@xterm/addon-progress 0.1.0

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2024, The xterm.js authors (https://github.com/xtermjs/xterm.js)
+
+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.

package/README.md

@@ -0,0 +1,69 @@
+## @xterm/addon-progress
+
+An xterm.js addon providing an interface for ConEmu's progress sequence.
+See https://conemu.github.io/en/AnsiEscapeCodes.html#ConEmu_specific_OSC for sequence details.
+
+
+### Install
+
+```bash
+npm install --save @xterm/addon-progress
+```
+
+
+### Usage
+
+```ts
+import { Terminal } from '@xterm/xterm';
+import { ProgressAddon, IProgressState } from '@xterm/addon-progress';
+
+const terminal = new Terminal();
+const progressAddon = new ProgressAddon();
+terminal.loadAddon(progressAddon);
+progressAddon.onChange({state, value}: IProgressState) => {
+  // state: 0-4 integer (see below for meaning)
+  // value: 0-100 integer (percent value)
+  
+  // do your visualisation based on state/value here
+  ...
+});
+```
+
+See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/addon-progress/typings/addon-progress.d.ts) for more advanced usage.
+
+### Sequence
+
+The sequence to set progress information has the following format:
+
+```plain
+ESC ] 9 ; 4 ; <state> ; <progress value> BEL
+```
+
+where state is a decimal number in 0 to 4 and progress value is a decimal number in 0 to 100.
+The states have the following meaning:
+
+- 0: Remove any progress indication. Also resets progress value to 0. A given progress value will be ignored.
+- 1: Normal state to set a progress value. The value should be in 0..100, greater values are clamped to 100.
+  If the value is omitted, it will be set to 0.
+- 2: Error state with an optional progress value. An omitted value will be set to 0,
+  which has a special meaning using the last active value.
+- 3: Actual progress is "indeterminate", any progress value will be ignored. Meant to be used to indicate
+  a running task without progress information (e.g. by a spinner). A previously set progress value
+  by any other state sequence will be left untouched.
+- 4: Pause or warning state with an optional progress value. An omitted value will be set to 0,
+  which has a special meaning using the last active value.
+
+The addon resolves most of those semantic nuances and will provide these ready-to-go values:
+- For the remove state (0) any progress value wont be parsed, thus is even allowed to contain garbage.
+  It will always emit `{state: 0, value: 0}`.
+- For the set state (1) an omitted value will be set to 0 emitting `{state: 1, value: 0}`.
+  If a value was given, it must be decimal digits only, any characters outside will mark the whole sequence
+  as faulty (no sloppy integer parsing). The value will be clamped to max 100 giving
+  `{state: 1, value: parsedAndClampedValue}`.
+- For the error and pause state (2 & 4) an omitted or zero value will emit `{state: 2|4, value: lastValue}`.
+  If a value was given, it must be decimal digits only, any characters outside will mark the whole sequence
+  as faulty (no sloppy integer parsing). The value will be clamped to max 100 giving
+  `{state: 2|4, value: parsedAndClampedValue}`.
+- For the indeterminate state (3) a value notion will be ignored.
+  It still emits the value as `{state: 3, value: lastValue}`. Keep in mind not use that value while
+  that state is active, as a task might have entered that state without a proper reset at the beginning.

package/lib/addon-progress.js

@@ -0,0 +1,2 @@
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.ProgressAddon=t():e.ProgressAddon=t()}(globalThis,(()=>(()=>{"use strict";var e={};return(()=>{var t=e;function s(e){let t=0;for(let s=0;s<e.length;++s){const r=e.charCodeAt(s);if(r<48||57<r)return-1;t=10*t+r-48}return t}Object.defineProperty(t,"__esModule",{value:!0}),t.ProgressAddon=void 0,t.ProgressAddon=class{constructor(){this._st=0,this._pr=0}dispose(){this._seqHandler?.dispose(),this._onChange?.dispose()}activate(e){this._seqHandler=e.parser.registerOscHandler(9,(e=>{if(!e.startsWith("4;"))return!1;const t=e.split(";");if(t.length>3)return!0;2===t.length&&t.push("");const r=s(t[1]),o=s(t[2]);switch(r){case 0:this.progress={state:r,value:0};break;case 1:if(o<0)return!0;this.progress={state:r,value:o};break;case 2:case 4:if(o<0)return!0;this.progress={state:r,value:o||this._pr};break;case 3:this.progress={state:r,value:this._pr}}return!0})),this._onChange=new e._core._onData.constructor,this.onChange=this._onChange.event}get progress(){return{state:this._st,value:this._pr}}set progress(e){e.state<0||e.state>4?console.warn("progress state out of bounds, not applied"):(this._st=e.state,this._pr=Math.min(Math.max(e.value,0),100),this._onChange?.fire({state:this._st,value:this._pr}))}}})(),e})()));
+//# sourceMappingURL=addon-progress.js.map

