@inweb/client 25.12.0 → 26.1.0

package/src/Api/IHttpClient.ts

@@ -26,12 +26,12 @@
  */
 export interface IHttpClient {
   /**
-   * REST API server base URL.
+   * REST API server URL.
    */
   serverUrl: string;
 
   /**
-   * Request HTTP headers. You can add specific headers after user log in.
+   * Default HTTP headers for all requests. You can add specific headers at any time.
    *
    * The following headers are added automatically:
    *
@@ -51,91 +51,97 @@ export interface IHttpClient {
   signInUserIsAdmin: boolean;
 
   /**
-   * Sends the GET request to the specified endpoint.
+   * Sends the `GET` request to the specified endpoint.
    *
    * @param relativePath - Endpoint relative path.
-   * @param signal - An
-   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
-   *   signal, which can be used to abort waiting as desired.
+   * @param init - A set of options that can be used to configure a fetch request. See
+   *   {@link https://developer.mozilla.org/docs/Web/API/RequestInit | RequestInit} for more details.
    */
-  get(relativePath: string, signal?: AbortSignal): Promise<Response>;
+  get(relativePath: string, init?: RequestInit): Promise<Response>;
 
   /**
-   * Sends the POST request to the specified endpoint.
+   * Sends the `POST` request to the specified endpoint.
    *
    * @param relativePath - Endpoint relative path.
    * @param body - Request body. Can be
    *   {@link https://developer.mozilla.org/docs/Web/API/FormData | FormData},
    *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
    *   {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob}, JSON object or plain text.
+   * @param init - A set of options that can be used to configure a fetch request. See
+   *   {@link https://developer.mozilla.org/docs/Web/API/RequestInit | RequestInit} for more details.
    */
-  post(relativePath: string, body?: BodyInit | object): Promise<Response>;
+  post(relativePath: string, body?: BodyInit | object, init?: RequestInit): Promise<Response>;
 
   /**
-   * Sends the PUT request to the specified endpoint.
+   * Sends the `PUT` request to the specified endpoint.
    *
    * @param relativePath - Endpoint relative path.
    * @param body - Request body. Can be
    *   {@link https://developer.mozilla.org/docs/Web/API/FormData | FormData},
    *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
    *   {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob}, JSON object or plain text.
+   * @param init - A set of options that can be used to configure a fetch request. See
+   *   {@link https://developer.mozilla.org/docs/Web/API/RequestInit | RequestInit} for more details.
    */
-  put(relativePath: string, body?: BodyInit | object): Promise<Response>;
+  put(relativePath: string, body?: BodyInit | object, init?: RequestInit): Promise<Response>;
 
   /**
-   * Sends the DELETE request to the specified endpoint.
+   * Sends the `DELETE` request to the specified endpoint.
    *
    * @param relativePath - Endpoint relative path.
+   * @param init - A set of options that can be used to configure a fetch request. See
+   *   {@link https://developer.mozilla.org/docs/Web/API/RequestInit | RequestInit} for more details.
    */
-  delete(relativePath: string): Promise<Response>;
+  delete(relativePath: string, init?: RequestInit): Promise<Response>;
 
   /**
    * Upload a file to the server.
    *
-   * @param relativePath - File relative path.
+   * @param relativePath - Upload endpoint relative path.
    * @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.
+   * @param init - A set of options that can be used to configure a fetch request. See
+   *   {@link https://developer.mozilla.org/docs/Web/API/RequestInit | RequestInit} for more details.
    */
   uploadFile(
     relativePath: string,
     file: globalThis.File,
-    onProgress?: (progress: number) => void
+    onProgress?: (progress: number) => void,
+    init?: RequestInit
   ): Promise<XMLHttpRequest>;
 
   /**
    * Downloads the specified file from the server.
    *
-   * @param relativePath - File relative path.
+   * @param relativePath - Download endpoint relative path.
    * @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.
+   * @param init - A set of options that can be used to configure a fetch request. See
+   *   {@link https://developer.mozilla.org/docs/Web/API/RequestInit | RequestInit} for more details.
    */
   downloadFile(
     relativePath: string,
     onProgress?: (progress: number, chunk: Uint8Array) => void,
-    signal?: AbortSignal
+    init?: RequestInit
   ): Promise<Response>;
 
   /**
    * Downloads a part of file from the server.
    *
-   * @param relativePath - File relative path.
+   * @param relativePath - Download endpoint relative path.
    * @param reserved - Reserved, do not use.
-   * @param ranges - A range of resource file contents to download.
+   * @param ranges - A ranges of resource file contents to download.
    * @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.
+   * @param init - A set of options that can be used to configure a fetch request. See
+   *   {@link https://developer.mozilla.org/docs/Web/API/RequestInit | RequestInit} for more details.
    */
   downloadFileRange(
     relativePath: string,
     reserved: number,
     ranges: Array<{ begin: number; end: number; requestId: number }>,
     onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void,
-    signal?: AbortSignal
+    init?: RequestInit
   ): Promise<Response>;
 }

