@extrahorizon/javascript-sdk 8.2.0 → 8.2.1-dev-49-61b4511

package/build/types/services/files/types.d.ts

@@ -1,185 +1,185 @@
-/// <reference types="node" />
-import { ReadStream } from 'fs';
-import type { AffectedRecords, ObjectId, OptionsBase, OptionsWithRql, PagedResult } from '../types';
-import { FileUploadOptions } from '../types';
-export * from './settings/types';
-/**
- * The combination of a uuid and id that is used to retrieve the file and decide an access level for the request
- */
-export declare type Token = string;
-export declare enum TokenPermission {
-    FULL = "full",
-    READ = "read"
-}
-export interface TokenObject {
-    token: Token;
-    accessLevel: TokenPermission;
-}
-export interface FileDetails {
-    tokens: Array<TokenObject>;
-    creatorId: ObjectId;
-    creationTimestamp: Date;
-    updateTimestamp: Date;
-    name: string;
-    mimetype: string;
-    size: number;
-    tags?: Array<string>;
-}
-export interface CreateTokenRequest {
-    accessLevel?: TokenPermission;
-}
-/**
- * As defined by React Native:
- * https://github.com/facebook/react-native/blob/v0.72.4/packages/react-native/Libraries/Network/FormData.js#L13
- */
-export declare type ReactNativeFile = {
-    uri: string;
-    name?: string;
-    type?: string;
-};
-export declare type FileDataTypes = Blob | string | Buffer | ReadStream | ReactNativeFile;
-export interface FilesService {
-    /**
-     * List all files
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * `VIEW_FILES` | `global` | **Required** for this endpoint
-     * @param rql Add filters to the requested list.
-     * @returns PagedResult<FileDetails>
-     */
-    find(options?: OptionsWithRql): Promise<PagedResult<FileDetails>>;
-    /**
-     * Find By Name
-     * @param name the name to search for
-     * @param rql an optional rql string
-     * @returns the first element found
-     */
-    findByName(name: string, options?: OptionsWithRql): Promise<FileDetails>;
-    /**
-     * Find First
-     * @param rql an optional rql string
-     * @returns the first element found
-     */
-    findFirst(options?: OptionsWithRql): Promise<FileDetails>;
-    /**
-     * ## Add a new file from a plain text source
-     *
-     * **Default Permissions:**
-     * Everyone can use this endpoint
-     * @param text {@link string} - The text to upload as a file
-     * @param options {@link FileUploadOptions} - Additional options for the request
-     * @returns {@link FileDetails} - The persisted metadata after file creation {@link FileDetails}
-     * @throws {FileTooLargeError} - An error if the uploaded file exceeds the maximum file size
-     */
-    createFromText(text: string, options?: FileUploadOptions): Promise<FileDetails>;
-    /**
-     * ## Add a new file
-     *
-     * Based on the platform `fileData` accepts different types:
-     * - Web browsers: `Blob` or `File`
-     * - Node.js: `string`, `Buffer` or `ReadStream`
-     * - React Native: `{ uri: string, name?: string, type?: string }`
-     *
-     * **Default Permissions:**
-     * Everyone can use this endpoint
-     * @param fileName {@link string} - The name of the file to upload
-     * @param fileData {@link FileDataTypes}  - The data used for file creation
-     * @param options {@link FileUploadOptions} - Additional options for the request
-     * @throws {FileTooLargeError} - An error if the uploaded file exceeds the maximum file size
-     * @returns {@link FileDetails} - The persisted metadata after file creation
-     */
-    create(fileName: string, fileData: FileDataTypes, options?: FileUploadOptions & {
-        tags?: string[];
-    }): Promise<FileDetails>;
-    /**
-     * Delete a file
-     *
-     * AccessLevel | Effect
-     * - | -
-     * `full` | **Required** to be able to delete the file
-     * @param token
-     * @returns AffectedRecords
-     * @throws {InvalidTokenError}
-     * @throws {UnauthorizedTokenError}
-     */
-    remove(token: Token, options?: OptionsBase): Promise<AffectedRecords>;
-    /**
-     * Retrieve a file from the object store
-     *
-     * Returns an `ArrayBuffer` in web browsers and React Native, a `Buffer` in Node.js
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | Everyone can use this endpoint
-     * @param token
-     * @returns Buffer
-     * @throws {InvalidTokenError}
-     * @throws {UnauthorizedTokenError}
-     */
-    retrieve(token: Token, options?: OptionsBase): Promise<Buffer>;
-    /**
-     * Retrieve a file stream from the object store
-     *
-     * Currently only supported in Node.js
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | Everyone can use this endpoint
-     * @param token
-     * @returns data as ReadStream
-     * @throws {InvalidTokenError}
-     * @throws {UnauthorizedTokenError}
-     */
-    retrieveStream(token: Token, options?: OptionsBase): Promise<{
-        data: ReadStream;
-    }>;
-    /**
-     * Get file details
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | Everyone can use this endpoint
-     *
-     * AccessLevel | Effect
-     * - | -
-     * `full` | **Required** to return file metadata with all tokens.
-     * `read` | **Required** to return name, size, mimetype.
-     * @param token
-     * @returns FileDetails
-     * @throws {InvalidTokenError}
-     * @throws {UnauthorizedTokenError}
-     */
-    getDetails(token: Token, options?: OptionsBase): Promise<FileDetails>;
-}
-export interface FileTokensService {
-    /**
-     * Delete a token
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none |  | Everyone can use this endpoint
-     *
-     * @param token
-     * @param tokenToAccess The token that should be deleted
-     * @returns void
-     * @throws {InvalidTokenError}
-     * @throws {UnauthorizedTokenError}
-     * @throws {TokenNotDeleteableError}
-     */
-    deleteToken(token: Token, tokenToAccess: Token, options?: OptionsBase): Promise<void>;
-    /**
-     * Generate a token for a file
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | Everyone can use this endpoint
-     *
-     * @param token
-     * @param requestBody
-     * @returns TokenObject Success
-     * @throws {InvalidTokenError}
-     * @throws {UnauthorizedTokenError}
-     */
-    generateToken(token: Token, requestBody: CreateTokenRequest, options?: OptionsBase): Promise<TokenObject>;
-}
+/// <reference types="node" />
+import { ReadStream } from 'fs';
+import type { AffectedRecords, ObjectId, OptionsBase, OptionsWithRql, PagedResult } from '../types';
+import { FileUploadOptions } from '../types';
+export * from './settings/types';
+/**
+ * The combination of a uuid and id that is used to retrieve the file and decide an access level for the request
+ */
+export declare type Token = string;
+export declare enum TokenPermission {
+    FULL = "full",
+    READ = "read"
+}
+export interface TokenObject {
+    token: Token;
+    accessLevel: TokenPermission;
+}
+export interface FileDetails {
+    tokens: Array<TokenObject>;
+    creatorId: ObjectId;
+    creationTimestamp: Date;
+    updateTimestamp: Date;
+    name: string;
+    mimetype: string;
+    size: number;
+    tags?: Array<string>;
+}
+export interface CreateTokenRequest {
+    accessLevel?: TokenPermission;
+}
+/**
+ * As defined by React Native:
+ * https://github.com/facebook/react-native/blob/v0.72.4/packages/react-native/Libraries/Network/FormData.js#L13
+ */
+export declare type ReactNativeFile = {
+    uri: string;
+    name?: string;
+    type?: string;
+};
+export declare type FileDataTypes = Blob | string | Buffer | ReadStream | ReactNativeFile;
+export interface FilesService {
+    /**
+     * List all files
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_FILES` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns PagedResult<FileDetails>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<FileDetails>>;
+    /**
+     * Find By Name
+     * @param name the name to search for
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findByName(name: string, options?: OptionsWithRql): Promise<FileDetails>;
+    /**
+     * Find First
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<FileDetails>;
+    /**
+     * ## Add a new file from a plain text source
+     *
+     * **Default Permissions:**
+     * Everyone can use this endpoint
+     * @param text {@link string} - The text to upload as a file
+     * @param options {@link FileUploadOptions} - Additional options for the request
+     * @returns {@link FileDetails} - The persisted metadata after file creation {@link FileDetails}
+     * @throws {FileTooLargeError} - An error if the uploaded file exceeds the maximum file size
+     */
+    createFromText(text: string, options?: FileUploadOptions): Promise<FileDetails>;
+    /**
+     * ## Add a new file
+     *
+     * Based on the platform `fileData` accepts different types:
+     * - Web browsers: `Blob` or `File`
+     * - Node.js: `string`, `Buffer` or `ReadStream`
+     * - React Native: `{ uri: string, name?: string, type?: string }`
+     *
+     * **Default Permissions:**
+     * Everyone can use this endpoint
+     * @param fileName {@link string} - The name of the file to upload
+     * @param fileData {@link FileDataTypes}  - The data used for file creation
+     * @param options {@link FileUploadOptions} - Additional options for the request
+     * @throws {FileTooLargeError} - An error if the uploaded file exceeds the maximum file size
+     * @returns {@link FileDetails} - The persisted metadata after file creation
+     */
+    create(fileName: string, fileData: FileDataTypes, options?: FileUploadOptions & {
+        tags?: string[];
+    }): Promise<FileDetails>;
+    /**
+     * Delete a file
+     *
+     * AccessLevel | Effect
+     * - | -
+     * `full` | **Required** to be able to delete the file
+     * @param token
+     * @returns AffectedRecords
+     * @throws {InvalidTokenError}
+     * @throws {UnauthorizedTokenError}
+     */
+    remove(token: Token, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Retrieve a file from the object store
+     *
+     * Returns an `ArrayBuffer` in web browsers and React Native, a `Buffer` in Node.js
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param token
+     * @returns Buffer
+     * @throws {InvalidTokenError}
+     * @throws {UnauthorizedTokenError}
+     */
+    retrieve(token: Token, options?: OptionsBase): Promise<Buffer>;
+    /**
+     * Retrieve a file stream from the object store
+     *
+     * Currently only supported in Node.js
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param token
+     * @returns data as ReadStream
+     * @throws {InvalidTokenError}
+     * @throws {UnauthorizedTokenError}
+     */
+    retrieveStream(token: Token, options?: OptionsBase): Promise<{
+        data: ReadStream;
+    }>;
+    /**
+     * Get file details
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     *
+     * AccessLevel | Effect
+     * - | -
+     * `full` | **Required** to return file metadata with all tokens.
+     * `read` | **Required** to return name, size, mimetype.
+     * @param token
+     * @returns FileDetails
+     * @throws {InvalidTokenError}
+     * @throws {UnauthorizedTokenError}
+     */
+    getDetails(token: Token, options?: OptionsBase): Promise<FileDetails>;
+}
+export interface FileTokensService {
+    /**
+     * Delete a token
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none |  | Everyone can use this endpoint
+     *
+     * @param token
+     * @param tokenToAccess The token that should be deleted
+     * @returns void
+     * @throws {InvalidTokenError}
+     * @throws {UnauthorizedTokenError}
+     * @throws {TokenNotDeleteableError}
+     */
+    deleteToken(token: Token, tokenToAccess: Token, options?: OptionsBase): Promise<void>;
+    /**
+     * Generate a token for a file
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     *
+     * @param token
+     * @param requestBody
+     * @returns TokenObject Success
+     * @throws {InvalidTokenError}
+     * @throws {UnauthorizedTokenError}
+     */
+    generateToken(token: Token, requestBody: CreateTokenRequest, options?: OptionsBase): Promise<TokenObject>;
+}

package/build/types/services/helpers.d.ts

@@ -1,7 +1,7 @@
-import { HttpInstance, HttpRequestConfig } from '../http/types';
-import { OptionsWithRql, PagedResult, PagedResultWithPager } from './types';
-export declare type FindAllIterator<T> = AsyncGenerator<PagedResult<T>, Record<string, never>, void>;
-export declare function findAllIterator<T>(find: (options: OptionsWithRql) => PagedResult<T> | Promise<PagedResult<T>>, options: OptionsWithRql): FindAllIterator<T>;
-export declare function findAllGeneric<T>(find: (options: OptionsWithRql) => PagedResult<T> | Promise<PagedResult<T>>, options: OptionsWithRql, level?: number): Promise<T[]>;
-export declare function addPagersFn<T>(find: (options: OptionsWithRql) => PagedResult<T> | Promise<PagedResult<T>>, options: OptionsWithRql, pagedResult: PagedResult<T>): PagedResultWithPager<T>;
-export declare function setCustomKeysConfigurationInRequestConfig(httpInstance: HttpInstance, requestOptions?: HttpRequestConfig): HttpRequestConfig;
+import { HttpInstance, HttpRequestConfig } from '../http/types';
+import { OptionsWithRql, PagedResult, PagedResultWithPager } from './types';
+export declare type FindAllIterator<T> = AsyncGenerator<PagedResult<T>, Record<string, never>, void>;
+export declare function findAllIterator<T>(find: (options: OptionsWithRql) => PagedResult<T> | Promise<PagedResult<T>>, options: OptionsWithRql): FindAllIterator<T>;
+export declare function findAllGeneric<T>(find: (options: OptionsWithRql) => PagedResult<T> | Promise<PagedResult<T>>, options: OptionsWithRql, level?: number): Promise<T[]>;
+export declare function addPagersFn<T>(find: (options: OptionsWithRql) => PagedResult<T> | Promise<PagedResult<T>>, options: OptionsWithRql, pagedResult: PagedResult<T>): PagedResultWithPager<T>;
+export declare function setCustomKeysConfigurationInRequestConfig(httpInstance: HttpInstance, requestOptions?: HttpRequestConfig): HttpRequestConfig;

package/build/types/services/http-client.d.ts

@@ -1,22 +1,22 @@
-import { HttpInstance, HttpRequestConfig } from '../http/types';
-interface HttpClientOptions {
-    basePath: string;
-    transformRequestData?(args: Record<string, unknown>, options?: HttpRequestConfig): Record<string, unknown>;
-}
-interface Options {
-    gzip?: boolean;
-}
-interface GetOptions {
-    shouldRetry?: boolean;
-}
-declare const httpClient: ({ basePath, transformRequestData, }: HttpClientOptions) => {
-    get: (axios: HttpInstance, url: string, { shouldRetry, ...config }?: HttpRequestConfig & GetOptions) => Promise<import("axios").AxiosResponse<any, any>>;
-    put: (axios: HttpInstance, url: string, data: any, config?: HttpRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
-    post: (axios: HttpInstance, url: string, data: any, config?: HttpRequestConfig, options?: Options) => Promise<import("axios").AxiosResponse<any, any>>;
-    delete: (axios: HttpInstance, url: string, config?: HttpRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
-    patch: (axios: HttpInstance, url: string, data: any, config?: HttpRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
-    options: (axios: HttpInstance, url: string) => Promise<import("axios").AxiosResponse<any, any>>;
-    head: (axios: HttpInstance, url: string) => Promise<import("axios").AxiosResponse<any, any>>;
-};
-export default httpClient;
-export declare type HttpClient = ReturnType<typeof httpClient>;
+import { HttpInstance, HttpRequestConfig } from '../http/types';
+interface HttpClientOptions {
+    basePath: string;
+    transformRequestData?(args: Record<string, unknown>, options?: HttpRequestConfig): Record<string, unknown>;
+}
+interface Options {
+    gzip?: boolean;
+}
+interface GetOptions {
+    shouldRetry?: boolean;
+}
+declare const httpClient: ({ basePath, transformRequestData, }: HttpClientOptions) => {
+    get: (axios: HttpInstance, url: string, { shouldRetry, ...config }?: HttpRequestConfig & GetOptions) => Promise<import("axios").AxiosResponse<any, any>>;
+    put: (axios: HttpInstance, url: string, data: any, config?: HttpRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+    post: (axios: HttpInstance, url: string, data: any, config?: HttpRequestConfig, options?: Options) => Promise<import("axios").AxiosResponse<any, any>>;
+    delete: (axios: HttpInstance, url: string, config?: HttpRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+    patch: (axios: HttpInstance, url: string, data: any, config?: HttpRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+    options: (axios: HttpInstance, url: string) => Promise<import("axios").AxiosResponse<any, any>>;
+    head: (axios: HttpInstance, url: string) => Promise<import("axios").AxiosResponse<any, any>>;
+};
+export default httpClient;
+export declare type HttpClient = ReturnType<typeof httpClient>;

package/build/types/services/index.d.ts

@@ -1,15 +1,15 @@
-export * from './auth';
-export * from './data';
-export * from './files';
-export * from './tasks';
-export * from './users';
-export * from './configurations';
-export * from './templates';
-export * from './mails';
-export * from './dispatchers';
-export * from './payments';
-export * from './localizations';
-export * from './profiles';
-export * from './notifications';
-export * from './events';
-export * from './logs';
+export * from './auth';
+export * from './data';
+export * from './files';
+export * from './tasks';
+export * from './users';
+export * from './configurations';
+export * from './templates';
+export * from './mails';
+export * from './dispatchers';
+export * from './payments';
+export * from './localizations';
+export * from './profiles';
+export * from './notifications';
+export * from './events';
+export * from './logs';

package/build/types/services/localizations/countries.d.ts

@@ -1,5 +1,5 @@
-import type { HttpInstance } from '../../types';
-import { HttpClient } from '../http-client';
-import type { CountriesService } from './types';
-declare const _default: (client: HttpClient, httpAuth: HttpInstance) => CountriesService;
-export default _default;
+import type { HttpInstance } from '../../types';
+import { HttpClient } from '../http-client';
+import type { CountriesService } from './types';
+declare const _default: (client: HttpClient, httpAuth: HttpInstance) => CountriesService;
+export default _default;

package/build/types/services/localizations/health.d.ts

@@ -1,9 +1,9 @@
-import type { HttpInstance } from '../../types';
-declare const _default: (client: any, http: HttpInstance) => {
-    /**
-     * Perform a health check
-     * @returns {boolean} success
-     */
-    health(): Promise<boolean>;
-};
-export default _default;
+import type { HttpInstance } from '../../types';
+declare const _default: (client: any, http: HttpInstance) => {
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
+};
+export default _default;

package/build/types/services/localizations/index.d.ts

@@ -1,4 +1,4 @@
-import type { HttpInstance } from '../../types';
-import health from './health';
-import { CountriesService, LanguagesService, LocalizationsService } from './types';
-export declare const localizationsService: (httpWithAuth: HttpInstance) => ReturnType<typeof health> & LocalizationsService & CountriesService & LanguagesService;
+import type { HttpInstance } from '../../types';
+import health from './health';
+import { CountriesService, LanguagesService, LocalizationsService } from './types';
+export declare const localizationsService: (httpWithAuth: HttpInstance) => ReturnType<typeof health> & LocalizationsService & CountriesService & LanguagesService;

package/build/types/services/localizations/languages.d.ts

@@ -1,5 +1,5 @@
-import type { HttpInstance } from '../../types';
-import { HttpClient } from '../http-client';
-import type { LanguagesService } from './types';
-declare const _default: (client: HttpClient, httpAuth: HttpInstance) => LanguagesService;
-export default _default;
+import type { HttpInstance } from '../../types';
+import { HttpClient } from '../http-client';
+import type { LanguagesService } from './types';
+declare const _default: (client: HttpClient, httpAuth: HttpInstance) => LanguagesService;
+export default _default;

package/build/types/services/localizations/localizations.d.ts

@@ -1,5 +1,5 @@
-import type { HttpInstance } from '../../types';
-import { HttpClient } from '../http-client';
-import type { LocalizationsService } from './types';
-declare const _default: (client: HttpClient, httpAuth: HttpInstance) => LocalizationsService;
-export default _default;
+import type { HttpInstance } from '../../types';
+import { HttpClient } from '../http-client';
+import type { LocalizationsService } from './types';
+declare const _default: (client: HttpClient, httpAuth: HttpInstance) => LocalizationsService;
+export default _default;