@tridion-sites/models 1.2.0 → 2.1.0

package/dist/dts/models/workflow/processDefinition.d.ts

@@ -1,23 +0,0 @@
-import type { ProcessDefinition as BackendProcessDefinition } from '@tridion-sites/open-api-client';
-import type { RepositoryLocalObjectConstructorArgs } from '../repositoryLocalObject';
-import { RepositoryLocalObject } from '../repositoryLocalObject';
-import type { ActivityDefinition } from './activityDefinition';
-export interface ProcessDefinitionConstructorArgs extends RepositoryLocalObjectConstructorArgs {
-    backendModel: BackendProcessDefinition;
-    activityDefinitions: ReadonlyArray<ActivityDefinition> | undefined;
-}
-export declare class ProcessDefinition extends RepositoryLocalObject {
-    protected _backendModel: BackendProcessDefinition;
-    private _activityDefinitions;
-    constructor({ backendModel, activityDefinitions, ...rloArgs }: ProcessDefinitionConstructorArgs);
-    /**
-     * The first Activity Definition specified in this collection is the one that will be used
-     * to create the first Activity Instance of the workflow.
-     */
-    get activityDefinitions(): ReadonlyArray<ActivityDefinition> | undefined;
-    /**
-     * A value indicating whether Process Instances based on this Process Definition store snapshots.
-     */
-    get storeSnapshot(): boolean;
-    getInternalModel: () => BackendProcessDefinition;
-}

package/dist/dts/models/workflow/processFinishReason.d.ts

@@ -1,12 +0,0 @@
-/**
- * Defines the reason a Process is going to be finished or has finished already.
- *
- * * `completedNormally` - Identifies if the process has finished normally.
- * * `forceFinished` - Identifies if the process was forcefully finished.
- * * `terminated` - Identifies if the process was terminated.
- * * `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 type ProcessFinishReason = 'completedNormally' | 'forceFinished' | 'terminated' | 'unknownByClient';

package/dist/dts/models/workflow/processHistory.d.ts

@@ -1,31 +0,0 @@
-import type { ProcessHistory as BackendProcessHistory } from '@tridion-sites/open-api-client';
-import type { ProcessConstructorArgs } from './process';
-import { Process } from './process';
-import type { ProcessFinishReason } from './processFinishReason';
-export interface ProcessHistoryConstructorArgs extends ProcessConstructorArgs {
-    backendModel: BackendProcessHistory;
-    finishReason: ProcessFinishReason | undefined;
-    finishDate: Date | undefined;
-}
-/**
- * Representing data of a Process History.
- */
-export declare class ProcessHistory extends Process {
-    protected _backendModel: BackendProcessHistory;
-    private _finishReason;
-    private _finishDate;
-    constructor({ backendModel, finishReason, finishDate, ...processArgs }: ProcessHistoryConstructorArgs);
-    /**
-     * Finish date and time in UTC of the Activity.
-     */
-    get finishDate(): Date | undefined;
-    /**
-     * Finish Reason of the Activity.
-     */
-    get finishReason(): ProcessFinishReason | undefined;
-    /**
-     * Process Definition Title of the Activity.
-     */
-    get processDefinitionTitle(): string | undefined;
-    getInternalModel: () => BackendProcessHistory;
-}

package/dist/dts/models/workflow/processInstance.d.ts

@@ -1,26 +0,0 @@
-import type { ProcessInstance as BackendProcessInstance } from '@tridion-sites/open-api-client';
-import type { Link } from '../links';
-import type { ProcessConstructorArgs } from './process';
-import { Process } from './process';
-import type { VariablesDictionary } from './variablesDictionary';
-export interface ProcessInstanceConstructorArgs extends ProcessConstructorArgs {
-    backendModel: BackendProcessInstance;
-    processDefinition: Link | undefined;
-}
-/**
- * Represents the data of a Process Instance: a current Process.
- */
-export declare class ProcessInstance extends Process {
-    protected _backendModel: BackendProcessInstance;
-    private _processDefinition;
-    constructor({ backendModel, processDefinition, ...processArgs }: ProcessInstanceConstructorArgs);
-    /**
-     * Process Definition on which the Process Instance is based.
-     */
-    get processDefinition(): Link | undefined;
-    /**
-     * The variable collection containing data shared between Process Instance activities.
-     */
-    get variables(): VariablesDictionary | undefined;
-    getInternalModel: () => BackendProcessInstance;
-}

package/dist/dts/models/workflow/tridionActivityDefinition.d.ts

