@mittwald/api-models 4.62.0 → 4.64.0

package/dist/esm/article/Article/Article.js

@@ -0,0 +1,79 @@
+import { ReferenceModel } from "../../base/ReferenceModel.js";
+import { config } from "../../config/config.js";
+import { classes } from "polytype";
+import { DataModel } from "../../base/DataModel.js";
+import assertObjectFound from "../../base/assertObjectFound.js";
+import { provideReact } from "../../react/provideReact.js";
+import { ListQueryModel } from "../../base/ListQueryModel.js";
+import { ListDataModel } from "../../base/ListDataModel.js";
+import { Money } from "../../base/Money.js";
+export class Article extends ReferenceModel {
+    static ofId(id) {
+        return new Article(id);
+    }
+    static find = provideReact(async (id) => {
+        const data = await config.behaviors.article.find(id);
+        if (data !== undefined) {
+            return new ArticleDetailed(data);
+        }
+    });
+    static get = provideReact(async (id) => {
+        const article = await this.find(id);
+        assertObjectFound(article, this, id);
+        return article;
+    });
+    static query(query = {}) {
+        return new ArticleListQuery(query);
+    }
+}
+class ArticleCommon extends classes((DataModel), Article) {
+    price;
+    constructor(data) {
+        super([data]);
+        this.price = Money({ amount: data.price, currency: "EUR" });
+    }
+}
+export class ArticleDetailed extends classes(ArticleCommon, (DataModel)) {
+    constructor(data) {
+        super([data], [data]);
+    }
+}
+export class ArticleListItem extends classes(ArticleCommon, (DataModel)) {
+    constructor(data) {
+        super([data]);
+    }
+}
+export class ArticleListQuery extends ListQueryModel {
+    constructor(query = {}) {
+        super(query);
+    }
+    refine(query) {
+        return new ArticleListQuery({
+            ...this.query,
+            ...query,
+        });
+    }
+    execute = provideReact(async () => {
+        const { ...query } = this.query;
+        const { items, totalCount } = await config.behaviors.article.list({
+            limit: config.defaultPaginationLimit,
+            ...query,
+        });
+        return new ArticleList(this.query, items.map((d) => new ArticleListItem(d)), totalCount);
+    }, [this.queryId]);
+    getTotalCount = provideReact(async () => {
+        const { totalCount } = await this.refine({ limit: 1 }).execute();
+        return totalCount;
+    }, [this.queryId]);
+    findOneAndOnly = provideReact(async () => {
+        const { items, totalCount } = await this.refine({ limit: 1 }).execute();
+        if (totalCount === 1) {
+            return items[0];
+        }
+    }, [this.queryId]);
+}
+export class ArticleList extends classes(ArticleListQuery, (ListDataModel)) {
+    constructor(query, articles, totalCount) {
+        super([query], [articles, totalCount]);
+    }
+}

package/dist/esm/article/Article/behaviors/api.js

@@ -0,0 +1,22 @@
+import { assertStatus, extractTotalCountHeader, } from "@mittwald/api-client";
+export const apiArticleBehaviors = (client) => ({
+    find: async (id) => {
+        const response = await client.article.getArticle({
+            articleId: id,
+        });
+        if (response.status === 200) {
+            return response.data;
+        }
+        assertStatus(response, 404);
+    },
+    list: async (query) => {
+        const response = await client.article.listArticles({
+            queryParameters: query,
+        });
+        assertStatus(response, 200);
+        return {
+            items: response.data,
+            totalCount: extractTotalCountHeader(response),
+        };
+    },
+});

package/dist/esm/article/Article/behaviors/index.js

@@ -0,0 +1,2 @@
+export * from "./api.js";
+export * from "./types.js";

package/dist/esm/article/Article/behaviors/types.js

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

package/dist/esm/article/Article/index.js

@@ -0,0 +1,2 @@
+export * from "./Article.js";
+export * from "./types.js";

package/dist/esm/article/Article/types.js

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

package/dist/esm/article/index.js

@@ -0,0 +1 @@
+export * from "./Article/index.js";

package/dist/esm/base/ListQueryModel.js

@@ -1,9 +1,11 @@
 import { hash } from "object-code";
