@cedarjs/tui 1.0.0-canary.12646 → 1.0.0-canary.12651

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/index.d.ts +13 -1
  2. package/dist/index.d.ts.map +1 -1
  3. package/dist/index.js +22 -2
  4. package/package.json +3 -3
package/dist/index.d.ts CHANGED
@@ -65,7 +65,19 @@ export interface RedwoodTUIConfig {
65
65
  err?: NodeJS.WriteStream;
66
66
  }
67
67
  /**
68
- * TODO: Documentation for this
68
+ * RedwoodTUI
69
+ *
70
+ * A thin wrapper around stdout/stderr that renders static text and
71
+ * "reactive" content (e.g., spinners) to the terminal. It coordinates a
72
+ * shared UpdateManager, handles TTY/non-TTY output, and provides helpers
73
+ * for prompting and boxed messages.
74
+ *
75
+ * Typical usage:
76
+ * const tui = new RedwoodTUI()
77
+ * const content = new ReactiveTUIContent({ spinner: { enabled: true } })
78
+ * tui.startReactive(content)
79
+ * // ...work...
80
+ * tui.stopReactive(true)
69
81
  */
70
82
  export declare class RedwoodTUI {
71
83
  private manager;
package/dist/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAA;AAG3B,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,MAAM,IAAI,cAAc,EAAE,MAAM,UAAU,CAAA;AAGnD;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;CAY1B,CAAA;AAED;;GAEG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,SAAS,CAAC,CAAiB;IAEnC,OAAO,CAAC,IAAI,CAAmB;IAC/B,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,OAAO,CAGd;IACD,OAAO,CAAC,KAAK,CAAe;IAC5B,OAAO,CAAC,aAAa,CAAQ;IAI7B,OAAO,CAAC,YAAY,CAAI;gBAEZ,OAAO,EAAE;QACnB,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;QACxB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,OAAO,CAAC,EAAE;YACR,OAAO,CAAC,EAAE,OAAO,CAAA;YACjB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;SACtB,CAAA;QACD,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAA;QACrB,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAA;QAC3B,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB;IAoBD,MAAM,CAAC,OAAO,EAAE;QACd,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;QACxB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,OAAO,CAAC,EAAE;YACR,OAAO,CAAC,EAAE,OAAO,CAAA;YACjB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;SACtB,CAAA;QACD,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAA;QACrB,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAA;QAC3B,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB;IA0BD,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ;IAajC,cAAc,IAAI,MAAM;IA8BxB,gBAAgB;CAGjB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,GAAG,CAAC,EAAE,MAAM,CAAC,WAAW,CAAA;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC,WAAW,CAAA;CACzB;AAED;;GAEG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,OAAO,CAAe;IAE9B,OAAO,CAAC,SAAS,CAAoB;IACrC,OAAO,CAAC,SAAS,CAAoB;IAErC,OAAO,CAAC,OAAO,CAAC,CAAgB;IAChC,OAAO,CAAC,UAAU,CAAQ;IAE1B,OAAO,CAAC,eAAe,CAAC,CAAoB;gBAEhC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAE,gBAAqB;IAW/C;;;;OAIG;IACH,aAAa,CAAC,eAAe,CAAC,EAAE,kBAAkB;IAkClD;;;;OAIG;IACH,YAAY,CAAC,KAAK,UAAQ;IAyB1B;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAgBpB;;;;OAIG;IACH,kBAAkB,IAAI,kBAAkB,GAAG,SAAS;IAIpD;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM;IAKrB;;;;;;OAMG;IACG,MAAM,CAAC,CAAC,GAAG,MAAM,EACrB,SAAS,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC,GAC9C,OAAO,CAAC,CAAC,CAAC;IAYb;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAW3C;;;;;OAKG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAU9C"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAA;AAG3B,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,MAAM,IAAI,cAAc,EAAE,MAAM,UAAU,CAAA;AAGnD;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;CAY1B,CAAA;AAED;;GAEG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,SAAS,CAAC,CAAiB;IAEnC,OAAO,CAAC,IAAI,CAAmB;IAC/B,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,OAAO,CAGd;IACD,OAAO,CAAC,KAAK,CAAe;IAC5B,OAAO,CAAC,aAAa,CAAQ;IAI7B,OAAO,CAAC,YAAY,CAAI;gBAEZ,OAAO,EAAE;QACnB,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;QACxB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,OAAO,CAAC,EAAE;YACR,OAAO,CAAC,EAAE,OAAO,CAAA;YACjB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;SACtB,CAAA;QACD,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAA;QACrB,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAA;QAC3B,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB;IA4CD,MAAM,CAAC,OAAO,EAAE;QACd,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;QACxB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,OAAO,CAAC,EAAE;YACR,OAAO,CAAC,EAAE,OAAO,CAAA;YACjB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;SACtB,CAAA;QACD,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAA;QACrB,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAA;QAC3B,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB;IAyCD,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ;IAajC,cAAc,IAAI,MAAM;IA8BxB,gBAAgB;CAGjB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,GAAG,CAAC,EAAE,MAAM,CAAC,WAAW,CAAA;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC,WAAW,CAAA;CACzB;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,OAAO,CAAe;IAE9B,OAAO,CAAC,SAAS,CAAoB;IACrC,OAAO,CAAC,SAAS,CAAoB;IAErC,OAAO,CAAC,OAAO,CAAC,CAAgB;IAChC,OAAO,CAAC,UAAU,CAAQ;IAE1B,OAAO,CAAC,eAAe,CAAC,CAAoB;gBAEhC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAE,gBAAqB;IAW/C;;;;OAIG;IACH,aAAa,CAAC,eAAe,CAAC,EAAE,kBAAkB;IAkClD;;;;OAIG;IACH,YAAY,CAAC,KAAK,UAAQ;IAyB1B;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAgBpB;;;;OAIG;IACH,kBAAkB,IAAI,kBAAkB,GAAG,SAAS;IAIpD;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM;IAKrB;;;;;;OAMG;IACG,MAAM,CAAC,CAAC,GAAG,MAAM,EACrB,SAAS,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC,GAC9C,OAAO,CAAC,CAAC,CAAC;IAYb;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAW3C;;;;;OAKG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAU9C"}
package/dist/index.js CHANGED
@@ -69,9 +69,21 @@ class ReactiveTUIContent {
69
69
  (c) => RedwoodStyling.redwood(c)
70
70
  )
