@tridion-sites/extensions 2.0.1 → 2.0.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @tridion-sites/extensions
 
+## 2.0.2
+
+### Patch Changes
+
+-   Updated dependencies [ed618c0898]
+    -   @tridion-sites/models@1.2.0
+
 ## 2.0.1
 
 ### Patch Changes

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

@@ -0,0 +1,2 @@
+export * from './useActivitiesExplorer';
+export * from './useActivitiesExplorerTable';

package/dist/dts/api/activitiesExplorer/hooks/useActivitiesExplorer.d.ts

@@ -0,0 +1,63 @@
+import type { LoadingState } from "../..";
+import type { ValuesOfArray } from '@tridion/graphene';
+import type { ActivityInstance } from '@tridion-sites/models';
+/**
+ * List of all built-in panel IDs of the Activities Explorer.
+ *
+ * @public
+ */
+export declare const activitiesExplorerPanelIds: readonly ["information", "relatedItems", "processHistory"];
+/**
+ * Type represents ID of a built-in panel of the Activities Explorer.
+ *
+ * @public
+ */
+export type ActivitiesExplorerPanelId = ValuesOfArray<typeof activitiesExplorerPanelIds>;
+/**
+ * All available built-in Activities Explorer panel IDs.
+ *
+ * @public
+ */
+export declare const activitiesExplorerPanelId: {
+    information: "information";
+    relatedItems: "relatedItems";
+    processHistory: "processHistory";
+};
+/**
+ * Data of the Activities Explorer.
+ *
+ * @public
+ */
+export interface ActivitiesExplorerHookResult {
+    /**
+     * List of Activity Instances.
+     */
+    items: ReadonlyArray<ActivityInstance>;
+    /**
+     * The loading state of the Activity Instances list.
+     */
+    itemsLoadingState: LoadingState;
+    /**
+     * Currently active ActivityInstance.
+     */
+    currentItem: ActivityInstance | undefined;
+}
+/**
+ * Hook for accessing Activities Explorer data.
+ *
+ * @remarks
+ * Should be used only inside Activities Explorer, otherwise throws an error.
+ *
+ * @public
+ */
+export type ActivitiesExplorerHook = () => ActivitiesExplorerHookResult;
+/**
+ * Hook for accessing Activities Explorer data when available.
+ *
+ * @remarks
+ * Safe to be used within or outside of the Activities Explorer.
+ * `undefined` is returned when used outside of Activities Explorer.
+ *
+ * @public
+ */
+export type OptionalActivitiesExplorerHook = () => ActivitiesExplorerHookResult | undefined;

package/dist/dts/api/activitiesExplorer/hooks/useActivitiesExplorerTable.d.ts

@@ -0,0 +1,41 @@
+import type { ActivityInstance, ItemUri } from '@tridion-sites/models';
+/**
+ * @public
+ */
+export interface ActivitiesExplorerTableSelection {
+    ids: ReadonlySet<ItemUri>;
+    selectedItems: ReadonlyArray<ActivityInstance>;
+}
+/**
+ * Methods of the Activities Explorer Table.
+ * @public
+ */
+export interface ActivitiesExplorerTableHookResult {
+    /**
+     * Refetch list of Activity Instances.
+     */
+    refresh: () => void;
+    /**
+     * Current state of selected Activity Instances in the Table.
+     */
+    selection: ActivitiesExplorerTableSelection;
+}
+/**
+ * Hook for accessing Activities Explorer Table data and methods.
+ *
+ * @remarks
+ * Should be used only inside Activities Explorer Table, otherwise throws an error.
+ *
+ * @public
+ */
+export type ActivitiesExplorerTableHook = () => ActivitiesExplorerTableHookResult;
+/**
+ * Hook for accessing Activities Explorer Table data and methods when available.
+ *
+ * @remarks
+ * Safe to be used within or outside of the Activities Explorer Table.
+ * `undefined` is returned when used outside of the Activities Explorer Table.
+ *
+ * @public
+ */
+export type OptionalActivitiesExplorerTableHook = () => ActivitiesExplorerTableHookResult | undefined;

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

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

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

@@ -0,0 +1,2 @@
+export * from './propertiesList';
+export * from './propertiesGrid';

package/dist/dts/api/contentExplorer/components/propertiesGrid.d.ts

