@portkey/onboarding 1.5.1 → 1.5.2

package/dist/commonjs/browser.js

@@ -13,6 +13,7 @@ const semverCompare = (verionA, versionB) => {
             return 1;
         if (snippetB > snippetA)
             return -1;
+        // e.g. '1.0.0-rc' -- Number('0-rc') = NaN
         if (!isNaN(snippetA) && isNaN(snippetB))
             return 1;
         if (isNaN(snippetA) && !isNaN(snippetB))

package/dist/commonjs/constants/index.js

@@ -11,3 +11,5 @@ exports.EXTENSION_DOWNLOAD_URL = {
     DEFAULT: 'https://portkey.finance/download',
 };
 exports.WEB_PAGE = 'https://openlogin.portkey.finance';
+// export const WEB_PAGE = 'https://openlogin-test.portkey.finance';
+// export const WEB_PAGE = 'http://192.168.11.245:3000';

package/dist/commonjs/evokeApp/evoke.d.ts

@@ -1,5 +1,22 @@
 import { OpenStatus } from './types';
+/**
+ * Jump via top.location.href
+ * @param {string} [uri] - open
+ */
 export declare function evokeByLocation(uri: string): void;
+/**
+ * Evoked by the A tag
+ * @param {string} uri - open url
+ */
 export declare function evokeByTagA(uri: string): void;
+/**
+ * Evoked by iframe
+ * @param {string} [uri] - open url
+ */
 export declare function evokeByIFrame(uri: string): void;
+/**
+ * Check whether the calling end is successful
+ * @param cb - Callback failure callback function
+ * @param timeout
+ */
 export declare function checkOpen(callback: (status: OpenStatus) => void, timeout: number): void;

package/dist/commonjs/evokeApp/evoke.js

@@ -8,6 +8,7 @@ function getSupportedProperty() {
     if (typeof document === 'undefined')
         return;
     if (typeof document.hidden !== 'undefined') {
+        // Opera 12.10 and Firefox 18 and later support
         hidden = 'hidden';
         visibilityChange = 'visibilitychange';
     }
@@ -21,6 +22,9 @@ function getSupportedProperty() {
     }
 }
 getSupportedProperty();
+/**
+ * Determine whether the page is hidden (enter the background)
+ */
 function isPageHidden() {
     if (typeof document === 'undefined')
         return false;
@@ -28,13 +32,22 @@ function isPageHidden() {
         return false;
     return document[hidden];
 }
+/**
+ * Jump via top.location.href
+ * @param {string} [uri] - open
+ */
 function evokeByLocation(uri) {
+    // if (typeof window === 'undefined') return;
     if (window.top)
         window.top.location.href = uri;
     else
         window.location.href = uri;
 }
 exports.evokeByLocation = evokeByLocation;
+/**
+ * Evoked by the A tag
+ * @param {string} uri - open url
+ */
 function evokeByTagA(uri) {
     const tagA = document.createElement('a');
     tagA.setAttribute('href', uri);
@@ -43,6 +56,10 @@ function evokeByTagA(uri) {
     tagA.click();
 }
 exports.evokeByTagA = evokeByTagA;
+/**
+ * Evoked by iframe
+ * @param {string} [uri] - open url
+ */
 function evokeByIFrame(uri) {
     if (!iframe) {
         iframe = document.createElement('iframe');
@@ -52,6 +69,11 @@ function evokeByIFrame(uri) {
     iframe.src = uri;
 }
 exports.evokeByIFrame = evokeByIFrame;
+/**
+ * Check whether the calling end is successful
+ * @param cb - Callback failure callback function
+ * @param timeout
+ */
 function checkOpen(callback, timeout) {
     const timer = setTimeout(() => {
         const pageHidden = isPageHidden();

package/dist/commonjs/evokeApp/generate.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateUniversalLink = exports.generateIntent = exports.generateScheme = exports.buildScheme = void 0;
 const query_string_1 = require("query-string");
+// Generate basic url scheme
 function buildScheme(config, options) {
     const { path, param } = config;
     const { scheme, buildScheme: customBuildScheme } = options;
@@ -15,6 +16,7 @@ function buildScheme(config, options) {
     }, { encode: true });
 }
 exports.buildScheme = buildScheme;
+// Generate the url scheme required by the business (distinguish whether it is an external link)
 function generateScheme(config, options) {
     const { outChain } = options;
     let uri = buildScheme(config, options);
@@ -25,6 +27,7 @@ function generateScheme(config, options) {
     return uri;
 }
 exports.generateScheme = generateScheme;
+// generate android intent
 function generateIntent(config, options) {
     const { outChain } = options;
     const { intent, fallback } = options;
@@ -42,6 +45,7 @@ function generateIntent(config, options) {
     return `intent://${urlPath}${intentTail}`;
 }
 exports.generateIntent = generateIntent;
+// generate universalLink
 function generateUniversalLink(config, options) {
     const { universal } = options;
     if (typeof universal === 'undefined')

package/dist/commonjs/evokeApp/index.d.ts

@@ -2,6 +2,10 @@ import { EvokeAppConfig, EvokeAppOptions } from './types';
 export declare class EvokeApp {
     private readonly options;
     constructor(options: EvokeAppOptions);
+    /**
+     * register as method
+     * generateScheme | generateIntent | generateUniversalLink  | checkOpen
+     */
     generateScheme(config: EvokeAppConfig): string;
     generateIntent(config: EvokeAppConfig): string;
     generateUniversalLink(config: EvokeAppConfig): string;
@@ -9,5 +13,9 @@ export declare class EvokeApp {
     fallToAppStore(): void;
     fallToFbUrl(): void;
     fallToCustomCb(callback: () => void): void;
+    /**
+     * Evoke the client
+     * Execute different call-out strategies according to different browsers
+     */
     open(config: EvokeAppConfig): void;
 }

package/dist/commonjs/evokeApp/index.js

@@ -24,14 +24,22 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EvokeApp = void 0;
+/**
+ * @remakes https://github.com/suanmei/callapp-lib
+ */
 const Browser = __importStar(require("../browser"));
 const evoke_1 = require("./evoke");
 const generate = __importStar(require("./generate"));
 class EvokeApp {
+    // Create an instance of EvokeApp
     constructor(options) {
         const defaultOptions = { timeout: 4000 };
         this.options = Object.assign(defaultOptions, options);
     }
+    /**
+     * register as method
+     * generateScheme | generateIntent | generateUniversalLink  | checkOpen
+     */
     generateScheme(config) {
         return generate.generateScheme(config, this.options);
     }
@@ -52,9 +60,11 @@ class EvokeApp {
             }, timeout);
         });
     }
+    // Call terminal failure jump app store
     fallToAppStore() {
         this.checkOpen().catch(() => (0, evoke_1.evokeByLocation)(this.options.appStore));
     }
+    // Redirect to the general (download) page if the terminal call fails
     fallToFbUrl() {
         this.checkOpen().catch(() => {
             if (!this.options.fallback)
@@ -62,9 +72,14 @@ class EvokeApp {
             (0, evoke_1.evokeByLocation)(this.options.fallback);
         });
     }
+    // Failed to call the terminal to call the custom callback function
     fallToCustomCb(callback) {
         this.checkOpen().catch(callback);
     }
+    /**
+     * Evoke the client
+     * Execute different call-out strategies according to different browsers
+     */
     open(config) {
         const { universal, logFunc, intent } = this.options;
         const { callback } = config;
@@ -86,12 +101,14 @@ class EvokeApp {
             else {
                 (0, evoke_1.evokeByLocation)(this.generateUniversalLink(config));
             }
+            // Android
         }
         else if (Browser.isOriginalChrome) {
             if (typeof intent !== 'undefined') {
                 (0, evoke_1.evokeByLocation)(this.generateIntent(config));
             }
             else {
+                // The scheme cannot pull up the iframe normally on the android chrome25+ version
                 (0, evoke_1.evokeByLocation)(schemeURL);
                 checkOpenFall = this.fallToFbUrl;
             }

package/dist/commonjs/evokePortkey/checkPortkeyExtension.js

@@ -15,6 +15,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const constants_1 = require("../constants");
 const detect_provider_1 = __importDefault(require("@portkey/detect-provider"));
+/**
+ * This method is used to check if the provided object is a Portkey provider.
+ */
 function isPortkeyProvider() {
     return __awaiter(this, void 0, void 0, function* () {
         try {

package/dist/commonjs/evokePortkey/evokePortkeyApp.js

@@ -7,7 +7,7 @@ const evokePortkeyApp = ({ domain, custom, action, timeout = 4000, customFailure
     const callLib = new evokeApp_1.EvokeApp({
         scheme: {
             protocol: utils_1.scheme.DID_APP_SCHEMA,
-            domain: domain || window.location.host,
+            domain: domain || (window === null || window === void 0 ? void 0 : window.location.host),
         },
         timeout,
         appStore: constants_1.APP_DOWNLOAD_URL.APP_STORE,

package/dist/esm/browser.js

@@ -10,6 +10,7 @@ export const semverCompare = (verionA, versionB) => {
             return 1;
         if (snippetB > snippetA)
             return -1;
+        // e.g. '1.0.0-rc' -- Number('0-rc') = NaN
         if (!isNaN(snippetA) && isNaN(snippetB))
             return 1;
         if (isNaN(snippetA) && !isNaN(snippetB))

package/dist/esm/constants/index.js

@@ -8,3 +8,5 @@ export const EXTENSION_DOWNLOAD_URL = {
     DEFAULT: 'https://portkey.finance/download',
 };
 export const WEB_PAGE = 'https://openlogin.portkey.finance';
+// export const WEB_PAGE = 'https://openlogin-test.portkey.finance';
+// export const WEB_PAGE = 'http://192.168.11.245:3000';

package/dist/esm/evokeApp/evoke.d.ts

@@ -1,5 +1,22 @@
 import { OpenStatus } from './types.js';
+/**
+ * Jump via top.location.href
+ * @param {string} [uri] - open
+ */
 export declare function evokeByLocation(uri: string): void;
+/**
+ * Evoked by the A tag
+ * @param {string} uri - open url
+ */
 export declare function evokeByTagA(uri: string): void;
+/**
+ * Evoked by iframe
+ * @param {string} [uri] - open url
+ */
 export declare function evokeByIFrame(uri: string): void;
+/**
+ * Check whether the calling end is successful
+ * @param cb - Callback failure callback function
+ * @param timeout
+ */
 export declare function checkOpen(callback: (status: OpenStatus) => void, timeout: number): void;

package/dist/esm/evokeApp/evoke.js

@@ -5,6 +5,7 @@ function getSupportedProperty() {
     if (typeof document === 'undefined')
         return;
     if (typeof document.hidden !== 'undefined') {
+        // Opera 12.10 and Firefox 18 and later support
         hidden = 'hidden';
         visibilityChange = 'visibilitychange';
     }
@@ -18,6 +19,9 @@ function getSupportedProperty() {
     }
 }
 getSupportedProperty();
+/**
+ * Determine whether the page is hidden (enter the background)
+ */
 function isPageHidden() {
     if (typeof document === 'undefined')
         return false;
@@ -25,12 +29,21 @@ function isPageHidden() {
         return false;
     return document[hidden];
 }
+/**
+ * Jump via top.location.href
+ * @param {string} [uri] - open
+ */
 export function evokeByLocation(uri) {
+    // if (typeof window === 'undefined') return;
     if (window.top)
         window.top.location.href = uri;
     else
         window.location.href = uri;
 }
+/**
+ * Evoked by the A tag
+ * @param {string} uri - open url
+ */
 export function evokeByTagA(uri) {
     const tagA = document.createElement('a');
     tagA.setAttribute('href', uri);
@@ -38,6 +51,10 @@ export function evokeByTagA(uri) {
     document.body.appendChild(tagA);
     tagA.click();
 }
+/**
+ * Evoked by iframe
+ * @param {string} [uri] - open url
+ */
 export function evokeByIFrame(uri) {
     if (!iframe) {
         iframe = document.createElement('iframe');
@@ -46,6 +63,11 @@ export function evokeByIFrame(uri) {
     }
     iframe.src = uri;
 }
+/**
+ * Check whether the calling end is successful
+ * @param cb - Callback failure callback function
+ * @param timeout
+ */
 export function checkOpen(callback, timeout) {
     const timer = setTimeout(() => {
         const pageHidden = isPageHidden();

package/dist/esm/evokeApp/generate.js

@@ -1,4 +1,5 @@
 import { stringifyUrl } from 'query-string';
+// Generate basic url scheme
 export function buildScheme(config, options) {
     const { path, param } = config;
     const { scheme, buildScheme: customBuildScheme } = options;
@@ -11,6 +12,7 @@ export function buildScheme(config, options) {
         query: param,
     }, { encode: true });
 }
+// Generate the url scheme required by the business (distinguish whether it is an external link)
 export function generateScheme(config, options) {
     const { outChain } = options;
     let uri = buildScheme(config, options);
@@ -20,6 +22,7 @@ export function generateScheme(config, options) {
     }
     return uri;
 }
+// generate android intent
 export function generateIntent(config, options) {
     const { outChain } = options;
     const { intent, fallback } = options;
@@ -36,6 +39,7 @@ export function generateIntent(config, options) {
     urlPath = urlPath.slice(urlPath.indexOf('//') + 2);
     return `intent://${urlPath}${intentTail}`;
 }
+// generate universalLink
 export function generateUniversalLink(config, options) {
     const { universal } = options;
     if (typeof universal === 'undefined')

package/dist/esm/evokeApp/index.d.ts

@@ -2,6 +2,10 @@ import { EvokeAppConfig, EvokeAppOptions } from './types.js';
 export declare class EvokeApp {
     private readonly options;
     constructor(options: EvokeAppOptions);
+    /**
+     * register as method
+     * generateScheme | generateIntent | generateUniversalLink  | checkOpen
+     */
     generateScheme(config: EvokeAppConfig): string;
     generateIntent(config: EvokeAppConfig): string;
     generateUniversalLink(config: EvokeAppConfig): string;
@@ -9,5 +13,9 @@ export declare class EvokeApp {
     fallToAppStore(): void;
     fallToFbUrl(): void;
     fallToCustomCb(callback: () => void): void;
+    /**
+     * Evoke the client
+     * Execute different call-out strategies according to different browsers
+     */
     open(config: EvokeAppConfig): void;
 }

package/dist/esm/evokeApp/index.js

@@ -1,11 +1,19 @@
+/**
+ * @remakes https://github.com/suanmei/callapp-lib
+ */
 import * as Browser from '../browser.js';
 import { evokeByLocation, evokeByIFrame, checkOpen, evokeByTagA } from './evoke.js';
 import * as generate from './generate.js';
 export class EvokeApp {
+    // Create an instance of EvokeApp
     constructor(options) {
         const defaultOptions = { timeout: 4000 };
         this.options = Object.assign(defaultOptions, options);
     }
+    /**
+     * register as method
+     * generateScheme | generateIntent | generateUniversalLink  | checkOpen
+     */
     generateScheme(config) {
         return generate.generateScheme(config, this.options);
     }
@@ -26,9 +34,11 @@ export class EvokeApp {
             }, timeout);
         });
     }
+    // Call terminal failure jump app store
     fallToAppStore() {
         this.checkOpen().catch(() => evokeByLocation(this.options.appStore));
     }
+    // Redirect to the general (download) page if the terminal call fails
     fallToFbUrl() {
         this.checkOpen().catch(() => {
             if (!this.options.fallback)
@@ -36,9 +46,14 @@ export class EvokeApp {
             evokeByLocation(this.options.fallback);
         });
     }
+    // Failed to call the terminal to call the custom callback function
     fallToCustomCb(callback) {
         this.checkOpen().catch(callback);
     }
+    /**
+     * Evoke the client
+     * Execute different call-out strategies according to different browsers
+     */
     open(config) {
         const { universal, logFunc, intent } = this.options;
         const { callback } = config;
@@ -60,12 +75,14 @@ export class EvokeApp {
             else {
                 evokeByLocation(this.generateUniversalLink(config));
             }
+            // Android
         }
         else if (Browser.isOriginalChrome) {
             if (typeof intent !== 'undefined') {
                 evokeByLocation(this.generateIntent(config));
             }
             else {
+                // The scheme cannot pull up the iframe normally on the android chrome25+ version
                 evokeByLocation(schemeURL);
                 checkOpenFall = this.fallToFbUrl;
             }

package/dist/esm/evokePortkey/checkPortkeyExtension.js

@@ -10,6 +10,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { detectBrowserName } from '../utils/index.js';
 import { EXTENSION_DOWNLOAD_URL } from '../constants/index.js';
 import detectProvider from '@portkey/detect-provider';
+/**
+ * This method is used to check if the provided object is a Portkey provider.
+ */
 function isPortkeyProvider() {
     return __awaiter(this, void 0, void 0, function* () {
         try {

package/dist/esm/evokePortkey/evokePortkeyApp.js

@@ -5,7 +5,7 @@ const evokePortkeyApp = ({ domain, custom, action, timeout = 4000, customFailure
     const callLib = new EvokeApp({
         scheme: {
             protocol: schemeUtils.DID_APP_SCHEMA,
-            domain: domain || window.location.host,
+            domain: domain || (window === null || window === void 0 ? void 0 : window.location.host),
         },
         timeout,
         appStore: APP_DOWNLOAD_URL.APP_STORE,

package/dist/types/evokeApp/evoke.d.ts

@@ -1,6 +1,23 @@
 import { OpenStatus } from './types';
+/**
+ * Jump via top.location.href
+ * @param {string} [uri] - open
+ */
 export declare function evokeByLocation(uri: string): void;
+/**
+ * Evoked by the A tag
+ * @param {string} uri - open url
+ */
 export declare function evokeByTagA(uri: string): void;
+/**
+ * Evoked by iframe
+ * @param {string} [uri] - open url
+ */
 export declare function evokeByIFrame(uri: string): void;
+/**
+ * Check whether the calling end is successful
+ * @param cb - Callback failure callback function
+ * @param timeout
+ */
 export declare function checkOpen(callback: (status: OpenStatus) => void, timeout: number): void;
 //# sourceMappingURL=evoke.d.ts.map

package/dist/types/evokeApp/evoke.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"evoke.d.ts","sourceRoot":"","sources":["../../../src/evokeApp/evoke.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,UAAU,EAAoB,MAAM,SAAS,CAAC;AAqC/D,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAIjD;AAMD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAQ7C;AAMD,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAQ/C;AAOD,wBAAgB,SAAS,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAuBvF"}
+{"version":3,"file":"evoke.d.ts","sourceRoot":"","sources":["../../../src/evokeApp/evoke.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,UAAU,EAAoB,MAAM,SAAS,CAAC;AAiC/D;;;GAGG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAIjD;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAQ7C;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAQ/C;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAuBvF"}

package/dist/types/evokeApp/index.d.ts

@@ -2,6 +2,10 @@ import { EvokeAppConfig, EvokeAppOptions } from './types';
 export declare class EvokeApp {
     private readonly options;
     constructor(options: EvokeAppOptions);
+    /**
+     * register as method
+     * generateScheme | generateIntent | generateUniversalLink  | checkOpen
+     */
     generateScheme(config: EvokeAppConfig): string;
     generateIntent(config: EvokeAppConfig): string;
     generateUniversalLink(config: EvokeAppConfig): string;
@@ -9,6 +13,10 @@ export declare class EvokeApp {
     fallToAppStore(): void;
     fallToFbUrl(): void;
     fallToCustomCb(callback: () => void): void;
+    /**
+     * Evoke the client
+     * Execute different call-out strategies according to different browsers
+     */
     open(config: EvokeAppConfig): void;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/types/evokeApp/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/evokeApp/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1D,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwC;gBAGpD,OAAO,EAAE,eAAe;IAS7B,cAAc,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM;IAI9C,cAAc,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM;IAI9C,qBAAqB,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM;IAI5D,SAAS;IAYT,cAAc,IAAI,IAAI;IAKtB,WAAW,IAAI,IAAI;IAQnB,cAAc,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAQ1C,IAAI,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI;CA2CnC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/evokeApp/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1D,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwC;gBAGpD,OAAO,EAAE,eAAe;IAKpC;;;OAGG;IACI,cAAc,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM;IAI9C,cAAc,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM;IAI9C,qBAAqB,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM;IAI5D,SAAS;IAYT,cAAc,IAAI,IAAI;IAKtB,WAAW,IAAI,IAAI;IAQnB,cAAc,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAI1C;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI;CA2CnC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portkey/onboarding",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "description": "",
   "main": "./dist/commonjs/index.js",
   "module": "./dist/esm/index.js",
@@ -40,11 +40,11 @@
     "start": "tsc --watch"
   },
   "dependencies": {
-    "@portkey/detect-provider": "1.0.1",
-    "@portkey/types": "^1.5.1",
-    "@portkey/utils": "^1.5.1",
+    "@portkey/detect-provider": "^1.0.1",
+    "@portkey/types": "^1.5.2",
+    "@portkey/utils": "^1.5.2",
     "bowser": "^2.11.0",
     "query-string": "^7.1.1"
   },
-  "gitHead": "34d6e25f1e23a951ae870638c53719c9bcacbbd8"
+  "gitHead": "20e7e64ea49904e59a69bb6cce8a54c22921993b"
 }