@ynput/ayon-frontend-shared 0.7.5 → 0.8.0

package/dist/types/DetailsPanel.d.ts

@@ -46,6 +46,8 @@ declare type DetailsPanelEntityData = {
     status: string;
     updatedAt: string;
     createdAt: string;
+    createdBy?: string | null;
+    updatedBy?: string | null;
     thumbnailHash: string;
     attrib: Record<string, string | number>;
     hasReviewables?: boolean;
@@ -198,7 +200,7 @@ export declare type EntityTypeIcons = {
 
 declare type FolderType_2 = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     shortName?: string;
     color?: string;
     icon?: string;
@@ -206,7 +208,7 @@ declare type FolderType_2 = {
 
 declare type FolderType_2_2 = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     shortName?: string;
     color?: string;
     icon?: string;
@@ -229,6 +231,8 @@ declare type GetDetailsPanelTaskQuery = {
             assignees: Array<string>;
             updatedAt: unknown;
             createdAt: unknown;
+            createdBy: string | null;
+            updatedBy: string | null;
             thumbnailHash: string;
             folderId: string;
             thumbnailId: string | null;
@@ -288,7 +292,9 @@ declare type LinkTypeModel_2 = {
     /** Output entity type */
     outputType: string;
     /** Additional link type data */
-    data?: object;
+    data?: {
+        [key: string]: any;
+    };
 };
 
 declare type LinkTypeModel_2_2 = {
@@ -301,7 +307,9 @@ declare type LinkTypeModel_2_2 = {
     /** Output entity type */
     outputType: string;
     /** Additional link type data */
-    data?: object;
+    data?: {
+        [key: string]: any;
+    };
 };
 
 /**
@@ -325,74 +333,36 @@ export declare const PriorityEnumDropdown: IStyledComponentBase<"web", FastOmit<
 
 declare type ProductTypeListItem = {
     name: string;
-    baseType?: string;
-    color?: string;
-    icon?: string;
-};
-
-declare type ProjectAttribModel2 = {
-    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 ProjectAttribModel2_2 = {
-    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;
+    baseType?: string | null;
+    color?: string | null;
+    icon?: string | null;
 };
 
 declare type ProjectModel = {
-    /** Name is an unique id of the {entity_name} */
+    /** Unique name of the project */
     name: string;
     code: string;
-    label?: string;
+    label?: string | null;
     library?: boolean;
     folderTypes?: FolderType_2[];
     taskTypes?: TaskType_2[];
     linkTypes?: LinkTypeModel_2[];
     statuses?: Status_2[];
     tags?: Tag_2[];
-    config?: object;
-    skeleton?: boolean;
-    attrib?: ProjectAttribModel2;
-    data?: object;
-    /** Whether the project is active */
+    config?: {
+        [key: string]: any;
+    };
+    skeleton?: boolean | null;
+    /** Attribute values of the entity */
+    attrib?: {
+        [key: string]: any;
+    };
+    data?: {
+        [key: string]: any;
+    };
+    /** Whether the entity is active */
     active?: boolean;
+    /** List of attributes explicitly set on the entity itself (not inherited) */
     ownAttrib?: string[];
     /** Time of creation */
     createdAt?: string;
@@ -401,22 +371,30 @@ declare type ProjectModel = {
 };
 
 declare type ProjectModel_2 = {
-    /** Name is an unique id of the {entity_name} */
+    /** Unique name of the project */
     name: string;
     code: string;
-    label?: string;
+    label?: string | null;
     library?: boolean;
     folderTypes?: FolderType_2_2[];
     taskTypes?: TaskType_2_2[];
     linkTypes?: LinkTypeModel_2_2[];
     statuses?: Status_2_2[];
     tags?: Tag_2_2[];
-    config?: object;
-    skeleton?: boolean;
-    attrib?: ProjectAttribModel2_2;
-    data?: object;
-    /** Whether the project is active */
+    config?: {
+        [key: string]: any;
+    };
+    skeleton?: boolean | null;
+    /** Attribute values of the entity */
+    attrib?: {
+        [key: string]: any;
+    };
+    data?: {
+        [key: string]: any;
+    };
+    /** Whether the entity is active */
     active?: boolean;
+    /** List of attributes explicitly set on the entity itself (not inherited) */
     ownAttrib?: string[];
     /** Time of creation */
     createdAt?: string;
@@ -434,24 +412,24 @@ declare type ResolveVersionJump = (versionId: string) => (() => void) | undefine
 
 declare type Status_2 = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     shortName?: string;
     state?: 'not_started' | 'in_progress' | 'done' | 'blocked';
     icon?: string;
     color?: string;
     /** Limit the status to specific entity types. */
-    scope?: string[];
+    scope?: string[] | null;
 };
 
 declare type Status_2_2 = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     shortName?: string;
     state?: 'not_started' | 'in_progress' | 'done' | 'blocked';
     icon?: string;
     color?: string;
     /** Limit the status to specific entity types. */
-    scope?: string[];
+    scope?: string[] | null;
 };
 
 export declare const StatusSelect: IStyledComponentBase<"web", FastOmit< FastOmit<Omit< StatusSelectProps & RefAttributes<DropdownRef>, "ref"> & {
@@ -462,19 +440,19 @@ export declare const StatusSelect: IStyledComponentBase<"web", FastOmit< FastOmi
 
 declare type Tag = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     color?: string;
 };
 
 declare type Tag_2 = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     color?: string;
 };
 
 declare type Tag_2_2 = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     color?: string;
 };
 
@@ -486,7 +464,7 @@ export declare const TagsSelect: IStyledComponentBase<"web", FastOmit<Omit< Tags
 
 declare type TaskType_2 = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     shortName?: string;
     color?: string;
     icon?: string;
@@ -494,7 +472,7 @@ declare type TaskType_2 = {
 
 declare type TaskType_2_2 = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     shortName?: string;
     color?: string;
     icon?: string;

package/dist/types/EntityPickerDialog.d.ts

@@ -2,14 +2,20 @@ import { DialogProps } from '@ynput/ayon-react-components';
 import { FC } from 'react';
 import { RowSelectionState } from '@tanstack/react-table';
 
+declare type EntityLinkThumbnail = {
+    entityType: string;
+    entityId: string;
+    thumbnailHash?: string;
+};
+
 export declare const EntityPickerDialog: FC<EntityPickerDialogProps>;
 
-declare interface EntityPickerDialogProps extends Pick<DialogProps, 'onClose'> {
+export declare interface EntityPickerDialogProps extends Pick<DialogProps, 'onClose'> {
     projectName: string;
     entityType: PickerEntityType;
     initialSelection?: Partial<PickerSelection>;
     isMultiSelect?: boolean;
-    onSubmit: (selection: string[]) => void;
+    onSubmit: (selection: string[], entities: PickedEntity[]) => void;
     showMoveToRoot?: boolean;
     onMoveToRoot?: () => void;
     disabledIds?: string[];
@@ -22,12 +28,55 @@ declare interface EntityPickerDialogProps extends Pick<DialogProps, 'onClose'> {
     isLoading?: boolean;
 }
 
+declare type FolderListItem = {
+    id: string;
+    path: string;
+    parentId?: string | null;
+    parents: string[];
+    name: string;
+    label?: string | null;
+    folderType: string;
+    hasTasks?: boolean;
+    hasChildren?: boolean;
+    hasReviewables?: boolean;
+    thumbnailHash: string;
+    taskNames?: string[] | null;
+    tags?: string[] | null;
+    status: string;
+    attrib?: {
+        [key: string]: any;
+    } | null;
+    active?: boolean;
+    visible?: boolean;
+    ownAttrib?: string[] | null;
+    createdAt: string;
+    updatedAt: string;
+    createdBy?: string | null;
+    updatedBy?: string | null;
+};
+
+/** a picked entity as the picker loaded it, `undefined` when it isn't loaded (a later page) */
+export declare type PickedEntity = SearchEntityLink | FolderListItem | undefined;
+
 export declare type PickerEntityType = 'folder' | 'task' | 'product' | 'version' | 'representation' | 'workfile';
 
 export declare type PickerSearch = Record<PickerEntityType, string | undefined>;
 
 export declare type PickerSelection = Record<PickerEntityType, RowSelectionState>;
 
+declare type SearchEntityLink = {
+    id: string;
+    name: string;
+    entityType: string;
+    parents: string[];
+    label: string;
+    icon: string | undefined;
+    subType: string | undefined;
+    hasReviewables?: boolean;
+    taskName?: string;
+    thumbnail?: EntityLinkThumbnail;
+};
+
 export { }
 
 

package/dist/types/Feed.d.ts

@@ -178,14 +178,14 @@ declare interface FileUploadPreviewProps {
 
 declare type FolderSuggestionItem = {
     /** The date and time when the suggested entity was created */
-    createdAt?: string;
+    createdAt?: string | null;
     /** The relevance score of the suggestion */
-    relevance?: number;
+    relevance?: number | null;
     id: string;
     folderType: string;
     name: string;
-    label?: string;
-    thumbnailId?: string;
+    label?: string | null;
+    thumbnailId?: string | null;
 };
 
 export declare const getMultiSelection: (selection: {
@@ -238,22 +238,22 @@ declare type PowerpackFeature = 'slicer' | 'annotations' | 'releases' | 'advance
 
 declare type ProductSuggestionItem = {
     /** The date and time when the suggested entity was created */
-    createdAt?: string;
+    createdAt?: string | null;
     /** The relevance score of the suggestion */
-    relevance?: number;
+    relevance?: number | null;
     id: string;
     name: string;
     productType: string;
-    parent?: FolderSuggestionItem;
+    parent?: FolderSuggestionItem | null;
 };
 
 declare type QueryCondition = {
     /** Path to the key separated by slashes */
     key: string;
     /** Value to compare against */
-    value?: string | number | number | boolean | string[] | number[] | number[];
-    /** Comparison operator */
-    operator?: 'eq' | 'like' | 'notlike' | 'lt' | 'gt' | 'lte' | 'gte' | 'ne' | 'isnull' | 'notnull' | 'in' | 'notin' | 'includes' | 'excludes' | 'includesall' | 'excludesall' | 'includesany' | 'excludesany';
+    value?: string | number | number | boolean | string[] | number[] | number[] | null;
+    /** Comparison operator. like and notlike perform case-insensitive substring matching. One surrounding pair of % is treated as a substring wrapper; %, _ and backslashes within it are literal. */
+    operator?: 'eq' | 'like' | 'notlike' | 're' | 'lt' | 'gt' | 'lte' | 'gte' | 'ne' | 'isnull' | 'notnull' | 'in' | 'notin' | 'includes' | 'excludes' | 'includesall' | 'excludesall' | 'includesany' | 'excludesany';
 };
 
 declare type QueryFilter = {
@@ -313,22 +313,22 @@ declare type SuggestResponse = {
 
 declare type TaskSuggestionItem = {
     /** The date and time when the suggested entity was created */
-    createdAt?: string;
+    createdAt?: string | null;
     /** The relevance score of the suggestion */
-    relevance?: number;
+    relevance?: number | null;
     id: string;
     taskType: string;
     name: string;
-    label?: string;
-    thumbnailId?: string;
-    parent?: FolderSuggestionItem;
+    label?: string | null;
+    thumbnailId?: string | null;
+    parent?: FolderSuggestionItem | null;
 };
 
 declare type TeamSuggestionItem = {
     /** The date and time when the suggested entity was created */
-    createdAt?: string;
+    createdAt?: string | null;
     /** The relevance score of the suggestion */
-    relevance?: number;
+    relevance?: number | null;
     name: string;
 };
 
@@ -336,11 +336,11 @@ export declare const useFeedContext: () => FeedContextType;
 
 declare type UserSuggestionItem = {
     /** The date and time when the suggested entity was created */
-    createdAt?: string;
+    createdAt?: string | null;
     /** The relevance score of the suggestion */
-    relevance?: number;
+    relevance?: number | null;
     name: string;
-    fullName?: string;
+    fullName?: string | null;
 };
 
 export declare const useTableKeyboardNavigation: ({ tableRef, treeData, selection, onSelectionChange, config: { multiSelect }, }: UseTableNavigationProps) => (event: React.KeyboardEvent<HTMLDivElement>) => void;
@@ -362,13 +362,13 @@ export declare interface UseTableNavigationProps {
 
 declare type VersionSuggestionItem = {
     /** The date and time when the suggested entity was created */
-    createdAt?: string;
+    createdAt?: string | null;
     /** The relevance score of the suggestion */
-    relevance?: number;
+    relevance?: number | null;
     id: string;
     version: number;
-    parent?: ProductSuggestionItem;
-    name?: string;
+    parent?: ProductSuggestionItem | null;
+    name?: string | null;
 };
 
 export { }

package/dist/types/ListTable.d.ts

@@ -15,36 +15,40 @@ 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';
     /** Nice, human readable title of the attribute */
-    title?: string;
-    description?: string;
+    title?: string | null;
+    description?: string | null;
     /** Example value of the field. */
     example?: any;
     /** Default value for the attribute. Do not set for list types. */
     default?: any;
-    gt?: number | number;
-    ge?: number | number;
-    lt?: number | number;
-    le?: number | number;
-    minLength?: number;
-    maxLength?: number;
+    gt?: number | number | null;
+    ge?: number | number | null;
+    lt?: number | number | null;
+    le?: number | number | null;
+    minLength?: number | null;
+    maxLength?: number | null;
     /** Minimum number of items in list type. */
-    minItems?: number;
+    minItems?: number | null;
     /** Only for list types. Maximum number of items in the list. */
-    maxItems?: number;
+    maxItems?: number | null;
     /** Only for string types. The value must match this regex. */
-    regex?: string;
+    regex?: string | null;
     /** List of enum items used for displaying select widgets */
-    enum?: EnumItem[];
+    enum?: EnumItem[] | null;
     /** Name of the function that provides enum values dynamically. */
-    enumResolver?: string;
+    enumResolver?: string | null;
     /** Settings passed to the enum resolver function. */
-    enumResolverSettings?: object;
+    enumResolverSettings?: {
+        [key: string]: any;
+    } | null;
     /** Inherit the attribute value from the parent entity. */
     inherit?: boolean;
     /** Specific widget style this field should use. */
-    widget?: string;
+    widget?: string | null;
     /** Any additional config specific for the widget style.(Date formats, precision etc.) */
-    widgetSettings?: object;
+    widgetSettings?: {
+        [key: string]: any;
+    } | null;
 };
 
 /**
@@ -108,19 +112,21 @@ export declare const defaultListTableDataTypeWidgets: ListTableDataTypeWidgets<a
 declare type EnumItem = {
     value: string | number | number | boolean;
     label: string;
-    description?: string;
-    fulltext?: string[];
-    group?: string;
+    description?: string | null;
+    fulltext?: string[] | null;
+    group?: string | null;
     /** Icon name (material symbol) or IconModel object */
-    icon?: string | IconModel;
-    color?: string;
-    shortName?: string;
+    icon?: string | IconModel | null;
+    color?: string | null;
+    shortName?: string | null;
     /** Enum item is visible, but not selectable */
     disabled?: boolean;
     /** Message to show when the option is disabled */
-    disabledMessage?: string;
-    /** Enum item is not offered for selection, but resolves when already used */
+    disabledMessage?: string | null;
+    /** Enum item is not visible in the dropdown */
     hidden?: boolean;
+    /** Extra badge labels to display next to the item */
+    badges?: string[] | null;
 };
 
 export declare const getDefaultListTableDataTypeWidgets: <TData extends RowData>() => ListTableDataTypeWidgets<TData>;
@@ -136,11 +142,11 @@ export declare type GetRowColumnValue<TData> = (row: TData, columnId: string) =>
 declare type IconModel = {
     type?: 'material-symbols' | 'url';
     /** The name of the icon (for type material-symbols) */
-    name?: string;
+    name?: string | null;
     /** The color of the icon (for type material-symbols) */
-    color?: string;
+    color?: string | null;
     /** The URL of the icon (for type url) */
-    url?: string;
+    url?: string | null;
 };
 
 export declare const isListTableGroupDisplayObject: (value: unknown) => value is ListTableGroupDisplay;

package/dist/types/NewEntity.d.ts

@@ -24,7 +24,7 @@ declare type EntityNaming = {
 
 declare type FolderType_2 = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     shortName?: string;
     color?: string;
     icon?: string;
@@ -46,7 +46,9 @@ declare type LinkTypeModel_2 = {
     /** Output entity type */
     outputType: string;
     /** Additional link type data */
-    data?: object;
+    data?: {
+        [key: string]: any;
+    };
 };
 
 export declare const NameRow: IStyledComponentBase<"web", FastOmit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never> & Partial<Pick< DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>>> & string;
@@ -111,53 +113,38 @@ declare type OperationResponseModel = {
     id: string;
     type: 'create' | 'update' | 'delete';
     entityType: 'folder' | 'product' | 'version' | 'representation' | 'task' | 'workfile';
-    entityId?: string;
+    entityId?: string | null;
     success: boolean;
     status: number;
-    errorCode?: string;
-    detail?: string;
-};
-
-declare type ProjectAttribModel2 = {
-    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;
+    errorCode?: string | null;
+    detail?: string | null;
 };
 
 declare type ProjectModel = {
-    /** Name is an unique id of the {entity_name} */
+    /** Unique name of the project */
     name: string;
     code: string;
-    label?: string;
+    label?: string | null;
     library?: boolean;
     folderTypes?: FolderType_2[];
     taskTypes?: TaskType_2[];
     linkTypes?: LinkTypeModel_2[];
     statuses?: Status_2[];
     tags?: Tag_2[];
-    config?: object;
-    skeleton?: boolean;
-    attrib?: ProjectAttribModel2;
-    data?: object;
-    /** Whether the project is active */
+    config?: {
+        [key: string]: any;
+    };
+    skeleton?: boolean | null;
+    /** Attribute values of the entity */
+    attrib?: {
+        [key: string]: any;
+    };
+    data?: {
+        [key: string]: any;
+    };
+    /** Whether the entity is active */
     active?: boolean;
+    /** List of attributes explicitly set on the entity itself (not inherited) */
     ownAttrib?: string[];
     /** Time of creation */
     createdAt?: string;
@@ -175,24 +162,24 @@ declare interface SequenceForm {
 
 declare type Status_2 = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     shortName?: string;
     state?: 'not_started' | 'in_progress' | 'done' | 'blocked';
     icon?: string;
     color?: string;
     /** Limit the status to specific entity types. */
-    scope?: string[];
+    scope?: string[] | null;
 };
 
 declare type Tag_2 = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     color?: string;
 };
 
 declare type TaskType_2 = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     shortName?: string;
     color?: string;
     icon?: string;