@pinwheel/react-native-pinwheel 2.3.16 → 2.4.0

package/README.md

@@ -12,11 +12,26 @@ You may want to run the example app locally to get started.
 - iPhone 14 simulator (open your Simulator app and check the available versions)
 - iOS 16 running on the simulator (open your Simulator app and check the available versions)
 - `pod` version 1.11.3 (check with `pod --version`)
+- Add your pinwheel secret to `example/env.js` (create this file) with `export default "<YOUR PINWHEEL SECRET>"`.
 
 #### Directions
 
 - `npm run dev`
 
+#### Troubleshooting
+
+###### An error was encountered processing the command (domain=com.apple.CoreSimulator.SimError, code=405)
+- Click Apple > About This Mac > Storage > Manage > Developer
+- Delete Xcode cache
+- Delete Project Build and indexes
+
+###### Failed to build iOS project. We ran "xcodebuild" command but it exited with error code 65
+- Try downloading Xcode 14.2 from https://developer.apple.com/download/all/?q=xcode
+
+###### Failed to locate 'git', requesting installation of command line developer tools
+For this or other errors related to command line developer tools:
+- Make sure you have Command Line Tools for Xcode 14.2 installed
+- Open Xcode > Click Xcode in the app menu > Settings > Locations > Command Line Tools dropdown and set the correct location 
 
 ## Installation
 
@@ -64,7 +79,7 @@ With the PinwheelLink component, end-users can select their employer, authentica
 
 ### `linkToken`
 
