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

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

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

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

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

@@ -1,282 +0,0 @@
-import { ApiPlanLimits } from '../../services';
-import { ParsedCategory } from '../data';
-import { UploadActionType, UploadComponentsActionType, UploadErrorType, UploadStatus } from './constants';
-/**
- * Upload options configurable via props.
- */
-export interface UploadProps extends Pick<UploadOptions, 'cacheInvalidationInterval' | 'progressBatchInterval'> {
-    /**
-     * Specifies interaction timeout for upload components.
-     *
-     * There will be an attempt to autoclose the upload components (such as upload dialog or upload indicator) after specified time
-     * unless user interacted with those components.
-     */
-    componentsInteractionTimeout: number;
-}
-export interface UploadOptions {
-    /**
-     * Instructs how often progress updates should be propagated.
-     * Use higher values for less frequent updates.
-     */
-    progressBatchInterval: number;
-    /**
-     * Rather than invalidating assets cache on every completed upload,
-     * cache will be invalidated less frequently as per specified interval.
-     */
-    cacheInvalidationInterval: number;
-    /**
-     * Instructs how many files can be uploaded in parallel.
-     */
-    uploadBatch?: number;
-    /**
-     * Callback invoked once status of all uploaded assets is concluded.
-     * An array of assets is passed as an argument.
-     */
-    onUploadConcluded?: (assets: UploadAsset[]) => void;
-    /**
-     * Callback invoked once new files are processed for upload.
-     * An array of files is passed as an argument.
-     */
-    onFilesProcessed?: (files: File[]) => void;
-    /**
-     * Subscription plan limits set for the environment.
-     */
-    environmentPlanLimits?: ApiPlanLimits;
-}
-export interface UploadError {
-    /**
-     * Error type.
-     */
-    type: UploadErrorType;
-    /**
-     * Optional raw error message.
-     */
-    msg?: string;
-}
-export interface UploadAsset {
-    /**
-     * Callback that aborts upload.
-     */
-    abort: () => void;
-    /**
-     * Indicates if upload can be aborted. Only "Pending" and "In Progress" assets can be aborted.
-     */
-    abortable: boolean;
-    /**
-     * Category to which asset belongs.
-     */
-    category: ParsedCategory;
-    /**
-     * Indicates if upload is concluded. Only "Aborted", "Completed", and "Error" assets are considered concluded.
-     */
-    concluded: boolean;
-    /**
-     * Optional error associated with `error` state.
-     */
-    error?: UploadError;
-    /**
-     * Unique asset id.
-     */
-    id: string;
-    /**
-     * Uploaded asset's name.
-     */
-    name: string;
-    /**
-     * Upload overhead associated with encoded form data.
-     *
-     * There is an inherent overhead associated with form data encoding
-     * and values reported by the progress events include it.
-     *
-     * The exact overhead value for a given asset cannot be determined upfront.
-     * It can be only calculated once the first progress event has been dispatched.
-     */
-    overhead?: number;
-    /**
-     * Uploaded asset's progress value (in %).
-     * The value takes into account form data encoding overhead.
-     */
-    progress?: number;
-    /**
-     * Uploaded asset's underlying file size (in bytes).
-     */
-    size: number;
-    /**
-     * Upload status.
-     */
-    status: UploadStatus;
-    /**
-     * Uploaded amount of asset in bytes.
-     */
-    uploaded: number;
-    /**
-     * Starts upload of a file associated with this asset.
-     */
-    uploadFile: () => Promise<void>;
-}
-export interface UploadState {
-    /**
-     * Total size (in bytes) of all uploaded data chunks since last calculated time estimate.
-     */
-    chunksRecordedSize?: number;
-    /**
-     * Number of progress updates that happened since last calculated time estimate.
-     */
-    chunksRecordedCount?: number;
-    /**
-     * Timestamp when time estimate was last calculated.
-     */
-    chunksRecordingStartedAt?: number;
-    /**
-     * Flag indicating if upload of all assets is concluded.
-     */
-    concluded: boolean;
-    /**
-     * Flag indicating if upload was aborted.
-     */
-    aborted: boolean;
-    /**
-     * Estimated time left to finish uploading all assets (in ms).
-     */
-    estimatedTimeLeft?: number;
-    /**
-     * Asset that can be regarded as one of the most important for a given queue.
-     * Such asset can be then somehow focused by downstream components.
-     *
-     * This is either the first asset in progress or the last completed one.
-     */
-    focusedAsset?: UploadAsset;
-    /**
-     * Queue of all assets that are being updated.
-     */
-    queue: UploadAsset[];
-    /**
-     * Total progress of all uploaded assets (in %).
-     */
-    totalProgress?: number;
-    /**
-     * Aggregates last N calculated upload speeds (in bytes / ms).
-     */
-    uploadSpeeds: number[];
-}
-export interface UpdateProgressPayload {
-    /**
-     * Asset id.
-     */
-    id: string;
-    /**
-     * Indicates how much of the asset has been uploaded so far (in bytes).
-     * It is a sum of form data overhead and uploaded part of the file.
-     */
-    uploaded: number;
-    /**
-     * Total size of the request (in bytes).
-     * It is a sum of form data overhead and total file size.
-     */
-    total: number;
-}
-export interface UploadCompletedPayload {
-    /**
-     * Category id.
-     */
-    id: string;
-}
-export interface UpdateProgressBatch {
-    /**
-     * Maps asset id to its recent update.
-     */
-    data: Record<string, UpdateProgressPayload>;
-    /**
-     * Total number of updates that happened during update interval.
-     */
-    count: number;
-}
-interface AbortUploadAllAction {
-    type: UploadActionType.ABORT_UPLOAD;
-    payload: {
-        ids: string[];
-    };
-}
-interface ClearQueueAction {
-    type: UploadActionType.CLEAR_QUEUE;
-}
-interface CompleteUploadAction {
-    type: UploadActionType.COMPLETE_UPLOAD;
-    payload: {
-        id: string;
-    };
-}
-interface DisableAbortAction {
-    type: UploadActionType.DISABLE_ABORT;
-    payload: {
-        id: string;
-    };
-}
-interface QueueUploadAction {
-    type: UploadActionType.QUEUE_UPLOAD;
-    payload: Omit<UploadAsset, 'status'>[];
-}
-interface RejectUploadAction {
-    type: UploadActionType.REJECT_UPLOAD;
-    payload: {
-        id: string;
-        error: UploadError;
-    };
-}
-interface StartUploadAction {
-    type: UploadActionType.START_UPLOAD;
-    payload: {
-        id: string;
-    };
-}
-interface UpdateProgressAction {
-    type: UploadActionType.UPDATE_PROGRESS;
-    payload: UpdateProgressBatch;
-}
-export declare type UploadAction = AbortUploadAllAction | ClearQueueAction | CompleteUploadAction | DisableAbortAction | QueueUploadAction | RejectUploadAction | StartUploadAction | UpdateProgressAction;
-export interface UploadComponentsState {
-    /**
-     * Indicates if dialog is open.
-     */
-    isDialogOpen: boolean;
-    /**
-     * Indicates if upload indicator is open.
-     */
-    isIndicatorOpen: boolean;
-    /**
-     * Flag indicating if upload components should be auto-hidden after specified timeout passes.
-     */
-    autoHide: boolean;
-    /**
-     * Flag indicating if auto-scroll is enabled for the dialog.
-     */
-    autoScroll: boolean;
-}
-interface CloseComponentsAction {
-    type: UploadComponentsActionType.RESET_UPLOAD_COMPONENTS;
-}
-interface CloseDialogAction {
-    type: UploadComponentsActionType.CLOSE_DIALOG;
-    payload: boolean;
-}
-interface DisableAutoFeatsAction {
-    type: UploadComponentsActionType.DISABLE_AUTO_FEATURES;
-}
-interface DisableAutoScrollAction {
-    type: UploadComponentsActionType.DISABLE_AUTO_HIDE;
-}
-interface EnableAutoHideAction {
-    type: UploadComponentsActionType.ENABLE_AUTO_HIDE;
-}
-interface OpenDialogAction {
-    type: UploadComponentsActionType.OPEN_DIALOG;
-}
-interface OpenIndicatorAction {
-    type: UploadComponentsActionType.OPEN_INDICATOR;
-}
-interface ToggleDialogAction {
-    type: UploadComponentsActionType.TOGGLE_DIALOG;
-    payload: boolean;
-}
-export declare type UploadComponentsAction = CloseComponentsAction | CloseDialogAction | DisableAutoFeatsAction | DisableAutoScrollAction | EnableAutoHideAction | OpenDialogAction | OpenIndicatorAction | ToggleDialogAction;
-export {};

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

