@ynput/ayon-frontend-shared 0.7.3 → 0.7.5

package/dist/types/ProjectsTable.d.ts

@@ -0,0 +1,228 @@
+import { default as default_2 } from 'react';
+import { Dispatch } from 'react';
+import { ExpandedState } from '@tanstack/react-table';
+import { FC } from 'react';
+import { RefObject } from 'react';
+import { Row } from '@tanstack/react-table';
+import { RowPinningState } from '@tanstack/react-table';
+import { RowSelectionState } from '@tanstack/react-table';
+import { SetStateAction } from 'react';
+
+export declare const buildProjectFolderRowId: (folderId: string) => string;
+
+export declare const buildProjectsTableData: (projects?: ListProjectsItemModel[], folders?: ProjectFolderModel[], showEmptyFolders?: boolean, powerLicense?: boolean) => SimpleTableRow[];
+
+declare type ButtonType = 'delete' | 'add' | 'filter' | 'search' | 'select-all';
+
+declare interface CommandEvent {
+    originalEvent: default_2.MouseEvent;
+    item: {
+        label: string;
+        command: (event: CommandEvent) => void;
+        shortcut?: string;
+    };
+}
+
+declare interface ContextMenuItemProps {
+    icon?: string;
+    iconFilled?: boolean;
+    label?: string;
+    shortcut?: string;
+    command?: (event: CommandEvent) => void;
+    children?: default_2.ReactNode;
+    contextMenuRef: RefObject<{
+        hide: () => void;
+    }>;
+    disabled?: boolean;
+    hidden?: boolean;
+    items?: any[];
+    isSave?: boolean;
+    danger?: boolean;
+    developer?: boolean;
+    style?: default_2.CSSProperties;
+    powerFeature?: PowerpackFeature;
+    powerLicense?: boolean;
+    onPowerClick?: (feature: PowerpackFeature) => void;
+    [key: string]: any;
+}
+
+declare interface ContextMenuItemType extends Omit<ContextMenuItemProps, 'contextMenuRef'> {
+    items?: ContextMenuItemType[];
+    template?: React.ReactNode;
+    [key: string]: any;
+}
+
+declare type ListProjectsItemModel = {
+    name: string;
+    code: string;
+    label?: string;
+    color?: string;
+    active?: boolean;
+    library?: boolean;
+    skeleton?: boolean;
+    pinned?: boolean;
+    projectFolder?: string;
+    createdAt: string;
+    updatedAt: string;
+};
+
+export declare const parseProjectFolderRowId: (rowId: string) => string | null;
+
+declare type PowerpackFeature = 'slicer' | 'annotations' | 'releases' | 'advancedFilters' | 'listAttributes' | 'listFolders' | 'listAccess' | 'groupAttributes' | 'sharedViews' | 'commentCategories' | 'projectFolders' | 'columnSummaries' | 'listValues' | 'entityLinks' | 'tableExport';
+
+export declare const PROJECT_FOLDER_ROW_ID_PREFIX = "folder";
+
+declare type ProjectFolderData = {
+    /** Hex color code */
+    color?: string;
+    /** Icon name */
+    icon?: string;
+};
+
+declare type ProjectFolderModel = {
+    id: string;
+    label: string;
+    parentId?: string;
+    position?: number;
+    isEmpty?: boolean;
+    data?: ProjectFolderData;
+};
+
+export declare const PROJECTS_LIST_MENU_ID = "projects-list-menu";
+
+export declare const ProjectsTable: FC<ProjectsTableProps>;
+
+export declare interface ProjectsTableProps {
+    data: SimpleTableRow[];
+    isLoading?: boolean;
+    error?: string | undefined;
+    search?: string | undefined;
+    onSearch?: (search: string | undefined) => void;
+    rowSelection?: RowSelectionState;
+    onRowSelectionChange?: (newSelection: RowSelectionState) => void;
+    rowPinning: string[];
+    onRowPinningChange?: (pinning: RowPinningState) => void;
+    expanded: ExpandedState;
+    setExpanded: Dispatch<SetStateAction<ExpandedState>>;
+    multiSelect?: boolean;
+    readonly?: boolean;
+    buildMenuItems?: (selection: string[], options?: any) => any[];
+    rowContextMenuBuilders?: SimpleTableRowContextMenuBuilder[];
+    selection: string[];
+    onSelect?: (ids: string[]) => void;
+    onOpenProject?: (projectName: string) => void;
+    onSettingsClick?: (projectId: string) => void;
+    title?: string;
+    showAddProject?: boolean;
+    onNewProject?: () => void;
+    toggleMenu?: (open?: boolean) => void;
+    onSelectAll?: () => void;
+    hiddenButtons?: ButtonType[];
+    renamingFolder?: string | null;
+    onSubmitRenameFolder?: (value: string) => void;
+    closeRenameFolder?: () => void;
+    renamingProject?: string | null;
+    onSubmitRenameProject?: (value: string) => void;
+    closeRenameProject?: () => void;
+    onRenameFolder?: (folderId: string) => void;
+    onRenameProject?: (projectName: string) => void;
+    containerClassName?: string;
+    enableClickToDeselect?: boolean;
+    pt?: {
+        container?: React.HTMLAttributes<HTMLDivElement>;
+    };
+}
+
+declare type RowItemData = {
+    id: string;
+    name?: string | null;
+    label?: string | null;
+    subType?: string | null;
+    [key: string]: any;
+};
+
+declare type SimpleTableRow = {
+    id: string;
+    parentId?: string;
+    name: string;
+    label: string;
+    parents?: string[];
+    icon?: string | null;
+    iconColor?: string;
+    iconFilled?: boolean;
+    img?: string | null;
+    imgShape?: 'square' | 'circle';
+    startContent?: JSX.Element;
+    endContent?: JSX.Element;
+    subRows: SimpleTableRow[];
+    data: RowItemData;
+    isDisabled?: boolean;
+    disabledMessage?: string;
+    inactive?: boolean;
+    badge?: string | React.ReactNode;
+};
+
+declare type SimpleTableRowContextMenuBuilder = (e: React.MouseEvent<HTMLTableRowElement>, context: SimpleTableRowContextMenuContext) => ContextMenuItemType | ContextMenuItemType[] | undefined;
+
+declare type SimpleTableRowContextMenuContext = {
+    rowId: string;
+    rowIndex: number;
+    row: Row<SimpleTableRow>;
+    selectedRows: string[];
+    selectedTableRows: Row<SimpleTableRow>[];
+    isSelected: boolean;
+};
+
+export { }
+
+
+declare module '@tanstack/react-table' {
+    interface ColumnMeta<TData extends RowData, TValue> {
+        addonColumn?: AddonColumnMeta;
+    }
+    interface TableMeta<TData extends RowData> {
+        options?: BuiltInFieldOptions;
+        readOnly?: ProjectTreeTableProps['readOnly'];
+        projectName?: string;
+        updateEntities?: CellUpdate;
+        toggleExpandAll?: ToggleExpandAll;
+        selection?: string[];
+        columnsConfig?: ColumnsConfig;
+        loadingLinksEntityIds?: Set<string>;
+    }
+}
+
+
+declare module '@tanstack/react-table' {
+    interface FilterFns {
+        fuzzy: (row: Row<any>, columnId: string, searchValue: string[][], addMeta: (meta: any) => void) => boolean;
+    }
+    interface FilterMeta {
+        itemRank: RankingInfo;
+    }
+    interface TableMeta<TData extends RowData> {
+        isExpandable?: boolean;
+        isLoading?: boolean;
+        children?: (props: SimpleTableCellTemplateProps, row: Row<TData>, table: Table<SimpleTableRow>) => JSX.Element;
+        [key: string]: any;
+    }
+}
+
+
+declare global {
+    interface Window {
+        senderId: string;
+    }
+}
+
+
+declare module '@tanstack/react-table' {
+    interface ColumnMeta<TData extends RowData, TValue> {
+        listTableCustomCell?: boolean;
+        editable?: boolean;
+    }
+    interface TableMeta<TData extends RowData> {
+        updateData: (columnId: string, value: unknown, rowId: string) => void;
+        openViewerDialog?: (row: TData) => void;
+    }
+}

