@spoosh/core 0.10.0 → 0.10.1

package/README.md

@@ -1,6 +1,6 @@
 # @spoosh/core
 
-Core client and plugin system for Spoosh - a type-safe API client framework.
+Core client and plugin system for Spoosh - a type-safe API toolkit.
 
 **[Documentation](https://spoosh.dev/docs/react)** · **Requirements:** TypeScript >= 5.0
 
@@ -188,7 +188,7 @@ Path parameters are defined using `:param` syntax in the path key (e.g., `"users
 
 ### createClient(config)
 
-Creates a lightweight type-safe API client.
+Creates a lightweight type-safe API instance.
 
 | Option           | Type                 | Description                                        |
 | ---------------- | -------------------- | -------------------------------------------------- |
@@ -228,12 +228,12 @@ const { data } = await api("users").GET();
 
 **Properties:**
 
-| Property          | Description                              |
-| ----------------- | ---------------------------------------- |
-| `.api`            | Type-safe API client for making requests |
-| `.stateManager`   | Cache and state management               |
-| `.eventEmitter`   | Event system for refetch/invalidation    |
-| `.pluginExecutor` | Plugin lifecycle management              |
+| Property          | Description                                 |
+| ----------------- | ------------------------------------------- |
+| `.api`            | Type-safe API interface for making requests |
+| `.stateManager`   | Cache and state management                  |
+| `.eventEmitter`   | Event system for refetch/invalidation       |
+| `.pluginExecutor` | Plugin lifecycle management                 |
 
 ## Creating Plugins
 

package/dist/index.d.mts

@@ -1060,7 +1060,7 @@ type PathMethods<TSchema, TPath extends string, TDefaultError> = FindMatchingKey
  */
 type SchemaPaths<TSchema> = keyof TSchema & string;
 /**
- * An API client that uses path strings instead of chained property access.
+ * An API interface that uses path strings instead of chained property access.
  * Methods use HTTP names directly: GET, POST, PUT, PATCH, DELETE.
  *
  * @example
@@ -1091,7 +1091,7 @@ type ReadPathMethods<TSchema, TPath extends string, TDefaultError> = FindMatchin
     GET: MethodFn<TSchema[TKey]["GET"], TDefaultError, TPath>;
 }> : never : never : never;
 /**
- * A read-only API client that only exposes GET methods.
+ * A read-only API interface that only exposes GET methods.
  * Used by useRead and injectRead hooks.
  */
 type ReadClient<TSchema, TDefaultError = unknown> = <TPath extends ReadPaths<TSchema> | (string & {})>(path: TPath) => HasReadMethod<TSchema, TPath> extends true ? ReadPathMethods<TSchema, TPath, TDefaultError> : never;
@@ -1103,7 +1103,7 @@ type WritePathMethods<TSchema, TPath extends string, TDefaultError> = FindMatchi
     [M in WriteMethod as M extends keyof TSchema[TKey] ? M : never]: M extends keyof TSchema[TKey] ? MethodFn<TSchema[TKey][M], TDefaultError, TPath> : never;
 }> : never : never;
 /**
- * A write-only API client that only exposes mutation methods (POST, PUT, PATCH, DELETE).
+ * A write-only API interface that only exposes mutation methods (POST, PUT, PATCH, DELETE).
  * Used by useWrite and injectWrite hooks.
  */
 type WriteClient<TSchema, TDefaultError = unknown> = <TPath extends WritePaths<TSchema> | (string & {})>(path: TPath) => HasWriteMethod<TSchema, TPath> extends true ? WritePathMethods<TSchema, TPath, TDefaultError> : never;
@@ -1246,7 +1246,7 @@ declare class Spoosh<TSchema = unknown, TError = unknown, TPlugins extends Plugi
      */
     private getInstance;
     /**
-     * The type-safe API client for making requests.
+     * The type-safe API interface for making requests.
      *
      * Provides a proxy-based interface for accessing endpoints defined in your schema.
      *
@@ -1352,13 +1352,13 @@ type SpooshClientConfig = {
     middlewares?: SpooshMiddleware[];
 };
 /**
- * Creates a lightweight type-safe API client for vanilla JavaScript/TypeScript usage.
+ * Creates a lightweight type-safe API instance for vanilla JavaScript/TypeScript usage.
  *
  * This is a simpler alternative to `Spoosh` for users who don't need
  * the full plugin system, state management, or React integration.
  *
  * @param config - Client configuration
- * @returns Type-safe API client
+ * @returns Type-safe API instance
  *
  * @example
  * ```ts
@@ -1456,7 +1456,7 @@ type ProxyHandlerConfig<TOptions = SpooshOptions> = {
     nextTags?: boolean;
 };
 /**
- * Creates an API client proxy that uses path strings instead of chained property access.
+ * Creates an API proxy that uses path strings instead of chained property access.
  * Methods use HTTP names directly: GET, POST, PUT, PATCH, DELETE.
  *
  * @param config - Proxy handler configuration
@@ -1474,7 +1474,7 @@ type ProxyHandlerConfig<TOptions = SpooshOptions> = {
  */
 declare function createProxyHandler<TSchema, TDefaultError = unknown, TOptions = SpooshOptions>(config: ProxyHandlerConfig<TOptions>): SpooshClient<TSchema, TDefaultError>;
 
-/** All supported HTTP method keys used in the API client */
+/** All supported HTTP method keys used in the API toolkit */
 declare const HTTP_METHODS: readonly ["GET", "POST", "PUT", "PATCH", "DELETE"];
 /** Union type of all HTTP method keys */
 type HttpMethodKey = (typeof HTTP_METHODS)[number];

package/dist/index.d.ts

@@ -1060,7 +1060,7 @@ type PathMethods<TSchema, TPath extends string, TDefaultError> = FindMatchingKey
  */
 type SchemaPaths<TSchema> = keyof TSchema & string;
 /**
- * An API client that uses path strings instead of chained property access.
+ * An API interface that uses path strings instead of chained property access.
  * Methods use HTTP names directly: GET, POST, PUT, PATCH, DELETE.
  *
  * @example
@@ -1091,7 +1091,7 @@ type ReadPathMethods<TSchema, TPath extends string, TDefaultError> = FindMatchin
     GET: MethodFn<TSchema[TKey]["GET"], TDefaultError, TPath>;
 }> : never : never : never;
 /**
- * A read-only API client that only exposes GET methods.
+ * A read-only API interface that only exposes GET methods.
  * Used by useRead and injectRead hooks.
  */
 type ReadClient<TSchema, TDefaultError = unknown> = <TPath extends ReadPaths<TSchema> | (string & {})>(path: TPath) => HasReadMethod<TSchema, TPath> extends true ? ReadPathMethods<TSchema, TPath, TDefaultError> : never;
@@ -1103,7 +1103,7 @@ type WritePathMethods<TSchema, TPath extends string, TDefaultError> = FindMatchi
     [M in WriteMethod as M extends keyof TSchema[TKey] ? M : never]: M extends keyof TSchema[TKey] ? MethodFn<TSchema[TKey][M], TDefaultError, TPath> : never;
 }> : never : never;
 /**
- * A write-only API client that only exposes mutation methods (POST, PUT, PATCH, DELETE).
+ * A write-only API interface that only exposes mutation methods (POST, PUT, PATCH, DELETE).
  * Used by useWrite and injectWrite hooks.
  */
 type WriteClient<TSchema, TDefaultError = unknown> = <TPath extends WritePaths<TSchema> | (string & {})>(path: TPath) => HasWriteMethod<TSchema, TPath> extends true ? WritePathMethods<TSchema, TPath, TDefaultError> : never;
@@ -1246,7 +1246,7 @@ declare class Spoosh<TSchema = unknown, TError = unknown, TPlugins extends Plugi
      */
     private getInstance;
     /**
-     * The type-safe API client for making requests.
+     * The type-safe API interface for making requests.
      *
      * Provides a proxy-based interface for accessing endpoints defined in your schema.
      *
@@ -1352,13 +1352,13 @@ type SpooshClientConfig = {
     middlewares?: SpooshMiddleware[];
 };
 /**
- * Creates a lightweight type-safe API client for vanilla JavaScript/TypeScript usage.
+ * Creates a lightweight type-safe API instance for vanilla JavaScript/TypeScript usage.
  *
  * This is a simpler alternative to `Spoosh` for users who don't need
  * the full plugin system, state management, or React integration.
  *
  * @param config - Client configuration
- * @returns Type-safe API client
+ * @returns Type-safe API instance
  *
  * @example
  * ```ts
@@ -1456,7 +1456,7 @@ type ProxyHandlerConfig<TOptions = SpooshOptions> = {
     nextTags?: boolean;
 };
 /**
- * Creates an API client proxy that uses path strings instead of chained property access.
+ * Creates an API proxy that uses path strings instead of chained property access.
  * Methods use HTTP names directly: GET, POST, PUT, PATCH, DELETE.
  *
  * @param config - Proxy handler configuration
@@ -1474,7 +1474,7 @@ type ProxyHandlerConfig<TOptions = SpooshOptions> = {
  */
 declare function createProxyHandler<TSchema, TDefaultError = unknown, TOptions = SpooshOptions>(config: ProxyHandlerConfig<TOptions>): SpooshClient<TSchema, TDefaultError>;
 
-/** All supported HTTP method keys used in the API client */
+/** All supported HTTP method keys used in the API toolkit */
 declare const HTTP_METHODS: readonly ["GET", "POST", "PUT", "PATCH", "DELETE"];
 /** Union type of all HTTP method keys */
 type HttpMethodKey = (typeof HTTP_METHODS)[number];

package/dist/index.js

@@ -1147,7 +1147,7 @@ var Spoosh = class _Spoosh {
     return this._instance;
   }
   /**
-   * The type-safe API client for making requests.
+   * The type-safe API interface for making requests.
    *
    * Provides a proxy-based interface for accessing endpoints defined in your schema.
    *
@@ -1318,6 +1318,7 @@ function createOperationController(options) {
     if (cached) {
       stateManager.setCache(queryKey, {
         state: { ...cached.state, ...updater },
+        tags,
         stale: false
       });
     } else {

package/dist/index.mjs

@@ -1083,7 +1083,7 @@ var Spoosh = class _Spoosh {
     return this._instance;
   }
   /**
-   * The type-safe API client for making requests.
+   * The type-safe API interface for making requests.
    *
    * Provides a proxy-based interface for accessing endpoints defined in your schema.
    *
@@ -1254,6 +1254,7 @@ function createOperationController(options) {
     if (cached) {
       stateManager.setCache(queryKey, {
         state: { ...cached.state, ...updater },
+        tags,
         stale: false
       });
     } else {

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@spoosh/core",
-  "version": "0.10.0",
+  "version": "0.10.1",
   "license": "MIT",
-  "description": "Type-safe API client with plugin middleware system",
+  "description": "Type-safe API toolkit with plugin middleware system",
   "keywords": [
     "spoosh",
-    "api-client",
+    "api-toolkit",
     "fetch",
     "typescript",
     "middleware",