@@ -1,10 +0,0 @@
-import { UploadAction, UploadState } from './types';
-export declare const initState: () => UploadState;
-/**
- * Derives next upload state.
- *
- * @param state current upload state
- * @param action dispatched upload action
- * @returns next state
- */
-export declare const uploadStateReducer: (state: Readonly<UploadState>, action: UploadAction) => UploadState;

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

@@ -1,10 +0,0 @@
-import { ParsedCategory } from '../data';
-/**
- * Utility hook that wraps logic related to managing UI components on files processing.
- *
- * @param category category to which files are uploaded
- * @returns upload helpers
- */
-export declare const useStartUpload: (category: ParsedCategory) => {
-    startUpload: (files: File[]) => void;
-};

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

@@ -1,21 +0,0 @@
-import { ParsedCategory } from '../data';
-import { UploadAsset, UploadOptions } from './types';
-/**
- * This hook is responsible for managing global upload queue. It provides a set of actions and the current upload state.
- *
- * Few optimization techniques are applied:
- *
- * - Actions are memoized in order to limit the number of re-renders in components.
- * - Progress updates are batched in order to minimize hook re-renders.
- * - Uploads are processed in batches. No more files than a specified number can be processed at the same time.
- *
- * @param options upload options
- * @returns upload state and actions
- */
-export declare const useUpload: (options: UploadOptions) => {
-    state: import("./types").UploadState;
-    actions: {
-        abortUpload: (assets: UploadAsset[]) => void;
-        processFiles: (category: ParsedCategory, files: File[]) => void;
-    };
-};

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

