@frankieone/one-sdk 0.7.2-alpha → 0.7.3-rc

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

@@ -0,0 +1,104 @@
+import { Dictionary, KeyOf, NOP } from "@types";
+import { EventsDictionary } from "../../modules/eventHub";
+import { ModuleDefinition } from "./Definition";
+import { ModuleCategory, ModuleCategoryMapping } from "./categories";
+import { ModuleContext } from "./contextObject";
+import { AnyModuleInitialiseFunction } from "./initialiseFunction";
+/**
+ * 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 = EventsDictionary> = ModuleContext<Context, Events> & {
+    instanceName: string;
+};
+/**  */
+/** 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.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TypeSystem.d.ts","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKModules/TypeSystem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,EAAkB,MAAM,QAAQ,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,2BAA2B,EAAE,MAAM,sBAAsB,CAAC;AAEnE;;;;;;;;;;;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;YAC7F,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;SAC9B;KACF,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,gBAAgB,IAAI,aAAa,CACpH,OAAO,EACP,MAAM,CACP,GAAG;IACF,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAQF,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,EAAE,OAAO,GAAG;IAAE,YAAY,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC"}

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

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

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

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

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

@@ -0,0 +1,19 @@
+export type ModuleCategory = "component" | "flow" | "private" | "setup";
+/**
+ * ModuleCategories
+ * ----[ Component modules
+ * These are the main modules of the OneSDK. They are the bricks with which the OneSDK provides all the different functionalities. They will usually map to FrankieOne services.
+ * ----[ Flow modules
+ * Similar to Component modules, they are a bit more abstract and offer simplified functionalities around the Component modules. They may initialise multiple components and orchestrate them,
+ * or provide direct integration with Vendors which offer bundle services, which can't be split into Components
+ * ----[ Private modules
+ * Used mainly internally and because multiple modules rely on their behaviour to be consistent, they are more strictly controlled. The "individual" module is currently the only in this category, but eventually "organisation" will be another.
+ * ----[ Setup modules
+ * Use exclusively internally by the OneSDK initialisation process. They are not exposed to the user and are not part of the OneSDK public API. They are still available for use by other modules.
+ * "Session" is an example of a pre initialisation module. It is initialised with the OneSDK and made available to other modules, allowing each of them to manage the OneSDK session internally.
+ *
+ * TODO: Get rid of Setup modules entirely. These don't need to be a category of modules and can be used ad-hoc, without any constraints or special treatment.
+ * TODO: These modules can be shared along with the GlobalState object and made available everywhere without being tied to the same restrictions as "component", "flow", or "private" modules.
+ */
+export type ModuleCategoryMapping<ModuleName extends string = string> = Record<ModuleCategory, ModuleName>;
+//# sourceMappingURL=categories.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"categories.d.ts","sourceRoot":"","sources":["../../../../../../modules/common/types/oneSDKModules/categories.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;AACxE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,qBAAqB,CAAC,UAAU,SAAS,MAAM,GAAG,MAAM,IAAI,MAAM,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC"}

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

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

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

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

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

