@openfilamentcollective/ofd-validator 0.5.1

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.
Files changed (3) hide show
  1. package/index.d.ts +64 -0
  2. package/index.js +330 -0
  3. package/package.json +53 -0
package/index.d.ts ADDED
@@ -0,0 +1,64 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+
4
+ /* auto-generated by NAPI-RS */
5
+
6
+ export interface ValidationError {
7
+ level: string
8
+ category: string
9
+ message: string
10
+ path?: string
11
+ }
12
+ export interface ValidationResult {
13
+ errors: Array<ValidationError>
14
+ isValid: boolean
15
+ errorCount: number
16
+ warningCount: number
17
+ }
18
+ export declare function validateAll(dataDir: string, storesDir: string, schemasDir?: string | undefined | null): ValidationResult
19
+ /**
20
+ * Validate the dataset after overlaying pending WebUI changes (mirrors the Python
21
+ * `validate_all_with_changes`). `changes_json` is the `{ "changes": [...] }` payload.
22
+ */
23
+ export declare function validateAllWithChanges(dataDir: string, storesDir: string, changesJson: string, schemasDir?: string | undefined | null): ValidationResult
24
+ export declare function validateJsonFiles(dataDir: string, storesDir: string, schemasDir?: string | undefined | null): ValidationResult
25
+ export declare function validateLogoFiles(dataDir: string, storesDir: string): ValidationResult
26
+ export declare function validateFolderNames(dataDir: string, storesDir: string): ValidationResult
27
+ export declare function validateStoreIds(dataDir: string, storesDir: string): ValidationResult
28
+ export declare function validateGtinEan(dataDir: string): ValidationResult
29
+ export declare function validateRequiredFiles(dataDir: string, storesDir: string): ValidationResult
30
+ export declare function validateLogoFile(logoPath: string, logoName?: string | undefined | null): ValidationResult
31
+ export declare function validateFolderName(folderPath: string, jsonFile: string, jsonKey: string): ValidationResult
32
+ export interface JsonFileInput {
33
+ path: string
34
+ schemaName: string
35
+ content: string
36
+ }
37
+ export interface LogoFileInput {
38
+ path: string
39
+ filename: string
40
+ content: Buffer
41
+ }
42
+ export interface FolderInput {
43
+ path: string
44
+ folderName: string
45
+ jsonContent: string
46
+ jsonKey: string
47
+ }
48
+ export interface SizesInput {
49
+ path: string
50
+ content: string
51
+ }
52
+ export interface ValidateAllContentInput {
53
+ jsonFiles: Array<JsonFileInput>
54
+ logoFiles: Array<LogoFileInput>
55
+ folders: Array<FolderInput>
56
+ storeIds: Array<string>
57
+ schemas: Record<string, string>
58
+ }
59
+ export declare function validateJsonContent(content: string, schemaName: string, schemas: Record<string, string>, filePath?: string | undefined | null): ValidationResult
60
+ export declare function validateLogoContent(content: Buffer, filename: string, logoName?: string | undefined | null, filePath?: string | undefined | null): ValidationResult
61
+ export declare function validateFolderNameContent(folderName: string, jsonContent: string, jsonKey: string, filePath?: string | undefined | null): ValidationResult
62
+ export declare function validateGtinEanContent(sizesEntries: Array<SizesInput>): ValidationResult
63
+ export declare function validateStoreIdsContent(storeIds: Array<string>, sizesEntries: Array<SizesInput>): ValidationResult
64
+ export declare function validateAllContent(data: ValidateAllContentInput): ValidationResult
package/index.js ADDED
@@ -0,0 +1,330 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /* prettier-ignore */
4
+
5
+ /* auto-generated by NAPI-RS */
6
+
7
+ const { existsSync, readFileSync } = require('fs')
8
+ const { join } = require('path')
9
+
10
+ const { platform, arch } = process
11
+
12
+ let nativeBinding = null
13
+ let localFileExisted = false
14
+ let loadError = null
15
+
16
+ function isMusl() {
17
+ // For Node 10
18
+ if (!process.report || typeof process.report.getReport !== 'function') {
19
+ try {
20
+ const lddPath = require('child_process').execSync('which ldd').toString().trim()
21
+ return readFileSync(lddPath, 'utf8').includes('musl')
22
+ } catch (e) {
23
+ return true
24
+ }
25
+ } else {
26
+ const { glibcVersionRuntime } = process.report.getReport().header
27
+ return !glibcVersionRuntime
28
+ }
29
+ }
30
+
31
+ switch (platform) {
32
+ case 'android':
33
+ switch (arch) {
34
+ case 'arm64':
35
+ localFileExisted = existsSync(join(__dirname, 'ofd-validator.android-arm64.node'))
36
+ try {
37
+ if (localFileExisted) {
38
+ nativeBinding = require('./ofd-validator.android-arm64.node')
39
+ } else {
40
+ nativeBinding = require('@openfilamentcollective/ofd-validator-android-arm64')
41
+ }
42
+ } catch (e) {
43
+ loadError = e
44
+ }
45
+ break
46
+ case 'arm':
47
+ localFileExisted = existsSync(join(__dirname, 'ofd-validator.android-arm-eabi.node'))
48
+ try {
49
+ if (localFileExisted) {
50
+ nativeBinding = require('./ofd-validator.android-arm-eabi.node')
51
+ } else {
52
+ nativeBinding = require('@openfilamentcollective/ofd-validator-android-arm-eabi')
53
+ }
54
+ } catch (e) {
55
+ loadError = e
56
+ }
57
+ break
58
+ default:
59
+ throw new Error(`Unsupported architecture on Android ${arch}`)
60
+ }
61
+ break
62
+ case 'win32':
63
+ switch (arch) {
64
+ case 'x64':
65
+ localFileExisted = existsSync(
66
+ join(__dirname, 'ofd-validator.win32-x64-msvc.node')
67
+ )
68
+ try {
69
+ if (localFileExisted) {
70
+ nativeBinding = require('./ofd-validator.win32-x64-msvc.node')
71
+ } else {
72
+ nativeBinding = require('@openfilamentcollective/ofd-validator-win32-x64-msvc')
73
+ }
74
+ } catch (e) {
75
+ loadError = e
76
+ }
77
+ break
78
+ case 'ia32':
79
+ localFileExisted = existsSync(
80
+ join(__dirname, 'ofd-validator.win32-ia32-msvc.node')
81
+ )
82
+ try {
83
+ if (localFileExisted) {
84
+ nativeBinding = require('./ofd-validator.win32-ia32-msvc.node')
85
+ } else {
86
+ nativeBinding = require('@openfilamentcollective/ofd-validator-win32-ia32-msvc')
87
+ }
88
+ } catch (e) {
89
+ loadError = e
90
+ }
91
+ break
92
+ case 'arm64':
93
+ localFileExisted = existsSync(
94
+ join(__dirname, 'ofd-validator.win32-arm64-msvc.node')
95
+ )
96
+ try {
97
+ if (localFileExisted) {
98
+ nativeBinding = require('./ofd-validator.win32-arm64-msvc.node')
99
+ } else {
100
+ nativeBinding = require('@openfilamentcollective/ofd-validator-win32-arm64-msvc')
101
+ }
102
+ } catch (e) {
103
+ loadError = e
104
+ }
105
+ break
106
+ default:
107
+ throw new Error(`Unsupported architecture on Windows: ${arch}`)
108
+ }
109
+ break
110
+ case 'darwin':
111
+ localFileExisted = existsSync(join(__dirname, 'ofd-validator.darwin-universal.node'))
112
+ try {
113
+ if (localFileExisted) {
114
+ nativeBinding = require('./ofd-validator.darwin-universal.node')
115
+ } else {
116
+ nativeBinding = require('@openfilamentcollective/ofd-validator-darwin-universal')
117
+ }
118
+ break
119
+ } catch {}
120
+ switch (arch) {
121
+ case 'x64':
122
+ localFileExisted = existsSync(join(__dirname, 'ofd-validator.darwin-x64.node'))
123
+ try {
124
+ if (localFileExisted) {
125
+ nativeBinding = require('./ofd-validator.darwin-x64.node')
126
+ } else {
127
+ nativeBinding = require('@openfilamentcollective/ofd-validator-darwin-x64')
128
+ }
129
+ } catch (e) {
130
+ loadError = e
131
+ }
132
+ break
133
+ case 'arm64':
134
+ localFileExisted = existsSync(
135
+ join(__dirname, 'ofd-validator.darwin-arm64.node')
136
+ )
137
+ try {
138
+ if (localFileExisted) {
139
+ nativeBinding = require('./ofd-validator.darwin-arm64.node')
140
+ } else {
141
+ nativeBinding = require('@openfilamentcollective/ofd-validator-darwin-arm64')
142
+ }
143
+ } catch (e) {
144
+ loadError = e
145
+ }
146
+ break
147
+ default:
148
+ throw new Error(`Unsupported architecture on macOS: ${arch}`)
149
+ }
150
+ break
151
+ case 'freebsd':
152
+ if (arch !== 'x64') {
153
+ throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
154
+ }
155
+ localFileExisted = existsSync(join(__dirname, 'ofd-validator.freebsd-x64.node'))
156
+ try {
157
+ if (localFileExisted) {
158
+ nativeBinding = require('./ofd-validator.freebsd-x64.node')
159
+ } else {
160
+ nativeBinding = require('@openfilamentcollective/ofd-validator-freebsd-x64')
161
+ }
162
+ } catch (e) {
163
+ loadError = e
164
+ }
165
+ break
166
+ case 'linux':
167
+ switch (arch) {
168
+ case 'x64':
169
+ if (isMusl()) {
170
+ localFileExisted = existsSync(
171
+ join(__dirname, 'ofd-validator.linux-x64-musl.node')
172
+ )
173
+ try {
174
+ if (localFileExisted) {
175
+ nativeBinding = require('./ofd-validator.linux-x64-musl.node')
176
+ } else {
177
+ nativeBinding = require('@openfilamentcollective/ofd-validator-linux-x64-musl')
178
+ }
179
+ } catch (e) {
180
+ loadError = e
181
+ }
182
+ } else {
183
+ localFileExisted = existsSync(
184
+ join(__dirname, 'ofd-validator.linux-x64-gnu.node')
185
+ )
186
+ try {
187
+ if (localFileExisted) {
188
+ nativeBinding = require('./ofd-validator.linux-x64-gnu.node')
189
+ } else {
190
+ nativeBinding = require('@openfilamentcollective/ofd-validator-linux-x64-gnu')
191
+ }
192
+ } catch (e) {
193
+ loadError = e
194
+ }
195
+ }
196
+ break
197
+ case 'arm64':
198
+ if (isMusl()) {
199
+ localFileExisted = existsSync(
200
+ join(__dirname, 'ofd-validator.linux-arm64-musl.node')
201
+ )
202
+ try {
203
+ if (localFileExisted) {
204
+ nativeBinding = require('./ofd-validator.linux-arm64-musl.node')
205
+ } else {
206
+ nativeBinding = require('@openfilamentcollective/ofd-validator-linux-arm64-musl')
207
+ }
208
+ } catch (e) {
209
+ loadError = e
210
+ }
211
+ } else {
212
+ localFileExisted = existsSync(
213
+ join(__dirname, 'ofd-validator.linux-arm64-gnu.node')
214
+ )
215
+ try {
216
+ if (localFileExisted) {
217
+ nativeBinding = require('./ofd-validator.linux-arm64-gnu.node')
218
+ } else {
219
+ nativeBinding = require('@openfilamentcollective/ofd-validator-linux-arm64-gnu')
220
+ }
221
+ } catch (e) {
222
+ loadError = e
223
+ }
224
+ }
225
+ break
226
+ case 'arm':
227
+ if (isMusl()) {
228
+ localFileExisted = existsSync(
229
+ join(__dirname, 'ofd-validator.linux-arm-musleabihf.node')
230
+ )
231
+ try {
232
+ if (localFileExisted) {
233
+ nativeBinding = require('./ofd-validator.linux-arm-musleabihf.node')
234
+ } else {
235
+ nativeBinding = require('@openfilamentcollective/ofd-validator-linux-arm-musleabihf')
236
+ }
237
+ } catch (e) {
238
+ loadError = e
239
+ }
240
+ } else {
241
+ localFileExisted = existsSync(
242
+ join(__dirname, 'ofd-validator.linux-arm-gnueabihf.node')
243
+ )
244
+ try {
245
+ if (localFileExisted) {
246
+ nativeBinding = require('./ofd-validator.linux-arm-gnueabihf.node')
247
+ } else {
248
+ nativeBinding = require('@openfilamentcollective/ofd-validator-linux-arm-gnueabihf')
249
+ }
250
+ } catch (e) {
251
+ loadError = e
252
+ }
253
+ }
254
+ break
255
+ case 'riscv64':
256
+ if (isMusl()) {
257
+ localFileExisted = existsSync(
258
+ join(__dirname, 'ofd-validator.linux-riscv64-musl.node')
259
+ )
260
+ try {
261
+ if (localFileExisted) {
262
+ nativeBinding = require('./ofd-validator.linux-riscv64-musl.node')
263
+ } else {
264
+ nativeBinding = require('@openfilamentcollective/ofd-validator-linux-riscv64-musl')
265
+ }
266
+ } catch (e) {
267
+ loadError = e
268
+ }
269
+ } else {
270
+ localFileExisted = existsSync(
271
+ join(__dirname, 'ofd-validator.linux-riscv64-gnu.node')
272
+ )
273
+ try {
274
+ if (localFileExisted) {
275
+ nativeBinding = require('./ofd-validator.linux-riscv64-gnu.node')
276
+ } else {
277
+ nativeBinding = require('@openfilamentcollective/ofd-validator-linux-riscv64-gnu')
278
+ }
279
+ } catch (e) {
280
+ loadError = e
281
+ }
282
+ }
283
+ break
284
+ case 's390x':
285
+ localFileExisted = existsSync(
286
+ join(__dirname, 'ofd-validator.linux-s390x-gnu.node')
287
+ )
288
+ try {
289
+ if (localFileExisted) {
290
+ nativeBinding = require('./ofd-validator.linux-s390x-gnu.node')
291
+ } else {
292
+ nativeBinding = require('@openfilamentcollective/ofd-validator-linux-s390x-gnu')
293
+ }
294
+ } catch (e) {
295
+ loadError = e
296
+ }
297
+ break
298
+ default:
299
+ throw new Error(`Unsupported architecture on Linux: ${arch}`)
300
+ }
301
+ break
302
+ default:
303
+ throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
304
+ }
305
+
306
+ if (!nativeBinding) {
307
+ if (loadError) {
308
+ throw loadError
309
+ }
310
+ throw new Error(`Failed to load native binding`)
311
+ }
312
+
313
+ const { validateAll, validateAllWithChanges, validateJsonFiles, validateLogoFiles, validateFolderNames, validateStoreIds, validateGtinEan, validateRequiredFiles, validateLogoFile, validateFolderName, validateJsonContent, validateLogoContent, validateFolderNameContent, validateGtinEanContent, validateStoreIdsContent, validateAllContent } = nativeBinding
314
+
315
+ module.exports.validateAll = validateAll
316
+ module.exports.validateAllWithChanges = validateAllWithChanges
317
+ module.exports.validateJsonFiles = validateJsonFiles
318
+ module.exports.validateLogoFiles = validateLogoFiles
319
+ module.exports.validateFolderNames = validateFolderNames
320
+ module.exports.validateStoreIds = validateStoreIds
321
+ module.exports.validateGtinEan = validateGtinEan
322
+ module.exports.validateRequiredFiles = validateRequiredFiles
323
+ module.exports.validateLogoFile = validateLogoFile
324
+ module.exports.validateFolderName = validateFolderName
325
+ module.exports.validateJsonContent = validateJsonContent
326
+ module.exports.validateLogoContent = validateLogoContent
327
+ module.exports.validateFolderNameContent = validateFolderNameContent
328
+ module.exports.validateGtinEanContent = validateGtinEanContent
329
+ module.exports.validateStoreIdsContent = validateStoreIdsContent
330
+ module.exports.validateAllContent = validateAllContent
package/package.json ADDED
@@ -0,0 +1,53 @@
1
+ {
2
+ "name": "@openfilamentcollective/ofd-validator",
3
+ "version": "0.5.1",
4
+ "description": "High-performance validation library for the Open Filament Database",
5
+ "main": "index.js",
6
+ "types": "index.d.ts",
7
+ "publishConfig": {
8
+ "access": "public",
9
+ "registry": "https://registry.npmjs.org"
10
+ },
11
+ "repository": {
12
+ "type": "git",
13
+ "url": "https://github.com/OpenFilamentCollective/ofd-validator"
14
+ },
15
+ "license": "MIT",
16
+ "keywords": [
17
+ "validation",
18
+ "filament",
19
+ "3d-printing",
20
+ "database",
21
+ "rust",
22
+ "napi"
23
+ ],
24
+ "files": [
25
+ "index.js",
26
+ "index.d.ts"
27
+ ],
28
+ "napi": {
29
+ "name": "ofd-validator",
30
+ "triples": {
31
+ "defaults": true,
32
+ "additional": [
33
+ "aarch64-unknown-linux-gnu",
34
+ "aarch64-apple-darwin"
35
+ ]
36
+ }
37
+ },
38
+ "optionalDependencies": {
39
+ "@openfilamentcollective/ofd-validator-win32-x64-msvc": "0.5.1",
40
+ "@openfilamentcollective/ofd-validator-darwin-x64": "0.5.1",
41
+ "@openfilamentcollective/ofd-validator-linux-x64-gnu": "0.5.1",
42
+ "@openfilamentcollective/ofd-validator-linux-arm64-gnu": "0.5.1",
43
+ "@openfilamentcollective/ofd-validator-darwin-arm64": "0.5.1"
44
+ },
45
+ "devDependencies": {
46
+ "@napi-rs/cli": "^2.18.0"
47
+ },
48
+ "scripts": {
49
+ "build": "napi build --release --platform",
50
+ "prepublishOnly": "napi prepublish --skip-gh-release",
51
+ "artifacts": "napi artifacts"
52
+ }
53
+ }