@tridion-sites/extensions 2.0.1 → 2.0.2

package/dist/dts/apiWrappers/general/components.d.ts

@@ -0,0 +1,88 @@
+import type { BlockComponent, ButtonComponent, CenterComponent, FlexComponent, IconComponent, LinkComponent, ModalContentComponent, ModalFooterComponent, ModalHeaderComponent, StackComponent, TextComponent, TextLinkComponent } from "../../api";
+/**
+ * Serves as the base for most components in the system and provides the most commonly used properties
+ * including the className and cssStyle props for custom styling.
+ *
+ * It should rarely be used directly as preference should be given to the more specialized child components.
+ *
+ * @public
+ */
+export declare const Block: BlockComponent;
+/**
+ * A component that has standard button functionality.
+ *
+ * @public
+ */
+export declare const Button: ButtonComponent;
+/**
+ * This components provides a convenient way to center its child components both
+ * vertically and horizontally using a flexbox layout.
+ * (see, for example, https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout).
+ *
+ * It is advisable to construct most of the layout using this component as it allows to freely utilize
+ * "shouldFill" and similar props that rely on the parent being a Flex component.
+ *
+ * @public
+ */
+export declare const Center: CenterComponent;
+/**
+ * The primary building block for layout, based on the principles of the flexible box layout module
+ * (see, for example, https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout).
+ *
+ * It is advisable to construct most of the layout using this component as it allows to freely utilize
+ * "shouldFill" and similar props that rely on the parent being a Flex component.
+ *
+ * @public
+ */
+export declare const Flex: FlexComponent;
+/**
+ * A component used for rendering SVG icons.
+ *
+ * @public
+ */
+export declare const Icon: IconComponent;
+/**
+ * A component to wrap any custom view with Link for navigation
+ *
+ * @public
+ */
+export declare const Link: LinkComponent;
+/**
+ * Allows items to be placed one after another with a user defined separation.
+ *
+ * Items can't have size that depends on Stack's size. This means that it is impossible to make item take available space or
+ * have size in percentage of Stack's size.
+ *
+ * @public
+ */
+export declare const Stack: StackComponent;
+/**
+ * Component which renders text with customizable content and styling.
+ *
+ * @public
+ */
+export declare const Text: TextComponent;
+/**
+ * A component to render Text Link for navigation
+ *
+ * @public
+ */
+export declare const TextLink: TextLinkComponent;
+/**
+ * A component to render Content of a Modal
+ *
+ * @public
+ */
+export declare const ModalContent: ModalContentComponent;
+/**
+ * A component to render Header of the Modal
+ *
+ * @public
+ */
+export declare const ModalHeader: ModalHeaderComponent;
+/**
+ * A component to render Footer of the Modal
+ *
+ * @public
+ */
+export declare const ModalFooter: ModalFooterComponent;

package/dist/dts/apiWrappers/general/globals.d.ts

@@ -0,0 +1,37 @@
+import type { BorderRadiusGetter, ColorPaletteGetter, OpacityLevelGetter, SpacingGetter, TransitionDurationGetter, ZIndexGetter } from "../../api";
+/**
+ * System-predefined border radiuses.
+ *
+ * @public
+ */
+export declare const getBorderRadius: BorderRadiusGetter;
+/**
+ * System-predefined color palette.
+ *
+ * @public
+ */
+export declare const getColorPalette: ColorPaletteGetter;
+/**
+ * System-predefined opacity levels.
+ *
+ * @public
+ */
+export declare const getOpacityLevel: OpacityLevelGetter;
+/**
+ * System-predefined spacings.
+ *
+ * @public
+ */
+export declare const getSpacing: SpacingGetter;
+/**
+ * System-predefined transition duration.
+ *
+ * @public
+ */
+export declare const getTransitionDuration: TransitionDurationGetter;
+/**
+ * System-predefined z-index values.
+ *
+ * @public
+ */
+export declare const getZIndex: ZIndexGetter;

package/dist/dts/apiWrappers/general/hooks.d.ts

