feat: Add new keyword to check max length based on space type (#949)

Author: ChaituVR

src/schemas/proposal.json

@@ -16,7 +16,10 @@
           "type": "string",
           "title": "body",
           "minLength": 0,
-          "maxLength": 20000
+          "maxLengthWithSpaceType": {
+            "default": 10000,
+            "turbo": 20000
+          }
         },
         "discussion": {
           "type": "string",

src/utils.ts

@@ -92,6 +92,27 @@ ajv.addKeyword({
   }
 });
 
+ajv.addKeyword({
+  keyword: 'maxLengthWithSpaceType',
+  validate: function validate(schema, data) {
+    // @ts-ignore
+    const spaceType = this.spaceType || 'default';
+    const isValid = data.length <= schema[spaceType];
+    if (!isValid) {
+      // @ts-ignore
+      validate.errors = [
+        {
+          keyword: 'maxLengthWithSpaceType',
+          message: `must NOT have more than ${schema[spaceType]} characters`,
+          params: { limit: schema[spaceType] }
+        }
+      ];
+    }
+    return isValid;
+  },
+  errors: true
+});
+
 // Custom URL format to allow empty string values
 // https://github.com/snapshot-labs/snapshot.js/pull/541/files
 ajv.addFormat('customUrl', {
@@ -423,11 +444,17 @@ export async function validate(
   }
 }
 
+interface validateSchemaOptions {
+  snapshotEnv?: string;
+  spaceType?: string;
+}
+
 export function validateSchema(
   schema,
   data,
-  options = {
-    snapshotEnv: 'default'
+  options: validateSchemaOptions = {
+    snapshotEnv: 'default',
+    spaceType: 'default'
   }
 ) {
   const ajvValidate = ajv.compile(schema);

test/examples/proposal-maxLengthWithSpaceType-error.json

@@ -0,0 +1,11 @@
+[
+  {
+    "instancePath": "/body",
+    "keyword": "maxLengthWithSpaceType",
+    "message": "must NOT have more than 10000 characters",
+    "params": {
+      "limit": 10000
+    },
+    "schemaPath": "#/properties/body/maxLengthWithSpaceType"
+  }
+]