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

package/dist/components/uploadDialog/uploadProgressPanel/utils.d.ts

@@ -1,29 +0,0 @@
-/// <reference types="react" />
-import { useTranslation } from '@ckbox/i18n';
-import { UploadError, UploadStatus } from '../../../providers';
-declare type TFn = ReturnType<typeof useTranslation>['t'];
-/**
- * Gets translated message for specified error data.
- *
- * @param t translation function
- * @param categoryName category name
- * @param errorData error details
- * @returns translated message
- */
-export declare const getErrorMsg: (t: TFn, categoryName: string, errorData?: UploadError) => string | import("react").ReactNode[];
-/**
- * Gets translated message for specified asset based on its status.
- *
- * @param t translation function
- * @param asset upload asset
- * @returns translated message
- */
-export declare const getHelpTextMsg: (t: TFn, status: UploadStatus, categoryName: string, errorData?: UploadError) => string | import("react").ReactNode[] | undefined;
-/**
- * Gets progress value based on asset's status.
- *
- * @param asset upload asset
- * @returns progress value
- */
-export declare const getProgress: (status: UploadStatus, progress?: number) => number;
-export {};

package/dist/components/uploadDialog/uploadQueue/UploadQueue.d.ts

@@ -1,18 +0,0 @@
-import * as React from 'react';
-import { UploadAsset } from '../../../providers';
-export interface Props {
-    /**
-     * Asset to automatically scroll to.
-     */
-    scrollTo?: UploadAsset;
-    /**
-     * Array of uploaded assets.
-     */
-    queue: UploadAsset[];
-}
-/**
- * The array of assets might have a significant size,
- * so let's limit the number of re-renders of the array by memoizing `UploadQueue` component.
- */
-declare const _default: React.NamedExoticComponent<Props>;
-export default _default;

package/dist/components/uploadDialog/uploadQueue/index.d.ts

@@ -1 +0,0 @@
-export { default } from './UploadQueue';

package/dist/components/uploadDialog/utils.d.ts

@@ -1,12 +0,0 @@
-import { useTranslation } from '@ckbox/i18n';
-declare type TFn = ReturnType<typeof useTranslation>['t'];
-/**
- * Gets translated subtitle value based on asset's status.
- *
- * @param t translation function
- * @param aborted determines if asset upload was aborted
- * @param concluded determines if asset upload was finished
- * @returns progress value
- */
-export declare const getSubTitle: (t: TFn, aborted: boolean, concluded: boolean) => string | undefined;
-export {};

package/dist/constants/constants.d.ts

@@ -1,36 +0,0 @@
-export declare enum FixedViews {
-    ADMIN = "admin",
-    RECENT = "recent",
-    SEARCH = "search"
-}
-export declare const PRODUCT_PREFIX = "CKBOX";
-/**
- * A key used to decipher API_SECRET from the process.env.API_SECRET.
- *
- * This name is used to make it similar to the obfuscated code, because
- * the preset used to obfuscate the bundle doesn't include renaming globals.
- */
-export declare const x35db57 = "nqZEt2K5=X=]G\"rr";
-/**
- * Current version of the package.
- */
-export declare const CKBOX_VERSION: string | undefined;
-/**
- * Secret to sign requests.
- *
- * This name is used to make it similar to the obfuscated code, because
- * the preset used to obfuscate the bundle doesn't include renaming globals.
- */
-export declare const x35d696: string | undefined;
-/**
- * Origin of the API server.
- */
-export declare const API_ORIGIN: string;
-/**
- * Origin of the API server with public assets.
- */
-export declare const ASSETS_ORIGIN: string;
-/**
- * Credit link url.
- */
-export declare const CREDIT_LINK_URL = "https://ckeditor.com/ckbox/";

package/dist/constants/index.d.ts

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

package/dist/core/Core.d.ts

@@ -1,5 +0,0 @@
-import * as React from 'react';
-import { CoreContext } from './CoreContext';
-declare const Core: React.FC<Props>;
-export declare type Props = CoreContext;
-export default Core;

package/dist/core/CoreContext.d.ts

