@odla-ai/chapter 0.25.6 → 0.26.0

package/dist/index.d.ts

@@ -1,4 +1,10 @@
-import { CrmConfig, Crm, CrmRecord } from '@odla-ai/crm';
+import { CrmConfig, Crm, FieldDef, TypeSummary, CrmRecord } from '@odla-ai/crm';
+
+type TextFields$1<Key extends string> = {
+    [Field in Key]: string;
+};
+/** User-visible language for sharing, delivery state, and leader rollups. */
+type AdminNetworkCopy = TextFields$1<"title" | "allowlistDescription" | "sharing" | "shareWith" | "shared" | "shareFailed" | "deliveryFailed" | "loadingRollup" | "loadRollupFailed" | "overview" | "configuredFollowers" | "reachableFollowers" | "recordsAcrossFollowers" | "noFollowers" | "followers" | "available" | "unavailable" | "recordTotals" | "noRecordTotals">;
 
 /** Complete default language resolved beneath partial Chapter copy overrides. */
 declare const DEFAULT_CHAPTER_COPY: ChapterCopy;
@@ -10,12 +16,7 @@ declare function formatChapterCopy(template: string, values: Readonly<Record<str
 type TextFields<Key extends string> = {
     [Field in Key]: string;
 };
-/**
- * Complete user-visible language owned by Chapter's packaged surfaces.
- *
- * Copy is serializable text; use render slots when presentation needs markup and
- * `formatChapterCopy()` for typed placeholders.
- */
+/** Complete serializable language for Chapter surfaces; use render slots for markup and `formatChapterCopy()` for placeholders. */
 interface ChapterCopy {
     common: TextFields<"loading" | "saved" | "unknown">;
     join: {
@@ -41,7 +42,7 @@ interface ChapterCopy {
     admin: {
         auth: TextFields<"checking" | "notAuthorized" | "accountNotAuthorized" | "thisAccount" | "signOut" | "loading" | "signInNotConfigured" | "missingPublishableKey" | "noWorkspaces" | "signInTagline">;
         shell: TextFields<"adminRole" | "adminConsole" | "adminName" | "navigationLabel">;
-        workspaces: TextFields<"dashboard" | "overview" | "billing" | "people" | "settings" | "calendar" | "email" | "dashboardViewsLabel" | "settingsViewsLabel" | "collectionsLabel">;
+        workspaces: TextFields<"dashboard" | "overview" | "billing" | "people" | "portfolio" | "settings" | "calendar" | "email" | "chapters" | "formations" | "dealFlow" | "dashboardViewsLabel" | "settingsViewsLabel" | "collectionsLabel" | "portfolioViewsLabel">;
         dashboard: TextFields<"loading" | "loadFailed" | "upcomingCalls" | "callsNeedAttention" | "noUpcomingCalls" | "drift" | "open" | "meet" | "applications" | "newMembers" | "newMembersUnavailable" | "revenueAdded" | "revenue" | "revenueUnavailable" | "pipeline" | "pipelineLabel" | "thisWeek" | "noChange" | "activeMemberships" | "annualRunRate" | "testMode">;
         billing: TextFields<"loading" | "loadFailed" | "notConfigured" | "active" | "annualized" | "renewingSoon" | "pastDue" | "subscriptions" | "testMode" | "truncated" | "name" | "email" | "application" | "subscription" | "cancelling" | "amount" | "renews">;
         availability: TextFields<"loading" | "loadFailed" | "saved" | "title" | "days" | "startHour" | "endHour" | "slotMinutes" | "minNoticeHours" | "windowDays" | "timezone" | "summaryTemplate" | "save"> & {
@@ -49,7 +50,7 @@ interface ChapterCopy {
         };
         email: TextFields<"loading" | "loadFailed" | "saved" | "sent" | "testFailed" | "delivery" | "notificationAddress" | "replyTo" | "debugInbox" | "debugInboxHint" | "sendTest" | "enabled" | "subject" | "body" | "save" | "sendLog" | "sentColumn" | "templateColumn" | "statusColumn" | "toColumn" | "failed" | "redirected" | "delivered">;
         meetings: TextFields<"loading" | "loadFailed" | "cancelConfirm" | "newStartPrompt" | "parseFailed" | "agenda" | "empty" | "unknown" | "drift" | "meet" | "reschedule" | "cancel">;
-        network: TextFields<"title" | "allowlistDescription" | "sharing" | "shareWith" | "shared" | "shareFailed" | "deliveryFailed">;
+        network: AdminNetworkCopy;
         records: TextFields<"workflowMissing" | "comms" | "commsHistory" | "scheduling" | "billing" | "notes" | "access" | "sharing" | "lifecycle" | "role" | "superAdminHint" | "noAccount" | "approve" | "refund" | "approved" | "refunded" | "roleSet" | "messageSent" | "messageNotSent" | "loadingTemplates" | "template" | "chooseTemplate" | "sending" | "send" | "noMessages" | "message" | "newStartPrompt" | "parseFailed" | "cancelConfirm" | "callCancelled" | "callRescheduled" | "noApplication" | "loadingMeetings" | "noMeetings" | "joinMeeting" | "openCalendar" | "reschedule" | "cancel">;
     };
 }
@@ -59,6 +60,66 @@ type DeepPartial<T> = T extends readonly (infer Item)[] ? readonly Item[] : T ex
 /** Recursively partial copy overrides accepted by `defineChapter({ copy })`. */
 type ChapterCopyInput = DeepPartial<ChapterCopy>;
 
+/** One follower site a leader can push CRM records to. The secret VALUE never
+ * lives in config: `secretName` names the leader tenant's vaulted copy of the
+ * follower's `network_share_secret`. */
+interface ChapterNetworkTarget {
+    /** Stable lowercase slug used by the UI, audit tags, and default secret name. */
+    id: string;
+    /** Human-facing site name. Defaults to `id`. */
+    name?: string;
+    /** Absolute follower origin, e.g. `https://chapter.example.com`. */
+    url: string;
+    /** Leader-vault key holding this follower's share secret. Defaults to
+     * `network_share_<id-with-underscores>`. */
+    secretName?: string;
+    /** Per-record-type field allowlist. If present, omitted types cannot be sent
+     * to this target. Without it, package-safe person/company defaults apply. */
+    fields?: Record<string, readonly string[]>;
+}
+/** Leader/follower network configuration. Followers need no code config to
+ * receive records; they only vault `network_share_secret`. */
+interface ChapterNetwork {
+    targets?: readonly ChapterNetworkTarget[];
+}
+/** Public chapter-formation intake backed by one CRM record type. The host owns
+ * the branded form; Chapter owns the bounded, idempotent write contract. */
+interface LeaderFormationConfig {
+    /** CRM type receiving submissions. Default `"chapter_application"`. */
+    type?: string;
+    /** Public fields that must be non-empty strings. */
+    required?: readonly string[];
+    /** Additional public fields accepted by the route. */
+    optional?: readonly string[];
+    maxLen?: Record<string, number>;
+    /** Per-string cap when `maxLen` has no field override. Default 4000. */
+    defaultMaxLen?: number;
+    /** Maximum JSON request size in characters. Default 32768. */
+    bodyCap?: number;
+}
+/** Fully resolved formation intake policy. */
+interface ResolvedLeaderFormation {
+    enabled: boolean;
+    type: string;
+    required: readonly string[];
+    optional: readonly string[];
+    maxLen: Record<string, number>;
+    defaultMaxLen: number;
+    bodyCap: number;
+}
+/** A validated network target carried on the resolved chapter engine. */
+interface ResolvedNetworkTarget {
+    id: string;
+    name: string;
+    url: string;
+    secretName: string;
+    fields?: Record<string, readonly string[]>;
+}
+/** Fully-resolved leader network configuration. */
+interface ResolvedNetwork {
+    targets: readonly ResolvedNetworkTarget[];
+}
+
 /** 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). */
@@ -186,40 +247,6 @@ interface ChapterBrand {
     }>>;
     logos?: string;
 }
-/** One follower site a leader can push CRM records to. The secret VALUE never
- * lives in config: `secretName` names the leader tenant's vaulted copy of the
- * follower's `network_share_secret`. */
-interface ChapterNetworkTarget {
-    /** Stable lowercase slug used by the UI, audit tags, and default secret name. */
-    id: string;
-    /** Human-facing site name. Defaults to `id`. */
-    name?: string;
-    /** Absolute follower origin, e.g. `https://chapter.example.com`. */
-    url: string;
-    /** Leader-vault key holding this follower's share secret. Defaults to
-     * `network_share_<id-with-underscores>`. */
-    secretName?: string;
-    /** Per-record-type field allowlist. If present, omitted types cannot be sent
-     * to this target. Without it, package-safe person/company defaults apply. */
-    fields?: Record<string, readonly string[]>;
-}
-/** Leader/follower network configuration. Followers need no code config to
- * receive records; they only vault `network_share_secret`. */
-interface ChapterNetwork {
-    targets?: readonly ChapterNetworkTarget[];
-}
-/** A validated network target carried on the resolved chapter engine. */
-interface ResolvedNetworkTarget {
-    id: string;
-    name: string;
-    url: string;
-    secretName: string;
-    fields?: Record<string, readonly string[]>;
-}
-/** Fully-resolved leader network configuration. */
-interface ResolvedNetwork {
-    targets: readonly ResolvedNetworkTarget[];
-}
 /** Membership pricing for the group row (chapter mode). */
 interface ChapterPrices {
     standardCents: number;
@@ -376,6 +403,8 @@ interface ChapterConfig {
     /** Leader → follower delivery targets. Secret values stay in the leader
      * tenant vault; see {@link ChapterNetworkTarget}. */
     network?: ChapterNetwork;
+    /** Enable a public, host-rendered formation application workflow. */
+    formation?: LeaderFormationConfig;
     thesis?: unknown;
     /** Required in `chapter` mode. */
     prices?: ChapterPrices;
@@ -466,6 +495,8 @@ interface Chapter {
     copy: ChapterCopy;
     /** Validated follower targets for leader-driven record pushes. */
     network: ResolvedNetwork;
+    /** Resolved public formation intake contract (disabled when omitted). */
+    formation: ResolvedLeaderFormation;
     /** Resolved CRM engine (from `defineCrm`). */
     crm: Crm;
     /** Resolved auth policy (source, claim, ladder, super-admin tier). */
@@ -496,6 +527,30 @@ interface Chapter {
  */
 declare function defineChapter(config: ChapterConfig): Chapter;
 
+/** Options for {@link leaderCrmConfig}. */
+interface LeaderCrmOptions {
+    /** Existing host CRM config to preserve. Defaults to Chapter's people +
+     * businesses graph for hub mode. */
+    base?: CrmConfig;
+}
+/**
+ * Add generic chapter-formation, portfolio, and deal-flow records to an
+ * existing CRM. Collisions fail through `composeCrmConfigs`, so this preset
+ * never silently replaces a host's people pipeline or templates.
+ */
+declare function leaderCrmConfig(options?: LeaderCrmOptions): CrmConfig;
+
+/** Resolve and validate the public chapter-formation intake contract. */
+declare function resolveLeaderFormation(input: LeaderFormationConfig | undefined, crm: Crm): ResolvedLeaderFormation;
+/** Public, presentational field metadata for a host-owned intake form. */
+declare function formationFields(crm: Crm, formation: ResolvedLeaderFormation): Array<{
+    id: string;
+    label: string;
+    type: FieldDef["type"];
+    required: boolean;
+    options?: readonly string[];
+}>;
+
 /** Options for {@link createChapterIntegration}. */
 interface ChapterIntegrationOptions {
     /** CRM route mount point. Default "/api/crm". */
@@ -935,7 +990,7 @@ interface JoinConfigGroup {
 declare function joinConfig(group: JoinConfigGroup, paymentsReady: boolean): Record<string, unknown>;
 
 /** The contact data the hub shares for a prospect. `hubRecordId` is the stable
- *  idempotency key (the hub's crm_record id). */
+ * idempotency key (the hub's crm_record id). */
 interface SharedPerson {
     email: string;
     name?: string;
@@ -958,39 +1013,96 @@ interface SharedBusiness {
 }
 /** Versioned generic wire shape. `input` is validated against the follower's
  * own CRM type before any write, so a leader cannot smuggle undeclared fields. */
-interface SharedRecord {
+interface SharedRecordV1 {
     version: 1;
     type: string;
     hubRecordId: string;
     input: Record<string, unknown>;
 }
-/** Safe defaults when a target does not declare an explicit field allowlist. */
-declare const DEFAULT_SHARE_FIELDS: Readonly<Record<string, readonly string[]>>;
-/** Map a shared prospect to a crm `person` input (only the fields the default
- *  person type accepts). Name falls back to first+last, then the email. */
-declare function sharedPersonInput(person: SharedPerson): Record<string, unknown>;
-/** Deps for the projection — the resolved CRM engine, the structural db, and
- *  injected clock/id (deterministic in tests). */
+/** Current wire envelope. `source.siteId` prevents records from two leaders
+ * with the same local id from colliding in a follower CRM. */
+interface SharedRecordV2 {
+    version: 2;
+    source: {
+        siteId: string;
+        recordId: string;
+    };
+    type: string;
+    input: Record<string, unknown>;
+}
+/** Accepted generic share envelopes. Version 1 remains readable for migration. */
+type SharedRecord = SharedRecordV1 | SharedRecordV2;
+/** Privacy-bounded follower status returned to an authenticated leader. */
+interface NetworkSnapshot {
+    version: 1;
+    site: {
+        id: string;
+        name: string;
+        mode: string;
+    };
+    generatedAt: number;
+    types: TypeSummary[];
+}
+/** One configured target's latest live result in a leader rollup. */
+interface NetworkRollupTarget {
+    id: string;
+    name: string;
+    url: string;
+    available: boolean;
+    generatedAt?: number;
+    types?: TypeSummary[];
+    error?: string;
+}
+/** Cross-target totals returned to the local leader admin. */
+interface NetworkRollup {
+    configured: number;
+    available: number;
+    totalRecords: number;
+    types: Array<{
+        type: string;
+        total: number;
+        stages: Record<string, number>;
+    }>;
+    targets: NetworkRollupTarget[];
+}
+interface NormalizedSharedRecord {
+    version: 1 | 2;
+    sourceId: string;
+    sourceRecordId: string;
+    type: string;
+    input: Record<string, unknown>;
+}
+/** Dependencies for applying a shared projection. */
 interface ProjectionDeps {
     crm: Crm;
     db: ChapterDb;
     now: () => number;
     newId: () => string;
 }
-/** CRM provenance tag used as the durable leader-id → local-record mapping. */
-declare function networkSourceTag(type: string, hubRecordId: string): string;
+/** Safe defaults when a target does not declare an explicit field allowlist. */
+declare const DEFAULT_SHARE_FIELDS: Readonly<Record<string, readonly string[]>>;
+
+/** Map a shared prospect to a crm `person` input (only the fields the default
+ *  person type accepts). Name falls back to first+last, then the email. */
+declare function sharedPersonInput(person: SharedPerson): Record<string, unknown>;
+/** Backward-compatible display tag retained while structured origin rows are
+ * the durable leader-id → local-record mapping. */
+declare function networkSourceTag(type: string, hubRecordId: string, sourceId?: string): string;
 /** Normalize the backwards-compatible person/business shapes into the versioned
  * generic record envelope the receiver writes. */
-declare function normalizeSharedRecord(record: SharedPerson | SharedBusiness | SharedRecord): SharedRecord;
+declare function normalizeSharedRecord(record: SharedPerson | SharedBusiness | SharedRecord, fallbackSourceId?: string): NormalizedSharedRecord;
 /** Build the allowlisted payload sent from one leader CRM record to a target.
  * A target with an explicit `fields` map only accepts the types it lists. */
-declare function sharedRecordFromCrm(crm: Crm, record: CrmRecord, target: ResolvedNetworkTarget): SharedRecord;
+declare function sharedRecordFromCrm(crm: Crm, record: CrmRecord, target: ResolvedNetworkTarget, sourceId?: string): SharedRecord;
 /**
  * Upsert a leader-shared CRM record into this follower. Accepts the original
  * person wire shape plus the versioned generic shape. Re-shares resolve through
  * a durable provenance tag; people/businesses also converge by natural key.
  */
-declare function projectSharedRecord(deps: ProjectionDeps, shared: SharedPerson | SharedBusiness | SharedRecord): Promise<{
+declare function projectSharedRecord(deps: ProjectionDeps, shared: SharedPerson | SharedBusiness | SharedRecord, options?: {
+    sourceId?: string;
+    sourceUrl?: string;
+}): Promise<{
     recordId: string;
 }>;
 /** An arriving applicant, as far as the CRM projection cares. `extra` carries the
@@ -1519,4 +1631,4 @@ type ApplicationBookingPatch = {
  *  already there (never backward). */
 declare function applicationBookingUpdate(currentStatus: string, startAt: number, htmlLink?: string | null): ApplicationBookingPatch;
 
-export { type AccountModel, type AdminNotificationTrigger, type Applicant, type ApplicationBookingPatch, type ApplicationRecord, type ApplicationSummary, type Attr, type AttrType, type Chapter, type ChapterApplication, type ChapterAuth, type ChapterBrand, type ChapterConfig, type ChapterCopy, type ChapterCopyInput, type ChapterDb, type ChapterEmails, type ChapterIntegrationDescriptor, type ChapterIntegrationOptions, type ChapterMode, type ChapterNetwork, type ChapterNetworkTarget, type ChapterOperations, type ChapterPipeline, type ChapterPolicy, type ChapterPrices, type ChapterRunbookHints, type ChapterScheduling, type ChapterSends, type ClerkInviteInput, type ClerkMetadataInput, type ClerkResult, type ClerkUserInput, type ClerkUserRecord, type CompiledChapterBrandTokens, DEFAULT_CHAPTER_COPY, DEFAULT_SHARE_FIELDS, type DashboardMetricData, type DashboardMetricSeries, type DbOp, type DbRules, type DbSchema, type DeliveryDecision, type EmailGroup, type EmailTemplate, type EmailTemplateRow, type Entity, type ExistingMeeting, type GuardResult, type IntegrationDescriptor, type IntegrationProvision, type IntegrationSecret, type IntegrationSetting, type IntegrationSync, type JoinConfigGroup, type LiveEvent, type MailSender, type MeetingForReconcile, type MeetingRecord, type MeetingReschedulePatch, type MemberApplication, type MemberSession, type NewMeetingRow, type NotifyDeps, type NotifyInput, type NotifyResult, type PaymentsGroup, type ProjectionDeps, type ReconcileDecision, type ResolvedApplication, type ResolvedAuth, type ResolvedNetwork, type ResolvedNetworkTarget, type ResolvedOperations, type ResolvedPipeline, type ResolvedScheduling, type ResolvedSends, type RoleChangeContext, type Rule, SCHEDULING_DEFAULTS, type SchedulingErrors, type SecretMode, type SecretStore, type SessionUser, type SharedBusiness, type SharedPerson, type SharedRecord, type StripeEvent, type StripeResult, type SubmitResult, type WebhookEvent, applicantProfile, applicationBookingUpdate, applicationSummary, backfillCrm, bookingDecision, brandTokens, bucketSeries, buildGroupSeed, canApprove, canBook, canChangeRole, canTransition, canceledPatch, chapterBrandFromTokens, chapterDb, clampArray, clerkGetUser, clerkGetUserByEmail, clerkIntegration, clerkInviteRequest, clerkListUsers, clerkSetRole, clerkUserRequest, createChapterIntegration, createClerkInvitation, createClerkUser, dashboardMetricData, defaultCrm, defineChapter, emailGroupFrom, endForSlot, findApplicationRef, firstPaymentPatch, formatChapterCopy, getVaultSecret, hasDisclaimerAck, introIdempotencyKey, isAdminRole, isAlreadySent, isReconcilable, isSlotAvailable, isValidEmail, joinConfig, meetingCreateRow, meetingRescheduleUpdate, memberApplication, memberSession, networkSourceTag, normalizeSharedRecord, normalizeWebhookEvent, paymentsReady, personInputFromApp, planDelivery, projectApplicant, projectSharedRecord, reconcileMeetings, refundedPatch, render, renderSummary, renderTemplateBody, renewalPatch, resolveApplication, resolveAuth, resolveChapterCopy, resolvePipeline, resolveScheduling, roleFromClaim, sendTemplated, sharedPersonInput, sharedRecordFromCrm, slotWindow, stageIndex, stripeCall, stripeForm, subAnnualCents, submitApplication, subscriptionIdempotencyKey, syncApplicationToCrm, updateClerkUserMetadata, updateClerkUserMetadataByEmail, validateScheduling, verifyStripeSignature, webhookMutationId };
+export { type AccountModel, type AdminNotificationTrigger, type Applicant, type ApplicationBookingPatch, type ApplicationRecord, type ApplicationSummary, type Attr, type AttrType, type Chapter, type ChapterApplication, type ChapterAuth, type ChapterBrand, type ChapterConfig, type ChapterCopy, type ChapterCopyInput, type ChapterDb, type ChapterEmails, type ChapterIntegrationDescriptor, type ChapterIntegrationOptions, type ChapterMode, type ChapterNetwork, type ChapterNetworkTarget, type ChapterOperations, type ChapterPipeline, type ChapterPolicy, type ChapterPrices, type ChapterRunbookHints, type ChapterScheduling, type ChapterSends, type ClerkInviteInput, type ClerkMetadataInput, type ClerkResult, type ClerkUserInput, type ClerkUserRecord, type CompiledChapterBrandTokens, DEFAULT_CHAPTER_COPY, DEFAULT_SHARE_FIELDS, type DashboardMetricData, type DashboardMetricSeries, type DbOp, type DbRules, type DbSchema, type DeliveryDecision, type EmailGroup, type EmailTemplate, type EmailTemplateRow, type Entity, type ExistingMeeting, type GuardResult, type IntegrationDescriptor, type IntegrationProvision, type IntegrationSecret, type IntegrationSetting, type IntegrationSync, type JoinConfigGroup, type LeaderCrmOptions, type LeaderFormationConfig, type LiveEvent, type MailSender, type MeetingForReconcile, type MeetingRecord, type MeetingReschedulePatch, type MemberApplication, type MemberSession, type NetworkRollup, type NetworkRollupTarget, type NetworkSnapshot, type NewMeetingRow, type NotifyDeps, type NotifyInput, type NotifyResult, type PaymentsGroup, type ProjectionDeps, type ReconcileDecision, type ResolvedApplication, type ResolvedAuth, type ResolvedLeaderFormation, type ResolvedNetwork, type ResolvedNetworkTarget, type ResolvedOperations, type ResolvedPipeline, type ResolvedScheduling, type ResolvedSends, type RoleChangeContext, type Rule, SCHEDULING_DEFAULTS, type SchedulingErrors, type SecretMode, type SecretStore, type SessionUser, type SharedBusiness, type SharedPerson, type SharedRecord, type SharedRecordV1, type SharedRecordV2, type StripeEvent, type StripeResult, type SubmitResult, type WebhookEvent, applicantProfile, applicationBookingUpdate, applicationSummary, backfillCrm, bookingDecision, brandTokens, bucketSeries, buildGroupSeed, canApprove, canBook, canChangeRole, canTransition, canceledPatch, chapterBrandFromTokens, chapterDb, clampArray, clerkGetUser, clerkGetUserByEmail, clerkIntegration, clerkInviteRequest, clerkListUsers, clerkSetRole, clerkUserRequest, createChapterIntegration, createClerkInvitation, createClerkUser, dashboardMetricData, defaultCrm, defineChapter, emailGroupFrom, endForSlot, findApplicationRef, firstPaymentPatch, formatChapterCopy, formationFields, getVaultSecret, hasDisclaimerAck, introIdempotencyKey, isAdminRole, isAlreadySent, isReconcilable, isSlotAvailable, isValidEmail, joinConfig, leaderCrmConfig, meetingCreateRow, meetingRescheduleUpdate, memberApplication, memberSession, networkSourceTag, normalizeSharedRecord, normalizeWebhookEvent, paymentsReady, personInputFromApp, planDelivery, projectApplicant, projectSharedRecord, reconcileMeetings, refundedPatch, render, renderSummary, renderTemplateBody, renewalPatch, resolveApplication, resolveAuth, resolveChapterCopy, resolveLeaderFormation, resolvePipeline, resolveScheduling, roleFromClaim, sendTemplated, sharedPersonInput, sharedRecordFromCrm, slotWindow, stageIndex, stripeCall, stripeForm, subAnnualCents, submitApplication, subscriptionIdempotencyKey, syncApplicationToCrm, updateClerkUserMetadata, updateClerkUserMetadataByEmail, validateScheduling, verifyStripeSignature, webhookMutationId };