@epicdm/flowstate-templates 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,260 @@
+/** A complete template bundle for one business type */
+interface TemplateBundle {
+    id: string;
+    label: string;
+    description: string;
+    category: BusinessCategory;
+    bizplan: BizplanTemplateData;
+    marketing: MarketingTemplateData;
+    product: ProductTemplateData;
+    content: ContentTemplateData;
+    operations: OperationsTemplateData;
+    agents: AgentOrgTemplate;
+    finance?: FinanceTemplateData;
+}
+type BusinessCategory = 'saas-product' | 'professional-services' | 'ecommerce-retail' | 'content-creator' | 'agency';
+/** Template data for a business plan, matching BusinessPlanModel domain fields */
+interface BizplanTemplateData {
+    planType: 'startup' | 'growth' | 'pivot' | 'annual';
+    missionStatement: string;
+    visionStatement: string;
+    targetMarket: string;
+    problemStatement: string;
+    solutionSummary: string;
+    revenueModel: string;
+    competitiveAdvantage: string;
+}
+/** Template data for the marketing domain: offers, campaigns, audiences, lead magnets */
+interface MarketingTemplateData {
+    offers: OfferTemplate[];
+    campaigns: CampaignTemplate[];
+    audiences: AudienceTemplate[];
+    leadMagnets: LeadMagnetTemplate[];
+}
+/** Template for an offer, aligned with OfferModel */
+interface OfferTemplate {
+    name: string;
+    description: string;
+    type: 'core' | 'tripwire' | 'upsell' | 'downsell' | 'lead_magnet';
+    targetAvatar: string;
+    valueStack: Array<{
+        name: string;
+        value: number;
+        description: string;
+    }>;
+    bonuses: Array<{
+        name: string;
+        value: number;
+        type: string;
+        description: string;
+    }>;
+    price: number;
+    compareAtPrice: number;
+    guaranteeType: 'unconditional' | 'conditional' | 'anti' | 'performance';
+    guaranteeTerms: string;
+    scarcityType: 'quantity' | 'time' | 'cohort';
+    scarcityDetails: string;
+    urgencyType: 'deadline' | 'seasonal' | 'pricing' | 'exploding';
+    urgencyDetails: string;
+    headline: string;
+}
+/** Template for a campaign, aligned with CampaignModel */
+interface CampaignTemplate {
+    name: string;
+    description: string;
+    type: 'content' | 'email' | 'social' | 'paid_ads' | 'outreach' | 'launch' | 'partnership' | 'event';
+    channel: string;
+    goalType: 'leads' | 'sales' | 'awareness' | 'engagement';
+    goalTarget: number;
+    budget: number;
+}
+/** Template for an audience segment, aligned with AudienceModel */
+interface AudienceTemplate {
+    name: string;
+    description: string;
+    type: 'segment' | 'persona' | 'list';
+    source: 'organic' | 'paid' | 'referral' | 'import';
+    criteria: string;
+}
+/** Template for a lead magnet, aligned with LeadMagnetModel */
+interface LeadMagnetTemplate {
+    name: string;
+    description: string;
+    type: 'problem_revealer' | 'sample_trial' | 'one_step' | 'software_tool' | 'checklist' | 'guide';
+    deliveryMethod: 'pdf' | 'video' | 'email_course' | 'tool' | 'service';
+}
+/** Template data for the product domain: product definition, goals, initiatives */
+interface ProductTemplateData {
+    product: ProductTemplate;
+    goals: GoalTemplate[];
+    initiatives: InitiativeTemplate[];
+}
+/** Template for a product, aligned with ProductModel */
+interface ProductTemplate {
+    type: 'software' | 'physical' | 'service' | 'content' | 'custom';
+    currentPhase: string;
+    problemStatement: string;
+    valueProposition: string;
+    targetMarket: string[];
+    customerPersona: string;
+    competitiveLandscape: string;
+    kpis: Array<{
+        name: string;
+        target: number;
+        unit: string;
+    }>;
+}
+/** Template for a goal, aligned with GoalModel */
+interface GoalTemplate {
+    name: string;
+    description: string;
+    category: 'Revenue' | 'Growth' | 'Quality' | 'Efficiency' | 'Custom';
+    metrics: Array<{
+        name: string;
+        type: string;
+        targetValue: number;
+        unit: string;
+    }>;
+}
+/** Template for an initiative, aligned with InitiativeModel */
+interface InitiativeTemplate {
+    name: string;
+    description: string;
+    quarter: string;
+    priority: 'High' | 'Medium' | 'Low';
+}
+/** Template data for the content domain: pillars, types, cadence, channels */
+interface ContentTemplateData {
+    pillars: ContentPillarTemplate[];
+    contentTypes: string[];
+    publishingCadence: string;
+    channels: string[];
+}
+/** Template for a content pillar, aligned with ContentPillarModel */
+interface ContentPillarTemplate {
+    name: string;
+    description: string;
+    topics: string[];
+}
+/** Template data for the operations domain: process definitions */
+interface OperationsTemplateData {
+    processes: ProcessTemplate[];
+}
+/** Template for a process, aligned with ProcessModel */
+interface ProcessTemplate {
+    name: string;
+    title: string;
+    description: string;
+    category: string;
+    steps: Array<{
+        name: string;
+        title: string;
+        stepType: string;
+        description: string;
+    }>;
+}
+/** Template data for the agent org chart: roles, reporting, RACI */
+interface AgentOrgTemplate {
+    orgName: string;
+    orgSize: string;
+    roles: OrgRoleTemplate[];
+    reportingStructure: ReportingLine[];
+    raciMatrix: RaciEntry[];
+}
+/** Template for an organizational role */
+interface OrgRoleTemplate {
+    id: string;
+    title: string;
+    level: number;
+    department: string;
+    description: string;
+    responsibilities: string[];
+}
+/** Template for a reporting line in the org chart */
+interface ReportingLine {
+    roleId: string;
+    reportsTo: string | null;
+}
+/** Template for a RACI matrix entry */
+interface RaciEntry {
+    area: string;
+    roleId: string;
+    assignment: 'R' | 'A' | 'C' | 'I';
+}
+/** Template data for the finance domain: chart of accounts, journal entries, budgets */
+interface FinanceTemplateData {
+    chartOfAccounts: AccountTemplate[];
+    fiscalPeriods: FiscalPeriodTemplate[];
+    budgetItems: BudgetItemTemplate[];
+    journalEntries: JournalEntryTemplate[];
+    invoices: InvoiceTemplate[];
+    vendorBills: VendorBillTemplate[];
+}
+/** Template for a chart of accounts entry */
+interface AccountTemplate {
+    accountNumber: string;
+    name: string;
+    accountType: 'asset' | 'liability' | 'equity' | 'revenue' | 'cogs' | 'expense' | 'other_income' | 'other_expense';
+    accountSubType?: string;
+    normalBalance: 'debit' | 'credit';
+    parentAccountRef?: string;
+    openingBalance?: number;
+    isActive?: boolean;
+    isBankAccount?: boolean;
+}
+/** Template for a fiscal period */
+interface FiscalPeriodTemplate {
+    name: string;
+    periodType: 'monthly' | 'quarterly';
+    startDayOffset: number;
+    endDayOffset: number;
+    periodStatus: 'open' | 'closed';
+}
+/** Template for a journal entry with inline lines */
+interface JournalEntryTemplate {
+    entryNumber: string;
+    dayOffset: number;
+    memo: string;
+    source: 'manual' | 'invoice_created' | 'invoice_paid' | 'bill_created' | 'bill_paid' | 'opening_balance';
+    entryStatus: 'posted' | 'draft';
+    lines: JournalLineTemplate[];
+}
+/** Template for a journal entry line */
+interface JournalLineTemplate {
+    accountRef: string;
+    debit: number;
+    credit: number;
+    memo?: string;
+}
+/** Template for a budget item */
+interface BudgetItemTemplate {
+    accountRef: string;
+    periodRef: string;
+    amount: number;
+    budgetType: 'revenue' | 'expense';
+}
+/** Template for an invoice (AR) */
+interface InvoiceTemplate {
+    dayOffset: number;
+    dueDayOffset: number;
+    clientName: string;
+    total: number;
+    amountPaid: number;
+    invoiceStatus: 'draft' | 'sent' | 'partial' | 'paid' | 'overdue' | 'voided';
+}
+/** Template for a vendor bill (AP) */
+interface VendorBillTemplate {
+    dayOffset: number;
+    dueDayOffset: number;
+    vendorName: string;
+    total: number;
+    amountPaid: number;
+    billStatus: 'draft' | 'received' | 'partial' | 'paid' | 'overdue';
+}
+
+declare function registerBundle(bundle: TemplateBundle): void;
+declare function listTemplates(): TemplateBundle[];
+declare function getTemplate(id: BusinessCategory | string): TemplateBundle | undefined;
+declare function getTemplateDomain<K extends keyof TemplateBundle>(id: BusinessCategory | string, domain: K): TemplateBundle[K] | undefined;
+
+export { type AccountTemplate, type AgentOrgTemplate, type AudienceTemplate, type BizplanTemplateData, type BudgetItemTemplate, type BusinessCategory, type CampaignTemplate, type ContentPillarTemplate, type ContentTemplateData, type FinanceTemplateData, type FiscalPeriodTemplate, type GoalTemplate, type InitiativeTemplate, type InvoiceTemplate, type JournalEntryTemplate, type JournalLineTemplate, type LeadMagnetTemplate, type MarketingTemplateData, type OfferTemplate, type OperationsTemplateData, type OrgRoleTemplate, type ProcessTemplate, type ProductTemplate, type ProductTemplateData, type RaciEntry, type ReportingLine, type TemplateBundle, type VendorBillTemplate, getTemplate, getTemplateDomain, listTemplates, registerBundle };

