@tridion-sites/extensions 2.0.0 → 2.0.2

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

@@ -0,0 +1,6 @@
+export * from './borderRadius';
+export * from './color';
+export * from './opacity';
+export * from './spacing';
+export * from './transitionDuration';
+export * from './zIndex';

package/dist/dts/api/general/globals/opacity.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @public
+ */
+export interface OpacityLevel {
+    semiopaque: number;
+    medium: number;
+    semitransparent: number;
+}
+/**
+ * @public
+ */
+export type OpacityLevelGetter = () => OpacityLevel;
+/**
+ * @public
+ */
+export type OpacityLevelUnit = keyof OpacityLevel;

package/dist/dts/api/general/globals/spacing.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @public
+ */
+export interface Spacing {
+    zero: number;
+    nano: number;
+    xs: number;
+    sm: number;
+    md: number;
+    lg: number;
+}
+/**
+ * @public
+ */
+export type SpacingGetter = () => Spacing;
+/**
+ * @public
+ */
+export type SpacingUnit = keyof Spacing;

package/dist/dts/api/general/globals/transitionDuration.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @public
+ */
+export interface TransitionDuration {
+    short: number;
+}
+/**
+ * @public
+ */
+export type TransitionDurationGetter = () => TransitionDuration;
+/**
+ * @public
+ */
+export type TransitionDurationUnit = keyof TransitionDuration;

package/dist/dts/api/general/globals/zIndex.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @public
+ */
+export interface ZIndex {
+    lowest: number;
+    low: number;
+    middle: number;
+    high: number;
+    highest: number;
+}
+/**
+ * @public
+ */
+export type ZIndexGetter = () => ZIndex;
+/**
+ * @public
+ */
+export type ZIndexInit = keyof ZIndex;

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

@@ -0,0 +1,4 @@
+export * from './useConfirmation';
+export * from './useNotifications';
+export * from './useUserProfile';
+export * from './useModal';

package/dist/dts/api/general/hooks/useConfirmation.d.ts

@@ -0,0 +1,40 @@
+import type { ReactNode } from 'react';
+/**
+ * @public
+ */
+export interface ConfirmationHookArguments {
+    /**
+     * Dialog's title.
+     */
+    title: string;
+    /**
+     * Callback is called after pressing confirm button.
+     */
+    onConfirm: () => void;
+    /**
+     * Label for dialog's cancel button.
+     */
+    cancelButtonLabel?: string;
+    /**
+     * Content of the dialog.
+     */
+    description?: ReactNode;
+    /**
+     * Label for dialog's confirm button.
+     */
+    okButtonLabel?: string;
+    /**
+     * Callback is executed when dialog has been canceled.
+     */
+    onCancel?: () => void;
+}
+/**
+ * @public
+ */
+export interface ConfirmationHookResult {
+    open: () => void;
+}
+/**
+ * @public
+ */
+export type ConfirmationHook = (args: ConfirmationHookArguments) => ConfirmationHookResult;

package/dist/dts/api/general/hooks/useModal.d.ts

@@ -0,0 +1,68 @@
+import type { ComponentType } from 'react';
+import type { ValuesOfArray } from '@tridion/graphene';
+/**
+ * @public
+ */
+export declare const modalTypes: readonly ["default", "danger"];
+/**
+ * @public
+ */
+export declare const modalType: {
+    default: "default";
+    danger: "danger";
+};
+/**
+ * @public
+ */
+export type ModalType = ValuesOfArray<typeof modalTypes>;
+/**
+ * @public
+ */
+export interface ModalResult<TResultData> {
+    status: ModalStatus;
+    result: TResultData | undefined;
+}
+/**
+ * @public
+ */
+export interface ModalContentProps<TResultData> {
+    onConfirm: (result?: TResultData) => void;
+    onCancel: () => void;
+}
+/**
+ * @public
+ */
+export interface ModalHookArguments<TResultData = unknown> {
+    content: ComponentType<ModalContentProps<TResultData>>;
+    height?: number;
+    isMaximizable?: boolean;
+    minHeight?: number;
+    minWidth?: number;
+    width?: number;
+    modalType?: ModalType;
+}
+/**
+ * @public
+ */
+export declare const modalStatuses: readonly ["ok", "cancel"];
+/**
+ * @public
+ */
+export declare const modalStatus: {
+    ok: "ok";
+    cancel: "cancel";
+};
+/**
+ * @public
+ */
+export type ModalStatus = ValuesOfArray<typeof modalStatuses>;
+/**
+ * @public
+ */
+export interface ModalHookResult<TResultData> {
+    open: () => Promise<ModalResult<TResultData>>;
+}
+/**
+ * @public
+ */
+export type ModalHook<TResultData = unknown> = (args: ModalHookArguments) => ModalHookResult<TResultData>;

