@settlemint/sdk-utils 2.3.2 → 2.3.3-pr94c5517e
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 +121 -77
- package/dist/environment.cjs +17708 -383
- package/dist/environment.cjs.map +1 -1
- package/dist/environment.d.cts +263 -98
- package/dist/environment.d.ts +263 -98
- package/dist/environment.js +17746 -0
- package/dist/environment.js.map +1 -0
- package/dist/filesystem.cjs +6746 -113
- package/dist/filesystem.cjs.map +1 -1
- package/dist/filesystem.d.cts +22 -1
- package/dist/filesystem.d.ts +22 -1
- package/dist/filesystem.js +6766 -0
- package/dist/filesystem.js.map +1 -0
- package/dist/http.cjs +217 -79
- package/dist/http.cjs.map +1 -1
- package/dist/http.d.cts +14 -1
- package/dist/http.d.ts +14 -1
- package/dist/http.js +226 -0
- package/dist/http.js.map +1 -0
- package/dist/index.cjs +295 -104
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +26 -1
- package/dist/index.d.ts +26 -1
- package/dist/index.js +306 -0
- package/dist/index.js.map +1 -0
- package/dist/json.cjs +83 -0
- package/dist/json.cjs.map +1 -0
- package/dist/json.d.cts +56 -0
- package/dist/json.d.ts +56 -0
- package/dist/json.js +80 -0
- package/dist/json.js.map +1 -0
- package/dist/logging.cjs +209 -137
- package/dist/logging.cjs.map +1 -1
- package/dist/logging.d.cts +23 -14
- package/dist/logging.d.ts +23 -14
- package/dist/logging.js +221 -0
- package/dist/logging.js.map +1 -0
- package/dist/package-manager.cjs +7353 -173
- package/dist/package-manager.cjs.map +1 -1
- package/dist/package-manager.d.cts +26 -3
- package/dist/package-manager.d.ts +26 -3
- package/dist/package-manager.js +7385 -0
- package/dist/package-manager.js.map +1 -0
- package/dist/retry.cjs +137 -0
- package/dist/retry.cjs.map +1 -0
- package/dist/retry.d.cts +19 -0
- package/dist/retry.d.ts +19 -0
- package/dist/retry.js +136 -0
- package/dist/retry.js.map +1 -0
- package/dist/runtime.cjs +58 -40
- package/dist/runtime.cjs.map +1 -1
- package/dist/runtime.d.cts +3 -0
- package/dist/runtime.d.ts +3 -0
- package/dist/runtime.js +45 -0
- package/dist/runtime.js.map +1 -0
- package/dist/string.cjs +76 -0
- package/dist/string.cjs.map +1 -0
- package/dist/string.d.cts +58 -0
- package/dist/string.d.ts +58 -0
- package/dist/string.js +72 -0
- package/dist/string.js.map +1 -0
- package/dist/terminal.cjs +426 -229
- package/dist/terminal.cjs.map +1 -1
- package/dist/terminal.d.cts +54 -24
- package/dist/terminal.d.ts +54 -24
- package/dist/terminal.js +441 -0
- package/dist/terminal.js.map +1 -0
- package/dist/url.cjs +25 -0
- package/dist/url.cjs.map +1 -0
- package/dist/url.d.cts +20 -0
- package/dist/url.d.ts +20 -0
- package/dist/url.js +24 -0
- package/dist/url.js.map +1 -0
- package/dist/validation.cjs +10486 -190
- package/dist/validation.cjs.map +1 -1
- package/dist/validation.d.cts +128 -94
- package/dist/validation.d.ts +128 -94
- package/dist/validation.js +10482 -0
- package/dist/validation.js.map +1 -0
- package/package.json +6 -6
- package/dist/environment.mjs +0 -383
- package/dist/environment.mjs.map +0 -1
- package/dist/filesystem.mjs +0 -105
- package/dist/filesystem.mjs.map +0 -1
- package/dist/http.mjs +0 -63
- package/dist/http.mjs.map +0 -1
- package/dist/index.mjs +0 -90
- package/dist/index.mjs.map +0 -1
- package/dist/logging.mjs +0 -123
- package/dist/logging.mjs.map +0 -1
- package/dist/package-manager.mjs +0 -167
- package/dist/package-manager.mjs.map +0 -1
- package/dist/runtime.mjs +0 -23
- package/dist/runtime.mjs.map +0 -1
- package/dist/terminal.mjs +0 -230
- package/dist/terminal.mjs.map +0 -1
- package/dist/validation.mjs +0 -159
- package/dist/validation.mjs.map +0 -1
package/README.md
CHANGED
|
@@ -39,6 +39,7 @@
|
|
|
39
39
|
- [ensureServer()](#ensureserver)
|
|
40
40
|
- [executeCommand()](#executecommand)
|
|
41
41
|
- [exists()](#exists)
|
|
42
|
+
- [extractBaseUrlBeforeSegment()](#extractbaseurlbeforesegment)
|
|
42
43
|
- [extractJsonObject()](#extractjsonobject)
|
|
43
44
|
- [fetchWithRetry()](#fetchwithretry)
|
|
44
45
|
- [findMonoRepoPackages()](#findmonorepopackages)
|
|
@@ -91,6 +92,7 @@
|
|
|
91
92
|
- [PersonalAccessTokenSchema](#personalaccesstokenschema)
|
|
92
93
|
- [runsInBrowser](#runsinbrowser)
|
|
93
94
|
- [runsOnServer](#runsonserver)
|
|
95
|
+
- [STANDALONE\_INSTANCE](#standalone_instance)
|
|
94
96
|
- [UniqueNameSchema](#uniquenameschema)
|
|
95
97
|
- [UrlOrPathSchema](#urlorpathschema)
|
|
96
98
|
- [UrlPathSchema](#urlpathschema)
|
|
@@ -110,7 +112,7 @@ The SettleMint Utils SDK provides a collection of shared utilities and helper fu
|
|
|
110
112
|
|
|
111
113
|
> **ascii**(): `void`
|
|
112
114
|
|
|
113
|
-
Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.3.
|
|
115
|
+
Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/ascii.ts#L14)
|
|
114
116
|
|
|
115
117
|
Prints the SettleMint ASCII art logo to the console in magenta color.
|
|
116
118
|
Used for CLI branding and visual identification.
|
|
@@ -134,7 +136,7 @@ ascii();
|
|
|
134
136
|
|
|
135
137
|
> **camelCaseToWords**(`s`): `string`
|
|
136
138
|
|
|
137
|
-
Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.3.
|
|
139
|
+
Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/string.ts#L29)
|
|
138
140
|
|
|
139
141
|
Converts a camelCase string to a human-readable string.
|
|
140
142
|
|
|
@@ -165,7 +167,7 @@ const words = camelCaseToWords("camelCaseString");
|
|
|
165
167
|
|
|
166
168
|
> **cancel**(`msg`): `never`
|
|
167
169
|
|
|
168
|
-
Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.3.
|
|
170
|
+
Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/cancel.ts#L23)
|
|
169
171
|
|
|
170
172
|
Displays an error message in red inverse text and throws a CancelError.
|
|
171
173
|
Used to terminate execution with a visible error message.
|
|
@@ -198,7 +200,7 @@ cancel("An error occurred");
|
|
|
198
200
|
|
|
199
201
|
> **capitalizeFirstLetter**(`val`): `string`
|
|
200
202
|
|
|
201
|
-
Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.3.
|
|
203
|
+
Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/string.ts#L13)
|
|
202
204
|
|
|
203
205
|
Capitalizes the first letter of a string.
|
|
204
206
|
|
|
@@ -229,7 +231,7 @@ const capitalized = capitalizeFirstLetter("hello");
|
|
|
229
231
|
|
|
230
232
|
> **createLogger**(`options`): [`Logger`](#logger)
|
|
231
233
|
|
|
232
|
-
Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.3.
|
|
234
|
+
Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L50)
|
|
233
235
|
|
|
234
236
|
Creates a simple logger with configurable log level
|
|
235
237
|
|
|
@@ -262,7 +264,7 @@ logger.error('Operation failed', new Error('Connection timeout'));
|
|
|
262
264
|
|
|
263
265
|
> **emptyDir**(`dir`): `Promise`\<`void`\>
|
|
264
266
|
|
|
265
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.3.
|
|
267
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/download-and-extract.ts#L45)
|
|
266
268
|
|
|
267
269
|
Removes all contents of a directory except the .git folder
|
|
268
270
|
|
|
@@ -290,7 +292,7 @@ await emptyDir("/path/to/dir"); // Removes all contents except .git
|
|
|
290
292
|
|
|
291
293
|
> **ensureBrowser**(): `void`
|
|
292
294
|
|
|
293
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.3.
|
|
295
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/runtime/ensure-server.ts#L31)
|
|
294
296
|
|
|
295
297
|
Ensures that code is running in a browser environment and not on the server.
|
|
296
298
|
|
|
@@ -317,7 +319,7 @@ ensureBrowser();
|
|
|
317
319
|
|
|
318
320
|
> **ensureServer**(): `void`
|
|
319
321
|
|
|
320
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.3.
|
|
322
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/runtime/ensure-server.ts#L13)
|
|
321
323
|
|
|
322
324
|
Ensures that code is running on the server and not in a browser environment.
|
|
323
325
|
|
|
@@ -344,7 +346,7 @@ ensureServer();
|
|
|
344
346
|
|
|
345
347
|
> **executeCommand**(`command`, `args`, `options?`): `Promise`\<`string`[]\>
|
|
346
348
|
|
|
347
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.3.
|
|
349
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/execute-command.ts#L51)
|
|
348
350
|
|
|
349
351
|
Executes a command with the given arguments in a child process.
|
|
350
352
|
Pipes stdin to the child process and captures stdout/stderr output.
|
|
@@ -386,7 +388,7 @@ await executeCommand("npm", ["install"], { silent: true });
|
|
|
386
388
|
|
|
387
389
|
> **exists**(`path`): `Promise`\<`boolean`\>
|
|
388
390
|
|
|
389
|
-
Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.3.
|
|
391
|
+
Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/filesystem/exists.ts#L17)
|
|
390
392
|
|
|
391
393
|
Checks if a file or directory exists at the given path
|
|
392
394
|
|
|
@@ -415,11 +417,43 @@ if (await exists('/path/to/file.txt')) {
|
|
|
415
417
|
|
|
416
418
|
***
|
|
417
419
|
|
|
420
|
+
#### extractBaseUrlBeforeSegment()
|
|
421
|
+
|
|
422
|
+
> **extractBaseUrlBeforeSegment**(`baseUrl`, `pathSegment`): `string`
|
|
423
|
+
|
|
424
|
+
Defined in: [sdk/utils/src/url.ts:15](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/url.ts#L15)
|
|
425
|
+
|
|
426
|
+
Extracts the base URL before a specific segment in a URL.
|
|
427
|
+
|
|
428
|
+
##### Parameters
|
|
429
|
+
|
|
430
|
+
| Parameter | Type | Description |
|
|
431
|
+
| ------ | ------ | ------ |
|
|
432
|
+
| `baseUrl` | `string` | The base URL to extract the path from |
|
|
433
|
+
| `pathSegment` | `string` | The path segment to start from |
|
|
434
|
+
|
|
435
|
+
##### Returns
|
|
436
|
+
|
|
437
|
+
`string`
|
|
438
|
+
|
|
439
|
+
The base URL before the specified segment
|
|
440
|
+
|
|
441
|
+
##### Example
|
|
442
|
+
|
|
443
|
+
```typescript
|
|
444
|
+
import { extractBaseUrlBeforeSegment } from "@settlemint/sdk-utils/url";
|
|
445
|
+
|
|
446
|
+
const baseUrl = extractBaseUrlBeforeSegment("https://example.com/api/v1/subgraphs/name/my-subgraph", "/subgraphs");
|
|
447
|
+
// Returns: "https://example.com/api/v1"
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
***
|
|
451
|
+
|
|
418
452
|
#### extractJsonObject()
|
|
419
453
|
|
|
420
454
|
> **extractJsonObject**\<`T`\>(`value`): `null` \| `T`
|
|
421
455
|
|
|
422
|
-
Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.3.
|
|
456
|
+
Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/json.ts#L50)
|
|
423
457
|
|
|
424
458
|
Extracts a JSON object from a string.
|
|
425
459
|
|
|
@@ -462,7 +496,7 @@ const json = extractJsonObject<{ port: number }>(
|
|
|
462
496
|
|
|
463
497
|
> **fetchWithRetry**(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Response`\>
|
|
464
498
|
|
|
465
|
-
Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.3.
|
|
499
|
+
Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/http/fetch-with-retry.ts#L18)
|
|
466
500
|
|
|
467
501
|
Retry an HTTP request with exponential backoff and jitter.
|
|
468
502
|
Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
|
|
@@ -500,7 +534,7 @@ const response = await fetchWithRetry("https://api.example.com/data");
|
|
|
500
534
|
|
|
501
535
|
> **findMonoRepoPackages**(`projectDir`): `Promise`\<`string`[]\>
|
|
502
536
|
|
|
503
|
-
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.3.
|
|
537
|
+
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/filesystem/mono-repo.ts#L59)
|
|
504
538
|
|
|
505
539
|
Finds all packages in a monorepo
|
|
506
540
|
|
|
@@ -531,7 +565,7 @@ console.log(packages); // Output: ["/path/to/your/project/packages/core", "/path
|
|
|
531
565
|
|
|
532
566
|
> **findMonoRepoRoot**(`startDir`): `Promise`\<`null` \| `string`\>
|
|
533
567
|
|
|
534
|
-
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.3.
|
|
568
|
+
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/filesystem/mono-repo.ts#L19)
|
|
535
569
|
|
|
536
570
|
Finds the root directory of a monorepo
|
|
537
571
|
|
|
@@ -562,7 +596,7 @@ console.log(root); // Output: /path/to/your/project/packages/core
|
|
|
562
596
|
|
|
563
597
|
> **formatTargetDir**(`targetDir`): `string`
|
|
564
598
|
|
|
565
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.3.
|
|
599
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/download-and-extract.ts#L15)
|
|
566
600
|
|
|
567
601
|
Formats a directory path by removing trailing slashes and whitespace
|
|
568
602
|
|
|
@@ -592,7 +626,7 @@ const formatted = formatTargetDir("/path/to/dir/ "); // "/path/to/dir"
|
|
|
592
626
|
|
|
593
627
|
> **getPackageManager**(`targetDir?`): `Promise`\<`AgentName`\>
|
|
594
628
|
|
|
595
|
-
Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.3.
|
|
629
|
+
Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/get-package-manager.ts#L15)
|
|
596
630
|
|
|
597
631
|
Detects the package manager used in the current project
|
|
598
632
|
|
|
@@ -623,7 +657,7 @@ console.log(`Using ${packageManager}`);
|
|
|
623
657
|
|
|
624
658
|
> **getPackageManagerExecutable**(`targetDir?`): `Promise`\<\{ `args`: `string`[]; `command`: `string`; \}\>
|
|
625
659
|
|
|
626
|
-
Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.3.
|
|
660
|
+
Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
|
|
627
661
|
|
|
628
662
|
Retrieves the executable command and arguments for the package manager
|
|
629
663
|
|
|
@@ -654,7 +688,7 @@ console.log(`Using ${command} with args: ${args.join(" ")}`);
|
|
|
654
688
|
|
|
655
689
|
> **graphqlFetchWithRetry**\<`Data`\>(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Data`\>
|
|
656
690
|
|
|
657
|
-
Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.3.
|
|
691
|
+
Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
|
|
658
692
|
|
|
659
693
|
Executes a GraphQL request with automatic retries using exponential backoff and jitter.
|
|
660
694
|
Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
|
|
@@ -713,7 +747,7 @@ const data = await graphqlFetchWithRetry<{ user: { id: string } }>(
|
|
|
713
747
|
|
|
714
748
|
> **installDependencies**(`pkgs`, `cwd?`): `Promise`\<`void`\>
|
|
715
749
|
|
|
716
|
-
Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.3.
|
|
750
|
+
Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/install-dependencies.ts#L20)
|
|
717
751
|
|
|
718
752
|
Installs one or more packages as dependencies using the detected package manager
|
|
719
753
|
|
|
@@ -752,7 +786,7 @@ await installDependencies(["express", "cors"]);
|
|
|
752
786
|
|
|
753
787
|
> **intro**(`msg`): `void`
|
|
754
788
|
|
|
755
|
-
Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.
|
|
789
|
+
Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/intro.ts#L16)
|
|
756
790
|
|
|
757
791
|
Displays an introductory message in magenta text with padding.
|
|
758
792
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -782,7 +816,7 @@ intro("Starting deployment...");
|
|
|
782
816
|
|
|
783
817
|
> **isEmpty**(`path`): `Promise`\<`boolean`\>
|
|
784
818
|
|
|
785
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.3.
|
|
819
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/download-and-extract.ts#L31)
|
|
786
820
|
|
|
787
821
|
Checks if a directory is empty or contains only a .git folder
|
|
788
822
|
|
|
@@ -814,7 +848,7 @@ if (await isEmpty("/path/to/dir")) {
|
|
|
814
848
|
|
|
815
849
|
> **isPackageInstalled**(`name`, `path?`): `Promise`\<`boolean`\>
|
|
816
850
|
|
|
817
|
-
Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.3.
|
|
851
|
+
Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/is-package-installed.ts#L17)
|
|
818
852
|
|
|
819
853
|
Checks if a package is installed in the project's dependencies, devDependencies, or peerDependencies.
|
|
820
854
|
|
|
@@ -850,7 +884,7 @@ console.log(`@settlemint/sdk-utils is installed: ${isInstalled}`);
|
|
|
850
884
|
|
|
851
885
|
> **list**(`title`, `items`): `void`
|
|
852
886
|
|
|
853
|
-
Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.3.
|
|
887
|
+
Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/list.ts#L23)
|
|
854
888
|
|
|
855
889
|
Displays a list of items in a formatted manner, supporting nested items.
|
|
856
890
|
|
|
@@ -890,7 +924,7 @@ list("Providers", [
|
|
|
890
924
|
|
|
891
925
|
> **loadEnv**\<`T`\>(`validateEnv`, `prod`, `path`): `Promise`\<`T` *extends* `true` ? `object` : `object`\>
|
|
892
926
|
|
|
893
|
-
Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.3.
|
|
927
|
+
Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/environment/load-env.ts#L25)
|
|
894
928
|
|
|
895
929
|
Loads environment variables from .env files.
|
|
896
930
|
To enable encryption with dotenvx (https://www.dotenvx.com/docs) run `bunx dotenvx encrypt`
|
|
@@ -938,7 +972,7 @@ const rawEnv = await loadEnv(false, false);
|
|
|
938
972
|
|
|
939
973
|
> **makeJsonStringifiable**\<`T`\>(`value`): `T`
|
|
940
974
|
|
|
941
|
-
Defined in: [sdk/utils/src/json.ts:73](https://github.com/settlemint/sdk/blob/v2.3.
|
|
975
|
+
Defined in: [sdk/utils/src/json.ts:73](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/json.ts#L73)
|
|
942
976
|
|
|
943
977
|
Converts a value to a JSON stringifiable format.
|
|
944
978
|
|
|
@@ -975,7 +1009,7 @@ const json = makeJsonStringifiable<{ amount: bigint }>({ amount: BigInt(1000) })
|
|
|
975
1009
|
|
|
976
1010
|
> **maskTokens**(`output`): `string`
|
|
977
1011
|
|
|
978
|
-
Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1012
|
+
Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/mask-tokens.ts#L13)
|
|
979
1013
|
|
|
980
1014
|
Masks sensitive SettleMint tokens in output text by replacing them with asterisks.
|
|
981
1015
|
Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).
|
|
@@ -1007,7 +1041,7 @@ const masked = maskTokens("Token: sm_pat_****"); // "Token: ***"
|
|
|
1007
1041
|
|
|
1008
1042
|
> **note**(`message`, `level`): `void`
|
|
1009
1043
|
|
|
1010
|
-
Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1044
|
+
Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/note.ts#L21)
|
|
1011
1045
|
|
|
1012
1046
|
Displays a note message with optional warning level formatting.
|
|
1013
1047
|
Regular notes are displayed in normal text, while warnings are shown in yellow.
|
|
@@ -1042,7 +1076,7 @@ note("Low disk space remaining", "warn");
|
|
|
1042
1076
|
|
|
1043
1077
|
> **outro**(`msg`): `void`
|
|
1044
1078
|
|
|
1045
|
-
Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1079
|
+
Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/outro.ts#L16)
|
|
1046
1080
|
|
|
1047
1081
|
Displays a closing message in green inverted text with padding.
|
|
1048
1082
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -1072,7 +1106,7 @@ outro("Deployment completed successfully!");
|
|
|
1072
1106
|
|
|
1073
1107
|
> **projectRoot**(`fallbackToCwd`, `cwd?`): `Promise`\<`string`\>
|
|
1074
1108
|
|
|
1075
|
-
Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1109
|
+
Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/filesystem/project-root.ts#L18)
|
|
1076
1110
|
|
|
1077
1111
|
Finds the root directory of the current project by locating the nearest package.json file
|
|
1078
1112
|
|
|
@@ -1109,7 +1143,7 @@ console.log(`Project root is at: ${rootDir}`);
|
|
|
1109
1143
|
|
|
1110
1144
|
> **replaceUnderscoresAndHyphensWithSpaces**(`s`): `string`
|
|
1111
1145
|
|
|
1112
|
-
Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1146
|
+
Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/string.ts#L48)
|
|
1113
1147
|
|
|
1114
1148
|
Replaces underscores and hyphens with spaces.
|
|
1115
1149
|
|
|
@@ -1140,7 +1174,7 @@ const result = replaceUnderscoresAndHyphensWithSpaces("Already_Spaced-Second");
|
|
|
1140
1174
|
|
|
1141
1175
|
> **requestLogger**(`logger`, `name`, `fn`): (...`args`) => `Promise`\<`Response`\>
|
|
1142
1176
|
|
|
1143
|
-
Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1177
|
+
Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/request-logger.ts#L14)
|
|
1144
1178
|
|
|
1145
1179
|
Logs the request and duration of a fetch call (> 500ms is logged as warn, otherwise info)
|
|
1146
1180
|
|
|
@@ -1174,7 +1208,7 @@ The fetch function
|
|
|
1174
1208
|
|
|
1175
1209
|
> **retryWhenFailed**\<`T`\>(`fn`, `maxRetries`, `initialSleepTime`, `stopOnError?`): `Promise`\<`T`\>
|
|
1176
1210
|
|
|
1177
|
-
Defined in: [sdk/utils/src/retry.ts:
|
|
1211
|
+
Defined in: [sdk/utils/src/retry.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/retry.ts#L16)
|
|
1178
1212
|
|
|
1179
1213
|
Retry a function when it fails.
|
|
1180
1214
|
|
|
@@ -1214,7 +1248,7 @@ const result = await retryWhenFailed(() => readFile("/path/to/file.txt"), 3, 1_0
|
|
|
1214
1248
|
|
|
1215
1249
|
> **setName**(`name`, `path?`): `Promise`\<`void`\>
|
|
1216
1250
|
|
|
1217
|
-
Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1251
|
+
Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/package-manager/set-name.ts#L16)
|
|
1218
1252
|
|
|
1219
1253
|
Sets the name field in the package.json file
|
|
1220
1254
|
|
|
@@ -1249,7 +1283,7 @@ await setName("my-new-project-name");
|
|
|
1249
1283
|
|
|
1250
1284
|
> **spinner**\<`R`\>(`options`): `Promise`\<`R`\>
|
|
1251
1285
|
|
|
1252
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1286
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/spinner.ts#L55)
|
|
1253
1287
|
|
|
1254
1288
|
Displays a loading spinner while executing an async task.
|
|
1255
1289
|
Shows progress with start/stop messages and handles errors.
|
|
@@ -1299,7 +1333,7 @@ const result = await spinner({
|
|
|
1299
1333
|
|
|
1300
1334
|
> **table**(`title`, `data`): `void`
|
|
1301
1335
|
|
|
1302
|
-
Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1336
|
+
Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/table.ts#L21)
|
|
1303
1337
|
|
|
1304
1338
|
Displays data in a formatted table in the terminal.
|
|
1305
1339
|
|
|
@@ -1333,7 +1367,7 @@ table("My Table", data);
|
|
|
1333
1367
|
|
|
1334
1368
|
> **truncate**(`value`, `maxLength`): `string`
|
|
1335
1369
|
|
|
1336
|
-
Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1370
|
+
Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/string.ts#L65)
|
|
1337
1371
|
|
|
1338
1372
|
Truncates a string to a maximum length and appends "..." if it is longer.
|
|
1339
1373
|
|
|
@@ -1365,7 +1399,7 @@ const truncated = truncate("Hello, world!", 10);
|
|
|
1365
1399
|
|
|
1366
1400
|
> **tryParseJson**\<`T`\>(`value`, `defaultValue`): `null` \| `T`
|
|
1367
1401
|
|
|
1368
|
-
Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1402
|
+
Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/json.ts#L23)
|
|
1369
1403
|
|
|
1370
1404
|
Attempts to parse a JSON string into a typed value, returning a default value if parsing fails.
|
|
1371
1405
|
|
|
@@ -1412,7 +1446,7 @@ const invalid = tryParseJson<string[]>(
|
|
|
1412
1446
|
|
|
1413
1447
|
> **validate**\<`T`\>(`schema`, `value`): `T`\[`"_output"`\]
|
|
1414
1448
|
|
|
1415
|
-
Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1449
|
+
Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/validate.ts#L16)
|
|
1416
1450
|
|
|
1417
1451
|
Validates a value against a given Zod schema.
|
|
1418
1452
|
|
|
@@ -1453,7 +1487,7 @@ const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
|
|
|
1453
1487
|
|
|
1454
1488
|
> **writeEnv**(`options`): `Promise`\<`void`\>
|
|
1455
1489
|
|
|
1456
|
-
Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1490
|
+
Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/environment/write-env.ts#L41)
|
|
1457
1491
|
|
|
1458
1492
|
Writes environment variables to .env files across a project or monorepo
|
|
1459
1493
|
|
|
@@ -1505,7 +1539,7 @@ await writeEnv({
|
|
|
1505
1539
|
|
|
1506
1540
|
#### CancelError
|
|
1507
1541
|
|
|
1508
|
-
Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1542
|
+
Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/cancel.ts#L8)
|
|
1509
1543
|
|
|
1510
1544
|
Error class used to indicate that the operation was cancelled.
|
|
1511
1545
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1518,7 +1552,7 @@ This error is used to signal that the operation should be aborted.
|
|
|
1518
1552
|
|
|
1519
1553
|
#### CommandError
|
|
1520
1554
|
|
|
1521
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1555
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/execute-command.ts#L16)
|
|
1522
1556
|
|
|
1523
1557
|
Error class for command execution errors
|
|
1524
1558
|
|
|
@@ -1532,7 +1566,7 @@ Error class for command execution errors
|
|
|
1532
1566
|
|
|
1533
1567
|
> **new CommandError**(`message`, `code`, `output`): [`CommandError`](#commanderror)
|
|
1534
1568
|
|
|
1535
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1569
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/execute-command.ts#L23)
|
|
1536
1570
|
|
|
1537
1571
|
Constructs a new CommandError
|
|
1538
1572
|
|
|
@@ -1558,7 +1592,7 @@ Constructs a new CommandError
|
|
|
1558
1592
|
|
|
1559
1593
|
> `readonly` **code**: `number`
|
|
1560
1594
|
|
|
1561
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1595
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/execute-command.ts#L25)
|
|
1562
1596
|
|
|
1563
1597
|
The exit code of the command
|
|
1564
1598
|
|
|
@@ -1566,7 +1600,7 @@ The exit code of the command
|
|
|
1566
1600
|
|
|
1567
1601
|
> `readonly` **output**: `string`[]
|
|
1568
1602
|
|
|
1569
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1603
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/execute-command.ts#L26)
|
|
1570
1604
|
|
|
1571
1605
|
The output of the command
|
|
1572
1606
|
|
|
@@ -1574,7 +1608,7 @@ The output of the command
|
|
|
1574
1608
|
|
|
1575
1609
|
#### SpinnerError
|
|
1576
1610
|
|
|
1577
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1611
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/spinner.ts#L12)
|
|
1578
1612
|
|
|
1579
1613
|
Error class used to indicate that the spinner operation failed.
|
|
1580
1614
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1587,7 +1621,7 @@ This error is used to signal that the operation should be aborted.
|
|
|
1587
1621
|
|
|
1588
1622
|
#### ExecuteCommandOptions
|
|
1589
1623
|
|
|
1590
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1624
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/execute-command.ts#L7)
|
|
1591
1625
|
|
|
1592
1626
|
Options for executing a command, extending SpawnOptionsWithoutStdio
|
|
1593
1627
|
|
|
@@ -1599,13 +1633,13 @@ Options for executing a command, extending SpawnOptionsWithoutStdio
|
|
|
1599
1633
|
|
|
1600
1634
|
| Property | Type | Description | Defined in |
|
|
1601
1635
|
| ------ | ------ | ------ | ------ |
|
|
1602
|
-
| <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.3.
|
|
1636
|
+
| <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.3.3/sdk/utils/src/terminal/execute-command.ts#L9) |
|
|
1603
1637
|
|
|
1604
1638
|
***
|
|
1605
1639
|
|
|
1606
1640
|
#### Logger
|
|
1607
1641
|
|
|
1608
|
-
Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1642
|
+
Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L23)
|
|
1609
1643
|
|
|
1610
1644
|
Simple logger interface with basic logging methods
|
|
1611
1645
|
Logger
|
|
@@ -1614,16 +1648,16 @@ Simple logger interface with basic logging methods
|
|
|
1614
1648
|
|
|
1615
1649
|
| Property | Type | Description | Defined in |
|
|
1616
1650
|
| ------ | ------ | ------ | ------ |
|
|
1617
|
-
| <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.3.
|
|
1618
|
-
| <a id="error"></a> `error` | (`message`, ...`args`) => `void` | Log errors | [sdk/utils/src/logging/logger.ts:31](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1619
|
-
| <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.3.
|
|
1620
|
-
| <a id="warn"></a> `warn` | (`message`, ...`args`) => `void` | Log warnings | [sdk/utils/src/logging/logger.ts:29](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1651
|
+
| <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.3.3/sdk/utils/src/logging/logger.ts#L25) |
|
|
1652
|
+
| <a id="error"></a> `error` | (`message`, ...`args`) => `void` | Log errors | [sdk/utils/src/logging/logger.ts:31](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L31) |
|
|
1653
|
+
| <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.3.3/sdk/utils/src/logging/logger.ts#L27) |
|
|
1654
|
+
| <a id="warn"></a> `warn` | (`message`, ...`args`) => `void` | Log warnings | [sdk/utils/src/logging/logger.ts:29](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L29) |
|
|
1621
1655
|
|
|
1622
1656
|
***
|
|
1623
1657
|
|
|
1624
1658
|
#### LoggerOptions
|
|
1625
1659
|
|
|
1626
|
-
Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1660
|
+
Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L12)
|
|
1627
1661
|
|
|
1628
1662
|
Configuration options for the logger
|
|
1629
1663
|
LoggerOptions
|
|
@@ -1632,14 +1666,14 @@ Configuration options for the logger
|
|
|
1632
1666
|
|
|
1633
1667
|
| Property | Type | Description | Defined in |
|
|
1634
1668
|
| ------ | ------ | ------ | ------ |
|
|
1635
|
-
| <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.3.
|
|
1636
|
-
| <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.3.
|
|
1669
|
+
| <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.3.3/sdk/utils/src/logging/logger.ts#L14) |
|
|
1670
|
+
| <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.3.3/sdk/utils/src/logging/logger.ts#L16) |
|
|
1637
1671
|
|
|
1638
1672
|
***
|
|
1639
1673
|
|
|
1640
1674
|
#### SpinnerOptions\<R\>
|
|
1641
1675
|
|
|
1642
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1676
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/terminal/spinner.ts#L25)
|
|
1643
1677
|
|
|
1644
1678
|
Options for configuring the spinner behavior
|
|
1645
1679
|
|
|
@@ -1653,9 +1687,9 @@ Options for configuring the spinner behavior
|
|
|
1653
1687
|
|
|
1654
1688
|
| Property | Type | Description | Defined in |
|
|
1655
1689
|
| ------ | ------ | ------ | ------ |
|
|
1656
|
-
| <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.3.
|
|
1657
|
-
| <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.3.
|
|
1658
|
-
| <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.3.
|
|
1690
|
+
| <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.3.3/sdk/utils/src/terminal/spinner.ts#L27) |
|
|
1691
|
+
| <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.3.3/sdk/utils/src/terminal/spinner.ts#L31) |
|
|
1692
|
+
| <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.3.3/sdk/utils/src/terminal/spinner.ts#L29) |
|
|
1659
1693
|
|
|
1660
1694
|
### Type Aliases
|
|
1661
1695
|
|
|
@@ -1663,7 +1697,7 @@ Options for configuring the spinner behavior
|
|
|
1663
1697
|
|
|
1664
1698
|
> **DotEnv** = `z.infer`\<*typeof* [`DotEnvSchema`](#dotenvschema)\>
|
|
1665
1699
|
|
|
1666
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1700
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:106](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/dot-env.schema.ts#L106)
|
|
1667
1701
|
|
|
1668
1702
|
Type definition for the environment variables schema.
|
|
1669
1703
|
|
|
@@ -1673,7 +1707,7 @@ Type definition for the environment variables schema.
|
|
|
1673
1707
|
|
|
1674
1708
|
> **DotEnvPartial** = `z.infer`\<*typeof* [`DotEnvSchemaPartial`](#dotenvschemapartial)\>
|
|
1675
1709
|
|
|
1676
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1710
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:117](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/dot-env.schema.ts#L117)
|
|
1677
1711
|
|
|
1678
1712
|
Type definition for the partial environment variables schema.
|
|
1679
1713
|
|
|
@@ -1683,7 +1717,7 @@ Type definition for the partial environment variables schema.
|
|
|
1683
1717
|
|
|
1684
1718
|
> **Id** = `z.infer`\<*typeof* [`IdSchema`](#idschema)\>
|
|
1685
1719
|
|
|
1686
|
-
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1720
|
+
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/id.schema.ts#L30)
|
|
1687
1721
|
|
|
1688
1722
|
Type definition for database IDs, inferred from IdSchema.
|
|
1689
1723
|
Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
|
|
@@ -1694,7 +1728,7 @@ Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
|
|
|
1694
1728
|
|
|
1695
1729
|
> **LogLevel** = `"debug"` \| `"info"` \| `"warn"` \| `"error"` \| `"none"`
|
|
1696
1730
|
|
|
1697
|
-
Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1731
|
+
Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/logging/logger.ts#L6)
|
|
1698
1732
|
|
|
1699
1733
|
Log levels supported by the logger
|
|
1700
1734
|
|
|
@@ -1704,7 +1738,7 @@ Log levels supported by the logger
|
|
|
1704
1738
|
|
|
1705
1739
|
> `const` **AccessTokenSchema**: `ZodString`
|
|
1706
1740
|
|
|
1707
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1741
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/access-token.schema.ts#L21)
|
|
1708
1742
|
|
|
1709
1743
|
Schema for validating both application and personal access tokens.
|
|
1710
1744
|
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
@@ -1715,7 +1749,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1715
1749
|
|
|
1716
1750
|
> `const` **ApplicationAccessTokenSchema**: `ZodString`
|
|
1717
1751
|
|
|
1718
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1752
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/access-token.schema.ts#L7)
|
|
1719
1753
|
|
|
1720
1754
|
Schema for validating application access tokens.
|
|
1721
1755
|
Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -1724,9 +1758,9 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1724
1758
|
|
|
1725
1759
|
#### DotEnvSchema
|
|
1726
1760
|
|
|
1727
|
-
> `const` **DotEnvSchema**: `ZodObject`\<\{ `SETTLEMINT_ACCESS_TOKEN`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_APPLICATION`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NETWORK`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_CUSTOM_DEPLOYMENT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_ADMIN_SECRET`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_DATABASE_URL`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HD_PRIVATE_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_INSTANCE`: `ZodDefault`\<`ZodString
|
|
1761
|
+
> `const` **DotEnvSchema**: `ZodObject`\<\{ `SETTLEMINT_ACCESS_TOKEN`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_APPLICATION`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NETWORK`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_CUSTOM_DEPLOYMENT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_ADMIN_SECRET`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_DATABASE_URL`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HD_PRIVATE_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_INSTANCE`: `ZodDefault`\<`ZodUnion`\<readonly \[`ZodString`, `ZodLiteral`\<`"standalone"`\>\]\>\>; `SETTLEMINT_IPFS`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_IPFS_API_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_IPFS_GATEWAY_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_IPFS_PINNING_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_LOG_LEVEL`: `ZodDefault`\<`ZodEnum`\<\{ `debug`: `"debug"`; `error`: `"error"`; `info`: `"info"`; `none`: `"none"`; `warn`: `"warn"`; \}\>\>; `SETTLEMINT_MINIO`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_MINIO_ACCESS_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_MINIO_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_MINIO_SECRET_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_NEW_PROJECT_NAME`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL_REST_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL_WS_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_THEGRAPH`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS`: `ZodPipe`\<`ZodTransform`\<`null` \| `never`[], `unknown`\>, `ZodOptional`\<`ZodArray`\<`ZodString`\>\>\>; `SETTLEMINT_WORKSPACE`: `ZodOptional`\<`ZodString`\>; \}, `$strip`\>
|
|
1728
1762
|
|
|
1729
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1763
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/dot-env.schema.ts#L17)
|
|
1730
1764
|
|
|
1731
1765
|
Schema for validating environment variables used by the SettleMint SDK.
|
|
1732
1766
|
Defines validation rules and types for configuration values like URLs,
|
|
@@ -1736,9 +1770,9 @@ access tokens, workspace names, and service endpoints.
|
|
|
1736
1770
|
|
|
1737
1771
|
#### DotEnvSchemaPartial
|
|
1738
1772
|
|
|
1739
|
-
> `const` **DotEnvSchemaPartial**: `ZodObject`\<\{ `SETTLEMINT_ACCESS_TOKEN`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_APPLICATION`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NETWORK`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_CUSTOM_DEPLOYMENT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_ADMIN_SECRET`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_DATABASE_URL`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HD_PRIVATE_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_INSTANCE`: `ZodOptional`\<`ZodDefault`\<`ZodString
|
|
1773
|
+
> `const` **DotEnvSchemaPartial**: `ZodObject`\<\{ `SETTLEMINT_ACCESS_TOKEN`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_APPLICATION`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NETWORK`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_CUSTOM_DEPLOYMENT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_ADMIN_SECRET`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_DATABASE_URL`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HD_PRIVATE_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_INSTANCE`: `ZodOptional`\<`ZodDefault`\<`ZodUnion`\<readonly \[`ZodString`, `ZodLiteral`\<`"standalone"`\>\]\>\>\>; `SETTLEMINT_IPFS`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_IPFS_API_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_IPFS_GATEWAY_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_IPFS_PINNING_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_LOG_LEVEL`: `ZodOptional`\<`ZodDefault`\<`ZodEnum`\<\{ `debug`: `"debug"`; `error`: `"error"`; `info`: `"info"`; `none`: `"none"`; `warn`: `"warn"`; \}\>\>\>; `SETTLEMINT_MINIO`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_MINIO_ACCESS_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_MINIO_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_MINIO_SECRET_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_NEW_PROJECT_NAME`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL_REST_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL_WS_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_THEGRAPH`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS`: `ZodOptional`\<`ZodPipe`\<`ZodTransform`\<`null` \| `never`[], `unknown`\>, `ZodOptional`\<`ZodArray`\<`ZodString`\>\>\>\>; `SETTLEMINT_WORKSPACE`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; \}, `$strip`\>
|
|
1740
1774
|
|
|
1741
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1775
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:112](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/dot-env.schema.ts#L112)
|
|
1742
1776
|
|
|
1743
1777
|
Partial version of the environment variables schema where all fields are optional.
|
|
1744
1778
|
Useful for validating incomplete configurations during development or build time.
|
|
@@ -1749,7 +1783,7 @@ Useful for validating incomplete configurations during development or build time
|
|
|
1749
1783
|
|
|
1750
1784
|
> `const` **IdSchema**: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>
|
|
1751
1785
|
|
|
1752
|
-
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1786
|
+
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/id.schema.ts#L17)
|
|
1753
1787
|
|
|
1754
1788
|
Schema for validating database IDs. Accepts both PostgreSQL UUIDs and MongoDB ObjectIDs.
|
|
1755
1789
|
PostgreSQL UUIDs are 32 hexadecimal characters with hyphens (e.g. 123e4567-e89b-12d3-a456-426614174000).
|
|
@@ -1773,7 +1807,7 @@ const isValidObjectId = IdSchema.safeParse("507f1f77bcf86cd799439011").success;
|
|
|
1773
1807
|
|
|
1774
1808
|
> `const` **PersonalAccessTokenSchema**: `ZodString`
|
|
1775
1809
|
|
|
1776
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1810
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/access-token.schema.ts#L14)
|
|
1777
1811
|
|
|
1778
1812
|
Schema for validating personal access tokens.
|
|
1779
1813
|
Personal access tokens start with 'sm_pat_' prefix.
|
|
@@ -1784,7 +1818,7 @@ Personal access tokens start with 'sm_pat_' prefix.
|
|
|
1784
1818
|
|
|
1785
1819
|
> `const` **runsInBrowser**: `boolean` = `isBrowser`
|
|
1786
1820
|
|
|
1787
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1821
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/runtime/ensure-server.ts#L40)
|
|
1788
1822
|
|
|
1789
1823
|
Boolean indicating if code is currently running in a browser environment
|
|
1790
1824
|
|
|
@@ -1794,17 +1828,27 @@ Boolean indicating if code is currently running in a browser environment
|
|
|
1794
1828
|
|
|
1795
1829
|
> `const` **runsOnServer**: `boolean` = `!isBrowser`
|
|
1796
1830
|
|
|
1797
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1831
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/runtime/ensure-server.ts#L45)
|
|
1798
1832
|
|
|
1799
1833
|
Boolean indicating if code is currently running in a server environment
|
|
1800
1834
|
|
|
1801
1835
|
***
|
|
1802
1836
|
|
|
1837
|
+
#### STANDALONE\_INSTANCE
|
|
1838
|
+
|
|
1839
|
+
> `const` **STANDALONE\_INSTANCE**: `"standalone"` = `"standalone"`
|
|
1840
|
+
|
|
1841
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:10](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/dot-env.schema.ts#L10)
|
|
1842
|
+
|
|
1843
|
+
Use this value to indicate that the resources are not part of the SettleMint platform.
|
|
1844
|
+
|
|
1845
|
+
***
|
|
1846
|
+
|
|
1803
1847
|
#### UniqueNameSchema
|
|
1804
1848
|
|
|
1805
1849
|
> `const` **UniqueNameSchema**: `ZodString`
|
|
1806
1850
|
|
|
1807
|
-
Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1851
|
+
Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/unique-name.schema.ts#L19)
|
|
1808
1852
|
|
|
1809
1853
|
Schema for validating unique names used across the SettleMint platform.
|
|
1810
1854
|
Only accepts lowercase alphanumeric characters and hyphens.
|
|
@@ -1830,7 +1874,7 @@ const isInvalidName = UniqueNameSchema.safeParse("My Workspace!").success;
|
|
|
1830
1874
|
|
|
1831
1875
|
> `const` **UrlOrPathSchema**: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>
|
|
1832
1876
|
|
|
1833
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1877
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/url.schema.ts#L54)
|
|
1834
1878
|
|
|
1835
1879
|
Schema that accepts either a full URL or a URL path.
|
|
1836
1880
|
|
|
@@ -1854,7 +1898,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
1854
1898
|
|
|
1855
1899
|
> `const` **UrlPathSchema**: `ZodString`
|
|
1856
1900
|
|
|
1857
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1901
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/url.schema.ts#L34)
|
|
1858
1902
|
|
|
1859
1903
|
Schema for validating URL paths.
|
|
1860
1904
|
|
|
@@ -1878,7 +1922,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
1878
1922
|
|
|
1879
1923
|
> `const` **UrlSchema**: `ZodString`
|
|
1880
1924
|
|
|
1881
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.
|
|
1925
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/utils/src/validation/url.schema.ts#L17)
|
|
1882
1926
|
|
|
1883
1927
|
Schema for validating URLs.
|
|
1884
1928
|
|