@frankieone/one-sdk 0.0.1-npm

package/dist/esm/modules/common/types/oneSDKModules/contextObject.d.ts

@@ -0,0 +1,18 @@
+import { CommonEvents, EventListener, EventsDictionary } from "../..";
+/**
+ * Module context represents an instance of a module. It is the result of calling the initialise function of that module.
+ * Both "Component" and "Flow" are instances of a module which are created by their respective factory functions. The factory function will:
+ * 1) Take any custom options the module might required, as defined by its implementation of the ModuleInitialiseFunction.
+ * 2) Call the ModuleInitialiseFunction with the shared state and the custom options.
+ * 3) Inject instanceName into the resulting context object and store it in the dictionary of instances.
+ * 4) The final object is defiend by the type ModuleInstance below
+ * The ModuleContext interface is the merge of a custom interface for each module with an EventListener (the methods "on" and "off")
+ */
+export type ModuleContext<Context extends object = object, Events extends EventsDictionary = CommonEvents> = Context & EventListener<Events>;
+/**
+ * The context object injected with the instanceName property. Details above.
+ */
+export type ModuleInstance<Ctx extends ModuleContext = ModuleContext> = Ctx & {
+    instanceName: string;
+};
+//# sourceMappingURL=contextObject.d.ts.map

package/dist/esm/modules/common/types/oneSDKModules/contextObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contextObject.d.ts","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKModules/contextObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAE/E;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,SAAS,gBAAgB,GAAG,YAAY,IAAI,OAAO,GAClH,aAAa,CAAC,MAAM,CAAC,CAAC;AACxB;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,GAAG,SAAS,aAAa,GAAG,aAAa,IAAI,GAAG,GAAG;IAAE,YAAY,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/esm/modules/common/types/oneSDKModules/contextObject.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=contextObject.js.map

package/dist/esm/modules/common/types/oneSDKModules/contextObject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contextObject.js","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKModules/contextObject.ts"],"names":[],"mappings":""}

package/dist/esm/modules/common/types/oneSDKModules/definition.types.d.ts

@@ -0,0 +1,71 @@
+import type { EventHub, EventsDictionary } from '../../modules/eventHub';
+import type { Dictionary, EmptyObject, Field } from '../../../../types/index.js';
+import type { ModuleCategory } from './categories';
+import type { ModuleContext, ModuleInstance } from './contextObject';
+import type { ModuleInitialiseFunction } from './initialiseFunction';
+import type { WrapperInitialiseFunction } from '../oneSDKVendorWrappers';
+/**
+ * Provide a type-safe way to define all details about a module in a single location.
+ * ModuleDefinition takes a clear object type where all the module's details are defined, relabels them so they are more easily accessed later (no nesting) and
+ * infer other types such as the initialise functions
+ */
+export type ModuleDefinition<Definition extends Parameters = Parameters> = {
+    moduleName: Field<Definition, 'module', 'name'>;
+    category: Field<Definition, 'module', 'category'>;
+    /** All the options exclusive to this module. This is the same object passed as a second argument to the factory functions
+     * "component" and "flow" */
+    moduleOptions: Field<Definition, 'module', 'options', undefined>;
+    /** The definition of the object returned by the 'raw' module initialisation function. This doesn't
+     * include the extra context injected by 'defineModule' */
+    moduleContext: Field<Definition, 'module', 'context'>;
+    moduleEvents: Field<Definition, 'module', 'events', Dictionary<never>>;
+    /** Module instance, defined by joining 'moduleContext' + event listener for the events in 'moduleEvents' and 'instanceName', defined at runtime */
+    moduleInstance: ModuleInstance<ModuleContext<Field<Definition, 'module', 'context'>, Field<Definition, 'module', 'events'>>>;
+    /** Union of strings representing the different vendor names for this module.
+     *  The provided array will be transformed to a union type, so this can be used as a type, or default to undefined */
+    vendorName: Field<Definition, 'wrapper', 'vendors', undefined, Field<Definition, 'wrapper', 'vendors'>[number]>;
+    /** All the options provided to the vendor wrappers under this module. All wrappers take the same options, if any. */
+    wrapperOptions: Field<Definition, 'wrapper', 'options', undefined>;
+    /** The definition of the object that must be returned by the wrapper initilise function. Not all modules require extended
+     * interactions with wrappers beyond initialisation, so they might not require an object to interact with them and may simply be 'void'. */
+    wrapperContext: Field<Definition, 'wrapper', 'context', void>;
+    /** Wrappers will be asynchronous most of the time, but just in case a wrapper initialisation function needs to be synchronous, that can be set here. */
+    wrapperLoadType: Field<Definition, 'wrapper', 'loadType', 'sync'>;
+    /** The subset of the recipe configuration expected by this module */
+    recipeConfiguration: Field<Definition, 'module', 'recipe', Dictionary<unknown>>;
+    /** The module's initialise function, before it has extra parameters injected by 'defineModule' */
+    moduleInitialiseFunction: ModuleInitialiseFunction<Field<Definition, 'module', 'category'>, ExtendedModuleContext<Field<Definition, 'module', 'category'>, Field<Definition, 'module', 'events'>, Field<Definition, 'module', 'context'>>, Field<Definition, 'module', 'options', void>>;
+    wrapperInitialiseFunction: WrapperInitialiseFunction<Field<Definition, 'wrapper', 'options', undefined>, Field<Definition, 'wrapper', 'context', void>, Field<Definition, 'wrapper', 'loadType'>, InjectedModuleParameters<Field<Definition, 'module', 'category'>, Field<Definition, 'module', 'events'>, Field<Definition, 'module', 'recipe'>>>;
+};
+type Parameters = {
+    module: ModuleSignature;
+    wrapper?: WrapperSignature;
+};
+type ModuleSignature = {
+    category: ModuleCategory;
+    name: string;
+    options?: Dictionary;
+    context: object;
+    events?: EventsDictionary;
+    recipe?: Dictionary;
+};
+type WrapperSignature = {
+    vendors: string[];
+    options?: Dictionary;
+    context?: unknown;
+    loadType?: 'sync' | 'async';
+};
+/** Any extra parameters that may be injected into the initialise function by "defineModule" should be present below */
+export type InjectedModuleParameters<Cat, Events extends EventsDictionary, Recipe extends Dictionary = EmptyObject> = Cat extends CategoryWithListener ? {
+    localEventHub: EventHub<Events>;
+    recipe: Recipe;
+} : object;
+type CategoryWithListener = 'component' | 'flow' | 'private';
+/**
+ * Logic for resolving a module's context object based on their category
+ * If category is either "component", "flow", or "private", wrap provided context in ModuleContext (add common methods to it)
+ * Otherwise, use the provided context as is
+ */
+type ExtendedModuleContext<Cat extends ModuleCategory, Events extends EventsDictionary, Context extends object> = Cat extends CategoryWithListener ? ModuleContext<Context, Events> : Context;
+export {};
+//# sourceMappingURL=definition.types.d.ts.map

