@reddoorla/maintenance 0.6.8 → 0.8.0

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { S as Site, b as AuditResult, a as AuditName, c as RecipeResult, R as RecipeName, I as InventoryProvider } from './sync-configs-pMPW4wTq.js';
 export { C as ConfigName, d as SyncConfigsOptions, s as syncConfigs } from './sync-configs-pMPW4wTq.js';
+import * as airtable_lib_airtable_base_js from 'airtable/lib/airtable_base.js';
 
 type SpawnResult = {
     code: number;
@@ -91,4 +92,206 @@ declare function localPath(path: string, opts?: LocalPathOptions): InventoryProv
 
 declare function fromJsonFile(path: string): InventoryProvider;
 
-export { ALL_AUDIT_NAMES, ALL_RECIPE_NAMES, AuditName, AuditResult, type BumpDepsOptions, type ConvertToPnpmOptions, InventoryProvider, type LocalPathOptions, type OnboardAudit, type OnboardOptions, RecipeName, RecipeResult, Site, type UpgradeSvelte4to5Options, a11yAudit, bumpDeps, convertToPnpm, depsAudit, fromJsonFile, isRecipeName, lighthouseAudit, lintAudit, localPath, onboard, runAudits, runAuditsAcross, securityAudit, svelteCodemods, upgradeSvelte4to5 };
+type AirtableConfig = {
+    apiKey: string;
+    baseId: string;
+};
+type AirtableBase = ReturnType<typeof openBase>;
+declare function openBase(cfg: AirtableConfig): airtable_lib_airtable_base_js.AirtableBase;
+
+type AirtableInventoryOptions = {
+    /**
+     * Local workdir to compute each site's path as `{workdir}/{slug}`.
+     * Defaults to REDDOOR_FLEET_WORKDIR env var if not provided.
+     * Airtable doesn't store local checkout paths, so this is required.
+     */
+    workdir?: string;
+};
+/**
+ * Read sites from the Airtable Websites table as an InventoryProvider.
+ * Each row becomes one Site; `path` is computed as `{workdir}/{slug}`.
+ * Sites where BOTH maintenance freq AND testing freq are "None" are excluded
+ * (they're inactive — no scheduled audits or reports).
+ *
+ * Note: `repoUrl` is set to the production URL (Websites.url). For sites
+ * cloned via `--workdir` semantics this is wrong — the convention should be
+ * tightened (e.g. add a `repo` field to Websites) when fleet-clone-from-
+ * airtable becomes a real flow. For local audits where the site is already
+ * checked out at `path`, the `repoUrl` is unused.
+ */
+declare function fromAirtableBase(base: AirtableBase, opts?: AirtableInventoryOptions): InventoryProvider;
+
+type ReportType = "Maintenance" | "Testing";
+type LighthouseScores = {
+    performance: number;
+    accessibility: number;
+    bestPractices: number;
+    seo: number;
+};
+type HeaderImage = {
+    /** Stable filename, used as the CID inside the email and as the attachment name in Resend. */
+    filename: string;
+    /** Bytes of the image, fetched once from Airtable before render+send. */
+    bytes: Uint8Array;
+    /** MIME, e.g. "image/jpeg". */
+    contentType: string;
+};
+/** Everything the template needs to render one report email. */
+type ReportData = {
+    siteName: string;
+    siteUrl: string;
+    reportType: ReportType;
+    completedOn: Date;
+    lighthouse: LighthouseScores;
+    gaUsersCurrent: number;
+    gaUsersPrevious: number;
+    /** Only used when reportType === "Maintenance"; the date shown next to the blurred-testing image. */
+    lastTestedDate: Date | null;
+    /** Optional free-text rendered as a section above the footer. */
+    commentary: string | null;
+    /** Used in the header `mj-image src`; the email attaches the bytes with this CID. */
+    headerImageCid: string;
+};
+
+type Frequency = "None" | "Monthly" | "Quarterly" | "Yearly";
+type Status = "in development" | "launch period" | "maintenance" | "hosting" | "probably not our problem" | "deprecated";
+type WebsiteRow = {
+    id: string;
+    name: string;
+    url: string;
+    status: Status | null;
+    pointOfContact: string | null;
+    maintenanceFreq: Frequency;
+    testingFreq: Frequency;
+    /** Last manually-recorded maintenance day (used as fallback when no Reports row exists). */
+    maintenanceDay: string | null;
+    testingDay: string | null;
+    ga4PropertyId: string | null;
+    reportRecipientsTo: string | null;
+    reportRecipientsCc: string | null;
+    /** First attachment in the Header image field (Airtable's signed URL — fetch before expiry). */
+    headerImage: {
+        url: string;
+        filename: string;
+        type: string;
+    } | null;
+    /** Lighthouse "current state" snapshot, kept fresh by `audit lighthouse --write-airtable`. */
+    pScore: number | null;
+    rScore: number | null;
+    bpScore: number | null;
+    seoScore: number | null;
+    /** ISO timestamp set by `audit lighthouse --write-airtable` when scores were last refreshed. */
+    lastLighthouseAuditAt: string | null;
+};
+
+type DeliveryStatus = "pending" | "delivered" | "bounced" | "complained";
+type ReportRow = {
+    id: string;
+    reportId: string;
+    siteId: string;
+    reportType: ReportType;
+    periodStart: string | null;
+    periodEnd: string | null;
+    completedOn: string | null;
+    lighthouse: LighthouseScores | null;
+    gaUsersCurrent: number | null;
+    gaUsersPrevious: number | null;
+    lastTestedDate: string | null;
+    commentary: string | null;
+    subjectOverride: string | null;
+    draftReady: boolean;
+    approvedToSend: boolean;
+    sentAt: string | null;
+    deliveryStatus: DeliveryStatus;
+    renderedHtmlAttachment: {
+        url: string;
+        filename: string;
+    } | null;
+    /** Read out of the Resend response and stored in a hidden field; needed for webhook reconciliation. */
+    resendMessageId: string | null;
+};
+
+type DraftOptions = {
+    /** Where to write the local preview HTML when `previewOnly`. Defaults to `reports/<slug>/draft.html`. */
+    previewPath?: string;
+    /** If true: render locally only, never touch Airtable. */
+    previewOnly?: boolean;
+};
+type DraftResult = {
+    /** null when previewOnly. */
+    reportRow: ReportRow | null;
+    /** Path to the local preview file (only set when previewOnly). */
+    htmlPath: string | null;
+    /** Always present — the rendered HTML string. */
+    html: string;
+};
+declare function draftReportForSite(base: AirtableBase | null, siteRow: WebsiteRow, reportType: ReportType, options?: DraftOptions): Promise<DraftResult>;
+
+type ResendSendInput = {
+    from: string;
+    to: string[];
+    cc?: string[];
+    replyTo?: string;
+    subject: string;
+    html: string;
+    attachments?: Array<{
+        filename: string;
+        content: string;
+        contentType?: string;
+        /** Setting this attaches the file as inline; reference it from HTML as `src="cid:<id>"`. */
+        inlineContentId?: string;
+    }>;
+    /**
+     * Stable key forwarded as the `Idempotency-Key` header. Resend dedupes calls
+     * with the same key for 24 hours, returning the original message id. Use a
+     * key that's stable across retries of the same logical send (e.g. the
+     * Reports row id), so a network blip during stamping doesn't cause a
+     * duplicate email to the client.
+     */
+    idempotencyKey?: string;
+};
+type ResendSendResult = {
+    messageId: string;
+};
+type ResendClient = {
+    send: (input: ResendSendInput) => Promise<ResendSendResult>;
+};
+
+type OrchestrateOptions = {
+    resend?: ResendClient;
+};
+declare function sendApprovedReports(options?: OrchestrateOptions): Promise<{
+    output: string;
+    code: number;
+}>;
+
+type RenderResult = {
+    html: string;
+    warnings: Array<{
+        line: number;
+        message: string;
+    }>;
+};
+declare function renderReportHtml(data: ReportData): Promise<RenderResult>;
+
+type DueItem = {
+    site: WebsiteRow;
+    reportType: ReportType;
+    /** Inclusive: the day the next report became due. */
+    dueDate: Date;
+    /** ISO date of the last `Sent at` for this (site, type), or null if there's never been one. */
+    lastSent: string | null;
+};
+/**
+ * Computes which (site, type) pairs are due as of `today`.
+ *
+ * Algorithm per (site, type):
+ *  1. If freq === "None", skip.
+ *  2. baseDate = max(last Sent at for this type, site's `maintenance/testing day` fallback).
+ *  3. If no baseDate exists at all, the site is due now.
+ *  4. dueDate = baseDate + frequency months.
+ *  5. Due iff startOfDay(today) >= startOfDay(dueDate).
+ */
+declare function findDueReports(websites: WebsiteRow[], reports: ReportRow[], today: Date): DueItem[];
+
+export { ALL_AUDIT_NAMES, ALL_RECIPE_NAMES, type AirtableInventoryOptions, AuditName, AuditResult, type BumpDepsOptions, type ConvertToPnpmOptions, type DraftOptions, type DraftResult, type DueItem, type HeaderImage, InventoryProvider, type LighthouseScores, type LocalPathOptions, type OnboardAudit, type OnboardOptions, type OrchestrateOptions, RecipeName, RecipeResult, type RenderResult, type ReportData, type ReportType, Site, type UpgradeSvelte4to5Options, a11yAudit, bumpDeps, convertToPnpm, depsAudit, draftReportForSite, findDueReports, fromAirtableBase, fromJsonFile, isRecipeName, lighthouseAudit, lintAudit, localPath, onboard, renderReportHtml, runAudits, runAuditsAcross, securityAudit, sendApprovedReports, svelteCodemods, upgradeSvelte4to5 };