@@ -1,44 +0,0 @@
-import * as React from 'react';
-import * as Providers from '../providers';
-export declare type Asset = Providers.Asset;
-export interface CoreContext {
-    /**
-     * Configures assets options.
-     */
-    assets?: Providers.AssetsConfig;
-    /**
-     * Configures origin for public assets.
-     */
-    assetsOrigin?: string;
-    /**
-     * Configures categories options.
-     */
-    categories?: Providers.CategoriesConfig;
-    /**
-     * Dialog mode options.
-     */
-    dialog?: Providers.DialogProps;
-    /**
-     * Unique ID used to distinguish various app instances.
-     * If not set, app instances will share common user preferences.
-     */
-    id?: string;
-    /**
-     * Language options.
-     */
-    language?: Providers.LanguageConfigProp;
-    /**
-     * Origin of the backend API service.
-     */
-    serviceOrigin?: string;
-    /**
-     * Theme to use.
-     */
-    theme?: string;
-    /**
-     * Token endpoint URL.
-     */
-    tokenUrl: string;
-}
-export declare const CoreContext: React.Context<CoreContext>;
-export declare const useCoreContext: () => CoreContext;

package/dist/core/CoreErrorBoundary.d.ts

@@ -1,26 +0,0 @@
-import * as React from 'react';
-interface Props {
-    /**
-     * Default React tree.
-     */
-    children: React.ReactNode;
-}
-interface State {
-    /**
-     * Error caught within boundary.
-     */
-    error?: Error;
-    /**
-     * Flag indicating if an error has been caught.
-     */
-    hasError: boolean;
-}
-declare class CoreErrorBoundary extends React.Component<Props, State> {
-    constructor(props: Props);
-    static getDerivedStateFromError(error: Error): {
-        error: Error;
-        hasError: boolean;
-    };
-    render(): string | number | boolean | React.ReactFragment | JSX.Element | null | undefined;
-}
-export default CoreErrorBoundary;

package/dist/core/CoreFallbackProviders.d.ts

@@ -1,9 +0,0 @@
-import * as React from 'react';
-declare const CoreFallbackProviders: React.FC<Props>;
-export interface Props {
-    /**
-     * Error instance for which fallback view is displayed.
-     */
-    error?: Error;
-}
-export default CoreFallbackProviders;

package/dist/core/CoreProviders.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="react" />
-declare const CoreProviders: () => JSX.Element;
-export default CoreProviders;

package/dist/core/index.d.ts

@@ -1,4 +0,0 @@
-export * from './Core';
-export * from './CoreContext';
-export { default as CoreProviders } from './CoreProviders';
-export { default } from './Core';

package/dist/providers/api/ApiContext.d.ts

@@ -1,12 +0,0 @@
-import * as React from 'react';
-import { createApi } from '../../services';
-export interface ApiContext {
-    /**
-     * API endpoints.
-     */
-    api?: ReturnType<typeof createApi>;
-}
-/**
- * Defines React context for API.
- */
-export declare const ApiContext: React.Context<ApiContext>;

package/dist/providers/api/ApiProvider.d.ts

@@ -1,17 +0,0 @@
-import * as React from 'react';
-declare const ApiProvider: React.FC<Props>;
-export interface Props {
-    /**
-     * Main content.
-     */
-    children: React.ReactNode;
-    /**
-     * Configures origin for public assets.
-     */
-    assetsOrigin: string;
-    /**
-     * Origin of the backend API service.
-     */
-    serviceOrigin: string;
-}
-export default ApiProvider;

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

@@ -1,3 +0,0 @@
-export * from './useApi';
-export * from './ApiContext';
-export { default as ApiProvider } from './ApiProvider';

package/dist/providers/api/useApi.d.ts

