@inweb/client 25.2.2

package/lib/Api/Project.d.ts

@@ -0,0 +1,247 @@
+import { IHttpClient } from "./IHttpClient";
+import { IShortUserDescription } from "./IUser";
+import { Role } from "./Role";
+import { Member } from "./Member";
+/**
+ * Projects are used to collaborate on models and track issues.
+ */
+export declare class Project {
+    private _data;
+    protected httpClient: IHttpClient;
+    /**
+     * @param data - An object that implements project data storage.
+     * @param httpClient - Http client.
+     */
+    constructor(data: any, httpClient: IHttpClient);
+    protected internalGet(relativePath: string): Promise<Response>;
+    protected internalPost(relativePath: string, body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null): Promise<Response>;
+    protected internalPut(relativePath: string, body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null): Promise<Response>;
+    protected internalDelete(relativePath: string): Promise<Response>;
+    /**
+     * Project features the user has access to.
+     *
+     * @property {string[]} project_actions - Actions are allowed to be performed: `update`,
+     *   `createTopic`, `createDocument`.
+     * @readonly
+     */
+    get authorization(): any;
+    /**
+     * Project 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;
+    /**
+     * Project custom fields object, to store custom data.
+     */
+    get customFields(): any;
+    set customFields(value: any);
+    /**
+     * Raw project data received from the server.
+     *
+     * @readonly
+     */
+    get data(): any;
+    private set data(value);
+    /**
+     * Project description.
+     */
+    get description(): string;
+    set description(value: string);
+    /**
+     * Project end date in the format specified in <a
+     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     */
+    get endDate(): string;
+    set endDate(value: string | Date);
+    /**
+     * Unique project ID.
+     *
+     * @readonly
+     */
+    get id(): string;
+    /**
+     * The number of members in the project.
+     *
+     * @readonly
+     */
+    get memberCount(): number;
+    /**
+     * The number of models in the project.
+     *
+     * @readonly
+     */
+    get modelCount(): number;
+    /**
+     * Project name.
+     */
+    get name(): string;
+    set name(value: string);
+    /**
+     * Project owner 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 owner(): IShortUserDescription;
+    /**
+     * Project preview image URL. Use [setPreview()]{@link Project#setPreview} to change preview image.
+     *
+     * @readonly
+     */
+    get previewUrl(): string;
+    /**
+     * `true` if project is public (shared) project.
+     */
+    get public(): boolean;
+    set public(value: boolean);
+    /**
+     * Project start date in the format specified in <a
+     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     */
+    get startDate(): string;
+    set startDate(value: string | Date);
+    /**
+     * The number of topics in the project.
+     *
+     * @readonly
+     */
+    get topicCount(): number;
+    /**
+     * Project last update time (UTC) in the format specified in <a
+     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     *
+     * @readonly
+     */
+    get updatedAt(): string;
+    /**
+     * Refresh project data.
+     *
+     * @async
+     */
+    checkout(): Promise<Project>;
+    /**
+     * Update project data on the server.
+     *
+     * @async
+     * @param data - Raw project data.
+     */
+    update(data: any): Promise<Project>;
+    /**
+     * Delete the project from the server.
+     *
+     * @async
+     * @returns Returns the raw data of a deleted project.
+     */
+    delete(): Promise<any>;
+    /**
+     * Save project data changes to the server. Call this method to update project data on the
+     * server after any changes.
+     *
+     * @async
+     */
+    save(): Promise<Project>;
+    /**
+     * Set or remove the project preview.
+     *
+     * @async
+     * @param image - Preview image. Can be a <a
+     *   href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
+     *   target="_blank">Data URL</a> string, <a
+     *   href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"
+     *   target="_blank">ArrayBuffer</a>, <a
+     *   href="https://developer.mozilla.org/docs/Web/API/Blob/Blob" target="_blank">Blob</a> or
+     *   Web API <a href="https://developer.mozilla.org/docs/Web/API/File"
+     *   target="_blank">File</a> object. Setting the `image` to `null` will remove the preview.
+     */
+    setPreview(image?: ArrayBuffer | Blob | globalThis.File | FormData | string | null): Promise<this>;
+    /**
+     * Returns a list of project roles. Project {@link Member | members} have different abilities
+     * depending on the role they have in a project.
+     *
+     * @async
+     */
+    getRoles(): Promise<Role[]>;
+    /**
+     * Returns the role information.
+     *
+     * @async
+     * @param name - Role name.
+     */
+    getRole(name: string): Promise<Role>;
+    /**
+     * Create a new project role.
+     *
+     * @async
+     * @param name - Role name.
+     * @param description - Role description.
+     * @param permissions - Actions are allowed to be performed. See
+     *   {@link Role#permissions | Role.permissions} for more details.
+     */
+    createRole(name: string, description: string, permissions: any): Promise<Role>;
+    /**
+     * Delete project role.
+     *
+     * @async
+     * @param name - Role name.
+     * @returns Returns the raw data of a deleted role.
+     */
+    deleteRole(name: string): Promise<any>;
+    /**
+     * Returns a list of project members.
+     *
+     * @async
+     */
+    getMembers(): Promise<Member[]>;
+    /**
+     * Returns the member information.
+     *
+     * @async
+     * @param memberId - Member ID.
+     */
+    getMember(memberId: string): Promise<Member>;
+    /**
+     * Add a user to the project to become a member and have permission to perform actions.
+     *
+     * @async
+     * @param userId - User ID.
+     * @param role - User role from the list of project roles.
+     */
+    addMember(userId: string, role: string): Promise<Member>;
+    /**
+     * Remove a member from a project.
+     *
+     * @async
+     * @param memberId - Member ID.
+     * @returns Returns the raw data of a deleted member.
+     */
+    removeMember(memberId: string): Promise<any>;
+    /**
+     * 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 {string} display_information.field_display_name - Field display name.
+     * @property {string} display_information.field_value - Field value.
+     * @property {any} file - The file reference object.
+     * @property {string} file.file_name - File name.
+     * @property {string} file.reference - File ID.
+     */
+    /**
+     * Returns a list of project files. To add a file to this list, create a `project` permission
+     * on the file using {@link File#createPermission | File.createPermission()}.
+     *
+     * @async
+     */
+    getFilesInformation(): Promise<any[]>;
+}
+//# sourceMappingURL=Project.d.ts.map

