@tridion-sites/extensions 2.0.2 → 3.1.0

package/dist/dts/api/contentExplorer/hooks/useContentExplorerTable.d.ts

@@ -1,39 +0,0 @@
-import type { IdentifiableObject, ItemUri } from '@tridion-sites/models';
-/**
- * @public
- */
-export interface ContentExplorerTableSelection {
-    ids: ReadonlySet<ItemUri>;
-    selectedItems: ReadonlyArray<IdentifiableObject>;
-}
-/**
- * Methods of a Content Explorer Table.
- *
- * @public
- */
-export interface ContentExplorerTableHookResult {
-    refresh: () => void;
-    /**
-     * Current state of selected items in the Table.
-     */
-    selection: ContentExplorerTableSelection;
-}
-/**
- * Hook for accessing Content Explorer Table data and methods.
- *
- * @remarks
- * Should be used only inside Content Explorer Table, otherwise throws an error.
- *
- * @public
- */
-export type ContentExplorerTableHook = () => ContentExplorerTableHookResult;
-/**
- * Hook for accessing Content Explorer Table data and methods when 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 type OptionalContentExplorerTableHook = () => ContentExplorerTableHookResult | undefined;

package/dist/dts/api/contentExplorer/hooks/useContentExplorerTree.d.ts

@@ -1,27 +0,0 @@
-/**
- * Methods of the Content Explorer Tree.
- *
- * @public
- */
-export interface ContentExplorerTreeHookResult {
-    refresh: () => void;
-}
-/**
- * Hook for accessing Content Explorer Tree data and methods.
- *
- * @remarks
- * Should be used only inside Content Explorer Tree, otherwise throws an error.
- *
- * @public
- */
-export type ContentExplorerTreeHook = () => ContentExplorerTreeHookResult;
-/**
- * Hook for accessing Content Explorer Tree data and methods when available.
- *
- * @remarks
- * Safe to be used within or outside of the Content Explorer Tree.
- * `undefined` is returned when used outside of the Content Explorer Tree.
- *
- * @public
- */
-export type OptionalContentExplorerTreeHook = () => ContentExplorerTreeHookResult | undefined;

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

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

package/dist/dts/api/contentExplorer/utils/hierarchyUtils.d.ts

@@ -1,80 +0,0 @@
-import type { Constructor } from '@tridion/graphene';
-import type { IdentifiableObject } from '@tridion-sites/models';
-import type { ContentExplorerItemNode, ContentExplorerItemsInProgressNode, ContentExplorerNode, ContentExplorerPublicationsNode, ContentExplorerRootNode, ContentExplorerSystemNode } from '../hierarchy';
-/**
- * @public
- */
-export interface ContentExplorerHierarchyUtilsExtensionApi {
-    /**
-     * Checks if a node ID is favorites node ID.
-     *
-     * @param nodeId - The ID of the node to check.
-     * @returns A boolean value indicating whether the node ID is favorites node ID.
-     */
-    isFavoritesNodeId: (nodeId: string) => boolean;
-    /**
-     * Checks if a node is item node.
-     *
-     * @param node - The node to check.
-     * @returns A boolean value indicating whether the node is item node.
-     */
-    isItemNode: (node: ContentExplorerNode | undefined) => node is ContentExplorerItemNode;
-    /**
-     * Checks if a node is item node of a specific type.
-     *
-     * @typeParam T - The type of the item node.
-     * @param node - The node to check.
-     * @param ctor - The constructor function of the item type.
-     * @returns A boolean value indicating whether the node is item node of the specified type.
-     */
-    isItemNodeOfType: <T extends IdentifiableObject>(node: ContentExplorerNode | undefined, ctor: Constructor<T>) => node is ContentExplorerItemNode<T>;
-    /**
-     * Checks if a node is "items in progress" node.
-     *
-     * @param node - The node to check.
-     * @returns A boolean value indicating whether the node is "items in progress" node.
-     */
-    isItemsInProgressNode: (node: ContentExplorerNode | undefined) => node is ContentExplorerItemsInProgressNode;
-    /**
-     * Checks if a node ID is "items in progress" node ID.
-     *
-     * @param nodeId - The ID of the node to check.
-     * @returns A boolean value indicating whether the node ID is "items in progress" node ID.
-     */
-    isItemsInProgressNodeId: (nodeId: string) => boolean;
-    /**
-     * Checks if a node is publications node.
-     *
-     * @param node - The node to check.
-     * @returns A boolean value indicating whether the node is publications node.
-     */
-    isPublicationsNode: (node: ContentExplorerNode | undefined) => node is ContentExplorerPublicationsNode;
-    /**
-     * Checks if a node ID is publications node ID.
-     *
-     * @param nodeId - The ID of the node to check.
-     * @returns A boolean value indicating whether the node ID is publications node ID.
-     */
-    isPublicationsNodeId: (nodeId: string) => boolean;
-    /**
-     * Checks if a node is root node.
-     *
-     * @param node - The node to check.
-     * @returns A boolean value indicating whether the node is root node.
-     */
-    isRootNode: (node: ContentExplorerNode | undefined) => node is ContentExplorerRootNode;
-    /**
-     * Checks if a node ID is root node ID.
-     *
-     * @param nodeId - The ID of the node to check.
-     * @returns A boolean value indicating whether the node ID is root node ID.
-     */
-    isRootNodeId: (nodeId: string) => boolean;
-    /**
-     * Checks if a node is system node.
-     *
-     * @param node - The node to check.
-     * @returns A boolean value indicating whether the node is system node.
-     */
-    isSystemNode: (node: ContentExplorerNode | undefined) => node is ContentExplorerSystemNode;
-}

