@pinwheel/react-native-pinwheel 2.3.3 → 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

@@ -17,14 +17,25 @@ export declare type LinkResult = {
         };
     };
 };
+/**
+ * @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: ErrorType;
+    type: PinwheelErrorType;
     code: string;
     message: string;
     pendingRetry: boolean;
 };
-declare type EventPayload = {
+export declare type PinwheelError = Error;
+export declare type EmptyPayloadObject = Record<string, never>;
+export declare type EventPayload = {
     selectedEmployerId: string;
     selectedEmployerName: string;
 } | {
@@ -36,7 +47,7 @@ declare type EventPayload = {
 } | LinkResult | {
     accountId: string;
     platformId: string;
-} | Error | {} | undefined;
+} | PinwheelError | EmptyPayloadObject | undefined;
 declare type PinwheelProps = {
     linkToken: string;
     onLogin?: (result: {
@@ -47,8 +58,8 @@ declare type PinwheelProps = {
         platformId: string;
     }) => void;
     onSuccess?: (result: LinkResult) => void;
-    onError?: (error: Error) => void;
-    onExit?: (error?: Error) => 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;

package/lib/index.js

@@ -1,7 +1,7 @@
 import React from 'react';
 import { WebView } from 'react-native-webview';
 import { Linking, Platform, SafeAreaView, StyleSheet } from 'react-native';
-const version = '2.3.3';
+const version = '2.3.4';
 const styles = StyleSheet.create({
     container: {
         flex: 1,

package/package.json

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