@stream-mdx/protocol 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.1.1
+- Initial protocol types and event envelope for StreamMDX Protocol v1.

package/README.md

@@ -0,0 +1,7 @@
+# @stream-mdx/protocol
+
+Protocol types for StreamMDX JSON/object streaming.
+
+This package defines the event envelope, capability metadata, and token
+structures used by StreamMDX Protocol v1. It is intended for consumers that
+need a stable, versioned contract (e.g., terminal UIs).

package/dist/index.cjs

@@ -0,0 +1,33 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  STREAM_MDX_PROTOCOL_ID: () => STREAM_MDX_PROTOCOL_ID,
+  STREAM_MDX_SCHEMA_VERSION: () => STREAM_MDX_SCHEMA_VERSION
+});
+module.exports = __toCommonJS(index_exports);
+var STREAM_MDX_PROTOCOL_ID = "streammdx";
+var STREAM_MDX_SCHEMA_VERSION = "1.0";
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  STREAM_MDX_PROTOCOL_ID,
+  STREAM_MDX_SCHEMA_VERSION
+});

package/dist/index.d.cts

@@ -0,0 +1,64 @@
+import { Block, Patch, PatchMetrics } from '@stream-mdx/core';
+export { DiffKind, TokenLineV1, TokenSpan, TokenStyle } from '@stream-mdx/core';
+
+declare const STREAM_MDX_PROTOCOL_ID = "streammdx";
+declare const STREAM_MDX_SCHEMA_VERSION = "1.0";
+type StreamMdxEventType = "init" | "snapshot" | "patch" | "metrics" | "error" | "done";
+type StreamMdxCapabilityLevel = "none" | "v1";
+type StreamMdxCapabilities = {
+    tokens?: StreamMdxCapabilityLevel;
+    diff?: StreamMdxCapabilityLevel;
+    mdx?: "none" | "detect" | "compile-ref" | "compile-inline";
+    htmlBlocks?: "none" | "sanitized" | "raw";
+    math?: "none" | "tex";
+    tables?: StreamMdxCapabilityLevel;
+    footnotes?: StreamMdxCapabilityLevel;
+};
+type StreamMdxTheme = {
+    mode: "single" | "dual";
+    theme?: string;
+    dark?: string;
+    light?: string;
+};
+type StreamMdxEventBase = {
+    protocol: typeof STREAM_MDX_PROTOCOL_ID;
+    schemaVersion: typeof STREAM_MDX_SCHEMA_VERSION;
+    streamId: string;
+    event: StreamMdxEventType;
+    tx?: number;
+};
+type StreamMdxInitEventV1 = StreamMdxEventBase & {
+    event: "init";
+    createdAt?: number;
+    capabilities?: StreamMdxCapabilities;
+    theme?: StreamMdxTheme;
+    shikiVersion?: string;
+};
+type StreamMdxSnapshotEventV1 = StreamMdxEventBase & {
+    event: "snapshot";
+    blocks: Block[];
+};
+type StreamMdxPatchEventV1 = StreamMdxEventBase & {
+    event: "patch";
+    tx: number;
+    patches: Patch[];
+    metrics?: PatchMetrics | null;
+};
+type StreamMdxMetricsEventV1 = StreamMdxEventBase & {
+    event: "metrics";
+    tx?: number;
+    metrics: PatchMetrics;
+};
+type StreamMdxErrorEventV1 = StreamMdxEventBase & {
+    event: "error";
+    message: string;
+    stack?: string;
+};
+type StreamMdxDoneEventV1 = StreamMdxEventBase & {
+    event: "done";
+    finalTx?: number;
+    status: "ok" | "error";
+};
+type StreamMdxEventV1 = StreamMdxInitEventV1 | StreamMdxSnapshotEventV1 | StreamMdxPatchEventV1 | StreamMdxMetricsEventV1 | StreamMdxErrorEventV1 | StreamMdxDoneEventV1;
+
+export { STREAM_MDX_PROTOCOL_ID, STREAM_MDX_SCHEMA_VERSION, type StreamMdxCapabilities, type StreamMdxCapabilityLevel, type StreamMdxDoneEventV1, type StreamMdxErrorEventV1, type StreamMdxEventBase, type StreamMdxEventType, type StreamMdxEventV1, type StreamMdxInitEventV1, type StreamMdxMetricsEventV1, type StreamMdxPatchEventV1, type StreamMdxSnapshotEventV1, type StreamMdxTheme };

