@supportpages.io/wtfm 0.0.0-stage → 0.3.0

package/dist/local-setup.d.ts

@@ -0,0 +1,208 @@
+import { z } from 'zod';
+import { Workspace } from './workspace.js';
+export declare const sectionProposal: z.ZodObject<{
+    name: z.ZodString;
+    slug: z.ZodString;
+    description: z.ZodDefault<z.ZodString>;
+    icon: z.ZodDefault<z.ZodString>;
+    justification: z.ZodOptional<z.ZodString>;
+    id: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const recommendation: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+    description: z.ZodString;
+    previous_titles: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    justification: z.ZodDefault<z.ZodString>;
+    type: z.ZodDefault<z.ZodEnum<{
+        "how-to": "how-to";
+        troubleshooting: "troubleshooting";
+        concept: "concept";
+        faq: "faq";
+    }>>;
+    section_id: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    section_slug: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    status: z.ZodDefault<z.ZodEnum<{
+        pending: "pending";
+        dismissed: "dismissed";
+        completed: "completed";
+    }>>;
+}, z.core.$strip>;
+export declare const planSchema: z.ZodObject<{
+    version: z.ZodLiteral<1>;
+    project_id: z.ZodString;
+    sections: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        slug: z.ZodString;
+        description: z.ZodDefault<z.ZodString>;
+        icon: z.ZodDefault<z.ZodString>;
+        justification: z.ZodOptional<z.ZodString>;
+        id: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    sections_generated: z.ZodDefault<z.ZodBoolean>;
+    section_suggestions: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        slug: z.ZodString;
+        description: z.ZodDefault<z.ZodString>;
+        icon: z.ZodDefault<z.ZodString>;
+        justification: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    dismissed_section_slugs: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    recommendations: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        description: z.ZodString;
+        previous_titles: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        justification: z.ZodDefault<z.ZodString>;
+        type: z.ZodDefault<z.ZodEnum<{
+            "how-to": "how-to";
+            troubleshooting: "troubleshooting";
+            concept: "concept";
+            faq: "faq";
+        }>>;
+        section_id: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+        section_slug: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+        status: z.ZodDefault<z.ZodEnum<{
+            pending: "pending";
+            dismissed: "dismissed";
+            completed: "completed";
+        }>>;
+    }, z.core.$strip>>>;
+    recommendations_generated: z.ZodDefault<z.ZodBoolean>;
+    feature_inventory: z.ZodDefault<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+}, z.core.$strip>;
+export type LocalPlan = z.infer<typeof planSchema>;
+export declare const cacheFiles: string[];
+export declare function projectCacheFiles(codebaseDir?: string): string[];
+/** detect-project names the app type an incomplete map needs; that is the recovery hint. */
+export declare function requiredAppType(block?: string | null): string | undefined;
+/** Shared by the CLI and MCP: a successful agent message is not a readiness check. */
+export declare class LocalSetup {
+    ws: Workspace;
+    root: string;
+    constructor(ws: Workspace, root: string);
+    validate(outputDir: string, codebaseDir?: string): Promise<{
+        codebase_dir: string;
+        branding: {
+            [x: string]: unknown;
+            framework: string;
+        };
+        map: {
+            [x: string]: unknown;
+            framework: string;
+            app_type: "win32" | "web" | "terminal" | "mobile" | "desktop" | "macos" | "game";
+            route_index: Record<string, unknown> | unknown[];
+            dir_map?: Record<string, unknown> | undefined;
+        };
+        detection: {
+            [x: string]: unknown;
+            detection_status?: string | undefined;
+            detection_block?: string | null | undefined;
+            app_type_source?: string | undefined;
+        };
+        hashes: Record<string, string>;
+        summary: string;
+        overview: string;
+    }>;
+    accept(outputDir: string, agent: string, skillsVersion: string, sourceCommit?: string | null, codebaseDir?: string): Promise<{
+        codebase_dir: string;
+        branding: {
+            [x: string]: unknown;
+            framework: string;
+        };
+        map: {
+            [x: string]: unknown;
+            framework: string;
+            app_type: "win32" | "web" | "terminal" | "mobile" | "desktop" | "macos" | "game";
+            route_index: Record<string, unknown> | unknown[];
+            dir_map?: Record<string, unknown> | undefined;
+        };
+        detection: {
+            [x: string]: unknown;
+            detection_status?: string | undefined;
+            detection_block?: string | null | undefined;
+            app_type_source?: string | undefined;
+        };
+        hashes: Record<string, string>;
+        summary: string;
+        overview: string;
+    }>;
+    analysis(): Promise<{
+        status: "required";
+        completed_at?: undefined;
+        skills_version?: undefined;
+        output_dir?: undefined;
+        source_commit?: undefined;
+        codebase_dir?: undefined;
+        summary?: undefined;
+        overview?: undefined;
+        app_type?: undefined;
+        framework?: undefined;
+    } | {
+        status: "invalid";
+        completed_at?: undefined;
+        skills_version?: undefined;
+        output_dir?: undefined;
+        source_commit?: undefined;
+        codebase_dir?: undefined;
+        summary?: undefined;
+        overview?: undefined;
+        app_type?: undefined;
+        framework?: undefined;
+    } | {
+        status: "ready";
+        completed_at: string;
+        skills_version: string;
+        output_dir: string;
+        source_commit: string | null;
+        codebase_dir: string;
+        summary: string;
+        overview: string;
+        app_type: "win32" | "web" | "terminal" | "mobile" | "desktop" | "macos" | "game";
+        framework: string;
+    } | {
+        status: "invalid";
+        error: {
+            code: string;
+            message: string;
+            details: unknown;
+        } | {
+            code: string;
+            message: string;
+            details?: undefined;
+        };
+        completed_at?: undefined;
+        skills_version?: undefined;
+        output_dir?: undefined;
+        source_commit?: undefined;
+        codebase_dir?: undefined;
+        summary?: undefined;
+        overview?: undefined;
+        app_type?: undefined;
+        framework?: undefined;
+    }>;
+    requireAnalysis(): Promise<{
+        status: "ready";
+        completed_at: string;
+        skills_version: string;
+        output_dir: string;
+        source_commit: string | null;
+        codebase_dir: string;
+        summary: string;
+        overview: string;
+        app_type: "win32" | "web" | "terminal" | "mobile" | "desktop" | "macos" | "game";
+        framework: string;
+    }>;
+    progress(): Promise<{
+        progress_source: "last_reported";
+        skill: "generate-illustrated-article" | "detect-project" | "suggest-sections" | "recommend-articles";
+        status: "running" | "failed" | "cancelled" | "completed";
+        started_at: string;
+        finished_at?: string | undefined;
+        total?: number | undefined;
+        completed?: number | undefined;
+        failed?: number | undefined;
+    } | null>;
+    plan(projectId: string): Promise<LocalPlan>;
+    savePlan(plan: LocalPlan): Promise<void>;
+}

