@frankieone/one-sdk 0.7.2-alpha → 0.7.4-alpha

package/dist/version.txt

@@ -1,2 +1,2 @@
-0.7.2-alpha
-v0.7.2-alpha
+0.7.4-alpha
+v0.7.4-alpha

package/package.json

@@ -4,6 +4,10 @@
     "email": "pedro@frankieone.com",
     "url": "https://frankieone.com"
   },
+  "engines": {
+    "node": "18",
+    "npm": "9"
+  },
   "dependencies": {
     "axios": "^0.27.2",
     "base-64": "^1.0.0",
@@ -34,6 +38,7 @@
     "@rollup/plugin-node-resolve": "^14.1.0",
     "@rollup/plugin-typescript": "^8.5.0",
     "@types/base-64": "^1.0.0",
+    "@types/dotenv-flow": "^3.2.0",
     "@types/estree": "^1.0.0",
     "@types/event-emitter": "^0.3.3",
     "@types/jest": "^27.5.1",
@@ -68,6 +73,7 @@
     "jwt-encode": "^1.0.1",
     "lint-staged": "^12.4.0",
     "live-server": "^1.2.2",
+    "madge": "^6.0.0",
     "mini-css-extract-plugin": "^2.6.0",
     "node-polyfill-webpack-plugin": "^2.0.1",
     "npm-run-all": "^4.1.5",
@@ -88,7 +94,7 @@
     "ts-node": "^10.8.0",
     "tsc-alias": "^1.6.7",
     "tsconfig-paths-webpack-plugin": "^3.5.2",
-    "typescript": "4.6",
+    "typescript": "^5.0.4",
     "vite": "^2.9.6",
     "vite-plugin-html": "^3.0.6",
     "vite-plugin-replace": "^0.1.1",
@@ -100,7 +106,7 @@
   "peerDependencies": {
     "ts-toolbelt": "^9.0.0",
     "type-fest": "^2.0.0",
-    "typescript": "^4.0.0"
+    "typescript": "^5.0.4"
   },
   "keywords": [],
   "license": "ISC",
@@ -133,13 +139,13 @@
     "build:playground": "cd apps/playground && npm run build",
     "build:npm-import-app": "cd apps/npm-import && npm run build",
     "watch": "webpack --watch",
-    "tsc-check": "tsc -p ./modules/tsconfig.json --noEmit",
+    "tsc-check": "tsc -p ./tsconfig.base.json --noEmit",
     "eslint-check": "eslint . -c .eslintrc.cjs --quiet --exit-on-fatal-error",
     "curr-version": "echo $npm_package_version"
   },
   "types": "./dist/esm/modules/index.d.ts",
   "type": "module",