@@ -1,76 +0,0 @@
-import type { TridionActivityDefinition as BackendTridionActivityDefinition } from '@tridion-sites/open-api-client';
-import type { Link } from '../links';
-import type { ActivityDefinitionConstructorArgs } from './activityDefinition';
-import { ActivityDefinition } from './activityDefinition';
-import type { ActivityType } from './activityType';
-export interface TridionActivityDefinitionConstructorArgs extends ActivityDefinitionConstructorArgs {
-    backendModel: BackendTridionActivityDefinition;
-    activityType: ActivityType | undefined;
-    finishApprovalStatus: Link | undefined;
-    nextActivityDefinitions: ReadonlyArray<Link> | undefined;
-}
-/**
- * Represents the data of a Tridion proprietary Activity Definition.
- */
-export declare class TridionActivityDefinition extends ActivityDefinition {
-    protected _backendModel: BackendTridionActivityDefinition;
-    private _activityType;
-    private _finishApprovalStatus;
-    private _nextActivityDefinitions;
-    constructor({ backendModel, activityType, finishApprovalStatus, nextActivityDefinitions, ...activityDefinitionArgs }: TridionActivityDefinitionConstructorArgs);
-    /**
-     * A value indicating whether this instance represents a decision or not.
-     */
-    get activityType(): ActivityType | undefined;
-    /**
-     * A value indicating whether "Activity.DueDate" can be changed manually, or not.
-     * true if "Activity.DueDate" can be changed manually otherwise, false.
-     */
-    get allowOverrideDueDate(): boolean;
-    /**
-     * A string that contains CSharp code.
-     * When "PerformingTimeout" is set, Workflow agent executes this script to expire the Activity.
-     */
-    get expirationScript(): string | undefined;
-    /**
-     * The value must be the name of one of the configured Workflow script types.
-     */
-    get expirationScriptType(): string | undefined;
-    /**
-     * Approval Status that is assigned to the Workflow Item when the Activity finishes.
-     */
-    get finishApprovalStatus(): Link | undefined;
-    /**
-     * Potential next activities in the Workflow.
-     * Will be undefined if the Activity Definition is read stand-alone. In the context of a Process Definition it will be set.
-     *
-     * The collection should be empty if this represents the last activity or it should contain exactly one activity, unless this represents a decision.
-     * Note that the next activity should be identified (linked) by title, not by Id.
-     */
-    get nextActivityDefinitions(): ReadonlyArray<Link> | undefined;
-    /**
-     * The timeout for performing current activity, in minutes.
-     * If value for this property set, default value for "Activity.DueDate" will be set, during creating instance of this activity definition.
-     */
-    get performingTimeout(): number | undefined;
-    /**
-     * Script of an automated Activity.
-     * A string that contains CSharp code.
-     *
-     * An Activity Definition can represent an automated activity to which a script is associated.
-     * This script is then executed by the TCM Workflow Agent once the workflow process reaches the activity.
-     *
-     * When you create a Process Definition, you can define an automatic Activity Definition simply by setting
-     * the Script property. You don't need to explicitly specify the "ActivityDefinition.Assignee", it will be
-     * automatically set to the TCM Workflow Agent during the creation of the Process Definition.
-     *
-     * The TCM Workflow Agent user is declared in the TCM configuration in the workflow section as the following example illustrates:
-     * @example &lt;configuration&gt; &lt;workflow workflowAgentAccountUri="tcm:0-3-65552" /&gt; &lt;/configuration&gt;
-     */
-    get script(): string | undefined;
-    /**
-     * The value must be the name of one of the configured Workflow script types.
-     */
-    get scriptType(): string | undefined;
-    getInternalModel: () => BackendTridionActivityDefinition;
-}

package/dist/dts/models/workflow/tridionProcessDefinition.d.ts

@@ -1,19 +0,0 @@
-import type { TridionProcessDefinition as BackendTridionProcessDefinition } from '@tridion-sites/open-api-client';
-import type { ProcessDefinitionConstructorArgs } from './processDefinition';
-import { ProcessDefinition } from './processDefinition';
-export interface TridionProcessDefinitionConstructorArgs extends ProcessDefinitionConstructorArgs {
-    backendModel: BackendTridionProcessDefinition;
-}
-/**
- * Represents the data of a Tridion proprietary Process Definition.
- */
-export declare class TridionProcessDefinition extends ProcessDefinition {
-    protected _backendModel: BackendTridionProcessDefinition;
-    constructor(tridionProcessDefinitionArgs: TridionProcessDefinitionConstructorArgs);
-    /**
-     * Binary representation of the Diagram of the Activity Definition.
-     * A Microsoft Visio diagram, or an empty byte array.
-     */
-    get diagram(): string | undefined;
-    getInternalModel: () => BackendTridionProcessDefinition;
-}

