@ynput/ayon-frontend-shared 0.2.23 → 0.2.24

package/dist/types/api/queries/entityLists/types.d.ts

@@ -29,24 +29,24 @@ type ItemNodeData = {
     taskType?: string;
     folderType?: string;
     productType?: string;
+    parentId?: string;
+    folderId?: string;
     assignees?: string[];
     label?: string;
     ownAttrib: string[];
-    path?: string;
+    parents?: string[];
     folder?: {
-        path: string;
         folderType: string;
     };
     product?: {
-        name: string;
+        folderId?: string;
         productType: string;
         folder: {
-            path: string;
             folderType: string;
         };
     };
     task?: {
-        name: string;
+        folderId?: string;
         taskType: string;
     };
 };

package/dist/types/api/queries/index.d.ts

@@ -8,6 +8,7 @@ export * from './entities';
 export * from './entityLists';
 export * from './folders';
 export * from './grouping';
+export * from './links';
 export * from './overview';
 export * from './permissions';
 export * from './products';

package/dist/types/api/queries/links/getEntityLinks.d.ts

@@ -0,0 +1,182 @@
+import { FetchBaseQueryError } from '@reduxjs/toolkit/query';
+import { GetFoldersLinksQuery, GetTasksLinksQuery, GetProductsLinksQuery, GetVersionsLinksQuery, GetRepresentationsLinksQuery, GetWorkfilesLinksQuery } from '../../generated';
+/**
+ * Custom queryFn for fetching entity links with optimized caching behavior.
+ *
+ * Key features:
+ * 1. Single cache per project and entity type - different entityIds combinations don't create new caches
+ * 2. Skips fetching entities that are already cached
+ * 3. Force refetch when entityIds change
+ * 4. Merges new entities into cache without duplicates
+ * 5. Supports all entity types: folders, tasks, products, versions, representations, workfiles
+ */
+export type GetEntityLinksArgs = {
+    projectName: string;
+    entityIds: string[];
+    entityType: 'folder' | 'task' | 'product' | 'version' | 'representation' | 'workfile';
+};
+export type FolderLink = GetFoldersLinksQuery['project']['folders']['edges'][0]['node']['links']['edges'][0];
+export type TaskLink = GetTasksLinksQuery['project']['tasks']['edges'][0]['node']['links']['edges'][0];
+export type ProductLink = GetProductsLinksQuery['project']['products']['edges'][0]['node']['links']['edges'][0];
+export type VersionLink = GetVersionsLinksQuery['project']['versions']['edges'][0]['node']['links']['edges'][0];
+export type RepresentationLink = GetRepresentationsLinksQuery['project']['representations']['edges'][0]['node']['links']['edges'][0];
+export type WorkfileLink = GetWorkfilesLinksQuery['project']['workfiles']['edges'][0]['node']['links']['edges'][0];
+export type EntityLinkQuery = FolderLink | TaskLink | ProductLink | VersionLink | RepresentationLink | WorkfileLink;
+export type EntityLink = Pick<EntityLinkQuery, 'direction' | 'entityType' | 'id' | 'linkType'> & {
+    node: Pick<EntityLinkQuery['node'], 'name' | 'id'> & {
+        label?: string | null;
+        parents: string[];
+        subType: string | undefined;
+    };
+};
+export type EntityWithLinks = {
+    id: string;
+    links: EntityLink[];
+};
+export type GetEntityLinksResult = EntityWithLinks[];
+declare const injectedQueries: import('@reduxjs/toolkit/query').Api<import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, {
+    getFolder: import('@reduxjs/toolkit/query').QueryDefinition<import('../../generated').GetFolderApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, import('../../generated').FolderModel, "restApi", unknown>;
+    deleteFolder: import('@reduxjs/toolkit/query').MutationDefinition<import('../../generated').DeleteFolderApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, unknown, "restApi", unknown>;
+    updateFolder: import('@reduxjs/toolkit/query').MutationDefinition<import('../../generated').UpdateFolderApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, unknown, "restApi", unknown>;
+    getFolderList: import('@reduxjs/toolkit/query').QueryDefinition<import('../../generated').GetFolderListApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, import('../../generated').FolderListModel, "restApi", unknown>;
+    createFolder: import('@reduxjs/toolkit/query').MutationDefinition<import('../../generated').CreateFolderApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, import('../../generated').EntityIdResponse, "restApi", unknown>;
+    getFolderHierarchy: import('@reduxjs/toolkit/query').QueryDefinition<import('../../generated').GetFolderHierarchyApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, import('../../generated').HierarchyResponseModel, "restApi", unknown>;
+    getFolderThumbnail: import('@reduxjs/toolkit/query').QueryDefinition<import('../../generated').GetFolderThumbnailApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, any, "restApi", unknown>;
+    createFolderThumbnail: import('@reduxjs/toolkit/query').MutationDefinition<import('../../generated').CreateFolderThumbnailApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, import('../../generated').CreateThumbnailResponseModel, "restApi", unknown>;
+} & {
+    getEntityLinks: import('@reduxjs/toolkit/query').QueryDefinition<GetEntityLinksArgs, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, GetEntityLinksResult, "restApi", unknown>;
+}, "restApi", string, typeof import('@reduxjs/toolkit/query').coreModuleName | typeof import('@reduxjs/toolkit/dist/query/react').reactHooksModuleName>;
+export declare const useGetEntityLinksQuery: <R extends Record<string, any> = import('@reduxjs/toolkit/query').TSHelpersId<(Omit<{
+    status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+    originalArgs?: undefined | undefined;
+    data?: undefined | undefined;
+    error?: undefined | undefined;
+    requestId?: undefined | undefined;
+    endpointName?: string | undefined;
+    startedTimeStamp?: undefined | undefined;
+    fulfilledTimeStamp?: undefined | undefined;
+} & {
+    currentData?: GetEntityLinksResult | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "isUninitialized"> & {
+    isUninitialized: true;
+}) | import('@reduxjs/toolkit/query').TSHelpersOverride<import('@reduxjs/toolkit/query').QuerySubState<import('@reduxjs/toolkit/query').QueryDefinition<GetEntityLinksArgs, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, GetEntityLinksResult, "restApi", unknown>> & {
+    currentData?: GetEntityLinksResult | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, {
+    isLoading: true;
+    isFetching: boolean;
+    data: undefined;
+} | ({
+    isSuccess: true;
+    isFetching: true;
+    error: undefined;
+} & Required<Pick<import('@reduxjs/toolkit/query').QuerySubState<import('@reduxjs/toolkit/query').QueryDefinition<GetEntityLinksArgs, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, GetEntityLinksResult, "restApi", unknown>> & {
+    currentData?: GetEntityLinksResult | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "data" | "fulfilledTimeStamp">>) | ({
+    isSuccess: true;
+    isFetching: false;
+    error: undefined;
+} & Required<Pick<import('@reduxjs/toolkit/query').QuerySubState<import('@reduxjs/toolkit/query').QueryDefinition<GetEntityLinksArgs, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, GetEntityLinksResult, "restApi", unknown>> & {
+    currentData?: GetEntityLinksResult | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
+    isError: true;
+} & Required<Pick<import('@reduxjs/toolkit/query').QuerySubState<import('@reduxjs/toolkit/query').QueryDefinition<GetEntityLinksArgs, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, GetEntityLinksResult, "restApi", unknown>> & {
+    currentData?: GetEntityLinksResult | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "error">>)>> & {
+    status: import('@reduxjs/toolkit/query').QueryStatus;
+}>(arg: typeof import('@reduxjs/toolkit/query').skipToken | GetEntityLinksArgs, options?: (import('@reduxjs/toolkit/query').SubscriptionOptions & {
+    skip?: boolean;
+    refetchOnMountOrArgChange?: boolean | number;
+} & {
+    skip?: boolean;
+    selectFromResult?: ((state: import('@reduxjs/toolkit/query').TSHelpersId<(Omit<{
+        status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+        originalArgs?: undefined | undefined;
+        data?: undefined | undefined;
+        error?: undefined | undefined;
+        requestId?: undefined | undefined;
+        endpointName?: string | undefined;
+        startedTimeStamp?: undefined | undefined;
+        fulfilledTimeStamp?: undefined | undefined;
+    } & {
+        currentData?: GetEntityLinksResult | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "isUninitialized"> & {
+        isUninitialized: true;
+    }) | import('@reduxjs/toolkit/query').TSHelpersOverride<import('@reduxjs/toolkit/query').QuerySubState<import('@reduxjs/toolkit/query').QueryDefinition<GetEntityLinksArgs, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, GetEntityLinksResult, "restApi", unknown>> & {
+        currentData?: GetEntityLinksResult | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, {
+        isLoading: true;
+        isFetching: boolean;
+        data: undefined;
+    } | ({
+        isSuccess: true;
+        isFetching: true;
+        error: undefined;
+    } & Required<Pick<import('@reduxjs/toolkit/query').QuerySubState<import('@reduxjs/toolkit/query').QueryDefinition<GetEntityLinksArgs, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, GetEntityLinksResult, "restApi", unknown>> & {
+        currentData?: GetEntityLinksResult | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "data" | "fulfilledTimeStamp">>) | ({
+        isSuccess: true;
+        isFetching: false;
+        error: undefined;
+    } & Required<Pick<import('@reduxjs/toolkit/query').QuerySubState<import('@reduxjs/toolkit/query').QueryDefinition<GetEntityLinksArgs, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, GetEntityLinksResult, "restApi", unknown>> & {
+        currentData?: GetEntityLinksResult | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
+        isError: true;
+    } & Required<Pick<import('@reduxjs/toolkit/query').QuerySubState<import('@reduxjs/toolkit/query').QueryDefinition<GetEntityLinksArgs, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, GetEntityLinksResult, "restApi", unknown>> & {
+        currentData?: GetEntityLinksResult | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "error">>)>> & {
+        status: import('@reduxjs/toolkit/query').QueryStatus;
+    }) => R) | undefined;
+}) | undefined) => [R][R extends any ? 0 : never] & {
+    refetch: () => import('@reduxjs/toolkit/query').QueryActionCreatorResult<import('@reduxjs/toolkit/query').QueryDefinition<GetEntityLinksArgs, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, FetchBaseQueryError>, string, GetEntityLinksResult, "restApi", unknown>>;
+};
+export { injectedQueries as entityLinksApi };