package/dist/esm/modules/common/types/oneSDKModules/definition.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"definition.types.d.ts","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKModules/definition.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAClF,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AAEzE;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,UAAU,SAAS,UAAU,GAAG,UAAU,IAAI;IACzE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAChD,QAAQ,EAAE,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IAClD;gCAC4B;IAC5B,aAAa,EAAE,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IACjE;8DAC0D;IAC1D,aAAa,EAAE,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACtD,YAAY,EAAE,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IACvE,mJAAmJ;IACnJ,cAAc,EAAE,cAAc,CAC5B,aAAa,CAAC,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAC7F,CAAC;IACF;yHACqH;IACrH,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IAChH,qHAAqH;IACrH,cAAc,EAAE,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IACnE;+IAC2I;IAC3I,cAAc,EAAE,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IAC9D,wJAAwJ;IACxJ,eAAe,EAAE,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IAClE,qEAAqE;IACrE,mBAAmB,EAAE,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IAEhF,kGAAkG;IAClG,wBAAwB,EAAE,wBAAwB,CAChD,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,EACvC,qBAAqB,CACnB,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,EACvC,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,QAAQ,CAAC,EACrC,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,CACvC,EACD,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,CAC7C,CAAC;IACF,yBAAyB,EAAE,yBAAyB,CAClD,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC,EAClD,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,EAC7C,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,EACxC,wBAAwB,CACtB,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,EACvC,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,QAAQ,CAAC,EACrC,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,QAAQ,CAAC,CACtC,CACF,CAAC;CACH,CAAC;AAgBF,KAAK,UAAU,GAAG;IAChB,MAAM,EAAE,eAAe,CAAC;IACxB,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B,CAAC;AACF,KAAK,eAAe,GAAG;IACrB,QAAQ,EAAE,cAAc,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,MAAM,CAAC,EAAE,UAAU,CAAC;CACrB,CAAC;AACF,KAAK,gBAAgB,GAAG;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC7B,CAAC;AAKF,uHAAuH;AACvH,MAAM,MAAM,wBAAwB,CAClC,GAAG,EACH,MAAM,SAAS,gBAAgB,EAC/B,MAAM,SAAS,UAAU,GAAG,WAAW,IACrC,GAAG,SAAS,oBAAoB,GAChC;IACE,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB,GACD,MAAM,CAAC;AACX,KAAK,oBAAoB,GAAG,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;AAC7D;;;;GAIG;AACH,KAAK,qBAAqB,CACxB,GAAG,SAAS,cAAc,EAC1B,MAAM,SAAS,gBAAgB,EAC/B,OAAO,SAAS,MAAM,IACpB,GAAG,SAAS,oBAAoB,GAAG,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC"}

package/dist/esm/modules/common/types/oneSDKModules/definition.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=definition.types.js.map

package/dist/esm/modules/common/types/oneSDKModules/definition.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definition.types.js","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKModules/definition.types.ts"],"names":[],"mappings":""}

package/dist/esm/modules/common/types/oneSDKModules/index.d.ts

