Class: Document

Defined in: domain/entities/Document.ts:26

A document in a workspace. Holds the document data and notifies registered change listeners, which the owning Workspace uses to persist changes.

Constructors

Constructor

new Document(
   instance, 
   profile?, 
   _typeLibrary?
): Document;

Defined in: domain/entities/Document.ts:46

Creates the entity from a stored DocumentInstance. createdAt and updatedAt are set to the current time.

Parameters

Parameter	Type	Description
instance	DocumentInstance	-
profile?	DocumentProfile	Profile used for validation, if already known.
_typeLibrary?	TypeLibrary	-

Returns

Document

Properties

audit

audit: AuditInfo;

Defined in: domain/entities/Document.ts:33

---

createdAt

createdAt: string;

Defined in: domain/entities/Document.ts:36

---

data

data: DocumentData;

Defined in: domain/entities/Document.ts:30

---

id

readonly id: string;

Defined in: domain/entities/Document.ts:27

---

profileId

readonly profileId: string;

Defined in: domain/entities/Document.ts:28

---

qa

qa: QAStatus;

Defined in: domain/entities/Document.ts:31

---

storageBindings

storageBindings: StorageBinding[];

Defined in: domain/entities/Document.ts:32

---

tags

tags: string[];

Defined in: domain/entities/Document.ts:35

---

title?

title?: string;

Defined in: domain/entities/Document.ts:29

---

updatedAt

updatedAt: string;

Defined in: domain/entities/Document.ts:37

---

version

version: VersionInfo;

Defined in: domain/entities/Document.ts:34

Methods

addTag()

addTag(tag): Promise<void>;

Defined in: domain/entities/Document.ts:145

Add a tag

Parameters

Parameter	Type
tag	string

Returns

Promise<void>

---

onChange()

onChange(listener): void;

Defined in: domain/entities/Document.ts:72

Register a listener to be notified when document changes Used by parent Workspace to persist changes automatically

Parameters

Parameter	Type
listener	ChangeListener

Returns

void

---

removeTag()

removeTag(tag): Promise<void>;

Defined in: domain/entities/Document.ts:156

Remove a tag

Parameters

Parameter	Type
tag	string

Returns

Promise<void>

---

setContext()

setContext(profile, _typeLibrary): void;

Defined in: domain/entities/Document.ts:64

Set the document's profile and type library for validation

Parameters

Parameter	Type
profile	DocumentProfile
_typeLibrary	TypeLibrary

Returns

void

---

setField()

setField(fieldPath, value): Promise<void>;

Defined in: domain/entities/Document.ts:86

Update a field value with automatic validation and propagation US-DOC-003: Edit Document

Parameters

Parameter	Type
fieldPath	string
value	FieldValue[]

Returns

Promise<void>

---

setTitle()

setTitle(title): Promise<void>;

Defined in: domain/entities/Document.ts:131

Update document title

Parameters

Parameter	Type
title	string | FieldValue[]

Returns

Promise<void>

---

toInstance()

toInstance(): DocumentInstance;

Defined in: domain/entities/Document.ts:186

Convert entity back to instance (for serialization)

Returns

DocumentInstance

---

updateQA()

updateQA(qa): Promise<void>;

Defined in: domain/entities/Document.ts:168

Update QA status

Parameters

Parameter	Type
qa	Partial<QAStatus>

Returns

Promise<void>