@objectstack/spec 0.3.3 → 0.4.2

package/json-schema/ui/View.json

@@ -8,7 +8,10 @@
           "type": "object",
           "properties": {
             "name": {
-              "type": "string"
+              "type": "string",
+              "minLength": 2,
+              "pattern": "^[a-z][a-z0-9_]*$",
+              "description": "Internal view name (lowercase snake_case)"
             },
             "label": {
               "type": "string"
@@ -17,8 +20,11 @@
               "type": "string",
               "enum": [
                 "grid",
+                "spreadsheet",
                 "kanban",
+                "gallery",
                 "calendar",
+                "timeline",
                 "gantt",
                 "map"
               ],
@@ -404,7 +410,10 @@
               "enum": [
                 "simple",
                 "tabbed",
-                "wizard"
+                "wizard",
+                "split",
+                "drawer",
+                "modal"
               ],
               "default": "simple"
             },
@@ -750,7 +759,10 @@
             "type": "object",
             "properties": {
               "name": {
-                "type": "string"
+                "type": "string",
+                "minLength": 2,
+                "pattern": "^[a-z][a-z0-9_]*$",
+                "description": "Internal view name (lowercase snake_case)"
               },
               "label": {
                 "type": "string"
@@ -759,8 +771,11 @@
                 "type": "string",
                 "enum": [
                   "grid",
+                  "spreadsheet",
                   "kanban",
+                  "gallery",
                   "calendar",
+                  "timeline",
                   "gantt",
                   "map"
                 ],
@@ -1150,7 +1165,10 @@
                 "enum": [
                   "simple",
                   "tabbed",
-                  "wizard"
+                  "wizard",
+                  "split",
+                  "drawer",
+                  "modal"
                 ],
                 "default": "simple"
               },

package/json-schema/ui/WidgetEvent.json

@@ -0,0 +1,42 @@
+{
+  "$ref": "#/definitions/WidgetEvent",
+  "definitions": {
+    "WidgetEvent": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Event name"
+        },
+        "label": {
+          "type": "string",
+          "description": "Human-readable event label"
+        },
+        "description": {
+          "type": "string",
+          "description": "Event description and usage"
+        },
+        "bubbles": {
+          "type": "boolean",
+          "default": false,
+          "description": "Whether event bubbles"
+        },
+        "cancelable": {
+          "type": "boolean",
+          "default": false,
+          "description": "Whether event is cancelable"
+        },
+        "payload": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Event payload schema"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ui/WidgetLifecycle.json

@@ -0,0 +1,40 @@
+{
+  "$ref": "#/definitions/WidgetLifecycle",
+  "definitions": {
+    "WidgetLifecycle": {
+      "type": "object",
+      "properties": {
+        "onMount": {
+          "type": "string",
+          "description": "Initialization code when widget mounts"
+        },
+        "onUpdate": {
+          "type": "string",
+          "description": "Code to run when props change"
+        },
+        "onUnmount": {
+          "type": "string",
+          "description": "Cleanup code when widget unmounts"
+        },
+        "onValidate": {
+          "type": "string",
+          "description": "Custom validation logic"
+        },
+        "onFocus": {
+          "type": "string",
+          "description": "Code to run on focus"
+        },
+        "onBlur": {
+          "type": "string",
+          "description": "Code to run on blur"
+        },
+        "onError": {
+          "type": "string",
+          "description": "Error handling code"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ui/WidgetManifest.json

@@ -0,0 +1,262 @@
+{
+  "$ref": "#/definitions/WidgetManifest",
+  "definitions": {
+    "WidgetManifest": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Widget identifier (snake_case)"
+        },
+        "label": {
+          "type": "string",
+          "description": "Widget display name"
+        },
+        "description": {
+          "type": "string",
+          "description": "Widget description"
+        },
+        "version": {
+          "type": "string",
+          "description": "Widget version (semver)"
+        },
+        "author": {
+          "type": "string",
+          "description": "Widget author"
+        },
+        "icon": {
+          "type": "string",
+          "description": "Widget icon"
+        },
+        "fieldTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Supported field types"
+        },
+        "category": {
+          "type": "string",
+          "enum": [
+            "input",
+            "display",
+            "picker",
+            "editor",
+            "custom"
+          ],
+          "default": "custom",
+          "description": "Widget category"
+        },
+        "lifecycle": {
+          "type": "object",
+          "properties": {
+            "onMount": {
+              "type": "string",
+              "description": "Initialization code when widget mounts"
+            },
+            "onUpdate": {
+              "type": "string",
+              "description": "Code to run when props change"
+            },
+            "onUnmount": {
+              "type": "string",
+              "description": "Cleanup code when widget unmounts"
+            },
+            "onValidate": {
+              "type": "string",
+              "description": "Custom validation logic"
+            },
+            "onFocus": {
+              "type": "string",
+              "description": "Code to run on focus"
+            },
+            "onBlur": {
+              "type": "string",
+              "description": "Code to run on blur"
+            },
+            "onError": {
+              "type": "string",
+              "description": "Error handling code"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Lifecycle hooks"
+        },
+        "events": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Event name"
+              },
+              "label": {
+                "type": "string",
+                "description": "Human-readable event label"
+              },
+              "description": {
+                "type": "string",
+                "description": "Event description and usage"
+              },
+              "bubbles": {
+                "type": "boolean",
+                "default": false,
+                "description": "Whether event bubbles"
+              },
+              "cancelable": {
+                "type": "boolean",
+                "default": false,
+                "description": "Whether event is cancelable"
+              },
+              "payload": {
+                "type": "object",
+                "additionalProperties": {},
+                "description": "Event payload schema"
+              }
+            },
+            "required": [
+              "name"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Custom events"
+        },
+        "properties": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Property name (camelCase)"
+              },
+              "label": {
+                "type": "string",
+                "description": "Human-readable label"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "string",
+                  "number",
+                  "boolean",
+                  "array",
+                  "object",
+                  "function",
+                  "any"
+                ],
+                "description": "TypeScript type"
+              },
+              "required": {
+                "type": "boolean",
+                "default": false,
+                "description": "Whether property is required"
+              },
+              "default": {
+                "description": "Default value"
+              },
+              "description": {
+                "type": "string",
+                "description": "Property description"
+              },
+              "validation": {
+                "type": "object",
+                "additionalProperties": {},
+                "description": "Validation rules"
+              },
+              "category": {
+                "type": "string",
+                "description": "Property category"
+              }
+            },
+            "required": [
+              "name",
+              "type"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Configuration properties"
+        },
+        "implementation": {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "url",
+                "inline",
+                "module"
+              ],
+              "description": "Implementation type"
+            },
+            "source": {
+              "type": "string",
+              "description": "Source URL, inline code, or module path"
+            }
+          },
+          "required": [
+            "type",
+            "source"
+          ],
+          "additionalProperties": false,
+          "description": "Widget implementation"
+        },
+        "dependencies": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "version": {
+                "type": "string"
+              },
+              "url": {
+                "type": "string",
+                "format": "uri"
+              }
+            },
+            "required": [
+              "name"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Widget dependencies"
+        },
+        "screenshots": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "format": "uri"
+          },
+          "description": "Screenshot URLs"
+        },
+        "documentation": {
+          "type": "string",
+          "format": "uri",
+          "description": "Documentation URL"
+        },
+        "license": {
+          "type": "string",
+          "description": "License (SPDX identifier)"
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Tags for categorization"
+        }
+      },
+      "required": [
+        "name",
+        "label"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ui/WidgetProperty.json

@@ -0,0 +1,58 @@
+{
+  "$ref": "#/definitions/WidgetProperty",
+  "definitions": {
+    "WidgetProperty": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Property name (camelCase)"
+        },
+        "label": {
+          "type": "string",
+          "description": "Human-readable label"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "string",
+            "number",
+            "boolean",
+            "array",
+            "object",
+            "function",
+            "any"
+          ],
+          "description": "TypeScript type"
+        },
+        "required": {
+          "type": "boolean",
+          "default": false,
+          "description": "Whether property is required"
+        },
+        "default": {
+          "description": "Default value"
+        },
+        "description": {
+          "type": "string",
+          "description": "Property description"
+        },
+        "validation": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Validation rules"
+        },
+        "category": {
+          "type": "string",
+          "description": "Property category"
+        }
+      },
+      "required": [
+        "name",
+        "type"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@objectstack/spec",
-  "version": "0.3.3",
+  "version": "0.4.2",
   "description": "ObjectStack Protocol & Specification - TypeScript Interfaces, JSON Schemas, and Convention Configurations",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/prompts/architecture.md

@@ -6,7 +6,7 @@ Mission: Build the "Post-SaaS Operating System" — an open-core, local-first ec
 1. The "Galaxy" Architecture (Monorepo Structure)
 We use a Monorepo (pnpm + Turborepo) to manage the ecosystem, but components are designed to be published independently.
 Directory Structure & Responsibilities
- * packages/protocol (The Constitution) [Apache 2.0]
+ * packages/spec (The Constitution) [Apache 2.0]
    * CRITICAL: Contains the shared manifest.schema.json, TypeScript interfaces, and plugin lifecycle hooks (onInstall, onEnable).
    * Rule: All other packages depend on this. No circular dependencies.
  * packages/objectql (Data Engine) [Apache 2.0]
@@ -20,7 +20,7 @@ Directory Structure & Responsibilities
    * Tools for third-party developers to build Marketplace plugins.
  * drivers/* [Apache 2.0]
    * driver-postgres, driver-redis, driver-excel.
-   * Must implement interfaces defined in packages/protocol.
+   * Must implement interfaces defined in packages/spec.
 Commercial & Apps
  * apps/www (Official Website): Marketing, Landing Pages, "Platform" Showcase.
  * apps/marketplace (Public Storefront): SEO-optimized Registry for plugins/drivers.
@@ -50,7 +50,7 @@ Top Navbar Layout:
 
 We do not rely solely on package.json. We use a strict ObjectStack Manifest standard.
 File: objectstack.config.ts (or strict JSON inside package.json)
-Schema Location: packages/protocol/schemas/manifest.schema.json
+Schema Location: spec/protocol/schemas/manifest.schema.json
 Key Fields:
  * type: app | plugin | driver
  * navigation: Structured navigation menu tree.
@@ -68,7 +68,7 @@ B. Terminology
  * ALWAYS emphasize "Polyglot Data". We are not just a SQL wrapper; we handle Redis and Excel native files.
  * Studio vs. Cloud: Studio is for "Local Data & Development". Cloud is for "Deployment & Collaboration".
 C. Coding Style
- * Monorepo: Use generic imports (e.g., import { User } from '@objectstack/protocol') instead of relative paths like ../../packages/protocol.
+ * Monorepo: Use generic imports (e.g., import { User } from '@objectstack/protocol') instead of relative paths like ../../packages/spec.
  * UI: Use Shadcn UI + Tailwind CSS. Dark mode default for developer tools (Studio/Console).
  * Data Fetching: All UI components must be Server-Driven or strongly typed against the Schema.
 5. Execution Context
@@ -78,4 +78,4 @@ When I ask you to build a feature, first determine:
  * Does it require updating the Protocol Manifest?
 Example:
 User: "Add a CRM plugin."
-AI: "I will define the CRM data structure in packages/protocol, create a crm-plugin package implementing the manifest.json standard, and register the 'Customer' menu item."
+AI: "I will define the CRM data structure in packages/spec, create a crm-plugin package implementing the manifest.json standard, and register the 'Customer' menu item."

package/prompts/create-new-project.md

@@ -0,0 +1,85 @@
+# Role
+You are an expert **ObjectStack Application Developer**.
+Your mission is to build metadata-driven business applications using the `@objectstack/spec` protocol.
+
+# Context
+We are building a new application based on the ObjectStack Standard Protocol.
+The core philosophy is **"Data as Code"** — all business logic (Objects, Fields, UI, Permissions) is defined as strictly typed TypeScript objects using Zod schemas.
+
+# Tech Stack & Imports
+- **Protocol Package:** `@objectstack/spec`
+- **Data Definition:** `import { Object, Field, Hook, Validation } from '@objectstack/spec/data'`
+- **UI Definition:** `import { App, View, Dashboard, Layout } from '@objectstack/spec/ui'`
+- **Configuration:** `objectstack.config.ts` (Application Entry)
+
+# Project Structure (Best Practice)
+Organize the code by **Domains** (Functional Modules) rather than technical layers.
+
+```text
+my-app/
+├── objectstack.config.ts       # App Entry (App.create({...}))
+├── package.json
+├── tsconfig.json
+└── src/
+    ├── domains/
+    │   ├── sales/              # Domain: Sales
+    │   │   ├── account.object.ts
+    │   │   ├── account.trigger.ts
+    │   │   └── opportunity.object.ts
+    │   └── support/            # Domain: Support
+    │       └── case.object.ts
+    └── ui/                     # Global UI Assets
+        ├── dashboards/
+        └── layouts/
+```
+
+# Implementation Rules
+
+1.  **Strict Typing:** Always explicit types.
+    *   BAD: `const MyObject = { ... }`
+    *   GOOD: `export const MyObject: Object = { ... }`
+
+2.  **Naming Conventions:**
+    *   **File Names:** `snake_case` or `domain.feature.ts` (e.g., `account.object.ts`).
+    *   **Machine Names (Inside Code):** `snake_case` (e.g., `name: 'customer_grade'`).
+    *   **Config Properties:** `camelCase` (e.g., `label: 'Customer Grade'`).
+
+3.  **Code Pattern (Object Definition):**
+    ```typescript
+    import { Object } from '@objectstack/spec/data';
+
+    export const AccountObject: Object = {
+      name: 'account',
+      label: 'Corporate Account',
+      enable: {
+        audit: true,
+        workflow: true
+      },
+      fields: {
+        name: { type: 'text', label: 'Account Name', required: true },
+        type: { 
+          type: 'select', 
+          options: [{ label: 'Customer', value: 'customer' }] 
+        },
+        owner: { type: 'lookup', reference: 'user' }
+      }
+    };
+    ```
+
+4.  **Code Pattern (App Config):**
+    ```typescript
+    // objectstack.config.ts
+    import { App } from '@objectstack/spec/ui';
+    import { AccountObject } from './src/domains/sales/account.object';
+
+    export default App.create({
+      name: 'my_erp_app',
+      version: '1.0.0',
+      objects: [AccountObject],
+      menus: [ ... ]
+    });
+    ```
+
+# Your Task
+Please assist me in implementing the following requirements for my new ObjectStack project.
+Focus on creating the `object.ts` definitions and the `objectstack.config.ts` integration.

package/dist/driver/index.d.ts

@@ -1,5 +0,0 @@
-export * from './driver.zod';
-export * from './datasource.zod';
-export * from './mongo.zod';
-export * from './postgres.zod';
-//# sourceMappingURL=index.d.ts.map

package/dist/driver/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/driver/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"mongo.zod.d.ts","sourceRoot":"","sources":["../../src/driver/mongo.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,iBAAiB;IAC5B;;;;OAIG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAKH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"postgres.zod.d.ts","sourceRoot":"","sources":["../../src/driver/postgres.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;;OAIG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;OAIG;;IAGH;;;OAGG;;;;;;;;;;;;;;;;;IAWH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;;OAGG;;IAGF;;;MAGE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/dist/kernel/index.d.ts

@@ -1,12 +0,0 @@
-/**
- * Kernel Protocol Exports
- *
- * The Core Architecture of ObjectStack.
- * Defines the Bootloader, Package Management, and Plugin Lifecycle.
- */
-export * from './manifest.zod';
-export * from './plugin.zod';
-export * from './logger.zod';
-export * from './context.zod';
-export * from './scoped-storage.zod';
-//# sourceMappingURL=index.d.ts.map

package/dist/kernel/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/kernel/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC"}

package/dist/kernel/index.js

@@ -1,27 +0,0 @@
-"use strict";
-/**
- * Kernel Protocol Exports
- *
- * The Core Architecture of ObjectStack.
- * Defines the Bootloader, Package Management, and Plugin Lifecycle.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./manifest.zod"), exports);
-__exportStar(require("./plugin.zod"), exports);
-__exportStar(require("./logger.zod"), exports);
-__exportStar(require("./context.zod"), exports);
-__exportStar(require("./scoped-storage.zod"), exports);