@@ -0,0 +1,18 @@
+import { EventListener, EventsDictionary } from "@module/common";
+/**
+ * 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 = EventsDictionary> = 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,aAAa,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAEjE;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,CACvB,OAAO,SAAS,MAAM,GAAG,MAAM,EAC/B,MAAM,SAAS,gBAAgB,GAAG,gBAAgB,IAChD,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AACpC;;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/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./BaseParameters";
+export * from "./Definition";
+export * from "./TypeSystem";
+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,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,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";
+export * from "./Definition";
+export * from "./TypeSystem";
+export * from "./categories";
+export * from "./contextObject";
+export * from "./initialiseFunction";
+//# 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,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC"}

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

@@ -0,0 +1,40 @@
+import { ModuleDefinition } from "@module/common/types/oneSDKModules/Definition";
+import { Branded, Dictionary } from "@types";
+import { BaseParameters } from "./BaseParameters";
+import { 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
+ */
+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 differentiating between initialisation functions with and without custom options, based on the type of the module */
+export type ModuleInitialiseFunctionParameters<Cat extends ModuleCategory, CustomOptions, InjectedParameters extends object> = CustomOptions extends void ? [shared: BaseParameters<Cat> & InjectedParameters] : [shared: 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 = (shared: 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,EAAE,gBAAgB,EAAE,MAAM,+CAA+C,CAAC;AACjF,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C;;;GAGG;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,wIAAwI;AACxI,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,gIAGyD,CAAC;AAE9F,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;AAGF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,UAAU,IAAI,UAAU,SAAS,yBAAyB,CAAC,MAAM,CAAC,SAAS,gBAAgB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACvI;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,IAAI,SAAS,wBAAwB,IAAI;KACrE,CAAC,IAAI,MAAM,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CAC9C,CAAA"}

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":"AA+BA;;;GAGG;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,IAAqB,EACrB,UAAyC,EACzC,EAAE,CAA+B,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,YAAY,EAAW,IAAI,EAAE,CAAC,CAAC"}

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";
+//# 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";
+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/config/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * modules will "define" each of the modules in the SDK, by
+ * 1) importing the index script of each, which will call "defineModule" and install each of their initialise functions into the (untyped) global object of initialise functions
+ * 2) importing the ModuleDefinition type of each of them and analysing them all and reexporting a Modules global type with all details extracted from each
+ * 3) exporting a Modules global object with all initialise functions, but now typed with the Modules global type
+ *
+ * For that reason, code inside modules cannot access the typed global object of initialise functions directly, but they may use the factory functions "component" and "flow".
+ */
+export * from "./modules";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/modules/config/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../modules/config/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,cAAc,WAAW,CAAC"}

package/dist/esm/modules/config/index.js

@@ -0,0 +1,10 @@
+/**
+ * modules will "define" each of the modules in the SDK, by
+ * 1) importing the index script of each, which will call "defineModule" and install each of their initialise functions into the (untyped) global object of initialise functions
+ * 2) importing the ModuleDefinition type of each of them and analysing them all and reexporting a Modules global type with all details extracted from each
+ * 3) exporting a Modules global object with all initialise functions, but now typed with the Modules global type
+ *
+ * For that reason, code inside modules cannot access the typed global object of initialise functions directly, but they may use the factory functions "component" and "flow".
+ */
+export * from "./modules";
+//# sourceMappingURL=index.js.map

package/dist/esm/modules/config/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/config/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,cAAc,WAAW,CAAC"}

package/dist/esm/modules/config/modules.d.ts

