@tridion-sites/models 0.1.4 → 1.1.0

package/CHANGELOG.md

@@ -1,68 +1,20 @@
 # @tridion-sites/models
 
-## 0.1.4
-
-### Patch Changes
-
--   54439b54a7: removed links to internal systems, added readme files
--   Updated dependencies [54439b54a7]
-    -   @tridion-sites/open-api-client@1.0.6
-
-## 0.1.3
-
-### Patch Changes
-
--   be9284a536: rename a property
-
-## 0.1.2
-
-### Patch Changes
-
--   b803ef7b33: Fake models now have special creation functions
--   9b78d6d626: upgrade dependencies
--   31bdf04adf: fixed VersionedItem isNew behavior
-
-## 0.1.1
-
-### Patch Changes
-
--   226cc4cce1: Additional info for Taxonomies model is added
--   1845a12377: use the latest typescript version
--   Updated dependencies [1845a12377]
-    -   @tridion-sites/open-api-client@1.0.5
-
-## 0.1.0
+## 1.1.0
 
 ### Minor Changes
 
--   Set of small improvements and fixes to the extensions framework
-
-## 0.0.5
-
-### Patch Changes
-
--   update packages
-
-## 0.0.4
-
-### Patch Changes
-
--   include node_modules into the build
-
-## 0.0.3
-
-### Patch Changes
-
--   include node_modules into the build
-
-## 0.0.2
+-   14288f4588: add publishing queue related models
 
 ### Patch Changes
 
--   release new package version for extensions, extensions-cli, models, open-api-client
--   c616d80f3c: fixed circular dependencies in @tridion-sites/models
--   117e9e5f76: Models package became public
--   Updated dependencies
--   Updated dependencies [0738aa9ac3]
--   Updated dependencies [ff20566f80]
-    -   @tridion-sites/open-api-client@1.0.4
+-   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

@@ -72,6 +72,7 @@ import type { ListDefinition as ListDefinition_2 } from '@tridion-sites/open-api
 import type { LoadInfo as LoadInfo_2 } from '@tridion-sites/open-api-client';
 import type { LocationInfo as LocationInfo_2 } from '@tridion-sites/open-api-client';
 import type { LockInfo as LockInfo_2 } from '@tridion-sites/open-api-client';
+import { LockType as LockType_2 } from '@tridion-sites/open-api-client';
 import type { MultiLineTextFieldDefinition as MultiLineTextFieldDefinition_2 } from '@tridion-sites/open-api-client';
 import type { MultimediaLinkFieldDefinition as MultimediaLinkFieldDefinition_2 } from '@tridion-sites/open-api-client';
 import type { MultimediaType as MultimediaType_2 } from '@tridion-sites/open-api-client';
@@ -82,19 +83,26 @@ import type { Page as Page_2 } from '@tridion-sites/open-api-client';
 import type { PageTemplate as PageTemplate_2 } from '@tridion-sites/open-api-client';
 import type { Process as Process_2 } from '@tridion-sites/open-api-client';
 import type { ProcessDefinition as ProcessDefinition_2 } from '@tridion-sites/open-api-client';
+import type { ProcessedItem as ProcessedItem_2 } from '@tridion-sites/open-api-client';
 import type { ProcessHistory as ProcessHistory_2 } from '@tridion-sites/open-api-client';
 import type { ProcessInstance as ProcessInstance_2 } from '@tridion-sites/open-api-client';
 import type { Publication as Publication_2 } from '@tridion-sites/open-api-client';
+import type { PublishContext as PublishContext_2 } from '@tridion-sites/open-api-client';
 import type { PublishInfo as PublishInfo_2 } from '@tridion-sites/open-api-client';
 import type { PublishingTarget as PublishingTarget_2 } from '@tridion-sites/open-api-client';
+import type { PublishInstructionBase as PublishInstructionBase_2 } from '@tridion-sites/open-api-client';
 import type { PublishLocationInfo as PublishLocationInfo_2 } from '@tridion-sites/open-api-client';
 import { PublishPriority as PublishPriority_2 } from '@tridion-sites/open-api-client';
+import type { PublishTransaction as PublishTransaction_2 } from '@tridion-sites/open-api-client';
 import type { PublishTransactionsCreationResult as PublishTransactionsCreationResult_2 } from '@tridion-sites/open-api-client';