package/dist/dts/models/workflow/variablesDictionary.d.ts

@@ -1,4 +0,0 @@
-/**
- * Represents multiple sets of variables grouped by name.
- */
-export type VariablesDictionary = Record<string, string>;

package/dist/dts/models/workflow/workItem.d.ts

@@ -1,60 +0,0 @@
-import type { WorkItem as BackendWorkItem } from '@tridion-sites/open-api-client';
-import type { Link } from '../links';
-import type { WorkflowObjectConstructorArgs } from './workflowObject';
-import { WorkflowObject } from './workflowObject';
-export interface WorkflowItemConstructorArgs extends WorkflowObjectConstructorArgs {
-    backendModel: BackendWorkItem;
-    activity: Link | undefined;
-    owner: Link | undefined;
-    process: Link | undefined;
-    subject: Link | undefined;
-    subjectOwningRepository: Link | undefined;
-}
-/**
- * Represents the data of a Work Item: the association between an item participating in workflow and an Activity.
- */
-export declare class WorkItem extends WorkflowObject {
-    protected _backendModel: BackendWorkItem;
-    private _activity;
-    private _owner;
-    private _process;
-    private _subject;
-    private _subjectOwningRepository;
-    constructor({ backendModel, activity, owner, process, subject, subjectOwningRepository, ...workflowObjectArgs }: WorkflowItemConstructorArgs);
-    /**
-     * Activity which contains the Work Item.
-     * If the Work Item is read in context of the Activity, the value is undefined.
-     * The value is only set if the Work Item is read stand-alone.
-     */
-    get activity(): Link | undefined;
-    /**
-     * Work Item comments can be used to communicate between workflow participants. It does not have meaning for the CM system itself.
-     * When an Activity is finished, its Work Item comments are carried over to the next Activity.
-     */
-    get comment(): string | undefined;
-    /**
-     * User who owns the Work Item.
-     *
-     * The owner of the Work Item can view/edit the "Subject".
-     * The owners of all Work Items of an Activity
-     * are called the "Workflow.Activity.Performers" of the Activity.
-     * In the future, each Work Item can have different Owner hence the Activity may have multiple Performers.
-     */
-    get owner(): Link | undefined;
-    /**
-     * Process which contains the Work Item.
-     *
-     * If the Work Item is read in context of the Process, the value is undefined
-     * The value is only set if the Work Item is read stand-alone.
-     */
-    get process(): Link | undefined;
-    /**
-     * The item participating in the workflow.
-     */
-    get subject(): Link | undefined;
-    /**
-     * Owning Repository of the Subject.
-     */
-    get subjectOwningRepository(): Link | undefined;
-    getInternalModel: () => BackendWorkItem;
-}

package/dist/dts/models/workflow/workflowInfo.d.ts