@@ -0,0 +1,58 @@
+import { BrandedInitialiseFunction, ExtractDefinitions, ModuleTypeSystem } from "@module/common/types";
+/**
+ * ADDING NEW MODULES
+ * 0) Choose an appropriate simple kebab-case name for your module. Ideally just a single word.
+ *    This name will be used by developers to initialise your module.
+ *    ie: component("biometrics"), or flow("idv")
+ *
+ * 1) Define the module
+ * 1.0) Create a folder with the same name as the module {module}
+ * 1.1) In the file "{module}/definition.ts", create create a type definition "{module}Module" for your module using the type "ModuleDefinition",
+ * where you will provide the chosen name, among other options.
+ * 1.2) Define the initialisation function for your module and pass it to the "defineModule" function, along with the "ModuleDefinition" type parameter.
+ * That function will add additional commmon functionality and enforce typing. Export the result of that function as the default export of the file.
+ *
+ * PS) The "defineModule" function will also "Brand" the initialise function with the ModuleDefinition, so the function will always carry the ModuleDefinition type with it, which can be retrieved with ExtractDefinition<typeof initialiseFunction>
+ *
+ * @example <caption>Example of a module definition</caption>
+ * export default defineModule<ModuleDefinition>("module-name", (globalState, customOptions) => {
+ *  // Do module things here
+ *  // Return the module context object
+ *  return { ... }
+ * });
+ *
+ * 2) Add it to the global Modules configuration
+ * Across the entire OneSDK, for the module name to be recognised as a valid and instantiable module, it needs to be part of the OneSDK modules type system.
+ * The "ModuleDefinition" for each module can be extracted from the dictionary "ConfiguredModules"
+ * The type system uses the "ConfiguredModules" to categorise and extract all sorts of particularities for each module. Interpreting them and making a summary available throughout the SDK from a single type called "Modules".
+ * 2.1) Import the initialise function and add it to the Modules object below.
+ *
+ * TLDR:
+ * - Define the module and add it to the global configuration below.
+ * - The type "Modules" works as a global namespace for all types inferred from all the modules included in the dictionary.
+ */
+declare const Modules: {
+    biometrics: BrandedInitialiseFunction<import("@module/biometrics").BiometricsModule>;
+    device: BrandedInitialiseFunction<import("@module/device").DeviceModule>;
+    ocr: BrandedInitialiseFunction<import("@module/ocr").OCRModule>;
+    individual: BrandedInitialiseFunction<import("@module/individual").IndividualModule>;
+    session: BrandedInitialiseFunction<import("@module/session").SessionModule>;
+    federation: BrandedInitialiseFunction<import("@module/federation").FederationModule>;
+    idv: BrandedInitialiseFunction<import("@module/idv").IDVModule>;
+};
+export type ConfiguredModules = ExtractDefinitions<typeof Modules>;
+export type Modules = ModuleTypeSystem<ConfiguredModules>;
+/**
+ * Helper function to retrieve the initialise function for a module
+ */
+export declare const getInitialiser: <Name extends "session" | "biometrics" | "ocr" | "federation" | "idv" | "device" | "individual">(name: Name) => BrandedInitialiseFunction<ExtractDefinitions<{
+    biometrics: BrandedInitialiseFunction<import("@module/biometrics").BiometricsModule>;
+    device: BrandedInitialiseFunction<import("@module/device").DeviceModule>;
+    ocr: BrandedInitialiseFunction<import("@module/ocr").OCRModule>;
+    individual: BrandedInitialiseFunction<import("@module/individual").IndividualModule>;
+    session: BrandedInitialiseFunction<import("@module/session").SessionModule>;
+    federation: BrandedInitialiseFunction<import("@module/federation").FederationModule>;
+    idv: BrandedInitialiseFunction<import("@module/idv").IDVModule>;
+}>[Name]>;
+export {};
+//# sourceMappingURL=modules.d.ts.map

package/dist/esm/modules/config/modules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modules.d.ts","sourceRoot":"","sources":["../../../../modules/config/modules.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAEvG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,QAAA,MAAM,OAAO;;;;;;;;CAQZ,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,OAAO,OAAO,CAAC,CAAC;AACnE,MAAM,MAAM,OAAO,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;AAC1D;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;SAM1B,CAAC"}

package/dist/esm/modules/config/modules.js

@@ -0,0 +1,58 @@
+import BiometricsModule from "../biometrics";
+import DeviceModule from "../device";
+import FederationModule from "../federation";
+import IDVModule from "../idv";
+import IndividualModule from "../individual";
+import OCRModule from "../ocr";
+import SessionModule from "../session";
+/**
+ * ADDING NEW MODULES
+ * 0) Choose an appropriate simple kebab-case name for your module. Ideally just a single word.
+ *    This name will be used by developers to initialise your module.
+ *    ie: component("biometrics"), or flow("idv")
+ *
+ * 1) Define the module
+ * 1.0) Create a folder with the same name as the module {module}
+ * 1.1) In the file "{module}/definition.ts", create create a type definition "{module}Module" for your module using the type "ModuleDefinition",
+ * where you will provide the chosen name, among other options.
+ * 1.2) Define the initialisation function for your module and pass it to the "defineModule" function, along with the "ModuleDefinition" type parameter.
+ * That function will add additional commmon functionality and enforce typing. Export the result of that function as the default export of the file.
+ *
+ * PS) The "defineModule" function will also "Brand" the initialise function with the ModuleDefinition, so the function will always carry the ModuleDefinition type with it, which can be retrieved with ExtractDefinition<typeof initialiseFunction>
+ *
+ * @example <caption>Example of a module definition</caption>
+ * export default defineModule<ModuleDefinition>("module-name", (globalState, customOptions) => {
+ *  // Do module things here
+ *  // Return the module context object
+ *  return { ... }
+ * });
+ *
+ * 2) Add it to the global Modules configuration
+ * Across the entire OneSDK, for the module name to be recognised as a valid and instantiable module, it needs to be part of the OneSDK modules type system.
+ * The "ModuleDefinition" for each module can be extracted from the dictionary "ConfiguredModules"
+ * The type system uses the "ConfiguredModules" to categorise and extract all sorts of particularities for each module. Interpreting them and making a summary available throughout the SDK from a single type called "Modules".
+ * 2.1) Import the initialise function and add it to the Modules object below.
+ *
+ * TLDR:
+ * - Define the module and add it to the global configuration below.
+ * - The type "Modules" works as a global namespace for all types inferred from all the modules included in the dictionary.
+ */
+const Modules = {
+    biometrics: BiometricsModule,
+    device: DeviceModule,
+    ocr: OCRModule,
+    individual: IndividualModule,
+    session: SessionModule,
+    federation: FederationModule,
+    idv: IDVModule,
+};
+/**
+ * Helper function to retrieve the initialise function for a module
+ */
+export const getInitialiser = (name) => {
+    const initialiser = Modules[name];
+    if (!initialiser)
+        throw new Error(`Initialiser for '${name}' was not found. Make sure the module was correctly defined`);
+    return initialiser;
+};
+//# sourceMappingURL=modules.js.map

