@inweb/client 25.12.0 → 26.1.0

package/lib/Api/Permission.d.ts

@@ -1,13 +1,12 @@
 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 declare class Permission {
+export declare class Permission extends Endpoint {
     private _data;
-    fileId: string;
-    httpClient: IHttpClient;
     /**
      * @param data - Raw permission data received from the server. For more information, see
      *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Permission | Open Cloud Permissions API}.
@@ -15,14 +14,11 @@ export declare class Permission {
      * @param httpClient - HTTP client instance used to send requests to the REST API server.
      */
     constructor(data: any, fileId: string, httpClient: IHttpClient);
-    private internalGet;
-    private internalPut;
-    private internalDelete;
     /**
      * 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.

package/lib/Api/Project.d.ts

@@ -1,4 +1,5 @@
 import { IHttpClient } from "./IHttpClient";
+import { Endpoint } from "./Endpoint";
 import { IShortUserDesc } from "./IUser";
 import { Role } from "./Role";
 import { IRoleActions } from "./IRole";
@@ -8,19 +9,14 @@ import { File } from "./File";
  * Provides properties and methods for obtaining information about a project on the Open Cloud
  * Server and managing its {@link Role | roles}, {@link Member | members} and models.
  */
-export declare class Project {
+export declare class Project extends Endpoint {
     private _data;
-    httpClient: IHttpClient;
     /**
      * @param data - Raw project data received from the server. For more information, see
      *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
      * @param httpClient - HTTP client instance used to send requests to the REST API server.
      */
     constructor(data: any, httpClient: IHttpClient);
-    protected internalGet(relativePath: string): Promise<Response>;
-    protected internalPost(relativePath: string, body?: BodyInit | object): Promise<Response>;
-    protected internalPut(relativePath: string, body?: BodyInit | object): Promise<Response>;
-    protected internalDelete(relativePath: string): Promise<Response>;
     /**
      * Project features the user has access to.
      *
@@ -252,7 +248,7 @@ export declare class Project {
      * @param actions - Actions are allowed to be performed on a file:
      *
      *   - `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.

package/lib/Api/Role.d.ts

@@ -1,13 +1,13 @@
 import { IHttpClient } from "./IHttpClient";
+import { Endpoint } from "./Endpoint";
 import { IRoleActions } from "./IRole";
 /**
  * A role determines what actions allowed to be performed by {@link User | users} on a
  * {@link Project | project}.
  */
-export declare class Role {
+export declare class Role extends Endpoint {
     private _data;
     projectId: string;
-    httpClient: IHttpClient;
     /**
      * @param data - Raw role data received from the server. For more information, see
      *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
@@ -15,9 +15,6 @@ export declare class Role {
      * @param httpClient - HTTP client instance used to send requests to the REST API server.
      */
     constructor(data: any, projectId: string, httpClient: IHttpClient);
-    private internalGet;
-    private internalPut;
-    private internalDelete;
     /**
      * Role description.
      */

package/lib/Api/SharedFile.d.ts

@@ -0,0 +1,9 @@
+import { IHttpClient } from "./IHttpClient";
+import { File } from "./File";
+export declare class SharedFile extends File {
+    constructor(data: any, password: string, httpClient: IHttpClient);
+    checkout(): Promise<this>;
+    update(data: any): Promise<this>;
+    getVersions(): Promise<undefined>;
+    useVersion(version?: number): this;
+}

package/lib/Api/SharedLink.d.ts

@@ -0,0 +1,70 @@
+import { IHttpClient } from "./IHttpClient";
+import { Endpoint } from "./Endpoint";
+import { ISharedLinkPermissions } from "./ISharedLink";
+/**
+ * Provides properties and methods for obtaining information about a file shared link.
+ */
+export declare class SharedLink extends Endpoint {
+    private _data;
+    /**
+     * @param data - Raw shared link data received from the server. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#ShareLinks | Open Cloud SharedLinks API}.
+     * @param httpClient - HTTP client instance used to send requests to the REST API server.
+     */
+    constructor(data: any, httpClient: IHttpClient);
+    /**
+     * Shared link creation time (UTC) in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
+     *
+     * @readonly
+     */
+    get createdAt(): string;
+    /**
+     * Raw shared link data received from the server. For more information, see
+     * {@link https://cloud.opendesign.com/docs//pages/server/api.html#ShareLinks | Open Cloud SharedLinks API}.
+     *
+     * @readonly
+     */
+    get data(): any;
+    private set data(value);
+    /**
+     * Share permissions.
+     */
+    get permissions(): ISharedLinkPermissions;
+    set permissions(value: ISharedLinkPermissions);
+    /**
+     * Unique shared link token.
+     *
+     * @readonly
+     */
+    get token(): string;
+    /**
+     * URL to open shared file in the viewer.
+     *
+     * @readonly
+     */
+    get url(): string;
+    /**
+     * Reloads shared link data from the server.
+     */
+    checkout(): Promise<this>;
+    /**
+     * Updates shared link data on the server.
+     *
+     * @param data - Raw shared link data. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#ShareLinks | Open Cloud SharedLinks API}.
+     */
+    update(data: any): Promise<this>;
+    /**
+     * Deletes a shared link from the server.
+     *
+     * @returns Returns the raw data of a deleted shared link. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#SharedLinks | Open Cloud SharedLinks API}.
+     */
+    delete(): Promise<any>;
+    /**
+     * Saves shared link properties changes to the server. Call this method to update shared link
+     * data on the server after any property changes.
+     */
+    save(): Promise<this>;
+}

package/lib/Api/User.d.ts

@@ -1,11 +1,11 @@
 import { IHttpClient } from "./IHttpClient";
+import { Endpoint } from "./Endpoint";
 /**
  * Provides properties and methods for obtaining information about a Open Cloud Server user and
  * manage its data.
  */
-export declare class User {
+export declare class User extends Endpoint {
     private _data;
-    httpClient: IHttpClient;
     /**
      * @param data - Raw user data received from the server. For more information, see
      *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Users | Open Cloud Users API}.

package/lib/Api/XMLHttp.d.ts

@@ -1,5 +1,5 @@
 export declare function $xmlhttp(url: string, params?: {
-    method: "GET" | "POST" | "PUT" | "DELETE";
+    method: "GET" | "POST" | "PUT" | "DELETE" | "HEAD";
     headers?: HeadersInit;
     body?: XMLHttpRequestBodyInit;
     uploadProgress?: (progress: number) => void;

package/lib/index.d.ts

@@ -7,15 +7,19 @@ export { FetchError, statusText } from "./Api/FetchError";
 export { Job } from "./Api/Job";
 export { IHttpClient } from "./Api/IHttpClient";
 export { IAssociatedFileData, IClashItem, IModelTransformMatrix } from "./Api/IAssembly";
-export { ICdaNode, IFileDataStatus, IFileReference, IFileReferences, IFileStatus, IFileVersionInfo, IGrantedTo, } from "./Api/IFile";
+export * from "./Api/IFile";
 export { IRoleActions } from "./Api/IRole";
+export * from "./Api/ISharedLink";
 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 * from "./Api/Endpoint";
 export { Role } from "./Api/Role";
+export * from "./Api/SharedLink";
+export * from "./Api/SharedFile";
 export { User } from "./Api/User";
 export { parseArgs, userFullName, userInitials, waitFor } from "./Api/Utils";
 export declare const version = "CLIENT_JS_VERSION";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.12.0",
+  "version": "26.1.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.12.0"
+    "@inweb/eventemitter2": "~26.1.0"
   }
 }

package/src/Api/Assembly.ts

@@ -22,23 +22,23 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
+import { Endpoint } from "./Endpoint";
 import { FetchError } from "./FetchError";
 import { ICdaNode, IFileReferences } from "./IFile";
 import { IAssociatedFileData, IAssemblyVersionInfo, IModelTransformMatrix } from "./IAssembly";
 import { IShortUserDesc } from "./IUser";
 import { Model } from "./Model";
 import { ClashTest } from "./ClashTest";
+import { ISharedLinkPermissions } from "./ISharedLink";
+import { SharedLink } from "./SharedLink";
 import { waitFor, userFullName, userInitials } from "./Utils";
 
 /**
  * Provides properties and methods for obtaining information about an assembly on the Open
  * Cloud Server and managing its data.
  */
-export class Assembly {
+export class Assembly extends Endpoint {
   private _data: any;
-  private _useVersion: number | undefined;
-  public httpClient: IHttpClient;
-  public path: string;
 
   /**
    * @param data - Raw assembly data received from the server. For more information, see
@@ -46,37 +46,10 @@ export class Assembly {
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, httpClient: IHttpClient) {
-    this.path = `/assemblies/${data.id}`;
-    this.httpClient = httpClient;
+    super(`/assemblies/${data.id}`, httpClient);
     this.data = data;
   }
 
-  public appendVersionParam(relativePath: string): string {
-    if (this._useVersion === undefined) return relativePath;
-    const delimiter = relativePath.includes("?") ? "&" : "?";
-    return `${relativePath}${delimiter}version=${this._useVersion}`;
-  }
-
-  protected internalGet(relativePath: string, signal?: AbortSignal): Promise<Response> {
-    relativePath = this.appendVersionParam(relativePath);
-    return this.httpClient.get(`${this.path}${relativePath}`, signal);
-  }
-
-  protected internalPost(relativePath: string, body?: BodyInit | object): Promise<Response> {
-    relativePath = this.appendVersionParam(relativePath);
-    return this.httpClient.post(`${this.path}${relativePath}`, body);
-  }
-
-  protected internalPut(relativePath: string, body?: BodyInit | object): Promise<Response> {
-    relativePath = this.appendVersionParam(relativePath);
-    return this.httpClient.put(`${this.path}${relativePath}`, body);
-  }
-
-  protected internalDelete(relativePath: string): Promise<Response> {
-    relativePath = this.appendVersionParam(relativePath);
-    return this.httpClient.delete(`${this.path}${relativePath}`);
-  }
-
   // Reserved for future use
 
   get activeVersion(): number {
@@ -224,7 +197,7 @@ export class Assembly {
    * Reloads assembly 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;
   }
@@ -236,7 +209,7 @@ export class Assembly {
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies 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;
   }
@@ -247,8 +220,8 @@ export class Assembly {
    * @returns Returns the raw data of a deleted assembly. For more information, see
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies API}.
    */
-  delete(): Promise<any> {
-    return this.internalDelete("").then((response) => response.json());
+  override delete(): Promise<any> {
+    return super.delete("").then((response) => response.json());
   }
 
   /**
@@ -275,7 +248,7 @@ export class Assembly {
    * Returns list of assembly models.
    */
   getModels(): Promise<Model[]> {
-    return this.internalGet("/geometry")
+    return this.get("/geometry")
       .then((response) => response.json())
       .then((array) => array.map((data: any) => new Model(data, this)));
   }
@@ -317,7 +290,7 @@ export class Assembly {
    */
   getProperties(handles?: string | string[]): Promise<any[]> {
     const relativePath = handles !== undefined ? `/properties?handles=${handles}` : "/properties";
-    return this.internalGet(relativePath).then((response) => response.json());
+    return this.get(relativePath).then((response) => response.json());
   }
 
   /**
@@ -346,14 +319,14 @@ export class Assembly {
    * @param searchPattern - Search pattern or combination of the patterns, see example below.
    */
   searchProperties(searchPattern: any): Promise<any[]> {
-    return this.internalPost("/properties/search", searchPattern).then((response) => response.json());
+    return this.post("/properties/search", searchPattern).then((response) => response.json());
   }
 
   /**
    * Returns the CDA tree for an assembly.
    */
   getCdaTree(): Promise<ICdaNode[]> {
-    return this.internalGet(`/properties/tree`).then((response) => response.json());
+    return this.get(`/properties/tree`).then((response) => response.json());
   }
 
   /**
@@ -361,7 +334,7 @@ export class Assembly {
    * {@link https://cloud.opendesign.com/docs//pages/server/api.html#AssemblyViewpoints | Open Cloud Assembly Viewpoints API}.
    */
   getViewpoints(): Promise<any[]> {
-    return this.internalGet("/viewpoints")
+    return this.get("/viewpoints")
       .then((response) => response.json())
       .then((viewpoints) => viewpoints.result);
   }
@@ -373,7 +346,7 @@ export class Assembly {
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#AssemblyViewpoints | Open Cloud Assembly Viewpoints API}.
    */
   saveViewpoint(viewpoint: any): Promise<any> {
-    return this.internalPost("/viewpoints", viewpoint).then((response) => response.json());
+    return this.post("/viewpoints", viewpoint).then((response) => response.json());
   }
 
   /**
@@ -384,7 +357,7 @@ export class Assembly {
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#AssemblyViewpoints | Open Cloud Assembly Viewpoints API}.
    */
   deleteViewpoint(guid: string): Promise<any> {
-    return this.internalDelete(`/viewpoints/${guid}`).then((response) => response.json());
+    return super.delete(`/viewpoints/${guid}`).then((response) => response.json());
   }
 
   /**
@@ -394,7 +367,7 @@ export class Assembly {
    * @param guid - Viewpoint GUID.
    */
   getSnapshot(guid: string): Promise<string> {
-    return this.internalGet(`/viewpoints/${guid}/snapshot`).then((response) => response.text());
+    return this.get(`/viewpoints/${guid}/snapshot`).then((response) => response.text());
   }
 
   /**
@@ -404,7 +377,7 @@ export class Assembly {
    * @param bitmapGuid - Bitmap GUID.
    */
   getSnapshotData(guid: string, bitmapGuid: string): Promise<string> {
-    return this.internalGet(`/viewpoints/${guid}/bitmaps/${bitmapGuid}`).then((response) => response.text());
+    return this.get(`/viewpoints/${guid}/bitmaps/${bitmapGuid}`).then((response) => response.text());
   }
 
   /**
@@ -422,9 +395,8 @@ export class Assembly {
     onProgress?: (progress: number, chunk: Uint8Array) => void,
     signal?: AbortSignal
   ): Promise<ArrayBuffer> {
-    const relativePath = this.appendVersionParam(`/downloads/${dataId}`);
     return this.httpClient
-      .downloadFile(`${this.path}${relativePath}`, onProgress, signal)
+      .downloadFile(this.getEndpointPath(`/downloads/${dataId}`), onProgress, { signal, headers: this.headers })
       .then((response) => response.arrayBuffer());
   }
 
@@ -447,9 +419,14 @@ export class Assembly {
     onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void,
     signal?: AbortSignal
   ): Promise<ArrayBuffer> {
-    const relativePath = this.appendVersionParam(`/downloads/${dataId}?requestId=${requestId}`);
     return this.httpClient
-      .downloadFileRange(`${this.path}${relativePath}`, requestId, ranges, onProgress, signal)
+      .downloadFileRange(
+        this.getEndpointPath(`/downloads/${dataId}?requestId=${requestId}`),
+        requestId,
+        ranges,
+        onProgress,
+        { signal, headers: this.headers }
+      )
       .then((response) => response.arrayBuffer());
   }
 
@@ -493,10 +470,11 @@ export class Assembly {
    *   signal, which can be used to abort waiting as desired.
    */
   async getReferences(signal?: AbortSignal): Promise<IFileReferences> {
+    const files = new Endpoint("/files", this.httpClient, this.headers);
     const references = await Promise.all(
       this.associatedFiles
-        .map((file) => `/files/${file.fileId}/references`)
-        .map((link) => this.httpClient.get(link, signal).then((response) => response.json()))
+        .map((file) => `/${file.fileId}/references`)
+        .map((link) => files.get(link, signal).then((response) => response.json()))
     )
       .then((references) => references.map((x) => x.references))
       .then((references) => references.reduce((x, v) => [...v, ...x], []))
@@ -567,7 +545,7 @@ export class Assembly {
     let queryString = searchParams.toString();
     if (queryString) queryString = "?" + queryString;
 
-    return this.internalGet(`/clashes${queryString}`)
+    return this.get(`/clashes${queryString}`)
       .then((response) => response.json())
       .then((tests) => {
         return {
@@ -583,7 +561,7 @@ export class Assembly {
    * @param testId - Test ID.
    */
   getClashTest(testId: string): Promise<ClashTest> {
-    return this.internalGet(`/clashes/${testId}`)
+    return this.get(`/clashes/${testId}`)
       .then((response) => response.json())
       .then((data) => new ClashTest(data, this.path, this.httpClient));
   }
@@ -650,7 +628,7 @@ export class Assembly {
     if (!Array.isArray(selectionSetA)) selectionSetA = [selectionSetA];
     if (!Array.isArray(selectionSetB)) selectionSetB = [selectionSetB];
 
-    return this.internalPost("/clashes", {
+    return this.post("/clashes", {
       name,
       selectionTypeA,
       selectionTypeB,
@@ -672,7 +650,7 @@ export class Assembly {
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies API}.
    */
   deleteClashTest(testId: string): Promise<any> {
-    return this.internalDelete(`/clashes/${testId}`).then((response) => response.json());
+    return super.delete(`/clashes/${testId}`).then((response) => response.json());
   }
 
   // Reserved for future use
@@ -708,8 +686,17 @@ export class Assembly {
     return this.update({ activeVersion: version });
   }
 
-  useVersion(version?: number): this {
-    this._useVersion = undefined;
-    return this;
+  // Reserved for future use
+
+  async createSharedLink(permissions?: ISharedLinkPermissions): Promise<SharedLink> {
+    return Promise.reject(new Error("Assembly shared link will be implemeted in a future release"));
+  }
+
+  async getSharedLink(): Promise<SharedLink> {
+    return Promise.resolve(undefined);
+  }
+
+  async deleteSharedLink(): Promise<any> {
+    return Promise.reject(new FetchError(404));
   }
 }

package/src/Api/ClashTest.ts

@@ -22,6 +22,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
+import { Endpoint } from "./Endpoint";
 import { IClashItem } from "./IAssembly";
 import { IShortUserDesc } from "./IUser";
 import { waitFor, userFullName, userInitials } from "./Utils";
@@ -29,35 +30,20 @@ import { waitFor, userFullName, userInitials } from "./Utils";
 /**
  * Provides properties and methods for obtaining information about a file/assembly clash detection test.
  */
-export class ClashTest {
+export class ClashTest extends Endpoint {
   private _data: any;
-  public basePath: string;
-  public httpClient: IHttpClient;
 
   /**
    * @param data - Raw test data received from the server. For more information, see
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies API}.
-   * @param basePath - The clash test API base path of the file/assembly that owns the test.
+   * @param path - The clash test API path of the file/assembly that owns the test.
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
-  constructor(data: any, basePath: string, httpClient: IHttpClient) {
-    this.httpClient = httpClient;
-    this.basePath = basePath;
+  constructor(data: any, path: string, httpClient: IHttpClient) {
+    super(`${path}/clashes/${data.id}`, httpClient);
     this.data = data;
   }
 
-  protected internalGet(relativePath: string): Promise<Response> {
-    return this.httpClient.get(`${this.basePath}/clashes/${this.id}${relativePath}`);
-  }
-
-  protected internalPut(relativePath: string, body?: BodyInit | object): Promise<Response> {
-    return this.httpClient.put(`${this.basePath}/clashes/${this.id}${relativePath}`, body);
-  }
-
-  protected internalDelete(relativePath: string): Promise<Response> {
-    return this.httpClient.delete(`${this.basePath}/clashes/${this.id}${relativePath}`);
-  }
-
   /**
    * The type of the clashes that the test detects:
    *
@@ -208,7 +194,7 @@ export class ClashTest {
    * Reloads test 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;
   }
@@ -220,7 +206,7 @@ export class ClashTest {
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies 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;
   }
@@ -231,8 +217,8 @@ export class ClashTest {
    * @returns Returns the raw data of a deleted test. For more information, see
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies API}.
    */
-  delete(): Promise<any> {
-    return this.internalDelete("").then((response) => response.json());
+  override delete(): Promise<any> {
+    return super.delete("").then((response) => response.json());
   }
 
   /**
@@ -275,6 +261,6 @@ export class ClashTest {
    * Returns a list of detected clashes for this test.
    */
   getReport(): Promise<IClashItem[]> {
-    return this.internalGet("/report").then((response) => response.json());
+    return this.get("/report").then((response) => response.json());
   }
 }