@moonpay/platform-sdk-core 1.0.2 → 1.2.0

package/dist/index.d.cts

@@ -116,6 +116,27 @@ interface UrlBuilderOptions {
 }
 /** Build a frame URL with query parameters. */
 declare function buildFrameUrl(path: string, query?: Record<string, unknown>, options?: UrlBuilderOptions): string;
+/** Theming options honoured by every visible MoonPay frame. */
+interface ThemeOptions {
+    /**
+     * Frame appearance. Emitted as the `theme` query param that MoonPay frames
+     * read to render in light or dark mode. Defaults to the customer's system
+     * preference when omitted.
+     */
+    appearance?: 'light' | 'dark';
+}
+/**
+ * Query params for a theme, mapping `appearance` → the `theme` param the
+ * frames actually read. Returns `{}` when no appearance is set, so it spreads
+ * cleanly into a frame URL's query object.
+ */
+declare function themeParams(theme?: ThemeOptions): Record<string, string>;
+/**
+ * Set the `theme` query param on an already-built frame URL from a
+ * client-level theme — unless the URL already carries one, so a per-frame
+ * (or partner-embedded) theme always wins over the client default.
+ */
+declare function applyThemeParam(url: string, theme?: ThemeOptions): string;
 
 interface CoreClientOptions extends ClientContextOptions, UrlBuilderOptions {
     /**
@@ -214,4 +235,4 @@ interface FrameHandle {
  */
 declare function createFrameOrchestrator(options: FrameOrchestratorOptions): Promise<FrameHandle>;
 
-export { type ClientContext, type ClientContextOptions, type CoreClient, type CoreClientOptions, FRAME_PATHS, type FrameHandle, type FrameOptions, type FrameOrchestratorOptions, type FrameTransport, type KeyPair, type ListTransactionsParams, type UrlBuilderOptions, apiFetch, buildFrameUrl, createClientContext, createClientCore, createFrameOrchestrator, createIdentity, decryptCredentials, deletePaymentMethod, generateKeyPair, getIdentity, getIdentityUploadUrl, getPaymentMethods, getQuote, getTransaction, listTransactions, submitIdentityFiles, updateIdentity, verifyIdentity };
+export { type ClientContext, type ClientContextOptions, type CoreClient, type CoreClientOptions, FRAME_PATHS, type FrameHandle, type FrameOptions, type FrameOrchestratorOptions, type FrameTransport, type KeyPair, type ListTransactionsParams, type ThemeOptions, type UrlBuilderOptions, apiFetch, applyThemeParam, buildFrameUrl, createClientContext, createClientCore, createFrameOrchestrator, createIdentity, decryptCredentials, deletePaymentMethod, generateKeyPair, getIdentity, getIdentityUploadUrl, getPaymentMethods, getQuote, getTransaction, listTransactions, submitIdentityFiles, themeParams, updateIdentity, verifyIdentity };

package/dist/index.d.ts

@@ -116,6 +116,27 @@ interface UrlBuilderOptions {
 }
 /** Build a frame URL with query parameters. */
 declare function buildFrameUrl(path: string, query?: Record<string, unknown>, options?: UrlBuilderOptions): string;
+/** Theming options honoured by every visible MoonPay frame. */
+interface ThemeOptions {
+    /**
+     * Frame appearance. Emitted as the `theme` query param that MoonPay frames
+     * read to render in light or dark mode. Defaults to the customer's system
+     * preference when omitted.
+     */
+    appearance?: 'light' | 'dark';
+}
+/**
+ * Query params for a theme, mapping `appearance` → the `theme` param the
+ * frames actually read. Returns `{}` when no appearance is set, so it spreads
+ * cleanly into a frame URL's query object.
+ */
+declare function themeParams(theme?: ThemeOptions): Record<string, string>;
+/**
+ * Set the `theme` query param on an already-built frame URL from a
+ * client-level theme — unless the URL already carries one, so a per-frame
+ * (or partner-embedded) theme always wins over the client default.
+ */
+declare function applyThemeParam(url: string, theme?: ThemeOptions): string;
 
 interface CoreClientOptions extends ClientContextOptions, UrlBuilderOptions {
     /**
@@ -214,4 +235,4 @@ interface FrameHandle {
  */
 declare function createFrameOrchestrator(options: FrameOrchestratorOptions): Promise<FrameHandle>;
 
-export { type ClientContext, type ClientContextOptions, type CoreClient, type CoreClientOptions, FRAME_PATHS, type FrameHandle, type FrameOptions, type FrameOrchestratorOptions, type FrameTransport, type KeyPair, type ListTransactionsParams, type UrlBuilderOptions, apiFetch, buildFrameUrl, createClientContext, createClientCore, createFrameOrchestrator, createIdentity, decryptCredentials, deletePaymentMethod, generateKeyPair, getIdentity, getIdentityUploadUrl, getPaymentMethods, getQuote, getTransaction, listTransactions, submitIdentityFiles, updateIdentity, verifyIdentity };
+export { type ClientContext, type ClientContextOptions, type CoreClient, type CoreClientOptions, FRAME_PATHS, type FrameHandle, type FrameOptions, type FrameOrchestratorOptions, type FrameTransport, type KeyPair, type ListTransactionsParams, type ThemeOptions, type UrlBuilderOptions, apiFetch, applyThemeParam, buildFrameUrl, createClientContext, createClientCore, createFrameOrchestrator, createIdentity, decryptCredentials, deletePaymentMethod, generateKeyPair, getIdentity, getIdentityUploadUrl, getPaymentMethods, getQuote, getTransaction, listTransactions, submitIdentityFiles, themeParams, updateIdentity, verifyIdentity };

package/dist/index.js

@@ -1585,9 +1585,22 @@ function buildFrameUrl(path, query = {}, options = {}) {
   }
   return url.href;
 }
+function themeParams(theme) {
+  return theme?.appearance ? { theme: theme.appearance } : {};
+}
+function applyThemeParam(url, theme) {
+  if (!theme?.appearance)
+    return url;
+  const parsed = new URL(url);
+  if (!parsed.searchParams.has("theme")) {
+    parsed.searchParams.set("theme", theme.appearance);
+  }
+  return parsed.href;
+}
 export {
   FRAME_PATHS,
   apiFetch,
+  applyThemeParam,
   buildFrameUrl,
   createClientContext,
   createClientCore,
@@ -1603,6 +1616,7 @@ export {
   getTransaction,
   listTransactions,
   submitIdentityFiles,
+  themeParams,
   updateIdentity,
   verifyIdentity
 };