package/lib/Api/Role.d.ts

@@ -0,0 +1,82 @@
+import { IHttpClient } from "./IHttpClient";
+/**
+ * A roles determines what permissions {@link User | users} have on a {@link Project | project}.
+ */
+export declare class Role {
+    private _data;
+    protected projectId: string;
+    protected httpClient: IHttpClient;
+    /**
+     * @param data - An object that implements role data storage.
+     * @param projectId - Owner project ID.
+     * @param httpClient - Http client.
+     */
+    constructor(data: any, projectId: string, httpClient: IHttpClient);
+    private internalGet;
+    private internalPut;
+    private internalDelete;
+    /**
+     * Role description.
+     */
+    get description(): string;
+    set description(value: string);
+    /**
+     * Raw role data received from the server.
+     *
+     * @readonly
+     */
+    get data(): any;
+    set data(value: any);
+    /**
+     * Role name.
+     */
+    get name(): string;
+    set name(value: string);
+    /**
+     * Role actions are allowed to be performed.
+     *
+     * @property {string[]} projectActions - Actions are allowed to be performed at the project
+     *   level: `update`, `createTopic`, `createDocument`.
+     * @property {string[]} topicActions - Actions are allowed to be performed at the topic
+     *   level: `update`, `updateBimSnippet`, `updateRelatedTopics`, `updateDocumentReferences`,
+     *   `updateFiles`, `createComment`, `createViewpoint`, `delete`.
+     * @property {string[]} commentActions - Actions are allowed to be performed at the comment
+     *   level: `update`, `delete`.
+     * @property {string[]} viewpointActions - Actions are allowed to be performed at the
+     *   viewpoint level: `delete`.
+     * @property {string[]} odaGroupActions - Actions are allowed to be performed at the members
+     *   level: `update`, `delete`.
+     * @property {string[]} odaRoleActions - Actions are allowed to be performed at the roles
+     *   level: `update`, `delete`.
+     */
+    get permissions(): any;
+    set permissions(value: any);
+    /**
+     * Refresh role data.
+     *
+     * @async
+     */
+    checkout(): Promise<Role>;
+    /**
+     * Update role data on the server.
+     *
+     * @async
+     * @param data - Raw role data.
+     */
+    update(data: any): Promise<Role>;
+    /**
+     * Delete a role from the project.
+     *
+     * @async
+     * @returns Returns the raw data of a deleted role.
+     */
+    delete(): Promise<any>;
+    /**
+     * Save role data changes to the server. Call this method to update role data on the server
+     * after any changes.
+     *
+     * @async
+     */
+    save(): Promise<Role>;
+}
+//# sourceMappingURL=Role.d.ts.map

