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

package/dist/providers/data/hooks/useMutation.d.ts

@@ -1,67 +0,0 @@
-import { MutationFunction } from '@tanstack/react-query';
-import { UseExtendedMutationOptions, ErrorSuppressedMutateFunction } from './types';
-export declare const useMutation: <TData = unknown, TError extends Error = Error, TVariables = void, TContext = unknown>(mutationFn: MutationFunction<TData, TVariables>, options?: UseExtendedMutationOptions<TData, TError, TVariables, TContext> | undefined) => {
-    mutateAsync: ErrorSuppressedMutateFunction<TData, TError, TVariables, TContext>;
-    data: undefined;
-    error: null;
-    isError: false;
-    isIdle: true;
-    isLoading: false;
-    isSuccess: false;
-    status: "idle";
-    mutate: import("@tanstack/react-query").UseMutateFunction<TData, TError, TVariables, TContext>;
-    reset: () => void;
-    context: TContext | undefined;
-    failureCount: number;
-    failureReason: TError | null;
-    isPaused: boolean;
-    variables: TVariables | undefined;
-} | {
-    mutateAsync: ErrorSuppressedMutateFunction<TData, TError, TVariables, TContext>;
-    data: undefined;
-    error: null;
-    isError: false;
-    isIdle: false;
-    isLoading: true;
-    isSuccess: false;
-    status: "loading";
-    mutate: import("@tanstack/react-query").UseMutateFunction<TData, TError, TVariables, TContext>;
-    reset: () => void;
-    context: TContext | undefined;
-    failureCount: number;
-    failureReason: TError | null;
-    isPaused: boolean;
-    variables: TVariables | undefined;
-} | {
-    mutateAsync: ErrorSuppressedMutateFunction<TData, TError, TVariables, TContext>;
-    data: undefined;
-    error: TError;
-    isError: true;
-    isIdle: false;
-    isLoading: false;
-    isSuccess: false;
-    status: "error";
-    mutate: import("@tanstack/react-query").UseMutateFunction<TData, TError, TVariables, TContext>;
-    reset: () => void;
-    context: TContext | undefined;
-    failureCount: number;
-    failureReason: TError | null;
-    isPaused: boolean;
-    variables: TVariables | undefined;
-} | {
-    mutateAsync: ErrorSuppressedMutateFunction<TData, TError, TVariables, TContext>;
-    data: TData;
-    error: null;
-    isError: false;
-    isIdle: false;
-    isLoading: false;
-    isSuccess: true;
-    status: "success";
-    mutate: import("@tanstack/react-query").UseMutateFunction<TData, TError, TVariables, TContext>;
-    reset: () => void;
-    context: TContext | undefined;
-    failureCount: number;
-    failureReason: TError | null;
-    isPaused: boolean;
-    variables: TVariables | undefined;
-};

package/dist/providers/data/hooks/useQuery.d.ts

@@ -1,3 +0,0 @@
-import { QueryFunction, QueryKey } from '@tanstack/react-query';
-import { UseExtendedQueryOptions } from './types';
-export declare const useQuery: <TQueryFnData = unknown, TError extends Error = Error, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: UseExtendedQueryOptions<TQueryFnData, TError, TData, TQueryKey> | undefined) => import("@tanstack/react-query").UseQueryResult<TData, TError>;

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

@@ -1,2 +0,0 @@
-export * from './hooks';
-export * from './parsers';

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

@@ -1,3 +0,0 @@
-export * from './parseAsset';
-export * from './parseAssets';
-export * from './types';

package/dist/providers/data/parsers/assets/parseAsset.d.ts

@@ -1,9 +0,0 @@
-import { ApiAsset } from '../../../../services';
-import { ParsedAsset } from './types';
-/**
- * Parses asset from API. Provides fallback value if needed.
- *
- * @param asset asset to parse
- * @returns parsed asset
- */
-export declare const parseAsset: (asset?: ApiAsset) => ParsedAsset;

