@settlemint/sdk-utils 2.3.2-pref69a5a3 → 2.3.2-preff27199
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 +51 -7
- package/dist/environment.cjs +17705 -384
- 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 +17743 -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 +214 -94
- package/dist/http.cjs.map +1 -1
- package/dist/http.d.cts +9 -1
- package/dist/http.d.ts +9 -1
- package/dist/http.js +226 -0
- package/dist/http.js.map +1 -0
- package/dist/index.cjs +292 -110
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +9 -0
- package/dist/index.d.ts +9 -0
- 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 +7350 -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 +7382 -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 +423 -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 +438 -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 -193
- package/dist/validation.cjs.map +1 -1
- package/dist/validation.d.cts +124 -94
- package/dist/validation.d.ts +124 -94
- package/dist/validation.js +10482 -0
- package/dist/validation.js.map +1 -0
- package/package.json +6 -6
- package/dist/environment.mjs +0 -384
- 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 -80
- package/dist/http.mjs.map +0 -1
- package/dist/index.mjs +0 -98
- 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 -161
- package/dist/validation.mjs.map +0 -1
package/dist/validation.d.cts
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ZodString, ZodType, z } from "zod/v4";
|
|
2
2
|
|
|
3
|
+
//#region src/validation/validate.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* Validates a value against a given Zod schema.
|
|
6
|
+
*
|
|
7
|
+
* @param schema - The Zod schema to validate against.
|
|
8
|
+
* @param value - The value to validate.
|
|
9
|
+
* @returns The validated and parsed value.
|
|
10
|
+
* @throws Will throw an error if validation fails, with formatted error messages.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* import { validate } from "@settlemint/sdk-utils/validation";
|
|
14
|
+
*
|
|
15
|
+
* const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
|
|
16
|
+
*/
|
|
3
17
|
/**
|
|
4
18
|
* Validates a value against a given Zod schema.
|
|
5
19
|
*
|
|
@@ -15,6 +29,8 @@ import { ZodType, ZodString, z } from 'zod/v4';
|
|
|
15
29
|
*/
|
|
16
30
|
declare function validate<T extends ZodType>(schema: T, value: unknown): T["_output"];
|
|
17
31
|
|
|
32
|
+
//#endregion
|
|
33
|
+
//#region src/validation/access-token.schema.d.ts
|
|
18
34
|
/**
|
|
19
35
|
* Schema for validating application access tokens.
|
|
20
36
|
* Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -34,6 +50,8 @@ type PersonalAccessToken = z.infer<typeof PersonalAccessTokenSchema>;
|
|
|
34
50
|
declare const AccessTokenSchema: ZodString;
|
|
35
51
|
type AccessToken = z.infer<typeof AccessTokenSchema>;
|
|
36
52
|
|
|
53
|
+
//#endregion
|
|
54
|
+
//#region src/validation/dot-env.schema.d.ts
|
|
37
55
|
/**
|
|
38
56
|
* Use this value to indicate that the resources are not part of the SettleMint platform.
|
|
39
57
|
*/
|
|
@@ -44,52 +62,52 @@ declare const STANDALONE_INSTANCE = "standalone";
|
|
|
44
62
|
* access tokens, workspace names, and service endpoints.
|
|
45
63
|
*/
|
|
46
64
|
declare const DotEnvSchema: z.ZodObject<{
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
65
|
+
SETTLEMINT_INSTANCE: z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"standalone">]>>;
|
|
66
|
+
SETTLEMINT_ACCESS_TOKEN: z.ZodOptional<z.ZodString>;
|
|
67
|
+
SETTLEMINT_PERSONAL_ACCESS_TOKEN: z.ZodOptional<z.ZodString>;
|
|
68
|
+
SETTLEMINT_WORKSPACE: z.ZodOptional<z.ZodString>;
|
|
69
|
+
SETTLEMINT_APPLICATION: z.ZodOptional<z.ZodString>;
|
|
70
|
+
SETTLEMINT_BLOCKCHAIN_NETWORK: z.ZodOptional<z.ZodString>;
|
|
71
|
+
SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID: z.ZodOptional<z.ZodString>;
|
|
72
|
+
SETTLEMINT_BLOCKCHAIN_NODE: z.ZodOptional<z.ZodString>;
|
|
73
|
+
SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
74
|
+
SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER: z.ZodOptional<z.ZodString>;
|
|
75
|
+
SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
76
|
+
SETTLEMINT_HASURA: z.ZodOptional<z.ZodString>;
|
|
77
|
+
SETTLEMINT_HASURA_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
78
|
+
SETTLEMINT_HASURA_ADMIN_SECRET: z.ZodOptional<z.ZodString>;
|
|
79
|
+
SETTLEMINT_HASURA_DATABASE_URL: z.ZodOptional<z.ZodString>;
|
|
80
|
+
SETTLEMINT_THEGRAPH: z.ZodOptional<z.ZodString>;
|
|
81
|
+
SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS: z.ZodPipe<z.ZodTransform<never[] | null, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
82
|
+
SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH: z.ZodOptional<z.ZodString>;
|
|
83
|
+
SETTLEMINT_PORTAL: z.ZodOptional<z.ZodString>;
|
|
84
|
+
SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
85
|
+
SETTLEMINT_PORTAL_REST_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
86
|
+
SETTLEMINT_PORTAL_WS_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
87
|
+
SETTLEMINT_HD_PRIVATE_KEY: z.ZodOptional<z.ZodString>;
|
|
88
|
+
SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS: z.ZodOptional<z.ZodString>;
|
|
89
|
+
SETTLEMINT_ACCESSIBLE_PRIVATE_KEY: z.ZodOptional<z.ZodString>;
|
|
90
|
+
SETTLEMINT_MINIO: z.ZodOptional<z.ZodString>;
|
|
91
|
+
SETTLEMINT_MINIO_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
92
|
+
SETTLEMINT_MINIO_ACCESS_KEY: z.ZodOptional<z.ZodString>;
|
|
93
|
+
SETTLEMINT_MINIO_SECRET_KEY: z.ZodOptional<z.ZodString>;
|
|
94
|
+
SETTLEMINT_IPFS: z.ZodOptional<z.ZodString>;
|
|
95
|
+
SETTLEMINT_IPFS_API_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
96
|
+
SETTLEMINT_IPFS_PINNING_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
97
|
+
SETTLEMINT_IPFS_GATEWAY_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
98
|
+
SETTLEMINT_CUSTOM_DEPLOYMENT: z.ZodOptional<z.ZodString>;
|
|
99
|
+
SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
100
|
+
SETTLEMINT_BLOCKSCOUT: z.ZodOptional<z.ZodString>;
|
|
101
|
+
SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
102
|
+
SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
103
|
+
SETTLEMINT_NEW_PROJECT_NAME: z.ZodOptional<z.ZodString>;
|
|
104
|
+
SETTLEMINT_LOG_LEVEL: z.ZodDefault<z.ZodEnum<{
|
|
105
|
+
error: "error";
|
|
106
|
+
debug: "debug";
|
|
107
|
+
info: "info";
|
|
108
|
+
warn: "warn";
|
|
109
|
+
none: "none";
|
|
110
|
+
}>>;
|
|
93
111
|
}, z.core.$strip>;
|
|
94
112
|
/**
|
|
95
113
|
* Type definition for the environment variables schema.
|
|
@@ -100,58 +118,60 @@ type DotEnv = z.infer<typeof DotEnvSchema>;
|
|
|
100
118
|
* Useful for validating incomplete configurations during development or build time.
|
|
101
119
|
*/
|
|
102
120
|
declare const DotEnvSchemaPartial: z.ZodObject<{
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
121
|
+
SETTLEMINT_INSTANCE: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"standalone">]>>>;
|
|
122
|
+
SETTLEMINT_ACCESS_TOKEN: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
123
|
+
SETTLEMINT_PERSONAL_ACCESS_TOKEN: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
124
|
+
SETTLEMINT_WORKSPACE: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
125
|
+
SETTLEMINT_APPLICATION: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
126
|
+
SETTLEMINT_BLOCKCHAIN_NETWORK: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
127
|
+
SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
128
|
+
SETTLEMINT_BLOCKCHAIN_NODE: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
129
|
+
SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
130
|
+
SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
131
|
+
SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
132
|
+
SETTLEMINT_HASURA: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
133
|
+
SETTLEMINT_HASURA_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
134
|
+
SETTLEMINT_HASURA_ADMIN_SECRET: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
135
|
+
SETTLEMINT_HASURA_DATABASE_URL: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
136
|
+
SETTLEMINT_THEGRAPH: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
137
|
+
SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS: z.ZodOptional<z.ZodPipe<z.ZodTransform<never[] | null, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>>;
|
|
138
|
+
SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
139
|
+
SETTLEMINT_PORTAL: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
140
|
+
SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
141
|
+
SETTLEMINT_PORTAL_REST_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
142
|
+
SETTLEMINT_PORTAL_WS_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
143
|
+
SETTLEMINT_HD_PRIVATE_KEY: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
144
|
+
SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
145
|
+
SETTLEMINT_ACCESSIBLE_PRIVATE_KEY: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
146
|
+
SETTLEMINT_MINIO: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
147
|
+
SETTLEMINT_MINIO_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
148
|
+
SETTLEMINT_MINIO_ACCESS_KEY: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
149
|
+
SETTLEMINT_MINIO_SECRET_KEY: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
150
|
+
SETTLEMINT_IPFS: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
151
|
+
SETTLEMINT_IPFS_API_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
152
|
+
SETTLEMINT_IPFS_PINNING_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
153
|
+
SETTLEMINT_IPFS_GATEWAY_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
154
|
+
SETTLEMINT_CUSTOM_DEPLOYMENT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
155
|
+
SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
156
|
+
SETTLEMINT_BLOCKSCOUT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
157
|
+
SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
158
|
+
SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
159
|
+
SETTLEMINT_NEW_PROJECT_NAME: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
160
|
+
SETTLEMINT_LOG_LEVEL: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
|
|
161
|
+
error: "error";
|
|
162
|
+
debug: "debug";
|
|
163
|
+
info: "info";
|
|
164
|
+
warn: "warn";
|
|
165
|
+
none: "none";
|
|
166
|
+
}>>>;
|
|
149
167
|
}, z.core.$strip>;
|
|
150
168
|
/**
|
|
151
169
|
* Type definition for the partial environment variables schema.
|
|
152
170
|
*/
|
|
153
171
|
type DotEnvPartial = z.infer<typeof DotEnvSchemaPartial>;
|
|
154
172
|
|
|
173
|
+
//#endregion
|
|
174
|
+
//#region src/validation/id.schema.d.ts
|
|
155
175
|
/**
|
|
156
176
|
* Schema for validating database IDs. Accepts both PostgreSQL UUIDs and MongoDB ObjectIDs.
|
|
157
177
|
* PostgreSQL UUIDs are 32 hexadecimal characters with hyphens (e.g. 123e4567-e89b-12d3-a456-426614174000).
|
|
@@ -173,6 +193,8 @@ declare const IdSchema: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
|
|
|
173
193
|
*/
|
|
174
194
|
type Id = z.infer<typeof IdSchema>;
|
|
175
195
|
|
|
196
|
+
//#endregion
|
|
197
|
+
//#region src/validation/unique-name.schema.d.ts
|
|
176
198
|
/**
|
|
177
199
|
* Schema for validating unique names used across the SettleMint platform.
|
|
178
200
|
* Only accepts lowercase alphanumeric characters and hyphens.
|
|
@@ -190,7 +212,13 @@ type Id = z.infer<typeof IdSchema>;
|
|
|
190
212
|
* // false
|
|
191
213
|
*/
|
|
192
214
|
declare const UniqueNameSchema: z.ZodString;
|
|
215
|
+
/**
|
|
216
|
+
* Type definition for unique names, inferred from UniqueNameSchema.
|
|
217
|
+
*/
|
|
218
|
+
type UniqueName = z.infer<typeof UniqueNameSchema>;
|
|
193
219
|
|
|
220
|
+
//#endregion
|
|
221
|
+
//#region src/validation/url.schema.d.ts
|
|
194
222
|
/**
|
|
195
223
|
* Schema for validating URLs.
|
|
196
224
|
*
|
|
@@ -240,4 +268,6 @@ type UrlPath = z.infer<typeof UrlPathSchema>;
|
|
|
240
268
|
declare const UrlOrPathSchema: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
|
|
241
269
|
type UrlOrPath = z.infer<typeof UrlOrPathSchema>;
|
|
242
270
|
|
|
243
|
-
|
|
271
|
+
//#endregion
|
|
272
|
+
export { AccessToken, AccessTokenSchema, ApplicationAccessToken, ApplicationAccessTokenSchema, DotEnv, DotEnvPartial, DotEnvSchema, DotEnvSchemaPartial, Id, IdSchema, PersonalAccessToken, PersonalAccessTokenSchema, STANDALONE_INSTANCE, UniqueNameSchema, Url, UrlOrPath, UrlOrPathSchema, UrlPath, UrlPathSchema, UrlSchema, validate };
|
|
273
|
+
//# sourceMappingURL=validation.d.cts.map
|
package/dist/validation.d.ts
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ZodString, ZodType, z } from "zod/v4";
|
|
2
2
|
|
|
3
|
+
//#region src/validation/validate.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* Validates a value against a given Zod schema.
|
|
6
|
+
*
|
|
7
|
+
* @param schema - The Zod schema to validate against.
|
|
8
|
+
* @param value - The value to validate.
|
|
9
|
+
* @returns The validated and parsed value.
|
|
10
|
+
* @throws Will throw an error if validation fails, with formatted error messages.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* import { validate } from "@settlemint/sdk-utils/validation";
|
|
14
|
+
*
|
|
15
|
+
* const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
|
|
16
|
+
*/
|
|
3
17
|
/**
|
|
4
18
|
* Validates a value against a given Zod schema.
|
|
5
19
|
*
|
|
@@ -15,6 +29,8 @@ import { ZodType, ZodString, z } from 'zod/v4';
|
|
|
15
29
|
*/
|
|
16
30
|
declare function validate<T extends ZodType>(schema: T, value: unknown): T["_output"];
|
|
17
31
|
|
|
32
|
+
//#endregion
|
|
33
|
+
//#region src/validation/access-token.schema.d.ts
|
|
18
34
|
/**
|
|
19
35
|
* Schema for validating application access tokens.
|
|
20
36
|
* Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -34,6 +50,8 @@ type PersonalAccessToken = z.infer<typeof PersonalAccessTokenSchema>;
|
|
|
34
50
|
declare const AccessTokenSchema: ZodString;
|
|
35
51
|
type AccessToken = z.infer<typeof AccessTokenSchema>;
|
|
36
52
|
|
|
53
|
+
//#endregion
|
|
54
|
+
//#region src/validation/dot-env.schema.d.ts
|
|
37
55
|
/**
|
|
38
56
|
* Use this value to indicate that the resources are not part of the SettleMint platform.
|
|
39
57
|
*/
|
|
@@ -44,52 +62,52 @@ declare const STANDALONE_INSTANCE = "standalone";
|
|
|
44
62
|
* access tokens, workspace names, and service endpoints.
|
|
45
63
|
*/
|
|
46
64
|
declare const DotEnvSchema: z.ZodObject<{
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
65
|
+
SETTLEMINT_INSTANCE: z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"standalone">]>>;
|
|
66
|
+
SETTLEMINT_ACCESS_TOKEN: z.ZodOptional<z.ZodString>;
|
|
67
|
+
SETTLEMINT_PERSONAL_ACCESS_TOKEN: z.ZodOptional<z.ZodString>;
|
|
68
|
+
SETTLEMINT_WORKSPACE: z.ZodOptional<z.ZodString>;
|
|
69
|
+
SETTLEMINT_APPLICATION: z.ZodOptional<z.ZodString>;
|
|
70
|
+
SETTLEMINT_BLOCKCHAIN_NETWORK: z.ZodOptional<z.ZodString>;
|
|
71
|
+
SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID: z.ZodOptional<z.ZodString>;
|
|
72
|
+
SETTLEMINT_BLOCKCHAIN_NODE: z.ZodOptional<z.ZodString>;
|
|
73
|
+
SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
74
|
+
SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER: z.ZodOptional<z.ZodString>;
|
|
75
|
+
SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
76
|
+
SETTLEMINT_HASURA: z.ZodOptional<z.ZodString>;
|
|
77
|
+
SETTLEMINT_HASURA_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
78
|
+
SETTLEMINT_HASURA_ADMIN_SECRET: z.ZodOptional<z.ZodString>;
|
|
79
|
+
SETTLEMINT_HASURA_DATABASE_URL: z.ZodOptional<z.ZodString>;
|
|
80
|
+
SETTLEMINT_THEGRAPH: z.ZodOptional<z.ZodString>;
|
|
81
|
+
SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS: z.ZodPipe<z.ZodTransform<never[] | null, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
82
|
+
SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH: z.ZodOptional<z.ZodString>;
|
|
83
|
+
SETTLEMINT_PORTAL: z.ZodOptional<z.ZodString>;
|
|
84
|
+
SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
85
|
+
SETTLEMINT_PORTAL_REST_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
86
|
+
SETTLEMINT_PORTAL_WS_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
87
|
+
SETTLEMINT_HD_PRIVATE_KEY: z.ZodOptional<z.ZodString>;
|
|
88
|
+
SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS: z.ZodOptional<z.ZodString>;
|
|
89
|
+
SETTLEMINT_ACCESSIBLE_PRIVATE_KEY: z.ZodOptional<z.ZodString>;
|
|
90
|
+
SETTLEMINT_MINIO: z.ZodOptional<z.ZodString>;
|
|
91
|
+
SETTLEMINT_MINIO_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
92
|
+
SETTLEMINT_MINIO_ACCESS_KEY: z.ZodOptional<z.ZodString>;
|
|
93
|
+
SETTLEMINT_MINIO_SECRET_KEY: z.ZodOptional<z.ZodString>;
|
|
94
|
+
SETTLEMINT_IPFS: z.ZodOptional<z.ZodString>;
|
|
95
|
+
SETTLEMINT_IPFS_API_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
96
|
+
SETTLEMINT_IPFS_PINNING_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
97
|
+
SETTLEMINT_IPFS_GATEWAY_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
98
|
+
SETTLEMINT_CUSTOM_DEPLOYMENT: z.ZodOptional<z.ZodString>;
|
|
99
|
+
SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
100
|
+
SETTLEMINT_BLOCKSCOUT: z.ZodOptional<z.ZodString>;
|
|
101
|
+
SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
102
|
+
SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT: z.ZodOptional<z.ZodString>;
|
|
103
|
+
SETTLEMINT_NEW_PROJECT_NAME: z.ZodOptional<z.ZodString>;
|
|
104
|
+
SETTLEMINT_LOG_LEVEL: z.ZodDefault<z.ZodEnum<{
|
|
105
|
+
error: "error";
|
|
106
|
+
debug: "debug";
|
|
107
|
+
info: "info";
|
|
108
|
+
warn: "warn";
|
|
109
|
+
none: "none";
|
|
110
|
+
}>>;
|
|
93
111
|
}, z.core.$strip>;
|
|
94
112
|
/**
|
|
95
113
|
* Type definition for the environment variables schema.
|
|
@@ -100,58 +118,60 @@ type DotEnv = z.infer<typeof DotEnvSchema>;
|
|
|
100
118
|
* Useful for validating incomplete configurations during development or build time.
|
|
101
119
|
*/
|
|
102
120
|
declare const DotEnvSchemaPartial: z.ZodObject<{
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
121
|
+
SETTLEMINT_INSTANCE: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"standalone">]>>>;
|
|
122
|
+
SETTLEMINT_ACCESS_TOKEN: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
123
|
+
SETTLEMINT_PERSONAL_ACCESS_TOKEN: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
124
|
+
SETTLEMINT_WORKSPACE: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
125
|
+
SETTLEMINT_APPLICATION: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
126
|
+
SETTLEMINT_BLOCKCHAIN_NETWORK: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
127
|
+
SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
128
|
+
SETTLEMINT_BLOCKCHAIN_NODE: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
129
|
+
SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
130
|
+
SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
131
|
+
SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
132
|
+
SETTLEMINT_HASURA: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
133
|
+
SETTLEMINT_HASURA_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
134
|
+
SETTLEMINT_HASURA_ADMIN_SECRET: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
135
|
+
SETTLEMINT_HASURA_DATABASE_URL: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
136
|
+
SETTLEMINT_THEGRAPH: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
137
|
+
SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS: z.ZodOptional<z.ZodPipe<z.ZodTransform<never[] | null, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>>;
|
|
138
|
+
SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
139
|
+
SETTLEMINT_PORTAL: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
140
|
+
SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
141
|
+
SETTLEMINT_PORTAL_REST_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
142
|
+
SETTLEMINT_PORTAL_WS_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
143
|
+
SETTLEMINT_HD_PRIVATE_KEY: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
144
|
+
SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
145
|
+
SETTLEMINT_ACCESSIBLE_PRIVATE_KEY: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
146
|
+
SETTLEMINT_MINIO: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
147
|
+
SETTLEMINT_MINIO_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
148
|
+
SETTLEMINT_MINIO_ACCESS_KEY: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
149
|
+
SETTLEMINT_MINIO_SECRET_KEY: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
150
|
+
SETTLEMINT_IPFS: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
151
|
+
SETTLEMINT_IPFS_API_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
152
|
+
SETTLEMINT_IPFS_PINNING_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
153
|
+
SETTLEMINT_IPFS_GATEWAY_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
154
|
+
SETTLEMINT_CUSTOM_DEPLOYMENT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
155
|
+
SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
156
|
+
SETTLEMINT_BLOCKSCOUT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
157
|
+
SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
158
|
+
SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
159
|
+
SETTLEMINT_NEW_PROJECT_NAME: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
160
|
+
SETTLEMINT_LOG_LEVEL: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
|
|
161
|
+
error: "error";
|
|
162
|
+
debug: "debug";
|
|
163
|
+
info: "info";
|
|
164
|
+
warn: "warn";
|
|
165
|
+
none: "none";
|
|
166
|
+
}>>>;
|
|
149
167
|
}, z.core.$strip>;
|
|
150
168
|
/**
|
|
151
169
|
* Type definition for the partial environment variables schema.
|
|
152
170
|
*/
|
|
153
171
|
type DotEnvPartial = z.infer<typeof DotEnvSchemaPartial>;
|
|
154
172
|
|
|
173
|
+
//#endregion
|
|
174
|
+
//#region src/validation/id.schema.d.ts
|
|
155
175
|
/**
|
|
156
176
|
* Schema for validating database IDs. Accepts both PostgreSQL UUIDs and MongoDB ObjectIDs.
|
|
157
177
|
* PostgreSQL UUIDs are 32 hexadecimal characters with hyphens (e.g. 123e4567-e89b-12d3-a456-426614174000).
|
|
@@ -173,6 +193,8 @@ declare const IdSchema: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
|
|
|
173
193
|
*/
|
|
174
194
|
type Id = z.infer<typeof IdSchema>;
|
|
175
195
|
|
|
196
|
+
//#endregion
|
|
197
|
+
//#region src/validation/unique-name.schema.d.ts
|
|
176
198
|
/**
|
|
177
199
|
* Schema for validating unique names used across the SettleMint platform.
|
|
178
200
|
* Only accepts lowercase alphanumeric characters and hyphens.
|
|
@@ -190,7 +212,13 @@ type Id = z.infer<typeof IdSchema>;
|
|
|
190
212
|
* // false
|
|
191
213
|
*/
|
|
192
214
|
declare const UniqueNameSchema: z.ZodString;
|
|
215
|
+
/**
|
|
216
|
+
* Type definition for unique names, inferred from UniqueNameSchema.
|
|
217
|
+
*/
|
|
218
|
+
type UniqueName = z.infer<typeof UniqueNameSchema>;
|
|
193
219
|
|
|
220
|
+
//#endregion
|
|
221
|
+
//#region src/validation/url.schema.d.ts
|
|
194
222
|
/**
|
|
195
223
|
* Schema for validating URLs.
|
|
196
224
|
*
|
|
@@ -240,4 +268,6 @@ type UrlPath = z.infer<typeof UrlPathSchema>;
|
|
|
240
268
|
declare const UrlOrPathSchema: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
|
|
241
269
|
type UrlOrPath = z.infer<typeof UrlOrPathSchema>;
|
|
242
270
|
|
|
243
|
-
|
|
271
|
+
//#endregion
|
|
272
|
+
export { AccessToken, AccessTokenSchema, ApplicationAccessToken, ApplicationAccessTokenSchema, DotEnv, DotEnvPartial, DotEnvSchema, DotEnvSchemaPartial, Id, IdSchema, PersonalAccessToken, PersonalAccessTokenSchema, STANDALONE_INSTANCE, UniqueNameSchema, Url, UrlOrPath, UrlOrPathSchema, UrlPath, UrlPathSchema, UrlSchema, validate };
|
|
273
|
+
//# sourceMappingURL=validation.d.ts.map
|