@@ -0,0 +1,7 @@
+export * from './baseParameters.types';
+export * from './definition.types';
+export * from './typeSystem.types';
+export * from './categories';
+export * from './contextObject';
+export * from './initialiseFunction';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/modules/common/types/oneSDKModules/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKModules/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC"}

package/dist/esm/modules/common/types/oneSDKModules/index.js

@@ -0,0 +1,7 @@
+export * from './baseParameters.types.js';
+export * from './definition.types.js';
+export * from './typeSystem.types.js';
+export * from './categories.js';
+export * from './contextObject.js';
+export * from './initialiseFunction.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/modules/common/types/oneSDKModules/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKModules/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC"}

package/dist/esm/modules/common/types/oneSDKModules/initialiseFunction.d.ts

@@ -0,0 +1,48 @@
+import type { ModuleDefinition } from './definition.types';
+import type { Branded, Dictionary } from '../../../../types/index.js';
+import type { BaseParameters } from './baseParameters.types';
+import type { ModuleCategory } from './categories';
+/**
+ * Module Initialise Function
+ * Not all modules actually require extra options and to make it explicit, if ExclusiveOptions isn't defined, it defaults to void
+ * ModuleInitialiseFunctionParameters will simplify typing the arguments for the initialise function
+ */
+export type ModuleInitialiseFunction<Cat extends ModuleCategory, Context extends object = object, ExclusiveOptions extends Dictionary<unknown> | void = void, InjectedParameters extends object = object> = (...args: ModuleInitialiseFunctionParameters<Cat, ExclusiveOptions, InjectedParameters>) => Context;
+/**
+ * Helper type for the initialise function parameters
+ * 1) The first parameter provides global dependencies and depends on the category of the module.
+ * TODO: Remove dependency on category all together. All modules should be able to access all global dependencies.
+ * TODO: Modules with categories other than "component" and "flow" should not be an OneSDK Module.
+ * TODO: Individual Module should be converted to a "component" even though it's special and instantiated internally by the OneSDK.
+ * 2) The second parameter provides special custom options, IF that module has any defined.
+ **/
+export type ModuleInitialiseFunctionParameters<Cat extends ModuleCategory, CustomOptions, InjectedParameters extends object> = CustomOptions extends void ? [global: BaseParameters<Cat> & InjectedParameters] : [global: BaseParameters<Cat> & InjectedParameters, options: CustomOptions];
+/**
+ * Helper to allow ANY module initialise function to be provided as a parameter
+ * Uses all broad type parameters so any valid generic should be acceptable
+ **/
+export type AnyModuleInitialiseFunction = (global: object, options?: object) => object;
+/**
+ * Branding is not only used to enforce the initialise function and the key in the ModuleDictionary object are consistent,
+ * but also to allow the initialise function itself to carry the whole Module definition with it
+ */
+export declare const brandInitialiseFunction: <M extends ModuleDefinition>(name: M['moduleName'], initialise: M['moduleInitialiseFunction']) => BrandedInitialiseFunction<M>;
+export type BrandedInitialiseFunction<Module extends ModuleDefinition = ModuleDefinition> = Branded<Module['moduleInitialiseFunction'], '__definition', Module>;
+/**
+ * Initialisation registry
+ */
+export type InitialisationDictionary = {
+    [k: string]: BrandedInitialiseFunction<ModuleDefinition>;
+};
+/**
+ * Unbranding is used to retrieve the original ModuleDefinition from the initialise function itself (BrandedInitialiseFunction)
+ * type Module = ExtractDefinition<typeof initialiseFunction> = ModuleDefinition
+ */
+export type ExtractDefinition<Initialise> = Initialise extends BrandedInitialiseFunction<infer T extends ModuleDefinition> ? T : never;
+/**
+ * Extract a dictionary of module definitions from a dictionary of initialise functions
+ */
+export type ExtractDefinitions<Dict extends InitialisationDictionary> = {
+    [K in keyof Dict]: ExtractDefinition<Dict[K]>;
+};
+//# sourceMappingURL=initialiseFunction.d.ts.map

package/dist/esm/modules/common/types/oneSDKModules/initialiseFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"initialiseFunction.d.ts","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKModules/initialiseFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qDAAqD,CAAC;AAC5F,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAElD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAEnD;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,CAClC,GAAG,SAAS,cAAc,EAC1B,OAAO,SAAS,MAAM,GAAG,MAAM,EAC/B,gBAAgB,SAAS,UAAU,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,IAAI,EAC1D,kBAAkB,SAAS,MAAM,GAAG,MAAM,IACxC,CAAC,GAAG,IAAI,EAAE,kCAAkC,CAAC,GAAG,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,KAAK,OAAO,CAAC;AAExG;;;;;;;IAOI;AACJ,MAAM,MAAM,kCAAkC,CAC5C,GAAG,SAAS,cAAc,EAC1B,aAAa,EACb,kBAAkB,SAAS,MAAM,IAC/B,aAAa,SAAS,IAAI,GAC1B,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,GAClD,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,CAAC,GAAG,kBAAkB,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;AAE/E;;;IAGI;AACJ,MAAM,MAAM,2BAA2B,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;AAEvF;;;GAGG;AAEH,eAAO,MAAM,uBAAuB,qCAC5B,CAAC,CAAC,YAAY,CAAC,cACT,CAAC,CAAC,0BAA0B,CAAC,iCACsD,CAAC;AAElG,MAAM,MAAM,yBAAyB,CAAC,MAAM,SAAS,gBAAgB,GAAG,gBAAgB,IAAI,OAAO,CACjG,MAAM,CAAC,0BAA0B,CAAC,EAClC,cAAc,EACd,MAAM,CACP,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,CAAC,CAAC,EAAE,MAAM,GAAG,yBAAyB,CAAC,gBAAgB,CAAC,CAAC;CAC1D,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,UAAU,IAAI,UAAU,SAAS,yBAAyB,CACtF,MAAM,CAAC,SAAS,gBAAgB,CACjC,GACG,CAAC,GACD,KAAK,CAAC;AACV;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,IAAI,SAAS,wBAAwB,IAAI;KACrE,CAAC,IAAI,MAAM,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CAC9C,CAAC"}

