feat: accept error messages for required,array, and object validations

Author: thetutlage

factories/output.ts

@@ -18,7 +18,11 @@ import { defineInlineFunctions } from '../src/scripts/define_inline_functions.js
 export function getInitialOutput(options?: CompilerOptions) {
   return [
     `async function anonymous(root,meta,refs,messagesProvider,errorReporter) {`,
-    ...defineInlineErrorMessages().split(EOL),
+    ...defineInlineErrorMessages({
+      required: 'value is required',
+      object: 'value is not a valid object',
+      array: 'value is not a valid array',
+    }).split(EOL),
     ...defineInlineFunctions(options || { convertEmptyStringsToNull: false }).split(EOL),
     'let out;',
   ]

src/compiler/main.ts

@@ -73,7 +73,14 @@ export class Compiler {
    * Initiates the JS output
    */
   #initiateJSOutput() {
-    this.#buffer.writeStatement(defineInlineErrorMessages())
+    this.#buffer.writeStatement(
+      defineInlineErrorMessages({
+        required: 'value is required',
+        object: 'value is not a valid object',
+        array: 'value is not a valid array',
+        ...this.#options.messages,
+      })
+    )
     this.#buffer.writeStatement(defineInlineFunctions(this.#options))
     this.#buffer.writeStatement('let out;')
   }

src/scripts/define_error_messages.ts

@@ -7,12 +7,16 @@
  * file that was distributed with this source code.
  */
 
+import { CompilerOptions } from '../types.js'
+
 /**
  * Returns JS fragment for inline error messages for errors raised
  * by the compiler.
  */
-export function defineInlineErrorMessages() {
-  return `const REQUIRED = 'value is required';
-const NOT_AN_OBJECT = 'value is not a valid object';
-const NOT_AN_ARRAY = 'value is not a valid array';`
+export function defineInlineErrorMessages(
+  messages: Required<Exclude<CompilerOptions['messages'], undefined>>
+) {
+  return `const REQUIRED = '${messages.required}';
+const NOT_AN_OBJECT = '${messages.object}';
+const NOT_AN_ARRAY = '${messages.array}';`
 }

src/types.ts

@@ -523,4 +523,14 @@ export type CompilerOptions = {
    * normalization
    */
   convertEmptyStringsToNull: boolean
+
+  /**
+   * Provide messages to use for required, object and
+   * array validations.
+   */
+  messages?: Partial<{
+    required: string
+    object: string
+    array: string
+  }>
 }