gantri-components 2.133.0-beta.1 → 2.133.0-beta.10

package/dist/components/file-uploader/file-uploader.styles.d.ts

@@ -2,6 +2,6 @@
 import { OptionalValues } from '../../types/common';
 export declare const StyledFileInput: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<import("react").DetailedHTMLProps<import("react").InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, OptionalValues<{
     $fileUrl: string;
-    $isDisabled: boolean;
-    $isThumbnail: boolean;
+    $isDropZone: boolean;
+    disabled: boolean;
 }, undefined>>> & string;

package/dist/components/file-uploader/file-uploader.types.d.ts

@@ -12,16 +12,19 @@ export type FileUploaderProps = {
     fileUrl: string;
     /** This function should delete the record from the database, ***then*** delete the file. */
     handleDeleteFile: HandleDeleteFile;
-    /** Provide this if supporting multiple uploads to prevent multiple calls to update the database. */
-    handleUploadsComplete: HandleUploadsComplete;
     inputName?: string;
     isActive?: boolean;
     isDisabled?: boolean;
+    /** Updates the input to be used as a file drop zone. */
+    isDropZone?: boolean;
     /** Use with variant `'thumbnail'` to always show the uploader view. */
     isUploaderOnly?: boolean;
     onBlur?: FocusEventHandler<HTMLInputElement>;
     onClick?: BoxProps['onClick'];
     onError: OnFileUploaderError;
+    onValidationCompleted?: () => void;
+    onValidationStarted?: () => void;
+    onlyUseCustomValidationFn?: boolean;
     /** Used to show loading indicator for `'thumbnail'` variant. For the `'button'` variant, it can be passed here or as part of `buttonProps`. */
     processing: boolean;
     purifyFileName?: boolean;
@@ -30,6 +33,7 @@ export type FileUploaderProps = {
     transformThumbnailSrc?: TransformThumbnailSrc;
     /** If invalid, return the error message to display. */
     validateFile?: ValidateFile;
+    validateSequentially?: boolean;
     /** The 'link' and 'plain' variants will show the 'button' variant if nothing has been uploaded yet. */
     variant: FileUploaderVariant;
 } & Partial<FileUploaderDefaultProps> & (WithDraggableProps | WithoutDraggableProps) & (WithReplaceableProps | WithoutReplaceableProps) & (ImmediatelyUploadProps | DelayUploadProps) & (WithCustomContent | WithoutCustomContent);
@@ -57,12 +61,13 @@ export interface FileMetaData {
 }
 export interface SelectedFileDetails {
     fileBlob: Blob;
+    fileExtension: string;
     fileName: string;
     fileSize: number;
     metadata: FileMetaData;
 }
 /** If invalid, return the error message to display. */
-export type ValidateFile = (file: SelectedFileDetails) => string | undefined | void;
+export type ValidateFile = (file: SelectedFileDetails) => Promise<string | undefined | void> | string | undefined | void;
 export type HandleFileSelected = (props: SelectedFileDetails) => Promise<any>;
 export type FileUploaderCustomContent = (props: {
     IconCopyUrl: () => JSX.Element;
@@ -88,10 +93,14 @@ export type TransformThumbnailSrc = (props: {
 type ImmediatelyUploadProps = {
     handleFileSelected?: never;
     handleUploadFile: HandleUploadFile;
+    /** Use this if supporting multiple uploads to prevent multiple calls to update the database. */
+    handleUploadsComplete: HandleUploadsComplete;
 };
 type DelayUploadProps = {
     handleFileSelected: HandleFileSelected;
     handleUploadFile?: never;
+    /** Use this if supporting multiple uploads to prevent multiple calls to update the database. */
+    handleUploadsComplete?: never;
 };
 type WithDraggableProps = {
     SortableDragHandleWrapper: (props: PropsWithChildren<HTMLAttributes<HTMLElement>>) => JSX.Element;

package/dist/components/file-uploader/helpers/get-valid-files/get-valid-files.types.d.ts

@@ -1,5 +1,5 @@
 import { FileUploaderProps } from '../../file-uploader.types';
 import { OptionalValues } from '../../../../types/common';
-export type GetValidFilesProps = OptionalValues<Pick<FileUploaderProps, 'expectedExtensions' | 'maxFileSizeMB' | 'maxUploadsAllowed' | 'minImageHeight' | 'minImageWidth' | 'onError' | 'transformFileName' | 'validateFile'>> & {
+export type GetValidFilesProps = OptionalValues<Required<Pick<FileUploaderProps, 'expectedExtensions' | 'maxFileSizeMB' | 'maxUploadsAllowed' | 'minImageHeight' | 'minImageWidth' | 'onError' | 'onlyUseCustomValidationFn' | 'transformFileName' | 'validateFile' | 'validateSequentially'>>> & {
     files: File[];
 };

package/dist/components/file-uploader/helpers/index.d.ts

@@ -2,5 +2,6 @@ export * from './get-base-64-from-blob';
 export * from './get-purified-file-name';
 export * from './get-valid-files';
 export * from './transform-file-name';
+export * from './validate-file-extension';
 export * from './validate-file-size';
 export * from './validate-image-dimensions';

package/dist/components/file-uploader/helpers/validate-file-extension/index.d.ts

@@ -0,0 +1 @@
+export * from './validate-file-extension';

package/dist/components/file-uploader/helpers/validate-file-extension/validate-file-extension.d.ts

@@ -0,0 +1,3 @@
+import { ValidateExtensionsProps } from './validate-file-extension.types';
+/** Validates when files are added via drag and drop. */
+export declare const validateExtensions: (props: ValidateExtensionsProps) => string | undefined;

package/dist/components/file-uploader/helpers/validate-file-extension/validate-file-extension.types.d.ts

@@ -0,0 +1,4 @@
+export interface ValidateExtensionsProps {
+    expectedExtensions: string[];
+    fileExtension: string;
+}

package/dist/components/file-uploader/helpers/validate-image-dimensions/validate-image-dimensions.d.ts

@@ -1,3 +1,3 @@
-import { ValidateImageScale } from './validate-image-dimensions.types';
-/** Returns an error message if invalid. */
-export declare const validateImageDimensions: (props: ValidateImageScale) => string | undefined;
+import { ValidateImageDimensionsProps } from './validate-image-dimensions.types';
+/** Returns error message if invalid. */
+export declare const validateImageDimensions: (props: ValidateImageDimensionsProps) => Promise<string | undefined>;

package/dist/components/file-uploader/helpers/validate-image-dimensions/validate-image-dimensions.types.d.ts

@@ -1,6 +1,13 @@
-export type ValidateImageScale = {
+export type ValidateDimensionsProps = {
     fileName: string;
     img: HTMLImageElement;
     minHeight: number;
     minWidth: number;
 };
+export interface ValidateImageDimensionsProps {
+    fileName: string;
+    minHeight: number;
+    minWidth: number;
+    /** If file is a `Blob`, convert to base64 `src` using `getBase64FromBlob`. */
+    src: string;
+}

package/dist/components/file-uploader/hooks/use-drag-and-drop-files/use-drag-and-drop-files.d.ts

@@ -1,8 +1,13 @@
 import { DragEvent } from 'react';
 import { UseDragAndDropFilesProps } from './use-drag-and-drop-files.types';
 export declare const useDragAndDropFiles: (props: UseDragAndDropFilesProps) => {
-    isDraggingOver: boolean;
     onDragEnter: (event: DragEvent<HTMLInputElement>) => void;
     onDragLeave: (event: DragEvent<HTMLInputElement>) => void;
     onDrop: (event: DragEvent<HTMLInputElement>) => Promise<void>;
+    isDraggingOver: boolean;
+} | {
+    onDragEnter?: undefined;
+    onDragLeave?: undefined;
+    onDrop?: undefined;
+    isDraggingOver: boolean;
 };

package/dist/components/file-uploader/hooks/use-drag-and-drop-files/use-drag-and-drop-files.types.d.ts

@@ -1,4 +1,4 @@
-import { FileUploaderProps } from '../../file-uploader.types';
-export type UseDragAndDropFilesProps = Pick<FileUploaderProps, 'variant' | 'fileUrl'> & {
+export interface UseDragAndDropFilesProps {
+    enable: boolean;
     handleSelectedFiles: (files: File[]) => Promise<void>;
-};
+}

package/dist/components/file-uploader/hooks/use-uploader-actions/hooks/use-handle-selected-files/use-handle-selected-files.types.d.ts

@@ -1,7 +1,7 @@
 import { Dispatch, SetStateAction } from 'react';
 import { SelectedFileDetails, FileUploaderProps } from '../../../../file-uploader.types';
 import { OptionalValues } from '../../../../../../types/common';
-export type UseHandleSelectedFilesProps = OptionalValues<Required<Pick<FileUploaderProps, 'expectedExtensions' | 'fileUrl' | 'handleFileSelected' | 'handleUploadsComplete' | 'isUploaderOnly' | 'maxFileSizeMB' | 'maxUploadsAllowed' | 'minImageHeight' | 'minImageWidth' | 'onError' | 'transformFileName' | 'validateFile'>>> & {
+export type UseHandleSelectedFilesProps = OptionalValues<Required<Pick<FileUploaderProps, 'expectedExtensions' | 'fileUrl' | 'handleFileSelected' | 'handleUploadsComplete' | 'isUploaderOnly' | 'maxFileSizeMB' | 'maxUploadsAllowed' | 'minImageHeight' | 'minImageWidth' | 'onError' | 'onValidationCompleted' | 'onValidationStarted' | 'onlyUseCustomValidationFn' | 'transformFileName' | 'validateFile' | 'validateSequentially'>>> & {
     purgeInput: () => void;
     setFileName: Dispatch<SetStateAction<string>>;
     setFileUrl: Dispatch<SetStateAction<string>>;

package/dist/components/file-uploader/hooks/use-uploader-actions/use-uploader-actions.types.d.ts

@@ -1,5 +1,5 @@
 import { FileUploaderProps } from '../../file-uploader.types';
 import { OptionalValues } from '../../../../types/common';
-export type UseUploadActionsProps = OptionalValues<Required<Pick<FileUploaderProps, 'expectedExtensions' | 'fileName' | 'fileUrl' | 'handleDeleteFile' | 'handleFileSelected' | 'handleUploadsComplete' | 'handleUploadFile' | 'isUploaderOnly' | 'maxUploadsAllowed' | 'onError' | 'purifyFileName' | 'transformFileName' | 'validateFile'>>> & Partial<Pick<FileUploaderProps, 'maxFileSizeMB' | 'minImageHeight' | 'minImageWidth'>> & {
+export type UseUploadActionsProps = OptionalValues<Required<Pick<FileUploaderProps, 'expectedExtensions' | 'fileName' | 'fileUrl' | 'handleDeleteFile' | 'handleFileSelected' | 'handleUploadsComplete' | 'handleUploadFile' | 'isUploaderOnly' | 'maxUploadsAllowed' | 'onError' | 'onValidationCompleted' | 'onValidationStarted' | 'onlyUseCustomValidationFn' | 'purifyFileName' | 'transformFileName' | 'validateFile' | 'validateSequentially'>>> & Partial<Pick<FileUploaderProps, 'maxFileSizeMB' | 'minImageHeight' | 'minImageWidth'>> & {
     purgeInput: () => void;
 };

package/dist/helpers/generate-skus-functions/helpers/generate-skus-from-options/generate-skus-from-options.types.d.ts

@@ -1,5 +1,4 @@
 export interface GenerateSkusFromOptionsProps {
-    loopNum?: number;
     options: string[][];
     partialSkus: string[];
 }