package/lib/addon-progress.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addon-progress.js","mappings":"CAAA,SAA2CA,EAAMC,GAC1B,iBAAZC,SAA0C,iBAAXC,OACxCA,OAAOD,QAAUD,IACQ,mBAAXG,QAAyBA,OAAOC,IAC9CD,OAAO,GAAIH,GACe,iBAAZC,QACdA,QAAuB,cAAID,IAE3BD,EAAoB,cAAIC,GACzB,CATD,CASGK,YAAY,I,gDCaf,SAASC,EAAMC,GACb,IAAIC,EAAI,EACR,IAAK,IAAIC,EAAI,EAAGA,EAAIF,EAAEG,SAAUD,EAAG,CACjC,MAAME,EAAIJ,EAAEK,WAAWH,GACvB,GAAIE,EAAI,IAAQ,GAAOA,EACrB,OAAQ,EAEVH,EAAQ,GAAJA,EAASG,EAAI,EACnB,CACA,OAAOH,CACT,C,wEAGA,oCAEU,KAAAK,IAAG,EACH,KAAAC,IAAM,CA8DhB,CA1DS,OAAAC,GACLC,KAAKC,aAAaF,UAClBC,KAAKE,WAAWH,SAClB,CAEO,QAAAI,CAASC,GACdJ,KAAKC,YAAcG,EAASC,OAAOC,mBAAmB,GAAGC,IACvD,IAAKA,EAAKC,WAAW,MACnB,OAAO,EAET,MAAMC,EAAQF,EAAKG,MAAM,KAEzB,GAAID,EAAMf,OAAS,EACjB,OAAO,EAEY,IAAjBe,EAAMf,QACRe,EAAME,KAAK,IAEb,MAAMC,EAAKtB,EAAMmB,EAAM,IACjBI,EAAKvB,EAAMmB,EAAM,IAEvB,OAAQG,GACN,KAAK,EACHZ,KAAKc,SAAW,CAAEC,MAAOH,EAAII,MAAO,GACpC,MACF,KAAK,EACH,GAAIH,EAAK,EAAG,OAAO,EACnBb,KAAKc,SAAW,CAAEC,MAAOH,EAAII,MAAOH,GACpC,MACF,KAAK,EACL,KAAK,EACH,GAAIA,EAAK,EAAG,OAAO,EACnBb,KAAKc,SAAW,CAAEC,MAAOH,EAAII,MAAOH,GAAMb,KAAKF,KAC/C,MACF,KAAK,EACHE,KAAKc,SAAW,CAAEC,MAAOH,EAAII,MAAOhB,KAAKF,KAG7C,OAAO,CAAI,IAGbE,KAAKE,UAAY,IAAKE,EAAiBa,MAAMC,QAAQC,YACrDnB,KAAKoB,SAAWpB,KAAKE,UAAWmB,KAClC,CAEA,YAAWP,GACT,MAAO,CAAEC,MAAOf,KAAKH,IAAKmB,MAAOhB,KAAKF,IACxC,CAEA,YAAWgB,CAASA,GACdA,EAASC,MAAQ,GAAKD,EAASC,MAAQ,EACzCO,QAAQC,KAAK,8CAGfvB,KAAKH,IAAMiB,EAASC,MACpBf,KAAKF,IAAM0B,KAAKC,IAAID,KAAKE,IAAIZ,EAASE,MAAO,GAAI,KACjDhB,KAAKE,WAAWyB,KAAK,CAAEZ,MAAOf,KAAKH,IAAKmB,MAAOhB,KAAKF,MACtD,E","sources":["webpack://ProgressAddon/webpack/universalModuleDefinition","webpack://ProgressAddon/./src/ProgressAddon.ts"],"sourcesContent":["(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ProgressAddon\"] = factory();\n\telse\n\t\troot[\"ProgressAddon\"] = factory();\n})(globalThis, () => {\nreturn ","/**\n * Copyright (c) 2024 The xterm.js authors. All rights reserved.\n * @license MIT\n */\n\nimport type { Terminal, ITerminalAddon, IDisposable } from '@xterm/xterm';\nimport type { ProgressAddon as IProgressApi, IProgressState } from '@xterm/addon-progress';\nimport type { Emitter, Event } from 'vs/base/common/event';\n\n\nconst enum ProgressType {\n  REMOVE = 0,\n  SET = 1,\n  ERROR = 2,\n  INDETERMINATE = 3,\n  PAUSE = 4\n}\n\n\n/**\n * Strict integer parsing, only decimal digits allowed.\n */\nfunction toInt(s: string): number {\n  let v = 0;\n  for (let i = 0; i < s.length; ++i) {\n    const c = s.charCodeAt(i);\n    if (c < 0x30 || 0x39 < c) {\n      return -1;\n    }\n    v = v * 10 + c - 48;\n  }\n  return v;\n}\n\n\nexport class ProgressAddon implements ITerminalAddon, IProgressApi {\n  private _seqHandler: IDisposable | undefined;\n  private _st: ProgressType = ProgressType.REMOVE;\n  private _pr = 0;\n  private _onChange: Emitter<IProgressState> | undefined;\n  public onChange: Event<IProgressState> | undefined;\n\n  public dispose(): void {\n    this._seqHandler?.dispose();\n    this._onChange?.dispose();\n  }\n\n  public activate(terminal: Terminal): void {\n    this._seqHandler = terminal.parser.registerOscHandler(9, data => {\n      if (!data.startsWith('4;')) {\n        return false;\n      }\n      const parts = data.split(';');\n\n      if (parts.length > 3) {\n        return true;  // faulty sequence, just exit\n      }\n      if (parts.length === 2) {\n        parts.push('');\n      }\n      const st = toInt(parts[1]);\n      const pr = toInt(parts[2]);\n\n      switch (st) {\n        case ProgressType.REMOVE:\n          this.progress = { state: st, value: 0 };\n          break;\n        case ProgressType.SET:\n          if (pr < 0) return true;  // faulty sequence, just exit\n          this.progress = { state: st, value: pr };\n          break;\n        case ProgressType.ERROR:\n        case ProgressType.PAUSE:\n          if (pr < 0) return true;  // faulty sequence, just exit\n          this.progress = { state: st, value: pr || this._pr };\n          break;\n        case ProgressType.INDETERMINATE:\n          this.progress = { state: st, value: this._pr };\n          break;\n      }\n      return true;\n    });\n    // FIXME: borrow emitter ctor from xterm, to be changed once #5283 is resolved\n    this._onChange = new (terminal as any)._core._onData.constructor();\n    this.onChange = this._onChange!.event;\n  }\n\n  public get progress(): IProgressState {\n    return { state: this._st, value: this._pr };\n  }\n\n  public set progress(progress: IProgressState) {\n    if (progress.state < 0 || progress.state > 4) {\n      console.warn(`progress state out of bounds, not applied`);\n      return;\n    }\n    this._st = progress.state;\n    this._pr = Math.min(Math.max(progress.value, 0), 100);\n    this._onChange?.fire({ state: this._st, value: this._pr });\n  }\n}\n"],"names":["root","factory","exports","module","define","amd","globalThis","toInt","s","v","i","length","c","charCodeAt","_st","_pr","dispose","this","_seqHandler","_onChange","activate","terminal","parser","registerOscHandler","data","startsWith","parts","split","push","st","pr","progress","state","value","_core","_onData","constructor","onChange","event","console","warn","Math","min","max","fire"],"sourceRoot":""}

