@pinwheel/react-native-pinwheel 3.0.5 → 3.2.0-rc.0

package/src/Pinwheel.tsx

@@ -0,0 +1,80 @@
+import React, { useEffect, useCallback } from 'react';
+import { SafeAreaView } from 'react-native';
+import RTNPinwheel from './RTNPinwheelNativeComponent';
+import { PinwheelEvents } from './PinwheelEvents';
+import { LinkOptions } from './client-events/client';
+
+const Pinwheel = ({
+  linkToken,
+  onLogin,
+  onLoginAttempt,
+  onSuccess,
+  onError,
+  onExit,
+  onEvent,
+}: LinkOptions) => {
+  const eventsListener = useCallback(
+    (event: any) => {
+      if (!event) {
+        return;
+      }
+
+      const { name, payload } = event;
+      if (!name) {
+        return;
+      }
+
+      // Our Android SDK, since the beginning, has been firing events with upper case.
+      // Since we are now wrapping the Android SDK to create the RN SDK, we need to reconcile
+      // the event names here.
+      const normalizedName = name.toLowerCase();
+      onEvent && onEvent(normalizedName, payload);
+
+      switch (normalizedName) {
+        case 'exit':
+          // console.log(`case: exit, onExit: ${onExit}`);
+          onExit && onExit(payload);
+          break;
+        case 'success':
+          // console.log(`case: success, onSuccess: ${onSuccess}`);
+          onSuccess && onSuccess(payload);
+          break;
+        case 'login':
+          // console.log(`case: login, onLogin: ${onLogin}`);
+          onLogin && onLogin(payload);
+          break;
+        case 'login_attempt':
+          // console.log(`case: login_attempt, onLoginAttempt: ${onLoginAttempt}`);
+          onLoginAttempt && onLoginAttempt(payload);
+          break;
+        case 'error':
+          // console.log(`case: error, onError: ${onError}`);
+          onError && onError(payload);
+          break;
+        default:
+      }
+    },
+    [onError, onEvent, onExit, onLogin, onLoginAttempt, onSuccess]
+  );
+
+  useEffect(() => {
+    const listener = PinwheelEvents.addListener(eventsListener);
+
+    return () => {
+      listener.remove();
+    };
+  }, [eventsListener]);
+
+  return (
+    <SafeAreaView style={{ width: '100%', height: '100%' }}>
+      {linkToken && (
+        <RTNPinwheel
+          style={{ width: '100%', height: '100%' }}
+          token={linkToken}
+        />
+      )}
+    </SafeAreaView>
+  );
+};
+
+export default Pinwheel;

package/src/PinwheelEvents.ts

@@ -0,0 +1,23 @@
+import {EmitterSubscription, Platform} from 'react-native';
+import {
+  addListener,
+  removeAllListeners,
+} from './NativePinwheelEvents';
+
+
+export const PinwheelEvents = {
+  addListener(callback: (events: any) => void): EmitterSubscription {
+    return addListener(callback);
+  },
+
+  /**
+   * (iOS and Android Only)
+   * Removes all previously registered listeners and turns off notifications on the native side.
+   * ```javascript
+   * Clipboard.removeAllListeners();
+   * ```
+   */
+  removeAllListeners() {
+    removeAllListeners();
+  },
+};

package/src/RTNPinwheelNativeComponent.ts

@@ -0,0 +1,15 @@
+import type { ViewProps } from "react-native";
+import type { HostComponent } from "react-native";
+import codegenNativeComponent from "react-native/Libraries/Utilities/codegenNativeComponent";
+
+type Event = {
+    name: string;
+}
+
+export interface NativeProps extends ViewProps {
+    token: string;
+}
+
+export default codegenNativeComponent<NativeProps>(
+  "RTNPinwheel"
+) as HostComponent<NativeProps>;

package/src/client-events/client.ts

