@frak-labs/nexus-sdk 0.0.4 → 0.0.7

package/README.md

@@ -8,7 +8,7 @@ Checkout our documentation for more informations about the usage:
 
 To have more info about how does it works under the hood, you can check [this](https://docs.frak.id/wallet-sdk/under-the-hood)
 
-> :warning: **This is in active development**: Only supporting polygon Mumbai at the moment, **DO NOT USE IN PROD**
+> :warning: **This is in active development**: Only supporting testnets at the moment, **DO NOT USE IN PROD**
 
 
 ## Installation

package/dist/{client-gnNyzrko.d.cts → client-DWLJ8zR-.d.cts}

@@ -29,6 +29,7 @@ type StartArticleUnlockParams = Readonly<{
     articleUrl: string;
     redirectUrl: string;
     previewUrl?: string;
+    provider: "le-monde" | "wired" | "l-equipe";
 }>;
 /**
  * Return type of the unlock request
@@ -69,7 +70,7 @@ type UnlockOptionsReturnType = Readonly<{
  */
 type ArticleUnlockStatusReturnType = Readonly<UnlockStatusLocked | UnlockStatusProcessing | UnlockStatusValid | UnlockStatusError>;
 /**
- * When the content unlocked was expired a few time ago
+ * When the content unlocked was expired or not unlocked
  */
 type UnlockStatusLocked = {
     key: "expired";
@@ -80,7 +81,7 @@ type UnlockStatusLocked = {
     status: "locked";
 };
 /**
- * When the content unlocked was expired a few time ago
+ * When the content unlock is in progress
  */
 type UnlockStatusProcessing = {
     status: "in-progress";
@@ -95,7 +96,7 @@ type UnlockStatusProcessing = {
     txHash: Hex;
 });
 /**
- * When the content unlocked was expired a few time ago
+ * When the content is unlocked
  */
 type UnlockStatusValid = {
     key: "valid";
@@ -103,7 +104,7 @@ type UnlockStatusValid = {
     allowedUntil: number;
 };
 /**
- * When the content unlocked was expired a few time ago
+ * When the unlock content is in error
  */
 type UnlockStatusError = {
     key: "error";

package/dist/{client-gnNyzrko.d.ts → client-DWLJ8zR-.d.ts}

@@ -29,6 +29,7 @@ type StartArticleUnlockParams = Readonly<{
     articleUrl: string;
     redirectUrl: string;
     previewUrl?: string;
+    provider: "le-monde" | "wired" | "l-equipe";
 }>;
 /**
  * Return type of the unlock request
@@ -69,7 +70,7 @@ type UnlockOptionsReturnType = Readonly<{
  */
 type ArticleUnlockStatusReturnType = Readonly<UnlockStatusLocked | UnlockStatusProcessing | UnlockStatusValid | UnlockStatusError>;
 /**
- * When the content unlocked was expired a few time ago
+ * When the content unlocked was expired or not unlocked
  */
 type UnlockStatusLocked = {
     key: "expired";
@@ -80,7 +81,7 @@ type UnlockStatusLocked = {
     status: "locked";
 };
 /**
- * When the content unlocked was expired a few time ago
+ * When the content unlock is in progress
  */
 type UnlockStatusProcessing = {
     status: "in-progress";
@@ -95,7 +96,7 @@ type UnlockStatusProcessing = {
     txHash: Hex;
 });
 /**
- * When the content unlocked was expired a few time ago
+ * When the content is unlocked
  */
 type UnlockStatusValid = {
     key: "valid";
@@ -103,7 +104,7 @@ type UnlockStatusValid = {
     allowedUntil: number;
 };
 /**
- * When the content unlocked was expired a few time ago
+ * When the unlock content is in error
  */
 type UnlockStatusError = {
     key: "error";

package/dist/core/actions/index.d.cts

@@ -1,5 +1,5 @@
-export { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams, g as getArticleUnlockOptions, w as watchUnlockStatus } from '../../watchUnlockStatus-DvDS55TN.cjs';
-import { N as NexusClient, W as WalletStatusReturnType, a as NexusWalletSdkConfig, S as StartArticleUnlockReturnType, b as StartArticleUnlockParams } from '../../client-gnNyzrko.cjs';
+export { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams, g as getArticleUnlockOptions, w as watchUnlockStatus } from '../../watchUnlockStatus-B4kRztOM.cjs';
+import { N as NexusClient, W as WalletStatusReturnType, a as NexusWalletSdkConfig, S as StartArticleUnlockReturnType, b as StartArticleUnlockParams } from '../../client-DWLJ8zR-.cjs';
 import 'viem';
 import 'viem/chains';
 

package/dist/core/actions/index.d.ts

@@ -1,5 +1,5 @@
-export { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams, g as getArticleUnlockOptions, w as watchUnlockStatus } from '../../watchUnlockStatus-Btjg-WTs.js';
-import { N as NexusClient, W as WalletStatusReturnType, a as NexusWalletSdkConfig, S as StartArticleUnlockReturnType, b as StartArticleUnlockParams } from '../../client-gnNyzrko.js';
+export { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams, g as getArticleUnlockOptions, w as watchUnlockStatus } from '../../watchUnlockStatus--7dFtOJr.js';
+import { N as NexusClient, W as WalletStatusReturnType, a as NexusWalletSdkConfig, S as StartArticleUnlockReturnType, b as StartArticleUnlockParams } from '../../client-DWLJ8zR-.js';
 import 'viem';
 import 'viem/chains';
 

package/dist/core/index.d.cts

@@ -1,5 +1,5 @@
-import { a as NexusWalletSdkConfig, N as NexusClient, E as ExtractedParametersFromRpc, I as IFrameRpcSchema, c as ExtractedReturnTypeFromRpc, R as RedirectRpcSchema } from '../client-gnNyzrko.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-gnNyzrko.cjs';
+import { a as NexusWalletSdkConfig, N as NexusClient, E as ExtractedParametersFromRpc, I as IFrameRpcSchema, c as ExtractedReturnTypeFromRpc, R as RedirectRpcSchema } from '../client-DWLJ8zR-.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-DWLJ8zR-.cjs';
 import 'viem';
 import 'viem/chains';
 

package/dist/core/index.d.ts

@@ -1,5 +1,5 @@
-import { a as NexusWalletSdkConfig, N as NexusClient, E as ExtractedParametersFromRpc, I as IFrameRpcSchema, c as ExtractedReturnTypeFromRpc, R as RedirectRpcSchema } from '../client-gnNyzrko.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-gnNyzrko.js';
+import { a as NexusWalletSdkConfig, N as NexusClient, E as ExtractedParametersFromRpc, I as IFrameRpcSchema, c as ExtractedReturnTypeFromRpc, R as RedirectRpcSchema } from '../client-DWLJ8zR-.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-DWLJ8zR-.js';
 import 'viem';
 import 'viem/chains';
 

package/dist/react/index.cjs

@@ -61,7 +61,8 @@ function useArticleUnlockOptions({ articleId }) {
       }
       return await _chunk3LF3FGI6cjs.getArticleUnlockOptions.call(void 0, client, { articleId });
     },
-    enabled: !!articleId
+    enabled: !!articleId,
+    gcTime: 0
   });
 }
 
@@ -78,6 +79,7 @@ function useWalletStatus() {
     [queryClient]
   );
   return _reactquery.useQuery.call(void 0, {
+    gcTime: 0,
     queryKey: ["walletStatusListener"],
     queryFn: async () => {
       await _chunk3LF3FGI6cjs.watchWalletStatus.call(void 0, client, newStatusUpdated);
@@ -103,7 +105,11 @@ function useArticleUnlockStatus({ articleId }) {
   );
   return _reactquery.useQuery.call(void 0, {
     queryKey: ["articleUnlockStatusListener", _nullishCoalesce(articleId, () => ( "no-article-id"))],
+    gcTime: 0,
     queryFn: async () => {
+      if (!articleId) {
+        return null;
+      }
       await _chunk3LF3FGI6cjs.watchUnlockStatus.call(void 0, client, { articleId }, newStatusUpdated);
       return {
         status: "waiting-response",
@@ -122,7 +128,7 @@ function NexusIFrameClientProvider({
   children
 }) {
   const config = useNexusConfig();
-  const [iframeElem, setIframElem] = _react.useState.call(void 0, 
+  const [iframeElem, setIframeElem] = _react.useState.call(void 0, 
     void 0
   );
   const client = _react.useMemo.call(void 0, 
@@ -143,10 +149,10 @@ function NexusIFrameClientProvider({
     },
     ref: (iframe) => {
       if (!iframe) {
-        setIframElem(void 0);
+        setIframeElem(void 0);
         return;
       }
-      setIframElem(iframe);
+      setIframeElem(iframe);
     }
   });
   const providerComponent = _react.createElement.call(void 0, 

package/dist/react/index.d.cts

@@ -1,8 +1,8 @@
 import * as react from 'react';
 import { PropsWithChildren, ReactNode } from 'react';
-import { a as NexusWalletSdkConfig, N as NexusClient, W as WalletStatusReturnType, A as ArticleUnlockStatusReturnType } from '../client-gnNyzrko.cjs';
-import * as _tanstack_react_query_build_legacy_types from '@tanstack/react-query/build/legacy/types';
-import { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams } from '../watchUnlockStatus-DvDS55TN.cjs';
+import { a as NexusWalletSdkConfig, N as NexusClient, W as WalletStatusReturnType, A as ArticleUnlockStatusReturnType } from '../client-DWLJ8zR-.cjs';
+import * as _tanstack_react_query from '@tanstack/react-query';
+import { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams } from '../watchUnlockStatus-B4kRztOM.cjs';
 import 'viem';
 import 'viem/chains';
 
@@ -70,7 +70,7 @@ declare function useNexusClient(): NexusClient;
 /**
  * Hook used to get the unlock options for an article
  */
-declare function useArticleUnlockOptions({ articleId }: GetUnlockOptionsParams): _tanstack_react_query_build_legacy_types.UseQueryResult<Readonly<{
+declare function useArticleUnlockOptions({ articleId }: GetUnlockOptionsParams): _tanstack_react_query.UseQueryResult<Readonly<{
     prices: {
         index: number;
         unlockDurationInSec: number;
@@ -85,15 +85,15 @@ type WalletStatusQueryReturnType = WalletStatusReturnType | {
 /**
  * Hooks used to listen to the current wallet status
  */
-declare function useWalletStatus(): _tanstack_react_query_build_legacy_types.UseQueryResult<WalletStatusQueryReturnType, Error>;
+declare function useWalletStatus(): _tanstack_react_query.UseQueryResult<WalletStatusQueryReturnType, Error>;
 
 type ArticleUnlockStatusQueryReturnType = ArticleUnlockStatusReturnType | {
     status: "waiting-response";
     key: "waiting-response";
 };
 /**
- * Hooks used to listen to the current wallet status
+ * Hooks used to listen to the current article unlock status
  */
-declare function useArticleUnlockStatus({ articleId }: WatchUnlockStatusParams): _tanstack_react_query_build_legacy_types.UseQueryResult<ArticleUnlockStatusQueryReturnType, Error>;
+declare function useArticleUnlockStatus({ articleId }: WatchUnlockStatusParams): _tanstack_react_query.UseQueryResult<ArticleUnlockStatusQueryReturnType | null, Error>;
 
 export { type ArticleUnlockStatusQueryReturnType, NexusConfigContext, NexusConfigProvider, type NexusConfigProviderProps, NexusIFrameClientContext, type NexusIFrameClientProps, NexusIFrameClientProvider, type WalletStatusQueryReturnType, useArticleUnlockOptions, useArticleUnlockStatus, useNexusClient, useNexusConfig, useWalletStatus };

package/dist/react/index.d.ts

@@ -1,8 +1,8 @@
 import * as react from 'react';
 import { PropsWithChildren, ReactNode } from 'react';
-import { a as NexusWalletSdkConfig, N as NexusClient, W as WalletStatusReturnType, A as ArticleUnlockStatusReturnType } from '../client-gnNyzrko.js';
-import * as _tanstack_react_query_build_legacy_types from '@tanstack/react-query/build/legacy/types';
-import { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams } from '../watchUnlockStatus-Btjg-WTs.js';
+import { a as NexusWalletSdkConfig, N as NexusClient, W as WalletStatusReturnType, A as ArticleUnlockStatusReturnType } from '../client-DWLJ8zR-.js';
+import * as _tanstack_react_query from '@tanstack/react-query';
+import { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams } from '../watchUnlockStatus--7dFtOJr.js';
 import 'viem';
 import 'viem/chains';
 
@@ -70,7 +70,7 @@ declare function useNexusClient(): NexusClient;
 /**
  * Hook used to get the unlock options for an article
  */
-declare function useArticleUnlockOptions({ articleId }: GetUnlockOptionsParams): _tanstack_react_query_build_legacy_types.UseQueryResult<Readonly<{
+declare function useArticleUnlockOptions({ articleId }: GetUnlockOptionsParams): _tanstack_react_query.UseQueryResult<Readonly<{
     prices: {
         index: number;
         unlockDurationInSec: number;
@@ -85,15 +85,15 @@ type WalletStatusQueryReturnType = WalletStatusReturnType | {
 /**
  * Hooks used to listen to the current wallet status
  */
-declare function useWalletStatus(): _tanstack_react_query_build_legacy_types.UseQueryResult<WalletStatusQueryReturnType, Error>;
+declare function useWalletStatus(): _tanstack_react_query.UseQueryResult<WalletStatusQueryReturnType, Error>;
 
 type ArticleUnlockStatusQueryReturnType = ArticleUnlockStatusReturnType | {
     status: "waiting-response";
     key: "waiting-response";
 };
 /**
- * Hooks used to listen to the current wallet status
+ * Hooks used to listen to the current article unlock status
  */
-declare function useArticleUnlockStatus({ articleId }: WatchUnlockStatusParams): _tanstack_react_query_build_legacy_types.UseQueryResult<ArticleUnlockStatusQueryReturnType, Error>;
+declare function useArticleUnlockStatus({ articleId }: WatchUnlockStatusParams): _tanstack_react_query.UseQueryResult<ArticleUnlockStatusQueryReturnType | null, Error>;
 
 export { type ArticleUnlockStatusQueryReturnType, NexusConfigContext, NexusConfigProvider, type NexusConfigProviderProps, NexusIFrameClientContext, type NexusIFrameClientProps, NexusIFrameClientProvider, type WalletStatusQueryReturnType, useArticleUnlockOptions, useArticleUnlockStatus, useNexusClient, useNexusConfig, useWalletStatus };

package/dist/react/index.js

@@ -61,7 +61,8 @@ function useArticleUnlockOptions({ articleId }) {
       }
       return await getArticleUnlockOptions(client, { articleId });
     },
-    enabled: !!articleId
+    enabled: !!articleId,
+    gcTime: 0
   });
 }
 
@@ -78,6 +79,7 @@ function useWalletStatus() {
     [queryClient]
   );
   return useQuery2({
+    gcTime: 0,
     queryKey: ["walletStatusListener"],
     queryFn: async () => {
       await watchWalletStatus(client, newStatusUpdated);
@@ -103,7 +105,11 @@ function useArticleUnlockStatus({ articleId }) {
   );
   return useQuery3({
     queryKey: ["articleUnlockStatusListener", articleId ?? "no-article-id"],
+    gcTime: 0,
     queryFn: async () => {
+      if (!articleId) {
+        return null;
+      }
       await watchUnlockStatus(client, { articleId }, newStatusUpdated);
       return {
         status: "waiting-response",
@@ -122,7 +128,7 @@ function NexusIFrameClientProvider({
   children
 }) {
   const config = useNexusConfig();
-  const [iframeElem, setIframElem] = useState(
+  const [iframeElem, setIframeElem] = useState(
     void 0
   );
   const client = useMemo(
@@ -143,10 +149,10 @@ function NexusIFrameClientProvider({
     },
     ref: (iframe) => {
       if (!iframe) {
-        setIframElem(void 0);
+        setIframeElem(void 0);
         return;
       }
-      setIframElem(iframe);
+      setIframeElem(iframe);
     }
   });
   const providerComponent = createElement2(

package/dist/{watchUnlockStatus-Btjg-WTs.d.ts → watchUnlockStatus--7dFtOJr.d.ts}

@@ -1,5 +1,5 @@
 import { Hex } from 'viem';
-import { N as NexusClient, A as ArticleUnlockStatusReturnType } from './client-gnNyzrko.js';
+import { N as NexusClient, A as ArticleUnlockStatusReturnType } from './client-DWLJ8zR-.js';
 
 /**
  * Type used to get the unlock options

package/dist/{watchUnlockStatus-DvDS55TN.d.cts → watchUnlockStatus-B4kRztOM.d.cts}

@@ -1,5 +1,5 @@
 import { Hex } from 'viem';
-import { N as NexusClient, A as ArticleUnlockStatusReturnType } from './client-gnNyzrko.cjs';
+import { N as NexusClient, A as ArticleUnlockStatusReturnType } from './client-DWLJ8zR-.cjs';
 
 /**
  * Type used to get the unlock options

package/package.json

@@ -11,7 +11,7 @@
       "url": "https://twitter.com/QNivelais"
     }
   ],
-  "version": "0.0.4",
+  "version": "0.0.7",
   "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",
@@ -72,7 +72,7 @@
     "js-sha256": "^0.11.0"
   },
   "devDependencies": {
-    "@tanstack/react-query": ">=5.0.0",
+    "@tanstack/react-query": ">=5.29.2",
     "@types/node": "^20",
     "tsup": "^8.0.2",
     "typescript": "^5"