@ynput/ayon-frontend-shared 0.6.3 → 0.6.5

package/dist/types/components.d.ts

@@ -136,6 +136,21 @@ declare type AddColumnItem = SettingsPanelItem & {
     parentScope?: EntityType;
 };
 
+declare type AddLinks = (links: {
+    targetEntityId: string;
+    linkId: string;
+}[], addToHistory?: boolean) => Promise<boolean>;
+
+export declare const AddNewLinks: FC<AddNewLinksProps>;
+
+declare interface AddNewLinksProps {
+    targetEntityType: string;
+    projectName: string;
+    onClose?: () => void;
+    onSearchTypeChange: (type: LinkSearchType) => void;
+    onAdd?: (targetEntityId: string, linkType?: string) => void;
+}
+
 export declare const AddonLoadingScreen: FC<ReportsLoadingScreenProps>;
 
 declare type AlignType = 'left' | 'right';
@@ -509,7 +524,7 @@ declare interface CustomDateRangeDialogProps {
     onClose: () => void;
 }
 
-export declare const CustomizeButton: ({ defaultSelected, className, ...props }: Props) => JSX_2.Element;
+export declare const CustomizeButton: ({ defaultSelected, className, ...props }: Props_2) => JSX_2.Element;
 
 export declare const customRangeOption: Option_2 & {
     id: typeof CUSTOM_RANGE_ID;
@@ -967,7 +982,7 @@ declare type EntityData = Record<string, unknown> & {
     };
 };
 
