@frak-labs/core-sdk 0.0.9 → 0.0.10

package/dist/index.d.cts

@@ -4,6 +4,20 @@ import type { Prettify } from 'viem/chains';
 import type { RpcSchema } from 'viem';
 import type { SiweMessage } from 'viem/siwe';
 
+/**
+ * Decode a base64url encoded string
+ * @param value The value to decode
+ * @returns The decoded value
+ */
+export declare function base64urlDecode(value: string): Uint8Array;
+
+/**
+ * Encode a buffer to a base64url encoded string
+ * @param buffer The buffer to encode
+ * @returns The encoded string
+ */
+export declare function base64urlEncode(buffer: Uint8Array): string;
+
 /**
  * Base props for the iframe
  * @ignore
@@ -27,7 +41,7 @@ export declare const baseIframeProps: {
  * Event related to the iframe lifecycle
  * @ignore
  */
-export declare type ClientLifecycleEvent = CustomCssEvent | RestoreBackupEvent | HearbeatEvent | HandshakeResponse;
+export declare type ClientLifecycleEvent = CustomCssEvent | CustomI18nEvent | RestoreBackupEvent | HearbeatEvent | HandshakeResponse;
 
 /** @ignore */
 export declare class ClientNotFound extends FrakRpcError {
@@ -46,17 +60,21 @@ declare function compress(context?: Partial<FrakContext>): string | undefined;
  *  -> The encoded should contain a HashProtectedData once decoded
  *  @ignore
  */
-export declare type CompressedData = Readonly<{
-    compressed: string;
-    compressedHash: string;
-}>;
+export declare type CompressedData = Uint8Array;
+
+/**
+ * Compress json data
+ * @param data
+ * @ignore
+ */
+export declare function compressJson(data: unknown): Uint8Array;
 
 /**
  * Compress json data
  * @param data
  * @ignore
  */
-export declare function compressJson(data: unknown): Promise<string>;
+export declare function compressJsonToB64(data: unknown): string;
 
 /**
  * Create the Frak iframe
@@ -92,6 +110,7 @@ export declare function createIFrameFrakClient({ config, iframe, }: {
 
 /**
  * All the currencies available
+ * @category Config
  */
 export declare type Currency = "eur" | "usd" | "gbp";
 
@@ -102,6 +121,13 @@ declare type CustomCssEvent = {
     };
 };
 
