@objectql/cli 1.8.4 → 1.9.0

package/templates/starter/src/modules/tasks/tasks.object.yml

@@ -0,0 +1,34 @@
+label: Task
+icon: checkbox-circle-line
+fields:
+  name:
+    type: text
+    required: true
+    index: true # Simple index
+    
+  project:
+    reference_to: projects
+    
+  due_date:
+    type: date
+    
+  completed:
+    type: boolean
+    defaultValue: false
+    index: true # Helpful for finding pending tasks
+    
+  priority:
+    options:
+      - low
+      - medium
+      - high
+    defaultValue: medium
+    
+  assigned_to:
+    type: text
+    label: Assignee
+    
+  estimated_hours:
+    type: number
+    label: Estimated Hours
+

package/templates/starter/src/modules/tasks/tasks.permission.yml

@@ -0,0 +1,167 @@
+name: tasks_permission
+object: tasks
+description: "Advanced permission rules for Task object demonstrating complex scenarios"
+
+# Roles (defined in demo.app.yml, referenced here)
+# This list documents which system roles have permissions on this object
+roles:
+  - admin
+  - project_manager
+  - team_lead
+  - developer
+  - viewer
+
+# Object-level permissions (CRUD)
+object_permissions:
+  create: [admin, project_manager, team_lead, developer]
+  read: [admin, project_manager, team_lead, developer, viewer]
+  update: [admin, project_manager, team_lead, developer]
+  delete: [admin, project_manager, team_lead]
+  view_all: [admin, project_manager]
+  modify_all: [admin]
+
+# Field-level security
+field_permissions:
+  estimated_hours:
+    read: [admin, project_manager, team_lead]
+    update: [admin, project_manager, team_lead]
+  
+  priority:
+    read: [admin, project_manager, team_lead, developer, viewer]
+    update: [admin, project_manager, team_lead]
+  
+  assigned_to:
+    read: [admin, project_manager, team_lead, developer, viewer]
+    update: [admin, project_manager, team_lead]
+
+# Record-level rules with complex conditions
+record_rules:
+  - name: assignee_full_access
+    priority: 100
+    description: Assignee has full access to assigned tasks
+    condition:
+      type: simple
+      field: assigned_to
+      operator: "="
+      value: $current_user.id
+    permissions:
+      read: true
+      update: true
+      delete: false
+  
+  - name: team_lead_access
+    priority: 90
+    description: Team leads can access all tasks in their team's projects
+    condition:
+      type: lookup
+      object: projects
+      via: project
+      condition:
+        type: simple
+        field: owner
+        operator: "="
+        value: $current_user.id
+    permissions:
+      read: true
+      update: true
+      delete: true
+  
+  - name: completed_tasks_readonly
+    priority: 50
+    description: Completed tasks are read-only for non-admins
+    condition:
+      type: simple
+      field: completed
+      operator: "="
+      value: true
+    permissions:
+      read: true
+      update: false
+      delete: false
+  
+  - name: high_priority_manager_only
+    priority: 80
+    description: Only managers can edit high priority tasks
+    condition:
+      type: simple
+      field: priority
+      operator: "="
+      value: high
+    permissions:
+      read: true
+      update: false
+      delete: false
+
+# Sharing rules
+sharing_rules:
+  - name: manual_collaboration
+    type: manual
+    description: Users can share tasks with collaborators
+    enabled: true
+    permissions:
+      read: true
+      update: true
+      delete: false
+  
+  - name: project_team_sharing
+    type: criteria
+    description: All project team members can see related tasks
+    condition:
+      type: simple
+      field: project
+      operator: "!="
+      value: null
+    shared_with:
+      type: role
+      roles: [developer, team_lead]
+    permissions:
+      read: true
+      update: false
+
+# Row-level security
+row_level_security:
+  enabled: true
+  default_rule:
+    field: assigned_to
+    operator: "="
+    value: $current_user.id
+  exceptions:
+    - role: admin
+      bypass: true
+    - role: project_manager
+      bypass: true
+    - role: team_lead
+      condition:
+        type: lookup
+        object: projects
+        via: project
+        condition:
+          type: simple
+          field: owner
+          operator: "="
+          value: $current_user.id
+
+# Field masking for sensitive data
+field_masking:
+  estimated_hours:
+    mask_format: "XX.X hours"  # Mask numeric values appropriately
+    visible_to: [admin, project_manager, team_lead]
+
+# Audit configuration
+audit:
+  enabled: true
+  events:
+    - permission_grant
+    - permission_revoke
+    - access_denied
+    - sensitive_field_access
+  retention_days: 180
+  alerts:
+    - event: access_denied
+      threshold: 10
+      window_minutes: 15
+      notify: [admin, project_manager]
+    - event: sensitive_field_access
+      threshold: 50
+      window_minutes: 60
+      notify: [admin]

package/templates/starter/src/seed.ts

