@ckbox/core 1.2.0-dev.0 → 1.2.0-dev.1

package/dist/services/api/client/types.d.ts

@@ -1,19 +0,0 @@
-export declare type ErrorResponse = {
-    message: string;
-    data: Record<string, unknown>;
-    traceId: string;
-    statusCode: number;
-};
-export declare type ApiError = Error | ErrorResponse;
-export declare enum HTTPStatusCode {
-    FAILED_TO_FETCH_ERROR = 0,
-    OK = 200,
-    NO_CONTENT = 204,
-    MULTI_STATUS = 207,
-    BAD_REQUEST = 400,
-    UNAUTHORIZED = 401,
-    FORBIDDEN = 403,
-    NOT_FOUND = 404,
-    INTERNAL_SERVER_ERROR = 500,
-    GATEWAY_TIMEOUT = 504
-}

package/dist/services/api/errors/ApiErrorHandler.d.ts

@@ -1,53 +0,0 @@
-import { ApiClientError } from '../client';
-import { ApiClientErrorHandler, ApiClientErrorHandlerFunction } from './types';
-export declare class ApiErrorHandler {
-    private _handlers;
-    /**
-     * Adds error handler to the error handling chain.
-     *
-     * @param handler
-     */
-    next(...handlers: ApiClientErrorHandler[]): void;
-    /**
-     * Delegates error handling to the respective handlers.
-     *
-     * @param error
-     */
-    handle(error: Error): void;
-    /**
-     * Sets handler.
-     *
-     * @param handler
-     */
-    private _set;
-}
-export declare class ValidationErrorHandler implements ApiClientErrorHandler {
-    private readonly _handler;
-    constructor(_handler: ApiClientErrorHandlerFunction);
-    handle(error: ApiClientError): void;
-}
-export declare class UnauthorizedErrorHandler implements ApiClientErrorHandler {
-    private readonly _handler;
-    constructor(_handler: ApiClientErrorHandlerFunction);
-    handle(error: ApiClientError): void;
-}
-export declare class ForbiddenErrorHandler implements ApiClientErrorHandler {
-    private readonly _handler;
-    constructor(_handler: ApiClientErrorHandlerFunction);
-    handle(error: ApiClientError): void;
-}
-export declare class MissingResourceErrorHandler implements ApiClientErrorHandler {
-    private readonly _handler;
-    constructor(_handler: ApiClientErrorHandlerFunction);
-    handle(error: ApiClientError): void;
-}
-export declare class ServerErrorHandler implements ApiClientErrorHandler {
-    private readonly _handler;
-    constructor(_handler: ApiClientErrorHandlerFunction);
-    handle(error: ApiClientError): void;
-}
-export declare class UnknownErrorHandler implements ApiClientErrorHandler {
-    private readonly _handler;
-    constructor(_handler: ApiClientErrorHandlerFunction);
-    handle(error: ApiClientError): void;
-}

package/dist/services/api/errors/index.d.ts

@@ -1,2 +0,0 @@
-export * from './types';
-export * from './ApiErrorHandler';

package/dist/services/api/errors/types.d.ts

@@ -1,6 +0,0 @@
-import { ApiClientError } from '../client';
-export interface ApiClientErrorHandler {
-    handle(error: ApiClientError): void;
-}
-export declare type ApiClientErrorHandlerFunction = (error: ApiClientError) => void;
-export declare type ApiErrorHandlers = ApiClientErrorHandler | ApiClientErrorHandler[] | void;

package/dist/services/api/images/images.d.ts

@@ -1,18 +0,0 @@
-import { ApiClient } from '../client';
-import { ApiImageFormatConfig, ApiImagesConfig } from '../types';
-export declare const createApiImages: (apiClient: ApiClient) => {
-    /**
-     * Gets images configuration.
-     *
-     * @returns images configuration
-     */
-    getImagesConfig: () => Promise<ApiImagesConfig>;
-    /**
-     * Updates image format config.
-     *
-     * @param format image format
-     * @param payload image format configuration to update
-     * @returns images configuration
-     */
-    updateImageFormatConfig: (format: string, payload: ApiImageFormatConfig) => Promise<ApiImagesConfig>;
-};

package/dist/services/api/images/index.d.ts

@@ -1 +0,0 @@
-export * from './images';

package/dist/services/api/index.d.ts

@@ -1,5 +0,0 @@
-export * from './api';
-export * from './client';
-export * from './types';
-export * from './errors';
-export * from './search';

package/dist/services/api/limits/index.d.ts

@@ -1 +0,0 @@
-export * from './limits';

package/dist/services/api/limits/limits.d.ts

