@adobe/data 0.5.16 → 0.5.17

package/dist/old-ecs/privacy/helper-functions.test.js

@@ -0,0 +1,173 @@
+/*MIT License
+
+© Copyright 2025 Adobe. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.*/
+import { shouldIncludeComponentForSerialization, filterColumnForPrivacy, getFilteredColumn, filterTableForPrivacy } from "./helper-functions.js";
+import { describe, expect, test } from "vitest";
+describe("Privacy Helper Functions", () => {
+    test("shouldIncludeComponentForSerialization works correctly", () => {
+        const testCases = [
+            {
+                schema: { type: "string", privacy: "strictlyNecessary" },
+                options: { strictlyNecessary: true },
+                expected: true,
+                description: "strictlyNecessary with permission"
+            },
+            {
+                schema: { type: "string", privacy: "strictlyNecessary" },
+                options: undefined,
+                expected: true,
+                description: "strictlyNecessary without options (default)"
+            },
+            {
+                schema: { type: "string", privacy: "functional" },
+                options: { functional: true },
+                expected: true,
+                description: "functional with permission"
+            },
+            {
+                schema: { type: "string", privacy: "functional" },
+                options: { functional: false },
+                expected: false,
+                description: "functional without permission"
+            },
+            {
+                schema: { type: "string", privacy: "performance" },
+                options: { performance: true },
+                expected: true,
+                description: "performance with permission"
+            },
+            {
+                schema: { type: "string", privacy: "performance" },
+                options: { performance: false },
+                expected: false,
+                description: "performance without permission"
+            },
+            {
+                schema: { type: "string", privacy: "advertising" },
+                options: { advertising: true },
+                expected: true,
+                description: "advertising with permission"
+            },
+            {
+                schema: { type: "string", privacy: "advertising" },
+                options: { advertising: false },
+                expected: false,
+                description: "advertising without permission"
+            },
+            {
+                schema: { type: "string" },
+                options: {},
+                expected: true,
+                description: "no privacy classification (always included)"
+            },
+            {
+                schema: { type: "string" },
+                options: { strictlyNecessary: false, functional: false, performance: false, advertising: false },
+                expected: true,
+                description: "no privacy classification with all permissions false"
+            },
+        ];
+        for (const testCase of testCases) {
+            const result = shouldIncludeComponentForSerialization(testCase.schema, testCase.options);
+            expect(result).toBe(testCase.expected);
+        }
+    });
+    test("filterColumnForPrivacy replaces data with default values", () => {
+        const schema = { type: "string", default: "defaultValue" };
+        const rows = 3;
+        const originalData = ["value1", "value2", "value3"];
+        const result = filterColumnForPrivacy(schema, rows, originalData);
+        expect(result).toEqual(["defaultValue", "defaultValue", "defaultValue"]);
+    });
+    test("filterColumnForPrivacy handles empty data", () => {
+        const schema = { type: "string", default: "defaultValue" };
+        const rows = 0;
+        const originalData = [];
+        const result = filterColumnForPrivacy(schema, rows, originalData);
+        expect(result).toEqual([]);
+    });
+    test("filterColumnForPrivacy handles null/undefined data", () => {
+        const schema = { type: "string", default: "defaultValue" };
+        const rows = 2;
+        expect(filterColumnForPrivacy(schema, rows, null)).toBe(null);
+        expect(filterColumnForPrivacy(schema, rows, undefined)).toBe(undefined);
+    });
+    test("getFilteredColumn returns original data when component should be included", () => {
+        const componentSchemas = {
+            allowedComponent: { type: "string", privacy: "strictlyNecessary" }
+        };
+        const privacyOptions = { strictlyNecessary: true };
+        const originalData = ["value1", "value2"];
+        const rows = 2;
+        const [name, data] = getFilteredColumn("allowedComponent", privacyOptions, originalData, componentSchemas, rows);
+        expect(name).toBe("allowedComponent");
+        expect(data).toBe(originalData);
+    });
+    test("getFilteredColumn returns filtered data when component should be excluded", () => {
+        const componentSchemas = {
+            blockedComponent: { type: "string", privacy: "advertising", default: "blocked" }
+        };
+        const privacyOptions = { strictlyNecessary: true };
+        const originalData = ["value1", "value2"];
+        const rows = 2;
+        const [name, data] = getFilteredColumn("blockedComponent", privacyOptions, originalData, componentSchemas, rows);
+        expect(name).toBe("blockedComponent");
+        expect(data).toEqual(["blocked", "blocked"]);
+    });
+    test("filterTableForPrivacy filters table columns based on privacy", () => {
+        const componentSchemas = {
+            allowedComponent: { type: "string", privacy: "strictlyNecessary" },
+            blockedComponent: { type: "string", privacy: "advertising", default: "filtered" }
+        };
+        const privacyOptions = { strictlyNecessary: true };
+        const table = {
+            rows: 2,
+            columns: {
+                allowedComponent: ["allowed1", "allowed2"],
+                blockedComponent: ["blocked1", "blocked2"]
+            }
+        };
+        const result = filterTableForPrivacy(componentSchemas, table, privacyOptions);
+        expect(result.rows).toBe(2);
+        expect(result.columns.allowedComponent).toEqual(["allowed1", "allowed2"]);
+        expect(result.columns.blockedComponent).toEqual(["filtered", "filtered"]);
+    });
+    test("filterTableForPrivacy preserves table structure", () => {
+        const componentSchemas = {
+            comp1: { type: "string", privacy: "functional", default: "default1" },
+            comp2: { type: "number", privacy: "performance", default: 0 }
+        };
+        const privacyOptions = { functional: true };
+        const table = {
+            rows: 3,
+            columns: {
+                comp1: ["a", "b", "c"],
+                comp2: [1, 2, 3]
+            }
+        };
+        const result = filterTableForPrivacy(componentSchemas, table, privacyOptions);
+        expect(result.rows).toBe(3);
+        expect(Object.keys(result.columns)).toEqual(["comp1", "comp2"]);
+        expect(result.columns.comp1).toEqual(["a", "b", "c"]);
+        expect(result.columns.comp2).toEqual([0, 0, 0]);
+    });
+});
+//# sourceMappingURL=helper-functions.test.js.map

