@moonpay/platform-sdk-core 1.17.0 → 1.18.0

package/dist/index.d.cts

@@ -215,6 +215,21 @@ interface CoreClientOptions extends ClientContextOptions, UrlBuilderOptions {
      */
     createTransport: () => FrameTransport;
 }
+/**
+ * Customer-scoped credentials the client holds after a successful connection.
+ * Surfaced to partners via `getCredentials()` — see that method for caveats.
+ */
+interface Credentials {
+    /** Short-lived bearer token scoped to the connected customer. */
+    accessToken: string;
+    /** Token identifying the SDK client; used when launching frames. */
+    clientToken: string;
+}
+/** Returned by `getCredentials()` when no customer session is active yet. */
+interface GetCredentialsError {
+    code: 'noActiveSession';
+    message: string;
+}
 interface CoreClient {
     /** Access the internal context (for platform SDKs). */
     readonly context: ClientContext;
@@ -222,6 +237,18 @@ interface CoreClient {
     readonly frameBaseUrl: string | undefined;
     /** Factory to create transports (for platform SDKs). */
     createTransport(): FrameTransport;
+    /**
+     * Returns the connected customer's credentials so the `accessToken` can be
+     * forwarded to your backend for customer-scoped Platform API calls (e.g.
+     * server-side quote fetching).
+     *
+     * Advanced escape hatch — the SDK otherwise keeps these internal. The
+     * `accessToken` is short-lived and scoped to the connected customer. Errs
+     * with `noActiveSession` until a customer session exists (populated by
+     * `getConnection()` / `connect()` / `setupAuth()`). Synchronous: returns a
+     * `Result` directly, not a Promise.
+     */
+    getCredentials(): Result<Credentials, GetCredentialsError>;
     getQuote(params: GetQuoteParams): Promise<Result<{
         data: Quote;
     }, GetQuoteError>>;
@@ -362,4 +389,4 @@ declare function isTrustedFrameOrigin(origin: string): boolean;
  */
 declare function isTrustedFrameUrl(value: string): boolean;
 
-export { type ClientContext, type ClientContextOptions, type CoreClient, type CoreClientOptions, FRAME_PATHS, type FrameHandle, type FrameOptions, type FrameOrchestratorOptions, type FrameTransport, type KeyPair, type ListAssetsParams, type ListTransactionsParams, type PresentationMode, TRUSTED_FRAME_ORIGIN_PATTERNS, type ThemeOptions, type UrlBuilderOptions, apiFetch, applyClientTokenParam, applyPresentationParam, applyThemeParam, buildFrameUrl, createClientContext, createClientCore, createFrameOrchestrator, createIdentity, decryptCredentials, deletePaymentMethod, generateKeyPair, getAssets, getCustomer, getCustomerUploadUrl, getIdentity, getIdentityUploadUrl, getPaymentMethods, getQuote, getTransaction, isSecureRandomAvailable, isTrustedFrameOrigin, isTrustedFrameUrl, listTransactions, presentationParams, simulateBankTransfer, submitCustomerFiles, submitCustomerKyc, submitIdentityFiles, themeParams, updateIdentity, verifyIdentity };
+export { type ClientContext, type ClientContextOptions, type CoreClient, type CoreClientOptions, type Credentials, FRAME_PATHS, type FrameHandle, type FrameOptions, type FrameOrchestratorOptions, type FrameTransport, type GetCredentialsError, type KeyPair, type ListAssetsParams, type ListTransactionsParams, type PresentationMode, TRUSTED_FRAME_ORIGIN_PATTERNS, type ThemeOptions, type UrlBuilderOptions, apiFetch, applyClientTokenParam, applyPresentationParam, applyThemeParam, buildFrameUrl, createClientContext, createClientCore, createFrameOrchestrator, createIdentity, decryptCredentials, deletePaymentMethod, generateKeyPair, getAssets, getCustomer, getCustomerUploadUrl, getIdentity, getIdentityUploadUrl, getPaymentMethods, getQuote, getTransaction, isSecureRandomAvailable, isTrustedFrameOrigin, isTrustedFrameUrl, listTransactions, presentationParams, simulateBankTransfer, submitCustomerFiles, submitCustomerKyc, submitIdentityFiles, themeParams, updateIdentity, verifyIdentity };

package/dist/index.d.ts

@@ -215,6 +215,21 @@ interface CoreClientOptions extends ClientContextOptions, UrlBuilderOptions {
      */
     createTransport: () => FrameTransport;
 }
+/**
+ * Customer-scoped credentials the client holds after a successful connection.
+ * Surfaced to partners via `getCredentials()` — see that method for caveats.
+ */
+interface Credentials {
+    /** Short-lived bearer token scoped to the connected customer. */
+    accessToken: string;
+    /** Token identifying the SDK client; used when launching frames. */
+    clientToken: string;
+}
+/** Returned by `getCredentials()` when no customer session is active yet. */
+interface GetCredentialsError {
+    code: 'noActiveSession';
+    message: string;
+}
 interface CoreClient {
     /** Access the internal context (for platform SDKs). */
     readonly context: ClientContext;
@@ -222,6 +237,18 @@ interface CoreClient {
     readonly frameBaseUrl: string | undefined;
     /** Factory to create transports (for platform SDKs). */
     createTransport(): FrameTransport;
+    /**
+     * Returns the connected customer's credentials so the `accessToken` can be
+     * forwarded to your backend for customer-scoped Platform API calls (e.g.
+     * server-side quote fetching).
+     *
+     * Advanced escape hatch — the SDK otherwise keeps these internal. The
+     * `accessToken` is short-lived and scoped to the connected customer. Errs
+     * with `noActiveSession` until a customer session exists (populated by
+     * `getConnection()` / `connect()` / `setupAuth()`). Synchronous: returns a
+     * `Result` directly, not a Promise.
+     */
+    getCredentials(): Result<Credentials, GetCredentialsError>;
     getQuote(params: GetQuoteParams): Promise<Result<{
         data: Quote;
     }, GetQuoteError>>;
@@ -362,4 +389,4 @@ declare function isTrustedFrameOrigin(origin: string): boolean;
  */
 declare function isTrustedFrameUrl(value: string): boolean;
 
-export { type ClientContext, type ClientContextOptions, type CoreClient, type CoreClientOptions, FRAME_PATHS, type FrameHandle, type FrameOptions, type FrameOrchestratorOptions, type FrameTransport, type KeyPair, type ListAssetsParams, type ListTransactionsParams, type PresentationMode, TRUSTED_FRAME_ORIGIN_PATTERNS, type ThemeOptions, type UrlBuilderOptions, apiFetch, applyClientTokenParam, applyPresentationParam, applyThemeParam, buildFrameUrl, createClientContext, createClientCore, createFrameOrchestrator, createIdentity, decryptCredentials, deletePaymentMethod, generateKeyPair, getAssets, getCustomer, getCustomerUploadUrl, getIdentity, getIdentityUploadUrl, getPaymentMethods, getQuote, getTransaction, isSecureRandomAvailable, isTrustedFrameOrigin, isTrustedFrameUrl, listTransactions, presentationParams, simulateBankTransfer, submitCustomerFiles, submitCustomerKyc, submitIdentityFiles, themeParams, updateIdentity, verifyIdentity };
+export { type ClientContext, type ClientContextOptions, type CoreClient, type CoreClientOptions, type Credentials, FRAME_PATHS, type FrameHandle, type FrameOptions, type FrameOrchestratorOptions, type FrameTransport, type GetCredentialsError, type KeyPair, type ListAssetsParams, type ListTransactionsParams, type PresentationMode, TRUSTED_FRAME_ORIGIN_PATTERNS, type ThemeOptions, type UrlBuilderOptions, apiFetch, applyClientTokenParam, applyPresentationParam, applyThemeParam, buildFrameUrl, createClientContext, createClientCore, createFrameOrchestrator, createIdentity, decryptCredentials, deletePaymentMethod, generateKeyPair, getAssets, getCustomer, getCustomerUploadUrl, getIdentity, getIdentityUploadUrl, getPaymentMethods, getQuote, getTransaction, isSecureRandomAvailable, isTrustedFrameOrigin, isTrustedFrameUrl, listTransactions, presentationParams, simulateBankTransfer, submitCustomerFiles, submitCustomerKyc, submitIdentityFiles, themeParams, updateIdentity, verifyIdentity };

package/dist/index.js

@@ -206,6 +206,7 @@ async function simulateBankTransfer(ctx, id, params) {
 }
 
 // src/client.ts
+import { err as err4, ok as ok4 } from "@moonpay/platform-protocol/result";
 function createClientCore(options) {
   const ctx = createClientContext({
     apiBaseUrl: options.apiBaseUrl
@@ -218,6 +219,10 @@ function createClientCore(options) {
       return options.frameBaseUrl;
     },
     createTransport: options.createTransport,
+    getCredentials: () => ctx.accessToken ? ok4({ accessToken: ctx.accessToken, clientToken: ctx.clientToken }) : err4({
+      code: "noActiveSession",
+      message: "No active session. Connect a customer (getConnection / connect / setupAuth) before requesting credentials."
+    }),
     getQuote: (params) => getQuote(ctx, params),
     getAssets: (params) => getAssets(ctx, params),
     getPaymentMethods: () => getPaymentMethods(ctx),