package/dist/providers/data/parsers/assets/parseAssets.d.ts

@@ -1,9 +0,0 @@
-import { ApiAsset } from '../../../../services';
-import { ParsedAsset } from './types';
-/**
- * Parses a list of assets. Provides fallback if needed.
- *
- * @param assets list of assets to parse
- * @returns list of parsed assets
- */
-export declare const parseAssets: (assets?: ApiAsset[]) => ParsedAsset[];

package/dist/providers/data/parsers/assets/types.d.ts

@@ -1,39 +0,0 @@
-import { ParsedAssetMetadata } from '../assetsMetadata';
-export interface ParsedAsset {
-    /**
-     * Asset id.
-     */
-    id: string;
-    /**
-     * Asset name.
-     */
-    name: string;
-    /**
-     * Asset file extension.
-     */
-    extension: string;
-    /**
-     * Converted asset size.
-     */
-    size?: number;
-    /**
-     * Asset last modification time.
-     */
-    lastModifiedAt?: string;
-    /**
-     * Asset upload date.
-     */
-    uploadedAt?: string;
-    /**
-     * Asset metadata.
-     */
-    metadata: ParsedAssetMetadata;
-    /**
-     * Asset category id.
-     */
-    categoryId: string;
-    /**
-     * Asset tags.
-     */
-    tags: string[];
-}

package/dist/providers/data/parsers/assetsMetadata/index.d.ts

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

package/dist/providers/data/parsers/assetsMetadata/parseAssetMetadata.d.ts

@@ -1,9 +0,0 @@
-import { ApiAssetMetadata } from '../../../../services';
-import { ParsedAssetMetadata } from './types';
-/**
- * Parses asset's metadata. Provides fallback values if necessary.
- *
- * @param metadata asset's metadata to parse
- * @returns parsed metadata
- */
-export declare const parseAssetMetadata: (metadata?: ApiAssetMetadata) => ParsedAssetMetadata;

package/dist/providers/data/parsers/assetsMetadata/types.d.ts

@@ -1,22 +0,0 @@
-export interface ParsedAssetMetadata {
-    /**
-     * Asset blurhash.
-     */
-    blurHash?: string;
-    /**
-     * Asset description.
-     */
-    description: string;
-    /**
-     * Asset width in px.
-     */
-    width?: number;
-    /**
-     * Asset height in px.
-     */
-    height?: number;
-    /**
-     * Set of custom attributes.
-     */
-    customAttributes?: Record<string, unknown>;
-}

package/dist/providers/data/parsers/categories/index.d.ts

@@ -1,4 +0,0 @@
-export * from './parseAdminCategories';
-export * from './parseCategories';
-export * from './parseCategory';
-export * from './types';

package/dist/providers/data/parsers/categories/parseAdminCategories.d.ts

@@ -1,13 +0,0 @@
-import { ApiAdminCategories } from '../../../../services';
-import { ParsedAdminCategory } from './types';
-/**
- * Parses admin categories from API. Merges them with existing ones. Provides fallbacks if needed.
- *
- * Categories fetched from the backend must be merged manully with existing ones.
- * This is due to the fact that new categories might be in staging phase, e.g. newly added or updated categories (but not saved yet).
- *
- * @param categories categories from API
- * @param cachedCategories cached categories
- * @returns parsed categories
- */
-export declare const parseAdminCategories: (categories?: ApiAdminCategories, cachedCategories?: ParsedAdminCategory[]) => ParsedAdminCategory[];

package/dist/providers/data/parsers/categories/parseCategories.d.ts

@@ -1,9 +0,0 @@
-import { ApiCategory, Maybe } from '../../../../services';
-import { ParsedCategory } from './types';
-/**
- * Parses a list of categories. Provides fallback if needed.
- *
- * @param categories categories from API
- * @returns parsed category
- */
-export declare const parseCategories: (categories: Maybe<ApiCategory[]>) => ParsedCategory[];

