@tridion-sites/extensions 2.0.0 → 2.0.2

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

@@ -0,0 +1,10 @@
+import type { ListBuilderConfiguration, ListBuilderConfigurationExtension } from '../listBuilder';
+import type { ActionGroup } from './actionGroup';
+/**
+ * @public
+ */
+export type ActionsConfiguration = ListBuilderConfiguration<ActionGroup>;
+/**
+ * @public
+ */
+export type ActionsConfigurationExtension = ListBuilderConfigurationExtension<ActionGroup>;

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

@@ -0,0 +1,70 @@
+import type { ListBuilderConfigurationExtension } from '../listBuilder';
+import type { ActionGroup } from './actionGroup';
+/**
+ * @public
+ */
+export declare class ActionsConfigurationExtensionsBuilder {
+    private _groupListBuilder;
+    /**
+     * Adds a new group to the group list.
+     *
+     * @param group - group to be added
+     * @param beforeGroupId - id of the group before which the new group will be inserted
+     */
+    addGroup: (group: ActionGroup, beforeGroupId?: string) => void;
+    /**
+     * Removes a group from the group list.
+     *
+     * @param groupId - id of the group to be removed
+     */
+    removeGroup: (groupId: string) => void;
+    /**
+     * Moves a group within the group list.
+     *
+     * @param groupId - id of the group to be moved
+     * @param beforeGroupId - id of the group before which the group will be moved
+     */
+    moveGroup: (groupId: string, beforeGroupId: string | undefined) => void;
+    /**
+     * Replaces a group in the group list.
+     *
+     * @param groupId - id of the group to be replaced
+     * @param group - new group to replace the existing group
+     */
+    replaceGroup: (groupId: string, group: ActionGroup) => void;
+    /**
+     * Customizes the group configuration in the group list.
+     *
+     * @param groupConfiguration - current configuration of the groups.
+     */
+    customizeGroup: (groupConfiguration: ListBuilderConfigurationExtension<ActionGroup>) => void;
+    /**
+     * Adds action to a specified group. New action can be added in a specified order using `beforeActionId`.
+     *
+     * @param groupId - id of the group to which the action will be added
+     * @param actionId - id of the action to be added
+     * @param beforeActionId - id of the action before which the new action will be inserted
+     */
+    addAction: (groupId: string, actionId: string, beforeActionId?: string) => void;
+    /**
+     * Removes action from the group(s).
+     *
+     * @param actionId - id of the action to be removed
+     */
+    removeAction: (actionId: string) => void;
+    /**
+     * Replaces an action with a new action id in the group(s).
+     *
+     * @param actionId - id of the action to be replaced
+     * @param newActionId - id of the new action
+     */
+    replaceAction: (actionId: string, newActionId: string) => void;
+    /**
+     * Moves an action withing other actions in the same (or other) group(s).
+     *
+     * @param actionId - id of the action to be moved
+     * @param beforeActionId - id of the action before which the moved action will be inserted
+     */
+    moveAction: (actionId: string, beforeActionId: string | undefined) => void;
+    build: () => ReadonlyArray<ListBuilderConfigurationExtension<ActionGroup>>;
+}

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

@@ -0,0 +1,4 @@
+export * from './actionExtension';
+export * from './actionGroup';
+export * from './actionsConfigurationExtension';
+export * from './actionsConfigurationExtensionsBuilder';

package/dist/dts/extensionPoints/activitiesExplorer/activitiesExplorerActions.d.ts

