@tridion-sites/models 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @tridion-sites/models
 
+## 2.2.0
+
+### Minor Changes
+
+- bc98a17: Add translation manager applicable actions
+- a7a8cd6: Add `IdentifiableTranslationJob`, `TmUri` models
+- 68fd3dc: Add `translationJob` item type
+- 77cdc6c: Add `TranslationResolvedItem` model
+- a4fda02: Add `tcm:finishprocess` action
+
+### Patch Changes
+
+- c8abfb1: Fix TM error translation job uri mapping
+- Updated dependencies [482b9d1], [77cdc6c], [cf7b3ba]
+    - @tridion-sites/open-api-client@4.2.0
+
 ## 2.1.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -104,6 +104,7 @@ import type { PublishTransactionsCreationResult as PublishTransactionsCreationRe
 import { PublishTransactionState as PublishTransactionState_2 } from '@tridion-sites/open-api-client';
 import type { PublishUrlInfo as PublishUrlInfo_2 } from '@tridion-sites/open-api-client';
 import type { Region as Region_2 } from '@tridion-sites/open-api-client';
+import type { RenderedItem as RenderedItem_2 } from '@tridion-sites/open-api-client';
 import type { Repository as Repository_2 } from '@tridion-sites/open-api-client';
 import type { RepositoryLocalObject as RepositoryLocalObject_2 } from '@tridion-sites/open-api-client';
 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
 import { SearchBlueprintStatus as SearchBlueprintStatus_2 } from '@tridion-sites/open-api-client';
 import type { SearchFolder as SearchFolder_2 } from '@tridion-sites/open-api-client';
 import type { SecurityDescriptor as SecurityDescriptor_2 } from '@tridion-sites/open-api-client';
+import type { Settings as Settings_2 } from '@tridion-sites/open-api-client';
 import type { SingleLineTextFieldDefinition as SingleLineTextFieldDefinition_2 } from '@tridion-sites/open-api-client';
 import type { SingleLineTextListDefinition as SingleLineTextListDefinition_2 } from '@tridion-sites/open-api-client';
 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'
 import type { Template as Template_2 } from '@tridion-sites/open-api-client';
 import type { TemplateBuildingBlock as TemplateBuildingBlock_2 } from '@tridion-sites/open-api-client';
 import type { TextFieldDefinition as TextFieldDefinition_2 } from '@tridion-sites/open-api-client';
+import type { TmResolvedItem } from '@tridion-sites/open-api-client';
 import type { TmsLanguage as TmsLanguage_2 } from '@tridion-sites/open-api-client';
 import type { TmsWorkflow as TmsWorkflow_2 } from '@tridion-sites/open-api-client';
 import type { TmsWorkflowStep as TmsWorkflowStep_2 } from '@tridion-sites/open-api-client';
