@frankieone/one-sdk 0.1.0-poc.15 → 0.2.2-alpha

package/dist/esm/modules/common/shared/models/UIBlueprint.js

@@ -0,0 +1,164 @@
+import { getDot } from "../utils/dotNotation";
+const mkRandomRef = () => Math.floor(Math.random() * 99999999999).toString(16);
+const isDynamicComponent = (c) => c.isDynamicComponent;
+export class UIBlueprint {
+    constructor(options) {
+        var _a, _b, _c;
+        this.isUIBlueprint = true;
+        this._ref = (_a = options.ref) !== null && _a !== void 0 ? _a : mkRandomRef();
+        this._root = (_b = options.root) !== null && _b !== void 0 ? _b : null;
+        this._children = reassignRefs((_c = options.children) !== null && _c !== void 0 ? _c : {});
+    }
+    ref() {
+        return this._ref;
+    }
+    root() {
+        return this._root;
+    }
+    children() {
+        return this._children;
+    }
+    setChildren(children) {
+        this._children = children;
+    }
+    getChild(path) {
+        const dotReadMethod = (blue, child) => blue._children[child];
+        return getDot(path, this, dotReadMethod);
+    }
+    getParentOf(path) {
+        // split path into array of child keys
+        const splitPath = path.split(".");
+        // if path only contains one key, then parent is current blueprint
+        if (splitPath.length === 1)
+            return this;
+        // otherwise, lose the last child key
+        splitPath.pop();
+        // join remaining keys again, resulting in path to parent
+        const pathToParent = splitPath.join(".");
+        const lastParent = this.getChild(pathToParent);
+        return lastParent;
+    }
+    setRef(ref) {
+        this._ref = ref;
+    }
+    setChild(path, child) {
+        const isBlueprint = (node) => node === null || node === void 0 ? void 0 : node.isUIBlueprint;
+        const parent = this.getParentOf(path);
+        const childKey = path.split(".").pop();
+        if (childKey && isBlueprint(parent)) {
+            parent._children[childKey] = child;
+            return true;
+        }
+        return false;
+    }
+    removeChild(path) {
+        const isBlueprint = (node) => node === null || node === void 0 ? void 0 : node.isUIBlueprint;
+        const parent = this.getParentOf(path);
+        const childKey = path.split(".").pop();
+        if (childKey && isBlueprint(parent)) {
+            delete parent._children[childKey];
+            return true;
+        }
+        return false;
+    }
+    isValid() {
+        const dictPrepended = (v, childKey) => {
+            // -> dictPrepend is the overall isValid value for the whole tree of nodes
+            // -- any errors on the tree are returned as a dictionary of "dot.notation": "error message" | false
+            // -- valid tree structures are returned as simply boolean true
+            // -> v is the value of each childKey.isValid()
+            // if value is true, isValid result remain true
+            if (v === true)
+                return true;
+            // if value of child already is a dictionary of "isValid" values (for deep tree structures),
+            // prepend keys with childKey, since childKey is the key to the root of this existing dictionary
+            // this will build the dot notation dictionary keys
+            if (typeof v === "object") {
+                const keys = Object.keys(v);
+                const val = (k) => v[k];
+                return keys.reduce((obj, k) => {
+                    obj[`${childKey}.${k}`] = val(k);
+                    return obj;
+                }, {});
+            }
+            // if value of child.isValid is string or boolean false,
+            // than child is an invalid leaf and its value should be returned as a dictionary
+            return { [childKey]: v };
+        };
+        const mergeChildrenIsValidResult = (merged, childKey) => {
+            const child = this._children[childKey];
+            const value = typeof child === "string" ? true : child.isValid();
+            const parsedValue = dictPrepended(value, childKey);
+            const isObject = (v) => typeof v === "object";
+            const isBool = (v) => typeof v === "boolean";
+            // if both are objects, merge them
+            if (isObject(parsedValue) && isObject(merged))
+                return Object.assign(Object.assign({}, merged), parsedValue);
+            // if one is object and the other is a boolean, return the object
+            if (isObject(parsedValue) && isBool(merged))
+                return parsedValue;
+            if (isObject(merged) && isBool(parsedValue))
+                return merged;
+            return merged;
+        };
+        const keys = Object.keys(this._children);
+        return keys.reduce(mergeChildrenIsValidResult, true);
+    }
+    toJSON() {
+        return JSON.parse(JSON.stringify({
+            root: this._root,
+            children: this._children,
+        }));
+    }
+    static fromJSON(payload) {
+        return new UIBlueprint(payload);
+    }
+    clone() {
+        return UIBlueprint.fromJSON(this.toJSON());
+    }
+}
+function reassignRefs(children) {
+    const keys = Object.keys(children);
+    const reassignedRefs = keys.reduce((obj, key) => {
+        const node = children[key];
+        if (typeof node !== "string")
+            node.setRef(key);
+        obj[key] = node;
+        return obj;
+    }, {});
+    return reassignedRefs;
+}
+// helpers for children array
+// function validateChildren(children: Dictionary<UINodeType> | UINodeType[]): UINodeType[] {
+//   const childArray: UINodeType[] = Array.isArray(children) ? children : assignKeysToRef(children);
+//   ensureUniqueRefs(childArray);
+//   return childArray;
+// }
+// function ensureUniqueRefs(children: UINodeType[]) {
+//   const jsonIt = it => JSON.stringify(it);
+//   const mkError = (i: number, iObj: DynamicUIComponent, j: number, jObj: DynamicUIComponent) => new Error(
+//     `Child [${i}] contains a repeated ref to child [${j}], which not allowed for blueprints to index and find children unambiguously` +
+//     `
+//     ${i}: ${jsonIt(iObj)}
+//     ${j}: ${jsonIt(jObj)}
+//     `
+//   );
+//   const extractRef = (child: DynamicUIComponent) => child.ref();
+//   const refs = children.filter(isDynamicComponent).map(extractRef);
+//   refs.forEach((ref, i) => {
+//     const get = (k: number) => children[k] as DynamicUIComponent;
+//     const j = refs.indexOf(ref);
+//     if (j !== i) throw mkError(i, get(i), j, get(j));
+//   })
+// }
+// function assignKeysToRef(children: Dictionary<UINodeType>): UINodeType[] {
+//   const keys = Object.keys(children);
+//   return keys.map(k => {
+//     const child = children[k];
+//     if (isDynamicComponent(child)) {
+//       child.setRef(k);
+//     }
+//     return child;
+//   })
+// }
+//# sourceMappingURL=UIBlueprint.js.map