@@ -1,42 +0,0 @@
-export declare const useApi: () => {
-    api: {
-        assets: {
-            deleteAssets: (assetIds: string[]) => Promise<import("../../services").ApiDeletedAssetsResponse | undefined>;
-            getCategoryAssets: (params: import("../../services").ApiCategoryAssetsParams) => Promise<import("../../services").ApiAssets | undefined>;
-            getRecentAssets: (params: import("../../services").ApiRecentAssetsParams) => Promise<import("../../services").ApiAssets | undefined>;
-            updateAsset: (assetId: string, payload: import("../../services").ApiUpdateAssetPayload) => Promise<import("../../services").ApiAsset | undefined>;
-            uploadAsset: () => {
-                start: <JSONResponse>(payload: Record<string, string | Blob>, progressCallback?: ((loaded: number, total: number) => void) | undefined) => Promise<JSONResponse>;
-                abort: () => void;
-            };
-            getAssetUrl: (assetId: string, forceDownload?: boolean) => string;
-            getAsset: (assetId: string) => Promise<import("../../services").ApiAsset | undefined>;
-            updateAssetLastUse: (assetIds: string[]) => Promise<void | undefined>;
-            getAssetThumbUrl: (assetId: string, width: number, heightOrFormat?: string | number | undefined, format?: string | undefined) => string;
-            getAssetResponsiveImageUrl: (assetId: string, width: number, heightOrFormat?: string | number | undefined, format?: string | undefined) => string;
-        };
-        categories: {
-            createCategory: (payload: import("../../services").ApiCreateCategoryPayload) => Promise<import("../../services").ApiCreatedCategoryResponse | undefined>;
-            deleteCategory: (categoryId: string) => Promise<unknown>;
-            getAdminCategories: (params?: import("../../services").ApiCategoriesParams) => Promise<import("../../services").ApiAdminCategories | undefined>;
-            getCategories: (params?: import("../../services").ApiCategoriesParams) => Promise<import("../../services").ApiCategories | undefined>;
-            getCategory: (id: string) => Promise<import("../../services").ApiCategory | undefined>;
-            updateCategory: (categoryId: string, payload: import("../../services").ApiUpdateCategoryPayload) => Promise<undefined>;
-            updateCategoriesOrder: (payload: import("../../services").ApiUpdateCategoriesOrderPayload) => Promise<undefined>;
-        };
-        images: {
-            getImagesConfig: () => Promise<import("../../services").ApiImagesConfig>;
-            updateImageFormatConfig: (format: string, payload: import("../../services").ApiImageFormatConfig) => Promise<import("../../services").ApiImagesConfig>;
-        };
-        planLimits: {
-            getPlanLimits: () => Promise<import("../../services").ApiPlanLimits | undefined>;
-        };
-        search: {
-            search: (payload: import("../../services").ApiSearchPayload) => Promise<import("../../services").ApiSearchResponse | undefined>;
-        };
-        config: {
-            serviceOrigin: string;
-            assetsOrigin: string;
-        };
-    };
-};

package/dist/providers/assetsConfig/AssetsConfigContext.d.ts

@@ -1,41 +0,0 @@
-import * as React from 'react';
-import { ParsedAsset } from '../data';
-export interface AssetExtraProps {
-    /**
-     * API origin.
-     */
-    origin: string;
-    /**
-     * Callback that returns URL to the resource.
-     */
-    getUrl: (forceDownload?: boolean) => string;
-    /**
-     * Callback that returns URL to image of specified dimensions. Resource at URL is cached on CDN.
-     * Returns `false` if there is no image available for the asset.
-     */
-    getResponsiveImageUrl: (width: number, heightOrFormat?: number | string, format?: string) => string | false;
-}
-export interface Asset extends AssetExtraProps {
-    data: ParsedAsset;
-}
-export declare type AssetsConfigOnChoose = (assets: ParsedAsset[]) => void;
-export declare type AssetsConfigOnChooseEnhanced = (assets: Asset[]) => void;
-export interface AssetsConfig {
-    /**
-     * Callback invoked upon clicking on `Choose` button.
-     * List of currently selected assets is passed as an argument.
-     */
-    onChoose?: AssetsConfigOnChooseEnhanced;
-}
-export interface AssetsConfigContext {
-    /**
-     * Callback invoked upon clicking on `Choose` button.
-     * List of currently selected assets is passed as an argument.
-     */
-    onChoose?: AssetsConfigOnChoose;
-}
-/**
- * Defines React context for assets config.
- */
-export declare const AssetsConfigContext: React.Context<AssetsConfigContext>;
-export declare const useAssetsConfig: () => AssetsConfigContext;

package/dist/providers/assetsConfig/AssetsConfigProvider.d.ts

@@ -1,16 +0,0 @@
-import * as React from 'react';
-import { AssetsConfigOnChooseEnhanced } from './AssetsConfigContext';
-declare const AssetsConfigProvider: React.FC<Props>;
-export interface Props {
-    /**
-     * Main content.
-     */
-    children: React.ReactNode;
-    /**
-     * Callback invoked upon clicking on `Choose` button.
-     * List of currently selected assets is passed as an argument.
-     * Each asset is enhanced with extra props.
-     */
-    onChoose?: AssetsConfigOnChooseEnhanced;
-}
-export default AssetsConfigProvider;

package/dist/providers/assetsConfig/index.d.ts

@@ -1,3 +0,0 @@
-export * from './utils';
-export * from './AssetsConfigContext';
-export { default as AssetsConfigProvider } from './AssetsConfigProvider';