+declare type CustomI18nEvent = {
+    clientLifecycle: "modal-i18n";
+    data: {
+        i18n: I18nConfig;
+    };
+};
+
 /** @ignore */
 export declare class DebugInfoGatherer {
     private config?;
@@ -139,14 +165,21 @@ declare function decompress(context?: string): FrakContext | undefined;
  * @param compressedData The params to encode
  * @ignore
  */
-export declare function decompressDataAndCheckHash<T>(compressedData: CompressedData): Promise<HashProtectedData<T>>;
+export declare function decompressDataAndCheckHash<T>(compressedData: CompressedData): HashProtectedData<T>;
+
+/**
+ * Decompress json data
+ * @param data
+ * @ignore
+ */
+export declare function decompressJson<T>(data: Uint8Array): T | null;
 
 /**
  * Decompress json data
  * @param data
  * @ignore
  */
-export declare function decompressJson<T>(data: string): Promise<T | null>;
+export declare function decompressJsonFromB64<T>(data: string): T | null;
 
 /**
  * Simple deferred promise wrapper
@@ -163,31 +196,31 @@ export declare class Deferred<T> {
 }
 
 /**
- * The params used to display the embeded wallet
+ * The params used to display the embedded wallet
  *
- * @group Embeded wallet
+ * @group Embedded wallet
  */
 export declare type DisplayEmbededWalletParamsType = {
     /**
-     * The embeded view to display once the user is logged in
+     * The embedded view to display once the user is logged in
      */
     loggedIn?: LoggedInEmbededView;
     /**
-     * The embeded view to display once the user is logged out
+     * The embedded view to display once the user is logged out
      */
     loggedOut?: LoggedOutEmbededView;
     /**
-     * Some metadata to customise the embeded view
+     * Some metadata to customize the embedded view
      */
     metadata?: {
         /**
-         * The logo to display on the embeded wallet
+         * The logo to display on the embedded wallet
          * If undefined, will default to no logo displayed
          */
         logo?: string;
         /**
          * Link to the homepage of the calling website
-         * If unedfined, will default to the domain of the calling website
+         * If undefined, will default to the domain of the calling website
          */
         homepageLink?: string;
         /**
@@ -198,6 +231,10 @@ export declare type DisplayEmbededWalletParamsType = {
          * The position of the component
          */
         position?: "left" | "right";
+        /**
+         * Some i18n override for the displayed modal (i.e. update the displayed text only for this modal)
+         */
+        i18n?: I18nConfig;
     };
 };
 
@@ -219,9 +256,9 @@ declare type DoBackupEvent = {
 };
 
 /**
- * The different type of action we can have on the embeded view (once the user is logged in)
+ * The different type of action we can have on the embedded view (once the user is logged in)
  *
- * @group Embeded wallet
+ * @group Embedded wallet
  */
 export declare type EmbededViewAction = {
     key: "sharing";
@@ -231,11 +268,13 @@ export declare type EmbededViewAction = {
     options?: {
         /**
          * The title that will be displayed on the system popup once the system sharing window is open
+         * @deprecated Use the top level `config.metadata.i18n` instead
          */
         popupTitle?: string;
         /**
          * The text that will be shared alongside the link.
          * Can contain the variable {LINK} to specify where the link is placed, otherwise it will be added at the end
+         * @deprecated Use the top level `config.metadata.i18n` instead
          */
         text?: string;
         /**
@@ -280,7 +319,13 @@ export declare type ExtractedReturnTypeFromRpc<TRpcSchema extends RpcSchema, TPa
 export declare type FinalActionType = {
     key: "sharing";
     options?: {
+        /**
+         * @deprecated Use the top level `config.metadata.i18n` instead
+         */
         popupTitle?: string;
+        /**
+         * @deprecated Use the top level `config.metadata.i18n` instead
+         */
         text?: string;
         link?: string;
     };
@@ -319,6 +364,8 @@ export declare type FrakClient = {
  * The current Frak Context
  *
  * For now, only contain a referrer address.
+ *
+ * @ignore
  */
 export declare type FrakContext = {
     r: Address;
@@ -347,7 +394,8 @@ export declare class FrakRpcError<T = undefined> extends Error {
 }
 
 /**
- * Configuration for the Nexus Wallet SDK
+ * Configuration for the Frak Wallet SDK
+ * @category Config
  */
 export declare type FrakWalletSdkConfig = {
     /**
@@ -363,20 +411,37 @@ export declare type FrakWalletSdkConfig = {
          * Your application name (will be displayed in a few modals and in SSO)
          */
         name: string;
-        /**
-         * Custom CSS styles to apply to the modals and components
-         */
-        css?: string;
         /**
          * Language to display in the modal
          * If undefined, will default to the browser language
          */
-        lang?: "fr" | "en";
+        lang?: Language;
         /**
          * The currency to display in the modal
          * @defaultValue `"eur"`
          */
         currency?: Currency;
+        /**
+         * The logo URL that will be displayed in a few components
+         */
+        logoUrl?: string;
+        /**
+         * The homepage link that could be displayed in a few components
+         */
+        homepageLink?: string;
+    };
+    /**
+     * Some customization for the modal
+     */
+    customizations?: {
+        /**
+         * Custom CSS styles to apply to the modals and components
+         */
+        css?: `${string}.css`;
+        /**
+         * Custom i18n configuration for the modal
+         */
+        i18n?: I18nConfig;
     };
     /**
      * The domain name of your application
@@ -491,7 +556,7 @@ declare type HandshakeResponse = {
  * @param data The params to encode
  * @ignore
  */
-export declare function hashAndCompressData<T>(data: T): Promise<CompressedData>;
+export declare function hashAndCompressData<T>(data: T): CompressedData;
 
 /**
  * The encoded data to send to a client / received by a client
@@ -505,6 +570,41 @@ declare type HearbeatEvent = {
     clientLifecycle: "heartbeat";
 };
 
+/**
+ * Custom i18n configuration for the modal
+ *  See [i18next json format](https://www.i18next.com/misc/json-format#i18next-json-v4)
+ *
+ * Available variables
+ *  - `{{ productName }}` : The name of your website (`metadata.name`)
+ *  - `{{ productOrigin }}` : The origin url of your website
+ *  - `{{ estimatedReward }}` : The estimated reward for the user (based on the specific `targetInteraction` you can specify, or the max referrer reward if no target interaction is specified)
+ *
+ * Context of the translation [see i18n context](https://www.i18next.com/translation-function/context)
+ *  - For modal display, the key of the final action (`sharing`, `reward`, or undefined)
+ *  - For embedded wallet display, the key of the logged in action (`sharing` or undefined)
+ *
+ * @example
+ * ```ts
+ * // Multi language config
+ * const multiI18n = {
+ *  fr: {
+ *      "sdk.modal.title": "Titre de modal",
+ *      "sdk.modal.description": "Description de modal, avec {{ estimatedReward }} de gains possible",
+ *  },
+ *  en: "https://example.com/en.json"
+ * }
+ *
+ * // Single language config
+ * const singleI18n = {
+ *      "sdk.modal.title": "Modal title",
+ *      "sdk.modal.description": "Modal description, with {{ estimatedReward }} of gains possible",
+ * }
+ * ```
+ *
+ * @category Config
+ */
+export declare type I18nConfig = Record<Language, LocalizedI18nConfig> | LocalizedI18nConfig;
+
 /**
  * Represent an iframe event
  */
@@ -525,10 +625,7 @@ export declare type IFrameLifecycleEvent = {
 export declare type IFrameRpcEvent = {
     id: string;
     topic: ExtractedParametersFromRpc<IFrameRpcSchema>["method"];
-    data: {
-        compressed: string;
-        compressedHash: string;
-    };
+    data: CompressedData;
 };
 
 /**
@@ -581,7 +678,8 @@ export declare type IFrameRpcSchema = [
     Method: "frak_displayModal";
     Parameters: [
     requests: ModalRpcStepsInput,
-    metadata: FrakWalletSdkConfig["metadata"] & ModalRpcMetadata
+    metadata: ModalRpcMetadata | undefined,
+    configMetadata: FrakWalletSdkConfig["metadata"]
     ];
     ReturnType: ModalRpcStepsResultType;
 },
@@ -622,12 +720,12 @@ export declare type IFrameRpcSchema = [
     ReturnType: GetProductInformationReturnType;
 },
 /**
-* Method to show the embeded wallet, with potential customisation
+* Method to show the embedded wallet, with potential customization
 */
     {
     Method: "frak_displayEmbededWallet";
     Parameters: [
-    DisplayEmbededWalletParamsType,
+    request: DisplayEmbededWalletParamsType,
     metadata: FrakWalletSdkConfig["metadata"]
     ];
     ReturnType: undefined;
@@ -703,6 +801,12 @@ export declare type InteractionTypesKey = {
  */
 export declare type KeyProvider<DataType> = (value: DataType) => string[];
 
+/**
+ * All the languages available
+ * @category Config
+ */
+export declare type Language = "fr" | "en";
+
 /**
  * Type used for a listening request
  * @inline
@@ -725,13 +829,21 @@ export declare const locales: {
 export declare type LocalesKey = keyof typeof locales;
 
 /**
- * Some configuration options for the embeded view
+ * A localized i18n config
+ * @category Config
+ */
+export declare type LocalizedI18nConfig = `${string}.css` | {
+    [key: string]: string;
+};
+
+/**
+ * Some configuration options for the embedded view
  *
- * @group Embeded wallet
+ * @group Embedded wallet
  */
 export declare type LoggedInEmbededView = {
     /**
-     * The main action to display on the logged in embeded view
+     * The main action to display on the logged in embedded view
      *  If none specified, the user will see his wallet with the activation button
      */
     action?: EmbededViewAction;
@@ -739,26 +851,28 @@ export declare type LoggedInEmbededView = {
 
 /**
  * The view when a user is logged out
- * @group Embeded wallet
+ * @group Embedded wallet
  */
 export declare type LoggedOutEmbededView = {
     /**
-     * Metadata option when displaying the embeded view
+     * Metadata option when displaying the embedded view
      */
     metadata?: {
         /**
          * The main CTA for the logged out view
          *  - can include some variable, available ones are:
-         *      - {REWARD} -> The maximum reward a user can receive when itneracting on your website
+         *      - {REWARD} -> The maximum reward a user can receive when interacting on your website
          *  - can be formatted in markdown
          *
-         * If not sert, it will default to a internalised message
+         * If not set, it will default to a internationalized message
+         * @deprecated Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
          */
         text?: string;
         /**
          * The text that will be displayed on the login button
          *
-         * If not set, it will default to a internalised message
+         * If not set, it will default to a internationalized message
+         * @deprecated Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
          */
         buttonText?: string;
     };
@@ -785,7 +899,7 @@ declare type LoginWithoutSso = {
 /** @inline */
 declare type LoginWithSso = {
     allowSso: true;
-    ssoMetadata: SsoMetadata;
+    ssoMetadata?: SsoMetadata;
 };
 
 /**
@@ -798,10 +912,16 @@ export declare type ModalRpcMetadata = {
         title?: string;
         icon?: string;
     };
-    context?: string;
     targetInteraction?: FullInteractionTypesKey;
+    /**
+     * Some i18n override for the displayed modal (i.e. update the displayed text only for this modal)
+     */
+    i18n?: I18nConfig;
 } & ({
     isDismissible: true;
+    /**
+     * @deprecated Use `config.customizations.i18n` or `metadata.i18n` instead
+     */
     dismissActionTxt?: string;
 } | {
     isDismissible?: false;
@@ -835,29 +955,34 @@ export declare type ModalRpcStepsResultType<T extends ModalStepTypes[] = ModalSt
 };
 
 /**
- * Metadata that can be used to customise a modal step
+ * Metadata that can be used to customize a modal step
  * @group Modal Display
+ * @deprecated Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
  */
 export declare type ModalStepMetadata = {
     metadata?: {
         /**
          * Custom title for the step
-         * If none provided, it will use an internationalised text
+         * If none provided, it will use an internationalized text
+         * @deprecated Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
          */
         title?: string;
         /**
          * Custom description for the step
-         * If none provided, it will use an internationalised text
+         * If none provided, it will use an internationalized text
+         * @deprecated Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
          */
         description?: string;
         /**
          * Custom text for the primary action of the step
-         * If none provided, it will use an internationalised text
+         * If none provided, it will use an internationalized text
+         * @deprecated Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
          */
         primaryActionText?: string;
         /**
          * Custom text for the secondary action of the step
-         * If none provided, it will use an internationalised text
+         * If none provided, it will use an internationalized text
+         * @deprecated Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
          */
         secondaryActionText?: string;
     };