@inweb/client 25.2.2

package/src/Api/HttpClient.ts

@@ -0,0 +1,73 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2002-2021, 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-2021 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 { $get, $delete, $post, $put, $XMLHttp } from "./impl/Utils";
+
+export class HttpClient implements IHttpClient {
+  serverUrl: string;
+  headers: HeadersInit;
+  signInUserId: string;
+
+  constructor(serverUrl: string) {
+    this.serverUrl = serverUrl;
+  }
+
+  get(relativePath: string, signal?: AbortSignal): Promise<Response> {
+    return $get(`${this.serverUrl}${relativePath}`, this.headers, signal);
+  }
+
+  post(
+    relativePath: string,
+    body?: string | object | ArrayBuffer | Blob | globalThis.File | FormData
+  ): Promise<Response> {
+    return $post(`${this.serverUrl}${relativePath}`, this.headers, body);
+  }
+
+  put(
+    relativePath: string,
+    body?: string | object | ArrayBuffer | Blob | globalThis.File | FormData
+  ): Promise<Response> {
+    return $put(`${this.serverUrl}${relativePath}`, this.headers, body);
+  }
+
+  delete(relativePath: string): Promise<Response> {
+    return $delete(`${this.serverUrl}${relativePath}`, this.headers);
+  }
+
+  postFile(
+    relativePath: string,
+    file: globalThis.File,
+    onProgress?: (progress: number) => void
+  ): Promise<XMLHttpRequest> {
+    const data = new FormData();
+    data.append("file", file);
+
+    return $XMLHttp(`${this.serverUrl}${relativePath}`, {
+      method: "POST",
+      headers: this.headers,
+      body: data,
+      uploadProgress: onProgress,
+    });
+  }
+}

package/src/Api/IAssembly.ts

@@ -0,0 +1,37 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2002-2021, 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-2021 by Open Design Alliance.
+//   All rights reserved.
+//
+// By use of this software, its documentation or related materials, you
+// acknowledge and accept the above terms.
+///////////////////////////////////////////////////////////////////////////////
+
+export interface IAssociatedFileData {
+  fileId: string;
+  name: string;
+  link: string;
+  version?: number;
+}
+
+export interface IAssemblyVersionInfo {
+  assemblyId: string;
+  status: string;
+  version: number;
+  createdAt: string;
+  ownerId: string;
+}

package/src/Api/IFile.ts

@@ -0,0 +1,74 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2002-2023, 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-2021 by Open Design Alliance.
+//   All rights reserved.
+//
+// By use of this software, its documentation or related materials, you
+// acknowledge and accept the above terms.
+///////////////////////////////////////////////////////////////////////////////
+
+export interface IFileDataStatus {
+  state: string;
+  jobId?: string;
+  jobUrl?: string;
+}
+
+export interface IFileStatus {
+  geometry: IFileDataStatus;
+  geometryGltf: IFileDataStatus;
+  properties: IFileDataStatus;
+  validation: IFileDataStatus;
+}
+
+/**
+ * Reference to file.
+ */
+export interface IFileReference {
+  /**
+   * The ID of the referenced file.
+   */
+  id: string;
+
+  /**
+   * The name of the referenced file.
+   */
+  name: string;
+}
+
+/**
+ * References are images, fonts, or any other files to correct rendering of the file.
+ */
+export interface IFileReferences {
+  /**
+   * The references ID, changed after each update of the file references.
+   */
+  id: string;
+
+  /**
+   * List of file references or `null` if there are no references.
+   */
+  references: IFileReference[] | null;
+}
+
+export interface IFileVersionInfo {
+  fileId: string;
+  status: object;
+  version: number;
+  createdAt: string;
+  size: number;
+  ownerId: string;
+}

package/src/Api/IHttpClient.ts

@@ -0,0 +1,50 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2002-2021, 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-2021 by Open Design Alliance.
+//   All rights reserved.
+//
+// By use of this software, its documentation or related materials, you
+// acknowledge and accept the above terms.
+///////////////////////////////////////////////////////////////////////////////
+
+export interface IHttpClient {
+  serverUrl: string;
+
+  headers: HeadersInit;
+
+  signInUserId: string;
+
+  get(relativePath, signal?: AbortSignal): Promise<Response>;
+
+  post(
+    relativePath: string,
+    body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null
+  ): Promise<Response>;
+
+  put(
+    relativePath: string,
+    body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null
+  ): Promise<Response>;
+
+  delete(relativePath: string): Promise<Response>;
+
+  postFile(
+    relativePath: string,
+    file: globalThis.File,
+    onProgress?: (progress: number) => void
+  ): Promise<XMLHttpRequest>;
+}

package/src/Api/IUser.ts

