@settlemint/sdk-utils 2.1.1-pr48657fc9 → 2.1.1-prca6b6840
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 +201 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -75,10 +75,16 @@
|
|
|
75
75
|
- [LoggerOptions](#loggeroptions)
|
|
76
76
|
- [SpinnerOptions\<R\>](#spinneroptionsr)
|
|
77
77
|
- [Type Aliases](#type-aliases)
|
|
78
|
+
- [AccessToken](#accesstoken)
|
|
79
|
+
- [ApplicationAccessToken](#applicationaccesstoken)
|
|
78
80
|
- [DotEnv](#dotenv)
|
|
79
81
|
- [DotEnvPartial](#dotenvpartial)
|
|
80
82
|
- [Id](#id)
|
|
81
83
|
- [LogLevel](#loglevel)
|
|
84
|
+
- [PersonalAccessToken](#personalaccesstoken)
|
|
85
|
+
- [Url](#url)
|
|
86
|
+
- [UrlOrPath](#urlorpath)
|
|
87
|
+
- [UrlPath](#urlpath)
|
|
82
88
|
- [Variables](#variables)
|
|
83
89
|
- [AccessTokenSchema](#accesstokenschema)
|
|
84
90
|
- [ApplicationAccessTokenSchema](#applicationaccesstokenschema)
|
|
@@ -1520,29 +1526,129 @@ Options for configuring the spinner behavior
|
|
|
1520
1526
|
|
|
1521
1527
|
### Type Aliases
|
|
1522
1528
|
|
|
1529
|
+
#### AccessToken
|
|
1530
|
+
|
|
1531
|
+
> **AccessToken** = `string`
|
|
1532
|
+
|
|
1533
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/access-token.schema.ts#L22)
|
|
1534
|
+
|
|
1535
|
+
Schema for validating both application and personal access tokens.
|
|
1536
|
+
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
1537
|
+
|
|
1538
|
+
***
|
|
1539
|
+
|
|
1540
|
+
#### ApplicationAccessToken
|
|
1541
|
+
|
|
1542
|
+
> **ApplicationAccessToken** = `string`
|
|
1543
|
+
|
|
1544
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/access-token.schema.ts#L8)
|
|
1545
|
+
|
|
1546
|
+
Schema for validating application access tokens.
|
|
1547
|
+
Application access tokens start with 'sm_aat_' prefix.
|
|
1548
|
+
|
|
1549
|
+
***
|
|
1550
|
+
|
|
1523
1551
|
#### DotEnv
|
|
1524
1552
|
|
|
1525
|
-
> **DotEnv** = `
|
|
1553
|
+
> **DotEnv** = `object`
|
|
1526
1554
|
|
|
1527
1555
|
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:91](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L91)
|
|
1528
1556
|
|
|
1529
1557
|
Type definition for the environment variables schema.
|
|
1530
1558
|
|
|
1559
|
+
##### Type declaration
|
|
1560
|
+
|
|
1561
|
+
| Name | Type | Description | Defined in |
|
|
1562
|
+
| ------ | ------ | ------ | ------ |
|
|
1563
|
+
| <a id="settlemint_access_token"></a> `SETTLEMINT_ACCESS_TOKEN?` | `string` | Application access token for authenticating with SettleMint services | [sdk/utils/src/validation/dot-env.schema.ts:16](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L16) |
|
|
1564
|
+
| <a id="settlemint_accessible_private_key"></a> `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY?` | `string` | Unique name of the accessible private key | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L55) |
|
|
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.1/sdk/utils/src/validation/dot-env.schema.ts#L22) |
|
|
1566
|
+
| <a id="settlemint_blockchain_network"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK?` | `string` | Unique name of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:24](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L24) |
|
|
1567
|
+
| <a id="settlemint_blockchain_node"></a> `SETTLEMINT_BLOCKCHAIN_NODE?` | `string` | Unique name of the blockchain node | [sdk/utils/src/validation/dot-env.schema.ts:26](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L26) |
|
|
1568
|
+
| <a id="settlemint_blockscout"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:77](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L77) |
|
|
1569
|
+
| <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:79](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L79) |
|
|
1570
|
+
| <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:81](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L81) |
|
|
1571
|
+
| <a id="settlemint_custom_deployment"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT?` | `string` | Unique name of the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:73](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L73) |
|
|
1572
|
+
| <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:75](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L75) |
|
|
1573
|
+
| <a id="settlemint_hasura"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L30) |
|
|
1574
|
+
| <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:34](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L34) |
|
|
1575
|
+
| <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:36](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L36) |
|
|
1576
|
+
| <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:32](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L32) |
|
|
1577
|
+
| <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:53](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L53) |
|
|
1578
|
+
| <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.1/sdk/utils/src/validation/dot-env.schema.ts#L14) |
|
|
1579
|
+
| <a id="settlemint_ipfs"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:65](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L65) |
|
|
1580
|
+
| <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:67](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L67) |
|
|
1581
|
+
| <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:71](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L71) |
|
|
1582
|
+
| <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:69](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L69) |
|
|
1583
|
+
| <a id="settlemint_load_balancer"></a> `SETTLEMINT_LOAD_BALANCER?` | `string` | Unique name of the load balancer | [sdk/utils/src/validation/dot-env.schema.ts:28](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L28) |
|
|
1584
|
+
| <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:85](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L85) |
|
|
1585
|
+
| <a id="settlemint_minio"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:57](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L57) |
|
|
1586
|
+
| <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:61](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L61) |
|
|
1587
|
+
| <a id="settlemint_minio_endpoint"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:59](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L59) |
|
|
1588
|
+
| <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:63](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L63) |
|
|
1589
|
+
| <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:83](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L83) |
|
|
1590
|
+
| <a id="settlemint_portal"></a> `SETTLEMINT_PORTAL?` | `string` | Unique name of the Smart Contract Portal instance | [sdk/utils/src/validation/dot-env.schema.ts:47](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L47) |
|
|
1591
|
+
| <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:49](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L49) |
|
|
1592
|
+
| <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:51](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L51) |
|
|
1593
|
+
| <a id="settlemint_thegraph"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L38) |
|
|
1594
|
+
| <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:45](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L45) |
|
|
1595
|
+
| <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:40](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L40) |
|
|
1596
|
+
| <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.1/sdk/utils/src/validation/dot-env.schema.ts#L20) |
|
|
1597
|
+
|
|
1531
1598
|
***
|
|
1532
1599
|
|
|
1533
1600
|
#### DotEnvPartial
|
|
1534
1601
|
|
|
1535
|
-
> **DotEnvPartial** = `
|
|
1602
|
+
> **DotEnvPartial** = `object`
|
|
1536
1603
|
|
|
1537
1604
|
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:102](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L102)
|
|
1538
1605
|
|
|
1539
1606
|
Type definition for the partial environment variables schema.
|
|
1540
1607
|
|
|
1608
|
+
##### Type declaration
|
|
1609
|
+
|
|
1610
|
+
| Name | Type | Description | Defined in |
|
|
1611
|
+
| ------ | ------ | ------ | ------ |
|
|
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.1/sdk/utils/src/validation/dot-env.schema.ts#L16) |
|
|
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:55](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L55) |
|
|
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.1/sdk/utils/src/validation/dot-env.schema.ts#L22) |
|
|
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.1/sdk/utils/src/validation/dot-env.schema.ts#L24) |
|
|
1616
|
+
| <a id="settlemint_blockchain_node-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE?` | `string` | Unique name of the blockchain node | [sdk/utils/src/validation/dot-env.schema.ts:26](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L26) |
|
|
1617
|
+
| <a id="settlemint_blockscout-1"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:77](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L77) |
|
|
1618
|
+
| <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:79](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L79) |
|
|
1619
|
+
| <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:81](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L81) |
|
|
1620
|
+
| <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:73](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L73) |
|
|
1621
|
+
| <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:75](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L75) |
|
|
1622
|
+
| <a id="settlemint_hasura-1"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L30) |
|
|
1623
|
+
| <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:34](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L34) |
|
|
1624
|
+
| <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:36](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L36) |
|
|
1625
|
+
| <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:32](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L32) |
|
|
1626
|
+
| <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:53](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L53) |
|
|
1627
|
+
| <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.1/sdk/utils/src/validation/dot-env.schema.ts#L14) |
|
|
1628
|
+
| <a id="settlemint_ipfs-1"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:65](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L65) |
|
|
1629
|
+
| <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:67](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L67) |
|
|
1630
|
+
| <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:71](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L71) |
|
|
1631
|
+
| <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:69](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L69) |
|
|
1632
|
+
| <a id="settlemint_load_balancer-1"></a> `SETTLEMINT_LOAD_BALANCER?` | `string` | Unique name of the load balancer | [sdk/utils/src/validation/dot-env.schema.ts:28](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L28) |
|
|
1633
|
+
| <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:85](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L85) |
|
|
1634
|
+
| <a id="settlemint_minio-1"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:57](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L57) |
|
|
1635
|
+
| <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:61](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L61) |
|
|
1636
|
+
| <a id="settlemint_minio_endpoint-1"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:59](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L59) |
|
|
1637
|
+
| <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:63](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L63) |
|
|
1638
|
+
| <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:83](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L83) |
|
|
1639
|
+
| <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:47](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L47) |
|
|
1640
|
+
| <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:49](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L49) |
|
|
1641
|
+
| <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:51](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L51) |
|
|
1642
|
+
| <a id="settlemint_thegraph-1"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L38) |
|
|
1643
|
+
| <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:45](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L45) |
|
|
1644
|
+
| <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:40](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L40) |
|
|
1645
|
+
| <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.1/sdk/utils/src/validation/dot-env.schema.ts#L20) |
|
|
1646
|
+
|
|
1541
1647
|
***
|
|
1542
1648
|
|
|
1543
1649
|
#### Id
|
|
1544
1650
|
|
|
1545
|
-
> **Id** = `
|
|
1651
|
+
> **Id** = `string`
|
|
1546
1652
|
|
|
1547
1653
|
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/id.schema.ts#L30)
|
|
1548
1654
|
|
|
@@ -1559,11 +1665,94 @@ Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sd
|
|
|
1559
1665
|
|
|
1560
1666
|
Log levels supported by the logger
|
|
1561
1667
|
|
|
1668
|
+
***
|
|
1669
|
+
|
|
1670
|
+
#### PersonalAccessToken
|
|
1671
|
+
|
|
1672
|
+
> **PersonalAccessToken** = `string`
|
|
1673
|
+
|
|
1674
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/access-token.schema.ts#L15)
|
|
1675
|
+
|
|
1676
|
+
Schema for validating personal access tokens.
|
|
1677
|
+
Personal access tokens start with 'sm_pat_' prefix.
|
|
1678
|
+
|
|
1679
|
+
***
|
|
1680
|
+
|
|
1681
|
+
#### Url
|
|
1682
|
+
|
|
1683
|
+
> **Url** = `string`
|
|
1684
|
+
|
|
1685
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/url.schema.ts#L18)
|
|
1686
|
+
|
|
1687
|
+
Schema for validating URLs.
|
|
1688
|
+
|
|
1689
|
+
##### Example
|
|
1690
|
+
|
|
1691
|
+
```ts
|
|
1692
|
+
import { UrlSchema } from "@settlemint/sdk-utils/validation";
|
|
1693
|
+
|
|
1694
|
+
// Validate a URL
|
|
1695
|
+
const isValidUrl = UrlSchema.safeParse("https://console.settlemint.com").success;
|
|
1696
|
+
// true
|
|
1697
|
+
|
|
1698
|
+
// Invalid URLs will fail validation
|
|
1699
|
+
const isInvalidUrl = UrlSchema.safeParse("not-a-url").success;
|
|
1700
|
+
// false
|
|
1701
|
+
```
|
|
1702
|
+
|
|
1703
|
+
***
|
|
1704
|
+
|
|
1705
|
+
#### UrlOrPath
|
|
1706
|
+
|
|
1707
|
+
> **UrlOrPath** = `string`
|
|
1708
|
+
|
|
1709
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/url.schema.ts#L55)
|
|
1710
|
+
|
|
1711
|
+
Schema that accepts either a full URL or a URL path.
|
|
1712
|
+
|
|
1713
|
+
##### Example
|
|
1714
|
+
|
|
1715
|
+
```ts
|
|
1716
|
+
import { UrlOrPathSchema } from "@settlemint/sdk-utils/validation";
|
|
1717
|
+
|
|
1718
|
+
// Validate a URL
|
|
1719
|
+
const isValidUrl = UrlOrPathSchema.safeParse("https://console.settlemint.com").success;
|
|
1720
|
+
// true
|
|
1721
|
+
|
|
1722
|
+
// Validate a path
|
|
1723
|
+
const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
1724
|
+
// true
|
|
1725
|
+
```
|
|
1726
|
+
|
|
1727
|
+
***
|
|
1728
|
+
|
|
1729
|
+
#### UrlPath
|
|
1730
|
+
|
|
1731
|
+
> **UrlPath** = `string`
|
|
1732
|
+
|
|
1733
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/url.schema.ts#L38)
|
|
1734
|
+
|
|
1735
|
+
Schema for validating URL paths.
|
|
1736
|
+
|
|
1737
|
+
##### Example
|
|
1738
|
+
|
|
1739
|
+
```ts
|
|
1740
|
+
import { UrlPathSchema } from "@settlemint/sdk-utils/validation";
|
|
1741
|
+
|
|
1742
|
+
// Validate a URL path
|
|
1743
|
+
const isValidPath = UrlPathSchema.safeParse("/api/v1/users").success;
|
|
1744
|
+
// true
|
|
1745
|
+
|
|
1746
|
+
// Invalid paths will fail validation
|
|
1747
|
+
const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
1748
|
+
// false
|
|
1749
|
+
```
|
|
1750
|
+
|
|
1562
1751
|
### Variables
|
|
1563
1752
|
|
|
1564
1753
|
#### AccessTokenSchema
|
|
1565
1754
|
|
|
1566
|
-
> `const` **AccessTokenSchema**: `ZodString`
|
|
1755
|
+
> `const` **AccessTokenSchema**: `ZodString`\<[`AccessToken`](#accesstoken)\>
|
|
1567
1756
|
|
|
1568
1757
|
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/access-token.schema.ts#L21)
|
|
1569
1758
|
|
|
@@ -1574,7 +1763,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1574
1763
|
|
|
1575
1764
|
#### ApplicationAccessTokenSchema
|
|
1576
1765
|
|
|
1577
|
-
> `const` **ApplicationAccessTokenSchema**: `ZodString`
|
|
1766
|
+
> `const` **ApplicationAccessTokenSchema**: `ZodString`\<[`ApplicationAccessToken`](#applicationaccesstoken)\>
|
|
1578
1767
|
|
|
1579
1768
|
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/access-token.schema.ts#L7)
|
|
1580
1769
|
|
|
@@ -1585,7 +1774,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1585
1774
|
|
|
1586
1775
|
#### DotEnvSchema
|
|
1587
1776
|
|
|
1588
|
-
> `const` **DotEnvSchema**: `ZodObject
|
|
1777
|
+
> `const` **DotEnvSchema**: `ZodObject`\<[`DotEnv`](#dotenv)\>
|
|
1589
1778
|
|
|
1590
1779
|
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:12](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L12)
|
|
1591
1780
|
|
|
@@ -1597,7 +1786,7 @@ access tokens, workspace names, and service endpoints.
|
|
|
1597
1786
|
|
|
1598
1787
|
#### DotEnvSchemaPartial
|
|
1599
1788
|
|
|
1600
|
-
> `const` **DotEnvSchemaPartial**: `ZodObject
|
|
1789
|
+
> `const` **DotEnvSchemaPartial**: `ZodObject`\<[`DotEnvPartial`](#dotenvpartial)\>
|
|
1601
1790
|
|
|
1602
1791
|
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:97](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/dot-env.schema.ts#L97)
|
|
1603
1792
|
|
|
@@ -1608,7 +1797,7 @@ Useful for validating incomplete configurations during development or build time
|
|
|
1608
1797
|
|
|
1609
1798
|
#### IdSchema
|
|
1610
1799
|
|
|
1611
|
-
> `const` **IdSchema**: `ZodUnion
|
|
1800
|
+
> `const` **IdSchema**: `ZodUnion`\<[`Id`](#id)\>
|
|
1612
1801
|
|
|
1613
1802
|
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/id.schema.ts#L17)
|
|
1614
1803
|
|
|
@@ -1632,7 +1821,7 @@ const isValidObjectId = IdSchema.safeParse("507f1f77bcf86cd799439011").success;
|
|
|
1632
1821
|
|
|
1633
1822
|
#### PersonalAccessTokenSchema
|
|
1634
1823
|
|
|
1635
|
-
> `const` **PersonalAccessTokenSchema**: `ZodString`
|
|
1824
|
+
> `const` **PersonalAccessTokenSchema**: `ZodString`\<[`PersonalAccessToken`](#personalaccesstoken)\>
|
|
1636
1825
|
|
|
1637
1826
|
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/access-token.schema.ts#L14)
|
|
1638
1827
|
|
|
@@ -1689,7 +1878,7 @@ const isInvalidName = UniqueNameSchema.safeParse("My Workspace!").success;
|
|
|
1689
1878
|
|
|
1690
1879
|
#### UrlOrPathSchema
|
|
1691
1880
|
|
|
1692
|
-
> `const` **UrlOrPathSchema**: `ZodUnion
|
|
1881
|
+
> `const` **UrlOrPathSchema**: `ZodUnion`\<[`UrlOrPath`](#urlorpath)\>
|
|
1693
1882
|
|
|
1694
1883
|
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/url.schema.ts#L54)
|
|
1695
1884
|
|
|
@@ -1713,7 +1902,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
1713
1902
|
|
|
1714
1903
|
#### UrlPathSchema
|
|
1715
1904
|
|
|
1716
|
-
> `const` **UrlPathSchema**: `ZodString`
|
|
1905
|
+
> `const` **UrlPathSchema**: `ZodString`\<[`UrlPath`](#urlpath)\>
|
|
1717
1906
|
|
|
1718
1907
|
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/url.schema.ts#L34)
|
|
1719
1908
|
|
|
@@ -1737,7 +1926,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
1737
1926
|
|
|
1738
1927
|
#### UrlSchema
|
|
1739
1928
|
|
|
1740
|
-
> `const` **UrlSchema**: `ZodString`
|
|
1929
|
+
> `const` **UrlSchema**: `ZodString`\<[`Url`](#url)\>
|
|
1741
1930
|
|
|
1742
1931
|
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/utils/src/validation/url.schema.ts#L17)
|
|
1743
1932
|
|
package/package.json
CHANGED