@adyen/bento-vue3 1.40.0 → 1.42.0

package/dist/@types/packages/vue2/src/components/file-uploader/components/file-uploader-file-card/file-uploader-file-card.vue.d.ts

@@ -0,0 +1,63 @@
+import type { FileUploaderFileCardProps } from './file-uploader-file-card.types';
+/**
+ *
+ * Individual file items that are listed inside "bento-file-uploader" that can
+ * be retried, removed or cancelled as they are being uploaded.
+ *
+ * @example
+ * import { FileUploaderFileCard, FileObject } from './';
+ *
+ * export default {
+ *     components: { FileUploaderFileCard },
+ *     template: `
+ *          <file-uploader-file-card
+ *              :file="file"
+ *              supportedFileTypes="video files, image files"
+ *              @retry="retryFile(file)"
+ *              @cancel="removeFile(file)"
+ *              @remove="removeFile(file)"
+ *          />
+ *     `,
+ *     setup() {
+ *         const file = ref<FileObject>({
+ *             id: 'stub-file',
+ *             type: FileType.AUDIO,
+ *             data: new File(['blob'], 'File name'),
+ *             state: FileState.SUCCESS,
+ *             progress: 99,
+ *         });
+ *     }
+ * }
+ */
+declare const _default: import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").DefineComponent<import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FileUploaderFileCardProps>, {
+    supportedFileTypes: any;
+}>>, {}, {}, {}, {}, import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ComponentOptionsMixin, import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ComponentOptionsMixin, {
+    cancel: () => void;
+} & {
+    remove: () => void;
+} & {
+    retry: () => void;
+}, string, import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").PublicProps, Readonly<import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FileUploaderFileCardProps>, {
+    supportedFileTypes: any;
+}>>> & Readonly<{
+    onCancel?: () => any;
+    onRemove?: () => any;
+    onRetry?: () => any;
+}>, {
+    supportedFileTypes: import("../../file-uploader.types").SupportedFileTypes;
+}, {}, {}, {}, string, import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? P[K] & {
+        default: D[K];
+    } : P[K];
+};

package/dist/@types/packages/vue2/src/components/file-uploader/components/file-uploader-file-card/index.d.ts

@@ -0,0 +1 @@
+export { default as FileUploaderFileCard } from './file-uploader-file-card.vue';

package/dist/@types/packages/vue2/src/components/file-uploader/components/file-uploader-file-card/utils/get-file-icon/get-file-icon.d.ts

@@ -0,0 +1,8 @@
+import { VueNodeElement } from "../../../../../../types";
+import { type FileObject } from "../../../../file-uploader.types";
+/**
+ * Return an icon Vue component that can be used with a given File type @see FileType
+ * @param file File object containing a type
+ * @returns Icon for the respective type
+ */
+export declare function getFileIcon(file: FileObject): VueNodeElement;

package/dist/@types/packages/vue2/src/components/file-uploader/components/file-uploader-file-card/utils/get-file-icon-color/get-file-icon-color.d.ts

@@ -0,0 +1,8 @@
+import { type FileObject } from "../../../../file-uploader.types";
+/**
+ * Returns the color to be used for the icon of a given type.
+ *
+ * @param file File with a given type
+ * @returns Color to be used with their respective file type
+ */
+export declare function getFileIconColor(file: FileObject): "blue" | "green" | "grey" | "orange";

package/dist/@types/packages/vue2/src/components/file-uploader/components/file-uploader-file-card/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './get-file-icon/get-file-icon';
+export * from './get-file-icon-color/get-file-icon-color';

package/dist/@types/packages/vue2/src/components/file-uploader/components/file-uploader-restrictions/file-uploader-restrictions.types.d.ts