package/dist/local-setup.js

@@ -0,0 +1,140 @@
+import { createHash } from 'node:crypto';
+import { z } from 'zod';
+import { fail, publicError } from './errors.js';
+import { articleType, remoteId } from './schema.js';
+import { CLI_NAME } from './brand.js';
+const text = z.string().trim().min(1).max(500);
+export const sectionProposal = z.object({ name: text, slug: z.string().regex(/^[a-z0-9]+(?:-[a-z0-9]+)*$/).max(120),
+    description: z.string().max(5000).default(''), icon: z.string().max(100).default('document-text'), justification: z.string().max(5000).optional(), id: remoteId.optional() });
+export const recommendation = z.object({ id: z.string().max(100), title: text, description: z.string().max(10000),
+    previous_titles: z.array(text).max(100).default([]),
+    justification: z.string().max(10000).default(''), type: articleType.default('how-to'), section_id: remoteId.nullable().default(null),
+    section_slug: z.string().nullable().default(null), status: z.enum(['pending', 'dismissed', 'completed']).default('pending') });
+export const planSchema = z.object({ version: z.literal(1), project_id: remoteId,
+    sections: z.array(sectionProposal).max(1000).default([]), sections_generated: z.boolean().default(false),
+    section_suggestions: z.array(sectionProposal.omit({ id: true })).max(1000).default([]),
+    dismissed_section_slugs: z.array(z.string().max(120)).max(1000).default([]),
+    recommendations: z.array(recommendation).max(2000).default([]), recommendations_generated: z.boolean().default(false),
+    feature_inventory: z.array(z.record(z.string(), z.unknown())).max(2000).default([]) });
+const receiptSchema = z.object({ version: z.literal(1), workspace: z.string(), output_dir: z.string(), completed_at: z.string(),
+    codebase_dir: z.string().default('.'),
+    skills_version: z.string(), agent: z.string(), source_commit: z.string().nullable().optional(), hashes: z.record(z.string(), z.string()) });
+export const cacheFiles = ['.rtfm/branding.json', '.rtfm/project_map.json', '.rtfm/branding.css'];
+export function projectCacheFiles(codebaseDir = '.') {
+    return cacheFiles.map(file => codebaseDir === '.' ? file : `${codebaseDir}/${file}`);
+}
+const sha = (data) => createHash('sha256').update(data).digest('hex');
+/** detect-project names the app type an incomplete map needs; that is the recovery hint. */
+export function requiredAppType(block) {
+    return /(?<![\w])app_type=([a-z0-9]+)/i.exec(block ?? '')?.[1]?.toLowerCase();
+}
+/** Shared by the CLI and MCP: a successful agent message is not a readiness check. */
+export class LocalSetup {
+    ws;
+    root;
+    constructor(ws, root) {
+        this.ws = ws;
+        this.root = root;
+    }
+    async validate(outputDir, codebaseDir) {
+        if (outputDir !== 'output/detect-project' && !outputDir.startsWith(`${this.root}/setup/tasks/`))
+            fail('invalid_analysis', 'Analysis output must belong to this workspace.');
+        if (codebaseDir === undefined && await this.ws.exists(`${outputDir}/analysis-target.json`)) {
+            codebaseDir = z.object({ codebase_dir: z.string() }).parse(await this.ws.json(`${outputDir}/analysis-target.json`)).codebase_dir;
+        }
+        codebaseDir ??= '.';
+        if (codebaseDir !== '.' && (!codebaseDir || codebaseDir.split('/').some(part => !part || part === '.' || part === '..') || codebaseDir.includes('\\')))
+            fail('invalid_analysis', 'The analysed application must be a directory inside this workspace.');
+        await this.ws.resolve(codebaseDir);
+        const filesForProject = projectCacheFiles(codebaseDir);
+        const branding = z.object({ framework: text }).passthrough().parse(await this.ws.json(filesForProject[0]));
+        const index = z.union([z.array(z.unknown()), z.record(z.string(), z.unknown())]);
+        const map = z.object({ framework: text, app_type: z.enum(['web', 'terminal', 'mobile', 'desktop', 'win32', 'macos', 'game']).default('web'),
+            route_index: index, dir_map: z.record(z.string(), z.unknown()).optional() }).passthrough().parse(await this.ws.json(filesForProject[1]));
+        // detect-project stamps its own verdict. A map that says it could not finish
+        // must not pass as ready: the article skill then refuses the wrong app_type and
+        // the run fails far from the cause.
+        const detection = z.object({ detection_status: z.string().optional(), detection_block: z.string().nullish(), app_type_source: z.string().optional() })
+            .passthrough().parse(await this.ws.json(filesForProject[1]));
+        if (detection.detection_status === 'incomplete') {
+            fail('analysis_incomplete', detection.detection_block?.trim() || 'Project detection reported an incomplete result. Rerun it with the app type it requires.', { app_type: requiredAppType(detection.detection_block) });
+        }
+        const capability = { terminal: 'command_index', mobile: 'screen_index', win32: 'dialog_index', macos: 'view_index' }[map.app_type];
+        if (capability && !Object.keys(index.parse(map[capability])).length)
+            fail('invalid_analysis', `Analysis must include a nonempty ${capability}.`);
+        if (!capability && (map.app_type !== 'web' || map.dir_map?.routes) && !Object.keys(map.route_index).length)
+            fail('invalid_analysis', 'Analysis must index the project’s user-facing routes or screens.');
+        const files = [...filesForProject, `${outputDir}/summary.md`, `${outputDir}/overview.txt`];
+        const hashes = {};
+        for (const file of files) {
+            const bytes = await this.ws.read(file, file.endsWith('.css') ? 10 * 1024 * 1024 : 2 * 1024 * 1024);
+            if (!bytes.toString('utf8').trim())
+                fail('invalid_analysis', `Analysis output is empty: ${file}`);
+            hashes[file] = sha(bytes);
+        }
+        return { codebase_dir: codebaseDir, branding, map, detection, hashes, summary: (await this.ws.read(`${outputDir}/summary.md`)).toString(), overview: (await this.ws.read(`${outputDir}/overview.txt`)).toString() };
+    }
+    async accept(outputDir, agent, skillsVersion, sourceCommit = null, codebaseDir) {
+        const valid = await this.validate(outputDir, codebaseDir);
+        await this.ws.writeJson(`${this.root}/setup/analysis.json`, { version: 1, workspace: this.ws.root, output_dir: outputDir,
+            codebase_dir: valid.codebase_dir,
+            completed_at: new Date().toISOString(), skills_version: skillsVersion, agent, source_commit: sourceCommit, hashes: valid.hashes });
+        return valid;
+    }
+    async analysis() {
+        try {
+            if (!await this.ws.exists(`${this.root}/setup/analysis.json`))
+                return { status: 'required' };
+            const receipt = receiptSchema.parse(await this.ws.json(`${this.root}/setup/analysis.json`));
+            if (receipt.workspace !== this.ws.root)
+                return { status: 'required' };
+            const valid = await this.validate(receipt.output_dir, receipt.codebase_dir);
+            // Generator skills legitimately enrich the shared branding/structure cache.
+            // The accepted full analysis itself must remain intact.
+            if (Object.entries(valid.hashes).some(([file, hash]) => !projectCacheFiles(receipt.codebase_dir).includes(file) && receipt.hashes[file] !== hash))
+                return { status: 'invalid' };
+            return { status: 'ready', completed_at: receipt.completed_at, skills_version: receipt.skills_version,
+                output_dir: receipt.output_dir, source_commit: receipt.source_commit ?? null,
+                codebase_dir: receipt.codebase_dir,
+                summary: valid.summary, overview: valid.overview, app_type: valid.map.app_type, framework: valid.branding.framework };
+        }
+        catch (error) {
+            // Keep the reason: an incomplete detection tells the user exactly what to rerun.
+            const safe = publicError(error);
+            return { status: 'invalid', error: safe, ...(safe.details && typeof safe.details === 'object' ? safe.details : {}) };
+        }
+    }
+    async requireAnalysis() {
+        const analysis = await this.analysis();
+        if (analysis.status !== 'ready') {
+            const appType = analysis.app_type;
+            fail('analysis_required', analysis.status === 'invalid' && 'error' in analysis && analysis.error?.message
+                ? `Project analysis is not usable: ${analysis.error.message}`
+                : `Analyse this workspace first: run ${CLI_NAME} analyse in its terminal.`, appType ? { app_type: appType, rerun: `${CLI_NAME} analyse --app-type ${appType}` } : undefined);
+        }
+        return analysis;
+    }
+    async progress() {
+        try {
+            const task = z.object({ skill: z.enum(['detect-project', 'suggest-sections', 'recommend-articles', 'generate-illustrated-article']),
+                status: z.enum(['running', 'completed', 'cancelled', 'failed']), started_at: z.string(), finished_at: z.string().optional(),
+                total: z.number().int().optional(), completed: z.number().int().optional(), failed: z.number().int().optional() })
+                .parse(await this.ws.json(`${this.root}/setup/task.json`));
+            return { ...task, progress_source: 'last_reported' };
+        }
+        catch {
+            return null;
+        }
+    }
+    async plan(projectId) {
+        const file = `${this.root}/setup/plan.json`;
+        if (!await this.ws.exists(file))
+            return planSchema.parse({ version: 1, project_id: projectId });
+        const plan = planSchema.parse(await this.ws.json(file));
+        if (plan.project_id !== projectId)
+            fail('destination_mismatch', 'The local plan belongs to a different help centre.');
+        return plan;
+    }
+    async savePlan(plan) { await this.ws.writeJson(`${this.root}/setup/plan.json`, planSchema.parse(plan)); }
+}
+//# sourceMappingURL=local-setup.js.map