@@ -0,0 +1,17 @@
+import type {
+  LoginEventPayload,
+  SuccessEventPayload,
+  EventHandler,
+  ErrorEventPayload,
+  LoginAttemptEventPayload
+} from './registry/v3'
+
+export type LinkOptions = {
+  linkToken: string
+  onLogin?: (payload: LoginEventPayload) => void
+  onLoginAttempt?: (payload: LoginAttemptEventPayload) => void
+  onSuccess?: (payload: SuccessEventPayload) => void
+  onError?: (error: ErrorEventPayload) => void
+  onExit?: (error?: ErrorEventPayload) => void
+  onEvent?: EventHandler
+}

package/src/client-events/registry/v2.3.ts

@@ -0,0 +1,166 @@
+/* eslint-disable @typescript-eslint/ban-types */
+import type { AdditionsType, ModificationsType, RemovalsType } from '../utils'
+
+export type PinwheelErrorType =
+  | 'sandboxError'
+  | 'clientError'
+  | 'systemError'
+  | 'userActionRequired'
+  | 'platformError'
+  | 'invalidAccountsConfiguration'
+  | 'invalidUserInput'
+  | 'invalidLinkToken'
+  | 'networkError'
+
+export type LinkApiJob = 'login' | 'direct_deposit_switch' | 'card_switch'
+
+export type OpenEventPayload = {}
+
+export type SelectEmployerEventPayload = {
+  selectedEmployerId: string
+  selectedEmployerName: string
+}
+
+export type SelectPlatformEventPayload = {
+  selectedPlatformId: string
+  selectedPlatformName: string
+}
+
+export type IncorrectPlatformGivenEventPayload = {}
+
+export type LoginAttemptEventPayload = {
+  platformId: string
+}
+
+export type LoginEventPayload = {
+  accountId: string
+  platformId: string
+}
+
+export type InputAmountEventPayload = {
+  value: number
+  unit: '$' | '%'
+}
+
+type _PartialSwitch<T> = { action: 'partial_switch'; allocation: T }
+type InputAllocationPercentage = _PartialSwitch<{
+  type: 'percentage'
+  value: number
+}>
+type InputAllocationAmount = _PartialSwitch<{
+  type: 'amount'
+  value: number
+}>
+type InputAllocationRemainder = _PartialSwitch<{
+  type: 'remainder'
+}>
+export type InputAllocationEventPayload =
+  | { action: 'full_switch' }
+  | InputAllocationRemainder
+  | InputAllocationAmount
+  | InputAllocationPercentage
+
+/**
+ * @deprecated - Use `InputAllocationEventPayload` instead.
+ */
+export type InputAllocation = InputAllocationEventPayload
+
+export type CardSwitchBeginEventPayload = {}
+
+export type DocUploadsBeginEventPayload = {
+  uploadedDocumentsSubmittedCount?: number
+}
+
+export type DocUploadsSubmittedEventPayload = {
+  uploadedDocumentSubmittedCount: number
+}
+
+export type DdFormBeginEventPayload = {}
+
+export type DdFormCreateEventPayload = {
+  url: string
+}
+
+export type DdFormDownloadEventPayload = {}
+
+export type ScreenTransitionEventPayload = {
+  screenName: string
+  selectedEmployerId?: string
+  selectedEmployerName?: string
+  selectedPlatformId?: string
+  selectedPlatformName?: string
+}
+
+/**
+ * @deprecated - Use `ScreenTransitionEventPayload` instead.
+ */
+export type ScreenTransition = ScreenTransitionEventPayload
+
+export type ExitEventPayload = Record<string, never>
+
+export type SuccessEventPayload = {
+  accountId: string
+  platformId: string
+  job: LinkApiJob
+  params?: {
+    amount?: { value: number; unit: '%' | '$' }
+  }
+}
+
+export type ErrorEventPayload = {
+  type: PinwheelErrorType
+  code: string
+  message: string
+  pendingRetry: boolean
+}
+
+export type OtherEventPayload = {
+  name: string;
+  payload: {
+    key: string;
+    value: string;
+    type: 'string' | 'boolean' | 'number';
+  }[];
+};
+
+/**
+ * @deprecated - Use `ErrorEventPayload` instead.
+ */
+export type PinwheelError = ErrorEventPayload
+
+type EventPayloadAdditions = {
+  open: OpenEventPayload
+  select_employer: SelectEmployerEventPayload
+  select_platform: SelectPlatformEventPayload
+  incorrect_platform_given: IncorrectPlatformGivenEventPayload
+  login_attempt: LoginAttemptEventPayload
+  login: LoginEventPayload
+  input_amount: InputAmountEventPayload
+  input_allocation: InputAllocationEventPayload
+  card_switch_begin: CardSwitchBeginEventPayload
+  doc_uploads_begin: DocUploadsBeginEventPayload
+  doc_uploads_submitted: DocUploadsSubmittedEventPayload
+  dd_form_begin: DdFormBeginEventPayload
+  dd_form_create: DdFormCreateEventPayload
+  dd_form_download: DdFormDownloadEventPayload
+  screen_transition: ScreenTransitionEventPayload
+  exit: ErrorEventPayload | ExitEventPayload
+  other_event: OtherEventPayload;
+  success: SuccessEventPayload
+  error: ErrorEventPayload
+}
+
+type EventPayloadModifications = {}
+
+type EventPayloadRemovals = []
+
+export type EventPayloadMap = Omit<
+  AdditionsType<EventPayloadAdditions> &
+    ModificationsType<EventPayloadModifications>,
+  keyof RemovalsType<EventPayloadRemovals>
+>
+
+export type EventHandler = <T extends keyof EventPayloadMap>(
+  eventName: T,
+  payload: EventPayloadMap[T]
+) => void

