@tridion-sites/extensions 2.0.2 → 3.1.0

package/CHANGELOG.md

@@ -1,42 +1,104 @@
 # @tridion-sites/extensions
 
-## 2.0.2
+## 4.0.0
+
+### Minor Changes
+
+- 54bfc05: add search panel id, align naming for panel types
+- a26e909: add favorites management actions
+
+### Patch Changes
+
+- Updated dependencies
+    - @tridion-sites/open-api-client@4.1.0
+    - @tridion-sites/models@2.1.0
+
+## 3.0.1
+
+### Patch Changes
+
+- Fix bug in mapToModel()
+- Updated dependencies
+    - @tridion-sites/models@2.0.1
+
+## 3.0.0
+
+### Major Changes
+
+- f0e6de6: Update TinyMCE to version 7.3.0
+- [BREAKING!] Models: map `Link`s inside content and metadata
+- 458cdf6: [BREAKING!] Make `useEditor().schema` property optional
+- 1de8ac4: react-query@5.0.0 upgrade
+- 4fe96e1: Remove deprecated `containerId` property of mutations
+- 2a39e32: Remove callbacks no longer supported in react-query@5.0.0
+- 23bcf5a: Align API of `useModal()`, `useConfirmation()` and the rest of the hooks
+- e21ab79: `userProfile` returned by `useUserProfile()` can be `undefined`
+- 7cf79a9: OpenAPI v3 update
+
+### Minor Changes
+
+- f220975: Add `isDisabled` prop to field extensions
+- 083504a: Add `demote` action
+- a273c4e: Add `newChildPublication` action
+- 75944cc: Add `removeParentPublication` action
+- ce528c5: Add `promote` action
+- e733693: Add `pasteInContainer` action
+- fed1499: Add optional `boolean` parameters for filtering the `/uses` and `/usedBy` requests
+- 774d7e3: Add `yellow10` to color palette
+- 458cdf6: Add `onUpdate` callback to `useEditor()` hook
+- 8562ee8: Add `Modal` components and `useModal()` hook
+- c3ba102: Add `primaryItem` to `ItemBlueprintHierarchy`
+- e514a9a: Add new OpenAPI v3 error type `ValidationApiError`
+- 928cab3: Add `useContainerItemsQuery()` query
+- 37b7603: Add `includeLocalCopies` parameter for `/usedBy` list
+- 191f8b8: Add required for some item types parameter of `useItemDefaultDataQuery()`
+- 457e67a: Align `containerItem` api across mutations
+- 1cf9db9: Allow control of a failure trigger for demote mutation
+- 527c39f: Make `fieldDefinition` type more specific for `useRichTextField()` hook
+- 871a645: Update major `styled-components`
+- 051b91a: Extensions: Add custom content editor endpoint `ExtensionBuilder.contentEditor.addItemEditor()`
+- 6ff5e58: Models: add generic `ListInfo` type to `IdentifiableObject`
 
 ### Patch Changes
 
--   Updated dependencies [ed618c0898]
-    -   @tridion-sites/models@1.2.0
+- c7a65bc: Models: Update model mapper to fallback to regular component when it can not be distinguished by `ComponentType`
+  Update Extensions API to make new option queries available
+- 82f1c93: Add non localizable fields schema sync api support
+- 2532518: Models: Fix default value for `ItemFieldDefinition.isLocalizable`
+- 1b0165e: Update axios to avoid vulnerability
+- b4d732a: Update to @tridion/graphene@2.6.0
+- ee208c1: Update 3rd party dependencies
 
 ## 2.0.1
 
 ### Patch Changes
 
--   Updated dependencies [c78d191530]
-    -   @tridion-sites/models@1.1.1
+- Updated dependencies [c78d191530]
+    - @tridion-sites/models@1.1.1
 
 ## 2.0.0
 
 ### Minor Changes
 