package/dist/esm/modules/config/modules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modules.js","sourceRoot":"","sources":["../../../../modules/config/modules.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAClD,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAClD,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAClD,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAI5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,OAAO,GAAG;IACd,UAAU,EAAE,gBAAgB;IAC5B,MAAM,EAAE,YAAY;IACpB,GAAG,EAAE,SAAS;IACd,UAAU,EAAE,gBAAgB;IAC5B,OAAO,EAAE,aAAa;IACtB,UAAU,EAAE,gBAAgB;IAC5B,GAAG,EAAE,SAAS;CACf,CAAC;AAIF;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAqC,IAAU,EAAE,EAAE;IAC/E,MAAM,WAAW,GAA8B,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7D,IAAI,CAAC,WAAW;QACd,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAI,6DAA6D,CAAC,CAAC;IAEzG,OAA2D,WAAW,CAAC;AACzE,CAAC,CAAC"}

package/dist/esm/modules/device/constants.d.ts

@@ -1,4 +1,5 @@
 export declare const VendorList: readonly ["sardine", "threatmetrix"];
 export declare const ActivityTypeList: readonly ["REGISTRATION", "LOGIN", "CRYPTO_DEPOSIT", "CRYPTO_WITHDRAWAL", "FIAT_DEPOSIT", "FIAT_WITHDRAWAL"];
-export declare type Vendor = typeof VendorList[number];
-export declare type ActivityType = typeof ActivityTypeList[number];
+export type Vendor = typeof VendorList[number];
+export type ActivityType = typeof ActivityTypeList[number];
+//# sourceMappingURL=constants.d.ts.map

package/dist/esm/modules/device/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../modules/device/constants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,UAAU,sCAAqC,CAAC;AAC7D,eAAO,MAAM,gBAAgB,8GAO5B,CAAC;AACF,MAAM,MAAM,MAAM,GAAG,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC;AAC/C,MAAM,MAAM,YAAY,GAAG,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC"}

package/dist/esm/modules/device/definition.d.ts

@@ -0,0 +1,34 @@
+import type { EventHub } from "@module/common";
+import type { ModuleDefinition } from "@module/common/types";
+import type { ActivityType } from "./constants";
+import type { Events } from "./events";
+export type DeviceModule = ModuleDefinition<{
+    module: {
+        category: "component";
+        name: "device";
+        context: {
+            start: () => void;
+        };
+        options: {
+            activityType: ActivityType;
+        };
+        events: Events;
+    };
+    wrapper: {
+        vendors: ["sardine", "threatmetrix"];
+        options: {
+            eventHub: EventHub<Events>;
+            activityType: ActivityType;
+        };
+        context: {
+            set<Key extends keyof SetOptions>(key: Key, value: SetOptions[Key]): void;
+        };
+        loadType: "async";
+    };
+}>;
+type SetOptions = {
+    activityType: ActivityType;
+    entityId: string;
+};
+export {};
+//# sourceMappingURL=definition.d.ts.map

