@adobe/data 0.2.0 → 0.2.2

package/dist/schemas/index.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 * from "../core/schemas.js";
+//# sourceMappingURL=index.js.map

package/dist/schemas/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;WAoBW;AACX,cAAc,oBAAoB,CAAC"}

package/dist/schemas/schemas.d.ts

@@ -0,0 +1,45 @@
+import { Schema } from "../core/index.js";
+export declare function Nullable<T extends Schema>(schema: T): {
+    oneOf: [T, {
+        type: "null";
+    }];
+};
+export declare function Tuple<T extends Schema, N extends number>(items: T, length: N): {
+    readonly type: "array";
+    readonly items: T;
+    readonly minItems: N;
+    readonly maxItems: N;
+};
+export declare const TrueSchema: {
+    readonly const: true;
+};
+export declare const BooleanSchema: {
+    readonly type: "boolean";
+};
+export declare const Float32Schema: {
+    readonly type: "number";
+    readonly precision: 1;
+};
+export declare const Float64Schema: {
+    readonly type: "number";
+    readonly precision: 2;
+};
+export declare const TimeSchema: {
+    readonly type: "number";
+    readonly precision: 2;
+};
+export declare const Uint8Schema: {
+    readonly type: "integer";
+    readonly minimum: 0;
+    readonly maximum: 255;
+};
+export declare const Uint16Schema: {
+    readonly type: "integer";
+    readonly minimum: 0;
+    readonly maximum: 65535;
+};
+export declare const Uint32Schema: {
+    readonly type: "integer";
+    readonly minimum: 0;
+    readonly maximum: 4294967295;
+};

package/dist/schemas/schemas.js

@@ -0,0 +1,39 @@
+export function Nullable(schema) {
+    return {
+        oneOf: [schema, { type: "null" }],
+    };
+}
+export function Tuple(items, length) {
+    return { type: "array", items, minItems: length, maxItems: length };
+}
+export const TrueSchema = {
+    const: true,
+};
+export const BooleanSchema = {
+    type: "boolean",
+};
+export const Float32Schema = {
+    type: "number",
+    precision: 1,
+};
+export const Float64Schema = {
+    type: "number",
+    precision: 2,
+};
+export const TimeSchema = Float64Schema;
+export const Uint8Schema = {
+    type: "integer",
+    minimum: 0,
+    maximum: 0xff,
+};
+export const Uint16Schema = {
+    type: "integer",
+    minimum: 0,
+    maximum: 0xffff,
+};
+export const Uint32Schema = {
+    type: "integer",
+    minimum: 0,
+    maximum: 0xffffffff,
+};
+//# sourceMappingURL=schemas.js.map

package/dist/schemas/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../src/schemas/schemas.ts"],"names":[],"mappings":"AAuBA,MAAM,UAAU,QAAQ,CACtB,MAAS;IAET,OAAO;QACL,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;KAClC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,KAAK,CAAqC,KAAQ,EAAE,MAAS;IAC3E,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAA4B,CAAC;AAChG,CAAC;AAED,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,KAAK,EAAE,IAAI;CACc,CAAC;AAE5B,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,SAAS;CACU,CAAC;AAE5B,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,QAAQ;IACd,SAAS,EAAE,CAAC;CACa,CAAC;AAE5B,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,QAAQ;IACd,SAAS,EAAE,CAAC;CACa,CAAC;AAE5B,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAC;AAExC,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,IAAI;CACY,CAAC;AAE5B,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,MAAM;CACU,CAAC;AAE5B,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,UAAU;CACM,CAAC"}

package/dist/service/add-observable-actions.d.ts

