@inweb/client 25.2.2 → 25.2.5

package/lib/Api/Model.d.ts

@@ -1,147 +1,147 @@
-import { IHttpClient } from "./IHttpClient";
-import { File } from "./File";
-import { Assembly } from "./Assembly";
-/**
- * The class representing the is a description of view of the file or 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 {
-    private _data;
-    private _file;
-    httpClient: IHttpClient;
-    path: string;
-    /**
-     * @param data - An object that implements model data storage.
-     * @param file - The `File` of 'Assembly' instance that owns the model.
-     */
-    constructor(data: any, file: File | Assembly);
-    /**
-     * The `Assembly` instance that owns the model.
-     *
-     * @readonly
-     */
-    get assembly(): Assembly;
-    /**
-     * Raw model data received from the server.
-     *
-     * @readonly
-     */
-    get data(): any;
-    private set data(value);
-    /**
-     * Scene description file resource ID. Use {@link Model#downloadResource | downloadResource()}
-     * to download scene description file.
-     *
-     * @readonly
-     */
-    get database(): string;
-    /**
-     * `true` if this is default model.
-     *
-     * @readonly
-     */
-    get default(): boolean;
-    /**
-     * The `File` instance that owns the model.
-     *
-     * @readonly
-     */
-    get file(): File;
-    /**
-     * The ID of the file that owns the model.
-     *
-     * @readonly
-     */
-    get fileId(): string;
-    /**
-     * The list of resource IDs for geometry data files. Use
-     * {@link Model#downloadResource | downloadResource()} to download geometry data files.
-     *
-     * @readonly
-     */
-    get geometry(): string[];
-    /**
-     * Unique model ID.
-     *
-     * @readonly
-     */
-    get id(): string;
-    /**
-     * Model name.
-     *
-     * @readonly
-     */
-    get name(): string;
-    get version(): string;
-    /**
-     * Returns model viewpoint list.
-     *
-     * _**Note**: Assemblу models do not support viewpoints_.
-     *
-     * @async
-     */
-    getViewpoints(): Promise<any[]>;
-    /**
-     * Add new model viewpoint. To create a new viewpoint use
-     * {@link Viewer#createViewpoint | Viewer.createViewpoint()}.
-     *
-     * _**Note**: Assemblу models do not support viewpoints_.
-     *
-     * @async
-     * @param viewpoint - Viewpoint.
-     */
-    saveViewpoint(viewpoint: any): Promise<any>;
-    /**
-     * Delete model viewpoint.
-     *
-     * _**Note**: Assemblу models do not support viewpoints_.
-     *
-     * @async
-     * @param guid - Viewpoint GUID.
-     * @returns Returns the raw data of a deleted viewpoint.
-     */
-    deleteViewpoint(guid: string): Promise<any>;
-    /**
-     * Returns viewpoint preview image as <a
-     * href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-     * target="_blank">Data URL</a>.
-     *
-     * @async
-     * @param guid - Viewpoint GIID.
-     */
-    getSnapshot(guid: string): Promise<string>;
-    /**
-     * Returns snapshot data.
-     *
-     * @async
-     * @param guid - Viewpoint GUID.
-     * @param bitmapGuid - Bitmap GUID.
-     */
-    getSnapshotData(guid: string, bitmapGuid: string): Promise<string>;
-    /**
-     * Downloads model resource, such as scene description file or geometry data files.
-     *
-     * @async
-     * @param resourceId - Resource ID.
-     * @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.
-     */
-    downloadResource(dataId: string, onProgress?: (progress: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
-    partialDownloadResource(dataId: string, onProgress?: (progress: number, downloaded: Uint8Array) => void, signal?: AbortSignal): Promise<void>;
-    downloadFileRange(requestId: number, records: any | null, dataId: string, onProgress?: (progress: number, downloaded: 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.
-     */
-    getReferences(signal?: AbortSignal): Promise<import("./IFile").IFileReferences> | Promise<{
-        fileId: string;
-        references: any[];
-    }>;
-}
+import { IHttpClient } from "./IHttpClient";
+import { File } from "./File";
+import { Assembly } from "./Assembly";
+/**
+ * The class representing the is a description of view of the file or 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 {
+    private _data;
+    private _file;
+    httpClient: IHttpClient;
+    path: string;
+    /**
+     * @param data - An object that implements model data storage.
+     * @param file - The `File` of 'Assembly' instance that owns the model.
+     */
+    constructor(data: any, file: File | Assembly);
+    /**
+     * The `Assembly` instance that owns the model.
+     *
+     * @readonly
+     */
+    get assembly(): Assembly;
+    /**
+     * Raw model data received from the server.
+     *
+     * @readonly
+     */
+    get data(): any;
+    private set data(value);
+    /**
+     * Scene description file resource ID. Use {@link Model#downloadResource | downloadResource()}
+     * to download scene description file.
+     *
+     * @readonly
+     */
+    get database(): string;
+    /**
+     * `true` if this is default model.
+     *
+     * @readonly
+     */
+    get default(): boolean;
+    /**
+     * The `File` instance that owns the model.
+     *
+     * @readonly
+     */
+    get file(): File;
+    /**
+     * The ID of the file that owns the model.
+     *
+     * @readonly
+     */
+    get fileId(): string;
+    /**
+     * The list of resource IDs for geometry data files. Use
+     * {@link Model#downloadResource | downloadResource()} to download geometry data files.
+     *
+     * @readonly
+     */
+    get geometry(): string[];
+    /**
+     * Unique model ID.
+     *
+     * @readonly
+     */
+    get id(): string;
+    /**
+     * Model name.
+     *
+     * @readonly
+     */
+    get name(): string;
+    get version(): string;
+    /**
+     * Returns model viewpoint list.
+     *
+     * _**Note**: Assemblу models do not support viewpoints_.
+     *
+     * @async
+     */
+    getViewpoints(): Promise<any[]>;
+    /**
+     * Add new model viewpoint. To create a new viewpoint use
+     * {@link Viewer#createViewpoint | Viewer.createViewpoint()}.
+     *
+     * _**Note**: Assemblу models do not support viewpoints_.
+     *
+     * @async
+     * @param viewpoint - Viewpoint.
+     */
+    saveViewpoint(viewpoint: any): Promise<any>;
+    /**
+     * Delete model viewpoint.
+     *
+     * _**Note**: Assemblу models do not support viewpoints_.
+     *
+     * @async
+     * @param guid - Viewpoint GUID.
+     * @returns Returns the raw data of a deleted viewpoint.
+     */
+    deleteViewpoint(guid: string): Promise<any>;
+    /**
+     * Returns viewpoint preview image as <a
+     * href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
+     * target="_blank">Data URL</a>.
+     *
+     * @async
+     * @param guid - Viewpoint GIID.
+     */
+    getSnapshot(guid: string): Promise<string>;
+    /**
+     * Returns snapshot data.
+     *
+     * @async
+     * @param guid - Viewpoint GUID.
+     * @param bitmapGuid - Bitmap GUID.
+     */
+    getSnapshotData(guid: string, bitmapGuid: string): Promise<string>;
+    /**
+     * Downloads model resource, such as scene description file or geometry data files.
+     *
+     * @async
+     * @param resourceId - Resource ID.
+     * @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.
+     */
+    downloadResource(dataId: string, onProgress?: (progress: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
+    partialDownloadResource(dataId: string, onProgress?: (progress: number, downloaded: Uint8Array) => void, signal?: AbortSignal): Promise<void>;
+    downloadFileRange(requestId: number, records: any | null, dataId: string, onProgress?: (progress: number, downloaded: 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.
+     */
+    getReferences(signal?: AbortSignal): Promise<import("./IFile").IFileReferences> | Promise<{
+        fileId: string;
+        references: any[];
+    }>;
+}
 //# sourceMappingURL=Model.d.ts.map

package/lib/Api/Permission.d.ts

@@ -1,93 +1,93 @@
-import { IHttpClient } from "./IHttpClient";
-/**
- * A permission provides information about {@link File | file} sharing granted to a specific
- * {@link User | users}, group, or project {@link Member | member}.
- */
-export declare class Permission {
-    private _data;
-    protected fileId: string;
-    protected httpClient: IHttpClient;
-    /**
-     * @param data - An object that implements permission data storage.
-     * @param fileId - Owner file ID.
-     * @param httpClient - Http client.
-     */
-    constructor(data: any, fileId: string, httpClient: IHttpClient);
-    private internalGet;
-    private internalPut;
-    private internalDelete;
-    /**
-     * Defines what actions are allowed to be performed on a file with this permission:
-     *
-     * - `read` - The ability to read file description, geometry data and properties
-     * - `readSourceFile` - The ability to read source file
-     * - `write` - The ability to modify file name, description and references
-     * - `readViewpoint` - The ability to read file viewpoints
-     * - `createViewpoint` - The ability to create file viewpoints
-     */
-    get actions(): string[];
-    set actions(value: string[]);
-    /**
-     * Raw permission data received from the server.
-     *
-     * @readonly
-     */
-    get data(): any;
-    private set data(value);
-    /**
-     * Unique permission ID.
-     *
-     * @readonly
-     */
-    get id(): string;
-    /**
-     * Principials are any entity that can be authenticated by the server, such as a any user or
-     * project that will get access to the file.
-     *
-     * @typedef {any} Principial
-     * @property {any} user - The user entry that get access to the file.
-     * @property {string} user.id - User ID.
-     * @property {string} user.name - User name.
-     * @property {any} project - The project entry that get access to the file.
-     * @property {string} project.id - Project ID.
-     * @property {string} project.name - Project name.
-     */
-    /**
-     * A collection of principials that will get access to the file.
-     */
-    get grantedTo(): any[];
-    set grantedTo(value: any[]);
-    /**
-     * Specifies whether all users have access to the file or not.
-     */
-    get public(): boolean;
-    set public(value: boolean);
-    /**
-     * Refresh permission data.
-     *
-     * @async
-     */
-    checkout(): Promise<Permission>;
-    /**
-     * Update permission data on the server.
-     *
-     * @async
-     * @param data - Raw permission data.
-     */
-    update(data: any): Promise<Permission>;
-    /**
-     * 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<Permission>;
-}
+import { IHttpClient } from "./IHttpClient";
+/**
+ * A permission provides information about {@link File | file} sharing granted to a specific
+ * {@link User | users}, group, or project {@link Member | member}.
+ */
+export declare class Permission {
+    private _data;
+    protected fileId: string;
+    protected httpClient: IHttpClient;
+    /**
+     * @param data - An object that implements permission data storage.
+     * @param fileId - Owner file ID.
+     * @param httpClient - Http client.
+     */
+    constructor(data: any, fileId: string, httpClient: IHttpClient);
+    private internalGet;
+    private internalPut;
+    private internalDelete;
+    /**
+     * Defines what actions are allowed to be performed on a file with this permission:
+     *
+     * - `read` - The ability to read file description, geometry data and properties
+     * - `readSourceFile` - The ability to read source file
+     * - `write` - The ability to modify file name, description and references
+     * - `readViewpoint` - The ability to read file viewpoints
+     * - `createViewpoint` - The ability to create file viewpoints
+     */
+    get actions(): string[];
+    set actions(value: string[]);
+    /**
+     * Raw permission data received from the server.
+     *
+     * @readonly
+     */
+    get data(): any;
+    private set data(value);
+    /**
+     * Unique permission ID.
+     *
+     * @readonly
+     */
+    get id(): string;
+    /**
+     * Principials are any entity that can be authenticated by the server, such as a any user or
+     * project that will get access to the file.
+     *
+     * @typedef {any} Principial
+     * @property {any} user - The user entry that get access to the file.
+     * @property {string} user.id - User ID.
+     * @property {string} user.name - User name.
+     * @property {any} project - The project entry that get access to the file.
+     * @property {string} project.id - Project ID.
+     * @property {string} project.name - Project name.
+     */
+    /**
+     * A collection of principials that will get access to the file.
+     */
+    get grantedTo(): any[];
+    set grantedTo(value: any[]);
+    /**
+     * Specifies whether all users have access to the file or not.
+     */
+    get public(): boolean;
+    set public(value: boolean);
+    /**
+     * Refresh permission data.
+     *
+     * @async
+     */
+    checkout(): Promise<Permission>;
+    /**
+     * Update permission data on the server.
+     *
+     * @async
+     * @param data - Raw permission data.
+     */
+    update(data: any): Promise<Permission>;
+    /**
+     * 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<Permission>;
+}
 //# sourceMappingURL=Permission.d.ts.map