@tridion-sites/extensions 1.0.3 → 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.d.ts CHANGED
@@ -33,7 +33,9 @@ import type { Publication } from '@tridion-sites/models';
33
33
  import type { PublicationBlueprintHierarchy } from '@tridion-sites/models';
34
34
  import type { PublishInfo } from '@tridion-sites/models';
35
35
  import type { PublishPriority } from '@tridion-sites/models';
36
+ import type { PublishTransaction } from '@tridion-sites/models';
36
37
  import type { PublishTransactionsCreationResult } from '@tridion-sites/models';
38
+ import type { PublishTransactionState } from '@tridion-sites/models';
37
39
  import type { PublishUrlInfo } from '@tridion-sites/models';
38
40
  import type { RawEditorOptions } from 'tinymce';
39
41
  import { ReactElement } from 'react';
@@ -48,6 +50,7 @@ import type { StringSearchMode } from '@tridion-sites/models';
48
50
  import type { StructureGroup } from '@tridion-sites/models';
49
51
  import type { StructureResolveOption } from '@tridion-sites/models';
50
52
  import type { TargetType } from '@tridion-sites/models';
53
+ import type { TcmUri } from '@tridion-sites/models';
51
54
  import type { TranslationInfo } from '@tridion-sites/models';
52
55
  import type { TranslationJob } from '@tridion-sites/models';
53
56
  import type { TranslationJobType } from '@tridion-sites/models';
@@ -262,12 +265,20 @@ export declare interface ActivitiesExplorerApiStorage {
262
265
  hooks: ActivitiesExplorerHooksApiStorage;
263
266
  }
264
267
 
268
+ /**
269
+ * @public
270
+ */
271
+ export declare interface ActivitiesExplorerExtensionInsightsPanelProps {
272
+ activityId: ItemUri;
273
+ }
274
+
265
275
  /**
266
276
  * @public
267
277
  */
268
278
  export declare interface ActivitiesExplorerExtensions {
269
279
  actions: ReadonlyArray<ActionExtension>;
270
280
  table: ActivitiesExplorerTableExtensions;
281
+ insightsPanels: ActivitiesExplorerInsightsPanelsExtensions;
271
282
  }
272
283
 
273
284
  /**
@@ -279,6 +290,10 @@ export declare class ActivitiesExplorerExtensionsBuilder {
279
290
  * Provides a mechanism for customizing Activities Explorer Table.
280
291
  */
281
292
  readonly table: ActivitiesExplorerTableExtensionsBuilder;
293
+ /**
294
+ * Provides a mechanism for customizing Activities Explorer Insights Panels.
295
+ */
296
+ readonly insightsPanels: ActivitiesExplorerInsightsPanelsExtensionsBuilder;
282
297
  /**
283
298
  * Adds a new action to Activities Explorer.
284
299
  *
@@ -312,6 +327,10 @@ export declare interface ActivitiesExplorerHookResult {
312
327
  * The loading state of the Activity Instances list.
313
328
  */
314
329
  itemsLoadingState: LoadingState;
330
+ /**
331
+ * Currently active ActivityInstance.
332
+ */
333
+ currentItem: ActivityInstance | undefined;
315
334
  }
316
335
 
317
336
  /**
@@ -324,6 +343,73 @@ export declare interface ActivitiesExplorerHooksApiStorage {
324
343
  useOptionalActivitiesExplorerTable: OptionalActivitiesExplorerTableHook;
325
344
  }
326
345
 
346
+ /**
347
+ * @public
348
+ */
349
+ export declare type ActivitiesExplorerInsightsPanelsExtension = () => InsightsPanelsExtensionConfiguration<ActivitiesExplorerExtensionInsightsPanelProps, ActivitiesExplorerInsightsPanelsHookProps>;
350
+
351
+ /**
352
+ * @public
353
+ */
354
+ export declare interface ActivitiesExplorerInsightsPanelsExtensions {
355
+ items: ReadonlyArray<ActivitiesExplorerInsightsPanelsExtension>;
356
+ config: ReadonlyArray<ListBuilderConfigurationExtension<string>>;
357
+ }
358
+
359
+ /**
360
+ * @public
361
+ */
362
+ export declare class ActivitiesExplorerInsightsPanelsExtensionsBuilder {
363
+ private _insightsPanelsExtensions;
364
+ /**
365
+ * Provides a mechanism for customizing the configuration of insights panels.
366
+ */
367
+ readonly config: ListBuilder<string>;
368
+ /**
369
+ * Registers a new insights panel.
370
+ *
371
+ * @remarks
372
+ * This method only registers the insights panel and does not automatically make it visible in the application.
373
+ * To add the insights panel to the application, use {@link ActivitiesExplorerInsightsPanelsExtensionsBuilder.config}.
374
+ *
375
+ * @param item - insights panel to be registered
376
+ */
377
+ register: (item: ActivitiesExplorerInsightsPanelsExtension) => this;
378
+ build: () => ActivitiesExplorerInsightsPanelsExtensions;
379
+ }
380
+
381
+ /**
382
+ * @public
383
+ */
384
+ export declare interface ActivitiesExplorerInsightsPanelsHookProps {
385
+ activityId?: ItemUri;
386
+ }
387
+
388
+ /**
389
+ * Type represents ID of a built-in panel of the Activities Explorer.
390
+ *
391
+ * @public
392
+ */
393
+ export declare type ActivitiesExplorerPanelId = ValuesOfArray<typeof activitiesExplorerPanelIds>;
394
+
395
+ /**
396
+ * All available built-in Activities Explorer panel IDs.
397
+ *
398
+ * @public
399
+ */
400
+ export declare const activitiesExplorerPanelId: {
401
+ information: "information";
402
+ relatedItems: "relatedItems";
403
+ processHistory: "processHistory";
404
+ };
405
+
406
+ /**
407
+ * List of all built-in panel IDs of the Activities Explorer.
408
+ *
409
+ * @public
410
+ */
411
+ export declare const activitiesExplorerPanelIds: readonly ["information", "relatedItems", "processHistory"];
412
+
327
413
  /**
328
414
  * @public
329
415
  */
