@atproto/lexicon 0.0.4 → 0.2.0

package/src/validators/xrpc.ts

@@ -2,49 +2,49 @@ import { Lexicons } from '../lexicons'
 import { LexXrpcParameters, ValidationResult, ValidationError } from '../types'
 
 import * as PrimitiveValidators from './primitives'
+import { array } from './complex'
 
 export function params(
   lexicons: Lexicons,
   path: string,
   def: LexXrpcParameters,
-  value: unknown,
+  val: unknown,
 ): ValidationResult {
-  def = def as LexXrpcParameters
-
   // type
-  if (!value || typeof value !== 'object') {
-    // in this case, we just fall back to an object
-    value = {}
-  }
+  const value = val && typeof val === 'object' ? val : {}
+
+  const requiredProps = new Set(def.required ?? [])
 
-  // required
-  if (Array.isArray(def.required)) {
-    for (const key of def.required) {
-      if (!(key in (value as Record<string, unknown>))) {
+  // properties
+  let resultValue = value
+  if (typeof def.properties === 'object') {
+    for (const key in def.properties) {
+      const propDef = def.properties[key]
+      const validated =
+        propDef.type === 'array'
+          ? array(lexicons, key, propDef, value[key])
+          : PrimitiveValidators.validate(lexicons, key, propDef, value[key])
+      const propValue = validated.success ? validated.value : value[key]
+      const propIsUndefined = typeof propValue === 'undefined'
+      // Return error for bad validation, giving required rule precedence
+      if (propIsUndefined && requiredProps.has(key)) {
         return {
           success: false,
           error: new ValidationError(`${path} must have the property "${key}"`),
         }
+      } else if (!propIsUndefined && !validated.success) {
+        return validated
+      }
+      // Adjust value based on e.g. applied defaults, cloning shallowly if there was a changed value
+      if (propValue !== value[key]) {
+        if (resultValue === value) {
+          // Lazy shallow clone
+          resultValue = { ...value }
+        }
+        resultValue[key] = propValue
       }
     }
   }
 
-  // properties
-  for (const key in def.properties) {
-    if (typeof (value as Record<string, unknown>)[key] === 'undefined') {
-      continue // skip- if required, will have already failed
-    }
-    const paramDef = def.properties[key]
-    const res = PrimitiveValidators.validate(
-      lexicons,
-      key,
-      paramDef,
-      (value as Record<string, unknown>)[key],
-    )
-    if (!res.success) {
-      return res
-    }
-  }
-
-  return { success: true }
+  return { success: true, value: resultValue }
 }

package/tests/_scaffolds/lexicons.ts

@@ -13,30 +13,29 @@ export default [
             'object',
             'array',
             'boolean',
-            'number',
             'integer',
             'string',
-            'datetime',
+            'bytes',
+            'cidLink',
           ],
           properties: {
             object: { type: 'ref', ref: '#object' },
             array: { type: 'array', items: { type: 'string' } },
             boolean: { type: 'boolean' },
-            number: { type: 'number' },
             integer: { type: 'integer' },
             string: { type: 'string' },
-            datetime: { type: 'datetime' },
+            bytes: { type: 'bytes' },
+            cidLink: { type: 'cid-link' },
           },
         },
       },
       object: {
         type: 'object',
-        required: ['object', 'array', 'boolean', 'number', 'integer', 'string'],
+        required: ['object', 'array', 'boolean', 'integer', 'string'],
         properties: {
           object: { type: 'ref', ref: '#subobject' },
           array: { type: 'array', items: { type: 'string' } },
           boolean: { type: 'boolean' },
-          number: { type: 'number' },
           integer: { type: 'integer' },
           string: { type: 'string' },
         },
@@ -59,12 +58,13 @@ export default [
         description: 'A query',
         parameters: {
           type: 'params',
-          required: ['boolean', 'number', 'integer'],
+          required: ['boolean', 'integer'],
           properties: {
             boolean: { type: 'boolean' },
-            number: { type: 'number' },
             integer: { type: 'integer' },
             string: { type: 'string' },
+            array: { type: 'array', items: { type: 'string' } },
+            def: { type: 'integer', default: 0 },
           },
         },
         output: {
@@ -83,12 +83,12 @@ export default [
         description: 'A procedure',
         parameters: {
           type: 'params',
-          required: ['boolean', 'number', 'integer'],
+          required: ['boolean', 'integer'],
           properties: {
             boolean: { type: 'boolean' },
-            number: { type: 'number' },
             integer: { type: 'integer' },
             string: { type: 'string' },
+            array: { type: 'array', items: { type: 'string' } },
           },
         },
         input: {
@@ -114,7 +114,6 @@ export default [
             object: { type: 'ref', ref: 'com.example.kitchenSink#object' },
             array: { type: 'array', items: { type: 'string' } },
             boolean: { type: 'boolean' },
-            number: { type: 'number' },
             integer: { type: 'integer' },
             string: { type: 'string' },
           },
@@ -122,6 +121,33 @@ export default [
       },
     },
   },
+  {
+    lexicon: 1,
+    id: 'com.example.default',
+    defs: {
+      main: {
+        type: 'record',
+        record: {
+          type: 'object',
+          required: ['boolean'],
+          properties: {
+            boolean: { type: 'boolean', default: false },
+            integer: { type: 'integer', default: 0 },
+            string: { type: 'string', default: '' },
+            object: { type: 'ref', ref: '#object' },
+          },
+        },
+      },
+      object: {
+        type: 'object',
+        properties: {
+          boolean: { type: 'boolean', default: true },
+          integer: { type: 'integer', default: 1 },
+          string: { type: 'string', default: 'x' },
+        },
+      },
+    },
+  },
   {
     lexicon: 1,
     id: 'com.example.union',
@@ -186,7 +212,7 @@ export default [
               type: 'array',
               minLength: 2,
               maxLength: 4,
-              items: { type: 'number' },
+              items: { type: 'integer' },
             },
           },
         },
@@ -213,15 +239,15 @@ export default [
   },
   {
     lexicon: 1,
-    id: 'com.example.numberRange',
+    id: 'com.example.integerRange',
     defs: {
       main: {
         type: 'record',
         record: {
           type: 'object',
           properties: {
-            number: {
-              type: 'number',
+            integer: {
+              type: 'integer',
               minimum: 2,
               maximum: 4,
             },
@@ -232,16 +258,16 @@ export default [
   },
   {
     lexicon: 1,
-    id: 'com.example.numberEnum',
+    id: 'com.example.integerEnum',
     defs: {
       main: {
         type: 'record',
         record: {
           type: 'object',
           properties: {
-            number: {
-              type: 'number',
-              enum: [1, 1.5, 2],
+            integer: {
+              type: 'integer',
+              enum: [1, 2],
             },
           },
         },
@@ -250,15 +276,15 @@ export default [
   },
   {
     lexicon: 1,
-    id: 'com.example.numberConst',
+    id: 'com.example.integerConst',
     defs: {
       main: {
         type: 'record',
         record: {
           type: 'object',
           properties: {
-            number: {
-              type: 'number',
+            integer: {
+              type: 'integer',
               const: 0,
             },
           },
@@ -268,17 +294,17 @@ export default [
   },
   {
     lexicon: 1,
-    id: 'com.example.integerRange',
+    id: 'com.example.stringLength',
     defs: {
       main: {
         type: 'record',
         record: {
           type: 'object',
           properties: {
-            integer: {
-              type: 'integer',
-              minimum: 2,
-              maximum: 4,
+            string: {
+              type: 'string',
+              minLength: 2,
+              maxLength: 4,
             },
           },
         },
@@ -287,16 +313,17 @@ export default [
   },
   {
     lexicon: 1,
-    id: 'com.example.integerEnum',
+    id: 'com.example.stringLengthGrapheme',
     defs: {
       main: {
         type: 'record',
         record: {
           type: 'object',
           properties: {
-            integer: {
-              type: 'integer',
-              enum: [1, 2],
+            string: {
+              type: 'string',
+              minGraphemes: 2,
+              maxGraphemes: 4,
             },
           },
         },
@@ -305,16 +332,16 @@ export default [
   },
   {
     lexicon: 1,
-    id: 'com.example.integerConst',
+    id: 'com.example.stringEnum',
     defs: {
       main: {
         type: 'record',
         record: {
           type: 'object',
           properties: {
-            integer: {
-              type: 'integer',
-              const: 0,
+            string: {
+              type: 'string',
+              enum: ['a', 'b'],
             },
           },
         },
@@ -323,7 +350,7 @@ export default [
   },
   {
     lexicon: 1,
-    id: 'com.example.stringLength',
+    id: 'com.example.stringConst',
     defs: {
       main: {
         type: 'record',
@@ -332,8 +359,7 @@ export default [
           properties: {
             string: {
               type: 'string',
-              minLength: 2,
-              maxLength: 4,
+              const: 'a',
             },
           },
         },
@@ -342,17 +368,14 @@ export default [
   },
   {
     lexicon: 1,
-    id: 'com.example.stringEnum',
+    id: 'com.example.datetime',
     defs: {
       main: {
         type: 'record',
         record: {
           type: 'object',
           properties: {
-            string: {
-              type: 'string',
-              enum: ['a', 'b'],
-            },
+            datetime: { type: 'string', format: 'datetime' },
           },
         },
       },
@@ -360,17 +383,14 @@ export default [
   },
   {
     lexicon: 1,
-    id: 'com.example.stringConst',
+    id: 'com.example.uri',
     defs: {
       main: {
         type: 'record',
         record: {
           type: 'object',
           properties: {
-            string: {
-              type: 'string',
-              const: 'a',
-            },
+            uri: { type: 'string', format: 'uri' },
           },
         },
       },
@@ -378,15 +398,122 @@ export default [
   },
   {
     lexicon: 1,
-    id: 'com.example.datetime',
+    id: 'com.example.atUri',
     defs: {
       main: {
         type: 'record',
         record: {
           type: 'object',
           properties: {
-            datetime: {
-              type: 'datetime',
+            atUri: { type: 'string', format: 'at-uri' },
+          },
+        },
+      },
+    },
+  },
+  {
+    lexicon: 1,
+    id: 'com.example.did',
+    defs: {
+      main: {
+        type: 'record',
+        record: {
+          type: 'object',
+          properties: {
+            did: { type: 'string', format: 'did' },
+          },
+        },
+      },
+    },
+  },
+  {
+    lexicon: 1,
+    id: 'com.example.handle',
+    defs: {
+      main: {
+        type: 'record',
+        record: {
+          type: 'object',
+          properties: {
+            handle: { type: 'string', format: 'handle' },
+          },
+        },
+      },
+    },
+  },
+  {
+    lexicon: 1,
+    id: 'com.example.atIdentifier',
+    defs: {
+      main: {
+        type: 'record',
+        record: {
+          type: 'object',
+          properties: {
+            atIdentifier: { type: 'string', format: 'at-identifier' },
+          },
+        },
+      },
+    },
+  },
+  {
+    lexicon: 1,
+    id: 'com.example.nsid',
+    defs: {
+      main: {
+        type: 'record',
+        record: {
+          type: 'object',
+          properties: {
+            nsid: { type: 'string', format: 'nsid' },
+          },
+        },
+      },
+    },
+  },
+  {
+    lexicon: 1,
+    id: 'com.example.cid',
+    defs: {
+      main: {
+        type: 'record',
+        record: {
+          type: 'object',
+          properties: {
+            cid: { type: 'string', format: 'cid' },
+          },
+        },
+      },
+    },
+  },
+  {
+    lexicon: 1,
+    id: 'com.example.language',
+    defs: {
+      main: {
+        type: 'record',
+        record: {
+          type: 'object',
+          properties: {
+            language: { type: 'string', format: 'language' },
+          },
+        },
+      },
+    },
+  },
+  {
+    lexicon: 1,
+    id: 'com.example.byteLength',
+    defs: {
+      main: {
+        type: 'record',
+        record: {
+          type: 'object',
+          properties: {
+            bytes: {
+              type: 'bytes',
+              minLength: 2,
+              maxLength: 4,
             },
           },
         },