+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 { 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';
+import type { ResolveInstruction as ResolveInstruction_2 } from '@tridion-sites/open-api-client';
+import type { ResolveInstructionBase as ResolveInstructionBase_2 } from '@tridion-sites/open-api-client';
 import { RetrieveReason as RetrieveReason_2 } from '@tridion-sites/open-api-client';
 import { RLOItemType } from '@tridion-sites/open-api-client';
 import type { Schema as Schema_2 } from '@tridion-sites/open-api-client';
@@ -129,6 +137,7 @@ import { TranslationStatus as TranslationStatus_2 } from '@tridion-sites/open-ap
 import type { TridionActivityDefinition as TridionActivityDefinition_2 } from '@tridion-sites/open-api-client';
 import type { TridionProcessDefinition as TridionProcessDefinition_2 } from '@tridion-sites/open-api-client';
 import type { Trustee as Trustee_2 } from '@tridion-sites/open-api-client';
+import type { UnPublishInstruction } from '@tridion-sites/open-api-client';
 import type { User as User_2 } from '@tridion-sites/open-api-client';
 import type { UserLocaleInfo as UserLocaleInfo_2 } from '@tridion-sites/open-api-client';
 import type { UserPreferences as UserPreferences_2 } from '@tridion-sites/open-api-client';
@@ -216,6 +225,7 @@ export declare class AccessToken extends User {
      * Dictionary containing "SystemPrivilege" and link "Group" associations.
      */
     get inheritedSystemPrivileges(): SystemPrivilegesDictionary | undefined;
+    hasInheritedSystemPrivilege(systemPrivilege: SystemPrivilegeName): boolean;
     /**
      * Signature value for this token to prevent modifying any of its properties outside of the CM system.
      */
@@ -1359,6 +1369,18 @@ export declare interface DateListDefinitionConstructorArgs extends ListDefinitio
     entries: ReadonlyArray<Date> | undefined;
 }
 
+/**
+ * Represents the action the deployer needs to take.
+ *
+ * Members:
+ * * `commit` - The deployer should commit the transport package.
+ * * `wait` - The deployer should wait to commit the transport package.
+ * * `abort` - The deployer should abort the transport package.
+ * * `unknownByClient` - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version.
+ * Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.
+ */
+export declare type DeployerAction = 'commit' | 'wait' | 'abort' | 'unknownByClient';
+
 export declare const determineBatchStatus: (operations: ReadonlyArray<BatchOperation>) => BatchStatus;
 
 /**
@@ -2449,8 +2471,12 @@ export declare const mapActivityStateToBackend: (model: ActivityState) => Activi
 
 export declare const mapBatchOperationState: (backendModel: BatchOperationState_2) => BatchOperationState;
 
+export declare const mapLockTypeToBackend: (model: LockType) => LockType_2;
+
 export declare const mapPublishPriorityToBackend: (model: PublishPriority) => PublishPriority_2;
 
+export declare const mapPublishTransactionStateToBackend: (model: PublishTransactionState) => PublishTransactionState_2;
+
 export declare const mapRetrieveReasonToBackend: (backendModel: RetrieveReason) => RetrieveReason_2;
 
 export declare const mapRloItemTypeToBackend: (rloItemType: RloItemType) => RLOItemType;
@@ -2854,6 +2880,39 @@ export declare interface ProcessDefinitionConstructorArgs extends RepositoryLoca
     activityDefinitions: ReadonlyArray<ActivityDefinition> | undefined;
 }
 
+export declare class ProcessedItem {
+    protected _backendModel: ProcessedItem_2;
+    private _resolvedItem;
+    constructor({ backendModel, resolvedItem }: ProcessedItemConstructorArgs);
+    /**
+     * A value indicating whether the item failed rendering.
+     */
+    get hasRenderFailure(): boolean | undefined;
+    /**
+     * A value indicating whether the item has been fully rendered.
+     */
+    get isRendered(): boolean | undefined;
+    /**
+     * The reason of failure of the rendering process.
+     */
+    get reasonOfRenderFailure(): string | undefined;
+    /**
+     * The duration of the rendering process for the processed item.
+     * The render time formatted as a string: HH:MM:SS
+     */
+    get renderTime(): string | undefined;
+    /**
+     * The "ResolvedItem" for which this instance stores additional rendering information.
+     */
+    get resolvedItem(): ResolvedItem | undefined;
+    getInternalModel: () => ProcessedItem_2;
+}
+
+export declare interface ProcessedItemConstructorArgs {
+    backendModel: ProcessedItem_2;
+    resolvedItem: ResolvedItem | undefined;
+}
+
 /**
  * Defines the reason a Process is going to be finished or has finished already.
  *
@@ -3019,6 +3078,40 @@ export declare interface PublicationConstructorArgs extends RepositoryConstructo
     templateBundleProcess: Link | undefined;
 }
 
+export declare class PublishContext {
+    protected _backendModel: PublishContext_2;
+    private _processedItems;
+    private _publication;
+    private _resolvedItems;
+    private _targetType;
+    constructor({ backendModel, processedItems, publication, resolvedItems, targetType, }: PublishContextConstructorArgs);
+    /**
+     * A collection of processed items.
+     */
+    get processedItems(): Array<ProcessedItem> | undefined;
+    /**
+     * The Publication which this Publish Context belongs to.
+     */
+    get publication(): Link | undefined;
+    /**
+     * A collection of Resolved Items in this Publish Context.
+     */
+    get resolvedItems(): Array<ResolvedItem> | undefined;
+    /**
+     * The Target Type which this Publish Context belongs to.
+     */
+    get targetType(): Link | undefined;
+    getInternalModel: () => PublishContext_2;
+}
+
+export declare interface PublishContextConstructorArgs {
+    backendModel: PublishContext_2;
+    processedItems: Array<ProcessedItem> | undefined;
+    publication: Link | undefined;
+    resolvedItems: Array<ResolvedItem> | undefined;
+    targetType: Link | undefined;
+}
+
 /**
  * Represents publishing information for Repository local objects.
  */
