@inweb/client 25.2.2

package/lib/Api/Job.d.ts

@@ -0,0 +1,142 @@
+import { IHttpClient } from "./IHttpClient";
+/**
+ * The class representing a `job` entity describes the process of converting a file from one
+ * format to another, to obtain geometric data, validate the file, or run a clash test.
+ */
+export declare class Job {
+    private _data;
+    protected httpClient: IHttpClient;
+    /**
+     * @param data - An object that implements job data storage.
+     * @param httpClient - Http client.
+     */
+    constructor(data: any, httpClient: IHttpClient);
+    protected internalGet(): Promise<Response>;
+    protected internalPut(body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null): Promise<Response>;
+    protected internalDelete(): Promise<Response>;
+    /**
+     * The ID of the assembly the job is working on (internal).
+     *
+     * @readonly
+     */
+    get assemblyId(): string;
+    /**
+     * Job creator ID. Use {@link Client#getUser | Client.getUser()} to obtain detailed creator information.
+     *
+     * @readonly
+     */
+    get authorId(): string;
+    /**
+     * Job creation time (UTC) in the format specified in <a
+     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     *
+     * @readonly
+     */
+    get createdAt(): string;
+    /**
+     * Raw job data received from the server.
+     *
+     * @readonly
+     */
+    get data(): any;
+    private set data(value);
+    /**
+     * `true` if job is `done` or `failed`. See {@link Job#status | status} for more details.
+     *
+     * @readonly
+     */
+    get done(): boolean;
+    /**
+     * The ID of the file the job is working on.
+     *
+     * @readonly
+     */
+    get fileId(): string;
+    /**
+     * Unique job ID.
+     *
+     * @readonly
+     */
+    get id(): string;
+    /**
+     * Job last update (UTC) time in the format specified in <a
+     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     *
+     * @readonly
+     */
+    get lastUpdate(): string;
+    /**
+     * Job type. Can be `properties`, `geomerty`, `geomertyGltf`, `validation`, `clash`, `dwg`,
+     * `obj`, `gltf`, `glb`, `vsf`, `pdf` or `3dpdf`.
+     *
+     * @readonly
+     */
+    get outputFormat(): string;
+    /**
+     * Parameters for the job runner.
+     *
+     * @readonly
+     */
+    get parameters(): any;
+    /**
+     * Job status. Can be `waiting`, `inprogress`, `done` or `failed`.
+     *
+     * @readonly
+     */
+    get status(): string;
+    /**
+     * Job status description message.
+     *
+     * @readonly
+     */
+    get statusMessage(): string;
+    /**
+     * Job starting time (UTC) in the format specified in <a
+     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     *
+     * @readonly
+     */
+    get startedAt(): string;
+    /**
+     * Refresh job data.
+     *
+     * @async
+     */
+    checkout(): Promise<Job>;
+    /**
+     * Update job data on the server. Only admins can update job data.
+     *
+     * @async
+     * @param data - Raw job data.
+     */
+    update(data: any): Promise<Job>;
+    /**
+     * Remove a job from the server job list. Jobs that are in progress or have already been
+     * completed cannot be deleted.
+     *
+     * @async
+     * @returns Returns the raw data of a deleted job.
+     */
+    delete(): Promise<any>;
+    /**
+     * Wait for job to be done. Job is done when it changes to `done` or `failed` status.
+     *
+     * @async
+     * @param params - An object containing waiting parameters.
+     * @param params.timeout - The time, in milliseconds that the function should wait job. If
+     *   jobs is not done during this time, the `TimeoutError` exception will be thrown.
+     * @param params.interval - The time, in milliseconds, the function should delay in between
+     *   checking job status.
+     * @param params.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 params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
+     */
+    waitForDone(params?: {
+        timeout?: number;
+        interval?: number;
+        signal?: AbortSignal;
+        onCheckout?: (job: Job, ready: boolean) => boolean;
+    }): Promise<Job>;
+}
+//# sourceMappingURL=Job.d.ts.map

package/lib/Api/Member.d.ts

@@ -0,0 +1,85 @@
+import { IHttpClient } from "./IHttpClient";
+import { IShortUserDescription } from "./IUser";
+/**
+ * Members are the {@link User | users} who have access to the {@link Project | project}.
+ */
+export declare class Member {
+    private _data;
+    protected projectId: string;
+    protected httpClient: IHttpClient;
+    /**
+     * @param data - An object that implements member data storage.
+     * @param projectId - Owner project ID.
+     * @param httpClient - Http client.
+     */
+    constructor(data: any, projectId: string, httpClient: IHttpClient);
+    private internalGet;
+    private internalPut;
+    private internalDelete;
+    /**
+     * Raw member data received from the server.
+     *
+     * @readonly
+     */
+    get data(): any;
+    private set data(value);
+    /**
+     * Unique member ID.
+     *
+     * @readonly
+     */
+    get id(): string;
+    /**
+     * Member role. See {@link Project#getRoles | Project.getRoles()} for more details.
+     */
+    get role(): string;
+    set role(value: string);
+    /**
+     * Member type. Can be `owner` or `user`.
+     *
+     * @readonly
+     */
+    get type(): string;
+    /**
+     * User information.
+     *
+     * @property {string} userId - User ID.
+     * @property {string} userName - User name.
+     * @property {string} name - First name.
+     * @property {string} lastName - Last name.
+     * @property {string} fullName - Full name.
+     * @property {string} initials - Initials.
+     * @property {string} email - User email.
+     * @property {string} avatarUrl - User avatar image URL.
+     * @readonly
+     */
+    get user(): IShortUserDescription;
+    /**
+     * Refresh member data.
+     *
+     * @async
+     */
+    checkout(): Promise<Member>;
+    /**
+     * Update member data on the server.
+     *
+     * @async
+     * @param data - Raw member data.
+     */
+    update(data: any): Promise<Member>;
+    /**
+     * Remove a member from a project.
+     *
+     * @async
+     * @returns Returns the raw data of a deleted member.
+     */
+    delete(): Promise<any>;
+    /**
+     * Save member data changes to the server. Call this method to update member data on the
+     * server after any changes.
+     *
+     * @async
+     */
+    save(): Promise<Member>;
+}
+//# sourceMappingURL=Member.d.ts.map

package/lib/Api/Model.d.ts

@@ -0,0 +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[];
+    }>;
+}
+//# sourceMappingURL=Model.d.ts.map

package/lib/Api/Permission.d.ts

@@ -0,0 +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>;
+}
+//# sourceMappingURL=Permission.d.ts.map