@defjs/vue 0.0.2 → 0.0.3

package/README.md

@@ -10,7 +10,7 @@ Keeping SDK definitions in their own package means the SDK needs no Vue dependen
 bun add @defjs/core @defjs/vue vue
 ```
 
-The package is ESM and requires `@defjs/core` as a peer in the `^0.5.0` range.
+The package is ESM and requires `@defjs/core` as a peer in the `^0.6.0` range.
 
 ## Quick start
 
@@ -46,7 +46,7 @@ watch(
     const abort = new AbortController();
     onCleanup(() => abort.abort());
 
-    void getUser(client({ abort: abort.signal }), { id }).then(
+    void getUser(client({ signal: abort.signal }), { id }).then(
       ([error, user]) => {
         if (abort.signal.aborted) return;
         if (error) {
@@ -72,13 +72,13 @@ watch(
 
 Creates a Vue plugin that provides the supplied client as `HTTP_CLIENT`.
 
-### `injectClient(key?): Client`
+### `injectClient(key?): DerivableClient`
 
 Returns the nearest client for `key`, defaulting to `HTTP_CLIENT`. Call it in a valid injection context: synchronous `setup()` or `app.runWithContext()` (Vue 3.3+). Throws without an active context or a client for the key; a missing custom key never falls back to `HTTP_CLIENT`.
 
 ### `HTTP_CLIENT`
 
-Public `InjectionKey<Client>` for native subtree overrides:
+Public `InjectionKey<DerivableClient>` for native subtree overrides:
 
 ```ts
 provide(HTTP_CLIENT, createClient(withEndpoint("https://preview.example.com")));
@@ -98,7 +98,7 @@ app.use(createClientPlugin(client));
 
 ## Notes
 
-- `Client` is a function. `injectClient()` returns that same function. Pass it straight to `createClientPlugin` or `provide`. Do not pass it to `watch` or `computed` as the source: Vue calls a function source. Do not wrap it in `ref` or `reactive`; the plugin stores the function as-is.
+- `injectClient()` returns the `DerivableClient` that was provided, a function. Call it with request options where the operation runs to derive a `Client` value. Pass it straight to `createClientPlugin` or `provide`. Do not pass it to `watch` or `computed` as the source: Vue calls a function source. Do not wrap it in `ref` or `reactive`; the plugin stores it as-is. A derived `Client` value is not accepted.
 - Create request-specific clients (SSR data with credentials, cookies, or tenant state) at the application boundary.
 - The owner that creates a client also owns its requests, SSE streams, and WebSocket sessions. App unmount does not clean them up.
 - Import `createClient`, `withEndpoint`, `withInterceptors`, and other client options from `@defjs/core`.

package/index.d.ts

@@ -1,42 +1,42 @@
 import { InjectionKey, Plugin } from "vue";
-import { Client } from "@defjs/core";
+import { DerivableClient } from "@defjs/core";
 /**
- * Vue injection key for the Defjs {@link Client} provided by {@link createClientPlugin}.
+ * Vue injection key for the Defjs {@link DerivableClient} provided by {@link createClientPlugin}.
  *
  * Prefer {@link injectClient} over calling `inject(HTTP_CLIENT)` directly. `inject(HTTP_CLIENT)` returns `undefined` when nothing was provided. Override a subtree with `provide(HTTP_CLIENT, childClient)`.
  *
  * @group vue
- * @see {@link Client}
+ * @see {@link DerivableClient}
  * @see {@link injectClient}
  */
-export declare const HTTP_CLIENT: InjectionKey<Client>;
+export declare const HTTP_CLIENT: InjectionKey<DerivableClient>;
 /**
  * Create a Vue plugin that provides an existing Defjs client via {@link HTTP_CLIENT}.
  *
- * Does not create, cache, or dispose the client — pass the function from `createClient`. Installing it calls `app.provide(HTTP_CLIENT, client)`, so components read the client with `injectClient()`. The client is stored as that function: it is not wrapped in `ref`, `reactive`, or `markRaw`.
+ * Does not create, cache, or dispose the client — pass the client returned by `createClient`. Installing it calls `app.provide(HTTP_CLIENT, client)`, so components read the client with `injectClient()`. The client is stored as given: it is not wrapped in `ref`, `reactive`, or `markRaw`.
  *
- * @param client - The client function to provide to the app.
+ * @param client - The client returned by `createClient` to provide to the app.
  * @returns A Vue `Plugin` for `app.use(...)`.
  *
  * @group vue
- * @see {@link Client}
+ * @see {@link DerivableClient}
  * @exampleFile examples/api/create-client-plugin.ts#example
  */
