@objectstack/spec 0.3.2 → 0.4.1

package/dist/data/validation.zod.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConditionalValidationSchema = exports.ValidationRuleSchema = exports.CustomValidatorSchema = exports.AsyncValidationSchema = exports.CrossFieldValidationSchema = exports.FormatValidationSchema = exports.StateMachineValidationSchema = exports.UniquenessValidationSchema = exports.ScriptValidationSchema = void 0;
+exports.ConditionalValidationSchema = exports.ValidationRuleSchema = exports.CustomValidatorSchema = exports.AsyncValidationSchema = exports.JSONValidationSchema = exports.CrossFieldValidationSchema = exports.FormatValidationSchema = exports.StateMachineValidationSchema = exports.UniquenessValidationSchema = exports.ScriptValidationSchema = void 0;
 const zod_1 = require("zod");
 /**
  * # ObjectStack Validation Protocol
@@ -50,12 +50,25 @@ const zod_1 = require("zod");
  * Base Validation Rule
  *
  * All validation rules extend from this base schema with common properties.
+ *
+ * ## Industry Standard Enhancements
+ * - **Label/Description**: Essential for governance in large systems with thousands of rules.
+ * - **Events**: granular control over validation timing (Context-aware validation).
+ * - **Tags**: categorization for reporting and management.
  */
 const BaseValidationSchema = zod_1.z.object({
-    name: zod_1.z.string().regex(/^[a-z_][a-z0-9_]*$/).describe('Unique rule name'),
+    // Identification
+    name: zod_1.z.string().regex(/^[a-z_][a-z0-9_]*$/).describe('Unique rule name (snake_case)'),
+    label: zod_1.z.string().optional().describe('Human-readable label for the rule listing'),
+    description: zod_1.z.string().optional().describe('Administrative notes explaining the business reason'),
+    // Execution Control
     active: zod_1.z.boolean().default(true),
+    events: zod_1.z.array(zod_1.z.enum(['insert', 'update', 'delete'])).default(['insert', 'update']).describe('Validation contexts'),
+    // Classification
+    tags: zod_1.z.array(zod_1.z.string()).optional().describe('Categorization tags (e.g., "compliance", "billing")'),
+    // Feedback
     severity: zod_1.z.enum(['error', 'warning', 'info']).default('error'),
-    message: zod_1.z.string().describe('Error message to display'),
+    message: zod_1.z.string().describe('Error message to display to the user'),
 });
 /**
  * 1. Script/Expression Validation
@@ -163,7 +176,21 @@ exports.CrossFieldValidationSchema = BaseValidationSchema.extend({
     fields: zod_1.z.array(zod_1.z.string()).describe('Fields involved in the validation'),
 });
 /**
- * 6. Async Validation
+ * 6. JSON Structure Validation
+ * Validates JSON fields against a JSON Schema.
+ *
+ * ## Use Cases
+ * - Validating configuration objects stored in JSON fields
+ * - Enforcing API payload structures
+ * - Complex nested data validation
+ */
+exports.JSONValidationSchema = BaseValidationSchema.extend({
+    type: zod_1.z.literal('json_schema'),
+    field: zod_1.z.string().describe('JSON field to validate'),
+    schema: zod_1.z.record(zod_1.z.any()).describe('JSON Schema object definition'),
+});
+/**
+ * 7. Async Validation
  * Remote validation via API call or database query.
  *
  * ## Use Cases
@@ -276,35 +303,29 @@ exports.CrossFieldValidationSchema = BaseValidationSchema.extend({
  *   }
  * }
  * ```
- *
- * ## Best Practices
- * - Always set a reasonable `timeout` (default is 5000ms)
- * - Use `debounce` for fields that are typed (300-500ms recommended)
- * - Implement proper error handling on the server side
- * - Cache validation results when appropriate
- * - Consider rate limiting for external API calls
  */
 exports.AsyncValidationSchema = BaseValidationSchema.extend({
     type: zod_1.z.literal('async'),
     field: zod_1.z.string().describe('Field to validate'),
     validatorUrl: zod_1.z.string().optional().describe('External API endpoint for validation'),
+    method: zod_1.z.enum(['GET', 'POST']).default('GET').describe('HTTP method for external call'),
+    headers: zod_1.z.record(zod_1.z.string()).optional().describe('Custom headers for the request'),
     validatorFunction: zod_1.z.string().optional().describe('Reference to custom validator function'),
     timeout: zod_1.z.number().optional().default(5000).describe('Timeout in milliseconds'),
     debounce: zod_1.z.number().optional().describe('Debounce delay in milliseconds'),
     params: zod_1.z.record(zod_1.z.any()).optional().describe('Additional parameters to pass to validator'),
 });
 /**
- * 7. Custom Validator Function
+ * 8. Custom Validator Function
  * User-defined validation logic with code reference.
  */
 exports.CustomValidatorSchema = BaseValidationSchema.extend({
     type: zod_1.z.literal('custom'),
-    field: zod_1.z.string().optional().describe('Field to validate (optional for record-level validation)'),
-    validatorFunction: zod_1.z.string().describe('Function name or reference to custom validator'),
-    params: zod_1.z.record(zod_1.z.any()).optional().describe('Additional parameters for the validator'),
+    handler: zod_1.z.string().describe('Name of the custom validation function registered in the system'),
+    params: zod_1.z.record(zod_1.z.any()).optional().describe('Parameters passed to the custom handler'),
 });
 /**
- * Master Validation Rule Schema (forward declared for circular reference)
+ * 9. Master Validation Rule Schema
  */
 exports.ValidationRuleSchema = zod_1.z.lazy(() => zod_1.z.discriminatedUnion('type', [
     exports.ScriptValidationSchema,
@@ -312,6 +333,7 @@ exports.ValidationRuleSchema = zod_1.z.lazy(() => zod_1.z.discriminatedUnion('ty
     exports.StateMachineValidationSchema,
     exports.FormatValidationSchema,
     exports.CrossFieldValidationSchema,
+    exports.JSONValidationSchema,
     exports.AsyncValidationSchema,
     exports.CustomValidatorSchema,
     exports.ConditionalValidationSchema,