package/dist/providers/assetsConfig/utils.d.ts

@@ -1,11 +0,0 @@
-/**
- * Only for the following extensions an asset image preview will be shown.
- */
-export declare const ASSET_PREVIEW_EXTENSIONS: string[];
-/**
- * Checks if asset can be previewed.
- *
- * @param extension asset extension
- * @returns flag indicating if asset can be previewed
- */
-export declare const canAssetBePreviewed: (extension: string) => boolean;

package/dist/providers/auth/AuthContext.d.ts

@@ -1,16 +0,0 @@
-import * as React from 'react';
-import { AuthClient, Token } from '../../services';
-export interface AuthContext {
-    /**
-     * Instance of authentication client class.
-     */
-    authClient?: AuthClient;
-    /**
-     * Token object.
-     */
-    token?: Token;
-}
-/**
- * Defines React context for authentication.
- */
-export declare const AuthContext: React.Context<AuthContext>;

package/dist/providers/auth/AuthProvider.d.ts

@@ -1,14 +0,0 @@
-import * as React from 'react';
-import { AuthConfig } from '../../services';
-declare const AuthProvider: React.FC<Props>;
-export interface Props {
-    /**
-     * Main content.
-     */
-    children: React.ReactNode;
-    /**
-     * Authentication config.
-     */
-    auth: AuthConfig;
-}
-export default AuthProvider;

package/dist/providers/auth/index.d.ts

@@ -1,3 +0,0 @@
-export * from './useAuth';
-export * from './AuthContext';
-export { default as AuthProvider } from './AuthProvider';

package/dist/providers/auth/useAuth.d.ts

@@ -1,4 +0,0 @@
-export declare const useAuth: () => {
-    authClient: import("../../services").AuthClient;
-    token?: import("../../services").Token | undefined;
-};

package/dist/providers/categoriesConfig/CategoriesConfigContext.d.ts

@@ -1,24 +0,0 @@
-import * as React from 'react';
-import { IconName, IconRenderProp } from '@ckbox/components';
-import { GetCategoryIconProps } from './utils';
-export interface CategoryIconProps {
-    name?: IconName;
-    render?: IconRenderProp;
-}
-export interface CategoriesConfigContext {
-    /**
-     * Gets icon renderer for a given category.
-     */
-    getCategoryIconProps: (params: GetCategoryIconProps) => CategoryIconProps;
-}
-export declare type CategoriesConfig = {
-    /**
-     * Maps category names to custom icons.
-     */
-    icons?: Record<string, IconRenderProp>;
-};
-/**
- * Defines React context for assets config.
- */
-export declare const CategoriesConfigContext: React.Context<CategoriesConfigContext>;
-export declare const useCategoriesConfig: () => CategoriesConfigContext;

package/dist/providers/categoriesConfig/CategoriesConfigProvider.d.ts

@@ -1,10 +0,0 @@
-import * as React from 'react';
-import { CategoriesConfig } from './CategoriesConfigContext';
-declare const CategoriesConfigProvider: React.FC<Props>;
-export interface Props extends CategoriesConfig {
-    /**
-     * Pass-through content.
-     */
-    children: React.ReactNode;
-}
-export default CategoriesConfigProvider;

package/dist/providers/categoriesConfig/index.d.ts

@@ -1,2 +0,0 @@
-export * from './CategoriesConfigContext';
-export { default as CategoriesConfigProvider } from './CategoriesConfigProvider';

package/dist/providers/categoriesConfig/utils.d.ts

@@ -1,16 +0,0 @@
-import { IconRenderProp } from '@ckbox/components';
-import { CategoryIconProps } from './CategoriesConfigContext';
-export declare type GetCategoryIconProps = Pick<GetCategoryIconPropsOptions, 'categoryName' | 'categoryId'>;
-export declare type GetCategoryIconPropsOptions = {
-    categoryName?: string;
-    categoryId?: string;
-    icons: Record<string, IconRenderProp>;
-};
-/**
- * Gets icon name or renderer function for a given category name.
- *
- * @param categoryName category name
- * @param icons maps category name to icon renderer or name
- * @returns icon name or renderer
- */
-export declare const getCategoryIconProps: (params: GetCategoryIconPropsOptions) => CategoryIconProps;

package/dist/providers/data/hooks/assets/index.d.ts