@@ -0,0 +1,25 @@
+import type { ConfirmationHook, ModalHookArguments, ModalHookResult, NotificationsHook, UserProfileHook } from "../../api";
+/**
+ * Provides access to data and methods for managing notifications.
+ *
+ * @public
+ */
+export declare const useNotifications: NotificationsHook;
+/**
+ * Provides access to user profile data and methods.
+ *
+ * @public
+ */
+export declare const useUserProfile: UserProfileHook;
+/**
+ * Opens a Confirmation Modal based on the provided options.
+ *
+ * @public
+ */
+export declare const useConfirmation: ConfirmationHook;
+/**
+ * Opens a Modal based on the provided options.
+ *
+ * @public
+ */
+export declare const useModal: <TResultData>(args: ModalHookArguments) => ModalHookResult<TResultData>;

package/dist/dts/apiWrappers/general/index.d.ts

@@ -0,0 +1,5 @@
+export * from './components';
+export * from './globals';
+export * from './hooks';
+export * from './mutations';
+export * from './queries';

package/dist/dts/apiWrappers/general/mutations/generalMutations.d.ts

@@ -0,0 +1,30 @@
+import type { AddToBundleMutationHook, ChangeUserLanguageMutationHook, ChangeUserLocaleMutationHook, RemoveFromBundleMutationHook, UploadMultimediaMutationHook } from "../../../api";
+/**
+ * Uploads multimedia files and creates multimedia components out of them.
+ * Uploading is done using a queue, which limits the number of files being uploaded at the same time.
+ *
+ * @public
+ */
+export declare const useUploadMultimediaMutation: UploadMultimediaMutationHook;
+/**
+ * @public
+ */
+export declare const useAddToBundleMutation: AddToBundleMutationHook;
+/**
+ * Updates the language selection for a given user.
+ *
+ * @public
+ */
+export declare const useChangeUserLanguageMutation: ChangeUserLanguageMutationHook;
+/**
+ * Updates the locale selection for a given user.
+ *
+ * @public
+ */
+export declare const useChangeUserLocaleMutation: ChangeUserLocaleMutationHook;
+/**
+ * Removes a list of items from a given bundle.
+ *
+ * @public
+ */
+export declare const useRemoveFromBundleMutation: RemoveFromBundleMutationHook;

package/dist/dts/apiWrappers/general/mutations/index.d.ts

@@ -0,0 +1,4 @@
+export * from './generalMutations';
+export * from './itemMutations';
+export * from './translationMutations';
+export * from './workflowMutations';

package/dist/dts/apiWrappers/general/mutations/itemMutations.d.ts