@@ -0,0 +1,40 @@
+import type { ValuesOfArray } from '@tridion/graphene';
+/**
+ * @public
+ */
+export declare const activitiesExplorerActionIds: readonly ["export", "refresh", "startActivity", "finishActivity", "restartActivity", "assignActivity"];
+/**
+ * @public
+ */
+export type ActivitiesExplorerActionId = ValuesOfArray<typeof activitiesExplorerActionIds>;
+/**
+ * All built-in action IDs available in Activities Explorer.
+ *
+ * @public
+ */
+export declare const activitiesExplorerActionId: {
+    assignActivity: "assignActivity";
+    startActivity: "startActivity";
+    finishActivity: "finishActivity";
+    restartActivity: "restartActivity";
+    export: "export";
+    refresh: "refresh";
+};
+/**
+ * @public
+ */
+export declare const activitiesExplorerActionGroupIds: readonly ["exporting", "refreshing", "workflow"];
+/**
+ * @public
+ */
+export type ActivitiesExplorerActionGroupId = ValuesOfArray<typeof activitiesExplorerActionGroupIds>;
+/**
+ * All built-in action group IDs available in Activities Explorer.
+ *
+ * @public
+ */
+export declare const activitiesExplorerActionGroupId: {
+    exporting: "exporting";
+    refreshing: "refreshing";
+    workflow: "workflow";
+};

package/dist/dts/extensionPoints/activitiesExplorer/activitiesExplorerExtensions.d.ts

@@ -0,0 +1,11 @@
+import type { ActionExtension } from '../actionsConfiguration';
+import type { ActivitiesExplorerInsightsPanelsExtensions } from './insightsPanels';
+import type { ActivitiesExplorerTableExtensions } from './table';
+/**
+ * @public
+ */
+export interface ActivitiesExplorerExtensions {
+    actions: ReadonlyArray<ActionExtension>;
+    table: ActivitiesExplorerTableExtensions;
+    insightsPanels: ActivitiesExplorerInsightsPanelsExtensions;
+}

package/dist/dts/extensionPoints/activitiesExplorer/activitiesExplorerExtensionsBuilder.d.ts

@@ -0,0 +1,25 @@
+import type { ActionExtension } from '../actionsConfiguration';
+import type { ActivitiesExplorerExtensions } from './activitiesExplorerExtensions';
+import { ActivitiesExplorerInsightsPanelsExtensionsBuilder } from './insightsPanels';
+import { ActivitiesExplorerTableExtensionsBuilder } from './table';
+/**
+ * @public
+ */
+export declare class ActivitiesExplorerExtensionsBuilder {
+    private _actions;
+    /**
+     * Provides a mechanism for customizing Activities Explorer Table.
+     */
+    readonly table: ActivitiesExplorerTableExtensionsBuilder;
+    /**
+     * Provides a mechanism for customizing Activities Explorer Insights Panels.
+     */
+    readonly insightsPanels: ActivitiesExplorerInsightsPanelsExtensionsBuilder;
+    /**
+     * Adds a new action to Activities Explorer.
+     *
+     * @param action - action to be added
+     */
+    addAction: (action: ActionExtension) => this;
+    build: () => ActivitiesExplorerExtensions;
+}

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

@@ -0,0 +1,5 @@
+export * from './table';
+export * from './insightsPanels';
+export * from './activitiesExplorerActions';
+export * from './activitiesExplorerExtensions';
+export * from './activitiesExplorerExtensionsBuilder';

package/dist/dts/extensionPoints/activitiesExplorer/insightsPanels/activitiesExplorerInsightsPanelsExtension.d.ts

@@ -0,0 +1,18 @@
+import type { ItemUri } from '@tridion-sites/models';
+import type { InsightsPanelsExtensionConfiguration } from '../../insightsPanels';
+/**
+ * @public
+ */
+export interface ActivitiesExplorerExtensionInsightsPanelProps {
+    activityId: ItemUri;
+}
+/**
+ * @public
+ */
+export interface ActivitiesExplorerInsightsPanelsHookProps {
+    activityId?: ItemUri;
+}
+/**
+ * @public
+ */
+export type ActivitiesExplorerInsightsPanelsExtension = () => InsightsPanelsExtensionConfiguration<ActivitiesExplorerExtensionInsightsPanelProps, ActivitiesExplorerInsightsPanelsHookProps>;

package/dist/dts/extensionPoints/activitiesExplorer/insightsPanels/activitiesExplorerInsightsPanelsExtensions.d.ts