@@ -0,0 +1,29 @@
+import { Service } from './service.js';
+import { Observe } from '../observe/index.js';
+import { Expand, IsVoid, NoNever } from '../types/index.js';
+declare const NESTED_SERVICE_SEPARATOR = "_";
+export type WithObservableActions<T extends Service> = T & {
+    actions: Observe<ServiceActionMessages<T>>;
+};
+export declare function addObservableActions<T extends Service>(service: T): WithObservableActions<T>;
+type FunctionsToMessages<T, Prefix extends string = ''> = {
+    [K in keyof T]: K extends string ? T[K] extends (...args: any[]) => unknown ? {
+        action: `${Prefix}${K}`;
+        args: Parameters<T[K]>;
+    } : never : never;
+};
+type SubServices<T> = NoNever<{
+    [K in keyof T]: T[K] extends Service ? T[K] : never;
+}>;
+type SubServiceActionMessages<T, ParentPrefix extends string = ''> = {
+    [K in keyof T]: K extends string ? ServiceActionMessagesWithPrefix<T[K], `${ParentPrefix}${K}${typeof NESTED_SERVICE_SEPARATOR}`> : never;
+};
+type IsPromiseOrVoid<T> = T extends Promise<unknown> ? true : IsVoid<T>;
+type PromiseOrVoidFunctions<T> = NoNever<{
+    [K in keyof T]: T[K] extends (...args: any[]) => infer R ? (IsPromiseOrVoid<R> extends true ? T[K] : never) : never;
+}>;
+type ServiceActionMessagesWithPrefix<T, Prefix extends string = ''> = FunctionsToMessages<PromiseOrVoidFunctions<T>, Prefix>[keyof FunctionsToMessages<PromiseOrVoidFunctions<T>, Prefix>] | (T extends Service ? Expand<SubServiceActionMessages<SubServices<T>, Prefix>[keyof SubServiceActionMessages<SubServices<T>, Prefix>]> : never);
+export type ServiceActionMessages<T> = Extract<ServiceActionMessagesWithPrefix<T>, {
+    action: string;
+}>;
+export {};

package/dist/service/add-observable-actions.js

@@ -0,0 +1,108 @@
+/*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 { isService } from "./is-service.js";
+import { createObservableEvent } from '../observe/index.js';
+import { isPromise } from '../internal/promise/is-promise.js';
+const NESTED_SERVICE_SEPARATOR = '_';
+/**
+ * Returns true if this function return value is from an action function.
+ * Action functions are only allowed to return void, BUT some action function implementations
+ * may be async and return a Promise<void>. This is convenient for authoring and since
+ * no other service functions are allowed to return Promises then we will assume this is an action.
+ */
+function isActionReturnValue(result) {
+    return result === undefined || isPromise(result);
+}
+/**
+ * Intercepts actions on a service and notifies via a callback.
+ *
+ * This function creates a proxy around the given service object. It intercepts
+ * action calls and sends back action messages after each call.
+ * It also wraps any child services within their own namespaced interceptActions Proxy.
+ *
+ * @template T - The type of the service object.
+ * @param {T} service - The service object to be proxied.
+ * @param {string} prefix - A prefix to be added to action names for nested services.
+ * @param {(...args: unknown[]) => void} callback - A callback function to be called after an action is executed.
+ * @returns {T} - The proxied service object.
+ */
+function interceptActions(service, prefix, callback) {
+    const propertyCache = new Map();
+    const serviceCache = new Map();
+    return new Proxy(service, {
+        get(target, prop, receiver) {
+            const value = Reflect.get(target, prop, receiver);
+            const cached = propertyCache.get(prop);
+            if (cached) {
+                return cached;
+            }
+            let returnValue = value;
+            if (typeof prop === 'string') {
+                if (typeof value === 'function') {
+                    returnValue = (...args) => {
+                        // Call the original function with the same arguments
+                        // the binding to the target as `this` shouldn't be necessary but
+                        // we'll add it out of an abundance of caution.
+                        // eslint-disable-next-line @typescript-eslint/no-explicit-any -- calling with same args.
+                        const result = value.call(target, ...args);
+                        const executeCallback = () => {
+                            // this is an action, as actions always return void.
+                            callback({ action: prefix + prop, args });
+                        };
+                        // Notify via callback if the function returns void
+                        if (isActionReturnValue(result)) {
+                            if (isPromise(result)) {
+                                result.finally(executeCallback);
+                            }
+                            else {
+                                executeCallback();
+                            }
+                        }
+                        return result;
+                    };
+                }
+                else if (isService(value)) {
+                    // Wrap nested services in the same way
+                    const cachedService = serviceCache.get(prop);
+                    if (cachedService) {
+                        return cachedService;
+                    }
+                    const wrappedService = interceptActions(value, prefix + prop + NESTED_SERVICE_SEPARATOR, callback);
+                    serviceCache.set(prop, wrappedService);
+                    return wrappedService;
+                }
+            }
+            propertyCache.set(prop, returnValue);
+            return returnValue;
+        },
+    });
+}
+// Function to add observable actions to a service
+export function addObservableActions(service) {
+    const [actions, notifyActions] = createObservableEvent();
+    //  eslint-disable-next-line @typescript-eslint/no-explicit-any -- the compiler is complaining about type recursion for no discernable reason.
+    return interceptActions({ ...service, actions }, '', notifyActions);
+}
+// Compile-time type unit tests
+{
+}
+//# sourceMappingURL=add-observable-actions.js.map