package/dist/dts/api/contentExplorer/utils/index.d.ts

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

package/dist/dts/api/editors/bundle/hooks/index.d.ts

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

package/dist/dts/api/editors/bundle/hooks/useBundleEditor.d.ts

@@ -1,32 +0,0 @@
-import type { Bundle, Schema } from '@tridion-sites/models';
-/**
- * @public
- */
-export interface BundleEditorHookResult {
-    /**
-     * Editable Bundle.
-     */
-    bundle: Bundle;
-    /**
-     * Bundle's metadata schema.
-     */
-    metadataSchema: Schema | undefined;
-    /**
-     * Boolean that indicates that Bundle has unsaved changes.
-     */
-    isChanged: boolean;
-    /**
-     * Boolean that indicates that Bundle can be edited.
-     */
-    isEditing: boolean;
-}
-/**
- * Hook for accessing Bundle Editor state when available.
- *
- * @remarks
- * Safe to be used within or outside of the Bundle Editor.
- * `undefined` is returned when used outside of Bundle Editor.
- *
- * @public
- */
-export type OptionalBundleEditorHook = () => BundleEditorHookResult | undefined;

package/dist/dts/api/editors/category/hooks/index.d.ts

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

package/dist/dts/api/editors/category/hooks/useCategoryEditor.d.ts

@@ -1,28 +0,0 @@
-import type { KeywordCategory } from '@tridion-sites/models';
-/**
- * @public
- */
-export interface CategoryEditorHookResult {
-    /**
-     * Editable Category.
-     */
-    category: KeywordCategory;
-    /**
-     * Boolean that indicates that Category has unsaved changes.
-     */
-    isChanged: boolean;
-    /**
-     * Boolean that indicates that Category can be edited.
-     */
-    isEditing: boolean;
-}
-/**
- * Hook for accessing Keyword Editor data when available.
- *
- * @remarks
- * Safe to be used within or outside of the Keyword Editor.
- * `undefined` is returned when used outside of Keyword Editor.
- *
- * @public
- */
-export type OptionalCategoryEditorHook = () => CategoryEditorHookResult | undefined;

package/dist/dts/api/editors/component/hooks/index.d.ts

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

package/dist/dts/api/editors/component/hooks/useComponentEditor.d.ts

@@ -1,32 +0,0 @@
-import type { Component, ExternalMultimediaComponent, MultimediaComponent, Schema } from '@tridion-sites/models';
-/**
- * @public
- */
-export interface ComponentEditorHookResult {
-    /**
-     * Editable Component.
-     */
-    component: Component | MultimediaComponent | ExternalMultimediaComponent;
-    /**
-     * Component's content and metadata schema.
-     */
-    schema: Schema | undefined;
-    /**
-     * Boolean that indicates that Component has unsaved changes.
-     */
-    isChanged: boolean;
-    /**
-     * Boolean that indicates that Component can be edited.
-     */
-    isEditing: boolean;
-}
-/**
- * Hook for accessing Component Editor data when available.
- *
- * @remarks
- * Safe to be used within or outside of the Component Editor.
- * `undefined` is returned when used outside of Component Editor.
- *
- * @public
- */
-export type OptionalComponentEditorHook = () => ComponentEditorHookResult | undefined;