@@ -0,0 +1,137 @@
+import type { AutoClassifyItemMutationHook, AutoClassifyItemsMutationHook, CopyItemMutationHook, CopyItemsMutationHook, DeleteItemMutationHook, DeleteItemsMutationHook, DemoteItemMutationHook, DemoteItemsMutationHook, FinishEditingItemMutationHook, FinishEditingItemsMutationHook, LocalizeItemMutationHook, LocalizeItemsMutationHook, MoveItemMutationHook, MoveItemsMutationHook, PublishItemsMutationHook, RevertItemMutationHook, RevertItemsMutationHook, RollbackItemMutationHook, UnlocalizeItemMutationHook, UnlocalizeItemsMutationHook, UnpublishItemsMutationHook, UpdateItemMutationHook } from "../../../api";
+/**
+ * Classifies a single item based on its content and metadata.
+ *
+ * @public
+ */
+export declare const useAutoClassifyItemMutation: AutoClassifyItemMutationHook;
+/**
+ * Classifies items based on their content and metadata.
+ *
+ * @public
+ */
+export declare const useAutoClassifyItemsMutation: AutoClassifyItemsMutationHook;
+/**
+ * Copies a single item to the specified destination.
+ *
+ * @public
+ */
+export declare const useCopyItemMutation: CopyItemMutationHook;
+/**
+ * Copies a list of items to the specified destination.
+ *
+ * @public
+ */
+export declare const useCopyItemsMutation: CopyItemsMutationHook;
+/**
+ * Deletes a single item from the system.
+ *
+ * @public
+ */
+export declare const useDeleteItemMutation: DeleteItemMutationHook;
+/**
+ * Deletes a list of items from the system.
+ *
+ * @public
+ */
+export declare const useDeleteItemsMutation: DeleteItemsMutationHook;
+/**
+ * Finishes editing of a checked out versioned item.
+ * Saves changes made in minor version updates and increments the major version of the item.
+ *
+ * @public
+ */
+export declare const useFinishEditingItemMutation: FinishEditingItemMutationHook;
+/**
+ * Finishes editing for checked out versioned items.
+ * Saves changes made in minor version updates and increments the major version of each item.
+ *
+ * @public
+ */
+export declare const useFinishEditingItemsMutation: FinishEditingItemsMutationHook;
+/**
+ * Localizes a shared item by creating a local copy that can then be modified locally.
+ *
+ * @public
+ */
+export declare const useLocalizeItemMutation: LocalizeItemMutationHook;
+/**
+ * Localizes a list of shared items by creating their local copies that can then be modified locally.
+ *
+ * @public
+ */
+export declare const useLocalizeItemsMutation: LocalizeItemsMutationHook;
+/**
+ * Moves a single item from its current location to the specified destination.
+ *
+ * @public
+ */
+export declare const useMoveItemMutation: MoveItemMutationHook;
+/**
+ * Moves a list of items from their current location to the specified destination.
+ *
+ * @public
+ */
+export declare const useMoveItemsMutation: MoveItemsMutationHook;
+/**
+ * Publishes a list of items with provided instructions.
+ *
+ * @public
+ */
+export declare const usePublishItemsMutation: PublishItemsMutationHook;
+/**
+ * Reverts the item to the last major version.
+ * If the item does not have a major version, it is deleted.
+ *
+ * @public
+ */
+export declare const useRevertItemMutation: RevertItemMutationHook;
+/**
+ * Reverts a list of items item to their last major version.
+ * If any of the items do not have a major version, they are deleted.
+ *
+ * @public
+ */
+export declare const useRevertItemsMutation: RevertItemsMutationHook;
+/**
+ * Rolls back all changes that have been made to an item since a specified version.
+ *
+ * @public
+ */
+export declare const useRollbackItemMutation: RollbackItemMutationHook;
+/**
+ * Unlocalizes a single item which removes its local copy from a publication.
+ *
+ * @public
+ */
+export declare const useUnlocalizeItemMutation: UnlocalizeItemMutationHook;
+/**
+ * Unlocalizes a list of items which removes their local copies from a publication.
+ *
+ * @public
+ */
+export declare const useUnlocalizeItemsMutation: UnlocalizeItemsMutationHook;
+/**
+ * Unpublishes a list of items with provided instructions.
+ *
+ * @public
+ */
+export declare const useUnpublishItemsMutation: UnpublishItemsMutationHook;
+/**
+ * Updates an item by URI.
+ *
+ * @public
+ */
+export declare const useUpdateItemMutation: UpdateItemMutationHook;
+/**
+ * Updates an item by URI.
+ *
+ * @public
+ */
+export declare const useDemoteItemMutation: DemoteItemMutationHook;
+/**
+ * Updates an item by URI.
+ *
+ * @public
+ */
+export declare const useDemoteItemsMutation: DemoteItemsMutationHook;

package/dist/dts/apiWrappers/general/mutations/translationMutations.d.ts

@@ -0,0 +1,5 @@
+import type { CreateTranslationJobMutationHook } from "../../../api";
+/**
+ * @public
+ */
+export declare const useCreateTranslationJobMutation: CreateTranslationJobMutationHook;

package/dist/dts/apiWrappers/general/mutations/workflowMutations.d.ts