@@ -0,0 +1,39 @@
+import type { BentoFileUploaderProps, SupportedFileTypes } from "../../file-uploader.types";
+export interface FileUploaderRestrictionsProps {
+    /**
+     * Reduces the size of the uploader area.
+     */
+    condensed?: BentoFileUploaderProps['condensed'];
+    /**
+     * Disables the File uploader
+     */
+    disabled?: BentoFileUploaderProps['disabled'];
+    /**
+     * Sets a maximum file count.
+     */
+    maxCount?: {
+        value: BentoFileUploaderProps['maxCount'];
+        error: boolean;
+    };
+    /**
+     * Sets a maximum image size (for image file types only).
+     */
+    maxDimensions?: {
+        value: BentoFileUploaderProps['maxDimensions'];
+        error: boolean;
+    };
+    /**
+     * Sets a maximum file size in Bytes
+     */
+    maxSize?: {
+        value: BentoFileUploaderProps['maxSize'];
+        error: boolean;
+    };
+    /**
+     * Supported file types message
+     */
+    supportedFileTypes?: {
+        value: SupportedFileTypes;
+        error: boolean;
+    };
+}

package/dist/@types/packages/vue2/src/components/file-uploader/components/file-uploader-restrictions/file-uploader-restrictions.vue.d.ts

@@ -0,0 +1,68 @@
+import type { FileUploaderRestrictionsProps } from './file-uploader-restrictions.types';
+/**
+ * List of restrictions defined for "bento-file-uploader".
+ *
+ * @example
+ * import { FileUploaderRestrictions } from './';
+ *
+ * export default {
+ *     components: { FileUploaderRestrictions },
+ *     template: `
+ *          <file-uploader-restrictions
+ *              :maxCount="1"
+ *              :maxSize="5000"
+ *              :maxDimensions="{ width: 100, height: 200 }"
+ *              supportedFileTypes="audio/*,.pdf,.jpg"
+ *          />
+ *     `
+ * }
+ */
+declare const _default: import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").DefineComponent<import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FileUploaderRestrictionsProps>, {
+    condensed: any;
+    disabled: any;
+    maxCount: any;
+    maxDimensions: any;
+    maxSize: any;
+    supportedFileTypes: any;
+}>>, {}, {}, {}, {}, import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ComponentOptionsMixin, import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ComponentOptionsMixin, {}, string, import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").PublicProps, Readonly<import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FileUploaderRestrictionsProps>, {
+    condensed: any;
+    disabled: any;
+    maxCount: any;
+    maxDimensions: any;
+    maxSize: any;
+    supportedFileTypes: any;
+}>>> & Readonly<{}>, {
+    condensed: import("../..").BentoFileUploaderProps["condensed"];
+    disabled: import("../..").BentoFileUploaderProps["disabled"];
+    supportedFileTypes: {
+        value: import("../../file-uploader.types").SupportedFileTypes;
+        error: boolean;
+    };
+    maxCount: {
+        value: import("../..").BentoFileUploaderProps["maxCount"];
+        error: boolean;
+    };
+    maxDimensions: {
+        value: import("../..").BentoFileUploaderProps["maxDimensions"];
+        error: boolean;
+    };
+    maxSize: {
+        value: import("../..").BentoFileUploaderProps["maxSize"];
+        error: boolean;
+    };
+}, {}, {}, {}, string, import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? P[K] & {
+        default: D[K];
+    } : P[K];
+};

package/dist/@types/packages/vue2/src/components/file-uploader/components/file-uploader-restrictions/index.d.ts

@@ -0,0 +1 @@
+export { default as FileUploaderRestrictions } from './file-uploader-restrictions.vue';

package/dist/@types/packages/vue2/src/components/file-uploader/composables/index.d.ts

@@ -0,0 +1 @@
+export * from './use-file-type-list/use-file-type-list';

package/dist/@types/packages/vue2/src/components/file-uploader/composables/use-file-type-list/use-file-type-list.d.ts

