This NPM package provides a set of domain models specifically designed for frontend development of Tridion Sites. These models encapsulate domain-specific logic and provide a convenient abstraction for interacting with the backend data.
Due to reliance on various functionality provided at runtime by Tridion Sites, this package is not suitable for standalone usage and can only be utilized as a part of an extension.
| Class | Description |
|---|---|
| AccessControlEntry | Represents an entry in an Access Control List, which is used to restrict access to containers. |
| AccessControlList | Represents an Access Control List which is used to restrict access to a container. |
| AccessToken | |
| Activity | Abstract base class for the data of Activities. |
| ActivityDefinition | |
| ActivityHistory | Representing data of the Activity History. This is the part of “ProcessHistory”. |
| ActivityInstance | Represents an Activity Instance: a current Activity which is part of a Process Instance. |
| ApiError | |
| ApprovalStatus | |
| BasicVersionInfo | Basic version information about any Identifiable Object. |
| Batch | Represents the data of a Batch. |
| BatchOperation | |
| BinaryContent | Represents the binary content of a Multimedia Component or a Template. |
| BlueprintGraph | |
| BlueprintGraphNode | |
| BlueprintInfo | BluePrint info for Repository-Local Objects. |
| Bundle | Represents a Bundle which is used to group Repository Local Objects for Release Management purposes. |
| BusinessProcessType | <p>Defines a type of (publishing) Business Process, including a set of publishing Target Types and workflows.</p><p>It is a root organizational item. Title must be unique across its blueprint hierarchy; like all other root organizational items.</p><p>Metadata Schema, Bundle Schemas and Target Types of a Business Process Type are not localizable.</p><p>AccessControlListData and IsPermissionsInheritanceRoot cannot be set for a Business Process Type.</p><p>When reading a Business Process Type the associated Target Types are returned without its Access Control List, if that information is needed, then, the Business Process Type should be loaded with LoadFlags.Expanded.</p> |
| BusinessProcessTypes | An item used to organize the business process types in a Repository. |
| ClaimMapping | Abstract base class representing the data of a mapping between a Claim and a TCM Group. |
| ClassificationDetail | |
| ClassificationInfo | Contains classification information for an Item. |
| Component | Represents the data of a regular Component: content and metadata fields. |
| ComponentBase | Represents the data of a Component: a generic holder of content and metadata. |
| ComponentLinkFieldDefinition | Represents a Component link field definition (in a Schema). |
| ComponentPresentation | Essentially a combination of a Component and a Component Template. |
| ComponentTemplate | Represents a Component Template: a template used to render a Component into a Component Presentation. |
| DateFieldDefinition | Represents a date field definition (in a Schema). |
| DateListDefinition | Provides information about whether/how to present a list of allowed date field values. |
| DependencyGraphNode | Node in a dependency graph. |
| DynamicVersionInfo | Information about the dynamic version of a Versioned Item. |
| EclUri | |
| EmbeddedRegion | |
| EmbeddedSchemaFieldDefinition | Represents an embedded schema field definition (in a Schema). |
| ExternalContainer | Container provided from external system. |
| ExternalKeyword | Represents an External Keyword (mapped to an external Taxonomy Management System). |
| ExternalKeywordCategory | Represents an External Category (mapped to an external Taxonomy Management System). |
| ExternalLinkFieldDefinition | Represents an external link field definition (in a Schema). |
| ExternalMultimediaComponent | Represents an External Multimedia Component: an item provided from external system. |
| ExternalVersionInfo | |
| FinishActivityResult | |
| Folder | An item used to organize the items in a Repository. |
| FormattingFeatures | Represents the formatting options. |
| FullVersionInfo | Limited version info for Repository-Local Objects. |
| GroupMembership | Contains the scope of a Group. |
| HateoasLink | Represents the hateoas link. |
| IdentifiableObject | Abstract base class for all objects that can be identified using a “TCM URI”. |
| ItemBlueprintHierarchy | |
| ItemBlueprintRloNodeData | |
| ItemFieldDefinition | Abstract base class for Item Field Definitions (specified in a Schema) |
| ItemPublishableFieldDefinition | Abstract base class for Item Field Definitions for the field types that can be published. |
| Keyword | Represents the data of a Keyword used to classify items. |
| KeywordCategory | Represents the data of a Category of Keywords. |
| KeywordFieldDefinition | Represents a Keyword field definition (in a Schema). |
| LimitedVersionInfo | Limited version info for Repository-Local Objects. |
| Link | Base class for links to Identifiable Objects. |
| LinkWithIsEditable | Represents a link to an Identifiable Object with the option to set if it is allowed to edit the linked Object. |
| ListDefinition | Provides information about how a list of values should be represented to the user. |
| LoadInfo | Represents the information about the error that was thrown while loading an item. |
| LocationInfo | Location/context info for Repository-Local Objects. |
| LockInfo | Lock information about Repository Local Object. |
| MultiLineTextFieldDefinition | Represents a multi-line text field definition (in a Schema). |
| MultimediaComponent | Represents the data of a Multimedia Component: binary content data and metadata fields. |
| MultimediaLinkFieldDefinition | Represents a Multimedia link field definition (in a Schema). |
| MultimediaType | Represents a Multimedia Type: a type of binary content |
| NumberFieldDefinition | Represents a number field definition (in a Schema). |
| NumberListDefinition | Provides information about whether/how to present a list of allowed number field values. |
| OrganizationalItem | Abstract base class for the data of “organizational items”: items used to organize the items in a Repository. |
| Page | Represents the data of a Page: an artifact in the Publication’s target structure. |
| PageTemplate | Represents a Page Template: a template used to render a Page. |
| Process | Abstract base class for the data of Processes. |
| ProcessDefinition | |
| ProcessedItem | |
| ProcessHistory | Representing data of a Process History. |
| ProcessInstance | Represents the data of a Process Instance: a current Process. |
| Publication | Publication: a “Repository” used for publishing. |
| PublicationBlueprintHierarchy | |
| PublishContext | |
| PublishInfo | Represents publishing information for Repository local objects. |
| PublishingTarget | Abstract base class for classes that represent a target for publishing: Target Type and Publication Target. |
| PublishInstruction | |
| PublishInstructionBase | Represents the instructions needed for (un)publishing an item. |
| PublishLocationInfo | Represents a publishing location information for the objects that reside in Structure Groups. |
| PublishTransaction | |
| PublishTransactionListInfo | |
| PublishTransactionsCreationResult | |
| PublishUrlInfo | |
| Region | Abstract base class for Regions. |
| Repository | Represents a Repository: a context for BluePrinting. |
| RepositoryLocalObject | Abstract base class for the data of repository-local data objects: data objects that reside in a “Repository”. |
| ResolvedItem | |
| ResolveInstruction | |
| ResolveInstructionBase | |
| Schema | Schema defines structure of content and/or metadata. |
| SearchFolder | Represents a Search Folder. |
| SecurityDescriptor | SecurityDescriptor is a grouping of all the Rights and Permissions (allow and denies) for the trustees. Specific to a user and a context (IdentifiableObject). |
| SingleLineTextFieldDefinition | Represents a single-line text field definition (in a Schema). |
| SingleLineTextListDefinition | Provides information about whether/how to present a list of allowed single-line text field values. |
| StructureGroup | Organizational Item used to build the Publication’s target structure. |
| SynchronizationAction | |
| SynchronizationResult | |
| SystemPrivilege | Represents a system-wide privilege. |
| SystemWideObject | Abstract base class for the data of all system-wide objects. |
| TargetGroup | Represents the data of a Target Group: used to target an audience based on certain conditions. |
| TargetGroupCondition | Represents a condition on “membership” of a Target Group. |
| TargetLanguage | |
| TargetType | Represents the data of a Target Type used as a target for publishing. |
| Taxonomies | An item used to organize the categories and keywords in a Repository. |
| TcmUri | <p>Represents a native Tridion Content Manager URI which uniquely identifies a resource in the system.</p><p>The structure of a TCM URI is PublicationID-ItemID[-ItemType][-vVersion].</p> |
| Template | Abstract base class for the data of Templates. |
| TemplateBuildingBlock | Represents a Template Building Block: a re-usable template module. |
| TextFieldDefinition | Abstract base class for Text Field Definitions (specified in a Schema) |
| TmsLanguage | Represents a language on the translation management system. |
| TmsWorkflow | |
| TmsWorkflowStep | |
| TranslationDetails | Contains information about the translation state of the Item. |
| TranslationErrorDetails | |
| TranslationExceptionDetails | |
| TranslationInfo | Contains information about the translation state of the Item. |
| TranslationJob | |
| TranslationJobInfo | Contains details on a specific translation to a target Item (see TranslationDetails). |
| TranslationJobItem | Represents an Item added to a TranslationJob. |
| TranslationTargetPublication | |
| TranslationWorkflowStatus | |
| TridionActivityDefinition | Represents the data of a Tridion proprietary Activity Definition. |
| TridionProcessDefinition | Represents the data of a Tridion proprietary Process Definition. |
| Trustee | Abstract base class for the data of “Trustees”: the data of Users or Groups. |
| UnpublishInstruction | |
| User | |
| UserFavoriteLink | Represents the link to a favorite item. |
| UserGroup | Represents a data of Group of Users. |
| UserLocaleInfo | Represents the information about User locale. |
| UserPreferences | Represents the User preferences data. |
| UserProfile | |
| UserRuntimeInfo | Represents the runtime information of the User. |
| ValidationApiError | |
| ValidationError | Represents a validation error which is returned when validating an item. |
| ValidationResult | Represents the data of a validation result which is returned when validating an item. |
| ValidationWarning | Represents the data of a validation warning which is returned when validating an item. |
| VersionedItem | Abstract base class for Versioned Items. |
| VirtualFolder | Organizational Item that dynamically collects its contents. |
| VirtualUri | |
| WhereUsedListInfo | |
| WorkflowInfo | Represents workflow-related information for items that can participate in a workflow process. |
| WorkflowObject | Abstract Base class for the data of workflow items except for “ProcessDefinition” and “ApprovalStatus”. |
| WorkItem | Represents the data of a Work Item: the association between an item participating in workflow and an Activity. |
| XhtmlFieldDefinition | Represents an XHTML field (a.k.a. Format Area) definition (in a Schema). |
| Type Alias | Description |
|---|---|
| ActivityConstraints | Defines the constraints of an Activity Instance. - none - Does not have any constraints. - denyBundleMetadataEditing - Denies editing Metadata of a Bundle in workflow. - denySubjectEditing - Denies editing Subject in workflow. - denyAddRemoveWorkItem - Denies adding/removing work items to/from the Activity. - 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. |
| ActivityState | <p>Defines a state of an Activity.</p><p>* assigned - The Activity is assigned to the User or Group. * started - The Activity is started by a User. * failed - The Activity is failed. * finished - The Activity is finished. * suspended - The Activity is suspended. * waitingForWorkflowAgent - The Activity is waiting for execution by Workflow Agent. * 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.</p> |
| ActivityType | Defines a type of an Activity. normal - Normal activity decision - Decision activity |
| ApiMethod | |
| ApplicableAction | |
| BatchOperationState | <p>The state of the batch operation.</p><p>* notStarted - Batch operation wasn’t started yet. * success - Batch operation was successfully finished. * warning - Batch operation was finished with warning. * error - Batch operation wasn’t finished due to an error. * 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.</p> |
| BatchStatus | |
| BatchType | |
| ComponentType | <p>Defines the subtype of a Component.</p><p>* normal - A normal Component containing XML content. * multimedia - A Multimedia Component containing binary content. * widget - A widget Component - a dedicated variant of the normal Component. * ‘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.</p> |
| DependencyDirection | |
| DeployerAction | <p>Represents the action the deployer needs to take.</p><p>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.</p> |
| ExtensionPropertyDictionary | Represents a collection of Extension Properties. |
| FieldsDefinitionDictionary | Set of Item Field Definitions grouped by the field definition name. |
| FieldsValueDictionary | Set of field values grouped by the field name. |
| ItemBlueprintNode | |
| ItemBlueprintNodeData | |
| ItemLinkType | |
| ItemType | |
| ItemUri | |
| LinkTargetStatus | |
| ListDetailsLevel | |
| ListInfoDictionary | |
| ListLink | |
| ListType | |
| LoadInfoErrorType | * none - No error. * error - General error. * security - User has no permissions to read an item. * 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. |
| LoadInfoState | |
| LockType | * none - The item is not locked. * checkedOut - The item is checked-out. This can mean either a temporary (edit) lock, a permanent lock (explicit check-out performed by user) or a workflow lock. * permanent - The item is permanently locked, that is using an explicit lock (check-out) action. Can be applied to versioned items (permanent check-out) and to organizational items. * newItem - The item is a new item, that is it has been created, but not checked-in for the first time yet. * inWorkflow - The item is in a workflow. * reserved - The item is reserved by the system. This means it is checked-out/locked, but nobody owns the lock. * 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. |
| ParametersDictionary | Represents multiple sets of the parameters grouped by name. |
| Permission | * none - No permission to access the items. * read - Grants read access to items. * write - Grants write access to items. * delete - Grants delete access to items. * localize - Grants localize and unlocalize access to items. * all - Grants all permissions to access the items. * 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. |
| ProcessFinishReason | <p>Defines the reason a Process is going to be finished or has finished already.</p><p>* 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.</p> |
| PublishAction | Distinguishes publishing and unpublishing actions. |
| PublishPriority | <p>Identifies the priority of the publish action.</p><p>* low - Low priority. * normal - Normal priority. * high - High priority.</p> |
| PublishTransactionState | |
| ResolveOptions | <p>Defines which Items will be included in the Translation Job for an .</p><p>Members: * translateContainerItems - Translate container items (Folders, Pages, Structure Groups, etc.) * translateSubItems - Translate the items inside of containers (Components, Keywords, etc.) * 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.</p> |
| RetrieveReason | <p>Used in TranslationJobInfo to indicate why the item was retrieved.</p><p>* unknown - The reason is not known. Most likely the item was retrieved by a previous version of Translation Manager that could only retrieve items when they were Completed. * completed - The item was completed in the Translation Management system. Translation Manager consider the Item completed and will complete the Translation Job once all items are in this stage. * review -The item was retrieved to allow review in Tridion Sites. The item remains in control of the translation management system’s workflow and Translation Manager will attempt to retrieve the Item again. * preview - The item was retrieved to allow preview in Tridion Sites. The item remains in control of the translation management system’s workflow and Translation Manager will attempt to retrieve the Item again. * 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.</p> |
| Right | * none - No rights. * publicationAccess - Grants access to a publication. * publicationManagement - Grants publication properties update. * folderManagement - Grants create, update, delete rights on Folder. * structureGroupManagement - Grants create, update, delete rights on StructureGroup. * schemaManagement - Grants create, update, delete rights on Schema. * componentManagement - Grants create, update, delete rights on Components. * componentTemplateManagement - Grants create, update, delete rights on ComponentTemplates. * pageManagement - Grants create, update, delete rights on Pages. * pageTemplateManagement - Grants create, update, delete rights on PageTemplates. * profileManagement - Grants create, update, delete rights on TargetGroups. * publishManagement - Grants rights to publish. * permissionManagement - Grants rights to change rights on Repository and permissions on Organizational Items. * workflowManagement - Grants create, update, delete rights to manage Workflow. To grant workflow management rights to a trustee, the WorkflowManager privilege must be used. * categoryManagement - Grants create, update, delete rights on Categories. * templateBuildingBlockManagement - Grants create, update, delete rights on TemplateBuildingBlocks. * virtualFolderManagement - Grants create, update, delete rights on VirtualFolders. * bundleManagement - Grants create, update, delete rights on Bundles. * businessProcessTypeManagement - Grants create, update, delete rights on Business Process Type. * publicationAdministration - Grants repository-local administration rights. * all - All rights. * lockManagement - Grants the user rights to unlock items locked by other users. * 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. |
| RloItemType | <p>Specifies the subset of the Item types which are the Repository Local Object model.</p><p>*folder - Folder. * structureGroup - Structure group. * schema - Schema. * component - Component. * componentTemplate - Component template. * page - Page. * pageTemplate - Page template. * targetGroup - Target group. * category - Category. * keyword - Keyword. * templateBuildingBlock - Template building block. * virtualFolder - Virtual folder. * 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.</p> |
| SchemaPurpose | <p>Defines a purpose of a Schema, that is in which items the Schema can be used.</p><p>* component - Schema defines the content and metadata of Components with XML content. * multimedia - Schema defines the content and metadata of Multimedia Components. * embedded - Schema is included into other Schemas. * metadata - Schema defines the metadata of items (except for Components). * protocol - Schema defines the protocol fields of a Publication Target. * virtualFolderType - Schema defines the configuration data of a Virtual Folder. * templateParameters - Schema defines the parameters of a Template. * bundle - Schema defines the metadata and process definition of a Bundle. * region - Schema defines the Region definition and metadata. * 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.</p> |
| SearchBlueprintStatus | |
| StringSearchMode | * contains - Matches the given substring in any location. * startsWith - Matches the given string at the start. * endsWith - Matches the given string at the end. * exactMatch - Matches the given string exactly. |
| StructureResolveOption | |
| SynchronizeFlags | |
| SystemPrivilegeName | |
| SystemPrivilegesDictionary | Represents a dictionary of the system-wide privilege keys associations with a collection of the Group’s link. |
| TranslationErrorSeverity | <p>Indicates the severity of an error sending or retrieving a Translation Job.</p><p>Members: * info - Information. * warning - Errors that can impact usability but does not impact sending or retrieving Items (for example old jobs not being deleted) * error - Errors stopping Items from being send to translation or retrieved from translation. * 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.</p> |
| TranslationJobDisplayState | <p>Gets the state that should be displayed in the UI for the. This is slightly more detailed than the.</p><p>Members: * error - The is in an error state not related to retrieval or sending the. The errors are available in. * canceled - The was canceled in the translation management system before all items where retrieved. * completed - The translation of the has been completed. * definition - It is still possible to edit the before it is send for translation. * awaitingAuthorization - One or more s is ready for authorization. * awaitingAuthorizationAndError - One or more s is ready for authorization and one or more errors is available in. * errorRetrieving - The is in an error state related to retrieving translations. The errors are available in. * inTranslation - The is currently in translation. Some - but not all - items might have been canceled or completed. * errorSending - The is in an error state related to sending the Items for translation. The errors are available in. * submittingToTranslation - The is currently being send to the translation management system by the Translation Manager windows service. * readyForTranslation - The is no longer in state and is ready to be send for translation by the Translation Manager windows service. * deleting - The is being deleted by the Translation Manager windows service. * 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.</p> |
| TranslationJobPriority | <p>Specifies the priority of the translation job. Higher priority jobs will be send to the TMS server first.</p><p>Members: * low - Low priority * normal - Normal priority * high - High priority * 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.</p> |
| TranslationJobState | <p>State of a translation job.</p><p>Members: * canceled - The job has been canceled. * definition - The job is in definition state - it can still be edited. * readyForTranslation - The job has been defined, and is waiting for the Translation Manager Service to retrieve it. * submittingToTranslation - The job is being transferred to the translation management system. * inTranslation - The job is under control of the translation management system. * completed - The job has been completed. * readyForDeletion - The job can be deleted and is waiting for the service to pick up the task. * deleting - The job is currently being deleted. * none - Unspecified state (used to get jobs for all states). * 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.</p> |
| TranslationJobType | <p>The Translation job type (push or pull)</p><p>Members: * none - Unspecified job type (used to get jobs for all types). * pushJob - Job that pushes translation from one translation source to one or more targets. * pullJob - Job that pulls the translation from one or more source languages to the context target. * 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.</p> |
| TranslationStatus | <p>Represents translation status of an Item.</p><p>* notTranslated - Item is not translated. * inProgress - Translation in progress. * upToDate - Items contains latest translation of source. * newSourceVersionExists - New version of source available. * newTargetVersionExists - Previous version of target item contains translation but target item was changed after. * 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.</p> |
| VariablesDictionary | Represents multiple sets of variables grouped by name. |
| VirtualUriItemType | |
| WhereUsedCommentToken | <p>Kind of relationship between this item and used item</p><p>Members: * parentItem - Specifies that the list item represents the (direct) BluePrint Parent Item of the given item. * localCopy - Specifies that the list item represents a Local Copy of the given item. * onlyOldVersions - Specifies that only old versions of the list item are referring to the given item. * onlyCheckedOutVersion - if only the checked-out version of an item refers to the given item. * unknownByClient - Special reserved value used to notify a legacy client about receiving an enumeration value added in a newer version of the service. Explicitly setting this value by a client is not allowed (it can only be set internally by the service), but client code should check it and be able to handle such cases.</p> |