package/dist/providers/data/parsers/categories/parseCategory.d.ts

@@ -1,9 +0,0 @@
-import { ApiCategory, Maybe } from '../../../../services';
-import { ParsedCategory } from './types';
-/**
- * Parses API category.
- *
- * @param category category from API
- * @returns parsed category
- */
-export declare const parseCategory: (category: Maybe<ApiCategory>) => ParsedCategory;

package/dist/providers/data/parsers/categories/types.d.ts

@@ -1,39 +0,0 @@
-export interface ParsedCategory {
-    /**
-     * Category id.
-     */
-    id: string;
-    /**
-     * Total number of assets in the category.
-     */
-    assetsCount: number;
-    /**
-     * Category name.
-     */
-    name: string;
-    /**
-     * Allowed extensions.
-     */
-    extensions: string[];
-}
-export interface ParsedAdminCategory extends ParsedCategory {
-    /**
-     * Extensions in use.
-     */
-    extensionsInUse: string[];
-    /**
-     * Additional data that can be added to a category.
-     * A category with `stage` property is in staging phase.
-     * These are newly added or updated categories (but not saved yet).
-     */
-    stage?: {
-        /**
-         * Indicates if category is in editing mode.
-         */
-        edit?: boolean;
-        /**
-         * Indicates if this is a newly added category.
-         */
-        newlyAdded?: boolean;
-    };
-}

package/dist/providers/data/parsers/index.d.ts

@@ -1,3 +0,0 @@
-export * from './assets';
-export * from './assetsMetadata';
-export * from './categories';

package/dist/providers/index.d.ts

@@ -1,12 +0,0 @@
-export * from './api';
-export * from './assetsConfig';
-export * from './auth';
-export * from './categoriesConfig';
-export * from './data';
-export * from './language';
-export * from './query';
-export * from './upload';
-export * from './user';
-export * from './notifications';
-export * from './ui';
-export * from './limits';

package/dist/providers/language/LanguageProvider.d.ts

@@ -1,4 +0,0 @@
-import * as React from 'react';
-import { LanguageProps } from './types';
-declare const LanguageProvider: React.FC<LanguageProps>;
-export default LanguageProvider;

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

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

package/dist/providers/language/types.d.ts

@@ -1,22 +0,0 @@
-/// <reference types="react" />
-export interface LanguageConfig {
-    /**
-     * Turns on debugging mode for simplifying translation process (info logged to JS console).
-     */
-    debug?: boolean;
-    /**
-     * Defines language code in case if an object is passed, e.g. 'en'.
-     */
-    ui?: string;
-}
-export declare type LanguageConfigProp = string | LanguageConfig;
-export interface LanguageProps {
-    /**
-     * Main content.
-     */
-    children: React.ReactNode;
-    /**
-     * Takes language code, e.g. 'en' or a detailed configuration options object.
-     */
-    language?: LanguageConfigProp;
-}

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

@@ -1,16 +0,0 @@
-import { I18nProps, I18nTranslations } from '@ckbox/i18n';
-import { LanguageConfigProp } from './types';
-/**
- * Gets resources from global scope.
- *
- * @param locale requested language
- * @returns translations
- */
-export declare const getTranslations: (locale: string) => I18nTranslations;
-/**
- * Maps language-related props exposed by `core` public API to internal `i18n` props.
- *
- * @param language language code or config
- * @returns config for `i18n` module
- */
-export declare const mapLangToI18n: (language?: LanguageConfigProp) => I18nProps;

package/dist/providers/limits/PlanLimitsContext.d.ts

@@ -1,11 +0,0 @@
-import * as React from 'react';
-import { ApiPlanLimits } from '../../services';
-declare type PlanLimits = ApiPlanLimits & {
-    isPersonalPlan: boolean;
-};
-/**
- * Defines React context for the subscription plan limits.
- */
-export declare const PlanLimitsContext: React.Context<PlanLimits>;
-export declare const usePlanLimits: () => PlanLimits;
-export {};

