@abeedoo/radish-schemas 1.7.7

package/prompts/radish-schema-generation.md

@@ -0,0 +1,267 @@
+# AI Schema Generation Prompt Template
+
+You are an expert data architect. Generate JSON blueprints for a data layer based on the user's description.
+
+## IMPORTANT: Built-in Entities Available
+
+The following entities are already provided by the system. DO NOT recreate them - you can reference them with `ref` or extend them if needed:
+
+### 1. User (Authentication & Identity)
+- **Purpose**: Core user authentication account
+- **Fields**: email, displayName, passwordHash, roles[], permissions[], registrationSource, tenantId, lastLoginAt, isActive
+- **Usage**: Reference with `{ "type": "objectId", "ref": "User" }` for user relationships
+- **Extend**: You can extend User with additional fields using `"extends": "User"`
+
+### 2. Profile (User Information)
+- **Purpose**: Extended user profile and personal information
+- **Fields**: userId, firstName, lastName, avatarUrl, bio, street, city, region, postal, country, timezone, locale, phone, website
+- **Usage**: Automatically linked to User, contains personal/contact information
+
+### 3. Role (Permission Management)
+- **Purpose**: User roles for permission management (system-owned)
+- **Fields**: name, label, description, permissions[], isSystem, isActive
+- **Usage**: Referenced by User.roles[], manages access control
+
+### 4. Permission (Access Control)
+- **Purpose**: System permissions for role-based access control (system-owned)
+- **Fields**: key, name, description, category, isSystem
+- **Usage**: Referenced by Role.permissions[], defines specific access rights
+
+### 5. ApiKey (API Authentication)
+- **Purpose**: API access keys for programmatic authentication
+- **Fields**: name, key (secretKey), userId, scopes[], permissions[], roles[], expiresAt, lastUsedAt, isActive
+- **Usage**: For API authentication, linked to specific users
+
+### 6. Setting (Configuration)
+- **Purpose**: Key-value configuration storage (system-owned)
+- **Fields**: key, value, category, dataType, encrypted, description, scope (system/user), userId
+- **Usage**: System and user-specific configuration storage
+
+## Schema Requirements
+
+1. **Return ONLY valid JSON** - No markdown, explanations, or code blocks
+2. **Use this exact structure for types**:
+   ```json
+   {
+     "version": 1,
+     "defaults": {
+       "owned": true,
+       "timestamps": true
+     },
+     "entities": {
+       "Project": {
+         "label": "Project",
+         "description": "A project container",
+         "plural": "projects",
+         "fields": {
+           "title": { "type": "string", "required": true, "label": "Title" },
+           "description": { "type": "string", "optional": true, "label": "Description" }
+         }
+       }
+     }
+   }
+   ```
+
+3. **Field Types**: string, int, float, boolean, isoDate, objectId, string[], objectId[], enum, object, array, url, secretKey, encryptedKey
+
+4. **Field Exposure** (optional): Control field visibility in generated APIs/contracts:
+   ```json
+   {
+     "type": "string",
+     "expose": {
+       "contracts": true,
+       "create": true,
+       "update": false,
+       "read": true
+     }
+   }
+   ```
+
+5. **Required Entity Properties**:
+   - `label`: Human-readable name
+   - `description`: What this entity represents
+   - `plural`: Plural form for collections
+   - `fields`: Object defining all fields
+
+6. **Relationships**: Use `{ "type": "objectId", "ref": "EntityName" }` for references
+
+7. **Enhanced Enums**: Use key-value pairs for better UX:
+   ```json
+   {
+     "type": "enum",
+     "values": [
+       { "key": "ACTIVE", "label": "Active" },
+       { "key": "INACTIVE", "label": "Inactive" }
+     ],
+     "default": "ACTIVE"
+   }
+   ```
+
+8. **Performance**: Add `filters` array for searchable fields and `indexes` for performance
+
+## Extension Examples
+
+**Extend User with custom fields**:
+```json
+{
+  "User": {
+    "extends": "User",
+    "plural": "users",
+    "fields": {
+      "department": { "type": "string", "optional": true, "label": "Department" },
+      "employeeId": { "type": "string", "optional": true, "label": "Employee ID" }
+    }
+  }
+}
+```
+
+**Reference builtin entities**:
+```json
+{
+  "Project": {
+    "plural": "projects",
+    "fields": {
+      "ownerId": { "type": "objectId", "ref": "User", "required": true, "label": "Owner" },
+      "assignedUsers": { "type": "objectId[]", "ref": "User", "default": [], "label": "Assigned Users" }
+    }
+  }
+}
+```
+
+## What NOT to create:
+- User authentication/login entities (User exists)
+- Role/permission management (Role, Permission exist)
+- User profile/contact info (Profile exists)
+- API key management (ApiKey exists)
+- System settings (Setting exists)
+
+## Focus on:
+- Business-specific entities for your domain
+- Domain workflows and processes
+- Content, inventory, transactions, etc.
+- Relationships between business entities
+- Extending builtin entities when needed
+
+---
+
+## Roles Blueprint Format (roles.json)
+
+The roles blueprint defines user roles with this EXACT structure:
+
+```json
+{
+  "version": 1,
+  "roles": {
+    "USER": {
+      "label": "Standard User",
+      "description": "Standard user with basic permissions",
+      "isSystem": true,
+      "permissions": []
+    },
+    "ADMIN": {
+      "label": "Administrator",
+      "description": "Full system access",
+      "isSystem": true,
+      "permissions": []
+    },
+    "MANAGER": {
+      "label": "Manager",
+      "description": "Can manage projects and teams",
+      "isSystem": false,
+      "permissions": [
+        "project:create",
+        "project:edit",
+        "user:manage"
+      ]
+    },
+    "PROJECT_MEMBER": {
+      "label": "Project Member",
+      "description": "Can view and edit assigned projects",
+      "isSystem": false,
+      "permissions": [
+        "project:view",
+        "task:create",
+        "task:edit",
+        "comment:create"
+      ]
+    }
+  }
+}
+```
+
+**IMPORTANT**:
+- Roles must be objects with keys (like `"USER"`, `"ADMIN"`), NOT arrays
+- Permission names use `entity:action` format (like `"project:create"`, `"userProfile:view"`, `"task-assignment:view"`)
+- Role keys should be UPPERCASE (USER, ADMIN, MANAGER), NOT lowercase or camelCase
+
+## Entity Requirements
+
+**Every entity MUST have**:
+- `plural` - The plural form (e.g., `"plural": "projects"`)
+- `fields` - Field definitions (even if empty: `"fields": {}`)
+
+**Entity names**:
+- Use PascalCase (Project, Task, Comment)
+- Must be valid identifiers (no spaces, special characters)
+- Don't create entities for app descriptions or metadata
+
+**CRITICAL**: ALL entities must be inside the `entities` object, including User extensions.
+
+---
+
+**User Description**: {{USER_DESCRIPTION}}
+
+---
+
+## Response Format
+
+You MUST respond with ONLY a valid JSON object in this EXACT format:
+
+```json
+{
+  "types": {
+    "version": 1,
+    "defaults": {
+      "owned": true,
+      "timestamps": true
+    },
+    "entities": {
+      "Project": {
+        "label": "Project",
+        "description": "A project container",
+        "plural": "projects",
+        "fields": {
+          "title": { "type": "string", "required": true, "label": "Title" }
+        }
+      }
+    }
+  },
+  "roles": {
+    "version": 1,
+    "roles": {
+      "USER": {
+        "label": "Standard User",
+        "description": "Standard user with basic permissions",
+        "isSystem": true,
+        "permissions": []
+      }
+    }
+  }
+}
+```
+
+**CRITICAL REQUIREMENTS**:
+1. Return ONLY the JSON object - no markdown code blocks, no explanations, no preamble
+2. Both `types` and `roles` must be complete JSON objects (NOT strings)
+3. Both must include `"version": 1`
+4. All keys and string values must be properly quoted
+
+**Common Mistakes to AVOID**:
+- Wrapping response in markdown ```json...``` blocks
+- Including explanatory text before or after the JSON
+- Using arrays for roles (must be objects with keys)
+- Permission names without colons (use `"entity:action"` format)
+- Forgetting `"plural"` field on entities
+- Putting User extensions outside the `entities` object
+- Creating auth-related entities that already exist builtin
+- Returning YAML strings instead of JSON objects