@@ -0,0 +1,29 @@
+import type { FunctionComponent, ReactNode } from 'react';
+/**
+ * @public
+ */
+export interface PropertyItem {
+    label: ReactNode;
+    value: ReactNode;
+}
+/**
+ * @public
+ */
+export interface PropertiesGridProps {
+    /**
+     * Data to be rendered inside the grid
+     */
+    data: ReadonlyArray<PropertyItem>;
+    /**
+     * Space in pixels between grid rows
+     */
+    rowGap?: number;
+    /**
+     * Space in pixels between grid columns
+     */
+    columnGap?: number;
+}
+/**
+ * @public
+ */
+export type PropertiesGridComponent = FunctionComponent<PropertiesGridProps>;

package/dist/dts/api/contentExplorer/components/propertiesList.d.ts

@@ -0,0 +1,21 @@
+import type { FunctionComponent, ReactNode } from 'react';
+/**
+ * @public
+ */
+export interface PropertyRow {
+    label: ReactNode;
+    value: ReactNode;
+}
+/**
+ * @public
+ */
+export interface PropertiesListProps {
+    /**
+     * List of properties to be displayed
+     */
+    properties: ReadonlyArray<PropertyRow>;
+}
+/**
+ * @public
+ */
+export type PropertiesListComponent = FunctionComponent<PropertiesListProps>;

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

@@ -0,0 +1,102 @@
+import type { IconElementType, ReadonlyHierarchy, ReadonlyHierarchyNode } from '@tridion/graphene';
+import type { IdentifiableObject } from '@tridion-sites/models';
+/**
+ * Basic data contained in a Content Explorer hierarchy node.
+ *
+ * @public
+ */
+export interface ContentExplorerNodeData {
+    /**
+     * Unique ID of the node.
+     */
+    readonly nodeId: string;
+    /**
+     * Title of the node.
+     */
+    readonly title: string;
+}
+/**
+ * Node of the Content Explorer hierarchy.
+ *
+ * @public
+ */
+export type ContentExplorerNode = ReadonlyHierarchyNode<ContentExplorerNodeData>;
+/**
+ * Data contained in a Content Explorer ItemNode.
+ *
+ * @public
+ */
+export interface ContentExplorerItemNodeData<TItem extends IdentifiableObject = IdentifiableObject> extends ContentExplorerNodeData {
+    /**
+     * Tridion item associated with the node.
+     */
+    readonly item: TItem;
+}
+/**
+ * Tridion item node of the Content Explorer hierarchy.
+ *
+ * @public
+ */
+export type ContentExplorerItemNode<TItem extends IdentifiableObject = IdentifiableObject> = ReadonlyHierarchyNode<ContentExplorerItemNodeData<TItem>>;
+/**
+ * Data of Content Explorer structured in a hierarchy form.
+ *
+ * @public
+ */
+export type ContentExplorerHierarchy = ReadonlyHierarchy<ContentExplorerNodeData>;
+/**
+ * Data contained in a Content Explorer SystemNode.
+ *
+ * @public
+ */
+export interface ContentExplorerSystemNodeData extends ContentExplorerNodeData {
+    /**
+     * Icon of the node.
+     */
+    readonly icon: IconElementType;
+}
+/**
+ * Predefined node of the Content Explorer hierarchy.
+ *
+ * @public
+ */
+export type ContentExplorerSystemNode = ReadonlyHierarchyNode<ContentExplorerSystemNodeData>;
+/**
+ * Data contained in a Content Explorer RootNode.
+ *
+ * @public
+ */
+export interface ContentExplorerRootNodeData extends ContentExplorerSystemNodeData {
+}
+/**
+ * Root node of Content Explorer hierarchy.
+ *
+ * @public
+ */
+export type ContentExplorerRootNode = ReadonlyHierarchyNode<ContentExplorerRootNodeData>;
+/**
+ * Data contained in a Content Explorer PublicationsNode.
+ *
+ * @public
+ */
+export interface ContentExplorerPublicationsNodeData extends ContentExplorerSystemNodeData {
+}
+/**
+ * Content Explorer hierarchy node that has list of publications as a children.
+ *
+ * @public
+ */
+export type ContentExplorerPublicationsNode = ReadonlyHierarchyNode<ContentExplorerPublicationsNodeData>;
+/**
+ * Data contained in a Content Explorer ItemsInProgressNode.
+ *
+ * @public
+ */
+export interface ContentExplorerItemsInProgressNodeData extends ContentExplorerSystemNodeData {
+}
+/**
+ * Content Explorer hierarchy node that stores items in progress.
+ *
+ * @public
+ */
+export type ContentExplorerItemsInProgressNode = ReadonlyHierarchyNode<ContentExplorerItemsInProgressNodeData>;

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