package/dist/esm/modules/device/definition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"definition.d.ts","sourceRoot":"","sources":["../../../../modules/device/definition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,MAAM,YAAY,GAAG,gBAAgB,CAAC;IAC1C,MAAM,EAAE;QACN,QAAQ,EAAE,WAAW,CAAC;QACtB,IAAI,EAAE,QAAQ,CAAC;QACf,OAAO,EAAE;YACP,KAAK,EAAE,MAAM,IAAI,CAAC;SACnB,CAAC;QACF,OAAO,EAAE;YACP,YAAY,EAAE,YAAY,CAAC;SAC5B,CAAC;QACF,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,OAAO,EAAE;QACP,OAAO,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QACrC,OAAO,EAAE;YACP,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC3B,YAAY,EAAE,YAAY,CAAC;SAC5B,CAAC;QACF,OAAO,EAAE;YACP,GAAG,CAAC,GAAG,SAAS,MAAM,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;SAC3E,CAAC;QACF,QAAQ,EAAE,OAAO,CAAC;KACnB,CAAC;CACH,CAAC,CAAC;AAEH,KAAK,UAAU,GAAG;IAChB,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/esm/modules/device/definition.js

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

package/dist/esm/modules/device/definition.js.map

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

package/dist/esm/modules/device/events.d.ts

@@ -1,6 +1,6 @@
-import { RecipeConfiguration } from "../common";
+import { RecipeConfiguration } from "@module/common";
 import { ActivityType, Vendor } from "./constants";
-export declare type Events = {
+export type Events = {
     configuration_loaded: [RecipeConfiguration];
     activity_started: [{
         activityType: ActivityType;
@@ -28,3 +28,4 @@ interface Core {
     DeviceDetailsObject: Record<string, never>;
 }
 export {};
+//# sourceMappingURL=events.d.ts.map

package/dist/esm/modules/device/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../modules/device/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAEnD,MAAM,MAAM,MAAM,GAAG;IACnB,oBAAoB,EAAE,CAAC,mBAAmB,CAAC,CAAC;IAC5C,gBAAgB,EAAE,CAAC;QAAE,YAAY,EAAE,YAAY,CAAA;KAAE,CAAC,CAAC;IACnD,gCAAgC,EAAE,CAAC;QAAE,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,CAAA;KAAE,CAAC,CAAC;IACxG,SAAS,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC;IACzC,iBAAiB,EAAE,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACxC,yBAAyB,EAAE,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IACtE,sBAAsB,EAAE,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAC/C,SAAS,EAAE,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CAC9C,CAAC;AAEF,UAAU,IAAI;IACZ,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAC5C"}

package/dist/esm/modules/device/index.d.ts

@@ -1,23 +1,7 @@
-import { EventHub } from "../common";
-import { ModuleContext, ModuleInitialiseFunction } from "../sdk";
-import { ActivityType } from "./constants";
-import { Events } from "./events";
+import { DeviceModule } from "./definition";
+declare const _default: import("../common/types").BrandedInitialiseFunction<DeviceModule>;
+export default _default;
 export * from "./constants";
+export * from "./definition";
 export * from "./events";
-export declare const initialise: ModuleInitialiseFunction<"device", DeviceModuleContext, DeviceModuleOptions>;
-export declare type DeviceModuleOptions = {
-    activityType: ActivityType;
-};
-export declare type DeviceModuleContext = ModuleContext<{
-    start: () => void;
-}, Events>;
-export declare type DeviceWrapperOptions = DeviceModuleOptions & {
-    eventHub: EventHub<Events>;
-};
-export declare type DeviceWrapperContext = {
-    set<Key extends keyof SetOptions>(key: Key, value: SetOptions[Key]): void;
-};
-export declare type SetOptions = {
-    activityType: ActivityType;
-    entityId: string;
-};
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/modules/device/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../modules/device/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;;AAG5C,wBAkEG;AAEH,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC"}