package/dist/index.d.ts

@@ -0,0 +1,64 @@
+import { Block, Patch, PatchMetrics } from '@stream-mdx/core';
+export { DiffKind, TokenLineV1, TokenSpan, TokenStyle } from '@stream-mdx/core';
+
+declare const STREAM_MDX_PROTOCOL_ID = "streammdx";
+declare const STREAM_MDX_SCHEMA_VERSION = "1.0";
+type StreamMdxEventType = "init" | "snapshot" | "patch" | "metrics" | "error" | "done";
+type StreamMdxCapabilityLevel = "none" | "v1";
+type StreamMdxCapabilities = {
+    tokens?: StreamMdxCapabilityLevel;
+    diff?: StreamMdxCapabilityLevel;
+    mdx?: "none" | "detect" | "compile-ref" | "compile-inline";
+    htmlBlocks?: "none" | "sanitized" | "raw";
+    math?: "none" | "tex";
+    tables?: StreamMdxCapabilityLevel;
+    footnotes?: StreamMdxCapabilityLevel;
+};
+type StreamMdxTheme = {
+    mode: "single" | "dual";
+    theme?: string;
+    dark?: string;
+    light?: string;
+};
+type StreamMdxEventBase = {
+    protocol: typeof STREAM_MDX_PROTOCOL_ID;
+    schemaVersion: typeof STREAM_MDX_SCHEMA_VERSION;
+    streamId: string;
+    event: StreamMdxEventType;
+    tx?: number;
+};
+type StreamMdxInitEventV1 = StreamMdxEventBase & {
+    event: "init";
+    createdAt?: number;
+    capabilities?: StreamMdxCapabilities;
+    theme?: StreamMdxTheme;
+    shikiVersion?: string;
+};
+type StreamMdxSnapshotEventV1 = StreamMdxEventBase & {
+    event: "snapshot";
+    blocks: Block[];
+};
+type StreamMdxPatchEventV1 = StreamMdxEventBase & {
+    event: "patch";
+    tx: number;
+    patches: Patch[];
+    metrics?: PatchMetrics | null;
+};
+type StreamMdxMetricsEventV1 = StreamMdxEventBase & {
+    event: "metrics";
+    tx?: number;
+    metrics: PatchMetrics;
+};
+type StreamMdxErrorEventV1 = StreamMdxEventBase & {
+    event: "error";
+    message: string;
+    stack?: string;
+};
+type StreamMdxDoneEventV1 = StreamMdxEventBase & {
+    event: "done";
+    finalTx?: number;
+    status: "ok" | "error";
+};
+type StreamMdxEventV1 = StreamMdxInitEventV1 | StreamMdxSnapshotEventV1 | StreamMdxPatchEventV1 | StreamMdxMetricsEventV1 | StreamMdxErrorEventV1 | StreamMdxDoneEventV1;
+
+export { STREAM_MDX_PROTOCOL_ID, STREAM_MDX_SCHEMA_VERSION, type StreamMdxCapabilities, type StreamMdxCapabilityLevel, type StreamMdxDoneEventV1, type StreamMdxErrorEventV1, type StreamMdxEventBase, type StreamMdxEventType, type StreamMdxEventV1, type StreamMdxInitEventV1, type StreamMdxMetricsEventV1, type StreamMdxPatchEventV1, type StreamMdxSnapshotEventV1, type StreamMdxTheme };

package/dist/index.mjs

@@ -0,0 +1,7 @@
+// src/index.ts
+var STREAM_MDX_PROTOCOL_ID = "streammdx";
+var STREAM_MDX_SCHEMA_VERSION = "1.0";
+export {
+  STREAM_MDX_PROTOCOL_ID,
+  STREAM_MDX_SCHEMA_VERSION
+};

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@stream-mdx/protocol",
+  "version": "0.2.0",
+  "description": "StreamMDX protocol types and event envelope for JSON/object streaming",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kmccleary3301/stream-mdx.git",
+    "directory": "packages/markdown-v2-protocol"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist",
+    "prepack": "npm run build"
+  },
+  "dependencies": {
+    "@stream-mdx/core": "0.2.0"
+  }
+}