@veeqo/ui 4.1.1 → 4.2.0

package/dist/components/UploadFile/UploadFile.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import { UploadFileProps } from './types';
+export declare const UploadFile: React.ForwardRefExoticComponent<UploadFileProps & React.RefAttributes<HTMLInputElement>>;

package/dist/components/UploadFile/UploadFile.test.d.ts

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

package/dist/components/UploadFile/UploadGraphic.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const UploadGraphic: () => React.JSX.Element;

package/dist/components/UploadFile/components/UploadCopy/UploadCopy.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+type UploadedFileProps = {
+    label: string;
+    acceptedTypesCopy: string;
+    maxSizeCopy: string;
+};
+export declare const UploadCopy: ({ label, acceptedTypesCopy, maxSizeCopy }: UploadedFileProps) => React.JSX.Element;
+export {};

package/dist/components/UploadFile/components/UploadedFile/UploadedFile.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+type UploadedFileProps = {
+    file: File;
+    label: string;
+    fileSizeCopy: string;
+    acceptedTypesCopy?: string;
+    maxSizeCopy?: string;
+};
+export declare const UploadedFile: ({ file, label, fileSizeCopy, acceptedTypesCopy, maxSizeCopy, }: UploadedFileProps) => React.JSX.Element;
+export {};

package/dist/components/UploadFile/components/styled.d.ts

@@ -0,0 +1,2 @@
+export declare const NoPointerStack: import("styled-components").StyledComponent<"div", any, import("../../Stack/types").StackProps, never>;
+export declare const SingleLineText: import("styled-components").StyledComponent<"span", any, {} & import("../../Text/types").TextProps, never>;

package/dist/components/UploadFile/constants.d.ts

@@ -0,0 +1,17 @@
+export declare enum AcceptedFileTypes {
+    CSV = ".csv",
+    JPEG = ".jpeg",
+    JPG = ".jpg",
+    GIF = ".gif",
+    PNG = ".png"
+}
+export declare enum FileSizeUnit {
+    KB = "KB",
+    MB = "MB"
+}
+export declare enum InputState {
+    VALID = "",
+    INVALID_FORMAT = "File is incorrect format",
+    INVALID_SIZE = "File size is too big",
+    INVALID_FORMAT_AND_SIZE = "File is incorrect format and too big"
+}

package/dist/components/UploadFile/index.d.ts

@@ -0,0 +1,2 @@
+export { UploadFile } from './UploadFile';
+export { AcceptedFileTypes, FileSizeUnit } from './constants';

package/dist/components/UploadFile/styled.d.ts

@@ -0,0 +1 @@
+export declare const DropZoneLabel: import("styled-components").StyledComponent<"label", any, {}, never>;

package/dist/components/UploadFile/types.d.ts

@@ -0,0 +1,9 @@
+import { AcceptedFileTypes, FileSizeUnit } from './constants';
+export interface UploadFileProps {
+    id: string;
+    name?: string;
+    fileTypes: Array<AcceptedFileTypes>;
+    label?: string;
+    format?: FileSizeUnit;
+    maxBytes?: number;
+}

package/dist/components/UploadFile/utils/getFileSizeString/getFileSizeString.d.ts

@@ -0,0 +1,24 @@
+import { FileSizeUnit } from '../../constants';
+type GetFileSizeStringProps = {
+    maxBytes: number;
+    format: FileSizeUnit;
+    baseString?: string;
+};
+/**
+ * Constructs a string intended to be consumed by an <input> element of type "file". This string
+ * should go inside the accept property
+ *
+ * E.g.
+ *
+ * const maxSizeCopy = getFileSizeString({
+ *  maxBytes: 10000,
+ *  format: FileSizeUnit.MB
+ * });
+ *
+ * Where @constant maxSizeCopy would equal "Max size: 1 MB"
+ *
+ * @param fileTypes - A list of file types, each value being of @type AcceptedFileTypes
+ * the returned string
+ */
+export declare const getFileSizeString: ({ maxBytes, format, baseString }: GetFileSizeStringProps) => string;
+export {};