@@ -570,9 +573,16 @@ export declare const applicableActions: {
     assignActivity: string;
     startActivity: string;
     finishActivity: string;
+    finishProcess: string;
     restartActivity: string;
     pushTranslation: string;
     pullTranslation: string;
+    deleteTranslation: string;
+    retryTranslation: string;
+    viewTranslation: string;
+    editTranslation: string;
+    copyTranslation: string;
+    sendTranslation: string;
 };
 
 export declare class ApprovalStatus extends SystemWideObject {
@@ -598,6 +608,8 @@ export declare class ApprovalStatus extends SystemWideObject {
 export declare interface ApprovalStatusConstructorArgs extends SystemWideObjectConstructorArgs {
 }
 
+export declare type BackendIdentifiableTranslationJob = IdentifiableObject_2 & Omit<TranslationJob_2, 'Id'>;
+
 export declare interface BackendValidationApiError extends ApiError_2 {
     body: BackendValidationApiErrorBody;
 }
@@ -1476,7 +1488,7 @@ export declare interface DynamicVersionInfoConstructorArgs {
     revisionDate: Date | undefined;
 }
 
-export declare class EclUri {
+export declare class EclUri implements Uri {
     /**
      * Id of the Tridion Publication this EclUri belongs to.
      */
@@ -1995,6 +2007,147 @@ export declare interface IdentifiableObjectConstructorArgs {
     securityDescriptor: SecurityDescriptor | undefined;
 }
 
+/**
+ * `TranslationJob` class that extends `IdentifiableObject`, that uses `ItemUri` instead of number as an id.
+ *
+ * @note
+ * Please note that the rest of `IdentifiableObject` props will be undefined always.
+ *
+ * To get original object use `getOriginalInternalModel()`, as `getInternalModel()` result will include `Id` in a format `tm:0-1234`.
+ *
+ * @example
+ * TranslationJob.id: number | undefined;
+ * IdentifiableTranslationJob.id: ItemUri;
+ */
+export declare class IdentifiableTranslationJob extends IdentifiableObject {
+    protected _backendModel: BackendIdentifiableTranslationJob;
+    private _addedItems;
+    private _creator;
+    private _configurationItemUri;
+    private _displayState;
+    private _errors;
+    private _errorSeverityLevel;
+    private _language;
+    private _priority;
+    private _revisor;
+    private _state;
+    private _targetLanguages;
+    private _type;
+    private _workflowStatus;
+    private _creationDate;
+    private _requiredDate;
+    private _revisionDate;
+    private _contextRepository;
+    constructor({ addedItems, backendModel, configurationItemUri, creationDate, creator, displayState, errors, errorSeverityLevel, language, priority, requiredDate, revisionDate, revisor, state, targetLanguages, type, workflowStatus, contextRepository, ...identifiableObjectArgs }: IdentifiableTranslationJobConstructorArgs);
+    get title(): string | undefined;
+    /**
+     * Collection containing the `AddedItem`s that have been added to this Translation Job.
+     * The `AddedItem`s represent either an Item that will be translated (for example a Component) or
+     * an Item that contains the Items that will be translated (for example a Folder).
+     */
+    get addedItems(): ReadonlyArray<TranslationJobItem> | undefined;
+    /**
+     * TCM URI of the item containing the `TranslationConfiguration` used for this Translation Job.
+     */
+    get configurationItemUri(): ItemUri | undefined;
+    /**
+     * Link to the Context Repository.
+     */
+    get contextRepository(): Link | undefined;
+    /**
+     * The date the Translation Job was created (in UTC).
+     */
+    get creationDate(): Date | undefined;
+    /**
+     * A link to the user who created the Translation Job.
+     */
+    get creator(): Link | undefined;
+    get displayState(): TranslationJobDisplayState | undefined;
+    /**
+     * Collection of errors registered to this job.
+     */
+    get errors(): ReadonlyArray<TranslationErrorDetails> | undefined;
+    get errorSeverityLevel(): TranslationErrorSeverity | undefined;
+    get hasError(): boolean;
+    /**
+     * Value indicating whether items that have already been translated should be included in the job.
+     */
+    get includeItemsAlreadyTranslated(): boolean;
+    /**
+     * Value indicating if the Translation Job currently have one or more `TranslationJobQuote`s awaiting authorization (see remarks).
+     */
+    get isAwaitingAuthorization(): boolean;
+    get language(): TmsLanguage | undefined;
+    /**
+     * Metadata associated with the Translation Job.
+     */
+    get metadata(): FieldsValueDictionary | undefined;
+    /**
+     * TCM URI of the metadata schema used for this Translation Job.
+     */
+    get metadataSchemaUri(): string | undefined;
+    /**
+     * The priority of the Translation Job. This value will only have an affect if `SupportsPriority` returns true.
+     */
+    get priority(): TranslationJobPriority | undefined;
+    get progressPercentage(): number | undefined;
+    /**
+     * The due date for this job.
+     */
+    get requiredDate(): Date | undefined;
+    get revisionDate(): Date | undefined;
+    /**
+     * A link to the user who last modified the Translation Job.
+     */
+    get revisor(): Link | undefined;
+    get state(): TranslationJobState | undefined;
+    /**
+     * Show if `TranslationJob` support setting of priority.
+     */
+    get supportsPriority(): boolean;
+    /**
+     * Show if `TranslationJob` support setting required rate.
+     */
+    get supportsRequiredDate(): boolean;
+    /**
+     * List of target languages available for this `TranslationJob`.
+     */
+    get targetLanguages(): ReadonlyArray<TargetLanguage> | undefined;
+    /**
+     * Value indicating if the Translation Job is a translation to the Publication of the `ConfigurationItemUri`
+     * (Pull job) or from the Publication (Push job).
+     */
+    get type(): ReadonlyArray<TranslationJobType> | undefined;
+    /**
+     * Item count of language/workflowstep pairs.
+     */
+    get workflowStatus(): ReadonlyArray<TranslationWorkflowStatus> | undefined;
+    getOriginalInternalModel: () => TranslationJob_2;
+    getInternalModel: () => BackendIdentifiableTranslationJob;
+}
+
+export declare interface IdentifiableTranslationJobConstructorArgs extends IdentifiableObjectConstructorArgs {
+    backendModel: BackendIdentifiableTranslationJob;
+    id: ItemUri;
+    addedItems: ReadonlyArray<TranslationJobItem> | undefined;
+    configurationItemUri: ItemUri | undefined;
+    creationDate: Date | undefined;
+    creator: Link | undefined;
+    displayState: TranslationJobDisplayState | undefined;
+    errors: ReadonlyArray<TranslationErrorDetails> | undefined;
+    errorSeverityLevel: TranslationErrorSeverity | undefined;
+    language: TmsLanguage | undefined;
+    priority: TranslationJobPriority | undefined;
+    requiredDate: Date | undefined;
+    revisionDate: Date | undefined;
+    revisor: Link | undefined;
+    state: TranslationJobState | undefined;
+    targetLanguages: ReadonlyArray<TargetLanguage> | undefined;
+    type: ReadonlyArray<TranslationJobType> | undefined;
+    workflowStatus: ReadonlyArray<TranslationWorkflowStatus> | undefined;
+    contextRepository: Link | undefined;
+}
+
 export declare const isRloNode: (node: ItemBlueprintNode) => node is BlueprintReadonlyGraphNode<ReadonlyItemBlueprintRloNodeData>;
 
 export declare class ItemBlueprintHierarchy {
@@ -2094,6 +2247,7 @@ export declare const itemLinkType: {
     activityInstance: "activityInstance";
     businessProcessTypes: "businessProcessTypes";
     taxonomies: "taxonomies";
+    translationJob: "translationJob";
     externalFolder: "externalFolder";
     externalKeyword: "externalKeyword";
     externalKeywordCategory: "externalKeywordCategory";
@@ -2103,7 +2257,7 @@ export declare const itemLinkType: {
     userGroup: "userGroup";
 };
 
-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"];
+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"];
 
 /**
  * Abstract base class for Item Field Definitions for the field types that can be published.
@@ -2146,6 +2300,7 @@ export declare const itemType: {
     activityInstance: "activityInstance";
     businessProcessTypes: "businessProcessTypes";
     taxonomies: "taxonomies";
+    translationJob: "translationJob";
     bundle: "bundle";
     externalFolder: "externalFolder";
     externalKeyword: "externalKeyword";
@@ -2161,9 +2316,9 @@ export declare const itemType: {
     searchFolder: "searchFolder";
 };
 
-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"];
+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"];
 
-export declare type ItemUri = TcmUri | EclUri | VirtualUri;
+export declare type ItemUri = TcmUri | EclUri | VirtualUri | TmUri;
 
 /**
  * Represents the data of a Keyword used to classify items.
@@ -3508,6 +3663,36 @@ export declare abstract class Region {
     getInternalModel: () => Region_2;
 }
 
+export declare class RenderedItem {
+    protected _backendModel: RenderedItem_2;
+    private _item;
+    private _template;
+    constructor({ backendModel, item, template }: RenderedItemConstructorArgs);
+    /**
+     * Gets the data pipeline JSON (if any)
+     */
+    get dataPipelineJson(): string | undefined;
+    /**
+     * Gets a link to the item that was rendered.
+     */
+    get item(): Link | undefined;
+    /**
+     * Gets the rendered output of the template (if any)
+     */
+    get renderedOutput(): string | undefined;
+    /**
+     * Gets a link to the template with which the item was rendered (if any).
+     */
+    get template(): Link | undefined;
+    getInternalModel: () => RenderedItem_2;
+}
+
+export declare interface RenderedItemConstructorArgs {
+    backendModel: RenderedItem_2;
+    item: Link | undefined;
+    template: Link | undefined;
+}
+
 /**
  * Represents a Repository: a context for BluePrinting.
  */
@@ -3913,6 +4098,19 @@ export declare interface SecurityDescriptorConstructorArgs {
     rights: ReadonlyArray<Right> | undefined;
 }
 
+export declare class Settings<TData extends Record<string, any>> {
+    protected _backendModel: Settings_2;
+    private _data;
+    constructor({ backendModel, data }: SettingsConstructorArgs<TData>);
+    get data(): TData | undefined;
+    getInternalModel: () => Settings_2;
+}
+
+export declare interface SettingsConstructorArgs<TData> {
+    backendModel: Settings_2;
+    data: TData | undefined;
+}
+
 /**
  * Represents a single-line text field definition (in a Schema).
  */
@@ -4310,7 +4508,7 @@ export declare interface TaxonomiesConstructorArgs extends OrganizationalItemCon
  *
  * The structure of a TCM URI is PublicationID-ItemID[-ItemType][-vVersion].
  */
-export declare class TcmUri {
+export declare class TcmUri implements Uri {
     private readonly _publicationId;
     private readonly _itemId;
     private readonly _itemType;
@@ -4524,6 +4722,42 @@ export declare class TmsWorkflowStep {
     getInternalModel: () => TmsWorkflowStep_2;
 }
 
+export declare class TmUri implements Uri {
+    /**
+     * TM-specified item id.
+     */
+    private readonly _itemId;
+    private readonly _asString;
+    private static _tmUriCache;
+    private static _tmUriPrefix;
+    private static _tmUriRegExp;
+    private constructor();
+    static get uriPrefix(): string;
+    static create: (itemId: number) => TmUri;
+    static parse: (input: string) => TmUri | undefined;
+    get itemType(): 'translationJob';
+    get itemId(): number;
+    get asString(): string;
+    /**
+     * Don't use it, will be removed later. Added to align api with other uris.
+     *
+     * @deprecated
+     */
+    get isDynamic(): boolean;
+    /**
+     * Don't use it, will be removed later. Added to align api with other uris.
+     *
+     * @deprecated
+     */
+    getPublicationUri: () => TcmUri;
+    /**
+     * Don't use it, will be removed later. Added to align api with other uris.
+     *
+     * @deprecated
+     */
+    getUriInPublication: (publicationUri: TcmUri) => TmUri;
+}
+
 /**
  * Contains information about the translation state of the Item.
  */
@@ -4750,7 +4984,8 @@ export declare class TranslationJob {
     private _creationDate;
     private _requiredDate;
     private _revisionDate;
-    constructor({ addedItems, backendModel, configurationItemUri, creationDate, creator, displayState, errors, errorSeverityLevel, language, priority, requiredDate, revisionDate, revisor, state, targetLanguages, type, workflowStatus, }: TranslationJobConstructorArgs);
+    private _contextRepository;
+    constructor({ addedItems, backendModel, configurationItemUri, creationDate, creator, displayState, errors, errorSeverityLevel, language, priority, requiredDate, revisionDate, revisor, state, targetLanguages, type, workflowStatus, contextRepository, }: TranslationJobConstructorArgs);
     get id(): number | undefined;
     get title(): string | undefined;
     /**
@@ -4764,9 +4999,9 @@ export declare class TranslationJob {
      */
     get configurationItemUri(): ItemUri | undefined;
     /**
-     * Title of the Publication containing the <seealso cref="P:Tridion.TranslationManager.OpenApi.V2.Dto.TranslationJob.ConfigurationItemUri" />.
+     * Link to the Context Repository.
      */
-    get contextPublicationTitle(): string | undefined;
+    get contextRepository(): Link | undefined;
     /**
      * The date the Translation Job was created (in UTC).
      */
@@ -4856,6 +5091,7 @@ export declare interface TranslationJobConstructorArgs {
     targetLanguages: ReadonlyArray<TargetLanguage> | undefined;
     type: ReadonlyArray<TranslationJobType> | undefined;
     workflowStatus: ReadonlyArray<TranslationWorkflowStatus> | undefined;
+    contextRepository: Link | undefined;
 }
 
 /**
@@ -5094,6 +5330,24 @@ export declare type TranslationJobState = 'canceled' | 'definition' | 'readyForT
  */
 export declare type TranslationJobType = 'none' | 'pushJob' | 'pullJob' | 'unknownByClient';
 
+export declare class TranslationResolvedItem {
+    protected _backendModel: TmResolvedItem;
+    private _sourceItem;
+    private _targetLanguages;
+    constructor({ backendModel, sourceItem, targetLanguages }: TranslationResolvedItemConstructorArgs);
+    get isValidForTranslation(): boolean;
+    get comment(): string | undefined;
+    get sourceItem(): RepositoryLocalObject | undefined;
+    get targetLanguages(): ReadonlyArray<TargetLanguage> | undefined;
+    getInternalModel: () => TmResolvedItem;
+}
+
+export declare interface TranslationResolvedItemConstructorArgs {
+    backendModel: TmResolvedItem;
+    sourceItem: RepositoryLocalObject | undefined;
+    targetLanguages: ReadonlyArray<TargetLanguage> | undefined;
+}
+
 /**
  * Represents translation status of an Item.
  *
@@ -5297,6 +5551,16 @@ export declare interface UnpublishInstructionConstructorArgs {
     resolveInstruction: ResolveInstruction | undefined;
 }
 
+declare abstract class Uri {
+    abstract itemId: number | string;
+    abstract asString: string;
+    abstract itemType: EclUriItemType | TcmUriItemType | VirtualUriItemType | 'translationJob';
+    abstract isDynamic: boolean;
+    abstract getPublicationUri(): TcmUri;
+    abstract getUriInPublication(publicationUri: TcmUri): ItemUri;
+    static parse(backendId: string): ItemUri | undefined;
+}
+
 export declare class User extends Trustee {
     protected _backendModel: User_2;
     constructor({ backendModel, ...trusteeArgs }: UserConstructorArgs);
@@ -5667,7 +5931,7 @@ export declare interface VirtualFolderConstructorArgs extends OrganizationalItem
     workflowInfo: WorkflowInfo | undefined;
 }
 
-export declare class VirtualUri {
+export declare class VirtualUri implements Uri {
     private readonly _publicationUri;
     private readonly _itemType;
     private readonly _asString;
@@ -5675,6 +5939,7 @@ export declare class VirtualUri {
     private constructor();
     static create: (publicationUri: TcmUri, itemType: VirtualUriItemType) => VirtualUri;
     static parse: (input: string) => VirtualUri | undefined;
+    get itemId(): string;
     get itemType(): VirtualUriItemType;
     get isDynamic(): boolean;
     get asString(): string;