@tridion-sites/extensions 2.0.1 → 2.0.2

package/dist/dts/api/general/mutations/useUploadMultimediaMutation.d.ts

@@ -0,0 +1,52 @@
+import type { ApiError, ItemUri, Link } from '@tridion-sites/models';
+import type { MutationOptions } from './mutationOptions';
+import type { MutationResult } from './mutationResult';
+/**
+ * @public
+ */
+export interface UploadMultimediaRequest {
+    /**
+     * Files to upload.
+     */
+    files: ReadonlyArray<File>;
+    /**
+     * ID of a Folder to upload files to.
+     */
+    containerId: ItemUri;
+    /**
+     * ID of a schema to create components based on.
+     */
+    schemaId?: ItemUri;
+}
+/**
+ * @public
+ */
+export interface MultimediaUploadResult {
+    /**
+     * Link to the created component with uploaded File.
+     */
+    componentLink?: Link;
+    /**
+     * In case `componentLink` is not created error will be fulfilled.
+     */
+    error?: ApiError | Error;
+}
+/**
+ * @public
+ */
+export interface UploadMultimediaMutationResult {
+    /**
+     * ID of the upload process.
+     */
+    processId: string;
+    /**
+     * Results for completed uploads.
+     *
+     * Result is mapped to uploaded file name.
+     */
+    resultsPerFile: Map<string, MultimediaUploadResult>;
+}
+/**
+ * @public
+ */
+export type UploadMultimediaMutationHook = (options?: MutationOptions<UploadMultimediaMutationResult, ApiError, UploadMultimediaRequest>) => MutationResult<UploadMultimediaMutationResult, ApiError, UploadMultimediaRequest>;

package/dist/dts/api/general/mutations/workflow/index.d.ts

@@ -0,0 +1,9 @@
+export * from './useAssignActivitiesMutation';
+export * from './useAssignActivityMutation';
+export * from './useFinishActivityMutation';
+export * from './useFinishActivitiesMutation';
+export * from './useRestartActivitiesMutation';
+export * from './useRestartActivityMutation';
+export * from './useStartActivitiesMutation';
+export * from './useStartActivityMutation';
+export * from './useStartWorkflowMutation';

package/dist/dts/api/general/mutations/workflow/useAssignActivitiesMutation.d.ts

@@ -0,0 +1,20 @@
+import type { ApiError, Batch, ItemUri } from '@tridion-sites/models';
+import type { BatchMutationOptions } from '../batchMutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface AssignActivitiesRequest {
+    /**
+     * The IDs of the ActivityInstances that will be assigned.
+     */
+    itemIds: ReadonlyArray<ItemUri>;
+    /**
+     * User or Group ID to assign ActivityInstances to.
+     */
+    newAssigneeId: ItemUri;
+}
+/**
+ * @public
+ */
+export type AssignActivitiesMutationHook = (options?: BatchMutationOptions<AssignActivitiesRequest>) => MutationResult<Batch, ApiError, AssignActivitiesRequest>;

package/dist/dts/api/general/mutations/workflow/useAssignActivityMutation.d.ts

@@ -0,0 +1,20 @@
+import type { ActivityInstance, ApiError, ItemUri } from '@tridion-sites/models';
+import type { MutationOptions } from '../mutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface AssignActivityRequest {
+    /**
+     * ID of an Activity Instance to change assignment for.
+     */
+    activityId: ItemUri;
+    /**
+     * User or Group ID to assign ActivityInstances to.
+     */
+    newAssigneeId: ItemUri;
+}
+/**
+ * @public
+ */
+export type AssignActivityMutationHook = (options?: MutationOptions<ActivityInstance, ApiError, AssignActivityRequest>) => MutationResult<ActivityInstance, ApiError, AssignActivityRequest>;

package/dist/dts/api/general/mutations/workflow/useFinishActivitiesMutation.d.ts

