@settlemint/sdk-utils 2.1.1 → 2.1.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 (2) hide show
  1. package/README.md +270 -81
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -75,10 +75,16 @@
75
75
  - [LoggerOptions](#loggeroptions)
76
76
  - [SpinnerOptions\<R\>](#spinneroptionsr)
77
77
  - [Type Aliases](#type-aliases)
78
+ - [AccessToken](#accesstoken)
79
+ - [ApplicationAccessToken](#applicationaccesstoken)
78
80
  - [DotEnv](#dotenv)
79
81
  - [DotEnvPartial](#dotenvpartial)
80
82
  - [Id](#id)
81
83
  - [LogLevel](#loglevel)
84
+ - [PersonalAccessToken](#personalaccesstoken)
85
+ - [Url](#url)
86
+ - [UrlOrPath](#urlorpath)
87
+ - [UrlPath](#urlpath)
82
88
  - [Variables](#variables)
83
89
  - [AccessTokenSchema](#accesstokenschema)
84
90
  - [ApplicationAccessTokenSchema](#applicationaccesstokenschema)
@@ -107,7 +113,7 @@ The SettleMint Utils SDK provides a collection of shared utilities and helper fu
107
113
 
108
114
  > **ascii**(): `void`
109
115
 
110
- Defined in: [sdk/utils/src/terminal/ascii.ts:13](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/ascii.ts#L13)
116
+ Defined in: [sdk/utils/src/terminal/ascii.ts:13](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/ascii.ts#L13)
111
117
 
112
118
  Prints the SettleMint ASCII art logo to the console in magenta color.
113
119
  Used for CLI branding and visual identification.
@@ -131,7 +137,7 @@ ascii();
131
137
 
132
138
  > **camelCaseToWords**(`s`): `string`
133
139
 
134
- Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/string.ts#L29)
140
+ Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/string.ts#L29)
135
141
 
136
142
  Converts a camelCase string to a human-readable string.
137
143
 
@@ -162,7 +168,7 @@ const words = camelCaseToWords("camelCaseString");
162
168
 
163
169
  > **cancel**(`msg`): `never`
164
170
 
165
- Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/cancel.ts#L23)
171
+ Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/cancel.ts#L23)
166
172
 
167
173
  Displays an error message in red inverse text and throws a CancelError.
168
174
  Used to terminate execution with a visible error message.
@@ -195,7 +201,7 @@ cancel("An error occurred");
195
201
 
196
202
  > **capitalizeFirstLetter**(`val`): `string`
197
203
 
198
- Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/string.ts#L13)
204
+ Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/string.ts#L13)
199
205
 
200
206
  Capitalizes the first letter of a string.
201
207
 
@@ -226,7 +232,7 @@ const capitalized = capitalizeFirstLetter("hello");
226
232
 
227
233
  > **createLogger**(`options`): [`Logger`](#logger)
228
234
 
229
- Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/logging/logger.ts#L50)
235
+ Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/logging/logger.ts#L50)
230
236
 
231
237
  Creates a simple logger with configurable log level
232
238
 
@@ -259,7 +265,7 @@ logger.error('Operation failed', new Error('Connection timeout'));
259
265
 
260
266
  > **emptyDir**(`dir`): `Promise`\<`void`\>
261
267
 
262
- Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/package-manager/download-and-extract.ts#L45)
268
+ Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/package-manager/download-and-extract.ts#L45)
263
269
 
264
270
  Removes all contents of a directory except the .git folder
265
271
 
@@ -287,7 +293,7 @@ await emptyDir("/path/to/dir"); // Removes all contents except .git
287
293
 
288
294
  > **ensureBrowser**(): `void`
289
295
 
290
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/runtime/ensure-server.ts#L31)
296
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/runtime/ensure-server.ts#L31)
291
297
 
292
298
  Ensures that code is running in a browser environment and not on the server.
293
299
 
@@ -314,7 +320,7 @@ ensureBrowser();
314
320
 
315
321
  > **ensureServer**(): `void`
316
322
 
317
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/runtime/ensure-server.ts#L13)
323
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/runtime/ensure-server.ts#L13)
318
324
 
319
325
  Ensures that code is running on the server and not in a browser environment.
320
326
 
@@ -341,7 +347,7 @@ ensureServer();
341
347
 
342
348
  > **executeCommand**(`command`, `args`, `options?`): `Promise`\<`string`[]\>
343
349
 
344
- Defined in: [sdk/utils/src/terminal/execute-command.ts:31](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/execute-command.ts#L31)
350
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:31](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/execute-command.ts#L31)
345
351
 
346
352
  Executes a command with the given arguments in a child process.
347
353
  Pipes stdin to the child process and captures stdout/stderr output.
@@ -383,7 +389,7 @@ await executeCommand("npm", ["install"], { silent: true });
383
389
 
384
390
  > **exists**(`path`): `Promise`\<`boolean`\>
385
391
 
386
- Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/filesystem/exists.ts#L17)
392
+ Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/filesystem/exists.ts#L17)
387
393
 
388
394
  Checks if a file or directory exists at the given path
389
395
 
@@ -416,7 +422,7 @@ if (await exists('/path/to/file.txt')) {
416
422
 
417
423
  > **fetchWithRetry**(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Response`\>
418
424
 
419
- Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/http/fetch-with-retry.ts#L18)
425
+ Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/http/fetch-with-retry.ts#L18)
420
426
 
421
427
  Retry an HTTP request with exponential backoff and jitter.
422
428
  Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
@@ -454,7 +460,7 @@ const response = await fetchWithRetry("https://api.example.com/data");
454
460
 
455
461
  > **findMonoRepoPackages**(`projectDir`): `Promise`\<`string`[]\>
456
462
 
457
- Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/filesystem/mono-repo.ts#L59)
463
+ Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/filesystem/mono-repo.ts#L59)
458
464
 
459
465
  Finds all packages in a monorepo
460
466
 
@@ -485,7 +491,7 @@ console.log(packages); // Output: ["/path/to/your/project/packages/core", "/path
485
491
 
486
492
  > **findMonoRepoRoot**(`startDir`): `Promise`\<`null` \| `string`\>
487
493
 
488
- Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/filesystem/mono-repo.ts#L19)
494
+ Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/filesystem/mono-repo.ts#L19)
489
495
 
490
496
  Finds the root directory of a monorepo
491
497
 
@@ -516,7 +522,7 @@ console.log(root); // Output: /path/to/your/project/packages/core
516
522
 
517
523
  > **formatTargetDir**(`targetDir`): `string`
518
524
 
519
- Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/package-manager/download-and-extract.ts#L15)
525
+ Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/package-manager/download-and-extract.ts#L15)
520
526
 
521
527
  Formats a directory path by removing trailing slashes and whitespace
522
528
 
@@ -546,7 +552,7 @@ const formatted = formatTargetDir("/path/to/dir/ "); // "/path/to/dir"
546
552
 
547
553
  > **getPackageManager**(`targetDir?`): `Promise`\<`AgentName`\>
548
554
 
549
- Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/package-manager/get-package-manager.ts#L15)
555
+ Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/package-manager/get-package-manager.ts#L15)
550
556
 
551
557
  Detects the package manager used in the current project
552
558
 
@@ -577,7 +583,7 @@ console.log(`Using ${packageManager}`);
577
583
 
578
584
  > **getPackageManagerExecutable**(`targetDir?`): `Promise`\<\{ `args`: `string`[]; `command`: `string`; \}\>
579
585
 
580
- Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
586
+ Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
581
587
 
582
588
  Retrieves the executable command and arguments for the package manager
583
589
 
@@ -608,7 +614,7 @@ console.log(`Using ${command} with args: ${args.join(" ")}`);
608
614
 
609
615
  > **graphqlFetchWithRetry**\<`Data`\>(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Data`\>
610
616
 
611
- Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
617
+ Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
612
618
 
613
619
  Executes a GraphQL request with automatic retries using exponential backoff and jitter.
614
620
  Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
@@ -667,7 +673,7 @@ const data = await graphqlFetchWithRetry<{ user: { id: string } }>(
667
673
 
668
674
  > **installDependencies**(`pkgs`, `cwd?`): `Promise`\<`void`\>
669
675
 
670
- Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/package-manager/install-dependencies.ts#L20)
676
+ Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/package-manager/install-dependencies.ts#L20)
671
677
 
672
678
  Installs one or more packages as dependencies using the detected package manager
673
679
 
@@ -706,7 +712,7 @@ await installDependencies(["express", "cors"]);
706
712
 
707
713
  > **intro**(`msg`): `void`
708
714
 
709
- Defined in: [sdk/utils/src/terminal/intro.ts:15](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/intro.ts#L15)
715
+ Defined in: [sdk/utils/src/terminal/intro.ts:15](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/intro.ts#L15)
710
716
 
711
717
  Displays an introductory message in magenta text with padding.
712
718
  Any sensitive tokens in the message are masked before display.
@@ -736,7 +742,7 @@ intro("Starting deployment...");
736
742
 
737
743
  > **isEmpty**(`path`): `Promise`\<`boolean`\>
738
744
 
739
- Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/package-manager/download-and-extract.ts#L31)
745
+ Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/package-manager/download-and-extract.ts#L31)
740
746
 
741
747
  Checks if a directory is empty or contains only a .git folder
742
748
 
@@ -768,7 +774,7 @@ if (await isEmpty("/path/to/dir")) {
768
774
 
769
775
  > **isPackageInstalled**(`name`, `path?`): `Promise`\<`boolean`\>
770
776
 
771
- Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/package-manager/is-package-installed.ts#L17)
777
+ Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/package-manager/is-package-installed.ts#L17)
772
778
 
773
779
  Checks if a package is installed in the project's dependencies, devDependencies, or peerDependencies.
774
780
 
@@ -804,7 +810,7 @@ console.log(`@settlemint/sdk-utils is installed: ${isInstalled}`);
804
810
 
805
811
  > **list**(`title`, `items`): `void`
806
812
 
807
- Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/list.ts#L23)
813
+ Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/list.ts#L23)
808
814
 
809
815
  Displays a list of items in a formatted manner, supporting nested items.
810
816
 
@@ -844,7 +850,7 @@ list("Providers", [
844
850
 
845
851
  > **loadEnv**\<`T`\>(`validateEnv`, `prod`, `path`): `Promise`\<`T` *extends* `true` ? `object` : `object`\>
846
852
 
847
- Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/environment/load-env.ts#L25)
853
+ Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/environment/load-env.ts#L25)
848
854
 
849
855
  Loads environment variables from .env files.
850
856
  To enable encryption with dotenvx (https://www.dotenvx.com/docs) run `bunx dotenvx encrypt`
@@ -892,7 +898,7 @@ const rawEnv = await loadEnv(false, false);
892
898
 
893
899
  > **maskTokens**(`output`): `string`
894
900
 
895
- Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/logging/mask-tokens.ts#L13)
901
+ Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/logging/mask-tokens.ts#L13)
896
902
 
897
903
  Masks sensitive SettleMint tokens in output text by replacing them with asterisks.
898
904
  Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).
@@ -924,7 +930,7 @@ const masked = maskTokens("Token: sm_pat_****"); // "Token: ***"
924
930
 
925
931
  > **note**(`message`, `level`): `void`
926
932
 
927
- Defined in: [sdk/utils/src/terminal/note.ts:20](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/note.ts#L20)
933
+ Defined in: [sdk/utils/src/terminal/note.ts:20](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/note.ts#L20)
928
934
 
929
935
  Displays a note message with optional warning level formatting.
930
936
  Regular notes are displayed in normal text, while warnings are shown in yellow.
@@ -959,7 +965,7 @@ note("Low disk space remaining", "warn");
959
965
 
960
966
  > **outro**(`msg`): `void`
961
967
 
962
- Defined in: [sdk/utils/src/terminal/outro.ts:15](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/outro.ts#L15)
968
+ Defined in: [sdk/utils/src/terminal/outro.ts:15](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/outro.ts#L15)
963
969
 
964
970
  Displays a closing message in green inverted text with padding.
965
971
  Any sensitive tokens in the message are masked before display.
@@ -989,7 +995,7 @@ outro("Deployment completed successfully!");
989
995
 
990
996
  > **projectRoot**(`fallbackToCwd`, `cwd?`): `Promise`\<`string`\>
991
997
 
992
- Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/filesystem/project-root.ts#L18)
998
+ Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/filesystem/project-root.ts#L18)
993
999
 
994
1000
  Finds the root directory of the current project by locating the nearest package.json file
995
1001
 
@@ -1026,7 +1032,7 @@ console.log(`Project root is at: ${rootDir}`);
1026
1032
 
1027
1033
  > **replaceUnderscoresAndHyphensWithSpaces**(`s`): `string`
1028
1034
 
1029
- Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/string.ts#L48)
1035
+ Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/string.ts#L48)
1030
1036
 
1031
1037
  Replaces underscores and hyphens with spaces.
1032
1038
 
@@ -1057,7 +1063,7 @@ const result = replaceUnderscoresAndHyphensWithSpaces("Already_Spaced-Second");
1057
1063
 
1058
1064
  > **requestLogger**(`logger`, `name`, `fn`): (...`args`) => `Promise`\<`Response`\>
1059
1065
 
1060
- Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/logging/request-logger.ts#L14)
1066
+ Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/logging/request-logger.ts#L14)
1061
1067
 
1062
1068
  Logs the request and duration of a fetch call (> 500ms is logged as warn, otherwise info)
1063
1069
 
@@ -1091,7 +1097,7 @@ The fetch function
1091
1097
 
1092
1098
  > **retryWhenFailed**\<`T`\>(`fn`, `maxRetries`, `initialSleepTime`, `stopOnError?`): `Promise`\<`T`\>
1093
1099
 
1094
- Defined in: [sdk/utils/src/retry.ts:14](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/retry.ts#L14)
1100
+ Defined in: [sdk/utils/src/retry.ts:14](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/retry.ts#L14)
1095
1101
 
1096
1102
  Retry a function when it fails.
1097
1103
 
@@ -1131,7 +1137,7 @@ const result = await retryWhenFailed(() => readFile("/path/to/file.txt"), 3, 1_0
1131
1137
 
1132
1138
  > **setName**(`name`, `path?`): `Promise`\<`void`\>
1133
1139
 
1134
- Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/package-manager/set-name.ts#L16)
1140
+ Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/package-manager/set-name.ts#L16)
1135
1141
 
1136
1142
  Sets the name field in the package.json file
1137
1143
 
@@ -1166,7 +1172,7 @@ await setName("my-new-project-name");
1166
1172
 
1167
1173
  > **spinner**\<`R`\>(`options`): `Promise`\<`R`\>
1168
1174
 
1169
- Defined in: [sdk/utils/src/terminal/spinner.ts:54](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/spinner.ts#L54)
1175
+ Defined in: [sdk/utils/src/terminal/spinner.ts:54](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/spinner.ts#L54)
1170
1176
 
1171
1177
  Displays a loading spinner while executing an async task.
1172
1178
  Shows progress with start/stop messages and handles errors.
@@ -1216,7 +1222,7 @@ const result = await spinner({
1216
1222
 
1217
1223
  > **table**(`title`, `data`): `void`
1218
1224
 
1219
- Defined in: [sdk/utils/src/terminal/table.ts:20](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/table.ts#L20)
1225
+ Defined in: [sdk/utils/src/terminal/table.ts:20](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/table.ts#L20)
1220
1226
 
1221
1227
  Displays data in a formatted table in the terminal.
1222
1228
 
@@ -1250,7 +1256,7 @@ table("My Table", data);
1250
1256
 
1251
1257
  > **truncate**(`value`, `maxLength`): `string`
1252
1258
 
1253
- Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/string.ts#L65)
1259
+ Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/string.ts#L65)
1254
1260
 
1255
1261
  Truncates a string to a maximum length and appends "..." if it is longer.
1256
1262
 
@@ -1282,7 +1288,7 @@ const truncated = truncate("Hello, world!", 10);
1282
1288
 
1283
1289
  > **tryParseJson**\<`T`\>(`value`, `defaultValue`): `null` \| `T`
1284
1290
 
1285
- Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/json.ts#L23)
1291
+ Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/json.ts#L23)
1286
1292
 
1287
1293
  Attempts to parse a JSON string into a typed value, returning a default value if parsing fails.
1288
1294
 
@@ -1329,7 +1335,7 @@ const invalid = tryParseJson<string[]>(
1329
1335
 
1330
1336
  > **validate**\<`T`\>(`schema`, `value`): `T`\[`"_output"`\]
1331
1337
 
1332
- Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/validate.ts#L16)
1338
+ Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/validate.ts#L16)
1333
1339
 
1334
1340
  Validates a value against a given Zod schema.
1335
1341
 
@@ -1370,7 +1376,7 @@ const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
1370
1376
 
1371
1377
  > **writeEnv**(`options`): `Promise`\<`void`\>
1372
1378
 
1373
- Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/environment/write-env.ts#L41)
1379
+ Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/environment/write-env.ts#L41)
1374
1380
 
1375
1381
  Writes environment variables to .env files across a project or monorepo
1376
1382
 
@@ -1422,7 +1428,7 @@ await writeEnv({
1422
1428
 
1423
1429
  #### CancelError
1424
1430
 
1425
- Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/cancel.ts#L8)
1431
+ Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/cancel.ts#L8)
1426
1432
 
1427
1433
  Error class used to indicate that the operation was cancelled.
1428
1434
  This error is used to signal that the operation should be aborted.
@@ -1435,7 +1441,7 @@ This error is used to signal that the operation should be aborted.
1435
1441
 
1436
1442
  #### SpinnerError
1437
1443
 
1438
- Defined in: [sdk/utils/src/terminal/spinner.ts:11](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/spinner.ts#L11)
1444
+ Defined in: [sdk/utils/src/terminal/spinner.ts:11](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/spinner.ts#L11)
1439
1445
 
1440
1446
  Error class used to indicate that the spinner operation failed.
1441
1447
  This error is used to signal that the operation should be aborted.
@@ -1448,7 +1454,7 @@ This error is used to signal that the operation should be aborted.
1448
1454
 
1449
1455
  #### ExecuteCommandOptions
1450
1456
 
1451
- Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/execute-command.ts#L7)
1457
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/execute-command.ts#L7)
1452
1458
 
1453
1459
  Options for executing a command, extending SpawnOptionsWithoutStdio
1454
1460
 
@@ -1460,13 +1466,13 @@ Options for executing a command, extending SpawnOptionsWithoutStdio
1460
1466
 
1461
1467
  | Property | Type | Description | Defined in |
1462
1468
  | ------ | ------ | ------ | ------ |
1463
- | <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.1.1/sdk/utils/src/terminal/execute-command.ts#L9) |
1469
+ | <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.1.2/sdk/utils/src/terminal/execute-command.ts#L9) |
1464
1470
 
1465
1471
  ***
1466
1472
 
1467
1473
  #### Logger
1468
1474
 
1469
- Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/logging/logger.ts#L23)
1475
+ Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/logging/logger.ts#L23)
1470
1476
 
1471
1477
  Simple logger interface with basic logging methods
1472
1478
  Logger
@@ -1475,16 +1481,16 @@ Simple logger interface with basic logging methods
1475
1481
 
1476
1482
  | Property | Type | Description | Defined in |
1477
1483
  | ------ | ------ | ------ | ------ |
1478
- | <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.1.1/sdk/utils/src/logging/logger.ts#L25) |
1479
- | <a id="error"></a> `error` | (`message`, ...`args`) => `void` | Log errors | [sdk/utils/src/logging/logger.ts:31](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/logging/logger.ts#L31) |
1480
- | <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.1.1/sdk/utils/src/logging/logger.ts#L27) |
1481
- | <a id="warn"></a> `warn` | (`message`, ...`args`) => `void` | Log warnings | [sdk/utils/src/logging/logger.ts:29](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/logging/logger.ts#L29) |
1484
+ | <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.1.2/sdk/utils/src/logging/logger.ts#L25) |
1485
+ | <a id="error"></a> `error` | (`message`, ...`args`) => `void` | Log errors | [sdk/utils/src/logging/logger.ts:31](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/logging/logger.ts#L31) |
1486
+ | <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.1.2/sdk/utils/src/logging/logger.ts#L27) |
1487
+ | <a id="warn"></a> `warn` | (`message`, ...`args`) => `void` | Log warnings | [sdk/utils/src/logging/logger.ts:29](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/logging/logger.ts#L29) |
1482
1488
 
1483
1489
  ***
1484
1490
 
1485
1491
  #### LoggerOptions
1486
1492
 
1487
- Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/logging/logger.ts#L12)
1493
+ Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/logging/logger.ts#L12)
1488
1494
 
1489
1495
  Configuration options for the logger
1490
1496
  LoggerOptions
@@ -1493,14 +1499,14 @@ Configuration options for the logger
1493
1499
 
1494
1500
  | Property | Type | Description | Defined in |
1495
1501
  | ------ | ------ | ------ | ------ |
1496
- | <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.1.1/sdk/utils/src/logging/logger.ts#L14) |
1497
- | <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.1.1/sdk/utils/src/logging/logger.ts#L16) |
1502
+ | <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.1.2/sdk/utils/src/logging/logger.ts#L14) |
1503
+ | <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.1.2/sdk/utils/src/logging/logger.ts#L16) |
1498
1504
 
1499
1505
  ***
1500
1506
 
1501
1507
  #### SpinnerOptions\<R\>
1502
1508
 
1503
- Defined in: [sdk/utils/src/terminal/spinner.ts:24](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/spinner.ts#L24)
1509
+ Defined in: [sdk/utils/src/terminal/spinner.ts:24](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/spinner.ts#L24)
1504
1510
 
1505
1511
  Options for configuring the spinner behavior
1506
1512
 
@@ -1514,37 +1520,137 @@ Options for configuring the spinner behavior
1514
1520
 
1515
1521
  | Property | Type | Description | Defined in |
1516
1522
  | ------ | ------ | ------ | ------ |
1517
- | <a id="startmessage"></a> `startMessage` | `string` | Message to display when spinner starts | [sdk/utils/src/terminal/spinner.ts:26](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/spinner.ts#L26) |
1518
- | <a id="stopmessage"></a> `stopMessage` | `string` | Message to display when spinner completes successfully | [sdk/utils/src/terminal/spinner.ts:30](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/spinner.ts#L30) |
1519
- | <a id="task"></a> `task` | (`spinner?`) => `Promise`\<`R`\> | Async task to execute while spinner is active | [sdk/utils/src/terminal/spinner.ts:28](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/terminal/spinner.ts#L28) |
1523
+ | <a id="startmessage"></a> `startMessage` | `string` | Message to display when spinner starts | [sdk/utils/src/terminal/spinner.ts:26](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/spinner.ts#L26) |
1524
+ | <a id="stopmessage"></a> `stopMessage` | `string` | Message to display when spinner completes successfully | [sdk/utils/src/terminal/spinner.ts:30](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/spinner.ts#L30) |
1525
+ | <a id="task"></a> `task` | (`spinner?`) => `Promise`\<`R`\> | Async task to execute while spinner is active | [sdk/utils/src/terminal/spinner.ts:28](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/terminal/spinner.ts#L28) |
1520
1526
 
1521
1527
  ### Type Aliases
1522
1528
 
1529
+ #### AccessToken
1530
+
1531
+ > **AccessToken** = `string`
1532
+
1533
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/access-token.schema.ts#L22)
1534
+
1535
+ Schema for validating both application and personal access tokens.
1536
+ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
1537
+
1538
+ ***
1539
+
1540
+ #### ApplicationAccessToken
1541
+
1542
+ > **ApplicationAccessToken** = `string`
1543
+
1544
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/access-token.schema.ts#L8)
1545
+
1546
+ Schema for validating application access tokens.
1547
+ Application access tokens start with 'sm_aat_' prefix.
1548
+
1549
+ ***
1550
+
1523
1551
  #### DotEnv
1524
1552
 
1525
- > **DotEnv** = `z.infer`\<*typeof* [`DotEnvSchema`](#dotenvschema)\>
1553
+ > **DotEnv** = `object`
1526
1554
 
1527
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:91](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L91)
1555
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:91](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L91)
1528
1556
 
1529
1557
  Type definition for the environment variables schema.
1530
1558
 
1559
+ ##### Type declaration
1560
+
1561
+ | Name | Type | Description | Defined in |
1562
+ | ------ | ------ | ------ | ------ |
1563
+ | <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.1.2/sdk/utils/src/validation/dot-env.schema.ts#L16) |
1564
+ | <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:55](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L55) |
1565
+ | <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.1.2/sdk/utils/src/validation/dot-env.schema.ts#L22) |
1566
+ | <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.1.2/sdk/utils/src/validation/dot-env.schema.ts#L24) |
1567
+ | <a id="settlemint_blockchain_node"></a> `SETTLEMINT_BLOCKCHAIN_NODE?` | `string` | Unique name of the blockchain node | [sdk/utils/src/validation/dot-env.schema.ts:26](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L26) |
1568
+ | <a id="settlemint_blockscout"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:77](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L77) |
1569
+ | <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:79](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L79) |
1570
+ | <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:81](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L81) |
1571
+ | <a id="settlemint_custom_deployment"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT?` | `string` | Unique name of the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:73](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L73) |
1572
+ | <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:75](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L75) |
1573
+ | <a id="settlemint_hasura"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L30) |
1574
+ | <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:34](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L34) |
1575
+ | <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:36](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L36) |
1576
+ | <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:32](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L32) |
1577
+ | <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:53](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L53) |
1578
+ | <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.1.2/sdk/utils/src/validation/dot-env.schema.ts#L14) |
1579
+ | <a id="settlemint_ipfs"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:65](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L65) |
1580
+ | <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:67](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L67) |
1581
+ | <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:71](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L71) |
1582
+ | <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:69](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L69) |
1583
+ | <a id="settlemint_load_balancer"></a> `SETTLEMINT_LOAD_BALANCER?` | `string` | Unique name of the load balancer | [sdk/utils/src/validation/dot-env.schema.ts:28](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L28) |
1584
+ | <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:85](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L85) |
1585
+ | <a id="settlemint_minio"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:57](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L57) |
1586
+ | <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:61](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L61) |
1587
+ | <a id="settlemint_minio_endpoint"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:59](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L59) |
1588
+ | <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:63](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L63) |
1589
+ | <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:83](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L83) |
1590
+ | <a id="settlemint_portal"></a> `SETTLEMINT_PORTAL?` | `string` | Unique name of the Smart Contract Portal instance | [sdk/utils/src/validation/dot-env.schema.ts:47](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L47) |
1591
+ | <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:49](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L49) |
1592
+ | <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:51](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L51) |
1593
+ | <a id="settlemint_thegraph"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L38) |
1594
+ | <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:45](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L45) |
1595
+ | <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:40](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L40) |
1596
+ | <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.1.2/sdk/utils/src/validation/dot-env.schema.ts#L20) |
1597
+
1531
1598
  ***
1532
1599
 
1533
1600
  #### DotEnvPartial
1534
1601
 
1535
- > **DotEnvPartial** = `z.infer`\<*typeof* [`DotEnvSchemaPartial`](#dotenvschemapartial)\>
1602
+ > **DotEnvPartial** = `object`
1536
1603
 
1537
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:102](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L102)
1604
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:102](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L102)
1538
1605
 
1539
1606
  Type definition for the partial environment variables schema.
1540
1607
 
1608
+ ##### Type declaration
1609
+
1610
+ | Name | Type | Description | Defined in |
1611
+ | ------ | ------ | ------ | ------ |
1612
+ | <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.1.2/sdk/utils/src/validation/dot-env.schema.ts#L16) |
1613
+ | <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:55](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L55) |
1614
+ | <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.1.2/sdk/utils/src/validation/dot-env.schema.ts#L22) |
1615
+ | <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.1.2/sdk/utils/src/validation/dot-env.schema.ts#L24) |
1616
+ | <a id="settlemint_blockchain_node-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE?` | `string` | Unique name of the blockchain node | [sdk/utils/src/validation/dot-env.schema.ts:26](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L26) |
1617
+ | <a id="settlemint_blockscout-1"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:77](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L77) |
1618
+ | <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:79](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L79) |
1619
+ | <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:81](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L81) |
1620
+ | <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:73](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L73) |
1621
+ | <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:75](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L75) |
1622
+ | <a id="settlemint_hasura-1"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L30) |
1623
+ | <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:34](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L34) |
1624
+ | <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:36](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L36) |
1625
+ | <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:32](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L32) |
1626
+ | <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:53](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L53) |
1627
+ | <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.1.2/sdk/utils/src/validation/dot-env.schema.ts#L14) |
1628
+ | <a id="settlemint_ipfs-1"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:65](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L65) |
1629
+ | <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:67](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L67) |
1630
+ | <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:71](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L71) |
1631
+ | <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:69](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L69) |
1632
+ | <a id="settlemint_load_balancer-1"></a> `SETTLEMINT_LOAD_BALANCER?` | `string` | Unique name of the load balancer | [sdk/utils/src/validation/dot-env.schema.ts:28](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L28) |
1633
+ | <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:85](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L85) |
1634
+ | <a id="settlemint_minio-1"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:57](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L57) |
1635
+ | <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:61](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L61) |
1636
+ | <a id="settlemint_minio_endpoint-1"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:59](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L59) |
1637
+ | <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:63](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L63) |
1638
+ | <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:83](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L83) |
1639
+ | <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:47](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L47) |
1640
+ | <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:49](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L49) |
1641
+ | <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:51](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L51) |
1642
+ | <a id="settlemint_thegraph-1"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L38) |
1643
+ | <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:45](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L45) |
1644
+ | <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:40](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L40) |
1645
+ | <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.1.2/sdk/utils/src/validation/dot-env.schema.ts#L20) |
1646
+
1541
1647
  ***
1542
1648
 
1543
1649
  #### Id
1544
1650
 
1545
- > **Id** = `z.infer`\<*typeof* [`IdSchema`](#idschema)\>
1651
+ > **Id** = `string`
1546
1652
 
1547
- Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/id.schema.ts#L30)
1653
+ Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/id.schema.ts#L30)
1548
1654
 
1549
1655
  Type definition for database IDs, inferred from IdSchema.
1550
1656
  Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
@@ -1555,17 +1661,100 @@ Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
1555
1661
 
1556
1662
  > **LogLevel** = `"debug"` \| `"info"` \| `"warn"` \| `"error"` \| `"none"`
1557
1663
 
1558
- Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/logging/logger.ts#L6)
1664
+ Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/logging/logger.ts#L6)
1559
1665
 
1560
1666
  Log levels supported by the logger
1561
1667
 
1668
+ ***
1669
+
1670
+ #### PersonalAccessToken
1671
+
1672
+ > **PersonalAccessToken** = `string`
1673
+
1674
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/access-token.schema.ts#L15)
1675
+
1676
+ Schema for validating personal access tokens.
1677
+ Personal access tokens start with 'sm_pat_' prefix.
1678
+
1679
+ ***
1680
+
1681
+ #### Url
1682
+
1683
+ > **Url** = `string`
1684
+
1685
+ Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/url.schema.ts#L18)
1686
+
1687
+ Schema for validating URLs.
1688
+
1689
+ ##### Example
1690
+
1691
+ ```ts
1692
+ import { UrlSchema } from "@settlemint/sdk-utils/validation";
1693
+
1694
+ // Validate a URL
1695
+ const isValidUrl = UrlSchema.safeParse("https://console.settlemint.com").success;
1696
+ // true
1697
+
1698
+ // Invalid URLs will fail validation
1699
+ const isInvalidUrl = UrlSchema.safeParse("not-a-url").success;
1700
+ // false
1701
+ ```
1702
+
1703
+ ***
1704
+
1705
+ #### UrlOrPath
1706
+
1707
+ > **UrlOrPath** = `string`
1708
+
1709
+ Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/url.schema.ts#L55)
1710
+
1711
+ Schema that accepts either a full URL or a URL path.
1712
+
1713
+ ##### Example
1714
+
1715
+ ```ts
1716
+ import { UrlOrPathSchema } from "@settlemint/sdk-utils/validation";
1717
+
1718
+ // Validate a URL
1719
+ const isValidUrl = UrlOrPathSchema.safeParse("https://console.settlemint.com").success;
1720
+ // true
1721
+
1722
+ // Validate a path
1723
+ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
1724
+ // true
1725
+ ```
1726
+
1727
+ ***
1728
+
1729
+ #### UrlPath
1730
+
1731
+ > **UrlPath** = `string`
1732
+
1733
+ Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/url.schema.ts#L38)
1734
+
1735
+ Schema for validating URL paths.
1736
+
1737
+ ##### Example
1738
+
1739
+ ```ts
1740
+ import { UrlPathSchema } from "@settlemint/sdk-utils/validation";
1741
+
1742
+ // Validate a URL path
1743
+ const isValidPath = UrlPathSchema.safeParse("/api/v1/users").success;
1744
+ // true
1745
+
1746
+ // Invalid paths will fail validation
1747
+ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
1748
+ // false
1749
+ ```
1750
+
1562
1751
  ### Variables
1563
1752
 
1564
1753
  #### AccessTokenSchema
1565
1754
 
1566
- > `const` **AccessTokenSchema**: `ZodString`
1755
+ > `const` **AccessTokenSchema**: `ZodString`\<[`AccessToken`](#accesstoken)\>
1567
1756
 
1568
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/access-token.schema.ts#L21)
1757
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/access-token.schema.ts#L21)
1569
1758
 
1570
1759
  Schema for validating both application and personal access tokens.
1571
1760
  Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
@@ -1574,9 +1763,9 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
1574
1763
 
1575
1764
  #### ApplicationAccessTokenSchema
1576
1765
 
1577
- > `const` **ApplicationAccessTokenSchema**: `ZodString`
1766
+ > `const` **ApplicationAccessTokenSchema**: `ZodString`\<[`ApplicationAccessToken`](#applicationaccesstoken)\>
1578
1767
 
1579
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/access-token.schema.ts#L7)
1768
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/access-token.schema.ts#L7)
1580
1769
 
1581
1770
  Schema for validating application access tokens.
1582
1771
  Application access tokens start with 'sm_aat_' prefix.
@@ -1585,9 +1774,9 @@ Application access tokens start with 'sm_aat_' prefix.
1585
1774
 
1586
1775
  #### DotEnvSchema
1587
1776
 
1588
- > `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_NODE`: `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_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_LOAD_BALANCER`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_LOG_LEVEL`: `ZodDefault`\<`ZodEnum`\<\[`"debug"`, `"info"`, `"warn"`, `"error"`, `"none"`\]\>\>; `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_THEGRAPH`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS`: `ZodEffects`\<`ZodOptional`\<`ZodArray`\<`ZodString`, `"many"`\>\>, `undefined` \| `string`[], `unknown`\>; `SETTLEMINT_WORKSPACE`: `ZodOptional`\<`ZodString`\>; \}, `"strip"`, `ZodTypeAny`, \{ `SETTLEMINT_ACCESS_TOKEN`: `string`; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY`: `string`; `SETTLEMINT_APPLICATION`: `string`; `SETTLEMINT_BLOCKCHAIN_NETWORK`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE`: `string`; `SETTLEMINT_BLOCKSCOUT`: `string`; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT`: `string`; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT`: `string`; `SETTLEMINT_CUSTOM_DEPLOYMENT`: `string`; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT`: `string`; `SETTLEMINT_HASURA`: `string`; `SETTLEMINT_HASURA_ADMIN_SECRET`: `string`; `SETTLEMINT_HASURA_DATABASE_URL`: `string`; `SETTLEMINT_HASURA_ENDPOINT`: `string`; `SETTLEMINT_HD_PRIVATE_KEY`: `string`; `SETTLEMINT_INSTANCE`: `string`; `SETTLEMINT_IPFS`: `string`; `SETTLEMINT_IPFS_API_ENDPOINT`: `string`; `SETTLEMINT_IPFS_GATEWAY_ENDPOINT`: `string`; `SETTLEMINT_IPFS_PINNING_ENDPOINT`: `string`; `SETTLEMINT_LOAD_BALANCER`: `string`; `SETTLEMINT_LOG_LEVEL`: `"error"` \| `"info"` \| `"warn"` \| `"debug"` \| `"none"`; `SETTLEMINT_MINIO`: `string`; `SETTLEMINT_MINIO_ACCESS_KEY`: `string`; `SETTLEMINT_MINIO_ENDPOINT`: `string`; `SETTLEMINT_MINIO_SECRET_KEY`: `string`; `SETTLEMINT_NEW_PROJECT_NAME`: `string`; `SETTLEMINT_PORTAL`: `string`; `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT`: `string`; `SETTLEMINT_PORTAL_REST_ENDPOINT`: `string`; `SETTLEMINT_THEGRAPH`: `string`; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH`: `string`; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS`: `string`[]; `SETTLEMINT_WORKSPACE`: `string`; \}, \{ `SETTLEMINT_ACCESS_TOKEN`: `string`; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY`: `string`; `SETTLEMINT_APPLICATION`: `string`; `SETTLEMINT_BLOCKCHAIN_NETWORK`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE`: `string`; `SETTLEMINT_BLOCKSCOUT`: `string`; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT`: `string`; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT`: `string`; `SETTLEMINT_CUSTOM_DEPLOYMENT`: `string`; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT`: `string`; `SETTLEMINT_HASURA`: `string`; `SETTLEMINT_HASURA_ADMIN_SECRET`: `string`; `SETTLEMINT_HASURA_DATABASE_URL`: `string`; `SETTLEMINT_HASURA_ENDPOINT`: `string`; `SETTLEMINT_HD_PRIVATE_KEY`: `string`; `SETTLEMINT_INSTANCE`: `string`; `SETTLEMINT_IPFS`: `string`; `SETTLEMINT_IPFS_API_ENDPOINT`: `string`; `SETTLEMINT_IPFS_GATEWAY_ENDPOINT`: `string`; `SETTLEMINT_IPFS_PINNING_ENDPOINT`: `string`; `SETTLEMINT_LOAD_BALANCER`: `string`; `SETTLEMINT_LOG_LEVEL`: `"error"` \| `"info"` \| `"warn"` \| `"debug"` \| `"none"`; `SETTLEMINT_MINIO`: `string`; `SETTLEMINT_MINIO_ACCESS_KEY`: `string`; `SETTLEMINT_MINIO_ENDPOINT`: `string`; `SETTLEMINT_MINIO_SECRET_KEY`: `string`; `SETTLEMINT_NEW_PROJECT_NAME`: `string`; `SETTLEMINT_PORTAL`: `string`; `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT`: `string`; `SETTLEMINT_PORTAL_REST_ENDPOINT`: `string`; `SETTLEMINT_THEGRAPH`: `string`; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH`: `string`; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS`: `unknown`; `SETTLEMINT_WORKSPACE`: `string`; \}\>
1777
+ > `const` **DotEnvSchema**: `ZodObject`\<[`DotEnv`](#dotenv)\>
1589
1778
 
1590
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:12](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L12)
1779
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:12](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L12)
1591
1780
 
1592
1781
  Schema for validating environment variables used by the SettleMint SDK.
1593
1782
  Defines validation rules and types for configuration values like URLs,
@@ -1597,9 +1786,9 @@ access tokens, workspace names, and service endpoints.
1597
1786
 
1598
1787
  #### DotEnvSchemaPartial
1599
1788
 
1600
- > `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_NODE`: `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_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_LOAD_BALANCER`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_LOG_LEVEL`: `ZodOptional`\<`ZodDefault`\<`ZodEnum`\<\[`"debug"`, `"info"`, `"warn"`, `"error"`, `"none"`\]\>\>\>; `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_THEGRAPH`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS`: `ZodOptional`\<`ZodEffects`\<`ZodOptional`\<`ZodArray`\<`ZodString`, `"many"`\>\>, `undefined` \| `string`[], `unknown`\>\>; `SETTLEMINT_WORKSPACE`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; \}, `"strip"`, `ZodTypeAny`, \{ `SETTLEMINT_ACCESS_TOKEN`: `string`; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY`: `string`; `SETTLEMINT_APPLICATION`: `string`; `SETTLEMINT_BLOCKCHAIN_NETWORK`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE`: `string`; `SETTLEMINT_BLOCKSCOUT`: `string`; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT`: `string`; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT`: `string`; `SETTLEMINT_CUSTOM_DEPLOYMENT`: `string`; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT`: `string`; `SETTLEMINT_HASURA`: `string`; `SETTLEMINT_HASURA_ADMIN_SECRET`: `string`; `SETTLEMINT_HASURA_DATABASE_URL`: `string`; `SETTLEMINT_HASURA_ENDPOINT`: `string`; `SETTLEMINT_HD_PRIVATE_KEY`: `string`; `SETTLEMINT_INSTANCE`: `string`; `SETTLEMINT_IPFS`: `string`; `SETTLEMINT_IPFS_API_ENDPOINT`: `string`; `SETTLEMINT_IPFS_GATEWAY_ENDPOINT`: `string`; `SETTLEMINT_IPFS_PINNING_ENDPOINT`: `string`; `SETTLEMINT_LOAD_BALANCER`: `string`; `SETTLEMINT_LOG_LEVEL`: `"error"` \| `"info"` \| `"warn"` \| `"debug"` \| `"none"`; `SETTLEMINT_MINIO`: `string`; `SETTLEMINT_MINIO_ACCESS_KEY`: `string`; `SETTLEMINT_MINIO_ENDPOINT`: `string`; `SETTLEMINT_MINIO_SECRET_KEY`: `string`; `SETTLEMINT_NEW_PROJECT_NAME`: `string`; `SETTLEMINT_PORTAL`: `string`; `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT`: `string`; `SETTLEMINT_PORTAL_REST_ENDPOINT`: `string`; `SETTLEMINT_THEGRAPH`: `string`; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH`: `string`; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS`: `string`[]; `SETTLEMINT_WORKSPACE`: `string`; \}, \{ `SETTLEMINT_ACCESS_TOKEN`: `string`; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY`: `string`; `SETTLEMINT_APPLICATION`: `string`; `SETTLEMINT_BLOCKCHAIN_NETWORK`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE`: `string`; `SETTLEMINT_BLOCKSCOUT`: `string`; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT`: `string`; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT`: `string`; `SETTLEMINT_CUSTOM_DEPLOYMENT`: `string`; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT`: `string`; `SETTLEMINT_HASURA`: `string`; `SETTLEMINT_HASURA_ADMIN_SECRET`: `string`; `SETTLEMINT_HASURA_DATABASE_URL`: `string`; `SETTLEMINT_HASURA_ENDPOINT`: `string`; `SETTLEMINT_HD_PRIVATE_KEY`: `string`; `SETTLEMINT_INSTANCE`: `string`; `SETTLEMINT_IPFS`: `string`; `SETTLEMINT_IPFS_API_ENDPOINT`: `string`; `SETTLEMINT_IPFS_GATEWAY_ENDPOINT`: `string`; `SETTLEMINT_IPFS_PINNING_ENDPOINT`: `string`; `SETTLEMINT_LOAD_BALANCER`: `string`; `SETTLEMINT_LOG_LEVEL`: `"error"` \| `"info"` \| `"warn"` \| `"debug"` \| `"none"`; `SETTLEMINT_MINIO`: `string`; `SETTLEMINT_MINIO_ACCESS_KEY`: `string`; `SETTLEMINT_MINIO_ENDPOINT`: `string`; `SETTLEMINT_MINIO_SECRET_KEY`: `string`; `SETTLEMINT_NEW_PROJECT_NAME`: `string`; `SETTLEMINT_PORTAL`: `string`; `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT`: `string`; `SETTLEMINT_PORTAL_REST_ENDPOINT`: `string`; `SETTLEMINT_THEGRAPH`: `string`; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH`: `string`; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS`: `unknown`; `SETTLEMINT_WORKSPACE`: `string`; \}\>
1789
+ > `const` **DotEnvSchemaPartial**: `ZodObject`\<[`DotEnvPartial`](#dotenvpartial)\>
1601
1790
 
1602
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:97](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L97)
1791
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:97](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/dot-env.schema.ts#L97)
1603
1792
 
1604
1793
  Partial version of the environment variables schema where all fields are optional.
1605
1794
  Useful for validating incomplete configurations during development or build time.
@@ -1608,9 +1797,9 @@ Useful for validating incomplete configurations during development or build time
1608
1797
 
1609
1798
  #### IdSchema
1610
1799
 
1611
- > `const` **IdSchema**: `ZodUnion`\<\[`ZodString`, `ZodString`\]\>
1800
+ > `const` **IdSchema**: `ZodUnion`\<[`Id`](#id)\>
1612
1801
 
1613
- Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/id.schema.ts#L17)
1802
+ Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/id.schema.ts#L17)
1614
1803
 
1615
1804
  Schema for validating database IDs. Accepts both PostgreSQL UUIDs and MongoDB ObjectIDs.
1616
1805
  PostgreSQL UUIDs are 32 hexadecimal characters with hyphens (e.g. 123e4567-e89b-12d3-a456-426614174000).
@@ -1632,9 +1821,9 @@ const isValidObjectId = IdSchema.safeParse("507f1f77bcf86cd799439011").success;
1632
1821
 
1633
1822
  #### PersonalAccessTokenSchema
1634
1823
 
1635
- > `const` **PersonalAccessTokenSchema**: `ZodString`
1824
+ > `const` **PersonalAccessTokenSchema**: `ZodString`\<[`PersonalAccessToken`](#personalaccesstoken)\>
1636
1825
 
1637
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/access-token.schema.ts#L14)
1826
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/access-token.schema.ts#L14)
1638
1827
 
1639
1828
  Schema for validating personal access tokens.
1640
1829
  Personal access tokens start with 'sm_pat_' prefix.
@@ -1645,7 +1834,7 @@ Personal access tokens start with 'sm_pat_' prefix.
1645
1834
 
1646
1835
  > `const` **runsInBrowser**: `boolean` = `isBrowser`
1647
1836
 
1648
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/runtime/ensure-server.ts#L40)
1837
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/runtime/ensure-server.ts#L40)
1649
1838
 
1650
1839
  Boolean indicating if code is currently running in a browser environment
1651
1840
 
@@ -1655,7 +1844,7 @@ Boolean indicating if code is currently running in a browser environment
1655
1844
 
1656
1845
  > `const` **runsOnServer**: `boolean` = `!isBrowser`
1657
1846
 
1658
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/runtime/ensure-server.ts#L45)
1847
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/runtime/ensure-server.ts#L45)
1659
1848
 
1660
1849
  Boolean indicating if code is currently running in a server environment
1661
1850
 
@@ -1665,7 +1854,7 @@ Boolean indicating if code is currently running in a server environment
1665
1854
 
1666
1855
  > `const` **UniqueNameSchema**: `ZodString`
1667
1856
 
1668
- Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/unique-name.schema.ts#L19)
1857
+ Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/unique-name.schema.ts#L19)
1669
1858
 
1670
1859
  Schema for validating unique names used across the SettleMint platform.
1671
1860
  Only accepts lowercase alphanumeric characters and hyphens.
@@ -1689,9 +1878,9 @@ const isInvalidName = UniqueNameSchema.safeParse("My Workspace!").success;
1689
1878
 
1690
1879
  #### UrlOrPathSchema
1691
1880
 
1692
- > `const` **UrlOrPathSchema**: `ZodUnion`\<\[`ZodString`, `ZodString`\]\>
1881
+ > `const` **UrlOrPathSchema**: `ZodUnion`\<[`UrlOrPath`](#urlorpath)\>
1693
1882
 
1694
- Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/url.schema.ts#L54)
1883
+ Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/url.schema.ts#L54)
1695
1884
 
1696
1885
  Schema that accepts either a full URL or a URL path.
1697
1886
 
@@ -1713,9 +1902,9 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
1713
1902
 
1714
1903
  #### UrlPathSchema
1715
1904
 
1716
- > `const` **UrlPathSchema**: `ZodString`
1905
+ > `const` **UrlPathSchema**: `ZodString`\<[`UrlPath`](#urlpath)\>
1717
1906
 
1718
- Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/url.schema.ts#L34)
1907
+ Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/url.schema.ts#L34)
1719
1908
 
1720
1909
  Schema for validating URL paths.
1721
1910
 
@@ -1737,9 +1926,9 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
1737
1926
 
1738
1927
  #### UrlSchema
1739
1928
 
1740
- > `const` **UrlSchema**: `ZodString`
1929
+ > `const` **UrlSchema**: `ZodString`\<[`Url`](#url)\>
1741
1930
 
1742
- Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/url.schema.ts#L17)
1931
+ Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.1.2/sdk/utils/src/validation/url.schema.ts#L17)
1743
1932
 
1744
1933
  Schema for validating URLs.
1745
1934
 
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.1.1",
4
+ "version": "2.1.2",
5
5
  "type": "module",
6
6
  "private": false,
7
7
  "license": "FSL-1.1-MIT",