@tridion-sites/extensions 2.0.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -24,6 +24,8 @@ import type { KeyboardEvent as KeyboardEvent_2 } from 'react';
24
24
  import type { Keyword } from '@tridion-sites/models';
25
25
  import type { KeywordCategory } from '@tridion-sites/models';
26
26
  import type { Link as Link_2 } from '@tridion-sites/models';
27
+ import type { ListDetailsLevel } from '@tridion-sites/models';
28
+ import type { ListInfoDictionary } from '@tridion-sites/models';
27
29
  import type { MouseEvent as MouseEvent_2 } from 'react';
28
30
  import type { MultimediaComponent } from '@tridion-sites/models';
29
31
  import type { Page } from '@tridion-sites/models';
@@ -34,6 +36,7 @@ import type { PublicationBlueprintHierarchy } from '@tridion-sites/models';
34
36
  import type { PublishInfo } from '@tridion-sites/models';
35
37
  import type { PublishPriority } from '@tridion-sites/models';
36
38
  import type { PublishTransaction } from '@tridion-sites/models';
39
+ import type { PublishTransactionListInfo } from '@tridion-sites/models';
37
40
  import type { PublishTransactionsCreationResult } from '@tridion-sites/models';
38
41
  import type { PublishTransactionState } from '@tridion-sites/models';
39
42
  import type { PublishUrlInfo } from '@tridion-sites/models';
@@ -58,6 +61,7 @@ import type { User } from '@tridion-sites/models';
58
61
  import type { UserGroup } from '@tridion-sites/models';
59
62
  import type { UserProfile } from '@tridion-sites/models';
60
63
  import type { VersionedItem } from '@tridion-sites/models';
64
+ import type { XhtmlFieldDefinition } from '@tridion-sites/models';
61
65
 
62
66
  /**
63
67
  * Accessibility-related props
@@ -245,12 +249,12 @@ export declare type ActivitiesExplorerActionId = ValuesOfArray<typeof activities
245
249
  * @public
246
250
  */
247
251
  export declare const activitiesExplorerActionId: {
248
- export: "export";
249
- refresh: "refresh";
252
+ assignActivity: "assignActivity";
250
253
  startActivity: "startActivity";
251
254
  finishActivity: "finishActivity";
252
255
  restartActivity: "restartActivity";
253
- assignActivity: "assignActivity";
256
+ export: "export";
257
+ refresh: "refresh";
254
258
  };
255
259
 
256
260
  /**
@@ -677,9 +681,9 @@ export declare interface AutoClassifyItemsRequest {
677
681
  */
678
682
  itemIds: ReadonlyArray<ItemUri>;
679
683
  /**
680
- * Container item ID of the items to classify.
684
+ * Container of an item to classify.
681
685
  */
682
- containerId: ItemUri;
686
+ containerItem?: IdentifiableObject;
683
687
  }
684
688
 
685
689
  /**
@@ -799,7 +803,7 @@ export declare interface BundleEditorHookResult {
799
803
  /**
800
804
  * Bundle's metadata schema.
801
805
  */
802
- metadataSchema: Schema;
806
+ metadataSchema: Schema | undefined;
803
807
  /**
804
808
  * Boolean that indicates that Bundle has unsaved changes.
805
809
  */