package/lib/Api/User.d.ts

@@ -0,0 +1,197 @@
+import { IHttpClient } from "./IHttpClient";
+export interface UserParams {
+    /**
+     * `true` if user is an administrator
+     */
+    isAdmin?: boolean;
+    /**
+     * User name
+     */
+    userName?: string;
+    /**
+     * First name
+     */
+    firstName?: string;
+    /**
+     * Last name
+     */
+    lastName?: string;
+    /**
+     * `true` if user is allowed to create a project
+     */
+    canCreateProject?: boolean;
+    /**
+     * The maximum number of projects that the user can create
+     */
+    projectsLimit?: number;
+    /**
+     * The size of the file storage available to the user
+     */
+    storageLimit?: number;
+}
+/**
+ * The class representing a `user` entity.
+ */
+export declare class User {
+    private _data;
+    protected httpClient: IHttpClient;
+    /**
+     * @param data - An object that implements user data storage.
+     * @param httpClient - Http client.
+     */
+    constructor(data: any, httpClient: IHttpClient);
+    /**
+     * User avatar image URL. Use {@link User#setAvatar | setAvatar()} to change avatar image.
+     *
+     * @readonly
+     */
+    get avatarUrl(): string;
+    /**
+     * `true` if user is allowed to create a project.
+     *
+     * @readonly
+     */
+    get canCreateProject(): boolean;
+    /**
+     * User account registration time (UTC) in the format specified in <a
+     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     *
+     * @readonly
+     */
+    get createAt(): string;
+    /**
+     * User custom fields object, to store custom data.
+     */
+    get customFields(): any;
+    set customFields(value: any);
+    /**
+     * Raw user data received from the server.
+     *
+     * @readonly
+     */
+    get data(): any;
+    private set data(value);
+    /**
+     * User email.
+     *
+     * @readonly
+     */
+    get email(): string;
+    /**
+     * The user's email confirmation code, or an empty string if the email has already been confirmed.
+     *
+     * @readonly
+     */
+    get emailConfirmationId(): string;
+    /**
+     * First name.
+     */
+    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.
+     */
+    get fullName(): string;
+    /**
+     * Unique user ID.
+     *
+     * @readonly
+     */
+    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.
+     */
+    get initials(): string;
+    /**
+     * `false` if the user has not yet confirmed his email address.
+     *
+     * @readonly
+     */
+    get isEmailConfirmed(): boolean;
+    /**
+     * User last update time (UTC) in the format specified in <a
+     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     */
+    get lastModified(): string;
+    /**
+     * Last name.
+     */
+    get lastName(): string;
+    set lastName(value: string);
+    /**
+     * User last sign in time (UTC) in the format specified in <a
+     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     */
+    get lastSignIn(): string;
+    /**
+     * The maximum number of projects that a user can create.
+     *
+     * @readonly
+     */
+    get projectsLimit(): number;
+    /**
+     * The user's API key.
+     *
+     * @readonly
+     */
+    get token(): string;
+    /**
+     * User name.
+     */
+    get userName(): string;
+    set userName(value: string);
+    /**
+     * Refresh user data. Only admins can checkout other users, if the current logged in user
+     * does not have administrator rights, hi can only checkout himself, otherwise an exception
+     * will be thrown.
+     */
+    checkout(): Promise<User>;
+    /**
+     * Update user data on the server. Only admins can update other users, if the current logged
+     * in user does not have administrator rights, hi can only update himself, otherwise an
+     * exception will be thrown.
+     *
+     * @async
+     * @param data - Raw user data.
+     */
+    update(data: any): Promise<this>;
+    /**
+     * 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
+     * @returns Returns the raw data of a deleted user.
+     */
+    delete(): Promise<any>;
+    /**
+     * Save user data changes to the server. Call this method to update user data on the server
+     * after any changes.
+     *
+     * @async
+     */
+    save(): Promise<User>;
+    /**
+     * Set or remove the user avatar. Only admins can set the avatar of other users, if the
+     * current logged in user does not have administrator rights, he can only set his own avatar,
+     * otherwise an exception will be thrown.
+     *
+     * @async
+     * @param image - Avatar image. Can be a <a
+     *   href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
+     *   target="_blank">Data URL</a> string, <a
+     *   href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"
+     *   target="_blank">ArrayBuffer</a>, <a
+     *   href="https://developer.mozilla.org/docs/Web/API/Blob/Blob" target="_blank">Blob</a> or
+     *   Web API <a href="https://developer.mozilla.org/docs/Web/API/File"
+     *   target="_blank">File</a> object. Setting the `image` to `null` will remove the avatar.
+     */
+    setAvatar(image?: ArrayBuffer | Blob | globalThis.File | FormData | string | null): Promise<User>;
+}
+//# sourceMappingURL=User.d.ts.map

