@ixo/decision-oracle 0.0.0-stage → 0.2.0

package/dist/lib/email/template.d.ts

@@ -0,0 +1,217 @@
+/**
+ * Notice copy — the chain lane's three (paused, resumed, review request), the member emails'
+ * six (invite, accepted, access granted, review needed / batched / reminder) and the source
+ * contact's low-balance notice.
+ *
+ * Ported STRUCTURE only from eval-engine's `lib/email/template.ts` (a ~56KB, multi-account console
+ * document): one internal `Notice` object per render → `render()` turns it into
+ * `{subject, html, text}` for email, and `chatBody()` turns the SAME object into a short plain-text
+ * twin for a chat surface — so a paused notice can never say something different in the two lanes.
+ * The kit doesn't have v1's owner-pooled subscription/payout accounts (billing is per-collection,
+ * one status column, not three account kinds), so the content itself is far smaller: no coin
+ * figures, no two-account panel, no dollar amounts — just what stopped, why, and where to look.
+ *
+ * Written for EMAIL: inline styles only (no external stylesheet — Gmail strips `<style>` blocks
+ * that aren't inlined onto the elements that need them), a real `text` twin for plain-text clients
+ * and spam filters, and no images (nothing to block, nothing to alt).
+ *
+ * What must never appear here: claim answers, files, the submitter, a key, or anything from the
+ * evaluation itself — a notice is delivery, not a claim payload (matches lib/matrix/events.ts's own
+ * rule). The member emails (invites, access, review requests — the member-emails spec) do carry
+ * people's names, and only through `untrusted()`.
+ *
+ * ALL copy and markup live in this file (member-emails spec, status line): a redesign of the look
+ * or the words touches nothing in the sending, batching or recipient code.
+ */
+import type { Config } from "../../config.js";
+export type CollectionPausedReason = "engine-credits" | "engine-no-grant" | "rubric-unusable" | "admin-unfunded" | "payer-credits" | "payer-delegation" | "oracle-plan";
+/**
+ * What the `admin-unfunded` notice needs to be actionable: WHICH account to top up and by how
+ * much. The chain draws every leg of a `MsgEvaluateClaim` from the collection's admin
+ * (entity-module) account — the evaluation payment on every one, plus the approval payment on an
+ * ordinary approve or the rejection payment on a reject — and fails the whole message unless it
+ * covers them all, so the owner must fund that one, not their wallet. `required` is the claim
+ * that failed's whole draw, per denom (`adminDraw`, lib/ixo/payment.ts). `balance` is the
+ * account's spendable amount when the chain's error text said it (`spendable balance 0uixo is
+ * smaller than …`), else unknown.
+ */
+export interface AdminUnfundedDetail {
+    adminAddress: string;
+    verdict: "approve" | "reject";
+    required: {
+        denom: string;
+        amount: string;
+    }[];
+    balance?: {
+        denom: string;
+        amount: string;
+    };
+}
+export interface RenderedEmail {
+    subject: string;
+    html: string;
+    text: string;
+}
+/**
+ * V1's `portalActionUrl` had a double-slash bug (`.replace(/\/+$/, "") + "//wallet"` — two slashes
+ * before the path). Fixed here: strip trailing slashes on the base exactly once, then join with
+ * exactly one leading slash.
+ */
+export declare function portalCollectionUrl(config: Pick<Config, "PORTAL_BASE_URL">, collectionId: string): string;
+/**
+ * Every notice input carries `brand`: this is a package, so the header cannot be a hardcoded
+ * "IXO EVALUATION ORACLE" — a caller passes `getOracle().config.name`. The chat twins take the
+ * same input (both renders are built from ONE Notice) and simply don't print it.
+ */
+interface PausedInput {
+    brand: string;
+    collectionId: string;
+    reason: CollectionPausedReason;
+    actionUrl: string;
+    /** `admin-unfunded` only — which account, how much (see `AdminUnfundedDetail`). */
+    detail?: AdminUnfundedDetail;
+}
+interface ResumedInput {
+    brand: string;
+    collectionId: string;
+    actionUrl: string;
+}
+interface ReviewRequestInput {
+    brand: string;
+    claimId: string;
+    collectionId: string;
+    link: string;
+}
+export type MemberRole = "owner" | "developer" | "reviewer" | "viewer" | "submitter";
+/** A source as the member emails need it: the id for links, the (untrusted) name for copy. */
+export interface EmailSource {
+    id: string;
+    name: string;
+}
+/** One claim awaiting review, as the review emails show it (never its answers — §1.4). */
+export interface ReviewEmailClaim {
+    claimId: string;
+    /** The protocol's NAME (untrusted, §1.5), not its DID. */
+    protocol: string;
+    /** How many review questions it waits on. */
+    questions: number;
+    /** When it was decided `review`. */
+    waitingSince: Date;
+    /**
+     * A paid claim's review deadline — when its payment reservation runs out (the record's
+     * `review.answerBy`); an answer after it can't be paid. Absent or null: no deadline to state.
+     */
+    answerBy?: Date | null;
+}
+/** Who a review email is for — only the footer differs (§5, §7). `member` = an owner or developer. */
+export type ReviewAudience = "reviewer" | "member" | "contact";
+/** §1.6: `12 Oct 2026, 14:05 UTC`. */
+export declare function fmtTime(at: Date): string;
+/**
+ * The oracle's own API base as the console names it — `https://<ORACLE_HOSTNAME>`, `http` only for
+ * localhost (the CLI's `oracleUrlFor` rule), so a local console reaches a local `wrangler dev`.
+ */
+export declare function oracleApiUrl(config: Pick<Config, "ORACLE_HOSTNAME">): string;
+interface MemberEmailBase {
+    brand: string;
+    /** `CONSOLE_URL`. */
+    consoleUrl: string;
+    /** This oracle's API base (`oracleApiUrl`) — the `oracle=` every console link carries. */
+    oracleUrl: string;
+    source: EmailSource;
+}
+export interface InviteEmailInput extends MemberEmailBase {
+    role: MemberRole;
+    /** Protocol NAMES when the grant is limited to some; absent/empty = all. */
+    protocols?: string[];
+    /** The inviter's name from AuthHub, else their email. */
+    inviter: string;
+    inviteeEmail: string;
+    inviteToken: string;
+    expiresAt: Date;
+}
+export interface InviteAcceptedEmailInput extends MemberEmailBase {
+    role: MemberRole;
+    protocols?: string[];
+    /** The member's AuthHub name. */
+    member: string;
+    /** The `did:ixo` the member signed in as — the oracle never learns an account's verified email. */
+    accountDid: string;
+    /** The email the invitation went to. */
+    invitedEmail: string;
+    memberId: string;
+    /** Absent until a grant says (the invite names no expiry): the row is left out. */
+    accessUntil?: Date;
+}
+export interface AccessGrantedEmailInput extends MemberEmailBase {
+    role: MemberRole;
+    protocols?: string[];
+    /** Who signed the grant (their AuthHub name, else their email). */
+    owner: string;
+    /** The grant's expiry; absent = none, and the row and the footer's end date are left out. */
+    accessUntil?: Date;
+}
+export interface ReviewNeededEmailInput extends MemberEmailBase {
+    claim: ReviewEmailClaim;
+    audience: ReviewAudience;
+}
+export interface ReviewBatchEmailInput extends MemberEmailBase {
+    claims: ReviewEmailClaim[];
+    audience: ReviewAudience;
+}
+export interface ReviewReminderEmailInput extends MemberEmailBase {
+    claims: ReviewEmailClaim[];
+    audience: ReviewAudience;
+    days: 3 | 14;
+}
+export interface BalanceLowEmailInput extends MemberEmailBase {
+    /** What the payer has left, whole cents. */
+    balanceCents: number;
+    /** The source's `refillFloorCents`. */
+    floorCents: number;
+}
+/** The Decision Console's "Pay for reviews" page (its `BILLING_HUB` tab). */
+export declare const CONSOLE_REVIEW_BILLING_PATH = "/billing/reviews";
+export interface ReviewBillingExpiringEmailInput extends MemberEmailBase {
+    /** When the delegation stops paying. */
+    expiresAt: Date;
+    /** The reminder's stage: 30 or 7 days ahead. */
+    daysLeft: 30 | 7;
+}
+export interface ReviewBillingCapEmailInput extends MemberEmailBase {
+    /** The stage crossed: 80 or 95 percent of the cap spent. */
+    percent: 80 | 95;
+    /** The delegation's lifetime cap and what is left of it, upay (1 PAY = 1 000 000). */
+    capUpay: string;
+    remainingUpay: string;
+    /** Whole reviews the rest pays for at the oracle's lowest price; null when it publishes none. */
+    reviewsLeft: number | null;
+}
+/** A Matrix message's two bodies, as `sendCollectionNoticeMessage` and its kin take them. */
+export interface ChatNotice {
+    body: string;
+    formattedBody: string;
+}
+export declare function renderPausedEmail(input: PausedInput): RenderedEmail;
+export declare function pausedNoticeChat(input: PausedInput): string;
+export declare function pausedNoticeHtml(input: PausedInput): string;
+export declare function renderResumedEmail(input: ResumedInput): RenderedEmail;
+export declare function resumedNoticeChat(input: ResumedInput): string;
+export declare function resumedNoticeHtml(input: ResumedInput): string;
+export declare function renderReviewRequestEmail(input: ReviewRequestInput): RenderedEmail;
+export declare function reviewRequestNoticeChat(input: ReviewRequestInput): string;
+export declare function renderInviteEmail(input: InviteEmailInput): RenderedEmail;
+export declare function renderInviteAcceptedEmail(input: InviteAcceptedEmailInput): RenderedEmail;
+export declare function renderAccessGrantedEmail(input: AccessGrantedEmailInput): RenderedEmail;
+export declare function renderReviewNeededEmail(input: ReviewNeededEmailInput): RenderedEmail;
+/** §1.9: the review room's post, from the SAME Notice as the email. */
+export declare function reviewNeededChat(input: ReviewNeededEmailInput): ChatNotice;
+export declare function renderReviewBatchEmail(input: ReviewBatchEmailInput): RenderedEmail;
+export declare function reviewBatchChat(input: ReviewBatchEmailInput): ChatNotice;
+export declare function renderReviewReminderEmail(input: ReviewReminderEmailInput): RenderedEmail;
+export declare function reviewReminderChat(input: ReviewReminderEmailInput): ChatNotice;
+export declare function renderBalanceLowEmail(input: BalanceLowEmailInput): RenderedEmail;
+export declare function renderReviewBillingCapEmail(input: ReviewBillingCapEmailInput): RenderedEmail;
+export declare function renderReviewBillingExpiringEmail(input: ReviewBillingExpiringEmailInput): RenderedEmail;
+export {};
+//# sourceMappingURL=template.d.ts.map

