@inweb/client 25.10.0 → 25.11.0

package/lib/Api/Client.d.ts

@@ -6,6 +6,7 @@ import { File } from "./File";
 import { Job } from "./Job";
 import { Project } from "./Project";
 import { User } from "./User";
+import { OAuthClient } from "./OAuthClient";
 /**
  * Provides methods for managing Open Cloud Server resources such as users, files, assemblies,
  * jobs, projects, etc.
@@ -136,6 +137,63 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @returns Returns an object with updated server settings.
      */
     updateServerSettings(settings: any): Promise<any>;
+    /**
+     * 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?: number, limit?: number): Promise<{
+        result: OAuthClient[];
+        start: number;
+        limit: number;
+        allSize: number;
+        size: number;
+    }>;
+    /**
+     * 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: string): Promise<OAuthClient>;
+    /**
+     * 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: string, redirectUrl: string, description?: string): Promise<OAuthClient>;
+    /**
+     * 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: string): Promise<any>;
     /**
      * Returns the list of server users.
      *
@@ -200,10 +258,10 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * 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.
      */
     /**
@@ -221,10 +279,10 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @param sortField - Allows to specify sort field.
      */
     getFiles(start?: number, limit?: number, name?: string, ext?: string | string[], ids?: string | string[], sortByDesc?: boolean, sortField?: string): Promise<{
-        allSize: number;
+        result: File[];
         start: number;
         limit: number;
-        result: File[];
+        allSize: number;
         size: number;
     }>;
     /**
@@ -296,10 +354,10 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * 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.
      */
     /**
@@ -313,10 +371,10 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @param {boolean} sortField - Allows to specify sort field.
      */
     getJobs(status?: string | string[], limit?: number, start?: number, sortByDesc?: boolean, sortField?: string): Promise<{
-        allSize: number;
+        result: Job[];
         start: number;
         limit: number;
-        result: Job[];
+        allSize: number;
         size: number;
     }>;
     /**
@@ -356,10 +414,10 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * 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.
      */
     /**
@@ -375,10 +433,10 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @param sortField - Allows to specify sort field.
      */
     getAssemblies(start?: number, limit?: number, name?: string, ids?: string | string[], sortByDesc?: boolean, sortField?: string): Promise<{
-        allSize: number;
+        result: Assembly[];
         start: number;
         limit: number;
-        result: Assembly[];
+        allSize: number;
         size: number;
     }>;
     /**
@@ -423,10 +481,10 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * 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.
      */
     /**
@@ -440,10 +498,10 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      *   projects are sorted by name in ascending order.
      */
     getProjects(start?: number, limit?: number, name?: string, ids?: string | string[], sortByDesc?: boolean): Promise<{
-        allSize: number;
+        result: Project[];
         start: number;
         limit: number;
-        result: Project[];
+        allSize: number;
         size: number;
     }>;
     /**

package/lib/Api/OAuthClient.d.ts

@@ -0,0 +1,108 @@
+import { IHttpClient } from "./IHttpClient";
+/**
+ * Provides properties and methods for obtaining information about a OAuth 2.0 client that have
+ * access the Open Cloud Server API.
+ */
+export declare class OAuthClient {
+    private _data;
+    httpClient: IHttpClient;
+    /**
+     * @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: any, httpClient: IHttpClient);
+    private internalGet;
+    protected internalPost(relativePath: string, body?: BodyInit | object): Promise<Response>;
+    private internalPut;
+    private internalDelete;
+    /**
+     * OAuth 2.0 server authorization endpoint.
+     */
+    get authUrl(): string;
+    /**
+     * OAuth 2.0 server token endpoint.
+     */
+    get accessTokenUrl(): string;
+    /**
+     * Unique client ID.
+     *
+     * @readonly
+     */
+    get clientId(): string;
+    /**
+     * Client creation time (UTC) in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
+     */
+    get createdAt(): string;
+    /**
+     * Client application description.
+     */
+    get description(): string;
+    set description(value: string);
+    /**
+     * 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(): any;
+    set data(value: any);
+    /**
+     * Client application name.
+     */
+    get name(): string;
+    set name(value: string);
+    /**
+     * The endpoint to which the OAuth 2.0 server sends the response.
+     */
+    get redirectUrl(): string;
+    set redirectUrl(value: string);
+    /**
+     * Client secret.
+     *
+     * @readonly
+     */
+    get secret(): string;
+    /**
+     * Client last update time (UTC) in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
+     */
+    get updatedAt(): string;
+    /**
+     * Reloads clien data from the server.
+     */
+    checkout(): Promise<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}.
+     */
+    update(data: any): Promise<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(): Promise<any>;
+    /**
+     * 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(): Promise<this>;
+    /**
+     * Revokes the access tokens for all users of the client application.
+     */
+    revoke(): Promise<this>;
+}

