@tridion-sites/models 1.1.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,34 @@
1
1
  # @tridion-sites/models
2
2
 
3
+ ## 2.0.0
4
+
5
+ ### Major Changes
6
+
7
+ - 051b91a: [Breaking!] Models: map `Link`s inside content and metadata
8
+
9
+ ### Minor Changes
10
+
11
+ - c7a65bc: Update model mapper to fallback to regular component when it can not be distinguished by `ComponentType`
12
+ - 7cf79a9: OpenAPI v3 update
13
+ - d56f8fa: Add `isLocalizable` field
14
+ - 6ff5e58: Add generic `ListInfo` type to `IdentifiableObject`
15
+ - c3ba102: Add `primaryItem` to `ItemBlueprintHierarchy`
16
+ - e514a9a: Add new OpenAPI v3 error type `ValidationApiError`
17
+
18
+ ### Patch Changes
19
+
20
+ - f1bb40c: Update API comments
21
+ - 1b0165e: Update axios to avoid vulnerability
22
+ - 2532518: Fix default value for `ItemFieldDefinition.isLocalizable` model
23
+ - b4d732a: Update `@tridion/graphene` dependency
24
+ - f1bb40c: Update 3rd party dependencies
25
+
26
+ ## 1.1.1
27
+
28
+ ### Patch Changes
29
+
30
+ - c78d191530: Resolved issue with TranslationJobItem mapping
31
+
3
32
  ## 1.1.0
4
33
 
5
34
  ### Minor Changes
package/dist/index.d.ts CHANGED
@@ -40,11 +40,14 @@ import type { ComponentPresentation as ComponentPresentation_2 } from '@tridion-
40
40
  import type { ComponentTemplate as ComponentTemplate_2 } from '@tridion-sites/open-api-client';
41
41
  import type { DateFieldDefinition as DateFieldDefinition_2 } from '@tridion-sites/open-api-client';
42
42
  import type { DateListDefinition as DateListDefinition_2 } from '@tridion-sites/open-api-client';
43
+ import { DependencyDirection as DependencyDirection_2 } from '@tridion-sites/open-api-client';
44
+ import type { DependencyGraphNode as DependencyGraphNode_2 } from '@tridion-sites/open-api-client';
43
45
  import type { DynamicVersionInfo as DynamicVersionInfo_2 } from '@tridion-sites/open-api-client';
44
46
  import type { EmbeddedRegion as EmbeddedRegion_2 } from '@tridion-sites/open-api-client';
45
47
  import type { EmbeddedSchemaFieldDefinition as EmbeddedSchemaFieldDefinition_2 } from '@tridion-sites/open-api-client';
46
48
  import type { ErrorDetails } from '@tridion-sites/open-api-client';
47
49
  import { ErrorSeverity } from '@tridion-sites/open-api-client';
50
+ import { ErrorType } from '@tridion-sites/open-api-client';
48
51
  import type { ExceptionDetails } from '@tridion-sites/open-api-client';
49
52
  import type { ExternalCategory } from '@tridion-sites/open-api-client';
50
53
  import type { ExternalComponent } from '@tridion-sites/open-api-client';
@@ -69,7 +72,9 @@ import type { LimitedVersionInfo as LimitedVersionInfo_2 } from '@tridion-sites/
69
72
  import type { Link as Link_2 } from '@tridion-sites/open-api-client';
70
73
  import type { LinkWithIsEditable as LinkWithIsEditable_2 } from '@tridion-sites/open-api-client';
71
74
  import type { ListDefinition as ListDefinition_2 } from '@tridion-sites/open-api-client';
75
+ import { ListDetails } from '@tridion-sites/open-api-client';
72
76
  import type { LoadInfo as LoadInfo_2 } from '@tridion-sites/open-api-client';
77
+ import { LoadInfoState as LoadInfoState_2 } from '@tridion-sites/open-api-client';
73
78
  import type { LocationInfo as LocationInfo_2 } from '@tridion-sites/open-api-client';
74
79
  import type { LockInfo as LockInfo_2 } from '@tridion-sites/open-api-client';