package/lib/addon-progress.mjs

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2014-2024 The xterm.js authors. All rights reserved.
+ * @license MIT
+ *
+ * Copyright (c) 2012-2013, Christopher Jeffrey (MIT License)
+ * @license MIT
+ *
+ * Originally forked from (with the author's permission):
+ *   Fabrice Bellard's javascript vt100 for jslinux:
+ *   http://bellard.org/jslinux/
+ *   Copyright (c) 2011 Fabrice Bellard
+ */
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+function i(n){let t=0;for(let s=0;s<n.length;++s){let e=n.charCodeAt(s);if(e<48||57<e)return-1;t=t*10+e-48}return t}var o=class{constructor(){this._st=0;this._pr=0}dispose(){this._seqHandler?.dispose(),this._onChange?.dispose()}activate(t){this._seqHandler=t.parser.registerOscHandler(9,s=>{if(!s.startsWith("4;"))return!1;let e=s.split(";");if(e.length>3)return!0;e.length===2&&e.push("");let r=i(e[1]),a=i(e[2]);switch(r){case 0:this.progress={state:r,value:0};break;case 1:if(a<0)return!0;this.progress={state:r,value:a};break;case 2:case 4:if(a<0)return!0;this.progress={state:r,value:a||this._pr};break;case 3:this.progress={state:r,value:this._pr};break}return!0}),this._onChange=new t._core._onData.constructor,this.onChange=this._onChange.event}get progress(){return{state:this._st,value:this._pr}}set progress(t){if(t.state<0||t.state>4){console.warn("progress state out of bounds, not applied");return}this._st=t.state,this._pr=Math.min(Math.max(t.value,0),100),this._onChange?.fire({state:this._st,value:this._pr})}};export{o as ProgressAddon};
+//# sourceMappingURL=addon-progress.mjs.map

package/lib/addon-progress.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/ProgressAddon.ts"],
+  "sourcesContent": ["/**\n * Copyright (c) 2024 The xterm.js authors. All rights reserved.\n * @license MIT\n */\n\nimport type { Terminal, ITerminalAddon, IDisposable } from '@xterm/xterm';\nimport type { ProgressAddon as IProgressApi, IProgressState } from '@xterm/addon-progress';\nimport type { Emitter, Event } from 'vs/base/common/event';\n\n\nconst enum ProgressType {\n  REMOVE = 0,\n  SET = 1,\n  ERROR = 2,\n  INDETERMINATE = 3,\n  PAUSE = 4\n}\n\n\n/**\n * Strict integer parsing, only decimal digits allowed.\n */\nfunction toInt(s: string): number {\n  let v = 0;\n  for (let i = 0; i < s.length; ++i) {\n    const c = s.charCodeAt(i);\n    if (c < 0x30 || 0x39 < c) {\n      return -1;\n    }\n    v = v * 10 + c - 48;\n  }\n  return v;\n}\n\n\nexport class ProgressAddon implements ITerminalAddon, IProgressApi {\n  private _seqHandler: IDisposable | undefined;\n  private _st: ProgressType = ProgressType.REMOVE;\n  private _pr = 0;\n  private _onChange: Emitter<IProgressState> | undefined;\n  public onChange: Event<IProgressState> | undefined;\n\n  public dispose(): void {\n    this._seqHandler?.dispose();\n    this._onChange?.dispose();\n  }\n\n  public activate(terminal: Terminal): void {\n    this._seqHandler = terminal.parser.registerOscHandler(9, data => {\n      if (!data.startsWith('4;')) {\n        return false;\n      }\n      const parts = data.split(';');\n\n      if (parts.length > 3) {\n        return true;  // faulty sequence, just exit\n      }\n      if (parts.length === 2) {\n        parts.push('');\n      }\n      const st = toInt(parts[1]);\n      const pr = toInt(parts[2]);\n\n      switch (st) {\n        case ProgressType.REMOVE:\n          this.progress = { state: st, value: 0 };\n          break;\n        case ProgressType.SET:\n          if (pr < 0) return true;  // faulty sequence, just exit\n          this.progress = { state: st, value: pr };\n          break;\n        case ProgressType.ERROR:\n        case ProgressType.PAUSE:\n          if (pr < 0) return true;  // faulty sequence, just exit\n          this.progress = { state: st, value: pr || this._pr };\n          break;\n        case ProgressType.INDETERMINATE:\n          this.progress = { state: st, value: this._pr };\n          break;\n      }\n      return true;\n    });\n    // FIXME: borrow emitter ctor from xterm, to be changed once #5283 is resolved\n    this._onChange = new (terminal as any)._core._onData.constructor();\n    this.onChange = this._onChange!.event;\n  }\n\n  public get progress(): IProgressState {\n    return { state: this._st, value: this._pr };\n  }\n\n  public set progress(progress: IProgressState) {\n    if (progress.state < 0 || progress.state > 4) {\n      console.warn(`progress state out of bounds, not applied`);\n      return;\n    }\n    this._st = progress.state;\n    this._pr = Math.min(Math.max(progress.value, 0), 100);\n    this._onChange?.fire({ state: this._st, value: this._pr });\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;AAsBA,SAASA,EAAMC,EAAmB,CAChC,IAAIC,EAAI,EACR,QAASC,EAAI,EAAGA,EAAIF,EAAE,OAAQ,EAAEE,EAAG,CACjC,IAAMC,EAAIH,EAAE,WAAWE,CAAC,EACxB,GAAIC,EAAI,IAAQ,GAAOA,EACrB,MAAO,GAETF,EAAIA,EAAI,GAAKE,EAAI,EACnB,CACA,OAAOF,CACT,CAGO,IAAMG,EAAN,KAA4D,CAA5D,cAEL,KAAQ,IAAoB,EAC5B,KAAQ,IAAM,EAIP,SAAgB,CACrB,KAAK,aAAa,QAAQ,EAC1B,KAAK,WAAW,QAAQ,CAC1B,CAEO,SAASC,EAA0B,CACxC,KAAK,YAAcA,EAAS,OAAO,mBAAmB,EAAGC,GAAQ,CAC/D,GAAI,CAACA,EAAK,WAAW,IAAI,EACvB,MAAO,GAET,IAAMC,EAAQD,EAAK,MAAM,GAAG,EAE5B,GAAIC,EAAM,OAAS,EACjB,MAAO,GAELA,EAAM,SAAW,GACnBA,EAAM,KAAK,EAAE,EAEf,IAAMC,EAAKT,EAAMQ,EAAM,CAAC,CAAC,EACnBE,EAAKV,EAAMQ,EAAM,CAAC,CAAC,EAEzB,OAAQC,EAAI,CACV,IAAK,GACH,KAAK,SAAW,CAAE,MAAOA,EAAI,MAAO,CAAE,EACtC,MACF,IAAK,GACH,GAAIC,EAAK,EAAG,MAAO,GACnB,KAAK,SAAW,CAAE,MAAOD,EAAI,MAAOC,CAAG,EACvC,MACF,IAAK,GACL,IAAK,GACH,GAAIA,EAAK,EAAG,MAAO,GACnB,KAAK,SAAW,CAAE,MAAOD,EAAI,MAAOC,GAAM,KAAK,GAAI,EACnD,MACF,IAAK,GACH,KAAK,SAAW,CAAE,MAAOD,EAAI,MAAO,KAAK,GAAI,EAC7C,KACJ,CACA,MAAO,EACT,CAAC,EAED,KAAK,UAAY,IAAKH,EAAiB,MAAM,QAAQ,YACrD,KAAK,SAAW,KAAK,UAAW,KAClC,CAEA,IAAW,UAA2B,CACpC,MAAO,CAAE,MAAO,KAAK,IAAK,MAAO,KAAK,GAAI,CAC5C,CAEA,IAAW,SAASK,EAA0B,CAC5C,GAAIA,EAAS,MAAQ,GAAKA,EAAS,MAAQ,EAAG,CAC5C,QAAQ,KAAK,2CAA2C,EACxD,MACF,CACA,KAAK,IAAMA,EAAS,MACpB,KAAK,IAAM,KAAK,IAAI,KAAK,IAAIA,EAAS,MAAO,CAAC,EAAG,GAAG,EACpD,KAAK,WAAW,KAAK,CAAE,MAAO,KAAK,IAAK,MAAO,KAAK,GAAI,CAAC,CAC3D,CACF",
+  "names": ["toInt", "s", "v", "i", "c", "ProgressAddon", "terminal", "data", "parts", "st", "pr", "progress"]
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@xterm/addon-progress",
+  "version": "0.1.0",
+  "author": {
+    "name": "The xterm.js authors",
+    "url": "https://xtermjs.org/"
+  },
+  "main": "lib/addon-progress.js",
+  "module": "lib/addon-progress.mjs",
+  "types": "typings/addon-progress.d.ts",
+  "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-progress",
+  "license": "MIT",
+  "keywords": [
+    "terminal",
+    "xterm",
+    "xterm.js"
+  ],
+  "scripts": {
+    "build": "../../node_modules/.bin/tsc -p .",
+    "prepackage": "npm run build",
+    "package": "../../node_modules/.bin/webpack",
+    "prepublishOnly": "npm run package",
+    "start": "node ../../demo/start"
+  },
+  "peerDependencies": {
+    "@xterm/xterm": "^5.6.0-beta.94"
+  },
+  "commit": "330e91ef080ae27ae92ced116fc0cc1346a1f16a"
+}

package/src/ProgressAddon.ts

@@ -0,0 +1,101 @@
+/**
+ * Copyright (c) 2024 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+import type { Terminal, ITerminalAddon, IDisposable } from '@xterm/xterm';
+import type { ProgressAddon as IProgressApi, IProgressState } from '@xterm/addon-progress';
+import type { Emitter, Event } from 'vs/base/common/event';
+
+
+const enum ProgressType {
+  REMOVE = 0,
+  SET = 1,
+  ERROR = 2,
+  INDETERMINATE = 3,
+  PAUSE = 4
+}
+
+
+/**
+ * Strict integer parsing, only decimal digits allowed.
+ */
+function toInt(s: string): number {
+  let v = 0;
+  for (let i = 0; i < s.length; ++i) {
+    const c = s.charCodeAt(i);
+    if (c < 0x30 || 0x39 < c) {
+      return -1;
+    }
+    v = v * 10 + c - 48;
+  }
+  return v;
+}
+
+
+export class ProgressAddon implements ITerminalAddon, IProgressApi {
+  private _seqHandler: IDisposable | undefined;
+  private _st: ProgressType = ProgressType.REMOVE;
+  private _pr = 0;
+  private _onChange: Emitter<IProgressState> | undefined;
+  public onChange: Event<IProgressState> | undefined;
+
+  public dispose(): void {
+    this._seqHandler?.dispose();
+    this._onChange?.dispose();
+  }
+
+  public activate(terminal: Terminal): void {
+    this._seqHandler = terminal.parser.registerOscHandler(9, data => {
+      if (!data.startsWith('4;')) {
+        return false;
+      }
+      const parts = data.split(';');
+
+      if (parts.length > 3) {
+        return true;  // faulty sequence, just exit
+      }
+      if (parts.length === 2) {
+        parts.push('');
+      }
+      const st = toInt(parts[1]);
+      const pr = toInt(parts[2]);
+
+      switch (st) {
+        case ProgressType.REMOVE:
+          this.progress = { state: st, value: 0 };
+          break;
+        case ProgressType.SET:
+          if (pr < 0) return true;  // faulty sequence, just exit
+          this.progress = { state: st, value: pr };
+          break;
+        case ProgressType.ERROR:
+        case ProgressType.PAUSE:
+          if (pr < 0) return true;  // faulty sequence, just exit
+          this.progress = { state: st, value: pr || this._pr };
+          break;
+        case ProgressType.INDETERMINATE:
+          this.progress = { state: st, value: this._pr };
+          break;
+      }
+      return true;
+    });
+    // FIXME: borrow emitter ctor from xterm, to be changed once #5283 is resolved
+    this._onChange = new (terminal as any)._core._onData.constructor();
+    this.onChange = this._onChange!.event;
+  }
+
+  public get progress(): IProgressState {
+    return { state: this._st, value: this._pr };
+  }
+
+  public set progress(progress: IProgressState) {
+    if (progress.state < 0 || progress.state > 4) {
+      console.warn(`progress state out of bounds, not applied`);
+      return;
+    }
+    this._st = progress.state;
+    this._pr = Math.min(Math.max(progress.value, 0), 100);
+    this._onChange?.fire({ state: this._st, value: this._pr });
+  }
+}

package/typings/addon-progress.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Copyright (c) 2024 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+import { Terminal, ITerminalAddon, IDisposable } from '@xterm/xterm';
+import type { Event } from 'vs/base/common/event';
+
+
+declare module '@xterm/addon-progress' {
+  /**
+   * An xterm.js addon that provides an interface for ConEmu's progress
+   * sequence.
+   */
+  export class ProgressAddon implements ITerminalAddon, IDisposable {
+    
+    /**
+     * Creates a new progress addon
+     */
+    constructor();
+
+    /**
+     * Activates the addon
+     * @param terminal The terminal the addon is being loaded in.
+     */
+    public activate(terminal: Terminal): void;
+    
+    /**
+     * Disposes the addon.
+     */
+    public dispose(): void;
+
+    /**
+     * An event that fires when the tracked progress changes.
+     */
+    public readonly onChange: Event<IProgressState> | undefined;
+
+    /**
+     * Gets or sets the current progress tracked by the addon.
+     * This can also be used to reset a stuck progress indicator
+     * back to initial with `{state: 0, value: 0}`
+     * or to restore an indicator.
+     */
+    public progress: IProgressState;
+  }
+  
+  /**
+   * Progress state tracked by the addon.
+   */
+  export interface IProgressState {
+    state: 0 | 1 | 2 | 3 | 4;
+    value: number;
+  }
+}