@@ -1,10 +0,0 @@
-import { ApiClient } from '../client';
-import { ApiPlanLimits } from '../types';
-export declare const createApiPlanLimits: (apiClient: ApiClient) => {
-    /**
-     * Gets plan limits for current environment.
-     *
-     * @returns plan limits
-     */
-    getPlanLimits: () => Promise<ApiPlanLimits | undefined>;
-};

package/dist/services/api/search/index.d.ts

@@ -1 +0,0 @@
-export * from './search';

package/dist/services/api/search/search.d.ts

@@ -1,10 +0,0 @@
-import { ApiClient } from '../client';
-import { ApiSearchPayload, ApiSearchResponse } from '../types/search';
-export declare const createApiSearch: (apiClient: ApiClient) => {
-    /**
-     * Makes a search request for assets.
-     *
-     * @returns search results
-     */
-    search: (payload: ApiSearchPayload) => Promise<ApiSearchResponse | undefined>;
-};

package/dist/services/api/types/assets.d.ts

@@ -1,131 +0,0 @@
-import { ApiAssetMetadata } from './assetsMetadata';
-import { ApiPaginatedResponse, Maybe } from './common';
-export declare enum ApiSortingOrder {
-    ASCENDING = "asc",
-    DESCENDING = "desc"
-}
-export declare enum ApiSortBy {
-    NAME = "name",
-    SIZE = "size",
-    UPLOADED_AT = "uploadedAt",
-    LAST_MODIFIED_AT = "lastModifiedAt"
-}
-export declare type ApiAsset = {
-    /**
-     * Asset id.
-     */
-    id: Maybe<string>;
-    /**
-     * Asset name.
-     */
-    name: Maybe<string>;
-    /**
-     * Asset extension.
-     */
-    extension: Maybe<string>;
-    /**
-     * Asset size.
-     */
-    size: Maybe<number>;
-    /**
-     * Asset mime-type.
-     */
-    mimeType: Maybe<string>;
-    /**
-     * Asset category id.
-     */
-    categoryId: Maybe<string>;
-    /**
-     * Asset metadata.
-     */
-    metadata: Maybe<ApiAssetMetadata>;
-    /**
-     * Asset upload time.
-     */
-    uploadedAt: Maybe<string>;
-    /**
-     * Asset last modification time.
-     */
-    lastModifiedAt: Maybe<string>;
-    /**
-     * Asset last usage time.
-     */
-    lastUsedAt: Maybe<string>;
-    /**
-     * List asset tags.
-     */
-    tags: Maybe<string[]>;
-};
-export declare type ApiUploadAssetData = {
-    /**
-     * Asset category id.
-     */
-    categoryId: string;
-    /**
-     * Asset binary.
-     */
-    file: File;
-    /**
-     * Upload progress callback.
-     */
-    progressCallback?: (loaded: number, total: number) => void;
-};
-declare type ApiAssetToDelete = {
-    /**
-     * Asset category id.
-     */
-    categoryId: string;
-};
-export declare type ApiAssetsToDelete = Record<string, ApiAssetToDelete>;
-export declare type ApiUpdateAssetPayload = {
-    /**
-     * Asset name.
-     */
-    name?: string;
-    /**
-     * Asset extension.
-     */
-    extension?: string;
-    /**
-     * Asset category id.
-     */
-    categoryId?: string;
-    /**
-     * Asset metadata.
-     */
-    metadata?: ApiAssetMetadata;
-};
-export declare type ApiUpdatedAssetResponse = ApiAsset;
-export declare type ApiAssets = ApiPaginatedResponse & {
-    /**
-     * Assets.
-     */
-    items: Maybe<ApiAsset[]>;
-};
-export declare type ApiDeletedAssetsResponse = Record<string, number>;
-export declare type ApiDeleteAssetsPayload = string[];
-export declare type ApiUpdateLastUseAssetsPayload = string[];
-export declare type ApiCategoryAssetsParams = {
-    /**
-     * Identifier of the assets category.
-     */
-    categoryId: string;
-    /**
-     * The numbers of assets to return.
-     */
-    limit?: number;
-    /**
-     * The number of assets to skip before starting to collect the result set.
-     */
-    offset?: number;
-    /**
-     * Returns assets in ascending or descending order.
-     */
-    order?: ApiSortingOrder;
-    /**
-     * Sorts assets.
-     */
-    sortBy?: ApiSortBy;
-};
-export declare type ApiRecentAssetsParams = Omit<ApiCategoryAssetsParams, 'categoryId' | 'sortBy'>;
-export {};

package/dist/services/api/types/assetsMetadata.d.ts

