@sinclair/typebox - npm Package Compare versions

Comparing version 0.12.8 to 0.12.9

package.json

 {
   "name": "@sinclair/typebox",
-  "version": "0.12.8",
+  "version": "0.12.9",
   "description": "JSONSchema Type Builder with Static Type Resolution for TypeScript",
@@ -25,7 +25,7 @@ "keywords": [
   "devDependencies": {
-    "@types/ajv": "^1.0.0",
     "@types/chai": "^4.1.3",
     "@types/mocha": "^5.2.0",
     "@types/node": "^13.7.7",
-    "ajv": "^6.12.0",
+    "ajv": "^7.1.1",
+    "ajv-formats": "^1.5.1",
     "chai": "^4.1.2",
@@ -32,0 +32,0 @@ "mocha": "^7.1.1",

readme.md

@@ -48,2 +48,3 @@ <div align='center'>
 - [Options](#Options)
+- [Strict](#Strict)
 - [Functions](#Functions)
@@ -77,3 +78,3 @@ - [Interfaces](#Interfaces)
 //
-// ...you can express this type in the following way.
+// ... you can express this type in the following way.
 //
@@ -104,3 +105,3 @@ //--------------------------------------------------------------------------------------------
 //
-// ...then infer back to the original static type this way.
+// ... then infer back to the original static type this way.
 //
@@ -117,8 +118,8 @@ //--------------------------------------------------------------------------------------------
 //
-// ...then use the type both as JSON schema and as a TypeScript type.
+// ... then use the type both as JSON schema and as a TypeScript type.
 //
 //--------------------------------------------------------------------------------------------
 
-function receive(record: Record) { // ...as a type
-    if(JSON.validate(Record, {     // ...as a schema
+function receive(record: Record) { // ... as a type
+    if(JSON.validate(Record, {     // ... as a schema
         id: '42', 
@@ -319,2 +320,31 @@ name: 'dave',
 
+<a name="Strict"></a>
+
+### Strict
+
+TypeBox includes the properties `kind` and `modifier` on each underlying schema. These properties are used to help TypeBox statically resolve the schemas to the appropriate TypeScript type as well as apply the appropriate modifiers to an objects properties (such as optional). These properties are not strictly valid JSON schema so in some cases it may be desirable to omit them. TypeBox provides a `Type.Strict()` function that will omit these properties if nessasary.
+
+```typescript
+const T = Type.Object({                 // const T = {
+    name: Type.Optional(Type.String())  //   kind: Symbol(ObjectKind),
+})                                      //   type: 'object',
+                                        //   properties: {
+                                        //     name: {
+                                        //       kind: Symbol(StringKind),
+                                        //       type: 'string',
+                                        //       modifier: Symbol(OptionalModifier)
+                                        //     }
+                                        //   }
+                                        // }
+
+const U = Type.Strict(T)                // const U = {
+                                        //     type: 'object', 
+                                        //     properties: { 
+                                        //         name: { 
+                                        //             type: 'string' 
+                                        //         } 
+                                        //     } 
+                                        // }
+```
+
 <a name="Functions"></a>
@@ -470,20 +500,45 @@
 
-TypeBox does not provide JSON schema validation out of the box and expects users to select an appropriate JSON schema validation library. TypeBox schemas should match JSON Schema draft 6. So any validation library capable of draft 6 should be fine.
+TypeBox does not provide JSON schema validation out of the box and expects users to select an appropriate JSON schema validation library for their needs. TypeBox schemas should match JSON Schema draft 6 so any library capable of draft 6 should be fine. A good library to use for validation is [Ajv](https://www.npmjs.com/package/ajv). The following example shows setting up Ajv 7 to work with TypeBox.
 
-A good validation library to use is [AJV](https://www.npmjs.com/package/ajv). The following demonstrates basic usage.
+```bash
+$ npm install ajv ajv-formats --save
+```
 
 ```typescript
 import { Type } from '@sinclair/typebox'
+import addFormats from 'ajv-formats'
+import Ajv from 'ajv'
 
-import * as Ajv from 'ajv'
+// Setup
+function setupAjv(): Ajv {
+    const ajv = new Ajv()
+    ajv.addKeyword('kind')
+    ajv.addKeyword('modifier')
+    return addFormats(ajv, [
+        'date-time', 
+        'time', 
+        'date', 
+        'email',  
+        'hostname', 
+        'ipv4', 
+        'ipv6', 
+        'uri', 
+        'uri-reference', 
+        'uuid',
+        'uri-template', 
+        'json-pointer', 
+        'relative-json-pointer', 
+        'regex'
+    ])
+}
 
-const ajv = new Ajv()
-
+// TypeBox
 const User = Type.Object({
-    name:  Type.String(),
+    name: Type.String(),
     email: Type.String({ format: 'email' })
 })
 
-const isValid = ajv.validate(User, { 
-    name:  'dave', 
+// Validate
+const isValid = setupAjv().validate(User, { 
+    name: 'dave', 
     email: '[e-mail]' 
@@ -494,39 +549,4 @@ })
 // isValid -> true
+//
 ```
 
-#### Strict
-
-By default, TypeBox will create `kind` and `modifier` properties on the underlying schemas. TypeBox uses these to help statically resolve the schemas to TypeScript types as well as apply the appropriate modifiers to an objects properties (such as optional). In most cases this is fine, however if using a validator that mandates on strict JSON schemas with known schema properties, you can use `Type.Strict()` to omit the `kind` and `modifier` properties. As follows.
-
-```typescript
-import { Type, Static } from '@sinclair/typebox'
-
-const T = Type.Object({
-    email: Type.Optional(Type.String())
-})
-
-// const T = {
-//   kind: Symbol(ObjectKind),
-//   type: 'object',
-//   properties: {
-//     email: {
-//       kind: Symbol(StringKind),
-//       type: 'string',
-//       modifier: Symbol(OptionalModifier)
-//     }
-//   }
-// }
-
-const U = Type.Strict(Type.Object({
-    email: Type.Optional(Type.String())
-}))
-
-// const U = { 
-//     type: 'object', 
-//     properties: { 
-//         email: { 
-//             type: 'string' 
-//         } 
-//     } 
-// }
-```

No alert changes

Improved metrics

Total package byte prevSize

60609

increased by2.02%

Number of lines in readme file

546

increased by4%

No dependency changes