@contractspec/example.crm-pipeline 1.44.0

package/src/handlers/mock-data.ts

@@ -0,0 +1,198 @@
+/**
+ * Mock data for crm-pipeline handlers
+ */
+
+// ============ Types for Mock Data ============
+
+export interface MockDeal {
+  id: string;
+  name: string;
+  value: number;
+  currency: string;
+  pipelineId: string;
+  stageId: string;
+  status: 'OPEN' | 'WON' | 'LOST' | 'STALE';
+  contactId?: string;
+  companyId?: string;
+  ownerId: string;
+  expectedCloseDate?: Date;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface MockStage {
+  id: string;
+  name: string;
+  position: number;
+  pipelineId: string;
+}
+
+// ============ Pipeline Stages Mock Data ============
+
+export const MOCK_STAGES: MockStage[] = [
+  { id: 'stage-1', name: 'Lead', position: 1, pipelineId: 'pipeline-1' },
+  { id: 'stage-2', name: 'Qualified', position: 2, pipelineId: 'pipeline-1' },
+  { id: 'stage-3', name: 'Proposal', position: 3, pipelineId: 'pipeline-1' },
+  { id: 'stage-4', name: 'Negotiation', position: 4, pipelineId: 'pipeline-1' },
+  { id: 'stage-5', name: 'Closed', position: 5, pipelineId: 'pipeline-1' },
+];
+
+// ============ Deal Mock Data ============
+
+export const MOCK_DEALS: MockDeal[] = [
+  {
+    id: 'deal-1',
+    name: 'Enterprise License - Acme Corp',
+    value: 75000,
+    currency: 'USD',
+    pipelineId: 'pipeline-1',
+    stageId: 'stage-3',
+    status: 'OPEN',
+    contactId: 'contact-1',
+    companyId: 'company-1',
+    ownerId: 'user-1',
+    expectedCloseDate: new Date('2024-05-15T00:00:00Z'),
+    createdAt: new Date('2024-02-01T10:00:00Z'),
+    updatedAt: new Date('2024-04-10T14:30:00Z'),
+  },
+  {
+    id: 'deal-2',
+    name: 'Startup Plan - TechStart Inc',
+    value: 12000,
+    currency: 'USD',
+    pipelineId: 'pipeline-1',
+    stageId: 'stage-2',
+    status: 'OPEN',
+    contactId: 'contact-2',
+    companyId: 'company-2',
+    ownerId: 'user-2',
+    expectedCloseDate: new Date('2024-04-30T00:00:00Z'),
+    createdAt: new Date('2024-03-15T09:00:00Z'),
+    updatedAt: new Date('2024-04-08T11:15:00Z'),
+  },
+  {
+    id: 'deal-3',
+    name: 'Professional Services - Global Ltd',
+    value: 45000,
+    currency: 'USD',
+    pipelineId: 'pipeline-1',
+    stageId: 'stage-4',
+    status: 'OPEN',
+    contactId: 'contact-3',
+    companyId: 'company-3',
+    ownerId: 'user-1',
+    expectedCloseDate: new Date('2024-04-20T00:00:00Z'),
+    createdAt: new Date('2024-01-20T08:00:00Z'),
+    updatedAt: new Date('2024-04-12T16:45:00Z'),
+  },
+  {
+    id: 'deal-4',
+    name: 'Annual Contract - SmallBiz Co',
+    value: 8500,
+    currency: 'USD',
+    pipelineId: 'pipeline-1',
+    stageId: 'stage-1',
+    status: 'OPEN',
+    contactId: 'contact-4',
+    companyId: 'company-4',
+    ownerId: 'user-3',
+    createdAt: new Date('2024-04-05T12:00:00Z'),
+    updatedAt: new Date('2024-04-05T12:00:00Z'),
+  },
+  {
+    id: 'deal-5',
+    name: 'Custom Integration - MegaCorp',
+    value: 125000,
+    currency: 'USD',
+    pipelineId: 'pipeline-1',
+    stageId: 'stage-5',
+    status: 'WON',
+    contactId: 'contact-5',
+    companyId: 'company-5',
+    ownerId: 'user-1',
+    expectedCloseDate: new Date('2024-03-31T00:00:00Z'),
+    createdAt: new Date('2023-11-10T10:00:00Z'),
+    updatedAt: new Date('2024-03-28T09:00:00Z'),
+  },
+  {
+    id: 'deal-6',
+    name: 'Pilot Project - NewCo',
+    value: 5000,
+    currency: 'USD',
+    pipelineId: 'pipeline-1',
+    stageId: 'stage-2',
+    status: 'LOST',
+    contactId: 'contact-6',
+    companyId: 'company-6',
+    ownerId: 'user-2',
+    createdAt: new Date('2024-01-15T14:00:00Z'),
+    updatedAt: new Date('2024-02-28T10:30:00Z'),
+  },
+];
+
+// ============ Company Mock Data ============
+
+export const MOCK_COMPANIES = [
+  {
+    id: 'company-1',
+    name: 'Acme Corporation',
+    domain: 'acme.com',
+    industry: 'Technology',
+    size: '1000-5000',
+    website: 'https://acme.com',
+    createdAt: new Date('2024-01-01T00:00:00Z'),
+  },
+  {
+    id: 'company-2',
+    name: 'TechStart Inc',
+    domain: 'techstart.io',
+    industry: 'Software',
+    size: '10-50',
+    website: 'https://techstart.io',
+    createdAt: new Date('2024-02-15T00:00:00Z'),
+  },
+  {
+    id: 'company-3',
+    name: 'Global Ltd',
+    domain: 'global.com',
+    industry: 'Consulting',
+    size: '500-1000',
+    website: 'https://global.com',
+    createdAt: new Date('2023-12-01T00:00:00Z'),
+  },
+];
+
+// ============ Contact Mock Data ============
+
+export const MOCK_CONTACTS = [
+  {
+    id: 'contact-1',
+    firstName: 'John',
+    lastName: 'Smith',
+    email: 'john.smith@acme.com',
+    phone: '+1-555-0101',
+    title: 'VP of Engineering',
+    companyId: 'company-1',
+    createdAt: new Date('2024-01-05T00:00:00Z'),
+  },
+  {
+    id: 'contact-2',
+    firstName: 'Sarah',
+    lastName: 'Johnson',
+    email: 'sarah@techstart.io',
+    phone: '+1-555-0102',
+    title: 'CEO',
+    companyId: 'company-2',
+    createdAt: new Date('2024-02-20T00:00:00Z'),
+  },
+  {
+    id: 'contact-3',
+    firstName: 'Michael',
+    lastName: 'Brown',
+    email: 'michael.brown@global.com',
+    phone: '+1-555-0103',
+    title: 'CTO',
+    companyId: 'company-3',
+    createdAt: new Date('2023-12-10T00:00:00Z'),
+  },
+];

package/src/index.ts

@@ -0,0 +1,31 @@
+// CRM Pipeline Example
+// Demonstrates ContractSpec principles for a CRM application
+
+export * from './entities';
+export * from './operations';
+export * from './events';
+export * from './handlers';
+export * from './presentations';
+export * from './crm-pipeline.feature';
+export { default as example } from './example';
+import './docs';
+
+// Schema composition configuration
+import { identityRbacSchemaContribution } from '@contractspec/lib.identity-rbac';
+import { auditTrailSchemaContribution } from '@contractspec/module.audit-trail';
+import { notificationsSchemaContribution } from '@contractspec/module.notifications';
+import { crmPipelineSchemaContribution } from './entities';
+
+/**
+ * Complete schema composition for CRM Pipeline.
+ */
+export const schemaComposition = {
+  modules: [
+    identityRbacSchemaContribution,
+    auditTrailSchemaContribution,
+    notificationsSchemaContribution,
+    crmPipelineSchemaContribution,
+  ],
+  provider: 'postgresql' as const,
+  outputPath: './prisma/schema/generated.prisma',
+};

package/src/operations/index.ts

@@ -0,0 +1,20 @@
+// Deal contracts and models - re-exports from deal domain
+// Note: DealStatusEnum is exported from entities, not here (to avoid conflict)
+export {
+  DealStatusFilterEnum,
+  DealModel,
+  CreateDealInputModel,
+  MoveDealInputModel,
+  DealMovedPayloadModel,
+  WinDealInputModel,
+  DealWonPayloadModel,
+  LoseDealInputModel,
+  DealLostPayloadModel,
+  ListDealsInputModel,
+  ListDealsOutputModel,
+  CreateDealContract,
+  MoveDealContract,
+  WinDealContract,
+  LoseDealContract,
+  ListDealsContract,
+} from '../deal';

package/src/presentations/dashboard.presentation.ts

@@ -0,0 +1,60 @@
+/**
+ * CRM Dashboard Presentation Descriptor
+ */
+import type { PresentationSpec } from '@contractspec/lib.contracts';
+import { StabilityEnum } from '@contractspec/lib.contracts';
+
+/**
+ * Main CRM dashboard presentation.
+ */
+export const CrmDashboardPresentation: PresentationSpec = {
+  meta: {
+    key: 'crm.dashboard',
+    version: 1,
+    title: 'CRM Dashboard',
+    description:
+      'Main CRM dashboard with pipeline overview, deal stats, and activities',
+    domain: 'crm-pipeline',
+    owners: ['@crm-team'],
+    tags: ['dashboard', 'overview'],
+    stability: StabilityEnum.Experimental,
+    goal: 'Provide a high-level overview of CRM performance and active deals.',
+    context: 'The landing page for CRM users.',
+  },
+  source: {
+    type: 'component',
+    framework: 'react',
+    componentKey: 'CrmDashboard',
+  },
+  targets: ['react', 'markdown'],
+  policy: {
+    flags: ['crm.enabled'],
+  },
+};
+
+/**
+ * Pipeline metrics presentation.
+ */
+export const PipelineMetricsPresentation: PresentationSpec = {
+  meta: {
+    key: 'crm.pipeline.metrics',
+    version: 1,
+    title: 'Pipeline Metrics',
+    description: 'Pipeline metrics and forecasting view',
+    domain: 'crm-pipeline',
+    owners: ['@crm-team'],
+    tags: ['pipeline', 'metrics', 'forecast'],
+    stability: StabilityEnum.Experimental,
+    goal: 'Track pipeline health and sales forecasts.',
+    context: 'Data-intensive widget for sales managers.',
+  },
+  source: {
+    type: 'component',
+    framework: 'react',
+    componentKey: 'PipelineMetricsView',
+  },
+  targets: ['react', 'markdown'],
+  policy: {
+    flags: ['crm.metrics.enabled'],
+  },
+};

package/src/presentations/index.ts

@@ -0,0 +1,2 @@
+export * from './dashboard.presentation';
+export * from './pipeline.presentation';

package/src/presentations/pipeline.presentation.ts

@@ -0,0 +1,118 @@
+/**
+ * Pipeline Presentation Descriptors
+ */
+import type { PresentationSpec } from '@contractspec/lib.contracts';
+import { StabilityEnum } from '@contractspec/lib.contracts';
+import { DealModel } from '../deal/deal.schema';
+
+/**
+ * Kanban board presentation for the sales pipeline.
+ */
+export const PipelineKanbanPresentation: PresentationSpec = {
+  meta: {
+    key: 'crm.pipeline.kanban',
+    version: 1,
+    title: 'Pipeline Kanban',
+    description: 'Kanban board view of deals organized by stage',
+    domain: 'crm-pipeline',
+    owners: ['@crm-team'],
+    tags: ['pipeline', 'kanban', 'deals'],
+    stability: StabilityEnum.Experimental,
+    goal: 'Visualize the sales pipeline status and deal distribution across stages.',
+    context: 'Used in the sales dashboard and management reports.',
+  },
+  source: {
+    type: 'component',
+    framework: 'react',
+    componentKey: 'PipelineKanbanView',
+    props: DealModel,
+  },
+  targets: ['react', 'markdown'],
+  policy: {
+    flags: ['crm.pipeline.enabled'],
+  },
+};
+
+/**
+ * List view of deals with filtering.
+ */
+export const DealListPresentation: PresentationSpec = {
+  meta: {
+    key: 'crm.deal.list',
+    version: 1,
+    title: 'Deal List',
+    description: 'List view of deals with value, status, and owner info',
+    domain: 'crm-pipeline',
+    owners: ['@crm-team'],
+    tags: ['deal', 'list'],
+    stability: StabilityEnum.Experimental,
+    goal: 'Search, filter, and review deal lists.',
+    context: 'Standard view for deal management and bulk actions.',
+  },
+  source: {
+    type: 'component',
+    framework: 'react',
+    componentKey: 'DealListView',
+    props: DealModel,
+  },
+  targets: ['react', 'markdown', 'application/json'],
+  policy: {
+    flags: ['crm.deals.enabled'],
+  },
+};
+
+/**
+ * Deal detail presentation.
+ */
+export const DealDetailPresentation: PresentationSpec = {
+  meta: {
+    key: 'crm.deal.detail',
+    version: 1,
+    title: 'Deal Details',
+    description:
+      'Detailed view of a deal with activities, contacts, and history',
+    domain: 'crm-pipeline',
+    owners: ['@crm-team'],
+    tags: ['deal', 'detail'],
+    stability: StabilityEnum.Experimental,
+    goal: 'Deep dive into deal details and historical activities.',
+    context: 'The main workspace for managing a single deal execution.',
+  },
+  source: {
+    type: 'component',
+    framework: 'react',
+    componentKey: 'DealDetailView',
+  },
+  targets: ['react', 'markdown'],
+  policy: {
+    flags: ['crm.deals.enabled'],
+  },
+};
+
+/**
+ * Deal card for kanban board.
+ */
+export const DealCardPresentation: PresentationSpec = {
+  meta: {
+    key: 'crm.deal.card',
+    version: 1,
+    title: 'Deal Card',
+    description: 'Compact deal card for kanban board display',
+    domain: 'crm-pipeline',
+    owners: ['@crm-team'],
+    tags: ['deal', 'card', 'kanban'],
+    stability: StabilityEnum.Experimental,
+    goal: 'Provide a quick overview of deal status in the pipeline view.',
+    context: 'Condensed representation used within the Pipeline Kanban board.',
+  },
+  source: {
+    type: 'component',
+    framework: 'react',
+    componentKey: 'DealCard',
+    props: DealModel,
+  },
+  targets: ['react'],
+  policy: {
+    flags: ['crm.deals.enabled'],
+  },
+};

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "@contractspec/tool.typescript/react-library.json",
+  "include": ["src"],
+  "exclude": ["node_modules"],
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  }
+}
+