@inweb/client 25.9.8 → 25.11.0

package/dist/client.js

@@ -3543,7 +3543,7 @@
             });
         }
         /**
-         * Returns a list of project models.
+         * Returns a list of project files.
          */
         getModels() {
             return this.getFilesInformation()
@@ -4018,6 +4018,188 @@
         }
     }
 
+    ///////////////////////////////////////////////////////////////////////////////
+    // Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
+    // All rights reserved.
+    //
+    // This software and its documentation and related materials are owned by
+    // the Alliance. The software may only be incorporated into application
+    // programs owned by members of the Alliance, subject to a signed
+    // Membership Agreement and Supplemental Software License Agreement with the
+    // Alliance. The structure and organization of this software are the valuable
+    // trade secrets of the Alliance and its suppliers. The software is also
+    // protected by copyright law and international treaty provisions. Application
+    // programs incorporating this software must include the following statement
+    // with their copyright notices:
+    //
+    //   This application incorporates Open Design Alliance software pursuant to a
+    //   license agreement with Open Design Alliance.
+    //   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
+    //   All rights reserved.
+    //
+    // By use of this software, its documentation or related materials, you
+    // acknowledge and accept the above terms.
+    ///////////////////////////////////////////////////////////////////////////////
+    /**
+     * Provides properties and methods for obtaining information about a OAuth 2.0 client that have
+     * access the Open Cloud Server API.
+     */
+    class OAuthClient {
+        /**
+         * @param data - Raw client data received from the server. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#OAuthClient | Open Cloud OAuth Clients API}.
+         * @param httpClient - HTTP client instance used to send requests to the REST API server.
+         */
+        constructor(data, httpClient) {
+            this.httpClient = httpClient;
+            this.data = data;
+        }
+        internalGet() {
+            return this.httpClient.get(`/oauth/clients/${this.clientId}`);
+        }
+        internalPost(relativePath, body) {
+            return this.httpClient.post(`/oauth/clients/${this.clientId}${relativePath}`, body);
+        }
+        internalPut(body) {
+            return this.httpClient.put(`/oauth/clients/${this.clientId}`, body);
+        }
+        internalDelete() {
+            return this.httpClient.delete(`/oauth/clients/${this.clientId}`);
+        }
+        /**
+         * OAuth 2.0 server authorization endpoint.
+         */
+        get authUrl() {
+            return this.data.authUrl;
+        }
+        /**
+         * OAuth 2.0 server token endpoint.
+         */
+        get accessTokenUrl() {
+            return this.data.accessTokenUrl;
+        }
+        /**
+         * Unique client ID.
+         *
+         * @readonly
+         */
+        get clientId() {
+            return this.data.clientId;
+        }
+        /**
+         * Client creation time (UTC) in the format specified in
+         * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
+         */
+        get createdAt() {
+            return this.data.createdAt;
+        }
+        /**
+         * Client application description.
+         */
+        get description() {
+            return this.data.description;
+        }
+        set description(value) {
+            this._data.description = value;
+        }
+        /**
+         * Client data received from the server. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/api.html#OAuthClient | Open Cloud OAuth Clients API}.
+         *
+         * @readonly
+         */
+        get data() {
+            return this._data;
+        }
+        set data(value) {
+            this._data = value;
+        }
+        /**
+         * Client application name.
+         */
+        get name() {
+            return this.data.name;
+        }
+        set name(value) {
+            this._data.name = value;
+        }
+        /**
+         * The endpoint to which the OAuth 2.0 server sends the response.
+         */
+        get redirectUrl() {
+            return this.data.redirectUrl;
+        }
+        set redirectUrl(value) {
+            this.data.redirectUrl = value;
+        }
+        /**
+         * Client secret.
+         *
+         * @readonly
+         */
+        get secret() {
+            return this.data.secret;
+        }
+        /**
+         * Client last update time (UTC) in the format specified in
+         * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
+         */
+        get updatedAt() {
+            return this.data.updatedAt;
+        }
+        /**
+         * Reloads clien data from the server.
+         */
+        async checkout() {
+            const response = await this.internalGet();
+            this.data = await response.json();
+            return this;
+        }
+        /**
+         * Updates client data on the server.
+         *
+         * Only administrators can update OAuth clients. If the current logged in user is not an
+         * administrator, an exception will be thrown.
+         *
+         * @param data - Raw client data. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#OAuthClient | Open Cloud OAuth Clients API}.
+         */
+        async update(data) {
+            const response = await this.internalPut(data);
+            this.data = await response.json();
+            return this;
+        }
+        /**
+         * Deletes a client from the server.
+         *
+         * Only administrators can delete OAuth clients. If the current logged in user is not an
+         * administrator, an exception will be thrown.
+         *
+         * @returns Returns the raw data of a deleted client. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#OAuthClient | Open Cloud OAuth Clients API}.
+         */
+        delete() {
+            return this.internalDelete().then((response) => response.json());
+        }
+        /**
+         * Saves client properties changes to the server. Call this method to update client data on
+         * the server after any property changes.
+         *
+         * Only administrators can update OAuth clients. If the current logged in user is not an
+         * administrator, an exception will be thrown.
+         */
+        save() {
+            return this.update(this.data);
+        }
+        /**
+         * Revokes the access tokens for all users of the client application.
+         */
+        async revoke() {
+            await this.internalPost("/revoke");
+            return this;
+        }
+    }
+
     ///////////////////////////////////////////////////////////////////////////////
     // Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
     // All rights reserved.