-  "version": "0.7.2-alpha",
+  "version": "0.7.4-alpha",
   "files": [
     "dist/**/*",
     "README.md"

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

@@ -1,2 +0,0 @@
-export declare const VendorList: readonly ["ocrlabs"];
-export declare type Vendor = typeof VendorList[number] | "dummy-biometrics";

package/dist/esm/modules/biometrics/constants.js

@@ -1,2 +0,0 @@
-export const VendorList = ["ocrlabs" /*, "onfido"*/];
-//# sourceMappingURL=constants.js.map

package/dist/esm/modules/biometrics/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../modules/biometrics/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,SAAS,CAAC,cAAc,CAAU,CAAC"}

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

@@ -1,18 +0,0 @@
-/** MODULE TYPES */
-export declare type PublicModuleName = "biometrics" | "device" | "ocr" | "federation";
-export declare type PrivateModuleName = "individual";
-export declare type PreInitialisationModuleName = "session";
-/** MODULES DICTIONARY */
-export declare const ModulesDictionary: {
-    readonly biometrics: import("./sdk").ModuleInitialiseFunction<"biometrics", import("./biometrics").BiometricsModuleContext, import("../types/index.js")._DictionaryWrite<never>>;
-    readonly device: import("./sdk").ModuleInitialiseFunction<"device", import("./device").DeviceModuleContext, import("./device").DeviceModuleOptions>;
-    readonly ocr: import("./sdk").ModuleInitialiseFunction<"ocr", import("./ocr").OcrModuleContext, import("../types/index.js")._DictionaryWrite<never>>;
-    readonly federation: import("./sdk").ModuleInitialiseFunction<"federation", import("./federation").FederationModuleContext, import("../types/index.js")._DictionaryWrite<never>>;
-    readonly individual: import("./sdk").ModuleInitialiseFunction<"individual", import("./individual").IndividualModuleContext, import("../types/index.js")._DictionaryWrite<never>>;
-    readonly session: import("./sdk").ModuleInitialiseFunction<"session", import("./session/SessionContext").SessionContext, import("../types/index.js")._DictionaryWrite<never>>;
-};
-export declare type ModulesDictionary = typeof ModulesDictionary;
-export declare type PublicModulesDictionary = Pick<ModulesDictionary, PublicModuleName>;
-export declare type PrivateModulesDictionary = Pick<ModulesDictionary, PrivateModuleName>;
-export declare type PreInitialisationModulesDictionary = Pick<ModulesDictionary, PreInitialisationModuleName>;
-export declare type AllModules = PublicModuleName | PrivateModuleName | PreInitialisationModuleName;

package/dist/esm/modules/configuration.js

@@ -1,16 +0,0 @@
-import { initialise as biometricsModule } from "./biometrics";
-import { initialise as deviceModule } from "./device";
-import { initialise as federationModule } from "./federation";
-import { initialise as individualModule } from "./individual";
-import { initialise as ocrModule } from "./ocr";
-import { initialise as sessionModule } from "./session";
-/** MODULES DICTIONARY */
-export const ModulesDictionary = {
-    biometrics: biometricsModule,
-    device: deviceModule,
-    ocr: ocrModule,
-    federation: federationModule,
-    individual: individualModule,
-    session: sessionModule,
-};
-//# sourceMappingURL=configuration.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"configuration.js","sourceRoot":"","sources":["../../../modules/configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACpE,OAAO,EAAE,UAAU,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC5D,OAAO,EAAE,UAAU,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACpE,OAAO,EAAE,UAAU,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACpE,OAAO,EAAE,UAAU,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAa9D,yBAAyB;AAEzB,MAAM,CAAC,MAAM,iBAAiB,GAAU;IACtC,UAAU,EAAE,gBAAgB;IAC5B,MAAM,EAAE,YAAY;IACpB,GAAG,EAAE,SAAS;IACd,UAAU,EAAE,gBAAgB;IAC5B,UAAU,EAAE,gBAAgB;IAC5B,OAAO,EAAE,aAAa;CACvB,CAAC"}

package/dist/esm/modules/sdk/types/oneSDKModules.d.ts

@@ -1,83 +0,0 @@
-import { AllModules, EventHub, EventListener, EventsDictionary, ModulesDictionary, PreInitialisationModuleName, PrivateModuleName, PublicModuleName } from "../../common";
-import { FrankieApiClient } from "../../frankie-client";
-import { SessionContext } from "../../session/SessionContext";
-import { Dictionary, ParameterCount } from "../../../types/index.js";
-import { OneSdkContext } from "../..";
-import { GlobalEvents } from "./globalEvents";
-import { DummyModeOptions, RecipeParsed, SdkModes } from "./oneSDKParameters";
-export declare type ModuleInitialiseFunction<ModuleName extends AllModules = PublicModuleName, Context extends ModuleContext = ModuleContext, ExclusiveOptions extends Dictionary<unknown> = Dictionary<never>> = (...args: ModuleInitialiseFunctionParameters<ModuleName, ExclusiveOptions>) => Context;
-export declare type AnyModuleInitialiseFunction = ModuleInitialiseFunction<AllModules, ModuleContext, Dictionary<unknown>>;
-declare type ModuleInitialiseFunctionParameters<Name extends AllModules, Options> = Options extends Dictionary<never> ? [shared: ModuleBaseParameters<Name>] : [shared: ModuleBaseParameters<Name>, options: Options];
-export declare type ModuleContext<Context extends object = object, Events extends EventsDictionary = EventsDictionary> = Context & EventListener<Events>;
-export declare type ModuleComponent<Ctx extends ModuleContext = ModuleContext> = Ctx & {
-    instanceName: string;
-};
-/**
- * ModuleBaseParameters
- * The base parameters object provided to all modules. Depending on the type of the module, ModuleBaseParameters is defined as:
- * - For public modules, defined in the PublicModuleName, it is SharedState + oneSdkInstance + moduleMeta (injected by the component loader)
- * - For private modules, defined in the PrivateModuleName, it is SharedState + oneSdkInstance
- * - For pre initialisation modules, where no dependencies were built yet, it is simply the ResolvedRootParameters
- */
-declare type ModuleBaseParameters<ModuleName extends AllModules> = ModuleName extends PublicModuleName ? SharedConfiguration : ModuleName extends PrivateModuleName ? Omit<SharedConfiguration, "moduleMeta"> : ModuleName extends PreInitialisationModuleName ? ResolvedRootParameters : never;
-export declare type SharedConfiguration<ModuleName extends PublicModuleName | PrivateModuleName = PublicModuleName> = SharedState & {
-    oneSdkInstance: OneSdkContext;
-    moduleMeta: ModuleMeta<ModuleName>;
-};
-declare type ModuleMeta<ModuleName extends AllModules> = {
-    moduleName: ModuleName;
-    instanceName: string;
-};
-export declare type SharedState = SharedDependencies & Omit<ResolvedRootParameters, "session">;
-export declare type SharedDependencies = {
-    globalEventHub: EventHub<GlobalEvents>;
-    frankieClient: FrankieApiClient;
-    session: SessionContext;
-};
-export declare type ResolvedRootParameters = {
-    recipe: RecipeParsed;
-    telemetry: boolean;
-    session: {
-        token: string;
-        persist: boolean;
-    } | {
-        token: null;
-        persist: false;
-    };
-    mode: {
-        modeName: SdkModes;
-    } | DummyModeOptions;
-};
-/** Type of the component factory function for public modules only */
-export declare type ComponentFactoryFunction = <Name extends PublicModuleName>(...args: ComponentFactoryParameters<Name>) => ComponentOf<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 declare type ComponentFactoryParameters<Name extends AllModules> = OptionsOf<Name> extends undefined ? [name: Name, options?: {
-    instanceName?: string;
-}] : [name: Name, options: OptionsOf<Name> & {
-    instanceName?: string;
-}];
-/**
- * Determine the exclusive options for a module, if any.
- */
-export declare type OptionsOf<Name extends AllModules> = ParameterCount<ModulesDictionary[Name]> extends 2 ? Parameters<ModulesDictionary[Name]>[1] : undefined;
-/**
- * Determine the context of a module (the type of the object returned by the initialisation function)
- */
-export declare type ContextOf<Name extends AllModules> = ModuleContext<ReturnType<ModulesDictionary[Name]>>;
-/**
- * Determine the type of the Component of a Module = Context + { instanceName: string }
- * A component is simply an instance of the module, represented by the context object and a name for that instance, which defaults to the name of the module
- */
-export declare type ComponentOf<Name extends PublicModuleName | PrivateModuleName, InstanceName extends string = string> = ContextOf<Name> & {
-    instanceName: InstanceName;
-};
-export declare type ComponentsDictionary = {
-    [Module in PublicModuleName]?: {
-        [instanceName: string]: ComponentOf<Module, string>;
-    };
-};
-export {};

package/dist/esm/modules/sdk/types/oneSDKModules.js

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

package/dist/esm/modules/sdk/types/oneSDKModules.js.map

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

package/dist/esm/modules/sdk/types/oneSDKVendorWrappers.d.ts

@@ -1,11 +0,0 @@
-import { PublicModuleName } from "../../configuration";
-import { Dictionary } from "../../../types/index.js";
-import { SharedConfiguration } from "./oneSDKModules";
-export declare type WrapperInitialiseFunction<Options extends Dictionary = Dictionary, // Vendor wrappers almost always have extra options
-VendorWrapperContext = Dictionary, // But sometimes return an empty context (no actions or fields attached to it)
-Async extends "sync" | "async" = "sync"> = (b: SharedConfiguration<PublicModuleName>, o: Options) => Async extends "async" ? Promise<VendorWrapperContext> : VendorWrapperContext;
-export declare type VendorWrapperImport<Wrapper extends WrapperInitialiseFunction> = {
-    initialise: Wrapper;
-};
-export declare type WrapperInitialiseOptions<Wrapper extends WrapperInitialiseFunction = WrapperInitialiseFunction> = Parameters<Wrapper>[1];
-export declare type WrapperContext<Wrapper extends WrapperInitialiseFunction> = ReturnType<Wrapper>;

package/dist/esm/modules/sdk/types/oneSDKVendorWrappers.js

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

package/dist/esm/modules/sdk/types/oneSDKVendorWrappers.js.map

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