package/src/client-events/registry/v3.ts

@@ -0,0 +1,47 @@
+/* eslint-disable camelcase */
+/* eslint-disable @typescript-eslint/ban-types */
+import type { AdditionsType, ModificationsType, RemovalsType } from '../utils'
+import type { EventPayloadMap as EventPayloadMapV2, LinkApiJob } from './v2.3'
+
+import { InputAllocationEventPayload as InputAllocationEventPayload2_3 } from './v2.3'
+
+/*
+ * Export all the types from V3 and we override whatever changes
+ */
+export * from './v2.3'
+
+export type SuccessEventPayload = {
+  accountId: string
+  platformId: string
+  job: LinkApiJob
+  params?: InputAllocationEventPayload
+}
+
+export type InputAllocationEventPayload =
+  | { action: null; allocation: null }
+  | InputAllocationEventPayload2_3
+
+/**
+ * @deprecated - Use `InputAllocationEventPayload` instead.
+ */
+export type InputAllocation = InputAllocationEventPayload
+
+type EventPayloadAdditions = {}
+
+type EventPayloadModifications = {
+  input_allocation: InputAllocationEventPayload
+}
+
+type EventPayloadRemovals = ['input_amount']
+
+export type EventPayloadMap = Omit<
+  EventPayloadMapV2 &
+    AdditionsType<EventPayloadAdditions> &
+    ModificationsType<EventPayloadModifications>,
+  keyof RemovalsType<EventPayloadRemovals>
+>
+
+export type EventHandler = <T extends keyof EventPayloadMap>(
+  eventName: T,
+  payload: EventPayloadMap[T]
+) => void

package/src/client-events/utils.ts

