@pinwheel/react-native-pinwheel 2.3.0 → 2.3.4

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+## 2.3.x Releases
+
+- `2.3.x` Releases - [2.3.4](#234)
+
+---
+
+### 2.3.4
+
+#### Added
+
+- Export `EventPayload` type.
+- Export `PinwheelError` type.
+- Export `PinwheelErrorType` type.
+- Export `EmptyPayloadObject` type as `Record<string, never>`.
+
+##### Updated
+
+- `EventPayload` is no longer a union containing `{}`. It now contains `Record<string, never>` instead due to [this behavior](https://github.com/Microsoft/TypeScript/wiki/FAQ#why-are-all-types-assignable-to-empty-interfaces).
+- Mark exported `Error` type as **@deprecated** because it collides with the built-in javascript `Error` object. Replaced with `PinwheelError`.
+- Mark exported `ErrorType` type as **@deprecated** because the new naming convention is prefixing with "`PinwheelError`". Replaced with `PinwheelErrorType`.
+- Update `onExit` type to be `(error: PinwheelError | Record<string, never>)` to be accurate with current functionality.

package/lib/index.d.ts

@@ -0,0 +1,66 @@
+/// <reference types="react" />
+export declare const PINWHEEL_MESSAGE_TYPES: {
+    PINWHEEL_EXIT: string;
+    PINWHEEL_MODAL_CLOSE: string;
+    PINWHEEL_LOAD_COMPLETE: string;
+    PINWHEEL_SUCCESS: string;
+    PINWHEEL_EVENT: string;
+};
+export declare type LinkResult = {
+    accountId: string;
+    platformId: string;
+    job: string;
+    params: {
+        amount?: {
+            value: number;
+            unit: '%' | '$';
+        };
+    };
+};
+/**
+ * @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;
+/**
+ * @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 = {
+    type: PinwheelErrorType;
+    code: string;
+    message: string;
+    pendingRetry: boolean;
+};
+export declare type PinwheelError = Error;
+export declare type EmptyPayloadObject = Record<string, never>;
+export declare type EventPayload = {
+    selectedEmployerId: string;
+    selectedEmployerName: string;
+} | {
+    selectedPlatformId: string;
+    selectedPlatformName: string;
+} | {
+    value: number;
+    unit: '%' | '$';
+} | LinkResult | {
+    accountId: string;
+    platformId: string;
+} | PinwheelError | EmptyPayloadObject | undefined;
+declare type PinwheelProps = {
+    linkToken: string;
+    onLogin?: (result: {
+        accountId: string;
+        platformId: string;
+    }) => void;
+    onLoginAttempt?: (result: {
+        platformId: string;
+    }) => void;
+    onSuccess?: (result: LinkResult) => void;
+    onError?: (error: PinwheelError) => void;
+    onExit?: (error: PinwheelError | EmptyPayloadObject) => void;
+    onEvent?: (eventName: string, payload: EventPayload) => void;
+};
+declare const _default: ({ linkToken, onLogin, onLoginAttempt, onSuccess, onError, onExit, onEvent }: PinwheelProps) => JSX.Element;
+export default _default;

package/lib/index.js

@@ -0,0 +1,124 @@
+import React from 'react';
+import { WebView } from 'react-native-webview';
+import { Linking, Platform, SafeAreaView, StyleSheet } from 'react-native';
+const version = '2.3.4';
+const styles = StyleSheet.create({
+    container: {
+        flex: 1,
+    },
+});
+export const PINWHEEL_MESSAGE_TYPES = {
+    PINWHEEL_EXIT: 'PINWHEEL_EXIT',
+    PINWHEEL_MODAL_CLOSE: 'PINWHEEL_MODAL_CLOSE',
+    PINWHEEL_LOAD_COMPLETE: 'PINWHEEL_LOAD_COMPLETE',
+    PINWHEEL_SUCCESS: 'PINWHEEL_SUCCESS',
+    PINWHEEL_EVENT: 'PINWHEEL_EVENT',
+};
+const LINK_PAGE_URL = 'https://cdn.getpinwheel.com/link-v2.3.0.html';
+const PINWHEEL_DOMAIN = 'getpinwheel.com';
+export default ({ linkToken, onLogin, onLoginAttempt, onSuccess, onError, onExit, onEvent }) => {
+    const handleEvent = (event) => {
+        if (!event) {
+            // first event is always an empty string
+            return;
+        }
+        let eventData;
+        try {
+            eventData = JSON.parse(event.nativeEvent.data);
+        }
+        catch (_error) {
+            let error = _error;
+            console.error(error);
+            onExit && onExit(error);
+            onError && onError(error);
+            onEvent && onEvent('error', error);
+            return;
+        }
+        const { type, eventName, payload } = eventData;
+        if (type === 'PINWHEEL_EVENT') {
+            onEvent && onEvent(eventName, payload);
+            switch (eventName) {
+                case 'exit':
+                    onExit && onExit(payload);
+                    break;
+                case 'success':
+                    onSuccess && onSuccess(payload);
+                    break;
+                case 'login':
+                    onLogin && onLogin(payload);
+                    break;
+                case 'login_attempt':
+                    onLoginAttempt && onLoginAttempt(payload);
+                    break;
+                case 'error':
+                    onError && onError(payload);
+                    break;
+                default:
+            }
+        }
+    };
+    const now = Date.now();
+    const [major, minor, patch] = version.split('.').map(x => Number(x));
+    const runFirst = `
+      const uuidKey = 'pinwheel-uuid';
+      const localStorage = window.localStorage;
+      let uuid = localStorage.getItem(uuidKey);
+      if(!uuid) {
+        uuid = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
+          var r = Math.random() * 16 | 0, v = c == 'x' ? r : (r & 0x3 | 0x8);
+          return v.toString(16);
+        });
+        localStorage.setItem(uuidKey, uuid);
+      }
+      try {
+        window.addEventListener('message', event => {
+          window.ReactNativeWebView.postMessage(JSON.stringify(event.data))
+        });
+        window.postMessage(
+          { 
+            type: 'PINWHEEL_INIT', 
+            payload: { 
+              platform: "${Platform.OS}",
+              sdk: 'react native',
+              version: {
+                major: ${major},
+                minor: ${minor},
+                patch: ${patch}
+              },
+              initializationOptions: {
+                hasOnSuccess: ${!!onSuccess},
+                hasOnEvent: ${!!onEvent},
+                hasOnExit: ${!!onExit},
+                hasOnError: ${!!onError},
+                hasOnLogin: ${!!onLogin},
+              },
+              linkToken: '${linkToken}', 
+              uniqueUserId: uuid,
+              initializationTimestamp: ${now}
+            } 
+          }
+        );
+      } catch (err) {
+        console.error(err);
+      }
+      true;
+    `;
+    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;
+    }}/>
+    </SafeAreaView>);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pinwheel/react-native-pinwheel",
-  "version": "2.3.0",
+  "version": "2.3.4",
   "type": "module",
   "description": "Pinwheel React Native SDK",
   "main": "lib/index.js",

package/lib/package.json

@@ -1,26 +0,0 @@
-{
-    "name": "@pinwheel/react-native-pinwheel",
-    "version": "2.0.5",
-    "type": "module",
-    "description": "Pinwheel React Native SDK",
-    "main": "lib/src/index.js",
-    "types": "lib/src/index.d.ts",
-    "files": [
-        "lib/**/*"
-    ],
-    "scripts": {
-        "build": "tsc"
-    },
-    "author": "Pinwheel",
-    "license": "MIT",
-    "peerDependencies": {
-        "react": "16.13.1",
-        "react-native": "0.63.3",
-        "react-native-webview": "^10.10.0"
-    },
-    "devDependencies": {
-        "@types/react-native": "^0.63.29",
-        "react-native-webview": "^10.9.2",
-        "typescript": "^4.0.3"
-    }
-}