@@ -1,24 +0,0 @@
-import { Maybe } from './common';
-export declare type ApiAssetMetadata = {
-    /**
-     * Asset blurhash.
-     */
-    blurHash?: Maybe<string>;
-    /**
-     * Asset description.
-     */
-    description?: Maybe<string>;
-    /**
-     * Asset width.
-     */
-    width?: Maybe<number>;
-    /**
-     * Asset height.
-     */
-    height?: Maybe<number>;
-    /**
-     * Asset custom attributed.
-     */
-    customAttributes?: Maybe<Record<string, unknown>>;
-};
-export declare type ApiUpdateAssetMetadataPayload = Pick<ApiAssetMetadata, 'description' | 'customAttributes'>;

package/dist/services/api/types/categories.d.ts

@@ -1,86 +0,0 @@
-import { ApiPaginatedResponse, Maybe } from './common';
-export declare type ApiCreateCategoryPayload = {
-    /**
-     * Staged category id.
-     */
-    categoryId?: string;
-    /**
-     * Category name.
-     */
-    name: string;
-    /**
-     * Category extensions.
-     */
-    extensions: string[];
-};
-export declare type ApiUpdateCategoryPayload = {
-    /**
-     * Category name.
-     */
-    name: string;
-    /**
-     * Category extensions.
-     */
-    extensions: string[];
-};
-export declare type ApiCreatedCategoryResponse = {
-    /**
-     * Category id.
-     */
-    id: string;
-};
-export interface ApiCategory {
-    /**
-     * Category id.
-     */
-    id: Maybe<string>;
-    /**
-     * Total number of assets in the category.
-     */
-    assetsCount: Maybe<number>;
-    /**
-     * Category name.
-     */
-    name: Maybe<string>;
-    /**
-     * Allowed extensions.
-     */
-    extensions: Maybe<string[]>;
-}
-export interface ApiAdminCategory extends ApiCategory {
-    /**
-     * Lists extensions in use.
-     */
-    extensionsInUse: Maybe<string[]>;
-}
-export declare type ApiCategories = ApiPaginatedResponse & {
-    /**
-     * List of categories.
-     */
-    items: Maybe<ApiCategory[]>;
-};
-export declare type ApiAdminCategories = ApiPaginatedResponse & {
-    /**
-     * List of categories.
-     */
-    items: Maybe<ApiAdminCategory[]>;
-};
-export declare type ApiUpdateCategoriesOrderPayload = string[];
-export declare type ApiCategoriesParams = {
-    /**
-     * The number of categories to skip before starting to collect the result set.
-     */
-    offset?: number;
-    /**
-     * The numbers of categories to return.
-     */
-    limit?: number;
-    /**
-     * Sort categories by position, createdAt, updatedAt.
-     */
-    sortBy?: 'position' | 'createdAt' | 'updatedAt';
-    /**
-     * Return categories in ascending or descending order
-     */
-    order?: 'asc' | 'desc';
-};

package/dist/services/api/types/common.d.ts

@@ -1,16 +0,0 @@
-export declare type Maybe<T> = T | undefined | null;
-export declare type ApiPaginatedResponse = {
-    /**
-     * Paginated resource total count.
-     */
-    totalCount: number;
-    /**
-     * Paginated resource page offset.
-     */
-    offset: number;
-    /**
-     * Paginated resource page limit.
-     */
-    limit: number;
-};
-export declare type SearchParams = Record<string, string | number>;

package/dist/services/api/types/images.d.ts

@@ -1,8 +0,0 @@
-import { Maybe } from './common';
-export declare type ApiImageFormatConfig = {
-    /**
-     * Image quality.
-     */
-    defaultQuality: Maybe<number>;
-};
-export declare type ApiImagesConfig = Maybe<Record<string, Maybe<ApiImageFormatConfig>>>;

package/dist/services/api/types/index.d.ts

@@ -1,7 +0,0 @@
-export * from './assets';
-export * from './assetsMetadata';
-export * from './categories';
-export * from './common';
-export * from './images';
-export * from './limits';
-export * from './search';

package/dist/services/api/types/limits.d.ts

@@ -1,11 +0,0 @@
-import { Maybe } from './common';
-export declare type ApiPlanLimits = {
-    /**
-     * Maximum megapixels number that can be uploaded with the current plan.
-     */
-    maxImageInMegapixelsLimit: Maybe<number>;
-    /**
-     * Maximum number of bytes per file that can be uploaded with the current plan.
-     */
-    maxFileSizeInBytesLimit: Maybe<number>;
-};

package/dist/services/api/types/search.d.ts

