@magnite/fledge.polyfill - npm Package Compare versions

Comparing version 0.0.0 to 0.1.0

package.json

@@ -6,4 +6,5 @@ {
   "author": "Newton Koumantzelis",
-  "version": "0.0.0",
-  "main": "index.js",
+  "version": "0.1.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
   "repository": "https://github.com/MagniteEngineering/fledge.polyfill.git",
@@ -14,2 +15,7 @@ "bugs": "https://github.com/MagniteEngineering/fledge.polyfill/issues",
   "license": "MIT",
+  "babel": {
+    "presets": [
+      "@theholocron"
+    ]
+  },
   "commitlint": {
@@ -20,2 +26,5 @@ "extends": [
   },
+  "engines": {
+    "node": "^12.16.0 || >=13.2.0"
+  },
   "eslintConfig": {
@@ -31,3 +40,19 @@ "extends": "@theholocron"
   "jest": {
-    "preset": "@theholocron/jest-preset"
+    "projects": [
+      {
+        "preset": "@theholocron/jest-preset",
+        "setupFiles": [
+          "fake-indexeddb/auto"
+        ]
+      },
+      {
+        "displayName": "End-to-End Integration Tests",
+        "setupFiles": [
+          "fake-indexeddb/auto"
+        ],
+        "testMatch": [
+          "<rootDir>/test/e2e/**/*.js"
+        ]
+      }
+    ]
   },
@@ -39,17 +64,33 @@ "publishConfig": {
     "extends": "@theholocron/semantic-release-config",
-    "branch": "master"
+    "branches": [
+      "main"
+    ]
   },
   "scripts": {
     "commit": "commit",
+    "dist": "rollup -c node:@theholocron/rollup-config --name=fledge",
     "lint": "eslint .",
     "release": "semantic-release",
-    "test": "jest"
+    "test:unit": "jest test/unit --passWithNoTests",
+    "pretest:e2e": "npm run dist",
+    "test:e2e": "jest --config test/e2e/jest.config.js",
+    "test": "npm run test:unit && npm run test:e2e",
+    "serve": "./node_modules/.bin/serve . -l 3000"
   },
   "devDependencies": {
-    "@theholocron/commitlint-config": "^0.1.11",
-    "@theholocron/eslint-config": "^0.4.1",
-    "@theholocron/lint-staged-config": "^0.1.6",
-    "@theholocron/jest-preset": "^0.2.3",
-    "@theholocron/semantic-release-config": "^0.2.4"
+    "@theholocron/babel-preset": "^0.4.1",
+    "@theholocron/commitlint-config": "^0.1.13",
+    "@theholocron/eslint-config": "^0.4.3",
+    "@theholocron/jest-preset": "^0.4.0",
+    "@theholocron/lint-staged-config": "^0.1.7",
+    "@theholocron/rollup-config": "^0.2.4",
+    "@theholocron/semantic-release-config": "^0.3.0",
+    "fake-indexeddb": "^3.1.2",
+    "jest-puppeteer": "^4.4.0",
+    "puppeteer": "^8.0.0",
+    "serve": "^11.3.2"
+  },
+  "dependencies": {
+    "idb": "^6.0.0"
   }
 }

README.md

@@ -1,2 +0,2 @@
-# fledge.polyfill [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=the-holocron/threepio)](https://dependabot.com)
+# fledge.polyfill [![npm version](https://badge.fury.io/js/%40magnite%2Ffledge.polyfill.svg)](https://badge.fury.io/js/%40magnite%2Ffledge.polyfill) [![codecov](https://codecov.io/gh/MagniteEngineering/fledge.polyfill/branch/main/graph/badge.svg?token=8NUU67BFAH)](https://codecov.io/gh/MagniteEngineering/fledge.polyfill)  [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=the-holocron/threepio)](https://dependabot.com)
 
@@ -15,14 +15,34 @@ A [Fledge](https://github.com/WICG/turtledove/blob/main/FLEDGE.md) JavaScript polyfill.
 - [Documentation](#where-to-find-documentation)
-- [Changelog](#how-we-track-changes)
-- [Versioning](#how-we-version)
-- [Contribution](#how-to-contribute)
-- [Support](#where-to-find-suport)
+- [Changelog](#how-we-track-changes-)
+- [Versioning](#how-we-version-)
+- [Contribution](#how-to-contribute-)
+- [Support](#where-to-find-suport-)
 - [Tools](#tools-we-use)
 - [Support](#where-to-find-suport)
-- [License](#license)
+- [License](#license-)
 
 ## Usage
 
-<!-- insert usage -->
+### Interest Groups
 
+As of this moment, the polyfill is intended to work within the Chrome browser at a version greater than 91.  There are several ways to invoke the polyfill, but given the modern capabilities of support required, the following is the recoommended way to invoke the API.
+
+```html
+<script type="module">
+    import { fledge } from "./node_modules/@magnite/fledge.polyfill/esm/index.js";
+
+    const options = {
+        owner: "www.buyer.com",
+        name: "an-interest-group",
+        bidding_logic_url: "https://dsp.com/bidding",
+    };
+
+    // join an interest group
+    fledge.joinAdInterestGroup(options, 864000000).then(response => console.log(response));
+
+    // leave an interest group
+    fledge.leaveAdInterestGroup(options).then(response => console.log(response));
+</script>
+```
+
 ## Where to Find Documentation
@@ -32,2 +52,4 @@
 
+* [Interest Groups](./src/interest-groups/README.md)
+
 ## How We Track Changes [![Keep a Changelog](https://img.shields.io/badge/Keep%20a%20Changelog-1.0.0-orange)](https://keepachangelog.com/en/1.0.0/)
@@ -102,2 +124,2 @@
 
-©2021 MIT License. See [LICENSE](./LICENSE) for specifics.
+©2021 Magnite, Inc. See [LICENSE](./LICENSE) for specifics.

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Improved metrics

Number of package files

65

increased by30%

Lines of code

2027

increased by913.5%

Number of lines in readme file

123

increased by21.78%

Worsened metrics

Total package byte prevSize

174347

decreased by-74.05%

Dependency count

1

increased byInfinity%

Dev dependency count

11

increased by120%

Number of medium supply chain risk alerts

3

increased byInfinity%

Dependency changes

• + Addedidb@^6.0.0

• + Addedidb@6.1.5(transitive)