@settlemint/sdk-utils 2.3.6 → 2.3.8-mainb7108730

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 (2) hide show
  1. package/README.md +77 -77
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -112,7 +112,7 @@ The SettleMint Utils SDK provides a collection of shared utilities and helper fu
112
112
 
113
113
  > **ascii**(): `void`
114
114
 
115
- Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/ascii.ts#L14)
115
+ Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/ascii.ts#L14)
116
116
 
117
117
  Prints the SettleMint ASCII art logo to the console in magenta color.
118
118
  Used for CLI branding and visual identification.
@@ -136,7 +136,7 @@ ascii();
136
136
 
137
137
  > **camelCaseToWords**(`s`): `string`
138
138
 
139
- Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/string.ts#L29)
139
+ Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/string.ts#L29)
140
140
 
141
141
  Converts a camelCase string to a human-readable string.
142
142
 
@@ -167,7 +167,7 @@ const words = camelCaseToWords("camelCaseString");
167
167
 
168
168
  > **cancel**(`msg`): `never`
169
169
 
170
- Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/cancel.ts#L23)
170
+ Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/cancel.ts#L23)
171
171
 
172
172
  Displays an error message in red inverse text and throws a CancelError.
173
173
  Used to terminate execution with a visible error message.
@@ -200,7 +200,7 @@ cancel("An error occurred");
200
200
 
201
201
  > **capitalizeFirstLetter**(`val`): `string`
202
202
 
203
- Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/string.ts#L13)
203
+ Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/string.ts#L13)
204
204
 
205
205
  Capitalizes the first letter of a string.
206
206
 
@@ -231,7 +231,7 @@ const capitalized = capitalizeFirstLetter("hello");
231
231
 