package/dist/esm/modules/common/types/oneSDKModules/initialiseFunction.js

@@ -0,0 +1,6 @@
+/**
+ * Branding is not only used to enforce the initialise function and the key in the ModuleDictionary object are consistent,
+ * but also to allow the initialise function itself to carry the whole Module definition with it
+ */
+export const brandInitialiseFunction = (name, initialise) => Object.assign(initialise, { __definition: name });
+//# sourceMappingURL=initialiseFunction.js.map

package/dist/esm/modules/common/types/oneSDKModules/initialiseFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initialiseFunction.js","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKModules/initialiseFunction.ts"],"names":[],"mappings":"AAwCA;;;GAGG;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,IAAqB,EACrB,UAAyC,EACzC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,IAAe,EAAE,CAAiC,CAAC"}

package/dist/esm/modules/common/types/oneSDKModules/typeSystem.types.d.ts

@@ -0,0 +1,108 @@
+import type { Dictionary, KeyOf, NOP, ParameterCount } from '../../../../types/index.js';
+import type { ModuleCategory, ModuleCategoryMapping } from './categories';
+import type { ModuleContext } from './contextObject';
+import type { ModuleDefinition } from './definition.types';
+import type { AnyModuleInitialiseFunction } from './initialiseFunction';
+import type { CommonEvents, EventsDictionary } from '../../modules/eventHub';
+/**
+ * Analyse the provided ModulesDefinitionDictionary and generate multiple types to ensure type safety across the entire OneSDK
+ * This reduces the amount of global types needing to be passed around and reduces the amount of boilerplate to
+ * 1) add new modules,
+ * 2) add new module categories and
+ * 3) add new component factories (component/flow methods)
+ *
+ * NOTE:
+ * Unions are written in singular, e.g. "ModuleName": "mod1" | "mod2"
+ * Dictionaries/Objects are written in plural, e.g. "Parameters": { mod1: (...), mod2: (...) }
+ * This is because these objects aren't enums, they are sets of types.
+ */
+export type ModuleTypeSystem<Dict extends ModuleDefinitionDictionary> = NOP<_ModuleTypeSystem<Dict, keyof Dict, InitialiseFunctions<Dict>, Categories<Dict>, ModuleOptions<Dict>, Instances<Dict>, InstanceStores<Dict, Categories<Dict>>>>;
+/** Underlying type to extract types from Dictionary of Modules and to avoid recursive types  */
+type _ModuleTypeSystem<Dict extends ModuleDefinitionDictionary, ModuleName extends keyof Dict, InitialiseFunctions extends Dictionary<AnyModuleInitialiseFunction>, Categories extends ModuleCategoryMapping, ModuleOptions extends Record<ModuleName, unknown>, Instances extends Record<ModuleName, object>, InstanceStores extends Record<ModuleCategory, unknown>> = {
+    moduleName: ModuleName;
+    categories: Categories;
+    /**
+     * Types of the resulting initialise functions for each module
+     */
+    initialiseFunctions: InitialiseFunctions;
+    /**
+     * Determine the type of the unique options parameter required by a module, if any.
+     * The unique parameters are provided as a second parameter to the initialise function, after the common shared parameters.
+     */
+    moduleOptions: ModuleOptions;
+    /**
+     * Each category will require its own factory function. That way developers won't be allowed to initialise a "flow" from a "component" function,
+     * even though they are all stored in the same ModulesDictionary
+     */
+    factoryFunctions: {
+        [C in ModuleCategory]: FactoryFunction<Categories[C] & ModuleName, ModuleOptions, Instances> & {
+            instances: InstanceStores[C];
+        };
+    };
+    /**
+     * Determine the type of the instance of a Module generated by either the "component" or the "flow" factory method.
+     * The returned instance is defined by the Context object and a name for that instance, which defaults to the name of the module.
+     * "setup" modules are not instantiated via factory functions, so they aren't accessible
+     * @example InstanceOf<"component", "myComponent"> = ContextOf<"component"> & { instanceName: "myComponent" }
+     */
+    instances: Instances;
+    /**
+     * ComponentsDictionary is used for caching initialised instances of Component modules
+     * Instances are stored in a dictionary, so they can be retrieved later
+     * Keeping its internal state alive
+     */
+    instancesCache: InstanceStores;
+};
+type ModuleDefinitionDictionary<ModuleName extends string = string> = {
+    [M in ModuleName]: ModuleDefinition & {
+        moduleName: M;
+    };
+};
+type Categories<Dict extends Dictionary<{
+    category: ModuleCategory;
+}>> = {
+    [C in ModuleCategory]: KeyOf<{
+        [M in KeyOf<Dict> as C extends Dict[M]['category'] ? M : never]: M;
+    }>;
+};
+type InitialiseFunctions<Dict extends Dictionary<ModuleDefinition>> = {
+    [M in keyof Dict]: Dict[M]['moduleInitialiseFunction'];
+};
+type ModuleOptions<Dict extends Dictionary<ModuleDefinition>> = {
+    [M in keyof Dict]: Dict[M]['moduleOptions'];
+};
+type Instances<Dict extends Dictionary<ModuleDefinition>> = {
+    [M in keyof Dict]: InstanceObject<Dict[M]['moduleContext'], Dict[M]['moduleEvents']>;
+};
+type InstanceStores<Dict extends Dictionary<ModuleDefinition>, Cats extends Categories<Dict>> = {
+    [C in ModuleCategory]: {
+        [M in Cats[C] & keyof Dict]?: {
+            [instanceName: string]: InstanceObject<Dict[M]['moduleContext'], Dict[M]['moduleEvents']>;
+        };
+    };
+};
+/**
+ * Determine the context of a module (the type of the object returned by the initialisation function)
+ */
+export type InstanceObject<Context extends object, Events extends EventsDictionary = CommonEvents> = ModuleContext<Context, Events> & {
+    instanceName: string;
+};
+/**
+ * Determine the exclusive options for a module, if any.
+ */
+export type OptionsOf<InitFunc extends AnyModuleInitialiseFunction> = ParameterCount<InitFunc> extends 2 ? Parameters<InitFunc>[1] : undefined;
+/**  */
+/** Type of the factory function */
+export type FactoryFunction<ModuleName extends string, Options extends Record<ModuleName, unknown>, Instances extends Record<ModuleName, unknown>> = <Name extends ModuleName>(...args: FactoryParameters<Name, Options[Name]>) => Instances[Name];
+/**
+ * If a module doesn't have exclusive options (second parameter of the initialisation function),
+ * then the second parameter is optional, containing only instanceName
+ * if it has exclusive options, add "instanceName" as an extra optional field
+ **/
+export type FactoryParameters<Name, Options> = Options extends undefined ? [name: Name, options?: {
+    instanceName?: string;
+}] : [name: Name, options?: Options & {
+    instanceName?: string;
+}];
+export {};
+//# sourceMappingURL=typeSystem.types.d.ts.map