--   334d76210f: dependency update @tridion/graphene@1.35
--   9e7f89cdc1: - add query `usePublishTransactionsQuery`;
-    -   add to `useActivityInstancesQuery` parameters `ownerId` and `assigneeId`;
-    -   add to `useItemsInProgressQuery` parameter `lockUserId`;
+- 334d76210f: dependency update @tridion/graphene@1.35
+- 9e7f89cdc1: - add query `usePublishTransactionsQuery`;
+    - add to `useActivityInstancesQuery` parameters `ownerId` and `assigneeId`;
+    - add to `useItemsInProgressQuery` parameter `lockUserId`;
 
 ### Patch Changes
 
--   d0875fe171: update dependencies
--   151fa1d3b2: add InsightsPanel mount point for ActivitiesExplorer
--   a6face574b9: add InsightsPanel mount point for PublishingQueueExplorer
--   cc40577cf7: add InsightsPanel mount point for ContentExplorer
--   Updated dependencies [d398729dce]
--   Updated dependencies [b37272386a]
--   Updated dependencies [d0875fe171]
--   Updated dependencies [151fa1d3b2]
--   Updated dependencies [7ff24d55b8]
--   Updated dependencies [14288f4588]
--   Updated dependencies [c75025f64f]
--   Updated dependencies [334d76210f]
--   Updated dependencies [1b257d330c]
-    -   @tridion-sites/open-api-client@3.0.0
-    -   @tridion-sites/models@1.1.0
+- d0875fe171: update dependencies
+- 151fa1d3b2: add InsightsPanel mount point for ActivitiesExplorer
+- a6face574b9: add InsightsPanel mount point for PublishingQueueExplorer
+- cc40577cf7: add InsightsPanel mount point for ContentExplorer
+- Updated dependencies [d398729dce]
+- Updated dependencies [b37272386a]
+- Updated dependencies [d0875fe171]
+- Updated dependencies [151fa1d3b2]
+- Updated dependencies [7ff24d55b8]
+- Updated dependencies [14288f4588]
+- Updated dependencies [c75025f64f]
+- Updated dependencies [334d76210f]
+- Updated dependencies [1b257d330c]
+    - @tridion-sites/open-api-client@3.0.0
+    - @tridion-sites/models@1.1.0

package/dist/index.d.ts

