@spoosh/angular 0.4.0 → 0.6.0

package/README.md

@@ -29,7 +29,7 @@ export const { injectRead, injectWrite, injectInfiniteRead } =
 
 ### injectRead
 
-Fetch data with automatic caching and refetching using Angular signals.
+Fetch data with automatic caching and triggering using Angular signals.
 
 ```typescript
 @Component({
@@ -187,7 +187,7 @@ export class PostListComponent {
 | `loading`  | `Signal<boolean>`             | True during initial load                  |
 | `fetching` | `Signal<boolean>`             | True during any fetch                     |
 | `meta`     | `Signal<PluginResults>`       | Plugin metadata (e.g., `transformedData`) |
-| `refetch`  | `() => Promise`               | Manually trigger refetch                  |
+| `trigger`  | `() => Promise`               | Manually trigger fetch                    |
 | `abort`    | `() => void`                  | Abort current request                     |
 
 ### injectWrite(writeFn)
@@ -202,7 +202,6 @@ export class PostListComponent {
 | `loading` | `Signal<boolean>`             | True while mutation is in progress |
 | `meta`    | `Signal<PluginResults>`       | Plugin metadata                    |
 | `input`   | `TriggerOptions \| undefined` | Last trigger input                 |
-| `reset`   | `() => void`                  | Reset state                        |
 | `abort`   | `() => void`                  | Abort current request              |
 
 ### injectInfiniteRead(readFn, options)

package/dist/index.d.mts

@@ -17,14 +17,21 @@ type EnabledOption = boolean | (() => boolean);
 interface BaseReadOptions extends TagOptions {
     enabled?: EnabledOption;
 }
-interface BaseReadResult<TData, TError, TPluginResult = Record<string, unknown>> {
+interface BaseReadResult<TData, TError, TPluginResult = Record<string, unknown>, TTriggerOptions = {
+    force?: boolean;
+}> {
     data: Signal<TData | undefined>;
     error: Signal<TError | undefined>;
     loading: Signal<boolean>;
     fetching: Signal<boolean>;
     meta: Signal<TPluginResult>;
     abort: () => void;
-    refetch: () => Promise<SpooshResponse<TData, TError>>;
+    /**
+     * Manually trigger a fetch.
+     *
+     * @param options - Optional override options (query, body, params) to use for this specific request
+     */
+    trigger: (options?: TTriggerOptions) => Promise<SpooshResponse<TData, TError>>;
 }
 interface BaseWriteResult<TData, TError, TOptions, TPluginResult = Record<string, unknown>> {
     trigger: (options?: TOptions) => Promise<SpooshResponse<TData, TError>>;
@@ -32,7 +39,6 @@ interface BaseWriteResult<TData, TError, TOptions, TPluginResult = Record<string
     error: Signal<TError | undefined>;
     loading: Signal<boolean>;
     meta: Signal<TPluginResult>;
-    reset: () => void;
     abort: () => void;
 }
 type PageContext<TData, TRequest> = {
@@ -61,7 +67,7 @@ interface BaseInfiniteReadResult<TData, TError, TItem, TPluginResult = Record<st
     meta: Signal<TPluginResult>;
     fetchNext: () => Promise<void>;
     fetchPrev: () => Promise<void>;
-    refetch: () => Promise<void>;
+    trigger: () => Promise<void>;
     abort: () => void;
 }
 type QueryRequestOptions = CoreRequestOptionsBase;
@@ -141,6 +147,33 @@ type ExtractResponseParamNames<T> = SuccessReturnType<T> extends {
         params: Record<infer K, unknown>;
     };
 } ? K extends string ? K : never : never;
+type AwaitedReturnTypeTrigger<T> = T extends (...args: never[]) => infer R ? Awaited<R> : never;
+type ExtractInputFromResponse<T> = T extends {
+    input: infer I;
+} ? I : never;
+type ExtractTriggerQuery<I> = I extends {
+    query: infer Q;
+} ? {
+    query?: Q;
+} : unknown;
+type ExtractTriggerBody<I> = I extends {
+    body: infer B;
+} ? {
+    body?: B;
+} : unknown;
+type ExtractTriggerParams<I> = I extends {
+    params: infer P;
+} ? {
+    params?: P;
+} : unknown;
+type TriggerOptions<T> = ExtractInputFromResponse<AwaitedReturnTypeTrigger<T>> extends infer I ? [I] extends [never] ? {
+    force?: boolean;
+} : ExtractTriggerQuery<I> & ExtractTriggerBody<I> & ExtractTriggerParams<I> & {
+    /** Force refetch even if data is cached */
+    force?: boolean;
+} : {
+    force?: boolean;
+};
 type ExtractMethodQuery<T> = ExtractMethodOptions<T> extends {
     query: infer Q;
 } ? Q : never;
@@ -313,7 +346,7 @@ declare function createInjectRead<TSchema, TDefaultError, TPlugins extends reado
     readResult: infer R_2;
 } ? R_2 : object : object : never : never) extends infer T_1 ? T_1 extends (TPlugins[number] extends infer T_2 ? T_2 extends TPlugins[number] ? T_2 extends SpooshPlugin<infer Types extends PluginTypeConfig> ? Types extends {
     readResult: infer R_2;
-} ? R_2 : object : object : never : never) ? T_1 extends unknown ? (x: T_1) => void : never : never : never) extends (x: infer I) => void ? I : never, TReadOpts>> & ResponseInputFields<ExtractResponseQuery<TReadFn>, ExtractResponseBody<TReadFn>, ExtractResponseParamNames<TReadFn>>;
+} ? R_2 : object : object : never : never) ? T_1 extends unknown ? (x: T_1) => void : never : never : never) extends (x: infer I) => void ? I : never, TReadOpts>, TriggerOptions<TReadFn>> & ResponseInputFields<ExtractResponseQuery<TReadFn>, ExtractResponseBody<TReadFn>, ExtractResponseParamNames<TReadFn>>;
 
 type SpooshAngularFunctions<TDefaultError, TSchema, TPlugins extends PluginArray> = {
     injectRead: ReturnType<typeof createInjectRead<TSchema, TDefaultError, TPlugins>>;
@@ -323,4 +356,4 @@ type SpooshAngularFunctions<TDefaultError, TSchema, TPlugins extends PluginArray
 
 declare function createAngularSpoosh<TSchema, TDefaultError, TPlugins extends PluginArray, TApi>(instance: SpooshInstanceShape<TApi, TSchema, TDefaultError, TPlugins>): SpooshAngularFunctions<TDefaultError, TSchema, TPlugins>;
 
-export { type AngularOptionsMap, type BaseInfiniteReadOptions, type BaseInfiniteReadResult, type BaseReadOptions, type BaseReadResult, type BaseWriteResult, type EnabledOption, type ExtractMethodBody, type ExtractMethodData, type ExtractMethodError, type ExtractMethodOptions, type ExtractMethodQuery, type ExtractResponseBody, type ExtractResponseParamNames, type ExtractResponseQuery, type PageContext, type ReadApiClient, type ResponseInputFields, type SpooshInstanceShape, type WriteApiClient, type WriteResponseInputFields, createAngularSpoosh };
+export { type AngularOptionsMap, type BaseInfiniteReadOptions, type BaseInfiniteReadResult, type BaseReadOptions, type BaseReadResult, type BaseWriteResult, type EnabledOption, type ExtractMethodBody, type ExtractMethodData, type ExtractMethodError, type ExtractMethodOptions, type ExtractMethodQuery, type ExtractResponseBody, type ExtractResponseParamNames, type ExtractResponseQuery, type PageContext, type ReadApiClient, type ResponseInputFields, type SpooshInstanceShape, type TriggerOptions, type WriteApiClient, type WriteResponseInputFields, createAngularSpoosh };

package/dist/index.d.ts

@@ -17,14 +17,21 @@ type EnabledOption = boolean | (() => boolean);
 interface BaseReadOptions extends TagOptions {
     enabled?: EnabledOption;
 }
-interface BaseReadResult<TData, TError, TPluginResult = Record<string, unknown>> {
+interface BaseReadResult<TData, TError, TPluginResult = Record<string, unknown>, TTriggerOptions = {
+    force?: boolean;
+}> {
     data: Signal<TData | undefined>;
     error: Signal<TError | undefined>;
     loading: Signal<boolean>;
     fetching: Signal<boolean>;
     meta: Signal<TPluginResult>;
     abort: () => void;
-    refetch: () => Promise<SpooshResponse<TData, TError>>;
+    /**
+     * Manually trigger a fetch.
+     *
+     * @param options - Optional override options (query, body, params) to use for this specific request
+     */
+    trigger: (options?: TTriggerOptions) => Promise<SpooshResponse<TData, TError>>;
 }
 interface BaseWriteResult<TData, TError, TOptions, TPluginResult = Record<string, unknown>> {
     trigger: (options?: TOptions) => Promise<SpooshResponse<TData, TError>>;
@@ -32,7 +39,6 @@ interface BaseWriteResult<TData, TError, TOptions, TPluginResult = Record<string
     error: Signal<TError | undefined>;
     loading: Signal<boolean>;
     meta: Signal<TPluginResult>;
-    reset: () => void;
     abort: () => void;
 }
 type PageContext<TData, TRequest> = {
@@ -61,7 +67,7 @@ interface BaseInfiniteReadResult<TData, TError, TItem, TPluginResult = Record<st
     meta: Signal<TPluginResult>;
     fetchNext: () => Promise<void>;
     fetchPrev: () => Promise<void>;
-    refetch: () => Promise<void>;
+    trigger: () => Promise<void>;
     abort: () => void;
 }
 type QueryRequestOptions = CoreRequestOptionsBase;
@@ -141,6 +147,33 @@ type ExtractResponseParamNames<T> = SuccessReturnType<T> extends {
         params: Record<infer K, unknown>;
     };
 } ? K extends string ? K : never : never;
+type AwaitedReturnTypeTrigger<T> = T extends (...args: never[]) => infer R ? Awaited<R> : never;
+type ExtractInputFromResponse<T> = T extends {
+    input: infer I;
+} ? I : never;
+type ExtractTriggerQuery<I> = I extends {
+    query: infer Q;
+} ? {
+    query?: Q;
+} : unknown;
+type ExtractTriggerBody<I> = I extends {
+    body: infer B;
+} ? {
+    body?: B;
+} : unknown;
+type ExtractTriggerParams<I> = I extends {
+    params: infer P;
+} ? {
+    params?: P;
+} : unknown;
+type TriggerOptions<T> = ExtractInputFromResponse<AwaitedReturnTypeTrigger<T>> extends infer I ? [I] extends [never] ? {
+    force?: boolean;
+} : ExtractTriggerQuery<I> & ExtractTriggerBody<I> & ExtractTriggerParams<I> & {
+    /** Force refetch even if data is cached */
+    force?: boolean;
+} : {
+    force?: boolean;
+};
 type ExtractMethodQuery<T> = ExtractMethodOptions<T> extends {
     query: infer Q;
 } ? Q : never;
@@ -313,7 +346,7 @@ declare function createInjectRead<TSchema, TDefaultError, TPlugins extends reado
     readResult: infer R_2;
 } ? R_2 : object : object : never : never) extends infer T_1 ? T_1 extends (TPlugins[number] extends infer T_2 ? T_2 extends TPlugins[number] ? T_2 extends SpooshPlugin<infer Types extends PluginTypeConfig> ? Types extends {
     readResult: infer R_2;
-} ? R_2 : object : object : never : never) ? T_1 extends unknown ? (x: T_1) => void : never : never : never) extends (x: infer I) => void ? I : never, TReadOpts>> & ResponseInputFields<ExtractResponseQuery<TReadFn>, ExtractResponseBody<TReadFn>, ExtractResponseParamNames<TReadFn>>;
+} ? R_2 : object : object : never : never) ? T_1 extends unknown ? (x: T_1) => void : never : never : never) extends (x: infer I) => void ? I : never, TReadOpts>, TriggerOptions<TReadFn>> & ResponseInputFields<ExtractResponseQuery<TReadFn>, ExtractResponseBody<TReadFn>, ExtractResponseParamNames<TReadFn>>;
 
 type SpooshAngularFunctions<TDefaultError, TSchema, TPlugins extends PluginArray> = {
     injectRead: ReturnType<typeof createInjectRead<TSchema, TDefaultError, TPlugins>>;
@@ -323,4 +356,4 @@ type SpooshAngularFunctions<TDefaultError, TSchema, TPlugins extends PluginArray
 
 declare function createAngularSpoosh<TSchema, TDefaultError, TPlugins extends PluginArray, TApi>(instance: SpooshInstanceShape<TApi, TSchema, TDefaultError, TPlugins>): SpooshAngularFunctions<TDefaultError, TSchema, TPlugins>;
 
-export { type AngularOptionsMap, type BaseInfiniteReadOptions, type BaseInfiniteReadResult, type BaseReadOptions, type BaseReadResult, type BaseWriteResult, type EnabledOption, type ExtractMethodBody, type ExtractMethodData, type ExtractMethodError, type ExtractMethodOptions, type ExtractMethodQuery, type ExtractResponseBody, type ExtractResponseParamNames, type ExtractResponseQuery, type PageContext, type ReadApiClient, type ResponseInputFields, type SpooshInstanceShape, type WriteApiClient, type WriteResponseInputFields, createAngularSpoosh };
+export { type AngularOptionsMap, type BaseInfiniteReadOptions, type BaseInfiniteReadResult, type BaseReadOptions, type BaseReadResult, type BaseWriteResult, type EnabledOption, type ExtractMethodBody, type ExtractMethodData, type ExtractMethodError, type ExtractMethodOptions, type ExtractMethodQuery, type ExtractResponseBody, type ExtractResponseParamNames, type ExtractResponseQuery, type PageContext, type ReadApiClient, type ResponseInputFields, type SpooshInstanceShape, type TriggerOptions, type WriteApiClient, type WriteResponseInputFields, createAngularSpoosh };

package/dist/index.js

@@ -45,6 +45,7 @@ function createInjectRead(options) {
     const metaSignal = (0, import_core.signal)({});
     let currentController = null;
     let currentQueryKey = null;
+    let baseQueryKey = null;
     let currentSubscription = null;
     let currentResolvedTags = [];
     let prevContext = null;
@@ -99,12 +100,16 @@ function createInjectRead(options) {
       currentResolvedTags = resolvedTags;
       return controller;
     };
-    const executeWithTracking = async (controller, force = false) => {
+    const executeWithTracking = async (controller, force = false, overrideOptions) => {
       const hasData = dataSignal() !== void 0;
       loadingSignal.set(!hasData);
       fetchingSignal.set(true);
       try {
-        const response = await controller.execute(void 0, { force });
+        const execOptions = overrideOptions ? {
+          ...currentController?.getContext().requestOptions,
+          ...overrideOptions
+        } : void 0;
+        const response = await controller.execute(execOptions, { force });
         if (response.error) {
           errorSignal.set(response.error);
         } else {
@@ -145,6 +150,7 @@ function createInjectRead(options) {
       options: initialCapturedCall.options
     });
     createController(initialCapturedCall, initialResolvedTags, initialQueryKey);
+    baseQueryKey = initialQueryKey;
     loadingSignal.set(false);
     let wasEnabled = false;
     (0, import_core.effect)(
@@ -181,10 +187,11 @@ function createInjectRead(options) {
           inputInner.params = opts.params;
         }
         inputSignal.set(inputInner);
-        const queryKeyChanged = queryKey !== currentQueryKey;
+        const baseQueryKeyChanged = queryKey !== baseQueryKey;
         const enabledChanged = isEnabled !== wasEnabled;
         wasEnabled = isEnabled;
-        if (queryKeyChanged) {
+        if (baseQueryKeyChanged) {
+          baseQueryKey = queryKey;
           if (currentController) {
             prevContext = currentController.getContext();
             if (isMounted) {
@@ -267,15 +274,47 @@ function createInjectRead(options) {
     const abort = () => {
       currentController?.abort();
     };
-    const refetch = () => {
-      if (currentController) {
-        if (!isMounted) {
-          currentController.mount();
-          isMounted = true;
+    const trigger = async (triggerOptions) => {
+      const { force = false, ...overrideOptions } = triggerOptions ?? {};
+      const hasOverrides = Object.keys(overrideOptions).length > 0;
+      if (!hasOverrides) {
+        if (!currentController) {
+          return Promise.resolve({ data: void 0, error: void 0 });
         }
-        return executeWithTracking(currentController, true);
+        return executeWithTracking(currentController, force, void 0);
       }
-      return Promise.resolve({ data: void 0, error: void 0 });
+      const selectorResult = captureSelector();
+      const capturedCall = selectorResult.call;
+      if (!capturedCall) {
+        return Promise.resolve({ data: void 0, error: void 0 });
+      }
+      const mergedOptions = {
+        ...capturedCall.options ?? {},
+        ...overrideOptions
+      };
+      const pathSegments = capturedCall.path.split("/").filter(Boolean);
+      const newQueryKey = stateManager.createQueryKey({
+        path: pathSegments,
+        method: capturedCall.method,
+        options: mergedOptions
+      });
+      if (newQueryKey === currentQueryKey && currentController) {
+        return executeWithTracking(currentController, force, overrideOptions);
+      }
+      const params = mergedOptions?.params;
+      const newResolvedPath = (0, import_core2.resolvePath)(pathSegments, params);
+      const newResolvedTags = (0, import_core2.resolveTags)(
+        tags !== void 0 ? { tags } : void 0,
+        newResolvedPath
+      );
+      const newController = createController(
+        { ...capturedCall, options: mergedOptions },
+        newResolvedTags,
+        newQueryKey
+      );
+      newController.mount();
+      isMounted = true;
+      return executeWithTracking(newController, force, void 0);
     };
     const result = {
       meta: metaSignal,
@@ -287,7 +326,7 @@ function createInjectRead(options) {
       loading: loadingSignal,
       fetching: fetchingSignal,
       abort,
-      refetch
+      trigger
     };
     return result;
   };
@@ -333,14 +372,6 @@ function createInjectWrite(options) {
         currentSubscription();
       }
     });
-    const reset = () => {
-      if (currentQueryKey) {
-        stateManager.deleteCache(currentQueryKey);
-      }
-      dataSignal.set(void 0);
-      errorSignal.set(void 0);
-      loadingSignal.set(false);
-    };
     const abort = () => {
       currentController?.abort();
     };
@@ -431,7 +462,6 @@ function createInjectWrite(options) {
       data: dataSignal,
       error: errorSignal,
       loading: loadingSignal,
-      reset,
       abort
     };
     return result;
@@ -730,7 +760,7 @@ function createInjectInfiniteRead(options) {
         fetchingPrevSignal.set(false);
       }
     };
-    const refetch = async () => {
+    const trigger = async () => {
       if (!currentController) return;
       if (!isMounted) {
         currentController.mount();
@@ -763,7 +793,7 @@ function createInjectInfiniteRead(options) {
       canFetchPrev: canFetchPrevSignal,
       fetchNext,
       fetchPrev,
-      refetch,
+      trigger,
       abort
     };
     return result;

package/dist/index.mjs

@@ -30,6 +30,7 @@ function createInjectRead(options) {
     const metaSignal = signal({});
     let currentController = null;
     let currentQueryKey = null;
+    let baseQueryKey = null;
     let currentSubscription = null;
     let currentResolvedTags = [];
     let prevContext = null;
@@ -84,12 +85,16 @@ function createInjectRead(options) {
       currentResolvedTags = resolvedTags;
       return controller;
     };
-    const executeWithTracking = async (controller, force = false) => {
+    const executeWithTracking = async (controller, force = false, overrideOptions) => {
       const hasData = dataSignal() !== void 0;
       loadingSignal.set(!hasData);
       fetchingSignal.set(true);
       try {
-        const response = await controller.execute(void 0, { force });
+        const execOptions = overrideOptions ? {
+          ...currentController?.getContext().requestOptions,
+          ...overrideOptions
+        } : void 0;
+        const response = await controller.execute(execOptions, { force });
         if (response.error) {
           errorSignal.set(response.error);
         } else {
@@ -130,6 +135,7 @@ function createInjectRead(options) {
       options: initialCapturedCall.options
     });
     createController(initialCapturedCall, initialResolvedTags, initialQueryKey);
+    baseQueryKey = initialQueryKey;
     loadingSignal.set(false);
     let wasEnabled = false;
     effect(
@@ -166,10 +172,11 @@ function createInjectRead(options) {
           inputInner.params = opts.params;
         }
         inputSignal.set(inputInner);
-        const queryKeyChanged = queryKey !== currentQueryKey;
+        const baseQueryKeyChanged = queryKey !== baseQueryKey;
         const enabledChanged = isEnabled !== wasEnabled;
         wasEnabled = isEnabled;
-        if (queryKeyChanged) {
+        if (baseQueryKeyChanged) {
+          baseQueryKey = queryKey;
           if (currentController) {
             prevContext = currentController.getContext();
             if (isMounted) {
@@ -252,15 +259,47 @@ function createInjectRead(options) {
     const abort = () => {
       currentController?.abort();
     };
-    const refetch = () => {
-      if (currentController) {
-        if (!isMounted) {
-          currentController.mount();
-          isMounted = true;
+    const trigger = async (triggerOptions) => {
+      const { force = false, ...overrideOptions } = triggerOptions ?? {};
+      const hasOverrides = Object.keys(overrideOptions).length > 0;
+      if (!hasOverrides) {
+        if (!currentController) {
+          return Promise.resolve({ data: void 0, error: void 0 });
         }
-        return executeWithTracking(currentController, true);
+        return executeWithTracking(currentController, force, void 0);
       }
-      return Promise.resolve({ data: void 0, error: void 0 });
+      const selectorResult = captureSelector();
+      const capturedCall = selectorResult.call;
+      if (!capturedCall) {
+        return Promise.resolve({ data: void 0, error: void 0 });
+      }
+      const mergedOptions = {
+        ...capturedCall.options ?? {},
+        ...overrideOptions
+      };
+      const pathSegments = capturedCall.path.split("/").filter(Boolean);
+      const newQueryKey = stateManager.createQueryKey({
+        path: pathSegments,
+        method: capturedCall.method,
+        options: mergedOptions
+      });
+      if (newQueryKey === currentQueryKey && currentController) {
+        return executeWithTracking(currentController, force, overrideOptions);
+      }
+      const params = mergedOptions?.params;
+      const newResolvedPath = resolvePath(pathSegments, params);
+      const newResolvedTags = resolveTags(
+        tags !== void 0 ? { tags } : void 0,
+        newResolvedPath
+      );
+      const newController = createController(
+        { ...capturedCall, options: mergedOptions },
+        newResolvedTags,
+        newQueryKey
+      );
+      newController.mount();
+      isMounted = true;
+      return executeWithTracking(newController, force, void 0);
     };
     const result = {
       meta: metaSignal,
@@ -272,7 +311,7 @@ function createInjectRead(options) {
       loading: loadingSignal,
       fetching: fetchingSignal,
       abort,
-      refetch
+      trigger
     };
     return result;
   };
@@ -323,14 +362,6 @@ function createInjectWrite(options) {
         currentSubscription();
       }
     });
-    const reset = () => {
-      if (currentQueryKey) {
-        stateManager.deleteCache(currentQueryKey);
-      }
-      dataSignal.set(void 0);
-      errorSignal.set(void 0);
-      loadingSignal.set(false);
-    };
     const abort = () => {
       currentController?.abort();
     };
@@ -421,7 +452,6 @@ function createInjectWrite(options) {
       data: dataSignal,
       error: errorSignal,
       loading: loadingSignal,
-      reset,
       abort
     };
     return result;
@@ -732,7 +762,7 @@ function createInjectInfiniteRead(options) {
         fetchingPrevSignal.set(false);
       }
     };
-    const refetch = async () => {
+    const trigger = async () => {
       if (!currentController) return;
       if (!isMounted) {
         currentController.mount();
@@ -765,7 +795,7 @@ function createInjectInfiniteRead(options) {
       canFetchPrev: canFetchPrevSignal,
       fetchNext,
       fetchPrev,
-      refetch,
+      trigger,
       abort
     };
     return result;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spoosh/angular",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "license": "MIT",
   "description": "Angular signals integration for Spoosh API client",
   "keywords": [
@@ -38,7 +38,7 @@
     "@angular/core": ">=16.0.0"
   },
   "devDependencies": {
-    "@spoosh/core": "0.7.0"
+    "@spoosh/core": "0.9.0"
   },
   "scripts": {
     "dev": "tsup --watch",