package/dist/esm/modules/common/shared/models/UIBlueprint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UIBlueprint.js","sourceRoot":"","sources":["../../../../../../modules/common/shared/models/UIBlueprint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAe9C,MAAM,WAAW,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,WAAW,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AAC/E,MAAM,kBAAkB,GAAG,CAAC,CAAa,EAA2B,EAAE,CAAE,CAAwB,CAAC,kBAAkB,CAAC;AACpH,MAAM,OAAO,WAAW;IAMtB,YAAY,OAA2B;;QAL9B,kBAAa,GAAG,IAAI,CAAC;QAM5B,IAAI,CAAC,IAAI,GAAG,MAAA,OAAO,CAAC,GAAG,mCAAI,WAAW,EAAE,CAAC;QACzC,IAAI,CAAC,KAAK,GAAG,MAAA,OAAO,CAAC,IAAI,mCAAI,IAAI,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,MAAA,OAAO,CAAC,QAAQ,mCAAI,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,GAAG;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IACD,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IACD,QAAQ;QACN,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IACD,WAAW,CAAC,QAAgC;QAC1C,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED,QAAQ,CAAC,IAAY;QACnB,MAAM,aAAa,GAAG,CAAC,IAAiB,EAAE,KAAa,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,aAAa,CAAe,CAAC;IACzD,CAAC;IACO,WAAW,CAAC,IAAY;QAC9B,sCAAsC;QACtC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClC,kEAAkE;QAClE,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QACxC,qCAAqC;QACrC,SAAS,CAAC,GAAG,EAAE,CAAC;QAChB,yDAAyD;QACzD,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAgB,CAAC;QAC9D,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,CAAC,GAAW;QAChB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IACD,QAAQ,CAAC,IAAY,EAAE,KAAiB;QACtC,MAAM,WAAW,GAAG,CAAC,IAAgB,EAAuB,EAAE,CAAE,IAAoB,aAApB,IAAI,uBAAJ,IAAI,CAAkB,aAAa,CAAC;QACpG,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAY,CAAC;QACjD,IAAI,QAAQ,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE;YACnC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;YACnC,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,WAAW,CAAC,IAAY;QACtB,MAAM,WAAW,GAAG,CAAC,IAAgB,EAAuB,EAAE,CAAE,IAAoB,aAApB,IAAI,uBAAJ,IAAI,CAAkB,aAAa,CAAC;QACpG,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAY,CAAC;QACjD,IAAI,QAAQ,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE;YACnC,OAAO,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAClC,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO;QACL,MAAM,aAAa,GAAG,CACpB,CAAsD,EACtD,QAAgB,EACa,EAAE;YAC/B,0EAA0E;YAC1E,oGAAoG;YACpG,+DAA+D;YAC/D,+CAA+C;YAE/C,+CAA+C;YAC/C,IAAI,CAAC,KAAK,IAAI;gBAAE,OAAO,IAAI,CAAC;YAC5B,4FAA4F;YAC5F,gGAAgG;YAChG,mDAAmD;YACnD,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;gBACzB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAC5B,MAAM,GAAG,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACxB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;oBAC5B,GAAG,CAAC,GAAG,QAAQ,IAAI,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;oBACjC,OAAO,GAAG,CAAC;gBACb,CAAC,EAAE,EAAE,CAAC,CAAC;aACR;YACD,wDAAwD;YACxD,iFAAiF;YACjF,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;QAC3B,CAAC,CAAC;QACF,MAAM,0BAA0B,GAAG,CACjC,MAAmC,EACnC,QAAgB,EACa,EAAE;YAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YACvC,MAAM,KAAK,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACjE,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACnD,MAAM,QAAQ,GAAG,CAAC,CAAM,EAAmB,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;YACpE,MAAM,MAAM,GAAG,CAAC,CAAM,EAAgB,EAAE,CAAC,OAAO,CAAC,KAAK,SAAS,CAAC;YAChE,kCAAkC;YAClC,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC;gBAC3C,uCACK,MAAM,GACN,WAAW,EACd;YACJ,iEAAiE;YACjE,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC;gBAAE,OAAO,WAAW,CAAC;YAChE,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC;gBAAE,OAAO,MAAM,CAAC;YAE3D,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,0BAA0B,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,KAAK,CACf,IAAI,CAAC,SAAS,CAAC;YACb,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,QAAQ,EAAE,IAAI,CAAC,SAAS;SACzB,CAAC,CACH,CAAC;IACJ,CAAC;IACD,MAAM,CAAC,QAAQ,CAAC,OAA2B;QACzC,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IACD,KAAK;QACH,OAAO,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AACD,SAAS,YAAY,CAAC,QAAgC;IACpD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAA2B,EAAE,GAAW,EAAE,EAAE;QAC9E,MAAM,IAAI,GAAe,QAAQ,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC/C,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;QAChB,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,OAAO,cAAc,CAAC;AACxB,CAAC;AACD,6BAA6B;AAC7B,6FAA6F;AAC7F,qGAAqG;AAErG,kCAAkC;AAElC,uBAAuB;AACvB,IAAI;AACJ,sDAAsD;AACtD,6CAA6C;AAC7C,6GAA6G;AAC7G,0IAA0I;AAC1I,QAAQ;AACR,4BAA4B;AAC5B,4BAA4B;AAC5B,QAAQ;AACR,OAAO;AACP,mEAAmE;AACnE,sEAAsE;AACtE,+BAA+B;AAC/B,oEAAoE;AACpE,mCAAmC;AACnC,wDAAwD;AACxD,OAAO;AACP,IAAI;AACJ,6EAA6E;AAE7E,wCAAwC;AACxC,2BAA2B;AAC3B,iCAAiC;AACjC,uCAAuC;AACvC,yBAAyB;AACzB,QAAQ;AACR,oBAAoB;AACpB,OAAO;AACP,IAAI"}

