@frak-labs/core-sdk 0.0.4 → 0.0.5

package/dist/index.d.ts

@@ -1,10 +1,31 @@
-import { F as FrakWalletSdkConfig, a as FrakClient, b as FrakContext } from './context-DjVVznrf.js';
-export { C as ClientLifecycleEvent, D as DisplayModalParamsType, E as ExtractedParametersFromRpc, w as ExtractedReturnTypeFromRpc, r as FinalActionType, q as FinalModalStepType, G as GetProductInformationReturnType, u as IFrameEvent, v as IFrameLifecycleEvent, t as IFrameRpcEvent, I as IFrameRpcSchema, s as IFrameTransport, L as LoginModalStepType, d as ModalRpcMetadata, e as ModalRpcStepsInput, f as ModalRpcStepsResultType, g as ModalStepMetadata, M as ModalStepTypes, o as OpenInteractionSessionModalStepType, n as OpenInteractionSessionReturnType, O as OpenSsoParamsType, P as ProductTypesKey, R as RpcResponse, l as SendTransactionModalStepType, m as SendTransactionReturnType, k as SendTransactionTxType, h as SiweAuthenticateModalStepType, j as SiweAuthenticateReturnType, i as SiweAuthenticationParams, S as SsoMetadata, W as WalletStatusReturnType, p as productTypes, c as productTypesMask } from './context-DjVVznrf.js';
+import { F as FrakWalletSdkConfig, a as FrakClient, I as IFrameEvent, b as FrakContext } from './context-CJ5ByAXa.js';
+export { C as ClientLifecycleEvent, D as DisplayEmbededWalletParamsType, j as DisplayModalParamsType, E as EmbededViewAction, H as ExtractedParametersFromRpc, J as ExtractedReturnTypeFromRpc, y as FinalActionType, x as FinalModalStepType, e as FullInteractionTypesKey, G as GetProductInformationReturnType, B as IFrameLifecycleEvent, A as IFrameRpcEvent, f as IFrameRpcSchema, z as IFrameTransport, d as InteractionTypesKey, g as LoggedInEmbededView, L as LoggedOutEmbededView, n as LoginModalStepType, h as ModalRpcMetadata, k as ModalRpcStepsInput, l as ModalRpcStepsResultType, m as ModalStepMetadata, M as ModalStepTypes, w as OpenInteractionSessionModalStepType, v as OpenInteractionSessionReturnType, O as OpenSsoParamsType, P as ProductTypesKey, R as RpcResponse, t as SendTransactionModalStepType, u as SendTransactionReturnType, s as SendTransactionTxType, o as SiweAuthenticateModalStepType, r as SiweAuthenticateReturnType, q as SiweAuthenticationParams, S as SsoMetadata, W as WalletStatusReturnType, i as interactionTypes, p as productTypes, c as productTypesMask } from './context-CJ5ByAXa.js';
 export { P as PreparedInteraction, S as SendInteractionParamsType, a as SendInteractionReturnType } from './interaction-CTQ5-kqe.js';
 import 'viem';
 import 'viem/chains';
 import 'viem/siwe';
 
+/**
+ * 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;
+
 /**
  * Generic Frak RPC error
  * @ignore
@@ -58,27 +79,6 @@ type HashProtectedData<DataType> = Readonly<DataType & {
  */
 type KeyProvider<DataType> = (value: DataType) => string[];
 
