@frak-labs/core-sdk 0.1.0-beta.afa252b0 → 0.1.0-beta.c7e026e5

package/dist/index-UFX7xCg3.d.ts

@@ -0,0 +1,351 @@
+import { J as Currency, L as PrepareSsoParamsType, Y as FrakWalletSdkConfig, a as FrakClient, d as TokenAmountType, i as FrakContext, z as SsoMetadata } from "./openSso-DsKJ4y0j.js";
+import { Hex } from "viem";
+import { RpcMessage, RpcResponse } from "@frak-labs/frame-connector";
+
+//#region src/types/compression.d.ts
+/**
+ * The received encoded data from a client
+ *  -> The encoded should contain a HashProtectedData once decoded
+ *  @ignore
+ */
+type CompressedData = Uint8Array;
+/**
+ * The encoded data to send to a client / received by a client
+ *  @ignore
+ */
+type HashProtectedData<DataType> = Readonly<DataType & {
+  validationHash: string;
+}>;
+/**
+ * Represent a key provider used for the hashed and secure compression
+ *  @ignore
+ */
+type KeyProvider<DataType> = (value: DataType) => string[];
+//#endregion
+//#region src/clients/createIFrameFrakClient.d.ts
+/**
+ * Create a new iframe Frak client
+ * @param args
+ * @param args.config - The configuration to use for the Frak Wallet SDK
+ * @param args.iframe - The iframe to use for the communication
+ * @returns The created Frak Client
+ *
+ * @example
+ * const frakConfig: FrakWalletSdkConfig = {
+ *     metadata: {
+ *         name: "My app title",
+ *     },
+ * }
+ * const iframe = await createIframe({ config: frakConfig });
+ * const client = createIFrameFrakClient({ config: frakConfig, iframe });
+ */
+declare function createIFrameFrakClient({
+  config,
+  iframe
+}: {
+  config: FrakWalletSdkConfig;
+  iframe: HTMLIFrameElement;
+}): FrakClient;
+//#endregion
+//#region src/clients/DebugInfo.d.ts
+/** @ignore */
+declare class DebugInfoGatherer {
+  private config?;
+  private iframe?;
+  private isSetupDone;
+  private lastResponse;
+  private lastRequest;
+  constructor(config?: FrakWalletSdkConfig, iframe?: HTMLIFrameElement);
+  setLastResponse(message: RpcMessage, response: RpcResponse): void;
+  setLastRequest(event: RpcMessage): void;
+  updateSetupStatus(status: boolean): void;
+  private base64Encode;
+  /**
+   * Extract information from the iframe status
+   */
+  private getIframeStatus;
+  private getNavigatorInfo;
+  private gatherDebugInfo;
+  static empty(): DebugInfoGatherer;
+  /**
+   * Format Frak debug information
+   */
+  formatDebugInfo(error: Error | unknown | string): string;
+}
+//#endregion
+//#region src/clients/setupClient.d.ts
+/**
+ * Directly setup the Frak client with an iframe
+ * Return when the FrakClient is ready (setup and communication estbalished with the wallet)
+ *
+ * @param config - The configuration to use for the Frak Wallet SDK
+ * @returns a Promise with the Frak Client
+ *
+ * @example
+ * const frakConfig: FrakWalletSdkConfig = {
+ *     metadata: {
+ *         name: "My app title",
+ *     },
+ * }
+ * const client = await setupClient({ config: frakConfig });
+ */
+declare function setupClient({
+  config
+}: {
+  config: FrakWalletSdkConfig;
+}): Promise<FrakClient | undefined>;
+//#endregion
+//#region src/constants/locales.d.ts
+/**
+ * The keys for each locales
+ * @inline
+ */
+type LocalesKey = keyof typeof locales;
+/**
+ * Map the currency to the locale
+ */
+declare const locales: {
+  readonly eur: "fr-FR";
+  readonly usd: "en-US";
+  readonly gbp: "en-GB";
+};
+//#endregion
+//#region src/utils/compression/b64.d.ts
+/**
+ * Encode a buffer to a base64url encoded string
+ * @param buffer The buffer to encode
+ * @returns The encoded string
+ */
+declare function base64urlEncode(buffer: Uint8Array): string;
+/**
+ * Decode a base64url encoded string
+ * @param value The value to decode
+ * @returns The decoded value
+ */
+declare function base64urlDecode(value: string): Uint8Array;
+//#endregion
+//#region src/utils/compression/compress.d.ts
+/**
+ * Compress json data
+ * @param data
+ * @ignore
+ */
+declare function compressJsonToB64(data: unknown): string;
+//#endregion
+//#region src/utils/compression/decompress.d.ts
+/**
+ * Decompress json data
+ * @param data
+ * @ignore
+ */
+declare function decompressJsonFromB64<T>(data: string): T | null;
+//#endregion
+//#region src/utils/FrakContext.d.ts
+/**
+ * Compress the current Frak context
+ * @param context - The context to be compressed
+ * @returns A compressed string containing the Frak context
+ */
+declare function compress(context?: Partial<FrakContext>): string | undefined;
+/**
+ * Decompress the given Frak context
+ * @param context - The raw context to be decompressed into a `FrakContext`
+ * @returns The decompressed Frak context, or undefined if it fails
+ */
+declare function decompress(context?: string): FrakContext | undefined;
+/**
+ * Parse the current URL into a Frak Context
+ * @param args
+ * @param args.url - The url to parse
+ * @returns The parsed Frak context
+ */
+declare function parse({
+  url
+}: {
+  url: string;
+}): FrakContext | null | undefined;
+/**
+ * Populate the current url with the given Frak context
+ * @param args
+ * @param args.url - The url to update
+ * @param args.context - The context to update
+ * @returns The new url with the Frak context
+ */
+declare function update({
+  url,
+  context
+}: {
+  url?: string;
+  context: Partial<FrakContext>;
+}): string | null;
+/**
+ * Remove Frak context from current url
+ * @param url - The url to update
+ * @returns The new url without the Frak context
+ */
+declare function remove(url: string): string;
+/**
+ * Replace the current url with the given Frak context
+ * @param args
+ * @param args.url - The url to update
+ * @param args.context - The context to update
+ */
+declare function replaceUrl({
+  url: baseUrl,
+  context
+}: {
+  url?: string;
+  context: Partial<FrakContext> | null;
+}): void;
+/**
+ * Export our frak context
+ */
+declare const FrakContextManager: {
+  compress: typeof compress;
+  decompress: typeof decompress;
+  parse: typeof parse;
+  update: typeof update;
+  remove: typeof remove;
+  replaceUrl: typeof replaceUrl;
+};
+//#endregion
+//#region src/utils/formatAmount.d.ts
+declare function formatAmount(amount: number, currency?: Currency): string;
+//#endregion
+//#region src/utils/getCurrencyAmountKey.d.ts
+/**
+ * Get the currency amount key for a given currency
+ * @param currency - The currency to use
+ * @returns The currency amount key
+ */
+declare function getCurrencyAmountKey(currency?: Currency): keyof TokenAmountType;
+//#endregion
+//#region src/utils/getSupportedCurrency.d.ts
+/**
+ * Get the supported currency for a given currency
+ * @param currency - The currency to use
+ * @returns The supported currency
+ */
+declare function getSupportedCurrency(currency?: Currency): Currency;
+//#endregion
+//#region src/utils/getSupportedLocale.d.ts
+/**
+ * Get the supported locale for a given currency
+ * @param currency - The currency to use
+ * @returns The supported locale
+ */
+declare function getSupportedLocale(currency?: Currency): (typeof locales)[LocalesKey];
+//#endregion
+//#region src/utils/iframeHelper.d.ts
+/**
+ * Base props for the iframe
+ * @ignore
+ */
+declare const baseIframeProps: {
+  id: string;
+  name: string;
+  title: string;
+  allow: string;
+  style: {
+    width: string;
+    height: string;
+    border: string;
+    position: string;
+    zIndex: number;
+    top: string;
+    left: string;
+    colorScheme: string;
+  };
+};
+/**
+ * Create the Frak iframe
+ * @param args
+ * @param args.walletBaseUrl - Use `config.walletUrl` instead. Will be removed in future versions.
+ * @param args.config - The configuration object containing iframe options, including the replacement for `walletBaseUrl`.
+ */
+declare function createIframe({
+  walletBaseUrl,
+  config
+}: {
+  walletBaseUrl?: string;
+  config?: FrakWalletSdkConfig;
+}): Promise<HTMLIFrameElement | undefined>;
+/**
+ * Find an iframe within window.opener by pathname
+ *
+ * When a popup is opened via window.open from an iframe, window.opener points to
+ * the parent window, not the iframe itself. This utility searches through all frames
+ * in window.opener to find an iframe matching the specified pathname.
+ *
+ * @param pathname - The pathname to search for (default: "/listener")
+ * @returns The matching iframe window, or null if not found
+ *
+ * @example
+ * ```typescript
+ * // Find the default /listener iframe
+ * const listenerIframe = findIframeInOpener();
+ *
+ * // Find a custom iframe
+ * const customIframe = findIframeInOpener("/my-custom-iframe");
+ * ```
+ */
+declare function findIframeInOpener(pathname?: string): Window | null;
+//#endregion
+//#region src/utils/sso.d.ts
+type AppSpecificSsoMetadata = SsoMetadata & {
+  name: string;
+  css?: string;
+};
+/**
+ * The full SSO params that will be used for compression
+ */
+type FullSsoParams = Omit<PrepareSsoParamsType, "metadata"> & {
+  metadata: AppSpecificSsoMetadata;
+  productId: Hex;
+};
+/**
+ * Generate SSO URL with compressed parameters
+ * This mirrors the wallet's getOpenSsoLink() function
+ *
+ * @param walletUrl - Base wallet URL (e.g., "https://wallet.frak.id")
+ * @param params - SSO parameters
+ * @param productId - Product identifier
+ * @param name - Application name
+ * @param css - Optional custom CSS
+ * @returns Complete SSO URL ready to open in popup or redirect
+ *
+ * @example
+ * ```ts
+ * const ssoUrl = generateSsoUrl(
+ *   "https://wallet.frak.id",
+ *   { metadata: { logoUrl: "..." }, directExit: true },
+ *   "0x123...",
+ *   "My App"
+ * );
+ * // Returns: https://wallet.frak.id/sso?p=<compressed_base64>
+ * ```
+ */
+declare function generateSsoUrl(walletUrl: string, params: PrepareSsoParamsType, productId: Hex, name: string, css?: string): string;
+/**
+ * Type of compressed the sso data
+ */
+type CompressedSsoData = {
+  id?: Hex;
+  r?: string;
+  d?: boolean;
+  l?: "en" | "fr";
+  p: Hex;
+  m: {
+    n: string;
+    css?: string;
+    l?: string;
+    h?: string;
+  };
+};
+//#endregion
+//#region src/utils/trackEvent.d.ts
+type FrakEvent = "share_button_clicked" | "wallet_button_clicked" | "share_modal_error" | "user_referred";
+type EventProps = Record<string, unknown>;
+declare function trackEvent(client: FrakClient | undefined, event: FrakEvent, props?: EventProps): void;
+//#endregion
+export { CompressedData as C, createIFrameFrakClient as S, KeyProvider as T, base64urlEncode as _, generateSsoUrl as a, setupClient as b, findIframeInOpener as c, getCurrencyAmountKey as d, formatAmount as f, base64urlDecode as g, compressJsonToB64 as h, FullSsoParams as i, getSupportedLocale as l, decompressJsonFromB64 as m, AppSpecificSsoMetadata as n, baseIframeProps as o, FrakContextManager as p, CompressedSsoData as r, createIframe as s, trackEvent as t, getSupportedCurrency as u, LocalesKey as v, HashProtectedData as w, DebugInfoGatherer as x, locales as y };