-
Notifications
You must be signed in to change notification settings - Fork 8
/
docUtils.js
165 lines (149 loc) · 4.69 KB
/
docUtils.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
import semver from 'semver'
/**
* @typedef {Object} FullProductName
* @property {string} name
* @property {string} product_id
*/
/**
* @typedef {Object} Branch
* @property {Array<Branch>} branches
* @property {FullProductName} product
*/
/**
* @param {any} doc
* @returns {doc is { document: { tracking: { version: string } } }}
*/
export const hasTrackingVersionField = (doc) =>
typeof doc?.document?.tracking?.version === 'string'
/**
* @param {any} doc
* @returns {doc is { document: { tracking: { status: string } } }}
*/
export const hasTrackingStatusField = (doc) =>
typeof doc?.document?.tracking?.status === 'string'
/**
* @param {any} doc
* @returns {doc is { document: { tracking: { revision_history: Array<{ number: string; date: string }> } } }}
*/
export const hasTrackingRevisionHistory = (doc) =>
Array.isArray(doc?.document?.tracking?.revision_history) &&
doc?.document?.tracking?.revision_history.every(
(/** @type {any} */ r) =>
typeof r.number === 'string' && typeof r.date === 'string'
)
/**
* This method collects definitions of product ids and corresponding names and instancePaths in the given document and returns a result object.
* @param {any} document
* @returns {{id: string, name: string, instancePath: string}[]}
*/
export const collectProductIds = ({ document }) => {
const entries =
/** @type {{id: string, name: string, instancePath: string}[]} */ ([])
const fullProductNames = document.product_tree?.full_product_names
if (fullProductNames) {
for (let i = 0; i < fullProductNames.length; ++i) {
const fullProductName = fullProductNames[i]
if (fullProductName.product_id) {
entries.push({
id: fullProductName.product_id,
name: fullProductName.name ?? '',
instancePath: `/product_tree/full_product_names/${i}/product_id`,
})
}
}
}
const relationships = document.product_tree?.relationships
if (relationships) {
for (let i = 0; i < relationships.length; ++i) {
const relationship = relationships[i]
const fullProductName = relationship.full_product_name
if (fullProductName) {
if (fullProductName.product_id) {
entries.push({
id: fullProductName.product_id,
name: fullProductName.name ?? '',
instancePath: `/product_tree/relationships/${i}/full_product_name/product_id`,
})
}
}
}
}
const branches = document.product_tree?.branches
if (branches) {
traverseBranches(branches, entries, '/product_tree/branches')
}
return entries
}
/**
* This method collects group ids and corresponding instancePaths in the given document and returns a result object.
*
* @param {any} document
* @returns {{id: string, name: string, instancePath: string}[]}
*/
export const collectGroupIds = ({ document }) => {
const entries =
/** @type {{id: string, name: string, instancePath: string}[]} */ ([])
const productGroups = document.product_tree?.product_groups
if (productGroups) {
for (let i = 0; i < productGroups.length; ++i) {
const productGroup = productGroups[i]
if (productGroup.group_id) {
entries.push({
id: productGroup.group_id,
name: productGroup.summary ?? '',
instancePath: `/product_tree/product_groups/${i}/group_id`,
})
}
}
}
return entries
}
/**
* @param {{id: string}[]} entries
* @param {{id: string, instancePath: string}[]} refs
*/
export const findMissingDefinitions = (entries, refs) => {
return refs.filter(
(ref) => entries.find((e) => e.id === ref.id) === undefined
)
}
/**
* @param {Array<Branch>} branches
* @param {{id: string, name: string, instancePath: string}[]} entries
* @param {string} instancePath
*/
const traverseBranches = (branches, entries, instancePath) => {
for (let i = 0; i < branches.length; ++i) {
const branch = branches[i]
const branchInstancePath = `${instancePath}/${i}`
const fullProductName = branch.product
if (fullProductName) {
if (fullProductName.product_id) {
entries.push({
id: fullProductName.product_id,
name: fullProductName.name ?? '',
instancePath: `${branchInstancePath}/product/product_id`,
})
}
}
if (branch.branches)
traverseBranches(
branch.branches,
entries,
`${branchInstancePath}/branches`
)
}
}
/**
* Return positive number if v2 is gte v1 and negative number otherwise
* @param {string} v1
* @param {string} v2
* @returns {number}
*/
export const compareVersions = (v1, v2) => {
if (semver.valid(v1) && semver.valid(v2)) {
return semver.gte(v2, v1) ? 1 : -1
} else {
return parseInt(v2) - parseInt(v1)
}
}