@dynamic-labs-sdk/legacy-embedded-wallet-upgrade 1.23.0 → 1.24.0

package/README.md

@@ -26,22 +26,24 @@ if (hasWalletsRequiringUpgrade()) {
 
 ## Redirect path
 
-Navigate the top-level window to the hosted upgrade app, then consume the result when it returns. The environment id is read from the client and the return URL defaults to the current page, so both calls are zero-arg.
+Navigate the top-level window to the hosted upgrade app, then handle the result when it returns. The return leg is two steps — `detectUpgradeRedirect` tells you whether the current URL is a return from the upgrade app, and `completeUpgradeRedirect` finishes it (refreshing the session on success) — mirroring how OAuth and device registration consume their redirects. You always pass the URL yourself (`window.location.href` in the browser, the deep-link URL in React Native).
 
 ```ts
 import {
   startUpgradeRedirect,
-  consumeUpgradeRedirect,
+  detectUpgradeRedirect,
+  completeUpgradeRedirect,
 } from '@dynamic-labs-sdk/legacy-embedded-wallet-upgrade';
 
 // on the "Upgrade via redirect" button
 startUpgradeRedirect();
 
-// once, on app load — reads and strips the status param, refreshes the
-// session on success, and returns the outcome (null if we didn't just return)
-const result = await consumeUpgradeRedirect();
-if (result?.status === 'error') {
-  showErrorToast();
+// once, on app load
+if (detectUpgradeRedirect({ url: window.location.href })) {
+  const result = await completeUpgradeRedirect({ url: window.location.href });
+  if (result?.status === 'error') {
+    showErrorToast();
+  }
 }
 ```
 

package/dist/buildUpgradeUrl/buildUpgradeUrl.d.ts

@@ -1,16 +1,4 @@
-type BuildUpgradeUrlParams = {
-    /**
-     * Base URL of the hosted upgrade app. Defaults to the production upgrade app;
-     * override it to target a local or preview build (e.g. during QA).
-     */
-    baseUrl?: string;
-    /**
-     * Absolute https URL the upgrade app returns to (redirect flow) or
-     * postMessages (iframe flow) on completion. Defaults to the current page
-     * (`window.location.href`). The upgrade app rejects any non-https URL.
-     */
-    redirectUrl?: string;
-};
+import type { BuildUpgradeUrlParams } from './buildUpgradeUrl.types';
 /**
  * Builds the URL that drives the hosted upgrade app for the client's Dynamic
  * environment and a return target.
@@ -26,19 +14,18 @@ type BuildUpgradeUrlParams = {
  * ```ts
  * const src = buildUpgradeUrl();
  * // or target a local upgrade app during QA:
- * const localSrc = buildUpgradeUrl({ baseUrl: 'https://localhost:3000' });
+ * const localSrc = buildUpgradeUrl({ baseUrl: 'http://localhost:3000' });
  * ```
  * @param [params] - Options for the generated URL.
- * @param [params.redirectUrl] - Absolute https return URL; defaults to `window.location.href`.
+ * @param [params.redirectUrl] - Absolute https or http return URL; defaults to `window.location.href`.
  * @param [params.baseUrl] - Upgrade app base URL; defaults to the production app.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns The fully-qualified upgrade app URL to load.
- * @throws {InvalidUpgradeRedirectUrlError} When `redirectUrl` is not an absolute https URL.
- * @throws {InvalidUpgradeBaseUrlError} When `baseUrl` is not an absolute https URL.
+ * @throws {InvalidUpgradeRedirectUrlError} When `redirectUrl` is not an absolute https or http URL.
+ * @throws {InvalidUpgradeBaseUrlError} When `baseUrl` is not an absolute https or http URL.
  * @throws {UnavailableInServerSideError} When called during SSR without an explicit `redirectUrl`.
  * @see startUpgradeRedirect
  * @see openUpgradeIframe
  */
 export declare const buildUpgradeUrl: ({ redirectUrl, baseUrl }?: BuildUpgradeUrlParams, client?: import("@dynamic-labs-sdk/client").DynamicClient) => string;
-export {};
 //# sourceMappingURL=buildUpgradeUrl.d.ts.map

package/dist/buildUpgradeUrl/buildUpgradeUrl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"buildUpgradeUrl.d.ts","sourceRoot":"","sources":["../../src/buildUpgradeUrl/buildUpgradeUrl.ts"],"names":[],"mappings":"AAkBA,KAAK,qBAAqB,GAAG;IAC3B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,eAAe,8BACuB,qBAAqB,gEAErE,MAqCF,CAAC"}
+{"version":3,"file":"buildUpgradeUrl.d.ts","sourceRoot":"","sources":["../../src/buildUpgradeUrl/buildUpgradeUrl.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAarE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,eAAe,8BACuB,qBAAqB,gEAErE,MAqDF,CAAC"}

package/dist/buildUpgradeUrl/buildUpgradeUrl.types.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Options for {@link buildUpgradeUrl}. Shared by the web and React Native
+ * builders so both platform variants keep an identical signature.
+ *
+ * @see buildUpgradeUrl
+ */
+export type BuildUpgradeUrlParams = {
+    /**
+     * Base URL of the hosted upgrade app. Defaults to the production upgrade app;
+     * override it to target a local or preview build (e.g. during QA).
+     */
+    baseUrl?: string;
+    /**
+     * URL the upgrade app returns to on completion. On the web this is the page
+     * the redirect flow navigates back to (or the iframe origin postMessages);
+     * it defaults to the current page (`window.location.href`) and must be an
+     * absolute https or http URL. On React Native there is no current page, so it
+     * is required and may be either https/http or a safe custom app deeplink
+     * (e.g. `myapp://callback`).
+     */
+    redirectUrl?: string;
+};
+//# sourceMappingURL=buildUpgradeUrl.types.d.ts.map

package/dist/buildUpgradeUrl/buildUpgradeUrl.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildUpgradeUrl.types.d.ts","sourceRoot":"","sources":["../../src/buildUpgradeUrl/buildUpgradeUrl.types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}

package/dist/clearUpgradeRedirectParams/clearUpgradeRedirectParams.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Removes the upgrade outcome parameter (`dynamicWaasMigrationStatus`) that the
+ * upgrade app appends to the return URL from the browser's current URL, leaving
+ * every other query parameter, the path, and the hash untouched.
+ *
+ * Call this once you have handled the outcome from `completeUpgradeRedirect` so a
+ * page refresh does not replay it. `completeUpgradeRedirect` never touches
+ * browser history, so clearing the param is your responsibility — this helper
+ * does it in one call, mirroring `clearSocialRedirectParams` and
+ * `clearDeviceRegistrationRedirectParams`. Unlike clearing the whole query
+ * string, it preserves any of your own parameters on the callback URL.
+ *
+ * This reads and rewrites `window.location`, so it can only run in the browser.
+ * Calling it during server-side rendering (no `window`) throws
+ * `UnavailableInServerSideError`. On React Native there is no browser address
+ * bar to clean — you own your navigation state — so a `.native` build throws
+ * instead.
+ *
+ * @example
+ * ```ts
+ * const outcome = await completeUpgradeRedirect({ url: window.location.href });
+ * if (outcome) {
+ *   handleOutcome(outcome);
+ *   clearUpgradeRedirectParams();
+ * }
+ * ```
+ * @returns Nothing. The current URL is rewritten in place via
+ * `window.history.replaceState`.
+ * @throws {UnavailableInServerSideError} When called during SSR (no `window`).
+ * @see completeUpgradeRedirect
+ * @see startUpgradeRedirect
+ */
+export declare const clearUpgradeRedirectParams: () => void;
+//# sourceMappingURL=clearUpgradeRedirectParams.d.ts.map

