@tridion-sites/models 2.1.0 → 2.3.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 +22 -0
- package/dist/index.d.ts +294 -11
- package/dist/index.js +1536 -698
- package/package.json +12 -12
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
# @tridion-sites/models
|
|
2
2
|
|
|
3
|
+
## 2.3.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- c31b0c9: `@tridion-sites/extensions`, `@tridion-sites/models`: Update `@tridion/graphene` dependency to v4.0.0
|
|
8
|
+
|
|
9
|
+
## 2.2.0
|
|
10
|
+
|
|
11
|
+
### Minor Changes
|
|
12
|
+
|
|
13
|
+
- bc98a17: Add translation manager applicable actions
|
|
14
|
+
- a7a8cd6: Add `IdentifiableTranslationJob`, `TmUri` models
|
|
15
|
+
- 68fd3dc: Add `translationJob` item type
|
|
16
|
+
- 77cdc6c: Add `TranslationResolvedItem` model
|
|
17
|
+
- a4fda02: Add `tcm:finishprocess` action
|
|
18
|
+
|
|
19
|
+
### Patch Changes
|
|
20
|
+
|
|
21
|
+
- c8abfb1: Fix TM error translation job uri mapping
|
|
22
|
+
- Updated dependencies [482b9d1], [77cdc6c], [cf7b3ba]
|
|
23
|
+
- @tridion-sites/open-api-client@4.2.0
|
|
24
|
+
|
|
3
25
|
## 2.1.0
|
|
4
26
|
|
|
5
27
|
### Minor Changes
|
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';
|
|
@@ -116,6 +117,7 @@ import { SchemaPurpose as SchemaPurpose_2 } from '@tridion-sites/open-api-client
|
|
|
116
117
|
import { SearchBlueprintStatus as SearchBlueprintStatus_2 } from '@tridion-sites/open-api-client';
|
|
117
118
|
import type { SearchFolder as SearchFolder_2 } from '@tridion-sites/open-api-client';
|
|
118
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';
|
|
119
121
|
import type { SingleLineTextFieldDefinition as SingleLineTextFieldDefinition_2 } from '@tridion-sites/open-api-client';
|
|
120
122
|
import type { SingleLineTextListDefinition as SingleLineTextListDefinition_2 } from '@tridion-sites/open-api-client';
|
|
121
123
|
import { StringSearchMode as StringSearchMode_2 } from '@tridion-sites/open-api-client';
|
|
@@ -134,6 +136,7 @@ import type { TargetType as TargetType_2 } from '@tridion-sites/open-api-client'
|
|
|
134
136
|
import type { Template as Template_2 } from '@tridion-sites/open-api-client';
|
|
135
137
|
import type { TemplateBuildingBlock as TemplateBuildingBlock_2 } from '@tridion-sites/open-api-client';
|
|
136
138
|
import type { TextFieldDefinition as TextFieldDefinition_2 } from '@tridion-sites/open-api-client';
|
|
139
|
+
import type { TmResolvedItem } from '@tridion-sites/open-api-client';
|
|
137
140
|
import type { TmsLanguage as TmsLanguage_2 } from '@tridion-sites/open-api-client';
|
|
138
141
|
import type { TmsWorkflow as TmsWorkflow_2 } from '@tridion-sites/open-api-client';
|
|
139
142
|
import type { TmsWorkflowStep as TmsWorkflowStep_2 } from '@tridion-sites/open-api-client';
|
|
@@ -570,9 +573,16 @@ export declare const applicableActions: {
|
|
|
570
573
|
assignActivity: string;
|
|
571
574
|
startActivity: string;
|
|
572
575
|
finishActivity: string;
|
|
576
|
+
finishProcess: string;
|
|
573
577
|
restartActivity: string;
|
|
574
578
|
pushTranslation: string;
|
|
575
579
|
pullTranslation: string;
|
|
580
|
+
deleteTranslation: string;
|
|
581
|
+
retryTranslation: string;
|
|
582
|
+
viewTranslation: string;
|
|
583
|
+
editTranslation: string;
|
|
584
|
+
copyTranslation: string;
|
|
585
|
+
sendTranslation: string;
|
|
576
586
|
};
|
|
577
587
|
|
|
578
588
|
export declare class ApprovalStatus extends SystemWideObject {
|
|
@@ -598,6 +608,8 @@ export declare class ApprovalStatus extends SystemWideObject {
|
|
|
598
608
|
export declare interface ApprovalStatusConstructorArgs extends SystemWideObjectConstructorArgs {
|
|
599
609
|
}
|
|
600
610
|
|
|
611
|
+
export declare type BackendIdentifiableTranslationJob = IdentifiableObject_2 & Omit<TranslationJob_2, 'Id'>;
|
|
612
|
+
|
|
601
613
|
export declare interface BackendValidationApiError extends ApiError_2 {
|
|
602
614
|
body: BackendValidationApiErrorBody;
|
|
603
615
|
}
|
|
@@ -1476,7 +1488,7 @@ export declare interface DynamicVersionInfoConstructorArgs {
|
|
|
1476
1488
|
revisionDate: Date | undefined;
|
|
1477
1489
|
}
|
|
1478
1490
|
|
|
1479
|
-
export declare class EclUri {
|
|
1491
|
+
export declare class EclUri implements Uri {
|
|
1480
1492
|
/**
|
|
1481
1493
|
* Id of the Tridion Publication this EclUri belongs to.
|
|
1482
1494
|
*/
|
|
@@ -1508,6 +1520,7 @@ export declare class EclUri {
|
|
|
1508
1520
|
private static _eclUriCache;
|
|
1509
1521
|
private static _eclUriPrefix;
|
|
1510
1522
|
private static _eclUriRegExp;
|
|
1523
|
+
private static _editableVersion;
|
|
1511
1524
|
private constructor();
|
|
1512
1525
|
static get uriPrefix(): string;
|
|
1513
1526
|
private static create;
|
|
@@ -1520,6 +1533,10 @@ export declare class EclUri {
|
|
|
1520
1533
|
get hasVersion(): boolean;
|
|
1521
1534
|
get isNullUri(): boolean;
|
|
1522
1535
|
get isDynamic(): boolean;
|
|
1536
|
+
/**
|
|
1537
|
+
* If the item version is 0, then the item is editable. (e.g. ecl:5-vim-295361341-vid-file-v0)
|
|
1538
|
+
*/
|
|
1539
|
+
get isEditableVersion(): boolean;
|
|
1523
1540
|
get asString(): string;
|
|
1524
1541
|
getPublicationUri: () => TcmUri;
|
|
1525
1542
|
getVersionlessUri: () => EclUri;
|
|
@@ -1995,6 +2012,149 @@ export declare interface IdentifiableObjectConstructorArgs {
|
|
|
1995
2012
|
securityDescriptor: SecurityDescriptor | undefined;
|
|
1996
2013
|
}
|
|
1997
2014
|
|
|
2015
|
+
/**
|
|
2016
|
+
* `TranslationJob` class that extends `IdentifiableObject`, that uses `ItemUri` instead of number as an id.
|
|
2017
|
+
*
|
|
2018
|
+
* @note
|
|
2019
|
+
* Please note that the rest of `IdentifiableObject` props will be undefined always.
|
|
2020
|
+
*
|
|
2021
|
+
* To get original object use `getOriginalInternalModel()`, as `getInternalModel()` result will include `Id` in a format `tm:0-1234`.
|
|
2022
|
+
*
|
|
2023
|
+
* @example
|
|
2024
|
+
* TranslationJob.id: number | undefined;
|
|
2025
|
+
* IdentifiableTranslationJob.id: ItemUri;
|
|
2026
|
+
*/
|
|
2027
|
+
export declare class IdentifiableTranslationJob extends IdentifiableObject {
|
|
2028
|
+
protected _backendModel: BackendIdentifiableTranslationJob;
|
|
2029
|
+
private _addedItems;
|
|
2030
|
+
private _creator;
|
|
2031
|
+
private _configurationItemUri;
|
|
2032
|
+
private _displayState;
|
|
2033
|
+
private _errors;
|
|
2034
|
+
private _errorSeverityLevel;
|
|
2035
|
+
private _language;
|
|
2036
|
+
private _priority;
|
|
2037
|
+
private _revisor;
|
|
2038
|
+
private _state;
|
|
2039
|
+
private _targetLanguages;
|
|
2040
|
+
private _type;
|
|
2041
|
+
private _workflowStatus;
|
|
2042
|
+
private _creationDate;
|
|
2043
|
+
private _requiredDate;
|
|
2044
|
+
private _revisionDate;
|
|
2045
|
+
private _contextRepository;
|
|
2046
|
+
constructor({ addedItems, backendModel, configurationItemUri, creationDate, creator, displayState, errors, errorSeverityLevel, language, priority, requiredDate, revisionDate, revisor, state, targetLanguages, type, workflowStatus, contextRepository, ...identifiableObjectArgs }: IdentifiableTranslationJobConstructorArgs);
|
|
2047
|
+
get title(): string | undefined;
|
|
2048
|
+
/**
|
|
2049
|
+
* Collection containing the `AddedItem`s that have been added to this Translation Job.
|
|
2050
|
+
* The `AddedItem`s represent either an Item that will be translated (for example a Component) or
|
|
2051
|
+
* an Item that contains the Items that will be translated (for example a Folder).
|
|
2052
|
+
*/
|
|
2053
|
+
get addedItems(): ReadonlyArray<TranslationJobItem> | undefined;
|
|
2054
|
+
/**
|
|
2055
|
+
* TCM URI of the item containing the `TranslationConfiguration` used for this Translation Job.
|
|
2056
|
+
*/
|
|
2057
|
+
get configurationItemUri(): ItemUri | undefined;
|
|
2058
|
+
/**
|
|
2059
|
+
* Link to the Context Repository.
|
|
2060
|
+
*/
|
|
2061
|
+
get contextRepository(): Link | undefined;
|
|
2062
|
+
/**
|
|
2063
|
+
* The date the Translation Job was created (in UTC).
|
|
2064
|
+
*/
|
|
2065
|
+
get creationDate(): Date | undefined;
|
|
2066
|
+
/**
|
|
2067
|
+
* A link to the user who created the Translation Job.
|
|
2068
|
+
*/
|
|
2069
|
+
get creator(): Link | undefined;
|
|
2070
|
+
get displayState(): TranslationJobDisplayState | undefined;
|
|
2071
|
+
/**
|
|
2072
|
+
* Collection of errors registered to this job.
|
|
2073
|
+
*/
|
|
2074
|
+
get errors(): ReadonlyArray<TranslationErrorDetails> | undefined;
|
|
2075
|
+
get errorSeverityLevel(): TranslationErrorSeverity | undefined;
|
|
2076
|
+
get hasError(): boolean;
|
|
2077
|
+
/**
|
|
2078
|
+
* Value indicating whether items that have already been translated should be included in the job.
|
|
2079
|
+
*/
|
|
2080
|
+
get includeItemsAlreadyTranslated(): boolean;
|
|
2081
|
+
/**
|
|
2082
|
+
* Value indicating if the Translation Job currently have one or more `TranslationJobQuote`s awaiting authorization (see remarks).
|
|
2083
|
+
*/
|
|
2084
|
+
get isAwaitingAuthorization(): boolean;
|
|
2085
|
+
get language(): TmsLanguage | undefined;
|
|
2086
|
+
/**
|
|
2087
|
+
* Metadata associated with the Translation Job.
|
|
2088
|
+
*/
|
|
2089
|
+
get metadata(): FieldsValueDictionary | undefined;
|
|
2090
|
+
/**
|
|
2091
|
+
* TCM URI of the metadata schema used for this Translation Job.
|
|
2092
|
+
*
|
|
2093
|
+
* @deprecated will be mapped to `ItemUri` in the next major release.
|
|
2094
|
+
*/
|
|
2095
|
+
get metadataSchemaUri(): string | undefined;
|
|
2096
|
+
/**
|
|
2097
|
+
* The priority of the Translation Job. This value will only have an affect if `SupportsPriority` returns true.
|
|
2098
|
+
*/
|
|
2099
|
+
get priority(): TranslationJobPriority | undefined;
|
|
2100
|
+
get progressPercentage(): number | undefined;
|
|
2101
|
+
/**
|
|
2102
|
+
* The due date for this job.
|
|
2103
|
+
*/
|
|
2104
|
+
get requiredDate(): Date | undefined;
|
|
2105
|
+
get revisionDate(): Date | undefined;
|
|
2106
|
+
/**
|
|
2107
|
+
* A link to the user who last modified the Translation Job.
|
|
2108
|
+
*/
|
|
2109
|
+
get revisor(): Link | undefined;
|
|
2110
|
+
get state(): TranslationJobState | undefined;
|
|
2111
|
+
/**
|
|
2112
|
+
* Show if `TranslationJob` support setting of priority.
|
|
2113
|
+
*/
|
|
2114
|
+
get supportsPriority(): boolean;
|
|
2115
|
+
/**
|
|
2116
|
+
* Show if `TranslationJob` support setting required rate.
|
|
2117
|
+
*/
|
|
2118
|
+
get supportsRequiredDate(): boolean;
|
|
2119
|
+
/**
|
|
2120
|
+
* List of target languages available for this `TranslationJob`.
|
|
2121
|
+
*/
|
|
2122
|
+
get targetLanguages(): ReadonlyArray<TargetLanguage> | undefined;
|
|
2123
|
+
/**
|
|
2124
|
+
* Value indicating if the Translation Job is a translation to the Publication of the `ConfigurationItemUri`
|
|
2125
|
+
* (Pull job) or from the Publication (Push job).
|
|
2126
|
+
*/
|
|
2127
|
+
get type(): ReadonlyArray<TranslationJobType> | undefined;
|
|
2128
|
+
/**
|
|
2129
|
+
* Item count of language/workflowstep pairs.
|
|
2130
|
+
*/
|
|
2131
|
+
get workflowStatus(): ReadonlyArray<TranslationWorkflowStatus> | undefined;
|
|
2132
|
+
getOriginalInternalModel: () => TranslationJob_2;
|
|
2133
|
+
getInternalModel: () => BackendIdentifiableTranslationJob;
|
|
2134
|
+
}
|
|
2135
|
+
|
|
2136
|
+
export declare interface IdentifiableTranslationJobConstructorArgs extends IdentifiableObjectConstructorArgs {
|
|
2137
|
+
backendModel: BackendIdentifiableTranslationJob;
|
|
2138
|
+
id: ItemUri;
|
|
2139
|
+
addedItems: ReadonlyArray<TranslationJobItem> | undefined;
|
|
2140
|
+
configurationItemUri: ItemUri | undefined;
|
|
2141
|
+
creationDate: Date | undefined;
|
|
2142
|
+
creator: Link | undefined;
|
|
2143
|
+
displayState: TranslationJobDisplayState | undefined;
|
|
2144
|
+
errors: ReadonlyArray<TranslationErrorDetails> | undefined;
|
|
2145
|
+
errorSeverityLevel: TranslationErrorSeverity | undefined;
|
|
2146
|
+
language: TmsLanguage | undefined;
|
|
2147
|
+
priority: TranslationJobPriority | undefined;
|
|
2148
|
+
requiredDate: Date | undefined;
|
|
2149
|
+
revisionDate: Date | undefined;
|
|
2150
|
+
revisor: Link | undefined;
|
|
2151
|
+
state: TranslationJobState | undefined;
|
|
2152
|
+
targetLanguages: ReadonlyArray<TargetLanguage> | undefined;
|
|
2153
|
+
type: ReadonlyArray<TranslationJobType> | undefined;
|
|
2154
|
+
workflowStatus: ReadonlyArray<TranslationWorkflowStatus> | undefined;
|
|
2155
|
+
contextRepository: Link | undefined;
|
|
2156
|
+
}
|
|
2157
|
+
|
|
1998
2158
|
export declare const isRloNode: (node: ItemBlueprintNode) => node is BlueprintReadonlyGraphNode<ReadonlyItemBlueprintRloNodeData>;
|
|
1999
2159
|
|
|
2000
2160
|
export declare class ItemBlueprintHierarchy {
|
|
@@ -2088,12 +2248,14 @@ export declare const itemLinkType: {
|
|
|
2088
2248
|
virtualFolder: "virtualFolder";
|
|
2089
2249
|
multimediaType: "multimediaType";
|
|
2090
2250
|
user: "user";
|
|
2251
|
+
publishTransaction: "publishTransaction";
|
|
2091
2252
|
processDefinition: "processDefinition";
|
|
2092
2253
|
processInstance: "processInstance";
|
|
2093
2254
|
processHistory: "processHistory";
|
|
2094
2255
|
activityInstance: "activityInstance";
|
|
2095
2256
|
businessProcessTypes: "businessProcessTypes";
|
|
2096
2257
|
taxonomies: "taxonomies";
|
|
2258
|
+
translationJob: "translationJob";
|
|
2097
2259
|
externalFolder: "externalFolder";
|
|
2098
2260
|
externalKeyword: "externalKeyword";
|
|
2099
2261
|
externalKeywordCategory: "externalKeywordCategory";
|
|
@@ -2103,7 +2265,7 @@ export declare const itemLinkType: {
|
|
|
2103
2265
|
userGroup: "userGroup";
|
|
2104
2266
|
};
|
|
2105
2267
|
|
|
2106
|
-
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"];
|
|
2268
|
+
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", "publishTransaction", "schema", "structureGroup", "targetGroup", "taxonomies", "templateBuildingBlock", "user", "userGroup", "virtualFolder", "translationJob"];
|
|
2107
2269
|
|
|
2108
2270
|
/**
|
|
2109
2271
|
* Abstract base class for Item Field Definitions for the field types that can be published.
|
|
@@ -2140,12 +2302,14 @@ export declare const itemType: {
|
|
|
2140
2302
|
virtualFolder: "virtualFolder";
|
|
2141
2303
|
multimediaType: "multimediaType";
|
|
2142
2304
|
user: "user";
|
|
2305
|
+
publishTransaction: "publishTransaction";
|
|
2143
2306
|
processDefinition: "processDefinition";
|
|
2144
2307
|
processInstance: "processInstance";
|
|
2145
2308
|
processHistory: "processHistory";
|
|
2146
2309
|
activityInstance: "activityInstance";
|
|
2147
2310
|
businessProcessTypes: "businessProcessTypes";
|
|
2148
2311
|
taxonomies: "taxonomies";
|
|
2312
|
+
translationJob: "translationJob";
|
|
2149
2313
|
bundle: "bundle";
|
|
2150
2314
|
externalFolder: "externalFolder";
|
|
2151
2315
|
externalKeyword: "externalKeyword";
|
|
@@ -2161,9 +2325,9 @@ export declare const itemType: {
|
|
|
2161
2325
|
searchFolder: "searchFolder";
|
|
2162
2326
|
};
|
|
2163
2327
|
|
|
2164
|
-
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"];
|
|
2328
|
+
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", "publishTransaction", "schema", "structureGroup", "targetGroup", "taxonomies", "templateBuildingBlock", "user", "userGroup", "virtualFolder", "translationJob", "abstractExternalKeyword", "abstractKeyword", "bundle", "multimediaComponent", "multimediaSchema", "searchFolder"];
|
|
2165
2329
|
|
|
2166
|
-
export declare type ItemUri = TcmUri | EclUri | VirtualUri;
|
|
2330
|
+
export declare type ItemUri = TcmUri | EclUri | VirtualUri | TmUri;
|
|
2167
2331
|
|
|
2168
2332
|
/**
|
|
2169
2333
|
* Represents the data of a Keyword used to classify items.
|
|
@@ -3508,6 +3672,36 @@ export declare abstract class Region {
|
|
|
3508
3672
|
getInternalModel: () => Region_2;
|
|
3509
3673
|
}
|
|
3510
3674
|
|
|
3675
|
+
export declare class RenderedItem {
|
|
3676
|
+
protected _backendModel: RenderedItem_2;
|
|
3677
|
+
private _item;
|
|
3678
|
+
private _template;
|
|
3679
|
+
constructor({ backendModel, item, template }: RenderedItemConstructorArgs);
|
|
3680
|
+
/**
|
|
3681
|
+
* Gets the data pipeline JSON (if any)
|
|
3682
|
+
*/
|
|
3683
|
+
get dataPipelineJson(): string | undefined;
|
|
3684
|
+
/**
|
|
3685
|
+
* Gets a link to the item that was rendered.
|
|
3686
|
+
*/
|
|
3687
|
+
get item(): Link | undefined;
|
|
3688
|
+
/**
|
|
3689
|
+
* Gets the rendered output of the template (if any)
|
|
3690
|
+
*/
|
|
3691
|
+
get renderedOutput(): string | undefined;
|
|
3692
|
+
/**
|
|
3693
|
+
* Gets a link to the template with which the item was rendered (if any).
|
|
3694
|
+
*/
|
|
3695
|
+
get template(): Link | undefined;
|
|
3696
|
+
getInternalModel: () => RenderedItem_2;
|
|
3697
|
+
}
|
|
3698
|
+
|
|
3699
|
+
export declare interface RenderedItemConstructorArgs {
|
|
3700
|
+
backendModel: RenderedItem_2;
|
|
3701
|
+
item: Link | undefined;
|
|
3702
|
+
template: Link | undefined;
|
|
3703
|
+
}
|
|
3704
|
+
|
|
3511
3705
|
/**
|
|
3512
3706
|
* Represents a Repository: a context for BluePrinting.
|
|
3513
3707
|
*/
|
|
@@ -3913,6 +4107,19 @@ export declare interface SecurityDescriptorConstructorArgs {
|
|
|
3913
4107
|
rights: ReadonlyArray<Right> | undefined;
|
|
3914
4108
|
}
|
|
3915
4109
|
|
|
4110
|
+
export declare class Settings<TData extends Record<string, any>> {
|
|
4111
|
+
protected _backendModel: Settings_2;
|
|
4112
|
+
private _data;
|
|
4113
|
+
constructor({ backendModel, data }: SettingsConstructorArgs<TData>);
|
|
4114
|
+
get data(): TData | undefined;
|
|
4115
|
+
getInternalModel: () => Settings_2;
|
|
4116
|
+
}
|
|
4117
|
+
|
|
4118
|
+
export declare interface SettingsConstructorArgs<TData> {
|
|
4119
|
+
backendModel: Settings_2;
|
|
4120
|
+
data: TData | undefined;
|
|
4121
|
+
}
|
|
4122
|
+
|
|
3916
4123
|
/**
|
|
3917
4124
|
* Represents a single-line text field definition (in a Schema).
|
|
3918
4125
|
*/
|
|
@@ -4310,7 +4517,7 @@ export declare interface TaxonomiesConstructorArgs extends OrganizationalItemCon
|
|
|
4310
4517
|
*
|
|
4311
4518
|
* The structure of a TCM URI is PublicationID-ItemID[-ItemType][-vVersion].
|
|
4312
4519
|
*/
|
|
4313
|
-
export declare class TcmUri {
|
|
4520
|
+
export declare class TcmUri implements Uri {
|
|
4314
4521
|
private readonly _publicationId;
|
|
4315
4522
|
private readonly _itemId;
|
|
4316
4523
|
private readonly _itemType;
|
|
@@ -4335,6 +4542,9 @@ export declare class TcmUri {
|
|
|
4335
4542
|
get isNewUri(): boolean;
|
|
4336
4543
|
get isNullUri(): boolean;
|
|
4337
4544
|
get isSystemUri(): boolean;
|
|
4545
|
+
/**
|
|
4546
|
+
* If the item version is 0, then the item is editable. (e.g. tcm:1-1-v0)
|
|
4547
|
+
*/
|
|
4338
4548
|
get isEditableVersion(): boolean;
|
|
4339
4549
|
get isDynamic(): boolean;
|
|
4340
4550
|
get asString(): string;
|
|
@@ -4344,7 +4554,7 @@ export declare class TcmUri {
|
|
|
4344
4554
|
getUriInPublication: (publicationUri: TcmUri) => TcmUri;
|
|
4345
4555
|
}
|
|
4346
4556
|
|
|
4347
|
-
declare type TcmUriItemType = keyof typeof tcmUriItemType;
|
|
4557
|
+
export declare type TcmUriItemType = keyof typeof tcmUriItemType;
|
|
4348
4558
|
|
|
4349
4559
|
declare const tcmUriItemType: {
|
|
4350
4560
|
none: number;
|
|
@@ -4524,6 +4734,42 @@ export declare class TmsWorkflowStep {
|
|
|
4524
4734
|
getInternalModel: () => TmsWorkflowStep_2;
|
|
4525
4735
|
}
|
|
4526
4736
|
|
|
4737
|
+
export declare class TmUri implements Uri {
|
|
4738
|
+
/**
|
|
4739
|
+
* TM-specified item id.
|
|
4740
|
+
*/
|
|
4741
|
+
private readonly _itemId;
|
|
4742
|
+
private readonly _asString;
|
|
4743
|
+
private static _tmUriCache;
|
|
4744
|
+
private static _tmUriPrefix;
|
|
4745
|
+
private static _tmUriRegExp;
|
|
4746
|
+
private constructor();
|
|
4747
|
+
static get uriPrefix(): string;
|
|
4748
|
+
static create: (itemId: number) => TmUri;
|
|
4749
|
+
static parse: (input: string) => TmUri | undefined;
|
|
4750
|
+
get itemType(): 'translationJob';
|
|
4751
|
+
get itemId(): number;
|
|
4752
|
+
get asString(): string;
|
|
4753
|
+
/**
|
|
4754
|
+
* Don't use it, will be removed later. Added to align api with other uris.
|
|
4755
|
+
*
|
|
4756
|
+
* @deprecated
|
|
4757
|
+
*/
|
|
4758
|
+
get isDynamic(): boolean;
|
|
4759
|
+
/**
|
|
4760
|
+
* Don't use it, will be removed later. Added to align api with other uris.
|
|
4761
|
+
*
|
|
4762
|
+
* @deprecated
|
|
4763
|
+
*/
|
|
4764
|
+
getPublicationUri: () => TcmUri;
|
|
4765
|
+
/**
|
|
4766
|
+
* Don't use it, will be removed later. Added to align api with other uris.
|
|
4767
|
+
*
|
|
4768
|
+
* @deprecated
|
|
4769
|
+
*/
|
|
4770
|
+
getUriInPublication: (publicationUri: TcmUri) => TmUri;
|
|
4771
|
+
}
|
|
4772
|
+
|
|
4527
4773
|
/**
|
|
4528
4774
|
* Contains information about the translation state of the Item.
|
|
4529
4775
|
*/
|
|
@@ -4750,7 +4996,8 @@ export declare class TranslationJob {
|
|
|
4750
4996
|
private _creationDate;
|
|
4751
4997
|
private _requiredDate;
|
|
4752
4998
|
private _revisionDate;
|
|
4753
|
-
|
|
4999
|
+
private _contextRepository;
|
|
5000
|
+
constructor({ addedItems, backendModel, configurationItemUri, creationDate, creator, displayState, errors, errorSeverityLevel, language, priority, requiredDate, revisionDate, revisor, state, targetLanguages, type, workflowStatus, contextRepository, }: TranslationJobConstructorArgs);
|
|
4754
5001
|
get id(): number | undefined;
|
|
4755
5002
|
get title(): string | undefined;
|
|
4756
5003
|
/**
|
|
@@ -4764,9 +5011,9 @@ export declare class TranslationJob {
|
|
|
4764
5011
|
*/
|
|
4765
5012
|
get configurationItemUri(): ItemUri | undefined;
|
|
4766
5013
|
/**
|
|
4767
|
-
*
|
|
5014
|
+
* Link to the Context Repository.
|
|
4768
5015
|
*/
|
|
4769
|
-
get
|
|
5016
|
+
get contextRepository(): Link | undefined;
|
|
4770
5017
|
/**
|
|
4771
5018
|
* The date the Translation Job was created (in UTC).
|
|
4772
5019
|
*/
|
|
@@ -4856,6 +5103,7 @@ export declare interface TranslationJobConstructorArgs {
|
|
|
4856
5103
|
targetLanguages: ReadonlyArray<TargetLanguage> | undefined;
|
|
4857
5104
|
type: ReadonlyArray<TranslationJobType> | undefined;
|
|
4858
5105
|
workflowStatus: ReadonlyArray<TranslationWorkflowStatus> | undefined;
|
|
5106
|
+
contextRepository: Link | undefined;
|
|
4859
5107
|
}
|
|
4860
5108
|
|
|
4861
5109
|
/**
|
|
@@ -5094,6 +5342,24 @@ export declare type TranslationJobState = 'canceled' | 'definition' | 'readyForT
|
|
|
5094
5342
|
*/
|
|
5095
5343
|
export declare type TranslationJobType = 'none' | 'pushJob' | 'pullJob' | 'unknownByClient';
|
|
5096
5344
|
|
|
5345
|
+
export declare class TranslationResolvedItem {
|
|
5346
|
+
protected _backendModel: TmResolvedItem;
|
|
5347
|
+
private _sourceItem;
|
|
5348
|
+
private _targetLanguages;
|
|
5349
|
+
constructor({ backendModel, sourceItem, targetLanguages }: TranslationResolvedItemConstructorArgs);
|
|
5350
|
+
get isValidForTranslation(): boolean;
|
|
5351
|
+
get comment(): string | undefined;
|
|
5352
|
+
get sourceItem(): RepositoryLocalObject | undefined;
|
|
5353
|
+
get targetLanguages(): ReadonlyArray<TargetLanguage> | undefined;
|
|
5354
|
+
getInternalModel: () => TmResolvedItem;
|
|
5355
|
+
}
|
|
5356
|
+
|
|
5357
|
+
export declare interface TranslationResolvedItemConstructorArgs {
|
|
5358
|
+
backendModel: TmResolvedItem;
|
|
5359
|
+
sourceItem: RepositoryLocalObject | undefined;
|
|
5360
|
+
targetLanguages: ReadonlyArray<TargetLanguage> | undefined;
|
|
5361
|
+
}
|
|
5362
|
+
|
|
5097
5363
|
/**
|
|
5098
5364
|
* Represents translation status of an Item.
|
|
5099
5365
|
*
|
|
@@ -5297,6 +5563,16 @@ export declare interface UnpublishInstructionConstructorArgs {
|
|
|
5297
5563
|
resolveInstruction: ResolveInstruction | undefined;
|
|
5298
5564
|
}
|
|
5299
5565
|
|
|
5566
|
+
declare abstract class Uri {
|
|
5567
|
+
abstract itemId: number | string;
|
|
5568
|
+
abstract asString: string;
|
|
5569
|
+
abstract itemType: EclUriItemType | TcmUriItemType | VirtualUriItemType | 'translationJob';
|
|
5570
|
+
abstract isDynamic: boolean;
|
|
5571
|
+
abstract getPublicationUri(): TcmUri;
|
|
5572
|
+
abstract getUriInPublication(publicationUri: TcmUri): ItemUri;
|
|
5573
|
+
static parse(backendId: string): ItemUri | undefined;
|
|
5574
|
+
}
|
|
5575
|
+
|
|
5300
5576
|
export declare class User extends Trustee {
|
|
5301
5577
|
protected _backendModel: User_2;
|
|
5302
5578
|
constructor({ backendModel, ...trusteeArgs }: UserConstructorArgs);
|
|
@@ -5473,7 +5749,8 @@ export declare class UserProfile {
|
|
|
5473
5749
|
private _user;
|
|
5474
5750
|
private _runtimeInfo;
|
|
5475
5751
|
private _preferences;
|
|
5476
|
-
|
|
5752
|
+
private _inheritedSystemPrivileges;
|
|
5753
|
+
constructor({ backendModel, user, runtimeInfo, preferences, inheritedSystemPrivileges, }: UserProfileConstructorArgs);
|
|
5477
5754
|
/**
|
|
5478
5755
|
* User display name.
|
|
5479
5756
|
*/
|
|
@@ -5494,6 +5771,10 @@ export declare class UserProfile {
|
|
|
5494
5771
|
* User preferences.
|
|
5495
5772
|
*/
|
|
5496
5773
|
get preferences(): UserPreferences | undefined;
|
|
5774
|
+
/**
|
|
5775
|
+
* Dictionary containing system privilege keys and their associated groups.
|
|
5776
|
+
*/
|
|
5777
|
+
get inheritedSystemPrivileges(): Record<string, any> | undefined;
|
|
5497
5778
|
getInternalModel: () => UserProfile_2;
|
|
5498
5779
|
}
|
|
5499
5780
|
|
|
@@ -5502,6 +5783,7 @@ export declare interface UserProfileConstructorArgs {
|
|
|
5502
5783
|
user: User | undefined;
|
|
5503
5784
|
runtimeInfo: UserRuntimeInfo | undefined;
|
|
5504
5785
|
preferences: UserPreferences | undefined;
|
|
5786
|
+
inheritedSystemPrivileges: Record<string, any> | undefined;
|
|
5505
5787
|
}
|
|
5506
5788
|
|
|
5507
5789
|
/**
|
|
@@ -5667,7 +5949,7 @@ export declare interface VirtualFolderConstructorArgs extends OrganizationalItem
|
|
|
5667
5949
|
workflowInfo: WorkflowInfo | undefined;
|
|
5668
5950
|
}
|
|
5669
5951
|
|
|
5670
|
-
export declare class VirtualUri {
|
|
5952
|
+
export declare class VirtualUri implements Uri {
|
|
5671
5953
|
private readonly _publicationUri;
|
|
5672
5954
|
private readonly _itemType;
|
|
5673
5955
|
private readonly _asString;
|
|
@@ -5675,6 +5957,7 @@ export declare class VirtualUri {
|
|
|
5675
5957
|
private constructor();
|
|
5676
5958
|
static create: (publicationUri: TcmUri, itemType: VirtualUriItemType) => VirtualUri;
|
|
5677
5959
|
static parse: (input: string) => VirtualUri | undefined;
|
|
5960
|
+
get itemId(): string;
|
|
5678
5961
|
get itemType(): VirtualUriItemType;
|
|
5679
5962
|
get isDynamic(): boolean;
|
|
5680
5963
|
get asString(): string;
|