@@ -0,0 +1,39 @@
+import type { ActivityInstance, ApiError, Batch, Link } from '@tridion-sites/models';
+import type { MutationOptions } from '../mutationOptions';
+/**
+ * @public
+ */
+export interface FinishActivitiesRequestData {
+    /**
+     * Array of Activity Instances to finish activity for.
+     */
+    activityInstances: ReadonlyArray<ActivityInstance>;
+    /**
+     * In case of choice fork Activity ID can be specified to be next one.
+     */
+    nextActivity?: Link;
+    /**
+     * User comment that will be added to finished Activity Instances.
+     */
+    message?: string;
+}
+/**
+ * @public
+ */
+export interface FinishActivitiesRequest {
+    requestData: ReadonlyArray<FinishActivitiesRequestData>;
+}
+/**
+ * @public
+ */
+export type FinishActivitiesMutationOptions = MutationOptions<Batch[], ApiError, FinishActivitiesRequest>;
+/**
+ * @public
+ */
+export interface FinishActivitiesHookResult {
+    mutateAsync: ({ requestData }: FinishActivitiesRequest) => Promise<Batch[]>;
+}
+/**
+ * @public
+ */
+export type FinishActivitiesMutationHook = (options?: FinishActivitiesMutationOptions) => FinishActivitiesHookResult;

package/dist/dts/api/general/mutations/workflow/useFinishActivityMutation.d.ts

@@ -0,0 +1,24 @@
+import type { ApiError, FinishActivityResult, ItemUri, Link } from '@tridion-sites/models';
+import type { MutationOptions } from '../mutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface FinishActivityRequest {
+    /**
+     * ID of the Activity Instance to finish.
+     */
+    activityId: ItemUri;
+    /**
+     * In case of choice fork Activity ID can be specified to be next one.
+     */
+    nextActivity?: Link;
+    /**
+     * User comment that will be added to finished Activity Instances.
+     */
+    message?: string;
+}
+/**
+ * @public
+ */
+export type FinishActivityMutationHook = (options?: MutationOptions<FinishActivityResult, ApiError, FinishActivityRequest>) => MutationResult<FinishActivityResult, ApiError, FinishActivityRequest>;

package/dist/dts/api/general/mutations/workflow/useRestartActivitiesMutation.d.ts

@@ -0,0 +1,16 @@
+import type { ActivityInstance, ApiError, Batch } from '@tridion-sites/models';
+import type { BatchMutationOptions } from '../batchMutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface RestartActivitiesRequest {
+    /**
+     * Array of Activity Instances to restart.
+     */
+    activityInstances: ReadonlyArray<ActivityInstance>;
+}
+/**
+ * @public
+ */
+export type RestartActivitiesMutationHook = (options?: BatchMutationOptions<RestartActivitiesRequest>) => MutationResult<Batch, ApiError, RestartActivitiesRequest>;

package/dist/dts/api/general/mutations/workflow/useRestartActivityMutation.d.ts

@@ -0,0 +1,16 @@
+import type { ActivityInstance, ApiError, ItemUri } from '@tridion-sites/models';
+import type { MutationOptions } from '../mutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface RestartActivityRequest {
+    /**
+     * Activity Instance ID to restart.
+     */
+    activityInstanceId: ItemUri;
+}
+/**
+ * @public
+ */
+export type RestartActivityMutationHook = (options?: MutationOptions<ActivityInstance, ApiError, RestartActivityRequest>) => MutationResult<ActivityInstance, ApiError, RestartActivityRequest>;

package/dist/dts/api/general/mutations/workflow/useStartActivitiesMutation.d.ts

@@ -0,0 +1,16 @@
+import type { ActivityInstance, ApiError, Batch } from '@tridion-sites/models';
+import type { BatchMutationOptions } from '../batchMutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface StartActivitiesRequest {
+    /**
+     * Array of Activity Instances to start.
+     */
+    activityInstances: ReadonlyArray<ActivityInstance>;
+}
+/**
+ * @public
+ */
+export type StartActivitiesMutationHook = (options?: BatchMutationOptions<StartActivitiesRequest>) => MutationResult<Batch, ApiError, StartActivitiesRequest>;

