@mittwald/api-models 4.242.2 → 4.243.0

package/dist/esm/app/AppInstallation/AppInstallation.js

@@ -0,0 +1,89 @@
+import { config } from "../../config/config.js";
+import { classes } from "polytype";
+import { DataModel } from "../../base/DataModel.js";
+import assertObjectFound from "../../base/assertObjectFound.js";
+import { ReferenceModel } from "../../base/ReferenceModel.js";
+import { provideReact, } from "../../react/provideReact.js";
+import { ListQueryModel } from "../../base/ListQueryModel.js";
+import { ListDataModel } from "../../base/ListDataModel.js";
+import { Project } from "../../project/index.js";
+export class AppInstallation extends ReferenceModel {
+    static find = provideReact(async (id) => {
+        const data = await config.behaviors.appInstallation.find(id);
+        if (data !== undefined) {
+            return new AppInstallationDetailed(data);
+        }
+    });
+    static get = provideReact(async (id) => {
+        const appInstallation = await this.find(id);
+        assertObjectFound(appInstallation, this, id);
+        return appInstallation;
+    });
+    static ofId(id) {
+        return new AppInstallation(id);
+    }
+    query(project, query = {}) {
+        return new AppInstallationListQuery(project, query);
+    }
+    /** @deprecated: use query() or project.appInstallations */
+    static list = provideReact(async (projectId, query = {}) => {
+        return new AppInstallationListQuery(Project.ofId(projectId), query)
+            .execute()
+            .then((r) => r.items);
+    });
+    getDetailed = provideReact(() => AppInstallation.get(this.id), [this.id]);
+    findDetailed = provideReact(() => AppInstallation.find(this.id), [this.id]);
+}
+// Common class for future extension
+class AppInstallationCommon extends classes((DataModel), AppInstallation) {
+    constructor(data) {
+        super([data], [data.id]);
+    }
+}
+export class AppInstallationDetailed extends classes(AppInstallationCommon, (DataModel)) {
+    constructor(data) {
+        super([data], [data]);
+    }
+}
+export class AppInstallationListItem extends classes(AppInstallationCommon, (DataModel)) {
+    constructor(data) {
+        super([data], [data]);
+    }
+}
+export class AppInstallationListQuery extends ListQueryModel {
+    project;
+    constructor(project, query = {}) {
+        super(query, {
+            dependencies: [project.id],
+        });
+        this.project = project;
+    }
+    refine(query) {
+        return new AppInstallationListQuery(this.project, {
+            ...this.query,
+            ...query,
+        });
+    }
+    execute = provideReact(async () => {
+        const { items, totalCount } = await config.behaviors.appInstallation.list(this.project.id, {
+            limit: config.defaultPaginationLimit,
+            ...this.query,
+        });
+        return new AppInstallationList(this.project, this.query, items.map((d) => new AppInstallationListItem(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: 2 }).execute();
+        if (totalCount === 1) {
+            return items[0];
+        }
+    }, [this.queryId]);
+}
+export class AppInstallationList extends classes(AppInstallationListQuery, (ListDataModel)) {
+    constructor(project, query, appInstallations, totalCount) {
+        super([project, query], [appInstallations, totalCount]);
+    }
+}

package/dist/esm/app/AppInstallation/behaviors/api.js

@@ -0,0 +1,24 @@
+import { assertStatus, extractTotalCountHeader, } from "@mittwald/api-client";
+import { assertOneOfStatus } from "@mittwald/api-client";
+export const apiAppInstallationBehaviors = (client) => ({
+    find: async (id) => {
+        const response = await client.app.getAppinstallation({
+            appInstallationId: id,
+        });
+        if (response.status === 200) {
+            return response.data;
+        }
+        assertOneOfStatus(response, [404]);
+    },
+    list: async (projectId, query) => {
+        const response = await client.app.listAppinstallations({
+            queryParameters: query,
+            projectId,
+        });
+        assertStatus(response, 200);
+        return {
+            items: response.data,
+            totalCount: extractTotalCountHeader(response),
+        };
+    },
+});

package/dist/esm/app/AppInstallation/behaviors/index.js

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

package/dist/esm/app/AppInstallation/behaviors/types.js

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

package/dist/esm/app/AppInstallation/index.js

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

package/dist/esm/app/AppInstallation/types.js

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

package/dist/esm/app/index.js

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

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/DataModel.js

@@ -0,0 +1,7 @@
+import deepFreeze from "../lib/deepFreeze.js";
+export class DataModel {
+    data;
+    constructor(data) {
+        this.data = deepFreeze(data);
+    }
+}

package/dist/esm/base/ListDataModel.js

@@ -0,0 +1,8 @@
+export class ListDataModel {
+    items;
+    totalCount;
+    constructor(items, totalCount) {
+        this.items = Object.freeze(items);
+        this.totalCount = totalCount;
+    }
+}

package/dist/esm/base/ListQueryModel.js

@@ -0,0 +1,11 @@
+import { hash } from "object-code";
+import { joinedId } from "../lib/joinedId.js";
+export class ListQueryModel {
+    query;
+    queryId;
+    constructor(query, opts = {}) {
+        const { dependencies = [] } = opts;
+        this.query = query;
+        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/base/ReferenceModel.js

@@ -0,0 +1,9 @@
+export class ReferenceModel {
+    id;
+    constructor(id) {
+        this.id = id;
+    }
+    describe() {
+        return `${this.constructor.name}@${this.id}`;
+    }
+}

package/dist/esm/base/assertObjectFound.js

@@ -0,0 +1,9 @@
+import ObjectNotFoundError from "../errors/ObjectNotFoundError.js";
+export default function assertObjectFound(obj, theClass, refIdOrObject) {
+    if (obj === undefined) {
+        const refName = typeof refIdOrObject === "string"
+            ? refIdOrObject
+            : refIdOrObject.toString();
+        throw new ObjectNotFoundError(theClass.name, refName);
+    }
+}

package/dist/esm/base/index.js

@@ -0,0 +1,6 @@
+export * from "./assertObjectFound.js";
+export * from "./DataModel.js";
+export * from "./ReferenceModel.js";
+export * from "./ListDataModel.js";
+export * from "./ListQueryModel.js";
+export * from "./types.js";

package/dist/esm/base/types.js

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

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

@@ -0,0 +1,49 @@
+import { MittwaldAPIV2Client } from "@mittwald/api-client";
+import { config } from "../config.js";
+import { apiProjectBehaviors } from "../../project/Project/behaviors/index.js";
+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 { 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 {
+    _client;
+    setupWithClient(client) {
+        if (this._client !== undefined) {
+            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 =
+            addUrlTagToProvideReactCache;
+        config.behaviors.article = apiArticleBehaviors(client);
+        config.behaviors.project = apiProjectBehaviors(client);
+        config.behaviors.server = apiServerBehaviors(client);
+        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));
+    }
+    setupUnauthenticated() {
+        return this.setupWithClient(MittwaldAPIV2Client.newUnauthenticated());
+    }
+    get client() {
+        if (!this._client) {
+            throw new Error("Could not get client. Behavior not initialized.");
+        }
+        return this._client;
+    }
+    get defaults() {
+        return this.client.axios.defaults;
+    }
+    get interceptors() {
+        return this.client.axios.interceptors;
+    }
+}
+export const api = new ApiSetupState();

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

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

package/dist/esm/config/config.js

@@ -0,0 +1,13 @@
+export const config = {
+    defaultPaginationLimit: 50,
+    behaviors: {
+        contract: undefined,
+        contractItem: undefined,
+        article: undefined,
+        project: undefined,
+        server: undefined,
+        customer: undefined,
+        ingress: undefined,
+        appInstallation: undefined,
+    },
+};

package/dist/esm/config/index.js

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

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";