Skip to content

Commit 715ad52

Browse files
jviottijviotti
authored
Prepare for the port NPM release (#690)
Signed-off-by: Juan Cruz Viotti <jv@jviotti.com>
1 parent 3a5fa69 commit 715ad52

6 files changed

Lines changed: 317 additions & 6 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ jobs:
142142
if: matrix.platform.benchmark
143143

144144
# Node.js
145-
- run: cd ports/javascript && npm test
145+
- run: node --test ports/javascript/test.mjs ports/javascript/trace.mjs
146146
- run: node ports/javascript/benchmark.mjs > build/benchmark-javascript.json
147147
if: matrix.platform.benchmark
148148

‎README.markdown‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,11 @@ if (result) {
105105
}
106106
```
107107
108+
Ports
109+
-----
110+
111+
- [JavaScript](./ports/javascript) (`npm install @sourcemeta/blaze`)
112+
108113
Documentation
109114
-------------
110115

‎ports/javascript/LICENSE‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎ports/javascript/README.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# @sourcemeta/blaze
2+
3+
A pure JavaScript port of the evaluator from
4+
[Blaze](https://github.com/sourcemeta/blaze), a high-performance
5+
C++ JSON Schema validator. Zero dependencies. Supports Draft 4,
6+
Draft 6, Draft 7, 2019-09, and 2020-12 with schema-specific code
7+
generation for near-native speed.
8+
9+
## Install
10+
11+
```sh
12+
npm install --save @sourcemeta/blaze
13+
```
14+
15+
## Usage
16+
17+
Blaze evaluates pre-compiled schema templates. Compile your JSON
18+
Schema using the
19+
[jsonschema](https://github.com/sourcemeta/jsonschema) CLI
20+
([compile docs](https://github.com/sourcemeta/jsonschema/blob/main/docs/compile.markdown)):
21+
22+
```sh
23+
npm install --global @sourcemeta/jsonschema
24+
25+
cat > schema.json <<'EOF'
26+
{
27+
"$schema": "https://json-schema.org/draft/2020-12/schema",
28+
"type": "object",
29+
"properties": {
30+
"name": { "type": "string" },
31+
"age": { "type": "integer" }
32+
},
33+
"required": [ "name" ]
34+
}
35+
EOF
36+
37+
jsonschema compile schema.json --fast > template.json
38+
```
39+
40+
Then validate instances:
41+
42+
```javascript
43+
import { readFileSync } from "node:fs";
44+
import { Blaze } from "@sourcemeta/blaze";
45+
46+
const template =
47+
JSON.parse(readFileSync("template.json", "utf-8"));
48+
const evaluator = new Blaze(template);
49+
50+
// true or false
51+
console.log(evaluator.validate({ name: "John", age: 30 }));
52+
```
53+
54+
With an evaluation callback for tracing:
55+
56+
```javascript
57+
const instance = { name: "John", age: 30 };
58+
const result = evaluator.validate(instance,
59+
(type, valid, instruction,
60+
evaluatePath, instanceLocation, annotation) => {
61+
console.log(type, evaluatePath,
62+
instanceLocation, valid);
63+
});
64+
console.log(result); // true or false
65+
```

‎ports/javascript/index.d.mts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
export type Template = Array<unknown>;
2+
3+
export type EvaluationCallback = (
4+
type: "pre" | "post",
5+
valid: boolean,
6+
instruction: unknown[],
7+
evaluatePath: string,
8+
instanceLocation: string,
9+
annotation: unknown
10+
) => void;
11+
12+
export declare class Blaze {
13+
constructor(template: Template);
14+
validate(instance: unknown, callback?: EvaluationCallback): boolean;
15+
}

‎ports/javascript/package.json‎

Lines changed: 66 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,71 @@
11
{
22
"name": "@sourcemeta/blaze",
33
"version": "0.0.1",
4-
"private": true,
4+
"description": "A pure JavaScript port of the evaluator from Blaze, a high-performance C++ JSON Schema validator. Zero dependencies. Supports Draft 4, Draft 6, Draft 7, 2019-09, and 2020-12 with schema-specific code generation for near-native speed",
55
"type": "module",
6-
"scripts": {
7-
"test": "node --test test.mjs trace.mjs",
8-
"benchmark": "node benchmark.mjs"
9-
}
6+
"main": "./index.mjs",
7+
"module": "./index.mjs",
8+
"exports": {
9+
".": {
10+
"import": "./index.mjs",
11+
"default": "./index.mjs"
12+
}
13+
},
14+
"types": "./index.d.mts",
15+
"license": "LGPL-3.0-or-later",
16+
"homepage": "https://github.com/sourcemeta/blaze",
17+
"author": {
18+
"email": "hello@sourcemeta.com",
19+
"name": "Sourcemeta",
20+
"url": "https://www.sourcemeta.com"
21+
},
22+
"engines": {
23+
"node": ">=18"
24+
},
25+
"funding": "https://github.com/sponsors/sourcemeta",
26+
"keywords": [
27+
"jsonschema",
28+
"json",
29+
"schema",
30+
"json-schema",
31+
"validator",
32+
"validation",
33+
"json-schema-validator",
34+
"json-schema-validation",
35+
"blaze",
36+
"sourcemeta",
37+
"fast",
38+
"performance",
39+
"codegen",
40+
"draft-04",
41+
"draft-06",
42+
"draft-07",
43+
"draft4",
44+
"draft6",
45+
"draft7",
46+
"2019-09",
47+
"2020-12",
48+
"ajv",
49+
"ajv-alternative",
50+
"$ref",
51+
"validate",
52+
"evaluator"
53+
],
54+
"bugs": {
55+
"url": "https://github.com/sourcemeta/blaze/issues"
56+
},
57+
"repository": {
58+
"type": "git",
59+
"url": "git+https://github.com/sourcemeta/blaze.git",
60+
"directory": "ports/javascript"
61+
},
62+
"publishConfig": {
63+
"access": "public"
64+
},
65+
"files": [
66+
"index.mjs",
67+
"index.d.mts",
68+
"README.md",
69+
"LICENSE"
70+
]
1071
}

0 commit comments

Comments
 (0)