package/dist/dts/api/general/hooks/useNotifications.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @public
+ */
+export type NotificationType = 'error' | 'info' | 'success' | 'warning';
+/**
+ * @public
+ */
+export interface NotifyArguments {
+    /**
+     * Type defines styling of the message.
+     *
+     * Depending on intention of the message one of the values can be used:
+     * - `error` - in cases error occurred, operation failed.
+     * - `info` - general information for the user.
+     * - `success` - report about success of the operation.
+     * - `warning` - information that user needs to pay attention to.
+     */
+    type: NotificationType;
+    /**
+     * Notification's title.
+     */
+    title: string;
+    /**
+     * Detailed notification message.
+     */
+    description?: string;
+    /**
+     * Option to store notification in Message Center.
+     */
+    showInMessageCenter?: boolean;
+}
+/**
+ * @public
+ */
+export interface NotificationsHookResult {
+    /**
+     * Method to show a new notification.
+     *
+     * @param args - options to customize notification.
+     */
+    notify: (args: NotifyArguments) => void;
+}
+/**
+ * @public
+ */
+export type NotificationsHook = () => NotificationsHookResult;

package/dist/dts/api/general/hooks/useUserProfile.d.ts

@@ -0,0 +1,14 @@
+import type { UserProfile } from '@tridion-sites/models';
+/**
+ * @public
+ */
+export interface UserProfileHookResult {
+    /**
+     * `UserProfile` instance of the logged-in Tridion user.
+     */
+    userProfile: UserProfile | undefined;
+}
+/**
+ * @public
+ */
+export type UserProfileHook = () => UserProfileHookResult;

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

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

package/dist/dts/api/general/mixins/accessibility.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @public
+ */
+export type AriaRole = 'button' | 'columnheader' | 'combobox' | 'grid' | 'gridcell' | 'group' | 'list' | 'listbox' | 'listitem' | 'menu' | 'menubar' | 'menuitem' | 'none' | 'option' | 'radiogroup' | 'row' | 'rowgroup' | 'rowheader' | 'tree' | 'treeitem';
+/**
+ * @public
+ */
+export type AriaAutocomplete = 'none' | 'both' | 'list' | 'inline';
+/**
+ * @public
+ */
+export type AriaCurrent = boolean | 'page' | 'step' | 'location' | 'date' | 'time';
+/**
+ * @public
+ */
+export type AriaHasPopup = boolean | 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog';
+/**
+ * @public
+ */
+export type AriaPressed = boolean | 'mixed';
+/**
+ * @public
+ */
+export interface AriaProps {
+    activeDescendant: string;
+    autocomplete: AriaAutocomplete;
+    controls: string;
+    current: AriaCurrent;
+    disabled: boolean;
+    expanded: boolean;
+    for: string;
+    hasPopup: AriaHasPopup;
+    hidden: boolean;
+    id: string;
+    label: string;
+    labelledBy: string;
+    pressed: AriaPressed;
+    required: boolean;
+    role: AriaRole;
+    rowCount: number;
+    rowIndex: number;
+    selected: boolean;
+}
+/**
+ * Accessibility-related props
+ * @public
+ */
+export interface AccessibleComponentProps<K extends keyof AriaProps> {
+    aria: Pick<Partial<AriaProps>, K>;
+}