package/src/Api/ISharedLink.ts

@@ -0,0 +1,63 @@
+///////////////////////////////////////////////////////////////////////////////
+// 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.
+///////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Defines what actions are allowed to be performed on a file from shared link:
+ *
+ * - `read` - The ability to read file description, geometry data and properties.
+ * - `readSourceFile` - The ability to download source file.
+ * - `readViewpoint` - The ability to read file viewpoints.
+ */
+export type SharedLinkAction = "read" | "readSourceFile" | "readViewpoint";
+
+/**
+ * Defines the shared link permissions.
+ */
+export interface ISharedLinkPermissions {
+  /**
+   * Defines what actions are allowed to be performed on a file from shared link:
+   *
+   * - `read` - The ability to read file description, geometry data and properties.
+   * - `readSourceFile` - The ability to download source file.
+   * - `readViewpoint` - The ability to read file viewpoints.
+   *
+   * At least one action must be defined.
+   */
+  actions: SharedLinkAction[];
+
+  /**
+   * Password to get access to the file.
+   */
+  password?: string;
+
+  /**
+   * true if the shared link is password protected.
+   */
+  readonly passwordProtected?: string;
+
+  /**
+   * Link expiration time (UTC) in the format specified in
+   * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
+   */
+  expiresAt?: string;
+}

package/src/Api/Job.ts

@@ -22,14 +22,14 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
+import { Endpoint } from "./Endpoint";
 import { waitFor } from "./Utils";
 
 /**
  * Provides properties and methods for obtaining information about a job on the Open Cloud Server.
  */