package/dist/index.d.ts

@@ -0,0 +1,260 @@
+/** A complete template bundle for one business type */
+interface TemplateBundle {
+    id: string;
+    label: string;
+    description: string;
+    category: BusinessCategory;
+    bizplan: BizplanTemplateData;
+    marketing: MarketingTemplateData;
+    product: ProductTemplateData;
+    content: ContentTemplateData;
+    operations: OperationsTemplateData;
+    agents: AgentOrgTemplate;
+    finance?: FinanceTemplateData;
+}
+type BusinessCategory = 'saas-product' | 'professional-services' | 'ecommerce-retail' | 'content-creator' | 'agency';
+/** Template data for a business plan, matching BusinessPlanModel domain fields */
+interface BizplanTemplateData {
+    planType: 'startup' | 'growth' | 'pivot' | 'annual';
+    missionStatement: string;
+    visionStatement: string;
+    targetMarket: string;
+    problemStatement: string;
+    solutionSummary: string;
+    revenueModel: string;
+    competitiveAdvantage: string;
+}
+/** Template data for the marketing domain: offers, campaigns, audiences, lead magnets */
+interface MarketingTemplateData {
+    offers: OfferTemplate[];
+    campaigns: CampaignTemplate[];
+    audiences: AudienceTemplate[];
+    leadMagnets: LeadMagnetTemplate[];
+}
+/** Template for an offer, aligned with OfferModel */
+interface OfferTemplate {
+    name: string;
+    description: string;
+    type: 'core' | 'tripwire' | 'upsell' | 'downsell' | 'lead_magnet';
+    targetAvatar: string;
+    valueStack: Array<{
+        name: string;
+        value: number;
+        description: string;
+    }>;
+    bonuses: Array<{
+        name: string;
+        value: number;
+        type: string;
+        description: string;
+    }>;
+    price: number;
+    compareAtPrice: number;
+    guaranteeType: 'unconditional' | 'conditional' | 'anti' | 'performance';
+    guaranteeTerms: string;
+    scarcityType: 'quantity' | 'time' | 'cohort';
+    scarcityDetails: string;
+    urgencyType: 'deadline' | 'seasonal' | 'pricing' | 'exploding';
+    urgencyDetails: string;
+    headline: string;
+}
+/** Template for a campaign, aligned with CampaignModel */
+interface CampaignTemplate {
+    name: string;
+    description: string;
+    type: 'content' | 'email' | 'social' | 'paid_ads' | 'outreach' | 'launch' | 'partnership' | 'event';
+    channel: string;
+    goalType: 'leads' | 'sales' | 'awareness' | 'engagement';
+    goalTarget: number;
+    budget: number;
+}
+/** Template for an audience segment, aligned with AudienceModel */
+interface AudienceTemplate {
+    name: string;
+    description: string;
+    type: 'segment' | 'persona' | 'list';
+    source: 'organic' | 'paid' | 'referral' | 'import';
+    criteria: string;
+}
+/** Template for a lead magnet, aligned with LeadMagnetModel */
+interface LeadMagnetTemplate {
+    name: string;
+    description: string;
+    type: 'problem_revealer' | 'sample_trial' | 'one_step' | 'software_tool' | 'checklist' | 'guide';
+    deliveryMethod: 'pdf' | 'video' | 'email_course' | 'tool' | 'service';
+}
+/** Template data for the product domain: product definition, goals, initiatives */
+interface ProductTemplateData {
+    product: ProductTemplate;
+    goals: GoalTemplate[];
+    initiatives: InitiativeTemplate[];
+}
+/** Template for a product, aligned with ProductModel */
+interface ProductTemplate {
+    type: 'software' | 'physical' | 'service' | 'content' | 'custom';
+    currentPhase: string;
+    problemStatement: string;
+    valueProposition: string;
+    targetMarket: string[];
+    customerPersona: string;
+    competitiveLandscape: string;
+    kpis: Array<{
+        name: string;
+        target: number;
+        unit: string;
+    }>;
+}
+/** Template for a goal, aligned with GoalModel */
+interface GoalTemplate {
+    name: string;
+    description: string;
+    category: 'Revenue' | 'Growth' | 'Quality' | 'Efficiency' | 'Custom';
+    metrics: Array<{
+        name: string;
+        type: string;
+        targetValue: number;
+        unit: string;
+    }>;
+}
+/** Template for an initiative, aligned with InitiativeModel */
+interface InitiativeTemplate {
+    name: string;
+    description: string;
+    quarter: string;
+    priority: 'High' | 'Medium' | 'Low';
+}
+/** Template data for the content domain: pillars, types, cadence, channels */
+interface ContentTemplateData {
+    pillars: ContentPillarTemplate[];
+    contentTypes: string[];
+    publishingCadence: string;
+    channels: string[];
+}
+/** Template for a content pillar, aligned with ContentPillarModel */
+interface ContentPillarTemplate {
+    name: string;
+    description: string;
+    topics: string[];
+}
+/** Template data for the operations domain: process definitions */
+interface OperationsTemplateData {
+    processes: ProcessTemplate[];
+}
+/** Template for a process, aligned with ProcessModel */
+interface ProcessTemplate {
+    name: string;
+    title: string;
+    description: string;
+    category: string;
+    steps: Array<{
+        name: string;
+        title: string;
+        stepType: string;
+        description: string;
+    }>;
+}
+/** Template data for the agent org chart: roles, reporting, RACI */
+interface AgentOrgTemplate {
+    orgName: string;
+    orgSize: string;
+    roles: OrgRoleTemplate[];
+    reportingStructure: ReportingLine[];
+    raciMatrix: RaciEntry[];
+}
+/** Template for an organizational role */
+interface OrgRoleTemplate {
+    id: string;
+    title: string;
+    level: number;
+    department: string;
+    description: string;
+    responsibilities: string[];
+}
+/** Template for a reporting line in the org chart */
+interface ReportingLine {
+    roleId: string;
+    reportsTo: string | null;
+}
+/** Template for a RACI matrix entry */
+interface RaciEntry {
+    area: string;
+    roleId: string;
+    assignment: 'R' | 'A' | 'C' | 'I';
+}
+/** Template data for the finance domain: chart of accounts, journal entries, budgets */
+interface FinanceTemplateData {
+    chartOfAccounts: AccountTemplate[];
+    fiscalPeriods: FiscalPeriodTemplate[];
+    budgetItems: BudgetItemTemplate[];
+    journalEntries: JournalEntryTemplate[];
+    invoices: InvoiceTemplate[];
+    vendorBills: VendorBillTemplate[];
+}
+/** Template for a chart of accounts entry */
+interface AccountTemplate {
+    accountNumber: string;
+    name: string;
+    accountType: 'asset' | 'liability' | 'equity' | 'revenue' | 'cogs' | 'expense' | 'other_income' | 'other_expense';
+    accountSubType?: string;
+    normalBalance: 'debit' | 'credit';
+    parentAccountRef?: string;
+    openingBalance?: number;
+    isActive?: boolean;
+    isBankAccount?: boolean;
+}
+/** Template for a fiscal period */
+interface FiscalPeriodTemplate {
+    name: string;
+    periodType: 'monthly' | 'quarterly';
+    startDayOffset: number;
+    endDayOffset: number;
+    periodStatus: 'open' | 'closed';
+}
+/** Template for a journal entry with inline lines */
+interface JournalEntryTemplate {
+    entryNumber: string;
+    dayOffset: number;
+    memo: string;
+    source: 'manual' | 'invoice_created' | 'invoice_paid' | 'bill_created' | 'bill_paid' | 'opening_balance';
+    entryStatus: 'posted' | 'draft';
+    lines: JournalLineTemplate[];
+}
+/** Template for a journal entry line */
+interface JournalLineTemplate {
+    accountRef: string;
+    debit: number;
+    credit: number;
+    memo?: string;
+}
+/** Template for a budget item */
+interface BudgetItemTemplate {
+    accountRef: string;
+    periodRef: string;
+    amount: number;
+    budgetType: 'revenue' | 'expense';
+}
+/** Template for an invoice (AR) */
+interface InvoiceTemplate {
+    dayOffset: number;
+    dueDayOffset: number;
+    clientName: string;
+    total: number;
+    amountPaid: number;
+    invoiceStatus: 'draft' | 'sent' | 'partial' | 'paid' | 'overdue' | 'voided';
+}
+/** Template for a vendor bill (AP) */
+interface VendorBillTemplate {
+    dayOffset: number;
+    dueDayOffset: number;
+    vendorName: string;
+    total: number;
+    amountPaid: number;
+    billStatus: 'draft' | 'received' | 'partial' | 'paid' | 'overdue';
+}
+
+declare function registerBundle(bundle: TemplateBundle): void;
+declare function listTemplates(): TemplateBundle[];
+declare function getTemplate(id: BusinessCategory | string): TemplateBundle | undefined;
+declare function getTemplateDomain<K extends keyof TemplateBundle>(id: BusinessCategory | string, domain: K): TemplateBundle[K] | undefined;
+
+export { type AccountTemplate, type AgentOrgTemplate, type AudienceTemplate, type BizplanTemplateData, type BudgetItemTemplate, type BusinessCategory, type CampaignTemplate, type ContentPillarTemplate, type ContentTemplateData, type FinanceTemplateData, type FiscalPeriodTemplate, type GoalTemplate, type InitiativeTemplate, type InvoiceTemplate, type JournalEntryTemplate, type JournalLineTemplate, type LeadMagnetTemplate, type MarketingTemplateData, type OfferTemplate, type OperationsTemplateData, type OrgRoleTemplate, type ProcessTemplate, type ProductTemplate, type ProductTemplateData, type RaciEntry, type ReportingLine, type TemplateBundle, type VendorBillTemplate, getTemplate, getTemplateDomain, listTemplates, registerBundle };