@@ -0,0 +1,33 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2002-2021, 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-2021 by Open Design Alliance.
+//   All rights reserved.
+//
+// By use of this software, its documentation or related materials, you
+// acknowledge and accept the above terms.
+///////////////////////////////////////////////////////////////////////////////
+
+export interface IShortUserDescription {
+  userId: string;
+  userName: string;
+  name: string;
+  lastName: string;
+  email: string;
+  avatarUrl?: string;
+  fullName?: string;
+  initials?: string;
+}

package/src/Api/Job.ts

@@ -0,0 +1,253 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2002-2021, 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-2021 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 { json, waitFor } from "./impl/Utils";
+
+/**
+ * The class representing a `job` entity describes the process of converting a file from one
+ * format to another, to obtain geometric data, validate the file, or run a clash test.
+ */
+export class Job {
+  private _data: any;
+  protected httpClient: IHttpClient;
+
+  /**
+   * @param data - An object that implements job data storage.
+   * @param httpClient - Http client.
+   */
+  constructor(data: any, httpClient: IHttpClient) {
+    this.httpClient = httpClient;
+    this.data = data;
+  }
+
+  protected internalGet() {
+    return this.httpClient.get(`/jobs/${this.data.id}`);
+  }
+
+  protected internalPut(body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null) {
+    return this.httpClient.put(`/jobs/${this.data.id}`, body);
+  }
+
+  protected internalDelete() {
+    return this.httpClient.delete(`/jobs/${this.data.id}`);
+  }
+
+  /**
+   * The ID of the assembly the job is working on (internal).
+   *
+   * @readonly
+   */
+  get assemblyId(): string {
+    return this.data.assemblyId;
+  }
+
+  /**
+   * Job creator ID. Use {@link Client#getUser | Client.getUser()} to obtain detailed creator information.
+   *
+   * @readonly
+   */
+  get authorId(): string {
+    return this.data.authorId;
+  }
+
+  /**
+   * Job creation time (UTC) in the format specified in <a
+   * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+   *
+   * @readonly
+   */
+  get createdAt(): string {
+    return this.data.createdAt;
+  }
+
+  /**
+   * Raw job data received from the server.
+   *
+   * @readonly
+   */
+  get data(): any {
+    return this._data;
+  }
+
+  private set data(value: any) {
+    this._data = value;
+  }
+
+  /**
+   * `true` if job is `done` or `failed`. See {@link Job#status | status} for more details.
+   *
+   * @readonly
+   */
+  get done(): boolean {
+    return this.data.status === "done" || this.data.status === "failed";
+  }
+
+  /**
+   * The ID of the file the job is working on.
+   *
+   * @readonly
+   */
+  get fileId(): string {
+    return this.data.fileId;
+  }
+
+  /**
+   * Unique job ID.
+   *
+   * @readonly
+   */
+  get id(): string {
+    return this.data.id;
+  }
+
+  /**
+   * Job last update (UTC) time in the format specified in <a
+   * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+   *
+   * @readonly
+   */
+  get lastUpdate(): string {
+    return this.data.lastUpdate;
+  }
+
+  /**
+   * Job type. Can be `properties`, `geomerty`, `geomertyGltf`, `validation`, `clash`, `dwg`,
+   * `obj`, `gltf`, `glb`, `vsf`, `pdf` or `3dpdf`.
+   *
+   * @readonly
+   */
+  get outputFormat(): string {
+    return this.data.outputFormat;
+  }
+
+  /**
+   * Parameters for the job runner.
+   *
+   * @readonly
+   */
+  get parameters(): any {
+    return this.data.parameters;
+  }
+
+  /**
+   * Job status. Can be `waiting`, `inprogress`, `done` or `failed`.
+   *
+   * @readonly
+   */
+  get status(): string {
+    return this.data.status;
+  }
+
+  /**
+   * Job status description message.
+   *
+   * @readonly
+   */
+  get statusMessage(): string {
+    return this.data.statusMessage;
+  }
+
+  /**
+   * Job starting time (UTC) in the format specified in <a
+   * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+   *
+   * @readonly
+   */
+  get startedAt(): string {
+    return this.data.startedAt;
+  }
+
+  /**
+   * Refresh job data.
+   *
+   * @async
+   */
+  async checkout(): Promise<Job> {
+    this.data = await json(this.internalGet());
+    return this;
+  }
+
+  /**
+   * Update job data on the server. Only admins can update job data.
+   *
+   * @async
+   * @param data - Raw job data.
+   */
+  async update(data: any): Promise<Job> {
+    this.data = await json(this.internalPut(data));
+    return this;
+  }
+
+  /**
+   * Remove a job from the server job list. Jobs that are in progress or have already been
+   * completed cannot be deleted.
+   *
+   * @async
+   * @returns Returns the raw data of a deleted job.
+   */
+  delete(): Promise<any> {
+    return json(this.internalDelete());
+  }
+
+  // /**
+  //  * Save job data changes to the server. Call this method to update job data on the server
+  //  * after any changes.
+  //  *
+  //  * @async
+  //  * @returns {Promise<Job>}
+  //  */
+  // save() {
+  //   return this.update(this.data);
+  // }
+
+  /**
+   * Wait for job to be done. Job is done when it changes to `done` or `failed` status.
+   *
+   * @async
+   * @param params - An object containing waiting parameters.
+   * @param params.timeout - The time, in milliseconds that the function should wait job. If
+   *   jobs is not done during this time, the `TimeoutError` exception will be thrown.
+   * @param params.interval - The time, in milliseconds, the function should delay in between
+   *   checking job status.
+   * @param params.signal- An <a
+   *   href="https://developer.mozilla.org/docs/Web/API/AbortController">AbortController</a>
+   *   signal object instance, which can be used to abort waiting as desired.
+   * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
+   */
+  waitForDone(params?: {
+    timeout?: number;
+    interval?: number;
+    signal?: AbortSignal;
+    onCheckout?: (job: Job, ready: boolean) => boolean;
+  }): Promise<Job> {
+    const checkDone = () =>
+      this.checkout().then((job) => {
+        const ready = ["done", "failed"].includes(job.status);
+        const cancel = params?.onCheckout?.(job, ready);
+        return cancel || ready;
+      });
+
+    return waitFor(checkDone, params).then(() => this);
+  }
+}