@@ -0,0 +1,9 @@
+import type { ListBuilderConfigurationExtension } from '../../listBuilder';
+import type { ActivitiesExplorerInsightsPanelsExtension } from './activitiesExplorerInsightsPanelsExtension';
+/**
+ * @public
+ */
+export interface ActivitiesExplorerInsightsPanelsExtensions {
+    items: ReadonlyArray<ActivitiesExplorerInsightsPanelsExtension>;
+    config: ReadonlyArray<ListBuilderConfigurationExtension<string>>;
+}

package/dist/dts/extensionPoints/activitiesExplorer/insightsPanels/activitiesExplorerInsightsPanelsExtensionsBuilder.d.ts

@@ -0,0 +1,24 @@
+import { ListBuilder } from '../../listBuilder';
+import type { ActivitiesExplorerInsightsPanelsExtension } from './activitiesExplorerInsightsPanelsExtension';
+import type { ActivitiesExplorerInsightsPanelsExtensions } from './activitiesExplorerInsightsPanelsExtensions';
+/**
+ * @public
+ */
+export declare class ActivitiesExplorerInsightsPanelsExtensionsBuilder {
+    private _insightsPanelsExtensions;
+    /**
+     * Provides a mechanism for customizing the configuration of insights panels.
+     */
+    readonly config: ListBuilder<string>;
+    /**
+     * Registers a new insights panel.
+     *
+     * @remarks
+     * This method only registers the insights panel and does not automatically make it visible in the application.
+     * To add the insights panel to the application, use {@link ActivitiesExplorerInsightsPanelsExtensionsBuilder.config}.
+     *
+     * @param item - insights panel to be registered
+     */
+    register: (item: ActivitiesExplorerInsightsPanelsExtension) => this;
+    build: () => ActivitiesExplorerInsightsPanelsExtensions;
+}

package/dist/dts/extensionPoints/activitiesExplorer/insightsPanels/index.d.ts

@@ -0,0 +1,3 @@
+export * from './activitiesExplorerInsightsPanelsExtension';
+export * from './activitiesExplorerInsightsPanelsExtensions';
+export * from './activitiesExplorerInsightsPanelsExtensionsBuilder';

package/dist/dts/extensionPoints/activitiesExplorer/table/activitiesExplorerTableActions.d.ts

@@ -0,0 +1,41 @@
+import type { ValuesOfArray } from '@tridion/graphene';
+/**
+ * @public
+ */
+export declare const activitiesExplorerTableActionIds: readonly ["export", "refresh", "startActivity", "finishActivity", "restartActivity", "assignActivity", "open"];
+/**
+ * @public
+ */
+export type ActivitiesExplorerTableActionId = ValuesOfArray<typeof activitiesExplorerTableActionIds>;
+/**
+ * All built-in action IDs available in Activities Explorer Table.
+ *
+ * @public
+ */
+export declare const activitiesExplorerTableActionId: {
+    assignActivity: "assignActivity";
+    startActivity: "startActivity";
+    finishActivity: "finishActivity";
+    restartActivity: "restartActivity";
+    export: "export";
+    refresh: "refresh";
+    open: "open";
+};
+/**
+ * @public
+ */
+export declare const activitiesExplorerTableActionGroupIds: readonly ["exporting", "refreshing", "workflow"];
+/**
+ * @public
+ */
+export type ActivitiesExplorerTableActionGroupId = ValuesOfArray<typeof activitiesExplorerTableActionGroupIds>;
+/**
+ * All built-in action group IDs available in Activities Explorer Table.
+ *
+ * @public
+ */
+export declare const activitiesExplorerTableActionGroupId: {
+    exporting: "exporting";
+    refreshing: "refreshing";
+    workflow: "workflow";
+};

package/dist/dts/extensionPoints/activitiesExplorer/table/activitiesExplorerTableColumnExtension.d.ts

