@objectstack/spec 0.3.2 → 0.3.3

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,

package/dist/{system → driver}/datasource.zod.d.ts

@@ -1,10 +1,4 @@
 import { z } from 'zod';
-/**
- * Driver Type Enum (Built-in)
- * Standard drivers supported by the core platform.
- * Plugins can register additional drivers using different identifiers.
- */
-export declare const BuiltInDrivers: readonly ["postgres", "mysql", "sqlserver", "oracle", "sqlite", "mongo", "redis", "excel", "csv", "airtable", "rest_api", "graphql", "odata", "salesforce", "sap", "workday"];
 /**
  * Driver Identifier
  * Can be a built-in driver or a plugin-contributed driver (e.g., "com.vendor.snowflake").
@@ -188,6 +182,32 @@ export declare const DatasourceSchema: z.ZodObject<{
      * Stored securely (passwords usually interpolated from ENV).
      */
     config: z.ZodRecord<z.ZodString, z.ZodAny>;
+    /**
+     * Connection Pool Configuration
+     * Standard connection pooling settings.
+     */
+    pool: z.ZodOptional<z.ZodObject<{
+        min: z.ZodDefault<z.ZodNumber>;
+        max: z.ZodDefault<z.ZodNumber>;
+        idleTimeoutMillis: z.ZodDefault<z.ZodNumber>;
+        connectionTimeoutMillis: z.ZodDefault<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        min: number;
+        max: number;
+        idleTimeoutMillis: number;
+        connectionTimeoutMillis: number;
+    }, {
+        min?: number | undefined;
+        max?: number | undefined;
+        idleTimeoutMillis?: number | undefined;
+        connectionTimeoutMillis?: number | undefined;
+    }>>;
+    /**
+     * Read Replicas
+     * Optional list of duplicate configurations for read-only operations.
+     * Useful for scaling read throughput.
+     */
+    readReplicas: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">>;
     /**
      * Capability Overrides
      * Manually override what the driver claims to support.
@@ -247,8 +267,8 @@ export declare const DatasourceSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     name: string;
     active: boolean;
-    config: Record<string, any>;
     driver: string;
+    config: Record<string, any>;
     label?: string | undefined;
     description?: string | undefined;
     capabilities?: {
@@ -264,10 +284,17 @@ export declare const DatasourceSchema: z.ZodObject<{
         readOnly: boolean;
         dynamicSchema: boolean;
     } | undefined;
+    pool?: {
+        min: number;
+        max: number;
+        idleTimeoutMillis: number;
+        connectionTimeoutMillis: number;
+    } | undefined;
+    readReplicas?: Record<string, any>[] | undefined;
 }, {
     name: string;
-    config: Record<string, any>;
     driver: string;
+    config: Record<string, any>;
     label?: string | undefined;
     description?: string | undefined;
     active?: boolean | undefined;
@@ -284,6 +311,13 @@ export declare const DatasourceSchema: z.ZodObject<{
         readOnly?: boolean | undefined;
         dynamicSchema?: boolean | undefined;
     } | undefined;
+    pool?: {
+        min?: number | undefined;
+        max?: number | undefined;
+        idleTimeoutMillis?: number | undefined;
+        connectionTimeoutMillis?: number | undefined;
+    } | undefined;
+    readReplicas?: Record<string, any>[] | undefined;
 }>;
 export type Datasource = z.infer<typeof DatasourceSchema>;
 export type DatasourceConfig = z.infer<typeof DatasourceCapabilities>;

package/dist/driver/datasource.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"datasource.zod.d.ts","sourceRoot":"","sources":["../../src/driver/datasource.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;GAGG;AACH,eAAO,MAAM,UAAU,aAAsD,CAAC;AAE9E;;;;GAIG;AACH,eAAO,MAAM,sBAAsB;;;;;IAMjC;;;;OAIG;;IAGH;;;OAGG;;QAeH,oCAAoC;;QAOpC,iDAAiD;;QAGjD,oDAAoD;;QAGpD,oCAAoC;;QAGpC,2CAA2C;;QAG3C,oCAAoC;;QAGpC,8BAA8B;;QAG9B,2CAA2C;;QAO3C,oCAAoC;;QAGpC,oBAAoB;;QAGpB,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAnD/C,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB;IAKjC,oCAAoC;;IAOpC,iDAAiD;;IAGjD,oDAAoD;;IAGpD,oCAAoC;;IAGpC,2CAA2C;;IAG3C,oCAAoC;;IAGpC,8BAA8B;;IAG9B,2CAA2C;;IAO3C,oCAAoC;;IAGpC,oBAAoB;;IAGpB,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;EAE/C,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAC3B,mBAAmB;;IAGnB,kBAAkB;;IAGlB,aAAa;;IAGb;;;;OAIG;;IAGH;;;OAGG;;;;;;;;;;;;;;;;;IAQH;;;;OAIG;;IAGH;;;OAGG;;QApFH,oCAAoC;;QAOpC,iDAAiD;;QAGjD,oDAAoD;;QAGpD,oCAAoC;;QAGpC,2CAA2C;;QAG3C,oCAAoC;;QAGpC,8BAA8B;;QAG9B,2CAA2C;;QAO3C,oCAAoC;;QAGpC,oBAAoB;;QAGpB,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;IAiD/C,kBAAkB;;IAGlB,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAElB,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC"}

package/dist/{system → driver}/datasource.zod.js

@@ -1,19 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DatasourceSchema = exports.DatasourceCapabilities = exports.DriverDefinitionSchema = exports.DriverType = exports.BuiltInDrivers = void 0;
+exports.DatasourceSchema = exports.DatasourceCapabilities = exports.DriverDefinitionSchema = exports.DriverType = void 0;
 const zod_1 = require("zod");
-/**
- * Driver Type Enum (Built-in)
- * Standard drivers supported by the core platform.
- * Plugins can register additional drivers using different identifiers.
- */
-exports.BuiltInDrivers = [
-    'postgres', 'mysql', 'sqlserver', 'oracle', 'sqlite', // SQL
-    'mongo', 'redis', // NoSQL
-    'excel', 'csv', 'airtable', // Spreadsheet / Low-code
-    'rest_api', 'graphql', 'odata', // Web Services
-    'salesforce', 'sap', 'workday' // Enterprise SaaS
-];
 /**
  * Driver Identifier
  * Can be a built-in driver or a plugin-contributed driver (e.g., "com.vendor.snowflake").
@@ -97,6 +85,22 @@ exports.DatasourceSchema = zod_1.z.object({
      * Stored securely (passwords usually interpolated from ENV).
      */
     config: zod_1.z.record(zod_1.z.any()).describe('Driver specific configuration'),
+    /**
+     * Connection Pool Configuration
+     * Standard connection pooling settings.
+     */
+    pool: zod_1.z.object({
+        min: zod_1.z.number().default(0).describe('Minimum connections'),
+        max: zod_1.z.number().default(10).describe('Maximum connections'),
+        idleTimeoutMillis: zod_1.z.number().default(30000).describe('Idle timeout'),
+        connectionTimeoutMillis: zod_1.z.number().default(3000).describe('Connection establishment timeout'),
+    }).optional().describe('Connection pool settings'),
+    /**
+     * Read Replicas
+     * Optional list of duplicate configurations for read-only operations.
+     * Useful for scaling read throughput.
+     */
+    readReplicas: zod_1.z.array(zod_1.z.record(zod_1.z.any())).optional().describe('Read-only replica configurations'),
     /**
      * Capability Overrides
      * Manually override what the driver claims to support.