@spoosh/core 0.11.1 → 0.12.0

package/dist/index.d.mts

@@ -279,13 +279,16 @@ type PluginContext = {
     readonly method: HttpMethod;
     readonly queryKey: string;
     readonly tags: string[];
-    /** Timestamp when this request was initiated. Useful for tracing and debugging. */
     readonly requestTimestamp: number;
-    /** Unique identifier for the hook instance. Persists across queryKey changes within the same hook. */
-    readonly hookId?: string;
+    /** Unique identifier for this usage instance. Persists across queryKey changes. */
+    readonly instanceId?: string;
+    /** Request options with resolved headers. Modify to customize the request (e.g., add headers, signal, body). */
     request: PluginRequestOptions;
+    /** Temporary storage for inter-plugin communication during a single request lifecycle. Data stored here doesn't persist beyond the request. */
     temp: Map<string, unknown>;
+    /** State manager for accessing and modifying cache entries. */
     stateManager: StateManager;
+    /** Event emitter for triggering refetch, invalidation, and other events. */
     eventEmitter: EventEmitter;
     /** Access other plugins' exported APIs */
     plugins: PluginAccessor;
@@ -1610,7 +1613,7 @@ type CreateOperationOptions<TData, TError> = {
     pluginExecutor: PluginExecutor;
     fetchFn: (options: AnyRequestOptions) => Promise<SpooshResponse<TData, TError>>;
     /** Unique identifier for the hook instance. Persists across queryKey changes. */
-    hookId?: string;
+    instanceId?: string;
 };
 declare function createOperationController<TData, TError>(options: CreateOperationOptions<TData, TError>): OperationController<TData, TError>;
 
@@ -1663,7 +1666,7 @@ type CreateInfiniteReadOptions<TData, TItem, TError, TRequest> = {
     pluginExecutor: PluginExecutor;
     fetchFn: (options: InfiniteRequestOptions, signal: AbortSignal) => Promise<SpooshResponse<TData, TError>>;
     /** Unique identifier for the hook instance. Persists across queryKey changes. */
-    hookId?: string;
+    instanceId?: string;
 };
 declare function createInfiniteReadController<TData, TItem, TError, TRequest extends InfiniteRequestOptions = InfiniteRequestOptions>(options: CreateInfiniteReadOptions<TData, TItem, TError, TRequest>): InfiniteReadController<TData, TItem, TError>;
 

package/dist/index.d.ts

@@ -279,13 +279,16 @@ type PluginContext = {
     readonly method: HttpMethod;
     readonly queryKey: string;
     readonly tags: string[];
-    /** Timestamp when this request was initiated. Useful for tracing and debugging. */
     readonly requestTimestamp: number;
-    /** Unique identifier for the hook instance. Persists across queryKey changes within the same hook. */
-    readonly hookId?: string;
+    /** Unique identifier for this usage instance. Persists across queryKey changes. */
+    readonly instanceId?: string;
+    /** Request options with resolved headers. Modify to customize the request (e.g., add headers, signal, body). */
     request: PluginRequestOptions;
+    /** Temporary storage for inter-plugin communication during a single request lifecycle. Data stored here doesn't persist beyond the request. */
     temp: Map<string, unknown>;
+    /** State manager for accessing and modifying cache entries. */
     stateManager: StateManager;
+    /** Event emitter for triggering refetch, invalidation, and other events. */
     eventEmitter: EventEmitter;
     /** Access other plugins' exported APIs */
     plugins: PluginAccessor;
@@ -1610,7 +1613,7 @@ type CreateOperationOptions<TData, TError> = {
     pluginExecutor: PluginExecutor;
     fetchFn: (options: AnyRequestOptions) => Promise<SpooshResponse<TData, TError>>;
     /** Unique identifier for the hook instance. Persists across queryKey changes. */
-    hookId?: string;
+    instanceId?: string;
 };
 declare function createOperationController<TData, TError>(options: CreateOperationOptions<TData, TError>): OperationController<TData, TError>;
 
@@ -1663,7 +1666,7 @@ type CreateInfiniteReadOptions<TData, TItem, TError, TRequest> = {
     pluginExecutor: PluginExecutor;
     fetchFn: (options: InfiniteRequestOptions, signal: AbortSignal) => Promise<SpooshResponse<TData, TError>>;
     /** Unique identifier for the hook instance. Persists across queryKey changes. */
-    hookId?: string;
+    instanceId?: string;
 };
 declare function createInfiniteReadController<TData, TItem, TError, TRequest extends InfiniteRequestOptions = InfiniteRequestOptions>(options: CreateInfiniteReadOptions<TData, TItem, TError, TRequest>): InfiniteReadController<TData, TItem, TError>;
 

package/dist/index.js

@@ -1232,7 +1232,7 @@ function createOperationController(options) {
     eventEmitter,
     pluginExecutor,
     fetchFn,
-    hookId
+    instanceId
   } = options;
   const queryKey = stateManager.createQueryKey({
     path,
@@ -1255,7 +1255,7 @@ function createOperationController(options) {
       queryKey,
       tags: resolvedTags,
       requestTimestamp,
-      hookId,
+      instanceId,
       request: {
         ...initialRequestOptions,
         ...requestOptions,
@@ -1450,7 +1450,7 @@ function createInfiniteReadController(options) {
     eventEmitter,
     pluginExecutor,
     fetchFn,
-    hookId
+    instanceId
   } = options;
   let pageKeys = [];
   let pageRequests = /* @__PURE__ */ new Map();
@@ -1550,7 +1550,7 @@ function createInfiniteReadController(options) {
       queryKey: pageKey,
       tags,
       requestTimestamp: Date.now(),
-      hookId,
+      instanceId,
       request: { headers: {} },
       temp: /* @__PURE__ */ new Map(),
       pluginOptions,

package/dist/index.mjs

@@ -1171,7 +1171,7 @@ function createOperationController(options) {
     eventEmitter,
     pluginExecutor,
     fetchFn,
-    hookId
+    instanceId
   } = options;
   const queryKey = stateManager.createQueryKey({
     path,
@@ -1194,7 +1194,7 @@ function createOperationController(options) {
       queryKey,
       tags: resolvedTags,
       requestTimestamp,
-      hookId,
+      instanceId,
       request: {
         ...initialRequestOptions,
         ...requestOptions,
@@ -1389,7 +1389,7 @@ function createInfiniteReadController(options) {
     eventEmitter,
     pluginExecutor,
     fetchFn,
-    hookId
+    instanceId
   } = options;
   let pageKeys = [];
   let pageRequests = /* @__PURE__ */ new Map();
@@ -1489,7 +1489,7 @@ function createInfiniteReadController(options) {
       queryKey: pageKey,
       tags,
       requestTimestamp: Date.now(),
-      hookId,
+      instanceId,
       request: { headers: {} },
       temp: /* @__PURE__ */ new Map(),
       pluginOptions,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spoosh/core",
-  "version": "0.11.1",
+  "version": "0.12.0",
   "license": "MIT",
   "description": "Type-safe API toolkit with plugin middleware system",
   "keywords": [