package/dist/{types → esm/modules/common/shared}/models/User.d.ts

@@ -1,27 +1,27 @@
-export declare type UserPayload = User;
-export interface User {
-    id: number;
-    organizationId: number | null;
-    username: string;
-    password: string;
-    salt: string;
-    realname: string | null;
-    email: string;
-    isActive: boolean;
-}
-export declare type TUser = {
-    id?: number;
-    organizationId?: number | null;
-    username?: string;
-    password?: string;
-    realname?: string | null;
-    email?: string;
-    isActive?: boolean;
-    loggedAt?: Date | null;
-    createdAt?: Date;
-    updatedAt?: Date | null;
-    deletedAt?: Date | null;
-    isLocked?: boolean;
-    latestChildViewed?: string | null;
-    [field: string]: any;
-};
+export declare type UserPayload = User;
+export interface User {
+    id: number;
+    organizationId: number | null;
+    username: string;
+    password: string;
+    salt: string;
+    realname: string | null;
+    email: string;
+    isActive: boolean;
+}
+export declare type TUser = {
+    id?: number;
+    organizationId?: number | null;
+    username?: string;
+    password?: string;
+    realname?: string | null;
+    email?: string;
+    isActive?: boolean;
+    loggedAt?: Date | null;
+    createdAt?: Date;
+    updatedAt?: Date | null;
+    deletedAt?: Date | null;
+    isLocked?: boolean;
+    latestChildViewed?: string | null;
+    [field: string]: any;
+};