package/lib/Api/impl/FetchError.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The `FetchError` object indicates an error when request to Open Cloud Server could not be
+ * performed. A `FetchError` is typically (but not exclusively) thrown when a network error
+ * occurs, access denied, or object not found.
+ */
+export declare class FetchError extends Error {
+    protected status: number;
+    protected statusText: string;
+    /**
+     * @property status - The <a href="https://developer.mozilla.org/docs/Web/HTTP/Status" target
+     *   ="_blank">HTTP status code</a> of the response.
+     * @property message - Error message. Inherited from <a
+     *   href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error"
+     *   target ="_blank">Error</a>.
+     */
+    constructor(status: number, message?: string);
+}
+//# sourceMappingURL=FetchError.d.ts.map

package/lib/Api/impl/Utils.d.ts

@@ -0,0 +1,33 @@
+export declare function json(request: any): any;
+export declare function text(request: any): any;
+export declare function arrayBuffer(request: any): any;
+export declare function $init(method: "GET" | "POST" | "PUT" | "DELETE", headers?: HeadersInit, body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null, signal?: AbortSignal): RequestInit;
+export declare function $fetch(url: RequestInfo | URL, init?: RequestInit): Promise<Response>;
+export declare function $get(url: RequestInfo | URL, headers?: HeadersInit, signal?: AbortSignal): Promise<Response>;
+export declare function $put(url: RequestInfo | URL, headers?: HeadersInit, body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null): Promise<Response>;
+export declare function $post(url: RequestInfo | URL, headers?: HeadersInit, body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null): Promise<Response>;
+export declare function $delete(url: RequestInfo | URL, headers?: HeadersInit): Promise<Response>;
+export declare function streamProgress(stream: ReadableStream<Uint8Array>, onprogress: (progress: number) => void): ReadableStream<Uint8Array>;
+export declare function downloadProgress(response: Response, onprogress?: (progress: number) => void): Response;
+interface XMLHttpParams {
+    headers: HeadersInit;
+    method: "GET" | "POST" | "PUT" | "DELETE";
+    body?: XMLHttpRequestBodyInit | Document;
+    uploadProgress?: (progress: number) => void;
+    downloadProgress?: (progress: number) => void;
+}
+export declare function $XMLHttp(url: string, { headers, method, body, uploadProgress, downloadProgress }: XMLHttpParams): Promise<XMLHttpRequest>;
+export declare function waitFor(func: (params: any) => Promise<boolean>, params?: {
+    timeout?: number;
+    interval?: number;
+    signal?: AbortSignal;
+    abortError?: DOMException;
+    timeoutError?: DOMException;
+    result?: any;
+}): Promise<any>;
+export declare function downloadPartOfFile(requestId: number, records: any | null, url: string, defHeaders: HeadersInit, onProgress?: (progress: number, downloaded: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<void>;
+export declare function parseArgs(args: string | object): object;
+export declare function userFullName(firstName: string | any, lastName?: string, userName?: string): string;
+export declare function userInitials(fullName?: string): string;
+export {};
+//# sourceMappingURL=Utils.d.ts.map

package/lib/Api/impl/http.d.ts

@@ -0,0 +1,67 @@
+export declare const STATUS_CODES: {
+    100: string;
+    101: string;
+    102: string;
+    103: string;
+    200: string;
+    201: string;
+    202: string;
+    203: string;
+    204: string;
+    205: string;
+    206: string;
+    207: string;
+    208: string;
+    226: string;
+    300: string;
+    301: string;
+    302: string;
+    303: string;
+    304: string;
+    305: string;
+    307: string;
+    308: string;
+    400: string;
+    401: string;
+    402: string;
+    403: string;
+    404: string;
+    405: string;
+    406: string;
+    407: string;
+    408: string;
+    409: string;
+    410: string;
+    411: string;
+    412: string;
+    413: string;
+    414: string;
+    415: string;
+    416: string;
+    417: string;
+    418: string;
+    421: string;
+    422: string;
+    423: string;
+    424: string;
+    425: string;
+    426: string;
+    428: string;
+    429: string;
+    431: string;
+    451: string;
+    500: string;
+    501: string;
+    502: string;
+    503: string;
+    504: string;
+    505: string;
+    506: string;
+    507: string;
+    508: string;
+    509: string;
+    510: string;
+    511: string;
+};
+export declare function statusText(status: number): string;
+//# sourceMappingURL=http.d.ts.map

package/lib/ConvetMath.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Convert world coordinates to screen normalized (-1, 1)
+ *
+ * @param viewMatrix Camera world matrix
+ * @param projectionMatrix Camera projection matrix
+ * @param worldPoint World point
+ */
+export declare function worldToScreenNormalized(viewMatrix: Array<number>, projectionMatrix: Array<number>, worldPoint: [x: number, y: number, z: number]): [x: number, y: number, z: number];
+export declare function multiplyMatrices(a: Array<number>, b: Array<number>): Array<number>;
+/**
+ * @param matrix
+ * @returns Matrix
+ */
+export declare function invertMatrix(matrix: Array<number>): Array<number>;
+/**
+ * Convert world coordinates to screen (screenWidth, screenHeight)
+ *
+ * @param viewMatrix Camera world matrix
+ * @param projectionMatrix Camera projection matrix
+ * @param worldPoint World point
+ * @param screenWidth Screen width
+ * @param screenHeight Screen height
+ */
+export declare function worldToScreen(viewMatrix: Array<number>, projectionMatrix: Array<number>, worldPoint: [x: number, y: number, z: number], screenWidth: number, screenHeight: number): number[];
+export declare function createOrthoProjectionMatrix(camera: any, width: any, height: any): number[];
+export declare function createViewMatrix(camera: any): any[];
+export declare function bcfWorldToScreenFromCamera(camera: any, canvas: HTMLCanvasElement, point: [x: number, y: number, z: number]): number[];
+export declare function matrixLookAt(matrix: any, eye: any, target: any, up: any): any;
+//# sourceMappingURL=ConvetMath.d.ts.map

package/lib/Viewer/CanvasEvents.d.ts

@@ -0,0 +1,2 @@
+export declare const CANVAS_EVENTS: string[];
+//# sourceMappingURL=CanvasEvents.d.ts.map

package/lib/Viewer/Commands/ApplyModelTransform.d.ts

@@ -0,0 +1,2 @@
+export declare const composeMatrixFromTransform: (translate: any, rotate: any, scale: any, modelCenter: any, matrix: any) => any;
+//# sourceMappingURL=ApplyModelTransform.d.ts.map

package/lib/Viewer/Commands/ClearMarkup.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ClearMarkup.d.ts.map

package/lib/Viewer/Commands/ClearSlices.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ClearSlices.d.ts.map

package/lib/Viewer/Commands/CreatePreview.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CreatePreview.d.ts.map