@@ -0,0 +1,47 @@
+import type { AssignActivitiesMutationHook, AssignActivityMutationHook, FinishActivitiesMutationHook, FinishActivityMutationHook, RestartActivitiesMutationHook, RestartActivityMutationHook, StartActivitiesMutationHook, StartActivityMutationHook, StartWorkflowMutationHook } from "../../../api";
+/**
+ * Assigns a list of activities to a new User or Group.
+ *
+ * @public
+ */
+export declare const useAssignActivitiesMutation: AssignActivitiesMutationHook;
+/**
+ * Assigns a single activity to a new User or Group.
+ *
+ * @public
+ */
+export declare const useAssignActivityMutation: AssignActivityMutationHook;
+/**
+ * @public
+ */
+export declare const useFinishActivityMutation: FinishActivityMutationHook;
+/**
+ * @public
+ */
+export declare const useFinishActivitiesMutation: FinishActivitiesMutationHook;
+/**
+ * Restarts failed activities.
+ *
+ * @public
+ */
+export declare const useRestartActivitiesMutation: RestartActivitiesMutationHook;
+/**
+ * Restarts an activity which is failed.
+ *
+ * @public
+ */
+export declare const useRestartActivityMutation: RestartActivityMutationHook;
+/**
+ * @public
+ */
+export declare const useStartActivitiesMutation: StartActivitiesMutationHook;
+/**
+ * @public
+ */
+export declare const useStartActivityMutation: StartActivityMutationHook;
+/**
+ * Starts a new workflow and associates the bundle and all items inside it with that workflow instance.
+ *
+ * @public
+ */
+export declare const useStartWorkflowMutation: StartWorkflowMutationHook;

package/dist/dts/apiWrappers/general/queries/generalQueries.d.ts

@@ -0,0 +1,7 @@
+import type { UserProfileQueryHook } from "../../../api";
+/**
+ * Retrieves user profile data of the currently logged-in user.
+ *
+ * @public
+ */
+export declare const useUserProfileQuery: UserProfileQueryHook;

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

@@ -0,0 +1,7 @@
+export * from './generalQueries';
+export * from './itemQueries';
+export * from './listsQueries';
+export * from './publishingQueries';
+export * from './searchQueries';
+export * from './translationQueries';
+export * from './workflowQueries';

package/dist/dts/apiWrappers/general/queries/itemQueries.d.ts

@@ -0,0 +1,85 @@
+import type { ItemBlueprintHierarchyQueryHook, ItemChildrenQueryHook, ItemClassifiedItemsQueryHook, ItemDefaultDataQueryHook, ItemHistoryQueryHook, ItemPublishedPagesQueryHook, ItemPublishedToQueryHook, ItemPublishUrlsQueryHook, ItemQueryHook, ItemsQueryHook, ItemTranslationInfoQueryHook, ItemUsedByQueryHook, ItemUsesQueryHook, PublicationBlueprintHierarchyQueryHook } from "../../../api";
+/**
+ * Retrieves the context of the provided item within the BluePrint hierarchy.
+ *
+ * @public
+ */
+export declare const useItemBlueprintHierarchyQuery: ItemBlueprintHierarchyQueryHook;
+/**
+ * Retrieves a list of child items for the provided organizational item.
+ *
+ * @public
+ */
+export declare const useItemChildrenQuery: ItemChildrenQueryHook;
+/**
+ * Retrieves a list of items classified with the provided Keyword or Concept.
+ *
+ * @public
+ */
+export declare const useItemClassifiedItemsQuery: ItemClassifiedItemsQueryHook;
+/**
+ * Retrieves the default model for the provided model type.
+ *
+ * @public
+ */
+export declare const useItemDefaultDataQuery: ItemDefaultDataQueryHook;
+/**
+ * Retrieves a list of major versions of the provided versioned item.
+ *
+ * @public
+ */
+export declare const useItemHistoryQuery: ItemHistoryQueryHook;
+/**
+ * Retrieves a list of published pages that use the provided item.
+ *
+ * @public
+ */
+export declare const useItemPublishedPagesQuery: ItemPublishedPagesQueryHook;
+/**
+ * Retrieves a list of targets to which the provided item is published.
+ *
+ * @public
+ */
+export declare const useItemPublishedToQuery: ItemPublishedToQueryHook;
+/**
+ * Retrieves a list of URLs where the provided item is published.
+ *
+ * @public
+ */
+export declare const useItemPublishUrlsQuery: ItemPublishUrlsQueryHook;
+/**
+ * Retrieves a single item using the provided item URI.
+ *
+ * @public
+ */
+export declare const useItemQuery: ItemQueryHook;
+/**
+ * Retrieves a list of items using the provided list of item URIs.
+ *
+ * @public
+ */
+export declare const useItemsQuery: ItemsQueryHook;
+/**
+ * Retrieves translation information for the provided item.
+ *
+ * @public
+ */
+export declare const useItemTranslationInfoQuery: ItemTranslationInfoQueryHook;
+/**
+ * Retrieves a list of items that use the provided item.
+ *
+ * @public
+ */
+export declare const useItemUsedByQuery: ItemUsedByQueryHook;
+/**
+ * Retrieves a list of items that are used by the provided item.
+ *
+ * @public
+ */
+export declare const useItemUsesQuery: ItemUsesQueryHook;
+/**
+ * Retrieves the context of the provided publication within the BluePrint hierarchy.
+ *
+ * @public
+ */
+export declare const usePublicationBlueprintHierarchyQuery: PublicationBlueprintHierarchyQueryHook;

