hvp-shared 7.9.0 → 7.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -7,6 +7,17 @@
|
|
|
7
7
|
*/
|
|
8
8
|
import { ChangeType, ContentType, Criticality, DocumentStatus, DocumentType, ExternalLinkProvider, Purpose } from "../../constants/document.enums";
|
|
9
9
|
import { DocumentAudienceEntry } from "./requests";
|
|
10
|
+
/**
|
|
11
|
+
* Compact reference to a document's current version, embedded in
|
|
12
|
+
* DocumentSummaryResponse so list views can show version + content-type info
|
|
13
|
+
* without a per-doc fetch.
|
|
14
|
+
*/
|
|
15
|
+
export interface DocumentSummaryVersionRef {
|
|
16
|
+
versionNumber: string;
|
|
17
|
+
contentType: ContentType;
|
|
18
|
+
externalLinkProvider: ExternalLinkProvider | null;
|
|
19
|
+
publishedAt: string | null;
|
|
20
|
+
}
|
|
10
21
|
/**
|
|
11
22
|
* Public Document Response
|
|
12
23
|
*
|
|
@@ -68,6 +79,13 @@ export interface DocumentSummaryResponse {
|
|
|
68
79
|
status: DocumentStatus;
|
|
69
80
|
criticality: Criticality;
|
|
70
81
|
tags: string[];
|
|
82
|
+
audience: DocumentAudienceEntry[];
|
|
83
|
+
requiredForOnboarding: boolean;
|
|
84
|
+
requiresAcknowledgment: boolean;
|
|
85
|
+
/** Compact current-version data; null when the doc has no published version yet. */
|
|
86
|
+
currentVersion: DocumentSummaryVersionRef | null;
|
|
87
|
+
/** Collaborator id of the document author. Frontend resolves to col_code via Redux store. */
|
|
88
|
+
createdBy: string;
|
|
71
89
|
updatedAt: string;
|
|
72
90
|
/** Match snippet — only present in search responses. */
|
|
73
91
|
snippet?: string;
|
|
@@ -77,6 +95,9 @@ export interface DocumentSummaryResponse {
|
|
|
77
95
|
*
|
|
78
96
|
* Full version row. Returned by the viewer, version history, and
|
|
79
97
|
* acknowledgment lookups.
|
|
98
|
+
*
|
|
99
|
+
* A version has a single meaningful date — `publishedAt` — which is null while
|
|
100
|
+
* the version is draft / in_review and set when it transitions to `current`.
|
|
80
101
|
*/
|
|
81
102
|
export interface DocumentVersionResponse {
|
|
82
103
|
id: string;
|
|
@@ -91,10 +112,11 @@ export interface DocumentVersionResponse {
|
|
|
91
112
|
} | null;
|
|
92
113
|
changeType: ChangeType;
|
|
93
114
|
changeNotes: string | null;
|
|
94
|
-
|
|
95
|
-
createdBy: string;
|
|
115
|
+
/** Set only when the version reached `current` (or was demoted to `superseded`). Null for draft / in_review. */
|
|
96
116
|
publishedAt: string | null;
|
|
97
117
|
publishedBy: string | null;
|
|
118
|
+
/** Author of this version row (typically who started the draft). */
|
|
119
|
+
createdBy?: string;
|
|
98
120
|
}
|
|
99
121
|
/**
|
|
100
122
|
* Document Acknowledgment Response
|