@inweb/client 25.4.2 → 25.4.4

package/dist/client.js

@@ -196,9 +196,8 @@
             return this._file.deleteViewpoint(guid);
         }
         /**
-         * Returns viewpoint preview image as <a
-         * href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-         * target="_blank">Data URL</a>.
+         * Returns viewpoint preview image as
+         * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
          *
          * @async
          * @param guid - Viewpoint GIID.
@@ -1029,26 +1028,54 @@
         getCdaTree() {
             return this.internalGet(`/properties/tree`).then((response) => response.json());
         }
-        // Reserved for future use
+        /**
+         * Returns a list of assembly viewpoints.
+         *
+         * @async
+         */
         getViewpoints() {
-            console.warn("Assembly does not support viewpoints");
-            return Promise.resolve([]);
+            return this.internalGet("/viewpoints")
+                .then((response) => response.json())
+                .then((viewpoints) => viewpoints.result);
         }
+        /**
+         * Add new assembly viewpoint. To create a new viewpoint use {@link Viewer.createViewpoint()}.
+         *
+         * @async
+         * @param viewpoint - Viewpoint.
+         */
         saveViewpoint(viewpoint) {
-            console.warn("Assembly does not support viewpoints");
-            return Promise.resolve({});
+            return this.internalPost("/viewpoints", viewpoint).then((response) => response.json());
         }
+        /**
+         * Delete assembly viewpoint.
+         *
+         * @async
+         * @param guid - Viewpoint GUID.
+         * @returns Returns the raw data of a deleted viewpoint.
+         */
         deleteViewpoint(guid) {
-            console.warn("Assembly does not support viewpoints");
-            return Promise.resolve({});
+            return this.internalDelete(`/viewpoints/${guid}`).then((response) => response.json());
         }
+        /**
+         * Returns viewpoint preview image as
+         * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
+         *
+         * @async
+         * @param guid - Viewpoint GUID.
+         */
         getSnapshot(guid) {
-            console.warn("Assembly does not support viewpoints");
-            return Promise.resolve({});
+            return this.internalGet(`/viewpoints/${guid}/snapshot`).then((response) => response.text());
         }
+        /**
+         * Returns viewpoint preview data.
+         *
+         * @async
+         * @param guid - Viewpoint GUID.
+         * @param bitmapGuid - Bitmap GUID.
+         */
         getSnapshotData(guid, bitmapGuid) {
-            console.warn("Assembly does not support viewpoints");
-            return Promise.resolve("");
+            return this.internalGet(`/viewpoints/${guid}/bitmaps/${bitmapGuid}`).then((response) => response.text());
         }
         /**
          * Download assembly resource file. Resource files are files that contain model scene
@@ -1316,7 +1343,7 @@
                     });
                 }
                 default:
-                    return Promise.reject(new FetchError(response.status, statusText(response.status)));
+                    return Promise.reject(new FetchError(response.status));
             }
         }
         return Promise.resolve(response);
@@ -2294,9 +2321,8 @@
             return this.internalDelete(`/viewpoints/${guid}`).then((response) => response.json());
         }
         /**
-         * Returns viewpoint preview image as <a
-         * href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-         * target="_blank">Data URL</a>.
+         * Returns viewpoint preview image as
+         * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
          *
          * @async
          * @param guid - Viewpoint GUID.
@@ -3642,7 +3668,7 @@
         constructor(params = {}) {
             super();
             this._serverUrl = "";
-            this._httpClient = new HttpClient("");
+            this.httpClient = new HttpClient("");
             this._user = null;
             this.eventEmitter = this;
             this.configure(params);
@@ -3704,7 +3730,7 @@
          */
         configure(params) {
             this._serverUrl = (params.serverUrl || "").replace(/\/+$/, "");
-            this._httpClient = new HttpClient(this.serverUrl);
+            this.httpClient = new HttpClient(this.serverUrl);
             this._user = null;
             return this;
         }
