@spoosh/react 0.4.0 → 0.5.0

package/dist/index.d.mts

@@ -1,17 +1,26 @@
 import * as _spoosh_core from '@spoosh/core';
-import { ReadClient, TagOptions, SpooshResponse, WriteClient, SpooshPlugin, PluginTypeConfig, SpooshOptions, MergePluginResults, StateManager, EventEmitter, PluginExecutor, PluginArray, MergePluginOptions, ResolverContext, ResolveResultTypes, MergePluginInstanceApi } from '@spoosh/core';
+import { ReadClient, TagMode, SpooshResponse, WriteClient, SpooshPlugin, PluginTypeConfig, SpooshOptions, MergePluginResults, StateManager, EventEmitter, PluginExecutor, PluginArray, MergePluginOptions, ResolverContext, ResolveResultTypes, MergePluginInstanceApi } from '@spoosh/core';
 
 type PluginHooksConfig<TPlugins extends readonly SpooshPlugin<PluginTypeConfig>[]> = {
     baseUrl: string;
     defaultOptions?: SpooshOptions;
     plugins: TPlugins;
 };
+type TagModeInArray = "all" | "self";
 /**
  * Base options for `useRead` hook.
  */
-type BaseReadOptions = TagOptions & {
+type BaseReadOptions = {
     /** Whether to fetch automatically on mount. Default: true */
     enabled?: boolean;
+    /**
+     * Unified tag option
+     * - String: mode only ('all' | 'self' | 'none')
+     * - Array: custom tags only OR [mode keyword mixed with custom tags]
+     *   - 'all' or 'self' can be used in arrays
+     *   - 'none' should only be used as string (use `tags: 'none'` not in array)
+     */
+    tags?: TagMode | (TagModeInArray | (string & {}))[];
 };
 
 /**
@@ -177,9 +186,17 @@ type InfinitePrevContext<TData, TRequest> = {
  * @template TItem - The item type after merging all responses
  * @template TRequest - The request options type (query, params, body)
  */
-type BaseInfiniteReadOptions<TData, TItem, TRequest = AnyInfiniteRequestOptions> = TagOptions & {
+type BaseInfiniteReadOptions<TData, TItem, TRequest = AnyInfiniteRequestOptions> = {
     /** Whether to fetch automatically on mount. Default: true */
     enabled?: boolean;
+    /**
+     * Unified tag option
+     * - String: mode only ('all' | 'self' | 'none')
+     * - Array: custom tags only OR [mode keyword mixed with custom tags]
+     *   - 'all' or 'self' can be used in arrays
+     *   - 'none' should only be used as string (use `tags: 'none'` not in array)
+     */
+    tags?: TagMode | (TagModeInArray | (string & {}))[];
     /** Callback to determine if there's a next page to fetch */
     canFetchNext: (ctx: InfiniteNextContext<TData, TRequest>) => boolean;
     /** Callback to build the request options for the next page */
@@ -351,7 +368,7 @@ type SpooshInstanceShape<TApi, TSchema, TDefaultError, TPlugins> = {
  * const { useRead, useWrite, useInfiniteRead } = createReactSpoosh(spooshInstance);
  *
  * function MyComponent() {
- *   const { data, loading } = useRead((api) => api.posts.$get());
+ *   const { data, loading } = useRead((api) => api("posts").GET());
  *   return <div>{loading ? 'Loading...' : data?.title}</div>;
  * }
  * ```

package/dist/index.d.ts

@@ -1,17 +1,26 @@
 import * as _spoosh_core from '@spoosh/core';
-import { ReadClient, TagOptions, SpooshResponse, WriteClient, SpooshPlugin, PluginTypeConfig, SpooshOptions, MergePluginResults, StateManager, EventEmitter, PluginExecutor, PluginArray, MergePluginOptions, ResolverContext, ResolveResultTypes, MergePluginInstanceApi } from '@spoosh/core';
+import { ReadClient, TagMode, SpooshResponse, WriteClient, SpooshPlugin, PluginTypeConfig, SpooshOptions, MergePluginResults, StateManager, EventEmitter, PluginExecutor, PluginArray, MergePluginOptions, ResolverContext, ResolveResultTypes, MergePluginInstanceApi } from '@spoosh/core';
 
 type PluginHooksConfig<TPlugins extends readonly SpooshPlugin<PluginTypeConfig>[]> = {
     baseUrl: string;
     defaultOptions?: SpooshOptions;
     plugins: TPlugins;
 };
+type TagModeInArray = "all" | "self";
 /**
  * Base options for `useRead` hook.
  */
-type BaseReadOptions = TagOptions & {
+type BaseReadOptions = {
     /** Whether to fetch automatically on mount. Default: true */
     enabled?: boolean;
+    /**
+     * Unified tag option
+     * - String: mode only ('all' | 'self' | 'none')
+     * - Array: custom tags only OR [mode keyword mixed with custom tags]
+     *   - 'all' or 'self' can be used in arrays
+     *   - 'none' should only be used as string (use `tags: 'none'` not in array)
+     */
+    tags?: TagMode | (TagModeInArray | (string & {}))[];
 };
 
 /**
@@ -177,9 +186,17 @@ type InfinitePrevContext<TData, TRequest> = {
  * @template TItem - The item type after merging all responses
  * @template TRequest - The request options type (query, params, body)
  */
-type BaseInfiniteReadOptions<TData, TItem, TRequest = AnyInfiniteRequestOptions> = TagOptions & {
+type BaseInfiniteReadOptions<TData, TItem, TRequest = AnyInfiniteRequestOptions> = {
     /** Whether to fetch automatically on mount. Default: true */
     enabled?: boolean;
+    /**
+     * Unified tag option
+     * - String: mode only ('all' | 'self' | 'none')
+     * - Array: custom tags only OR [mode keyword mixed with custom tags]
+     *   - 'all' or 'self' can be used in arrays
+     *   - 'none' should only be used as string (use `tags: 'none'` not in array)
+     */
+    tags?: TagMode | (TagModeInArray | (string & {}))[];
     /** Callback to determine if there's a next page to fetch */
     canFetchNext: (ctx: InfiniteNextContext<TData, TRequest>) => boolean;
     /** Callback to build the request options for the next page */
@@ -351,7 +368,7 @@ type SpooshInstanceShape<TApi, TSchema, TDefaultError, TPlugins> = {
  * const { useRead, useWrite, useInfiniteRead } = createReactSpoosh(spooshInstance);
  *
  * function MyComponent() {
- *   const { data, loading } = useRead((api) => api.posts.$get());
+ *   const { data, loading } = useRead((api) => api("posts").GET());
  *   return <div>{loading ? 'Loading...' : data?.title}</div>;
  * }
  * ```

package/dist/index.js

@@ -35,12 +35,7 @@ var import_core = require("@spoosh/core");
 function createUseRead(options) {
   const { api, stateManager, eventEmitter, pluginExecutor } = options;
   return function useRead(readFn, readOptions) {
-    const {
-      enabled = true,
-      tags,
-      additionalTags,
-      ...pluginOpts
-    } = readOptions ?? {};
+    const { enabled = true, tags, ...pluginOpts } = readOptions ?? {};
     const hookId = (0, import_react.useId)();
     const selectorResultRef = (0, import_react.useRef)({
       call: null,
@@ -59,7 +54,7 @@ function createUseRead(options) {
     const requestOptions = capturedCall.options;
     const pathSegments = capturedCall.path.split("/").filter(Boolean);
     const resolvedPath = (0, import_core.resolvePath)(pathSegments, requestOptions?.params);
-    const resolvedTags = (0, import_core.resolveTags)({ tags, additionalTags }, resolvedPath);
+    const resolvedTags = (0, import_core.resolveTags)({ tags }, resolvedPath);
     const queryKey = stateManager.createQueryKey({
       path: pathSegments,
       method: capturedCall.method,
@@ -331,7 +326,6 @@ function createUseInfiniteRead(options) {
     const {
       enabled = true,
       tags,
-      additionalTags,
       canFetchNext,
       nextPageRequest,
       merger,
@@ -368,7 +362,7 @@ function createUseInfiniteRead(options) {
       body: void 0
     };
     const resolvedPath = (0, import_core3.resolvePath)(pathSegments, requestOptions?.params);
-    const resolvedTags = (0, import_core3.resolveTags)({ tags, additionalTags }, resolvedPath);
+    const resolvedTags = (0, import_core3.resolveTags)({ tags }, resolvedPath);
     const canFetchNextRef = (0, import_react3.useRef)(canFetchNext);
     const canFetchPrevRef = (0, import_react3.useRef)(canFetchPrev);
     const nextPageRequestRef = (0, import_react3.useRef)(nextPageRequest);

package/dist/index.mjs

@@ -19,12 +19,7 @@ import {
 function createUseRead(options) {
   const { api, stateManager, eventEmitter, pluginExecutor } = options;
   return function useRead(readFn, readOptions) {
-    const {
-      enabled = true,
-      tags,
-      additionalTags,
-      ...pluginOpts
-    } = readOptions ?? {};
+    const { enabled = true, tags, ...pluginOpts } = readOptions ?? {};
     const hookId = useId();
     const selectorResultRef = useRef({
       call: null,
@@ -43,7 +38,7 @@ function createUseRead(options) {
     const requestOptions = capturedCall.options;
     const pathSegments = capturedCall.path.split("/").filter(Boolean);
     const resolvedPath = resolvePath(pathSegments, requestOptions?.params);
-    const resolvedTags = resolveTags({ tags, additionalTags }, resolvedPath);
+    const resolvedTags = resolveTags({ tags }, resolvedPath);
     const queryKey = stateManager.createQueryKey({
       path: pathSegments,
       method: capturedCall.method,
@@ -337,7 +332,6 @@ function createUseInfiniteRead(options) {
     const {
       enabled = true,
       tags,
-      additionalTags,
       canFetchNext,
       nextPageRequest,
       merger,
@@ -374,7 +368,7 @@ function createUseInfiniteRead(options) {
       body: void 0
     };
     const resolvedPath = resolvePath3(pathSegments, requestOptions?.params);
-    const resolvedTags = resolveTags3({ tags, additionalTags }, resolvedPath);
+    const resolvedTags = resolveTags3({ tags }, resolvedPath);
     const canFetchNextRef = useRef3(canFetchNext);
     const canFetchPrevRef = useRef3(canFetchPrev);
     const nextPageRequestRef = useRef3(nextPageRequest);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spoosh/react",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "license": "MIT",
   "description": "React hooks for Spoosh API client",
   "keywords": [
@@ -34,11 +34,11 @@
     }
   },
   "peerDependencies": {
-    "@spoosh/core": ">=0.6.0",
+    "@spoosh/core": ">=0.7.0",
     "react": "^18 || ^19"
   },
   "devDependencies": {
-    "@spoosh/core": "0.6.0"
+    "@spoosh/core": "0.7.0"
   },
   "scripts": {
     "dev": "tsup --watch",