package/dist/dts/api/editors/folder/hooks/index.d.ts

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

package/dist/dts/api/editors/folder/hooks/useFolderEditor.d.ts

@@ -1,32 +0,0 @@
-import type { Folder, Schema } from '@tridion-sites/models';
-/**
- * @public
- */
-export interface FolderEditorHookResult {
-    /**
-     * Editable Folder.
-     */
-    folder: Folder;
-    /**
-     * Folder's metadata schema.
-     */
-    metadataSchema: Schema | undefined;
-    /**
-     * Boolean that indicates that Folder has unsaved changes.
-     */
-    isChanged: boolean;
-    /**
-     * Boolean that indicates that Folder can be edited.
-     */
-    isEditing: boolean;
-}
-/**
- * Hook for accessing Folder Editor data when available.
- *
- * @remarks
- * Safe to be used within or outside of the Folder Editor.
- * `undefined` is returned when used outside of Folder Editor.
- *
- * @public
- */
-export type OptionalFolderEditorHook = () => FolderEditorHookResult | undefined;

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

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

package/dist/dts/api/editors/hooks/useEditor.d.ts

@@ -1,40 +0,0 @@
-import type { Bundle, Component, Folder, Keyword, KeywordCategory, MultimediaComponent, Page, Schema, StructureGroup } from '@tridion-sites/models';
-/**
- * @public
- */
-export interface EditorHookResult {
-    /**
-     * Editable item.
-     */
-    item: Bundle | KeywordCategory | Component | MultimediaComponent | Folder | Keyword | Page | StructureGroup;
-    /**
-     * Item's metadata schema.
-     */
-    schema: Schema | undefined;
-    /**
-     * Boolean that indicates that Item has unsaved changes.
-     */
-    isChanged: boolean;
-    /**
-     * Boolean that indicates that item can be edited.
-     */
-    isEditing: boolean;
-    /**
-     * Callback to update internal editor state.
-     */
-    onUpdate: (item: Bundle | KeywordCategory | Component | MultimediaComponent | Folder | Keyword | Page | StructureGroup) => void;
-}
-/**
- * @public
- */
-export type EditorHook = () => EditorHookResult;
-/**
- * Hook for accessing Item Editor data when available.
- *
- * @remarks
- * Safe to be used within or outside of the Item Editor.
- * `undefined` is returned when used outside of Item Editor.
- *
- * @public
- */
-export type OptionalEditorHook = () => EditorHookResult | undefined;

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

@@ -1,8 +0,0 @@
-export * from './component/hooks';
-export * from './bundle/hooks';
-export * from './category/hooks';
-export * from './folder/hooks';
-export * from './hooks';
-export * from './keyword/hooks';
-export * from './page/hooks';
-export * from './structureGroup/hooks';

package/dist/dts/api/editors/keyword/hooks/index.d.ts

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

package/dist/dts/api/editors/keyword/hooks/useKeywordEditor.d.ts

@@ -1,32 +0,0 @@
-import type { Keyword, Schema } from '@tridion-sites/models';
-/**
- * @public
- */
-export interface KeywordEditorHookResult {
-    /**
-     * Editable Keyword.
-     */
-    keyword: Keyword;
-    /**
-     * Keyword's metadata schema.
-     */
-    metadataSchema: Schema | undefined;
-    /**
-     * Boolean that indicates that Keyword has unsaved changes.
-     */
-    isChanged: boolean;
-    /**
-     * Boolean that indicates that Keyword can be edited.
-     */
-    isEditing: boolean;
-}
-/**
- * Hook for accessing Keyword Editor data when available.
- *
- * @remarks
- * Safe to be used within or outside of the Keyword Editor.
- * `undefined` is returned when used outside of Keyword Editor.
- *
- * @public
- */
-export type OptionalKeywordEditorHook = () => KeywordEditorHookResult | undefined;

package/dist/dts/api/editors/page/hooks/index.d.ts

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

package/dist/dts/api/editors/page/hooks/usePageEditor.d.ts