package/dist/clearUpgradeRedirectParams/clearUpgradeRedirectParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clearUpgradeRedirectParams.d.ts","sourceRoot":"","sources":["../../src/clearUpgradeRedirectParams/clearUpgradeRedirectParams.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,0BAA0B,QAAO,IAU7C,CAAC"}

package/dist/clearUpgradeRedirectParams/index.d.ts

@@ -0,0 +1,2 @@
+export { clearUpgradeRedirectParams } from './clearUpgradeRedirectParams';
+//# sourceMappingURL=index.d.ts.map

package/dist/clearUpgradeRedirectParams/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/clearUpgradeRedirectParams/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC"}

package/dist/completeUpgradeRedirect/completeUpgradeRedirect.d.ts

@@ -0,0 +1,70 @@
+import { type WalletUpgradeOutcome } from '../upgradeAppContract';
+/**
+ * Options for {@link completeUpgradeRedirect}.
+ *
+ * @example
+ * ```ts
+ * // Browser: read the outcome from the current page.
+ * await completeUpgradeRedirect({ url: window.location.href });
+ * ```
+ * @see completeUpgradeRedirect
+ * @see detectUpgradeRedirect
+ */
+export type CompleteUpgradeRedirectParams = {
+    /**
+     * The return URL to read the upgrade outcome from. Pass the URL yourself so
+     * the flow works everywhere: in the browser pass `window.location.href`; in
+     * React Native pass the deep-link URL you received. This mirrors how social
+     * sign-in and device registration consume their redirects, and keeps the
+     * function free of any implicit `window` dependency.
+     */
+    url: string;
+};
+/**
+ * Completes the redirect upgrade path after {@link detectUpgradeRedirect}.
+ *
+ * The upgrade app sends the user back with the outcome in the
+ * `dynamicWaasMigrationStatus` query param. Once `detectUpgradeRedirect` tells
+ * you the return URL is an upgrade redirect, call this to finish it: it reads
+ * the param and, on success, refreshes the session (so the upgraded wallet
+ * appears) before returning the outcome. The refresh is best-effort — the
+ * upgrade already succeeded on the backend, so a failed refresh still reports
+ * success and reconciles on the next auth refresh. This detect-then-complete
+ * split mirrors the OAuth (`detectSocialRedirectUrl` + `completeSocialRedirect`)
+ * and
+ * device-registration (`detectDeviceRegistrationRedirect` +
+ * `completeDeviceRegistration`) flows. Returns `null` when a well-formed URL
+ * simply carries no upgrade result, so that common case is safe to call
+ * directly without `detectUpgradeRedirect` first. A malformed/unparseable URL
+ * rejects instead — either gate the call with `detectUpgradeRedirect` (which
+ * parses defensively) or surface the rejection (e.g. via
+ * `useUpgradeRedirectResult`'s `onError`).
+ *
+ * You always pass the URL (`window.location.href` in the browser, the deep-link
+ * URL in React Native), matching how social sign-in and device registration
+ * consume their redirects. The function never touches browser history, so you
+ * own clearing the param from your navigation state once you have the outcome.
+ *
+ * @example
+ * ```ts
+ * // Browser
+ * if (detectUpgradeRedirect({ url: window.location.href })) {
+ *   const outcome = await completeUpgradeRedirect({ url: window.location.href });
+ *   if (outcome?.status === 'error') showRetryToast();
+ * }
+ * ```
+ * @example
+ * ```ts
+ * // React Native: pass the deep-link URL you received.
+ * const outcome = await completeUpgradeRedirect({ url: deepLinkUrl });
+ * ```
+ * @param params - Options.
+ * @param params.url - Return URL to read the outcome from (e.g. `window.location.href`).
+ * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+ * @returns A promise resolving to the upgrade outcome, or `null` when there was no upgrade result to consume.
+ * @see detectUpgradeRedirect
+ * @see startUpgradeRedirect
+ * @see subscribeToUpgradeCompletion
+ */
+export declare const completeUpgradeRedirect: ({ url }: CompleteUpgradeRedirectParams, client?: import("@dynamic-labs-sdk/client").DynamicClient) => Promise<WalletUpgradeOutcome | null>;
+//# sourceMappingURL=completeUpgradeRedirect.d.ts.map

package/dist/completeUpgradeRedirect/completeUpgradeRedirect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"completeUpgradeRedirect.d.ts","sourceRoot":"","sources":["../../src/completeUpgradeRedirect/completeUpgradeRedirect.ts"],"names":[],"mappings":"AAGA,OAAO,EAIL,KAAK,oBAAoB,EAC1B,MAAM,uBAAuB,CAAC;AAE/B;;;;;;;;;;GAUG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;;;;OAMG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,eAAO,MAAM,uBAAuB,YACzB,6BAA6B,gEAErC,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAoCrC,CAAC"}

package/dist/completeUpgradeRedirect/index.d.ts

@@ -0,0 +1,2 @@
+export { completeUpgradeRedirect, type CompleteUpgradeRedirectParams, } from './completeUpgradeRedirect';
+//# sourceMappingURL=index.d.ts.map

package/dist/completeUpgradeRedirect/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/completeUpgradeRedirect/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,KAAK,6BAA6B,GACnC,MAAM,2BAA2B,CAAC"}

package/dist/detectUpgradeRedirect/detectUpgradeRedirect.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Options for {@link detectUpgradeRedirect}.
+ *
+ * @example
+ * ```ts
+ * // Browser: check the current page.
+ * detectUpgradeRedirect({ url: window.location.href });
+ * ```
+ * @see detectUpgradeRedirect
+ * @see completeUpgradeRedirect
+ */
+export type DetectUpgradeRedirectParams = {
+    /**
+     * The return URL to check. In the browser pass `window.location.href`; in
+     * React Native pass the deep-link URL you received. Mirrors how social
+     * sign-in and device registration detect their redirects.
+     */
+    url: string;
+};
+/**
+ * Detects whether the given URL is a return from the redirect upgrade path.
+ *
+ * Checks the `dynamicWaasMigrationStatus` query param for one of the two values
+ * the upgrade app emits (`success` / `error`). Use it to decide whether to run
+ * {@link completeUpgradeRedirect}, mirroring the detect-then-complete flow of
+ * OAuth (`detectSocialRedirectUrl` + `completeSocialRedirect`) and device
+ * registration (`detectDeviceRegistrationRedirect` + `completeDeviceRegistration`).
+ *
+ * @example
+ * ```ts
+ * if (detectUpgradeRedirect({ url: window.location.href })) {
+ *   const outcome = await completeUpgradeRedirect({ url: window.location.href });
+ * }
+ * ```
+ * @param params - Options.
+ * @param params.url - Return URL to check (e.g. `window.location.href`).
+ * @returns `true` when the URL carries a recognized upgrade outcome, `false` otherwise.
+ * @see completeUpgradeRedirect
+ * @see startUpgradeRedirect
+ */
+export declare const detectUpgradeRedirect: ({ url, }: DetectUpgradeRedirectParams) => boolean;
+//# sourceMappingURL=detectUpgradeRedirect.d.ts.map