-export class Job {
+export class Job extends Endpoint {
   private _data: any;
-  public httpClient: IHttpClient;
 
   /**
    * @param data - Raw job data received from the server. For more information, see
@@ -37,22 +37,10 @@ export class Job {
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, httpClient: IHttpClient) {
-    this.httpClient = httpClient;
+    super(`/jobs/${data.id}`, httpClient);
     this.data = data;
   }
 
-  protected internalGet(): Promise<Response> {
-    return this.httpClient.get(`/jobs/${this.data.id}`);
-  }
-
-  protected internalPut(body?: BodyInit | object): Promise<Response> {
-    return this.httpClient.put(`/jobs/${this.data.id}`, body);
-  }
-
-  protected internalDelete(): Promise<Response> {
-    return this.httpClient.delete(`/jobs/${this.data.id}`);
-  }
-
   /**
    * The ID of the assembly the job is working on (internal).
    *
@@ -184,7 +172,7 @@ export class Job {
    * Reloads job data from the server.
    */
   async checkout(): Promise<this> {
-    const response = await this.internalGet();
+    const response = await this.get("");
     this.data = await response.json();
     return this;
   }
@@ -199,7 +187,7 @@ export class Job {
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
    */
   async update(data: any): Promise<this> {
-    const response = await this.internalPut(data);
+    const response = await this.put("", data);
     this.data = await response.json();
     return this;
   }
@@ -211,8 +199,8 @@ export class Job {
    * @returns Returns the raw data of a deleted job. For more information, see
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
    */
-  delete(): Promise<any> {
-    return this.internalDelete().then((response) => response.json());
+  override delete(): Promise<any> {
+    return super.delete("").then((response) => response.json());
   }
 
   // /**

package/src/Api/Member.ts

@@ -22,6 +22,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
+import { Endpoint } from "./Endpoint";
 import { IShortUserDesc } from "./IUser";
 import { userFullName, userInitials } from "./Utils";
 
@@ -29,10 +30,8 @@ import { userFullName, userInitials } from "./Utils";
  * Provides properties and methods for obtaining information about a {@link User | user} who has
  * access to the {@link Project | project}.
  */
-export class Member {
+export class Member extends Endpoint {
   private _data: any;
-  public projectId: string;
-  public httpClient: IHttpClient;
 
   /**
    * @param data - Raw member data received from the server. For more information, see
@@ -41,23 +40,10 @@ export class Member {
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, projectId: string, httpClient: IHttpClient) {
-    this.httpClient = httpClient;
-    this.projectId = projectId;
+    super(`/projects/${projectId}/members/${data.id}`, httpClient);
     this.data = data;
   }
 
-  private internalGet(): Promise<Response> {
-    return this.httpClient.get(`/projects/${this.projectId}/members/${this.id}`);
-  }
-
-  private internalPut(body?: BodyInit | object): Promise<Response> {
-    return this.httpClient.put(`/projects/${this.projectId}/members/${this.id}`, body);
-  }
-
-  private internalDelete(): Promise<Response> {
-    return this.httpClient.delete(`/projects/${this.projectId}/members/${this.id}`);
-  }
-
   /**
    * Raw member data received from the server. For more information, see
    * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
@@ -118,7 +104,7 @@ export class Member {
    * Reloads member data from the server.
    */
   async checkout(): Promise<this> {
-    const response = await this.internalGet();
+    const response = await this.get("");
     this.data = await response.json();
     return this;
   }
@@ -130,7 +116,7 @@ export class Member {
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    */
   async update(data: any): Promise<this> {
-    const response = await this.internalPut(data);
+    const response = await this.put("", data);
     this.data = await response.json();
     return this;
   }
@@ -141,8 +127,8 @@ export class Member {
    * @returns Returns the raw data of a deleted member. For more information, see
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    */
-  delete(): Promise<any> {
-    return this.internalDelete().then((response) => response.json());
+  override delete(): Promise<any> {
+    return super.delete("").then((response) => response.json());
   }
 
   /**

package/src/Api/Model.ts

@@ -21,7 +21,7 @@
 // acknowledge and accept the above terms.
 ///////////////////////////////////////////////////////////////////////////////
 
-import { IHttpClient } from "./IHttpClient";
+import { Endpoint } from "./Endpoint";
 import type { File } from "./File";
 import type { Assembly } from "./Assembly";
 import type { IFileReferences } from "./IFile";
@@ -32,21 +32,18 @@ import type { IModelTransformMatrix } from "./IAssembly";
  * {@link Assembly| assembly}. For example, for `dwg` it is a `Model` space or layout, and for
  * `rvt` files it is a `3D` view.
  */
-export class Model {
+export class Model extends Endpoint {
   private _data: any;
   private _file: File | Assembly;
-  public httpClient: IHttpClient;
-  public path: string;
 
   /**
    * @param data - Raw model data received from the server.
    * @param file - The file/assembly instance that owns the model.
    */
   constructor(data: any, file: File | Assembly) {
-    this.path = `${file.path}/downloads`;
-    this.httpClient = file.httpClient;
-    this._file = file;
+    super(`${file.path}/downloads`, file.httpClient);
     this._data = data;
+    this._file = file;
   }
 
   /**

package/src/Api/OAuthClient.ts

@@ -22,14 +22,14 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
+import { Endpoint } from "./Endpoint";
 
 /**
  * Provides properties and methods for obtaining information about a OAuth 2.0 client that have
  * access the Open Cloud Server API.
  */
-export class OAuthClient {
+export class OAuthClient extends Endpoint {
   private _data: any;
-  public httpClient: IHttpClient;
 
   /**
    * @param data - Raw client data received from the server. For more information, see
@@ -37,26 +37,10 @@ export class OAuthClient {
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, httpClient: IHttpClient) {
-    this.httpClient = httpClient;
+    super(`/oauth/clients/${data.clientId}`, httpClient);
     this.data = data;
   }
 
-  private internalGet(): Promise<Response> {
-    return this.httpClient.get(`/oauth/clients/${this.clientId}`);
-  }
-
-  protected internalPost(relativePath: string, body?: BodyInit | object): Promise<Response> {
-    return this.httpClient.post(`/oauth/clients/${this.clientId}${relativePath}`, body);
-  }
-
-  private internalPut(body?: BodyInit | object): Promise<Response> {
-    return this.httpClient.put(`/oauth/clients/${this.clientId}`, body);
-  }
-
-  private internalDelete(): Promise<Response> {
-    return this.httpClient.delete(`/oauth/clients/${this.clientId}`);
-  }
-
   /**
    * OAuth 2.0 server authorization endpoint.
    */
@@ -156,7 +140,7 @@ export class OAuthClient {
    * Reloads clien data from the server.
    */
   async checkout(): Promise<this> {
-    const response = await this.internalGet();
+    const response = await this.get("");
     this.data = await response.json();
     return this;
   }
@@ -171,7 +155,7 @@ export class OAuthClient {
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#OAuthClient | Open Cloud OAuth Clients API}.
    */
   async update(data: any): Promise<this> {
-    const response = await this.internalPut(data);
+    const response = await this.put("", data);
     this.data = await response.json();
     return this;
   }
@@ -185,8 +169,8 @@ export class OAuthClient {
    * @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> {
-    return this.internalDelete().then((response) => response.json());
+  override delete(): Promise<any> {
+    return super.delete("").then((response) => response.json());
   }
 
   /**
@@ -204,7 +188,7 @@ export class OAuthClient {
    * Revokes the access tokens for all users of the client application.
    */
   async revoke(): Promise<this> {
-    await this.internalPost("/revoke");
+    await this.post("/revoke");
     return this;
   }
 }

package/src/Api/Permission.ts

@@ -22,16 +22,15 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
+import { Endpoint } from "./Endpoint";
 import { IGrantedTo } from "./IFile";
 
 /**
  * Provides properties and methods for obtaining information about {@link File | file} actions
  * granted to a specific user, project, or group.
  */
-export class Permission {
+export class Permission extends Endpoint {
   private _data: any;
-  public fileId: string;
-  public httpClient: IHttpClient;
 
   /**
    * @param data - Raw permission data received from the server. For more information, see
@@ -40,28 +39,15 @@ export class Permission {
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, fileId: string, httpClient: IHttpClient) {
-    this.httpClient = httpClient;
-    this.fileId = fileId;
+    super(`/files/${fileId}/permissions/${data.id}`, httpClient);
     this.data = data;
   }
 
-  private internalGet(): Promise<Response> {
-    return this.httpClient.get(`/files/${this.fileId}/permissions/${this.id}`);
-  }
-
-  private internalPut(body?: BodyInit | object): Promise<Response> {
-    return this.httpClient.put(`/files/${this.fileId}/permissions/${this.id}`, body);
-  }
-
-  private internalDelete(): Promise<Response> {
-    return this.httpClient.delete(`/files/${this.fileId}/permissions/${this.id}`);
-  }
-
   /**
    * Defines what actions are allowed to be performed on a file with this permission:
    *
    * - `read` - The ability to read file description, geometry data and properties.
-   * - `readSourceFile` - The ability to read source file.
+   * - `readSourceFile` - The ability to download source file.
    * - `write` - The ability to modify file name, description and references.
    * - `readViewpoint` - The ability to read file viewpoints.
    * - `createViewpoint` - The ability to create file viewpoints.
@@ -137,7 +123,7 @@ export class Permission {
    * Reloads permission data from the server.
    */
   async checkout(): Promise<this> {
-    const response = await this.internalGet();
+    const response = await this.get("");
     this.data = await response.json();
     return this;
   }
@@ -149,7 +135,7 @@ export class Permission {
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Permission | Open Cloud Permissions API}.
    */
   async update(data: any): Promise<this> {
-    const response = await this.internalPut(data);
+    const response = await this.put("", data);
     this.data = await response.json();
     return this;
   }
@@ -160,8 +146,8 @@ export class Permission {
    * @returns Returns the raw data of a deleted permission. For more information, see
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Permission | Open Cloud Permissions API}.
    */
-  delete(): Promise<any> {
-    return this.internalDelete().then((response) => response.json());
+  override delete(): Promise<any> {
+    return super.delete("").then((response) => response.json());
   }
 
   /**