@fnndsc/calypso 0.2.0

package/dist/protocol/envelope.d.ts

@@ -0,0 +1,136 @@
+/**
+ * @file The wire schema for a command envelope.
+ *
+ * cumin defines the `CommandEnvelope` type (the shape produced in-stack);
+ * calypso owns the wire schema that validates that envelope at the boundary
+ * — the published promise an external surface programs against. The two are
+ * kept in step by a compile-time check below: if cumin's type gains a field
+ * the wire schema does not cover, this file stops compiling, so the contract
+ * can never silently drift from what the code produces.
+ *
+ * @module
+ */
+import { z } from 'zod';
+/** Terminal status of a completed command. */
+export declare const envelopeStatusSchema: z.ZodEnum<["ok", "error"]>;
+/** A single structured error/warning drained from the error stack. */
+export declare const stackMessageSchema: z.ZodObject<{
+    type: z.ZodEnum<["error", "warning"]>;
+    message: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "error" | "warning";
+    message: string;
+}, {
+    type: "error" | "warning";
+    message: string;
+}>;
+/** A command's typed result: a namespaced kind and an opaque payload. */
+export declare const envelopeModelSchema: z.ZodObject<{
+    kind: z.ZodString;
+    data: z.ZodUnknown;
+}, "strip", z.ZodTypeAny, {
+    kind: string;
+    data?: unknown;
+}, {
+    kind: string;
+    data?: unknown;
+}>;
+/** The record of how a natural-language input resolved into a command. */
+export declare const resolutionTraceSchema: z.ZodObject<{
+    input: z.ZodString;
+    proposed: z.ZodString;
+    validated: z.ZodBoolean;
+    executed: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    input: string;
+    proposed: string;
+    validated: boolean;
+    executed?: string | undefined;
+}, {
+    input: string;
+    proposed: string;
+    validated: boolean;
+    executed?: string | undefined;
+}>;
+/**
+ * The envelope in which one command's complete outcome crosses the wire.
+ */
+export declare const commandEnvelopeSchema: z.ZodObject<{
+    status: z.ZodEnum<["ok", "error"]>;
+    rendered: z.ZodString;
+    renderedErr: z.ZodOptional<z.ZodString>;
+    model: z.ZodOptional<z.ZodObject<{
+        kind: z.ZodString;
+        data: z.ZodUnknown;
+    }, "strip", z.ZodTypeAny, {
+        kind: string;
+        data?: unknown;
+    }, {
+        kind: string;
+        data?: unknown;
+    }>>;
+    errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<["error", "warning"]>;
+        message: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "error" | "warning";
+        message: string;
+    }, {
+        type: "error" | "warning";
+        message: string;
+    }>, "many">>;
+    trace: z.ZodOptional<z.ZodObject<{
+        input: z.ZodString;
+        proposed: z.ZodString;
+        validated: z.ZodBoolean;
+        executed: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        input: string;
+        proposed: string;
+        validated: boolean;
+        executed?: string | undefined;
+    }, {
+        input: string;
+        proposed: string;
+        validated: boolean;
+        executed?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    status: "ok" | "error";
+    rendered: string;
+    renderedErr?: string | undefined;
+    model?: {
+        kind: string;
+        data?: unknown;
+    } | undefined;
+    errors?: {
+        type: "error" | "warning";
+        message: string;
+    }[] | undefined;
+    trace?: {
+        input: string;
+        proposed: string;
+        validated: boolean;
+        executed?: string | undefined;
+    } | undefined;
+}, {
+    status: "ok" | "error";
+    rendered: string;
+    renderedErr?: string | undefined;
+    model?: {
+        kind: string;
+        data?: unknown;
+    } | undefined;
+    errors?: {
+        type: "error" | "warning";
+        message: string;
+    }[] | undefined;
+    trace?: {
+        input: string;
+        proposed: string;
+        validated: boolean;
+        executed?: string | undefined;
+    } | undefined;
+}>;
+/** The envelope type inferred from the wire schema. */
+export type WireEnvelope = z.infer<typeof commandEnvelopeSchema>;

package/dist/protocol/envelope.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commandEnvelopeSchema = exports.resolutionTraceSchema = exports.envelopeModelSchema = exports.stackMessageSchema = exports.envelopeStatusSchema = void 0;
+/**
+ * @file The wire schema for a command envelope.
+ *
+ * cumin defines the `CommandEnvelope` type (the shape produced in-stack);
+ * calypso owns the wire schema that validates that envelope at the boundary
+ * — the published promise an external surface programs against. The two are
+ * kept in step by a compile-time check below: if cumin's type gains a field
+ * the wire schema does not cover, this file stops compiling, so the contract
+ * can never silently drift from what the code produces.
+ *
+ * @module
+ */
+const zod_1 = require("zod");
+/** Terminal status of a completed command. */
+exports.envelopeStatusSchema = zod_1.z.enum(['ok', 'error']);
+/** A single structured error/warning drained from the error stack. */
+exports.stackMessageSchema = zod_1.z.object({
+    type: zod_1.z.enum(['error', 'warning']),
+    message: zod_1.z.string(),
+});
+/** A command's typed result: a namespaced kind and an opaque payload. */
+exports.envelopeModelSchema = zod_1.z.object({
+    kind: zod_1.z.string(),
+    data: zod_1.z.unknown(),
+});
+/** The record of how a natural-language input resolved into a command. */
+exports.resolutionTraceSchema = zod_1.z.object({
+    input: zod_1.z.string(),
+    proposed: zod_1.z.string(),
+    validated: zod_1.z.boolean(),
+    executed: zod_1.z.string().optional(),
+});
+/**
+ * The envelope in which one command's complete outcome crosses the wire.
+ */
+exports.commandEnvelopeSchema = zod_1.z.object({
+    status: exports.envelopeStatusSchema,
+    rendered: zod_1.z.string(),
+    renderedErr: zod_1.z.string().optional(),
+    model: exports.envelopeModelSchema.optional(),
+    errors: zod_1.z.array(exports.stackMessageSchema).optional(),
+    trace: exports.resolutionTraceSchema.optional(),
+});
+const _envelopeCoversCumin = true;
+void _envelopeCoversCumin;
+//# sourceMappingURL=envelope.js.map

package/dist/protocol/envelope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"envelope.js","sourceRoot":"","sources":["../../src/protocol/envelope.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;GAWG;AACH,6BAAwB;AAGxB,8CAA8C;AACjC,QAAA,oBAAoB,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;AAE5D,sEAAsE;AACzD,QAAA,kBAAkB,GAAG,OAAC,CAAC,MAAM,CAAC;IACzC,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAClC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC;AAEH,yEAAyE;AAC5D,QAAA,mBAAmB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC1C,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,OAAC,CAAC,OAAO,EAAE;CAClB,CAAC,CAAC;AAEH,0EAA0E;AAC7D,QAAA,qBAAqB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5C,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE;IACtB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,qBAAqB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5C,MAAM,EAAE,4BAAoB;IAC5B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,KAAK,EAAE,2BAAmB,CAAC,QAAQ,EAAE;IACrC,MAAM,EAAE,OAAC,CAAC,KAAK,CAAC,0BAAkB,CAAC,CAAC,QAAQ,EAAE;IAC9C,KAAK,EAAE,6BAAqB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAcH,MAAM,oBAAoB,GAAwB,IAAI,CAAC;AACvD,KAAK,oBAAoB,CAAC"}