@inweb/client 26.1.2 → 26.1.4

package/lib/Api/Model.d.ts

@@ -5,8 +5,8 @@ import type { IFileReferences } from "./IFile";
 import type { IModelTransformMatrix } from "./IAssembly";
 /**
  * Provides properties and methods for working with view of the {@link File | file} or
- * {@link Assembly| assembly}. For example, for `dwg` it is a `Model` space or layout, and for `rvt` files
- * it is a `3D` view.
+ * {@link Assembly| assembly}. For example, for `dwg` it is a `Model` space or layout, and for
+ * `rvt` files it is a `3D` view.
  */
 export declare class Model extends Endpoint {
     private _data;
@@ -30,8 +30,8 @@ export declare class Model extends Endpoint {
     get data(): any;
     private set data(value);
     /**
-     * Scene description resource file name. Use {@link downloadResource | downloadResource()} to download
-     * scene description file.
+     * Scene description resource file name. Use {@link downloadResource | downloadResource()} to
+     * download scene description file.
      *
      * @readonly
      */
@@ -55,8 +55,8 @@ export declare class Model extends Endpoint {
      */
     get fileId(): string;
     /**
-     * The list of geometry data resource files. Use {@link downloadResource | downloadResource()} to
-     * download geometry data files.
+     * The list of geometry data resource files. Use {@link downloadResource | downloadResource()}
+     * to download geometry data files.
      *
      * @readonly
      */
@@ -103,8 +103,8 @@ export declare class Model extends Endpoint {
      */
     getViewpoints(): Promise<any[]>;
     /**
-     * Saves a new model owner file/assembly viewpoint to the server. To create a new viewpoint use
-     * `Viewer.createViewpoint()`.
+     * Saves a new model owner file/assembly viewpoint to the server. To create a new viewpoint
+     * use `Viewer.createViewpoint()`.
      *
      * @param viewpoint - Viewpoint object.
      */
@@ -131,27 +131,27 @@ export declare class Model extends Endpoint {
      */
     getSnapshotData(guid: string, bitmapGuid: string): Promise<string>;
     /**
-     * Downloads a resource file. Resource files are files that contain model scene descriptions, or
-     * geometry data.
+     * Downloads a resource file. Resource files are files that contain model scene descriptions,
+     * or geometry data.
      *
      * @param dataId - Resource file name.
      * @param onProgress - Download progress callback.
      * @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.
+     *   {@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>;
     /**
-     * Downloads a part of resource file. Resource files are files that contain model scene descriptions,
-     * or geometry data.
+     * Downloads a part of resource file. Resource files are files that contain model scene
+     * descriptions, or geometry data.
      *
      * @param dataId - Resource file name.
      * @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
-     *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal. Allows
-     *   to communicate with a fetch request and abort it if desired.
+     *   {@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;
@@ -176,8 +176,8 @@ export declare class Model extends Endpoint {
      * References are images, fonts, or any other files to correct rendering of the file.
      *
      * @param signal - An
-     *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal, which
-     *   can be used to abort waiting as desired.
+     *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+     *   signal, which can be used to abort waiting as desired.
      */
     getReferences(signal?: AbortSignal): Promise<IFileReferences>;
 }

package/lib/Api/OAuthClient.d.ts

@@ -1,8 +1,8 @@
 import { IHttpClient } from "./IHttpClient";
 import { Endpoint } from "./Endpoint";
 /**
- * Provides properties and methods for obtaining information about a OAuth 2.0 client that have access
- * the Open Cloud Server API.
+ * Provides properties and methods for obtaining information about a OAuth 2.0 client that have
+ * access the Open Cloud Server API.
  */
 export declare class OAuthClient extends Endpoint {
     private _data;
@@ -72,8 +72,8 @@ export declare class OAuthClient extends Endpoint {
     /**
      * Updates client data on the server.
      *
-     * Only administrators can update OAuth clients. If the current logged in user is not an administrator,
-     * an exception will be thrown.
+     * Only administrators can update OAuth clients. If the current logged in user is not an
+     * administrator, an exception will be thrown.
      *
      * @param data - Raw client data. For more information, see
      *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#OAuthClient | Open Cloud OAuth Clients API}.
@@ -82,19 +82,19 @@ export declare class OAuthClient extends Endpoint {
     /**
      * Deletes a client from the server.
      *
-     * Only administrators can delete OAuth clients. If the current logged in user is not an administrator,
-     * an exception will be thrown.
+     * Only administrators can delete OAuth clients. If the current logged in user is not an
+     * administrator, an exception will be thrown.
      *
      * @returns Returns the raw data of a deleted client. For more information, see
      *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#OAuthClient | Open Cloud OAuth Clients API}.
      */
     delete(): Promise<any>;
     /**
-     * Saves client properties changes to the server. Call this method to update client data on the server
-     * after any property changes.
+     * Saves client properties changes to the server. Call this method to update client data on
+     * the server after any property changes.
      *
-     * Only administrators can update OAuth clients. If the current logged in user is not an administrator,
-     * an exception will be thrown.
+     * Only administrators can update OAuth clients. If the current logged in user is not an
+     * administrator, an exception will be thrown.
      */
     save(): Promise<this>;
     /**

package/lib/Api/Permission.d.ts

@@ -2,8 +2,8 @@ import { IHttpClient } from "./IHttpClient";
 import { Endpoint } from "./Endpoint";
 import { IGrantedTo } from "./IFile";
 /**
- * Provides properties and methods for obtaining information about {@link File | file} actions granted to
- * a specific user, project, or group.
+ * Provides properties and methods for obtaining information about {@link File | file} actions
+ * granted to a specific user, project, or group.
  */
 export declare class Permission extends Endpoint {
     private _data;
@@ -23,22 +23,19 @@ export declare class Permission extends Endpoint {
      * - `readViewpoint` - The ability to read file viewpoints.
      * - `createViewpoint` - The ability to create file viewpoints.
      *
-     * @example Change file permissions for the the specified project.
-     *
-     * ```javascript
-     * const myFile = client.getFile(myFileId);
-     * const permissions = await myFile.getPermissions();
-     * const projectPermissions = permissions.filter((permission) =>
-     *   permission.grantedTo.some((x) => x.project?.id === myProjectId)
-     * );
-     * const newActions = ["read", "readSourceFile", "update"];
-     * await Promise.all(
-     *   projectPermissions.map((permission) => {
-     *     permission.actions = newActions;
-     *     return permission.save();
-     *   })
-     * );
-     * ```
+     * @example <caption>Change file permissions for the the specified project.</caption>
+     *   const myFile = client.getFile(myFileId);
+     *   const permissions = await myFile.getPermissions();
+     *   const projectPermissions = permissions.filter((permission) =>
+     *     permission.grantedTo.some((x) => x.project?.id === myProjectId)
+     *   );
+     *   const newActions = ["read", "readSourceFile", "update"];
+     *   await Promise.all(
+     *     projectPermissions.map((permission) => {
+     *       permission.actions = newActions;
+     *       return permission.save();
+     *     })
+     *   );
      */
     get actions(): string[];
     set actions(value: string[]);
@@ -85,8 +82,8 @@ export declare class Permission extends Endpoint {
      */
     delete(): Promise<any>;
     /**
-     * Saves permission properties changes to the server. Call this method to update permission data on the
-     * server after any property changes.
+     * Saves permission properties changes to the server. Call this method to update permission
+     * data on the server after any property changes.
      */
     save(): Promise<this>;
 }

package/lib/Api/Project.d.ts

@@ -6,8 +6,8 @@ import { IRoleActions } from "./IRole";
 import { Member } from "./Member";
 import { File } from "./File";
 /**
- * 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.
+ * 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 declare class Project extends Endpoint {
     private _data;
@@ -142,19 +142,20 @@ export declare class Project extends Endpoint {
      */
     delete(): Promise<any>;
     /**
-     * Saves project properties changes to the server. Call this method to update project data on the
-     * server after any property changes.
+     * Saves project properties changes to the server. Call this method to update project data on
+     * the server after any property changes.
      */
     save(): Promise<this>;
     /**
      * Sets or removes the project preview.
      *
      * @param image - Preview image. Can be a
-     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL} string,
+     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
+     *   string,
      *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
      *   {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or
-     *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting the `image`
-     *   to `null` will remove the preview.
+     *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting
+     *   the `image` to `null` will remove the preview.
      */
     setPreview(image?: BodyInit | null): Promise<this>;
     /**
@@ -162,8 +163,8 @@ export declare class Project extends Endpoint {
      */
     deletePreview(): Promise<this>;
     /**
-     * Returns a list of project roles. Project members have different abilities depending on the role they
-     * have in a project.
+     * Returns a list of project roles. Project members have different abilities depending on the
+     * role they have in a project.
      */
     getRoles(): Promise<Role[]>;
     /**
@@ -217,8 +218,8 @@ export declare class Project extends Endpoint {
      * Information about the file (model) that can be reference in the project topics.
      *
      * @typedef {any} FileInformation
-     * @property {any[]} display_information - The list of fields to allow users to associate the file with
-     *   a server model.
+     * @property {any[]} display_information - The list of fields to allow users to associate the
+     *   file with a server model.
      * @property {string} display_information.field_display_name - Field display name.
      * @property {string} display_information.field_value - Field value.
      * @property {any} file - The file reference object.
@@ -229,8 +230,8 @@ export declare class Project extends Endpoint {
      * Returns a list of project files. For more information, see
      * {@link https://cloud.opendesign.com/docs//pages/server/bcf3.html#ProjectFilesInformation | Open Cloud BCF3 API}.
      *
-     * This list contains all files that the project has access to. To add a file to this list, create a
-     * {@link IGrantedTo.project | project} permission on the file using
+     * This list contains all files that the project has access to. To add a file to this list,
+     * create a {@link IGrantedTo.project | project} permission on the file using
      * {@link File.createPermission | File.createPermission()}.
      */
     getFilesInformation(): Promise<any[]>;

package/lib/Api/Role.d.ts

@@ -57,8 +57,8 @@ export declare class Role extends Endpoint {
      */
     delete(): Promise<any>;
     /**
-     * Saves role properties changes to the server. Call this method to update role data on the server
-     * after any property changes.
+     * Saves role properties changes to the server. Call this method to update role data on the
+     * server after any property changes.
      */
     save(): Promise<this>;
 }

package/lib/Api/SharedLink.d.ts

@@ -63,8 +63,8 @@ export declare class SharedLink extends Endpoint {
      */
     delete(): Promise<any>;
     /**
-     * Saves shared link properties changes to the server. Call this method to update shared link data on
-     * the server after any property changes.
+     * 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>;
 }

package/lib/Api/User.d.ts

@@ -1,8 +1,8 @@
 import { IHttpClient } from "./IHttpClient";
 import { Endpoint } from "./Endpoint";
 /**
- * Provides properties and methods for obtaining information about a Open Cloud Server user and manage
- * its data.
+ * Provides properties and methods for obtaining information about a Open Cloud Server user and
+ * manage its data.
  */
 export declare class User extends Endpoint {
     private _data;
@@ -66,8 +66,8 @@ export declare class User extends Endpoint {
     get firstName(): string;
     set firstName(value: string);
     /**
-     * Full name. Returns the user's first and last name. If first name and last names are empty, returns
-     * the user name.
+     * Full name. Returns the user's first and last name. If first name and last names are empty,
+     * returns the user name.
      *
      * @readonly
      */
@@ -79,8 +79,8 @@ export declare class User extends Endpoint {
      */
     get id(): string;
     /**
-     * User initials. Returns a first letters of the user's first and last names. If first name and last
-     * names are empty, returns the first letter of the user name.
+     * User initials. Returns a first letters of the user's first and last names. If first name
+     * and last names are empty, returns the first letter of the user name.
      *
      * @readonly
      */
@@ -121,8 +121,8 @@ export declare class User extends Endpoint {
     get projectsLimit(): number;
     set projectsLimit(value: number);
     /**
-     * The identity provider used to create the account. Can be `ldap`, `oauth`, `saml` or empty for local
-     * accounts.
+     * The identity provider used to create the account. Can be `ldap`, `oauth`, `saml` or empty
+     * for local accounts.
      *
      * @readonly
      */
@@ -141,8 +141,8 @@ export declare class User extends Endpoint {
      */
     get storageUsed(): number;
     /**
-     * The user's access token (API key). Use {@link Client.signInWithToken | Client.signInWithToken()} to
-     * sign in to the server using this token.
+     * The user's access token (API key). Use
+     * {@link Client.signInWithToken | Client.signInWithToken()} to sign in to the server using this token.
      *
      * @readonly
      */
@@ -155,15 +155,15 @@ export declare class User extends Endpoint {
     /**
      * Reloads user data from the server.
      *
-     * Only administrators can checkout other users. If the current logged in user is not an administrator,
-     * they can only checkout themselves, otherwise an exception will be thrown.
+     * Only administrators can checkout other users. If the current logged in user is not an
+     * administrator, they can only checkout themselves, otherwise an exception will be thrown.
      */
     checkout(): Promise<this>;
     /**
      * Updates user data on the server.
      *
-     * 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.
+     * 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.
      *
      * @param data - Raw user data. For more information, see
      *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Users | Open Cloud Users API}.
@@ -172,11 +172,11 @@ export declare class User extends Endpoint {
     /**
      * Deletes a user from the server.
      *
-     * Only administrators can delete users. If the current logged in user is not an administrator, an
-     * exception will be thrown.
+     * Only administrators can delete users. If the current logged in user is not an
+     * administrator, an exception will be thrown.
      *
-     * Administrators can delete themselves or other administrators. An administrator can only delete
-     * themself if they is not the last administrator.
+     * Administrators can delete themselves or other administrators. An administrator can only
+     * delete themself if they is not the last administrator.
      *
      * You need to re-login after deleting the current logged in user.
      *
@@ -185,42 +185,44 @@ export declare class User extends Endpoint {
      */
     delete(): Promise<any>;
     /**
-     * Saves user properties changes to the server. Call this method to update user data on the server
-     * after any property changes.
+     * Saves user properties changes to the server. Call this method to update user data on the
+     * server after any property changes.
      */
     save(): Promise<this>;
     /**
      * Sets or removes the user avatar.
      *
-     * 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.
+     * 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.
      *
      * @param image - Avatar image. Can be a
-     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL} string,
+     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
+     *   string,
      *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
      *   {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or
-     *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting the `image`
-     *   to `null` will remove the avatar.
+     *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting
+     *   the `image` to `null` will remove the avatar.
      */
     setAvatar(image?: BodyInit | null): Promise<this>;
     /**
      * Removes the user avatar.
      *
-     * 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.
+     * 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.
      */
     deleteAvatar(): Promise<this>;
     /**
      * Changes the user password.
      *
-     * Only administrators can change the passwords of other users. If the current logged in user is not an
-     * administrator, they can only change their password, otherwise an exception will be thrown.
+     * Only administrators can change the passwords of other users. If the current logged in user
+     * is not an administrator, they can only change their password, otherwise an exception will
+     * be thrown.
      *
      * To change their password, non-administrator users must specify their old password.
      *
      * @param newPassword - New user password.
-     * @param oldPassword - Old user password. Only required for non-administrator users to change their
-     *   password.
+     * @param oldPassword - Old user password. Only required for non-administrator users to
+     *   change their password.
      */
     changePassword(newPassword: string, oldPassword?: string): Promise<this>;
 }

package/package.json

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