-/**
- * 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;
-
 /**
  * Directly setup the Frak client with an iframe
  * Return when the FrakClient is ready (setup and communication estbalished with the wallet)
@@ -98,6 +98,31 @@ declare function setupClient({ config, }: {
     config: FrakWalletSdkConfig;
 }): Promise<FrakClient | undefined>;
 
+/** @ignore */
+declare class DebugInfoGatherer {
+    private config?;
+    private iframe?;
+    private isSetupDone;
+    private lastResponse;
+    private lastRequest;
+    constructor(config?: FrakWalletSdkConfig, iframe?: HTMLIFrameElement);
+    setLastResponse(event: MessageEvent<IFrameEvent>): void;
+    setLastRequest(event: IFrameEvent, target: string): 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;
+}
+
 /**
  * Base props for the iframe
  * @ignore
@@ -227,47 +252,4 @@ declare class Deferred<T> {
     reject: (reason?: unknown) => void;
 }
 
-/**
- * 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";
-    };
-};
-
-export { ClientNotFound, type CompressedData, Deferred, FrakClient, FrakContext, FrakContextManager, FrakRpcError, FrakWalletSdkConfig, type FullInteractionTypesKey, type HashProtectedData, type InteractionTypesKey, type KeyProvider, RpcErrorCodes, baseIframeProps, compressJson, createIFrameFrakClient, createIframe, decompressDataAndCheckHash, decompressJson, hashAndCompressData, interactionTypes, setupClient };
+export { ClientNotFound, type CompressedData, DebugInfoGatherer, Deferred, FrakClient, FrakContext, FrakContextManager, FrakRpcError, FrakWalletSdkConfig, type HashProtectedData, IFrameEvent, type KeyProvider, RpcErrorCodes, baseIframeProps, compressJson, createIFrameFrakClient, createIframe, decompressDataAndCheckHash, decompressJson, hashAndCompressData, setupClient };

package/dist/index.js

@@ -1,27 +1,124 @@
-import {
-  ClientNotFound,
-  Deferred,
-  FrakContextManager,
-  FrakRpcError,
-  InternalError,
-  RpcErrorCodes,
-  baseIframeProps,
-  changeIframeVisibility,
-  compressJson,
-  createIframe,
-  decompressDataAndCheckHash,
-  decompressJson,
-  hashAndCompressData
-} from "./chunk-AFLVOY5H.js";
-import {
-  interactionTypes,
-  productTypes,
-  productTypesMask
-} from "./chunk-GDH3M5ZC.js";
+import { createIframe, FrakRpcError, Deferred, RpcErrorCodes, decompressDataAndCheckHash, hashAndCompressData, InternalError, changeIframeVisibility } from './chunk-XDZMP74U.js';
+export { ClientNotFound, Deferred, FrakContextManager, FrakRpcError, RpcErrorCodes, baseIframeProps, compressJson, createIframe, decompressDataAndCheckHash, decompressJson, hashAndCompressData } from './chunk-XDZMP74U.js';
+import { __publicField } from './chunk-GDH3M5ZC.js';
+export { interactionTypes, productTypes, productTypesMask } from './chunk-GDH3M5ZC.js';
 
 // src/utils/constants.ts
 var BACKUP_KEY = "nexus-wallet-backup";
 
+// src/clients/DebugInfo.ts
+var DebugInfoGatherer = class _DebugInfoGatherer {
+  constructor(config, iframe) {
+    __publicField(this, "config");
+    __publicField(this, "iframe");
+    __publicField(this, "isSetupDone", false);
+    __publicField(this, "lastResponse", null);
+    __publicField(this, "lastRequest", null);
+    this.config = config;
+    this.iframe = iframe;
+    this.lastRequest = null;
+    this.lastResponse = null;
+  }
+  // Update communication logs
+  setLastResponse(event) {
+    this.lastResponse = {
+      event: event.data,
+      origin: event.origin,
+      timestamp: Date.now()
+    };
+  }
+  setLastRequest(event, target) {
+    this.lastRequest = { event, target, timestamp: Date.now() };
+  }
+  // Update connection status
+  updateSetupStatus(status) {
+    this.isSetupDone = status;
+  }
+  base64Encode(data) {
+    try {
+      return btoa(JSON.stringify(data));
+    } catch (err) {
+      console.warn("Failed to encode debug data", err);
+      return btoa("Failed to encode data");
+    }
+  }
+  /**
+   * Extract information from the iframe status
+   */
+  getIframeStatus() {
+    var _a;
+    if (!this.iframe) {
+      return null;
+    }
+    return {
+      loading: this.iframe.hasAttribute("loading"),
+      url: this.iframe.src,
+      readyState: ((_a = this.iframe.contentDocument) == null ? undefined : _a.readyState) ? this.iframe.contentDocument.readyState === "complete" ? 1 : 0 : -1,
+      contentWindow: !!this.iframe.contentWindow,
+      isConnected: this.iframe.isConnected
+    };
+  }
+  getNavigatorInfo() {
+    if (!navigator) {
+      return null;
+    }
+    return {
+      userAgent: navigator.userAgent,
+      language: navigator.language,
+      onLine: navigator.onLine,
+      screenWidth: window.screen.width,
+      screenHeight: window.screen.height,
+      pixelRatio: window.devicePixelRatio
+    };
+  }
+  gatherDebugInfo(error) {
+    const iframeStatus = this.getIframeStatus();
+    const navigatorInfo = this.getNavigatorInfo();
+    let formattedError = "Unknown";
+    if (error instanceof FrakRpcError) {
+      formattedError = `FrakRpcError: ${error.code} '${error.message}'`;
+    } else if (error instanceof Error) {
+      formattedError = error.message;
+    } else if (typeof error === "string") {
+      formattedError = error;
+    }
+    const debugInfo = {
+      timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+      encodedUrl: btoa(window.location.href),
+      encodedConfig: this.config ? this.base64Encode(this.config) : "no-config",
+      navigatorInfo: navigatorInfo ? this.base64Encode(navigatorInfo) : "no-navigator",
+      iframeStatus: iframeStatus ? this.base64Encode(iframeStatus) : "not-iframe",
+      lastRequest: this.lastRequest ? this.base64Encode(this.lastRequest) : "No Frak request logged",
+      lastResponse: this.lastResponse ? this.base64Encode(this.lastResponse) : "No Frak response logged",
+      clientStatus: this.isSetupDone ? "setup" : "not-setup",
+      error: formattedError
+    };
+    return debugInfo;
+  }
+  static empty() {
+    return new _DebugInfoGatherer();
+  }
+  /**
+   * Format Frak debug information
+   */
+  formatDebugInfo(error) {
+    const debugInfo = this.gatherDebugInfo(error);
+    return `
+  Debug Information:
+  -----------------
+  Timestamp: ${debugInfo.timestamp}
+  URL: ${debugInfo.encodedUrl}
+  Config: ${debugInfo.encodedConfig}
+  Navigator Info: ${debugInfo.navigatorInfo}
+  IFrame Status: ${debugInfo.iframeStatus}
+  Last Request: ${debugInfo.lastRequest}
+  Last Response: ${debugInfo.lastResponse}
+  Client Status: ${debugInfo.clientStatus}
+  Error: ${debugInfo.error}
+  `.trim();
+  }
+};
+
 // src/clients/transports/iframeChannelManager.ts
 function createIFrameChannelManager() {
   const channels = /* @__PURE__ */ new Map();
@@ -44,6 +141,7 @@ function createIFrameLifecycleManager({
 }) {
   const isConnectedDeferred = new Deferred();
   const handler = async (messageEvent) => {
+    var _a;
     switch (messageEvent.iframeLifecycle) {
       // Resolve the isConnected promise
       case "connected":
@@ -69,6 +167,23 @@ function createIFrameLifecycleManager({
           isVisible: messageEvent.iframeLifecycle === "show"
         });
         break;
+      // Handshake handling
+      case "handshake": {
+        console.log("Received handshake event", {
+          token: messageEvent.data.token
+        });
+        (_a = iframe.contentWindow) == null ? undefined : _a.postMessage(
+          {
+            clientLifecycle: "handshake-response",
+            data: {
+              token: messageEvent.data.token,
+              currentUrl: window.location.href
+            }
+          },
+          "*"
+        );
+        break;
+      }
     }
   };
   return {
@@ -82,7 +197,8 @@ function createIFrameMessageHandler({
   frakWalletUrl,
   iframe,
   channelManager,
-  iframeLifecycleManager
+  iframeLifecycleManager,
+  debugInfo
 }) {
   if (typeof window === "undefined") {
     throw new FrakRpcError(
@@ -97,16 +213,22 @@ function createIFrameMessageHandler({
     );
   }
   const contentWindow = iframe.contentWindow;
-  const msgHandler = async (event) => {
-    if (!(event.origin && URL.canParse(event.origin))) {
+  async function msgHandler(event) {
+    if (!event.origin) {
       return;
     }
-    if (new URL(event.origin).origin.toLowerCase() !== new URL(frakWalletUrl).origin.toLowerCase()) {
+    try {
+      if (new URL(event.origin).origin.toLowerCase() !== new URL(frakWalletUrl).origin.toLowerCase()) {
+        return;
+      }
+    } catch (e) {
+      console.log("Unable to check frak msg origin", e);
       return;
     }
     if (typeof event.data !== "object") {
       return;
     }
+    debugInfo.setLastResponse(event);
     if ("iframeLifecycle" in event.data) {
       await iframeLifecycleManager.handleEvent(event.data);
       return;
@@ -123,16 +245,17 @@ function createIFrameMessageHandler({
       return;
     }
     await resolver(event.data);
-  };
+  }
   window.addEventListener("message", msgHandler);
-  const sendEvent = (message) => {
+  function sendEvent(message) {
     contentWindow.postMessage(message, {
       targetOrigin: frakWalletUrl
     });
-  };
-  const cleanup = () => {
+    debugInfo.setLastRequest(message, frakWalletUrl);
+  }
+  function cleanup() {
     window.removeEventListener("message", msgHandler);
-  };
+  }
   return {
     sendEvent,
     cleanup
@@ -144,13 +267,16 @@ function createIFrameFrakClient({
   config,
   iframe
 }) {
+  var _a;
   const channelManager = createIFrameChannelManager();
   const lifecycleManager = createIFrameLifecycleManager({ iframe });
+  const debugInfo = new DebugInfoGatherer(config, iframe);
   const messageHandler = createIFrameMessageHandler({
-    frakWalletUrl: config?.walletUrl ?? "https://wallet.frak.id",
+    frakWalletUrl: (_a = config == null ? undefined : config.walletUrl) != null ? _a : "https://wallet.frak.id",
     iframe,
     channelManager,
-    iframeLifecycleManager: lifecycleManager
+    iframeLifecycleManager: lifecycleManager,
+    debugInfo
   });
   const request = async (args) => {
     const isConnected = await lifecycleManager.isConnected;
@@ -162,13 +288,14 @@ function createIFrameFrakClient({
     }
     const result = new Deferred();
     const channelId = channelManager.createChannel(async (message) => {
+      var _a2;
       const decompressed = await decompressDataAndCheckHash(message.data);
       if (decompressed.error) {
         result.reject(
           new FrakRpcError(
             decompressed.error.code,
             decompressed.error.message,
-            decompressed.error?.data
+            (_a2 = decompressed.error) == null ? undefined : _a2.data
           )
         );
       } else {
@@ -218,9 +345,10 @@ function createIFrameFrakClient({
     config,
     messageHandler,
     lifecycleManager
-  });
+  }).then(() => debugInfo.updateSetupStatus(true));
   return {
     config,
+    debugInfo,
     waitForConnection: lifecycleManager.isConnected,
     waitForSetup,
     request,
@@ -234,7 +362,7 @@ function setupHeartbeat(messageHandler, lifecycleManager) {
   let heartbeatInterval;
   let timeoutId;
   const sendHeartbeat = () => messageHandler.sendEvent({
-    iframeLifecycle: "heartbeat"
+    clientLifecycle: "heartbeat"
   });
   async function startHeartbeat() {
     sendHeartbeat();
@@ -306,21 +434,5 @@ async function setupClient({
   }
   return client;
 }
-export {
-  ClientNotFound,
-  Deferred,
-  FrakContextManager,
-  FrakRpcError,
-  RpcErrorCodes,
-  baseIframeProps,
-  compressJson,
-  createIFrameFrakClient,
-  createIframe,
-  decompressDataAndCheckHash,
-  decompressJson,
-  hashAndCompressData,
-  interactionTypes,
-  productTypes,
-  productTypesMask,
-  setupClient
-};
+
+export { DebugInfoGatherer, createIFrameFrakClient, setupClient };

package/dist/interactions/index.cjs

@@ -1,15 +1,26 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-
-
-
-
-var _chunkZDGHKI3Scjs = require('../chunk-ZDGHKI3S.cjs');
-require('../chunk-PO6YSB4Q.cjs');
-
-
-
-
-
-
-exports.PressInteractionEncoder = _chunkZDGHKI3Scjs.PressInteractionEncoder; exports.PurchaseInteractionEncoder = _chunkZDGHKI3Scjs.PurchaseInteractionEncoder; exports.ReferralInteractionEncoder = _chunkZDGHKI3Scjs.ReferralInteractionEncoder; exports.RetailInteractionEncoder = _chunkZDGHKI3Scjs.RetailInteractionEncoder; exports.WebShopInteractionEncoder = _chunkZDGHKI3Scjs.WebShopInteractionEncoder;
+'use strict';
+
+var chunkZDGHKI3S_cjs = require('../chunk-ZDGHKI3S.cjs');
+
+
+
+Object.defineProperty(exports, "PressInteractionEncoder", {
+  enumerable: true,
+  get: function () { return chunkZDGHKI3S_cjs.PressInteractionEncoder; }
+});
+Object.defineProperty(exports, "PurchaseInteractionEncoder", {
+  enumerable: true,
+  get: function () { return chunkZDGHKI3S_cjs.PurchaseInteractionEncoder; }
+});
+Object.defineProperty(exports, "ReferralInteractionEncoder", {
+  enumerable: true,
+  get: function () { return chunkZDGHKI3S_cjs.ReferralInteractionEncoder; }
+});
+Object.defineProperty(exports, "RetailInteractionEncoder", {
+  enumerable: true,
+  get: function () { return chunkZDGHKI3S_cjs.RetailInteractionEncoder; }
+});
+Object.defineProperty(exports, "WebShopInteractionEncoder", {
+  enumerable: true,
+  get: function () { return chunkZDGHKI3S_cjs.WebShopInteractionEncoder; }
+});

package/dist/interactions/index.js

@@ -1,15 +1 @@
-import {
-  PressInteractionEncoder,
-  PurchaseInteractionEncoder,
-  ReferralInteractionEncoder,
-  RetailInteractionEncoder,
-  WebShopInteractionEncoder
-} from "../chunk-RMOFMRZR.js";
-import "../chunk-GDH3M5ZC.js";
-export {
-  PressInteractionEncoder,
-  PurchaseInteractionEncoder,
-  ReferralInteractionEncoder,
-  RetailInteractionEncoder,
-  WebShopInteractionEncoder
-};
+export { PressInteractionEncoder, PurchaseInteractionEncoder, ReferralInteractionEncoder, RetailInteractionEncoder, WebShopInteractionEncoder } from '../chunk-RMOFMRZR.js';

package/package.json

@@ -11,7 +11,7 @@
       "url": "https://twitter.com/QNivelais"
     }
   ],
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Core SDK of the Frak wallet, low level library to interact directly with the frak ecosystem.",
   "repository": {
     "url": "https://github.com/frak-id/wallet",
@@ -89,9 +89,16 @@
     "js-sha256": "^0.11.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.2",
+    "@arethetypeswrong/cli": "^0.17.3",
     "@types/node": "^22",
     "tsup": "^8.3.5",
     "typescript": "^5"
-  }
+  },
+  "browserslist": [
+    "chrome 67",
+    "edge 79",
+    "firefox 68",
+    "opera 54",
+    "safari 14"
+  ]
 }