@moyarich/console-addon-process-state 0.1.0 → 0.2.0

package/README.md

@@ -2,12 +2,18 @@
 
 Track terminal process progress. Interpret OSC progress, working directory, command lifecycle, and notifications without requiring xterm.js.
 
+[Documentation and live examples](https://moyarich.github.io/console/)
+
 ## Install
 
 ```bash
-npm install @moyarich/console @moyarich/console-addon-process-state
+npm install @moyarich/console @moyarich/console-addon-process-state 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`, `react@>=18`.
+
 ## Quick start
 
 ```tsx

package/dist/ProgressIndicator.d.cts

@@ -0,0 +1,19 @@
+import { type ProcessStateTranslations } from "./localization.cjs";
+import { type CSSProperties } from "react";
+import type { ProcessStateController } from "./index.cjs";
+
+export interface ConsoleProgressIndicatorOptions {
+    locale?: string;
+    translations?: ProcessStateTranslations;
+    className?: string;
+    style?: CSSProperties;
+    /** Custom label for the determinate progress mode. */
+    format?: (percentage: number, state: number) => string;
+    /** Keep the progress strip visible after a clear command. */
+    showCleared?: boolean;
+}
+export interface ConsoleProgressIndicatorProps extends ConsoleProgressIndicatorOptions {
+    controller: ProcessStateController;
+}
+/** Read-only, optional status strip; it never modifies terminal output or scroll position. */
+export declare function ConsoleProgressIndicator({ controller, className, style, format, showCleared, locale, translations, }: ConsoleProgressIndicatorProps): import("react").JSX.Element | null;

package/dist/ProgressIndicator.d.ts

@@ -1,7 +1,10 @@
+import { type ProcessStateTranslations } from "./localization.js";
 import { type CSSProperties } from "react";
-import type { ProcessStateController } from "./index";
-import "./ProgressIndicator.css";
+import type { ProcessStateController } from "./index.js";
+
 export interface ConsoleProgressIndicatorOptions {
+    locale?: string;
+    translations?: ProcessStateTranslations;
     className?: string;
     style?: CSSProperties;
     /** Custom label for the determinate progress mode. */
@@ -13,4 +16,4 @@ export interface ConsoleProgressIndicatorProps extends ConsoleProgressIndicatorO
     controller: ProcessStateController;
 }
 /** Read-only, optional status strip; it never modifies terminal output or scroll position. */
-export declare function ConsoleProgressIndicator({ controller, className, style, format, showCleared, }: ConsoleProgressIndicatorProps): import("react").JSX.Element | null;
+export declare function ConsoleProgressIndicator({ controller, className, style, format, showCleared, locale, translations, }: ConsoleProgressIndicatorProps): import("react").JSX.Element | null;

package/dist/index.cjs

@@ -3,35 +3,95 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const react = require("react");
 const jsxRuntime = require("react/jsx-runtime");
 const consoleCore = require("@moyarich/console-core");
+const cleared$3 = "Progress cleared";
+const working$3 = "Working";
+const error$3 = "Process error";
+const paused$3 = "Paused";
+const progress$3 = "In progress";
+const en = {
+  cleared: cleared$3,
+  working: working$3,
+  error: error$3,
+  paused: paused$3,
+  progress: progress$3
+};
+const cleared$2 = "Progreso borrado";
+const working$2 = "Trabajando";
+const error$2 = "Error del proceso";
+const paused$2 = "En pausa";
+const progress$2 = "En curso";
+const es = {
+  cleared: cleared$2,
+  working: working$2,
+  error: error$2,
+  paused: paused$2,
+  progress: progress$2
+};
+const cleared$1 = "Progression effacée";
+const working$1 = "En cours";
+const error$1 = "Erreur du processus";
+const paused$1 = "En pause";
+const progress$1 = "En progression";
+const fr = {
+  cleared: cleared$1,
+  working: working$1,
+  error: error$1,
+  paused: paused$1,
+  progress: progress$1
+};
+const cleared = "Progresso limpo";
+const working = "Trabalhando";
+const error = "Erro do processo";
+const paused = "Pausado";
+const progress = "Em andamento";
+const pt = {
+  cleared,
+  working,
+  error,
+  paused,
+  progress
+};
+const locales = { en, es, fr, pt };
+function resolveProcessStateMessages(locale = "en", overrides) {
+  const tag = locale.replace(/_/g, "-").toLowerCase();
+  return {
+    ...en,
+    ...locales[tag] ?? locales[tag.split("-")[0]] ?? {},
+    ...overrides
+  };
+}
 function ConsoleProgressIndicator({
   controller,
   className,
   style,
   format,
-  showCleared = false
+  showCleared = false,
+  locale = "en",
+  translations
 }) {
   const state = react.useSyncExternalStore(
     controller.subscribe,
     controller.getState,
     controller.getState
   );
-  const progress = state.progress;
-  if (!progress || progress.state === 0 && !showCleared) return null;
-  const value = progress.value ?? 0;
-  const label = progress.state === 0 ? "Progress cleared" : progress.state === 3 ? "Working" : progress.state === 2 ? "Process error" : progress.state === 4 ? "Paused" : "In progress";
-  const description = progress.state === 0 ? label : progress.state === 3 ? label : format?.(value, progress.state) ?? `${label}: ${value}%`;
+  const progress2 = state.progress;
+  const labels = resolveProcessStateMessages(locale, translations);
+  if (!progress2 || progress2.state === 0 && !showCleared) return null;
+  const value = progress2.value ?? 0;
+  const label = progress2.state === 0 ? labels.cleared : progress2.state === 3 ? labels.working : progress2.state === 2 ? labels.error : progress2.state === 4 ? labels.paused : labels.progress;
+  const description = progress2.state === 0 ? label : progress2.state === 3 ? label : format?.(value, progress2.state) ?? `${label}: ${value}%`;
   return /* @__PURE__ */ jsxRuntime.jsxs(
     "div",
     {
       className: ["console-progress-indicator", className].filter(Boolean).join(" "),
-      "data-state": progress.state,
+      "data-state": progress2.state,
       style,
       role: "status",
       "aria-live": "polite",
       "aria-label": description,
       children: [
         /* @__PURE__ */ jsxRuntime.jsx("span", { className: "console-progress-indicator__label", children: description }),
-        progress.state !== 0 && /* @__PURE__ */ jsxRuntime.jsx(
+        progress2.state !== 0 && /* @__PURE__ */ jsxRuntime.jsx(
           "div",
           {
             className: "console-progress-indicator__track",
@@ -39,12 +99,12 @@ function ConsoleProgressIndicator({
             "aria-label": label,
             "aria-valuemin": 0,
             "aria-valuemax": 100,
-            "aria-valuenow": progress.state === 3 ? void 0 : value,
+            "aria-valuenow": progress2.state === 3 ? void 0 : value,
             children: /* @__PURE__ */ jsxRuntime.jsx(
               "div",
               {
                 className: "console-progress-indicator__fill",
-                style: { width: `${progress.state === 3 ? 30 : value}%` }
+                style: { width: `${progress2.state === 3 ? 30 : value}%` }
               }
             )
           }
@@ -263,3 +323,4 @@ exports.consoleProcessStateService = consoleProcessStateService;
 exports.createConsoleProcessStateAddon = createConsoleProcessStateAddon;
 exports.createProcessStateController = createProcessStateController;
 exports.createProcessStateParser = createProcessStateParser;
+exports.resolveProcessStateMessages = resolveProcessStateMessages;

package/dist/index.d.cts

@@ -0,0 +1,58 @@
+import { type ConsoleProgressIndicatorOptions } from "./ProgressIndicator.cjs";
+export { ConsoleProgressIndicator } from "./ProgressIndicator.cjs";
+export { resolveProcessStateMessages } from "./localization.cjs";
+export type { ProcessStateTranslations } from "./localization.cjs";
+export type { ConsoleProgressIndicatorOptions } from "./ProgressIndicator.cjs";
+import { type ConsoleAddon, type ConsoleProcessControlParser } from "@moyarich/console-core";
+export declare const CONSOLE_PROCESS_STATE_ADDON_ID = "@moyarich/console-addon-process-state";
+export interface ProcessState {
+    readonly progress?: {
+        readonly state: number;
+        readonly value?: number;
+    };
+    readonly cwd?: string;
+    readonly command?: {
+        readonly phase: "prompt" | "started" | "executing" | "finished";
+        readonly exitCode?: number;
+    };
+    readonly notifications: readonly {
+        readonly title: string;
+        readonly message: string;
+    }[];
+}
+export type ProcessStateEvent = {
+    readonly type: "progress";
+    readonly state: number;
+    readonly value?: number;
+} | {
+    readonly type: "cwd";
+    readonly cwd: string;
+} | {
+    readonly type: "command";
+    readonly phase: "prompt" | "started" | "executing" | "finished";
+    readonly exitCode?: number;
+} | {
+    readonly type: "notification";
+    readonly title: string;
+    readonly message: string;
+};
+export interface ProcessStateController {
+    getState(): ProcessState;
+    getEvents(): readonly ProcessStateEvent[];
+    subscribe(listener: () => void): () => void;
+    reset(): void;
+    apply(event: ProcessStateEvent): void;
+}
+export declare const consoleProcessStateService: import("@moyarich/console-core").ConsoleServiceToken<ProcessStateController>;
+export declare function createProcessStateController(): ProcessStateController;
+/** Stateful OSC decoder; parsed sequences are removed while printable text is preserved. */
+export declare function createProcessStateParser(controller: ProcessStateController): ConsoleProcessControlParser;
+export interface ProcessStateAddon extends ConsoleAddon {
+    readonly controller: ProcessStateController;
+}
+export interface ProcessStateAddonOptions {
+    controller?: ProcessStateController;
+    /** Set to true or provide options to display a compact status strip. Default: headless. */
+    indicator?: boolean | ConsoleProgressIndicatorOptions;
+}
+export declare function createConsoleProcessStateAddon(options?: ProcessStateController | ProcessStateAddonOptions): ProcessStateAddon;

package/dist/index.d.ts

@@ -1,6 +1,8 @@
-import { type ConsoleProgressIndicatorOptions } from "./ProgressIndicator";
-export { ConsoleProgressIndicator } from "./ProgressIndicator";
-export type { ConsoleProgressIndicatorOptions } from "./ProgressIndicator";
+import { type ConsoleProgressIndicatorOptions } from "./ProgressIndicator.js";
+export { ConsoleProgressIndicator } from "./ProgressIndicator.js";
+export { resolveProcessStateMessages } from "./localization.js";
+export type { ProcessStateTranslations } from "./localization.js";
+export type { ConsoleProgressIndicatorOptions } from "./ProgressIndicator.js";
 import { type ConsoleAddon, type ConsoleProcessControlParser } from "@moyarich/console-core";
 export declare const CONSOLE_PROCESS_STATE_ADDON_ID = "@moyarich/console-addon-process-state";
 export interface ProcessState {

package/dist/index.js

@@ -1,35 +1,95 @@
 import { useSyncExternalStore, createElement } from "react";
 import { jsxs, jsx } from "react/jsx-runtime";
 import { createConsoleServiceToken, consoleExtensionPoints } from "@moyarich/console-core";
+const cleared$3 = "Progress cleared";
+const working$3 = "Working";
+const error$3 = "Process error";
+const paused$3 = "Paused";
+const progress$3 = "In progress";
+const en = {
+  cleared: cleared$3,
+  working: working$3,
+  error: error$3,
+  paused: paused$3,
+  progress: progress$3
+};
+const cleared$2 = "Progreso borrado";
+const working$2 = "Trabajando";
+const error$2 = "Error del proceso";
+const paused$2 = "En pausa";
+const progress$2 = "En curso";
+const es = {
+  cleared: cleared$2,
+  working: working$2,
+  error: error$2,
+  paused: paused$2,
+  progress: progress$2
+};
+const cleared$1 = "Progression effacée";
+const working$1 = "En cours";
+const error$1 = "Erreur du processus";
+const paused$1 = "En pause";
+const progress$1 = "En progression";
+const fr = {
+  cleared: cleared$1,
+  working: working$1,
+  error: error$1,
+  paused: paused$1,
+  progress: progress$1
+};
+const cleared = "Progresso limpo";
+const working = "Trabalhando";
+const error = "Erro do processo";
+const paused = "Pausado";
+const progress = "Em andamento";
+const pt = {
+  cleared,
+  working,
+  error,
+  paused,
+  progress
+};
+const locales = { en, es, fr, pt };
+function resolveProcessStateMessages(locale = "en", overrides) {
+  const tag = locale.replace(/_/g, "-").toLowerCase();
+  return {
+    ...en,
+    ...locales[tag] ?? locales[tag.split("-")[0]] ?? {},
+    ...overrides
+  };
+}
 function ConsoleProgressIndicator({
   controller,
   className,
   style,
   format,
-  showCleared = false
+  showCleared = false,
+  locale = "en",
+  translations
 }) {
   const state = useSyncExternalStore(
     controller.subscribe,
     controller.getState,
     controller.getState
   );
-  const progress = state.progress;
-  if (!progress || progress.state === 0 && !showCleared) return null;
-  const value = progress.value ?? 0;
-  const label = progress.state === 0 ? "Progress cleared" : progress.state === 3 ? "Working" : progress.state === 2 ? "Process error" : progress.state === 4 ? "Paused" : "In progress";
-  const description = progress.state === 0 ? label : progress.state === 3 ? label : format?.(value, progress.state) ?? `${label}: ${value}%`;
+  const progress2 = state.progress;
+  const labels = resolveProcessStateMessages(locale, translations);
+  if (!progress2 || progress2.state === 0 && !showCleared) return null;
+  const value = progress2.value ?? 0;
+  const label = progress2.state === 0 ? labels.cleared : progress2.state === 3 ? labels.working : progress2.state === 2 ? labels.error : progress2.state === 4 ? labels.paused : labels.progress;
+  const description = progress2.state === 0 ? label : progress2.state === 3 ? label : format?.(value, progress2.state) ?? `${label}: ${value}%`;
   return /* @__PURE__ */ jsxs(
     "div",
     {
       className: ["console-progress-indicator", className].filter(Boolean).join(" "),
-      "data-state": progress.state,
+      "data-state": progress2.state,
       style,
       role: "status",
       "aria-live": "polite",
       "aria-label": description,
       children: [
         /* @__PURE__ */ jsx("span", { className: "console-progress-indicator__label", children: description }),
-        progress.state !== 0 && /* @__PURE__ */ jsx(
+        progress2.state !== 0 && /* @__PURE__ */ jsx(
           "div",
           {
             className: "console-progress-indicator__track",
@@ -37,12 +97,12 @@ function ConsoleProgressIndicator({
             "aria-label": label,
             "aria-valuemin": 0,
             "aria-valuemax": 100,
-            "aria-valuenow": progress.state === 3 ? void 0 : value,
+            "aria-valuenow": progress2.state === 3 ? void 0 : value,
             children: /* @__PURE__ */ jsx(
               "div",
               {
                 className: "console-progress-indicator__fill",
-                style: { width: `${progress.state === 3 ? 30 : value}%` }
+                style: { width: `${progress2.state === 3 ? 30 : value}%` }
               }
             )
           }
@@ -261,5 +321,6 @@ export {
   consoleProcessStateService,
   createConsoleProcessStateAddon,
   createProcessStateController,
-  createProcessStateParser
+  createProcessStateParser,
+  resolveProcessStateMessages
 };

package/dist/locales/en.json

@@ -0,0 +1,7 @@
+{
+  "cleared": "Progress cleared",
+  "working": "Working",
+  "error": "Process error",
+  "paused": "Paused",
+  "progress": "In progress"
+}

package/dist/locales/es.json

@@ -0,0 +1,7 @@
+{
+  "cleared": "Progreso borrado",
+  "working": "Trabajando",
+  "error": "Error del proceso",
+  "paused": "En pausa",
+  "progress": "En curso"
+}

package/dist/locales/fr.json

@@ -0,0 +1,7 @@
+{
+  "cleared": "Progression effacée",
+  "working": "En cours",
+  "error": "Erreur du processus",
+  "paused": "En pause",
+  "progress": "En progression"
+}

package/dist/locales/pt.json

@@ -0,0 +1,7 @@
+{
+  "cleared": "Progresso limpo",
+  "working": "Trabalhando",
+  "error": "Erro do processo",
+  "paused": "Pausado",
+  "progress": "Em andamento"
+}

package/dist/localization.d.cts

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

package/dist/localization.d.ts

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

package/dist/styles.css

@@ -0,0 +1,67 @@
+/* src/ProgressIndicator.css */
+.console-progress-indicator {
+  --_progress-fg: var(
+    --console-progress-color,
+    var(--console-color-accent, currentColor)
+  );
+  --_progress-track: var(
+    --console-progress-track,
+    color-mix(in srgb, currentColor 12%, transparent)
+  );
+  --_progress-text: var(--console-progress-text, inherit);
+  /* This overlay has no layout height: updates cannot resize or scroll the terminal. */
+  position: sticky;
+  top: 0;
+  z-index: 2;
+  display: flex;
+  justify-content: flex-end;
+  align-items: center;
+  gap: var(--console-progress-gap, 0.75rem);
+  box-sizing: border-box;
+  height: 0;
+  min-height: 0;
+  padding: 0 var(--console-progress-inline-padding, 0.75rem);
+  pointer-events: none;
+  color: var(--_progress-text);
+  font: inherit;
+  transform: translateY(var(--console-progress-offset, 0.25rem));
+}
+.console-progress-indicator__label {
+  flex: none;
+  font-size: 0.8em;
+}
+.console-progress-indicator__track {
+  flex: 1;
+  height: 0.35rem;
+  border-radius: 999px;
+  background: var(--_progress-track);
+  overflow: hidden;
+}
+.console-progress-indicator__fill {
+  height: 100%;
+  background: var(--_progress-fg);
+  transition: width 120ms linear;
+}
+.console-progress-indicator[data-state="2"] .console-progress-indicator__fill {
+  background: var(--console-progress-error, #b42318);
+}
+.console-progress-indicator[data-state="4"] .console-progress-indicator__fill {
+  background: var(--console-progress-paused, #a46b00);
+}
+.console-progress-indicator[data-state="3"] .console-progress-indicator__fill {
+  animation: console-progress-motion 1.5s ease-in-out infinite alternate;
+}
+@keyframes console-progress-motion {
+  from {
+    transform: translateX(0);
+  }
+  to {
+    transform: translateX(230%);
+  }
+}
+@media (prefers-reduced-motion: reduce) {
+  .console-progress-indicator__fill {
+    transition: none;
+    animation: none !important;
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moyarich/console-addon-process-state",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Observable process state from OSC terminal control sequences",
   "license": "MIT",
   "type": "module",
@@ -9,11 +9,16 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "development": "./src/index.ts",
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
-    }
+      "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"
@@ -22,15 +27,15 @@
     "registry": "https://npm.pkg.github.com"
   },
   "scripts": {
-    "build": "vite build && tsc -p tsconfig.build.json",
+    "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.1.0",
+    "@moyarich/console-core": "^0.2.0",
     "react": ">=18"
   },
   "devDependencies": {
-    "@moyarich/console-core": "0.1.0",
+    "@moyarich/console-core": "0.2.0",
     "typescript": "^5.9.2",
     "vite": "^7.1.5",
     "react": "^19.2.7",
@@ -55,9 +60,13 @@
   "sideEffects": [
     "./src/ProgressIndicator.css",
     "./dist/index.js",
-    "./dist/index.cjs"
+    "./dist/index.cjs",
+    "./dist/styles.css"
   ],
   "publisher": "moyarich",
   "author": "Moya Richards",
+  "engines": {
+    "node": ">=24"
+  },
   "private": false
 }

package/dist/progress.test.d.ts

@@ -1 +0,0 @@
-export {};