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

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

@@ -0,0 +1,50 @@
+import * as React from 'react';
+import { UploadError, UploadStatus } from '../../../providers';
+/**
+ * Since the component is by default memoized, make sure to pass props that do not change too often.
+ * For the same reason it's preferable that props remain primitive values.
+ */
+export interface Props {
+    /**
+     * Name of the category the asset belongs to.
+     */
+    categoryName: string;
+    /**
+     * Error data associated with this asset.
+     */
+    errorData?: UploadError;
+    /**
+     * Uploaded asset id.
+     */
+    id: string;
+    /**
+     * Uploaded asset name.
+     */
+    name: string;
+    /**
+     * Overhead associated with multipart/form-data.
+     */
+    overhead?: number;
+    /**
+     * Current progress.
+     */
+    progress?: number;
+    /**
+     * Total asset size.
+     */
+    size: number;
+    /**
+     * Current upload status.
+     */
+    status: UploadStatus;
+    /**
+     * Uploaded size so far.
+     */
+    uploaded: number;
+}
+/**
+ * The array of assets might have a significant size,
+ * so let's limit the number of re-renders of a single asset by memoizing `UploadProgressPanel` component.
+ */
+declare const _default: React.MemoExoticComponent<React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLDivElement>>>;
+export default _default;

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

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

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

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

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

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

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

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

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

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

package/dist/core/Core.d.ts

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

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

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

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

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

package/dist/core/index.d.ts

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

package/dist/index.d.ts

@@ -45,6 +45,10 @@ interface ParsedAsset {
      * Converted asset size.
      */
     size?: number;
+    /**
+     * Asset last modification time.
+     */
+    lastModifiedAt?: string;
     /**
      * Asset upload date.
      */
@@ -57,6 +61,10 @@ interface ParsedAsset {
      * Asset category id.
      */
     categoryId: string;
+    /**
+     * Asset tags.
+     */
+    tags: string[];
 }
 
 interface AssetExtraProps {