use-tus 0.4.0 → 0.5.0

package/README.md

@@ -15,7 +15,6 @@
 ## Features
 - Resumable file uploads on react.
 - Managing the [Upload](https://github.com/tus/tus-js-client/blob/master/docs/api.md#tusuploadfile-options) by using context.
-- One dependency ([tus-js-client](https://github.com/tus/tus-js-client)).
 - TypeScript support.
 
 ## Demo
@@ -25,12 +24,12 @@ You can try the [use-tus demo](https://kqito.github.io/use-tus/?path=/story/uset
 ## Installation
 You can install the package from npm.
 ```sh
-npm install use-tus
+npm install use-tus tus-js-client
 ```
 
 or
 ```sh
-yarn add use-tus
+yarn add use-tus tus-js-client
 ```
 
 ## Usage

package/dist/TusClientProvider/TusClientProvider.d.ts

@@ -1,4 +1,4 @@
-import type { FC } from 'react';
-import { TusConfigs } from '../core/tusHandler';
-export declare type TusClientProviderProps = Readonly<TusConfigs>;
-export declare const TusClientProvider: FC<TusClientProviderProps>;
+import { FC } from 'react';
+import { TusConfigs } from '../core/tusHandler';
+export declare type TusClientProviderProps = Readonly<TusConfigs>;
+export declare const TusClientProvider: FC<TusClientProviderProps>;

package/dist/TusClientProvider/TusController.d.ts

@@ -1,4 +1,4 @@
-import { FC } from 'react';
-import { TusConfigs } from '../core/tusHandler';
-export declare type TusControllerProps = Readonly<TusConfigs>;
-export declare const TusController: FC<TusControllerProps>;
+import { FC } from 'react';
+import { TusConfigs } from '../core/tusHandler';
+export declare type TusControllerProps = Readonly<TusConfigs>;
+export declare const TusController: FC<TusControllerProps>;

package/dist/TusClientProvider/index.d.ts

@@ -1,2 +1,2 @@
-export { TusClientProvider } from './TusClientProvider';
-export type { TusClientProviderProps } from './TusClientProvider';
+export { TusClientProvider } from './TusClientProvider';
+export type { TusClientProviderProps } from './TusClientProvider';

package/dist/__stories__/Basic.stories.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { Meta } from '@storybook/react';
+declare const _default: Meta<import("@storybook/react").Args>;
+export default _default;
+export declare const Basic: () => JSX.Element;

package/dist/__stories__/CacheKey.stories.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { Meta } from '@storybook/react';
+declare const _default: Meta<import("@storybook/react").Args>;
+export default _default;
+export declare const CacheKey: () => JSX.Element;

package/dist/__stories__/DefaultOptions.stories.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { Meta } from '@storybook/react';
+declare const _default: Meta<import("@storybook/react").Args>;
+export default _default;
+export declare const WithDefaultOptions: () => JSX.Element;

package/dist/__stories__/components/BasicButton/BasicButton.d.ts

@@ -0,0 +1,9 @@
+import { ComponentProps } from 'react';
+declare type BasicButtonProps = {
+    onClick: ComponentProps<'button'>['onClick'];
+    title: string;
+    disabled?: ComponentProps<'button'>['disabled'];
+    styleColor?: 'primary' | 'basic' | 'error';
+};
+export declare const BasicButton: import("react").ForwardRefExoticComponent<BasicButtonProps & import("react").RefAttributes<HTMLButtonElement>>;
+export {};

package/dist/__stories__/components/BasicButton/index.d.ts

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

package/dist/__stories__/components/LoadingCircle/LoadingCircle.d.ts

@@ -0,0 +1,2 @@
+import type { VFC } from 'react';
+export declare const LoadingCircle: VFC;

package/dist/__stories__/components/LoadingCircle/index.d.ts

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

package/dist/__stories__/components/ProgressBar/ProgressBar.d.ts

@@ -0,0 +1,7 @@
+import { VFC } from 'react';
+declare type ProgressBarProps = {
+    title?: string;
+    value?: number;
+};
+export declare const ProgressBar: VFC<ProgressBarProps>;
+export {};

package/dist/__stories__/components/ProgressBar/index.d.ts

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

package/dist/__stories__/components/UploadIcon/UploadIcon.d.ts

@@ -0,0 +1,2 @@
+import { VFC } from 'react';
+export declare const UploadIcon: VFC;

package/dist/__stories__/components/UploadIcon/index.d.ts

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

package/dist/__stories__/constants.d.ts

@@ -0,0 +1 @@
+export declare const TUS_DEMO_ENDPOINT: "https://tusd.tusdemo.net/files/";

package/dist/__tests__/TusClientProvider.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/useTus.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/utils/getBlob.d.ts

@@ -0,0 +1 @@
+export declare const getBlob: (str: string) => Blob;

package/dist/__tests__/utils/mock.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="jest" />
+/// <reference types="webpack-env" />
+/// <reference types="node" />
+export declare const createConsoleErrorMock: () => jest.SpyInstance<void, [message?: any, ...optionalParams: any[]]>;
+export declare const insertEnvValue: (value: NodeJS.Process['env']) => void;

package/dist/core/constants.d.ts

@@ -1,4 +1,4 @@
-export declare const ERROR_MESSAGES: {
-    tusClientHasNotFounded: string;
-    tusIsNotSupported: string;
-};
+export declare const ERROR_MESSAGES: {
+    tusClientHasNotFounded: string;
+    tusIsNotSupported: string;
+};

package/dist/core/contexts.d.ts

@@ -1,7 +1,7 @@
-import type { Dispatch } from 'react';
-import { TusClientActions } from './tucClientActions';
-import { TusClientState } from './tusClientReducer';
-export declare const TusClientStateContext: import("react").Context<TusClientState | undefined>;
-export declare const TusClientDispatchContext: import("react").Context<Dispatch<TusClientActions> | undefined>;
-export declare const useTusClientState: () => TusClientState;
-export declare const useTusClientDispatch: () => Dispatch<TusClientActions>;
+import type { Dispatch } from 'react';
+import { TusClientActions } from './tucClientActions';
+import { TusClientState } from './tusClientReducer';
+export declare const TusClientStateContext: import("react").Context<TusClientState | undefined>;
+export declare const TusClientDispatchContext: import("react").Context<Dispatch<TusClientActions> | undefined>;
+export declare const useTusClientState: () => TusClientState;
+export declare const useTusClientDispatch: () => Dispatch<TusClientActions>;

package/dist/core/tucClientActions.d.ts

@@ -1,50 +1,50 @@
-import type { Upload } from 'tus-js-client';
-import { TusConfigs } from './tusHandler';
-export declare type TusClientActions = ReturnType<typeof insertUploadInstance | typeof removeUploadInstance | typeof resetClient | typeof updateSuccessUpload | typeof updateErrorUpload | typeof updateIsAbortedUpload | typeof updateTusHandlerOptions>;
-export declare const insertUploadInstance: (cacheKey: string, upload: Upload) => {
-    readonly type: "INSERT_UPLOAD_INSTANCE";
-    readonly payload: {
-        readonly cacheKey: string;
-        readonly uploadState: {
-            readonly upload: Upload;
-            readonly isSuccess: false;
-            readonly isAborted: false;
-        };
-    };
-};
-export declare const updateSuccessUpload: (cacheKey: string) => {
-    readonly type: "UPDATE_SUCCESS_UPLOAD";
-    readonly payload: {
-        readonly cacheKey: string;
-    };
-};
-export declare const updateErrorUpload: (cacheKey: string, error?: Error | undefined) => {
-    readonly type: "UPDATE_ERROR_UPLOAD";
-    readonly payload: {
-        readonly cacheKey: string;
-        readonly error: Error | undefined;
-    };
-};
-export declare const updateIsAbortedUpload: (cacheKey: string, isAborted: boolean) => {
-    readonly type: "UPDATE_IS_ABORTED_UPLOAD";
-    readonly payload: {
-        readonly cacheKey: string;
-        readonly isAborted: boolean;
-    };
-};
-export declare const removeUploadInstance: (cacheKey: string) => {
-    readonly type: "REMOVE_UPLOAD_INSTANCE";
-    readonly payload: {
-        readonly cacheKey: string;
-    };
-};
-export declare const resetClient: () => {
-    readonly type: "RESET_CLIENT";
-};
-export declare const updateTusHandlerOptions: (payload: TusConfigs) => {
-    readonly type: "UPDATE_TUS_HANDLER_OPTIONS";
-    readonly payload: Partial<{
-        canStoreURLs: boolean;
-        defaultOptions: import("./tusHandler").DefaultOptions;
-    }>;
-};
+import type { Upload } from 'tus-js-client';
+import { TusConfigs } from './tusHandler';
+export declare type TusClientActions = ReturnType<typeof insertUploadInstance | typeof removeUploadInstance | typeof resetClient | typeof updateSuccessUpload | typeof updateErrorUpload | typeof updateIsAbortedUpload | typeof updateTusHandlerOptions>;
+export declare const insertUploadInstance: (cacheKey: string, upload: Upload) => {
+    readonly type: "INSERT_UPLOAD_INSTANCE";
+    readonly payload: {
+        readonly cacheKey: string;
+        readonly uploadState: {
+            readonly upload: Upload;
+            readonly isSuccess: false;
+            readonly isAborted: false;
+        };
+    };
+};
+export declare const updateSuccessUpload: (cacheKey: string) => {
+    readonly type: "UPDATE_SUCCESS_UPLOAD";
+    readonly payload: {
+        readonly cacheKey: string;
+    };
+};
+export declare const updateErrorUpload: (cacheKey: string, error?: Error | undefined) => {
+    readonly type: "UPDATE_ERROR_UPLOAD";
+    readonly payload: {
+        readonly cacheKey: string;
+        readonly error: Error | undefined;
+    };
+};
+export declare const updateIsAbortedUpload: (cacheKey: string, isAborted: boolean) => {
+    readonly type: "UPDATE_IS_ABORTED_UPLOAD";
+    readonly payload: {
+        readonly cacheKey: string;
+        readonly isAborted: boolean;
+    };
+};
+export declare const removeUploadInstance: (cacheKey: string) => {
+    readonly type: "REMOVE_UPLOAD_INSTANCE";
+    readonly payload: {
+        readonly cacheKey: string;
+    };
+};
+export declare const resetClient: () => {
+    readonly type: "RESET_CLIENT";
+};
+export declare const updateTusHandlerOptions: (payload: TusConfigs) => {
+    readonly type: "UPDATE_TUS_HANDLER_OPTIONS";
+    readonly payload: Partial<{
+        canStoreURLs: boolean;
+        defaultOptions: import("./tusHandler").DefaultOptions;
+    }>;
+};

package/dist/core/tusClientReducer.d.ts

@@ -1,18 +1,18 @@
-import type { Reducer } from 'react';
-import type { Upload } from 'tus-js-client';
-import { TusClientActions } from './tucClientActions';
-import { TusHandler } from './tusHandler';
-export declare type UploadState = {
-    upload: Upload | undefined;
-    isSuccess: boolean;
-    isAborted: boolean;
-    error?: Error;
-};
-export declare type TusClientState = {
-    uploads: {
-        [cacheKey: string]: UploadState | undefined;
-    };
-    tusHandler: TusHandler;
-};
-export declare const tusClientReducer: Reducer<TusClientState, TusClientActions>;
-export declare const tusClientInitialState: TusClientState;
+import type { Reducer } from 'react';
+import type { Upload } from 'tus-js-client';
+import { TusClientActions } from './tucClientActions';
+import { TusHandler } from './tusHandler';
+export declare type UploadState = {
+    upload: Upload | undefined;
+    isSuccess: boolean;
+    isAborted: boolean;
+    error?: Error;
+};
+export declare type TusClientState = {
+    uploads: {
+        [cacheKey: string]: UploadState | undefined;
+    };
+    tusHandler: TusHandler;
+};
+export declare const tusClientReducer: Reducer<TusClientState, TusClientActions>;
+export declare const tusClientInitialState: TusClientState;

package/dist/core/tusHandler.d.ts

@@ -1,17 +1,17 @@
-import * as tus from 'tus-js-client';
-import { Upload } from 'tus-js-client';
-export declare type DefaultOptions = (file: Upload['file']) => tus.UploadOptions;
-export declare type TusConfigs = Partial<{
-    canStoreURLs: boolean;
-    defaultOptions: DefaultOptions;
-}>;
-export declare type Tus = Readonly<Omit<typeof tus, 'defaultOptions'> & Required<TusConfigs>>;
-export declare const initialDefaultOptions: DefaultOptions;
-export declare class TusHandler {
-    private tus;
-    constructor(tusConfigs?: TusConfigs);
-    get getTus(): Readonly<Omit<typeof tus, "defaultOptions"> & Required<Partial<{
-        canStoreURLs: boolean;
-        defaultOptions: DefaultOptions;
-    }>>>;
-}
+import * as tus from 'tus-js-client';
+import { Upload } from 'tus-js-client';
+export declare type DefaultOptions = (file: Upload['file']) => tus.UploadOptions;
+export declare type TusConfigs = Partial<{
+    canStoreURLs: boolean;
+    defaultOptions: DefaultOptions;
+}>;
+export declare type Tus = Readonly<Omit<typeof tus, 'defaultOptions'> & Required<TusConfigs>>;
+export declare const initialDefaultOptions: DefaultOptions;
+export declare class TusHandler {
+    private tus;
+    constructor(tusConfigs?: TusConfigs);
+    get getTus(): Readonly<Omit<typeof tus, "defaultOptions"> & Required<Partial<{
+        canStoreURLs: boolean;
+        defaultOptions: DefaultOptions;
+    }>>>;
+}

package/dist/core/types.d.ts

@@ -1,8 +1,8 @@
-import { Upload } from 'tus-js-client';
-export declare type BaseUseTusResult = {
-    upload?: Upload;
-    setUpload: (file: Upload['file'], options?: Upload['options']) => void;
-    isSuccess: boolean;
-    error?: Error;
-};
-export declare type BaseUseTusOptions = {};
+import { Upload } from 'tus-js-client';
+export declare type BaseUseTusResult = {
+    upload?: Upload;
+    setUpload: (file: Upload['file'], options?: Upload['options']) => void;
+    isSuccess: boolean;
+    error?: Error;
+};
+export declare type BaseUseTusOptions = {};