@x12i/made-easy 0.0.0-stage → 0.1.0

package/dist/contracts/api.d.ts

@@ -0,0 +1,447 @@
+import { z } from 'zod';
+/**
+ * Shared request, result and job contracts. The SDK, CLI, HTTP API, MCP tools and
+ * Studio all speak these shapes so they return the same diagnostics and content.
+ */
+export declare const ModeSchema: z.ZodEnum<{
+    draft: "draft";
+    release: "release";
+}>;
+export declare const AudienceSchema: z.ZodEnum<{
+    private: "private";
+    public: "public";
+}>;
+export declare const PaperSchema: z.ZodEnum<{
+    A4: "A4";
+    Letter: "Letter";
+}>;
+export declare const FormatSchema: z.ZodEnum<{
+    html: "html";
+    pdf: "pdf";
+}>;
+export type Paper = z.infer<typeof PaperSchema>;
+export type OutputFormat = z.infer<typeof FormatSchema>;
+export declare const FileContentSchema: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+    encoding: z.ZodEnum<{
+        utf8: "utf8";
+        base64: "base64";
+    }>;
+    content: z.ZodString;
+}, z.core.$strict>]>;
+export type FileContent = z.infer<typeof FileContentSchema>;
+/** Where a bundle comes from. `path` is honoured only by local adapters. */
+export declare const SourceRefSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"path">;
+    path: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"files">;
+    files: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        encoding: z.ZodEnum<{
+            utf8: "utf8";
+            base64: "base64";
+        }>;
+        content: z.ZodString;
+    }, z.core.$strict>]>>;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"zip">;
+    base64: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"guide">;
+    guideId: z.ZodString;
+    revision: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>], "kind">;
+export type SourceRef = z.infer<typeof SourceRefSchema>;
+export declare const CreateGuideRequestSchema: z.ZodObject<{
+    recipe: z.ZodString;
+    subject: z.ZodObject<{
+        name: z.ZodString;
+        subtitle: z.ZodOptional<z.ZodString>;
+        scope: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    guideId: z.ZodOptional<z.ZodString>;
+    jobId: z.ZodOptional<z.ZodString>;
+    locale: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type CreateGuideRequest = z.infer<typeof CreateGuideRequestSchema>;
+export declare const ValidateRequestSchema: z.ZodObject<{
+    source: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"path">;
+        path: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"files">;
+        files: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+            encoding: z.ZodEnum<{
+                utf8: "utf8";
+                base64: "base64";
+            }>;
+            content: z.ZodString;
+        }, z.core.$strict>]>>;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"zip">;
+        base64: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"guide">;
+        guideId: z.ZodString;
+        revision: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>], "kind">;
+    mode: z.ZodDefault<z.ZodEnum<{
+        draft: "draft";
+        release: "release";
+    }>>;
+    audience: z.ZodOptional<z.ZodEnum<{
+        private: "private";
+        public: "public";
+    }>>;
+}, z.core.$strict>;
+export type ValidateRequest = z.input<typeof ValidateRequestSchema>;
+export declare const DiagnosticSummarySchema: z.ZodObject<{
+    errors: z.ZodNumber;
+    warnings: z.ZodNumber;
+    infos: z.ZodNumber;
+}, z.core.$strict>;
+export declare const ValidateResultSchema: z.ZodObject<{
+    ok: z.ZodBoolean;
+    mode: z.ZodEnum<{
+        draft: "draft";
+        release: "release";
+    }>;
+    guideId: z.ZodOptional<z.ZodString>;
+    revision: z.ZodOptional<z.ZodString>;
+    referenceRevision: z.ZodOptional<z.ZodString>;
+    summary: z.ZodObject<{
+        errors: z.ZodNumber;
+        warnings: z.ZodNumber;
+        infos: z.ZodNumber;
+    }, z.core.$strict>;
+    diagnostics: z.ZodArray<z.ZodObject<{
+        code: z.ZodString;
+        severity: z.ZodEnum<{
+            error: "error";
+            warning: "warning";
+            info: "info";
+        }>;
+        path: z.ZodString;
+        message: z.ZodString;
+        line: z.ZodOptional<z.ZodNumber>;
+        column: z.ZodOptional<z.ZodNumber>;
+        blockId: z.ZodOptional<z.ZodString>;
+        pointer: z.ZodOptional<z.ZodString>;
+        hint: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strict>;
+export type ValidateResult = z.infer<typeof ValidateResultSchema>;
+export declare const PreviewRequestSchema: z.ZodObject<{
+    source: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"path">;
+        path: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"files">;
+        files: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+            encoding: z.ZodEnum<{
+                utf8: "utf8";
+                base64: "base64";
+            }>;
+            content: z.ZodString;
+        }, z.core.$strict>]>>;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"zip">;
+        base64: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"guide">;
+        guideId: z.ZodString;
+        revision: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>], "kind">;
+    track: z.ZodDefault<z.ZodEnum<{
+        human: "human";
+        operator: "operator";
+        brief: "brief";
+    }>>;
+    format: z.ZodDefault<z.ZodEnum<{
+        html: "html";
+        markdown: "markdown";
+        json: "json";
+    }>>;
+    mode: z.ZodDefault<z.ZodEnum<{
+        draft: "draft";
+        release: "release";
+    }>>;
+    audience: z.ZodOptional<z.ZodEnum<{
+        private: "private";
+        public: "public";
+    }>>;
+}, z.core.$strict>;
+export type PreviewRequest = z.input<typeof PreviewRequestSchema>;
+export declare const PreviewResultSchema: z.ZodObject<{
+    ok: z.ZodBoolean;
+    track: z.ZodString;
+    format: z.ZodString;
+    mediaType: z.ZodString;
+    revision: z.ZodOptional<z.ZodString>;
+    content: z.ZodOptional<z.ZodString>;
+    diagnostics: z.ZodArray<z.ZodObject<{
+        code: z.ZodString;
+        severity: z.ZodEnum<{
+            error: "error";
+            warning: "warning";
+            info: "info";
+        }>;
+        path: z.ZodString;
+        message: z.ZodString;
+        line: z.ZodOptional<z.ZodNumber>;
+        column: z.ZodOptional<z.ZodNumber>;
+        blockId: z.ZodOptional<z.ZodString>;
+        pointer: z.ZodOptional<z.ZodString>;
+        hint: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strict>;
+export type PreviewResult = z.infer<typeof PreviewResultSchema>;
+export declare const ArtifactDescriptorSchema: z.ZodObject<{
+    id: z.ZodString;
+    path: z.ZodString;
+    mediaType: z.ZodString;
+    size: z.ZodNumber;
+    sha256: z.ZodString;
+    url: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type ArtifactDescriptor = z.infer<typeof ArtifactDescriptorSchema>;
+export declare const BuildOptionsSchema: z.ZodObject<{
+    mode: z.ZodDefault<z.ZodEnum<{
+        draft: "draft";
+        release: "release";
+    }>>;
+    formats: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        html: "html";
+        pdf: "pdf";
+    }>>>;
+    paper: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        A4: "A4";
+        Letter: "Letter";
+    }>>>;
+    audience: z.ZodDefault<z.ZodEnum<{
+        private: "private";
+        public: "public";
+    }>>;
+    zip: z.ZodDefault<z.ZodBoolean>;
+    allowPartial: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strict>;
+export type BuildOptionsInput = z.input<typeof BuildOptionsSchema>;
+export declare const BuildRequestSchema: z.ZodObject<{
+    mode: z.ZodDefault<z.ZodEnum<{
+        draft: "draft";
+        release: "release";
+    }>>;
+    formats: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        html: "html";
+        pdf: "pdf";
+    }>>>;
+    paper: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        A4: "A4";
+        Letter: "Letter";
+    }>>>;
+    audience: z.ZodDefault<z.ZodEnum<{
+        private: "private";
+        public: "public";
+    }>>;
+    zip: z.ZodDefault<z.ZodBoolean>;
+    allowPartial: z.ZodDefault<z.ZodBoolean>;
+    source: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"path">;
+        path: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"files">;
+        files: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+            encoding: z.ZodEnum<{
+                utf8: "utf8";
+                base64: "base64";
+            }>;
+            content: z.ZodString;
+        }, z.core.$strict>]>>;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"zip">;
+        base64: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"guide">;
+        guideId: z.ZodString;
+        revision: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>], "kind">;
+}, z.core.$strict>;
+export type BuildRequest = z.input<typeof BuildRequestSchema>;
+export declare const BuildResultSchema: z.ZodObject<{
+    ok: z.ZodBoolean;
+    status: z.ZodEnum<{
+        partial: "partial";
+        succeeded: "succeeded";
+        failed: "failed";
+    }>;
+    mode: z.ZodEnum<{
+        draft: "draft";
+        release: "release";
+    }>;
+    guideId: z.ZodOptional<z.ZodString>;
+    revision: z.ZodOptional<z.ZodString>;
+    referenceRevision: z.ZodOptional<z.ZodString>;
+    visibility: z.ZodEnum<{
+        private: "private";
+        public: "public";
+    }>;
+    complete: z.ZodBoolean;
+    summary: z.ZodObject<{
+        errors: z.ZodNumber;
+        warnings: z.ZodNumber;
+        infos: z.ZodNumber;
+    }, z.core.$strict>;
+    diagnostics: z.ZodArray<z.ZodObject<{
+        code: z.ZodString;
+        severity: z.ZodEnum<{
+            error: "error";
+            warning: "warning";
+            info: "info";
+        }>;
+        path: z.ZodString;
+        message: z.ZodString;
+        line: z.ZodOptional<z.ZodNumber>;
+        column: z.ZodOptional<z.ZodNumber>;
+        blockId: z.ZodOptional<z.ZodString>;
+        pointer: z.ZodOptional<z.ZodString>;
+        hint: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    artifacts: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        path: z.ZodString;
+        mediaType: z.ZodString;
+        size: z.ZodNumber;
+        sha256: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    outDir: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type BuildResult = z.infer<typeof BuildResultSchema>;
+export declare const DraftSectionSelectionSchema: z.ZodObject<{
+    track: z.ZodDefault<z.ZodEnum<{
+        human: "human";
+        operator: "operator";
+    }>>;
+    entry: z.ZodString;
+}, z.core.$strict>;
+export declare const SourceSnapshotSchema: z.ZodObject<{
+    id: z.ZodString;
+    sources: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        version: z.ZodString;
+        locator: z.ZodString;
+        excerpt: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type SourceSnapshot = z.infer<typeof SourceSnapshotSchema>;
+export declare const DraftRequestSchema: z.ZodObject<{
+    source: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"path">;
+        path: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"files">;
+        files: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+            encoding: z.ZodEnum<{
+                utf8: "utf8";
+                base64: "base64";
+            }>;
+            content: z.ZodString;
+        }, z.core.$strict>]>>;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"zip">;
+        base64: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"guide">;
+        guideId: z.ZodString;
+        revision: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>], "kind">;
+    sections: z.ZodArray<z.ZodObject<{
+        track: z.ZodDefault<z.ZodEnum<{
+            human: "human";
+            operator: "operator";
+        }>>;
+        entry: z.ZodString;
+    }, z.core.$strict>>;
+    snapshot: z.ZodObject<{
+        id: z.ZodString;
+        sources: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+            version: z.ZodString;
+            locator: z.ZodString;
+            excerpt: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+    expectedRevision: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type DraftRequestInput = z.input<typeof DraftRequestSchema>;
+export declare const JOB_STATUSES: readonly ["queued", "running", "succeeded", "failed", "cancelled"];
+export type JobStatus = (typeof JOB_STATUSES)[number];
+export declare const JOB_KINDS: readonly ["build", "draft"];
+export type JobKind = (typeof JOB_KINDS)[number];
+export declare const JobRecordSchema: z.ZodObject<{
+    id: z.ZodString;
+    kind: z.ZodEnum<{
+        draft: "draft";
+        build: "build";
+    }>;
+    status: z.ZodEnum<{
+        succeeded: "succeeded";
+        failed: "failed";
+        queued: "queued";
+        running: "running";
+        cancelled: "cancelled";
+    }>;
+    guideId: z.ZodOptional<z.ZodString>;
+    revision: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+    cancelRequested: z.ZodOptional<z.ZodBoolean>;
+    result: z.ZodOptional<z.ZodUnknown>;
+    error: z.ZodOptional<z.ZodObject<{
+        code: z.ZodString;
+        message: z.ZodString;
+    }, z.core.$strict>>;
+    artifacts: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        path: z.ZodString;
+        mediaType: z.ZodString;
+        size: z.ZodNumber;
+        sha256: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    statusUrl: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type JobRecordView = z.infer<typeof JobRecordSchema>;
+export declare const ProblemSchema: z.ZodObject<{
+    error: z.ZodObject<{
+        code: z.ZodString;
+        message: z.ZodString;
+        diagnostics: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            code: z.ZodString;
+            severity: z.ZodEnum<{
+                error: "error";
+                warning: "warning";
+                info: "info";
+            }>;
+            path: z.ZodString;
+            message: z.ZodString;
+            line: z.ZodOptional<z.ZodNumber>;
+            column: z.ZodOptional<z.ZodNumber>;
+            blockId: z.ZodOptional<z.ZodString>;
+            pointer: z.ZodOptional<z.ZodString>;
+            hint: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+export declare const SubjectInputSchema: z.ZodObject<{
+    type: z.ZodEnum<{
+        market: "market";
+        product: "product";
+        service: "service";
+        sdk: "sdk";
+    }>;
+    name: z.ZodString;
+}, z.core.$strict>;
+export declare function artifactIdForPath(path: string): string;
+//# sourceMappingURL=api.d.ts.map

package/dist/contracts/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/contracts/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB;;;GAGG;AAEH,eAAO,MAAM,UAAU;;;EAA+B,CAAC;AACvD,eAAO,MAAM,cAAc;;;EAAgC,CAAC;AAC5D,eAAO,MAAM,WAAW;;;EAA2B,CAAC;AACpD,eAAO,MAAM,YAAY;;;EAA0B,CAAC;AACpD,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAChD,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAExD,eAAO,MAAM,iBAAiB;;;;;;oBAG5B,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,4EAA4E;AAC5E,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;4BAK1B,CAAC;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAExD,eAAO,MAAM,wBAAwB;;;;;;;;;;kBAUnC,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAIhC,CAAC;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE,eAAO,MAAM,uBAAuB;;;;kBAIlC,CAAC;AAEH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAQ/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAM/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;kBAQ9B,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,eAAO,MAAM,wBAAwB;;;;;;;kBAOnC,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;kBAO7B,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEnE,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAAyD,CAAC;AACzF,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAa5B,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,eAAO,MAAM,2BAA2B;;;;;;kBAGtC,CAAC;AAEH,eAAO,MAAM,oBAAoB;;;;;;;;;kBAa/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAK7B,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEnE,eAAO,MAAM,YAAY,oEAAqE,CAAC;AAC/F,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AACtD,eAAO,MAAM,SAAS,6BAA8B,CAAC;AACrD,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjD,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAa1B,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAE5D,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;kBAMxB,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;kBAG7B,CAAC;AAEH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEtD"}

package/dist/contracts/api.js

@@ -0,0 +1,152 @@
+import { z } from 'zod';
+import { DiagnosticSchema } from './diagnostics.js';
+import { IdSchema, SubjectTypeSchema } from './schemas.js';
+/**
+ * Shared request, result and job contracts. The SDK, CLI, HTTP API, MCP tools and
+ * Studio all speak these shapes so they return the same diagnostics and content.
+ */
+export const ModeSchema = z.enum(['draft', 'release']);
+export const AudienceSchema = z.enum(['private', 'public']);
+export const PaperSchema = z.enum(['A4', 'Letter']);
+export const FormatSchema = z.enum(['html', 'pdf']);
+export const FileContentSchema = z.union([
+    z.string(),
+    z.strictObject({ encoding: z.enum(['utf8', 'base64']), content: z.string() }),
+]);
+/** Where a bundle comes from. `path` is honoured only by local adapters. */
+export const SourceRefSchema = z.discriminatedUnion('kind', [
+    z.strictObject({ kind: z.literal('path'), path: z.string().min(1) }),
+    z.strictObject({ kind: z.literal('files'), files: z.record(z.string(), FileContentSchema) }),
+    z.strictObject({ kind: z.literal('zip'), base64: z.string().min(1) }),
+    z.strictObject({ kind: z.literal('guide'), guideId: IdSchema, revision: z.string().optional() }),
+]);
+export const CreateGuideRequestSchema = z.strictObject({
+    recipe: z.string().min(1),
+    subject: z.strictObject({
+        name: z.string().min(1),
+        subtitle: z.string().optional(),
+        scope: z.string().optional(),
+    }),
+    guideId: IdSchema.optional(),
+    jobId: IdSchema.optional(),
+    locale: z.string().optional(),
+});
+export const ValidateRequestSchema = z.strictObject({
+    source: SourceRefSchema,
+    mode: ModeSchema.default('draft'),
+    audience: AudienceSchema.optional(),
+});
+export const DiagnosticSummarySchema = z.strictObject({
+    errors: z.number().int(),
+    warnings: z.number().int(),
+    infos: z.number().int(),
+});
+export const ValidateResultSchema = z.strictObject({
+    ok: z.boolean(),
+    mode: ModeSchema,
+    guideId: z.string().optional(),
+    revision: z.string().optional(),
+    referenceRevision: z.string().optional(),
+    summary: DiagnosticSummarySchema,
+    diagnostics: z.array(DiagnosticSchema),
+});
+export const PreviewRequestSchema = z.strictObject({
+    source: SourceRefSchema,
+    track: z.enum(['human', 'operator', 'brief']).default('human'),
+    format: z.enum(['html', 'markdown', 'json']).default('html'),
+    mode: ModeSchema.default('draft'),
+    audience: AudienceSchema.optional(),
+});
+export const PreviewResultSchema = z.strictObject({
+    ok: z.boolean(),
+    track: z.string(),
+    format: z.string(),
+    mediaType: z.string(),
+    revision: z.string().optional(),
+    content: z.string().optional(),
+    diagnostics: z.array(DiagnosticSchema),
+});
+export const ArtifactDescriptorSchema = z.strictObject({
+    id: z.string(),
+    path: z.string(),
+    mediaType: z.string(),
+    size: z.number().int().nonnegative(),
+    sha256: z.string(),
+    url: z.string().optional(),
+});
+export const BuildOptionsSchema = z.strictObject({
+    mode: ModeSchema.default('draft'),
+    formats: z.array(FormatSchema).min(1).default(['html', 'pdf']),
+    paper: z.array(PaperSchema).min(1).default(['A4']),
+    audience: AudienceSchema.default('private'),
+    zip: z.boolean().default(true),
+    allowPartial: z.boolean().default(false),
+});
+export const BuildRequestSchema = BuildOptionsSchema.extend({ source: SourceRefSchema });
+export const BuildResultSchema = z.strictObject({
+    ok: z.boolean(),
+    status: z.enum(['succeeded', 'partial', 'failed']),
+    mode: ModeSchema,
+    guideId: z.string().optional(),
+    revision: z.string().optional(),
+    referenceRevision: z.string().optional(),
+    visibility: AudienceSchema,
+    complete: z.boolean(),
+    summary: DiagnosticSummarySchema,
+    diagnostics: z.array(DiagnosticSchema),
+    artifacts: z.array(ArtifactDescriptorSchema),
+    outDir: z.string().optional(),
+});
+export const DraftSectionSelectionSchema = z.strictObject({
+    track: z.enum(['human', 'operator']).default('human'),
+    entry: IdSchema,
+});
+export const SourceSnapshotSchema = z.strictObject({
+    id: z.string().min(1),
+    sources: z
+        .array(z.strictObject({
+        id: IdSchema,
+        title: z.string(),
+        version: z.string(),
+        locator: z.string(),
+        excerpt: z.string().optional(),
+    }))
+        .min(1),
+});
+export const DraftRequestSchema = z.strictObject({
+    source: SourceRefSchema,
+    sections: z.array(DraftSectionSelectionSchema).min(1),
+    snapshot: SourceSnapshotSchema,
+    expectedRevision: z.string().optional(),
+});
+export const JOB_STATUSES = ['queued', 'running', 'succeeded', 'failed', 'cancelled'];
+export const JOB_KINDS = ['build', 'draft'];
+export const JobRecordSchema = z.object({
+    id: z.string(),
+    kind: z.enum(JOB_KINDS),
+    status: z.enum(JOB_STATUSES),
+    guideId: z.string().optional(),
+    revision: z.string().optional(),
+    createdAt: z.string(),
+    updatedAt: z.string(),
+    cancelRequested: z.boolean().optional(),
+    result: z.unknown().optional(),
+    error: z.strictObject({ code: z.string(), message: z.string() }).optional(),
+    artifacts: z.array(ArtifactDescriptorSchema),
+    statusUrl: z.string().optional(),
+});
+export const ProblemSchema = z.strictObject({
+    error: z.strictObject({
+        code: z.string(),
+        message: z.string(),
+        diagnostics: z.array(DiagnosticSchema).optional(),
+    }),
+});
+export const SubjectInputSchema = z.strictObject({
+    type: SubjectTypeSchema,
+    name: z.string().min(1),
+});
+export function artifactIdForPath(path) {
+    return path.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-+|-+$/g, '') || 'artifact';
+}
+//# sourceMappingURL=api.js.map

package/dist/contracts/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/contracts/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAE3D;;;GAGG;AAEH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;AACvD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC5D,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;AACpD,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;AAIpD,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC;IACvC,CAAC,CAAC,MAAM,EAAE;IACV,CAAC,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;CAC9E,CAAC,CAAC;AAGH,4EAA4E;AAC5E,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAC1D,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACpE,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,EAAE,CAAC;IAC5F,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACrE,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;CACjG,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,YAAY,CAAC;IACrD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACzB,OAAO,EAAE,CAAC,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACvB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC7B,CAAC;IACF,OAAO,EAAE,QAAQ,CAAC,QAAQ,EAAE;IAC5B,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE;IAC1B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,YAAY,CAAC;IAClD,MAAM,EAAE,eAAe;IACvB,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC;IACjC,QAAQ,EAAE,cAAc,CAAC,QAAQ,EAAE;CACpC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,YAAY,CAAC;IACpD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACxB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CACxB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,YAAY,CAAC;IACjD,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE;IACf,IAAI,EAAE,UAAU;IAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,OAAO,EAAE,uBAAuB;IAChC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;CACvC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,YAAY,CAAC;IACjD,MAAM,EAAE,eAAe;IACvB,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9D,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IAC5D,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC;IACjC,QAAQ,EAAE,cAAc,CAAC,QAAQ,EAAE;CACpC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,YAAY,CAAC;IAChD,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE;IACf,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;CACvC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,YAAY,CAAC;IACrD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IACpC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC3B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC/C,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC;IACjC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC9D,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IAClD,QAAQ,EAAE,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC;IAC3C,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IAC9B,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;CACzC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,CAAC;AAGzF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC9C,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE;IACf,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAClD,IAAI,EAAE,UAAU;IAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,UAAU,EAAE,cAAc;IAC1B,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,OAAO,EAAE,uBAAuB;IAChC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;IACtC,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC;IAC5C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,YAAY,CAAC;IACxD,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACrD,KAAK,EAAE,QAAQ;CAChB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,YAAY,CAAC;IACjD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACrB,OAAO,EAAE,CAAC;SACP,KAAK,CACJ,CAAC,CAAC,YAAY,CAAC;QACb,EAAE,EAAE,QAAQ;QACZ,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC/B,CAAC,CACH;SACA,GAAG,CAAC,CAAC,CAAC;CACV,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC/C,MAAM,EAAE,eAAe;IACvB,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACrD,QAAQ,EAAE,oBAAoB;IAC9B,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,CAAU,CAAC;AAE/F,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,OAAO,CAAU,CAAC;AAGrD,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;IACvB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;IAC5B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACvC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3E,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC;IAC5C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,YAAY,CAAC;IAC1C,KAAK,EAAE,CAAC,CAAC,YAAY,CAAC;QACpB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE;KAClD,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC/C,IAAI,EAAE,iBAAiB;IACvB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACxB,CAAC,CAAC;AAEH,MAAM,UAAU,iBAAiB,CAAC,IAAY;IAC5C,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC;AAC9F,CAAC"}