@procore/core-react 10.21.0-rc.27 → 10.21.0-rc.31

package/dist/esm/components/FileSelect/FileSelect.types.d.ts

@@ -6,57 +6,150 @@ import { LocalSourceProps } from './LocalSource';
 import { ThumbnailListItem } from './ThumbnailList/ThumbnailList.types';
 export declare type FileSelectValue = FileSelectValueEntry[];
 export interface FileSelectSource {
+    /**
+     * @since 10.19.0
+     */
     sourceId: SourceId;
+    /**
+     * @since 10.19.0
+     */
     title: string;
     /**
-     * @deprecated String icon variant is deprecated, use the React components directly from the `@procore/core-icons/dist` package
+     * @deprecated String icon variant is deprecated, use the React components
+     * directly from the `@procore/core-icons/dist` package
+     * @since 10.19.0
      */
     icon: string | React.ReactNode;
+    /**
+     * @since 10.19.0
+     */
     hasError: boolean;
+    /**
+     * @since 10.19.0
+     */
     isUploading: boolean;
+    /**
+     * @since 10.19.0
+     */
     value: SourceValueEntry[];
 }
 export declare type ValueId = string | number;
 export interface FileSelectValueEntry {
+    /**
+     * @since 10.19.0
+     */
     id: ValueId;
+    /**
+     * @since 10.19.0
+     */
     name: string;
+    /**
+     * @since 10.19.0
+     */
     src?: File | string;
+    /**
+     * @since 10.19.0
+     */
     error?: string;
+    /**
+     * @since 10.19.0
+     */
     origin?: unknown;
+    /**
+     * @since 10.19.0
+     */
     response?: unknown;
+    /**
+     * @since 10.19.0
+     */
     sourceId?: string;
 }
 export declare type SetFileSelectValue = React.Dispatch<React.SetStateAction<FileSelectValue>>;
 export interface FileSelectRef {
+    /**
+     * @since 10.19.0
+     */
     setValue: SetFileSelectValue;
+    /**
+     * @since 10.19.0
+     */
     open: (sourceId: SourceId) => void;
+    /**
+     * @since 10.19.0
+     */
     rootEl: React.RefObject<HTMLDivElement | null>;
+    /**
+     * @since 10.19.0
+     */
     modalEl: React.RefObject<HTMLDivElement | null>;
 }
 export interface FileSelectContextApi {
+    /**
+     * @since 10.19.0
+     */
     register: (sourceId: SourceId, source: Partial<Pick<FileSelectSource, 'title' | 'icon'>>) => () => void;
+    /**
+     * @since 10.19.0
+     */
     currentSource: SourceId;
+    /**
+     * @since 10.19.0
+     */
     isModalOpen: boolean;
+    /**
+     * @since 10.19.0
+     */
     onChange: (sourceId: SourceId, value: SourceValueEntry[]) => void;
+    /**
+     * @since 10.19.0
+     */
     onResetValue: (listener: () => void) => () => void;
+    /**
+     * @since 10.19.0
+     */
     setIsUploading: (sourceId: SourceId, isUploading: boolean) => void;
+    /**
+     * @since 10.19.0
+     */
     setHasError: (sourceId: SourceId, isError: boolean) => void;
+    /**
+     * @since 10.19.0
+     */
     maxFileNumber: number;
 }
 export interface DropzoneContentRendererProps {
     /**
      * Enable/disable the dropzone
+     * @since 10.19.0
      */
     disabled: DropzoneContentProps['disabled'];
+    /**
+     * @since 10.19.0
+     */
     errorMessage?: DropzoneContentProps['errorMessage'];
+    /**
+     * @since 10.19.0
+     */
     openLocalFiles: () => void;
+    /**
+     * @since 10.19.0
+     */
     openFileExplorer: () => void;
 }
 export declare type SourceId = string;
 export declare type SourceValueEntry = any;
 export interface QaTags {
+    /**
+     * @since 10.19.0
+     */
     localSource?: LocalSourceProps['qa'];
+    /**
+     * @since 10.19.0
+     */
     attachButton?: string;
+    /**
+     * @since 10.19.0
+     */
     removeEntry?: string;
 }
 export interface FileSelectProps extends Omit<DivAttributes, 'onError' | 'onProgress'> {
@@ -64,15 +157,18 @@ export interface FileSelectProps extends Omit<DivAttributes, 'onError' | 'onProg
      * To be called every time when the files are uploaded directly or
      * attached via file explorer. The input data should be appended to the
      * current value. Files with upload errors are omitted.
+     * @since 10.19.0
      */
     onAdd?: (value: FileSelectValue) => void;
     /**
      * To be called whenever the file is removed by user from the primary token
      * list. Removed item should be deleted from the current value by `id` key
+     * @since 10.19.0
      */
     onRemove?: (valueEntry: FileSelectValueEntry) => void;
     /**
      * To be called whenever the upload progress is changed
+     * @since 10.19.0
      */
     onProgress?: (fileId: ValueId, progress: number) => void;
     /**
@@ -80,18 +176,22 @@ export interface FileSelectProps extends Omit<DivAttributes, 'onError' | 'onProg
      * local file. If you want to restrict certain uploads, you can use this
      * callback. Returning true continues the upload, while false will prevent
      * upload.
+     * @since 10.19.0
      */
     beforeLocalFileUpload?: (files: ThumbnailListItem[]) => Promise<boolean>;
     /**
      * To be called whenever upload state is changed
+     * @since 10.19.0
      */
     onUploadStateChange?: (isPendingUpload: boolean) => void;
     /**
-     * To be called whenever an upload error occures
+     * To be called whenever an upload error occurs
+     * @since 10.19.0
      */
     onError?: (fileId: ValueId, error: unknown) => void;
     /**
      * To be called when attached file receives a click
+     * @since 10.19.0
      */
     onFileTokenClick?: (file: FileSelectValueEntry) => void;
     /**
@@ -99,20 +199,24 @@ export interface FileSelectProps extends Omit<DivAttributes, 'onError' | 'onProg
      * `{ open, disabled, errorMessage }` as a single argument,
      * allowing to control the dropzone and display different content depending
      * on dropzone state
+     * @since 10.19.0
      */
     dropzoneContentRenderer?: (dropzoneProps: DropzoneContentRendererProps) => React.ReactNode;
     /**
      * Hide dropzone and render only default "Attach File(s)" button.
      * @default false
+     * @since 10.19.0
      */
     hideDropzone?: boolean;
     /**
      * Hide local files source in file explorer modal
+     * @since 10.19.0
      */
     hideLocalSource?: boolean;
     /**
      * Customize the token label for a given source value. By default,
      * `sourceValueEntry.name` is returned.
+     * @since 10.19.0
      */
     getTokenLabel?: (sourceId: string, sourceValueEntry: unknown) => string;
     localSourceDropzoneContentRenderer?: (dropzoneProps: DropzoneContentProps) => React.ReactNode;
@@ -120,53 +224,64 @@ export interface FileSelectProps extends Omit<DivAttributes, 'onError' | 'onProg
      * A function returning an upload URL for a given file. An
      * alternative to `uploadFile` which allows manual control of
      * the network request for file upload.
+     * @since 10.19.0
      */
     getEndpoint?: (file: File) => string;
     /**
      * A function returning an upload HTTP method for a given file.
      * Returns `POST` by default.
+     * @since 10.19.0
      */
     getMethod?: (file: File) => Method;
     /**
      * A function returning an upload payload `FormData` key
      * for a given file. Returns `file` by default.
+     * @since 10.19.0
      */
     getPayloadKey?: (file: File) => string;
     /**
      * A function returning an upload payload `FormData`
      * object for a given file. When defined, `getPayloadKey` is
      * ignored.
+     * @since 10.19.0
      */
     getPayload?: (file: File) => FormData;
     /**
      * A function returning an upload request headers. Returns empty
      * object by default.
+     * @since 10.19.0
      */
     getHeaders?: (file: File) => Record<string, string>;
     /**
      * A function for manually controlling the network request for file
      * upload. An alternative to using `getEndpoint` which handles
      * the network request itself.
+     * @since 10.19.0
      */
     uploadFile?: UploadFile;
     /**
      * Maximum number of files that can be selected
+     * @since 10.19.0
      */
     maxFileNumber?: number;
     /**
      * Maximum file size (in bytes)
+     * @since 10.19.0
      */
     maxFileSize?: number;
     /**
      * Minimum file size (in bytes)
+     * @since 10.19.0
      */
     minFileSize?: number;
     /**
      * Set accepted file types. Accepts everything if left undefined
+     * @since 10.19.0
      */
     accept?: string | string[];
     /**
      * @ignore
+     * @since 10.19.0
      */
     qa?: QaTags;
 }

