@adobe/data 0.1.3 → 0.2.0

package/{core/schema/dynamic/enumerate-patches.test.js → src/schema/dynamic/enumerate-patches.test.ts}

@@ -1,5 +1,28 @@
+/*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 { describe, it, expect } from 'vitest';
 import { enumeratePatches } from './enumerate-patches.js';
+import { FromSchema, Schema } from '../schema.js';
+
 export const PersonSchema = {
     type: "object",
     properties: {
@@ -40,7 +63,8 @@ export const PersonSchema = {
         },
     },
     additionalProperties: false,
-};
+} as const satisfies Schema;
+
 export const PersonSchemaWithOneOf = {
     type: "object",
     properties: {
@@ -87,7 +111,8 @@ export const PersonSchemaWithOneOf = {
         },
     },
     additionalProperties: false,
-};
+} as const satisfies Schema;
+
 export const PersonSchemaRootConditions = {
     type: "object",
     properties: {
@@ -151,59 +176,60 @@ export const PersonSchemaRootConditions = {
         }
     ],
     additionalProperties: false,
-};
+} as const satisfies Schema;
+
 describe('enumeratePatches', () => {
     it('should not enumerate patches when the local condition is not met', () => {
         const patches = [...enumeratePatches(PersonSchema, {
-                name: "John Doe",
-                age: 20,
-            })];
-        expect(patches).toEqual([]);
+            name: "John Doe",
+            age: 20,
+        })];
+        expect(patches).toEqual([
+        ]);
     });
     it('should enumerate patches when the local condition is met', () => {
         const patches = [...enumeratePatches(PersonSchema, {
-                name: "John Doe",
-                age: 10,
-            })];
+            name: "John Doe",
+            age: 10,
+        })];
         expect(patches).toEqual([
             { path: ["$", "properties", "email", "ui"], fragment: { visible: false } },
         ]);
     });
     it('should match on oneOf cases for human', () => {
         const patches = [...enumeratePatches(PersonSchemaWithOneOf, {
-                name: "John Doe",
-                species: "human",
-            })];
+            name: "John Doe",
+            species: "human",
+        })];
         expect(patches).toEqual([
             { path: ["$", "properties", "email", "ui"], fragment: { visible: true } },
         ]);
     });
     it('should match on oneOf cases for robot', () => {
         const patches = [...enumeratePatches(PersonSchemaWithOneOf, {
-                name: "John Doe",
-                species: "robot",
-            })];
+            name: "John Doe",
+            species: "robot",
+        })];
         expect(patches).toEqual([
             { path: ["$", "properties", "email", "ui"], fragment: { enabled: false } },
         ]);
     });
     it('should match on complex root conditions', () => {
         const patches = [...enumeratePatches(PersonSchemaRootConditions, {
-                name: "John Doe",
-                species: "human",
-            })];
+            name: "John Doe",
+            species: "human",
+        })];
         expect(patches).toEqual([
             { path: ["$", "properties", "email", "ui"], fragment: { visible: true } },
         ]);
     });
     it('should match on simple root conditions', () => {
         const patches = [...enumeratePatches(PersonSchemaRootConditions, {
-                name: "ab",
-                species: "human",
-            })];
+            name: "ab",
+            species: "human",
+        })];
         expect(patches).toEqual([
             { path: ["$", "properties", "email", "ui"], fragment: { visible: false } },
         ]);
     });
 });
-//# sourceMappingURL=enumerate-patches.test.js.map

package/{core/schema/dynamic/enumerate-patches.js → src/schema/dynamic/enumerate-patches.ts}

@@ -1,6 +1,43 @@
-import jp from "jsonpath";
+/*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 { Schema } from "../schema.js";
+import jp, { PathComponent } from "jsonpath";
 import { isValid } from "../validation/is-valid.js";
-export function* enumeratePatches(currentSchema, currentValue, rootValue = currentValue, rootSchema = currentSchema, currentPath = ["$"], localPath = ["$"]) {
+
+export type EnumeratePatch = {
+    /** The path to the target node. */
+    path: PathComponent[];
+    /** The fragment that will be patched into the target. */
+    fragment: unknown;
+}
+
+export function* enumeratePatches(
+    currentSchema: Schema,
+    currentValue: unknown,
+    rootValue: unknown = currentValue,
+    rootSchema: Schema = currentSchema,
+    currentPath: PathComponent[] = ["$"],
+    localPath: PathComponent[] = ["$"],
+): Generator<EnumeratePatch> {
     if (currentValue === undefined || currentValue === null) {
         return;
     }
@@ -23,7 +60,9 @@ export function* enumeratePatches(currentSchema, currentValue, rootValue = curre
             }
         }
     }
