@tridion-sites/extensions 2.0.2 → 3.1.0

package/dist/dts/api/general/components/layout/stack.d.ts

@@ -1,39 +0,0 @@
-import type { ForwardRefExoticComponent } from 'react';
-import type { BlockProps, SpacingUnit } from "../../..";
-/**
- * @public
- */
-export type StackAlignment = 'start' | 'center' | 'end' | 'stretch' | 'baseline';
-/**
- * @public
- */
-export type StackDirection = 'row' | 'column';
-/**
- * @public
- */
-export interface StackProps extends BlockProps {
-    /**
-     * The direction in which items are going to stack.
-     */
-    direction: StackDirection;
-    /**
-     * The spacing between items in the stack.
-     */
-    itemGap: SpacingUnit;
-    /**
-     * How items should be aligned vertically.
-     */
-    verticalAlignment?: StackAlignment;
-    /**
-     * How items should be aligned horizontally.
-     */
-    horizontalAlignment?: StackAlignment;
-    /**
-     * Render as an inline-level element or as a block-level one?
-     */
-    inline?: boolean;
-}
-/**
- * @public
- */
-export type StackComponent = ForwardRefExoticComponent<StackProps>;

package/dist/dts/api/general/components/link.d.ts

@@ -1,29 +0,0 @@
-import type { FunctionComponent, ReactNode } from 'react';
-/**
- * @public
- */
-export interface LinkProps {
-    /**
-     * String that represents a valid path to the external or internal source. The relative path always starts with `/`, otherwise it's treated as an absolute path.
-     * Relative to the current directory path is not supported (ex. `subfolder`).
-     *
-     * @example `/explorer` or `https://www.website.com`.
-     */
-    to: string;
-    /**
-     * Boolean that indicates whether a link should be opened in new tab.
-     */
-    openInNewTab?: boolean;
-    /**
-     * String that is shown as tooltip on hover.
-     */
-    tooltip?: string;
-    /**
-     * The content to be rendered inside the Link component.
-     */
-    children?: ReactNode;
-}
-/**
- * @public
- */
-export type LinkComponent = FunctionComponent<LinkProps>;

package/dist/dts/api/general/components/modal.d.ts

@@ -1,61 +0,0 @@
-import type { FunctionComponent, ReactNode } from 'react';
-import type { FlexProps } from './layout';
-/**
- * @public
- */
-export interface ModalHeaderComponentProps {
-    /**
-     * React node that is rendered as a title of the Modal component, includes expand and close buttons by default.
-     */
-    title?: ReactNode;
-}
-/**
- * @public
- */
-export type ModalHeaderComponent = FunctionComponent<ModalHeaderComponentProps>;
-/**
- * @public
- */
-export interface ModalFooterComponentProps {
-    /**
-     * Label for the Cancel button of the Modal.
-     */
-    cancelButtonLabel?: string;
-    /**
-     * Boolean that indicates disabled state of the Cancel button.
-     */
-    isCancelButtonDisabled?: boolean;
-    /**
-     * Boolean that indicates disabled state of the Ok button.
-     */
-    isOkButtonDisabled?: boolean;
-    /**
-     * Label for the Ok button of the Modal.
-     */
-    okButtonLabel?: string;
-    /**
-     * Callback executed when Ok button clicked.
-     */
-    onOk?: () => void;
-    /**
-     * Callback executed when Cancel button clicked.
-     */
-    onCancel?: () => void;
-}
-/**
- * @public
- */
-export type ModalFooterComponent = FunctionComponent<ModalFooterComponentProps>;
-/**
- * @public
- */
-export interface ModalContentComponentProps extends FlexProps {
-    /**
-     * Content of the Modal.
-     */
-    children: ReactNode;
-}
-/**
- * @public
- */
-export type ModalContentComponent = FunctionComponent<ModalContentComponentProps>;

package/dist/dts/api/general/components/text.d.ts