+import { joinedId } from "../lib/joinedId.js";
 export class ListQueryModel {
     query;
     queryId;
-    constructor(query) {
+    constructor(query, opts = {}) {
+        const { dependencies = [] } = opts;
         this.query = query;
-        this.queryId = hash(query).toString();
+        this.queryId = joinedId(hash(query), ...dependencies);
     }
 }

package/dist/esm/base/Money.js

@@ -0,0 +1,5 @@
+import Dinero from "dinero.js";
+export const Money = Dinero;
+Money.defaultCurrency = "EUR";
+Money.defaultPrecision = 2;
+Money.globalLocale = "de-DE";

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

@@ -6,6 +6,7 @@ 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 { addUrlTagToProvideReactCache } from "../../react/asyncResourceInvalidation.js";
+import { apiArticleBehaviors } from "../../article/Article/behaviors/index.js";
 import { apiContractBehaviors } from "../../contract/Contract/behaviors/index.js";
 import { apiContractItemBehaviors } from "../../contract/ContractItem/behaviors/index.js";
 class ApiSetupState {
@@ -17,6 +18,7 @@ class ApiSetupState {
         this._client = client;
         this._client.defaultRequestOptions.onBeforeRequest =
             addUrlTagToProvideReactCache;
+        config.behaviors.article = apiArticleBehaviors(client);
         config.behaviors.project = apiProjectBehaviors(client);
         config.behaviors.server = apiServerBehaviors(client);
         config.behaviors.customer = apiCustomerBehaviors(client);

package/dist/esm/config/config.js

@@ -3,6 +3,7 @@ export const config = {
     behaviors: {
         contract: undefined,
         contractItem: undefined,
+        article: undefined,
         project: undefined,
         server: undefined,
         customer: undefined,

package/dist/esm/lib/joinedId.js

@@ -0,0 +1 @@
+export const joinedId = (...parts) => parts.join(" | ");

package/dist/esm/react/provideReact.js

@@ -1,14 +1,11 @@
 import { reactUsePromise } from "./reactUsePromise.js";
 import { hash } from "object-code";
 import { reactProvisionContext } from "./reactProvisionContext.js";
-export const provideReact = (loader, dependencies) => {
-    const provisionId = String(hash({
-        loader,
-        dependencies,
-    }));
+import { joinedId } from "../lib/joinedId.js";
+export const provideReact = (loader, dependencies = []) => {
+    const provisionId = joinedId(hash(loader), ...dependencies);
     const getAsyncResource = (params) => {
-        const paramsHash = params && params.length > 0 ? String(hash(params)) : "";
-        const contextId = provisionId + paramsHash;
+        const contextId = joinedId(provisionId, hash(params));
         const loaderWithContext = reactProvisionContext.bind({
             id: contextId,
         }, loader);

package/dist/types/app/AppInstallation/behaviors/types.d.ts

@@ -1,4 +1,4 @@
-import { AppInstallationListItemData, AppInstallationData, AppInstallationListQueryData } from "../types.js";
+import { AppInstallationData, AppInstallationListItemData, AppInstallationListQueryData } from "../types.js";
 import { QueryResponseData } from "../../../base/index.js";
 export interface AppInstallationBehaviors {
     find: (id: string) => Promise<AppInstallationData | undefined>;

package/dist/types/article/Article/Article.d.ts

@@ -0,0 +1,133 @@
+import { ReferenceModel } from "../../base/ReferenceModel.js";
+import { ArticleData, ArticleListItemData, ArticleListQueryData, ArticleListQueryModelData } from "./types.js";
+import { DataModel } from "../../base/DataModel.js";
+import { ListQueryModel } from "../../base/ListQueryModel.js";
+import { ListDataModel } from "../../base/ListDataModel.js";
+import { Money } from "../../base/Money.js";
+export declare class Article extends ReferenceModel {
+    static ofId(id: string): Article;
+    static find: import("../../react/provideReact.js").AsyncResourceVariant<(id: string) => Promise<ArticleDetailed | undefined>>;
+    static get: import("../../react/provideReact.js").AsyncResourceVariant<(id: string) => Promise<ArticleDetailed>>;
+    static query(query?: ArticleListQueryModelData): ArticleListQuery;
+}
+declare const ArticleCommon_base: import("polytype").Polytype.ClusteredConstructor<[{
+    new (data: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleReadableArticle | {
+        addons?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleAddons[] | undefined;
+        articleId: string;
+        attributes?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleAttributes[] | undefined;
+        balanceAddonKey?: string | undefined;
+        contractDurationInMonth: number;
+        description?: string | undefined;
+        forcedInvoicingPeriodInMonth?: number | undefined;
+        hasIndependentContractPeriod?: boolean | undefined;
+        hideOnInvoice?: boolean | undefined;
+        machineType?: {
+            cpu: string;
+            memory: string;
+            name: string;
+        } | undefined;
+        modifierArticles?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleReadableModifierArticleOptions[] | undefined;
+        name: string;
+        orderable: "forbidden" | "internal" | "beta_testing" | "full" | "deprecated";
+        possibleArticleChanges?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleReadableChangeArticleOptions[] | undefined;
+        price?: number | undefined;
+        tags?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleTag[] | undefined;
+        template: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleTemplate;
+    }): DataModel<import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleReadableArticle | {
+        addons?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleAddons[] | undefined;
+        articleId: string;
+        attributes?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleAttributes[] | undefined;
+        balanceAddonKey?: string | undefined;
+        contractDurationInMonth: number;
+        description?: string | undefined;
+        forcedInvoicingPeriodInMonth?: number | undefined;
+        hasIndependentContractPeriod?: boolean | undefined;
+        hideOnInvoice?: boolean | undefined;
+        machineType?: {
+            cpu: string;
+            memory: string;
+            name: string;
+        } | undefined;
+        modifierArticles?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleReadableModifierArticleOptions[] | undefined;
+        name: string;
+        orderable: "forbidden" | "internal" | "beta_testing" | "full" | "deprecated";
+        possibleArticleChanges?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleReadableChangeArticleOptions[] | undefined;
+        price?: number | undefined;
+        tags?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleTag[] | undefined;
+        template: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleTemplate;
+    }>;
+}, typeof Article]>;
+declare class ArticleCommon extends ArticleCommon_base {
+    readonly price: Money;
+    constructor(data: ArticleListItemData | ArticleData);
+}
+declare const ArticleDetailed_base: import("polytype").Polytype.ClusteredConstructor<[typeof ArticleCommon, {
+    new (data: {
+        addons?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleAddons[] | undefined;
+        articleId: string;
+        attributes?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleAttributes[] | undefined;
+        balanceAddonKey?: string | undefined;
+        contractDurationInMonth: number;
+        description?: string | undefined;
+        forcedInvoicingPeriodInMonth?: number | undefined;
+        hasIndependentContractPeriod?: boolean | undefined;
+        hideOnInvoice?: boolean | undefined;
+        machineType?: {
+            cpu: string;
+            memory: string;
+            name: string;
+        } | undefined;
+        modifierArticles?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleReadableModifierArticleOptions[] | undefined;
+        name: string;
+        orderable: "forbidden" | "internal" | "beta_testing" | "full" | "deprecated";
+        possibleArticleChanges?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleReadableChangeArticleOptions[] | undefined;
+        price?: number | undefined;
+        tags?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleTag[] | undefined;
+        template: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleTemplate;
+    }): DataModel<{
+        addons?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleAddons[] | undefined;
+        articleId: string;
+        attributes?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleAttributes[] | undefined;
+        balanceAddonKey?: string | undefined;
+        contractDurationInMonth: number;
+        description?: string | undefined;
+        forcedInvoicingPeriodInMonth?: number | undefined;
+        hasIndependentContractPeriod?: boolean | undefined;
+        hideOnInvoice?: boolean | undefined;
+        machineType?: {
+            cpu: string;
+            memory: string;
+            name: string;
+        } | undefined;
+        modifierArticles?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleReadableModifierArticleOptions[] | undefined;
+        name: string;
+        orderable: "forbidden" | "internal" | "beta_testing" | "full" | "deprecated";
+        possibleArticleChanges?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleReadableChangeArticleOptions[] | undefined;
+        price?: number | undefined;
+        tags?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleTag[] | undefined;
+        template: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleArticleTemplate;
+    }>;
+}]>;
+export declare class ArticleDetailed extends ArticleDetailed_base {
+    constructor(data: ArticleData);
+}
+declare const ArticleListItem_base: import("polytype").Polytype.ClusteredConstructor<[typeof ArticleCommon, {
+    new (data: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleReadableArticle): DataModel<import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ArticleReadableArticle>;
+}]>;
+export declare class ArticleListItem extends ArticleListItem_base {
+    constructor(data: ArticleListItemData);
+}
+export declare class ArticleListQuery extends ListQueryModel<ArticleListQueryModelData> {
+    constructor(query?: ArticleListQueryModelData);
+    refine(query: ArticleListQueryModelData): ArticleListQuery;
+    execute: import("../../react/provideReact.js").AsyncResourceVariant<() => Promise<ArticleList>>;
+    getTotalCount: import("../../react/provideReact.js").AsyncResourceVariant<() => Promise<number>>;
+    findOneAndOnly: import("../../react/provideReact.js").AsyncResourceVariant<() => Promise<ArticleListItem | undefined>>;
+}
+declare const ArticleList_base: import("polytype").Polytype.ClusteredConstructor<[typeof ArticleListQuery, {
+    new (items: ArticleListItem[], totalCount: number): ListDataModel<ArticleListItem>;
+}]>;
+export declare class ArticleList extends ArticleList_base {
+    constructor(query: ArticleListQueryData, articles: ArticleListItem[], totalCount: number);
+}
+export {};

package/dist/types/article/Article/behaviors/api.d.ts

@@ -0,0 +1,3 @@
+import { ArticleBehaviors } from "./types.js";
+import { MittwaldAPIV2Client } from "@mittwald/api-client";
+export declare const apiArticleBehaviors: (client: MittwaldAPIV2Client) => ArticleBehaviors;

package/dist/types/article/Article/behaviors/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./api.js";
+export * from "./types.js";

package/dist/types/article/Article/behaviors/types.d.ts

@@ -0,0 +1,6 @@
+import { ArticleData, ArticleListItemData, ArticleListQueryData } from "../types.js";
+import { QueryResponseData } from "../../../base/index.js";
+export interface ArticleBehaviors {
+    find: (id: string) => Promise<ArticleData | undefined>;
+    list: (query?: ArticleListQueryData) => Promise<QueryResponseData<ArticleListItemData>>;
+}

package/dist/types/article/Article/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Article.js";
+export * from "./types.js";

package/dist/types/article/Article/types.d.ts

@@ -0,0 +1,5 @@
+import { MittwaldAPIV2 } from "@mittwald/api-client";
+export type ArticleListQueryData = MittwaldAPIV2.Paths.V2Articles.Get.Parameters.Query;
+export type ArticleData = MittwaldAPIV2.Operations.ArticleGetArticle.ResponseData;
+export type ArticleListItemData = MittwaldAPIV2.Operations.ArticleListArticles.ResponseData[number];
+export type ArticleListQueryModelData = ArticleListQueryData;

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

@@ -0,0 +1 @@
+export * from "./Article/index.js";

package/dist/types/base/ListQueryModel.d.ts

@@ -1,5 +1,9 @@
+interface Options {
+    dependencies?: string[];
+}
 export declare abstract class ListQueryModel<TQuery> {
     protected readonly query: TQuery;
     readonly queryId: string;
-    constructor(query: TQuery);
+    constructor(query: TQuery, opts?: Options);
 }
+export {};

package/dist/types/base/Money.d.ts

@@ -0,0 +1,3 @@
+import Dinero from "dinero.js";
+export declare const Money: typeof Dinero;
+export type Money = ReturnType<typeof Money>;

package/dist/types/config/config.d.ts

@@ -5,11 +5,13 @@ import { IngressBehaviors } from "../domain/Ingress/behaviors/index.js";
 import { ContractBehaviors } from "../contract/Contract/behaviors/index.js";
 import { AppInstallationBehaviors } from "../app/AppInstallation/behaviors/index.js";
 import { ContractItemBehaviors } from "../contract/ContractItem/behaviors/index.js";
+import { ArticleBehaviors } from "../article/Article/behaviors/index.js";
 interface Config {
     defaultPaginationLimit: number;
     behaviors: {
         contract: ContractBehaviors;
         contractItem: ContractItemBehaviors;
+        article: ArticleBehaviors;
         project: ProjectBehaviors;
         server: ServerBehaviors;
         customer: CustomerBehaviors;

package/dist/types/lib/joinedId.d.ts

@@ -0,0 +1 @@
+export declare const joinedId: (...parts: Array<number | string>) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-models",
-  "version": "4.62.0",
+  "version": "4.64.0",
   "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
   "type": "module",
   "description": "Collection of domain models for coherent interaction with the API",
@@ -42,6 +42,7 @@
     "@mittwald/api-client": "^4.61.1",
     "another-deep-freeze": "^1.0.0",
     "context": "^3.0.31",
+    "dinero.js": "^1.9.1",
     "object-code": "^1.3.3",
     "polytype": "^0.17.0",
     "tsd": "^0.31.2",
@@ -53,6 +54,7 @@
     "@testing-library/dom": "^10.4.0",
     "@testing-library/jest-dom": "^6.5.0",
     "@testing-library/react": "^16.0.1",
+    "@types/dinero.js": "^1",
     "@types/jest": "^29.5.12",
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18",
@@ -82,5 +84,5 @@
       "optional": true
     }
   },
-  "gitHead": "e22fd31676cdf21390bda78ffde3f7acc364911c"
+  "gitHead": "d8f0554d50dff2de81524e1c3749fa3499b4f888"
 }