@ynput/ayon-frontend-shared 0.6.6 → 0.6.8

package/dist/types/components.d.ts

@@ -17,6 +17,7 @@ import { DetailedHTMLProps } from 'react';
 import { DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES } from 'react';
 import { DocumentNode } from 'graphql';
 import { DropdownRef } from '@ynput/ayon-react-components';
+import { ExecutionProps } from 'styled-components';
 import { FastOmit } from 'styled-components';
 import { FC } from 'react';
 import { FetchArgs } from '@reduxjs/toolkit/query';
@@ -36,6 +37,7 @@ import { LabelHTMLAttributes } from 'react';
 import { MouseEvent as MouseEvent_2 } from 'react';
 import { MutationActionCreatorResult } from '@reduxjs/toolkit/query';
 import { MutationDefinition } from '@reduxjs/toolkit/query';
+import { NamedExoticComponent } from 'react';
 import { Option as Option_2 } from '@ynput/ayon-react-components';
 import { OverrideResultType } from '@reduxjs/toolkit/query';
 import { QueryDefinition } from '@reduxjs/toolkit/query';
@@ -2286,7 +2288,11 @@ declare type QueryFilter_5 = {
     operator?: 'and' | 'or';
 };
 
-export declare const RefreshToast: () => JSX_2.Element;
+export declare const RefreshToast: ({ message }: RefreshToastProps) => JSX_2.Element;
+
+declare type RefreshToastProps = {
+    message?: string;
+};
 
 export declare interface RemotePageContext {
     detailsPanel?: DetailsPanelContextType;
@@ -2828,6 +2834,8 @@ export declare const splitClientFiltersByScope: (filters: (Filter | SliceFilter)
  */
 export declare const splitFiltersByScope: (combinedFilter: Record<string, any> | null, scopes: ScopeType[], config?: FilterConfig, filterIdToScopeMap?: Record<string, ScopeType>) => Record<ScopeType | "unscoped", Record<string, any>>;
 
+export declare const SplitterStyles: NamedExoticComponent< ExecutionProps & object>;
+
 export declare const StackedThumbnails: ({ thumbnails, isLoading, className, style, ...props }: StackedThumbnailsProps) => JSX_2.Element | null;
 
 export declare interface StackedThumbnailsProps extends Omit<ThumbnailProps, 'entityType' | 'entityId' | 'projectName' | 'thumbnailHash'> {

package/dist/types/context.d.ts

@@ -970,6 +970,7 @@ export declare type PowerpackContextType = {
     }) | null;
     powerLicense: boolean;
     isLoading: boolean;
+    storedLicense: boolean | null;
 };
 
 /** The dialog can be opened for a power feature or an addon */

package/dist/types/hooks.d.ts

@@ -5,6 +5,7 @@ import { Dispatch } from 'react';
 import { FC } from 'react';
 import { FetchBaseQueryError } from '@reduxjs/toolkit/query';
 import { OnChangeFn } from '@tanstack/react-table';
+import { RefObject } from 'react';
 import { SerializedError } from '@reduxjs/toolkit';
 import { SetStateAction } from 'react';
 import { SortingState } from '@tanstack/react-table';
@@ -336,6 +337,12 @@ declare type Options<T extends ReviewableLike> = {
     enabled?: boolean;
 };
 
+declare type Options_2 = {
+    containerRef: RefObject<HTMLElement>;
+    toolsRef: RefObject<HTMLElement>;
+    reviewablesCount: number;
+};
+
 declare type PathDefinition = {
     windows?: string;
     linux?: string;
@@ -356,6 +363,7 @@ declare interface Props<T> {
     debug?: boolean;
     minVersion?: string;
     skip?: boolean;
+    defer?: boolean;
 }
 
 declare type Props_2 = {
@@ -396,6 +404,8 @@ declare type ReviewableLike = {
     label?: string | null;
 };
 
+export declare type ReviewablesLayout = 'column' | 'row';
+
 declare type RowItemData = {
     id: string;
     name?: string | null;
@@ -474,6 +484,13 @@ export declare const useActionTriggers: ({ searchParams, onSetSearchParams, onNa
     handleActionPayload: (actionType: string, payload: ActionPayload | null) => void;
 };
 
+/**
+ * False until the page has had time to load (see afterStartup), then true.
+ * Use it to skip queries nobody waits for on load, e.g. prompts and banners,
+ * so they don't compete with the page's own requests.
+ */
+export declare const useAfterStartup: (delay?: number) => boolean;
+
 export declare const useAttributeEnumOptions: (data: AttributeData | undefined, { projectName, skip }?: UseAttributeEnumOptionsParams) => AttributeEnumState;
 
 export declare interface UseAttributeEnumOptionsParams {
@@ -551,7 +568,7 @@ export declare const useHierarchyTable: ({ projectName, folderTypes, includeColo
     isFetching: boolean;
 };
 
-export declare const useLoadModule: <T>({ addon, remote, module, fallback, minVersion, skip, }: Props<T>) => [T, {
+export declare const useLoadModule: <T>({ addon, remote, module, fallback, minVersion, skip, defer, }: Props<T>) => [T, {
     isLoaded: boolean;
     isLoading: boolean;
     outdated?: {
@@ -579,6 +596,13 @@ export declare const useQueryArgumentChangeLoading: <T extends Record<string, an
 
 export declare function useReviewablesKeyboardNavigation<T extends ReviewableLike>({ reviewables, selected, onChange, onNavigate, enabled, }: Options<T>): void;
 
+/**
+ * Stacks the reviewables above the annotation tools while there is room for them.
+ * Once there are more than 3 reviewables and they would get less than 30% of the
+ * container height, the tools and reviewables are laid out side by side instead.
+ */
+export declare function useReviewablesLayout({ containerRef, toolsRef, reviewablesCount, }: Options_2): ReviewablesLayout;
+
 export declare const useScopedStatuses: (projects: string[], entityTypes: string[]) => EntityStatus[] | undefined;
 
 export declare const useScopedTypes: (projects: string[], entityType: string) => EntityType[];

package/dist/types/util.d.ts

@@ -22,6 +22,14 @@ export declare type ActiveEntity = {
     projectName: string;
 };
 
+/**
+ * Runs `callback` once the page has had time to load: after `delay` ms, at the next idle
+ * period (or straight away where requestIdleCallback is missing).
+ * Use it for work nobody waits for on load, like third party widgets or rarely used addon code.
+ * Returns a function that cancels it.
+ */
+export declare const afterStartup: (callback: () => void, delay?: number) => () => void;
+
 declare type Anatomy = {
     /** Settings for automatic entity name generation */
     entity_naming?: EntityNaming;
@@ -1033,6 +1041,8 @@ declare type StagingDirectory = {
     directory?: string;
 };
 
+export declare const STARTUP_DELAY = 3000;
+
 declare type Status = {
     name: string;
     original_name?: string;

package/dist/util.es.js

@@ -1,27 +1,28 @@
-import { K as S, g as I, a as A } from "./chunks/platform.es.js";
+import { K as S, g as A, a as I } from "./chunks/platform.es.js";
 import { c as d } from "./chunks/confirmDelete.es.js";
 import { a as R } from "./chunks/confirmDelete.es.js";
 import { e as F, g as M } from "./chunks/getEntityTypeIcon.es.js";
 import { g as v, r as D } from "./chunks/replaceRoot.es.js";
 import { A as U, c as w, e as N, g as O, a as V, s as k, u as H, b as K } from "./chunks/activeEntities.es.js";
 import { c as z } from "./chunks/copyToClipboard.es.js";
-import { g as q, h as J } from "./chunks/humanizeFieldName.es.js";
-import { c as W, a as X, g as Y, b as $, d as G, p as Z, e as ee } from "./chunks/iconUtils.es.js";
-import { bk as g } from "./chunks/searchTerms.es.js";
-import { bl as ae, be as re, bm as se, bg as oe, bn as ie, bi as ne, bo as le, bp as me, bj as ce, bf as pe, bq as de, br as ge, bs as be, bh as ue, bt as Ee, bu as fe, bv as he, bw as Te } from "./chunks/searchTerms.es.js";
-import { M as xe, a as Se, b as Ie, d as Ae, e as Pe, f as Re, c as Ce, g as Fe, h as Me, i as _e, p as ve, s as De, j as Le, v as Ue, w as we } from "./chunks/realtimeUpdatesUtils.es.js";
+import { g as j, h as q } from "./chunks/humanizeFieldName.es.js";
+import { c as Q, a as W, g as X, b as $, d as G, p as Z, e as ee } from "./chunks/iconUtils.es.js";
+import { bl as g } from "./chunks/searchTerms.es.js";
+import { bm as ae, bf as re, bn as se, bh as oe, bo as ie, bj as ne, bp as le, bq as me, bk as ce, bg as pe, br as de, bs as ge, bt as ue, bi as be, bu as Ee, bv as fe, bw as Te, bx as he } from "./chunks/searchTerms.es.js";
+import { M as ye, a as Se, b as Ae, d as Ie, e as Pe, f as Re, c as Ce, g as Fe, h as Me, i as _e, p as ve, s as De, j as Le, v as Ue, w as we } from "./chunks/realtimeUpdatesUtils.es.js";
 import { e as Oe } from "./chunks/extractVersionFromFilename.es.js";
-import { c as ke, a as He, b as Ke, g as Be, h as ze, s as je, v as qe, d as Je, e as Qe } from "./chunks/versionUploadHelpers.es.js";
-import { c as Xe, a as Ye } from "./chunks/columnConfigConverter.es.js";
+import { c as ke, a as He, b as Ke, g as Be, h as ze, s as Ye, v as je, d as qe, e as Je } from "./chunks/versionUploadHelpers.es.js";
+import { c as We, a as Xe } from "./chunks/columnConfigConverter.es.js";
 import { p as Ge } from "./chunks/pluralize.es.js";
 import { b as et, a as tt, h as at, p as rt, r as st } from "./chunks/colorUtils.es.js";
 import { g as it } from "./chunks/getGroupByDataType.es.js";
 import { b as lt, g as mt, a as ct, c as pt, p as dt, u as gt } from "./chunks/getBundleMode.es.js";
-import { b as ut, s as Et } from "./chunks/buildHierarchicalTableRows.es.js";
-import { g as ht, a as Tt } from "./chunks/getThumbnailUrl.es.js";
-import { p as xt } from "./chunks/parseFilename.es.js";
-import { i as It } from "./chunks/isHTMLElement.es.js";
-import { ConfirmDialog as Pt } from "primereact/confirmdialog";
+import { b as bt, s as Et } from "./chunks/buildHierarchicalTableRows.es.js";
+import { g as Tt, a as ht } from "./chunks/getThumbnailUrl.es.js";
+import { p as yt } from "./chunks/parseFilename.es.js";
+import { i as At } from "./chunks/isHTMLElement.es.js";
+import { S as Pt, a as Rt } from "./chunks/afterStartup.es.js";
+import { ConfirmDialog as Ft } from "primereact/confirmdialog";
 const E = (e) => {
   const a = /* @__PURE__ */ new Map(), s = [];
   for (const t of e)
@@ -51,7 +52,7 @@ const E = (e) => {
     label: m,
     message: l || c
   });
-}, h = (e) => e ? e.label?.trim() || e.name : "", T = {
+}, T = (e) => e ? e.label?.trim() || e.name : "", h = {
   "@@@": {
     id: "task"
   },
@@ -65,28 +66,30 @@ const E = (e) => {
 };
 export {
   U as ACTIVE_ENTITIES_PRIORITY,
-  Pt as ConfirmDialog,
+  Ft as ConfirmDialog,
   ae as ENUM_CONTEXT_PARAMS,
   S as KeyMode,
-  xe as MAX_SORT_KEYS,
+  ye as MAX_SORT_KEYS,
   re as PubSub,
   Se as REALTIME_REST_CALL_LIMIT,
-  Ie as REALTIME_REST_JITTER,
-  Ae as REALTIME_TASK_SUPPORTED_VALUE_FIELDS,
+  Ae as REALTIME_REST_JITTER,
+  Ie as REALTIME_TASK_SUPPORTED_VALUE_FIELDS,
   Pe as REALTIME_UPDATE_DEBOUNCE,
+  Pt as STARTUP_DELAY,
+  Rt as afterStartup,
   et as blendCategoryColor,
   tt as blendColors,
   lt as buildEntityUri,
   E as buildFolderHierarchy,
-  ut as buildHierarchicalTableRows,
+  bt as buildHierarchicalTableRows,
   Re as buildSortArgs,
-  W as checkLabel,
-  X as checkName,
+  Q as checkLabel,
+  W as checkName,
   w as clearActiveEntities,
   d as confirmDelete,
   R as confirmDeleteDialog,
-  Xe as convertColumnConfigToTanstackStates,
-  Ye as convertTanstackStatesToColumnConfig,
+  We as convertColumnConfigToTanstackStates,
+  Xe as convertTanstackStatesToColumnConfig,
   z as copyToClipboard,
   ke as createProductAndVersion,
   He as createProductHelper,
@@ -96,27 +99,27 @@ export {
   N as extractEntityHierarchyFromParents,
   Oe as extractVersionFromFilename,
   O as getActiveEntities,
-  Y as getAttributeIcon,
+  X as getAttributeIcon,
   mt as getBundleModeFromUser,
-  I as getCurrentPlatform,
+  A as getCurrentPlatform,
   $ as getEntityColor,
   G as getEntityIcon,
   Fe as getEntityId,
   ct as getEntityStateFromUri,
-  ht as getEntityThumbnailUrl,
+  Tt as getEntityThumbnailUrl,
   M as getEntityTypeIcon,
   se as getEnumContextParams,
   oe as getEnumErrorText,
   ie as getEnumItemIcon,
   g as getErrorMessage,
   it as getGroupByDataType,
-  q as getMixedState,
+  j as getMixedState,
   Be as getNextVersionNumber,
-  A as getPlatformShortcutKey,
+  I as getPlatformShortcutKey,
   Me as getPrimarySortKey,
   V as getPriorityOptions,
-  h as getProjectDisplayName,
-  Tt as getProjectThumbnailUrl,
+  T as getProjectDisplayName,
+  ht as getProjectThumbnailUrl,
   ne as getRequestErrorString,
   le as getSelectableAssignees,
   me as getSelectableEnumItems,
@@ -128,16 +131,16 @@ export {
   ce as hasEnumOptions,
   pe as hasEnumResolver,
   at as hexToRgb,
-  J as humanizeField,
+  q as humanizeField,
   de as isEnumContextParam,
   ge as isEnumIconImage,
-  It as isHTMLElement,
-  be as matchSearchQuery,
-  T as mentionTypeOptions,
-  ue as normalizeEnumItems,
+  At as isHTMLElement,
+  ue as matchSearchQuery,
+  h as mentionTypeOptions,
+  be as normalizeEnumItems,
   Z as parseAndFormatName,
   rt as parseColor,
-  xt as parseFilename,
+  yt as parseFilename,
   ee as parseHtmlToPlainTextWithLinks,
   Ee as parseSearchQuery,
   dt as parseUri,
@@ -146,19 +149,19 @@ export {
   Ge as pluralize,
   D as replaceRoot,
   st as rgbToHex,
-  je as sanitizeProductName,
+  Ye as sanitizeProductName,
   De as serializeViewSorting,
   k as setActiveEntities,
   Et as shouldBlockShortcuts,
-  he as sortKeysDeep,
+  Te as sortKeysDeep,
   Le as subscribeToThumbnailUpdates,
-  Te as toDropdownErrorText,
+  he as toDropdownErrorText,
   H as useActiveEntities,
   K as useRegisterActiveEntities,
   gt as useStagingModeState,
   Ue as validateEntityId,
-  qe as validateFormData,
-  Je as validateProductName,
-  Qe as validateVersion,
+  je as validateFormData,
+  qe as validateProductName,
+  Je as validateVersion,
   we as waitForRealtimeJitter
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ynput/ayon-frontend-shared",
-  "version": "0.6.6",
+  "version": "0.6.8",
   "description": "Shared React components for AYON frontend",
   "module": "dist/index.es.js",
   "exports": {
@@ -137,7 +137,7 @@
     "@tanstack/react-virtual": "3.13.23",
     "@uiw/react-textarea-code-editor": "2.1.9",
     "@ynput/ayon-player": "1.0.2",
-    "@ynput/ayon-react-components": "^1.21.0",
+    "@ynput/ayon-react-components": "^1.22.0",
     "axios": "1.20.0",
     "clsx": "2.1.1",
     "custom-protocol-check": "1.4.0",