package/dist/dts/apiWrappers/general/queries/listsQueries.d.ts

@@ -0,0 +1,25 @@
+import type { ContainerItemsQueryHook, FavoritesQueryHook, ItemsInProgressQueryHook, PublicationsQueryHook, UserGroupsQueryHook, UsersQueryHook } from "../../../api";
+/**
+ * @public
+ */
+export declare const useContainerItems: ContainerItemsQueryHook;
+/**
+ * @public
+ */
+export declare const useFavoritesQuery: FavoritesQueryHook;
+/**
+ * @public
+ */
+export declare const useItemsInProgressQuery: ItemsInProgressQueryHook;
+/**
+ * @public
+ */
+export declare const usePublicationsQuery: PublicationsQueryHook;
+/**
+ * @public
+ */
+export declare const useUserGroupsQuery: UserGroupsQueryHook;
+/**
+ * @public
+ */
+export declare const useUsersQuery: UsersQueryHook;

package/dist/dts/apiWrappers/general/queries/publishingQueries.d.ts

@@ -0,0 +1,19 @@
+import type { ItemsToPublishQueryHook, ItemsToUnpublishQueryHook, PublishableTargetTypesQueryHook } from "../../../api";
+/**
+ * Retrieves a list of items that will be published with the provided instructions.
+ *
+ * @public
+ */
+export declare const useItemsToPublishQuery: ItemsToPublishQueryHook;
+/**
+ * Retrieves a list of items that will be unpublished with the provided instructions.
+ *
+ * @public
+ */
+export declare const useItemsToUnpublishQuery: ItemsToUnpublishQueryHook;
+/**
+ * Retrieves a list of Target Types for the provided Business Process Type.
+ *
+ * @public
+ */
+export declare const usePublishableTargetTypesQuery: PublishableTargetTypesQueryHook;

package/dist/dts/apiWrappers/general/queries/searchQueries.d.ts

@@ -0,0 +1,13 @@
+import type { SearchInContainerQueryHook, SystemSearchQueryHook } from "../../../api";
+/**
+ * Retrieves search results within an individual item for the provided input.
+ *
+ * @public
+ */
+export declare const useSearchInContainerQuery: SearchInContainerQueryHook;
+/**
+ * Retrieves search results within the system for the provided input.
+ *
+ * @public
+ */
+export declare const useSystemSearchQuery: SystemSearchQueryHook;

package/dist/dts/apiWrappers/general/queries/translationQueries.d.ts

@@ -0,0 +1,5 @@
+import type { DefaultTranslationJobQueryHook } from "../../../api";
+/**
+ * @public
+ */
+export declare const useDefaultTranslationJobQuery: DefaultTranslationJobQueryHook;