-export declare const EntityIcon: ({ entity, icon, color, ...props }: Props_2) => JSX_2.Element;
+export declare const EntityIcon: ({ entity, icon, color, ...props }: Props_3) => JSX_2.Element;
 
 declare type EntityIdResponse_10 = {
     /** Entity ID */
@@ -1565,6 +1580,21 @@ declare interface GridConfig {
 
 export declare const GROUP_KEY_PREFIX = "group:";
 
+export declare type GroupedLink = {
+    groupKey: string;
+    entityId: string;
+    count: number;
+    linkIds: string[];
+    representative: LinkEntity;
+};
+
+/**
+ * Groups links by entityId. Restricted links are never grouped
+ * (we can't verify they're the same entity), each gets its own group.
+ * Preserves sort order of first occurrence.
+ */
+export declare const groupLinksByEntity: (links: LinkEntity[]) => GroupedLink[];
+
 export declare const GUEST_KEY_PREFIX = "guest:";
 
 export declare interface HeightSliderProps {
@@ -1682,8 +1712,11 @@ export declare interface LinkManagerItemProps {
     onRemove: (e: React.MouseEvent<HTMLButtonElement>, link: LinkEntity) => void;
     onCountChange?: (newCount: number) => void;
     isManager?: boolean;
+    readOnly?: boolean;
 }
 
+export declare type LinkSearchType = 'search' | 'picker' | null;
+
 export declare const LinksManager: FC<LinksManagerProps>;
 
 export declare interface LinksManagerDialogProps {
@@ -1752,7 +1785,7 @@ declare interface ListMetaDataProps {
 
 declare type ListsSettings = {
     rowHeight?: number;
-    sortBy?: string;
+    sortBy?: string | string[];
     sortDesc?: boolean;
     filter?: QueryFilter_5;
     columns?: ColumnItemModel[];
@@ -1917,7 +1950,7 @@ declare type OverviewSettings = {
     groupBy?: string;
     groupSortByDesc?: boolean;
     showEmptyGroups?: boolean;
-    sortBy?: string;
+    sortBy?: string | string[];
     sortDesc?: boolean;
     filter?: QueryFilter_5;
     folderFilter?: QueryFilter_5;
@@ -2028,7 +2061,7 @@ declare type PowerpackDialogType = {
     icon?: string;
 };
 
-declare type PowerpackFeature = 'slicer' | 'annotations' | 'releases' | 'advancedFilters' | 'listAttributes' | 'listFolders' | 'listAccess' | 'groupAttributes' | 'sharedViews' | 'commentCategories' | 'projectFolders' | 'columnSummaries';
+declare type PowerpackFeature = 'slicer' | 'annotations' | 'releases' | 'advancedFilters' | 'listAttributes' | 'listFolders' | 'listAccess' | 'groupAttributes' | 'sharedViews' | 'commentCategories' | 'projectFolders' | 'columnSummaries' | 'entityLinks';
 
 declare interface Processing extends ReviewableProcessingStatus {
     progress?: number;
@@ -2187,11 +2220,20 @@ export declare type ProjectTableSettingsProps = {
     columnIdAliases?: ColumnIdAliases;
 };
 
-declare interface Props extends ButtonProps {
+declare type Props = {
+    projectName: string;
+    entityId: string;
+    entityType: string;
+    targetEntityType: string;
+    linkType: string;
+    direction?: 'in' | 'out';
+};
+
+declare interface Props_2 extends ButtonProps {
     defaultSelected?: string | null;
 }
 
-declare interface Props_2 extends Partial<IconProps> {
+declare interface Props_3 extends Partial<IconProps> {
     entity: {
         entityType: string;
         subType?: string;
@@ -2279,6 +2321,14 @@ export declare interface RemotePageWrapperProps {
     }) => void;
 }
 
+declare type RemoveLinks = (links: {
+    id: string;
+    target: {
+        entityId: string;
+        entityType: string;
+    };
+}[], addToHistory?: boolean) => Promise<void>;
+
 export declare interface ReportsLoadingScreenProps extends HTMLAttributes<HTMLDivElement> {
     showSidebar?: boolean;
     sidebarConfig?: SidebarConfig;
@@ -2437,7 +2487,7 @@ export declare interface ReviewableUploadProps extends React.HTMLProps<HTMLDivEl
 
 declare type ReviewsSettings = {
     rowHeight?: number;
-    sortBy?: string;
+    sortBy?: string | string[];
     sortDesc?: boolean;
     filter?: QueryFilter_5;
     columns?: ColumnItemModel[];
@@ -3211,6 +3261,11 @@ declare type UserModel = {
     updatedAt?: string;
 };
 
+export declare const useUpdateLinks: ({ projectName, direction, entityId, entityType, targetEntityType, linkType, }: Props) => {
+    remove: RemoveLinks;
+    add: AddLinks;
+};
+
 declare const useUpdateSubtasksMutation: <R extends Record<string, any> = ({
     requestId?: undefined;
     status: QueryStatus.uninitialized;
@@ -3414,7 +3469,7 @@ declare type VersionsSettings = {
     groupSortByDesc?: boolean;
     showEmptyGroups?: boolean;
     latestPerFolder?: boolean;
-    sortBy?: string;
+    sortBy?: string | string[];
     sortDesc?: boolean;
     filter?: QueryFilter_5;
     columns?: ColumnItemModel[];

package/dist/types/context.d.ts

@@ -792,7 +792,7 @@ declare type ListProjectsItemModel = {
 
 declare type ListsSettings = {
     rowHeight?: number;
-    sortBy?: string;
+    sortBy?: string | string[];
     sortDesc?: boolean;
     filter?: QueryFilter_5;
     columns?: ColumnItemModel[];
@@ -885,7 +885,7 @@ declare type OverviewSettings = {
     groupBy?: string;
     groupSortByDesc?: boolean;
     showEmptyGroups?: boolean;
-    sortBy?: string;
+    sortBy?: string | string[];
     sortDesc?: boolean;
     filter?: QueryFilter_5;
     folderFilter?: QueryFilter_5;
@@ -982,7 +982,7 @@ export declare type PowerpackDialogType = {
     icon?: string;
 };
 
-export declare type PowerpackFeature = 'slicer' | 'annotations' | 'releases' | 'advancedFilters' | 'listAttributes' | 'listFolders' | 'listAccess' | 'groupAttributes' | 'sharedViews' | 'commentCategories' | 'projectFolders' | 'columnSummaries';
+export declare type PowerpackFeature = 'slicer' | 'annotations' | 'releases' | 'advancedFilters' | 'listAttributes' | 'listFolders' | 'listAccess' | 'groupAttributes' | 'sharedViews' | 'commentCategories' | 'projectFolders' | 'columnSummaries' | 'entityLinks';
 
 export declare const powerpackFeatureOrder: PowerpackFeature[];
 
@@ -1352,7 +1352,7 @@ declare type ResolvedUriModel = {
 
 declare type ReviewsSettings = {
     rowHeight?: number;
-    sortBy?: string;
+    sortBy?: string | string[];
     sortDesc?: boolean;
     filter?: QueryFilter_5;
     columns?: ColumnItemModel[];
@@ -2198,7 +2198,7 @@ declare type VersionsSettings = {
     groupSortByDesc?: boolean;
     showEmptyGroups?: boolean;
     latestPerFolder?: boolean;
-    sortBy?: string;
+    sortBy?: string | string[];
     sortDesc?: boolean;
     filter?: QueryFilter_5;
     columns?: ColumnItemModel[];

package/dist/types/util.d.ts

@@ -10,6 +10,40 @@ import { VisibilityState } from '@tanstack/react-table';
 
 declare type AcceptedParams = Record<string, unknown> | undefined | null;
 
+export declare const ACTIVE_ENTITIES_PRIORITY: {
+    readonly page: 0;
+    readonly detailsPanel: 1;
+    readonly slideOut: 2;
+};
+
+export declare type ActiveEntity = {
+    id: string;
+    entityType: string;
+    projectName: string;
+};
+
+declare type Anatomy = {
+    /** Settings for automatic entity name generation */
+    entity_naming?: EntityNaming;
+    /** Setup root paths for the project */
+    roots?: Root[];
+    /** Path templates configuration */
+    templates?: Templates;
+    /** Attributes configuration */
+    attributes?: ProjectAttribModel;
+    /** Folder types configuration */
+    folder_types?: FolderType[];
+    /** Task types configuration */
+    task_types?: TaskType[];
+    /** Link types configuration */
+    link_types?: LinkType[];
+    /** Statuses configuration */
+    statuses?: Status[];
+    /** Tags configuration */
+    tags?: Tag[];
+    product_base_types?: ProductBaseTypes;
+};
+
 declare type AttributeData = {
     /** Type of attribute value */
     type?: 'string' | 'integer' | 'float' | 'boolean' | 'datetime' | 'list_of_strings' | 'list_of_integers' | 'list_of_any' | 'list_of_submodels' | 'dict';
@@ -194,6 +228,17 @@ export declare interface BuildHierarchicalRowsConfig<TFolder, TItem> {
  */
 export declare const buildHierarchicalTableRows: <TFolder, TItem>(config: BuildHierarchicalRowsConfig<TFolder, TItem>) => SimpleTableRow[];
 
+/**
+ * Builds the `sortBy` and `desc` arguments of the paginated entity queries.
+ *
+ * `desc` is the direction of the first key. The queries page a descending sort
+ * backwards (`last`/`before`), which reverses the whole ordering on the
+ * backend, so the other keys are prefixed with `-` when their direction differs
+ * from the first key rather than when they are descending.
+ * A single key is sent as a plain string, exactly as before multi-key sorting.
+ */
+export declare const buildSortArgs: (keys: SortKey[]) => SortArgs;
+
 export declare type BundleMode = 'production' | 'staging' | 'developer';
 
 export declare const checkLabel: (label?: string | null) => CheckNameResult;
@@ -205,6 +250,8 @@ export declare interface CheckNameResult {
     error?: string;
 }
 
+export declare const clearActiveEntities: (key: string) => void;
+
 declare type ColumnItemModel = {
     name: string;
     visible?: boolean;
@@ -288,8 +335,18 @@ export declare function createRealtimeBatcher<T>(onBatch: RealtimeBatchProcessor
  */
 export declare const createVersionHelper: (createVersionMutation: any, projectName: string, versionData: VersionCreationData) => Promise<any>;
 
+declare type CustomTemplate = {
+    name: string;
+    value?: string;
+};
+
 declare type DataType = 'string' | 'list_of_strings' | string;
 
+declare type DefaultProductBaseType = {
+    color?: string;
+    icon?: string;
+};
+
 /**
  * Configuration for delete folder operation
  */
@@ -302,6 +359,12 @@ export declare interface DeleteFolderConfig<T extends FolderWithLabel> {
     messageDetail?: string;
 }
 
+declare type DeliveryTemplate = {
+    name: string;
+    directory: string;
+    file: string;
+};
+
 declare type EntityNaming = {
     /** How to capitalize the entity names */
     capitalization?: 'lower' | 'upper' | 'keep' | 'pascal' | 'camel';
@@ -309,6 +372,13 @@ declare type EntityNaming = {
     separator?: '' | '_' | '-' | '.';
 };
 
+declare type EntityNaming_2 = {
+    /** How to capitalize the entity names */
+    capitalization?: 'lower' | 'upper' | 'keep' | 'pascal' | 'camel';
+    /** Character to separate different parts of the name */
+    separator?: '' | '_' | '-' | '.';
+};
+
 export declare const entityTypesWithIcons: string[];
 
 declare type EntityUri = {
@@ -420,6 +490,14 @@ export declare interface FolderHierarchyResult<T extends HierarchicalFolder> {
     rootFolders: FolderWithChildren<T>[];
 }
 
+declare type FolderType = {
+    name: string;
+    original_name?: string;
+    shortName?: string;
+    color?: string;
+    icon?: string;
+};
+
 /**
  * Folder with children array attached
  */
@@ -435,6 +513,8 @@ export declare interface FolderWithLabel {
     label?: string;
 }
 
+export declare const getActiveEntities: () => ActiveEntity[];
+
 export declare const getAttributeIcon: GetAttributesIcon;
 
 declare type GetAttributesIcon = (name: string, type?: AttributeData_2['type'], hasEnum?: boolean) => string;
@@ -443,6 +523,10 @@ export declare const getBundleModeFromUser: (user: UserModel | undefined) => Bun
 
 export declare const getCurrentPlatform: () => "other" | "windows" | "linux" | "darwin";
 
+export declare const getEntityColor: (entityType: string, subType: string | undefined, anatomy: IconAnatomy) => string | undefined;
+
+export declare const getEntityIcon: (entityType: string, subType: string | undefined, anatomy: IconAnatomy) => string;
+
 export declare const getEntityId: () => string;
 
 export declare const getEntityStateFromUri: (uri: string) => EntityUri;
@@ -513,6 +597,9 @@ export declare const getNextVersionNumber: (existingVersion?: {
 
 export declare const getPlatformShortcutKey: (key: string, modes: KeyMode[], prefix?: string) => string;
 
+/** The first key of a `sortBy` argument, without its direction prefix. */
+export declare const getPrimarySortKey: (sortBy?: string | string[] | null) => string | undefined;
+
 export declare const getPriorityOptions: (priority: AttributeModel | undefined, type: ScopeEntityType) => EnumItem_2[] | undefined;
 
 export declare const getProjectDisplayName: (project: ProjectLike | null | undefined) => string;
@@ -577,6 +664,12 @@ export declare const hasEnumOptions: (data: EnumSource) => boolean;
 
 export declare const hasEnumResolver: (data: EnumSource) => boolean;
 
+declare type HeroTemplate = {
+    name: string;
+    directory: string;
+    file: string;
+};
+
 /**
  * Parse a hex color string to RGB components
  */
@@ -612,6 +705,8 @@ export declare interface HierarchicalFolderNode<TFolder, TItem> {
 
 export declare function humanizeField(input: string): string;
 
+export declare type IconAnatomy = Pick<Anatomy, 'folder_types' | 'task_types' | 'product_base_types'>;
+
 declare type IconModel = {
     type?: 'material-symbols' | 'url';
     /** The name of the icon (for type material-symbols) */
@@ -664,10 +759,20 @@ export declare enum KeyMode {
     Shift = "shift"
 }
 
+declare type LinkType = {
+    link_type: string;
+    input_type: 'folder' | 'product' | 'version' | 'representation' | 'task' | 'workfile';
+    output_type: 'folder' | 'product' | 'version' | 'representation' | 'task' | 'workfile';
+    color?: string;
+    style?: 'solid' | 'dashed';
+};
+
 declare type MainCalc = 'count' | 'breakdown';
 
 export declare const matchSearchQuery: (haystack: string, groups: string[][]) => RankingInfo;
 
+export declare const MAX_SORT_KEYS = 5;
+
 export declare const mentionTypeOptions: {
     '@@@': {
         id: string;
@@ -693,7 +798,7 @@ declare type OverviewSettings = {
     groupBy?: string;
     groupSortByDesc?: boolean;
     showEmptyGroups?: boolean;
-    sortBy?: string;
+    sortBy?: string | string[];
     sortDesc?: boolean;
     filter?: QueryFilter;
     folderFilter?: QueryFilter;
@@ -701,7 +806,7 @@ declare type OverviewSettings = {
     columns?: ColumnItemModel[];
 };
 
-export declare const parseAndFormatName: (raw: string, config?: EntityNaming) => string;
+export declare const parseAndFormatName: (raw: string, config?: EntityNaming_2) => string;
 
 /**
  * Parse a CSS color string (hex or rgb/rgba) to RGB components
@@ -729,10 +834,32 @@ export declare const parseUri: (uri: string) => {
     entity?: EntityUri;
 };
 
+/**
+ * Reads the sorting of a saved view.
+ *
+ * Views store `sortBy` as a list of column ids in order of precedence, where a
+ * `-` prefix means descending: `['-status', 'name']`.
+ * Views saved before multi-key sorting store a single column id and a separate
+ * `sortDesc` flag, which is only read for that old format.
+ */
+export declare const parseViewSorting: (sortBy?: string | string[] | null, sortDesc?: boolean | null) => SortingState;
+
 export declare const pastedListToSearch: (text: string) => string | null;
 
 export declare const pluralize: (count: number, singular: string) => string;
 
+declare type ProductBaseType = {
+    name?: string;
+    color?: string;
+    icon?: string;
+};
+
+declare type ProductBaseTypes = {
+    /** Default appearance for product types */
+    default?: DefaultProductBaseType;
+    definitions?: ProductBaseType[];
+};
+
 export declare interface ProductCreationData {
     folderId: string;
     name: string;
@@ -740,6 +867,29 @@ export declare interface ProductCreationData {
     productBaseType?: string;
 }
 
+declare type ProjectAttribModel = {
+    priority?: 'urgent' | 'high' | 'normal' | 'low';
+    /** Frame rate */
+    fps?: number;
+    /** Horizontal resolution */
+    resolutionWidth?: number;
+    /** Vertical resolution */
+    resolutionHeight?: number;
+    pixelAspect?: number;
+    clipIn?: number;
+    clipOut?: number;
+    frameStart?: number;
+    frameEnd?: number;
+    handleStart?: number;
+    handleEnd?: number;
+    /** Date and time when the project or task or asset was started */
+    startDate?: string;
+    /** Deadline date and time */
+    endDate?: string;
+    /** Textual description of the entity */
+    description?: string;
+};
+
 declare type ProjectLike = {
     name: string;
     label?: string | null;
@@ -751,6 +901,12 @@ declare interface ProjectTableAttribute extends Omit<AttributeModel_2, 'position
     enumError?: string;
 }
 
+declare type PublishTemplate = {
+    name: string;
+    directory: string;
+    file: string;
+};
+
 /**
  * Copyright (c) 2010,2011,2012,2013,2014 Morgan Roderick http://roderick.dk
  * License: MIT - http://mrgnrdrck.mit-license.org
@@ -792,6 +948,13 @@ export declare const replaceRoot: (input?: string | null, roots?: Record<string,
  */
 export declare const rgbToHex: (r: number, g: number, b: number) => string;
 
+declare type Root = {
+    name: string;
+    windows?: string;
+    linux?: string;
+    darwin?: string;
+};
+
 declare type RowItemData = {
     id: string;
     name?: string | null;
@@ -809,6 +972,14 @@ export declare const sanitizeProductName: (name: string) => string;
 
 declare type ScopeEntityType = 'folder' | 'product' | 'version' | 'representation' | 'task' | 'workfile' | 'project' | 'user';
 
+/**
+ * Writes the sorting of a view, see `parseViewSorting` for the format.
+ * No sorting is `undefined` so the view falls back to its default order.
+ */
+export declare const serializeViewSorting: (sorting?: SortingState) => string[] | undefined;
+
+export declare const setActiveEntities: (key: string, entities: ActiveEntity[], priority?: number) => void;
+
 declare type SettingsUri = {
     addonName: string;
     addonVersion: string;
@@ -845,8 +1016,34 @@ declare type SimpleTableRow = {
     badge?: string | React.ReactNode;
 };
 
+export declare type SortArgs = {
+    sortBy: string | string[] | undefined;
+    desc: boolean;
+};
+
+export declare type SortKey = {
+    key?: string;
+    desc?: boolean;
+};
+
 export declare const sortKeysDeep: (value: unknown) => unknown;
 
+declare type StagingDirectory = {
+    name: string;
+    directory?: string;
+};
+
+declare type Status = {
+    name: string;
+    original_name?: string;
+    shortName?: string;
+    state?: 'not_started' | 'in_progress' | 'done' | 'blocked';
+    icon?: string;
+    color?: string;
+    /** Limit the status to specific entity types. */
+    scope?: string[];
+};
+
 /**
  * Subscribes a callback to listen for thumbnail updates.
  *
@@ -869,6 +1066,33 @@ declare interface TableGroupBy {
     id: string;
 }
 
+declare type Tag = {
+    name: string;
+    original_name?: string;
+    color?: string;
+};
+
+declare type TaskType = {
+    name: string;
+    original_name?: string;
+    shortName?: string;
+    color?: string;
+    icon?: string;
+};
+
+declare type Templates = {
+    version_padding?: number;
+    version?: string;
+    frame_padding?: number;
+    frame?: string;
+    work?: WorkTemplate[];
+    publish?: PublishTemplate[];
+    hero?: HeroTemplate[];
+    delivery?: DeliveryTemplate[];
+    staging?: StagingDirectory[];
+    others?: CustomTemplate[];
+};
+
 declare type TextCalc = 'filled' | 'notFilled';
 
 /**
@@ -888,6 +1112,8 @@ export declare type ThumbnailUpdater = (messages: ThumbnailUpdateMessage[]) => v
 
 export declare const toDropdownErrorText: (text?: string) => string | undefined;
 
+export declare const useActiveEntities: () => ActiveEntity[];
+
 declare type UserAttribModel = {
     fullName?: string;
     email?: string;
@@ -895,6 +1121,9 @@ declare type UserAttribModel = {
     developerMode?: boolean;
 };
 
+/** Register entities for as long as the calling component is mounted. */
+export declare const useRegisterActiveEntities: (entities: ActiveEntity[] | undefined, priority?: number) => void;
+
 declare type UserModel = {
     /** Name is an unique id of the {entity_name} */
     name: string;
@@ -946,6 +1175,12 @@ export declare interface VersionCreationData {
 
 export declare const waitForRealtimeJitter: () => Promise<void>;
 
+declare type WorkTemplate = {
+    name: string;
+    directory: string;
+    file: string;
+};
+
 export { }