@inweb/client 25.2.2 → 25.2.8

package/lib/Api/User.d.ts

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

@@ -1,18 +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);
-}
+/**
+ * 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

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

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