package/dist/esm/modules/common/types/oneSDKModules/typeSystem.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeSystem.types.d.ts","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKModules/typeSystem.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAErE,OAAO,KAAK,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAC1E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,sBAAsB,CAAC;AACxE,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE7E;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,0BAA0B,IAAI,GAAG,CACzE,iBAAiB,CACf,IAAI,EACJ,MAAM,IAAI,EACV,mBAAmB,CAAC,IAAI,CAAC,EACzB,UAAU,CAAC,IAAI,CAAC,EAChB,aAAa,CAAC,IAAI,CAAC,EACnB,SAAS,CAAC,IAAI,CAAC,EACf,cAAc,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CACvC,CACF,CAAC;AACF,gGAAgG;AAChG,KAAK,iBAAiB,CACpB,IAAI,SAAS,0BAA0B,EACvC,UAAU,SAAS,MAAM,IAAI,EAC7B,mBAAmB,SAAS,UAAU,CAAC,2BAA2B,CAAC,EACnE,UAAU,SAAS,qBAAqB,EACxC,aAAa,SAAS,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,EACjD,SAAS,SAAS,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,EAC5C,cAAc,SAAS,MAAM,CAAC,cAAc,EAAE,OAAO,CAAC,IACpD;IACF,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,UAAU,CAAC;IAGvB;;OAEG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;IAEzC;;;OAGG;IACH,aAAa,EAAE,aAAa,CAAC;IAC7B;;;OAGG;IACH,gBAAgB,EAAE;SACf,CAAC,IAAI,cAAc,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,EAAE,aAAa,EAAE,SAAS,CAAC,GAAG;YAC/F,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;SAC9B;KACA,CAAC;IAEF;;;;;OAKG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB;;;;OAIG;IACH,cAAc,EAAE,cAAc,CAAC;CAChC,CAAC;AAEF,KAAK,0BAA0B,CAAC,UAAU,SAAS,MAAM,GAAG,MAAM,IAAI;KACnE,CAAC,IAAI,UAAU,GAAG,gBAAgB,GAAG;QAAE,UAAU,EAAE,CAAC,CAAA;KAAE;CACxD,CAAC;AAKF,KAAK,UAAU,CAAC,IAAI,SAAS,UAAU,CAAC;IAAE,QAAQ,EAAE,cAAc,CAAA;CAAE,CAAC,IAAI;KACtE,CAAC,IAAI,cAAc,GAAG,KAAK,CAAC;SAC1B,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC;KACnE,CAAC;CACH,CAAC;AAEF,KAAK,mBAAmB,CAAC,IAAI,SAAS,UAAU,CAAC,gBAAgB,CAAC,IAAI;KACnE,CAAC,IAAI,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC;CACvD,CAAC;AAEF,KAAK,aAAa,CAAC,IAAI,SAAS,UAAU,CAAC,gBAAgB,CAAC,IAAI;KAC7D,CAAC,IAAI,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC;CAC5C,CAAC;AAGF,KAAK,SAAS,CAAC,IAAI,SAAS,UAAU,CAAC,gBAAgB,CAAC,IAAI;KACzD,CAAC,IAAI,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;CACrF,CAAC;AAGF,KAAK,cAAc,CAAC,IAAI,SAAS,UAAU,CAAC,gBAAgB,CAAC,EAAE,IAAI,SAAS,UAAU,CAAC,IAAI,CAAC,IAAI;KAC7F,CAAC,IAAI,cAAc,GAAG;SACpB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC,CAAC,EAAE;YAC5B,CAAC,YAAY,EAAE,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;SAC3F;KACF;CACF,CAAC;AAMF;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,OAAO,SAAS,MAAM,EAAE,MAAM,SAAS,gBAAgB,GAAG,YAAY,IAC/F,aAAa,CACX,OAAO,EACP,MAAM,CACP,GACC;IACF,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,QAAQ,SAAS,2BAA2B,IAAI,cAAc,CAAC,QAAQ,CAAC,SAAS,CAAC,GACpG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GACvB,SAAS,CAAC;AACd,OAAO;AAEP,mCAAmC;AACnC,MAAM,MAAM,eAAe,CACzB,UAAU,SAAS,MAAM,EACzB,OAAO,SAAS,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,EAC3C,SAAS,SAAS,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,IAC3C,CAAC,IAAI,SAAS,UAAU,EAAE,GAAG,IAAI,EAAE,iBAAiB,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,SAAS,CAAC,IAAI,CAAC,CAAC;AAClG;;;;IAII;AACJ,MAAM,MAAM,iBAAiB,CAAC,IAAI,EAAE,OAAO,IAAI,OAAO,SAAS,SAAS,GACpE,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE;IAAE,YAAY,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,GACjD,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG;IAAE,YAAY,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC"}