package/src/Api/Member.ts

@@ -0,0 +1,161 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2002-2021, 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-2021 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 { IShortUserDescription } from "./IUser";
+import { json, userFullName, userInitials } from "./impl/Utils";
+
+/**
+ * Members are the {@link User | users} who have access to the {@link Project | project}.
+ */
+export class Member {
+  private _data: any;
+  protected projectId: string;
+  protected httpClient: IHttpClient;
+
+  /**
+   * @param data - An object that implements member data storage.
+   * @param projectId - Owner project ID.
+   * @param httpClient - Http client.
+   */
+  constructor(data: any, projectId: string, httpClient: IHttpClient) {
+    this.httpClient = httpClient;
+    this.projectId = projectId;
+    this.data = data;
+  }
+
+  private internalGet() {
+    return this.httpClient.get(`/projects/${this.projectId}/members/${this.id}`);
+  }
+
+  private internalPut(body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null) {
+    return this.httpClient.put(`/projects/${this.projectId}/members/${this.id}`, body);
+  }
+
+  private internalDelete() {
+    return this.httpClient.delete(`/projects/${this.projectId}/members/${this.id}`);
+  }
+
+  /**
+   * Raw member data received from the server.
+   *
+   * @readonly
+   */
+  get data(): any {
+    return this._data;
+  }
+
+  private set data(value: any) {
+    this._data = value;
+    this._data.user.avatarUrl = `${this.httpClient.serverUrl}/users/${this._data.user.userId}/avatar`;
+    this._data.user.fullName = userFullName(this._data.user);
+    this._data.user.initials = userInitials(this._data.user.fullName);
+  }
+
+  /**
+   * Unique member ID.
+   *
+   * @readonly
+   */
+  get id(): string {
+    return this.data.id;
+  }
+
+  /**
+   * Member role. See {@link Project#getRoles | Project.getRoles()} for more details.
+   */
+  get role(): string {
+    return this.data.role;
+  }
+
+  set role(value: string) {
+    this.data.role = value;
+  }
+
+  /**
+   * Member type. Can be `owner` or `user`.
+   *
+   * @readonly
+   */
+  get type(): string {
+    return this.data.type;
+  }
+
+  /**
+   * User information.
+   *
+   * @property {string} userId - User ID.
+   * @property {string} userName - User name.
+   * @property {string} name - First name.
+   * @property {string} lastName - Last name.
+   * @property {string} fullName - Full name.
+   * @property {string} initials - Initials.
+   * @property {string} email - User email.
+   * @property {string} avatarUrl - User avatar image URL.
+   * @readonly
+   */
+  get user(): IShortUserDescription {
+    return this.data.user;
+  }
+
+  /**
+   * Refresh member data.
+   *
+   * @async
+   */
+  async checkout(): Promise<Member> {
+    this.data = await json(this.internalGet());
+    return this;
+  }
+
+  /**
+   * Update member data on the server.
+   *
+   * @async
+   * @param data - Raw member data.
+   */
+  async update(data: any): Promise<Member> {
+    this.data = await json(this.internalPut(data));
+    return this;
+  }
+
+  /**
+   * Remove a member from a project.
+   *
+   * @async
+   * @returns Returns the raw data of a deleted member.
+   */
+  delete(): Promise<any> {
+    return json(this.internalDelete());
+  }
+
+  /**
+   * Save member data changes to the server. Call this method to update member data on the
+   * server after any changes.
+   *
+   * @async
+   */
+  save(): Promise<Member> {
+    return this.update(this.data);
+  }
+}