package/dist/dts/api/general/mutations/workflow/useStartActivityMutation.d.ts

@@ -0,0 +1,16 @@
+import type { ActivityInstance, ApiError, ItemUri } from '@tridion-sites/models';
+import type { MutationOptions } from '../mutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface StartActivityRequest {
+    /**
+     * ID of Activity Instance to start.
+     */
+    activityInstanceId: ItemUri;
+}
+/**
+ * @public
+ */
+export type StartActivityMutationHook = (options?: MutationOptions<ActivityInstance, ApiError, StartActivityRequest>) => MutationResult<ActivityInstance, ApiError, StartActivityRequest>;

package/dist/dts/api/general/mutations/workflow/useStartWorkflowMutation.d.ts

@@ -0,0 +1,16 @@
+import type { ApiError, ItemUri, ProcessInstance } from '@tridion-sites/models';
+import type { MutationOptions } from '../mutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface StartWorkflowRequest {
+    /**
+     * ID of an item to start workflow for.
+     */
+    itemId: ItemUri;
+}
+/**
+ * @public
+ */
+export type StartWorkflowMutationHook = (options?: MutationOptions<ProcessInstance, ApiError, StartWorkflowRequest>) => MutationResult<ProcessInstance, ApiError, StartWorkflowRequest>;

package/dist/dts/api/general/queries/index.d.ts

@@ -0,0 +1,10 @@
+export * from './item';
+export * from './lists';
+export * from './publishing';
+export * from './search';
+export * from './translation';
+export * from './workflow';
+export * from './loadingState';
+export * from './queryOptions';
+export * from './queryResult';
+export * from './useUserProfileQuery';

package/dist/dts/api/general/queries/item/index.d.ts

@@ -0,0 +1,14 @@
+export * from './useItemBlueprintHierarchyQuery';
+export * from './useItemChildrenQuery';
+export * from './useItemClassifiedItemsQuery';
+export * from './useItemDefaultDataQuery';
+export * from './useItemHistoryQuery';
+export * from './useItemPublishedPagesQuery';
+export * from './useItemPublishedToQuery';
+export * from './useItemPublishUrlsQuery';
+export * from './useItemQuery';
+export * from './useItemsQuery';
+export * from './useItemTranslationInfoQuery';
+export * from './useItemUsedByQuery';
+export * from './useItemUsesQuery';
+export * from './usePublicationBlueprintHierarchyQuery';

package/dist/dts/api/general/queries/item/useItemBlueprintHierarchyQuery.d.ts

@@ -0,0 +1,20 @@
+import type { ApiError, ItemBlueprintHierarchy, ItemUri, ListDetailsLevel } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export interface ItemBlueprintHierarchyQueryProps {
+    /**
+     * Identifies the item for which Blueprint hierarchy is being retrieved.
+     */
+    itemId: ItemUri;
+    /**
+     * Option to control how much data is returned per item.
+     */
+    detailsLevel?: ListDetailsLevel;
+}
+/**
+ * @public
+ */
+export type ItemBlueprintHierarchyQueryHook = (props: ItemBlueprintHierarchyQueryProps | undefined, options?: QueryOptions<ItemBlueprintHierarchy | undefined, ApiError>) => QueryResult<ItemBlueprintHierarchy | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemChildrenQuery.d.ts

@@ -0,0 +1,20 @@
+import type { ApiError, ItemUri, RepositoryLocalObject } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export interface ItemChildrenQueryProps {
+    /**
+     * The Item URI of an organizational item, such as a Bundle, Category, Folder, Virtual folder, or Structure Group.
+     */
+    itemId: ItemUri;
+    /**
+     * Loads a dynamic version (if available for the current user)
+     */
+    useDynamicVersion?: boolean;
+}
+/**
+ * @public
+ */
+export type ItemChildrenQueryHook = (props: ItemChildrenQueryProps | undefined, options?: QueryOptions<ReadonlyArray<RepositoryLocalObject> | undefined, ApiError>) => QueryResult<ReadonlyArray<RepositoryLocalObject> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemClassifiedItemsQuery.d.ts