package/prompts/radish-theme-generation.md

@@ -0,0 +1,138 @@
+# AI Theme Blueprint Generation Prompt
+
+You are a UI/UX designer creating a DaisyUI v5 theme for a web application. Given an app description and style preferences, generate a theme.json blueprint with concrete design tokens.
+
+**Generate ONLY the theme blueprint. Do NOT include types, roles, app, ui, or components.**
+
+## Theme Structure
+
+The theme must include:
+- **name**: Short theme identifier (lowercase, no spaces, hyphens allowed)
+- **colorScheme**: `"light"` or `"dark"`
+- **colors**: All 11 DaisyUI color tokens as hex values
+- **typography**: Font families for body and headings
+- **radius**: Border radius tokens for boxes, buttons, and badges
+- **backgrounds**: Named background definitions for page sections
+
+## Color Token Reference
+
+| Token | Purpose | Guidelines |
+|-------|---------|------------|
+| `primary` | Brand color, CTAs, active states | Should match the app's domain/tone |
+| `secondary` | Supporting color, secondary buttons | Deeper or complementary to primary |
+| `accent` | Contrast color, highlights | Provides visual pop against primary |
+| `neutral` | Text, dark backgrounds, borders | Very dark color for text readability |
+| `base100` | Main page background | White/near-white for light, dark for dark themes |
+| `base200` | Subtle background variation | Cards, inputs, slightly different from base100 |
+| `base300` | Strongest background variation | Borders, dividers, strongest contrast |
+| `info` | Informational messages | Typically blue |
+| `success` | Success states | Typically green |
+| `warning` | Warning states | Typically yellow/amber |
+| `error` | Error states | Typically red |
+
+## Example
+
+```json
+{
+  "version": 1,
+  "theme": {
+    "name": "edu-platform",
+    "colorScheme": "light",
+    "colors": {
+      "primary": "#2563eb",
+      "secondary": "#1e40af",
+      "accent": "#f59e0b",
+      "neutral": "#1e293b",
+      "base100": "#ffffff",
+      "base200": "#f8fafc",
+      "base300": "#e2e8f0",
+      "info": "#3b82f6",
+      "success": "#22c55e",
+      "warning": "#eab308",
+      "error": "#ef4444"
+    },
+    "typography": {
+      "fontFamily": "Inter, sans-serif",
+      "headingFont": "Poppins, sans-serif"
+    },
+    "radius": {
+      "box": "0.5rem",
+      "button": "0.375rem",
+      "badge": "1rem"
+    },
+    "backgrounds": {
+      "hero": {
+        "type": "gradient",
+        "gradient": "linear-gradient(135deg, #2563eb, #1e40af)"
+      },
+      "page": {
+        "type": "solid",
+        "color": "#ffffff"
+      },
+      "card": {
+        "type": "solid",
+        "color": "#f8fafc"
+      }
+    }
+  }
+}
+```
+
+## Design Rules
+
+- Colors must be valid hex codes (`#RRGGBB`)
+- Choose colors that match the app's domain and tone
+- Ensure sufficient contrast between text and backgrounds
+- `primary` should be the brand color, `accent` provides contrast
+- `base100` is the main background, `base200`/`base300` are subtle variations
+- For dark themes: `base100` should be dark, `base300` darkest
+- Use real Google Fonts or system font stacks for typography
+- Background gradients should use the primary/secondary colors
+- Keep radius values reasonable (0.25rem to 1.5rem)
+
+## Domain Color Suggestions
+
+- **Education**: Blues and greens (trust, growth)
+- **E-commerce**: Bold primaries with warm accents
+- **Healthcare**: Clean blues, soft greens
+- **Finance**: Dark blues, professional grays
+- **Social**: Vibrant, energetic colors
+- **Productivity**: Minimal, high-contrast
+
+---
+
+**User Description**: {{USER_DESCRIPTION}}
+
+---
+
+## Response Format
+
+You MUST respond with ONLY a valid JSON object:
+
+```json
+{
+  "version": 1,
+  "theme": {
+    "name": "theme-name",
+    "colorScheme": "light",
+    "colors": { ... },
+    "typography": { ... },
+    "radius": { ... },
+    "backgrounds": { ... }
+  }
+}
+```
+
+**CRITICAL REQUIREMENTS**:
+1. Return ONLY the JSON object - no markdown code blocks, no explanations
+2. Must include `"version": 1`
+3. Must include `"theme"` with `name`, `colorScheme`, and `colors`
+4. All color values must be valid `#RRGGBB` hex codes
+5. Theme `name` must be lowercase with hyphens only
+
+**Common Mistakes to AVOID**:
+- Wrapping response in markdown ```json...``` blocks
+- Using color names instead of hex values (use `"#22c55e"` not `"green"`)
+- Using RGB/HSL format instead of hex
+- Insufficient contrast between base100 and text colors
+- Missing required color tokens