@@ -3080,6 +3173,38 @@ export declare abstract class PublishingTarget extends SystemWideObject {
 export declare interface PublishingTargetConstructorArgs extends SystemWideObjectConstructorArgs {
 }
 
+export declare class PublishInstruction extends PublishInstructionBase {
+    protected _backendModel: UnPublishInstruction;
+    private _deployAt;
+    private _resolveInstruction;
+    constructor({ backendModel, deployAt, resolveInstruction }: PublishInstructionConstructorArgs);
+    /**
+     * Date and time when the content should be deployed at the content delivery side.
+     * Should be specified in UTC, for example: "2022-01-01T12:00:00:00Z".
+     */
+    get deployAt(): Date | undefined;
+    /**
+     * Represents the instructions needed for resolving.
+     */
+    get resolveInstruction(): ResolveInstruction | undefined;
+    getInternalModel: () => UnPublishInstruction;
+}
+
+/**
+ * Represents the instructions needed for (un)publishing an item.
+ */
+export declare abstract class PublishInstructionBase {
+    protected _backendModel: PublishInstructionBase_2;
+    constructor(backendModel: PublishInstructionBase_2);
+    getInternalModel: () => PublishInstructionBase_2;
+}
+
+export declare interface PublishInstructionConstructorArgs {
+    backendModel: UnPublishInstruction;
+    deployAt: Date | undefined;
+    resolveInstruction: ResolveInstruction | undefined;
+}
+
 /**
  * Represents a publishing location information for the objects that reside in Structure Groups.
  */
@@ -3122,6 +3247,100 @@ export declare interface PublishLocationInfoConstructorArgs extends LocationInfo
  */
 export declare type PublishPriority = 'low' | 'normal' | 'high';
 
+export declare class PublishTransaction extends SystemWideObject {
+    protected _backendModel: PublishTransaction_2;
+    private _creator;
+    private _deployerAction;
+    private _instruction;
+    private _items;
+    private _priority;
+    private _publishContexts;
+    private _state;
+    private _targetType;
+    private _stateChangeDateTime;
+    constructor({ backendModel, creator, deployerAction, instruction, items, priority, publishContexts, state, targetType, stateChangeDateTime, ...systemWideObjectConstructorArgs }: PublishTransactionConstructorArgs);
+    /**
+     * Gets a value indicating whether one of the "PublishContext.ProcessedItems" in this instance has render failures.
+     */
+    get hasRenderFailures(): boolean | undefined;
+    /**
+     * Information about this publish transaction.
+     */
+    get information(): string | undefined;
+    /**
+     * Value whether the publishing of the "PublishTransaction" is finished.This property is set to true when the transaction is in the one of the final states: "PublishTransactionState.Success", "PublishTransactionState.Failed",
+     * "PublishTransactionState.Warning"; otherwise, false.
+     */
+    get isCompleted(): boolean | undefined;
+    /**
+     * Name of the server with Publisher service that handles current "PublishTransaction".The value of this property is available after a Publisher has started processing this publish transaction and is an unqualified (domainless) server name. Prior to that the value of this property is null.
+     */
+    get publisherHost(): string | undefined;
+    /**
+     * Time span which was spent to render "PublishTransaction".The value of this property is available after a Publisher has finished rendering of the publish transaction.
+     */
+    get renderingTime(): string | undefined;
+    /**
+     * Time span which was spent to resolve items for "PublishTransaction".The value of this property is available after a Publisher has finished resolving of the items to be published for the publish transaction.
+     */
+    get resolvingTime(): string | undefined;
+    /**
+     * Date and time in UTC when the last state change occurred.
+     */
+    get stateChangeDateTime(): Date | undefined;
+    /**
+     * Time span which was spent for publishing "PublishTransaction".The value of this property is available after publish transaction gets to the one of the final states
+     * ("PublishTransactionState.success", "PublishTransactionState.warning", "PublishTransactionState.failed").
+     */
+    get totalExecutionTime(): string | undefined;
+    /**
+     * User that created this "PublishTransaction" by publishing item(s).
+     */
+    get creator(): Link | undefined;
+    /**
+     * Action the deployer should take.
+     */
+    get deployerAction(): DeployerAction | undefined;
+    /**
+     * Instruction of this instance.
+     */
+    get instruction(): PublishInstructionBase | undefined;
+    /**
+     * Collection of items that need to be published or unpublished.
+     */
+    get items(): ReadonlyArray<Link> | undefined;
+    /**
+     * Priority of this instance. It can be one of three values: low, normal or high. Transactions are executed according to this priority.
+     */
+    get priority(): PublishPriority | undefined;
+    /**
+     * Collection of publish contexts that indicates where to publish/unpublish to.
+     */
+    get publishContexts(): ReadonlyArray<PublishContext> | undefined;
+    /**
+     * State of this instance.
+     */
+    get state(): PublishTransactionState | undefined;
+    /**
+     * Target Type for this Publish Transaction.This property might be null if associated Publication Target has none or more than one Target Type.
+     */
+    get targetType(): Link | undefined;
+    getInternalModel: () => PublishTransaction_2;
+}
+
+export declare interface PublishTransactionConstructorArgs extends SystemWideObjectConstructorArgs {
+    backendModel: PublishTransaction_2;
+    creator: Link | undefined;
+    deployerAction: DeployerAction | undefined;
+    instruction: PublishInstructionBase | undefined;
+    items: ReadonlyArray<Link> | undefined;
+    priority: PublishPriority | undefined;
+    publishContexts: ReadonlyArray<PublishContext> | undefined;
+    state: PublishTransactionState | undefined;
+    targetType: Link | undefined;
+    stateChangeDateTime: Date | undefined;
+}
+
 export declare class PublishTransactionsCreationResult {
     protected _backendModel: PublishTransactionsCreationResult_2;
     private _publishTransactionIds;
@@ -3135,6 +3354,8 @@ export declare interface PublishTransactionsCreationResultConstructorArgs {
     publishTransactionIds: ReadonlyArray<ItemUri> | undefined;
 }
 
+export declare type PublishTransactionState = 'scheduledForPublish' | 'waitingForPublish' | 'inProgress' | 'scheduledForDeployment' | 'waitingForDeployment' | 'failed' | 'success' | 'warning' | 'resolving' | 'rendering' | 'throttled' | 'readyForTransport' | 'transporting' | 'deploying' | 'preparingDeployment' | 'preCommittingDeployment' | 'committingDeployment' | 'waitingForCdEnvironment' | 'unknownByClient';
+
 export declare class PublishUrlInfo {
     protected _backendModel: PublishUrlInfo_2;
     constructor(backendModel: PublishUrlInfo_2);
@@ -3292,6 +3513,62 @@ export declare interface ResolvedItemConstructorArgs {
     template: Link | undefined;
 }
 
+export declare class ResolveInstruction extends ResolveInstructionBase {
+    protected _backendModel: ResolveInstruction_2;
+    constructor({ backendModel, ...resolveInstructionBaseConstructorArgs }: ResolveInstructionConstructorArgs);
+    /**
+     * Value indicating whether component links should also be resolved.
+     */
+    get includeComponentLinks(): boolean | undefined;
+    /**
+     * Value indicating whether dynamic version of the item will be resolved.
+     */
+    get includeDynamicVersion(): boolean | undefined;
+    /**
+     * Value indicating whether the item is published from the user's work list.
+     */
+    get includeWorkflow(): boolean | undefined;
+    /**
+     * Value indicating whether already published items should be published.
+     */
+    get publishNewContent(): boolean | undefined;
+    getInternalModel: () => ResolveInstruction_2;
+}
+
+export declare abstract class ResolveInstructionBase {
+    protected _backendModel: ResolveInstructionBase_2;
+    private _structureResolveOption;
+    private _publishInChildPublications;
+    constructor({ backendModel, structureResolveOption, publishInChildPublications, }: ResolveInstructionBaseConstructorArgs);
+    /**
+     * Value indicating whether to resolve items also from all child Publications where user has PublishManagement rights.
+     */
+    get includeChildPublications(): boolean | undefined;
+    /**
+     * Value indicating whether items will be (un)published inside the current Publication.
+     */
+    get includeCurrentPublication(): boolean | undefined;
+    /**
+     * Value indicating the option to include the resolved items and/or structure.
+     */
+    get structureResolveOption(): StructureResolveOption | undefined;
+    /**
+     * Collection of TCM URIs of child Publications where items will be (un)published.
+     */
+    get publishInChildPublications(): ReadonlyArray<ItemUri> | undefined;
+    getInternalModel: () => ResolveInstructionBase_2;
+}
+
+export declare interface ResolveInstructionBaseConstructorArgs {
+    backendModel: ResolveInstructionBase_2;
+    structureResolveOption: StructureResolveOption | undefined;
+    publishInChildPublications: ReadonlyArray<ItemUri> | undefined;
+}
+
+export declare interface ResolveInstructionConstructorArgs extends ResolveInstructionBaseConstructorArgs {
+    backendModel: ResolveInstruction_2;
+}
+
 /**
  * Defines which Items will be included in the Translation Job for an .
  *
@@ -3666,10 +3943,12 @@ export declare class SystemPrivilege {
     getInternalModel: () => SystemPrivilege_2;
 }
 
+export declare type SystemPrivilegeName = 'tcm:ApprovalStatusManagement' | 'tcm:ChildPublicationCreation' | 'tcm:GroupManagement' | 'tcm:MultimediaTypeManagement' | 'tcm:PublishTransactionManagement' | 'tcm:SystemAdministration' | 'tcm:SystemPrivilegeManagement' | 'ttm:TopologyManagementReadPrivilege';
+
 /**
  * Represents a dictionary of the system-wide privilege keys associations with a collection of the Group's link.
  */
-export declare type SystemPrivilegesDictionary = Record<string, ReadonlyArray<Link>>;
+export declare type SystemPrivilegesDictionary = Record<SystemPrivilegeName, ReadonlyArray<Link>>;
 
 /**
  * Abstract base class for the data of all system-wide objects.
@@ -4802,6 +5081,30 @@ export declare const tryMapToModel: <T>(backendItem: any) => T | undefined;
 
 export declare const tryParseItemUri: (backendId: string) => ItemUri | undefined;
 
+export declare class UnpublishInstruction extends PublishInstructionBase {
+    protected _backendModel: UnPublishInstruction;
+    private _startAt;
+    private _resolveInstruction;
+    constructor({ backendModel, startAt, resolveInstruction }: UnpublishInstructionConstructorArgs);
+    /**
+     * Date and time when the un-publishing should be started. Should be specified in UTC format.
+     * The value will be converted to UTC time if specified with time zone shift, e.g. "2020-01-24T17:24:50+02:00" will be converted to "2020-01-24T15:24:50Z"
+     * Conversion is not happening if time zone shift is not specified.
+     */
+    get startAt(): Date | undefined;
+    /**
+     * Represents the instructions needed for resolving.
+     */
+    get resolveInstruction(): ResolveInstruction | undefined;
+    getInternalModel: () => UnPublishInstruction;
+}
+
+export declare interface UnpublishInstructionConstructorArgs {
+    backendModel: UnPublishInstruction;
+    startAt: Date | undefined;
+    resolveInstruction: ResolveInstruction | undefined;
+}
+
 export declare class User extends Trustee {
     protected _backendModel: User_2;
     constructor({ backendModel, ...trusteeArgs }: UserConstructorArgs);