@@ -398,6 +484,18 @@ export declare interface ActivitiesExplorerTableHookResult {
398
484
  * Refetch list of Activity Instances.
399
485
  */
400
486
  refresh: () => void;
487
+ /**
488
+ * Current state of selected Activity Instances in the Table.
489
+ */
490
+ selection: ActivitiesExplorerTableSelection;
491
+ }
492
+
493
+ /**
494
+ * @public
495
+ */
496
+ export declare interface ActivitiesExplorerTableSelection {
497
+ ids: ReadonlySet<ItemUri>;
498
+ selectedItems: ReadonlyArray<ActivityInstance>;
401
499
  }
402
500
 
403
501
  /**
@@ -426,6 +524,14 @@ export declare interface ActivityInstancesQueryProps {
426
524
  * If specified, only Activity Instances based on the given Process Definition will be returned.
427
525
  */
428
526
  processDefinitionId?: ItemUri;
527
+ /**
528
+ * If specified, inly Activity Instances created by given User will be returned.
529
+ */
530
+ ownerId?: ItemUri;
531
+ /**
532
+ * If specified, inly Activity Instances assigned to a given User will be returned.
533
+ */
534
+ assigneeId?: ItemUri;
429
535
  }
430
536
 
431
537
  /**
@@ -893,6 +999,7 @@ export declare interface ColorPalette {
893
999
  yellow50: string;
894
1000
  yellow100: string;
895
1001
  yellow120: string;
1002
+ yellow140: string;
896
1003
  }
897
1004
 
898
1005
  /**
@@ -1178,6 +1285,21 @@ export declare const contentExplorerActionIds: readonly ["open", "openEditor", "
1178
1285
  export declare interface ContentExplorerApiStorage {
1179
1286
  hooks: ContentExplorerHooksApiStorage;
1180
1287
  utils: ContentExplorerUtilsApiStorage;
1288
+ components: ContentExplorerComponentsApiStorage;
1289
+ }
1290
+
1291
+ /**
1292
+ * @internal
1293
+ */
1294
+ export declare interface ContentExplorerComponentsApiStorage {
1295
+ PropertiesList: PropertiesListComponent;
1296
+ }
1297
+
1298
+ /**
1299
+ * @public
1300
+ */
1301
+ export declare interface ContentExplorerExtensionInsightsPanelProps {
1302
+ item: IdentifiableObject;
1181
1303
  }
1182
1304
 
1183
1305
  /**
@@ -1187,6 +1309,7 @@ export declare interface ContentExplorerExtensions {
1187
1309
  actions: ReadonlyArray<ActionExtension>;
1188
1310
  table: ContentExplorerTableExtensions;
1189
1311
  tree: ContentExplorerTreeExtensions;
1312
+ insightsPanels: ContentExplorerInsightsPanelsExtensions;
1190
1313
  }
1191
1314
 
1192
1315
  /**
@@ -1202,6 +1325,10 @@ export declare class ContentExplorerExtensionsBuilder {
1202
1325
  * Provides a mechanism for customizing Content Explorer Tree.
1203
1326
  */
1204
1327
  readonly tree: ContentExplorerTreeExtensionsBuilder;
1328
+ /**
1329
+ * Provides a mechanism for customizing Content Explorer Insights Panels.
1330
+ */
1331
+ readonly insightsPanels: ContentExplorerInsightsPanelsExtensionsBuilder;
1205
1332
  /**
1206
1333
  * Adds a new action to Content Explorer.
1207
1334
  *
@@ -1324,6 +1451,10 @@ export declare type ContentExplorerHook = () => ContentExplorerHookResult;
1324
1451
  export declare interface ContentExplorerHookResult {
1325
1452
  hierarchy: ContentExplorerHierarchy;
1326
1453
  currentNode: ContentExplorerNode | undefined;
1454
+ /**
1455
+ * Currently active item.
1456
+ */
1457
+ currentItem: IdentifiableObject | undefined;
1327
1458
  /**
1328
1459
  * Loading state of nodes of the Content Explorer hierarchy.
1329
1460
  */
