@mittwald/api-models 0.1.0-alpha.2 → 4.11.0

package/LICENSE

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

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

@@ -3,15 +3,15 @@ import { classes } from "polytype";
 import { DataModel } from "../../base/DataModel.js";
 import assertObjectFound from "../../base/assertObjectFound.js";
 import { ReferenceModel } from "../../base/ReferenceModel.js";
-import { withAsyncResourceVariant } from "../../lib/withAsyncResourceVariant.js";
+import { provideReact } from "../../lib/provideReact.js";
 export class AppInstallation extends ReferenceModel {
-    static find = withAsyncResourceVariant(async (id) => {
+    static find = provideReact(async (id) => {
         const data = await config.behaviors.appInstallation.find(id);
         if (data !== undefined) {
             return new AppInstallationDetailed(data);
         }
     });
-    static get = withAsyncResourceVariant(async (id) => {
+    static get = provideReact(async (id) => {
         const appInstallation = await this.find(id);
         assertObjectFound(appInstallation, this, id);
         return appInstallation;
@@ -19,11 +19,11 @@ export class AppInstallation extends ReferenceModel {
     static ofId(id) {
         return new AppInstallation(id);
     }
-    static list = withAsyncResourceVariant(async (projectId, query = {}) => {
+    static list = provideReact(async (projectId, query = {}) => {
         const data = await config.behaviors.appInstallation.list(projectId, query);
         return data.map((d) => new AppInstallationListItem(d));
     });
-    getDetailed = withAsyncResourceVariant(() => AppInstallation.get(this.id));
+    getDetailed = provideReact(() => AppInstallation.get(this.id));
 }
 // Common class for future extension
 class AppInstallationCommon extends classes((DataModel), AppInstallation) {

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

@@ -8,6 +8,9 @@ import { apiAppInstallationBehaviors } from "../../app/AppInstallation/behaviors
 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;
         config.behaviors.project = apiProjectBehaviors(client);
         config.behaviors.server = apiServerBehaviors(client);
@@ -18,6 +21,9 @@ class ApiSetupState {
     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.");

package/dist/esm/customer/Customer/Customer.js

@@ -3,27 +3,27 @@ import { classes } from "polytype";
 import { DataModel } from "../../base/DataModel.js";
 import assertObjectFound from "../../base/assertObjectFound.js";
 import { ReferenceModel } from "../../base/ReferenceModel.js";
-import { withAsyncResourceVariant } from "../../lib/withAsyncResourceVariant.js";
+import { provideReact } from "../../lib/provideReact.js";
 export class Customer extends ReferenceModel {
     static ofId(id) {
         return new Customer(id);
     }
-    static find = withAsyncResourceVariant(async (id) => {
+    static find = provideReact(async (id) => {
         const data = await config.behaviors.customer.find(id);
         if (data !== undefined) {
             return new CustomerDetailed(data);
         }
     });
-    static list = withAsyncResourceVariant(async (query = {}) => {
+    static list = provideReact(async (query = {}) => {
         const data = await config.behaviors.customer.list(query);
         return Object.freeze(data.map((d) => new CustomerListItem(d)));
     });
-    static get = withAsyncResourceVariant(async (id) => {
+    static get = provideReact(async (id) => {
         const customer = await this.find(id);
         assertObjectFound(customer, this, id);
         return customer;
     });
-    getDetailed = withAsyncResourceVariant(() => Customer.get(this.id));
+    getDetailed = provideReact(() => Customer.get(this.id));
 }
 // Common class for future extension
 class CustomerCommon extends classes((DataModel), Customer) {

package/dist/esm/domain/Ingress/Ingress.js

@@ -3,7 +3,7 @@ import { classes } from "polytype";
 import { DataModel } from "../../base/DataModel.js";
 import assertObjectFound from "../../base/assertObjectFound.js";
 import { ReferenceModel } from "../../base/ReferenceModel.js";
-import { withAsyncResourceVariant } from "../../lib/withAsyncResourceVariant.js";
+import { provideReact } from "../../lib/provideReact.js";
 import { IngressPath } from "../IngressPath/IngressPath.js";
 export class Ingress extends ReferenceModel {
     static ofId(id) {
@@ -12,22 +12,22 @@ export class Ingress extends ReferenceModel {
     static ofHostname(hostname) {
         return Ingress.ofId(hostname);
     }
-    static list = withAsyncResourceVariant(async (query = {}) => {
+    static list = provideReact(async (query = {}) => {
         const data = await config.behaviors.ingress.list(query);
         return data.map((d) => new IngressListItem(d));
     });
-    static find = withAsyncResourceVariant(async (id) => {
+    static find = provideReact(async (id) => {
         const data = await config.behaviors.ingress.find(id);
         if (data !== undefined) {
             return new IngressDetailed(data);
         }
     });
-    static get = withAsyncResourceVariant(async (id) => {
+    static get = provideReact(async (id) => {
         const ingress = await this.find(id);
         assertObjectFound(ingress, this, id);
         return ingress;
     });
-    getDetailed = withAsyncResourceVariant(() => Ingress.get(this.id));
+    getDetailed = provideReact(() => Ingress.get(this.id));
 }
 export class IngressCommon extends classes((DataModel), Ingress) {
     baseUrl;

package/dist/esm/lib/{withAsyncResourceVariant.js → provideReact.js}

@@ -1,5 +1,5 @@
 import { reactUsePromise } from "../react/reactUsePromise.js";
-export const withAsyncResourceVariant = (loader) => Object.assign(loader, {
+export const provideReact = (loader) => Object.assign(loader, {
     asResource: (...params) => reactUsePromise.getAsyncResource(loader, params),
     use: (...params) => reactUsePromise.getAsyncResource(loader, params).use(),
 });

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

@@ -3,7 +3,7 @@ import { classes } from "polytype";
 import { DataModel } from "../../base/DataModel.js";
 import assertObjectFound from "../../base/assertObjectFound.js";
 import { Server } from "../../server/index.js";
-import { withAsyncResourceVariant, } from "../../lib/withAsyncResourceVariant.js";
+import { provideReact, } from "../../lib/provideReact.js";
 import { Customer } from "../../customer/Customer/Customer.js";
 import { ReferenceModel } from "../../base/ReferenceModel.js";
 import { Ingress, IngressListItem } from "../../domain/index.js";
@@ -11,18 +11,18 @@ export class Project extends ReferenceModel {
     static ofId(id) {
         return new Project(id);
     }
-    static find = withAsyncResourceVariant(async (id) => {
+    static find = provideReact(async (id) => {
         const data = await config.behaviors.project.find(id);
         if (data !== undefined) {
             return new ProjectDetailed(data);
         }
     });
-    static get = withAsyncResourceVariant(async (id) => {
+    static get = provideReact(async (id) => {
         const project = await this.find(id);
         assertObjectFound(project, this, id);
         return project;
     });
-    static list = withAsyncResourceVariant(async (query = {}) => {
+    static list = provideReact(async (query = {}) => {
         const data = await config.behaviors.project.list(query);
         return Object.freeze(data.map((d) => new ProjectListItem(d)));
     });
@@ -30,9 +30,9 @@ export class Project extends ReferenceModel {
         const { id } = await config.behaviors.project.create(serverId, description);
         return new Project(id);
     }
-    getDetailed = withAsyncResourceVariant(() => Project.get(this.id));
-    listIngresses = withAsyncResourceVariant(() => Ingress.list({ projectId: this.id }));
-    getDefaultIngress = withAsyncResourceVariant(async () => {
+    getDetailed = provideReact(() => Project.get(this.id));
+    listIngresses = provideReact(() => Ingress.list({ projectId: this.id }));
+    getDefaultIngress = provideReact(async () => {
         const ingresses = await Project.ofId(this.id).listIngresses();
         const defaultIngress = ingresses.find((i) => i.data.isDefault);
         assertObjectFound(defaultIngress, IngressListItem, this);

package/dist/esm/react/index.js

@@ -1,3 +1,3 @@
 export * from "./MittwaldApiModelProvider.js";
 export * from "./reactUsePromise.js";
-export { withAsyncResourceVariant } from "../lib/withAsyncResourceVariant.js";
+export { provideReact } from "../lib/provideReact.js";

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

@@ -4,20 +4,20 @@ import { classes } from "polytype";
 import { DataModel } from "../../base/DataModel.js";
 import assertObjectFound from "../../base/assertObjectFound.js";
 import { Project } from "../../project/index.js";
-import { withAsyncResourceVariant, } from "../../lib/withAsyncResourceVariant.js";
+import { provideReact } from "../../lib/provideReact.js";
 export class Server extends ReferenceModel {
-    static find = withAsyncResourceVariant(async (id) => {
+    static find = provideReact(async (id) => {
         const serverData = await config.behaviors.server.find(id);
         if (serverData !== undefined) {
             return new ServerDetailed([serverData]);
         }
     });
-    static get = withAsyncResourceVariant(async (id) => {
+    static get = provideReact(async (id) => {
         const server = await ServerDetailed.find(id);
         assertObjectFound(server, this, id);
         return server;
     });
-    static list = withAsyncResourceVariant(async (query = {}) => {
+    static list = provideReact(async (query = {}) => {
         const projectListData = await config.behaviors.server.list(query);
         return projectListData.map((d) => new ServerListItem([d]));
     });
@@ -27,13 +27,13 @@ export class Server extends ReferenceModel {
     async createProject(...parameters) {
         return Project.create(this.id, ...parameters);
     }
-    listProjects = withAsyncResourceVariant(async (query = {}) => {
+    listProjects = provideReact(async (query = {}) => {
         return Project.list({
             ...query,
             serverId: this.id,
         });
     });
-    getDetailed = withAsyncResourceVariant(() => ServerDetailed.get(this.id));
+    getDetailed = provideReact(() => ServerDetailed.get(this.id));
 }
 // Common class for future extension
 class ServerCommon extends classes((DataModel), Server) {

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

@@ -3,6 +3,7 @@ declare class ApiSetupState {
     private _client;
     setupWithClient(client: MittwaldAPIV2Client): void;
     setupWithApiToken(apiToken: string): void;
+    setupUnauthenticated(): void;
     get client(): MittwaldAPIV2Client;
     get defaults(): (typeof this.client)["axios"]["defaults"];
     get interceptors(): (typeof this.client)["axios"]["interceptors"];

package/dist/types/lib/{withAsyncResourceVariant.d.ts → provideReact.d.ts}

@@ -1,7 +1,7 @@
 import { AsyncResource } from "../react/reactUsePromise.js";
 type FnParameters = unknown[];
 type AsyncFn<TResult, TParams extends FnParameters> = (...args: TParams) => Promise<TResult>;
-export declare const withAsyncResourceVariant: <TValue, TParams extends FnParameters>(loader: AsyncFn<TValue, TParams>) => AsyncResourceVariant<TValue, TParams>;
+export declare const provideReact: <TValue, TParams extends FnParameters>(loader: AsyncFn<TValue, TParams>) => AsyncResourceVariant<TValue, TParams>;
 export type AsyncResourceVariant<TValue, TParams extends FnParameters> = TParams extends null ? AsyncFn<TValue, TParams> & {
     asResource: () => AsyncResource<TValue>;
 } : AsyncFn<TValue, TParams> & {

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

@@ -1,4 +1,4 @@
 export * from "./MittwaldApiModelProvider.js";
 export * from "./reactUsePromise.js";
-export { type AsyncResourceVariant } from "../lib/withAsyncResourceVariant.js";
-export { withAsyncResourceVariant } from "../lib/withAsyncResourceVariant.js";
+export { type AsyncResourceVariant } from "../lib/provideReact.js";
+export { provideReact } from "../lib/provideReact.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-models",
-  "version": "0.1.0-alpha.2",
+  "version": "4.11.0",
   "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
   "type": "module",
   "description": "Collection of domain models for coherent interaction with the API",
@@ -36,7 +36,7 @@
     "test": "node --experimental-vm-modules $(yarn bin jest)"
   },
   "dependencies": {
-    "@mittwald/api-client": "^3.1.59",
+    "@mittwald/api-client": "^4.11.0",
     "another-deep-freeze": "^1.0.0",
     "polytype": "^0.17.0",
     "type-fest": "^4.10.3"
@@ -69,5 +69,6 @@
     "react": {
       "optional": true
     }
-  }
+  },
+  "gitHead": "48692f21b29d6f4f51aed998a2502f32d4f0eb5c"
 }