@@ -1,21 +0,0 @@
-import * as React from 'react';
-import { UploadAsset } from './types';
-/**
- * Manages state related to upload components: upload dialog and indicator.
- *
- * @returns state and actions
- */
-export declare const useUploadComponents: (interactionTimeout?: number) => {
-    autoScroll: boolean;
-    isDialogOpen: boolean;
-    isIndicatorOpen: boolean;
-    closeDialog: (uploadConcluded?: boolean) => void;
-    disableAutoHide: () => void;
-    disableAutoFeats: () => void;
-    onUploadConcluded: (assets: UploadAsset[]) => void;
-    openDialog: () => void;
-    openIndicator: () => void;
-    toggleDialog: (uploadConcluded?: boolean) => void;
-    setUploadIndicatorEl: React.Dispatch<React.SetStateAction<HTMLElement | null>>;
-    uploadIndicatorEl: HTMLElement | null;
-};

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

@@ -1,136 +0,0 @@
-import { ApiPlanLimits, ErrorResponse } from '../../services';
-import { ParsedCategory } from '../data';
-import { UploadErrorType } from './constants';
-import { UpdateProgressBatch, UploadAsset, UploadError, UploadState } from './types';
-/**
- * Checks if upload of the queue is concluded.
- *
- * @param queue upload queue
- * @returns flag indicating if upload of the queue is concluded
- */
-export declare const isQueueConcluded: (queue: UploadAsset[]) => boolean;
-/**
- * Parses error response from server into an upload error object.
- *
- * @param response response data
- * @returns upload error details object
- */
-export declare const getUploadErrorType: (response: ErrorResponse) => UploadError;
-/**
- * Calculates total upload progress of an upload queue.
- * It takes aborted assets into account while calculating total progress percentage.
- *
- * Sums size of all uploaded data chunks so far and divides by total size of assets in the queue.
- *
- * @param queue upload queue
- * @returns current progress
- */
-export declare const getUploadProgress: (queue: UploadAsset[]) => {
-    totalSize: number;
-    totalProgress: number;
-    totalUploaded: number;
-    totalLeft: number;
-};
-/**
- * Calculates amount of uploaded data within a batch.
- *
- * @param queue upload queue
- * @param progressBatch update batch
- * @returns how much data has been uploaded within a batch
- */
-export declare const getUploadedDiff: (queue: UploadAsset[], updates: UpdateProgressBatch['data']) => number;
-/**
- * Derives next array of upload speeds.
- *
- * @param uploadSpeeds list of recorded upload speeds
- * @param uploadDiff specifies how much has been uploaded during latest period (in bytes)
- * @param uploadDuration specifies how long it took to upload the chunks (in ms)
- * @returns next progress updates
- */
-export declare const getUploadSpeeds: (uploadSpeeds: number[], uploadDiff: number, uploadDuration: number) => number[];
-/**
- * Calculates asset's progress value.
- *
- * @param asset asset
- * @param nextUploaded how much has been uploaded so far (in bytes)
- * @returns updated asset
- */
-export declare const getAssetUploadProgress: (uploaded: number, total: number) => number;
-/**
- * Calculates average upload speed based on a list of recorded values.
- * If there are at least two entries in the list, then truncated average is calculated (min and max values are discarded).
- *
- * @param uploadSpeeds list of upload speeds
- * @returns average upload speed
- */
-export declare const getAvgUploadSpeed: (uploadSpeeds: number[]) => number | undefined;
-/**
- * Estimates total time left to complete upload of all assets.
- *
- * @param sizeLeft total size left of all active assets in the queue
- * @param uploadSpeed upload speed
- * @returns estimated time left to complete upload
- */
-export declare const getTimeLeft: (sizeLeft: number, uploadSpeed?: number) => number | undefined;
-/**
- * Sorts assets based on their status. Those with error go first.
- *
- * @param assets assets to sort
- * @returns sorted assets
- */
-export declare const sortAssets: (assets: UploadAsset[]) => UploadAsset[];
-/**
- * Validates file to be uploaded.
- *
- * @param file file to validate
- * @param category category being uploaded to
- * @param environmentPlanLimits plan limits
- * @returns object containing validation results
- */
-export declare const validateFileUpload: (file: File, category: ParsedCategory, environmentPlanLimits?: ApiPlanLimits) => Promise<{
-    isExtensionValid: boolean;
-    isSizeValid: boolean;
-    isResolutionValid: boolean;
-}>;
-/**
- * Gets a detailed error object depending on result of validation.
- *
- * @param isExtensionValid specifies whether file's extension was valid
- * @param isSizeValid specifies whether file's size was valid
- * @param isResolutionValid specifies whether file's resolution was valid
- * @param environmentPlanLimits plan limits
- * @returns error object
- */
-export declare const getUploadValidationError: (isExtensionValid: boolean, isSizeValid: boolean, isResolutionValid: boolean, environmentPlanLimits?: ApiPlanLimits) => {
-    type: UploadErrorType;
-    msg?: string;
-};
-/**
- * Gets initial values for queue's partial progress updates.
- *
- * @returns initial progress updates for a single update batch
- */
-export declare const initQueuePartialProgressUpdates: () => {
-    chunksRecordedCount: number;
-    chunksRecordedSize: number;
-    chunksRecordingStartedAt: undefined;
-    estimatedTimeLeft: undefined;
-};
-/**
- * Gets asset from a queue which can be considered as the most important by the specified rules:
- *
- * - It tries to get first asset in progress.
- * - If there are none, tries to get last asset which upload was completed.
- *
- * @param queue upload queue
- * @returns asset
- */
-export declare const getFocusedAsset: (queue: UploadAsset[]) => UploadAsset | undefined;
-/**
- * Helper that calculates partial updates related to the queue.
- *
- * @param queue upload queue
- * @param uploadSpeeds list of recorded upload speeds
- * @returns partial upload state
- */
-export declare const getQueuePartialUpdate: (queue: UploadAsset[], uploadSpeeds: number[]) => Partial<UploadState>;