@inweb/client 26.9.0 → 26.9.2

package/README.md

@@ -13,6 +13,7 @@ Core capabilities:
 - Create and manage assemblies.
 - Create projects, manage project models and members.
 - Change server settings.
+- Manage server plugins.
 
 This library is a part of [CDE SDK](https://www.opendesign.com/products/cde) by [Open Design Alliance](https://opendesign.com).
 
@@ -46,6 +47,7 @@ The `Client.js` package will be downloaded and installed. Then you're ready to i
 
 ```javascript
 import { Client } from "@inweb/client";
+
 const client = new Client({ serverUrl: "https://cloud.opendesign.com/api" });
 ```
 

package/dist/client.js

@@ -2844,8 +2844,8 @@
          *       {@link downloadResource | downloadResource()} to download the exported file.
          *   - Other custom job name. Custom job must be registered in the job templates before running.
          *
-         * @param parameters - Parameters for the File Converter jobs or custom job. Can be given as command
-         *   line arguments in form `--arg=value`.
+         * @param parameters - Parameters for the File Converter jobs or custom job. Can be given as JSON
+         *   object or command line arguments in form `--arg=value`.
          */
         createJob(outputFormat, parameters) {
             const jobs = new Endpoint("/jobs", this.httpClient, this.headers);
@@ -4501,6 +4501,221 @@
         }
     }
 
+    ///////////////////////////////////////////////////////////////////////////////
+    // Copyright (C) 2002-2025, 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-2025 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 server plugin on the Open Cloud
+     * Server and managing its data.
+     */
+    class Plugin extends Endpoint {
+        /**
+         * @param data - Raw plugin data received from the server. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Plugin | Open Cloud Plugins API}.
+         * @param httpClient - HTTP client instance used to send requests to the REST API server.
+         */
+        constructor(data, httpClient) {
+            super(`/plugins/${data.name}/${data.version}`, httpClient);
+            this.data = data;
+        }
+        /**
+         * Plugin author information. The `author` is an object with a `name` field and optionally `url` and
+         * `email`. Or it can be shorten that all into a single string.
+         *
+         * @readonly
+         */
+        get author() {
+            return this.data.author;
+        }
+        /**
+         * Raw plugin data received from the server. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Plugin | Open Cloud Plugins API}.
+         */
+        get data() {
+            return this._data;
+        }
+        set data(value) {
+            this._data = value;
+        }
+        /**
+         * Short description of the plugin.
+         *
+         * @readonly
+         */
+        get description() {
+            return this.data.description;
+        }
+        /**
+         * Plugin state.
+         *
+         * @readonly
+         */
+        get enabled() {
+            return this.data.enabled;
+        }
+        /**
+         * The URL to the plugin homepage.
+         *
+         * @readonly
+         */
+        get homepage() {
+            return this.data.homepage;
+        }
+        /**
+         * Unique plugin ID.
+         *
+         * @readonly
+         */
+        get id() {
+            return this.data.id;
+        }
+        /**
+         * A license for the plugin.
+         *
+         * @readonly
+         */
+        get license() {
+            return this.data.license;
+        }
+        /**
+         * Plugin name.
+         *
+         * @readonly
+         */
+        get name() {
+            return this.data.name;
+        }
+        /**
+         * API permissions required.
+         *
+         * @readonly
+         */
+        get permissions() {
+            return this.data.permissions;
+        }
+        /**
+         * Plugin type. Can be set of:
+         *
+         * - `app` - Viewer plugin, the client‑side web app that the server hosts and serves as static content.
+         * - `server` - Binary dll that extends server functionality.
+         * - `jobrunner` - Binary dll that adds a new Job Runner on the server.
+         *
+         * @readonly
+         */
+        get pluginType() {
+            return this.data.pluginType;
+        }
+        /**
+         * {@link https://semver.org/ | SemVer} compatible version of the plugin.
+         *
+         * @readonly
+         */
+        get version() {
+            return this.data.version;
+        }
+        /**
+         * Reloads plugin data from the server.
+         */
+        async checkout() {
+            const response = await this.get("");
+            this.data = await response.json();
+            return this;
+        }
+        /**
+         * Uninstalls and deletes a plugin from the server.
+         *
+         * @returns Returns the raw data of a deleted plugin. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Plugin | Open Cloud Plugins API}.
+         */
+        delete() {
+            return super.delete("").then((response) => response.json());
+        }
+        /**
+         * Enables a plugin.
+         */
+        async enable() {
+            const response = await this.put("/enable");
+            this.data = await response.json();
+            return this;
+        }
+        /**
+         * Disables a plugin.
+         */
+        async disable() {
+            const response = await this.put("/disable");
+            this.data = await response.json();
+            return this;
+        }
+        /**
+         * Downloads the plugins package from the server.
+         *
+         * @param onProgress - Download progress callback.
+         * @param signal - An
+         *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal. Allows
+         *   to communicate with a fetch request and abort it if desired.
+         */
+        download(onProgress, signal) {
+            return this.httpClient
+                .downloadFile(this.getEndpointPath("/download"), onProgress, { signal, headers: this.headers })
+                .then((response) => response.arrayBuffer());
+        }
+        /**
+         * Returns a plugin manfest.
+         */
+        getManifest() {
+            return this.get("/manifest").then((response) => response.json());
+        }
+        /**
+         * Returns the plugin settings.
+         *
+         * @returns Returns an object with plugin settings.
+         */
+        getSettings() {
+            return this.get("/settings").then((response) => response.json());
+        }
+        /**
+         * Changes the plugin settings.
+         *
+         * @param settings - An object with the new plugin settings or part of the settings.
+         * @returns Returns an object with updated plugin settings.
+         */
+        updateSettings(settings) {
+            return this.post("/settings", settings).then((response) => response.json());
+        }
+        /**
+         * Executes a plugin command.
+         *
+         * This method executes the command for the current version of the plugin. To execute a command for the
+         * latest installed version of the plugin, use the {@link Client.executePluginCommand}.
+         *
+         * @param command - Command to execute.
+         * @param parameters - Command parameters. Command-dependent.
+         */
+        executeCommand(command, parameters) {
+            const commands = new Endpoint(`/plugins/${this.name}/commands`, this.httpClient, this.headers);
+            return commands.post(`/${command}?version=${this.version}`, parameters).then((response) => response.json());
+        }
+    }
+
     ///////////////////////////////////////////////////////////////////////////////
     // Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
     // All rights reserved.
