@settlemint/sdk-utils 2.4.0 → 2.4.1-main722d543c

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.
package/README.md CHANGED
@@ -79,10 +79,16 @@
79
79
  - [LoggerOptions](#loggeroptions)
80
80
  - [SpinnerOptions\<R\>](#spinneroptionsr)
81
81
  - [Type Aliases](#type-aliases)
82
+ - [AccessToken](#accesstoken)
83
+ - [ApplicationAccessToken](#applicationaccesstoken)
82
84
  - [DotEnv](#dotenv)
83
85
  - [DotEnvPartial](#dotenvpartial)
84
86
  - [Id](#id)
85
87
  - [LogLevel](#loglevel)
88
+ - [PersonalAccessToken](#personalaccesstoken)
89
+ - [Url](#url)
90
+ - [UrlOrPath](#urlorpath)
91
+ - [UrlPath](#urlpath)
86
92
  - [Variables](#variables)
87
93
  - [AccessTokenSchema](#accesstokenschema)
88
94
  - [ApplicationAccessTokenSchema](#applicationaccesstokenschema)
@@ -113,7 +119,7 @@ The SettleMint Utils SDK provides a collection of shared utilities and helper fu
113
119
 
114
120
  > **ascii**(): `void`
115
121
 
116
- Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/ascii.ts#L14)
122
+ Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/ascii.ts#L14)
117
123
 
118
124
  Prints the SettleMint ASCII art logo to the console in magenta color.
119
125
  Used for CLI branding and visual identification.
@@ -137,7 +143,7 @@ ascii();
137
143
 
138
144
  > **camelCaseToWords**(`s`): `string`
139
145
 
140
- Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/string.ts#L29)
146
+ Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/string.ts#L29)
141
147
 
142
148
  Converts a camelCase string to a human-readable string.
143
149
 
@@ -168,7 +174,7 @@ const words = camelCaseToWords("camelCaseString");
168
174
 
169
175
  > **cancel**(`msg`): `never`
170
176
 
171
- Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/cancel.ts#L23)
177
+ Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/cancel.ts#L23)
172
178
 
173
179
  Displays an error message in red inverse text and throws a CancelError.
174
180
  Used to terminate execution with a visible error message.
@@ -201,7 +207,7 @@ cancel("An error occurred");
201
207
 
202
208
  > **capitalizeFirstLetter**(`val`): `string`
203
209
 
204
- Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/string.ts#L13)
210
+ Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/string.ts#L13)
205
211
 
206
212
  Capitalizes the first letter of a string.
207
213
 
@@ -232,7 +238,7 @@ const capitalized = capitalizeFirstLetter("hello");
232
238
 
233
239
  > **createLogger**(`options`): [`Logger`](#logger)
234
240
 
235
- Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/logging/logger.ts#L50)
241
+ Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/logging/logger.ts#L50)
236
242
 
237
243
  Creates a simple logger with configurable log level
238
244
 
@@ -265,7 +271,7 @@ logger.error('Operation failed', new Error('Connection timeout'));
265
271
 
266
272
  > **emptyDir**(`dir`): `Promise`\<`void`\>
267
273
 
268
- Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/package-manager/download-and-extract.ts#L45)
274
+ Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/package-manager/download-and-extract.ts#L45)
269
275
 
270
276
  Removes all contents of a directory except the .git folder
271
277
 
@@ -293,7 +299,7 @@ await emptyDir("/path/to/dir"); // Removes all contents except .git
293
299
 
294
300
  > **ensureBrowser**(): `void`
295
301
 
296
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/runtime/ensure-server.ts#L31)
302
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/runtime/ensure-server.ts#L31)
297
303
 
298
304
  Ensures that code is running in a browser environment and not on the server.
299
305
 
@@ -320,7 +326,7 @@ ensureBrowser();
320
326
 
321
327
  > **ensureServer**(): `void`
322
328
 
323
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/runtime/ensure-server.ts#L13)
329
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/runtime/ensure-server.ts#L13)
324
330
 
325
331
  Ensures that code is running on the server and not in a browser environment.
326
332
 
@@ -347,7 +353,7 @@ ensureServer();
347
353
 
348
354
  > **executeCommand**(`command`, `args`, `options?`): `Promise`\<`string`[]\>
349
355
 
350
- Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/execute-command.ts#L51)
356
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/execute-command.ts#L51)
351
357
 
352
358
  Executes a command with the given arguments in a child process.
353
359
  Pipes stdin to the child process and captures stdout/stderr output.
@@ -389,7 +395,7 @@ await executeCommand("npm", ["install"], { silent: true });
389
395
 
390
396
  > **exists**(`path`): `Promise`\<`boolean`\>
391
397
 
392
- Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/filesystem/exists.ts#L17)
398
+ Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/filesystem/exists.ts#L17)
393
399
 
394
400
  Checks if a file or directory exists at the given path
395
401
 
@@ -422,7 +428,7 @@ if (await exists('/path/to/file.txt')) {
422
428
 
423
429
  > **extractBaseUrlBeforeSegment**(`baseUrl`, `pathSegment`): `string`
424
430
 
425
- Defined in: [sdk/utils/src/url.ts:15](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/url.ts#L15)
431
+ Defined in: [sdk/utils/src/url.ts:15](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/url.ts#L15)
426
432
 
427
433
  Extracts the base URL before a specific segment in a URL.
428
434
 
@@ -454,7 +460,7 @@ const baseUrl = extractBaseUrlBeforeSegment("https://example.com/api/v1/subgraph
454
460
 
455
461
  > **extractJsonObject**\<`T`\>(`value`): `null` \| `T`
456
462
 
457
- Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/json.ts#L50)
463
+ Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/json.ts#L50)
458
464
 
459
465
  Extracts a JSON object from a string.
460
466
 
@@ -497,7 +503,7 @@ const json = extractJsonObject<{ port: number }>(
497
503
 
498
504
  > **fetchWithRetry**(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Response`\>
499
505
 
500
- Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/http/fetch-with-retry.ts#L18)
506
+ Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/http/fetch-with-retry.ts#L18)
501
507
 
502
508
  Retry an HTTP request with exponential backoff and jitter.
503
509
  Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
@@ -535,7 +541,7 @@ const response = await fetchWithRetry("https://api.example.com/data");
535
541
 
536
542
  > **findMonoRepoPackages**(`projectDir`): `Promise`\<`string`[]\>
537
543
 
538
- Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/filesystem/mono-repo.ts#L59)
544
+ Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/filesystem/mono-repo.ts#L59)
539
545
 
540
546
  Finds all packages in a monorepo
541
547
 
@@ -566,7 +572,7 @@ console.log(packages); // Output: ["/path/to/your/project/packages/core", "/path
566
572
 
567
573
  > **findMonoRepoRoot**(`startDir`): `Promise`\<`null` \| `string`\>
568
574
 
569
- Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/filesystem/mono-repo.ts#L19)
575
+ Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/filesystem/mono-repo.ts#L19)
570
576
 
571
577
  Finds the root directory of a monorepo
572
578
 
@@ -597,7 +603,7 @@ console.log(root); // Output: /path/to/your/project/packages/core
597
603
 
598
604
  > **formatTargetDir**(`targetDir`): `string`
599
605
 
600
- Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/package-manager/download-and-extract.ts#L15)
606
+ Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/package-manager/download-and-extract.ts#L15)
601
607
 
602
608
  Formats a directory path by removing trailing slashes and whitespace
603
609
 
@@ -627,7 +633,7 @@ const formatted = formatTargetDir("/path/to/dir/ "); // "/path/to/dir"
627
633
 
628
634
  > **getPackageManager**(`targetDir?`): `Promise`\<`AgentName`\>
629
635
 
630
- Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/package-manager/get-package-manager.ts#L15)
636
+ Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/package-manager/get-package-manager.ts#L15)
631
637
 
632
638
  Detects the package manager used in the current project
633
639
 
@@ -658,7 +664,7 @@ console.log(`Using ${packageManager}`);
658
664
 
659
665
  > **getPackageManagerExecutable**(`targetDir?`): `Promise`\<\{ `args`: `string`[]; `command`: `string`; \}\>
660
666
 
661
- Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
667
+ Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
662
668
 
663
669
  Retrieves the executable command and arguments for the package manager
664
670
 
@@ -689,7 +695,7 @@ console.log(`Using ${command} with args: ${args.join(" ")}`);
689
695
 
690
696
  > **graphqlFetchWithRetry**\<`Data`\>(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Data`\>
691
697
 
692
- Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
698
+ Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
693
699
 
694
700
  Executes a GraphQL request with automatic retries using exponential backoff and jitter.
695
701
  Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
@@ -748,7 +754,7 @@ const data = await graphqlFetchWithRetry<{ user: { id: string } }>(
748
754
 
749
755
  > **installDependencies**(`pkgs`, `cwd?`): `Promise`\<`void`\>
750
756
 
751
- Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/package-manager/install-dependencies.ts#L20)
757
+ Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/package-manager/install-dependencies.ts#L20)
752
758
 
753
759
  Installs one or more packages as dependencies using the detected package manager
754
760
 
@@ -787,7 +793,7 @@ await installDependencies(["express", "cors"]);
787
793
 
788
794
  > **intro**(`msg`): `void`
789
795
 
790
- Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/intro.ts#L16)
796
+ Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/intro.ts#L16)
791
797
 
792
798
  Displays an introductory message in magenta text with padding.
793
799
  Any sensitive tokens in the message are masked before display.
@@ -817,7 +823,7 @@ intro("Starting deployment...");
817
823
 
818
824
  > **isEmpty**(`path`): `Promise`\<`boolean`\>
819
825
 
820
- Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/package-manager/download-and-extract.ts#L31)
826
+ Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/package-manager/download-and-extract.ts#L31)
821
827
 
822
828
  Checks if a directory is empty or contains only a .git folder
823
829
 
@@ -849,7 +855,7 @@ if (await isEmpty("/path/to/dir")) {
849
855
 
850
856
  > **isPackageInstalled**(`name`, `path?`): `Promise`\<`boolean`\>
851
857
 
852
- Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/package-manager/is-package-installed.ts#L17)
858
+ Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/package-manager/is-package-installed.ts#L17)
853
859
 
854
860
  Checks if a package is installed in the project's dependencies, devDependencies, or peerDependencies.
855
861
 
@@ -885,7 +891,7 @@ console.log(`@settlemint/sdk-utils is installed: ${isInstalled}`);
885
891
 
886
892
  > **list**(`title`, `items`): `void`
887
893
 
888
- Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/list.ts#L23)
894
+ Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/list.ts#L23)
889
895
 
890
896
  Displays a list of items in a formatted manner, supporting nested items.
891
897
 
@@ -925,7 +931,7 @@ list("Providers", [
925
931
 
926
932
  > **loadEnv**\<`T`\>(`validateEnv`, `prod`, `path`): `Promise`\<`T` *extends* `true` ? `object` : `object`\>
927
933
 
928
- Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/environment/load-env.ts#L25)
934
+ Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/environment/load-env.ts#L25)
929
935
 
930
936
  Loads environment variables from .env files.
931
937
  To enable encryption with dotenvx (https://www.dotenvx.com/docs) run `bunx dotenvx encrypt`
@@ -973,7 +979,7 @@ const rawEnv = await loadEnv(false, false);
973
979
 
974
980
  > **makeJsonStringifiable**\<`T`\>(`value`): `T`
975
981
 
976
- Defined in: [sdk/utils/src/json.ts:73](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/json.ts#L73)
982
+ Defined in: [sdk/utils/src/json.ts:73](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/json.ts#L73)
977
983
 
978
984
  Converts a value to a JSON stringifiable format.
979
985
 
@@ -1010,7 +1016,7 @@ const json = makeJsonStringifiable<{ amount: bigint }>({ amount: BigInt(1000) })
1010
1016
 
1011
1017
  > **maskTokens**(`output`): `string`
1012
1018
 
1013
- Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/logging/mask-tokens.ts#L13)
1019
+ Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/logging/mask-tokens.ts#L13)
1014
1020
 
1015
1021
  Masks sensitive SettleMint tokens in output text by replacing them with asterisks.
1016
1022
  Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).
@@ -1042,7 +1048,7 @@ const masked = maskTokens("Token: sm_pat_****"); // "Token: ***"
1042
1048
 
1043
1049
  > **note**(`message`, `level`): `void`
1044
1050
 
1045
- Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/note.ts#L21)
1051
+ Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/note.ts#L21)
1046
1052
 
1047
1053
  Displays a note message with optional warning level formatting.
1048
1054
  Regular notes are displayed in normal text, while warnings are shown in yellow.
@@ -1077,7 +1083,7 @@ note("Low disk space remaining", "warn");
1077
1083
 
1078
1084
  > **outro**(`msg`): `void`
1079
1085
 
1080
- Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/outro.ts#L16)
1086
+ Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/outro.ts#L16)
1081
1087
 
1082
1088
  Displays a closing message in green inverted text with padding.
1083
1089
  Any sensitive tokens in the message are masked before display.
@@ -1107,7 +1113,7 @@ outro("Deployment completed successfully!");
1107
1113
 
1108
1114
  > **projectRoot**(`fallbackToCwd`, `cwd?`): `Promise`\<`string`\>
1109
1115
 
1110
- Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/filesystem/project-root.ts#L18)
1116
+ Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/filesystem/project-root.ts#L18)
1111
1117
 
1112
1118
  Finds the root directory of the current project by locating the nearest package.json file
1113
1119
 
@@ -1144,7 +1150,7 @@ console.log(`Project root is at: ${rootDir}`);
1144
1150
 
1145
1151
  > **replaceUnderscoresAndHyphensWithSpaces**(`s`): `string`
1146
1152
 
1147
- Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/string.ts#L48)
1153
+ Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/string.ts#L48)
1148
1154
 
1149
1155
  Replaces underscores and hyphens with spaces.
1150
1156
 
@@ -1175,7 +1181,7 @@ const result = replaceUnderscoresAndHyphensWithSpaces("Already_Spaced-Second");
1175
1181
 
1176
1182
  > **requestLogger**(`logger`, `name`, `fn`): (...`args`) => `Promise`\<`Response`\>
1177
1183
 
1178
- Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/logging/request-logger.ts#L14)
1184
+ Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/logging/request-logger.ts#L14)
1179
1185
 
1180
1186
  Logs the request and duration of a fetch call (> 500ms is logged as warn, otherwise info)
1181
1187
 
@@ -1209,7 +1215,7 @@ The fetch function
1209
1215
 
1210
1216
  > **retryWhenFailed**\<`T`\>(`fn`, `maxRetries`, `initialSleepTime`, `stopOnError?`): `Promise`\<`T`\>
1211
1217
 
1212
- Defined in: [sdk/utils/src/retry.ts:16](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/retry.ts#L16)
1218
+ Defined in: [sdk/utils/src/retry.ts:16](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/retry.ts#L16)
1213
1219
 
1214
1220
  Retry a function when it fails.
1215
1221
 
@@ -1249,7 +1255,7 @@ const result = await retryWhenFailed(() => readFile("/path/to/file.txt"), 3, 1_0
1249
1255
 
1250
1256
  > **setName**(`name`, `path?`): `Promise`\<`void`\>
1251
1257
 
1252
- Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/package-manager/set-name.ts#L16)
1258
+ Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/package-manager/set-name.ts#L16)
1253
1259
 
1254
1260
  Sets the name field in the package.json file
1255
1261
 
@@ -1284,7 +1290,7 @@ await setName("my-new-project-name");
1284
1290
 
1285
1291
  > **spinner**\<`R`\>(`options`): `Promise`\<`R`\>
1286
1292
 
1287
- Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/spinner.ts#L55)
1293
+ Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/spinner.ts#L55)
1288
1294
 
1289
1295
  Displays a loading spinner while executing an async task.
1290
1296
  Shows progress with start/stop messages and handles errors.
@@ -1334,7 +1340,7 @@ const result = await spinner({
1334
1340
 
1335
1341
  > **table**(`title`, `data`): `void`
1336
1342
 
1337
- Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/table.ts#L21)
1343
+ Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/table.ts#L21)
1338
1344
 
1339
1345
  Displays data in a formatted table in the terminal.
1340
1346
 
@@ -1368,7 +1374,7 @@ table("My Table", data);
1368
1374
 
1369
1375
  > **truncate**(`value`, `maxLength`): `string`
1370
1376
 
1371
- Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/string.ts#L65)
1377
+ Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/string.ts#L65)
1372
1378
 
1373
1379
  Truncates a string to a maximum length and appends "..." if it is longer.
1374
1380
 
@@ -1400,7 +1406,7 @@ const truncated = truncate("Hello, world!", 10);
1400
1406
 
1401
1407
  > **tryParseJson**\<`T`\>(`value`, `defaultValue`): `null` \| `T`
1402
1408
 
1403
- Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/json.ts#L23)
1409
+ Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/json.ts#L23)
1404
1410
 
1405
1411
  Attempts to parse a JSON string into a typed value, returning a default value if parsing fails.
1406
1412
 
@@ -1447,7 +1453,7 @@ const invalid = tryParseJson<string[]>(
1447
1453
 
1448
1454
  > **validate**\<`T`\>(`schema`, `value`): `T`\[`"_output"`\]
1449
1455
 
1450
- Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/validate.ts#L16)
1456
+ Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/validate.ts#L16)
1451
1457
 
1452
1458
  Validates a value against a given Zod schema.
1453
1459
 
@@ -1488,7 +1494,7 @@ const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
1488
1494
 
1489
1495
  > **writeEnv**(`options`): `Promise`\<`void`\>
1490
1496
 
1491
- Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/environment/write-env.ts#L41)
1497
+ Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/environment/write-env.ts#L41)
1492
1498
 
1493
1499
  Writes environment variables to .env files across a project or monorepo
1494
1500
 
@@ -1540,7 +1546,7 @@ await writeEnv({
1540
1546
 
1541
1547
  #### CancelError
1542
1548
 
1543
- Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/cancel.ts#L8)
1549
+ Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/cancel.ts#L8)
1544
1550
 
1545
1551
  Error class used to indicate that the operation was cancelled.
1546
1552
  This error is used to signal that the operation should be aborted.
@@ -1553,7 +1559,7 @@ This error is used to signal that the operation should be aborted.
1553
1559
 
1554
1560
  #### CommandError
1555
1561
 
1556
- Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/execute-command.ts#L16)
1562
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/execute-command.ts#L16)
1557
1563
 
1558
1564
  Error class for command execution errors
1559
1565
 
@@ -1567,7 +1573,7 @@ Error class for command execution errors
1567
1573
 
1568
1574
  > **new CommandError**(`message`, `code`, `output`): [`CommandError`](#commanderror)
1569
1575
 
1570
- Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/execute-command.ts#L23)
1576
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/execute-command.ts#L23)
1571
1577
 
1572
1578
  Constructs a new CommandError
1573
1579
 
@@ -1593,7 +1599,7 @@ Constructs a new CommandError
1593
1599
 
1594
1600
  > `readonly` **code**: `number`
1595
1601
 
1596
- Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/execute-command.ts#L25)
1602
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/execute-command.ts#L25)
1597
1603
 
1598
1604
  The exit code of the command
1599
1605
 
@@ -1601,7 +1607,7 @@ The exit code of the command
1601
1607
 
1602
1608
  > `readonly` **output**: `string`[]
1603
1609
 
1604
- Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/execute-command.ts#L26)
1610
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/execute-command.ts#L26)
1605
1611
 
1606
1612
  The output of the command
1607
1613
 
@@ -1609,7 +1615,7 @@ The output of the command
1609
1615
 
1610
1616
  #### SpinnerError
1611
1617
 
1612
- Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/spinner.ts#L12)
1618
+ Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/spinner.ts#L12)
1613
1619
 
1614
1620
  Error class used to indicate that the spinner operation failed.
1615
1621
  This error is used to signal that the operation should be aborted.
@@ -1622,7 +1628,7 @@ This error is used to signal that the operation should be aborted.
1622
1628
 
1623
1629
  #### ExecuteCommandOptions
1624
1630
 
1625
- Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/execute-command.ts#L7)
1631
+ Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/execute-command.ts#L7)
1626
1632
 
1627
1633
  Options for executing a command, extending SpawnOptionsWithoutStdio
1628
1634
 
@@ -1634,13 +1640,13 @@ Options for executing a command, extending SpawnOptionsWithoutStdio
1634
1640
 
1635
1641
  | Property | Type | Description | Defined in |
1636
1642
  | ------ | ------ | ------ | ------ |
1637
- | <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.4.0/sdk/utils/src/terminal/execute-command.ts#L9) |
1643
+ | <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.4.1/sdk/utils/src/terminal/execute-command.ts#L9) |
1638
1644
 
1639
1645
  ***
1640
1646
 
1641
1647
  #### Logger
1642
1648
 
1643
- Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/logging/logger.ts#L23)
1649
+ Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/logging/logger.ts#L23)
1644
1650
 
1645
1651
  Simple logger interface with basic logging methods
1646
1652
  Logger
@@ -1649,16 +1655,16 @@ Simple logger interface with basic logging methods
1649
1655
 
1650
1656
  | Property | Type | Description | Defined in |
1651
1657
  | ------ | ------ | ------ | ------ |
1652
- | <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.4.0/sdk/utils/src/logging/logger.ts#L25) |
1653
- | <a id="error"></a> `error` | (`message`, ...`args`) => `void` | Log errors | [sdk/utils/src/logging/logger.ts:31](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/logging/logger.ts#L31) |
1654
- | <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.4.0/sdk/utils/src/logging/logger.ts#L27) |
1655
- | <a id="warn"></a> `warn` | (`message`, ...`args`) => `void` | Log warnings | [sdk/utils/src/logging/logger.ts:29](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/logging/logger.ts#L29) |
1658
+ | <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.4.1/sdk/utils/src/logging/logger.ts#L25) |
1659
+ | <a id="error"></a> `error` | (`message`, ...`args`) => `void` | Log errors | [sdk/utils/src/logging/logger.ts:31](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/logging/logger.ts#L31) |
1660
+ | <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.4.1/sdk/utils/src/logging/logger.ts#L27) |
1661
+ | <a id="warn"></a> `warn` | (`message`, ...`args`) => `void` | Log warnings | [sdk/utils/src/logging/logger.ts:29](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/logging/logger.ts#L29) |
1656
1662
 
1657
1663
  ***
1658
1664
 
1659
1665
  #### LoggerOptions
1660
1666
 
1661
- Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/logging/logger.ts#L12)
1667
+ Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/logging/logger.ts#L12)
1662
1668
 
1663
1669
  Configuration options for the logger
1664
1670
  LoggerOptions
@@ -1667,14 +1673,14 @@ Configuration options for the logger
1667
1673
 
1668
1674
  | Property | Type | Description | Defined in |
1669
1675
  | ------ | ------ | ------ | ------ |
1670
- | <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.4.0/sdk/utils/src/logging/logger.ts#L14) |
1671
- | <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.4.0/sdk/utils/src/logging/logger.ts#L16) |
1676
+ | <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.4.1/sdk/utils/src/logging/logger.ts#L14) |
1677
+ | <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.4.1/sdk/utils/src/logging/logger.ts#L16) |
1672
1678
 
1673
1679
  ***
1674
1680
 
1675
1681
  #### SpinnerOptions\<R\>
1676
1682
 
1677
- Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/terminal/spinner.ts#L25)
1683
+ Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/terminal/spinner.ts#L25)
1678
1684
 
1679
1685
  Options for configuring the spinner behavior
1680
1686
 
@@ -1688,37 +1694,147 @@ Options for configuring the spinner behavior
1688
1694
 
1689
1695
  | Property | Type | Description | Defined in |
1690
1696
  | ------ | ------ | ------ | ------ |
1691
- | <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.4.0/sdk/utils/src/terminal/spinner.ts#L27) |
1692
- | <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.4.0/sdk/utils/src/terminal/spinner.ts#L31) |
1693
- | <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.4.0/sdk/utils/src/terminal/spinner.ts#L29) |
1697
+ | <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.4.1/sdk/utils/src/terminal/spinner.ts#L27) |
1698
+ | <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.4.1/sdk/utils/src/terminal/spinner.ts#L31) |
1699
+ | <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.4.1/sdk/utils/src/terminal/spinner.ts#L29) |
1694
1700
 
1695
1701
  ### Type Aliases
1696
1702
 
1703
+ #### AccessToken
1704
+
1705
+ > **AccessToken** = `string`
1706
+
1707
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/access-token.schema.ts#L22)
1708
+
1709
+ Schema for validating both application and personal access tokens.
1710
+ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
1711
+
1712
+ ***
1713
+
1714
+ #### ApplicationAccessToken
1715
+
1716
+ > **ApplicationAccessToken** = `string`
1717
+
1718
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/access-token.schema.ts#L8)
1719
+
1720
+ Schema for validating application access tokens.
1721
+ Application access tokens start with 'sm_aat_' prefix.
1722
+
1723
+ ***
1724
+
1697
1725
  #### DotEnv
1698
1726
 
1699
- > **DotEnv** = `z.infer`\<*typeof* [`DotEnvSchema`](#dotenvschema)\>
1727
+ > **DotEnv** = `object`
1700
1728
 
1701
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:112](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/dot-env.schema.ts#L112)
1729
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:112](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L112)
1702
1730
 
1703
1731
  Type definition for the environment variables schema.
1704
1732
 
1733
+ ##### Type declaration
1734
+
1735
+ | Name | Type | Description | Defined in |
1736
+ | ------ | ------ | ------ | ------ |
1737
+ | <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:27](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L27) |
1738
+ | <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:76](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L76) |
1739
+ | <a id="settlemint_application"></a> `SETTLEMINT_APPLICATION?` | `string` | Unique name of the application | [sdk/utils/src/validation/dot-env.schema.ts:33](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L33) |
1740
+ | <a id="settlemint_blockchain_network"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK?` | `string` | Unique name of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:35](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L35) |
1741
+ | <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:37](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L37) |
1742
+ | <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:39](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L39) |
1743
+ | <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:41](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L41) |
1744
+ | <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:43](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L43) |
1745
+ | <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:45](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L45) |
1746
+ | <a id="settlemint_blockscout"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:98](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L98) |
1747
+ | <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:100](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L100) |
1748
+ | <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:102](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L102) |
1749
+ | <a id="settlemint_custom_deployment"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT?` | `string` | Unique name of the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:94](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L94) |
1750
+ | <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:96](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L96) |
1751
+ | <a id="settlemint_hasura"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:47](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L47) |
1752
+ | <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:51](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L51) |
1753
+ | <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:53](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L53) |
1754
+ | <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:49](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L49) |
1755
+ | <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:72](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L72) |
1756
+ | <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:74](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L74) |
1757
+ | <a id="settlemint_instance"></a> `SETTLEMINT_INSTANCE` | `string` | Base URL of the SettleMint platform instance, set to standalone if your resources are not part of the SettleMint platform | [sdk/utils/src/validation/dot-env.schema.ts:23](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L23) |
1758
+ | <a id="settlemint_ipfs"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:86](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L86) |
1759
+ | <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:88](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L88) |
1760
+ | <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:92](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L92) |
1761
+ | <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:90](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L90) |
1762
+ | <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:106](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L106) |
1763
+ | <a id="settlemint_minio"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:78](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L78) |
1764
+ | <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:82](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L82) |
1765
+ | <a id="settlemint_minio_endpoint"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:80](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L80) |
1766
+ | <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:84](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L84) |
1767
+ | <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:104](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L104) |
1768
+ | <a id="settlemint_portal"></a> `SETTLEMINT_PORTAL?` | `string` | Unique name of the Smart Contract Portal instance | [sdk/utils/src/validation/dot-env.schema.ts:64](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L64) |
1769
+ | <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:66](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L66) |
1770
+ | <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:68](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L68) |
1771
+ | <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:70](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L70) |
1772
+ | <a id="settlemint_thegraph"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L55) |
1773
+ | <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:62](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L62) |
1774
+ | <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:57](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L57) |
1775
+ | <a id="settlemint_workspace"></a> `SETTLEMINT_WORKSPACE?` | `string` | Unique name of the workspace | [sdk/utils/src/validation/dot-env.schema.ts:31](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L31) |
1776
+
1705
1777
  ***
1706
1778
 
1707
1779
  #### DotEnvPartial
1708
1780
 
1709
- > **DotEnvPartial** = `z.infer`\<*typeof* [`DotEnvSchemaPartial`](#dotenvschemapartial)\>
1781
+ > **DotEnvPartial** = `object`
1710
1782
 
1711
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:123](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/dot-env.schema.ts#L123)
1783
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:123](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L123)
1712
1784
 
1713
1785
  Type definition for the partial environment variables schema.
1714
1786
 
1787
+ ##### Type declaration
1788
+
1789
+ | Name | Type | Description | Defined in |
1790
+ | ------ | ------ | ------ | ------ |
1791
+ | <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:27](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L27) |
1792
+ | <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:76](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L76) |
1793
+ | <a id="settlemint_application-1"></a> `SETTLEMINT_APPLICATION?` | `string` | Unique name of the application | [sdk/utils/src/validation/dot-env.schema.ts:33](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L33) |
1794
+ | <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:35](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L35) |
1795
+ | <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:37](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L37) |
1796
+ | <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:39](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L39) |
1797
+ | <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:41](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L41) |
1798
+ | <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:43](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L43) |
1799
+ | <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:45](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L45) |
1800
+ | <a id="settlemint_blockscout-1"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:98](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L98) |
1801
+ | <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:100](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L100) |
1802
+ | <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:102](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L102) |
1803
+ | <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:94](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L94) |
1804
+ | <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:96](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L96) |
1805
+ | <a id="settlemint_hasura-1"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:47](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L47) |
1806
+ | <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:51](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L51) |
1807
+ | <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:53](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L53) |
1808
+ | <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:49](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L49) |
1809
+ | <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:72](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L72) |
1810
+ | <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:74](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L74) |
1811
+ | <a id="settlemint_instance-1"></a> `SETTLEMINT_INSTANCE?` | `string` | Base URL of the SettleMint platform instance, set to standalone if your resources are not part of the SettleMint platform | [sdk/utils/src/validation/dot-env.schema.ts:23](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L23) |
1812
+ | <a id="settlemint_ipfs-1"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:86](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L86) |
1813
+ | <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:88](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L88) |
1814
+ | <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:92](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L92) |
1815
+ | <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:90](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L90) |
1816
+ | <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:106](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L106) |
1817
+ | <a id="settlemint_minio-1"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:78](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L78) |
1818
+ | <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:82](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L82) |
1819
+ | <a id="settlemint_minio_endpoint-1"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:80](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L80) |
1820
+ | <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:84](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L84) |
1821
+ | <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:104](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L104) |
1822
+ | <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:64](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L64) |
1823
+ | <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:66](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L66) |
1824
+ | <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:68](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L68) |
1825
+ | <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:70](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L70) |
1826
+ | <a id="settlemint_thegraph-1"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L55) |
1827
+ | <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:62](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L62) |
1828
+ | <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:57](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L57) |
1829
+ | <a id="settlemint_workspace-1"></a> `SETTLEMINT_WORKSPACE?` | `string` | Unique name of the workspace | [sdk/utils/src/validation/dot-env.schema.ts:31](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L31) |
1830
+
1715
1831
  ***