package/dist/detectUpgradeRedirect/detectUpgradeRedirect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"detectUpgradeRedirect.d.ts","sourceRoot":"","sources":["../../src/detectUpgradeRedirect/detectUpgradeRedirect.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;GAUG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,qBAAqB,aAE/B,2BAA2B,KAAG,OAahC,CAAC"}

package/dist/detectUpgradeRedirect/index.d.ts

@@ -0,0 +1,2 @@
+export { detectUpgradeRedirect, type DetectUpgradeRedirectParams, } from './detectUpgradeRedirect';
+//# sourceMappingURL=index.d.ts.map

package/dist/detectUpgradeRedirect/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/detectUpgradeRedirect/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,2BAA2B,GACjC,MAAM,yBAAyB,CAAC"}

package/dist/errors/InvalidUpgradeCallbackOriginError.d.ts

@@ -0,0 +1,7 @@
+import { BaseError } from '@dynamic-labs-sdk/client';
+export declare class InvalidUpgradeCallbackOriginError extends BaseError {
+    constructor({ expectedOrigin }: {
+        expectedOrigin: string;
+    });
+}
+//# sourceMappingURL=InvalidUpgradeCallbackOriginError.d.ts.map

package/dist/errors/InvalidUpgradeCallbackOriginError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InvalidUpgradeCallbackOriginError.d.ts","sourceRoot":"","sources":["../../src/errors/InvalidUpgradeCallbackOriginError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAErD,qBAAa,iCAAkC,SAAQ,SAAS;gBAClD,EAAE,cAAc,EAAE,EAAE;QAAE,cAAc,EAAE,MAAM,CAAA;KAAE;CAY3D"}

package/dist/errors/InvalidUpgradeNativeRedirectUrlError.d.ts

@@ -0,0 +1,5 @@
+import { BaseError } from '@dynamic-labs-sdk/client';
+export declare class InvalidUpgradeNativeRedirectUrlError extends BaseError {
+    constructor(redirectUrl: string | undefined);
+}
+//# sourceMappingURL=InvalidUpgradeNativeRedirectUrlError.d.ts.map

package/dist/errors/InvalidUpgradeNativeRedirectUrlError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InvalidUpgradeNativeRedirectUrlError.d.ts","sourceRoot":"","sources":["../../src/errors/InvalidUpgradeNativeRedirectUrlError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAErD,qBAAa,oCAAqC,SAAQ,SAAS;gBAErD,WAAW,EAAE,MAAM,GAAG,SAAS;CAgC5C"}

package/dist/errors/UpgradeCallbackMissingOutcomeError.d.ts

@@ -0,0 +1,5 @@
+import { BaseError } from '@dynamic-labs-sdk/client';
+export declare class UpgradeCallbackMissingOutcomeError extends BaseError {
+    constructor();
+}
+//# sourceMappingURL=UpgradeCallbackMissingOutcomeError.d.ts.map

package/dist/errors/UpgradeCallbackMissingOutcomeError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UpgradeCallbackMissingOutcomeError.d.ts","sourceRoot":"","sources":["../../src/errors/UpgradeCallbackMissingOutcomeError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAErD,qBAAa,kCAAmC,SAAQ,SAAS;;CAWhE"}

package/dist/exports/index.d.ts

@@ -2,7 +2,9 @@ export { buildUpgradeUrl } from '../buildUpgradeUrl';
 export { getWalletsRequiringUpgrade } from '../getWalletsRequiringUpgrade';
 export { hasWalletsRequiringUpgrade } from '../hasWalletsRequiringUpgrade';
 export { startUpgradeRedirect } from '../startUpgradeRedirect';
-export { consumeUpgradeRedirect, type ConsumeUpgradeRedirectParams, } from '../consumeUpgradeRedirect';
+export { detectUpgradeRedirect, type DetectUpgradeRedirectParams, } from '../detectUpgradeRedirect';
+export { completeUpgradeRedirect, type CompleteUpgradeRedirectParams, } from '../completeUpgradeRedirect';
+export { clearUpgradeRedirectParams } from '../clearUpgradeRedirectParams';
 export { subscribeToUpgradeCompletion } from '../subscribeToUpgradeCompletion';
 export { openUpgradeIframe } from '../openUpgradeIframe';
 export type { UpgradeIframeSession } from '../openUpgradeIframe';

package/dist/exports/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/exports/index.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EACL,sBAAsB,EACtB,KAAK,4BAA4B,GAClC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,YAAY,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,YAAY,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC/D,YAAY,EACV,oBAAoB,EACpB,mBAAmB,GACpB,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/exports/index.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EACL,qBAAqB,EACrB,KAAK,2BAA2B,GACjC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,uBAAuB,EACvB,KAAK,6BAA6B,GACnC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,YAAY,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,YAAY,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC/D,YAAY,EACV,oBAAoB,EACpB,mBAAmB,GACpB,MAAM,uBAAuB,CAAC"}

package/dist/exports/react.d.ts

@@ -1,6 +1,6 @@
 export { useWalletsRequiringUpgrade } from '../react/useWalletsRequiringUpgrade';
 export { useHasWalletsRequiringUpgrade } from '../react/useHasWalletsRequiringUpgrade';
-export { useUpgradeRedirectResult, type UseUpgradeRedirectResultParams, } from '../react/useUpgradeRedirectResult';
+export { useUpgradeRedirectResult, type UseUpgradeRedirectResultParams, type UseUpgradeRedirectResult, } from '../react/useUpgradeRedirectResult';
 export { useUpgradeIframe, type UseUpgradeIframeParams, type UseUpgradeIframeResult, } from '../react/useUpgradeIframe';
 export { useUpgradePopup, type UseUpgradePopupParams, type UseUpgradePopupResult, } from '../react/useUpgradePopup';
 //# sourceMappingURL=react.d.ts.map

