@inweb/client 25.12.0 → 26.1.0

package/src/Api/Project.ts

@@ -22,6 +22,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
+import { Endpoint } from "./Endpoint";
 import { IShortUserDesc } from "./IUser";
 import { Role } from "./Role";
 import { IRoleActions } from "./IRole";
@@ -33,9 +34,8 @@ import { userFullName, userInitials } from "./Utils";
  * 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 class Project {
+export class Project extends Endpoint {
   private _data: any;
-  public httpClient: IHttpClient;
 
   /**
    * @param data - Raw project data received from the server. For more information, see
@@ -43,26 +43,10 @@ export class Project {
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, httpClient: IHttpClient) {
-    this.httpClient = httpClient;
+    super(`/projects/${data.id}`, httpClient);
     this.data = data;
   }
 
-  protected internalGet(relativePath: string): Promise<Response> {
-    return this.httpClient.get(`/projects/${this.id}${relativePath}`);
-  }
-
-  protected internalPost(relativePath: string, body?: BodyInit | object): Promise<Response> {
-    return this.httpClient.post(`/projects/${this.id}${relativePath}`, body);
-  }
-
-  protected internalPut(relativePath: string, body?: BodyInit | object): Promise<Response> {
-    return this.httpClient.put(`/projects/${this.id}${relativePath}`, body);
-  }
-
-  protected internalDelete(relativePath: string): Promise<Response> {
-    return this.httpClient.delete(`/projects/${this.id}${relativePath}`);
-  }
-
   /**
    * Project features the user has access to.
    *
@@ -248,7 +232,7 @@ export class Project {
    * Reloads project 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;
   }
@@ -260,7 +244,7 @@ export class Project {
    *   {@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;
   }
@@ -271,8 +255,9 @@ export class Project {
    * @returns Returns the raw data of a deleted project. 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("")
+  override delete(): Promise<any> {
+    return super
+      .delete("")
       .then((response) => response.text())
       .then((text) => {
         // TODO fix for server 23.5 and below
@@ -308,7 +293,7 @@ export class Project {
     if (!image) {
       await this.deletePreview();
     } else {
-      const response = await this.internalPost("/preview", image);
+      const response = await this.post("/preview", image);
       this.data = await response.json();
     }
     return this;
@@ -318,7 +303,7 @@ export class Project {
    * Removes the project preview.
    */
   async deletePreview(): Promise<this> {
-    const response = await this.internalDelete("/preview");
+    const response = await super.delete("/preview");
     this.data = await response.json();
     return this;
   }
@@ -328,7 +313,7 @@ export class Project {
    * role they have in a project.
    */
   getRoles(): Promise<Role[]> {
-    return this.internalGet("/roles")
+    return this.get("/roles")
       .then((response) => response.json())
       .then((array) => array.map((data) => new Role(data, this.id, this.httpClient)));
   }
@@ -339,7 +324,7 @@ export class Project {
    * @param name - Role name.
    */
   getRole(name: string): Promise<Role> {
-    return this.internalGet(`/roles/${name}`)
+    return this.get(`/roles/${name}`)
       .then((response) => response.json())
       .then((data) => new Role(data, this.id, this.httpClient));
   }
@@ -352,7 +337,7 @@ export class Project {
    * @param permissions - Actions are allowed to be performed for the role.
    */
   createRole(name: string, description: string, permissions: IRoleActions): Promise<Role> {
-    return this.internalPost("/roles", {
+    return this.post("/roles", {
       name,
       description,
       permissions: permissions || {},
@@ -369,14 +354,14 @@ export class Project {
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    */
   deleteRole(name: string): Promise<any> {
-    return this.internalDelete(`/roles/${name}`).then((response) => response.json());
+    return super.delete(`/roles/${name}`).then((response) => response.json());
   }
 
   /**
    * Returns a list of project members.
    */
   getMembers(): Promise<Member[]> {
-    return this.internalGet("/members")
+    return this.get("/members")
       .then((response) => response.json())
       .then((array) => array.map((data) => new Member(data, this.id, this.httpClient)));
   }
@@ -387,7 +372,7 @@ export class Project {
    * @param memberId - Member ID.
    */
   getMember(memberId: string): Promise<Member> {
-    return this.internalGet(`/members/${memberId}`)
+    return this.get(`/members/${memberId}`)
       .then((response) => response.json())
       .then((data) => new Member(data, this.id, this.httpClient));
   }
@@ -399,7 +384,7 @@ export class Project {
    * @param role - Role name from the list of project {@link getRoles | roles}.
    */
   addMember(userId: string, role: string): Promise<Member> {
-    return this.internalPost("/members", { userId, role })
+    return this.post("/members", { userId, role })
       .then((response) => response.json())
       .then((data) => new Member(data, this.id, this.httpClient));
   }
@@ -412,7 +397,7 @@ export class Project {
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    */
   removeMember(memberId: string): Promise<any> {
-    return this.internalDelete(`/members/${memberId}`).then((response) => response.json());
+    return super.delete(`/members/${memberId}`).then((response) => response.json());
   }
 
   /**
@@ -437,8 +422,9 @@ export class Project {
    * {@link File.createPermission | File.createPermission()}.
    */
   getFilesInformation(): Promise<any[]> {
-    return this.httpClient
-      .get(`/bcf/3.0/projects/${this.data.id}/files_information`)
+    const bcfProjects = new Endpoint("/bcf/3.0/projects", this.httpClient, this.headers);
+    return bcfProjects
+      .get(`/${this.id}/files_information`)
       .then((response) => response.json())
       .then((items) => {
         items.forEach((item) => {
@@ -496,9 +482,8 @@ export class Project {
     return this.getFilesInformation()
       .then((filesInformation) => filesInformation.map((item) => item.file.reference))
       .then((ids) => {
-        const searchParams = new URLSearchParams();
-        searchParams.set("id", ids.join("|"));
-        return this.httpClient.get(`/files?${searchParams.toString()}`);
+        const files = new Endpoint("/files", this.httpClient, this.headers);
+        return files.get(`?id=${ids.join("|")}`);
       })
       .then((response) => response.json())
       .then((files) => files.result.map((data) => new File(data, this.httpClient)));
@@ -513,7 +498,7 @@ export 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.
@@ -522,8 +507,9 @@ export class Project {
    * @returns Returns a file instance added to the project.
    */
   async addModel(fileId: string, actions: string | string[], _public: boolean): Promise<File> {
-    const file = await this.httpClient
-      .get(`/files/${fileId}`)
+    const files = new Endpoint("/files", this.httpClient, this.headers);
+    const file = await files
+      .get(`/${fileId}`)
       .then((response) => response.json())
       .then((data) => new File(data, this.httpClient));
 
@@ -540,8 +526,9 @@ export class Project {
    * @returns Returns a file instance removed from the project.
    */
   async removeModel(fileId: string): Promise<File> {
-    const file = await this.httpClient
-      .get(`/files/${fileId}`)
+    const files = new Endpoint("/files", this.httpClient, this.headers);
+    const file = await files
+      .get(`/${fileId}`)
       .then((response) => response.json())
       .then((data) => new File(data, this.httpClient));
 

package/src/Api/Role.ts

@@ -22,16 +22,16 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 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 class Role {
+export class Role extends Endpoint {
   private _data: any;
   public projectId: string;
-  public httpClient: IHttpClient;
 
   /**
    * @param data - Raw role data received from the server. For more information, see
@@ -40,23 +40,11 @@ export class Role {
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, projectId: string, httpClient: IHttpClient) {
-    this.httpClient = httpClient;
+    super("", httpClient);
     this.projectId = projectId;
     this.data = data;
   }
 
-  private internalGet(): Promise<Response> {
-    return this.httpClient.get(`/projects/${this.projectId}/roles/${this.name}`);
-  }
-
-  private internalPut(body?: BodyInit | object): Promise<Response> {
-    return this.httpClient.put(`/projects/${this.projectId}/roles/${this.name}`, body);
-  }
-
-  private internalDelete(): Promise<Response> {
-    return this.httpClient.delete(`/projects/${this.projectId}/roles/${this.name}`);
-  }
-
   /**
    * Role description.
    */
@@ -80,6 +68,7 @@ export class Role {
 
   set data(value: any) {
     this._data = value;
+    this.path = `/projects/${this.projectId}/roles/${value.name}`;
   }
 
   /**
@@ -108,7 +97,7 @@ export class Role {
    * Reloads role 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;
   }
@@ -120,7 +109,7 @@ export class Role {
    *   {@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;
   }
@@ -131,8 +120,8 @@ export class Role {
    * @returns Returns the raw data of a deleted role. 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/SharedFile.ts

@@ -0,0 +1,54 @@
+///////////////////////////////////////////////////////////////////////////////
+// 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.
+///////////////////////////////////////////////////////////////////////////////
+
+import { IHttpClient } from "./IHttpClient";
+import { File } from "./File";
+
+export class SharedFile extends File {
+  constructor(data: any, password: string, httpClient: IHttpClient) {
+    super(data.file, httpClient);
+    this.path = `/shares/${data.file.sharedLinkToken}`;
+    this.headers = { "InWeb-Password": password };
+  }
+
+  override async checkout(): Promise<this> {
+    const response = await this.get("/info");
+    const data = await response.json();
+    this.data = data.file;
+    return this;
+  }
+
+  override async update(data: any): Promise<this> {
+    const response = await this.put("/info", data);
+    this.data = await response.json();
+    return this;
+  }
+
+  override getVersions(): Promise<undefined> {
+    return Promise.resolve(undefined);
+  }
+
+  override useVersion(version?: number): this {
+    return this;
+  }
+}

package/src/Api/SharedLink.ts

@@ -0,0 +1,135 @@
+///////////////////////////////////////////////////////////////////////////////
+// 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.
+///////////////////////////////////////////////////////////////////////////////
+
+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 class SharedLink extends Endpoint {
+  private _data: any;
+
+  /**
+   * @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) {
+    super(`/shares/${data.token}`, httpClient);
+    this.data = data;
+  }
+
+  /**
+   * Shared link creation time (UTC) in the format specified in
+   * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
+   *
+   * @readonly
+   */
+  get createdAt(): string {
+    return this.data.createdAt;
+  }
+
+  /**
+   * 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 {
+    return this._data;
+  }
+
+  private set data(value: any) {
+    this._data = value;
+  }
+
+  /**
+   * Share permissions.
+   */
+  get permissions(): ISharedLinkPermissions {
+    return this.data.permissions;
+  }
+
+  set permissions(value: ISharedLinkPermissions) {
+    this.data.permissions = { ...this.data.permissions, ...value };
+  }
+
+  /**
+   * Unique shared link token.
+   *
+   * @readonly
+   */
+  get token(): string {
+    return this.data.token;
+  }
+
+  /**
+   * URL to open shared file in the viewer.
+   *
+   * @readonly
+   */
+  get url(): string {
+    return this.data.url;
+  }
+
+  /**
+   * Reloads shared link data from the server.
+   */
+  async checkout(): Promise<this> {
+    const response = await this.get("");
+    this.data = await response.json();
+    return 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}.
+   */
+  async update(data: any): Promise<this> {
+    const response = await this.put("", data);
+    this.data = await response.json();
+    return 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}.
+   */
+  override delete(): Promise<any> {
+    return super.delete("").then((response) => response.json());
+  }
+
+  /**
+   * 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> {
+    return this.update(this.data);
+  }
+}

package/src/Api/User.ts

@@ -22,6 +22,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
+import { Endpoint } from "./Endpoint";
 import { FetchError } from "./FetchError";
 import { userFullName, userInitials } from "./Utils";
 
@@ -29,9 +30,8 @@ import { userFullName, userInitials } from "./Utils";
  * Provides properties and methods for obtaining information about a Open Cloud Server user and
  * manage its data.
  */
-export class User {
+export class User extends Endpoint {
   private _data: any;
-  public httpClient: IHttpClient;
 
   /**
    * @param data - Raw user data received from the server. For more information, see
@@ -39,7 +39,7 @@ export class User {
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, httpClient: IHttpClient) {
-    this.httpClient = httpClient;
+    super("", httpClient);
     this.data = data;
   }
 
@@ -293,11 +293,11 @@ export class User {
    */
   async checkout(): Promise<this> {
     if (this.httpClient.signInUserIsAdmin) {
-      const response = await this.httpClient.get(`/users/${this.id}`);
+      const response = await this.get(`/users/${this.id}`);
       const data = await response.json();
       this.data = { id: data.id, ...data.userBrief };
     } else if (this.id === this.httpClient.signInUserId) {
-      const response = await this.httpClient.get("/user");
+      const response = await this.get("/user");
       const data = await response.json();
       this.data = { id: this.id, ...data };
     } else {
@@ -317,11 +317,11 @@ export class User {
    */
   async update(data: any): Promise<this> {
     if (this.httpClient.signInUserIsAdmin) {
-      const response = await this.httpClient.put(`/users/${this.id}`, { isAdmin: data.isAdmin, userBrief: data });
+      const response = await this.put(`/users/${this.id}`, { isAdmin: data.isAdmin, userBrief: data });
       const newData = await response.json();
       this.data = { id: newData.id, ...newData.userBrief };
     } else if (this.id === this.httpClient.signInUserId) {
-      const response = await this.httpClient.put("/user", data);
+      const response = await this.put("/user", data);
       const newData = await response.json();
       this.data = { id: this.id, ...newData };
     } else {
@@ -344,14 +344,14 @@ export class User {
    * @returns Returns the raw data of a deleted user. For more information, see
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Users | Open Cloud Users API}.
    */
-  delete(): Promise<any> {
+  override delete(): Promise<any> {
     if (this.httpClient.signInUserIsAdmin) {
-      return this.httpClient
+      return super
         .delete(`/users/${this.id}`)
         .then((response) => response.json())
         .then((data) => {
           if (this.id === this.httpClient.signInUserId) {
-            this.httpClient.headers = {};
+            delete this.httpClient.headers["Authorization"];
             this.httpClient.signInUserId = "";
             this.httpClient.signInUserIsAdmin = false;
           }
@@ -388,11 +388,11 @@ export class User {
     if (!image) {
       await this.deleteAvatar();
     } else if (this.httpClient.signInUserIsAdmin) {
-      const response = await this.httpClient.post(`/users/${this.id}/avatar`, image);
+      const response = await this.post(`/users/${this.id}/avatar`, image);
       const data = await response.json();
       this.data = { id: data.id, ...data.userBrief };
     } else if (this.id === this.httpClient.signInUserId) {
-      const response = await this.httpClient.post("/user/avatar", image);
+      const response = await this.post("/user/avatar", image);
       const data = await response.json();
       this.data = { id: this.id, ...data };
     } else {
@@ -409,11 +409,11 @@ export class User {
    */
   async deleteAvatar(): Promise<this> {
     if (this.httpClient.signInUserIsAdmin) {
-      const response = await this.httpClient.delete(`/users/${this.id}/avatar`);
+      const response = await super.delete(`/users/${this.id}/avatar`);
       const data = await response.json();
       this.data = { id: data.id, ...data.userBrief };
     } else if (this.id === this.httpClient.signInUserId) {
-      const response = await this.httpClient.delete("/user/avatar");
+      const response = await super.delete("/user/avatar");
       const data = await response.json();
       this.data = { id: this.id, ...data };
     } else {
@@ -437,11 +437,11 @@ export class User {
    */
   async changePassword(newPassword: string, oldPassword?: string): Promise<this> {
     if (this.httpClient.signInUserIsAdmin) {
-      const response = await this.httpClient.put(`/users/${this.id}/password`, { new: newPassword });
+      const response = await this.put(`/users/${this.id}/password`, { new: newPassword });
       const data = await response.json();
       this.data = { id: data.id, ...data.userBrief };
     } else if (this.id === this.httpClient.signInUserId) {
-      const response = await this.httpClient.put("/user/password", { old: oldPassword, new: newPassword });
+      const response = await this.put("/user/password", { old: oldPassword, new: newPassword });
       const data = await response.json();
       this.data = { id: this.id, ...data };
     } else {

package/src/Api/XMLHttp.ts

@@ -48,7 +48,7 @@ function handleXMLHttpError(xhr: XMLHttpRequest): Promise<XMLHttpRequest> {
 export 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/src/index.ts

@@ -30,23 +30,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";