package/dist/dts/apiWrappers/general/queries/workflowQueries.d.ts

@@ -0,0 +1,5 @@
+import type { ActivityInstancesQueryHook } from "../../../api";
+/**
+ * @public
+ */
+export declare const useActivityInstancesQuery: ActivityInstancesQueryHook;

package/dist/dts/apiWrappers/index.d.ts

@@ -0,0 +1,5 @@
+export * from './activitiesExplorer';
+export * from './contentExplorer';
+export * from './publishingQueueExplorer';
+export * from './editors';
+export * from './general';

package/dist/dts/apiWrappers/publishingQueueExplorer/hooks.d.ts

@@ -0,0 +1,39 @@
+import type { OptionalPublishingQueueExplorerHook, OptionalPublishingQueueExplorerTableHook, PublishingQueueExplorerHook, PublishingQueueExplorerTableHook } from "../../api";
+/**
+ * Provides access to PublishingQueue Explorer data and methods.
+ *
+ * @remarks
+ * Should be used only inside PublishingQueue Explorer, otherwise throws an error.
+ *
+ * @public
+ */
+export declare const usePublishingQueueExplorer: PublishingQueueExplorerHook;
+/**
+ * Provides access to PublishingQueue Explorer data and methods, if available.
+ *
+ * @remarks
+ * Safe to be used within or outside of the PublishingQueue Explorer.
+ * `undefined` is returned when used outside of PublishingQueue Explorer.
+ *
+ * @public
+ */
+export declare const useOptionalPublishingQueueExplorer: OptionalPublishingQueueExplorerHook;
+/**
+ * Provides access to PublishingQueue Explorer Table data and methods.
+ *
+ * @remarks
+ * Should be used only inside PublishingQueue Explorer Table, otherwise throws an error.
+ *
+ * @public
+ */
+export declare const usePublishingQueueExplorerTable: PublishingQueueExplorerTableHook;
+/**
+ * Provides access to PublishingQueue Explorer Table data and methods, if available.
+ *
+ * @remarks
+ * Safe to be used within or outside of the PublishingQueue Explorer Table.
+ * `undefined` is returned when used outside of PublishingQueue Explorer Table.
+ *
+ * @public
+ */
+export declare const useOptionalPublishingQueueExplorerTable: OptionalPublishingQueueExplorerTableHook;

package/dist/dts/apiWrappers/publishingQueueExplorer/index.d.ts

@@ -0,0 +1 @@
+export * from './hooks';

package/dist/dts/extensionPoints/actionsConfiguration/actionExtension.d.ts

@@ -0,0 +1,43 @@
+import type { CustomIcon } from "../../api";
+/**
+ * @public
+ */
+export interface ActionHookResult {
+    /**
+     * Indicates the availability of the action.
+     */
+    readonly isAvailable: boolean;
+    /**
+     * A callback function that is executed when the action is triggered.
+     */
+    readonly execute: () => void;
+}
+/**
+ * @public
+ */
+export type ActionHook = () => ActionHookResult;
+/**
+ * @public
+ */
+export interface ActionExtensionConfiguration {
+    /**
+     * A unique identifier for the action.
+     */
+    readonly id: string;
+    /**
+     * Label associated with the action.
+     */
+    readonly label: string;
+    /**
+     * Icon associated with the action.
+     */
+    readonly icon: CustomIcon;
+    /**
+     * Hook that contains behavior of the action.
+     */
+    readonly useAction: ActionHook;
+}
+/**
+ * @public
+ */
+export type ActionExtension = () => ActionExtensionConfiguration;

package/dist/dts/extensionPoints/actionsConfiguration/actionGroup.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @public
+ */
+export interface ActionGroup {
+    /**
+     * A unique identifier for the action group.
+     */
+    readonly id: string;
+    /**
+     * Label associated with the action group.
+     *
+     * @remarks
+     * It can be used to provide insight into why specific actions are grouped together.
+     */
+    readonly label: string;
+    /**
+     * An ordered array of action IDs that are included in the group.
+     */
+    readonly actionIds: readonly string[];
+}