@adobe/data 0.5.3 → 0.5.4

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

@@ -1,9 +1,9 @@
 import { Schema } from "../schema/schema.js";
-export type ErrorResult<Result, Error> = Partial<Result> & {
+export type ErrorResult<Error> = {
     readonly error: Error;
     readonly progress?: number;
 };
-export type IntermediateResult<Result> = Partial<Result> & {
+export type IntermediateResult<Result> = Result & {
     readonly error?: never;
     readonly progress: number;
 };
@@ -11,7 +11,8 @@ export type SuccessResult<Result> = Result & {
     readonly error?: never;
     readonly progress: 1.0;
 };
-export type ProgressiveResult<Result, Error> = IntermediateResult<Result> | SuccessResult<Result> | ErrorResult<Result, Error>;
+export type FinalResult<Result, Error> = SuccessResult<Result> | ErrorResult<Error>;
+export type ProgressiveResult<Result, Error, Intermediate = Partial<Result>> = IntermediateResult<Intermediate> | FinalResult<Result, Error>;
 /**
  * Results must be objects as we are going to add error and progress properties to them.
  */
@@ -80,17 +81,13 @@ export declare function ProgressiveResultSchema<T extends ResultSchema, E extend
 /**
  * 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>;
+export declare function isErrorResult<ErrorValue>(result: ProgressiveResult<any, ErrorValue> | FinalResult<any, ErrorValue>): result is ErrorResult<ErrorValue>;
 /**
  * Checks if the result is an intermediate result.
  */
-export declare function isIntermediateResult<FinalValue, ErrorValue>(result: ProgressiveResult<FinalValue, ErrorValue>): result is IntermediateResult<FinalValue>;
+export declare function isIntermediateResult<IntermediateValue>(result: ProgressiveResult<any, any, IntermediateValue>): result is IntermediateResult<IntermediateValue>;
 /**
  * Checks if the result is a final result.
  */
-export declare function isSuccessResult<FinalValue, ErrorValue>(result: ProgressiveResult<FinalValue, ErrorValue>): result is SuccessResult<FinalValue>;
+export declare function isSuccessResult<FinalValue>(result: ProgressiveResult<FinalValue, any, any> | FinalResult<FinalValue, any>): result is SuccessResult<FinalValue>;
 export {};

package/dist/service/progressive-result.js

@@ -78,12 +78,6 @@ export function ProgressiveResultSchema(successSchema, errorSchema) {
 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.
  */

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

@@ -1 +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"}
+{"version":3,"file":"progressive-result.js","sourceRoot":"","sources":["../../src/service/progressive-result.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;WAoBW;AA2BX;;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,MAAyE;IAEzE,OAAO,MAAM,CAAC,KAAK,KAAK,IAAI,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC;AAC7D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAsD;IAEtD,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,QAAQ,KAAK,GAAG,CAAC;AAC3D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,MAA8E;IAE9E,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,QAAQ,KAAK,GAAG,CAAC;AAC3D,CAAC"}

package/dist/service/service.d.ts

@@ -1,4 +1,14 @@
+/**
+ * A service is an object that provides functionality to an application.
+ * Services are never dependent upon user interface components.
+ * Services come in several varieties:
+ * - Frontend Services
+ *   - Only contain void actions and observe functions.
+ *   - Async nature enforces unidirectional control flow and decouples the service from the UI.
+ * - Backend Services
+ *   - Usually consumed by other services.
+ *   - May also contain Promise<Data> or AsyncGenerator<Data> functions.
+ */
 export interface Service {
     readonly serviceName: string;
-    dispose?(): void;
 }

package/dist/service/to-frontend-service.d.ts

@@ -0,0 +1,12 @@
+import { Service } from "./service.js";
+import { Observe } from "../observe/types.js";
+/**
+ * Converts a service to a frontend service by removing all non-observe and non-void action functions recursively.
+ * For each child property value type
+ *   - if it is a service, recursively convert it to a frontend service.
+ *   - if it is a function which returns a function or a service, leave it as is.
+ *   - if it is a non-void action function, convert it's return type to void.
+ */
+export type ToFrontEndService<T extends Service> = {
+    readonly [K in keyof T]: T[K] extends Observe<any> ? T[K] : T[K] extends Service ? ToFrontEndService<T[K]> : T[K] extends (...args: any[]) => (...args: any[]) => any ? T[K] : T[K] extends (...args: any[]) => Service ? T[K] : T[K] extends (...args: any[]) => void | Promise<void> ? T[K] : T[K] extends (...args: infer P) => any ? (...args: P) => void : T[K];
+};

package/dist/service/to-frontend-service.js

@@ -0,0 +1,5 @@
+// Compile-time type unit tests
+{
+}
+export {};
+//# sourceMappingURL=to-frontend-service.js.map

package/dist/service/to-frontend-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-frontend-service.js","sourceRoot":"","sources":["../../src/service/to-frontend-service.ts"],"names":[],"mappings":"AA2BA,+BAA+B;AAC/B,CAAC;AAyED,CAAC"}