@tridion-sites/models 1.2.0 → 2.1.0

package/CHANGELOG.md

@@ -1,32 +1,70 @@
 # @tridion-sites/models
 
-## 1.2.0
+## 2.1.0
 
 ### Minor Changes
 
--   ed618c0898: Update ECL regular expression
+- dc46fe7: Update ECL regular expression
+- 9ca3137: Add schemaPurposeMapping
+- 6a7856d: Expose uri prefix
+- dce5ac7: Add `VersionedItem.isHistoricalVersion`, add `RepositoryLocalObject.hasLockType()` and fix some typos
+- 3c68243: Add SearchBlueprintStatus model
+
+### Patch Changes
+
+- Updated dependencies [553decf]
+    - @tridion-sites/open-api-client@4.1.0
+
+## 2.0.1
+
+### Patch Changes
+
+- Fix bug in mapToModel()
+
+## 2.0.0
+
+### Major Changes
+
+- 051b91a: [Breaking!] Models: map `Link`s inside content and metadata
+
+### Minor Changes
+
+- c7a65bc: Update model mapper to fallback to regular component when it can not be distinguished by `ComponentType`
+- 7cf79a9: OpenAPI v3 update
+- d56f8fa: Add `isLocalizable` field
+- 6ff5e58: Add generic `ListInfo` type to `IdentifiableObject`
+- c3ba102: Add `primaryItem` to `ItemBlueprintHierarchy`
+- e514a9a: Add new OpenAPI v3 error type `ValidationApiError`
+
+### Patch Changes
+
+- f1bb40c: Update API comments
+- 1b0165e: Update axios to avoid vulnerability
+- 2532518: Fix default value for `ItemFieldDefinition.isLocalizable` model
+- b4d732a: Update `@tridion/graphene` dependency
+- f1bb40c: Update 3rd party dependencies
 
 ## 1.1.1
 
 ### Patch Changes
 
--   c78d191530: Resolved issue with TranslationJobItem mapping
+- c78d191530: Resolved issue with TranslationJobItem mapping
 
 ## 1.1.0
 
 ### Minor Changes
 
--   14288f4588: add publishing queue related models
+- 14288f4588: add publishing queue related models
 
 ### Patch Changes
 
--   d0875fe171: update dependencies
--   7ff24d55b8: Add LockType and its mapping function
--   334d76210f: Dependency update @tridion/graphene@1.35
--   Updated dependencies [d398729dce]
--   Updated dependencies [b37272386a]
--   Updated dependencies [d0875fe171]
--   Updated dependencies [151fa1d3b2]
--   Updated dependencies [c75025f64f]
--   Updated dependencies [1b257d330c]
-    -   @tridion-sites/open-api-client@3.0.0
+- d0875fe171: update dependencies
+- 7ff24d55b8: Add LockType and its mapping function
+- 334d76210f: Dependency update @tridion/graphene@1.35
+- Updated dependencies [d398729dce]
+- Updated dependencies [b37272386a]
+- Updated dependencies [d0875fe171]
+- Updated dependencies [151fa1d3b2]
+- Updated dependencies [c75025f64f]
+- Updated dependencies [1b257d330c]
+    - @tridion-sites/open-api-client@3.0.0

package/dist/index.d.ts

@@ -598,10 +598,6 @@ export declare class ApprovalStatus extends SystemWideObject {
 export declare interface ApprovalStatusConstructorArgs extends SystemWideObjectConstructorArgs {
 }
 
-export declare type BackendIdentifiableTranslationJob = TranslationJob_2 & {
-    Id: string;
-};
-
 export declare interface BackendValidationApiError extends ApiError_2 {
     body: BackendValidationApiErrorBody;
 }
@@ -1480,7 +1476,7 @@ export declare interface DynamicVersionInfoConstructorArgs {
     revisionDate: Date | undefined;
 }
 
-export declare class EclUri implements Uri {
+export declare class EclUri {
     /**
      * Id of the Tridion Publication this EclUri belongs to.
      */
@@ -1999,145 +1995,6 @@ 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;
-    constructor({ addedItems, backendModel, configurationItemUri, creationDate, creator, displayState, errors, errorSeverityLevel, language, priority, requiredDate, revisionDate, revisor, state, targetLanguages, type, workflowStatus, ...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;
-    /**
-     * Title of the Publication containing the <seealso cref="P:Tridion.TranslationManager.OpenApi.V2.Dto.TranslationJob.ConfigurationItemUri" />.
-     */
-    get contextPublicationTitle(): string | 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;
-}
-
 export declare const isRloNode: (node: ItemBlueprintNode) => node is BlueprintReadonlyGraphNode<ReadonlyItemBlueprintRloNodeData>;
 
 export declare class ItemBlueprintHierarchy {
@@ -2306,7 +2163,7 @@ export declare const itemType: {
 
 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 type ItemUri = TcmUri | EclUri | VirtualUri | TmUri;
+export declare type ItemUri = TcmUri | EclUri | VirtualUri;
 
 /**
  * Represents the data of a Keyword used to classify items.
@@ -4453,7 +4310,7 @@ export declare interface TaxonomiesConstructorArgs extends OrganizationalItemCon
  *
  * The structure of a TCM URI is PublicationID-ItemID[-ItemType][-vVersion].
  */
-export declare class TcmUri implements Uri {
+export declare class TcmUri {
     private readonly _publicationId;
     private readonly _itemId;
     private readonly _itemType;
@@ -4667,42 +4524,6 @@ 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.
  */
@@ -5476,16 +5297,6 @@ 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);
@@ -5856,7 +5667,7 @@ export declare interface VirtualFolderConstructorArgs extends OrganizationalItem
     workflowInfo: WorkflowInfo | undefined;
 }
 
-export declare class VirtualUri implements Uri {
+export declare class VirtualUri {
     private readonly _publicationUri;
     private readonly _itemType;
     private readonly _asString;
@@ -5864,7 +5675,6 @@ export declare class VirtualUri implements Uri {
     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;