@settlemint/sdk-utils 2.3.1-prfcd3c3b5 → 2.3.2

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 (14) hide show
  1. package/README.md +88 -287
  2. package/dist/environment.cjs +31 -31
  3. package/dist/environment.cjs.map +1 -1
  4. package/dist/environment.d.cts +19 -211
  5. package/dist/environment.d.ts +19 -211
  6. package/dist/environment.mjs +8 -8
  7. package/dist/environment.mjs.map +1 -1
  8. package/dist/validation.cjs +31 -31
  9. package/dist/validation.cjs.map +1 -1
  10. package/dist/validation.d.cts +22 -214
  11. package/dist/validation.d.ts +22 -214
  12. package/dist/validation.mjs +8 -8
  13. package/dist/validation.mjs.map +1 -1
  14. package/package.json +1 -1
package/README.md CHANGED
@@ -78,16 +78,10 @@
78
78
  - [LoggerOptions](#loggeroptions)
79
79
  - [SpinnerOptions\<R\>](#spinneroptionsr)
80
80
  - [Type Aliases](#type-aliases)
81
- - [AccessToken](#accesstoken)
82
- - [ApplicationAccessToken](#applicationaccesstoken)
83
81
  - [DotEnv](#dotenv)
84
82
  - [DotEnvPartial](#dotenvpartial)
85
83
  - [Id](#id)
86
84
  - [LogLevel](#loglevel)
87
- - [PersonalAccessToken](#personalaccesstoken)
88
- - [Url](#url)
89
- - [UrlOrPath](#urlorpath)
90
- - [UrlPath](#urlpath)
91
85
  - [Variables](#variables)
92
86
  - [AccessTokenSchema](#accesstokenschema)
93
87
  - [ApplicationAccessTokenSchema](#applicationaccesstokenschema)
@@ -116,7 +110,7 @@ The SettleMint Utils SDK provides a collection of shared utilities and helper fu
116
110
 
117
111
  > **ascii**(): `void`
118
112
 
119
- Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/ascii.ts#L14)
113
+ Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/ascii.ts#L14)
120
114
 
121
115
  Prints the SettleMint ASCII art logo to the console in magenta color.
122
116
  Used for CLI branding and visual identification.
@@ -140,7 +134,7 @@ ascii();
140
134
 
141
135
  > **camelCaseToWords**(`s`): `string`
142
136
 
143
- Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/string.ts#L29)
137
+ Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/string.ts#L29)
144
138
 
145
139
  Converts a camelCase string to a human-readable string.
146
140
 
@@ -171,7 +165,7 @@ const words = camelCaseToWords("camelCaseString");
171
165
 
172
166
  > **cancel**(`msg`): `never`
173
167
 
174
- Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/cancel.ts#L23)
168
+ Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/cancel.ts#L23)
175
169
 
176
170
  Displays an error message in red inverse text and throws a CancelError.
177
171
  Used to terminate execution with a visible error message.
@@ -204,7 +198,7 @@ cancel("An error occurred");
204
198
 
205
199
  > **capitalizeFirstLetter**(`val`): `string`
206
200
 
207
- Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/string.ts#L13)
201
+ Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/string.ts#L13)
208
202
 
209
203
  Capitalizes the first letter of a string.
210
204
 
@@ -235,7 +229,7 @@ const capitalized = capitalizeFirstLetter("hello");
235
229
 
236
230
  > **createLogger**(`options`): [`Logger`](#logger)
237
231
 
238
- Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/logging/logger.ts#L50)
232
+ Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/logging/logger.ts#L50)
239
233
 
240
234
  Creates a simple logger with configurable log level
241
235
 
@@ -268,7 +262,7 @@ logger.error('Operation failed', new Error('Connection timeout'));
268
262
 
269
263
  > **emptyDir**(`dir`): `Promise`\<`void`\>
270
264
 
271
- Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/package-manager/download-and-extract.ts#L45)
265
+ Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/package-manager/download-and-extract.ts#L45)
272
266
 
273
267
  Removes all contents of a directory except the .git folder
274
268
 
@@ -296,7 +290,7 @@ await emptyDir("/path/to/dir"); // Removes all contents except .git
296
290
 
297
291
  > **ensureBrowser**(): `void`
298
292
 
299
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/runtime/ensure-server.ts#L31)
293
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/runtime/ensure-server.ts#L31)
300
294
 
301
295
  Ensures that code is running in a browser environment and not on the server.
302
296
 
@@ -323,7 +317,7 @@ ensureBrowser();
323
317
 
324
318
  > **ensureServer**(): `void`
325
319
 
326
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/runtime/ensure-server.ts#L13)
320
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/runtime/ensure-server.ts#L13)
327
321
 
328
322
  Ensures that code is running on the server and not in a browser environment.
329
323
 
@@ -350,7 +344,7 @@ ensureServer();
350
344
 
351
345
  > **executeCommand**(`command`, `args`, `options?`): `Promise`\<`string`[]\>
352
346
 
353
- Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/execute-command.ts#L51)
347
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/execute-command.ts#L51)
354
348
 
355
349
  Executes a command with the given arguments in a child process.
356
350
  Pipes stdin to the child process and captures stdout/stderr output.
@@ -392,7 +386,7 @@ await executeCommand("npm", ["install"], { silent: true });
392
386
 
393
387
  > **exists**(`path`): `Promise`\<`boolean`\>
394
388
 
395
- Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/filesystem/exists.ts#L17)
389
+ Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/filesystem/exists.ts#L17)
396
390
 
397
391
  Checks if a file or directory exists at the given path
398
392
 
@@ -425,7 +419,7 @@ if (await exists('/path/to/file.txt')) {
425
419
 
426
420
  > **extractJsonObject**\<`T`\>(`value`): `null` \| `T`
427
421
 
428
- Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/json.ts#L50)
422
+ Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/json.ts#L50)
429
423
 
430
424
  Extracts a JSON object from a string.
431
425
 
@@ -468,7 +462,7 @@ const json = extractJsonObject<{ port: number }>(
468
462
 
469
463
  > **fetchWithRetry**(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Response`\>
470
464
 
471
- Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/http/fetch-with-retry.ts#L18)
465
+ Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/http/fetch-with-retry.ts#L18)
472
466
 
473
467
  Retry an HTTP request with exponential backoff and jitter.
474
468
  Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
@@ -506,7 +500,7 @@ const response = await fetchWithRetry("https://api.example.com/data");
506
500
 
507
501
  > **findMonoRepoPackages**(`projectDir`): `Promise`\<`string`[]\>
508
502
 
509
- Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/filesystem/mono-repo.ts#L59)
503
+ Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/filesystem/mono-repo.ts#L59)
510
504
 
511
505
  Finds all packages in a monorepo
512
506
 
@@ -537,7 +531,7 @@ console.log(packages); // Output: ["/path/to/your/project/packages/core", "/path
537
531
 
538
532
  > **findMonoRepoRoot**(`startDir`): `Promise`\<`null` \| `string`\>
539
533
 
540
- Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/filesystem/mono-repo.ts#L19)
534
+ Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/filesystem/mono-repo.ts#L19)
541
535
 
542
536
  Finds the root directory of a monorepo
543
537
 
@@ -568,7 +562,7 @@ console.log(root); // Output: /path/to/your/project/packages/core
568
562
 
569
563
  > **formatTargetDir**(`targetDir`): `string`
570
564
 
571
- Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/package-manager/download-and-extract.ts#L15)
565
+ Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/package-manager/download-and-extract.ts#L15)
572
566
 
573
567
  Formats a directory path by removing trailing slashes and whitespace
574
568
 
@@ -598,7 +592,7 @@ const formatted = formatTargetDir("/path/to/dir/ "); // "/path/to/dir"
598
592
 
599
593
  > **getPackageManager**(`targetDir?`): `Promise`\<`AgentName`\>
600
594
 
601
- Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/package-manager/get-package-manager.ts#L15)
595
+ Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/package-manager/get-package-manager.ts#L15)
602
596
 
603
597
  Detects the package manager used in the current project
604
598
 
@@ -629,7 +623,7 @@ console.log(`Using ${packageManager}`);
629
623
 
630
624
  > **getPackageManagerExecutable**(`targetDir?`): `Promise`\<\{ `args`: `string`[]; `command`: `string`; \}\>
631
625
 
632
- Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
626
+ Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
633
627
 
634
628
  Retrieves the executable command and arguments for the package manager
635
629
 
@@ -660,7 +654,7 @@ console.log(`Using ${command} with args: ${args.join(" ")}`);
660
654
 
661
655
  > **graphqlFetchWithRetry**\<`Data`\>(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Data`\>
662
656
 
663
- Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
657
+ Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
664
658
 
665
659
  Executes a GraphQL request with automatic retries using exponential backoff and jitter.
666
660
  Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
@@ -719,7 +713,7 @@ const data = await graphqlFetchWithRetry<{ user: { id: string } }>(
719
713
 
720
714
  > **installDependencies**(`pkgs`, `cwd?`): `Promise`\<`void`\>
721
715
 
722
- Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/package-manager/install-dependencies.ts#L20)
716
+ Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/package-manager/install-dependencies.ts#L20)
723
717
 
724
718
  Installs one or more packages as dependencies using the detected package manager
725
719
 
@@ -758,7 +752,7 @@ await installDependencies(["express", "cors"]);
758
752
 
759
753
  > **intro**(`msg`): `void`
760
754
 
761
- Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/intro.ts#L16)
755
+ Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/intro.ts#L16)
762
756
 
763
757
  Displays an introductory message in magenta text with padding.
764
758
  Any sensitive tokens in the message are masked before display.
@@ -788,7 +782,7 @@ intro("Starting deployment...");
788
782
 
789
783
  > **isEmpty**(`path`): `Promise`\<`boolean`\>
790
784
 
791
- Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/package-manager/download-and-extract.ts#L31)
785
+ Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/package-manager/download-and-extract.ts#L31)
792
786
 
793
787
  Checks if a directory is empty or contains only a .git folder
794
788
 
@@ -820,7 +814,7 @@ if (await isEmpty("/path/to/dir")) {
820
814
 
821
815
  > **isPackageInstalled**(`name`, `path?`): `Promise`\<`boolean`\>
822
816
 
823
- Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/package-manager/is-package-installed.ts#L17)
817
+ Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/package-manager/is-package-installed.ts#L17)
824
818
 
825
819
  Checks if a package is installed in the project's dependencies, devDependencies, or peerDependencies.
826
820
 
@@ -856,7 +850,7 @@ console.log(`@settlemint/sdk-utils is installed: ${isInstalled}`);
856
850
 
857
851
  > **list**(`title`, `items`): `void`
858
852
 
859
- Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/list.ts#L23)
853
+ Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/list.ts#L23)
860
854
 
861
855
  Displays a list of items in a formatted manner, supporting nested items.
862
856
 
@@ -896,7 +890,7 @@ list("Providers", [
896
890
 
897
891
  > **loadEnv**\<`T`\>(`validateEnv`, `prod`, `path`): `Promise`\<`T` *extends* `true` ? `object` : `object`\>
898
892
 
899
- Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/environment/load-env.ts#L25)
893
+ Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/environment/load-env.ts#L25)
900
894
 
901
895
  Loads environment variables from .env files.
902
896
  To enable encryption with dotenvx (https://www.dotenvx.com/docs) run `bunx dotenvx encrypt`
@@ -944,7 +938,7 @@ const rawEnv = await loadEnv(false, false);
944
938
 
945
939
  > **makeJsonStringifiable**\<`T`\>(`value`): `T`
946
940
 
947
- Defined in: [sdk/utils/src/json.ts:73](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/json.ts#L73)
941
+ Defined in: [sdk/utils/src/json.ts:73](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/json.ts#L73)
948
942
 
949
943
  Converts a value to a JSON stringifiable format.
950
944
 
@@ -981,7 +975,7 @@ const json = makeJsonStringifiable<{ amount: bigint }>({ amount: BigInt(1000) })
981
975
 
982
976
  > **maskTokens**(`output`): `string`
983
977
 
984
- Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/logging/mask-tokens.ts#L13)
978
+ Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/logging/mask-tokens.ts#L13)
985
979
 
986
980
  Masks sensitive SettleMint tokens in output text by replacing them with asterisks.
987
981
  Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).
@@ -1013,7 +1007,7 @@ const masked = maskTokens("Token: sm_pat_****"); // "Token: ***"
1013
1007
 
1014
1008
  > **note**(`message`, `level`): `void`
1015
1009
 
1016
- Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/note.ts#L21)
1010
+ Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/note.ts#L21)
1017
1011
 
1018
1012
  Displays a note message with optional warning level formatting.
1019
1013
  Regular notes are displayed in normal text, while warnings are shown in yellow.
@@ -1048,7 +1042,7 @@ note("Low disk space remaining", "warn");
1048
1042
 
1049
1043
  > **outro**(`msg`): `void`
1050
1044
 
1051
- Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/outro.ts#L16)
1045
+ Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/outro.ts#L16)
1052
1046
 
1053
1047
  Displays a closing message in green inverted text with padding.
1054
1048
  Any sensitive tokens in the message are masked before display.
@@ -1078,7 +1072,7 @@ outro("Deployment completed successfully!");
1078
1072
 
1079
1073
  > **projectRoot**(`fallbackToCwd`, `cwd?`): `Promise`\<`string`\>
1080
1074
 
1081
- Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/filesystem/project-root.ts#L18)
1075
+ Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/filesystem/project-root.ts#L18)
1082
1076
 
1083
1077
  Finds the root directory of the current project by locating the nearest package.json file
1084
1078
 
@@ -1115,7 +1109,7 @@ console.log(`Project root is at: ${rootDir}`);
1115
1109
 
1116
1110
  > **replaceUnderscoresAndHyphensWithSpaces**(`s`): `string`
1117
1111
 
1118
- Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/string.ts#L48)
1112
+ Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/string.ts#L48)
1119
1113
 
1120
1114
  Replaces underscores and hyphens with spaces.
1121
1115
 
@@ -1146,7 +1140,7 @@ const result = replaceUnderscoresAndHyphensWithSpaces("Already_Spaced-Second");
1146
1140
 
1147
1141
  > **requestLogger**(`logger`, `name`, `fn`): (...`args`) => `Promise`\<`Response`\>
1148
1142
 
1149
- Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/logging/request-logger.ts#L14)
1143
+ Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/logging/request-logger.ts#L14)
1150
1144
 
1151
1145
  Logs the request and duration of a fetch call (> 500ms is logged as warn, otherwise info)
1152
1146
 
@@ -1180,7 +1174,7 @@ The fetch function
1180
1174
 
1181
1175
  > **retryWhenFailed**\<`T`\>(`fn`, `maxRetries`, `initialSleepTime`, `stopOnError?`): `Promise`\<`T`\>
1182
1176
 
1183
- Defined in: [sdk/utils/src/retry.ts:14](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/retry.ts#L14)
1177
+ Defined in: [sdk/utils/src/retry.ts:14](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/retry.ts#L14)
1184
1178
 
1185
1179
  Retry a function when it fails.
1186
1180
 
@@ -1220,7 +1214,7 @@ const result = await retryWhenFailed(() => readFile("/path/to/file.txt"), 3, 1_0
1220
1214
 
1221
1215
  > **setName**(`name`, `path?`): `Promise`\<`void`\>
1222
1216
 
1223
- Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/package-manager/set-name.ts#L16)
1217
+ Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/package-manager/set-name.ts#L16)
1224
1218
 
1225
1219
  Sets the name field in the package.json file
1226
1220
 
@@ -1255,7 +1249,7 @@ await setName("my-new-project-name");
1255
1249
 
1256
1250
  > **spinner**\<`R`\>(`options`): `Promise`\<`R`\>
1257
1251
 
1258
- Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/spinner.ts#L55)
1252
+ Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/spinner.ts#L55)
1259
1253
 
1260
1254
  Displays a loading spinner while executing an async task.
1261
1255
  Shows progress with start/stop messages and handles errors.
@@ -1305,7 +1299,7 @@ const result = await spinner({
1305
1299
 
1306
1300
  > **table**(`title`, `data`): `void`
1307
1301
 
1308
- Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/table.ts#L21)
1302
+ Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/table.ts#L21)
1309
1303
 
1310
1304
  Displays data in a formatted table in the terminal.
1311
1305
 
@@ -1339,7 +1333,7 @@ table("My Table", data);
1339
1333
 
1340
1334
  > **truncate**(`value`, `maxLength`): `string`
1341
1335
 
1342
- Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/string.ts#L65)
1336
+ Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/string.ts#L65)
1343
1337
 
1344
1338
  Truncates a string to a maximum length and appends "..." if it is longer.
1345
1339
 
@@ -1371,7 +1365,7 @@ const truncated = truncate("Hello, world!", 10);
1371
1365
 
1372
1366
  > **tryParseJson**\<`T`\>(`value`, `defaultValue`): `null` \| `T`
1373
1367
 
1374
- Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/json.ts#L23)
1368
+ Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/json.ts#L23)
1375
1369
 
1376
1370
  Attempts to parse a JSON string into a typed value, returning a default value if parsing fails.
1377
1371
 
@@ -1418,7 +1412,7 @@ const invalid = tryParseJson<string[]>(
1418
1412
 
1419
1413
  > **validate**\<`T`\>(`schema`, `value`): `T`\[`"_output"`\]
1420
1414
 
1421
- Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/validate.ts#L16)
1415
+ Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/validation/validate.ts#L16)
1422
1416
 
1423
1417
  Validates a value against a given Zod schema.
1424
1418
 
@@ -1426,7 +1420,7 @@ Validates a value against a given Zod schema.
1426
1420
 
1427
1421
  | Type Parameter |
1428
1422
  | ------ |
1429
- | `T` *extends* `ZodType`\<`any`, `ZodTypeDef`, `any`\> |
1423
+ | `T` *extends* `ZodType`\<`unknown`, `unknown`\> |
1430
1424
 
1431
1425
  ##### Parameters
1432
1426
 
@@ -1459,7 +1453,7 @@ const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
1459
1453
 
1460
1454
  > **writeEnv**(`options`): `Promise`\<`void`\>
1461
1455
 
1462
- Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/environment/write-env.ts#L41)
1456
+ Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/environment/write-env.ts#L41)
1463
1457
 
1464
1458
  Writes environment variables to .env files across a project or monorepo
1465
1459
 
@@ -1511,7 +1505,7 @@ await writeEnv({
1511
1505
 
1512
1506
  #### CancelError
1513
1507
 
1514
- Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/cancel.ts#L8)
1508
+ Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/cancel.ts#L8)
1515
1509
 
1516
1510
  Error class used to indicate that the operation was cancelled.
1517
1511
  This error is used to signal that the operation should be aborted.
@@ -1524,7 +1518,7 @@ This error is used to signal that the operation should be aborted.
1524
1518
 
1525
1519
  #### CommandError
1526
1520
 
1527
- Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/execute-command.ts#L16)
1521
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/execute-command.ts#L16)
1528
1522
 
1529
1523
  Error class for command execution errors
1530
1524
 
@@ -1538,7 +1532,7 @@ Error class for command execution errors
1538
1532
 
1539
1533
  > **new CommandError**(`message`, `code`, `output`): [`CommandError`](#commanderror)
1540
1534
 
1541
- Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/execute-command.ts#L23)
1535
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/execute-command.ts#L23)
1542
1536
 
1543
1537
  Constructs a new CommandError
1544
1538
 
@@ -1564,7 +1558,7 @@ Constructs a new CommandError
1564
1558
 
1565
1559
  > `readonly` **code**: `number`
1566
1560
 
1567
- Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/execute-command.ts#L25)
1561
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/execute-command.ts#L25)
1568
1562
 
1569
1563
  The exit code of the command
1570
1564
 
@@ -1572,7 +1566,7 @@ The exit code of the command
1572
1566
 
1573
1567
  > `readonly` **output**: `string`[]
1574
1568
 
1575
- Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/execute-command.ts#L26)
1569
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/execute-command.ts#L26)
1576
1570
 
1577
1571
  The output of the command
1578
1572
 
@@ -1580,7 +1574,7 @@ The output of the command
1580
1574
 
1581
1575
  #### SpinnerError
1582
1576
 
1583
- Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/spinner.ts#L12)
1577
+ Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/spinner.ts#L12)
1584
1578
 
1585
1579
  Error class used to indicate that the spinner operation failed.
1586
1580
  This error is used to signal that the operation should be aborted.
@@ -1593,7 +1587,7 @@ This error is used to signal that the operation should be aborted.
1593
1587
 
1594
1588
  #### ExecuteCommandOptions
1595
1589
 
1596
- Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/execute-command.ts#L7)
1590
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/execute-command.ts#L7)
1597
1591
 
1598
1592
  Options for executing a command, extending SpawnOptionsWithoutStdio
1599
1593
 
@@ -1605,13 +1599,13 @@ Options for executing a command, extending SpawnOptionsWithoutStdio
1605
1599
 
1606
1600
  | Property | Type | Description | Defined in |
1607
1601
  | ------ | ------ | ------ | ------ |
1608
- | <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.1/sdk/utils/src/terminal/execute-command.ts#L9) |
1602
+ | <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.2/sdk/utils/src/terminal/execute-command.ts#L9) |
1609
1603
 
1610
1604
  ***
1611
1605
 
1612
1606
  #### Logger
1613
1607
 
1614
- Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/logging/logger.ts#L23)
1608
+ Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/logging/logger.ts#L23)
1615
1609
 
1616
1610
  Simple logger interface with basic logging methods
1617
1611
  Logger
@@ -1620,16 +1614,16 @@ Simple logger interface with basic logging methods
1620
1614
 
1621
1615
  | Property | Type | Description | Defined in |
1622
1616
  | ------ | ------ | ------ | ------ |
1623
- | <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.1/sdk/utils/src/logging/logger.ts#L25) |
1624
- | <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.1/sdk/utils/src/logging/logger.ts#L31) |
1625
- | <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.1/sdk/utils/src/logging/logger.ts#L27) |
1626
- | <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.1/sdk/utils/src/logging/logger.ts#L29) |
1617
+ | <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.2/sdk/utils/src/logging/logger.ts#L25) |
1618
+ | <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.2/sdk/utils/src/logging/logger.ts#L31) |
1619
+ | <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.2/sdk/utils/src/logging/logger.ts#L27) |
1620
+ | <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.2/sdk/utils/src/logging/logger.ts#L29) |
1627
1621
 
1628
1622
  ***
1629
1623
 
1630
1624
  #### LoggerOptions
1631
1625
 
1632
- Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/logging/logger.ts#L12)
1626
+ Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/logging/logger.ts#L12)
1633
1627
 
1634
1628
  Configuration options for the logger
1635
1629
  LoggerOptions
@@ -1638,14 +1632,14 @@ Configuration options for the logger
1638
1632
 
1639
1633
  | Property | Type | Description | Defined in |
1640
1634
  | ------ | ------ | ------ | ------ |
1641
- | <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.1/sdk/utils/src/logging/logger.ts#L14) |
1642
- | <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.1/sdk/utils/src/logging/logger.ts#L16) |
1635
+ | <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.2/sdk/utils/src/logging/logger.ts#L14) |
1636
+ | <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.2/sdk/utils/src/logging/logger.ts#L16) |
1643
1637
 
1644
1638
  ***
1645
1639
 
1646
1640
  #### SpinnerOptions\<R\>
1647
1641
 
1648
- Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/terminal/spinner.ts#L25)
1642
+ Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/terminal/spinner.ts#L25)
1649
1643
 
1650
1644
  Options for configuring the spinner behavior
1651
1645
 
@@ -1659,147 +1653,37 @@ Options for configuring the spinner behavior
1659
1653
 
1660
1654
  | Property | Type | Description | Defined in |
1661
1655
  | ------ | ------ | ------ | ------ |
1662
- | <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.1/sdk/utils/src/terminal/spinner.ts#L27) |
1663
- | <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.1/sdk/utils/src/terminal/spinner.ts#L31) |
1664
- | <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.1/sdk/utils/src/terminal/spinner.ts#L29) |
1656
+ | <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.2/sdk/utils/src/terminal/spinner.ts#L27) |
1657
+ | <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.2/sdk/utils/src/terminal/spinner.ts#L31) |
1658
+ | <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.2/sdk/utils/src/terminal/spinner.ts#L29) |
1665
1659
 
1666
1660
  ### Type Aliases
1667
1661
 
1668
- #### AccessToken
1669
-
1670
- > **AccessToken** = `string`
1671
-
1672
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/access-token.schema.ts#L22)
1673
-
1674
- Schema for validating both application and personal access tokens.
1675
- Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
1676
-
1677
- ***
1678
-
1679
- #### ApplicationAccessToken
1680
-
1681
- > **ApplicationAccessToken** = `string`
1682
-
1683
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/access-token.schema.ts#L8)
1684
-
1685
- Schema for validating application access tokens.
1686
- Application access tokens start with 'sm_aat_' prefix.
1687
-
1688
- ***
1689
-
1690
1662
  #### DotEnv
1691
1663
 
1692
- > **DotEnv** = `object`
1664
+ > **DotEnv** = `z.infer`\<*typeof* [`DotEnvSchema`](#dotenvschema)\>
1693
1665
 
1694
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:101](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L101)
1666
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:101](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/validation/dot-env.schema.ts#L101)
1695
1667
 
1696
1668
  Type definition for the environment variables schema.
1697
1669
 
1698
- ##### Type declaration
1699
-
1700
- | Name | Type | Description | Defined in |
1701
- | ------ | ------ | ------ | ------ |
1702
- | <a id="settlemint_access_token"></a> `SETTLEMINT_ACCESS_TOKEN?` | `string` | Application access token for authenticating with SettleMint services | [sdk/utils/src/validation/dot-env.schema.ts:16](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L16) |
1703
- | <a id="settlemint_accessible_private_key"></a> `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY?` | `string` | Unique name of the accessible private key | [sdk/utils/src/validation/dot-env.schema.ts:65](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L65) |
1704
- | <a id="settlemint_application"></a> `SETTLEMINT_APPLICATION?` | `string` | Unique name of the application | [sdk/utils/src/validation/dot-env.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L22) |
1705
- | <a id="settlemint_blockchain_network"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK?` | `string` | Unique name of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:24](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L24) |
1706
- | <a id="settlemint_blockchain_network_chain_id"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID?` | `string` | Chain ID of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:26](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L26) |
1707
- | <a id="settlemint_blockchain_node"></a> `SETTLEMINT_BLOCKCHAIN_NODE?` | `string` | Unique name of the blockchain node (should have a private key for signing transactions) | [sdk/utils/src/validation/dot-env.schema.ts:28](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L28) |
1708
- | <a id="settlemint_blockchain_node_json_rpc_endpoint"></a> `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node | [sdk/utils/src/validation/dot-env.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L30) |
1709
- | <a id="settlemint_blockchain_node_or_load_balancer"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER?` | `string` | Unique name of the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:32](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L32) |
1710
- | <a id="settlemint_blockchain_node_or_load_balancer_json_rpc_endpoint"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L34) |
1711
- | <a id="settlemint_blockscout"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:87](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L87) |
1712
- | <a id="settlemint_blockscout_graphql_endpoint"></a> `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT?` | `string` | GraphQL endpoint URL for Blockscout | [sdk/utils/src/validation/dot-env.schema.ts:89](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L89) |
1713
- | <a id="settlemint_blockscout_ui_endpoint"></a> `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT?` | `string` | UI endpoint URL for Blockscout | [sdk/utils/src/validation/dot-env.schema.ts:91](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L91) |
1714
- | <a id="settlemint_custom_deployment"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT?` | `string` | Unique name of the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:83](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L83) |
1715
- | <a id="settlemint_custom_deployment_endpoint"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT?` | `string` | Endpoint URL for the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:85](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L85) |
1716
- | <a id="settlemint_hasura"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:36](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L36) |
1717
- | <a id="settlemint_hasura_admin_secret"></a> `SETTLEMINT_HASURA_ADMIN_SECRET?` | `string` | Admin secret for authenticating with Hasura | [sdk/utils/src/validation/dot-env.schema.ts:40](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L40) |
1718
- | <a id="settlemint_hasura_database_url"></a> `SETTLEMINT_HASURA_DATABASE_URL?` | `string` | Database connection URL for Hasura | [sdk/utils/src/validation/dot-env.schema.ts:42](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L42) |
1719
- | <a id="settlemint_hasura_endpoint"></a> `SETTLEMINT_HASURA_ENDPOINT?` | `string` | Endpoint URL for the Hasura GraphQL API | [sdk/utils/src/validation/dot-env.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L38) |
1720
- | <a id="settlemint_hd_private_key"></a> `SETTLEMINT_HD_PRIVATE_KEY?` | `string` | Unique name of the HD private key | [sdk/utils/src/validation/dot-env.schema.ts:61](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L61) |
1721
- | <a id="settlemint_hd_private_key_forwarder_address"></a> `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS?` | `string` | Address of the HD private key forwarder | [sdk/utils/src/validation/dot-env.schema.ts:63](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L63) |
1722
- | <a id="settlemint_instance"></a> `SETTLEMINT_INSTANCE` | `string` | Base URL of the SettleMint platform instance | [sdk/utils/src/validation/dot-env.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L14) |
1723
- | <a id="settlemint_ipfs"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:75](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L75) |
1724
- | <a id="settlemint_ipfs_api_endpoint"></a> `SETTLEMINT_IPFS_API_ENDPOINT?` | `string` | API endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:77](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L77) |
1725
- | <a id="settlemint_ipfs_gateway_endpoint"></a> `SETTLEMINT_IPFS_GATEWAY_ENDPOINT?` | `string` | Gateway endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:81](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L81) |
1726
- | <a id="settlemint_ipfs_pinning_endpoint"></a> `SETTLEMINT_IPFS_PINNING_ENDPOINT?` | `string` | Pinning service endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:79](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L79) |
1727
- | <a id="settlemint_log_level"></a> `SETTLEMINT_LOG_LEVEL` | `"error"` \| `"info"` \| `"warn"` \| `"debug"` \| `"none"` | The log level to use | [sdk/utils/src/validation/dot-env.schema.ts:95](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L95) |
1728
- | <a id="settlemint_minio"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:67](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L67) |
1729
- | <a id="settlemint_minio_access_key"></a> `SETTLEMINT_MINIO_ACCESS_KEY?` | `string` | Access key for MinIO authentication | [sdk/utils/src/validation/dot-env.schema.ts:71](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L71) |
1730
- | <a id="settlemint_minio_endpoint"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:69](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L69) |
1731
- | <a id="settlemint_minio_secret_key"></a> `SETTLEMINT_MINIO_SECRET_KEY?` | `string` | Secret key for MinIO authentication | [sdk/utils/src/validation/dot-env.schema.ts:73](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L73) |
1732
- | <a id="settlemint_new_project_name"></a> `SETTLEMINT_NEW_PROJECT_NAME?` | `string` | Name of the new project being created | [sdk/utils/src/validation/dot-env.schema.ts:93](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L93) |
1733
- | <a id="settlemint_portal"></a> `SETTLEMINT_PORTAL?` | `string` | Unique name of the Smart Contract Portal instance | [sdk/utils/src/validation/dot-env.schema.ts:53](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L53) |
1734
- | <a id="settlemint_portal_graphql_endpoint"></a> `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT?` | `string` | GraphQL endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L55) |
1735
- | <a id="settlemint_portal_rest_endpoint"></a> `SETTLEMINT_PORTAL_REST_ENDPOINT?` | `string` | REST endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:57](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L57) |
1736
- | <a id="settlemint_portal_ws_endpoint"></a> `SETTLEMINT_PORTAL_WS_ENDPOINT?` | `string` | WebSocket endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:59](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L59) |
1737
- | <a id="settlemint_thegraph"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:44](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L44) |
1738
- | <a id="settlemint_thegraph_default_subgraph"></a> `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH?` | `string` | Default The Graph subgraph to use | [sdk/utils/src/validation/dot-env.schema.ts:51](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L51) |
1739
- | <a id="settlemint_thegraph_subgraphs_endpoints"></a> `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS?` | `string`[] | Array of endpoint URLs for The Graph subgraphs | [sdk/utils/src/validation/dot-env.schema.ts:46](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L46) |
1740
- | <a id="settlemint_workspace"></a> `SETTLEMINT_WORKSPACE?` | `string` | Unique name of the workspace | [sdk/utils/src/validation/dot-env.schema.ts:20](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L20) |
1741
-
1742
1670
  ***
1743
1671
 
1744
1672
  #### DotEnvPartial
1745
1673
 
1746
- > **DotEnvPartial** = `object`
1674
+ > **DotEnvPartial** = `z.infer`\<*typeof* [`DotEnvSchemaPartial`](#dotenvschemapartial)\>
1747
1675
 
1748
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:112](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L112)
1676
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:112](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/validation/dot-env.schema.ts#L112)
1749
1677
 
1750
1678
  Type definition for the partial environment variables schema.
1751
1679
 
1752
- ##### Type declaration
1753
-
1754
- | Name | Type | Description | Defined in |
1755
- | ------ | ------ | ------ | ------ |
1756
- | <a id="settlemint_access_token-1"></a> `SETTLEMINT_ACCESS_TOKEN?` | `string` | Application access token for authenticating with SettleMint services | [sdk/utils/src/validation/dot-env.schema.ts:16](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L16) |
1757
- | <a id="settlemint_accessible_private_key-1"></a> `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY?` | `string` | Unique name of the accessible private key | [sdk/utils/src/validation/dot-env.schema.ts:65](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L65) |
1758
- | <a id="settlemint_application-1"></a> `SETTLEMINT_APPLICATION?` | `string` | Unique name of the application | [sdk/utils/src/validation/dot-env.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L22) |
1759
- | <a id="settlemint_blockchain_network-1"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK?` | `string` | Unique name of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:24](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L24) |
1760
- | <a id="settlemint_blockchain_network_chain_id-1"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID?` | `string` | Chain ID of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:26](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L26) |
1761
- | <a id="settlemint_blockchain_node-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE?` | `string` | Unique name of the blockchain node (should have a private key for signing transactions) | [sdk/utils/src/validation/dot-env.schema.ts:28](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L28) |
1762
- | <a id="settlemint_blockchain_node_json_rpc_endpoint-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node | [sdk/utils/src/validation/dot-env.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L30) |
1763
- | <a id="settlemint_blockchain_node_or_load_balancer-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER?` | `string` | Unique name of the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:32](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L32) |
1764
- | <a id="settlemint_blockchain_node_or_load_balancer_json_rpc_endpoint-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L34) |
1765
- | <a id="settlemint_blockscout-1"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:87](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L87) |
1766
- | <a id="settlemint_blockscout_graphql_endpoint-1"></a> `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT?` | `string` | GraphQL endpoint URL for Blockscout | [sdk/utils/src/validation/dot-env.schema.ts:89](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L89) |
1767
- | <a id="settlemint_blockscout_ui_endpoint-1"></a> `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT?` | `string` | UI endpoint URL for Blockscout | [sdk/utils/src/validation/dot-env.schema.ts:91](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L91) |
1768
- | <a id="settlemint_custom_deployment-1"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT?` | `string` | Unique name of the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:83](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L83) |
1769
- | <a id="settlemint_custom_deployment_endpoint-1"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT?` | `string` | Endpoint URL for the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:85](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L85) |
1770
- | <a id="settlemint_hasura-1"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:36](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L36) |
1771
- | <a id="settlemint_hasura_admin_secret-1"></a> `SETTLEMINT_HASURA_ADMIN_SECRET?` | `string` | Admin secret for authenticating with Hasura | [sdk/utils/src/validation/dot-env.schema.ts:40](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L40) |
1772
- | <a id="settlemint_hasura_database_url-1"></a> `SETTLEMINT_HASURA_DATABASE_URL?` | `string` | Database connection URL for Hasura | [sdk/utils/src/validation/dot-env.schema.ts:42](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L42) |
1773
- | <a id="settlemint_hasura_endpoint-1"></a> `SETTLEMINT_HASURA_ENDPOINT?` | `string` | Endpoint URL for the Hasura GraphQL API | [sdk/utils/src/validation/dot-env.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L38) |
1774
- | <a id="settlemint_hd_private_key-1"></a> `SETTLEMINT_HD_PRIVATE_KEY?` | `string` | Unique name of the HD private key | [sdk/utils/src/validation/dot-env.schema.ts:61](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L61) |
1775
- | <a id="settlemint_hd_private_key_forwarder_address-1"></a> `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS?` | `string` | Address of the HD private key forwarder | [sdk/utils/src/validation/dot-env.schema.ts:63](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L63) |
1776
- | <a id="settlemint_instance-1"></a> `SETTLEMINT_INSTANCE?` | `string` | Base URL of the SettleMint platform instance | [sdk/utils/src/validation/dot-env.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L14) |
1777
- | <a id="settlemint_ipfs-1"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:75](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L75) |
1778
- | <a id="settlemint_ipfs_api_endpoint-1"></a> `SETTLEMINT_IPFS_API_ENDPOINT?` | `string` | API endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:77](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L77) |
1779
- | <a id="settlemint_ipfs_gateway_endpoint-1"></a> `SETTLEMINT_IPFS_GATEWAY_ENDPOINT?` | `string` | Gateway endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:81](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L81) |
1780
- | <a id="settlemint_ipfs_pinning_endpoint-1"></a> `SETTLEMINT_IPFS_PINNING_ENDPOINT?` | `string` | Pinning service endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:79](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L79) |
1781
- | <a id="settlemint_log_level-1"></a> `SETTLEMINT_LOG_LEVEL?` | `"error"` \| `"info"` \| `"warn"` \| `"debug"` \| `"none"` | The log level to use | [sdk/utils/src/validation/dot-env.schema.ts:95](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L95) |
1782
- | <a id="settlemint_minio-1"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:67](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L67) |
1783
- | <a id="settlemint_minio_access_key-1"></a> `SETTLEMINT_MINIO_ACCESS_KEY?` | `string` | Access key for MinIO authentication | [sdk/utils/src/validation/dot-env.schema.ts:71](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L71) |
1784
- | <a id="settlemint_minio_endpoint-1"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:69](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L69) |
1785
- | <a id="settlemint_minio_secret_key-1"></a> `SETTLEMINT_MINIO_SECRET_KEY?` | `string` | Secret key for MinIO authentication | [sdk/utils/src/validation/dot-env.schema.ts:73](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L73) |
1786
- | <a id="settlemint_new_project_name-1"></a> `SETTLEMINT_NEW_PROJECT_NAME?` | `string` | Name of the new project being created | [sdk/utils/src/validation/dot-env.schema.ts:93](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L93) |
1787
- | <a id="settlemint_portal-1"></a> `SETTLEMINT_PORTAL?` | `string` | Unique name of the Smart Contract Portal instance | [sdk/utils/src/validation/dot-env.schema.ts:53](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L53) |
1788
- | <a id="settlemint_portal_graphql_endpoint-1"></a> `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT?` | `string` | GraphQL endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L55) |
1789
- | <a id="settlemint_portal_rest_endpoint-1"></a> `SETTLEMINT_PORTAL_REST_ENDPOINT?` | `string` | REST endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:57](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L57) |
1790
- | <a id="settlemint_portal_ws_endpoint-1"></a> `SETTLEMINT_PORTAL_WS_ENDPOINT?` | `string` | WebSocket endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:59](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L59) |
1791
- | <a id="settlemint_thegraph-1"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:44](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L44) |
1792
- | <a id="settlemint_thegraph_default_subgraph-1"></a> `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH?` | `string` | Default The Graph subgraph to use | [sdk/utils/src/validation/dot-env.schema.ts:51](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L51) |
1793
- | <a id="settlemint_thegraph_subgraphs_endpoints-1"></a> `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS?` | `string`[] | Array of endpoint URLs for The Graph subgraphs | [sdk/utils/src/validation/dot-env.schema.ts:46](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L46) |
1794
- | <a id="settlemint_workspace-1"></a> `SETTLEMINT_WORKSPACE?` | `string` | Unique name of the workspace | [sdk/utils/src/validation/dot-env.schema.ts:20](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L20) |
1795
-
1796
1680
  ***
1797
1681
 
1798
1682
  #### Id
1799
1683
 
1800
- > **Id** = `string`
1684
+ > **Id** = `z.infer`\<*typeof* [`IdSchema`](#idschema)\>
1801
1685
 
1802
- Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/id.schema.ts#L30)
1686
+ Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/validation/id.schema.ts#L30)
1803
1687
 
1804
1688
  Type definition for database IDs, inferred from IdSchema.
1805
1689
  Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
@@ -1810,100 +1694,17 @@ Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
1810
1694
 
1811
1695
  > **LogLevel** = `"debug"` \| `"info"` \| `"warn"` \| `"error"` \| `"none"`
1812
1696
 
1813
- Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/logging/logger.ts#L6)
1697
+ Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/logging/logger.ts#L6)
1814
1698
 
1815
1699
  Log levels supported by the logger
1816
1700
 
1817
- ***
1818
-
1819
- #### PersonalAccessToken
1820
-
1821
- > **PersonalAccessToken** = `string`
1822
-
1823
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/access-token.schema.ts#L15)
1824
-
1825
- Schema for validating personal access tokens.
1826
- Personal access tokens start with 'sm_pat_' prefix.
1827
-
1828
- ***
1829
-
1830
- #### Url
1831
-
1832
- > **Url** = `string`
1833
-
1834
- Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/url.schema.ts#L18)
1835
-
1836
- Schema for validating URLs.
1837
-
1838
- ##### Example
1839
-
1840
- ```ts
1841
- import { UrlSchema } from "@settlemint/sdk-utils/validation";
1842
-
1843
- // Validate a URL
1844
- const isValidUrl = UrlSchema.safeParse("https://console.settlemint.com").success;
1845
- // true
1846
-
1847
- // Invalid URLs will fail validation
1848
- const isInvalidUrl = UrlSchema.safeParse("not-a-url").success;
1849
- // false
1850
- ```
1851
-
1852
- ***
1853
-
1854
- #### UrlOrPath
1855
-
1856
- > **UrlOrPath** = `string`
1857
-
1858
- Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/url.schema.ts#L55)
1859
-
1860
- Schema that accepts either a full URL or a URL path.
1861
-
1862
- ##### Example
1863
-
1864
- ```ts
1865
- import { UrlOrPathSchema } from "@settlemint/sdk-utils/validation";
1866
-
1867
- // Validate a URL
1868
- const isValidUrl = UrlOrPathSchema.safeParse("https://console.settlemint.com").success;
1869
- // true
1870
-
1871
- // Validate a path
1872
- const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
1873
- // true
1874
- ```
1875
-
1876
- ***
1877
-
1878
- #### UrlPath
1879
-
1880
- > **UrlPath** = `string`
1881
-
1882
- Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/url.schema.ts#L38)
1883
-
1884
- Schema for validating URL paths.
1885
-
1886
- ##### Example
1887
-
1888
- ```ts
1889
- import { UrlPathSchema } from "@settlemint/sdk-utils/validation";
1890
-
1891
- // Validate a URL path
1892
- const isValidPath = UrlPathSchema.safeParse("/api/v1/users").success;
1893
- // true
1894
-
1895
- // Invalid paths will fail validation
1896
- const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
1897
- // false
1898
- ```
1899
-
1900
1701
  ### Variables
1901
1702
 
1902
1703
  #### AccessTokenSchema
1903
1704
 
1904
- > `const` **AccessTokenSchema**: `ZodString`\<[`AccessToken`](#accesstoken)\>
1705
+ > `const` **AccessTokenSchema**: `ZodString`
1905
1706
 
1906
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/access-token.schema.ts#L21)
1707
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/validation/access-token.schema.ts#L21)
1907
1708
 
1908
1709
  Schema for validating both application and personal access tokens.
1909
1710
  Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
@@ -1912,9 +1713,9 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
1912
1713
 
1913
1714
  #### ApplicationAccessTokenSchema
1914
1715
 
1915
- > `const` **ApplicationAccessTokenSchema**: `ZodString`\<[`ApplicationAccessToken`](#applicationaccesstoken)\>
1716
+ > `const` **ApplicationAccessTokenSchema**: `ZodString`
1916
1717
 
1917
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/access-token.schema.ts#L7)
1718
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/validation/access-token.schema.ts#L7)
1918
1719
 
1919
1720
  Schema for validating application access tokens.
1920
1721
  Application access tokens start with 'sm_aat_' prefix.
@@ -1923,9 +1724,9 @@ Application access tokens start with 'sm_aat_' prefix.
1923
1724
 
1924
1725
  #### DotEnvSchema
1925
1726
 
1926
- > `const` **DotEnvSchema**: `ZodObject`\<[`DotEnv`](#dotenv)\>
1727
+ > `const` **DotEnvSchema**: `ZodObject`\<\{ `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`\<`ZodString`\>; `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`\>
1927
1728
 
1928
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:12](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L12)
1729
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:12](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/validation/dot-env.schema.ts#L12)
1929
1730
 
1930
1731
  Schema for validating environment variables used by the SettleMint SDK.
1931
1732
  Defines validation rules and types for configuration values like URLs,
@@ -1935,9 +1736,9 @@ access tokens, workspace names, and service endpoints.
1935
1736
 
1936
1737
  #### DotEnvSchemaPartial
1937
1738
 
1938
- > `const` **DotEnvSchemaPartial**: `ZodObject`\<[`DotEnvPartial`](#dotenvpartial)\>
1739
+ > `const` **DotEnvSchemaPartial**: `ZodObject`\<\{ `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`\<`ZodString`\>\>; `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`\>
1939
1740
 
1940
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:107](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L107)
1741
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:107](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/validation/dot-env.schema.ts#L107)
1941
1742
 
1942
1743
  Partial version of the environment variables schema where all fields are optional.
1943
1744
  Useful for validating incomplete configurations during development or build time.
@@ -1946,9 +1747,9 @@ Useful for validating incomplete configurations during development or build time
1946
1747
 
1947
1748
  #### IdSchema
1948
1749
 
1949
- > `const` **IdSchema**: `ZodUnion`\<[`Id`](#id)\>
1750
+ > `const` **IdSchema**: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>
1950
1751
 
1951
- Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/id.schema.ts#L17)
1752
+ Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/validation/id.schema.ts#L17)
1952
1753
 
1953
1754
  Schema for validating database IDs. Accepts both PostgreSQL UUIDs and MongoDB ObjectIDs.
1954
1755
  PostgreSQL UUIDs are 32 hexadecimal characters with hyphens (e.g. 123e4567-e89b-12d3-a456-426614174000).
@@ -1970,9 +1771,9 @@ const isValidObjectId = IdSchema.safeParse("507f1f77bcf86cd799439011").success;
1970
1771
 
1971
1772
  #### PersonalAccessTokenSchema
1972
1773
 
1973
- > `const` **PersonalAccessTokenSchema**: `ZodString`\<[`PersonalAccessToken`](#personalaccesstoken)\>
1774
+ > `const` **PersonalAccessTokenSchema**: `ZodString`
1974
1775
 
1975
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/access-token.schema.ts#L14)
1776
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/validation/access-token.schema.ts#L14)
1976
1777
 
1977
1778
  Schema for validating personal access tokens.
1978
1779
  Personal access tokens start with 'sm_pat_' prefix.
@@ -1983,7 +1784,7 @@ Personal access tokens start with 'sm_pat_' prefix.
1983
1784
 
1984
1785
  > `const` **runsInBrowser**: `boolean` = `isBrowser`
1985
1786
 
1986
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/runtime/ensure-server.ts#L40)
1787
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/runtime/ensure-server.ts#L40)
1987
1788
 
1988
1789
  Boolean indicating if code is currently running in a browser environment
1989
1790
 
@@ -1993,7 +1794,7 @@ Boolean indicating if code is currently running in a browser environment
1993
1794
 
1994
1795
  > `const` **runsOnServer**: `boolean` = `!isBrowser`
1995
1796
 
1996
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/runtime/ensure-server.ts#L45)
1797
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/runtime/ensure-server.ts#L45)
1997
1798
 
1998
1799
  Boolean indicating if code is currently running in a server environment
1999
1800
 
@@ -2003,7 +1804,7 @@ Boolean indicating if code is currently running in a server environment
2003
1804
 
2004
1805
  > `const` **UniqueNameSchema**: `ZodString`
2005
1806
 
2006
- Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/unique-name.schema.ts#L19)
1807
+ Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/validation/unique-name.schema.ts#L19)
2007
1808
 
2008
1809
  Schema for validating unique names used across the SettleMint platform.
2009
1810
  Only accepts lowercase alphanumeric characters and hyphens.
@@ -2027,9 +1828,9 @@ const isInvalidName = UniqueNameSchema.safeParse("My Workspace!").success;
2027
1828
 
2028
1829
  #### UrlOrPathSchema
2029
1830
 
2030
- > `const` **UrlOrPathSchema**: `ZodUnion`\<[`UrlOrPath`](#urlorpath)\>
1831
+ > `const` **UrlOrPathSchema**: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>
2031
1832
 
2032
- Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/url.schema.ts#L54)
1833
+ Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/validation/url.schema.ts#L54)
2033
1834
 
2034
1835
  Schema that accepts either a full URL or a URL path.
2035
1836
 
@@ -2051,9 +1852,9 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
2051
1852
 
2052
1853
  #### UrlPathSchema
2053
1854
 
2054
- > `const` **UrlPathSchema**: `ZodString`\<[`UrlPath`](#urlpath)\>
1855
+ > `const` **UrlPathSchema**: `ZodString`
2055
1856
 
2056
- Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/url.schema.ts#L34)
1857
+ Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/validation/url.schema.ts#L34)
2057
1858
 
2058
1859
  Schema for validating URL paths.
2059
1860
 
@@ -2075,9 +1876,9 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
2075
1876
 
2076
1877
  #### UrlSchema
2077
1878
 
2078
- > `const` **UrlSchema**: `ZodString`\<[`Url`](#url)\>
1879
+ > `const` **UrlSchema**: `ZodString`
2079
1880
 
2080
- Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/url.schema.ts#L17)
1881
+ Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/utils/src/validation/url.schema.ts#L17)
2081
1882
 
2082
1883
  Schema for validating URLs.
2083
1884