+
     // recurse
+
     // items
     if (currentSchema.items && Array.isArray(currentValue)) {
         for (const [i, childSchema] of Object.entries(currentSchema.items)) {
@@ -32,12 +71,14 @@ export function* enumeratePatches(currentSchema, currentValue, rootValue = curre
             }
         }
     }
+
     // properties
     if (currentSchema.properties && typeof currentValue === "object") {
         for (const [k, childSchema] of Object.entries(currentSchema.properties)) {
-            yield* enumeratePatches(childSchema, currentValue[k], rootValue, rootSchema, [...currentPath, "properties", k], [...localPath, k]);
+            yield* enumeratePatches(childSchema, (currentValue as any)[k], rootValue, rootSchema, [...currentPath, "properties", k], [...localPath, k]);
         }
     }
+
     // oneOf 
     if (currentSchema.oneOf?.length) {
         for (const branch of currentSchema.oneOf) {
@@ -47,4 +88,3 @@ export function* enumeratePatches(currentSchema, currentValue, rootValue = curre
         }
     }
 }
-//# sourceMappingURL=enumerate-patches.js.map

package/{core/schema/dynamic/get-dynamic-schema.test.js → src/schema/dynamic/get-dynamic-schema.test.ts}

@@ -1,23 +1,49 @@
+/*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 { describe, it, expect } from 'vitest';
 import { getDynamicSchema } from './get-dynamic-schema.js';
 import { PersonSchema, PersonSchemaWithOneOf, PersonSchemaRootConditions } from './enumerate-patches.test.js';
+import { Schema } from '../schema.js';
+
 describe('getDynamicSchema', () => {
     it('should not modify schema when local condition is not met', () => {
         const dynamicSchema = getDynamicSchema(PersonSchema, {
             name: "John Doe",
             age: 20,
         });
+
         // Email UI should remain unchanged
         expect(dynamicSchema.properties?.email?.ui).toEqual({
             name: "Email",
             placeholder: "john.doe@example.com",
         });
     });
+
     it('should modify schema when local condition is met', () => {
         const dynamicSchema = getDynamicSchema(PersonSchema, {
             name: "John Doe",
             age: 10,
         });
+
         // Email UI should be hidden
         expect(dynamicSchema.properties?.email?.ui).toEqual({
             name: "Email",
@@ -25,11 +51,13 @@ describe('getDynamicSchema', () => {
             visible: false,
         });
     });
+
     it('should apply oneOf conditions for human', () => {
         const dynamicSchema = getDynamicSchema(PersonSchemaWithOneOf, {
             name: "John Doe",
             species: "human",
         });
+
         // Email UI should be visible
         expect(dynamicSchema.properties?.email?.ui).toEqual({
             name: "Email",
@@ -37,11 +65,13 @@ describe('getDynamicSchema', () => {
             visible: true,
         });
     });
+
     it('should apply oneOf conditions for robot', () => {
         const dynamicSchema = getDynamicSchema(PersonSchemaWithOneOf, {
             name: "John Doe",
             species: "robot",
         });
+
         // Email UI should be disabled
         expect(dynamicSchema.properties?.email?.ui).toEqual({
             name: "Email",
@@ -49,11 +79,13 @@ describe('getDynamicSchema', () => {
             enabled: false,
         });
     });
+
     it('should apply complex root conditions', () => {
         const dynamicSchema = getDynamicSchema(PersonSchemaRootConditions, {
             name: "John Doe",
             species: "human",
         });
+
         // Email UI should be visible due to name length > 3 and species being human
         expect(dynamicSchema.properties?.email?.ui).toEqual({
             name: "Email",
@@ -61,11 +93,13 @@ describe('getDynamicSchema', () => {
             visible: true,
         });
     });
+
     it('should apply simple root conditions', () => {
         const dynamicSchema = getDynamicSchema(PersonSchemaRootConditions, {
             name: "ab",
             species: "human",
         });
+
         // Email UI should be hidden due to name length <= 2
         expect(dynamicSchema.properties?.email?.ui).toEqual({
             name: "Email",
@@ -73,6 +107,7 @@ describe('getDynamicSchema', () => {
             visible: false,
         });
     });
+
     it('should throw error when target node is not an object', () => {
         const invalidSchema = {
             type: "object",
@@ -80,15 +115,15 @@ describe('getDynamicSchema', () => {
                 name: {
                     type: "string",
                     conditionals: [{
-                            path: "$.type", // targeting a string, not an object
-                            value: { visible: false }
-                        }]
+                        path: "$.type",  // targeting a string, not an object
+                        value: { visible: false }
+                    }]
                 }
             }
-        };
+        } as const satisfies Schema;
+
         expect(() => getDynamicSchema(invalidSchema, {
             name: "John Doe"
         })).toThrow('Target node MUST be an object');
     });
-});
-//# sourceMappingURL=get-dynamic-schema.test.js.map
+}); 

package/src/schema/dynamic/get-dynamic-schema.ts

@@ -0,0 +1,48 @@
+/*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 { normalize } from "../../normalize.js";
+import { deepMerge } from "./deep-merge.js";
+import { Schema } from "../schema.js";
+import { enumeratePatches } from "./enumerate-patches.js";
+import jp from "jsonpath";
+
+/**
+ * Gets a dynamic schema from a static schema with conditionals and a current value.
+ */
+export function getDynamicSchema(schema: Schema, value: unknown): Schema {
+    let input = schema;
+    for (let i = 0; i < 20; i++) {
+        const output = structuredClone(input);
+        for (const { path, fragment } of enumeratePatches(input, value)) {
+            const node = jp.value(output, jp.stringify(path));
+            if (typeof node !== "object" || node === null) {
+                throw new Error(`Target node MUST be an object, found: ${JSON.stringify(node)} at ${jp.stringify(path)}`);
+            }
+            Object.assign(node, deepMerge(node, fragment, { mergeArrays: false }));
+        }
+        if (JSON.stringify(normalize(input)) === JSON.stringify(normalize(output))) {
+            return output;
+        }
+        input = output;
+    }
+    throw new Error("Failed resolve stable dynamic schema");
+}

