@mittwald/api-models 4.59.0 → 4.60.0-beta.1

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

@@ -5,6 +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";
 class ApiSetupState {
     _client;
     setupWithClient(client) {
@@ -12,6 +13,8 @@ class ApiSetupState {
             throw new Error("API already setup. If you want to operate on the API client use api.client.");
         }
         this._client = client;
+        this._client.defaultRequestOptions.onBeforeRequest =
+            updateCacheTagsBeforeRequest;
         config.behaviors.project = apiProjectBehaviors(client);
         config.behaviors.server = apiServerBehaviors(client);
         config.behaviors.customer = apiCustomerBehaviors(client);

package/dist/esm/project/Project/Project.js

@@ -34,7 +34,7 @@ export class Project extends ReferenceModel {
         assertObjectFound(project, this, id);
         return project;
     });
-    query(query = {}) {
+    static query(query = {}) {
         return new ProjectListQuery(query);
     }
     /** @deprecated: use query(), Customer.projects or Server.projects */

package/dist/esm/react/MittwaldApiModelProvider.js

@@ -1,12 +1,12 @@
-import React, { createElement } from "react";
+import { usePromise } from "@mittwald/react-use-promise";
 import { setModule } from "./reactUsePromise.js";
-let loadingPromise = undefined;
 export const MittwaldApiModelProvider = (props) => {
-    if (loadingPromise === undefined) {
-        loadingPromise = import("@mittwald/react-use-promise").then((m) => {
-            setModule(m);
-        });
-        throw loadingPromise;
+    const { fallback, children } = props;
+    const module = usePromise(() => import("@mittwald/react-use-promise").then(setModule), [], {
+        useSuspense: false,
+    });
+    if (!module.hasValue) {
+        return fallback;
     }
-    return createElement(React.Fragment, undefined, props.children);
+    return children;
 };

package/dist/esm/react/asyncResourceInvalidation.js

@@ -0,0 +1,29 @@
+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) => {
+    cacheTagStore.getAll(tag).forEach((ids) => {
+        ids.forEach((id) => {
+            refresh({
+                tag: String(id),
+            });
+        });
+    });
+};
+export const addCacheTag = (tag) => {
+    const context = reactProvisionContext.use();
+    if (context) {
+        const ids = cacheTagStore.get(tag) ?? new Set();
+        ids.add(context.id);
+        cacheTagStore.set(tag, () => ids, {
+            tags: [tag],
+        });
+    }
+};
+export const updateCacheTagsBeforeRequest = (request) => {
+    const url = request.requestConfig.url;
+    if (request.requestConfig.method === "GET" && url) {
+        addCacheTag(url);
+    }
+};

package/dist/esm/react/index.js

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

package/dist/esm/react/provideReact.js

@@ -1,10 +1,22 @@
 import { reactUsePromise } from "./reactUsePromise.js";
+import { hash } from "object-code";
+import { reactProvisionContext } from "./reactProvisionContext.js";
 export const provideReact = (loader, dependencies) => {
-    const getAsyncResource = (params) => reactUsePromise.getAsyncResource(loader, params, {
-        // "stringify" dependencies to be used as loaderId
-        // see https://github.com/mittwald/react-use-promise?tab=readme-ov-file#loaderid
-        loaderId: dependencies ? dependencies.join("|") : undefined,
-    });
+    const provisionId = String(hash({
+        loader,
+        dependencies,
+    }));
+    const getAsyncResource = (params) => {
+        const paramsHash = params && params.length > 0 ? String(hash(params)) : "";
+        const contextId = provisionId + paramsHash;
+        const loaderWithContext = reactProvisionContext.bind({
+            id: contextId,
+        }, loader);
+        return reactUsePromise.getAsyncResource(loaderWithContext, params, {
+            loaderId: provisionId,
+            tags: [contextId],
+        });
+    };
     return Object.assign(loader, {
         asResource: (...params) => getAsyncResource(params),
         use: (...params) => getAsyncResource(params).use(),

package/dist/esm/react/reactProvisionContext.js

@@ -0,0 +1,2 @@
+import { createCascade } from "context";
+export const reactProvisionContext = createCascade();

package/dist/types/project/Project/Project.d.ts

@@ -15,7 +15,7 @@ export declare class Project extends ReferenceModel {
     static ofId(id: string): Project;
     static find: AsyncResourceVariant<(id: string) => Promise<ProjectDetailed | undefined>>;
     static get: AsyncResourceVariant<(id: string) => Promise<ProjectDetailed>>;
-    query(query?: ProjectListQueryModelData): ProjectListQuery;
+    static query(query?: ProjectListQueryModelData): ProjectListQuery;
     /** @deprecated: use query(), Customer.projects or Server.projects */
     static list: AsyncResourceVariant<(query?: ProjectListQueryData) => Promise<Readonly<Array<ProjectListItem>>>>;
     static create(serverId: string, description: string): Promise<Project>;

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

@@ -1,2 +1,6 @@
-import { FC, PropsWithChildren } from "react";
-export declare const MittwaldApiModelProvider: FC<PropsWithChildren>;
+import { FC, PropsWithChildren, ReactNode } from "react";
+interface Props extends PropsWithChildren {
+    fallback?: ReactNode;
+}
+export declare const MittwaldApiModelProvider: FC<Props>;
+export {};

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

@@ -0,0 +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"];

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

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

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

@@ -0,0 +1,3 @@
+export declare const reactProvisionContext: import("context").CtxCascadeApi<{
+    id: string;
+}>;

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

@@ -1 +1,2 @@
+export type ReactUsePromiseModule = typeof import("@mittwald/react-use-promise");
 export type { AsyncResource, getAsyncResource, } from "@mittwald/react-use-promise";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-models",
-  "version": "4.59.0",
+  "version": "4.60.0-beta.1",
   "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
   "type": "module",
   "description": "Collection of domain models for coherent interaction with the API",
@@ -39,17 +39,22 @@
     "test:unit": "node --experimental-vm-modules $(yarn bin jest)"
   },
   "dependencies": {
-    "@mittwald/api-client": "^4.59.0",
+    "@mittwald/api-client": "workspace:^",
     "another-deep-freeze": "^1.0.0",
+    "context": "^3.0.31",
     "object-code": "^1.3.3",
     "polytype": "^0.17.0",
     "type-fest": "^4.23.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
-    "@mittwald/react-use-promise": "^2.3.13",
+    "@mittwald/react-use-promise": "^2.5.0",
+    "@testing-library/dom": "^10.4.0",
+    "@testing-library/jest-dom": "^6.5.0",
+    "@testing-library/react": "^16.0.1",
     "@types/jest": "^29.5.12",
     "@types/react": "^18.3.3",
+    "@types/react-dom": "^18",
     "@typescript-eslint/eslint-plugin": "^7.18.0",
     "@typescript-eslint/parser": "^7.18.0",
     "eslint": "^8.57.0",
@@ -57,8 +62,10 @@
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-prettier": "^5.2.1",
     "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "prettier": "^3.3.3",
     "react": "^18.3.1",
+    "react-dom": "^18.3.1",
     "rimraf": "^5.0.10",
     "ts-jest": "^29.2.4",
     "typescript": "^5.5.4"
@@ -73,6 +80,5 @@
     "react": {
       "optional": true
     }
-  },
-  "gitHead": "9300cc09b76184f2d270d48f706e978e44759fa5"
+  }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Mittwald CM Service GmbH & Co. KG and contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.