@uipath/common 0.1.5

package/README.md

@@ -0,0 +1,110 @@
+# common
+
+This package is the holder for common infrastructure needed by `uip` tools.
+
+# Functionalities:
+
+## 1. Output Formatter
+
+A small utility set of functions used to format a `typescript` data object in one of the data formats supported by [uip](https://github.com/UiPath/uipcli).
+
+Currently supported data formats are:
+```
+type OutputFormat = "table" | "json" | "yaml" | "plain";
+```
+
+Functions exposed:
+
+### OutputFormatter.success
+
+- Format message and logs to `console.info`
+- Default `OutputFormat` is "table"
+
+```
+export namespace OutputFormatter {
+
+    export class SuccessOutput {
+        Result: "Success" = "Success";
+        Code: string;
+        Data: Record<string, any>[] | Record<string, any>;
+    }
+
+    export function success(
+        data: SuccessOutput,
+        format: OutputFormat = "table",
+    ): void {
+        ...
+    }
+}
+
+```
+
+### OutputFormatter.error
+
+- Format message and logs to `console.error`
+- Default `OutputFormat` is "table"
+
+```
+export namespace OutputFormatter {
+
+    export class FailureOutput {
+        Result: FailureResultType;
+        Message: string;
+        Instructions: string;
+    }
+
+    export function error(
+        data: FailureOutput,
+        format: OutputFormat = "table",
+    ): void {
+        ...
+    }
+}
+
+```
+
+### OutputFormatter.log
+
+- Format message and logs to `console.log`
+- Default `OutputFormat` is "table"
+
+```
+export namespace OutputFormatter {
+
+    export class LogOutput {
+        Message: string;
+        [key: string]: unknown;
+    }
+    
+    export function log(data: LogOutput, format: OutputFormat = "table"): void {
+        ...
+    }
+}
+```
+
+## 2. Logger
+
+A simple console wrapper that works in both Node.js/Bun and browser environments. Supports four log levels and respects a `DEBUG` flag to enable verbose output.
+
+- **Node/Bun**: reads `process.env.DEBUG`
+- **Browser**: reads `localStorage.debug` (same convention as the `debug` npm package)
+
+```ts
+import { logger, LogLevel } from "@uipath/common";
+
+logger.debug("only visible when DEBUG is set");
+logger.info("general info");
+logger.warn("warning");
+logger.error("error");
+
+// Override the level at runtime
+logger.setLevel(LogLevel.DEBUG);
+```
+
+| Method          | Level   | Node stream | Visible by default |
+|-----------------|---------|-------------|--------------------|
+| `logger.debug`  | DEBUG   | stdout      | No                 |
+| `logger.info`   | INFO    | stdout      | Yes                |
+| `logger.warn`   | WARN    | stdout      | Yes                |
+| `logger.error`  | ERROR   | stderr      | Yes                |
+