@@ -4142,7 +4324,7 @@
                 .then((data) => ({
                 ...data,
                 server: data.version,
-                client: "25.9.8",
+                client: "25.11.0",
             }));
         }
         /**
@@ -4264,6 +4446,91 @@
         updateServerSettings(settings) {
             return this.httpClient.put("/settings", settings).then((response) => response.json());
         }
+        /**
+         * Result for OAuth client list.
+         *
+         * @typedef {any} OAuthClientsResult
+         * @property {OAuthClient[]} result - Result client list.
+         * @property {number} start - The starting index in the client list in the request.
+         * @property {number} limit - The maximum number of requested clients.
+         * @property {number} allSize - Total number of OAuth clients on the server.
+         * @property {number} size - The number of clients in the result list.
+         */
+        /**
+         * Returns a list of OAuth clients of the server.
+         *
+         * Only administrators can get a list of OAuth clients. If the current logged in user is not
+         * an administrator, an exception will be thrown.
+         *
+         * @param start - The starting index in the client list. Used for paging.
+         * @param limit - The maximum number of clients that should be returned per request. Used for paging.
+         */
+        getOAuthClients(start, limit) {
+            const searchParams = new URLSearchParams();
+            if (start > 0)
+                searchParams.set("start", start.toString());
+            if (limit > 0)
+                searchParams.set("limit", limit.toString());
+            let queryString = searchParams.toString();
+            if (queryString)
+                queryString = "?" + queryString;
+            return this.httpClient
+                .get(`/oauth/clients${queryString}`)
+                .then((response) => response.json())
+                .then((clients) => {
+                return {
+                    ...clients,
+                    result: clients.result.map((data) => new OAuthClient(data, this.httpClient)),
+                };
+            });
+        }
+        /**
+         * Returns information about the specified OAuth client.
+         *
+         * Only administrators can get OAuth clients. If the current logged in user is not an
+         * administrator, an exception will be thrown.
+         *
+         * @param clientId - Client ID.
+         */
+        getOAuthClient(clientId) {
+            return this.httpClient
+                .get(`/oauth/clients/${clientId}`)
+                .then((response) => response.json())
+                .then((data) => new OAuthClient(data, this.httpClient));
+        }
+        /**
+         * Creates a new OAuth client on the server.
+         *
+         * Only administrators can create OAuth clients. If the current logged in user is not an
+         * administrator, an exception will be thrown.
+         *
+         * @param name - Client name.
+         * @param redirectUrl - Endpoint to which the OAuth 2.0 server sends the response.
+         * @param description - Client description.
+         */
+        createOAuthClient(name, redirectUrl, description) {
+            return this.httpClient
+                .post("/oauth/clients", {
+                name,
+                redirectUrl,
+                description,
+            })
+                .then((response) => response.json())
+                .then((data) => new OAuthClient(data, this.httpClient));
+        }
+        /**
+         * Deletes the specified OAuth client from the server.
+         *
+         * Only administrators can delete OAuth clients. If the current logged in user is not an
+         * administrator, an exception will be thrown.
+         *
+         * @param clientId - Client ID.
+         * @returns Returns the raw data of a deleted client. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#OAuthClient | Open Cloud OAuth Clients API}.
+         */
+        deleteOAuthClient(clientId) {
+            return this.httpClient.delete(`/oauth/clients/${clientId}`).then((response) => response.json());
+        }
         /**
          * Returns the list of server users.
          *
@@ -4374,10 +4641,10 @@
          * Result for file list.
          *
          * @typedef {any} FilesResult
-         * @property {number} allSize - Total number of files the user has access to.
+         * @property {File[]} result - Result file list.
          * @property {number} start - The starting index in the file list in the request.
          * @property {number} limit - The maximum number of requested files.
-         * @property {File[]} result - Result file list.
+         * @property {number} allSize - Total number of files the user has access to.
          * @property {number} size - The number of files in the result list.
          */
         /**
@@ -4529,10 +4796,10 @@
          * Result for job list.
          *
          * @typedef {any} JobsResult
-         * @property {number} allSize - Total number of jobs created by the user.
+         * @property {Job[]} result - Result job list.
          * @property {number} start - The starting index in the job list in the request.
          * @property {number} limit - The maximum number of requested jobs.
-         * @property {Job[]} result - Result job list.
+         * @property {number} allSize - Total number of jobs created by the user.
          * @property {number} size - The number of jobs in the result list.
          */
         /**
@@ -4627,10 +4894,10 @@
          * Result for assembly list.
          *
          * @typedef {any} AssembliesResult
-         * @property {number} allSize - Total number of assemblies the user has access to.
+         * @property {Assembly[]} result - Result assembly list.
          * @property {number} start - The starting index in the assembly list in the request.
          * @property {number} limit - The maximum number of requested assemblies.
-         * @property {Assembly[]} result - Result assembly list.
+         * @property {number} allSize - Total number of assemblies the user has access to.
          * @property {number} size - The number of assemblies in the result list.
          */
         /**
@@ -4728,10 +4995,10 @@
          * Result for project list.
          *
          * @typedef {any} ProjectsResult
-         * @property {number} allSize - Total number of projects the user has access to.
+         * @property {Project[]} result - Result project list.
          * @property {number} start - The starting index in the project list in the request.
          * @property {number} limit - The maximum number of requested projects.
-         * @property {Project[]} result - Result project list.
+         * @property {number} allSize - Total number of projects the user has access to.
          * @property {number} size - The number of projects in the result list.
          */
         /**
@@ -4872,7 +5139,7 @@
     // By use of this software, its documentation or related materials, you
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
-    const version = "25.9.8";
+    const version = "25.11.0";
 
     exports.Assembly = Assembly;
     exports.ClashTest = ClashTest;
@@ -4882,6 +5149,7 @@
     exports.Job = Job;
     exports.Member = Member;
     exports.Model = Model;
+    exports.OAuthClient = OAuthClient;
     exports.Permission = Permission;
     exports.Project = Project;
     exports.Role = Role;