@tridion-sites/extensions 1.0.2 → 2.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.js CHANGED
@@ -1,7 +1,29 @@
1
1
  import { jsx } from 'react/jsx-runtime';
2
2
  import { memo } from 'react';
3
3
 
4
+ const createEnumObject = (values) => {
5
+ return values.reduce((acc, currentVal) => {
6
+ acc[currentVal] = currentVal;
7
+ return acc;
8
+ }, {});
9
+ };
10
+
11
+ /**
12
+ * List of all built-in panel IDs of the Activities Explorer.
13
+ *
14
+ * @public
15
+ */
16
+ const activitiesExplorerPanelIds = ['information', 'relatedItems', 'processHistory'];
4
17
  /**
18
+ * All available built-in Activities Explorer panel IDs.
19
+ *
20
+ * @public
21
+ */
22
+ const activitiesExplorerPanelId = createEnumObject(activitiesExplorerPanelIds);
23
+
24
+ /**
25
+ * List of all built-in panel IDs of the Content Explorer.
26
+ *
5
27
  * @public
6
28
  */
7
29
  const contentExplorerPanelIds = [
@@ -15,6 +37,25 @@ const contentExplorerPanelIds = [
15
37
  'published-to',
16
38
  'translations',
17
39
  ];
40
+ /**
41
+ * All available built-in Content Explorer panel IDs.
42
+ *
43
+ * @public
44
+ */
45
+ const contentExplorerPanelId = createEnumObject(contentExplorerPanelIds);
46
+
47
+ /**
48
+ * List of all built-in panel IDs of the Publishing Queue Explorer.
49
+ *
50
+ * @public
51
+ */
52
+ const publishingQueueExplorerPanelIds = ['information', 'resolvedItems'];
53
+ /**
54
+ * All available built-in Publishing Queue Explorer panel IDs.
55
+ *
56
+ * @public
57
+ */
58
+ const publishingQueueExplorerPanelId = createEnumObject(publishingQueueExplorerPanelIds);
18
59
 
19
60
  /**
20
61
  * @internal
@@ -386,18 +427,31 @@ class ActivitiesExplorerTableExtensionsBuilder {
386
427
  writable: true,
387
428
  value: []
388
429
  });
430
+ /**
431
+ * Provides a mechanism for customizing the configuration of actions
432
+ * within Activities Explorer Table toolbar.
433
+ */
389
434
  Object.defineProperty(this, "toolbar", {
390
435
  enumerable: true,
391
436
  configurable: true,
392
437
  writable: true,
393
438
  value: new ActionsConfigurationExtensionsBuilder()
394
439
  });
440
+ /**
441
+ * Provides a mechanism for customizing the configuration of actions
442
+ * within Activities Explorer Table context menu.
443
+ */
395
444
  Object.defineProperty(this, "contextMenu", {
396
445
  enumerable: true,
397
446
  configurable: true,
398
447
  writable: true,
399
448
  value: new ActionsConfigurationExtensionsBuilder()
400
449
  });
450
+ /**
451
+ * Adds a new column to Activities Explorer Table.
452
+ *
453
+ * @param column - column to be added
454
+ */
401
455
  Object.defineProperty(this, "addColumn", {
402
456
  enumerable: true,
403
457
  configurable: true,
@@ -422,12 +476,57 @@ class ActivitiesExplorerTableExtensionsBuilder {
422
476
  }
423
477
  }
424
478
 
425
- const createEnumObject = (values) => {
426
- return values.reduce((acc, currentVal) => {
427
- acc[currentVal] = currentVal;
428
- return acc;
429
- }, {});
430
- };
479
+ /**
480
+ * @public
481
+ */
482
+ class ActivitiesExplorerInsightsPanelsExtensionsBuilder {
483
+ constructor() {
484
+ Object.defineProperty(this, "_insightsPanelsExtensions", {
485
+ enumerable: true,
486
+ configurable: true,
487
+ writable: true,
488
+ value: []
489
+ });
490
+ /**
491
+ * Provides a mechanism for customizing the configuration of insights panels.
492
+ */
493
+ Object.defineProperty(this, "config", {
494
+ enumerable: true,
495
+ configurable: true,
496
+ writable: true,
497
+ value: new ListBuilder(itemId => itemId)
498
+ });
499
+ /**
500
+ * Registers a new insights panel.
501
+ *
502
+ * @remarks
503
+ * This method only registers the insights panel and does not automatically make it visible in the application.
504
+ * To add the insights panel to the application, use {@link ActivitiesExplorerInsightsPanelsExtensionsBuilder.config}.
505
+ *
506
+ * @param item - insights panel to be registered
507
+ */
508
+ Object.defineProperty(this, "register", {
509
+ enumerable: true,
510
+ configurable: true,
511
+ writable: true,
512
+ value: (item) => {
513
+ this._insightsPanelsExtensions.push(item);
514
+ return this;
515
+ }
516
+ });
517
+ Object.defineProperty(this, "build", {
518
+ enumerable: true,
519
+ configurable: true,
520
+ writable: true,
521
+ value: () => {
522
+ return {
523
+ items: this._insightsPanelsExtensions,
524
+ config: this.config.build(),
525
+ };
526
+ }
527
+ });
528
+ }
529
+ }
431
530
 
432
531
  /**
433
532
  * @public
@@ -441,6 +540,8 @@ const activitiesExplorerActionIds = [
441
540
  'assignActivity',
442
541
  ];
443
542
  /**
543
+ * All built-in action IDs available in Activities Explorer.
544
+ *
444
545
  * @public
445
546
  */
446
547
  const activitiesExplorerActionId = createEnumObject(activitiesExplorerActionIds);
@@ -449,6 +550,8 @@ const activitiesExplorerActionId = createEnumObject(activitiesExplorerActionIds)
449
550
  */
450
551
  const activitiesExplorerActionGroupIds = ['exporting', 'refreshing', 'workflow'];
451
552
  /**
553
+ * All built-in action group IDs available in Activities Explorer.
554
+ *
452
555
  * @public
453
556
  */
454
557
  const activitiesExplorerActionGroupId = createEnumObject(activitiesExplorerActionGroupIds);
@@ -464,12 +567,29 @@ class ActivitiesExplorerExtensionsBuilder {
464
567
  writable: true,
465
568
  value: []
466
569
  });
570
+ /**
571
+ * Provides a mechanism for customizing Activities Explorer Table.
572
+ */
467
573
  Object.defineProperty(this, "table", {
468
574
  enumerable: true,
469
575
  configurable: true,
470
576
  writable: true,
471
577
  value: new ActivitiesExplorerTableExtensionsBuilder()
472
578
  });
579
+ /**
580
+ * Provides a mechanism for customizing Activities Explorer Insights Panels.
581
+ */
582
+ Object.defineProperty(this, "insightsPanels", {
583
+ enumerable: true,
584
+ configurable: true,
585
+ writable: true,
586
+ value: new ActivitiesExplorerInsightsPanelsExtensionsBuilder()
587
+ });
588
+ /**
589
+ * Adds a new action to Activities Explorer.
590
+ *
591
+ * @param action - action to be added
592
+ */
473
593
  Object.defineProperty(this, "addAction", {
474
594
  enumerable: true,
475
595
  configurable: true,
@@ -487,6 +607,7 @@ class ActivitiesExplorerExtensionsBuilder {
487
607
  return {
488
608
  actions: this._actions,
489
609
  table: this.table.build(),
610
+ insightsPanels: this.insightsPanels.build(),
490
611
  };
491
612
  }
492
613
  });
@@ -591,18 +712,31 @@ class ContentExplorerTableExtensionsBuilder {
591
712
  writable: true,
592
713
  value: []
593
714
  });
715
+ /**
716
+ * Provides a mechanism for customizing the configuration of actions
717
+ * within Content Explorer Table toolbar.
718
+ */
594
719
  Object.defineProperty(this, "toolbar", {
595
720
  enumerable: true,
596
721
  configurable: true,
597
722
  writable: true,
598
723
  value: new ActionsConfigurationExtensionsBuilder()
599
724
  });
725
+ /**
726
+ * Provides a mechanism for customizing the configuration of actions
727
+ * within Content Explorer Table context menu.
728
+ */
600
729
  Object.defineProperty(this, "contextMenu", {
601
730
  enumerable: true,
602
731
  configurable: true,
603
732
  writable: true,
604
733
  value: new ActionsConfigurationExtensionsBuilder()
605
734
  });