@@ -0,0 +1,12 @@
+// Generic types for additions, modifications, and removals
+export type AdditionsType<Additions> = {
+  [Event in keyof Additions]: Additions[Event]
+}
+
+export type ModificationsType<Modifications> = {
+  [Event in keyof Modifications]: Modifications[Event]
+}
+
+export type RemovalsType<Removals extends string[]> = {
+  [Event in Removals[number]]: never
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+import Pinwheel from "./Pinwheel";
+
+export default Pinwheel;

package/.vscode/settings.json

@@ -1,4 +0,0 @@
-{
-    "java.compile.nullAnalysis.mode": "automatic",
-    "java.configuration.updateBuildConfiguration": "interactive"
-}

package/CHANGELOG.md

@@ -1,152 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-# 3.0.x Releases
-
-- `3.0.x` Releases - [3.0.0](#300) | [3.0.1](#301) | [3.0.2](#302) | [3.0.3](#303) | [3.0.4](#304) | [3.0.5](#305)
-
----
-
-### [3.0.5](https://www.npmjs.com/package/@pinwheel/react-native-pinwheel/v/3.0.5)
-
-Expand internal functionality to support a broader range of platforms and increase conversion rate. Export `OtherEventPayload` event payload type for the `other_event` event.
-
-### [3.0.4](https://www.npmjs.com/package/@pinwheel/react-native-pinwheel/v/3.0.4)
-
-####
-Bugfix: Normalize event names to lower case. Event names began firing as uppercase in versions 3.0.0 and 2.5.0.
-
-### [3.0.3](https://www.npmjs.com/package/@pinwheel/react-native-pinwheel/v/3.0.3)
-
-Changed Minimum Android SDK requirements to 22
-
-### [3.0.2](https://www.npmjs.com/package/@pinwheel/react-native-pinwheel/v/3.0.2)
-
-Changed example app Minimum Android SDK requirements to 22
-
-### [3.0.1](https://www.npmjs.com/package/@pinwheel/react-native-pinwheel/v/3.0.1)
-
-Expand internal functionality to support a broader range of platforms and increase conversion rate.
-
-### [3.0.0](https://www.npmjs.com/package/@pinwheel/react-native-pinwheel/v/3.0.0)
-
-This new major version bump introduces an updated API to support partner-based switches.
-
-#### Changed
-- The `action` field in `input_allocation` event is now optional.
-- The `params` field in the `success` event uses the `input_allocation` schema with fields `action` and `allocation`.
-
-#### Removed
-- Removed `LinkResult` type export. This was the old `success` event payload. The new payload has the same format as the newly exported `SuccessEventPayload`.
-- Removed `EventPayload` type export. The event handler function will now be implicitly typed.
-- Removed `ScreenTransition` type export. Use `ScreenTransitionEventPayload` instead.
-- Removed `EmptyPayloadObject` type export.
-- Removed `Error` type export. Use `ErrorEventPayload` instead. (`Error` was marked as deprecated in version 2.)
-- Removed `ErrorType` type export. Use `PinwheelErrorType` instead. (`ErrorType` was marked as deprecated in version 2.)
-- Removed `input_amount` event. Use `input_allocation` even instead.
-- Removed `PINWHEEL_MESSAGE_TYPES`.
-
-## 2.5.x Releases
-
-[2.5.0](#250) | [2.5.1](#251) | [2.5.2](#252) | [2.5.3](#253) | [2.5.4](#254)
-
----
-### [2.5.4](https://www.npmjs.com/package/@pinwheel/react-native-pinwheel/v/2.5.4)
-
-#### Bugfix
-Normalize event names to lower case. Event names began firing as uppercase in versions 3.0.0 and 2.5.0.
-
-### [2.5.3](https://www.npmjs.com/package/@pinwheel/react-native-pinwheel/v/2.5.3)
-
-#### Notes
-
-Changed Minimum Android SDK requirements to 22
-
-### [2.5.2](https://www.npmjs.com/package/@pinwheel/react-native-pinwheel/v/2.5.2)
-
-#### Notes
-
-Expand internal functionality to support a broader range of platforms and increase conversion rate.
-
-### 2.5.1
-
-#### Notes
-
-- Internal contract changes
-
-### 2.5.0
-
-#### Notes
-
-We're thrilled to announce the latest version of our SDK! While you'll find that our familiar API contract remains unchanged, there's a host of improvements that make this upgrade indispensable:
-
-- **Enhanced Redundancy**: 🛡️ We've fortified our systems, ensuring smoother recovery from integration failures for a significant percentage of our traffic.
-- **Superior Uptime**: 🦾 Reliability is a top priority. This upgrade brings even more robust uptime for DDS integrations.
-- **Increased Conversion**: ↗️ We are leveraging system level features to increase conversion.
-- **Easy Upgrade**: 🥧 No changes were made to the API contract. Easy as pie.
-
-## 2.4.x Releases
-
-[2.4.0](#240)
-
----
-
-### 2.4.0
-
-- Removing `overrides` from main package.
-- Updating example app to use newest ReactNative versions.
-- Changing devDependencies to use newest React Native Webview (for typing).
-
-## 2.3.x Releases
-
-[2.3.4](#234) | [2.3.5](#235) | [2.3.6](#236) | [2.3.10](#2310) | [2.3.12](#2312) | [2.3.13](#2313) | [2.3.14](#2314) | [2.3.17](#2317)
-
----
-
-### 2.3.17
-
-Export `ScreenTransition` event payload type for the `screen_transition` event.
-
-
-### 2.3.14
-
-Remove `hermes-engine` and `shell-quote` sub-dependencies from package-lock files.
-
-### 2.3.13
-
-Bump `hermes-engine` and `shell-quote` sub-dependency package.
-
-### 2.3.12
-
-Add CircleCI scripting and local scripts.
-- Add `npm run dev` script.
-- Remove need for hardcoding api secret in code to run locally.
-
-### 2.3.10
-
-Use node 16.7.0 instead of 12.16.1 to install dependencies.
-
-### [2.3.6](https://www.npmjs.com/package/@pinwheel/react-native-pinwheel/v/2.3.6)
-
-N/A
-
-### [2.3.5](https://www.npmjs.com/package/@pinwheel/react-native-pinwheel/v/2.3.5)
-
-N/A
-
-### [2.3.4](https://www.npmjs.com/package/@pinwheel/react-native-pinwheel/v/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/android/src/main/AndroidManifest.xml

@@ -1,6 +0,0 @@
-
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-          package="com.underdog_tech.react">
-
-</manifest>
-

package/android/src/main/java/com/underdog_tech/react/RNTPinwheelEvents.kt

@@ -1,51 +0,0 @@
-package com.underdog_tech.react
-
-import com.facebook.react.bridge.Arguments
-import com.facebook.react.bridge.ReactApplicationContext
-import com.facebook.react.bridge.ReactContextBaseJavaModule
-import com.facebook.react.bridge.ReactMethod
-import com.facebook.react.bridge.WritableMap
-import com.facebook.react.modules.core.DeviceEventManagerModule
-
-class RNTPinwheelEvents(reactContext: ReactApplicationContext) : ReactContextBaseJavaModule(reactContext) {
-    companion object {
-        private const val EVENT_KEY = "PINWHEEL_EVENT"
-    }
-
-    override fun getName(): String {
-        return "RNTPinwheelEvents"
-    }
-
-    @ReactMethod
-    fun anExposedMethod() {
-        val currentContext = reactApplicationContext
-        val eventName = "PINWHEEL_EVENT"
-        val params: WritableMap = Arguments.createMap().apply {
-            putString("type", "myEventType")
-        }
-        sendEvent(currentContext, eventName, params)
-    }
-
-    fun sendEvent(reactContext: ReactApplicationContext, eventName: String, params: WritableMap?) {
-        reactContext.getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter::class.java).emit(eventName, params)
-    }
-
-    private var listenerCount = 0
-
-    @ReactMethod
-    fun addListener(eventName: String) {
-      if (listenerCount == 0) {
-        // Set up any upstream listeners or background tasks as necessary
-      }
-
-      listenerCount += 1
-    }
-
-    @ReactMethod
-    fun removeListeners(count: Int) {
-      listenerCount -= count
-      if (listenerCount == 0) {
-        // Remove upstream listeners, stop unnecessary background tasks
-      }
-    }
-}

package/dist/client-events/client.d.ts

@@ -1,10 +0,0 @@
-import type { LoginEventPayload, SuccessEventPayload, EventHandler, ErrorEventPayload, LoginAttemptEventPayload } from './registry/v3';
-export type LinkOptions = {
-    linkToken: string;
-    onLogin?: (payload: LoginEventPayload) => void;
-    onLoginAttempt?: (payload: LoginAttemptEventPayload) => void;
-    onSuccess?: (payload: SuccessEventPayload) => void;
-    onError?: (error: ErrorEventPayload) => void;
-    onExit?: (error?: ErrorEventPayload) => void;
-    onEvent?: EventHandler;
-};

package/dist/client-events/client.js

@@ -1 +0,0 @@
-export {};