@@ -1,122 +0,0 @@
-import { ApiAsset, ApiSortBy, ApiSortingOrder } from './assets';
-export declare enum PredefinedDateMode {
-    AnyTime = "0",
-    Today = "1",
-    Yesterday = "2",
-    LastWeek = "3",
-    LastMonth = "4",
-    LastSixMonths = "5",
-    LastYear = "6"
-}
-export declare type SearchFilters = {
-    categories?: {
-        in: string[];
-    };
-    extensions?: {
-        in: string[];
-    };
-    tags?: {
-        in: string[];
-    };
-    uploadedAt?: PredefinedDateMode;
-    lastModifiedAt?: PredefinedDateMode;
-};
-export declare type SearchCriteria = {
-    /**
-     * Search phrase.
-     */
-    searchPhrase: string;
-    /**
-     * Advanced filters applied to the search results.
-     */
-    filters?: SearchFilters;
-};
-export declare type ApiSearchFilters = {
-    categories?: {
-        in: string[];
-    };
-    extensions?: {
-        in: string[];
-    };
-    tags?: {
-        in: string[];
-    };
-    uploadedAt?: {
-        from?: string;
-        to?: string;
-    };
-    lastModifiedAt?: {
-        from?: string;
-        to?: string;
-    };
-};
-export declare type ApiSearchCriteria = {
-    /**
-     * Search phrase.
-     */
-    searchPhrase: string;
-    /**
-     * Advanced filters applied to the search results.
-     */
-    filters?: ApiSearchFilters;
-};
-export declare type ApiSearchPaginationParams = {
-    /**
-     * The number of assets to skip before starting to collect the result set.
-     */
-    offset: number;
-    /**
-     * The numbers of assets to return.
-     */
-    limit: number;
-    /**
-     * Sorts assets.
-     */
-    sortBy?: ApiSortBy;
-    /**
-     * Returns assets in ascending or descending order.
-     */
-    order?: ApiSortingOrder;
-};
-export declare type ApiSearchPayload = ApiSearchCriteria & {
-    /**
-     * Pagination options applied to the search result.
-     */
-    pagination: ApiSearchPaginationParams;
-};
-export declare type ApiSearchParams = ApiSearchCriteria & {
-    /**
-     * The numbers of assets to return.
-     */
-    limit?: number;
-    /**
-     * The number of assets to skip before starting to collect the result set.
-     */
-    offset?: number;
-    /**
-     * Returns assets in ascending or descending order.
-     */
-    order?: ApiSortingOrder;
-    /**
-     * Sorts assets.
-     */
-    sortBy?: ApiSortBy;
-};
-export declare type ApiSearchResponse = {
-    /**
-     * Assets being the result of the search with used criteria.
-     */
-    items: ApiAsset[];
-    /**
-     * The numbers of assets returned.
-     */
-    limit: number;
-    /**
-     * The number of assets skipped before starting to collect the result set.
-     */
-    offset: number;
-    /**
-     * The total number of assets meeting the search criteria.
-     */
-    totalCount: number;
-};

package/dist/services/auth/AuthClient.d.ts

@@ -1,89 +0,0 @@
-import { Token } from './Token';
-export interface AuthConfig {
-    /**
-     * API endpoint for retrieving tokens.
-     */
-    tokenUrl: string;
-}
-/**
- * Manages JWT token that is used for communication with API.
- */
-export declare class AuthClient {
-    /**
-     * Current timeout identifier. Used to cleanup pending timeout.
-     */
-    private _tokenTimeout?;
-    /**
-     * Currently used token.
-     */
-    private _token?;
-    /**
-     * Decoded API secret used to sign REST API requests.
-     */
-    private _apiSecret;
-    /**
-     * Indicates if token is ready to use.
-     */
-    private _isReady;
-    /**
-     * Instance of promise that fetches next token.
-     */
-    private _tokenPromise?;
-    /**
-     * Indicates if an unrecoverable error occurred.
-     */
-    private _err?;
-    /**
-     * URL where tokens are generated.
-     */
-    tokenUrl: URL;
-    constructor(config: AuthConfig);
-    /**
-     * Fetches token from a specified url.
-     *
-     * @returns token
-     */
-    private fetchToken;
-    /**
-     * Initializes token refresh lifecycle.
-     *
-     * @param initToken initial token
-     */
-    private refresh;
-    /**
-     * Decodes obfuscated api secret.
-     *
-     * @param key Key used to xor-decode api secret
-     * @param encodedApiSecret Obfuscated api secret
-     */
-    private decodeApiSecret;
-    /**
-     * Gets raw value of a token.
-     * This method is async because token might not be set and the request might be in progress.
-     *
-     * @returns token
-     */
-    tokenValue(): Promise<string | undefined>;
-    /**
-     * Parses payload of a raw token and returns it.
-     *
-     * @returns token payload
-     */
-    token(): Promise<Token | undefined>;
-    /**
-     * Cleans up state.
-     */
-    cleanup(): void;
-    /**
-     * Generates the request signature.
-     *
-     * @param url request url
-     * @param body request body
-     * @param apiSecret secret key - obfuscated api secret
-     * @returns request signature and timestamp
-     */
-    generateSignature(method: string, url: string, body?: string): {
-        signature?: string;
-        timestamp: number;
-    };
-}