@@ -1346,6 +1477,48 @@ export declare interface ContentExplorerHooksApiStorage {
1346
1477
  useOptionalContentExplorerTree: OptionalContentExplorerTreeHook;
1347
1478
  }
1348
1479
 
1480
+ /**
1481
+ * @public
1482
+ */
1483
+ export declare type ContentExplorerInsightsPanelsExtension = () => InsightsPanelsExtensionConfiguration<ContentExplorerExtensionInsightsPanelProps, ContentExplorerInsightsPanelsHookProps>;
1484
+
1485
+ /**
1486
+ * @public
1487
+ */
1488
+ export declare interface ContentExplorerInsightsPanelsExtensions {
1489
+ items: ReadonlyArray<ContentExplorerInsightsPanelsExtension>;
1490
+ config: ReadonlyArray<ListBuilderConfigurationExtension<string>>;
1491
+ }
1492
+
1493
+ /**
1494
+ * @public
1495
+ */
1496
+ export declare class ContentExplorerInsightsPanelsExtensionsBuilder {
1497
+ private _insightsPanelsExtensions;
1498
+ /**
1499
+ * Provides a mechanism for customizing the configuration of insights panels.
1500
+ */
1501
+ readonly config: ListBuilder<string>;
1502
+ /**
1503
+ * Registers a new insights panel.
1504
+ *
1505
+ * @remarks
1506
+ * This method only registers the insights panel and does not automatically make it visible in the application.
1507
+ * To add the insights panel to the application, use {@link ContentExplorerInsightsPanelsExtensionsBuilder.config}.
1508
+ *
1509
+ * @param item - insights panel to be registered
1510
+ */
1511
+ register: (item: ContentExplorerInsightsPanelsExtension) => this;
1512
+ build: () => ContentExplorerInsightsPanelsExtensions;
1513
+ }
1514
+
1515
+ /**
1516
+ * @public
1517
+ */
1518
+ export declare interface ContentExplorerInsightsPanelsHookProps {
1519
+ item?: IdentifiableObject;
1520
+ }
1521
+
1349
1522
  /**
1350
1523
  * Tridion item node of the Content Explorer hierarchy.
1351
1524
  *
@@ -1410,6 +1583,23 @@ export declare interface ContentExplorerNodeData {
1410
1583
  */
1411
1584
  export declare type ContentExplorerPanelId = ValuesOfArray<typeof contentExplorerPanelIds>;
1412
1585
 
1586
+ /**
1587
+ * All available built-in Content Explorer panel IDs.
1588
+ *
1589
+ * @public
1590
+ */
1591
+ export declare const contentExplorerPanelId: {
1592
+ information: "information";
1593
+ general: "general";
1594
+ metadata: "metadata";
1595
+ history: "history";
1596
+ blueprint: "blueprint";
1597
+ "where-used": "where-used";
1598
+ "view-on-site": "view-on-site";
1599
+ "published-to": "published-to";
1600
+ translations: "translations";
1601
+ };
1602
+
1413
1603
  /**
1414
1604
  * List of all built-in panel IDs of the Content Explorer.
1415
1605
  *
@@ -1538,6 +1728,18 @@ export declare type ContentExplorerTableHook = () => ContentExplorerTableHookRes
1538
1728
  */
1539
1729
  export declare interface ContentExplorerTableHookResult {
1540
1730
  refresh: () => void;
1731
+ /**
1732
+ * Current state of selected items in the Table.
1733
+ */
1734
+ selection: ContentExplorerTableSelection;
1735
+ }
1736
+
1737
+ /**
1738
+ * @public
1739
+ */
1740
+ export declare interface ContentExplorerTableSelection {
1741
+ ids: ReadonlySet<ItemUri>;
1742
+ selectedItems: ReadonlyArray<IdentifiableObject>;
1541
1743
  }
1542
1744
 
1543
1745
  /**
@@ -1791,6 +1993,7 @@ export declare const extensionApiBridge: {
1791
1993
  export declare interface ExtensionApiImplementationStorage {
1792
1994
  activitiesExplorer: ActivitiesExplorerApiStorage;
1793
1995
  contentExplorer: ContentExplorerApiStorage;
1996
+ publishingQueueExplorer: PublishingQueueExplorerApiStorage;
1794
1997
  editors: EditorsApiStorage;
1795
1998
  general: GeneralApiStorage;
1796
1999
  }
@@ -1819,6 +2022,10 @@ export declare class ExtensionBuilder {
1819
2022
  * Provides a mechanism for customizing Activities Explorer.
1820
2023
  */
1821
2024
  readonly activitiesExplorer: ActivitiesExplorerExtensionsBuilder;
2025
+ /**
2026
+ * Provides a mechanism for customizing Publishing Queue Explorer.
2027
+ */
2028
+ readonly publishingQueueExplorer: PublishingQueueExplorerExtensionsBuilder;
1822
2029
  build: () => ExtensionPoints;
1823
2030
  }
1824
2031
 