@@ -0,0 +1,20 @@
+import type { ActivityInstance } from '@tridion-sites/models';
+import type { TableColumnExtension, TableColumnExtensionComponentProps, TableColumnExtensionConfiguration, TableColumnHook } from '../../tableColumnConfiguration';
+/**
+ * @public
+ */
+export interface ActivitiesExplorerTableColumnExtensionComponentProps extends TableColumnExtensionComponentProps<ActivityInstance> {
+}
+/**
+ * @public
+ */
+export type ActivitiesExplorerTableColumnIsAvailableHook = TableColumnHook;
+/**
+ * @public
+ */
+export interface ActivitiesExplorerTableColumnExtensionConfiguration extends TableColumnExtensionConfiguration<ActivityInstance> {
+}
+/**
+ * @public
+ */
+export type ActivitiesExplorerTableColumnExtension = TableColumnExtension<ActivityInstance>;

package/dist/dts/extensionPoints/activitiesExplorer/table/activitiesExplorerTableExtensions.d.ts

@@ -0,0 +1,10 @@
+import type { ActionsConfigurationExtension } from '../../actionsConfiguration';
+import type { ActivitiesExplorerTableColumnExtension } from './activitiesExplorerTableColumnExtension';
+/**
+ * @public
+ */
+export interface ActivitiesExplorerTableExtensions {
+    columns: ReadonlyArray<ActivitiesExplorerTableColumnExtension>;
+    contextMenu: ReadonlyArray<ActionsConfigurationExtension>;
+    toolbar: ReadonlyArray<ActionsConfigurationExtension>;
+}

package/dist/dts/extensionPoints/activitiesExplorer/table/activitiesExplorerTableExtensionsBuilder.d.ts

@@ -0,0 +1,26 @@
+import { ActionsConfigurationExtensionsBuilder } from '../../actionsConfiguration';
+import type { ActivitiesExplorerTableColumnExtension } from './activitiesExplorerTableColumnExtension';
+import type { ActivitiesExplorerTableExtensions } from './activitiesExplorerTableExtensions';
+/**
+ * @public
+ */
+export declare class ActivitiesExplorerTableExtensionsBuilder {
+    private _columns;
+    /**
+     * Provides a mechanism for customizing the configuration of actions
+     * within Activities Explorer Table toolbar.
+     */
+    readonly toolbar: ActionsConfigurationExtensionsBuilder;
+    /**
+     * Provides a mechanism for customizing the configuration of actions
+     * within Activities Explorer Table context menu.
+     */
+    readonly contextMenu: ActionsConfigurationExtensionsBuilder;
+    /**
+     * Adds a new column to Activities Explorer Table.
+     *
+     * @param column - column to be added
+     */
+    addColumn: (column: ActivitiesExplorerTableColumnExtension) => this;
+    build: () => ActivitiesExplorerTableExtensions;
+}

package/dist/dts/extensionPoints/activitiesExplorer/table/index.d.ts

@@ -0,0 +1,3 @@
+export * from './activitiesExplorerTableColumnExtension';
+export * from './activitiesExplorerTableExtensions';
+export * from './activitiesExplorerTableExtensionsBuilder';

package/dist/dts/extensionPoints/contentEditor/contentEditorExtensions.d.ts

@@ -0,0 +1,11 @@
+import type { ContentEditorFormFieldExtension } from './contentEditorFormFieldExtension';
+import type { ContentEditorViewExtension } from './contentEditorViewExtension';
+import type { RichTextFieldExtensions } from './richTextField';
+/**
+ * @public
+ */
+export interface ContentEditorExtensions {
+    richTextField: RichTextFieldExtensions;
+    formFields: ReadonlyArray<ContentEditorFormFieldExtension>;
+    editors: ReadonlyArray<ContentEditorViewExtension>;
+}

package/dist/dts/extensionPoints/contentEditor/contentEditorExtensionsBuilder.d.ts

@@ -0,0 +1,15 @@
+import type { ContentEditorExtensions } from './contentEditorExtensions';
+import type { ContentEditorFormFieldExtension } from './contentEditorFormFieldExtension';
+import type { ContentEditorViewExtension } from './contentEditorViewExtension';
+import { RichTextFieldExtensionsBuilder } from './richTextField';
+/**
+ * @public
+ */
+export declare class ContentEditorExtensionsBuilder {
+    private _formFields;
+    private _itemEditors;
+    readonly richTextField: RichTextFieldExtensionsBuilder;
+    addFormField: (item: ContentEditorFormFieldExtension) => this;
+    addItemEditor: (item: ContentEditorViewExtension) => this;
+    build: () => ContentEditorExtensions;
+}