1716
1832
 
1717
1833
  #### Id
1718
1834
 
1719
- > **Id** = `z.infer`\<*typeof* [`IdSchema`](#idschema)\>
1835
+ > **Id** = `string`
1720
1836
 
1721
- Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/id.schema.ts#L30)
1837
+ Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/id.schema.ts#L30)
1722
1838
 
1723
1839
  Type definition for database IDs, inferred from IdSchema.
1724
1840
  Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
@@ -1729,17 +1845,100 @@ Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
1729
1845
 
1730
1846
  > **LogLevel** = `"debug"` \| `"info"` \| `"warn"` \| `"error"` \| `"none"`
1731
1847
 
1732
- Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/logging/logger.ts#L6)
1848
+ Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/logging/logger.ts#L6)
1733
1849
 
1734
1850
  Log levels supported by the logger
1735
1851
 
1852
+ ***
1853
+
1854
+ #### PersonalAccessToken
1855
+
1856
+ > **PersonalAccessToken** = `string`
1857
+
1858
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/access-token.schema.ts#L15)
1859
+
1860
+ Schema for validating personal access tokens.
1861
+ Personal access tokens start with 'sm_pat_' prefix.
1862
+
1863
+ ***
1864
+
1865
+ #### Url
1866
+
1867
+ > **Url** = `string`
1868
+
1869
+ Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/url.schema.ts#L18)
1870
+
1871
+ Schema for validating URLs.
1872
+
1873
+ ##### Example
1874
+
1875
+ ```ts
1876
+ import { UrlSchema } from "@settlemint/sdk-utils/validation";
1877
+
1878
+ // Validate a URL
1879
+ const isValidUrl = UrlSchema.safeParse("https://console.settlemint.com").success;
1880
+ // true
1881
+
1882
+ // Invalid URLs will fail validation
1883
+ const isInvalidUrl = UrlSchema.safeParse("not-a-url").success;
1884
+ // false
1885
+ ```
1886
+
1887
+ ***
1888
+
1889
+ #### UrlOrPath
1890
+
1891
+ > **UrlOrPath** = `string`
1892
+
1893
+ Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/url.schema.ts#L55)
1894
+
1895
+ Schema that accepts either a full URL or a URL path.
1896
+
1897
+ ##### Example
1898
+
1899
+ ```ts
1900
+ import { UrlOrPathSchema } from "@settlemint/sdk-utils/validation";
1901
+
1902
+ // Validate a URL
1903
+ const isValidUrl = UrlOrPathSchema.safeParse("https://console.settlemint.com").success;
1904
+ // true
1905
+
1906
+ // Validate a path
1907
+ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
1908
+ // true
1909
+ ```
1910
+
1911
+ ***
1912
+
1913
+ #### UrlPath
1914
+
1915
+ > **UrlPath** = `string`
1916
+
1917
+ Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/url.schema.ts#L38)
1918
+
1919
+ Schema for validating URL paths.
1920
+
1921
+ ##### Example
1922
+
1923
+ ```ts
1924
+ import { UrlPathSchema } from "@settlemint/sdk-utils/validation";
1925
+
1926
+ // Validate a URL path
1927
+ const isValidPath = UrlPathSchema.safeParse("/api/v1/users").success;
1928
+ // true
1929
+
1930
+ // Invalid paths will fail validation
1931
+ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
1932
+ // false
1933
+ ```
1934
+
1736
1935
  ### Variables
1737
1936
 
1738
1937
  #### AccessTokenSchema
1739
1938
 
1740
- > `const` **AccessTokenSchema**: `ZodString`
1939
+ > `const` **AccessTokenSchema**: `ZodString`\<[`AccessToken`](#accesstoken)\>
1741
1940
 
1742
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/access-token.schema.ts#L21)
1941
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/access-token.schema.ts#L21)
1743
1942
 
1744
1943
  Schema for validating both application and personal access tokens.
1745
1944
  Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
@@ -1748,9 +1947,9 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
1748
1947
 
1749
1948
  #### ApplicationAccessTokenSchema
1750
1949
 
1751
- > `const` **ApplicationAccessTokenSchema**: `ZodString`
1950
+ > `const` **ApplicationAccessTokenSchema**: `ZodString`\<[`ApplicationAccessToken`](#applicationaccesstoken)\>
1752
1951
 
1753
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/access-token.schema.ts#L7)
1952
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/access-token.schema.ts#L7)
1754
1953
 
1755
1954
  Schema for validating application access tokens.
1756
1955
  Application access tokens start with 'sm_aat_' prefix.
@@ -1759,9 +1958,9 @@ Application access tokens start with 'sm_aat_' prefix.
1759
1958
 
1760
1959
  #### DotEnvSchema
1761
1960
 
1762
- > `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`\<`ZodUnion`\<readonly \[`ZodString`, `ZodLiteral`\<`"standalone"`\>, `ZodLiteral`\<`"local"`\>\]\>\>; `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`\>
1961
+ > `const` **DotEnvSchema**: `ZodObject`\<[`DotEnv`](#dotenv)\>
1763
1962
 
1764
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/dot-env.schema.ts#L21)
1963
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L21)
1765
1964
 
1766
1965
  Schema for validating environment variables used by the SettleMint SDK.
1767
1966
  Defines validation rules and types for configuration values like URLs,
@@ -1771,9 +1970,9 @@ access tokens, workspace names, and service endpoints.
1771
1970
 
1772
1971
  #### DotEnvSchemaPartial
1773
1972
 
1774
- > `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`\<`ZodUnion`\<readonly \[`ZodString`, `ZodLiteral`\<`"standalone"`\>, `ZodLiteral`\<`"local"`\>\]\>\>\>; `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`\>
1973
+ > `const` **DotEnvSchemaPartial**: `ZodObject`\<[`DotEnvPartial`](#dotenvpartial)\>
1775
1974
 
1776
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:118](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/dot-env.schema.ts#L118)
1975
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:118](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L118)
1777
1976
 
1778
1977
  Partial version of the environment variables schema where all fields are optional.
1779
1978
  Useful for validating incomplete configurations during development or build time.
@@ -1782,9 +1981,9 @@ Useful for validating incomplete configurations during development or build time
1782
1981
 
1783
1982
  #### IdSchema
1784
1983
 
1785
- > `const` **IdSchema**: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>
1984
+ > `const` **IdSchema**: `ZodUnion`\<[`Id`](#id)\>
1786
1985
 
1787
- Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/id.schema.ts#L17)
1986
+ Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/id.schema.ts#L17)
1788
1987
 
1789
1988
  Schema for validating database IDs. Accepts both PostgreSQL UUIDs and MongoDB ObjectIDs.
1790
1989
  PostgreSQL UUIDs are 32 hexadecimal characters with hyphens (e.g. 123e4567-e89b-12d3-a456-426614174000).
@@ -1808,7 +2007,7 @@ const isValidObjectId = IdSchema.safeParse("507f1f77bcf86cd799439011").success;
1808
2007
 
1809
2008
  > `const` **LOCAL\_INSTANCE**: `"local"` = `"local"`
1810
2009
 
1811
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/dot-env.schema.ts#L14)
2010
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L14)
1812
2011
 
1813
2012
  Use this value to indicate that the resources are not part of the SettleMint platform.
1814
2013
 
@@ -1816,9 +2015,9 @@ Use this value to indicate that the resources are not part of the SettleMint pla
1816
2015
 
1817
2016
  #### PersonalAccessTokenSchema
1818
2017
 
1819
- > `const` **PersonalAccessTokenSchema**: `ZodString`
2018
+ > `const` **PersonalAccessTokenSchema**: `ZodString`\<[`PersonalAccessToken`](#personalaccesstoken)\>
1820
2019
 
1821
- Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/access-token.schema.ts#L14)
2020
+ Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/access-token.schema.ts#L14)
1822
2021
 
1823
2022
  Schema for validating personal access tokens.
1824
2023
  Personal access tokens start with 'sm_pat_' prefix.
@@ -1829,7 +2028,7 @@ Personal access tokens start with 'sm_pat_' prefix.
1829
2028
 
1830
2029
  > `const` **runsInBrowser**: `boolean` = `isBrowser`
1831
2030
 
1832
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/runtime/ensure-server.ts#L40)
2031
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/runtime/ensure-server.ts#L40)
1833
2032
 
1834
2033
  Boolean indicating if code is currently running in a browser environment
1835
2034
 
@@ -1839,7 +2038,7 @@ Boolean indicating if code is currently running in a browser environment
1839
2038
 
1840
2039
  > `const` **runsOnServer**: `boolean` = `!isBrowser`
1841
2040
 
1842
- Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/runtime/ensure-server.ts#L45)
2041
+ Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/runtime/ensure-server.ts#L45)
1843
2042
 
1844
2043
  Boolean indicating if code is currently running in a server environment
1845
2044
 
@@ -1849,7 +2048,7 @@ Boolean indicating if code is currently running in a server environment
1849
2048
 
1850
2049
  > `const` **STANDALONE\_INSTANCE**: `"standalone"` = `"standalone"`
1851
2050
 
1852
- Defined in: [sdk/utils/src/validation/dot-env.schema.ts:10](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/dot-env.schema.ts#L10)
2051
+ Defined in: [sdk/utils/src/validation/dot-env.schema.ts:10](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/dot-env.schema.ts#L10)
1853
2052
 
1854
2053
  Use this value to indicate that the resources are not part of the SettleMint platform.
1855
2054
 
@@ -1859,7 +2058,7 @@ Use this value to indicate that the resources are not part of the SettleMint pla
1859
2058
 
1860
2059
  > `const` **UniqueNameSchema**: `ZodString`
1861
2060
 
1862
- Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/unique-name.schema.ts#L19)
2061
+ Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/unique-name.schema.ts#L19)
1863
2062
 
1864
2063
  Schema for validating unique names used across the SettleMint platform.
1865
2064
  Only accepts lowercase alphanumeric characters and hyphens.
@@ -1883,9 +2082,9 @@ const isInvalidName = UniqueNameSchema.safeParse("My Workspace!").success;
1883
2082
 
1884
2083
  #### UrlOrPathSchema
1885
2084
 
1886
- > `const` **UrlOrPathSchema**: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>
2085
+ > `const` **UrlOrPathSchema**: `ZodUnion`\<[`UrlOrPath`](#urlorpath)\>
1887
2086
 
1888
- Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/url.schema.ts#L54)
2087
+ Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/url.schema.ts#L54)
1889
2088
 
1890
2089
  Schema that accepts either a full URL or a URL path.
1891
2090
 
@@ -1907,9 +2106,9 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
1907
2106
 
1908
2107
  #### UrlPathSchema
1909
2108
 
1910
- > `const` **UrlPathSchema**: `ZodString`
2109
+ > `const` **UrlPathSchema**: `ZodString`\<[`UrlPath`](#urlpath)\>
1911
2110
 
1912
- Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/url.schema.ts#L34)
2111
+ Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/url.schema.ts#L34)
1913
2112
 
1914
2113
  Schema for validating URL paths.
1915
2114
 
@@ -1931,9 +2130,9 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
1931
2130
 
1932
2131
  #### UrlSchema
1933
2132
 
1934
- > `const` **UrlSchema**: `ZodString`
2133
+ > `const` **UrlSchema**: `ZodString`\<[`Url`](#url)\>
1935
2134
 
1936
- Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/url.schema.ts#L17)
2135
+ Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.4.1/sdk/utils/src/validation/url.schema.ts#L17)
1937
2136
 
1938
2137
  Schema for validating URLs.
1939
2138