@civic/common-gateway-react - npm Package Compare versions

Comparing version 0.11.1 to 0.11.2-beta.0

dist/cjs/gateway/GatewayContext.js

@@ -47,2 +47,3 @@ "use strict";
 const usePrevious_1 = require("../useHooks/usePrevious");
+const analytics_1 = require("../utils/analytics");
 const logDebug = (0, logger_1.prefixLogger)('GatewayContext').debug;
@@ -89,2 +90,4 @@ const GatewayContext = react_1.default.createContext({
         instanceId: (0, uuid_1.v4)(),
+        did: chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.did,
+        flowId: (0, analytics_1.getFlowId)('', {}),
     });
@@ -139,2 +142,3 @@ const dispatch = (0, react_1.useCallback)((action) => {
             headers,
+            flowId: state.flowId,
         })
@@ -184,6 +188,8 @@ : undefined);
                 headers,
+                flowId: state.flowId,
             }));
         }, 10);
+        // eslint-disable-next-line consistent-return
         return () => abortController.abort();
-    }, [stage, gatekeeperEndpoint, gatekeeperNetworkAddress, network, wallet === null || wallet === void 0 ? void 0 : wallet.publicKey]);
+    }, [stage, gatekeeperEndpoint, gatekeeperNetworkAddress, network, wallet === null || wallet === void 0 ? void 0 : wallet.publicKey, state.flowId]);
     // this hook implements the main business logic and handles requesting and refreshing gateway tokens
@@ -190,0 +196,0 @@ (0, useOrchestration_1.default)({ wallet, chainImplementation, stage, gatekeeperClient }, state, dispatch);

dist/cjs/useHooks/useChain.js

@@ -38,3 +38,3 @@ "use strict";
         }
