Consent management component

.github/workflows/check.yml

@@ -1,42 +1,38 @@
-name: Build and Deploy
-
+name: Check
 on:
   push:
     branches:
       - main
   pull_request:
-    branches:
-      - main
 
 env:
   EDGEE_API_TOKEN: ${{ secrets.EDGEE_API_TOKEN }}
 
 jobs:
-  build:
+  full-ci:
+    name: Full CI (${{ matrix.dir }})
     runs-on: ubuntu-latest
-
+    strategy:
+      matrix:
+        dir: [consent-management, data-collection]
+    defaults:
+      run:
+        working-directory: ${{ matrix.dir }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
 
+      - name: Install edgee
+        uses: edgee-cloud/[email protected]
+
       - name: Set up Node.js
         uses: actions/setup-node@v2
         with:
           node-version: "20"
 
-      - name: Install edgee
-        uses: edgee-cloud/[email protected]
-
       - name: Build
         run: |
           edgee component build
 
-      - name: Verify .wasm file exists
-        run: |
-          if [ ! -f "./example-ts-component.wasm" ]; then
-            echo "❌ Error: example-ts-component.wasm not found" >&2
-            exit 1
-          fi
-
       - name: Run tests
         run: npm test

consent-management/.gitignore

@@ -0,0 +1,9 @@
+# Node stuff
+/node_modules
+/coverage
+
+.edgee/
+src/index.js
+
+# Build artifacts
+*.wasm

consent-management/edgee-component.toml

@@ -0,0 +1,20 @@
+manifest-version = 1
+
+[component]
+name = "example-ts-consent-management-component"
+version = "1.0.0"
+category = "consent-management"
+subcategory = "consent-mapping"
+description = "Example TypeScript component for consent management"
+documentation = "https://github.com/edgee-cloud/example-ts-component"
+repository = "https://github.com/edgee-cloud/example-ts-component"
+language = "TypeScript"
+wit-version = "1.0.0"
+
+[component.build]
+command = "npm install && npm run generate && npm run build"
+output_path = "./example-ts-component.wasm"
+
+[component.settings.example]
+title = "Example Config Field"
+type = "string"

consent-management/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "example-ts-component",
+  "type": "module",
+  "main": "src/index.ts",
+  "types": "types/wit.d.ts",
+  "scripts": {
+    "generate": "npx @bytecodealliance/jco types .edgee/wit -o types",
+    "compile": "npx tsc",
+    "build": "npm run compile && npx @bytecodealliance/jco componentize src/index.js --wit .edgee/wit -o example-ts-component.wasm -n consent-management -d all",
+    "lint": "npx eslint",
+    "test": "mocha",
+    "coverage": "c8 --src js --all -r text -r text-summary npm test"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.20.0",
+    "@types/chai": "^5.0.1",
+    "@types/mocha": "^10.0.10",
+    "@types/sinon": "^17.0.3",
+    "c8": "^10.1.3",
+    "chai": "^5.1.2",
+    "eslint": "^9.20.0",
+    "mocha": "^11.1.0",
+    "sinon": "^19.0.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.24.0"
+  }
+}

consent-management/src/index.ts

@@ -0,0 +1,32 @@
+import type {
+  consentManagement as EdgeeConsentManagement,
+} from "../types/wit";
+
+
+const convertDict = (dict: EdgeeConsentManagement.Dict): Map<string, string> => {
+  const data = new Map<string, string>();
+
+  for (const [key, value] of dict) {
+    data.set(key, value);
+  }
+
+  return data;
+};
+
+export const consentManagement: typeof EdgeeConsentManagement = {
+  map(cookies: EdgeeConsentManagement.Dict, settings: EdgeeConsentManagement.Dict) {
+    const dictSettings = convertDict(settings);
+    const dictCookies = convertDict(cookies);
+
+    if (!dictCookies.has('example')) {
+        return;
+    }
+    const example = dictCookies.get('example');
+    if (example === "granted") {
+        return "granted";
+    } else if (example === "denied") {
+        return "denied";
+    }
+    return "pending";
+  },
+};

consent-management/test/index.spec.ts

@@ -0,0 +1,23 @@
+import { assert } from "chai";
+import { describe, it } from "mocha";
+import { consentManagement } from '../src/index';
+import { Dict } from "../types/interfaces/edgee-components-consent-management";
+
+describe('consent management component', function () {
+
+  const sampleSettings: Dict = [
+    ["example", "api_value"]
+  ];
+
+  const sampleCookies: Dict = [
+    ["example", "denied"]
+  ];
+
+  describe('#map()', function () {
+    it('should return consent denied', function () {
+      const req = consentManagement.map(sampleCookies, sampleSettings);
+      assert.equal(req, "denied");
+    });
+  });
+
+});

consent-management/types/interfaces/edgee-components-consent-management.d.ts

@@ -0,0 +1,13 @@
+/** @module Interface edgee:components/[email protected] **/
+export function map(cookies: Dict, settings: Dict): Consent | undefined;
+export type Dict = Array<[string, string]>;
+/**
+ * # Variants
+ * 
+ * ## `"pending"`
+ * 
+ * ## `"granted"`
+ * 
+ * ## `"denied"`
+ */
+export type Consent = 'pending' | 'granted' | 'denied';

consent-management/types/wit.d.ts

@@ -0,0 +1,2 @@
+// world edgee:native/consent-management
+export * as consentManagement from './interfaces/edgee-components-consent-management.js'; // export edgee:components/[email protected]

data-collection/.gitignore

@@ -0,0 +1,9 @@
+# Node stuff
+/node_modules
+/coverage
+
+.edgee/
+src/index.js
+
+# Build artifacts
+*.wasm