-export declare function createClientPlugin(client: Client): Plugin;
+export declare function createClientPlugin(client: DerivableClient): Plugin;
 /**
  * Vue composable that injects the Defjs client for a key, defaulting to {@link HTTP_CLIENT}.
  *
  * `injectClient(key)` reads the nearest provider for that key; omitted or `undefined` uses `HTTP_CLIENT`. Call in a valid Vue injection context: synchronous `setup()`, compiler-restored `<script setup>` after top-level `await`, or a synchronous `app.runWithContext()` callback (Vue 3.3+). `app.runWithContext()` supplies only synchronous app-level context, not subtree overrides or context across ordinary `await`.
  *
- * For a custom `InjectionKey<Client>`, use `app.provide(key, client)` or an ancestor’s `provide(key, client)`. Share the same `Symbol` object; matching descriptions do not make keys equal. `createClientPlugin(client)` still takes only the client and provides `HTTP_CLIENT`.
+ * For a custom `InjectionKey<DerivableClient>`, use `app.provide(key, client)` or an ancestor’s `provide(key, client)`. Share the same `Symbol` object; matching descriptions do not make keys equal. `createClientPlugin(client)` still takes only the client and provides `HTTP_CLIENT`.
  *
- * It returns the exact client function provided for the selected key, and throws an `Error` without an active injection context or a client for the selected key. Installing the plugin alone does not establish an injection context.
+ * It returns the exact client value provided for the selected key, and throws an `Error` without an active injection context or a client for the selected key. Installing the plugin alone does not establish an injection context.
  *
- * `Client` is callable. Pass it to `provide` as-is. Do not pass it to `watch` or `computed` as the source: Vue calls a function source. Do not wrap it in `ref` or `reactive`.
+ * The injected `DerivableClient` is a function. Call it with request options at the call site to derive a `Client` value for one call: `getUser(client({ signal }), input)`. Do not pass it to `watch` or `computed` as the source: Vue calls a function source. Do not wrap it in `ref` or `reactive`. The provider holds only a root client; a derived `Client` value is not accepted, so create it where the operation is called.
  *
  * @param key - Injection key; use the same object with `app.provide` or `provide`.
  * Defaults to `HTTP_CLIENT`, as provided by {@link createClientPlugin}.
- * @returns The injected client function.
+ * @returns The injected derivable client.
  * @throws If called outside a Vue injection context or no client was provided for
  * the requested key. A missing custom key does not fall back to `HTTP_CLIENT`.
  *
@@ -45,6 +45,6 @@ export declare function createClientPlugin(client: Client): Plugin;
  * const client = injectClient()
  * ```
  * @group vue
- * @see {@link Client}
+ * @see {@link DerivableClient}
  */
-export declare function injectClient(key?: InjectionKey<Client>): Client;
+export declare function injectClient(key?: InjectionKey<DerivableClient>): DerivableClient;

package/index.js

