@mittwald/api-models 4.61.0 → 4.62.0

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

@@ -6,6 +6,8 @@ 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 { apiContractBehaviors } from "../../contract/Contract/behaviors/index.js";
+import { apiContractItemBehaviors } from "../../contract/ContractItem/behaviors/index.js";
 class ApiSetupState {
     _client;
     setupWithClient(client) {
@@ -20,6 +22,8 @@ class ApiSetupState {
         config.behaviors.customer = apiCustomerBehaviors(client);
         config.behaviors.ingress = apiIngressBehaviors(client);
         config.behaviors.appInstallation = apiAppInstallationBehaviors(client);
+        config.behaviors.contract = apiContractBehaviors(client);
+        config.behaviors.contractItem = apiContractItemBehaviors(client);
     }
     setupWithApiToken(apiToken) {
         return this.setupWithClient(MittwaldAPIV2Client.newWithToken(apiToken));

package/dist/esm/config/config.js

@@ -1,6 +1,8 @@
 export const config = {
     defaultPaginationLimit: 50,
     behaviors: {
+        contract: undefined,
+        contractItem: undefined,
         project: undefined,
         server: undefined,
         customer: undefined,

package/dist/esm/contract/Contract/Contract.js

@@ -0,0 +1,78 @@
+import { DataModel, ListDataModel, ListQueryModel, ReferenceModel, } from "../../base/index.js";
+import { provideReact } from "../../react/index.js";
+import { config } from "../../config/config.js";
+import { classes } from "polytype";
+import assertObjectFound from "../../base/assertObjectFound.js";
+export class Contract extends ReferenceModel {
+    static ofId(id) {
+        return new Contract(id);
+    }
+    static find = provideReact(async (id) => {
+        const data = await config.behaviors.contract.find(id);
+        if (data !== undefined) {
+            return new ContractDetailed(data);
+        }
+    });
+    static query(query) {
+        return new ContractListQuery(query);
+    }
+    static get = provideReact(async (id) => {
+        const customer = await this.find(id);
+        assertObjectFound(customer, this, id);
+        return customer;
+    });
+}
+class ContractCommon extends classes((DataModel), Contract) {
+    constructor(data) {
+        super([data], [data.customerId]);
+    }
+}
+export class ContractDetailed extends classes(ContractCommon, (DataModel)) {
+    constructor(data) {
+        super([data], [data]);
+    }
+}
+export class ContractListItem extends classes(ContractCommon, (DataModel)) {
+    constructor(data) {
+        super([data], [data]);
+    }
+}
+export class ContractListQuery extends ListQueryModel {
+    constructor(query) {
+        super(query);
+    }
+    refine(query) {
+        return new ContractListQuery({
+            ...this.query,
+            ...query,
+        });
+    }
+    execute = provideReact(async () => {
+        const { customer, ...query } = this.query;
+        const customerId = customer.id;
+        const request = {
+            customerId: customerId,
+            queryParameters: {
+                limit: config.defaultPaginationLimit,
+                ...query,
+            },
+        };
+        const { items, totalCount } = await config.behaviors.contract.list(request);
+        return new ContractList(this.query, items.map((d) => new ContractListItem(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 ContractList extends classes(ContractListQuery, (ListDataModel)) {
+    constructor(query, contracts, totalCount) {
+        super([query], [contracts, totalCount]);
+    }
+}

package/dist/esm/contract/Contract/behaviors/api.js

@@ -0,0 +1,20 @@
+import { assertStatus, extractTotalCountHeader, } from "@mittwald/api-client";
+export const apiContractBehaviors = (client) => ({
+    find: async (id) => {
+        const response = await client.contract.getDetailOfContract({
+            contractId: id,
+        });
+        if (response.status === 200) {
+            return response.data;
+        }
+        assertStatus(response, 404);
+    },
+    list: async (request) => {
+        const response = await client.contract.listContracts(request);
+        assertStatus(response, 200);
+        return {
+            items: response.data,
+            totalCount: extractTotalCountHeader(response),
+        };
+    },
+});

package/dist/esm/contract/Contract/behaviors/index.js

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

package/dist/esm/contract/Contract/behaviors/types.js

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

package/dist/esm/contract/Contract/index.js

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

package/dist/esm/contract/Contract/types.js

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

package/dist/esm/contract/ContractItem/ContractItem.js

@@ -0,0 +1,31 @@
+import { classes } from "polytype";
+import { DataModel, ReferenceModel } from "../../base/index.js";
+import { provideReact } from "../../react/index.js";
+import { config } from "../../config/config.js";
+import assertObjectFound from "../../base/assertObjectFound.js";
+export class ContractItem extends ReferenceModel {
+    static ofId(contractId, id) {
+        return new ContractItem(contractId, id);
+    }
+    static find = provideReact(async (contractId, contractItemId) => {
+        const data = await config.behaviors.contractItem.find(contractId, contractItemId);
+        if (data !== undefined) {
+            return new ContractItemDetailed(contractId, data);
+        }
+    });
+    static get = provideReact(async (contractId, contractItemId) => {
+        const item = await this.find(contractId, contractItemId);
+        assertObjectFound(item, this, contractItemId);
+        return item;
+    });
+    contractId;
+    constructor(contractId, id) {
+        super(id);
+        this.contractId = contractId;
+    }
+}
+export class ContractItemDetailed extends classes((DataModel), ContractItem) {
+    constructor(contractId, data) {
+        super([data], [contractId, data.itemId]);
+    }
+}

package/dist/esm/contract/ContractItem/behaviors/api.js

@@ -0,0 +1,13 @@
+import { assertStatus } from "@mittwald/api-client";
+export const apiContractItemBehaviors = (client) => ({
+    find: async (contractId, contractItemId) => {
+        const response = await client.contract.getDetailOfContractItem({
+            contractId,
+            contractItemId,
+        });
+        if (response.status === 200) {
+            return response.data;
+        }
+        assertStatus(response, 404);
+    },
+});

package/dist/esm/contract/ContractItem/behaviors/index.js

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

package/dist/esm/contract/ContractItem/behaviors/types.js

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

package/dist/esm/contract/ContractItem/index.js

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

package/dist/esm/contract/ContractItem/types.js

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

package/dist/esm/contract/index.js

@@ -0,0 +1,2 @@
+export * from "./Contract/index.js";
+export * from "./ContractItem/index.js";

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

@@ -2,10 +2,14 @@ import { ProjectBehaviors } from "../project/Project/behaviors/index.js";
 import { ServerBehaviors } from "../server/Server/behaviors/index.js";
 import { CustomerBehaviors } from "../customer/Customer/behaviors/index.js";
 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";
 interface Config {
     defaultPaginationLimit: number;
     behaviors: {
+        contract: ContractBehaviors;
+        contractItem: ContractItemBehaviors;
         project: ProjectBehaviors;
         server: ServerBehaviors;
         customer: CustomerBehaviors;

package/dist/types/contract/Contract/Contract.d.ts

@@ -0,0 +1,68 @@
+import { DataModel, ListDataModel, ListQueryModel, ReferenceModel } from "../../base/index.js";
+import { ContractData, ContractListItemData, ContractListQueryData, ContractListQueryModelData } from "./types.js";
+export declare class Contract extends ReferenceModel {
+    static ofId(id: string): Contract;
+    static find: import("../../react/provideReact.js").AsyncResourceVariant<(id: string) => Promise<ContractDetailed | undefined>>;
+    static query(query: ContractListQueryModelData): ContractListQuery;
+    static get: import("../../react/provideReact.js").AsyncResourceVariant<(id: string) => Promise<ContractDetailed>>;
+}
+declare const ContractCommon_base: import("polytype").Polytype.ClusteredConstructor<[{
+    new (data: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractContract | {
+        additionalItems?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractContractItem[] | undefined;
+        baseItem: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractContractItem;
+        contractId: string;
+        contractNumber: string;
+        customerId: string;
+        termination?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
+    }): DataModel<import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractContract | {
+        additionalItems?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractContractItem[] | undefined;
+        baseItem: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractContractItem;
+        contractId: string;
+        contractNumber: string;
+        customerId: string;
+        termination?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
+    }>;
+}, typeof Contract]>;
+declare class ContractCommon extends ContractCommon_base {
+    constructor(data: ContractListItemData | ContractData);
+}
+declare const ContractDetailed_base: import("polytype").Polytype.ClusteredConstructor<[typeof ContractCommon, {
+    new (data: {
+        additionalItems?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractContractItem[] | undefined;
+        baseItem: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractContractItem;
+        contractId: string;
+        contractNumber: string;
+        customerId: string;
+        termination?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
+    }): DataModel<{
+        additionalItems?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractContractItem[] | undefined;
+        baseItem: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractContractItem;
+        contractId: string;
+        contractNumber: string;
+        customerId: string;
+        termination?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
+    }>;
+}]>;
+export declare class ContractDetailed extends ContractDetailed_base {
+    constructor(data: ContractData);
+}
+declare const ContractListItem_base: import("polytype").Polytype.ClusteredConstructor<[typeof ContractCommon, {
+    new (data: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractContract): DataModel<import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractContract>;
+}]>;
+export declare class ContractListItem extends ContractListItem_base {
+    constructor(data: ContractListItemData);
+}
+export declare class ContractListQuery extends ListQueryModel<ContractListQueryModelData> {
+    constructor(query: ContractListQueryModelData);
+    refine(query: ContractListQueryData): ContractListQuery;
+    execute: import("../../react/provideReact.js").AsyncResourceVariant<() => Promise<ContractList>>;
+    getTotalCount: import("../../react/provideReact.js").AsyncResourceVariant<() => Promise<number>>;
+    findOneAndOnly: import("../../react/provideReact.js").AsyncResourceVariant<() => Promise<ContractListItem | undefined>>;
+}
+declare const ContractList_base: import("polytype").Polytype.ClusteredConstructor<[typeof ContractListQuery, {
+    new (items: ContractListItem[], totalCount: number): ListDataModel<ContractListItem>;
+}]>;
+export declare class ContractList extends ContractList_base {
+    constructor(query: ContractListQueryModelData, contracts: ContractListItem[], totalCount: number);
+}
+export {};

package/dist/types/contract/Contract/behaviors/api.d.ts

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

package/dist/types/contract/Contract/behaviors/index.d.ts

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

package/dist/types/contract/Contract/behaviors/types.d.ts

@@ -0,0 +1,9 @@
+import { ContractData, ContractListItemData, ContractListQueryData } from "../types.js";
+import { QueryResponseData } from "../../../base/index.js";
+export interface ContractBehaviors {
+    find: (id: string) => Promise<ContractData | undefined>;
+    list: (request: {
+        customerId: string;
+        queryParameters?: ContractListQueryData;
+    }) => Promise<QueryResponseData<ContractListItemData>>;
+}

package/dist/types/contract/Contract/index.d.ts

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

package/dist/types/contract/Contract/types.d.ts

@@ -0,0 +1,8 @@
+import { MittwaldAPIV2 } from "@mittwald/api-client";
+import { Customer } from "../../customer/index.js";
+export type ContractListQueryData = MittwaldAPIV2.Paths.V2ContractsContractId.Get.Parameters.Query;
+export type ContractListQueryModelData = Omit<ContractListQueryData, "customerId"> & {
+    customer: Customer;
+};
+export type ContractData = MittwaldAPIV2.Operations.ContractGetDetailOfContract.ResponseData;
+export type ContractListItemData = MittwaldAPIV2.Operations.ContractListContracts.ResponseData[number];

package/dist/types/contract/ContractItem/ContractItem.d.ts

@@ -0,0 +1,64 @@
+import { ContractItemData } from "./types.js";
+import { DataModel, ReferenceModel } from "../../base/index.js";
+export declare class ContractItem extends ReferenceModel {
+    static ofId(contractId: string, id: string): ContractItem;
+    static find: import("../../react/provideReact.js").AsyncResourceVariant<(contractId: string, contractItemId: string) => Promise<ContractItemDetailed | undefined>>;
+    static get: import("../../react/provideReact.js").AsyncResourceVariant<(contractId: string, contractItemId: string) => Promise<ContractItemDetailed>>;
+    readonly contractId: string;
+    constructor(contractId: string, id: string);
+}
+declare const ContractItemDetailed_base: import("polytype").Polytype.ClusteredConstructor<[{
+    new (data: {
+        activationDate?: string | undefined;
+        aggregateReference?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractAggregateReference | undefined;
+        articles: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractArticle[];
+        contractPeriod: number;
+        description: string;
+        freeTrialDays?: number | undefined;
+        groupByProjectId?: string | undefined;
+        invoiceStop?: string | undefined;
+        invoicingPeriod?: number | undefined;
+        isActivated: boolean;
+        isBaseItem: boolean;
+        isInFreeTrial?: boolean | undefined;
+        isInclusive?: boolean | undefined;
+        itemId: string;
+        nextPossibleDowngradeDate?: string | undefined;
+        nextPossibleTerminationDate?: string | undefined;
+        nextPossibleUpgradeDate?: string | undefined;
+        orderDate?: string | undefined;
+        orderId?: string | undefined;
+        replacedByItem?: string | undefined;
+        tariffChange?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractTariffChange | undefined;
+        termination?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
+        totalPrice: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractPrice;
+    }): DataModel<{
+        activationDate?: string | undefined;
+        aggregateReference?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractAggregateReference | undefined;
+        articles: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractArticle[];
+        contractPeriod: number;
+        description: string;
+        freeTrialDays?: number | undefined;
+        groupByProjectId?: string | undefined;
+        invoiceStop?: string | undefined;
+        invoicingPeriod?: number | undefined;
+        isActivated: boolean;
+        isBaseItem: boolean;
+        isInFreeTrial?: boolean | undefined;
+        isInclusive?: boolean | undefined;
+        itemId: string;
+        nextPossibleDowngradeDate?: string | undefined;
+        nextPossibleTerminationDate?: string | undefined;
+        nextPossibleUpgradeDate?: string | undefined;
+        orderDate?: string | undefined;
+        orderId?: string | undefined;
+        replacedByItem?: string | undefined;
+        tariffChange?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractTariffChange | undefined;
+        termination?: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
+        totalPrice: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.ContractPrice;
+    }>;
+}, typeof ContractItem]>;
+export declare class ContractItemDetailed extends ContractItemDetailed_base {
+    constructor(contractId: string, data: ContractItemData);
+}
+export {};

package/dist/types/contract/ContractItem/behaviors/api.d.ts

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

package/dist/types/contract/ContractItem/behaviors/index.d.ts

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

package/dist/types/contract/ContractItem/behaviors/types.d.ts

@@ -0,0 +1,4 @@
+import { ContractItemData } from "../types.js";
+export interface ContractItemBehaviors {
+    find: (contractId: string, contractItemId: string) => Promise<ContractItemData | undefined>;
+}

package/dist/types/contract/ContractItem/index.d.ts

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

package/dist/types/contract/ContractItem/types.d.ts

@@ -0,0 +1,2 @@
+import { MittwaldAPIV2 } from "@mittwald/api-client";
+export type ContractItemData = MittwaldAPIV2.Operations.ContractGetDetailOfContractItem.ResponseData;

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

@@ -0,0 +1,2 @@
+export * from "./Contract/index.js";
+export * from "./ContractItem/index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-models",
-  "version": "4.61.0",
+  "version": "4.62.0",
   "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
   "type": "module",
   "description": "Collection of domain models for coherent interaction with the API",
@@ -39,7 +39,7 @@
     "test:unit": "node --experimental-vm-modules $(yarn bin jest)"
   },
   "dependencies": {
-    "@mittwald/api-client": "^4.60.0",
+    "@mittwald/api-client": "^4.61.1",
     "another-deep-freeze": "^1.0.0",
     "context": "^3.0.31",
     "object-code": "^1.3.3",
@@ -82,5 +82,5 @@
       "optional": true
     }
   },
-  "gitHead": "87f9b29bfab46d969b2061411b3dc7c4b7dd9699"
+  "gitHead": "e22fd31676cdf21390bda78ffde3f7acc364911c"
 }