@frak-labs/nexus-sdk 0.0.1-alpha

package/dist/core/index.d.cts

@@ -0,0 +1,83 @@
+import { a as FrakWalletSdkConfig, F as FrakClient, E as ExtractedParametersFromRpc, I as IFrameRpcSchema, c as ExtractedReturnTypeFromRpc, R as RedirectRpcSchema } from '../client-SCwoh_kP.cjs';
+export { A as ArticleUnlockStatusReturnType, f as IFrameEvent, e as IFrameRpcEvent, d as IFrameTransport, P as PaidArticleUnlockPrice, b as StartArticleUnlockParams, S as StartArticleUnlockReturnType, U as UnlockOptionsReturnType, W as WalletStatusReturnType } from '../client-SCwoh_kP.cjs';
+import 'viem';
+import 'viem/chains';
+
+/**
+ * Create a new iframe Frak client
+ */
+declare function createIFrameFrakClient({ config, iframe, }: {
+    config: FrakWalletSdkConfig;
+    iframe: HTMLIFrameElement;
+}): FrakClient;
+
+/**
+ * Create the given iframe
+ * @param walletBaseUrl
+ */
+declare function createIframe({ walletBaseUrl, }: {
+    walletBaseUrl: string;
+}): Promise<HTMLIFrameElement | undefined>;
+
+/**
+ * The received encoded data from a client
+ *  -> The encoded should contain a HashProtectedData once decoded
+ */
+type CompressedData = Readonly<{
+    compressed: string;
+    compressedHash: string;
+}>;
+/**
+ * The encoded data to send to a client / received by a client
+ */
+type HashProtectedData<DataType> = Readonly<DataType & {
+    validationHash: string;
+}>;
+/**
+ * Represent a key provider used for the hashed and secure compression
+ */
+type KeyProvider<DataType> = (value: DataType) => string[];
+
+/**
+ * Compress the given params, and add hash protection to (rapidly) prevent interception modification
+ * @param data The params to encode
+ * @param keyProvider The method used to access the keys
+ */
+declare function hashAndCompressData<T>(data: T, keyProvider: KeyProvider<T>): Promise<CompressedData>;
+
+/**
+ * Decompress the given string
+ * @param compressedData The params to encode
+ * @param keyAccessor The key accessor used to query the keys used for the validation hash
+ */
+declare function decompressDataAndCheckHash<T>(compressedData: CompressedData, keyAccessor: KeyProvider<T>): Promise<HashProtectedData<T>>;
+
+/**
+ * Get the right request key provider for the given args
+ * @param args
+ */
+declare const iFrameRequestKeyProvider: KeyProvider<ExtractedParametersFromRpc<IFrameRpcSchema>>;
+type RpcResponseKeyProvider<TParameters extends Pick<ExtractedParametersFromRpc<IFrameRpcSchema>, "method">> = KeyProvider<ExtractedReturnTypeFromRpc<IFrameRpcSchema, Extract<ExtractedParametersFromRpc<IFrameRpcSchema>, {
+    method: TParameters["method"];
+}>>>;
+/**
+ * Get the right response key provider for the given param
+ * @param param
+ */
+declare function getIFrameResponseKeyProvider<TParameters extends Pick<ExtractedParametersFromRpc<IFrameRpcSchema>, "method">>(param: TParameters): RpcResponseKeyProvider<TParameters>;
+
+/**
+ * Get the right request key provider for the given args
+ * @param args
+ */
+declare const redirectRequestKeyProvider: KeyProvider<ExtractedParametersFromRpc<RedirectRpcSchema>>;
+type RedirectRpcResponseKeyProvider<TMethod extends ExtractedParametersFromRpc<RedirectRpcSchema>["method"]> = KeyProvider<Extract<RedirectRpcSchema[number], {
+    Method: TMethod;
+}>["ReturnType"]>;
+/**
+ * Get the right response key provider for the given redirect method
+ * @param method
+ */
+declare function getRedirectResponseResponseKeyProvider<TMethod extends ExtractedParametersFromRpc<RedirectRpcSchema>["method"]>(method: TMethod): RedirectRpcResponseKeyProvider<TMethod>;
+
+export { type CompressedData, ExtractedParametersFromRpc, ExtractedReturnTypeFromRpc, FrakClient, FrakWalletSdkConfig, type HashProtectedData, IFrameRpcSchema, type KeyProvider, RedirectRpcSchema, createIFrameFrakClient, createIframe, decompressDataAndCheckHash, getIFrameResponseKeyProvider, getRedirectResponseResponseKeyProvider, hashAndCompressData, iFrameRequestKeyProvider, redirectRequestKeyProvider };

