@settlemint/sdk-utils 2.1.4 → 2.1.5-pr9382b4f5
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 +252 -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/filesystem.cjs.map +1 -1
- package/dist/filesystem.mjs.map +1 -1
- package/dist/index.cjs +12 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +16 -1
- package/dist/index.d.ts +16 -1
- package/dist/index.mjs +11 -0
- package/dist/index.mjs.map +1 -1
- package/dist/package-manager.cjs +8 -0
- package/dist/package-manager.cjs.map +1 -1
- package/dist/package-manager.mjs +8 -0
- package/dist/package-manager.mjs.map +1 -1
- package/dist/terminal.cjs +48 -6
- package/dist/terminal.cjs.map +1 -1
- package/dist/terminal.d.cts +17 -2
- package/dist/terminal.d.ts +17 -2
- package/dist/terminal.mjs +47 -6
- package/dist/terminal.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
|
@@ -39,6 +39,7 @@
|
|
|
39
39
|
- [ensureServer()](#ensureserver)
|
|
40
40
|
- [executeCommand()](#executecommand)
|
|
41
41
|
- [exists()](#exists)
|
|
42
|
+
- [extractJsonObject()](#extractjsonobject)
|
|
42
43
|
- [fetchWithRetry()](#fetchwithretry)
|
|
43
44
|
- [findMonoRepoPackages()](#findmonorepopackages)
|
|
44
45
|
- [findMonoRepoRoot()](#findmonoreporoot)
|
|
@@ -68,6 +69,7 @@
|
|
|
68
69
|
- [writeEnv()](#writeenv)
|
|
69
70
|
- [Classes](#classes)
|
|
70
71
|
- [CancelError](#cancelerror)
|
|
72
|
+
- [CommandError](#commanderror)
|
|
71
73
|
- [SpinnerError](#spinnererror)
|
|
72
74
|
- [Interfaces](#interfaces)
|
|
73
75
|
- [ExecuteCommandOptions](#executecommandoptions)
|
|
@@ -113,7 +115,7 @@ The SettleMint Utils SDK provides a collection of shared utilities and helper fu
|
|
|
113
115
|
|
|
114
116
|
> **ascii**(): `void`
|
|
115
117
|
|
|
116
|
-
Defined in: [sdk/utils/src/terminal/ascii.ts:
|
|
118
|
+
Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/ascii.ts#L14)
|
|
117
119
|
|
|
118
120
|
Prints the SettleMint ASCII art logo to the console in magenta color.
|
|
119
121
|
Used for CLI branding and visual identification.
|
|
@@ -137,7 +139,7 @@ ascii();
|
|
|
137
139
|
|
|
138
140
|
> **camelCaseToWords**(`s`): `string`
|
|
139
141
|
|
|
140
|
-
Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.1.
|
|
142
|
+
Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/string.ts#L29)
|
|
141
143
|
|
|
142
144
|
Converts a camelCase string to a human-readable string.
|
|
143
145
|
|
|
@@ -168,7 +170,7 @@ const words = camelCaseToWords("camelCaseString");
|
|
|
168
170
|
|
|
169
171
|
> **cancel**(`msg`): `never`
|
|
170
172
|
|
|
171
|
-
Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.1.
|
|
173
|
+
Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/cancel.ts#L23)
|
|
172
174
|
|
|
173
175
|
Displays an error message in red inverse text and throws a CancelError.
|
|
174
176
|
Used to terminate execution with a visible error message.
|
|
@@ -201,7 +203,7 @@ cancel("An error occurred");
|
|
|
201
203
|
|
|
202
204
|
> **capitalizeFirstLetter**(`val`): `string`
|
|
203
205
|
|
|
204
|
-
Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.1.
|
|
206
|
+
Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/string.ts#L13)
|
|
205
207
|
|
|
206
208
|
Capitalizes the first letter of a string.
|
|
207
209
|
|
|
@@ -232,7 +234,7 @@ const capitalized = capitalizeFirstLetter("hello");
|
|
|
232
234
|
|
|
233
235
|
> **createLogger**(`options`): [`Logger`](#logger)
|
|
234
236
|
|
|
235
|
-
Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.1.
|
|
237
|
+
Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/logging/logger.ts#L50)
|
|
236
238
|
|
|
237
239
|
Creates a simple logger with configurable log level
|
|
238
240
|
|
|
@@ -265,7 +267,7 @@ logger.error('Operation failed', new Error('Connection timeout'));
|
|
|
265
267
|
|
|
266
268
|
> **emptyDir**(`dir`): `Promise`\<`void`\>
|
|
267
269
|
|
|
268
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.1.
|
|
270
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/package-manager/download-and-extract.ts#L45)
|
|
269
271
|
|
|
270
272
|
Removes all contents of a directory except the .git folder
|
|
271
273
|
|
|
@@ -293,7 +295,7 @@ await emptyDir("/path/to/dir"); // Removes all contents except .git
|
|
|
293
295
|
|
|
294
296
|
> **ensureBrowser**(): `void`
|
|
295
297
|
|
|
296
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.1.
|
|
298
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/runtime/ensure-server.ts#L31)
|
|
297
299
|
|
|
298
300
|
Ensures that code is running in a browser environment and not on the server.
|
|
299
301
|
|
|
@@ -320,7 +322,7 @@ ensureBrowser();
|
|
|
320
322
|
|
|
321
323
|
> **ensureServer**(): `void`
|
|
322
324
|
|
|
323
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.1.
|
|
325
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/runtime/ensure-server.ts#L13)
|
|
324
326
|
|
|
325
327
|
Ensures that code is running on the server and not in a browser environment.
|
|
326
328
|
|
|
@@ -347,7 +349,7 @@ ensureServer();
|
|
|
347
349
|
|
|
348
350
|
> **executeCommand**(`command`, `args`, `options?`): `Promise`\<`string`[]\>
|
|
349
351
|
|
|
350
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:
|
|
352
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/execute-command.ts#L51)
|
|
351
353
|
|
|
352
354
|
Executes a command with the given arguments in a child process.
|
|
353
355
|
Pipes stdin to the child process and captures stdout/stderr output.
|
|
@@ -389,7 +391,7 @@ await executeCommand("npm", ["install"], { silent: true });
|
|
|
389
391
|
|
|
390
392
|
> **exists**(`path`): `Promise`\<`boolean`\>
|
|
391
393
|
|
|
392
|
-
Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.1.
|
|
394
|
+
Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/filesystem/exists.ts#L17)
|
|
393
395
|
|
|
394
396
|
Checks if a file or directory exists at the given path
|
|
395
397
|
|
|
@@ -418,11 +420,54 @@ if (await exists('/path/to/file.txt')) {
|
|
|
418
420
|
|
|
419
421
|
***
|
|
420
422
|
|
|
423
|
+
#### extractJsonObject()
|
|
424
|
+
|
|
425
|
+
> **extractJsonObject**\<`T`\>(`value`): `null` \| `T`
|
|
426
|
+
|
|
427
|
+
Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/json.ts#L50)
|
|
428
|
+
|
|
429
|
+
Extracts a JSON object from a string.
|
|
430
|
+
|
|
431
|
+
##### Type Parameters
|
|
432
|
+
|
|
433
|
+
| Type Parameter |
|
|
434
|
+
| ------ |
|
|
435
|
+
| `T` |
|
|
436
|
+
|
|
437
|
+
##### Parameters
|
|
438
|
+
|
|
439
|
+
| Parameter | Type | Description |
|
|
440
|
+
| ------ | ------ | ------ |
|
|
441
|
+
| `value` | `string` | The string to extract the JSON object from |
|
|
442
|
+
|
|
443
|
+
##### Returns
|
|
444
|
+
|
|
445
|
+
`null` \| `T`
|
|
446
|
+
|
|
447
|
+
The parsed JSON object, or null if no JSON object is found
|
|
448
|
+
|
|
449
|
+
##### Throws
|
|
450
|
+
|
|
451
|
+
If the input string is too long (longer than 5000 characters)
|
|
452
|
+
|
|
453
|
+
##### Example
|
|
454
|
+
|
|
455
|
+
```ts
|
|
456
|
+
import { extractJsonObject } from "@settlemint/sdk-utils";
|
|
457
|
+
|
|
458
|
+
const json = extractJsonObject<{ port: number }>(
|
|
459
|
+
'port info: {"port": 3000}',
|
|
460
|
+
);
|
|
461
|
+
// Returns: { port: 3000 }
|
|
462
|
+
```
|
|
463
|
+
|
|
464
|
+
***
|
|
465
|
+
|
|
421
466
|
#### fetchWithRetry()
|
|
422
467
|
|
|
423
468
|
> **fetchWithRetry**(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Response`\>
|
|
424
469
|
|
|
425
|
-
Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.1.
|
|
470
|
+
Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/http/fetch-with-retry.ts#L18)
|
|
426
471
|
|
|
427
472
|
Retry an HTTP request with exponential backoff and jitter.
|
|
428
473
|
Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
|
|
@@ -460,7 +505,7 @@ const response = await fetchWithRetry("https://api.example.com/data");
|
|
|
460
505
|
|
|
461
506
|
> **findMonoRepoPackages**(`projectDir`): `Promise`\<`string`[]\>
|
|
462
507
|
|
|
463
|
-
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.1.
|
|
508
|
+
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/filesystem/mono-repo.ts#L59)
|
|
464
509
|
|
|
465
510
|
Finds all packages in a monorepo
|
|
466
511
|
|
|
@@ -491,7 +536,7 @@ console.log(packages); // Output: ["/path/to/your/project/packages/core", "/path
|
|
|
491
536
|
|
|
492
537
|
> **findMonoRepoRoot**(`startDir`): `Promise`\<`null` \| `string`\>
|
|
493
538
|
|
|
494
|
-
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.1.
|
|
539
|
+
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/filesystem/mono-repo.ts#L19)
|
|
495
540
|
|
|
496
541
|
Finds the root directory of a monorepo
|
|
497
542
|
|
|
@@ -522,7 +567,7 @@ console.log(root); // Output: /path/to/your/project/packages/core
|
|
|
522
567
|
|
|
523
568
|
> **formatTargetDir**(`targetDir`): `string`
|
|
524
569
|
|
|
525
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.1.
|
|
570
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/package-manager/download-and-extract.ts#L15)
|
|
526
571
|
|
|
527
572
|
Formats a directory path by removing trailing slashes and whitespace
|
|
528
573
|
|
|
@@ -552,7 +597,7 @@ const formatted = formatTargetDir("/path/to/dir/ "); // "/path/to/dir"
|
|
|
552
597
|
|
|
553
598
|
> **getPackageManager**(`targetDir?`): `Promise`\<`AgentName`\>
|
|
554
599
|
|
|
555
|
-
Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.1.
|
|
600
|
+
Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/package-manager/get-package-manager.ts#L15)
|
|
556
601
|
|
|
557
602
|
Detects the package manager used in the current project
|
|
558
603
|
|
|
@@ -583,7 +628,7 @@ console.log(`Using ${packageManager}`);
|
|
|
583
628
|
|
|
584
629
|
> **getPackageManagerExecutable**(`targetDir?`): `Promise`\<\{ `args`: `string`[]; `command`: `string`; \}\>
|
|
585
630
|
|
|
586
|
-
Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.1.
|
|
631
|
+
Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
|
|
587
632
|
|
|
588
633
|
Retrieves the executable command and arguments for the package manager
|
|
589
634
|
|
|
@@ -614,7 +659,7 @@ console.log(`Using ${command} with args: ${args.join(" ")}`);
|
|
|
614
659
|
|
|
615
660
|
> **graphqlFetchWithRetry**\<`Data`\>(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Data`\>
|
|
616
661
|
|
|
617
|
-
Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.1.
|
|
662
|
+
Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
|
|
618
663
|
|
|
619
664
|
Executes a GraphQL request with automatic retries using exponential backoff and jitter.
|
|
620
665
|
Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
|
|
@@ -673,7 +718,7 @@ const data = await graphqlFetchWithRetry<{ user: { id: string } }>(
|
|
|
673
718
|
|
|
674
719
|
> **installDependencies**(`pkgs`, `cwd?`): `Promise`\<`void`\>
|
|
675
720
|
|
|
676
|
-
Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.1.
|
|
721
|
+
Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/package-manager/install-dependencies.ts#L20)
|
|
677
722
|
|
|
678
723
|
Installs one or more packages as dependencies using the detected package manager
|
|
679
724
|
|
|
@@ -712,7 +757,7 @@ await installDependencies(["express", "cors"]);
|
|
|
712
757
|
|
|
713
758
|
> **intro**(`msg`): `void`
|
|
714
759
|
|
|
715
|
-
Defined in: [sdk/utils/src/terminal/intro.ts:
|
|
760
|
+
Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/intro.ts#L16)
|
|
716
761
|
|
|
717
762
|
Displays an introductory message in magenta text with padding.
|
|
718
763
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -742,7 +787,7 @@ intro("Starting deployment...");
|
|
|
742
787
|
|
|
743
788
|
> **isEmpty**(`path`): `Promise`\<`boolean`\>
|
|
744
789
|
|
|
745
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.1.
|
|
790
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/package-manager/download-and-extract.ts#L31)
|
|
746
791
|
|
|
747
792
|
Checks if a directory is empty or contains only a .git folder
|
|
748
793
|
|
|
@@ -774,7 +819,7 @@ if (await isEmpty("/path/to/dir")) {
|
|
|
774
819
|
|
|
775
820
|
> **isPackageInstalled**(`name`, `path?`): `Promise`\<`boolean`\>
|
|
776
821
|
|
|
777
|
-
Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.1.
|
|
822
|
+
Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/package-manager/is-package-installed.ts#L17)
|
|
778
823
|
|
|
779
824
|
Checks if a package is installed in the project's dependencies, devDependencies, or peerDependencies.
|
|
780
825
|
|
|
@@ -810,7 +855,7 @@ console.log(`@settlemint/sdk-utils is installed: ${isInstalled}`);
|
|
|
810
855
|
|
|
811
856
|
> **list**(`title`, `items`): `void`
|
|
812
857
|
|
|
813
|
-
Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.1.
|
|
858
|
+
Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/list.ts#L23)
|
|
814
859
|
|
|
815
860
|
Displays a list of items in a formatted manner, supporting nested items.
|
|
816
861
|
|
|
@@ -850,7 +895,7 @@ list("Providers", [
|
|
|
850
895
|
|
|
851
896
|
> **loadEnv**\<`T`\>(`validateEnv`, `prod`, `path`): `Promise`\<`T` *extends* `true` ? `object` : `object`\>
|
|
852
897
|
|
|
853
|
-
Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.1.
|
|
898
|
+
Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/environment/load-env.ts#L25)
|
|
854
899
|
|
|
855
900
|
Loads environment variables from .env files.
|
|
856
901
|
To enable encryption with dotenvx (https://www.dotenvx.com/docs) run `bunx dotenvx encrypt`
|
|
@@ -898,7 +943,7 @@ const rawEnv = await loadEnv(false, false);
|
|
|
898
943
|
|
|
899
944
|
> **maskTokens**(`output`): `string`
|
|
900
945
|
|
|
901
|
-
Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.1.
|
|
946
|
+
Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/logging/mask-tokens.ts#L13)
|
|
902
947
|
|
|
903
948
|
Masks sensitive SettleMint tokens in output text by replacing them with asterisks.
|
|
904
949
|
Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).
|
|
@@ -930,7 +975,7 @@ const masked = maskTokens("Token: sm_pat_****"); // "Token: ***"
|
|
|
930
975
|
|
|
931
976
|
> **note**(`message`, `level`): `void`
|
|
932
977
|
|
|
933
|
-
Defined in: [sdk/utils/src/terminal/note.ts:
|
|
978
|
+
Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/note.ts#L21)
|
|
934
979
|
|
|
935
980
|
Displays a note message with optional warning level formatting.
|
|
936
981
|
Regular notes are displayed in normal text, while warnings are shown in yellow.
|
|
@@ -965,7 +1010,7 @@ note("Low disk space remaining", "warn");
|
|
|
965
1010
|
|
|
966
1011
|
> **outro**(`msg`): `void`
|
|
967
1012
|
|
|
968
|
-
Defined in: [sdk/utils/src/terminal/outro.ts:
|
|
1013
|
+
Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/outro.ts#L16)
|
|
969
1014
|
|
|
970
1015
|
Displays a closing message in green inverted text with padding.
|
|
971
1016
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -995,7 +1040,7 @@ outro("Deployment completed successfully!");
|
|
|
995
1040
|
|
|
996
1041
|
> **projectRoot**(`fallbackToCwd`, `cwd?`): `Promise`\<`string`\>
|
|
997
1042
|
|
|
998
|
-
Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1043
|
+
Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/filesystem/project-root.ts#L18)
|
|
999
1044
|
|
|
1000
1045
|
Finds the root directory of the current project by locating the nearest package.json file
|
|
1001
1046
|
|
|
@@ -1032,7 +1077,7 @@ console.log(`Project root is at: ${rootDir}`);
|
|
|
1032
1077
|
|
|
1033
1078
|
> **replaceUnderscoresAndHyphensWithSpaces**(`s`): `string`
|
|
1034
1079
|
|
|
1035
|
-
Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1080
|
+
Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/string.ts#L48)
|
|
1036
1081
|
|
|
1037
1082
|
Replaces underscores and hyphens with spaces.
|
|
1038
1083
|
|
|
@@ -1063,7 +1108,7 @@ const result = replaceUnderscoresAndHyphensWithSpaces("Already_Spaced-Second");
|
|
|
1063
1108
|
|
|
1064
1109
|
> **requestLogger**(`logger`, `name`, `fn`): (...`args`) => `Promise`\<`Response`\>
|
|
1065
1110
|
|
|
1066
|
-
Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1111
|
+
Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/logging/request-logger.ts#L14)
|
|
1067
1112
|
|
|
1068
1113
|
Logs the request and duration of a fetch call (> 500ms is logged as warn, otherwise info)
|
|
1069
1114
|
|
|
@@ -1097,7 +1142,7 @@ The fetch function
|
|
|
1097
1142
|
|
|
1098
1143
|
> **retryWhenFailed**\<`T`\>(`fn`, `maxRetries`, `initialSleepTime`, `stopOnError?`): `Promise`\<`T`\>
|
|
1099
1144
|
|
|
1100
|
-
Defined in: [sdk/utils/src/retry.ts:14](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1145
|
+
Defined in: [sdk/utils/src/retry.ts:14](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/retry.ts#L14)
|
|
1101
1146
|
|
|
1102
1147
|
Retry a function when it fails.
|
|
1103
1148
|
|
|
@@ -1137,7 +1182,7 @@ const result = await retryWhenFailed(() => readFile("/path/to/file.txt"), 3, 1_0
|
|
|
1137
1182
|
|
|
1138
1183
|
> **setName**(`name`, `path?`): `Promise`\<`void`\>
|
|
1139
1184
|
|
|
1140
|
-
Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1185
|
+
Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/package-manager/set-name.ts#L16)
|
|
1141
1186
|
|
|
1142
1187
|
Sets the name field in the package.json file
|
|
1143
1188
|
|
|
@@ -1172,7 +1217,7 @@ await setName("my-new-project-name");
|
|
|
1172
1217
|
|
|
1173
1218
|
> **spinner**\<`R`\>(`options`): `Promise`\<`R`\>
|
|
1174
1219
|
|
|
1175
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:
|
|
1220
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/spinner.ts#L55)
|
|
1176
1221
|
|
|
1177
1222
|
Displays a loading spinner while executing an async task.
|
|
1178
1223
|
Shows progress with start/stop messages and handles errors.
|
|
@@ -1222,7 +1267,7 @@ const result = await spinner({
|
|
|
1222
1267
|
|
|
1223
1268
|
> **table**(`title`, `data`): `void`
|
|
1224
1269
|
|
|
1225
|
-
Defined in: [sdk/utils/src/terminal/table.ts:
|
|
1270
|
+
Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/table.ts#L21)
|
|
1226
1271
|
|
|
1227
1272
|
Displays data in a formatted table in the terminal.
|
|
1228
1273
|
|
|
@@ -1256,7 +1301,7 @@ table("My Table", data);
|
|
|
1256
1301
|
|
|
1257
1302
|
> **truncate**(`value`, `maxLength`): `string`
|
|
1258
1303
|
|
|
1259
|
-
Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1304
|
+
Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/string.ts#L65)
|
|
1260
1305
|
|
|
1261
1306
|
Truncates a string to a maximum length and appends "..." if it is longer.
|
|
1262
1307
|
|
|
@@ -1288,7 +1333,7 @@ const truncated = truncate("Hello, world!", 10);
|
|
|
1288
1333
|
|
|
1289
1334
|
> **tryParseJson**\<`T`\>(`value`, `defaultValue`): `null` \| `T`
|
|
1290
1335
|
|
|
1291
|
-
Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1336
|
+
Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/json.ts#L23)
|
|
1292
1337
|
|
|
1293
1338
|
Attempts to parse a JSON string into a typed value, returning a default value if parsing fails.
|
|
1294
1339
|
|
|
@@ -1335,7 +1380,7 @@ const invalid = tryParseJson<string[]>(
|
|
|
1335
1380
|
|
|
1336
1381
|
> **validate**\<`T`\>(`schema`, `value`): `T`\[`"_output"`\]
|
|
1337
1382
|
|
|
1338
|
-
Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1383
|
+
Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/validate.ts#L16)
|
|
1339
1384
|
|
|
1340
1385
|
Validates a value against a given Zod schema.
|
|
1341
1386
|
|
|
@@ -1376,7 +1421,7 @@ const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
|
|
|
1376
1421
|
|
|
1377
1422
|
> **writeEnv**(`options`): `Promise`\<`void`\>
|
|
1378
1423
|
|
|
1379
|
-
Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1424
|
+
Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/environment/write-env.ts#L41)
|
|
1380
1425
|
|
|
1381
1426
|
Writes environment variables to .env files across a project or monorepo
|
|
1382
1427
|
|
|
@@ -1384,9 +1429,9 @@ Writes environment variables to .env files across a project or monorepo
|
|
|
1384
1429
|
|
|
1385
1430
|
| Parameter | Type | Description |
|
|
1386
1431
|
| ------ | ------ | ------ |
|
|
1387
|
-
| `options` | \{ `cwd
|
|
1432
|
+
| `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
1433
|
| `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
|
|
1434
|
+
| `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
1435
|
| `options.prod` | `boolean` | Whether to write production environment variables |
|
|
1391
1436
|
| `options.secrets` | `boolean` | Whether to write to .env.local files for secrets |
|
|
1392
1437
|
|
|
@@ -1428,7 +1473,7 @@ await writeEnv({
|
|
|
1428
1473
|
|
|
1429
1474
|
#### CancelError
|
|
1430
1475
|
|
|
1431
|
-
Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1476
|
+
Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/cancel.ts#L8)
|
|
1432
1477
|
|
|
1433
1478
|
Error class used to indicate that the operation was cancelled.
|
|
1434
1479
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1439,9 +1484,65 @@ This error is used to signal that the operation should be aborted.
|
|
|
1439
1484
|
|
|
1440
1485
|
***
|
|
1441
1486
|
|
|
1487
|
+
#### CommandError
|
|
1488
|
+
|
|
1489
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/execute-command.ts#L16)
|
|
1490
|
+
|
|
1491
|
+
Error class for command execution errors
|
|
1492
|
+
|
|
1493
|
+
##### Extends
|
|
1494
|
+
|
|
1495
|
+
- `Error`
|
|
1496
|
+
|
|
1497
|
+
##### Constructors
|
|
1498
|
+
|
|
1499
|
+
###### Constructor
|
|
1500
|
+
|
|
1501
|
+
> **new CommandError**(`message`, `code`, `output`): [`CommandError`](#commanderror)
|
|
1502
|
+
|
|
1503
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/execute-command.ts#L23)
|
|
1504
|
+
|
|
1505
|
+
Constructs a new CommandError
|
|
1506
|
+
|
|
1507
|
+
###### Parameters
|
|
1508
|
+
|
|
1509
|
+
| Parameter | Type | Description |
|
|
1510
|
+
| ------ | ------ | ------ |
|
|
1511
|
+
| `message` | `string` | The error message |
|
|
1512
|
+
| `code` | `number` | The exit code of the command |
|
|
1513
|
+
| `output` | `string`[] | The output of the command |
|
|
1514
|
+
|
|
1515
|
+
###### Returns
|
|
1516
|
+
|
|
1517
|
+
[`CommandError`](#commanderror)
|
|
1518
|
+
|
|
1519
|
+
###### Overrides
|
|
1520
|
+
|
|
1521
|
+
`Error.constructor`
|
|
1522
|
+
|
|
1523
|
+
##### Properties
|
|
1524
|
+
|
|
1525
|
+
###### code
|
|
1526
|
+
|
|
1527
|
+
> `readonly` **code**: `number`
|
|
1528
|
+
|
|
1529
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/execute-command.ts#L25)
|
|
1530
|
+
|
|
1531
|
+
The exit code of the command
|
|
1532
|
+
|
|
1533
|
+
###### output
|
|
1534
|
+
|
|
1535
|
+
> `readonly` **output**: `string`[]
|
|
1536
|
+
|
|
1537
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/execute-command.ts#L26)
|
|
1538
|
+
|
|
1539
|
+
The output of the command
|
|
1540
|
+
|
|
1541
|
+
***
|
|
1542
|
+
|
|
1442
1543
|
#### SpinnerError
|
|
1443
1544
|
|
|
1444
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:
|
|
1545
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/spinner.ts#L12)
|
|
1445
1546
|
|
|
1446
1547
|
Error class used to indicate that the spinner operation failed.
|
|
1447
1548
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1454,7 +1555,7 @@ This error is used to signal that the operation should be aborted.
|
|
|
1454
1555
|
|
|
1455
1556
|
#### ExecuteCommandOptions
|
|
1456
1557
|
|
|
1457
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1558
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/execute-command.ts#L7)
|
|
1458
1559
|
|
|
1459
1560
|
Options for executing a command, extending SpawnOptionsWithoutStdio
|
|
1460
1561
|
|
|
@@ -1466,13 +1567,13 @@ Options for executing a command, extending SpawnOptionsWithoutStdio
|
|
|
1466
1567
|
|
|
1467
1568
|
| Property | Type | Description | Defined in |
|
|
1468
1569
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.1.5/sdk/utils/src/terminal/execute-command.ts#L9) |
|
|
1470
1571
|
|
|
1471
1572
|
***
|
|
1472
1573
|
|
|
1473
1574
|
#### Logger
|
|
1474
1575
|
|
|
1475
|
-
Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1576
|
+
Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/logging/logger.ts#L23)
|
|
1476
1577
|
|
|
1477
1578
|
Simple logger interface with basic logging methods
|
|
1478
1579
|
Logger
|
|
@@ -1481,16 +1582,16 @@ Simple logger interface with basic logging methods
|
|
|
1481
1582
|
|
|
1482
1583
|
| Property | Type | Description | Defined in |
|
|
1483
1584
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.1.5/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.1.5/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.1.5/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.1.5/sdk/utils/src/logging/logger.ts#L29) |
|
|
1488
1589
|
|
|
1489
1590
|
***
|
|
1490
1591
|
|
|
1491
1592
|
#### LoggerOptions
|
|
1492
1593
|
|
|
1493
|
-
Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1594
|
+
Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/logging/logger.ts#L12)
|
|
1494
1595
|
|
|
1495
1596
|
Configuration options for the logger
|
|
1496
1597
|
LoggerOptions
|
|
@@ -1499,14 +1600,14 @@ Configuration options for the logger
|
|
|
1499
1600
|
|
|
1500
1601
|
| Property | Type | Description | Defined in |
|
|
1501
1602
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.1.5/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.1.5/sdk/utils/src/logging/logger.ts#L16) |
|
|
1504
1605
|
|
|
1505
1606
|
***
|
|
1506
1607
|
|
|
1507
1608
|
#### SpinnerOptions\<R\>
|
|
1508
1609
|
|
|
1509
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:
|
|
1610
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/terminal/spinner.ts#L25)
|
|
1510
1611
|
|
|
1511
1612
|
Options for configuring the spinner behavior
|
|
1512
1613
|
|
|
@@ -1520,9 +1621,9 @@ Options for configuring the spinner behavior
|
|
|
1520
1621
|
|
|
1521
1622
|
| Property | Type | Description | Defined in |
|
|
1522
1623
|
| ------ | ------ | ------ | ------ |
|
|
1523
|
-
| <a id="startmessage"></a> `startMessage` | `string` | Message to display when spinner starts | [sdk/utils/src/terminal/spinner.ts:
|
|
1524
|
-
| <a id="stopmessage"></a> `stopMessage` | `string` | Message to display when spinner completes successfully | [sdk/utils/src/terminal/spinner.ts:
|
|
1525
|
-
| <a id="task"></a> `task` | (`spinner?`) => `Promise`\<`R`\> | Async task to execute while spinner is active | [sdk/utils/src/terminal/spinner.ts:
|
|
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.1.5/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.1.5/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.1.5/sdk/utils/src/terminal/spinner.ts#L29) |
|
|
1526
1627
|
|
|
1527
1628
|
### Type Aliases
|
|
1528
1629
|
|
|
@@ -1530,7 +1631,7 @@ Options for configuring the spinner behavior
|
|
|
1530
1631
|
|
|
1531
1632
|
> **AccessToken** = `string`
|
|
1532
1633
|
|
|
1533
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1634
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/access-token.schema.ts#L22)
|
|
1534
1635
|
|
|
1535
1636
|
Schema for validating both application and personal access tokens.
|
|
1536
1637
|
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
@@ -1541,7 +1642,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1541
1642
|
|
|
1542
1643
|
> **ApplicationAccessToken** = `string`
|
|
1543
1644
|
|
|
1544
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1645
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/access-token.schema.ts#L8)
|
|
1545
1646
|
|
|
1546
1647
|
Schema for validating application access tokens.
|
|
1547
1648
|
Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -1552,7 +1653,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1552
1653
|
|
|
1553
1654
|
> **DotEnv** = `object`
|
|
1554
1655
|
|
|
1555
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1656
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:97](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/dot-env.schema.ts#L97)
|
|
1556
1657
|
|
|
1557
1658
|
Type definition for the environment variables schema.
|
|
1558
1659
|
|
|
@@ -1560,40 +1661,43 @@ Type definition for the environment variables schema.
|
|
|
1560
1661
|
|
|
1561
1662
|
| Name | Type | Description | Defined in |
|
|
1562
1663
|
| ------ | ------ | ------ | ------ |
|
|
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="
|
|
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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/sdk/utils/src/validation/dot-env.schema.ts#L20) |
|
|
1597
1701
|
|
|
1598
1702
|
***
|
|
1599
1703
|
|
|
@@ -1601,7 +1705,7 @@ Type definition for the environment variables schema.
|
|
|
1601
1705
|
|
|
1602
1706
|
> **DotEnvPartial** = `object`
|
|
1603
1707
|
|
|
1604
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1708
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:108](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/dot-env.schema.ts#L108)
|
|
1605
1709
|
|
|
1606
1710
|
Type definition for the partial environment variables schema.
|
|
1607
1711
|
|
|
@@ -1609,40 +1713,43 @@ Type definition for the partial environment variables schema.
|
|
|
1609
1713
|
|
|
1610
1714
|
| Name | Type | Description | Defined in |
|
|
1611
1715
|
| ------ | ------ | ------ | ------ |
|
|
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="
|
|
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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/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.1.5/sdk/utils/src/validation/dot-env.schema.ts#L20) |
|
|
1646
1753
|
|
|
1647
1754
|
***
|
|
1648
1755
|
|
|
@@ -1650,7 +1757,7 @@ Type definition for the partial environment variables schema.
|
|
|
1650
1757
|
|
|
1651
1758
|
> **Id** = `string`
|
|
1652
1759
|
|
|
1653
|
-
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1760
|
+
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/id.schema.ts#L30)
|
|
1654
1761
|
|
|
1655
1762
|
Type definition for database IDs, inferred from IdSchema.
|
|
1656
1763
|
Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
|
|
@@ -1661,7 +1768,7 @@ Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
|
|
|
1661
1768
|
|
|
1662
1769
|
> **LogLevel** = `"debug"` \| `"info"` \| `"warn"` \| `"error"` \| `"none"`
|
|
1663
1770
|
|
|
1664
|
-
Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1771
|
+
Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/logging/logger.ts#L6)
|
|
1665
1772
|
|
|
1666
1773
|
Log levels supported by the logger
|
|
1667
1774
|
|
|
@@ -1671,7 +1778,7 @@ Log levels supported by the logger
|
|
|
1671
1778
|
|
|
1672
1779
|
> **PersonalAccessToken** = `string`
|
|
1673
1780
|
|
|
1674
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1781
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/access-token.schema.ts#L15)
|
|
1675
1782
|
|
|
1676
1783
|
Schema for validating personal access tokens.
|
|
1677
1784
|
Personal access tokens start with 'sm_pat_' prefix.
|
|
@@ -1682,7 +1789,7 @@ Personal access tokens start with 'sm_pat_' prefix.
|
|
|
1682
1789
|
|
|
1683
1790
|
> **Url** = `string`
|
|
1684
1791
|
|
|
1685
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1792
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/url.schema.ts#L18)
|
|
1686
1793
|
|
|
1687
1794
|
Schema for validating URLs.
|
|
1688
1795
|
|
|
@@ -1706,7 +1813,7 @@ const isInvalidUrl = UrlSchema.safeParse("not-a-url").success;
|
|
|
1706
1813
|
|
|
1707
1814
|
> **UrlOrPath** = `string`
|
|
1708
1815
|
|
|
1709
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1816
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/url.schema.ts#L55)
|
|
1710
1817
|
|
|
1711
1818
|
Schema that accepts either a full URL or a URL path.
|
|
1712
1819
|
|
|
@@ -1730,7 +1837,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
1730
1837
|
|
|
1731
1838
|
> **UrlPath** = `string`
|
|
1732
1839
|
|
|
1733
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1840
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/url.schema.ts#L38)
|
|
1734
1841
|
|
|
1735
1842
|
Schema for validating URL paths.
|
|
1736
1843
|
|
|
@@ -1754,7 +1861,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
1754
1861
|
|
|
1755
1862
|
> `const` **AccessTokenSchema**: `ZodString`\<[`AccessToken`](#accesstoken)\>
|
|
1756
1863
|
|
|
1757
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1864
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/access-token.schema.ts#L21)
|
|
1758
1865
|
|
|
1759
1866
|
Schema for validating both application and personal access tokens.
|
|
1760
1867
|
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
@@ -1765,7 +1872,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1765
1872
|
|
|
1766
1873
|
> `const` **ApplicationAccessTokenSchema**: `ZodString`\<[`ApplicationAccessToken`](#applicationaccesstoken)\>
|
|
1767
1874
|
|
|
1768
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1875
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/access-token.schema.ts#L7)
|
|
1769
1876
|
|
|
1770
1877
|
Schema for validating application access tokens.
|
|
1771
1878
|
Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -1776,7 +1883,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1776
1883
|
|
|
1777
1884
|
> `const` **DotEnvSchema**: `ZodObject`\<[`DotEnv`](#dotenv)\>
|
|
1778
1885
|
|
|
1779
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:12](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1886
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:12](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/dot-env.schema.ts#L12)
|
|
1780
1887
|
|
|
1781
1888
|
Schema for validating environment variables used by the SettleMint SDK.
|
|
1782
1889
|
Defines validation rules and types for configuration values like URLs,
|
|
@@ -1788,7 +1895,7 @@ access tokens, workspace names, and service endpoints.
|
|
|
1788
1895
|
|
|
1789
1896
|
> `const` **DotEnvSchemaPartial**: `ZodObject`\<[`DotEnvPartial`](#dotenvpartial)\>
|
|
1790
1897
|
|
|
1791
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1898
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:103](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/dot-env.schema.ts#L103)
|
|
1792
1899
|
|
|
1793
1900
|
Partial version of the environment variables schema where all fields are optional.
|
|
1794
1901
|
Useful for validating incomplete configurations during development or build time.
|
|
@@ -1799,7 +1906,7 @@ Useful for validating incomplete configurations during development or build time
|
|
|
1799
1906
|
|
|
1800
1907
|
> `const` **IdSchema**: `ZodUnion`\<[`Id`](#id)\>
|
|
1801
1908
|
|
|
1802
|
-
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1909
|
+
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/id.schema.ts#L17)
|
|
1803
1910
|
|
|
1804
1911
|
Schema for validating database IDs. Accepts both PostgreSQL UUIDs and MongoDB ObjectIDs.
|
|
1805
1912
|
PostgreSQL UUIDs are 32 hexadecimal characters with hyphens (e.g. 123e4567-e89b-12d3-a456-426614174000).
|
|
@@ -1823,7 +1930,7 @@ const isValidObjectId = IdSchema.safeParse("507f1f77bcf86cd799439011").success;
|
|
|
1823
1930
|
|
|
1824
1931
|
> `const` **PersonalAccessTokenSchema**: `ZodString`\<[`PersonalAccessToken`](#personalaccesstoken)\>
|
|
1825
1932
|
|
|
1826
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1933
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/access-token.schema.ts#L14)
|
|
1827
1934
|
|
|
1828
1935
|
Schema for validating personal access tokens.
|
|
1829
1936
|
Personal access tokens start with 'sm_pat_' prefix.
|
|
@@ -1834,7 +1941,7 @@ Personal access tokens start with 'sm_pat_' prefix.
|
|
|
1834
1941
|
|
|
1835
1942
|
> `const` **runsInBrowser**: `boolean` = `isBrowser`
|
|
1836
1943
|
|
|
1837
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1944
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/runtime/ensure-server.ts#L40)
|
|
1838
1945
|
|
|
1839
1946
|
Boolean indicating if code is currently running in a browser environment
|
|
1840
1947
|
|
|
@@ -1844,7 +1951,7 @@ Boolean indicating if code is currently running in a browser environment
|
|
|
1844
1951
|
|
|
1845
1952
|
> `const` **runsOnServer**: `boolean` = `!isBrowser`
|
|
1846
1953
|
|
|
1847
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1954
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/runtime/ensure-server.ts#L45)
|
|
1848
1955
|
|
|
1849
1956
|
Boolean indicating if code is currently running in a server environment
|
|
1850
1957
|
|
|
@@ -1854,7 +1961,7 @@ Boolean indicating if code is currently running in a server environment
|
|
|
1854
1961
|
|
|
1855
1962
|
> `const` **UniqueNameSchema**: `ZodString`
|
|
1856
1963
|
|
|
1857
|
-
Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1964
|
+
Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/unique-name.schema.ts#L19)
|
|
1858
1965
|
|
|
1859
1966
|
Schema for validating unique names used across the SettleMint platform.
|
|
1860
1967
|
Only accepts lowercase alphanumeric characters and hyphens.
|
|
@@ -1880,7 +1987,7 @@ const isInvalidName = UniqueNameSchema.safeParse("My Workspace!").success;
|
|
|
1880
1987
|
|
|
1881
1988
|
> `const` **UrlOrPathSchema**: `ZodUnion`\<[`UrlOrPath`](#urlorpath)\>
|
|
1882
1989
|
|
|
1883
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.1.
|
|
1990
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/url.schema.ts#L54)
|
|
1884
1991
|
|
|
1885
1992
|
Schema that accepts either a full URL or a URL path.
|
|
1886
1993
|
|
|
@@ -1904,7 +2011,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
1904
2011
|
|
|
1905
2012
|
> `const` **UrlPathSchema**: `ZodString`\<[`UrlPath`](#urlpath)\>
|
|
1906
2013
|
|
|
1907
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.1.
|
|
2014
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/url.schema.ts#L34)
|
|
1908
2015
|
|
|
1909
2016
|
Schema for validating URL paths.
|
|
1910
2017
|
|
|
@@ -1928,7 +2035,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
1928
2035
|
|
|
1929
2036
|
> `const` **UrlSchema**: `ZodString`\<[`Url`](#url)\>
|
|
1930
2037
|
|
|
1931
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.1.
|
|
2038
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/utils/src/validation/url.schema.ts#L17)
|
|
1932
2039
|
|
|
1933
2040
|
Schema for validating URLs.
|
|
1934
2041
|
|