@@ -1,91 +0,0 @@
-import type { WorkflowInfo as BackendWorkflowInfo } from '@tridion-sites/open-api-client';
-import type { Link } from '../links';
-import type { ActivityConstraints } from './activityConstraints';
-import type { ActivityState } from './activityState';
-export interface WorkflowInfoConstructorArgs {
-    backendModel: BackendWorkflowInfo;
-    activityConstraints: ActivityConstraints | undefined;
-    activityInstance: Link | undefined;
-    activityState: ActivityState | undefined;
-    assignee: Link | undefined;
-    performer: Link | undefined;
-    processInstance: Link | undefined;
-    assignmentDate: Date | undefined;
-    dueDate: Date | undefined;
-    finishDate: Date | undefined;
-    startDate: Date | undefined;
-    creationDate: Date | undefined;
-}
-/**
- * Represents workflow-related information for items that can participate in a workflow process.
- */
-export declare class WorkflowInfo {
-    protected _backendModel: BackendWorkflowInfo;
-    private _activityConstraints;
-    private _activityInstance;
-    private _activityState;
-    private _assignee;
-    private _performer;
-    private _processInstance;
-    private _assignmentDate;
-    private _dueDate;
-    private _finishDate;
-    private _startDate;
-    private _creationDate;
-    constructor({ activityConstraints, activityInstance, activityState, assignee, assignmentDate, backendModel, dueDate, finishDate, performer, processInstance, startDate, creationDate, }: WorkflowInfoConstructorArgs);
-    /**
-     * Constraints of the current activity.
-     */
-    get activityConstraints(): ActivityConstraints | undefined;
-    /**
-     * Activity Definition Description of the current Activity Instance.
-     */
-    get activityDefinitionDescription(): string | undefined;
-    /**
-     * Activity Instance in which the item is currently participating (if any).
-     */
-    get activityInstance(): Link | undefined;
-    /**
-     * State of the current Activity Instance.
-     */
-    get activityState(): ActivityState | undefined;
-    /**
-     * Assignee of the current Activity Instance.
-     */
-    get assignee(): Link | undefined;
-    /**
-     * The most recent assigned/re-assigned date and time in UTC of the current Activity Instance.
-     *
-     * Initially, the Assignment date and Creation date are the same, upon re-assign of the activity this is updated to time the operation was performed.
-     */
-    get assignmentDate(): Date | undefined;
-    /**
-     * Creation date and time in UTC of the current Activity Instance.
-     */
-    get creationDate(): Date | undefined;
-    /**
-     * Due date and time in UTC of the current Activity Instance if any.
-     */
-    get dueDate(): Date | undefined;
-    /**
-     * Finish date and time in UTC of the last Activity Instance.
-     */
-    get finishDate(): Date | undefined;
-    /**
-     * Performer of the current Activity Instance.
-     */
-    get performer(): Link | undefined;
-    /**
-     * Finish message of the last Activity Instance.
-     */
-    get previousMessage(): string | undefined;
-    /**
-     * Process Instance in which the item is currently participating (if any).
-     */
-    get processInstance(): Link | undefined;
-    /**
-     * Start date and time in UTC of the current Activity Instance.
-     */
-    get startDate(): Date | undefined;
-    getInternalModel: () => BackendWorkflowInfo;
-}

package/dist/dts/models/workflow/workflowObject.d.ts

@@ -1,21 +0,0 @@
-import type { WorkflowObject as BackendWorkflowObject } from '@tridion-sites/open-api-client';
-import type { IdentifiableObjectConstructorArgs } from '../identifiableObject';
-import { IdentifiableObject } from '../identifiableObject';
-import type { Link } from '../links';
-export interface WorkflowObjectConstructorArgs extends IdentifiableObjectConstructorArgs {
-    backendModel: BackendWorkflowObject;
-    contextRepository: Link | undefined;
-}
-/**
- * Abstract Base class for the data of workflow items except for "ProcessDefinition" and "ApprovalStatus".
- */
-export declare abstract class WorkflowObject extends IdentifiableObject {
-    protected _backendModel: BackendWorkflowObject;
-    private _contextRepository;
-    constructor({ backendModel, contextRepository, ...identifiableObjectArgs }: WorkflowObjectConstructorArgs);
-    /**
-     * The context Repository: the Repository in which the object has been retrieved.
-     */
-    get contextRepository(): Link | undefined;
-    getInternalModel: () => BackendWorkflowObject;
-}

package/dist/dts/utils/getItemContainerId.d.ts

@@ -1,3 +0,0 @@
-import type { IdentifiableObject } from "../models/identifiableObject";
-import type { ItemUri } from "../models/itemUri";
-export declare const getItemContainerId: (item: IdentifiableObject) => ItemUri | undefined;

package/dist/dts/utils/getItemLabelWithId.d.ts

@@ -1,11 +0,0 @@
-import { type ItemUri } from "../models/itemUri";
-export interface GetItemLabelWithIdOptions<TItem> {
-    item: TItem;
-    includeVersion?: boolean;
-    labelSource?: 'title' | 'description';
-}
-export declare const getItemLabelWithId: <TItem extends {
-    title?: string;
-    description?: string;
-    id: ItemUri;
-}>({ item, labelSource, includeVersion, }: GetItemLabelWithIdOptions<TItem>) => string;

package/dist/dts/utils/getItemLinkType.d.ts

@@ -1,3 +0,0 @@
-import type { ItemLinkType } from "../models/itemType";
-import type { Link } from "../models/links";
-export declare const getItemLinkType: (itemLink: Link) => ItemLinkType | undefined;

package/dist/dts/utils/getItemType.d.ts

@@ -1,3 +0,0 @@
-import type { IdentifiableObject } from "../models/identifiableObject";
-import type { ItemType } from "../models/itemType";
-export declare const getItemType: (item: IdentifiableObject) => ItemType | undefined;

package/dist/dts/utils/index.d.ts

@@ -1,4 +0,0 @@
-export * from './getItemContainerId';
-export * from './getItemLinkType';
-export * from './getItemType';
-export * from './getItemLabelWithId';