@settlemint/sdk-utils 2.1.3 → 2.1.4-main0ca0d06f
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 +151 -145
- package/dist/environment.cjs +9 -3
- package/dist/environment.cjs.map +1 -1
- package/dist/environment.d.cts +29 -8
- package/dist/environment.d.ts +29 -8
- package/dist/environment.mjs +9 -3
- package/dist/environment.mjs.map +1 -1
- package/dist/validation.cjs +9 -3
- package/dist/validation.cjs.map +1 -1
- package/dist/validation.d.cts +29 -8
- package/dist/validation.d.ts +29 -8
- package/dist/validation.mjs +9 -3
- package/dist/validation.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -113,7 +113,7 @@ The SettleMint Utils SDK provides a collection of shared utilities and helper fu
|
|
|
113
113
|
|
|
114
114
|
> **ascii**(): `void`
|
|
115
115
|
|
|
116
|
-
Defined in: [sdk/utils/src/terminal/ascii.ts:13](https://github.com/settlemint/sdk/blob/v2.1.
|
|
116
|
+
Defined in: [sdk/utils/src/terminal/ascii.ts:13](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/ascii.ts#L13)
|
|
117
117
|
|
|
118
118
|
Prints the SettleMint ASCII art logo to the console in magenta color.
|
|
119
119
|
Used for CLI branding and visual identification.
|
|
@@ -137,7 +137,7 @@ ascii();
|
|
|
137
137
|
|
|
138
138
|
> **camelCaseToWords**(`s`): `string`
|
|
139
139
|
|
|
140
|
-
Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.1.
|
|
140
|
+
Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/string.ts#L29)
|
|
141
141
|
|
|
142
142
|
Converts a camelCase string to a human-readable string.
|
|
143
143
|
|
|
@@ -168,7 +168,7 @@ const words = camelCaseToWords("camelCaseString");
|
|
|
168
168
|
|
|
169
169
|
> **cancel**(`msg`): `never`
|
|
170
170
|
|
|
171
|
-
Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.1.
|
|
171
|
+
Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/cancel.ts#L23)
|
|
172
172
|
|
|
173
173
|
Displays an error message in red inverse text and throws a CancelError.
|
|
174
174
|
Used to terminate execution with a visible error message.
|
|
@@ -201,7 +201,7 @@ cancel("An error occurred");
|
|
|
201
201
|
|
|
202
202
|
> **capitalizeFirstLetter**(`val`): `string`
|
|
203
203
|
|
|
204
|
-
Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.1.
|
|
204
|
+
Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/string.ts#L13)
|
|
205
205
|
|
|
206
206
|
Capitalizes the first letter of a string.
|
|
207
207
|
|
|
@@ -232,7 +232,7 @@ const capitalized = capitalizeFirstLetter("hello");
|
|
|
232
232
|
|
|
233
233
|
> **createLogger**(`options`): [`Logger`](#logger)
|
|
234
234
|
|
|
235
|
-
Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.1.
|
|
235
|
+
Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/logging/logger.ts#L50)
|
|
236
236
|
|
|
237
237
|
Creates a simple logger with configurable log level
|
|
238
238
|
|
|
@@ -265,7 +265,7 @@ logger.error('Operation failed', new Error('Connection timeout'));
|
|
|
265
265
|
|
|
266
266
|
> **emptyDir**(`dir`): `Promise`\<`void`\>
|
|
267
267
|
|
|
268
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.1.
|
|
268
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/package-manager/download-and-extract.ts#L45)
|
|
269
269
|
|
|
270
270
|
Removes all contents of a directory except the .git folder
|
|
271
271
|
|
|
@@ -293,7 +293,7 @@ await emptyDir("/path/to/dir"); // Removes all contents except .git
|
|
|
293
293
|
|
|
294
294
|
> **ensureBrowser**(): `void`
|
|
295
295
|
|
|
296
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.1.
|
|
296
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/runtime/ensure-server.ts#L31)
|
|
297
297
|
|
|
298
298
|
Ensures that code is running in a browser environment and not on the server.
|
|
299
299
|
|
|
@@ -320,7 +320,7 @@ ensureBrowser();
|
|
|
320
320
|
|
|
321
321
|
> **ensureServer**(): `void`
|
|
322
322
|
|
|
323
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.1.
|
|
323
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/runtime/ensure-server.ts#L13)
|
|
324
324
|
|
|
325
325
|
Ensures that code is running on the server and not in a browser environment.
|
|
326
326
|
|
|
@@ -347,7 +347,7 @@ ensureServer();
|
|
|
347
347
|
|
|
348
348
|
> **executeCommand**(`command`, `args`, `options?`): `Promise`\<`string`[]\>
|
|
349
349
|
|
|
350
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:31](https://github.com/settlemint/sdk/blob/v2.1.
|
|
350
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:31](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/execute-command.ts#L31)
|
|
351
351
|
|
|
352
352
|
Executes a command with the given arguments in a child process.
|
|
353
353
|
Pipes stdin to the child process and captures stdout/stderr output.
|
|
@@ -389,7 +389,7 @@ await executeCommand("npm", ["install"], { silent: true });
|
|
|
389
389
|
|
|
390
390
|
> **exists**(`path`): `Promise`\<`boolean`\>
|
|
391
391
|
|
|
392
|
-
Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.1.
|
|
392
|
+
Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/filesystem/exists.ts#L17)
|
|
393
393
|
|
|
394
394
|
Checks if a file or directory exists at the given path
|
|
395
395
|
|
|
@@ -422,7 +422,7 @@ if (await exists('/path/to/file.txt')) {
|
|
|
422
422
|
|
|
423
423
|
> **fetchWithRetry**(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Response`\>
|
|
424
424
|
|
|
425
|
-
Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.1.
|
|
425
|
+
Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/http/fetch-with-retry.ts#L18)
|
|
426
426
|
|
|
427
427
|
Retry an HTTP request with exponential backoff and jitter.
|
|
428
428
|
Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
|
|
@@ -460,7 +460,7 @@ const response = await fetchWithRetry("https://api.example.com/data");
|
|
|
460
460
|
|
|
461
461
|
> **findMonoRepoPackages**(`projectDir`): `Promise`\<`string`[]\>
|
|
462
462
|
|
|
463
|
-
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.1.
|
|
463
|
+
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/filesystem/mono-repo.ts#L59)
|
|
464
464
|
|
|
465
465
|
Finds all packages in a monorepo
|
|
466
466
|
|
|
@@ -491,7 +491,7 @@ console.log(packages); // Output: ["/path/to/your/project/packages/core", "/path
|
|
|
491
491
|
|
|
492
492
|
> **findMonoRepoRoot**(`startDir`): `Promise`\<`null` \| `string`\>
|
|
493
493
|
|
|
494
|
-
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.1.
|
|
494
|
+
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/filesystem/mono-repo.ts#L19)
|
|
495
495
|
|
|
496
496
|
Finds the root directory of a monorepo
|
|
497
497
|
|
|
@@ -522,7 +522,7 @@ console.log(root); // Output: /path/to/your/project/packages/core
|
|
|
522
522
|
|
|
523
523
|
> **formatTargetDir**(`targetDir`): `string`
|
|
524
524
|
|
|
525
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.1.
|
|
525
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/package-manager/download-and-extract.ts#L15)
|
|
526
526
|
|
|
527
527
|
Formats a directory path by removing trailing slashes and whitespace
|
|
528
528
|
|
|
@@ -552,7 +552,7 @@ const formatted = formatTargetDir("/path/to/dir/ "); // "/path/to/dir"
|
|
|
552
552
|
|
|
553
553
|
> **getPackageManager**(`targetDir?`): `Promise`\<`AgentName`\>
|
|
554
554
|
|
|
555
|
-
Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.1.
|
|
555
|
+
Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/package-manager/get-package-manager.ts#L15)
|
|
556
556
|
|
|
557
557
|
Detects the package manager used in the current project
|
|
558
558
|
|
|
@@ -583,7 +583,7 @@ console.log(`Using ${packageManager}`);
|
|
|
583
583
|
|
|
584
584
|
> **getPackageManagerExecutable**(`targetDir?`): `Promise`\<\{ `args`: `string`[]; `command`: `string`; \}\>
|
|
585
585
|
|
|
586
|
-
Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.1.
|
|
586
|
+
Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
|
|
587
587
|
|
|
588
588
|
Retrieves the executable command and arguments for the package manager
|
|
589
589
|
|
|
@@ -614,7 +614,7 @@ console.log(`Using ${command} with args: ${args.join(" ")}`);
|
|
|
614
614
|
|
|
615
615
|
> **graphqlFetchWithRetry**\<`Data`\>(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Data`\>
|
|
616
616
|
|
|
617
|
-
Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.1.
|
|
617
|
+
Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
|
|
618
618
|
|
|
619
619
|
Executes a GraphQL request with automatic retries using exponential backoff and jitter.
|
|
620
620
|
Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
|
|
@@ -673,7 +673,7 @@ const data = await graphqlFetchWithRetry<{ user: { id: string } }>(
|
|
|
673
673
|
|
|
674
674
|
> **installDependencies**(`pkgs`, `cwd?`): `Promise`\<`void`\>
|
|
675
675
|
|
|
676
|
-
Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.1.
|
|
676
|
+
Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/package-manager/install-dependencies.ts#L20)
|
|
677
677
|
|
|
678
678
|
Installs one or more packages as dependencies using the detected package manager
|
|
679
679
|
|
|
@@ -712,7 +712,7 @@ await installDependencies(["express", "cors"]);
|
|
|
712
712
|
|
|
713
713
|
> **intro**(`msg`): `void`
|
|
714
714
|
|
|
715
|
-
Defined in: [sdk/utils/src/terminal/intro.ts:15](https://github.com/settlemint/sdk/blob/v2.1.
|
|
715
|
+
Defined in: [sdk/utils/src/terminal/intro.ts:15](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/intro.ts#L15)
|
|
716
716
|
|
|
717
717
|
Displays an introductory message in magenta text with padding.
|
|
718
718
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -742,7 +742,7 @@ intro("Starting deployment...");
|
|
|
742
742
|
|
|
743
743
|
> **isEmpty**(`path`): `Promise`\<`boolean`\>
|
|
744
744
|
|
|
745
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.1.
|
|
745
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/package-manager/download-and-extract.ts#L31)
|
|
746
746
|
|
|
747
747
|
Checks if a directory is empty or contains only a .git folder
|
|
748
748
|
|
|
@@ -774,7 +774,7 @@ if (await isEmpty("/path/to/dir")) {
|
|
|
774
774
|
|
|
775
775
|
> **isPackageInstalled**(`name`, `path?`): `Promise`\<`boolean`\>
|
|
776
776
|
|
|
777
|
-
Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.1.
|
|
777
|
+
Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/package-manager/is-package-installed.ts#L17)
|
|
778
778
|
|
|
779
779
|
Checks if a package is installed in the project's dependencies, devDependencies, or peerDependencies.
|
|
780
780
|
|
|
@@ -810,7 +810,7 @@ console.log(`@settlemint/sdk-utils is installed: ${isInstalled}`);
|
|
|
810
810
|
|
|
811
811
|
> **list**(`title`, `items`): `void`
|
|
812
812
|
|
|
813
|
-
Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.1.
|
|
813
|
+
Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/list.ts#L23)
|
|
814
814
|
|
|
815
815
|
Displays a list of items in a formatted manner, supporting nested items.
|
|
816
816
|
|
|
@@ -850,7 +850,7 @@ list("Providers", [
|
|
|
850
850
|
|
|
851
851
|
> **loadEnv**\<`T`\>(`validateEnv`, `prod`, `path`): `Promise`\<`T` *extends* `true` ? `object` : `object`\>
|
|
852
852
|
|
|
853
|
-
Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.1.
|
|
853
|
+
Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/environment/load-env.ts#L25)
|
|
854
854
|
|
|
855
855
|
Loads environment variables from .env files.
|
|
856
856
|
To enable encryption with dotenvx (https://www.dotenvx.com/docs) run `bunx dotenvx encrypt`
|
|
@@ -898,7 +898,7 @@ const rawEnv = await loadEnv(false, false);
|
|
|
898
898
|
|
|
899
899
|
> **maskTokens**(`output`): `string`
|
|
900
900
|
|
|
901
|
-
Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.1.
|
|
901
|
+
Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/logging/mask-tokens.ts#L13)
|
|
902
902
|
|
|
903
903
|
Masks sensitive SettleMint tokens in output text by replacing them with asterisks.
|
|
904
904
|
Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).
|
|
@@ -930,7 +930,7 @@ const masked = maskTokens("Token: sm_pat_****"); // "Token: ***"
|
|
|
930
930
|
|
|
931
931
|
> **note**(`message`, `level`): `void`
|
|
932
932
|
|
|
933
|
-
Defined in: [sdk/utils/src/terminal/note.ts:20](https://github.com/settlemint/sdk/blob/v2.1.
|
|
933
|
+
Defined in: [sdk/utils/src/terminal/note.ts:20](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/note.ts#L20)
|
|
934
934
|
|
|
935
935
|
Displays a note message with optional warning level formatting.
|
|
936
936
|
Regular notes are displayed in normal text, while warnings are shown in yellow.
|
|
@@ -965,7 +965,7 @@ note("Low disk space remaining", "warn");
|
|
|
965
965
|
|
|
966
966
|
> **outro**(`msg`): `void`
|
|
967
967
|
|
|
968
|
-
Defined in: [sdk/utils/src/terminal/outro.ts:15](https://github.com/settlemint/sdk/blob/v2.1.
|
|
968
|
+
Defined in: [sdk/utils/src/terminal/outro.ts:15](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/outro.ts#L15)
|
|
969
969
|
|
|
970
970
|
Displays a closing message in green inverted text with padding.
|
|
971
971
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -995,7 +995,7 @@ outro("Deployment completed successfully!");
|
|
|
995
995
|
|
|
996
996
|
> **projectRoot**(`fallbackToCwd`, `cwd?`): `Promise`\<`string`\>
|
|
997
997
|
|
|
998
|
-
Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.1.
|
|
998
|
+
Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/filesystem/project-root.ts#L18)
|
|
999
999
|
|
|
1000
1000
|
Finds the root directory of the current project by locating the nearest package.json file
|
|
1001
1001
|
|
|
@@ -1032,7 +1032,7 @@ console.log(`Project root is at: ${rootDir}`);
|
|
|
1032
1032
|
|
|
1033
1033
|
> **replaceUnderscoresAndHyphensWithSpaces**(`s`): `string`
|
|
1034
1034
|
|
|
1035
|
-
Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1035
|
+
Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/string.ts#L48)
|
|
1036
1036
|
|
|
1037
1037
|
Replaces underscores and hyphens with spaces.
|
|
1038
1038
|
|
|
@@ -1063,7 +1063,7 @@ const result = replaceUnderscoresAndHyphensWithSpaces("Already_Spaced-Second");
|
|
|
1063
1063
|
|
|
1064
1064
|
> **requestLogger**(`logger`, `name`, `fn`): (...`args`) => `Promise`\<`Response`\>
|
|
1065
1065
|
|
|
1066
|
-
Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1066
|
+
Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/logging/request-logger.ts#L14)
|
|
1067
1067
|
|
|
1068
1068
|
Logs the request and duration of a fetch call (> 500ms is logged as warn, otherwise info)
|
|
1069
1069
|
|
|
@@ -1097,7 +1097,7 @@ The fetch function
|
|
|
1097
1097
|
|
|
1098
1098
|
> **retryWhenFailed**\<`T`\>(`fn`, `maxRetries`, `initialSleepTime`, `stopOnError?`): `Promise`\<`T`\>
|
|
1099
1099
|
|
|
1100
|
-
Defined in: [sdk/utils/src/retry.ts:14](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1100
|
+
Defined in: [sdk/utils/src/retry.ts:14](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/retry.ts#L14)
|
|
1101
1101
|
|
|
1102
1102
|
Retry a function when it fails.
|
|
1103
1103
|
|
|
@@ -1137,7 +1137,7 @@ const result = await retryWhenFailed(() => readFile("/path/to/file.txt"), 3, 1_0
|
|
|
1137
1137
|
|
|
1138
1138
|
> **setName**(`name`, `path?`): `Promise`\<`void`\>
|
|
1139
1139
|
|
|
1140
|
-
Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1140
|
+
Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/package-manager/set-name.ts#L16)
|
|
1141
1141
|
|
|
1142
1142
|
Sets the name field in the package.json file
|
|
1143
1143
|
|
|
@@ -1172,7 +1172,7 @@ await setName("my-new-project-name");
|
|
|
1172
1172
|
|
|
1173
1173
|
> **spinner**\<`R`\>(`options`): `Promise`\<`R`\>
|
|
1174
1174
|
|
|
1175
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:54](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1175
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:54](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/spinner.ts#L54)
|
|
1176
1176
|
|
|
1177
1177
|
Displays a loading spinner while executing an async task.
|
|
1178
1178
|
Shows progress with start/stop messages and handles errors.
|
|
@@ -1222,7 +1222,7 @@ const result = await spinner({
|
|
|
1222
1222
|
|
|
1223
1223
|
> **table**(`title`, `data`): `void`
|
|
1224
1224
|
|
|
1225
|
-
Defined in: [sdk/utils/src/terminal/table.ts:20](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1225
|
+
Defined in: [sdk/utils/src/terminal/table.ts:20](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/table.ts#L20)
|
|
1226
1226
|
|
|
1227
1227
|
Displays data in a formatted table in the terminal.
|
|
1228
1228
|
|
|
@@ -1256,7 +1256,7 @@ table("My Table", data);
|
|
|
1256
1256
|
|
|
1257
1257
|
> **truncate**(`value`, `maxLength`): `string`
|
|
1258
1258
|
|
|
1259
|
-
Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1259
|
+
Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/string.ts#L65)
|
|
1260
1260
|
|
|
1261
1261
|
Truncates a string to a maximum length and appends "..." if it is longer.
|
|
1262
1262
|
|
|
@@ -1288,7 +1288,7 @@ const truncated = truncate("Hello, world!", 10);
|
|
|
1288
1288
|
|
|
1289
1289
|
> **tryParseJson**\<`T`\>(`value`, `defaultValue`): `null` \| `T`
|
|
1290
1290
|
|
|
1291
|
-
Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1291
|
+
Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/json.ts#L23)
|
|
1292
1292
|
|
|
1293
1293
|
Attempts to parse a JSON string into a typed value, returning a default value if parsing fails.
|
|
1294
1294
|
|
|
@@ -1335,7 +1335,7 @@ const invalid = tryParseJson<string[]>(
|
|
|
1335
1335
|
|
|
1336
1336
|
> **validate**\<`T`\>(`schema`, `value`): `T`\[`"_output"`\]
|
|
1337
1337
|
|
|
1338
|
-
Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1338
|
+
Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/validate.ts#L16)
|
|
1339
1339
|
|
|
1340
1340
|
Validates a value against a given Zod schema.
|
|
1341
1341
|
|
|
@@ -1376,7 +1376,7 @@ const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
|
|
|
1376
1376
|
|
|
1377
1377
|
> **writeEnv**(`options`): `Promise`\<`void`\>
|
|
1378
1378
|
|
|
1379
|
-
Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1379
|
+
Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/environment/write-env.ts#L41)
|
|
1380
1380
|
|
|
1381
1381
|
Writes environment variables to .env files across a project or monorepo
|
|
1382
1382
|
|
|
@@ -1384,9 +1384,9 @@ Writes environment variables to .env files across a project or monorepo
|
|
|
1384
1384
|
|
|
1385
1385
|
| Parameter | Type | Description |
|
|
1386
1386
|
| ------ | ------ | ------ |
|
|
1387
|
-
| `options` | \{ `cwd
|
|
1387
|
+
| `options` | \{ `cwd?`: `string`; `env`: `Partial`\<\{ `SETTLEMINT_ACCESS_TOKEN?`: `string`; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY?`: `string`; `SETTLEMINT_APPLICATION?`: `string`; `SETTLEMINT_BLOCKCHAIN_NETWORK?`: `string`; `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT?`: `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_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`; \}\>; `prod`: `boolean`; `secrets`: `boolean`; \} | The options for writing the environment variables |
|
|
1388
1388
|
| `options.cwd?` | `string` | The directory to start searching for the package.json file from (defaults to process.cwd()) |
|
|
1389
|
-
| `options.env` | `Partial`\<\{ `SETTLEMINT_ACCESS_TOKEN
|
|
1389
|
+
| `options.env` | `Partial`\<\{ `SETTLEMINT_ACCESS_TOKEN?`: `string`; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY?`: `string`; `SETTLEMINT_APPLICATION?`: `string`; `SETTLEMINT_BLOCKCHAIN_NETWORK?`: `string`; `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT?`: `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_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`; \}\> | The environment variables to write |
|
|
1390
1390
|
| `options.prod` | `boolean` | Whether to write production environment variables |
|
|
1391
1391
|
| `options.secrets` | `boolean` | Whether to write to .env.local files for secrets |
|
|
1392
1392
|
|
|
@@ -1428,7 +1428,7 @@ await writeEnv({
|
|
|
1428
1428
|
|
|
1429
1429
|
#### CancelError
|
|
1430
1430
|
|
|
1431
|
-
Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1431
|
+
Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/cancel.ts#L8)
|
|
1432
1432
|
|
|
1433
1433
|
Error class used to indicate that the operation was cancelled.
|
|
1434
1434
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1441,7 +1441,7 @@ This error is used to signal that the operation should be aborted.
|
|
|
1441
1441
|
|
|
1442
1442
|
#### SpinnerError
|
|
1443
1443
|
|
|
1444
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:11](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1444
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:11](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/spinner.ts#L11)
|
|
1445
1445
|
|
|
1446
1446
|
Error class used to indicate that the spinner operation failed.
|
|
1447
1447
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1454,7 +1454,7 @@ This error is used to signal that the operation should be aborted.
|
|
|
1454
1454
|
|
|
1455
1455
|
#### ExecuteCommandOptions
|
|
1456
1456
|
|
|
1457
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1457
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/execute-command.ts#L7)
|
|
1458
1458
|
|
|
1459
1459
|
Options for executing a command, extending SpawnOptionsWithoutStdio
|
|
1460
1460
|
|
|
@@ -1466,13 +1466,13 @@ Options for executing a command, extending SpawnOptionsWithoutStdio
|
|
|
1466
1466
|
|
|
1467
1467
|
| Property | Type | Description | Defined in |
|
|
1468
1468
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.4/sdk/utils/src/terminal/execute-command.ts#L9) |
|
|
1470
1470
|
|
|
1471
1471
|
***
|
|
1472
1472
|
|
|
1473
1473
|
#### Logger
|
|
1474
1474
|
|
|
1475
|
-
Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1475
|
+
Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/logging/logger.ts#L23)
|
|
1476
1476
|
|
|
1477
1477
|
Simple logger interface with basic logging methods
|
|
1478
1478
|
Logger
|
|
@@ -1481,16 +1481,16 @@ Simple logger interface with basic logging methods
|
|
|
1481
1481
|
|
|
1482
1482
|
| Property | Type | Description | Defined in |
|
|
1483
1483
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.4/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.4/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.4/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.4/sdk/utils/src/logging/logger.ts#L29) |
|
|
1488
1488
|
|
|
1489
1489
|
***
|
|
1490
1490
|
|
|
1491
1491
|
#### LoggerOptions
|
|
1492
1492
|
|
|
1493
|
-
Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1493
|
+
Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/logging/logger.ts#L12)
|
|
1494
1494
|
|
|
1495
1495
|
Configuration options for the logger
|
|
1496
1496
|
LoggerOptions
|
|
@@ -1499,14 +1499,14 @@ Configuration options for the logger
|
|
|
1499
1499
|
|
|
1500
1500
|
| Property | Type | Description | Defined in |
|
|
1501
1501
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.4/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.4/sdk/utils/src/logging/logger.ts#L16) |
|
|
1504
1504
|
|
|
1505
1505
|
***
|
|
1506
1506
|
|
|
1507
1507
|
#### SpinnerOptions\<R\>
|
|
1508
1508
|
|
|
1509
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:24](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1509
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:24](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/spinner.ts#L24)
|
|
1510
1510
|
|
|
1511
1511
|
Options for configuring the spinner behavior
|
|
1512
1512
|
|
|
@@ -1520,9 +1520,9 @@ Options for configuring the spinner behavior
|
|
|
1520
1520
|
|
|
1521
1521
|
| Property | Type | Description | Defined in |
|
|
1522
1522
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.4/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.4/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.4/sdk/utils/src/terminal/spinner.ts#L28) |
|
|
1526
1526
|
|
|
1527
1527
|
### Type Aliases
|
|
1528
1528
|
|
|
@@ -1530,7 +1530,7 @@ Options for configuring the spinner behavior
|
|
|
1530
1530
|
|
|
1531
1531
|
> **AccessToken** = `string`
|
|
1532
1532
|
|
|
1533
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1533
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/access-token.schema.ts#L22)
|
|
1534
1534
|
|
|
1535
1535
|
Schema for validating both application and personal access tokens.
|
|
1536
1536
|
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
@@ -1541,7 +1541,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1541
1541
|
|
|
1542
1542
|
> **ApplicationAccessToken** = `string`
|
|
1543
1543
|
|
|
1544
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1544
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/access-token.schema.ts#L8)
|
|
1545
1545
|
|
|
1546
1546
|
Schema for validating application access tokens.
|
|
1547
1547
|
Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -1552,7 +1552,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1552
1552
|
|
|
1553
1553
|
> **DotEnv** = `object`
|
|
1554
1554
|
|
|
1555
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1555
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:97](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L97)
|
|
1556
1556
|
|
|
1557
1557
|
Type definition for the environment variables schema.
|
|
1558
1558
|
|
|
@@ -1560,40 +1560,43 @@ Type definition for the environment variables schema.
|
|
|
1560
1560
|
|
|
1561
1561
|
| Name | Type | Description | Defined in |
|
|
1562
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.
|
|
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:
|
|
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.
|
|
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.
|
|
1567
|
-
| <a id="
|
|
1568
|
-
| <a id="
|
|
1569
|
-
| <a id="
|
|
1570
|
-
| <a id="
|
|
1571
|
-
| <a id="
|
|
1572
|
-
| <a id="
|
|
1573
|
-
| <a id="
|
|
1574
|
-
| <a id="
|
|
1575
|
-
| <a id="
|
|
1576
|
-
| <a id="
|
|
1577
|
-
| <a id="
|
|
1578
|
-
| <a id="
|
|
1579
|
-
| <a id="
|
|
1580
|
-
| <a id="
|
|
1581
|
-
| <a id="
|
|
1582
|
-
| <a id="
|
|
1583
|
-
| <a id="
|
|
1584
|
-
| <a id="
|
|
1585
|
-
| <a id="
|
|
1586
|
-
| <a id="
|
|
1587
|
-
| <a id="
|
|
1588
|
-
| <a id="
|
|
1589
|
-
| <a id="
|
|
1590
|
-
| <a id="
|
|
1591
|
-
| <a id="
|
|
1592
|
-
| <a id="
|
|
1593
|
-
| <a id="
|
|
1594
|
-
| <a id="
|
|
1595
|
-
| <a id="
|
|
1596
|
-
| <a id="
|
|
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.4/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:61](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L61) |
|
|
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.4/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.4/sdk/utils/src/validation/dot-env.schema.ts#L24) |
|
|
1567
|
+
| <a id="settlemint_blockchain_network_chain_id"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID?` | `string` | Chain ID of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:26](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L26) |
|
|
1568
|
+
| <a id="settlemint_blockchain_node"></a> `SETTLEMINT_BLOCKCHAIN_NODE?` | `string` | Unique name of the blockchain node (should have a private key for signing transactions) | [sdk/utils/src/validation/dot-env.schema.ts:28](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L28) |
|
|
1569
|
+
| <a id="settlemint_blockchain_node_json_rpc_endpoint"></a> `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node | [sdk/utils/src/validation/dot-env.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L30) |
|
|
1570
|
+
| <a id="settlemint_blockchain_node_or_load_balancer"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER?` | `string` | Unique name of the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:32](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L32) |
|
|
1571
|
+
| <a id="settlemint_blockchain_node_or_load_balancer_json_rpc_endpoint"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L34) |
|
|
1572
|
+
| <a id="settlemint_blockscout"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:83](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L83) |
|
|
1573
|
+
| <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:85](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L85) |
|
|
1574
|
+
| <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:87](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L87) |
|
|
1575
|
+
| <a id="settlemint_custom_deployment"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT?` | `string` | Unique name of the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:79](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L79) |
|
|
1576
|
+
| <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:81](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L81) |
|
|
1577
|
+
| <a id="settlemint_hasura"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:36](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L36) |
|
|
1578
|
+
| <a id="settlemint_hasura_admin_secret"></a> `SETTLEMINT_HASURA_ADMIN_SECRET?` | `string` | Admin secret for authenticating with Hasura | [sdk/utils/src/validation/dot-env.schema.ts:40](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L40) |
|
|
1579
|
+
| <a id="settlemint_hasura_database_url"></a> `SETTLEMINT_HASURA_DATABASE_URL?` | `string` | Database connection URL for Hasura | [sdk/utils/src/validation/dot-env.schema.ts:42](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L42) |
|
|
1580
|
+
| <a id="settlemint_hasura_endpoint"></a> `SETTLEMINT_HASURA_ENDPOINT?` | `string` | Endpoint URL for the Hasura GraphQL API | [sdk/utils/src/validation/dot-env.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L38) |
|
|
1581
|
+
| <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:59](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L59) |
|
|
1582
|
+
| <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.4/sdk/utils/src/validation/dot-env.schema.ts#L14) |
|
|
1583
|
+
| <a id="settlemint_ipfs"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:71](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L71) |
|
|
1584
|
+
| <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:73](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L73) |
|
|
1585
|
+
| <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:77](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L77) |
|
|
1586
|
+
| <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:75](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L75) |
|
|
1587
|
+
| <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:91](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L91) |
|
|
1588
|
+
| <a id="settlemint_minio"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:63](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L63) |
|
|
1589
|
+
| <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:67](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L67) |
|
|
1590
|
+
| <a id="settlemint_minio_endpoint"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:65](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L65) |
|
|
1591
|
+
| <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:69](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L69) |
|
|
1592
|
+
| <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:89](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L89) |
|
|
1593
|
+
| <a id="settlemint_portal"></a> `SETTLEMINT_PORTAL?` | `string` | Unique name of the Smart Contract Portal instance | [sdk/utils/src/validation/dot-env.schema.ts:53](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L53) |
|
|
1594
|
+
| <a id="settlemint_portal_graphql_endpoint"></a> `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT?` | `string` | GraphQL endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L55) |
|
|
1595
|
+
| <a id="settlemint_portal_rest_endpoint"></a> `SETTLEMINT_PORTAL_REST_ENDPOINT?` | `string` | REST endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:57](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L57) |
|
|
1596
|
+
| <a id="settlemint_thegraph"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:44](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L44) |
|
|
1597
|
+
| <a id="settlemint_thegraph_default_subgraph"></a> `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH?` | `string` | Default The Graph subgraph to use | [sdk/utils/src/validation/dot-env.schema.ts:51](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L51) |
|
|
1598
|
+
| <a id="settlemint_thegraph_subgraphs_endpoints"></a> `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS?` | `string`[] | Array of endpoint URLs for The Graph subgraphs | [sdk/utils/src/validation/dot-env.schema.ts:46](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L46) |
|
|
1599
|
+
| <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.4/sdk/utils/src/validation/dot-env.schema.ts#L20) |
|
|
1597
1600
|
|
|
1598
1601
|
***
|
|
1599
1602
|
|
|
@@ -1601,7 +1604,7 @@ Type definition for the environment variables schema.
|
|
|
1601
1604
|
|
|
1602
1605
|
> **DotEnvPartial** = `object`
|
|
1603
1606
|
|
|
1604
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1607
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:108](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L108)
|
|
1605
1608
|
|
|
1606
1609
|
Type definition for the partial environment variables schema.
|
|
1607
1610
|
|
|
@@ -1609,40 +1612,43 @@ Type definition for the partial environment variables schema.
|
|
|
1609
1612
|
|
|
1610
1613
|
| Name | Type | Description | Defined in |
|
|
1611
1614
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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:
|
|
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.
|
|
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.
|
|
1616
|
-
| <a id="
|
|
1617
|
-
| <a id="
|
|
1618
|
-
| <a id="
|
|
1619
|
-
| <a id="
|
|
1620
|
-
| <a id="
|
|
1621
|
-
| <a id="
|
|
1622
|
-
| <a id="
|
|
1623
|
-
| <a id="
|
|
1624
|
-
| <a id="
|
|
1625
|
-
| <a id="
|
|
1626
|
-
| <a id="
|
|
1627
|
-
| <a id="
|
|
1628
|
-
| <a id="
|
|
1629
|
-
| <a id="
|
|
1630
|
-
| <a id="
|
|
1631
|
-
| <a id="
|
|
1632
|
-
| <a id="
|
|
1633
|
-
| <a id="
|
|
1634
|
-
| <a id="
|
|
1635
|
-
| <a id="
|
|
1636
|
-
| <a id="
|
|
1637
|
-
| <a id="
|
|
1638
|
-
| <a id="
|
|
1639
|
-
| <a id="
|
|
1640
|
-
| <a id="
|
|
1641
|
-
| <a id="
|
|
1642
|
-
| <a id="
|
|
1643
|
-
| <a id="
|
|
1644
|
-
| <a id="
|
|
1645
|
-
| <a id="
|
|
1615
|
+
| <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.4/sdk/utils/src/validation/dot-env.schema.ts#L16) |
|
|
1616
|
+
| <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:61](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L61) |
|
|
1617
|
+
| <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.4/sdk/utils/src/validation/dot-env.schema.ts#L22) |
|
|
1618
|
+
| <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.4/sdk/utils/src/validation/dot-env.schema.ts#L24) |
|
|
1619
|
+
| <a id="settlemint_blockchain_network_chain_id-1"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID?` | `string` | Chain ID of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:26](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L26) |
|
|
1620
|
+
| <a id="settlemint_blockchain_node-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE?` | `string` | Unique name of the blockchain node (should have a private key for signing transactions) | [sdk/utils/src/validation/dot-env.schema.ts:28](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L28) |
|
|
1621
|
+
| <a id="settlemint_blockchain_node_json_rpc_endpoint-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node | [sdk/utils/src/validation/dot-env.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L30) |
|
|
1622
|
+
| <a id="settlemint_blockchain_node_or_load_balancer-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER?` | `string` | Unique name of the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:32](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L32) |
|
|
1623
|
+
| <a id="settlemint_blockchain_node_or_load_balancer_json_rpc_endpoint-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L34) |
|
|
1624
|
+
| <a id="settlemint_blockscout-1"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:83](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L83) |
|
|
1625
|
+
| <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:85](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L85) |
|
|
1626
|
+
| <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:87](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L87) |
|
|
1627
|
+
| <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:79](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L79) |
|
|
1628
|
+
| <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:81](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L81) |
|
|
1629
|
+
| <a id="settlemint_hasura-1"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:36](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L36) |
|
|
1630
|
+
| <a id="settlemint_hasura_admin_secret-1"></a> `SETTLEMINT_HASURA_ADMIN_SECRET?` | `string` | Admin secret for authenticating with Hasura | [sdk/utils/src/validation/dot-env.schema.ts:40](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L40) |
|
|
1631
|
+
| <a id="settlemint_hasura_database_url-1"></a> `SETTLEMINT_HASURA_DATABASE_URL?` | `string` | Database connection URL for Hasura | [sdk/utils/src/validation/dot-env.schema.ts:42](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L42) |
|
|
1632
|
+
| <a id="settlemint_hasura_endpoint-1"></a> `SETTLEMINT_HASURA_ENDPOINT?` | `string` | Endpoint URL for the Hasura GraphQL API | [sdk/utils/src/validation/dot-env.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L38) |
|
|
1633
|
+
| <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:59](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L59) |
|
|
1634
|
+
| <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.4/sdk/utils/src/validation/dot-env.schema.ts#L14) |
|
|
1635
|
+
| <a id="settlemint_ipfs-1"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:71](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L71) |
|
|
1636
|
+
| <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:73](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L73) |
|
|
1637
|
+
| <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:77](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L77) |
|
|
1638
|
+
| <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:75](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L75) |
|
|
1639
|
+
| <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:91](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L91) |
|
|
1640
|
+
| <a id="settlemint_minio-1"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:63](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L63) |
|
|
1641
|
+
| <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:67](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L67) |
|
|
1642
|
+
| <a id="settlemint_minio_endpoint-1"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:65](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L65) |
|
|
1643
|
+
| <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:69](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L69) |
|
|
1644
|
+
| <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:89](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L89) |
|
|
1645
|
+
| <a id="settlemint_portal-1"></a> `SETTLEMINT_PORTAL?` | `string` | Unique name of the Smart Contract Portal instance | [sdk/utils/src/validation/dot-env.schema.ts:53](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L53) |
|
|
1646
|
+
| <a id="settlemint_portal_graphql_endpoint-1"></a> `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT?` | `string` | GraphQL endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L55) |
|
|
1647
|
+
| <a id="settlemint_portal_rest_endpoint-1"></a> `SETTLEMINT_PORTAL_REST_ENDPOINT?` | `string` | REST endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:57](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L57) |
|
|
1648
|
+
| <a id="settlemint_thegraph-1"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:44](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L44) |
|
|
1649
|
+
| <a id="settlemint_thegraph_default_subgraph-1"></a> `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH?` | `string` | Default The Graph subgraph to use | [sdk/utils/src/validation/dot-env.schema.ts:51](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L51) |
|
|
1650
|
+
| <a id="settlemint_thegraph_subgraphs_endpoints-1"></a> `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS?` | `string`[] | Array of endpoint URLs for The Graph subgraphs | [sdk/utils/src/validation/dot-env.schema.ts:46](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L46) |
|
|
1651
|
+
| <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.4/sdk/utils/src/validation/dot-env.schema.ts#L20) |
|
|
1646
1652
|
|
|
1647
1653
|
***
|
|
1648
1654
|
|
|
@@ -1650,7 +1656,7 @@ Type definition for the partial environment variables schema.
|
|
|
1650
1656
|
|
|
1651
1657
|
> **Id** = `string`
|
|
1652
1658
|
|
|
1653
|
-
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1659
|
+
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/id.schema.ts#L30)
|
|
1654
1660
|
|
|
1655
1661
|
Type definition for database IDs, inferred from IdSchema.
|
|
1656
1662
|
Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
|
|
@@ -1661,7 +1667,7 @@ Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
|
|
|
1661
1667
|
|
|
1662
1668
|
> **LogLevel** = `"debug"` \| `"info"` \| `"warn"` \| `"error"` \| `"none"`
|
|
1663
1669
|
|
|
1664
|
-
Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1670
|
+
Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/logging/logger.ts#L6)
|
|
1665
1671
|
|
|
1666
1672
|
Log levels supported by the logger
|
|
1667
1673
|
|
|
@@ -1671,7 +1677,7 @@ Log levels supported by the logger
|
|
|
1671
1677
|
|
|
1672
1678
|
> **PersonalAccessToken** = `string`
|
|
1673
1679
|
|
|
1674
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1680
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/access-token.schema.ts#L15)
|
|
1675
1681
|
|
|
1676
1682
|
Schema for validating personal access tokens.
|
|
1677
1683
|
Personal access tokens start with 'sm_pat_' prefix.
|
|
@@ -1682,7 +1688,7 @@ Personal access tokens start with 'sm_pat_' prefix.
|
|
|
1682
1688
|
|
|
1683
1689
|
> **Url** = `string`
|
|
1684
1690
|
|
|
1685
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1691
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/url.schema.ts#L18)
|
|
1686
1692
|
|
|
1687
1693
|
Schema for validating URLs.
|
|
1688
1694
|
|
|
@@ -1706,7 +1712,7 @@ const isInvalidUrl = UrlSchema.safeParse("not-a-url").success;
|
|
|
1706
1712
|
|
|
1707
1713
|
> **UrlOrPath** = `string`
|
|
1708
1714
|
|
|
1709
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1715
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/url.schema.ts#L55)
|
|
1710
1716
|
|
|
1711
1717
|
Schema that accepts either a full URL or a URL path.
|
|
1712
1718
|
|
|
@@ -1730,7 +1736,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
1730
1736
|
|
|
1731
1737
|
> **UrlPath** = `string`
|
|
1732
1738
|
|
|
1733
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1739
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/url.schema.ts#L38)
|
|
1734
1740
|
|
|
1735
1741
|
Schema for validating URL paths.
|
|
1736
1742
|
|
|
@@ -1754,7 +1760,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
1754
1760
|
|
|
1755
1761
|
> `const` **AccessTokenSchema**: `ZodString`\<[`AccessToken`](#accesstoken)\>
|
|
1756
1762
|
|
|
1757
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1763
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/access-token.schema.ts#L21)
|
|
1758
1764
|
|
|
1759
1765
|
Schema for validating both application and personal access tokens.
|
|
1760
1766
|
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
@@ -1765,7 +1771,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1765
1771
|
|
|
1766
1772
|
> `const` **ApplicationAccessTokenSchema**: `ZodString`\<[`ApplicationAccessToken`](#applicationaccesstoken)\>
|
|
1767
1773
|
|
|
1768
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1774
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/access-token.schema.ts#L7)
|
|
1769
1775
|
|
|
1770
1776
|
Schema for validating application access tokens.
|
|
1771
1777
|
Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -1776,7 +1782,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1776
1782
|
|
|
1777
1783
|
> `const` **DotEnvSchema**: `ZodObject`\<[`DotEnv`](#dotenv)\>
|
|
1778
1784
|
|
|
1779
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:12](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1785
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:12](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L12)
|
|
1780
1786
|
|
|
1781
1787
|
Schema for validating environment variables used by the SettleMint SDK.
|
|
1782
1788
|
Defines validation rules and types for configuration values like URLs,
|
|
@@ -1788,7 +1794,7 @@ access tokens, workspace names, and service endpoints.
|
|
|
1788
1794
|
|
|
1789
1795
|
> `const` **DotEnvSchemaPartial**: `ZodObject`\<[`DotEnvPartial`](#dotenvpartial)\>
|
|
1790
1796
|
|
|
1791
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1797
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:103](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L103)
|
|
1792
1798
|
|
|
1793
1799
|
Partial version of the environment variables schema where all fields are optional.
|
|
1794
1800
|
Useful for validating incomplete configurations during development or build time.
|
|
@@ -1799,7 +1805,7 @@ Useful for validating incomplete configurations during development or build time
|
|
|
1799
1805
|
|
|
1800
1806
|
> `const` **IdSchema**: `ZodUnion`\<[`Id`](#id)\>
|
|
1801
1807
|
|
|
1802
|
-
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1808
|
+
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/id.schema.ts#L17)
|
|
1803
1809
|
|
|
1804
1810
|
Schema for validating database IDs. Accepts both PostgreSQL UUIDs and MongoDB ObjectIDs.
|
|
1805
1811
|
PostgreSQL UUIDs are 32 hexadecimal characters with hyphens (e.g. 123e4567-e89b-12d3-a456-426614174000).
|
|
@@ -1823,7 +1829,7 @@ const isValidObjectId = IdSchema.safeParse("507f1f77bcf86cd799439011").success;
|
|
|
1823
1829
|
|
|
1824
1830
|
> `const` **PersonalAccessTokenSchema**: `ZodString`\<[`PersonalAccessToken`](#personalaccesstoken)\>
|
|
1825
1831
|
|
|
1826
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1832
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/access-token.schema.ts#L14)
|
|
1827
1833
|
|
|
1828
1834
|
Schema for validating personal access tokens.
|
|
1829
1835
|
Personal access tokens start with 'sm_pat_' prefix.
|
|
@@ -1834,7 +1840,7 @@ Personal access tokens start with 'sm_pat_' prefix.
|
|
|
1834
1840
|
|
|
1835
1841
|
> `const` **runsInBrowser**: `boolean` = `isBrowser`
|
|
1836
1842
|
|
|
1837
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1843
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/runtime/ensure-server.ts#L40)
|
|
1838
1844
|
|
|
1839
1845
|
Boolean indicating if code is currently running in a browser environment
|
|
1840
1846
|
|
|
@@ -1844,7 +1850,7 @@ Boolean indicating if code is currently running in a browser environment
|
|
|
1844
1850
|
|
|
1845
1851
|
> `const` **runsOnServer**: `boolean` = `!isBrowser`
|
|
1846
1852
|
|
|
1847
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1853
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/runtime/ensure-server.ts#L45)
|
|
1848
1854
|
|
|
1849
1855
|
Boolean indicating if code is currently running in a server environment
|
|
1850
1856
|
|
|
@@ -1854,7 +1860,7 @@ Boolean indicating if code is currently running in a server environment
|
|
|
1854
1860
|
|
|
1855
1861
|
> `const` **UniqueNameSchema**: `ZodString`
|
|
1856
1862
|
|
|
1857
|
-
Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1863
|
+
Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/unique-name.schema.ts#L19)
|
|
1858
1864
|
|
|
1859
1865
|
Schema for validating unique names used across the SettleMint platform.
|
|
1860
1866
|
Only accepts lowercase alphanumeric characters and hyphens.
|
|
@@ -1880,7 +1886,7 @@ const isInvalidName = UniqueNameSchema.safeParse("My Workspace!").success;
|
|
|
1880
1886
|
|
|
1881
1887
|
> `const` **UrlOrPathSchema**: `ZodUnion`\<[`UrlOrPath`](#urlorpath)\>
|
|
1882
1888
|
|
|
1883
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1889
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/url.schema.ts#L54)
|
|
1884
1890
|
|
|
1885
1891
|
Schema that accepts either a full URL or a URL path.
|
|
1886
1892
|
|
|
@@ -1904,7 +1910,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
1904
1910
|
|
|
1905
1911
|
> `const` **UrlPathSchema**: `ZodString`\<[`UrlPath`](#urlpath)\>
|
|
1906
1912
|
|
|
1907
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1913
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/url.schema.ts#L34)
|
|
1908
1914
|
|
|
1909
1915
|
Schema for validating URL paths.
|
|
1910
1916
|
|
|
@@ -1928,7 +1934,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
1928
1934
|
|
|
1929
1935
|
> `const` **UrlSchema**: `ZodString`\<[`Url`](#url)\>
|
|
1930
1936
|
|
|
1931
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1937
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/url.schema.ts#L17)
|
|
1932
1938
|
|
|
1933
1939
|
Schema for validating URLs.
|
|
1934
1940
|
|