@settlemint/sdk-utils 2.2.2 → 2.2.3-main0f4b90ca
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 +154 -154
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -115,7 +115,7 @@ The SettleMint Utils SDK provides a collection of shared utilities and helper fu
|
|
|
115
115
|
|
|
116
116
|
> **ascii**(): `void`
|
|
117
117
|
|
|
118
|
-
Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.2.
|
|
118
|
+
Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/ascii.ts#L14)
|
|
119
119
|
|
|
120
120
|
Prints the SettleMint ASCII art logo to the console in magenta color.
|
|
121
121
|
Used for CLI branding and visual identification.
|
|
@@ -139,7 +139,7 @@ ascii();
|
|
|
139
139
|
|
|
140
140
|
> **camelCaseToWords**(`s`): `string`
|
|
141
141
|
|
|
142
|
-
Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.2.
|
|
142
|
+
Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/string.ts#L29)
|
|
143
143
|
|
|
144
144
|
Converts a camelCase string to a human-readable string.
|
|
145
145
|
|
|
@@ -170,7 +170,7 @@ const words = camelCaseToWords("camelCaseString");
|
|
|
170
170
|
|
|
171
171
|
> **cancel**(`msg`): `never`
|
|
172
172
|
|
|
173
|
-
Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.2.
|
|
173
|
+
Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/cancel.ts#L23)
|
|
174
174
|
|
|
175
175
|
Displays an error message in red inverse text and throws a CancelError.
|
|
176
176
|
Used to terminate execution with a visible error message.
|
|
@@ -203,7 +203,7 @@ cancel("An error occurred");
|
|
|
203
203
|
|
|
204
204
|
> **capitalizeFirstLetter**(`val`): `string`
|
|
205
205
|
|
|
206
|
-
Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.2.
|
|
206
|
+
Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/string.ts#L13)
|
|
207
207
|
|
|
208
208
|
Capitalizes the first letter of a string.
|
|
209
209
|
|
|
@@ -234,7 +234,7 @@ const capitalized = capitalizeFirstLetter("hello");
|
|
|
234
234
|
|
|
235
235
|
> **createLogger**(`options`): [`Logger`](#logger)
|
|
236
236
|
|
|
237
|
-
Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.2.
|
|
237
|
+
Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/logging/logger.ts#L50)
|
|
238
238
|
|
|
239
239
|
Creates a simple logger with configurable log level
|
|
240
240
|
|
|
@@ -267,7 +267,7 @@ logger.error('Operation failed', new Error('Connection timeout'));
|
|
|
267
267
|
|
|
268
268
|
> **emptyDir**(`dir`): `Promise`\<`void`\>
|
|
269
269
|
|
|
270
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.2.
|
|
270
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/package-manager/download-and-extract.ts#L45)
|
|
271
271
|
|
|
272
272
|
Removes all contents of a directory except the .git folder
|
|
273
273
|
|
|
@@ -295,7 +295,7 @@ await emptyDir("/path/to/dir"); // Removes all contents except .git
|
|
|
295
295
|
|
|
296
296
|
> **ensureBrowser**(): `void`
|
|
297
297
|
|
|
298
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.2.
|
|
298
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/runtime/ensure-server.ts#L31)
|
|
299
299
|
|
|
300
300
|
Ensures that code is running in a browser environment and not on the server.
|
|
301
301
|
|
|
@@ -322,7 +322,7 @@ ensureBrowser();
|
|
|
322
322
|
|
|
323
323
|
> **ensureServer**(): `void`
|
|
324
324
|
|
|
325
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.2.
|
|
325
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/runtime/ensure-server.ts#L13)
|
|
326
326
|
|
|
327
327
|
Ensures that code is running on the server and not in a browser environment.
|
|
328
328
|
|
|
@@ -349,7 +349,7 @@ ensureServer();
|
|
|
349
349
|
|
|
350
350
|
> **executeCommand**(`command`, `args`, `options?`): `Promise`\<`string`[]\>
|
|
351
351
|
|
|
352
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.2.
|
|
352
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/execute-command.ts#L51)
|
|
353
353
|
|
|
354
354
|
Executes a command with the given arguments in a child process.
|
|
355
355
|
Pipes stdin to the child process and captures stdout/stderr output.
|
|
@@ -391,7 +391,7 @@ await executeCommand("npm", ["install"], { silent: true });
|
|
|
391
391
|
|
|
392
392
|
> **exists**(`path`): `Promise`\<`boolean`\>
|
|
393
393
|
|
|
394
|
-
Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.2.
|
|
394
|
+
Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/filesystem/exists.ts#L17)
|
|
395
395
|
|
|
396
396
|
Checks if a file or directory exists at the given path
|
|
397
397
|
|
|
@@ -424,7 +424,7 @@ if (await exists('/path/to/file.txt')) {
|
|
|
424
424
|
|
|
425
425
|
> **extractJsonObject**\<`T`\>(`value`): `null` \| `T`
|
|
426
426
|
|
|
427
|
-
Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.2.
|
|
427
|
+
Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/json.ts#L50)
|
|
428
428
|
|
|
429
429
|
Extracts a JSON object from a string.
|
|
430
430
|
|
|
@@ -467,7 +467,7 @@ const json = extractJsonObject<{ port: number }>(
|
|
|
467
467
|
|
|
468
468
|
> **fetchWithRetry**(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Response`\>
|
|
469
469
|
|
|
470
|
-
Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.2.
|
|
470
|
+
Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/http/fetch-with-retry.ts#L18)
|
|
471
471
|
|
|
472
472
|
Retry an HTTP request with exponential backoff and jitter.
|
|
473
473
|
Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
|
|
@@ -505,7 +505,7 @@ const response = await fetchWithRetry("https://api.example.com/data");
|
|
|
505
505
|
|
|
506
506
|
> **findMonoRepoPackages**(`projectDir`): `Promise`\<`string`[]\>
|
|
507
507
|
|
|
508
|
-
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.2.
|
|
508
|
+
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/filesystem/mono-repo.ts#L59)
|
|
509
509
|
|
|
510
510
|
Finds all packages in a monorepo
|
|
511
511
|
|
|
@@ -536,7 +536,7 @@ console.log(packages); // Output: ["/path/to/your/project/packages/core", "/path
|
|
|
536
536
|
|
|
537
537
|
> **findMonoRepoRoot**(`startDir`): `Promise`\<`null` \| `string`\>
|
|
538
538
|
|
|
539
|
-
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.2.
|
|
539
|
+
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/filesystem/mono-repo.ts#L19)
|
|
540
540
|
|
|
541
541
|
Finds the root directory of a monorepo
|
|
542
542
|
|
|
@@ -567,7 +567,7 @@ console.log(root); // Output: /path/to/your/project/packages/core
|
|
|
567
567
|
|
|
568
568
|
> **formatTargetDir**(`targetDir`): `string`
|
|
569
569
|
|
|
570
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.2.
|
|
570
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/package-manager/download-and-extract.ts#L15)
|
|
571
571
|
|
|
572
572
|
Formats a directory path by removing trailing slashes and whitespace
|
|
573
573
|
|
|
@@ -597,7 +597,7 @@ const formatted = formatTargetDir("/path/to/dir/ "); // "/path/to/dir"
|
|
|
597
597
|
|
|
598
598
|
> **getPackageManager**(`targetDir?`): `Promise`\<`AgentName`\>
|
|
599
599
|
|
|
600
|
-
Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.2.
|
|
600
|
+
Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/package-manager/get-package-manager.ts#L15)
|
|
601
601
|
|
|
602
602
|
Detects the package manager used in the current project
|
|
603
603
|
|
|
@@ -628,7 +628,7 @@ console.log(`Using ${packageManager}`);
|
|
|
628
628
|
|
|
629
629
|
> **getPackageManagerExecutable**(`targetDir?`): `Promise`\<\{ `args`: `string`[]; `command`: `string`; \}\>
|
|
630
630
|
|
|
631
|
-
Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.2.
|
|
631
|
+
Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
|
|
632
632
|
|
|
633
633
|
Retrieves the executable command and arguments for the package manager
|
|
634
634
|
|
|
@@ -659,7 +659,7 @@ console.log(`Using ${command} with args: ${args.join(" ")}`);
|
|
|
659
659
|
|
|
660
660
|
> **graphqlFetchWithRetry**\<`Data`\>(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Data`\>
|
|
661
661
|
|
|
662
|
-
Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.2.
|
|
662
|
+
Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
|
|
663
663
|
|
|
664
664
|
Executes a GraphQL request with automatic retries using exponential backoff and jitter.
|
|
665
665
|
Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
|
|
@@ -718,7 +718,7 @@ const data = await graphqlFetchWithRetry<{ user: { id: string } }>(
|
|
|
718
718
|
|
|
719
719
|
> **installDependencies**(`pkgs`, `cwd?`): `Promise`\<`void`\>
|
|
720
720
|
|
|
721
|
-
Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.2.
|
|
721
|
+
Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/package-manager/install-dependencies.ts#L20)
|
|
722
722
|
|
|
723
723
|
Installs one or more packages as dependencies using the detected package manager
|
|
724
724
|
|
|
@@ -757,7 +757,7 @@ await installDependencies(["express", "cors"]);
|
|
|
757
757
|
|
|
758
758
|
> **intro**(`msg`): `void`
|
|
759
759
|
|
|
760
|
-
Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.2.
|
|
760
|
+
Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/intro.ts#L16)
|
|
761
761
|
|
|
762
762
|
Displays an introductory message in magenta text with padding.
|
|
763
763
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -787,7 +787,7 @@ intro("Starting deployment...");
|
|
|
787
787
|
|
|
788
788
|
> **isEmpty**(`path`): `Promise`\<`boolean`\>
|
|
789
789
|
|
|
790
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.2.
|
|
790
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/package-manager/download-and-extract.ts#L31)
|
|
791
791
|
|
|
792
792
|
Checks if a directory is empty or contains only a .git folder
|
|
793
793
|
|
|
@@ -819,7 +819,7 @@ if (await isEmpty("/path/to/dir")) {
|
|
|
819
819
|
|
|
820
820
|
> **isPackageInstalled**(`name`, `path?`): `Promise`\<`boolean`\>
|
|
821
821
|
|
|
822
|
-
Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.2.
|
|
822
|
+
Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/package-manager/is-package-installed.ts#L17)
|
|
823
823
|
|
|
824
824
|
Checks if a package is installed in the project's dependencies, devDependencies, or peerDependencies.
|
|
825
825
|
|
|
@@ -855,7 +855,7 @@ console.log(`@settlemint/sdk-utils is installed: ${isInstalled}`);
|
|
|
855
855
|
|
|
856
856
|
> **list**(`title`, `items`): `void`
|
|
857
857
|
|
|
858
|
-
Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.2.
|
|
858
|
+
Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/list.ts#L23)
|
|
859
859
|
|
|
860
860
|
Displays a list of items in a formatted manner, supporting nested items.
|
|
861
861
|
|
|
@@ -895,7 +895,7 @@ list("Providers", [
|
|
|
895
895
|
|
|
896
896
|
> **loadEnv**\<`T`\>(`validateEnv`, `prod`, `path`): `Promise`\<`T` *extends* `true` ? `object` : `object`\>
|
|
897
897
|
|
|
898
|
-
Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.2.
|
|
898
|
+
Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/environment/load-env.ts#L25)
|
|
899
899
|
|
|
900
900
|
Loads environment variables from .env files.
|
|
901
901
|
To enable encryption with dotenvx (https://www.dotenvx.com/docs) run `bunx dotenvx encrypt`
|
|
@@ -943,7 +943,7 @@ const rawEnv = await loadEnv(false, false);
|
|
|
943
943
|
|
|
944
944
|
> **maskTokens**(`output`): `string`
|
|
945
945
|
|
|
946
|
-
Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.2.
|
|
946
|
+
Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/logging/mask-tokens.ts#L13)
|
|
947
947
|
|
|
948
948
|
Masks sensitive SettleMint tokens in output text by replacing them with asterisks.
|
|
949
949
|
Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).
|
|
@@ -975,7 +975,7 @@ const masked = maskTokens("Token: sm_pat_****"); // "Token: ***"
|
|
|
975
975
|
|
|
976
976
|
> **note**(`message`, `level`): `void`
|
|
977
977
|
|
|
978
|
-
Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.2.
|
|
978
|
+
Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/note.ts#L21)
|
|
979
979
|
|
|
980
980
|
Displays a note message with optional warning level formatting.
|
|
981
981
|
Regular notes are displayed in normal text, while warnings are shown in yellow.
|
|
@@ -1010,7 +1010,7 @@ note("Low disk space remaining", "warn");
|
|
|
1010
1010
|
|
|
1011
1011
|
> **outro**(`msg`): `void`
|
|
1012
1012
|
|
|
1013
|
-
Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1013
|
+
Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/outro.ts#L16)
|
|
1014
1014
|
|
|
1015
1015
|
Displays a closing message in green inverted text with padding.
|
|
1016
1016
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -1040,7 +1040,7 @@ outro("Deployment completed successfully!");
|
|
|
1040
1040
|
|
|
1041
1041
|
> **projectRoot**(`fallbackToCwd`, `cwd?`): `Promise`\<`string`\>
|
|
1042
1042
|
|
|
1043
|
-
Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1043
|
+
Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/filesystem/project-root.ts#L18)
|
|
1044
1044
|
|
|
1045
1045
|
Finds the root directory of the current project by locating the nearest package.json file
|
|
1046
1046
|
|
|
@@ -1077,7 +1077,7 @@ console.log(`Project root is at: ${rootDir}`);
|
|
|
1077
1077
|
|
|
1078
1078
|
> **replaceUnderscoresAndHyphensWithSpaces**(`s`): `string`
|
|
1079
1079
|
|
|
1080
|
-
Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1080
|
+
Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/string.ts#L48)
|
|
1081
1081
|
|
|
1082
1082
|
Replaces underscores and hyphens with spaces.
|
|
1083
1083
|
|
|
@@ -1108,7 +1108,7 @@ const result = replaceUnderscoresAndHyphensWithSpaces("Already_Spaced-Second");
|
|
|
1108
1108
|
|
|
1109
1109
|
> **requestLogger**(`logger`, `name`, `fn`): (...`args`) => `Promise`\<`Response`\>
|
|
1110
1110
|
|
|
1111
|
-
Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1111
|
+
Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/logging/request-logger.ts#L14)
|
|
1112
1112
|
|
|
1113
1113
|
Logs the request and duration of a fetch call (> 500ms is logged as warn, otherwise info)
|
|
1114
1114
|
|
|
@@ -1142,7 +1142,7 @@ The fetch function
|
|
|
1142
1142
|
|
|
1143
1143
|
> **retryWhenFailed**\<`T`\>(`fn`, `maxRetries`, `initialSleepTime`, `stopOnError?`): `Promise`\<`T`\>
|
|
1144
1144
|
|
|
1145
|
-
Defined in: [sdk/utils/src/retry.ts:14](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1145
|
+
Defined in: [sdk/utils/src/retry.ts:14](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/retry.ts#L14)
|
|
1146
1146
|
|
|
1147
1147
|
Retry a function when it fails.
|
|
1148
1148
|
|
|
@@ -1182,7 +1182,7 @@ const result = await retryWhenFailed(() => readFile("/path/to/file.txt"), 3, 1_0
|
|
|
1182
1182
|
|
|
1183
1183
|
> **setName**(`name`, `path?`): `Promise`\<`void`\>
|
|
1184
1184
|
|
|
1185
|
-
Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1185
|
+
Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/package-manager/set-name.ts#L16)
|
|
1186
1186
|
|
|
1187
1187
|
Sets the name field in the package.json file
|
|
1188
1188
|
|
|
@@ -1217,7 +1217,7 @@ await setName("my-new-project-name");
|
|
|
1217
1217
|
|
|
1218
1218
|
> **spinner**\<`R`\>(`options`): `Promise`\<`R`\>
|
|
1219
1219
|
|
|
1220
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1220
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/spinner.ts#L55)
|
|
1221
1221
|
|
|
1222
1222
|
Displays a loading spinner while executing an async task.
|
|
1223
1223
|
Shows progress with start/stop messages and handles errors.
|
|
@@ -1267,7 +1267,7 @@ const result = await spinner({
|
|
|
1267
1267
|
|
|
1268
1268
|
> **table**(`title`, `data`): `void`
|
|
1269
1269
|
|
|
1270
|
-
Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1270
|
+
Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/table.ts#L21)
|
|
1271
1271
|
|
|
1272
1272
|
Displays data in a formatted table in the terminal.
|
|
1273
1273
|
|
|
@@ -1301,7 +1301,7 @@ table("My Table", data);
|
|
|
1301
1301
|
|
|
1302
1302
|
> **truncate**(`value`, `maxLength`): `string`
|
|
1303
1303
|
|
|
1304
|
-
Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1304
|
+
Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/string.ts#L65)
|
|
1305
1305
|
|
|
1306
1306
|
Truncates a string to a maximum length and appends "..." if it is longer.
|
|
1307
1307
|
|
|
@@ -1333,7 +1333,7 @@ const truncated = truncate("Hello, world!", 10);
|
|
|
1333
1333
|
|
|
1334
1334
|
> **tryParseJson**\<`T`\>(`value`, `defaultValue`): `null` \| `T`
|
|
1335
1335
|
|
|
1336
|
-
Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1336
|
+
Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/json.ts#L23)
|
|
1337
1337
|
|
|
1338
1338
|
Attempts to parse a JSON string into a typed value, returning a default value if parsing fails.
|
|
1339
1339
|
|
|
@@ -1380,7 +1380,7 @@ const invalid = tryParseJson<string[]>(
|
|
|
1380
1380
|
|
|
1381
1381
|
> **validate**\<`T`\>(`schema`, `value`): `T`\[`"_output"`\]
|
|
1382
1382
|
|
|
1383
|
-
Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1383
|
+
Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/validate.ts#L16)
|
|
1384
1384
|
|
|
1385
1385
|
Validates a value against a given Zod schema.
|
|
1386
1386
|
|
|
@@ -1421,7 +1421,7 @@ const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
|
|
|
1421
1421
|
|
|
1422
1422
|
> **writeEnv**(`options`): `Promise`\<`void`\>
|
|
1423
1423
|
|
|
1424
|
-
Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1424
|
+
Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/environment/write-env.ts#L41)
|
|
1425
1425
|
|
|
1426
1426
|
Writes environment variables to .env files across a project or monorepo
|
|
1427
1427
|
|
|
@@ -1473,7 +1473,7 @@ await writeEnv({
|
|
|
1473
1473
|
|
|
1474
1474
|
#### CancelError
|
|
1475
1475
|
|
|
1476
|
-
Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1476
|
+
Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/cancel.ts#L8)
|
|
1477
1477
|
|
|
1478
1478
|
Error class used to indicate that the operation was cancelled.
|
|
1479
1479
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1486,7 +1486,7 @@ This error is used to signal that the operation should be aborted.
|
|
|
1486
1486
|
|
|
1487
1487
|
#### CommandError
|
|
1488
1488
|
|
|
1489
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1489
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/execute-command.ts#L16)
|
|
1490
1490
|
|
|
1491
1491
|
Error class for command execution errors
|
|
1492
1492
|
|
|
@@ -1500,7 +1500,7 @@ Error class for command execution errors
|
|
|
1500
1500
|
|
|
1501
1501
|
> **new CommandError**(`message`, `code`, `output`): [`CommandError`](#commanderror)
|
|
1502
1502
|
|
|
1503
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1503
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/execute-command.ts#L23)
|
|
1504
1504
|
|
|
1505
1505
|
Constructs a new CommandError
|
|
1506
1506
|
|
|
@@ -1526,7 +1526,7 @@ Constructs a new CommandError
|
|
|
1526
1526
|
|
|
1527
1527
|
> `readonly` **code**: `number`
|
|
1528
1528
|
|
|
1529
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1529
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/execute-command.ts#L25)
|
|
1530
1530
|
|
|
1531
1531
|
The exit code of the command
|
|
1532
1532
|
|
|
@@ -1534,7 +1534,7 @@ The exit code of the command
|
|
|
1534
1534
|
|
|
1535
1535
|
> `readonly` **output**: `string`[]
|
|
1536
1536
|
|
|
1537
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1537
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/execute-command.ts#L26)
|
|
1538
1538
|
|
|
1539
1539
|
The output of the command
|
|
1540
1540
|
|
|
@@ -1542,7 +1542,7 @@ The output of the command
|
|
|
1542
1542
|
|
|
1543
1543
|
#### SpinnerError
|
|
1544
1544
|
|
|
1545
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1545
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/spinner.ts#L12)
|
|
1546
1546
|
|
|
1547
1547
|
Error class used to indicate that the spinner operation failed.
|
|
1548
1548
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1555,7 +1555,7 @@ This error is used to signal that the operation should be aborted.
|
|
|
1555
1555
|
|
|
1556
1556
|
#### ExecuteCommandOptions
|
|
1557
1557
|
|
|
1558
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1558
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/execute-command.ts#L7)
|
|
1559
1559
|
|
|
1560
1560
|
Options for executing a command, extending SpawnOptionsWithoutStdio
|
|
1561
1561
|
|
|
@@ -1567,13 +1567,13 @@ Options for executing a command, extending SpawnOptionsWithoutStdio
|
|
|
1567
1567
|
|
|
1568
1568
|
| Property | Type | Description | Defined in |
|
|
1569
1569
|
| ------ | ------ | ------ | ------ |
|
|
1570
|
-
| <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.2.
|
|
1570
|
+
| <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.2.3/sdk/utils/src/terminal/execute-command.ts#L9) |
|
|
1571
1571
|
|
|
1572
1572
|
***
|
|
1573
1573
|
|
|
1574
1574
|
#### Logger
|
|
1575
1575
|
|
|
1576
|
-
Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1576
|
+
Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/logging/logger.ts#L23)
|
|
1577
1577
|
|
|
1578
1578
|
Simple logger interface with basic logging methods
|
|
1579
1579
|
Logger
|
|
@@ -1582,16 +1582,16 @@ Simple logger interface with basic logging methods
|
|
|
1582
1582
|
|
|
1583
1583
|
| Property | Type | Description | Defined in |
|
|
1584
1584
|
| ------ | ------ | ------ | ------ |
|
|
1585
|
-
| <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.2.
|
|
1586
|
-
| <a id="error"></a> `error` | (`message`, ...`args`) => `void` | Log errors | [sdk/utils/src/logging/logger.ts:31](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1587
|
-
| <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.2.
|
|
1588
|
-
| <a id="warn"></a> `warn` | (`message`, ...`args`) => `void` | Log warnings | [sdk/utils/src/logging/logger.ts:29](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1585
|
+
| <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.2.3/sdk/utils/src/logging/logger.ts#L25) |
|
|
1586
|
+
| <a id="error"></a> `error` | (`message`, ...`args`) => `void` | Log errors | [sdk/utils/src/logging/logger.ts:31](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/logging/logger.ts#L31) |
|
|
1587
|
+
| <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.2.3/sdk/utils/src/logging/logger.ts#L27) |
|
|
1588
|
+
| <a id="warn"></a> `warn` | (`message`, ...`args`) => `void` | Log warnings | [sdk/utils/src/logging/logger.ts:29](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/logging/logger.ts#L29) |
|
|
1589
1589
|
|
|
1590
1590
|
***
|
|
1591
1591
|
|
|
1592
1592
|
#### LoggerOptions
|
|
1593
1593
|
|
|
1594
|
-
Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1594
|
+
Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/logging/logger.ts#L12)
|
|
1595
1595
|
|
|
1596
1596
|
Configuration options for the logger
|
|
1597
1597
|
LoggerOptions
|
|
@@ -1600,14 +1600,14 @@ Configuration options for the logger
|
|
|
1600
1600
|
|
|
1601
1601
|
| Property | Type | Description | Defined in |
|
|
1602
1602
|
| ------ | ------ | ------ | ------ |
|
|
1603
|
-
| <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.2.
|
|
1604
|
-
| <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.2.
|
|
1603
|
+
| <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.2.3/sdk/utils/src/logging/logger.ts#L14) |
|
|
1604
|
+
| <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.2.3/sdk/utils/src/logging/logger.ts#L16) |
|
|
1605
1605
|
|
|
1606
1606
|
***
|
|
1607
1607
|
|
|
1608
1608
|
#### SpinnerOptions\<R\>
|
|
1609
1609
|
|
|
1610
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1610
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/terminal/spinner.ts#L25)
|
|
1611
1611
|
|
|
1612
1612
|
Options for configuring the spinner behavior
|
|
1613
1613
|
|
|
@@ -1621,9 +1621,9 @@ Options for configuring the spinner behavior
|
|
|
1621
1621
|
|
|
1622
1622
|
| Property | Type | Description | Defined in |
|
|
1623
1623
|
| ------ | ------ | ------ | ------ |
|
|
1624
|
-
| <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.2.
|
|
1625
|
-
| <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.2.
|
|
1626
|
-
| <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.2.
|
|
1624
|
+
| <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.2.3/sdk/utils/src/terminal/spinner.ts#L27) |
|
|
1625
|
+
| <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.2.3/sdk/utils/src/terminal/spinner.ts#L31) |
|
|
1626
|
+
| <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.2.3/sdk/utils/src/terminal/spinner.ts#L29) |
|
|
1627
1627
|
|
|
1628
1628
|
### Type Aliases
|
|
1629
1629
|
|
|
@@ -1631,7 +1631,7 @@ Options for configuring the spinner behavior
|
|
|
1631
1631
|
|
|
1632
1632
|
> **AccessToken** = `string`
|
|
1633
1633
|
|
|
1634
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1634
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/access-token.schema.ts#L22)
|
|
1635
1635
|
|
|
1636
1636
|
Schema for validating both application and personal access tokens.
|
|
1637
1637
|
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
@@ -1642,7 +1642,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1642
1642
|
|
|
1643
1643
|
> **ApplicationAccessToken** = `string`
|
|
1644
1644
|
|
|
1645
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1645
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/access-token.schema.ts#L8)
|
|
1646
1646
|
|
|
1647
1647
|
Schema for validating application access tokens.
|
|
1648
1648
|
Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -1653,7 +1653,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1653
1653
|
|
|
1654
1654
|
> **DotEnv** = `object`
|
|
1655
1655
|
|
|
1656
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:97](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1656
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:97](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/dot-env.schema.ts#L97)
|
|
1657
1657
|
|
|
1658
1658
|
Type definition for the environment variables schema.
|
|
1659
1659
|
|
|
@@ -1661,43 +1661,43 @@ Type definition for the environment variables schema.
|
|
|
1661
1661
|
|
|
1662
1662
|
| Name | Type | Description | Defined in |
|
|
1663
1663
|
| ------ | ------ | ------ | ------ |
|
|
1664
|
-
| <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.2.
|
|
1665
|
-
| <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.2.
|
|
1666
|
-
| <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.2.
|
|
1667
|
-
| <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.2.
|
|
1668
|
-
| <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.2.
|
|
1669
|
-
| <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.2.
|
|
1670
|
-
| <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.2.
|
|
1671
|
-
| <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.2.
|
|
1672
|
-
| <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.2.
|
|
1673
|
-
| <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.2.
|
|
1674
|
-
| <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.2.
|
|
1675
|
-
| <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.2.
|
|
1676
|
-
| <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.2.
|
|
1677
|
-
| <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.2.
|
|
1678
|
-
| <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.2.
|
|
1679
|
-
| <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.2.
|
|
1680
|
-
| <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.2.
|
|
1681
|
-
| <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.2.
|
|
1682
|
-
| <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.2.
|
|
1683
|
-
| <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.2.
|
|
1684
|
-
| <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.2.
|
|
1685
|
-
| <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.2.
|
|
1686
|
-
| <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.2.
|
|
1687
|
-
| <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.2.
|
|
1688
|
-
| <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.2.
|
|
1689
|
-
| <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.2.
|
|
1690
|
-
| <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.2.
|
|
1691
|
-
| <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.2.
|
|
1692
|
-
| <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.2.
|
|
1693
|
-
| <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.2.
|
|
1694
|
-
| <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.2.
|
|
1695
|
-
| <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.2.
|
|
1696
|
-
| <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.2.
|
|
1697
|
-
| <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.2.
|
|
1698
|
-
| <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.2.
|
|
1699
|
-
| <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.2.
|
|
1700
|
-
| <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.2.
|
|
1664
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L16) |
|
|
1665
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L61) |
|
|
1666
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L22) |
|
|
1667
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L24) |
|
|
1668
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L26) |
|
|
1669
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L28) |
|
|
1670
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L30) |
|
|
1671
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L32) |
|
|
1672
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L34) |
|
|
1673
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L83) |
|
|
1674
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L85) |
|
|
1675
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L87) |
|
|
1676
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L79) |
|
|
1677
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L81) |
|
|
1678
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L36) |
|
|
1679
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L40) |
|
|
1680
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L42) |
|
|
1681
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L38) |
|
|
1682
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L59) |
|
|
1683
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L14) |
|
|
1684
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L71) |
|
|
1685
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L73) |
|
|
1686
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L77) |
|
|
1687
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L75) |
|
|
1688
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L91) |
|
|
1689
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L63) |
|
|
1690
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L67) |
|
|
1691
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L65) |
|
|
1692
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L69) |
|
|
1693
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L89) |
|
|
1694
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L53) |
|
|
1695
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L55) |
|
|
1696
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L57) |
|
|
1697
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L44) |
|
|
1698
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L51) |
|
|
1699
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L46) |
|
|
1700
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L20) |
|
|
1701
1701
|
|
|
1702
1702
|
***
|
|
1703
1703
|
|
|
@@ -1705,7 +1705,7 @@ Type definition for the environment variables schema.
|
|
|
1705
1705
|
|
|
1706
1706
|
> **DotEnvPartial** = `object`
|
|
1707
1707
|
|
|
1708
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:108](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1708
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:108](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/dot-env.schema.ts#L108)
|
|
1709
1709
|
|
|
1710
1710
|
Type definition for the partial environment variables schema.
|
|
1711
1711
|
|
|
@@ -1713,43 +1713,43 @@ Type definition for the partial environment variables schema.
|
|
|
1713
1713
|
|
|
1714
1714
|
| Name | Type | Description | Defined in |
|
|
1715
1715
|
| ------ | ------ | ------ | ------ |
|
|
1716
|
-
| <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.2.
|
|
1717
|
-
| <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.2.
|
|
1718
|
-
| <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.2.
|
|
1719
|
-
| <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.2.
|
|
1720
|
-
| <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.2.
|
|
1721
|
-
| <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.2.
|
|
1722
|
-
| <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.2.
|
|
1723
|
-
| <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.2.
|
|
1724
|
-
| <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.2.
|
|
1725
|
-
| <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.2.
|
|
1726
|
-
| <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.2.
|
|
1727
|
-
| <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.2.
|
|
1728
|
-
| <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.2.
|
|
1729
|
-
| <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.2.
|
|
1730
|
-
| <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.2.
|
|
1731
|
-
| <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.2.
|
|
1732
|
-
| <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.2.
|
|
1733
|
-
| <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.2.
|
|
1734
|
-
| <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.2.
|
|
1735
|
-
| <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.2.
|
|
1736
|
-
| <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.2.
|
|
1737
|
-
| <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.2.
|
|
1738
|
-
| <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.2.
|
|
1739
|
-
| <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.2.
|
|
1740
|
-
| <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.2.
|
|
1741
|
-
| <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.2.
|
|
1742
|
-
| <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.2.
|
|
1743
|
-
| <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.2.
|
|
1744
|
-
| <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.2.
|
|
1745
|
-
| <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.2.
|
|
1746
|
-
| <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.2.
|
|
1747
|
-
| <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.2.
|
|
1748
|
-
| <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.2.
|
|
1749
|
-
| <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.2.
|
|
1750
|
-
| <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.2.
|
|
1751
|
-
| <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.2.
|
|
1752
|
-
| <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.2.
|
|
1716
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L16) |
|
|
1717
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L61) |
|
|
1718
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L22) |
|
|
1719
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L24) |
|
|
1720
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L26) |
|
|
1721
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L28) |
|
|
1722
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L30) |
|
|
1723
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L32) |
|
|
1724
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L34) |
|
|
1725
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L83) |
|
|
1726
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L85) |
|
|
1727
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L87) |
|
|
1728
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L79) |
|
|
1729
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L81) |
|
|
1730
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L36) |
|
|
1731
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L40) |
|
|
1732
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L42) |
|
|
1733
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L38) |
|
|
1734
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L59) |
|
|
1735
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L14) |
|
|
1736
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L71) |
|
|
1737
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L73) |
|
|
1738
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L77) |
|
|
1739
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L75) |
|
|
1740
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L91) |
|
|
1741
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L63) |
|
|
1742
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L67) |
|
|
1743
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L65) |
|
|
1744
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L69) |
|
|
1745
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L89) |
|
|
1746
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L53) |
|
|
1747
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L55) |
|
|
1748
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L57) |
|
|
1749
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L44) |
|
|
1750
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L51) |
|
|
1751
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L46) |
|
|
1752
|
+
| <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.2.3/sdk/utils/src/validation/dot-env.schema.ts#L20) |
|
|
1753
1753
|
|
|
1754
1754
|
***
|
|
1755
1755
|
|
|
@@ -1757,7 +1757,7 @@ Type definition for the partial environment variables schema.
|
|
|
1757
1757
|
|
|
1758
1758
|
> **Id** = `string`
|
|
1759
1759
|
|
|
1760
|
-
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1760
|
+
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/id.schema.ts#L30)
|
|
1761
1761
|
|
|
1762
1762
|
Type definition for database IDs, inferred from IdSchema.
|
|
1763
1763
|
Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
|
|
@@ -1768,7 +1768,7 @@ Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
|
|
|
1768
1768
|
|
|
1769
1769
|
> **LogLevel** = `"debug"` \| `"info"` \| `"warn"` \| `"error"` \| `"none"`
|
|
1770
1770
|
|
|
1771
|
-
Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1771
|
+
Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/logging/logger.ts#L6)
|
|
1772
1772
|
|
|
1773
1773
|
Log levels supported by the logger
|
|
1774
1774
|
|
|
@@ -1778,7 +1778,7 @@ Log levels supported by the logger
|
|
|
1778
1778
|
|
|
1779
1779
|
> **PersonalAccessToken** = `string`
|
|
1780
1780
|
|
|
1781
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1781
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/access-token.schema.ts#L15)
|
|
1782
1782
|
|
|
1783
1783
|
Schema for validating personal access tokens.
|
|
1784
1784
|
Personal access tokens start with 'sm_pat_' prefix.
|
|
@@ -1789,7 +1789,7 @@ Personal access tokens start with 'sm_pat_' prefix.
|
|
|
1789
1789
|
|
|
1790
1790
|
> **Url** = `string`
|
|
1791
1791
|
|
|
1792
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1792
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/url.schema.ts#L18)
|
|
1793
1793
|
|
|
1794
1794
|
Schema for validating URLs.
|
|
1795
1795
|
|
|
@@ -1813,7 +1813,7 @@ const isInvalidUrl = UrlSchema.safeParse("not-a-url").success;
|
|
|
1813
1813
|
|
|
1814
1814
|
> **UrlOrPath** = `string`
|
|
1815
1815
|
|
|
1816
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1816
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/url.schema.ts#L55)
|
|
1817
1817
|
|
|
1818
1818
|
Schema that accepts either a full URL or a URL path.
|
|
1819
1819
|
|
|
@@ -1837,7 +1837,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
1837
1837
|
|
|
1838
1838
|
> **UrlPath** = `string`
|
|
1839
1839
|
|
|
1840
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1840
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/url.schema.ts#L38)
|
|
1841
1841
|
|
|
1842
1842
|
Schema for validating URL paths.
|
|
1843
1843
|
|
|
@@ -1861,7 +1861,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
1861
1861
|
|
|
1862
1862
|
> `const` **AccessTokenSchema**: `ZodString`\<[`AccessToken`](#accesstoken)\>
|
|
1863
1863
|
|
|
1864
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1864
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/access-token.schema.ts#L21)
|
|
1865
1865
|
|
|
1866
1866
|
Schema for validating both application and personal access tokens.
|
|
1867
1867
|
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
@@ -1872,7 +1872,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1872
1872
|
|
|
1873
1873
|
> `const` **ApplicationAccessTokenSchema**: `ZodString`\<[`ApplicationAccessToken`](#applicationaccesstoken)\>
|
|
1874
1874
|
|
|
1875
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1875
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/access-token.schema.ts#L7)
|
|
1876
1876
|
|
|
1877
1877
|
Schema for validating application access tokens.
|
|
1878
1878
|
Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -1883,7 +1883,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1883
1883
|
|
|
1884
1884
|
> `const` **DotEnvSchema**: `ZodObject`\<[`DotEnv`](#dotenv)\>
|
|
1885
1885
|
|
|
1886
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:12](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1886
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:12](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/dot-env.schema.ts#L12)
|
|
1887
1887
|
|
|
1888
1888
|
Schema for validating environment variables used by the SettleMint SDK.
|
|
1889
1889
|
Defines validation rules and types for configuration values like URLs,
|
|
@@ -1895,7 +1895,7 @@ access tokens, workspace names, and service endpoints.
|
|
|
1895
1895
|
|
|
1896
1896
|
> `const` **DotEnvSchemaPartial**: `ZodObject`\<[`DotEnvPartial`](#dotenvpartial)\>
|
|
1897
1897
|
|
|
1898
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:103](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1898
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:103](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/dot-env.schema.ts#L103)
|
|
1899
1899
|
|
|
1900
1900
|
Partial version of the environment variables schema where all fields are optional.
|
|
1901
1901
|
Useful for validating incomplete configurations during development or build time.
|
|
@@ -1906,7 +1906,7 @@ Useful for validating incomplete configurations during development or build time
|
|
|
1906
1906
|
|
|
1907
1907
|
> `const` **IdSchema**: `ZodUnion`\<[`Id`](#id)\>
|
|
1908
1908
|
|
|
1909
|
-
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1909
|
+
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/id.schema.ts#L17)
|
|
1910
1910
|
|
|
1911
1911
|
Schema for validating database IDs. Accepts both PostgreSQL UUIDs and MongoDB ObjectIDs.
|
|
1912
1912
|
PostgreSQL UUIDs are 32 hexadecimal characters with hyphens (e.g. 123e4567-e89b-12d3-a456-426614174000).
|
|
@@ -1930,7 +1930,7 @@ const isValidObjectId = IdSchema.safeParse("507f1f77bcf86cd799439011").success;
|
|
|
1930
1930
|
|
|
1931
1931
|
> `const` **PersonalAccessTokenSchema**: `ZodString`\<[`PersonalAccessToken`](#personalaccesstoken)\>
|
|
1932
1932
|
|
|
1933
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1933
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/access-token.schema.ts#L14)
|
|
1934
1934
|
|
|
1935
1935
|
Schema for validating personal access tokens.
|
|
1936
1936
|
Personal access tokens start with 'sm_pat_' prefix.
|
|
@@ -1941,7 +1941,7 @@ Personal access tokens start with 'sm_pat_' prefix.
|
|
|
1941
1941
|
|
|
1942
1942
|
> `const` **runsInBrowser**: `boolean` = `isBrowser`
|
|
1943
1943
|
|
|
1944
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1944
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/runtime/ensure-server.ts#L40)
|
|
1945
1945
|
|
|
1946
1946
|
Boolean indicating if code is currently running in a browser environment
|
|
1947
1947
|
|
|
@@ -1951,7 +1951,7 @@ Boolean indicating if code is currently running in a browser environment
|
|
|
1951
1951
|
|
|
1952
1952
|
> `const` **runsOnServer**: `boolean` = `!isBrowser`
|
|
1953
1953
|
|
|
1954
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1954
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/runtime/ensure-server.ts#L45)
|
|
1955
1955
|
|
|
1956
1956
|
Boolean indicating if code is currently running in a server environment
|
|
1957
1957
|
|
|
@@ -1961,7 +1961,7 @@ Boolean indicating if code is currently running in a server environment
|
|
|
1961
1961
|
|
|
1962
1962
|
> `const` **UniqueNameSchema**: `ZodString`
|
|
1963
1963
|
|
|
1964
|
-
Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1964
|
+
Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/unique-name.schema.ts#L19)
|
|
1965
1965
|
|
|
1966
1966
|
Schema for validating unique names used across the SettleMint platform.
|
|
1967
1967
|
Only accepts lowercase alphanumeric characters and hyphens.
|
|
@@ -1987,7 +1987,7 @@ const isInvalidName = UniqueNameSchema.safeParse("My Workspace!").success;
|
|
|
1987
1987
|
|
|
1988
1988
|
> `const` **UrlOrPathSchema**: `ZodUnion`\<[`UrlOrPath`](#urlorpath)\>
|
|
1989
1989
|
|
|
1990
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.2.
|
|
1990
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/url.schema.ts#L54)
|
|
1991
1991
|
|
|
1992
1992
|
Schema that accepts either a full URL or a URL path.
|
|
1993
1993
|
|
|
@@ -2011,7 +2011,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
2011
2011
|
|
|
2012
2012
|
> `const` **UrlPathSchema**: `ZodString`\<[`UrlPath`](#urlpath)\>
|
|
2013
2013
|
|
|
2014
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.2.
|
|
2014
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/url.schema.ts#L34)
|
|
2015
2015
|
|
|
2016
2016
|
Schema for validating URL paths.
|
|
2017
2017
|
|
|
@@ -2035,7 +2035,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
2035
2035
|
|
|
2036
2036
|
> `const` **UrlSchema**: `ZodString`\<[`Url`](#url)\>
|
|
2037
2037
|
|
|
2038
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.2.
|
|
2038
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/utils/src/validation/url.schema.ts#L17)
|
|
2039
2039
|
|
|
2040
2040
|
Schema for validating URLs.
|
|
2041
2041
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@settlemint/sdk-utils",
|
|
3
3
|
"description": "Shared utilities and helper functions for SettleMint SDK modules",
|
|
4
|
-
"version": "2.2.
|
|
4
|
+
"version": "2.2.3-main0f4b90ca",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"private": false,
|
|
7
7
|
"license": "FSL-1.1-MIT",
|
|
@@ -66,7 +66,7 @@
|
|
|
66
66
|
"is-in-ci": "^1",
|
|
67
67
|
"@antfu/install-pkg": "^1",
|
|
68
68
|
"@dotenvx/dotenvx": "^1",
|
|
69
|
-
"@manypkg/find-root": "^
|
|
69
|
+
"@manypkg/find-root": "^3.0.0",
|
|
70
70
|
"@npmcli/package-json": "^6",
|
|
71
71
|
"console-table-printer": "^2",
|
|
72
72
|
"deepmerge-ts": "^7",
|