@@ -4625,7 +4840,7 @@
                 .then((data) => ({
                 ...data,
                 server: data.version,
-                client: "26.9.0",
+                client: "26.9.2",
             }));
         }
         /**
@@ -5182,8 +5397,8 @@
          *   - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the specified format.
          *   - Other custom job name. Custom job must be registered in the job templates before running.
          *
-         * @param parameters - Parameters for the File Converter jobs or custom job. Can be given as command
-         *   line arguments in form `--arg=value`.
+         * @param parameters - Parameters for the File Converter jobs or custom job. Can be given as JSON
+         *   object or command line arguments in form `--arg=value`.
          */
         createJob(fileId, outputFormat, parameters) {
             return this.httpClient
@@ -5279,8 +5494,8 @@
          * @param name - Assembly name.
          * @param params - Additional assembly creating parameters.
          * @param params.jobParameters - Parameters for the File Converter jobs. Use this to specify aditional
-         *   parameters for generating the geometry and properties of the new assembly. Can be given as command
-         *   line arguments in form `--arg=value`.
+         *   parameters for generating the geometry and properties of the new assembly. Can be given as JSON
+         *   object or command line arguments in form `--arg=value`.
          * @param params.waitForDone - Wait for assembly to be created.
          * @param params.timeout - The time, in milliseconds, that the function should wait for the assembly to
          *   be created. If the assembly is not created within this time, a TimeoutError exception will be
@@ -5500,6 +5715,108 @@
                 .then((response) => response.json())
                 .then((data) => new SharedFile(data, password, this.httpClient));
         }
