@frak-labs/core-sdk 0.0.2 → 0.0.5

package/dist/{context-GkNATUkF.d.cts → context-C7RkT8hA.d.cts}

@@ -37,9 +37,9 @@ type FrakWalletSdkConfig = {
  * @ignore
  */
 type IFrameLifecycleEvent = {
-    iframeLifecycle: "connected" | "heartbeat" | "show" | "hide";
+    iframeLifecycle: "connected" | "show" | "hide";
     data?: never;
-} | DoBackupEvent | RemoveBackupEvent;
+} | DoBackupEvent | RemoveBackupEvent | HandshakeRequestEvent;
 type DoBackupEvent = {
     iframeLifecycle: "do-backup";
     data: {
@@ -49,12 +49,18 @@ type DoBackupEvent = {
 type RemoveBackupEvent = {
     iframeLifecycle: "remove-backup";
 };
+type HandshakeRequestEvent = {
+    iframeLifecycle: "handshake";
+    data: {
+        token: string;
+    };
+};
 
 /**
  * Event related to the iframe lifecycle
  * @ignore
  */
-type ClientLifecycleEvent = CustomCssEvent | RestoreBackupEvent;
+type ClientLifecycleEvent = CustomCssEvent | RestoreBackupEvent | HearbeatEvent | HandshakeResponse;
 type CustomCssEvent = {
     clientLifecycle: "modal-css";
     data: {
@@ -67,6 +73,59 @@ type RestoreBackupEvent = {
         backup: string;
     };
 };
+type HearbeatEvent = {
+    clientLifecycle: "heartbeat";
+};
+type HandshakeResponse = {
+    clientLifecycle: "handshake-response";
+    data: {
+        token: string;
+        currentUrl: string;
+    };
+};
+
+/**
+ * The final keys for each interaction types (e.g. `openArticle`) -> interaction type
+ * @inline
+ */
+type InteractionTypesKey = {
+    [K in keyof typeof interactionTypes]: keyof (typeof interactionTypes)[K];
+}[keyof typeof interactionTypes];
+/**
+ * The keys for each interaction types (e.g. `press.openArticle`) -> category_type.interaction_type
+ * @inline
+ */
+type FullInteractionTypesKey = {
+    [Category in keyof typeof interactionTypes]: `${Category & string}.${keyof (typeof interactionTypes)[Category] & string}`;
+}[keyof typeof interactionTypes];
+/**
+ * Each interactions types according to the product types
+ */
+declare const interactionTypes: {
+    readonly press: {
+        readonly openArticle: "0xc0a24ffb";
+        readonly readArticle: "0xd5bd0fbe";
+    };
+    readonly dapp: {
+        readonly proofVerifiableStorageUpdate: "0x2ab2aeef";
+        readonly callableVerifiableStorageUpdate: "0xa07da986";
+    };
+    readonly webshop: {
+        readonly open: "0xb311798f";
+    };
+    readonly referral: {
+        readonly referred: "0x010cc3b9";
+        readonly createLink: "0xb2c0f17c";
+    };
+    readonly purchase: {
+        readonly started: "0xd87e90c3";
+        readonly completed: "0x8403aeb4";
+        readonly unsafeCompleted: "0x4d5b14e0";
+    };
+    readonly retail: {
+        readonly customerMeeting: "0x74489004";
+    };
+};
 
 /**
  * SSO Metadata
@@ -80,23 +139,6 @@ type SsoMetadata = {
      * Link to your homepage, if referenced your app name will contain a link on the sso page
      */
     homepageLink?: string;
-    /**
-     * A few links that will be displayed in the footer
-     */
-    links?: {
-        /**
-         * URL to your confidentiality page
-         */
-        confidentialityLink?: string;
-        /**
-         * URL to your help page
-         */
-        helpLink?: string;
-        /**
-         * URL to your CGU page
-         */
-        cguLink?: string;
-    };
 };
 /**
  * Params to start a SSO
@@ -327,6 +369,7 @@ type ModalRpcMetadata = {
     };
     context?: string;
     lang?: "en" | "fr";
+    targetInteraction?: FullInteractionTypesKey;
 } & ({
     isDismissible: true;
     dismissActionTxt?: string;
@@ -344,6 +387,112 @@ type DisplayModalParamsType<T extends ModalStepTypes[]> = {
     metadata?: ModalRpcMetadata;
 };
 
+/**
+ * The different type of action we can have on the embeded view (once the user is logged in)
+ *
+ * @group Embeded wallet
+ */
+type EmbededViewAction = {
+    key: "sharing";
+    /**
+     * Some sharing options
+     */
+    options?: {
+        /**
+         * The title that will be displayed on the system popup once the system sharing window is open
+         */
+        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
+         */
+        text?: string;
+        /**
+         * The link to be shared (will be suffixed with the Frak sharing context)
+         */
+        link?: string;
+    };
+};
+/**
+ * Some configuration options for the embeded view
+ *
+ * @group Embeded wallet
+ */
+type LoggedInEmbededView = {
+    /**
+     * The main action to display on the logged in embeded view
+     *  If none specified, the user will see his wallet with the activation button
+     */
+    action?: EmbededViewAction;
+};
+
+/**
+ * The view when a user is logged out
+ * @group Embeded wallet
+ */
+type LoggedOutEmbededView = {
+    /**
+     * Metadata option when displaying the embeded 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
+         *  - can be formatted in markdown
+         *
+         * If not sert, it will default to a internalised message
+         */
+        text?: string;
+        /**
+         * The text that will be displayed on the login button
+         *
+         * If not set, it will default to a internalised message
+         */
+        buttonText?: string;
+    };
+};
+
+/**
+ * The params used to display the embeded wallet
+ *
+ * @group Embeded wallet
+ */
+type DisplayEmbededWalletParamsType = {
+    /**
+     * The embeded view to display once the user is logged in
+     */
+    loggedIn?: LoggedInEmbededView;
+    /**
+     * The embeded view to display once the user is logged out
+     */
+    loggedOut?: LoggedOutEmbededView;
+    /**
+     * Some metadata to customise the embeded view
+     */
+    metadata?: {
+        /**
+         * Language of the embeded wallet
+         * If undefined, will default to the browser language
+         */
+        lang?: "fr" | "en";
+        /**
+         * The logo to display on the embeded 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
+         */
+        homepageLink?: string;
+        /**
+         * The target interaction behind this modal
+         */
+        targetInteraction?: FullInteractionTypesKey;
+    };
+};
+
 /**
  * The keys for each product types
  * @inline
@@ -356,6 +505,7 @@ declare const productTypes: {
     dapp: number;
     press: number;
     webshop: number;
+    retail: number;
     referral: number;
     purchase: number;
 };
@@ -391,9 +541,27 @@ type GetProductInformationReturnType = {
         productTypes: ProductTypesKey[];
     };
     /**
-     * Current the current estimated product reward
+     * The max potential reward in EUR for the given product
      */
     estimatedEurReward?: string;
+    /**
+     * List of all the potentials reward arround this product
+     */
+    rewards: {
+        token: Address;
+        campaign: Address;
+        interactionTypeKey: FullInteractionTypesKey;
+        referrer: {
+            amount: number;
+            eurAmount: number;
+            usdAmount: number;
+        };
+        referee: {
+            amount: number;
+            eurAmount: number;
+            usdAmount: number;
+        };
+    }[];
 };
 
 /**
@@ -454,6 +622,10 @@ type WalletNotConnected = {
  *  ### frak_getProductInformation
  *  - Params: None
  *  - Returns: {@link GetProductInformationReturnType}
+ *
+ * ### frak_displayEmbededWallet
+ * - Params: [{@link DisplayEmbededWalletParamsType}]
+ * - Returns: undefined
  */
 type IFrameRpcSchema = [
     /**
@@ -465,7 +637,7 @@ type IFrameRpcSchema = [
         ReturnType: WalletStatusReturnType;
     },
     /**
-     * Method to transmit a user interaction
+     * Method to display a modal with the provided steps
      */
     {
         Method: "frak_displayModal";
@@ -511,6 +683,14 @@ type IFrameRpcSchema = [
         Method: "frak_getProductInformation";
         Parameters?: undefined;
         ReturnType: GetProductInformationReturnType;
+    },
+    /**
+     * Method to show the embeded wallet, with potential customisation
+     */
+    {
+        Method: "frak_displayEmbededWallet";
+        Parameters: [DisplayEmbededWalletParamsType, name: string];
+        ReturnType: undefined;
     }
 ];
 
@@ -612,6 +792,9 @@ type IFrameRpcEvent = {
  */
 type FrakClient = {
     config: FrakWalletSdkConfig;
+    debugInfo: {
+        formatDebugInfo: (error: Error | unknown | string) => string;
+    };
 } & IFrameTransport;
 
 /**
@@ -623,4 +806,4 @@ type FrakContext = {
     r: Address;
 };
 
-export { type ClientLifecycleEvent as C, type DisplayModalParamsType as D, type ExtractedParametersFromRpc as E, type FrakWalletSdkConfig as F, type GetProductInformationReturnType as G, type IFrameRpcSchema as I, type LoginModalStepType as L, type ModalStepTypes as M, type OpenSsoParamsType as O, type ProductTypesKey as P, type RpcResponse as R, type SsoMetadata as S, type WalletStatusReturnType as W, type FrakClient as a, type FrakContext as b, productTypesMask as c, type ModalRpcMetadata as d, type ModalRpcStepsInput as e, type ModalRpcStepsResultType as f, type ModalStepMetadata as g, type SiweAuthenticateModalStepType as h, type SiweAuthenticationParams as i, type SiweAuthenticateReturnType as j, type SendTransactionTxType as k, type SendTransactionModalStepType as l, type SendTransactionReturnType as m, type OpenInteractionSessionReturnType as n, type OpenInteractionSessionModalStepType as o, productTypes as p, type FinalModalStepType as q, type FinalActionType as r, type IFrameTransport as s, type IFrameRpcEvent as t, type IFrameEvent as u, type IFrameLifecycleEvent as v, type ExtractedReturnTypeFromRpc as w };
+export { type IFrameRpcEvent as A, type IFrameLifecycleEvent as B, type ClientLifecycleEvent as C, type DisplayEmbededWalletParamsType as D, type EmbededViewAction as E, type FrakWalletSdkConfig as F, type GetProductInformationReturnType as G, type ExtractedParametersFromRpc as H, type IFrameEvent as I, type ExtractedReturnTypeFromRpc as J, type LoggedOutEmbededView as L, type ModalStepTypes as M, type OpenSsoParamsType as O, type ProductTypesKey as P, type RpcResponse as R, type SsoMetadata as S, type WalletStatusReturnType as W, type FrakClient as a, type FrakContext as b, productTypesMask as c, type InteractionTypesKey as d, type FullInteractionTypesKey as e, type IFrameRpcSchema as f, type LoggedInEmbededView as g, type ModalRpcMetadata as h, interactionTypes as i, type DisplayModalParamsType as j, type ModalRpcStepsInput as k, type ModalRpcStepsResultType as l, type ModalStepMetadata as m, type LoginModalStepType as n, type SiweAuthenticateModalStepType as o, productTypes as p, type SiweAuthenticationParams as q, type SiweAuthenticateReturnType as r, type SendTransactionTxType as s, type SendTransactionModalStepType as t, type SendTransactionReturnType as u, type OpenInteractionSessionReturnType as v, type OpenInteractionSessionModalStepType as w, type FinalModalStepType as x, type FinalActionType as y, type IFrameTransport as z };

package/dist/{context-B0trlYGx.d.ts → context-CJ5ByAXa.d.ts}

@@ -37,9 +37,9 @@ type FrakWalletSdkConfig = {
  * @ignore
  */
 type IFrameLifecycleEvent = {
-    iframeLifecycle: "connected" | "heartbeat" | "show" | "hide";
+    iframeLifecycle: "connected" | "show" | "hide";
     data?: never;
-} | DoBackupEvent | RemoveBackupEvent;
+} | DoBackupEvent | RemoveBackupEvent | HandshakeRequestEvent;
 type DoBackupEvent = {
     iframeLifecycle: "do-backup";
     data: {
@@ -49,12 +49,18 @@ type DoBackupEvent = {
 type RemoveBackupEvent = {
     iframeLifecycle: "remove-backup";
 };
+type HandshakeRequestEvent = {
+    iframeLifecycle: "handshake";
+    data: {
+        token: string;
+    };
+};
 
 /**
  * Event related to the iframe lifecycle
  * @ignore
  */
-type ClientLifecycleEvent = CustomCssEvent | RestoreBackupEvent;
+type ClientLifecycleEvent = CustomCssEvent | RestoreBackupEvent | HearbeatEvent | HandshakeResponse;
 type CustomCssEvent = {
     clientLifecycle: "modal-css";
     data: {
@@ -67,6 +73,59 @@ type RestoreBackupEvent = {
         backup: string;
     };
 };
+type HearbeatEvent = {
+    clientLifecycle: "heartbeat";
+};
+type HandshakeResponse = {
+    clientLifecycle: "handshake-response";
+    data: {
+        token: string;
+        currentUrl: string;
+    };
+};
+
+/**
+ * The final keys for each interaction types (e.g. `openArticle`) -> interaction type
+ * @inline
+ */
+type InteractionTypesKey = {
+    [K in keyof typeof interactionTypes]: keyof (typeof interactionTypes)[K];
+}[keyof typeof interactionTypes];
+/**
+ * The keys for each interaction types (e.g. `press.openArticle`) -> category_type.interaction_type
+ * @inline
+ */
+type FullInteractionTypesKey = {
+    [Category in keyof typeof interactionTypes]: `${Category & string}.${keyof (typeof interactionTypes)[Category] & string}`;
+}[keyof typeof interactionTypes];
+/**
+ * Each interactions types according to the product types
+ */
+declare const interactionTypes: {
+    readonly press: {
+        readonly openArticle: "0xc0a24ffb";
+        readonly readArticle: "0xd5bd0fbe";
+    };
+    readonly dapp: {
+        readonly proofVerifiableStorageUpdate: "0x2ab2aeef";
+        readonly callableVerifiableStorageUpdate: "0xa07da986";
+    };
+    readonly webshop: {
+        readonly open: "0xb311798f";
+    };
+    readonly referral: {
+        readonly referred: "0x010cc3b9";
+        readonly createLink: "0xb2c0f17c";
+    };
+    readonly purchase: {
+        readonly started: "0xd87e90c3";
+        readonly completed: "0x8403aeb4";
+        readonly unsafeCompleted: "0x4d5b14e0";
+    };
+    readonly retail: {
+        readonly customerMeeting: "0x74489004";
+    };
+};
 
 /**
  * SSO Metadata
@@ -80,23 +139,6 @@ type SsoMetadata = {
      * Link to your homepage, if referenced your app name will contain a link on the sso page
      */
     homepageLink?: string;
-    /**
-     * A few links that will be displayed in the footer
-     */
-    links?: {
-        /**
-         * URL to your confidentiality page
-         */
-        confidentialityLink?: string;
-        /**
-         * URL to your help page
-         */
-        helpLink?: string;
-        /**
-         * URL to your CGU page
-         */
-        cguLink?: string;
-    };
 };
 /**
  * Params to start a SSO
@@ -327,6 +369,7 @@ type ModalRpcMetadata = {
     };
     context?: string;
     lang?: "en" | "fr";
+    targetInteraction?: FullInteractionTypesKey;
 } & ({
     isDismissible: true;
     dismissActionTxt?: string;
@@ -344,6 +387,112 @@ type DisplayModalParamsType<T extends ModalStepTypes[]> = {
     metadata?: ModalRpcMetadata;
 };
 
+/**
+ * The different type of action we can have on the embeded view (once the user is logged in)
+ *
+ * @group Embeded wallet
+ */
+type EmbededViewAction = {
+    key: "sharing";
+    /**
+     * Some sharing options
+     */
+    options?: {
+        /**
+         * The title that will be displayed on the system popup once the system sharing window is open
+         */
+        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
+         */
+        text?: string;
+        /**
+         * The link to be shared (will be suffixed with the Frak sharing context)
+         */
+        link?: string;
+    };
+};
+/**
+ * Some configuration options for the embeded view
+ *
+ * @group Embeded wallet
+ */
+type LoggedInEmbededView = {
+    /**
+     * The main action to display on the logged in embeded view
+     *  If none specified, the user will see his wallet with the activation button
+     */
+    action?: EmbededViewAction;
+};
+
+/**
+ * The view when a user is logged out
+ * @group Embeded wallet
+ */
+type LoggedOutEmbededView = {
+    /**
+     * Metadata option when displaying the embeded 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
+         *  - can be formatted in markdown
+         *
+         * If not sert, it will default to a internalised message
+         */
+        text?: string;
+        /**
+         * The text that will be displayed on the login button
+         *
+         * If not set, it will default to a internalised message
+         */
+        buttonText?: string;
+    };
+};
+
+/**
+ * The params used to display the embeded wallet
+ *
+ * @group Embeded wallet
+ */
+type DisplayEmbededWalletParamsType = {
+    /**
+     * The embeded view to display once the user is logged in
+     */
+    loggedIn?: LoggedInEmbededView;
+    /**
+     * The embeded view to display once the user is logged out
+     */
+    loggedOut?: LoggedOutEmbededView;
+    /**
+     * Some metadata to customise the embeded view
+     */
+    metadata?: {
+        /**
+         * Language of the embeded wallet
+         * If undefined, will default to the browser language
+         */
+        lang?: "fr" | "en";
+        /**
+         * The logo to display on the embeded 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
+         */
+        homepageLink?: string;
+        /**
+         * The target interaction behind this modal
+         */
+        targetInteraction?: FullInteractionTypesKey;
+    };
+};
+
 /**
  * The keys for each product types
  * @inline
@@ -356,6 +505,7 @@ declare const productTypes: {
     dapp: number;
     press: number;
     webshop: number;
+    retail: number;
     referral: number;
     purchase: number;
 };
@@ -391,9 +541,27 @@ type GetProductInformationReturnType = {
         productTypes: ProductTypesKey[];
     };
     /**
-     * Current the current estimated product reward
+     * The max potential reward in EUR for the given product
      */
     estimatedEurReward?: string;
+    /**
+     * List of all the potentials reward arround this product
+     */
+    rewards: {
+        token: Address;
+        campaign: Address;
+        interactionTypeKey: FullInteractionTypesKey;
+        referrer: {
+            amount: number;
+            eurAmount: number;
+            usdAmount: number;
+        };
+        referee: {
+            amount: number;
+            eurAmount: number;
+            usdAmount: number;
+        };
+    }[];
 };
 
 /**
@@ -454,6 +622,10 @@ type WalletNotConnected = {
  *  ### frak_getProductInformation
  *  - Params: None
  *  - Returns: {@link GetProductInformationReturnType}
+ *
+ * ### frak_displayEmbededWallet
+ * - Params: [{@link DisplayEmbededWalletParamsType}]
+ * - Returns: undefined
  */
 type IFrameRpcSchema = [
     /**
@@ -465,7 +637,7 @@ type IFrameRpcSchema = [
         ReturnType: WalletStatusReturnType;
     },
     /**
-     * Method to transmit a user interaction
+     * Method to display a modal with the provided steps
      */
     {
         Method: "frak_displayModal";
@@ -511,6 +683,14 @@ type IFrameRpcSchema = [
         Method: "frak_getProductInformation";
         Parameters?: undefined;
         ReturnType: GetProductInformationReturnType;
+    },
+    /**
+     * Method to show the embeded wallet, with potential customisation
+     */
+    {
+        Method: "frak_displayEmbededWallet";
+        Parameters: [DisplayEmbededWalletParamsType, name: string];
+        ReturnType: undefined;
     }
 ];
 
@@ -612,6 +792,9 @@ type IFrameRpcEvent = {
  */
 type FrakClient = {
     config: FrakWalletSdkConfig;
+    debugInfo: {
+        formatDebugInfo: (error: Error | unknown | string) => string;
+    };
 } & IFrameTransport;
 
 /**
@@ -623,4 +806,4 @@ type FrakContext = {
     r: Address;
 };
 
-export { type ClientLifecycleEvent as C, type DisplayModalParamsType as D, type ExtractedParametersFromRpc as E, type FrakWalletSdkConfig as F, type GetProductInformationReturnType as G, type IFrameRpcSchema as I, type LoginModalStepType as L, type ModalStepTypes as M, type OpenSsoParamsType as O, type ProductTypesKey as P, type RpcResponse as R, type SsoMetadata as S, type WalletStatusReturnType as W, type FrakClient as a, type FrakContext as b, productTypesMask as c, type ModalRpcMetadata as d, type ModalRpcStepsInput as e, type ModalRpcStepsResultType as f, type ModalStepMetadata as g, type SiweAuthenticateModalStepType as h, type SiweAuthenticationParams as i, type SiweAuthenticateReturnType as j, type SendTransactionTxType as k, type SendTransactionModalStepType as l, type SendTransactionReturnType as m, type OpenInteractionSessionReturnType as n, type OpenInteractionSessionModalStepType as o, productTypes as p, type FinalModalStepType as q, type FinalActionType as r, type IFrameTransport as s, type IFrameRpcEvent as t, type IFrameEvent as u, type IFrameLifecycleEvent as v, type ExtractedReturnTypeFromRpc as w };
+export { type IFrameRpcEvent as A, type IFrameLifecycleEvent as B, type ClientLifecycleEvent as C, type DisplayEmbededWalletParamsType as D, type EmbededViewAction as E, type FrakWalletSdkConfig as F, type GetProductInformationReturnType as G, type ExtractedParametersFromRpc as H, type IFrameEvent as I, type ExtractedReturnTypeFromRpc as J, type LoggedOutEmbededView as L, type ModalStepTypes as M, type OpenSsoParamsType as O, type ProductTypesKey as P, type RpcResponse as R, type SsoMetadata as S, type WalletStatusReturnType as W, type FrakClient as a, type FrakContext as b, productTypesMask as c, type InteractionTypesKey as d, type FullInteractionTypesKey as e, type IFrameRpcSchema as f, type LoggedInEmbededView as g, type ModalRpcMetadata as h, interactionTypes as i, type DisplayModalParamsType as j, type ModalRpcStepsInput as k, type ModalRpcStepsResultType as l, type ModalStepMetadata as m, type LoginModalStepType as n, type SiweAuthenticateModalStepType as o, productTypes as p, type SiweAuthenticationParams as q, type SiweAuthenticateReturnType as r, type SendTransactionTxType as s, type SendTransactionModalStepType as t, type SendTransactionReturnType as u, type OpenInteractionSessionReturnType as v, type OpenInteractionSessionModalStepType as w, type FinalModalStepType as x, type FinalActionType as y, type IFrameTransport as z };