package/dist/providers/limits/PlanLimitsProvider.d.ts

@@ -1,9 +0,0 @@
-import * as React from 'react';
-declare const PlanLimitsProvider: React.FC<Props>;
-export interface Props {
-    /**
-     * Main content.
-     */
-    children: React.ReactNode;
-}
-export default PlanLimitsProvider;

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

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

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

@@ -1,7 +0,0 @@
-import { ApiPlanLimits } from '../../services/api/types';
-/**
- * Returns true if applied environment limits meet the Personal subscription plan.
- *
- * @param planLimits - Environment plan limits
- */
-export declare const hasPersonalPlan: (planLimits: ApiPlanLimits | undefined) => boolean;

package/dist/providers/notifications/NotificationsContext.d.ts

@@ -1,53 +0,0 @@
-import * as React from 'react';
-export interface Notification {
-    /**
-     * Notification id.
-     */
-    id: string;
-    /**
-     * Notification type.
-     */
-    type: 'success' | 'error' | 'info';
-    /**
-     * Notification title.
-     */
-    title: string;
-    /**
-     * Notification details.
-     */
-    details?: React.ReactNode;
-}
-interface NotificationsContextShape {
-    /**
-     * Method for dismissing notification by id.
-     */
-    dismissNotification: (id: string) => void;
-    /**
-     * Optional element rendered below notification's container.
-     * Container's position should be adjusted in accordance with provided element's height.
-     */
-    bottomOffsetEl?: HTMLElement | null;
-    /**
-     * Root element to which notifications container should be mounted to. Defaults to UI root container.
-     */
-    notificationsRootEl?: HTMLElement | null;
-    /**
-     * List of the notifications within the context.
-     */
-    notifications: Notification[];
-    /**
-     * Method for pushing new notification.
-     */
-    pushNotification: (notification: Omit<Notification, 'id'>) => void;
-    /**
-     * Setter for bottom offset element.
-     */
-    setBottomOffsetEl: (el: HTMLElement | null) => void;
-    /**
-     * Setter for notifications root element.
-     */
-    setNotificationsRootEl: (el: HTMLElement | null) => void;
-}
-export declare const NotificationsContext: React.Context<NotificationsContextShape>;
-export declare const useNotifications: () => NotificationsContextShape;
-export {};

package/dist/providers/notifications/NotificationsProvider.d.ts

@@ -1,9 +0,0 @@
-import * as React from 'react';
-declare const NotificationsProvider: React.FC<Props>;
-interface Props {
-    /**
-     * Main content of the component.
-     */
-    children: React.ReactNode;
-}
-export default NotificationsProvider;

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

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

package/dist/providers/query/QueryProvider.d.ts

@@ -1,12 +0,0 @@
-import * as React from 'react';
-/**
- * Configures `@tanstack/react-query` provider.
- */
-declare const QueryProvider: React.FC<Props>;
-export interface Props {
-    /**
-     * Main content.
-     */
-    children: React.ReactNode;
-}
-export default QueryProvider;

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

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

package/dist/providers/ui/UIProvider.d.ts

@@ -1,22 +0,0 @@
-import * as React from 'react';
-import { DialogProps } from './types';
-declare const UIProvider: React.FC<Props>;
-export interface Props {
-    /**
-     * Main content.
-     */
-    children: React.ReactNode;
-    /**
-     * Dialog mode options.
-     */
-    dialog?: DialogProps;
-    /**
-     * Name of the selected theme.
-     */
-    theme?: string;
-    /**
-     * Aria label to set on root element.
-     */
-    label?: string;
-}
-export default UIProvider;

package/dist/providers/ui/UIProviderContainerMode.d.ts

@@ -1,4 +0,0 @@
-import * as React from 'react';
-import { UIProviderProps } from '@ckbox/components';
-declare const UIProviderContainerMode: React.FC<UIProviderProps>;
-export default UIProviderContainerMode;

package/dist/providers/ui/UIProviderDialogMode.d.ts

