@tryfinch/react-connect 2.8.1 → 3.1.0

package/.eslintrc.js

@@ -1,5 +1,12 @@
 module.exports = {
-  extends: ['airbnb', 'plugin:prettier/recommended', 'prettier/react'],
+  extends: [
+    'airbnb',
+    'plugin:prettier/recommended',
+    'prettier/react',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  parser: '@typescript-eslint/parser',
+  plugins: ['prettier', '@typescript-eslint'],
   env: {
     browser: true,
     commonjs: true,

package/README.md

@@ -1,6 +1,6 @@
 # @tryfinch/react-connect
 
-[![NPM](https://img.shields.io/npm/v/@tryfinch/react-connect)](https://www.npmjs.com/package/@tryfinch/react-connect) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+[![NPM](https://img.shields.io/npm/v/@tryfinch/react-connect)](https://www.npmjs.com/package/@tryfinch/react-connect)
 
 ## Install
 

package/dist/index.d.ts

@@ -1,25 +1,26 @@
-declare module 'react-finch-connect' {
-  export type SuccessEvent = {
+export type SuccessEvent = {
     code: string;
-  };
-
-  export type ErrorEvent = {
+    state?: string;
+};
+export type ErrorEvent = {
     errorMessage: string;
-  };
-
-  export type ConnectOptions = {
+};
+export type ConnectOptions = {
+    category: string | null;
     clientId: string;
-    products?: string[];
-    mode?: string;
-    manual?: boolean;
-    payrollProvider?: string;
-    sandbox?: boolean;
-    category?: string;
-    onSuccess?: (e: SuccessEvent) => void;
-    onError?: (e: ErrorEvent) => void;
-    onClose?: () => void;
-    zIndex?: bigint | string;
-  };
-
-  export function useFinchConnect(opts: ConnectOptions): { open: () => void };
-}
+    manual: boolean;
+    state: string | null;
+    onSuccess: (e: SuccessEvent) => void;
+    onError: (e: ErrorEvent) => void;
+    onClose: () => void;
+    payrollProvider: string | null;
+    products: string[];
+    sandbox: boolean;
+    zIndex: number;
+};
+type OpenFn = (overrides?: Partial<Pick<ConnectOptions, 'products'>>) => void;
+export declare const useFinchConnect: (options: Partial<ConnectOptions>) => {
+    open: OpenFn;
+};
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,SAAS,EAAE,CAAC,CAAC,EAAE,YAAY,KAAK,IAAI,CAAC;IACrC,OAAO,EAAE,CAAC,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;IACjC,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,MAAM,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC,KAAK,IAAI,CAAC;AAwE9E,eAAO,MAAM,eAAe,YAAa,QAAQ,cAAc,CAAC;UAAW,MAAM;CA+EhF,CAAC"}

package/dist/index.es.js

@@ -1,119 +1,112 @@
 import { useEffect } from 'react';
 
-var BASE_FINCH_CONNECT_URI = 'https://connect.tryfinch.com';
-var DEFAULT_FINCH_REDIRECT_URI = 'https://tryfinch.com';
-var FINCH_CONNECT_IFRAME_ID = 'finch-connect-iframe';
-var FINCH_AUTH_MESSAGE_NAME = 'finch-auth-message';
-
-var noop = function noop() {}; // eslint-disable-next-line import/prefer-default-export
-
-
-var useFinchConnect = function useFinchConnect() {
-  var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var clientId = options.clientId,
-      _options$products = options.products,
-      products = _options$products === void 0 ? [] : _options$products,
-      _options$mode = options.mode,
-      mode = _options$mode === void 0 ? 'employer' : _options$mode,
-      category = options.category,
-      _options$manual = options.manual,
-      manual = _options$manual === void 0 ? false : _options$manual,
-      _options$payrollProvi = options.payrollProvider,
-      payrollProvider = _options$payrollProvi === void 0 ? null : _options$payrollProvi,
-      _options$sandbox = options.sandbox,
-      sandbox = _options$sandbox === void 0 ? false : _options$sandbox,
-      _options$onSuccess = options.onSuccess,
-      onSuccess = _options$onSuccess === void 0 ? noop : _options$onSuccess,
-      _options$onError = options.onError,
-      onError = _options$onError === void 0 ? noop : _options$onError,
-      _options$onClose = options.onClose,
-      onClose = _options$onClose === void 0 ? noop : _options$onClose,
-      _options$zIndex = options.zIndex,
-      zIndex = _options$zIndex === void 0 ? 999 : _options$zIndex;
-
-  var _constructAuthUrl = function _constructAuthUrl(clientId, products) {
-    var authUrl = new URL("".concat(BASE_FINCH_CONNECT_URI, "/authorize"));
-    if (clientId) authUrl.searchParams.append('client_id', clientId);
-    if (payrollProvider) authUrl.searchParams.append('payroll_provider', payrollProvider);
-    if (category) authUrl.searchParams.append('category', category);
-    authUrl.searchParams.append('products', products.join(' '));
+const BASE_FINCH_CONNECT_URI = 'https://connect.tryfinch.com';
+const DEFAULT_FINCH_REDIRECT_URI = 'https://tryfinch.com';
+const FINCH_CONNECT_IFRAME_ID = 'finch-connect-iframe';
+const FINCH_AUTH_MESSAGE_NAME = 'finch-auth-message';
+const constructAuthUrl = ({ clientId, payrollProvider, category, products, manual, sandbox, state, }) => {
+    const authUrl = new URL(`${BASE_FINCH_CONNECT_URI}/authorize`);
+    if (clientId)
+        authUrl.searchParams.append('client_id', clientId);
+    if (payrollProvider)
+        authUrl.searchParams.append('payroll_provider', payrollProvider);
+    if (category)
+        authUrl.searchParams.append('category', category);
+    authUrl.searchParams.append('products', (products !== null && products !== void 0 ? products : []).join(' '));
     authUrl.searchParams.append('app_type', 'spa');
     authUrl.searchParams.append('redirect_uri', DEFAULT_FINCH_REDIRECT_URI);
-    authUrl.searchParams.append('mode', mode);
-    if (manual) authUrl.searchParams.append('manual', manual);
-    if (sandbox) authUrl.searchParams.append('sandbox', sandbox);
-    /* global "2.8.1" */
-
-    authUrl.searchParams.append('sdk_version', "react-".concat("2.8.1"));
+    authUrl.searchParams.append('mode', 'employer');
+    if (manual)
+        authUrl.searchParams.append('manual', String(manual));
+    if (sandbox)
+        authUrl.searchParams.append('sandbox', String(sandbox));
+    if (state)
+        authUrl.searchParams.append('state', state);
+    // replace with actual SDK version by rollup
+    authUrl.searchParams.append('sdk_version', 'react-3.1.0');
     return authUrl.href;
-  };
-
-  var open = function open() {
-    if (document.getElementById(FINCH_CONNECT_IFRAME_ID)) {
-      return null;
-    }
-
-    var iframe = document.createElement('iframe');
-    iframe.src = _constructAuthUrl(clientId, products);
-    iframe.frameBorder = '0';
-    iframe.id = FINCH_CONNECT_IFRAME_ID;
-    iframe.style.position = 'fixed';
-    iframe.style.zIndex = zIndex.toString();
-    iframe.style.height = '100%';
-    iframe.style.width = '100%';
-    iframe.style.top = '0';
-    iframe.style.backgroundColor = 'none transparent';
-    iframe.style.border = 'none';
-    document.body.prepend(iframe);
-    document.body.style.overflow = 'hidden';
-  };
-
-  var close = function close() {
-    var frameToRemove = document.getElementById(FINCH_CONNECT_IFRAME_ID);
-
-    if (frameToRemove) {
-      frameToRemove.parentNode.removeChild(frameToRemove);
-      document.body.style.overflow = 'inherit';
-    }
-  };
-
-  useEffect(function () {
-    function handleFinchAuth(event) {
-      var handleFinchAuthSuccess = function handleFinchAuthSuccess(code) {
-        return onSuccess({
-          code: code
-        });
-      };
-
-      var handleFinchAuthError = function handleFinchAuthError(error) {
-        return onError({
-          errorMessage: error
-        });
-      };
-
-      var handleFinchAuthClose = function handleFinchAuthClose() {
-        return onClose();
-      };
-
-      if (!event.data) return;
-      if (event.data.name !== FINCH_AUTH_MESSAGE_NAME) return;
-      if (!event.origin.startsWith(BASE_FINCH_CONNECT_URI)) return;
-      var _event$data = event.data,
-          code = _event$data.code,
-          error = _event$data.error,
-          closed = _event$data.closed;
-      close();
-      if (code) handleFinchAuthSuccess(code);else if (error) handleFinchAuthError(error);else if (closed) handleFinchAuthClose();
-    }
-
-    window.addEventListener('message', handleFinchAuth);
-    return function () {
-      return window.removeEventListener('message', handleFinchAuth);
+};
+const noop = () => {
+    // intentionally empty
+};
+const DEFAULT_OPTIONS = {
+    category: null,
+    manual: false,
+    onSuccess: noop,
+    onError: noop,
+    onClose: noop,
+    payrollProvider: null,
+    products: [],
+    sandbox: false,
+    state: null,
+    zIndex: 999,
+};
+const useFinchConnect = (options) => {
+    if (!options.clientId)
+        throw new Error('must specify clientId in options for useFinchConnect');
+    const combinedOptions = Object.assign(Object.assign({ clientId: '' }, DEFAULT_OPTIONS), options);
+    const open = (overrides) => {
+        const openOptions = Object.assign(Object.assign({}, combinedOptions), overrides);
+        if (!document.getElementById(FINCH_CONNECT_IFRAME_ID)) {
+            const iframe = document.createElement('iframe');
+            iframe.src = constructAuthUrl(openOptions);
+            iframe.frameBorder = '0';
+            iframe.id = FINCH_CONNECT_IFRAME_ID;
+            iframe.style.position = 'fixed';
+            iframe.style.zIndex = openOptions.zIndex.toString();
+            iframe.style.height = '100%';
+            iframe.style.width = '100%';
+            iframe.style.top = '0';
+            iframe.style.backgroundColor = 'none transparent';
+            iframe.style.border = 'none';
+            document.body.prepend(iframe);
+            document.body.style.overflow = 'hidden';
+        }
+    };
+    const close = () => {
+        var _a;
+        const frameToRemove = document.getElementById(FINCH_CONNECT_IFRAME_ID);
+        if (frameToRemove) {
+            (_a = frameToRemove.parentNode) === null || _a === void 0 ? void 0 : _a.removeChild(frameToRemove);
+            document.body.style.overflow = 'inherit';
+        }
+    };
+    useEffect(() => {
+        function handleFinchAuth(event) {
+            if (!event.data)
+                return;
+            if (event.data.name !== FINCH_AUTH_MESSAGE_NAME)
+                return;
+            if (!event.origin.startsWith(BASE_FINCH_CONNECT_URI))
+                return;
+            close();
+            switch (event.data.kind) {
+                case 'closed':
+                    combinedOptions.onClose();
+                    break;
+                case 'error':
+                    combinedOptions.onError({ errorMessage: event.data.error });
+                    break;
+                case 'success':
+                    combinedOptions.onSuccess({
+                        code: event.data.code,
+                        state: event.data.state,
+                    });
+                    break;
+                default: {
+                    // This case should never happen, if it does it should be reported to us
+                    combinedOptions.onError({
+                        errorMessage: `Report to developers@tryfinch.com: unable to handle window.postMessage for:  ${JSON.stringify(event.data)}`,
+                    });
+                }
+            }
+        }
+        window.addEventListener('message', handleFinchAuth);
+        return () => window.removeEventListener('message', handleFinchAuth);
+    }, [combinedOptions.onClose, combinedOptions.onError, combinedOptions.onSuccess]);
+    return {
+        open,
     };
-  }, [onClose, onError, onSuccess]);
-  return {
-    open: open
-  };
 };
 
 export { useFinchConnect };

package/dist/index.es.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.es.js","sources":["../src/index.js"],"sourcesContent":["import { useEffect } from 'react';\n\nconst BASE_FINCH_CONNECT_URI = 'https://connect.tryfinch.com';\nconst DEFAULT_FINCH_REDIRECT_URI = 'https://tryfinch.com';\nconst FINCH_CONNECT_IFRAME_ID = 'finch-connect-iframe';\nconst FINCH_AUTH_MESSAGE_NAME = 'finch-auth-message';\n\nconst noop = () => {};\n\n// eslint-disable-next-line import/prefer-default-export\nexport const useFinchConnect = (options = {}) => {\n  const {\n    clientId,\n    products = [],\n    mode = 'employer',\n    category,\n    manual = false,\n    payrollProvider = null,\n    sandbox = false,\n    onSuccess = noop,\n    onError = noop,\n    onClose = noop,\n    zIndex = 999,\n  } = options;\n\n  const _constructAuthUrl = (clientId, products) => {\n    const authUrl = new URL(`${BASE_FINCH_CONNECT_URI}/authorize`);\n\n    if (clientId) authUrl.searchParams.append('client_id', clientId);\n    if (payrollProvider) authUrl.searchParams.append('payroll_provider', payrollProvider);\n    if (category) authUrl.searchParams.append('category', category);\n    authUrl.searchParams.append('products', products.join(' '));\n    authUrl.searchParams.append('app_type', 'spa');\n    authUrl.searchParams.append('redirect_uri', DEFAULT_FINCH_REDIRECT_URI);\n    authUrl.searchParams.append('mode', mode);\n    if (manual) authUrl.searchParams.append('manual', manual);\n    if (sandbox) authUrl.searchParams.append('sandbox', sandbox);\n    /* global SDK_VERSION */\n    if (SDK_VERSION) authUrl.searchParams.append('sdk_version', `react-${SDK_VERSION}`);\n\n    return authUrl.href;\n  };\n\n  const open = () => {\n    if (document.getElementById(FINCH_CONNECT_IFRAME_ID)) {\n      return null;\n    }\n\n    const iframe = document.createElement('iframe');\n    iframe.src = _constructAuthUrl(clientId, products);\n    iframe.frameBorder = '0';\n    iframe.id = FINCH_CONNECT_IFRAME_ID;\n    iframe.style.position = 'fixed';\n    iframe.style.zIndex = zIndex.toString();\n    iframe.style.height = '100%';\n    iframe.style.width = '100%';\n    iframe.style.top = '0';\n    iframe.style.backgroundColor = 'none transparent';\n    iframe.style.border = 'none';\n    document.body.prepend(iframe);\n    document.body.style.overflow = 'hidden';\n  };\n\n  const close = () => {\n    const frameToRemove = document.getElementById(FINCH_CONNECT_IFRAME_ID);\n    if (frameToRemove) {\n      frameToRemove.parentNode.removeChild(frameToRemove);\n      document.body.style.overflow = 'inherit';\n    }\n  };\n\n  useEffect(() => {\n    function handleFinchAuth(event) {\n      const handleFinchAuthSuccess = (code) => onSuccess({ code });\n      const handleFinchAuthError = (error) => onError({ errorMessage: error });\n      const handleFinchAuthClose = () => onClose();\n\n      if (!event.data) return;\n      if (event.data.name !== FINCH_AUTH_MESSAGE_NAME) return;\n      if (!event.origin.startsWith(BASE_FINCH_CONNECT_URI)) return;\n\n      const { code, error, closed } = event.data;\n\n      close();\n      if (code) handleFinchAuthSuccess(code);\n      else if (error) handleFinchAuthError(error);\n      else if (closed) handleFinchAuthClose();\n    }\n\n    window.addEventListener('message', handleFinchAuth);\n    return () => window.removeEventListener('message', handleFinchAuth);\n  }, [onClose, onError, onSuccess]);\n\n  return {\n    open,\n  };\n};\n"],"names":["BASE_FINCH_CONNECT_URI","DEFAULT_FINCH_REDIRECT_URI","FINCH_CONNECT_IFRAME_ID","FINCH_AUTH_MESSAGE_NAME","noop","useFinchConnect","options","clientId","products","mode","category","manual","payrollProvider","sandbox","onSuccess","onError","onClose","zIndex","_constructAuthUrl","authUrl","URL","searchParams","append","join","SDK_VERSION","href","open","document","getElementById","iframe","createElement","src","frameBorder","id","style","position","toString","height","width","top","backgroundColor","border","body","prepend","overflow","close","frameToRemove","parentNode","removeChild","useEffect","handleFinchAuth","event","handleFinchAuthSuccess","code","handleFinchAuthError","error","errorMessage","handleFinchAuthClose","data","name","origin","startsWith","closed","window","addEventListener","removeEventListener"],"mappings":";;AAEA,IAAMA,sBAAsB,GAAG,8BAA/B,CAAA;AACA,IAAMC,0BAA0B,GAAG,sBAAnC,CAAA;AACA,IAAMC,uBAAuB,GAAG,sBAAhC,CAAA;AACA,IAAMC,uBAAuB,GAAG,oBAAhC,CAAA;;AAEA,IAAMC,IAAI,GAAG,SAAPA,IAAO,GAAM,EAAnB;;;AAGaC,IAAAA,eAAe,GAAG,SAAlBA,eAAkB,GAAkB;EAAA,IAAjBC,OAAiB,uEAAP,EAAO,CAAA;AAC/C,EAAA,IACEC,QADF,GAYID,OAZJ,CACEC,QADF;MAYID,iBAAAA,GAAAA,OAZJ,CAEEE,QAFF;MAEEA,QAFF,kCAEa,EAFb,GAAA,iBAAA;MAYIF,aAAAA,GAAAA,OAZJ,CAGEG,IAHF;MAGEA,IAHF,8BAGS,UAHT,GAAA,aAAA;AAAA,MAIEC,QAJF,GAYIJ,OAZJ,CAIEI,QAJF;MAYIJ,eAAAA,GAAAA,OAZJ,CAKEK,MALF;MAKEA,MALF,gCAKW,KALX,GAAA,eAAA;MAYIL,qBAAAA,GAAAA,OAZJ,CAMEM,eANF;MAMEA,eANF,sCAMoB,IANpB,GAAA,qBAAA;MAYIN,gBAAAA,GAAAA,OAZJ,CAOEO,OAPF;MAOEA,OAPF,iCAOY,KAPZ,GAAA,gBAAA;MAYIP,kBAAAA,GAAAA,OAZJ,CAQEQ,SARF;MAQEA,SARF,mCAQcV,IARd,GAAA,kBAAA;MAYIE,gBAAAA,GAAAA,OAZJ,CASES,OATF;MASEA,OATF,iCASYX,IATZ,GAAA,gBAAA;MAYIE,gBAAAA,GAAAA,OAZJ,CAUEU,OAVF;MAUEA,OAVF,iCAUYZ,IAVZ,GAAA,gBAAA;MAYIE,eAAAA,GAAAA,OAZJ,CAWEW,MAXF;MAWEA,MAXF,gCAWW,GAXX,GAAA,eAAA,CAAA;;EAcA,IAAMC,iBAAiB,GAAG,SAApBA,iBAAoB,CAACX,QAAD,EAAWC,QAAX,EAAwB;AAChD,IAAA,IAAMW,OAAO,GAAG,IAAIC,GAAJ,CAAA,EAAA,CAAA,MAAA,CAAWpB,sBAAX,EAAhB,YAAA,CAAA,CAAA,CAAA;IAEA,IAAIO,QAAJ,EAAcY,OAAO,CAACE,YAAR,CAAqBC,MAArB,CAA4B,WAA5B,EAAyCf,QAAzC,CAAA,CAAA;IACd,IAAIK,eAAJ,EAAqBO,OAAO,CAACE,YAAR,CAAqBC,MAArB,CAA4B,kBAA5B,EAAgDV,eAAhD,CAAA,CAAA;IACrB,IAAIF,QAAJ,EAAcS,OAAO,CAACE,YAAR,CAAqBC,MAArB,CAA4B,UAA5B,EAAwCZ,QAAxC,CAAA,CAAA;AACdS,IAAAA,OAAO,CAACE,YAAR,CAAqBC,MAArB,CAA4B,UAA5B,EAAwCd,QAAQ,CAACe,IAAT,CAAc,GAAd,CAAxC,CAAA,CAAA;AACAJ,IAAAA,OAAO,CAACE,YAAR,CAAqBC,MAArB,CAA4B,UAA5B,EAAwC,KAAxC,CAAA,CAAA;AACAH,IAAAA,OAAO,CAACE,YAAR,CAAqBC,MAArB,CAA4B,cAA5B,EAA4CrB,0BAA5C,CAAA,CAAA;AACAkB,IAAAA,OAAO,CAACE,YAAR,CAAqBC,MAArB,CAA4B,MAA5B,EAAoCb,IAApC,CAAA,CAAA;IACA,IAAIE,MAAJ,EAAYQ,OAAO,CAACE,YAAR,CAAqBC,MAArB,CAA4B,QAA5B,EAAsCX,MAAtC,CAAA,CAAA;IACZ,IAAIE,OAAJ,EAAaM,OAAO,CAACE,YAAR,CAAqBC,MAArB,CAA4B,SAA5B,EAAuCT,OAAvC,CAAA,CAAA;AACb;;IACiBM,OAAO,CAACE,YAAR,CAAqBC,MAArB,CAA4B,aAA5B,EAAA,QAAA,CAAA,MAAA,CAAoDE,OAApD,CAAA,CAAA,CAAA;IAEjB,OAAOL,OAAO,CAACM,IAAf,CAAA;GAfF,CAAA;;AAkBA,EAAA,IAAMC,IAAI,GAAG,SAAPA,IAAO,GAAM;AACjB,IAAA,IAAIC,QAAQ,CAACC,cAAT,CAAwB1B,uBAAxB,CAAJ,EAAsD;AACpD,MAAA,OAAO,IAAP,CAAA;AACD,KAAA;;AAED,IAAA,IAAM2B,MAAM,GAAGF,QAAQ,CAACG,aAAT,CAAuB,QAAvB,CAAf,CAAA;IACAD,MAAM,CAACE,GAAP,GAAab,iBAAiB,CAACX,QAAD,EAAWC,QAAX,CAA9B,CAAA;IACAqB,MAAM,CAACG,WAAP,GAAqB,GAArB,CAAA;IACAH,MAAM,CAACI,EAAP,GAAY/B,uBAAZ,CAAA;AACA2B,IAAAA,MAAM,CAACK,KAAP,CAAaC,QAAb,GAAwB,OAAxB,CAAA;IACAN,MAAM,CAACK,KAAP,CAAajB,MAAb,GAAsBA,MAAM,CAACmB,QAAP,EAAtB,CAAA;AACAP,IAAAA,MAAM,CAACK,KAAP,CAAaG,MAAb,GAAsB,MAAtB,CAAA;AACAR,IAAAA,MAAM,CAACK,KAAP,CAAaI,KAAb,GAAqB,MAArB,CAAA;AACAT,IAAAA,MAAM,CAACK,KAAP,CAAaK,GAAb,GAAmB,GAAnB,CAAA;AACAV,IAAAA,MAAM,CAACK,KAAP,CAAaM,eAAb,GAA+B,kBAA/B,CAAA;AACAX,IAAAA,MAAM,CAACK,KAAP,CAAaO,MAAb,GAAsB,MAAtB,CAAA;AACAd,IAAAA,QAAQ,CAACe,IAAT,CAAcC,OAAd,CAAsBd,MAAtB,CAAA,CAAA;AACAF,IAAAA,QAAQ,CAACe,IAAT,CAAcR,KAAd,CAAoBU,QAApB,GAA+B,QAA/B,CAAA;GAjBF,CAAA;;AAoBA,EAAA,IAAMC,KAAK,GAAG,SAARA,KAAQ,GAAM;AAClB,IAAA,IAAMC,aAAa,GAAGnB,QAAQ,CAACC,cAAT,CAAwB1B,uBAAxB,CAAtB,CAAA;;AACA,IAAA,IAAI4C,aAAJ,EAAmB;AACjBA,MAAAA,aAAa,CAACC,UAAd,CAAyBC,WAAzB,CAAqCF,aAArC,CAAA,CAAA;AACAnB,MAAAA,QAAQ,CAACe,IAAT,CAAcR,KAAd,CAAoBU,QAApB,GAA+B,SAA/B,CAAA;AACD,KAAA;GALH,CAAA;;AAQAK,EAAAA,SAAS,CAAC,YAAM;IACd,SAASC,eAAT,CAAyBC,KAAzB,EAAgC;AAC9B,MAAA,IAAMC,sBAAsB,GAAG,SAAzBA,sBAAyB,CAACC,IAAD,EAAA;AAAA,QAAA,OAAUvC,SAAS,CAAC;AAAEuC,UAAAA,IAAI,EAAJA,IAAAA;AAAF,SAAD,CAAnB,CAAA;OAA/B,CAAA;;AACA,MAAA,IAAMC,oBAAoB,GAAG,SAAvBA,oBAAuB,CAACC,KAAD,EAAA;AAAA,QAAA,OAAWxC,OAAO,CAAC;AAAEyC,UAAAA,YAAY,EAAED,KAAAA;AAAhB,SAAD,CAAlB,CAAA;OAA7B,CAAA;;MACA,IAAME,oBAAoB,GAAG,SAAvBA,oBAAuB,GAAA;AAAA,QAAA,OAAMzC,OAAO,EAAb,CAAA;OAA7B,CAAA;;AAEA,MAAA,IAAI,CAACmC,KAAK,CAACO,IAAX,EAAiB,OAAA;AACjB,MAAA,IAAIP,KAAK,CAACO,IAAN,CAAWC,IAAX,KAAoBxD,uBAAxB,EAAiD,OAAA;MACjD,IAAI,CAACgD,KAAK,CAACS,MAAN,CAAaC,UAAb,CAAwB7D,sBAAxB,CAAL,EAAsD,OAAA;MAEtD,IAAgCmD,WAAAA,GAAAA,KAAK,CAACO,IAAtC;UAAQL,IAAR,eAAQA,IAAR;UAAcE,KAAd,eAAcA,KAAd;UAAqBO,MAArB,eAAqBA,MAArB,CAAA;MAEAjB,KAAK,EAAA,CAAA;MACL,IAAIQ,IAAJ,EAAUD,sBAAsB,CAACC,IAAD,CAAtB,CAAV,KACK,IAAIE,KAAJ,EAAWD,oBAAoB,CAACC,KAAD,CAApB,CAAX,KACA,IAAIO,MAAJ,EAAYL,oBAAoB,EAAA,CAAA;AACtC,KAAA;;AAEDM,IAAAA,MAAM,CAACC,gBAAP,CAAwB,SAAxB,EAAmCd,eAAnC,CAAA,CAAA;IACA,OAAO,YAAA;AAAA,MAAA,OAAMa,MAAM,CAACE,mBAAP,CAA2B,SAA3B,EAAsCf,eAAtC,CAAN,CAAA;KAAP,CAAA;GAnBO,EAoBN,CAAClC,OAAD,EAAUD,OAAV,EAAmBD,SAAnB,CApBM,CAAT,CAAA;EAsBA,OAAO;AACLY,IAAAA,IAAI,EAAJA,IAAAA;GADF,CAAA;AAGD;;;;"}
+{"version":3,"file":"index.es.js","sources":["../src/src/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAiDA,MAAM,sBAAsB,GAAG,8BAA8B,CAAC;AAC9D,MAAM,0BAA0B,GAAG,sBAAsB,CAAC;AAC1D,MAAM,uBAAuB,GAAG,sBAAsB,CAAC;AACvD,MAAM,uBAAuB,GAAG,oBAAoB,CAAC;AAErD,MAAM,gBAAgB,GAAG,CAAC,EACxB,QAAQ,EACR,eAAe,EACf,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,OAAO,EACP,KAAK,GACmB,KAAI;IAC5B,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,CAAG,EAAA,sBAAsB,CAAY,UAAA,CAAA,CAAC,CAAC;AAC/D,IAAA,IAAI,QAAQ;QAAE,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;AACjE,IAAA,IAAI,eAAe;QAAE,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,kBAAkB,EAAE,eAAe,CAAC,CAAC;AACtF,IAAA,IAAI,QAAQ;QAAE,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAChE,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,QAAQ,KAAR,IAAA,IAAA,QAAQ,cAAR,QAAQ,GAAI,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACpE,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAC/C,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,cAAc,EAAE,0BAA0B,CAAC,CAAC;IACxE,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAChD,IAAA,IAAI,MAAM;AAAE,QAAA,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AAClE,IAAA,IAAI,OAAO;AAAE,QAAA,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;AACrE,IAAA,IAAI,KAAK;QAAE,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;;IAEvD,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,aAAmB,CAAC,CAAC;IAEhE,OAAO,OAAO,CAAC,IAAI,CAAC;AACtB,CAAC,CAAC;AAEF,MAAM,IAAI,GAAG,MAAK;;AAElB,CAAC,CAAC;AAEF,MAAM,eAAe,GAAqC;AACxD,IAAA,QAAQ,EAAE,IAAI;AACd,IAAA,MAAM,EAAE,KAAK;AACb,IAAA,SAAS,EAAE,IAAI;AACf,IAAA,OAAO,EAAE,IAAI;AACb,IAAA,OAAO,EAAE,IAAI;AACb,IAAA,eAAe,EAAE,IAAI;AACrB,IAAA,QAAQ,EAAE,EAAE;AACZ,IAAA,OAAO,EAAE,KAAK;AACd,IAAA,KAAK,EAAE,IAAI;AACX,IAAA,MAAM,EAAE,GAAG;CACZ,CAAC;AAEW,MAAA,eAAe,GAAG,CAAC,OAAgC,KAAsB;IACpF,IAAI,CAAC,OAAO,CAAC,QAAQ;AAAE,QAAA,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAE/F,MAAM,eAAe,GACnB,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,EAAA,QAAQ,EAAE,EAAE,IACT,eAAe,CAAA,EACf,OAAO,CACX,CAAC;AAEF,IAAA,MAAM,IAAI,GAAW,CAAC,SAAqD,KAAI;AAC7E,QAAA,MAAM,WAAW,GACZ,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,EAAA,EAAA,eAAe,CACf,EAAA,SAAS,CACb,CAAC;AAEF,QAAA,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,uBAAuB,CAAC,EAAE;YACrD,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;AAChD,YAAA,MAAM,CAAC,GAAG,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;AAC3C,YAAA,MAAM,CAAC,WAAW,GAAG,GAAG,CAAC;AACzB,YAAA,MAAM,CAAC,EAAE,GAAG,uBAAuB,CAAC;AACpC,YAAA,MAAM,CAAC,KAAK,CAAC,QAAQ,GAAG,OAAO,CAAC;YAChC,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;AACpD,YAAA,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;AAC7B,YAAA,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC;AAC5B,YAAA,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;AACvB,YAAA,MAAM,CAAC,KAAK,CAAC,eAAe,GAAG,kBAAkB,CAAC;AAClD,YAAA,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;AAC7B,YAAA,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC9B,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACzC,SAAA;AACH,KAAC,CAAC;IAEF,MAAM,KAAK,GAAG,MAAK;;QACjB,MAAM,aAAa,GAAG,QAAQ,CAAC,cAAc,CAAC,uBAAuB,CAAC,CAAC;AACvE,QAAA,IAAI,aAAa,EAAE;YACjB,CAAA,EAAA,GAAA,aAAa,CAAC,UAAU,MAAA,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAE,WAAW,CAAC,aAAa,CAAC,CAAC;YACrD,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;AAC1C,SAAA;AACH,KAAC,CAAC;IAEF,SAAS,CAAC,MAAK;QACb,SAAS,eAAe,CAAC,KAA8B,EAAA;YACrD,IAAI,CAAC,KAAK,CAAC,IAAI;gBAAE,OAAO;AACxB,YAAA,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,uBAAuB;gBAAE,OAAO;YACxD,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,sBAAsB,CAAC;gBAAE,OAAO;AAE7D,YAAA,KAAK,EAAE,CAAC;AAER,YAAA,QAAQ,KAAK,CAAC,IAAI,CAAC,IAAI;AACrB,gBAAA,KAAK,QAAQ;oBACX,eAAe,CAAC,OAAO,EAAE,CAAC;oBAC1B,MAAM;AACR,gBAAA,KAAK,OAAO;AACV,oBAAA,eAAe,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;oBAC5D,MAAM;AACR,gBAAA,KAAK,SAAS;oBACZ,eAAe,CAAC,SAAS,CAAC;AACxB,wBAAA,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI;AACrB,wBAAA,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK;AACxB,qBAAA,CAAC,CAAC;oBACH,MAAM;AACR,gBAAA,SAAS;;oBAEP,eAAe,CAAC,OAAO,CAAC;wBACtB,YAAY,EAAE,CAAgF,6EAAA,EAAA,IAAI,CAAC,SAAS,CAC1G,KAAK,CAAC,IAAI,CACX,CAAE,CAAA;AACJ,qBAAA,CAAC,CAAC;AACJ,iBAAA;AACF,aAAA;SACF;AAED,QAAA,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QACpD,OAAO,MAAM,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;AACtE,KAAC,EAAE,CAAC,eAAe,CAAC,OAAO,EAAE,eAAe,CAAC,OAAO,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;IAElF,OAAO;QACL,IAAI;KACL,CAAC;AACJ;;;;"}

package/dist/index.js

@@ -4,120 +4,113 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var react = require('react');
 
-var BASE_FINCH_CONNECT_URI = 'https://connect.tryfinch.com';
-var DEFAULT_FINCH_REDIRECT_URI = 'https://tryfinch.com';
-var FINCH_CONNECT_IFRAME_ID = 'finch-connect-iframe';
-var FINCH_AUTH_MESSAGE_NAME = 'finch-auth-message';
-
-var noop = function noop() {}; // eslint-disable-next-line import/prefer-default-export
-
-
-var useFinchConnect = function useFinchConnect() {
-  var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var clientId = options.clientId,
-      _options$products = options.products,
-      products = _options$products === void 0 ? [] : _options$products,
-      _options$mode = options.mode,
-      mode = _options$mode === void 0 ? 'employer' : _options$mode,
-      category = options.category,
-      _options$manual = options.manual,
-      manual = _options$manual === void 0 ? false : _options$manual,
-      _options$payrollProvi = options.payrollProvider,
-      payrollProvider = _options$payrollProvi === void 0 ? null : _options$payrollProvi,
-      _options$sandbox = options.sandbox,
-      sandbox = _options$sandbox === void 0 ? false : _options$sandbox,
-      _options$onSuccess = options.onSuccess,
-      onSuccess = _options$onSuccess === void 0 ? noop : _options$onSuccess,
-      _options$onError = options.onError,
-      onError = _options$onError === void 0 ? noop : _options$onError,
-      _options$onClose = options.onClose,
-      onClose = _options$onClose === void 0 ? noop : _options$onClose,
-      _options$zIndex = options.zIndex,
-      zIndex = _options$zIndex === void 0 ? 999 : _options$zIndex;
-
-  var _constructAuthUrl = function _constructAuthUrl(clientId, products) {
-    var authUrl = new URL("".concat(BASE_FINCH_CONNECT_URI, "/authorize"));
-    if (clientId) authUrl.searchParams.append('client_id', clientId);
-    if (payrollProvider) authUrl.searchParams.append('payroll_provider', payrollProvider);
-    if (category) authUrl.searchParams.append('category', category);
-    authUrl.searchParams.append('products', products.join(' '));
+const BASE_FINCH_CONNECT_URI = 'https://connect.tryfinch.com';
+const DEFAULT_FINCH_REDIRECT_URI = 'https://tryfinch.com';
+const FINCH_CONNECT_IFRAME_ID = 'finch-connect-iframe';
+const FINCH_AUTH_MESSAGE_NAME = 'finch-auth-message';
+const constructAuthUrl = ({ clientId, payrollProvider, category, products, manual, sandbox, state, }) => {
+    const authUrl = new URL(`${BASE_FINCH_CONNECT_URI}/authorize`);
+    if (clientId)
+        authUrl.searchParams.append('client_id', clientId);
+    if (payrollProvider)
+        authUrl.searchParams.append('payroll_provider', payrollProvider);
+    if (category)
+        authUrl.searchParams.append('category', category);
+    authUrl.searchParams.append('products', (products !== null && products !== void 0 ? products : []).join(' '));
     authUrl.searchParams.append('app_type', 'spa');
     authUrl.searchParams.append('redirect_uri', DEFAULT_FINCH_REDIRECT_URI);
-    authUrl.searchParams.append('mode', mode);
-    if (manual) authUrl.searchParams.append('manual', manual);
-    if (sandbox) authUrl.searchParams.append('sandbox', sandbox);
-    /* global "2.8.1" */
-
-    authUrl.searchParams.append('sdk_version', "react-".concat("2.8.1"));
+    authUrl.searchParams.append('mode', 'employer');
+    if (manual)
+        authUrl.searchParams.append('manual', String(manual));
+    if (sandbox)
+        authUrl.searchParams.append('sandbox', String(sandbox));
+    if (state)
+        authUrl.searchParams.append('state', state);
+    // replace with actual SDK version by rollup
+    authUrl.searchParams.append('sdk_version', 'react-3.1.0');
     return authUrl.href;
-  };
-
-  var open = function open() {
-    if (document.getElementById(FINCH_CONNECT_IFRAME_ID)) {
-      return null;
-    }
-
-    var iframe = document.createElement('iframe');
-    iframe.src = _constructAuthUrl(clientId, products);
-    iframe.frameBorder = '0';
-    iframe.id = FINCH_CONNECT_IFRAME_ID;
-    iframe.style.position = 'fixed';
-    iframe.style.zIndex = zIndex.toString();
-    iframe.style.height = '100%';
-    iframe.style.width = '100%';
-    iframe.style.top = '0';
-    iframe.style.backgroundColor = 'none transparent';
-    iframe.style.border = 'none';
-    document.body.prepend(iframe);
-    document.body.style.overflow = 'hidden';
-  };
-
-  var close = function close() {
-    var frameToRemove = document.getElementById(FINCH_CONNECT_IFRAME_ID);
-
-    if (frameToRemove) {
-      frameToRemove.parentNode.removeChild(frameToRemove);
-      document.body.style.overflow = 'inherit';
-    }
-  };
-
-  react.useEffect(function () {
-    function handleFinchAuth(event) {
-      var handleFinchAuthSuccess = function handleFinchAuthSuccess(code) {
-        return onSuccess({
-          code: code
-        });
-      };
-
-      var handleFinchAuthError = function handleFinchAuthError(error) {
-        return onError({
-          errorMessage: error
-        });
-      };
-
-      var handleFinchAuthClose = function handleFinchAuthClose() {
-        return onClose();
-      };
-
-      if (!event.data) return;
-      if (event.data.name !== FINCH_AUTH_MESSAGE_NAME) return;
-      if (!event.origin.startsWith(BASE_FINCH_CONNECT_URI)) return;
-      var _event$data = event.data,
-          code = _event$data.code,
-          error = _event$data.error,
-          closed = _event$data.closed;
-      close();
-      if (code) handleFinchAuthSuccess(code);else if (error) handleFinchAuthError(error);else if (closed) handleFinchAuthClose();
-    }
-
-    window.addEventListener('message', handleFinchAuth);
-    return function () {
-      return window.removeEventListener('message', handleFinchAuth);
+};
+const noop = () => {
+    // intentionally empty
+};
+const DEFAULT_OPTIONS = {
+    category: null,
+    manual: false,
+    onSuccess: noop,
+    onError: noop,
+    onClose: noop,
+    payrollProvider: null,
+    products: [],
+    sandbox: false,
+    state: null,
+    zIndex: 999,
+};
+const useFinchConnect = (options) => {
+    if (!options.clientId)
+        throw new Error('must specify clientId in options for useFinchConnect');
+    const combinedOptions = Object.assign(Object.assign({ clientId: '' }, DEFAULT_OPTIONS), options);
+    const open = (overrides) => {
+        const openOptions = Object.assign(Object.assign({}, combinedOptions), overrides);
+        if (!document.getElementById(FINCH_CONNECT_IFRAME_ID)) {
+            const iframe = document.createElement('iframe');
+            iframe.src = constructAuthUrl(openOptions);
+            iframe.frameBorder = '0';
+            iframe.id = FINCH_CONNECT_IFRAME_ID;
+            iframe.style.position = 'fixed';
+            iframe.style.zIndex = openOptions.zIndex.toString();
+            iframe.style.height = '100%';
+            iframe.style.width = '100%';
+            iframe.style.top = '0';
+            iframe.style.backgroundColor = 'none transparent';
+            iframe.style.border = 'none';
+            document.body.prepend(iframe);
+            document.body.style.overflow = 'hidden';
+        }
+    };
+    const close = () => {
+        var _a;
+        const frameToRemove = document.getElementById(FINCH_CONNECT_IFRAME_ID);
+        if (frameToRemove) {
+            (_a = frameToRemove.parentNode) === null || _a === void 0 ? void 0 : _a.removeChild(frameToRemove);
+            document.body.style.overflow = 'inherit';
+        }
+    };
+    react.useEffect(() => {
+        function handleFinchAuth(event) {
+            if (!event.data)
+                return;
+            if (event.data.name !== FINCH_AUTH_MESSAGE_NAME)
+                return;
+            if (!event.origin.startsWith(BASE_FINCH_CONNECT_URI))
+                return;
+            close();
+            switch (event.data.kind) {
+                case 'closed':
+                    combinedOptions.onClose();
+                    break;
+                case 'error':
+                    combinedOptions.onError({ errorMessage: event.data.error });
+                    break;
+                case 'success':
+                    combinedOptions.onSuccess({
+                        code: event.data.code,
+                        state: event.data.state,
+                    });
+                    break;
+                default: {
+                    // This case should never happen, if it does it should be reported to us
+                    combinedOptions.onError({
+                        errorMessage: `Report to developers@tryfinch.com: unable to handle window.postMessage for:  ${JSON.stringify(event.data)}`,
+                    });
+                }
+            }
+        }
+        window.addEventListener('message', handleFinchAuth);
+        return () => window.removeEventListener('message', handleFinchAuth);
+    }, [combinedOptions.onClose, combinedOptions.onError, combinedOptions.onSuccess]);
+    return {
+        open,
     };
-  }, [onClose, onError, onSuccess]);
-  return {
-    open: open
-  };
 };
 
 exports.useFinchConnect = useFinchConnect;