@visulima/pail 4.0.0-alpha.2 → 4.0.0-alpha.21

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 (131) hide show
  1. package/CHANGELOG.md +371 -0
  2. package/LICENSE.md +148 -879
  3. package/README.md +323 -0
  4. package/dist/error.d.ts +103 -0
  5. package/dist/error.js +5 -0
  6. package/dist/index.browser.d.ts +557 -45
  7. package/dist/index.browser.js +19 -12
  8. package/dist/index.server.d.ts +724 -63
  9. package/dist/index.server.js +27 -529
  10. package/dist/middleware/elysia.d.ts +73 -0
  11. package/dist/middleware/elysia.js +1 -0
  12. package/dist/middleware/express.d.ts +88 -0
  13. package/dist/middleware/express.js +1 -0
  14. package/dist/middleware/fastify.d.ts +83 -0
  15. package/dist/middleware/fastify.js +1 -0
  16. package/dist/middleware/hono.d.ts +87 -0
  17. package/dist/middleware/hono.js +1 -0
  18. package/dist/middleware/next/handler.d.ts +103 -0
  19. package/dist/middleware/next/handler.js +1 -0
  20. package/dist/middleware/sveltekit.d.ts +125 -0
  21. package/dist/middleware/sveltekit.js +1 -0
  22. package/dist/object-tree.d.ts +67 -70
  23. package/dist/object-tree.js +2 -89
  24. package/dist/packem_shared/AbstractJsonReporter-CF0KKdQS.js +1 -0
  25. package/dist/packem_shared/AbstractJsonReporter-CVwjgboT.js +1 -0
  26. package/dist/packem_shared/JsonReporter-BJFnahby.js +1 -0
  27. package/dist/packem_shared/JsonReporter-CnLM-d0U.js +2 -0
  28. package/dist/packem_shared/PrettyReporter-D75CJT0C.js +5 -0
  29. package/dist/packem_shared/PrettyReporter-D9aBMmxI.js +45 -0
  30. package/dist/packem_shared/abstract-json-reporter.d-Boj5w068.d.ts +61 -0
  31. package/dist/packem_shared/abstract-pretty-reporter-zijeSUgy.js +34 -0
  32. package/dist/packem_shared/constants-DKfCaSUR.js +1 -0
  33. package/dist/packem_shared/constants-ep2nsfdy.js +1 -0
  34. package/dist/packem_shared/create-middleware-logger.d-MK7moe4r.d.ts +47 -0
  35. package/dist/packem_shared/createPailError-CbU1Ogfa.js +5 -0
  36. package/dist/packem_shared/headers-D-K_EnkH.js +1 -0
  37. package/dist/packem_shared/index-COQEZODZ.js +1 -0
  38. package/dist/packem_shared/pailMiddleware-B5DJoBYl.js +1 -0
  39. package/dist/packem_shared/storage-DaXAlpiO.js +1 -0
  40. package/dist/packem_shared/types.d-Ck_RSjLg.d.ts +246 -0
  41. package/dist/packem_shared/types.d-Cz9S7jZh.d.ts +201 -0
  42. package/dist/packem_shared/types.d-xxE3FOD3.d.ts +229 -0
  43. package/dist/packem_shared/useLogger-DB34CuU5.js +1 -0
  44. package/dist/packem_shared/wide-event.d-DkYD7YVK.d.ts +705 -0
  45. package/dist/packem_shared/write-console-log-based-on-level-DDSKGBKj.js +1 -0
  46. package/dist/packem_shared/write-stream-B6BXco86.js +1 -0
  47. package/dist/processor/caller/caller-processor.d.ts +49 -47
  48. package/dist/processor/caller/caller-processor.js +1 -59
  49. package/dist/processor/environment-processor.d.ts +124 -0
  50. package/dist/processor/environment-processor.js +1 -0
  51. package/dist/processor/message-formatter-processor.d.ts +51 -50
  52. package/dist/processor/message-formatter-processor.js +1 -66
  53. package/dist/processor/opentelemetry-processor.d.ts +69 -66
  54. package/dist/processor/opentelemetry-processor.js +1 -52
  55. package/dist/processor/redact-processor.d.ts +60 -41
  56. package/dist/processor/redact-processor.js +1 -30
  57. package/dist/processor/sampling-processor.d.ts +112 -0
  58. package/dist/processor/sampling-processor.js +1 -0
  59. package/dist/reporter/file/json-file-reporter.d.ts +91 -42
  60. package/dist/reporter/file/json-file-reporter.js +2 -136
  61. package/dist/reporter/http/abstract-http-reporter.d.ts +213 -211
  62. package/dist/reporter/http/abstract-http-reporter.js +2 -435
  63. package/dist/reporter/http/http-reporter.d.ts +40 -36
  64. package/dist/reporter/http/http-reporter.edge-light.d.ts +430 -38
  65. package/dist/reporter/http/http-reporter.edge-light.js +2 -651
  66. package/dist/reporter/http/http-reporter.js +1 -13
  67. package/dist/reporter/json/index.browser.d.ts +98 -3
  68. package/dist/reporter/json/index.browser.js +1 -2
  69. package/dist/reporter/json/index.d.ts +51 -3
  70. package/dist/reporter/json/index.js +1 -2
  71. package/dist/reporter/pretty/index.browser.d.ts +105 -2
  72. package/dist/reporter/pretty/index.browser.js +1 -1
  73. package/dist/reporter/pretty/index.d.ts +183 -2
  74. package/dist/reporter/pretty/index.js +1 -1
  75. package/dist/reporter/simple/simple-reporter.server.d.ts +133 -18
  76. package/dist/reporter/simple/simple-reporter.server.js +8 -186
  77. package/dist/wide-event.d.ts +5 -0
  78. package/dist/wide-event.js +1 -0
  79. package/package.json +87 -37
  80. package/dist/constants.d.ts +0 -37
  81. package/dist/interactive/index.d.ts +0 -2
  82. package/dist/interactive/index.js +0 -2
  83. package/dist/interactive/interactive-manager.d.ts +0 -108
  84. package/dist/interactive/interactive-stream-hook.d.ts +0 -68
  85. package/dist/packem_shared/AbstractJsonReporter-BaZ33PlE.js +0 -204
  86. package/dist/packem_shared/InteractiveManager-CbE7d1kY.js +0 -172
  87. package/dist/packem_shared/InteractiveStreamHook-DiSubbJ1.js +0 -21
  88. package/dist/packem_shared/JsonReporter-BRw4skd5.js +0 -28
  89. package/dist/packem_shared/JsonReporter-VzgyLEYz.js +0 -58
  90. package/dist/packem_shared/PrettyReporter-C2wVB7yu.js +0 -222
  91. package/dist/packem_shared/PrettyReporter-DySIXBjQ.js +0 -169
  92. package/dist/packem_shared/abstract-pretty-reporter-Di_sdm2r.js +0 -50
  93. package/dist/packem_shared/constants-omsTHUWB.js +0 -119
  94. package/dist/packem_shared/format-label-De49vNPd.js +0 -1193
  95. package/dist/packem_shared/get-longest-label-C9PWeyKq.js +0 -9
  96. package/dist/packem_shared/index-BomQ3E6J.js +0 -650
  97. package/dist/packem_shared/index-EZ_WSQZS.js +0 -1146
  98. package/dist/packem_shared/interactive-stream-hook-DG4BtN12.js +0 -141
  99. package/dist/packem_shared/pail.browser-u2CSR_af.js +0 -1427
  100. package/dist/packem_shared/write-console-log-based-on-level-DBmRYXpj.js +0 -14
  101. package/dist/packem_shared/write-stream-BG8fhcs3.js +0 -6
  102. package/dist/pail.browser.d.ts +0 -412
  103. package/dist/pail.server.d.ts +0 -233
  104. package/dist/processor/caller/get-caller-filename.d.ts +0 -23
  105. package/dist/progress-bar.d.ts +0 -136
  106. package/dist/progress-bar.js +0 -404
  107. package/dist/reporter/file/utils/rotating-file-stream.d.ts +0 -48
  108. package/dist/reporter/http/utils/compression.d.ts +0 -7
  109. package/dist/reporter/http/utils/log-size-error.d.ts +0 -30
  110. package/dist/reporter/http/utils/retry.d.ts +0 -27
  111. package/dist/reporter/json/abstract-json-reporter.d.ts +0 -61
  112. package/dist/reporter/json/json-reporter.browser.d.ts +0 -40
  113. package/dist/reporter/json/json-reporter.server.d.ts +0 -50
  114. package/dist/reporter/pretty/abstract-pretty-reporter.d.ts +0 -83
  115. package/dist/reporter/pretty/pretty-reporter.browser.d.ts +0 -36
  116. package/dist/reporter/pretty/pretty-reporter.server.d.ts +0 -70
  117. package/dist/reporter/raw/raw-reporter.browser.d.ts +0 -5
  118. package/dist/reporter/raw/raw-reporter.server.d.ts +0 -13
  119. package/dist/reporter/utils/default-inspector-config.d.ts +0 -3
  120. package/dist/reporter/utils/format-label.d.ts +0 -3
  121. package/dist/spinner.d.ts +0 -220
  122. package/dist/spinner.js +0 -2150
  123. package/dist/types.d.ts +0 -241
  124. package/dist/utils/ansi-escapes.d.ts +0 -4
  125. package/dist/utils/arrayify.d.ts +0 -2
  126. package/dist/utils/get-longest-badge.d.ts +0 -4
  127. package/dist/utils/get-longest-label.d.ts +0 -4
  128. package/dist/utils/merge-types.d.ts +0 -4
  129. package/dist/utils/stream/safe-stream-handler.d.ts +0 -21
  130. package/dist/utils/write-console-log-based-on-level.d.ts +0 -4
  131. package/dist/utils/write-stream.d.ts +0 -2