package/dist/dts/extensionPoints/contentEditor/contentEditorFormFieldExtension.d.ts

@@ -0,0 +1,85 @@
+import type { ComponentType, ReactNode } from 'react';
+import type { ItemFieldDefinition } from '@tridion-sites/models';
+/**
+ * @public
+ */
+export interface ContentEditorFormFieldExtensionProps<T = any> {
+    /**
+     * Value of the field
+     */
+    value: T;
+    /**
+     * Field definition of the form field
+     */
+    fieldDefinition: ItemFieldDefinition;
+    /**
+     * Boolean to indicate whether the field should be rendered in read only mode
+     */
+    isReadOnly: boolean;
+    /**
+     * Boolean to indicate whether the field should be rendered in a disabled state
+     */
+    isDisabled: boolean;
+    /**
+     * Set field value function
+     */
+    setValue: (value: T) => void;
+    /**
+     * Original field to render
+     */
+    renderField: ReactNode;
+}
+/**
+ * @public
+ */
+export interface ContentEditorFormFieldHookProps {
+    /**
+     * Indicates whether the field is rendered in read only mode or not
+     */
+    isReadOnly: boolean;
+    /**
+     * Indicates whether the field is rendered in disabled mode or not
+     */
+    isDisabled: boolean;
+    /**
+     * Field definition of the form field
+     */
+    fieldDefinition: ItemFieldDefinition;
+}
+/**
+ * @public
+ */
+export interface ContentEditorFormFieldHookResult {
+    /**
+     * Priority value of the field in the list of candidates for rendering.
+     * Extension with a higher priority will be displayed instead of an extension with lower priority.
+     * Helps to resolve collapsing cases when useIsAvailable returns true for two or more
+     * extensions for a single field at the same time.
+     */
+    priority?: number;
+    /**
+     * Defines whether the field extension is available to be displayed or not
+     */
+    isAvailable: boolean;
+}
+/**
+ * @public
+ */
+export interface ContentEditorFormFieldExtensionConfiguration {
+    /**
+     * Extension id
+     */
+    readonly id: string;
+    /**
+     * Component to render on this path
+     */
+    readonly component: ComponentType<ContentEditorFormFieldExtensionProps>;
+    /**
+     * Hook which returns information about the current field for the extension
+     */
+    readonly useFormField: (props: ContentEditorFormFieldHookProps) => ContentEditorFormFieldHookResult;
+}
+/**
+ * @public
+ */
+export type ContentEditorFormFieldExtension = () => ContentEditorFormFieldExtensionConfiguration;

package/dist/dts/extensionPoints/contentEditor/contentEditorViewExtension.d.ts

@@ -0,0 +1,69 @@
+import type { ComponentType, ReactNode } from 'react';
+import type { IdentifiableObject } from '@tridion-sites/models';
+/**
+ * @public
+ */
+export interface ContentEditorViewExtensionComponentProps {
+    /**
+     * Item to edit/view
+     */
+    item: IdentifiableObject;
+    /**
+     * Boolean to indicate whether the editor should be rendered in read-only mode
+     */
+    isReadonly: boolean;
+    /**
+     * Original editor to render
+     */
+    renderEditor: ReactNode;
+}
+/**
+ * @public
+ */
+export interface ContentEditorViewHookProps {
+    /**
+     * Indicates whether the content is rendered in read-only mode or not
+     */
+    isReadonly: boolean;
+    /**
+     * Item is being passed to editor
+     */
+    item: IdentifiableObject;
+}
+/**
+ * @public
+ */
+export interface ContentEditorViewHookResult {
+    /**
+     * Priority value of the custom editor in the list of candidates for rendering.
+     * Extension with a higher priority will be displayed instead of an extension with lower priority.
+     * Helps to resolve collapsing cases when useIsAvailable returns true for two or more
+     * extensions for a single editor at the same time.
+     */
+    priority?: number;
+    /**
+     * Defines whether the content extension is available to be displayed or not
+     */
+    isAvailable: boolean;
+}
+/**
+ * @public
+ */
+export interface ContentEditorViewExtensionConfiguration {
+    /**
+     * Extension id
+     */
+    readonly id: string;
+    /**
+     * Component to render on this path
+     */
+    readonly component: ComponentType<ContentEditorViewExtensionComponentProps>;
+    /**
+     * Hook which returns information about the current content for the extension
+     */
+    readonly useContentEditorView: (props: ContentEditorViewHookProps) => ContentEditorViewHookResult;
+}
+/**
+ * @public
+ */
+export type ContentEditorViewExtension<TItem = any> = () => ContentEditorViewExtensionConfiguration;