package/dist/service/add-observable-actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-observable-actions.js","sourceRoot":"","sources":["../../src/service/add-observable-actions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;WAoBW;AAGX,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAW,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAErE,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAE9D,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAKrC;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,MAAe;IAC1C,OAAO,MAAM,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC;AACnD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAS,gBAAgB,CAAmB,OAAU,EAAE,MAAc,EAAE,QAAsC;IAC5G,MAAM,aAAa,GAAG,IAAI,GAAG,EAA4B,CAAC;IAC1D,MAAM,YAAY,GAAG,IAAI,GAAG,EAA4B,CAAC;IAEzD,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE;QACxB,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ;YACxB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;YAClD,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACvC,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,IAAI,WAAW,GAAY,KAAK,CAAC;YACjC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;oBAChC,WAAW,GAAG,CAAC,GAAG,IAAe,EAAE,EAAE;wBACnC,qDAAqD;wBACrD,iEAAiE;wBACjE,+CAA+C;wBAC/C,yFAAyF;wBACzF,MAAM,MAAM,GAAI,KAAa,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;wBACpD,MAAM,eAAe,GAAG,GAAG,EAAE;4BAC3B,oDAAoD;4BACpD,QAAQ,CAAC,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;wBAC5C,CAAC,CAAC;wBAEF,mDAAmD;wBACnD,IAAI,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAC;4BAChC,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;gCACtB,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;4BAClC,CAAC;iCAAM,CAAC;gCACN,eAAe,EAAE,CAAC;4BACpB,CAAC;wBACH,CAAC;wBAED,OAAO,MAAM,CAAC;oBAChB,CAAC,CAAC;gBACJ,CAAC;qBAAM,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC5B,uCAAuC;oBACvC,MAAM,aAAa,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBAC7C,IAAI,aAAa,EAAE,CAAC;wBAClB,OAAO,aAAa,CAAC;oBACvB,CAAC;oBACD,MAAM,cAAc,GAAG,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,wBAAwB,EAAE,QAAQ,CAAC,CAAC;oBACnG,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;oBACvC,OAAO,cAAc,CAAC;gBACxB,CAAC;YACH,CAAC;YACD,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YACrC,OAAO,WAAW,CAAC;QACrB,CAAC;KACF,CAAiB,CAAC;AACrB,CAAC;AAED,kDAAkD;AAClD,MAAM,UAAU,oBAAoB,CAAoB,OAAU;IAChE,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC,GAAG,qBAAqB,EAA4B,CAAC;IACnF,8IAA8I;IAC9I,OAAQ,gBAAwB,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;AAC/E,CAAC;AAuCD,+BAA+B;AAC/B,CAAC;AAoDD,CAAC"}

package/dist/service/index.d.ts

@@ -0,0 +1,4 @@
+export { type Service } from './service.js';
+export { isService } from './is-service.js';
+export { type WithObservableActions, type ServiceActionMessages, addObservableActions } from './add-observable-actions.js';
+export * from './progressive-result.js';

package/dist/service/index.js