package/dist/lib/email/template.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.d.ts","sourceRoot":"","sources":["../../../src/lib/email/template.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3C,MAAM,MAAM,sBAAsB,GAC9B,gBAAgB,GAChB,iBAAiB,GACjB,iBAAiB,GACjB,gBAAgB,GAChB,eAAe,GACf,kBAAkB,GAClB,aAAa,CAAC;AAElB;;;;;;;;;GASG;AACH,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC9B,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC9C,OAAO,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC7C;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAkFD;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,iBAAiB,CAAC,EACvC,YAAY,EAAE,MAAM,GACnB,MAAM,CAER;AAED;;;;GAIG;AACH,UAAU,WAAW;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,sBAAsB,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,mFAAmF;IACnF,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED,UAAU,YAAY;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,UAAU,kBAAkB;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;CACd;AA2DD,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,GAAG,WAAW,CAAC;AAErF,8FAA8F;AAC9F,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd;AAED,0FAA0F;AAC1F,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,0DAA0D;IAC1D,QAAQ,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,YAAY,EAAE,IAAI,CAAC;IACnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;CACxB;AAED,sGAAsG;AACtG,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,CAAC;AA0C/D,sCAAsC;AACtC,wBAAgB,OAAO,CAAC,EAAE,EAAE,IAAI,GAAG,MAAM,CAIxC;AAWD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,MAAM,CAG5E;AAqCD,UAAU,eAAe;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,0FAA0F;IAC1F,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,IAAI,EAAE,UAAU,CAAC;IACjB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,yDAAyD;IACzD,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,wBAAyB,SAAQ,eAAe;IAC/D,IAAI,EAAE,UAAU,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,mGAAmG;IACnG,UAAU,EAAE,MAAM,CAAC;IACnB,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,mFAAmF;IACnF,WAAW,CAAC,EAAE,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,uBAAwB,SAAQ,eAAe;IAC9D,IAAI,EAAE,UAAU,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,mEAAmE;IACnE,KAAK,EAAE,MAAM,CAAC;IACd,6FAA6F;IAC7F,WAAW,CAAC,EAAE,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D,KAAK,EAAE,gBAAgB,CAAC;IACxB,QAAQ,EAAE,cAAc,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC3B,QAAQ,EAAE,cAAc,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAyB,SAAQ,eAAe;IAC/D,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC3B,QAAQ,EAAE,cAAc,CAAC;IACzB,IAAI,EAAE,CAAC,GAAG,EAAE,CAAC;CACd;AA6ND,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D,4CAA4C;IAC5C,YAAY,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,6EAA6E;AAC7E,eAAO,MAAM,2BAA2B,qBAAqB,CAAC;AAE9D,MAAM,WAAW,+BAAgC,SAAQ,eAAe;IACtE,wCAAwC;IACxC,SAAS,EAAE,IAAI,CAAC;IAChB,gDAAgD;IAChD,QAAQ,EAAE,EAAE,GAAG,CAAC,CAAC;CAClB;AAED,MAAM,WAAW,0BAA2B,SAAQ,eAAe;IACjE,4DAA4D;IAC5D,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC;IACjB,sFAAsF;IACtF,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,iGAAiG;IACjG,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AA8PD,6FAA6F;AAC7F,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;CACvB;AAQD,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,WAAW,GAAG,aAAa,CAEnE;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,CAE3D;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,CAE3D;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,YAAY,GAAG,aAAa,CAErE;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAE7D;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAE7D;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,kBAAkB,GAAG,aAAa,CAEjF;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,kBAAkB,GAAG,MAAM,CAEzE;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,gBAAgB,GAAG,aAAa,CAExE;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,wBAAwB,GAAG,aAAa,CAExF;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,uBAAuB,GAAG,aAAa,CAEtF;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,sBAAsB,GAAG,aAAa,CAEpF;AAED,uEAAuE;AACvE,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,sBAAsB,GAAG,UAAU,CAE1E;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,qBAAqB,GAAG,aAAa,CAElF;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,qBAAqB,GAAG,UAAU,CAExE;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,wBAAwB,GAAG,aAAa,CAExF;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,wBAAwB,GAAG,UAAU,CAE9E;AAED,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,oBAAoB,GAAG,aAAa,CAEhF;AAED,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,0BAA0B,GAAG,aAAa,CAE5F;AAED,wBAAgB,gCAAgC,CAC9C,KAAK,EAAE,+BAA+B,GACrC,aAAa,CAEf"}