package/dist/exports/react.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../../src/exports/react.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACjF,OAAO,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AACvF,OAAO,EACL,wBAAwB,EACxB,KAAK,8BAA8B,GACpC,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,gBAAgB,EAChB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,GAC5B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,eAAe,EACf,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,GAC3B,MAAM,0BAA0B,CAAC"}
+{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../../src/exports/react.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACjF,OAAO,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AACvF,OAAO,EACL,wBAAwB,EACxB,KAAK,8BAA8B,EACnC,KAAK,wBAAwB,GAC9B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,gBAAgB,EAChB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,GAC5B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,eAAe,EACf,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,GAC3B,MAAM,0BAA0B,CAAC"}

package/dist/index.cjs

@@ -1,4 +1,4 @@
-const require_openUpgradePopup = require('./openUpgradePopup-C_vOjG3Q.cjs');
+const require_openUpgradePopup = require('./openUpgradePopup-j9eg2-qt.cjs');
 let _dynamic_labs_sdk_assert_package_version = require("@dynamic-labs-sdk/assert-package-version");
 let _dynamic_labs_sdk_client = require("@dynamic-labs-sdk/client");
 let _dynamic_labs_sdk_client_core = require("@dynamic-labs-sdk/client/core");
@@ -34,7 +34,7 @@ const hasWalletsRequiringUpgrade = (client = (0, _dynamic_labs_sdk_client.getDef
 *
 * Call this from an "Upgrade" button. The upgrade app runs full-page and, once
 * finished, returns the user to `redirectUrl` with the outcome encoded in the
-* URL — call {@link consumeUpgradeRedirect} on load to pick it up. The
+* URL — call {@link completeUpgradeRedirect} on load to pick it up. The
 * environment id and return URL are derived from the client and current page,
 * so the common call is zero-arg.
 *
@@ -44,15 +44,48 @@ const hasWalletsRequiringUpgrade = (client = (0, _dynamic_labs_sdk_client.getDef
 * await startUpgradeRedirect();
 * ```
 * @param [params] - Options for the redirect.
-* @param [params.redirectUrl] - Absolute https return URL; defaults to `window.location.href`.
+* @param [params.redirectUrl] - Absolute https or http return URL; defaults to `window.location.href`.
 * @param [params.baseUrl] - Upgrade app base URL; defaults to the production app.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns A promise that resolves once navigation has been initiated.
-* @see consumeUpgradeRedirect
+* @see completeUpgradeRedirect
 * @see buildUpgradeUrl
 */
 const startUpgradeRedirect = async (params = {}, client = (0, _dynamic_labs_sdk_client.getDefaultClient)()) => (0, _dynamic_labs_sdk_client_core.getCore)(client).navigate(require_openUpgradePopup.buildUpgradeUrl(params, client));
 
+//#endregion
+//#region src/detectUpgradeRedirect/detectUpgradeRedirect.ts
+/**
+* Detects whether the given URL is a return from the redirect upgrade path.
+*
+* Checks the `dynamicWaasMigrationStatus` query param for one of the two values
+* the upgrade app emits (`success` / `error`). Use it to decide whether to run
+* {@link completeUpgradeRedirect}, mirroring the detect-then-complete flow of
+* OAuth (`detectSocialRedirectUrl` + `completeSocialRedirect`) and device
+* registration (`detectDeviceRegistrationRedirect` + `completeDeviceRegistration`).
+*
+* @example
+* ```ts
+* if (detectUpgradeRedirect({ url: window.location.href })) {
+*   const outcome = await completeUpgradeRedirect({ url: window.location.href });
+* }
+* ```
+* @param params - Options.
+* @param params.url - Return URL to check (e.g. `window.location.href`).
+* @returns `true` when the URL carries a recognized upgrade outcome, `false` otherwise.
+* @see completeUpgradeRedirect
+* @see startUpgradeRedirect
+*/
+const detectUpgradeRedirect = ({ url }) => {
+	let status;
+	try {
+		status = new URL(url).searchParams.get(require_openUpgradePopup.UPGRADE_STATUS_PARAM);
+	} catch {
+		return false;
+	}
+	return status === require_openUpgradePopup.UPGRADE_STATUS_SUCCESS || status === require_openUpgradePopup.UPGRADE_STATUS_ERROR;
+};
+
 //#endregion
 //#region src/errors/UpgradeIframeClosedError.ts
 var UpgradeIframeClosedError = class extends _dynamic_labs_sdk_client.BaseError {
@@ -93,7 +126,7 @@ const UPGRADE_IFRAME_TITLE = "Dynamic embedded wallet upgrade";
 * ```
 * @param params - Iframe options.
 * @param params.container - Element the upgrade iframe is appended into.
-* @param [params.redirectUrl] - Absolute https completion URL; defaults to `window.location.href`.
+* @param [params.redirectUrl] - Absolute https or http completion URL; defaults to `window.location.href`.
 * @param [params.baseUrl] - Upgrade app base URL; defaults to the production app.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns A session handle exposing the `iframe`, a `close` function, and the `completed` promise.
@@ -142,7 +175,9 @@ const openUpgradeIframe = ({ container, redirectUrl, baseUrl }, client = (0, _dy
 
 //#endregion
 exports.buildUpgradeUrl = require_openUpgradePopup.buildUpgradeUrl;
-exports.consumeUpgradeRedirect = require_openUpgradePopup.consumeUpgradeRedirect;
+exports.clearUpgradeRedirectParams = require_openUpgradePopup.clearUpgradeRedirectParams;
+exports.completeUpgradeRedirect = require_openUpgradePopup.completeUpgradeRedirect;
+exports.detectUpgradeRedirect = detectUpgradeRedirect;
 exports.getWalletsRequiringUpgrade = require_openUpgradePopup.getWalletsRequiringUpgrade;
 exports.hasWalletsRequiringUpgrade = hasWalletsRequiringUpgrade;
 exports.openUpgradeIframe = openUpgradeIframe;

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["getWalletsRequiringUpgrade","buildUpgradeUrl","BaseError","buildUpgradeUrl","resolveCompleted: ((outcome: WalletUpgradeOutcome) => void) | undefined","rejectCompleted: ((reason: UpgradeIframeClosedError) => void) | undefined","subscribeToUpgradeCompletion","packageName","packageVersion"],"sources":["../src/hasWalletsRequiringUpgrade/hasWalletsRequiringUpgrade.ts","../src/startUpgradeRedirect/startUpgradeRedirect.ts","../src/errors/UpgradeIframeClosedError.ts","../src/openUpgradeIframe/openUpgradeIframe.ts","../src/exports/index.ts"],"sourcesContent":["import { getDefaultClient } from '@dynamic-labs-sdk/client';\n\nimport { getWalletsRequiringUpgrade } from '../getWalletsRequiringUpgrade';\n\n/**\n * Returns whether the current session has any legacy Dynamic embedded wallet\n * that requires an upgrade to Dynamic WaaS.\n *\n * A boolean convenience over {@link getWalletsRequiringUpgrade} for the common\n * case where you only need to decide whether to surface the upgrade flow (e.g.\n * show a banner or gate a wallet's actions) rather than act on the specific\n * accounts.\n *\n * @example\n * ```ts\n * if (hasWalletsRequiringUpgrade()) {\n *   showUpgradeToWaasBanner();\n * }\n * ```\n * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.\n * @returns True when at least one wallet account requires an upgrade to Dynamic WaaS, false otherwise.\n * @see getWalletsRequiringUpgrade\n * @see startUpgradeRedirect\n */\nexport const hasWalletsRequiringUpgrade = (\n  client = getDefaultClient()\n): boolean => getWalletsRequiringUpgrade(client).length > 0;\n","import { getDefaultClient } from '@dynamic-labs-sdk/client';\nimport { getCore } from '@dynamic-labs-sdk/client/core';\n\nimport { buildUpgradeUrl } from '../buildUpgradeUrl';\n\ntype StartUpgradeRedirectParams = {\n  /**\n   * Base URL of the hosted upgrade app. Defaults to the production upgrade app;\n   * override it to target a local or preview build (e.g. during QA).\n   */\n  baseUrl?: string;\n  /**\n   * Absolute https URL the upgrade app returns to on completion. Defaults to\n   * the current page (`window.location.href`), so the outcome can be picked up\n   * by {@link consumeUpgradeRedirect} when the user lands back.\n   */\n  redirectUrl?: string;\n};\n\n/**\n * Starts the redirect upgrade path by navigating the top-level window to the\n * hosted upgrade app.\n *\n * Call this from an \"Upgrade\" button. The upgrade app runs full-page and, once\n * finished, returns the user to `redirectUrl` with the outcome encoded in the\n * URL — call {@link consumeUpgradeRedirect} on load to pick it up. The\n * environment id and return URL are derived from the client and current page,\n * so the common call is zero-arg.\n *\n * @example\n * ```ts\n * // on the \"Upgrade via redirect\" button\n * await startUpgradeRedirect();\n * ```\n * @param [params] - Options for the redirect.\n * @param [params.redirectUrl] - Absolute https return URL; defaults to `window.location.href`.\n * @param [params.baseUrl] - Upgrade app base URL; defaults to the production app.\n * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.\n * @returns A promise that resolves once navigation has been initiated.\n * @see consumeUpgradeRedirect\n * @see buildUpgradeUrl\n */\nexport const startUpgradeRedirect = async (\n  params: StartUpgradeRedirectParams = {},\n  client = getDefaultClient()\n): Promise<void> =>\n  getCore(client).navigate(buildUpgradeUrl(params, client));\n","import { BaseError } from '@dynamic-labs-sdk/client';\n\nexport class UpgradeIframeClosedError extends BaseError {\n  constructor() {\n    super({\n      cause: null,\n      code: 'upgrade_iframe_closed_error',\n      docsUrl: null,\n      name: 'UpgradeIframeClosedError',\n      shortMessage: 'Upgrade iframe was closed before the upgrade completed',\n    });\n  }\n}\n","/* eslint-disable no-restricted-globals */\n\nimport { getDefaultClient } from '@dynamic-labs-sdk/client';\n\nimport { buildUpgradeUrl } from '../buildUpgradeUrl';\nimport { UpgradeIframeClosedError } from '../errors/UpgradeIframeClosedError';\nimport { subscribeToUpgradeCompletion } from '../subscribeToUpgradeCompletion';\nimport type { WalletUpgradeOutcome } from '../upgradeAppContract';\nimport type {\n  OpenUpgradeIframeParams,\n  UpgradeIframeSession,\n} from './openUpgradeIframe.types';\n\nexport type { UpgradeIframeSession } from './openUpgradeIframe.types';\n\n// Permissions the upgrade app needs inside the iframe: clipboard writes plus\n// passkey (WebAuthn) get/create, which the embedded wallet upgrade relies on.\nconst UPGRADE_IFRAME_ALLOW =\n  'clipboard-write; publickey-credentials-get *; publickey-credentials-create *';\n\nconst UPGRADE_IFRAME_TITLE = 'Dynamic embedded wallet upgrade';\n\n/**\n * Runs the embedded upgrade path by mounting the hosted upgrade app in an\n * iframe inside a container you provide.\n *\n * The package renders no UI of its own: pass the element of your modal/sheet\n * and it appends the iframe, wires the origin-checked completion handshake, and\n * refreshes the session on success. `completed` resolves with the outcome once\n * the app reports back; call `close()` when the user dismisses the surface (or\n * after completion) to remove the iframe and detach the listener. Closing\n * before completion rejects `completed` with {@link UpgradeIframeClosedError}\n * so awaiters don't hang — wrap `await session.completed` in try/catch if you\n * allow early dismissal. For React Native or custom mounts, use\n * {@link subscribeToUpgradeCompletion} with {@link buildUpgradeUrl} instead.\n *\n * @example\n * ```ts\n * const session = openUpgradeIframe({ container: sheetBodyEl });\n * const { status } = await session.completed;\n * session.close();\n * ```\n * @param params - Iframe options.\n * @param params.container - Element the upgrade iframe is appended into.\n * @param [params.redirectUrl] - Absolute https completion URL; defaults to `window.location.href`.\n * @param [params.baseUrl] - Upgrade app base URL; defaults to the production app.\n * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.\n * @returns A session handle exposing the `iframe`, a `close` function, and the `completed` promise.\n * @see subscribeToUpgradeCompletion\n * @see buildUpgradeUrl\n */\nexport const openUpgradeIframe = (\n  { container, redirectUrl, baseUrl }: OpenUpgradeIframeParams,\n  client = getDefaultClient()\n): UpgradeIframeSession => {\n  const iframe = document.createElement('iframe');\n  iframe.src = buildUpgradeUrl({ baseUrl, redirectUrl }, client);\n  iframe.title = UPGRADE_IFRAME_TITLE;\n  iframe.setAttribute('allow', UPGRADE_IFRAME_ALLOW);\n\n  container.appendChild(iframe);\n\n  // Executor runs synchronously, so both settlers are assigned before the\n  // subscription below (or `close`) can ever fire.\n  let resolveCompleted: ((outcome: WalletUpgradeOutcome) => void) | undefined;\n  let rejectCompleted: ((reason: UpgradeIframeClosedError) => void) | undefined;\n  const completed = new Promise<WalletUpgradeOutcome>((resolve, reject) => {\n    resolveCompleted = resolve;\n    rejectCompleted = reject;\n  });\n\n  // Callers may use `close()` purely for teardown and never await `completed`.\n  // Attach a no-op catch so an early-close rejection is treated as handled\n  // globally (no unhandled-rejection noise); a caller that does await\n  // `completed` still receives the rejection in its own context.\n  completed.catch(() => undefined);\n\n  // Set the instant a valid completion message arrives — before the async\n  // session refresh resolves `completed` via `onComplete`. `close()` checks\n  // this so dismissing the surface during that refresh window does not reject a\n  // promise for an upgrade that already succeeded.\n  let hasReceivedCompletion = false;\n\n  const unsubscribe = subscribeToUpgradeCompletion(\n    {\n      baseUrl,\n      onComplete: (outcome) => resolveCompleted?.(outcome),\n      onReceived: () => {\n        hasReceivedCompletion = true;\n      },\n    },\n    client\n  );\n\n  const close = () => {\n    unsubscribe();\n    iframe.remove();\n    // Reject `completed` only as a genuine cancellation — i.e. no completion\n    // has been received yet — so anything awaiting it doesn't hang forever. If\n    // a completion already arrived, `onComplete` (after the refresh) resolves\n    // `completed` with the real outcome, so we must not reject here.\n    if (!hasReceivedCompletion) {\n      rejectCompleted?.(new UpgradeIframeClosedError());\n    }\n  };\n\n  return { close, completed, iframe };\n};\n","import { assertPackageVersion } from '@dynamic-labs-sdk/assert-package-version';\n\nimport {\n  name as packageName,\n  version as packageVersion,\n} from '../../package.json';\n\nassertPackageVersion(packageName, packageVersion);\n\nexport { buildUpgradeUrl } from '../buildUpgradeUrl';\nexport { getWalletsRequiringUpgrade } from '../getWalletsRequiringUpgrade';\nexport { hasWalletsRequiringUpgrade } from '../hasWalletsRequiringUpgrade';\nexport { startUpgradeRedirect } from '../startUpgradeRedirect';\nexport {\n  consumeUpgradeRedirect,\n  type ConsumeUpgradeRedirectParams,\n} from '../consumeUpgradeRedirect';\nexport { subscribeToUpgradeCompletion } from '../subscribeToUpgradeCompletion';\nexport { openUpgradeIframe } from '../openUpgradeIframe';\nexport type { UpgradeIframeSession } from '../openUpgradeIframe';\nexport { openUpgradePopup } from '../openUpgradePopup';\nexport type { UpgradePopupSession } from '../openUpgradePopup';\nexport type {\n  WalletUpgradeOutcome,\n  WalletUpgradeStatus,\n} from '../upgradeAppContract';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,MAAa,8BACX,yDAA2B,KACfA,oDAA2B,OAAO,CAAC,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;ACgB1D,MAAa,uBAAuB,OAClC,SAAqC,EAAE,EACvC,yDAA2B,gDAEnB,OAAO,CAAC,SAASC,yCAAgB,QAAQ,OAAO,CAAC;;;;AC5C3D,IAAa,2BAAb,cAA8CC,mCAAU;CACtD,cAAc;AACZ,QAAM;GACJ,OAAO;GACP,MAAM;GACN,SAAS;GACT,MAAM;GACN,cAAc;GACf,CAAC;;;;;;ACON,MAAM,uBACJ;AAEF,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+B7B,MAAa,qBACX,EAAE,WAAW,aAAa,WAC1B,yDAA2B,KACF;CACzB,MAAM,SAAS,SAAS,cAAc,SAAS;AAC/C,QAAO,MAAMC,yCAAgB;EAAE;EAAS;EAAa,EAAE,OAAO;AAC9D,QAAO,QAAQ;AACf,QAAO,aAAa,SAAS,qBAAqB;AAElD,WAAU,YAAY,OAAO;CAI7B,IAAIC;CACJ,IAAIC;CACJ,MAAM,YAAY,IAAI,SAA+B,SAAS,WAAW;AACvE,qBAAmB;AACnB,oBAAkB;GAClB;AAMF,WAAU,YAAY,OAAU;CAMhC,IAAI,wBAAwB;CAE5B,MAAM,cAAcC,sDAClB;EACE;EACA,aAAa,YAAY,mBAAmB,QAAQ;EACpD,kBAAkB;AAChB,2BAAwB;;EAE3B,EACD,OACD;CAED,MAAM,cAAc;AAClB,eAAa;AACb,SAAO,QAAQ;AAKf,MAAI,CAAC,sBACH,mBAAkB,IAAI,0BAA0B,CAAC;;AAIrD,QAAO;EAAE;EAAO;EAAW;EAAQ;;;;;mECnGhBC,+BAAaC,iCAAe"}
+{"version":3,"file":"index.cjs","names":["getWalletsRequiringUpgrade","buildUpgradeUrl","status: string | null","UPGRADE_STATUS_PARAM","UPGRADE_STATUS_SUCCESS","UPGRADE_STATUS_ERROR","BaseError","buildUpgradeUrl","resolveCompleted: ((outcome: WalletUpgradeOutcome) => void) | undefined","rejectCompleted: ((reason: UpgradeIframeClosedError) => void) | undefined","subscribeToUpgradeCompletion","packageName","packageVersion"],"sources":["../src/hasWalletsRequiringUpgrade/hasWalletsRequiringUpgrade.ts","../src/startUpgradeRedirect/startUpgradeRedirect.ts","../src/detectUpgradeRedirect/detectUpgradeRedirect.ts","../src/errors/UpgradeIframeClosedError.ts","../src/openUpgradeIframe/openUpgradeIframe.ts","../src/exports/index.ts"],"sourcesContent":["import { getDefaultClient } from '@dynamic-labs-sdk/client';\n\nimport { getWalletsRequiringUpgrade } from '../getWalletsRequiringUpgrade';\n\n/**\n * Returns whether the current session has any legacy Dynamic embedded wallet\n * that requires an upgrade to Dynamic WaaS.\n *\n * A boolean convenience over {@link getWalletsRequiringUpgrade} for the common\n * case where you only need to decide whether to surface the upgrade flow (e.g.\n * show a banner or gate a wallet's actions) rather than act on the specific\n * accounts.\n *\n * @example\n * ```ts\n * if (hasWalletsRequiringUpgrade()) {\n *   showUpgradeToWaasBanner();\n * }\n * ```\n * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.\n * @returns True when at least one wallet account requires an upgrade to Dynamic WaaS, false otherwise.\n * @see getWalletsRequiringUpgrade\n * @see startUpgradeRedirect\n */\nexport const hasWalletsRequiringUpgrade = (\n  client = getDefaultClient()\n): boolean => getWalletsRequiringUpgrade(client).length > 0;\n","import { getDefaultClient } from '@dynamic-labs-sdk/client';\nimport { getCore } from '@dynamic-labs-sdk/client/core';\n\nimport { buildUpgradeUrl } from '../buildUpgradeUrl';\n\ntype StartUpgradeRedirectParams = {\n  /**\n   * Base URL of the hosted upgrade app. Defaults to the production upgrade app;\n   * override it to target a local or preview build (e.g. during QA).\n   */\n  baseUrl?: string;\n  /**\n   * Absolute https or http URL the upgrade app returns to on completion. Defaults to\n   * the current page (`window.location.href`), so the outcome can be picked up\n   * by {@link completeUpgradeRedirect} when the user lands back.\n   */\n  redirectUrl?: string;\n};\n\n/**\n * Starts the redirect upgrade path by navigating the top-level window to the\n * hosted upgrade app.\n *\n * Call this from an \"Upgrade\" button. The upgrade app runs full-page and, once\n * finished, returns the user to `redirectUrl` with the outcome encoded in the\n * URL — call {@link completeUpgradeRedirect} on load to pick it up. The\n * environment id and return URL are derived from the client and current page,\n * so the common call is zero-arg.\n *\n * @example\n * ```ts\n * // on the \"Upgrade via redirect\" button\n * await startUpgradeRedirect();\n * ```\n * @param [params] - Options for the redirect.\n * @param [params.redirectUrl] - Absolute https or http return URL; defaults to `window.location.href`.\n * @param [params.baseUrl] - Upgrade app base URL; defaults to the production app.\n * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.\n * @returns A promise that resolves once navigation has been initiated.\n * @see completeUpgradeRedirect\n * @see buildUpgradeUrl\n */\nexport const startUpgradeRedirect = async (\n  params: StartUpgradeRedirectParams = {},\n  client = getDefaultClient()\n): Promise<void> =>\n  getCore(client).navigate(buildUpgradeUrl(params, client));\n","import {\n  UPGRADE_STATUS_ERROR,\n  UPGRADE_STATUS_PARAM,\n  UPGRADE_STATUS_SUCCESS,\n} from '../upgradeAppContract';\n\n/**\n * Options for {@link detectUpgradeRedirect}.\n *\n * @example\n * ```ts\n * // Browser: check the current page.\n * detectUpgradeRedirect({ url: window.location.href });\n * ```\n * @see detectUpgradeRedirect\n * @see completeUpgradeRedirect\n */\nexport type DetectUpgradeRedirectParams = {\n  /**\n   * The return URL to check. In the browser pass `window.location.href`; in\n   * React Native pass the deep-link URL you received. Mirrors how social\n   * sign-in and device registration detect their redirects.\n   */\n  url: string;\n};\n\n/**\n * Detects whether the given URL is a return from the redirect upgrade path.\n *\n * Checks the `dynamicWaasMigrationStatus` query param for one of the two values\n * the upgrade app emits (`success` / `error`). Use it to decide whether to run\n * {@link completeUpgradeRedirect}, mirroring the detect-then-complete flow of\n * OAuth (`detectSocialRedirectUrl` + `completeSocialRedirect`) and device\n * registration (`detectDeviceRegistrationRedirect` + `completeDeviceRegistration`).\n *\n * @example\n * ```ts\n * if (detectUpgradeRedirect({ url: window.location.href })) {\n *   const outcome = await completeUpgradeRedirect({ url: window.location.href });\n * }\n * ```\n * @param params - Options.\n * @param params.url - Return URL to check (e.g. `window.location.href`).\n * @returns `true` when the URL carries a recognized upgrade outcome, `false` otherwise.\n * @see completeUpgradeRedirect\n * @see startUpgradeRedirect\n */\nexport const detectUpgradeRedirect = ({\n  url,\n}: DetectUpgradeRedirectParams): boolean => {\n  let status: string | null;\n\n  try {\n    status = new URL(url).searchParams.get(UPGRADE_STATUS_PARAM);\n  } catch {\n    // A malformed URL is never one of our redirects.\n    return false;\n  }\n\n  // Only the two values the upgrade app emits count; ignore anything else\n  // (including tampered values) so a stray param cannot trigger completion.\n  return status === UPGRADE_STATUS_SUCCESS || status === UPGRADE_STATUS_ERROR;\n};\n","import { BaseError } from '@dynamic-labs-sdk/client';\n\nexport class UpgradeIframeClosedError extends BaseError {\n  constructor() {\n    super({\n      cause: null,\n      code: 'upgrade_iframe_closed_error',\n      docsUrl: null,\n      name: 'UpgradeIframeClosedError',\n      shortMessage: 'Upgrade iframe was closed before the upgrade completed',\n    });\n  }\n}\n","/* eslint-disable no-restricted-globals */\n\nimport { getDefaultClient } from '@dynamic-labs-sdk/client';\n\nimport { buildUpgradeUrl } from '../buildUpgradeUrl';\nimport { UpgradeIframeClosedError } from '../errors/UpgradeIframeClosedError';\nimport { subscribeToUpgradeCompletion } from '../subscribeToUpgradeCompletion';\nimport type { WalletUpgradeOutcome } from '../upgradeAppContract';\nimport type {\n  OpenUpgradeIframeParams,\n  UpgradeIframeSession,\n} from './openUpgradeIframe.types';\n\nexport type { UpgradeIframeSession } from './openUpgradeIframe.types';\n\n// Permissions the upgrade app needs inside the iframe: clipboard writes plus\n// passkey (WebAuthn) get/create, which the embedded wallet upgrade relies on.\nconst UPGRADE_IFRAME_ALLOW =\n  'clipboard-write; publickey-credentials-get *; publickey-credentials-create *';\n\nconst UPGRADE_IFRAME_TITLE = 'Dynamic embedded wallet upgrade';\n\n/**\n * Runs the embedded upgrade path by mounting the hosted upgrade app in an\n * iframe inside a container you provide.\n *\n * The package renders no UI of its own: pass the element of your modal/sheet\n * and it appends the iframe, wires the origin-checked completion handshake, and\n * refreshes the session on success. `completed` resolves with the outcome once\n * the app reports back; call `close()` when the user dismisses the surface (or\n * after completion) to remove the iframe and detach the listener. Closing\n * before completion rejects `completed` with {@link UpgradeIframeClosedError}\n * so awaiters don't hang — wrap `await session.completed` in try/catch if you\n * allow early dismissal. For React Native or custom mounts, use\n * {@link subscribeToUpgradeCompletion} with {@link buildUpgradeUrl} instead.\n *\n * @example\n * ```ts\n * const session = openUpgradeIframe({ container: sheetBodyEl });\n * const { status } = await session.completed;\n * session.close();\n * ```\n * @param params - Iframe options.\n * @param params.container - Element the upgrade iframe is appended into.\n * @param [params.redirectUrl] - Absolute https or http completion URL; defaults to `window.location.href`.\n * @param [params.baseUrl] - Upgrade app base URL; defaults to the production app.\n * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.\n * @returns A session handle exposing the `iframe`, a `close` function, and the `completed` promise.\n * @see subscribeToUpgradeCompletion\n * @see buildUpgradeUrl\n */\nexport const openUpgradeIframe = (\n  { container, redirectUrl, baseUrl }: OpenUpgradeIframeParams,\n  client = getDefaultClient()\n): UpgradeIframeSession => {\n  const iframe = document.createElement('iframe');\n  iframe.src = buildUpgradeUrl({ baseUrl, redirectUrl }, client);\n  iframe.title = UPGRADE_IFRAME_TITLE;\n  iframe.setAttribute('allow', UPGRADE_IFRAME_ALLOW);\n\n  container.appendChild(iframe);\n\n  // Executor runs synchronously, so both settlers are assigned before the\n  // subscription below (or `close`) can ever fire.\n  let resolveCompleted: ((outcome: WalletUpgradeOutcome) => void) | undefined;\n  let rejectCompleted: ((reason: UpgradeIframeClosedError) => void) | undefined;\n  const completed = new Promise<WalletUpgradeOutcome>((resolve, reject) => {\n    resolveCompleted = resolve;\n    rejectCompleted = reject;\n  });\n\n  // Callers may use `close()` purely for teardown and never await `completed`.\n  // Attach a no-op catch so an early-close rejection is treated as handled\n  // globally (no unhandled-rejection noise); a caller that does await\n  // `completed` still receives the rejection in its own context.\n  completed.catch(() => undefined);\n\n  // Set the instant a valid completion message arrives — before the async\n  // session refresh resolves `completed` via `onComplete`. `close()` checks\n  // this so dismissing the surface during that refresh window does not reject a\n  // promise for an upgrade that already succeeded.\n  let hasReceivedCompletion = false;\n\n  const unsubscribe = subscribeToUpgradeCompletion(\n    {\n      baseUrl,\n      onComplete: (outcome) => resolveCompleted?.(outcome),\n      onReceived: () => {\n        hasReceivedCompletion = true;\n      },\n    },\n    client\n  );\n\n  const close = () => {\n    unsubscribe();\n    iframe.remove();\n    // Reject `completed` only as a genuine cancellation — i.e. no completion\n    // has been received yet — so anything awaiting it doesn't hang forever. If\n    // a completion already arrived, `onComplete` (after the refresh) resolves\n    // `completed` with the real outcome, so we must not reject here.\n    if (!hasReceivedCompletion) {\n      rejectCompleted?.(new UpgradeIframeClosedError());\n    }\n  };\n\n  return { close, completed, iframe };\n};\n","import { assertPackageVersion } from '@dynamic-labs-sdk/assert-package-version';\n\nimport {\n  name as packageName,\n  version as packageVersion,\n} from '../../package.json';\n\nassertPackageVersion(packageName, packageVersion);\n\nexport { buildUpgradeUrl } from '../buildUpgradeUrl';\nexport { getWalletsRequiringUpgrade } from '../getWalletsRequiringUpgrade';\nexport { hasWalletsRequiringUpgrade } from '../hasWalletsRequiringUpgrade';\nexport { startUpgradeRedirect } from '../startUpgradeRedirect';\nexport {\n  detectUpgradeRedirect,\n  type DetectUpgradeRedirectParams,\n} from '../detectUpgradeRedirect';\nexport {\n  completeUpgradeRedirect,\n  type CompleteUpgradeRedirectParams,\n} from '../completeUpgradeRedirect';\nexport { clearUpgradeRedirectParams } from '../clearUpgradeRedirectParams';\nexport { subscribeToUpgradeCompletion } from '../subscribeToUpgradeCompletion';\nexport { openUpgradeIframe } from '../openUpgradeIframe';\nexport type { UpgradeIframeSession } from '../openUpgradeIframe';\nexport { openUpgradePopup } from '../openUpgradePopup';\nexport type { UpgradePopupSession } from '../openUpgradePopup';\nexport type {\n  WalletUpgradeOutcome,\n  WalletUpgradeStatus,\n} from '../upgradeAppContract';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,MAAa,8BACX,yDAA2B,KACfA,oDAA2B,OAAO,CAAC,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;ACgB1D,MAAa,uBAAuB,OAClC,SAAqC,EAAE,EACvC,yDAA2B,gDAEnB,OAAO,CAAC,SAASC,yCAAgB,QAAQ,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;ACC3D,MAAa,yBAAyB,EACpC,UAC0C;CAC1C,IAAIC;AAEJ,KAAI;AACF,WAAS,IAAI,IAAI,IAAI,CAAC,aAAa,IAAIC,8CAAqB;SACtD;AAEN,SAAO;;AAKT,QAAO,WAAWC,mDAA0B,WAAWC;;;;;AC3DzD,IAAa,2BAAb,cAA8CC,mCAAU;CACtD,cAAc;AACZ,QAAM;GACJ,OAAO;GACP,MAAM;GACN,SAAS;GACT,MAAM;GACN,cAAc;GACf,CAAC;;;;;;ACON,MAAM,uBACJ;AAEF,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+B7B,MAAa,qBACX,EAAE,WAAW,aAAa,WAC1B,yDAA2B,KACF;CACzB,MAAM,SAAS,SAAS,cAAc,SAAS;AAC/C,QAAO,MAAMC,yCAAgB;EAAE;EAAS;EAAa,EAAE,OAAO;AAC9D,QAAO,QAAQ;AACf,QAAO,aAAa,SAAS,qBAAqB;AAElD,WAAU,YAAY,OAAO;CAI7B,IAAIC;CACJ,IAAIC;CACJ,MAAM,YAAY,IAAI,SAA+B,SAAS,WAAW;AACvE,qBAAmB;AACnB,oBAAkB;GAClB;AAMF,WAAU,YAAY,OAAU;CAMhC,IAAI,wBAAwB;CAE5B,MAAM,cAAcC,sDAClB;EACE;EACA,aAAa,YAAY,mBAAmB,QAAQ;EACpD,kBAAkB;AAChB,2BAAwB;;EAE3B,EACD,OACD;CAED,MAAM,cAAc;AAClB,eAAa;AACb,SAAO,QAAQ;AAKf,MAAI,CAAC,sBACH,mBAAkB,IAAI,0BAA0B,CAAC;;AAIrD,QAAO;EAAE;EAAO;EAAW;EAAQ;;;;;mECnGhBC,+BAAaC,iCAAe"}

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-import { a as buildUpgradeUrl, c as version, i as getWalletsRequiringUpgrade, n as subscribeToUpgradeCompletion, r as consumeUpgradeRedirect, s as name, t as openUpgradePopup } from "./openUpgradePopup-DQcEdgY_.esm.js";
+import { a as getWalletsRequiringUpgrade, c as UPGRADE_STATUS_PARAM, d as version, i as completeUpgradeRedirect, l as UPGRADE_STATUS_SUCCESS, n as subscribeToUpgradeCompletion, o as buildUpgradeUrl, r as clearUpgradeRedirectParams, s as UPGRADE_STATUS_ERROR, t as openUpgradePopup, u as name } from "./openUpgradePopup-DhnSl-2L.esm.js";
 import { assertPackageVersion } from "@dynamic-labs-sdk/assert-package-version";
 import { BaseError, getDefaultClient } from "@dynamic-labs-sdk/client";
 import { getCore } from "@dynamic-labs-sdk/client/core";
@@ -34,7 +34,7 @@ const hasWalletsRequiringUpgrade = (client = getDefaultClient()) => getWalletsRe
 *
 * Call this from an "Upgrade" button. The upgrade app runs full-page and, once
 * finished, returns the user to `redirectUrl` with the outcome encoded in the
-* URL — call {@link consumeUpgradeRedirect} on load to pick it up. The
+* URL — call {@link completeUpgradeRedirect} on load to pick it up. The
 * environment id and return URL are derived from the client and current page,
 * so the common call is zero-arg.
 *
@@ -44,15 +44,48 @@ const hasWalletsRequiringUpgrade = (client = getDefaultClient()) => getWalletsRe
 * await startUpgradeRedirect();
 * ```
 * @param [params] - Options for the redirect.
-* @param [params.redirectUrl] - Absolute https return URL; defaults to `window.location.href`.
+* @param [params.redirectUrl] - Absolute https or http return URL; defaults to `window.location.href`.
 * @param [params.baseUrl] - Upgrade app base URL; defaults to the production app.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns A promise that resolves once navigation has been initiated.
-* @see consumeUpgradeRedirect
+* @see completeUpgradeRedirect
 * @see buildUpgradeUrl
 */
 const startUpgradeRedirect = async (params = {}, client = getDefaultClient()) => getCore(client).navigate(buildUpgradeUrl(params, client));
 
+//#endregion
+//#region src/detectUpgradeRedirect/detectUpgradeRedirect.ts
+/**
+* Detects whether the given URL is a return from the redirect upgrade path.
+*
+* Checks the `dynamicWaasMigrationStatus` query param for one of the two values
+* the upgrade app emits (`success` / `error`). Use it to decide whether to run
+* {@link completeUpgradeRedirect}, mirroring the detect-then-complete flow of
+* OAuth (`detectSocialRedirectUrl` + `completeSocialRedirect`) and device
+* registration (`detectDeviceRegistrationRedirect` + `completeDeviceRegistration`).
+*
+* @example
+* ```ts
+* if (detectUpgradeRedirect({ url: window.location.href })) {
+*   const outcome = await completeUpgradeRedirect({ url: window.location.href });
+* }
+* ```
+* @param params - Options.
+* @param params.url - Return URL to check (e.g. `window.location.href`).
+* @returns `true` when the URL carries a recognized upgrade outcome, `false` otherwise.
+* @see completeUpgradeRedirect
+* @see startUpgradeRedirect
+*/
+const detectUpgradeRedirect = ({ url }) => {
+	let status;
+	try {
+		status = new URL(url).searchParams.get(UPGRADE_STATUS_PARAM);
+	} catch {
+		return false;
+	}
+	return status === UPGRADE_STATUS_SUCCESS || status === UPGRADE_STATUS_ERROR;
+};
+
 //#endregion
 //#region src/errors/UpgradeIframeClosedError.ts
 var UpgradeIframeClosedError = class extends BaseError {
@@ -93,7 +126,7 @@ const UPGRADE_IFRAME_TITLE = "Dynamic embedded wallet upgrade";
 * ```
 * @param params - Iframe options.
 * @param params.container - Element the upgrade iframe is appended into.
-* @param [params.redirectUrl] - Absolute https completion URL; defaults to `window.location.href`.
+* @param [params.redirectUrl] - Absolute https or http completion URL; defaults to `window.location.href`.
 * @param [params.baseUrl] - Upgrade app base URL; defaults to the production app.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns A session handle exposing the `iframe`, a `close` function, and the `completed` promise.
@@ -141,5 +174,5 @@ const openUpgradeIframe = ({ container, redirectUrl, baseUrl }, client = getDefa
 assertPackageVersion(name, version);
 
 //#endregion
-export { buildUpgradeUrl, consumeUpgradeRedirect, getWalletsRequiringUpgrade, hasWalletsRequiringUpgrade, openUpgradeIframe, openUpgradePopup, startUpgradeRedirect, subscribeToUpgradeCompletion };
+export { buildUpgradeUrl, clearUpgradeRedirectParams, completeUpgradeRedirect, detectUpgradeRedirect, getWalletsRequiringUpgrade, hasWalletsRequiringUpgrade, openUpgradeIframe, openUpgradePopup, startUpgradeRedirect, subscribeToUpgradeCompletion };
 //# sourceMappingURL=index.esm.js.map