@frak-labs/nexus-sdk 0.0.10 → 0.0.12

package/dist/chunk-T54VMWHQ.js

@@ -1,100 +0,0 @@
-import {
-  decompressDataAndCheckHash,
-  hashAndCompressData
-} from "./chunk-TPC5PMRC.js";
-
-// src/core/actions/getUnlockOptions.ts
-function getArticleUnlockOptions(client, { articleId, contentId }) {
-  return client.request({
-    method: "frak_getArticleUnlockOptions",
-    params: [contentId, articleId]
-  });
-}
-
-// src/core/actions/watchUnlockStatus.ts
-function watchUnlockStatus(client, { articleId, contentId }, callback) {
-  return client.listenerRequest(
-    {
-      method: "frak_listenToArticleUnlockStatus",
-      params: [contentId, articleId]
-    },
-    callback
-  );
-}
-
-// src/core/actions/watchWalletStatus.ts
-function watchWalletStatus(client, callback) {
-  return client.listenerRequest(
-    {
-      method: "frak_listenToWalletStatus"
-    },
-    callback
-  );
-}
-
-// src/core/actions/startUnlock.ts
-async function getStartArticleUnlockUrl(config, params) {
-  const { compressed, compressedHash } = await hashAndCompressData({
-    method: "frak_startArticleUnlock",
-    params
-  });
-  const outputUrl = new URL(config.walletUrl);
-  outputUrl.pathname = "/paywall";
-  outputUrl.searchParams.set("params", encodeURIComponent(compressed));
-  outputUrl.searchParams.set("hash", encodeURIComponent(compressedHash));
-  return outputUrl.toString();
-}
-async function decodeStartUnlockReturn({
-  result,
-  hash
-}) {
-  return decompressDataAndCheckHash({
-    compressed: decodeURIComponent(result),
-    compressedHash: decodeURIComponent(hash)
-  });
-}
-
-// src/core/actions/sendTransaction.ts
-async function sendTransaction(client, { tx, context }) {
-  return await client.request({
-    method: "frak_sendTransaction",
-    params: [tx, context]
-  });
-}
-
-// src/core/actions/siweAuthenticate.ts
-import { generateSiweNonce } from "viem/siwe";
-async function siweAuthenticate(client, { siwe, context }) {
-  const realStatement = siwe?.statement ?? `I confirm that I want to use my Nexus wallet on: ${client.config.metadata.name}`;
-  const builtSiwe = {
-    ...siwe,
-    statement: realStatement,
-    nonce: siwe?.nonce ?? generateSiweNonce(),
-    uri: siwe?.uri ?? `https://${client.config.domain}`,
-    version: siwe?.version ?? "1",
-    domain: client.config.domain
-  };
-  return await client.request({
-    method: "frak_siweAuthenticate",
-    params: [builtSiwe, context]
-  });
-}
-
-// src/core/actions/sendInteraction.ts
-async function sendInteraction(client, { contentId, interaction, validation }) {
-  return await client.request({
-    method: "frak_sendInteraction",
-    params: [contentId, interaction, validation]
-  });
-}
-
-export {
-  getArticleUnlockOptions,
-  watchUnlockStatus,
-  watchWalletStatus,
-  getStartArticleUnlockUrl,
-  decodeStartUnlockReturn,
-  sendTransaction,
-  siweAuthenticate,
-  sendInteraction
-};

package/dist/chunk-TPC5PMRC.js