package/dist/esm/modules/common/shared/models/User.js

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

package/dist/esm/modules/common/shared/models/User.js.map

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

package/dist/{types/models/General.d.ts → esm/modules/common/shared/models/api.d.ts}

@@ -1,196 +1,124 @@
-import { Applicant, IApplicantPayload } from "./Applicant";
-import { IDocumentPayload, Document } from "./Document";
-import { SupportingDocument, ISupportingDocumentPayload } from "./SupportingDocument";
-import { ICheckSummaryPayload, CheckSummary } from "./CheckSummary";
-import { OrganisationPayload } from "./Organisation";
-import { Admin } from "./Admin";
-import { Core } from "./Core";
-import { PartialDeep } from "type-fest";
-export declare type Nullable<T> = T | null;
-export declare type IStringOrNull = string | null;
-export declare type Dictionary<T = any> = {
-    [key: string]: T;
-};
-export declare type Kvp = (AdminKvpWithoutValue | CoreKvpWithoutValue) & {
-    kvpValue: any;
-};
-export declare type DictionaryReturnTypes<D extends Dictionary<(...args: any) => any>> = {
-    [P in keyof D]: ReturnType<D[P]>;
-};
-export declare type DeepPartial<T> = PartialDeep<T>;
-export declare interface ICloneable<T> {
-    clone(): T;
-}
-declare type AdminKvpWithoutValue = Omit<Admin["KeyValuePairObject"], "kvpValue">;
-declare type CoreKvpWithoutValue = Omit<Core["KeyValuePairObject"], "kvpValue">;
-export declare type TDOBTypeSupport = "gregorian" | "buddhist";
-export declare type DateObject = {
-    dd: IStringOrNull;
-    mm: IStringOrNull;
-    yyyy: IStringOrNull;
-};
-export declare type ExtraData = {
-    [field: string]: Nullable<string | boolean | number>;
-};
-export declare type TValidation = boolean | null;
-export declare type TValidationFieldIssues = string[];
-export declare type TValidationResult = {
-    [field: string]: TValidationFieldIssues;
-};
-export declare type TFieldIssuesTuple = [string, TValidationFieldIssues];
-export declare type TApplicantStatus = {
-    type: TStatusType | null;
-    label: string;
-    key: string;
-    action?: string;
-};
-export declare type TStatusType = "failed" | "passed" | "fail_manual" | "pass_manual" | "refer" | "wait" | "unchecked" | "archived" | "inactive";
-export declare interface IMachineCredential {
-    customerId: string;
-    customerChildId?: string | null;
-    apiKey: string;
-}
-export declare interface IUserCredential {
-    username: string;
-    password: string;
-}
-export declare type IFrankieClientCredentials = IMachineCredential | IUserCredential;
-export declare interface IApplicantInformation {
-    applicant: Applicant;
-    documents?: Document[];
-    supportingDocuments?: SupportingDocument[];
-}
-export declare interface ICreateApplicantResponse {
-    entityId: string;
-    requestId: string;
-}
-export declare type SearchOptions = {
-    reference: string;
-    entityId: string;
-};
-export declare interface IUserRole {
-    id: number;
-    role: string;
-    isHidden: boolean;
-    permissions: [];
-    createdAt: {
-        date: Date;
-    };
-}
-export declare interface ICreateUser {
-    userData: ICreateUserData;
-}
-export declare interface ICreateUserData {
-    realname: string;
-    username: string;
-    email: string;
-    roleIds: number[];
-}
-export declare interface ITriggerChecksResponse {
-    hasCreditHeaderIssue: boolean;
-    detailLevel: TDetailLevel;
-}
-export declare interface IGetExternalIdvToken {
-    token: string;
-}
-export declare type TDetailLevel = "full";
-export declare interface IGetApplicantDetailsResponse {
-    applicant: IApplicantPayload;
-    documents: IDocumentPayload[];
-    checkSummary: ICheckSummaryPayload;
-}
-export declare interface IGetApplicantInformationResponse {
-    applicant: IApplicantPayload;
-    documents: IDocumentPayload[];
-    supportingDocuments: ISupportingDocumentPayload[];
-}
-export interface ICreateIDVTokenResponse {
-    token: string;
-    applicant: IApplicantPayload;
-    documents: IDocumentPayload[];
-    checkSummary: ICheckSummaryPayload;
-    docTypesRequiredToCheck: IDocumentPayload["idType"][];
-    idvTwoDocuments: boolean;
-}
-export interface IApplicantDetails {
-    applicant: Applicant;
-    documents: Document[];
-    checkSummary: CheckSummary;
-}
-export interface IGetCommits {
-    coreApiCommitId: string;
-    adminApiCommitId: boolean;
-}
-export interface IAnalyticsData {
-    [organizationId: string]: IOrganizationAnalytics;
-}
-export declare type IOrganizationAnalytics = {
-    pass_rate: TPassRateAnalytics;
-    risk_level: TRiskLevelAnalytics;
-    issues: TIssueCount[];
-};
-export declare type TPassRateAnalytics = {
-    passed: number;
-    manually_passed: number;
-    failed: number;
-    manually_failed: number;
-    needs_attention: number;
-    unchecked: number;
-    pending: number;
-    duplicate: number;
-    archived: number;
-    inactive: number;
-};
-export declare type TRiskLevelAnalytics = {
-    high: number;
-    low: number;
-    medium: number;
-    unacceptable: number;
-    unknown: number;
-};
-export declare type TIssueCount = {
-    type: string;
-    count: number;
-};
-export declare type TEventPayload = {
-    customerId: string;
-    sessionId: string;
-    data: {
-        [field: string]: Nullable<string | boolean | number>;
-    };
-    channel: Nullable<string>;
-    version: Nullable<string>;
-    deviceType: Nullable<string>;
-    browser: Nullable<string>;
-};
-export declare type TIssueType = "warning" | "action" | "alert" | "success";
-export interface IIssue {
-    term: string;
-    type: TIssueType;
-}
-export interface IIssueAction extends IIssue {
-    type: "action";
-    extra: {
-        action: string;
-        label?: string;
-    };
-}
-export declare type TKycMethod = "electronic" | "manual";
-export interface IChangeStamp {
-    channel: ChannelString;
-    userId: string;
-    by: string;
-    timestamp: string;
-}
-export declare enum ChannelString {
-    PORTAL = "PORTAL",
-    SMART_UI = "SMART_UI",
-    API = "API"
-}
-export declare function isMachineCredential(cred: any): cred is IMachineCredential;
-export declare function isUserCredential(cred: any): cred is IUserCredential;
-export interface ICreateMachineSessionResponse {
-    organisation: OrganisationPayload;
-    [configurations: string]: any;
-}
-export {};
+import { Applicant, IApplicantPayload } from "./Applicant";
+import { CheckSummary, ICheckSummaryPayload } from "./CheckSummary";
+import { IDocumentPayload } from "./Document";
+import { Nullable } from "./general";
+import { ISupportingDocumentPayload, SupportingDocument } from "./SupportingDocument";
+export declare type TStatusType = "failed" | "passed" | "fail_manual" | "pass_manual" | "refer" | "wait" | "unchecked" | "archived" | "inactive";
+export declare interface IMachineCredential {
+    customerId: string;
+    customerChildId?: string | null;
+    apiKey: string;
+}
+export declare interface IUserCredential {
+    username: string;
+    password: string;
+}
+export declare type IFrankieClientCredentials = IMachineCredential | IUserCredential;
+export declare interface IApplicantInformation {
+    applicant: Applicant;
+    documents?: Document[];
+    supportingDocuments?: SupportingDocument[];
+}
+export declare interface ICreateApplicantResponse {
+    entityId: string;
+    requestId: string;
+}
+export declare type SearchOptions = {
+    reference: string;
+    entityId: string;
+};
+export declare interface IUserRole {
+    id: number;
+    role: string;
+    isHidden: boolean;
+    permissions: [];
+    createdAt: {
+        date: Date;
+    };
+}
+export declare interface ICreateUser {
+    userData: ICreateUserData;
+}
+export declare interface ICreateUserData {
+    realname: string;
+    username: string;
+    email: string;
+    roleIds: number[];
+}
+export declare interface ITriggerChecksResponse {
+    hasCreditHeaderIssue: boolean;
+    detailLevel: TDetailLevel;
+}
+export declare interface IGetExternalIdvToken {
+    token: string;
+}
+export declare type TDetailLevel = "full";
+export declare interface IGetApplicantDetailsResponse {
+    applicant: IApplicantPayload;
+    documents: IDocumentPayload[];
+    checkSummary: ICheckSummaryPayload;
+}
+export declare interface IGetApplicantInformationResponse {
+    applicant: IApplicantPayload;
+    documents: IDocumentPayload[];
+    supportingDocuments: ISupportingDocumentPayload[];
+}
+export interface ICreateIDVTokenResponse {
+    token: string;
+    applicant: IApplicantPayload;
+    documents: IDocumentPayload[];
+    checkSummary: ICheckSummaryPayload;
+    docTypesRequiredToCheck: IDocumentPayload["idType"][];
+    idvTwoDocuments: boolean;
+}
+export interface IApplicantDetails {
+    applicant: Applicant;
+    documents: Document[];
+    checkSummary: CheckSummary;
+}
+export interface IGetCommits {
+    coreApiCommitId: string;
+    adminApiCommitId: boolean;
+}
+export interface IAnalyticsData {
+    [organizationId: string]: IOrganizationAnalytics;
+}
+export declare type IOrganizationAnalytics = {
+    pass_rate: TPassRateAnalytics;
+    risk_level: TRiskLevelAnalytics;
+    issues: TIssueCount[];
+};
+export declare type TPassRateAnalytics = {
+    passed: number;
+    manually_passed: number;
+    failed: number;
+    manually_failed: number;
+    needs_attention: number;
+    unchecked: number;
+    pending: number;
+    duplicate: number;
+    archived: number;
+    inactive: number;
+};
+export declare type TRiskLevelAnalytics = {
+    high: number;
+    low: number;
+    medium: number;
+    unacceptable: number;
+    unknown: number;
+};
+export declare type TIssueCount = {
+    type: string;
+    count: number;
+};
+export declare type TEventPayload = {
+    customerId: string;
+    sessionId: string;
+    data: {
+        [field: string]: Nullable<string | boolean | number>;
+    };
+    channel: Nullable<string>;
+    version: Nullable<string>;
+    deviceType: Nullable<string>;
+    browser: Nullable<string>;
+};

