@odla-ai/chapter 0.61.0 → 0.63.0

package/dist/copy-context-BNKK7ZDm.d.ts

@@ -0,0 +1,370 @@
+import * as preact from 'preact';
+import { ComponentChildren } from 'preact';
+
+type TextFields$2<Key extends string> = {
+    [Field in Key]: string;
+};
+/** User-visible language for sharing, delivery state, and leader rollups. */
+type AdminNetworkCopy = TextFields$2<"title" | "allowlistDescription" | "sharing" | "shareWith" | "shared" | "shareFailed" | "deliveryFailed" | "loadingRollup" | "loadRollupFailed" | "overview" | "configuredFollowers" | "reachableFollowers" | "recordsAcrossFollowers" | "noFollowers" | "followers" | "available" | "unavailable" | "transportReachable" | "transportUnavailable" | "transportNotChecked" | "edgeUnpaired" | "edgeUnpairedHint" | "bindingTransport" | "urlTransport" | "activeConfiguration" | "noActiveConfiguration" | "publicSiteAvailable" | "publicSiteUnavailable" | "publicSiteNotChecked" | "recordTotals" | "noRecordTotals">;
+
+type TextFields$1<Key extends string> = {
+    [Field in Key]: string;
+};
+/**
+ * Member portal language. Placeholders in braces are filled by
+ * `formatChapterCopy()`. Sites override any field through `copy.portal`.
+ */
+interface PortalCopy {
+    shell: TextFields$1<"navLabel" | "welcomeBack" | "home" | "backHome" | "yourProfile" | "signedInAs" | "signOut" | "adminConsole" | "openMenu" | "closeMenu" | "locked" | "loading" | "loadFailed" | "notFound">;
+    pages: TextFields$1<"comingSoon" | "comingIn" | "includedWith" | "upgrade" | "comingToPortal" | "tagNew" | "tagSoon">;
+    profile: TextFields$1<"eyebrow" | "editProfile" | "saveProfile" | "saving" | "cancel" | "uploadPhoto" | "changePhoto" | "photoUploading" | "photoFailed" | "memberSince" | "promptsTitle" | "promptsNote" | "answerEmpty" | "addPrompt" | "howYouFoundUs" | "referredBy" | "referredByNote" | "introducedBy" | "introducedByPlaceholder" | "namePlaceholder" | "locationPlaceholder" | "saved" | "conflict" | "saveFailed">;
+    /** Invitations and referrals. Templates take {tierName}, {article}, {inviteUrl}, {firstName}, {location}, {credit}. */
+    share: TextFields$1<"eyebrow" | "intro" | "officialTitle" | "officialBody" | "showMeHow" | "stepsEyebrow" | "openLinkedIn" | "copyDescription" | "linkedinDescription" | "postTitle" | "postBody" | "shareOnLinkedIn" | "previewPost" | "linkedinPost" | "linkTitle" | "linkBody" | "linkCredit" | "referralsCredit" | "copyLink" | "copied" | "copyBlocked" | "emailInvite" | "textInvite" | "inviteNote" | "emailSubject" | "emailBody" | "textBody" | "fallbackEmail" | "fallbackText" | "copyMessage" | "close" | "referralsTitle" | "referralsBody" | "inviteFriend" | "joined" | "inProcess" | "offNextYear" | "joinedWith"> & {
+        steps: string[];
+    };
+    /** The cohort course page and Home panel. Templates take {left}, {capacity}, {position}, {count}. */
+    course: TextFields$1<"eyebrow" | "reserve" | "seeDetails" | "courseDetails" | "youreIn" | "invitesOnWay" | "openMeet" | "giveUp" | "confirmGiveUp" | "joinWaitlist" | "onWaitlist" | "leaveWaitlist" | "seatsOpen" | "full" | "closed" | "when" | "dates" | "where" | "seats" | "googleMeet" | "inviteEvery" | "guidesTitle" | "sessionsTitle" | "materialsOpen" | "materialsLocked" | "items" | "outcomesTitle" | "toolkitTitle" | "timeTitle" | "open" | "read" | "do" | "watch" | "extra" | "failed" | "reserveYourSeat">;
+}
+
+/** Copy for the person record panels: lifecycle actions, comms, scheduling, billing and meetings. */
+type AdminRecordsCopy = {
+    [Field in AdminRecordsCopyKey]: string;
+};
+/** Every key a host may override under `admin.records`. */
+type AdminRecordsCopyKey = "workflowMissing" | "invitation" | "comms" | "commsHistory" | "scheduling" | "billing" | "notes" | "access" | "sharing" | "lifecycle" | "role" | "superAdminHint" | "noAccount" | "approve" | "decline" | "refund" | "approved" | "declined" | "refunded" | "roleSet" | "messageSent" | "messageNotSent" | "loadingTemplates" | "template" | "chooseTemplate" | "sending" | "send" | "noMessages" | "message" | "newStartPrompt" | "parseFailed" | "cancelConfirm" | "callCancelled" | "callRescheduled" | "noApplication" | "loadingMeetings" | "noMeetings" | "joinMeeting" | "openCalendar" | "reschedule" | "cancel";
+
+type TextFields<Key extends string> = {
+    [Field in Key]: string;
+};
+
+/** Complete serializable language for Chapter surfaces; use render slots for markup and `formatChapterCopy()` for placeholders. */
+interface ChapterCopy {
+    common: TextFields<"loading" | "saved" | "unknown">;
+    join: {
+        /** Prepaid invitation attribution, consent and recoverable error copy. */
+        namedSeat?: TextFields<"title" | "from" | "prepaid" | "body" | "consent" | "accept" | "accepting" | "loading" | "unavailable" | "retry" | "failure">;
+        form: TextFields<"submit" | "submitting" | "submitFailed" | "unexpectedFailure">;
+        booking: TextFields<"unavailable" | "loadFailed" | "slotTaken" | "failed" | "loading" | "book" | "booking"> & {
+            title?: string;
+            intro?: string;
+            /** Shown under the booking button until a date is chosen. */
+            pickDate?: string;
+            /** Shown under the booking button once a date is chosen, until a time is. */
+            pickTime?: string;
+        };
+        /**
+         * `consent` is the affirmative statement a member agrees to before the card
+         * form appears, rendered beside the checkbox and beneath the policy text.
+         * It is what the member is shown at the moment of consent, so it says they
+         * agree rather than merely restating the policy. Set it to an empty string
+         * to render the checkbox with the policy as its only label.
+         */
+        payment: TextFields<"setupFailed" | "preparing" | "pending" | "processing" | "payAndContinue" | "incomplete" | "consent" | "foundingMember" | "foundingDiscount" | "standardRate" | "yourRate">;
+        done: TextFields<"label" | "calendarInvite" | "memberArea">;
+        accepted: TextFields<"label" | "body">;
+        gift: TextFields<"chooseSelf" | "optionsLabel" | "label" | "body" | "save" | "rotate" | "rotateFailed" | "claimTitle" | "claimBody" | "code" | "redeem" | "redeemed" | "redeemFailed">;
+    };
+    members: {
+        loadFailed: string;
+        account: TextFields<"signOut" | "adminConsole">;
+        provisional: TextFields<"cardLabel" | "applicationNeeded" | "applicationNeededBody" | "apply" | "refunded" | "refundedBody" | "declined" | "declinedBody" | "active" | "renews" | "introductionCall" | "calendarInvite" | "joinCall" | "bookCall" | "bookCallBody" | "chooseTime">;
+        full: TextFields<"welcome">;
+        gifts: TextFields<"title" | "body" | "noneAvailable" | "paid" | "saveCode" | "purchases" | "noPurchases" | "pending" | "redeemed" | "expired" | "revoked" | "rotate" | "rotated" | "rotateFailed" | "redeemTitle" | "code" | "redeem" | "redeemFailed">;
+        reschedule: TextFields<"changeTime" | "unavailable" | "loadFailed" | "slotGone" | "loading" | "noTimes" | "rescheduling" | "keepTime">;
+    };
+    /** Signed-in member portal: shell, pages, profile. */
+    portal: PortalCopy;
+    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" | "admission" | "network" | "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"> & {
+            dayLabels: readonly string[];
+        };
+        email: TextFields<"loading" | "loadFailed" | "saved" | "sent" | "testFailed" | "delivery" | "notificationAddress" | "replyTo" | "fromName" | "fromNameHint" | "spamRisk" | "debugInbox" | "debugInboxHint" | "sendTest" | "enabled" | "subject" | "body" | "htmlBody" | "htmlBodyHint" | "save" | "sendLog" | "sentColumn" | "templateColumn" | "statusColumn" | "toColumn" | "failed" | "redirected" | "delivered">;
+        meetings: TextFields<"loading" | "loadFailed" | "cancelConfirm" | "newStartPrompt" | "parseFailed" | "agenda" | "empty" | "unknown" | "drift" | "meet" | "reschedule" | "cancel">;
+        admission: TextFields<"title" | "description" | "email" | "decision" | "expires" | "note" | "waive" | "require" | "add" | "ledger" | "loading" | "consumed" | "revoked" | "expired" | "active" | "local" | "parent" | "revoke">;
+        network: AdminNetworkCopy;
+        records: AdminRecordsCopy;
+    };
+}
+type DeepPartial<T> = T extends readonly (infer Item)[] ? readonly Item[] : T extends object ? {
+    [Key in keyof T]?: DeepPartial<T[Key]>;
+} : T;
+/** Recursively partial copy overrides accepted by `defineChapter({ copy })`. */
+type ChapterCopyInput = DeepPartial<ChapterCopy>;
+
+/** Brand identity and build-time tokens from the checked-in Chapter config. */
+/** Typed semantic roles shared by the public site and application surfaces. */
+interface ChapterBrandTokens {
+    background?: string;
+    surface?: string;
+    surface2?: string;
+    text?: string;
+    textMuted?: string;
+    textFaint?: string;
+    border?: string;
+    borderStrong?: string;
+    accent?: string;
+    accentStrong?: string;
+    accentSoft?: string;
+    onAccent?: string;
+    good?: string;
+    warn?: string;
+    danger?: string;
+    chart1?: string;
+    chart2?: string;
+    chart3?: string;
+    chart4?: string;
+    chart5?: string;
+    chart6?: string;
+    chartPositive?: string;
+    chartNegative?: string;
+    /** Admin/application content width, e.g. `"960px"`. */
+    contentWidth?: string;
+    panelRadius?: string;
+    panelShadow?: string;
+    masterDetailColumns?: string;
+    masterDetailMinHeight?: string;
+    /** Chapter-admin page padding shorthand. */
+    pagePadding?: string;
+    /** Chapter-admin workspace-tab padding shorthand. */
+    workspacePadding?: string;
+}
+/** Brand tokens that theme the site: theme, semantic roles, fonts, and logos. */
+interface ChapterBrand {
+    /** Preloaded @odla-ai/ui theme name used by ThemeScope. */
+    theme?: string;
+    /** Named accent family supplied by the selected @odla-ai/ui theme. */
+    accent?: string;
+    /** Admin/application color mode. Explicit light is the safe default. */
+    colorScheme?: "light" | "dark" | "system";
+    tokens?: ChapterBrandTokens;
+    tokensDark?: ChapterBrandTokens;
+    /** Palette overrides written into styles.css :root (e.g. `{ moss: "#2F3E34" }`
+     * or `--ui-*` token names). Applies in BOTH light and dark unless overridden
+     * by {@link paletteDark}. */
+    palette?: Record<string, string>;
+    /** Dark-mode palette overrides. Same shape as {@link palette}; emitted under
+     *  `:root[data-theme="dark"]` and `@media (prefers-color-scheme: dark)`, so a
+     *  site brands both modes. */
+    paletteDark?: Record<string, string>;
+    /** Full token map for `.ui-invert` islands. A compiled custom theme normally
+     * uses its dark map here so inverted content never inherits stale composites. */
+    paletteInvert?: Record<string, string>;
+    fonts?: {
+        display?: string;
+        body?: string;
+        numeral?: string;
+    };
+    /** Short glyph used in compact admin chrome. Defaults to the first three
+     * letters of the chapter name. */
+    badge?: 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;
+}
+
+/**
+ * Member catalog schema version 2: ordered navigation sections, page kinds,
+ * navigation tags and icons. Version 1 documents remain valid and keep their
+ * alphabetical section order; every field here requires `schemaVersion: 2`.
+ */
+/** Packaged member features a catalog page can stand for. */
+declare const MEMBER_PAGE_FEATURES: readonly ["course", "share"];
+/** A packaged member feature: `course` (cohort course) or `share` (invite kit). */
+type MemberPageFeatureName = typeof MEMBER_PAGE_FEATURES[number];
+/** Fixed icon vocabulary. Content never carries SVG, URLs or markup. */
+declare const MEMBER_PAGE_ICONS: readonly ["home", "course", "library", "deals", "training", "events", "members", "share", "profile", "document", "calendar", "chat", "star"];
+/** One icon from {@link MEMBER_PAGE_ICONS}. */
+type MemberPageIcon = typeof MEMBER_PAGE_ICONS[number];
+/** Authored navigation tags. "Soon" and year tags are derived from placeholder pages. */
+declare const MEMBER_PAGE_TAGS: readonly ["new"];
+/** One tag from {@link MEMBER_PAGE_TAGS}. */
+type MemberPageTag = typeof MEMBER_PAGE_TAGS[number];
+/** How a page renders: authored Markdown, a not-yet-open placeholder, or a packaged feature. */
+type MemberPageKind = "markdown" | "placeholder" | "feature";
+/**
+ * A page that is announced but not open. Without `availableYear` it reads as
+ * "Coming soon"; with one, as "Coming in <year>".
+ */
+interface MemberPagePlaceholder {
+    /** Calendar year the page is expected to open. */
+    availableYear?: number;
+    /** Replaces the derived "Coming soon" / "Coming in <year>" badge text. */
+    badge?: string;
+    /** Label of a disabled call to action, e.g. "Investor form opens in 2027". */
+    actionLabel?: string;
+}
+/** A catalog page backed by a packaged feature, gated by the page's audience. */
+interface MemberPageFeature {
+    name: MemberPageFeatureName;
+    /** Feature-specific identity, e.g. the course id for `course`. */
+    ref?: string;
+}
+/**
+ * One navigation group. A section without a label renders without a heading.
+ * Section order is the order of the document's `sections` array.
+ */
+interface MemberContentSection {
+    id: string;
+    label?: string;
+}
+
+/** Every member-content schema version this release validates. */
+type MemberContentSchemaVersion = 1 | 2;
+/** Authority that authored one independently stored member-content layer. */
+type MemberContentSourceType = "parent" | "chapter";
+/** Stable author identity attached to every member-content document and page. */
+interface MemberContentSource {
+    type: MemberContentSourceType;
+    appId: string;
+}
+/** Chapter deployment that a parent member-content revision is intended for. */
+interface MemberContentTarget {
+    chapterId: string;
+    environment: string;
+}
+/** Navigation is data, so agents do not have to coordinate route code. */
+interface MemberPageNavigation {
+    /** A section id declared in `sections`, or (without `sections`) the section's display label. */
+    section: string;
+    order: number;
+    parentId?: string;
+    /** Schema version 2. */
+    tag?: MemberPageTag;
+    /** Schema version 2. */
+    icon?: MemberPageIcon;
+}
+/** Explicit sets avoid unsafe assumptions that commercial tiers form a ladder. */
+type MemberPageAudience = {
+    kind: "all-members";
+} | {
+    kind: "tiers";
+    tierIds: readonly string[];
+};
+/** Authored offer copy. Price and provider identity deliberately do not live here. */
+interface MemberPageUpsellOffer {
+    tierId: string;
+    label?: string;
+    bodyMarkdown?: string;
+    ctaLabel?: string;
+}
+/** Parent offer authority is explicit; a Chapter can edit only a delegated offer. */
+type MemberPageUpsell = {
+    owner: "parent";
+    offer: MemberPageUpsellOffer;
+} | {
+    owner: "chapter";
+    offer?: MemberPageUpsellOffer;
+};
+/** Authored member page whose body is disclosed only after server-side projection. */
+interface MemberContentPage {
+    id: string;
+    slug: string;
+    title: string;
+    summary?: string;
+    navigation: MemberPageNavigation;
+    audience: MemberPageAudience;
+    /** Safe Markdown shown while the body is withheld. */
+    teaserMarkdown?: string;
+    /** Never serialized to a viewer whose audience does not match. Required for Markdown pages. */
+    bodyMarkdown?: string;
+    upsell?: MemberPageUpsell;
+    /** Schema version 2; defaults to `markdown`. */
+    kind?: MemberPageKind;
+    /** Schema version 2; present exactly when `kind` is `placeholder`. */
+    placeholder?: MemberPagePlaceholder;
+    /** Schema version 2; present exactly when `kind` is `feature`. */
+    feature?: MemberPageFeature;
+}
+/** Chapter-owned offer attached to a Parent page that delegated offer authority. */
+interface MemberPageUpsellOverride {
+    pageId: string;
+    offer: MemberPageUpsellOffer;
+}
+/** One complete source layer. Parent and Chapter layers are stored independently. */
+interface MemberContentDocument {
+    schemaVersion: MemberContentSchemaVersion;
+    revision: number;
+    generatedAt: number;
+    source: MemberContentSource;
+    target?: MemberContentTarget;
+    pages: readonly MemberContentPage[];
+    upsellOverrides?: readonly MemberPageUpsellOverride[];
+    /** Schema version 2: navigation groups in display order. */
+    sections?: readonly MemberContentSection[];
+}
+/** Provider-neutral tier facts used to validate access and resolve safe offers. */
+interface MemberContentTierAuthority {
+    id: string;
+    name?: string;
+    priceCents?: number;
+    active?: boolean;
+}
+/** Composed member page retaining the identity of its authoring layer. */
+interface EffectiveMemberContentPage extends MemberContentPage {
+    source: MemberContentSource;
+}
+/** Deterministically ordered parent and chapter layers with their source revisions. */
+interface EffectiveMemberContent {
+    pages: readonly EffectiveMemberContentPage[];
+    /** Navigation groups in display order; only groups that have pages. Always set by `composeMemberContent`. */
+    sections?: readonly MemberContentSection[];
+    parentRevision: number | null;
+    chapterRevision: number | null;
+}
+/** Authored upsell joined to active chapter tier name and price authority. */
+interface ResolvedMemberPageUpsell extends MemberPageUpsellOffer {
+    tierName: string;
+    priceCents: number;
+}
+/** Viewer-safe page result; locked projections never carry bodyMarkdown. */
+interface MemberContentPageProjection {
+    id: string;
+    slug: string;
+    title: string;
+    summary?: string;
+    navigation: MemberPageNavigation;
+    audience: MemberPageAudience;
+    source: MemberContentSource;
+    access: "allowed" | "locked";
+    /** Always sent by the server; a hand-built preview may omit it to mean `markdown`. */
+    kind?: MemberPageKind;
+    placeholder?: MemberPagePlaceholder;
+    feature?: MemberPageFeature;
+    teaserMarkdown?: string;
+    bodyMarkdown?: string;
+    upsell?: ResolvedMemberPageUpsell;
+}
+/** Complete viewer-safe member navigation and revision projection. */
+interface MemberContentProjection {
+    pages: readonly MemberContentPageProjection[];
+    /** Always sent by the server; a hand-built preview may omit it. */
+    sections?: readonly MemberContentSection[];
+    viewer: {
+        tierId: string | null;
+        admin: boolean;
+    };
+    revisions: {
+        parent: number | null;
+        chapter: number | null;
+    };
+}
+
+/** Place a resolved or partial copy contract around any Chapter UI surface. */
+declare function ChapterCopyProvider(props: {
+    copy?: ChapterCopy | ChapterCopyInput;
+    children: ComponentChildren;
+}): preact.JSX.Element;
+/** Read the nearest complete Chapter copy contract. */
+declare function useChapterCopy(): ChapterCopy;
+
+export { ChapterCopyProvider as C, type EffectiveMemberContent as E, type MemberContentDocument as M, type PortalCopy as P, type ChapterBrand as a, type ChapterCopyInput as b, type ChapterCopy as c, type MemberContentTierAuthority as d, type MemberContentProjection as e, type MemberContentPageProjection as f, type MemberPageFeatureName as g, type MemberPageIcon as h, useChapterCopy as u };