Merge branch 'main' of https://github.com/objectstack-ai/spec

Author: hotlong

content/prompts/plugin/project-structure.prompt.md

@@ -18,11 +18,17 @@ my-plugin/
 │   └── copilot-instructions.md  # (Copy from content/prompts/plugin/copilot-instructions.md)
 ├── src/
 │   ├── objects/                 # 📦 Data Models (*.object.ts, *.hook.ts)
+│   │   └── index.ts            #    ↳ Barrel: re-exports all *.object.ts
 │   ├── actions/                 # ⚡ Buttons & Actions (*.actions.ts)
+│   │   └── index.ts            #    ↳ Barrel: re-exports all actions
 │   ├── flows/                   # 🔄 Automation Flows (*.flow.ts)
+│   │   └── index.ts
 │   ├── dashboards/              # 📊 BI Dashboards (*.dashboard.ts)
+│   │   └── index.ts
 │   ├── reports/                 # 📈 Analytics Reports (*.report.ts)
+│   │   └── index.ts
 │   ├── apps/                    # 🚀 App Configuration (*.app.ts)
+│   │   └── index.ts
 │   ├── apis/                    # 🌐 API Endpoints (*.api.ts)
 │   ├── agents/                  # 🤖 AI Agents (*.agent.ts)
 │   ├── rag/                     # 🧠 RAG Pipelines (*.rag.ts)
@@ -77,20 +83,17 @@ src/
 ## 2. Essential Configuration Files
 
 ### A. The Manifest (`objectstack.config.ts`)
-This is the heart of your plugin. It registers all metadata so the runtime can load it. Organize imports by type with section comments to match the directory structure.
+This is the heart of your plugin. It registers all metadata so the runtime can load it.
+
+**Barrel Pattern (Recommended):** Each type folder has an `index.ts` barrel that re-exports all definitions. The config collects them via `Object.values()` — adding a new file only requires updating the barrel, not the config.
 
 ```typescript
 import { defineStack } from '@objectstack/spec';
 
-// ─── Objects ────────────────────────────────────────────────────────
-import { Project } from './src/objects/project.object';
-import { Task } from './src/objects/task.object';
-
-// ─── Actions ────────────────────────────────────────────────────────
-import { CompleteTaskAction } from './src/actions/task.actions';
-
-// ─── App ────────────────────────────────────────────────────────────
-import { ProjectApp } from './src/apps/project.app';
+// ─── Barrel Imports (one per metadata type) ─────────────────────────
+import * as objects from './src/objects';
+import * as actions from './src/actions';
+import * as apps from './src/apps';
 
 export default defineStack({
   manifest: {
@@ -101,12 +104,27 @@ export default defineStack({
     description: 'Project management capabilities for ObjectStack',
   },
 
-  objects: [Project, Task],
-  actions: [CompleteTaskAction],
-  apps: [ProjectApp],
+  // Auto-collected from barrel index files
+  objects: Object.values(objects),
+  actions: Object.values(actions),
+  apps: Object.values(apps),
 });
 ```
 
+**Barrel File Example** (`src/objects/index.ts`):
+```typescript
+// Only re-export *.object.ts definitions
+// Hooks (*.hook.ts) and state machines (*.state.ts) are auto-associated by convention
+export { Project } from './project.object';
+export { Task } from './task.object';
+```
+
+> **Workflow:** Adding a new object only requires 2 steps:
+> 1. Create `src/objects/invoice.object.ts`
+> 2. Add `export { Invoice } from './invoice.object'` to `src/objects/index.ts`
+> 
+> The `objectstack.config.ts` stays unchanged.
+
 ### B. Package Definition (`package.json`)
 You must depend on `@objectstack/spec` to get the types.
 
@@ -159,5 +177,6 @@ Enable `strict` mode and path mapping.
 1.  **Create Folders:** Run `mkdir -p src/objects src/actions src/apps`.
 2.  **Install Instructions:** Copy `content/prompts/plugin/copilot-instructions.md` to `.github/`.
 3.  **Init Git:** `git init && echo "node_modules\ndist" > .gitignore`.
