@frankieone/one-sdk 0.1.0-poc.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/dist/index.esm.js +2 -0
- package/dist/index.esm.js.map +1 -0
- package/dist/index.umd.js +2 -0
- package/dist/index.umd.js.map +1 -0
- package/dist/types/api/ExternalIdvClient.d.ts +19 -0
- package/dist/types/api/FrankieApiClient.d.ts +54 -0
- package/dist/types/api/index.d.ts +1 -0
- package/dist/types/facades/POC/reactComponent.d.ts +644 -0
- package/dist/types/facades/POC/routing.d.ts +3 -0
- package/dist/types/facades/POC/viewWrapper.d.ts +4 -0
- package/dist/types/facades/POC/webEntry.d.ts +6 -0
- package/dist/types/index.d.ts +11 -0
- package/dist/types/models/Address.d.ts +67 -0
- package/dist/types/models/Admin.d.ts +1295 -0
- package/dist/types/models/Applicant.d.ts +115 -0
- package/dist/types/models/CheckSummary.d.ts +164 -0
- package/dist/types/models/ConfigurationReader.d.ts +7 -0
- package/dist/types/models/Core.d.ts +2725 -0
- package/dist/types/models/Document.d.ts +112 -0
- package/dist/types/models/General.d.ts +196 -0
- package/dist/types/models/Organisation.d.ts +36 -0
- package/dist/types/models/Profile.d.ts +27 -0
- package/dist/types/models/SupportingDocument.d.ts +95 -0
- package/dist/types/models/User.d.ts +27 -0
- package/dist/types/models/index.d.ts +14 -0
- package/dist/types/models/transformers/apiState.d.ts +23 -0
- package/dist/types/models/utils/address.d.ts +2 -0
- package/dist/types/models/utils/base64.d.ts +11 -0
- package/dist/types/models/utils/buildCycleUtils.d.ts +1 -0
- package/dist/types/models/utils/constants.d.ts +75 -0
- package/dist/types/models/utils/date.d.ts +5 -0
- package/dist/types/models/utils/getCountryDetails.d.ts +9 -0
- package/dist/types/models/utils/getDocumentDetails.d.ts +8 -0
- package/dist/types/models/utils/helper.d.ts +4 -0
- package/dist/types/models/utils/index.d.ts +11 -0
- package/dist/types/models/utils/isEmpty.d.ts +5 -0
- package/dist/types/models/utils/sanitiser.d.ts +8 -0
- package/dist/types/modules/router/ReactDictionaryRouter.d.ts +15 -0
- package/dist/types/modules/router/common/routing.d.ts +25 -0
- package/dist/types/modules/store/ReactInMemoryStore.d.ts +24 -0
- package/dist/types/uiComponents/reactWeb.d.ts +8 -0
- package/dist/types/utils/base64.d.ts +11 -0
- package/dist/types/utils/env2Url.d.ts +1 -0
- package/package.json +64 -0
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import sanitizeHtml from "sanitize-html";
|
|
2
|
+
export declare type Sanitiser = typeof sanitizeHtml;
|
|
3
|
+
export declare type SanitiserOptions = Parameters<Sanitiser>[1];
|
|
4
|
+
export declare const mkHtmlSanitiser: ((options?: SanitiserOptions) => (dirty: string) => string) & {
|
|
5
|
+
defaults: sanitizeHtml.IDefaults;
|
|
6
|
+
};
|
|
7
|
+
export declare function stripOutScriptTagFromString(content: string): string;
|
|
8
|
+
export declare function mkAnchorsTargetBlank(content: string): string;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { Router, StrObject } from "../../interfaces";
|
|
2
|
+
import { RouterOptions } from "./DictionaryRouter";
|
|
3
|
+
export default class ReactDictionaryRouter<Config extends StrObject, RouteComponent, RouteName extends string, WrappedRouteComponent> implements Router<WrappedRouteComponent> {
|
|
4
|
+
private currentComponent;
|
|
5
|
+
private routeComponentSetter;
|
|
6
|
+
private routeDictionary;
|
|
7
|
+
private routeOrder;
|
|
8
|
+
private routeHistoryRef;
|
|
9
|
+
private storeRef;
|
|
10
|
+
private routeNameResolution;
|
|
11
|
+
private routeComponentResolution;
|
|
12
|
+
constructor({ store, routeDictionary, routeOrder, routeComponentResolution, routeNameResolution, }: RouterOptions<Config, RouteComponent, RouteName, WrappedRouteComponent>);
|
|
13
|
+
getCurrentRoute(): WrappedRouteComponent | null;
|
|
14
|
+
getNextRoute(): Promise<WrappedRouteComponent | null>;
|
|
15
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { Context, RouteObject, Store, StrObject } from "../../../interfaces";
|
|
2
|
+
export declare type RouteDictionary<RouteName extends string, RouteComponent> = Record<RouteName, RouteObject<RouteComponent>>;
|
|
3
|
+
export declare type RouteHistory<RouteName> = (RouteName | null)[];
|
|
4
|
+
export declare type RouteNameResolution<RouteName extends string, Config> = (o: {
|
|
5
|
+
context: Context<Config>;
|
|
6
|
+
checkOrder: RouteName[];
|
|
7
|
+
routeHistory: (RouteName | null)[];
|
|
8
|
+
}) => RouteName | null;
|
|
9
|
+
export declare type RouteComponentResolution<RouteName extends string, RouteComponent, Config extends StrObject, ResultingRouteComponent = RouteComponent> = (o: {
|
|
10
|
+
routeName: RouteName;
|
|
11
|
+
routeDictionary: RouteDictionary<RouteName, RouteComponent>;
|
|
12
|
+
context: Context<Config>;
|
|
13
|
+
}) => ResultingRouteComponent;
|
|
14
|
+
export declare type RouterContext<Config, RouteName extends string, RouteComponent, ResultingRouteComponent> = {
|
|
15
|
+
resolveRouteName: RouteNameResolution<RouteName, Config>;
|
|
16
|
+
resolveRouteComponent: RouteComponentResolution<RouteName, RouteComponent, Config, ResultingRouteComponent>;
|
|
17
|
+
getStore(): Store<Config>;
|
|
18
|
+
getRouteOrder(): RouteName[];
|
|
19
|
+
getRouteHistory(): RouteHistory<RouteName>;
|
|
20
|
+
pushRouteToHistory(nxtName: RouteHistory<RouteName>[0]): void;
|
|
21
|
+
getRouteDictionary(): RouteDictionary<RouteName, RouteComponent>;
|
|
22
|
+
};
|
|
23
|
+
export default function getNextRoute<Config, RouteName extends string, RouteComponent, ResultingRouteComponent>(router: RouterContext<Config, RouteName, RouteComponent, ResultingRouteComponent>): Promise<ResultingRouteComponent | null>;
|
|
24
|
+
export declare const defaultRouteComponentResolution: RouteComponentResolution<any, any, any, any>;
|
|
25
|
+
export declare const defaultRouteNameResolution: RouteNameResolution<any, any>;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { Applicant } from "../../models";
|
|
2
|
+
import { FrankieApiClient } from "../../api";
|
|
3
|
+
import { Context, Store, StrObject } from "../../interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* lot of repeated code from InMemoryStore, but this will make the purpose of the code a bit clearer
|
|
6
|
+
* notice how this is simply a "class syntax" version of a custom hook
|
|
7
|
+
*/
|
|
8
|
+
export default class ReactInMemoryStore<Config extends StrObject> implements Store<Config> {
|
|
9
|
+
private frankieClientRef;
|
|
10
|
+
private contextSetter;
|
|
11
|
+
private context;
|
|
12
|
+
constructor(config: Config, frankieClient: FrankieApiClient);
|
|
13
|
+
getContext(): Readonly<Context<Config>>;
|
|
14
|
+
updateContext(newContext: Context<Config>): void;
|
|
15
|
+
getFrankieClient(): FrankieApiClient;
|
|
16
|
+
initialise(o: {
|
|
17
|
+
applicant: Partial<Applicant>;
|
|
18
|
+
}): void;
|
|
19
|
+
private isPersisted;
|
|
20
|
+
private load;
|
|
21
|
+
private update;
|
|
22
|
+
private create;
|
|
23
|
+
submitContext(): Promise<void>;
|
|
24
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { RouteObject } from "../interfaces";
|
|
2
|
+
import { RawComponent } from "~/facades/POC/typeDefinitions";
|
|
3
|
+
export declare const NameForm: RouteObject<RawComponent>;
|
|
4
|
+
export declare const DOBForm: RouteObject<RawComponent>;
|
|
5
|
+
export declare const AddressForm: RouteObject<RawComponent>;
|
|
6
|
+
export declare const ReviewPage: RouteObject<RawComponent>;
|
|
7
|
+
export declare const SuccessScreen: RouteObject<RawComponent>;
|
|
8
|
+
export declare const IDVScreen: RouteObject<RawComponent>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import { Buffer } from "buffer";
|
|
3
|
+
export declare function stringToBase64(s: string): string;
|
|
4
|
+
export declare function bufferToBase64(b: Buffer): string;
|
|
5
|
+
export declare function base64ToString(bs: string): string;
|
|
6
|
+
export declare function bufferToString(b: Buffer): string;
|
|
7
|
+
export declare function hexToByteString(hex: string): string;
|
|
8
|
+
export declare function hexToBytes(hex: string): number[];
|
|
9
|
+
export declare function bytesToBase64(byt: number[]): string;
|
|
10
|
+
export declare function bufferToByteString(buff: Buffer): number[];
|
|
11
|
+
export declare function stringToByteString(str: string): number[];
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const env2url: (env: "development" | "local" | "production" | "uat" | "demo" | "qa") => string;
|
package/package.json
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@frankieone/one-sdk",
|
|
3
|
+
"version": "0.1.0-poc.15",
|
|
4
|
+
"description": "This is a Javascript SDK for FrankieOne's services",
|
|
5
|
+
"homepage": "https://bitbucket.org/kycutility/one-sdk/src/main/packages/sdk/README.md",
|
|
6
|
+
"repository": {
|
|
7
|
+
"directory": "packages/sdk",
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "git+ssh://git@bitbucket.org/kycutility/one-sdk.git"
|
|
10
|
+
},
|
|
11
|
+
"license": "UNLICENSED",
|
|
12
|
+
"author": "Eddie Pan <eddie@frankieone.com>",
|
|
13
|
+
"exports": {
|
|
14
|
+
"import": "./dist/index.esm.js",
|
|
15
|
+
"require": "./dist/index.umd.js"
|
|
16
|
+
},
|
|
17
|
+
"main": "./dist/index.umd.js",
|
|
18
|
+
"module": "./dist/index.esm.js",
|
|
19
|
+
"source": "./src/index.ts",
|
|
20
|
+
"types": "./dist/types/index.d.ts",
|
|
21
|
+
"files": [
|
|
22
|
+
"dist"
|
|
23
|
+
],
|
|
24
|
+
"scripts": {
|
|
25
|
+
"bundle": "microbundle --format umd,esm --jsx React.createElement",
|
|
26
|
+
"dev": "microbundle --no-compress --format umd,esm --jsx React.createElement --watch",
|
|
27
|
+
"lint": "eslint .",
|
|
28
|
+
"lint:fix": "eslint . --fix",
|
|
29
|
+
"prebundle": "rm -rf dist",
|
|
30
|
+
"predev": "rm -rf dist",
|
|
31
|
+
"prepare": "npm run bundle",
|
|
32
|
+
"test": "echo \"No tests\" && exit 0"
|
|
33
|
+
},
|
|
34
|
+
"dependencies": {
|
|
35
|
+
"@types/sanitize-html": "^2.6.2",
|
|
36
|
+
"axios": "^0.26.0",
|
|
37
|
+
"buffer": "^6.0.3",
|
|
38
|
+
"convert-hex": "^0.1.0",
|
|
39
|
+
"date-and-time": "^2.1.0",
|
|
40
|
+
"dot-object": "^2.1.4",
|
|
41
|
+
"moment": "^2.29.1",
|
|
42
|
+
"nl2br": "^0.0.3",
|
|
43
|
+
"node-html-parser": "^5.2.0",
|
|
44
|
+
"onfido-sdk-ui": "^6.17.0",
|
|
45
|
+
"react": "^17.0.2",
|
|
46
|
+
"react-dom": "^17.0.2",
|
|
47
|
+
"sanitize-html": "^2.7.0"
|
|
48
|
+
},
|
|
49
|
+
"devDependencies": {
|
|
50
|
+
"@types/date-and-time": "^0.13.0",
|
|
51
|
+
"@types/dot-object": "^2.1.2",
|
|
52
|
+
"@types/react": "^17.0.39",
|
|
53
|
+
"@types/react-dom": "^17.0.11",
|
|
54
|
+
"@web/dev-server-rollup": "^0.3.15",
|
|
55
|
+
"microbundle": "^0.14.2",
|
|
56
|
+
"type-fest": "^2.12.0"
|
|
57
|
+
},
|
|
58
|
+
"peerDependencies": {
|
|
59
|
+
"react": "^17.0.2",
|
|
60
|
+
"react-dom": "^17.0.2"
|
|
61
|
+
},
|
|
62
|
+
"amdName": "FrankieOne",
|
|
63
|
+
"gitHead": "020f837ba84c2e67acc05a3a030c1d8fc4412d68"
|
|
64
|
+
}
|