package/dist/local-setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-setup.js","sourceRoot":"","sources":["../src/local-setup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAC/C,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACjH,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,EAAE,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAChL,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC;IAC/G,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACnD,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IACpI,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;AACjI,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,QAAQ;IAC9E,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACxG,mBAAmB,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACtF,uBAAuB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IAC3E,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,yBAAyB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACrH,iBAAiB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;AAEzF,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IAC7H,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC;IACrC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;AAC9I,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,qBAAqB,EAAE,wBAAwB,EAAE,oBAAoB,CAAC,CAAC;AAClG,MAAM,UAAU,iBAAiB,CAAC,WAAW,GAAG,GAAG;IACjD,OAAO,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,WAAW,IAAI,IAAI,EAAE,CAAC,CAAC;AACvF,CAAC;AACD,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAE9E,4FAA4F;AAC5F,MAAM,UAAU,eAAe,CAAC,KAAqB;IACnD,OAAO,gCAAgC,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;AAChF,CAAC;AAED,sFAAsF;AACtF,MAAM,OAAO,UAAU;IACF;IAAsB;IAAzC,YAAmB,EAAa,EAAS,IAAY;QAAlC,OAAE,GAAF,EAAE,CAAW;QAAS,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IACzD,KAAK,CAAC,QAAQ,CAAC,SAAiB,EAAE,WAAoB;QACpD,IAAI,SAAS,KAAK,uBAAuB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,IAAI,eAAe,CAAC;YAAE,IAAI,CAAC,kBAAkB,EAAE,gDAAgD,CAAC,CAAC;QAC5K,IAAI,WAAW,KAAK,SAAS,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,SAAS,uBAAuB,CAAC,EAAE,CAAC;YAC3F,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,SAAS,uBAAuB,CAAC,CAAC,CAAC,YAAY,CAAC;QACnI,CAAC;QACD,WAAW,KAAK,GAAG,CAAC;QACpB,IAAI,WAAW,KAAK,GAAG,IAAI,CAAC,CAAC,WAAW,IAAI,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,IAAI,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAAE,IAAI,CAAC,kBAAkB,EAAE,qEAAqE,CAAC,CAAC;QACxP,MAAM,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACnC,MAAM,eAAe,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;QACvD,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC;QAC5G,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QACjF,MAAM,GAAG,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;YACzI,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC;QAC5I,6EAA6E;QAC7E,gFAAgF;QAChF,oCAAoC;QACpC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;aACnJ,WAAW,EAAE,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC;QAChE,IAAI,SAAS,CAAC,gBAAgB,KAAK,YAAY,EAAE,CAAC;YAChD,IAAI,CAAC,qBAAqB,EAAE,SAAS,CAAC,eAAe,EAAE,IAAI,EAAE,IAAI,0FAA0F,EAAE,EAAE,QAAQ,EAAE,eAAe,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QACzN,CAAC;QACD,MAAM,UAAU,GAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,YAAY,EAA6B,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC/J,IAAI,UAAU,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM;YAAE,IAAI,CAAC,kBAAkB,EAAE,oCAAoC,UAAU,GAAG,CAAC,CAAC;QACjJ,IAAI,CAAC,UAAU,IAAI,CAAC,GAAG,CAAC,QAAQ,KAAK,KAAK,IAAI,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,MAAM;YAAE,IAAI,CAAC,kBAAkB,EAAE,kEAAkE,CAAC,CAAC;QACzM,MAAM,KAAK,GAAG,CAAC,GAAG,eAAe,EAAE,GAAG,SAAS,aAAa,EAAE,GAAG,SAAS,eAAe,CAAC,CAAC;QAC3F,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;YACnG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE;gBAAE,IAAI,CAAC,kBAAkB,EAAE,6BAA6B,IAAI,EAAE,CAAC,CAAC;YAClG,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,SAAS,aAAa,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,SAAS,eAAe,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;IACtN,CAAC;IACD,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,KAAa,EAAE,aAAqB,EAAE,eAA8B,IAAI,EAAE,WAAoB;QAC5H,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QAC1D,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,sBAAsB,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS;YACtH,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,YAAY,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;QACrI,OAAO,KAAK,CAAC;IACf,CAAC;IACD,KAAK,CAAC,QAAQ;QACZ,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,sBAAsB,CAAC;gBAAE,OAAO,EAAE,MAAM,EAAE,UAAmB,EAAE,CAAC;YACtG,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,sBAAsB,CAAC,CAAC,CAAC;YAC5F,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,EAAE,CAAC,IAAI;gBAAE,OAAO,EAAE,MAAM,EAAE,UAAmB,EAAE,CAAC;YAC/E,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;YAC5E,4EAA4E;YAC5E,wDAAwD;YACxD,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;gBAAE,OAAO,EAAE,MAAM,EAAE,SAAkB,EAAE,CAAC;YACzL,OAAO,EAAE,MAAM,EAAE,OAAgB,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc;gBAC3G,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,aAAa,EAAE,OAAO,CAAC,aAAa,IAAI,IAAI;gBAC5E,YAAY,EAAE,OAAO,CAAC,YAAY;gBAClC,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;QAC1H,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,iFAAiF;YACjF,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;YAChC,OAAO,EAAE,MAAM,EAAE,SAAkB,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAkC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;QAC3J,CAAC;IACH,CAAC;IACD,KAAK,CAAC,eAAe;QACnB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACvC,IAAI,QAAQ,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;YAChC,MAAM,OAAO,GAAI,QAAkC,CAAC,QAAQ,CAAC;YAC7D,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,IAAI,QAAQ,IAAI,QAAQ,CAAC,KAAK,EAAE,OAAO;gBACvG,CAAC,CAAC,mCAAmC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE;gBAC7D,CAAC,CAAC,qCAAqC,QAAQ,2BAA2B,EAC5E,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,QAAQ,uBAAuB,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACnG,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,KAAK,CAAC,QAAQ;QACZ,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,8BAA8B,CAAC,CAAC;gBACjI,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;gBAC3H,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;iBACjH,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC;YAC7D,OAAO,EAAE,GAAG,IAAI,EAAE,eAAe,EAAE,eAAwB,EAAE,CAAC;QAChE,CAAC;QAAC,MAAM,CAAC;YAAC,OAAO,IAAI,CAAC;QAAC,CAAC;IAC1B,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,SAAiB;QAC1B,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,kBAAkB,CAAC;QAC5C,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;YAAE,OAAO,UAAU,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;QAChG,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACxD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;YAAE,IAAI,CAAC,sBAAsB,EAAE,oDAAoD,CAAC,CAAC;QACtH,OAAO,IAAI,CAAC;IACd,CAAC;IACD,KAAK,CAAC,QAAQ,CAAC,IAAe,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,kBAAkB,EAAE,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;CACrH"}

