@inweb/client 25.4.1 → 25.4.3

package/lib/Api/ClashTest.d.ts

@@ -5,8 +5,8 @@ import { IShortUserDescription } from "./IUser";
  */
 export declare class ClashTest {
     private _data;
-    private basePath;
-    private httpClient;
+    basePath: string;
+    httpClient: IHttpClient;
     /**
      * @param data - Raw test data.
      * @param basePath - Clash tests API base path for the owner file/assembly.

package/lib/Api/Client.d.ts

@@ -1,4 +1,5 @@
 import { EventEmitter2 } from "@inweb/eventemitter2";
+import { IHttpClient } from "./IHttpClient";
 import { ClientEventMap } from "./ClientEvents";
 import { Assembly } from "./Assembly";
 import { File } from "./File";
@@ -12,7 +13,7 @@ import { User } from "./User";
  */
 export declare class Client extends EventEmitter2<ClientEventMap> {
     private _serverUrl;
-    private _httpClient;
+    httpClient: IHttpClient;
     private _user;
     eventEmitter: EventEmitter2;
     /**
@@ -92,13 +93,22 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      */
     signInWithEmail(email: string, password: string): Promise<User>;
     /**
-     * Log in an existing user using API Key.
+     * Log in an existing user using access token (API Key).
      *
      * @async
-     * @param token - An access token for authentication request. See
-     *   {@link User#token | User.token} for more details.
+     * @param token - An access token for authentication request. See {@link User.token} for more details.
      */
     signInWithToken(token: string): Promise<User>;
+    /**
+     * Get the list of server indentity providers.
+     *
+     * To sign in with the provider in your web application:
+     *
+     * - Open the `provider.url` link using `window.open()`.
+     * - Add a `/oauth` path (server-defined) handler to the router. In this handler, show an error
+     *   message if the `error` search parameter is present, or log in with the `token` search parameter.
+     */
+    getIdentityProviders(): Promise<any>;
     private setCurrentUser;
     private clearCurrentUser;
     /**

package/lib/Api/Job.d.ts

@@ -5,7 +5,7 @@ import { IHttpClient } from "./IHttpClient";
  */
 export declare class Job {
     private _data;
-    protected httpClient: IHttpClient;
+    httpClient: IHttpClient;
     /**
      * @param data - An object that implements job data storage.
      * @param httpClient - Http client.

package/lib/Api/Member.d.ts

@@ -5,8 +5,8 @@ import { IShortUserDescription } from "./IUser";
  */
 export declare class Member {
     private _data;
-    protected projectId: string;
-    protected httpClient: IHttpClient;
+    projectId: string;
+    httpClient: IHttpClient;
     /**
      * @param data - An object that implements member data storage.
      * @param projectId - Owner project ID.

package/lib/Api/Permission.d.ts

@@ -5,8 +5,8 @@ import { IHttpClient } from "./IHttpClient";
  */
 export declare class Permission {
     private _data;
-    protected fileId: string;
-    protected httpClient: IHttpClient;
+    fileId: string;
+    httpClient: IHttpClient;
     /**
      * @param data - An object that implements permission data storage.
      * @param fileId - Owner file ID.

package/lib/Api/Project.d.ts

@@ -7,7 +7,7 @@ import { Member } from "./Member";
  */
 export declare class Project {
     private _data;
-    protected httpClient: IHttpClient;
+    httpClient: IHttpClient;
     /**
      * @param data - An object that implements project data storage.
      * @param httpClient - Http client.

package/lib/Api/Role.d.ts

@@ -4,8 +4,8 @@ import { IHttpClient } from "./IHttpClient";
  */
 export declare class Role {
     private _data;
-    protected projectId: string;
-    protected httpClient: IHttpClient;
+    projectId: string;
+    httpClient: IHttpClient;
     /**
      * @param data - An object that implements role data storage.
      * @param projectId - Owner project ID.

package/lib/Api/User.d.ts

@@ -34,7 +34,7 @@ export interface UserParams {
  */
 export declare class User {
     private _data;
-    protected httpClient: IHttpClient;
+    httpClient: IHttpClient;
     /**
      * @param data - An object that implements user data storage.
      * @param httpClient - Http client.
@@ -132,7 +132,7 @@ export declare class User {
      */
     get projectsLimit(): number;
     /**
-     * The user's API key.
+     * The user's access token (API key). Use {@link Client.signInWithToken()} to log in using token.
      *
      * @readonly
      */

package/lib/index.d.ts

@@ -3,6 +3,7 @@ export { Client } from "./Api/Client";
 export { ClashTest } from "./Api/ClashTest";
 export * from "./Api/ClientEvents";
 export { File } from "./Api/File";
+export { FetchError, statusText } from "./Api/FetchError";
 export { Job } from "./Api/Job";
 export { Member } from "./Api/Member";
 export { Model } from "./Api/Model";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.4.1",
+  "version": "25.4.3",
   "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 @@
     "ts-docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "~25.4.1"
+    "@inweb/eventemitter2": "~25.4.3"
   }
 }

package/src/Api/ClashTest.ts

@@ -30,8 +30,8 @@ import { waitFor, userFullName, userInitials } from "./Utils";
  */
 export class ClashTest {
   private _data: any;
-  private basePath: string;
-  private httpClient: IHttpClient;
+  public basePath: string;
+  public httpClient: IHttpClient;
 
   /**
    * @param data - Raw test data.

package/src/Api/Client.ts

@@ -40,7 +40,7 @@ import { parseArgs } from "./Utils";
  */
 export class Client extends EventEmitter2<ClientEventMap> {
   private _serverUrl = "";
-  private _httpClient: IHttpClient = new HttpClient("");
+  public httpClient: IHttpClient = new HttpClient("");
   private _user: User | null = null;
   public eventEmitter: EventEmitter2 = this;
 
@@ -114,7 +114,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    */
   configure(params: { serverUrl?: string }): this {
     this._serverUrl = (params.serverUrl || "").replace(/\/+$/, "");
-    this._httpClient = new HttpClient(this.serverUrl);
+    this.httpClient = new HttpClient(this.serverUrl);
     this._user = null;
     return this;
   }
@@ -133,7 +133,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @async
    */
   version(): Promise<any> {
-    return this._httpClient
+    return this.httpClient
       .get("/version")
       .then((response) => response.json())
       .then((data) => ({
@@ -154,7 +154,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *   `username` from email.
    */
   registerUser(email: string, password: string, userName?: string): Promise<any> {
-    return this._httpClient
+    return this.httpClient
       .post("/register", {
         email,
         password,
@@ -172,7 +172,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param password - User password.
    */
   resendConfirmationEmail(email: string, password: string): Promise<any> {
-    return this._httpClient
+    return this.httpClient
       .post("/register/email-confirmation", { email, password })
       .then((response) => response.json());
   }
@@ -184,7 +184,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param emailConfirmationId - Confirmation code from the Confirmation Email.
    */
   confirmUserEmail(emailConfirmationId: string): Promise<any> {
-    return this._httpClient
+    return this.httpClient
       .get(`/register/email-confirmation/${emailConfirmationId}`)
       .then((response) => response.json());
   }
@@ -198,39 +198,51 @@ export class Client extends EventEmitter2<ClientEventMap> {
    */
   async signInWithEmail(email: string, password: string): Promise<User> {
     const credentials = btoa(unescape(encodeURIComponent(email + ":" + password)));
-    this._httpClient.headers = { Authorization: "Basic " + credentials };
-    const response = await this._httpClient.get("/token");
+    this.httpClient.headers = { Authorization: "Basic " + credentials };
+    const response = await this.httpClient.get("/token");
     const data = await response.json();
     return this.setCurrentUser(data);
   }
 
   /**
-   * Log in an existing user using API Key.
+   * Log in an existing user using access token (API Key).
    *
    * @async
-   * @param token - An access token for authentication request. See
-   *   {@link User#token | User.token} for more details.
+   * @param token - An access token for authentication request. See {@link User.token} for more details.
    */
   async signInWithToken(token: string): Promise<User> {
-    this._httpClient.headers = { Authorization: token };
-    const response = await this._httpClient.get("/user");
+    this.httpClient.headers = { Authorization: token };
+    const response = await this.httpClient.get("/user");
     const data = await response.json();
     return this.setCurrentUser(data);
   }
 
+  /**
+   * Get the list of server indentity providers.
+   *
+   * To sign in with the provider in your web application:
+   *
+   * - Open the `provider.url` link using `window.open()`.
+   * - Add a `/oauth` path (server-defined) handler to the router. In this handler, show an error
+   *   message if the `error` search parameter is present, or log in with the `token` search parameter.
+   */
+  getIdentityProviders(): Promise<any> {
+    return this.httpClient.get("/identity").then((response) => response.json());
+  }
+
   // Save the current logged in user information for internal use.
 
   private setCurrentUser(data: any): User {
-    this._user = new User(data, this._httpClient);
-    this._httpClient.headers = { Authorization: data.tokenInfo.token };
-    this._httpClient.signInUserId = this._user.id;
+    this._user = new User(data, this.httpClient);
+    this.httpClient.headers = { Authorization: data.tokenInfo.token };
+    this.httpClient.signInUserId = this._user.id;
     return this._user;
   }
 
   private clearCurrentUser(): void {
     this._user = null;
-    this._httpClient.headers = {};
-    this._httpClient.signInUserId = "";
+    this.httpClient.headers = {};
+    this.httpClient.signInUserId = "";
   }
 
   /**
@@ -238,7 +250,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * in or the logged in user has deleted himself.
    */
   getCurrentUser(): User | null {
-    if (this._user && !this._httpClient.signInUserId) this._user = null;
+    if (this._user && !this.httpClient.signInUserId) this._user = null;
     return this._user;
   }
 
@@ -249,11 +261,11 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @async
    */
   getUsers(): Promise<User[]> {
-    return this._httpClient
+    return this.httpClient
       .get("/users")
       .then((response) => response.json())
       .then((array) => array.map((data) => ({ id: data.id, ...data.userBrief })))
-      .then((array) => array.map((data) => new User(data, this._httpClient)));
+      .then((array) => array.map((data) => new User(data, this.httpClient)));
   }
 
   /**
@@ -265,18 +277,18 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param userId - User ID.
    */
   getUser(userId: string): Promise<User> {
-    if (userId === this._httpClient.signInUserId) {
-      return this._httpClient
+    if (userId === this.httpClient.signInUserId) {
+      return this.httpClient
         .get("/user")
         .then((response) => response.json())
         .then((data) => ({ id: userId, ...data }))
-        .then((data) => new User(data, this._httpClient));
+        .then((data) => new User(data, this.httpClient));
     } else {
-      return this._httpClient
+      return this.httpClient
         .get(`/users/${userId}`)
         .then((response) => response.json())
         .then((data) => ({ id: data.id, ...data.userBrief }))
-        .then((data) => new User(data, this._httpClient));
+        .then((data) => new User(data, this.httpClient));
     }
   }
 
@@ -312,7 +324,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
     } = {}
   ): Promise<User> {
     const { isAdmin, userName, ...rest } = params;
-    return this._httpClient
+    return this.httpClient
       .post("/users", {
         isAdmin,
         userBrief: {
@@ -324,7 +336,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
       })
       .then((response) => response.json())
       .then((data) => ({ id: data.id, ...data.userBrief }))
-      .then((data) => new User(data, this._httpClient));
+      .then((data) => new User(data, this.httpClient));
   }
 
   /**
@@ -341,11 +353,11 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @returns Returns the raw data of a deleted user.
    */
   deleteUser(userId: string): Promise<any> {
-    return this._httpClient
+    return this.httpClient
       .delete(`/users/${userId}`)
       .then((response) => response.json())
       .then((data) => {
-        if (userId === this._httpClient.signInUserId) {
+        if (userId === this.httpClient.signInUserId) {
           this.clearCurrentUser();
         }
         return data;
@@ -408,13 +420,13 @@ export class Client extends EventEmitter2<ClientEventMap> {
     let queryString = searchParams.toString();
     if (queryString) queryString = "?" + queryString;
 
-    return this._httpClient
+    return this.httpClient
       .get(`/files${queryString}`)
       .then((response) => response.json())
       .then((files) => {
         return {
           ...files,
-          result: files.result.map((data) => new File(data, this._httpClient)),
+          result: files.result.map((data) => new File(data, this.httpClient)),
         };
       });
   }
@@ -426,10 +438,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param fileId - File ID.
    */
   getFile(fileId: string): Promise<File> {
-    return this._httpClient
+    return this.httpClient
       .get(`/files/${fileId}`)
       .then((response) => response.json())
-      .then((data) => new File(data, this._httpClient));
+      .then((data) => new File(data, this.httpClient));
   }
 
   /**
@@ -478,13 +490,13 @@ export class Client extends EventEmitter2<ClientEventMap> {
       waitForDone: false,
     }
   ): Promise<File> {
-    const result = await this._httpClient
+    const result = await this.httpClient
       .uploadFile("/files", file, (progress) => {
         this.emitEvent({ type: "uploadprogress", data: progress, file });
         params.onProgress?.(progress, file);
       })
       .then((xhr: XMLHttpRequest) => JSON.parse(xhr.responseText))
-      .then((data) => new File(data, this._httpClient));
+      .then((data) => new File(data, this.httpClient));
 
     const geometryType = typeof params.geometry === "string" ? params.geometry : "vsfx";
 
@@ -506,7 +518,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @returns Returns the raw data of a deleted file.
    */
   deleteFile(fileId: string): Promise<any> {
-    return this._httpClient.delete(`/files/${fileId}`).then((response) => response.json());
+    return this.httpClient.delete(`/files/${fileId}`).then((response) => response.json());
   }
 
   /**
@@ -520,7 +532,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *   and abort it if desired.
    */
   downloadFile(fileId: string, onProgress?: (progress: number) => void, signal?: AbortSignal): Promise<ArrayBuffer> {
-    return this._httpClient
+    return this.httpClient
       .downloadFile(`/files/${fileId}/downloads`, onProgress, signal)
       .then((response) => response.arrayBuffer());
   }
@@ -569,12 +581,12 @@ export class Client extends EventEmitter2<ClientEventMap> {
     let queryString = searchParams.toString();
     if (queryString) queryString = "?" + queryString;
 
-    return this._httpClient
+    return this.httpClient
       .get(`/jobs${queryString}`)
       .then((response) => response.json())
       .then((jobs) => ({
         ...jobs,
-        result: jobs.result.map((data) => new Job(data, this._httpClient)),
+        result: jobs.result.map((data) => new Job(data, this.httpClient)),
       }));
   }
 
@@ -585,10 +597,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param jobId - Job ID.
    */
   getJob(jobId: string): Promise<Job> {
-    return this._httpClient
+    return this.httpClient
       .get(`/jobs/${jobId}`)
       .then((response) => response.json())
-      .then((data) => new Job(data, this._httpClient));
+      .then((data) => new Job(data, this.httpClient));
   }
 
   /**
@@ -610,14 +622,14 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *   for the File Converter tool in form "--arg=value".
    */
   createJob(fileId: string, outputFormat: string, parameters?: string | object): Promise<Job> {
-    return this._httpClient
+    return this.httpClient
       .post("/jobs", {
         fileId,
         outputFormat,
         parameters: parseArgs(parameters),
       })
       .then((response) => response.json())
-      .then((data) => new Job(data, this._httpClient));
+      .then((data) => new Job(data, this.httpClient));
   }
 
   /**
@@ -629,7 +641,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @returns Returns the raw data of a deleted job.
    */
   deleteJob(jobId: string): Promise<any> {
-    return this._httpClient.delete(`/jobs/${jobId}`).then((response) => response.json());
+    return this.httpClient.delete(`/jobs/${jobId}`).then((response) => response.json());
   }
 
   /**
@@ -680,13 +692,13 @@ export class Client extends EventEmitter2<ClientEventMap> {
     let queryString = searchParams.toString();
     if (queryString) queryString = "?" + queryString;
 
-    return this._httpClient
+    return this.httpClient
       .get(`/assemblies${queryString}`)
       .then((response) => response.json())
       .then((assemblies) => {
         return {
           ...assemblies,
-          result: assemblies.result.map((data) => new Assembly(data, this._httpClient)),
+          result: assemblies.result.map((data) => new Assembly(data, this.httpClient)),
         };
       });
   }
@@ -698,10 +710,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param assemblyId - Assembly ID.
    */
   getAssembly(assemblyId: string): Promise<Assembly> {
-    return this._httpClient
+    return this.httpClient
       .get(`/assemblies/${assemblyId}`)
       .then((response) => response.json())
-      .then((data) => new Assembly(data, this._httpClient));
+      .then((data) => new Assembly(data, this.httpClient));
   }
 
   /**
@@ -724,10 +736,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
     }
   ): Promise<Assembly> {
     const { waitForDone } = params ?? {};
-    return this._httpClient
+    return this.httpClient
       .post("/assemblies", { name, files })
       .then((response) => response.json())
-      .then((data) => new Assembly(data, this._httpClient))
+      .then((data) => new Assembly(data, this.httpClient))
       .then((result) => (waitForDone ? result.waitForDone(params) : result));
   }
 
@@ -739,7 +751,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @returns Returns the raw data of a deleted assembly.
    */
   deleteAssembly(assemblyId: string): Promise<any> {
-    return this._httpClient.delete(`/assemblies/${assemblyId}`).then((response) => response.json());
+    return this.httpClient.delete(`/assemblies/${assemblyId}`).then((response) => response.json());
   }
 
   /**
@@ -785,7 +797,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
 
     let queryString = searchParams.toString();
     if (queryString) queryString = "?" + queryString;
-    return this._httpClient
+    return this.httpClient
       .get(`/projects${queryString}`)
       .then((response) => response.json())
       .then((projects) => {
@@ -811,7 +823,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
       .then((projects) => {
         return {
           ...projects,
-          result: projects.result.map((data) => new Project(data, this._httpClient)),
+          result: projects.result.map((data) => new Project(data, this.httpClient)),
         };
       });
   }
@@ -823,10 +835,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param projectId - Project ID.
    */
   getProject(projectId: string): Promise<Project> {
-    return this._httpClient
+    return this.httpClient
       .get(`/projects/${projectId}`)
       .then((response) => response.json())
-      .then((data) => new Project(data, this._httpClient));
+      .then((data) => new Project(data, this.httpClient));
   }
 
   /**
@@ -848,7 +860,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
     endDate?: Date | string,
     avatarUrl?: string
   ): Promise<Project> {
-    return this._httpClient
+    return this.httpClient
       .post("/projects", {
         name,
         description,
@@ -857,7 +869,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
         avatarUrl,
       })
       .then((response) => response.json())
-      .then((data) => new Project(data, this._httpClient));
+      .then((data) => new Project(data, this.httpClient));
   }
 
   /**
@@ -868,7 +880,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @returns Returns the raw data of a deleted project.
    */
   deleteProject(projectId: string): Promise<any> {
-    return this._httpClient
+    return this.httpClient
       .delete(`/projects/${projectId}`)
       .then((response) => response.text())
       .then((text) => {

package/src/Api/Fetch.ts

@@ -21,7 +21,7 @@
 // acknowledge and accept the above terms.
 ///////////////////////////////////////////////////////////////////////////////
 
-import { FetchError, statusText, error400 } from "./FetchError";
+import { FetchError, error400 } from "./FetchError";
 
 function handleFetchError(response: Response): Promise<Response> {
   if (!response.ok) {
@@ -39,7 +39,7 @@ function handleFetchError(response: Response): Promise<Response> {
         });
       }
       default:
-        return Promise.reject(new FetchError(response.status, statusText(response.status)));
+        return Promise.reject(new FetchError(response.status));
     }
   }
   return Promise.resolve(response);

package/src/Api/HttpClient.ts

@@ -26,9 +26,9 @@ import { $fetch } from "./Fetch";
 import { $xmlhttp } from "./XMLHttp";
 
 export class HttpClient implements IHttpClient {
-  serverUrl: string;
-  headers: HeadersInit = {};
-  signInUserId = "";
+  public serverUrl: string;
+  public headers: HeadersInit = {};
+  public signInUserId = "";
 
   constructor(serverUrl: string) {
     this.serverUrl = serverUrl;

package/src/Api/Job.ts

@@ -30,7 +30,7 @@ import { waitFor } from "./Utils";
  */
 export class Job {
   private _data: any;
-  protected httpClient: IHttpClient;
+  public httpClient: IHttpClient;
 
   /**
    * @param data - An object that implements job data storage.

package/src/Api/Member.ts

@@ -30,8 +30,8 @@ import { userFullName, userInitials } from "./Utils";
  */
 export class Member {
   private _data: any;
-  protected projectId: string;
-  protected httpClient: IHttpClient;
+  public projectId: string;
+  public httpClient: IHttpClient;
 
   /**
    * @param data - An object that implements member data storage.

package/src/Api/Permission.ts

@@ -29,8 +29,8 @@ import { IHttpClient } from "./IHttpClient";
  */
 export class Permission {
   private _data: any;
-  protected fileId: string;
-  protected httpClient: IHttpClient;
+  public fileId: string;
+  public httpClient: IHttpClient;
 
   /**
    * @param data - An object that implements permission data storage.

package/src/Api/Project.ts

@@ -32,7 +32,7 @@ import { userFullName, userInitials } from "./Utils";
  */
 export class Project {
   private _data: any;
-  protected httpClient: IHttpClient;
+  public httpClient: IHttpClient;
 
   /**
    * @param data - An object that implements project data storage.

package/src/Api/Role.ts

@@ -28,8 +28,8 @@ import { IHttpClient } from "./IHttpClient";
  */
 export class Role {
   private _data: any;
-  protected projectId: string;
-  protected httpClient: IHttpClient;
+  public projectId: string;
+  public httpClient: IHttpClient;
 
   /**
    * @param data - An object that implements role data storage.