package/dist/esm/components/FileSelect/FileSelectDropzone/FileSelectDropzone.types.d.ts

@@ -1,34 +1,103 @@
 import { DropzoneContentProps, DropzoneHookProps, DropzoneProps } from '../../Dropzone/Dropzone.types';
 import { ValueId } from '../FileSelect.types';
 interface QaTags {
+    /**
+     * @since 10.19.0
+     */
     attachFiles?: string;
+    /**
+     * @since 10.19.0
+     */
     fileToken?: (id: ValueId) => string;
 }
 export interface FileSelectDropzoneProps {
+    /**
+     * @since 10.19.0
+     */
     contentRenderer?: (props: DropzoneContentProps) => React.ReactNode;
+    /**
+     * @since 10.19.0
+     */
     hideDropzone?: boolean;
+    /**
+     * @since 10.19.0
+     */
     onAttachFromProject: () => void;
+    /**
+     * @since 10.19.0
+     */
     tooltip: DropzoneProps['tooltip'];
+    /**
+     * @since 10.19.0
+     */
     accept: DropzoneHookProps['accept'];
+    /**
+     * @since 10.19.0
+     */
     maxFileNumber?: number;
+    /**
+     * @since 10.19.0
+     */
     maxFileSize?: number;
+    /**
+     * @since 10.19.0
+     */
     minFileSize?: number;
+    /**
+     * @since 10.19.0
+     */
     disabled: boolean;
+    /**
+     * @since 10.19.0
+     */
     value: DropzoneHookProps['value'];
+    /**
+     * @since 10.19.0
+     */
     onDrop: DropzoneHookProps['onDrop'];
+    /**
+     * @since 10.19.0
+     */
     multiple: boolean;
+    /**
+     * @since 10.19.0
+     */
     noDrag: boolean;
+    /**
+     * @since 10.19.0
+     */
     qa?: QaTags;
 }
 export interface FileSelectDropzoneRef {
+    /**
+     * @since 10.19.0
+     */
     clearErrors: () => void;
+    /**
+     * @since 10.19.0
+     */
     attachButton: HTMLButtonElement | null;
 }
 export interface FileSelectDropzoneContentProps extends DropzoneContentProps {
+    /**
+     * @since 10.19.0
+     */
     hideDropzone?: boolean;
+    /**
+     * @since 10.19.0
+     */
     multiple: boolean;
+    /**
+     * @since 10.19.0
+     */
     onAttachFromProject: () => void;
+    /**
+     * @since 10.19.0
+     */
     tooltip?: React.ReactNode | string;
+    /**
+     * @since 10.19.0
+     */
     qa?: QaTags;
 }
 export {};

