@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/CHANGELOG.md +28 -0
- package/README.md +95 -93
- package/dist/index.d.ts +2060 -77
- package/dist/index.js +755 -10
- package/package.json +16 -16
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';
|
|
@@ -73,9 +76,21 @@ export declare type ActionExtension = () => ActionExtensionConfiguration;
|
|
|
73
76
|
* @public
|
|
74
77
|
*/
|
|
75
78
|
export declare interface ActionExtensionConfiguration {
|
|
79
|
+
/**
|
|
80
|
+
* A unique identifier for the action.
|
|
81
|
+
*/
|
|
76
82
|
readonly id: string;
|
|
83
|
+
/**
|
|
84
|
+
* Label associated with the action.
|
|
85
|
+
*/
|
|
77
86
|
readonly label: string;
|
|
87
|
+
/**
|
|
88
|
+
* Icon associated with the action.
|
|
89
|
+
*/
|
|
78
90
|
readonly icon: CustomIcon;
|
|
91
|
+
/**
|
|
92
|
+
* Hook that contains behavior of the action.
|
|
93
|
+
*/
|
|
79
94
|
readonly useAction: ActionHook;
|
|
80
95
|
}
|
|
81
96
|
|
|
@@ -83,8 +98,20 @@ export declare interface ActionExtensionConfiguration {
|
|
|
83
98
|
* @public
|
|
84
99
|
*/
|
|
85
100
|
export declare interface ActionGroup {
|
|
101
|
+
/**
|
|
102
|
+
* A unique identifier for the action group.
|
|
103
|
+
*/
|
|
86
104
|
readonly id: string;
|
|
105
|
+
/**
|
|
106
|
+
* Label associated with the action group.
|
|
107
|
+
*
|
|
108
|
+
* @remarks
|
|
109
|
+
* It can be used to provide insight into why specific actions are grouped together.
|
|
110
|
+
*/
|
|
87
111
|
readonly label: string;
|
|
112
|
+
/**
|
|
113
|
+
* An ordered array of action IDs that are included in the group.
|
|
114
|
+
*/
|
|
88
115
|
readonly actionIds: readonly string[];
|
|
89
116
|
}
|
|
90
117
|
|
|
@@ -97,7 +124,13 @@ export declare type ActionHook = () => ActionHookResult;
|
|
|
97
124
|
* @public
|
|
98
125
|
*/
|
|
99
126
|
export declare interface ActionHookResult {
|
|
127
|
+
/**
|
|
128
|
+
* Indicates the availability of the action.
|
|
129
|
+
*/
|
|
100
130
|
readonly isAvailable: boolean;
|
|
131
|
+
/**
|
|
132
|
+
* A callback function that is executed when the action is triggered.
|
|
133
|
+
*/
|
|
101
134
|
readonly execute: () => void;
|
|
102
135
|
}
|
|
103
136
|
|
|
@@ -186,6 +219,8 @@ export declare class ActionsConfigurationExtensionsBuilder {
|
|
|
186
219
|
export declare type ActivitiesExplorerActionGroupId = ValuesOfArray<typeof activitiesExplorerActionGroupIds>;
|
|
187
220
|
|
|
188
221
|
/**
|
|
222
|
+
* All built-in action group IDs available in Activities Explorer.
|
|
223
|
+
*
|
|
189
224
|
* @public
|
|
190
225
|
*/
|
|
191
226
|
export declare const activitiesExplorerActionGroupId: {
|
|
@@ -205,6 +240,8 @@ export declare const activitiesExplorerActionGroupIds: readonly ["exporting", "r
|
|
|
205
240
|
export declare type ActivitiesExplorerActionId = ValuesOfArray<typeof activitiesExplorerActionIds>;
|
|
206
241
|
|
|
207
242
|
/**
|
|
243
|
+
* All built-in action IDs available in Activities Explorer.
|
|
244
|
+
*
|
|
208
245
|
* @public
|
|
209
246
|
*/
|
|
210
247
|
export declare const activitiesExplorerActionId: {
|
|
@@ -228,12 +265,20 @@ export declare interface ActivitiesExplorerApiStorage {
|
|
|
228
265
|
hooks: ActivitiesExplorerHooksApiStorage;
|
|
229
266
|
}
|
|
230
267
|
|
|
268
|
+
/**
|
|
269
|
+
* @public
|
|
270
|
+
*/
|
|
271
|
+
export declare interface ActivitiesExplorerExtensionInsightsPanelProps {
|
|
272
|
+
activityId: ItemUri;
|
|
273
|
+
}
|
|
274
|
+
|
|
231
275
|
/**
|
|
232
276
|
* @public
|
|
233
277
|
*/
|
|
234
278
|
export declare interface ActivitiesExplorerExtensions {
|
|
235
279
|
actions: ReadonlyArray<ActionExtension>;
|
|
236
280
|
table: ActivitiesExplorerTableExtensions;
|
|
281
|
+
insightsPanels: ActivitiesExplorerInsightsPanelsExtensions;
|
|
237
282
|
}
|
|
238
283
|
|
|
239
284
|
/**
|
|
@@ -241,22 +286,51 @@ export declare interface ActivitiesExplorerExtensions {
|
|
|
241
286
|
*/
|
|
242
287
|
export declare class ActivitiesExplorerExtensionsBuilder {
|
|
243
288
|
private _actions;
|
|
289
|
+
/**
|
|
290
|
+
* Provides a mechanism for customizing Activities Explorer Table.
|
|
291
|
+
*/
|
|
244
292
|
readonly table: ActivitiesExplorerTableExtensionsBuilder;
|
|
293
|
+
/**
|
|
294
|
+
* Provides a mechanism for customizing Activities Explorer Insights Panels.
|
|
295
|
+
*/
|
|
296
|
+
readonly insightsPanels: ActivitiesExplorerInsightsPanelsExtensionsBuilder;
|
|
297
|
+
/**
|
|
298
|
+
* Adds a new action to Activities Explorer.
|
|
299
|
+
*
|
|
300
|
+
* @param action - action to be added
|
|
301
|
+
*/
|
|
245
302
|
addAction: (action: ActionExtension) => this;
|
|
246
303
|
build: () => ActivitiesExplorerExtensions;
|
|
247
304
|
}
|
|
248
305
|
|
|
249
306
|
/**
|
|
307
|
+
* Hook for accessing Activities Explorer data.
|
|
308
|
+
*
|
|
309
|
+
* @remarks
|
|
310
|
+
* Should be used only inside Activities Explorer, otherwise throws an error.
|
|
311
|
+
*
|
|
250
312
|
* @public
|
|
251
313
|
*/
|
|
252
314
|
export declare type ActivitiesExplorerHook = () => ActivitiesExplorerHookResult;
|
|
253
315
|
|
|
254
316
|
/**
|
|
317
|
+
* Data of the Activities Explorer.
|
|
318
|
+
*
|
|
255
319
|
* @public
|
|
256
320
|
*/
|
|
257
321
|
export declare interface ActivitiesExplorerHookResult {
|
|
322
|
+
/**
|
|
323
|
+
* List of Activity Instances.
|
|
324
|
+
*/
|
|
258
325
|
items: ReadonlyArray<ActivityInstance>;
|
|
326
|
+
/**
|
|
327
|
+
* The loading state of the Activity Instances list.
|
|
328
|
+
*/
|
|
259
329
|
itemsLoadingState: LoadingState;
|
|
330
|
+
/**
|
|
331
|
+
* Currently active ActivityInstance.
|
|
332
|
+
*/
|
|
333
|
+
currentItem: ActivityInstance | undefined;
|
|
260
334
|
}
|
|
261
335
|
|
|
262
336
|
/**
|
|
@@ -269,6 +343,73 @@ export declare interface ActivitiesExplorerHooksApiStorage {
|
|
|
269
343
|
useOptionalActivitiesExplorerTable: OptionalActivitiesExplorerTableHook;
|
|
270
344
|
}
|
|
271
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
|
+
|
|
272
413
|
/**
|
|
273
414
|
* @public
|
|
274
415
|
*/
|
|
@@ -305,22 +446,56 @@ export declare interface ActivitiesExplorerTableExtensions {
|
|
|
305
446
|
*/
|
|
306
447
|
export declare class ActivitiesExplorerTableExtensionsBuilder {
|
|
307
448
|
private _columns;
|
|
449
|
+
/**
|
|
450
|
+
* Provides a mechanism for customizing the configuration of actions
|
|
451
|
+
* within Activities Explorer Table toolbar.
|
|
452
|
+
*/
|
|
308
453
|
readonly toolbar: ActionsConfigurationExtensionsBuilder;
|
|
454
|
+
/**
|
|
455
|
+
* Provides a mechanism for customizing the configuration of actions
|
|
456
|
+
* within Activities Explorer Table context menu.
|
|
457
|
+
*/
|
|
309
458
|
readonly contextMenu: ActionsConfigurationExtensionsBuilder;
|
|
459
|
+
/**
|
|
460
|
+
* Adds a new column to Activities Explorer Table.
|
|
461
|
+
*
|
|
462
|
+
* @param column - column to be added
|
|
463
|
+
*/
|
|
310
464
|
addColumn: (column: ActivitiesExplorerTableColumnExtension) => this;
|
|
311
465
|
build: () => ActivitiesExplorerTableExtensions;
|
|
312
466
|
}
|
|
313
467
|
|
|
314
468
|
/**
|
|
469
|
+
* Hook for accessing Activities Explorer Table data and methods.
|
|
470
|
+
*
|
|
471
|
+
* @remarks
|
|
472
|
+
* Should be used only inside Activities Explorer Table, otherwise throws an error.
|
|
473
|
+
*
|
|
315
474
|
* @public
|
|
316
475
|
*/
|
|
317
476
|
export declare type ActivitiesExplorerTableHook = () => ActivitiesExplorerTableHookResult;
|
|
318
477
|
|
|
319
478
|
/**
|
|
479
|
+
* Methods of the Activities Explorer Table.
|
|
320
480
|
* @public
|
|
321
481
|
*/
|
|
322
482
|
export declare interface ActivitiesExplorerTableHookResult {
|
|
483
|
+
/**
|
|
484
|
+
* Refetch list of Activity Instances.
|
|
485
|
+
*/
|
|
323
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>;
|
|
324
499
|
}
|
|
325
500
|
|
|
326
501
|
/**
|
|
@@ -332,9 +507,31 @@ export declare type ActivityInstancesQueryHook = (props?: ActivityInstancesQuery
|
|
|
332
507
|
* @public
|
|
333
508
|
*/
|
|
334
509
|
export declare interface ActivityInstancesQueryProps {
|
|
510
|
+
/**
|
|
511
|
+
* When set to `false`, the results will be filtered on Assignee or Owner depending on the activity instance state:
|
|
512
|
+
* - Activity Instances in Assigned State are returned if they are assigned to the Current User or any groups of the Current User.
|
|
513
|
+
* - Activity Instances in other Activity States are returned if they are owned by the Current User
|
|
514
|
+
*
|
|
515
|
+
* When set to `true`, the results are filtered by security instead.
|
|
516
|
+
* Only the Activity Instances on which the current user has Workflow Management rights (or system administration privileges) are returned.
|
|
517
|
+
*/
|
|
335
518
|
forAllUsers?: boolean;
|
|
519
|
+
/**
|
|
520
|
+
* If specified, only Activity Instances which have one of the given Activity States will be returned.
|
|
521
|
+
*/
|
|
336
522
|
activityStates?: ReadonlyArray<ActivityState>;
|
|
523
|
+
/**
|
|
524
|
+
* If specified, only Activity Instances based on the given Process Definition will be returned.
|
|
525
|
+
*/
|
|
337
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;
|
|
338
535
|
}
|
|
339
536
|
|
|
340
537
|
/**
|
|
@@ -346,8 +543,17 @@ export declare type AddToBundleMutationHook = (options?: MutationOptions<Mutatio
|
|
|
346
543
|
* @public
|
|
347
544
|
*/
|
|
348
545
|
export declare interface AddToBundleRequest {
|
|
546
|
+
/**
|
|
547
|
+
* ID of the bundle to which items should be added.
|
|
548
|
+
*/
|
|
349
549
|
bundleId: ItemUri;
|
|
550
|
+
/**
|
|
551
|
+
* Items to add to the bundle.
|
|
552
|
+
*/
|
|
350
553
|
itemsToAdd: ReadonlyArray<IdentifiableObject>;
|
|
554
|
+
/**
|
|
555
|
+
* Container item of the bundle.
|
|
556
|
+
*/
|
|
351
557
|
containerItem?: IdentifiableObject;
|
|
352
558
|
}
|
|
353
559
|
|
|
@@ -409,7 +615,13 @@ export declare type AssignActivitiesMutationHook = (options?: BatchMutationOptio
|
|
|
409
615
|
* @public
|
|
410
616
|
*/
|
|
411
617
|
export declare interface AssignActivitiesRequest {
|
|
618
|
+
/**
|
|
619
|
+
* The IDs of the ActivityInstances that will be assigned.
|
|
620
|
+
*/
|
|
412
621
|
itemIds: ReadonlyArray<ItemUri>;
|
|
622
|
+
/**
|
|
623
|
+
* User or Group ID to assign ActivityInstances to.
|
|
624
|
+
*/
|
|
413
625
|
newAssigneeId: ItemUri;
|
|
414
626
|
}
|
|
415
627
|
|
|
@@ -422,7 +634,13 @@ export declare type AssignActivityMutationHook = (options?: MutationOptions<Acti
|
|
|
422
634
|
* @public
|
|
423
635
|
*/
|
|
424
636
|
export declare interface AssignActivityRequest {
|
|
637
|
+
/**
|
|
638
|
+
* ID of an Activity Instance to change assignment for.
|
|
639
|
+
*/
|
|
425
640
|
activityId: ItemUri;
|
|
641
|
+
/**
|
|
642
|
+
* User or Group ID to assign ActivityInstances to.
|
|
643
|
+
*/
|
|
426
644
|
newAssigneeId: ItemUri;
|
|
427
645
|
}
|
|
428
646
|
|
|
@@ -435,7 +653,13 @@ export declare type AutoClassifyItemMutationHook = (options?: MutationOptions<Cl
|
|
|
435
653
|
* @public
|
|
436
654
|
*/
|
|
437
655
|
export declare interface AutoClassifyItemRequest {
|
|
656
|
+
/**
|
|
657
|
+
* ID of an item to classify.
|
|
658
|
+
*/
|
|
438
659
|
itemId: ItemUri;
|
|
660
|
+
/**
|
|
661
|
+
* Container of an item to classify.
|
|
662
|
+
*/
|
|
439
663
|
containerItem?: IdentifiableObject;
|
|
440
664
|
}
|
|
441
665
|
|
|
@@ -448,7 +672,13 @@ export declare type AutoClassifyItemsMutationHook = (options?: BatchMutationOpti
|
|
|
448
672
|
* @public
|
|
449
673
|
*/
|
|
450
674
|
export declare interface AutoClassifyItemsRequest {
|
|
675
|
+
/**
|
|
676
|
+
* IDs of the items to classify.
|
|
677
|
+
*/
|
|
451
678
|
itemIds: ReadonlyArray<ItemUri>;
|
|
679
|
+
/**
|
|
680
|
+
* Container item ID of the items to classify.
|
|
681
|
+
*/
|
|
452
682
|
containerId: ItemUri;
|
|
453
683
|
}
|
|
454
684
|
|
|
@@ -477,6 +707,7 @@ declare type BatchMutationOptions<TVariables> = MutationOptions<Batch, ApiError,
|
|
|
477
707
|
* including the className and cssStyle props for custom styling.
|
|
478
708
|
*
|
|
479
709
|
* It should rarely be used directly as preference should be given to the more specialized child components.
|
|
710
|
+
*
|
|
480
711
|
* @public
|
|
481
712
|
*/
|
|
482
713
|
export declare const Block: BlockComponent;
|
|
@@ -540,6 +771,11 @@ export declare interface BorderRadius {
|
|
|
540
771
|
large: number;
|
|
541
772
|
}
|
|
542
773
|
|
|
774
|
+
/**
|
|
775
|
+
* @public
|
|
776
|
+
*/
|
|
777
|
+
export declare type BorderRadiusGetter = () => BorderRadius;
|
|
778
|
+
|
|
543
779
|
/**
|
|
544
780
|
* @public
|
|
545
781
|
*/
|
|
@@ -556,9 +792,21 @@ export declare interface BundleEditorApiStorage {
|
|
|
556
792
|
* @public
|
|
557
793
|
*/
|
|
558
794
|
export declare interface BundleEditorHookResult {
|
|
795
|
+
/**
|
|
796
|
+
* Editable Bundle.
|
|
797
|
+
*/
|
|
559
798
|
bundle: Bundle;
|
|
799
|
+
/**
|
|
800
|
+
* Bundle's metadata schema.
|
|
801
|
+
*/
|
|
560
802
|
metadataSchema: Schema;
|
|
803
|
+
/**
|
|
804
|
+
* Boolean that indicates that Bundle has unsaved changes.
|
|
805
|
+
*/
|
|
561
806
|
isChanged: boolean;
|
|
807
|
+
/**
|
|
808
|
+
* Boolean that indicates that Bundle can be edited.
|
|
809
|
+
*/
|
|
562
810
|
isEditing: boolean;
|
|
563
811
|
}
|
|
564
812
|
|
|
@@ -571,6 +819,7 @@ export declare interface BundleEditorHooksApiStorage {
|
|
|
571
819
|
|
|
572
820
|
/**
|
|
573
821
|
* A component that has standard button functionality.
|
|
822
|
+
*
|
|
574
823
|
* @public
|
|
575
824
|
*/
|
|
576
825
|
export declare const Button: ButtonComponent;
|
|
@@ -620,9 +869,21 @@ export declare interface CategoryEditorApiStorage {
|
|
|
620
869
|
* @public
|
|
621
870
|
*/
|
|
622
871
|
export declare interface CategoryEditorHookResult {
|
|
872
|
+
/**
|
|
873
|
+
* Editable Category.
|
|
874
|
+
*/
|
|
623
875
|
category: KeywordCategory;
|
|
876
|
+
/**
|
|
877
|
+
* Category's metadata schema.
|
|
878
|
+
*/
|
|
624
879
|
metadataSchema: Schema;
|
|
880
|
+
/**
|
|
881
|
+
* Boolean that indicates that Category has unsaved changes.
|
|
882
|
+
*/
|
|
625
883
|
isChanged: boolean;
|
|
884
|
+
/**
|
|
885
|
+
* Boolean that indicates that Category can be edited.
|
|
886
|
+
*/
|
|
626
887
|
isEditing: boolean;
|
|
627
888
|
}
|
|
628
889
|
|
|
@@ -640,6 +901,7 @@ export declare interface CategoryEditorHooksApiStorage {
|
|
|
640
901
|
*
|
|
641
902
|
* It is advisable to construct most of the layout using this component as it allows to freely utilize
|
|
642
903
|
* "shouldFill" and similar props that rely on the parent being a Flex component.
|
|
904
|
+
*
|
|
643
905
|
* @public
|
|
644
906
|
*/
|
|
645
907
|
export declare const Center: CenterComponent;
|
|
@@ -664,7 +926,13 @@ export declare type ChangeUserLanguageMutationHook = (options?: MutationOptions<
|
|
|
664
926
|
* @public
|
|
665
927
|
*/
|
|
666
928
|
export declare interface ChangeUserLanguageRequest {
|
|
929
|
+
/**
|
|
930
|
+
* ID of a User to change language for.
|
|
931
|
+
*/
|
|
667
932
|
userId: ItemUri;
|
|
933
|
+
/**
|
|
934
|
+
* ID of a language to set to.
|
|
935
|
+
*/
|
|
668
936
|
languageId: number;
|
|
669
937
|
}
|
|
670
938
|
|
|
@@ -677,7 +945,13 @@ export declare type ChangeUserLocaleMutationHook = (options?: MutationOptions<Us
|
|
|
677
945
|
* @public
|
|
678
946
|
*/
|
|
679
947
|
export declare interface ChangeUserLocaleRequest {
|
|
948
|
+
/**
|
|
949
|
+
* ID of a User to change locale for.
|
|
950
|
+
*/
|
|
680
951
|
userId: ItemUri;
|
|
952
|
+
/**
|
|
953
|
+
* ID of a Locale to set to.
|
|
954
|
+
*/
|
|
681
955
|
localeId: number;
|
|
682
956
|
}
|
|
683
957
|
|
|
@@ -725,12 +999,21 @@ export declare interface ColorPalette {
|
|
|
725
999
|
yellow50: string;
|
|
726
1000
|
yellow100: string;
|
|
727
1001
|
yellow120: string;
|
|
1002
|
+
yellow140: string;
|
|
728
1003
|
}
|
|
729
1004
|
|
|
1005
|
+
/**
|
|
1006
|
+
* @public
|
|
1007
|
+
*/
|
|
1008
|
+
export declare type ColorPaletteGetter = () => ColorPalette;
|
|
1009
|
+
|
|
730
1010
|
/**
|
|
731
1011
|
* @public
|
|
732
1012
|
*/
|
|
733
1013
|
export declare interface ColorProps {
|
|
1014
|
+
/**
|
|
1015
|
+
* Color of the component based on the color palette.
|
|
1016
|
+
*/
|
|
734
1017
|
color?: Color | 'inherit';
|
|
735
1018
|
}
|
|
736
1019
|
|
|
@@ -749,9 +1032,21 @@ export declare interface ComponentEditorApiStorage {
|
|
|
749
1032
|
* @public
|
|
750
1033
|
*/
|
|
751
1034
|
export declare interface ComponentEditorHookResult {
|
|
1035
|
+
/**
|
|
1036
|
+
* Editable Component.
|
|
1037
|
+
*/
|
|
752
1038
|
component: Component | MultimediaComponent | ExternalMultimediaComponent;
|
|
1039
|
+
/**
|
|
1040
|
+
* Component's metadata schema.
|
|
1041
|
+
*/
|
|
753
1042
|
schema: Schema;
|
|
1043
|
+
/**
|
|
1044
|
+
* Boolean that indicates that Component has unsaved changes.
|
|
1045
|
+
*/
|
|
754
1046
|
isChanged: boolean;
|
|
1047
|
+
/**
|
|
1048
|
+
* Boolean that indicates that Component can be edited.
|
|
1049
|
+
*/
|
|
755
1050
|
isEditing: boolean;
|
|
756
1051
|
}
|
|
757
1052
|
|
|
@@ -771,11 +1066,29 @@ export declare type ConfirmationHook = (args: ConfirmationHookArguments) => Conf
|
|
|
771
1066
|
* @public
|
|
772
1067
|
*/
|
|
773
1068
|
export declare interface ConfirmationHookArguments {
|
|
1069
|
+
/**
|
|
1070
|
+
* Dialog's title.
|
|
1071
|
+
*/
|
|
774
1072
|
title: string;
|
|
1073
|
+
/**
|
|
1074
|
+
* Callback is called after pressing confirm button.
|
|
1075
|
+
*/
|
|
775
1076
|
onConfirm: () => void;
|
|
1077
|
+
/**
|
|
1078
|
+
* Label for dialog's cancel button.
|
|
1079
|
+
*/
|
|
776
1080
|
cancelButtonLabel?: string;
|
|
1081
|
+
/**
|
|
1082
|
+
* Content of the dialog.
|
|
1083
|
+
*/
|
|
777
1084
|
description?: ReactNode;
|
|
1085
|
+
/**
|
|
1086
|
+
* Label for dialog's confirm button.
|
|
1087
|
+
*/
|
|
778
1088
|
okButtonLabel?: string;
|
|
1089
|
+
/**
|
|
1090
|
+
* Callback is executed when dialog has been canceled.
|
|
1091
|
+
*/
|
|
779
1092
|
onCancel?: () => void;
|
|
780
1093
|
}
|
|
781
1094
|
|
|
@@ -890,6 +1203,8 @@ export declare interface ContentEditorFormFieldHookResult {
|
|
|
890
1203
|
export declare type ContentExplorerActionGroupId = ValuesOfArray<typeof contentExplorerActionGroupIds>;
|
|
891
1204
|
|
|
892
1205
|
/**
|
|
1206
|
+
* All built-in action group IDs available in Content Explorer.
|
|
1207
|
+
*
|
|
893
1208
|
* @public
|
|
894
1209
|
*/
|
|
895
1210
|
export declare const contentExplorerActionGroupId: {
|
|
@@ -919,6 +1234,8 @@ export declare const contentExplorerActionGroupIds: readonly ["browsing", "bundl
|
|
|
919
1234
|
export declare type ContentExplorerActionId = ValuesOfArray<typeof contentExplorerActionIds>;
|
|
920
1235
|
|
|
921
1236
|
/**
|
|
1237
|
+
* All built-in action IDs available in Content Explorer.
|
|
1238
|
+
*
|
|
922
1239
|
* @public
|
|
923
1240
|
*/
|
|
924
1241
|
export declare const contentExplorerActionId: {
|
|
@@ -968,6 +1285,21 @@ export declare const contentExplorerActionIds: readonly ["open", "openEditor", "
|
|
|
968
1285
|
export declare interface ContentExplorerApiStorage {
|
|
969
1286
|
hooks: ContentExplorerHooksApiStorage;
|
|
970
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;
|
|
971
1303
|
}
|
|
972
1304
|
|
|
973
1305
|
/**
|
|
@@ -977,6 +1309,7 @@ export declare interface ContentExplorerExtensions {
|
|
|
977
1309
|
actions: ReadonlyArray<ActionExtension>;
|
|
978
1310
|
table: ContentExplorerTableExtensions;
|
|
979
1311
|
tree: ContentExplorerTreeExtensions;
|
|
1312
|
+
insightsPanels: ContentExplorerInsightsPanelsExtensions;
|
|
980
1313
|
}
|
|
981
1314
|
|
|
982
1315
|
/**
|
|
@@ -984,13 +1317,30 @@ export declare interface ContentExplorerExtensions {
|
|
|
984
1317
|
*/
|
|
985
1318
|
export declare class ContentExplorerExtensionsBuilder {
|
|
986
1319
|
private _actions;
|
|
1320
|
+
/**
|
|
1321
|
+
* Provides a mechanism for customizing Content Explorer Table.
|
|
1322
|
+
*/
|
|
987
1323
|
readonly table: ContentExplorerTableExtensionsBuilder;
|
|
1324
|
+
/**
|
|
1325
|
+
* Provides a mechanism for customizing Content Explorer Tree.
|
|
1326
|
+
*/
|
|
988
1327
|
readonly tree: ContentExplorerTreeExtensionsBuilder;
|
|
1328
|
+
/**
|
|
1329
|
+
* Provides a mechanism for customizing Content Explorer Insights Panels.
|
|
1330
|
+
*/
|
|
1331
|
+
readonly insightsPanels: ContentExplorerInsightsPanelsExtensionsBuilder;
|
|
1332
|
+
/**
|
|
1333
|
+
* Adds a new action to Content Explorer.
|
|
1334
|
+
*
|
|
1335
|
+
* @param action - action to be added
|
|
1336
|
+
*/
|
|
989
1337
|
addAction: (action: ActionExtension) => this;
|
|
990
1338
|
build: () => ContentExplorerExtensions;
|
|
991
1339
|
}
|
|
992
1340
|
|
|
993
1341
|
/**
|
|
1342
|
+
* Data of Content Explorer structured in a hierarchy form.
|
|
1343
|
+
*
|
|
994
1344
|
* @public
|
|
995
1345
|
*/
|
|
996
1346
|
export declare type ContentExplorerHierarchy = ReadonlyHierarchy<ContentExplorerNodeData>;
|
|
@@ -1009,30 +1359,109 @@ export declare interface ContentExplorerHierarchyLoadingState {
|
|
|
1009
1359
|
* @public
|
|
1010
1360
|
*/
|
|
1011
1361
|
export declare interface ContentExplorerHierarchyUtilsExtensionApi {
|
|
1362
|
+
/**
|
|
1363
|
+
* Checks if a node ID is favorites node ID.
|
|
1364
|
+
*
|
|
1365
|
+
* @param nodeId - The ID of the node to check.
|
|
1366
|
+
* @returns A boolean value indicating whether the node ID is favorites node ID.
|
|
1367
|
+
*/
|
|
1012
1368
|
isFavoritesNodeId: (nodeId: string) => boolean;
|
|
1369
|
+
/**
|
|
1370
|
+
* Checks if a node is item node.
|
|
1371
|
+
*
|
|
1372
|
+
* @param node - The node to check.
|
|
1373
|
+
* @returns A boolean value indicating whether the node is item node.
|
|
1374
|
+
*/
|
|
1013
1375
|
isItemNode: (node: ContentExplorerNode | undefined) => node is ContentExplorerItemNode;
|
|
1376
|
+
/**
|
|
1377
|
+
* Checks if a node is item node of a specific type.
|
|
1378
|
+
*
|
|
1379
|
+
* @typeParam T - The type of the item node.
|
|
1380
|
+
* @param node - The node to check.
|
|
1381
|
+
* @param ctor - The constructor function of the item type.
|
|
1382
|
+
* @returns A boolean value indicating whether the node is item node of the specified type.
|
|
1383
|
+
*/
|
|
1014
1384
|
isItemNodeOfType: <T extends IdentifiableObject>(node: ContentExplorerNode | undefined, ctor: Constructor<T>) => node is ContentExplorerItemNode<T>;
|
|
1385
|
+
/**
|
|
1386
|
+
* Checks if a node is "items in progress" node.
|
|
1387
|
+
*
|
|
1388
|
+
* @param node - The node to check.
|
|
1389
|
+
* @returns A boolean value indicating whether the node is "items in progress" node.
|
|
1390
|
+
*/
|
|
1015
1391
|
isItemsInProgressNode: (node: ContentExplorerNode | undefined) => node is ContentExplorerItemsInProgressNode;
|
|
1392
|
+
/**
|
|
1393
|
+
* Checks if a node ID is "items in progress" node ID.
|
|
1394
|
+
*
|
|
1395
|
+
* @param nodeId - The ID of the node to check.
|
|
1396
|
+
* @returns A boolean value indicating whether the node ID is "items in progress" node ID.
|
|
1397
|
+
*/
|
|
1016
1398
|
isItemsInProgressNodeId: (nodeId: string) => boolean;
|
|
1399
|
+
/**
|
|
1400
|
+
* Checks if a node is publications node.
|
|
1401
|
+
*
|
|
1402
|
+
* @param node - The node to check.
|
|
1403
|
+
* @returns A boolean value indicating whether the node is publications node.
|
|
1404
|
+
*/
|
|
1017
1405
|
isPublicationsNode: (node: ContentExplorerNode | undefined) => node is ContentExplorerPublicationsNode;
|
|
1406
|
+
/**
|
|
1407
|
+
* Checks if a node ID is publications node ID.
|
|
1408
|
+
*
|
|
1409
|
+
* @param nodeId - The ID of the node to check.
|
|
1410
|
+
* @returns A boolean value indicating whether the node ID is publications node ID.
|
|
1411
|
+
*/
|
|
1018
1412
|
isPublicationsNodeId: (nodeId: string) => boolean;
|
|
1413
|
+
/**
|
|
1414
|
+
* Checks if a node is root node.
|
|
1415
|
+
*
|
|
1416
|
+
* @param node - The node to check.
|
|
1417
|
+
* @returns A boolean value indicating whether the node is root node.
|
|
1418
|
+
*/
|
|
1019
1419
|
isRootNode: (node: ContentExplorerNode | undefined) => node is ContentExplorerRootNode;
|
|
1420
|
+
/**
|
|
1421
|
+
* Checks if a node ID is root node ID.
|
|
1422
|
+
*
|
|
1423
|
+
* @param nodeId - The ID of the node to check.
|
|
1424
|
+
* @returns A boolean value indicating whether the node ID is root node ID.
|
|
1425
|
+
*/
|
|
1020
1426
|
isRootNodeId: (nodeId: string) => boolean;
|
|
1427
|
+
/**
|
|
1428
|
+
* Checks if a node is system node.
|
|
1429
|
+
*
|
|
1430
|
+
* @param node - The node to check.
|
|
1431
|
+
* @returns A boolean value indicating whether the node is system node.
|
|
1432
|
+
*/
|
|
1021
1433
|
isSystemNode: (node: ContentExplorerNode | undefined) => node is ContentExplorerSystemNode;
|
|
1022
1434
|
}
|
|
1023
1435
|
|
|
1024
1436
|
/**
|
|
1437
|
+
* Hook for accessing Content Explorer data and methods.
|
|
1438
|
+
*
|
|
1439
|
+
* @remarks
|
|
1440
|
+
* Should be used only inside Content Explorer, otherwise throws an error.
|
|
1441
|
+
*
|
|
1025
1442
|
* @public
|
|
1026
1443
|
*/
|
|
1027
1444
|
export declare type ContentExplorerHook = () => ContentExplorerHookResult;
|
|
1028
1445
|
|
|
1029
1446
|
/**
|
|
1447
|
+
* Data and methods of the Content Explorer.
|
|
1448
|
+
*
|
|
1030
1449
|
* @public
|
|
1031
1450
|
*/
|
|
1032
1451
|
export declare interface ContentExplorerHookResult {
|
|
1033
1452
|
hierarchy: ContentExplorerHierarchy;
|
|
1034
1453
|
currentNode: ContentExplorerNode | undefined;
|
|
1454
|
+
/**
|
|
1455
|
+
* Currently active item.
|
|
1456
|
+
*/
|
|
1457
|
+
currentItem: IdentifiableObject | undefined;
|
|
1458
|
+
/**
|
|
1459
|
+
* Loading state of nodes of the Content Explorer hierarchy.
|
|
1460
|
+
*/
|
|
1035
1461
|
hierarchyLoadingState: ContentExplorerHierarchyLoadingState;
|
|
1462
|
+
/**
|
|
1463
|
+
* Method to change current location of the Content Explorer.
|
|
1464
|
+
*/
|
|
1036
1465
|
setTarget: (props: SetTargetContentExplorerProps) => void;
|
|
1037
1466
|
}
|
|
1038
1467
|
|
|
@@ -1051,9 +1480,55 @@ export declare interface ContentExplorerHooksApiStorage {
|
|
|
1051
1480
|
/**
|
|
1052
1481
|
* @public
|
|
1053
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
|
+
|
|
1522
|
+
/**
|
|
1523
|
+
* Tridion item node of the Content Explorer hierarchy.
|
|
1524
|
+
*
|
|
1525
|
+
* @public
|
|
1526
|
+
*/
|
|
1054
1527
|
export declare type ContentExplorerItemNode<TItem extends IdentifiableObject = IdentifiableObject> = ReadonlyHierarchyNode<ContentExplorerItemNodeData<TItem>>;
|
|
1055
1528
|
|
|
1056
1529
|
/**
|
|
1530
|
+
* Data contained in a Content Explorer ItemNode.
|
|
1531
|
+
*
|
|
1057
1532
|
* @public
|
|
1058
1533
|
*/
|
|
1059
1534
|
export declare interface ContentExplorerItemNodeData<TItem extends IdentifiableObject = IdentifiableObject> extends ContentExplorerNodeData {
|
|
@@ -1064,22 +1539,30 @@ export declare interface ContentExplorerItemNodeData<TItem extends IdentifiableO
|
|
|
1064
1539
|
}
|
|
1065
1540
|
|
|
1066
1541
|
/**
|
|
1542
|
+
* Content Explorer hierarchy node that stores items in progress.
|
|
1543
|
+
*
|
|
1067
1544
|
* @public
|
|
1068
1545
|
*/
|
|
1069
1546
|
export declare type ContentExplorerItemsInProgressNode = ReadonlyHierarchyNode<ContentExplorerItemsInProgressNodeData>;
|
|
1070
1547
|
|
|
1071
1548
|
/**
|
|
1549
|
+
* Data contained in a Content Explorer ItemsInProgressNode.
|
|
1550
|
+
*
|
|
1072
1551
|
* @public
|
|
1073
1552
|
*/
|
|
1074
1553
|
export declare interface ContentExplorerItemsInProgressNodeData extends ContentExplorerSystemNodeData {
|
|
1075
1554
|
}
|
|
1076
1555
|
|
|
1077
1556
|
/**
|
|
1557
|
+
* Node of the Content Explorer hierarchy.
|
|
1558
|
+
*
|
|
1078
1559
|
* @public
|
|
1079
1560
|
*/
|
|
1080
1561
|
export declare type ContentExplorerNode = ReadonlyHierarchyNode<ContentExplorerNodeData>;
|
|
1081
1562
|
|
|
1082
1563
|
/**
|
|
1564
|
+
* Basic data contained in a Content Explorer hierarchy node.
|
|
1565
|
+
*
|
|
1083
1566
|
* @public
|
|
1084
1567
|
*/
|
|
1085
1568
|
export declare interface ContentExplorerNodeData {
|
|
@@ -1094,43 +1577,76 @@ export declare interface ContentExplorerNodeData {
|
|
|
1094
1577
|
}
|
|
1095
1578
|
|
|
1096
1579
|
/**
|
|
1580
|
+
* Type represents ID of a built-in panel of the Content Explorer.
|
|
1581
|
+
*
|
|
1097
1582
|
* @public
|
|
1098
1583
|
*/
|
|
1099
1584
|
export declare type ContentExplorerPanelId = ValuesOfArray<typeof contentExplorerPanelIds>;
|
|
1100
1585
|
|
|
1101
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
|
+
|
|
1603
|
+
/**
|
|
1604
|
+
* List of all built-in panel IDs of the Content Explorer.
|
|
1605
|
+
*
|
|
1102
1606
|
* @public
|
|
1103
1607
|
*/
|
|
1104
1608
|
export declare const contentExplorerPanelIds: readonly ["information", "general", "metadata", "history", "blueprint", "where-used", "view-on-site", "published-to", "translations"];
|
|
1105
1609
|
|
|
1106
1610
|
/**
|
|
1611
|
+
* Content Explorer hierarchy node that has list of publications as a children.
|
|
1612
|
+
*
|
|
1107
1613
|
* @public
|
|
1108
1614
|
*/
|
|
1109
1615
|
export declare type ContentExplorerPublicationsNode = ReadonlyHierarchyNode<ContentExplorerPublicationsNodeData>;
|
|
1110
1616
|
|
|
1111
1617
|
/**
|
|
1618
|
+
* Data contained in a Content Explorer PublicationsNode.
|
|
1619
|
+
*
|
|
1112
1620
|
* @public
|
|
1113
1621
|
*/
|
|
1114
1622
|
export declare interface ContentExplorerPublicationsNodeData extends ContentExplorerSystemNodeData {
|
|
1115
1623
|
}
|
|
1116
1624
|
|
|
1117
1625
|
/**
|
|
1626
|
+
* Root node of Content Explorer hierarchy.
|
|
1627
|
+
*
|
|
1118
1628
|
* @public
|
|
1119
1629
|
*/
|
|
1120
1630
|
export declare type ContentExplorerRootNode = ReadonlyHierarchyNode<ContentExplorerRootNodeData>;
|
|
1121
1631
|
|
|
1122
1632
|
/**
|
|
1633
|
+
* Data contained in a Content Explorer RootNode.
|
|
1634
|
+
*
|
|
1123
1635
|
* @public
|
|
1124
1636
|
*/
|
|
1125
1637
|
export declare interface ContentExplorerRootNodeData extends ContentExplorerSystemNodeData {
|
|
1126
1638
|
}
|
|
1127
1639
|
|
|
1128
1640
|
/**
|
|
1641
|
+
* Predefined node of the Content Explorer hierarchy.
|
|
1642
|
+
*
|
|
1129
1643
|
* @public
|
|
1130
1644
|
*/
|
|
1131
1645
|
export declare type ContentExplorerSystemNode = ReadonlyHierarchyNode<ContentExplorerSystemNodeData>;
|
|
1132
1646
|
|
|
1133
1647
|
/**
|
|
1648
|
+
* Data contained in a Content Explorer SystemNode.
|
|
1649
|
+
*
|
|
1134
1650
|
* @public
|
|
1135
1651
|
*/
|
|
1136
1652
|
export declare interface ContentExplorerSystemNodeData extends ContentExplorerNodeData {
|
|
@@ -1176,22 +1692,54 @@ export declare interface ContentExplorerTableExtensions {
|
|
|
1176
1692
|
*/
|
|
1177
1693
|
export declare class ContentExplorerTableExtensionsBuilder {
|
|
1178
1694
|
private _columns;
|
|
1695
|
+
/**
|
|
1696
|
+
* Provides a mechanism for customizing the configuration of actions
|
|
1697
|
+
* within Content Explorer Table toolbar.
|
|
1698
|
+
*/
|
|
1179
1699
|
readonly toolbar: ActionsConfigurationExtensionsBuilder;
|
|
1700
|
+
/**
|
|
1701
|
+
* Provides a mechanism for customizing the configuration of actions
|
|
1702
|
+
* within Content Explorer Table context menu.
|
|
1703
|
+
*/
|
|
1180
1704
|
readonly contextMenu: ActionsConfigurationExtensionsBuilder;
|
|
1705
|
+
/**
|
|
1706
|
+
* Adds a new column to Content Explorer Table.
|
|
1707
|
+
*
|
|
1708
|
+
* @param column - column to be added
|
|
1709
|
+
*/
|
|
1181
1710
|
addColumn: (column: ContentExplorerTableColumnExtension) => this;
|
|
1182
1711
|
build: () => ContentExplorerTableExtensions;
|
|
1183
1712
|
}
|
|
1184
1713
|
|
|
1185
1714
|
/**
|
|
1715
|
+
* Hook for accessing Content Explorer Table data and methods.
|
|
1716
|
+
*
|
|
1717
|
+
* @remarks
|
|
1718
|
+
* Should be used only inside Content Explorer Table, otherwise throws an error.
|
|
1719
|
+
*
|
|
1186
1720
|
* @public
|
|
1187
1721
|
*/
|
|
1188
1722
|
export declare type ContentExplorerTableHook = () => ContentExplorerTableHookResult;
|
|
1189
1723
|
|
|
1190
1724
|
/**
|
|
1725
|
+
* Methods of a Content Explorer Table.
|
|
1726
|
+
*
|
|
1191
1727
|
* @public
|
|
1192
1728
|
*/
|
|
1193
1729
|
export declare interface ContentExplorerTableHookResult {
|
|
1194
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>;
|
|
1195
1743
|
}
|
|
1196
1744
|
|
|
1197
1745
|
/**
|
|
@@ -1205,16 +1753,27 @@ export declare interface ContentExplorerTreeExtensions {
|
|
|
1205
1753
|
* @public
|
|
1206
1754
|
*/
|
|
1207
1755
|
export declare class ContentExplorerTreeExtensionsBuilder {
|
|
1756
|
+
/**
|
|
1757
|
+
* Provides a mechanism for customizing the configuration of actions
|
|
1758
|
+
* within Content Explorer Tree context menu.
|
|
1759
|
+
*/
|
|
1208
1760
|
readonly contextMenu: ActionsConfigurationExtensionsBuilder;
|
|
1209
1761
|
build: () => ContentExplorerTreeExtensions;
|
|
1210
1762
|
}
|
|
1211
1763
|
|
|
1212
1764
|
/**
|
|
1765
|
+
* Hook for accessing Content Explorer Tree data and methods.
|
|
1766
|
+
*
|
|
1767
|
+
* @remarks
|
|
1768
|
+
* Should be used only inside Content Explorer Tree, otherwise throws an error.
|
|
1769
|
+
*
|
|
1213
1770
|
* @public
|
|
1214
1771
|
*/
|
|
1215
1772
|
export declare type ContentExplorerTreeHook = () => ContentExplorerTreeHookResult;
|
|
1216
1773
|
|
|
1217
1774
|
/**
|
|
1775
|
+
* Methods of the Content Explorer Tree.
|
|
1776
|
+
*
|
|
1218
1777
|
* @public
|
|
1219
1778
|
*/
|
|
1220
1779
|
export declare interface ContentExplorerTreeHookResult {
|
|
@@ -1237,7 +1796,13 @@ export declare type CopyItemMutationHook = (options?: MutationOptions<Repository
|
|
|
1237
1796
|
* @public
|
|
1238
1797
|
*/
|
|
1239
1798
|
export declare interface CopyItemRequest {
|
|
1799
|
+
/**
|
|
1800
|
+
* ID of an item to copy.
|
|
1801
|
+
*/
|
|
1240
1802
|
itemId: ItemUri;
|
|
1803
|
+
/**
|
|
1804
|
+
* ID of organizational item to copy to.
|
|
1805
|
+
*/
|
|
1241
1806
|
destinationId: ItemUri;
|
|
1242
1807
|
}
|
|
1243
1808
|
|
|
@@ -1250,7 +1815,13 @@ export declare type CopyItemsMutationHook = (options?: BatchMutationOptions<Copy
|
|
|
1250
1815
|
* @public
|
|
1251
1816
|
*/
|
|
1252
1817
|
export declare interface CopyItemsRequest {
|
|
1818
|
+
/**
|
|
1819
|
+
* IDs of items to copy.
|
|
1820
|
+
*/
|
|
1253
1821
|
itemIds: ReadonlyArray<ItemUri>;
|
|
1822
|
+
/**
|
|
1823
|
+
* ID of organizational item to copy to.
|
|
1824
|
+
*/
|
|
1254
1825
|
destinationId: ItemUri;
|
|
1255
1826
|
}
|
|
1256
1827
|
|
|
@@ -1275,6 +1846,9 @@ export declare type CreateTranslationJobMutationHook = (options: MutationOptions
|
|
|
1275
1846
|
* @public
|
|
1276
1847
|
*/
|
|
1277
1848
|
export declare interface CreateTranslationJobRequest {
|
|
1849
|
+
/**
|
|
1850
|
+
* Configuration to create Translation Job from.
|
|
1851
|
+
*/
|
|
1278
1852
|
translationJob: TranslationJob;
|
|
1279
1853
|
}
|
|
1280
1854
|
|
|
@@ -1294,6 +1868,8 @@ export declare type CustomIcon = ReactElement<CustomIconProps>;
|
|
|
1294
1868
|
export declare type CustomIconProps = Omit<IconProps, 'children' | 'viewBox'>;
|
|
1295
1869
|
|
|
1296
1870
|
/**
|
|
1871
|
+
* Model type for which default data can be retrieved.
|
|
1872
|
+
*
|
|
1297
1873
|
* @public
|
|
1298
1874
|
*/
|
|
1299
1875
|
export declare type DefaultModelType = Extract<ItemType, 'bundle' | 'searchFolder' | 'schema' | 'page' | 'pageTemplate' | 'component' | 'componentTemplate' | 'folder' | 'keyword' | 'structureGroup' | 'templateBuildingBlock' | 'publication' | 'keywordCategory' | 'userGroup' | 'processDefinition' | 'businessProcessType' | 'multimediaType' | 'user' | 'targetGroup'>;
|
|
@@ -1307,6 +1883,9 @@ export declare type DefaultTranslationJobQueryHook = (props: DefaultTranslationJ
|
|
|
1307
1883
|
* @public
|
|
1308
1884
|
*/
|
|
1309
1885
|
export declare interface DefaultTranslationJobQueryProps {
|
|
1886
|
+
/**
|
|
1887
|
+
* IDs to get default Translation Job for.
|
|
1888
|
+
*/
|
|
1310
1889
|
itemIds: ReadonlyArray<ItemUri>;
|
|
1311
1890
|
type: TranslationJobType;
|
|
1312
1891
|
}
|
|
@@ -1320,7 +1899,13 @@ export declare type DeleteItemMutationHook = (options?: MutationOptions<void, Ap
|
|
|
1320
1899
|
* @public
|
|
1321
1900
|
*/
|
|
1322
1901
|
export declare interface DeleteItemRequest {
|
|
1902
|
+
/**
|
|
1903
|
+
* Item to delete.
|
|
1904
|
+
*/
|
|
1323
1905
|
item: IdentifiableObject;
|
|
1906
|
+
/**
|
|
1907
|
+
* Container item ID of the item to delete.
|
|
1908
|
+
*/
|
|
1324
1909
|
containerItem?: IdentifiableObject;
|
|
1325
1910
|
}
|
|
1326
1911
|
|
|
@@ -1333,9 +1918,13 @@ export declare type DeleteItemsMutationHook = (options?: BatchMutationOptions<De
|
|
|
1333
1918
|
* @public
|
|
1334
1919
|
*/
|
|
1335
1920
|
export declare interface DeleteItemsRequest {
|
|
1921
|
+
/**
|
|
1922
|
+
* Items to delete.
|
|
1923
|
+
*/
|
|
1336
1924
|
items: ReadonlyArray<IdentifiableObject>;
|
|
1337
1925
|
/**
|
|
1338
|
-
*
|
|
1926
|
+
* Container item ID of an items to delete.
|
|
1927
|
+
* `containerId` may take 'undefined' value when publications
|
|
1339
1928
|
* which don't have a real container are being deleted.
|
|
1340
1929
|
*/
|
|
1341
1930
|
containerId: ItemUri | undefined;
|
|
@@ -1350,9 +1939,21 @@ export declare type EditorHook = () => EditorHookResult;
|
|
|
1350
1939
|
* @public
|
|
1351
1940
|
*/
|
|
1352
1941
|
export declare interface EditorHookResult {
|
|
1942
|
+
/**
|
|
1943
|
+
* Editable item.
|
|
1944
|
+
*/
|
|
1353
1945
|
item: Bundle | KeywordCategory | Component | MultimediaComponent | Folder | Keyword | Page | StructureGroup;
|
|
1946
|
+
/**
|
|
1947
|
+
* Item's metadata schema.
|
|
1948
|
+
*/
|
|
1354
1949
|
schema: Schema;
|
|
1950
|
+
/**
|
|
1951
|
+
* Boolean that indicates that Item has unsaved changes.
|
|
1952
|
+
*/
|
|
1355
1953
|
isChanged: boolean;
|
|
1954
|
+
/**
|
|
1955
|
+
* Boolean that indicates that item can be edited.
|
|
1956
|
+
*/
|
|
1356
1957
|
isEditing: boolean;
|
|
1357
1958
|
}
|
|
1358
1959
|
|
|
@@ -1392,6 +1993,7 @@ export declare const extensionApiBridge: {
|
|
|
1392
1993
|
export declare interface ExtensionApiImplementationStorage {
|
|
1393
1994
|
activitiesExplorer: ActivitiesExplorerApiStorage;
|
|
1394
1995
|
contentExplorer: ContentExplorerApiStorage;
|
|
1996
|
+
publishingQueueExplorer: PublishingQueueExplorerApiStorage;
|
|
1395
1997
|
editors: EditorsApiStorage;
|
|
1396
1998
|
general: GeneralApiStorage;
|
|
1397
1999
|
}
|
|
@@ -1400,11 +2002,30 @@ export declare interface ExtensionApiImplementationStorage {
|
|
|
1400
2002
|
* @public
|
|
1401
2003
|
*/
|
|
1402
2004
|
export declare class ExtensionBuilder {
|
|
2005
|
+
/**
|
|
2006
|
+
* Provides a mechanism for customizing the header of the application.
|
|
2007
|
+
*/
|
|
1403
2008
|
readonly header: HeaderExtensionsBuilder;
|
|
2009
|
+
/**
|
|
2010
|
+
* Provides a mechanism for customizing form fields within editors.
|
|
2011
|
+
*/
|
|
1404
2012
|
readonly contentEditor: ContentEditorExtensionsBuilder;
|
|
2013
|
+
/**
|
|
2014
|
+
* Provides a mechanism for customizing Content Explorer.
|
|
2015
|
+
*/
|
|
1405
2016
|
readonly contentExplorer: ContentExplorerExtensionsBuilder;
|
|
2017
|
+
/**
|
|
2018
|
+
* Provides a mechanism for managing localization strings within extensions.
|
|
2019
|
+
*/
|
|
1406
2020
|
readonly translations: TranslationExtensionsBuilder;
|
|
2021
|
+
/**
|
|
2022
|
+
* Provides a mechanism for customizing Activities Explorer.
|
|
2023
|
+
*/
|
|
1407
2024
|
readonly activitiesExplorer: ActivitiesExplorerExtensionsBuilder;
|
|
2025
|
+
/**
|
|
2026
|
+
* Provides a mechanism for customizing Publishing Queue Explorer.
|
|
2027
|
+
*/
|
|
2028
|
+
readonly publishingQueueExplorer: PublishingQueueExplorerExtensionsBuilder;
|
|
1408
2029
|
build: () => ExtensionPoints;
|
|
1409
2030
|
}
|
|
1410
2031
|
|
|
@@ -1434,6 +2055,7 @@ export declare interface ExtensionPoints {
|
|
|
1434
2055
|
contentExplorer: ContentExplorerExtensions;
|
|
1435
2056
|
activitiesExplorer: ActivitiesExplorerExtensions;
|
|
1436
2057
|
translations: TranslationExtensions;
|
|
2058
|
+
publishingQueueExplorer: PublishingQueueExplorerExtensions;
|
|
1437
2059
|
}
|
|
1438
2060
|
|
|
1439
2061
|
/**
|
|
@@ -1469,8 +2091,17 @@ export declare interface FinishActivitiesRequest {
|
|
|
1469
2091
|
* @public
|
|
1470
2092
|
*/
|
|
1471
2093
|
export declare interface FinishActivitiesRequestData {
|
|
2094
|
+
/**
|
|
2095
|
+
* Array of Activity Instances to finish activity for.
|
|
2096
|
+
*/
|
|
1472
2097
|
activityInstances: ReadonlyArray<ActivityInstance>;
|
|
2098
|
+
/**
|
|
2099
|
+
* In case of choice fork Activity ID can be specified to be next one.
|
|
2100
|
+
*/
|
|
1473
2101
|
nextActivity?: Link_2;
|
|
2102
|
+
/**
|
|
2103
|
+
* User comment that will be added to finished Activity Instances.
|
|
2104
|
+
*/
|
|
1474
2105
|
message?: string;
|
|
1475
2106
|
}
|
|
1476
2107
|
|
|
@@ -1483,8 +2114,17 @@ export declare type FinishActivityMutationHook = (options?: MutationOptions<Fini
|
|
|
1483
2114
|
* @public
|
|
1484
2115
|
*/
|
|
1485
2116
|
export declare interface FinishActivityRequest {
|
|
2117
|
+
/**
|
|
2118
|
+
* ID of the Activity Instance to finish.
|
|
2119
|
+
*/
|
|
1486
2120
|
activityId: ItemUri;
|
|
2121
|
+
/**
|
|
2122
|
+
* In case of choice fork Activity ID can be specified to be next one.
|
|
2123
|
+
*/
|
|
1487
2124
|
nextActivity?: Link_2;
|
|
2125
|
+
/**
|
|
2126
|
+
* User comment that will be added to finished Activity Instances.
|
|
2127
|
+
*/
|
|
1488
2128
|
message?: string;
|
|
1489
2129
|
}
|
|
1490
2130
|
|
|
@@ -1497,7 +2137,13 @@ export declare type FinishEditingItemMutationHook = (options?: MutationOptions<R
|
|
|
1497
2137
|
* @public
|
|
1498
2138
|
*/
|
|
1499
2139
|
export declare interface FinishEditingItemRequest {
|
|
2140
|
+
/**
|
|
2141
|
+
* Item to finish editing on.
|
|
2142
|
+
*/
|
|
1500
2143
|
item: VersionedItem;
|
|
2144
|
+
/**
|
|
2145
|
+
* Container item of the item to finish.
|
|
2146
|
+
*/
|
|
1501
2147
|
containerItem?: IdentifiableObject;
|
|
1502
2148
|
}
|
|
1503
2149
|
|
|
@@ -1510,7 +2156,13 @@ export declare type FinishEditingItemsMutationHook = (options?: BatchMutationOpt
|
|
|
1510
2156
|
* @public
|
|
1511
2157
|
*/
|
|
1512
2158
|
export declare interface FinishItemsRequest {
|
|
2159
|
+
/**
|
|
2160
|
+
* Items to finish editing on.
|
|
2161
|
+
*/
|
|
1513
2162
|
items: ReadonlyArray<VersionedItem>;
|
|
2163
|
+
/**
|
|
2164
|
+
* Container item ID of the items to finish.
|
|
2165
|
+
*/
|
|
1514
2166
|
containerId: ItemUri;
|
|
1515
2167
|
}
|
|
1516
2168
|
|
|
@@ -1520,6 +2172,7 @@ export declare interface FinishItemsRequest {
|
|
|
1520
2172
|
*
|
|
1521
2173
|
* It is advisable to construct most of the layout using this component as it allows to freely utilize
|
|
1522
2174
|
* "shouldFill" and similar props that rely on the parent being a Flex component.
|
|
2175
|
+
*
|
|
1523
2176
|
* @public
|
|
1524
2177
|
*/
|
|
1525
2178
|
export declare const Flex: FlexComponent;
|
|
@@ -1588,9 +2241,21 @@ export declare interface FolderEditorApiStorage {
|
|
|
1588
2241
|
* @public
|
|
1589
2242
|
*/
|
|
1590
2243
|
export declare interface FolderEditorHookResult {
|
|
2244
|
+
/**
|
|
2245
|
+
* Editable Folder.
|
|
2246
|
+
*/
|
|
1591
2247
|
folder: Folder;
|
|
2248
|
+
/**
|
|
2249
|
+
* Folder's metadata schema.
|
|
2250
|
+
*/
|
|
1592
2251
|
metadataSchema: Schema;
|
|
2252
|
+
/**
|
|
2253
|
+
* Boolean that indicates that Folder has unsaved changes.
|
|
2254
|
+
*/
|
|
1593
2255
|
isChanged: boolean;
|
|
2256
|
+
/**
|
|
2257
|
+
* Boolean that indicates that Folder can be edited.
|
|
2258
|
+
*/
|
|
1594
2259
|
isEditing: boolean;
|
|
1595
2260
|
}
|
|
1596
2261
|
|
|
@@ -1639,12 +2304,12 @@ export declare interface GeneralComponentsApiStorage {
|
|
|
1639
2304
|
* @internal
|
|
1640
2305
|
*/
|
|
1641
2306
|
export declare interface GeneralGlobalsApiStorage {
|
|
1642
|
-
getBorderRadius:
|
|
1643
|
-
getColorPalette:
|
|
1644
|
-
getOpacityLevel:
|
|
1645
|
-
getSpacing:
|
|
1646
|
-
getTransitionDuration:
|
|
1647
|
-
getZIndex:
|
|
2307
|
+
getBorderRadius: BorderRadiusGetter;
|
|
2308
|
+
getColorPalette: ColorPaletteGetter;
|
|
2309
|
+
getOpacityLevel: OpacityLevelGetter;
|
|
2310
|
+
getSpacing: SpacingGetter;
|
|
2311
|
+
getTransitionDuration: TransitionDurationGetter;
|
|
2312
|
+
getZIndex: ZIndexGetter;
|
|
1648
2313
|
}
|
|
1649
2314
|
|
|
1650
2315
|
/**
|
|
@@ -1735,6 +2400,7 @@ export declare interface GeneralQueriesApiStorage {
|
|
|
1735
2400
|
useItemsToPublishQuery: ItemsToPublishQueryHook;
|
|
1736
2401
|
useItemsToUnpublishQuery: ItemsToUnpublishQueryHook;
|
|
1737
2402
|
usePublishableTargetTypesQuery: PublishableTargetTypesQueryHook;
|
|
2403
|
+
usePublishTransactionsQuery: PublishTransactionsQueryHook;
|
|
1738
2404
|
};
|
|
1739
2405
|
search: {
|
|
1740
2406
|
useSearchInContainerQuery: SearchInContainerQueryHook;
|
|
@@ -1748,73 +2414,52 @@ export declare interface GeneralQueriesApiStorage {
|
|
|
1748
2414
|
};
|
|
1749
2415
|
}
|
|
1750
2416
|
|
|
1751
|
-
/**
|
|
1752
|
-
* @public
|
|
1753
|
-
*/
|
|
1754
|
-
export declare type GetBorderRadius = () => BorderRadius;
|
|
1755
|
-
|
|
1756
2417
|
/**
|
|
1757
2418
|
* System-predefined border radiuses.
|
|
2419
|
+
*
|
|
1758
2420
|
* @public
|
|
1759
2421
|
*/
|
|
1760
|
-
export declare const getBorderRadius:
|
|
1761
|
-
|
|
1762
|
-
/**
|
|
1763
|
-
* @public
|
|
1764
|
-
*/
|
|
1765
|
-
export declare type GetColorPalette = () => ColorPalette;
|
|
2422
|
+
export declare const getBorderRadius: BorderRadiusGetter;
|
|
1766
2423
|
|
|
1767
2424
|
/**
|
|
1768
2425
|
* System-predefined color palette.
|
|
2426
|
+
*
|
|
1769
2427
|
* @public
|
|
1770
2428
|
*/
|
|
1771
|
-
export declare const getColorPalette:
|
|
1772
|
-
|
|
1773
|
-
declare type GetListBuilderItemId<TItem> = (item: TItem) => string;
|
|
2429
|
+
export declare const getColorPalette: ColorPaletteGetter;
|
|
1774
2430
|
|
|
1775
2431
|
/**
|
|
1776
|
-
* @
|
|
2432
|
+
* @internal
|
|
1777
2433
|
*/
|
|
1778
|
-
export declare type
|
|
2434
|
+
export declare type GetListBuilderItemId<TItem> = (item: TItem) => string;
|
|
1779
2435
|
|
|
1780
2436
|
/**
|
|
1781
2437
|
* System-predefined opacity levels.
|
|
2438
|
+
*
|
|
1782
2439
|
* @public
|
|
1783
2440
|
*/
|
|
1784
|
-
export declare const getOpacityLevel:
|
|
1785
|
-
|
|
1786
|
-
/**
|
|
1787
|
-
* @public
|
|
1788
|
-
*/
|
|
1789
|
-
export declare type GetSpacing = () => Spacing;
|
|
2441
|
+
export declare const getOpacityLevel: OpacityLevelGetter;
|
|
1790
2442
|
|
|
1791
2443
|
/**
|
|
1792
2444
|
* System-predefined spacings.
|
|
2445
|
+
*
|
|
1793
2446
|
* @public
|
|
1794
2447
|
*/
|
|
1795
|
-
export declare const getSpacing:
|
|
1796
|
-
|
|
1797
|
-
/**
|
|
1798
|
-
* @public
|
|
1799
|
-
*/
|
|
1800
|
-
export declare type GetTransitionDuration = () => TransitionDuration;
|
|
2448
|
+
export declare const getSpacing: SpacingGetter;
|
|
1801
2449
|
|
|
1802
2450
|
/**
|
|
1803
2451
|
* System-predefined transition duration.
|
|
2452
|
+
*
|
|
1804
2453
|
* @public
|
|
1805
2454
|
*/
|
|
1806
|
-
export declare const getTransitionDuration:
|
|
1807
|
-
|
|
1808
|
-
/**
|
|
1809
|
-
* @public
|
|
1810
|
-
*/
|
|
1811
|
-
export declare type GetZIndex = () => ZIndex;
|
|
2455
|
+
export declare const getTransitionDuration: TransitionDurationGetter;
|
|
1812
2456
|
|
|
1813
2457
|
/**
|
|
1814
2458
|
* System-predefined z-index values.
|
|
2459
|
+
*
|
|
1815
2460
|
* @public
|
|
1816
2461
|
*/
|
|
1817
|
-
export declare const getZIndex:
|
|
2462
|
+
export declare const getZIndex: ZIndexGetter;
|
|
1818
2463
|
|
|
1819
2464
|
/**
|
|
1820
2465
|
* @public
|
|
@@ -1827,12 +2472,16 @@ export declare interface HeaderExtensions {
|
|
|
1827
2472
|
* @public
|
|
1828
2473
|
*/
|
|
1829
2474
|
export declare class HeaderExtensionsBuilder {
|
|
2475
|
+
/**
|
|
2476
|
+
* Provides a mechanism for customizing navigation items.
|
|
2477
|
+
*/
|
|
1830
2478
|
readonly navigation: NavigationExtensionsBuilder;
|
|
1831
2479
|
build: () => HeaderExtensions;
|
|
1832
2480
|
}
|
|
1833
2481
|
|
|
1834
2482
|
/**
|
|
1835
2483
|
* A component used for rendering SVG icons.
|
|
2484
|
+
*
|
|
1836
2485
|
* @public
|
|
1837
2486
|
*/
|
|
1838
2487
|
export declare const Icon: IconComponent;
|
|
@@ -1869,49 +2518,120 @@ declare interface IconProps_2 extends SvgProps, Partial<IconDefaultProps> {
|
|
|
1869
2518
|
/**
|
|
1870
2519
|
* @public
|
|
1871
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
|
+
|
|
2559
|
+
/**
|
|
2560
|
+
* Checks whether the provided nodeId is the 'Favorites' node ID.
|
|
2561
|
+
*
|
|
2562
|
+
* @public
|
|
2563
|
+
*/
|
|
1872
2564
|
export declare const isFavoritesNodeId: (nodeId: string) => boolean;
|
|
1873
2565
|
|
|
1874
2566
|
/**
|
|
2567
|
+
* Checks whether the provided node is an item in the system.
|
|
2568
|
+
*
|
|
2569
|
+
* @example
|
|
2570
|
+
* Folder node returns `true`
|
|
2571
|
+
* Publication node returns `false`
|
|
2572
|
+
* Taxonomies node returns `false`
|
|
2573
|
+
*
|
|
1875
2574
|
* @public
|
|
1876
2575
|
*/
|
|
1877
2576
|
export declare const isItemNode: (node: ContentExplorerNode | undefined) => node is ContentExplorerItemNode;
|
|
1878
2577
|
|
|
1879
2578
|
/**
|
|
2579
|
+
* Checks if an item in a node, given as the first parameter,
|
|
2580
|
+
* is an instance of a constructor, provided as the second parameter.
|
|
2581
|
+
*
|
|
2582
|
+
* @param node - The node to check.
|
|
2583
|
+
* @param ctor - The constructor to compare against.
|
|
2584
|
+
* @returns Boolean value indicating whether the item node is an instance of the constructor.
|
|
2585
|
+
*
|
|
1880
2586
|
* @public
|
|
1881
2587
|
*/
|
|
1882
2588
|
export declare const isItemNodeOfType: <TItem extends IdentifiableObject>(node: ContentExplorerNode | undefined, ctor: Constructor<TItem>) => node is ContentExplorerItemNode<TItem>;
|
|
1883
2589
|
|
|
1884
2590
|
/**
|
|
2591
|
+
* Checks whether the provided node is the 'Items in Progress' node.
|
|
2592
|
+
*
|
|
1885
2593
|
* @public
|
|
1886
2594
|
*/
|
|
1887
2595
|
export declare const isItemsInProgressNode: (node: ContentExplorerNode) => boolean;
|
|
1888
2596
|
|
|
1889
2597
|
/**
|
|
2598
|
+
* Checks whether the provided nodeId is the 'Items in Progress' node ID.
|
|
2599
|
+
*
|
|
1890
2600
|
* @public
|
|
1891
2601
|
*/
|
|
1892
2602
|
export declare const isItemsInProgressNodeId: (nodeId: string) => boolean;
|
|
1893
2603
|
|
|
1894
2604
|
/**
|
|
2605
|
+
* Checks whether the provided node is the 'Publications' node.
|
|
2606
|
+
*
|
|
1895
2607
|
* @public
|
|
1896
2608
|
*/
|
|
1897
2609
|
export declare const isPublicationsNode: (node: ContentExplorerNode) => boolean;
|
|
1898
2610
|
|
|
1899
2611
|
/**
|
|
2612
|
+
* Checks whether the provided nodeId is the 'Publications' node ID
|
|
2613
|
+
*
|
|
1900
2614
|
* @public
|
|
1901
2615
|
*/
|
|
1902
2616
|
export declare const isPublicationsNodeId: (nodeId: string) => boolean;
|
|
1903
2617
|
|
|
1904
2618
|
/**
|
|
2619
|
+
* Checks whether the provided node is the 'Root' node.
|
|
2620
|
+
*
|
|
1905
2621
|
* @public
|
|
1906
2622
|
*/
|
|
1907
2623
|
export declare const isRootNode: (node: ContentExplorerNode) => boolean;
|
|
1908
2624
|
|
|
1909
2625
|
/**
|
|
2626
|
+
* Checks whether the provided nodeId is the 'Root' node ID.
|
|
2627
|
+
*
|
|
1910
2628
|
* @public
|
|
1911
2629
|
*/
|
|
1912
2630
|
export declare const isRootNodeId: (nodeId: string) => boolean;
|
|
1913
2631
|
|
|
1914
2632
|
/**
|
|
2633
|
+
* Checks whether the provided node is the 'System' node.
|
|
2634
|
+
*
|
|
1915
2635
|
* @public
|
|
1916
2636
|
*/
|
|
1917
2637
|
export declare const isSystemNode: (node: ContentExplorerNode) => boolean;
|
|
@@ -1925,6 +2645,9 @@ export declare type ItemBlueprintHierarchyQueryHook = (props: ItemBlueprintHiera
|
|
|
1925
2645
|
* @public
|
|
1926
2646
|
*/
|
|
1927
2647
|
export declare interface ItemBlueprintHierarchyQueryProps {
|
|
2648
|
+
/**
|
|
2649
|
+
* Identifies the item for which Blueprint hierarchy is being retrieved.
|
|
2650
|
+
*/
|
|
1928
2651
|
itemId: ItemUri;
|
|
1929
2652
|
}
|
|
1930
2653
|
|
|
@@ -1988,6 +2711,9 @@ export declare type ItemDefaultDataQueryHook = <TItem extends IdentifiableObject
|
|
|
1988
2711
|
* @public
|
|
1989
2712
|
*/
|
|
1990
2713
|
export declare interface ItemDefaultDataQueryProps {
|
|
2714
|
+
/**
|
|
2715
|
+
* Type of the model to get default data for.
|
|
2716
|
+
*/
|
|
1991
2717
|
modelType: DefaultModelType;
|
|
1992
2718
|
}
|
|
1993
2719
|
|
|
@@ -2000,6 +2726,9 @@ export declare type ItemHistoryQueryHook = (props: ItemHistoryQueryProps | undef
|
|
|
2000
2726
|
* @public
|
|
2001
2727
|
*/
|
|
2002
2728
|
export declare interface ItemHistoryQueryProps {
|
|
2729
|
+
/**
|
|
2730
|
+
* Identifies the item for which History is being retrieved.
|
|
2731
|
+
*/
|
|
2003
2732
|
itemId: ItemUri;
|
|
2004
2733
|
}
|
|
2005
2734
|
|
|
@@ -2012,6 +2741,9 @@ export declare type ItemPublishedPagesQueryHook = (props: ItemPublishedPagesQuer
|
|
|
2012
2741
|
* @public
|
|
2013
2742
|
*/
|
|
2014
2743
|
export declare interface ItemPublishedPagesQueryProps {
|
|
2744
|
+
/**
|
|
2745
|
+
* Identifies the item for which published pages will be requested.
|
|
2746
|
+
*/
|
|
2015
2747
|
itemId: ItemUri;
|
|
2016
2748
|
}
|
|
2017
2749
|
|
|
@@ -2024,6 +2756,9 @@ export declare type ItemPublishedToQueryHook = (props: ItemPublishedToQueryProps
|
|
|
2024
2756
|
* @public
|
|
2025
2757
|
*/
|
|
2026
2758
|
export declare interface ItemPublishedToQueryProps {
|
|
2759
|
+
/**
|
|
2760
|
+
* ID of the published item.
|
|
2761
|
+
*/
|
|
2027
2762
|
itemId: ItemUri;
|
|
2028
2763
|
}
|
|
2029
2764
|
|
|
@@ -2036,6 +2771,9 @@ export declare type ItemPublishUrlsQueryHook = (props: ItemPublishUrlsQueryProps
|
|
|
2036
2771
|
* @public
|
|
2037
2772
|
*/
|
|
2038
2773
|
export declare interface ItemPublishUrlsQueryProps {
|
|
2774
|
+
/**
|
|
2775
|
+
* Identifies the item for which Publish URLs are being retrieved.
|
|
2776
|
+
*/
|
|
2039
2777
|
itemId: ItemUri;
|
|
2040
2778
|
}
|
|
2041
2779
|
|
|
@@ -2048,7 +2786,13 @@ export declare type ItemQueryHook = <TItem extends IdentifiableObject>(props: It
|
|
|
2048
2786
|
* @public
|
|
2049
2787
|
*/
|
|
2050
2788
|
export declare interface ItemQueryProps {
|
|
2789
|
+
/**
|
|
2790
|
+
* ID of an item to get.
|
|
2791
|
+
*/
|
|
2051
2792
|
itemId: ItemUri;
|
|
2793
|
+
/**
|
|
2794
|
+
* Option to request dynamic item (v0) if it's available.
|
|
2795
|
+
*/
|
|
2052
2796
|
useDynamicVersion?: boolean;
|
|
2053
2797
|
}
|
|
2054
2798
|
|
|
@@ -2061,8 +2805,19 @@ export declare type ItemsInProgressQueryHook = (props?: ItemsInProgressQueryProp
|
|
|
2061
2805
|
* @public
|
|
2062
2806
|
*/
|
|
2063
2807
|
export declare interface ItemsInProgressQueryProps {
|
|
2808
|
+
/**
|
|
2809
|
+
* Option to include items that are in progress by any user, but only in Publications where the user has Publication Administration or Lock Management Rights (unless the user has System Administration privileges).
|
|
2810
|
+
* By default, only items locked by the current user are returned.
|
|
2811
|
+
*/
|
|
2064
2812
|
forAllUsers?: boolean;
|
|
2813
|
+
/**
|
|
2814
|
+
* Specifies the maximum number of results to return.
|
|
2815
|
+
*/
|
|
2065
2816
|
maxResults?: number;
|
|
2817
|
+
/**
|
|
2818
|
+
* Option to filter results by specified user id.
|
|
2819
|
+
*/
|
|
2820
|
+
lockUserId?: ItemUri;
|
|
2066
2821
|
}
|
|
2067
2822
|
|
|
2068
2823
|
/**
|
|
@@ -2074,8 +2829,21 @@ export declare type ItemsQueryHook = <TItem extends IdentifiableObject>(props: I
|
|
|
2074
2829
|
* @public
|
|
2075
2830
|
*/
|
|
2076
2831
|
export declare interface ItemsQueryProps {
|
|
2832
|
+
/**
|
|
2833
|
+
* IDs of items to request.
|
|
2834
|
+
*/
|
|
2077
2835
|
itemIds: ReadonlyArray<ItemUri>;
|
|
2836
|
+
/**
|
|
2837
|
+
* Option to request dynamic item (v0) if it's available.
|
|
2838
|
+
*/
|
|
2078
2839
|
useDynamicVersion?: boolean;
|
|
2840
|
+
/**
|
|
2841
|
+
* By default list includes contentless items. Some of the properties might be missed.
|
|
2842
|
+
* This option allows to include all available fields.
|
|
2843
|
+
*
|
|
2844
|
+
* @example
|
|
2845
|
+
* When `false` - Component item will be returned without `content` property.
|
|
2846
|
+
*/
|
|
2079
2847
|
loadFullItems?: boolean;
|
|
2080
2848
|
}
|
|
2081
2849
|
|
|
@@ -2098,6 +2866,9 @@ export declare type ItemTranslationInfoQueryHook = (props: ItemTranslationInfoQu
|
|
|
2098
2866
|
* @public
|
|
2099
2867
|
*/
|
|
2100
2868
|
export declare interface ItemTranslationInfoQueryProps {
|
|
2869
|
+
/**
|
|
2870
|
+
* Identifies the item for which Translation Info is being retrieved.
|
|
2871
|
+
*/
|
|
2101
2872
|
itemId: ItemUri;
|
|
2102
2873
|
}
|
|
2103
2874
|
|
|
@@ -2110,6 +2881,9 @@ export declare type ItemUsedByQueryHook = <TItem extends IdentifiableObject>(pro
|
|
|
2110
2881
|
* @public
|
|
2111
2882
|
*/
|
|
2112
2883
|
export declare interface ItemUsedByQueryProps {
|
|
2884
|
+
/**
|
|
2885
|
+
* Identifies the item for which 'Used By' dependencies are being retrieved.
|
|
2886
|
+
*/
|
|
2113
2887
|
itemId: ItemUri;
|
|
2114
2888
|
}
|
|
2115
2889
|
|
|
@@ -2122,6 +2896,9 @@ export declare type ItemUsesQueryHook = <TItem extends IdentifiableObject>(props
|
|
|
2122
2896
|
* @public
|
|
2123
2897
|
*/
|
|
2124
2898
|
export declare interface ItemUsesQueryProps {
|
|
2899
|
+
/**
|
|
2900
|
+
* Identifies the item for which 'Uses' dependencies are being retrieved.
|
|
2901
|
+
*/
|
|
2125
2902
|
itemId: ItemUri;
|
|
2126
2903
|
}
|
|
2127
2904
|
|
|
@@ -2136,9 +2913,21 @@ export declare interface KeywordEditorApiStorage {
|
|
|
2136
2913
|
* @public
|
|
2137
2914
|
*/
|
|
2138
2915
|
export declare interface KeywordEditorHookResult {
|
|
2916
|
+
/**
|
|
2917
|
+
* Editable Keyword.
|
|
2918
|
+
*/
|
|
2139
2919
|
keyword: Keyword;
|
|
2920
|
+
/**
|
|
2921
|
+
* Keyword's metadata schema.
|
|
2922
|
+
*/
|
|
2140
2923
|
metadataSchema: Schema;
|
|
2924
|
+
/**
|
|
2925
|
+
* Boolean that indicates that Keyword has unsaved changes.
|
|
2926
|
+
*/
|
|
2141
2927
|
isChanged: boolean;
|
|
2928
|
+
/**
|
|
2929
|
+
* Boolean that indicates that Keyword can be edited.
|
|
2930
|
+
*/
|
|
2142
2931
|
isEditing: boolean;
|
|
2143
2932
|
}
|
|
2144
2933
|
|
|
@@ -2150,12 +2939,15 @@ export declare interface KeywordEditorHooksApiStorage {
|
|
|
2150
2939
|
}
|
|
2151
2940
|
|
|
2152
2941
|
/**
|
|
2942
|
+
* All built-in language codes available in the system.
|
|
2943
|
+
*
|
|
2153
2944
|
* @public
|
|
2154
2945
|
*/
|
|
2155
2946
|
export declare type LanguageCode = 'de' | 'en' | 'es' | 'fr' | 'nl' | 'zh' | 'ja';
|
|
2156
2947
|
|
|
2157
2948
|
/**
|
|
2158
2949
|
* A component to wrap any custom view with Link for navigation
|
|
2950
|
+
*
|
|
2159
2951
|
* @public
|
|
2160
2952
|
*/
|
|
2161
2953
|
export declare const Link: LinkComponent;
|
|
@@ -2166,15 +2958,27 @@ export declare const Link: LinkComponent;
|
|
|
2166
2958
|
export declare type LinkComponent = FunctionComponent<LinkProps>;
|
|
2167
2959
|
|
|
2168
2960
|
/**
|
|
2169
|
-
* @
|
|
2170
|
-
*
|
|
2171
|
-
* @param to - string that represents valid path to external or internal source. Relative path always starts with `/`, otherwise it's treated as full path. Relative to the current directory path is not supported (ex. `subfolder`).
|
|
2172
|
-
* @example `/explorer` or `https://www.website.com`.
|
|
2961
|
+
* @public
|
|
2173
2962
|
*/
|
|
2174
2963
|
export declare interface LinkProps {
|
|
2964
|
+
/**
|
|
2965
|
+
* String that represents a valid path to the external or internal source. The relative path always starts with `/`, otherwise it's treated as an absolute path.
|
|
2966
|
+
* Relative to the current directory path is not supported (ex. `subfolder`).
|
|
2967
|
+
*
|
|
2968
|
+
* @example `/explorer` or `https://www.website.com`.
|
|
2969
|
+
*/
|
|
2175
2970
|
to: string;
|
|
2971
|
+
/**
|
|
2972
|
+
* Boolean that indicates whether a link should be opened in new tab.
|
|
2973
|
+
*/
|
|
2176
2974
|
openInNewTab?: boolean;
|
|
2975
|
+
/**
|
|
2976
|
+
* String that is shown as tooltip on hover.
|
|
2977
|
+
*/
|
|
2177
2978
|
tooltip?: string;
|
|
2979
|
+
/**
|
|
2980
|
+
* The content to be rendered inside the Link component.
|
|
2981
|
+
*/
|
|
2178
2982
|
children?: ReactNode;
|
|
2179
2983
|
}
|
|
2180
2984
|
|
|
@@ -2190,9 +2994,15 @@ declare class ListBuilder<TItem> {
|
|
|
2190
2994
|
build: () => ReadonlyArray<ListBuilderConfigurationExtension<TItem>>;
|
|
2191
2995
|
}
|
|
2192
2996
|
|
|
2193
|
-
|
|
2997
|
+
/**
|
|
2998
|
+
* @internal
|
|
2999
|
+
*/
|
|
3000
|
+
export declare type ListBuilderConfiguration<TItem> = TItem[];
|
|
2194
3001
|
|
|
2195
|
-
|
|
3002
|
+
/**
|
|
3003
|
+
* @internal
|
|
3004
|
+
*/
|
|
3005
|
+
export declare type ListBuilderConfigurationExtension<TItem> = (currentList: ListBuilderConfiguration<TItem>, defaultList: ListBuilderConfiguration<TItem>) => void;
|
|
2196
3006
|
|
|
2197
3007
|
/**
|
|
2198
3008
|
* @public
|
|
@@ -2214,7 +3024,13 @@ export declare type LocalizeItemMutationHook = (options?: MutationOptions<Reposi
|
|
|
2214
3024
|
* @public
|
|
2215
3025
|
*/
|
|
2216
3026
|
export declare interface LocalizeItemRequest {
|
|
3027
|
+
/**
|
|
3028
|
+
* ID of an item to localize.
|
|
3029
|
+
*/
|
|
2217
3030
|
itemId: ItemUri;
|
|
3031
|
+
/**
|
|
3032
|
+
* Container item of the item to localize.
|
|
3033
|
+
*/
|
|
2218
3034
|
containerItem?: IdentifiableObject;
|
|
2219
3035
|
}
|
|
2220
3036
|
|
|
@@ -2227,7 +3043,13 @@ export declare type LocalizeItemsMutationHook = (options?: BatchMutationOptions<
|
|
|
2227
3043
|
* @public
|
|
2228
3044
|
*/
|
|
2229
3045
|
export declare interface LocalizeItemsRequest {
|
|
3046
|
+
/**
|
|
3047
|
+
* IDs of items to localize.
|
|
3048
|
+
*/
|
|
2230
3049
|
itemIds: ReadonlyArray<ItemUri>;
|
|
3050
|
+
/**
|
|
3051
|
+
* Container item ID of the items to localize.
|
|
3052
|
+
*/
|
|
2231
3053
|
containerId: ItemUri;
|
|
2232
3054
|
}
|
|
2233
3055
|
|
|
@@ -2245,8 +3067,17 @@ export declare type MoveItemMutationHook = (options?: MutationOptions<Repository
|
|
|
2245
3067
|
* @public
|
|
2246
3068
|
*/
|
|
2247
3069
|
export declare interface MoveItemRequest {
|
|
3070
|
+
/**
|
|
3071
|
+
* ID of an item to move.
|
|
3072
|
+
*/
|
|
2248
3073
|
itemId: ItemUri;
|
|
3074
|
+
/**
|
|
3075
|
+
* ID of organizational item to move to.
|
|
3076
|
+
*/
|
|
2249
3077
|
destinationId: ItemUri;
|
|
3078
|
+
/**
|
|
3079
|
+
* ID of organizational item to move from.
|
|
3080
|
+
*/
|
|
2250
3081
|
sourceId: ItemUri;
|
|
2251
3082
|
}
|
|
2252
3083
|
|
|
@@ -2259,8 +3090,17 @@ export declare type MoveItemsMutationHook = (options?: BatchMutationOptions<Move
|
|
|
2259
3090
|
* @public
|
|
2260
3091
|
*/
|
|
2261
3092
|
export declare interface MoveItemsRequest {
|
|
3093
|
+
/**
|
|
3094
|
+
* IDs of items to move.
|
|
3095
|
+
*/
|
|
2262
3096
|
itemIds: ReadonlyArray<ItemUri>;
|
|
3097
|
+
/**
|
|
3098
|
+
* ID of organizational item to move to.
|
|
3099
|
+
*/
|
|
2263
3100
|
destinationId: ItemUri;
|
|
3101
|
+
/**
|
|
3102
|
+
* ID of organizational item to move from.
|
|
3103
|
+
*/
|
|
2264
3104
|
sourceId: ItemUri;
|
|
2265
3105
|
}
|
|
2266
3106
|
|
|
@@ -2268,7 +3108,13 @@ export declare interface MoveItemsRequest {
|
|
|
2268
3108
|
* @public
|
|
2269
3109
|
*/
|
|
2270
3110
|
export declare interface MultimediaUploadResult {
|
|
3111
|
+
/**
|
|
3112
|
+
* Link to the created component with uploaded File.
|
|
3113
|
+
*/
|
|
2271
3114
|
componentLink?: Link_2;
|
|
3115
|
+
/**
|
|
3116
|
+
* In case `componentLink` is not created error will be fulfilled.
|
|
3117
|
+
*/
|
|
2272
3118
|
error?: ApiError | Error;
|
|
2273
3119
|
}
|
|
2274
3120
|
|
|
@@ -2291,13 +3137,37 @@ export declare interface MutateOptions<TData = unknown, TError = unknown, TVaria
|
|
|
2291
3137
|
*/
|
|
2292
3138
|
export declare interface MutationOptions<TData = unknown, TError = unknown, TVariables = void> {
|
|
2293
3139
|
variables?: TVariables;
|
|
3140
|
+
/**
|
|
3141
|
+
* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive.
|
|
3142
|
+
* */
|
|
2294
3143
|
onMutate?: (variables: TVariables) => Promise<void> | void;
|
|
3144
|
+
/**
|
|
3145
|
+
* This function will fire when the mutation is successful and will be passed the mutation's result.
|
|
3146
|
+
* */
|
|
2295
3147
|
onSuccess?: (data: TData, variables: TVariables) => Promise<void> | void;
|
|
3148
|
+
/**
|
|
3149
|
+
* This function will fire if the mutation encounters an error and will be passed the error.
|
|
3150
|
+
* */
|
|
2296
3151
|
onError?: (error: TError, variables: TVariables) => Promise<void> | void;
|
|
3152
|
+
/**
|
|
3153
|
+
* This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error.
|
|
3154
|
+
* */
|
|
2297
3155
|
onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables) => Promise<void> | void;
|
|
3156
|
+
/**
|
|
3157
|
+
* Defaults to 0.
|
|
3158
|
+
* - If `false`, failed mutations will not retry.
|
|
3159
|
+
* - If `true`, failed mutations will retry infinitely.
|
|
3160
|
+
* - If set to a number, e.g. 3, failed mutations will retry until the failed mutations count meets that number.
|
|
3161
|
+
*/
|
|
2298
3162
|
retry?: boolean | number | ((failureCount: number, error: TError) => boolean);
|
|
3163
|
+
/**
|
|
3164
|
+
* This function receives a retryAttempt integer and the actual Error and returns the delay to apply before the next attempt in milliseconds. Alternatively, you can pass the delay in milliseconds.
|
|
3165
|
+
*/
|
|
2299
3166
|
retryDelay?: number | ((failureCount: number, error: TError) => number);
|
|
2300
3167
|
cacheTime?: number;
|
|
3168
|
+
/**
|
|
3169
|
+
* If set, it stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever the mutation is available (eg. onError, onSuccess functions of the MutationCache).
|
|
3170
|
+
*/
|
|
2301
3171
|
meta?: Record<string, unknown>;
|
|
2302
3172
|
}
|
|
2303
3173
|
|
|
@@ -2313,23 +3183,61 @@ export declare interface MutationResponse {
|
|
|
2313
3183
|
* @public
|
|
2314
3184
|
*/
|
|
2315
3185
|
export declare interface MutationResult<TData = unknown, TError = unknown, TVariables = unknown> {
|
|
3186
|
+
/**
|
|
3187
|
+
* The mutation function to call with variables to trigger the mutation and optionally override options passed to useMutation.
|
|
3188
|
+
*/
|
|
2316
3189
|
mutate: (...args: Parameters<MutateFunction<TData, TError, TVariables>>) => void;
|
|
3190
|
+
/**
|
|
3191
|
+
* Similar to mutate but returns a promise which can be awaited.
|
|
3192
|
+
*/
|
|
2317
3193
|
mutateAsync: MutateFunction<TData, TError, TVariables>;
|
|
3194
|
+
/**
|
|
3195
|
+
* Is `true` when status is `error`.
|
|
3196
|
+
*/
|
|
2318
3197
|
isError: boolean;
|
|
3198
|
+
/**
|
|
3199
|
+
* Is `true` when status is `idle`.
|
|
3200
|
+
*/
|
|
2319
3201
|
isIdle: boolean;
|
|
3202
|
+
/**
|
|
3203
|
+
* Is `true` when status is `loading`.
|
|
3204
|
+
*/
|
|
2320
3205
|
isLoading: boolean;
|
|
3206
|
+
/**
|
|
3207
|
+
* Is `true` when status is `success`.
|
|
3208
|
+
*/
|
|
2321
3209
|
isSuccess: boolean;
|
|
3210
|
+
/**
|
|
3211
|
+
* A function to clean the mutation internal state (i.e., it resets the mutation to its initial state).
|
|
3212
|
+
*/
|
|
2322
3213
|
reset: () => void;
|
|
3214
|
+
/**
|
|
3215
|
+
* The last successfully resolved data for the query.
|
|
3216
|
+
*/
|
|
2323
3217
|
data: TData | undefined;
|
|
3218
|
+
/**
|
|
3219
|
+
* The error object for the query, if an error was encountered.
|
|
3220
|
+
*/
|
|
2324
3221
|
error: TError | null;
|
|
2325
3222
|
failureCount: number;
|
|
2326
3223
|
failureReason: TError | null;
|
|
2327
3224
|
isPaused: boolean;
|
|
3225
|
+
/**
|
|
3226
|
+
* - `idle` initial status prior to the mutation function executing.
|
|
3227
|
+
* - `loading` if the mutation is currently executing.
|
|
3228
|
+
* - `error` if the last mutation attempt resulted in an error.
|
|
3229
|
+
* - `success` if the last mutation attempt was successful.
|
|
3230
|
+
*/
|
|
2328
3231
|
status: MutationStatus;
|
|
2329
3232
|
variables: TVariables | undefined;
|
|
2330
3233
|
}
|
|
2331
3234
|
|
|
2332
3235
|
/**
|
|
3236
|
+
* - `idle` initial status prior to the mutation function executing.
|
|
3237
|
+
* - `loading` if the mutation is currently executing.
|
|
3238
|
+
* - `error` if the last mutation attempt resulted in an error.
|
|
3239
|
+
* - `success` if the last mutation attempt was successful.
|
|
3240
|
+
*
|
|
2333
3241
|
* @public
|
|
2334
3242
|
*/
|
|
2335
3243
|
export declare type MutationStatus = 'idle' | 'loading' | 'success' | 'error';
|
|
@@ -2347,7 +3255,19 @@ export declare interface NavigationExtensions {
|
|
|
2347
3255
|
*/
|
|
2348
3256
|
export declare class NavigationExtensionsBuilder {
|
|
2349
3257
|
private _navigationItemExtensions;
|
|
3258
|
+
/**
|
|
3259
|
+
* Provides a mechanism for customizing the configuration of navigation items.
|
|
3260
|
+
*/
|
|
2350
3261
|
readonly config: ListBuilder<string>;
|
|
3262
|
+
/**
|
|
3263
|
+
* Registers a new navigation item.
|
|
3264
|
+
*
|
|
3265
|
+
* @remarks
|
|
3266
|
+
* This method only registers the navigation item and does not automatically make it visible in the application.
|
|
3267
|
+
* To add the navigation item to the application, use {@link NavigationExtensionsBuilder.config}.
|
|
3268
|
+
*
|
|
3269
|
+
* @param item - navigation item to be registered
|
|
3270
|
+
*/
|
|
2351
3271
|
register: (item: NavigationItemExtension) => this;
|
|
2352
3272
|
build: () => NavigationExtensions;
|
|
2353
3273
|
}
|
|
@@ -2362,19 +3282,20 @@ export declare type NavigationItemExtension = () => NavigationItemExtensionConfi
|
|
|
2362
3282
|
*/
|
|
2363
3283
|
export declare interface NavigationItemExtensionConfiguration {
|
|
2364
3284
|
/**
|
|
2365
|
-
*
|
|
3285
|
+
* A unique identifier for the navigation item.
|
|
2366
3286
|
*/
|
|
2367
3287
|
readonly id: string;
|
|
2368
3288
|
/**
|
|
2369
|
-
*
|
|
3289
|
+
* The route path associated with the navigation item.
|
|
2370
3290
|
*/
|
|
2371
3291
|
readonly routePath: string;
|
|
2372
3292
|
/**
|
|
2373
|
-
*
|
|
3293
|
+
* The component to be rendered when the path in the browser address bar matches
|
|
3294
|
+
* the specified {@link NavigationItemExtensionConfiguration.routePath}.
|
|
2374
3295
|
*/
|
|
2375
3296
|
readonly routeComponent: ComponentType;
|
|
2376
3297
|
/**
|
|
2377
|
-
* Hook
|
|
3298
|
+
* Hook that contains behavior of the navigation item.
|
|
2378
3299
|
*/
|
|
2379
3300
|
readonly useNavigationItem: NavigationItemHook;
|
|
2380
3301
|
}
|
|
@@ -2382,25 +3303,33 @@ export declare interface NavigationItemExtensionConfiguration {
|
|
|
2382
3303
|
/**
|
|
2383
3304
|
* @public
|
|
2384
3305
|
*/
|
|
2385
|
-
export declare type NavigationItemHook = () =>
|
|
3306
|
+
export declare type NavigationItemHook = () => NavigationItemHookResult;
|
|
3307
|
+
|
|
3308
|
+
/**
|
|
3309
|
+
* @public
|
|
3310
|
+
*/
|
|
3311
|
+
export declare interface NavigationItemHookResult {
|
|
2386
3312
|
/**
|
|
2387
|
-
*
|
|
3313
|
+
* Indicates the visibility of the item in the navigation menu and determines
|
|
3314
|
+
* whether its corresponding page is available.
|
|
2388
3315
|
*/
|
|
2389
3316
|
readonly isAvailable: boolean;
|
|
2390
3317
|
/**
|
|
2391
|
-
*
|
|
3318
|
+
* Label associated with the navigation item.
|
|
2392
3319
|
*/
|
|
2393
3320
|
readonly label: string;
|
|
2394
3321
|
/**
|
|
2395
|
-
*
|
|
3322
|
+
* A component used for custom rendering of {@link NavigationItemHookResult.label}.
|
|
2396
3323
|
*/
|
|
2397
3324
|
readonly renderLabel?: ComponentType<NavigationItemRenderLabel>;
|
|
2398
3325
|
/**
|
|
2399
|
-
* Tooltip displayed
|
|
2400
|
-
*
|
|
3326
|
+
* Tooltip displayed when hovering over the navigation item.
|
|
3327
|
+
*
|
|
3328
|
+
* @remarks
|
|
3329
|
+
* If not provided, {@link NavigationItemHookResult.label} property is used instead of it.
|
|
2401
3330
|
*/
|
|
2402
3331
|
readonly tooltip?: string;
|
|
2403
|
-
}
|
|
3332
|
+
}
|
|
2404
3333
|
|
|
2405
3334
|
/**
|
|
2406
3335
|
* @public
|
|
@@ -2408,24 +3337,27 @@ export declare type NavigationItemHook = () => {
|
|
|
2408
3337
|
export declare type NavigationItemId = ValuesOfArray<typeof navigationItemIds>;
|
|
2409
3338
|
|
|
2410
3339
|
/**
|
|
3340
|
+
* All available built-in navigation item IDs.
|
|
3341
|
+
*
|
|
2411
3342
|
* @public
|
|
2412
3343
|
*/
|
|
2413
3344
|
export declare const navigationItemId: {
|
|
2414
3345
|
activitiesExplorer: "activitiesExplorer";
|
|
2415
3346
|
contentExplorer: "contentExplorer";
|
|
3347
|
+
publishingQueueExplorer: "publishingQueueExplorer";
|
|
2416
3348
|
};
|
|
2417
3349
|
|
|
2418
3350
|
/**
|
|
2419
3351
|
* @public
|
|
2420
3352
|
*/
|
|
2421
|
-
export declare const navigationItemIds: readonly ["activitiesExplorer", "contentExplorer"];
|
|
3353
|
+
export declare const navigationItemIds: readonly ["activitiesExplorer", "contentExplorer", "publishingQueueExplorer"];
|
|
2422
3354
|
|
|
2423
3355
|
/**
|
|
2424
3356
|
* @public
|
|
2425
3357
|
*/
|
|
2426
3358
|
export declare interface NavigationItemRenderLabel {
|
|
2427
3359
|
/**
|
|
2428
|
-
*
|
|
3360
|
+
* The label obtained from {@link NavigationItemHookResult.label}.
|
|
2429
3361
|
*/
|
|
2430
3362
|
readonly label: string;
|
|
2431
3363
|
}
|
|
@@ -2439,6 +3371,11 @@ export declare type NotificationsHook = () => NotificationsHookResult;
|
|
|
2439
3371
|
* @public
|
|
2440
3372
|
*/
|
|
2441
3373
|
export declare interface NotificationsHookResult {
|
|
3374
|
+
/**
|
|
3375
|
+
* Method to show a new notification.
|
|
3376
|
+
*
|
|
3377
|
+
* @param args - options to customize notification.
|
|
3378
|
+
*/
|
|
2442
3379
|
notify: (args: NotifyArguments) => void;
|
|
2443
3380
|
}
|
|
2444
3381
|
|
|
@@ -2451,9 +3388,27 @@ export declare type NotificationType = 'error' | 'info' | 'success' | 'warning';
|
|
|
2451
3388
|
* @public
|
|
2452
3389
|
*/
|
|
2453
3390
|
export declare interface NotifyArguments {
|
|
3391
|
+
/**
|
|
3392
|
+
* Type defines styling of the message.
|
|
3393
|
+
*
|
|
3394
|
+
* Depending on intention of the message one of the values can be used:
|
|
3395
|
+
* - `error` - in cases error occurred, operation failed.
|
|
3396
|
+
* - `info` - general information for the user.
|
|
3397
|
+
* - `success` - report about success of the operation.
|
|
3398
|
+
* - `warning` - information that user needs to pay attention to.
|
|
3399
|
+
*/
|
|
2454
3400
|
type: NotificationType;
|
|
3401
|
+
/**
|
|
3402
|
+
* Notification's title.
|
|
3403
|
+
*/
|
|
2455
3404
|
title: string;
|
|
3405
|
+
/**
|
|
3406
|
+
* Detailed notification message.
|
|
3407
|
+
*/
|
|
2456
3408
|
description?: string;
|
|
3409
|
+
/**
|
|
3410
|
+
* Option to store notification in Message Center.
|
|
3411
|
+
*/
|
|
2457
3412
|
showInMessageCenter?: boolean;
|
|
2458
3413
|
}
|
|
2459
3414
|
|
|
@@ -2474,6 +3429,11 @@ declare const opacityLevel: {
|
|
|
2474
3429
|
|
|
2475
3430
|
declare type OpacityLevel_2 = keyof typeof opacityLevel;
|
|
2476
3431
|
|
|
3432
|
+
/**
|
|
3433
|
+
* @public
|
|
3434
|
+
*/
|
|
3435
|
+
export declare type OpacityLevelGetter = () => OpacityLevel;
|
|
3436
|
+
|
|
2477
3437
|
/**
|
|
2478
3438
|
* @public
|
|
2479
3439
|
*/
|
|
@@ -2499,66 +3459,166 @@ declare interface OpacityProps_2 {
|
|
|
2499
3459
|
}
|
|
2500
3460
|
|
|
2501
3461
|
/**
|
|
3462
|
+
* Hook for accessing Activities Explorer data when available.
|
|
3463
|
+
*
|
|
3464
|
+
* @remarks
|
|
3465
|
+
* Safe to be used within or outside of the Activities Explorer.
|
|
3466
|
+
* `undefined` is returned when used outside of Activities Explorer.
|
|
3467
|
+
*
|
|
2502
3468
|
* @public
|
|
2503
3469
|
*/
|
|
2504
3470
|
export declare type OptionalActivitiesExplorerHook = () => ActivitiesExplorerHookResult | undefined;
|
|
2505
3471
|
|
|
2506
3472
|
/**
|
|
3473
|
+
* Hook for accessing Activities Explorer Table data and methods when available.
|
|
3474
|
+
*
|
|
3475
|
+
* @remarks
|
|
3476
|
+
* Safe to be used within or outside of the Activities Explorer Table.
|
|
3477
|
+
* `undefined` is returned when used outside of the Activities Explorer Table.
|
|
3478
|
+
*
|
|
2507
3479
|
* @public
|
|
2508
3480
|
*/
|
|
2509
3481
|
export declare type OptionalActivitiesExplorerTableHook = () => ActivitiesExplorerTableHookResult | undefined;
|
|
2510
3482
|
|
|
2511
3483
|
/**
|
|
3484
|
+
* Hook for accessing Bundle Editor state when available.
|
|
3485
|
+
*
|
|
3486
|
+
* @remarks
|
|
3487
|
+
* Safe to be used within or outside of the Bundle Editor.
|
|
3488
|
+
* `undefined` is returned when used outside of Bundle Editor.
|
|
3489
|
+
*
|
|
2512
3490
|
* @public
|
|
2513
3491
|
*/
|
|
2514
3492
|
export declare type OptionalBundleEditorHook = () => BundleEditorHookResult | undefined;
|
|
2515
3493
|
|
|
2516
3494
|
/**
|
|
3495
|
+
* Hook for accessing Keyword Editor data when available.
|
|
3496
|
+
*
|
|
3497
|
+
* @remarks
|
|
3498
|
+
* Safe to be used within or outside of the Keyword Editor.
|
|
3499
|
+
* `undefined` is returned when used outside of Keyword Editor.
|
|
3500
|
+
*
|
|
2517
3501
|
* @public
|
|
2518
3502
|
*/
|
|
2519
3503
|
export declare type OptionalCategoryEditorHook = () => CategoryEditorHookResult | undefined;
|
|
2520
3504
|
|
|
2521
3505
|
/**
|
|
3506
|
+
* Hook for accessing Component Editor data when available.
|
|
3507
|
+
*
|
|
3508
|
+
* @remarks
|
|
3509
|
+
* Safe to be used within or outside of the Component Editor.
|
|
3510
|
+
* `undefined` is returned when used outside of Component Editor.
|
|
3511
|
+
*
|
|
2522
3512
|
* @public
|
|
2523
3513
|
*/
|
|
2524
3514
|
export declare type OptionalComponentEditorHook = () => ComponentEditorHookResult | undefined;
|
|
2525
3515
|
|
|
2526
3516
|
/**
|
|
3517
|
+
* Hook for accessing Content Explorer data and methods when available.
|
|
3518
|
+
*
|
|
3519
|
+
* @remarks
|
|
3520
|
+
* Safe to be used within or outside of the Content Explorer.
|
|
3521
|
+
* `undefined` is returned when used outside of Content Explorer.
|
|
3522
|
+
*
|
|
2527
3523
|
* @public
|
|
2528
3524
|
*/
|
|
2529
3525
|
export declare type OptionalContentExplorerHook = () => ContentExplorerHookResult | undefined;
|
|
2530
3526
|
|
|
2531
3527
|
/**
|
|
3528
|
+
* Hook for accessing Content Explorer Table data and methods when available.
|
|
3529
|
+
*
|
|
3530
|
+
* @remarks
|
|
3531
|
+
* Safe to be used within or outside of the Content Explorer Table.
|
|
3532
|
+
* `undefined` is returned when used outside of Content Explorer Table.
|
|
3533
|
+
*
|
|
2532
3534
|
* @public
|
|
2533
3535
|
*/
|
|
2534
3536
|
export declare type OptionalContentExplorerTableHook = () => ContentExplorerTableHookResult | undefined;
|
|
2535
3537
|
|
|
2536
3538
|
/**
|
|
3539
|
+
* Hook for accessing Content Explorer Tree data and methods when available.
|
|
3540
|
+
*
|
|
3541
|
+
* @remarks
|
|
3542
|
+
* Safe to be used within or outside of the Content Explorer Tree.
|
|
3543
|
+
* `undefined` is returned when used outside of the Content Explorer Tree.
|
|
3544
|
+
*
|
|
2537
3545
|
* @public
|
|
2538
3546
|
*/
|
|
2539
3547
|
export declare type OptionalContentExplorerTreeHook = () => ContentExplorerTreeHookResult | undefined;
|
|
2540
3548
|
|
|
2541
3549
|
/**
|
|
3550
|
+
* Hook for accessing Item Editor data when available.
|
|
3551
|
+
*
|
|
3552
|
+
* @remarks
|
|
3553
|
+
* Safe to be used within or outside of the Item Editor.
|
|
3554
|
+
* `undefined` is returned when used outside of Item Editor.
|
|
3555
|
+
*
|
|
2542
3556
|
* @public
|
|
2543
3557
|
*/
|
|
2544
3558
|
export declare type OptionalEditorHook = () => EditorHookResult | undefined;
|
|
2545
3559
|
|
|
2546
3560
|
/**
|
|
3561
|
+
* Hook for accessing Folder Editor data when available.
|
|
3562
|
+
*
|
|
3563
|
+
* @remarks
|
|
3564
|
+
* Safe to be used within or outside of the Folder Editor.
|
|
3565
|
+
* `undefined` is returned when used outside of Folder Editor.
|
|
3566
|
+
*
|
|
2547
3567
|
* @public
|
|
2548
3568
|
*/
|
|
2549
3569
|
export declare type OptionalFolderEditorHook = () => FolderEditorHookResult | undefined;
|
|
2550
3570
|
|
|
2551
3571
|
/**
|
|
3572
|
+
* Hook for accessing Keyword Editor data when available.
|
|
3573
|
+
*
|
|
3574
|
+
* @remarks
|
|
3575
|
+
* Safe to be used within or outside of the Keyword Editor.
|
|
3576
|
+
* `undefined` is returned when used outside of Keyword Editor.
|
|
3577
|
+
*
|
|
2552
3578
|
* @public
|
|
2553
3579
|
*/
|
|
2554
3580
|
export declare type OptionalKeywordEditorHook = () => KeywordEditorHookResult | undefined;
|
|
2555
3581
|
|
|
2556
3582
|
/**
|
|
3583
|
+
* Hook for accessing Page Editor data when available.
|
|
3584
|
+
*
|
|
3585
|
+
* @remarks
|
|
3586
|
+
* Safe to be used within or outside of the Page Editor.
|
|
3587
|
+
* `undefined` is returned when used outside of Page Editor.
|
|
3588
|
+
*
|
|
2557
3589
|
* @public
|
|
2558
3590
|
*/
|
|
2559
3591
|
export declare type OptionalPageEditorHook = () => PageEditorHookResult | undefined;
|
|
2560
3592
|
|
|
2561
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
|
+
|
|
3615
|
+
/**
|
|
3616
|
+
* Hook for accessing Structure Group Editor data when available.
|
|
3617
|
+
*
|
|
3618
|
+
* @remarks
|
|
3619
|
+
* Safe to be used within or outside of the Structure Group Editor.
|
|
3620
|
+
* `undefined` is returned when used outside of Structure Group Editor.
|
|
3621
|
+
*
|
|
2562
3622
|
* @public
|
|
2563
3623
|
*/
|
|
2564
3624
|
export declare type OptionalStructureGroupEditorHook = () => StructureGroupEditorHookResult | undefined;
|
|
@@ -2574,11 +3634,29 @@ export declare interface PageEditorApiStorage {
|
|
|
2574
3634
|
* @public
|
|
2575
3635
|
*/
|
|
2576
3636
|
export declare interface PageEditorHookResult {
|
|
3637
|
+
/**
|
|
3638
|
+
* Editable Page.
|
|
3639
|
+
*/
|
|
2577
3640
|
page: Page;
|
|
3641
|
+
/**
|
|
3642
|
+
* Template that is used to publish Page with.
|
|
3643
|
+
*/
|
|
2578
3644
|
pageTemplate: PageTemplate | undefined;
|
|
3645
|
+
/**
|
|
3646
|
+
* Page's metadata schema.
|
|
3647
|
+
*/
|
|
2579
3648
|
metadataSchema: Schema | undefined;
|
|
3649
|
+
/**
|
|
3650
|
+
* Boolean that indicates that Page has unsaved changes.
|
|
3651
|
+
*/
|
|
2580
3652
|
isChanged: boolean;
|
|
3653
|
+
/**
|
|
3654
|
+
* Boolean that indicates that Page can be edited.
|
|
3655
|
+
*/
|
|
2581
3656
|
isEditing: boolean;
|
|
3657
|
+
/**
|
|
3658
|
+
* Boolean that indicates whether any components in the page have unsaved changes.
|
|
3659
|
+
*/
|
|
2582
3660
|
hasUnsavedRelatives: boolean;
|
|
2583
3661
|
}
|
|
2584
3662
|
|
|
@@ -2616,8 +3694,68 @@ declare const palette: {
|
|
|
2616
3694
|
yellow50: string;
|
|
2617
3695
|
yellow100: string;
|
|
2618
3696
|
yellow120: string;
|
|
3697
|
+
yellow140: string;
|
|
2619
3698
|
};
|
|
2620
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
|
+
|
|
2621
3759
|
/**
|
|
2622
3760
|
* @public
|
|
2623
3761
|
*/
|
|
@@ -2627,6 +3765,9 @@ export declare type PublicationBlueprintHierarchyQueryHook = (props: Publication
|
|
|
2627
3765
|
* @public
|
|
2628
3766
|
*/
|
|
2629
3767
|
export declare interface PublicationBlueprintHierarchyQueryProps {
|
|
3768
|
+
/**
|
|
3769
|
+
* Identifies the item for which Blueprint hierarchy is being retrieved.
|
|
3770
|
+
*/
|
|
2630
3771
|
publicationId: ItemUri;
|
|
2631
3772
|
}
|
|
2632
3773
|
|
|
@@ -2644,9 +3785,295 @@ export declare type PublishableTargetTypesQueryHook = (props: PublishableTargetT
|
|
|
2644
3785
|
* @public
|
|
2645
3786
|
*/
|
|
2646
3787
|
export declare interface PublishableTargetTypesQueryProps {
|
|
3788
|
+
/**
|
|
3789
|
+
* Identifies the Business Process Type for which Target Types are being retrieved.
|
|
3790
|
+
*/
|
|
2647
3791
|
businessProcessTypeId: ItemUri;
|
|
2648
3792
|
}
|
|
2649
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
|
+
|
|
2650
4077
|
/**
|
|
2651
4078
|
* @public
|
|
2652
4079
|
*/
|
|
@@ -2708,6 +4135,45 @@ export declare interface PublishItemsRequest {
|
|
|
2708
4135
|
publishInChildPublications?: ReadonlyArray<ItemUri>;
|
|
2709
4136
|
}
|
|
2710
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
|
+
|
|
2711
4177
|
/**
|
|
2712
4178
|
* @public
|
|
2713
4179
|
*/
|
|
@@ -2735,7 +4201,7 @@ export declare interface QueryOptions<TQueryFnData = unknown, TError = unknown,
|
|
|
2735
4201
|
staleTime?: number;
|
|
2736
4202
|
/**
|
|
2737
4203
|
* If set to a number, the query will continuously refetch at this frequency in milliseconds.
|
|
2738
|
-
* If set to a function, the function will be executed with the latest data and query to compute a frequency
|
|
4204
|
+
* If set to a function, the function will be executed with the latest data and query to compute a frequency.
|
|
2739
4205
|
* Defaults to `false`.
|
|
2740
4206
|
*/
|
|
2741
4207
|
refetchInterval?: number | false;
|
|
@@ -2798,29 +4264,85 @@ export declare interface QueryOptions<TQueryFnData = unknown, TError = unknown,
|
|
|
2798
4264
|
* @public
|
|
2799
4265
|
*/
|
|
2800
4266
|
export declare interface QueryResult<TData = unknown, TError = unknown> {
|
|
4267
|
+
/**
|
|
4268
|
+
* The last successfully resolved data for the query.
|
|
4269
|
+
*/
|
|
2801
4270
|
data: TData | undefined;
|
|
4271
|
+
/**
|
|
4272
|
+
* The timestamp for when the query most recently returned the `status` as `success`.
|
|
4273
|
+
*/
|
|
2802
4274
|
dataUpdatedAt: number;
|
|
4275
|
+
/**
|
|
4276
|
+
* The error object for the query, if an error was thrown.
|
|
4277
|
+
*/
|
|
2803
4278
|
error: TError | null;
|
|
4279
|
+
/**
|
|
4280
|
+
* The timestamp for when the query most recently returned the `status` as `error`.
|
|
4281
|
+
*/
|
|
2804
4282
|
errorUpdatedAt: number;
|
|
2805
4283
|
failureCount: number;
|
|
4284
|
+
/**
|
|
4285
|
+
* The failure reason for the query retry.
|
|
4286
|
+
* Reset to null when the query succeeds.
|
|
4287
|
+
*/
|
|
2806
4288
|
failureReason: TError | null;
|
|
4289
|
+
/**
|
|
4290
|
+
* The sum of all errors.
|
|
4291
|
+
*/
|
|
2807
4292
|
errorUpdateCount: number;
|
|
2808
4293
|
isError: boolean;
|
|
4294
|
+
/**
|
|
4295
|
+
* Will be true if the query has been fetched.
|
|
4296
|
+
*/
|
|
2809
4297
|
isFetched: boolean;
|
|
4298
|
+
/**
|
|
4299
|
+
* Will be true if the query has been fetched after the component mounted.
|
|
4300
|
+
* This property can be used to not show any previously cached data.
|
|
4301
|
+
*/
|
|
2810
4302
|
isFetchedAfterMount: boolean;
|
|
2811
4303
|
isFetching: boolean;
|
|
2812
4304
|
isLoading: boolean;
|
|
2813
4305
|
isLoadingError: boolean;
|
|
4306
|
+
/**
|
|
4307
|
+
* Is true whenever the first fetch for a query is in-flight.
|
|
4308
|
+
*/
|
|
2814
4309
|
isInitialLoading: boolean;
|
|
2815
4310
|
isPaused: boolean;
|
|
4311
|
+
/**
|
|
4312
|
+
* Will be `true` if the data shown is the placeholder data.
|
|
4313
|
+
*/
|
|
2816
4314
|
isPlaceholderData: boolean;
|
|
4315
|
+
/**
|
|
4316
|
+
* Will be true when `keepPreviousData` is set and data from the previous query is returned.
|
|
4317
|
+
*/
|
|
2817
4318
|
isPreviousData: boolean;
|
|
4319
|
+
/**
|
|
4320
|
+
* Will be `true` if the query failed while fetching for the first time.
|
|
4321
|
+
*/
|
|
2818
4322
|
isRefetchError: boolean;
|
|
4323
|
+
/**
|
|
4324
|
+
* Is `true` whenever a background refetch is in-flight, which does not include initial loading.
|
|
4325
|
+
*/
|
|
2819
4326
|
isRefetching: boolean;
|
|
4327
|
+
/**
|
|
4328
|
+
* Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.
|
|
4329
|
+
*/
|
|
2820
4330
|
isStale: boolean;
|
|
2821
4331
|
isSuccess: boolean;
|
|
2822
4332
|
refetch: (options?: RefetchOptions) => Promise<QueryResult<TData, TError>>;
|
|
4333
|
+
/**
|
|
4334
|
+
* - `loading` - if there's no cached data and no query attempt was finished yet.
|
|
4335
|
+
* - `error` - if the query attempt resulted in an error. The corresponding error property has the error received from the attempted fetch.
|
|
4336
|
+
* - `success` - if the query has received a response with no errors and is ready to display its data.
|
|
4337
|
+
* The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false`
|
|
4338
|
+
* and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.
|
|
4339
|
+
*/
|
|
2823
4340
|
status: QueryStatus;
|
|
4341
|
+
/**
|
|
4342
|
+
* - `fetching` - Is true whenever the queryFn is executing, which includes initial loading as well as background refetches.
|
|
4343
|
+
* - `paused` - The query wanted to fetch, but has been paused.
|
|
4344
|
+
* - `idle` - The query is not fetching.
|
|
4345
|
+
*/
|
|
2824
4346
|
fetchStatus: QueryFetchStatus;
|
|
2825
4347
|
}
|
|
2826
4348
|
|
|
@@ -2876,7 +4398,13 @@ export declare type RemoveFromBundleMutationHook = (options?: MutationOptions<Bu
|
|
|
2876
4398
|
* @public
|
|
2877
4399
|
*/
|
|
2878
4400
|
export declare interface RemoveFromBundleRequest {
|
|
4401
|
+
/**
|
|
4402
|
+
* ID of a bundle to remove items from.
|
|
4403
|
+
*/
|
|
2879
4404
|
bundleId: ItemUri;
|
|
4405
|
+
/**
|
|
4406
|
+
* IDs of items to remove from the bundle.
|
|
4407
|
+
*/
|
|
2880
4408
|
itemIdsToRemove: ReadonlyArray<ItemUri>;
|
|
2881
4409
|
}
|
|
2882
4410
|
|
|
@@ -2889,6 +4417,9 @@ export declare type RestartActivitiesMutationHook = (options?: BatchMutationOpti
|
|
|
2889
4417
|
* @public
|
|
2890
4418
|
*/
|
|
2891
4419
|
export declare interface RestartActivitiesRequest {
|
|
4420
|
+
/**
|
|
4421
|
+
* Array of Activity Instances to restart.
|
|
4422
|
+
*/
|
|
2892
4423
|
activityInstances: ReadonlyArray<ActivityInstance>;
|
|
2893
4424
|
}
|
|
2894
4425
|
|
|
@@ -2901,6 +4432,9 @@ export declare type RestartActivityMutationHook = (options?: MutationOptions<Act
|
|
|
2901
4432
|
* @public
|
|
2902
4433
|
*/
|
|
2903
4434
|
export declare interface RestartActivityRequest {
|
|
4435
|
+
/**
|
|
4436
|
+
* Activity Instance ID to restart.
|
|
4437
|
+
*/
|
|
2904
4438
|
activityInstanceId: ItemUri;
|
|
2905
4439
|
}
|
|
2906
4440
|
|
|
@@ -2913,7 +4447,13 @@ export declare type RevertItemMutationHook = (options?: MutationOptions<Reposito
|
|
|
2913
4447
|
* @public
|
|
2914
4448
|
*/
|
|
2915
4449
|
export declare interface RevertItemRequest {
|
|
4450
|
+
/**
|
|
4451
|
+
* ID of the item being reverted.
|
|
4452
|
+
*/
|
|
2916
4453
|
item: IdentifiableObject;
|
|
4454
|
+
/**
|
|
4455
|
+
* Container item of the item to revert.
|
|
4456
|
+
*/
|
|
2917
4457
|
containerItem?: IdentifiableObject;
|
|
2918
4458
|
}
|
|
2919
4459
|
|
|
@@ -2926,7 +4466,13 @@ export declare type RevertItemsMutationHook = (options?: BatchMutationOptions<Re
|
|
|
2926
4466
|
* @public
|
|
2927
4467
|
*/
|
|
2928
4468
|
export declare interface RevertItemsRequest {
|
|
4469
|
+
/**
|
|
4470
|
+
* IDs of items being reverted.
|
|
4471
|
+
*/
|
|
2929
4472
|
itemIds: ReadonlyArray<ItemUri>;
|
|
4473
|
+
/**
|
|
4474
|
+
* Container item ID of the items to revert.
|
|
4475
|
+
*/
|
|
2930
4476
|
containerId: ItemUri;
|
|
2931
4477
|
}
|
|
2932
4478
|
|
|
@@ -3017,8 +4563,22 @@ export declare type RollbackItemMutationHook = (options?: MutationOptions<Reposi
|
|
|
3017
4563
|
* @public
|
|
3018
4564
|
*/
|
|
3019
4565
|
export declare interface RollbackItemRequest {
|
|
4566
|
+
/**
|
|
4567
|
+
* ID of the item being rolled back.
|
|
4568
|
+
*/
|
|
3020
4569
|
itemId: ItemUri;
|
|
4570
|
+
/**
|
|
4571
|
+
* Container item of the item to rollback.
|
|
4572
|
+
*/
|
|
3021
4573
|
containerItem?: IdentifiableObject;
|
|
4574
|
+
/**
|
|
4575
|
+
* Option to delete all the versions higher than `itemId` version.
|
|
4576
|
+
*
|
|
4577
|
+
* @example
|
|
4578
|
+
* Latest item version is 5. Revert to version 3.
|
|
4579
|
+
* Case 1: `deleteNewerVersions: false` - v6 is created out of v3.
|
|
4580
|
+
* Case 2: `deleteNewerVersions: true` - v3 is the latest version now, v4 and v5 are deleted.
|
|
4581
|
+
*/
|
|
3022
4582
|
deleteNewerVersions: boolean;
|
|
3023
4583
|
}
|
|
3024
4584
|
|
|
@@ -3040,7 +4600,7 @@ export declare type SearchInContainerQueryHook = (props: SearchInContainerQueryP
|
|
|
3040
4600
|
*/
|
|
3041
4601
|
export declare interface SearchInContainerQueryProps {
|
|
3042
4602
|
/**
|
|
3043
|
-
* URI of the container
|
|
4603
|
+
* URI of the container to search in.
|
|
3044
4604
|
*/
|
|
3045
4605
|
containerId: ItemUri;
|
|
3046
4606
|
/**
|
|
@@ -3060,7 +4620,13 @@ export declare interface SearchInContainerQueryProps {
|
|
|
3060
4620
|
* @public
|
|
3061
4621
|
*/
|
|
3062
4622
|
export declare interface SetTargetContentExplorerProps {
|
|
4623
|
+
/**
|
|
4624
|
+
* Id of a container node to resolve to.
|
|
4625
|
+
*/
|
|
3063
4626
|
containerNodeId: string;
|
|
4627
|
+
/**
|
|
4628
|
+
* Item URI of an item to resolve to inside the `containerNodeId`.
|
|
4629
|
+
*/
|
|
3064
4630
|
itemInContainerId: ItemUri | undefined;
|
|
3065
4631
|
}
|
|
3066
4632
|
|
|
@@ -3082,9 +4648,21 @@ export declare interface SizeProps {
|
|
|
3082
4648
|
* Zero is ignored.
|
|
3083
4649
|
*/
|
|
3084
4650
|
height?: number;
|
|
4651
|
+
/**
|
|
4652
|
+
* Minimum width of the component in pixels.
|
|
4653
|
+
*/
|
|
3085
4654
|
minWidth?: number;
|
|
4655
|
+
/**
|
|
4656
|
+
* Minimum height of the component in pixels.
|
|
4657
|
+
*/
|
|
3086
4658
|
minHeight?: number;
|
|
4659
|
+
/**
|
|
4660
|
+
* Maximum width of the component in pixels.
|
|
4661
|
+
*/
|
|
3087
4662
|
maxWidth?: number;
|
|
4663
|
+
/**
|
|
4664
|
+
* Maximum height of the component in pixels.
|
|
4665
|
+
*/
|
|
3088
4666
|
maxHeight?: number;
|
|
3089
4667
|
}
|
|
3090
4668
|
|
|
@@ -3159,6 +4737,11 @@ declare const spacing: {
|
|
|
3159
4737
|
lg: number;
|
|
3160
4738
|
};
|
|
3161
4739
|
|
|
4740
|
+
/**
|
|
4741
|
+
* @public
|
|
4742
|
+
*/
|
|
4743
|
+
export declare type SpacingGetter = () => Spacing;
|
|
4744
|
+
|
|
3162
4745
|
/**
|
|
3163
4746
|
* @public
|
|
3164
4747
|
*/
|
|
@@ -3171,6 +4754,7 @@ declare type SpacingUnit_2 = keyof typeof spacing;
|
|
|
3171
4754
|
*
|
|
3172
4755
|
* Items can't have size that depends on Stack's size. This means that it is impossible to make item take available space or
|
|
3173
4756
|
* have size in percentage of Stack's size.
|
|
4757
|
+
*
|
|
3174
4758
|
* @public
|
|
3175
4759
|
*/
|
|
3176
4760
|
export declare const Stack: StackComponent;
|
|
@@ -3225,6 +4809,9 @@ export declare type StartActivitiesMutationHook = (options?: BatchMutationOption
|
|
|
3225
4809
|
* @public
|
|
3226
4810
|
*/
|
|
3227
4811
|
export declare interface StartActivitiesRequest {
|
|
4812
|
+
/**
|
|
4813
|
+
* Array of Activity Instances to start.
|
|
4814
|
+
*/
|
|
3228
4815
|
activityInstances: ReadonlyArray<ActivityInstance>;
|
|
3229
4816
|
}
|
|
3230
4817
|
|
|
@@ -3237,6 +4824,9 @@ export declare type StartActivityMutationHook = (options?: MutationOptions<Activ
|
|
|
3237
4824
|
* @public
|
|
3238
4825
|
*/
|
|
3239
4826
|
export declare interface StartActivityRequest {
|
|
4827
|
+
/**
|
|
4828
|
+
* ID of Activity Instance to start.
|
|
4829
|
+
*/
|
|
3240
4830
|
activityInstanceId: ItemUri;
|
|
3241
4831
|
}
|
|
3242
4832
|
|
|
@@ -3249,6 +4839,9 @@ export declare type StartWorkflowMutationHook = (options?: MutationOptions<Proce
|
|
|
3249
4839
|
* @public
|
|
3250
4840
|
*/
|
|
3251
4841
|
export declare interface StartWorkflowRequest {
|
|
4842
|
+
/**
|
|
4843
|
+
* ID of an item to start workflow for.
|
|
4844
|
+
*/
|
|
3252
4845
|
itemId: ItemUri;
|
|
3253
4846
|
}
|
|
3254
4847
|
|
|
@@ -3263,9 +4856,21 @@ export declare interface StructureGroupEditorApiStorage {
|
|
|
3263
4856
|
* @public
|
|
3264
4857
|
*/
|
|
3265
4858
|
export declare interface StructureGroupEditorHookResult {
|
|
4859
|
+
/**
|
|
4860
|
+
* Editable Structure Group.
|
|
4861
|
+
*/
|
|
3266
4862
|
structureGroup: StructureGroup;
|
|
4863
|
+
/**
|
|
4864
|
+
* Structure Group's metadata schema.
|
|
4865
|
+
*/
|
|
3267
4866
|
metadataSchema: Schema;
|
|
4867
|
+
/**
|
|
4868
|
+
* Boolean that indicates that Structure Group has unsaved changes.
|
|
4869
|
+
*/
|
|
3268
4870
|
isChanged: boolean;
|
|
4871
|
+
/**
|
|
4872
|
+
* Boolean that indicates that Structure Group can be edited.
|
|
4873
|
+
*/
|
|
3269
4874
|
isEditing: boolean;
|
|
3270
4875
|
}
|
|
3271
4876
|
|
|
@@ -3322,7 +4927,7 @@ export declare type TableColumnExtension<TItem extends IdentifiableObject> = ()
|
|
|
3322
4927
|
*/
|
|
3323
4928
|
export declare interface TableColumnExtensionComponentProps<TItem extends IdentifiableObject> {
|
|
3324
4929
|
/**
|
|
3325
|
-
*
|
|
4930
|
+
* An item associated with the table row where the component is being rendered.
|
|
3326
4931
|
*/
|
|
3327
4932
|
item: TItem;
|
|
3328
4933
|
}
|
|
@@ -3332,15 +4937,15 @@ export declare interface TableColumnExtensionComponentProps<TItem extends Identi
|
|
|
3332
4937
|
*/
|
|
3333
4938
|
export declare interface TableColumnExtensionConfiguration<TItem extends IdentifiableObject> {
|
|
3334
4939
|
/**
|
|
3335
|
-
*
|
|
4940
|
+
* A unique identifier for the column.
|
|
3336
4941
|
*/
|
|
3337
4942
|
readonly id: string;
|
|
3338
4943
|
/**
|
|
3339
|
-
*
|
|
4944
|
+
* The component to be rendered for each cell that belongs to the column.
|
|
3340
4945
|
*/
|
|
3341
4946
|
readonly component: ComponentType<TableColumnExtensionComponentProps<TItem>>;
|
|
3342
4947
|
/**
|
|
3343
|
-
* Hook
|
|
4948
|
+
* Hook that contains behavior of the column.
|
|
3344
4949
|
*/
|
|
3345
4950
|
readonly useColumn: TableColumnHook;
|
|
3346
4951
|
}
|
|
@@ -3348,34 +4953,53 @@ export declare interface TableColumnExtensionConfiguration<TItem extends Identif
|
|
|
3348
4953
|
/**
|
|
3349
4954
|
* @public
|
|
3350
4955
|
*/
|
|
3351
|
-
export declare type TableColumnHook = () =>
|
|
4956
|
+
export declare type TableColumnHook = () => TableColumnHookResult;
|
|
4957
|
+
|
|
4958
|
+
/**
|
|
4959
|
+
* @public
|
|
4960
|
+
*/
|
|
4961
|
+
export declare interface TableColumnHookResult {
|
|
3352
4962
|
/**
|
|
3353
|
-
*
|
|
4963
|
+
* Title associated with the column.
|
|
3354
4964
|
*/
|
|
3355
4965
|
readonly title: string;
|
|
3356
4966
|
/**
|
|
3357
|
-
*
|
|
4967
|
+
* Indicates the availability of the column in the table.
|
|
4968
|
+
*
|
|
4969
|
+
* @remarks
|
|
4970
|
+
* If the property is set to `true` but the column is still not visible in the table,
|
|
4971
|
+
* please make sure that it is enabled in the table configurator.
|
|
3358
4972
|
*/
|
|
3359
4973
|
readonly isAvailable: boolean;
|
|
3360
4974
|
/**
|
|
3361
|
-
*
|
|
4975
|
+
* Indicates whether the column width can be manually adjusted.
|
|
3362
4976
|
*/
|
|
3363
4977
|
readonly isResizable: boolean;
|
|
3364
4978
|
/**
|
|
3365
|
-
*
|
|
4979
|
+
* The minimum width that the column can have.
|
|
3366
4980
|
*/
|
|
3367
4981
|
readonly minWidth?: number;
|
|
3368
4982
|
/**
|
|
3369
|
-
*
|
|
4983
|
+
* The initial width of the column.
|
|
4984
|
+
*
|
|
4985
|
+
* @remarks
|
|
4986
|
+
* If the {@link TableColumnHookResult.isResizable} is set to `true`, this value is utilized for
|
|
4987
|
+
* initial width calculations of each column.
|
|
4988
|
+
* Otherwise, the column will have a fixed width based on this value.
|
|
3370
4989
|
*/
|
|
3371
4990
|
readonly initialWidth?: number;
|
|
3372
|
-
}
|
|
4991
|
+
}
|
|
3373
4992
|
|
|
3374
4993
|
/**
|
|
3375
4994
|
* @public
|
|
3376
4995
|
*/
|
|
3377
4996
|
export declare type Tag = keyof ReactHTML;
|
|
3378
4997
|
|
|
4998
|
+
/**
|
|
4999
|
+
* @public
|
|
5000
|
+
*/
|
|
5001
|
+
export declare type TargetTypesQueryHook = (options?: QueryOptions<ReadonlyArray<TargetType> | undefined, ApiError>) => QueryResult<ReadonlyArray<TargetType> | undefined, ApiError>;
|
|
5002
|
+
|
|
3379
5003
|
declare type TestName = string;
|
|
3380
5004
|
|
|
3381
5005
|
declare interface TestsProps {
|
|
@@ -3386,6 +5010,8 @@ declare interface TestsProps {
|
|
|
3386
5010
|
}
|
|
3387
5011
|
|
|
3388
5012
|
/**
|
|
5013
|
+
* Component which renders text with customizable content and styling.
|
|
5014
|
+
*
|
|
3389
5015
|
* @public
|
|
3390
5016
|
*/
|
|
3391
5017
|
declare const Text_2: TextComponent;
|
|
@@ -3408,6 +5034,7 @@ export declare type TextDirection = 'leftToRight' | 'rightToLeft';
|
|
|
3408
5034
|
|
|
3409
5035
|
/**
|
|
3410
5036
|
* A component to render Text Link for navigation
|
|
5037
|
+
*
|
|
3411
5038
|
* @public
|
|
3412
5039
|
*/
|
|
3413
5040
|
export declare const TextLink: TextLinkComponent;
|
|
@@ -3421,6 +5048,9 @@ export declare type TextLinkComponent = FunctionComponent<TextLinkProps>;
|
|
|
3421
5048
|
* @public
|
|
3422
5049
|
*/
|
|
3423
5050
|
export declare interface TextLinkProps extends TextProps, LinkProps {
|
|
5051
|
+
/**
|
|
5052
|
+
* String that is rendered as a link.
|
|
5053
|
+
*/
|
|
3424
5054
|
text: string;
|
|
3425
5055
|
}
|
|
3426
5056
|
|
|
@@ -3428,16 +5058,60 @@ export declare interface TextLinkProps extends TextProps, LinkProps {
|
|
|
3428
5058
|
* @public
|
|
3429
5059
|
*/
|
|
3430
5060
|
export declare interface TextProps extends ColorProps, TooltipProps {
|
|
5061
|
+
/**
|
|
5062
|
+
* The alignment of the text in the container.
|
|
5063
|
+
*/
|
|
3431
5064
|
alignment?: TextAlignment;
|
|
5065
|
+
/**
|
|
5066
|
+
* Determines whether the text should break words if they exceed the container width.
|
|
5067
|
+
* Note that it can be used in combination with `multiLine: true` only, since single line text is truncated by default.
|
|
5068
|
+
*/
|
|
3432
5069
|
breakWord?: boolean;
|
|
5070
|
+
/**
|
|
5071
|
+
* The content to be rendered inside the Text component.
|
|
5072
|
+
*/
|
|
3433
5073
|
children?: ReactNode;
|
|
5074
|
+
/**
|
|
5075
|
+
* Determines whether the Text component should have compact spacing.
|
|
5076
|
+
* If set to `true`, the line height of the text will be reduced.
|
|
5077
|
+
*/
|
|
3434
5078
|
compact?: boolean;
|
|
5079
|
+
/**
|
|
5080
|
+
* The direction of the text.
|
|
5081
|
+
*/
|
|
3435
5082
|
direction?: TextDirection;
|
|
5083
|
+
/**
|
|
5084
|
+
* Allow text to flow over multiple lines.
|
|
5085
|
+
* By default it's a single line text with truncation enabled.
|
|
5086
|
+
*/
|
|
3436
5087
|
multiLine?: boolean;
|
|
5088
|
+
/**
|
|
5089
|
+
* Option to make text non-selectable by the user.
|
|
5090
|
+
*/
|
|
3437
5091
|
notSelectable?: boolean;
|
|
5092
|
+
/**
|
|
5093
|
+
* The HTML tag to be used for rendering the Text component. Overrides default tag defined by `type`.
|
|
5094
|
+
*/
|
|
3438
5095
|
tag?: TextTag;
|
|
5096
|
+
/**
|
|
5097
|
+
* Preset that consist of specific styling (size, weight, etc) and HTML tag.
|
|
5098
|
+
*
|
|
5099
|
+
* - `heading1` - usually represents a top-level heading or title. It is styled as a large and prominent text. By default `<h1>` HTML tag is used.
|
|
5100
|
+
* - `heading2` - a secondary-level heading. It is styled as a slightly smaller text compared to `heading1`. By default `<h2>` HTML tag is used.
|
|
5101
|
+
* - `heading3` - a tertiary-level heading. It is styled as a smaller text compared to `heading2`. By default `<h3>` HTML tag is used.
|
|
5102
|
+
* - `default` - default style for regular text. It is styled as a standard paragraph text. By default `<div>` HTML tag used.
|
|
5103
|
+
* - `defaultBold` - the default style for bold text. It is styled similarly to `default` but with added font-weight. By default `<div>` HTML tag is used.
|
|
5104
|
+
* - `small` - a smaller size for text. It is typically used for captions, footnotes, or other smaller pieces of text. By default `<div>` HTML tag is used.
|
|
5105
|
+
* - `smallBold` - a smaller size for bold text. It combines the smaller size of 'small' with the added font-weight. By default `<div>` HTML tag is used.
|
|
5106
|
+
*/
|
|
3439
5107
|
type?: TextType;
|
|
5108
|
+
/**
|
|
5109
|
+
* Determines whether the text should have an underline.
|
|
5110
|
+
*/
|
|
3440
5111
|
underline?: boolean;
|
|
5112
|
+
/**
|
|
5113
|
+
* Determines whether the text should be displayed in uppercase.
|
|
5114
|
+
*/
|
|
3441
5115
|
uppercase?: boolean;
|
|
3442
5116
|
}
|
|
3443
5117
|
|
|
@@ -3456,7 +5130,7 @@ export declare type TextType = 'heading1' | 'heading2' | 'heading3' | 'default'
|
|
|
3456
5130
|
*/
|
|
3457
5131
|
export declare interface TooltipProps {
|
|
3458
5132
|
/**
|
|
3459
|
-
* Tooltip that
|
|
5133
|
+
* Tooltip that is shown on hover.
|
|
3460
5134
|
*/
|
|
3461
5135
|
tooltip?: string;
|
|
3462
5136
|
}
|
|
@@ -3475,6 +5149,11 @@ export declare interface TransitionDuration {
|
|
|
3475
5149
|
short: number;
|
|
3476
5150
|
}
|
|
3477
5151
|
|
|
5152
|
+
/**
|
|
5153
|
+
* @public
|
|
5154
|
+
*/
|
|
5155
|
+
export declare type TransitionDurationGetter = () => TransitionDuration;
|
|
5156
|
+
|
|
3478
5157
|
/**
|
|
3479
5158
|
* @public
|
|
3480
5159
|
*/
|
|
@@ -3493,6 +5172,7 @@ export declare interface TranslationExtensions {
|
|
|
3493
5172
|
export declare class TranslationExtensionsBuilder {
|
|
3494
5173
|
private _translations;
|
|
3495
5174
|
/**
|
|
5175
|
+
* Adds new translations for the specified language code.
|
|
3496
5176
|
*
|
|
3497
5177
|
* @param code - Language code.
|
|
3498
5178
|
* @param records - Key-value pairs of string translated to `code` language.
|
|
@@ -3512,11 +5192,11 @@ export declare type TranslationItemExtension = () => TranslationItemExtensionCon
|
|
|
3512
5192
|
*/
|
|
3513
5193
|
export declare interface TranslationItemExtensionConfiguration {
|
|
3514
5194
|
/**
|
|
3515
|
-
*
|
|
5195
|
+
* A code used to identify a specific language.
|
|
3516
5196
|
*/
|
|
3517
5197
|
readonly code: LanguageCode;
|
|
3518
5198
|
/**
|
|
3519
|
-
* Key-value pairs of string translated to
|
|
5199
|
+
* Key-value pairs of string translated to {@link TranslationItemExtensionConfiguration.code} language.
|
|
3520
5200
|
*/
|
|
3521
5201
|
readonly records: Record<string, any>;
|
|
3522
5202
|
}
|
|
@@ -3530,7 +5210,13 @@ export declare type UnlocalizeItemMutationHook = (options?: MutationOptions<Repo
|
|
|
3530
5210
|
* @public
|
|
3531
5211
|
*/
|
|
3532
5212
|
export declare interface UnlocalizeItemRequest {
|
|
5213
|
+
/**
|
|
5214
|
+
* ID of the local item to unlocalize.
|
|
5215
|
+
*/
|
|
3533
5216
|
itemId: ItemUri;
|
|
5217
|
+
/**
|
|
5218
|
+
* Container item of the item to unlocalize.
|
|
5219
|
+
*/
|
|
3534
5220
|
containerItem?: IdentifiableObject;
|
|
3535
5221
|
useDynamicVersion?: boolean;
|
|
3536
5222
|
}
|
|
@@ -3544,7 +5230,13 @@ export declare type UnlocalizeItemsMutationHook = (options?: BatchMutationOption
|
|
|
3544
5230
|
* @public
|
|
3545
5231
|
*/
|
|
3546
5232
|
export declare interface UnlocalizeItemsRequest {
|
|
5233
|
+
/**
|
|
5234
|
+
* IDs of items to unlocalize.
|
|
5235
|
+
*/
|
|
3547
5236
|
itemIds: ReadonlyArray<ItemUri>;
|
|
5237
|
+
/**
|
|
5238
|
+
* Container item ID of the items to unlocalize.
|
|
5239
|
+
*/
|
|
3548
5240
|
containerId: ItemUri;
|
|
3549
5241
|
}
|
|
3550
5242
|
|
|
@@ -3602,6 +5294,9 @@ export declare type UpdateItemMutationHook = (options?: MutationOptions<Identifi
|
|
|
3602
5294
|
* @public
|
|
3603
5295
|
*/
|
|
3604
5296
|
export declare interface UpdateItemRequest {
|
|
5297
|
+
/**
|
|
5298
|
+
* Item being updated.
|
|
5299
|
+
*/
|
|
3605
5300
|
item: IdentifiableObject;
|
|
3606
5301
|
}
|
|
3607
5302
|
|
|
@@ -3614,7 +5309,15 @@ export declare type UploadMultimediaMutationHook = (options?: MutationOptions<Up
|
|
|
3614
5309
|
* @public
|
|
3615
5310
|
*/
|
|
3616
5311
|
export declare interface UploadMultimediaMutationResult {
|
|
5312
|
+
/**
|
|
5313
|
+
* ID of the upload process.
|
|
5314
|
+
*/
|
|
3617
5315
|
processId: string;
|
|
5316
|
+
/**
|
|
5317
|
+
* Results for completed uploads.
|
|
5318
|
+
*
|
|
5319
|
+
* Result is mapped to uploaded file name.
|
|
5320
|
+
*/
|
|
3618
5321
|
resultsPerFile: Map<string, MultimediaUploadResult>;
|
|
3619
5322
|
}
|
|
3620
5323
|
|
|
@@ -3622,17 +5325,36 @@ export declare interface UploadMultimediaMutationResult {
|
|
|
3622
5325
|
* @public
|
|
3623
5326
|
*/
|
|
3624
5327
|
export declare interface UploadMultimediaRequest {
|
|
5328
|
+
/**
|
|
5329
|
+
* Files to upload.
|
|
5330
|
+
*/
|
|
3625
5331
|
files: ReadonlyArray<File>;
|
|
5332
|
+
/**
|
|
5333
|
+
* ID of a Folder to upload files to.
|
|
5334
|
+
*/
|
|
3626
5335
|
containerId: ItemUri;
|
|
5336
|
+
/**
|
|
5337
|
+
* ID of a schema to create components based on.
|
|
5338
|
+
*/
|
|
3627
5339
|
schemaId?: ItemUri;
|
|
3628
5340
|
}
|
|
3629
5341
|
|
|
3630
5342
|
/**
|
|
5343
|
+
* Provides access to Activities Explorer data and methods.
|
|
5344
|
+
*
|
|
5345
|
+
* @remarks
|
|
5346
|
+
* Should be used only inside Activities Explorer, otherwise throws an error.
|
|
5347
|
+
*
|
|
3631
5348
|
* @public
|
|
3632
5349
|
*/
|
|
3633
5350
|
export declare const useActivitiesExplorer: ActivitiesExplorerHook;
|
|
3634
5351
|
|
|
3635
5352
|
/**
|
|
5353
|
+
* Provides access to Activities Explorer Table data and methods.
|
|
5354
|
+
*
|
|
5355
|
+
* @remarks
|
|
5356
|
+
* Should be used only inside Activities Explorer Table, otherwise throws an error.
|
|
5357
|
+
*
|
|
3636
5358
|
* @public
|
|
3637
5359
|
*/
|
|
3638
5360
|
export declare const useActivitiesExplorerTable: ActivitiesExplorerTableHook;
|
|
@@ -3648,61 +5370,94 @@ export declare const useActivityInstancesQuery: ActivityInstancesQueryHook;
|
|
|
3648
5370
|
export declare const useAddToBundleMutation: AddToBundleMutationHook;
|
|
3649
5371
|
|
|
3650
5372
|
/**
|
|
5373
|
+
* Assigns a list of activities to a new User or Group.
|
|
5374
|
+
*
|
|
3651
5375
|
* @public
|
|
3652
5376
|
*/
|
|
3653
5377
|
export declare const useAssignActivitiesMutation: AssignActivitiesMutationHook;
|
|
3654
5378
|
|
|
3655
5379
|
/**
|
|
5380
|
+
* Assigns a single activity to a new User or Group.
|
|
5381
|
+
*
|
|
3656
5382
|
* @public
|
|
3657
5383
|
*/
|
|
3658
5384
|
export declare const useAssignActivityMutation: AssignActivityMutationHook;
|
|
3659
5385
|
|
|
3660
5386
|
/**
|
|
5387
|
+
* Classifies a single item based on its content and metadata.
|
|
5388
|
+
*
|
|
3661
5389
|
* @public
|
|
3662
5390
|
*/
|
|
3663
5391
|
export declare const useAutoClassifyItemMutation: AutoClassifyItemMutationHook;
|
|
3664
5392
|
|
|
3665
5393
|
/**
|
|
5394
|
+
* Classifies items based on their content and metadata.
|
|
5395
|
+
*
|
|
3666
5396
|
* @public
|
|
3667
5397
|
*/
|
|
3668
5398
|
export declare const useAutoClassifyItemsMutation: AutoClassifyItemsMutationHook;
|
|
3669
5399
|
|
|
3670
5400
|
/**
|
|
5401
|
+
* Updates the language selection for a given user.
|
|
5402
|
+
*
|
|
3671
5403
|
* @public
|
|
3672
5404
|
*/
|
|
3673
5405
|
export declare const useChangeUserLanguageMutation: ChangeUserLanguageMutationHook;
|
|
3674
5406
|
|
|
3675
5407
|
/**
|
|
5408
|
+
* Updates the locale selection for a given user.
|
|
5409
|
+
*
|
|
3676
5410
|
* @public
|
|
3677
5411
|
*/
|
|
3678
5412
|
export declare const useChangeUserLocaleMutation: ChangeUserLocaleMutationHook;
|
|
3679
5413
|
|
|
3680
5414
|
/**
|
|
5415
|
+
* Opens a Confirmation Modal based on the provided options.
|
|
5416
|
+
*
|
|
3681
5417
|
* @public
|
|
3682
5418
|
*/
|
|
3683
5419
|
export declare const useConfirmation: ConfirmationHook;
|
|
3684
5420
|
|
|
3685
5421
|
/**
|
|
5422
|
+
* Hook for accessing Content Explorer data and methods.
|
|
5423
|
+
*
|
|
5424
|
+
* @remarks
|
|
5425
|
+
* Should be used only inside Content Explorer, otherwise throws an error.
|
|
5426
|
+
*
|
|
3686
5427
|
* @public
|
|
3687
5428
|
*/
|
|
3688
5429
|
export declare const useContentExplorer: ContentExplorerHook;
|
|
3689
5430
|
|
|
3690
5431
|
/**
|
|
5432
|
+
* Hook for accessing Content Explorer Table data and methods.
|
|
5433
|
+
*
|
|
5434
|
+
* @remarks
|
|
5435
|
+
* Should be used only inside Content Explorer Table, otherwise throws an error.
|
|
5436
|
+
*
|
|
3691
5437
|
* @public
|
|
3692
5438
|
*/
|
|
3693
5439
|
export declare const useContentExplorerTable: ContentExplorerTableHook;
|
|
3694
5440
|
|
|
3695
5441
|
/**
|
|
5442
|
+
* Hook for accessing Content Explorer Tree data and methods.
|
|
5443
|
+
*
|
|
5444
|
+
* @remarks
|
|
5445
|
+
* Should be used only inside Content Explorer Tree, otherwise throws an error.
|
|
5446
|
+
*
|
|
3696
5447
|
* @public
|
|
3697
5448
|
*/
|
|
3698
5449
|
export declare const useContentExplorerTree: ContentExplorerTreeHook;
|
|
3699
5450
|
|
|
3700
5451
|
/**
|
|
5452
|
+
* Copies a single item to the specified destination.
|
|
5453
|
+
*
|
|
3701
5454
|
* @public
|
|
3702
5455
|
*/
|
|
3703
5456
|
export declare const useCopyItemMutation: CopyItemMutationHook;
|
|
3704
5457
|
|
|
3705
5458
|
/**
|
|
5459
|
+
* Copies a list of items to the specified destination.
|
|
5460
|
+
*
|
|
3706
5461
|
* @public
|
|
3707
5462
|
*/
|
|
3708
5463
|
export declare const useCopyItemsMutation: CopyItemsMutationHook;
|
|
@@ -3718,16 +5473,22 @@ export declare const useCreateTranslationJobMutation: CreateTranslationJobMutati
|
|
|
3718
5473
|
export declare const useDefaultTranslationJobQuery: DefaultTranslationJobQueryHook;
|
|
3719
5474
|
|
|
3720
5475
|
/**
|
|
5476
|
+
* Deletes a single item from the system.
|
|
5477
|
+
*
|
|
3721
5478
|
* @public
|
|
3722
5479
|
*/
|
|
3723
5480
|
export declare const useDeleteItemMutation: DeleteItemMutationHook;
|
|
3724
5481
|
|
|
3725
5482
|
/**
|
|
5483
|
+
* Deletes a list of items from the system.
|
|
5484
|
+
*
|
|
3726
5485
|
* @public
|
|
3727
5486
|
*/
|
|
3728
5487
|
export declare const useDeleteItemsMutation: DeleteItemsMutationHook;
|
|
3729
5488
|
|
|
3730
5489
|
/**
|
|
5490
|
+
* Provides access to Item Editor data and methods.
|
|
5491
|
+
*
|
|
3731
5492
|
* @public
|
|
3732
5493
|
*/
|
|
3733
5494
|
export declare const useEditor: EditorHook;
|
|
@@ -3748,56 +5509,80 @@ export declare const useFinishActivitiesMutation: FinishActivitiesMutationHook;
|
|
|
3748
5509
|
export declare const useFinishActivityMutation: FinishActivityMutationHook;
|
|
3749
5510
|
|
|
3750
5511
|
/**
|
|
5512
|
+
* Finishes editing of a checked out versioned item.
|
|
5513
|
+
* Saves changes made in minor version updates and increments the major version of the item.
|
|
5514
|
+
*
|
|
3751
5515
|
* @public
|
|
3752
5516
|
*/
|
|
3753
5517
|
export declare const useFinishEditingItemMutation: FinishEditingItemMutationHook;
|
|
3754
5518
|
|
|
3755
5519
|
/**
|
|
5520
|
+
* Finishes editing for checked out versioned items.
|
|
5521
|
+
* Saves changes made in minor version updates and increments the major version of each item.
|
|
5522
|
+
*
|
|
3756
5523
|
* @public
|
|
3757
5524
|
*/
|
|
3758
5525
|
export declare const useFinishEditingItemsMutation: FinishEditingItemsMutationHook;
|
|
3759
5526
|
|
|
3760
5527
|
/**
|
|
5528
|
+
* Retrieves the context of the provided item within the BluePrint hierarchy.
|
|
5529
|
+
*
|
|
3761
5530
|
* @public
|
|
3762
5531
|
*/
|
|
3763
5532
|
export declare const useItemBlueprintHierarchyQuery: ItemBlueprintHierarchyQueryHook;
|
|
3764
5533
|
|
|
3765
5534
|
/**
|
|
5535
|
+
* Retrieves a list of child items for the provided organizational item.
|
|
5536
|
+
*
|
|
3766
5537
|
* @public
|
|
3767
5538
|
*/
|
|
3768
5539
|
export declare const useItemChildrenQuery: ItemChildrenQueryHook;
|
|
3769
5540
|
|
|
3770
5541
|
/**
|
|
5542
|
+
* Retrieves a list of items classified with the provided Keyword or Concept.
|
|
5543
|
+
*
|
|
3771
5544
|
* @public
|
|
3772
5545
|
*/
|
|
3773
5546
|
export declare const useItemClassifiedItemsQuery: ItemClassifiedItemsQueryHook;
|
|
3774
5547
|
|
|
3775
5548
|
/**
|
|
5549
|
+
* Retrieves the default model for the provided model type.
|
|
5550
|
+
*
|
|
3776
5551
|
* @public
|
|
3777
5552
|
*/
|
|
3778
5553
|
export declare const useItemDefaultDataQuery: ItemDefaultDataQueryHook;
|
|
3779
5554
|
|
|
3780
5555
|
/**
|
|
5556
|
+
* Retrieves a list of major versions of the provided versioned item.
|
|
5557
|
+
*
|
|
3781
5558
|
* @public
|
|
3782
5559
|
*/
|
|
3783
5560
|
export declare const useItemHistoryQuery: ItemHistoryQueryHook;
|
|
3784
5561
|
|
|
3785
5562
|
/**
|
|
5563
|
+
* Retrieves a list of published pages that use the provided item.
|
|
5564
|
+
*
|
|
3786
5565
|
* @public
|
|
3787
5566
|
*/
|
|
3788
5567
|
export declare const useItemPublishedPagesQuery: ItemPublishedPagesQueryHook;
|
|
3789
5568
|
|
|
3790
5569
|
/**
|
|
5570
|
+
* Retrieves a list of targets to which the provided item is published.
|
|
5571
|
+
*
|
|
3791
5572
|
* @public
|
|
3792
5573
|
*/
|
|
3793
5574
|
export declare const useItemPublishedToQuery: ItemPublishedToQueryHook;
|
|
3794
5575
|
|
|
3795
5576
|
/**
|
|
5577
|
+
* Retrieves a list of URLs where the provided item is published.
|
|
5578
|
+
*
|
|
3796
5579
|
* @public
|
|
3797
5580
|
*/
|
|
3798
5581
|
export declare const useItemPublishUrlsQuery: ItemPublishUrlsQueryHook;
|
|
3799
5582
|
|
|
3800
5583
|
/**
|
|
5584
|
+
* Retrieves a single item using the provided item URI.
|
|
5585
|
+
*
|
|
3801
5586
|
* @public
|
|
3802
5587
|
*/
|
|
3803
5588
|
export declare const useItemQuery: ItemQueryHook;
|
|
@@ -3808,126 +5593,226 @@ export declare const useItemQuery: ItemQueryHook;
|
|
|
3808
5593
|
export declare const useItemsInProgressQuery: ItemsInProgressQueryHook;
|
|
3809
5594
|
|
|
3810
5595
|
/**
|
|
5596
|
+
* Retrieves a list of items using the provided list of item URIs.
|
|
5597
|
+
*
|
|
3811
5598
|
* @public
|
|
3812
5599
|
*/
|
|
3813
5600
|
export declare const useItemsQuery: ItemsQueryHook;
|
|
3814
5601
|
|
|
3815
5602
|
/**
|
|
5603
|
+
* Retrieves a list of items that will be published with the provided instructions.
|
|
5604
|
+
*
|
|
3816
5605
|
* @public
|
|
3817
5606
|
*/
|
|
3818
5607
|
export declare const useItemsToPublishQuery: ItemsToPublishQueryHook;
|
|
3819
5608
|
|
|
3820
5609
|
/**
|
|
5610
|
+
* Retrieves a list of items that will be unpublished with the provided instructions.
|
|
5611
|
+
*
|
|
3821
5612
|
* @public
|
|
3822
5613
|
*/
|
|
3823
5614
|
export declare const useItemsToUnpublishQuery: ItemsToUnpublishQueryHook;
|
|
3824
5615
|
|
|
3825
5616
|
/**
|
|
5617
|
+
* Retrieves translation information for the provided item.
|
|
5618
|
+
*
|
|
3826
5619
|
* @public
|
|
3827
5620
|
*/
|
|
3828
5621
|
export declare const useItemTranslationInfoQuery: ItemTranslationInfoQueryHook;
|
|
3829
5622
|
|
|
3830
5623
|
/**
|
|
5624
|
+
* Retrieves a list of items that use the provided item.
|
|
5625
|
+
*
|
|
3831
5626
|
* @public
|
|
3832
5627
|
*/
|
|
3833
5628
|
export declare const useItemUsedByQuery: ItemUsedByQueryHook;
|
|
3834
5629
|
|
|
3835
5630
|
/**
|
|
5631
|
+
* Retrieves a list of items that are used by the provided item.
|
|
5632
|
+
*
|
|
3836
5633
|
* @public
|
|
3837
5634
|
*/
|
|
3838
5635
|
export declare const useItemUsesQuery: ItemUsesQueryHook;
|
|
3839
5636
|
|
|
3840
5637
|
/**
|
|
5638
|
+
* Localizes a shared item by creating a local copy that can then be modified locally.
|
|
5639
|
+
*
|
|
3841
5640
|
* @public
|
|
3842
5641
|
*/
|
|
3843
5642
|
export declare const useLocalizeItemMutation: LocalizeItemMutationHook;
|
|
3844
5643
|
|
|
3845
5644
|
/**
|
|
5645
|
+
* Localizes a list of shared items by creating their local copies that can then be modified locally.
|
|
5646
|
+
*
|
|
3846
5647
|
* @public
|
|
3847
5648
|
*/
|
|
3848
5649
|
export declare const useLocalizeItemsMutation: LocalizeItemsMutationHook;
|
|
3849
5650
|
|
|
3850
5651
|
/**
|
|
5652
|
+
* Moves a single item from its current location to the specified destination.
|
|
5653
|
+
*
|
|
3851
5654
|
* @public
|
|
3852
5655
|
*/
|
|
3853
5656
|
export declare const useMoveItemMutation: MoveItemMutationHook;
|
|
3854
5657
|
|
|
3855
5658
|
/**
|
|
5659
|
+
* Moves a list of items from their current location to the specified destination.
|
|
5660
|
+
*
|
|
3856
5661
|
* @public
|
|
3857
5662
|
*/
|
|
3858
5663
|
export declare const useMoveItemsMutation: MoveItemsMutationHook;
|
|
3859
5664
|
|
|
3860
5665
|
/**
|
|
5666
|
+
* Provides access to data and methods for managing notifications.
|
|
5667
|
+
*
|
|
3861
5668
|
* @public
|
|
3862
5669
|
*/
|
|
3863
5670
|
export declare const useNotifications: NotificationsHook;
|
|
3864
5671
|
|
|
3865
5672
|
/**
|
|
5673
|
+
* Provides access to Activities Explorer data and methods, if available.
|
|
5674
|
+
*
|
|
5675
|
+
* @remarks
|
|
5676
|
+
* Safe to be used within or outside of the Activities Explorer.
|
|
5677
|
+
* `undefined` is returned when used outside of Activities Explorer.
|
|
5678
|
+
*
|
|
3866
5679
|
* @public
|
|
3867
5680
|
*/
|
|
3868
5681
|
export declare const useOptionalActivitiesExplorer: OptionalActivitiesExplorerHook;
|
|
3869
5682
|
|
|
3870
5683
|
/**
|
|
5684
|
+
* Provides access to Activities Explorer Table data and methods, if available.
|
|
5685
|
+
*
|
|
5686
|
+
* @remarks
|
|
5687
|
+
* Safe to be used within or outside of the Activities Explorer Table.
|
|
5688
|
+
* `undefined` is returned when used outside of Activities Explorer Table.
|
|
5689
|
+
*
|
|
3871
5690
|
* @public
|
|
3872
5691
|
*/
|
|
3873
5692
|
export declare const useOptionalActivitiesExplorerTable: OptionalActivitiesExplorerTableHook;
|
|
3874
5693
|
|
|
3875
5694
|
/**
|
|
5695
|
+
* Provides access to Bundle Editor data and methods, if available.
|
|
5696
|
+
* `undefined` is returned when used outside of Bundle Editor.
|
|
5697
|
+
*
|
|
3876
5698
|
* @public
|
|
3877
5699
|
*/
|
|
3878
5700
|
export declare const useOptionalBundleEditor: OptionalBundleEditorHook;
|
|
3879
5701
|
|
|
3880
5702
|
/**
|
|
5703
|
+
* Provides access to Category Editor data and methods, if available.
|
|
5704
|
+
* `undefined` is returned when used outside of Category Editor.
|
|
5705
|
+
*
|
|
3881
5706
|
* @public
|
|
3882
5707
|
*/
|
|
3883
5708
|
export declare const useOptionalCategoryEditor: OptionalCategoryEditorHook;
|
|
3884
5709
|
|
|
3885
5710
|
/**
|
|
5711
|
+
* Provides access to Component Editor data and methods, if available.
|
|
5712
|
+
* `undefined` is returned when used outside of Component Editor.
|
|
5713
|
+
*
|
|
3886
5714
|
* @public
|
|
3887
5715
|
*/
|
|
3888
5716
|
export declare const useOptionalComponentEditor: OptionalComponentEditorHook;
|
|
3889
5717
|
|
|
3890
5718
|
/**
|
|
5719
|
+
* Hook for accessing Content Explorer data and methods, if available.
|
|
5720
|
+
*
|
|
5721
|
+
* @remarks
|
|
5722
|
+
* Safe to be used within or outside of the Content Explorer.
|
|
5723
|
+
* `undefined` is returned when used outside of Content Explorer.
|
|
5724
|
+
*
|
|
3891
5725
|
* @public
|
|
3892
5726
|
*/
|
|
3893
5727
|
export declare const useOptionalContentExplorer: OptionalContentExplorerHook;
|
|
3894
5728
|
|
|
3895
5729
|
/**
|
|
5730
|
+
* Hook for accessing Content Explorer Table data and methods, if available.
|
|
5731
|
+
*
|
|
5732
|
+
* @remarks
|
|
5733
|
+
* Safe to be used within or outside of the Content Explorer Table.
|
|
5734
|
+
* `undefined` is returned when used outside of Content Explorer Table.
|
|
5735
|
+
*
|
|
3896
5736
|
* @public
|
|
3897
5737
|
*/
|
|
3898
5738
|
export declare const useOptionalContentExplorerTable: OptionalContentExplorerTableHook;
|
|
3899
5739
|
|
|
3900
5740
|
/**
|
|
5741
|
+
* Hook for accessing Content Explorer Tree data and methods, if available.
|
|
5742
|
+
*
|
|
5743
|
+
* @remarks
|
|
5744
|
+
* Safe to be used within or outside of the Content Explorer Tree.
|
|
5745
|
+
* `undefined` is returned when used outside of Content Explorer Tree.
|
|
5746
|
+
*
|
|
3901
5747
|
* @public
|
|
3902
5748
|
*/
|
|
3903
5749
|
export declare const useOptionalContentExplorerTree: OptionalContentExplorerTreeHook;
|
|
3904
5750
|
|
|
3905
5751
|
/**
|
|
5752
|
+
* Provides access to Item Editor data and methods, if available.
|
|
5753
|
+
* `undefined` is returned when used outside of Item Editor.
|
|
5754
|
+
*
|
|
3906
5755
|
* @public
|
|
3907
5756
|
*/
|
|
3908
5757
|
export declare const useOptionalEditor: OptionalEditorHook;
|
|
3909
5758
|
|
|
3910
5759
|
/**
|
|
5760
|
+
* Provides access to Folder Editor data and methods, if available.
|
|
5761
|
+
* `undefined` is returned when used outside of Folder Editor.
|
|
5762
|
+
*
|
|
3911
5763
|
* @public
|
|
3912
5764
|
*/
|
|
3913
5765
|
export declare const useOptionalFolderEditor: OptionalFolderEditorHook;
|
|
3914
5766
|
|
|
3915
5767
|
/**
|
|
5768
|
+
* Provides access to Keyword Editor data and methods, if available.
|
|
5769
|
+
* `undefined` is returned when used outside of Keyword Editor.
|
|
5770
|
+
*
|
|
3916
5771
|
* @public
|
|
3917
5772
|
*/
|
|
3918
5773
|
export declare const useOptionalKeywordEditor: OptionalKeywordEditorHook;
|
|
3919
5774
|
|
|
3920
5775
|
/**
|
|
5776
|
+
* Provides access to Page Editor data and methods, if available.
|
|
5777
|
+
* `undefined` is returned when used outside of Page Editor.
|
|
5778
|
+
*
|
|
3921
5779
|
* @public
|
|
3922
5780
|
*/
|
|
3923
5781
|
export declare const useOptionalPageEditor: OptionalPageEditorHook;
|
|
3924
5782
|
|
|
3925
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
|
+
|
|
5805
|
+
/**
|
|
5806
|
+
* Provides access to Structure Group Editor data and methods, if available.
|
|
5807
|
+
* `undefined` is returned when used outside of Structure Group Editor.
|
|
5808
|
+
*
|
|
3926
5809
|
* @public
|
|
3927
5810
|
*/
|
|
3928
5811
|
export declare const useOptionalStructureGroupEditor: OptionalStructureGroupEditorHook;
|
|
3929
5812
|
|
|
3930
5813
|
/**
|
|
5814
|
+
* Retrieves the context of the provided publication within the BluePrint hierarchy.
|
|
5815
|
+
*
|
|
3931
5816
|
* @public
|
|
3932
5817
|
*/
|
|
3933
5818
|
export declare const usePublicationBlueprintHierarchyQuery: PublicationBlueprintHierarchyQueryHook;
|
|
@@ -3938,36 +5823,72 @@ export declare const usePublicationBlueprintHierarchyQuery: PublicationBlueprint
|
|
|
3938
5823
|
export declare const usePublicationsQuery: PublicationsQueryHook;
|
|
3939
5824
|
|
|
3940
5825
|
/**
|
|
5826
|
+
* Retrieves a list of Target Types for the provided Business Process Type.
|
|
5827
|
+
*
|
|
3941
5828
|
* @public
|
|
3942
5829
|
*/
|
|
3943
5830
|
export declare const usePublishableTargetTypesQuery: PublishableTargetTypesQueryHook;
|
|
3944
5831
|
|
|
3945
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
|
+
|
|
5852
|
+
/**
|
|
5853
|
+
* Publishes a list of items with provided instructions.
|
|
5854
|
+
*
|
|
3946
5855
|
* @public
|
|
3947
5856
|
*/
|
|
3948
5857
|
export declare const usePublishItemsMutation: PublishItemsMutationHook;
|
|
3949
5858
|
|
|
3950
5859
|
/**
|
|
5860
|
+
* Removes a list of items from a given bundle.
|
|
5861
|
+
*
|
|
3951
5862
|
* @public
|
|
3952
5863
|
*/
|
|
3953
5864
|
export declare const useRemoveFromBundleMutation: RemoveFromBundleMutationHook;
|
|
3954
5865
|
|
|
3955
5866
|
/**
|
|
5867
|
+
* Restarts failed activities.
|
|
5868
|
+
*
|
|
3956
5869
|
* @public
|
|
3957
5870
|
*/
|
|
3958
5871
|
export declare const useRestartActivitiesMutation: RestartActivitiesMutationHook;
|
|
3959
5872
|
|
|
3960
5873
|
/**
|
|
5874
|
+
* Restarts an activity which is failed.
|
|
5875
|
+
*
|
|
3961
5876
|
* @public
|
|
3962
5877
|
*/
|
|
3963
5878
|
export declare const useRestartActivityMutation: RestartActivityMutationHook;
|
|
3964
5879
|
|
|
3965
5880
|
/**
|
|
5881
|
+
* Reverts the item to the last major version.
|
|
5882
|
+
* If the item does not have a major version, it is deleted.
|
|
5883
|
+
*
|
|
3966
5884
|
* @public
|
|
3967
5885
|
*/
|
|
3968
5886
|
export declare const useRevertItemMutation: RevertItemMutationHook;
|
|
3969
5887
|
|
|
3970
5888
|
/**
|
|
5889
|
+
* Reverts a list of items item to their last major version.
|
|
5890
|
+
* If any of the items do not have a major version, they are deleted.
|
|
5891
|
+
*
|
|
3971
5892
|
* @public
|
|
3972
5893
|
*/
|
|
3973
5894
|
export declare const useRevertItemsMutation: RevertItemsMutationHook;
|
|
@@ -3981,9 +5902,22 @@ export declare type UserGroupsQueryHook = (props?: UserGroupsQueryProps, options
|
|
|
3981
5902
|
* @public
|
|
3982
5903
|
*/
|
|
3983
5904
|
export declare interface UserGroupsQueryProps {
|
|
5905
|
+
/**
|
|
5906
|
+
* If specified, return only groups which are scoped to the Publication ID.
|
|
5907
|
+
*/
|
|
3984
5908
|
inPublicationId?: ItemUri;
|
|
5909
|
+
/**
|
|
5910
|
+
* Specifies whether the special "Everyone" Group (representing all CM users) should be returned.
|
|
5911
|
+
*/
|
|
3985
5912
|
includeEveryone?: boolean;
|
|
5913
|
+
/**
|
|
5914
|
+
* If specified, return only groups with titles matching this value.
|
|
5915
|
+
*/
|
|
3986
5916
|
search?: string;
|
|
5917
|
+
/**
|
|
5918
|
+
* Specifies how to match on the group title.
|
|
5919
|
+
* @defaultValue Contains
|
|
5920
|
+
*/
|
|
3987
5921
|
searchMode?: UserGroupsQuerySearchMode;
|
|
3988
5922
|
}
|
|
3989
5923
|
|
|
@@ -3993,6 +5927,8 @@ export declare interface UserGroupsQueryProps {
|
|
|
3993
5927
|
export declare type UserGroupsQuerySearchMode = StringSearchMode;
|
|
3994
5928
|
|
|
3995
5929
|
/**
|
|
5930
|
+
* Rolls back all changes that have been made to an item since a specified version.
|
|
5931
|
+
*
|
|
3996
5932
|
* @public
|
|
3997
5933
|
*/
|
|
3998
5934
|
export declare const useRollbackItemMutation: RollbackItemMutationHook;
|
|
@@ -4006,6 +5942,9 @@ export declare type UserProfileHook = () => UserProfileHookResult;
|
|
|
4006
5942
|
* @public
|
|
4007
5943
|
*/
|
|
4008
5944
|
export declare interface UserProfileHookResult {
|
|
5945
|
+
/**
|
|
5946
|
+
* `UserProfile` instance of the logged-in Tridion user.
|
|
5947
|
+
*/
|
|
4009
5948
|
userProfile: UserProfile;
|
|
4010
5949
|
}
|
|
4011
5950
|
|
|
@@ -4023,9 +5962,27 @@ export declare type UsersQueryHook = (props?: UsersQueryProps, options?: QueryOp
|
|
|
4023
5962
|
* @public
|
|
4024
5963
|
*/
|
|
4025
5964
|
export declare interface UsersQueryProps {
|
|
5965
|
+
/**
|
|
5966
|
+
* If specified, return only non-predefined users or predefined users.
|
|
5967
|
+
*
|
|
5968
|
+
* @example
|
|
5969
|
+
* - `undefined` - all of the users returned
|
|
5970
|
+
* - `true` - predefined only users returned
|
|
5971
|
+
* - `false` - non-predefined only users returned
|
|
5972
|
+
*/
|
|
4026
5973
|
predefined?: boolean;
|
|
5974
|
+
/**
|
|
5975
|
+
* Specifies whether to include disabled user accounts. These are excluded by default.
|
|
5976
|
+
*/
|
|
4027
5977
|
includeDisabled?: boolean;
|
|
5978
|
+
/**
|
|
5979
|
+
* If specified, return only users whose account name (Title) matches this value.
|
|
5980
|
+
*/
|
|
4028
5981
|
search?: string;
|
|
5982
|
+
/**
|
|
5983
|
+
* Specifies how to match on the account name.
|
|
5984
|
+
* @defaultValue Contains
|
|
5985
|
+
*/
|
|
4029
5986
|
searchMode?: UsersQuerySearchMode;
|
|
4030
5987
|
}
|
|
4031
5988
|
|
|
@@ -4035,6 +5992,8 @@ export declare interface UsersQueryProps {
|
|
|
4035
5992
|
export declare type UsersQuerySearchMode = StringSearchMode;
|
|
4036
5993
|
|
|
4037
5994
|
/**
|
|
5995
|
+
* Retrieves search results within an individual item for the provided input.
|
|
5996
|
+
*
|
|
4038
5997
|
* @public
|
|
4039
5998
|
*/
|
|
4040
5999
|
export declare const useSearchInContainerQuery: SearchInContainerQueryHook;
|
|
@@ -4050,36 +6009,51 @@ export declare const useStartActivitiesMutation: StartActivitiesMutationHook;
|
|
|
4050
6009
|
export declare const useStartActivityMutation: StartActivityMutationHook;
|
|
4051
6010
|
|
|
4052
6011
|
/**
|
|
6012
|
+
* Starts a new workflow and associates the bundle and all items inside it with that workflow instance.
|
|
6013
|
+
*
|
|
4053
6014
|
* @public
|
|
4054
6015
|
*/
|
|
4055
6016
|
export declare const useStartWorkflowMutation: StartWorkflowMutationHook;
|
|
4056
6017
|
|
|
4057
6018
|
/**
|
|
6019
|
+
* Retrieves search results within the system for the provided input.
|
|
6020
|
+
*
|
|
4058
6021
|
* @public
|
|
4059
6022
|
*/
|
|
4060
6023
|
export declare const useSystemSearchQuery: SystemSearchQueryHook;
|
|
4061
6024
|
|
|
4062
6025
|
/**
|
|
6026
|
+
* Unlocalizes a single item which removes its local copy from a publication.
|
|
6027
|
+
*
|
|
4063
6028
|
* @public
|
|
4064
6029
|
*/
|
|
4065
6030
|
export declare const useUnlocalizeItemMutation: UnlocalizeItemMutationHook;
|
|
4066
6031
|
|
|
4067
6032
|
/**
|
|
6033
|
+
* Unlocalizes a list of items which removes their local copies from a publication.
|
|
6034
|
+
*
|
|
4068
6035
|
* @public
|
|
4069
6036
|
*/
|
|
4070
6037
|
export declare const useUnlocalizeItemsMutation: UnlocalizeItemsMutationHook;
|
|
4071
6038
|
|
|
4072
6039
|
/**
|
|
6040
|
+
* Unpublishes a list of items with provided instructions.
|
|
6041
|
+
*
|
|
4073
6042
|
* @public
|
|
4074
6043
|
*/
|
|
4075
6044
|
export declare const useUnpublishItemsMutation: UnpublishItemsMutationHook;
|
|
4076
6045
|
|
|
4077
6046
|
/**
|
|
6047
|
+
* Updates an item by URI.
|
|
6048
|
+
*
|
|
4078
6049
|
* @public
|
|
4079
6050
|
*/
|
|
4080
6051
|
export declare const useUpdateItemMutation: UpdateItemMutationHook;
|
|
4081
6052
|
|
|
4082
6053
|
/**
|
|
6054
|
+
* Uploads multimedia files and creates multimedia components out of them.
|
|
6055
|
+
* Uploading is done using a queue, which limits the number of files being uploaded at the same time.
|
|
6056
|
+
*
|
|
4083
6057
|
* @public
|
|
4084
6058
|
*/
|
|
4085
6059
|
export declare const useUploadMultimediaMutation: UploadMultimediaMutationHook;
|
|
@@ -4090,11 +6064,15 @@ export declare const useUploadMultimediaMutation: UploadMultimediaMutationHook;
|
|
|
4090
6064
|
export declare const useUserGroupsQuery: UserGroupsQueryHook;
|
|
4091
6065
|
|
|
4092
6066
|
/**
|
|
6067
|
+
* Provides access to user profile data and methods.
|
|
6068
|
+
*
|
|
4093
6069
|
* @public
|
|
4094
6070
|
*/
|
|
4095
6071
|
export declare const useUserProfile: UserProfileHook;
|
|
4096
6072
|
|
|
4097
6073
|
/**
|
|
6074
|
+
* Retrieves user profile data of the currently logged-in user.
|
|
6075
|
+
*
|
|
4098
6076
|
* @public
|
|
4099
6077
|
*/
|
|
4100
6078
|
export declare const useUserProfileQuery: UserProfileQueryHook;
|
|
@@ -4121,6 +6099,11 @@ export declare interface ZIndex {
|
|
|
4121
6099
|
highest: number;
|
|
4122
6100
|
}
|
|
4123
6101
|
|
|
6102
|
+
/**
|
|
6103
|
+
* @public
|
|
6104
|
+
*/
|
|
6105
|
+
export declare type ZIndexGetter = () => ZIndex;
|
|
6106
|
+
|
|
4124
6107
|
/**
|
|
4125
6108
|
* @public
|
|
4126
6109
|
*/
|