-    }, [chainImplementation]);
+    }, [chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.initProps]);
     const dispatchListenerAdded = (listenerId) => {
@@ -58,3 +58,3 @@ dispatch({ type: 'tokenListenerAdded', listenerId });
         return listenerId;
-    }, [chainImplementation, tokenCreatedOrChangedListenerId]);
+    }, [chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.initProps, tokenCreatedOrChangedListenerId]);
     /**
@@ -74,3 +74,3 @@ * listen to the blockchain for a token being changed-only (the case where the chainImplementation doesn't support listening for creation)
         return listenerId;
-    }, [chainImplementation, tokenCreatedOrChangedListenerId]);
+    }, [chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.initProps, tokenCreatedOrChangedListenerId]);
     /**
@@ -110,3 +110,3 @@ * use the on-chain lookup utility findGatewayToken to retrieve a token from the chain
         }
-    }, [chainImplementation, gatekeeperNetworkAddress]);
+    }, [chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.initProps, gatekeeperNetworkAddress]);
     /**
@@ -117,3 +117,3 @@ * Check token on chain
         checkForOnChainToken(onGatewayTokenCreatedOrChanged);
-    }, [chainImplementation]);
+    }, [chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.initProps]);
     const dispatchTokenExpectedTimerAdded = (listenerId) => {
@@ -120,0 +120,0 @@ dispatch({ type: 'tokenExpectedTimerAdded', listenerId });

dist/cjs/useHooks/useOrchestration.js

@@ -149,3 +149,3 @@ "use strict";
         };
-    }, [wallet === null || wallet === void 0 ? void 0 : wallet.publicKey, chainImplementation, state.tokenCreatedOrChangedListenerId]);
+    }, [wallet === null || wallet === void 0 ? void 0 : wallet.publicKey, chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.initProps, state.tokenCreatedOrChangedListenerId]);
     /**
@@ -152,0 +152,0 @@ * Refresh Flows ----------------------------------------------------------------

dist/cjs/useHooks/useWalletHooks.js

@@ -57,3 +57,3 @@ "use strict";
         }
-    }, [chainImplementation]);
+    }, [chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.initProps]);
     return {
@@ -60,0 +60,0 @@ waitForTransactionConfirm,

dist/cjs/useReducer/reducer.js

@@ -54,5 +54,5 @@ "use strict";
         case 'requestGatekeeperIssuanceRejected':
-            return Object.assign(Object.assign({}, (0, utils_1.resetState)(state)), { gatewayStatus: types_1.GatewayStatus.REJECTED, tokenIssuanceState: types_1.TokenIssuanceState.FAILED });
+            return Object.assign(Object.assign({}, (0, utils_1.resetState)(state)), { flowId: state.flowId, gatewayStatus: types_1.GatewayStatus.REJECTED, tokenIssuanceState: types_1.TokenIssuanceState.FAILED });
         case 'requestGatekeeperIssuanceFailed':
-            return Object.assign(Object.assign({}, (0, utils_1.resetState)(state)), { gatewayStatus: types_1.GatewayStatus.ERROR, tokenIssuanceState: types_1.TokenIssuanceState.FAILED });
+            return Object.assign(Object.assign({}, (0, utils_1.resetState)(state)), { flowId: state.flowId, gatewayStatus: types_1.GatewayStatus.ERROR, tokenIssuanceState: types_1.TokenIssuanceState.FAILED });
         case 'refreshAttemptDone':
@@ -65,3 +65,3 @@ return Object.assign(Object.assign({}, updatedState), { refreshInProgress: false });
             logDebug('resetStateWithProps', action);
-            return Object.assign(Object.assign({}, (0, utils_1.resetState)(state)), { stage: action.stage, walletAddress: action.walletAddress, gatekeeperNetworkAddress: action.gatekeeperNetworkAddress, chainType: action.chainType, chainNetwork: action.chainNetwork });
+            return Object.assign(Object.assign({}, (0, utils_1.resetState)(state)), { stage: action.stage, walletAddress: action.walletAddress, gatekeeperNetworkAddress: action.gatekeeperNetworkAddress, chainType: action.chainType, chainNetwork: action.chainNetwork, did: action.did });
         case 'tokenNotFoundError':
@@ -68,0 +68,0 @@ return Object.assign(Object.assign({}, state), { gatewayStatus: types_1.GatewayStatus.ERROR });

dist/cjs/useReducer/utils.js

@@ -10,2 +10,3 @@ "use strict";
 const types_1 = require("../types");
+const analytics_1 = require("../utils/analytics");
 const tokenUtils_1 = require("../utils/tokenUtils");
@@ -20,3 +21,3 @@ const logDebug = (0, logger_1.prefixLogger)('useUserInteraction').debug;
             renderIframe: false,
-        }, userInitiatedFlow: false, flowId: undefined, did: undefined });
+        }, userInitiatedFlow: false, flowId: (0, analytics_1.getFlowId)('', {}), did: undefined });
 };
@@ -23,0 +24,0 @@ exports.resetState = resetState;

dist/cjs/utils/analytics.js

@@ -19,3 +19,5 @@ "use strict";
     }
-    return !state.flowId || !((_a = state.flowId) === null || _a === void 0 ? void 0 : _a.includes(prefix)) ? `${constants_1.RC_FLOW_ID_PREFIX}_${prefix}${(0, uuid_1.v4)()}` : state.flowId;
+    return !state.flowId || state.flowId === '' || !((_a = state.flowId) === null || _a === void 0 ? void 0 : _a.includes(prefix))
+        ? `${constants_1.RC_FLOW_ID_PREFIX}_${prefix}${(0, uuid_1.v4)()}`
+        : state.flowId;
 };
@@ -22,0 +24,0 @@ exports.getFlowId = getFlowId;

dist/cjs/utils/gatekeeperClient.js

@@ -30,3 +30,3 @@ "use strict";
         this.queryParams = initConfig.queryParams;
-        this.headers = (0, generalUtils_1.objectToURLParams)(Object.assign(Object.assign({}, initConfig.headers), { 'X-Civic-FlowId': initConfig.flowId }));
+        this.headers = (0, generalUtils_1.objectToURLParams)(Object.assign(Object.assign({}, initConfig.headers), { 'x-civic-flowid': initConfig.flowId }));
         this.fetchImplementation = initConfig.fetchImplementation || fetch;
@@ -33,0 +33,0 @@ const retries = initConfig.numRetries || (0, config_1.getDefaultApiNumRetries)(this.stage);

dist/cjs/utils/generalUtils.d.ts

@@ -7,2 +7,2 @@ /**
  */