package/dist/dts/extensionPoints/contentEditor/index.d.ts

@@ -0,0 +1,5 @@
+export * from './contentEditorExtensions';
+export * from './contentEditorExtensionsBuilder';
+export * from './contentEditorFormFieldExtension';
+export * from './contentEditorViewExtension';
+export * from './richTextField';

package/dist/dts/extensionPoints/contentEditor/richTextField/index.d.ts

@@ -0,0 +1,2 @@
+export * from './richTextFieldExtensions';
+export * from './richTextFieldExtensionsBuilder';

package/dist/dts/extensionPoints/contentEditor/richTextField/richTextFieldExtensions.d.ts

@@ -0,0 +1,64 @@
+import type { Editor, RawEditorOptions } from 'tinymce';
+import type { XhtmlFieldDefinition } from '@tridion-sites/models';
+/**
+ * @public
+ */
+export type RichTextFieldOptions = Omit<RawEditorOptions, 'id' | 'selector' | 'setup' | 'target'>;
+/**
+ * @public
+ */
+export type RichTextFieldCustomization = (configuration: RichTextFieldOptions) => void;
+/**
+ * @public
+ */
+export type RichTextFieldSetup = RawEditorOptions['setup'];
+/**
+ * @public
+ */
+export type RichTextFieldHookResult = {
+    readonly customize?: RichTextFieldCustomization;
+    readonly setup?: RichTextFieldSetup;
+    readonly isAvailable: boolean;
+};
+/**
+ * @public
+ */
+export interface RichTextFieldHookProps {
+    /**
+     * Indicates whether the field is rendered in read only mode or not
+     */
+    isReadOnly: boolean;
+    /**
+     * Indicates whether the field is editable or not
+     */
+    isDisabled: boolean;
+    /**
+     * Field definition of the form field
+     */
+    fieldDefinition: XhtmlFieldDefinition;
+}
+/**
+ * @public
+ */
+export type RichTextFieldHook = (props: RichTextFieldHookProps) => RichTextFieldHookResult;
+/**
+ * @public
+ */
+export interface RichTextFieldConfig {
+    readonly id: string;
+    readonly useRichTextField: RichTextFieldHook;
+}
+/**
+ * @public
+ */
+export interface RichTextFieldPlugin {
+    readonly id: string;
+    readonly plugin: (editor: Editor) => void;
+}
+/**
+ * @public
+ */
+export interface RichTextFieldExtensions {
+    readonly customizations: RichTextFieldConfig[];
+    readonly plugins: RichTextFieldPlugin[];
+}

package/dist/dts/extensionPoints/contentEditor/richTextField/richTextFieldExtensionsBuilder.d.ts

@@ -0,0 +1,11 @@
+import type { RichTextFieldConfig, RichTextFieldExtensions, RichTextFieldPlugin } from './richTextFieldExtensions';
+/**
+ * @public
+ */
+export declare class RichTextFieldExtensionsBuilder {
+    private _customizations;
+    private _plugins;
+    customize: (customization: RichTextFieldConfig) => this;
+    registerPlugin: (plugin: RichTextFieldPlugin) => this;
+    build: () => RichTextFieldExtensions;
+}