diff --git a/examples/app-crm/objectstack.config.ts b/examples/app-crm/objectstack.config.ts
index 16a62f05cd..e4915e3000 100644
--- a/examples/app-crm/objectstack.config.ts
+++ b/examples/app-crm/objectstack.config.ts
@@ -7,10 +7,8 @@ import * as views from './src/views/index.js';
import * as apps from './src/apps/index.js';
import * as dashboards from './src/dashboards/index.js';
import * as datasets from './src/datasets/index.js';
-import * as reports from './src/reports/index.js';
import * as pages from './src/pages/index.js';
import * as actions from './src/actions/index.js';
-import * as emails from './src/emails/index.js';
import { allHooks } from './src/hooks/index.js';
import { allFlows } from './src/flows/index.js';
import {
@@ -24,29 +22,19 @@ import {
WonDealActivitySharingRule,
} from './src/security/index.js';
import { CrmSeedData } from './src/data/index.js';
-import { LeadCsvImportMapping, ContactJsonSyncMapping } from './src/data/crm-mappings.js';
import { CrmDatasource, CrmAnalyticsDatasource } from './src/datasources/crm.datasource.js';
import { CrmTranslationBundle } from './src/translations/crm.translation.js';
-import { ContactExtension } from './src/extensions/contact.extension.js';
-import { CustomerPortal } from './src/portals/customer.portal.js';
-import { CrmLightTheme, CrmDarkTheme } from './src/themes/crm.theme.js';
-import { LeadScoringJob, PipelineReportJob, RenewalSweepJob } from './src/jobs/crm-jobs.js';
-import {
- PipelineSummaryEndpoint,
- LeadConvertEndpoint,
- MarketingWebhookEndpoint,
-} from './src/api/crm-endpoints.js';
-import { OpportunityChangedWebhook, DealWonSlackWebhook } from './src/webhooks/crm-webhooks.js';
-import { PipelineCube, LeadFunnelCube } from './src/analytics/crm.cube.js';
-import { HubSpotConnector, SlackConnector } from './src/connectors/crm-connectors.js';
/**
- * CRM example — exercises the full metadata loading pipeline with at
- * least one record of every form-bearing metadata type so the Studio
- * metadata-admin UI can be developed and validated against real data.
+ * CRM example — a MINIMAL, realistic relational bundle that smoke-tests the
+ * metadata application loading pipeline: objects/relationships → views →
+ * app → dashboard (dataset-backed) → hook → one screen-flow wizard → seed.
+ * Deliberately small so `pnpm dev:crm` boots fast for backend debugging.
*
- * For a full enterprise reference (10+ objects, RAG, sharing rules,
- * etc.) see https://github.com/objectstack-ai/hotcrm
+ * NOT a feature showcase: capability breadth (cubes, extensions, apis,
+ * webhooks, portals, themes, reports, jobs, emails, automation variety)
+ * lives in examples/app-showcase, whose coverage manifest enforces it.
+ * For a full enterprise reference see https://github.com/objectstack-ai/hotcrm
*/
export default defineStack({
manifest: {
@@ -58,12 +46,10 @@ export default defineStack({
description: 'Minimal CRM workspace used by the framework to validate the metadata loading pipeline end-to-end.',
},
- // Auto-resolved by the CLI; `ui` enables the Studio shell, `automation` loads
- // AutomationServicePlugin + node packs so screen flows can execute, and
- // `approvals` loads ApprovalsServicePlugin so the `approval` flow node is
- // contributed to the engine (ADR-0019) — required for the discount-approval
- // flow to compile/register and to surface the node in the designer palette.
- requires: ['ui', 'automation', 'approvals'],
+ // Auto-resolved by the CLI; `ui` enables the Studio shell, `automation`
+ // loads AutomationServicePlugin + node packs so the convert-lead screen
+ // flow can execute.
+ requires: ['ui', 'automation'],
// Infrastructure
datasources: [CrmDatasource, CrmAnalyticsDatasource],
@@ -85,28 +71,22 @@ export default defineStack({
// Data
objects: Object.values(objects),
- objectExtensions: [ContactExtension],
// UI
apps: Object.values(apps),
- portals: [CustomerPortal],
views: Object.values(views),
pages: Object.values(pages),
dashboards: Object.values(dashboards),
datasets: Object.values(datasets),
- reports: Object.values(reports),
actions: Object.values(actions),
- themes: [CrmLightTheme, CrmDarkTheme],
// Logic
hooks: allHooks,
- // ADR-0020: `workflows` retired — record state machines are now a
+ // ADR-0020: `workflows` retired — record state machines are a
// `state_machine` validation rule on the object (see
- // src/objects/opportunity.object.ts) and side-effecting automation is
- // modelled as Flows (high-value-deal, stale-opportunity in allFlows).
+ // src/objects/opportunity.object.ts). One flow only: the convert-lead
+ // screen wizard the smoke test drives.
flows: allFlows,
- jobs: [LeadScoringJob, PipelineReportJob, RenewalSweepJob],
- emailTemplates: Object.values(emails),
// Security
roles: [SalesRepRole, SalesManagerRole, FinanceApproverRole],
@@ -117,17 +97,6 @@ export default defineStack({
WonDealActivitySharingRule,
],
- // API
- apis: [PipelineSummaryEndpoint, LeadConvertEndpoint, MarketingWebhookEndpoint],
- webhooks: [OpportunityChangedWebhook, DealWonSlackWebhook],
-
- // Data Extensions
- mappings: [LeadCsvImportMapping, ContactJsonSyncMapping],
- analyticsCubes: [PipelineCube, LeadFunnelCube],
-
- // Integrations
- connectors: [HubSpotConnector, SlackConnector],
-
// Seed data
data: CrmSeedData,
});
diff --git a/examples/app-crm/src/actions/index.ts b/examples/app-crm/src/actions/index.ts
index 9490e28e5f..0957b456b8 100644
--- a/examples/app-crm/src/actions/index.ts
+++ b/examples/app-crm/src/actions/index.ts
@@ -1,4 +1,3 @@
// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
export { ConvertLeadAction } from './convert-lead.action.js';
-export { ParkLeadAction } from './park-lead.action.js';
diff --git a/examples/app-crm/src/actions/park-lead.action.ts b/examples/app-crm/src/actions/park-lead.action.ts
deleted file mode 100644
index 0f4a30ca04..0000000000
--- a/examples/app-crm/src/actions/park-lead.action.ts
+++ /dev/null
@@ -1,35 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-import { defineAction } from '@objectstack/spec/ui';
-
-/**
- * Row-level action on crm_lead — reassign the lead's owner.
- *
- * Demonstrates the `undoable` action affordance: it's a single-record field
- * update (`assigned_to`), so the runtime captures the prior owner and the
- * success toast offers an "Undo" that restores it (backed by the client
- * UndoManager — Ctrl+Z works too). Prompts for the new owner via one param
- * (pre-filled with "Triage Queue").
- */
-export const ParkLeadAction = defineAction({
- name: 'crm_park_lead',
- label: 'Reassign Lead',
- icon: 'UserPlus',
- objectName: 'crm_lead',
- // `type: 'api'` with a non-URL target routes to the console runtime's generic
- // `dataSource.update` path (the row id comes from the list_item row record).
- type: 'api',
- target: 'crm_lead',
- // From the list row AND the record header — both runtimes drive param
- // collection, the dataSource.update, and the Undo toast.
- locations: ['list_item', 'record_header'],
- // Conditional disable (CEL): a converted lead is locked — the action shows but
- // greys out, rather than disappearing. Demonstrates `disabled` (greys) vs
- // `visible` (hides). Evaluated against the record on every surface.
- disabled: 'record.status == "converted"',
- params: [
- { field: 'assigned_to', label: 'Reassign to', defaultValue: 'Triage Queue', required: true },
- ],
- undoable: true,
- successMessage: 'Lead reassigned.',
-});
diff --git a/examples/app-crm/src/analytics/crm.cube.ts b/examples/app-crm/src/analytics/crm.cube.ts
deleted file mode 100644
index 766f9cc5ab..0000000000
--- a/examples/app-crm/src/analytics/crm.cube.ts
+++ /dev/null
@@ -1,122 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-import { defineCube } from '@objectstack/spec/data';
-
-/**
- * Opportunity Pipeline Cube — revenue metrics broken down by stage,
- * owner, and account for the CRM sales dashboard.
- */
-export const PipelineCube = defineCube({
- name: 'crm_pipeline',
- title: 'CRM Pipeline',
- description: 'Revenue and deal-count analytics across the sales pipeline.',
- sql: 'crm_opportunity',
- measures: {
- count: {
- name: 'count',
- label: 'Deal Count',
- type: 'count',
- sql: '*',
- },
- total_amount: {
- name: 'total_amount',
- label: 'Total Pipeline Value',
- type: 'sum',
- sql: 'amount',
- format: 'currency',
- },
- avg_amount: {
- name: 'avg_amount',
- label: 'Average Deal Size',
- type: 'avg',
- sql: 'amount',
- format: 'currency',
- },
- win_rate: {
- name: 'win_rate',
- label: 'Win Rate (%)',
- type: 'number',
- sql: "SUM(CASE WHEN stage = 'closed_won' THEN 1 ELSE 0 END) * 100.0 / COUNT(*)",
- format: 'percent',
- },
- },
- dimensions: {
- stage: {
- name: 'stage',
- label: 'Pipeline Stage',
- type: 'string',
- sql: 'stage',
- },
- close_date: {
- name: 'close_date',
- label: 'Close Date',
- type: 'time',
- sql: 'close_date',
- },
- owner: {
- name: 'owner',
- label: 'Owner',
- type: 'string',
- sql: 'owner_id',
- },
- },
- joins: {
- crm_account: {
- name: 'crm_account',
- relationship: 'many_to_one',
- sql: '${crm_pipeline}.account_id = ${crm_account}.id',
- },
- },
- refreshKey: {
- every: '1 hour',
- },
- public: false,
-});
-
-/**
- * Lead funnel cube — conversion metrics from lead to opportunity.
- */
-export const LeadFunnelCube = defineCube({
- name: 'crm_lead_funnel',
- title: 'CRM Lead Funnel',
- description: 'Lead volume and conversion rate analytics.',
- sql: 'crm_lead',
- measures: {
- count: {
- name: 'count',
- label: 'Lead Count',
- type: 'count',
- sql: '*',
- },
- converted_count: {
- name: 'converted_count',
- label: 'Converted Leads',
- type: 'count',
- sql: 'converted_opportunity_id',
- },
- },
- dimensions: {
- status: {
- name: 'status',
- label: 'Lead Status',
- type: 'string',
- sql: 'status',
- },
- source: {
- name: 'source',
- label: 'Lead Source',
- type: 'string',
- sql: 'source',
- },
- created_at: {
- name: 'created_at',
- label: 'Created At',
- type: 'time',
- sql: 'created_at',
- },
- },
- refreshKey: {
- every: '30 minutes',
- },
- public: false,
-});
diff --git a/examples/app-crm/src/api/crm-endpoints.ts b/examples/app-crm/src/api/crm-endpoints.ts
deleted file mode 100644
index fbd1797054..0000000000
--- a/examples/app-crm/src/api/crm-endpoints.ts
+++ /dev/null
@@ -1,54 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-import type { ApiEndpoint } from '@objectstack/spec/api';
-
-/**
- * Custom REST endpoint — exposes pipeline summary metrics.
- * Backed by a flow (lead_qualification_conversion) that aggregates stage data.
- */
-export const PipelineSummaryEndpoint: ApiEndpoint = {
- name: 'crm_pipeline_summary',
- path: '/api/v1/crm/pipeline-summary',
- method: 'GET',
- summary: 'Pipeline summary by stage',
- description: 'Returns opportunity count and total value grouped by stage.',
- type: 'object_operation',
- target: 'crm_opportunity',
- objectParams: {
- object: 'crm_opportunity',
- operation: 'find',
- },
- authRequired: true,
- cacheTtl: 60,
-};
-
-/**
- * Lead conversion endpoint — triggers the qualification flow via HTTP.
- */
-export const LeadConvertEndpoint: ApiEndpoint = {
- name: 'crm_lead_convert',
- path: '/api/v1/crm/leads/:id/convert',
- method: 'POST',
- summary: 'Convert a lead to an opportunity',
- type: 'flow',
- target: 'lead_qualification_conversion',
- inputMapping: [
- { source: 'params.id', target: 'leadId' },
- { source: 'body.ownerId', target: 'ownerId' },
- ],
- authRequired: true,
-};
-
-/**
- * Public webhook receiver — inbound events from external marketing tools.
- * No auth required (HMAC verified at the webhook layer instead).
- */
-export const MarketingWebhookEndpoint: ApiEndpoint = {
- name: 'crm_marketing_webhook',
- path: '/api/v1/crm/marketing/events',
- method: 'POST',
- summary: 'Receive marketing automation events',
- type: 'flow',
- target: 'lead_qualification_conversion',
- authRequired: false,
-};
diff --git a/examples/app-crm/src/connectors/crm-connectors.ts b/examples/app-crm/src/connectors/crm-connectors.ts
deleted file mode 100644
index 3cf9b6c42f..0000000000
--- a/examples/app-crm/src/connectors/crm-connectors.ts
+++ /dev/null
@@ -1,126 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-import { defineConnector } from '@objectstack/spec/integration';
-
-/**
- * HubSpot connector — sync contacts and deals bi-directionally.
- * Uses OAuth2 for authentication; actual credentials come from environment.
- */
-export const HubSpotConnector = defineConnector({
- name: 'hubspot_crm',
- label: 'HubSpot CRM',
- type: 'saas',
- description: 'Bi-directional sync of contacts, companies, and deals with HubSpot.',
- icon: 'hubspot',
- authentication: {
- type: 'oauth2',
- authorizationUrl: 'https://app.hubspot.com/oauth/authorize',
- tokenUrl: 'https://api.hubapi.com/oauth/v1/token',
- clientId: 'env:HUBSPOT_CLIENT_ID',
- clientSecret: 'env:HUBSPOT_CLIENT_SECRET',
- scopes: ['contacts', 'crm.objects.deals.read', 'crm.objects.deals.write'],
- },
- actions: [
- {
- key: 'create_contact',
- label: 'Create Contact',
- description: 'Create a new contact in HubSpot',
- inputSchema: {
- type: 'object',
- properties: {
- email: { type: 'string' },
- firstname: { type: 'string' },
- lastname: { type: 'string' },
- },
- required: ['email'],
- },
- },
- {
- key: 'update_deal',
- label: 'Update Deal',
- description: 'Update an existing deal in HubSpot',
- inputSchema: {
- type: 'object',
- properties: {
- dealId: { type: 'string' },
- dealstage: { type: 'string' },
- amount: { type: 'number' },
- },
- required: ['dealId'],
- },
- },
- ],
- triggers: [
- {
- key: 'contact_created',
- label: 'Contact Created',
- type: 'webhook',
- description: 'Fires when a contact is created in HubSpot',
- },
- {
- key: 'deal_stage_changed',
- label: 'Deal Stage Changed',
- type: 'polling',
- interval: 300,
- description: 'Polls every 5 minutes for deal stage changes',
- },
- ],
- syncConfig: {
- direction: 'bidirectional',
- schedule: '0 * * * *',
- conflictResolution: 'source_wins',
- batchSize: 500,
- },
- rateLimitConfig: {
- maxRequests: 100,
- windowSeconds: 10,
- strategy: 'sliding_window',
- },
- retryConfig: {
- strategy: 'exponential_backoff',
- maxAttempts: 3,
- initialDelayMs: 1000,
- maxDelayMs: 30000,
- },
- connectionTimeoutMs: 10000,
- requestTimeoutMs: 30000,
- status: 'inactive',
- enabled: true,
-});
-
-/**
- * Slack connector — post notifications to channels.
- */
-export const SlackConnector = defineConnector({
- name: 'slack_notifications',
- label: 'Slack',
- type: 'api',
- description: 'Post deal-win and alert notifications to Slack channels.',
- icon: 'slack',
- authentication: {
- type: 'bearer',
- token: 'env:SLACK_BOT_TOKEN',
- },
- actions: [
- {
- key: 'post_message',
- label: 'Post Message',
- description: 'Post a message to a Slack channel',
- inputSchema: {
- type: 'object',
- properties: {
- channel: { type: 'string' },
- text: { type: 'string' },
- },
- required: ['channel', 'text'],
- },
- },
- ],
- rateLimitConfig: {
- maxRequests: 50,
- windowSeconds: 60,
- strategy: 'token_bucket',
- },
- status: 'inactive',
- enabled: true,
-});
diff --git a/examples/app-crm/src/data/crm-mappings.ts b/examples/app-crm/src/data/crm-mappings.ts
deleted file mode 100644
index 66a17731fd..0000000000
--- a/examples/app-crm/src/data/crm-mappings.ts
+++ /dev/null
@@ -1,75 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-import { defineMapping } from '@objectstack/spec/data';
-
-/**
- * CSV import mapping for bulk lead upload.
- * Maps common CRM export column names to crm_lead fields.
- */
-export const LeadCsvImportMapping = defineMapping({
- name: 'csv_import_leads',
- label: 'CSV Import: Leads',
- sourceFormat: 'csv',
- targetObject: 'crm_lead',
- mode: 'upsert',
- upsertKey: ['email'],
- fieldMapping: [
- { source: 'First Name', target: 'first_name', transform: 'none' },
- { source: 'Last Name', target: 'last_name', transform: 'none' },
- { source: 'Email', target: 'email', transform: 'none' },
- { source: 'Phone', target: 'phone', transform: 'none' },
- { source: 'Company', target: 'company', transform: 'none' },
- {
- source: 'Lead Status',
- target: 'status',
- transform: 'map',
- params: {
- valueMap: {
- New: 'new',
- 'Working': 'contacted',
- Qualified: 'qualified',
- 'Unqualified': 'disqualified',
- Converted: 'converted',
- },
- },
- },
- {
- source: 'Lead Source',
- target: 'source',
- transform: 'map',
- params: {
- valueMap: {
- 'Web': 'web',
- 'Email Campaign': 'email_campaign',
- 'Cold Call': 'cold_call',
- 'Referral': 'referral',
- 'Trade Show': 'trade_show',
- },
- },
- },
- { source: 'Lead Score', target: 'lead_score', transform: 'none' },
- ],
- errorPolicy: 'skip',
- batchSize: 500,
-});
-
-/**
- * JSON import mapping for contact sync from external systems (HubSpot, etc.).
- */
-export const ContactJsonSyncMapping = defineMapping({
- name: 'json_sync_contacts',
- label: 'JSON Sync: Contacts from HubSpot',
- sourceFormat: 'json',
- targetObject: 'crm_contact',
- mode: 'upsert',
- upsertKey: ['email'],
- fieldMapping: [
- { source: 'properties.firstname', target: 'first_name', transform: 'none' },
- { source: 'properties.lastname', target: 'last_name', transform: 'none' },
- { source: 'properties.email', target: 'email', transform: 'none' },
- { source: 'properties.phone', target: 'phone', transform: 'none' },
- { source: 'properties.jobtitle', target: 'title', transform: 'none' },
- ],
- errorPolicy: 'skip',
- batchSize: 250,
-});
diff --git a/examples/app-crm/src/emails/deal-won.email.ts b/examples/app-crm/src/emails/deal-won.email.ts
deleted file mode 100644
index 39bac0b18a..0000000000
--- a/examples/app-crm/src/emails/deal-won.email.ts
+++ /dev/null
@@ -1,36 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-import { defineEmailTemplateDefinition } from '@objectstack/spec/system';
-
-/**
- * Sent when an opportunity moves to Closed Won.
- * Referenced by the `notify_owner_deal_won` workflow action.
- */
-export const DealWonEmail = defineEmailTemplateDefinition({
- name: 'crm.deal_won',
- label: 'Deal Won — Owner Congrats',
- category: 'workflow',
- locale: 'en-US',
- subject: 'Congratulations — {{opportunity.name}} closed!',
- bodyHtml: `
-
-
Great news!
-
Hi {{user.name}},
-
The opportunity {{opportunity.name}} for {{account.name}} just closed at \${{opportunity.amount}}.
-
Nice work! 🎉
-
-
Time to follow up
-
Hi {{owner.name}},
-
Lead {{lead.name}} ({{lead.company}}) has had no activity for {{days_idle}} days.
-
Open the lead in CRM and log the next action to keep your pipeline healthy.
-
View lead
-
-
Welcome aboard 👋
-
Hi {{contact.first_name}},
-
Thanks for connecting with {{account.name}}. Your account manager {{owner.name}} will be in touch shortly.
-
Open your customer portal
-
Or copy this link: {{portal_url}}
-