-export declare const objectToURLParams: (obj: Record<string, unknown>) => Record<string, string>;
+export declare const objectToURLParams: (obj: Record<string, unknown> | undefined) => Record<string, string>;

dist/cjs/utils/generalUtils.js

@@ -10,12 +10,14 @@ "use strict";
  */
-const objectToURLParams = (obj) => Object.entries(obj).reduce((a, [k, v]) => {
-    if (v === undefined ||
-        v === null ||
-        (v instanceof Array && v.length === 0) ||
-        (v instanceof Object && Object.keys(v).length === 0) ||
-        v === '') {
-        return a;
-    }
-    return Object.assign(Object.assign({}, a), { [k]: v.toString() }); // Convert to string as needed
-}, {});
+const objectToURLParams = (obj) => obj
+    ? Object.entries(obj).reduce((a, [k, v]) => {
+        if (v === undefined ||
+            v === null ||
+            (v instanceof Array && v.length === 0) ||
+            (v instanceof Object && Object.keys(v).length === 0) ||
+            v === '') {
+            return a;
+        }
+        return Object.assign(Object.assign({}, a), { [k]: v.toString() }); // Convert to string as needed
+    }, {})
+    : {};
 exports.objectToURLParams = objectToURLParams;

dist/esm/gateway/GatewayContext.js

@@ -18,2 +18,3 @@ import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
 import { usePrevious } from '../useHooks/usePrevious';
+import { getFlowId } from '../utils/analytics';
 const logDebug = prefixLogger('GatewayContext').debug;
@@ -60,2 +61,4 @@ const GatewayContext = React.createContext({
         instanceId: uuid(),
+        did: chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.did,
+        flowId: getFlowId('', {}),
     });
@@ -110,2 +113,3 @@ const dispatch = useCallback((action) => {
             headers,
+            flowId: state.flowId,
         })
@@ -155,6 +159,8 @@ : undefined);
                 headers,
+                flowId: state.flowId,
             }));
         }, 10);
+        // eslint-disable-next-line consistent-return
         return () => abortController.abort();
-    }, [stage, gatekeeperEndpoint, gatekeeperNetworkAddress, network, wallet === null || wallet === void 0 ? void 0 : wallet.publicKey]);
+    }, [stage, gatekeeperEndpoint, gatekeeperNetworkAddress, network, wallet === null || wallet === void 0 ? void 0 : wallet.publicKey, state.flowId]);
     // this hook implements the main business logic and handles requesting and refreshing gateway tokens
@@ -161,0 +167,0 @@ useOrchestration({ wallet, chainImplementation, stage, gatekeeperClient }, state, dispatch);

dist/esm/useHooks/useChain.js

@@ -34,3 +34,3 @@ import { useCallback, useEffect } from 'react';
         }
