@tridion-sites/extensions 0.5.2 → 0.5.3

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/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @tridion-sites/extensions
2
2
 
3
+ ## 0.5.3
4
+
5
+ ### Patch Changes
6
+
7
+ - 6c90f9857b: add optional hooks
8
+ - 5b9c431d84: expose activities explorer hook
9
+ - 3a72874a67: Added moveAction method for Content Explorer actions
10
+ - ee268eb424: Exposed ref property to some of the Components
11
+ - a93bc99d21: More Text component props have been exposed
12
+ - Updated dependencies [be9284a536]
13
+ - @tridion-sites/models@0.1.3
14
+
3
15
  ## 0.5.2
4
16
 
5
17
  ### Patch Changes
package/dist/index.d.ts CHANGED
@@ -13,6 +13,7 @@ import type { ExternalMultimediaComponent } from '@tridion-sites/models';
13
13
  import type { FinishActivityResult } from '@tridion-sites/models';
14
14
  import type { FocusEvent as FocusEvent_2 } from 'react';
15
15
  import type { Folder } from '@tridion-sites/models';
16
+ import type { ForwardRefExoticComponent } from 'react';
16
17
  import type { FunctionComponent } from 'react';
17
18
  import type { IdentifiableObject } from '@tridion-sites/models';
18
19
  import type { ItemBlueprintHierarchy } from '@tridion-sites/models';
@@ -39,6 +40,7 @@ import type { RawEditorOptions } from 'tinymce';
39
40
  import { ReactElement } from 'react';
40
41
  import type { ReactHTML } from 'react';
41
42
  import { ReactNode } from 'react';
43
+ import type { RefAttributes } from 'react';
42
44
  import type { RepositoryLocalObject } from '@tridion-sites/models';
43
45
  import type { ResolvedItem } from '@tridion-sites/models';
44
46
  import type { RloItemType } from '@tridion-sites/models';
@@ -138,7 +140,7 @@ export declare class ActionsConfigurationExtensionsBuilder {
138
140
  * @param groupId - id of the group to be moved
139
141
  * @param beforeGroupId - id of the group before which the group will be moved
140
142
  */
141
- moveGroup: (groupId: string, beforeGroupId?: string) => void;
143
+ moveGroup: (groupId: string, beforeGroupId: string | undefined) => void;
142
144
  /**
143
145
  * Replaces a group in the group list.
144
146
  *
@@ -161,20 +163,25 @@ export declare class ActionsConfigurationExtensionsBuilder {
161
163
  */
162
164
  addAction: (groupId: string, actionId: string, beforeActionId?: string) => void;
163
165
  /**
164
- * Removes action from the group(s). If `groupId` is not provided removal is done for all the groups.
166
+ * Removes action from the group(s).
165
167
  *
166
168
  * @param actionId - id of the action to be removed
167
- * @param groupId - id of the group in which the removal will occur
168
169
  */
169
- removeAction: (actionId: string, groupId?: string) => void;
170
+ removeAction: (actionId: string) => void;
170
171
  /**
171
- * Replaces an action with a new action id in the group(s). If `groupId` is not provided replacement is done for all the groups.
172
+ * Replaces an action with a new action id in the group(s).
172
173
  *
173
174
  * @param actionId - id of the action to be replaced
174
175
  * @param newActionId - id of the new action
175
- * @param groupId - id of the group in which the replacement will occur
176
176
  */
177
- replaceAction: (actionId: string, newActionId: string, groupId?: string) => void;
177
+ replaceAction: (actionId: string, newActionId: string) => void;
178
+ /**
179
+ * Moves an action withing other actions in the same (or other) group(s).
180
+ *
181
+ * @param actionId - id of the action to be moved
182
+ * @param beforeActionId - id of the action before which the moved action will be inserted
183
+ */
184
+ moveAction: (actionId: string, beforeActionId: string | undefined) => void;
178
185
  build: () => ReadonlyArray<ListBuilderConfigurationExtension<ActionGroup>>;
179
186
  }
180
187
 
@@ -244,11 +251,27 @@ export declare class ActivitiesExplorerExtensionsBuilder {
244
251
  build: () => ActivitiesExplorerExtensions;
245
252
  }
246
253
 
254
+ /**
255
+ * @public
256
+ */
257
+ export declare type ActivitiesExplorerHook = () => ActivitiesExplorerHookResult;
258
+
259
+ /**
260
+ * @public
261
+ */
262
+ export declare interface ActivitiesExplorerHookResult {
263
+ items: ReadonlyArray<ActivityInstance>;
264
+ itemsLoadingState: LoadingState;
265
+ }
266
+
247
267
  /**
248
268
  * @internal
249
269
  */
250
270
  export declare interface ActivitiesExplorerHooksApiStorage {
271
+ useActivitiesExplorer: ActivitiesExplorerHook;
251
272
  useActivitiesExplorerTable: ActivitiesExplorerTableHook;
273
+ useOptionalActivitiesExplorer: OptionalActivitiesExplorerHook;
274
+ useOptionalActivitiesExplorerTable: OptionalActivitiesExplorerTableHook;
252
275
  }
253
276
 
254
277
  /**
@@ -296,7 +319,7 @@ export declare class ActivitiesExplorerTableExtensionsBuilder {
296
319
  /**
297
320
  * @public
298
321
  */