package/dist/pairing.d.ts

@@ -0,0 +1,71 @@
+import { z } from 'zod';
+declare const deliverySchema: z.ZodObject<{
+    status: z.ZodLiteral<"authorized">;
+    api_origin: z.ZodString;
+    account: z.ZodObject<{
+        id: z.ZodString;
+        email: z.ZodString;
+    }, z.core.$strip>;
+    token: z.ZodString;
+    scopes: z.ZodArray<z.ZodEnum<{
+        read: "read";
+        import: "import";
+        publish: "publish";
+        manage: "manage";
+        generate: "generate";
+        "projects:create": "projects:create";
+    }>>;
+    token_expires_at: z.ZodISODateTime;
+}, z.core.$strip>;
+export type Delivery = z.infer<typeof deliverySchema>;
+export type Approval = {
+    url: string;
+    code: string;
+    id: string;
+};
+export type PairingRuntime = {
+    fetcher: typeof fetch;
+    now: () => number;
+    sleep: (ms: number) => Promise<void>;
+};
+export declare const REQUIRED_SCOPES: readonly ["read", "import", "projects:create"];
+/** Offered alongside the required ones at every sign-in. The approval page is
+ * where the user decides what to grant; sending them back to the browser
+ * mid-task for one more box is worse than one informed decision up front. */
+export declare const OPTIONAL_SCOPES: readonly ["publish", "manage", "generate"];
+/** Device sign-in. Bootstrap secrets and delivery responses never leave this native process. */
+export declare class Pairing {
+    private origin;
+    private dev;
+    private rt;
+    private secret;
+    private id;
+    private deadline;
+    private interval;
+    private stopped;
+    private done?;
+    private failure?;
+    private status;
+    private approval?;
+    private approvalOrigin;
+    private requestedScopes;
+    constructor(origin: string, dev: boolean, rt?: PairingRuntime);
+    /** `label` is the device name shown on the approval page (never a filesystem path). */
+    start(label: string, options: {
+        client: 'SupportPages Writer' | 'SupportPages Writer MCP';
+    }): Promise<Approval>;
+    cancel(): void;
+    get finished(): boolean;
+    result(): {
+        status: string;
+        verification_uri: string | undefined;
+        user_code: string | undefined;
+        expires_at: string;
+        instructions: string;
+    };
+    run(save: (delivery: Delivery) => Promise<void>, completed?: () => Promise<void>): void;
+    wait(ms?: number): Promise<void>;
+    private deliver;
+    private request;
+}
+export {};