@@ -1848,6 +2055,7 @@ export declare interface ExtensionPoints {
1848
2055
  contentExplorer: ContentExplorerExtensions;
1849
2056
  activitiesExplorer: ActivitiesExplorerExtensions;
1850
2057
  translations: TranslationExtensions;
2058
+ publishingQueueExplorer: PublishingQueueExplorerExtensions;
1851
2059
  }
1852
2060
 
1853
2061
  /**
@@ -2192,6 +2400,7 @@ export declare interface GeneralQueriesApiStorage {
2192
2400
  useItemsToPublishQuery: ItemsToPublishQueryHook;
2193
2401
  useItemsToUnpublishQuery: ItemsToUnpublishQueryHook;
2194
2402
  usePublishableTargetTypesQuery: PublishableTargetTypesQueryHook;
2403
+ usePublishTransactionsQuery: PublishTransactionsQueryHook;
2195
2404
  };
2196
2405
  search: {
2197
2406
  useSearchInContainerQuery: SearchInContainerQueryHook;
@@ -2219,7 +2428,10 @@ export declare const getBorderRadius: BorderRadiusGetter;
2219
2428
  */
2220
2429
  export declare const getColorPalette: ColorPaletteGetter;
2221
2430
 
2222
- declare type GetListBuilderItemId<TItem> = (item: TItem) => string;
2431
+ /**
2432
+ * @internal
2433
+ */
2434
+ export declare type GetListBuilderItemId<TItem> = (item: TItem) => string;
2223
2435
 
2224
2436
  /**
2225
2437
  * System-predefined opacity levels.
@@ -2303,6 +2515,47 @@ export declare interface IconProps extends TooltipProps, SpaceProps, SizeProps,
2303
2515
  declare interface IconProps_2 extends SvgProps, Partial<IconDefaultProps> {
2304
2516
  }
2305
2517
 
2518
+ /**
2519
+ * @public
2520
+ */
2521
+ export declare type InsightsPanelsExtension = <TComponentProps, THookProps>() => InsightsPanelsExtensionConfiguration<TComponentProps, THookProps>;
2522
+
2523
+ /**
2524
+ * @public
2525
+ */
2526
+ export declare interface InsightsPanelsExtensionConfiguration<TComponentProps, THookProps> {
2527
+ /**
2528
+ * Extension id
2529
+ */
2530
+ readonly id: string;
2531
+ /**
2532
+ * Component to display as a panel
2533
+ */
2534
+ readonly component: ComponentType<TComponentProps>;
2535
+ /**
2536
+ * Hook which returns information about the current panel for the extension
2537
+ */
2538
+ readonly usePanel: (props: THookProps) => InsightsPanelsExtensionHookResult;
2539
+ }
2540
+
2541
+ /**
2542
+ * @public
2543
+ */
2544
+ export declare interface InsightsPanelsExtensionHookResult {
2545
+ /**
2546
+ * Defines whether an insights panel extension is available to be displayed or not
2547
+ */
2548
+ readonly isAvailable: boolean;
2549
+ /**
2550
+ * Title of a panel to display
2551
+ */
2552
+ readonly title: string;
2553
+ /**
2554
+ * Icon to display as a part of a tab for a panel
2555
+ */
2556
+ readonly icon: ReactNode;
2557
+ }
2558
+
2306
2559
  /**
2307
2560
  * Checks whether the provided nodeId is the 'Favorites' node ID.
2308
2561
  *
@@ -2561,6 +2814,10 @@ export declare interface ItemsInProgressQueryProps {
2561
2814
  * Specifies the maximum number of results to return.
2562
2815
  */
2563
2816
  maxResults?: number;
2817
+ /**
2818
+ * Option to filter results by specified user id.
2819
+ */
2820
+ lockUserId?: ItemUri;
2564
2821
  }
2565
2822
 
2566
2823
  /**
@@ -2737,9 +2994,15 @@ declare class ListBuilder<TItem> {
2737
2994
  build: () => ReadonlyArray<ListBuilderConfigurationExtension<TItem>>;
2738
2995
  }
2739
2996
 
2740
- declare type ListBuilderConfiguration<TItem> = TItem[];
2997
+ /**
2998
+ * @internal
2999
+ */
3000
+ export declare type ListBuilderConfiguration<TItem> = TItem[];
2741
3001
 
2742
- declare type ListBuilderConfigurationExtension<TItem> = (currentList: ListBuilderConfiguration<TItem>, defaultList: ListBuilderConfiguration<TItem>) => void;
3002
+ /**
3003
+ * @internal
3004
+ */
3005
+ export declare type ListBuilderConfigurationExtension<TItem> = (currentList: ListBuilderConfiguration<TItem>, defaultList: ListBuilderConfiguration<TItem>) => void;
2743
3006
 
2744
3007
  /**
2745
3008
  * @public
@@ -3081,12 +3344,13 @@ export declare type NavigationItemId = ValuesOfArray<typeof navigationItemIds>;
3081
3344
  export declare const navigationItemId: {
3082
3345
  activitiesExplorer: "activitiesExplorer";
3083
3346
  contentExplorer: "contentExplorer";
3347
+ publishingQueueExplorer: "publishingQueueExplorer";
3084
3348
  };
3085
3349
 
3086
3350
  /**
3087
3351
  * @public
3088
3352
  */