-The link token retrieved using the [create link token endpoint](https://docs.getpinwheel.com/docs/api/docs/guides/Link.md#link-token).
+The link token retrieved using the [create link token endpoint](https://docs.pinwheelapi.com/reference/post_v1_link_tokens___post).
 
 | Type   | Required |
 | ------ | -------- |
@@ -80,7 +95,7 @@ Callback when a user successfully signs in to their payroll account.
 
 ### `onError`
 
-Callback whenever an error occurs during the modal flow. This does not necessarily mean that the flow cannot still complete successfully. These include such retryable events as the user inputting an incorrect password or MFA code and needs to reattempt it. Error codes can be seen [here](https://docs.getpinwheel.com/docs/api/docs/guides/Link.md#errors-1).
+Callback whenever an error occurs during the modal flow. This does not necessarily mean that the flow cannot still complete successfully. These include such retryable events as the user inputting an incorrect password or MFA code and needs to reattempt it. Error codes can be seen [here](https://docs.pinwheelapi.com/docs/link-sdk-errors).
 
 | Type     | Required |
 | -------- | -------- |
@@ -96,7 +111,7 @@ Callback whenever a user completes a modal flow successfully. Note: This is simp
 
 ### `onExit`
 
-Callback whenever a user exits the modal either explicitly or if an error occurred that crashed the modal. Error codes can be seen [here](https://docs.getpinwheel.com/docs/api/docs/guides/Link.md#errors-1). Will pass back an error result if the modal either crashed due to an error or if the user exited while in an error state (e.g. invalid credentials).
+Callback whenever a user exits the modal either explicitly or if an error occurred that crashed the modal. Error codes can be seen [here](https://docs.pinwheelapi.com/docs/link-sdk-errors). Will pass back an error result if the modal either crashed due to an error or if the user exited while in an error state (e.g. invalid credentials).
 
 | Type     | Required |
 | -------- | -------- |
@@ -104,7 +119,7 @@ Callback whenever a user exits the modal either explicitly or if an error occurr
 
 ### `onEvent`
 
-Callback for all significant events that happen during the modal flow. See all possible [event types](https://docs.getpinwheel.com/docs/api/docs/guides/Link.md#events).
+Callback for all significant events that happen during the modal flow. See all possible [event types](https://docs.pinwheelapi.com/docs/link-1#link-events).
 
 | Type     | Required |
 | -------- | -------- |

package/lib/constants.d.ts

@@ -1,6 +1,6 @@
 /**
  * Importing package.json here causes a problem with the folder structure when we npm pack and publish.
  */
-export declare const VERSION = "2.3.14";
+export declare const VERSION = "2.3.18";
 export declare const LINK_PAGE_URL = "https://cdn.getpinwheel.com/link-v2.3.0.html";
 export declare const PINWHEEL_DOMAIN = "getpinwheel.com";

package/lib/constants.js

@@ -1,6 +1,6 @@
 /**
  * Importing package.json here causes a problem with the folder structure when we npm pack and publish.
  */
-export const VERSION = '2.3.14';
+export const VERSION = '2.3.18';
 export const LINK_PAGE_URL = 'https://cdn.getpinwheel.com/link-v2.3.0.html';
 export const PINWHEEL_DOMAIN = 'getpinwheel.com';

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="react" />
+import React from 'react';
 export declare const PINWHEEL_MESSAGE_TYPES: {
     PINWHEEL_EXIT: string;
     PINWHEEL_MODAL_CLOSE: string;
@@ -6,7 +6,7 @@ export declare const PINWHEEL_MESSAGE_TYPES: {
     PINWHEEL_SUCCESS: string;
     PINWHEEL_EVENT: string;
 };
-export declare type LinkResult = {
+export type LinkResult = {
     accountId: string;
     platformId: string;
     job: string;
@@ -17,25 +17,32 @@ export declare type LinkResult = {
         };
     };
 };
+export type ScreenTransition = {
+    screenName: string;
+    selectedEmployerId?: string;
+    selectedEmployerName?: string;
+    selectedPlatformId?: string;
+    selectedPlatformName?: string;
+};
 /**
  * @deprecated This type will be removed in version 2.4. Use the renamed type `PinwheelErrorType`
  * instead.
  */
-export declare type ErrorType = 'clientError' | 'systemError' | 'userActionRequired' | 'platformError' | 'invalidAccountsConfiguration' | 'invalidUserInput' | 'invalidLinkToken';
-export declare type PinwheelErrorType = ErrorType;
+export type ErrorType = 'clientError' | 'systemError' | 'userActionRequired' | 'platformError' | 'invalidAccountsConfiguration' | 'invalidUserInput' | 'invalidLinkToken';
+export type PinwheelErrorType = ErrorType;
 /**
  * @deprecated The type should not be used as it clashes with the native JS `Error` object.
  * You should use `PinwheelError` instead. `Error` will be removed in version 2.4
  */
-export declare type Error = {
+export type Error = {
     type: PinwheelErrorType;
     code: string;
     message: string;
     pendingRetry: boolean;
 };
-export declare type PinwheelError = Error;
-export declare type EmptyPayloadObject = Record<string, never>;
-export declare type EventPayload = {
+export type PinwheelError = Error;
+export type EmptyPayloadObject = Record<string, never>;
+export type EventPayload = {
     selectedEmployerId: string;
     selectedEmployerName: string;
 } | {
@@ -47,8 +54,8 @@ export declare type EventPayload = {
 } | LinkResult | {
     accountId: string;
     platformId: string;
-} | PinwheelError | EmptyPayloadObject | undefined;
-declare type PinwheelProps = {
+} | ScreenTransition | PinwheelError | EmptyPayloadObject | undefined;
+type PinwheelProps = {
     linkToken: string;
     onLogin?: (result: {
         accountId: string;
@@ -62,5 +69,5 @@ declare type PinwheelProps = {
     onExit?: (error: PinwheelError | EmptyPayloadObject) => void;
     onEvent?: (eventName: string, payload: EventPayload) => void;
 };
-declare const _default: ({ linkToken, onLogin, onLoginAttempt, onSuccess, onError, onExit, onEvent }: PinwheelProps) => JSX.Element;
+declare const _default: ({ linkToken, onLogin, onLoginAttempt, onSuccess, onError, onExit, onEvent }: PinwheelProps) => React.JSX.Element;
 export default _default;

package/lib/index.js

@@ -103,20 +103,20 @@ export default ({ linkToken, onLogin, onLoginAttempt, onSuccess, onError, onExit
     `;
     return (<SafeAreaView style={styles.container}>
       <WebView source={{ uri: LINK_PAGE_URL }} onMessage={handleEvent} injectedJavaScript={runFirst} onShouldStartLoadWithRequest={(request) => {
-        const targetURL = request.url;
-        const isLinkPage = targetURL.includes(PINWHEEL_DOMAIN);
-        if (!isLinkPage) {
-            Linking.canOpenURL(targetURL).then(supported => {
-                if (supported) {
-                    Linking.openURL(targetURL).then(() => { });
-                }
-                else {
-                    console.warn('Don\'t know how to open URL: ' + targetURL);
-                }
-                return false;
-            }).catch(err => console.error('An error occurred ', err));
-        }
-        return isLinkPage;
-    }}/>
+            const targetURL = request.url;
+            const isLinkPage = targetURL.includes(PINWHEEL_DOMAIN);
+            if (!isLinkPage) {
+                Linking.canOpenURL(targetURL).then(supported => {
+                    if (supported) {
+                        Linking.openURL(targetURL).then(() => { });
+                    }
+                    else {
+                        console.warn('Don\'t know how to open URL: ' + targetURL);
+                    }
+                    return false;
+                }).catch(err => console.error('An error occurred ', err));
+            }
+            return isLinkPage;
+        }}/>
     </SafeAreaView>);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pinwheel/react-native-pinwheel",
-  "version": "2.3.16",
+  "version": "2.4.0",
   "type": "module",
   "description": "Pinwheel React Native SDK",
   "main": "lib/index.js",
@@ -18,19 +18,11 @@
   "peerDependencies": {
     "react": "^16.13.1 || ^17 || ^18",
     "react-native": "*",
-    "react-native-webview": "^10.10.0 || ^11.0.0"
+    "react-native-webview": "*"
   },
   "devDependencies": {
-    "@types/react-native": "^0.63.29",
-    "react-native-webview": "^11.0.0",
+    "@types/react-native": "^0.72.2",
+    "react-native-webview": "^13.3.1",
     "typescript": "^4.0.3"
-  },
-  "overrides": {
-    "react-native": {
-      "hermes-engine": "0.11.0"
-    },
-    "@react-native-community/cli-tools": {
-      "shell-quote": "^1.7.4"
-    }
   }
 }