@objectql/create 1.0.0

package/templates/enterprise/src/core/i18n/en/core.json

@@ -0,0 +1,60 @@
+{
+  "user": {
+    "label": "User",
+    "fields": {
+      "name": "Full Name",
+      "email": "Email Address",
+      "username": "Username",
+      "mobile": "Mobile Phone",
+      "avatar": "Profile Picture",
+      "status": "Status",
+      "role": "Role",
+      "last_login_at": "Last Login Time",
+      "locale": "Preferred Language",
+      "timezone": "Timezone"
+    },
+    "options": {
+      "status": {
+        "active": "Active",
+        "inactive": "Inactive",
+        "suspended": "Suspended"
+      },
+      "role": {
+        "admin": "Administrator",
+        "user": "User",
+        "guest": "Guest"
+      }
+    }
+  },
+  "organization": {
+    "label": "Organization",
+    "fields": {
+      "name": "Organization Name",
+      "code": "Organization Code",
+      "type": "Type",
+      "parent": "Parent Organization",
+      "manager": "Manager",
+      "description": "Description",
+      "logo": "Logo",
+      "address": "Address",
+      "website": "Website",
+      "phone": "Phone Number",
+      "email": "Contact Email",
+      "status": "Status"
+    }
+  },
+  "attachment": {
+    "label": "Attachment",
+    "fields": {
+      "name": "File Name",
+      "file_url": "File URL",
+      "file_size": "File Size",
+      "file_type": "MIME Type",
+      "related_to": "Related Object",
+      "related_id": "Related Record ID",
+      "uploaded_by": "Uploaded By",
+      "description": "Description",
+      "tags": "Tags"
+    }
+  }
+}

package/templates/enterprise/src/core/i18n/zh-CN/core.json

@@ -0,0 +1,60 @@
+{
+  "user": {
+    "label": "用户",
+    "fields": {
+      "name": "全名",
+      "email": "电子邮件地址",
+      "username": "用户名",
+      "mobile": "手机号码",
+      "avatar": "头像",
+      "status": "状态",
+      "role": "角色",
+      "last_login_at": "最后登录时间",
+      "locale": "首选语言",
+      "timezone": "时区"
+    },
+    "options": {
+      "status": {
+        "active": "活跃",
+        "inactive": "未活跃",
+        "suspended": "已暂停"
+      },
+      "role": {
+        "admin": "管理员",
+        "user": "用户",
+        "guest": "访客"
+      }
+    }
+  },
+  "organization": {
+    "label": "组织",
+    "fields": {
+      "name": "组织名称",
+      "code": "组织代码",
+      "type": "类型",
+      "parent": "上级组织",
+      "manager": "管理者",
+      "description": "描述",
+      "logo": "标志",
+      "address": "地址",
+      "website": "网站",
+      "phone": "电话号码",
+      "email": "联系邮箱",
+      "status": "状态"
+    }
+  },
+  "attachment": {
+    "label": "附件",
+    "fields": {
+      "name": "文件名",
+      "file_url": "文件URL",
+      "file_size": "文件大小",
+      "file_type": "MIME类型",
+      "related_to": "关联对象",
+      "related_id": "关联记录ID",
+      "uploaded_by": "上传者",
+      "description": "描述",
+      "tags": "标签"
+    }
+  }
+}

package/templates/enterprise/src/core/index.ts

@@ -0,0 +1,24 @@
+/**
+ * Core Module - Foundation Objects
+ * 
+ * Exports all core/shared objects
+ */
+
+export const CORE_OBJECTS = [
+  'user',
+  'organization',
+  'attachment',
+] as const;
+
+export type CoreObject = typeof CORE_OBJECTS[number];
+
+/**
+ * Module metadata
+ */
+export const CORE_MODULE = {
+  name: 'core',
+  label: 'Core Objects',
+  description: 'Foundation objects used across all modules',
+  version: '1.0.0',
+  objects: CORE_OBJECTS,
+} as const;

package/templates/enterprise/src/core/organization.object.yml