@@ -3721,13 +3747,13 @@
          * @async
          */
         version() {
-            return this._httpClient
+            return this.httpClient
                 .get("/version")
                 .then((response) => response.json())
                 .then((data) => ({
                 ...data,
                 server: data.version,
-                client: "25.4.2",
+                client: "25.4.4",
             }));
         }
         /**
@@ -3741,7 +3767,7 @@
          *   `username` from email.
          */
         registerUser(email, password, userName) {
-            return this._httpClient
+            return this.httpClient
                 .post("/register", {
                 email,
                 password,
@@ -3758,7 +3784,7 @@
          * @param password - User password.
          */
         resendConfirmationEmail(email, password) {
-            return this._httpClient
+            return this.httpClient
                 .post("/register/email-confirmation", { email, password })
                 .then((response) => response.json());
         }
@@ -3769,7 +3795,7 @@
          * @param emailConfirmationId - Confirmation code from the Confirmation Email.
          */
         confirmUserEmail(emailConfirmationId) {
-            return this._httpClient
+            return this.httpClient
                 .get(`/register/email-confirmation/${emailConfirmationId}`)
                 .then((response) => response.json());
         }
@@ -3782,8 +3808,8 @@
          */
         async signInWithEmail(email, password) {
             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);
         }
@@ -3794,8 +3820,8 @@
          * @param token - An access token for authentication request. See {@link User.token} for more details.
          */
         async signInWithToken(token) {
-            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);
         }
@@ -3807,28 +3833,30 @@
          * - 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.
+         *
+         * @async
          */
         getIdentityProviders() {
-            return this._httpClient.get("/identity").then((response) => response.json());
+            return this.httpClient.get("/identity").then((response) => response.json());
         }
         // Save the current logged in user information for internal use.
         setCurrentUser(data) {
-            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;
         }
         clearCurrentUser() {
             this._user = null;
-            this._httpClient.headers = {};
-            this._httpClient.signInUserId = "";
+            this.httpClient.headers = {};
+            this.httpClient.signInUserId = "";
         }
         /**
          * Returns the current logged in user information. Returns `null` if the user is not logged
          * in or the logged in user has deleted himself.
          */
         getCurrentUser() {
-            if (this._user && !this._httpClient.signInUserId)
+            if (this._user && !this.httpClient.signInUserId)
                 this._user = null;
             return this._user;
         }
@@ -3839,11 +3867,11 @@
          * @async
          */
         getUsers() {
-            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)));
         }
         /**
          * Returns the user information. Only admins can get other users, if the current logged in
@@ -3854,19 +3882,19 @@
          * @param userId - User ID.
          */
         getUser(userId) {
-            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));
             }
         }
         /**
@@ -3889,7 +3917,7 @@
          */
         createUser(email, password, params = {}) {
             const { isAdmin, userName, ...rest } = params;
-            return this._httpClient
+            return this.httpClient
                 .post("/users", {
                 isAdmin,
                 userBrief: {
@@ -3901,7 +3929,7 @@
             })
                 .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));
         }
         /**
          * Delete a user from the server. Only admins can delete users, if the current logged in user
@@ -3917,11 +3945,11 @@
          * @returns Returns the raw data of a deleted user.
          */
         deleteUser(userId) {
-            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;
@@ -3982,13 +4010,13 @@
             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)),
                 };
             });
         }
@@ -3999,10 +4027,10 @@
          * @param fileId - File ID.
          */
         getFile(fileId) {
-            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));
         }
         /**
          * Upload a drawing or reference file to the server.
@@ -4039,14 +4067,14 @@
             properties: false,
             waitForDone: false,
         }) {
-            const result = await this._httpClient
+            const result = await this.httpClient
                 .uploadFile("/files", file, (progress) => {
                 var _a;
                 this.emitEvent({ type: "uploadprogress", data: progress, file });
                 (_a = params.onProgress) === null || _a === void 0 ? void 0 : _a.call(params, progress, file);
             })
                 .then((xhr) => 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";
             const jobs = [];
             if (params.geometry)
@@ -4068,7 +4096,7 @@
          * @returns Returns the raw data of a deleted file.
          */
         deleteFile(fileId) {
-            return this._httpClient.delete(`/files/${fileId}`).then((response) => response.json());
+            return this.httpClient.delete(`/files/${fileId}`).then((response) => response.json());
         }
         /**
          * Download the drawing or reference file.
@@ -4081,7 +4109,7 @@
          *   and abort it if desired.
          */
         downloadFile(fileId, onProgress, signal) {
-            return this._httpClient
+            return this.httpClient
                 .downloadFile(`/files/${fileId}/downloads`, onProgress, signal)
                 .then((response) => response.arrayBuffer());
         }
