Add custom API support and CRM API endpoints

Introduces support for registering custom APIs in the app schema and config. Adds two example CRM API endpoints: PipelineStatsApi and LeadConvertApi. Updates type definitions and utility functions to support API registration and creation.

Author: hotlong

examples/crm/objectstack.config.ts

@@ -5,6 +5,7 @@ import { Opportunity } from './src/domains/crm/opportunity.object';
 import { Lead } from './src/domains/crm/lead.object';
 import { Case } from './src/domains/crm/case.object';
 import { Task } from './src/domains/crm/task.object';
+import { PipelineStatsApi, LeadConvertApi } from './src/server';
 
 import { CrmActions } from './src/ui/actions';
 import { CrmDashboards } from './src/ui/dashboards';
@@ -26,6 +27,12 @@ export default App.create({
     Task
   ],
 
+  // Custom APIs
+  apis: [
+    PipelineStatsApi,
+    LeadConvertApi
+  ],
+  
   // Navigation menu structure
   menus: [
     {

examples/crm/src/server/apis.ts

@@ -0,0 +1,39 @@
+import { ApiEndpoint } from '@objectstack/spec';
+
+/**
+ * Custom API: Close Won Opportunities
+ * A business-specific endpoint that encapsulates complex logic.
+ * Path: GET /api/v1/crm/stats/pipeline
+ */
+export const PipelineStatsApi = ApiEndpoint.create({
+  name: 'get_pipeline_stats',
+  path: '/api/v1/crm/stats/pipeline',
+  method: 'GET',
+  summary: 'Get Pipeline Statistics',
+  description: 'Returns the total value of open opportunities grouped by stage',
+  
+  type: 'script',
+  target: 'server/scripts/pipeline_stats.ts', // Hypothetical script path
+  
+  authRequired: true,
+  cacheTtl: 300, // Cache for 5 minutes
+});
+
+/**
+ * Custom API: Quick Lead Conversion (RPC Style)
+ * Path: POST /api/v1/crm/leads/convert
+ */
+export const LeadConvertApi = ApiEndpoint.create({
+  name: 'lead_convert',
+  path: '/api/v1/crm/leads/convert',
+  method: 'POST',
+  summary: 'Convert Lead to Account/Contact',
+  
+  type: 'flow',
+  target: 'flow_lead_conversion_v2',
+  
+  inputMapping: [
+    { source: 'body.leadId', target: 'leadRecordId' },
+    { source: 'body.ownerId', target: 'newOwnerId' }
+  ]
+});

examples/crm/src/server/index.ts

@@ -0,0 +1 @@
+export * from './apis';

packages/spec/src/system/api.zod.ts

@@ -58,4 +58,8 @@ export const ApiEndpointSchema = z.object({
   cacheTtl: z.number().optional().describe('Response cache TTL in seconds'),
 });
 
+export const ApiEndpoint = Object.assign(ApiEndpointSchema, {
+  create: <T extends z.input<typeof ApiEndpointSchema>>(config: T) => config,
+});
+
 export type ApiEndpoint = z.infer<typeof ApiEndpointSchema>;

packages/spec/src/ui/app.zod.ts

@@ -144,6 +144,17 @@ export const AppSchema = z.object({
    * Example: ["app.access.crm"]
    */
   requiredPermissions: z.array(z.string()).optional().describe('Permissions required to access this app'),
+  
+  /** 
+   * Package Components (For config file convenience)
+   * In a real monorepo these might be auto-discovered, but here we allow explicit registration.
+   */
+  objects: z.array(z.any()).optional().describe('Objects belonging to this app'),
+  apis: z.array(z.any()).optional().describe('Custom APIs belonging to this app'),
+});
+
+export const App = Object.assign(AppSchema, {
+  create: <T extends z.input<typeof AppSchema>>(config: T) => config,
 });
 
 // Main Types