Add index and unique support to field and object configs

Introduces 'index' and 'unique' properties to FieldConfig and documents their usage. Adds IndexConfig and 'indexes' to ObjectConfig for composite and unique indexes. Updates documentation to clarify field-level and object-level index definitions and constraints.

Author: hotlong

.github/copilot-instructions.md

@@ -15,7 +15,6 @@ We use **Turborepo** + **PNPM Workspaces**.
 | Path | Package Name | Environment | Role | Description |
 | --- | --- | --- | --- | --- |
 | `packages/types` | `@objectql/types` | **Universal** | **The Contract** | Pure TS Interfaces, Enums, and Error Classes. **No deps.** |
-| `packages/parser` | `@objectql/parser` | **Universal** | **The Compiler** | YAML string -> JSON AST. Pure logic. |
 | `packages/core` | `@objectql/core` | **Universal** | **The Engine** | Main entry point (`ObjectQL` class). Connects Drivers & Registry. |
 | `packages/driver-pg` | `@objectql/driver-pg` | **Node.js** | **The Adapter** | Postgres implementation. Depends on `knex` or `pg`. |
 | `packages/driver-mongo` | `@objectql/driver-mongo` | **Node.js** | **The Adapter** | MongoDB implementation. |
@@ -60,12 +59,6 @@ You must strictly enforce the following dependency rules:
 
 * **Role:** It orchestrates the flow. It validates the request using `SimpleRegistry` and delegates execution to the injected `driver`.
 
-### 📦 `packages/parser`
-
-* **Content:** `function parse(yaml: string): ObjectConfig`
-* **Role:** Pure transformation. Uses `js-yaml`. Validation via `zod` (optional).
-* **Output:** Must strictly match `ObjectConfig` from `types`.
-
 ### 📦 `packages/driver-*`
 
 * **Content:** Implementation of `ObjectQLDriver`.

docs/spec/object.md

@@ -32,8 +32,9 @@ fields:
 | `type` | `string` | **Required.** Data type of the field. |
 | `label` | `string` | Display label for UI validation messages. |
 | `required` | `boolean` | If `true`, the field cannot be null/undefined. Default: `false`. |
+| `unique` | `boolean` | If `true`, enforces unique values in the database. Default: `false`. |
 | `defaultValue` | `any` | Default value if not provided during creation. |
-| `index` | `boolean` | Hint to create a database index. |
+| `index` | `boolean` | Creates a database index for this field. |
 | `searchable` | `boolean` | Hint to include this field in global search. |
 | `sortable` | `boolean` | Hint that this field can be used for sorting in UI. |
 | `description` | `string` | Help text or documentation for the field. |
@@ -102,3 +103,43 @@ status:
     - label: In Progress
       value: in_progress
 ```
+
+## 3. Indexes
+
+Indexes can be defined at the field level (for single-field indexes) or at the object level (for composite indexes).
+
+### 3.1 Field-Level Indexes
+
+You can define simple indexes directly on the field:
+
+```yaml
+fields:
+  email:
+    type: email
+    index: true   # Creates a standard index
+    unique: true  # Creates a unique index (constraint)
+```
+
+### 3.2 Object-Level Indexes
+
+For composite indexes (spanning multiple fields), define them under the `indexes` key at the root of the file.
+
+```yaml
+indexes:
+  # Index Name: Index Definition
+  
+  # Composite Index
+  project_status_idx:
+    fields: [project_id, status]
+  
+  # Unique Composite Index
+  unique_task_name:
+    fields: [project_id, name]
+    unique: true
+```
+
+| Property | Type | Description |
+| :--- | :--- | :--- |
+| `fields` | `string[]` | **Required.** List of field names to include in the index. |
+| `unique` | `boolean` | If `true`, requires values to be unique combination. Default: `false`. |
+

packages/types/src/field.ts

@@ -69,6 +69,9 @@ export interface FieldConfig {
     /** Whether the field is unique in the table. */
     unique?: boolean;
 
+    /** Whether to create a database index for this field. */
+    index?: boolean;
+
     /** Whether the field is read-only in UI. */
     readonly?: boolean;
 

packages/types/src/object.ts

@@ -1,6 +1,13 @@
 import { FieldConfig } from './field';
 import { ActionConfig } from './action';
 
+export interface IndexConfig {
+    /** List of fields involved in the index */
+    fields: string[];
+    /** Whether the index enforces uniqueness */
+    unique?: boolean;
+}
+
 export interface ObjectConfig {
     name: string;
     datasource?: string; // The name of the datasource to use
@@ -9,5 +16,6 @@ export interface ObjectConfig {
     description?: string;
 
     fields: Record<string, FieldConfig>;
+    indexes?: Record<string, IndexConfig>;
     actions?: Record<string, ActionConfig>;
 }