@serum-enterprises/schema 2.0.1-beta.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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Serum Enterprises L.L.C-FZ
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,65 @@
1
+ # Schema
2
+
3
+ Modern Schema Validation Library inspired by Joi.dev
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install --save @serum-enterprises/schema
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ```typescript
14
+ import Schema from '@serum-enterprises/schema';
15
+
16
+ const schema = Schema.Object
17
+ .nullable()
18
+ .schema({
19
+ name: Schema.String,
20
+ age: Schema.Number.integer().min(18).max(99),
21
+ friends: Schema.Array
22
+ .every(
23
+ Schema.Or.oneOf([
24
+ Schema.Object
25
+ .schema({
26
+ name: Schema.String,
27
+ age: Schema.Number.min(18).max(99)
28
+ }),
29
+ Schema.String
30
+ ])
31
+ )
32
+ });
33
+
34
+ schema.validate({ name: 'John', age: 20, friends: [{ name: "Maria", age: 22 }] });
35
+ ```
36
+
37
+ **Note: Schema.fromJSON and Schema.validate return a Result. See @serum-enterprises/result for more Information.**
38
+
39
+ ## API
40
+
41
+ Please check [Schema.d.ts](./types/Schema.d.ts) for the full API.
42
+
43
+ ## LICENSE
44
+
45
+ MIT License
46
+
47
+ Copyright (c) 2025 Serum Enterprises L.L.C-FZ
48
+
49
+ Permission is hereby granted, free of charge, to any person obtaining a copy
50
+ of this software and associated documentation files (the "Software"), to deal
51
+ in the Software without restriction, including without limitation the rights
52
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
53
+ copies of the Software, and to permit persons to whom the Software is
54
+ furnished to do so, subject to the following conditions:
55
+
56
+ The above copyright notice and this permission notice shall be included in all
57
+ copies or substantial portions of the Software.
58
+
59
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
60
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
61
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
62
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
63
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
64
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
65
+ SOFTWARE.