@tridion-sites/models 2.0.0 → 2.2.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 +61 -24
- package/dist/index.d.ts +291 -10
- package/dist/index.js +1578 -697
- package/package.json +12 -11
package/CHANGELOG.md
CHANGED
|
@@ -1,49 +1,86 @@
|
|
|
1
1
|
# @tridion-sites/models
|
|
2
2
|
|
|
3
|
+
## 2.2.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- bc98a17: Add translation manager applicable actions
|
|
8
|
+
- a7a8cd6: Add `IdentifiableTranslationJob`, `TmUri` models
|
|
9
|
+
- 68fd3dc: Add `translationJob` item type
|
|
10
|
+
- 77cdc6c: Add `TranslationResolvedItem` model
|
|
11
|
+
- a4fda02: Add `tcm:finishprocess` action
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- c8abfb1: Fix TM error translation job uri mapping
|
|
16
|
+
- Updated dependencies [482b9d1], [77cdc6c], [cf7b3ba]
|
|
17
|
+
- @tridion-sites/open-api-client@4.2.0
|
|
18
|
+
|
|
19
|
+
## 2.1.0
|
|
20
|
+
|
|
21
|
+
### Minor Changes
|
|
22
|
+
|
|
23
|
+
- dc46fe7: Update ECL regular expression
|
|
24
|
+
- 9ca3137: Add schemaPurposeMapping
|
|
25
|
+
- 6a7856d: Expose uri prefix
|
|
26
|
+
- dce5ac7: Add `VersionedItem.isHistoricalVersion`, add `RepositoryLocalObject.hasLockType()` and fix some typos
|
|
27
|
+
- 3c68243: Add SearchBlueprintStatus model
|
|
28
|
+
|
|
29
|
+
### Patch Changes
|
|
30
|
+
|
|
31
|
+
- Updated dependencies [553decf]
|
|
32
|
+
- @tridion-sites/open-api-client@4.1.0
|
|
33
|
+
|
|
34
|
+
## 2.0.1
|
|
35
|
+
|
|
36
|
+
### Patch Changes
|
|
37
|
+
|
|
38
|
+
- Fix bug in mapToModel()
|
|
39
|
+
|
|
3
40
|
## 2.0.0
|
|
4
41
|
|
|
5
42
|
### Major Changes
|
|
6
43
|
|
|
7
|
-
-
|
|
44
|
+
- 051b91a: [Breaking!] Models: map `Link`s inside content and metadata
|
|
8
45
|
|
|
9
46
|
### Minor Changes
|
|
10
47
|
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
48
|
+
- c7a65bc: Update model mapper to fallback to regular component when it can not be distinguished by `ComponentType`
|
|
49
|
+
- 7cf79a9: OpenAPI v3 update
|
|
50
|
+
- d56f8fa: Add `isLocalizable` field
|
|
51
|
+
- 6ff5e58: Add generic `ListInfo` type to `IdentifiableObject`
|
|
52
|
+
- c3ba102: Add `primaryItem` to `ItemBlueprintHierarchy`
|
|
53
|
+
- e514a9a: Add new OpenAPI v3 error type `ValidationApiError`
|
|
17
54
|
|
|
18
55
|
### Patch Changes
|
|
19
56
|
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
57
|
+
- f1bb40c: Update API comments
|
|
58
|
+
- 1b0165e: Update axios to avoid vulnerability
|
|
59
|
+
- 2532518: Fix default value for `ItemFieldDefinition.isLocalizable` model
|
|
60
|
+
- b4d732a: Update `@tridion/graphene` dependency
|
|
61
|
+
- f1bb40c: Update 3rd party dependencies
|
|
25
62
|
|
|
26
63
|
## 1.1.1
|
|
27
64
|
|
|
28
65
|
### Patch Changes
|
|
29
66
|
|
|
30
|
-
-
|
|
67
|
+
- c78d191530: Resolved issue with TranslationJobItem mapping
|
|
31
68
|
|
|
32
69
|
## 1.1.0
|
|
33
70
|
|
|
34
71
|
### Minor Changes
|
|
35
72
|
|
|
36
|
-
-
|
|
73
|
+
- 14288f4588: add publishing queue related models
|
|
37
74
|
|
|
38
75
|
### Patch Changes
|
|
39
76
|
|
|
40
|
-
-
|
|
41
|
-
-
|
|
42
|
-
-
|
|
43
|
-
-
|
|
44
|
-
-
|
|
45
|
-
-
|
|
46
|
-
-
|
|
47
|
-
-
|
|
48
|
-
-
|
|
49
|
-
-
|
|
77
|
+
- d0875fe171: update dependencies
|
|
78
|
+
- 7ff24d55b8: Add LockType and its mapping function
|
|
79
|
+
- 334d76210f: Dependency update @tridion/graphene@1.35
|
|
80
|
+
- Updated dependencies [d398729dce]
|
|
81
|
+
- Updated dependencies [b37272386a]
|
|
82
|
+
- Updated dependencies [d0875fe171]
|
|
83
|
+
- Updated dependencies [151fa1d3b2]
|
|
84
|
+
- Updated dependencies [c75025f64f]
|
|
85
|
+
- Updated dependencies [1b257d330c]
|
|
86
|
+
- @tridion-sites/open-api-client@3.0.0
|
package/dist/index.d.ts
CHANGED
|
@@ -104,6 +104,7 @@ import type { PublishTransactionsCreationResult as PublishTransactionsCreationRe
|
|
|
104
104
|
import { PublishTransactionState as PublishTransactionState_2 } from '@tridion-sites/open-api-client';
|
|
105
105
|
import type { PublishUrlInfo as PublishUrlInfo_2 } from '@tridion-sites/open-api-client';
|
|
106
106
|
import type { Region as Region_2 } from '@tridion-sites/open-api-client';
|
|
107
|
+
import type { RenderedItem as RenderedItem_2 } from '@tridion-sites/open-api-client';
|
|
107
108
|
import type { Repository as Repository_2 } from '@tridion-sites/open-api-client';
|
|
108
109
|
import type { RepositoryLocalObject as RepositoryLocalObject_2 } from '@tridion-sites/open-api-client';
|
|
109
110
|
import type { ResolvedItem as ResolvedItem_2 } from '@tridion-sites/open-api-client';
|
|
@@ -112,8 +113,11 @@ import type { ResolveInstructionBase as ResolveInstructionBase_2 } from '@tridio
|
|
|
112
113
|
import { RetrieveReason as RetrieveReason_2 } from '@tridion-sites/open-api-client';
|
|
113
114
|
import { RLOItemType } from '@tridion-sites/open-api-client';
|
|
114
115
|
import type { Schema as Schema_2 } from '@tridion-sites/open-api-client';
|
|
116
|
+
import { SchemaPurpose as SchemaPurpose_2 } from '@tridion-sites/open-api-client';
|
|
117
|
+
import { SearchBlueprintStatus as SearchBlueprintStatus_2 } from '@tridion-sites/open-api-client';
|
|
115
118
|
import type { SearchFolder as SearchFolder_2 } from '@tridion-sites/open-api-client';
|
|
116
119
|
import type { SecurityDescriptor as SecurityDescriptor_2 } from '@tridion-sites/open-api-client';
|
|
120
|
+
import type { Settings as Settings_2 } from '@tridion-sites/open-api-client';
|
|
117
121
|
import type { SingleLineTextFieldDefinition as SingleLineTextFieldDefinition_2 } from '@tridion-sites/open-api-client';
|
|
118
122
|
import type { SingleLineTextListDefinition as SingleLineTextListDefinition_2 } from '@tridion-sites/open-api-client';
|
|
119
123
|
import { StringSearchMode as StringSearchMode_2 } from '@tridion-sites/open-api-client';
|
|
@@ -132,6 +136,7 @@ import type { TargetType as TargetType_2 } from '@tridion-sites/open-api-client'
|
|
|
132
136
|
import type { Template as Template_2 } from '@tridion-sites/open-api-client';
|
|
133
137
|
import type { TemplateBuildingBlock as TemplateBuildingBlock_2 } from '@tridion-sites/open-api-client';
|
|
134
138
|
import type { TextFieldDefinition as TextFieldDefinition_2 } from '@tridion-sites/open-api-client';
|
|
139
|
+
import type { TmResolvedItem } from '@tridion-sites/open-api-client';
|
|
135
140
|
import type { TmsLanguage as TmsLanguage_2 } from '@tridion-sites/open-api-client';
|
|
136
141
|
import type { TmsWorkflow as TmsWorkflow_2 } from '@tridion-sites/open-api-client';
|
|
137
142
|
import type { TmsWorkflowStep as TmsWorkflowStep_2 } from '@tridion-sites/open-api-client';
|
|
@@ -438,7 +443,7 @@ export declare class ActivityInstance extends Activity {
|
|
|
438
443
|
private _approvalStatus;
|
|
439
444
|
private _processDefinition;
|
|
440
445
|
private _workflowType;
|
|
441
|
-
constructor({ backendModel, activityConstraints, activityDefinition, activityState, approvalStatus, processDefinition, workflowType, ...
|
|
446
|
+
constructor({ backendModel, activityConstraints, activityDefinition, activityState, approvalStatus, processDefinition, workflowType, ...activityArgs }: ActivityInstanceConstructorArgs);
|
|
442
447
|
/**
|
|
443
448
|
* Constraints of this activity.
|
|
444
449
|
*/
|
|
@@ -568,9 +573,16 @@ export declare const applicableActions: {
|
|
|
568
573
|
assignActivity: string;
|
|
569
574
|
startActivity: string;
|
|
570
575
|
finishActivity: string;
|
|
576
|
+
finishProcess: string;
|
|
571
577
|
restartActivity: string;
|
|
572
578
|
pushTranslation: string;
|
|
573
579
|
pullTranslation: string;
|
|
580
|
+
deleteTranslation: string;
|
|
581
|
+
retryTranslation: string;
|
|
582
|
+
viewTranslation: string;
|
|
583
|
+
editTranslation: string;
|
|
584
|
+
copyTranslation: string;
|
|
585
|
+
sendTranslation: string;
|
|
574
586
|
};
|
|
575
587
|
|
|
576
588
|
export declare class ApprovalStatus extends SystemWideObject {
|
|
@@ -596,6 +608,8 @@ export declare class ApprovalStatus extends SystemWideObject {
|
|
|
596
608
|
export declare interface ApprovalStatusConstructorArgs extends SystemWideObjectConstructorArgs {
|
|
597
609
|
}
|
|
598
610
|
|
|
611
|
+
export declare type BackendIdentifiableTranslationJob = IdentifiableObject_2 & Omit<TranslationJob_2, 'Id'>;
|
|
612
|
+
|
|
599
613
|
export declare interface BackendValidationApiError extends ApiError_2 {
|
|
600
614
|
body: BackendValidationApiErrorBody;
|
|
601
615
|
}
|
|
@@ -1474,7 +1488,7 @@ export declare interface DynamicVersionInfoConstructorArgs {
|
|
|
1474
1488
|
revisionDate: Date | undefined;
|
|
1475
1489
|
}
|
|
1476
1490
|
|
|
1477
|
-
export declare class EclUri {
|
|
1491
|
+
export declare class EclUri implements Uri {
|
|
1478
1492
|
/**
|
|
1479
1493
|
* Id of the Tridion Publication this EclUri belongs to.
|
|
1480
1494
|
*/
|
|
@@ -1504,8 +1518,10 @@ export declare class EclUri {
|
|
|
1504
1518
|
private readonly _itemVersion?;
|
|
1505
1519
|
private readonly _asString;
|
|
1506
1520
|
private static _eclUriCache;
|
|
1521
|
+
private static _eclUriPrefix;
|
|
1507
1522
|
private static _eclUriRegExp;
|
|
1508
1523
|
private constructor();
|
|
1524
|
+
static get uriPrefix(): string;
|
|
1509
1525
|
private static create;
|
|
1510
1526
|
static parse: (input: string) => EclUri | undefined;
|
|
1511
1527
|
get publicationId(): number;
|
|
@@ -1991,6 +2007,147 @@ export declare interface IdentifiableObjectConstructorArgs {
|
|
|
1991
2007
|
securityDescriptor: SecurityDescriptor | undefined;
|
|
1992
2008
|
}
|
|
1993
2009
|
|
|
2010
|
+
/**
|
|
2011
|
+
* `TranslationJob` class that extends `IdentifiableObject`, that uses `ItemUri` instead of number as an id.
|
|
2012
|
+
*
|
|
2013
|
+
* @note
|
|
2014
|
+
* Please note that the rest of `IdentifiableObject` props will be undefined always.
|
|
2015
|
+
*
|
|
2016
|
+
* To get original object use `getOriginalInternalModel()`, as `getInternalModel()` result will include `Id` in a format `tm:0-1234`.
|
|
2017
|
+
*
|
|
2018
|
+
* @example
|
|
2019
|
+
* TranslationJob.id: number | undefined;
|
|
2020
|
+
* IdentifiableTranslationJob.id: ItemUri;
|
|
2021
|
+
*/
|
|
2022
|
+
export declare class IdentifiableTranslationJob extends IdentifiableObject {
|
|
2023
|
+
protected _backendModel: BackendIdentifiableTranslationJob;
|
|
2024
|
+
private _addedItems;
|
|
2025
|
+
private _creator;
|
|
2026
|
+
private _configurationItemUri;
|
|
2027
|
+
private _displayState;
|
|
2028
|
+
private _errors;
|
|
2029
|
+
private _errorSeverityLevel;
|
|
2030
|
+
private _language;
|
|
2031
|
+
private _priority;
|
|
2032
|
+
private _revisor;
|
|
2033
|
+
private _state;
|
|
2034
|
+
private _targetLanguages;
|
|
2035
|
+
private _type;
|
|
2036
|
+
private _workflowStatus;
|
|
2037
|
+
private _creationDate;
|
|
2038
|
+
private _requiredDate;
|
|
2039
|
+
private _revisionDate;
|
|
2040
|
+
private _contextRepository;
|
|
2041
|
+
constructor({ addedItems, backendModel, configurationItemUri, creationDate, creator, displayState, errors, errorSeverityLevel, language, priority, requiredDate, revisionDate, revisor, state, targetLanguages, type, workflowStatus, contextRepository, ...identifiableObjectArgs }: IdentifiableTranslationJobConstructorArgs);
|
|
2042
|
+
get title(): string | undefined;
|
|
2043
|
+
/**
|
|
2044
|
+
* Collection containing the `AddedItem`s that have been added to this Translation Job.
|
|
2045
|
+
* The `AddedItem`s represent either an Item that will be translated (for example a Component) or
|
|
2046
|
+
* an Item that contains the Items that will be translated (for example a Folder).
|
|
2047
|
+
*/
|
|
2048
|
+
get addedItems(): ReadonlyArray<TranslationJobItem> | undefined;
|
|
2049
|
+
/**
|
|
2050
|
+
* TCM URI of the item containing the `TranslationConfiguration` used for this Translation Job.
|
|
2051
|
+
*/
|
|
2052
|
+
get configurationItemUri(): ItemUri | undefined;
|
|
2053
|
+
/**
|
|
2054
|
+
* Link to the Context Repository.
|
|
2055
|
+
*/
|
|
2056
|
+
get contextRepository(): Link | undefined;
|
|
2057
|
+
/**
|
|
2058
|
+
* The date the Translation Job was created (in UTC).
|
|
2059
|
+
*/
|
|
2060
|
+
get creationDate(): Date | undefined;
|
|
2061
|
+
/**
|
|
2062
|
+
* A link to the user who created the Translation Job.
|
|
2063
|
+
*/
|
|
2064
|
+
get creator(): Link | undefined;
|
|
2065
|
+
get displayState(): TranslationJobDisplayState | undefined;
|
|
2066
|
+
/**
|
|
2067
|
+
* Collection of errors registered to this job.
|
|
2068
|
+
*/
|
|
2069
|
+
get errors(): ReadonlyArray<TranslationErrorDetails> | undefined;
|
|
2070
|
+
get errorSeverityLevel(): TranslationErrorSeverity | undefined;
|
|
2071
|
+
get hasError(): boolean;
|
|
2072
|
+
/**
|
|
2073
|
+
* Value indicating whether items that have already been translated should be included in the job.
|
|
2074
|
+
*/
|
|
2075
|
+
get includeItemsAlreadyTranslated(): boolean;
|
|
2076
|
+
/**
|
|
2077
|
+
* Value indicating if the Translation Job currently have one or more `TranslationJobQuote`s awaiting authorization (see remarks).
|
|
2078
|
+
*/
|
|
2079
|
+
get isAwaitingAuthorization(): boolean;
|
|
2080
|
+
get language(): TmsLanguage | undefined;
|
|
2081
|
+
/**
|
|
2082
|
+
* Metadata associated with the Translation Job.
|
|
2083
|
+
*/
|
|
2084
|
+
get metadata(): FieldsValueDictionary | undefined;
|
|
2085
|
+
/**
|
|
2086
|
+
* TCM URI of the metadata schema used for this Translation Job.
|
|
2087
|
+
*/
|
|
2088
|
+
get metadataSchemaUri(): string | undefined;
|
|
2089
|
+
/**
|
|
2090
|
+
* The priority of the Translation Job. This value will only have an affect if `SupportsPriority` returns true.
|
|
2091
|
+
*/
|
|
2092
|
+
get priority(): TranslationJobPriority | undefined;
|
|
2093
|
+
get progressPercentage(): number | undefined;
|
|
2094
|
+
/**
|
|
2095
|
+
* The due date for this job.
|
|
2096
|
+
*/
|
|
2097
|
+
get requiredDate(): Date | undefined;
|
|
2098
|
+
get revisionDate(): Date | undefined;
|
|
2099
|
+
/**
|
|
2100
|
+
* A link to the user who last modified the Translation Job.
|
|
2101
|
+
*/
|
|
2102
|
+
get revisor(): Link | undefined;
|
|
2103
|
+
get state(): TranslationJobState | undefined;
|
|
2104
|
+
/**
|
|
2105
|
+
* Show if `TranslationJob` support setting of priority.
|
|
2106
|
+
*/
|
|
2107
|
+
get supportsPriority(): boolean;
|
|
2108
|
+
/**
|
|
2109
|
+
* Show if `TranslationJob` support setting required rate.
|
|
2110
|
+
*/
|
|
2111
|
+
get supportsRequiredDate(): boolean;
|
|
2112
|
+
/**
|
|
2113
|
+
* List of target languages available for this `TranslationJob`.
|
|
2114
|
+
*/
|
|
2115
|
+
get targetLanguages(): ReadonlyArray<TargetLanguage> | undefined;
|
|
2116
|
+
/**
|
|
2117
|
+
* Value indicating if the Translation Job is a translation to the Publication of the `ConfigurationItemUri`
|
|
2118
|
+
* (Pull job) or from the Publication (Push job).
|
|
2119
|
+
*/
|
|
2120
|
+
get type(): ReadonlyArray<TranslationJobType> | undefined;
|
|
2121
|
+
/**
|
|
2122
|
+
* Item count of language/workflowstep pairs.
|
|
2123
|
+
*/
|
|
2124
|
+
get workflowStatus(): ReadonlyArray<TranslationWorkflowStatus> | undefined;
|
|
2125
|
+
getOriginalInternalModel: () => TranslationJob_2;
|
|
2126
|
+
getInternalModel: () => BackendIdentifiableTranslationJob;
|
|
2127
|
+
}
|
|
2128
|
+
|
|
2129
|
+
export declare interface IdentifiableTranslationJobConstructorArgs extends IdentifiableObjectConstructorArgs {
|
|
2130
|
+
backendModel: BackendIdentifiableTranslationJob;
|
|
2131
|
+
id: ItemUri;
|
|
2132
|
+
addedItems: ReadonlyArray<TranslationJobItem> | undefined;
|
|
2133
|
+
configurationItemUri: ItemUri | undefined;
|
|
2134
|
+
creationDate: Date | undefined;
|
|
2135
|
+
creator: Link | undefined;
|
|
2136
|
+
displayState: TranslationJobDisplayState | undefined;
|
|
2137
|
+
errors: ReadonlyArray<TranslationErrorDetails> | undefined;
|
|
2138
|
+
errorSeverityLevel: TranslationErrorSeverity | undefined;
|
|
2139
|
+
language: TmsLanguage | undefined;
|
|
2140
|
+
priority: TranslationJobPriority | undefined;
|
|
2141
|
+
requiredDate: Date | undefined;
|
|
2142
|
+
revisionDate: Date | undefined;
|
|
2143
|
+
revisor: Link | undefined;
|
|
2144
|
+
state: TranslationJobState | undefined;
|
|
2145
|
+
targetLanguages: ReadonlyArray<TargetLanguage> | undefined;
|
|
2146
|
+
type: ReadonlyArray<TranslationJobType> | undefined;
|
|
2147
|
+
workflowStatus: ReadonlyArray<TranslationWorkflowStatus> | undefined;
|
|
2148
|
+
contextRepository: Link | undefined;
|
|
2149
|
+
}
|
|
2150
|
+
|
|
1994
2151
|
export declare const isRloNode: (node: ItemBlueprintNode) => node is BlueprintReadonlyGraphNode<ReadonlyItemBlueprintRloNodeData>;
|
|
1995
2152
|
|
|
1996
2153
|
export declare class ItemBlueprintHierarchy {
|
|
@@ -2090,6 +2247,7 @@ export declare const itemLinkType: {
|
|
|
2090
2247
|
activityInstance: "activityInstance";
|
|
2091
2248
|
businessProcessTypes: "businessProcessTypes";
|
|
2092
2249
|
taxonomies: "taxonomies";
|
|
2250
|
+
translationJob: "translationJob";
|
|
2093
2251
|
externalFolder: "externalFolder";
|
|
2094
2252
|
externalKeyword: "externalKeyword";
|
|
2095
2253
|
externalKeywordCategory: "externalKeywordCategory";
|
|
@@ -2099,7 +2257,7 @@ export declare const itemLinkType: {
|
|
|
2099
2257
|
userGroup: "userGroup";
|
|
2100
2258
|
};
|
|
2101
2259
|
|
|
2102
|
-
export declare const itemLinkTypes: readonly ["activityInstance", "businessProcessType", "businessProcessTypes", "component", "componentTemplate", "externalFolder", "externalKeyword", "externalKeywordCategory", "externalMountpoint", "externalMultimediaComponent", "folder", "keyword", "keywordCategory", "multimediaType", "page", "pageTemplate", "processDefinition", "processHistory", "processInstance", "publication", "schema", "structureGroup", "targetGroup", "taxonomies", "templateBuildingBlock", "user", "userGroup", "virtualFolder"];
|
|
2260
|
+
export declare const itemLinkTypes: readonly ["activityInstance", "businessProcessType", "businessProcessTypes", "component", "componentTemplate", "externalFolder", "externalKeyword", "externalKeywordCategory", "externalMountpoint", "externalMultimediaComponent", "folder", "keyword", "keywordCategory", "multimediaType", "page", "pageTemplate", "processDefinition", "processHistory", "processInstance", "publication", "schema", "structureGroup", "targetGroup", "taxonomies", "templateBuildingBlock", "user", "userGroup", "virtualFolder", "translationJob"];
|
|
2103
2261
|
|
|
2104
2262
|
/**
|
|
2105
2263
|
* Abstract base class for Item Field Definitions for the field types that can be published.
|
|
@@ -2142,6 +2300,7 @@ export declare const itemType: {
|
|
|
2142
2300
|
activityInstance: "activityInstance";
|
|
2143
2301
|
businessProcessTypes: "businessProcessTypes";
|
|
2144
2302
|
taxonomies: "taxonomies";
|
|
2303
|
+
translationJob: "translationJob";
|
|
2145
2304
|
bundle: "bundle";
|
|
2146
2305
|
externalFolder: "externalFolder";
|
|
2147
2306
|
externalKeyword: "externalKeyword";
|
|
@@ -2157,9 +2316,9 @@ export declare const itemType: {
|
|
|
2157
2316
|
searchFolder: "searchFolder";
|
|
2158
2317
|
};
|
|
2159
2318
|
|
|
2160
|
-
export declare const itemTypes: readonly ["activityInstance", "businessProcessType", "businessProcessTypes", "component", "componentTemplate", "externalFolder", "externalKeyword", "externalKeywordCategory", "externalMountpoint", "externalMultimediaComponent", "folder", "keyword", "keywordCategory", "multimediaType", "page", "pageTemplate", "processDefinition", "processHistory", "processInstance", "publication", "schema", "structureGroup", "targetGroup", "taxonomies", "templateBuildingBlock", "user", "userGroup", "virtualFolder", "abstractExternalKeyword", "abstractKeyword", "bundle", "multimediaComponent", "multimediaSchema", "searchFolder"];
|
|
2319
|
+
export declare const itemTypes: readonly ["activityInstance", "businessProcessType", "businessProcessTypes", "component", "componentTemplate", "externalFolder", "externalKeyword", "externalKeywordCategory", "externalMountpoint", "externalMultimediaComponent", "folder", "keyword", "keywordCategory", "multimediaType", "page", "pageTemplate", "processDefinition", "processHistory", "processInstance", "publication", "schema", "structureGroup", "targetGroup", "taxonomies", "templateBuildingBlock", "user", "userGroup", "virtualFolder", "translationJob", "abstractExternalKeyword", "abstractKeyword", "bundle", "multimediaComponent", "multimediaSchema", "searchFolder"];
|
|
2161
2320
|
|
|
2162
|
-
export declare type ItemUri = TcmUri | EclUri | VirtualUri;
|
|
2321
|
+
export declare type ItemUri = TcmUri | EclUri | VirtualUri | TmUri;
|
|
2163
2322
|
|
|
2164
2323
|
/**
|
|
2165
2324
|
* Represents the data of a Keyword used to classify items.
|
|
@@ -2524,6 +2683,7 @@ export declare class LockInfo {
|
|
|
2524
2683
|
* A user who locked the item.
|
|
2525
2684
|
*/
|
|
2526
2685
|
get lockUser(): Link | undefined;
|
|
2686
|
+
hasLockType(lockType: LockType): boolean;
|
|
2527
2687
|
getInternalModel: () => LockInfo_2;
|
|
2528
2688
|
}
|
|
2529
2689
|
|
|
@@ -2570,6 +2730,12 @@ export declare const mapRetrieveReasonToBackend: (backendModel: RetrieveReason)
|
|
|
2570
2730
|
|
|
2571
2731
|
export declare const mapRloItemTypeToBackend: (rloItemType: RloItemType) => RLOItemType;
|
|
2572
2732
|
|
|
2733
|
+
export declare const mapSchemaPurposeBackend: (backendModel: SchemaPurpose) => SchemaPurpose_2;
|
|
2734
|
+
|
|
2735
|
+
export declare const mapSearchBlueprintStatus: (backendModel: SearchBlueprintStatus_2) => SearchBlueprintStatus;
|
|
2736
|
+
|
|
2737
|
+
export declare const mapSearchBlueprintStatusToBackend: (model: SearchBlueprintStatus) => SearchBlueprintStatus_2;
|
|
2738
|
+
|
|
2573
2739
|
export declare const mapStringSearchModeToBackend: (backendModel: StringSearchMode) => StringSearchMode_2;
|
|
2574
2740
|
|
|
2575
2741
|
export declare const mapStructureResolveOptionToBackend: (model: StructureResolveOption) => StructureResolveOption_2;
|
|
@@ -3497,6 +3663,36 @@ export declare abstract class Region {
|
|
|
3497
3663
|
getInternalModel: () => Region_2;
|
|
3498
3664
|
}
|
|
3499
3665
|
|
|
3666
|
+
export declare class RenderedItem {
|
|
3667
|
+
protected _backendModel: RenderedItem_2;
|
|
3668
|
+
private _item;
|
|
3669
|
+
private _template;
|
|
3670
|
+
constructor({ backendModel, item, template }: RenderedItemConstructorArgs);
|
|
3671
|
+
/**
|
|
3672
|
+
* Gets the data pipeline JSON (if any)
|
|
3673
|
+
*/
|
|
3674
|
+
get dataPipelineJson(): string | undefined;
|
|
3675
|
+
/**
|
|
3676
|
+
* Gets a link to the item that was rendered.
|
|
3677
|
+
*/
|
|
3678
|
+
get item(): Link | undefined;
|
|
3679
|
+
/**
|
|
3680
|
+
* Gets the rendered output of the template (if any)
|
|
3681
|
+
*/
|
|
3682
|
+
get renderedOutput(): string | undefined;
|
|
3683
|
+
/**
|
|
3684
|
+
* Gets a link to the template with which the item was rendered (if any).
|
|
3685
|
+
*/
|
|
3686
|
+
get template(): Link | undefined;
|
|
3687
|
+
getInternalModel: () => RenderedItem_2;
|
|
3688
|
+
}
|
|
3689
|
+
|
|
3690
|
+
export declare interface RenderedItemConstructorArgs {
|
|
3691
|
+
backendModel: RenderedItem_2;
|
|
3692
|
+
item: Link | undefined;
|
|
3693
|
+
template: Link | undefined;
|
|
3694
|
+
}
|
|
3695
|
+
|
|
3500
3696
|
/**
|
|
3501
3697
|
* Represents a Repository: a context for BluePrinting.
|
|
3502
3698
|
*/
|
|
@@ -3849,6 +4045,8 @@ export declare interface SchemaConstructorArgs extends VersionedItemConstructorA
|
|
|
3849
4045
|
*/
|
|
3850
4046
|
export declare type SchemaPurpose = 'component' | 'multimedia' | 'embedded' | 'metadata' | 'protocol' | 'virtualFolderType' | 'templateParameters' | 'bundle' | 'region' | 'unknownByClient';
|
|
3851
4047
|
|
|
4048
|
+
export declare type SearchBlueprintStatus = 'unspecified' | 'local' | 'localized' | 'shared' | 'unknownByClient';
|
|
4049
|
+
|
|
3852
4050
|
/**
|
|
3853
4051
|
* Represents a Search Folder.
|
|
3854
4052
|
*/
|
|
@@ -3900,6 +4098,19 @@ export declare interface SecurityDescriptorConstructorArgs {
|
|
|
3900
4098
|
rights: ReadonlyArray<Right> | undefined;
|
|
3901
4099
|
}
|
|
3902
4100
|
|
|
4101
|
+
export declare class Settings<TData extends Record<string, any>> {
|
|
4102
|
+
protected _backendModel: Settings_2;
|
|
4103
|
+
private _data;
|
|
4104
|
+
constructor({ backendModel, data }: SettingsConstructorArgs<TData>);
|
|
4105
|
+
get data(): TData | undefined;
|
|
4106
|
+
getInternalModel: () => Settings_2;
|
|
4107
|
+
}
|
|
4108
|
+
|
|
4109
|
+
export declare interface SettingsConstructorArgs<TData> {
|
|
4110
|
+
backendModel: Settings_2;
|
|
4111
|
+
data: TData | undefined;
|
|
4112
|
+
}
|
|
4113
|
+
|
|
3903
4114
|
/**
|
|
3904
4115
|
* Represents a single-line text field definition (in a Schema).
|
|
3905
4116
|
*/
|
|
@@ -4297,16 +4508,18 @@ export declare interface TaxonomiesConstructorArgs extends OrganizationalItemCon
|
|
|
4297
4508
|
*
|
|
4298
4509
|
* The structure of a TCM URI is PublicationID-ItemID[-ItemType][-vVersion].
|
|
4299
4510
|
*/
|
|
4300
|
-
export declare class TcmUri {
|
|
4511
|
+
export declare class TcmUri implements Uri {
|
|
4301
4512
|
private readonly _publicationId;
|
|
4302
4513
|
private readonly _itemId;
|
|
4303
4514
|
private readonly _itemType;
|
|
4304
4515
|
private readonly _itemVersion?;
|
|
4305
4516
|
private readonly _asString;
|
|
4306
4517
|
private static _tcmUriCache;
|
|
4518
|
+
private static _tcmUriPrefix;
|
|
4307
4519
|
private static _tcmUriRegExp;
|
|
4308
4520
|
private static _editableVersion;
|
|
4309
4521
|
private constructor();
|
|
4522
|
+
static get uriPrefix(): string;
|
|
4310
4523
|
static create: (publicationId: number, itemId: number, itemType: TcmUriItemType, itemVersion?: number) => TcmUri;
|
|
4311
4524
|
static null: TcmUri;
|
|
4312
4525
|
static system: TcmUri;
|
|
@@ -4509,6 +4722,42 @@ export declare class TmsWorkflowStep {
|
|
|
4509
4722
|
getInternalModel: () => TmsWorkflowStep_2;
|
|
4510
4723
|
}
|
|
4511
4724
|
|
|
4725
|
+
export declare class TmUri implements Uri {
|
|
4726
|
+
/**
|
|
4727
|
+
* TM-specified item id.
|
|
4728
|
+
*/
|
|
4729
|
+
private readonly _itemId;
|
|
4730
|
+
private readonly _asString;
|
|
4731
|
+
private static _tmUriCache;
|
|
4732
|
+
private static _tmUriPrefix;
|
|
4733
|
+
private static _tmUriRegExp;
|
|
4734
|
+
private constructor();
|
|
4735
|
+
static get uriPrefix(): string;
|
|
4736
|
+
static create: (itemId: number) => TmUri;
|
|
4737
|
+
static parse: (input: string) => TmUri | undefined;
|
|
4738
|
+
get itemType(): 'translationJob';
|
|
4739
|
+
get itemId(): number;
|
|
4740
|
+
get asString(): string;
|
|
4741
|
+
/**
|
|
4742
|
+
* Don't use it, will be removed later. Added to align api with other uris.
|
|
4743
|
+
*
|
|
4744
|
+
* @deprecated
|
|
4745
|
+
*/
|
|
4746
|
+
get isDynamic(): boolean;
|
|
4747
|
+
/**
|
|
4748
|
+
* Don't use it, will be removed later. Added to align api with other uris.
|
|
4749
|
+
*
|
|
4750
|
+
* @deprecated
|
|
4751
|
+
*/
|
|
4752
|
+
getPublicationUri: () => TcmUri;
|
|
4753
|
+
/**
|
|
4754
|
+
* Don't use it, will be removed later. Added to align api with other uris.
|
|
4755
|
+
*
|
|
4756
|
+
* @deprecated
|
|
4757
|
+
*/
|
|
4758
|
+
getUriInPublication: (publicationUri: TcmUri) => TmUri;
|
|
4759
|
+
}
|
|
4760
|
+
|
|
4512
4761
|
/**
|
|
4513
4762
|
* Contains information about the translation state of the Item.
|
|
4514
4763
|
*/
|
|
@@ -4735,7 +4984,8 @@ export declare class TranslationJob {
|
|
|
4735
4984
|
private _creationDate;
|
|
4736
4985
|
private _requiredDate;
|
|
4737
4986
|
private _revisionDate;
|
|
4738
|
-
|
|
4987
|
+
private _contextRepository;
|
|
4988
|
+
constructor({ addedItems, backendModel, configurationItemUri, creationDate, creator, displayState, errors, errorSeverityLevel, language, priority, requiredDate, revisionDate, revisor, state, targetLanguages, type, workflowStatus, contextRepository, }: TranslationJobConstructorArgs);
|
|
4739
4989
|
get id(): number | undefined;
|
|
4740
4990
|
get title(): string | undefined;
|
|
4741
4991
|
/**
|
|
@@ -4749,9 +4999,9 @@ export declare class TranslationJob {
|
|
|
4749
4999
|
*/
|
|
4750
5000
|
get configurationItemUri(): ItemUri | undefined;
|
|
4751
5001
|
/**
|
|
4752
|
-
*
|
|
5002
|
+
* Link to the Context Repository.
|
|
4753
5003
|
*/
|
|
4754
|
-
get
|
|
5004
|
+
get contextRepository(): Link | undefined;
|
|
4755
5005
|
/**
|
|
4756
5006
|
* The date the Translation Job was created (in UTC).
|
|
4757
5007
|
*/
|
|
@@ -4841,6 +5091,7 @@ export declare interface TranslationJobConstructorArgs {
|
|
|
4841
5091
|
targetLanguages: ReadonlyArray<TargetLanguage> | undefined;
|
|
4842
5092
|
type: ReadonlyArray<TranslationJobType> | undefined;
|
|
4843
5093
|
workflowStatus: ReadonlyArray<TranslationWorkflowStatus> | undefined;
|
|
5094
|
+
contextRepository: Link | undefined;
|
|
4844
5095
|
}
|
|
4845
5096
|
|
|
4846
5097
|
/**
|
|
@@ -5079,6 +5330,24 @@ export declare type TranslationJobState = 'canceled' | 'definition' | 'readyForT
|
|
|
5079
5330
|
*/
|
|
5080
5331
|
export declare type TranslationJobType = 'none' | 'pushJob' | 'pullJob' | 'unknownByClient';
|
|
5081
5332
|
|
|
5333
|
+
export declare class TranslationResolvedItem {
|
|
5334
|
+
protected _backendModel: TmResolvedItem;
|
|
5335
|
+
private _sourceItem;
|
|
5336
|
+
private _targetLanguages;
|
|
5337
|
+
constructor({ backendModel, sourceItem, targetLanguages }: TranslationResolvedItemConstructorArgs);
|
|
5338
|
+
get isValidForTranslation(): boolean;
|
|
5339
|
+
get comment(): string | undefined;
|
|
5340
|
+
get sourceItem(): RepositoryLocalObject | undefined;
|
|
5341
|
+
get targetLanguages(): ReadonlyArray<TargetLanguage> | undefined;
|
|
5342
|
+
getInternalModel: () => TmResolvedItem;
|
|
5343
|
+
}
|
|
5344
|
+
|
|
5345
|
+
export declare interface TranslationResolvedItemConstructorArgs {
|
|
5346
|
+
backendModel: TmResolvedItem;
|
|
5347
|
+
sourceItem: RepositoryLocalObject | undefined;
|
|
5348
|
+
targetLanguages: ReadonlyArray<TargetLanguage> | undefined;
|
|
5349
|
+
}
|
|
5350
|
+
|
|
5082
5351
|
/**
|
|
5083
5352
|
* Represents translation status of an Item.
|
|
5084
5353
|
*
|
|
@@ -5282,6 +5551,16 @@ export declare interface UnpublishInstructionConstructorArgs {
|
|
|
5282
5551
|
resolveInstruction: ResolveInstruction | undefined;
|
|
5283
5552
|
}
|
|
5284
5553
|
|
|
5554
|
+
declare abstract class Uri {
|
|
5555
|
+
abstract itemId: number | string;
|
|
5556
|
+
abstract asString: string;
|
|
5557
|
+
abstract itemType: EclUriItemType | TcmUriItemType | VirtualUriItemType | 'translationJob';
|
|
5558
|
+
abstract isDynamic: boolean;
|
|
5559
|
+
abstract getPublicationUri(): TcmUri;
|
|
5560
|
+
abstract getUriInPublication(publicationUri: TcmUri): ItemUri;
|
|
5561
|
+
static parse(backendId: string): ItemUri | undefined;
|
|
5562
|
+
}
|
|
5563
|
+
|
|
5285
5564
|
export declare class User extends Trustee {
|
|
5286
5565
|
protected _backendModel: User_2;
|
|
5287
5566
|
constructor({ backendModel, ...trusteeArgs }: UserConstructorArgs);
|
|
@@ -5603,6 +5882,7 @@ export declare abstract class VersionedItem extends RepositoryLocalObject {
|
|
|
5603
5882
|
get dynamicVersionInfo(): DynamicVersionInfo | undefined;
|
|
5604
5883
|
get versionInfo(): FullVersionInfo | undefined;
|
|
5605
5884
|
get isCurrentVersion(): boolean;
|
|
5885
|
+
get isHistoricVersion(): boolean;
|
|
5606
5886
|
getInternalModel: () => VersionedItem_2;
|
|
5607
5887
|
}
|
|
5608
5888
|
|
|
@@ -5651,7 +5931,7 @@ export declare interface VirtualFolderConstructorArgs extends OrganizationalItem
|
|
|
5651
5931
|
workflowInfo: WorkflowInfo | undefined;
|
|
5652
5932
|
}
|
|
5653
5933
|
|
|
5654
|
-
export declare class VirtualUri {
|
|
5934
|
+
export declare class VirtualUri implements Uri {
|
|
5655
5935
|
private readonly _publicationUri;
|
|
5656
5936
|
private readonly _itemType;
|
|
5657
5937
|
private readonly _asString;
|
|
@@ -5659,6 +5939,7 @@ export declare class VirtualUri {
|
|
|
5659
5939
|
private constructor();
|
|
5660
5940
|
static create: (publicationUri: TcmUri, itemType: VirtualUriItemType) => VirtualUri;
|
|
5661
5941
|
static parse: (input: string) => VirtualUri | undefined;
|
|
5942
|
+
get itemId(): string;
|
|
5662
5943
|
get itemType(): VirtualUriItemType;
|
|
5663
5944
|
get isDynamic(): boolean;
|
|
5664
5945
|
get asString(): string;
|