+        /**
+         * Returns the list of installed plugins.
+         *
+         * Only administrators can get a list of plugins. If the current logged in user is not an
+         * administrator, an exception will be thrown.
+         */
+        getPlugins() {
+            return this.httpClient
+                .get("/plugins")
+                .then((response) => response.json())
+                .then((array) => array.map((data) => new Plugin(data, this.httpClient)));
+        }
+        /**
+         * Returns information about the specified plugin.
+         *
+         * Only administrators can get plugins. If the current logged in user is not an administrator, they can
+         * only get themselves, otherwise an exception will be thrown.
+         *
+         * @param name - Plugin name.
+         * @param version - Plugin version.
+         */
+        getPlugin(name, version) {
+            return this.httpClient
+                .get(`/plugins/${name}/${version}`)
+                .then((response) => response.json())
+                .then((data) => new Plugin(data, this.httpClient));
+        }
+        /**
+         * Uploads and install a plugin package to the server. The package must be a ZIP file and undergoes
+         * verification, scanning, and health checks during installation.
+         *
+         * Only administrators can upload plugins. If the current logged in user is not an administrator, an
+         * exception will be thrown.
+         *
+         * @param file - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object are
+         *   generally retrieved from a {@link https://developer.mozilla.org/docs/Web/API/FileList | FileList}
+         *   object returned as a result of a user selecting files using the HTML `<input>` element.
+         * @param onProgress - Upload progress callback.
+         */
+        async uploadPlugin(file, onProgress) {
+            return await this.httpClient
+                .uploadFile("/plugins", file, (progress) => {
+                this.emitEvent({ type: "uploadprogress", data: progress, file });
+                if (onProgress)
+                    onProgress(progress, file);
+            })
+                .then((xhr) => JSON.parse(xhr.responseText))
+                .then((data) => new Plugin(data, this.httpClient));
+        }
+        /**
+         * Uninstalls and deletes the specified plugin from the server.
+         *
+         * Only administrators can delete plugins. If the current logged in user is not an administrator, an
+         * exception will be thrown.
+         *
+         * @param name - Plugin name.
+         * @param version - Plugin version.
+         */
+        deletePlugin(name, version) {
+            return this.httpClient.delete(`/plugins/${name}/${version}`).then((response) => response.json());
+        }
+        /**
+         * Downloads the specified plugin package from the server.
+         *
+         * Only administrators can download plugins. If the current logged in user is not an administrator, an
+         * exception will be thrown.
+         *
+         * @param name - Plugin name.
+         * @param version - Plugin version.
+         * @param onProgress - Download progress callback.
+         * @param signal - An
+         *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal. Allows
+         *   to communicate with a fetch request and abort it if desired.
+         */
+        downloadPlugin(name, version, onProgress, signal) {
+            return this.httpClient
+                .downloadFile(`/plugins/${name}/${version}/download`, onProgress, { signal })
+                .then((response) => response.arrayBuffer());
+        }
+        /**
+         * Executes a plugin command.
+         *
+         * If you have multiple versions of a plugin installed and want to run the command for the latest
+         * version of the plugin, specify `undefined` or empty string for the `version` parameter.
+         *
+         * @param name - Plugin name.
+         * @param version - Plugin version. Specify `undefined` or empty string to run the command for the
+         *   latest version of the plugin.
+         * @param command - Command to execute.
+         * @param parameters - Command parameters. Command-dependent.
+         */
+        executePluginCommand(name, version, command, parameters) {
+            const searchParams = new URLSearchParams();
+            if (version)
+                searchParams.set("version", version);
+            let queryString = searchParams.toString();
+            if (queryString)
+                queryString = "?" + queryString;
+            return this.httpClient
+                .post(`/plugins/${name}/commands/${command}${queryString}`, parameters)
+                .then((response) => response.json());
+        }
     }
 
     ///////////////////////////////////////////////////////////////////////////////
@@ -5524,7 +5841,7 @@
     // By use of this software, its documentation or related materials, you
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
-    const version = "26.9.0";
+    const version = "26.9.2";
 
     exports.Assembly = Assembly;
     exports.ClashTest = ClashTest;
@@ -5537,6 +5854,7 @@
     exports.Model = Model;
     exports.OAuthClient = OAuthClient;
     exports.Permission = Permission;
+    exports.Plugin = Plugin;
     exports.Project = Project;
     exports.Role = Role;
     exports.SharedFile = SharedFile;