@@ -1,82 +0,0 @@
-import type { FunctionComponent, ReactNode } from 'react';
-import type { ColorProps, TooltipProps } from '../mixins';
-/**
- * @public
- */
-export type TextTag = 'div' | 'span' | 'h1' | 'h2' | 'h3';
-/**
- * @public
- */
-export type TextAlignment = 'left' | 'center' | 'right' | 'justify';
-/**
- * @public
- */
-export type TextDirection = 'leftToRight' | 'rightToLeft';
-/**
- * @public
- */
-export type TextType = 'heading1' | 'heading2' | 'heading3' | 'default' | 'defaultBold' | 'small' | 'smallBold';
-/**
- * @public
- */
-export interface TextProps extends ColorProps, TooltipProps {
-    /**
-     * The alignment of the text in the container.
-     */
-    alignment?: TextAlignment;
-    /**
-     * Determines whether the text should break words if they exceed the container width.
-     * Note that it can be used in combination with `multiLine: true` only, since single line text is truncated by default.
-     */
-    breakWord?: boolean;
-    /**
-     * The content to be rendered inside the Text component.
-     */
-    children?: ReactNode;
-    /**
-     * Determines whether the Text component should have compact spacing.
-     * If set to `true`, the line height of the text will be reduced.
-     */
-    compact?: boolean;
-    /**
-     * The direction of the text.
-     */
-    direction?: TextDirection;
-    /**
-     * Allow text to flow over multiple lines.
-     * By default it's a single line text with truncation enabled.
-     */
-    multiLine?: boolean;
-    /**
-     * Option to make text non-selectable by the user.
-     */
-    notSelectable?: boolean;
-    /**
-     * The HTML tag to be used for rendering the Text component. Overrides default tag defined by `type`.
-     */
-    tag?: TextTag;
-    /**
-     * Preset that consist of specific styling (size, weight, etc) and HTML tag.
-     *
-     * - `heading1` - usually represents a top-level heading or title. It is styled as a large and prominent text. By default `<h1>` HTML tag is used.
-     * - `heading2` - a secondary-level heading. It is styled as a slightly smaller text compared to `heading1`. By default `<h2>` HTML tag is used.
-     * - `heading3` - a tertiary-level heading. It is styled as a smaller text compared to `heading2`. By default `<h3>` HTML tag is used.
-     * - `default` - default style for regular text. It is styled as a standard paragraph text. By default `<div>` HTML tag used.
-     * - `defaultBold` - the default style for bold text. It is styled similarly to `default` but with added font-weight. By default `<div>` HTML tag is used.
-     * - `small` - a smaller size for text. It is typically used for captions, footnotes, or other smaller pieces of text. By default `<div>` HTML tag is used.
-     * - `smallBold` - a smaller size for bold text. It combines the smaller size of 'small' with the added font-weight. By default `<div>` HTML tag is used.
-     */
-    type?: TextType;
-    /**
-     * Determines whether the text should have an underline.
-     */
-    underline?: boolean;
-    /**
-     * Determines whether the text should be displayed in uppercase.
-     */
-    uppercase?: boolean;
-}
-/**
- * @public
- */
-export type TextComponent = FunctionComponent<TextProps>;

package/dist/dts/api/general/components/textLink.d.ts

@@ -1,16 +0,0 @@
-import type { FunctionComponent } from 'react';
-import type { LinkProps } from './link';
-import type { TextProps } from './text';
-/**
- * @public
- */
-export interface TextLinkProps extends TextProps, LinkProps {
-    /**
-     * String that is rendered as a link.
-     */
-    text: string;
-}
-/**
- * @public
- */
-export type TextLinkComponent = FunctionComponent<TextLinkProps>;

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

@@ -1,15 +0,0 @@
-/**
- * @public
- */
-export interface BorderRadius {
-    small: number;
-    large: number;
-}
-/**
- * @public
- */
-export type BorderRadiusGetter = () => BorderRadius;
-/**
- * @public
- */
-export type BorderRadiusUnit = keyof BorderRadius;

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

@@ -1,41 +0,0 @@
-/**
- * @public
- */
-export interface ColorPalette {
-    transparent: string;
-    brandLight: string;
-    brandPrimary: string;
-    brandAccessible: string;
-    brandDark: string;
-    gray0: string;
-    gray10: string;
-    gray20: string;
-    gray50: string;
-    gray80: string;
-    gray100: string;
-    gray120: string;
-    gray180: string;
-    blue50: string;
-    blue100: string;
-    red50: string;
-    red100: string;
-    red120: string;
-    orange50: string;
-    orange100: string;
-    magenta50: string;
-    magenta100: string;
-    magenta120: string;
-    yellow10: string;
-    yellow50: string;
-    yellow100: string;
-    yellow120: string;
-    yellow140: string;
-}
-/**
- * @public
- */
-export type ColorPaletteGetter = () => ColorPalette;
-/**
- * @public
- */
-export type Color = keyof ColorPalette;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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