@inweb/client 25.2.2 → 25.2.8

package/lib/Api/HttpClient.d.ts

@@ -1,13 +1,13 @@
-import { IHttpClient } from "./IHttpClient";
-export declare class HttpClient implements IHttpClient {
-    serverUrl: string;
-    headers: HeadersInit;
-    signInUserId: string;
-    constructor(serverUrl: string);
-    get(relativePath: string, signal?: AbortSignal): Promise<Response>;
-    post(relativePath: string, body?: string | object | ArrayBuffer | Blob | globalThis.File | FormData): Promise<Response>;
-    put(relativePath: string, body?: string | object | ArrayBuffer | Blob | globalThis.File | FormData): Promise<Response>;
-    delete(relativePath: string): Promise<Response>;
-    postFile(relativePath: string, file: globalThis.File, onProgress?: (progress: number) => void): Promise<XMLHttpRequest>;
-}
+import { IHttpClient } from "./IHttpClient";
+export declare class HttpClient implements IHttpClient {
+    serverUrl: string;
+    headers: HeadersInit;
+    signInUserId: string;
+    constructor(serverUrl: string);
+    get(relativePath: string, signal?: AbortSignal): Promise<Response>;
+    post(relativePath: string, body?: string | object | ArrayBuffer | Blob | globalThis.File | FormData): Promise<Response>;
+    put(relativePath: string, body?: string | object | ArrayBuffer | Blob | globalThis.File | FormData): Promise<Response>;
+    delete(relativePath: string): Promise<Response>;
+    postFile(relativePath: string, file: globalThis.File, onProgress?: (progress: number) => void): Promise<XMLHttpRequest>;
+}
 //# sourceMappingURL=HttpClient.d.ts.map

package/lib/Api/IAssembly.d.ts

@@ -1,14 +1,14 @@
-export interface IAssociatedFileData {
-    fileId: string;
-    name: string;
-    link: string;
-    version?: number;
-}
-export interface IAssemblyVersionInfo {
-    assemblyId: string;
-    status: string;
-    version: number;
-    createdAt: string;
-    ownerId: string;
-}
+export interface IAssociatedFileData {
+    fileId: string;
+    name: string;
+    link: string;
+    version?: number;
+}
+export interface IAssemblyVersionInfo {
+    assemblyId: string;
+    status: string;
+    version: number;
+    createdAt: string;
+    ownerId: string;
+}
 //# sourceMappingURL=IAssembly.d.ts.map

package/lib/Api/IFile.d.ts

@@ -1,46 +1,46 @@
-export interface IFileDataStatus {
-    state: string;
-    jobId?: string;
-    jobUrl?: string;
-}
-export interface IFileStatus {
-    geometry: IFileDataStatus;
-    geometryGltf: IFileDataStatus;
-    properties: IFileDataStatus;
-    validation: IFileDataStatus;
-}
-/**
- * Reference to file.
- */
-export interface IFileReference {
-    /**
-     * The ID of the referenced file.
-     */
-    id: string;
-    /**
-     * The name of the referenced file.
-     */
-    name: string;
-}
-/**
- * References are images, fonts, or any other files to correct rendering of the file.
- */
-export interface IFileReferences {
-    /**
-     * The references ID, changed after each update of the file references.
-     */
-    id: string;
-    /**
-     * List of file references or `null` if there are no references.
-     */
-    references: IFileReference[] | null;
-}
-export interface IFileVersionInfo {
-    fileId: string;
-    status: object;
-    version: number;
-    createdAt: string;
-    size: number;
-    ownerId: string;
-}
+export interface IFileDataStatus {
+    state: string;
+    jobId?: string;
+    jobUrl?: string;
+}
+export interface IFileStatus {
+    geometry: IFileDataStatus;
+    geometryGltf: IFileDataStatus;
+    properties: IFileDataStatus;
+    validation: IFileDataStatus;
+}
+/**
+ * Reference to file.
+ */
+export interface IFileReference {
+    /**
+     * The ID of the referenced file.
+     */
+    id: string;
+    /**
+     * The name of the referenced file.
+     */
+    name: string;
+}
+/**
+ * References are images, fonts, or any other files to correct rendering of the file.
+ */
+export interface IFileReferences {
+    /**
+     * The references ID, changed after each update of the file references.
+     */
+    id: string;
+    /**
+     * List of file references or `null` if there are no references.
+     */
+    references: IFileReference[] | null;
+}
+export interface IFileVersionInfo {
+    fileId: string;
+    status: object;
+    version: number;
+    createdAt: string;
+    size: number;
+    ownerId: string;
+}
 //# sourceMappingURL=IFile.d.ts.map

package/lib/Api/IHttpClient.d.ts

@@ -1,11 +1,11 @@
-export interface IHttpClient {
-    serverUrl: string;
-    headers: HeadersInit;
-    signInUserId: string;
-    get(relativePath: any, signal?: AbortSignal): Promise<Response>;
-    post(relativePath: string, body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null): Promise<Response>;
-    put(relativePath: string, body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null): Promise<Response>;
-    delete(relativePath: string): Promise<Response>;
-    postFile(relativePath: string, file: globalThis.File, onProgress?: (progress: number) => void): Promise<XMLHttpRequest>;
-}
+export interface IHttpClient {
+    serverUrl: string;
+    headers: HeadersInit;
+    signInUserId: string;
+    get(relativePath: any, signal?: AbortSignal): Promise<Response>;
+    post(relativePath: string, body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null): Promise<Response>;
+    put(relativePath: string, body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null): Promise<Response>;
+    delete(relativePath: string): Promise<Response>;
+    postFile(relativePath: string, file: globalThis.File, onProgress?: (progress: number) => void): Promise<XMLHttpRequest>;
+}
 //# sourceMappingURL=IHttpClient.d.ts.map

package/lib/Api/IUser.d.ts

@@ -1,11 +1,11 @@
-export interface IShortUserDescription {
-    userId: string;
-    userName: string;
-    name: string;
-    lastName: string;
-    email: string;
-    avatarUrl?: string;
-    fullName?: string;
-    initials?: string;
-}
+export interface IShortUserDescription {
+    userId: string;
+    userName: string;
+    name: string;
+    lastName: string;
+    email: string;
+    avatarUrl?: string;
+    fullName?: string;
+    initials?: string;
+}
 //# sourceMappingURL=IUser.d.ts.map

package/lib/Api/Job.d.ts

@@ -1,142 +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>;
-}
+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

@@ -1,85 +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>;
-}
+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