@@ -1,152 +0,0 @@
-// src/core/types/rpc/error.ts
-var FrakRpcError = class extends Error {
-  constructor(code, message, data) {
-    super(message);
-    this.code = code;
-    this.data = data;
-  }
-};
-var ClientNotFound = class extends FrakRpcError {
-  constructor() {
-    super(RpcErrorCodes.clientNotConnected, "Client not found");
-  }
-};
-var RpcErrorCodes = {
-  // Standard JSON-RPC 2.0 errors
-  parseError: -32700,
-  invalidRequest: -32600,
-  methodNotFound: -32601,
-  invalidParams: -32602,
-  internalError: -32603,
-  serverError: -32e3,
-  // Frak specific errors (from -32001 to -32099)
-  clientNotConnected: -32001,
-  configError: -32002,
-  corruptedResponse: -32003,
-  clientAborted: -32004,
-  walletNotConnected: -32005,
-  noInteractionSession: -32006
-};
-
-// src/core/utils/compression/compress.ts
-import { compressToBase64 } from "async-lz-string";
-import { sha256 } from "js-sha256";
-async function hashAndCompressData(data) {
-  const validationHash = sha256(JSON.stringify(data));
-  const hashProtectedData = {
-    ...data,
-    validationHash
-  };
-  const compressed = await compressJson(hashProtectedData);
-  const compressedHash = sha256(compressed);
-  return {
-    compressed,
-    compressedHash
-  };
-}
-async function compressJson(data) {
-  return compressToBase64(JSON.stringify(data));
-}
-
-// src/core/utils/compression/decompress.ts
-import { decompressFromBase64 } from "async-lz-string";
-import { sha256 as sha2562 } from "js-sha256";
-async function decompressDataAndCheckHash(compressedData) {
-  if (!(compressedData?.compressed && compressedData?.compressedHash)) {
-    throw new FrakRpcError(
-      RpcErrorCodes.corruptedResponse,
-      "Missing compressed data"
-    );
-  }
-  const parsedData = await decompressJson(
-    compressedData.compressed
-  );
-  if (!parsedData) {
-    throw new FrakRpcError(
-      RpcErrorCodes.corruptedResponse,
-      "Invalid compressed data"
-    );
-  }
-  if (!parsedData?.validationHash) {
-    throw new FrakRpcError(
-      RpcErrorCodes.corruptedResponse,
-      "Missing validation hash"
-    );
-  }
-  const expectedCompressedHash = sha2562(compressedData.compressed);
-  if (expectedCompressedHash !== compressedData.compressedHash) {
-    throw new FrakRpcError(
-      RpcErrorCodes.corruptedResponse,
-      "Invalid compressed hash"
-    );
-  }
-  const { validationHash: _, ...rawResultData } = parsedData;
-  const expectedValidationHash = sha2562(JSON.stringify(rawResultData));
-  if (expectedValidationHash !== parsedData.validationHash) {
-    throw new FrakRpcError(
-      RpcErrorCodes.corruptedResponse,
-      "Invalid data validation hash"
-    );
-  }
-  return parsedData;
-}
-async function decompressJson(data) {
-  const decompressed = await decompressFromBase64(data);
-  try {
-    return JSON.parse(decompressed);
-  } catch (e) {
-    console.error("Invalid compressed data", e);
-    return null;
-  }
-}
-
-// src/core/utils/iframeHelper.ts
-function createIframe({
-  walletBaseUrl
-}) {
-  const alreadyCreatedIFrame = document.querySelector("#nexus-wallet");
-  if (alreadyCreatedIFrame) {
-    return Promise.resolve(void 0);
-  }
-  const iframe = document.createElement("iframe");
-  iframe.name = "nexus-wallet";
-  iframe.id = "nexus-wallet";
-  iframe.style.zIndex = "1000";
-  changeIframeVisibility({ iframe, isVisible: false });
-  document.body.appendChild(iframe);
-  return new Promise((resolve) => {
-    iframe?.addEventListener("load", () => resolve(iframe));
-    iframe.src = `${walletBaseUrl}/listener`;
-  });
-}
-function changeIframeVisibility({
-  iframe,
-  isVisible
-}) {
-  if (!isVisible) {
-    iframe.style.width = "0";
-    iframe.style.height = "0";
-    iframe.style.border = "0";
-    iframe.style.position = "fixed";
-    iframe.style.top = "-1000px";
-    iframe.style.left = "-1000px";
-    return;
-  }
-  iframe.style.position = "fixed";
-  iframe.style.top = "0";
-  iframe.style.left = "0";
-  iframe.style.width = "100%";
-  iframe.style.height = "100%";
-}
-
-export {
-  FrakRpcError,
-  ClientNotFound,
-  RpcErrorCodes,
-  hashAndCompressData,
-  compressJson,
-  decompressDataAndCheckHash,
-  decompressJson,
-  createIframe,
-  changeIframeVisibility
-};

