@coinbase/cdp-core 0.0.114 → 0.0.115

package/dist/web-types/secureIframe/types.d.ts

@@ -94,7 +94,46 @@ export type SecureIframeListeningMessage = {
 /**
  * The status of the secure iframe.
  */
-export type SecureIframeStatus = "ready" | "success" | "error" | "expiring" | "expired";
+export type SecureIframeStatus = "ready" | "pending" | "success" | "error" | "expiring" | "expired";
+/**
+ * The action a `pending`/`success`/`error` status refers to: copying the key or ejecting
+ * the account. Absent for lifecycle statuses (ready/expiring/expired).
+ */
+export type SecureIframeOperation = "copy" | "eject";
+/**
+ * Which button the iframe should render initially: a copy button or an eject
+ * button. Defaults to "copy".
+ */
+export type SecureIframeAction = SecureIframeOperation;
+/**
+ * Button presentation/behavior config provided to the iframe via the init
+ * message. Preferred over the (deprecated) URL query params; each field that
+ * also exists as a URL param (see `BuildKeyExportIframeUrlOptions`) takes
+ * precedence over it.
+ */
+export type SecureIframeButtonConfig = {
+    /** Which button to render initially. Defaults to "copy". */
+    action?: SecureIframeAction;
+    /** The label for the copy button. */
+    label?: string;
+    /** The label shown after a successful copy. */
+    copiedLabel?: string;
+    /** The label for the eject button. */
+    ejectLabel?: string;
+    /** The label for the eject button while ejection is in progress. */
+    ejectingLabel?: string;
+    /** The label for the eject button once the account has been ejected. */
+    ejectedLabel?: string;
+    /** Whether to show an icon in the button. */
+    icon?: boolean;
+    /**
+     * Whether to show an icon on the eject button specifically.
+     * Falls back to `icon` when unset.
+     */
+    ejectIcon?: boolean;
+    /** Whether the button should be full width. */
+    fullWidth?: boolean;
+};
 /**
  * The message sent from the secure iframe to the parent window to indicate the status of the private key retrieval.
  */
@@ -102,7 +141,19 @@ export type SecureIframeStatusMessage = {
     type: SecureIframeEventType["STATUS"];
     payload: {
         status: SecureIframeStatus;
+        /** Which action a success/error refers to. Absent for lifecycle statuses. */
+        operation?: SecureIframeOperation;
+        /** Human-readable error message. Only set for error statuses. */
         message?: string;
+        /**
+         * The backend error type for error statuses (e.g. "invalid_request"). Note
+         * that the eject-specific failures (already ejected vs ejection not enabled)
+         * currently share the "invalid_request" type, so use `message` to tell them
+         * apart. Only set when the error originated from an API error.
+         */
+        errorType?: string;
+        /** The backend correlation ID for the failed request, useful for support. */
+        correlationId?: string;
     };
 };
 /**
@@ -121,12 +172,23 @@ export type SecureIframeGetPrivateKeyMessage = {
     payload: SecureIframeContext & {
         address: string;
         type: SecureIframeChainType;
+        /** Button presentation/behavior config. Preferred over URL params. */
+        config?: SecureIframeButtonConfig;
     };
 };
+/**
+ * The message sent to the secure iframe to reveal the eject button at runtime
+ * (e.g. after the parent's own UI confirms the user stored their copied key in
+ * the copy -> eject flow). Not needed when the iframe is initialized with
+ * `config.action: "eject"`.
+ */
+export type SecureIframeShowEjectMessage = {
+    type: SecureIframeKeyExportEventType["SHOW_EJECT"];
+};
 /**
  * The messages sent to the secure iframe from the parent window for key export.
  */
-export type SecureIframeKeyExportIncomingMessage = SecureIframeIncomingMessage | SecureIframeGetPrivateKeyMessage;
+export type SecureIframeKeyExportIncomingMessage = SecureIframeIncomingMessage | SecureIframeGetPrivateKeyMessage | SecureIframeShowEjectMessage;
 /**
  * The messages sent from the secure iframe to the parent window for key export.
  */

package/dist/web-types/secureIframe/utils.d.ts

@@ -15,18 +15,56 @@ export interface BuildKeyExportIframeUrlOptions {
     basePath?: string;
     /**
      * The label for the button displayed in the iframe.
+     *
+     * Prefer sending button config via the GET_PRIVATE_KEY init message
+     * (`config.label`); this URL param is a supported alternative.
      */
     label?: string;
     /**
      * The label to display when the key is copied successfully.
+     *
+     * Prefer the init message (`config.copiedLabel`); this URL param is a
+     * supported alternative.
      */
     copiedLabel?: string;
     /**
      * Whether to show an icon in the button.
      *
      * @default true
+     *
+     * Prefer the init message (`config.icon`); this URL param is a supported
+     * alternative.
      */
     icon?: boolean;
+    /**
+     * Whether to show an icon on the eject button specifically. Falls back to
+     * `icon` when unset.
+     *
+     * Prefer the init message (`config.ejectIcon`); this URL param is a supported
+     * alternative.
+     */
+    ejectIcon?: boolean;
+    /**
+     * The label for the eject button.
+     *
+     * Prefer the init message (`config.ejectLabel`); this URL param is a
+     * supported alternative.
+     */
+    ejectLabel?: string;
+    /**
+     * The label for the eject button while ejection is in progress.
+     *
+     * Prefer the init message (`config.ejectingLabel`); this URL param is a
+     * supported alternative.
+     */
+    ejectingLabel?: string;
+    /**
+     * The label for the eject button once the account has been ejected.
+     *
+     * Prefer the init message (`config.ejectedLabel`); this URL param is a
+     * supported alternative.
+     */
+    ejectedLabel?: string;
 }
 /**
  * Validates that the function is called in a browser environment.

package/dist/web-types/version.d.ts

@@ -2,4 +2,4 @@
  * Current version of @coinbase/cdp-core package.
  * This file is auto-generated by scripts/sync-versions.js
  */
-export declare const VERSION = "0.0.114";
+export declare const VERSION = "0.0.115";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coinbase/cdp-core",
-  "version": "0.0.114",
+  "version": "0.0.115",
   "type": "module",
   "files": [
     "dist/**",
@@ -29,7 +29,7 @@
     "ox": "0.8.1",
     "viem": "^2.47.0",
     "zustand": "^5.0.6",
-    "@coinbase/cdp-api-client": "^0.0.114"
+    "@coinbase/cdp-api-client": "^0.0.115"
   },
   "peerDependencies": {
     "@react-native-async-storage/async-storage": "^2.0.0",