@@ -0,0 +1,3 @@
+export * from './useContentExplorer';
+export * from './useContentExplorerTable';
+export * from './useContentExplorerTree';

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

@@ -0,0 +1,123 @@
+import { type ValuesOfArray } from '@tridion/graphene';
+import type { IdentifiableObject, ItemUri } from '@tridion-sites/models';
+import type { ContentExplorerHierarchy, ContentExplorerNode } from '../hierarchy';
+/**
+ * List of all built-in panel IDs of the Content Explorer.
+ *
+ * @public
+ */
+export declare const contentExplorerInsightsPanelIds: readonly ["search", "information", "general", "metadata", "history", "blueprint", "where-used", "view-on-site", "published-to", "translations"];
+/**
+ * Type represents ID of a built-in panel of the Content Explorer.
+ *
+ * @public
+ */
+export type ContentExplorerInsightsPanelId = ValuesOfArray<typeof contentExplorerInsightsPanelIds>;
+/**
+ * All available built-in Content Explorer panel IDs.
+ *
+ * @public
+ */
+export declare const contentExplorerInsightsPanelId: {
+    information: "information";
+    history: "history";
+    search: "search";
+    general: "general";
+    metadata: "metadata";
+    blueprint: "blueprint";
+    "where-used": "where-used";
+    "view-on-site": "view-on-site";
+    "published-to": "published-to";
+    translations: "translations";
+};
+/**
+ * @public
+ */
+export interface SetTargetContentExplorerProps {
+    /**
+     * Id of a container node to resolve to.
+     */
+    containerNodeId: string;
+    /**
+     * Item URI of an item to resolve to inside the `containerNodeId`.
+     */
+    itemInContainerId: ItemUri | undefined;
+}
+/**
+ * @public
+ */
+export interface ContentExplorerHierarchyLoadingState {
+    loadedNodeIds: ReadonlySet<string>;
+    loadingNodeIds: ReadonlySet<string>;
+    reloadingNodeIds: ReadonlySet<string>;
+    firstTimeLoadingNodeIds: ReadonlySet<string>;
+}
+/**
+ * Data and methods of the Content Explorer.
+ *
+ * @public
+ */
+export interface ContentExplorerHookResult {
+    hierarchy: ContentExplorerHierarchy;
+    currentNode: ContentExplorerNode | undefined;
+    /**
+     * Currently active item.
+     */
+    currentItem: IdentifiableObject | undefined;
+    /**
+     * Loading state of nodes of the Content Explorer hierarchy.
+     */
+    hierarchyLoadingState: ContentExplorerHierarchyLoadingState;
+    /**
+     * Method to change current location of the Content Explorer.
+     */
+    setTarget: (props: SetTargetContentExplorerProps) => void;
+}
+/**
+ * Hook for accessing Content Explorer data and methods.
+ *
+ * @remarks
+ * Should be used only inside Content Explorer, otherwise throws an error.
+ *
+ * @public
+ */
+export type ContentExplorerHook = () => ContentExplorerHookResult;
+/**
+ * Hook for accessing Content Explorer data and methods when available.
+ *
+ * @remarks
+ * Safe to be used within or outside of the Content Explorer.
+ * `undefined` is returned when used outside of Content Explorer.
+ *
+ * @public
+ */
+export type OptionalContentExplorerHook = () => ContentExplorerHookResult | undefined;
+/**
+ * Backwards compatibility for `contentExplorerInsightsPanelIds`
+ *
+ * @internal
+ */
+export declare const contentExplorerPanelIds: readonly ["search", "information", "general", "metadata", "history", "blueprint", "where-used", "view-on-site", "published-to", "translations"];
+/**
+ * Backwards compatibility for `contentExplorerInsightsPanelId`
+ *
+ * @internal
+ */
+export declare const contentExplorerPanelId: {
+    information: "information";
+    history: "history";
+    search: "search";
+    general: "general";
+    metadata: "metadata";
+    blueprint: "blueprint";
+    "where-used": "where-used";
+    "view-on-site": "view-on-site";
+    "published-to": "published-to";
+    translations: "translations";
+};
+/**
+ * Backwards compatibility for `ContentExplorerInsightsPanelId`
+ *
+ * @internal
+ */
+export type ContentExplorerPanelId = ContentExplorerInsightsPanelId;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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