package/dist/esm/modules/common/types/oneSDKModules/typeSystem.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=typeSystem.types.js.map

package/dist/esm/modules/common/types/oneSDKModules/typeSystem.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeSystem.types.js","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKModules/typeSystem.types.ts"],"names":[],"mappings":""}

package/dist/esm/modules/common/types/oneSDKVendorWrappers/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./initialiseFunction";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/modules/common/types/oneSDKVendorWrappers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKVendorWrappers/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC"}

package/dist/esm/modules/common/types/oneSDKVendorWrappers/index.js

@@ -0,0 +1,2 @@
+export * from "./initialiseFunction.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/modules/common/types/oneSDKVendorWrappers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKVendorWrappers/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC"}

package/dist/esm/modules/common/types/oneSDKVendorWrappers/initialiseFunction.d.ts

@@ -0,0 +1,21 @@
+import { Dictionary } from "../../../../types/index.js";
+import { InjectedState } from "../oneSDKModules";
+/**
+ * Definition for a vendor wrapper initialise function. This is the function that is whats exported by all vendor wrappers.
+ * It takes as type parameters:
+ * 1) the module name which holds and initialises the vendor wrapper.
+ * 2) the custom options that the vendor wrapper takes defined as a dictionary of values
+ * 3) the context object that the vendor wrapper returns, which has no strict definition
+ * 4) whether the vendor wrapper is sync or async, which means the contxt object is either wraped in a promise or not
+ */
+export type WrapperInitialiseFunction<Options extends Dictionary = never, // Vendor wrappers almost always have extra options
+VendorWrapperContext extends unknown | void = void, // But sometimes they don't return anything
+Async extends "sync" | "async" = "sync", InjectedParameters extends object = object> = (b: InjectedState & InjectedParameters, o: Options) => Async extends "async" ? Promise<VendorWrapperContext> : Awaited<VendorWrapperContext>;
+/**
+ * The type of the imported vendor wrapper module.
+ * This allows do define the general shape of the vendor wrapper module and reference in the dynamic import function.
+ */
+export type VendorWrapperImport<Wrapper extends WrapperInitialiseFunction> = {
+    initialise: Wrapper;
+};
+//# sourceMappingURL=initialiseFunction.d.ts.map

