@inweb/client 25.7.0 → 25.7.2

package/lib/Api/Model.d.ts

@@ -29,8 +29,8 @@ export declare class Model {
     get data(): any;
     private set data(value);
     /**
-     * Scene description resource file name. Use {@link Model.downloadResource()} to download
-     * scene description file.
+     * Scene description resource file name. Use {@link downloadResource | downloadResource()} to
+     * download scene description file.
      *
      * @readonly
      */
@@ -54,8 +54,8 @@ export declare class Model {
      */
     get fileId(): string;
     /**
-     * The list of geometry data resource files. Use {@link Model.downloadResource()} to download
-     * geometry data files.
+     * The list of geometry data resource files. Use {@link downloadResource | downloadResource()}
+     * to download geometry data files.
      *
      * @readonly
      */
@@ -82,8 +82,6 @@ export declare class Model {
     get version(): string;
     /**
      * Returns model list with one item `self`.
-     *
-     * @async
      */
     getModels(): Promise<Model[]>;
     /**
@@ -95,28 +93,23 @@ export declare class Model {
     /**
      * Set or delete a model transformation.
      *
-     * @async
      * @param handle - Model handle.
      * @param transform - Transformation matrix. To delete transformation provide this to `undefined`.
      */
     setModelTransformMatrix(handle: string, transform: any): Promise<this>;
     /**
      * Returns model viewpoint list.
-     *
-     * @async
      */
     getViewpoints(): Promise<any[]>;
     /**
      * Add new model viewpoint. To create a new viewpoint use `Viewer.createViewpoint()`.
      *
-     * @async
      * @param viewpoint - Viewpoint.
      */
     saveViewpoint(viewpoint: any): Promise<any>;
     /**
      * Delete model viewpoint.
      *
-     * @async
      * @param guid - Viewpoint GUID.
      * @returns Returns the raw data of a deleted viewpoint.
      */
@@ -125,14 +118,12 @@ export declare class Model {
      * 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.
      */
     getSnapshot(guid: string): Promise<string>;
     /**
      * Returns snapshot data.
      *
-     * @async
      * @param guid - Viewpoint GUID.
      * @param bitmapGuid - Bitmap GUID.
      */
@@ -141,12 +132,11 @@ export declare class Model {
      * Download model resource file. Resource files are files that contain model scene
      * descriptions, or geometry data.
      *
-     * @async
      * @param dataId - Resource file name.
      * @param onProgress - Download progress callback.
-     * @param signal - An <a href="https://developer.mozilla.org/docs/Web/API/AbortSignal" target
-     *   ="_blank">AbortSignal</a> object instance. Allows to communicate with a fetch request
-     *   and abort it if desired.
+     * @param signal - An
+     *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+     *   signal. Allows to communicate with a fetch request and abort it if desired.
      */
     downloadResource(dataId: string, onProgress?: (progress: number, chunk: Uint8Array) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
     /**
@@ -157,9 +147,9 @@ export declare class Model {
      * @param ranges - A range of resource file contents to download.
      * @param requestId - Request ID for download progress callback.
      * @param onProgress - Download progress callback.
-     * @param signal - An <a href="https://developer.mozilla.org/docs/Web/API/AbortSignal" target
-     *   ="_blank">AbortSignal</a> object instance. Allows to communicate with a fetch request
-     *   and abort it if desired.
+     * @param signal - An
+     *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+     *   signal. Allows to communicate with a fetch request and abort it if desired.
      */
     downloadResourceRange(dataId: string, requestId: number, ranges: Array<{
         begin: number;
@@ -167,20 +157,23 @@ export declare class Model {
         requestId: number;
     }>, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
     /**
-     * Deprecated since `25.3`. Use {@link Model.downloadResource()} instead.
+     * Deprecated since `25.3`. Use {@link downloadResource | downloadResource()} instead.
+     *
+     * @deprecated
      */
     partialDownloadResource(dataId: string, onProgress?: (progress: number, chunk: Uint8Array) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
     /**
-     * Deprecated since `25.3`. Use {@link Model.downloadResourceRange()} instead.
+     * Deprecated since `25.3`. Use {@link downloadResourceRange | downloadResourceRange()} instead.
+     *
+     * @deprecated
      */
     downloadFileRange(requestId: number, records: any | null, dataId: string, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<void>;
     /**
      * Returns a list of references to files used to extract geometry data.
      *
-     * @async
-     * @param [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 signal - An
+     *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+     *   signal, which can be used to abort waiting as desired.
      */
     getReferences(signal?: AbortSignal): Promise<any>;
 }

package/lib/Api/Permission.d.ts

@@ -64,29 +64,23 @@ export declare class Permission {
     set public(value: boolean);
     /**
      * Refresh permission data.
-     *
-     * @async
      */
     checkout(): Promise<this>;
     /**
      * Update permission data on the server.
      *
-     * @async
      * @param data - Raw permission data.
      */
     update(data: any): Promise<this>;
     /**
      * Remove a permission from a file.
      *
-     * @async
      * @returns Returns the raw data of a deleted permission.
      */
     delete(): Promise<any>;
     /**
      * Save permission data changes to the server. Call this method to update permission data on
      * the server after any changes.
-     *
-     * @async
      */
     save(): Promise<this>;
 }

package/lib/Api/Project.d.ts

@@ -26,8 +26,8 @@ export declare class Project {
      */
     get authorization(): any;
     /**
-     * Project creation time (UTC) in the format specified in <a
-     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     * Project creation time (UTC) in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
      *
      * @readonly
      */
@@ -50,8 +50,8 @@ export declare class Project {
     get description(): string;
     set description(value: string);
     /**
-     * Project end date in the format specified in <a
-     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     * Project end date in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
      */
     get endDate(): string;
     set endDate(value: string | Date);
@@ -105,8 +105,8 @@ export declare class Project {
     get public(): boolean;
     set public(value: boolean);
     /**
-     * Project start date in the format specified in <a
-     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     * Project start date in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
      */
     get startDate(): string;
     set startDate(value: string | Date);
@@ -117,43 +117,36 @@ export declare class Project {
      */
     get topicCount(): number;
     /**
-     * Project last update time (UTC) in the format specified in <a
-     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     * Project last update time (UTC) in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
      *
      * @readonly
      */
     get updatedAt(): string;
     /**
      * Refresh project data.
-     *
-     * @async
      */
     checkout(): Promise<this>;
     /**
      * Update project data on the server.
      *
-     * @async
      * @param data - Raw project data.
      */
     update(data: any): Promise<this>;
     /**
      * Delete the project from the server.
      *
-     * @async
      * @returns Returns the raw data of a deleted project.
      */
     delete(): Promise<any>;
     /**
      * Save project data changes to the server. Call this method to update project data on the
      * server after any changes.
-     *
-     * @async
      */
     save(): Promise<this>;
     /**
      * Set or remove the project preview.
      *
-     * @async
      * @param image - Preview image. Can be a
      *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
      *   string,
@@ -165,59 +158,48 @@ export declare class Project {
     setPreview(image?: BodyInit | null): Promise<any>;
     /**
      * Remove the project preview.
-     *
-     * @async
      */
     deletePreview(): Promise<this>;
     /**
-     * Returns a list of project roles. Project {@link Member | members} have different abilities
-     * depending on the role they have in a project.
-     *
-     * @async
+     * Returns a list of project roles. Project members have different abilities depending on the
+     * role they have in a project.
      */
     getRoles(): Promise<Role[]>;
     /**
      * Returns the role information.
      *
-     * @async
      * @param name - Role name.
      */
     getRole(name: string): Promise<Role>;
     /**
      * Create a new project role.
      *
-     * @async
      * @param name - Role name.
      * @param description - Role description.
-     * @param permissions - Actions are allowed to be performed. See
-     *   {@link Role#permissions | Role.permissions} for more details.
+     * @param permissions - Actions are allowed to be performed. See {@link Role.permissions} for
+     *   more details.
      */
     createRole(name: string, description: string, permissions: any): Promise<Role>;
     /**
      * Delete project role.
      *
-     * @async
      * @param name - Role name.
      * @returns Returns the raw data of a deleted role.
      */
     deleteRole(name: string): Promise<any>;
     /**
      * Returns a list of project members.
-     *
-     * @async
      */
     getMembers(): Promise<Member[]>;
     /**
      * Returns the member information.
      *
-     * @async
      * @param memberId - Member ID.
      */
     getMember(memberId: string): Promise<Member>;
     /**
      * Add a user to the project to become a member and have permission to perform actions.
      *
-     * @async
      * @param userId - User ID.
      * @param role - User role from the list of project roles.
      */
@@ -225,7 +207,6 @@ export declare class Project {
     /**
      * Remove a member from a project.
      *
-     * @async
      * @param memberId - Member ID.
      * @returns Returns the raw data of a deleted member.
      */
@@ -244,9 +225,7 @@ export declare class Project {
      */
     /**
      * Returns a list of project files. To add a file to this list, create a `project` permission
-     * on the file using {@link File#createPermission | File.createPermission()}.
-     *
-     * @async
+     * on the file using {@link File.createPermission | File.createPermission()}.
      */
     getFilesInformation(): Promise<any[]>;
 }

package/lib/Api/Role.d.ts

@@ -53,29 +53,23 @@ export declare class Role {
     set permissions(value: any);
     /**
      * Refresh role data.
-     *
-     * @async
      */
     checkout(): Promise<this>;
     /**
      * Update role data on the server.
      *
-     * @async
      * @param data - Raw role data.
      */
     update(data: any): Promise<this>;
     /**
      * Delete a role from the project.
      *
-     * @async
      * @returns Returns the raw data of a deleted role.
      */
     delete(): Promise<any>;
     /**
      * Save role data changes to the server. Call this method to update role data on the server
      * after any changes.
-     *
-     * @async
      */
     save(): Promise<this>;
 }

package/lib/Api/User.d.ts

@@ -12,7 +12,7 @@ export declare class User {
     constructor(data: any, httpClient: IHttpClient);
     /**
      * User avatar image URL or empty string if the user does not have an avatar. Use
-     * {@link User.setAvatar | setAvatar()} to change avatar image.
+     * {@link setAvatar | setAvatar()} to change avatar image.
      *
      * @readonly
      */
@@ -134,7 +134,8 @@ export declare class User {
      */
     get storageUsed(): number;
     /**
-     * The user's access token (API key). Use {@link Client.signInWithToken()} to log in using token.
+     * The user's access token (API key). Use {@link signInWithToken | Client.signInWithToken()}
+     * to log in using token.
      *
      * @readonly
      */
@@ -157,7 +158,6 @@ export declare class User {
      * Only administrators can update other users. If the current logged in user is not an
      * administrator, they can only update themself, otherwise an exception will be thrown.
      *
-     * @async
      * @param data - Raw user data.
      */
     update(data: any): Promise<this>;
@@ -172,15 +172,12 @@ export declare class User {
      *
      * You need to re-login to continue working after deleting the current logged in user.
      *
-     * @async
      * @returns Returns the raw data of a deleted user.
      */
     delete(): Promise<any>;
     /**
      * Save user data changes to the server. Call this method to update user data on the server
      * after any changes.
-     *
-     * @async
      */
     save(): Promise<this>;
     /**
@@ -189,7 +186,6 @@ export declare class User {
      * Only administrators can set the avatar of other users. If the current logged in user is
      * not an administrator, they can only set their avatar, otherwise an exception will be thrown.
      *
-     * @async
      * @param image - Avatar image. Can be a
      *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
      *   string,
@@ -204,8 +200,6 @@ export declare class User {
      *
      * Only administrators can remove the avatar of other users. If the current logged in user is
      * not an administrator, they can only remove their avatar, otherwise an exception will be thrown.
-     *
-     * @async
      */
     deleteAvatar(): Promise<this>;
     /**
@@ -217,7 +211,6 @@ export declare class User {
      *
      * To change their password, non-administrator users must provide their old password.
      *
-     * @async
      * @param newPassword - New user password.
      * @param oldPassword - Old user password. Only required for non-administrator users to
      *   change their password.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.7.0",
+  "version": "25.7.2",
   "description": "JavaScript REST API client for the Open Cloud Server",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -23,9 +23,9 @@
   "scripts": {
     "build": "rollup -c rollup.config.js",
     "test": "karma start karma.conf.js",
-    "ts-docs": "typedoc"
+    "docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "~25.7.0"
+    "@inweb/eventemitter2": "~25.7.2"
   }
 }