@odla-ai/chapter 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,198 @@
+import { CrmConfig, Crm } from '@odla-ai/crm';
+
+/** Which feature profile a site runs. `chapter` is the full public member site
+ * (join, Stripe membership, booking, member area, admin, CRM); `hub` is
+ * admin-only and CRM-focused (a directory/registry over the same CRM). */
+type ChapterMode = "chapter" | "hub";
+/** The scalar kinds an odla-db attribute can hold. */
+type AttrType = "string" | "number" | "boolean" | "json";
+/** One odla-db attribute: its type and index/uniqueness/optionality flags. */
+interface Attr {
+    type: AttrType;
+    unique: boolean;
+    indexed: boolean;
+    optional: boolean;
+}
+/** One odla-db namespace: its attribute map. */
+interface Entity {
+    attrs: Record<string, Attr>;
+}
+/** A serialized odla-db schema fragment (namespaces + links). */
+interface DbSchema {
+    entities: Record<string, Entity>;
+    links: Record<string, unknown>;
+}
+/** Per-namespace CEL rule strings (deny-all is `"false"` for each action). */
+interface Rule {
+    view: string;
+    create: string;
+    update: string;
+    delete: string;
+}
+/** Namespace → rule set. */
+type DbRules = Record<string, Rule>;
+/** Brand tokens that theme the site: palette, fonts, wordmark, nav, logos. */
+interface ChapterBrand {
+    /** Palette overrides written into styles.css :root (e.g. `{ moss: "#2F3E34" }`
+     * or `--ui-*` token names). */
+    palette?: Record<string, string>;
+    fonts?: {
+        display?: string;
+        body?: string;
+        numeral?: string;
+    };
+    wordmark?: string;
+    tagline?: string;
+    /** Header/footer nav sections for the web-component chrome: label → entries. */
+    nav?: Record<string, ReadonlyArray<{
+        label: string;
+        href: string;
+    }>>;
+    logos?: string;
+}
+/** Membership pricing for the group row (chapter mode). */
+interface ChapterPrices {
+    standardCents: number;
+    foundingDiscountCents?: number;
+    /** ISO currency, default "usd". */
+    currency?: string;
+    /** Billing interval, default "year". */
+    interval?: "year" | "month";
+}
+/** Membership policy + compliance copy stored on the group row. */
+interface ChapterPolicy {
+    disclaimerText?: string;
+    refundPolicyText?: string;
+    trustCopy?: string;
+    commitmentText?: string;
+    normsText?: string;
+}
+/** One owner-editable transactional email template. */
+interface EmailTemplate {
+    subject: string;
+    text: string;
+    enabled?: boolean;
+}
+/** Notification/reply/debug addresses + operational email templates. */
+interface ChapterEmails {
+    notificationEmail: string;
+    replyTo?: string;
+    debugEmail?: string;
+    /** Operational lifecycle templates: adminNotification / paymentConfirmation /
+     * prepEmail / onboardingInvite, each `{ subject, text, enabled? }`. */
+    templates?: Record<string, EmailTemplate>;
+}
+/** Booking rules for the intro-call scheduler (stored as schedulingJson). */
+interface ChapterScheduling {
+    slotMinutes?: number;
+    days?: readonly number[];
+    startHour?: number;
+    endHour?: number;
+    timezone?: string;
+    minNoticeHours?: number;
+    windowDays?: number;
+    summaryTemplate?: string;
+}
+/** The `defineChapter()` config a site fills in. */
+interface ChapterConfig {
+    /** Slug: app id, tenant, group id, worker name. `[a-z0-9-]`. */
+    id: string;
+    name: string;
+    url?: string;
+    /** Default `"chapter"`. */
+    mode?: ChapterMode;
+    /** A `defineCrm()` config or a resolved `Crm`. Omit for the per-mode default. */
+    crm?: CrmConfig | Crm;
+    brand?: ChapterBrand;
+    thesis?: unknown;
+    /** Required in `chapter` mode. */
+    prices?: ChapterPrices;
+    policy?: ChapterPolicy;
+    /** `notificationEmail` required in `chapter` mode. */
+    emails?: ChapterEmails;
+    scheduling?: ChapterScheduling;
+    /** odla services (db implied). Default `["db","calendar","o11y"]`. */
+    services?: readonly string[];
+}
+/** The resolved engine `defineChapter()` returns. */
+interface Chapter {
+    config: ChapterConfig;
+    id: string;
+    name: string;
+    url?: string;
+    mode: ChapterMode;
+    /** Resolved CRM engine (from `defineCrm`). */
+    crm: Crm;
+    /** The chapter's own odla-db namespaces (mode-dependent; excludes `crm_*`). */
+    schema: DbSchema;
+    rules: DbRules;
+    services: readonly string[];
+    /** The seed `groups` row derived from config (chapter mode), else `null`. */
+    groupSeed(): Record<string, unknown> | null;
+}
+
+/**
+ * Validate a chapter/hub config and resolve its engine — the CRM, the chapter's
+ * odla-db schema/rules, and the seed groups row. Throws at import on a bad
+ * config (bad slug, wrong mode, missing chapter-mode prices/emails), never at
+ * request time.
+ */
+declare function defineChapter(config: ChapterConfig): Chapter;
+
+/** Options for {@link createChapterIntegration}. */
+interface ChapterIntegrationOptions {
+    /** CRM route mount point. Default "/api/crm". */
+    basePath?: string;
+    /** Seed timestamp override for reproducible builds/tests. */
+    now?: number;
+}
+interface IntegrationSeed {
+    id: string;
+    ns: string;
+    key: {
+        attr: string;
+        value: string;
+    };
+    attrs: Record<string, unknown>;
+}
+/** Structural match for the CLI's `OdlaIntegration`. */
+interface ChapterIntegrationDescriptor {
+    id: string;
+    title: string;
+    npm: string;
+    schema: {
+        entities: Record<string, unknown>;
+        links: Record<string, unknown>;
+    };
+    rules: Record<string, unknown>;
+    seeds: IntegrationSeed[];
+    probes: Array<{
+        path: string;
+        expectedStatus: number;
+    }>;
+}
+/**
+ * Build the one CLI-consumable integration for a chapter/hub: the crm_*
+ * namespaces + crm_config seed + route probe, merged with the chapter's own
+ * namespaces and a guarded `groups`-row seed. Drop it in odla.config.mjs's
+ * `integrations` array.
+ */
+declare function createChapterIntegration(chapter: Chapter, options?: ChapterIntegrationOptions): ChapterIntegrationDescriptor;
+
+/** The chapter's own schema + deny-all rules for a mode. `hub` needs only the
+ * `admins` allowlist (its records live in `crm_*`); `chapter` adds the
+ * operational membership tables. */
+declare function chapterDb(mode: ChapterMode): {
+    schema: DbSchema;
+    rules: DbRules;
+};
+
+/** The per-mode default CRM config: `chapter` = a person lead pipeline;
+ * `hub` = people + businesses with a works_at relation. */
+declare function defaultCrm(mode: ChapterMode): CrmConfig;
+
+/** The `groups` row (attrs) for `chapter` mode. Missing config falls back to
+ * empty copy / defaults, so a minimal config still provisions cleanly. */
+declare function buildGroupSeed(config: ChapterConfig): Record<string, unknown>;
+
+export { type Attr, type AttrType, type Chapter, type ChapterBrand, type ChapterConfig, type ChapterEmails, type ChapterIntegrationDescriptor, type ChapterIntegrationOptions, type ChapterMode, type ChapterPolicy, type ChapterPrices, type ChapterScheduling, type DbRules, type DbSchema, type EmailTemplate, type Entity, type Rule, buildGroupSeed, chapterDb, createChapterIntegration, defaultCrm, defineChapter };