@@ -0,0 +1,11 @@
+import { Ref } from "../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue";
+/**
+ * Transforms a list of accepted file types @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept}
+ * into a human readable list of accepted types
+ *
+ * @param accept String containing a list of unique file type specifiers.
+ * @returns String with types transformed to human readable text
+ */
+export declare function useFileTypeList(accept?: Ref<string>): {
+    supportedFileTypeList: import("../../../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ComputedRef<string>;
+};

package/dist/@types/packages/vue2/src/components/file-uploader/file-uploader.types.d.ts

@@ -0,0 +1,99 @@
+export type BentoFileUploaderValue = string | Array<string> | File | Array<File>;
+export interface BentoFileUploaderProps {
+    /**
+     * A string that defines the file types the file input should accept.
+     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept
+     */
+    accept?: HTMLInputElement['accept'];
+    /**
+     * Reduces the size of the uploader area.
+     */
+    condensed?: boolean;
+    /**
+     * Descriptive supporting text visbile underneath the label.
+     */
+    description?: string;
+    /**
+     * Disable the radio button (optional).
+     */
+    disabled?: boolean;
+    /**
+     * Renders file-uploader with an error state and the error message beneath the input box
+     */
+    errorMessage?: string;
+    /**
+     * The label of the component.
+     */
+    label: string;
+    /**
+     * Sets a maximum file count. Allows for uploading multiple files.
+     */
+    maxCount?: number;
+    /**
+     * Sets a maximum image size (for image file types only).
+     */
+    maxDimensions?: {
+        width?: number;
+        height?: number;
+    };
+    /**
+     * Sets a maximum file size in Bytes
+     */
+    maxSize?: number;
+    /**
+     * Used to support `v-model`. Doesn't actually set the value of the file uploader.
+     */
+    modelValue?: BentoFileUploaderValue;
+    /**
+     * Sets the field as optional.
+     */
+    optional?: boolean;
+    /**
+     * Sets the field as required.
+     */
+    required?: boolean;
+    /**
+     * Adds a info icon next to the label to display the passed tooltip message.
+     */
+    tooltipText?: string;
+}
+/**
+ * Private types
+ */
+export declare enum FileState {
+    LOADING = "loading",
+    ERROR_SIZE = "error-size",
+    ERROR_LOAD = "error-load",
+    ERROR_DIMENSIONS = "error-dimensions",
+    ERROR_TYPE = "error-type",
+    SUCCESS = "success"
+}
+export declare enum FileUploaderState {
+    DISABLED = "disabled",
+    DRAG_OVER = "drag-over",
+    ERROR = "error",
+    READONLY = "readonly"
+}
+export declare enum FileType {
+    TABLE = "table",
+    IMAGE = "image",
+    VIDEO = "video",
+    AUDIO = "audio",
+    TEXT = "text",
+    PDF = "pdf",
+    SLIDES = "slides",
+    COMPRESSED = "compressed",
+    GENERIC = "generic"
+}
+export interface FileObject {
+    id: string;
+    data: File;
+    state: FileState;
+    type: FileType;
+    progress: number | null;
+    dimensions?: {
+        width: number;
+        height: number;
+    };
+}
+export type SupportedFileTypes = string;

package/dist/@types/packages/vue2/src/components/file-uploader/file-uploader.vue.d.ts

@@ -0,0 +1,85 @@
+import { type BentoFileUploaderProps } from './file-uploader.types';
+/**
+ * The file uploader component enables users to upload one or multiple files from their device to our system.
+ *
+ * @example
+ * import { BentoFileUploader, type BentoFileValue } from '@adyen/bento-vue2';
+ *
+ * export default {
+ *     components: { BentoFileUploader },
+ *     template: `
+ *          <bento-file-uploader
+ *              accept="image/*,video/*,.pdf,.png"
+ *              condensed
+ *              description="Custom supporting text"
+ *              disabled
+ *              errorMessage="Custom error message"
+ *              label="Bento file uploader"
+ *              :maxCount="1"
+ *              :maxDimensions="{ width: 200, height: 100 }"
+ *              :maxSize="1000"
+ *              v-model="files"
+ *              multiple
+ *              :optional="false"
+ *              required
+ *              tooltipText="Useful information"
+ *          />
+ *     `,
+ *      setup() {
+ *          const files = ref<BentoFileValue>()
+ *      }
+ * }
+ */
+declare const _default: import("../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").DefineComponent<import("../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<BentoFileUploaderProps>, {
+    accept: any;
+    description: any;
+    errorMessage: any;
+    maxCount: number;
+    maxDimensions: any;
+    maxSize: any;
+    modelValue: any;
+    tooltipText: any;
+}>>, {}, {}, {}, {}, import("../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ComponentOptionsMixin, import("../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ComponentOptionsMixin, {
+    change: (value?: FileList) => void;
+} & {
+    "update:modelValue": (value?: FileList) => void;
+}, string, import("../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").PublicProps, Readonly<import("../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<BentoFileUploaderProps>, {
+    accept: any;
+    description: any;
+    errorMessage: any;
+    maxCount: number;
+    maxDimensions: any;
+    maxSize: any;
+    modelValue: any;
+    tooltipText: any;
+}>>> & Readonly<{
+    onChange?: (value?: FileList) => any;
+    "onUpdate:modelValue"?: (value?: FileList) => any;
+}>, {
+    description: string;
+    tooltipText: string;
+    errorMessage: string;
+    modelValue: import("./file-uploader.types").BentoFileUploaderValue;
+    accept: HTMLInputElement["accept"];
+    maxCount: number;
+    maxDimensions: {
+        width?: number;
+        height?: number;
+    };
+    maxSize: number;
+}, {}, {}, {}, string, import("../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import("../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import("../../../../../node_modules/.pnpm/vue@3.5.13_typescript@5.6.3/node_modules/vue").PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? P[K] & {
+        default: D[K];
+    } : P[K];
+};

package/dist/@types/packages/vue2/src/components/file-uploader/index.d.ts

@@ -0,0 +1,2 @@
+export { default as BentoFileUploader } from './file-uploader.vue';
+export type { BentoFileUploaderValue, BentoFileUploaderProps } from './file-uploader.types';

package/dist/@types/packages/vue2/src/components/file-uploader/utils/format-file-size/format-file-size.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Converts size in bytes to a human readable format.
+ * For example, it transforms "1000" to "1kB"
+ *
+ * @param locale App's set locale (e.g. en, es, pt-BR)
+ * @param size Size of file
+ * @returns Size of file using metrics
+ */
+export declare function formatFileSize(locale: string, size: number): string;

package/dist/@types/packages/vue2/src/components/file-uploader/utils/get-file-type/get-file-type.d.ts

@@ -0,0 +1,8 @@
+import { FileType } from "../../file-uploader.types";
+/**
+ * Categorizes the type of a file. Maps all types of text, image, video,
+ * audio and documents to an specific category such as "text/*" or "image/*" respectively
+ * @param file File to be typed
+ * @returns Type category of the file being uploaded
+ */
+export declare function getFileType(file: File): FileType;

package/dist/@types/packages/vue2/src/components/file-uploader/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './format-file-size/format-file-size';
+export * from './get-file-type/get-file-type';
+export * from './read-file/read-file';

package/dist/@types/packages/vue2/src/components/file-uploader/utils/read-file/read-file.d.ts

@@ -0,0 +1,14 @@
+import { type FileObject } from "../../file-uploader.types";
+/**
+ * Process a file to verify if it fulfills the accepted type restrictions defined in "accept",
+ * the dimensions for "image/*" types defined by "maxDimensions". The state of the "fileObject" will
+ * be updated according to the restrictions or if it was successfully uploaded.
+ *
+ * @param fileObject File to be processed
+ * @param accept HTML MIME types valid for the file to be processed
+ * @param maxDimensions Width and height restrictions for "image/*" files
+ */
+export declare function readFile(fileObject: FileObject, accept?: string, maxDimensions?: {
+    width?: number;
+    height?: number;
+}): void;