@@ -0,0 +1,25 @@
+/*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 { isService } from './is-service.js';
+export { addObservableActions } from './add-observable-actions.js';
+export * from './progressive-result.js';
+//# sourceMappingURL=index.js.map

package/dist/service/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/service/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;WAoBW;AAGX,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAA0D,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAC3H,cAAc,yBAAyB,CAAC"}

package/dist/service/is-service.d.ts

@@ -0,0 +1,2 @@
+import { Service } from "./service.js";
+export declare function isService(value: unknown): value is Service;

package/dist/service/is-service.js

@@ -0,0 +1,5 @@
+export function isService(value) {
+    const maybeService = value;
+    return typeof maybeService?.serviceName === 'string';
+}
+//# sourceMappingURL=is-service.js.map

package/dist/service/is-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-service.js","sourceRoot":"","sources":["../../src/service/is-service.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,MAAM,YAAY,GAAG,KAA4C,CAAC;IAClE,OAAO,OAAO,YAAY,EAAE,WAAW,KAAK,QAAQ,CAAC;AACvD,CAAC"}

package/dist/service/progressive-result.d.ts

@@ -0,0 +1,96 @@
+import { Schema } from "../schema/schema.js";
+export type ErrorResult<Result, Error> = Partial<Result> & {
+    readonly error: Error;
+    readonly progress?: number;
+};
+export type IntermediateResult<Result> = Partial<Result> & {
+    readonly error?: never;
+    readonly progress: number;
+};
+export type SuccessResult<Result> = Result & {
+    readonly error?: never;
+    readonly progress: 1.0;
+};
+export type ProgressiveResult<Result, Error> = IntermediateResult<Result> | SuccessResult<Result> | ErrorResult<Result, Error>;
+/**
+ * Results must be objects as we are going to add error and progress properties to them.
+ */
+type ResultSchema = Schema & {
+    properties: {};
+    required: string[];
+};
+/**
+ * Returns a json schema for an final result with the specified value schema.
+ */
+export declare function SuccessResultSchema<T extends ResultSchema>(valueSchema: T): Omit<T, "properties" | "required"> & {
+    readonly type: "object";
+    readonly properties: {
+        readonly progress: {
+            readonly const: 1;
+        };
+    };
+    readonly required: readonly [...string[], "progress"];
+};
+/**
+ * Returns a json schema for an intermediate result with the specified result schema.
+ */
+export declare function IntermediateResultSchema<T extends ResultSchema>(valueSchema: T): Omit<T, "properties" | "required"> & {
+    readonly type: "object";
+    readonly properties: {
+        readonly error: T;
+    };
+    readonly required: readonly ["progress"];
+};
+/**
+ * Returns a json schema for an error result with the specified result schema.
+ */
+export declare function ErrorResultSchema<T extends ResultSchema, E extends ResultSchema>(valueSchema: T, errorSchema: E): Omit<T, "properties" | "required"> & {
+    readonly type: "object";
+    readonly properties: {
+        readonly error: E;
+    };
+    readonly required: readonly ["error"];
+};
+/**
+ * Returns a json schema for a progressive result with the specified result schemas.
+ */
+export declare function ProgressiveResultSchema<T extends ResultSchema, E extends ResultSchema>(successSchema: T, errorSchema: E): {
+    readonly oneOf: readonly [Omit<T, "properties" | "required"> & {
+        readonly type: "object";
+        readonly properties: {
+            readonly error: T;
+        };
+        readonly required: readonly ["progress"];
+    }, Omit<T, "properties" | "required"> & {
+        readonly type: "object";
+        readonly properties: {
+            readonly progress: {
+                readonly const: 1;
+            };
+        };
+        readonly required: readonly [...string[], "progress"];
+    }, Omit<T, "properties" | "required"> & {
+        readonly type: "object";
+        readonly properties: {
+            readonly error: E;
+        };
+        readonly required: readonly ["error"];
+    }];
+};
+/**
+ * Checks if the result is an error result.
+ */
+export declare function isErrorResult<FinalValue extends ResultSchema, ErrorValue>(result: ProgressiveResult<FinalValue, ErrorValue>): result is ErrorResult<FinalValue, ErrorValue>;
+/**
+ * Checks if the result is not started. We check progress < 0.0 to mean not started.
+ */
+export declare function isNotStarted<FinalValue extends ResultSchema, ErrorValue>(result: ProgressiveResult<FinalValue, ErrorValue>): result is IntermediateResult<FinalValue>;
+/**
+ * Checks if the result is an intermediate result.
+ */
+export declare function isIntermediateResult<FinalValue extends ResultSchema, ErrorValue>(result: ProgressiveResult<FinalValue, ErrorValue>): result is IntermediateResult<FinalValue>;
+/**
+ * Checks if the result is a final result.
+ */
+export declare function isSuccessResult<FinalValue extends ResultSchema, ErrorValue>(result: ProgressiveResult<FinalValue, ErrorValue>): result is SuccessResult<FinalValue>;
+export {};