3089
- export declare const navigationItemIds: readonly ["activitiesExplorer", "contentExplorer"];
3353
+ export declare const navigationItemIds: readonly ["activitiesExplorer", "contentExplorer", "publishingQueueExplorer"];
3090
3354
 
3091
3355
  /**
3092
3356
  * @public
@@ -3326,6 +3590,28 @@ export declare type OptionalKeywordEditorHook = () => KeywordEditorHookResult |
3326
3590
  */
3327
3591
  export declare type OptionalPageEditorHook = () => PageEditorHookResult | undefined;
3328
3592
 
3593
+ /**
3594
+ * Hook for accessing PublishingQueue Explorer data when available.
3595
+ *
3596
+ * @remarks
3597
+ * Safe to be used within or outside of the PublishingQueue Explorer.
3598
+ * `undefined` is returned when used outside of PublishingQueue Explorer.
3599
+ *
3600
+ * @public
3601
+ */
3602
+ export declare type OptionalPublishingQueueExplorerHook = () => PublishingQueueExplorerHookResult | undefined;
3603
+
3604
+ /**
3605
+ * Hook for accessing PublishingQueue Explorer Table data and methods when available.
3606
+ *
3607
+ * @remarks
3608
+ * Safe to be used within or outside of the PublishingQueue Explorer Table.
3609
+ * `undefined` is returned when used outside of the PublishingQueue Explorer Table.
3610
+ *
3611
+ * @public
3612
+ */
3613
+ export declare type OptionalPublishingQueueExplorerTableHook = () => PublishingQueueExplorerTableHookResult | undefined;
3614
+
3329
3615
  /**
3330
3616
  * Hook for accessing Structure Group Editor data when available.
3331
3617
  *
@@ -3408,8 +3694,68 @@ declare const palette: {
3408
3694
  yellow50: string;
3409
3695
  yellow100: string;
3410
3696
  yellow120: string;
3697
+ yellow140: string;
3411
3698
  };
3412
3699
 
3700
+ /**
3701
+ * @public
3702
+ */
3703
+ export declare type PropertiesGridComponent = FunctionComponent<PropertiesGridProps>;
3704
+
3705
+ /**
3706
+ * @public
3707
+ */
3708
+ export declare interface PropertiesGridProps {
3709
+ /**
3710
+ * Data to be rendered inside the grid
3711
+ */
3712
+ data: ReadonlyArray<PropertyItem>;
3713
+ /**
3714
+ * Space in pixels between grid rows
3715
+ */
3716
+ rowGap?: number;
3717
+ /**
3718
+ * Space in pixels between grid columns
3719
+ */
3720
+ columnGap?: number;
3721
+ }
3722
+
3723
+ /**
3724
+ * @public
3725
+ */
3726
+ export declare const PropertiesList: PropertiesListComponent;
3727
+
3728
+ /**
3729
+ * @public
3730
+ */
3731
+ export declare type PropertiesListComponent = FunctionComponent<PropertiesListProps>;
3732
+
3733
+ /**
3734
+ * @public
3735
+ */
3736
+ export declare interface PropertiesListProps {
3737
+ /**
3738
+ * List of properties to be displayed
3739
+ */
3740
+ properties: ReadonlyArray<PropertyRow>;
3741
+ }
3742
+
3743
+ /**
3744
+ * @public
3745
+ */
3746
+ export declare interface PropertyItem {
3747
+ label: ReactNode;
3748
+ value: ReactNode;
3749
+ }
3750
+
3751
+ /**
3752
+ * @public
3753
+ */
3754
+ export declare interface PropertyRow {
3755
+ label: ReactNode;
3756
+ value: ReactNode;
3757
+ }
3758
+
3413
3759
  /**
3414
3760
  * @public
3415
3761
  */
@@ -3445,6 +3791,289 @@ export declare interface PublishableTargetTypesQueryProps {
3445
3791
  businessProcessTypeId: ItemUri;
3446
3792
  }
3447
3793
 
