@objectstack/spec 0.3.0 → 0.3.1

package/dist/ui/theme.zod.d.ts

@@ -292,8 +292,8 @@ export declare const BorderRadiusSchema: z.ZodObject<{
     '2xl': z.ZodOptional<z.ZodString>;
     full: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    full?: string | undefined;
     none?: string | undefined;
+    full?: string | undefined;
     base?: string | undefined;
     sm?: string | undefined;
     lg?: string | undefined;
@@ -301,8 +301,8 @@ export declare const BorderRadiusSchema: z.ZodObject<{
     '2xl'?: string | undefined;
     md?: string | undefined;
 }, {
-    full?: string | undefined;
     none?: string | undefined;
+    full?: string | undefined;
     base?: string | undefined;
     sm?: string | undefined;
     lg?: string | undefined;
@@ -324,8 +324,8 @@ export declare const ShadowSchema: z.ZodObject<{
     '2xl': z.ZodOptional<z.ZodString>;
     inner: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    inner?: string | undefined;
     none?: string | undefined;
+    inner?: string | undefined;
     base?: string | undefined;
     sm?: string | undefined;
     lg?: string | undefined;
@@ -333,8 +333,8 @@ export declare const ShadowSchema: z.ZodObject<{
     '2xl'?: string | undefined;
     md?: string | undefined;
 }, {
-    inner?: string | undefined;
     none?: string | undefined;
+    inner?: string | undefined;
     base?: string | undefined;
     sm?: string | undefined;
     lg?: string | undefined;
@@ -759,8 +759,8 @@ export declare const ThemeSchema: z.ZodObject<{
         '2xl': z.ZodOptional<z.ZodString>;
         full: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        full?: string | undefined;
         none?: string | undefined;
+        full?: string | undefined;
         base?: string | undefined;
         sm?: string | undefined;
         lg?: string | undefined;
@@ -768,8 +768,8 @@ export declare const ThemeSchema: z.ZodObject<{
         '2xl'?: string | undefined;
         md?: string | undefined;
     }, {
-        full?: string | undefined;
         none?: string | undefined;
+        full?: string | undefined;
         base?: string | undefined;
         sm?: string | undefined;
         lg?: string | undefined;
@@ -788,8 +788,8 @@ export declare const ThemeSchema: z.ZodObject<{
         '2xl': z.ZodOptional<z.ZodString>;
         inner: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        inner?: string | undefined;
         none?: string | undefined;
+        inner?: string | undefined;
         base?: string | undefined;
         sm?: string | undefined;
         lg?: string | undefined;
@@ -797,8 +797,8 @@ export declare const ThemeSchema: z.ZodObject<{
         '2xl'?: string | undefined;
         md?: string | undefined;
     }, {
-        inner?: string | undefined;
         none?: string | undefined;
+        inner?: string | undefined;
         base?: string | undefined;
         sm?: string | undefined;
         lg?: string | undefined;
@@ -1019,8 +1019,8 @@ export declare const ThemeSchema: z.ZodObject<{
         '24'?: string | undefined;
     } | undefined;
     borderRadius?: {
-        full?: string | undefined;
         none?: string | undefined;
+        full?: string | undefined;
         base?: string | undefined;
         sm?: string | undefined;
         lg?: string | undefined;
@@ -1029,8 +1029,8 @@ export declare const ThemeSchema: z.ZodObject<{
         md?: string | undefined;
     } | undefined;
     shadows?: {
-        inner?: string | undefined;
         none?: string | undefined;
+        inner?: string | undefined;
         base?: string | undefined;
         sm?: string | undefined;
         lg?: string | undefined;
@@ -1154,8 +1154,8 @@ export declare const ThemeSchema: z.ZodObject<{
         '24'?: string | undefined;
     } | undefined;
     borderRadius?: {
-        full?: string | undefined;
         none?: string | undefined;
+        full?: string | undefined;
         base?: string | undefined;
         sm?: string | undefined;
         lg?: string | undefined;
@@ -1164,8 +1164,8 @@ export declare const ThemeSchema: z.ZodObject<{
         md?: string | undefined;
     } | undefined;
     shadows?: {
-        inner?: string | undefined;
         none?: string | undefined;
+        inner?: string | undefined;
         base?: string | undefined;
         sm?: string | undefined;
         lg?: string | undefined;

package/dist/ui/widget.zod.d.ts

@@ -48,7 +48,7 @@ export declare const FieldWidgetPropsSchema: z.ZodObject<{
     field: z.ZodObject<{
         name: z.ZodOptional<z.ZodString>;
         label: z.ZodOptional<z.ZodString>;
-        type: z.ZodEnum<["text", "textarea", "email", "url", "phone", "password", "markdown", "html", "richtext", "number", "currency", "percent", "date", "datetime", "time", "boolean", "select", "lookup", "master_detail", "image", "file", "avatar", "formula", "summary", "autonumber", "location", "address", "code", "color", "rating", "signature"]>;
+        type: z.ZodEnum<["text", "textarea", "email", "url", "phone", "password", "markdown", "html", "richtext", "number", "currency", "percent", "date", "datetime", "time", "boolean", "select", "lookup", "master_detail", "image", "file", "avatar", "formula", "summary", "autonumber", "location", "geolocation", "address", "code", "color", "rating", "slider", "signature", "qrcode"]>;
         description: z.ZodOptional<z.ZodString>;
         format: z.ZodOptional<z.ZodString>;
         required: z.ZodDefault<z.ZodBoolean>;
@@ -108,13 +108,20 @@ export declare const FieldWidgetPropsSchema: z.ZodObject<{
         colorFormat: z.ZodOptional<z.ZodEnum<["hex", "rgb", "rgba", "hsl"]>>;
         allowAlpha: z.ZodOptional<z.ZodBoolean>;
         presetColors: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        step: z.ZodOptional<z.ZodNumber>;
+        showValue: z.ZodOptional<z.ZodBoolean>;
+        marks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        barcodeFormat: z.ZodOptional<z.ZodEnum<["qr", "ean13", "ean8", "code128", "code39", "upca", "upce"]>>;
+        qrErrorCorrection: z.ZodOptional<z.ZodEnum<["L", "M", "Q", "H"]>>;
+        displayValue: z.ZodOptional<z.ZodBoolean>;
+        allowScanning: z.ZodOptional<z.ZodBoolean>;
         hidden: z.ZodDefault<z.ZodBoolean>;
         readonly: z.ZodDefault<z.ZodBoolean>;
         encryption: z.ZodDefault<z.ZodBoolean>;
         index: z.ZodDefault<z.ZodBoolean>;
         externalId: z.ZodDefault<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
-        type: "number" | "boolean" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "date" | "datetime" | "time" | "select" | "lookup" | "master_detail" | "image" | "file" | "avatar" | "formula" | "summary" | "autonumber" | "location" | "address" | "code" | "color" | "rating" | "signature";
+        type: "number" | "boolean" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "date" | "datetime" | "time" | "select" | "lookup" | "master_detail" | "image" | "file" | "avatar" | "formula" | "summary" | "autonumber" | "location" | "geolocation" | "address" | "code" | "color" | "rating" | "slider" | "signature" | "qrcode";
         required: boolean;
         searchable: boolean;
         multiple: boolean;
@@ -163,8 +170,15 @@ export declare const FieldWidgetPropsSchema: z.ZodObject<{
         colorFormat?: "hex" | "rgb" | "rgba" | "hsl" | undefined;
         allowAlpha?: boolean | undefined;
         presetColors?: string[] | undefined;
+        step?: number | undefined;
+        showValue?: boolean | undefined;
+        marks?: Record<string, string> | undefined;
+        barcodeFormat?: "qr" | "ean13" | "ean8" | "code128" | "code39" | "upca" | "upce" | undefined;
+        qrErrorCorrection?: "L" | "M" | "Q" | "H" | undefined;
+        displayValue?: boolean | undefined;
+        allowScanning?: boolean | undefined;
     }, {
-        type: "number" | "boolean" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "date" | "datetime" | "time" | "select" | "lookup" | "master_detail" | "image" | "file" | "avatar" | "formula" | "summary" | "autonumber" | "location" | "address" | "code" | "color" | "rating" | "signature";
+        type: "number" | "boolean" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "date" | "datetime" | "time" | "select" | "lookup" | "master_detail" | "image" | "file" | "avatar" | "formula" | "summary" | "autonumber" | "location" | "geolocation" | "address" | "code" | "color" | "rating" | "slider" | "signature" | "qrcode";
         formula?: string | undefined;
         options?: {
             value: string;
@@ -208,6 +222,13 @@ export declare const FieldWidgetPropsSchema: z.ZodObject<{
         colorFormat?: "hex" | "rgb" | "rgba" | "hsl" | undefined;
         allowAlpha?: boolean | undefined;
         presetColors?: string[] | undefined;
+        step?: number | undefined;
+        showValue?: boolean | undefined;
+        marks?: Record<string, string> | undefined;
+        barcodeFormat?: "qr" | "ean13" | "ean8" | "code128" | "code39" | "upca" | "upce" | undefined;
+        qrErrorCorrection?: "L" | "M" | "Q" | "H" | undefined;
+        displayValue?: boolean | undefined;
+        allowScanning?: boolean | undefined;
         hidden?: boolean | undefined;
         readonly?: boolean | undefined;
         encryption?: boolean | undefined;
@@ -227,7 +248,7 @@ export declare const FieldWidgetPropsSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     required: boolean;
     field: {
-        type: "number" | "boolean" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "date" | "datetime" | "time" | "select" | "lookup" | "master_detail" | "image" | "file" | "avatar" | "formula" | "summary" | "autonumber" | "location" | "address" | "code" | "color" | "rating" | "signature";
+        type: "number" | "boolean" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "date" | "datetime" | "time" | "select" | "lookup" | "master_detail" | "image" | "file" | "avatar" | "formula" | "summary" | "autonumber" | "location" | "geolocation" | "address" | "code" | "color" | "rating" | "slider" | "signature" | "qrcode";
         required: boolean;
         searchable: boolean;
         multiple: boolean;
@@ -276,6 +297,13 @@ export declare const FieldWidgetPropsSchema: z.ZodObject<{
         colorFormat?: "hex" | "rgb" | "rgba" | "hsl" | undefined;
         allowAlpha?: boolean | undefined;
         presetColors?: string[] | undefined;
+        step?: number | undefined;
+        showValue?: boolean | undefined;
+        marks?: Record<string, string> | undefined;
+        barcodeFormat?: "qr" | "ean13" | "ean8" | "code128" | "code39" | "upca" | "upce" | undefined;
+        qrErrorCorrection?: "L" | "M" | "Q" | "H" | undefined;
+        displayValue?: boolean | undefined;
+        allowScanning?: boolean | undefined;
     };
     readonly: boolean;
     onChange: (args_0: any, ...args: unknown[]) => void;
@@ -285,7 +313,7 @@ export declare const FieldWidgetPropsSchema: z.ZodObject<{
     record?: Record<string, any> | undefined;
 }, {
     field: {
-        type: "number" | "boolean" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "date" | "datetime" | "time" | "select" | "lookup" | "master_detail" | "image" | "file" | "avatar" | "formula" | "summary" | "autonumber" | "location" | "address" | "code" | "color" | "rating" | "signature";
+        type: "number" | "boolean" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "date" | "datetime" | "time" | "select" | "lookup" | "master_detail" | "image" | "file" | "avatar" | "formula" | "summary" | "autonumber" | "location" | "geolocation" | "address" | "code" | "color" | "rating" | "slider" | "signature" | "qrcode";
         formula?: string | undefined;
         options?: {
             value: string;
@@ -329,6 +357,13 @@ export declare const FieldWidgetPropsSchema: z.ZodObject<{
         colorFormat?: "hex" | "rgb" | "rgba" | "hsl" | undefined;
         allowAlpha?: boolean | undefined;
         presetColors?: string[] | undefined;
+        step?: number | undefined;
+        showValue?: boolean | undefined;
+        marks?: Record<string, string> | undefined;
+        barcodeFormat?: "qr" | "ean13" | "ean8" | "code128" | "code39" | "upca" | "upce" | undefined;
+        qrErrorCorrection?: "L" | "M" | "Q" | "H" | undefined;
+        displayValue?: boolean | undefined;
+        allowScanning?: boolean | undefined;
         hidden?: boolean | undefined;
         readonly?: boolean | undefined;
         encryption?: boolean | undefined;

package/dist/ui/widget.zod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"widget.zod.d.ts","sourceRoot":"","sources":["../../src/ui/widget.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,sBAAsB;IACjC;;;OAGG;;IAGH;;;;;OAKG;;IAMH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAGH;;;OAGG;;IAGH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC"}
+{"version":3,"file":"widget.zod.d.ts","sourceRoot":"","sources":["../../src/ui/widget.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,sBAAsB;IACjC;;;OAGG;;IAGH;;;;;OAKG;;IAMH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAGH;;;OAGG;;IAGH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC"}

package/json-schema/README.md

@@ -0,0 +1,127 @@
+# JSON Schema Directory
+
+This directory contains auto-generated JSON schemas for all ObjectStack protocols, organized by category.
+
+## Directory Structure
+
+The schemas are organized into the following categories matching the protocol structure:
+
+```
+json-schema/
+├── data/       # Data Protocol - Business Logic & Data Modeling (74 schemas)
+├── ui/         # UI Protocol - Presentation & Interaction (39 schemas)
+├── system/     # System Protocol - Runtime Configuration & Security (112 schemas)
+├── ai/         # AI Protocol - AI/ML Capabilities (86 schemas)
+└── api/        # API Protocol - API Contracts & Envelopes (12 schemas)
+```
+
+## Categories
+
+### 📊 Data Protocol (`data/`)
+Core business logic and data modeling schemas:
+- Object, Field, Validation
+- Query (AST), Mapping (ETL)
+- Permission, Sharing, Flow, Workflow
+
+**Example schemas:** `Field.json`, `Object.json`, `Query.json`, `ValidationRule.json`
+
+### 🎨 UI Protocol (`ui/`)
+Presentation and interaction schemas:
+- App, Page, View (Grid/Kanban/Calendar/Gantt)
+- Dashboard (Widgets), Report
+- Action (Triggers), Theme
+
+**Example schemas:** `App.json`, `View.json`, `Dashboard.json`, `Theme.json`
+
+### ⚙️ System Protocol (`system/`)
+Runtime configuration and security schemas:
+- Manifest (Config), Datasource, Driver
+- Role (Hierarchy), Identity (Auth)
+- Webhook (Integration), Policy (Compliance)
+- Plugin Architecture, Audit, Tenant Management
+
+**Example schemas:** `Manifest.json`, `AuthConfig.json`, `Datasource.json`, `AuditEvent.json`
+
+### 🤖 AI Protocol (`ai/`)
+AI/ML capabilities schemas:
+- Agent Configuration
+- Model Registry & Selection
+- RAG Pipeline, NLQ (Natural Language Query)
+- Workflow Automation, Predictive Analytics
+- Conversation Memory & Token Management
+- Cost Tracking & Budget Management
+
+**Example schemas:** `Agent.json`, `ModelRegistry.json`, `RAGPipelineConfig.json`, `NLQRequest.json`
+
+### 🔌 API Protocol (`api/`)
+API contracts and envelopes:
+- Request/Response schemas
+- Error handling
+- Bulk operations
+
+**Example schemas:** `ApiEndpoint.json`, `BaseResponse.json`, `BulkRequest.json`
+
+## Generation
+
+These schemas are automatically generated from Zod schemas during the build process:
+
+```bash
+npm run gen:schema
+```
+
+The generation script is located at `scripts/build-schemas.ts`.
+
+## Usage
+
+### In TypeScript/JavaScript Projects
+
+You can reference these JSON schemas for validation, documentation, or IDE support:
+
+```typescript
+import fieldSchema from '@objectstack/spec/json-schema/data/Field.json';
+```
+
+### In JSON Schema Tools
+
+Use these schemas with any JSON Schema validator or documentation generator:
+
+```bash
+ajv validate -s json-schema/data/Field.json -d myfield.json
+```
+
+### In IDEs
+
+Many IDEs support JSON schema validation. You can reference these schemas in your configuration files:
+
+```json
+{
+  "$schema": "./node_modules/@objectstack/spec/json-schema/data/Object.json"
+}
+```
+
+## Schema Format
+
+All schemas are generated with:
+- **Format:** JSON Schema Draft 7
+- **Strategy:** Self-contained (no external `$ref`s)
+- **Naming:** PascalCase matching the TypeScript type names
+
+## Conventions
+
+- **Configuration Keys (Properties):** `camelCase` (e.g., `maxLength`, `referenceFilters`)
+- **Machine Names (Data Values):** `snake_case` (e.g., `name: 'first_name'`, `object: 'project_task'`)
+
+## Contributing
+
+Do not manually edit these files. They are auto-generated from the Zod schemas in `src/`.
+
+To update schemas:
+1. Edit the corresponding `.zod.ts` file in `src/{category}/`
+2. Run `npm run gen:schema`
+3. Commit both the Zod source and generated JSON schemas
+
+---
+
+**Total Schemas:** 325 (as of latest build)
+
+For more information, see the main [README](../README.md).

package/json-schema/ai/AITask.json

@@ -0,0 +1,123 @@
+{
+  "$ref": "#/definitions/AITask",
+  "definitions": {
+    "AITask": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Optional task ID for referencing"
+        },
+        "name": {
+          "type": "string",
+          "description": "Human-readable task name"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "classify",
+            "extract",
+            "summarize",
+            "generate",
+            "predict",
+            "translate",
+            "sentiment",
+            "entity_recognition",
+            "anomaly_detection",
+            "recommendation"
+          ]
+        },
+        "model": {
+          "type": "string",
+          "description": "Model ID from registry (uses default if not specified)"
+        },
+        "promptTemplate": {
+          "type": "string",
+          "description": "Prompt template ID for this task"
+        },
+        "inputFields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Source fields to process (e.g., [\"description\", \"comments\"])"
+        },
+        "inputContext": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Additional context for the AI model"
+        },
+        "outputField": {
+          "type": "string",
+          "description": "Target field to store the result"
+        },
+        "outputFormat": {
+          "type": "string",
+          "enum": [
+            "text",
+            "json",
+            "number",
+            "boolean",
+            "array"
+          ],
+          "default": "text"
+        },
+        "classes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Valid classes for classification tasks"
+        },
+        "multiClass": {
+          "type": "boolean",
+          "default": false,
+          "description": "Allow multiple classes to be selected"
+        },
+        "extractionSchema": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "JSON schema for structured extraction"
+        },
+        "maxLength": {
+          "type": "number",
+          "description": "Maximum length for generated content"
+        },
+        "temperature": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 2,
+          "description": "Model temperature override"
+        },
+        "fallbackValue": {
+          "description": "Fallback value if AI task fails"
+        },
+        "retryAttempts": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 5,
+          "default": 1
+        },
+        "condition": {
+          "type": "string",
+          "description": "Formula condition - task only runs if TRUE"
+        },
+        "description": {
+          "type": "string"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true
+        }
+      },
+      "required": [
+        "name",
+        "type",
+        "inputFields",
+        "outputField"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ai/AITaskType.json

@@ -0,0 +1,21 @@
+{
+  "$ref": "#/definitions/AITaskType",
+  "definitions": {
+    "AITaskType": {
+      "type": "string",
+      "enum": [
+        "classify",
+        "extract",
+        "summarize",
+        "generate",
+        "predict",
+        "translate",
+        "sentiment",
+        "entity_recognition",
+        "anomaly_detection",
+        "recommendation"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}