@tridion-sites/extensions 2.0.0 → 2.0.2

package/dist/dts/extensionPoints/listBuilder/utils/removeItem.d.ts

@@ -0,0 +1,13 @@
+import type { GetListBuilderItemId, ListBuilderConfiguration } from '../listBuilderExtension';
+/**
+ * @internal
+ */
+export interface RemoveItemArgs<TItem> {
+    list: ListBuilderConfiguration<TItem>;
+    itemId: string;
+    getItemId: GetListBuilderItemId<TItem>;
+}
+/**
+ * @internal
+ */
+export declare const removeItem: <TItem>({ list, itemId, getItemId }: RemoveItemArgs<TItem>) => TItem | undefined;

package/dist/dts/extensionPoints/listBuilder/utils/replaceItem.d.ts

@@ -0,0 +1,14 @@
+import type { GetListBuilderItemId, ListBuilderConfiguration } from '../listBuilderExtension';
+/**
+ * @internal
+ */
+export interface ReplaceItemArgs<TItem> {
+    list: ListBuilderConfiguration<TItem>;
+    itemId: string;
+    newItem: TItem;
+    getItemId: GetListBuilderItemId<TItem>;
+}
+/**
+ * @internal
+ */
+export declare const replaceItem: <TItem>({ list, itemId, newItem, getItemId }: ReplaceItemArgs<TItem>) => void;

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

@@ -0,0 +1,5 @@
+export * from './table';
+export * from './insightsPanels';
+export * from './publishingQueueExplorerActions';
+export * from './publishingQueueExplorerExtensions';
+export * from './publishingQueueExplorerExtensionsBuilder';

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

@@ -0,0 +1,3 @@
+export * from './publishingQueueExplorerInsightsPanelsExtensions';
+export * from './publishingQueueExplorerInsightsPanelsExtensionsBuilder';
+export * from './publishingQueueExplorerInsightsPanelsExtension';

package/dist/dts/extensionPoints/publishingQueueExplorer/insightsPanels/publishingQueueExplorerInsightsPanelsExtension.d.ts

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

package/dist/dts/extensionPoints/publishingQueueExplorer/insightsPanels/publishingQueueExplorerInsightsPanelsExtensions.d.ts

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

package/dist/dts/extensionPoints/publishingQueueExplorer/insightsPanels/publishingQueueExplorerInsightsPanelsExtensionsBuilder.d.ts

@@ -0,0 +1,24 @@
+import { ListBuilder } from '../../listBuilder';
+import type { PublishingQueueExplorerInsightsPanelsExtension } from './publishingQueueExplorerInsightsPanelsExtension';
+import type { PublishingQueueExplorerInsightsPanelsExtensions } from './publishingQueueExplorerInsightsPanelsExtensions';
+/**
+ * @public
+ */
+export declare class PublishingQueueExplorerInsightsPanelsExtensionsBuilder {
+    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 PublishingQueueExplorerInsightsPanelsExtensionsBuilder.config}.
+     *
+     * @param item - insights panel to be registered
+     */
+    register: (item: PublishingQueueExplorerInsightsPanelsExtension) => this;
+    build: () => PublishingQueueExplorerInsightsPanelsExtensions;
+}

package/dist/dts/extensionPoints/publishingQueueExplorer/publishingQueueExplorerActions.d.ts

@@ -0,0 +1,39 @@
+import type { ValuesOfArray } from '@tridion/graphene';
+/**
+ * @public
+ */
+export declare const publishingQueueExplorerActionIds: readonly ["refresh", "export", "delete", "redo"];
+/**
+ * @public
+ */
+export type PublishingQueueExplorerActionId = ValuesOfArray<typeof publishingQueueExplorerActionIds>;
+/**
+ * All built-in action IDs available in Publishing Queue Explorer.
+ *
+ * @public
+ */
+export declare const publishingQueueExplorerActionId: {
+    delete: "delete";
+    export: "export";
+    refresh: "refresh";
+    redo: "redo";
+};
+/**
+ * @public
+ */
+export declare const publishingQueueExplorerActionGroupIds: readonly ["refreshing", "exporting", "publishing", "deleting"];
+/**
+ * @public
+ */
+export type PublishingQueueExplorerActionGroupId = ValuesOfArray<typeof publishingQueueExplorerActionGroupIds>;
+/**
+ * All built-in action group IDs available in Publishing Queue Explorer.
+ *
+ * @public
+ */
+export declare const publishingQueueExplorerActionGroupId: {
+    exporting: "exporting";
+    refreshing: "refreshing";
+    publishing: "publishing";
+    deleting: "deleting";
+};

package/dist/dts/extensionPoints/publishingQueueExplorer/publishingQueueExplorerExtensions.d.ts

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