@@ -0,0 +1,33 @@
+import type { ApiError, ItemUri, RepositoryLocalObject, RloItemType } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export interface ItemClassifiedItemsQueryProps {
+    /**
+     * The URI of a Keyword or Concept.
+     */
+    keywordId: ItemUri;
+    /**
+     * Loads a dynamic version (if available for the current user).
+     */
+    useDynamicVersion?: boolean;
+    /**
+     * The item types of all repository-local objects that you want to include in the response.
+     */
+    rloItemTypes?: ReadonlyArray<RloItemType>;
+    /**
+     * A boolean value to indicate whether to include descendant keywords in the results.
+     */
+    resolveDescendantKeywords?: boolean;
+    /**
+     * An integer value to limit the number of items returned in the list.
+     * Specify a positive value as the limit or -1 for no limit. Setting the value to zero will return an empty list.
+     */
+    resultLimit?: number;
+}
+/**
+ * @public
+ */
+export type ItemClassifiedItemsQueryHook = (props: ItemClassifiedItemsQueryProps | undefined, options?: QueryOptions<ReadonlyArray<RepositoryLocalObject> | undefined, ApiError>) => QueryResult<ReadonlyArray<RepositoryLocalObject> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemDefaultDataQuery.d.ts

@@ -0,0 +1,26 @@
+import type { ApiError, IdentifiableObject, ItemType, ItemUri } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * Model type for which default data can be retrieved.
+ *
+ * @public
+ */
+export type DefaultModelType = Extract<ItemType, 'bundle' | 'searchFolder' | 'schema' | 'page' | 'pageTemplate' | 'component' | 'componentTemplate' | 'folder' | 'keyword' | 'structureGroup' | 'templateBuildingBlock' | 'publication' | 'keywordCategory' | 'userGroup' | 'processDefinition' | 'businessProcessType' | 'multimediaType' | 'user' | 'targetGroup'>;
+/**
+ * @public
+ */
+export interface ItemDefaultDataQueryProps {
+    /**
+     * Type of the model to get default data for.
+     */
+    modelType: DefaultModelType;
+    /**
+     * A container ID is required for all types except the following: `Batch`, `Publication`, `PublicationTarget`, `PublishTransaction`, `TargetType`, `MultimediaType`, `WorkflowType`, `User`, `Group`, and `ApprovalStatus`.
+     */
+    containerId?: ItemUri;
+}
+/**
+ * @public
+ */
+export type ItemDefaultDataQueryHook = <TItem extends IdentifiableObject>(props: ItemDefaultDataQueryProps | undefined, options?: QueryOptions<TItem | undefined, ApiError>) => QueryResult<TItem | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemHistoryQuery.d.ts

@@ -0,0 +1,16 @@
+import type { ApiError, ItemUri, VersionedItem } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export interface ItemHistoryQueryProps {
+    /**
+     * Identifies the item for which History is being retrieved.
+     */
+    itemId: ItemUri;
+}
+/**
+ * @public
+ */
+export type ItemHistoryQueryHook = (props: ItemHistoryQueryProps | undefined, options?: QueryOptions<ReadonlyArray<VersionedItem> | undefined, ApiError>) => QueryResult<ReadonlyArray<VersionedItem> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemPublishUrlsQuery.d.ts

@@ -0,0 +1,16 @@
+import type { ApiError, ItemUri, PublishUrlInfo } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export interface ItemPublishUrlsQueryProps {
+    /**
+     * Identifies the item for which Publish URLs are being retrieved.
+     */
+    itemId: ItemUri;
+}
+/**
+ * @public
+ */
+export type ItemPublishUrlsQueryHook = (props: ItemPublishUrlsQueryProps | undefined, options?: QueryOptions<ReadonlyArray<PublishUrlInfo> | undefined, ApiError>) => QueryResult<ReadonlyArray<PublishUrlInfo> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemPublishedPagesQuery.d.ts