package/dist/service/progressive-result.js

@@ -0,0 +1,99 @@
+/*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.*/
+/**
+ * Returns a json schema for an final result with the specified value schema.
+ */
+export function SuccessResultSchema(valueSchema) {
+    const { properties, required, ...rest } = valueSchema;
+    return {
+        ...rest,
+        type: 'object',
+        properties: {
+            ...properties,
+            progress: { const: 1.0 },
+        },
+        required: [...required, 'progress'],
+    };
+}
+/**
+ * Returns a json schema for an intermediate result with the specified result schema.
+ */
+export function IntermediateResultSchema(valueSchema) {
+    const { properties, required, ...rest } = valueSchema;
+    return {
+        ...rest,
+        type: 'object',
+        properties: {
+            ...properties,
+            error: valueSchema,
+        },
+        required: ['progress'],
+    };
+}
+/**
+ * Returns a json schema for an error result with the specified result schema.
+ */
+export function ErrorResultSchema(valueSchema, errorSchema) {
+    const { properties, required, ...rest } = valueSchema;
+    return {
+        ...rest,
+        type: 'object',
+        properties: {
+            ...properties,
+            error: errorSchema,
+        },
+        required: ['error'],
+    };
+}
+/**
+ * Returns a json schema for a progressive result with the specified result schemas.
+ */
+export function ProgressiveResultSchema(successSchema, errorSchema) {
+    return {
+        oneOf: [IntermediateResultSchema(successSchema), SuccessResultSchema(successSchema), ErrorResultSchema(successSchema, errorSchema)],
+    };
+}
+/**
+ * Checks if the result is an error result.
+ */
+export function isErrorResult(result) {
+    return result.error !== null && result.error !== undefined;
+}
+/**
+ * Checks if the result is not started. We check progress < 0.0 to mean not started.
+ */
+export function isNotStarted(result) {
+    return !isErrorResult(result) && result.progress < 0.0;
+}
+/**
+ * Checks if the result is an intermediate result.
+ */
+export function isIntermediateResult(result) {
+    return !isErrorResult(result) && result.progress !== 1.0;
+}
+/**
+ * Checks if the result is a final result.
+ */
+export function isSuccessResult(result) {
+    return !isErrorResult(result) && result.progress === 1.0;
+}
+//# sourceMappingURL=progressive-result.js.map

package/dist/service/progressive-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"progressive-result.js","sourceRoot":"","sources":["../../src/service/progressive-result.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;WAoBW;AA0BX;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAyB,WAAc;IACxE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,WAAW,CAAC;IACtD,OAAO;QACL,GAAG,IAAI;QACP,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,GAAG,UAAU;YACb,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACzB;QACD,QAAQ,EAAE,CAAC,GAAG,QAAQ,EAAE,UAAU,CAAC;KAC3B,CAAC;AACb,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAyB,WAAc;IAC7E,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,WAAW,CAAC;IACtD,OAAO;QACL,GAAG,IAAI;QACP,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,GAAG,UAAU;YACb,KAAK,EAAE,WAAW;SACnB;QACD,QAAQ,EAAE,CAAC,UAAU,CAAC;KACd,CAAC;AACb,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAiD,WAAc,EAAE,WAAc;IAC9G,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,WAAW,CAAC;IACtD,OAAO;QACL,GAAG,IAAI;QACP,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,GAAG,UAAU;YACb,KAAK,EAAE,WAAW;SACnB;QACD,QAAQ,EAAE,CAAC,OAAO,CAAC;KACX,CAAC;AACb,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACrC,aAAgB,EAChB,WAAc;IAEd,OAAO;QACL,KAAK,EAAE,CAAC,wBAAwB,CAAC,aAAa,CAAC,EAAE,mBAAmB,CAAC,aAAa,CAAC,EAAE,iBAAiB,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;KAC3H,CAAC;AACb,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAiD;IAEjD,OAAO,MAAM,CAAC,KAAK,KAAK,IAAI,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC;AAC7D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAiD;IAEjD,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC;AACzD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAiD;IAEjD,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,QAAQ,KAAK,GAAG,CAAC;AAC3D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAiD;IAEjD,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,QAAQ,KAAK,GAAG,CAAC;AAC3D,CAAC"}