232
232
  > **createLogger**(`options`): [`Logger`](#logger)
233
233
 
234
- Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/logging/logger.ts#L50)
234
+ Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/logging/logger.ts#L50)
235
235
 
236
236
  Creates a simple logger with configurable log level
237
237
 
@@ -264,7 +264,7 @@ logger.error('Operation failed', new Error('Connection timeout'));
264
264
 
265
265
  > **emptyDir**(`dir`): `Promise`\<`void`\>
266
266
 
267
- Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/package-manager/download-and-extract.ts#L45)
267
+ Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/package-manager/download-and-extract.ts#L45)
268
268
 
269
269
  Removes all contents of a directory except the .git folder
270
270
 
@@ -292,7 +292,7 @@ await emptyDir("/path/to/dir"); // Removes all contents except .git
292
292
 
293
293
  > **ensureBrowser**(): `void`
294
294
 
295
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/runtime/ensure-server.ts#L31)
295
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/runtime/ensure-server.ts#L31)
296
296
 
297
297
  Ensures that code is running in a browser environment and not on the server.
298
298
 
@@ -319,7 +319,7 @@ ensureBrowser();
319
319
 
320
320
  > **ensureServer**(): `void`
321
321
 
322
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/runtime/ensure-server.ts#L13)
322
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/runtime/ensure-server.ts#L13)
323
323
 
324
324
  Ensures that code is running on the server and not in a browser environment.
325
325
 
@@ -346,7 +346,7 @@ ensureServer();
346
346
 
347
347
  > **executeCommand**(`command`, `args`, `options?`): `Promise`\<`string`[]\>
348
348
 
349
- Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/execute-command.ts#L51)
349
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/execute-command.ts#L51)
350
350
 
351
351
  Executes a command with the given arguments in a child process.
352
352
  Pipes stdin to the child process and captures stdout/stderr output.
@@ -388,7 +388,7 @@ await executeCommand("npm", ["install"], { silent: true });
388
388
 
389
389
  > **exists**(`path`): `Promise`\<`boolean`\>
390
390
 
391
- Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/filesystem/exists.ts#L17)
391
+ Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/filesystem/exists.ts#L17)
392
392
 
393
393
  Checks if a file or directory exists at the given path
394
394
 
@@ -421,7 +421,7 @@ if (await exists('/path/to/file.txt')) {
421
421
 
422
422
  > **extractBaseUrlBeforeSegment**(`baseUrl`, `pathSegment`): `string`
423
423
 
424
- Defined in: [sdk/utils/src/url.ts:15](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/url.ts#L15)
424
+ Defined in: [sdk/utils/src/url.ts:15](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/url.ts#L15)
425
425
 
426
426
  Extracts the base URL before a specific segment in a URL.
427
427
 
@@ -453,7 +453,7 @@ const baseUrl = extractBaseUrlBeforeSegment("https://example.com/api/v1/subgraph
453
453
 
454
454
  > **extractJsonObject**\<`T`\>(`value`): `null` \| `T`
455
455
 
456
- Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/json.ts#L50)
456
+ Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/json.ts#L50)
457
457
 
458
458
  Extracts a JSON object from a string.
459
459
 
@@ -496,7 +496,7 @@ const json = extractJsonObject<{ port: number }>(
496
496
 
497
497
  > **fetchWithRetry**(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Response`\>
498
498
 
499
- Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/http/fetch-with-retry.ts#L18)
499
+ Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/http/fetch-with-retry.ts#L18)
500
500
 
501
501
  Retry an HTTP request with exponential backoff and jitter.
502
502
  Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
@@ -534,7 +534,7 @@ const response = await fetchWithRetry("https://api.example.com/data");
534
534
 
535
535
  > **findMonoRepoPackages**(`projectDir`): `Promise`\<`string`[]\>
536
536
 
537
- Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/filesystem/mono-repo.ts#L59)
537
+ Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/filesystem/mono-repo.ts#L59)
538
538
 
539
539
  Finds all packages in a monorepo
540
540
 
@@ -565,7 +565,7 @@ console.log(packages); // Output: ["/path/to/your/project/packages/core", "/path
565
565
 
566
566
  > **findMonoRepoRoot**(`startDir`): `Promise`\<`null` \| `string`\>
567
567
 
568
- Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/filesystem/mono-repo.ts#L19)
568
+ Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/filesystem/mono-repo.ts#L19)
569
569
 
570
570
  Finds the root directory of a monorepo
571
571
 
@@ -596,7 +596,7 @@ console.log(root); // Output: /path/to/your/project/packages/core
596
596
 
597
597
  > **formatTargetDir**(`targetDir`): `string`
598
598
 
599
- Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/package-manager/download-and-extract.ts#L15)
599
+ Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/package-manager/download-and-extract.ts#L15)
600
600
 
601
601
  Formats a directory path by removing trailing slashes and whitespace
602
602
 
@@ -626,7 +626,7 @@ const formatted = formatTargetDir("/path/to/dir/ "); // "/path/to/dir"
626
626
 
627
627
  > **getPackageManager**(`targetDir?`): `Promise`\<`AgentName`\>
628
628
 
629
- Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/package-manager/get-package-manager.ts#L15)
629
+ Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/package-manager/get-package-manager.ts#L15)
630
630
 
631
631
  Detects the package manager used in the current project
632
632
 
@@ -657,7 +657,7 @@ console.log(`Using ${packageManager}`);
657
657
 
658
658
  > **getPackageManagerExecutable**(`targetDir?`): `Promise`\<\{ `args`: `string`[]; `command`: `string`; \}\>
659
659
 
660
- Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
660
+ Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
661
661
 
662
662
  Retrieves the executable command and arguments for the package manager
663
663
 
@@ -688,7 +688,7 @@ console.log(`Using ${command} with args: ${args.join(" ")}`);
688
688
 
689
689
  > **graphqlFetchWithRetry**\<`Data`\>(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Data`\>
690
690
 
691
- Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
691
+ Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
692
692
 
693
693
  Executes a GraphQL request with automatic retries using exponential backoff and jitter.
694
694
  Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
@@ -747,7 +747,7 @@ const data = await graphqlFetchWithRetry<{ user: { id: string } }>(
747
747
 
748
748
  > **installDependencies**(`pkgs`, `cwd?`): `Promise`\<`void`\>
749
749
 
750
- Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/package-manager/install-dependencies.ts#L20)
750
+ Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/package-manager/install-dependencies.ts#L20)
751
751
 
752
752
  Installs one or more packages as dependencies using the detected package manager
753
753
 
@@ -786,7 +786,7 @@ await installDependencies(["express", "cors"]);
786
786
 
787
787
  > **intro**(`msg`): `void`
788
788
 
789
- Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/intro.ts#L16)
789
+ Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/intro.ts#L16)
790
790
 
791
791
  Displays an introductory message in magenta text with padding.
792
792
  Any sensitive tokens in the message are masked before display.
@@ -816,7 +816,7 @@ intro("Starting deployment...");
816
816
 
817
817
  > **isEmpty**(`path`): `Promise`\<`boolean`\>
818
818
 
819
- Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/package-manager/download-and-extract.ts#L31)
819
+ Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/package-manager/download-and-extract.ts#L31)
820
820
 
821
821
  Checks if a directory is empty or contains only a .git folder
822
822
 
@@ -848,7 +848,7 @@ if (await isEmpty("/path/to/dir")) {
848
848
 
849
849
  > **isPackageInstalled**(`name`, `path?`): `Promise`\<`boolean`\>
850
850
 
851
- Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/package-manager/is-package-installed.ts#L17)
851
+ Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/package-manager/is-package-installed.ts#L17)
852
852
 
853
853
  Checks if a package is installed in the project's dependencies, devDependencies, or peerDependencies.
854
854
 
@@ -884,7 +884,7 @@ console.log(`@settlemint/sdk-utils is installed: ${isInstalled}`);
884
884
 
885
885
  > **list**(`title`, `items`): `void`
886
886
 
887
- Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/list.ts#L23)
887
+ Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/list.ts#L23)
888
888
 
889
889
  Displays a list of items in a formatted manner, supporting nested items.
890
890
 
@@ -924,7 +924,7 @@ list("Providers", [
924
924
 
925
925
  > **loadEnv**\<`T`\>(`validateEnv`, `prod`, `path`): `Promise`\<`T` *extends* `true` ? `object` : `object`\>
926
926
 
927
- Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/environment/load-env.ts#L25)
927
+ Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/environment/load-env.ts#L25)
928
928
 
929
929
  Loads environment variables from .env files.
930
930
  To enable encryption with dotenvx (https://www.dotenvx.com/docs) run `bunx dotenvx encrypt`
@@ -972,7 +972,7 @@ const rawEnv = await loadEnv(false, false);
972
972
 
973
973
  > **makeJsonStringifiable**\<`T`\>(`value`): `T`
974
974
 
975
- Defined in: [sdk/utils/src/json.ts:73](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/json.ts#L73)
975
+ Defined in: [sdk/utils/src/json.ts:73](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/json.ts#L73)
976
976
 
977
977
  Converts a value to a JSON stringifiable format.
978
978
 
@@ -1009,7 +1009,7 @@ const json = makeJsonStringifiable<{ amount: bigint }>({ amount: BigInt(1000) })
1009
1009
 
1010
1010
  > **maskTokens**(`output`): `string`
1011
1011
 
1012
- Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/logging/mask-tokens.ts#L13)
1012
+ Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/logging/mask-tokens.ts#L13)
1013
1013
 
1014
1014
  Masks sensitive SettleMint tokens in output text by replacing them with asterisks.
1015
1015
  Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).
@@ -1041,7 +1041,7 @@ const masked = maskTokens("Token: sm_pat_****"); // "Token: ***"
1041
1041
 
1042
1042
  > **note**(`message`, `level`): `void`
1043
1043
 
1044
- Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/note.ts#L21)
1044
+ Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/note.ts#L21)
1045
1045
 
1046
1046
  Displays a note message with optional warning level formatting.
1047
1047
  Regular notes are displayed in normal text, while warnings are shown in yellow.
@@ -1076,7 +1076,7 @@ note("Low disk space remaining", "warn");
1076
1076
 
1077
1077
  > **outro**(`msg`): `void`
1078
1078
 
1079
- Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/outro.ts#L16)
1079
+ Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/outro.ts#L16)
1080
1080
 
1081
1081
  Displays a closing message in green inverted text with padding.
1082
1082
  Any sensitive tokens in the message are masked before display.
@@ -1106,7 +1106,7 @@ outro("Deployment completed successfully!");
1106
1106
 
1107
1107
  > **projectRoot**(`fallbackToCwd`, `cwd?`): `Promise`\<`string`\>
1108
1108
 
1109
- Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/filesystem/project-root.ts#L18)
1109
+ Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/filesystem/project-root.ts#L18)
1110
1110
 
1111
1111
  Finds the root directory of the current project by locating the nearest package.json file
1112
1112
 
@@ -1143,7 +1143,7 @@ console.log(`Project root is at: ${rootDir}`);
1143
1143
 
1144
1144
  > **replaceUnderscoresAndHyphensWithSpaces**(`s`): `string`
1145
1145
 
1146
- Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/string.ts#L48)
1146
+ Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/string.ts#L48)
1147
1147
 
1148
1148
  Replaces underscores and hyphens with spaces.
1149
1149
 
@@ -1174,7 +1174,7 @@ const result = replaceUnderscoresAndHyphensWithSpaces("Already_Spaced-Second");
1174
1174
 
1175
1175
  > **requestLogger**(`logger`, `name`, `fn`): (...`args`) => `Promise`\<`Response`\>
1176
1176
 
1177
- Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/logging/request-logger.ts#L14)
1177
+ Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/logging/request-logger.ts#L14)
1178
1178
 
1179
1179
  Logs the request and duration of a fetch call (> 500ms is logged as warn, otherwise info)
1180
1180
 
@@ -1208,7 +1208,7 @@ The fetch function
1208
1208
 
1209
1209
  > **retryWhenFailed**\<`T`\>(`fn`, `maxRetries`, `initialSleepTime`, `stopOnError?`): `Promise`\<`T`\>
1210
1210
 
1211
- Defined in: [sdk/utils/src/retry.ts:16](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/retry.ts#L16)
1211
+ Defined in: [sdk/utils/src/retry.ts:16](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/retry.ts#L16)
1212
1212
 
1213
1213
  Retry a function when it fails.
1214
1214
 
@@ -1248,7 +1248,7 @@ const result = await retryWhenFailed(() => readFile("/path/to/file.txt"), 3, 1_0
1248
1248
 
1249
1249
  > **setName**(`name`, `path?`): `Promise`\<`void`\>
1250
1250
 
1251
- Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/package-manager/set-name.ts#L16)
1251
+ Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/package-manager/set-name.ts#L16)
1252
1252
 
1253
1253
  Sets the name field in the package.json file
1254
1254
 
@@ -1283,7 +1283,7 @@ await setName("my-new-project-name");
1283
1283
 
1284
1284
  > **spinner**\<`R`\>(`options`): `Promise`\<`R`\>
1285
1285
 
1286
- Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/spinner.ts#L55)
1286
+ Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/spinner.ts#L55)
1287
1287
 
1288
1288
  Displays a loading spinner while executing an async task.
1289
1289
  Shows progress with start/stop messages and handles errors.
@@ -1333,7 +1333,7 @@ const result = await spinner({
1333
1333
 
1334
1334
  > **table**(`title`, `data`): `void`
1335
1335
 
1336
- Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/table.ts#L21)
1336
+ Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/table.ts#L21)
1337
1337
 
1338
1338
  Displays data in a formatted table in the terminal.
1339
1339
 
@@ -1367,7 +1367,7 @@ table("My Table", data);
1367
1367
 
1368
1368
  > **truncate**(`value`, `maxLength`): `string`
1369
1369
 
1370
- Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/string.ts#L65)
1370
+ Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/string.ts#L65)
1371
1371
 
1372
1372
  Truncates a string to a maximum length and appends "..." if it is longer.
1373
1373
 
@@ -1399,7 +1399,7 @@ const truncated = truncate("Hello, world!", 10);
1399
1399
 
1400
1400
  > **tryParseJson**\<`T`\>(`value`, `defaultValue`): `null` \| `T`
1401
1401
 
1402
- Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/json.ts#L23)
1402
+ Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/json.ts#L23)
1403
1403
 
1404
1404
  Attempts to parse a JSON string into a typed value, returning a default value if parsing fails.
1405
1405
 
@@ -1446,7 +1446,7 @@ const invalid = tryParseJson<string[]>(
1446
1446
 
1447
1447
  > **validate**\<`T`\>(`schema`, `value`): `T`\[`"_output"`\]
1448
1448
 
1449
- Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/validate.ts#L16)
1449
+ Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/validate.ts#L16)
1450
1450
 
1451
1451
  Validates a value against a given Zod schema.
1452
1452
 
@@ -1487,7 +1487,7 @@ const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
1487
1487
 
1488
1488
  > **writeEnv**(`options`): `Promise`\<`void`\>
1489
1489
 
1490
- Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/environment/write-env.ts#L41)
1490
+ Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/environment/write-env.ts#L41)
1491
1491
 
1492
1492
  Writes environment variables to .env files across a project or monorepo
1493
1493
 
@@ -1539,7 +1539,7 @@ await writeEnv({
1539
1539
 
1540
1540
  #### CancelError
1541
1541
 
1542
- Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/cancel.ts#L8)
1542
+ Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/cancel.ts#L8)
1543
1543
 
1544
1544
  Error class used to indicate that the operation was cancelled.
1545
1545
  This error is used to signal that the operation should be aborted.
@@ -1552,7 +1552,7 @@ This error is used to signal that the operation should be aborted.
1552
1552
 
1553
1553
  #### CommandError
1554
1554
 
1555
- Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/execute-command.ts#L16)
1555
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/execute-command.ts#L16)
1556
1556
 
1557
1557
  Error class for command execution errors
1558
1558
 
@@ -1566,7 +1566,7 @@ Error class for command execution errors
1566
1566
 
1567
1567
  > **new CommandError**(`message`, `code`, `output`): [`CommandError`](#commanderror)
1568
1568
 
1569
- Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/execute-command.ts#L23)
1569
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/execute-command.ts#L23)
1570
1570
 
1571
1571
  Constructs a new CommandError
1572
1572
 
@@ -1592,7 +1592,7 @@ Constructs a new CommandError
1592
1592
 
1593
1593
  > `readonly` **code**: `number`
1594
1594
 
1595
- Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/execute-command.ts#L25)
1595
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/execute-command.ts#L25)
1596
1596
 
1597
1597
  The exit code of the command
1598
1598
 
@@ -1600,7 +1600,7 @@ The exit code of the command
1600
1600
 
1601
1601
  > `readonly` **output**: `string`[]
1602
1602
 
1603
- Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/execute-command.ts#L26)
1603
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/execute-command.ts#L26)
1604
1604
 
1605
1605
  The output of the command
1606
1606
 
@@ -1608,7 +1608,7 @@ The output of the command
1608
1608
 
1609
1609
  #### SpinnerError
1610
1610
 
1611
- Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/spinner.ts#L12)
1611
+ Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/spinner.ts#L12)
1612
1612
 
1613
1613
  Error class used to indicate that the spinner operation failed.
1614
1614
  This error is used to signal that the operation should be aborted.
@@ -1621,7 +1621,7 @@ This error is used to signal that the operation should be aborted.
1621
1621
 
1622
1622
  #### ExecuteCommandOptions
1623
1623
 
1624
- Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/execute-command.ts#L7)
1624
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/execute-command.ts#L7)
1625
1625
 
1626
1626
  Options for executing a command, extending SpawnOptionsWithoutStdio
1627
1627
 
@@ -1633,13 +1633,13 @@ Options for executing a command, extending SpawnOptionsWithoutStdio
1633
1633
 
1634
1634
  | Property | Type | Description | Defined in |
1635
1635
  | ------ | ------ | ------ | ------ |
1636
- | <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.6/sdk/utils/src/terminal/execute-command.ts#L9) |
1636
+ | <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.8/sdk/utils/src/terminal/execute-command.ts#L9) |
1637
1637
 
1638
1638
  ***
1639
1639
 
1640
1640
  #### Logger
1641
1641
 
1642
- Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/logging/logger.ts#L23)
1642
+ Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/logging/logger.ts#L23)
1643
1643
 
1644
1644
  Simple logger interface with basic logging methods
1645
1645
  Logger
@@ -1648,16 +1648,16 @@ Simple logger interface with basic logging methods
1648
1648
 
1649
1649
  | Property | Type | Description | Defined in |
1650
1650
  | ------ | ------ | ------ | ------ |
1651
- | <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.6/sdk/utils/src/logging/logger.ts#L25) |
1652
- | <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.6/sdk/utils/src/logging/logger.ts#L31) |
1653
- | <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.6/sdk/utils/src/logging/logger.ts#L27) |
1654
- | <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.6/sdk/utils/src/logging/logger.ts#L29) |
1651
+ | <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.8/sdk/utils/src/logging/logger.ts#L25) |
1652
+ | <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.8/sdk/utils/src/logging/logger.ts#L31) |
1653
+ | <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.8/sdk/utils/src/logging/logger.ts#L27) |
1654
+ | <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.8/sdk/utils/src/logging/logger.ts#L29) |
1655
1655
 
1656
1656
  ***
1657
1657
 
1658
1658
  #### LoggerOptions
1659
1659
 
1660
- Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/logging/logger.ts#L12)
1660
+ Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/logging/logger.ts#L12)
1661
1661
 
1662
1662
  Configuration options for the logger
1663
1663
  LoggerOptions
@@ -1666,14 +1666,14 @@ Configuration options for the logger
1666
1666
 
1667
1667
  | Property | Type | Description | Defined in |
1668
1668
  | ------ | ------ | ------ | ------ |
1669
- | <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.6/sdk/utils/src/logging/logger.ts#L14) |
1670
- | <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.6/sdk/utils/src/logging/logger.ts#L16) |
1669
+ | <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.8/sdk/utils/src/logging/logger.ts#L14) |
1670
+ | <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.8/sdk/utils/src/logging/logger.ts#L16) |
1671
1671
 
1672
1672
  ***
1673
1673
 
1674
1674
  #### SpinnerOptions\<R\>
1675
1675
 
1676
- Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/terminal/spinner.ts#L25)
1676
+ Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/terminal/spinner.ts#L25)
1677
1677
 
1678
1678
  Options for configuring the spinner behavior
1679
1679
 
@@ -1687,9 +1687,9 @@ Options for configuring the spinner behavior
1687
1687
 
1688
1688
  | Property | Type | Description | Defined in |
1689
1689
  | ------ | ------ | ------ | ------ |
1690
- | <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.6/sdk/utils/src/terminal/spinner.ts#L27) |
1691
- | <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.6/sdk/utils/src/terminal/spinner.ts#L31) |
1692
- | <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.6/sdk/utils/src/terminal/spinner.ts#L29) |
1690
+ | <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.8/sdk/utils/src/terminal/spinner.ts#L27) |
1691
+ | <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.8/sdk/utils/src/terminal/spinner.ts#L31) |
1692
+ | <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.8/sdk/utils/src/terminal/spinner.ts#L29) |
1693
1693
 
1694
1694
  ### Type Aliases
1695
1695
 
@@ -1697,7 +1697,7 @@ Options for configuring the spinner behavior
1697
1697
 
1698
1698
  > **DotEnv** = `z.infer`\<*typeof* [`DotEnvSchema`](#dotenvschema)\>
1699
1699
 
1700
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:108](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/dot-env.schema.ts#L108)
1700
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:108](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/dot-env.schema.ts#L108)
1701
1701
 
1702
1702
  Type definition for the environment variables schema.
1703
1703
 
@@ -1707,7 +1707,7 @@ Type definition for the environment variables schema.
1707
1707
 
1708
1708
  > **DotEnvPartial** = `z.infer`\<*typeof* [`DotEnvSchemaPartial`](#dotenvschemapartial)\>
1709
1709
 
1710
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:119](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/dot-env.schema.ts#L119)
1710
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:119](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/dot-env.schema.ts#L119)
1711
1711
 
1712
1712
  Type definition for the partial environment variables schema.
1713
1713
 
@@ -1717,7 +1717,7 @@ Type definition for the partial environment variables schema.
1717
1717
 
1718
1718
  > **Id** = `z.infer`\<*typeof* [`IdSchema`](#idschema)\>
1719
1719
 
1720
- Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/id.schema.ts#L30)
1720
+ Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/id.schema.ts#L30)
1721
1721
 
1722
1722
  Type definition for database IDs, inferred from IdSchema.
1723
1723
  Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
@@ -1728,7 +1728,7 @@ Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
1728
1728
 
1729
1729
  > **LogLevel** = `"debug"` \| `"info"` \| `"warn"` \| `"error"` \| `"none"`
1730
1730
 
1731
- Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/logging/logger.ts#L6)
1731
+ Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/logging/logger.ts#L6)
1732
1732
 
1733
1733
  Log levels supported by the logger
1734
1734
 
@@ -1738,7 +1738,7 @@ Log levels supported by the logger
1738
1738
 
1739
1739
  > `const` **AccessTokenSchema**: `ZodString`
1740
1740
 
1741
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/access-token.schema.ts#L21)
1741
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/access-token.schema.ts#L21)
1742
1742
 
1743
1743
  Schema for validating both application and personal access tokens.
1744
1744
  Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
@@ -1749,7 +1749,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
1749
1749
 
1750
1750
  > `const` **ApplicationAccessTokenSchema**: `ZodString`
1751
1751
 
1752
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/access-token.schema.ts#L7)
1752
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/access-token.schema.ts#L7)
1753
1753
 
1754
1754
  Schema for validating application access tokens.
1755
1755
  Application access tokens start with 'sm_aat_' prefix.
@@ -1760,7 +1760,7 @@ Application access tokens start with 'sm_aat_' prefix.
1760
1760
 
1761
1761
  > `const` **DotEnvSchema**: `ZodObject`\<\{ `NODE_TLS_REJECT_UNAUTHORIZED`: `ZodOptional`\<`ZodEnum`\<\{ `0`: `"0"`; `1`: `"1"`; \}\>\>; `SETTLEMINT_ACCESS_TOKEN`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_APPLICATION`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NETWORK`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_CUSTOM_DEPLOYMENT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_ADMIN_SECRET`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_DATABASE_URL`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HD_PRIVATE_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_INSTANCE`: `ZodDefault`\<`ZodUnion`\<readonly \[`ZodString`, `ZodLiteral`\<`"standalone"`\>\]\>\>; `SETTLEMINT_IPFS`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_IPFS_API_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_IPFS_GATEWAY_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_IPFS_PINNING_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_LOG_LEVEL`: `ZodDefault`\<`ZodEnum`\<\{ `debug`: `"debug"`; `error`: `"error"`; `info`: `"info"`; `none`: `"none"`; `warn`: `"warn"`; \}\>\>; `SETTLEMINT_MINIO`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_MINIO_ACCESS_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_MINIO_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_MINIO_SECRET_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_NEW_PROJECT_NAME`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL_REST_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL_WS_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_THEGRAPH`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS`: `ZodPipe`\<`ZodTransform`\<`null` \| `never`[], `unknown`\>, `ZodOptional`\<`ZodArray`\<`ZodString`\>\>\>; `SETTLEMINT_WORKSPACE`: `ZodOptional`\<`ZodString`\>; \}, `$strip`\>
1762
1762
 
1763
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/dot-env.schema.ts#L17)
1763
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/dot-env.schema.ts#L17)
1764
1764
 
1765
1765
  Schema for validating environment variables used by the SettleMint SDK.
1766
1766
  Defines validation rules and types for configuration values like URLs,
@@ -1772,7 +1772,7 @@ access tokens, workspace names, and service endpoints.
1772
1772
 
1773
1773
  > `const` **DotEnvSchemaPartial**: `ZodObject`\<\{ `NODE_TLS_REJECT_UNAUTHORIZED`: `ZodOptional`\<`ZodOptional`\<`ZodEnum`\<\{ `0`: `"0"`; `1`: `"1"`; \}\>\>\>; `SETTLEMINT_ACCESS_TOKEN`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_APPLICATION`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NETWORK`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_CUSTOM_DEPLOYMENT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_ADMIN_SECRET`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_DATABASE_URL`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HD_PRIVATE_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_INSTANCE`: `ZodOptional`\<`ZodDefault`\<`ZodUnion`\<readonly \[`ZodString`, `ZodLiteral`\<`"standalone"`\>\]\>\>\>; `SETTLEMINT_IPFS`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_IPFS_API_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_IPFS_GATEWAY_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_IPFS_PINNING_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_LOG_LEVEL`: `ZodOptional`\<`ZodDefault`\<`ZodEnum`\<\{ `debug`: `"debug"`; `error`: `"error"`; `info`: `"info"`; `none`: `"none"`; `warn`: `"warn"`; \}\>\>\>; `SETTLEMINT_MINIO`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_MINIO_ACCESS_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_MINIO_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_MINIO_SECRET_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_NEW_PROJECT_NAME`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL_REST_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL_WS_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_THEGRAPH`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS`: `ZodOptional`\<`ZodPipe`\<`ZodTransform`\<`null` \| `never`[], `unknown`\>, `ZodOptional`\<`ZodArray`\<`ZodString`\>\>\>\>; `SETTLEMINT_WORKSPACE`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; \}, `$strip`\>
1774
1774
 
1775
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:114](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/dot-env.schema.ts#L114)
1775
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:114](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/dot-env.schema.ts#L114)
1776
1776
 
1777
1777
  Partial version of the environment variables schema where all fields are optional.
1778
1778
  Useful for validating incomplete configurations during development or build time.
@@ -1783,7 +1783,7 @@ Useful for validating incomplete configurations during development or build time
1783
1783
 
1784
1784
  > `const` **IdSchema**: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>
1785
1785
 
1786
- Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/id.schema.ts#L17)
1786
+ Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/id.schema.ts#L17)
1787
1787
 
1788
1788
  Schema for validating database IDs. Accepts both PostgreSQL UUIDs and MongoDB ObjectIDs.
1789
1789
  PostgreSQL UUIDs are 32 hexadecimal characters with hyphens (e.g. 123e4567-e89b-12d3-a456-426614174000).
@@ -1807,7 +1807,7 @@ const isValidObjectId = IdSchema.safeParse("507f1f77bcf86cd799439011").success;
1807
1807
 
1808
1808
  > `const` **PersonalAccessTokenSchema**: `ZodString`
1809
1809
 
1810
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/access-token.schema.ts#L14)
1810
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/access-token.schema.ts#L14)
1811
1811
 
1812
1812
  Schema for validating personal access tokens.
1813
1813
  Personal access tokens start with 'sm_pat_' prefix.
@@ -1818,7 +1818,7 @@ Personal access tokens start with 'sm_pat_' prefix.
1818
1818
 
1819
1819
  > `const` **runsInBrowser**: `boolean` = `isBrowser`
1820
1820
 
1821
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/runtime/ensure-server.ts#L40)
1821
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/runtime/ensure-server.ts#L40)
1822
1822
 
1823
1823
  Boolean indicating if code is currently running in a browser environment
1824
1824
 
@@ -1828,7 +1828,7 @@ Boolean indicating if code is currently running in a browser environment
1828
1828
 
1829
1829
  > `const` **runsOnServer**: `boolean` = `!isBrowser`
1830
1830
 
1831
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/runtime/ensure-server.ts#L45)
1831
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/runtime/ensure-server.ts#L45)
1832
1832
 
1833
1833
  Boolean indicating if code is currently running in a server environment
1834
1834
 
@@ -1838,7 +1838,7 @@ Boolean indicating if code is currently running in a server environment
1838
1838
 
1839
1839
  > `const` **STANDALONE\_INSTANCE**: `"standalone"` = `"standalone"`
1840
1840
 
1841
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:10](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/dot-env.schema.ts#L10)
1841
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:10](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/dot-env.schema.ts#L10)
1842
1842
 
1843
1843
  Use this value to indicate that the resources are not part of the SettleMint platform.
1844
1844
 
@@ -1848,7 +1848,7 @@ Use this value to indicate that the resources are not part of the SettleMint pla
1848
1848
 
1849
1849
  > `const` **UniqueNameSchema**: `ZodString`
1850
1850
 
1851
- Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/unique-name.schema.ts#L19)
1851
+ Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/unique-name.schema.ts#L19)
1852
1852
 
1853
1853
  Schema for validating unique names used across the SettleMint platform.
1854
1854
  Only accepts lowercase alphanumeric characters and hyphens.
@@ -1874,7 +1874,7 @@ const isInvalidName = UniqueNameSchema.safeParse("My Workspace!").success;
1874
1874
 
1875
1875
  > `const` **UrlOrPathSchema**: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>
1876
1876
 
1877
- Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/url.schema.ts#L54)
1877
+ Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/url.schema.ts#L54)
1878
1878
 
1879
1879
  Schema that accepts either a full URL or a URL path.
1880
1880
 
@@ -1898,7 +1898,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
1898
1898
 
1899
1899
  > `const` **UrlPathSchema**: `ZodString`
1900
1900
 
1901
- Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/url.schema.ts#L34)
1901
+ Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/url.schema.ts#L34)
1902
1902
 
1903
1903
  Schema for validating URL paths.
1904
1904
 
@@ -1922,7 +1922,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
1922
1922
 
1923
1923
  > `const` **UrlSchema**: `ZodString`
1924
1924
 
1925
- Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.6/sdk/utils/src/validation/url.schema.ts#L17)
1925
+ Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/url.schema.ts#L17)
1926
1926
 
1927
1927
  Schema for validating URLs.
1928
1928
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@settlemint/sdk-utils",
3
3
  "description": "Shared utilities and helper functions for SettleMint SDK modules",
4
- "version": "2.3.6",
4
+ "version": "2.3.8-mainb7108730",
5
5
  "type": "module",
6
6
  "private": false,
7
7
  "license": "FSL-1.1-MIT",