@@ -1737,14 +1737,16 @@ export declare interface ContentExplorerNodeData {
 /**
  * Backwards compatibility for `ContentExplorerInsightsPanelId`
  *
- * @internal
+ * @public
+ * @deprecated use `ContentExplorerInsightsPanelId` instead
  */
 export declare type ContentExplorerPanelId = ContentExplorerInsightsPanelId;
 
 /**
  * Backwards compatibility for `contentExplorerInsightsPanelId`
  *
- * @internal
+ * @public
+ * @deprecated use `contentExplorerInsightsPanelId` instead
  */
 export declare const contentExplorerPanelId: {
     information: "information";
@@ -1762,7 +1764,8 @@ export declare const contentExplorerPanelId: {
 /**
  * Backwards compatibility for `contentExplorerInsightsPanelIds`
  *
- * @internal
+ * @public
+ * @deprecated use `contentExplorerInsightsPanelIds` instead
  */
 export declare const contentExplorerPanelIds: readonly ["search", "information", "general", "metadata", "history", "blueprint", "where-used", "view-on-site", "published-to", "translations"];
 
@@ -3730,13 +3733,12 @@ export declare const navigationItemId: {
     activitiesExplorer: "activitiesExplorer";
     contentExplorer: "contentExplorer";
     publishingQueueExplorer: "publishingQueueExplorer";
-    translationsExplorer: "translationsExplorer";
 };
 
 /**
  * @public
  */
-export declare const navigationItemIds: readonly ["activitiesExplorer", "contentExplorer", "publishingQueueExplorer", "translationsExplorer"];
+export declare const navigationItemIds: readonly ["activitiesExplorer", "contentExplorer", "publishingQueueExplorer"];
 
 /**
  * @public

package/dist/index.js

@@ -47,13 +47,15 @@ const contentExplorerInsightsPanelId = createEnumObject(contentExplorerInsightsP
 /**
  * Backwards compatibility for `contentExplorerInsightsPanelIds`
  *
- * @internal
+ * @public
+ * @deprecated use `contentExplorerInsightsPanelIds` instead
  */
 const contentExplorerPanelIds = contentExplorerInsightsPanelIds;
 /**
  * Backwards compatibility for `contentExplorerInsightsPanelId`
  *
- * @internal
+ * @public
+ * @deprecated use `contentExplorerInsightsPanelId` instead
  */
 const contentExplorerPanelId = contentExplorerInsightsPanelId;
 
@@ -1088,12 +1090,7 @@ class NavigationExtensionsBuilder {
 /**
  * @public
  */
-const navigationItemIds = [
-    'activitiesExplorer',
-    'contentExplorer',
-    'publishingQueueExplorer',
-    'translationsExplorer',
-];
+const navigationItemIds = ['activitiesExplorer', 'contentExplorer', 'publishingQueueExplorer'];
 /**
  * All available built-in navigation item IDs.
  *
@@ -2598,7 +2595,7 @@ const createExtensionGlobals = () => {
     };
 };
 
-const version = "3.0.1";
+const version = "3.1.0";
 const peerDependencies = {
 	"@tridion-sites/models": "workspace:*",
 	"@tridion-sites/open-api-client": "workspace:*",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tridion-sites/extensions",
-  "version": "2.0.2",
+  "version": "3.1.0",
   "description": "Tridion Sites Extensions API",
   "author": "RWS",
   "homepage": "https://www.rws.com",
@@ -22,33 +22,32 @@
     "prepublish": "yarn build"
   },
   "peerDependencies": {
-    "@tridion-sites/models": "1.2.0",
-    "@tridion-sites/open-api-client": "3.0.0",
-    "react": "18.2.0",
-    "react-dom": "18.2.0",
-    "react-is": "18.2.0",
-    "styled-components": "5.3.6",
-    "tinymce": "6.8.4"
+    "@tridion-sites/models": "2.1.0",
+    "@tridion-sites/open-api-client": "4.1.0",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "react-is": "18.3.1",
+    "styled-components": "6.1.13",
+    "tinymce": "7.3.0"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "25.0.4",
-    "@rollup/plugin-json": "6.0.0",
-    "@rollup/plugin-node-resolve": "15.2.1",
-    "@rollup/plugin-typescript": "11.1.3",
-    "@tridion-sites/models": "1.2.0",
-    "@tridion-sites/open-api-client": "3.0.0",
-    "@tridion/graphene": "1.35.2",
-    "@types/react": "18.2.21",
-    "react": "18.2.0",
-    "react-dom": "18.2.0",
-    "react-is": "18.2.0",
-    "rimraf": "5.0.1",
-    "rollup": "3.29.1",
-    "rollup-plugin-delete": "2.0.0",
-    "rollup-plugin-node-externals": "6.1.1",
-    "styled-components": "5.3.6",
-    "tinymce": "6.8.4",
-    "typescript": "5.2.2",
-    "typescript-transform-paths": "3.4.6"
+    "@rollup/plugin-commonjs": "25.0.8",
+    "@rollup/plugin-json": "6.1.0",
+    "@rollup/plugin-node-resolve": "15.3.0",
+    "@rollup/plugin-typescript": "11.1.6",
+    "@tridion-sites/models": "2.1.0",
+    "@tridion-sites/open-api-client": "4.1.0",
+    "@tridion/graphene": "3.4.0",
+    "@types/react": "18.3.11",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "react-is": "18.3.1",
+    "rimraf": "5.0.10",
+    "rollup": "3.29.5",
+    "rollup-plugin-delete": "2.1.0",
+    "rollup-plugin-node-externals": "6.1.2",
+    "tinymce": "7.3.0",
+    "typescript": "5.5.2",
+    "typescript-transform-paths": "3.5.1"
   }
 }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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