package/dist/types/RepresentationsList.d.ts

@@ -145,6 +145,9 @@ export { }
 
 
 declare module '@tanstack/react-table' {
+    interface ColumnMeta<TData extends RowData, TValue> {
+        addonColumn?: AddonColumnMeta;
+    }
     interface TableMeta<TData extends RowData> {
         options?: BuiltInFieldOptions;
         readOnly?: ProjectTreeTableProps['readOnly'];

package/dist/types/SimpleTable.d.ts

@@ -80,6 +80,9 @@ export declare const HeaderButton: IStyledComponentBase<"web", FastOmit<Omit< Bu
 
 declare type PowerpackFeature = 'slicer' | 'annotations' | 'releases' | 'advancedFilters' | 'listAttributes' | 'listFolders' | 'listAccess' | 'groupAttributes' | 'sharedViews' | 'commentCategories' | 'projectFolders' | 'columnSummaries' | 'listValues' | 'entityLinks' | 'tableExport';
 
+/** The project pages with a project table (ProjectTreeTable). */
+declare type ProjectTablePage = 'overview' | 'products' | 'lists'
+
 export declare const RowExpander: ({ isRowExpandable, isRowExpanded, enableNonFolderIndent, isTableExpandable, onExpandClick, }: RowExpanderProps) => false | JSX_2.Element | undefined;
 
 export declare type RowExpanderProps = {
@@ -98,6 +101,13 @@ export declare type RowItemData = {
     [key: string]: any;
 };
 
+/**
+ * A table with addon shortcuts: the project tables (`overview`, `products`, `lists`) and the
+ * panels' tables: the slicer, the project list, the Lists page's lists and the Products page's
+ * versions.
+ */
+declare type ShortcutTable = ProjectTablePage | 'slicer' | 'projects' | 'listsPanel' | 'versionsPanel'
+
 declare const SimpleTable: FC<SimpleTableProps>;
 export default SimpleTable;
 
@@ -181,6 +191,10 @@ export declare interface SimpleTableProps extends Omit<React.HTMLAttributes<HTML
     fitContent?: boolean;
     rowIdPrefix?: string;
     rowContextMenuBuilders?: SimpleTableRowContextMenuBuilder[];
+    addonShortcuts?: {
+        table: ShortcutTable;
+        projectName: string | null;
+    };
     children?: (props: SimpleTableCellTemplateProps, row: Row<SimpleTableRow>, table: Table<SimpleTableRow>) => JSX.Element;
     pt?: {
         cell?: Partial<SimpleTableCellTemplateProps>;
@@ -247,6 +261,9 @@ export { }
 
 
 declare module '@tanstack/react-table' {
+    interface ColumnMeta<TData extends RowData, TValue> {
+        addonColumn?: AddonColumnMeta;
+    }
     interface TableMeta<TData extends RowData> {
         options?: BuiltInFieldOptions;
         readOnly?: ProjectTreeTableProps['readOnly'];

package/dist/types/Slicer.d.ts

@@ -821,6 +821,7 @@ declare interface UseFiltersWithHierarchyProps {
 
 export declare const useHierarchyContextMenuItems: (onAddToList?: OnAddToList, entityMap?: SliceMap, onOpenViewer?: OnOpenViewer, openMoveDialog?: OpenMoveDialog) => {
     rowContextMenuBuilders: SimpleTableRowContextMenuBuilder[];
+    deleteContextMenuBuilder: SimpleTableRowContextMenuBuilder;
     onOptionClick: (row: SimpleTableRow, selectedRows?: string[]) => void;
     onRename: (row: SimpleTableRow) => void;
     renamingRow: SimpleTableRow | null;
@@ -957,6 +958,9 @@ export { }
 
 
 declare module '@tanstack/react-table' {
+    interface ColumnMeta<TData extends RowData, TValue> {
+        addonColumn?: AddonColumnMeta;
+    }
     interface TableMeta<TData extends RowData> {
         options?: BuiltInFieldOptions;
         readOnly?: ProjectTreeTableProps['readOnly'];

package/dist/types/Views.d.ts

@@ -984,6 +984,9 @@ export { }
 
 
 declare module '@tanstack/react-table' {
+    interface ColumnMeta<TData extends RowData, TValue> {
+        addonColumn?: AddonColumnMeta;
+    }
     interface TableMeta<TData extends RowData> {
         options?: BuiltInFieldOptions;
         readOnly?: ProjectTreeTableProps['readOnly'];

package/dist/types/api.d.ts

@@ -75130,6 +75130,9 @@ export { }
 
 
 declare module '@tanstack/react-table' {
+    interface ColumnMeta<TData extends RowData, TValue> {
+        addonColumn?: AddonColumnMeta;
+    }
     interface TableMeta<TData extends RowData> {
         options?: BuiltInFieldOptions;
         readOnly?: ProjectTreeTableProps['readOnly'];