-4.  **First Object:** Create `src/objects/example.object.ts` to test type resolution.
-5.  **Register:** Import the object in `objectstack.config.ts`.
+4.  **First Object:** Create `src/objects/example.object.ts`.
+5.  **Create Barrel:** Create `src/objects/index.ts` with `export { Example } from './example.object'`.
+6.  **Register:** Import the barrel in `objectstack.config.ts` via `import * as objects from './src/objects'`.

examples/app-crm/objectstack.config.ts

@@ -1,77 +1,25 @@
 import { defineStack } from '@objectstack/spec';
 
-// ─── Objects ────────────────────────────────────────────────────────
-import { Account } from './src/objects/account.object';
-import { Contact } from './src/objects/contact.object';
-import { Opportunity } from './src/objects/opportunity.object';
-import { Lead } from './src/objects/lead.object';
-import { Quote } from './src/objects/quote.object';
-import { Contract } from './src/objects/contract.object';
-import { Case } from './src/objects/case.object';
-import { Task } from './src/objects/task.object';
-import { Campaign } from './src/objects/campaign.object';
-import { Product } from './src/objects/product.object';
-
-// ─── APIs ───────────────────────────────────────────────────────────
-import { PipelineStatsApi } from './src/apis/pipeline-stats.api';
-import { LeadConvertApi } from './src/apis/lead-convert.api';
-
-// ─── Actions ────────────────────────────────────────────────────────
-import { ConvertLeadAction, CreateCampaignAction } from './src/actions/lead.actions';
-import { MarkPrimaryContactAction, SendEmailAction } from './src/actions/contact.actions';
-import { CloneOpportunityAction, MassUpdateStageAction } from './src/actions/opportunity.actions';
-import { EscalateCaseAction, CloseCaseAction } from './src/actions/case.actions';
-import { LogCallAction, ExportToCsvAction } from './src/actions/global.actions';
-
-// ─── Dashboards ─────────────────────────────────────────────────────
-import { SalesDashboard } from './src/dashboards/sales.dashboard';
-import { ServiceDashboard } from './src/dashboards/service.dashboard';
-import { ExecutiveDashboard } from './src/dashboards/executive.dashboard';
-
-// ─── Reports ────────────────────────────────────────────────────────
-import { OpportunitiesByStageReport, WonOpportunitiesByOwnerReport } from './src/reports/opportunity.report';
-import { AccountsByIndustryTypeReport } from './src/reports/account.report';
-import { CasesByStatusPriorityReport, SlaPerformanceReport } from './src/reports/case.report';
-import { LeadsBySourceReport } from './src/reports/lead.report';
-import { ContactsByAccountReport } from './src/reports/contact.report';
-import { TasksByOwnerReport } from './src/reports/task.report';
-
-// ─── Flows ──────────────────────────────────────────────────────────
-import { LeadConversionFlow } from './src/flows/lead-conversion.flow';
-import { OpportunityApprovalFlow } from './src/flows/opportunity-approval.flow';
-import { CaseEscalationFlow } from './src/flows/case-escalation.flow';
-import { QuoteGenerationFlow } from './src/flows/quote-generation.flow';
-import { CampaignEnrollmentFlow } from './src/flows/campaign-enrollment.flow';
-
-// ─── Agents ─────────────────────────────────────────────────────────
-import { SalesAssistantAgent } from './src/agents/sales.agent';
-import { ServiceAgent } from './src/agents/service.agent';
-import { LeadEnrichmentAgent } from './src/agents/lead-enrichment.agent';
-import { RevenueIntelligenceAgent } from './src/agents/revenue-intelligence.agent';
-import { EmailCampaignAgent } from './src/agents/email-campaign.agent';
-
-// ─── RAG Pipelines ─────────────────────────────────────────────────
-import { SalesKnowledgeRAG } from './src/rag/sales-knowledge.rag';
-import { SupportKnowledgeRAG } from './src/rag/support-knowledge.rag';
-import { ProductInfoRAG } from './src/rag/product-info.rag';
-import { CompetitiveIntelRAG } from './src/rag/competitive-intel.rag';
-
-// ─── Profiles ───────────────────────────────────────────────────────
-import { SalesRepProfile } from './src/profiles/sales-rep.profile';
-import { SalesManagerProfile } from './src/profiles/sales-manager.profile';
-import { ServiceAgentProfile } from './src/profiles/service-agent.profile';
-import { MarketingUserProfile } from './src/profiles/marketing-user.profile';
-import { SystemAdminProfile } from './src/profiles/system-admin.profile';
-
-// ─── Sharing & Security ────────────────────────────────────────────
-import { OrganizationDefaults } from './src/sharing/defaults.sharing';
-import { AccountTeamSharingRule, TerritorySharingRules } from './src/sharing/account.sharing';
-import { OpportunitySalesSharingRule } from './src/sharing/opportunity.sharing';
-import { CaseEscalationSharingRule } from './src/sharing/case.sharing';
-import { RoleHierarchy } from './src/sharing/role-hierarchy';
-
-// ─── App ────────────────────────────────────────────────────────────
-import { CrmApp } from './src/apps/crm.app';
+// ─── Barrel Imports (one per metadata type) ─────────────────────────
+import * as objects from './src/objects';
+import * as apis from './src/apis';
+import * as actions from './src/actions';
+import * as dashboards from './src/dashboards';
+import * as reports from './src/reports';
+import * as flows from './src/flows';
+import * as agents from './src/agents';
+import * as ragPipelines from './src/rag';
+import * as profiles from './src/profiles';
+import * as apps from './src/apps';
+
+// ─── Sharing & Security (special: mixed single/array values) ───────
+import {
+  OrganizationDefaults,
+  AccountTeamSharingRule, TerritorySharingRules,
+  OpportunitySalesSharingRule,
+  CaseEscalationSharingRule,
+  RoleHierarchy,
+} from './src/sharing';
 
 export default defineStack({
   manifest: {
@@ -80,77 +28,21 @@ export default defineStack({
     type: 'app',
     name: 'Enterprise CRM',
     description: 'Comprehensive enterprise CRM demonstrating all ObjectStack Protocol features including AI, security, and automation',
-    author: 'ObjectStack Team',
-    repository: 'https://github.com/objectstack-ai/spec',
-    license: 'MIT',
   },
 
-  objects: [
-    Account, Contact, Lead, Opportunity, Quote, Contract,
-    Case, Task,
-    Campaign,
-    Product,
-  ],
-
-  apis: [
-    PipelineStatsApi,
-    LeadConvertApi,
-  ],
-
-  actions: [
-    ConvertLeadAction, CreateCampaignAction,
-    MarkPrimaryContactAction, SendEmailAction,
-    CloneOpportunityAction, MassUpdateStageAction,
-    EscalateCaseAction, CloseCaseAction,
-    LogCallAction, ExportToCsvAction,
-  ],
-
-  dashboards: [
-    SalesDashboard,
-    ServiceDashboard,
-    ExecutiveDashboard,
-  ],
-
-  reports: [
-    OpportunitiesByStageReport, WonOpportunitiesByOwnerReport,
-    AccountsByIndustryTypeReport,
-    CasesByStatusPriorityReport, SlaPerformanceReport,
-    LeadsBySourceReport,
-    ContactsByAccountReport,
-    TasksByOwnerReport,
-  ],
-
-  flows: [
-    LeadConversionFlow,
-    OpportunityApprovalFlow,
-    CaseEscalationFlow,
-    QuoteGenerationFlow,
-    CampaignEnrollmentFlow,
-  ],
-
-  agents: [
-    SalesAssistantAgent,
-    ServiceAgent,
-    LeadEnrichmentAgent,
-    RevenueIntelligenceAgent,
-    EmailCampaignAgent,
-  ],
-
-  ragPipelines: [
-    SalesKnowledgeRAG,
-    SupportKnowledgeRAG,
-    ProductInfoRAG,
-    CompetitiveIntelRAG,
-  ],
-
-  profiles: [
-    SalesRepProfile,
-    SalesManagerProfile,
-    ServiceAgentProfile,
-    MarketingUserProfile,
-    SystemAdminProfile,
-  ],
-
+  // Auto-collected from barrel index files via Object.values()
+  objects: Object.values(objects),
+  apis: Object.values(apis),
+  actions: Object.values(actions),
+  dashboards: Object.values(dashboards),
+  reports: Object.values(reports),
+  flows: Object.values(flows) as any,
+  agents: Object.values(agents) as any,
+  ragPipelines: Object.values(ragPipelines),
+  profiles: Object.values(profiles),
+  apps: Object.values(apps),
+
+  // Sharing & security (requires explicit wiring)
   sharingRules: [
     AccountTeamSharingRule,
     OpportunitySalesSharingRule,
@@ -159,6 +51,4 @@ export default defineStack({
   ],
   roleHierarchy: RoleHierarchy,
   organizationDefaults: OrganizationDefaults,
-
-  apps: [CrmApp],
-});
+} as any);

examples/app-crm/src/actions/index.ts

@@ -0,0 +1,8 @@
+/**
+ * Action Definitions Barrel
+ */
+export { EscalateCaseAction, CloseCaseAction } from './case.actions';
+export { MarkPrimaryContactAction, SendEmailAction } from './contact.actions';
+export { LogCallAction, ExportToCsvAction } from './global.actions';
+export { ConvertLeadAction, CreateCampaignAction } from './lead.actions';
+export { CloneOpportunityAction, MassUpdateStageAction } from './opportunity.actions';

examples/app-crm/src/agents/index.ts

@@ -0,0 +1,8 @@
+/**
+ * Agent Definitions Barrel
+ */
+export { EmailCampaignAgent } from './email-campaign.agent';
+export { LeadEnrichmentAgent } from './lead-enrichment.agent';
+export { RevenueIntelligenceAgent } from './revenue-intelligence.agent';
+export { SalesAssistantAgent } from './sales.agent';
+export { ServiceAgent } from './service.agent';

examples/app-crm/src/apis/index.ts

@@ -0,0 +1,5 @@
+/**
+ * API Definitions Barrel
+ */
+export { LeadConvertApi } from './lead-convert.api';
+export { PipelineStatsApi } from './pipeline-stats.api';

examples/app-crm/src/apps/index.ts

@@ -0,0 +1,4 @@
+/**
+ * App Definitions Barrel
+ */
+export { CrmApp } from './crm.app';

examples/app-crm/src/dashboards/index.ts

@@ -0,0 +1,6 @@
+/**
+ * Dashboard Definitions Barrel
+ */
+export { ExecutiveDashboard } from './executive.dashboard';
+export { SalesDashboard } from './sales.dashboard';
+export { ServiceDashboard } from './service.dashboard';

examples/app-crm/src/flows/index.ts

@@ -0,0 +1,8 @@
+/**
+ * Flow Definitions Barrel
+ */
+export { CampaignEnrollmentFlow } from './campaign-enrollment.flow';
+export { CaseEscalationFlow } from './case-escalation.flow';
+export { LeadConversionFlow } from './lead-conversion.flow';
+export { OpportunityApprovalFlow } from './opportunity-approval.flow';
+export { QuoteGenerationFlow } from './quote-generation.flow';

examples/app-crm/src/objects/index.ts

@@ -0,0 +1,17 @@
+/**
+ * Object Definitions Barrel
+ * 
+ * Re-exports all *.object.ts definitions for auto-registration.
+ * Hooks (*.hook.ts) and state machines (*.state.ts) are excluded —
+ * they are auto-associated by naming convention at runtime.
+ */
+export { Account } from './account.object';
+export { Campaign } from './campaign.object';
+export { Case } from './case.object';
+export { Contact } from './contact.object';
+export { Contract } from './contract.object';
+export { Lead } from './lead.object';
+export { Opportunity } from './opportunity.object';
+export { Product } from './product.object';
+export { Quote } from './quote.object';
+export { Task } from './task.object';

examples/app-crm/src/profiles/index.ts

@@ -0,0 +1,8 @@
+/**
+ * Profile Definitions Barrel
+ */
+export { MarketingUserProfile } from './marketing-user.profile';
+export { SalesManagerProfile } from './sales-manager.profile';
+export { SalesRepProfile } from './sales-rep.profile';
+export { ServiceAgentProfile } from './service-agent.profile';
+export { SystemAdminProfile } from './system-admin.profile';