3794
+ /**
3795
+ * @public
3796
+ */
3797
+ export declare type PublishingQueueExplorerActionGroupId = ValuesOfArray<typeof publishingQueueExplorerActionGroupIds>;
3798
+
3799
+ /**
3800
+ * All built-in action group IDs available in Publishing Queue Explorer.
3801
+ *
3802
+ * @public
3803
+ */
3804
+ export declare const publishingQueueExplorerActionGroupId: {
3805
+ exporting: "exporting";
3806
+ refreshing: "refreshing";
3807
+ publishing: "publishing";
3808
+ deleting: "deleting";
3809
+ };
3810
+
3811
+ /**
3812
+ * @public
3813
+ */
3814
+ export declare const publishingQueueExplorerActionGroupIds: readonly ["refreshing", "exporting", "publishing", "deleting"];
3815
+
3816
+ /**
3817
+ * @public
3818
+ */
3819
+ export declare type PublishingQueueExplorerActionId = ValuesOfArray<typeof publishingQueueExplorerActionIds>;
3820
+
3821
+ /**
3822
+ * All built-in action IDs available in Publishing Queue Explorer.
3823
+ *
3824
+ * @public
3825
+ */
3826
+ export declare const publishingQueueExplorerActionId: {
3827
+ export: "export";
3828
+ refresh: "refresh";
3829
+ delete: "delete";
3830
+ redo: "redo";
3831
+ };
3832
+
3833
+ /**
3834
+ * @public
3835
+ */
3836
+ export declare const publishingQueueExplorerActionIds: readonly ["refresh", "export", "delete", "redo"];
3837
+
3838
+ /**
3839
+ * @internal
3840
+ */
3841
+ export declare interface PublishingQueueExplorerApiStorage {
3842
+ hooks: PublishingQueueExplorerHooksApiStorage;
3843
+ }
3844
+
3845
+ /**
3846
+ * @public
3847
+ */
3848
+ export declare interface PublishingQueueExplorerExtensionInsightsPanelProps {
3849
+ transactionId: ItemUri;
3850
+ }
3851
+
3852
+ /**
3853
+ * @public
3854
+ */
3855
+ export declare interface PublishingQueueExplorerExtensions {
3856
+ actions: ReadonlyArray<ActionExtension>;
3857
+ table: PublishingQueueExplorerTableExtensions;
3858
+ insightsPanels: PublishingQueueExplorerInsightsPanelsExtensions;
3859
+ }
3860
+
3861
+ /**
3862
+ * @public
3863
+ */
3864
+ export declare class PublishingQueueExplorerExtensionsBuilder {
3865
+ private _actions;
3866
+ /**
3867
+ * Provides a mechanism for customizing Publishing Queue Explorer Table.
3868
+ */
3869
+ readonly table: PublishingQueueExplorerTableExtensionsBuilder;
3870
+ /**
3871
+ * Provides a mechanism for customizing Publishing Queue Explorer Insights Panels.
3872
+ */
3873
+ readonly insightsPanels: PublishingQueueExplorerInsightsPanelsExtensionsBuilder;
3874
+ /**
3875
+ * Adds a new action to Publishing Queue Explorer.
3876
+ *
3877
+ * @param action - action to be added
3878
+ */
3879
+ addAction: (action: ActionExtension) => this;
3880
+ build: () => PublishingQueueExplorerExtensions;
3881
+ }
3882
+
3883
+ /**
3884
+ * Hook for accessing PublishingQueue Explorer data.
3885
+ *
3886
+ * @remarks
3887
+ * Should be used only inside PublishingQueue Explorer, otherwise throws an error.
3888
+ *
3889
+ * @public
3890
+ */
3891
+ export declare type PublishingQueueExplorerHook = () => PublishingQueueExplorerHookResult;
3892
+
3893
+ /**
3894
+ * Data of the PublishingQueue Explorer.
3895
+ *
3896
+ * @public
3897
+ */
3898
+ export declare interface PublishingQueueExplorerHookResult {
3899
+ /**
3900
+ * List of Publish Transactions.
3901
+ */
3902
+ items: ReadonlyArray<PublishTransaction>;
3903
+ /**
3904
+ * The loading state of the Publish Transactions list.
3905
+ */
3906
+ itemsLoadingState: LoadingState;
3907
+ /**
3908
+ * Currently active PublishTransaction.
3909
+ */
3910
+ currentItem: PublishTransaction | undefined;
3911
+ }
3912
+
3913
+ /**
3914
+ * @internal
3915
+ */
3916
+ export declare interface PublishingQueueExplorerHooksApiStorage {
3917
+ usePublishingQueueExplorer: PublishingQueueExplorerHook;
3918
+ usePublishingQueueExplorerTable: PublishingQueueExplorerTableHook;
3919
+ useOptionalPublishingQueueExplorer: OptionalPublishingQueueExplorerHook;
3920
+ useOptionalPublishingQueueExplorerTable: OptionalPublishingQueueExplorerTableHook;
3921
+ }
3922
+
3923
+ /**
3924
+ * @public
3925
+ */
3926
+ export declare type PublishingQueueExplorerInsightsPanelsExtension = () => InsightsPanelsExtensionConfiguration<PublishingQueueExplorerExtensionInsightsPanelProps, PublishingQueueExplorerInsightsPanelsHookProps>;
3927
+
3928
+ /**
3929
+ * @public
3930
+ */
3931
+ export declare interface PublishingQueueExplorerInsightsPanelsExtensions {
3932
+ items: ReadonlyArray<PublishingQueueExplorerInsightsPanelsExtension>;
3933
+ config: ReadonlyArray<ListBuilderConfigurationExtension<string>>;
3934
+ }
3935
+
3936
+ /**
3937
+ * @public
3938
+ */
3939
+ export declare class PublishingQueueExplorerInsightsPanelsExtensionsBuilder {
3940
+ private _insightsPanelsExtensions;
3941
+ /**
3942
+ * Provides a mechanism for customizing the configuration of insights panels.
3943
+ */
3944
+ readonly config: ListBuilder<string>;
3945
+ /**
3946
+ * Registers a new insights panel.
3947
+ *
3948
+ * @remarks
3949
+ * This method only registers the insights panel and does not automatically make it visible in the application.
3950
+ * To add the insights panel to the application, use {@link PublishingQueueExplorerInsightsPanelsExtensionsBuilder.config}.
3951
+ *
3952
+ * @param item - insights panel to be registered
3953
+ */
3954
+ register: (item: PublishingQueueExplorerInsightsPanelsExtension) => this;
3955
+ build: () => PublishingQueueExplorerInsightsPanelsExtensions;
3956
+ }
3957
+
3958
+ /**
3959
+ * @public
3960
+ */
3961
+ export declare interface PublishingQueueExplorerInsightsPanelsHookProps {
3962
+ transactionId?: ItemUri;
3963
+ }
3964
+
3965
+ /**
3966
+ * Type represents ID of a built-in panel of the Publishing Queue Explorer.
3967
+ *
3968
+ * @public
3969
+ */
3970
+ export declare type PublishingQueueExplorerPanelId = ValuesOfArray<typeof publishingQueueExplorerPanelIds>;
3971
+
3972
+ /**
3973
+ * All available built-in Publishing Queue Explorer panel IDs.
3974
+ *
3975
+ * @public
3976
+ */
3977
+ export declare const publishingQueueExplorerPanelId: {
3978
+ information: "information";
3979
+ resolvedItems: "resolvedItems";
3980
+ };
3981
+
3982
+ /**
3983
+ * List of all built-in panel IDs of the Publishing Queue Explorer.
3984
+ *
3985
+ * @public
3986
+ */
3987
+ export declare const publishingQueueExplorerPanelIds: readonly ["information", "resolvedItems"];
3988
+
3989
+ /**
3990
+ * @public
3991
+ */
3992
+ export declare type PublishingQueueExplorerTableColumnExtension = TableColumnExtension<PublishTransaction>;
3993
+
3994
+ /**
3995
+ * @public
3996
+ */
3997
+ export declare interface PublishingQueueExplorerTableColumnExtensionComponentProps extends TableColumnExtensionComponentProps<PublishTransaction> {
3998
+ }
3999
+
4000
+ /**
4001
+ * @public
4002
+ */
4003
+ export declare interface PublishingQueueExplorerTableColumnExtensionConfiguration extends TableColumnExtensionConfiguration<PublishTransaction> {
4004
+ }
4005
+
4006
+ /**
4007
+ * @public
4008
+ */
4009
+ export declare type PublishingQueueExplorerTableColumnIsAvailableHook = TableColumnHook;
4010
+
4011
+ /**
4012
+ * @public
4013
+ */
4014
+ export declare interface PublishingQueueExplorerTableExtensions {
4015
+ columns: ReadonlyArray<PublishingQueueExplorerTableColumnExtension>;
4016
+ contextMenu: ReadonlyArray<ActionsConfigurationExtension>;
4017
+ toolbar: ReadonlyArray<ActionsConfigurationExtension>;
4018
+ }
4019
+
4020
+ /**
4021
+ * @public
4022
+ */
4023
+ export declare class PublishingQueueExplorerTableExtensionsBuilder {
4024
+ private _columns;
4025
+ /**
4026
+ * Provides a mechanism for customizing the configuration of actions
4027
+ * within Publishing Queue Explorer Table toolbar.
4028
+ */
4029
+ readonly toolbar: ActionsConfigurationExtensionsBuilder;
4030
+ /**
4031
+ * Provides a mechanism for customizing the configuration of actions
4032
+ * within Publishing Queue Explorer Table context menu.
4033
+ */
4034
+ readonly contextMenu: ActionsConfigurationExtensionsBuilder;
4035
+ /**
4036
+ * Adds a new column to Publishing Queue Explorer Table.
4037
+ *
4038
+ * @param column - column to be added
4039
+ */
4040
+ addColumn: (column: PublishingQueueExplorerTableColumnExtension) => this;
4041
+ build: () => PublishingQueueExplorerTableExtensions;
4042
+ }
4043
+
4044
+ /**
4045
+ * Hook for accessing PublishingQueue Explorer Table data and methods.
4046
+ *
4047
+ * @remarks
4048
+ * Should be used only inside PublishingQueue Explorer Table, otherwise throws an error.
4049
+ *
4050
+ * @public
4051
+ */
4052
+ export declare type PublishingQueueExplorerTableHook = () => PublishingQueueExplorerTableHookResult;
4053
+
4054
+ /**
4055
+ * Methods of the PublishingQueue Explorer Table.
4056
+ * @public
4057
+ */
4058
+ export declare interface PublishingQueueExplorerTableHookResult {
4059
+ /**
4060
+ * Refetch list of Publish Transactions.
4061
+ */
4062
+ refresh: () => void;
4063
+ /**
4064
+ * Current state of selected Publish Transactions in the Table.
4065
+ */
4066
+ selection: PublishingQueueExplorerTableSelection;
4067
+ }
4068
+
4069
+ /**
4070
+ * @public
4071
+ */
4072
+ export declare interface PublishingQueueExplorerTableSelection {
4073
+ ids: ReadonlySet<ItemUri>;
4074
+ selectedItems: ReadonlyArray<PublishTransaction>;
4075
+ }
4076
+
3448
4077
  /**
3449
4078
  * @public
3450
4079
  */