@@ -0,0 +1,16 @@
+import type { ApiError, ItemUri, Page } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export interface ItemPublishedPagesQueryProps {
+    /**
+     * Identifies the item for which published pages will be requested.
+     */
+    itemId: ItemUri;
+}
+/**
+ * @public
+ */
+export type ItemPublishedPagesQueryHook = (props: ItemPublishedPagesQueryProps | undefined, options?: QueryOptions<ReadonlyArray<Page> | undefined, ApiError>) => QueryResult<ReadonlyArray<Page> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemPublishedToQuery.d.ts

@@ -0,0 +1,16 @@
+import type { ApiError, ItemUri, PublishInfo } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export interface ItemPublishedToQueryProps {
+    /**
+     * ID of the published item.
+     */
+    itemId: ItemUri;
+}
+/**
+ * @public
+ */
+export type ItemPublishedToQueryHook = (props: ItemPublishedToQueryProps | undefined, options?: QueryOptions<ReadonlyArray<PublishInfo> | undefined, ApiError>) => QueryResult<ReadonlyArray<PublishInfo> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemQuery.d.ts

@@ -0,0 +1,20 @@
+import type { ApiError, IdentifiableObject, ItemUri } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export interface ItemQueryProps {
+    /**
+     * ID of an item to get.
+     */
+    itemId: ItemUri;
+    /**
+     * Option to request dynamic item (v0) if it's available.
+     */
+    useDynamicVersion?: boolean;
+}
+/**
+ * @public
+ */
+export type ItemQueryHook = <TItem extends IdentifiableObject>(props: ItemQueryProps | undefined, options?: QueryOptions<TItem | undefined, ApiError>) => QueryResult<TItem | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemTranslationInfoQuery.d.ts

@@ -0,0 +1,16 @@
+import type { ApiError, ItemUri, TranslationInfo } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export interface ItemTranslationInfoQueryProps {
+    /**
+     * Identifies the item for which Translation Info is being retrieved.
+     */
+    itemId: ItemUri;
+}
+/**
+ * @public
+ */
+export type ItemTranslationInfoQueryHook = (props: ItemTranslationInfoQueryProps | undefined, options?: QueryOptions<TranslationInfo | undefined, ApiError>) => QueryResult<TranslationInfo | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemUsedByQuery.d.ts

@@ -0,0 +1,25 @@
+import type { ApiError, IdentifiableObject, ItemUri } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export interface ItemUsedByQueryProps {
+    /**
+     * Identifies the item for which 'Used By' dependencies are being retrieved.
+     */
+    itemId: ItemUri;
+    /**
+     * Set to true to include local copies of the specified item in the response.
+     */
+    includeLocalCopies?: boolean;
+    /**
+     * To limit the response to items that currently use the specified item,
+     * set this option to `true`.
+     */
+    onlyLatestVersion?: boolean;
+}
+/**
+ * @public
+ */
+export type ItemUsedByQueryHook = <TItem extends IdentifiableObject>(props: ItemUsedByQueryProps | undefined, options?: QueryOptions<ReadonlyArray<TItem> | undefined, ApiError>) => QueryResult<ReadonlyArray<TItem> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemUsesQuery.d.ts

@@ -0,0 +1,21 @@
+import type { ApiError, IdentifiableObject, ItemUri } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export interface ItemUsesQueryProps {
+    /**
+     * Identifies the item for which 'Uses' dependencies are being retrieved.
+     */
+    itemId: ItemUri;
+    /**
+     * To include the BluePrint parent of a local copy in the response,
+     * set this option to `true`.
+     */
+    includeBlueprintParentItem?: boolean;
+}
+/**
+ * @public
+ */
+export type ItemUsesQueryHook = <TItem extends IdentifiableObject>(props: ItemUsesQueryProps | undefined, options?: QueryOptions<ReadonlyArray<TItem> | undefined, ApiError>) => QueryResult<ReadonlyArray<TItem> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemsQuery.d.ts