package/dist/client--U_6SK0l.d.cts

@@ -1,339 +0,0 @@
-import { Hex, Address, RpcSchema } from 'viem';
-import { Prettify } from 'viem/chains';
-import { SiweMessage } from 'viem/siwe';
-import { P as PreparedInteraction, a as SendInteractionReturnType } from './interaction-D_CzyqRE.cjs';
-
-/**
- * Configuration for the Nexus Wallet SDK
- */
-type NexusWalletSdkConfig = Readonly<{
-    walletUrl: string;
-    metadata: {
-        name: string;
-    };
-    domain: string;
-}>;
-
-/**
- * Parameters of the send transaction rpc request
- */
-type SiweAuthenticationParams = Omit<SiweMessage, "address" | "chainId">;
-/**
- * Same stuff but in an object format for better readability
- */
-type SiweAuthenticateActionParamsType = Readonly<{
-    siwe?: Partial<SiweAuthenticationParams>;
-    context?: string;
-}>;
-/**
- * Return type of the send transaction rpc request
- */
-type SiweAuthenticateReturnType = Readonly<{
-    signature: Hex;
-    message: string;
-}>;
-
-/**
- * Parameters of the send transaction rpc request
- */
-type SendTransactionRpcParamsType = [
-    tx: SendTransactionTxType | SendTransactionTxType[],
-    context?: string
-];
-/**
- * Same stuff but in an object format for better readability
- */
-type SendTransactionActionParamsType = Readonly<{
-    tx: SendTransactionTxType | SendTransactionTxType[];
-    context?: string;
-}>;
-type SendTransactionTxType = Readonly<{
-    to: Address;
-    data: Hex;
-    value: Hex;
-}>;
-/**
- * Return type of the send transaction rpc request
- */
-type SendTransactionReturnType = Readonly<{
-    hash: Hex;
-}>;
-
-type PaidArticleUnlockPrice = Readonly<{
-    index: number;
-    unlockDurationInSec: number;
-    frkAmount: Hex;
-}>;
-
-/**
- * Request to unlock a paid article
- */
-type StartArticleUnlockParams = Readonly<{
-    articleId: Hex;
-    contentId: Hex;
-    imageUrl: string;
-    articleTitle: string;
-    contentTitle: string;
-    price: PaidArticleUnlockPrice;
-    articleUrl: string;
-    redirectUrl: string;
-    previewUrl?: string;
-    provider: "le-monde" | "wired" | "l-equipe";
-}>;
-/**
- * Return type of the unlock request
- */
-type StartArticleUnlockReturnType = UnlockSuccess | AlreadyUnlocked | UnlockError;
-type UnlockSuccess = {
-    key: "success";
-    status: "in-progress";
-    user: Address;
-    userOpHash: Hex;
-};
-type AlreadyUnlocked = {
-    key: "already-unlocked";
-    status: "unlocked";
-    user: Address;
-};
-type UnlockError = {
-    key: "error" | "cancelled";
-    status: "locked";
-    user?: Address;
-    reason?: string;
-};
-
-/**
- * The response to the get unlock options response
- */
-type UnlockOptionsReturnType = Readonly<{
-    frkBalanceAsHex?: Hex;
-    prices: {
-        index: number;
-        unlockDurationInSec: number;
-        frkAmount: Hex;
-        isUserAccessible: boolean | null;
-    }[];
-}>;
-
-/**
- * The different types of response for the current unlock status
- */
-type ArticleUnlockStatusReturnType = Readonly<UnlockStatusLocked | UnlockStatusProcessing | UnlockStatusValid | UnlockStatusError>;
-/**
- * When the content unlocked was expired or not unlocked
- */
-type UnlockStatusLocked = {
-    key: "expired";
-    status: "locked";
-    expiredAt: number;
-} | {
-    key: "not-unlocked";
-    status: "locked";
-};
-/**
- * When the content unlock is in progress
- */
-type UnlockStatusProcessing = {
-    status: "in-progress";
-} & ({
-    key: "preparing" | "waiting-user-validation";
-} | {
-    key: "waiting-transaction-bundling";
-    userOpHash: Hex;
-} | {
-    key: "waiting-transaction-confirmation";
-    userOpHash: Hex;
-    txHash: Hex;
-});
-/**
- * When the content is unlocked
- */
-type UnlockStatusValid = {
-    key: "valid";
-    status: "unlocked";
-    allowedUntil: number;
-};
-/**
- * When the unlock content is in error
- */
-type UnlockStatusError = {
-    key: "error";
-    status: "locked";
-    reason: string;
-};
-
-type WalletStatusReturnType = Readonly<WalletConnected | WalletNotConnected>;
-type WalletConnected = {
-    key: "connected";
-    wallet: Address;
-};
-type WalletNotConnected = {
-    key: "not-connected";
-};
-
-/**
- * RPC interface that's used for the iframe communication
- */
-type IFrameRpcSchema = [
-    /**
-     * Method used to fetch an article unlock options
-     */
-    {
-        Method: "frak_getArticleUnlockOptions";
-        Parameters: [contentId: Hex, articleId: Hex];
-        ReturnType: UnlockOptionsReturnType;
-    },
-    /**
-     * Method used to listen to the wallet status
-     */
-    {
-        Method: "frak_listenToWalletStatus";
-        Parameters?: undefined;
-        ReturnType: WalletStatusReturnType;
-    },
-    /**
-     * Method used to listen to an article unlock status
-     */
-    {
-        Method: "frak_listenToArticleUnlockStatus";
-        Parameters: [contentId: Hex, articleId: Hex];
-        ReturnType: ArticleUnlockStatusReturnType;
-    },
-    /**
-     * Method to ask the user to send a transaction
-     */
-    {
-        Method: "frak_sendTransaction";
-        Parameters: SendTransactionRpcParamsType;
-        ReturnType: SendTransactionReturnType;
-    },
-    /**
-     * Method to ask the user for a strong authentication
-     */
-    {
-        Method: "frak_siweAuthenticate";
-        Parameters: [request: SiweAuthenticationParams, context?: string];
-        ReturnType: SiweAuthenticateReturnType;
-    },
-    /**
-     * Method to transmit a user interaction
-     */
-    {
-        Method: "frak_sendInteraction";
-        Parameters: [
-            contentId: Hex,
-            interaction: PreparedInteraction,
-            signature?: Hex
-        ];
-        ReturnType: SendInteractionReturnType;
-    }
-];
-/**
- * RPC interface that's used for the redirection communication
- */
-type RedirectRpcSchema = [
-    /**
-     * Method used to start the unlock of an article
-     */
-    {
-        Method: "frak_startArticleUnlock";
-        Path: "/paywall";
-        Parameters: StartArticleUnlockParams;
-        ReturnType: StartArticleUnlockReturnType;
-    }
-];
-
-/**
- * Type that extract the possible parameters from a RPC Schema
- */
-type ExtractedParametersFromRpc<TRpcSchema extends RpcSchema> = {
-    [K in keyof TRpcSchema]: Prettify<{
-        method: TRpcSchema[K] extends TRpcSchema[number] ? TRpcSchema[K]["Method"] : string;
-    } & (TRpcSchema[K] extends TRpcSchema[number] ? TRpcSchema[K]["Parameters"] extends undefined ? {
-        params?: never;
-    } : {
-        params: TRpcSchema[K]["Parameters"];
-    } : never)>;
-}[number];
-/**
- * Type that extract the possible return type from a RPC Schema
- */
-type ExtractedReturnTypeFromRpc<TRpcSchema extends RpcSchema, TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>> = ExtractedMethodFromRpc<TRpcSchema, TParameters["method"]>["ReturnType"];
-/**
- * Type that extract the possible return type from a RPC Schema
- */
-type ExtractedMethodFromRpc<TRpcSchema extends RpcSchema, TMethod extends ExtractedParametersFromRpc<TRpcSchema>["method"] = ExtractedParametersFromRpc<TRpcSchema>["method"]> = Extract<TRpcSchema[number], {
-    Method: TMethod;
-}>;
-/**
- * Raw response that we will receive after an rpc request
- */
-type RpcResponse<TRpcSchema extends RpcSchema, TMethod extends TRpcSchema[number]["Method"] = TRpcSchema[number]["Method"]> = {
-    result: Extract<TRpcSchema[number], {
-        Method: TMethod;
-    }>["ReturnType"];
-    error?: never;
-} | {
-    result?: never;
-    error: {
-        code: number;
-        message: string;
-        data?: unknown;
-    };
-};
-/**
- * Type used for a one shot request function
- */
-type RequestFn<TRpcSchema extends RpcSchema> = <TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>, _ReturnType = ExtractedReturnTypeFromRpc<TRpcSchema, TParameters>>(args: TParameters) => Promise<_ReturnType>;
-/**
- * Type used for a one shot request function
- */
-type ListenerRequestFn<TRpcSchema extends RpcSchema> = <TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>>(args: TParameters, callback: (result: ExtractedReturnTypeFromRpc<TRpcSchema, TParameters>) => void) => Promise<void>;
-/**
- * IFrame transport interface
- */
-type IFrameTransport = {
-    /**
-     * Wait for the connection to be established
-     */
-    waitForConnection: Promise<boolean>;
-    /**
-     * Function used to perform a single request via the iframe transport
-     */
-    request: RequestFn<IFrameRpcSchema>;
-    /**
-     * Function used to listen to a request response via the iframe transport
-     */
-    listenerRequest: ListenerRequestFn<IFrameRpcSchema>;
-    /**
-     * Function used to destroy the iframe transport
-     */
-    destroy: () => Promise<void>;
-};
-/**
- * Represent an iframe event
- */
-type IFrameEvent = IFrameRpcEvent | IFrameLifecycleEvent;
-/**
- * Represent an iframe rpc event
- */
-type IFrameRpcEvent = {
-    id: string;
-    topic: ExtractedParametersFromRpc<IFrameRpcSchema>["method"];
-    data: {
-        compressed: string;
-        compressedHash: string;
-    };
-};
-type IFrameLifecycleEvent = {
-    lifecycle: "connected" | "show" | "hide";
-};
-
-/**
- * Representing a Nexus client
- */
-type NexusClient = {
-    config: NexusWalletSdkConfig;
-} & IFrameTransport;
-
-export type { ArticleUnlockStatusReturnType as A, ExtractedParametersFromRpc as E, IFrameRpcSchema as I, NexusClient as N, PaidArticleUnlockPrice as P, RedirectRpcSchema as R, StartArticleUnlockParams as S, UnlockOptionsReturnType as U, WalletStatusReturnType as W, NexusWalletSdkConfig as a, StartArticleUnlockReturnType as b, SendTransactionActionParamsType as c, SendTransactionReturnType as d, SendTransactionTxType as e, SiweAuthenticateReturnType as f, SiweAuthenticateActionParamsType as g, SiweAuthenticationParams as h, RpcResponse as i, IFrameTransport as j, IFrameRpcEvent as k, IFrameEvent as l, ExtractedReturnTypeFromRpc as m };