@@ -1,7 +0,0 @@
-export * from './useGetCategoryAssets';
-export * from './useDeleteAssets';
-export * from './useGetRecentAssets';
-export * from './useUpdateAsset';
-export * from './useUpdateAssetLastUse';
-export * from './useLazyGetAsset';
-export * from './useGetAsset';

package/dist/providers/data/hooks/assets/useDeleteAssets.d.ts

@@ -1,71 +0,0 @@
-import { ApiAssetsToDelete, ApiDeletedAssetsResponse } from '../../../../services';
-/**
- * Deletes multiple assets by id.
- *
- * @returns deleted assets data
- */
-export declare const useDeleteAssets: () => {
-    mutateAsync: import("../types").ErrorSuppressedMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
-    data: undefined;
-    error: null;
-    isError: false;
-    isIdle: true;
-    isLoading: false;
-    isSuccess: false;
-    status: "idle";
-    mutate: import("@tanstack/react-query").UseMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
-    reset: () => void;
-    context: unknown;
-    failureCount: number;
-    failureReason: Error | null;
-    isPaused: boolean;
-    variables: ApiAssetsToDelete | undefined;
-} | {
-    mutateAsync: import("../types").ErrorSuppressedMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
-    data: undefined;
-    error: null;
-    isError: false;
-    isIdle: false;
-    isLoading: true;
-    isSuccess: false;
-    status: "loading";
-    mutate: import("@tanstack/react-query").UseMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
-    reset: () => void;
-    context: unknown;
-    failureCount: number;
-    failureReason: Error | null;
-    isPaused: boolean;
-    variables: ApiAssetsToDelete | undefined;
-} | {
-    mutateAsync: import("../types").ErrorSuppressedMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
-    data: undefined;
-    error: Error;
-    isError: true;
-    isIdle: false;
-    isLoading: false;
-    isSuccess: false;
-    status: "error";
-    mutate: import("@tanstack/react-query").UseMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
-    reset: () => void;
-    context: unknown;
-    failureCount: number;
-    failureReason: Error | null;
-    isPaused: boolean;
-    variables: ApiAssetsToDelete | undefined;
-} | {
-    mutateAsync: import("../types").ErrorSuppressedMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
-    data: ApiDeletedAssetsResponse | undefined;
-    error: null;
-    isError: false;
-    isIdle: false;
-    isLoading: false;
-    isSuccess: true;
-    status: "success";
-    mutate: import("@tanstack/react-query").UseMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
-    reset: () => void;
-    context: unknown;
-    failureCount: number;
-    failureReason: Error | null;
-    isPaused: boolean;
-    variables: ApiAssetsToDelete | undefined;
-};

package/dist/providers/data/hooks/assets/useGetAsset.d.ts

@@ -1,6 +0,0 @@
-/**
- * Manages a single asset.
- *
- * @returns details of queried asset.
- */
-export declare const useGetAsset: (assetId: string) => import("@tanstack/react-query").UseQueryResult<import("../../parsers").ParsedAsset, Error>;

package/dist/providers/data/hooks/assets/useGetCategoryAssets.d.ts

@@ -1,11 +0,0 @@
-import { ApiCategoryAssetsParams } from '../../../../services';
-/**
- * Manages list of category assets.
- *
- * @param params parameters for API call
- * @returns list of queried category assets
- */
-export declare const useGetCategoryAssets: (params: ApiCategoryAssetsParams, enabled?: boolean) => import("@tanstack/react-query").UseQueryResult<{
-    totalCount: number | undefined;
-    items: import("../../parsers").ParsedAsset[];
-}, Error>;

package/dist/providers/data/hooks/assets/useGetRecentAssets.d.ts

@@ -1,10 +0,0 @@
-import { ApiRecentAssetsParams } from '../../../../services';
-/**
- * Manages list of category assets.
- *
- * @returns list of queried category assets
- */
-export declare const useGetRecentAssets: (params: ApiRecentAssetsParams, enabled?: boolean) => import("@tanstack/react-query").UseQueryResult<{
-    totalCount: number | undefined;
-    items: import("../../parsers").ParsedAsset[];
-}, Error>;

package/dist/providers/data/hooks/assets/useLazyGetAsset.d.ts

@@ -1,10 +0,0 @@
-import { ParsedAsset } from '../../parsers';
-/**
- * Fetches the details of a single asset.
- *
- * @returns fetch callback
- */
-export declare const useLazyGetAsset: () => {
-    fetchAsset: (asset?: ParsedAsset) => Promise<ParsedAsset | undefined>;
-    isLoading: boolean;
-};