@ynput/ayon-frontend-shared 0.7.5 → 0.8.0

package/dist/types/hooks.d.ts

@@ -39,9 +39,9 @@ declare type AddonListItem = {
     /** Addon description */
     description: string;
     /** Production version of the addon */
-    productionVersion?: string;
+    productionVersion?: string | null;
     /** Staging version of the addon */
-    stagingVersion?: string;
+    stagingVersion?: string | null;
     /** Type of the addon */
     addonType: 'server' | 'pipeline';
     /** Is the addon a system addon? */
@@ -54,36 +54,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;
 };
 
 export declare type AttributeEnumsRequest = string[] | 'all';
@@ -97,6 +101,8 @@ export declare interface AttributeEnumState {
 
 declare type BooleanCalc = 'checked' | 'notChecked';
 
+declare type BundleMode = 'production' | 'staging' | 'developer';
+
 declare type ColumnsConfig = {
     columnVisibility: VisibilityState;
     columnOrder: ColumnOrderState;
@@ -189,19 +195,21 @@ declare type EnumCalc = 'values' | 'fill';
 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;
 };
 
 declare interface EnumItemDialogProps {
@@ -234,27 +242,33 @@ export declare const filterProjectStatuses: (statuses: EntityStatus[], entityTyp
 declare type FolderListItem = {
     id: string;
     path: string;
-    parentId?: string;
+    parentId?: string | null;
     parents: string[];
     name: string;
-    label?: string;
+    label?: string | null;
     folderType: string;
     hasTasks?: boolean;
     hasChildren?: boolean;
     hasReviewables?: boolean;
     thumbnailHash: string;
-    taskNames?: string[];
-    tags?: string[];
+    taskNames?: string[] | null;
+    tags?: string[] | null;
     status: string;
-    attrib?: object;
-    ownAttrib?: string[];
+    attrib?: {
+        [key: string]: any;
+    } | null;
+    active?: boolean;
+    visible?: boolean;
+    ownAttrib?: string[] | null;
     createdAt: string;
     updatedAt: string;
+    createdBy?: string | null;
+    updatedBy?: string | null;
 };
 
 declare type FolderType = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     shortName?: string;
     color?: string;
     icon?: string;
@@ -303,20 +317,20 @@ declare interface GroupSettingsProps {
 declare type HttpSourceInfo = {
     type?: 'http';
     url: string;
-    filename?: string;
+    filename?: string | null;
     headers?: {
         [key: string]: string;
-    };
+    } | null;
 };
 
 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 MainCalc = 'count' | 'breakdown';
@@ -436,8 +450,8 @@ declare type RowScope = 'all' | 'primary' | 'secondary' | 'none';
 
 declare type ServerSourceInfo = {
     type?: 'server';
-    filename?: string;
-    path?: string;
+    filename?: string | null;
+    path?: string | null;
 };
 
 declare type SettingsPanelItem = {
@@ -470,13 +484,13 @@ declare type SimpleTableRow = {
 
 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;
 };
 
 declare type SummaryCalc = NumberCalc | BooleanCalc | TextCalc | EnumCalc | MainCalc;
@@ -490,7 +504,7 @@ declare interface TableGroupBy {
 
 declare type TaskType = {
     name: string;
-    original_name?: string;
+    original_name?: string | null;
     shortName?: string;
     color?: string;
     icon?: string;
@@ -554,6 +568,12 @@ export declare interface UseEntityUpdateParams {
 
 export declare const useFetchAttributeEnumOptions: () => FetchAttributeEnumOptions;
 
+export declare const useGetBundleAddon: () => {
+    getBundleAddonVersion: (addonName: string, options?: VersionOptions) => string | undefined;
+    bundleVariant: BundleMode;
+    isLoading: boolean;
+};
+
 export declare const useGetEntityGroups: ({ groupBy, projectName, entityType }: GetEntityGroupsProps) => {
     groups: EntityGroup[];
     error: FetchBaseQueryError | SerializedError | undefined;
@@ -652,16 +672,25 @@ declare type VersionInfo = {
     frontendScopes?: {
         [key: string]: FrontendScopeSettings;
     };
-    clientPyproject?: object;
-    clientSourceInfo?: (FilesystemSourceInfo | ServerSourceInfo | HttpSourceInfo)[];
-    services?: object;
+    clientPyproject?: {
+        [key: string]: any;
+    } | null;
+    clientSourceInfo?: (FilesystemSourceInfo | ServerSourceInfo | HttpSourceInfo)[] | null;
+    services?: {
+        [key: string]: any;
+    } | null;
     isBroken?: boolean;
     reason?: {
         [key: string]: string;
-    };
+    } | null;
     projectCanOverrideAddonVersion?: boolean;
 };
 
+declare type VersionOptions = {
+    version?: string;
+    minVersion?: string;
+};
+
 export declare const writeLocalStorage: <T>(key: string, value: T) => void;
 
 export declare const writeSessionStorage: <T>(key: string, value: T) => void;

package/dist/types/index.d.ts

@@ -44,6 +44,12 @@ declare interface ThumbnailSimpleProps extends default_2.HTMLAttributes<HTMLDivE
     onLoad?: default_2.ReactEventHandler<HTMLImageElement>;
     onError?: default_2.ReactEventHandler<HTMLImageElement>;
     iconOnly?: boolean;
+    /** show a hover-scrub filmstrip (the entity should have reviewables) */
+    filmstrip?: boolean;
+    /** filmstrip url override, when the entity props are not available */
+    filmstripUrl?: string | null;
+    /** should match object-fit of the image */
+    filmstripFit?: 'cover' | 'contain';
 }
 
 export declare const useMenuContext: () => MenuContextType;