@@ -1,40 +0,0 @@
-import type { Page, PageTemplate, Schema } from '@tridion-sites/models';
-/**
- * @public
- */
-export interface PageEditorHookResult {
-    /**
-     * Editable Page.
-     */
-    page: Page;
-    /**
-     * Template that is used to publish Page with.
-     */
-    pageTemplate: PageTemplate | undefined;
-    /**
-     * Page's metadata schema.
-     */
-    metadataSchema: Schema | undefined;
-    /**
-     * Boolean that indicates that Page has unsaved changes.
-     */
-    isChanged: boolean;
-    /**
-     * Boolean that indicates that Page can be edited.
-     */
-    isEditing: boolean;
-    /**
-     * Boolean that indicates whether any components in the page have unsaved changes.
-     */
-    hasUnsavedRelatives: boolean;
-}
-/**
- * Hook for accessing Page Editor data when available.
- *
- * @remarks
- * Safe to be used within or outside of the Page Editor.
- * `undefined` is returned when used outside of Page Editor.
- *
- * @public
- */
-export type OptionalPageEditorHook = () => PageEditorHookResult | undefined;

package/dist/dts/api/editors/structureGroup/hooks/index.d.ts

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

package/dist/dts/api/editors/structureGroup/hooks/useStructureGroupEditor.d.ts

@@ -1,32 +0,0 @@
-import type { Schema, StructureGroup } from '@tridion-sites/models';
-/**
- * @public
- */
-export interface StructureGroupEditorHookResult {
-    /**
-     * Editable Structure Group.
-     */
-    structureGroup: StructureGroup;
-    /**
-     * Structure Group's metadata schema.
-     */
-    metadataSchema: Schema | undefined;
-    /**
-     * Boolean that indicates that Structure Group has unsaved changes.
-     */
-    isChanged: boolean;
-    /**
-     * Boolean that indicates that Structure Group can be edited.
-     */
-    isEditing: boolean;
-}
-/**
- * Hook for accessing Structure Group Editor data when available.
- *
- * @remarks
- * Safe to be used within or outside of the Structure Group Editor.
- * `undefined` is returned when used outside of Structure Group Editor.
- *
- * @public
- */
-export type OptionalStructureGroupEditorHook = () => StructureGroupEditorHookResult | undefined;

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

@@ -1,33 +0,0 @@
-import type { ForwardRefExoticComponent, MouseEvent, RefAttributes } from 'react';
-/**
- * @public
- */
-export interface ButtonProps extends RefAttributes<HTMLElement> {
-    /**
-     * Callback executed when the button is clicked.
-     */
-    onClick: (event: MouseEvent) => void;
-    /**
-     * If `true`, the element is displayed in a disabled state.
-     */
-    isDisabled?: boolean;
-    /**
-     * If `true`, the element shows a processing indicator.
-     */
-    isProcessing?: boolean;
-    /**
-     * Text that is displayed inside button, i.e., the button label.
-     * If omitted, you must provide a `tooltip`.
-     */
-    label?: string;
-    /**
-     * A tooltip text that is displayed when the element is hovered.
-     * Can be omitted if `label` is specified. Required if there is no `label` specified.
-     * For accessibility purposes, the tooltip is only displayed when it differs from the label.
-     */
-    tooltip?: string;
-}
-/**
- * @public
- */
-export type ButtonComponent = ForwardRefExoticComponent<ButtonProps>;

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

@@ -1,19 +0,0 @@
-import type { FunctionComponent, ReactNode } from 'react';
-import type { ColorProps, SizeProps, SpaceProps, TooltipProps } from "../..";
-/**
- * @public
- */
-export interface IconProps extends TooltipProps, SpaceProps, SizeProps, ColorProps {
-    /**
-     * ViewBox of the provided content.
-     */
-    viewBox: string;
-    /**
-     * SVG content to render.
-     */
-    children: ReactNode;
-}
-/**
- * @public
- */
-export type IconComponent = FunctionComponent<IconProps>;

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

@@ -1,7 +0,0 @@
-export * from './button';
-export * from './icon';
-export * from './layout';
-export * from './link';
-export * from './modal';
-export * from './text';
-export * from './textLink';

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

