@tridion-sites/extensions 2.0.2 → 3.1.0

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

@@ -1,39 +0,0 @@
-import type { ActivitiesExplorerHook, ActivitiesExplorerTableHook, OptionalActivitiesExplorerHook, OptionalActivitiesExplorerTableHook } from "../../api";
-/**
- * Provides access to Activities Explorer data and methods.
- *
- * @remarks
- * Should be used only inside Activities Explorer, otherwise throws an error.
- *
- * @public
- */
-export declare const useActivitiesExplorer: ActivitiesExplorerHook;
-/**
- * Provides access to Activities Explorer data and methods, if available.
- *
- * @remarks
- * Safe to be used within or outside of the Activities Explorer.
- * `undefined` is returned when used outside of Activities Explorer.
- *
- * @public
- */
-export declare const useOptionalActivitiesExplorer: OptionalActivitiesExplorerHook;
-/**
- * Provides access to Activities Explorer Table data and methods.
- *
- * @remarks
- * Should be used only inside Activities Explorer Table, otherwise throws an error.
- *
- * @public
- */
-export declare const useActivitiesExplorerTable: ActivitiesExplorerTableHook;
-/**
- * Provides access to Activities Explorer Table data and methods, if available.
- *
- * @remarks
- * Safe to be used within or outside of the Activities Explorer Table.
- * `undefined` is returned when used outside of Activities Explorer Table.
- *
- * @public
- */
-export declare const useOptionalActivitiesExplorerTable: OptionalActivitiesExplorerTableHook;

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

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

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

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

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

@@ -1,58 +0,0 @@
-import type { ContentExplorerHook, ContentExplorerTableHook, ContentExplorerTreeHook, OptionalContentExplorerHook, OptionalContentExplorerTableHook, OptionalContentExplorerTreeHook } from "../../api";
-/**
- * Hook for accessing Content Explorer data and methods.
- *
- * @remarks
- * Should be used only inside Content Explorer, otherwise throws an error.
- *
- * @public
- */
-export declare const useContentExplorer: ContentExplorerHook;
-/**
- * Hook for accessing Content Explorer data and methods, if available.
- *
- * @remarks
- * Safe to be used within or outside of the Content Explorer.
- * `undefined` is returned when used outside of Content Explorer.
- *
- * @public
- */
-export declare const useOptionalContentExplorer: OptionalContentExplorerHook;
-/**
- * Hook for accessing Content Explorer Table data and methods.
- *
- * @remarks
- * Should be used only inside Content Explorer Table, otherwise throws an error.
- *
- * @public
- */
-export declare const useContentExplorerTable: ContentExplorerTableHook;
-/**
- * Hook for accessing Content Explorer Table data and methods, if available.
- *
- * @remarks
- * Safe to be used within or outside of the Content Explorer Table.
- * `undefined` is returned when used outside of Content Explorer Table.
- *
- * @public
- */
-export declare const useOptionalContentExplorerTable: OptionalContentExplorerTableHook;
-/**
- * Hook for accessing Content Explorer Tree data and methods.
- *
- * @remarks
- * Should be used only inside Content Explorer Tree, otherwise throws an error.
- *
- * @public
- */
-export declare const useContentExplorerTree: ContentExplorerTreeHook;
-/**
- * Hook for accessing Content Explorer Tree data and methods, if available.
- *
- * @remarks
- * Safe to be used within or outside of the Content Explorer Tree.
- * `undefined` is returned when used outside of Content Explorer Tree.
- *
- * @public
- */
-export declare const useOptionalContentExplorerTree: OptionalContentExplorerTreeHook;

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

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

package/dist/dts/apiWrappers/contentExplorer/utils.d.ts