75
80
  import { LockType as LockType_2 } from '@tridion-sites/open-api-client';
@@ -94,6 +99,7 @@ import type { PublishInstructionBase as PublishInstructionBase_2 } from '@tridio
94
99
  import type { PublishLocationInfo as PublishLocationInfo_2 } from '@tridion-sites/open-api-client';
95
100
  import { PublishPriority as PublishPriority_2 } from '@tridion-sites/open-api-client';
96
101
  import type { PublishTransaction as PublishTransaction_2 } from '@tridion-sites/open-api-client';
102
+ import type { PublishTransactionListInfo as PublishTransactionListInfo_2 } from '@tridion-sites/open-api-client';
97
103
  import type { PublishTransactionsCreationResult as PublishTransactionsCreationResult_2 } from '@tridion-sites/open-api-client';
98
104
  import { PublishTransactionState as PublishTransactionState_2 } from '@tridion-sites/open-api-client';
99
105
  import type { PublishUrlInfo as PublishUrlInfo_2 } from '@tridion-sites/open-api-client';
@@ -113,6 +119,9 @@ import type { SingleLineTextListDefinition as SingleLineTextListDefinition_2 } f
113
119
  import { StringSearchMode as StringSearchMode_2 } from '@tridion-sites/open-api-client';
114
120
  import type { StructureGroup as StructureGroup_2 } from '@tridion-sites/open-api-client';
115
121
  import { StructureResolveOption as StructureResolveOption_2 } from '@tridion-sites/open-api-client';
122
+ import type { SynchronizationAction as SynchronizationAction_2 } from '@tridion-sites/open-api-client';
123
+ import type { SynchronizationResult as SynchronizationResult_2 } from '@tridion-sites/open-api-client';
124
+ import { SynchronizeFlags as SynchronizeFlags_2 } from '@tridion-sites/open-api-client';
116
125
  import type { SystemPrivilege as SystemPrivilege_2 } from '@tridion-sites/open-api-client';
117
126
  import type { SystemWideObject as SystemWideObject_2 } from '@tridion-sites/open-api-client';
118
127
  import type { TargetGroup as TargetGroup_2 } from '@tridion-sites/open-api-client';
@@ -148,6 +157,7 @@ import type { ValidationResult as ValidationResult_2 } from '@tridion-sites/open
148
157
  import type { ValidationWarning as ValidationWarning_2 } from '@tridion-sites/open-api-client';
149
158
  import type { VersionedItem as VersionedItem_2 } from '@tridion-sites/open-api-client';
150
159
  import type { VirtualFolder as VirtualFolder_2 } from '@tridion-sites/open-api-client';
160
+ import type { WhereUsedListInfo as WhereUsedListInfo_2 } from '@tridion-sites/open-api-client';
151
161
  import type { WorkflowInfo as WorkflowInfo_2 } from '@tridion-sites/open-api-client';
152
162
  import type { WorkflowObject as WorkflowObject_2 } from '@tridion-sites/open-api-client';
153
163
  import type { WorkflowStatus } from '@tridion-sites/open-api-client';
