@ynput/ayon-frontend-shared 0.6.9 → 0.7.1

package/dist/types/components.d.ts

@@ -44,6 +44,7 @@ import { LabelHTMLAttributes } from 'react';
 import { LexicalCommand } from 'lexical';
 import { LexicalEditor } from 'lexical';
 import { LexicalNode } from 'lexical';
+import { MixedChange } from '@ynput/ayon-react-components';
 import { MouseEvent as MouseEvent_2 } from 'react';
 import { MutationActionCreatorResult } from '@reduxjs/toolkit/query';
 import { MutationDefinition } from '@reduxjs/toolkit/query';
@@ -352,6 +353,8 @@ export declare type BuildFilterOptions = {
 
 export declare const buildScopes: (scopes: ScopeType_2[], exclude?: Partial<Record<ScopeType_2, FilterFieldType[]>>) => ScopeWithFilterTypes[];
 
+export declare const buildSortMenuItem: <T extends string>({ options, sort, onChange, id, label, icon, }: SortMenuItemArgs<T>) => MenuItemType;
+
 declare type BundleMode = 'production' | 'staging' | 'developer';
 
 declare const Button: IStyledComponentBase<"web", FastOmit<Omit< ButtonProps & RefAttributes<HTMLButtonElement>, "ref"> & {
@@ -367,6 +370,7 @@ export declare const Chips: FC<ChipsProps>;
 declare interface ChipsProps {
     values: ChipValue[];
     disabled?: boolean;
+    className?: string;
     pt?: {
         chip?: Partial<HTMLAttributes<HTMLDivElement>>;
     };
@@ -378,6 +382,7 @@ export declare type ChipValue = {
     icon?: string;
     prefix?: default_2.ReactNode;
     suffix?: default_2.ReactNode;
+    onClick?: default_2.MouseEventHandler<HTMLDivElement>;
 };
 
 declare type ColorInputPt = Partial<React.InputHTMLAttributes<HTMLInputElement>>;
@@ -750,7 +755,7 @@ declare interface DescriptionSectionProps {
     }, target: HTMLElement) => void;
 }
 
-export declare const DetailsDialog: ({ projectName, entityType, entityIds, visible, onHide, }: DetailsDialogProps) => JSX_2.Element | null;
+export declare const DetailsDialog: ({ projectName, entityType, entityIds, visible, onHide, data: dataProp, header, }: DetailsDialogProps) => JSX_2.Element | null;
 
 export declare interface DetailsDialogProps {
     projectName?: string;
@@ -758,6 +763,8 @@ export declare interface DetailsDialogProps {
     entityIds: string[];
     visible: boolean;
     onHide: () => void;
+    data?: unknown;
+    header?: string;
 }
 
 declare type DetailsField = Pick<AttributeField, 'name' | 'data' | 'hidden'>;
@@ -772,6 +779,7 @@ export declare interface DetailsPanelAttributesEditorProps {
     form: Record<string, string | number | boolean | Date | any[] | Record<string, any> | undefined | null>;
     mixedFields?: string[];
     onChange?: (key: string, value: any) => void;
+    onMixedChange?: (key: string, change: MixedChange) => void;
     entities?: any[];
     projectName?: string;
     entityType?: string;
@@ -1247,6 +1255,26 @@ declare const EnumItemBody: IStyledComponentBase<"web", FastOmit<DetailedHTMLPro
 
 declare const EnumItemBodyExpander: IStyledComponentBase<"web", FastOmit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never> & Partial<Pick< DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>>> & string;
 
+export declare const EnumItemDialog: FC<EnumItemDialogProps>;
+
+export declare interface EnumItemDialogProps {
+    item?: EnumItemDraft;
+    isNew?: boolean;
+    fields: EnumItemField[];
+    itemLabel?: string;
+    onSave: (item: EnumItemDraft) => void;
+    onCancel: () => void;
+}
+
+export declare interface EnumItemDraft {
+    value: string;
+    label?: string;
+    icon?: string;
+    color?: string;
+}
+
+export declare type EnumItemField = 'label' | 'icon' | 'color';
+
 declare const EnumItemHeader: IStyledComponentBase<"web", FastOmit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never> & Partial<Pick< DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>>> & string;
 
 declare const EnumItemWrapper: IStyledComponentBase<"web", FastOmit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never> & Partial<Pick< DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>>> & string;
@@ -1397,7 +1425,7 @@ export declare interface FilterErrorActionsProps {
     errorMessage?: string;
 }
 
-export declare type FilterFieldType = 'folderType' | 'taskType' | 'productType' | 'productBaseType' | ('users' | 'assignees' | 'author') | 'attributes' | 'status' | 'tags' | 'version' | 'hasReviewables' | 'productName' | 'name' | 'createdAt' | 'updatedAt';
+export declare type FilterFieldType = 'folderType' | 'taskType' | 'productType' | 'productBaseType' | ('users' | 'assignees' | 'author') | 'attributes' | 'status' | 'tags' | 'version' | 'hasReviewables' | 'productName' | 'name' | 'extension' | 'createdAt' | 'updatedAt';
 
 export declare const FLOATING_TOOLBAR: ToolbarLayout;
 
@@ -2441,7 +2469,7 @@ declare type PowerpackDialogType = {
     icon?: string;
 };
 
-declare type PowerpackFeature = 'slicer' | 'annotations' | 'releases' | 'advancedFilters' | 'listAttributes' | 'listFolders' | 'listAccess' | 'groupAttributes' | 'sharedViews' | 'commentCategories' | 'projectFolders' | 'columnSummaries' | 'entityLinks';
+declare type PowerpackFeature = 'slicer' | 'annotations' | 'releases' | 'advancedFilters' | 'listAttributes' | 'listFolders' | 'listAccess' | 'groupAttributes' | 'sharedViews' | 'commentCategories' | 'projectFolders' | 'columnSummaries' | 'listValues' | 'entityLinks' | 'tableExport';
 
 declare interface Processing extends ReviewableProcessingStatus {
     progress?: number;
@@ -3015,7 +3043,7 @@ declare type Scalars = {
 
 declare type Scope = ScopeType | ScopeType[];
 
-declare type ScopeType = 'folder' | 'product' | 'task' | 'user' | 'version';
+declare type ScopeType = 'folder' | 'product' | 'task' | 'user' | 'version' | 'representation';
 
 declare type ScopeType_2 = ScopeWithFilterTypes['scope'];
 
@@ -3215,6 +3243,26 @@ declare type SlideOut = {
     projectName: string;
 };
 
+declare interface SortMenuItemArgs<T extends string> {
+    options: SortMenuOption<T>[];
+    sort: SortMenuValue<T>;
+    onChange: (sort: SortMenuValue<T>) => void;
+    id?: string;
+    label?: string;
+    icon?: string;
+}
+
+export declare interface SortMenuOption<T extends string = string> {
+    id: T;
+    label: string;
+    desc: boolean;
+}
+
+export declare interface SortMenuValue<T extends string = string> {
+    by: T;
+    desc: boolean;
+}
+
 /**
  * Splits combined Filter objects by their scope and removes the scope prefix from filter IDs.
  * Used to separate multi-scope Filter arrays back into individual scope Filter arrays.

package/dist/types/context.d.ts

@@ -983,7 +983,7 @@ export declare type PowerpackDialogType = {
     icon?: string;
 };
 
-export declare type PowerpackFeature = 'slicer' | 'annotations' | 'releases' | 'advancedFilters' | 'listAttributes' | 'listFolders' | 'listAccess' | 'groupAttributes' | 'sharedViews' | 'commentCategories' | 'projectFolders' | 'columnSummaries' | 'entityLinks';
+export declare type PowerpackFeature = 'slicer' | 'annotations' | 'releases' | 'advancedFilters' | 'listAttributes' | 'listFolders' | 'listAccess' | 'groupAttributes' | 'sharedViews' | 'commentCategories' | 'projectFolders' | 'columnSummaries' | 'listValues' | 'entityLinks' | 'tableExport';
 
 export declare const powerpackFeatureOrder: PowerpackFeature[];
 
@@ -1646,7 +1646,7 @@ declare interface SubtasksManagerProps extends Omit<React.HTMLAttributes<HTMLDiv
 export declare const SubtasksModulesContext: Context<SubtasksModulesContextType | undefined>;
 
 export declare interface SubtasksModulesContextType {
-    SubtasksManager: typeof SubtasksManagerFallback;
+    SubtasksManager?: typeof SubtasksManagerFallback;
     requiredVersion: string | undefined;
     isLoading: boolean;
 }
@@ -1655,6 +1655,98 @@ export declare const SubtasksModulesProvider: FC<{
     children: ReactNode;
 }>;
 
+export declare const TABLE_EXPORT_SEARCH_PARAM = "tableExport";
+
+export declare type TableExportContent = TableExportRows & {
+    columns: string[];
+    columnLabels: Record<string, string>;
+};
+
+export declare const TableExportContext: Context<TableExportContextType | null>;
+
+export declare type TableExportContextType = {
+    source: TableExportSource | null;
+    isAvailable: boolean;
+    openExport: (scope: TableExportScope) => void;
+    registerSource: (source: TableExportSource) => () => void;
+};
+
+export declare type TableExportListQuery = {
+    id: string;
+    itemIds?: string[];
+    filter?: string;
+    search?: string;
+    sortBy?: string[];
+};
+
+export declare type TableExportOptions = {
+    includeImportColumns: boolean;
+    selectionColumns: 'selected' | 'visible';
+    format?: 'xlsx' | 'csv';
+    content?: 'readable' | 'raw';
+};
+
+export declare type TableExportProductsQuery = {
+    ids?: string[];
+    folderIds?: string[];
+    includeFolderChildren?: boolean;
+    filter?: string;
+    folderFilter?: string;
+    versionFilter?: string;
+    taskFilter?: string;
+    representationFilter?: string;
+    sortBy?: string[];
+    featuredVersionOrder?: string[];
+};
+
+export declare const TableExportProvider: ({ children }: {
+    children: ReactNode;
+}) => JSX_2.Element;
+
+export declare type TableExportRows = {
+    folderIds?: string[];
+    tasks?: TableExportTasksQuery;
+    products?: TableExportProductsQuery;
+    versions?: TableExportVersionsQuery;
+    entityList?: TableExportListQuery;
+};
+
+export declare type TableExportScope = 'table' | 'selection';
+
+export declare type TableExportSource = {
+    projectName: string;
+    canImport: boolean;
+    selectedRowsCount: number;
+    getContent: (scope: TableExportScope, options: TableExportOptions) => TableExportContent;
+    getSkippedColumns: (scope: TableExportScope, options: TableExportOptions) => string[];
+};
+
+export declare type TableExportTasksQuery = {
+    ids?: string[];
+    folderIds?: string[];
+    includeFolderChildren?: boolean;
+    filter?: string;
+    folderFilter?: string;
+    search?: string;
+    sortBy?: string[];
+};
+
+export declare type TableExportVersionsQuery = {
+    ids?: string[];
+    productIds?: string[];
+    folderIds?: string[];
+    includeFolderChildren?: boolean;
+    filter?: string;
+    folderFilter?: string;
+    productFilter?: string;
+    taskFilter?: string;
+    representationFilter?: string;
+    featuredOnly?: string[];
+    latestPerFolder?: boolean;
+    hasReviewables?: boolean;
+    sortBy?: string[];
+};
+
 export declare const TABS_BY_SCOPE_KEY = "details/tabs-by-scope";
 
 export declare interface TabStateByScope {
@@ -1988,6 +2080,8 @@ declare type UseSyncUpdatesParams = {
     shouldSyncOnUpdate?: (update: RTEntityUpdate) => boolean;
 };
 
+export declare const useTableExportContext: () => TableExportContextType | null;
+
 export declare const useThumbnailUploadContext: () => {
     resetFileUploadState?: Function;
     triggerThumbnailUpload?: () => void;

package/dist/types/hooks.d.ts

@@ -204,6 +204,24 @@ declare type EnumItem = {
     hidden?: boolean;
 };
 
+declare interface EnumItemDialogProps {
+    item?: EnumItemDraft;
+    isNew?: boolean;
+    fields: EnumItemField[];
+    itemLabel?: string;
+    onSave: (item: EnumItemDraft) => void;
+    onCancel: () => void;
+}
+
+declare interface EnumItemDraft {
+    value: string;
+    label?: string;
+    icon?: string;
+    color?: string;
+}
+
+declare type EnumItemField = 'label' | 'icon' | 'color';
+
 export declare type FetchAttributeEnumOptions = (data: AttributeData, projectName?: string) => Promise<EnumItem[]>;
 
 declare type FilesystemSourceInfo = {
@@ -505,11 +523,28 @@ export declare interface UseAttributeEnumsParams {
     request?: AttributeEnumsRequest;
 }
 
+/**
+ * Edits the project anatomy's tags from a tags dropdown: new tags saved on entities are added to
+ * it, and a dialog (render `dialog` with EnumItemDialog) creates a tag with a colour or changes a
+ * tag's colour. Undefined when the user can't change the project (managers and admins can), or
+ * without a project.
+ */
+export declare const useEditProjectTags: (projectName: string | undefined, anatomyTags?: {
+    name: string;
+}[]) => {
+    onEditOption: (tag: {
+        name?: string;
+        color?: string;
+    }, isNew: boolean) => Promise<string | undefined>;
+    dialog: EnumItemDialogProps;
+    addTags: (names: string[]) => void;
+} | undefined;
+
 /**
  * Hook for updating entities with proper error handling and version-specific logic
  */
 export declare const useEntityUpdate: ({ entities, entityType }: UseEntityUpdateParams) => {
-    updateEntity: (field: string, value: any) => Promise<void>;
+    updateEntity: (field: string, value: any | ((entityId: string) => any)) => Promise<void>;
 };
 
 export declare interface UseEntityUpdateParams {

package/dist/types/util.d.ts

@@ -352,6 +352,8 @@ declare type CustomTemplate = {
 
 declare type DataType = 'string' | 'list_of_strings' | string;
 
+export declare const DEFAULT_LISTS_SORT: ListsSort;
+
 declare type DefaultProductBaseType = {
     color?: string;
     icon?: string;
@@ -431,10 +433,15 @@ declare type EnumItem_2 = {
     /** Icon name (material symbol) or IconModel object */
     icon?: string | IconModel_2;
     color?: string;
+    shortName?: string;
     /** Enum item is visible, but not selectable */
     disabled?: boolean;
     /** Message to show when the option is disabled */
     disabledMessage?: string;
+    /** Enum item is not visible in the dropdown */
+    hidden?: boolean;
+    /** Extra badge labels to display next to the item */
+    badges?: string[];
 };
 
 declare type EnumItem_3 = {
@@ -492,6 +499,8 @@ export declare const extractEntityHierarchyFromParents: (parents: string[], enti
  */
 export declare function extractVersionFromFilename(filename: string): number | null;
 
+export declare const filterBySearchQuery: <T>(items: T[], query: string, toHaystack: (item: T) => string) => T[];
+
 /**
  * Result of building a folder hierarchy
  */
@@ -577,6 +586,12 @@ export declare const getEnumItemIcon: (icon: EnumItem_4["icon"]) => string | und
  */
 export declare const getErrorMessage: (error: unknown, prefix: string) => string;
 
+/**
+ * The `sortBy` of `buildSortArgs` for a query read forwards (`first`/`after`), where every
+ * key carries its own direction.
+ */
+export declare const getForwardSortBy: ({ sortBy, desc }: SortArgs) => string[] | undefined;
+
 /**
  * Determines the data type for a groupBy field.
  * Handles special cases for built-in group types (assignees, tags) and attribute-based grouping.
@@ -593,6 +608,11 @@ export declare const getErrorMessage: (error: unknown, prefix: string) => string
  */
 export declare const getGroupByDataType: (groupBy: TableGroupBy | undefined, attribFields: (ProjectTableAttribute | AttributeModel)[]) => DataType;
 
+export declare const getListIcon: (list: {
+    entityListType: string;
+    entityType: string;
+}) => string;
+
 export declare const getMixedState: (values: any[]) => {
     value: any;
     isMixed: boolean;
@@ -769,6 +789,8 @@ export declare enum KeyMode {
     Shift = "shift"
 }
 
+export declare const labelCollator: Intl.Collator;
+
 declare type LinkType = {
     link_type: string;
     input_type: 'folder' | 'product' | 'version' | 'representation' | 'task' | 'workfile';
@@ -777,6 +799,19 @@ declare type LinkType = {
     style?: 'solid' | 'dashed';
 };
 
+export declare const LISTS_SORT_OPTIONS: {
+    id: ListsSortBy;
+    label: string;
+    desc: boolean;
+}[];
+
+export declare interface ListsSort {
+    by: ListsSortBy;
+    desc: boolean;
+}
+
+export declare type ListsSortBy = 'createdAt' | 'updatedAt' | 'label';
+
 declare type MainCalc = 'count' | 'breakdown';
 
 export declare const matchSearchQuery: (haystack: string, groups: string[][]) => RankingInfo;
@@ -953,6 +988,8 @@ export declare type RealtimeBatchProcessor<T> = (items: T[], isActive: () => boo
 
 export declare const replaceRoot: (input?: string | null, roots?: Record<string, string | undefined>) => string | undefined;
 
+export declare const resolveListsSort: (sort: unknown) => ListsSort;
+
 /**
  * Convert RGB components to hex color string
  */
@@ -982,6 +1019,14 @@ export declare const sanitizeProductName: (name: string) => string;
 
 declare type ScopeEntityType = 'folder' | 'product' | 'version' | 'representation' | 'task' | 'workfile' | 'project' | 'user';
 
+export declare const searchQueryToFilter: <C>(query: string, toCondition: (term: string) => C) => {
+    operator: "or";
+    conditions: {
+        operator: "and";
+        conditions: C[];
+    }[];
+} | null;
+
 /**
  * Writes the sorting of a view, see `parseViewSorting` for the format.
  * No sorting is `undefined` so the view falls back to its default order.
@@ -1026,6 +1071,13 @@ declare type SimpleTableRow = {
     badge?: string | React.ReactNode;
 };
 
+declare interface SortableList {
+    label: string;
+    active: boolean;
+    createdAt?: unknown;
+    updatedAt?: unknown;
+}
+
 export declare type SortArgs = {
     sortBy: string | string[] | undefined;
     desc: boolean;
@@ -1038,6 +1090,8 @@ export declare type SortKey = {
 
 export declare const sortKeysDeep: (value: unknown) => unknown;
 
+export declare const sortLists: <T extends SortableList>(lists: T[], { by, desc }?: ListsSort) => T[];
+
 declare type StagingDirectory = {
     name: string;
     directory?: string;