@vc-shell/framework 2.5.0-pr333.50c07fa → 2.5.0-pr334.23413b7

package/dist/core/composables/useApiClient/index.d.ts

@@ -3,12 +3,28 @@ export interface IAuthApiBase {
     setAuthToken(token: string): void;
     getBaseUrl(defaultUrl: string, baseUrl: string): string;
 }
+/** The HTTP seam the generated clients accept as their second constructor argument. */
+export interface ApiClientHttp {
+    fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
+}
+export type ApiClientCtor<ApiClient extends IAuthApiBase> = new (baseUrl?: string, http?: ApiClientHttp) => ApiClient;
+export interface UseApiClientOptions {
+    /**
+     * Cancels every request the returned client makes.
+     *
+     * The generated clients take no `AbortSignal` of their own — they build their
+     * own `RequestInit` — so the signal travels through the `http` seam instead,
+     * which every operation of every client already routes through.
+     */
+    signal?: AbortSignal;
+}
 export interface UseApiClientReturn<ApiClient extends IAuthApiBase> {
     getApiClient: () => Promise<ApiClient>;
 }
 /** @deprecated Use UseApiClientReturn instead */
 export type UseApiClient<ApiClient extends IAuthApiBase> = UseApiClientReturn<ApiClient>;
-export declare function useApiClient<ApiClient extends IAuthApiBase>(c: new (baseUrl?: string, http?: {
-    fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
-}) => ApiClient): UseApiClientReturn<ApiClient>;
+/** Builds the client instance. Replaceable so an app or a test can supply its own. */
+export type ApiClientFactory = <ApiClient extends IAuthApiBase>(ctor: ApiClientCtor<ApiClient>, options: UseApiClientOptions) => ApiClient;
+export declare function setApiClientFactory(factory: ApiClientFactory | undefined): void;
+export declare function useApiClient<ApiClient extends IAuthApiBase>(c: ApiClientCtor<ApiClient>, options?: UseApiClientOptions): UseApiClientReturn<ApiClient>;
 //# sourceMappingURL=index.d.ts.map

package/dist/core/composables/useApiClient/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../core/composables/useApiClient/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;CACzD;AAED,MAAM,WAAW,kBAAkB,CAAC,SAAS,SAAS,YAAY;IAChE,YAAY,EAAE,MAAM,OAAO,CAAC,SAAS,CAAC,CAAC;CACxC;AAED,iDAAiD;AACjD,MAAM,MAAM,YAAY,CAAC,SAAS,SAAS,YAAY,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;AAEzF,wBAAgB,YAAY,CAAC,SAAS,SAAS,YAAY,EACzD,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;IAAE,KAAK,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;CAAE,KAAK,SAAS,GAChH,kBAAkB,CAAC,SAAS,CAAC,CAS/B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../core/composables/useApiClient/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;CACzD;AAED,uFAAuF;AACvF,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CAChE;AAED,MAAM,MAAM,aAAa,CAAC,SAAS,SAAS,YAAY,IAAI,KAAK,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,aAAa,KAAK,SAAS,CAAC;AAEtH,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB,CAAC,SAAS,SAAS,YAAY;IAChE,YAAY,EAAE,MAAM,OAAO,CAAC,SAAS,CAAC,CAAC;CACxC;AAED,iDAAiD;AACjD,MAAM,MAAM,YAAY,CAAC,SAAS,SAAS,YAAY,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;AAEzF,sFAAsF;AACtF,MAAM,MAAM,gBAAgB,GAAG,CAAC,SAAS,SAAS,YAAY,EAC5D,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,EAC9B,OAAO,EAAE,mBAAmB,KACzB,SAAS,CAAC;AASf,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,gBAAgB,GAAG,SAAS,GAAG,IAAI,CAE/E;AAsBD,wBAAgB,YAAY,CAAC,SAAS,SAAS,YAAY,EACzD,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC,EAC3B,OAAO,GAAE,mBAAwB,GAChC,kBAAkB,CAAC,SAAS,CAAC,CAQ/B"}

package/dist/core/composables/useLatestRequest/index.d.ts

@@ -34,10 +34,18 @@ export interface UseLatestRequestReturn {
  * }
  * ```
  *
- * This discards the late result rather than cancelling the request: the
- * generated API clients build their own `RequestInit` and take no `AbortSignal`,
- * so there is nothing to cancel through. Aborting would additionally save the
- * round trip and belongs with a client that accepts a signal.
+ * This discards the late result rather than cancelling the request. To also save
+ * the round trip, give the client a signal and abort it when a newer request
+ * supersedes the last:
+ *
+ * ```ts
+ * const controller = new AbortController();
+ * const { getApiClient } = useApiClient(SearchClient, { signal: controller.signal });
+ * ```
+ *
+ * The two compose rather than replace each other: aborting stops the request that
+ * is still in flight, and `isCurrent()` still guards a response that had already
+ * come back before the newer request started.
  */
 export declare function useLatestRequest(): UseLatestRequestReturn;
 //# sourceMappingURL=index.d.ts.map

package/dist/core/composables/useLatestRequest/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../core/composables/useLatestRequest/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkD,KAAK,GAAG,EAAE,MAAM,KAAK,CAAC;AAE/E,MAAM,WAAW,aAAa;IAC5B,2FAA2F;IAC3F,SAAS,IAAI,OAAO,CAAC;IACrB,0FAA0F;IAC1F,QAAQ,IAAI,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,uDAAuD;IACvD,KAAK,IAAI,aAAa,CAAC;IACvB,8FAA8F;IAC9F,UAAU,IAAI,IAAI,CAAC;IACnB,2FAA2F;IAC3F,OAAO,IAAI,IAAI,CAAC;IAChB,sDAAsD;IACtD,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;CACjC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,gBAAgB,IAAI,sBAAsB,CA2CzD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../core/composables/useLatestRequest/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkD,KAAK,GAAG,EAAE,MAAM,KAAK,CAAC;AAE/E,MAAM,WAAW,aAAa;IAC5B,2FAA2F;IAC3F,SAAS,IAAI,OAAO,CAAC;IACrB,0FAA0F;IAC1F,QAAQ,IAAI,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,uDAAuD;IACvD,KAAK,IAAI,aAAa,CAAC;IACvB,8FAA8F;IAC9F,UAAU,IAAI,IAAI,CAAC;IACnB,2FAA2F;IAC3F,OAAO,IAAI,IAAI,CAAC;IAChB,sDAAsD;IACtD,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;CACjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,gBAAgB,IAAI,sBAAsB,CA2CzD"}

package/dist/core/interceptors/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../core/interceptors/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AA2CpC,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,wFAwMlD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../core/interceptors/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AA4CpC,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,wFAsMlD"}