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

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

@@ -0,0 +1,39 @@
+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

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

package/dist/providers/index.d.ts

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,4 @@
+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

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

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

@@ -0,0 +1,22 @@
+/// <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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,9 @@
+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

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

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

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

@@ -0,0 +1,53 @@
+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

@@ -0,0 +1,9 @@
+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

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

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

@@ -0,0 +1,12 @@
+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

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

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

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,20 @@
+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

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

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

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,48 @@
+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

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

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

@@ -0,0 +1,142 @@
+export declare enum UploadActionType {
+    /**
+     * Marks specified assets as aborted.
+     */
+    ABORT_UPLOAD = 0,
+    /**
+     * Clears queue by removing assets marked as concluded.
+     */
+    CLEAR_QUEUE = 1,
+    /**
+     * Marks specified asset as completed.
+     */
+    COMPLETE_UPLOAD = 2,
+    /**
+     * Disables abort for the specified asset.
+     */
+    DISABLE_ABORT = 3,
+    /**
+     * Adds specified assets to the queue.
+     */
+    QUEUE_UPLOAD = 4,
+    /**
+     * Marks specified asset as rejected.
+     */
+    REJECT_UPLOAD = 5,
+    /**
+     * Marks specified asset as being in progress.
+     */
+    START_UPLOAD = 6,
+    /**
+     * Updates progress of specified assets.
+     */
+    UPDATE_PROGRESS = 7
+}
+export declare enum UploadErrorData {
+    PLAN_EXCEEDED_MEGAPIXELS_KEY = "megapixelsLimit",
+    PLAN_EXCEEDED_SIZE_KEY = "sizeLimit",
+    STORAGE_QUOTA_EXCEEDED_KEY = "limit"
+}
+export declare enum UploadErrorType {
+    EXTENSION_NOT_ALLOWED = 0,
+    REJECTED = 1,
+    PLAN_EXCEEDED_RESOLUTION = 2,
+    PLAN_EXCEEDED_SIZE = 3,
+    STORAGE_QUOTA_EXCEEDED = 4
+}
+export declare enum UploadStatus {
+    /**
+     * Upload of an asset has been aborted.
+     */
+    ABORTED = 0,
+    /**
+     * Upload of an asset is completed.
+     */
+    COMPLETED = 1,
+    /**
+     * Upload of an asset has terminated with an error.
+     */
+    ERROR = 2,
+    /**
+     * Upload of an asset is in progress.
+     */
+    IN_PROGRESS = 3,
+    /**
+     * Upload has not started yet but it is scheduled to happen.
+     */
+    PENDING = 4
+}
+/**
+ * Please note that any action that disables auto-scroll only sets relevant flag to `false`.
+ * The actual scrolling behavior must be then disabled in a downstream component.
+ */
+export declare enum UploadComponentsActionType {
+    /**
+     * Closes dialog.
+     *
+     * If upload queue is concluded, then auto-hide feature is enabled
+     * so that other upload components get closed after specified timeout.
+     *
+     * In addition, auto-scrolling is disabled.
+     */
+    CLOSE_DIALOG = 0,
+    /**
+     * Disables auto features (auto-hide and auto-scroll).
+     */
+    DISABLE_AUTO_FEATURES = 1,
+    /**
+     * Disables auto-hide feature.
+     */
+    DISABLE_AUTO_HIDE = 2,
+    /**
+     * Enables auto-hide feature.
+     */
+    ENABLE_AUTO_HIDE = 3,
+    /**
+     * Opens dialog.
+     *
+     * Opening a closed dialog disables auto-hide and enables auto-scroll.
+     */
+    OPEN_DIALOG = 4,
+    /**
+     * Opens indicator.
+     */
+    OPEN_INDICATOR = 5,
+    /**
+     * Resets state to initial values.
+     */
+    RESET_UPLOAD_COMPONENTS = 6,
+    /**
+     * Toggles dialog.
+     *
+     * Opening a closed dialog disables auto-hide and enables auto-scroll.
+     */
+    TOGGLE_DIALOG = 7
+}
+/**
+ * Maximum tolerated value of standard deviation for upload speeds.
+ * If average upload speed exceeds provided maximum,
+ * then it means that upload speed fluctuations are too high and estimated upload time cannot be trusted.
+ */
+export declare const MAX_STANDARD_DEV = 0.3;
+/**
+ * Specifies minimum time (in ms) of upload chunks sampling in order to calculate upload speed.
+ * Increasing this value will result in longer times of sampling, leading to more accurate estimates at the cost of less frequent updates.
+ */
+export declare const MIN_TIME_ELAPSED = 1000;
+/**
+ * Specifies minimum number of accumulated progress updates for upload time estimate to be estimated.
+ * Increasing this value will result in longer times of sampling, leading to more accurate estimates at the cost of less frequent updates.
+ * This value equals the number of server calls related to upload progress.
+ */
+export declare const MIN_PROGRESS_UPDATES = 10;
+/**
+ * Specifies minimum number of recorded upload speeds required to calculate average value.
+ * Increasing this value will result in more accurate estimates at the cost of longer initial lag.
+ */
+export declare const MIN_UPLOAD_SPEEDS = 2;
+/**
+ * Specifies maximum number of collected upload speeds. Older records will be discarded in favor of more recent ones.
+ * Increasing this value will result in more stable estimates at the cost of less flexibility in case of fluctuations.
+ */
+export declare const MAX_UPLOAD_SPEEDS = 15;

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

@@ -0,0 +1,5 @@
+export * from './constants';
+export * from './types';
+export * from './UploadContext';
+export * from './useStartUpload';
+export { default as UploadProvider } from './UploadProvider';