-    }, [chainImplementation]);
+    }, [chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.initProps]);
     const dispatchListenerAdded = (listenerId) => {
@@ -54,3 +54,3 @@ dispatch({ type: 'tokenListenerAdded', listenerId });
         return listenerId;
-    }, [chainImplementation, tokenCreatedOrChangedListenerId]);
+    }, [chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.initProps, tokenCreatedOrChangedListenerId]);
     /**
@@ -70,3 +70,3 @@ * listen to the blockchain for a token being changed-only (the case where the chainImplementation doesn't support listening for creation)
         return listenerId;
-    }, [chainImplementation, tokenCreatedOrChangedListenerId]);
+    }, [chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.initProps, tokenCreatedOrChangedListenerId]);
     /**
@@ -106,3 +106,3 @@ * use the on-chain lookup utility findGatewayToken to retrieve a token from the chain
         }
-    }, [chainImplementation, gatekeeperNetworkAddress]);
+    }, [chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.initProps, gatekeeperNetworkAddress]);
     /**
@@ -113,3 +113,3 @@ * Check token on chain
         checkForOnChainToken(onGatewayTokenCreatedOrChanged);
-    }, [chainImplementation]);
+    }, [chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.initProps]);
     const dispatchTokenExpectedTimerAdded = (listenerId) => {
@@ -116,0 +116,0 @@ dispatch({ type: 'tokenExpectedTimerAdded', listenerId });

dist/esm/useHooks/useOrchestration.js

@@ -121,3 +121,3 @@ import { useCallback, useEffect } from 'react';
         };
-    }, [wallet === null || wallet === void 0 ? void 0 : wallet.publicKey, chainImplementation, state.tokenCreatedOrChangedListenerId]);
+    }, [wallet === null || wallet === void 0 ? void 0 : wallet.publicKey, chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.initProps, state.tokenCreatedOrChangedListenerId]);
     /**
@@ -124,0 +124,0 @@ * Refresh Flows ----------------------------------------------------------------

dist/esm/useHooks/useWalletHooks.js

@@ -55,3 +55,3 @@ import { useCallback } from 'react';
         }
-    }, [chainImplementation]);
+    }, [chainImplementation === null || chainImplementation === void 0 ? void 0 : chainImplementation.initProps]);
     return {
@@ -58,0 +58,0 @@ waitForTransactionConfirm,

dist/esm/useReducer/reducer.js

@@ -50,5 +50,5 @@ import { prefixLogger } from '../logger';
         case 'requestGatekeeperIssuanceRejected':
-            return Object.assign(Object.assign({}, resetState(state)), { gatewayStatus: GatewayStatus.REJECTED, tokenIssuanceState: TokenIssuanceState.FAILED });
+            return Object.assign(Object.assign({}, resetState(state)), { flowId: state.flowId, gatewayStatus: GatewayStatus.REJECTED, tokenIssuanceState: TokenIssuanceState.FAILED });
         case 'requestGatekeeperIssuanceFailed':
-            return Object.assign(Object.assign({}, resetState(state)), { gatewayStatus: GatewayStatus.ERROR, tokenIssuanceState: TokenIssuanceState.FAILED });
+            return Object.assign(Object.assign({}, resetState(state)), { flowId: state.flowId, gatewayStatus: GatewayStatus.ERROR, tokenIssuanceState: TokenIssuanceState.FAILED });
         case 'refreshAttemptDone':
@@ -61,3 +61,3 @@ return Object.assign(Object.assign({}, updatedState), { refreshInProgress: false });
             logDebug('resetStateWithProps', action);
-            return Object.assign(Object.assign({}, resetState(state)), { stage: action.stage, walletAddress: action.walletAddress, gatekeeperNetworkAddress: action.gatekeeperNetworkAddress, chainType: action.chainType, chainNetwork: action.chainNetwork });
+            return Object.assign(Object.assign({}, resetState(state)), { stage: action.stage, walletAddress: action.walletAddress, gatekeeperNetworkAddress: action.gatekeeperNetworkAddress, chainType: action.chainType, chainNetwork: action.chainNetwork, did: action.did });
         case 'tokenNotFoundError':
@@ -64,0 +64,0 @@ return Object.assign(Object.assign({}, state), { gatewayStatus: GatewayStatus.ERROR });

dist/esm/useReducer/utils.js

 import { prefixLogger } from '../logger';
 import config from '../networkConfig';
 import { GatewayStatus, TokenIssuanceState, CivicPassIssuanceStatus, State, GatekeeperAPIStatus, } from '../types';
+import { getFlowId } from '../utils/analytics';
 import { isTokenRefreshRequired } from '../utils/tokenUtils';
@@ -13,3 +14,3 @@ const logDebug = prefixLogger('useUserInteraction').debug;
             renderIframe: false,
-        }, userInitiatedFlow: false, flowId: undefined, did: undefined });
+        }, userInitiatedFlow: false, flowId: getFlowId('', {}), did: undefined });
 };
@@ -16,0 +17,0 @@ // const hasExpired = (gatewayToken: GatewayToken): boolean => {

dist/esm/utils/analytics.js

@@ -16,3 +16,5 @@ import { v4 as uuid } from 'uuid';
     }
-    return !state.flowId || !((_a = state.flowId) === null || _a === void 0 ? void 0 : _a.includes(prefix)) ? `${RC_FLOW_ID_PREFIX}_${prefix}${uuid()}` : state.flowId;
+    return !state.flowId || state.flowId === '' || !((_a = state.flowId) === null || _a === void 0 ? void 0 : _a.includes(prefix))
+        ? `${RC_FLOW_ID_PREFIX}_${prefix}${uuid()}`
+        : state.flowId;
 };
@@ -19,0 +21,0 @@ export const flowTypeFromFlowId = (flowId) => {

dist/esm/utils/gatekeeperClient.js

@@ -20,3 +20,3 @@ import fetchBuilder from 'fetch-retry';
         this.queryParams = initConfig.queryParams;
-        this.headers = objectToURLParams(Object.assign(Object.assign({}, initConfig.headers), { 'X-Civic-FlowId': initConfig.flowId }));
+        this.headers = objectToURLParams(Object.assign(Object.assign({}, initConfig.headers), { 'x-civic-flowid': initConfig.flowId }));
         this.fetchImplementation = initConfig.fetchImplementation || fetch;
@@ -23,0 +23,0 @@ const retries = initConfig.numRetries || getDefaultApiNumRetries(this.stage);

dist/esm/utils/generalUtils.d.ts

@@ -7,2 +7,2 @@ /**
  */