package/src/schema/dynamic/index.ts

@@ -0,0 +1,22 @@
+/*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.*/
+export * from './get-dynamic-schema.js';

package/src/schema/f32.ts

@@ -0,0 +1,30 @@
+/*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 type { Schema } from "./schema.js";
+
+export const F32Schema = {
+    type: 'number',
+    precision: 1,
+    default: 0 as number,
+} as const satisfies Schema;
+
+export type F32 = number;

package/src/schema/i32.ts

@@ -0,0 +1,31 @@
+/*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 type { Schema } from "./schema.js";
+
+export const I32Schema = {
+    type: 'integer',
+    minimum: -2147483648,
+    maximum: 2147483647,
+    default: 0 as number,
+} as const satisfies Schema;
+
+export type I32 = number;

package/src/schema/index.ts

@@ -0,0 +1,32 @@
+/*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.*/
+
+export type { Schema, FromSchema } from "./schema.js";
+export { Nullable } from "./nullable.js";
+export type { getDynamicSchema } from "./dynamic/index.js";
+export { withValidation } from "./validation/with-validation.js";
+export { type F32, F32Schema } from "./f32.js";
+export { type I32, I32Schema } from "./i32.js";
+export { type U32, U32Schema } from "./u32.js";
+export { type True, TrueSchema } from "./true.js";
+export { BooleanSchema } from "./boolean.js";
+export { type Time, TimeSchema } from "./time.js";

package/{cache/functions/omit.js → src/schema/nullable.ts}

@@ -19,11 +19,14 @@ 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.*/
-export function omit(obj, ...keys) {
-    const result = { ...obj };
-    for (const key of keys) {
-        delete result[key];
-    }
-    return result;
+import { Schema } from "./schema.js";
+
+export function Nullable<T extends Schema>(
+  schema: T
+): { oneOf: [T, { type: "null" }] } {
+  return {
+    oneOf: [schema, { type: "null" }],
+  };
 }
-//# sourceMappingURL=omit.js.map
+
+