@settlemint/sdk-utils
Advanced tools
Comparing version
{ | ||
"name": "@settlemint/sdk-utils", | ||
"description": "Shared utilities and helper functions for SettleMint SDK modules", | ||
"version": "2.3.3", | ||
"version": "2.3.4", | ||
"type": "module", | ||
@@ -6,0 +6,0 @@ "private": false, |
154
README.md
@@ -115,3 +115,3 @@ <p align="center"> | ||
Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/ascii.ts#L14) | ||
Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/ascii.ts#L14) | ||
@@ -140,3 +140,3 @@ Prints the SettleMint ASCII art logo to the console in magenta color. | ||
Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/string.ts#L29) | ||
Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/string.ts#L29) | ||
@@ -172,3 +172,3 @@ Converts a camelCase string to a human-readable string. | ||
Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/cancel.ts#L23) | ||
Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/cancel.ts#L23) | ||
@@ -206,3 +206,3 @@ Displays an error message in red inverse text and throws a CancelError. | ||
Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/string.ts#L13) | ||
Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/string.ts#L13) | ||
@@ -238,3 +238,3 @@ Capitalizes the first letter of a string. | ||
Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L50) | ||
Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/logging/logger.ts#L50) | ||
@@ -272,3 +272,3 @@ Creates a simple logger with configurable log level | ||
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/download-and-extract.ts#L45) | ||
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/package-manager/download-and-extract.ts#L45) | ||
@@ -301,3 +301,3 @@ Removes all contents of a directory except the .git folder | ||
Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/runtime/ensure-server.ts#L31) | ||
Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/runtime/ensure-server.ts#L31) | ||
@@ -329,3 +329,3 @@ Ensures that code is running in a browser environment and not on the server. | ||
Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/runtime/ensure-server.ts#L13) | ||
Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/runtime/ensure-server.ts#L13) | ||
@@ -357,3 +357,3 @@ Ensures that code is running on the server and not in a browser environment. | ||
Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/execute-command.ts#L51) | ||
Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/execute-command.ts#L51) | ||
@@ -400,3 +400,3 @@ Executes a command with the given arguments in a child process. | ||
Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/filesystem/exists.ts#L17) | ||
Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/filesystem/exists.ts#L17) | ||
@@ -434,3 +434,3 @@ Checks if a file or directory exists at the given path | ||
Defined in: [sdk/utils/src/url.ts:15](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/url.ts#L15) | ||
Defined in: [sdk/utils/src/url.ts:15](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/url.ts#L15) | ||
@@ -467,3 +467,3 @@ Extracts the base URL before a specific segment in a URL. | ||
Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/json.ts#L50) | ||
Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/json.ts#L50) | ||
@@ -511,3 +511,3 @@ Extracts a JSON object from a string. | ||
Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/http/fetch-with-retry.ts#L18) | ||
Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/http/fetch-with-retry.ts#L18) | ||
@@ -550,3 +550,3 @@ Retry an HTTP request with exponential backoff and jitter. | ||
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/filesystem/mono-repo.ts#L59) | ||
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/filesystem/mono-repo.ts#L59) | ||
@@ -582,3 +582,3 @@ Finds all packages in a monorepo | ||
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/filesystem/mono-repo.ts#L19) | ||
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/filesystem/mono-repo.ts#L19) | ||
@@ -614,3 +614,3 @@ Finds the root directory of a monorepo | ||
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/download-and-extract.ts#L15) | ||
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/package-manager/download-and-extract.ts#L15) | ||
@@ -645,3 +645,3 @@ Formats a directory path by removing trailing slashes and whitespace | ||
Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/get-package-manager.ts#L15) | ||
Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/package-manager/get-package-manager.ts#L15) | ||
@@ -677,3 +677,3 @@ Detects the package manager used in the current project | ||
Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14) | ||
Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14) | ||
@@ -709,3 +709,3 @@ Retrieves the executable command and arguments for the package manager | ||
Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34) | ||
Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34) | ||
@@ -769,3 +769,3 @@ Executes a GraphQL request with automatic retries using exponential backoff and jitter. | ||
Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/install-dependencies.ts#L20) | ||
Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/package-manager/install-dependencies.ts#L20) | ||
@@ -809,3 +809,3 @@ Installs one or more packages as dependencies using the detected package manager | ||
Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/intro.ts#L16) | ||
Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/intro.ts#L16) | ||
@@ -840,3 +840,3 @@ Displays an introductory message in magenta text with padding. | ||
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/download-and-extract.ts#L31) | ||
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/package-manager/download-and-extract.ts#L31) | ||
@@ -873,3 +873,3 @@ Checks if a directory is empty or contains only a .git folder | ||
Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/is-package-installed.ts#L17) | ||
Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/package-manager/is-package-installed.ts#L17) | ||
@@ -910,3 +910,3 @@ Checks if a package is installed in the project's dependencies, devDependencies, or peerDependencies. | ||
Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/list.ts#L23) | ||
Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/list.ts#L23) | ||
@@ -951,3 +951,3 @@ Displays a list of items in a formatted manner, supporting nested items. | ||
Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/environment/load-env.ts#L25) | ||
Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/environment/load-env.ts#L25) | ||
@@ -1000,3 +1000,3 @@ Loads environment variables from .env files. | ||
Defined in: [sdk/utils/src/json.ts:73](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/json.ts#L73) | ||
Defined in: [sdk/utils/src/json.ts:73](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/json.ts#L73) | ||
@@ -1038,3 +1038,3 @@ Converts a value to a JSON stringifiable format. | ||
Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/mask-tokens.ts#L13) | ||
Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/logging/mask-tokens.ts#L13) | ||
@@ -1071,3 +1071,3 @@ Masks sensitive SettleMint tokens in output text by replacing them with asterisks. | ||
Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/note.ts#L21) | ||
Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/note.ts#L21) | ||
@@ -1107,3 +1107,3 @@ Displays a note message with optional warning level formatting. | ||
Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/outro.ts#L16) | ||
Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/outro.ts#L16) | ||
@@ -1138,3 +1138,3 @@ Displays a closing message in green inverted text with padding. | ||
Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/filesystem/project-root.ts#L18) | ||
Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/filesystem/project-root.ts#L18) | ||
@@ -1176,3 +1176,3 @@ Finds the root directory of the current project by locating the nearest package.json file | ||
Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/string.ts#L48) | ||
Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/string.ts#L48) | ||
@@ -1208,3 +1208,3 @@ Replaces underscores and hyphens with spaces. | ||
Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/request-logger.ts#L14) | ||
Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/logging/request-logger.ts#L14) | ||
@@ -1243,3 +1243,3 @@ Logs the request and duration of a fetch call (> 500ms is logged as warn, otherwise info) | ||
Defined in: [sdk/utils/src/retry.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/retry.ts#L16) | ||
Defined in: [sdk/utils/src/retry.ts:16](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/retry.ts#L16) | ||
@@ -1284,3 +1284,3 @@ Retry a function when it fails. | ||
Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/set-name.ts#L16) | ||
Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/package-manager/set-name.ts#L16) | ||
@@ -1320,3 +1320,3 @@ Sets the name field in the package.json file | ||
Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/spinner.ts#L55) | ||
Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/spinner.ts#L55) | ||
@@ -1371,3 +1371,3 @@ Displays a loading spinner while executing an async task. | ||
Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/table.ts#L21) | ||
Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/table.ts#L21) | ||
@@ -1406,3 +1406,3 @@ Displays data in a formatted table in the terminal. | ||
Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/string.ts#L65) | ||
Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/string.ts#L65) | ||
@@ -1439,3 +1439,3 @@ Truncates a string to a maximum length and appends "..." if it is longer. | ||
Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/json.ts#L23) | ||
Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/json.ts#L23) | ||
@@ -1487,3 +1487,3 @@ Attempts to parse a JSON string into a typed value, returning a default value if parsing fails. | ||
Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/validate.ts#L16) | ||
Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/validate.ts#L16) | ||
@@ -1529,3 +1529,3 @@ Validates a value against a given Zod schema. | ||
Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/environment/write-env.ts#L41) | ||
Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/environment/write-env.ts#L41) | ||
@@ -1582,3 +1582,3 @@ Writes environment variables to .env files across a project or monorepo | ||
Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/cancel.ts#L8) | ||
Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/cancel.ts#L8) | ||
@@ -1596,3 +1596,3 @@ Error class used to indicate that the operation was cancelled. | ||
Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/execute-command.ts#L16) | ||
Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/execute-command.ts#L16) | ||
@@ -1611,3 +1611,3 @@ Error class for command execution errors | ||
Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/execute-command.ts#L23) | ||
Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/execute-command.ts#L23) | ||
@@ -1638,3 +1638,3 @@ Constructs a new CommandError | ||
Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/execute-command.ts#L25) | ||
Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/execute-command.ts#L25) | ||
@@ -1647,3 +1647,3 @@ The exit code of the command | ||
Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/execute-command.ts#L26) | ||
Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/execute-command.ts#L26) | ||
@@ -1656,3 +1656,3 @@ The output of the command | ||
Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/spinner.ts#L12) | ||
Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/spinner.ts#L12) | ||
@@ -1670,3 +1670,3 @@ Error class used to indicate that the spinner operation failed. | ||
Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/execute-command.ts#L7) | ||
Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/execute-command.ts#L7) | ||
@@ -1683,3 +1683,3 @@ Options for executing a command, extending SpawnOptionsWithoutStdio | ||
| ------ | ------ | ------ | ------ | | ||
| <a id="silent"></a> `silent?` | `boolean` | Whether to suppress output to stdout/stderr | [sdk/utils/src/terminal/execute-command.ts:9](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/execute-command.ts#L9) | | ||
| <a id="silent"></a> `silent?` | `boolean` | Whether to suppress output to stdout/stderr | [sdk/utils/src/terminal/execute-command.ts:9](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/execute-command.ts#L9) | | ||
@@ -1690,3 +1690,3 @@ *** | ||
Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L23) | ||
Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/logging/logger.ts#L23) | ||
@@ -1700,6 +1700,6 @@ Simple logger interface with basic logging methods | ||
| ------ | ------ | ------ | ------ | | ||
| <a id="debug"></a> `debug` | (`message`, ...`args`) => `void` | Log debug information | [sdk/utils/src/logging/logger.ts:25](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L25) | | ||
| <a id="error"></a> `error` | (`message`, ...`args`) => `void` | Log errors | [sdk/utils/src/logging/logger.ts:31](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L31) | | ||
| <a id="info"></a> `info` | (`message`, ...`args`) => `void` | Log general information | [sdk/utils/src/logging/logger.ts:27](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L27) | | ||
| <a id="warn"></a> `warn` | (`message`, ...`args`) => `void` | Log warnings | [sdk/utils/src/logging/logger.ts:29](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L29) | | ||
| <a id="debug"></a> `debug` | (`message`, ...`args`) => `void` | Log debug information | [sdk/utils/src/logging/logger.ts:25](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/logging/logger.ts#L25) | | ||
| <a id="error"></a> `error` | (`message`, ...`args`) => `void` | Log errors | [sdk/utils/src/logging/logger.ts:31](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/logging/logger.ts#L31) | | ||
| <a id="info"></a> `info` | (`message`, ...`args`) => `void` | Log general information | [sdk/utils/src/logging/logger.ts:27](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/logging/logger.ts#L27) | | ||
| <a id="warn"></a> `warn` | (`message`, ...`args`) => `void` | Log warnings | [sdk/utils/src/logging/logger.ts:29](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/logging/logger.ts#L29) | | ||
@@ -1710,3 +1710,3 @@ *** | ||
Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L12) | ||
Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/logging/logger.ts#L12) | ||
@@ -1720,4 +1720,4 @@ Configuration options for the logger | ||
| ------ | ------ | ------ | ------ | | ||
| <a id="level"></a> `level?` | [`LogLevel`](#loglevel) | The minimum log level to output | [sdk/utils/src/logging/logger.ts:14](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L14) | | ||
| <a id="prefix"></a> `prefix?` | `string` | The prefix to add to the log message | [sdk/utils/src/logging/logger.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L16) | | ||
| <a id="level"></a> `level?` | [`LogLevel`](#loglevel) | The minimum log level to output | [sdk/utils/src/logging/logger.ts:14](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/logging/logger.ts#L14) | | ||
| <a id="prefix"></a> `prefix?` | `string` | The prefix to add to the log message | [sdk/utils/src/logging/logger.ts:16](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/logging/logger.ts#L16) | | ||
@@ -1728,3 +1728,3 @@ *** | ||
Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/spinner.ts#L25) | ||
Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/spinner.ts#L25) | ||
@@ -1743,5 +1743,5 @@ Options for configuring the spinner behavior | ||
| ------ | ------ | ------ | ------ | | ||
| <a id="startmessage"></a> `startMessage` | `string` | Message to display when spinner starts | [sdk/utils/src/terminal/spinner.ts:27](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/spinner.ts#L27) | | ||
| <a id="stopmessage"></a> `stopMessage` | `string` | Message to display when spinner completes successfully | [sdk/utils/src/terminal/spinner.ts:31](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/spinner.ts#L31) | | ||
| <a id="task"></a> `task` | (`spinner?`) => `Promise`\<`R`\> | Async task to execute while spinner is active | [sdk/utils/src/terminal/spinner.ts:29](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/spinner.ts#L29) | | ||
| <a id="startmessage"></a> `startMessage` | `string` | Message to display when spinner starts | [sdk/utils/src/terminal/spinner.ts:27](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/spinner.ts#L27) | | ||
| <a id="stopmessage"></a> `stopMessage` | `string` | Message to display when spinner completes successfully | [sdk/utils/src/terminal/spinner.ts:31](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/spinner.ts#L31) | | ||
| <a id="task"></a> `task` | (`spinner?`) => `Promise`\<`R`\> | Async task to execute while spinner is active | [sdk/utils/src/terminal/spinner.ts:29](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/terminal/spinner.ts#L29) | | ||
@@ -1754,3 +1754,3 @@ ### Type Aliases | ||
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:106](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/dot-env.schema.ts#L106) | ||
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:106](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/dot-env.schema.ts#L106) | ||
@@ -1765,3 +1765,3 @@ Type definition for the environment variables schema. | ||
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:117](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/dot-env.schema.ts#L117) | ||
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:117](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/dot-env.schema.ts#L117) | ||
@@ -1776,3 +1776,3 @@ Type definition for the partial environment variables schema. | ||
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/id.schema.ts#L30) | ||
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/id.schema.ts#L30) | ||
@@ -1788,3 +1788,3 @@ Type definition for database IDs, inferred from IdSchema. | ||
Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L6) | ||
Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/logging/logger.ts#L6) | ||
@@ -1799,3 +1799,3 @@ Log levels supported by the logger | ||
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/access-token.schema.ts#L21) | ||
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/access-token.schema.ts#L21) | ||
@@ -1811,3 +1811,3 @@ Schema for validating both application and personal access tokens. | ||
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/access-token.schema.ts#L7) | ||
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/access-token.schema.ts#L7) | ||
@@ -1823,3 +1823,3 @@ Schema for validating application access tokens. | ||
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/dot-env.schema.ts#L17) | ||
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/dot-env.schema.ts#L17) | ||
@@ -1836,3 +1836,3 @@ Schema for validating environment variables used by the SettleMint SDK. | ||
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:112](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/dot-env.schema.ts#L112) | ||
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:112](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/dot-env.schema.ts#L112) | ||
@@ -1848,3 +1848,3 @@ Partial version of the environment variables schema where all fields are optional. | ||
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/id.schema.ts#L17) | ||
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/id.schema.ts#L17) | ||
@@ -1873,3 +1873,3 @@ Schema for validating database IDs. Accepts both PostgreSQL UUIDs and MongoDB ObjectIDs. | ||
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/access-token.schema.ts#L14) | ||
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/access-token.schema.ts#L14) | ||
@@ -1885,3 +1885,3 @@ Schema for validating personal access tokens. | ||
Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/runtime/ensure-server.ts#L40) | ||
Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/runtime/ensure-server.ts#L40) | ||
@@ -1896,3 +1896,3 @@ Boolean indicating if code is currently running in a browser environment | ||
Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/runtime/ensure-server.ts#L45) | ||
Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/runtime/ensure-server.ts#L45) | ||
@@ -1907,3 +1907,3 @@ Boolean indicating if code is currently running in a server environment | ||
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:10](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/dot-env.schema.ts#L10) | ||
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:10](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/dot-env.schema.ts#L10) | ||
@@ -1918,3 +1918,3 @@ Use this value to indicate that the resources are not part of the SettleMint platform. | ||
Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/unique-name.schema.ts#L19) | ||
Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/unique-name.schema.ts#L19) | ||
@@ -1945,3 +1945,3 @@ Schema for validating unique names used across the SettleMint platform. | ||
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/url.schema.ts#L54) | ||
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/url.schema.ts#L54) | ||
@@ -1970,3 +1970,3 @@ Schema that accepts either a full URL or a URL path. | ||
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/url.schema.ts#L34) | ||
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/url.schema.ts#L34) | ||
@@ -1995,3 +1995,3 @@ Schema for validating URL paths. | ||
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/url.schema.ts#L17) | ||
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.4/sdk/utils/src/validation/url.schema.ts#L17) | ||
@@ -1998,0 +1998,0 @@ Schema for validating URLs. |
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
1
-50%