package/dist/esm/components/FileSelect/FileTokenList/FileToken.types.d.ts

@@ -1,17 +1,47 @@
 import { ValueId } from '../FileSelect.types';
 export interface FileTokenEntry {
+    /**
+     * @since 10.19.0
+     */
     id: string | number;
+    /**
+     * @since 10.19.0
+     */
     name: string;
+    /**
+     * @since 10.19.0
+     */
     error?: string;
+    /**
+     * @since 10.19.0
+     */
     progress?: number;
 }
 export interface QaTags {
+    /**
+     * @since 10.19.0
+     */
     fileToken?: (id: ValueId) => string;
+    /**
+     * @since 10.19.0
+     */
     closeButton?: string;
 }
 export interface FileTokenListProps {
+    /**
+     * @since 10.19.0
+     */
     tokens: FileTokenEntry[];
+    /**
+     * @since 10.19.0
+     */
     onClick?: (token: FileTokenEntry) => void;
+    /**
+     * @since 10.19.0
+     */
     onClose?: (token: FileTokenEntry) => void;
+    /**
+     * @since 10.19.0
+     */
     qa?: QaTags;
 }

package/dist/esm/components/FileSelect/GridSource/GridSource.types.d.ts

@@ -10,15 +10,24 @@ export declare type GetThumbnailSource = (item: GridItem) => string;
 export declare type GetThumbnailLabel = (item: GridItem) => string;
 export declare type GetGroupId = (item: GridItem) => string | number;
 export interface GridProps {
+    /**
+     * @since 10.19.0
+     */
     sourceId: string;
     /**
-     * @deprecated String icon variant is deprecated, use the React components directly from the `@procore/core-icons/dist` package
+     * @deprecated String icon variant is deprecated, use the React components
+     * directly from the `@procore/core-icons/dist` package
+     * @since 10.19.0
      */
     icon: string | React.ReactNode;
+    /**
+     * @since 10.19.0
+     */
     title: string;
     /**
      * Allows controlling the search input value. Can be used with
      * <Code>onSearch</Code> to customize the default string-based search
+     * @since 10.19.0
      */
     searchQuery?: string;
     /**
@@ -26,27 +35,32 @@ export interface GridProps {
      * different set of <Code>items</Code> every time
      * <Code>onSearch</Code> is called with query string as a single
      * parameter
+     * @since 10.19.0
      */
     onSearch?: (q: string) => void;
     /**
      * React nodes to be displayed next to the search bar
+     * @since 10.19.0
      */
     children?: React.ReactNode;
     /**
      * An array of arbitrarily-shaped objects representing grid items.{' '}
      * <Code>getId</Code> <Code>getName</Code> and <Code>getThumbnail</Code>{' '}
      * should be used to bind the target shape to a view.
+     * @since 10.19.0
      */
     items: GridItem[];
     /**
      * <Code>{`{ id: string | number, title: string }[]`}</Code> object
      * representing file groups
+     * @since 10.19.0
      */
     groups?: ThumbnailGridGroup[];
     /**
      * <Code>{`{ text: string, image: string }`}</Code> props for{' '}
      * <Code>EmptyState</Code> component shown when there are no items in
      * grid
+     * @since 10.19.0
      */
     emptyState?: {
         text?: string;
@@ -54,20 +68,24 @@ export interface GridProps {
     };
     /**
      * Show/Hide loading indicator at the list bottom
+     * @since 10.19.0
      */
     isLoadingMore?: boolean;
     /**
      * Show/Hide loading indicator of the content
+     * @since 10.19.0
      */
     isLoading?: boolean;
     /**
      * Optional <Code>function</Code> that automatically executes when
      * scrolling reaches the last item.
+     * @since 10.19.0
      */
     onScrollBottom?: () => Promise<any>;
     /**
      * A function called returning ID of a given grid item that is used to
      * identify the item. Returns <Code>item.id</Code> by default.
+     * @since 10.19.0
      */
     getId?: GetId;
     /**
@@ -75,30 +93,43 @@ export interface GridProps {
      * used to display the item's thumbnail image. Returns{' '}
      * <Code>item.src</Code>
      * by default.
+     * @since 10.19.0
      */
     getThumbnailSource?: GetThumbnailSource;
     /**
      * A function called returning name of a given grid item that is used to
      * display the item's thumbnail name. Returns <Code>item.name</Code> by
      * default.
+     * @since 10.19.0
      */
     getThumbnailName?: GetThumnbnailName;
     /**
      * A function called returning label of a given grid item that is used to
      * display the item's thumbnail label. Returns <Code>item.label</Code>
      * by default.
+     * @since 10.19.0
      */
     getThumbnailLabel?: GetThumbnailLabel;
     /**
      * A function called returning group ID of a given grid item that is used
      * to sort items by group. Returns <Code>item.groupId</Code>
      * by default.
+     * @since 10.19.0
      */
     getGroupId?: GetGroupId;
+    /**
+     * @since 10.19.0
+     */
     qa?: QaTags;
 }
 export interface SearchBarProps {
+    /**
+     * @since 10.19.0
+     */
     onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * @since 10.19.0
+     */
     query: string;
 }
 export {};

package/dist/esm/components/FileSelect/LocalSource/LocalSource.types.d.ts

@@ -6,16 +6,22 @@ export declare type ValueId = string | number;
 export interface UploaderProps extends Omit<DropzoneHookProps, 'value'> {
     /**
      * Allow drag 'n' drop (or selection from the file dialog) of multiple files
+     * @since 10.19.0
      */
     multiple: boolean;
+    /**
+     * @since 10.19.0
+     */
     uploadedValue: ThumbnailListItem[];
     /**
      * Array of already selected items
+     * @since 10.19.0
      */
     value: ThumbnailListItem[];
     /**
      * Callback function fired with currently selected array of items.
      * <CodeBlock>(items: ThumbnailListItem[]) => void</CodeBlock>
+     * @since 10.19.0
      */
     onChange: (items: ThumbnailListItem[]) => void;
     /**
@@ -23,6 +29,7 @@ export interface UploaderProps extends Omit<DropzoneHookProps, 'value'> {
      * <br />
      * <br />
      * <Code>(item: ThumbnailListItem) => void</Code>
+     * @since 10.19.0
      */
     onCancel?: (item: ThumbnailListItem) => void;
     /**
@@ -30,29 +37,42 @@ export interface UploaderProps extends Omit<DropzoneHookProps, 'value'> {
      * <CodeBlock>
      *  {`{ type: DropErrorType, title: string, message: string }`}
      * </CodeBlock>
+     * @since 10.19.0
      */
     dropError?: DropError;
+    /**
+     * @since 10.19.0
+     */
     onDropError: (err: DropError) => void;
     /**
      * An optional content renderer for the dropzone. Accepts{' '}
      * <Code>{'{ open, disabled, errorMessage }'}</Code> as a single argument,
      * allowing to control the dropzone and display different content depending
      * on dropzone state
+     * @since 10.19.0
      */
     dropzoneContentRenderer?: (props: DropzoneContentProps) => React.ReactNode;
+    /**
+     * @since 10.19.0
+     */
     qa?: QaTags;
 }
 export interface LocalSourceProps {
+    /**
+     * @since 10.19.0
+     */
     sourceId: string;
     /**
      * Callback function fired when a previously selected file is removed.
      * <br />
      * <br />
      * <Code>(item: ThumbnailListItem) => void</Code>
+     * @since 10.19.0
      */
     onCancel?: UploaderProps['onCancel'];
     /**
      * Set accepted file types. Accepts everything if left undefined
+     * @since 10.19.0
      */
     accept?: UploaderProps['accept'];
     /**
@@ -61,6 +81,7 @@ export interface LocalSourceProps {
      * <br />A function returning an upload URL for a given file. An
      * alternative to <Code>uploadFile</Code> which allows manual control of
      * the network request for file upload.
+     * @since 10.19.0
      */
     getEndpoint?: (file: File) => string;
     /**
@@ -68,6 +89,7 @@ export interface LocalSourceProps {
      * <br />
      * <br />A function returning an upload HTTP method for a given file.
      * Returns <Code>POST</Code> by default.
+     * @since 10.19.0
      */
     getMethod?: (file: File) => Method;
     /**
@@ -76,6 +98,7 @@ export interface LocalSourceProps {
      * <br />A function returning an upload payload <Code>FormData</Code>{' '}
      * object for a given file. When defined, <Code>getPayloadKey</Code> is
      * ignored.
+     * @since 10.19.0
      */
     getPayload?: (file: File) => FormData;
     /**
@@ -84,6 +107,7 @@ export interface LocalSourceProps {
      * callback. Returning true continues the upload, while false will prevent
      * upload.
      * <Code>{'(files: ThumbnailListItem[]) => Promise<boolean>'}</Code>
+     * @since 10.19.0
      */
     beforeLocalFileUpload: (files: ThumbnailListItem[]) => Promise<boolean>;
     /**
@@ -91,6 +115,7 @@ export interface LocalSourceProps {
      * <br />
      * <br />A function returning an upload payload <Code>FormData</Code> key
      * for a given file. Returns <Code>file</Code> by default.
+     * @since 10.19.0
      */
     getPayloadKey?: (file: File) => string;
     /**
@@ -98,6 +123,7 @@ export interface LocalSourceProps {
      * <br />
      * <br />A function returning an upload request headers. Returns empty
      * object by default.
+     * @since 10.19.0
      */
     getHeaders?: (file: File) => Record<string, string>;
     /**
@@ -114,14 +140,17 @@ export interface LocalSourceProps {
      * <br />A function for manually controlling the network request for file
      * upload. An alternative to using <Code>getEndpoint</Code> which handles
      * the network request itself.
+     * @since 10.19.0
      */
     uploadFile?: UploadFile;
     /**
      * Maximum file size (in bytes)
+     * @since 10.19.0
      */
     maxFileSize?: number;
     /**
      * Minimum file size (in bytes)
+     * @since 10.19.0
      */
     minFileSize?: number;
     /**
@@ -129,7 +158,11 @@ export interface LocalSourceProps {
      * <Code>{'{ open, disabled, errorMessage }'}</Code> as a single argument,
      * allowing to control the dropzone and display different content depending
      * on dropzone state
+     * @since 10.19.0
      */
     dropzoneContentRenderer?: (props: DropzoneContentProps) => React.ReactNode;
+    /**
+     * @since 10.19.0
+     */
     qa?: UploaderProps['qa'];
 }