@@ -0,0 +1,78 @@
+name: organization
+label: Organization
+description: Company or organization entity
+icon: building-line
+
+fields:
+  name:
+    type: text
+    required: true
+    label: Organization Name
+    index: true
+  
+  code:
+    type: text
+    label: Organization Code
+    unique: true
+    index: true
+  
+  type:
+    type: select
+    options:
+      - enterprise
+      - department
+      - team
+    defaultValue: enterprise
+    index: true
+  
+  parent:
+    type: lookup
+    reference_to: organization
+    label: Parent Organization
+    index: true
+  
+  manager:
+    type: lookup
+    reference_to: user
+    label: Manager
+  
+  description:
+    type: textarea
+    label: Description
+  
+  logo:
+    type: image
+    label: Organization Logo
+  
+  address:
+    type: textarea
+    label: Address
+  
+  website:
+    type: url
+    label: Website
+  
+  phone:
+    type: text
+    label: Phone Number
+  
+  email:
+    type: text
+    label: Contact Email
+  
+  status:
+    type: select
+    options:
+      - active
+      - inactive
+    defaultValue: active
+    index: true
+
+indexes:
+  # For org tree queries
+  parent_type_idx:
+    fields: [parent, type]
+  
+  # For active org lookup
+  status_name_idx:
+    fields: [status, name]

package/templates/enterprise/src/core/user.object.yml

@@ -0,0 +1,80 @@
+name: user
+label: User
+description: System user with authentication and profile
+icon: user-line
+
+fields:
+  name:
+    type: text
+    required: true
+    label: Full Name
+    index: true
+  
+  email:
+    type: text
+    required: true
+    label: Email Address
+    unique: true
+    index: true
+  
+  username:
+    type: text
+    label: Username
+    unique: true
+    index: true
+  
+  mobile:
+    type: text
+    label: Mobile Phone
+  
+  avatar:
+    type: image
+    label: Profile Picture
+    multiple: false
+    max_size: 1048576  # 1MB
+  
+  status:
+    type: select
+    options:
+      - active
+      - inactive
+      - suspended
+    defaultValue: active
+    index: true
+  
+  role:
+    type: select
+    options:
+      - admin
+      - user
+      - guest
+    defaultValue: user
+    index: true
+  
+  last_login_at:
+    type: datetime
+    label: Last Login Time
+  
+  locale:
+    type: select
+    options:
+      - en
+      - zh-CN
+      - ja
+      - es
+    defaultValue: en
+    label: Preferred Language
+  
+  timezone:
+    type: text
+    defaultValue: UTC
+    label: Timezone
+
+indexes:
+  # For query: active users sorted by name
+  status_name_idx:
+    fields: [status, name]
+  
+  # For authentication lookup
+  email_status_idx:
+    fields: [email, status]

package/templates/enterprise/src/extensions/README.md

@@ -0,0 +1,56 @@
+# Extensions Directory
+
+This directory contains object **extensions** - modifications and additions to objects defined elsewhere (either in the `core/` layer or external plugins).
+
+## How Extensions Work
+
+Extensions use ObjectQL's **Schema Merging** feature. When you define an object with the same `name` as an existing object, ObjectQL merges the definitions together.
+
+## Example: Extending the User Object
+
+The `user.extension.object.yml` file extends the core `user` object with company-specific customizations:
+
+1. **Adding fields** - Links to employee record, office location
+2. **Overriding properties** - Making email required and unique
+3. **Business logic** - Two-factor authentication flag
+
+## When to Use Extensions
+
+✅ **Good Use Cases:**
+- Adding company-specific fields to standard objects
+- Customizing field properties (making fields required, adding validation)
+- Regional variations (GDPR compliance fields for EU)
+- Customer-specific customizations in SaaS products
+
+❌ **Avoid Extensions For:**
+- Core business logic (put in the original object definition)
+- Frequently changing fields (causes merge complexity)
+- Breaking changes (removing required fields)
+
+## File Naming Convention
+
+```
+[object_name].extension.object.yml
+```
+
+Examples:
+- `user.extension.object.yml` - Extends the `user` object
+- `organization.extension.object.yml` - Extends the `organization` object
+
+## Loading Order
+
+ObjectQL loads objects in this order:
+1. External plugins
+2. Core layer (`core/objects/`)
+3. Module layers (`modules/*/objects/`)
+4. Extensions (`extensions/`)
+
+Later definitions override earlier ones for conflicting properties, and merge for nested structures like fields.
+
+## Testing Extensions
+
+Always test that your extensions:
+1. Don't break existing functionality
+2. Merge correctly with the base definition
+3. Have appropriate indexes for new fields
+4. Include i18n translations for new labels

