@coinbase/cdp-react 0.0.98 → 0.0.100

package/dist/utils/formatPhoneNumber.d.ts

@@ -1 +1,9 @@
+/**
+ * Format a phone number.
+ *
+ * @param phoneNumber - The phone number in E.164 format, e.g. "+12345678900".
+ * @returns The formatted phone number (calling code + national format) or the incomplete phone number if it cannot be parsed.
+ *
+ * @group Utilities
+ */
 export declare const formatPhoneNumber: (phoneNumber: string) => string;

package/dist/utils/getMessageFromUnknownError.d.ts

@@ -1 +1,10 @@
+/**
+ * Get a message from an unknown error with a fallback in case one is not found.
+ *
+ * @param {unknown} error - The error to get a message from.
+ * @param {string} [defaultMesasge] - The default message to return if no message is found.
+ * @returns {string} The message from the error.
+ *
+ * @group Utilities
+ */
 export declare const getMessageFromUnknownError: (error: unknown, defaultMesasge?: string) => string;

package/dist/utils/isApiError.d.ts

@@ -1,2 +1,23 @@
 import { APIError } from '@coinbase/cdp-hooks';
+/**
+ * Type guard to check if the error is an API error.
+ *
+ * @param {unknown} error - The error to check.
+ * @returns {error is ApiError} - True if the error is an API error, false otherwise.
+ *
+ * @group Utilities
+ *
+ * @example
+ * ```tsx lines
+ * try {
+ *   ...
+ * }
+ * catch (error) {
+ *   if (isApiError(error)) {
+ *     // Handle API error
+ *     console.log(error.errorMessage);
+ *   }
+ * }
+ * ```
+ */
 export declare const isApiError: (error: unknown) => error is APIError;

package/dist/utils/isEmailInvalid.d.ts

@@ -1 +1,16 @@
+/**
+ * Check if an email address is invalid.
+ *
+ * @param value - The email address to validate.
+ * @returns `true` if the email address is invalid, `false` otherwise.
+ *
+ * @group Utilities
+ *
+ * @example
+ * ```tsx lines
+ * if (isEmailInvalid("test@example")) {
+ *   console.log("Invalid email address");
+ * }
+ * ```
+ */
 export declare const isEmailInvalid: (value: string) => boolean;

package/dist/utils/openPopup.d.ts

@@ -1,7 +1,22 @@
+/**
+ * The parameters for the openPopup function.
+ */
 export type OpenPopupParams = {
     url: string;
     height: number;
     width: number;
     target?: string;
 };
+/**
+ * Open a popup in the center of the screen with the specified size.
+ *
+ * @param {OpenPopupParams} params - The parameters for the popup.
+ * @param {string} params.url - The URL to open in the popup.
+ * @param {string} [params.target] - The target window for the popup.
+ * @param {number} params.height - The height of the popup.
+ * @param {number} params.width - The width of the popup.
+ * @returns {Window | null} The popup window.
+ *
+ * @group Utilities
+ */
 export declare const openPopup: ({ url, target, height, width }: OpenPopupParams) => Window | null;

package/dist/utils/parseValuesFromPhoneNumber.d.ts

@@ -1,6 +1,22 @@
 import { CountryCode } from 'libphonenumber-js';
+/**
+ * A phone number object.
+ *
+ * @see {@link parseValuesFromPhoneNumber} for the function that parses a phone number into a phone number object.
+ */
 export interface PhoneNumber {
+    /** The phone number in the national format (country calling code is not included) */
     value: string;
+    /** The phone number in international format (E.164). Typically used in API calls. */
     e164: string;
 }
+/**
+ * Parse a phone number into a phone number object.
+ *
+ * @param phoneNumber - The phone number to parse.
+ * @param countryCode - The country code to parse the phone number for.
+ * @returns A phone number object.
+ *
+ * @group Utilities
+ */
 export declare const parseValuesFromPhoneNumber: (phoneNumber: string, countryCode?: CountryCode) => PhoneNumber;

package/dist/utils/sendIframeMessage.d.ts

@@ -1 +1,9 @@
+/**
+ * Sends a message to an iframe.
+ *
+ * @param el - The iframe element to send the message to.
+ * @param message - The message to send to the iframe.
+ *
+ * @group Utilities
+ */
 export declare const sendIframeMessage: <T extends Record<string | number | symbol, unknown>>(el: HTMLIFrameElement | null, message: T) => void;

package/dist/utils/toOAuthProviderType.d.ts

@@ -1,2 +1,10 @@
 import { OAuth2ProviderType } from '@coinbase/cdp-hooks';