package/dist/old-ecs/privacy/helper-functions.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helper-functions.test.js","sourceRoot":"","sources":["../../../src/old-ecs/privacy/helper-functions.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;WAoBW;AACX,OAAO,EAEH,sCAAsC,EACtC,sBAAsB,EACtB,iBAAiB,EACjB,qBAAqB,EACxB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAGhD,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACtC,IAAI,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,SAAS,GAA2F;YACtG;gBACI,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,mBAAmB,EAAE;gBACxD,OAAO,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE;gBACpC,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,mCAAmC;aACnD;YACD;gBACI,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,mBAAmB,EAAE;gBACxD,OAAO,EAAE,SAAS;gBAClB,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,6CAA6C;aAC7D;YACD;gBACI,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE;gBACjD,OAAO,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE;gBAC7B,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,4BAA4B;aAC5C;YACD;gBACI,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE;gBACjD,OAAO,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE;gBAC9B,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,+BAA+B;aAC/C;YACD;gBACI,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE;gBAClD,OAAO,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE;gBAC9B,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,6BAA6B;aAC7C;YACD;gBACI,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE;gBAClD,OAAO,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE;gBAC/B,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,gCAAgC;aAChD;YACD;gBACI,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE;gBAClD,OAAO,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE;gBAC9B,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,6BAA6B;aAC7C;YACD;gBACI,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE;gBAClD,OAAO,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE;gBAC/B,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,gCAAgC;aAChD;YACD;gBACI,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAC1B,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,6CAA6C;aAC7D;YACD;gBACI,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAC1B,OAAO,EAAE,EAAE,iBAAiB,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE;gBAChG,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,sDAAsD;aACtE;SACJ,CAAC;QAEF,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YAC/B,MAAM,MAAM,GAAG,sCAAsC,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;YACzF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,MAAM,MAAM,GAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;QACnE,MAAM,IAAI,GAAG,CAAC,CAAC;QACf,MAAM,YAAY,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAEpD,MAAM,MAAM,GAAG,sBAAsB,CAAC,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;QAElE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,MAAM,GAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;QACnE,MAAM,IAAI,GAAG,CAAC,CAAC;QACf,MAAM,YAAY,GAAa,EAAE,CAAC;QAElC,MAAM,MAAM,GAAG,sBAAsB,CAAC,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;QAElE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,MAAM,GAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;QACnE,MAAM,IAAI,GAAG,CAAC,CAAC;QAEf,MAAM,CAAC,sBAAsB,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9D,MAAM,CAAC,sBAAsB,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACnF,MAAM,gBAAgB,GAAG;YACrB,gBAAgB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,mBAAmB,EAAE;SACrE,CAAC;QACF,MAAM,cAAc,GAAmB,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;QACnE,MAAM,YAAY,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,CAAC,CAAC;QAEf,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,iBAAiB,CAAC,kBAAkB,EAAE,cAAc,EAAE,YAAY,EAAE,gBAA0C,EAAE,IAAI,CAAC,CAAC;QAE3I,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACtC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACnF,MAAM,gBAAgB,GAAG;YACrB,gBAAgB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE;SACnF,CAAC;QACF,MAAM,cAAc,GAAmB,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;QACnE,MAAM,YAAY,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,CAAC,CAAC;QAEf,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,iBAAiB,CAAC,kBAAkB,EAAE,cAAc,EAAE,YAAY,EAAE,gBAA0C,EAAE,IAAI,CAAC,CAAC;QAE3I,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACtC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACtE,MAAM,gBAAgB,GAAG;YACrB,gBAAgB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,mBAAmB,EAAE;YAClE,gBAAgB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,UAAU,EAAE;SACpF,CAAC;QACF,MAAM,cAAc,GAAmB,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;QAEnE,MAAM,KAAK,GAAG;YACV,IAAI,EAAE,CAAC;YACP,OAAO,EAAE;gBACL,gBAAgB,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;gBAC1C,gBAAgB,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;aAC7C;SACJ,CAAC;QAEF,MAAM,MAAM,GAAG,qBAAqB,CAAC,gBAA0C,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;QAExG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC5B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;QAC1E,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,gBAAgB,GAAG;YACrB,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE;YACrE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,EAAE;SAChE,CAAC;QACF,MAAM,cAAc,GAAmB,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;QAE5D,MAAM,KAAK,GAAG;YACV,IAAI,EAAE,CAAC;YACP,OAAO,EAAE;gBACL,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;gBACtB,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;aACnB;SACJ,CAAC;QAEF,MAAM,MAAM,GAAG,qBAAqB,CAAC,gBAA0C,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;QAExG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC5B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QAChE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QACtD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/samples/todo/services/state-service/create-todo-database.d.ts