@@ -0,0 +1,55 @@
+import { ObjectQL } from '@objectql/core';
+import { SqlDriver } from '@objectql/driver-sql';
+import { ObjectLoader } from '@objectql/platform-node';
+import * as path from 'path';
+
+async function main() {
+    console.log("🚀 Starting Project Tracker Showcase...");
+
+    const app = new ObjectQL({
+        datasources: {
+            default: new SqlDriver({
+                client: 'sqlite3',
+                connection: { filename: ':memory:' },
+                useNullAsDefault: true
+            })
+        }
+    });
+
+    const loader = new ObjectLoader(app.metadata);
+    await loader.load(path.join(__dirname));
+
+    await app.init();
+    console.log("✅ Schema loaded from filesystem");
+
+    const ctx = app.createContext({ isSystem: true });
+    
+    console.log("Creating Project...");
+    const project = await ctx.object('projects').create({
+        name: 'Website Redesign',
+        status: 'planning',
+        start_date: new Date()
+    });
+    
+    console.log("Creating Task...");
+    const projectId = project._id || project.id; 
+
+    await ctx.object('tasks').create({
+        name: 'Design Mockups',
+        project: projectId,
+        completed: false
+    });
+
+    console.log("Querying Tasks...");
+    const tasks = await ctx.object('tasks').find({
+        filters: [['project', '=', projectId]]
+    });
+
+    console.log("📊 Project Report:", JSON.stringify({ project, tasks }, null, 2));
+}
+
+if (require.main === module) {
+    main().catch(console.error);
+}
+
+export * from './types';

package/templates/starter/src/types/index.ts

@@ -0,0 +1,3 @@
+export * from './kitchen_sink';
+export * from './projects';
+export * from './tasks';

package/templates/starter/src/types/kitchen_sink.ts

@@ -0,0 +1,101 @@
+// Auto-generated by ObjectQL. DO NOT EDIT.
+import { ObjectDoc } from '@objectql/types';
+
+export interface KitchenSink extends ObjectDoc {
+    /**
+     * Simple Text
+     */
+    simple_text: string;
+    /**
+     * Multi-line Text
+     */
+    long_text?: string;
+    /**
+     * Markdown Content
+     */
+    rich_content?: string;
+    /**
+     * HTML Content
+     */
+    raw_html?: string;
+    /**
+     * Integer Count
+     */
+    count?: number;
+    /**
+     * Price
+     */
+    price?: number;
+    /**
+     * Progress
+     */
+    progress?: number;
+    /**
+     * Is Active
+     */
+    is_active?: boolean;
+    /**
+     * Due Date
+     */
+    due_date?: Date | string;
+    /**
+     * Meeting (Date & Time)
+     */
+    meeting_time?: Date | string;
+    /**
+     * Alarm Time
+     */
+    alarm?: Date | string;
+    /**
+     * Status
+     */
+    status?: string;
+    /**
+     * Tags
+     */
+    tags?: string;
+    /**
+     * Email
+     */
+    email_address?: string;
+    /**
+     * Phone
+     */
+    phone_number?: string;
+    /**
+     * Website URL
+     */
+    website?: string;
+    /**
+     * Avatar
+     */
+    profile_pic?: any;
+    /**
+     * Attachment document
+     */
+    attachment?: any;
+    /**
+     * Image Gallery
+     */
+    gallery?: any[];
+    /**
+     * Secret Code
+     */
+    secret_code?: string;
+    /**
+     * GPS Coordinates
+     */
+    coords?: any;
+    /**
+     * JSON Metadata
+     */
+    metadata?: any;
+    /**
+     * Vector Embedding
+     */
+    embedding?: number[];
+    /**
+     * Related Project
+     */
+    related_project?: string | number;
+}

package/templates/starter/src/types/projects.ts

@@ -0,0 +1,49 @@
+// Auto-generated by ObjectQL. DO NOT EDIT.
+import { ObjectDoc } from '@objectql/types';
+
+export interface Projects extends ObjectDoc {
+    /**
+     * Name
+     */
+    name: string;
+    /**
+     * Status
+     */
+    status?: string;
+    /**
+     * Priority
+     */
+    priority?: string;
+    /**
+     * Description
+     */
+    description?: string;
+    /**
+     * Owner
+     */
+    owner?: string;
+    /**
+     * Budget
+     */
+    budget?: number;
+    /**
+     * Start Date
+     */
+    start_date?: Date | string;
+    /**
+     * End Date
+     */
+    end_date?: Date | string;
+    /**
+     * Approved By
+     */
+    approved_by?: string;
+    /**
+     * Approved At
+     */
+    approved_at?: Date | string;
+    /**
+     * Approval Comment
+     */
+    approval_comment?: string;
+}

package/templates/starter/src/types/tasks.ts

@@ -0,0 +1,33 @@
+// Auto-generated by ObjectQL. DO NOT EDIT.
+import { ObjectDoc } from '@objectql/types';
+
+export interface Tasks extends ObjectDoc {
+    /**
+     * Name
+     */
+    name: string;
+    /**
+     * Project
+     */
+    project?: string | number;
+    /**
+     * Due Date
+     */
+    due_date?: Date | string;
+    /**
+     * Completed
+     */
+    completed?: boolean;
+    /**
+     * Priority
+     */
+    priority?: string;
+    /**
+     * Assignee
+     */
+    assigned_to?: string;
+    /**
+     * Estimated Hours
+     */
+    estimated_hours?: number;
+}

package/templates/starter/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["objectql.config.ts"]
+}
+