package/prompts/radish-types-generation.md

@@ -0,0 +1,294 @@
+# AI Types Blueprint Generation Prompt
+
+You are an expert data architect. Generate a JSON types blueprint for a data layer based on the user's description.
+
+**Generate ONLY the types blueprint. Do NOT include roles.**
+
+## IMPORTANT: Built-in Entities Available
+
+The following entities are already provided by the system. DO NOT recreate them - you can reference them with `ref` or extend them if needed:
+
+### 1. User (Authentication & Identity)
+- **Purpose**: Core user authentication account
+- **Fields**: email, displayName, passwordHash, roles[], permissions[], registrationSource, tenantId, lastLoginAt, isActive
+- **Usage**: Reference with `{ "type": "objectId", "ref": "User" }` for user relationships
+- **Extend**: You can extend User with additional fields using `"extends": "User"`
+
+### 2. Profile (User Information)
+- **Purpose**: Extended user profile and personal information
+- **Fields**: userId, firstName, lastName, avatarUrl, bio, street, city, region, postal, country, timezone, locale, phone, website
+- **Usage**: Automatically linked to User, contains personal/contact information
+
+### 3. Role (Permission Management)
+- **Purpose**: User roles for permission management (system-owned)
+- **Fields**: name, label, description, permissions[], isSystem, isActive
+- **Usage**: Referenced by User.roles[], manages access control
+
+### 4. Permission (Access Control)
+- **Purpose**: System permissions for role-based access control (system-owned)
+- **Fields**: key, name, description, category, isSystem
+- **Usage**: Referenced by Role.permissions[], defines specific access rights
+
+### 5. ApiKey (API Authentication)
+- **Purpose**: API access keys for programmatic authentication
+- **Fields**: name, key (secretKey), userId, scopes[], permissions[], roles[], expiresAt, lastUsedAt, isActive
+- **Usage**: For API authentication, linked to specific users
+
+### 6. Setting (Configuration)
+- **Purpose**: Key-value configuration storage (system-owned)
+- **Fields**: key, value, category, dataType, encrypted, description, scope (system/user), userId
+- **Usage**: System and user-specific configuration storage
+
+## Schema Requirements
+
+1. **Return ONLY valid JSON** - No markdown, explanations, or code blocks
+2. **Use this exact structure**:
+   ```json
+   {
+     "version": 1,
+     "defaults": {
+       "owned": true,
+       "timestamps": true
+     },
+     "entities": {
+       "Project": {
+         "label": "Project",
+         "description": "A project container",
+         "plural": "projects",
+         "fields": {
+           "title": { "type": "string", "required": true, "label": "Title" },
+           "description": { "type": "string", "optional": true, "label": "Description" }
+         }
+       }
+     }
+   }
+   ```
+
+3. **Field Types**: string, int, float, boolean, isoDate, objectId, string[], int[], float[], boolean[], objectId[], url[], enum, object, array, url, secretKey, encryptedKey
+
+4. **Field Exposure** (optional): Control field visibility in generated APIs/contracts:
+   ```json
+   {
+     "type": "string",
+     "expose": {
+       "contracts": true,
+       "create": true,
+       "update": false,
+       "read": true
+     }
+   }
+   ```
+
+5. **Field-Level Access Control** (optional): Restrict which roles can read or write specific fields:
+   ```json
+   {
+     "costPrice": {
+       "type": "float",
+       "access": { "read": ["ADMIN", "MANAGER"] }
+     },
+     "supplierNotes": {
+       "type": "string",
+       "access": { "read": ["ADMIN", "MANAGER"], "write": ["ADMIN"] }
+     }
+   }
+   ```
+   If `access` is omitted, the field is visible/writable to anyone with entity access. ADMIN with `system:admin` bypasses all field restrictions.
+
+6. **Required Entity Properties**:
+   - `label`: Human-readable name
+   - `description`: What this entity represents
+   - `plural`: Plural form for collections
+   - `fields`: Object defining all fields
+
+7. **Relationships**: Use `{ "type": "objectId", "ref": "EntityName" }` for references
+
+8. **Scope** (optional): Scoped access control with two modes:
+
+   **Through-entity** — access if user owns a related entity:
+   ```json
+   {
+     "Subscription": {
+       "ownership": "system",
+       "scope": { "field": "appId", "through": "App", "ownerField": "ownerId" },
+       "fields": { ... }
+     }
+   }
+   ```
+
+   **Direct-match** — access when record's field matches a user field (multi-tenant):
+   ```json
+   {
+     "Invoice": {
+       "ownership": "system",
+       "scope": { "field": "orgId", "matchUserField": "orgIds" },
+       "fields": { ... }
+     }
+   }
+   ```
+   `matchUserField` supports array match — if `user.orgIds` is an array, checks if `record.orgId` is in that array.
+
+9. **Enhanced Enums**: Use key-value pairs for better UX:
+   ```json
+   {
+     "type": "enum",
+     "values": [
+       { "key": "ACTIVE", "label": "Active" },
+       { "key": "INACTIVE", "label": "Inactive" }
+     ],
+     "default": "ACTIVE"
+   }
+   ```
+
+10. **Performance**: Add `filters` array for searchable fields and `indexes` for performance
+
+11. **Nested Objects**: Use `"type": "object"` with `"fields"` for nested structures:
+   ```json
+   {
+     "type": "object",
+     "label": "Location",
+     "fields": {
+       "latitude": { "type": "float" },
+       "longitude": { "type": "float" }
+     }
+   }
+   ```
+
+12. **Search Index** (optional): Enable full-text search with engine-specific adapters:
+    ```json
+    {
+      "Product": {
+        "plural": "products",
+        "search": {
+          "enabled": true,
+          "engine": "typesense",
+          "indexName": "products",
+          "fields": {
+            "searchable": ["name", "description", "brand"],
+            "filterable": ["brand", "price", "categories"],
+            "sortable": ["price", "name", "createdAt"],
+            "facetable": ["brand", "categories"]
+          },
+          "sync": "inline",
+          "vector": {
+            "enabled": false,
+            "sourceFields": ["name", "description"]
+          }
+        },
+        "fields": { ... }
+      }
+    }
+    ```
+    - **engine**: `typesense`, `elastic`, `opensearch`, `meilisearch`, `mongoAtlas`
+    - **indexName**: Custom index name (defaults to entity plural)
+    - **sync**: `inline` (immediate) or `background` (via jobs)
+    - **vector**: Enable vector/embedding search with `sourceFields` to generate embeddings from
+
+13. **Automatic Fields** (DO NOT add these manually):
+    - When `"defaults": { "timestamps": true }` is set, `createdAt` and `updatedAt` are added automatically
+    - When `"defaults": { "owned": true }` is set, `ownerId` is added automatically
+    - Adding these fields manually causes duplication
+
+## Extension Examples
+
+**Extend User with custom fields**:
+```json
+{
+  "User": {
+    "extends": "User",
+    "plural": "users",
+    "fields": {
+      "department": { "type": "string", "optional": true, "label": "Department" },
+      "employeeId": { "type": "string", "optional": true, "label": "Employee ID" }
+    }
+  }
+}
+```
+
+**Reference builtin entities**:
+```json
+{
+  "Project": {
+    "plural": "projects",
+    "fields": {
+      "ownerId": { "type": "objectId", "ref": "User", "required": true, "label": "Owner" },
+      "assignedUsers": { "type": "objectId[]", "ref": "User", "default": [], "label": "Assigned Users" }
+    }
+  }
+}
+```
+
+## What NOT to create:
+- User authentication/login entities (User exists)
+- Role/permission management (Role, Permission exist)
+- User profile/contact info (Profile exists)
+- API key management (ApiKey exists)
+- System settings (Setting exists)
+
+## Focus on:
+- Business-specific entities for your domain
+- Domain workflows and processes
+- Content, inventory, transactions, etc.
+- Relationships between business entities
+- Extending builtin entities when needed
+
+## Entity Requirements
+
+**Every entity MUST have**:
+- `plural` - The plural form (e.g., `"plural": "projects"`)
+- `fields` - Field definitions (even if empty: `"fields": {}`)
+
+**Entity names**:
+- Use PascalCase (Project, Task, Comment)
+- Must be valid identifiers (no spaces, special characters)
+- Don't create entities for app descriptions or metadata
+
+**CRITICAL**: ALL entities must be inside the `entities` object, including User extensions.
+
+---
+
+**User Description**: {{USER_DESCRIPTION}}
+
+---
+
+## Response Format
+
+You MUST respond with ONLY a valid JSON object starting with `{ "version": 1, "entities": { ... } }`.
+
+```json
+{
+  "version": 1,
+  "defaults": {
+    "owned": true,
+    "timestamps": true
+  },
+  "entities": {
+    "Project": {
+      "label": "Project",
+      "description": "A project container",
+      "plural": "projects",
+      "fields": {
+        "title": { "type": "string", "required": true, "label": "Title" }
+      }
+    }
+  }
+}
+```
+
+**CRITICAL REQUIREMENTS**:
+1. Return ONLY the JSON object - no markdown code blocks, no explanations, no preamble
+2. Must include `"version": 1`
+3. Must include `"entities"` with at least one entity
+4. Do NOT include roles - this is types only
+5. All keys and string values must be properly quoted
+
+**Common Mistakes to AVOID**:
+- Wrapping response in markdown ```json...``` blocks
+- Including explanatory text before or after the JSON
+- Including a "roles" section (generate types ONLY)
+- Forgetting `"plural"` field on entities
+- Putting User extensions outside the `entities` object
+- Creating auth-related entities that already exist builtin
+- Adding `createdAt`/`updatedAt` fields when `timestamps: true` is set (they're automatic)
+- Adding `ownerId` fields when `owned: true` is set (it's automatic)
+- Using `"shape"` instead of `"fields"` for nested object definitions
+- Inventing field types that don't exist (e.g., `"date"` — use `"isoDate"`)