package/lib/index.d.ts

@@ -12,6 +12,7 @@ export { IRoleActions } from "./Api/IRole";
 export { IShortUserDesc } from "./Api/IUser";
 export { Member } from "./Api/Member";
 export { Model } from "./Api/Model";
+export { OAuthClient } from "./Api/OAuthClient";
 export { Permission } from "./Api/Permission";
 export { Project } from "./Api/Project";
 export { Role } from "./Api/Role";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.10.0",
+  "version": "25.11.0",
   "description": "JavaScript REST API client for the Open Cloud Server",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -26,6 +26,6 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "~25.10.0"
+    "@inweb/eventemitter2": "~25.11.0"
   }
 }

package/src/Api/Client.ts

@@ -32,6 +32,7 @@ import { File } from "./File";
 import { Job } from "./Job";
 import { Project } from "./Project";
 import { User } from "./User";
+import { OAuthClient } from "./OAuthClient";
 import { parseArgs } from "./Utils";
 
 /**
@@ -278,6 +279,104 @@ export class Client extends EventEmitter2<ClientEventMap> {
     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?: number,
+    limit?: number
+  ): Promise<{
+    result: OAuthClient[];
+    start: number;
+    limit: number;
+    allSize: number;
+    size: number;
+  }> {
+    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: string): Promise<OAuthClient> {
+    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: string, redirectUrl: string, description?: string): Promise<OAuthClient> {
+    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: string): Promise<any> {
+    return this.httpClient.delete(`/oauth/clients/${clientId}`).then((response) => response.json());
+  }
+
   /**
    * Returns the list of server users.
    *
@@ -401,10 +500,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * 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.
    */
 
@@ -430,7 +529,13 @@ export class Client extends EventEmitter2<ClientEventMap> {
     ids?: string | string[],
     sortByDesc?: boolean,
     sortField?: string
-  ): Promise<{ allSize: number; start: number; limit: number; result: File[]; size: number }> {
+  ): Promise<{
+    result: File[];
+    start: number;
+    limit: number;
+    allSize: number;
+    size: number;
+  }> {
     const searchParams = new URLSearchParams();
     if (start > 0) searchParams.set("start", start.toString());
     if (limit > 0) searchParams.set("limit", limit.toString());
@@ -571,10 +676,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * 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.
    */
 
@@ -594,7 +699,13 @@ export class Client extends EventEmitter2<ClientEventMap> {
     start?: number,
     sortByDesc?: boolean,
     sortField?: string
-  ): Promise<{ allSize: number; start: number; limit: number; result: Job[]; size: number }> {
+  ): Promise<{
+    result: Job[];
+    start: number;
+    limit: number;
+    allSize: number;
+    size: number;
+  }> {
     const searchParams = new URLSearchParams();
     if (start > 0) searchParams.set("start", start.toString());
     if (limit > 0) searchParams.set("limit", limit.toString());
@@ -674,10 +785,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * 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.
    */
 
@@ -700,7 +811,13 @@ export class Client extends EventEmitter2<ClientEventMap> {
     ids?: string | string[],
     sortByDesc?: boolean,
     sortField?: string
-  ): Promise<{ allSize: number; start: number; limit: number; result: Assembly[]; size: number }> {
+  ): Promise<{
+    result: Assembly[];
+    start: number;
+    limit: number;
+    allSize: number;
+    size: number;
+  }> {
     const searchParams = new URLSearchParams();
     if (start > 0) searchParams.set("start", start.toString());
     if (limit > 0) searchParams.set("limit", limit.toString());
@@ -790,10 +907,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * 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.
    */
 
@@ -813,7 +930,13 @@ export class Client extends EventEmitter2<ClientEventMap> {
     name?: string,
     ids?: string | string[],
     sortByDesc?: boolean
-  ): Promise<{ allSize: number; start: number; limit: number; result: Project[]; size: number }> {
+  ): Promise<{
+    result: Project[];
+    start: number;
+    limit: number;
+    allSize: number;
+    size: number;
+  }> {
     const searchParams = new URLSearchParams();
     if (start > 0) searchParams.set("start", start.toString());
     if (limit > 0) searchParams.set("limit", limit.toString());