package/dist/dts/api/general/mixins/backgroundColor.d.ts

@@ -0,0 +1,10 @@
+import type { Color } from "../..";
+/**
+ * @public
+ */
+export interface BackgroundColorProps {
+    /**
+     * Background color of the component based on the color palette
+     */
+    backgroundColor?: Color;
+}

package/dist/dts/api/general/mixins/clickable.d.ts

@@ -0,0 +1,7 @@
+import type { MouseEvent } from 'react';
+/**
+ * @public
+ */
+export interface ClickableProps {
+    onClick?: (event: MouseEvent<never>) => void;
+}

package/dist/dts/api/general/mixins/color.d.ts

@@ -0,0 +1,10 @@
+import type { Color } from "../..";
+/**
+ * @public
+ */
+export interface ColorProps {
+    /**
+     * Color of the component based on the color palette.
+     */
+    color?: Color | 'inherit';
+}

package/dist/dts/api/general/mixins/customIcon.d.ts

@@ -0,0 +1,10 @@
+import type { ReactElement } from 'react';
+import type { IconProps } from "../..";
+/**
+ * @public
+ */
+export type CustomIconProps = Omit<IconProps, 'children' | 'viewBox'>;
+/**
+ * @public
+ */
+export type CustomIcon = ReactElement<CustomIconProps>;

package/dist/dts/api/general/mixins/focusBehavior.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @public
+ */
+export type FocusBehavior = 'tabbable' | 'programmatic';
+/**
+ * @public
+ */
+export interface FocusBehaviorProps {
+    /**
+     * Should focus be available on "Tab" press or only via JS?
+     */
+    focusBehavior?: FocusBehavior;
+}

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

@@ -0,0 +1,10 @@
+export * from './accessibility';
+export * from './backgroundColor';
+export * from './clickable';
+export * from './color';
+export * from './customIcon';
+export * from './focusBehavior';
+export * from './opacity';
+export * from './sizing';
+export * from './spacing';
+export * from './tooltip';

package/dist/dts/api/general/mixins/opacity.d.ts

@@ -0,0 +1,11 @@
+import type { OpacityLevelUnit } from "../..";
+/**
+ * @public
+ */
+export interface OpacityProps {
+    /**
+     * Opacity level of the component.
+     * Accepts one of predefined values.
+     */
+    opacity?: OpacityLevelUnit;
+}

package/dist/dts/api/general/mixins/sizing.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @public
+ */
+export interface SizeProps {
+    /**
+     * Width of the component.
+     * Values higher than 1 are treated as pixels.
+     * Values less than or equal to 1 are treated as percentage.
+     * Zero is ignored.
+     */
+    width?: number;
+    /**
+     * Height of the component.
+     * Values higher than 1 are treated as pixels.
+     * Values less than or equal to 1 are treated as percentage.
+     * Zero is ignored.
+     */
+    height?: number;
+    /**
+     * Minimum width of the component in pixels.
+     */
+    minWidth?: number;
+    /**
+     * Minimum height of the component in pixels.
+     */
+    minHeight?: number;
+    /**
+     * Maximum width of the component in pixels.
+     */
+    maxWidth?: number;
+    /**
+     * Maximum height of the component in pixels.
+     */
+    maxHeight?: number;
+}

package/dist/dts/api/general/mixins/spacing.d.ts

@@ -0,0 +1,16 @@
+import type { SpacingUnit } from "../..";
+/**
+ * @public
+ */
+export interface SpaceProps {
+    margin?: SpacingUnit | SpacingUnit[];
+    marginBottom?: SpacingUnit;
+    marginTop?: SpacingUnit;
+    marginLeft?: SpacingUnit;
+    marginRight?: SpacingUnit;
+    padding?: SpacingUnit | SpacingUnit[];
+    paddingLeft?: SpacingUnit;
+    paddingRight?: SpacingUnit;
+    paddingTop?: SpacingUnit;
+    paddingBottom?: SpacingUnit;
+}