@@ -1,20 +0,0 @@
-import * as React from 'react';
-import { UIProviderProps } from '@ckbox/components';
-import { DialogProps } from './types';
-import { DialogDimensions } from '../user';
-declare const UIProviderDialogMode: React.FC<Props>;
-export interface Props extends Omit<UIProviderProps, 'dialog'> {
-    /**
-     * Dialog mode options.
-     */
-    dialog: DialogProps;
-    /**
-     * Initial dialog dimensions.
-     */
-    dialogDimensions?: DialogDimensions;
-    /**
-     * Callback invoked when dialog dimensions change.
-     */
-    onDialogDimensionsChange: (dimensions: DialogDimensions) => void;
-}
-export default UIProviderDialogMode;

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

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

package/dist/providers/ui/types.d.ts

@@ -1,19 +0,0 @@
-export interface DialogModeProps {
-    /**
-     * Initial dialog height.
-     */
-    height?: string | number;
-    /**
-     * Toggles dialog.
-     */
-    open: boolean;
-    /**
-     * Callback invoked upon clicking on close button.
-     */
-    onClose?: () => void;
-    /**
-     * Initial dialog width.
-     */
-    width?: string | number;
-}
-export declare type DialogProps = boolean | DialogModeProps;

package/dist/providers/upload/UploadContext.d.ts

@@ -1,48 +0,0 @@
-import * as React from 'react';
-/**
- * Defines React context for upload dialog.
- */
-export declare const UploadComponentsContext: React.Context<{
-    autoScroll: boolean;
-    isDialogOpen: boolean;
-    isIndicatorOpen: boolean;
-    closeDialog: (uploadConcluded?: boolean) => void;
-    disableAutoHide: () => void;
-    disableAutoFeats: () => void;
-    onUploadConcluded: (assets: import("./types").UploadAsset[]) => void;
-    openDialog: () => void;
-    openIndicator: () => void;
-    toggleDialog: (uploadConcluded?: boolean) => void;
-    setUploadIndicatorEl: React.Dispatch<React.SetStateAction<HTMLElement | null>>;
-    uploadIndicatorEl: HTMLElement | null;
-}>;
-/**
- * Defines React context for upload state.
- */
-export declare const UploadStateContext: React.Context<import("./types").UploadState>;
-/**
- * Defines React context for upload actions.
- */
-export declare const UploadUpdaterContext: React.Context<{
-    abortUpload: (assets: import("./types").UploadAsset[]) => void;
-    processFiles: (category: import("..").ParsedCategory, files: File[]) => void;
-}>;
-export declare const useUploadComponents: () => {
-    autoScroll: boolean;
-    isDialogOpen: boolean;
-    isIndicatorOpen: boolean;
-    closeDialog: (uploadConcluded?: boolean) => void;
-    disableAutoHide: () => void;
-    disableAutoFeats: () => void;
-    onUploadConcluded: (assets: import("./types").UploadAsset[]) => void;
-    openDialog: () => void;
-    openIndicator: () => void;
-    toggleDialog: (uploadConcluded?: boolean) => void;
-    setUploadIndicatorEl: React.Dispatch<React.SetStateAction<HTMLElement | null>>;
-    uploadIndicatorEl: HTMLElement | null;
-};
-export declare const useUploadState: () => import("./types").UploadState;
-export declare const useUploadUpdater: () => {
-    abortUpload: (assets: import("./types").UploadAsset[]) => void;
-    processFiles: (category: import("..").ParsedCategory, files: File[]) => void;
-};

package/dist/providers/upload/UploadProvider.d.ts

@@ -1,14 +0,0 @@
-import * as React from 'react';
-import { UploadProps } from './types';
-declare const UploadProvider: React.FC<Props>;
-export interface Props {
-    /**
-     * Main content.
-     */
-    children: React.ReactNode;
-    /**
-     * Upload config.
-     */
-    upload?: UploadProps;
-}
-export default UploadProvider;