@@ -1,25 +1,25 @@
 import { inject } from "vue";
 // src/core.ts
 /**
-* Vue injection key for the Defjs {@link Client} provided by {@link createClientPlugin}.
+* Vue injection key for the Defjs {@link DerivableClient} provided by {@link createClientPlugin}.
 *
 * Prefer {@link injectClient} over calling `inject(HTTP_CLIENT)` directly. `inject(HTTP_CLIENT)` returns `undefined` when nothing was provided. Override a subtree with `provide(HTTP_CLIENT, childClient)`.
 *
 * @group vue
-* @see {@link Client}
+* @see {@link DerivableClient}
 * @see {@link injectClient}
 */
 const HTTP_CLIENT = Symbol("HTTP_CLIENT");
 /**
 * Create a Vue plugin that provides an existing Defjs client via {@link HTTP_CLIENT}.
 *
-* Does not create, cache, or dispose the client — pass the function from `createClient`. Installing it calls `app.provide(HTTP_CLIENT, client)`, so components read the client with `injectClient()`. The client is stored as that function: it is not wrapped in `ref`, `reactive`, or `markRaw`.
+* Does not create, cache, or dispose the client — pass the client returned by `createClient`. Installing it calls `app.provide(HTTP_CLIENT, client)`, so components read the client with `injectClient()`. The client is stored as given: it is not wrapped in `ref`, `reactive`, or `markRaw`.
 *
-* @param client - The client function to provide to the app.
+* @param client - The client returned by `createClient` to provide to the app.
 * @returns A Vue `Plugin` for `app.use(...)`.
 *
 * @group vue
-* @see {@link Client}
+* @see {@link DerivableClient}
 * @exampleFile examples/api/create-client-plugin.ts#example
 */
 function createClientPlugin(client) {
@@ -32,15 +32,15 @@ function createClientPlugin(client) {
 *
 * `injectClient(key)` reads the nearest provider for that key; omitted or `undefined` uses `HTTP_CLIENT`. Call in a valid Vue injection context: synchronous `setup()`, compiler-restored `<script setup>` after top-level `await`, or a synchronous `app.runWithContext()` callback (Vue 3.3+). `app.runWithContext()` supplies only synchronous app-level context, not subtree overrides or context across ordinary `await`.
 *
-* For a custom `InjectionKey<Client>`, use `app.provide(key, client)` or an ancestor’s `provide(key, client)`. Share the same `Symbol` object; matching descriptions do not make keys equal. `createClientPlugin(client)` still takes only the client and provides `HTTP_CLIENT`.
+* For a custom `InjectionKey<DerivableClient>`, use `app.provide(key, client)` or an ancestor’s `provide(key, client)`. Share the same `Symbol` object; matching descriptions do not make keys equal. `createClientPlugin(client)` still takes only the client and provides `HTTP_CLIENT`.
 *
-* It returns the exact client function provided for the selected key, and throws an `Error` without an active injection context or a client for the selected key. Installing the plugin alone does not establish an injection context.
+* It returns the exact client value provided for the selected key, and throws an `Error` without an active injection context or a client for the selected key. Installing the plugin alone does not establish an injection context.
 *
-* `Client` is callable. Pass it to `provide` as-is. Do not pass it to `watch` or `computed` as the source: Vue calls a function source. Do not wrap it in `ref` or `reactive`.
+* The injected `DerivableClient` is a function. Call it with request options at the call site to derive a `Client` value for one call: `getUser(client({ signal }), input)`. Do not pass it to `watch` or `computed` as the source: Vue calls a function source. Do not wrap it in `ref` or `reactive`. The provider holds only a root client; a derived `Client` value is not accepted, so create it where the operation is called.
 *
 * @param key - Injection key; use the same object with `app.provide` or `provide`.
 * Defaults to `HTTP_CLIENT`, as provided by {@link createClientPlugin}.
-* @returns The injected client function.
+* @returns The injected derivable client.
 * @throws If called outside a Vue injection context or no client was provided for
 * the requested key. A missing custom key does not fall back to `HTTP_CLIENT`.
 *
@@ -49,7 +49,7 @@ function createClientPlugin(client) {
 * const client = injectClient()
 * ```
 * @group vue
-* @see {@link Client}
+* @see {@link DerivableClient}
 */
 function injectClient(key = HTTP_CLIENT) {
 	const client = inject(key);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defjs/vue",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Provide an existing Defjs client to a Vue application.",
   "bugs": {
     "url": "https://github.com/defjs/defjs/issues"
@@ -14,7 +14,7 @@
   "main": "./index.js",
   "types": "./index.d.ts",
   "peerDependencies": {
-    "@defjs/core": "^0.5.0",
+    "@defjs/core": "^0.6.0",
     "vue": ">=3.0.0"
   },
   "module": "./index.js",