299
- export declare type ActivitiesExplorerTableHook = () => ActivitiesExplorerTableHookResult | undefined;
322
+ export declare type ActivitiesExplorerTableHook = () => ActivitiesExplorerTableHookResult;
300
323
 
301
324
  /**
302
325
  * @public
@@ -466,12 +489,12 @@ export declare const Block: BlockComponent;
466
489
  /**
467
490
  * @public
468
491
  */
469
- export declare type BlockComponent = FunctionComponent<BlockProps>;
492
+ export declare type BlockComponent = ForwardRefExoticComponent<BlockProps>;
470
493
 
471
494
  /**
472
495
  * @public
473
496
  */
474
- export declare interface BlockProps extends SpaceProps, SizeProps, ClickableProps, BackgroundColorProps, OpacityProps, TooltipProps, FocusBehaviorProps {
497
+ export declare interface BlockProps extends RefAttributes<HTMLElement>, SpaceProps, SizeProps, ClickableProps, BackgroundColorProps, OpacityProps, TooltipProps, FocusBehaviorProps {
475
498
  /**
476
499
  * Accessibility-related props.
477
500
  */
@@ -534,11 +557,6 @@ export declare interface BundleEditorApiStorage {
534
557
  hooks: BundleEditorHooksApiStorage;
535
558
  }
536
559
 
537
- /**
538
- * @public
539
- */
540
- export declare type BundleEditorHook = () => BundleEditorHookResult | undefined;
541
-
542
560
  /**
543
561
  * @public
544
562
  */
@@ -553,7 +571,7 @@ export declare interface BundleEditorHookResult {
553
571
  * @internal
554
572
  */
555
573
  export declare interface BundleEditorHooksApiStorage {
556
- useBundleEditor: BundleEditorHook;
574
+ useOptionalBundleEditor: OptionalBundleEditorHook;
557
575
  }
558
576
 
559
577
  /**
@@ -565,12 +583,12 @@ export declare const Button: ButtonComponent;
565
583
  /**
566
584
  * @public
567
585
  */
568
- export declare type ButtonComponent = FunctionComponent<ButtonProps>;
586
+ export declare type ButtonComponent = ForwardRefExoticComponent<ButtonProps>;
569
587
 
570
588
  /**
571
589
  * @public
572
590
  */
573
- export declare interface ButtonProps {
591
+ export declare interface ButtonProps extends RefAttributes<HTMLElement> {
574
592
  /**
575
593
  * Callback executed when the button is clicked.
576
594
  */
@@ -603,11 +621,6 @@ export declare interface CategoryEditorApiStorage {
603
621
  hooks: CategoryEditorHooksApiStorage;
604
622
  }
605
623
 
606
- /**
607
- * @public
608
- */
609
- export declare type CategoryEditorHook = () => CategoryEditorHookResult | undefined;
610
-
611
624
  /**
612
625
  * @public
613
626
  */
@@ -622,7 +635,7 @@ export declare interface CategoryEditorHookResult {
622
635
  * @internal
623
636
  */
624
637
  export declare interface CategoryEditorHooksApiStorage {
625
- useCategoryEditor: CategoryEditorHook;
638
+ useOptionalCategoryEditor: OptionalCategoryEditorHook;
626
639
  }
627
640
 
628
641
  /**
@@ -639,7 +652,7 @@ export declare const Center: CenterComponent;
639
652
  /**
640
653
  * @public
641
654
  */
642
- export declare type CenterComponent = FunctionComponent<CenterProps>;
655
+ export declare type CenterComponent = ForwardRefExoticComponent<CenterProps>;
643
656
 
644
657
  /**
645
658
  * @public
@@ -737,11 +750,6 @@ export declare interface ComponentEditorApiStorage {
737
750
  hooks: ComponentEditorHooksApiStorage;
738
751
  }
739
752
 
740
- /**
741
- * @public
742
- */
743
- export declare type ComponentEditorHook = () => ComponentEditorHookResult | undefined;
744
-
745
753
  /**
746
754
  * @public
747
755
  */
@@ -756,7 +764,7 @@ export declare interface ComponentEditorHookResult {
756
764
  * @internal
757
765
  */
758
766
  export declare interface ComponentEditorHooksApiStorage {
759
- useComponentEditor: ComponentEditorHook;
767
+ useOptionalComponentEditor: OptionalComponentEditorHook;
760
768
  }
761
769
 
762
770
  /**
@@ -1040,6 +1048,9 @@ export declare interface ContentExplorerHooksApiStorage {
1040
1048
  useContentExplorer: ContentExplorerHook;
1041
1049
  useContentExplorerTable: ContentExplorerTableHook;
1042
1050
  useContentExplorerTree: ContentExplorerTreeHook;
1051
+ useOptionalContentExplorer: OptionalContentExplorerHook;
1052
+ useOptionalContentExplorerTable: OptionalContentExplorerTableHook;
1053
+ useOptionalContentExplorerTree: OptionalContentExplorerTreeHook;
1043
1054
  }
1044
1055
 
1045
1056
  /**
@@ -1179,7 +1190,7 @@ export declare class ContentExplorerTableExtensionsBuilder {
1179
1190
  /**
1180
1191
  * @public
1181
1192
  */
1182
- export declare type ContentExplorerTableHook = () => ContentExplorerTableHookResult | undefined;
1193
+ export declare type ContentExplorerTableHook = () => ContentExplorerTableHookResult;
1183
1194
 
1184
1195
  /**
1185
1196
  * @public
@@ -1206,7 +1217,7 @@ export declare class ContentExplorerTreeExtensionsBuilder {
1206
1217
  /**
1207
1218
  * @public
1208
1219
  */
1209
- export declare type ContentExplorerTreeHook = () => ContentExplorerTreeHookResult | undefined;
1220
+ export declare type ContentExplorerTreeHook = () => ContentExplorerTreeHookResult;
1210
1221
 
1211
1222
  /**
1212
1223
  * @public
@@ -1338,7 +1349,7 @@ export declare interface DeleteItemsRequest {
1338
1349
  /**
1339
1350
  * @public
1340
1351
  */
1341
- export declare type EditorHook = () => EditorHookResult | undefined;
1352
+ export declare type EditorHook = () => EditorHookResult;
1342
1353
 
1343
1354
  /**
1344
1355
  * @public
@@ -1355,6 +1366,7 @@ export declare interface EditorHookResult {
1355
1366
  */
1356
1367
  export declare interface EditorHooksApiStorage {
1357
1368
  useEditor: EditorHook;
1369
+ useOptionalEditor: OptionalEditorHook;
1358
1370
  }
1359
1371
 
1360
1372
  /**
@@ -1406,7 +1418,7 @@ export declare class ExtensionBuilder {
1406
1418
  */
1407
1419
  export declare interface ExtensionGlobals {
1408
1420
  t: (key: string, options?: Record<string, any>) => string;
1409
- getConfiguration: () => Record<string, any> | undefined;
1421
+ getConfiguration: <T extends Record<string, any>>() => T | undefined;
1410
1422
  }
1411
1423
 
1412
1424
  /**
@@ -1520,7 +1532,7 @@ export declare const Flex: FlexComponent;
1520
1532
  /**
1521
1533
  * @public
1522
1534
  */
1523
- export declare type FlexComponent = FunctionComponent<FlexProps>;
1535
+ export declare type FlexComponent = ForwardRefExoticComponent<FlexProps>;
1524
1536
 
1525
1537
  /**
1526
1538
  * @public
@@ -1577,11 +1589,6 @@ export declare interface FolderEditorApiStorage {
1577
1589
  hooks: FolderEditorHooksApiStorage;
1578
1590
  }
1579
1591
 
1580
- /**
1581
- * @public
1582
- */
1583
- export declare type FolderEditorHook = () => FolderEditorHookResult | undefined;
1584
-
1585
1592
  /**
1586
1593
  * @public
1587
1594
  */
@@ -1596,7 +1603,7 @@ export declare interface FolderEditorHookResult {
1596
1603
  * @internal
1597
1604
  */
1598
1605
  export declare interface FolderEditorHooksApiStorage {
1599
- useFolderEditor: FolderEditorHook;
1606
+ useOptionalFolderEditor: OptionalFolderEditorHook;
1600
1607
  }
1601
1608
 
1602
1609
  /**
@@ -2130,11 +2137,6 @@ export declare interface KeywordEditorApiStorage {
2130
2137
  hooks: KeywordEditorHooksApiStorage;
2131
2138
  }
2132
2139
 
2133
- /**
2134
- * @public
2135
- */
2136
- export declare type KeywordEditorHook = () => KeywordEditorHookResult | undefined;
2137
-
2138
2140
  /**
2139
2141
  * @public
2140
2142
  */
@@ -2149,7 +2151,7 @@ export declare interface KeywordEditorHookResult {
2149
2151
  * @internal
2150
2152
  */
2151
2153
  export declare interface KeywordEditorHooksApiStorage {
2152
- useKeywordEditor: KeywordEditorHook;
2154
+ useOptionalKeywordEditor: OptionalKeywordEditorHook;
2153
2155
  }
2154
2156
 
2155
2157
  /**
@@ -2197,6 +2199,17 @@ declare type ListBuilderConfiguration<TItem> = TItem[];
2197
2199
 
2198
2200
  declare type ListBuilderConfigurationExtension<TItem> = (currentList: ListBuilderConfiguration<TItem>, defaultList: ListBuilderConfiguration<TItem>) => void;
2199
2201
 
2202
+ /**
2203
+ * @public
2204
+ */
2205
+ export declare interface LoadingState {
2206
+ isFirstTimeLoading: boolean;
2207
+ isLoading: boolean;
2208
+ isReloading: boolean;
2209
+ isLoaded: boolean;
2210
+ isError: boolean;
2211
+ }
2212
+
2200
2213
  /**
2201
2214
  * @public
2202
2215
  */
@@ -2441,16 +2454,76 @@ declare interface OpacityProps_2 {
2441
2454
  }
2442
2455
 
2443
2456
  /**
2444
- * @internal
2457
+ * @public
2445
2458
  */
2446
- export declare interface PageEditorApiStorage {
2447
- hooks: PageEditorHooksApiStorage;
2448
- }
2459
+ export declare type OptionalActivitiesExplorerHook = () => ActivitiesExplorerHookResult | undefined;
2449
2460
 
2450
2461
  /**
2451
2462
  * @public
2452
2463
  */
2453
- export declare type PageEditorHook = () => PageEditorHookResult | undefined;
2464
+ export declare type OptionalActivitiesExplorerTableHook = () => ActivitiesExplorerTableHookResult | undefined;
2465
+
2466
+ /**
2467
+ * @public
2468
+ */
2469
+ export declare type OptionalBundleEditorHook = () => BundleEditorHookResult | undefined;
2470
+
2471
+ /**
2472
+ * @public
2473
+ */
2474
+ export declare type OptionalCategoryEditorHook = () => CategoryEditorHookResult | undefined;
2475
+
2476
+ /**
2477
+ * @public
2478
+ */
2479
+ export declare type OptionalComponentEditorHook = () => ComponentEditorHookResult | undefined;
2480
+
2481
+ /**
2482
+ * @public
2483
+ */
2484
+ export declare type OptionalContentExplorerHook = () => ContentExplorerHookResult | undefined;
2485
+
2486
+ /**
2487
+ * @public
2488
+ */
2489
+ export declare type OptionalContentExplorerTableHook = () => ContentExplorerTableHookResult | undefined;
2490
+
2491
+ /**
2492
+ * @public
2493
+ */
2494
+ export declare type OptionalContentExplorerTreeHook = () => ContentExplorerTreeHookResult | undefined;
2495
+
2496
+ /**
2497
+ * @public
2498
+ */
2499
+ export declare type OptionalEditorHook = () => EditorHookResult | undefined;
2500
+
2501
+ /**
2502
+ * @public
2503
+ */
2504
+ export declare type OptionalFolderEditorHook = () => FolderEditorHookResult | undefined;
2505
+
2506
+ /**
2507
+ * @public
2508
+ */
2509
+ export declare type OptionalKeywordEditorHook = () => KeywordEditorHookResult | undefined;
2510
+
2511
+ /**
2512
+ * @public
2513
+ */
2514
+ export declare type OptionalPageEditorHook = () => PageEditorHookResult | undefined;
2515
+
2516
+ /**
2517
+ * @public
2518
+ */
2519
+ export declare type OptionalStructureGroupEditorHook = () => StructureGroupEditorHookResult | undefined;
2520
+
2521
+ /**
2522
+ * @internal
2523
+ */
2524
+ export declare interface PageEditorApiStorage {
2525
+ hooks: PageEditorHooksApiStorage;
2526
+ }
2454
2527
 
2455
2528
  /**
2456
2529
  * @public
@@ -2468,7 +2541,7 @@ export declare interface PageEditorHookResult {
2468
2541
  * @internal
2469
2542
  */
2470
2543
  export declare interface PageEditorHooksApiStorage {
2471
- usePageEditor: PageEditorHook;
2544
+ useOptionalPageEditor: OptionalPageEditorHook;
2472
2545
  }
2473
2546
 
2474
2547
  declare const palette: {
@@ -2941,7 +3014,7 @@ export declare type StackAlignment = 'start' | 'center' | 'end' | 'stretch' | 'b
2941
3014
  /**
2942
3015
  * @public
2943
3016
  */
2944
- export declare type StackComponent = FunctionComponent<StackProps>;
3017
+ export declare type StackComponent = ForwardRefExoticComponent<StackProps>;
2945
3018
 
2946
3019
  /**
2947
3020
  * @public
@@ -3017,11 +3090,6 @@ export declare interface StructureGroupEditorApiStorage {
3017
3090
  hooks: StructureGroupEditorHooksApiStorage;
3018
3091
  }
3019
3092
 
3020
- /**
3021
- * @public
3022
- */
3023
- export declare type StructureGroupEditorHook = () => StructureGroupEditorHookResult | undefined;
3024
-
3025
3093
  /**
3026
3094
  * @public
3027
3095
  */
@@ -3036,7 +3104,7 @@ export declare interface StructureGroupEditorHookResult {
3036
3104
  * @internal
3037
3105
  */
3038
3106
  export declare interface StructureGroupEditorHooksApiStorage {
3039
- useStructureGroupEditor: StructureGroupEditorHook;
3107
+ useOptionalStructureGroupEditor: OptionalStructureGroupEditorHook;
3040
3108
  }
3041
3109
 
3042
3110
  declare interface SvgProps extends TestsProps, TooltipProps_2, SpaceProps_2, SizeProps_2, ColorProps_2, OpacityProps_2 {
@@ -3190,17 +3258,18 @@ export declare interface TextLinkProps extends TextProps, LinkProps {
3190
3258
  /**
3191
3259
  * @public
3192
3260
  */
3193
- export declare interface TextProps {
3194
- tag?: TextTag;
3261
+ export declare interface TextProps extends ColorProps, TooltipProps {
3195
3262
  alignment?: TextAlignment;
3196
- children?: ReactNode;
3197
- notSelectable?: boolean;
3198
- uppercase?: boolean;
3199
- underline?: boolean;
3200
- multiLine?: boolean;
3201
3263
  breakWord?: boolean;
3264
+ children?: ReactNode;
3202
3265
  compact?: boolean;
3203
3266
  direction?: TextDirection;
3267
+ multiLine?: boolean;
3268
+ notSelectable?: boolean;
3269
+ tag?: TextTag;
3270
+ type?: TextType;
3271
+ underline?: boolean;
3272
+ uppercase?: boolean;
3204
3273
  }
3205
3274
 
3206
3275
  /**
@@ -3208,6 +3277,11 @@ export declare interface TextProps {
3208
3277
  */
3209
3278
  export declare type TextTag = 'div' | 'span' | 'h1' | 'h2' | 'h3';
3210
3279
 
3280
+ /**
3281
+ * @public
3282
+ */
3283
+ export declare type TextType = 'heading1' | 'heading2' | 'heading3' | 'default' | 'defaultBold' | 'small' | 'smallBold';
3284
+
3211
3285
  /**
3212
3286
  * @public
3213
3287
  */
@@ -3384,6 +3458,11 @@ export declare interface UploadMultimediaRequest {
3384
3458
  schemaId?: ItemUri;
3385
3459
  }
3386
3460
 
3461
+ /**
3462
+ * @public
3463
+ */
3464
+ export declare const useActivitiesExplorer: ActivitiesExplorerHook;
3465
+
3387
3466
  /**
3388
3467
  * @public
3389
3468
  */
@@ -3419,16 +3498,6 @@ export declare const useAutoClassifyItemMutation: AutoClassifyItemMutationHook;
3419
3498
  */
3420
3499
  export declare const useAutoClassifyItemsMutation: AutoClassifyItemsMutationHook;
3421
3500
 
3422
- /**
3423
- * @public
3424
- */
3425
- export declare const useBundleEditor: BundleEditorHook;
3426
-
3427
- /**
3428
- * @public
3429
- */
3430
- export declare const useCategoryEditor: CategoryEditorHook;
3431
-
3432
3501
  /**
3433
3502
  * @public
3434
3503
  */
@@ -3439,11 +3508,6 @@ export declare const useChangeUserLanguageMutation: ChangeUserLanguageMutationHo
3439
3508
  */
3440
3509
  export declare const useChangeUserLocaleMutation: ChangeUserLocaleMutationHook;
3441
3510
 
3442
- /**
3443
- * @public
3444
- */
3445
- export declare const useComponentEditor: ComponentEditorHook;
3446
-
3447
3511
  /**
3448
3512
  * @public
3449
3513
  */
@@ -3524,11 +3588,6 @@ export declare const useFinishEditingItemMutation: FinishEditingItemMutationHook
3524
3588
  */
3525
3589
  export declare const useFinishEditingItemsMutation: FinishEditingItemsMutationHook;
3526
3590
 
3527
- /**
3528
- * @public
3529
- */
3530
- export declare const useFolderEditor: FolderEditorHook;
3531
-
3532
3591
  /**
3533
3592
  * @public
3534
3593
  */
@@ -3609,11 +3668,6 @@ export declare const useItemUsedByQuery: ItemUsedByQueryHook;
3609
3668
  */
3610
3669
  export declare const useItemUsesQuery: ItemUsesQueryHook;
3611
3670
 
3612
- /**
3613
- * @public
3614
- */
3615
- export declare const useKeywordEditor: KeywordEditorHook;
3616
-
3617
3671
  /**
3618
3672
  * @public
3619
3673
  */
@@ -3642,7 +3696,67 @@ export declare const useNotifications: NotificationsHook;
3642
3696
  /**
3643
3697
  * @public
3644
3698
  */
3645
- export declare const usePageEditor: PageEditorHook;
3699
+ export declare const useOptionalActivitiesExplorer: OptionalActivitiesExplorerHook;
3700
+
3701
+ /**
3702
+ * @public
3703
+ */
3704
+ export declare const useOptionalActivitiesExplorerTable: OptionalActivitiesExplorerTableHook;
3705
+
3706
+ /**
3707
+ * @public
3708
+ */
3709
+ export declare const useOptionalBundleEditor: OptionalBundleEditorHook;
3710
+
3711
+ /**
3712
+ * @public
3713
+ */
3714
+ export declare const useOptionalCategoryEditor: OptionalCategoryEditorHook;
3715
+
3716
+ /**
3717
+ * @public
3718
+ */
3719
+ export declare const useOptionalComponentEditor: OptionalComponentEditorHook;
3720
+
3721
+ /**
3722
+ * @public
3723
+ */
3724
+ export declare const useOptionalContentExplorer: OptionalContentExplorerHook;
3725
+
3726
+ /**
3727
+ * @public
3728
+ */
3729
+ export declare const useOptionalContentExplorerTable: OptionalContentExplorerTableHook;
3730
+
3731
+ /**
3732
+ * @public
3733
+ */
3734
+ export declare const useOptionalContentExplorerTree: OptionalContentExplorerTreeHook;
3735
+
3736
+ /**
3737
+ * @public
3738
+ */
3739
+ export declare const useOptionalEditor: OptionalEditorHook;
3740
+
3741
+ /**
3742
+ * @public
3743
+ */
3744
+ export declare const useOptionalFolderEditor: OptionalFolderEditorHook;
3745
+
3746
+ /**
3747
+ * @public
3748
+ */
3749
+ export declare const useOptionalKeywordEditor: OptionalKeywordEditorHook;
3750
+
3751
+ /**
3752
+ * @public
3753
+ */
3754
+ export declare const useOptionalPageEditor: OptionalPageEditorHook;
3755
+
3756
+ /**
3757
+ * @public
3758
+ */
3759
+ export declare const useOptionalStructureGroupEditor: OptionalStructureGroupEditorHook;
3646
3760
 
3647
3761
  /**
3648
3762
  * @public
@@ -3771,11 +3885,6 @@ export declare const useStartActivityMutation: StartActivityMutationHook;
3771
3885
  */
3772
3886
  export declare const useStartWorkflowMutation: StartWorkflowMutationHook;
3773
3887
 
3774
- /**
3775
- * @public
3776
- */
3777
- export declare const useStructureGroupEditor: StructureGroupEditorHook;
3778
-
3779
3888
  /**
3780
3889
  * @public
3781
3890
  */
package/dist/index.js CHANGED
@@ -293,20 +293,17 @@ class ActionsConfigurationExtensionsBuilder {
293
293
  }
294
294
  });
295
295
  /**
296
- * Removes action from the group(s). If `groupId` is not provided removal is done for all the groups.
296
+ * Removes action from the group(s).
297
297
  *
298
298
  * @param actionId - id of the action to be removed
299
- * @param groupId - id of the group in which the removal will occur
300
299
  */
301
300
  Object.defineProperty(this, "removeAction", {
302
301
  enumerable: true,
303
302
  configurable: true,
304
303
  writable: true,
305
- value: (actionId, groupId) => {
304
+ value: (actionId) => {
306
305
  this._groupListBuilder.customize(configuration => {
307
306
  configuration.forEach(group => {
308
- if (groupId && group.id !== groupId)
309
- return;
310
307
  removeItem({
311
308
  getItemId: item => item,
312
309
  itemId: actionId,
@@ -317,21 +314,18 @@ class ActionsConfigurationExtensionsBuilder {
317
314
  }
318
315
  });
319
316
  /**
320
- * Replaces an action with a new action id in the group(s). If `groupId` is not provided replacement is done for all the groups.
317
+ * Replaces an action with a new action id in the group(s).
321
318
  *
322
319
  * @param actionId - id of the action to be replaced
323
320
  * @param newActionId - id of the new action
324
- * @param groupId - id of the group in which the replacement will occur
325
321
  */
326
322
  Object.defineProperty(this, "replaceAction", {
327
323
  enumerable: true,
328
324
  configurable: true,
329
325
  writable: true,
330
- value: (actionId, newActionId, groupId) => {
326
+ value: (actionId, newActionId) => {
331
327
  this._groupListBuilder.customize(configuration => {
332
328
  configuration.forEach(group => {
333
- if (groupId && group.id !== groupId)
334
- return;
335
329
  replaceItem({
336
330
  getItemId: item => item,
337
331
  itemId: actionId,
@@ -342,6 +336,34 @@ class ActionsConfigurationExtensionsBuilder {
342
336
  });
343
337
  }
344
338
  });
339
+ /**
340
+ * Moves an action withing other actions in the same (or other) group(s).
341
+ *
342
+ * @param actionId - id of the action to be moved
343
+ * @param beforeActionId - id of the action before which the moved action will be inserted
344
+ */
345
+ Object.defineProperty(this, "moveAction", {
346
+ enumerable: true,
347
+ configurable: true,
348
+ writable: true,
349
+ value: (actionId, beforeActionId) => {
350
+ this._groupListBuilder.customize(configuration => {
351
+ configuration.forEach(group => {
352
+ removeItem({
353
+ getItemId: item => item,
354
+ itemId: actionId,
355
+ list: group.actionIds,
356
+ });
357
+ addItem({
358
+ list: group.actionIds,
359
+ getItemId: item => item,
360
+ newItem: actionId,
361
+ beforeItemId: beforeActionId,
362
+ });
363
+ });
364
+ });
365
+ }
366
+ });
345
367
  Object.defineProperty(this, "build", {
346
368
  enumerable: true,
347
369
  configurable: true,
@@ -918,6 +940,20 @@ const extensionApiBridge = {
918
940
  get: () => implementationStorage,
919
941
  };
920
942
 
943
+ /**
944
+ * @public
945
+ */
946
+ const useActivitiesExplorer = () => {
947
+ const useActivitiesExplorer = extensionApiBridge.get().activitiesExplorer.hooks.useActivitiesExplorer;
948
+ return useActivitiesExplorer();
949
+ };
950
+ /**
951
+ * @public
952
+ */
953
+ const useOptionalActivitiesExplorer = () => {
954
+ const useOptionalActivitiesExplorer = extensionApiBridge.get().activitiesExplorer.hooks.useOptionalActivitiesExplorer;
955
+ return useOptionalActivitiesExplorer();
956
+ };
921
957
  /**
922
958
  * @public
923
959
  */
@@ -925,6 +961,13 @@ const useActivitiesExplorerTable = () => {
925
961
  const useActivitiesExplorerTable = extensionApiBridge.get().activitiesExplorer.hooks.useActivitiesExplorerTable;
926
962
  return useActivitiesExplorerTable();
927
963
  };
964
+ /**
965
+ * @public
966
+ */
967
+ const useOptionalActivitiesExplorerTable = () => {
968
+ const useOptionalActivitiesExplorerTable = extensionApiBridge.get().activitiesExplorer.hooks.useOptionalActivitiesExplorerTable;
969
+ return useOptionalActivitiesExplorerTable();
970
+ };
928
971
 
929
972
  /**
930
973
  * @public
@@ -933,6 +976,13 @@ const useContentExplorer = () => {
933
976
  const useContentExplorer = extensionApiBridge.get().contentExplorer.hooks.useContentExplorer;
934
977
  return useContentExplorer();
935
978
  };
979
+ /**
980
+ * @public
981
+ */
982
+ const useOptionalContentExplorer = () => {
983
+ const useOptionalContentExplorer = extensionApiBridge.get().contentExplorer.hooks.useOptionalContentExplorer;
984
+ return useOptionalContentExplorer();
985
+ };
936
986
  /**
937
987
  * @public
938
988
  */
@@ -940,6 +990,13 @@ const useContentExplorerTable = () => {
940
990
  const useContentExplorerTable = extensionApiBridge.get().contentExplorer.hooks.useContentExplorerTable;
941
991
  return useContentExplorerTable();
942
992
  };
993
+ /**
994
+ * @public
995
+ */
996
+ const useOptionalContentExplorerTable = () => {
997
+ const useOptionalContentExplorerTable = extensionApiBridge.get().contentExplorer.hooks.useOptionalContentExplorerTable;
998
+ return useOptionalContentExplorerTable();
999
+ };
943
1000
  /**
944
1001
  * @public
945
1002
  */
@@ -947,6 +1004,13 @@ const useContentExplorerTree = () => {
947
1004
  const useContentExplorerTree = extensionApiBridge.get().contentExplorer.hooks.useContentExplorerTree;
948
1005
  return useContentExplorerTree();
949
1006
  };
1007
+ /**
1008
+ * @public
1009
+ */
1010
+ const useOptionalContentExplorerTree = () => {
1011
+ const useOptionalContentExplorerTree = extensionApiBridge.get().contentExplorer.hooks.useOptionalContentExplorerTree;
1012
+ return useOptionalContentExplorerTree();
1013
+ };
950
1014
 
951
1015
  /**
952
1016
  * @public
@@ -999,51 +1063,58 @@ const useEditor = () => {
999
1063
  /**
1000
1064
  * @public
1001
1065
  */
1002
- const useBundleEditor = () => {
1003
- const useBundleEditor = extensionApiBridge.get().editors.bundleEditor.hooks.useBundleEditor;
1004
- return useBundleEditor();
1066
+ const useOptionalEditor = () => {
1067
+ const useOptionalEditor = extensionApiBridge.get().editors.hooks.useOptionalEditor;
1068
+ return useOptionalEditor();
1069
+ };
1070
+ /**
1071
+ * @public
1072
+ */
1073
+ const useOptionalBundleEditor = () => {
1074
+ const useOptionalBundleEditor = extensionApiBridge.get().editors.bundleEditor.hooks.useOptionalBundleEditor;
1075
+ return useOptionalBundleEditor();
1005
1076
  };
1006
1077
  /**
1007
1078
  * @public
1008
1079
  */
1009
- const useComponentEditor = () => {
1010
- const useComponentEditor = extensionApiBridge.get().editors.componentEditor.hooks.useComponentEditor;
1011
- return useComponentEditor();
1080
+ const useOptionalComponentEditor = () => {
1081
+ const useOptionalComponentEditor = extensionApiBridge.get().editors.componentEditor.hooks.useOptionalComponentEditor;
1082
+ return useOptionalComponentEditor();
1012
1083
  };
1013
1084
  /**
1014
1085
  * @public
1015
1086
  */
1016
- const useCategoryEditor = () => {
1017
- const useCategoryEditor = extensionApiBridge.get().editors.categoryEditor.hooks.useCategoryEditor;
1018
- return useCategoryEditor();
1087
+ const useOptionalCategoryEditor = () => {
1088
+ const useOptionalCategoryEditor = extensionApiBridge.get().editors.categoryEditor.hooks.useOptionalCategoryEditor;
1089
+ return useOptionalCategoryEditor();
1019
1090
  };
1020
1091
  /**
1021
1092
  * @public
1022
1093
  */
1023
- const useFolderEditor = () => {
1024
- const useFolderEditor = extensionApiBridge.get().editors.folderEditor.hooks.useFolderEditor;
1025
- return useFolderEditor();
1094
+ const useOptionalFolderEditor = () => {
1095
+ const useOptionalFolderEditor = extensionApiBridge.get().editors.folderEditor.hooks.useOptionalFolderEditor;
1096
+ return useOptionalFolderEditor();
1026
1097
  };
1027
1098
  /**
1028
1099
  * @public
1029
1100
  */
1030
- const useKeywordEditor = () => {
1031
- const useKeywordEditor = extensionApiBridge.get().editors.keywordEditor.hooks.useKeywordEditor;
1032
- return useKeywordEditor();
1101
+ const useOptionalKeywordEditor = () => {
1102
+ const useOptionalKeywordEditor = extensionApiBridge.get().editors.keywordEditor.hooks.useOptionalKeywordEditor;
1103
+ return useOptionalKeywordEditor();
1033
1104
  };
1034
1105
  /**
1035
1106
  * @public
1036
1107
  */
1037
- const usePageEditor = () => {
1038
- const usePageEditor = extensionApiBridge.get().editors.pageEditor.hooks.usePageEditor;
1039
- return usePageEditor();
1108
+ const useOptionalPageEditor = () => {
1109
+ const useOptionalPageEditor = extensionApiBridge.get().editors.pageEditor.hooks.useOptionalPageEditor;
1110
+ return useOptionalPageEditor();
1040
1111
  };
1041
1112
  /**
1042
1113
  * @public
1043
1114
  */
1044
- const useStructureGroupEditor = () => {
1045
- const useStructureGroupEditor = extensionApiBridge.get().editors.structureGroupEditor.hooks.useStructureGroupEditor;
1046
- return useStructureGroupEditor();
1115
+ const useOptionalStructureGroupEditor = () => {
1116
+ const useOptionalStructureGroupEditor = extensionApiBridge.get().editors.structureGroupEditor.hooks.useOptionalStructureGroupEditor;
1117
+ return useOptionalStructureGroupEditor();
1047
1118
  };
1048
1119
 
1049
1120
  /**
@@ -1658,7 +1729,7 @@ const createExtensionGlobals = () => {
1658
1729
  };
1659
1730
  };
1660
1731
 
1661
- const version = "0.5.2";
1732
+ const version = "0.5.3";
1662
1733
  const peerDependencies = {
1663
1734
  "@tridion-sites/models": "workspace:*",
1664
1735
  "@tridion-sites/open-api-client": "workspace:*",
@@ -1677,4 +1748,4 @@ const frameworkInfo = {
1677
1748
  peerDependencies,
1678
1749
  };
1679
1750
 
1680
- 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, useActivitiesExplorerTable, useActivityInstancesQuery, useAddToBundleMutation, useAssignActivitiesMutation, useAssignActivityMutation, useAutoClassifyItemMutation, useAutoClassifyItemsMutation, useBundleEditor, useCategoryEditor, useChangeUserLanguageMutation, useChangeUserLocaleMutation, useComponentEditor, useConfirmation, useContentExplorer, useContentExplorerTable, useContentExplorerTree, useCopyItemMutation, useCopyItemsMutation, useCreateTranslationJobMutation, useDefaultTranslationJobQuery, useDeleteItemMutation, useDeleteItemsMutation, useEditor, useFavoritesQuery, useFinishActivitiesMutation, useFinishActivityMutation, useFinishEditingItemMutation, useFinishEditingItemsMutation, useFolderEditor, useItemBlueprintHierarchyQuery, useItemChildrenQuery, useItemClassifiedItemsQuery, useItemDefaultDataQuery, useItemHistoryQuery, useItemPublishUrlsQuery, useItemPublishedPagesQuery, useItemPublishedToQuery, useItemQuery, useItemTranslationInfoQuery, useItemUsedByQuery, useItemUsesQuery, useItemsInProgressQuery, useItemsQuery, useItemsToPublishQuery, useItemsToUnpublishQuery, useKeywordEditor, useLocalizeItemMutation, useLocalizeItemsMutation, useMoveItemMutation, useMoveItemsMutation, useNotifications, usePageEditor, usePublicationBlueprintHierarchyQuery, usePublicationsQuery, usePublishItemsMutation, usePublishableTargetTypesQuery, useRemoveFromBundleMutation, useRestartActivitiesMutation, useRestartActivityMutation, useRevertItemMutation, useRevertItemsMutation, useRollbackItemMutation, useSearchInContainerQuery, useStartActivitiesMutation, useStartActivityMutation, useStartWorkflowMutation, useStructureGroupEditor, useSystemSearchQuery, useUnlocalizeItemMutation, useUnlocalizeItemsMutation, useUnpublishItemsMutation, useUpdateItemMutation, useUploadMultimediaMutation, useUserGroupsQuery, useUserProfile, useUserProfileQuery, useUsersQuery };
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 };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tridion-sites/extensions",
3
- "version": "0.5.2",
3
+ "version": "0.5.3",
4
4
  "description": "Tridion Sites Extensions API",
5
5
  "author": "RWS",
6
6
  "homepage": "https://www.rws.com",
@@ -29,7 +29,7 @@
29
29
  "prepublish": "yarn build"
30
30
  },
31
31
  "peerDependencies": {
32
- "@tridion-sites/models": "0.1.2",
32
+ "@tridion-sites/models": "0.1.3",
33
33
  "@tridion-sites/open-api-client": "1.0.5",
34
34
  "react": "18.2.0",
35
35
  "react-dom": "18.2.0",
@@ -42,7 +42,7 @@
42
42
  "@rollup/plugin-json": "6.0.0",
43
43
  "@rollup/plugin-node-resolve": "15.0.1",
44
44
  "@rollup/plugin-typescript": "11.0.0",
45
- "@tridion-sites/models": "0.1.2",
45
+ "@tridion-sites/models": "0.1.3",
46
46
  "@tridion-sites/open-api-client": "1.0.5",
47
47
  "@tridion/graphene": "1.33.0",
48
48
  "@types/react": "18.0.31",