@vue-solana/vue 4.0.0-rc.1 → 4.0.0

package/README.md

@@ -7,6 +7,16 @@
 
 Solana wallet, RPC, account, message signing, and transaction composables for Vue 3.
 
+## Related packages
+
+This package is part of the Vue Solana family. Choose based on your app framework:
+
+- [`@vue-solana/core`](https://www.npmjs.com/package/@vue-solana/core) — framework-agnostic Solana primitives: Kit RPC client helpers, wallet types, Android MWA registration, iOS browser wallet helpers, message signing, token account reads, and transaction helpers. **Use this directly** when you want shared RPC/wallet/transaction helpers without installing a Vue plugin (non-Vue apps, server/relayer code, or your own framework integration).
+- [`@vue-solana/vue`](https://www.npmjs.com/package/@vue-solana/vue) — Vue 3 plugin plus composables for RPC, account, balance, wallet, message signing, live data, and transactions. **Use this** in plain Vue 3 apps (Vite, etc.). (This package.)
+- [`@vue-solana/nuxt`](https://www.npmjs.com/package/@vue-solana/nuxt) — Nuxt module that installs the Vue plugin and auto-imports the composables. **Use this** in Nuxt 3/4 apps.
+
+This package builds on `@vue-solana/core`; install `@vue-solana/vue` for plain Vue apps and `@vue-solana/nuxt` for Nuxt apps.
+
 Use this package in Vue 3 apps that need Solana RPC access, balance reads, wallet state, message signing, and transaction helper state.
 
 New to Solana? Start with the official docs and the project concepts guide:
@@ -64,20 +74,22 @@ import { createApp } from "vue";
 import { createSolanaPlugin } from "@vue-solana/vue";
 import App from "./App.vue";
 
-createApp(App)
-  .use(
-    createSolanaPlugin({
-      cluster: "devnet",
-      mobileWallet: {
-        appIdentity: {
-          name: "My Vue Solana App",
-          uri: "https://example.com",
-          icon: "favicon.ico",
-        },
-      },
-    }),
-  )
-  .mount("#app");
+const solana = createSolanaPlugin({
+  cluster: "devnet",
+  mobileWallet: {
+    appIdentity: {
+      name: "My Vue Solana App",
+      uri: "https://example.com",
+      icon: "favicon.ico",
+    },
+  },
+});
+
+createApp(App).use(solana).mount("#app");
+
+// On teardown:
+// app.unmount();
+// solana.dispose();
 ```
 
 Android Mobile Wallet Adapter registration is enabled by default on supported Android Chrome clients. Pass `mobileWallet` options to customize the MWA app identity, or pass `mobileWallet: false` to disable Android mobile wallet registration.
@@ -227,6 +239,8 @@ const signatureStatus = useSignatureStatus(signature, {
 });
 ```
 
+There is no per-call `commitment` option for `useSignatureStatus()`; `getSignatureStatuses` takes no per-call commitment, so reads use the commitment baked into the endpoint. Polling uses chained timeouts and `stopPolling()` prevents further ticks until the watched signature changes (which restarts polling). Invalid `pollIntervalMs` values return an `RPC_FAILURE` `SolanaError`.
+
 Read SPL token accounts and balances through Kit RPC `jsonParsed`:
 
 ```ts
@@ -490,7 +504,7 @@ import { useRequestSwr } from "@vue-solana/vue/swr";
 const balance = useRequestSwr(["balance", address], () => client.rpc.getBalance(address).send());
 ```
 
-The SWR cache is module-level and shared across the whole app, including across SSR requests. Namespace cache keys per request (for example by including a request or session id) or call `clearSwrCache()` at the start of each server request to avoid leaking one request's cached data into another. On the client the cache is intentionally shared for stale-while-revalidate seeding.
+The SWR cache is module-level and shared across the whole app, including across SSR requests. Namespace cache keys per request (for example by including a request or session id) or call `clearSwrCache()` at the start of each server request to avoid leaking one request's cached data into another. On the client the cache is intentionally shared for stale-while-revalidate seeding. It is capped at 1024 entries with oldest-first eviction. Use `deleteSwrKey(key)` to evict a single entry by its full cache key (including the adapter prefix like `request:`).
 
 ### Cancellation & Timeouts
 
@@ -594,9 +608,9 @@ Docs: [Vue Solana Agent Skill](https://vue-solana-docs.vercel.app/agent-skill)
 
 | API                                                                                        | Description                                                                                                                              |
 | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
-| `createSolanaPlugin(options?)`                                                             | Installs the Vue Solana context.                                                                                                         |
+| `createSolanaPlugin(options?)`                                                             | Installs the Vue Solana context and returns `{ install, context, dispose }`. `dispose()` stops wallet discovery/subscriptions.           |
 | `VueSolana`                                                                                | Alias for `createSolanaPlugin`.                                                                                                          |
-| `useSolana()`                                                                              | Returns the full injected Solana context; throws when no plugin context is available.                                                    |
+| `useSolana()`                                                                              | Returns the full injected Solana context; throws when no plugin context is available (SSR fallback uses a fresh inert context per call). |
 | `tryUseSolana()`                                                                           | Returns the injected Solana context or `null` when no plugin context is available (SSR-safe).                                            |
 | `MissingClientCapabilityError`                                                             | Thrown by `useClientCapability()` (and client-sent composables) when the configured client lacks a required capability.                  |
 | `useRpc()`                                                                                 | Returns cluster, endpoint, connection status, latest blockhash, the Kit `client`, and `checkConnection()`.                               |
@@ -621,12 +635,14 @@ Docs: [Vue Solana Agent Skill](https://vue-solana-docs.vercel.app/agent-skill)
 | `useTrackedData(source, options?)`                                                         | Slot-deduplicated fetch plus subscription over Kit's slot-tracking store.                                                                |
 | `useRequestSwr(key, ...)` / `useSubscriptionSwr(key, ...)` / `useTrackedDataSwr(key, ...)` | Cache-keyed SWR adapters seeding fresh mounts from the last-known result.                                                                |
 | `clearSwrCache()`                                                                          | Clears every cached SWR entry.                                                                                                           |
+| `deleteSwrKey(key)`                                                                        | Removes a single cached SWR entry by full cache key (including adapter prefix).                                                          |
 | `useSignIn(input?)`                                                                        | Sign In With Solana (SIWS) trigger returning `{ account, signedMessage, signature }` for server-side verification.                       |
 | `useSelectedWalletAccount()`                                                               | App-wide selected wallet account context: `[selectedAccount, setSelectedAccount, filteredWallets]`.                                      |
 | `SelectedWalletAccountProvider`                                                            | Component that provides the selected wallet account context to its subtree.                                                              |
 | `useSignTransactions()`                                                                    | Batch-signs transactions through the wallet, preferring `signTransactions` and falling back to `signAllTransactions`.                    |
 | `useSignAndSendTransactions()`                                                             | Signs and sends multiple transactions, returning one signature each, with a singular sequential fallback.                                |
 | `useClientCapability(capability, options?)`                                                | Fails fast with a clear error when the configured Solana client lacks a requested capability.                                            |
+| `tryUseSolana()`                                                                           | Returns the injected Solana context or `null` when no plugin context is available (SSR-safe).                                            |
 | `usePayer()`                                                                               | Reactive Kit client `payer` signer ref. The default client exposes a configured payer when supplied.                                     |
 | `useIdentity()`                                                                            | Reactive Kit client `identity` signer ref (requires an identity signer on a custom client).                                              |
 | `usePlanTransaction()`                                                                     | Plans a single transaction message from instruction inputs without signing or sending; the default client includes the official planner. |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vue-solana/vue",
-  "version": "4.0.0-rc.1",
+  "version": "4.0.0",
   "description": "Vue plugin and composables for Solana applications.",
   "license": "MIT",
   "keywords": [
@@ -178,7 +178,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@vue-solana/core": "4.0.0-rc.1"
+    "@vue-solana/core": "4.0.0"
   },
   "peerDependencies": {
     "vue": "^3.5.0"