@@ -3506,6 +4135,45 @@ export declare interface PublishItemsRequest {
3506
4135
  publishInChildPublications?: ReadonlyArray<ItemUri>;
3507
4136
  }
3508
4137
 
4138
+ /**
4139
+ * @public
4140
+ */
4141
+ export declare type PublishTransactionsQueryHook = (props: PublishTransactionsQueryProps | undefined, options?: QueryOptions<ReadonlyArray<PublishTransaction> | undefined, ApiError>) => QueryResult<ReadonlyArray<PublishTransaction> | undefined, ApiError>;
4142
+
4143
+ /**
4144
+ * @public
4145
+ */
4146
+ export declare interface PublishTransactionsQueryProps {
4147
+ /**
4148
+ * Option to filter transactions for specific publication.
4149
+ */
4150
+ publicationId?: TcmUri;
4151
+ /**
4152
+ * Option to filter transactions for specific Target Type.
4153
+ */
4154
+ targetTypeId?: TcmUri;
4155
+ /**
4156
+ * Option to filter transaction created by specific User.
4157
+ */
4158
+ userId?: TcmUri;
4159
+ /**
4160
+ * Option to filter transactions prior to specified date.
4161
+ */
4162
+ endDate?: Date;
4163
+ /**
4164
+ * Option to filter transactions following specified date.
4165
+ */
4166
+ startDate?: Date;
4167
+ /**
4168
+ * Option to filter transactions based ot it's state.
4169
+ */
4170
+ state?: PublishTransactionState;
4171
+ /**
4172
+ * Option to filter transactions with specific priority.
4173
+ */
4174
+ priority?: PublishPriority;
4175
+ }
4176
+
3509
4177
  /**
3510
4178
  * @public
3511
4179
  */