package/dist/dts/extensionPoints/publishingQueueExplorer/publishingQueueExplorerExtensionsBuilder.d.ts

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

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

@@ -0,0 +1,3 @@
+export * from './publishingQueueExplorerTableColumnExtension';
+export * from './publishingQueueExplorerTableExtensions';
+export * from './publishingQueueExplorerTableExtensionsBuilder';

package/dist/dts/extensionPoints/publishingQueueExplorer/table/publishingQueueExplorerTableActions.d.ts

@@ -0,0 +1,39 @@
+import type { ValuesOfArray } from '@tridion/graphene';
+/**
+ * @public
+ */
+export declare const publishingQueueExplorerTableActionIds: readonly ["refresh", "export", "delete", "redo"];
+/**
+ * @public
+ */
+export type PublishingQueueExplorerTableActionId = ValuesOfArray<typeof publishingQueueExplorerTableActionIds>;
+/**
+ * All built-in action IDs available in Publishing Queue Explorer Table.
+ *
+ * @public
+ */
+export declare const publishingQueueExplorerTableActionId: {
+    delete: "delete";
+    export: "export";
+    refresh: "refresh";
+    redo: "redo";
+};
+/**
+ * @public
+ */
+export declare const publishingQueueExplorerTableActionGroupIds: readonly ["refreshing", "exporting", "publishing", "deleting"];
+/**
+ * @public
+ */
+export type PublishingQueueExplorerTableActionGroupId = ValuesOfArray<typeof publishingQueueExplorerTableActionGroupIds>;
+/**
+ * All built-in action group IDs available in Publishing Queue Explorer Table.
+ *
+ * @public
+ */
+export declare const publishingQueueExplorerTableActionGroupId: {
+    exporting: "exporting";
+    refreshing: "refreshing";
+    publishing: "publishing";
+    deleting: "deleting";
+};

package/dist/dts/extensionPoints/publishingQueueExplorer/table/publishingQueueExplorerTableColumnExtension.d.ts

@@ -0,0 +1,20 @@
+import type { PublishTransaction, PublishTransactionListInfo } from '@tridion-sites/models';
+import type { TableColumnExtension, TableColumnExtensionComponentProps, TableColumnExtensionConfiguration, TableColumnHook } from '../../tableColumnConfiguration';
+/**
+ * @public
+ */
+export interface PublishingQueueExplorerTableColumnExtensionComponentProps extends TableColumnExtensionComponentProps<PublishTransaction<PublishTransactionListInfo>> {
+}
+/**
+ * @public
+ */
+export type PublishingQueueExplorerTableColumnIsAvailableHook = TableColumnHook;
+/**
+ * @public
+ */
+export interface PublishingQueueExplorerTableColumnExtensionConfiguration extends TableColumnExtensionConfiguration<PublishTransaction<PublishTransactionListInfo>> {
+}
+/**
+ * @public
+ */
+export type PublishingQueueExplorerTableColumnExtension = TableColumnExtension<PublishTransaction<PublishTransactionListInfo>>;

package/dist/dts/extensionPoints/publishingQueueExplorer/table/publishingQueueExplorerTableExtensions.d.ts

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

package/dist/dts/extensionPoints/publishingQueueExplorer/table/publishingQueueExplorerTableExtensionsBuilder.d.ts

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

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

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

package/dist/dts/extensionPoints/tableColumnConfiguration/tableColumnExtension.d.ts

@@ -0,0 +1,70 @@
+import type { ComponentType } from 'react';
+import type { IdentifiableObject } from '@tridion-sites/models';
+/**
+ * @public
+ */
+export interface TableColumnExtensionComponentProps<TItem extends IdentifiableObject> {
+    /**
+     * An item associated with the table row where the component is being rendered.
+     */
+    item: TItem;
+}
+/**
+ * @public
+ */
+export interface TableColumnHookResult {
+    /**
+     * Title associated with the column.
+     */
+    readonly title: string;
+    /**
+     * Indicates the availability of the column in the table.
+     *
+     * @remarks
+     * If the property is set to `true` but the column is still not visible in the table,
+     * please make sure that it is enabled in the table configurator.
+     */
+    readonly isAvailable: boolean;
+    /**
+     * Indicates whether the column width can be manually adjusted.
+     */
+    readonly isResizable: boolean;
+    /**
+     * The minimum width that the column can have.
+     */
+    readonly minWidth?: number;
+    /**
+     * The initial width of the column.
+     *
+     * @remarks
+     * If the {@link TableColumnHookResult.isResizable} is set to `true`, this value is utilized for
+     * initial width calculations of each column.
+     * Otherwise, the column will have a fixed width based on this value.
+     */
+    readonly initialWidth?: number;
+}
+/**
+ * @public
+ */
+export type TableColumnHook = () => TableColumnHookResult;
+/**
+ * @public
+ */
+export interface TableColumnExtensionConfiguration<TItem extends IdentifiableObject> {
+    /**
+     * A unique identifier for the column.
+     */
+    readonly id: string;
+    /**
+     * The component to be rendered for each cell that belongs to the column.
+     */
+    readonly component: ComponentType<TableColumnExtensionComponentProps<TItem>>;
+    /**
+     * Hook that contains behavior of the column.
+     */
+    readonly useColumn: TableColumnHook;
+}
+/**
+ * @public
+ */
+export type TableColumnExtension<TItem extends IdentifiableObject> = () => TableColumnExtensionConfiguration<TItem>;

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