package/dist/core/index.d.ts

@@ -0,0 +1,83 @@
+import { a as FrakWalletSdkConfig, F as FrakClient, E as ExtractedParametersFromRpc, I as IFrameRpcSchema, c as ExtractedReturnTypeFromRpc, R as RedirectRpcSchema } from '../client-SCwoh_kP.js';
+export { A as ArticleUnlockStatusReturnType, f as IFrameEvent, e as IFrameRpcEvent, d as IFrameTransport, P as PaidArticleUnlockPrice, b as StartArticleUnlockParams, S as StartArticleUnlockReturnType, U as UnlockOptionsReturnType, W as WalletStatusReturnType } from '../client-SCwoh_kP.js';
+import 'viem';
+import 'viem/chains';
+
+/**
+ * Create a new iframe Frak client
+ */
+declare function createIFrameFrakClient({ config, iframe, }: {
+    config: FrakWalletSdkConfig;
+    iframe: HTMLIFrameElement;
+}): FrakClient;
+
+/**
+ * Create the given iframe
+ * @param walletBaseUrl
+ */
+declare function createIframe({ walletBaseUrl, }: {
+    walletBaseUrl: string;
+}): Promise<HTMLIFrameElement | undefined>;
+
+/**
+ * The received encoded data from a client
+ *  -> The encoded should contain a HashProtectedData once decoded
+ */
+type CompressedData = Readonly<{
+    compressed: string;
+    compressedHash: string;
+}>;
+/**
+ * The encoded data to send to a client / received by a client
+ */
+type HashProtectedData<DataType> = Readonly<DataType & {
+    validationHash: string;
+}>;
+/**
+ * Represent a key provider used for the hashed and secure compression
+ */
+type KeyProvider<DataType> = (value: DataType) => string[];
+
+/**
+ * Compress the given params, and add hash protection to (rapidly) prevent interception modification
+ * @param data The params to encode
+ * @param keyProvider The method used to access the keys
+ */
+declare function hashAndCompressData<T>(data: T, keyProvider: KeyProvider<T>): Promise<CompressedData>;
+
+/**
+ * Decompress the given string
+ * @param compressedData The params to encode
+ * @param keyAccessor The key accessor used to query the keys used for the validation hash
+ */
+declare function decompressDataAndCheckHash<T>(compressedData: CompressedData, keyAccessor: KeyProvider<T>): Promise<HashProtectedData<T>>;
+
+/**
+ * Get the right request key provider for the given args
+ * @param args
+ */
+declare const iFrameRequestKeyProvider: KeyProvider<ExtractedParametersFromRpc<IFrameRpcSchema>>;
+type RpcResponseKeyProvider<TParameters extends Pick<ExtractedParametersFromRpc<IFrameRpcSchema>, "method">> = KeyProvider<ExtractedReturnTypeFromRpc<IFrameRpcSchema, Extract<ExtractedParametersFromRpc<IFrameRpcSchema>, {
+    method: TParameters["method"];
+}>>>;
+/**
+ * Get the right response key provider for the given param
+ * @param param
+ */
+declare function getIFrameResponseKeyProvider<TParameters extends Pick<ExtractedParametersFromRpc<IFrameRpcSchema>, "method">>(param: TParameters): RpcResponseKeyProvider<TParameters>;
+
+/**
+ * Get the right request key provider for the given args
+ * @param args
+ */
+declare const redirectRequestKeyProvider: KeyProvider<ExtractedParametersFromRpc<RedirectRpcSchema>>;
+type RedirectRpcResponseKeyProvider<TMethod extends ExtractedParametersFromRpc<RedirectRpcSchema>["method"]> = KeyProvider<Extract<RedirectRpcSchema[number], {
+    Method: TMethod;
+}>["ReturnType"]>;
+/**
+ * Get the right response key provider for the given redirect method
+ * @param method
+ */
+declare function getRedirectResponseResponseKeyProvider<TMethod extends ExtractedParametersFromRpc<RedirectRpcSchema>["method"]>(method: TMethod): RedirectRpcResponseKeyProvider<TMethod>;
+
+export { type CompressedData, ExtractedParametersFromRpc, ExtractedReturnTypeFromRpc, FrakClient, FrakWalletSdkConfig, type HashProtectedData, IFrameRpcSchema, type KeyProvider, RedirectRpcSchema, createIFrameFrakClient, createIframe, decompressDataAndCheckHash, getIFrameResponseKeyProvider, getRedirectResponseResponseKeyProvider, hashAndCompressData, iFrameRequestKeyProvider, redirectRequestKeyProvider };