@@ -4327,6 +4995,11 @@ export declare interface TableColumnHookResult {
4327
4995
  */
4328
4996
  export declare type Tag = keyof ReactHTML;
4329
4997
 
4998
+ /**
4999
+ * @public
5000
+ */
5001
+ export declare type TargetTypesQueryHook = (options?: QueryOptions<ReadonlyArray<TargetType> | undefined, ApiError>) => QueryResult<ReadonlyArray<TargetType> | undefined, ApiError>;
5002
+
4330
5003
  declare type TestName = string;
4331
5004
 
4332
5005
  declare interface TestsProps {
@@ -5107,6 +5780,28 @@ export declare const useOptionalKeywordEditor: OptionalKeywordEditorHook;
5107
5780
  */
5108
5781
  export declare const useOptionalPageEditor: OptionalPageEditorHook;
5109
5782
 
5783
+ /**
5784
+ * Provides access to PublishingQueue Explorer data and methods, if available.
5785
+ *
5786
+ * @remarks
5787
+ * Safe to be used within or outside of the PublishingQueue Explorer.
5788
+ * `undefined` is returned when used outside of PublishingQueue Explorer.
5789
+ *
5790
+ * @public
5791
+ */
5792
+ export declare const useOptionalPublishingQueueExplorer: OptionalPublishingQueueExplorerHook;
5793
+
5794
+ /**
5795
+ * Provides access to PublishingQueue Explorer Table data and methods, if available.
5796
+ *
5797
+ * @remarks
5798
+ * Safe to be used within or outside of the PublishingQueue Explorer Table.
5799
+ * `undefined` is returned when used outside of PublishingQueue Explorer Table.
5800
+ *
5801
+ * @public
5802
+ */
5803
+ export declare const useOptionalPublishingQueueExplorerTable: OptionalPublishingQueueExplorerTableHook;
5804
+
5110
5805
  /**
5111
5806
  * Provides access to Structure Group Editor data and methods, if available.
5112
5807
  * `undefined` is returned when used outside of Structure Group Editor.
@@ -5134,6 +5829,26 @@ export declare const usePublicationsQuery: PublicationsQueryHook;
5134
5829
  */
5135
5830
  export declare const usePublishableTargetTypesQuery: PublishableTargetTypesQueryHook;
5136
5831
 
5832
+ /**
5833
+ * Provides access to PublishingQueue Explorer data and methods.
5834
+ *
5835
+ * @remarks
5836
+ * Should be used only inside PublishingQueue Explorer, otherwise throws an error.
5837
+ *
5838
+ * @public
5839
+ */
5840
+ export declare const usePublishingQueueExplorer: PublishingQueueExplorerHook;
5841
+
5842
+ /**
5843
+ * Provides access to PublishingQueue Explorer Table data and methods.
5844
+ *
5845
+ * @remarks
5846
+ * Should be used only inside PublishingQueue Explorer Table, otherwise throws an error.
5847
+ *
5848
+ * @public
5849
+ */
5850
+ export declare const usePublishingQueueExplorerTable: PublishingQueueExplorerTableHook;
5851
+
5137
5852
  /**
5138
5853
  * Publishes a list of items with provided instructions.
5139
5854
  *