@inweb/client 25.2.2

package/lib/Api/Client.d.ts

@@ -0,0 +1,452 @@
+import { EventEmitter2 } from "../Viewer/EventEmitter2";
+import { ClientEventMap } from "./ClientEvents";
+import { Options } from "../Viewer/Options";
+import { OptionsEventMap } from "../Viewer/OptionsEvents";
+import { Assembly } from "./Assembly";
+import { File } from "./File";
+import { Job } from "./Job";
+import { Project } from "./Project";
+import { User } from "./User";
+/**
+ * The `Client.js` library class that provides methods to access the [Open Cloud
+ * Server](https://cloud.opendesign.com/docs/index.html#/opencloud_server) resources like
+ * Projects, Files, Issues etc.
+ */
+export declare class Client extends EventEmitter2<ClientEventMap & OptionsEventMap> {
+    private _options;
+    private _serverUrl;
+    private _httpClient;
+    private _user;
+    eventEmitter: EventEmitter2;
+    /**
+     * @param params - An object containing client configuration parameters.
+     * @param params.serverUrl - Open Cloud Server URL.
+     */
+    constructor(params?: {
+        serverUrl?: string;
+        url?: string;
+    });
+    /**
+     * Open Cloud Server URL. Use {@link Client#configure | configure()} to change server URL.
+     *
+     * @readonly
+     */
+    get serverUrl(): string;
+    /**
+     * `VisualizeJS` parameters. Changes to these parameters are automatically applied to
+     * `Viewer` instances associated with that client.
+     */
+    get options(): Options;
+    /**
+     * Change the client configuration parameters.
+     *
+     * @param params - An object containing new configuration parameters.
+     * @param params.serverUrl - Open Cloud Server URL.
+     * @returns Returns a reference to the `Client`.
+     */
+    configure(params: {
+        serverUrl?: string;
+    }): this;
+    /**
+     * The Object represents server version information.
+     *
+     * @typedef {any} VersionResult
+     * @property {string} version - The server version.
+     * @property {string} hash - Build hash.
+     */
+    /**
+     * Returns server version.
+     *
+     * @async
+     */
+    version(): Promise<any>;
+    /**
+     * Register a new user with the specified email and password.
+     *
+     * @async
+     * @param email - User email. Cannot be empty.
+     * @param password - User password. Cannot be empty. Password can only contain letters (a-z,
+     *   A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]:;"'`<>,.?|/\ ).
+     * @param userName - User name. Cannot be empty or blank if defined. Leave undefined to use
+     *   `username` from email.
+     */
+    registerUser(email: string, password: string, userName?: string): Promise<any>;
+    /**
+     * Resend the Confirmation Email to new user. If the user's email is already confirmed, an
+     * exception will be thrown.
+     *
+     * @async
+     * @param email - User email.
+     * @param password - User password.
+     */
+    resendConfirmationEmail(email: string, password: string): Promise<any>;
+    /**
+     * Confirm the user's email. If the user's email is already confirmed, an exception will be thrown.
+     *
+     * @async
+     * @param emailConfirmationId - Confirmation code from the Confirmation Email.
+     */
+    confirmUserEmail(emailConfirmationId: string): Promise<any>;
+    /**
+     * Log in an existing user using email or user name.
+     *
+     * @async
+     * @param email - An email or user name for authentication request.
+     * @param password - Password for authentication request.
+     */
+    signInWithEmail(email: string, password: string): Promise<User>;
+    /**
+     * Log in an existing user using API Key.
+     *
+     * @async
+     * @param token - An access token for authentication request. See
+     *   {@link User#token | User.token} for more details.
+     */
+    signInWithToken(token: string): Promise<User>;
+    private setCurrentUser;
+    private clearCurrentUser;
+    /**
+     * Returns the current logged in user information. Returns `null` if the user is not logged
+     * in or the logged in user has deleted himself.
+     */
+    getCurrentUser(): User | null;
+    /**
+     * Returns a list of server users. Only admins can get a list of users, if the current logged
+     * in user does not have administrator rights, an exception will be thrown.
+     *
+     * @async
+     */
+    getUsers(): Promise<User[]>;
+    /**
+     * Returns the user information. Only admins can get other users, if the current logged in
+     * user does not have administrator rights, hi can only get himself, otherwise an exception
+     * will be thrown.
+     *
+     * @async
+     * @param userId - User ID.
+     */
+    getUser(userId: string): Promise<User>;
+    /**
+     * Create a new user. Only admins can create users, if the current logged in user does not
+     * have administrator rights, an exception will be thrown.
+     *
+     * @async
+     * @param email - User email. Cannot be empty.
+     * @param password - User password. Cannot be empty. Password can only contain latin letters
+     *   (a-z, A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]:;"'`<>,.?|/\ ).
+     * @param params - Additional user data.
+     * @param params.isAdmin - `true` if user is an administrator.
+     * @param params.userName - User name. Cannot be empty or blank if defined. Leave undefined
+     *   to use `username` from email.
+     * @param params.firstName - First name.
+     * @param params.lastName - Last name.
+     * @param params.canCreateProject - `true` if user is allowed to create a project.
+     * @param params.projectsLimit - The maximum number of projects that the user can create.
+     * @param params.storageLimit - The size of the file storage available to the user.
+     */
+    createUser(email: string, password: string, params?: {
+        isAdmin?: boolean;
+        userName?: string;
+        firstName?: string;
+        lastName?: string;
+        canCreateProject?: boolean;
+        projectsLimit?: number;
+        storageLimit?: number;
+    }): Promise<User>;
+    /**
+     * Delete a user from the server. Only admins can delete users, if the current logged in user
+     * does not have administrator rights, an exception will be thrown.
+     *
+     * Admins can delete themselves or other admins. An admin can only delete himself if he is
+     * not the last administrator.
+     *
+     * You need to re-login to continue working after deleting the current logged in user.
+     *
+     * @async
+     * @param userId - User ID.
+     * @returns Returns the raw data of a deleted user.
+     */
+    deleteUser(userId: string): Promise<any>;
+    /**
+     * Result for file list.
+     *
+     * @typedef {any} FilesResult
+     * @property {number} allSize - Total number of files the user has access to.
+     * @property {number} start - The starting index in the file list in the request.
+     * @property {number} limit - The maximum number of requested files.
+     * @property {File[]} result - Result file list.
+     * @property {number} size - The number of files in the result list.
+     */
+    /**
+     * Returns a list of files the user has access to.
+     *
+     * @async
+     * @param start - The starting index in the file list. Used for paging.
+     * @param limit - The maximum number of files that should be returned per request. Used for paging.
+     * @param name - Filter the files by part of the name.
+     * @param ext - Filter the files by extension. Extension can be `dgn`, `dwf`, `dwg`, `dxf`,
+     *   `ifc`, `ifczip`, `nwc`, `nwd`, `obj`, `rcs`, `rfa`, `rvt`, `step`, `stl`, `stp`, `vsf`,
+     *   or any other drawing or reference file type extension. You can specify multiple
+     *   extensions on one `string` by separating them with a "|".
+     * @param ids - List of file IDs to return. You can specify multiple IDs on one `string` by
+     *   separating them with a "|".
+     * @param sortByDesc - Allows to specify the descending order of the result. By default,
+     *   files are sorted by name in ascending order.
+     * @param {string} sortField - Allows to specify sort field.
+     */
+    getFiles(start?: number, limit?: number, name?: string, ext?: string | string[], ids?: string | string[], sortByDesc?: boolean, sortField?: string): Promise<{
+        allSize: number;
+        start: number;
+        limit: number;
+        result: File[];
+        size: number;
+    }>;
+    /**
+     * Returns the file information.
+     *
+     * @async
+     * @param fileId - File ID.
+     */
+    getFile(fileId: string): Promise<File>;
+    /**
+     * Upload a drawing or reference file to the server.
+     *
+     * Fires:
+     *
+     * - {@link UploadProgressEvent | uploadprogress}
+     *
+     * @async
+     * @param file - Web API <a href="https://developer.mozilla.org/docs/Web/API/File"
+     *   target="_blank">File</a> object are generally retrieved from a <a
+     *   href="https://developer.mozilla.org/docs/Web/API/FileList" target="_blank">FileList</a>
+     *   object returned as a result of a user selecting files using the HTML `<input>` element.
+     * @param params - An object containing upload parameters.
+     * @param params.geometry=true - Create job to extract file geometry data. Can be:
+     *
+     *   - `true` - Extract file geometry data into type, defined by [options]{@link Client#options}.
+     *   - `vsfx` - Extract file geometry data into `VSFX` to open the file in `VisualizeJS` viewer.
+     *   - `gltf` - Extract file geometry data into `glTF` to open the file in `Three.js` viewer.
+     *
+     * @param params.properties=false - Create job to extract file properties.
+     * @param params.waitForDone=false - Wait for geometry and properties jobs to complete.
+     * @param params.timeout - The time, in milliseconds that the function should wait jobs. If
+     *   no one jobs are done during this time, the `TimeoutError` exception will be thrown.
+     * @param params.interval - The time, in milliseconds, the function should delay in between
+     *   checking jobs 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.onProgress - Upload progress callback.
+     */
+    uploadFile(file: globalThis.File, params?: {
+        geometry?: boolean | string;
+        properties?: boolean;
+        waitForDone?: boolean;
+        timeout?: number;
+        interval?: number;
+        signal?: AbortSignal;
+        onProgress?: (progress: number, file: globalThis.File) => void;
+    }): Promise<File>;
+    /**
+     * Delete the drawing or reference file from the server.
+     *
+     * @async
+     * @param fileId - File ID.
+     * @returns Returns the raw data of a deleted file.
+     */
+    deleteFile(fileId: string): Promise<any>;
+    /**
+     * Download the drawing or reference file.
+     *
+     * @async
+     * @param fileId - File 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.
+     */
+    downloadFile(fileId: string, onProgress?: (progress: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
+    /**
+     * Result for job list.
+     *
+     * @typedef {any} JobsResult
+     * @property {number} allSize - Total number of jobs created by the user.
+     * @property {number} start - The starting index in the job list in the request.
+     * @property {number} limit - The maximum number of requested jobs.
+     * @property {Job[]} result - Result job list.
+     * @property {number} size - The number of jobs in the result list.
+     */
+    /**
+     * Returns a list of jobs created by current user.
+     *
+     * @async
+     * @param status - Filter the jobs by status. Status can be `waiting`, `inpogress`, `done` or
+     *   `failed`. You can specify multiple statuses on one `string` by separating them with a "|".
+     * @param limit - The maximum number of jobs that should be returned per request. Used for paging.
+     * @param start - The starting index in the job list. Used for paging.
+     * @param sortByDesc - Allows to specify the descending order of the result. By default, jobs
+     *   are sorted by creation time in ascending order.
+     * @param {boolean} sortField - Allows to specify sort field.
+     */
+    getJobs(status?: string | string[], limit?: number, start?: number, sortByDesc?: boolean, sortField?: string): Promise<{
+        allSize: number;
+        start: number;
+        limit: number;
+        result: Job[];
+        size: number;
+    }>;
+    /**
+     * Returns the job information.
+     *
+     * @async
+     * @param jobId - Job ID.
+     */
+    getJob(jobId: string): Promise<Job>;
+    /**
+     * Create a new job.
+     *
+     * @async
+     * @param fileId - File ID.
+     * @param outputFormat - The job type. Can be one of:
+     *
+     *   - `geometry` - Extract file geometry data into `VSFX`.
+     *   - `geometryGltf` - Extract file geometry data into `glTF`.
+     *   - `properties` - Extract file properties.
+     *   - `validation` - Validate the file. Only for `IFC`.
+     *   - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the one of the supported format.
+     *   - Other custom job name. Custom job runner must be registered in the job templates table
+     *       before creating a job.
+     *
+     * @param parameters - Parameters for the job runner. Can be given as command line arguments
+     *   for the File Converter tool in form "--arg=value".
+     */
+    createJob(fileId: string, outputFormat: string, parameters?: string | object): Promise<Job>;
+    /**
+     * Remove a job from the server job list. The method does not delete or stop jobs that are
+     * already being executed.
+     *
+     * @async
+     * @param jobId - Job ID.
+     * @returns Returns the raw data of a deleted job.
+     */
+    deleteJob(jobId: string): Promise<any>;
+    /**
+     * Result for assembly list.
+     *
+     * @typedef {any} AssembliesResult
+     * @property {number} allSize - Total number of assemblies the user has access to.
+     * @property {number} start - The starting index in the assembly list in the request.
+     * @property {number} limit - The maximum number of requested assemblies.
+     * @property {Assembly[]} result - Result assembly list.
+     * @property {number} size - The number of assemblies in the result list.
+     */
+    /**
+     * Returns a list of assemblies the user has access to.
+     *
+     * @async
+     * @param start - The starting index in the assembly list. Used for paging.
+     * @param limit - The maximum number of assemblies that should be returned per request. Used
+     *   for paging.
+     * @param name - Filter the assemblies by part of the name.
+     * @param ids - List of assembly IDs to return. You can specify multiple IDs on one `string`
+     *   by separating them with a "|".
+     * @param sortByDesc - Allows to specify the descending order of the result. By default
+     *   assemblies are sorted by name in ascending order.
+     * @param sortField - Allows to specify sort field.
+     */
+    getAssemblies(start?: number, limit?: number, name?: string, ids?: string | string[], sortByDesc?: boolean, sortField?: string): Promise<{
+        allSize: number;
+        start: number;
+        limit: number;
+        result: Assembly[];
+        size: number;
+    }>;
+    /**
+     * Get assembly information.
+     *
+     * @async
+     * @param assemblyId - Assembly ID.
+     */
+    getAssembly(assemblyId: string): Promise<Assembly>;
+    /**
+     * Create a new assembly.
+     *
+     * @async
+     * @param files - List of file IDs.
+     * @param name - Assembly name.
+     * @param params - An object containing upload parameters.
+     * @param params.waitForDone=false - Wait for assembly to be created.
+     */
+    createAssembly(files: string[], name: string, params?: {
+        waitForDone?: boolean;
+        timeout?: number;
+        interval?: number;
+        signal?: AbortSignal;
+    }): Promise<Assembly>;
+    /**
+     * Delete the assembly from the server.
+     *
+     * @async
+     * @param assemblyId - Assembly ID.
+     * @returns Returns the raw data of a deleted assembly.
+     */
+    deleteAssembly(assemblyId: string): Promise<any>;
+    /**
+     * Result for project list.
+     *
+     * @typedef {any} ProjectsResult
+     * @property {number} allSize - Total number of projects the user has access to.
+     * @property {number} start - The starting index in the project list in the request.
+     * @property {number} limit - The maximum number of requested projects.
+     * @property {Project[]} result - Result project list.
+     * @property {number} size - The number of projects in the result list.
+     */
+    /**
+     * Returns a list of projects the user has access to.
+     *
+     * @async
+     * @param start - The starting index in the project list. Used for paging.
+     * @param limit - The maximum number of projects that should be returned per request. Used for paging.
+     * @param name - Filter the projects by part of the name.
+     * @param ids - List of project IDs to return. You can specify multiple IDs on one `string`
+     *   by separating them with a "|".
+     * @param sortByDesc - Allows to specify the descending order of the result. By default
+     *   projects are sorted by name in ascending order.
+     */
+    getProjects(start?: number, limit?: number, name?: string, ids?: string | string[], sortByDesc?: boolean): Promise<{
+        allSize: number;
+        start: number;
+        limit: number;
+        result: Project[];
+        size: number;
+    }>;
+    /**
+     * Returns the project information.
+     *
+     * @async
+     * @param projectId - Project ID.
+     */
+    getProject(projectId: string): Promise<Project>;
+    /**
+     * Create a new project.
+     *
+     * @async
+     * @param name - Project name.
+     * @param description - Project description.
+     * @param startDate - Project start date.
+     * @param endDate - Project end date.
+     * @param avatarUrl - Project preview image URL. Can be <a
+     *   href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
+     *   target="_blank">Data URL</a>.
+     */
+    createProject(name: string, description?: string, startDate?: Date | string, endDate?: Date | string, avatarUrl?: string): Promise<Project>;
+    /**
+     * Delete the project from the server.
+     *
+     * @async
+     * @param projectId - Project ID.
+     * @returns Returns the raw data of a deleted project.
+     */
+    deleteProject(projectId: string): Promise<any>;
+}
+//# sourceMappingURL=Client.d.ts.map

package/lib/Api/ClientEvents.d.ts

@@ -0,0 +1,29 @@
+/**
+ * A {@link Client | Client} event measuring progress of an file uploading process.
+ *
+ * @event
+ */
+export interface UploadProgressEvent {
+    /**
+     * Event type.
+     */
+    type: "uploadprogress";
+    /**
+     * The non-rounded progress value from 0 to 1. To get a percentage (%), multiply the `data` by 100.
+     */
+    data: number;
+    /**
+     * File object to upload.
+     */
+    file: globalThis.File;
+}
+/**
+ * Client events.
+ */
+export interface ClientEventMap {
+    /**
+     * A {@link Client | Client} event measuring progress of an file uploading process.
+     */
+    uploadprogress: UploadProgressEvent;
+}
+//# sourceMappingURL=ClientEvents.d.ts.map