@@ -0,0 +1,28 @@
+import type { ApiError, IdentifiableObject, ItemUri } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export interface ItemsQueryProps {
+    /**
+     * IDs of items to request.
+     */
+    itemIds: ReadonlyArray<ItemUri>;
+    /**
+     * Option to request dynamic item (v0) if it's available.
+     */
+    useDynamicVersion?: boolean;
+    /**
+     * By default list includes contentless items. Some of the properties might be missed.
+     * This option allows to include all available fields.
+     *
+     * @example
+     * When `false` - Component item will be returned without `content` property.
+     */
+    loadFullItems?: boolean;
+}
+/**
+ * @public
+ */
+export type ItemsQueryHook = <TItem extends IdentifiableObject>(props: ItemsQueryProps | undefined, options?: QueryOptions<ReadonlyArray<TItem> | undefined, ApiError>) => QueryResult<ReadonlyArray<TItem> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/usePublicationBlueprintHierarchyQuery.d.ts

@@ -0,0 +1,20 @@
+import type { ApiError, ItemUri, ListDetailsLevel, PublicationBlueprintHierarchy } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export interface PublicationBlueprintHierarchyQueryProps {
+    /**
+     * Identifies the item for which Blueprint hierarchy is being retrieved.
+     */
+    publicationId: ItemUri;
+    /**
+     * Option to control how much data is returned per item.
+     */
+    detailsLevel?: ListDetailsLevel;
+}
+/**
+ * @public
+ */
+export type PublicationBlueprintHierarchyQueryHook = (props: PublicationBlueprintHierarchyQueryProps | undefined, options?: QueryOptions<PublicationBlueprintHierarchy | undefined, ApiError>) => QueryResult<PublicationBlueprintHierarchy | undefined, ApiError>;

package/dist/dts/api/general/queries/lists/index.d.ts

@@ -0,0 +1,6 @@
+export * from './useContainerItems';
+export * from './useFavoritesQuery';
+export * from './useItemsInProgressQuery';
+export * from './usePublicationsQuery';
+export * from './useUserGroupsQuery';
+export * from './useUsersQuery';

package/dist/dts/api/general/queries/lists/useContainerItems.d.ts

@@ -0,0 +1,32 @@
+import type { ApiError, ItemUri, ListDetailsLevel, RepositoryLocalObject, RloItemType } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export interface ContainerItemsQueryProps {
+    /**
+     * The Item URI of an organizational item, such as a Bundle, Category, Folder, Virtual folder, or Structure Group.
+     */
+    itemId: ItemUri;
+    /**
+     * Loads a dynamic version (if available for the current user)
+     */
+    useDynamicVersion?: boolean;
+    /**
+     * The item types of all repository-local objects that you want to include in the response.
+     */
+    rloItemTypes?: ReadonlyArray<RloItemType>;
+    /**
+     * Option to control how much data is returned per item.
+     */
+    detailsLevel?: ListDetailsLevel;
+    /**
+     * Determines if nested Organizational Items (recursively) should also be returned.
+     */
+    isRecursive?: boolean;
+}
+/**
+ * @public
+ */
+export type ContainerItemsQueryHook = (props?: ContainerItemsQueryProps, options?: QueryOptions<ReadonlyArray<RepositoryLocalObject> | undefined, ApiError>) => QueryResult<ReadonlyArray<RepositoryLocalObject> | undefined, ApiError>;

package/dist/dts/api/general/queries/lists/useFavoritesQuery.d.ts

@@ -0,0 +1,7 @@
+import type { ApiError, IdentifiableObject } from '@tridion-sites/models';
+import type { QueryOptions } from '../queryOptions';
+import type { QueryResult } from '../queryResult';
+/**
+ * @public
+ */
+export type FavoritesQueryHook = (options?: QueryOptions<ReadonlyArray<IdentifiableObject> | undefined, ApiError>) => QueryResult<ReadonlyArray<IdentifiableObject> | undefined, ApiError>;