@pinwheel/react-native-pinwheel 2.5.1 → 3.0.0

package/CHANGELOG.md

@@ -2,9 +2,33 @@
 
 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.0](https://github.com/underdog-tech/pinwheel-ios-sdk/releases/tag/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.0](#250) | [2.5.1](#251) 
 
 ---
 ### 2.5.1

package/RNPinwheelSDK.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
     s.name         = "RNPinwheelSDK"
-    s.version      = "2.5.1"
+    s.version      = "3.0.0"
     s.summary      = "React Native plugin for Pinwheel's SDK"
     s.description  = <<-DESC
                      An open source React Native plugin for calling Pinwheel's native SDKs to manage payroll data.
@@ -14,5 +14,5 @@ Pod::Spec.new do |s|
     s.public_header_files = 'ios/**/*.h'
     s.requires_arc = true
     s.dependency "React"
-    s.dependency 'PinwheelSDK', '2.4.5'
+    s.dependency 'PinwheelSDK', '3.0.0'
   end

package/android/build.gradle

@@ -41,7 +41,7 @@ rootProject.allprojects {
     }
 }
 
-def PW_SDK_VERSION = '2.4.5'
+def PW_SDK_VERSION = '3.0.0'
 
 dependencies {
     def pwVersion = rootProject.hasProperty('pwVersion') ? rootProject.pwVersion : PW_SDK_VERSION

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

@@ -19,7 +19,7 @@ import com.underdog_tech.pinwheel_android.PinwheelFragment
 import com.underdog_tech.pinwheel_android.PinwheelEventListener
 import com.underdog_tech.pinwheel_android.model.PinwheelEventType
 import com.underdog_tech.pinwheel_android.model.PinwheelEventPayload
-import com.underdog_tech.pinwheel_android.model.PinwheelAmount
+import com.underdog_tech.pinwheel_android.model.PinwheelInputAllocationPayload
 import com.underdog_tech.pinwheel_android.model.PinwheelTarget
 import com.underdog_tech.pinwheel_android.model.PinwheelAllocation
 import com.underdog_tech.pinwheel_android.model.PinwheelParams
@@ -31,7 +31,6 @@ import com.underdog_tech.pinwheel_android.model.PinwheelLoginPayload
 import com.underdog_tech.pinwheel_android.model.PinwheelLoginAttemptPayload
 import com.underdog_tech.pinwheel_android.model.PinwheelDDFormCreatePayload
 import com.underdog_tech.pinwheel_android.model.PinwheelScreenTransitionPayload
-import com.underdog_tech.pinwheel_android.model.PinwheelInputAmountPayload
 
 fun PinwheelTarget.toWritableMap(): WritableMap {
   return Arguments.createMap().apply {
@@ -50,17 +49,14 @@ fun PinwheelAllocation.toWritableMap(): WritableMap {
 
 fun PinwheelParams.toWritableMap(): WritableMap {
   return Arguments.createMap().apply {
-    putMap("amount", this@toWritableMap.amount?.toWritableMap())
+    putString("action", this@toWritableMap.action)
+    putMap("allocation", this@toWritableMap.allocation?.toWritableMap())
   }
 }
 
 fun PinwheelEventPayload.toWritableMap(): WritableMap = when (this) {
-  is PinwheelAmount -> Arguments.createMap().apply {
-    putDouble("value", this@toWritableMap.value.toDouble())
-    putString("unit", this@toWritableMap.unit)
-  }
 
-  is PinwheelInputAmountPayload -> Arguments.createMap().apply {
+  is PinwheelInputAllocationPayload -> Arguments.createMap().apply {
     putString("action", this@toWritableMap.action)
     putMap("allocation", this@toWritableMap.allocation?.toWritableMap())
   }
@@ -162,7 +158,7 @@ class PinwheelViewManager(
 
 
     this.token?.let {
-      val pinwheelFragment = PinwheelFragment.newInstance(it, "react native", "2.5.1")
+      val pinwheelFragment = PinwheelFragment.newInstance(it, "react native", "3.0.0")
       pinwheelFragment.pinwheelEventListener = this
       val activity = reactContext.currentActivity as FragmentActivity
       activity.supportFragmentManager
@@ -210,4 +206,4 @@ class PinwheelViewManager(
     private const val REACT_CLASS = "RNTPinwheel"
     private const val COMMAND_CREATE = 1
   }
-}
+}}

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

@@ -0,0 +1,10 @@
+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

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

package/dist/client-events/registry/v2.3.d.ts

@@ -0,0 +1,116 @@
+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 = {
+    screen_name: 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;
+};
+/**
+ * @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;
+    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;
+export {};

package/dist/client-events/registry/v2.3.js

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

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

@@ -0,0 +1,25 @@
+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 * 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/dist/client-events/registry/v3.js

@@ -0,0 +1,4 @@
+/*
+ * Export all the types from V3 and we override whatever changes
+ */
+export * from './v2.3';

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

@@ -0,0 +1,9 @@
+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/dist/client-events/utils.js

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

package/{constants.d.ts → dist/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.5.1";
+export declare const VERSION = "3.0.0";
 export declare const LINK_PAGE_URL = "https://cdn.getpinwheel.com/link-v2.3.0.html";
 export declare const PINWHEEL_DOMAIN = "getpinwheel.com";

package/{constants.js → dist/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.5.1';
+export const VERSION = '3.0.0';
 export const LINK_PAGE_URL = 'https://cdn.getpinwheel.com/link-v2.3.0.html';
 export const PINWHEEL_DOMAIN = 'getpinwheel.com';

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+import { LinkOptions } from './client-events/client';
+type PinwheelProps = {} & LinkOptions;
+declare const _default: ({ linkToken, onLogin, onLoginAttempt, onSuccess, onError, onExit, onEvent }: PinwheelProps) => React.JSX.Element;
+export default _default;

package/{index.js → dist/index.js}

@@ -7,13 +7,6 @@ const styles = StyleSheet.create({
         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',
-};
 export default ({ linkToken, onLogin, onLoginAttempt, onSuccess, onError, onExit, onEvent }) => {
     const handleEvent = (event) => {
         if (!event) {

package/ios/RNTPinwheelView.m

@@ -18,7 +18,7 @@
 
 - (void)initPinwheelWrapperVC {
     if (self.token != nil && self.pinwheelWrapperVC == nil) {
-        self.pinwheelWrapperVC = [[PinwheelWrapperVC alloc] initWithToken:self.token delegate:self sdk:@"react native" version: @"2.5.1"];
+        self.pinwheelWrapperVC = [[PinwheelWrapperVC alloc] initWithToken:self.token delegate:self sdk:@"react native" version: @"3.0.0"];
         [self addSubview:self.pinwheelWrapperVC.view];
     }
 }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@pinwheel/react-native-pinwheel",
-  "version": "2.5.1",
+  "version": "3.0.0",
   "type": "module",
   "description": "Pinwheel React Native SDK",
-  "main": "index.js",
-  "types": "index.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
     "bump-pkg-version": "./scripts/bump-pkg-version.sh",
@@ -14,7 +14,8 @@
   "license": "MIT",
   "peerDependencies": {
     "react": "^16.13.1 || ^17 || ^18",
-    "react-native": "*"
+    "react-native": "*",
+    "react-native-webview": "*"
   },
   "devDependencies": {
     "@types/react-native": "^0.72.2",

package/index.d.ts

@@ -1,73 +0,0 @@
-import React from '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 type LinkResult = {
-    accountId: string;
-    platformId: string;
-    job: string;
-    params: {
-        amount?: {
-            value: number;
-            unit: '%' | '$';
-        };
-    };
-};
-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 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 type Error = {
-    type: PinwheelErrorType;
-    code: string;
-    message: string;
-    pendingRetry: boolean;
-};
-export type PinwheelError = Error;
-export type EmptyPayloadObject = Record<string, never>;
-export type EventPayload = {
-    selectedEmployerId: string;
-    selectedEmployerName: string;
-} | {
-    selectedPlatformId: string;
-    selectedPlatformName: string;
-} | {
-    value: number;
-    unit: '%' | '$';
-} | LinkResult | {
-    accountId: string;
-    platformId: string;
-} | ScreenTransition | PinwheelError | EmptyPayloadObject | undefined;
-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) => React.JSX.Element;
-export default _default;