@moyarich/console-addon-xterm 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,39 @@
-# Temporary Holding Version
+# @moyarich/console-addon-xterm
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Render terminal output with xterm.js. Use xterm.js for ANSI/VT terminal rendering, append-only streaming, and terminal-sized scrolling.
+
+[Documentation and live examples](https://moyarich.github.io/console/)
+
+## Install
+
+```bash
+npm install @moyarich/console @moyarich/console-addon-xterm react
+```
+
+Configure the `@moyarich` scope and authenticate with GitHub Packages as described in the [installation guide](../../../README.md#installation).
+
+Required peer dependencies: `@moyarich/console-core@^0.2.0`, `@moyarich/console@^0.2.0`, `react@>=18`.
+
+## Quick start
+
+```tsx
+import { Console } from "@moyarich/console";
+import { createConsoleXtermAddon } from "@moyarich/console-addon-xterm";
+
+const addons = [createConsoleXtermAddon()];
+
+// Pass your application's terminal output entries to Console.
+<Console mode="terminal" messages={messages} addons={addons} />;
+```
+
+The addon is optional and can be combined with other Console addons. Use terminal mode when passing process output.
+
+## Learn more
+
+Explore [runnable package examples](./examples) and the [Console documentation](https://moyarich.github.io/console/) for available settings and integration patterns.
+
+Review the [changelog](./CHANGELOG.md) for changes by version and [package metadata](./package.json) for dependency requirements.
+
+## License
+
+MIT

package/dist/XtermOutput.d.cts

@@ -0,0 +1,12 @@
+import { type AddonTranslations } from "./localization.cjs";
+import type { ConsoleStdoutEntry } from "@moyarich/console";
+
+
+/** Decide when new output can be appended without replaying prior chunks. */
+export declare function isAppendOnly(previous: readonly (ConsoleStdoutEntry | string)[], next: readonly (ConsoleStdoutEntry | string)[]): boolean;
+/** The addon owns terminal creation, updates, and disposal. */
+export declare function XtermOutput({ entries, locale, translations, }: {
+    entries: readonly (ConsoleStdoutEntry | string)[];
+    locale?: string;
+    translations?: AddonTranslations;
+}): import("react").JSX.Element;

package/dist/XtermOutput.d.ts

@@ -0,0 +1,12 @@
+import { type AddonTranslations } from "./localization.js";
+import type { ConsoleStdoutEntry } from "@moyarich/console";
+
+
+/** Decide when new output can be appended without replaying prior chunks. */
+export declare function isAppendOnly(previous: readonly (ConsoleStdoutEntry | string)[], next: readonly (ConsoleStdoutEntry | string)[]): boolean;
+/** The addon owns terminal creation, updates, and disposal. */
+export declare function XtermOutput({ entries, locale, translations, }: {
+    entries: readonly (ConsoleStdoutEntry | string)[];
+    locale?: string;
+    translations?: AddonTranslations;
+}): import("react").JSX.Element;

package/dist/console-addon-xterm.css

@@ -0,0 +1,317 @@
+/**
+ * Copyright (c) 2014 The xterm.js authors. All rights reserved.
+ * Copyright (c) 2012-2013, Christopher Jeffrey (MIT License)
+ * https://github.com/chjj/term.js
+ * @license MIT
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * Originally forked from (with the author's permission):
+ *   Fabrice Bellard's javascript vt100 for jslinux:
+ *   http://bellard.org/jslinux/
+ *   Copyright (c) 2011 Fabrice Bellard
+ *   The original design remains. The terminal itself
+ *   has been extended to include xterm CSI codes, among
+ *   other features.
+ */
+
+/**
+ *  Default styles for xterm.js
+ */
+
+.xterm {
+    cursor: text;
+    position: relative;
+    user-select: none;
+    -ms-user-select: none;
+    -webkit-user-select: none;
+}
+
+.xterm.focus,
+.xterm:focus {
+    outline: none;
+}
+
+.xterm .xterm-helpers {
+    position: absolute;
+    top: 0;
+    /**
+     * The z-index of the helpers must be higher than the canvases in order for
+     * IMEs to appear on top.
+     */
+    z-index: 5;
+}
+
+.xterm .xterm-helper-textarea {
+    padding: 0;
+    border: 0;
+    margin: 0;
+    /* Move textarea out of the screen to the far left, so that the cursor is not visible */
+    position: absolute;
+    opacity: 0;
+    left: -9999em;
+    top: 0;
+    width: 0;
+    height: 0;
+    z-index: -5;
+    /** Prevent wrapping so the IME appears against the textarea at the correct position */
+    white-space: nowrap;
+    overflow: hidden;
+    resize: none;
+}
+
+.xterm .composition-view {
+    /* TODO: Composition position got messed up somewhere */
+    background: #000;
+    color: #FFF;
+    display: none;
+    position: absolute;
+    white-space: nowrap;
+    z-index: 1;
+}
+
+.xterm .composition-view.active {
+    display: block;
+}
+
+.xterm .xterm-viewport {
+    /* On OS X this is required in order for the scroll bar to appear fully opaque */
+    background-color: #000;
+    overflow-y: scroll;
+    cursor: default;
+    position: absolute;
+    right: 0;
+    left: 0;
+    top: 0;
+    bottom: 0;
+}
+
+.xterm .xterm-screen {
+    position: relative;
+}
+
+.xterm .xterm-screen canvas {
+    position: absolute;
+    left: 0;
+    top: 0;
+}
+
+.xterm-char-measure-element {
+    display: inline-block;
+    visibility: hidden;
+    position: absolute;
+    top: 0;
+    left: -9999em;
+    line-height: normal;
+}
+
+.xterm.enable-mouse-events {
+    /* When mouse events are enabled (eg. tmux), revert to the standard pointer cursor */
+    cursor: default;
+}
+
+.xterm.xterm-cursor-pointer,
+.xterm .xterm-cursor-pointer {
+    cursor: pointer;
+}
+
+.xterm.column-select.focus {
+    /* Column selection mode */
+    cursor: crosshair;
+}
+
+.xterm .xterm-accessibility:not(.debug),
+.xterm .xterm-message {
+    position: absolute;
+    left: 0;
+    top: 0;
+    bottom: 0;
+    right: 0;
+    z-index: 10;
+    color: transparent;
+    pointer-events: none;
+}
+
+.xterm .xterm-accessibility-tree:not(.debug) *::selection {
+  color: transparent;
+}
+
+.xterm .xterm-accessibility-tree {
+  font-family: monospace;
+  user-select: text;
+  white-space: pre;
+}
+
+.xterm .xterm-accessibility-tree > div {
+  transform-origin: left;
+  width: fit-content;
+}
+
+.xterm .live-region {
+    position: absolute;
+    left: -9999px;
+    width: 1px;
+    height: 1px;
+    overflow: hidden;
+}
+
+.xterm-dim {
+    /* Dim should not apply to background, so the opacity of the foreground color is applied
+     * explicitly in the generated class and reset to 1 here */
+    opacity: 1 !important;
+}
+
+.xterm-underline-1 { text-decoration: underline; }
+.xterm-underline-2 { text-decoration: double underline; }
+.xterm-underline-3 { text-decoration: wavy underline; }
+.xterm-underline-4 { text-decoration: dotted underline; }
+.xterm-underline-5 { text-decoration: dashed underline; }
+
+.xterm-overline {
+    text-decoration: overline;
+}
+
+.xterm-overline.xterm-underline-1 { text-decoration: overline underline; }
+.xterm-overline.xterm-underline-2 { text-decoration: overline double underline; }
+.xterm-overline.xterm-underline-3 { text-decoration: overline wavy underline; }
+.xterm-overline.xterm-underline-4 { text-decoration: overline dotted underline; }
+.xterm-overline.xterm-underline-5 { text-decoration: overline dashed underline; }
+
+.xterm-strikethrough {
+    text-decoration: line-through;
+}
+
+.xterm-screen .xterm-decoration-container .xterm-decoration {
+	z-index: 6;
+	position: absolute;
+}
+
+.xterm-screen .xterm-decoration-container .xterm-decoration.xterm-decoration-top-layer {
+	z-index: 7;
+}
+
+.xterm-decoration-overview-ruler {
+    z-index: 8;
+    position: absolute;
+    top: 0;
+    right: 0;
+    pointer-events: none;
+}
+
+.xterm-decoration-top {
+    z-index: 2;
+    position: relative;
+}
+
+
+
+/* Derived from vs/base/browser/ui/scrollbar/media/scrollbar.css */
+
+/* xterm.js customization: Override xterm's cursor style */
+.xterm .xterm-scrollable-element > .scrollbar {
+    cursor: default;
+}
+
+/* Arrows */
+.xterm .xterm-scrollable-element > .scrollbar > .scra {
+	cursor: pointer;
+	font-size: 11px !important;
+}
+
+.xterm .xterm-scrollable-element > .visible {
+	opacity: 1;
+
+	/* Background rule added for IE9 - to allow clicks on dom node */
+	background:rgba(0,0,0,0);
+
+	transition: opacity 100ms linear;
+	/* In front of peek view */
+	z-index: 11;
+}
+.xterm .xterm-scrollable-element > .invisible {
+	opacity: 0;
+	pointer-events: none;
+}
+.xterm .xterm-scrollable-element > .invisible.fade {
+	transition: opacity 800ms linear;
+}
+
+/* Scrollable Content Inset Shadow */
+.xterm .xterm-scrollable-element > .shadow {
+	position: absolute;
+	display: none;
+}
+.xterm .xterm-scrollable-element > .shadow.top {
+	display: block;
+	top: 0;
+	left: 3px;
+	height: 3px;
+	width: 100%;
+	box-shadow: var(--vscode-scrollbar-shadow, #000) 0 6px 6px -6px inset;
+}
+.xterm .xterm-scrollable-element > .shadow.left {
+	display: block;
+	top: 3px;
+	left: 0;
+	height: 100%;
+	width: 3px;
+	box-shadow: var(--vscode-scrollbar-shadow, #000) 6px 0 6px -6px inset;
+}
+.xterm .xterm-scrollable-element > .shadow.top-left-corner {
+	display: block;
+	top: 0;
+	left: 0;
+	height: 3px;
+	width: 3px;
+}
+.xterm .xterm-scrollable-element > .shadow.top.left {
+	box-shadow: var(--vscode-scrollbar-shadow, #000) 6px 0 6px -6px inset;
+}
+.console-panel .console-surface:has(.console-xterm-output) {
+  min-height: 0;
+  min-width: 0;
+  overflow: hidden;
+  display: flex;
+  flex-direction: column;
+}
+
+.console-panel
+  .console-surface:has(.console-xterm-output)
+  > .console-scroll-end-spacer {
+  display: none;
+}
+
+.console-xterm-output {
+  --_console-xterm-background: var(--console-xterm-background, transparent);
+  box-sizing: border-box;
+  flex: 1 1 0;
+  min-width: 0;
+  min-height: 0;
+  width: 100%;
+  height: 0;
+  overflow: hidden;
+  background: var(--_console-xterm-background);
+}
+
+.console-xterm-output .xterm {
+  box-sizing: border-box;
+  height: 100%;
+  width: 100%;
+  padding: var(--console-xterm-padding, 0.5rem);
+}

package/dist/index.cjs

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const jsxRuntime = require("react/jsx-runtime");
+const consoleCore = require("@moyarich/console-core");
+const react = require("react");
+const xterm = require("@xterm/xterm");
+const terminal$3 = "Terminal output";
+const en = {
+  terminal: terminal$3
+};
+const terminal$2 = "Salida del terminal";
+const es = {
+  terminal: terminal$2
+};
+const terminal$1 = "Sortie du terminal";
+const fr = {
+  terminal: terminal$1
+};
+const terminal = "Saída do terminal";
+const pt = {
+  terminal
+};
+const locales = { en, es, fr, pt };
+function resolveAddonMessages(locale = "en", overrides) {
+  const tag = locale.replace(/_/g, "-").toLowerCase();
+  return {
+    ...en,
+    ...locales[tag] ?? locales[tag.split("-")[0]] ?? {},
+    ...overrides
+  };
+}
+function isAppendOnly(previous, next) {
+  return previous.length <= next.length && previous.every((entry, i) => {
+    const current = next[i];
+    return entry === current || typeof entry !== "string" && typeof current !== "string" && current !== void 0 && entry.id === current.id && entry.data === current.data && entry.stream === current.stream;
+  });
+}
+function XtermOutput({
+  entries,
+  locale = "en",
+  translations
+}) {
+  const labels = resolveAddonMessages(locale, translations);
+  const element = react.useRef(null);
+  const terminal2 = react.useRef(null);
+  const written = react.useRef([]);
+  react.useEffect(() => {
+    if (!element.current) return;
+    const instance = new xterm.Terminal({
+      convertEol: true,
+      disableStdin: true,
+      screenReaderMode: true,
+      scrollback: 5e3
+    });
+    instance.open(element.current);
+    const container = element.current;
+    const resizeToContainer = () => {
+      const screen = instance.element?.querySelector(".xterm-screen");
+      if (!screen || !container.isConnected) return;
+      const cellWidth = screen.offsetWidth / instance.cols;
+      const cellHeight = screen.offsetHeight / instance.rows;
+      if (cellWidth <= 0 || cellHeight <= 0) return;
+      const xtermElement = instance.element;
+      const styles = xtermElement ? getComputedStyle(xtermElement) : null;
+      const horizontalPadding = styles ? parseFloat(styles.paddingLeft) + parseFloat(styles.paddingRight) : 0;
+      const verticalPadding = styles ? parseFloat(styles.paddingTop) + parseFloat(styles.paddingBottom) : 0;
+      const cols = Math.max(
+        2,
+        Math.floor((container.clientWidth - horizontalPadding) / cellWidth)
+      );
+      const rows = Math.max(
+        1,
+        Math.floor((container.clientHeight - verticalPadding) / cellHeight)
+      );
+      if (cols !== instance.cols || rows !== instance.rows)
+        instance.resize(cols, rows);
+    };
+    resizeToContainer();
+    const observer = typeof ResizeObserver === "undefined" ? null : new ResizeObserver(resizeToContainer);
+    observer?.observe(container);
+    terminal2.current = instance;
+    written.current = [];
+    return () => {
+      observer?.disconnect();
+      terminal2.current = null;
+      written.current = [];
+      instance.dispose();
+    };
+  }, []);
+  react.useEffect(() => {
+    const instance = terminal2.current;
+    if (!instance) return;
+    const appendOnly = isAppendOnly(written.current, entries);
+    if (!appendOnly) instance.reset();
+    const start = appendOnly ? written.current.length : 0;
+    for (let i = start; i < entries.length; i++) {
+      const entry = entries[i];
+      instance.write(typeof entry === "string" ? entry : entry.data);
+    }
+    written.current = [...entries];
+  }, [entries]);
+  return /* @__PURE__ */ jsxRuntime.jsx(
+    "div",
+    {
+      ref: element,
+      className: "console-xterm-output",
+      "aria-label": labels.terminal
+    }
+  );
+}
+const CONSOLE_XTERM_ADDON_ID = "@moyarich/console-addon-xterm";
+const xtermOutputRenderer = {
+  mode: "terminal",
+  render(context) {
+    if (context.mode !== "terminal") return void 0;
+    return /* @__PURE__ */ jsxRuntime.jsx(XtermOutput, { entries: context.entries });
+  }
+};
+function createConsoleXtermAddon(options = {}) {
+  return {
+    id: CONSOLE_XTERM_ADDON_ID,
+    activate(host) {
+      host.extensions.register(
+        consoleCore.consoleExtensionPoints.outputRenderer,
+        {
+          ...xtermOutputRenderer,
+          render(context) {
+            if (context.mode !== "terminal") return void 0;
+            return /* @__PURE__ */ jsxRuntime.jsx(XtermOutput, { entries: context.entries, ...options });
+          }
+        },
+        {
+          id: `${CONSOLE_XTERM_ADDON_ID}:output-renderer`
+        }
+      );
+    }
+  };
+}
+exports.CONSOLE_XTERM_ADDON_ID = CONSOLE_XTERM_ADDON_ID;
+exports.XtermOutput = XtermOutput;
+exports.createConsoleXtermAddon = createConsoleXtermAddon;
+exports.isAppendOnly = isAppendOnly;
+exports.resolveAddonMessages = resolveAddonMessages;
+exports.xtermOutputRenderer = xtermOutputRenderer;

package/dist/index.d.cts

@@ -0,0 +1,11 @@
+import type { AddonTranslations } from "./localization.cjs";
+export { resolveAddonMessages } from "./localization.cjs";
+export type { AddonTranslations } from "./localization.cjs";
+import { type ConsoleAddon, type ConsoleOutputRenderer } from "@moyarich/console-core";
+export declare const CONSOLE_XTERM_ADDON_ID = "@moyarich/console-addon-xterm";
+export declare const xtermOutputRenderer: ConsoleOutputRenderer;
+export declare function createConsoleXtermAddon(options?: {
+    locale?: string;
+    translations?: AddonTranslations;
+}): ConsoleAddon;
+export { XtermOutput, isAppendOnly } from "./XtermOutput.cjs";

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import type { AddonTranslations } from "./localization.js";
+export { resolveAddonMessages } from "./localization.js";
+export type { AddonTranslations } from "./localization.js";
+import { type ConsoleAddon, type ConsoleOutputRenderer } from "@moyarich/console-core";
+export declare const CONSOLE_XTERM_ADDON_ID = "@moyarich/console-addon-xterm";
+export declare const xtermOutputRenderer: ConsoleOutputRenderer;
+export declare function createConsoleXtermAddon(options?: {
+    locale?: string;
+    translations?: AddonTranslations;
+}): ConsoleAddon;
+export { XtermOutput, isAppendOnly } from "./XtermOutput.js";

package/dist/index.js

@@ -0,0 +1,144 @@
+import { jsx } from "react/jsx-runtime";
+import { consoleExtensionPoints } from "@moyarich/console-core";
+import { useRef, useEffect } from "react";
+import { Terminal } from "@xterm/xterm";
+const terminal$3 = "Terminal output";
+const en = {
+  terminal: terminal$3
+};
+const terminal$2 = "Salida del terminal";
+const es = {
+  terminal: terminal$2
+};
+const terminal$1 = "Sortie du terminal";
+const fr = {
+  terminal: terminal$1
+};
+const terminal = "Saída do terminal";
+const pt = {
+  terminal
+};
+const locales = { en, es, fr, pt };
+function resolveAddonMessages(locale = "en", overrides) {
+  const tag = locale.replace(/_/g, "-").toLowerCase();
+  return {
+    ...en,
+    ...locales[tag] ?? locales[tag.split("-")[0]] ?? {},
+    ...overrides
+  };
+}
+function isAppendOnly(previous, next) {
+  return previous.length <= next.length && previous.every((entry, i) => {
+    const current = next[i];
+    return entry === current || typeof entry !== "string" && typeof current !== "string" && current !== void 0 && entry.id === current.id && entry.data === current.data && entry.stream === current.stream;
+  });
+}
+function XtermOutput({
+  entries,
+  locale = "en",
+  translations
+}) {
+  const labels = resolveAddonMessages(locale, translations);
+  const element = useRef(null);
+  const terminal2 = useRef(null);
+  const written = useRef([]);
+  useEffect(() => {
+    if (!element.current) return;
+    const instance = new Terminal({
+      convertEol: true,
+      disableStdin: true,
+      screenReaderMode: true,
+      scrollback: 5e3
+    });
+    instance.open(element.current);
+    const container = element.current;
+    const resizeToContainer = () => {
+      const screen = instance.element?.querySelector(".xterm-screen");
+      if (!screen || !container.isConnected) return;
+      const cellWidth = screen.offsetWidth / instance.cols;
+      const cellHeight = screen.offsetHeight / instance.rows;
+      if (cellWidth <= 0 || cellHeight <= 0) return;
+      const xtermElement = instance.element;
+      const styles = xtermElement ? getComputedStyle(xtermElement) : null;
+      const horizontalPadding = styles ? parseFloat(styles.paddingLeft) + parseFloat(styles.paddingRight) : 0;
+      const verticalPadding = styles ? parseFloat(styles.paddingTop) + parseFloat(styles.paddingBottom) : 0;
+      const cols = Math.max(
+        2,
+        Math.floor((container.clientWidth - horizontalPadding) / cellWidth)
+      );
+      const rows = Math.max(
+        1,
+        Math.floor((container.clientHeight - verticalPadding) / cellHeight)
+      );
+      if (cols !== instance.cols || rows !== instance.rows)
+        instance.resize(cols, rows);
+    };
+    resizeToContainer();
+    const observer = typeof ResizeObserver === "undefined" ? null : new ResizeObserver(resizeToContainer);
+    observer?.observe(container);
+    terminal2.current = instance;
+    written.current = [];
+    return () => {
+      observer?.disconnect();
+      terminal2.current = null;
+      written.current = [];
+      instance.dispose();
+    };
+  }, []);
+  useEffect(() => {
+    const instance = terminal2.current;
+    if (!instance) return;
+    const appendOnly = isAppendOnly(written.current, entries);
+    if (!appendOnly) instance.reset();
+    const start = appendOnly ? written.current.length : 0;
+    for (let i = start; i < entries.length; i++) {
+      const entry = entries[i];
+      instance.write(typeof entry === "string" ? entry : entry.data);
+    }
+    written.current = [...entries];
+  }, [entries]);
+  return /* @__PURE__ */ jsx(
+    "div",
+    {
+      ref: element,
+      className: "console-xterm-output",
+      "aria-label": labels.terminal
+    }
+  );
+}
+const CONSOLE_XTERM_ADDON_ID = "@moyarich/console-addon-xterm";
+const xtermOutputRenderer = {
+  mode: "terminal",
+  render(context) {
+    if (context.mode !== "terminal") return void 0;
+    return /* @__PURE__ */ jsx(XtermOutput, { entries: context.entries });
+  }
+};
+function createConsoleXtermAddon(options = {}) {
+  return {
+    id: CONSOLE_XTERM_ADDON_ID,
+    activate(host) {
+      host.extensions.register(
+        consoleExtensionPoints.outputRenderer,
+        {
+          ...xtermOutputRenderer,
+          render(context) {
+            if (context.mode !== "terminal") return void 0;
+            return /* @__PURE__ */ jsx(XtermOutput, { entries: context.entries, ...options });
+          }
+        },
+        {
+          id: `${CONSOLE_XTERM_ADDON_ID}:output-renderer`
+        }
+      );
+    }
+  };
+}
+export {
+  CONSOLE_XTERM_ADDON_ID,
+  XtermOutput,
+  createConsoleXtermAddon,
+  isAppendOnly,
+  resolveAddonMessages,
+  xtermOutputRenderer
+};

package/dist/locales/en.json

@@ -0,0 +1,3 @@
+{
+  "terminal": "Terminal output"
+}

package/dist/locales/es.json

@@ -0,0 +1,3 @@
+{
+  "terminal": "Salida del terminal"
+}

package/dist/locales/fr.json

@@ -0,0 +1,3 @@
+{
+  "terminal": "Sortie du terminal"
+}

package/dist/locales/pt.json

@@ -0,0 +1,3 @@
+{
+  "terminal": "Saída do terminal"
+}

package/dist/localization.d.cts

@@ -0,0 +1,3 @@
+import en from "./locales/en.json";
+export type AddonTranslations = Partial<typeof en>;
+export declare function resolveAddonMessages(locale?: string, overrides?: AddonTranslations): typeof en;

package/dist/localization.d.ts

@@ -0,0 +1,3 @@
+import en from "./locales/en.json";
+export type AddonTranslations = Partial<typeof en>;
+export declare function resolveAddonMessages(locale?: string, overrides?: AddonTranslations): typeof en;

package/dist/styles.css

@@ -0,0 +1,33 @@
+/* src/XtermOutput.css */
+.console-panel .console-surface:has(.console-xterm-output) {
+  min-height: 0;
+  min-width: 0;
+  overflow: hidden;
+  display: flex;
+  flex-direction: column;
+}
+
+.console-panel
+  .console-surface:has(.console-xterm-output)
+  > .console-scroll-end-spacer {
+  display: none;
+}
+
+.console-xterm-output {
+  --_console-xterm-background: var(--console-xterm-background, transparent);
+  box-sizing: border-box;
+  flex: 1 1 0;
+  min-width: 0;
+  min-height: 0;
+  width: 100%;
+  height: 0;
+  overflow: hidden;
+  background: var(--_console-xterm-background);
+}
+
+.console-xterm-output .xterm {
+  box-sizing: border-box;
+  height: 100%;
+  width: 100%;
+  padding: var(--console-xterm-padding, 0.5rem);
+}

package/package.json

@@ -1,6 +1,76 @@
 {
   "name": "@moyarich/console-addon-xterm",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "Optional xterm.js terminal renderer for Console",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./styles.css": "./dist/styles.css"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com"
+  },
+  "scripts": {
+    "build": "vite build && tsc -p tsconfig.build.json && node ../../../scripts/prepare-cjs-types.mjs && node ../../../scripts/prepare-addon-styles.mjs",
+    "typecheck": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "@moyarich/console-core": "^0.2.0",
+    "@moyarich/console": "^0.2.0",
+    "react": ">=18"
+  },
+  "dependencies": {
+    "@xterm/xterm": "^6.0.0"
+  },
+  "devDependencies": {
+    "@moyarich/console-core": "0.2.0",
+    "@moyarich/console": "0.2.0",
+    "@types/react": "^19.1.12",
+    "react": "^19.2.7",
+    "typescript": "^5.9.2",
+    "vite": "^7.1.5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/moyarich/console.git",
+    "directory": "packages/addons/xterm"
+  },
+  "sideEffects": [
+    "./src/index.tsx",
+    "./src/XtermOutput.css",
+    "./dist/index.js",
+    "./dist/index.cjs",
+    "./dist/styles.css"
+  ],
+  "publisher": "moyarich",
+  "author": "Moya Richards",
+  "engines": {
+    "node": ">=24"
+  },
+  "private": false,
+  "keywords": [
+    "console",
+    "addon",
+    "xterm"
+  ],
+  "homepage": "https://moyarich.github.io/console/",
+  "bugs": {
+    "url": "https://github.com/moyarich/console/issues"
+  }
+}