@adobe/data 0.4.5 → 0.4.6

package/dist/ecs/store/store-schema/create-store-schema-test.js

@@ -0,0 +1,36 @@
+/*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 { TrueSchema } from "../../../schema/true.js";
+import { createStoreSchema } from "./create-store-schema.js";
+// just a compile time test which is why we're using -test.ts extension instead of .test.ts
+createStoreSchema({
+    velocity: { type: "number" },
+    particle: TrueSchema,
+}, {
+    mousePosition: { type: "number", default: 0 },
+    fooPosition: { type: "number", default: 0 },
+}, {
+    bar: ["particle", "velocity"],
+    // @ts-expect-error
+    foo: ["particle", "velocity2"] // should throw error because velocity2 is not a component
+});
+//# sourceMappingURL=create-store-schema-test.js.map

package/dist/ecs/store/store-schema/create-store-schema-test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-store-schema-test.js","sourceRoot":"","sources":["../../../../src/ecs/store/store-schema/create-store-schema-test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;WAoBW;AAEX,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,2FAA2F;AAE3F,iBAAiB,CACb;IACI,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC5B,QAAQ,EAAE,UAAU;CACvB,EACD;IACI,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,EAAE;IAC7C,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,EAAE;CAC9C,EACD;IACI,GAAG,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;IAC7B,mBAAmB;IACnB,GAAG,EAAE,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,0DAA0D;CAC5F,CACJ,CAAA"}

package/dist/ecs/store/store-schema/create-store-schema.d.ts

@@ -0,0 +1,9 @@
+import { StringKeyof } from "../../../types/types.js";
+import { ComponentSchemas } from "../../component-schemas.js";
+import { ResourceSchemas } from "../../resource-schemas.js";
+import { ArchetypeComponents } from "../archetype-components.js";
+export declare function createStoreSchema<const CS extends ComponentSchemas, const RS extends ResourceSchemas, const A extends ArchetypeComponents<StringKeyof<CS>>>(components: CS, resources: RS, archetypes: A): {
+    readonly components: CS;
+    readonly resources: RS;
+    readonly archetypes: A;
+};

package/dist/ecs/store/store-schema/create-store-schema.js

@@ -0,0 +1,26 @@
+/*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 function createStoreSchema(components, resources, archetypes) {
+    return { components, resources, archetypes };
+}
+;
+//# sourceMappingURL=create-store-schema.js.map

package/dist/ecs/store/store-schema/create-store-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-store-schema.js","sourceRoot":"","sources":["../../../../src/ecs/store/store-schema/create-store-schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;WAoBW;AAQX,MAAM,UAAU,iBAAiB,CAK7B,UAAc,EACd,SAAa,EACb,UAAa;IAEb,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAA4C,CAAC;AAC3F,CAAC;AAAA,CAAC"}

package/dist/ecs/store/store-schema/index.d.ts

@@ -0,0 +1,2 @@
+export { createStoreSchema } from "./create-store-schema.js";
+export * from "./store-schema.js";

package/dist/ecs/store/store-schema/index.js

@@ -0,0 +1,24 @@
+/*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 { createStoreSchema } from "./create-store-schema.js";
+export * from "./store-schema.js";
+//# sourceMappingURL=index.js.map

package/dist/ecs/store/store-schema/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/ecs/store/store-schema/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;WAoBW;AAEX,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,cAAc,mBAAmB,CAAC"}

package/dist/ecs/store/store-schema/store-schema.d.ts

@@ -0,0 +1,12 @@
+import { FromSchemas } from "@adobe/data/schema";
+import { ComponentSchemas } from "../../component-schemas.js";
+import { ResourceSchemas } from "../../resource-schemas.js";
+import { Store } from "../store.js";
+import { ArchetypeComponents } from "../archetype-components.js";
+import { StringKeyof } from "../../../types/types.js";
+export type StoreSchema<CS extends ComponentSchemas, RS extends ResourceSchemas, A extends ArchetypeComponents<StringKeyof<CS>>> = {
+    readonly components: CS;
+    readonly resources: RS;
+    readonly archetypes: A;
+};
+export type StoreFromSchema<T> = T extends StoreSchema<infer CS, infer RS, infer A> ? Store<FromSchemas<CS>, FromSchemas<RS>, A> : never;

package/dist/ecs/store/store-schema/store-schema.js

@@ -0,0 +1,23 @@
+/*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 {};
+//# sourceMappingURL=store-schema.js.map

package/dist/ecs/store/store-schema/store-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store-schema.js","sourceRoot":"","sources":["../../../../src/ecs/store/store-schema/store-schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;WAoBW"}

package/dist/ecs/store/store.d.ts

@@ -7,6 +7,7 @@ import { Components } from "./components.js";
 import { ArchetypeComponents } from "./archetype-components.js";
 import { Archetype, ReadonlyArchetype } from "../archetype/archetype.js";
 import { EntitySelectOptions } from "./entity-select-options.js";
+import { Undoable } from "../database/undoable.js";
 interface BaseStore<C extends object = never> {
     select<Include extends StringKeyof<C>, T extends Include>(include: readonly Include[] | ReadonlySet<string>, options?: EntitySelectOptions<C, Pick<C & CoreComponents, T>>): readonly Entity[];
     toData(): unknown;
@@ -26,6 +27,11 @@ export type ToReadonlyStore<T extends Store<any, any>> = T extends Store<infer C
  * Store is the main interface for storing components, entities and resources.
  */
 export interface Store<C extends Components = never, R extends ResourceComponents = never, A extends ArchetypeComponents<StringKeyof<C>> = never> extends BaseStore<C>, Core<C> {
+    /**
+     * This is used when a store is used to represent a transaction.
+     * For most stores, this is ignored if it is set.
+     */
+    undoable?: Undoable;
     readonly resources: {
         -readonly [K in StringKeyof<R>]: R[K];
     };