package/dist/dts/api/general/mixins/tooltip.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @public
+ */
+export interface TooltipProps {
+    /**
+     * Tooltip that is shown on hover.
+     */
+    tooltip?: string;
+}

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

@@ -0,0 +1,6 @@
+import type { ApiError, Batch } from '@tridion-sites/models';
+import type { MutationOptions } from './mutationOptions';
+/**
+ * @public
+ */
+export type BatchMutationOptions<TVariables> = MutationOptions<Batch, ApiError, TVariables>;

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

@@ -0,0 +1,10 @@
+export * from './useAddToBundleMutation';
+export * from './useChangeUserLanguageMutation';
+export * from './useChangeUserLocaleMutation';
+export * from './useRemoveFromBundleMutation';
+export * from './useUploadMultimediaMutation';
+export * from './item';
+export * from './translation';
+export * from './workflow';
+export * from './mutationOptions';
+export * from './mutationResult';

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

@@ -0,0 +1,24 @@
+export * from './useAutoClassifyItemMutation';
+export * from './useAutoClassifyItemsMutation';
+export * from './useCopyItemMutation';
+export * from './useCopyItemsMutation';
+export * from './useDeleteItemMutation';
+export * from './useDeleteItemsMutation';
+export * from './useDemoteItemMutation';
+export * from './useDemoteItemsMutation';
+export * from './useFinishEditingItemMutation';
+export * from './useFinishEditingItemsMutation';
+export * from './useLocalizeItemMutation';
+export * from './useLocalizeItemsMutation';
+export * from './useMoveItemMutation';
+export * from './useMoveItemsMutation';
+export * from './usePublishItemsMutation';
+export * from './usePromoteItemMutation';
+export * from './usePromoteItemsMutation';
+export * from './useRevertItemMutation';
+export * from './useRevertItemsMutation';
+export * from './useRollbackItemMutation';
+export * from './useUnlocalizeItemMutation';
+export * from './useUnlocalizeItemsMutation';
+export * from './useUnpublishItemsMutation';
+export * from './useUpdateItemMutation';

package/dist/dts/api/general/mutations/item/useAutoClassifyItemMutation.d.ts

@@ -0,0 +1,20 @@
+import type { ApiError, ClassificationInfo, IdentifiableObject, ItemUri } from '@tridion-sites/models';
+import type { MutationOptions } from '../mutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface AutoClassifyItemRequest {
+    /**
+     * ID of an item to classify.
+     */
+    itemId: ItemUri;
+    /**
+     * Container of an item to classify.
+     */
+    containerItem?: IdentifiableObject;
+}
+/**
+ * @public
+ */
+export type AutoClassifyItemMutationHook = (options?: MutationOptions<ClassificationInfo, ApiError, AutoClassifyItemRequest>) => MutationResult<ClassificationInfo, ApiError, AutoClassifyItemRequest>;

package/dist/dts/api/general/mutations/item/useAutoClassifyItemsMutation.d.ts

@@ -0,0 +1,20 @@
+import type { ApiError, Batch, IdentifiableObject, ItemUri } from '@tridion-sites/models';
+import type { BatchMutationOptions } from '../batchMutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface AutoClassifyItemsRequest {
+    /**
+     * IDs of the items to classify.
+     */
+    itemIds: ReadonlyArray<ItemUri>;
+    /**
+     * Container of an item to classify.
+     */
+    containerItem?: IdentifiableObject;
+}
+/**
+ * @public
+ */
+export type AutoClassifyItemsMutationHook = (options?: BatchMutationOptions<AutoClassifyItemsRequest>) => MutationResult<Batch, ApiError, AutoClassifyItemsRequest>;

package/dist/dts/api/general/mutations/item/useCopyItemMutation.d.ts