@@ -1,73 +0,0 @@
-import type { ContentExplorerItemNode, ContentExplorerNode } from "../../api";
-import type { Constructor } from '@tridion/graphene';
-import type { IdentifiableObject } from '@tridion-sites/models';
-/**
- * Checks whether the provided node is an item in the system.
- *
- * @example
- * Folder node returns `true`
- * Publication node returns `false`
- * Taxonomies node returns `false`
- *
- * @public
- */
-export declare const isItemNode: (node: ContentExplorerNode | undefined) => node is ContentExplorerItemNode;
-/**
- * Checks whether the provided nodeId is the 'Favorites' node ID.
- *
- * @public
- */
-export declare const isFavoritesNodeId: (nodeId: string) => boolean;
-/**
- * Checks whether the provided nodeId is the 'Items in Progress' node ID.
- *
- * @public
- */
-export declare const isItemsInProgressNodeId: (nodeId: string) => boolean;
-/**
- * Checks whether the provided nodeId is the 'Publications' node ID
- *
- * @public
- */
-export declare const isPublicationsNodeId: (nodeId: string) => boolean;
-/**
- * Checks whether the provided nodeId is the 'Root' node ID.
- *
- * @public
- */
-export declare const isRootNodeId: (nodeId: string) => boolean;
-/**
- * Checks if an item in a node, given as the first parameter,
- * is an instance of a constructor, provided as the second parameter.
- *
- * @param node - The node to check.
- * @param ctor - The constructor to compare against.
- * @returns Boolean value indicating whether the item node is an instance of the constructor.
- *
- * @public
- */
-export declare const isItemNodeOfType: <TItem extends IdentifiableObject>(node: ContentExplorerNode | undefined, ctor: Constructor<TItem>) => node is ContentExplorerItemNode<TItem>;
-/**
- * Checks whether the provided node is the 'Items in Progress' node.
- *
- * @public
- */
-export declare const isItemsInProgressNode: (node: ContentExplorerNode) => boolean;
-/**
- * Checks whether the provided node is the 'Publications' node.
- *
- * @public
- */
-export declare const isPublicationsNode: (node: ContentExplorerNode) => boolean;
-/**
- * Checks whether the provided node is the 'Root' node.
- *
- * @public
- */
-export declare const isRootNode: (node: ContentExplorerNode) => boolean;
-/**
- * Checks whether the provided node is the 'System' node.
- *
- * @public
- */
-export declare const isSystemNode: (node: ContentExplorerNode) => boolean;

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

@@ -1,63 +0,0 @@
-import type { EditorHook, OptionalBundleEditorHook, OptionalCategoryEditorHook, OptionalComponentEditorHook, OptionalEditorHook, OptionalFolderEditorHook, OptionalKeywordEditorHook, OptionalPageEditorHook, OptionalStructureGroupEditorHook } from "../../api";
-/**
- * Provides access to Item Editor data and methods.
- *
- * @public
- */
-export declare const useEditor: EditorHook;
-/**
- * Provides access to Item Editor data and methods, if available.
- * `undefined` is returned when used outside of Item Editor.
- *
- * @public
- */
-export declare const useOptionalEditor: OptionalEditorHook;
-/**
- * Provides access to Bundle Editor data and methods, if available.
- * `undefined` is returned when used outside of Bundle Editor.
- *
- * @public
- */
-export declare const useOptionalBundleEditor: OptionalBundleEditorHook;
-/**
- * Provides access to Component Editor data and methods, if available.
- * `undefined` is returned when used outside of Component Editor.
- *
- * @public
- */
-export declare const useOptionalComponentEditor: OptionalComponentEditorHook;
-/**
- * Provides access to Category Editor data and methods, if available.
- * `undefined` is returned when used outside of Category Editor.
- *
- * @public
- */
-export declare const useOptionalCategoryEditor: OptionalCategoryEditorHook;
-/**
- * Provides access to Folder Editor data and methods, if available.
- * `undefined` is returned when used outside of Folder Editor.
- *
- * @public
- */
-export declare const useOptionalFolderEditor: OptionalFolderEditorHook;
-/**
- * Provides access to Keyword Editor data and methods, if available.
- * `undefined` is returned when used outside of Keyword Editor.
- *
- * @public
- */
-export declare const useOptionalKeywordEditor: OptionalKeywordEditorHook;
-/**
- * Provides access to Page Editor data and methods, if available.
- * `undefined` is returned when used outside of Page Editor.
- *
- * @public
- */
-export declare const useOptionalPageEditor: OptionalPageEditorHook;
-/**
- * Provides access to Structure Group Editor data and methods, if available.
- * `undefined` is returned when used outside of Structure Group Editor.
- *
- * @public
- */
-export declare const useOptionalStructureGroupEditor: OptionalStructureGroupEditorHook;

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

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

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

@@ -1,88 +0,0 @@
-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

@@ -1,37 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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

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

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

@@ -1,30 +0,0 @@
-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

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

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

@@ -1,137 +0,0 @@
-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

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

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

@@ -1,47 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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

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