package/dist/components/UploadFile/utils/getFileSizeString/getFileSizeString.test.d.ts

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

package/dist/components/UploadFile/utils/getTypePropForInputEl/getTypePropForInputEl.d.ts

@@ -0,0 +1,24 @@
+import { AcceptedFileTypes } from '../../constants';
+type GetValidTypesStringProps = {
+    fileTypes: Array<AcceptedFileTypes>;
+    baseString?: string;
+};
+/**
+ * Constructs a string intended to be consumed by an <input> element of type "file". This string
+ * should go inside the accept property.
+ *
+ * E.g.
+ *
+ * const inputElAcceptProperty = getTypePropForInputEl({
+ *  fileTypes: [
+ *    AcceptedFileTypes.CSV,
+ *  ]
+ * });
+ *
+ * Where @constant inputElAcceptProperty would equal ".csv"
+ *
+ * @param fileTypes - A list of file types, each value being of @type AcceptedFileTypes
+ * the returned string
+ */
+export declare const getTypePropForInputEl: ({ fileTypes }: GetValidTypesStringProps) => string;
+export {};

package/dist/components/UploadFile/utils/getTypePropForInputEl/getTypePropForInputEl.test.d.ts

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

package/dist/components/UploadFile/utils/getValidTypesString/getValidTypesString.d.ts

@@ -0,0 +1,25 @@
+import { AcceptedFileTypes } from '../../constants';
+type GetValidTypesStringProps = {
+    fileTypes: Array<AcceptedFileTypes>;
+    baseString?: string;
+};
+/**
+ * Constructs a user-friendly string of accepted types valid for the UploadFile component based on the
+ * fileTypes list passed as parameter.
+ *
+ * E.g.
+ *
+ * const validTypesCopy = getValidTypesString({
+ *  fileTypes: [
+ *    AcceptedFileTypes.CSV,
+ *  ]
+ * });
+ *
+ * Where @constant validTypesCopy would equal "Valid types: CSV"
+ *
+ * @param fileTypes - A list of file types, each value being of @type AcceptedFileTypes
+ * @param baseString - An optional string to override the default value of 'Valid types: ' prefixed to
+ * the returned string
+ */
+export declare const getValidTypesString: ({ fileTypes, baseString }: GetValidTypesStringProps) => string;
+export {};

package/dist/components/UploadFile/utils/getValidTypesString/getValidTypesString.test.d.ts

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

package/dist/components/UploadFile/utils/index.d.ts

@@ -0,0 +1,4 @@
+export { getValidTypesString } from './getValidTypesString/getValidTypesString';
+export { getFileSizeString } from './getFileSizeString/getFileSizeString';
+export { getTypePropForInputEl } from './getTypePropForInputEl/getTypePropForInputEl';
+export { setInputElFile } from './setInputElFile/setInputElFile';

package/dist/components/UploadFile/utils/setInputElFile/setInputElFile.d.ts

@@ -0,0 +1,13 @@
+type SetInputElFileProps = {
+    fileList: FileList;
+    elementId: string;
+};
+/**
+ * Updates the value of the files attribute held within an input elment. Used during DnD operations where
+ * the input element's files need to kept in sync and updated.
+ *
+ * @param fileList - A list of files, typically extracted from the "files" attribute of an input element
+ * @param elementId - The ID of the input element
+ */
+export declare const setInputElFile: ({ fileList, elementId }: SetInputElFileProps) => void;
+export {};

package/dist/components/UploadFile/utils/setInputElFile/setInputElFile.test.d.ts

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

package/dist/components/index.d.ts

@@ -47,6 +47,7 @@ export { ToastsLayout } from './ToastsLayout';
 export { Toggle } from './Toggle';
 export { ToggleButton } from './ToggleButton';
 export { Tooltip } from './Tooltip';
+export { UploadFile, AcceptedFileTypes, FileSizeUnit } from './UploadFile';
 export { VideoModal, Popup } from './VideoModal';
 export { View } from './View';
 export { WeightInput } from './WeightInput';