@tridion-sites/extensions 0.5.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 +95 -0
- package/LICENSE.md +322 -0
- package/dist/index.d.ts +3214 -0
- package/dist/index.js +1451 -0
- package/dist/tsdoc-metadata.json +11 -0
- package/package.json +62 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,3214 @@
|
|
|
1
|
+
import type { ActivityInstance } from '@tridion-sites/models';
|
|
2
|
+
import type { ActivityState } from '@tridion-sites/models';
|
|
3
|
+
import type { ApiError } from '@tridion-sites/models';
|
|
4
|
+
import type { Batch } from '@tridion-sites/models';
|
|
5
|
+
import type { Bundle } from '@tridion-sites/models';
|
|
6
|
+
import type { ClassificationInfo } from '@tridion-sites/models';
|
|
7
|
+
import type { Component } from '@tridion-sites/models';
|
|
8
|
+
import type { ComponentType } from 'react';
|
|
9
|
+
import type { Editor } from 'tinymce';
|
|
10
|
+
import type { ExternalMultimediaComponent } from '@tridion-sites/models';
|
|
11
|
+
import type { FinishActivityResult } from '@tridion-sites/models';
|
|
12
|
+
import type { Folder } from '@tridion-sites/models';
|
|
13
|
+
import type { FunctionComponent } from 'react';
|
|
14
|
+
import type { IdentifiableObject } from '@tridion-sites/models';
|
|
15
|
+
import type { ItemBlueprintHierarchy } from '@tridion-sites/models';
|
|
16
|
+
import type { ItemFieldDefinition } from '@tridion-sites/models';
|
|
17
|
+
import type { ItemType } from '@tridion-sites/models';
|
|
18
|
+
import type { ItemUri } from '@tridion-sites/models';
|
|
19
|
+
import type { Keyword } from '@tridion-sites/models';
|
|
20
|
+
import type { KeywordCategory } from '@tridion-sites/models';
|
|
21
|
+
import type { Link as Link_2 } from '@tridion-sites/models';
|
|
22
|
+
import type { MouseEvent as MouseEvent_2 } from 'react';
|
|
23
|
+
import type { MultimediaComponent } from '@tridion-sites/models';
|
|
24
|
+
import type { Page } from '@tridion-sites/models';
|
|
25
|
+
import type { PageTemplate } from '@tridion-sites/models';
|
|
26
|
+
import type { ProcessInstance } from '@tridion-sites/models';
|
|
27
|
+
import type { Publication } from '@tridion-sites/models';
|
|
28
|
+
import type { PublicationBlueprintHierarchy } from '@tridion-sites/models';
|
|
29
|
+
import type { PublishInfo } from '@tridion-sites/models';
|
|
30
|
+
import type { PublishPriority } from '@tridion-sites/models';
|
|
31
|
+
import type { PublishTransactionsCreationResult } from '@tridion-sites/models';
|
|
32
|
+
import type { PublishUrlInfo } from '@tridion-sites/models';
|
|
33
|
+
import type { QueryKey } from 'react-query';
|
|
34
|
+
import type { RawEditorOptions } from 'tinymce';
|
|
35
|
+
import type { ReactElement } from 'react';
|
|
36
|
+
import type { ReactNode } from 'react';
|
|
37
|
+
import type { RepositoryLocalObject } from '@tridion-sites/models';
|
|
38
|
+
import type { ResolvedItem } from '@tridion-sites/models';
|
|
39
|
+
import type { RloItemType } from '@tridion-sites/models';
|
|
40
|
+
import type { Schema } from '@tridion-sites/models';
|
|
41
|
+
import type { StringSearchMode } from '@tridion-sites/models';
|
|
42
|
+
import type { StructureGroup } from '@tridion-sites/models';
|
|
43
|
+
import type { StructureResolveOption } from '@tridion-sites/models';
|
|
44
|
+
import type { TargetType } from '@tridion-sites/models';
|
|
45
|
+
import type { TranslationInfo } from '@tridion-sites/models';
|
|
46
|
+
import type { TranslationJob } from '@tridion-sites/models';
|
|
47
|
+
import type { TranslationJobType } from '@tridion-sites/models';
|
|
48
|
+
import type { UseMutationOptions } from 'react-query';
|
|
49
|
+
import type { UseMutationResult } from 'react-query';
|
|
50
|
+
import type { UseQueryOptions } from 'react-query';
|
|
51
|
+
import type { UseQueryResult } from 'react-query';
|
|
52
|
+
import type { User } from '@tridion-sites/models';
|
|
53
|
+
import type { UserGroup } from '@tridion-sites/models';
|
|
54
|
+
import type { UserProfile } from '@tridion-sites/models';
|
|
55
|
+
import type { VersionedItem } from '@tridion-sites/models';
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* @internal
|
|
59
|
+
*/
|
|
60
|
+
export declare type ActionExtension = () => ActionExtensionConfiguration;
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* @internal
|
|
64
|
+
*/
|
|
65
|
+
export declare interface ActionExtensionConfiguration {
|
|
66
|
+
readonly id: string;
|
|
67
|
+
readonly label: string;
|
|
68
|
+
readonly icon: CustomIcon;
|
|
69
|
+
readonly useAction: ActionHook;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* @internal
|
|
74
|
+
*/
|
|
75
|
+
export declare interface ActionGroup {
|
|
76
|
+
readonly id: string;
|
|
77
|
+
readonly label: string;
|
|
78
|
+
readonly actionIds: readonly string[];
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* @internal
|
|
83
|
+
*/
|
|
84
|
+
export declare type ActionHook = () => ActionHookResult;
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
89
|
+
export declare interface ActionHookResult {
|
|
90
|
+
readonly isAvailable: boolean;
|
|
91
|
+
readonly execute: () => void;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* @internal
|
|
96
|
+
*/
|
|
97
|
+
export declare type ActionsConfiguration = ListBuilderConfiguration<ActionGroup>;
|
|
98
|
+
|
|
99
|
+
/**
|
|
100
|
+
* @internal
|
|
101
|
+
*/
|
|
102
|
+
export declare type ActionsConfigurationExtension = ListBuilderConfigurationExtension<ActionGroup>;
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
export declare class ActionsConfigurationExtensionsBuilder extends ListBuilder<ActionGroup> {
|
|
108
|
+
constructor();
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* @internal
|
|
113
|
+
*/
|
|
114
|
+
export declare type ActivitiesExplorerActionGroupId = ValuesOfArray<typeof activitiesExplorerActionGroupIds>;
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* @internal
|
|
118
|
+
*/
|
|
119
|
+
export declare const activitiesExplorerActionGroupId: {
|
|
120
|
+
exporting: "exporting";
|
|
121
|
+
refreshing: "refreshing";
|
|
122
|
+
workflow: "workflow";
|
|
123
|
+
};
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* @internal
|
|
127
|
+
*/
|
|
128
|
+
export declare const activitiesExplorerActionGroupIds: readonly ["exporting", "refreshing", "workflow"];
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* @internal
|
|
132
|
+
*/
|
|
133
|
+
export declare type ActivitiesExplorerActionId = ValuesOfArray<typeof activitiesExplorerActionIds>;
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* @internal
|
|
137
|
+
*/
|
|
138
|
+
export declare const activitiesExplorerActionId: {
|
|
139
|
+
export: "export";
|
|
140
|
+
refresh: "refresh";
|
|
141
|
+
startActivity: "startActivity";
|
|
142
|
+
finishActivity: "finishActivity";
|
|
143
|
+
restartActivity: "restartActivity";
|
|
144
|
+
assignActivity: "assignActivity";
|
|
145
|
+
};
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* @internal
|
|
149
|
+
*/
|
|
150
|
+
export declare const activitiesExplorerActionIds: readonly ["export", "refresh", "startActivity", "finishActivity", "restartActivity", "assignActivity"];
|
|
151
|
+
|
|
152
|
+
/**
|
|
153
|
+
* @internal
|
|
154
|
+
*/
|
|
155
|
+
export declare interface ActivitiesExplorerApiStorage {
|
|
156
|
+
hooks: ActivitiesExplorerHooksApiStorage;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
/**
|
|
160
|
+
* @internal
|
|
161
|
+
*/
|
|
162
|
+
export declare interface ActivitiesExplorerExtensions {
|
|
163
|
+
actions: ReadonlyArray<ActionExtension>;
|
|
164
|
+
table: ActivitiesExplorerTableExtensions;
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
/**
|
|
168
|
+
* @internal
|
|
169
|
+
*/
|
|
170
|
+
export declare class ActivitiesExplorerExtensionsBuilder {
|
|
171
|
+
private _actions;
|
|
172
|
+
readonly table: ActivitiesExplorerTableExtensionsBuilder;
|
|
173
|
+
addAction: (action: ActionExtension) => this;
|
|
174
|
+
build: () => ActivitiesExplorerExtensions;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* @internal
|
|
179
|
+
*/
|
|
180
|
+
export declare interface ActivitiesExplorerHooksApiStorage {
|
|
181
|
+
useActivitiesExplorerTable: ActivitiesExplorerTableHook;
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
/**
|
|
185
|
+
* @internal
|
|
186
|
+
*/
|
|
187
|
+
export declare type ActivitiesExplorerTableColumnExtension = TableColumnExtension<ActivityInstance>;
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* @internal
|
|
191
|
+
*/
|
|
192
|
+
export declare interface ActivitiesExplorerTableColumnExtensionComponentProps extends TableColumnExtensionComponentProps<ActivityInstance> {
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* @internal
|
|
197
|
+
*/
|
|
198
|
+
export declare interface ActivitiesExplorerTableColumnExtensionConfiguration extends TableColumnExtensionConfiguration<ActivityInstance> {
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
/**
|
|
202
|
+
* @internal
|
|
203
|
+
*/
|
|
204
|
+
export declare type ActivitiesExplorerTableColumnIsAvailableHook = TableColumnIsAvailableHook;
|
|
205
|
+
|
|
206
|
+
/**
|
|
207
|
+
* @internal
|
|
208
|
+
*/
|
|
209
|
+
export declare interface ActivitiesExplorerTableExtensions {
|
|
210
|
+
actions: ReadonlyArray<ActionExtension>;
|
|
211
|
+
columns: ReadonlyArray<ActivitiesExplorerTableColumnExtension>;
|
|
212
|
+
contextMenu: ReadonlyArray<ActionsConfigurationExtension>;
|
|
213
|
+
toolbar: ReadonlyArray<ActionsConfigurationExtension>;
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
/**
|
|
217
|
+
* @internal
|
|
218
|
+
*/
|
|
219
|
+
export declare class ActivitiesExplorerTableExtensionsBuilder {
|
|
220
|
+
private _actions;
|
|
221
|
+
private _columns;
|
|
222
|
+
readonly toolbar: ActionsConfigurationExtensionsBuilder;
|
|
223
|
+
readonly contextMenu: ActionsConfigurationExtensionsBuilder;
|
|
224
|
+
addColumn: (column: ActivitiesExplorerTableColumnExtension) => this;
|
|
225
|
+
addAction: (action: ActionExtension) => this;
|
|
226
|
+
build: () => ActivitiesExplorerTableExtensions;
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
/**
|
|
230
|
+
* @internal
|
|
231
|
+
*/
|
|
232
|
+
export declare type ActivitiesExplorerTableHook = () => ActivitiesExplorerTableHookResult;
|
|
233
|
+
|
|
234
|
+
/**
|
|
235
|
+
* @internal
|
|
236
|
+
*/
|
|
237
|
+
export declare interface ActivitiesExplorerTableHookResult {
|
|
238
|
+
refresh: () => void;
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
/**
|
|
242
|
+
* @internal
|
|
243
|
+
*/
|
|
244
|
+
export declare type ActivityInstancesQueryHook = (props?: ActivityInstancesQueryProps, options?: QueryOptions<ReadonlyArray<ActivityInstance> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<ActivityInstance> | undefined, ApiError>;
|
|
245
|
+
|
|
246
|
+
/**
|
|
247
|
+
* @internal
|
|
248
|
+
*/
|
|
249
|
+
export declare interface ActivityInstancesQueryProps {
|
|
250
|
+
forAllUsers?: boolean;
|
|
251
|
+
activityStates?: ReadonlyArray<ActivityState>;
|
|
252
|
+
processDefinitionId?: ItemUri;
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
/**
|
|
256
|
+
* @internal
|
|
257
|
+
*/
|
|
258
|
+
export declare type AddToBundleMutationHook = (options?: UseMutationOptions<MutationResponse, ApiError, AddToBundleRequest>) => UseMutationResult<MutationResponse, ApiError, AddToBundleRequest>;
|
|
259
|
+
|
|
260
|
+
/**
|
|
261
|
+
* @internal
|
|
262
|
+
*/
|
|
263
|
+
export declare interface AddToBundleRequest {
|
|
264
|
+
bundleId: ItemUri;
|
|
265
|
+
itemsToAdd: ReadonlyArray<IdentifiableObject>;
|
|
266
|
+
contextItem?: IdentifiableObject;
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* @internal
|
|
271
|
+
*/
|
|
272
|
+
export declare type AssignActivitiesMutationHook = (options?: BatchMutationOptions<AssignActivitiesRequest>) => UseMutationResult<Batch, ApiError, AssignActivitiesRequest>;
|
|
273
|
+
|
|
274
|
+
/**
|
|
275
|
+
* @internal
|
|
276
|
+
*/
|
|
277
|
+
export declare interface AssignActivitiesRequest {
|
|
278
|
+
itemIds: ReadonlyArray<ItemUri>;
|
|
279
|
+
newAssigneeId: ItemUri;
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* @internal
|
|
284
|
+
*/
|
|
285
|
+
export declare type AssignActivityMutationHook = (options?: UseMutationOptions<ActivityInstance, ApiError, AssignActivityRequest>) => UseMutationResult<ActivityInstance, ApiError, AssignActivityRequest>;
|
|
286
|
+
|
|
287
|
+
/**
|
|
288
|
+
* @internal
|
|
289
|
+
*/
|
|
290
|
+
export declare interface AssignActivityRequest {
|
|
291
|
+
activityId: ItemUri;
|
|
292
|
+
newAssigneeId: ItemUri;
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
/**
|
|
296
|
+
* @internal
|
|
297
|
+
*/
|
|
298
|
+
export declare type AutoClassifyItemMutationHook = (options?: UseMutationOptions<ClassificationInfo, ApiError, AutoClassifyItemRequest>) => UseMutationResult<ClassificationInfo, ApiError, AutoClassifyItemRequest>;
|
|
299
|
+
|
|
300
|
+
/**
|
|
301
|
+
* @internal
|
|
302
|
+
*/
|
|
303
|
+
export declare interface AutoClassifyItemRequest {
|
|
304
|
+
itemId: ItemUri;
|
|
305
|
+
contextItem?: IdentifiableObject;
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
/**
|
|
309
|
+
* @internal
|
|
310
|
+
*/
|
|
311
|
+
export declare type AutoClassifyItemsMutationHook = (options?: BatchMutationOptions<AutoClassifyItemsRequest>) => UseMutationResult<Batch, ApiError, AutoClassifyItemsRequest>;
|
|
312
|
+
|
|
313
|
+
/**
|
|
314
|
+
* @internal
|
|
315
|
+
*/
|
|
316
|
+
export declare interface AutoClassifyItemsRequest {
|
|
317
|
+
itemIds: ReadonlyArray<ItemUri>;
|
|
318
|
+
containerId: ItemUri;
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
/**
|
|
322
|
+
* @internal
|
|
323
|
+
*/
|
|
324
|
+
declare type BatchMutationOptions<TVariables> = Without<UseMutationOptions<Batch, ApiError, TVariables>, 'mutationFn'>;
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* @internal
|
|
328
|
+
*/
|
|
329
|
+
export declare interface BundleEditorApiStorage {
|
|
330
|
+
hooks: BundleEditorHooksApiStorage;
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
/**
|
|
334
|
+
* @internal
|
|
335
|
+
*/
|
|
336
|
+
export declare type BundleEditorHook = () => BundleEditorHookResult | undefined;
|
|
337
|
+
|
|
338
|
+
/**
|
|
339
|
+
* @internal
|
|
340
|
+
*/
|
|
341
|
+
export declare interface BundleEditorHookResult {
|
|
342
|
+
bundle: Bundle;
|
|
343
|
+
metadataSchema: Schema;
|
|
344
|
+
isChanged: boolean;
|
|
345
|
+
isEditing: boolean;
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
/**
|
|
349
|
+
* @internal
|
|
350
|
+
*/
|
|
351
|
+
export declare interface BundleEditorHooksApiStorage {
|
|
352
|
+
useBundleEditor: BundleEditorHook;
|
|
353
|
+
}
|
|
354
|
+
|
|
355
|
+
/**
|
|
356
|
+
* A component that has standard button functionality.
|
|
357
|
+
* @internal
|
|
358
|
+
*/
|
|
359
|
+
export declare const Button: ButtonComponent;
|
|
360
|
+
|
|
361
|
+
/**
|
|
362
|
+
* @internal
|
|
363
|
+
*/
|
|
364
|
+
export declare type ButtonComponent = FunctionComponent<ButtonProps>;
|
|
365
|
+
|
|
366
|
+
/**
|
|
367
|
+
* @internal
|
|
368
|
+
*/
|
|
369
|
+
export declare interface ButtonProps {
|
|
370
|
+
/**
|
|
371
|
+
* Callback executed when the button is clicked.
|
|
372
|
+
*/
|
|
373
|
+
onClick: (event: MouseEvent_2) => void;
|
|
374
|
+
/**
|
|
375
|
+
* If `true`, the element is displayed in a disabled state.
|
|
376
|
+
*/
|
|
377
|
+
isDisabled?: boolean;
|
|
378
|
+
/**
|
|
379
|
+
* If `true`, the element shows a processing indicator.
|
|
380
|
+
*/
|
|
381
|
+
isProcessing?: boolean;
|
|
382
|
+
/**
|
|
383
|
+
* Text that is displayed inside button, i.e., the button label.
|
|
384
|
+
* If omitted, you must provide a `tooltip`.
|
|
385
|
+
*/
|
|
386
|
+
label?: string;
|
|
387
|
+
/**
|
|
388
|
+
* A tooltip text that is displayed when the element is hovered.
|
|
389
|
+
* Can be omitted if `label` is specified. Required if there is no `label` specified.
|
|
390
|
+
* For accessibility purposes, the tooltip is only displayed when it differs from the label.
|
|
391
|
+
*/
|
|
392
|
+
tooltip?: string;
|
|
393
|
+
}
|
|
394
|
+
|
|
395
|
+
/**
|
|
396
|
+
* @internal
|
|
397
|
+
*/
|
|
398
|
+
export declare interface CategoryEditorApiStorage {
|
|
399
|
+
hooks: CategoryEditorHooksApiStorage;
|
|
400
|
+
}
|
|
401
|
+
|
|
402
|
+
/**
|
|
403
|
+
* @internal
|
|
404
|
+
*/
|
|
405
|
+
export declare type CategoryEditorHook = () => CategoryEditorHookResult | undefined;
|
|
406
|
+
|
|
407
|
+
/**
|
|
408
|
+
* @internal
|
|
409
|
+
*/
|
|
410
|
+
export declare interface CategoryEditorHookResult {
|
|
411
|
+
category: KeywordCategory;
|
|
412
|
+
metadataSchema: Schema;
|
|
413
|
+
isChanged: boolean;
|
|
414
|
+
isEditing: boolean;
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
/**
|
|
418
|
+
* @internal
|
|
419
|
+
*/
|
|
420
|
+
export declare interface CategoryEditorHooksApiStorage {
|
|
421
|
+
useCategoryEditor: CategoryEditorHook;
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
/**
|
|
425
|
+
* @internal
|
|
426
|
+
*/
|
|
427
|
+
export declare type ChangeUserLanguageMutationHook = (options?: UseMutationOptions<User, ApiError, ChangeUserLanguageRequest>) => UseMutationResult<User, ApiError, ChangeUserLanguageRequest>;
|
|
428
|
+
|
|
429
|
+
/**
|
|
430
|
+
* @internal
|
|
431
|
+
*/
|
|
432
|
+
export declare interface ChangeUserLanguageRequest {
|
|
433
|
+
userId: ItemUri;
|
|
434
|
+
languageId: number;
|
|
435
|
+
}
|
|
436
|
+
|
|
437
|
+
/**
|
|
438
|
+
* @internal
|
|
439
|
+
*/
|
|
440
|
+
export declare type ChangeUserLocaleMutationHook = (options?: UseMutationOptions<User, ApiError, ChangeUserLocaleRequest>) => UseMutationResult<User, ApiError, ChangeUserLocaleRequest>;
|
|
441
|
+
|
|
442
|
+
/**
|
|
443
|
+
* @internal
|
|
444
|
+
*/
|
|
445
|
+
export declare interface ChangeUserLocaleRequest {
|
|
446
|
+
userId: ItemUri;
|
|
447
|
+
localeId: number;
|
|
448
|
+
}
|
|
449
|
+
|
|
450
|
+
/**
|
|
451
|
+
* @internal
|
|
452
|
+
*/
|
|
453
|
+
export declare type Color = keyof ColorPalette;
|
|
454
|
+
|
|
455
|
+
/**
|
|
456
|
+
* @internal
|
|
457
|
+
*/
|
|
458
|
+
export declare interface ColorPalette {
|
|
459
|
+
transparent: string;
|
|
460
|
+
brandLight: string;
|
|
461
|
+
brandPrimary: string;
|
|
462
|
+
brandAccessible: string;
|
|
463
|
+
brandDark: string;
|
|
464
|
+
gray0: string;
|
|
465
|
+
gray10: string;
|
|
466
|
+
gray20: string;
|
|
467
|
+
gray50: string;
|
|
468
|
+
gray80: string;
|
|
469
|
+
gray100: string;
|
|
470
|
+
gray120: string;
|
|
471
|
+
gray180: string;
|
|
472
|
+
blue50: string;
|
|
473
|
+
blue100: string;
|
|
474
|
+
red50: string;
|
|
475
|
+
red100: string;
|
|
476
|
+
red120: string;
|
|
477
|
+
orange50: string;
|
|
478
|
+
orange100: string;
|
|
479
|
+
magenta50: string;
|
|
480
|
+
magenta100: string;
|
|
481
|
+
magenta120: string;
|
|
482
|
+
yellow50: string;
|
|
483
|
+
yellow100: string;
|
|
484
|
+
yellow120: string;
|
|
485
|
+
}
|
|
486
|
+
|
|
487
|
+
/**
|
|
488
|
+
* @internal
|
|
489
|
+
*/
|
|
490
|
+
export declare interface ColorProps {
|
|
491
|
+
color?: Color | 'inherit';
|
|
492
|
+
}
|
|
493
|
+
|
|
494
|
+
/**
|
|
495
|
+
* @internal
|
|
496
|
+
*/
|
|
497
|
+
export declare interface ComponentEditorApiStorage {
|
|
498
|
+
hooks: ComponentEditorHooksApiStorage;
|
|
499
|
+
}
|
|
500
|
+
|
|
501
|
+
/**
|
|
502
|
+
* @internal
|
|
503
|
+
*/
|
|
504
|
+
export declare type ComponentEditorHook = () => ComponentEditorHookResult | undefined;
|
|
505
|
+
|
|
506
|
+
/**
|
|
507
|
+
* @internal
|
|
508
|
+
*/
|
|
509
|
+
export declare interface ComponentEditorHookResult {
|
|
510
|
+
component: Component | MultimediaComponent | ExternalMultimediaComponent;
|
|
511
|
+
schema: Schema;
|
|
512
|
+
isChanged: boolean;
|
|
513
|
+
isEditing: boolean;
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
/**
|
|
517
|
+
* @internal
|
|
518
|
+
*/
|
|
519
|
+
export declare interface ComponentEditorHooksApiStorage {
|
|
520
|
+
useComponentEditor: ComponentEditorHook;
|
|
521
|
+
}
|
|
522
|
+
|
|
523
|
+
/**
|
|
524
|
+
* @internal
|
|
525
|
+
*/
|
|
526
|
+
export declare type ConfirmationHook = (args: ConfirmationHookArguments) => ConfirmationHookResult;
|
|
527
|
+
|
|
528
|
+
/**
|
|
529
|
+
* @internal
|
|
530
|
+
*/
|
|
531
|
+
export declare interface ConfirmationHookArguments {
|
|
532
|
+
title: string;
|
|
533
|
+
onConfirm: () => void;
|
|
534
|
+
cancelButtonLabel?: string;
|
|
535
|
+
description?: ReactNode;
|
|
536
|
+
okButtonLabel?: string;
|
|
537
|
+
onCancel?: () => void;
|
|
538
|
+
}
|
|
539
|
+
|
|
540
|
+
/**
|
|
541
|
+
* @internal
|
|
542
|
+
*/
|
|
543
|
+
export declare type ConfirmationHookResult = () => void;
|
|
544
|
+
|
|
545
|
+
/**
|
|
546
|
+
* @internal
|
|
547
|
+
*/
|
|
548
|
+
export declare interface ContentEditorExtensions {
|
|
549
|
+
richTextField: RichTextFieldExtensions;
|
|
550
|
+
formFields: ReadonlyArray<ContentEditorFormFieldExtension>;
|
|
551
|
+
}
|
|
552
|
+
|
|
553
|
+
/**
|
|
554
|
+
* @internal
|
|
555
|
+
*/
|
|
556
|
+
export declare class ContentEditorExtensionsBuilder {
|
|
557
|
+
private _formFields;
|
|
558
|
+
readonly richTextField: RichTextFieldExtensionsBuilder;
|
|
559
|
+
addFormField: (item: ContentEditorFormFieldExtension) => this;
|
|
560
|
+
build: () => ContentEditorExtensions;
|
|
561
|
+
}
|
|
562
|
+
|
|
563
|
+
/**
|
|
564
|
+
* @internal
|
|
565
|
+
*/
|
|
566
|
+
export declare type ContentEditorFormFieldExtension = () => ContentEditorFormFieldExtensionConfiguration;
|
|
567
|
+
|
|
568
|
+
/**
|
|
569
|
+
* @internal
|
|
570
|
+
*/
|
|
571
|
+
export declare interface ContentEditorFormFieldExtensionConfiguration {
|
|
572
|
+
/**
|
|
573
|
+
* Extension id
|
|
574
|
+
*/
|
|
575
|
+
readonly id: string;
|
|
576
|
+
/**
|
|
577
|
+
* Component to render on this path
|
|
578
|
+
*/
|
|
579
|
+
readonly component: ComponentType<ContentEditorFormFieldExtensionProps>;
|
|
580
|
+
/**
|
|
581
|
+
* Hook which returns information about the current field for the extension
|
|
582
|
+
*/
|
|
583
|
+
readonly useFormField: (props: ContentEditorFormFieldHookProps) => ContentEditorFormFieldHookResult;
|
|
584
|
+
}
|
|
585
|
+
|
|
586
|
+
/**
|
|
587
|
+
* @internal
|
|
588
|
+
*/
|
|
589
|
+
export declare interface ContentEditorFormFieldExtensionProps<T = any> {
|
|
590
|
+
/**
|
|
591
|
+
* Value of the field
|
|
592
|
+
*/
|
|
593
|
+
value: T;
|
|
594
|
+
/**
|
|
595
|
+
* Field definition of the form field
|
|
596
|
+
*/
|
|
597
|
+
fieldDefinition: ItemFieldDefinition;
|
|
598
|
+
/**
|
|
599
|
+
* Boolean to indicate of the field is rendered in read only mode
|
|
600
|
+
*/
|
|
601
|
+
isReadOnly: boolean;
|
|
602
|
+
/**
|
|
603
|
+
* Set field value function
|
|
604
|
+
*/
|
|
605
|
+
setValue: (value: T) => void;
|
|
606
|
+
/**
|
|
607
|
+
* Original field to render
|
|
608
|
+
*/
|
|
609
|
+
renderField: ReactNode;
|
|
610
|
+
}
|
|
611
|
+
|
|
612
|
+
/**
|
|
613
|
+
* @internal
|
|
614
|
+
*/
|
|
615
|
+
export declare interface ContentEditorFormFieldHookProps {
|
|
616
|
+
/**
|
|
617
|
+
* Indicates whether the field is rendered in read only mode or not
|
|
618
|
+
*/
|
|
619
|
+
isReadOnly: boolean;
|
|
620
|
+
/**
|
|
621
|
+
* Field definition of the form field
|
|
622
|
+
*/
|
|
623
|
+
fieldDefinition: ItemFieldDefinition;
|
|
624
|
+
}
|
|
625
|
+
|
|
626
|
+
/**
|
|
627
|
+
* @internal
|
|
628
|
+
*/
|
|
629
|
+
export declare interface ContentEditorFormFieldHookResult {
|
|
630
|
+
/**
|
|
631
|
+
* Priority value of the field in the list of candidates for rendering.
|
|
632
|
+
* Extension with a higher priority will be displayed instead of an extension with lower priority.
|
|
633
|
+
* Helps to resolve collapsing cases when useIsAvailable returns true for two or more
|
|
634
|
+
* extensions for a single fields at the same time.
|
|
635
|
+
*/
|
|
636
|
+
priority?: number;
|
|
637
|
+
/**
|
|
638
|
+
* Defines whether the field extension is available to be displayed or not
|
|
639
|
+
*/
|
|
640
|
+
isAvailable: boolean;
|
|
641
|
+
}
|
|
642
|
+
|
|
643
|
+
/**
|
|
644
|
+
* @internal
|
|
645
|
+
*/
|
|
646
|
+
export declare type ContentExplorerActionGroupId = ValuesOfArray<typeof contentExplorerActionGroupIds>;
|
|
647
|
+
|
|
648
|
+
/**
|
|
649
|
+
* @internal
|
|
650
|
+
*/
|
|
651
|
+
export declare const contentExplorerActionGroupId: {
|
|
652
|
+
bundle: "bundle";
|
|
653
|
+
exporting: "exporting";
|
|
654
|
+
refreshing: "refreshing";
|
|
655
|
+
workflow: "workflow";
|
|
656
|
+
browsing: "browsing";
|
|
657
|
+
classification: "classification";
|
|
658
|
+
clipboard: "clipboard";
|
|
659
|
+
creation: "creation";
|
|
660
|
+
deletion: "deletion";
|
|
661
|
+
editing: "editing";
|
|
662
|
+
blueprinting: "blueprinting";
|
|
663
|
+
publishing: "publishing";
|
|
664
|
+
translation: "translation";
|
|
665
|
+
};
|
|
666
|
+
|
|
667
|
+
/**
|
|
668
|
+
* @internal
|
|
669
|
+
*/
|
|
670
|
+
export declare const contentExplorerActionGroupIds: readonly ["browsing", "bundle", "classification", "clipboard", "creation", "deletion", "editing", "exporting", "blueprinting", "publishing", "refreshing", "translation", "workflow"];
|
|
671
|
+
|
|
672
|
+
/**
|
|
673
|
+
* @internal
|
|
674
|
+
*/
|
|
675
|
+
export declare type ContentExplorerActionId = ValuesOfArray<typeof contentExplorerActionIds>;
|
|
676
|
+
|
|
677
|
+
/**
|
|
678
|
+
* @internal
|
|
679
|
+
*/
|
|
680
|
+
export declare const contentExplorerActionId: {
|
|
681
|
+
export: "export";
|
|
682
|
+
refresh: "refresh";
|
|
683
|
+
openEditor: "openEditor";
|
|
684
|
+
openEditorInNewTab: "openEditorInNewTab";
|
|
685
|
+
addSelectedItemsToBundle: "addSelectedItemsToBundle";
|
|
686
|
+
addToBundle: "addToBundle";
|
|
687
|
+
removeFromBundle: "removeFromBundle";
|
|
688
|
+
autoClassify: "autoClassify";
|
|
689
|
+
copy: "copy";
|
|
690
|
+
cut: "cut";
|
|
691
|
+
paste: "paste";
|
|
692
|
+
newBundle: "newBundle";
|
|
693
|
+
newCategory: "newCategory";
|
|
694
|
+
newComponent: "newComponent";
|
|
695
|
+
newFolder: "newFolder";
|
|
696
|
+
newKeyword: "newKeyword";
|
|
697
|
+
newMultimediaComponent: "newMultimediaComponent";
|
|
698
|
+
newPage: "newPage";
|
|
699
|
+
newStructureGroup: "newStructureGroup";
|
|
700
|
+
uploadMultimediaComponent: "uploadMultimediaComponent";
|
|
701
|
+
delete: "delete";
|
|
702
|
+
finishEditing: "finishEditing";
|
|
703
|
+
revert: "revert";
|
|
704
|
+
localize: "localize";
|
|
705
|
+
unlocalize: "unlocalize";
|
|
706
|
+
publish: "publish";
|
|
707
|
+
unpublish: "unpublish";
|
|
708
|
+
openPublishingQueue: "openPublishingQueue";
|
|
709
|
+
openTranslationQueue: "openTranslationQueue";
|
|
710
|
+
translate: "translate";
|
|
711
|
+
translateTarget: "translateTarget";
|
|
712
|
+
startWorkflow: "startWorkflow";
|
|
713
|
+
};
|
|
714
|
+
|
|
715
|
+
/**
|
|
716
|
+
* @internal
|
|
717
|
+
*/
|
|
718
|
+
export declare const contentExplorerActionIds: readonly ["openEditor", "openEditorInNewTab", "addSelectedItemsToBundle", "addToBundle", "removeFromBundle", "autoClassify", "copy", "cut", "paste", "newBundle", "newCategory", "newComponent", "newFolder", "newKeyword", "newMultimediaComponent", "newPage", "newStructureGroup", "uploadMultimediaComponent", "delete", "finishEditing", "revert", "export", "localize", "unlocalize", "publish", "unpublish", "openPublishingQueue", "refresh", "openTranslationQueue", "translate", "translateTarget", "startWorkflow"];
|
|
719
|
+
|
|
720
|
+
/**
|
|
721
|
+
* @internal
|
|
722
|
+
*/
|
|
723
|
+
export declare interface ContentExplorerApiStorage {
|
|
724
|
+
hooks: ContentExplorerHooksApiStorage;
|
|
725
|
+
utils: ContentExplorerUtilsApiStorage;
|
|
726
|
+
}
|
|
727
|
+
|
|
728
|
+
/**
|
|
729
|
+
* @internal
|
|
730
|
+
*/
|
|
731
|
+
export declare interface ContentExplorerExtensions {
|
|
732
|
+
table: ContentExplorerTableExtensions;
|
|
733
|
+
tree: ContentExplorerTreeExtensions;
|
|
734
|
+
}
|
|
735
|
+
|
|
736
|
+
/**
|
|
737
|
+
* @internal
|
|
738
|
+
*/
|
|
739
|
+
export declare class ContentExplorerExtensionsBuilder {
|
|
740
|
+
readonly table: ContentExplorerTableExtensionsBuilder;
|
|
741
|
+
readonly tree: ContentExplorerTreeExtensionsBuilder;
|
|
742
|
+
build: () => ContentExplorerExtensions;
|
|
743
|
+
}
|
|
744
|
+
|
|
745
|
+
/**
|
|
746
|
+
* @internal
|
|
747
|
+
*/
|
|
748
|
+
export declare type ContentExplorerHierarchy = ReadonlyHierarchy<ContentExplorerNodeData>;
|
|
749
|
+
|
|
750
|
+
/**
|
|
751
|
+
* @internal
|
|
752
|
+
*/
|
|
753
|
+
export declare interface ContentExplorerHierarchyUtilsExtensionApi {
|
|
754
|
+
isItemNode: (node: ContentExplorerNode) => node is ContentExplorerItemNode;
|
|
755
|
+
isFavoritesNodeId: (nodeId: string) => boolean;
|
|
756
|
+
isItemInProgressNodeId: (nodeId: string) => boolean;
|
|
757
|
+
isPublicationsNodeId: (nodeId: string) => boolean;
|
|
758
|
+
isRootNodeId: (nodeId: string) => boolean;
|
|
759
|
+
}
|
|
760
|
+
|
|
761
|
+
/**
|
|
762
|
+
* @internal
|
|
763
|
+
*/
|
|
764
|
+
export declare type ContentExplorerHook = () => ContentExplorerHookResult;
|
|
765
|
+
|
|
766
|
+
/**
|
|
767
|
+
* @internal
|
|
768
|
+
*/
|
|
769
|
+
export declare interface ContentExplorerHookResult {
|
|
770
|
+
hierarchy: ContentExplorerHierarchy;
|
|
771
|
+
currentNode: ContentExplorerNode;
|
|
772
|
+
loadingNodeIds: ReadonlySet<string>;
|
|
773
|
+
navigateTo: (props: NavigateToContentExplorerProps) => void;
|
|
774
|
+
}
|
|
775
|
+
|
|
776
|
+
/**
|
|
777
|
+
* @internal
|
|
778
|
+
*/
|
|
779
|
+
export declare interface ContentExplorerHooksApiStorage {
|
|
780
|
+
useContentExplorer: ContentExplorerHook;
|
|
781
|
+
useContentExplorerTable: ContentExplorerTableHook;
|
|
782
|
+
useContentExplorerTree: ContentExplorerTreeHook;
|
|
783
|
+
}
|
|
784
|
+
|
|
785
|
+
/**
|
|
786
|
+
* @internal
|
|
787
|
+
*/
|
|
788
|
+
export declare type ContentExplorerItemNode = ReadonlyHierarchyNode<ContentExplorerItemNodeData>;
|
|
789
|
+
|
|
790
|
+
/**
|
|
791
|
+
* @internal
|
|
792
|
+
*/
|
|
793
|
+
export declare interface ContentExplorerItemNodeData extends ContentExplorerNodeData {
|
|
794
|
+
/**
|
|
795
|
+
* Tridion item associated with the node.
|
|
796
|
+
*/
|
|
797
|
+
readonly item: IdentifiableObject;
|
|
798
|
+
}
|
|
799
|
+
|
|
800
|
+
/**
|
|
801
|
+
* @internal
|
|
802
|
+
*/
|
|
803
|
+
export declare type ContentExplorerNode = ReadonlyHierarchyNode<ContentExplorerNodeData>;
|
|
804
|
+
|
|
805
|
+
/**
|
|
806
|
+
* @internal
|
|
807
|
+
*/
|
|
808
|
+
export declare interface ContentExplorerNodeData {
|
|
809
|
+
/**
|
|
810
|
+
* Unique ID of the node.
|
|
811
|
+
*/
|
|
812
|
+
readonly nodeId: string;
|
|
813
|
+
/**
|
|
814
|
+
* Title of the node.
|
|
815
|
+
*/
|
|
816
|
+
readonly title: string;
|
|
817
|
+
/**
|
|
818
|
+
* Whether the node is loaded.
|
|
819
|
+
* Node is considered to be loaded if its children were loaded at least once.
|
|
820
|
+
*/
|
|
821
|
+
readonly isLoaded: boolean;
|
|
822
|
+
}
|
|
823
|
+
|
|
824
|
+
/**
|
|
825
|
+
* @internal
|
|
826
|
+
*/
|
|
827
|
+
export declare type ContentExplorerTableActionGroupId = ValuesOfArray<typeof contentExplorerTableActionGroupIds>;
|
|
828
|
+
|
|
829
|
+
/**
|
|
830
|
+
* @internal
|
|
831
|
+
*/
|
|
832
|
+
export declare const contentExplorerTableActionGroupId: {
|
|
833
|
+
bundle: "bundle";
|
|
834
|
+
exporting: "exporting";
|
|
835
|
+
refreshing: "refreshing";
|
|
836
|
+
workflow: "workflow";
|
|
837
|
+
browsing: "browsing";
|
|
838
|
+
classification: "classification";
|
|
839
|
+
clipboard: "clipboard";
|
|
840
|
+
creation: "creation";
|
|
841
|
+
deletion: "deletion";
|
|
842
|
+
editing: "editing";
|
|
843
|
+
blueprinting: "blueprinting";
|
|
844
|
+
publishing: "publishing";
|
|
845
|
+
translation: "translation";
|
|
846
|
+
};
|
|
847
|
+
|
|
848
|
+
/**
|
|
849
|
+
* @internal
|
|
850
|
+
*/
|
|
851
|
+
export declare const contentExplorerTableActionGroupIds: readonly ["browsing", "bundle", "classification", "clipboard", "creation", "deletion", "editing", "exporting", "blueprinting", "publishing", "refreshing", "translation", "workflow"];
|
|
852
|
+
|
|
853
|
+
/**
|
|
854
|
+
* @internal
|
|
855
|
+
*/
|
|
856
|
+
export declare type ContentExplorerTableActionId = ValuesOfArray<typeof contentExplorerTableActionIds>;
|
|
857
|
+
|
|
858
|
+
/**
|
|
859
|
+
* @internal
|
|
860
|
+
*/
|
|
861
|
+
export declare const contentExplorerTableActionId: {
|
|
862
|
+
export: "export";
|
|
863
|
+
refresh: "refresh";
|
|
864
|
+
openEditor: "openEditor";
|
|
865
|
+
openEditorInNewTab: "openEditorInNewTab";
|
|
866
|
+
addSelectedItemsToBundle: "addSelectedItemsToBundle";
|
|
867
|
+
addToBundle: "addToBundle";
|
|
868
|
+
removeFromBundle: "removeFromBundle";
|
|
869
|
+
autoClassify: "autoClassify";
|
|
870
|
+
copy: "copy";
|
|
871
|
+
cut: "cut";
|
|
872
|
+
paste: "paste";
|
|
873
|
+
newBundle: "newBundle";
|
|
874
|
+
newCategory: "newCategory";
|
|
875
|
+
newComponent: "newComponent";
|
|
876
|
+
newFolder: "newFolder";
|
|
877
|
+
newKeyword: "newKeyword";
|
|
878
|
+
newMultimediaComponent: "newMultimediaComponent";
|
|
879
|
+
newPage: "newPage";
|
|
880
|
+
newStructureGroup: "newStructureGroup";
|
|
881
|
+
uploadMultimediaComponent: "uploadMultimediaComponent";
|
|
882
|
+
delete: "delete";
|
|
883
|
+
finishEditing: "finishEditing";
|
|
884
|
+
revert: "revert";
|
|
885
|
+
localize: "localize";
|
|
886
|
+
unlocalize: "unlocalize";
|
|
887
|
+
publish: "publish";
|
|
888
|
+
unpublish: "unpublish";
|
|
889
|
+
openPublishingQueue: "openPublishingQueue";
|
|
890
|
+
openTranslationQueue: "openTranslationQueue";
|
|
891
|
+
translate: "translate";
|
|
892
|
+
translateTarget: "translateTarget";
|
|
893
|
+
startWorkflow: "startWorkflow";
|
|
894
|
+
open: "open";
|
|
895
|
+
};
|
|
896
|
+
|
|
897
|
+
/**
|
|
898
|
+
* @internal
|
|
899
|
+
*/
|
|
900
|
+
export declare const contentExplorerTableActionIds: readonly ["openEditor", "openEditorInNewTab", "addSelectedItemsToBundle", "addToBundle", "removeFromBundle", "autoClassify", "copy", "cut", "paste", "newBundle", "newCategory", "newComponent", "newFolder", "newKeyword", "newMultimediaComponent", "newPage", "newStructureGroup", "uploadMultimediaComponent", "delete", "finishEditing", "revert", "export", "localize", "unlocalize", "publish", "unpublish", "openPublishingQueue", "refresh", "openTranslationQueue", "translate", "translateTarget", "startWorkflow", "open"];
|
|
901
|
+
|
|
902
|
+
/**
|
|
903
|
+
* @internal
|
|
904
|
+
*/
|
|
905
|
+
export declare type ContentExplorerTableColumnExtension = TableColumnExtension<IdentifiableObject>;
|
|
906
|
+
|
|
907
|
+
/**
|
|
908
|
+
* @internal
|
|
909
|
+
*/
|
|
910
|
+
export declare interface ContentExplorerTableColumnExtensionComponentProps extends TableColumnExtensionComponentProps<IdentifiableObject> {
|
|
911
|
+
}
|
|
912
|
+
|
|
913
|
+
/**
|
|
914
|
+
* @internal
|
|
915
|
+
*/
|
|
916
|
+
export declare interface ContentExplorerTableColumnExtensionConfiguration extends TableColumnExtensionConfiguration<IdentifiableObject> {
|
|
917
|
+
}
|
|
918
|
+
|
|
919
|
+
/**
|
|
920
|
+
* @internal
|
|
921
|
+
*/
|
|
922
|
+
export declare type ContentExplorerTableColumnIsAvailableHook = TableColumnIsAvailableHook;
|
|
923
|
+
|
|
924
|
+
/**
|
|
925
|
+
* @internal
|
|
926
|
+
*/
|
|
927
|
+
export declare interface ContentExplorerTableExtensions {
|
|
928
|
+
actions: ReadonlyArray<ActionExtension>;
|
|
929
|
+
columns: ReadonlyArray<ContentExplorerTableColumnExtension>;
|
|
930
|
+
contextMenu: ReadonlyArray<ActionsConfigurationExtension>;
|
|
931
|
+
toolbar: ReadonlyArray<ActionsConfigurationExtension>;
|
|
932
|
+
}
|
|
933
|
+
|
|
934
|
+
/**
|
|
935
|
+
* @internal
|
|
936
|
+
*/
|
|
937
|
+
export declare class ContentExplorerTableExtensionsBuilder {
|
|
938
|
+
private _actions;
|
|
939
|
+
private _columns;
|
|
940
|
+
readonly toolbar: ActionsConfigurationExtensionsBuilder;
|
|
941
|
+
readonly contextMenu: ActionsConfigurationExtensionsBuilder;
|
|
942
|
+
addColumn: (column: ContentExplorerTableColumnExtension) => this;
|
|
943
|
+
addAction: (action: ActionExtension) => this;
|
|
944
|
+
build: () => ContentExplorerTableExtensions;
|
|
945
|
+
}
|
|
946
|
+
|
|
947
|
+
/**
|
|
948
|
+
* @internal
|
|
949
|
+
*/
|
|
950
|
+
export declare type ContentExplorerTableHook = () => ContentExplorerTableHookResult;
|
|
951
|
+
|
|
952
|
+
/**
|
|
953
|
+
* @internal
|
|
954
|
+
*/
|
|
955
|
+
export declare interface ContentExplorerTableHookResult {
|
|
956
|
+
refresh: () => void;
|
|
957
|
+
}
|
|
958
|
+
|
|
959
|
+
/**
|
|
960
|
+
* @internal
|
|
961
|
+
*/
|
|
962
|
+
export declare type ContentExplorerTreeActionGroupId = ValuesOfArray<typeof contentExplorerTreeActionGroupIds>;
|
|
963
|
+
|
|
964
|
+
/**
|
|
965
|
+
* @internal
|
|
966
|
+
*/
|
|
967
|
+
export declare const contentExplorerTreeActionGroupId: {
|
|
968
|
+
bundle: "bundle";
|
|
969
|
+
exporting: "exporting";
|
|
970
|
+
refreshing: "refreshing";
|
|
971
|
+
workflow: "workflow";
|
|
972
|
+
browsing: "browsing";
|
|
973
|
+
classification: "classification";
|
|
974
|
+
clipboard: "clipboard";
|
|
975
|
+
creation: "creation";
|
|
976
|
+
deletion: "deletion";
|
|
977
|
+
editing: "editing";
|
|
978
|
+
blueprinting: "blueprinting";
|
|
979
|
+
publishing: "publishing";
|
|
980
|
+
translation: "translation";
|
|
981
|
+
};
|
|
982
|
+
|
|
983
|
+
/**
|
|
984
|
+
* @internal
|
|
985
|
+
*/
|
|
986
|
+
export declare const contentExplorerTreeActionGroupIds: readonly ["browsing", "bundle", "classification", "clipboard", "creation", "deletion", "editing", "exporting", "blueprinting", "publishing", "refreshing", "translation", "workflow"];
|
|
987
|
+
|
|
988
|
+
/**
|
|
989
|
+
* @internal
|
|
990
|
+
*/
|
|
991
|
+
export declare type ContentExplorerTreeActionId = ValuesOfArray<typeof contentExplorerTreeActionIds>;
|
|
992
|
+
|
|
993
|
+
/**
|
|
994
|
+
* @internal
|
|
995
|
+
*/
|
|
996
|
+
export declare const contentExplorerTreeActionId: {
|
|
997
|
+
export: "export";
|
|
998
|
+
refresh: "refresh";
|
|
999
|
+
openEditor: "openEditor";
|
|
1000
|
+
openEditorInNewTab: "openEditorInNewTab";
|
|
1001
|
+
addSelectedItemsToBundle: "addSelectedItemsToBundle";
|
|
1002
|
+
addToBundle: "addToBundle";
|
|
1003
|
+
removeFromBundle: "removeFromBundle";
|
|
1004
|
+
autoClassify: "autoClassify";
|
|
1005
|
+
copy: "copy";
|
|
1006
|
+
cut: "cut";
|
|
1007
|
+
paste: "paste";
|
|
1008
|
+
newBundle: "newBundle";
|
|
1009
|
+
newCategory: "newCategory";
|
|
1010
|
+
newComponent: "newComponent";
|
|
1011
|
+
newFolder: "newFolder";
|
|
1012
|
+
newKeyword: "newKeyword";
|
|
1013
|
+
newMultimediaComponent: "newMultimediaComponent";
|
|
1014
|
+
newPage: "newPage";
|
|
1015
|
+
newStructureGroup: "newStructureGroup";
|
|
1016
|
+
uploadMultimediaComponent: "uploadMultimediaComponent";
|
|
1017
|
+
delete: "delete";
|
|
1018
|
+
finishEditing: "finishEditing";
|
|
1019
|
+
revert: "revert";
|
|
1020
|
+
localize: "localize";
|
|
1021
|
+
unlocalize: "unlocalize";
|
|
1022
|
+
publish: "publish";
|
|
1023
|
+
unpublish: "unpublish";
|
|
1024
|
+
openPublishingQueue: "openPublishingQueue";
|
|
1025
|
+
openTranslationQueue: "openTranslationQueue";
|
|
1026
|
+
translate: "translate";
|
|
1027
|
+
translateTarget: "translateTarget";
|
|
1028
|
+
startWorkflow: "startWorkflow";
|
|
1029
|
+
};
|
|
1030
|
+
|
|
1031
|
+
/**
|
|
1032
|
+
* @internal
|
|
1033
|
+
*/
|
|
1034
|
+
export declare const contentExplorerTreeActionIds: readonly ["openEditor", "openEditorInNewTab", "addSelectedItemsToBundle", "addToBundle", "removeFromBundle", "autoClassify", "copy", "cut", "paste", "newBundle", "newCategory", "newComponent", "newFolder", "newKeyword", "newMultimediaComponent", "newPage", "newStructureGroup", "uploadMultimediaComponent", "delete", "finishEditing", "revert", "export", "localize", "unlocalize", "publish", "unpublish", "openPublishingQueue", "refresh", "openTranslationQueue", "translate", "translateTarget", "startWorkflow"];
|
|
1035
|
+
|
|
1036
|
+
/**
|
|
1037
|
+
* @internal
|
|
1038
|
+
*/
|
|
1039
|
+
export declare interface ContentExplorerTreeExtensions {
|
|
1040
|
+
actions: ReadonlyArray<ActionExtension>;
|
|
1041
|
+
contextMenu: ReadonlyArray<ActionsConfigurationExtension>;
|
|
1042
|
+
}
|
|
1043
|
+
|
|
1044
|
+
/**
|
|
1045
|
+
* @internal
|
|
1046
|
+
*/
|
|
1047
|
+
export declare class ContentExplorerTreeExtensionsBuilder {
|
|
1048
|
+
private _actions;
|
|
1049
|
+
readonly contextMenu: ActionsConfigurationExtensionsBuilder;
|
|
1050
|
+
addAction: (action: ActionExtension) => this;
|
|
1051
|
+
build: () => ContentExplorerTreeExtensions;
|
|
1052
|
+
}
|
|
1053
|
+
|
|
1054
|
+
/**
|
|
1055
|
+
* @internal
|
|
1056
|
+
*/
|
|
1057
|
+
export declare type ContentExplorerTreeHook = () => ContentExplorerTreeHookResult;
|
|
1058
|
+
|
|
1059
|
+
/**
|
|
1060
|
+
* @internal
|
|
1061
|
+
*/
|
|
1062
|
+
export declare interface ContentExplorerTreeHookResult {
|
|
1063
|
+
refresh: () => void;
|
|
1064
|
+
}
|
|
1065
|
+
|
|
1066
|
+
/**
|
|
1067
|
+
* @internal
|
|
1068
|
+
*/
|
|
1069
|
+
export declare interface ContentExplorerUtilsApiStorage {
|
|
1070
|
+
hierarchy: ContentExplorerHierarchyUtilsExtensionApi;
|
|
1071
|
+
}
|
|
1072
|
+
|
|
1073
|
+
/**
|
|
1074
|
+
* @internal
|
|
1075
|
+
*/
|
|
1076
|
+
export declare type CopyItemMutationHook = (options?: UseMutationOptions<RepositoryLocalObject, ApiError, CopyItemRequest>) => UseMutationResult<RepositoryLocalObject, ApiError, CopyItemRequest>;
|
|
1077
|
+
|
|
1078
|
+
/**
|
|
1079
|
+
* @internal
|
|
1080
|
+
*/
|
|
1081
|
+
export declare interface CopyItemRequest {
|
|
1082
|
+
itemId: ItemUri;
|
|
1083
|
+
destinationId: ItemUri;
|
|
1084
|
+
}
|
|
1085
|
+
|
|
1086
|
+
/**
|
|
1087
|
+
* @internal
|
|
1088
|
+
*/
|
|
1089
|
+
export declare type CopyItemsMutationHook = (options?: BatchMutationOptions<CopyItemsRequest>) => UseMutationResult<Batch, ApiError, CopyItemsRequest>;
|
|
1090
|
+
|
|
1091
|
+
/**
|
|
1092
|
+
* @internal
|
|
1093
|
+
*/
|
|
1094
|
+
export declare interface CopyItemsRequest {
|
|
1095
|
+
itemIds: ReadonlyArray<ItemUri>;
|
|
1096
|
+
destinationId: ItemUri;
|
|
1097
|
+
}
|
|
1098
|
+
|
|
1099
|
+
/**
|
|
1100
|
+
* @internal
|
|
1101
|
+
*/
|
|
1102
|
+
export declare const createExtensionGlobals: () => CreateExtensionGlobalsResult;
|
|
1103
|
+
|
|
1104
|
+
/**
|
|
1105
|
+
* @internal
|
|
1106
|
+
*/
|
|
1107
|
+
export declare interface CreateExtensionGlobalsResult extends ExtensionGlobals {
|
|
1108
|
+
initialize: (globals: ExtensionGlobals) => void;
|
|
1109
|
+
}
|
|
1110
|
+
|
|
1111
|
+
/**
|
|
1112
|
+
* @internal
|
|
1113
|
+
*/
|
|
1114
|
+
export declare type CreateTranslationJobMutationHook = (options: UseMutationOptions<TranslationJob, ApiError, CreateTranslationJobRequest>) => UseMutationResult<TranslationJob, ApiError, CreateTranslationJobRequest>;
|
|
1115
|
+
|
|
1116
|
+
/**
|
|
1117
|
+
* @internal
|
|
1118
|
+
*/
|
|
1119
|
+
export declare interface CreateTranslationJobRequest {
|
|
1120
|
+
translationJob: TranslationJob;
|
|
1121
|
+
}
|
|
1122
|
+
|
|
1123
|
+
/**
|
|
1124
|
+
* @internal
|
|
1125
|
+
*/
|
|
1126
|
+
export declare type CustomIcon = ReactElement<CustomIconProps>;
|
|
1127
|
+
|
|
1128
|
+
/**
|
|
1129
|
+
* @internal
|
|
1130
|
+
*/
|
|
1131
|
+
export declare type CustomIconProps = Omit<IconProps, 'children' | 'viewBox'>;
|
|
1132
|
+
|
|
1133
|
+
/**
|
|
1134
|
+
* @internal
|
|
1135
|
+
*/
|
|
1136
|
+
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'>;
|
|
1137
|
+
|
|
1138
|
+
/**
|
|
1139
|
+
* @internal
|
|
1140
|
+
*/
|
|
1141
|
+
export declare type DefaultTranslationJobQueryHook = (props: DefaultTranslationJobQueryProps | undefined, options?: QueryOptions<TranslationJob | undefined, ApiError>) => UseQueryResult<TranslationJob | undefined, ApiError>;
|
|
1142
|
+
|
|
1143
|
+
/**
|
|
1144
|
+
* @internal
|
|
1145
|
+
*/
|
|
1146
|
+
export declare interface DefaultTranslationJobQueryProps {
|
|
1147
|
+
itemIds: ReadonlyArray<ItemUri>;
|
|
1148
|
+
type: TranslationJobType;
|
|
1149
|
+
}
|
|
1150
|
+
|
|
1151
|
+
/**
|
|
1152
|
+
* @internal
|
|
1153
|
+
*/
|
|
1154
|
+
export declare type DeleteItemMutationHook = (options?: UseMutationOptions<void, ApiError, DeleteItemRequest>) => UseMutationResult<void, ApiError, DeleteItemRequest>;
|
|
1155
|
+
|
|
1156
|
+
/**
|
|
1157
|
+
* @internal
|
|
1158
|
+
*/
|
|
1159
|
+
export declare interface DeleteItemRequest {
|
|
1160
|
+
item: IdentifiableObject;
|
|
1161
|
+
contextItem?: IdentifiableObject;
|
|
1162
|
+
}
|
|
1163
|
+
|
|
1164
|
+
/**
|
|
1165
|
+
* @internal
|
|
1166
|
+
*/
|
|
1167
|
+
export declare type DeleteItemsMutationHook = (options?: BatchMutationOptions<DeleteItemsRequest>) => UseMutationResult<Batch, ApiError, DeleteItemsRequest>;
|
|
1168
|
+
|
|
1169
|
+
/**
|
|
1170
|
+
* @internal
|
|
1171
|
+
*/
|
|
1172
|
+
export declare interface DeleteItemsRequest {
|
|
1173
|
+
items: ReadonlyArray<IdentifiableObject>;
|
|
1174
|
+
/**
|
|
1175
|
+
* containerId may take 'undefined' value when publications
|
|
1176
|
+
* which don't have a real container are being deleted.
|
|
1177
|
+
*/
|
|
1178
|
+
containerId: ItemUri | undefined;
|
|
1179
|
+
}
|
|
1180
|
+
|
|
1181
|
+
/**
|
|
1182
|
+
* @internal
|
|
1183
|
+
*/
|
|
1184
|
+
export declare interface EditorsApiStorage {
|
|
1185
|
+
componentEditor: ComponentEditorApiStorage;
|
|
1186
|
+
bundleEditor: BundleEditorApiStorage;
|
|
1187
|
+
categoryEditor: CategoryEditorApiStorage;
|
|
1188
|
+
folderEditor: FolderEditorApiStorage;
|
|
1189
|
+
keywordEditor: KeywordEditorApiStorage;
|
|
1190
|
+
pageEditor: PageEditorApiStorage;
|
|
1191
|
+
structureGroupEditor: StructureGroupEditorApiStorage;
|
|
1192
|
+
}
|
|
1193
|
+
|
|
1194
|
+
/**
|
|
1195
|
+
* @internal
|
|
1196
|
+
*/
|
|
1197
|
+
export declare const extensionApiBridge: {
|
|
1198
|
+
initialize: (implementation: ExtensionApiImplementationStorage) => void;
|
|
1199
|
+
get: () => ExtensionApiImplementationStorage;
|
|
1200
|
+
};
|
|
1201
|
+
|
|
1202
|
+
/**
|
|
1203
|
+
* @internal
|
|
1204
|
+
*/
|
|
1205
|
+
export declare interface ExtensionApiImplementationStorage {
|
|
1206
|
+
activitiesExplorer: ActivitiesExplorerApiStorage;
|
|
1207
|
+
contentExplorer: ContentExplorerApiStorage;
|
|
1208
|
+
editors: EditorsApiStorage;
|
|
1209
|
+
general: GeneralApiStorage;
|
|
1210
|
+
}
|
|
1211
|
+
|
|
1212
|
+
/**
|
|
1213
|
+
* @internal
|
|
1214
|
+
*/
|
|
1215
|
+
export declare class ExtensionBuilder {
|
|
1216
|
+
readonly header: HeaderExtensionsBuilder;
|
|
1217
|
+
readonly contentEditor: ContentEditorExtensionsBuilder;
|
|
1218
|
+
readonly contentExplorer: ContentExplorerExtensionsBuilder;
|
|
1219
|
+
readonly translations: TranslationExtensionsBuilder;
|
|
1220
|
+
readonly activitiesExplorer: ActivitiesExplorerExtensionsBuilder;
|
|
1221
|
+
build: () => ExtensionPoints;
|
|
1222
|
+
}
|
|
1223
|
+
|
|
1224
|
+
/**
|
|
1225
|
+
* @internal
|
|
1226
|
+
*/
|
|
1227
|
+
export declare interface ExtensionGlobals {
|
|
1228
|
+
t: (key: string, options?: Record<string, any>) => string;
|
|
1229
|
+
getConfiguration: () => Record<string, any> | undefined;
|
|
1230
|
+
}
|
|
1231
|
+
|
|
1232
|
+
/**
|
|
1233
|
+
* @internal
|
|
1234
|
+
*/
|
|
1235
|
+
export declare interface ExtensionModule {
|
|
1236
|
+
runtimeInfo: RuntimeInformation;
|
|
1237
|
+
initializeGlobals: (globals: ExtensionGlobals) => void;
|
|
1238
|
+
initialize: (builder: ExtensionBuilder) => void;
|
|
1239
|
+
}
|
|
1240
|
+
|
|
1241
|
+
/**
|
|
1242
|
+
* @internal
|
|
1243
|
+
*/
|
|
1244
|
+
export declare interface ExtensionPoints {
|
|
1245
|
+
header: HeaderExtensions;
|
|
1246
|
+
contentEditor: ContentEditorExtensions;
|
|
1247
|
+
contentExplorer: ContentExplorerExtensions;
|
|
1248
|
+
activitiesExplorer: ActivitiesExplorerExtensions;
|
|
1249
|
+
translations: TranslationExtensions;
|
|
1250
|
+
}
|
|
1251
|
+
|
|
1252
|
+
/**
|
|
1253
|
+
* @internal
|
|
1254
|
+
*/
|
|
1255
|
+
export declare type FavoritesQueryHook = (options?: QueryOptions<ReadonlyArray<IdentifiableObject> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<IdentifiableObject> | undefined, ApiError>;
|
|
1256
|
+
|
|
1257
|
+
/**
|
|
1258
|
+
* @internal
|
|
1259
|
+
*/
|
|
1260
|
+
export declare interface FinishActivitiesHookResult {
|
|
1261
|
+
mutateAsync: ({ requestData }: FinishActivitiesRequest) => Promise<Batch[]>;
|
|
1262
|
+
}
|
|
1263
|
+
|
|
1264
|
+
/**
|
|
1265
|
+
* @internal
|
|
1266
|
+
*/
|
|
1267
|
+
export declare type FinishActivitiesMutationHook = (options?: FinishActivitiesMutationOptions) => FinishActivitiesHookResult;
|
|
1268
|
+
|
|
1269
|
+
/**
|
|
1270
|
+
* @internal
|
|
1271
|
+
*/
|
|
1272
|
+
export declare type FinishActivitiesMutationOptions = Without<UseMutationOptions<Batch[], ApiError, FinishActivitiesRequest>, 'mutationFn'>;
|
|
1273
|
+
|
|
1274
|
+
/**
|
|
1275
|
+
* @internal
|
|
1276
|
+
*/
|
|
1277
|
+
export declare interface FinishActivitiesRequest {
|
|
1278
|
+
requestData: ReadonlyArray<FinishActivitiesRequestData>;
|
|
1279
|
+
}
|
|
1280
|
+
|
|
1281
|
+
/**
|
|
1282
|
+
* @internal
|
|
1283
|
+
*/
|
|
1284
|
+
export declare interface FinishActivitiesRequestData {
|
|
1285
|
+
activityInstances: ReadonlyArray<ActivityInstance>;
|
|
1286
|
+
nextActivity?: Link_2;
|
|
1287
|
+
message?: string;
|
|
1288
|
+
}
|
|
1289
|
+
|
|
1290
|
+
/**
|
|
1291
|
+
* @internal
|
|
1292
|
+
*/
|
|
1293
|
+
export declare type FinishActivityMutationHook = (options?: UseMutationOptions<FinishActivityResult, ApiError, FinishActivityRequest>) => UseMutationResult<FinishActivityResult, ApiError, FinishActivityRequest>;
|
|
1294
|
+
|
|
1295
|
+
/**
|
|
1296
|
+
* @internal
|
|
1297
|
+
*/
|
|
1298
|
+
export declare interface FinishActivityRequest {
|
|
1299
|
+
activityId: ItemUri;
|
|
1300
|
+
nextActivity?: Link_2;
|
|
1301
|
+
message?: string;
|
|
1302
|
+
}
|
|
1303
|
+
|
|
1304
|
+
/**
|
|
1305
|
+
* @internal
|
|
1306
|
+
*/
|
|
1307
|
+
export declare type FinishEditingItemMutationHook = (options?: UseMutationOptions<RepositoryLocalObject, ApiError, FinishEditingItemRequest>) => UseMutationResult<RepositoryLocalObject, ApiError, FinishEditingItemRequest>;
|
|
1308
|
+
|
|
1309
|
+
/**
|
|
1310
|
+
* @internal
|
|
1311
|
+
*/
|
|
1312
|
+
export declare interface FinishEditingItemRequest {
|
|
1313
|
+
item: VersionedItem;
|
|
1314
|
+
contextItem?: IdentifiableObject;
|
|
1315
|
+
}
|
|
1316
|
+
|
|
1317
|
+
/**
|
|
1318
|
+
* @internal
|
|
1319
|
+
*/
|
|
1320
|
+
export declare type FinishEditingItemsMutationHook = (options?: BatchMutationOptions<FinishItemsRequest>) => UseMutationResult<Batch, ApiError, FinishItemsRequest>;
|
|
1321
|
+
|
|
1322
|
+
/**
|
|
1323
|
+
* @internal
|
|
1324
|
+
*/
|
|
1325
|
+
export declare interface FinishItemsRequest {
|
|
1326
|
+
items: ReadonlyArray<VersionedItem>;
|
|
1327
|
+
containerId: ItemUri;
|
|
1328
|
+
}
|
|
1329
|
+
|
|
1330
|
+
/**
|
|
1331
|
+
* @internal
|
|
1332
|
+
*/
|
|
1333
|
+
export declare interface FolderEditorApiStorage {
|
|
1334
|
+
hooks: FolderEditorHooksApiStorage;
|
|
1335
|
+
}
|
|
1336
|
+
|
|
1337
|
+
/**
|
|
1338
|
+
* @internal
|
|
1339
|
+
*/
|
|
1340
|
+
export declare type FolderEditorHook = () => FolderEditorHookResult | undefined;
|
|
1341
|
+
|
|
1342
|
+
/**
|
|
1343
|
+
* @internal
|
|
1344
|
+
*/
|
|
1345
|
+
export declare interface FolderEditorHookResult {
|
|
1346
|
+
folder: Folder;
|
|
1347
|
+
metadataSchema: Schema;
|
|
1348
|
+
isChanged: boolean;
|
|
1349
|
+
isEditing: boolean;
|
|
1350
|
+
}
|
|
1351
|
+
|
|
1352
|
+
/**
|
|
1353
|
+
* @internal
|
|
1354
|
+
*/
|
|
1355
|
+
export declare interface FolderEditorHooksApiStorage {
|
|
1356
|
+
useFolderEditor: FolderEditorHook;
|
|
1357
|
+
}
|
|
1358
|
+
|
|
1359
|
+
/**
|
|
1360
|
+
* @internal
|
|
1361
|
+
*/
|
|
1362
|
+
export declare const frameworkInfo: {
|
|
1363
|
+
version: string;
|
|
1364
|
+
peerDependencies: Record<string, string>;
|
|
1365
|
+
};
|
|
1366
|
+
|
|
1367
|
+
/**
|
|
1368
|
+
* @internal
|
|
1369
|
+
*/
|
|
1370
|
+
export declare interface GeneralApiStorage {
|
|
1371
|
+
components: GeneralComponentsApiStorage;
|
|
1372
|
+
hooks: GeneralHooksApiStorage;
|
|
1373
|
+
mutations: GeneralMutationsApiStorage;
|
|
1374
|
+
queries: GeneralQueriesApiStorage;
|
|
1375
|
+
}
|
|
1376
|
+
|
|
1377
|
+
/**
|
|
1378
|
+
* @internal
|
|
1379
|
+
*/
|
|
1380
|
+
export declare interface GeneralComponentsApiStorage {
|
|
1381
|
+
Button: ButtonComponent;
|
|
1382
|
+
Icon: IconComponent;
|
|
1383
|
+
Link: LinkComponent;
|
|
1384
|
+
Text: TextComponent;
|
|
1385
|
+
TextLink: TextLinkComponent;
|
|
1386
|
+
}
|
|
1387
|
+
|
|
1388
|
+
/**
|
|
1389
|
+
* @internal
|
|
1390
|
+
*/
|
|
1391
|
+
export declare interface GeneralHooksApiStorage {
|
|
1392
|
+
useNotifications: NotificationsHook;
|
|
1393
|
+
useUserProfile: UserProfileHook;
|
|
1394
|
+
useConfirmation: ConfirmationHook;
|
|
1395
|
+
}
|
|
1396
|
+
|
|
1397
|
+
/**
|
|
1398
|
+
* @internal
|
|
1399
|
+
*/
|
|
1400
|
+
export declare interface GeneralMutationsApiStorage {
|
|
1401
|
+
item: {
|
|
1402
|
+
useAutoClassifyItemMutation: AutoClassifyItemMutationHook;
|
|
1403
|
+
useAutoClassifyItemsMutation: AutoClassifyItemsMutationHook;
|
|
1404
|
+
useCopyItemMutation: CopyItemMutationHook;
|
|
1405
|
+
useCopyItemsMutation: CopyItemsMutationHook;
|
|
1406
|
+
useDeleteItemMutation: DeleteItemMutationHook;
|
|
1407
|
+
useDeleteItemsMutation: DeleteItemsMutationHook;
|
|
1408
|
+
useFinishEditingItemMutation: FinishEditingItemMutationHook;
|
|
1409
|
+
useFinishEditingItemsMutation: FinishEditingItemsMutationHook;
|
|
1410
|
+
useLocalizeItemMutation: LocalizeItemMutationHook;
|
|
1411
|
+
useLocalizeItemsMutation: LocalizeItemsMutationHook;
|
|
1412
|
+
useMoveItemMutation: MoveItemMutationHook;
|
|
1413
|
+
useMoveItemsMutation: MoveItemsMutationHook;
|
|
1414
|
+
usePublishItemsMutation: PublishItemsMutationHook;
|
|
1415
|
+
useRevertItemMutation: RevertItemMutationHook;
|
|
1416
|
+
useRevertItemsMutation: RevertItemsMutationHook;
|
|
1417
|
+
useRollbackItemMutation: RollbackItemMutationHook;
|
|
1418
|
+
useUnlocalizeItemMutation: UnlocalizeItemMutationHook;
|
|
1419
|
+
useUnlocalizeItemsMutation: UnlocalizeItemsMutationHook;
|
|
1420
|
+
useUnpublishItemsMutation: UnpublishItemsMutationHook;
|
|
1421
|
+
useUpdateItemMutation: UpdateItemMutationHook;
|
|
1422
|
+
};
|
|
1423
|
+
translations: {
|
|
1424
|
+
useCreateTranslationJobMutation: CreateTranslationJobMutationHook;
|
|
1425
|
+
};
|
|
1426
|
+
workflow: {
|
|
1427
|
+
useAssignActivitiesMutation: AssignActivitiesMutationHook;
|
|
1428
|
+
useAssignActivityMutation: AssignActivityMutationHook;
|
|
1429
|
+
useFinishActivityMutation: FinishActivityMutationHook;
|
|
1430
|
+
useFinishActivitiesMutation: FinishActivitiesMutationHook;
|
|
1431
|
+
useRestartActivitiesMutation: RestartActivitiesMutationHook;
|
|
1432
|
+
useRestartActivityMutation: RestartActivityMutationHook;
|
|
1433
|
+
useStartActivitiesMutation: StartActivitiesMutationHook;
|
|
1434
|
+
useStartActivityMutation: StartActivityMutationHook;
|
|
1435
|
+
useStartWorkflowMutation: StartWorkflowMutationHook;
|
|
1436
|
+
};
|
|
1437
|
+
useAddToBundleMutation: AddToBundleMutationHook;
|
|
1438
|
+
useChangeUserLanguageMutation: ChangeUserLanguageMutationHook;
|
|
1439
|
+
useChangeUserLocaleMutation: ChangeUserLocaleMutationHook;
|
|
1440
|
+
useRemoveFromBundleMutation: RemoveFromBundleMutationHook;
|
|
1441
|
+
useUploadMultimediaMutation: UploadMultimediaMutationHook;
|
|
1442
|
+
}
|
|
1443
|
+
|
|
1444
|
+
/**
|
|
1445
|
+
* @internal
|
|
1446
|
+
*/
|
|
1447
|
+
export declare interface GeneralQueriesApiStorage {
|
|
1448
|
+
useUserProfileQuery: UserProfileQueryHook;
|
|
1449
|
+
item: {
|
|
1450
|
+
useItemBlueprintHierarchyQuery: ItemBlueprintHierarchyQueryHook;
|
|
1451
|
+
useItemChildrenQuery: ItemChildrenQueryHook;
|
|
1452
|
+
useItemClassifiedItemsQuery: ItemClassifiedItemsQueryHook;
|
|
1453
|
+
useItemDefaultDataQuery: ItemDefaultDataQueryHook;
|
|
1454
|
+
useItemHistoryQuery: ItemHistoryQueryHook;
|
|
1455
|
+
useItemPublishedPagesQuery: ItemPublishedPagesQueryHook;
|
|
1456
|
+
useItemPublishedToQuery: ItemPublishedToQueryHook;
|
|
1457
|
+
useItemPublishUrlsQuery: ItemPublishUrlsQueryHook;
|
|
1458
|
+
useItemQuery: ItemQueryHook;
|
|
1459
|
+
useItemsQuery: ItemsQueryHook;
|
|
1460
|
+
useItemTranslationInfoQuery: ItemTranslationInfoQueryHook;
|
|
1461
|
+
useItemUsedByQuery: ItemUsedByQueryHook;
|
|
1462
|
+
useItemUsesQuery: ItemUsesQueryHook;
|
|
1463
|
+
usePublicationBlueprintHierarchyQuery: PublicationBlueprintHierarchyQueryHook;
|
|
1464
|
+
};
|
|
1465
|
+
lists: {
|
|
1466
|
+
useFavoritesQuery: FavoritesQueryHook;
|
|
1467
|
+
useItemsInProgressQuery: ItemsInProgressQueryHook;
|
|
1468
|
+
usePublicationsQuery: PublicationsQueryHook;
|
|
1469
|
+
useUserGroupsQuery: UserGroupsQueryHook;
|
|
1470
|
+
useUsersQuery: UsersQueryHook;
|
|
1471
|
+
};
|
|
1472
|
+
publishing: {
|
|
1473
|
+
useItemsToPublishQuery: ItemsToPublishQueryHook;
|
|
1474
|
+
useItemsToUnpublishQuery: ItemsToUnpublishQueryHook;
|
|
1475
|
+
usePublishableTargetTypesQuery: PublishableTargetTypesQueryHook;
|
|
1476
|
+
};
|
|
1477
|
+
search: {
|
|
1478
|
+
useSearchInContainerQuery: SearchInContainerQueryHook;
|
|
1479
|
+
useSystemSearchQuery: SystemSearchQueryHook;
|
|
1480
|
+
};
|
|
1481
|
+
translation: {
|
|
1482
|
+
useDefaultTranslationJobQuery: DefaultTranslationJobQueryHook;
|
|
1483
|
+
};
|
|
1484
|
+
workflow: {
|
|
1485
|
+
useActivityInstancesQuery: ActivityInstancesQueryHook;
|
|
1486
|
+
};
|
|
1487
|
+
}
|
|
1488
|
+
|
|
1489
|
+
declare type GetListBuilderItemId<TItem> = (item: TItem) => string;
|
|
1490
|
+
|
|
1491
|
+
/**
|
|
1492
|
+
* @internal
|
|
1493
|
+
*/
|
|
1494
|
+
export declare interface HeaderExtensions {
|
|
1495
|
+
navigation: NavigationExtensions;
|
|
1496
|
+
}
|
|
1497
|
+
|
|
1498
|
+
/**
|
|
1499
|
+
* @internal
|
|
1500
|
+
*/
|
|
1501
|
+
export declare class HeaderExtensionsBuilder {
|
|
1502
|
+
readonly navigation: NavigationExtensionsBuilder;
|
|
1503
|
+
build: () => HeaderExtensions;
|
|
1504
|
+
}
|
|
1505
|
+
|
|
1506
|
+
/**
|
|
1507
|
+
* A component used for rendering SVG icons.
|
|
1508
|
+
* @internal
|
|
1509
|
+
*/
|
|
1510
|
+
export declare const Icon: IconComponent;
|
|
1511
|
+
|
|
1512
|
+
/**
|
|
1513
|
+
* @internal
|
|
1514
|
+
*/
|
|
1515
|
+
export declare type IconComponent = FunctionComponent<IconProps>;
|
|
1516
|
+
|
|
1517
|
+
/**
|
|
1518
|
+
* @internal
|
|
1519
|
+
*/
|
|
1520
|
+
export declare interface IconProps extends TooltipProps, SpaceProps, SizeProps, ColorProps {
|
|
1521
|
+
/**
|
|
1522
|
+
* ViewBox of the provided content.
|
|
1523
|
+
*/
|
|
1524
|
+
viewBox: string;
|
|
1525
|
+
/**
|
|
1526
|
+
* SVG content to render.
|
|
1527
|
+
*/
|
|
1528
|
+
children: ReactNode;
|
|
1529
|
+
}
|
|
1530
|
+
|
|
1531
|
+
/**
|
|
1532
|
+
* @internal
|
|
1533
|
+
*/
|
|
1534
|
+
export declare const isFavoritesNodeId: (nodeId: string) => boolean;
|
|
1535
|
+
|
|
1536
|
+
/**
|
|
1537
|
+
* @internal
|
|
1538
|
+
*/
|
|
1539
|
+
export declare const isItemInProgressNodeId: (nodeId: string) => boolean;
|
|
1540
|
+
|
|
1541
|
+
/**
|
|
1542
|
+
* @internal
|
|
1543
|
+
*/
|
|
1544
|
+
export declare const isItemNode: (node: ContentExplorerNode) => node is ContentExplorerItemNode;
|
|
1545
|
+
|
|
1546
|
+
/**
|
|
1547
|
+
* @internal
|
|
1548
|
+
*/
|
|
1549
|
+
export declare const isPublicationsNodeId: (nodeId: string) => boolean;
|
|
1550
|
+
|
|
1551
|
+
/**
|
|
1552
|
+
* @internal
|
|
1553
|
+
*/
|
|
1554
|
+
export declare const isRootNodeId: (nodeId: string) => boolean;
|
|
1555
|
+
|
|
1556
|
+
/**
|
|
1557
|
+
* @internal
|
|
1558
|
+
*/
|
|
1559
|
+
export declare type ItemBlueprintHierarchyQueryHook = (props: ItemBlueprintHierarchyQueryProps | undefined, options?: QueryOptions<ItemBlueprintHierarchy | undefined, ApiError>) => UseQueryResult<ItemBlueprintHierarchy | undefined, ApiError>;
|
|
1560
|
+
|
|
1561
|
+
/**
|
|
1562
|
+
* @internal
|
|
1563
|
+
*/
|
|
1564
|
+
export declare interface ItemBlueprintHierarchyQueryProps {
|
|
1565
|
+
itemId: ItemUri;
|
|
1566
|
+
}
|
|
1567
|
+
|
|
1568
|
+
/**
|
|
1569
|
+
* @internal
|
|
1570
|
+
*/
|
|
1571
|
+
export declare type ItemChildrenQueryHook = (props: ItemChildrenQueryProps | undefined, options?: QueryOptions<ReadonlyArray<RepositoryLocalObject> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<RepositoryLocalObject> | undefined, ApiError>;
|
|
1572
|
+
|
|
1573
|
+
/**
|
|
1574
|
+
* @internal
|
|
1575
|
+
*/
|
|
1576
|
+
export declare interface ItemChildrenQueryProps {
|
|
1577
|
+
/**
|
|
1578
|
+
* The Item URI of an organizational item, such as a Bundle, Category, Folder, Virtual folder, or Structure Group.
|
|
1579
|
+
*/
|
|
1580
|
+
itemId: ItemUri;
|
|
1581
|
+
/**
|
|
1582
|
+
* Loads a dynamic version (if available for the current user)
|
|
1583
|
+
*/
|
|
1584
|
+
useDynamicVersion?: boolean;
|
|
1585
|
+
}
|
|
1586
|
+
|
|
1587
|
+
/**
|
|
1588
|
+
* @internal
|
|
1589
|
+
*/
|
|
1590
|
+
export declare type ItemClassifiedItemsQueryHook = (props: ItemClassifiedItemsQueryProps | undefined, options?: QueryOptions<ReadonlyArray<RepositoryLocalObject> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<RepositoryLocalObject> | undefined, ApiError>;
|
|
1591
|
+
|
|
1592
|
+
/**
|
|
1593
|
+
* @internal
|
|
1594
|
+
*/
|
|
1595
|
+
export declare interface ItemClassifiedItemsQueryProps {
|
|
1596
|
+
/**
|
|
1597
|
+
* The URI of a Keyword or Concept.
|
|
1598
|
+
*/
|
|
1599
|
+
keywordId: ItemUri;
|
|
1600
|
+
/**
|
|
1601
|
+
* Loads a dynamic version (if available for the current user).
|
|
1602
|
+
*/
|
|
1603
|
+
useDynamicVersion?: boolean;
|
|
1604
|
+
/**
|
|
1605
|
+
* The item types of all repository-local objects that you want to include in the response.
|
|
1606
|
+
*/
|
|
1607
|
+
rloItemTypes?: ReadonlyArray<RloItemType>;
|
|
1608
|
+
/**
|
|
1609
|
+
* A boolean value to indicate whether to include descendant keywords in the results.
|
|
1610
|
+
*/
|
|
1611
|
+
resolveDescendantKeywords?: boolean;
|
|
1612
|
+
/**
|
|
1613
|
+
* An integer value to limit the number of items returned in the list.
|
|
1614
|
+
* Specify a positive value as the limit or -1 for no limit. Setting the value to zero will return an empty list.
|
|
1615
|
+
*/
|
|
1616
|
+
resultLimit?: number;
|
|
1617
|
+
}
|
|
1618
|
+
|
|
1619
|
+
/**
|
|
1620
|
+
* @internal
|
|
1621
|
+
*/
|
|
1622
|
+
export declare type ItemDefaultDataQueryHook = <TItem extends IdentifiableObject>(props: ItemDefaultDataQueryProps | undefined, options?: QueryOptions<TItem | undefined, ApiError>) => UseQueryResult<TItem | undefined, ApiError>;
|
|
1623
|
+
|
|
1624
|
+
/**
|
|
1625
|
+
* @internal
|
|
1626
|
+
*/
|
|
1627
|
+
export declare interface ItemDefaultDataQueryProps {
|
|
1628
|
+
modelType: DefaultModelType;
|
|
1629
|
+
}
|
|
1630
|
+
|
|
1631
|
+
/**
|
|
1632
|
+
* @internal
|
|
1633
|
+
*/
|
|
1634
|
+
export declare type ItemHistoryQueryHook = (props: ItemHistoryQueryProps | undefined, options?: QueryOptions<ReadonlyArray<VersionedItem> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<VersionedItem> | undefined, ApiError>;
|
|
1635
|
+
|
|
1636
|
+
/**
|
|
1637
|
+
* @internal
|
|
1638
|
+
*/
|
|
1639
|
+
export declare interface ItemHistoryQueryProps {
|
|
1640
|
+
itemId: ItemUri;
|
|
1641
|
+
}
|
|
1642
|
+
|
|
1643
|
+
/**
|
|
1644
|
+
* @internal
|
|
1645
|
+
*/
|
|
1646
|
+
export declare type ItemPublishedPagesQueryHook = (props: ItemPublishedPagesQueryProps | undefined, options?: QueryOptions<ReadonlyArray<Page> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<Page> | undefined, ApiError>;
|
|
1647
|
+
|
|
1648
|
+
/**
|
|
1649
|
+
* @internal
|
|
1650
|
+
*/
|
|
1651
|
+
export declare interface ItemPublishedPagesQueryProps {
|
|
1652
|
+
itemId: ItemUri;
|
|
1653
|
+
}
|
|
1654
|
+
|
|
1655
|
+
/**
|
|
1656
|
+
* @internal
|
|
1657
|
+
*/
|
|
1658
|
+
export declare type ItemPublishedToQueryHook = (props: ItemPublishedToQueryProps | undefined, options?: QueryOptions<ReadonlyArray<PublishInfo> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<PublishInfo> | undefined, ApiError>;
|
|
1659
|
+
|
|
1660
|
+
/**
|
|
1661
|
+
* @internal
|
|
1662
|
+
*/
|
|
1663
|
+
export declare interface ItemPublishedToQueryProps {
|
|
1664
|
+
itemId: ItemUri;
|
|
1665
|
+
}
|
|
1666
|
+
|
|
1667
|
+
/**
|
|
1668
|
+
* @internal
|
|
1669
|
+
*/
|
|
1670
|
+
export declare type ItemPublishUrlsQueryHook = (props: ItemPublishUrlsQueryProps | undefined, options?: QueryOptions<ReadonlyArray<PublishUrlInfo> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<PublishUrlInfo> | undefined, ApiError>;
|
|
1671
|
+
|
|
1672
|
+
/**
|
|
1673
|
+
* @internal
|
|
1674
|
+
*/
|
|
1675
|
+
export declare interface ItemPublishUrlsQueryProps {
|
|
1676
|
+
itemId: ItemUri;
|
|
1677
|
+
}
|
|
1678
|
+
|
|
1679
|
+
/**
|
|
1680
|
+
* @internal
|
|
1681
|
+
*/
|
|
1682
|
+
export declare type ItemQueryHook = <TItem extends IdentifiableObject>(props: ItemQueryProps | undefined, options?: QueryOptions<TItem | undefined, ApiError>) => UseQueryResult<TItem | undefined, ApiError>;
|
|
1683
|
+
|
|
1684
|
+
/**
|
|
1685
|
+
* @internal
|
|
1686
|
+
*/
|
|
1687
|
+
export declare interface ItemQueryProps {
|
|
1688
|
+
itemId: ItemUri;
|
|
1689
|
+
useDynamicVersion?: boolean;
|
|
1690
|
+
}
|
|
1691
|
+
|
|
1692
|
+
/**
|
|
1693
|
+
* @internal
|
|
1694
|
+
*/
|
|
1695
|
+
export declare type ItemsInProgressQueryHook = (props?: ItemsInProgressQueryProps, options?: QueryOptions<ReadonlyArray<VersionedItem> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<VersionedItem> | undefined, ApiError>;
|
|
1696
|
+
|
|
1697
|
+
/**
|
|
1698
|
+
* @internal
|
|
1699
|
+
*/
|
|
1700
|
+
export declare interface ItemsInProgressQueryProps {
|
|
1701
|
+
forAllUsers?: boolean;
|
|
1702
|
+
maxResults?: number;
|
|
1703
|
+
}
|
|
1704
|
+
|
|
1705
|
+
/**
|
|
1706
|
+
* @internal
|
|
1707
|
+
*/
|
|
1708
|
+
export declare type ItemsQueryHook = <TItem extends IdentifiableObject>(props: ItemsQueryProps | undefined, options?: QueryOptions<ReadonlyArray<TItem> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<TItem> | undefined, ApiError>;
|
|
1709
|
+
|
|
1710
|
+
/**
|
|
1711
|
+
* @internal
|
|
1712
|
+
*/
|
|
1713
|
+
export declare interface ItemsQueryProps {
|
|
1714
|
+
itemIds: ReadonlyArray<ItemUri>;
|
|
1715
|
+
useDynamicVersion?: boolean;
|
|
1716
|
+
loadFullItems?: boolean;
|
|
1717
|
+
}
|
|
1718
|
+
|
|
1719
|
+
/**
|
|
1720
|
+
* @internal
|
|
1721
|
+
*/
|
|
1722
|
+
export declare type ItemsToPublishQueryHook = (props: PublishItemsRequest | undefined, options?: QueryOptions<ResolvedItem[] | undefined, ApiError>) => UseQueryResult<ResolvedItem[] | undefined, ApiError>;
|
|
1723
|
+
|
|
1724
|
+
/**
|
|
1725
|
+
* @internal
|
|
1726
|
+
*/
|
|
1727
|
+
export declare type ItemsToUnpublishQueryHook = (props: UnpublishItemsRequest | undefined, options?: QueryOptions<ResolvedItem[] | undefined, ApiError>) => UseQueryResult<ResolvedItem[] | undefined, ApiError>;
|
|
1728
|
+
|
|
1729
|
+
/**
|
|
1730
|
+
* @internal
|
|
1731
|
+
*/
|
|
1732
|
+
export declare type ItemTranslationInfoQueryHook = (props: ItemTranslationInfoQueryProps | undefined, options?: QueryOptions<TranslationInfo | undefined, ApiError>) => UseQueryResult<TranslationInfo | undefined, ApiError>;
|
|
1733
|
+
|
|
1734
|
+
/**
|
|
1735
|
+
* @internal
|
|
1736
|
+
*/
|
|
1737
|
+
export declare interface ItemTranslationInfoQueryProps {
|
|
1738
|
+
itemId: ItemUri;
|
|
1739
|
+
}
|
|
1740
|
+
|
|
1741
|
+
/**
|
|
1742
|
+
* @internal
|
|
1743
|
+
*/
|
|
1744
|
+
export declare type ItemUsedByQueryHook = <TItem extends IdentifiableObject>(props: ItemUsedByQueryProps | undefined, options?: QueryOptions<ReadonlyArray<TItem> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<TItem> | undefined, ApiError>;
|
|
1745
|
+
|
|
1746
|
+
/**
|
|
1747
|
+
* @internal
|
|
1748
|
+
*/
|
|
1749
|
+
export declare interface ItemUsedByQueryProps {
|
|
1750
|
+
itemId: ItemUri;
|
|
1751
|
+
}
|
|
1752
|
+
|
|
1753
|
+
/**
|
|
1754
|
+
* @internal
|
|
1755
|
+
*/
|
|
1756
|
+
export declare type ItemUsesQueryHook = <TItem extends IdentifiableObject>(props: ItemUsesQueryProps | undefined, options?: QueryOptions<ReadonlyArray<TItem> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<TItem> | undefined, ApiError>;
|
|
1757
|
+
|
|
1758
|
+
/**
|
|
1759
|
+
* @internal
|
|
1760
|
+
*/
|
|
1761
|
+
export declare interface ItemUsesQueryProps {
|
|
1762
|
+
itemId: ItemUri;
|
|
1763
|
+
}
|
|
1764
|
+
|
|
1765
|
+
/**
|
|
1766
|
+
* @internal
|
|
1767
|
+
*/
|
|
1768
|
+
export declare interface KeywordEditorApiStorage {
|
|
1769
|
+
hooks: KeywordEditorHooksApiStorage;
|
|
1770
|
+
}
|
|
1771
|
+
|
|
1772
|
+
/**
|
|
1773
|
+
* @internal
|
|
1774
|
+
*/
|
|
1775
|
+
export declare type KeywordEditorHook = () => KeywordEditorHookResult | undefined;
|
|
1776
|
+
|
|
1777
|
+
/**
|
|
1778
|
+
* @internal
|
|
1779
|
+
*/
|
|
1780
|
+
export declare interface KeywordEditorHookResult {
|
|
1781
|
+
keyword: Keyword;
|
|
1782
|
+
metadataSchema: Schema;
|
|
1783
|
+
isChanged: boolean;
|
|
1784
|
+
isEditing: boolean;
|
|
1785
|
+
}
|
|
1786
|
+
|
|
1787
|
+
/**
|
|
1788
|
+
* @internal
|
|
1789
|
+
*/
|
|
1790
|
+
export declare interface KeywordEditorHooksApiStorage {
|
|
1791
|
+
useKeywordEditor: KeywordEditorHook;
|
|
1792
|
+
}
|
|
1793
|
+
|
|
1794
|
+
/**
|
|
1795
|
+
* @internal
|
|
1796
|
+
*/
|
|
1797
|
+
export declare type LanguageCode = 'de' | 'en' | 'es' | 'fr' | 'nl' | 'zh' | 'ja';
|
|
1798
|
+
|
|
1799
|
+
/**
|
|
1800
|
+
* A component to wrap any custom view with Link for navigation
|
|
1801
|
+
* @internal
|
|
1802
|
+
*/
|
|
1803
|
+
export declare const Link: LinkComponent;
|
|
1804
|
+
|
|
1805
|
+
/**
|
|
1806
|
+
* @internal
|
|
1807
|
+
*/
|
|
1808
|
+
export declare type LinkComponent = FunctionComponent<LinkProps>;
|
|
1809
|
+
|
|
1810
|
+
/**
|
|
1811
|
+
* @internal
|
|
1812
|
+
*
|
|
1813
|
+
* @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`).
|
|
1814
|
+
* @example `/explorer` or `https://www.website.com`.
|
|
1815
|
+
*/
|
|
1816
|
+
export declare interface LinkProps {
|
|
1817
|
+
to: string;
|
|
1818
|
+
openInNewTab?: boolean;
|
|
1819
|
+
tooltip?: string;
|
|
1820
|
+
children?: ReactNode;
|
|
1821
|
+
}
|
|
1822
|
+
|
|
1823
|
+
declare class ListBuilder<TItem> {
|
|
1824
|
+
private _itemsConfiguration;
|
|
1825
|
+
private _getItemId;
|
|
1826
|
+
constructor(getItemId: GetListBuilderItemId<TItem>);
|
|
1827
|
+
customize: (configuration: ListBuilderConfigurationExtension<TItem>) => this;
|
|
1828
|
+
add: (newItem: TItem, beforeItemId?: string) => void;
|
|
1829
|
+
move: (itemId: string, beforeItemId?: string) => void;
|
|
1830
|
+
replace: (itemId: string, newItem: TItem) => void;
|
|
1831
|
+
remove: (itemId: string) => void;
|
|
1832
|
+
build: () => ReadonlyArray<ListBuilderConfigurationExtension<TItem>>;
|
|
1833
|
+
}
|
|
1834
|
+
|
|
1835
|
+
declare type ListBuilderConfiguration<TItem> = TItem[];
|
|
1836
|
+
|
|
1837
|
+
declare type ListBuilderConfigurationExtension<TItem> = (currentList: ListBuilderConfiguration<TItem>, defaultList: ListBuilderConfiguration<TItem>) => void;
|
|
1838
|
+
|
|
1839
|
+
/**
|
|
1840
|
+
* @internal
|
|
1841
|
+
*/
|
|
1842
|
+
export declare type LocalizeItemMutationHook = (options?: UseMutationOptions<RepositoryLocalObject, ApiError, LocalizeItemRequest>) => UseMutationResult<RepositoryLocalObject, ApiError, LocalizeItemRequest>;
|
|
1843
|
+
|
|
1844
|
+
/**
|
|
1845
|
+
* @internal
|
|
1846
|
+
*/
|
|
1847
|
+
export declare interface LocalizeItemRequest {
|
|
1848
|
+
itemId: ItemUri;
|
|
1849
|
+
contextItem?: IdentifiableObject;
|
|
1850
|
+
}
|
|
1851
|
+
|
|
1852
|
+
/**
|
|
1853
|
+
* @internal
|
|
1854
|
+
*/
|
|
1855
|
+
export declare type LocalizeItemsMutationHook = (options?: BatchMutationOptions<LocalizeItemsRequest>) => UseMutationResult<Batch, ApiError, LocalizeItemsRequest>;
|
|
1856
|
+
|
|
1857
|
+
/**
|
|
1858
|
+
* @internal
|
|
1859
|
+
*/
|
|
1860
|
+
export declare interface LocalizeItemsRequest {
|
|
1861
|
+
itemIds: ReadonlyArray<ItemUri>;
|
|
1862
|
+
containerId: ItemUri;
|
|
1863
|
+
}
|
|
1864
|
+
|
|
1865
|
+
/**
|
|
1866
|
+
* @internal
|
|
1867
|
+
*/
|
|
1868
|
+
export declare type MoveItemMutationHook = (options?: UseMutationOptions<RepositoryLocalObject, ApiError, MoveItemRequest>) => UseMutationResult<RepositoryLocalObject, ApiError, MoveItemRequest>;
|
|
1869
|
+
|
|
1870
|
+
/**
|
|
1871
|
+
* @internal
|
|
1872
|
+
*/
|
|
1873
|
+
export declare interface MoveItemRequest {
|
|
1874
|
+
itemId: ItemUri;
|
|
1875
|
+
destinationId: ItemUri;
|
|
1876
|
+
sourceId: ItemUri;
|
|
1877
|
+
}
|
|
1878
|
+
|
|
1879
|
+
/**
|
|
1880
|
+
* @internal
|
|
1881
|
+
*/
|
|
1882
|
+
export declare type MoveItemsMutationHook = (options?: BatchMutationOptions<MoveItemsRequest>) => UseMutationResult<Batch, ApiError, MoveItemsRequest>;
|
|
1883
|
+
|
|
1884
|
+
/**
|
|
1885
|
+
* @internal
|
|
1886
|
+
*/
|
|
1887
|
+
export declare interface MoveItemsRequest {
|
|
1888
|
+
itemIds: ReadonlyArray<ItemUri>;
|
|
1889
|
+
destinationId: ItemUri;
|
|
1890
|
+
sourceId: ItemUri;
|
|
1891
|
+
}
|
|
1892
|
+
|
|
1893
|
+
/**
|
|
1894
|
+
* @internal
|
|
1895
|
+
*/
|
|
1896
|
+
export declare interface MultimediaUploadResult {
|
|
1897
|
+
componentLink?: Link_2;
|
|
1898
|
+
error?: ApiError | Error;
|
|
1899
|
+
}
|
|
1900
|
+
|
|
1901
|
+
/**
|
|
1902
|
+
* @internal
|
|
1903
|
+
*/
|
|
1904
|
+
export declare interface MutationResponse {
|
|
1905
|
+
bundle: IdentifiableObject;
|
|
1906
|
+
addedItems: Link_2[];
|
|
1907
|
+
}
|
|
1908
|
+
|
|
1909
|
+
/**
|
|
1910
|
+
* @internal
|
|
1911
|
+
*/
|
|
1912
|
+
export declare interface NavigateToContentExplorerProps {
|
|
1913
|
+
contextNodeId?: string;
|
|
1914
|
+
itemId?: ItemUri;
|
|
1915
|
+
}
|
|
1916
|
+
|
|
1917
|
+
/**
|
|
1918
|
+
* @internal
|
|
1919
|
+
*/
|
|
1920
|
+
export declare interface NavigationExtensions {
|
|
1921
|
+
items: ReadonlyArray<NavigationItemExtension>;
|
|
1922
|
+
config: ReadonlyArray<ListBuilderConfigurationExtension<string>>;
|
|
1923
|
+
}
|
|
1924
|
+
|
|
1925
|
+
/**
|
|
1926
|
+
* @internal
|
|
1927
|
+
*/
|
|
1928
|
+
export declare class NavigationExtensionsBuilder {
|
|
1929
|
+
private _navigationItemExtensions;
|
|
1930
|
+
readonly config: ListBuilder<string>;
|
|
1931
|
+
register: (item: NavigationItemExtension) => this;
|
|
1932
|
+
build: () => NavigationExtensions;
|
|
1933
|
+
}
|
|
1934
|
+
|
|
1935
|
+
/**
|
|
1936
|
+
* @internal
|
|
1937
|
+
*/
|
|
1938
|
+
export declare type NavigationItemExtension = () => NavigationItemExtensionConfiguration;
|
|
1939
|
+
|
|
1940
|
+
/**
|
|
1941
|
+
* @internal
|
|
1942
|
+
*/
|
|
1943
|
+
export declare interface NavigationItemExtensionConfiguration {
|
|
1944
|
+
/**
|
|
1945
|
+
* Item id
|
|
1946
|
+
*/
|
|
1947
|
+
readonly id: string;
|
|
1948
|
+
/**
|
|
1949
|
+
* Route path
|
|
1950
|
+
*/
|
|
1951
|
+
readonly routePath: string;
|
|
1952
|
+
/**
|
|
1953
|
+
* Component to render on this path
|
|
1954
|
+
*/
|
|
1955
|
+
readonly routeComponent: ComponentType;
|
|
1956
|
+
/**
|
|
1957
|
+
* Hook to determine if a navigation item is available
|
|
1958
|
+
*/
|
|
1959
|
+
readonly useNavigationItem: NavigationItemHook;
|
|
1960
|
+
}
|
|
1961
|
+
|
|
1962
|
+
/**
|
|
1963
|
+
* @internal
|
|
1964
|
+
*/
|
|
1965
|
+
export declare type NavigationItemHook = () => {
|
|
1966
|
+
/**
|
|
1967
|
+
* If `true`, navigation menu item and its corresponding page are available.
|
|
1968
|
+
*/
|
|
1969
|
+
readonly isAvailable: boolean;
|
|
1970
|
+
/**
|
|
1971
|
+
* If `true`, navigation item has enough information to determine its availability.
|
|
1972
|
+
*/
|
|
1973
|
+
readonly isInitialized: boolean;
|
|
1974
|
+
/**
|
|
1975
|
+
* Navigation item label.
|
|
1976
|
+
*/
|
|
1977
|
+
readonly label: string;
|
|
1978
|
+
/**
|
|
1979
|
+
* Component for custom rendering of label.
|
|
1980
|
+
*/
|
|
1981
|
+
readonly renderLabel?: ComponentType<NavigationItemRenderLabel>;
|
|
1982
|
+
/**
|
|
1983
|
+
* Tooltip displayed on a navigation item hover.
|
|
1984
|
+
* If not provided, `label` property is used instead of it.
|
|
1985
|
+
*/
|
|
1986
|
+
readonly tooltip?: string;
|
|
1987
|
+
};
|
|
1988
|
+
|
|
1989
|
+
/**
|
|
1990
|
+
* @internal
|
|
1991
|
+
*/
|
|
1992
|
+
export declare type NavigationItemId = ValuesOfArray<typeof navigationItemIds>;
|
|
1993
|
+
|
|
1994
|
+
/**
|
|
1995
|
+
* @internal
|
|
1996
|
+
*/
|
|
1997
|
+
export declare const navigationItemId: {
|
|
1998
|
+
activitiesExplorer: "activitiesExplorer";
|
|
1999
|
+
contentExplorer: "contentExplorer";
|
|
2000
|
+
};
|
|
2001
|
+
|
|
2002
|
+
/**
|
|
2003
|
+
* @internal
|
|
2004
|
+
*/
|
|
2005
|
+
export declare const navigationItemIds: readonly ["activitiesExplorer", "contentExplorer"];
|
|
2006
|
+
|
|
2007
|
+
/**
|
|
2008
|
+
* @internal
|
|
2009
|
+
*/
|
|
2010
|
+
export declare interface NavigationItemRenderLabel {
|
|
2011
|
+
/**
|
|
2012
|
+
* Label that is returned from `NavigationItemHook`.
|
|
2013
|
+
*/
|
|
2014
|
+
readonly label: string;
|
|
2015
|
+
}
|
|
2016
|
+
|
|
2017
|
+
/**
|
|
2018
|
+
* @internal
|
|
2019
|
+
*/
|
|
2020
|
+
export declare type NotificationsHook = () => NotificationsHookResult;
|
|
2021
|
+
|
|
2022
|
+
/**
|
|
2023
|
+
* @internal
|
|
2024
|
+
*/
|
|
2025
|
+
export declare interface NotificationsHookResult {
|
|
2026
|
+
notify: (args: NotifyArguments) => void;
|
|
2027
|
+
}
|
|
2028
|
+
|
|
2029
|
+
/**
|
|
2030
|
+
* @internal
|
|
2031
|
+
*/
|
|
2032
|
+
export declare type NotificationType = 'error' | 'info' | 'success' | 'warning';
|
|
2033
|
+
|
|
2034
|
+
/**
|
|
2035
|
+
* @internal
|
|
2036
|
+
*/
|
|
2037
|
+
export declare interface NotifyArguments {
|
|
2038
|
+
type: NotificationType;
|
|
2039
|
+
title: string;
|
|
2040
|
+
description?: string;
|
|
2041
|
+
showInMessageCenter?: boolean;
|
|
2042
|
+
}
|
|
2043
|
+
|
|
2044
|
+
/**
|
|
2045
|
+
* @internal
|
|
2046
|
+
*/
|
|
2047
|
+
export declare interface PageEditorApiStorage {
|
|
2048
|
+
hooks: PageEditorHooksApiStorage;
|
|
2049
|
+
}
|
|
2050
|
+
|
|
2051
|
+
/**
|
|
2052
|
+
* @internal
|
|
2053
|
+
*/
|
|
2054
|
+
export declare type PageEditorHook = () => PageEditorHookResult | undefined;
|
|
2055
|
+
|
|
2056
|
+
/**
|
|
2057
|
+
* @internal
|
|
2058
|
+
*/
|
|
2059
|
+
export declare interface PageEditorHookResult {
|
|
2060
|
+
page: Page;
|
|
2061
|
+
pageTemplate: PageTemplate | undefined;
|
|
2062
|
+
metadataSchema: Schema | undefined;
|
|
2063
|
+
isChanged: boolean;
|
|
2064
|
+
isEditing: boolean;
|
|
2065
|
+
hasUnsavedRelatives: boolean;
|
|
2066
|
+
}
|
|
2067
|
+
|
|
2068
|
+
/**
|
|
2069
|
+
* @internal
|
|
2070
|
+
*/
|
|
2071
|
+
export declare interface PageEditorHooksApiStorage {
|
|
2072
|
+
usePageEditor: PageEditorHook;
|
|
2073
|
+
}
|
|
2074
|
+
|
|
2075
|
+
/**
|
|
2076
|
+
* @internal
|
|
2077
|
+
*/
|
|
2078
|
+
export declare type PublicationBlueprintHierarchyQueryHook = (props: PublicationBlueprintHierarchyQueryProps | undefined, options?: QueryOptions<PublicationBlueprintHierarchy | undefined, ApiError>) => UseQueryResult<PublicationBlueprintHierarchy | undefined, ApiError>;
|
|
2079
|
+
|
|
2080
|
+
/**
|
|
2081
|
+
* @internal
|
|
2082
|
+
*/
|
|
2083
|
+
export declare interface PublicationBlueprintHierarchyQueryProps {
|
|
2084
|
+
publicationId: ItemUri;
|
|
2085
|
+
}
|
|
2086
|
+
|
|
2087
|
+
/**
|
|
2088
|
+
* @internal
|
|
2089
|
+
*/
|
|
2090
|
+
export declare type PublicationsQueryHook = (options?: QueryOptions<ReadonlyArray<Publication> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<Publication> | undefined, ApiError>;
|
|
2091
|
+
|
|
2092
|
+
/**
|
|
2093
|
+
* @internal
|
|
2094
|
+
*/
|
|
2095
|
+
export declare type PublishableTargetTypesQueryHook = (props: PublishableTargetTypesQueryProps | undefined, options?: QueryOptions<ReadonlyArray<TargetType> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<TargetType> | undefined, ApiError>;
|
|
2096
|
+
|
|
2097
|
+
/**
|
|
2098
|
+
* @internal
|
|
2099
|
+
*/
|
|
2100
|
+
export declare interface PublishableTargetTypesQueryProps {
|
|
2101
|
+
businessProcessTypeId: ItemUri;
|
|
2102
|
+
}
|
|
2103
|
+
|
|
2104
|
+
/**
|
|
2105
|
+
* @internal
|
|
2106
|
+
*/
|
|
2107
|
+
export declare type PublishItemsMutationHook = (options?: UseMutationOptions<PublishTransactionsCreationResult, ApiError, PublishItemsRequest>) => UseMutationResult<PublishTransactionsCreationResult, ApiError, PublishItemsRequest>;
|
|
2108
|
+
|
|
2109
|
+
/**
|
|
2110
|
+
* @internal
|
|
2111
|
+
*/
|
|
2112
|
+
export declare interface PublishItemsRequest {
|
|
2113
|
+
/**
|
|
2114
|
+
* The identifiers of the items that will be send for publishing.
|
|
2115
|
+
*/
|
|
2116
|
+
itemIds: ReadonlyArray<ItemUri>;
|
|
2117
|
+
/**
|
|
2118
|
+
* The priority of the publish action.
|
|
2119
|
+
*/
|
|
2120
|
+
priority?: PublishPriority;
|
|
2121
|
+
/**
|
|
2122
|
+
* A collection of Publishing Target instances (Target Types or Purposes) where the items are published to.
|
|
2123
|
+
*/
|
|
2124
|
+
targetIdsOrPurposes?: ReadonlyArray<string>;
|
|
2125
|
+
/**
|
|
2126
|
+
* Date and time when the content should be deployed at the content delivery side. Should be specified in UTC format.
|
|
2127
|
+
* The value will be converted to UTC time if specified with time zone shift, e.g. "2020-01-24T17:24:50+02:00" will be converted to "2020-01-24T15:24:50Z"
|
|
2128
|
+
* Conversion is not happening if time zone shift is not specified.
|
|
2129
|
+
*/
|
|
2130
|
+
deployAt?: string;
|
|
2131
|
+
/**
|
|
2132
|
+
* Value indicating whether component links should also be resolved.
|
|
2133
|
+
*/
|
|
2134
|
+
includeComponentLinks?: boolean;
|
|
2135
|
+
/**
|
|
2136
|
+
* Value indicating whether dynamic version of the item will be resolved.
|
|
2137
|
+
*/
|
|
2138
|
+
includeDynamicVersion?: boolean;
|
|
2139
|
+
/**
|
|
2140
|
+
* Value indicating whether the item is published from the user's work list.
|
|
2141
|
+
*/
|
|
2142
|
+
includeWorkflow?: boolean;
|
|
2143
|
+
/**
|
|
2144
|
+
* Value indicating whether already published items should be published.
|
|
2145
|
+
*/
|
|
2146
|
+
publishNewContent?: boolean;
|
|
2147
|
+
/**
|
|
2148
|
+
* Value indicating the option to include the resolved items and/or structure.
|
|
2149
|
+
*/
|
|
2150
|
+
structureResolveOption?: StructureResolveOption;
|
|
2151
|
+
/**
|
|
2152
|
+
* Value indicating whether to resolve items also from all child Publications where user has PublishManagement rights.
|
|
2153
|
+
*/
|
|
2154
|
+
includeChildPublications?: boolean;
|
|
2155
|
+
/**
|
|
2156
|
+
* Value indicating whether items will be (un)published inside the current Publication.
|
|
2157
|
+
*/
|
|
2158
|
+
includeCurrentPublication?: boolean;
|
|
2159
|
+
/**
|
|
2160
|
+
* Collection of TCM URIs of child Publications where items will be unpublished.
|
|
2161
|
+
*/
|
|
2162
|
+
publishInChildPublications?: ReadonlyArray<ItemUri>;
|
|
2163
|
+
}
|
|
2164
|
+
|
|
2165
|
+
/**
|
|
2166
|
+
* @internal
|
|
2167
|
+
*/
|
|
2168
|
+
export declare type QueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'queryFn'>;
|
|
2169
|
+
|
|
2170
|
+
declare interface ReadonlyHierarchy<TData> {
|
|
2171
|
+
root: ReadonlyHierarchyNode<TData> | undefined;
|
|
2172
|
+
size: number;
|
|
2173
|
+
nodes: IterableIterator<ReadonlyHierarchyNode<TData>>;
|
|
2174
|
+
findNode(nodeId: string): ReadonlyHierarchyNode<TData> | undefined;
|
|
2175
|
+
getNode(nodeId: string): ReadonlyHierarchyNode<TData>;
|
|
2176
|
+
getParent(nodeId: string): ReadonlyHierarchyNode<TData> | undefined;
|
|
2177
|
+
getChildren(nodeId: string): ReadonlyHierarchyNode<TData>[];
|
|
2178
|
+
getDescendants(nodeId: string): ReadonlyHierarchyNode<TData>[];
|
|
2179
|
+
getAncestors(nodeId: string): ReadonlyArray<ReadonlyHierarchyNode<TData>>;
|
|
2180
|
+
iterateBreadthFirst(callback: (node: ReadonlyHierarchyNode<TData>) => {
|
|
2181
|
+
skipChildren?: boolean;
|
|
2182
|
+
stopIteration?: boolean;
|
|
2183
|
+
} | void, startingNodeId?: string): void;
|
|
2184
|
+
iterateDepthFirst(callback: (node: ReadonlyHierarchyNode<TData>) => {
|
|
2185
|
+
skipChildren?: boolean;
|
|
2186
|
+
stopIteration?: boolean;
|
|
2187
|
+
} | void, startingNodeId?: string): void;
|
|
2188
|
+
iterateParents(callback: (node: ReadonlyHierarchyNode<TData>) => boolean | void, startingNodeId: string): void;
|
|
2189
|
+
getPathToNode(nodeId: string): ReadonlyArray<ReadonlyHierarchyNode<TData>>;
|
|
2190
|
+
}
|
|
2191
|
+
|
|
2192
|
+
declare interface ReadonlyHierarchyNode<TData> {
|
|
2193
|
+
id: string;
|
|
2194
|
+
childrenIds: ReadonlyArray<string>;
|
|
2195
|
+
data: TData;
|
|
2196
|
+
level: number;
|
|
2197
|
+
parentId: string | undefined;
|
|
2198
|
+
}
|
|
2199
|
+
|
|
2200
|
+
/**
|
|
2201
|
+
* @internal
|
|
2202
|
+
*/
|
|
2203
|
+
export declare type RemoveFromBundleMutationHook = (options?: UseMutationOptions<IdentifiableObject, ApiError, RemoveFromBundleRequest>) => UseMutationResult<IdentifiableObject, ApiError, RemoveFromBundleRequest>;
|
|
2204
|
+
|
|
2205
|
+
/**
|
|
2206
|
+
* @internal
|
|
2207
|
+
*/
|
|
2208
|
+
export declare interface RemoveFromBundleRequest {
|
|
2209
|
+
bundleId: ItemUri;
|
|
2210
|
+
itemIdsToRemove: ReadonlyArray<ItemUri>;
|
|
2211
|
+
}
|
|
2212
|
+
|
|
2213
|
+
/**
|
|
2214
|
+
* @internal
|
|
2215
|
+
*/
|
|
2216
|
+
export declare type RestartActivitiesMutationHook = (options?: BatchMutationOptions<RestartActivitiesRequest>) => UseMutationResult<Batch, ApiError, RestartActivitiesRequest>;
|
|
2217
|
+
|
|
2218
|
+
/**
|
|
2219
|
+
* @internal
|
|
2220
|
+
*/
|
|
2221
|
+
export declare interface RestartActivitiesRequest {
|
|
2222
|
+
activityInstances: ReadonlyArray<ActivityInstance>;
|
|
2223
|
+
}
|
|
2224
|
+
|
|
2225
|
+
/**
|
|
2226
|
+
* @internal
|
|
2227
|
+
*/
|
|
2228
|
+
export declare type RestartActivityMutationHook = (options?: UseMutationOptions<ActivityInstance, ApiError, RestartActivityRequest>) => UseMutationResult<ActivityInstance, ApiError, RestartActivityRequest>;
|
|
2229
|
+
|
|
2230
|
+
/**
|
|
2231
|
+
* @internal
|
|
2232
|
+
*/
|
|
2233
|
+
export declare interface RestartActivityRequest {
|
|
2234
|
+
activityInstanceId: ItemUri;
|
|
2235
|
+
}
|
|
2236
|
+
|
|
2237
|
+
/**
|
|
2238
|
+
* @internal
|
|
2239
|
+
*/
|
|
2240
|
+
export declare type RevertItemMutationHook = (options?: UseMutationOptions<RepositoryLocalObject | void, ApiError, RevertItemRequest>) => UseMutationResult<RepositoryLocalObject | void, ApiError, RevertItemRequest>;
|
|
2241
|
+
|
|
2242
|
+
/**
|
|
2243
|
+
* @internal
|
|
2244
|
+
*/
|
|
2245
|
+
export declare interface RevertItemRequest {
|
|
2246
|
+
item: IdentifiableObject;
|
|
2247
|
+
contextItem?: IdentifiableObject;
|
|
2248
|
+
}
|
|
2249
|
+
|
|
2250
|
+
/**
|
|
2251
|
+
* @internal
|
|
2252
|
+
*/
|
|
2253
|
+
export declare type RevertItemsMutationHook = (options?: BatchMutationOptions<RevertItemsRequest>) => UseMutationResult<Batch, ApiError, RevertItemsRequest>;
|
|
2254
|
+
|
|
2255
|
+
/**
|
|
2256
|
+
* @internal
|
|
2257
|
+
*/
|
|
2258
|
+
export declare interface RevertItemsRequest {
|
|
2259
|
+
itemIds: ReadonlyArray<ItemUri>;
|
|
2260
|
+
containerId: ItemUri;
|
|
2261
|
+
}
|
|
2262
|
+
|
|
2263
|
+
/**
|
|
2264
|
+
* @internal
|
|
2265
|
+
*/
|
|
2266
|
+
export declare interface RichTextFieldConfig {
|
|
2267
|
+
readonly id: string;
|
|
2268
|
+
readonly useRichTextField: RichTextFieldHook;
|
|
2269
|
+
}
|
|
2270
|
+
|
|
2271
|
+
/**
|
|
2272
|
+
* @internal
|
|
2273
|
+
*/
|
|
2274
|
+
export declare type RichTextFieldCustomization = (configuration: RichTextFieldOptions) => void;
|
|
2275
|
+
|
|
2276
|
+
/**
|
|
2277
|
+
* @internal
|
|
2278
|
+
*/
|
|
2279
|
+
export declare interface RichTextFieldExtensions {
|
|
2280
|
+
readonly customizations: RichTextFieldConfig[];
|
|
2281
|
+
readonly plugins: RichTextFieldPlugin[];
|
|
2282
|
+
}
|
|
2283
|
+
|
|
2284
|
+
/**
|
|
2285
|
+
* @internal
|
|
2286
|
+
*/
|
|
2287
|
+
export declare class RichTextFieldExtensionsBuilder {
|
|
2288
|
+
private _customizations;
|
|
2289
|
+
private _plugins;
|
|
2290
|
+
customize: (customization: RichTextFieldConfig) => this;
|
|
2291
|
+
registerPlugin: (plugin: RichTextFieldPlugin) => this;
|
|
2292
|
+
build: () => RichTextFieldExtensions;
|
|
2293
|
+
}
|
|
2294
|
+
|
|
2295
|
+
/**
|
|
2296
|
+
* @internal
|
|
2297
|
+
*/
|
|
2298
|
+
export declare type RichTextFieldHook = (props: RichTextFieldHookProps) => RichTextFieldHookResult;
|
|
2299
|
+
|
|
2300
|
+
/**
|
|
2301
|
+
* @internal
|
|
2302
|
+
*/
|
|
2303
|
+
export declare interface RichTextFieldHookProps {
|
|
2304
|
+
/**
|
|
2305
|
+
* Indicates whether the field is rendered in read only mode or not
|
|
2306
|
+
*/
|
|
2307
|
+
isReadOnly: boolean;
|
|
2308
|
+
/**
|
|
2309
|
+
* Field definition of the form field
|
|
2310
|
+
*/
|
|
2311
|
+
fieldDefinition: ItemFieldDefinition;
|
|
2312
|
+
}
|
|
2313
|
+
|
|
2314
|
+
/**
|
|
2315
|
+
* @internal
|
|
2316
|
+
*/
|
|
2317
|
+
export declare type RichTextFieldHookResult = {
|
|
2318
|
+
readonly customize?: RichTextFieldCustomization;
|
|
2319
|
+
readonly setup?: RichTextFieldSetup;
|
|
2320
|
+
readonly isAvailable: boolean;
|
|
2321
|
+
};
|
|
2322
|
+
|
|
2323
|
+
/**
|
|
2324
|
+
* @internal
|
|
2325
|
+
*/
|
|
2326
|
+
export declare type RichTextFieldOptions = Omit<RawEditorOptions, 'id' | 'selector' | 'setup' | 'target'>;
|
|
2327
|
+
|
|
2328
|
+
/**
|
|
2329
|
+
* @internal
|
|
2330
|
+
*/
|
|
2331
|
+
export declare interface RichTextFieldPlugin {
|
|
2332
|
+
readonly id: string;
|
|
2333
|
+
readonly plugin: (editor: Editor) => void;
|
|
2334
|
+
}
|
|
2335
|
+
|
|
2336
|
+
/**
|
|
2337
|
+
* @internal
|
|
2338
|
+
*/
|
|
2339
|
+
export declare type RichTextFieldSetup = RawEditorOptions['setup'];
|
|
2340
|
+
|
|
2341
|
+
/**
|
|
2342
|
+
* @internal
|
|
2343
|
+
*/
|
|
2344
|
+
export declare type RollbackItemMutationHook = (options?: UseMutationOptions<RepositoryLocalObject, ApiError, RollbackItemRequest>) => UseMutationResult<RepositoryLocalObject, ApiError, RollbackItemRequest>;
|
|
2345
|
+
|
|
2346
|
+
/**
|
|
2347
|
+
* @internal
|
|
2348
|
+
*/
|
|
2349
|
+
export declare interface RollbackItemRequest {
|
|
2350
|
+
itemId: ItemUri;
|
|
2351
|
+
contextItem?: IdentifiableObject;
|
|
2352
|
+
deleteNewerVersions: boolean;
|
|
2353
|
+
}
|
|
2354
|
+
|
|
2355
|
+
/**
|
|
2356
|
+
* @internal
|
|
2357
|
+
*/
|
|
2358
|
+
export declare interface RuntimeInformation {
|
|
2359
|
+
name: string;
|
|
2360
|
+
peerDependencies: Record<string, string>;
|
|
2361
|
+
}
|
|
2362
|
+
|
|
2363
|
+
/**
|
|
2364
|
+
* @internal
|
|
2365
|
+
*/
|
|
2366
|
+
export declare type SearchInContainerQueryHook = (props: SearchInContainerQueryProps | undefined, options?: QueryOptions<ReadonlyArray<IdentifiableObject> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<IdentifiableObject> | undefined, ApiError>;
|
|
2367
|
+
|
|
2368
|
+
/**
|
|
2369
|
+
* @internal
|
|
2370
|
+
*/
|
|
2371
|
+
export declare interface SearchInContainerQueryProps {
|
|
2372
|
+
/**
|
|
2373
|
+
* URI of the container
|
|
2374
|
+
*/
|
|
2375
|
+
containerId: ItemUri;
|
|
2376
|
+
/**
|
|
2377
|
+
* Input for the full-text query.
|
|
2378
|
+
* The following characters have special meaning in the query syntax: + - && || ! ( ) \{ \} [ ] ^ " ~ * ? : \\\\
|
|
2379
|
+
* To use any of these characters without their syntactical meaning, to escape them by preceding the character with a \\\\.
|
|
2380
|
+
*/
|
|
2381
|
+
fullTextQuery: string;
|
|
2382
|
+
itemTypes?: ReadonlyArray<RloItemType>;
|
|
2383
|
+
/**
|
|
2384
|
+
* The maximum number of search results.
|
|
2385
|
+
*/
|
|
2386
|
+
resultLimit?: number;
|
|
2387
|
+
}
|
|
2388
|
+
|
|
2389
|
+
/**
|
|
2390
|
+
* @internal
|
|
2391
|
+
*/
|
|
2392
|
+
export declare interface SizeProps {
|
|
2393
|
+
/**
|
|
2394
|
+
* Width of the component.
|
|
2395
|
+
* Values higher than 1 are treated as pixels.
|
|
2396
|
+
* Values less than or equal to 1 are treated as percentage.
|
|
2397
|
+
* Zero is ignored.
|
|
2398
|
+
*/
|
|
2399
|
+
width?: number;
|
|
2400
|
+
/**
|
|
2401
|
+
* Height of the component.
|
|
2402
|
+
* Values higher than 1 are treated as pixels.
|
|
2403
|
+
* Values less than or equal to 1 are treated as percentage.
|
|
2404
|
+
* Zero is ignored.
|
|
2405
|
+
*/
|
|
2406
|
+
height?: number;
|
|
2407
|
+
minWidth?: number;
|
|
2408
|
+
minHeight?: number;
|
|
2409
|
+
maxWidth?: number;
|
|
2410
|
+
maxHeight?: number;
|
|
2411
|
+
}
|
|
2412
|
+
|
|
2413
|
+
/**
|
|
2414
|
+
* @internal
|
|
2415
|
+
*/
|
|
2416
|
+
export declare interface SpaceProps {
|
|
2417
|
+
margin?: SpacingUnit | SpacingUnit[];
|
|
2418
|
+
marginBottom?: SpacingUnit;
|
|
2419
|
+
marginTop?: SpacingUnit;
|
|
2420
|
+
marginLeft?: SpacingUnit;
|
|
2421
|
+
marginRight?: SpacingUnit;
|
|
2422
|
+
padding?: SpacingUnit | SpacingUnit[];
|
|
2423
|
+
paddingLeft?: SpacingUnit;
|
|
2424
|
+
paddingRight?: SpacingUnit;
|
|
2425
|
+
paddingTop?: SpacingUnit;
|
|
2426
|
+
paddingBottom?: SpacingUnit;
|
|
2427
|
+
}
|
|
2428
|
+
|
|
2429
|
+
/**
|
|
2430
|
+
* @internal
|
|
2431
|
+
*/
|
|
2432
|
+
export declare type SpacingUnit = 'zero' | 'nano' | 'xs' | 'sm' | 'md' | 'lg';
|
|
2433
|
+
|
|
2434
|
+
/**
|
|
2435
|
+
* @internal
|
|
2436
|
+
*/
|
|
2437
|
+
export declare type StartActivitiesMutationHook = (options?: BatchMutationOptions<StartActivitiesRequest>) => UseMutationResult<Batch, ApiError, StartActivitiesRequest>;
|
|
2438
|
+
|
|
2439
|
+
/**
|
|
2440
|
+
* @internal
|
|
2441
|
+
*/
|
|
2442
|
+
export declare interface StartActivitiesRequest {
|
|
2443
|
+
activityInstances: ReadonlyArray<ActivityInstance>;
|
|
2444
|
+
}
|
|
2445
|
+
|
|
2446
|
+
/**
|
|
2447
|
+
* @internal
|
|
2448
|
+
*/
|
|
2449
|
+
export declare type StartActivityMutationHook = (options?: UseMutationOptions<ActivityInstance, ApiError, StartActivityRequest>) => UseMutationResult<ActivityInstance, ApiError, StartActivityRequest>;
|
|
2450
|
+
|
|
2451
|
+
/**
|
|
2452
|
+
* @internal
|
|
2453
|
+
*/
|
|
2454
|
+
export declare interface StartActivityRequest {
|
|
2455
|
+
activityInstanceId: ItemUri;
|
|
2456
|
+
}
|
|
2457
|
+
|
|
2458
|
+
/**
|
|
2459
|
+
* @internal
|
|
2460
|
+
*/
|
|
2461
|
+
export declare type StartWorkflowMutationHook = (options?: UseMutationOptions<ProcessInstance, ApiError, StartWorkflowRequest>) => UseMutationResult<ProcessInstance, ApiError, StartWorkflowRequest>;
|
|
2462
|
+
|
|
2463
|
+
/**
|
|
2464
|
+
* @internal
|
|
2465
|
+
*/
|
|
2466
|
+
export declare interface StartWorkflowRequest {
|
|
2467
|
+
itemId: ItemUri;
|
|
2468
|
+
}
|
|
2469
|
+
|
|
2470
|
+
/**
|
|
2471
|
+
* @internal
|
|
2472
|
+
*/
|
|
2473
|
+
export declare interface StructureGroupEditorApiStorage {
|
|
2474
|
+
hooks: StructureGroupEditorHooksApiStorage;
|
|
2475
|
+
}
|
|
2476
|
+
|
|
2477
|
+
/**
|
|
2478
|
+
* @internal
|
|
2479
|
+
*/
|
|
2480
|
+
export declare type StructureGroupEditorHook = () => StructureGroupEditorHookResult | undefined;
|
|
2481
|
+
|
|
2482
|
+
/**
|
|
2483
|
+
* @internal
|
|
2484
|
+
*/
|
|
2485
|
+
export declare interface StructureGroupEditorHookResult {
|
|
2486
|
+
structureGroup: StructureGroup;
|
|
2487
|
+
metadataSchema: Schema;
|
|
2488
|
+
isChanged: boolean;
|
|
2489
|
+
isEditing: boolean;
|
|
2490
|
+
}
|
|
2491
|
+
|
|
2492
|
+
/**
|
|
2493
|
+
* @internal
|
|
2494
|
+
*/
|
|
2495
|
+
export declare interface StructureGroupEditorHooksApiStorage {
|
|
2496
|
+
useStructureGroupEditor: StructureGroupEditorHook;
|
|
2497
|
+
}
|
|
2498
|
+
|
|
2499
|
+
/**
|
|
2500
|
+
* @internal
|
|
2501
|
+
*/
|
|
2502
|
+
export declare type SystemSearchQueryHook = (props?: SystemSearchQueryProps, options?: QueryOptions<ReadonlyArray<IdentifiableObject> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<IdentifiableObject> | undefined, ApiError>;
|
|
2503
|
+
|
|
2504
|
+
/**
|
|
2505
|
+
* @internal
|
|
2506
|
+
*/
|
|
2507
|
+
export declare interface SystemSearchQueryProps {
|
|
2508
|
+
/**
|
|
2509
|
+
* Input for the full-text query.
|
|
2510
|
+
* The following characters have special meaning in the query syntax: + - && || ! ( ) \{ \} [ ] ^ " ~ * ? : \\\\
|
|
2511
|
+
* To use any of these characters without their syntactical meaning, to escape them by preceding the character with a \\\\.
|
|
2512
|
+
*/
|
|
2513
|
+
fullTextQuery?: string;
|
|
2514
|
+
/**
|
|
2515
|
+
* The maximum number of search results.
|
|
2516
|
+
*/
|
|
2517
|
+
resultLimit?: number;
|
|
2518
|
+
/**
|
|
2519
|
+
* Limits the search results to only items that are classified with the specified keyword IDs.
|
|
2520
|
+
*/
|
|
2521
|
+
usedKeywordsIds?: ReadonlyArray<ItemUri>;
|
|
2522
|
+
}
|
|
2523
|
+
|
|
2524
|
+
/**
|
|
2525
|
+
* @internal
|
|
2526
|
+
*/
|
|
2527
|
+
export declare type TableColumnExtension<TItem extends IdentifiableObject> = () => TableColumnExtensionConfiguration<TItem>;
|
|
2528
|
+
|
|
2529
|
+
/**
|
|
2530
|
+
* @internal
|
|
2531
|
+
*/
|
|
2532
|
+
export declare interface TableColumnExtensionComponentProps<TItem extends IdentifiableObject> {
|
|
2533
|
+
/**
|
|
2534
|
+
* Item that is rendered for the current row
|
|
2535
|
+
*/
|
|
2536
|
+
item: TItem;
|
|
2537
|
+
}
|
|
2538
|
+
|
|
2539
|
+
/**
|
|
2540
|
+
* @internal
|
|
2541
|
+
*/
|
|
2542
|
+
export declare interface TableColumnExtensionConfiguration<TItem extends IdentifiableObject> {
|
|
2543
|
+
/**
|
|
2544
|
+
* Column id (unique)
|
|
2545
|
+
*/
|
|
2546
|
+
readonly id: string;
|
|
2547
|
+
/**
|
|
2548
|
+
* Column title
|
|
2549
|
+
*/
|
|
2550
|
+
readonly title: string;
|
|
2551
|
+
/**
|
|
2552
|
+
* Column is resizable or fixed size
|
|
2553
|
+
*/
|
|
2554
|
+
readonly isResizable: boolean;
|
|
2555
|
+
/**
|
|
2556
|
+
* Component to render on this path
|
|
2557
|
+
*/
|
|
2558
|
+
readonly component: ComponentType<TableColumnExtensionComponentProps<TItem>>;
|
|
2559
|
+
/**
|
|
2560
|
+
* Minimal column with when resizing
|
|
2561
|
+
*/
|
|
2562
|
+
readonly minWidth?: number;
|
|
2563
|
+
/**
|
|
2564
|
+
* Initial column size (fixed when non-resizable)
|
|
2565
|
+
*/
|
|
2566
|
+
readonly initialWidth?: number;
|
|
2567
|
+
/**
|
|
2568
|
+
* Hook to determine if a table column is available
|
|
2569
|
+
*/
|
|
2570
|
+
readonly useIsAvailable: TableColumnIsAvailableHook;
|
|
2571
|
+
}
|
|
2572
|
+
|
|
2573
|
+
/**
|
|
2574
|
+
* @internal
|
|
2575
|
+
*/
|
|
2576
|
+
export declare type TableColumnIsAvailableHook = () => boolean;
|
|
2577
|
+
|
|
2578
|
+
/**
|
|
2579
|
+
* @internal
|
|
2580
|
+
*/
|
|
2581
|
+
declare const Text_2: TextComponent;
|
|
2582
|
+
export { Text_2 as Text }
|
|
2583
|
+
|
|
2584
|
+
/**
|
|
2585
|
+
* @internal
|
|
2586
|
+
*/
|
|
2587
|
+
export declare type TextComponent = FunctionComponent<TextProps>;
|
|
2588
|
+
|
|
2589
|
+
/**
|
|
2590
|
+
* A component to render Text Link for navigation
|
|
2591
|
+
* @internal
|
|
2592
|
+
*/
|
|
2593
|
+
export declare const TextLink: TextLinkComponent;
|
|
2594
|
+
|
|
2595
|
+
/**
|
|
2596
|
+
* @internal
|
|
2597
|
+
*/
|
|
2598
|
+
export declare type TextLinkComponent = FunctionComponent<TextLinkProps>;
|
|
2599
|
+
|
|
2600
|
+
/**
|
|
2601
|
+
* @internal
|
|
2602
|
+
*/
|
|
2603
|
+
export declare interface TextLinkProps extends TextProps, LinkProps {
|
|
2604
|
+
text: string;
|
|
2605
|
+
}
|
|
2606
|
+
|
|
2607
|
+
/**
|
|
2608
|
+
* @internal
|
|
2609
|
+
*/
|
|
2610
|
+
export declare interface TextProps {
|
|
2611
|
+
children?: ReactNode;
|
|
2612
|
+
}
|
|
2613
|
+
|
|
2614
|
+
/**
|
|
2615
|
+
* @internal
|
|
2616
|
+
*/
|
|
2617
|
+
export declare interface TooltipProps {
|
|
2618
|
+
/**
|
|
2619
|
+
* Tooltip that should be shown on hover.
|
|
2620
|
+
*/
|
|
2621
|
+
tooltip?: string;
|
|
2622
|
+
}
|
|
2623
|
+
|
|
2624
|
+
/**
|
|
2625
|
+
* @internal
|
|
2626
|
+
*/
|
|
2627
|
+
export declare interface TranslationExtensions {
|
|
2628
|
+
translations: ReadonlyArray<TranslationItemExtension>;
|
|
2629
|
+
}
|
|
2630
|
+
|
|
2631
|
+
/**
|
|
2632
|
+
* @internal
|
|
2633
|
+
*/
|
|
2634
|
+
export declare class TranslationExtensionsBuilder {
|
|
2635
|
+
private _translations;
|
|
2636
|
+
/**
|
|
2637
|
+
*
|
|
2638
|
+
* @param code - Language code.
|
|
2639
|
+
* @param records - Key-value pairs of string translated to `code` language.
|
|
2640
|
+
* @returns instance of `TranslationsExtensionsBuilder`
|
|
2641
|
+
*/
|
|
2642
|
+
addTranslation: (code: LanguageCode, records: Record<string, any>) => this;
|
|
2643
|
+
build: () => TranslationExtensions;
|
|
2644
|
+
}
|
|
2645
|
+
|
|
2646
|
+
/**
|
|
2647
|
+
* @internal
|
|
2648
|
+
*/
|
|
2649
|
+
export declare type TranslationItemExtension = () => TranslationItemExtensionConfiguration;
|
|
2650
|
+
|
|
2651
|
+
/**
|
|
2652
|
+
* @internal
|
|
2653
|
+
*/
|
|
2654
|
+
export declare interface TranslationItemExtensionConfiguration {
|
|
2655
|
+
/**
|
|
2656
|
+
* Language code.
|
|
2657
|
+
*/
|
|
2658
|
+
readonly code: LanguageCode;
|
|
2659
|
+
/**
|
|
2660
|
+
* Key-value pairs of string translated to `code` language.
|
|
2661
|
+
*/
|
|
2662
|
+
readonly records: Record<string, any>;
|
|
2663
|
+
}
|
|
2664
|
+
|
|
2665
|
+
/**
|
|
2666
|
+
* @internal
|
|
2667
|
+
*/
|
|
2668
|
+
export declare type UnlocalizeItemMutationHook = (options?: UseMutationOptions<RepositoryLocalObject, ApiError, UnlocalizeItemRequest>) => UseMutationResult<RepositoryLocalObject, ApiError, UnlocalizeItemRequest>;
|
|
2669
|
+
|
|
2670
|
+
/**
|
|
2671
|
+
* @internal
|
|
2672
|
+
*/
|
|
2673
|
+
export declare interface UnlocalizeItemRequest {
|
|
2674
|
+
itemId: ItemUri;
|
|
2675
|
+
contextItem?: IdentifiableObject;
|
|
2676
|
+
useDynamicVersion?: boolean;
|
|
2677
|
+
}
|
|
2678
|
+
|
|
2679
|
+
/**
|
|
2680
|
+
* @internal
|
|
2681
|
+
*/
|
|
2682
|
+
export declare type UnlocalizeItemsMutationHook = (options?: BatchMutationOptions<UnlocalizeItemsRequest>) => UseMutationResult<Batch, ApiError, UnlocalizeItemsRequest>;
|
|
2683
|
+
|
|
2684
|
+
/**
|
|
2685
|
+
* @internal
|
|
2686
|
+
*/
|
|
2687
|
+
export declare interface UnlocalizeItemsRequest {
|
|
2688
|
+
itemIds: ReadonlyArray<ItemUri>;
|
|
2689
|
+
containerId: ItemUri;
|
|
2690
|
+
}
|
|
2691
|
+
|
|
2692
|
+
/**
|
|
2693
|
+
* @internal
|
|
2694
|
+
*/
|
|
2695
|
+
export declare type UnpublishItemsMutationHook = (options?: UseMutationOptions<PublishTransactionsCreationResult, ApiError, UnpublishItemsRequest>) => UseMutationResult<PublishTransactionsCreationResult, ApiError, UnpublishItemsRequest>;
|
|
2696
|
+
|
|
2697
|
+
/**
|
|
2698
|
+
* @internal
|
|
2699
|
+
*/
|
|
2700
|
+
export declare interface UnpublishItemsRequest {
|
|
2701
|
+
/**
|
|
2702
|
+
* The identifiers of the items that will be send for un-publishing.
|
|
2703
|
+
*/
|
|
2704
|
+
itemIds: ReadonlyArray<ItemUri>;
|
|
2705
|
+
/**
|
|
2706
|
+
* The priority of the un-publish action.
|
|
2707
|
+
*/
|
|
2708
|
+
priority?: PublishPriority;
|
|
2709
|
+
/**
|
|
2710
|
+
* A collection of Publishing Target instances (Target Types or Purposes) where the items are published to.
|
|
2711
|
+
*/
|
|
2712
|
+
targetIdsOrPurposes?: ReadonlyArray<string>;
|
|
2713
|
+
/**
|
|
2714
|
+
* Date and time when the un-publishing should be started. Should be specified in UTC format.
|
|
2715
|
+
* The value will be converted to UTC time if specified with time zone shift, e.g. "2020-01-24T17:24:50+02:00" will be converted to "2020-01-24T15:24:50Z"
|
|
2716
|
+
* Conversion is not happening if time zone shift is not specified.
|
|
2717
|
+
*/
|
|
2718
|
+
startAt?: string;
|
|
2719
|
+
/**
|
|
2720
|
+
* Value indicating the option to include the resolved items and/or structure.
|
|
2721
|
+
*/
|
|
2722
|
+
structureResolveOption?: StructureResolveOption;
|
|
2723
|
+
/**
|
|
2724
|
+
* Value indicating whether to resolve items also from all child Publications where user has PublishManagement rights.
|
|
2725
|
+
*/
|
|
2726
|
+
includeChildPublications?: boolean;
|
|
2727
|
+
/**
|
|
2728
|
+
* Value indicating whether items will be (un)published inside the current Publication.
|
|
2729
|
+
*/
|
|
2730
|
+
includeCurrentPublication?: boolean;
|
|
2731
|
+
/**
|
|
2732
|
+
* Collection of TCM URIs of child Publications where items will be unpublished.
|
|
2733
|
+
*/
|
|
2734
|
+
publishInChildPublications?: ReadonlyArray<ItemUri>;
|
|
2735
|
+
}
|
|
2736
|
+
|
|
2737
|
+
/**
|
|
2738
|
+
* @internal
|
|
2739
|
+
*/
|
|
2740
|
+
export declare type UpdateItemMutationHook = (options?: UseMutationOptions<IdentifiableObject, ApiError, UpdateItemRequest>) => UseMutationResult<IdentifiableObject, ApiError, UpdateItemRequest>;
|
|
2741
|
+
|
|
2742
|
+
/**
|
|
2743
|
+
* @internal
|
|
2744
|
+
*/
|
|
2745
|
+
export declare interface UpdateItemRequest {
|
|
2746
|
+
item: IdentifiableObject;
|
|
2747
|
+
}
|
|
2748
|
+
|
|
2749
|
+
/**
|
|
2750
|
+
* @internal
|
|
2751
|
+
*/
|
|
2752
|
+
export declare type UploadMultimediaMutationHook = (options?: UseMutationOptions<UploadMultimediaMutationResult, ApiError, UploadMultimediaRequest>) => UseMutationResult<UploadMultimediaMutationResult, ApiError, UploadMultimediaRequest>;
|
|
2753
|
+
|
|
2754
|
+
/**
|
|
2755
|
+
* @internal
|
|
2756
|
+
*/
|
|
2757
|
+
export declare interface UploadMultimediaMutationResult {
|
|
2758
|
+
processId: string;
|
|
2759
|
+
resultsPerFile: Map<string, MultimediaUploadResult>;
|
|
2760
|
+
}
|
|
2761
|
+
|
|
2762
|
+
/**
|
|
2763
|
+
* @internal
|
|
2764
|
+
*/
|
|
2765
|
+
export declare interface UploadMultimediaRequest {
|
|
2766
|
+
files: ReadonlyArray<File>;
|
|
2767
|
+
containerId: ItemUri;
|
|
2768
|
+
schemaId?: ItemUri;
|
|
2769
|
+
}
|
|
2770
|
+
|
|
2771
|
+
/**
|
|
2772
|
+
* @internal
|
|
2773
|
+
*/
|
|
2774
|
+
export declare const useActivitiesExplorerTable: ActivitiesExplorerTableHook;
|
|
2775
|
+
|
|
2776
|
+
/**
|
|
2777
|
+
* @internal
|
|
2778
|
+
*/
|
|
2779
|
+
export declare const useActivityInstancesQuery: ActivityInstancesQueryHook;
|
|
2780
|
+
|
|
2781
|
+
/**
|
|
2782
|
+
* @internal
|
|
2783
|
+
*/
|
|
2784
|
+
export declare const useAddToBundleMutation: AddToBundleMutationHook;
|
|
2785
|
+
|
|
2786
|
+
/**
|
|
2787
|
+
* @internal
|
|
2788
|
+
*/
|
|
2789
|
+
export declare const useAssignActivitiesMutation: AssignActivitiesMutationHook;
|
|
2790
|
+
|
|
2791
|
+
/**
|
|
2792
|
+
* @internal
|
|
2793
|
+
*/
|
|
2794
|
+
export declare const useAssignActivityMutation: AssignActivityMutationHook;
|
|
2795
|
+
|
|
2796
|
+
/**
|
|
2797
|
+
* @internal
|
|
2798
|
+
*/
|
|
2799
|
+
export declare const useAutoClassifyItemMutation: AutoClassifyItemMutationHook;
|
|
2800
|
+
|
|
2801
|
+
/**
|
|
2802
|
+
* @internal
|
|
2803
|
+
*/
|
|
2804
|
+
export declare const useAutoClassifyItemsMutation: AutoClassifyItemsMutationHook;
|
|
2805
|
+
|
|
2806
|
+
/**
|
|
2807
|
+
* @internal
|
|
2808
|
+
*/
|
|
2809
|
+
export declare const useBundleEditor: BundleEditorHook;
|
|
2810
|
+
|
|
2811
|
+
/**
|
|
2812
|
+
* @internal
|
|
2813
|
+
*/
|
|
2814
|
+
export declare const useCategoryEditor: CategoryEditorHook;
|
|
2815
|
+
|
|
2816
|
+
/**
|
|
2817
|
+
* @internal
|
|
2818
|
+
*/
|
|
2819
|
+
export declare const useChangeUserLanguageMutation: ChangeUserLanguageMutationHook;
|
|
2820
|
+
|
|
2821
|
+
/**
|
|
2822
|
+
* @internal
|
|
2823
|
+
*/
|
|
2824
|
+
export declare const useChangeUserLocaleMutation: ChangeUserLocaleMutationHook;
|
|
2825
|
+
|
|
2826
|
+
/**
|
|
2827
|
+
* @internal
|
|
2828
|
+
*/
|
|
2829
|
+
export declare const useComponentEditor: ComponentEditorHook;
|
|
2830
|
+
|
|
2831
|
+
/**
|
|
2832
|
+
* @internal
|
|
2833
|
+
*/
|
|
2834
|
+
export declare const useConfirmation: ConfirmationHook;
|
|
2835
|
+
|
|
2836
|
+
/**
|
|
2837
|
+
* @internal
|
|
2838
|
+
*/
|
|
2839
|
+
export declare const useContentExplorer: ContentExplorerHook;
|
|
2840
|
+
|
|
2841
|
+
/**
|
|
2842
|
+
* @internal
|
|
2843
|
+
*/
|
|
2844
|
+
export declare const useContentExplorerTable: ContentExplorerTableHook;
|
|
2845
|
+
|
|
2846
|
+
/**
|
|
2847
|
+
* @internal
|
|
2848
|
+
*/
|
|
2849
|
+
export declare const useContentExplorerTree: ContentExplorerTreeHook;
|
|
2850
|
+
|
|
2851
|
+
/**
|
|
2852
|
+
* @internal
|
|
2853
|
+
*/
|
|
2854
|
+
export declare const useCopyItemMutation: CopyItemMutationHook;
|
|
2855
|
+
|
|
2856
|
+
/**
|
|
2857
|
+
* @internal
|
|
2858
|
+
*/
|
|
2859
|
+
export declare const useCopyItemsMutation: CopyItemsMutationHook;
|
|
2860
|
+
|
|
2861
|
+
/**
|
|
2862
|
+
* @internal
|
|
2863
|
+
*/
|
|
2864
|
+
export declare const useCreateTranslationJobMutation: CreateTranslationJobMutationHook;
|
|
2865
|
+
|
|
2866
|
+
/**
|
|
2867
|
+
* @internal
|
|
2868
|
+
*/
|
|
2869
|
+
export declare const useDefaultTranslationJobQuery: DefaultTranslationJobQueryHook;
|
|
2870
|
+
|
|
2871
|
+
/**
|
|
2872
|
+
* @internal
|
|
2873
|
+
*/
|
|
2874
|
+
export declare const useDeleteItemMutation: DeleteItemMutationHook;
|
|
2875
|
+
|
|
2876
|
+
/**
|
|
2877
|
+
* @internal
|
|
2878
|
+
*/
|
|
2879
|
+
export declare const useDeleteItemsMutation: DeleteItemsMutationHook;
|
|
2880
|
+
|
|
2881
|
+
/**
|
|
2882
|
+
* @internal
|
|
2883
|
+
*/
|
|
2884
|
+
export declare const useFavoritesQuery: FavoritesQueryHook;
|
|
2885
|
+
|
|
2886
|
+
/**
|
|
2887
|
+
* @internal
|
|
2888
|
+
*/
|
|
2889
|
+
export declare const useFinishActivitiesMutation: FinishActivitiesMutationHook;
|
|
2890
|
+
|
|
2891
|
+
/**
|
|
2892
|
+
* @internal
|
|
2893
|
+
*/
|
|
2894
|
+
export declare const useFinishActivityMutation: FinishActivityMutationHook;
|
|
2895
|
+
|
|
2896
|
+
/**
|
|
2897
|
+
* @internal
|
|
2898
|
+
*/
|
|
2899
|
+
export declare const useFinishEditingItemMutation: FinishEditingItemMutationHook;
|
|
2900
|
+
|
|
2901
|
+
/**
|
|
2902
|
+
* @internal
|
|
2903
|
+
*/
|
|
2904
|
+
export declare const useFinishEditingItemsMutation: FinishEditingItemsMutationHook;
|
|
2905
|
+
|
|
2906
|
+
/**
|
|
2907
|
+
* @internal
|
|
2908
|
+
*/
|
|
2909
|
+
export declare const useFolderEditor: FolderEditorHook;
|
|
2910
|
+
|
|
2911
|
+
/**
|
|
2912
|
+
* @internal
|
|
2913
|
+
*/
|
|
2914
|
+
export declare const useItemBlueprintHierarchyQuery: ItemBlueprintHierarchyQueryHook;
|
|
2915
|
+
|
|
2916
|
+
/**
|
|
2917
|
+
* @internal
|
|
2918
|
+
*/
|
|
2919
|
+
export declare const useItemChildrenQuery: ItemChildrenQueryHook;
|
|
2920
|
+
|
|
2921
|
+
/**
|
|
2922
|
+
* @internal
|
|
2923
|
+
*/
|
|
2924
|
+
export declare const useItemClassifiedItemsQuery: ItemClassifiedItemsQueryHook;
|
|
2925
|
+
|
|
2926
|
+
/**
|
|
2927
|
+
* @internal
|
|
2928
|
+
*/
|
|
2929
|
+
export declare const useItemDefaultDataQuery: ItemDefaultDataQueryHook;
|
|
2930
|
+
|
|
2931
|
+
/**
|
|
2932
|
+
* @internal
|
|
2933
|
+
*/
|
|
2934
|
+
export declare const useItemHistoryQuery: ItemHistoryQueryHook;
|
|
2935
|
+
|
|
2936
|
+
/**
|
|
2937
|
+
* @internal
|
|
2938
|
+
*/
|
|
2939
|
+
export declare const useItemPublishedPagesQuery: ItemPublishedPagesQueryHook;
|
|
2940
|
+
|
|
2941
|
+
/**
|
|
2942
|
+
* @internal
|
|
2943
|
+
*/
|
|
2944
|
+
export declare const useItemPublishedToQuery: ItemPublishedToQueryHook;
|
|
2945
|
+
|
|
2946
|
+
/**
|
|
2947
|
+
* @internal
|
|
2948
|
+
*/
|
|
2949
|
+
export declare const useItemPublishUrlsQuery: ItemPublishUrlsQueryHook;
|
|
2950
|
+
|
|
2951
|
+
/**
|
|
2952
|
+
* @internal
|
|
2953
|
+
*/
|
|
2954
|
+
export declare const useItemQuery: ItemQueryHook;
|
|
2955
|
+
|
|
2956
|
+
/**
|
|
2957
|
+
* @internal
|
|
2958
|
+
*/
|
|
2959
|
+
export declare const useItemsInProgressQuery: ItemsInProgressQueryHook;
|
|
2960
|
+
|
|
2961
|
+
/**
|
|
2962
|
+
* @internal
|
|
2963
|
+
*/
|
|
2964
|
+
export declare const useItemsQuery: ItemsQueryHook;
|
|
2965
|
+
|
|
2966
|
+
/**
|
|
2967
|
+
* @internal
|
|
2968
|
+
*/
|
|
2969
|
+
export declare const useItemsToPublishQuery: ItemsToPublishQueryHook;
|
|
2970
|
+
|
|
2971
|
+
/**
|
|
2972
|
+
* @internal
|
|
2973
|
+
*/
|
|
2974
|
+
export declare const useItemsToUnpublishQuery: ItemsToUnpublishQueryHook;
|
|
2975
|
+
|
|
2976
|
+
/**
|
|
2977
|
+
* @internal
|
|
2978
|
+
*/
|
|
2979
|
+
export declare const useItemTranslationInfoQuery: ItemTranslationInfoQueryHook;
|
|
2980
|
+
|
|
2981
|
+
/**
|
|
2982
|
+
* @internal
|
|
2983
|
+
*/
|
|
2984
|
+
export declare const useItemUsedByQuery: ItemUsedByQueryHook;
|
|
2985
|
+
|
|
2986
|
+
/**
|
|
2987
|
+
* @internal
|
|
2988
|
+
*/
|
|
2989
|
+
export declare const useItemUsesQuery: ItemUsesQueryHook;
|
|
2990
|
+
|
|
2991
|
+
/**
|
|
2992
|
+
* @internal
|
|
2993
|
+
*/
|
|
2994
|
+
export declare const useKeywordEditor: KeywordEditorHook;
|
|
2995
|
+
|
|
2996
|
+
/**
|
|
2997
|
+
* @internal
|
|
2998
|
+
*/
|
|
2999
|
+
export declare const useLocalizeItemMutation: LocalizeItemMutationHook;
|
|
3000
|
+
|
|
3001
|
+
/**
|
|
3002
|
+
* @internal
|
|
3003
|
+
*/
|
|
3004
|
+
export declare const useLocalizeItemsMutation: LocalizeItemsMutationHook;
|
|
3005
|
+
|
|
3006
|
+
/**
|
|
3007
|
+
* @internal
|
|
3008
|
+
*/
|
|
3009
|
+
export declare const useMoveItemMutation: MoveItemMutationHook;
|
|
3010
|
+
|
|
3011
|
+
/**
|
|
3012
|
+
* @internal
|
|
3013
|
+
*/
|
|
3014
|
+
export declare const useMoveItemsMutation: MoveItemsMutationHook;
|
|
3015
|
+
|
|
3016
|
+
/**
|
|
3017
|
+
* @internal
|
|
3018
|
+
*/
|
|
3019
|
+
export declare const useNotifications: NotificationsHook;
|
|
3020
|
+
|
|
3021
|
+
/**
|
|
3022
|
+
* @internal
|
|
3023
|
+
*/
|
|
3024
|
+
export declare const usePageEditor: PageEditorHook;
|
|
3025
|
+
|
|
3026
|
+
/**
|
|
3027
|
+
* @internal
|
|
3028
|
+
*/
|
|
3029
|
+
export declare const usePublicationBlueprintHierarchyQuery: PublicationBlueprintHierarchyQueryHook;
|
|
3030
|
+
|
|
3031
|
+
/**
|
|
3032
|
+
* @internal
|
|
3033
|
+
*/
|
|
3034
|
+
export declare const usePublicationsQuery: PublicationsQueryHook;
|
|
3035
|
+
|
|
3036
|
+
/**
|
|
3037
|
+
* @internal
|
|
3038
|
+
*/
|
|
3039
|
+
export declare const usePublishableTargetTypesQuery: PublishableTargetTypesQueryHook;
|
|
3040
|
+
|
|
3041
|
+
/**
|
|
3042
|
+
* @internal
|
|
3043
|
+
*/
|
|
3044
|
+
export declare const usePublishItemsMutation: PublishItemsMutationHook;
|
|
3045
|
+
|
|
3046
|
+
/**
|
|
3047
|
+
* @internal
|
|
3048
|
+
*/
|
|
3049
|
+
export declare const useRemoveFromBundleMutation: RemoveFromBundleMutationHook;
|
|
3050
|
+
|
|
3051
|
+
/**
|
|
3052
|
+
* @internal
|
|
3053
|
+
*/
|
|
3054
|
+
export declare const useRestartActivitiesMutation: RestartActivitiesMutationHook;
|
|
3055
|
+
|
|
3056
|
+
/**
|
|
3057
|
+
* @internal
|
|
3058
|
+
*/
|
|
3059
|
+
export declare const useRestartActivityMutation: RestartActivityMutationHook;
|
|
3060
|
+
|
|
3061
|
+
/**
|
|
3062
|
+
* @internal
|
|
3063
|
+
*/
|
|
3064
|
+
export declare const useRevertItemMutation: RevertItemMutationHook;
|
|
3065
|
+
|
|
3066
|
+
/**
|
|
3067
|
+
* @internal
|
|
3068
|
+
*/
|
|
3069
|
+
export declare const useRevertItemsMutation: RevertItemsMutationHook;
|
|
3070
|
+
|
|
3071
|
+
/**
|
|
3072
|
+
* @internal
|
|
3073
|
+
*/
|
|
3074
|
+
export declare type UserGroupsQueryHook = (props?: UserGroupsQueryProps, options?: QueryOptions<ReadonlyArray<UserGroup> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<UserGroup> | undefined, ApiError>;
|
|
3075
|
+
|
|
3076
|
+
/**
|
|
3077
|
+
* @internal
|
|
3078
|
+
*/
|
|
3079
|
+
export declare interface UserGroupsQueryProps {
|
|
3080
|
+
inPublicationId?: ItemUri;
|
|
3081
|
+
includeEveryone?: boolean;
|
|
3082
|
+
search?: string;
|
|
3083
|
+
searchMode?: UserGroupsQuerySearchMode;
|
|
3084
|
+
}
|
|
3085
|
+
|
|
3086
|
+
/**
|
|
3087
|
+
* @internal
|
|
3088
|
+
*/
|
|
3089
|
+
export declare type UserGroupsQuerySearchMode = StringSearchMode;
|
|
3090
|
+
|
|
3091
|
+
/**
|
|
3092
|
+
* @internal
|
|
3093
|
+
*/
|
|
3094
|
+
export declare const useRollbackItemMutation: RollbackItemMutationHook;
|
|
3095
|
+
|
|
3096
|
+
/**
|
|
3097
|
+
* @internal
|
|
3098
|
+
*/
|
|
3099
|
+
export declare type UserProfileHook = () => UserProfileHookResult;
|
|
3100
|
+
|
|
3101
|
+
/**
|
|
3102
|
+
* @internal
|
|
3103
|
+
*/
|
|
3104
|
+
export declare interface UserProfileHookResult {
|
|
3105
|
+
userProfile: UserProfile;
|
|
3106
|
+
}
|
|
3107
|
+
|
|
3108
|
+
/**
|
|
3109
|
+
* @internal
|
|
3110
|
+
*/
|
|
3111
|
+
export declare type UserProfileQueryHook = (options?: QueryOptions<UserProfile | undefined, ApiError>) => UseQueryResult<UserProfile | undefined, ApiError>;
|
|
3112
|
+
|
|
3113
|
+
/**
|
|
3114
|
+
* @internal
|
|
3115
|
+
*/
|
|
3116
|
+
export declare type UsersQueryHook = (props?: UsersQueryProps, options?: QueryOptions<ReadonlyArray<User> | undefined, ApiError>) => UseQueryResult<ReadonlyArray<User> | undefined, ApiError>;
|
|
3117
|
+
|
|
3118
|
+
/**
|
|
3119
|
+
* @internal
|
|
3120
|
+
*/
|
|
3121
|
+
export declare interface UsersQueryProps {
|
|
3122
|
+
predefined?: boolean;
|
|
3123
|
+
includeDisabled?: boolean;
|
|
3124
|
+
search?: string;
|
|
3125
|
+
searchMode?: UsersQuerySearchMode;
|
|
3126
|
+
}
|
|
3127
|
+
|
|
3128
|
+
/**
|
|
3129
|
+
* @internal
|
|
3130
|
+
*/
|
|
3131
|
+
export declare type UsersQuerySearchMode = StringSearchMode;
|
|
3132
|
+
|
|
3133
|
+
/**
|
|
3134
|
+
* @internal
|
|
3135
|
+
*/
|
|
3136
|
+
export declare const useSearchInContainerQuery: SearchInContainerQueryHook;
|
|
3137
|
+
|
|
3138
|
+
/**
|
|
3139
|
+
* @internal
|
|
3140
|
+
*/
|
|
3141
|
+
export declare const useStartActivitiesMutation: StartActivitiesMutationHook;
|
|
3142
|
+
|
|
3143
|
+
/**
|
|
3144
|
+
* @internal
|
|
3145
|
+
*/
|
|
3146
|
+
export declare const useStartActivityMutation: StartActivityMutationHook;
|
|
3147
|
+
|
|
3148
|
+
/**
|
|
3149
|
+
* @internal
|
|
3150
|
+
*/
|
|
3151
|
+
export declare const useStartWorkflowMutation: StartWorkflowMutationHook;
|
|
3152
|
+
|
|
3153
|
+
/**
|
|
3154
|
+
* @internal
|
|
3155
|
+
*/
|
|
3156
|
+
export declare const useStructureGroupEditor: StructureGroupEditorHook;
|
|
3157
|
+
|
|
3158
|
+
/**
|
|
3159
|
+
* @internal
|
|
3160
|
+
*/
|
|
3161
|
+
export declare const useSystemSearchQuery: SystemSearchQueryHook;
|
|
3162
|
+
|
|
3163
|
+
/**
|
|
3164
|
+
* @internal
|
|
3165
|
+
*/
|
|
3166
|
+
export declare const useUnlocalizeItemMutation: UnlocalizeItemMutationHook;
|
|
3167
|
+
|
|
3168
|
+
/**
|
|
3169
|
+
* @internal
|
|
3170
|
+
*/
|
|
3171
|
+
export declare const useUnlocalizeItemsMutation: UnlocalizeItemsMutationHook;
|
|
3172
|
+
|
|
3173
|
+
/**
|
|
3174
|
+
* @internal
|
|
3175
|
+
*/
|
|
3176
|
+
export declare const useUnpublishItemsMutation: UnpublishItemsMutationHook;
|
|
3177
|
+
|
|
3178
|
+
/**
|
|
3179
|
+
* @internal
|
|
3180
|
+
*/
|
|
3181
|
+
export declare const useUpdateItemMutation: UpdateItemMutationHook;
|
|
3182
|
+
|
|
3183
|
+
/**
|
|
3184
|
+
* @internal
|
|
3185
|
+
*/
|
|
3186
|
+
export declare const useUploadMultimediaMutation: UploadMultimediaMutationHook;
|
|
3187
|
+
|
|
3188
|
+
/**
|
|
3189
|
+
* @internal
|
|
3190
|
+
*/
|
|
3191
|
+
export declare const useUserGroupsQuery: UserGroupsQueryHook;
|
|
3192
|
+
|
|
3193
|
+
/**
|
|
3194
|
+
* @internal
|
|
3195
|
+
*/
|
|
3196
|
+
export declare const useUserProfile: UserProfileHook;
|
|
3197
|
+
|
|
3198
|
+
/**
|
|
3199
|
+
* @internal
|
|
3200
|
+
*/
|
|
3201
|
+
export declare const useUserProfileQuery: UserProfileQueryHook;
|
|
3202
|
+
|
|
3203
|
+
/**
|
|
3204
|
+
* @internal
|
|
3205
|
+
*/
|
|
3206
|
+
export declare const useUsersQuery: UsersQueryHook;
|
|
3207
|
+
|
|
3208
|
+
declare type ValuesOfArray<T> = T extends {
|
|
3209
|
+
[index: number]: infer E;
|
|
3210
|
+
} ? E : never;
|
|
3211
|
+
|
|
3212
|
+
declare type Without<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
|
|
3213
|
+
|
|
3214
|
+
export { }
|