@settlemint/sdk-utils 2.3.8-mainb7108730 → 2.3.8-pr8d699549
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 +18 -7
- package/dist/environment.cjs +4501 -3924
- package/dist/environment.cjs.map +1 -1
- package/dist/environment.d.cts +7 -31
- package/dist/environment.d.ts +7 -31
- package/dist/environment.js +4501 -3924
- package/dist/environment.js.map +1 -1
- package/dist/filesystem.d.cts +1 -17
- package/dist/filesystem.d.ts +1 -17
- package/dist/http.d.cts +0 -4
- package/dist/http.d.ts +0 -4
- package/dist/index.d.cts +0 -4
- package/dist/index.d.ts +0 -4
- package/dist/json.d.cts +0 -1
- package/dist/json.d.ts +0 -1
- package/dist/logging.d.cts +2 -3
- package/dist/logging.d.ts +2 -3
- package/dist/package-manager.d.cts +1 -16
- package/dist/package-manager.d.ts +1 -16
- package/dist/retry.d.cts +0 -1
- package/dist/retry.d.ts +0 -1
- package/dist/runtime.d.cts +0 -1
- package/dist/runtime.d.ts +0 -1
- package/dist/string.d.cts +0 -1
- package/dist/string.d.ts +0 -1
- package/dist/terminal.d.cts +1 -20
- package/dist/terminal.d.ts +1 -20
- package/dist/url.d.cts +0 -1
- package/dist/url.d.ts +0 -1
- package/dist/validation.cjs +4503 -3925
- package/dist/validation.cjs.map +1 -1
- package/dist/validation.d.cts +8 -30
- package/dist/validation.d.ts +8 -30
- package/dist/validation.js +4503 -3926
- package/dist/validation.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -89,6 +89,7 @@
|
|
|
89
89
|
- [DotEnvSchema](#dotenvschema)
|
|
90
90
|
- [DotEnvSchemaPartial](#dotenvschemapartial)
|
|
91
91
|
- [IdSchema](#idschema)
|
|
92
|
+
- [LOCAL\_INSTANCE](#local_instance)
|
|
92
93
|
- [PersonalAccessTokenSchema](#personalaccesstokenschema)
|
|
93
94
|
- [runsInBrowser](#runsinbrowser)
|
|
94
95
|
- [runsOnServer](#runsonserver)
|
|
@@ -1454,7 +1455,7 @@ Validates a value against a given Zod schema.
|
|
|
1454
1455
|
|
|
1455
1456
|
| Type Parameter |
|
|
1456
1457
|
| ------ |
|
|
1457
|
-
| `T` *extends* `ZodType`\<`unknown`, `unknown
|
|
1458
|
+
| `T` *extends* `ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> |
|
|
1458
1459
|
|
|
1459
1460
|
##### Parameters
|
|
1460
1461
|
|
|
@@ -1697,7 +1698,7 @@ Options for configuring the spinner behavior
|
|
|
1697
1698
|
|
|
1698
1699
|
> **DotEnv** = `z.infer`\<*typeof* [`DotEnvSchema`](#dotenvschema)\>
|
|
1699
1700
|
|
|
1700
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1701
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:112](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/dot-env.schema.ts#L112)
|
|
1701
1702
|
|
|
1702
1703
|
Type definition for the environment variables schema.
|
|
1703
1704
|
|
|
@@ -1707,7 +1708,7 @@ Type definition for the environment variables schema.
|
|
|
1707
1708
|
|
|
1708
1709
|
> **DotEnvPartial** = `z.infer`\<*typeof* [`DotEnvSchemaPartial`](#dotenvschemapartial)\>
|
|
1709
1710
|
|
|
1710
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1711
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:123](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/dot-env.schema.ts#L123)
|
|
1711
1712
|
|
|
1712
1713
|
Type definition for the partial environment variables schema.
|
|
1713
1714
|
|
|
@@ -1758,9 +1759,9 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1758
1759
|
|
|
1759
1760
|
#### DotEnvSchema
|
|
1760
1761
|
|
|
1761
|
-
> `const` **DotEnvSchema**: `ZodObject`\<\{ `
|
|
1762
|
+
> `const` **DotEnvSchema**: `ZodObject`\<\{ `SETTLEMINT_ACCESS_TOKEN`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_APPLICATION`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NETWORK`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_CUSTOM_DEPLOYMENT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_ADMIN_SECRET`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_DATABASE_URL`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HD_PRIVATE_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_INSTANCE`: `ZodDefault`\<`ZodUnion`\<readonly \[`ZodString`, `ZodLiteral`\<`"standalone"`\>, `ZodLiteral`\<`"local"`\>\]\>\>; `SETTLEMINT_IPFS`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_IPFS_API_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_IPFS_GATEWAY_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_IPFS_PINNING_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_LOG_LEVEL`: `ZodDefault`\<`ZodEnum`\<\{ `debug`: `"debug"`; `error`: `"error"`; `info`: `"info"`; `none`: `"none"`; `warn`: `"warn"`; \}\>\>; `SETTLEMINT_MINIO`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_MINIO_ACCESS_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_MINIO_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_MINIO_SECRET_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_NEW_PROJECT_NAME`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL_REST_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL_WS_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_THEGRAPH`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS`: `ZodPipe`\<`ZodTransform`\<`null` \| `never`[], `unknown`\>, `ZodOptional`\<`ZodArray`\<`ZodString`\>\>\>; `SETTLEMINT_WORKSPACE`: `ZodOptional`\<`ZodString`\>; \}, `$strip`\>
|
|
1762
1763
|
|
|
1763
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1764
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/dot-env.schema.ts#L21)
|
|
1764
1765
|
|
|
1765
1766
|
Schema for validating environment variables used by the SettleMint SDK.
|
|
1766
1767
|
Defines validation rules and types for configuration values like URLs,
|
|
@@ -1770,9 +1771,9 @@ access tokens, workspace names, and service endpoints.
|
|
|
1770
1771
|
|
|
1771
1772
|
#### DotEnvSchemaPartial
|
|
1772
1773
|
|
|
1773
|
-
> `const` **DotEnvSchemaPartial**: `ZodObject`\<\{ `
|
|
1774
|
+
> `const` **DotEnvSchemaPartial**: `ZodObject`\<\{ `SETTLEMINT_ACCESS_TOKEN`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_APPLICATION`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NETWORK`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_CUSTOM_DEPLOYMENT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_ADMIN_SECRET`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_DATABASE_URL`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HD_PRIVATE_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_INSTANCE`: `ZodOptional`\<`ZodDefault`\<`ZodUnion`\<readonly \[`ZodString`, `ZodLiteral`\<`"standalone"`\>, `ZodLiteral`\<`"local"`\>\]\>\>\>; `SETTLEMINT_IPFS`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_IPFS_API_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_IPFS_GATEWAY_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_IPFS_PINNING_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_LOG_LEVEL`: `ZodOptional`\<`ZodDefault`\<`ZodEnum`\<\{ `debug`: `"debug"`; `error`: `"error"`; `info`: `"info"`; `none`: `"none"`; `warn`: `"warn"`; \}\>\>\>; `SETTLEMINT_MINIO`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_MINIO_ACCESS_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_MINIO_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_MINIO_SECRET_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_NEW_PROJECT_NAME`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL_REST_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL_WS_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_THEGRAPH`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS`: `ZodOptional`\<`ZodPipe`\<`ZodTransform`\<`null` \| `never`[], `unknown`\>, `ZodOptional`\<`ZodArray`\<`ZodString`\>\>\>\>; `SETTLEMINT_WORKSPACE`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; \}, `$strip`\>
|
|
1774
1775
|
|
|
1775
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1776
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:118](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/dot-env.schema.ts#L118)
|
|
1776
1777
|
|
|
1777
1778
|
Partial version of the environment variables schema where all fields are optional.
|
|
1778
1779
|
Useful for validating incomplete configurations during development or build time.
|
|
@@ -1803,6 +1804,16 @@ const isValidObjectId = IdSchema.safeParse("507f1f77bcf86cd799439011").success;
|
|
|
1803
1804
|
|
|
1804
1805
|
***
|
|
1805
1806
|
|
|
1807
|
+
#### LOCAL\_INSTANCE
|
|
1808
|
+
|
|
1809
|
+
> `const` **LOCAL\_INSTANCE**: `"local"` = `"local"`
|
|
1810
|
+
|
|
1811
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/utils/src/validation/dot-env.schema.ts#L14)
|
|
1812
|
+
|
|
1813
|
+
Use this value to indicate that the resources are not part of the SettleMint platform.
|
|
1814
|
+
|
|
1815
|
+
***
|
|
1816
|
+
|
|
1806
1817
|
#### PersonalAccessTokenSchema
|
|
1807
1818
|
|
|
1808
1819
|
> `const` **PersonalAccessTokenSchema**: `ZodString`
|