@@ -1,136 +0,0 @@
1
- import type InteractiveManager from "./interactive/interactive-manager.d.ts";
2
- export type ProgressBarStyle = "shades_classic" | "shades_grey" | "rect" | "filled" | "solid" | "ascii" | "custom";
3
- export interface ProgressBarOptions {
4
- barCompleteChar?: string | string[];
5
- barGlue?: string;
6
- barIncompleteChar?: string | string[];
7
- current?: number;
8
- format?: string;
9
- fps?: number;
10
- style?: ProgressBarStyle;
11
- total: number;
12
- width?: number;
13
- }
14
- export interface SingleBarOptions extends ProgressBarOptions {
15
- format?: string;
16
- }
17
- export interface MultiBarOptions {
18
- barCompleteChar?: string | string[];
19
- barGlue?: string;
20
- barIncompleteChar?: string | string[];
21
- composite?: boolean;
22
- format?: string;
23
- fps?: number;
24
- style?: ProgressBarStyle;
25
- }
26
- export interface ProgressBarPayload {
27
- [key: string]: string | number | boolean;
28
- }
29
- /**
30
- * Gets the appropriate bar character based on style and completion state.
31
- * @param char Custom character override
32
- * @param style Progress bar style to use
33
- * @param complete Whether to get completed or incomplete character
34
- * @returns The appropriate character for the given style
35
- */
36
- export declare const getBarChar: (char: string | undefined, style: ProgressBarStyle, complete?: boolean) => string;
37
- export declare const applyStyleToOptions: <T extends ProgressBarOptions | MultiBarOptions>(options: T) => T;
38
- export declare class ProgressBar {
39
- protected options: ProgressBarOptions;
40
- protected current: number;
41
- private startTime;
42
- private interactiveManager?;
43
- private isActive;
44
- private payload?;
45
- /**
46
- * Creates a new progress bar instance.
47
- * @param options Configuration options for the progress bar
48
- * @param interactiveManager Optional interactive manager for rendering
49
- * @param payload Optional initial payload data for format placeholders
50
- */
51
- constructor(options: ProgressBarOptions, interactiveManager?: InteractiveManager, payload?: ProgressBarPayload);
52
- /**
53
- * Updates the progress bar to a new value.
54
- * @param current The current progress value
55
- * @param payload Optional payload data to merge with existing data
56
- */
57
- update(current: number, payload?: ProgressBarPayload): void;
58
- /**
59
- * Increments the progress bar by a specified step.
60
- * @param step Amount to increment (default: 1)
61
- * @param payload Optional payload data to merge with existing data
62
- */
63
- increment(step?: number, payload?: ProgressBarPayload): void;
64
- /**
65
- * Renders the progress bar as a formatted string.
66
- * @returns Formatted progress bar string with all placeholders replaced
67
- */
68
- render(): string;
69
- /**
70
- * Starts the progress bar.
71
- * @param total Optional total value to set
72
- * @param startValue Optional starting value
73
- * @param payload Optional initial payload data
74
- */
75
- start(total?: number, startValue?: number, payload?: ProgressBarPayload): void;
76
- /**
77
- * Stops the progress bar and cleanup.
78
- */
79
- stop(): void;
80
- private calculateETA;
81
- }
82
- export declare class MultiBarInstance extends ProgressBar {
83
- private multiBar;
84
- constructor(multiBar: MultiProgressBar, options: ProgressBarOptions, payload?: ProgressBarPayload);
85
- update(current: number, payload?: ProgressBarPayload): void;
86
- getBarState(): {
87
- char: string;
88
- current: number;
89
- total: number;
90
- };
91
- }
92
- export declare class MultiProgressBar {
93
- private bars;
94
- private options;
95
- private interactiveManager?;
96
- private isActive;
97
- private nextBarId;
98
- private composite;
99
- private barColors;
100
- /**
101
- * Creates a new multi progress bar manager.
102
- * @param options Configuration options for the progress bars
103
- * @param interactiveManager Optional interactive manager for rendering
104
- */
105
- constructor(options?: MultiBarOptions, interactiveManager?: InteractiveManager);
106
- /**
107
- * Creates a new progress bar within this multi-bar manager.
108
- * @param total Total value for the progress bar
109
- * @param current Starting current value (default: 0)
110
- * @param payload Optional initial payload data for format placeholders
111
- * @returns The created progress bar instance
112
- */
113
- create(total: number, current?: number, payload?: ProgressBarPayload): ProgressBar;
114
- /**
115
- * Removes a progress bar from the manager.
116
- * @param bar The progress bar instance to remove
117
- * @returns True if the bar was removed, false if not found
118
- */
119
- remove(bar: ProgressBar): boolean;
120
- /**
121
- * Renders all progress bars.
122
- */
123
- renderAll(): void;
124
- /**
125
- * Sets or removes a color function for a specific bar.
126
- * @param bar The progress bar instance to color (must be from this MultiProgressBar)
127
- * @param color Color function or undefined to remove color
128
- */
129
- setBarColor(bar: MultiBarInstance, color: ((text: string) => string) | undefined): void;
130
- /**
131
- * Stops all progress bars and cleanup.
132
- */
133
- stop(): void;
134
- private renderComposite;
135
- private getCompositeChar;
136
- }
@@ -1,404 +0,0 @@
1
- const CHAR_GRADIENTS = {
2
- default: ["█", "▓", "▒", "░"],
3
- rect: ["▬", "▮", "▯", "▭"]
4
- };
5
- const BAR_REGEX = /\[([^[\]]*)\]/u;
6
- const getBarChar = (char, style, complete = true) => {
7
- if (char) {
8
- return char;
9
- }
10
- switch (style) {
11
- case "ascii": {
12
- return complete ? "#" : "-";
13
- }
14
- case "filled": {
15
- return complete ? "█" : " ";
16
- }
17
- case "rect": {
18
- return complete ? "▬" : "▭";
19
- }
20
- case "shades_classic": {
21
- return complete ? "█" : "░";
22
- }
23
- case "shades_grey": {
24
- return complete ? "▓" : "░";
25
- }
26
- case "solid": {
27
- return complete ? "█" : " ";
28
- }
29
- default: {
30
- return complete ? "█" : "░";
31
- }
32
- }
33
- };
34
- const applyStyleToOptions = (options) => {
35
- if (!options.style) {
36
- return options;
37
- }
38
- const { style } = options;
39
- const result = { ...options };
40
- if (result.barCompleteChar === void 0) {
41
- result.barCompleteChar = getBarChar(void 0, style, true);
42
- }
43
- if (result.barIncompleteChar === void 0) {
44
- result.barIncompleteChar = getBarChar(void 0, style, false);
45
- }
46
- if (result.barGlue === void 0) {
47
- result.barGlue = "";
48
- }
49
- return result;
50
- };
51
- class ProgressBar {
52
- options;
53
- current;
54
- startTime;
55
- interactiveManager;
56
- isActive = false;
57
- payload;
58
- /**
59
- * Creates a new progress bar instance.
60
- * @param options Configuration options for the progress bar
61
- * @param interactiveManager Optional interactive manager for rendering
62
- * @param payload Optional initial payload data for format placeholders
63
- */
64
- constructor(options, interactiveManager, payload) {
65
- const isCompleteArray = Array.isArray(options.barCompleteChar);
66
- const isIncompleteArray = Array.isArray(options.barIncompleteChar);
67
- const isGradientMode = isCompleteArray || isIncompleteArray;
68
- const completeChar = isCompleteArray ? options.barCompleteChar : getBarChar(options.barCompleteChar, "shades_classic");
69
- const incompleteChar = isIncompleteArray ? options.barIncompleteChar : getBarChar(options.barIncompleteChar, "shades_classic", false);
70
- this.options = {
71
- barCompleteChar: completeChar,
72
- barIncompleteChar: incompleteChar,
73
- current: 0,
74
- fps: 10,
75
- width: 40,
76
- ...options
77
- };
78
- if (isGradientMode) {
79
- if (!Array.isArray(this.options.barCompleteChar)) {
80
- this.options.barCompleteChar = [this.options.barCompleteChar];
81
- }
82
- if (!Array.isArray(this.options.barIncompleteChar)) {
83
- this.options.barIncompleteChar = [this.options.barIncompleteChar];
84
- }
85
- }
86
- this.current = this.options.current ?? 0;
87
- this.startTime = Date.now();
88
- this.interactiveManager = interactiveManager;
89
- this.payload = payload;
90
- }
91
- /**
92
- * Updates the progress bar to a new value.
93
- * @param current The current progress value
94
- * @param payload Optional payload data to merge with existing data
95
- */
96
- update(current, payload) {
97
- this.current = Math.min(current, this.options.total);
98
- if (payload) {
99
- this.payload = { ...this.payload, ...payload };
100
- }
101
- if (this.interactiveManager && this.isActive) {
102
- const progressBar = this.render();
103
- this.interactiveManager.update("stdout", [progressBar]);
104
- }
105
- }
106
- /**
107
- * Increments the progress bar by a specified step.
108
- * @param step Amount to increment (default: 1)
109
- * @param payload Optional payload data to merge with existing data
110
- */
111
- increment(step = 1, payload) {
112
- this.update(this.current + step, payload);
113
- }
114
- /**
115
- * Renders the progress bar as a formatted string.
116
- * @returns Formatted progress bar string with all placeholders replaced
117
- */
118
- // eslint-disable-next-line sonarjs/cognitive-complexity
119
- render() {
120
- const total = this.options.total > 0 ? this.options.total : 1;
121
- const width = Math.max(0, this.options.width ?? 40);
122
- const percentage = Math.max(0, Math.min(100, Math.round(this.current / total * 100)));
123
- const filled = Math.max(0, Math.min(width, Math.round(this.current / total * width)));
124
- const empty = width - filled;
125
- let bar;
126
- if (Array.isArray(this.options.barCompleteChar) || Array.isArray(this.options.barIncompleteChar)) {
127
- const completeChars = Array.isArray(this.options.barCompleteChar) ? this.options.barCompleteChar : void 0;
128
- const incompleteChars = Array.isArray(this.options.barIncompleteChar) ? this.options.barIncompleteChar : void 0;
129
- const completeChar = completeChars?.[completeChars.length - 1] ?? (typeof this.options.barCompleteChar === "string" ? this.options.barCompleteChar : "█");
130
- const incompleteChar = incompleteChars?.[0] ?? (typeof this.options.barIncompleteChar === "string" ? this.options.barIncompleteChar : "░");
131
- const completeLength = completeChars?.length ?? 1;
132
- const progressRatio = this.current / total;
133
- const totalSteps = width * completeLength;
134
- const currentStep = Math.round(progressRatio * totalSteps);
135
- const fractional = currentStep % completeLength;
136
- let barContent = "";
137
- for (let i = 0; i < width; i += 1) {
138
- if (i < filled) {
139
- const isGradientBoundary = i === filled - 1 && fractional > 0 && completeChars;
140
- barContent += isGradientBoundary ? completeChars[Math.max(0, fractional - 1)] : completeChar;
141
- } else {
142
- barContent += incompleteChar;
143
- }
144
- }
145
- bar = barContent;
146
- } else {
147
- const completeChar = typeof this.options.barCompleteChar === "string" ? this.options.barCompleteChar : "█";
148
- const incompleteChar = typeof this.options.barIncompleteChar === "string" ? this.options.barIncompleteChar : "░";
149
- bar = completeChar.repeat(filled) + incompleteChar.repeat(empty);
150
- }
151
- let format = this.options.format ?? "progress [{bar}] {percentage}% | ETA: {eta}s | {value}/{total}";
152
- if (this.payload) {
153
- for (const [k, v] of Object.entries(this.payload)) {
154
- format = format.replaceAll(`{${k}}`, String(v));
155
- }
156
- }
157
- const eta = this.calculateETA();
158
- return format.replaceAll("{bar}", bar).replaceAll("{percentage}", String(percentage)).replaceAll("{value}", String(this.current)).replaceAll("{total}", String(this.options.total)).replaceAll("{eta}", String(eta));
159
- }
160
- /**
161
- * Starts the progress bar.
162
- * @param total Optional total value to set
163
- * @param startValue Optional starting value
164
- * @param payload Optional initial payload data
165
- */
166
- start(total, startValue, payload) {
167
- if (total !== void 0) {
168
- this.options.total = total;
169
- }
170
- if (startValue !== void 0) {
171
- this.current = startValue;
172
- }
173
- this.startTime = Date.now();
174
- this.isActive = true;
175
- if (this.interactiveManager) {
176
- this.interactiveManager.hook();
177
- this.update(this.current, payload);
178
- }
179
- }
180
- /**
181
- * Stops the progress bar and cleanup.
182
- */
183
- stop() {
184
- this.isActive = false;
185
- if (this.interactiveManager) {
186
- this.interactiveManager.unhook(false);
187
- }
188
- }
189
- calculateETA() {
190
- if (this.current === 0) {
191
- return 0;
192
- }
193
- const elapsed = (Date.now() - this.startTime) / 1e3;
194
- if (elapsed < 0.1) {
195
- return 0;
196
- }
197
- const rate = this.current / elapsed;
198
- const remaining = this.options.total - this.current;
199
- return Math.round(remaining / rate);
200
- }
201
- }
202
- class MultiBarInstance extends ProgressBar {
203
- multiBar;
204
- constructor(multiBar, options, payload) {
205
- super(options, void 0, payload);
206
- this.multiBar = multiBar;
207
- }
208
- update(current, payload) {
209
- super.update(current, payload);
210
- this.multiBar.renderAll();
211
- }
212
- getBarState() {
213
- const completeChar = Array.isArray(this.options.barCompleteChar) ? this.options.barCompleteChar[this.options.barCompleteChar.length - 1] : getBarChar(this.options.barCompleteChar, this.options.style ?? "shades_classic", true);
214
- return {
215
- char: completeChar ?? "█",
216
- current: this.current,
217
- total: this.options.total
218
- };
219
- }
220
- }
221
- class MultiProgressBar {
222
- bars = /* @__PURE__ */ new Map();
223
- options;
224
- interactiveManager;
225
- isActive = false;
226
- nextBarId = 0;
227
- composite = false;
228
- barColors = /* @__PURE__ */ new Map();
229
- /**
230
- * Creates a new multi progress bar manager.
231
- * @param options Configuration options for the progress bars
232
- * @param interactiveManager Optional interactive manager for rendering
233
- */
234
- constructor(options = {}, interactiveManager) {
235
- this.options = {
236
- barCompleteChar: getBarChar(void 0, "shades_classic"),
237
- barIncompleteChar: getBarChar(void 0, "shades_classic", false),
238
- composite: false,
239
- format: "progress [{bar}] {percentage}% | ETA: {eta}s | {value}/{total}",
240
- fps: 10,
241
- ...options
242
- };
243
- this.composite = this.options.composite ?? false;
244
- this.interactiveManager = interactiveManager;
245
- }
246
- /**
247
- * Creates a new progress bar within this multi-bar manager.
248
- * @param total Total value for the progress bar
249
- * @param current Starting current value (default: 0)
250
- * @param payload Optional initial payload data for format placeholders
251
- * @returns The created progress bar instance
252
- */
253
- create(total, current = 0, payload) {
254
- const barId = `bar_${this.nextBarId++}`;
255
- const bar = new MultiBarInstance(
256
- this,
257
- {
258
- barCompleteChar: this.options.barCompleteChar,
259
- barIncompleteChar: this.options.barIncompleteChar,
260
- current,
261
- format: this.options.format,
262
- fps: this.options.fps,
263
- total,
264
- width: 40
265
- },
266
- payload
267
- );
268
- this.bars.set(barId, bar);
269
- if (!this.isActive && this.interactiveManager) {
270
- this.interactiveManager.hook();
271
- this.isActive = true;
272
- this.renderAll();
273
- }
274
- return bar;
275
- }
276
- /**
277
- * Removes a progress bar from the manager.
278
- * @param bar The progress bar instance to remove
279
- * @returns True if the bar was removed, false if not found
280
- */
281
- remove(bar) {
282
- for (const [id, existingBar] of this.bars.entries()) {
283
- if (existingBar === bar) {
284
- this.bars.delete(id);
285
- if (this.bars.size === 0) {
286
- if (this.interactiveManager) {
287
- this.interactiveManager.unhook(false);
288
- }
289
- this.isActive = false;
290
- } else {
291
- this.renderAll();
292
- }
293
- return true;
294
- }
295
- }
296
- return false;
297
- }
298
- /**
299
- * Renders all progress bars.
300
- */
301
- renderAll() {
302
- if (!this.interactiveManager || !this.isActive) {
303
- return;
304
- }
305
- const lines = [];
306
- if (this.composite) {
307
- const barsArray = [...this.bars.values()];
308
- if (barsArray.length > 0) {
309
- const compositeOutput = this.renderComposite(barsArray);
310
- lines.push(compositeOutput);
311
- }
312
- } else {
313
- for (const bar of this.bars.values()) {
314
- lines.push(bar.render());
315
- }
316
- }
317
- this.interactiveManager.update("stdout", lines);
318
- }
319
- /**
320
- * Sets or removes a color function for a specific bar.
321
- * @param bar The progress bar instance to color (must be from this MultiProgressBar)
322
- * @param color Color function or undefined to remove color
323
- */
324
- setBarColor(bar, color) {
325
- for (const instance of this.bars.values()) {
326
- if (instance === bar) {
327
- if (color) {
328
- this.barColors.set(instance, color);
329
- } else {
330
- this.barColors.delete(instance);
331
- }
332
- break;
333
- }
334
- }
335
- }
336
- /**
337
- * Stops all progress bars and cleanup.
338
- */
339
- // eslint-disable-next-line sonarjs/no-identical-functions
340
- stop() {
341
- this.isActive = false;
342
- if (this.interactiveManager) {
343
- this.interactiveManager.unhook(false);
344
- }
345
- }
346
- renderComposite(bars) {
347
- if (bars.length === 0) {
348
- return "";
349
- }
350
- const firstBar = bars[0];
351
- if (!firstBar) {
352
- return "";
353
- }
354
- const output = firstBar.render();
355
- const barMatch = output.match(BAR_REGEX);
356
- if (!barMatch || !barMatch[1]) {
357
- return output;
358
- }
359
- const width = barMatch[1].length;
360
- const grid = Array.from({ length: width }, () => []);
361
- bars.forEach((bar, index) => {
362
- const state = bar.getBarState();
363
- const filled = Math.round(state.current / state.total * width);
364
- for (let i = 0; i < width; i += 1) {
365
- if (i < filled) {
366
- grid[i]?.push(index);
367
- }
368
- }
369
- });
370
- const composite = Array.from({ length: width }, (_, i) => this.getCompositeChar(bars, grid[i])).join("");
371
- return output.replace(BAR_REGEX, `[${composite}]`);
372
- }
373
- getCompositeChar(bars, stack) {
374
- if (!stack || stack.length === 0) {
375
- const defaultBar = bars[0];
376
- return defaultBar?.getBarState().char ?? "█";
377
- }
378
- const charGradient = CHAR_GRADIENTS[this.options.style === "rect" ? "rect" : "default"];
379
- const char = charGradient?.[Math.min(stack.length - 1, charGradient.length - 1)] ?? "█";
380
- let selectedBar;
381
- let smallestPercent = 100;
382
- for (const stackBarIndex of stack) {
383
- const bar = bars[stackBarIndex];
384
- if (!bar) {
385
- continue;
386
- }
387
- const barState = bar.getBarState();
388
- const barPercent = barState.current / barState.total * 100;
389
- if (barPercent < smallestPercent || barPercent === smallestPercent && (selectedBar === void 0 || stackBarIndex > selectedBar)) {
390
- smallestPercent = barPercent;
391
- selectedBar = stackBarIndex;
392
- }
393
- }
394
- const barIndex = selectedBar ?? stack[0];
395
- const targetBar = bars[barIndex ?? 0];
396
- if (!targetBar) {
397
- return char;
398
- }
399
- const barColor = this.barColors.get(targetBar);
400
- return barColor ? barColor(char) : char;
401
- }
402
- }
403
-
404
- export { MultiBarInstance, MultiProgressBar, ProgressBar, applyStyleToOptions, getBarChar };
@@ -1,48 +0,0 @@
1
- import type { Options as RfsOptions } from "rotating-file-stream";
2
- /**
3
- * Rotating File Stream.
4
- *
5
- * A wrapper for the `rotating-file-stream` module that provides optional immediate
6
- * writing to disk by creating and closing a new stream on each write operation.
7
- * This is useful for ensuring log messages are written immediately rather than buffered.
8
- * @example
9
- * ```typescript
10
- * // Buffered writing (default)
11
- * const bufferedStream = new RotatingFileStream("/var/log/app.log", false, {
12
- * interval: "1d",
13
- * size: "10M"
14
- * });
15
- *
16
- * // Immediate writing
17
- * const immediateStream = new RotatingFileStream("/var/log/app.log", true, {
18
- * interval: "1d"
19
- * });
20
- * ```
21
- */
22
- declare class RotatingFileStream {
23
- #private;
24
- /**
25
- * Creates a new RotatingFileStream instance.
26
- * @param filePath Path to the log file
27
- * @param writeImmediately Whether to write immediately or buffer writes
28
- * @param options Options for the rotating file stream
29
- * @throws {Error} If the 'rotating-file-stream' package is not installed
30
- */
31
- constructor(filePath: string, writeImmediately?: boolean, options?: RfsOptions);
32
- /**
33
- * Writes a message to the rotating file stream.
34
- *
35
- * If writeImmediately was set to true in the constructor, a new stream
36
- * is created for each write operation. Otherwise, uses the buffered stream.
37
- * @param message The message to write to the file
38
- */
39
- write(message: string): void;
40
- /**
41
- * Ends the rotating file stream.
42
- *
43
- * Closes the underlying stream. When `writeImmediately` is not `true`,
44
- * calling `write` after calling this method will throw an error.
45
- */
46
- end(): void;
47
- }
48
- export default RotatingFileStream;
@@ -1,7 +0,0 @@
1
- /**
2
- * Compresses data using gzip compression.
3
- * @param data The data to compress as a string
4
- * @returns A Promise that resolves to the compressed data as Uint8Array
5
- */
6
- declare const compressData: (data: string) => Promise<Uint8Array>;
7
- export default compressData;
@@ -1,30 +0,0 @@
1
- /**
2
- * Error thrown when a log entry exceeds the maximum allowed size.
3
- */
4
- declare class LogSizeError extends Error {
5
- /**
6
- * The log entry data that caused the error
7
- */
8
- readonly logData: Record<string, unknown>;
9
- /**
10
- * The actual size of the log entry in bytes
11
- */
12
- readonly actualSize: number;
13
- /**
14
- * The maximum allowed size in bytes
15
- */
16
- readonly maxSize: number;
17
- /**
18
- * Creates a new LogSizeError instance.
19
- * @param message Descriptive error message explaining the size violation
20
- * @param logData The log entry data that caused the error
21
- * @param actualSize Size of the log entry in bytes
22
- * @param maxSize Maximum allowed size in bytes
23
- * @example
24
- * ```typescript
25
- * throw new LogSizeError("Log too large", logData, 2000000, 1000000);
26
- * ```
27
- */
28
- constructor(message: string, logData: Record<string, unknown>, actualSize: number, maxSize: number);
29
- }
30
- export default LogSizeError;
@@ -1,27 +0,0 @@
1
- /**
2
- * Sends an HTTP request with retry logic and rate limiting support.
3
- * @param url The URL to send the request to
4
- * @param method The HTTP method to use
5
- * @param headers Request headers
6
- * @param body The request body (string or Uint8Array)
7
- * @param maxRetries Maximum number of retry attempts
8
- * @param retryDelay Base delay between retries in milliseconds
9
- * @param respectRateLimit Whether to respect rate limiting (429 responses)
10
- * @param onDebugRequestResponse Optional callback for debugging requests/responses
11
- * @param onError Optional callback for error handling
12
- */
13
- declare const sendWithRetry: (url: string, method: string, headers: Record<string, string>, body: string | Uint8Array, maxRetries: number, retryDelay: number, respectRateLimit: boolean, onDebugRequestResponse?: (requestResponse: {
14
- req: {
15
- body: string | Uint8Array;
16
- headers: Record<string, string>;
17
- method: string;
18
- url: string;
19
- };
20
- res: {
21
- body: string;
22
- headers: Record<string, string>;
23
- status: number;
24
- statusText: string;
25
- };
26
- }) => void, onError?: (error: Error) => void) => Promise<void>;
27
- export default sendWithRetry;