@frak-labs/nexus-sdk 0.0.9 → 0.0.11

package/dist/client-BwzXSgqQ.d.ts

@@ -1,278 +0,0 @@
-import { Hex, Address, RpcSchema } from 'viem';
-import { Prettify } from 'viem/chains';
-
-/**
- * Configuration for the Nexus Wallet SDK
- */
-type NexusWalletSdkConfig = Readonly<{
-    walletUrl: string;
-    metadata: {
-        name: string;
-    };
-}>;
-
-/**
- * Parameters of the referred request
- */
-type SetUserReferredParams = Readonly<{
-    contentId: Hex;
-}>;
-/**
- * Return type of the referred request
- */
-type SetUserReferredReturnType = UserIsSameWallet | UserReferredSuccessful | UserReferredHistory;
-type UserIsSameWallet = {
-    key: "same-wallet";
-};
-type UserReferredSuccessful = {
-    key: "referred-successful";
-};
-type UserReferredHistory = {
-    key: "referred-history";
-};
-
-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 used to set the referred user
-     */
-    {
-        Method: "frak_listenToSetUserReferred";
-        Parameters: [contentId: Hex, walletAddress: Address];
-        ReturnType: SetUserReferredReturnType;
-    }
-];
-/**
- * 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 | undefined = undefined> = 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] : {
-    method: string;
-    params?: unknown;
-};
-/**
- * Type that extract the possible return type from a RPC Schema
- */
-type ExtractedReturnTypeFromRpc<TRpcSchema extends RpcSchema | undefined = undefined, TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>> = TRpcSchema extends RpcSchema ? ExtractedMethodFromRpc<TRpcSchema, TParameters["method"]>["ReturnType"] : unknown;
-/**
- * Type that extract the possible return type from a RPC Schema
- */
-type ExtractedMethodFromRpc<TRpcSchema extends RpcSchema | undefined = undefined, TMethod extends ExtractedParametersFromRpc<TRpcSchema>["method"] = ExtractedParametersFromRpc<TRpcSchema>["method"]> = TRpcSchema extends RpcSchema ? Extract<TRpcSchema[number], {
-    Method: TMethod;
-}> : unknown;
-/**
- * Type used for a one shot request function
- */
-type RequestFn<TRpcSchema extends RpcSchema | undefined = undefined> = <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 | undefined = undefined> = <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";
-};
-
-/**
- * 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, StartArticleUnlockReturnType as S, UnlockOptionsReturnType as U, WalletStatusReturnType as W, NexusWalletSdkConfig as a, StartArticleUnlockParams as b, SetUserReferredReturnType as c, ExtractedReturnTypeFromRpc as d, SetUserReferredParams as e, IFrameTransport as f, IFrameRpcEvent as g, IFrameEvent as h };

package/dist/watchUnlockStatus-DXClCYH9.d.cts

@@ -1,43 +0,0 @@
-import { Hex } from 'viem';
-import { N as NexusClient, A as ArticleUnlockStatusReturnType } from './client-BwzXSgqQ.cjs';
-
-/**
- * Type used to get the unlock options
- */
-type GetUnlockOptionsParams = {
-    articleId: Hex;
-    contentId: Hex;
-};
-/**
- * Function used to fetch the unlock option for the given client
- * @param client
- * @param articleId
- * @param contentId
- */
-declare function getArticleUnlockOptions(client: NexusClient, { articleId, contentId }: GetUnlockOptionsParams): Promise<Readonly<{
-    frkBalanceAsHex?: `0x${string}` | undefined;
-    prices: {
-        index: number;
-        unlockDurationInSec: number;
-        frkAmount: `0x${string}`;
-        isUserAccessible: boolean | null;
-    }[];
-}>>;
-
-/**
- * Type used to get the unlock options
- */
-type WatchUnlockStatusParams = {
-    articleId: Hex;
-    contentId: Hex;
-};
-/**
- * Function used to watch a current article unlock status
- * @param client
- * @param articleId
- * @param contentId
- * @param callback
- */
-declare function watchUnlockStatus(client: NexusClient, { articleId, contentId }: WatchUnlockStatusParams, callback: (status: ArticleUnlockStatusReturnType) => void): Promise<void>;
-
-export { type GetUnlockOptionsParams as G, type WatchUnlockStatusParams as W, getArticleUnlockOptions as g, watchUnlockStatus as w };

package/dist/watchUnlockStatus-WJxoDliF.d.ts

@@ -1,43 +0,0 @@
-import { Hex } from 'viem';
-import { N as NexusClient, A as ArticleUnlockStatusReturnType } from './client-BwzXSgqQ.js';
-
-/**
- * Type used to get the unlock options
- */
-type GetUnlockOptionsParams = {
-    articleId: Hex;
-    contentId: Hex;
-};
-/**
- * Function used to fetch the unlock option for the given client
- * @param client
- * @param articleId
- * @param contentId
- */
-declare function getArticleUnlockOptions(client: NexusClient, { articleId, contentId }: GetUnlockOptionsParams): Promise<Readonly<{
-    frkBalanceAsHex?: `0x${string}` | undefined;
-    prices: {
-        index: number;
-        unlockDurationInSec: number;
-        frkAmount: `0x${string}`;
-        isUserAccessible: boolean | null;
-    }[];
-}>>;
-
-/**
- * Type used to get the unlock options
- */
-type WatchUnlockStatusParams = {
-    articleId: Hex;
-    contentId: Hex;
-};
-/**
- * Function used to watch a current article unlock status
- * @param client
- * @param articleId
- * @param contentId
- * @param callback
- */
-declare function watchUnlockStatus(client: NexusClient, { articleId, contentId }: WatchUnlockStatusParams, callback: (status: ArticleUnlockStatusReturnType) => void): Promise<void>;
-
-export { type GetUnlockOptionsParams as G, type WatchUnlockStatusParams as W, getArticleUnlockOptions as g, watchUnlockStatus as w };