@@ -1,13 +1,13 @@
 import * as transactions from './transactions/index.js';
 export declare const createTodoDatabase: () => import("../../../../ecs/index.js").Database<{
     name: string;
-    order: number;
     todo: true;
     complete: boolean;
+    order: number;
     dragPosition: number | null;
 }, {
     displayCompleted: boolean;
 }, {
-    Todo: ("name" | "order" | "todo" | "complete" | "dragPosition")[];
+    Todo: ("name" | "todo" | "complete" | "order" | "dragPosition")[];
 }, import("../../../../ecs/index.js").ToTransactionFunctions<typeof transactions>>;
 export type TodoDatabase = ReturnType<typeof createTodoDatabase>;

package/dist/samples/todo/services/state-service/create-todo-store.d.ts

@@ -1,13 +1,13 @@
 export declare const todoStoreSchemaVersion = 1;
 export declare const createTodoStore: () => import("../../../../ecs/index.js").Store<{
     name: string;
-    order: number;
     todo: true;
     complete: boolean;
+    order: number;
     dragPosition: number | null;
 }, {
     displayCompleted: boolean;
 }, {
-    Todo: ("name" | "order" | "todo" | "complete" | "dragPosition")[];
+    Todo: ("name" | "todo" | "complete" | "order" | "dragPosition")[];
 }>;
 export type TodoStore = ReturnType<typeof createTodoStore>;