@@ -321,15 +331,13 @@ export declare abstract class Activity extends WorkflowObject {
321
331
 
322
332
  /**
323
333
  * Defines the constraints of an Activity Instance.
324
- *
325
- * * `none` - Does not have any constraints.
326
- * * `denyBundleMetadataEditing` - Denies editing Metadata of a Bundle in workflow.
327
- * * `denySubjectEditing` - Denies editing Subject in workflow.
328
- * * `denyAddRemoveWorkItem` - Denies adding/removing work items to/from the Activity.
329
- * * `unknownByClient` - * Special reserved value used to notify an older API version client about
334
+ * - `none` - Does not have any constraints.
335
+ * - `denyBundleMetadataEditing` - Denies editing Metadata of a Bundle in workflow.
336
+ * - `denySubjectEditing` - Denies editing Subject in workflow.
337
+ * - `denyAddRemoveWorkItem` - Denies adding/removing work items to/from the Activity.
338
+ * - `unknownByClient` - Special reserved value used to notify an older API version client about
330
339
  * the presence of an enumeration member added in a later API version. Explicitly setting this value
331
340
  * by a client is not allowed, but client code should check it and be able to handle such cases.
332
- *
333
341
  */
334
342
  export declare type ActivityConstraints = 'none' | 'denyBundleMetadataEditing' | 'denySubjectEditing' | 'denyAddRemoveWorkItem' | 'unknownByClient';
335
343
 
@@ -588,6 +596,23 @@ export declare class ApprovalStatus extends SystemWideObject {
588
596
  export declare interface ApprovalStatusConstructorArgs extends SystemWideObjectConstructorArgs {
589
597
  }
590
598
 
599
+ export declare interface BackendValidationApiError extends ApiError_2 {
600
+ body: BackendValidationApiErrorBody;
601
+ }
602
+
603
+ export declare interface BackendValidationApiErrorBody {
604
+ Data: BackendValidationApiErrorData;
605
+ Message: string;
606
+ Status: number;
607
+ }
608
+
609
+ export declare interface BackendValidationApiErrorData {
610
+ Category: string;
611
+ ErrorCode: string;
612
+ ValidationErrors?: ValidationError_2[];
613
+ ValidationWarnings?: ValidationWarning_2[];
614
+ }
615
+
591
616
  /**
592
617
  * Basic version information about any Identifiable Object.
593
618
  */
@@ -1083,7 +1108,8 @@ export declare interface ClassificationInfoConstructorArgs {
1083
1108
  * Represents the data of a regular Component: content and metadata fields.
1084
1109
  */
1085
1110
  export declare class Component extends ComponentBase {
1086
- constructor(componentArgs: ComponentConstructorArgs);
1111
+ private _content;
1112
+ constructor({ content, backendModel, ...componentBaseArgs }: ComponentConstructorArgs);
1087
1113
  get content(): FieldsValueDictionary | undefined;
1088
1114
  }
1089
1115
 
@@ -1136,6 +1162,7 @@ export declare interface ComponentBaseConstructorArgs extends VersionedItemConst
1136
1162
 
1137
1163
  export declare interface ComponentConstructorArgs extends ComponentBaseConstructorArgs {
1138
1164
  backendModel: Component_2;
1165
+ content: Record<string, any> | undefined;
1139
1166
  }
1140
1167
 
1141
1168
  /**
@@ -1369,6 +1396,41 @@ export declare interface DateListDefinitionConstructorArgs extends ListDefinitio
1369
1396
  entries: ReadonlyArray<Date> | undefined;
1370
1397
  }
1371
1398
 
1399
+ export declare type DependencyDirection = 'uses' | 'usedBy';
1400
+
1401
+ /**
1402
+ * Node in a dependency graph.
1403
+ */
1404
+ export declare class DependencyGraphNode {
1405
+ protected _backendModel: DependencyGraphNode_2;
1406
+ private _dependencies;
1407
+ private _item;
1408
+ constructor({ backendModel, dependencies, item }: DependencyGraphNodeConstructorArgs);
1409
+ /**
1410
+ * The list of dependencies that the graph node has.
1411
+ */
1412
+ get dependencies(): ReadonlyArray<DependencyGraphNode> | undefined;
1413
+ /**
1414
+ * Indicates whether the graph node exists in the given context Repository.
1415
+ */
1416
+ get existsInContext(): boolean;
1417
+ /**
1418
+ * Indicates whether there are more (transitive) dependencies than returned for the graph node.
1419
+ */
1420
+ get hasMore(): boolean;
1421
+ /**
1422
+ * The item that the graph node represents.
1423
+ */
1424
+ get item(): IdentifiableObject | undefined;
1425
+ getInternalModel: () => DependencyGraphNode_2;
1426
+ }
1427
+
1428
+ export declare interface DependencyGraphNodeConstructorArgs {
1429
+ backendModel: DependencyGraphNode_2;
1430
+ dependencies: ReadonlyArray<DependencyGraphNode> | undefined;
1431
+ item: IdentifiableObject | undefined;
1432
+ }
1433
+
1372
1434
  /**
1373
1435
  * Represents the action the deployer needs to take.
1374
1436
  *
@@ -1860,10 +1922,11 @@ export declare class HateoasLink {
1860
1922
  /**
1861
1923
  * Abstract base class for all objects that can be identified using a "TCM URI".
1862
1924
  */
1863
- export declare abstract class IdentifiableObject {
1925
+ export declare abstract class IdentifiableObject<TListInfo extends ListInfoDictionary = ListInfoDictionary> {
1864
1926
  protected _backendModel: IdentifiableObject_2;
1865
1927
  protected _id: ItemUri;
1866
1928
  private _loadInfo;
1929
+ private _listInfo;
1867
1930
  private _basicVersionInfo;
1868
1931
  private _applicableActions;
1869
1932
  private _listLinks;
@@ -1901,7 +1964,14 @@ export declare abstract class IdentifiableObject {
1901
1964
  * Extension properties dictionary which may be used by extensions.Key must comply with XML NCName datatype.This value is not persisted by Content Manager Kernel.
1902
1965
  */
1903
1966
  get extensionProperties(): ExtensionPropertyDictionary | undefined;
1967
+ /**
1968
+ * Collection of the hateoas links.
1969
+ */
1904
1970
  get listLinks(): ReadonlyArray<HateoasLink> | undefined;
1971
+ /**
1972
+ * List information of the object.
1973
+ */
1974
+ get listInfo(): TListInfo | undefined;
1905
1975
  get securityDescriptor(): SecurityDescriptor | undefined;
1906
1976
  getInternalModel: () => IdentifiableObject_2;
1907
1977
  hasApplicableAction: (applicableAction: ApplicableAction) => boolean;
@@ -1913,10 +1983,11 @@ export declare abstract class IdentifiableObject {
1913
1983
  export declare interface IdentifiableObjectConstructorArgs {
1914
1984
  backendModel: IdentifiableObject_2;
1915
1985
  id: ItemUri;
1916
- loadInfo: LoadInfo | undefined;
1917
- basicVersionInfo: BasicVersionInfo | undefined;
1918
1986
  applicableActions: ReadonlyArray<HateoasLink> | undefined;
1987
+ basicVersionInfo: BasicVersionInfo | undefined;
1988
+ listInfo: ListInfoDictionary | undefined;
1919
1989
  listLinks: ReadonlyArray<HateoasLink> | undefined;
1990
+ loadInfo: LoadInfo | undefined;
1920
1991
  securityDescriptor: SecurityDescriptor | undefined;
1921
1992
  }
1922
1993
 
@@ -1925,8 +1996,10 @@ export declare const isRloNode: (node: ItemBlueprintNode) => node is BlueprintRe
1925
1996
  export declare class ItemBlueprintHierarchy {
1926
1997
  protected _backendModel: BlueprintHierarchyResponse;
1927
1998
  private _graph;
1999
+ private _primaryItem;
1928
2000
  constructor(backendModel: BlueprintHierarchyResponse);
1929
2001
  readonly rootNode: ItemBlueprintNode;
2002
+ get primaryItem(): RepositoryLocalObject;
1930
2003
  getNodeByPublicationId: (publicationId: ItemUri) => ItemBlueprintNode | undefined;
1931
2004
  getNodeByItemId: (itemId: ItemUri) => ItemBlueprintNode | undefined;
1932
2005
  getInternalModel: () => BlueprintHierarchyResponse;
@@ -1934,7 +2007,7 @@ export declare class ItemBlueprintHierarchy {
1934
2007
 
1935
2008
  export declare type ItemBlueprintNode = BlueprintReadonlyGraphNode<ItemBlueprintNodeData>;
1936
2009
 
1937
- export declare type ItemBlueprintNodeData = ReadonlyItemBlueprintRloNodeData | Publication;
2010
+ export declare type ItemBlueprintNodeData = ReadonlyItemBlueprintRloNodeData | Link;
1938
2011
 
1939
2012
  export declare class ItemBlueprintRloNodeData implements ReadonlyItemBlueprintRloNodeData {
1940
2013
  private _sharedOrLocalizedFromItem?;
@@ -1968,6 +2041,10 @@ export declare abstract class ItemFieldDefinition {
1968
2041
  * Extension XML element which can contain any custom data.
1969
2042
  */
1970
2043
  get extensionXml(): string | undefined;
2044
+ /**
2045
+ * Whether this field is localizable (default) or not.
2046
+ */
2047
+ get isLocalizable(): boolean;
1971
2048
  /**
1972
2049
  * Maximum occurrence of the field.
1973
2050
  *
@@ -2329,6 +2406,10 @@ export declare interface ListDefinitionConstructorArgs {
2329
2406
  type: ListType | undefined;
2330
2407
  }
2331
2408
 
2409
+ export declare type ListDetailsLevel = 'idAndTitleOnly' | 'withApplicableActions' | 'contentless';
2410
+
2411
+ export declare type ListInfoDictionary = Record<string, any>;
2412
+
2332
2413
  export declare type ListLink = keyof typeof listLinks;
2333
2414
 
2334
2415
  export declare const listLinks: {
@@ -2471,6 +2552,14 @@ export declare const mapActivityStateToBackend: (model: ActivityState) => Activi
2471
2552
 
2472
2553
  export declare const mapBatchOperationState: (backendModel: BatchOperationState_2) => BatchOperationState;
2473
2554
 
2555
+ export declare const mapDependencyDirectionToBackend: (backendValue: DependencyDirection) => DependencyDirection_2;
2556
+
2557
+ export declare const mapErrorTypeToBackend: (errorType: LoadInfoErrorType | undefined) => ErrorType | undefined;
2558
+
2559
+ export declare const mapListDetailsLevelToBackend: (backendValue: ListDetailsLevel) => ListDetails;
2560
+
2561
+ export declare const mapLoadInfoStateToBackend: (loadInfoState: LoadInfoState) => LoadInfoState_2;
2562
+
2474
2563
  export declare const mapLockTypeToBackend: (model: LockType) => LockType_2;
2475
2564
 
2476
2565
  export declare const mapPublishPriorityToBackend: (model: PublishPriority) => PublishPriority_2;
@@ -2485,9 +2574,11 @@ export declare const mapStringSearchModeToBackend: (backendModel: StringSearchMo
2485
2574
 
2486
2575
  export declare const mapStructureResolveOptionToBackend: (model: StructureResolveOption) => StructureResolveOption_2;
2487
2576
 
2577
+ export declare const mapSynchronizeFlagsToBackend: (model: SynchronizeFlags) => SynchronizeFlags_2;
2578
+
2488
2579
  export declare const mapToModel: <T>(backendItem: Record<string, any>) => T;
2489
2580
 
2490
- export declare const mapToModels: <T>(backendItems: ReadonlyArray<any>) => readonly T[];
2581
+ export declare const mapToModels: <T>(backendItems: ReadonlyArray<any>) => ReadonlyArray<T>;
2491
2582
 
2492
2583
  export declare const mapTranslationErrorSeverityToBackend: (model: TranslationErrorSeverity) => ErrorSeverity;
2493
2584
 
@@ -3062,6 +3153,7 @@ export declare class PublicationBlueprintHierarchy {
3062
3153
  constructor(backendModel: BlueprintHierarchyResponse);
3063
3154
  get rootNode(): BlueprintReadonlyGraphNode<Publication>;
3064
3155
  getNode: (publicationId: ItemUri) => BlueprintReadonlyGraphNode<Publication> | undefined;
3156
+ getNodes: () => ReadonlyArray<BlueprintReadonlyGraphNode<Publication>> | undefined;
3065
3157
  getInternalModel: () => BlueprintHierarchyResponse;
3066
3158
  }
3067
3159
 
@@ -3078,6 +3170,11 @@ export declare interface PublicationConstructorArgs extends RepositoryConstructo
3078
3170
  templateBundleProcess: Link | undefined;
3079
3171
  }
3080
3172
 
3173
+ /**
3174
+ * Distinguishes publishing and unpublishing actions.
3175
+ */
3176
+ export declare type PublishAction = 'publish' | 'unpublish';
3177
+
3081
3178
  export declare class PublishContext {
3082
3179
  protected _backendModel: PublishContext_2;
3083
3180
  private _processedItems;
@@ -3247,7 +3344,7 @@ export declare interface PublishLocationInfoConstructorArgs extends LocationInfo
3247
3344
  */
3248
3345
  export declare type PublishPriority = 'low' | 'normal' | 'high';
3249
3346
 
3250
- export declare class PublishTransaction extends SystemWideObject {
3347
+ export declare class PublishTransaction<TListInfo extends ListInfoDictionary = ListInfoDictionary> extends SystemWideObject<TListInfo> {
3251
3348
  protected _backendModel: PublishTransaction_2;
3252
3349
  private _creator;
3253
3350
  private _deployerAction;
@@ -3341,6 +3438,25 @@ export declare interface PublishTransactionConstructorArgs extends SystemWideObj
3341
3438
  stateChangeDateTime: Date | undefined;
3342
3439
  }
3343
3440
 
3441
+ export declare class PublishTransactionListInfo {
3442
+ protected _backendModel: PublishTransactionListInfo_2;
3443
+ protected _publishAction: PublishAction | undefined;
3444
+ protected _scheduleTime: Date | undefined;
3445
+ constructor({ backendModel, publishAction, scheduleTime }: PublishTransactionListInfoConstructorArgs);
3446
+ get itemPath(): string | undefined;
3447
+ get publicationTargetTitle(): string | undefined;
3448
+ get publicationTitle(): string | undefined;
3449
+ get publishAction(): PublishAction | undefined;
3450
+ get scheduleTime(): Date | undefined;
3451
+ getInternalModel: () => PublishTransactionListInfo_2;
3452
+ }
3453
+
3454
+ export declare interface PublishTransactionListInfoConstructorArgs {
3455
+ backendModel: PublishTransactionListInfo_2;
3456
+ publishAction: PublishAction | undefined;
3457
+ scheduleTime: Date | undefined;
3458
+ }
3459
+
3344
3460
  export declare class PublishTransactionsCreationResult {
3345
3461
  protected _backendModel: PublishTransactionsCreationResult_2;
3346
3462
  private _publishTransactionIds;
@@ -3443,8 +3559,9 @@ export declare abstract class RepositoryLocalObject extends IdentifiableObject {
3443
3559
  private _blueprintInfo;
3444
3560
  private _locationInfo;
3445
3561
  private _lockInfo;
3562
+ private _metadata;
3446
3563
  private _isLocked;
3447
- constructor({ backendModel, blueprintInfo, isLocked, limitedVersionInfo, locationInfo, lockInfo, metadataSchema, ...identifiableObjectArgs }: RepositoryLocalObjectConstructorArgs);
3564
+ constructor({ backendModel, blueprintInfo, isLocked, limitedVersionInfo, locationInfo, lockInfo, metadata, metadataSchema, ...identifiableObjectArgs }: RepositoryLocalObjectConstructorArgs);
3448
3565
  get blueprintInfo(): BlueprintInfo | undefined;
3449
3566
  /**
3450
3567
  * Whether the object is published in the context Publication.
@@ -3473,6 +3590,7 @@ export declare interface RepositoryLocalObjectConstructorArgs extends Identifiab
3473
3590
  locationInfo: LocationInfo | undefined;
3474
3591
  lockInfo: LockInfo | undefined;
3475
3592
  isLocked: boolean;
3593
+ metadata: Record<string, any> | undefined;
3476
3594
  }
3477
3595
 
3478
3596
  export declare class ResolvedItem {
@@ -3648,7 +3766,7 @@ export declare type Right = 'none' | 'publicationAccess' | 'publicationManagemen
3648
3766
  * the presence of an enumeration member added in a later API version. Explicitly setting this value
3649
3767
  * by a client is not allowed, but client code should check it and be able to handle such cases.
3650
3768
  */
3651
- export declare type RloItemType = 'folder' | 'structureGroup' | 'schema' | 'component' | 'componentTemplate' | 'page' | 'pageTemplate' | 'targetGroup' | 'category' | 'keyword' | 'templateBuildingBlock' | 'virtualFolder' | 'unknownByClient';
3769
+ export declare type RloItemType = 'all' | 'business-process-type' | 'category' | 'component' | 'componentTemplate' | 'folder' | 'keyword' | 'page' | 'pageTemplate' | 'process-definition' | 'schema' | 'structureGroup' | 'targetGroup' | 'templateBuildingBlock' | 'virtualFolder' | 'unknownByClient';
3652
3770
 
3653
3771
  /**
3654
3772
  * Schema defines structure of content and/or metadata.
@@ -3922,6 +4040,65 @@ export declare interface StructureGroupConstructorArgs extends OrganizationalIte
3922
4040
 
3923
4041
  export declare type StructureResolveOption = 'onlyItems' | 'onlyStructure' | 'itemsAndStructure' | 'unknownByClient';
3924
4042
 
4043
+ export declare class SynchronizationAction {
4044
+ protected _backendModel: SynchronizationAction_2;
4045
+ private _synchronizationActionApplied;
4046
+ constructor({ backendModel, synchronizationActionApplied }: SynchronizationActionConstructorArgs);
4047
+ /**
4048
+ * Description/label of the field on which the synchronization operation was applied.
4049
+ * For the following operation the value of this property is null.
4050
+ * "SynchronizeFlags.UpdateRegions"
4051
+ */
4052
+ get fieldDescription(): string | undefined;
4053
+ /**
4054
+ * Index of a multivalued field in which the synchronization operation was applied.
4055
+ * For the following operation the value of this property is null, as it is not applicable as these
4056
+ * operations are done on fields not individual field value or the the collection of fields.
4057
+ */
4058
+ get fieldIndex(): number | undefined;
4059
+ /**
4060
+ * XML name of the field on which the synchronization operation was applied.
4061
+ * FieldName contains name of the original region that was changed in case "SynchronizeFlags.UpdateRegions" flag is used.
4062
+ *
4063
+ */
4064
+ get fieldName(): string | undefined;
4065
+ /**
4066
+ * The synchronization operation applied.
4067
+ */
4068
+ get synchronizationActionApplied(): ReadonlyArray<SynchronizeFlags> | undefined;
4069
+ hasSynchronizationActionApplied: (synchronizationAction: SynchronizeFlags) => boolean;
4070
+ getInternalModel: () => SynchronizationAction_2;
4071
+ }
4072
+
4073
+ export declare interface SynchronizationActionConstructorArgs {
4074
+ backendModel: SynchronizationAction_2;
4075
+ synchronizationActionApplied: ReadonlyArray<SynchronizeFlags> | undefined;
4076
+ }
4077
+
4078
+ export declare class SynchronizationResult {
4079
+ protected _backendModel: SynchronizationResult_2;
4080
+ private _synchronizationActions;
4081
+ private _synchronizedItem;
4082
+ constructor({ backendModel, synchronizationActions, synchronizedItem }: SynchronizationResultConstructorArgs);
4083
+ /**
4084
+ * Collection of `SynchronizationAction` objects containing all applied changes.
4085
+ */
4086
+ get synchronizationActions(): ReadonlyArray<SynchronizationAction> | undefined;
4087
+ /**
4088
+ * The `IdentifiableObject` with synchronized content and/or metadata.
4089
+ */
4090
+ get synchronizedItem(): IdentifiableObject | undefined;
4091
+ getInternalModel: () => SynchronizationResult_2;
4092
+ }
4093
+
4094
+ export declare interface SynchronizationResultConstructorArgs {
4095
+ backendModel: SynchronizationResult_2;
4096
+ synchronizedItem: IdentifiableObject | undefined;
4097
+ synchronizationActions: ReadonlyArray<SynchronizationAction> | undefined;
4098
+ }
4099
+
4100
+ export declare type SynchronizeFlags = 'basic' | 'fixNamespace' | 'removeUnknownFields' | 'removeAdditionalValues' | 'applyDefaultValuesForMissingMandatoryFields' | 'applyDefaultValuesForMissingNonMandatoryFields' | 'applyFilterXsltToXhtmlFields' | 'convertFieldType' | 'updateRegions' | 'syncNonLocalizableFields' | 'syncNonLocalizableRegions' | 'all' | 'unknownByClient';
4101
+
3925
4102
  /**
3926
4103
  * Represents a system-wide privilege.
3927
4104
  */
@@ -3953,7 +4130,7 @@ export declare type SystemPrivilegesDictionary = Record<SystemPrivilegeName, Rea
3953
4130
  /**
3954
4131
  * Abstract base class for the data of all system-wide objects.
3955
4132
  */
3956
- export declare abstract class SystemWideObject extends IdentifiableObject {
4133
+ export declare abstract class SystemWideObject<TListInfo extends ListInfoDictionary = ListInfoDictionary> extends IdentifiableObject<TListInfo> {
3957
4134
  protected _backendModel: SystemWideObject_2;
3958
4135
  constructor(systemWideObjectArgs: SystemWideObjectConstructorArgs);
3959
4136
  getInternalModel: () => SystemWideObject_2;
@@ -5343,6 +5520,18 @@ export declare interface UserRuntimeInfoConstructorArgs {
5343
5520
  locale: UserLocaleInfo | undefined;
5344
5521
  }
5345
5522
 
5523
+ export declare class ValidationApiError extends ApiError {
5524
+ protected _backendModel: BackendValidationApiError;
5525
+ private _validationWarnings;
5526
+ private _validationErrors;
5527
+ constructor(backendModel: BackendValidationApiError);
5528
+ get validationWarnings(): ValidationWarning[];
5529
+ get validationErrors(): ValidationError[];
5530
+ get hasErrors(): boolean;
5531
+ get hasWarnings(): boolean;
5532
+ getInternalModel(): ApiError_2;
5533
+ }
5534
+
5346
5535
  /**
5347
5536
  * Represents a validation error which is returned when validating an item.
5348
5537
  */
@@ -5479,6 +5668,37 @@ export declare class VirtualUri {
5479
5668
 
5480
5669
  export declare type VirtualUriItemType = 'businessProcessTypes' | 'taxonomies';
5481
5670
 
5671
+ /**
5672
+ * Kind of relationship between this item and used item
5673
+ *
5674
+ * Members:
5675
+ * * `parentItem` - Specifies that the list item represents the (direct) BluePrint Parent Item of the given item.
5676
+ * * `localCopy` - Specifies that the list item represents a Local Copy of the given item.
5677
+ * * `onlyOldVersions` - Specifies that only old versions of the list item are referring to the given item.
5678
+ * * `onlyCheckedOutVersion` - if only the checked-out version of an item refers to the given item.
5679
+ * * `unknownByClient` -
5680
+ * Special reserved value used to notify a legacy client about receiving an enumeration value added in a newer version of the service.
5681
+ * Explicitly setting this value by a client is not allowed (it can only be set internally by the service), but client code should check it and be able to handle such cases.
5682
+ *
5683
+ *
5684
+ */
5685
+ export declare type WhereUsedCommentToken = 'parentItem' | 'localCopy' | 'onlyOldVersions' | 'onlyCheckedOutVersion' | 'unknownByClient';
5686
+
5687
+ export declare class WhereUsedListInfo {
5688
+ protected _backendModel: WhereUsedListInfo_2;
5689
+ private _commentToken;
5690
+ constructor({ backendModel, commentToken }: WhereUsedListInfoConstructorArgs);
5691
+ get versions(): ReadonlyArray<number>;
5692
+ get comment(): string | undefined;
5693
+ get hasOnlyOldVersions(): boolean;
5694
+ getInternalModel: () => WhereUsedListInfo_2;
5695
+ }
5696
+
5697
+ export declare interface WhereUsedListInfoConstructorArgs {
5698
+ backendModel: WhereUsedListInfo_2;
5699
+ commentToken: WhereUsedCommentToken | undefined;
5700
+ }
5701
+
5482
5702
  /**
5483
5703
  * Represents workflow-related information for items that can participate in a workflow process.
5484
5704
  */