@adobe/data 0.5.1 → 0.5.3

package/dist/services/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, 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, ErrorValue>(result: ProgressiveResult<FinalValue, ErrorValue>): result is IntermediateResult<FinalValue>;
+/**
+ * Checks if the result is an intermediate result.
+ */
+export declare function isIntermediateResult<FinalValue, ErrorValue>(result: ProgressiveResult<FinalValue, ErrorValue>): result is IntermediateResult<FinalValue>;
+/**
+ * Checks if the result is a final result.
+ */
+export declare function isSuccessResult<FinalValue, ErrorValue>(result: ProgressiveResult<FinalValue, ErrorValue>): result is SuccessResult<FinalValue>;
+export { };

package/dist/services/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/services/progressive-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"progressive-result.js","sourceRoot":"","sources":["../../src/services/progressive-result.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;WAoBW;AA4BX;;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/services/service.d.ts

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

package/dist/{cache/functions/types.js → services/service.js}

@@ -20,4 +20,4 @@ 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=types.js.map
+//# sourceMappingURL=service.js.map

package/dist/services/service.js.map

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