package/dist/core/index.js

@@ -0,0 +1,179 @@
+import {
+  __publicField,
+  createIframe,
+  decompressDataAndCheckHash,
+  getIFrameResponseKeyProvider,
+  getRedirectResponseResponseKeyProvider,
+  hashAndCompressData,
+  iFrameRequestKeyProvider,
+  redirectRequestKeyProvider
+} from "../chunk-JE64MPH2.js";
+
+// src/core/utils/Deferred.ts
+var Deferred = class {
+  constructor() {
+    __publicField(this, "_promise");
+    __publicField(this, "_resolve");
+    __publicField(this, "_reject");
+    __publicField(this, "resolve", (value) => {
+      this._resolve?.(value);
+    });
+    __publicField(this, "reject", (reason) => {
+      this._reject?.(reason);
+    });
+    this._promise = new Promise((resolve, reject) => {
+      this._resolve = resolve;
+      this._reject = reject;
+    });
+  }
+  get promise() {
+    return this._promise;
+  }
+};
+
+// src/core/clients/transports/iframeChannelManager.ts
+function createIFrameChannelManager() {
+  const channels = /* @__PURE__ */ new Map();
+  return {
+    // TODO: Better id system?? uid stuff?
+    createChannel: (resolver) => {
+      const id = Math.random().toString(36).substring(7);
+      channels.set(id, resolver);
+      return id;
+    },
+    getRpcResolver: (id) => channels.get(id),
+    removeChannel: (id) => channels.delete(id),
+    destroy: () => channels.clear()
+  };
+}
+
+// src/core/clients/transports/iframeMessageHandler.ts
+function createIFrameMessageHandler({
+  frakWalletUrl,
+  iframe,
+  channelManager
+}) {
+  if (typeof window === "undefined") {
+    throw new Error("iframe client should be used in the browser");
+  }
+  if (!iframe.contentWindow) {
+    throw new Error("The iframe does not have a content window");
+  }
+  const contentWindow = iframe.contentWindow;
+  const isConnected = new Deferred();
+  const msgHandler = async (event) => {
+    if (!event.origin) {
+      return;
+    }
+    if (new URL(event.origin).origin.toLowerCase() !== new URL(frakWalletUrl).origin.toLowerCase()) {
+      return;
+    }
+    if ("lifecycle" in event.data) {
+      isConnected.resolve(event.data.lifecycle === "connected");
+      return;
+    }
+    const channel = event.data.id;
+    const resolver = channelManager.getRpcResolver(channel);
+    if (!resolver) {
+      return;
+    }
+    await resolver(event.data);
+  };
+  window.addEventListener("message", msgHandler);
+  const sendEvent = (message) => {
+    contentWindow.postMessage(message, {
+      targetOrigin: frakWalletUrl
+    });
+  };
+  const cleanup = () => {
+    window.removeEventListener("message", msgHandler);
+  };
+  return {
+    isConnected: isConnected.promise,
+    sendEvent,
+    cleanup
+  };
+}
+
+// src/core/clients/createIFrameFrakClient.ts
+function createIFrameFrakClient({
+  config,
+  iframe
+}) {
+  const channelManager = createIFrameChannelManager();
+  const messageHandler = createIFrameMessageHandler({
+    frakWalletUrl: config.walletUrl,
+    iframe,
+    channelManager
+  });
+  const request = async (args) => {
+    const isConnected = await messageHandler.isConnected;
+    if (!isConnected) {
+      throw new Error("The iframe provider isn't connected yet");
+    }
+    const result = new Deferred();
+    const resultCompressionKeyProvider = getIFrameResponseKeyProvider(args);
+    const channelId = channelManager.createChannel(async (message) => {
+      const decompressed = await decompressDataAndCheckHash(
+        message.data,
+        resultCompressionKeyProvider
+      );
+      result.resolve(decompressed);
+      channelManager.removeChannel(channelId);
+    });
+    const compressedMessage = await hashAndCompressData(
+      args,
+      iFrameRequestKeyProvider
+    );
+    messageHandler.sendEvent({
+      id: channelId,
+      topic: args.method,
+      data: compressedMessage
+    });
+    return result.promise;
+  };
+  const listenerRequest = async (args, callback) => {
+    const isConnected = await messageHandler.isConnected;
+    if (!isConnected) {
+      throw new Error("The iframe provider isn't connected yet");
+    }
+    const resultCompressionKeyProvider = getIFrameResponseKeyProvider(args);
+    const channelId = channelManager.createChannel(async (message) => {
+      const decompressed = await decompressDataAndCheckHash(
+        message.data,
+        resultCompressionKeyProvider
+      );
+      callback(decompressed);
+    });
+    const compressedMessage = await hashAndCompressData(
+      args,
+      iFrameRequestKeyProvider
+    );
+    messageHandler.sendEvent({
+      id: channelId,
+      topic: args.method,
+      data: compressedMessage
+    });
+  };
+  const destroy = async () => {
+    channelManager.destroy();
+    messageHandler.cleanup();
+  };
+  return {
+    config,
+    waitForConnection: messageHandler.isConnected,
+    request,
+    listenerRequest,
+    destroy
+  };
+}
+export {
+  createIFrameFrakClient,
+  createIframe,
+  decompressDataAndCheckHash,
+  getIFrameResponseKeyProvider,
+  getRedirectResponseResponseKeyProvider,
+  hashAndCompressData,
+  iFrameRequestKeyProvider,
+  redirectRequestKeyProvider
+};

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/index.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@frak-labs/nexus-sdk",
+  "author": "Frak Labs",
+  "version": "0.0.1-alpha",
+  "description": "Nexus Wallet client SDK, helping any person to interact with the Frak wallet, and require the unlock of a premium article within the Frak ecosystem.",
+  "repository": "https://github.com/frak-id/wallet",
+  "homepage": "https://docs.frak.id/wallet-sdk",
+  "license": "GNU GPL 3.0",
+  "sideEffects": false,
+  "private": false,
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "typings": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "/dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.cjs"
+    },
+    "./core": {
+      "types": "./dist/core/index.d.ts",
+      "import": "./dist/core/index.js",
+      "default": "./dist/core/index.cjs"
+    },
+    "./actions": {
+      "types": "./dist/core/actions/index.d.ts",
+      "import": "./dist/core/actions/index.js",
+      "default": "./dist/core/actions/index.cjs"
+    }
+  },
+  "scripts": {
+    "lint": "biome lint .",
+    "format:check": "biome check .",
+    "format": "biome check --apply .",
+    "clean": "rimraf dist",
+    "build": "tsup --splitting"
+  },
+  "peerDependencies": {
+    "viem": "^2.7.10"
+  },
+  "dependencies": {
+    "async-lz-string": "^1.1.0",
+    "js-sha256": "^0.11.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20",
+    "tsup": "^8.0.2",
+    "typescript": "^5"
+  }
+}