@@ -873,10 +877,6 @@ export declare interface CategoryEditorHookResult {
873
877
  * Editable Category.
874
878
  */
875
879
  category: KeywordCategory;
876
- /**
877
- * Category's metadata schema.
878
- */
879
- metadataSchema: Schema;
880
880
  /**
881
881
  * Boolean that indicates that Category has unsaved changes.
882
882
  */
@@ -996,6 +996,7 @@ export declare interface ColorPalette {
996
996
  magenta50: string;
997
997
  magenta100: string;
998
998
  magenta120: string;
999
+ yellow10: string;
999
1000
  yellow50: string;
1000
1001
  yellow100: string;
1001
1002
  yellow120: string;
@@ -1037,9 +1038,9 @@ export declare interface ComponentEditorHookResult {
1037
1038
  */
1038
1039
  component: Component | MultimediaComponent | ExternalMultimediaComponent;
1039
1040
  /**
1040
- * Component's metadata schema.
1041
+ * Component's content and metadata schema.
1041
1042
  */
1042
- schema: Schema;
1043
+ schema: Schema | undefined;
1043
1044
  /**
1044
1045
  * Boolean that indicates that Component has unsaved changes.
1045
1046
  */
@@ -1095,16 +1096,50 @@ export declare interface ConfirmationHookArguments {
1095
1096
  /**
1096
1097
  * @public
1097
1098
  */
1098
- export declare type ConfirmationHookResult = () => void;
1099
+ export declare interface ConfirmationHookResult {
1100
+ open: () => void;
1101
+ }
1099
1102
 
1100
1103
  declare type Constructor<T> = abstract new (...args: any[]) => T;
1101
1104
 
1105
+ /**
1106
+ * @public
1107
+ */
1108
+ export declare type ContainerItemsQueryHook = (props?: ContainerItemsQueryProps, options?: QueryOptions<ReadonlyArray<RepositoryLocalObject> | undefined, ApiError>) => QueryResult<ReadonlyArray<RepositoryLocalObject> | undefined, ApiError>;
1109
+
1110
+ /**
1111
+ * @public
1112
+ */
1113
+ export declare interface ContainerItemsQueryProps {
1114
+ /**
1115
+ * The Item URI of an organizational item, such as a Bundle, Category, Folder, Virtual folder, or Structure Group.
1116
+ */
1117
+ itemId: ItemUri;
1118
+ /**
1119
+ * Loads a dynamic version (if available for the current user)
1120
+ */
1121
+ useDynamicVersion?: boolean;
1122
+ /**
1123
+ * The item types of all repository-local objects that you want to include in the response.
1124
+ */
1125
+ rloItemTypes?: ReadonlyArray<RloItemType>;
1126
+ /**
1127
+ * Option to control how much data is returned per item.
1128
+ */
1129
+ detailsLevel?: ListDetailsLevel;
1130
+ /**
1131
+ * Determines if nested Organizational Items (recursively) should also be returned.
1132
+ */
1133
+ isRecursive?: boolean;
1134
+ }
1135
+
1102
1136
  /**
1103
1137
  * @public
1104
1138
  */
1105
1139
  export declare interface ContentEditorExtensions {
1106
1140
  richTextField: RichTextFieldExtensions;
1107
1141
  formFields: ReadonlyArray<ContentEditorFormFieldExtension>;
1142
+ editors: ReadonlyArray<ContentEditorViewExtension>;
1108
1143
  }
1109
1144
 
1110
1145
  /**
@@ -1112,8 +1147,10 @@ export declare interface ContentEditorExtensions {
1112
1147
  */
1113
1148
  export declare class ContentEditorExtensionsBuilder {
1114
1149
  private _formFields;
1150
+ private _itemEditors;
1115
1151
  readonly richTextField: RichTextFieldExtensionsBuilder;
1116
1152
  addFormField: (item: ContentEditorFormFieldExtension) => this;
1153
+ addItemEditor: (item: ContentEditorViewExtension) => this;
1117
1154
  build: () => ContentEditorExtensions;
1118
1155
  }
1119
1156
 
@@ -1153,9 +1190,13 @@ export declare interface ContentEditorFormFieldExtensionProps<T = any> {
1153
1190
  */
1154
1191
  fieldDefinition: ItemFieldDefinition;
1155
1192
  /**
1156
- * Boolean to indicate of the field is rendered in read only mode
1193
+ * Boolean to indicate whether the field should be rendered in read only mode
1157
1194
  */
1158
1195
  isReadOnly: boolean;
1196
+ /**
1197
+ * Boolean to indicate whether the field should be rendered in a disabled state
1198
+ */
1199
+ isDisabled: boolean;
1159
1200
  /**
1160
1201
  * Set field value function
1161
1202
  */
@@ -1174,6 +1215,10 @@ export declare interface ContentEditorFormFieldHookProps {
1174
1215
  * Indicates whether the field is rendered in read only mode or not
1175
1216
  */
1176
1217
  isReadOnly: boolean;
1218
+ /**
1219
+ * Indicates whether the field is rendered in disabled mode or not
1220
+ */
1221
+ isDisabled: boolean;
1177
1222
  /**
1178
1223
  * Field definition of the form field
1179
1224
  */
@@ -1188,7 +1233,7 @@ export declare interface ContentEditorFormFieldHookResult {
1188
1233
  * Priority value of the field in the list of candidates for rendering.
1189
1234
  * Extension with a higher priority will be displayed instead of an extension with lower priority.
1190
1235
  * Helps to resolve collapsing cases when useIsAvailable returns true for two or more
1191
- * extensions for a single fields at the same time.
1236
+ * extensions for a single field at the same time.
1192
1237
  */
1193
1238
  priority?: number;
1194
1239
  /**
@@ -1197,6 +1242,78 @@ export declare interface ContentEditorFormFieldHookResult {
1197
1242
  isAvailable: boolean;
1198
1243
  }
1199
1244
 
1245
+ /**
1246
+ * @public
1247
+ */
1248
+ export declare type ContentEditorViewExtension<TItem = any> = () => ContentEditorViewExtensionConfiguration;
1249
+
1250
+ /**
1251
+ * @public
1252
+ */
1253
+ export declare interface ContentEditorViewExtensionComponentProps {
1254
+ /**
1255
+ * Item to edit/view
1256
+ */
1257
+ item: IdentifiableObject;
1258
+ /**
1259
+ * Boolean to indicate whether the editor should be rendered in read-only mode
1260
+ */
1261
+ isReadonly: boolean;
1262
+ /**
1263
+ * Original editor to render
1264
+ */
1265
+ renderEditor: ReactNode;
1266
+ }
1267
+
1268
+ /**
1269
+ * @public
1270
+ */
1271
+ export declare interface ContentEditorViewExtensionConfiguration {
1272
+ /**
1273
+ * Extension id
1274
+ */
1275
+ readonly id: string;
1276
+ /**
1277
+ * Component to render on this path
1278
+ */
1279
+ readonly component: ComponentType<ContentEditorViewExtensionComponentProps>;
1280
+ /**
1281
+ * Hook which returns information about the current content for the extension
1282
+ */
1283
+ readonly useContentEditorView: (props: ContentEditorViewHookProps) => ContentEditorViewHookResult;
1284
+ }
1285
+
1286
+ /**
1287
+ * @public
1288
+ */
1289
+ export declare interface ContentEditorViewHookProps {
1290
+ /**
1291
+ * Indicates whether the content is rendered in read-only mode or not
1292
+ */
1293
+ isReadonly: boolean;
1294
+ /**
1295
+ * Item is being passed to editor
1296
+ */
1297
+ item: IdentifiableObject;
1298
+ }
1299
+
1300
+ /**
1301
+ * @public
1302
+ */
1303
+ export declare interface ContentEditorViewHookResult {
1304
+ /**
1305
+ * Priority value of the custom editor in the list of candidates for rendering.
1306
+ * Extension with a higher priority will be displayed instead of an extension with lower priority.
1307
+ * Helps to resolve collapsing cases when useIsAvailable returns true for two or more
1308
+ * extensions for a single editor at the same time.
1309
+ */
1310
+ priority?: number;
1311
+ /**
1312
+ * Defines whether the content extension is available to be displayed or not
1313
+ */
1314
+ isAvailable: boolean;
1315
+ }
1316
+
1200
1317
  /**
1201
1318
  * @public
1202
1319
  */
@@ -1208,12 +1325,12 @@ export declare type ContentExplorerActionGroupId = ValuesOfArray<typeof contentE
1208
1325
  * @public
1209
1326
  */
1210
1327
  export declare const contentExplorerActionGroupId: {
1328
+ classification: "classification";
1211
1329
  bundle: "bundle";
1212
1330
  exporting: "exporting";
1213
1331
  refreshing: "refreshing";
1214
1332
  workflow: "workflow";
1215
1333
  browsing: "browsing";
1216
- classification: "classification";
1217
1334
  clipboard: "clipboard";
1218
1335
  creation: "creation";
1219
1336
  deletion: "deletion";
@@ -1239,45 +1356,51 @@ export declare type ContentExplorerActionId = ValuesOfArray<typeof contentExplor
1239
1356
  * @public
1240
1357
  */
1241
1358
  export declare const contentExplorerActionId: {
1359
+ cut: "cut";
1360
+ copy: "copy";
1361
+ paste: "paste";
1362
+ promote: "promote";
1363
+ demote: "demote";
1364
+ delete: "delete";
1365
+ localize: "localize";
1366
+ publish: "publish";
1242
1367
  export: "export";
1243
1368
  refresh: "refresh";
1244
- open: "open";
1245
- openEditor: "openEditor";
1246
- openEditorInNewTab: "openEditorInNewTab";
1369
+ addParentPublication: "addParentPublication";
1247
1370
  addSelectedItemsToBundle: "addSelectedItemsToBundle";
1248
1371
  addToBundle: "addToBundle";
1249
- removeFromBundle: "removeFromBundle";
1250
1372
  autoClassify: "autoClassify";
1251
- copy: "copy";
1252
- cut: "cut";
1253
- paste: "paste";
1373
+ finishEditing: "finishEditing";
1254
1374
  newBundle: "newBundle";
1255
1375
  newCategory: "newCategory";
1376
+ newChildPublication: "newChildPublication";
1256
1377
  newComponent: "newComponent";
1257
1378
  newFolder: "newFolder";
1258
1379
  newKeyword: "newKeyword";
1259
1380
  newMultimediaComponent: "newMultimediaComponent";
1260
1381
  newPage: "newPage";
1261
1382
  newStructureGroup: "newStructureGroup";
1262
- uploadMultimediaComponent: "uploadMultimediaComponent";
1263
- delete: "delete";
1264
- finishEditing: "finishEditing";
1265
- revert: "revert";
1266
- localize: "localize";
1267
- unlocalize: "unlocalize";
1268
- publish: "publish";
1269
- unpublish: "unpublish";
1383
+ open: "open";
1384
+ openEditor: "openEditor";
1385
+ openEditorInNewTab: "openEditorInNewTab";
1270
1386
  openPublishingQueue: "openPublishingQueue";
1271
1387
  openTranslationQueue: "openTranslationQueue";
1388
+ pasteInContainer: "pasteInContainer";
1389
+ removeFromBundle: "removeFromBundle";
1390
+ removeParentPublication: "removeParentPublication";
1391
+ revert: "revert";
1392
+ startWorkflow: "startWorkflow";
1272
1393
  translate: "translate";
1273
1394
  translateTarget: "translateTarget";
1274
- startWorkflow: "startWorkflow";
1395
+ unlocalize: "unlocalize";
1396
+ unpublish: "unpublish";
1397
+ uploadMultimediaComponent: "uploadMultimediaComponent";
1275
1398
  };
1276
1399
 
1277
1400
  /**
1278
1401
  * @public
1279
1402
  */
1280
- export declare const contentExplorerActionIds: readonly ["open", "openEditor", "openEditorInNewTab", "addSelectedItemsToBundle", "addToBundle", "removeFromBundle", "autoClassify", "copy", "cut", "paste", "newBundle", "newCategory", "newComponent", "newFolder", "newKeyword", "newMultimediaComponent", "newPage", "newStructureGroup", "uploadMultimediaComponent", "delete", "finishEditing", "revert", "export", "localize", "unlocalize", "publish", "unpublish", "openPublishingQueue", "refresh", "openTranslationQueue", "translate", "translateTarget", "startWorkflow"];
1403
+ export declare const contentExplorerActionIds: readonly ["addParentPublication", "addSelectedItemsToBundle", "addToBundle", "autoClassify", "copy", "cut", "delete", "demote", "export", "finishEditing", "localize", "newBundle", "newCategory", "newChildPublication", "newComponent", "newFolder", "newKeyword", "newMultimediaComponent", "newPage", "newStructureGroup", "open", "openEditor", "openEditorInNewTab", "openPublishingQueue", "openTranslationQueue", "paste", "pasteInContainer", "promote", "publish", "refresh", "removeFromBundle", "removeParentPublication", "revert", "startWorkflow", "translate", "translateTarget", "unlocalize", "unpublish", "uploadMultimediaComponent"];
1281
1404
 
1282
1405
  /**
1283
1406
  * @internal
@@ -1590,9 +1713,9 @@ export declare type ContentExplorerPanelId = ValuesOfArray<typeof contentExplore
1590
1713
  */
1591
1714
  export declare const contentExplorerPanelId: {
1592
1715
  information: "information";
1716
+ history: "history";
1593
1717
  general: "general";
1594
1718
  metadata: "metadata";
1595
- history: "history";
1596
1719
  blueprint: "blueprint";
1597
1720
  "where-used": "where-used";
1598
1721
  "view-on-site": "view-on-site";
@@ -1904,7 +2027,7 @@ export declare interface DeleteItemRequest {
1904
2027
  */
1905
2028
  item: IdentifiableObject;
1906
2029
  /**
1907
- * Container item ID of the item to delete.
2030
+ * The container (context) in which the delete action is being performed. If specified, the container is invalidated on success to trigger reloading.
1908
2031
  */
1909
2032
  containerItem?: IdentifiableObject;
1910
2033
  }
@@ -1923,11 +2046,39 @@ export declare interface DeleteItemsRequest {
1923
2046
  */
1924
2047
  items: ReadonlyArray<IdentifiableObject>;
1925
2048
  /**
1926
- * Container item ID of an items to delete.
2049
+ * Container item of the item to delete.
1927
2050
  * `containerId` may take 'undefined' value when publications
1928
2051
  * which don't have a real container are being deleted.
1929
2052
  */
1930
- containerId: ItemUri | undefined;
2053
+ containerItem?: IdentifiableObject;
2054
+ }
2055
+
2056
+ /**
2057
+ * @public
2058
+ */
2059
+ export declare type DemoteItemMutationHook = (options?: MutationOptions<RepositoryLocalObject | void, ApiError, DemoteItemRequest>) => MutationResult<RepositoryLocalObject | void, ApiError, DemoteItemRequest>;
2060
+
2061
+ /**
2062
+ * @public
2063
+ */
2064
+ export declare interface DemoteItemRequest {
2065
+ item: RepositoryLocalObject;
2066
+ destinationPublicationId: ItemUri;
2067
+ failureLevel: 'warning' | 'error';
2068
+ }
2069
+
2070
+ /**
2071
+ * @public
2072
+ */
2073
+ export declare type DemoteItemsMutationHook = (options?: BatchMutationOptions<DemoteItemsRequest>) => MutationResult<Batch, ApiError, DemoteItemsRequest>;
2074
+
2075
+ /**
2076
+ * @public
2077
+ */
2078
+ export declare interface DemoteItemsRequest {
2079
+ items: ReadonlyArray<RepositoryLocalObject>;
2080
+ destinationPublicationId: ItemUri;
2081
+ failureLevel: 'warning' | 'error';
1931
2082
  }
1932
2083
 
1933
2084
  /**
@@ -1946,7 +2097,7 @@ export declare interface EditorHookResult {
1946
2097
  /**
1947
2098
  * Item's metadata schema.
1948
2099
  */
1949
- schema: Schema;
2100
+ schema: Schema | undefined;
1950
2101
  /**
1951
2102
  * Boolean that indicates that Item has unsaved changes.
1952
2103
  */
@@ -1955,6 +2106,10 @@ export declare interface EditorHookResult {
1955
2106
  * Boolean that indicates that item can be edited.
1956
2107
  */
1957
2108
  isEditing: boolean;
2109
+ /**
2110
+ * Callback to update internal editor state.
2111
+ */
2112
+ onUpdate: (item: Bundle | KeywordCategory | Component | MultimediaComponent | Folder | Keyword | Page | StructureGroup) => void;
1958
2113
  }
1959
2114
 
1960
2115
  /**
@@ -2161,9 +2316,9 @@ export declare interface FinishItemsRequest {
2161
2316
  */
2162
2317
  items: ReadonlyArray<VersionedItem>;
2163
2318
  /**
2164
- * Container item ID of the items to finish.
2319
+ * Container item of the item to finish.
2165
2320
  */
2166
- containerId: ItemUri;
2321
+ containerItem?: IdentifiableObject;
2167
2322
  }
2168
2323
 
2169
2324
  /**
@@ -2248,7 +2403,7 @@ export declare interface FolderEditorHookResult {
2248
2403
  /**
2249
2404
  * Folder's metadata schema.
2250
2405
  */
2251
- metadataSchema: Schema;
2406
+ metadataSchema: Schema | undefined;
2252
2407
  /**
2253
2408
  * Boolean that indicates that Folder has unsaved changes.
2254
2409
  */
@@ -2298,6 +2453,9 @@ export declare interface GeneralComponentsApiStorage {
2298
2453
  Stack: StackComponent;
2299
2454
  Text: TextComponent;
2300
2455
  TextLink: TextLinkComponent;
2456
+ ModalContent: ModalContentComponent;
2457
+ ModalHeader: ModalHeaderComponent;
2458
+ ModalFooter: ModalFooterComponent;
2301
2459
  }
2302
2460
 
2303
2461
  /**
@@ -2319,6 +2477,7 @@ export declare interface GeneralHooksApiStorage {
2319
2477
  useNotifications: NotificationsHook;
2320
2478
  useUserProfile: UserProfileHook;
2321
2479
  useConfirmation: ConfirmationHook;
2480
+ useModal: ModalHook;
2322
2481
  }
2323
2482
 
2324
2483
  /**
@@ -2332,6 +2491,8 @@ export declare interface GeneralMutationsApiStorage {
2332
2491
  useCopyItemsMutation: CopyItemsMutationHook;
2333
2492
  useDeleteItemMutation: DeleteItemMutationHook;
2334
2493
  useDeleteItemsMutation: DeleteItemsMutationHook;
2494
+ useDemoteItemMutation: DemoteItemMutationHook;
2495
+ useDemoteItemsMutation: DemoteItemsMutationHook;
2335
2496
  useFinishEditingItemMutation: FinishEditingItemMutationHook;
2336
2497
  useFinishEditingItemsMutation: FinishEditingItemsMutationHook;
2337
2498
  useLocalizeItemMutation: LocalizeItemMutationHook;
@@ -2339,6 +2500,8 @@ export declare interface GeneralMutationsApiStorage {
2339
2500
  useMoveItemMutation: MoveItemMutationHook;
2340
2501
  useMoveItemsMutation: MoveItemsMutationHook;
2341
2502
  usePublishItemsMutation: PublishItemsMutationHook;
2503
+ usePromoteItemMutation: PromoteItemMutationHook;
2504
+ usePromoteItemsMutation: PromoteItemsMutationHook;
2342
2505
  useRevertItemMutation: RevertItemMutationHook;
2343
2506
  useRevertItemsMutation: RevertItemsMutationHook;
2344
2507
  useRollbackItemMutation: RollbackItemMutationHook;
@@ -2390,6 +2553,7 @@ export declare interface GeneralQueriesApiStorage {
2390
2553
  usePublicationBlueprintHierarchyQuery: PublicationBlueprintHierarchyQueryHook;
2391
2554
  };
2392
2555
  lists: {
2556
+ useContainerItems: ContainerItemsQueryHook;
2393
2557
  useFavoritesQuery: FavoritesQueryHook;
2394
2558
  useItemsInProgressQuery: ItemsInProgressQueryHook;
2395
2559
  usePublicationsQuery: PublicationsQueryHook;
@@ -2649,6 +2813,10 @@ export declare interface ItemBlueprintHierarchyQueryProps {
2649
2813
  * Identifies the item for which Blueprint hierarchy is being retrieved.
2650
2814
  */
2651
2815
  itemId: ItemUri;
2816
+ /**
2817
+ * Option to control how much data is returned per item.
2818
+ */
2819
+ detailsLevel?: ListDetailsLevel;
2652
2820
  }
2653
2821
 
2654
2822
  /**
@@ -2715,6 +2883,10 @@ export declare interface ItemDefaultDataQueryProps {
2715
2883
  * Type of the model to get default data for.
2716
2884
  */
2717
2885
  modelType: DefaultModelType;
2886
+ /**
2887
+ * A container ID is required for all types except the following: `Batch`, `Publication`, `PublicationTarget`, `PublishTransaction`, `TargetType`, `MultimediaType`, `WorkflowType`, `User`, `Group`, and `ApprovalStatus`.
2888
+ */
2889
+ containerId?: ItemUri;
2718
2890
  }
2719
2891
 
2720
2892
  /**
@@ -2885,6 +3057,15 @@ export declare interface ItemUsedByQueryProps {
2885
3057
  * Identifies the item for which 'Used By' dependencies are being retrieved.
2886
3058
  */
2887
3059
  itemId: ItemUri;
3060
+ /**
3061
+ * Set to true to include local copies of the specified item in the response.
3062
+ */
3063
+ includeLocalCopies?: boolean;
3064
+ /**
3065
+ * To limit the response to items that currently use the specified item,
3066
+ * set this option to `true`.
3067
+ */
3068
+ onlyLatestVersion?: boolean;
2888
3069
  }
2889
3070
 
2890
3071
  /**
@@ -2900,6 +3081,11 @@ export declare interface ItemUsesQueryProps {
2900
3081
  * Identifies the item for which 'Uses' dependencies are being retrieved.
2901
3082
  */
2902
3083
  itemId: ItemUri;
3084
+ /**
3085
+ * To include the BluePrint parent of a local copy in the response,
3086
+ * set this option to `true`.
3087
+ */
3088
+ includeBlueprintParentItem?: boolean;
2903
3089
  }
2904
3090
 
2905
3091
  /**
@@ -2920,7 +3106,7 @@ export declare interface KeywordEditorHookResult {
2920
3106
  /**
2921
3107
  * Keyword's metadata schema.
2922
3108
  */
2923
- metadataSchema: Schema;
3109
+ metadataSchema: Schema | undefined;
2924
3110
  /**
2925
3111
  * Boolean that indicates that Keyword has unsaved changes.
2926
3112
  */
@@ -3048,9 +3234,9 @@ export declare interface LocalizeItemsRequest {
3048
3234
  */
3049
3235
  itemIds: ReadonlyArray<ItemUri>;
3050
3236
  /**
3051
- * Container item ID of the items to localize.
3237
+ * Container item of the item to localize.
3052
3238
  */
3053
- containerId: ItemUri;
3239
+ containerItem?: IdentifiableObject;
3054
3240
  }
3055
3241
 
3056
3242
  /**
@@ -3058,6 +3244,169 @@ export declare interface LocalizeItemsRequest {
3058
3244
  */
3059
3245
  export declare type MainAxisAlignment = 'start' | 'center' | 'end' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch';
3060
3246
 
3247
+ /**
3248
+ * A component to render Content of a Modal
3249
+ *
3250
+ * @public
3251
+ */
3252
+ export declare const ModalContent: ModalContentComponent;
3253
+
3254
+ /**
3255
+ * @public
3256
+ */
3257
+ export declare type ModalContentComponent = FunctionComponent<ModalContentComponentProps>;
3258
+
3259
+ /**
3260
+ * @public
3261
+ */
3262
+ export declare interface ModalContentComponentProps extends FlexProps {
3263
+ /**
3264
+ * Content of the Modal.
3265
+ */
3266
+ children: ReactNode;
3267
+ }
3268
+
3269
+ /**
3270
+ * @public
3271
+ */
3272
+ export declare interface ModalContentProps<TResultData> {
3273
+ onConfirm: (result?: TResultData) => void;
3274
+ onCancel: () => void;
3275
+ }
3276
+
3277
+ /**
3278
+ * A component to render Footer of the Modal
3279
+ *
3280
+ * @public
3281
+ */
3282
+ export declare const ModalFooter: ModalFooterComponent;
3283
+
3284
+ /**
3285
+ * @public
3286
+ */
3287
+ export declare type ModalFooterComponent = FunctionComponent<ModalFooterComponentProps>;
3288
+
3289
+ /**
3290
+ * @public
3291
+ */
3292
+ export declare interface ModalFooterComponentProps {
3293
+ /**
3294
+ * Label for the Cancel button of the Modal.
3295
+ */
3296
+ cancelButtonLabel?: string;
3297
+ /**
3298
+ * Boolean that indicates disabled state of the Cancel button.
3299
+ */
3300
+ isCancelButtonDisabled?: boolean;
3301
+ /**
3302
+ * Boolean that indicates disabled state of the Ok button.
3303
+ */
3304
+ isOkButtonDisabled?: boolean;
3305
+ /**
3306
+ * Label for the Ok button of the Modal.
3307
+ */
3308
+ okButtonLabel?: string;
3309
+ /**
3310
+ * Callback executed when Ok button clicked.
3311
+ */
3312
+ onOk?: () => void;
3313
+ /**
3314
+ * Callback executed when Cancel button clicked.
3315
+ */
3316
+ onCancel?: () => void;
3317
+ }
3318
+
3319
+ /**
3320
+ * A component to render Header of the Modal
3321
+ *
3322
+ * @public
3323
+ */
3324
+ export declare const ModalHeader: ModalHeaderComponent;
3325
+
3326
+ /**
3327
+ * @public
3328
+ */
3329
+ export declare type ModalHeaderComponent = FunctionComponent<ModalHeaderComponentProps>;
3330
+
3331
+ /**
3332
+ * @public
3333
+ */
3334
+ export declare interface ModalHeaderComponentProps {
3335
+ /**
3336
+ * React node that is rendered as a title of the Modal component, includes expand and close buttons by default.
3337
+ */
3338
+ title?: ReactNode;
3339
+ }
3340
+
3341
+ /**
3342
+ * @public
3343
+ */
3344
+ export declare type ModalHook<TResultData = unknown> = (args: ModalHookArguments) => ModalHookResult<TResultData>;
3345
+
3346
+ /**
3347
+ * @public
3348
+ */
3349
+ export declare interface ModalHookArguments<TResultData = unknown> {
3350
+ content: ComponentType<ModalContentProps<TResultData>>;
3351
+ height?: number;
3352
+ isMaximizable?: boolean;
3353
+ minHeight?: number;
3354
+ minWidth?: number;
3355
+ width?: number;
3356
+ modalType?: ModalType;
3357
+ }
3358
+
3359
+ /**
3360
+ * @public
3361
+ */
3362
+ export declare interface ModalHookResult<TResultData> {
3363
+ open: () => Promise<ModalResult<TResultData>>;
3364
+ }
3365
+
3366
+ /**
3367
+ * @public
3368
+ */
3369
+ export declare interface ModalResult<TResultData> {
3370
+ status: ModalStatus;
3371
+ result: TResultData | undefined;
3372
+ }
3373
+
3374
+ /**
3375
+ * @public
3376
+ */
3377
+ export declare type ModalStatus = ValuesOfArray<typeof modalStatuses>;
3378
+
3379
+ /**
3380
+ * @public
3381
+ */
3382
+ export declare const modalStatus: {
3383
+ ok: "ok";
3384
+ cancel: "cancel";
3385
+ };
3386
+
3387
+ /**
3388
+ * @public
3389
+ */
3390
+ export declare const modalStatuses: readonly ["ok", "cancel"];
3391
+
3392
+ /**
3393
+ * @public
3394
+ */
3395
+ export declare type ModalType = ValuesOfArray<typeof modalTypes>;
3396
+
3397
+ /**
3398
+ * @public
3399
+ */
3400
+ export declare const modalType: {
3401
+ default: "default";
3402
+ danger: "danger";
3403
+ };
3404
+
3405
+ /**
3406
+ * @public
3407
+ */
3408
+ export declare const modalTypes: readonly ["default", "danger"];
3409
+
3061
3410
  /**
3062
3411
  * @public
3063
3412
  */
@@ -3202,7 +3551,7 @@ export declare interface MutationResult<TData = unknown, TError = unknown, TVari
3202
3551
  /**
3203
3552
  * Is `true` when status is `loading`.
3204
3553
  */
3205
- isLoading: boolean;
3554
+ isPending: boolean;
3206
3555
  /**
3207
3556
  * Is `true` when status is `success`.
3208
3557
  */
@@ -3240,7 +3589,7 @@ export declare interface MutationResult<TData = unknown, TError = unknown, TVari
3240
3589
  *
3241
3590
  * @public
3242
3591
  */
3243
- export declare type MutationStatus = 'idle' | 'loading' | 'success' | 'error';
3592
+ export declare type MutationStatus = 'idle' | 'pending' | 'success' | 'error';
3244
3593
 
3245
3594
  /**
3246
3595
  * @public
@@ -3362,6 +3711,11 @@ export declare interface NavigationItemRenderLabel {
3362
3711
  readonly label: string;
3363
3712
  }
3364
3713
 
3714
+ /**
3715
+ * @public
3716
+ */
3717
+ export declare type NonFunctionGuard<T> = T extends Function ? never : T;
3718
+
3365
3719
  /**
3366
3720
  * @public
3367
3721
  */
@@ -3691,12 +4045,43 @@ declare const palette: {
3691
4045
  magenta50: string;
3692
4046
  magenta100: string;
3693
4047
  magenta120: string;
4048
+ yellow10: string;
3694
4049
  yellow50: string;
3695
4050
  yellow100: string;
3696
4051
  yellow120: string;
3697
4052
  yellow140: string;
3698
4053
  };
3699
4054
 
4055
+ /**
4056
+ * @public
4057
+ */
4058
+ export declare type PromoteItemMutationHook = (options?: MutationOptions<RepositoryLocalObject | void, ApiError, PromoteItemRequest>) => MutationResult<RepositoryLocalObject | void, ApiError, PromoteItemRequest>;
4059
+
4060
+ /**
4061
+ * @public
4062
+ */
4063
+ export declare interface PromoteItemRequest {
4064
+ item: RepositoryLocalObject;
4065
+ destinationPublicationId: ItemUri;
4066
+ failureLevel: 'warning' | 'error';
4067
+ includeDependencies?: boolean;
4068
+ }
4069
+
4070
+ /**
4071
+ * @public
4072
+ */
4073
+ export declare type PromoteItemsMutationHook = (options?: BatchMutationOptions<PromoteItemsRequest>) => MutationResult<Batch, ApiError, PromoteItemsRequest>;
4074
+
4075
+ /**
4076
+ * @public
4077
+ */
4078
+ export declare interface PromoteItemsRequest {
4079
+ items: ReadonlyArray<RepositoryLocalObject>;
4080
+ destinationPublicationId: ItemUri;
4081
+ failureLevel: 'warning' | 'error';
4082
+ includeDependencies?: boolean;
4083
+ }
4084
+
3700
4085
  /**
3701
4086
  * @public
3702
4087
  */
@@ -3769,6 +4154,10 @@ export declare interface PublicationBlueprintHierarchyQueryProps {
3769
4154
  * Identifies the item for which Blueprint hierarchy is being retrieved.
3770
4155
  */
3771
4156
  publicationId: ItemUri;
4157
+ /**
4158
+ * Option to control how much data is returned per item.
4159
+ */
4160
+ detailsLevel?: ListDetailsLevel;
3772
4161
  }
3773
4162
 
3774
4163
  /**
@@ -3824,9 +4213,9 @@ export declare type PublishingQueueExplorerActionId = ValuesOfArray<typeof publi
3824
4213
  * @public
3825
4214
  */
3826
4215
  export declare const publishingQueueExplorerActionId: {
4216
+ delete: "delete";
3827
4217
  export: "export";
3828
4218
  refresh: "refresh";
3829
- delete: "delete";
3830
4219
  redo: "redo";
3831
4220
  };
3832
4221
 
@@ -3989,18 +4378,18 @@ export declare const publishingQueueExplorerPanelIds: readonly ["information", "
3989
4378
  /**
3990
4379
  * @public
3991
4380
  */
3992
- export declare type PublishingQueueExplorerTableColumnExtension = TableColumnExtension<PublishTransaction>;
4381
+ export declare type PublishingQueueExplorerTableColumnExtension = TableColumnExtension<PublishTransaction<PublishTransactionListInfo>>;
3993
4382
 
3994
4383
  /**
3995
4384
  * @public
3996
4385
  */
3997
- export declare interface PublishingQueueExplorerTableColumnExtensionComponentProps extends TableColumnExtensionComponentProps<PublishTransaction> {
4386
+ export declare interface PublishingQueueExplorerTableColumnExtensionComponentProps extends TableColumnExtensionComponentProps<PublishTransaction<PublishTransactionListInfo>> {
3998
4387
  }
3999
4388
 
4000
4389
  /**
4001
4390
  * @public
4002
4391
  */
4003
- export declare interface PublishingQueueExplorerTableColumnExtensionConfiguration extends TableColumnExtensionConfiguration<PublishTransaction> {
4392
+ export declare interface PublishingQueueExplorerTableColumnExtensionConfiguration extends TableColumnExtensionConfiguration<PublishTransaction<PublishTransactionListInfo>> {
4004
4393
  }
4005
4394
 
4006
4395
  /**
@@ -4071,7 +4460,7 @@ export declare interface PublishingQueueExplorerTableHookResult {
4071
4460
  */
4072
4461
  export declare interface PublishingQueueExplorerTableSelection {
4073
4462
  ids: ReadonlySet<ItemUri>;
4074
- selectedItems: ReadonlyArray<PublishTransaction>;
4463
+ selectedItems: ReadonlyArray<PublishTransaction<PublishTransactionListInfo>>;
4075
4464
  }
4076
4465
 
4077
4466
  /**
@@ -4138,7 +4527,7 @@ export declare interface PublishItemsRequest {
4138
4527
  /**
4139
4528
  * @public
4140
4529
  */
4141
- export declare type PublishTransactionsQueryHook = (props: PublishTransactionsQueryProps | undefined, options?: QueryOptions<ReadonlyArray<PublishTransaction> | undefined, ApiError>) => QueryResult<ReadonlyArray<PublishTransaction> | undefined, ApiError>;
4530
+ export declare type PublishTransactionsQueryHook = <TListInfo extends ListInfoDictionary>(props: PublishTransactionsQueryProps | undefined, options?: QueryOptions<ReadonlyArray<PublishTransaction<TListInfo>> | undefined, ApiError>) => QueryResult<ReadonlyArray<PublishTransaction<TListInfo>> | undefined, ApiError>;
4142
4531
 
4143
4532
  /**
4144
4533
  * @public
@@ -4237,27 +4626,10 @@ export declare interface QueryOptions<TQueryFnData = unknown, TError = unknown,
4237
4626
  * Defaults to `true`.
4238
4627
  */
4239
4628
  retryOnMount?: boolean;
4240
- /**
4241
- * This callback will fire any time the query successfully fetches new data.
4242
- */
4243
- onSuccess?: (data: TData) => void;
4244
- /**
4245
- * This callback will fire if the query encounters an error and will be passed the error.
4246
- */
4247
- onError?: (err: TError) => void;
4248
- /**
4249
- * This callback will fire any time the query is either successfully fetched or errors and be passed either the data or error.
4250
- */
4251
- onSettled?: (data: TData | undefined, error: TError | null) => void;
4252
- /**
4253
- * Set this to `true` to keep the previous `data` when fetching based on a new query key.
4254
- * Defaults to `false`.
4255
- */
4256
- keepPreviousData?: boolean;
4257
4629
  /**
4258
4630
  * If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `loading` data and no initialData has been provided.
4259
4631
  */
4260
- placeholderData?: TQueryFnData | (() => TQueryFnData | undefined);
4632
+ placeholderData?: NonFunctionGuard<TQueryFnData> | ((previousData: TData | undefined) => NonFunctionGuard<TQueryFnData> | undefined);
4261
4633
  }
4262
4634
 
4263
4635
  /**
@@ -4301,21 +4673,14 @@ export declare interface QueryResult<TData = unknown, TError = unknown> {
4301
4673
  */
4302
4674
  isFetchedAfterMount: boolean;
4303
4675
  isFetching: boolean;
4676
+ isPending: boolean;
4304
4677
  isLoading: boolean;
4305
4678
  isLoadingError: boolean;
4306
- /**
4307
- * Is true whenever the first fetch for a query is in-flight.
4308
- */
4309
- isInitialLoading: boolean;
4310
4679
  isPaused: boolean;
4311
4680
  /**
4312
4681
  * Will be `true` if the data shown is the placeholder data.
4313
4682
  */
4314
4683
  isPlaceholderData: boolean;
4315
- /**
4316
- * Will be true when `keepPreviousData` is set and data from the previous query is returned.
4317
- */
4318
- isPreviousData: boolean;
4319
4684
  /**
4320
4685
  * Will be `true` if the query failed while fetching for the first time.
4321
4686
  */
@@ -4349,7 +4714,7 @@ export declare interface QueryResult<TData = unknown, TError = unknown> {
4349
4714
  /**
4350
4715
  * @public
4351
4716
  */
4352
- export declare type QueryStatus = 'loading' | 'error' | 'success';
4717
+ export declare type QueryStatus = 'pending' | 'error' | 'success';
4353
4718
 
4354
4719
  declare interface ReadonlyHierarchy<TData> {
4355
4720
  root: ReadonlyHierarchyNode<TData> | undefined;
@@ -4471,9 +4836,9 @@ export declare interface RevertItemsRequest {
4471
4836
  */
4472
4837
  itemIds: ReadonlyArray<ItemUri>;
4473
4838
  /**
4474
- * Container item ID of the items to revert.
4839
+ * Container item of the item to revert.
4475
4840
  */
4476
- containerId: ItemUri;
4841
+ containerItem?: IdentifiableObject;
4477
4842
  }
4478
4843
 
4479
4844
  /**
@@ -4521,10 +4886,14 @@ export declare interface RichTextFieldHookProps {
4521
4886
  * Indicates whether the field is rendered in read only mode or not
4522
4887
  */
4523
4888
  isReadOnly: boolean;
4889
+ /**
4890
+ * Indicates whether the field is editable or not
4891
+ */
4892
+ isDisabled: boolean;
4524
4893
  /**
4525
4894
  * Field definition of the form field
4526
4895
  */
4527
- fieldDefinition: ItemFieldDefinition;
4896
+ fieldDefinition: XhtmlFieldDefinition;
4528
4897
  }
4529
4898
 
4530
4899
  /**
@@ -4863,7 +5232,7 @@ export declare interface StructureGroupEditorHookResult {
4863
5232
  /**
4864
5233
  * Structure Group's metadata schema.
4865
5234
  */
4866
- metadataSchema: Schema;
5235
+ metadataSchema: Schema | undefined;
4867
5236
  /**
4868
5237
  * Boolean that indicates that Structure Group has unsaved changes.
4869
5238
  */
@@ -5235,9 +5604,9 @@ export declare interface UnlocalizeItemsRequest {
5235
5604
  */
5236
5605
  itemIds: ReadonlyArray<ItemUri>;
5237
5606
  /**
5238
- * Container item ID of the items to unlocalize.
5607
+ * Container item of the item to unlocalize.
5239
5608
  */
5240
- containerId: ItemUri;
5609
+ containerItem?: IdentifiableObject;
5241
5610
  }
5242
5611
 
5243
5612
  /**
@@ -5418,6 +5787,11 @@ export declare const useChangeUserLocaleMutation: ChangeUserLocaleMutationHook;
5418
5787
  */
5419
5788
  export declare const useConfirmation: ConfirmationHook;
5420
5789
 
5790
+ /**
5791
+ * @public
5792
+ */
5793
+ export declare const useContainerItems: ContainerItemsQueryHook;
5794
+
5421
5795
  /**
5422
5796
  * Hook for accessing Content Explorer data and methods.
5423
5797
  *
@@ -5486,6 +5860,20 @@ export declare const useDeleteItemMutation: DeleteItemMutationHook;
5486
5860
  */
5487
5861
  export declare const useDeleteItemsMutation: DeleteItemsMutationHook;
5488
5862
 
5863
+ /**
5864
+ * Updates an item by URI.
5865
+ *
5866
+ * @public
5867
+ */
5868
+ export declare const useDemoteItemMutation: DemoteItemMutationHook;
5869
+
5870
+ /**
5871
+ * Updates an item by URI.
5872
+ *
5873
+ * @public
5874
+ */
5875
+ export declare const useDemoteItemsMutation: DemoteItemsMutationHook;
5876
+
5489
5877
  /**
5490
5878
  * Provides access to Item Editor data and methods.
5491
5879
  *
@@ -5648,6 +6036,13 @@ export declare const useLocalizeItemMutation: LocalizeItemMutationHook;
5648
6036
  */
5649
6037
  export declare const useLocalizeItemsMutation: LocalizeItemsMutationHook;
5650
6038
 
6039
+ /**
6040
+ * Opens a Modal based on the provided options.
6041
+ *
6042
+ * @public
6043
+ */
6044
+ export declare const useModal: <TResultData>(args: ModalHookArguments) => ModalHookResult<TResultData>;
6045
+
5651
6046
  /**
5652
6047
  * Moves a single item from its current location to the specified destination.
5653
6048
  *
@@ -5945,7 +6340,7 @@ export declare interface UserProfileHookResult {
5945
6340
  /**
5946
6341
  * `UserProfile` instance of the logged-in Tridion user.
5947
6342
  */
5948
- userProfile: UserProfile;
6343
+ userProfile: UserProfile | undefined;
5949
6344
  }
5950
6345
 
5951
6346
  /**