@@ -0,0 +1,20 @@
+import type { ApiError, ItemUri, RepositoryLocalObject } from '@tridion-sites/models';
+import type { MutationOptions } from '../mutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface CopyItemRequest {
+    /**
+     * ID of an item to copy.
+     */
+    itemId: ItemUri;
+    /**
+     * ID of organizational item to copy to.
+     */
+    destinationId: ItemUri;
+}
+/**
+ * @public
+ */
+export type CopyItemMutationHook = (options?: MutationOptions<RepositoryLocalObject, ApiError, CopyItemRequest>) => MutationResult<RepositoryLocalObject, ApiError, CopyItemRequest>;

package/dist/dts/api/general/mutations/item/useCopyItemsMutation.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 CopyItemsRequest {
+    /**
+     * IDs of items to copy.
+     */
+    itemIds: ReadonlyArray<ItemUri>;
+    /**
+     * ID of organizational item to copy to.
+     */
+    destinationId: ItemUri;
+}
+/**
+ * @public
+ */
+export type CopyItemsMutationHook = (options?: BatchMutationOptions<CopyItemsRequest>) => MutationResult<Batch, ApiError, CopyItemsRequest>;

package/dist/dts/api/general/mutations/item/useDeleteItemMutation.d.ts

@@ -0,0 +1,20 @@
+import type { ApiError, IdentifiableObject } from '@tridion-sites/models';
+import type { MutationOptions } from '../mutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface DeleteItemRequest {
+    /**
+     * Item to delete.
+     */
+    item: IdentifiableObject;
+    /**
+     * The container (context) in which the delete action is being performed. If specified, the container is invalidated on success to trigger reloading.
+     */
+    containerItem?: IdentifiableObject;
+}
+/**
+ * @public
+ */
+export type DeleteItemMutationHook = (options?: MutationOptions<void, ApiError, DeleteItemRequest>) => MutationResult<void, ApiError, DeleteItemRequest>;

package/dist/dts/api/general/mutations/item/useDeleteItemsMutation.d.ts

@@ -0,0 +1,22 @@
+import type { ApiError, Batch, IdentifiableObject } from '@tridion-sites/models';
+import type { BatchMutationOptions } from '../batchMutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface DeleteItemsRequest {
+    /**
+     * Items to delete.
+     */
+    items: ReadonlyArray<IdentifiableObject>;
+    /**
+     * Container item of the item to delete.
+     * `containerId` may take 'undefined' value when publications
+     * which don't have a real container are being deleted.
+     */
+    containerItem?: IdentifiableObject;
+}
+/**
+ * @public
+ */
+export type DeleteItemsMutationHook = (options?: BatchMutationOptions<DeleteItemsRequest>) => MutationResult<Batch, ApiError, DeleteItemsRequest>;

package/dist/dts/api/general/mutations/item/useDemoteItemMutation.d.ts

@@ -0,0 +1,15 @@
+import type { ApiError, ItemUri, RepositoryLocalObject } from '@tridion-sites/models';
+import type { MutationOptions } from '../mutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface DemoteItemRequest {
+    item: RepositoryLocalObject;
+    destinationPublicationId: ItemUri;
+    failureLevel: 'warning' | 'error';
+}
+/**
+ * @public
+ */
+export type DemoteItemMutationHook = (options?: MutationOptions<RepositoryLocalObject | void, ApiError, DemoteItemRequest>) => MutationResult<RepositoryLocalObject | void, ApiError, DemoteItemRequest>;

package/dist/dts/api/general/mutations/item/useDemoteItemsMutation.d.ts

@@ -0,0 +1,15 @@
+import type { ApiError, Batch, ItemUri, RepositoryLocalObject } from '@tridion-sites/models';
+import type { BatchMutationOptions } from '../batchMutationOptions';
+import type { MutationResult } from '../mutationResult';
+/**
+ * @public
+ */
+export interface DemoteItemsRequest {
+    items: ReadonlyArray<RepositoryLocalObject>;
+    destinationPublicationId: ItemUri;
+    failureLevel: 'warning' | 'error';
+}
+/**
+ * @public
+ */
+export type DemoteItemsMutationHook = (options?: BatchMutationOptions<DemoteItemsRequest>) => MutationResult<Batch, ApiError, DemoteItemsRequest>;