@@ -1,55 +0,0 @@
-import type { CSSProperties, DragEvent, FocusEvent, ForwardRefExoticComponent, KeyboardEvent, MouseEvent, ReactHTML, ReactNode, RefAttributes } from 'react';
-import type { AriaProps, BackgroundColorProps, ClickableProps, FocusBehaviorProps, OpacityProps, SizeProps, SpaceProps, TooltipProps } from "../../..";
-/**
- * @public
- */
-export type Tag = keyof ReactHTML;
-/**
- * @public
- */
-export interface BlockProps extends RefAttributes<HTMLElement>, SpaceProps, SizeProps, ClickableProps, BackgroundColorProps, OpacityProps, TooltipProps, FocusBehaviorProps {
-    /**
-     * Accessibility-related props.
-     */
-    aria?: Partial<AriaProps>;
-    /**
-     * The Block's content.
-     */
-    children?: ReactNode;
-    /**
-     * Custom CSS class that should be passed to the node.
-     * Should be used for custom styling that is not covered by other properties.
-     */
-    className?: string;
-    /**
-     * Custom CSS style that would be applied to the node directly.
-     * Useful for frequently changing styles, e.g., animation.
-     * In the case of less frequent updates it is preferable to use 'className' prop.
-     */
-    cssStyle?: CSSProperties;
-    /**
-     * Should content be scrollable?
-     * Scrollbar will not appear if content doesn't overflow Block (i.e: if Block's size is not restricted).
-     */
-    hasScroll?: boolean;
-    /**
-     * The HTML tag that should be used for this component.
-     */
-    tag?: Tag;
-    onBlur?: (event: FocusEvent<HTMLElement>) => void;
-    onFocus?: (event: FocusEvent<HTMLElement>) => void;
-    onKeyDown?: (event: KeyboardEvent<HTMLElement>) => void;
-    onMouseDown?: (event: MouseEvent<HTMLElement>) => void;
-    onMouseEnter?: (event: MouseEvent<HTMLElement>) => void;
-    onMouseLeave?: (event: MouseEvent<HTMLElement>) => void;
-    onDragEnter?: (event: DragEvent<HTMLElement>) => void;
-    onDragLeave?: (event: DragEvent<HTMLElement>) => void;
-    onDragOver?: (event: DragEvent<HTMLElement>) => void;
-    onDrop?: (event: DragEvent<HTMLElement>) => void;
-    onDoubleClick?: (event: MouseEvent<HTMLElement>) => void;
-    onContextMenu?: (event: MouseEvent<HTMLElement>) => void;
-}
-/**
- * @public
- */
-export type BlockComponent = ForwardRefExoticComponent<BlockProps>;

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

@@ -1,12 +0,0 @@
-import type { ForwardRefExoticComponent } from 'react';
-import type { FlexProps } from "../../..";
-import type { Without } from '@tridion/graphene';
-/**
- * @public
- */
-export interface CenterProps extends Without<FlexProps, 'mainAxis' | 'crossAxis'> {
-}
-/**
- * @public
- */
-export type CenterComponent = ForwardRefExoticComponent<CenterProps>;

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

@@ -1,50 +0,0 @@
-import type { ForwardRefExoticComponent } from 'react';
-import type { BlockProps } from "../../..";
-/**
- * @public
- */
-export type AxisDirection = 'row' | 'column';
-/**
- * @public
- */
-export type MainAxisAlignment = 'start' | 'center' | 'end' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch';
-/**
- * @public
- */
-export type CrossAxisAlignment = 'start' | 'center' | 'end' | 'stretch';
-/**
- * @public
- */
-export interface FlexProps extends BlockProps {
-    /**
-     * Defines how items are placed in the container.
-     */
-    direction?: AxisDirection;
-    /**
-     * Item alignment on the main axis.
-     */
-    mainAxis?: MainAxisAlignment;
-    /**
-     * Item alignment on the cross axis.
-     * Items are centered by default if direction="row".
-     */
-    crossAxis?: CrossAxisAlignment;
-    /**
-     * Render as an inline-level element or as a block-level one?
-     */
-    inline?: boolean;
-    /**
-     * Whether flex items are forced onto one line or can wrap onto multiple lines.
-     */
-    shouldWrap?: boolean;
-    /**
-     * Take available space in the parent.
-     * The parent is required to be Flex for this property to work.
-     * Multiple components with this property set to true are going to split available space equally between them.
-     */
-    shouldFill?: boolean;
-}
-/**
- * @public
- */
-export type FlexComponent = ForwardRefExoticComponent<FlexProps>;

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

@@ -1,4 +0,0 @@
-export * from './block';
-export * from './center';
-export * from './flex';
-export * from './stack';