+/**
+ * Extracts the OAuth provider type from an auth method.
+ *
+ * @param {string} authMethod - The auth method to convert.
+ * @returns {OAuth2ProviderType} The OAuth provider type.
+ *
+ * @group Utilities
+ */
 export declare function toOAuthProviderType(authMethod: string): OAuth2ProviderType | undefined;

package/dist/utils/transition.d.ts

@@ -1,4 +1,10 @@
+/**
+ * The possible statuses of a transition.
+ */
 export type TransitionStatus = "preEnter" | "entering" | "entered" | "preExit" | "exiting" | "exited" | "unmounted";
+/**
+ * The state of a transition.
+ */
 export type TransitionState = Readonly<{
     _s: number;
     status: TransitionStatus;
@@ -14,6 +20,12 @@ export declare const EXITING = 4;
 export declare const EXITED = 5;
 export declare const UNMOUNTED = 6;
 export declare const STATUS: TransitionStatus[];
+/**
+ * Get the state object based on the status.
+ *
+ * @param {number} status - The current status.
+ * @returns {TransitionState} The state object.
+ */
 export declare const getState: (status: number) => {
     _s: number;
     status: TransitionStatus;
@@ -21,10 +33,39 @@ export declare const getState: (status: number) => {
     isMounted: boolean;
     isResolved: boolean;
 };
+/**
+ * Get the start or end status based on the unmounted flag.
+ *
+ * @param {boolean} unmounted - Whether the component is unmounted.
+ * @returns {number} The start or end status.
+ */
 export declare const startOrEnd: (unmounted: boolean) => 5 | 6;
+/**
+ * Get the end status based on the status and unmountOnExit flag.
+ *
+ * @param {number} status - The current status.
+ * @param {boolean} unmountOnExit - Whether to unmount the component on exit.
+ * @returns {number} The end status based on the status and unmountOnExit flag.
+ */
 export declare const getEndStatus: (status: number, unmountOnExit: boolean) => 2 | 5 | 6 | undefined;
+/**
+ * Normalize the timeout option to timeout tuple.
+ *
+ * @param {number | { enter: number; exit: number }} timeout - The timeout value or an object with enter and exit timeout values.
+ * @returns {[number, number]} The enter and exit timeout values.
+ */
 export declare const getTimeout: (timeout: number | {
     enter: number;
     exit: number;
 }) => number[];
+/**
+ * Schedule a next tick to transition to the next status.
+ * If onTimerScheduled is provided, it is called with the inner rAF id when scheduled
+ * so the caller can cancel it on cleanup (avoids state updates after unmount in tests).
+ *
+ * @param {(status: number) => void} transitState - A function to call when the next tick is reached.
+ * @param {number} status - The current status.
+ * @param {(id: number) => void} [onTimerScheduled] - Called with the inner animation frame id when scheduled.
+ * @returns {number} The outer animation frame ID.
+ */
 export declare const nextTick: (transitState: (status: number) => void, status: number, onTimerScheduled?: (id: number) => void) => number;

package/dist/version.d.ts

@@ -1 +1,5 @@
-export declare const VERSION = "0.0.98";
+/**
+ * Current version of @coinbase/cdp-react package.
+ * This file is auto-generated by scripts/sync-versions.js
+ */
+export declare const VERSION = "0.0.100";

package/dist/version.js

@@ -1,4 +1,4 @@
-const o = "0.0.98";
+const o = "0.0.100";
 export {
   o as VERSION
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coinbase/cdp-react",
-  "version": "0.0.98",
+  "version": "0.0.100",
   "type": "module",
   "dependencies": {
     "@internationalized/number": "3.6.4",
@@ -16,8 +16,8 @@
   },
   "peerDependencies": {
     "react": ">=18.2.0 <19.2.0",
-    "@coinbase/cdp-core": "^0.0.98",
-    "@coinbase/cdp-hooks": "^0.0.98"
+    "@coinbase/cdp-hooks": "^0.0.100",
+    "@coinbase/cdp-core": "^0.0.100"
   },
   "devDependencies": {
     "@size-limit/preset-big-lib": "^11.2.0",
@@ -49,8 +49,8 @@
     "vite": "^7.0.4",
     "vite-plugin-dts": "^4.5.4",
     "vite-plugin-lib-inject-css": "^2.2.2",
-    "@coinbase/cdp-core": "^0.0.98",
-    "@coinbase/cdp-hooks": "^0.0.98"
+    "@coinbase/cdp-hooks": "^0.0.100",
+    "@coinbase/cdp-core": "^0.0.100"
   },
   "size-limit": [
     {