package/dist/service/sequential-action.d.ts

@@ -0,0 +1,18 @@
+import { Data } from '../core/data.js';
+export type SequentialActionResult<Args extends Data[]> = {
+    update: (...args: Args) => SequentialActionResult<Args>;
+    cancel: () => void;
+    commit: () => void;
+};
+/**
+ * A function that represents a transient, sequential series of actions that must end with a commit or cancel.
+ * This is the only service action which can return a value other than void.
+ * It is intended to be used for multiframe transactions.
+ */
+export type SequentialAction<Args extends Data[]> = (...args: Args) => SequentialActionResult<Args>;
+/**
+ * Executes a sequential action using an async iterable iterator that provides the arguments.
+ * @param action - The action to execute.
+ * @param argProvider - An async iterable iterator of arguments to pass to the action.
+ */
+export declare function executeSequentialAction<Arg extends Data>(action: SequentialAction<[Arg]>, argProvider: AsyncIterableIterator<Arg>): Promise<void>;

package/dist/service/sequential-action.js

@@ -0,0 +1,45 @@
+/*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.*/
+/**
+ * Executes a sequential action using an async iterable iterator that provides the arguments.
+ * @param action - The action to execute.
+ * @param argProvider - An async iterable iterator of arguments to pass to the action.
+ */
+export async function executeSequentialAction(action, argProvider) {
+    let sequence;
+    try {
+        //  get the next arguments from the arg provider
+        for await (const arg of argProvider) {
+            //  then write them into the multiframe transaction (persisting this set of updates into database)
+            sequence = (sequence?.update ?? action)(arg);
+        }
+        //  everything succeeded, finalize this transaction.
+        sequence?.commit();
+    }
+    catch (e) {
+        //  cancel the sequence
+        sequence?.cancel();
+        //  allow the async iterable iterator to finalize and close any open resources
+        argProvider.throw?.(e);
+    }
+}
+//# sourceMappingURL=sequential-action.js.map

package/dist/service/sequential-action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sequential-action.js","sourceRoot":"","sources":["../../src/service/sequential-action.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;WAoBW;AAiBX;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAmB,MAA+B,EAAE,WAAuC;IACpI,IAAI,QAAmD,CAAC;IACxD,IAAI,CAAC;QACD,gDAAgD;QAChD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;YAClC,kGAAkG;YAClG,QAAQ,GAAG,CAAC,QAAQ,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;QACjD,CAAC;QACD,oDAAoD;QACpD,QAAQ,EAAE,MAAM,EAAE,CAAC;IACvB,CAAC;IACD,OAAO,CAAC,EAAE,CAAC;QACP,uBAAuB;QACvB,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,8EAA8E;QAC9E,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;AACL,CAAC"}

package/dist/service/service.d.ts

@@ -0,0 +1,4 @@
+export interface Service {
+    readonly serviceName: string;
+    dispose?(): void;
+}

package/dist/service/service.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=service.js.map

package/dist/service/service.js.map

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

package/dist/table/add-row.d.ts

@@ -0,0 +1,8 @@
+import { RowIndex } from "./row-index.js";
+import { Table } from "./table.js";
+/**
+ * Adds a row to the end of the Table.
+ * @param Table
+ * @param rowData
+ */
+export declare const addRow: <C>(table: Table<C>, rowData: C) => RowIndex;