package/templates/enterprise/src/extensions/user.extension.object.yml

@@ -0,0 +1,42 @@
+name: user
+# This extends the core user object with company-specific fields
+label: System User (Extended)
+
+fields:
+  # Add employee link
+  employee:
+    type: lookup
+    reference_to: hr_employee
+    label: Employee Record
+    unique: true
+  
+  # Override email to make it required and unique
+  email:
+    required: true
+    unique: true
+  
+  # Add custom fields
+  employee_id:
+    type: text
+    label: Employee ID
+    unique: true
+    index: true
+  
+  department:
+    type: lookup
+    reference_to: hr_department
+    label: Department
+  
+  office_location:
+    type: select
+    options:
+      - headquarters
+      - branch_office_a
+      - branch_office_b
+      - remote
+    label: Office Location
+  
+  two_factor_enabled:
+    type: boolean
+    defaultValue: false
+    label: Two-Factor Auth Enabled

package/templates/enterprise/src/extensions/user.ts

@@ -0,0 +1,26 @@
+// Auto-generated by ObjectQL. DO NOT EDIT.
+import { ObjectDoc } from '@objectql/types';
+
+export interface User extends ObjectDoc {
+    /**
+     * Employee Record
+     */
+    employee?: string | number;
+    email: any;
+    /**
+     * Employee ID
+     */
+    employee_id?: string;
+    /**
+     * Department
+     */
+    department?: string | number;
+    /**
+     * Office Location
+     */
+    office_location?: string;
+    /**
+     * Two-Factor Auth Enabled
+     */
+    two_factor_enabled?: boolean;
+}

package/templates/enterprise/src/index.ts

@@ -0,0 +1,47 @@
+import { ObjectQL } from '@objectql/core';
+import { SqlDriver } from '@objectql/driver-sql';
+import { ObjectLoader } from '@objectql/platform-node';
+import * as path from 'path';
+import { AuditLogPlugin } from './plugins/audit/audit.plugin';
+
+async function main() {
+    console.log("🚀 Starting Enterprise ERP Showcase...");
+
+    const app = new ObjectQL({
+        datasources: {
+            default: new SqlDriver({
+                client: 'sqlite3',
+                connection: { filename: ':memory:' },
+                useNullAsDefault: true
+            })
+        }
+    });
+
+    // Register Plugin
+    app.use(new AuditLogPlugin());
+
+    const loader = new ObjectLoader(app.metadata);
+    await loader.load(path.join(__dirname));
+
+    await app.init();
+    console.log("✅ Enterprise Engine Booted");
+
+    const ctx = app.createContext({ isSystem: true });
+
+    // Business Logic
+    console.log("Creating Employee...");
+    const emp = await ctx.object('employees').create({
+        first_name: 'John',
+        last_name: 'Doe',
+        email: 'john.doe@corp.com',
+        department: 'Engineering'
+    });
+
+    console.log(`Created Employee: ${emp.first_name} ${emp.last_name}`);
+}
+
+if (require.main === module) {
+    main().catch(console.error);
+}
+
+export * from './types';

package/templates/enterprise/src/modules/crm/README.md