@@ -0,0 +1,3 @@
+export * from './translationExtensionsBuilder';
+export * from './translationExtensions';
+export * from './translationItem';

package/dist/dts/extensionPoints/translations/translationExtensions.d.ts

@@ -0,0 +1,7 @@
+import type { TranslationItemExtension } from './translationItem';
+/**
+ * @public
+ */
+export interface TranslationExtensions {
+    translations: ReadonlyArray<TranslationItemExtension>;
+}

package/dist/dts/extensionPoints/translations/translationExtensionsBuilder.d.ts

@@ -0,0 +1,17 @@
+import type { TranslationExtensions } from './translationExtensions';
+import type { LanguageCode } from './translationItem';
+/**
+ * @public
+ */
+export declare class TranslationExtensionsBuilder {
+    private _translations;
+    /**
+     * Adds new translations for the specified language code.
+     *
+     * @param code - Language code.
+     * @param records - Key-value pairs of string translated to `code` language.
+     * @returns instance of `TranslationsExtensionsBuilder`
+     */
+    addTranslation: (code: LanguageCode, records: Record<string, any>) => this;
+    build: () => TranslationExtensions;
+}

package/dist/dts/extensionPoints/translations/translationItem.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @public
+ */
+export type TranslationItemExtension = () => TranslationItemExtensionConfiguration;
+/**
+ * All built-in language codes available in the system.
+ *
+ * @public
+ */
+export type LanguageCode = 'de' | 'en' | 'es' | 'fr' | 'nl' | 'zh' | 'ja';
+/**
+ * @public
+ */
+export interface TranslationItemExtensionConfiguration {
+    /**
+     * A code used to identify a specific language.
+     */
+    readonly code: LanguageCode;
+    /**
+     * Key-value pairs of string translated to {@link TranslationItemExtensionConfiguration.code} language.
+     */
+    readonly records: Record<string, any>;
+}

package/dist/dts/frameworkInfo.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @public
+ */
+export declare const frameworkInfo: {
+    version: string;
+    peerDependencies: Record<string, string>;
+};

package/dist/dts/index.d.ts

@@ -0,0 +1,6 @@
+export * from './api';
+export * from './extensionPoints';
+export * from './apiBridge';
+export * from './apiWrappers';
+export * from './module';
+export * from './frameworkInfo';

package/dist/dts/module/createExtensionGlobals.d.ts

@@ -0,0 +1,11 @@
+import type { ExtensionGlobals } from './extensionGlobals';
+/**
+ * @public
+ */
+export interface CreateExtensionGlobalsResult extends ExtensionGlobals {
+    initialize: (globals: ExtensionGlobals) => void;
+}
+/**
+ * @public
+ */
+export declare const createExtensionGlobals: () => CreateExtensionGlobalsResult;

package/dist/dts/module/extensionGlobals.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @public
+ */
+export interface ExtensionGlobals {
+    t: (key: string, options?: Record<string, any>) => string;
+    getConfiguration: <T extends Record<string, any>>() => T | undefined;
+}

package/dist/dts/module/extensionModule.d.ts

@@ -0,0 +1,11 @@
+import type { ExtensionBuilder } from '../extensionPoints';
+import type { ExtensionGlobals } from './extensionGlobals';
+import type { RuntimeInformation } from './runtimeInformation';
+/**
+ * @public
+ */
+export interface ExtensionModule {
+    runtimeInfo: RuntimeInformation;
+    initializeGlobals: (globals: ExtensionGlobals) => void;
+    initialize: (builder: ExtensionBuilder) => void;
+}

package/dist/dts/module/index.d.ts

@@ -0,0 +1,4 @@
+export * from './createExtensionGlobals';
+export * from './extensionGlobals';
+export * from './extensionModule';
+export * from './runtimeInformation';

package/dist/dts/module/runtimeInformation.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @public
+ */
+export interface RuntimeInformation {
+    name: string;
+    peerDependencies: Record<string, string>;
+}