71
71
  };
72
+ if (options.spinner?.characters !== void 0 && (!Array.isArray(options.spinner.characters) || options.spinner.characters.length < 2)) {
73
+ throw new Error(
74
+ "tui: `spinner.characters` must be an array with at least 2 entries"
75
+ );
76
+ }
72
77
  this.spinner = { ...defaultSpinner, ...options.spinner };
73
78
  this.boxen = { ...options.boxen };
74
- this.frameInterval = options.frameInterval || 80;
79
+ if (options.frameInterval !== void 0) {
80
+ if (typeof options.frameInterval !== "number" || options.frameInterval <= 0) {
81
+ throw new Error("tui: `frameInterval` must be a number > 0");
82
+ }
83
+ this.frameInterval = options.frameInterval;
84
+ } else {
85
+ this.frameInterval = 80;
86
+ }
75
87
  if (options.outStream) {
76
88
  this.setOutStream(options.outStream);
77
89
  }
@@ -87,6 +99,11 @@ class ReactiveTUIContent {
87
99
  this.content = options.content;
88
100
  }
89
101
  if (options.spinner) {
102
+ if (options.spinner.characters !== void 0 && (!Array.isArray(options.spinner.characters) || options.spinner.characters.length < 2)) {
103
+ throw new Error(
104
+ "tui: `spinner.characters` must be an array with at least 2 entries"
105
+ );
106
+ }
90
107
  this.spinner = { ...this.spinner, ...options.spinner };
91
108
  }
92
109
  if (options.boxen) {
@@ -95,7 +112,10 @@ class ReactiveTUIContent {
95
112
  if (options.outStream) {
96
113
  this.setOutStream(options.outStream);
97
114
  }
98
- if (options.frameInterval) {
115
+ if (options.frameInterval !== void 0) {
116
+ if (typeof options.frameInterval !== "number" || options.frameInterval <= 0) {
117
+ throw new Error("tui: `frameInterval` must be a number > 0");
118
+ }
99
119
  this.frameInterval = options.frameInterval;
100
120
  }
101
121
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cedarjs/tui",
3
- "version": "1.0.0-canary.12646+4b618d891",
3
+ "version": "1.0.0-canary.12651+5b33608d4",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "git+https://github.com/cedarjs/cedar.git",
@@ -26,12 +26,12 @@
26
26
  "stdout-update": "1.6.8"
27
27
  },
28
28
  "devDependencies": {
29
- "@cedarjs/framework-tools": "1.0.0-canary.12646",
29
+ "@cedarjs/framework-tools": "1.0.0-canary.12651",
30
30
  "tsx": "4.20.5",
31
31
  "typescript": "5.6.2"
32
32
  },
33
33
  "publishConfig": {
34
34
  "access": "public"
35
35
  },
36
- "gitHead": "4b618d891e7a4e4755e4960173c97d29a0cf7122"
36
+ "gitHead": "5b33608d48fd4bae4f0483fefbbbf4fac5f80635"
37
37
  }