735
+ /**
736
+ * Adds a new column to Content Explorer Table.
737
+ *
738
+ * @param column - column to be added
739
+ */
606
740
  Object.defineProperty(this, "addColumn", {
607
741
  enumerable: true,
608
742
  configurable: true,
@@ -632,6 +766,10 @@ class ContentExplorerTableExtensionsBuilder {
632
766
  */
633
767
  class ContentExplorerTreeExtensionsBuilder {
634
768
  constructor() {
769
+ /**
770
+ * Provides a mechanism for customizing the configuration of actions
771
+ * within Content Explorer Tree context menu.
772
+ */
635
773
  Object.defineProperty(this, "contextMenu", {
636
774
  enumerable: true,
637
775
  configurable: true,
@@ -651,6 +789,58 @@ class ContentExplorerTreeExtensionsBuilder {
651
789
  }
652
790
  }
653
791
 
792
+ /**
793
+ * @public
794
+ */
795
+ class ContentExplorerInsightsPanelsExtensionsBuilder {
796
+ constructor() {
797
+ Object.defineProperty(this, "_insightsPanelsExtensions", {
798
+ enumerable: true,
799
+ configurable: true,
800
+ writable: true,
801
+ value: []
802
+ });
803
+ /**
804
+ * Provides a mechanism for customizing the configuration of insights panels.
805
+ */
806
+ Object.defineProperty(this, "config", {
807
+ enumerable: true,
808
+ configurable: true,
809
+ writable: true,
810
+ value: new ListBuilder(itemId => itemId)
811
+ });
812
+ /**
813
+ * Registers a new insights panel.
814
+ *
815
+ * @remarks
816
+ * This method only registers the insights panel and does not automatically make it visible in the application.
817
+ * To add the insights panel to the application, use {@link ContentExplorerInsightsPanelsExtensionsBuilder.config}.
818
+ *
819
+ * @param item - insights panel to be registered
820
+ */
821
+ Object.defineProperty(this, "register", {
822
+ enumerable: true,
823
+ configurable: true,
824
+ writable: true,
825
+ value: (item) => {
826
+ this._insightsPanelsExtensions.push(item);
827
+ return this;
828
+ }
829
+ });
830
+ Object.defineProperty(this, "build", {
831
+ enumerable: true,
832
+ configurable: true,
833
+ writable: true,
834
+ value: () => {
835
+ return {
836
+ items: this._insightsPanelsExtensions,
837
+ config: this.config.build(),
838
+ };
839
+ }
840
+ });
841
+ }
842
+ }
843
+
654
844
  /**
655
845
  * @public
656
846
  */
@@ -690,6 +880,8 @@ const contentExplorerActionIds = [
690
880
  'startWorkflow',
691
881
  ];
692
882
  /**
883
+ * All built-in action IDs available in Content Explorer.
884
+ *
693
885
  * @public
694
886
  */
695
887
  const contentExplorerActionId = createEnumObject(contentExplorerActionIds);
@@ -712,6 +904,8 @@ const contentExplorerActionGroupIds = [
712
904
  'workflow',
713
905
  ];
714
906
  /**
907
+ * All built-in action group IDs available in Content Explorer.
908
+ *
715
909
  * @public
716
910
  */
717
911
  const contentExplorerActionGroupId = createEnumObject(contentExplorerActionGroupIds);
@@ -727,18 +921,38 @@ class ContentExplorerExtensionsBuilder {
727
921
  writable: true,
728
922
  value: []
729
923
  });
924
+ /**
925
+ * Provides a mechanism for customizing Content Explorer Table.
926
+ */
730
927
  Object.defineProperty(this, "table", {
731
928
  enumerable: true,
732
929
  configurable: true,
733
930
  writable: true,
734
931
  value: new ContentExplorerTableExtensionsBuilder()
735
932
  });
933
+ /**
934
+ * Provides a mechanism for customizing Content Explorer Tree.
935
+ */
736
936
  Object.defineProperty(this, "tree", {
737
937
  enumerable: true,
738
938
  configurable: true,
739
939
  writable: true,
740
940
  value: new ContentExplorerTreeExtensionsBuilder()
741
941
  });
942
+ /**
943
+ * Provides a mechanism for customizing Content Explorer Insights Panels.
944
+ */
945
+ Object.defineProperty(this, "insightsPanels", {
946
+ enumerable: true,
947
+ configurable: true,
948
+ writable: true,
949
+ value: new ContentExplorerInsightsPanelsExtensionsBuilder()
950
+ });
951
+ /**
952
+ * Adds a new action to Content Explorer.
953
+ *
954
+ * @param action - action to be added
955
+ */
742
956
  Object.defineProperty(this, "addAction", {
743
957
  enumerable: true,
744
958
  configurable: true,
@@ -757,6 +971,7 @@ class ContentExplorerExtensionsBuilder {
757
971
  actions: this._actions,
758
972
  table: this.table.build(),
759
973
  tree: this.tree.build(),
974
+ insightsPanels: this.insightsPanels.build(),
760
975
  };
761
976
  }
762
977
  });
@@ -774,12 +989,24 @@ class NavigationExtensionsBuilder {
774
989
  writable: true,
775
990
  value: []
776
991
  });
992
+ /**
993
+ * Provides a mechanism for customizing the configuration of navigation items.
994
+ */
777
995
  Object.defineProperty(this, "config", {
778
996
  enumerable: true,
779
997
  configurable: true,
780
998
  writable: true,
781
999
  value: new ListBuilder(itemId => itemId)
782
1000
  });
1001
+ /**
1002
+ * Registers a new navigation item.
1003
+ *
1004
+ * @remarks
1005
+ * This method only registers the navigation item and does not automatically make it visible in the application.
1006
+ * To add the navigation item to the application, use {@link NavigationExtensionsBuilder.config}.
1007
+ *
1008
+ * @param item - navigation item to be registered
1009
+ */
783
1010
  Object.defineProperty(this, "register", {
784
1011
  enumerable: true,
785
1012
  configurable: true,
@@ -806,8 +1033,10 @@ class NavigationExtensionsBuilder {
806
1033
  /**
807
1034
  * @public
808
1035
  */
809
- const navigationItemIds = ['activitiesExplorer', 'contentExplorer'];
1036
+ const navigationItemIds = ['activitiesExplorer', 'contentExplorer', 'publishingQueueExplorer'];
810
1037
  /**
1038
+ * All available built-in navigation item IDs.
1039
+ *
811
1040
  * @public
812
1041
  */
813
1042
  const navigationItemId = createEnumObject(navigationItemIds);
@@ -817,6 +1046,9 @@ const navigationItemId = createEnumObject(navigationItemIds);
817
1046
  */
818
1047
  class HeaderExtensionsBuilder {
819
1048
  constructor() {
1049
+ /**
1050
+ * Provides a mechanism for customizing navigation items.
1051
+ */
820
1052
  Object.defineProperty(this, "navigation", {
821
1053
  enumerable: true,
822
1054
  configurable: true,
@@ -836,6 +1068,197 @@ class HeaderExtensionsBuilder {
836
1068
  }
837
1069
  }
838
1070
 
1071
+ /**
1072
+ * @public
1073
+ */
1074
+ class PublishingQueueExplorerTableExtensionsBuilder {
1075
+ constructor() {
1076
+ Object.defineProperty(this, "_columns", {
1077
+ enumerable: true,
1078
+ configurable: true,
1079
+ writable: true,
1080
+ value: []
1081
+ });
1082
+ /**
1083
+ * Provides a mechanism for customizing the configuration of actions
1084
+ * within Publishing Queue Explorer Table toolbar.
1085
+ */
1086
+ Object.defineProperty(this, "toolbar", {
1087
+ enumerable: true,
1088
+ configurable: true,
1089
+ writable: true,
1090
+ value: new ActionsConfigurationExtensionsBuilder()
1091
+ });
1092
+ /**
1093
+ * Provides a mechanism for customizing the configuration of actions
1094
+ * within Publishing Queue Explorer Table context menu.
1095
+ */
1096
+ Object.defineProperty(this, "contextMenu", {
1097
+ enumerable: true,
1098
+ configurable: true,
1099
+ writable: true,
1100
+ value: new ActionsConfigurationExtensionsBuilder()
1101
+ });
1102
+ /**
1103
+ * Adds a new column to Publishing Queue Explorer Table.
1104
+ *
1105
+ * @param column - column to be added
1106
+ */
1107
+ Object.defineProperty(this, "addColumn", {
1108
+ enumerable: true,
1109
+ configurable: true,
1110
+ writable: true,
1111
+ value: (column) => {
1112
+ this._columns.push(column);
1113
+ return this;
1114
+ }
1115
+ });
1116
+ Object.defineProperty(this, "build", {
1117
+ enumerable: true,
1118
+ configurable: true,
1119
+ writable: true,
1120
+ value: () => {
1121
+ return {
1122
+ columns: this._columns,
1123
+ contextMenu: this.contextMenu.build(),
1124
+ toolbar: this.toolbar.build(),
1125
+ };
1126
+ }
1127
+ });
1128
+ }
1129
+ }
1130
+
1131
+ /**
1132
+ * @public
1133
+ */
1134
+ class PublishingQueueExplorerInsightsPanelsExtensionsBuilder {
1135
+ constructor() {
1136
+ Object.defineProperty(this, "_insightsPanelsExtensions", {
1137
+ enumerable: true,
1138
+ configurable: true,
1139
+ writable: true,
1140
+ value: []
1141
+ });
1142
+ /**
1143
+ * Provides a mechanism for customizing the configuration of insights panels.
1144
+ */
1145
+ Object.defineProperty(this, "config", {
1146
+ enumerable: true,
1147
+ configurable: true,
1148
+ writable: true,
1149
+ value: new ListBuilder(itemId => itemId)
1150
+ });
1151
+ /**
1152
+ * Registers a new insights panel.
1153
+ *
1154
+ * @remarks
1155
+ * This method only registers the insights panel and does not automatically make it visible in the application.
1156
+ * To add the insights panel to the application, use {@link PublishingQueueExplorerInsightsPanelsExtensionsBuilder.config}.
1157
+ *
1158
+ * @param item - insights panel to be registered
1159
+ */
1160
+ Object.defineProperty(this, "register", {
1161
+ enumerable: true,
1162
+ configurable: true,
1163
+ writable: true,
1164
+ value: (item) => {
1165
+ this._insightsPanelsExtensions.push(item);
1166
+ return this;
1167
+ }
1168
+ });
1169
+ Object.defineProperty(this, "build", {
1170
+ enumerable: true,
1171
+ configurable: true,
1172
+ writable: true,
1173
+ value: () => {
1174
+ return {
1175
+ items: this._insightsPanelsExtensions,
1176
+ config: this.config.build(),
1177
+ };
1178
+ }
1179
+ });
1180
+ }
1181
+ }
1182
+
1183
+ /**
1184
+ * @public
1185
+ */
1186
+ const publishingQueueExplorerActionIds = ['refresh', 'export', 'delete', 'redo'];
1187
+ /**
1188
+ * All built-in action IDs available in Publishing Queue Explorer.
1189
+ *
1190
+ * @public
1191
+ */
1192
+ const publishingQueueExplorerActionId = createEnumObject(publishingQueueExplorerActionIds);
1193
+ /**
1194
+ * @public
1195
+ */
1196
+ const publishingQueueExplorerActionGroupIds = ['refreshing', 'exporting', 'publishing', 'deleting'];
1197
+ /**
1198
+ * All built-in action group IDs available in Publishing Queue Explorer.
1199
+ *
1200
+ * @public
1201
+ */
1202
+ const publishingQueueExplorerActionGroupId = createEnumObject(publishingQueueExplorerActionGroupIds);
1203
+
1204
+ /**
1205
+ * @public
1206
+ */
1207
+ class PublishingQueueExplorerExtensionsBuilder {
1208
+ constructor() {
1209
+ Object.defineProperty(this, "_actions", {
1210
+ enumerable: true,
1211
+ configurable: true,
1212
+ writable: true,
1213
+ value: []
1214
+ });
1215
+ /**
1216
+ * Provides a mechanism for customizing Publishing Queue Explorer Table.
1217
+ */
1218
+ Object.defineProperty(this, "table", {
1219
+ enumerable: true,
1220
+ configurable: true,
1221
+ writable: true,
1222
+ value: new PublishingQueueExplorerTableExtensionsBuilder()
1223
+ });
1224
+ /**
1225
+ * Provides a mechanism for customizing Publishing Queue Explorer Insights Panels.
1226
+ */
1227
+ Object.defineProperty(this, "insightsPanels", {
1228
+ enumerable: true,
1229
+ configurable: true,
1230
+ writable: true,
1231
+ value: new PublishingQueueExplorerInsightsPanelsExtensionsBuilder()
1232
+ });
1233
+ /**
1234
+ * Adds a new action to Publishing Queue Explorer.
1235
+ *
1236
+ * @param action - action to be added
1237
+ */
1238
+ Object.defineProperty(this, "addAction", {
1239
+ enumerable: true,
1240
+ configurable: true,
1241
+ writable: true,
1242
+ value: (action) => {
1243
+ this._actions.push(action);
1244
+ return this;
1245
+ }
1246
+ });
1247
+ Object.defineProperty(this, "build", {
1248
+ enumerable: true,
1249
+ configurable: true,
1250
+ writable: true,
1251
+ value: () => {
1252
+ return {
1253
+ actions: this._actions,
1254
+ table: this.table.build(),
1255
+ insightsPanels: this.insightsPanels.build(),
1256
+ };
1257
+ }
1258
+ });
1259
+ }
1260
+ }
1261
+
839
1262
  /**
840
1263
  * @public
841
1264
  */
@@ -848,6 +1271,7 @@ class TranslationExtensionsBuilder {
848
1271
  value: []
849
1272
  });
850
1273
  /**
1274
+ * Adds new translations for the specified language code.
851
1275
  *
852
1276
  * @param code - Language code.
853
1277
  * @param records - Key-value pairs of string translated to `code` language.
@@ -880,36 +1304,60 @@ class TranslationExtensionsBuilder {
880
1304
  */
881
1305
  class ExtensionBuilder {
882
1306
  constructor() {
1307
+ /**
1308
+ * Provides a mechanism for customizing the header of the application.
1309
+ */
883
1310
  Object.defineProperty(this, "header", {
884
1311
  enumerable: true,
885
1312
  configurable: true,
886
1313
  writable: true,
887
1314
  value: new HeaderExtensionsBuilder()
888
1315
  });
1316
+ /**
1317
+ * Provides a mechanism for customizing form fields within editors.
1318
+ */
889
1319
  Object.defineProperty(this, "contentEditor", {
890
1320
  enumerable: true,
891
1321
  configurable: true,
892
1322
  writable: true,
893
1323
  value: new ContentEditorExtensionsBuilder()
894
1324
  });
1325
+ /**
1326
+ * Provides a mechanism for customizing Content Explorer.
1327
+ */
895
1328
  Object.defineProperty(this, "contentExplorer", {
896
1329
  enumerable: true,
897
1330
  configurable: true,
898
1331
  writable: true,
899
1332
  value: new ContentExplorerExtensionsBuilder()
900
1333
  });
1334
+ /**
1335
+ * Provides a mechanism for managing localization strings within extensions.
1336
+ */
901
1337
  Object.defineProperty(this, "translations", {
902
1338
  enumerable: true,
903
1339
  configurable: true,
904
1340
  writable: true,
905
1341
  value: new TranslationExtensionsBuilder()
906
1342
  });
1343
+ /**
1344
+ * Provides a mechanism for customizing Activities Explorer.
1345
+ */
907
1346
  Object.defineProperty(this, "activitiesExplorer", {
908
1347
  enumerable: true,
909
1348
  configurable: true,
910
1349
  writable: true,
911
1350
  value: new ActivitiesExplorerExtensionsBuilder()
912
1351
  });
1352
+ /**
1353
+ * Provides a mechanism for customizing Publishing Queue Explorer.
1354
+ */
1355
+ Object.defineProperty(this, "publishingQueueExplorer", {
1356
+ enumerable: true,
1357
+ configurable: true,
1358
+ writable: true,
1359
+ value: new PublishingQueueExplorerExtensionsBuilder()
1360
+ });
913
1361
  Object.defineProperty(this, "build", {
914
1362
  enumerable: true,
915
1363
  configurable: true,
@@ -921,6 +1369,7 @@ class ExtensionBuilder {
921
1369
  contentEditor: this.contentEditor.build(),
922
1370
  translations: this.translations.build(),
923
1371
  activitiesExplorer: this.activitiesExplorer.build(),
1372
+ publishingQueueExplorer: this.publishingQueueExplorer.build(),
924
1373
  };
925
1374
  }
926
1375
  });
@@ -941,6 +1390,11 @@ const extensionApiBridge = {
941
1390
  };
942
1391
 
943
1392
  /**
1393
+ * Provides access to Activities Explorer data and methods.
1394
+ *
1395
+ * @remarks
1396
+ * Should be used only inside Activities Explorer, otherwise throws an error.
1397
+ *
944
1398
  * @public
945
1399
  */
946
1400
  const useActivitiesExplorer = () => {
@@ -948,6 +1402,12 @@ const useActivitiesExplorer = () => {
948
1402
  return useActivitiesExplorer();
949
1403
  };
950
1404
  /**
1405
+ * Provides access to Activities Explorer data and methods, if available.
1406
+ *
1407
+ * @remarks
1408
+ * Safe to be used within or outside of the Activities Explorer.
1409
+ * `undefined` is returned when used outside of Activities Explorer.
1410
+ *
951
1411
  * @public
952
1412
  */
953
1413
  const useOptionalActivitiesExplorer = () => {
@@ -955,6 +1415,11 @@ const useOptionalActivitiesExplorer = () => {
955
1415
  return useOptionalActivitiesExplorer();
956
1416
  };
957
1417
  /**
1418
+ * Provides access to Activities Explorer Table data and methods.
1419
+ *
1420
+ * @remarks
1421
+ * Should be used only inside Activities Explorer Table, otherwise throws an error.
1422
+ *
958
1423
  * @public
959
1424
  */
960
1425
  const useActivitiesExplorerTable = () => {
@@ -962,6 +1427,12 @@ const useActivitiesExplorerTable = () => {
962
1427
  return useActivitiesExplorerTable();
963
1428
  };
964
1429
  /**
1430
+ * Provides access to Activities Explorer Table data and methods, if available.
1431
+ *
1432
+ * @remarks
1433
+ * Safe to be used within or outside of the Activities Explorer Table.
1434
+ * `undefined` is returned when used outside of Activities Explorer Table.
1435
+ *
965
1436
  * @public
966
1437
  */
967
1438
  const useOptionalActivitiesExplorerTable = () => {
@@ -970,6 +1441,11 @@ const useOptionalActivitiesExplorerTable = () => {
970
1441
  };
971
1442
 
972
1443
  /**
1444
+ * Hook for accessing Content Explorer data and methods.
1445
+ *
1446
+ * @remarks
1447
+ * Should be used only inside Content Explorer, otherwise throws an error.
1448
+ *
973
1449
  * @public
974
1450
  */
975
1451
  const useContentExplorer = () => {
@@ -977,6 +1453,12 @@ const useContentExplorer = () => {
977
1453
  return useContentExplorer();
978
1454
  };
979
1455
  /**
1456
+ * Hook for accessing Content Explorer data and methods, if available.
1457
+ *
1458
+ * @remarks
1459
+ * Safe to be used within or outside of the Content Explorer.
1460
+ * `undefined` is returned when used outside of Content Explorer.
1461
+ *
980
1462
  * @public
981
1463
  */
982
1464
  const useOptionalContentExplorer = () => {
@@ -984,6 +1466,11 @@ const useOptionalContentExplorer = () => {
984
1466
  return useOptionalContentExplorer();
985
1467
  };
986
1468
  /**
1469
+ * Hook for accessing Content Explorer Table data and methods.
1470
+ *
1471
+ * @remarks
1472
+ * Should be used only inside Content Explorer Table, otherwise throws an error.
1473
+ *
987
1474
  * @public
988
1475
  */
989
1476
  const useContentExplorerTable = () => {
@@ -991,6 +1478,12 @@ const useContentExplorerTable = () => {
991
1478
  return useContentExplorerTable();
992
1479
  };
993
1480
  /**
1481
+ * Hook for accessing Content Explorer Table data and methods, if available.
1482
+ *
1483
+ * @remarks
1484
+ * Safe to be used within or outside of the Content Explorer Table.
1485
+ * `undefined` is returned when used outside of Content Explorer Table.
1486
+ *
994
1487
  * @public
995
1488
  */
996
1489
  const useOptionalContentExplorerTable = () => {
@@ -998,6 +1491,11 @@ const useOptionalContentExplorerTable = () => {
998
1491
  return useOptionalContentExplorerTable();
999
1492
  };
1000
1493
  /**
1494
+ * Hook for accessing Content Explorer Tree data and methods.
1495
+ *
1496
+ * @remarks
1497
+ * Should be used only inside Content Explorer Tree, otherwise throws an error.
1498
+ *
1001
1499
  * @public
1002
1500
  */
1003
1501
  const useContentExplorerTree = () => {
@@ -1005,6 +1503,12 @@ const useContentExplorerTree = () => {
1005
1503
  return useContentExplorerTree();
1006
1504
  };
1007
1505
  /**
1506
+ * Hook for accessing Content Explorer Tree data and methods, if available.
1507
+ *
1508
+ * @remarks
1509
+ * Safe to be used within or outside of the Content Explorer Tree.
1510
+ * `undefined` is returned when used outside of Content Explorer Tree.
1511
+ *
1008
1512
  * @public
1009
1513
  */
1010
1514
  const useOptionalContentExplorerTree = () => {
@@ -1013,42 +1517,72 @@ const useOptionalContentExplorerTree = () => {
1013
1517
  };
1014
1518
 
1015
1519
  /**
1520
+ * Checks whether the provided node is an item in the system.
1521
+ *
1522
+ * @example
1523
+ * Folder node returns `true`
1524
+ * Publication node returns `false`
1525
+ * Taxonomies node returns `false`
1526
+ *
1016
1527
  * @public
1017
1528
  */
1018
1529
  const isItemNode = (node) => extensionApiBridge.get().contentExplorer.utils.hierarchy.isItemNode(node);
1019
1530
  /**
1531
+ * Checks whether the provided nodeId is the 'Favorites' node ID.
1532
+ *
1020
1533
  * @public
1021
1534
  */
1022
1535
  const isFavoritesNodeId = (nodeId) => extensionApiBridge.get().contentExplorer.utils.hierarchy.isFavoritesNodeId(nodeId);
1023
1536
  /**
1537
+ * Checks whether the provided nodeId is the 'Items in Progress' node ID.
1538
+ *
1024
1539
  * @public
1025
1540
  */
1026
1541
  const isItemsInProgressNodeId = (nodeId) => extensionApiBridge.get().contentExplorer.utils.hierarchy.isItemsInProgressNodeId(nodeId);
1027
1542
  /**
1543
+ * Checks whether the provided nodeId is the 'Publications' node ID
1544
+ *
1028
1545
  * @public
1029
1546
  */
1030
1547
  const isPublicationsNodeId = (nodeId) => extensionApiBridge.get().contentExplorer.utils.hierarchy.isPublicationsNodeId(nodeId);
1031
1548
  /**
1549
+ * Checks whether the provided nodeId is the 'Root' node ID.
1550
+ *
1032
1551
  * @public
1033
1552
  */
1034
1553
  const isRootNodeId = (nodeId) => extensionApiBridge.get().contentExplorer.utils.hierarchy.isRootNodeId(nodeId);
1035
1554
  /**
1555
+ * Checks if an item in a node, given as the first parameter,
1556
+ * is an instance of a constructor, provided as the second parameter.
1557
+ *
1558
+ * @param node - The node to check.
1559
+ * @param ctor - The constructor to compare against.
1560
+ * @returns Boolean value indicating whether the item node is an instance of the constructor.
1561
+ *
1036
1562
  * @public
1037
1563
  */
1038
1564
  const isItemNodeOfType = (node, ctor) => extensionApiBridge.get().contentExplorer.utils.hierarchy.isItemNodeOfType(node, ctor);
1039
1565
  /**
1566
+ * Checks whether the provided node is the 'Items in Progress' node.
1567
+ *
1040
1568
  * @public
1041
1569
  */
1042
1570
  const isItemsInProgressNode = (node) => extensionApiBridge.get().contentExplorer.utils.hierarchy.isItemsInProgressNode(node);
1043
1571
  /**
1572
+ * Checks whether the provided node is the 'Publications' node.
1573
+ *
1044
1574
  * @public
1045
1575
  */
1046
1576
  const isPublicationsNode = (node) => extensionApiBridge.get().contentExplorer.utils.hierarchy.isPublicationsNode(node);
1047
1577
  /**
1578
+ * Checks whether the provided node is the 'Root' node.
1579
+ *
1048
1580
  * @public
1049
1581
  */
1050
1582
  const isRootNode = (node) => extensionApiBridge.get().contentExplorer.utils.hierarchy.isRootNode(node);
1051
1583
  /**
1584
+ * Checks whether the provided node is the 'System' node.
1585
+ *
1052
1586
  * @public
1053
1587
  */
1054
1588
  const isSystemNode = (node) => extensionApiBridge.get().contentExplorer.utils.hierarchy.isSystemNode(node);
@@ -1056,11 +1590,76 @@ const isSystemNode = (node) => extensionApiBridge.get().contentExplorer.utils.hi
1056
1590
  /**
1057
1591
  * @public
1058
1592
  */
1593
+ const PropertiesList = memo(props => {
1594
+ const PropertiesList = extensionApiBridge.get().contentExplorer.components.PropertiesList;
1595
+ return jsx(PropertiesList, Object.assign({}, props));
1596
+ });
1597
+ PropertiesList.displayName = 'PropertiesList';
1598
+
1599
+ /**
1600
+ * Provides access to PublishingQueue Explorer data and methods.
1601
+ *
1602
+ * @remarks
1603
+ * Should be used only inside PublishingQueue Explorer, otherwise throws an error.
1604
+ *
1605
+ * @public
1606
+ */
1607
+ const usePublishingQueueExplorer = () => {
1608
+ const usePublishingQueueExplorer = extensionApiBridge.get().publishingQueueExplorer.hooks.usePublishingQueueExplorer;
1609
+ return usePublishingQueueExplorer();
1610
+ };
1611
+ /**
1612
+ * Provides access to PublishingQueue Explorer data and methods, if available.
1613
+ *
1614
+ * @remarks
1615
+ * Safe to be used within or outside of the PublishingQueue Explorer.
1616
+ * `undefined` is returned when used outside of PublishingQueue Explorer.
1617
+ *
1618
+ * @public
1619
+ */
1620
+ const useOptionalPublishingQueueExplorer = () => {
1621
+ const useOptionalPublishingQueueExplorer = extensionApiBridge.get().publishingQueueExplorer.hooks.useOptionalPublishingQueueExplorer;
1622
+ return useOptionalPublishingQueueExplorer();
1623
+ };
1624
+ /**
1625
+ * Provides access to PublishingQueue Explorer Table data and methods.
1626
+ *
1627
+ * @remarks
1628
+ * Should be used only inside PublishingQueue Explorer Table, otherwise throws an error.
1629
+ *
1630
+ * @public
1631
+ */
1632
+ const usePublishingQueueExplorerTable = () => {
1633
+ const usePublishingQueueExplorerTable = extensionApiBridge.get().publishingQueueExplorer.hooks.usePublishingQueueExplorerTable;
1634
+ return usePublishingQueueExplorerTable();
1635
+ };
1636
+ /**
1637
+ * Provides access to PublishingQueue Explorer Table data and methods, if available.
1638
+ *
1639
+ * @remarks
1640
+ * Safe to be used within or outside of the PublishingQueue Explorer Table.
1641
+ * `undefined` is returned when used outside of PublishingQueue Explorer Table.
1642
+ *
1643
+ * @public
1644
+ */
1645
+ const useOptionalPublishingQueueExplorerTable = () => {
1646
+ const useOptionalPublishingQueueExplorerTable = extensionApiBridge.get().publishingQueueExplorer.hooks.useOptionalPublishingQueueExplorerTable;
1647
+ return useOptionalPublishingQueueExplorerTable();
1648
+ };
1649
+
1650
+ /**
1651
+ * Provides access to Item Editor data and methods.
1652
+ *
1653
+ * @public
1654
+ */
1059
1655
  const useEditor = () => {
1060
1656
  const useEditor = extensionApiBridge.get().editors.hooks.useEditor;
1061
1657
  return useEditor();
1062
1658
  };
1063
1659
  /**
1660
+ * Provides access to Item Editor data and methods, if available.
1661
+ * `undefined` is returned when used outside of Item Editor.
1662
+ *
1064
1663
  * @public
1065
1664
  */
1066
1665
  const useOptionalEditor = () => {
@@ -1068,6 +1667,9 @@ const useOptionalEditor = () => {
1068
1667
  return useOptionalEditor();
1069
1668
  };
1070
1669
  /**
1670
+ * Provides access to Bundle Editor data and methods, if available.
1671
+ * `undefined` is returned when used outside of Bundle Editor.
1672
+ *
1071
1673
  * @public
1072
1674
  */
1073
1675
  const useOptionalBundleEditor = () => {
@@ -1075,6 +1677,9 @@ const useOptionalBundleEditor = () => {
1075
1677
  return useOptionalBundleEditor();
1076
1678
  };
1077
1679
  /**
1680
+ * Provides access to Component Editor data and methods, if available.
1681
+ * `undefined` is returned when used outside of Component Editor.
1682
+ *
1078
1683
  * @public
1079
1684
  */
1080
1685
  const useOptionalComponentEditor = () => {
@@ -1082,6 +1687,9 @@ const useOptionalComponentEditor = () => {
1082
1687
  return useOptionalComponentEditor();
1083
1688
  };
1084
1689
  /**
1690
+ * Provides access to Category Editor data and methods, if available.
1691
+ * `undefined` is returned when used outside of Category Editor.
1692
+ *
1085
1693
  * @public
1086
1694
  */
1087
1695
  const useOptionalCategoryEditor = () => {
@@ -1089,6 +1697,9 @@ const useOptionalCategoryEditor = () => {
1089
1697
  return useOptionalCategoryEditor();
1090
1698
  };
1091
1699
  /**
1700
+ * Provides access to Folder Editor data and methods, if available.
1701
+ * `undefined` is returned when used outside of Folder Editor.
1702
+ *
1092
1703
  * @public
1093
1704
  */
1094
1705
  const useOptionalFolderEditor = () => {
@@ -1096,6 +1707,9 @@ const useOptionalFolderEditor = () => {
1096
1707
  return useOptionalFolderEditor();
1097
1708
  };
1098
1709
  /**
1710
+ * Provides access to Keyword Editor data and methods, if available.
1711
+ * `undefined` is returned when used outside of Keyword Editor.
1712
+ *
1099
1713
  * @public
1100
1714
  */
1101
1715
  const useOptionalKeywordEditor = () => {
@@ -1103,6 +1717,9 @@ const useOptionalKeywordEditor = () => {
1103
1717
  return useOptionalKeywordEditor();
1104
1718
  };
1105
1719
  /**
1720
+ * Provides access to Page Editor data and methods, if available.
1721
+ * `undefined` is returned when used outside of Page Editor.
1722
+ *
1106
1723
  * @public
1107
1724
  */
1108
1725
  const useOptionalPageEditor = () => {
@@ -1110,6 +1727,9 @@ const useOptionalPageEditor = () => {
1110
1727
  return useOptionalPageEditor();
1111
1728
  };
1112
1729
  /**
1730
+ * Provides access to Structure Group Editor data and methods, if available.
1731
+ * `undefined` is returned when used outside of Structure Group Editor.
1732
+ *
1113
1733
  * @public
1114
1734
  */
1115
1735
  const useOptionalStructureGroupEditor = () => {
@@ -1122,6 +1742,7 @@ const useOptionalStructureGroupEditor = () => {
1122
1742
  * including the className and cssStyle props for custom styling.
1123
1743
  *
1124
1744
  * It should rarely be used directly as preference should be given to the more specialized child components.
1745
+ *
1125
1746
  * @public
1126
1747
  */
1127
1748
  const Block = memo(props => {
@@ -1131,6 +1752,7 @@ const Block = memo(props => {
1131
1752
  Block.displayName = 'Block';
1132
1753
  /**
1133
1754
  * A component that has standard button functionality.
1755
+ *
1134
1756
  * @public
1135
1757
  */
1136
1758
  const Button = memo(props => {
@@ -1145,6 +1767,7 @@ Button.displayName = 'Button';
1145
1767
  *
1146
1768
  * It is advisable to construct most of the layout using this component as it allows to freely utilize
1147
1769
  * "shouldFill" and similar props that rely on the parent being a Flex component.
1770
+ *
1148
1771
  * @public
1149
1772
  */
1150
1773
  const Center = memo(props => {
@@ -1158,6 +1781,7 @@ Center.displayName = 'Center';
1158
1781
  *
1159
1782
  * It is advisable to construct most of the layout using this component as it allows to freely utilize
1160
1783
  * "shouldFill" and similar props that rely on the parent being a Flex component.
1784
+ *
1161
1785
  * @public
1162
1786
  */
1163
1787
  const Flex = memo(props => {
@@ -1167,6 +1791,7 @@ const Flex = memo(props => {
1167
1791
  Flex.displayName = 'Flex';
1168
1792
  /**
1169
1793
  * A component used for rendering SVG icons.
1794
+ *
1170
1795
  * @public
1171
1796
  */
1172
1797
  const Icon = memo(props => {
@@ -1176,6 +1801,7 @@ const Icon = memo(props => {
1176
1801
  Icon.displayName = 'Icon';
1177
1802
  /**
1178
1803
  * A component to wrap any custom view with Link for navigation
1804
+ *
1179
1805
  * @public
1180
1806
  */
1181
1807
  const Link = memo(props => {
@@ -1188,6 +1814,7 @@ Link.displayName = 'Link';
1188
1814
  *
1189
1815
  * Items can't have size that depends on Stack's size. This means that it is impossible to make item take available space or
1190
1816
  * have size in percentage of Stack's size.
1817
+ *
1191
1818
  * @public
1192
1819
  */
1193
1820
  const Stack = memo(props => {
@@ -1196,6 +1823,8 @@ const Stack = memo(props => {
1196
1823
  });
1197
1824
  Stack.displayName = 'Stack';
1198
1825
  /**
1826
+ * Component which renders text with customizable content and styling.
1827
+ *
1199
1828
  * @public
1200
1829
  */
1201
1830
  const Text = memo(props => {
@@ -1205,6 +1834,7 @@ const Text = memo(props => {
1205
1834
  Text.displayName = 'Text';
1206
1835
  /**
1207
1836
  * A component to render Text Link for navigation
1837
+ *
1208
1838
  * @public
1209
1839
  */
1210
1840
  const TextLink = memo(props => {
@@ -1215,36 +1845,44 @@ TextLink.displayName = 'TextLink';
1215
1845
 
1216
1846
  /**
1217
1847
  * System-predefined border radiuses.
1848
+ *
1218
1849
  * @public
1219
1850
  */
1220
1851
  const getBorderRadius = () => extensionApiBridge.get().general.globals.getBorderRadius();
1221
1852
  /**
1222
1853
  * System-predefined color palette.
1854
+ *
1223
1855
  * @public
1224
1856
  */
1225
1857
  const getColorPalette = () => extensionApiBridge.get().general.globals.getColorPalette();
1226
1858
  /**
1227
1859
  * System-predefined opacity levels.
1860
+ *
1228
1861
  * @public
1229
1862
  */
1230
1863
  const getOpacityLevel = () => extensionApiBridge.get().general.globals.getOpacityLevel();
1231
1864
  /**
1232
1865
  * System-predefined spacings.
1866
+ *
1233
1867
  * @public
1234
1868
  */
1235
1869
  const getSpacing = () => extensionApiBridge.get().general.globals.getSpacing();
1236
1870
  /**
1237
1871
  * System-predefined transition duration.
1872
+ *
1238
1873
  * @public
1239
1874
  */
1240
1875
  const getTransitionDuration = () => extensionApiBridge.get().general.globals.getTransitionDuration();
1241
1876
  /**
1242
1877
  * System-predefined z-index values.
1878
+ *
1243
1879
  * @public
1244
1880
  */
1245
1881
  const getZIndex = () => extensionApiBridge.get().general.globals.getZIndex();
1246
1882
 
1247
1883
  /**
1884
+ * Provides access to data and methods for managing notifications.
1885
+ *
1248
1886
  * @public
1249
1887
  */
1250
1888
  const useNotifications = () => {
@@ -1252,6 +1890,8 @@ const useNotifications = () => {
1252
1890
  return useNotifications();
1253
1891
  };
1254
1892
  /**
1893
+ * Provides access to user profile data and methods.
1894
+ *
1255
1895
  * @public
1256
1896
  */
1257
1897
  const useUserProfile = () => {
@@ -1259,6 +1899,8 @@ const useUserProfile = () => {
1259
1899
  return useUserProfile();
1260
1900
  };
1261
1901
  /**
1902
+ * Opens a Confirmation Modal based on the provided options.
1903
+ *
1262
1904
  * @public
1263
1905
  */
1264
1906
  const useConfirmation = (args) => {
@@ -1267,6 +1909,9 @@ const useConfirmation = (args) => {
1267
1909
  };
1268
1910
 
1269
1911
  /**
1912
+ * Uploads multimedia files and creates multimedia components out of them.
1913
+ * Uploading is done using a queue, which limits the number of files being uploaded at the same time.
1914
+ *
1270
1915
  * @public
1271
1916
  */
1272
1917
  const useUploadMultimediaMutation = options => {
@@ -1281,6 +1926,8 @@ const useAddToBundleMutation = options => {
1281
1926
  return useAddToBundleMutation(options);
1282
1927
  };
1283
1928
  /**
1929
+ * Updates the language selection for a given user.
1930
+ *
1284
1931
  * @public
1285
1932
  */
1286
1933
  const useChangeUserLanguageMutation = options => {
@@ -1288,6 +1935,8 @@ const useChangeUserLanguageMutation = options => {
1288
1935
  return useChangeUserLanguageMutation(options);
1289
1936
  };
1290
1937
  /**
1938
+ * Updates the locale selection for a given user.
1939
+ *
1291
1940
  * @public
1292
1941
  */
1293
1942
  const useChangeUserLocaleMutation = options => {
@@ -1295,6 +1944,8 @@ const useChangeUserLocaleMutation = options => {
1295
1944
  return useChangeUserLocaleMutation(options);
1296
1945
  };
1297
1946
  /**
1947
+ * Removes a list of items from a given bundle.
1948
+ *
1298
1949
  * @public
1299
1950
  */
1300
1951
  const useRemoveFromBundleMutation = options => {
@@ -1303,6 +1954,8 @@ const useRemoveFromBundleMutation = options => {
1303
1954
  };
1304
1955
 
1305
1956
  /**
1957
+ * Classifies a single item based on its content and metadata.
1958
+ *
1306
1959
  * @public
1307
1960
  */
1308
1961
  const useAutoClassifyItemMutation = options => {
@@ -1310,6 +1963,8 @@ const useAutoClassifyItemMutation = options => {
1310
1963
  return useAutoClassifyItemMutation(options);
1311
1964
  };
1312
1965
  /**
1966
+ * Classifies items based on their content and metadata.
1967
+ *
1313
1968
  * @public
1314
1969
  */
1315
1970
  const useAutoClassifyItemsMutation = options => {
@@ -1317,6 +1972,8 @@ const useAutoClassifyItemsMutation = options => {
1317
1972
  return useAutoClassifyItemsMutation(options);
1318
1973
  };
1319
1974
  /**
1975
+ * Copies a single item to the specified destination.
1976
+ *
1320
1977
  * @public
1321
1978
  */
1322
1979
  const useCopyItemMutation = options => {
@@ -1324,6 +1981,8 @@ const useCopyItemMutation = options => {
1324
1981
  return useCopyItemMutation(options);
1325
1982
  };
1326
1983
  /**
1984
+ * Copies a list of items to the specified destination.
1985
+ *
1327
1986
  * @public
1328
1987
  */
1329
1988
  const useCopyItemsMutation = options => {
@@ -1331,6 +1990,8 @@ const useCopyItemsMutation = options => {
1331
1990
  return useCopyItemsMutation(options);
1332
1991
  };
1333
1992
  /**
1993
+ * Deletes a single item from the system.
1994
+ *
1334
1995
  * @public
1335
1996
  */
1336
1997
  const useDeleteItemMutation = options => {
@@ -1338,6 +1999,8 @@ const useDeleteItemMutation = options => {
1338
1999
  return useDeleteItemMutation(options);
1339
2000
  };
1340
2001
  /**
2002
+ * Deletes a list of items from the system.
2003
+ *
1341
2004
  * @public
1342
2005
  */
1343
2006
  const useDeleteItemsMutation = options => {
@@ -1345,6 +2008,9 @@ const useDeleteItemsMutation = options => {
1345
2008
  return useDeleteItemsMutation(options);
1346
2009
  };
1347
2010
  /**
2011
+ * Finishes editing of a checked out versioned item.
2012
+ * Saves changes made in minor version updates and increments the major version of the item.
2013
+ *
1348
2014
  * @public
1349
2015
  */
1350
2016
  const useFinishEditingItemMutation = options => {
@@ -1352,6 +2018,9 @@ const useFinishEditingItemMutation = options => {
1352
2018
  return useFinishEditingItemMutation(options);
1353
2019
  };
1354
2020
  /**
2021
+ * Finishes editing for checked out versioned items.
2022
+ * Saves changes made in minor version updates and increments the major version of each item.
2023
+ *
1355
2024
  * @public
1356
2025
  */
1357
2026
  const useFinishEditingItemsMutation = options => {
@@ -1359,6 +2028,8 @@ const useFinishEditingItemsMutation = options => {
1359
2028
  return useFinishEditingItemsMutation(options);
1360
2029
  };
1361
2030
  /**
2031
+ * Localizes a shared item by creating a local copy that can then be modified locally.
2032
+ *
1362
2033
  * @public
1363
2034
  */
1364
2035
  const useLocalizeItemMutation = options => {
@@ -1366,6 +2037,8 @@ const useLocalizeItemMutation = options => {
1366
2037
  return useLocalizeItemMutation(options);
1367
2038
  };
1368
2039
  /**
2040
+ * Localizes a list of shared items by creating their local copies that can then be modified locally.
2041
+ *
1369
2042
  * @public
1370
2043
  */
1371
2044
  const useLocalizeItemsMutation = options => {
@@ -1373,6 +2046,8 @@ const useLocalizeItemsMutation = options => {
1373
2046
  return useLocalizeItemsMutation(options);
1374
2047
  };
1375
2048
  /**
2049
+ * Moves a single item from its current location to the specified destination.
2050
+ *
1376
2051
  * @public
1377
2052
  */
1378
2053
  const useMoveItemMutation = options => {
@@ -1380,6 +2055,8 @@ const useMoveItemMutation = options => {
1380
2055
  return useMoveItemMutation(options);
1381
2056
  };
1382
2057
  /**
2058
+ * Moves a list of items from their current location to the specified destination.
2059
+ *
1383
2060
  * @public
1384
2061
  */
1385
2062
  const useMoveItemsMutation = options => {
@@ -1387,6 +2064,8 @@ const useMoveItemsMutation = options => {
1387
2064
  return useMoveItemsMutation(options);
1388
2065
  };
1389
2066
  /**
2067
+ * Publishes a list of items with provided instructions.
2068
+ *
1390
2069
  * @public
1391
2070
  */
1392
2071
  const usePublishItemsMutation = options => {
@@ -1394,6 +2073,9 @@ const usePublishItemsMutation = options => {
1394
2073
  return usePublishItemsMutation(options);
1395
2074
  };
1396
2075
  /**
2076
+ * Reverts the item to the last major version.
2077
+ * If the item does not have a major version, it is deleted.
2078
+ *
1397
2079
  * @public
1398
2080
  */
1399
2081
  const useRevertItemMutation = options => {
@@ -1401,6 +2083,9 @@ const useRevertItemMutation = options => {
1401
2083
  return useRevertItemMutation(options);
1402
2084
  };
1403
2085
  /**
2086
+ * Reverts a list of items item to their last major version.
2087
+ * If any of the items do not have a major version, they are deleted.
2088
+ *
1404
2089
  * @public
1405
2090
  */
1406
2091
  const useRevertItemsMutation = options => {
@@ -1408,6 +2093,8 @@ const useRevertItemsMutation = options => {
1408
2093
  return useRevertItemsMutation(options);
1409
2094
  };
1410
2095
  /**
2096
+ * Rolls back all changes that have been made to an item since a specified version.
2097
+ *
1411
2098
  * @public
1412
2099
  */
1413
2100
  const useRollbackItemMutation = options => {
@@ -1415,6 +2102,8 @@ const useRollbackItemMutation = options => {
1415
2102
  return useRollbackItemMutation(options);
1416
2103
  };
1417
2104
  /**
2105
+ * Unlocalizes a single item which removes its local copy from a publication.
2106
+ *
1418
2107
  * @public
1419
2108
  */
1420
2109
  const useUnlocalizeItemMutation = options => {
@@ -1422,6 +2111,8 @@ const useUnlocalizeItemMutation = options => {
1422
2111
  return useUnlocalizeItemMutation(options);
1423
2112
  };
1424
2113
  /**
2114
+ * Unlocalizes a list of items which removes their local copies from a publication.
2115
+ *
1425
2116
  * @public
1426
2117
  */
1427
2118
  const useUnlocalizeItemsMutation = options => {
@@ -1429,6 +2120,8 @@ const useUnlocalizeItemsMutation = options => {
1429
2120
  return useUnlocalizeItemsMutation(options);
1430
2121
  };
1431
2122
  /**
2123
+ * Unpublishes a list of items with provided instructions.
2124
+ *
1432
2125
  * @public
1433
2126
  */
1434
2127
  const useUnpublishItemsMutation = options => {
@@ -1436,6 +2129,8 @@ const useUnpublishItemsMutation = options => {
1436
2129
  return useUnpublishItemsMutation(options);
1437
2130
  };
1438
2131
  /**
2132
+ * Updates an item by URI.
2133
+ *
1439
2134
  * @public
1440
2135
  */
1441
2136
  const useUpdateItemMutation = options => {
@@ -1452,6 +2147,8 @@ const useCreateTranslationJobMutation = options => {
1452
2147
  };
1453
2148
 
1454
2149
  /**
2150
+ * Assigns a list of activities to a new User or Group.
2151
+ *
1455
2152
  * @public
1456
2153
  */
1457
2154
  const useAssignActivitiesMutation = options => {
@@ -1459,6 +2156,8 @@ const useAssignActivitiesMutation = options => {
1459
2156
  return useAssignActivitiesMutation(options);
1460
2157
  };
1461
2158
  /**
2159
+ * Assigns a single activity to a new User or Group.
2160
+ *
1462
2161
  * @public
1463
2162
  */
1464
2163
  const useAssignActivityMutation = options => {
@@ -1480,6 +2179,8 @@ const useFinishActivitiesMutation = options => {
1480
2179
  return useFinishActivitiesMutation(options);
1481
2180
  };
1482
2181
  /**
2182
+ * Restarts failed activities.
2183
+ *
1483
2184
  * @public
1484
2185
  */
1485
2186
  const useRestartActivitiesMutation = options => {
@@ -1487,6 +2188,8 @@ const useRestartActivitiesMutation = options => {
1487
2188
  return useRestartActivitiesMutation(options);
1488
2189
  };
1489
2190
  /**
2191
+ * Restarts an activity which is failed.
2192
+ *
1490
2193
  * @public
1491
2194
  */
1492
2195
  const useRestartActivityMutation = options => {
@@ -1508,6 +2211,8 @@ const useStartActivityMutation = options => {
1508
2211
  return useStartActivityMutation(options);
1509
2212
  };
1510
2213
  /**
2214
+ * Starts a new workflow and associates the bundle and all items inside it with that workflow instance.
2215
+ *
1511
2216
  * @public
1512
2217
  */
1513
2218
  const useStartWorkflowMutation = options => {
@@ -1516,6 +2221,8 @@ const useStartWorkflowMutation = options => {
1516
2221
  };
1517
2222
 
1518
2223
  /**
2224
+ * Retrieves user profile data of the currently logged-in user.
2225
+ *
1519
2226
  * @public
1520
2227
  */
1521
2228
  const useUserProfileQuery = options => {
@@ -1524,6 +2231,8 @@ const useUserProfileQuery = options => {
1524
2231
  };
1525
2232
 
1526
2233
  /**
2234
+ * Retrieves the context of the provided item within the BluePrint hierarchy.
2235
+ *
1527
2236
  * @public
1528
2237
  */
1529
2238
  const useItemBlueprintHierarchyQuery = (props, options) => {
@@ -1531,6 +2240,8 @@ const useItemBlueprintHierarchyQuery = (props, options) => {
1531
2240
  return useItemBlueprintHierarchyQuery(props, options);
1532
2241
  };
1533
2242
  /**
2243
+ * Retrieves a list of child items for the provided organizational item.
2244
+ *
1534
2245
  * @public
1535
2246
  */
1536
2247
  const useItemChildrenQuery = (props, options) => {
@@ -1538,6 +2249,8 @@ const useItemChildrenQuery = (props, options) => {
1538
2249
  return useItemChildrenQuery(props, options);
1539
2250
  };
1540
2251
  /**
2252
+ * Retrieves a list of items classified with the provided Keyword or Concept.
2253
+ *
1541
2254
  * @public
1542
2255
  */
1543
2256
  const useItemClassifiedItemsQuery = (props, options) => {
@@ -1545,6 +2258,8 @@ const useItemClassifiedItemsQuery = (props, options) => {
1545
2258
  return useItemClassifiedItemsQuery(props, options);
1546
2259
  };
1547
2260
  /**
2261
+ * Retrieves the default model for the provided model type.
2262
+ *
1548
2263
  * @public
1549
2264
  */
1550
2265
  const useItemDefaultDataQuery = (props, options) => {
@@ -1552,6 +2267,8 @@ const useItemDefaultDataQuery = (props, options) => {
1552
2267
  return useItemDefaultDataQuery(props, options);
1553
2268
  };
1554
2269
  /**
2270
+ * Retrieves a list of major versions of the provided versioned item.
2271
+ *
1555
2272
  * @public
1556
2273
  */
1557
2274
  const useItemHistoryQuery = (props, options) => {
@@ -1559,6 +2276,8 @@ const useItemHistoryQuery = (props, options) => {
1559
2276
  return useItemHistoryQuery(props, options);
1560
2277
  };
1561
2278
  /**
2279
+ * Retrieves a list of published pages that use the provided item.
2280
+ *
1562
2281
  * @public
1563
2282
  */
1564
2283
  const useItemPublishedPagesQuery = (props, options) => {
@@ -1566,6 +2285,8 @@ const useItemPublishedPagesQuery = (props, options) => {
1566
2285
  return useItemPublishedPagesQuery(props, options);
1567
2286
  };
1568
2287
  /**
2288
+ * Retrieves a list of targets to which the provided item is published.
2289
+ *
1569
2290
  * @public
1570
2291
  */
1571
2292
  const useItemPublishedToQuery = (props, options) => {
@@ -1573,6 +2294,8 @@ const useItemPublishedToQuery = (props, options) => {
1573
2294
  return useItemPublishedToQuery(props, options);
1574
2295
  };
1575
2296
  /**
2297
+ * Retrieves a list of URLs where the provided item is published.
2298
+ *
1576
2299
  * @public
1577
2300
  */
1578
2301
  const useItemPublishUrlsQuery = (props, options) => {
@@ -1580,6 +2303,8 @@ const useItemPublishUrlsQuery = (props, options) => {
1580
2303
  return useItemPublishUrlsQuery(props, options);
1581
2304
  };
1582
2305
  /**
2306
+ * Retrieves a single item using the provided item URI.
2307
+ *
1583
2308
  * @public
1584
2309
  */
1585
2310
  const useItemQuery = (props, options) => {
@@ -1587,6 +2312,8 @@ const useItemQuery = (props, options) => {
1587
2312
  return useItemQuery(props, options);
1588
2313
  };
1589
2314
  /**
2315
+ * Retrieves a list of items using the provided list of item URIs.
2316
+ *
1590
2317
  * @public
1591
2318
  */
1592
2319
  const useItemsQuery = (props, options) => {
@@ -1594,6 +2321,8 @@ const useItemsQuery = (props, options) => {
1594
2321
  return useItemsQuery(props, options);
1595
2322
  };
1596
2323
  /**
2324
+ * Retrieves translation information for the provided item.
2325
+ *
1597
2326
  * @public
1598
2327
  */
1599
2328
  const useItemTranslationInfoQuery = (props, options) => {
@@ -1601,6 +2330,8 @@ const useItemTranslationInfoQuery = (props, options) => {
1601
2330
  return useItemTranslationInfoQuery(props, options);
1602
2331
  };
1603
2332
  /**
2333
+ * Retrieves a list of items that use the provided item.
2334
+ *
1604
2335
  * @public
1605
2336
  */
1606
2337
  const useItemUsedByQuery = (props, options) => {
@@ -1608,6 +2339,8 @@ const useItemUsedByQuery = (props, options) => {
1608
2339
  return useItemUsedByQuery(props, options);
1609
2340
  };
1610
2341
  /**
2342
+ * Retrieves a list of items that are used by the provided item.
2343
+ *
1611
2344
  * @public
1612
2345
  */
1613
2346
  const useItemUsesQuery = (props, options) => {
@@ -1615,6 +2348,8 @@ const useItemUsesQuery = (props, options) => {
1615
2348
  return useItemUsesQuery(props, options);
1616
2349
  };
1617
2350
  /**
2351
+ * Retrieves the context of the provided publication within the BluePrint hierarchy.
2352
+ *
1618
2353
  * @public
1619
2354
  */
1620
2355
  const usePublicationBlueprintHierarchyQuery = (props, options) => {
@@ -1659,6 +2394,8 @@ const useUsersQuery = (props, options) => {
1659
2394
  };
1660
2395
 
1661
2396
  /**
2397
+ * Retrieves a list of items that will be published with the provided instructions.
2398
+ *
1662
2399
  * @public
1663
2400
  */
1664
2401
  const useItemsToPublishQuery = (props, options) => {
@@ -1666,6 +2403,8 @@ const useItemsToPublishQuery = (props, options) => {
1666
2403
  return useItemsToPublishQuery(props, options);
1667
2404
  };
1668
2405
  /**
2406
+ * Retrieves a list of items that will be unpublished with the provided instructions.
2407
+ *
1669
2408
  * @public
1670
2409
  */
1671
2410
  const useItemsToUnpublishQuery = (props, options) => {
@@ -1673,6 +2412,8 @@ const useItemsToUnpublishQuery = (props, options) => {
1673
2412
  return useItemsToUnpublishQuery(props, options);
1674
2413
  };
1675
2414
  /**
2415
+ * Retrieves a list of Target Types for the provided Business Process Type.
2416
+ *
1676
2417
  * @public
1677
2418
  */
1678
2419
  const usePublishableTargetTypesQuery = (props, options) => {
@@ -1681,6 +2422,8 @@ const usePublishableTargetTypesQuery = (props, options) => {
1681
2422
  };
1682
2423
 
1683
2424
  /**
2425
+ * Retrieves search results within an individual item for the provided input.
2426
+ *
1684
2427
  * @public
1685
2428
  */
1686
2429
  const useSearchInContainerQuery = (props, options) => {
@@ -1688,6 +2431,8 @@ const useSearchInContainerQuery = (props, options) => {
1688
2431
  return useSearchInContainerQuery(props, options);
1689
2432
  };
1690
2433
  /**
2434
+ * Retrieves search results within the system for the provided input.
2435
+ *
1691
2436
  * @public
1692
2437
  */
1693
2438
  const useSystemSearchQuery = (props, options) => {
@@ -1729,7 +2474,7 @@ const createExtensionGlobals = () => {
1729
2474
  };
1730
2475
  };
1731
2476
 
1732
- const version = "1.0.2";
2477
+ const version = "2.0.0";
1733
2478
  const peerDependencies = {
1734
2479
  "@tridion-sites/models": "workspace:*",
1735
2480
  "@tridion-sites/open-api-client": "workspace:*",
@@ -1737,7 +2482,7 @@ const peerDependencies = {
1737
2482
  "react-dom": "18.2.0",
1738
2483
  "react-is": "18.2.0",
1739
2484
  "styled-components": "5.3.6",
1740
- tinymce: "6.4.2"
2485
+ tinymce: "6.7.1"
1741
2486
  };
1742
2487
 
1743
2488
  /**
@@ -1748,4 +2493,4 @@ const frameworkInfo = {
1748
2493
  peerDependencies,
1749
2494
  };
1750
2495
 
1751
- export { ActionsConfigurationExtensionsBuilder, ActivitiesExplorerExtensionsBuilder, ActivitiesExplorerTableExtensionsBuilder, Block, Button, Center, ContentEditorExtensionsBuilder, ContentExplorerExtensionsBuilder, ContentExplorerTableExtensionsBuilder, ContentExplorerTreeExtensionsBuilder, ExtensionBuilder, Flex, HeaderExtensionsBuilder, Icon, Link, NavigationExtensionsBuilder, RichTextFieldExtensionsBuilder, Stack, Text, TextLink, TranslationExtensionsBuilder, activitiesExplorerActionGroupId, activitiesExplorerActionGroupIds, activitiesExplorerActionId, activitiesExplorerActionIds, contentExplorerActionGroupId, contentExplorerActionGroupIds, contentExplorerActionId, contentExplorerActionIds, contentExplorerPanelIds, createExtensionGlobals, extensionApiBridge, frameworkInfo, getBorderRadius, getColorPalette, getOpacityLevel, getSpacing, getTransitionDuration, getZIndex, isFavoritesNodeId, isItemNode, isItemNodeOfType, isItemsInProgressNode, isItemsInProgressNodeId, isPublicationsNode, isPublicationsNodeId, isRootNode, isRootNodeId, isSystemNode, navigationItemId, navigationItemIds, useActivitiesExplorer, useActivitiesExplorerTable, useActivityInstancesQuery, useAddToBundleMutation, useAssignActivitiesMutation, useAssignActivityMutation, useAutoClassifyItemMutation, useAutoClassifyItemsMutation, useChangeUserLanguageMutation, useChangeUserLocaleMutation, useConfirmation, useContentExplorer, useContentExplorerTable, useContentExplorerTree, useCopyItemMutation, useCopyItemsMutation, useCreateTranslationJobMutation, useDefaultTranslationJobQuery, useDeleteItemMutation, useDeleteItemsMutation, useEditor, useFavoritesQuery, useFinishActivitiesMutation, useFinishActivityMutation, useFinishEditingItemMutation, useFinishEditingItemsMutation, useItemBlueprintHierarchyQuery, useItemChildrenQuery, useItemClassifiedItemsQuery, useItemDefaultDataQuery, useItemHistoryQuery, useItemPublishUrlsQuery, useItemPublishedPagesQuery, useItemPublishedToQuery, useItemQuery, useItemTranslationInfoQuery, useItemUsedByQuery, useItemUsesQuery, useItemsInProgressQuery, useItemsQuery, useItemsToPublishQuery, useItemsToUnpublishQuery, useLocalizeItemMutation, useLocalizeItemsMutation, useMoveItemMutation, useMoveItemsMutation, useNotifications, useOptionalActivitiesExplorer, useOptionalActivitiesExplorerTable, useOptionalBundleEditor, useOptionalCategoryEditor, useOptionalComponentEditor, useOptionalContentExplorer, useOptionalContentExplorerTable, useOptionalContentExplorerTree, useOptionalEditor, useOptionalFolderEditor, useOptionalKeywordEditor, useOptionalPageEditor, useOptionalStructureGroupEditor, usePublicationBlueprintHierarchyQuery, usePublicationsQuery, usePublishItemsMutation, usePublishableTargetTypesQuery, useRemoveFromBundleMutation, useRestartActivitiesMutation, useRestartActivityMutation, useRevertItemMutation, useRevertItemsMutation, useRollbackItemMutation, useSearchInContainerQuery, useStartActivitiesMutation, useStartActivityMutation, useStartWorkflowMutation, useSystemSearchQuery, useUnlocalizeItemMutation, useUnlocalizeItemsMutation, useUnpublishItemsMutation, useUpdateItemMutation, useUploadMultimediaMutation, useUserGroupsQuery, useUserProfile, useUserProfileQuery, useUsersQuery };
2496
+ export { ActionsConfigurationExtensionsBuilder, ActivitiesExplorerExtensionsBuilder, ActivitiesExplorerInsightsPanelsExtensionsBuilder, ActivitiesExplorerTableExtensionsBuilder, Block, Button, Center, ContentEditorExtensionsBuilder, ContentExplorerExtensionsBuilder, ContentExplorerInsightsPanelsExtensionsBuilder, ContentExplorerTableExtensionsBuilder, ContentExplorerTreeExtensionsBuilder, ExtensionBuilder, Flex, HeaderExtensionsBuilder, Icon, Link, NavigationExtensionsBuilder, PropertiesList, PublishingQueueExplorerExtensionsBuilder, PublishingQueueExplorerInsightsPanelsExtensionsBuilder, PublishingQueueExplorerTableExtensionsBuilder, RichTextFieldExtensionsBuilder, Stack, Text, TextLink, TranslationExtensionsBuilder, activitiesExplorerActionGroupId, activitiesExplorerActionGroupIds, activitiesExplorerActionId, activitiesExplorerActionIds, activitiesExplorerPanelId, activitiesExplorerPanelIds, contentExplorerActionGroupId, contentExplorerActionGroupIds, contentExplorerActionId, contentExplorerActionIds, contentExplorerPanelId, contentExplorerPanelIds, createExtensionGlobals, extensionApiBridge, frameworkInfo, getBorderRadius, getColorPalette, getOpacityLevel, getSpacing, getTransitionDuration, getZIndex, isFavoritesNodeId, isItemNode, isItemNodeOfType, isItemsInProgressNode, isItemsInProgressNodeId, isPublicationsNode, isPublicationsNodeId, isRootNode, isRootNodeId, isSystemNode, navigationItemId, navigationItemIds, publishingQueueExplorerActionGroupId, publishingQueueExplorerActionGroupIds, publishingQueueExplorerActionId, publishingQueueExplorerActionIds, publishingQueueExplorerPanelId, publishingQueueExplorerPanelIds, useActivitiesExplorer, useActivitiesExplorerTable, useActivityInstancesQuery, useAddToBundleMutation, useAssignActivitiesMutation, useAssignActivityMutation, useAutoClassifyItemMutation, useAutoClassifyItemsMutation, useChangeUserLanguageMutation, useChangeUserLocaleMutation, useConfirmation, useContentExplorer, useContentExplorerTable, useContentExplorerTree, useCopyItemMutation, useCopyItemsMutation, useCreateTranslationJobMutation, useDefaultTranslationJobQuery, useDeleteItemMutation, useDeleteItemsMutation, useEditor, useFavoritesQuery, useFinishActivitiesMutation, useFinishActivityMutation, useFinishEditingItemMutation, useFinishEditingItemsMutation, useItemBlueprintHierarchyQuery, useItemChildrenQuery, useItemClassifiedItemsQuery, useItemDefaultDataQuery, useItemHistoryQuery, useItemPublishUrlsQuery, useItemPublishedPagesQuery, useItemPublishedToQuery, useItemQuery, useItemTranslationInfoQuery, useItemUsedByQuery, useItemUsesQuery, useItemsInProgressQuery, useItemsQuery, useItemsToPublishQuery, useItemsToUnpublishQuery, useLocalizeItemMutation, useLocalizeItemsMutation, useMoveItemMutation, useMoveItemsMutation, useNotifications, useOptionalActivitiesExplorer, useOptionalActivitiesExplorerTable, useOptionalBundleEditor, useOptionalCategoryEditor, useOptionalComponentEditor, useOptionalContentExplorer, useOptionalContentExplorerTable, useOptionalContentExplorerTree, useOptionalEditor, useOptionalFolderEditor, useOptionalKeywordEditor, useOptionalPageEditor, useOptionalPublishingQueueExplorer, useOptionalPublishingQueueExplorerTable, useOptionalStructureGroupEditor, usePublicationBlueprintHierarchyQuery, usePublicationsQuery, usePublishItemsMutation, usePublishableTargetTypesQuery, usePublishingQueueExplorer, usePublishingQueueExplorerTable, useRemoveFromBundleMutation, useRestartActivitiesMutation, useRestartActivityMutation, useRevertItemMutation, useRevertItemsMutation, useRollbackItemMutation, useSearchInContainerQuery, useStartActivitiesMutation, useStartActivityMutation, useStartWorkflowMutation, useSystemSearchQuery, useUnlocalizeItemMutation, useUnlocalizeItemsMutation, useUnpublishItemsMutation, useUpdateItemMutation, useUploadMultimediaMutation, useUserGroupsQuery, useUserProfile, useUserProfileQuery, useUsersQuery };