package/dist/index.d.ts

@@ -0,0 +1,198 @@
+import { CrmConfig, Crm } from '@odla-ai/crm';
+
+/** Which feature profile a site runs. `chapter` is the full public member site
+ * (join, Stripe membership, booking, member area, admin, CRM); `hub` is
+ * admin-only and CRM-focused (a directory/registry over the same CRM). */
+type ChapterMode = "chapter" | "hub";
+/** The scalar kinds an odla-db attribute can hold. */
+type AttrType = "string" | "number" | "boolean" | "json";
+/** One odla-db attribute: its type and index/uniqueness/optionality flags. */
+interface Attr {
+    type: AttrType;
+    unique: boolean;
+    indexed: boolean;
+    optional: boolean;
+}
+/** One odla-db namespace: its attribute map. */
+interface Entity {
+    attrs: Record<string, Attr>;
+}
+/** A serialized odla-db schema fragment (namespaces + links). */
+interface DbSchema {
+    entities: Record<string, Entity>;
+    links: Record<string, unknown>;
+}
+/** Per-namespace CEL rule strings (deny-all is `"false"` for each action). */
+interface Rule {
+    view: string;
+    create: string;
+    update: string;
+    delete: string;
+}
+/** Namespace → rule set. */
+type DbRules = Record<string, Rule>;
+/** Brand tokens that theme the site: palette, fonts, wordmark, nav, logos. */
+interface ChapterBrand {
+    /** Palette overrides written into styles.css :root (e.g. `{ moss: "#2F3E34" }`
+     * or `--ui-*` token names). */
+    palette?: Record<string, string>;
+    fonts?: {
+        display?: string;
+        body?: string;
+        numeral?: string;
+    };
+    wordmark?: string;
+    tagline?: string;
+    /** Header/footer nav sections for the web-component chrome: label → entries. */
+    nav?: Record<string, ReadonlyArray<{
+        label: string;
+        href: string;
+    }>>;
+    logos?: string;
+}
+/** Membership pricing for the group row (chapter mode). */
+interface ChapterPrices {
+    standardCents: number;
+    foundingDiscountCents?: number;
+    /** ISO currency, default "usd". */
+    currency?: string;
+    /** Billing interval, default "year". */
+    interval?: "year" | "month";
+}
+/** Membership policy + compliance copy stored on the group row. */
+interface ChapterPolicy {
+    disclaimerText?: string;
+    refundPolicyText?: string;
+    trustCopy?: string;
+    commitmentText?: string;
+    normsText?: string;
+}
+/** One owner-editable transactional email template. */
+interface EmailTemplate {
+    subject: string;
+    text: string;
+    enabled?: boolean;
+}
+/** Notification/reply/debug addresses + operational email templates. */
+interface ChapterEmails {
+    notificationEmail: string;
+    replyTo?: string;
+    debugEmail?: string;
+    /** Operational lifecycle templates: adminNotification / paymentConfirmation /
+     * prepEmail / onboardingInvite, each `{ subject, text, enabled? }`. */
+    templates?: Record<string, EmailTemplate>;
+}
+/** Booking rules for the intro-call scheduler (stored as schedulingJson). */
+interface ChapterScheduling {
+    slotMinutes?: number;
+    days?: readonly number[];
+    startHour?: number;
+    endHour?: number;
+    timezone?: string;
+    minNoticeHours?: number;
+    windowDays?: number;
+    summaryTemplate?: string;
+}
+/** The `defineChapter()` config a site fills in. */
+interface ChapterConfig {
+    /** Slug: app id, tenant, group id, worker name. `[a-z0-9-]`. */
+    id: string;
+    name: string;
+    url?: string;
+    /** Default `"chapter"`. */
+    mode?: ChapterMode;
+    /** A `defineCrm()` config or a resolved `Crm`. Omit for the per-mode default. */
+    crm?: CrmConfig | Crm;
+    brand?: ChapterBrand;
+    thesis?: unknown;
+    /** Required in `chapter` mode. */
+    prices?: ChapterPrices;
+    policy?: ChapterPolicy;
+    /** `notificationEmail` required in `chapter` mode. */
+    emails?: ChapterEmails;
+    scheduling?: ChapterScheduling;
+    /** odla services (db implied). Default `["db","calendar","o11y"]`. */
+    services?: readonly string[];
+}
+/** The resolved engine `defineChapter()` returns. */
+interface Chapter {
+    config: ChapterConfig;
+    id: string;
+    name: string;
+    url?: string;
+    mode: ChapterMode;
+    /** Resolved CRM engine (from `defineCrm`). */
+    crm: Crm;
+    /** The chapter's own odla-db namespaces (mode-dependent; excludes `crm_*`). */
+    schema: DbSchema;
+    rules: DbRules;
+    services: readonly string[];
+    /** The seed `groups` row derived from config (chapter mode), else `null`. */
+    groupSeed(): Record<string, unknown> | null;
+}
+
+/**
+ * Validate a chapter/hub config and resolve its engine — the CRM, the chapter's
+ * odla-db schema/rules, and the seed groups row. Throws at import on a bad
+ * config (bad slug, wrong mode, missing chapter-mode prices/emails), never at
+ * request time.
+ */
+declare function defineChapter(config: ChapterConfig): Chapter;
+
+/** Options for {@link createChapterIntegration}. */
+interface ChapterIntegrationOptions {
+    /** CRM route mount point. Default "/api/crm". */
+    basePath?: string;
+    /** Seed timestamp override for reproducible builds/tests. */
+    now?: number;
+}
+interface IntegrationSeed {
+    id: string;
+    ns: string;
+    key: {
+        attr: string;
+        value: string;
+    };
+    attrs: Record<string, unknown>;
+}
+/** Structural match for the CLI's `OdlaIntegration`. */
+interface ChapterIntegrationDescriptor {
+    id: string;
+    title: string;
+    npm: string;
+    schema: {
+        entities: Record<string, unknown>;
+        links: Record<string, unknown>;
+    };
+    rules: Record<string, unknown>;
+    seeds: IntegrationSeed[];
+    probes: Array<{
+        path: string;
+        expectedStatus: number;
+    }>;
+}
+/**
+ * Build the one CLI-consumable integration for a chapter/hub: the crm_*
+ * namespaces + crm_config seed + route probe, merged with the chapter's own
+ * namespaces and a guarded `groups`-row seed. Drop it in odla.config.mjs's
+ * `integrations` array.
+ */
+declare function createChapterIntegration(chapter: Chapter, options?: ChapterIntegrationOptions): ChapterIntegrationDescriptor;
+
+/** The chapter's own schema + deny-all rules for a mode. `hub` needs only the
+ * `admins` allowlist (its records live in `crm_*`); `chapter` adds the
+ * operational membership tables. */
+declare function chapterDb(mode: ChapterMode): {
+    schema: DbSchema;
+    rules: DbRules;
+};
+
+/** The per-mode default CRM config: `chapter` = a person lead pipeline;
+ * `hub` = people + businesses with a works_at relation. */
+declare function defaultCrm(mode: ChapterMode): CrmConfig;
+
+/** The `groups` row (attrs) for `chapter` mode. Missing config falls back to
+ * empty copy / defaults, so a minimal config still provisions cleanly. */
+declare function buildGroupSeed(config: ChapterConfig): Record<string, unknown>;
+
+export { type Attr, type AttrType, type Chapter, type ChapterBrand, type ChapterConfig, type ChapterEmails, type ChapterIntegrationDescriptor, type ChapterIntegrationOptions, type ChapterMode, type ChapterPolicy, type ChapterPrices, type ChapterScheduling, type DbRules, type DbSchema, type EmailTemplate, type Entity, type Rule, buildGroupSeed, chapterDb, createChapterIntegration, defaultCrm, defineChapter };