@ynput/ayon-frontend-shared 0.7.6 → 0.8.0

package/dist/types/util.d.ts

@@ -38,7 +38,9 @@ declare type Anatomy = {
     /** Path templates configuration */
     templates?: Templates;
     /** Attributes configuration */
-    attributes?: ProjectAttribModel;
+    attributes?: {
+        [key: string]: any;
+    };
     /** Folder types configuration */
     folder_types?: FolderType[];
     /** Task types configuration */
@@ -56,72 +58,80 @@ 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;
 };
 
 declare type AttributeData_2 = {
     /** 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_3[];
+    enum?: EnumItem_3[] | 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;
 };
 
 declare type AttributeModel = {
@@ -262,6 +272,13 @@ export declare const clearAccessToken: () => void;
 
 export declare const clearActiveEntities: (key: string) => void;
 
+/**
+ * Settings stored in a view, per page (`viewType`).
+ *
+ * The backend treats `settings` as a free-form object (`GenericViewModel`), so the shape of each
+ * page's settings is owned here and is not part of the generated API types. Keep these in step
+ * with what the pages read and write.
+ */
 declare type ColumnItemModel = {
     name: string;
     visible?: boolean;
@@ -413,73 +430,81 @@ export declare type EnumContextParam = (typeof ENUM_CONTEXT_PARAMS)[number];
 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;
+    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;
 };
 
 declare type EnumItem_2 = {
     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_2;
-    color?: string;
-    shortName?: string;
+    icon?: string | IconModel_2 | 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;
+    disabledMessage?: string | null;
     /** Enum item is not visible in the dropdown */
     hidden?: boolean;
     /** Extra badge labels to display next to the item */
-    badges?: string[];
+    badges?: string[] | null;
 };
 
 declare type EnumItem_3 = {
     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_3;
-    color?: string;
-    shortName?: string;
+    icon?: string | IconModel_3 | 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;
 };
 
 declare type EnumItem_4 = {
     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_4;
-    color?: string;
-    shortName?: string;
+    icon?: string | IconModel_4 | 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;
 };
 
 declare type EnumSource = {
@@ -501,6 +526,8 @@ export declare const extractEntityHierarchyFromParents: (parents: string[], enti
  */
 export declare function extractVersionFromFilename(filename: string): number | null;
 
+export declare const FILMSTRIP_ENTITY_TYPES: string[];
+
 export declare const filterBySearchQuery: <T>(items: T[], query: string, toHaystack: (item: T) => string) => T[];
 
 /**
@@ -513,7 +540,7 @@ export declare interface FolderHierarchyResult<T extends HierarchicalFolder> {
 
 declare type FolderType = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     shortName?: string;
     color?: string;
     icon?: string;
@@ -546,6 +573,21 @@ export declare const getCurrentPlatform: () => "other" | "windows" | "linux" | "
 
 export declare const getEntityColor: (entityType: string, subType: string | undefined, anatomy: IconAnatomy) => string | undefined;
 
+/**
+ * Builds a hover-scrub filmstrip URL for a project entity.
+ *
+ * Returns `null` for entity types without filmstrips (products, workfiles, projects...)
+ * or when the required identity information is missing.
+ */
+export declare const getEntityFilmstripUrl: ({ projectName, entityType, entityId, thumbnailHash, }: GetEntityFilmstripUrlParams) => string | null;
+
+export declare interface GetEntityFilmstripUrlParams {
+    projectName?: string;
+    entityType?: string;
+    entityId?: string;
+    thumbnailHash?: string;
+}
+
 export declare const getEntityIcon: (entityType: string, subType: string | undefined, anatomy: IconAnatomy) => string;
 
 export declare const getEntityId: () => string;
@@ -588,6 +630,9 @@ export declare const getEnumItemIcon: (icon: EnumItem_4["icon"]) => string | und
  */
 export declare const getErrorMessage: (error: unknown, prefix: string) => string;
 
+/** Builds a hover-scrub filmstrip URL for a project file (e.g. a reviewable) */
+export declare const getFileFilmstripUrl: (projectName?: string, fileId?: string) => string | null;
+
 /**
  * The `sortBy` of `buildSortArgs` for a query read forwards (`first`/`after`), where every
  * key carries its own direction.
@@ -742,41 +787,41 @@ export declare type IconAnatomy = Pick<Anatomy, 'folder_types' | 'task_types' |
 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;
 };
 
 declare type IconModel_2 = {
     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;
 };
 
 declare type IconModel_3 = {
     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;
 };
 
 declare type IconModel_4 = {
     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 isEnumContextParam: (name: string) => name is EnumContextParam;
@@ -797,7 +842,7 @@ declare type LinkType = {
     link_type: string;
     input_type: 'folder' | 'product' | 'version' | 'representation' | 'task' | 'workfile';
     output_type: 'folder' | 'product' | 'version' | 'representation' | 'task' | 'workfile';
-    color?: string;
+    color?: string | null;
     style?: 'solid' | 'dashed';
 };
 
@@ -914,29 +959,6 @@ 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;
@@ -966,9 +988,9 @@ 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 = {
@@ -1103,13 +1125,13 @@ export declare const STARTUP_DELAY = 3000;
 
 declare type Status = {
     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 storeAccessToken: (accessToken: string) => void;
@@ -1138,13 +1160,13 @@ declare interface TableGroupBy {
 
 declare type Tag = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     color?: string;
 };
 
 declare type TaskType = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     shortName?: string;
     color?: string;
     icon?: string;
@@ -1186,24 +1208,23 @@ export declare const URL_PARAM_ID = "uri";
 
 export declare const useActiveEntities: () => ActiveEntity[];
 
-declare type UserAttribModel = {
-    fullName?: string;
-    email?: string;
-    avatarUrl?: string;
-    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} */
+    /** Unique name of the user */
     name: string;
-    uiExposureLevel?: number;
-    attrib?: UserAttribModel;
-    data?: Record<string, any>;
-    /** Whether the user is active */
+    uiExposureLevel?: number | 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;