package/dist/esm/modules/common/types/oneSDKVendorWrappers/initialiseFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"initialiseFunction.d.ts","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKVendorWrappers/initialiseFunction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD;;;;;;;GAOG;AACH,MAAM,MAAM,yBAAyB,CACnC,OAAO,SAAS,UAAU,GAAG,KAAK,EAAE,mDAAmD;AACvF,oBAAoB,SAAS,OAAO,GAAG,IAAI,GAAG,IAAI,EAAE,2CAA2C;AAC/F,KAAK,SAAS,MAAM,GAAG,OAAO,GAAG,MAAM,EACvC,kBAAkB,SAAS,MAAM,GAAG,MAAM,IACxC,CACF,CAAC,EAAE,aAAa,GAAG,kBAAkB,EACrC,CAAC,EAAE,OAAO,KACP,KAAK,SAAS,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAC3F;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,OAAO,SAAS,yBAAyB,IAAI;IAC3E,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC"}

package/dist/esm/modules/common/types/oneSDKVendorWrappers/initialiseFunction.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=initialiseFunction.js.map

package/dist/esm/modules/common/types/oneSDKVendorWrappers/initialiseFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initialiseFunction.js","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKVendorWrappers/initialiseFunction.ts"],"names":[],"mappings":""}

package/dist/esm/modules/common/types/recipeConfiguration.types.d.ts

@@ -0,0 +1,38 @@
+import type { BiometricsModule } from '../../biometrics';
+import type { FormModule } from '../../form/definition';
+import type { IDVModule } from '../../idv/definition.types';
+import type { OCRModule } from '../../ocr';
+import type { WorkflowModule } from '../../workflow/definition.types';
+import type { PartialDeep } from 'type-fest';
+export type RecipeConfiguration = PartialDeep<RecipeNameConfiguration & BiometricsModule['recipeConfiguration'] & DeviceRecipeConfiguration & IDVModule['recipeConfiguration'] & OCRModule['recipeConfiguration'] & FederationRecipeConfiguration & FormModule['recipeConfiguration'] & WorkflowModule['recipeConfiguration']>;
+type RecipeNameConfiguration = {
+    name: string;
+};
+type DeviceRecipeConfiguration = {
+    deviceCharacteristics: {
+        provider: {
+            name: 'sardine' | 'threatmetrix';
+            clientID: string;
+            environment: 'production' | 'sandbox';
+        };
+    };
+};
+type FederationRecipeConfiguration = {
+    idps: {
+        singpass?: {
+            environment: 'production' | 'sandbox' | 'test';
+            client_id: string;
+            attributes: string;
+            purpose: string;
+            state: string;
+            redirect_url: string;
+        };
+        google?: {
+            redirect_url: string;
+            clientId: string;
+        };
+    };
+    federation?: keyof RecipeConfiguration['idps'];
+};
+export {};
+//# sourceMappingURL=recipeConfiguration.types.d.ts.map

package/dist/esm/modules/common/types/recipeConfiguration.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipeConfiguration.types.d.ts","sourceRoot":"","sources":["../../../../../modules/common/types/recipeConfiguration.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AAExE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAK7C,MAAM,MAAM,mBAAmB,GAAG,WAAW,CAC3C,uBAAuB,GACvB,gBAAgB,CAAC,qBAAqB,CAAC,GACvC,yBAAyB,GACzB,SAAS,CAAC,qBAAqB,CAAC,GAChC,SAAS,CAAC,qBAAqB,CAAC,GAChC,6BAA6B,GAC7B,UAAU,CAAC,qBAAqB,CAAC,GACjC,cAAc,CAAC,qBAAqB,CAAC,CACtC,CAAC;AAEF,KAAK,uBAAuB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,KAAK,yBAAyB,GAAG;IAC/B,qBAAqB,EAAE;QACrB,QAAQ,EAAE;YACR,IAAI,EAAE,SAAS,GAAG,cAAc,CAAC;YACjC,QAAQ,EAAE,MAAM,CAAC;YACjB,WAAW,EAAE,YAAY,GAAG,SAAS,CAAC;SACvC,CAAC;KACH,CAAC;CACH,CAAC;AAEF,KAAK,6BAA6B,GAAG;IACnC,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE;YACT,WAAW,EAAE,YAAY,GAAG,SAAS,GAAG,MAAM,CAAC;YAC/C,SAAS,EAAE,MAAM,CAAC;YAClB,UAAU,EAAE,MAAM,CAAC;YACnB,OAAO,EAAE,MAAM,CAAC;YAChB,KAAK,EAAE,MAAM,CAAC;YACd,YAAY,EAAE,MAAM,CAAC;SACtB,CAAC;QACF,MAAM,CAAC,EAAE;YACP,YAAY,EAAE,MAAM,CAAC;YACrB,QAAQ,EAAE,MAAM,CAAC;SAClB,CAAC;KACH,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,mBAAmB,CAAC,MAAM,CAAC,CAAC;CAChD,CAAC"}

package/dist/esm/modules/common/types/recipeConfiguration.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=recipeConfiguration.types.js.map

package/dist/esm/modules/common/types/recipeConfiguration.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipeConfiguration.types.js","sourceRoot":"","sources":["../../../../../modules/common/types/recipeConfiguration.types.ts"],"names":[],"mappings":""}

package/dist/esm/modules/common/vendors/form/promisifyForm.d.ts