@@ -4128,12 +4156,12 @@
             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)),
             }));
         }
         /**
@@ -4143,10 +4171,10 @@
          * @param jobId - Job ID.
          */
         getJob(jobId) {
-            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));
         }
         /**
          * Create a new job.
@@ -4167,14 +4195,14 @@
          *   for the File Converter tool in form "--arg=value".
          */
         createJob(fileId, outputFormat, parameters) {
-            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));
         }
         /**
          * Remove a job from the server job list. The method does not delete or stop jobs that are
@@ -4185,7 +4213,7 @@
          * @returns Returns the raw data of a deleted job.
          */
         deleteJob(jobId) {
-            return this._httpClient.delete(`/jobs/${jobId}`).then((response) => response.json());
+            return this.httpClient.delete(`/jobs/${jobId}`).then((response) => response.json());
         }
         /**
          * Result for assembly list.
@@ -4234,13 +4262,13 @@
             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)),
                 };
             });
         }
@@ -4251,10 +4279,10 @@
          * @param assemblyId - Assembly ID.
          */
         getAssembly(assemblyId) {
-            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));
         }
         /**
          * Create a new assembly.
@@ -4267,10 +4295,10 @@
          */
         createAssembly(files, name, params) {
             const { waitForDone } = params !== null && params !== void 0 ? 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));
         }
         /**
@@ -4281,7 +4309,7 @@
          * @returns Returns the raw data of a deleted assembly.
          */
         deleteAssembly(assemblyId) {
-            return this._httpClient.delete(`/assemblies/${assemblyId}`).then((response) => response.json());
+            return this.httpClient.delete(`/assemblies/${assemblyId}`).then((response) => response.json());
         }
         /**
          * Result for project list.
@@ -4326,7 +4354,7 @@
             let queryString = searchParams.toString();
             if (queryString)
                 queryString = "?" + queryString;
-            return this._httpClient
+            return this.httpClient
                 .get(`/projects${queryString}`)
                 .then((response) => response.json())
                 .then((projects) => {
@@ -4354,7 +4382,7 @@
                 .then((projects) => {
                 return {
                     ...projects,
-                    result: projects.result.map((data) => new Project(data, this._httpClient)),
+                    result: projects.result.map((data) => new Project(data, this.httpClient)),
                 };
             });
         }
@@ -4365,10 +4393,10 @@
          * @param projectId - Project ID.
          */
         getProject(projectId) {
-            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));
         }
         /**
          * Create a new project.
@@ -4383,7 +4411,7 @@
          *   target="_blank">Data URL</a>.
          */
         createProject(name, description, startDate, endDate, avatarUrl) {
-            return this._httpClient
+            return this.httpClient
                 .post("/projects", {
                 name,
                 description,
@@ -4392,7 +4420,7 @@
                 avatarUrl,
             })
                 .then((response) => response.json())
-                .then((data) => new Project(data, this._httpClient));
+                .then((data) => new Project(data, this.httpClient));
         }
         /**
          * Delete the project from the server.
@@ -4402,7 +4430,7 @@
          * @returns Returns the raw data of a deleted project.
          */
         deleteProject(projectId) {
-            return this._httpClient
+            return this.httpClient
                 .delete(`/projects/${projectId}`)
                 .then((response) => response.text())
                 .then((text) => {
@@ -4418,11 +4446,12 @@
     }
 
     ///////////////////////////////////////////////////////////////////////////////
-    const version = "25.4.2";
+    const version = "25.4.4";
 
     exports.Assembly = Assembly;
     exports.ClashTest = ClashTest;
     exports.Client = Client;
+    exports.FetchError = FetchError;
     exports.File = File;
     exports.Job = Job;
     exports.Member = Member;
@@ -4432,6 +4461,7 @@
     exports.Role = Role;
     exports.User = User;
     exports.parseArgs = parseArgs;
+    exports.statusText = statusText;
     exports.userFullName = userFullName;
     exports.userInitials = userInitials;
     exports.version = version;