package/dist/esm/modules/common/shared/models/api.js

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

package/dist/esm/modules/common/shared/models/api.js.map

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

package/dist/esm/modules/common/shared/models/general.d.ts

@@ -0,0 +1,31 @@
+import { PartialDeep } from "type-fest";
+import { Admin } from "./Admin";
+import { Core } from "./Core";
+export declare type Nullable<T> = T | null;
+export declare type IStringOrNull = string | null;
+export declare type Dictionary<T = any> = {
+    [key: string]: T;
+};
+export declare type Kvp = (AdminKvpWithoutValue | CoreKvpWithoutValue) & {
+    kvpValue: any;
+};
+export declare type DictionaryReturnTypes<D extends Dictionary<(...args: any) => any>> = {
+    [P in keyof D]: ReturnType<D[P]>;
+};
+export declare type DeepPartial<T> = PartialDeep<T>;
+export declare interface ICloneable<T> {
+    clone(): T;
+}
+declare type AdminKvpWithoutValue = Omit<Admin["KeyValuePairObject"], "kvpValue">;
+declare type CoreKvpWithoutValue = Omit<Core["KeyValuePairObject"], "kvpValue">;
+export declare type TDOBTypeSupport = "gregorian" | "buddhist";
+export declare type DateObject = {
+    dd: IStringOrNull;
+    mm: IStringOrNull;
+    yyyy: IStringOrNull;
+};
+export declare type ExtraData = {
+    [field: string]: Nullable<string | boolean | number>;
+};
+export declare type IChannel = "portal" | "smart-ui" | "support-portal" | "unknown" | Admin["enumChannel"];
+export {};

package/dist/esm/modules/common/shared/models/general.js

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

package/dist/esm/modules/common/shared/models/general.js.map

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

package/dist/esm/modules/common/shared/transformers/apiAlert.d.ts

@@ -0,0 +1,4 @@
+import { KvpList } from "../models/KvpList";
+import { IIssue, IIssueAction } from "../models/TApplicantIssue";
+export declare function mapBackendAlert(backendTerm: string): IIssue | IIssueAction;
+export declare const appendIssueWhenMissingCheck: (extraData: KvpList, alertList: (IIssue | IIssueAction)[]) => void;