@mittwald/api-models 4.60.0 → 4.61.0

package/dist/esm/config/behaviors/api.js

@@ -5,7 +5,7 @@ import { apiServerBehaviors } from "../../server/Server/behaviors/index.js";
 import { apiCustomerBehaviors } from "../../customer/Customer/behaviors/index.js";
 import { apiIngressBehaviors } from "../../domain/Ingress/behaviors/index.js";
 import { apiAppInstallationBehaviors } from "../../app/AppInstallation/behaviors/index.js";
-import { updateCacheTagsBeforeRequest } from "../../react/asyncResourceInvalidation.js";
+import { addUrlTagToProvideReactCache } from "../../react/asyncResourceInvalidation.js";
 class ApiSetupState {
     _client;
     setupWithClient(client) {
@@ -14,7 +14,7 @@ class ApiSetupState {
         }
         this._client = client;
         this._client.defaultRequestOptions.onBeforeRequest =
-            updateCacheTagsBeforeRequest;
+            addUrlTagToProvideReactCache;
         config.behaviors.project = apiProjectBehaviors(client);
         config.behaviors.server = apiServerBehaviors(client);
         config.behaviors.customer = apiCustomerBehaviors(client);

package/dist/esm/react/asyncResourceInvalidation.js

@@ -2,7 +2,7 @@ import { reactProvisionContext } from "./reactProvisionContext.js";
 import { refresh } from "@mittwald/react-use-promise";
 import { Store } from "@mittwald/react-use-promise/store";
 const cacheTagStore = new Store();
-export const refreshModels = (tag) => {
+export const refreshProvideReactCache = (tag) => {
     cacheTagStore.getAll(tag).forEach((ids) => {
         ids.forEach((id) => {
             refresh({
@@ -11,7 +11,7 @@ export const refreshModels = (tag) => {
         });
     });
 };
-export const addCacheTag = (tag) => {
+export const addTagToProvideReactCache = (tag) => {
     const context = reactProvisionContext.use();
     if (context) {
         const ids = cacheTagStore.get(tag) ?? new Set();
@@ -21,9 +21,9 @@ export const addCacheTag = (tag) => {
         });
     }
 };
-export const updateCacheTagsBeforeRequest = (request) => {
+export const addUrlTagToProvideReactCache = (request) => {
     const url = request.requestConfig.url;
     if (request.requestConfig.method === "GET" && url) {
-        addCacheTag(url);
+        addTagToProvideReactCache(url);
     }
 };

package/dist/esm/react/index.js

@@ -1,4 +1,4 @@
-export { refreshModels, addCacheTag } from "./asyncResourceInvalidation.js";
+export { refreshProvideReactCache, addTagToProvideReactCache, addUrlTagToProvideReactCache, } from "./asyncResourceInvalidation.js";
 export * from "./MittwaldApiModelProvider.js";
 export * from "./reactUsePromise.js";
 export { provideReact } from "./provideReact.js";

package/dist/esm/react/provideReact.test-types.js

@@ -0,0 +1,21 @@
+import { provideReact } from "./provideReact.js";
+import { expectType } from "tsd";
+const reactProvided = provideReact(async (ignoredP1, ignoredP2) => Promise.resolve("foo"));
+function ignoredTestReturnTypesOfProvideReact() {
+    const usedValue = reactProvided.use("foo");
+    const asAsyncResource = reactProvided.asResource("foo");
+    expectType(usedValue);
+    expectType(asAsyncResource.use());
+}
+function ignoredTestParameterTypesOfProvideReact() {
+    reactProvided.use("foo", true);
+    reactProvided.asResource("foo", true);
+    reactProvided.use("foo");
+    reactProvided.asResource("foo");
+    // @ts-expect-error Not assignable
+    reactProvided.asResource(42);
+    // @ts-expect-error Not assignable
+    reactProvided.asResource("foo", 42);
+    // @ts-expect-error Not assignable
+    reactProvided.asResource("foo", true, 42);
+}

package/dist/types/react/asyncResourceInvalidation.d.ts

@@ -1,4 +1,4 @@
 import { Commons } from "@mittwald/api-client";
-export declare const refreshModels: (tag: string) => void;
-export declare const addCacheTag: (tag: string) => void;
-export declare const updateCacheTagsBeforeRequest: Commons.RequestOptions["onBeforeRequest"];
+export declare const refreshProvideReactCache: (tag: string) => void;
+export declare const addTagToProvideReactCache: (tag: string) => void;
+export declare const addUrlTagToProvideReactCache: Commons.RequestOptions["onBeforeRequest"];

package/dist/types/react/index.d.ts

@@ -1,4 +1,4 @@
-export { refreshModels, addCacheTag } from "./asyncResourceInvalidation.js";
+export { refreshProvideReactCache, addTagToProvideReactCache, addUrlTagToProvideReactCache, } from "./asyncResourceInvalidation.js";
 export * from "./MittwaldApiModelProvider.js";
 export * from "./reactUsePromise.js";
 export { type AsyncResourceVariant } from "./provideReact.js";

package/dist/types/react/provideReact.d.ts

@@ -3,7 +3,7 @@ import { AsyncReturnType } from "type-fest";
 type AsyncFn = (...args: any[]) => Promise<unknown>;
 export declare const provideReact: <T extends AsyncFn>(loader: T, dependencies?: string[]) => AsyncResourceVariant<T>;
 export type AsyncResourceVariant<T extends AsyncFn> = T & {
-    asResource: (...params: Parameters<T>) => AsyncResource<ReturnType<T>>;
+    asResource: (...params: Parameters<T>) => AsyncResource<AsyncReturnType<T>>;
     use: (...params: Parameters<T>) => AsyncReturnType<T>;
 };
 export {};

package/dist/types/react/provideReact.test-types.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-models",
-  "version": "4.60.0",
+  "version": "4.61.0",
   "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
   "type": "module",
   "description": "Collection of domain models for coherent interaction with the API",
@@ -44,6 +44,7 @@
     "context": "^3.0.31",
     "object-code": "^1.3.3",
     "polytype": "^0.17.0",
+    "tsd": "^0.31.2",
     "type-fest": "^4.23.0"
   },
   "devDependencies": {
@@ -81,5 +82,5 @@
       "optional": true
     }
   },
-  "gitHead": "8058044c2d8ab32e0507561baa1172cbfbce4fe0"
+  "gitHead": "87f9b29bfab46d969b2061411b3dc7c4b7dd9699"
 }