-export declare const objectToURLParams: (obj: Record<string, unknown>) => Record<string, string>;
+export declare const objectToURLParams: (obj: Record<string, unknown> | undefined) => Record<string, string>;

dist/esm/utils/generalUtils.js

@@ -7,11 +7,13 @@ /**
  */
-export const objectToURLParams = (obj) => Object.entries(obj).reduce((a, [k, v]) => {
-    if (v === undefined ||
-        v === null ||
-        (v instanceof Array && v.length === 0) ||
-        (v instanceof Object && Object.keys(v).length === 0) ||
-        v === '') {
-        return a;
-    }
-    return Object.assign(Object.assign({}, a), { [k]: v.toString() }); // Convert to string as needed
-}, {});
+export const objectToURLParams = (obj) => obj
+    ? Object.entries(obj).reduce((a, [k, v]) => {
+        if (v === undefined ||
+            v === null ||
+            (v instanceof Array && v.length === 0) ||
+            (v instanceof Object && Object.keys(v).length === 0) ||
+            v === '') {
+            return a;
+        }
+        return Object.assign(Object.assign({}, a), { [k]: v.toString() }); // Convert to string as needed
+    }, {})
+    : {};

package.json

 {
   "name": "@civic/common-gateway-react",
-  "version": "0.11.1",
+  "version": "0.11.2-beta.0",
   "main": "./dist/cjs/index.js",
@@ -37,3 +37,3 @@ "module": "./dist/esm/index.js",
   },
-  "gitHead": "8e2482b6812f302b4cb2336109bf34cab15d625f"
+  "gitHead": "61d5f3e84491828707cfa2f7ce45b174124576a4"
 }

No alert changes

Improved metrics

Total package byte prevSize

478905

0.49%

Lines of code

9259

0.25%

No dependency changes