@@ -0,0 +1,14 @@
+import type { Document } from '../../shared/models/Document';
+import type { FormModule } from '../../../form/definition';
+/**
+ * Convert the Form execution into a promise. This function will mount the
+ * Form and wait for user completion, resulting in a Document object
+ * @param form The Form module instance object generated by calling component('form')
+ * @param args The expected document id to be found after form emits results
+ * @returns The document object containing the specified document id
+ */
+export declare function promisifyForm(form: FormModule['moduleInstance'], args: {
+    documentId: string;
+    mountElement: HTMLElement;
+}): Promise<Document>;
+//# sourceMappingURL=promisifyForm.d.ts.map

package/dist/esm/modules/common/vendors/form/promisifyForm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promisifyForm.d.ts","sourceRoot":"","sources":["../../../../../../modules/common/vendors/form/promisifyForm.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;;;;;GAMG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,EAClC,IAAI,EAAE;IACJ,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,WAAW,CAAC;CAC3B,GACA,OAAO,CAAC,QAAQ,CAAC,CAWnB"}

package/dist/esm/modules/common/vendors/form/promisifyForm.js

@@ -0,0 +1,31 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+/**
+ * Convert the Form execution into a promise. This function will mount the
+ * Form and wait for user completion, resulting in a Document object
+ * @param form The Form module instance object generated by calling component('form')
+ * @param args The expected document id to be found after form emits results
+ * @returns The document object containing the specified document id
+ */
+export function promisifyForm(form, args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { documentId, mountElement } = args;
+        return new Promise((resolve, reject) => {
+            const findDocument = (d) => d.documentId === documentId;
+            form.on('results', ({ documents }) => {
+                const updatedDocument = documents.find(findDocument);
+                resolve(updatedDocument);
+            });
+            form.on('error', reject);
+            form.mount(mountElement);
+        });
+    });
+}
+//# sourceMappingURL=promisifyForm.js.map

package/dist/esm/modules/common/vendors/form/promisifyForm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promisifyForm.js","sourceRoot":"","sources":["../../../../../../modules/common/vendors/form/promisifyForm.ts"],"names":[],"mappings":";;;;;;;;;AAGA;;;;;;GAMG;AACH,MAAM,UAAgB,aAAa,CACjC,IAAkC,EAClC,IAGC;;QAED,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;QAC1C,OAAO,IAAI,OAAO,CAAW,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC/C,MAAM,YAAY,GAAG,CAAC,CAAW,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,UAAU,CAAC;YAClE,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE;gBACnC,MAAM,eAAe,GAAG,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBACrD,OAAO,CAAC,eAAe,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YACzB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;CAAA"}

package/dist/esm/modules/common/vendors/form/useForm.d.ts

@@ -0,0 +1,36 @@
+import { OneSDKError } from '../../errors/OneSDKError.class';
+import type { EventHub } from '../../modules/eventHub';
+import type { Document } from '../../shared/models/Document';
+import type { OneSdkContext } from '../../../types';
+type IDVResults = {
+    document: Document;
+    entityId: string;
+};
+type Dependencies = {
+    oneSdkInstance: OneSdkContext;
+    localEventHub: EventHub<{
+        loading: [boolean, {
+            message: string;
+        }];
+        detection_complete: [];
+        detection_failed: [OneSDKError];
+        results: [IDVResults];
+        ready: [{
+            domElement: HTMLElement;
+        }];
+    }>;
+    mountElement: HTMLElement;
+    /** When this option is true, the Form will be rendered before the 'results' event. */
+    attachForm: boolean;
+};
+/**
+ * Use currying to create a callback function that will be called when the vendor emits "results" event.
+ * The callback may or may not include the Form for reviewing the results,
+ * based on the value of the "attachForm" parameter.
+ *
+ * Attention: The caller "loading" state should be true when calling this method.
+ * A "loading" false event will be emitted when the initial actions are completed.
+ */
+export declare function useFormToReviewResults(deps: Dependencies): (results: IDVResults) => Promise<void>;
+export {};
+//# sourceMappingURL=useForm.d.ts.map

package/dist/esm/modules/common/vendors/form/useForm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useForm.d.ts","sourceRoot":"","sources":["../../../../../../modules/common/vendors/form/useForm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AAMtE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnD,KAAK,UAAU,GAAG;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAC3D,KAAK,YAAY,GAAG;IAClB,cAAc,EAAE,aAAa,CAAC;IAC9B,aAAa,EAAE,QAAQ,CAAC;QACtB,OAAO,EAAE,CAAC,OAAO,EAAE;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACxC,kBAAkB,EAAE,EAAE,CAAC;QACvB,gBAAgB,EAAE,CAAC,WAAW,CAAC,CAAC;QAChC,OAAO,EAAE,CAAC,UAAU,CAAC,CAAC;QACtB,KAAK,EAAE,CAAC;YAAE,UAAU,EAAE,WAAW,CAAA;SAAE,CAAC,CAAC;KACtC,CAAC,CAAC;IACH,YAAY,EAAE,WAAW,CAAC;IAC1B,sFAAsF;IACtF,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,YAAY,aAGf,UAAU,mBAoDnD"}