@@ -0,0 +1,99 @@
+# CRM Module
+
+## Overview
+The Customer Relationship Management (CRM) module handles all customer-facing business processes including lead management, account management, contact management, and opportunity tracking.
+
+## Objects
+
+### crm_account
+Company or organization customers. Stores company information, industry classification, and revenue data.
+
+**Key Features:**
+- Hierarchical account structure (parent-child accounts)
+- Industry classification
+- Revenue tracking
+- AI-powered search on company name and description
+
+### crm_contact
+Individual contacts associated with accounts.
+
+**Key Features:**
+- Linked to accounts
+- Lead source tracking
+- Full name formula field
+- AI-powered search
+
+### crm_opportunity
+Sales opportunities and deals.
+
+**Key Features:**
+- Stage-based pipeline management
+- Probability and amount tracking
+- Custom actions for won/lost marking
+- Forecasting support via indexes
+
+### crm_lead
+Potential sales leads before conversion.
+
+**Key Features:**
+- Lead qualification workflow
+- Rating system (hot/warm/cold)
+- Convert action to create Account, Contact, and Opportunity
+- Lead source attribution
+
+## Relationships
+
+```
+Lead --converts to--> Account + Contact + Opportunity
+Account <--has many-- Contact
+Account <--has many-- Opportunity
+```
+
+## Team Ownership
+**Owner:** Sales Team
+**Primary Contact:** sales-team@example.com
+
+## Dependencies
+- **Core Objects:** `user` (for ownership tracking)
+- **External:** None
+
+## Custom Actions
+- `Lead.convert` - Convert lead to account/contact/opportunity
+- `Opportunity.mark_won` - Mark opportunity as won
+- `Opportunity.mark_lost` - Mark opportunity as lost
+
+## Indexes Strategy
+- Composite indexes on `owner + status` for sales rep dashboards
+- Date-based indexes for pipeline reporting
+- Industry indexes for market analysis
+
+## Usage Examples
+
+### Find hot leads for a sales rep
+```typescript
+const leads = await app.find({
+  object: 'crm_lead',
+  filters: [
+    ['owner', '=', userId],
+    'and',
+    ['rating', '=', 'hot'],
+    'and',
+    ['status', '!=', 'converted']
+  ]
+});
+```
+
+### Pipeline report for current quarter
+```typescript
+const opportunities = await app.find({
+  object: 'crm_opportunity',
+  filters: [
+    ['close_date', '>=', quarterStart],
+    'and',
+    ['close_date', '<=', quarterEnd],
+    'and',
+    ['stage', 'not in', ['closed_won', 'closed_lost']]
+  ],
+  sort: [['amount', 'desc']]
+});
+```

package/templates/enterprise/src/modules/crm/crm_account.object.yml

@@ -0,0 +1,105 @@
+label: Account
+description: Customer company or organization
+icon: briefcase-line
+
+fields:
+  name:
+    type: text
+    required: true
+    label: Account Name
+    index: true
+  
+  account_number:
+    type: text
+    label: Account Number
+    unique: true
+    index: true
+  
+  type:
+    type: select
+    options:
+      - customer
+      - prospect
+      - partner
+      - competitor
+    defaultValue: prospect
+    index: true
+  
+  industry:
+    type: select
+    options:
+      - technology
+      - finance
+      - healthcare
+      - manufacturing
+      - retail
+      - education
+      - other
+    label: Industry
+    index: true
+  
+  annual_revenue:
+    type: currency
+    label: Annual Revenue
+  
+  employees:
+    type: number
+    label: Number of Employees
+  
+  website:
+    type: url
+    label: Website
+  
+  phone:
+    type: text
+    label: Phone
+  
+  billing_address:
+    type: textarea
+    label: Billing Address
+  
+  shipping_address:
+    type: textarea
+    label: Shipping Address
+  
+  owner:
+    type: lookup
+    reference_to: user
+    label: Account Owner
+    index: true
+  
+  parent_account:
+    type: lookup
+    reference_to: crm_account
+    label: Parent Account
+  
+  description:
+    type: textarea
+    label: Description
+  
+  status:
+    type: select
+    options:
+      - active
+      - inactive
+    defaultValue: active
+    index: true
+
+indexes:
+  # For account owner queries
+  owner_type_idx:
+    fields: [owner, type]
+  
+  # For industry analysis
+  industry_revenue_idx:
+    fields: [industry, annual_revenue]
+  
+  # For status reporting
+  status_created_idx:
+    fields: [status, created_at]
+
+ai:
+  search:
+    enabled: true
+    fields: [name, description, website]
+    model: text-embedding-3-small