@mittwald/api-models 4.242.3 → 4.244.0

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 refreshProvideReactCache = (tag) => {
+    cacheTagStore.getAll(tag).forEach((ids) => {
+        ids.forEach((id) => {
+            refresh({
+                tag: String(id),
+            });
+        });
+    });
+};
+export const addTagToProvideReactCache = (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 addUrlTagToProvideReactCache = (request) => {
+    const url = request.requestConfig.url;
+    if (request.requestConfig.method === "GET" && url) {
+        addTagToProvideReactCache(url);
+    }
+};

package/dist/esm/react/index.js

@@ -0,0 +1,4 @@
+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.js

@@ -0,0 +1,27 @@
+import { reactUsePromise } from "./reactUsePromise.js";
+import { hash } from "object-code";
+import { reactProvisionContext } from "./reactProvisionContext.js";
+import { joinedId } from "../lib/joinedId.js";
+export const provideReact = (loader, dependencies = []) => {
+    const loaderHash = hash(loader);
+    let cachedProvisionId;
+    const getAsyncResource = (params) => {
+        const provisionId = cachedProvisionId ??
+            joinedId(loaderHash, ...dependencies
+                .map((d) => (typeof d === "function" ? d() : d))
+                .map((d) => hash(d)));
+        cachedProvisionId = provisionId;
+        const contextId = joinedId(provisionId, hash(params));
+        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/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/esm/react/reactProvisionContext.js

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

package/dist/esm/react/reactUsePromise.js

@@ -0,0 +1,17 @@
+let module = undefined;
+/** @internal */
+export const reactUsePromise = new Proxy({}, {
+    get: (_, prop) => {
+        if (module === undefined) {
+            // @todo Provide better error message
+            throw new Error("ModelProvider not found");
+        }
+        if (prop in module) {
+            return module[prop];
+        }
+    },
+});
+/** @internal */
+export const setModule = (theModule) => {
+    module = theModule;
+};

package/dist/esm/react.js

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

package/dist/esm/server/Server/Server.js

@@ -0,0 +1,102 @@
+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 { Project, ProjectListQuery } from "../../project/index.js";
+import { provideReact, } from "../../react/provideReact.js";
+import { ListQueryModel } from "../../base/ListQueryModel.js";
+import { ListDataModel } from "../../base/ListDataModel.js";
+export class Server extends ReferenceModel {
+    projects;
+    constructor(id) {
+        super(id);
+        this.projects = new ProjectListQuery({
+            server: this,
+        });
+    }
+    static ofId(id) {
+        return new Server(id);
+    }
+    static find = provideReact(async (id) => {
+        const data = await config.behaviors.server.find(id);
+        if (data !== undefined) {
+            return new ServerDetailed(data);
+        }
+    });
+    static get = provideReact(async (id) => {
+        const server = await this.find(id);
+        assertObjectFound(server, this, id);
+        return server;
+    });
+    static query(query = {}) {
+        return new ServerListQuery(query);
+    }
+    /** @deprecated: use query() or customer.servers */
+    static list = provideReact(async (query = {}) => {
+        return new ServerListQuery(query).execute().then((r) => r.items);
+    });
+    async createProject(...parameters) {
+        return Project.create(this.id, ...parameters);
+    }
+    /** @deprecated Use Server.projects property */
+    listProjects = provideReact(async (query = {}) => {
+        return Project.list({
+            ...query,
+            serverId: this.id,
+        });
+    });
+    getDetailed = provideReact(() => Server.get(this.id), [this.id]);
+    findDetailed = provideReact(() => Server.find(this.id), [this.id]);
+}
+// Common class for future extension
+class ServerCommon extends classes((DataModel), Server) {
+    constructor(data) {
+        super([data], [data.id]);
+    }
+}
+export class ServerDetailed extends classes(ServerCommon, (DataModel)) {
+    constructor(data) {
+        super([data], [data]);
+    }
+}
+export class ServerListItem extends classes(ServerCommon, (DataModel)) {
+    constructor(data) {
+        super([data], [data]);
+    }
+}
+export class ServerListQuery extends ListQueryModel {
+    constructor(query = {}) {
+        super(query);
+    }
+    refine(query) {
+        return new ServerListQuery({
+            ...this.query,
+            ...query,
+        });
+    }
+    execute = provideReact(async () => {
+        const { customer, ...query } = this.query;
+        const { items, totalCount } = await config.behaviors.server.list({
+            limit: config.defaultPaginationLimit,
+            customerId: customer?.id,
+            ...query,
+        });
+        return new ServerList(this.query, items.map((d) => new ServerListItem(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 ServerList extends classes(ServerListQuery, (ListDataModel)) {
+    constructor(query, servers, totalCount) {
+        super([query], [servers, totalCount]);
+    }
+}

package/dist/esm/server/Server/behaviors/api.js

@@ -0,0 +1,22 @@
+import { assertStatus, assertOneOfStatus, extractTotalCountHeader, } from "@mittwald/api-client";
+export const apiServerBehaviors = (client) => ({
+    find: async (id) => {
+        const response = await client.project.getServer({
+            serverId: id,
+        });
+        if (response.status === 200) {
+            return response.data;
+        }
+        assertOneOfStatus(response, [403, 404]);
+    },
+    list: async (query) => {
+        const response = await client.project.listServers({
+            queryParameters: query,
+        });
+        assertStatus(response, 200);
+        return {
+            items: response.data,
+            totalCount: extractTotalCountHeader(response),
+        };
+    },
+});

package/dist/esm/server/Server/behaviors/index.js

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

package/dist/esm/server/Server/behaviors/types.js

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

package/dist/esm/server/Server/index.js

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

package/dist/esm/server/Server/types.js

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

package/dist/esm/server/index.js

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

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

@@ -0,0 +1,138 @@
+import { DataModel } from "../../base/DataModel.js";
+import { ReferenceModel } from "../../base/ReferenceModel.js";
+import { AsyncResourceVariant } from "../../react/provideReact.js";
+import { AppInstallationData, AppInstallationListItemData, AppInstallationListQueryData } from "./types.js";
+import { ListQueryModel } from "../../base/ListQueryModel.js";
+import { ListDataModel } from "../../base/ListDataModel.js";
+import { Project } from "../../project/index.js";
+export declare class AppInstallation extends ReferenceModel {
+    static find: AsyncResourceVariant<(id: string) => Promise<AppInstallationDetailed | undefined>>;
+    static get: AsyncResourceVariant<(id: string) => Promise<AppInstallationDetailed>>;
+    static ofId(id: string): AppInstallation;
+    query(project: Project, query?: AppInstallationListQueryData): AppInstallationListQuery;
+    /** @deprecated: use query() or project.appInstallations */
+    static list: AsyncResourceVariant<(projectId: string, query?: AppInstallationListQueryData) => Promise<Readonly<Array<AppInstallationListItem>>>>;
+    getDetailed: AsyncResourceVariant<() => Promise<AppInstallationDetailed>>;
+    findDetailed: AsyncResourceVariant<() => Promise<AppInstallationDetailed | undefined>>;
+}
+declare const AppInstallationCommon_base: import("polytype").Polytype.ClusteredConstructor<[{
+    new (data: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppAppInstallation | {
+        appId: string;
+        appVersion: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppVersionStatus;
+        createdAt: string;
+        customDocumentRoot?: string | undefined;
+        deletionRequested?: boolean | undefined;
+        description: string;
+        disabled: boolean;
+        id: string;
+        installationPath: string;
+        linkedDatabases: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppLinkedDatabase[];
+        lockedBy?: {
+            [k: string]: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppLockPurpose;
+        } | undefined;
+        phase: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppPhase;
+        projectId: string;
+        screenshotId?: string | undefined;
+        screenshotRef?: string | undefined;
+        shortId: string;
+        systemSoftware: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppInstalledSystemSoftware[];
+        updatePolicy: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppAppUpdatePolicy;
+        userInputs: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppSavedUserInput[];
+    }): DataModel<import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppAppInstallation | {
+        appId: string;
+        appVersion: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppVersionStatus;
+        createdAt: string;
+        customDocumentRoot?: string | undefined;
+        deletionRequested?: boolean | undefined;
+        description: string;
+        disabled: boolean;
+        id: string;
+        installationPath: string;
+        linkedDatabases: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppLinkedDatabase[];
+        lockedBy?: {
+            [k: string]: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppLockPurpose;
+        } | undefined;
+        phase: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppPhase;
+        projectId: string;
+        screenshotId?: string | undefined;
+        screenshotRef?: string | undefined;
+        shortId: string;
+        systemSoftware: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppInstalledSystemSoftware[];
+        updatePolicy: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppAppUpdatePolicy;
+        userInputs: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppSavedUserInput[];
+    }>;
+}, typeof AppInstallation]>;
+declare class AppInstallationCommon extends AppInstallationCommon_base {
+    constructor(data: AppInstallationListItemData | AppInstallationData);
+}
+declare const AppInstallationDetailed_base: import("polytype").Polytype.ClusteredConstructor<[typeof AppInstallationCommon, {
+    new (data: {
+        appId: string;
+        appVersion: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppVersionStatus;
+        createdAt: string;
+        customDocumentRoot?: string | undefined;
+        deletionRequested?: boolean | undefined;
+        description: string;
+        disabled: boolean;
+        id: string;
+        installationPath: string;
+        linkedDatabases: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppLinkedDatabase[];
+        lockedBy?: {
+            [k: string]: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppLockPurpose;
+        } | undefined;
+        phase: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppPhase;
+        projectId: string;
+        screenshotId?: string | undefined;
+        screenshotRef?: string | undefined;
+        shortId: string;
+        systemSoftware: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppInstalledSystemSoftware[];
+        updatePolicy: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppAppUpdatePolicy;
+        userInputs: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppSavedUserInput[];
+    }): DataModel<{
+        appId: string;
+        appVersion: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppVersionStatus;
+        createdAt: string;
+        customDocumentRoot?: string | undefined;
+        deletionRequested?: boolean | undefined;
+        description: string;
+        disabled: boolean;
+        id: string;
+        installationPath: string;
+        linkedDatabases: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppLinkedDatabase[];
+        lockedBy?: {
+            [k: string]: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppLockPurpose;
+        } | undefined;
+        phase: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppPhase;
+        projectId: string;
+        screenshotId?: string | undefined;
+        screenshotRef?: string | undefined;
+        shortId: string;
+        systemSoftware: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppInstalledSystemSoftware[];
+        updatePolicy: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppAppUpdatePolicy;
+        userInputs: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppSavedUserInput[];
+    }>;
+}]>;
+export declare class AppInstallationDetailed extends AppInstallationDetailed_base {
+    constructor(data: AppInstallationData);
+}
+declare const AppInstallationListItem_base: import("polytype").Polytype.ClusteredConstructor<[typeof AppInstallationCommon, {
+    new (data: import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppAppInstallation): DataModel<import("@mittwald/api-client").MittwaldAPIV2.Components.Schemas.AppAppInstallation>;
+}]>;
+export declare class AppInstallationListItem extends AppInstallationListItem_base {
+    constructor(data: AppInstallationListItemData);
+}
+export declare class AppInstallationListQuery extends ListQueryModel<AppInstallationListQueryData> {
+    readonly project: Project;
+    constructor(project: Project, query?: AppInstallationListQueryData);
+    refine(query: AppInstallationListQueryData): AppInstallationListQuery;
+    execute: AsyncResourceVariant<() => Promise<AppInstallationList>>;
+    getTotalCount: AsyncResourceVariant<() => Promise<number>>;
+    findOneAndOnly: AsyncResourceVariant<() => Promise<AppInstallationListItem | undefined>>;
+}
+declare const AppInstallationList_base: import("polytype").Polytype.ClusteredConstructor<[typeof AppInstallationListQuery, {
+    new (items: AppInstallationListItem[], totalCount: number): ListDataModel<AppInstallationListItem>;
+}]>;
+export declare class AppInstallationList extends AppInstallationList_base {
+    constructor(project: Project, query: AppInstallationListQueryData, appInstallations: AppInstallationListItem[], totalCount: number);
+}
+export {};

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,4 @@
+import { MittwaldAPIV2 } from "@mittwald/api-client";
+export type AppInstallationListQueryData = MittwaldAPIV2.Paths.V2ProjectsProjectIdAppInstallations.Get.Parameters.Query;
+export type AppInstallationData = MittwaldAPIV2.Operations.AppGetAppinstallation.ResponseData;
+export type AppInstallationListItemData = MittwaldAPIV2.Operations.AppListAppinstallations.ResponseData[number];

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

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

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/DataModel.d.ts

@@ -0,0 +1,5 @@
+import { ReadonlyDeep } from "type-fest";
+export declare class DataModel<T> {
+    readonly data: ReadonlyDeep<T>;
+    constructor(data: T);
+}

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

@@ -0,0 +1,5 @@
+export declare class ListDataModel<TItem> {
+    readonly items: readonly TItem[];
+    readonly totalCount: number;
+    constructor(items: TItem[], totalCount: number);
+}

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

@@ -0,0 +1,9 @@
+interface Options {
+    dependencies?: string[];
+}
+export declare abstract class ListQueryModel<TQuery> {
+    protected readonly query: TQuery;
+    readonly queryId: string;
+    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/base/ReferenceModel.d.ts

@@ -0,0 +1,5 @@
+export declare abstract class ReferenceModel {
+    readonly id: string;
+    constructor(id: string);
+    describe(): string;
+}

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

@@ -0,0 +1,3 @@
+import { Constructor } from "type-fest";
+import { ReferenceModel } from "./ReferenceModel.js";
+export default function assertObjectFound<T>(obj: T | undefined, theClass: Constructor<unknown>, refIdOrObject: string | ReferenceModel): asserts obj is T;

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

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