@postman/sdk-config 0.7.0 → 0.8.0
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 +1 -3
- package/dist/index.cjs +808 -742
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +808 -742
- package/dist/index.js.map +1 -1
- package/dist/sdk-config/index.cjs +570 -539
- package/dist/sdk-config/index.cjs.map +1 -1
- package/dist/sdk-config/index.d.cts +1 -1
- package/dist/sdk-config/index.d.ts +1 -1
- package/dist/sdk-config/index.js +570 -539
- package/dist/sdk-config/index.js.map +1 -1
- package/dist/sdk-config/v1/index.cjs +570 -539
- package/dist/sdk-config/v1/index.cjs.map +1 -1
- package/dist/sdk-config/v1/index.d.cts +62 -934
- package/dist/sdk-config/v1/index.d.ts +62 -934
- package/dist/sdk-config/v1/index.js +570 -539
- package/dist/sdk-config/v1/index.js.map +1 -1
- package/dist/sdk-config-ir/index.cjs +606 -541
- package/dist/sdk-config-ir/index.cjs.map +1 -1
- package/dist/sdk-config-ir/index.d.cts +1 -1
- package/dist/sdk-config-ir/index.d.ts +1 -1
- package/dist/sdk-config-ir/index.js +606 -541
- package/dist/sdk-config-ir/index.js.map +1 -1
- package/dist/sdk-config-ir/v1/index.cjs +606 -541
- package/dist/sdk-config-ir/v1/index.cjs.map +1 -1
- package/dist/sdk-config-ir/v1/index.d.cts +7 -7
- package/dist/sdk-config-ir/v1/index.d.ts +7 -7
- package/dist/sdk-config-ir/v1/index.js +606 -541
- package/dist/sdk-config-ir/v1/index.js.map +1 -1
- package/dist/{typescript-BdDv_kwT.d.cts → typescript-Chge0X4f.d.cts} +1 -2
- package/dist/{typescript-BdDv_kwT.d.ts → typescript-Chge0X4f.d.ts} +1 -2
- package/package.json +1 -1
- package/src/sdk-config/v1/README.md +15 -14
package/dist/index.cjs
CHANGED
|
@@ -38,140 +38,152 @@ var hashAlgorithmSchema = zod.z.enum(["sha1", "sha256", "sha384", "sha512"]);
|
|
|
38
38
|
var encodingSchema = zod.z.enum(["base64", "hex"]);
|
|
39
39
|
var payloadComponentSchema = zod.z.enum(["body", "timestamp", "notification-url", "message-id"]);
|
|
40
40
|
var payloadFormatSchema = zod.z.strictObject({
|
|
41
|
-
components: zod.z.array(payloadComponentSchema).min(1),
|
|
42
|
-
delimiter: zod.z.string().optional(),
|
|
41
|
+
components: zod.z.array(payloadComponentSchema).min(1).describe("Payload components concatenated in declaration order before signing."),
|
|
42
|
+
delimiter: zod.z.string().optional().describe("The delimiter inserted between payload components."),
|
|
43
43
|
/**
|
|
44
44
|
* Set when the body is a form-encoded parameter map that must be canonicalized before signing:
|
|
45
45
|
* keys sorted, each key's values deduped and sorted, concatenated as key-value pairs.
|
|
46
46
|
*/
|
|
47
|
-
bodySort: zod.z.literal("alphabetical").optional()
|
|
47
|
+
bodySort: zod.z.literal("alphabetical").optional().describe("Canonicalizes form body keys and values alphabetically before signing.")
|
|
48
48
|
});
|
|
49
49
|
var timestampSchema = zod.z.strictObject({
|
|
50
|
-
header: nonEmptyStringSchema,
|
|
51
|
-
format: zod.z.enum(["unix-seconds", "unix-millis", "iso8601"]).optional(),
|
|
50
|
+
header: nonEmptyStringSchema.describe("The request header containing the signing timestamp."),
|
|
51
|
+
format: zod.z.enum(["unix-seconds", "unix-millis", "iso8601"]).optional().describe("The timestamp format used in the signature payload."),
|
|
52
52
|
/** Replay window in seconds. */
|
|
53
|
-
tolerance: zod.z.number().positive().optional()
|
|
53
|
+
tolerance: zod.z.number().positive().optional().describe("The maximum accepted timestamp age, in seconds.")
|
|
54
54
|
});
|
|
55
55
|
var bodyHashLocationSchema = zod.z.discriminatedUnion("type", [
|
|
56
56
|
zod.z.strictObject({
|
|
57
|
-
type: zod.z.literal("query-parameter"),
|
|
58
|
-
name: nonEmptyStringSchema
|
|
57
|
+
type: zod.z.literal("query-parameter").describe("Reads the body hash from a query parameter."),
|
|
58
|
+
name: nonEmptyStringSchema.describe("The query parameter containing the body hash.")
|
|
59
59
|
})
|
|
60
60
|
]);
|
|
61
61
|
var bodyHashBindingSchema = zod.z.strictObject({
|
|
62
|
-
algorithm: hashAlgorithmSchema,
|
|
63
|
-
encoding: encodingSchema.optional(),
|
|
64
|
-
location: bodyHashLocationSchema
|
|
62
|
+
algorithm: hashAlgorithmSchema.describe("The hash algorithm applied to the raw request body."),
|
|
63
|
+
encoding: encodingSchema.optional().describe("The encoding used for the body hash."),
|
|
64
|
+
location: bodyHashLocationSchema.describe("Where the expected body hash is read from.")
|
|
65
65
|
});
|
|
66
66
|
var urlNormalizationSchema = zod.z.strictObject({
|
|
67
67
|
/** Try the URL with and without an explicit default port. */
|
|
68
|
-
portVariants: zod.z.boolean().optional(),
|
|
68
|
+
portVariants: zod.z.boolean().optional().describe("Whether verification tries URLs with and without an explicit default port."),
|
|
69
69
|
/** Try the URL with the pre-RFC3986 query encoding (`+` for space, unescaped `*`). */
|
|
70
|
-
legacyQueryEncoding: zod.z.boolean().optional()
|
|
70
|
+
legacyQueryEncoding: zod.z.boolean().optional().describe("Whether verification also tries legacy form-style query encoding.")
|
|
71
71
|
}).refine(
|
|
72
72
|
({ portVariants, legacyQueryEncoding }) => portVariants === true || legacyQueryEncoding === true,
|
|
73
73
|
{ message: "url normalization must enable at least one variant" }
|
|
74
74
|
);
|
|
75
75
|
var webhookSignatureSchema = zod.z.discriminatedUnion("type", [
|
|
76
76
|
zod.z.strictObject({
|
|
77
|
-
type: zod.z.literal("hmac"),
|
|
77
|
+
type: zod.z.literal("hmac").describe("Identifies HMAC webhook signature verification."),
|
|
78
78
|
/** Request header carrying the signature. */
|
|
79
|
-
header: nonEmptyStringSchema,
|
|
80
|
-
algorithm: hashAlgorithmSchema.optional(),
|
|
81
|
-
encoding: encodingSchema.optional(),
|
|
79
|
+
header: nonEmptyStringSchema.describe("The request header containing the signature."),
|
|
80
|
+
algorithm: hashAlgorithmSchema.optional().describe("The HMAC hash algorithm."),
|
|
81
|
+
encoding: encodingSchema.optional().describe("The encoding used for the HMAC signature."),
|
|
82
82
|
/** Stripped from the header value before comparison, e.g. `sha256=`. */
|
|
83
|
-
signaturePrefix: zod.z.string().optional(),
|
|
84
|
-
payloadFormat: payloadFormatSchema.optional(),
|
|
85
|
-
timestamp: timestampSchema.optional(),
|
|
86
|
-
bodyHashBinding: bodyHashBindingSchema.optional(),
|
|
87
|
-
urlNormalization: urlNormalizationSchema.optional()
|
|
83
|
+
signaturePrefix: zod.z.string().optional().describe("A prefix removed from the signature header before comparison."),
|
|
84
|
+
payloadFormat: payloadFormatSchema.optional().describe("How the payload signed by the provider is assembled."),
|
|
85
|
+
timestamp: timestampSchema.optional().describe("Timestamp validation included in signature verification."),
|
|
86
|
+
bodyHashBinding: bodyHashBindingSchema.optional().describe("A separately transmitted hash that binds the raw body to the signed payload."),
|
|
87
|
+
urlNormalization: urlNormalizationSchema.optional().describe("Alternate notification URL forms accepted during verification.")
|
|
88
88
|
})
|
|
89
89
|
]);
|
|
90
90
|
|
|
91
91
|
// src/sdk-config-domain/v1/api.ts
|
|
92
92
|
var authVariableSchema = zod.z.strictObject({
|
|
93
|
-
name: nonEmptyStringSchema.optional(),
|
|
94
|
-
environmentVariable: nonEmptyStringSchema.optional(),
|
|
95
|
-
description: zod.z.string().optional()
|
|
96
|
-
|
|
93
|
+
name: nonEmptyStringSchema.optional().describe("The parameter name exposed by the SDK."),
|
|
94
|
+
environmentVariable: nonEmptyStringSchema.optional().describe("The environment variable used to populate the parameter."),
|
|
95
|
+
description: zod.z.string().optional().describe(
|
|
96
|
+
"A description of the authentication parameter included in generated SDK documentation."
|
|
97
|
+
),
|
|
98
|
+
omit: zod.z.boolean().optional().describe("Whether the parameter is omitted from the SDK surface.")
|
|
97
99
|
});
|
|
98
100
|
var apiKeyAuthSchema = zod.z.strictObject({
|
|
99
|
-
id: nonEmptyStringSchema,
|
|
100
|
-
type: zod.z.literal("api-key"),
|
|
101
|
-
location: zod.z.enum(["header", "query", "cookie"]),
|
|
102
|
-
name: nonEmptyStringSchema,
|
|
103
|
-
prefix: nonEmptyStringSchema.optional(),
|
|
104
|
-
environmentVariable: nonEmptyStringSchema.optional(),
|
|
105
|
-
description: zod.z.string().optional()
|
|
101
|
+
id: nonEmptyStringSchema.describe("A unique identifier for this authentication scheme."),
|
|
102
|
+
type: zod.z.literal("api-key").describe("Identifies an API key authentication scheme."),
|
|
103
|
+
location: zod.z.enum(["header", "query", "cookie"]).describe("Where the API key is sent on requests."),
|
|
104
|
+
name: nonEmptyStringSchema.describe("The header, query parameter, or cookie name."),
|
|
105
|
+
prefix: nonEmptyStringSchema.optional().describe("A prefix added before the API key value."),
|
|
106
|
+
environmentVariable: nonEmptyStringSchema.optional().describe("The default environment variable for the API key."),
|
|
107
|
+
description: zod.z.string().optional().describe(
|
|
108
|
+
"A description of the authentication scheme included in generated SDK documentation."
|
|
109
|
+
)
|
|
106
110
|
});
|
|
107
111
|
var bearerAuthSchema = zod.z.strictObject({
|
|
108
|
-
id: nonEmptyStringSchema,
|
|
109
|
-
type: zod.z.literal("bearer"),
|
|
110
|
-
header: nonEmptyStringSchema.optional(),
|
|
111
|
-
prefix: nonEmptyStringSchema.optional(),
|
|
112
|
-
environmentVariable: nonEmptyStringSchema.optional(),
|
|
113
|
-
description: zod.z.string().optional()
|
|
112
|
+
id: nonEmptyStringSchema.describe("A unique identifier for this authentication scheme."),
|
|
113
|
+
type: zod.z.literal("bearer").describe("Identifies a bearer token authentication scheme."),
|
|
114
|
+
header: nonEmptyStringSchema.optional().describe("The request header that carries the bearer token."),
|
|
115
|
+
prefix: nonEmptyStringSchema.optional().describe('The token prefix, such as "Bearer".'),
|
|
116
|
+
environmentVariable: nonEmptyStringSchema.optional().describe("The default environment variable for the bearer token."),
|
|
117
|
+
description: zod.z.string().optional().describe(
|
|
118
|
+
"A description of the authentication scheme included in generated SDK documentation."
|
|
119
|
+
)
|
|
114
120
|
});
|
|
115
121
|
var basicAuthSchema = zod.z.strictObject({
|
|
116
|
-
id: nonEmptyStringSchema,
|
|
117
|
-
type: zod.z.literal("basic"),
|
|
118
|
-
username: authVariableSchema.optional(),
|
|
119
|
-
password: authVariableSchema.optional(),
|
|
120
|
-
description: zod.z.string().optional()
|
|
122
|
+
id: nonEmptyStringSchema.describe("A unique identifier for this authentication scheme."),
|
|
123
|
+
type: zod.z.literal("basic").describe("Identifies an HTTP Basic authentication scheme."),
|
|
124
|
+
username: authVariableSchema.optional().describe("The username parameter exposed by the SDK."),
|
|
125
|
+
password: authVariableSchema.optional().describe("The password parameter exposed by the SDK."),
|
|
126
|
+
description: zod.z.string().optional().describe(
|
|
127
|
+
"A description of the authentication scheme included in generated SDK documentation."
|
|
128
|
+
)
|
|
121
129
|
});
|
|
122
130
|
var oauthScopeSchema = zod.z.strictObject({
|
|
123
|
-
name: nonEmptyStringSchema,
|
|
124
|
-
description: zod.z.string().optional()
|
|
131
|
+
name: nonEmptyStringSchema.describe("The OAuth scope value requested from the provider."),
|
|
132
|
+
description: zod.z.string().optional().describe("A description of the OAuth scope included in generated SDK documentation.")
|
|
125
133
|
});
|
|
126
134
|
var oauthFlowSchema = zod.z.discriminatedUnion("type", [
|
|
127
135
|
zod.z.strictObject({
|
|
128
|
-
type: zod.z.literal("authorization-code"),
|
|
129
|
-
authorizationUrl: nonEmptyStringSchema,
|
|
130
|
-
tokenUrl: nonEmptyStringSchema,
|
|
131
|
-
refreshUrl: nonEmptyStringSchema.optional(),
|
|
132
|
-
scopes: zod.z.array(oauthScopeSchema).optional()
|
|
136
|
+
type: zod.z.literal("authorization-code").describe("Uses the OAuth authorization code flow."),
|
|
137
|
+
authorizationUrl: nonEmptyStringSchema.describe("The URL used to authorize the client."),
|
|
138
|
+
tokenUrl: nonEmptyStringSchema.describe("The URL used to exchange a code for tokens."),
|
|
139
|
+
refreshUrl: nonEmptyStringSchema.optional().describe("The URL used to refresh access tokens."),
|
|
140
|
+
scopes: zod.z.array(oauthScopeSchema).optional().describe("The scopes supported by this flow.")
|
|
133
141
|
}),
|
|
134
142
|
zod.z.strictObject({
|
|
135
|
-
type: zod.z.literal("client-credentials"),
|
|
136
|
-
tokenUrl: nonEmptyStringSchema,
|
|
137
|
-
refreshUrl: nonEmptyStringSchema.optional(),
|
|
138
|
-
scopes: zod.z.array(oauthScopeSchema).optional()
|
|
143
|
+
type: zod.z.literal("client-credentials").describe("Uses the OAuth client credentials flow."),
|
|
144
|
+
tokenUrl: nonEmptyStringSchema.describe("The URL used to obtain access tokens."),
|
|
145
|
+
refreshUrl: nonEmptyStringSchema.optional().describe("The URL used to refresh access tokens."),
|
|
146
|
+
scopes: zod.z.array(oauthScopeSchema).optional().describe("The scopes supported by this flow.")
|
|
139
147
|
}),
|
|
140
148
|
zod.z.strictObject({
|
|
141
|
-
type: zod.z.literal("implicit"),
|
|
142
|
-
authorizationUrl: nonEmptyStringSchema,
|
|
143
|
-
refreshUrl: nonEmptyStringSchema.optional(),
|
|
144
|
-
scopes: zod.z.array(oauthScopeSchema).optional()
|
|
149
|
+
type: zod.z.literal("implicit").describe("Uses the OAuth implicit flow."),
|
|
150
|
+
authorizationUrl: nonEmptyStringSchema.describe("The URL used to authorize the client."),
|
|
151
|
+
refreshUrl: nonEmptyStringSchema.optional().describe("The URL used to refresh access tokens."),
|
|
152
|
+
scopes: zod.z.array(oauthScopeSchema).optional().describe("The scopes supported by this flow.")
|
|
145
153
|
}),
|
|
146
154
|
zod.z.strictObject({
|
|
147
|
-
type: zod.z.literal("password"),
|
|
148
|
-
tokenUrl: nonEmptyStringSchema,
|
|
149
|
-
refreshUrl: nonEmptyStringSchema.optional(),
|
|
150
|
-
scopes: zod.z.array(oauthScopeSchema).optional()
|
|
155
|
+
type: zod.z.literal("password").describe("Uses the OAuth resource owner password flow."),
|
|
156
|
+
tokenUrl: nonEmptyStringSchema.describe("The URL used to obtain access tokens."),
|
|
157
|
+
refreshUrl: nonEmptyStringSchema.optional().describe("The URL used to refresh access tokens."),
|
|
158
|
+
scopes: zod.z.array(oauthScopeSchema).optional().describe("The scopes supported by this flow.")
|
|
151
159
|
})
|
|
152
160
|
]);
|
|
153
161
|
var oauth2AuthSchema = zod.z.strictObject({
|
|
154
|
-
id: nonEmptyStringSchema,
|
|
155
|
-
type: zod.z.literal("oauth2"),
|
|
156
|
-
flows: zod.z.array(oauthFlowSchema).min(1),
|
|
157
|
-
clientId: authVariableSchema.optional(),
|
|
158
|
-
clientSecret: authVariableSchema.optional(),
|
|
159
|
-
tokenHeader: nonEmptyStringSchema.optional(),
|
|
160
|
-
tokenPrefix: nonEmptyStringSchema.optional(),
|
|
161
|
-
refreshBufferSeconds: zod.z.number().nonnegative().optional(),
|
|
162
|
-
description: zod.z.string().optional()
|
|
162
|
+
id: nonEmptyStringSchema.describe("A unique identifier for this authentication scheme."),
|
|
163
|
+
type: zod.z.literal("oauth2").describe("Identifies an OAuth 2.0 authentication scheme."),
|
|
164
|
+
flows: zod.z.array(oauthFlowSchema).min(1).describe("The OAuth flows supported by the API."),
|
|
165
|
+
clientId: authVariableSchema.optional().describe("The OAuth client ID parameter exposed by the SDK."),
|
|
166
|
+
clientSecret: authVariableSchema.optional().describe("The OAuth client secret parameter exposed by the SDK."),
|
|
167
|
+
tokenHeader: nonEmptyStringSchema.optional().describe("The request header that carries the OAuth access token."),
|
|
168
|
+
tokenPrefix: nonEmptyStringSchema.optional().describe("The prefix added before the OAuth access token."),
|
|
169
|
+
refreshBufferSeconds: zod.z.number().nonnegative().optional().describe("How early, in seconds, the client refreshes a token before it expires."),
|
|
170
|
+
description: zod.z.string().optional().describe(
|
|
171
|
+
"A description of the authentication scheme included in generated SDK documentation."
|
|
172
|
+
)
|
|
163
173
|
});
|
|
164
174
|
var customAuthParameterSchema = zod.z.strictObject({
|
|
165
|
-
location: zod.z.enum(["header", "query", "cookie"]),
|
|
166
|
-
name: nonEmptyStringSchema,
|
|
167
|
-
prefix: nonEmptyStringSchema.optional(),
|
|
168
|
-
environmentVariable: nonEmptyStringSchema.optional()
|
|
175
|
+
location: zod.z.enum(["header", "query", "cookie"]).describe("Where the custom authentication value is sent."),
|
|
176
|
+
name: nonEmptyStringSchema.describe("The header, query parameter, or cookie name."),
|
|
177
|
+
prefix: nonEmptyStringSchema.optional().describe("A prefix added before the parameter value."),
|
|
178
|
+
environmentVariable: nonEmptyStringSchema.optional().describe("The default environment variable for the parameter.")
|
|
169
179
|
});
|
|
170
180
|
var customAuthSchema = zod.z.strictObject({
|
|
171
|
-
id: nonEmptyStringSchema,
|
|
172
|
-
type: zod.z.literal("custom"),
|
|
173
|
-
parameters: zod.z.array(customAuthParameterSchema).min(1),
|
|
174
|
-
description: zod.z.string().optional()
|
|
181
|
+
id: nonEmptyStringSchema.describe("A unique identifier for this authentication scheme."),
|
|
182
|
+
type: zod.z.literal("custom").describe("Identifies a custom authentication scheme."),
|
|
183
|
+
parameters: zod.z.array(customAuthParameterSchema).min(1).describe("The request parameters that implement the custom scheme."),
|
|
184
|
+
description: zod.z.string().optional().describe(
|
|
185
|
+
"A description of the authentication scheme included in generated SDK documentation."
|
|
186
|
+
)
|
|
175
187
|
});
|
|
176
188
|
var authSchemeSchema = zod.z.discriminatedUnion("type", [
|
|
177
189
|
apiKeyAuthSchema,
|
|
@@ -181,12 +193,12 @@ var authSchemeSchema = zod.z.discriminatedUnion("type", [
|
|
|
181
193
|
customAuthSchema
|
|
182
194
|
]);
|
|
183
195
|
var authRequirementSchema = zod.z.strictObject({
|
|
184
|
-
schemes: zod.z.array(nonEmptyStringSchema).min(1)
|
|
196
|
+
schemes: zod.z.array(nonEmptyStringSchema).min(1).describe("Scheme identifiers that must be satisfied together.")
|
|
185
197
|
});
|
|
186
198
|
var authConfigSchema = zod.z.strictObject({
|
|
187
|
-
schemes: zod.z.array(authSchemeSchema).min(1),
|
|
188
|
-
requirements: zod.z.array(authRequirementSchema).optional(),
|
|
189
|
-
endpointSecurity: zod.z.boolean().optional()
|
|
199
|
+
schemes: zod.z.array(authSchemeSchema).min(1).describe("Authentication schemes offered by the API."),
|
|
200
|
+
requirements: zod.z.array(authRequirementSchema).optional().describe("Valid combinations of authentication schemes."),
|
|
201
|
+
endpointSecurity: zod.z.boolean().optional().describe("Whether generated endpoints expose their individual security requirements.")
|
|
190
202
|
}).superRefine(({ requirements, schemes }, context) => {
|
|
191
203
|
const schemeIds = /* @__PURE__ */ new Set();
|
|
192
204
|
schemes.forEach(({ id }, index) => {
|
|
@@ -212,45 +224,45 @@ var authConfigSchema = zod.z.strictObject({
|
|
|
212
224
|
});
|
|
213
225
|
});
|
|
214
226
|
var environmentUrlSchema = zod.z.strictObject({
|
|
215
|
-
name: nonEmptyStringSchema,
|
|
216
|
-
url: nonEmptyStringSchema,
|
|
217
|
-
serverName: nonEmptyStringSchema.optional()
|
|
227
|
+
name: nonEmptyStringSchema.describe("The display name for this environment URL."),
|
|
228
|
+
url: nonEmptyStringSchema.describe("The base URL used for this environment entry."),
|
|
229
|
+
serverName: nonEmptyStringSchema.optional().describe("The source server represented by this URL.")
|
|
218
230
|
});
|
|
219
231
|
var environmentSchema = zod.z.strictObject({
|
|
220
|
-
name: nonEmptyStringSchema,
|
|
221
|
-
urls: zod.z.array(environmentUrlSchema).min(1),
|
|
222
|
-
description: zod.z.string().optional()
|
|
232
|
+
name: nonEmptyStringSchema.describe("The environment name exposed by the SDK."),
|
|
233
|
+
urls: zod.z.array(environmentUrlSchema).min(1).describe("The base URLs available in this environment."),
|
|
234
|
+
description: zod.z.string().optional().describe("A description of the environment included in generated SDK documentation.")
|
|
223
235
|
});
|
|
224
236
|
var headerSchema = zod.z.strictObject({
|
|
225
|
-
name: nonEmptyStringSchema,
|
|
226
|
-
value: zod.z.string().optional(),
|
|
227
|
-
description: zod.z.string().optional(),
|
|
228
|
-
environmentVariable: nonEmptyStringSchema.optional()
|
|
237
|
+
name: nonEmptyStringSchema.describe("The HTTP header name."),
|
|
238
|
+
value: zod.z.string().optional().describe("A fixed value for the generated header."),
|
|
239
|
+
description: zod.z.string().optional().describe("A description of the header included in generated SDK documentation."),
|
|
240
|
+
environmentVariable: nonEmptyStringSchema.optional().describe("The environment variable used to populate the header.")
|
|
229
241
|
});
|
|
230
242
|
var environmentVariableSchema = zod.z.strictObject({
|
|
231
|
-
name: nonEmptyStringSchema,
|
|
232
|
-
description: zod.z.string().optional(),
|
|
233
|
-
defaultValue: zod.z.string().optional()
|
|
243
|
+
name: nonEmptyStringSchema.describe("The environment variable name exposed by the SDK."),
|
|
244
|
+
description: zod.z.string().optional().describe("A description of the environment variable included in generated SDK documentation."),
|
|
245
|
+
defaultValue: zod.z.string().optional().describe("The default value used when the variable is unset.")
|
|
234
246
|
});
|
|
235
247
|
var apiConfigSchema = zod.z.strictObject({
|
|
236
|
-
baseUrl: zod.z.string().default(""),
|
|
237
|
-
environments: zod.z.array(environmentSchema).default([]),
|
|
238
|
-
environmentVariables: zod.z.array(environmentVariableSchema).default([]),
|
|
239
|
-
defaultEnvironment: nonEmptyStringSchema.optional(),
|
|
240
|
-
auth: authConfigSchema.optional(),
|
|
241
|
-
headers: zod.z.array(headerSchema).optional(),
|
|
248
|
+
baseUrl: zod.z.string().default("").describe("The default base URL used by the generated client."),
|
|
249
|
+
environments: zod.z.array(environmentSchema).default([]).describe("Named API environments and their base URLs."),
|
|
250
|
+
environmentVariables: zod.z.array(environmentVariableSchema).default([]).describe("Environment variables exposed through generated client configuration."),
|
|
251
|
+
defaultEnvironment: nonEmptyStringSchema.optional().describe("The environment selected when a caller does not choose one."),
|
|
252
|
+
auth: authConfigSchema.optional().describe("Authentication supported by the API."),
|
|
253
|
+
headers: zod.z.array(headerSchema).optional().describe("Headers added to generated API requests."),
|
|
242
254
|
/**
|
|
243
255
|
* Selects the named `x-fern-audiences`.
|
|
244
256
|
*
|
|
245
257
|
* Absent means all audiences. A present empty array selects no tagged audience: untagged nodes
|
|
246
258
|
* remain included, while every audience-tagged node is excluded.
|
|
247
259
|
*/
|
|
248
|
-
audiences: zod.z.array(nonEmptyStringSchema).optional(),
|
|
260
|
+
audiences: zod.z.array(nonEmptyStringSchema).optional().describe("Named API audiences included in the generated SDK."),
|
|
249
261
|
/**
|
|
250
262
|
* How the API signs the webhooks it sends, enabling a generated verification helper. API-wide, and
|
|
251
263
|
* independent of whether any webhook is modeled — see {@link webhookSignatureSchema}.
|
|
252
264
|
*/
|
|
253
|
-
webhookSignature: webhookSignatureSchema.optional()
|
|
265
|
+
webhookSignature: webhookSignatureSchema.optional().describe("How generated helpers verify webhook signatures from the API.")
|
|
254
266
|
});
|
|
255
267
|
|
|
256
268
|
// src/sdk-config/v1/api.ts
|
|
@@ -259,16 +271,16 @@ var sdkConfigV1AuthConfigSchema = authConfigSchema;
|
|
|
259
271
|
var sdkConfigV1ApiConfigSchema = apiConfigSchema;
|
|
260
272
|
var sdkConfigV1WebhookSignatureSchema = webhookSignatureSchema;
|
|
261
273
|
var retryOverrideShape = {
|
|
262
|
-
enabled: zod.z.boolean().optional(),
|
|
263
|
-
maxAttempts: zod.z.number().int().min(1).optional(),
|
|
264
|
-
retryDelayMs: zod.z.number().nonnegative().optional(),
|
|
265
|
-
maxDelayMs: zod.z.number().nonnegative().optional(),
|
|
266
|
-
jitterMs: zod.z.number().nonnegative().optional(),
|
|
267
|
-
backoffFactor: zod.z.number().positive().optional(),
|
|
268
|
-
statusCodes: zod.z.array(zod.z.number().int().min(100).max(599)).optional(),
|
|
269
|
-
methods: zod.z.array(nonEmptyStringSchema).optional(),
|
|
270
|
-
statusCodeProfile: zod.z.enum(["legacy", "recommended"]).optional(),
|
|
271
|
-
maxRetryAfterDelayMs: zod.z.number().nonnegative().optional()
|
|
274
|
+
enabled: zod.z.boolean().optional().describe("Whether the generated client retries failed requests."),
|
|
275
|
+
maxAttempts: zod.z.number().int().min(1).optional().describe("The maximum total request attempts, including the initial attempt."),
|
|
276
|
+
retryDelayMs: zod.z.number().nonnegative().optional().describe("The initial delay between retry attempts, in milliseconds."),
|
|
277
|
+
maxDelayMs: zod.z.number().nonnegative().optional().describe("The maximum backoff delay between attempts, in milliseconds."),
|
|
278
|
+
jitterMs: zod.z.number().nonnegative().optional().describe("The maximum random jitter added to retry delays, in milliseconds."),
|
|
279
|
+
backoffFactor: zod.z.number().positive().optional().describe("The multiplier applied to the delay after each failed attempt."),
|
|
280
|
+
statusCodes: zod.z.array(zod.z.number().int().min(100).max(599)).optional().describe("HTTP status codes that are eligible for retries."),
|
|
281
|
+
methods: zod.z.array(nonEmptyStringSchema).optional().describe("HTTP methods that are eligible for retries."),
|
|
282
|
+
statusCodeProfile: zod.z.enum(["legacy", "recommended"]).optional().describe("The built-in retryable status-code policy."),
|
|
283
|
+
maxRetryAfterDelayMs: zod.z.number().nonnegative().optional().describe("The longest Retry-After delay the client will honor, in milliseconds.")
|
|
272
284
|
};
|
|
273
285
|
function validateRetryDelays({
|
|
274
286
|
maxDelayMs,
|
|
@@ -285,27 +297,29 @@ function validateRetryDelays({
|
|
|
285
297
|
var clientRetryOverrideSchema = zod.z.strictObject(retryOverrideShape).superRefine(validateRetryDelays);
|
|
286
298
|
var retryConfigSchema = zod.z.strictObject({
|
|
287
299
|
...retryOverrideShape,
|
|
288
|
-
enabled: zod.z.boolean().default(true),
|
|
289
|
-
maxAttempts: zod.z.number().int().min(1).default(3),
|
|
290
|
-
retryDelayMs: zod.z.number().nonnegative().default(150),
|
|
291
|
-
maxDelayMs: zod.z.number().nonnegative().default(5e3),
|
|
292
|
-
jitterMs: zod.z.number().nonnegative().default(50),
|
|
293
|
-
backoffFactor: zod.z.number().positive().default(2),
|
|
294
|
-
methods: zod.z.array(nonEmptyStringSchema).default(["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"]),
|
|
295
|
-
maxRetryAfterDelayMs: zod.z.number().nonnegative().default(6e4)
|
|
300
|
+
enabled: zod.z.boolean().default(true).describe("Whether the generated client retries failed requests."),
|
|
301
|
+
maxAttempts: zod.z.number().int().min(1).default(3).describe("The maximum total request attempts, including the initial attempt."),
|
|
302
|
+
retryDelayMs: zod.z.number().nonnegative().default(150).describe("The initial delay between retry attempts, in milliseconds."),
|
|
303
|
+
maxDelayMs: zod.z.number().nonnegative().default(5e3).describe("The maximum backoff delay between attempts, in milliseconds."),
|
|
304
|
+
jitterMs: zod.z.number().nonnegative().default(50).describe("The maximum random jitter added to retry delays, in milliseconds."),
|
|
305
|
+
backoffFactor: zod.z.number().positive().default(2).describe("The multiplier applied to the delay after each failed attempt."),
|
|
306
|
+
methods: zod.z.array(nonEmptyStringSchema).default(["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"]).describe("HTTP methods that are eligible for retries."),
|
|
307
|
+
maxRetryAfterDelayMs: zod.z.number().nonnegative().default(6e4).describe("The longest Retry-After delay the client will honor, in milliseconds.")
|
|
296
308
|
}).superRefine(validateRetryDelays);
|
|
297
309
|
var constructorParameterSchema = zod.z.strictObject({
|
|
298
|
-
name: nonEmptyStringSchema,
|
|
299
|
-
example: zod.z.string().optional(),
|
|
300
|
-
description: zod.z.string().optional()
|
|
301
|
-
|
|
310
|
+
name: nonEmptyStringSchema.describe("The parameter name in the generated client constructor."),
|
|
311
|
+
example: zod.z.string().optional().describe("An example value shown in generated documentation."),
|
|
312
|
+
description: zod.z.string().optional().describe(
|
|
313
|
+
"A description of the constructor parameter included in generated SDK documentation."
|
|
314
|
+
),
|
|
315
|
+
required: zod.z.boolean().optional().describe("Whether callers must provide the parameter.")
|
|
302
316
|
});
|
|
303
317
|
var parameterStyleSchema = zod.z.enum(["wrapped", "inline", "language-default"]);
|
|
304
318
|
var tokenRefreshConfigSchema = zod.z.strictObject({
|
|
305
|
-
enabled: zod.z.boolean(),
|
|
306
|
-
endpoint: nonEmptyStringSchema.optional(),
|
|
307
|
-
accessTokenField: nonEmptyStringSchema.optional(),
|
|
308
|
-
refreshTokenField: nonEmptyStringSchema.optional()
|
|
319
|
+
enabled: zod.z.boolean().describe("Whether the client can exchange refresh tokens."),
|
|
320
|
+
endpoint: nonEmptyStringSchema.optional().describe("The API endpoint used to refresh tokens."),
|
|
321
|
+
accessTokenField: nonEmptyStringSchema.optional().describe("The response field containing the refreshed access token."),
|
|
322
|
+
refreshTokenField: nonEmptyStringSchema.optional().describe("The response field containing the refreshed refresh token.")
|
|
309
323
|
}).superRefine(({ enabled, endpoint }, context) => {
|
|
310
324
|
if (enabled && endpoint === void 0) {
|
|
311
325
|
context.addIssue({
|
|
@@ -316,26 +330,26 @@ var tokenRefreshConfigSchema = zod.z.strictObject({
|
|
|
316
330
|
}
|
|
317
331
|
});
|
|
318
332
|
var clientOverrideShape = {
|
|
319
|
-
retry: clientRetryOverrideSchema.optional(),
|
|
320
|
-
responseHeaders: zod.z.boolean().optional(),
|
|
321
|
-
responseValidation: zod.z.boolean().optional(),
|
|
322
|
-
multiTenant: zod.z.boolean().optional(),
|
|
323
|
-
additionalConstructorParameters: zod.z.array(constructorParameterSchema).optional(),
|
|
324
|
-
timeoutMs: zod.z.union([zod.z.number().nonnegative(), zod.z.literal("infinity")]).optional(),
|
|
325
|
-
requestParameterStyle: parameterStyleSchema.optional(),
|
|
326
|
-
pathParameterStyle: parameterStyleSchema.optional(),
|
|
327
|
-
filePropertyStyle: parameterStyleSchema.optional(),
|
|
328
|
-
useDefaultRequestParameterValues: zod.z.boolean().optional(),
|
|
329
|
-
respectOptionalRequestBody: zod.z.boolean().optional(),
|
|
330
|
-
tokenRefresh: tokenRefreshConfigSchema.optional()
|
|
333
|
+
retry: clientRetryOverrideSchema.optional().describe("Retry behavior for generated API requests."),
|
|
334
|
+
responseHeaders: zod.z.boolean().optional().describe("Whether generated operations expose HTTP response headers."),
|
|
335
|
+
responseValidation: zod.z.boolean().optional().describe("Whether the client validates API responses against the schema."),
|
|
336
|
+
multiTenant: zod.z.boolean().optional().describe("Whether the client exposes configuration for tenant-specific API access."),
|
|
337
|
+
additionalConstructorParameters: zod.z.array(constructorParameterSchema).optional().describe("Additional parameters added to the generated client constructor."),
|
|
338
|
+
timeoutMs: zod.z.union([zod.z.number().nonnegative(), zod.z.literal("infinity")]).optional().describe('The default request timeout in milliseconds, or "infinity" for no timeout.'),
|
|
339
|
+
requestParameterStyle: parameterStyleSchema.optional().describe("Whether generated operation parameters are wrapped or passed inline."),
|
|
340
|
+
pathParameterStyle: parameterStyleSchema.optional().describe("Whether generated path parameters are wrapped or passed inline."),
|
|
341
|
+
filePropertyStyle: parameterStyleSchema.optional().describe("Whether generated file properties are wrapped or passed inline."),
|
|
342
|
+
useDefaultRequestParameterValues: zod.z.boolean().optional().describe("Whether schema defaults are applied to omitted request parameters."),
|
|
343
|
+
respectOptionalRequestBody: zod.z.boolean().optional().describe("Whether an optional request body remains optional in generated methods."),
|
|
344
|
+
tokenRefresh: tokenRefreshConfigSchema.optional().describe("Refresh-token behavior for the generated client.")
|
|
331
345
|
};
|
|
332
346
|
var clientConfigOverrideSchema = zod.z.strictObject(clientOverrideShape);
|
|
333
347
|
var clientConfigSchema = zod.z.strictObject({
|
|
334
348
|
...clientOverrideShape,
|
|
335
|
-
retry: retryConfigSchema.prefault({}),
|
|
336
|
-
responseHeaders: zod.z.boolean().default(false),
|
|
337
|
-
multiTenant: zod.z.boolean().default(false),
|
|
338
|
-
additionalConstructorParameters: zod.z.array(constructorParameterSchema).default([])
|
|
349
|
+
retry: retryConfigSchema.prefault({}).describe("Retry behavior for generated API requests."),
|
|
350
|
+
responseHeaders: zod.z.boolean().default(false).describe("Whether generated operations expose HTTP response headers."),
|
|
351
|
+
multiTenant: zod.z.boolean().default(false).describe("Whether the client exposes configuration for tenant-specific API access."),
|
|
352
|
+
additionalConstructorParameters: zod.z.array(constructorParameterSchema).default([]).describe("Additional parameters added to the generated client constructor.")
|
|
339
353
|
});
|
|
340
354
|
|
|
341
355
|
// src/sdk-config/v1/client.ts
|
|
@@ -350,75 +364,75 @@ var composerPackageNameSchema = nonEmptyStringSchema.regex(
|
|
|
350
364
|
'Composer package name must be a lowercase "vendor/package" name'
|
|
351
365
|
);
|
|
352
366
|
var authorSchema = zod.z.strictObject({
|
|
353
|
-
name: nonEmptyStringSchema,
|
|
354
|
-
email: zod.z.email().optional(),
|
|
355
|
-
url: nonEmptyStringSchema.optional()
|
|
367
|
+
name: nonEmptyStringSchema.describe("The package author name."),
|
|
368
|
+
email: zod.z.email().optional().describe("The package author email address."),
|
|
369
|
+
url: nonEmptyStringSchema.optional().describe("The package author website.")
|
|
356
370
|
});
|
|
357
371
|
var developerSchema = zod.z.strictObject({
|
|
358
|
-
name: nonEmptyStringSchema,
|
|
359
|
-
email: zod.z.email().optional(),
|
|
360
|
-
organization: nonEmptyStringSchema.optional(),
|
|
361
|
-
organizationUrl: nonEmptyStringSchema.optional()
|
|
372
|
+
name: nonEmptyStringSchema.describe("The package developer name."),
|
|
373
|
+
email: zod.z.email().optional().describe("The package developer email address."),
|
|
374
|
+
organization: nonEmptyStringSchema.optional().describe("The developer organization name."),
|
|
375
|
+
organizationUrl: nonEmptyStringSchema.optional().describe("The developer organization website.")
|
|
362
376
|
});
|
|
363
377
|
var licenseSchema = zod.z.strictObject({
|
|
364
|
-
type: nonEmptyStringSchema,
|
|
365
|
-
name: nonEmptyStringSchema.optional(),
|
|
366
|
-
url: nonEmptyStringSchema.optional(),
|
|
367
|
-
path: nonEmptyStringSchema.optional()
|
|
378
|
+
type: nonEmptyStringSchema.describe("The license identifier or license type."),
|
|
379
|
+
name: nonEmptyStringSchema.optional().describe("The human-readable license name."),
|
|
380
|
+
url: nonEmptyStringSchema.optional().describe("The URL containing the license text."),
|
|
381
|
+
path: nonEmptyStringSchema.optional().describe("The path to a custom license file.")
|
|
368
382
|
});
|
|
369
383
|
var dependencySourceSchema = zod.z.discriminatedUnion("type", [
|
|
370
384
|
zod.z.strictObject({
|
|
371
|
-
type: zod.z.literal("registry"),
|
|
372
|
-
registry: nonEmptyStringSchema.optional()
|
|
385
|
+
type: zod.z.literal("registry").describe("Resolves the dependency from a package registry."),
|
|
386
|
+
registry: nonEmptyStringSchema.optional().describe("The registry used to resolve the dependency.")
|
|
373
387
|
}),
|
|
374
388
|
zod.z.strictObject({
|
|
375
|
-
type: zod.z.literal("git"),
|
|
376
|
-
url: nonEmptyStringSchema,
|
|
377
|
-
ref: nonEmptyStringSchema.optional(),
|
|
378
|
-
subdirectory: nonEmptyStringSchema.optional()
|
|
389
|
+
type: zod.z.literal("git").describe("Resolves the dependency from a Git repository."),
|
|
390
|
+
url: nonEmptyStringSchema.describe("The Git repository URL."),
|
|
391
|
+
ref: nonEmptyStringSchema.optional().describe("The Git branch, tag, or commit to use."),
|
|
392
|
+
subdirectory: nonEmptyStringSchema.optional().describe("The package subdirectory within the Git repository.")
|
|
379
393
|
}),
|
|
380
394
|
zod.z.strictObject({
|
|
381
|
-
type: zod.z.literal("path"),
|
|
382
|
-
path: nonEmptyStringSchema
|
|
395
|
+
type: zod.z.literal("path").describe("Resolves the dependency from a local path."),
|
|
396
|
+
path: nonEmptyStringSchema.describe("The local path containing the dependency.")
|
|
383
397
|
})
|
|
384
398
|
]);
|
|
385
399
|
var dependencySchema = zod.z.strictObject({
|
|
386
|
-
name: nonEmptyStringSchema,
|
|
387
|
-
version: nonEmptyStringSchema.optional(),
|
|
388
|
-
source: dependencySourceSchema.optional(),
|
|
389
|
-
packageName: nonEmptyStringSchema.optional(),
|
|
390
|
-
features: zod.z.array(nonEmptyStringSchema).optional(),
|
|
391
|
-
extras: zod.z.array(nonEmptyStringSchema).optional(),
|
|
392
|
-
optional: zod.z.boolean().optional(),
|
|
393
|
-
defaultFeatures: zod.z.boolean().optional(),
|
|
394
|
-
environmentMarker: nonEmptyStringSchema.optional()
|
|
400
|
+
name: nonEmptyStringSchema.describe("The dependency name used by the package manager."),
|
|
401
|
+
version: nonEmptyStringSchema.optional().describe("The dependency version requirement."),
|
|
402
|
+
source: dependencySourceSchema.optional().describe("A non-default source for the dependency."),
|
|
403
|
+
packageName: nonEmptyStringSchema.optional().describe("The source package name when it differs from the dependency alias."),
|
|
404
|
+
features: zod.z.array(nonEmptyStringSchema).optional().describe("Cargo features enabled for this dependency."),
|
|
405
|
+
extras: zod.z.array(nonEmptyStringSchema).optional().describe("Python extras enabled for this dependency."),
|
|
406
|
+
optional: zod.z.boolean().optional().describe("Whether the dependency is optional."),
|
|
407
|
+
defaultFeatures: zod.z.boolean().optional().describe("Whether the dependency enables its default Cargo features."),
|
|
408
|
+
environmentMarker: nonEmptyStringSchema.optional().describe("A Python environment marker that conditions this dependency.")
|
|
395
409
|
}).refine(({ source, version }) => source !== void 0 || version !== void 0, {
|
|
396
410
|
message: "dependency must define a version or a source"
|
|
397
411
|
});
|
|
398
412
|
var projectUrlSchema = zod.z.strictObject({
|
|
399
|
-
label: nonEmptyStringSchema,
|
|
400
|
-
url: nonEmptyStringSchema
|
|
413
|
+
label: nonEmptyStringSchema.describe("The label displayed for the project link."),
|
|
414
|
+
url: nonEmptyStringSchema.describe("The project link URL.")
|
|
401
415
|
});
|
|
402
416
|
var packageConfigSchema = zod.z.strictObject({
|
|
403
|
-
packageName: nonEmptyStringSchema.optional(),
|
|
404
|
-
moduleName: nonEmptyStringSchema.optional(),
|
|
405
|
-
modulePath: goModulePathSchema.optional(),
|
|
406
|
-
namespace: nonEmptyStringSchema.optional(),
|
|
407
|
-
groupId: nonEmptyStringSchema.optional(),
|
|
408
|
-
artifactId: nonEmptyStringSchema.optional(),
|
|
409
|
-
description: zod.z.string().optional(),
|
|
410
|
-
repository: nonEmptyStringSchema.optional(),
|
|
411
|
-
homepage: nonEmptyStringSchema.optional(),
|
|
412
|
-
documentationUrl: nonEmptyStringSchema.optional(),
|
|
413
|
-
authors: zod.z.array(authorSchema).optional(),
|
|
414
|
-
developers: zod.z.array(developerSchema).optional(),
|
|
415
|
-
license: licenseSchema.optional(),
|
|
416
|
-
keywords: zod.z.array(nonEmptyStringSchema).optional(),
|
|
417
|
-
classifiers: zod.z.array(nonEmptyStringSchema).optional(),
|
|
418
|
-
projectUrls: zod.z.array(projectUrlSchema).optional(),
|
|
419
|
-
extraDependencies: zod.z.array(dependencySchema).optional(),
|
|
420
|
-
extraDevDependencies: zod.z.array(dependencySchema).optional(),
|
|
421
|
-
extraPeerDependencies: zod.z.array(dependencySchema).optional()
|
|
417
|
+
packageName: nonEmptyStringSchema.optional().describe("The package name used by the target language registry."),
|
|
418
|
+
moduleName: nonEmptyStringSchema.optional().describe("The generated module or import name when it differs from the package name."),
|
|
419
|
+
modulePath: goModulePathSchema.optional().describe("The Go module path used for imports and publishing."),
|
|
420
|
+
namespace: nonEmptyStringSchema.optional().describe("The namespace or package prefix for generated code."),
|
|
421
|
+
groupId: nonEmptyStringSchema.optional().describe("The Maven group identifier."),
|
|
422
|
+
artifactId: nonEmptyStringSchema.optional().describe("The Maven artifact identifier."),
|
|
423
|
+
description: zod.z.string().optional().describe("The package description used in generated metadata."),
|
|
424
|
+
repository: nonEmptyStringSchema.optional().describe("The source repository for the generated SDK."),
|
|
425
|
+
homepage: nonEmptyStringSchema.optional().describe("The package homepage URL."),
|
|
426
|
+
documentationUrl: nonEmptyStringSchema.optional().describe("The package documentation URL."),
|
|
427
|
+
authors: zod.z.array(authorSchema).optional().describe("Authors credited in package metadata."),
|
|
428
|
+
developers: zod.z.array(developerSchema).optional().describe("Developers credited in package metadata."),
|
|
429
|
+
license: licenseSchema.optional().describe("License metadata for the generated package."),
|
|
430
|
+
keywords: zod.z.array(nonEmptyStringSchema).optional().describe("Search keywords for package metadata."),
|
|
431
|
+
classifiers: zod.z.array(nonEmptyStringSchema).optional().describe("Package classifiers used by registries such as PyPI."),
|
|
432
|
+
projectUrls: zod.z.array(projectUrlSchema).optional().describe("Labeled project links for package metadata."),
|
|
433
|
+
extraDependencies: zod.z.array(dependencySchema).optional().describe("Additional runtime dependencies added to the generated package."),
|
|
434
|
+
extraDevDependencies: zod.z.array(dependencySchema).optional().describe("Additional development dependencies added to the generated package."),
|
|
435
|
+
extraPeerDependencies: zod.z.array(dependencySchema).optional().describe("Additional peer dependencies added to the generated package.")
|
|
422
436
|
});
|
|
423
437
|
var httpMethodSchema = zod.z.enum([
|
|
424
438
|
"GET",
|
|
@@ -432,34 +446,34 @@ var httpMethodSchema = zod.z.enum([
|
|
|
432
446
|
"CONNECT"
|
|
433
447
|
]);
|
|
434
448
|
var readmeEndpointSchema = zod.z.strictObject({
|
|
435
|
-
method: httpMethodSchema,
|
|
436
|
-
path: nonEmptyStringSchema,
|
|
437
|
-
stream: zod.z.boolean().optional()
|
|
449
|
+
method: httpMethodSchema.describe("The HTTP method of the documented endpoint."),
|
|
450
|
+
path: nonEmptyStringSchema.describe("The endpoint path used in generated examples."),
|
|
451
|
+
stream: zod.z.boolean().optional().describe("Whether the example uses the streaming response API.")
|
|
438
452
|
});
|
|
439
453
|
var readmeCustomSectionSchema = zod.z.strictObject({
|
|
440
|
-
title: nonEmptyStringSchema,
|
|
441
|
-
content: zod.z.string()
|
|
454
|
+
title: nonEmptyStringSchema.describe("The heading displayed for this README section."),
|
|
455
|
+
content: zod.z.string().describe("The Markdown content of this README section.")
|
|
442
456
|
});
|
|
443
457
|
var readmeConfigSchema = zod.z.strictObject({
|
|
444
|
-
apiName: nonEmptyStringSchema.optional(),
|
|
445
|
-
introduction: zod.z.string().optional(),
|
|
446
|
-
apiReferenceLink: nonEmptyStringSchema.optional(),
|
|
447
|
-
bannerLink: nonEmptyStringSchema.optional(),
|
|
448
|
-
disabledSections: zod.z.array(nonEmptyStringSchema).optional(),
|
|
449
|
-
customSections: zod.z.array(readmeCustomSectionSchema).optional(),
|
|
450
|
-
defaultEndpoint: readmeEndpointSchema.optional(),
|
|
451
|
-
features: zod.z.record(zod.z.string(), zod.z.array(readmeEndpointSchema)).optional()
|
|
458
|
+
apiName: nonEmptyStringSchema.optional().describe("The API name displayed in the README."),
|
|
459
|
+
introduction: zod.z.string().optional().describe("Custom introductory Markdown for the README."),
|
|
460
|
+
apiReferenceLink: nonEmptyStringSchema.optional().describe("The URL linked as the API reference."),
|
|
461
|
+
bannerLink: nonEmptyStringSchema.optional().describe("The destination URL for the README banner."),
|
|
462
|
+
disabledSections: zod.z.array(nonEmptyStringSchema).optional().describe("Generated README sections to omit."),
|
|
463
|
+
customSections: zod.z.array(readmeCustomSectionSchema).optional().describe("Additional sections inserted into the README."),
|
|
464
|
+
defaultEndpoint: readmeEndpointSchema.optional().describe("The endpoint used for the primary README example."),
|
|
465
|
+
features: zod.z.record(zod.z.string(), zod.z.array(readmeEndpointSchema)).optional().describe("Named feature groups and the endpoints demonstrated by each group.")
|
|
452
466
|
});
|
|
453
467
|
var snippetsConfigSchema = zod.z.strictObject({
|
|
454
|
-
enabled: zod.z.boolean(),
|
|
455
|
-
format: zod.z.enum(["md", "json"]).optional(),
|
|
456
|
-
outputPath: nonEmptyStringSchema.optional()
|
|
468
|
+
enabled: zod.z.boolean().describe("Whether standalone usage snippets are generated."),
|
|
469
|
+
format: zod.z.enum(["md", "json"]).optional().describe("The output format for generated snippets."),
|
|
470
|
+
outputPath: nonEmptyStringSchema.optional().describe("The output path for generated snippet files.")
|
|
457
471
|
});
|
|
458
472
|
var docsConfigSchema = zod.z.strictObject({
|
|
459
|
-
readme: readmeConfigSchema.optional(),
|
|
460
|
-
snippets: snippetsConfigSchema.optional(),
|
|
461
|
-
referenceBaseUrl: nonEmptyStringSchema.optional(),
|
|
462
|
-
includeApiReference: zod.z.boolean().optional()
|
|
473
|
+
readme: readmeConfigSchema.optional().describe("README content and example configuration."),
|
|
474
|
+
snippets: snippetsConfigSchema.optional().describe("Standalone usage snippet generation."),
|
|
475
|
+
referenceBaseUrl: nonEmptyStringSchema.optional().describe("The base URL used for links to generated API reference files."),
|
|
476
|
+
includeApiReference: zod.z.boolean().optional().describe("Whether API reference documentation is included in the SDK output.")
|
|
463
477
|
});
|
|
464
478
|
|
|
465
479
|
// src/sdk-config/v1/docs.ts
|
|
@@ -1258,16 +1272,10 @@ function finishOutputMapping(mapping, outputMode, sourcePath, state, index) {
|
|
|
1258
1272
|
for (const path of collectLeafPaths(outputMode, sourcePath)) {
|
|
1259
1273
|
if (path[path.length - 1] === "_visit") consume(state, path);
|
|
1260
1274
|
}
|
|
1261
|
-
const legacyGenerateFullProject = isObject(outputMode) ? outputMode.generateFullProject : void 0;
|
|
1262
|
-
const generationShape = typeof legacyGenerateFullProject === "boolean" ? { generation: { ...mapping.generation, generateFullProject: legacyGenerateFullProject } } : {};
|
|
1263
|
-
if (typeof legacyGenerateFullProject === "boolean") {
|
|
1264
|
-
consume(state, [...sourcePath, "generateFullProject"]);
|
|
1265
|
-
}
|
|
1266
1275
|
const unsupported = collectUnsupported(outputMode, sourcePath, state);
|
|
1267
1276
|
const hasCredentials = unsupported.some((diagnostic) => isCredentialPath(diagnostic.path));
|
|
1268
1277
|
return {
|
|
1269
1278
|
...mapping,
|
|
1270
|
-
...generationShape,
|
|
1271
1279
|
unsupportedFields: [
|
|
1272
1280
|
...state.credentialDiagnostics ?? [],
|
|
1273
1281
|
...hasCredentials ? [
|
|
@@ -1338,6 +1346,9 @@ function outputDiagnostic(path, index) {
|
|
|
1338
1346
|
homepageLink: {
|
|
1339
1347
|
sdkConfigPath: ["targets", index, "package", "homepage"],
|
|
1340
1348
|
suggestedAction: "Set target.package.homepage manually to a valid URL."
|
|
1349
|
+
},
|
|
1350
|
+
generateFullProject: {
|
|
1351
|
+
suggestedAction: "Preserve this packaging setting on the generation request; it is not customer-authored SDK configuration."
|
|
1341
1352
|
}
|
|
1342
1353
|
};
|
|
1343
1354
|
const fieldGuidance = field ? guidance[field] : void 0;
|
|
@@ -1471,59 +1482,48 @@ function deepEqual(left, right) {
|
|
|
1471
1482
|
return false;
|
|
1472
1483
|
}
|
|
1473
1484
|
var namingConfigSchema = zod.z.strictObject({
|
|
1474
|
-
clientName: nonEmptyStringSchema.optional(),
|
|
1475
|
-
exportedClientName: nonEmptyStringSchema.optional(),
|
|
1476
|
-
environmentTypeName: nonEmptyStringSchema.optional(),
|
|
1477
|
-
apiErrorName: nonEmptyStringSchema.optional(),
|
|
1478
|
-
baseErrorName: nonEmptyStringSchema.optional(),
|
|
1479
|
-
pagerName: nonEmptyStringSchema.optional(),
|
|
1485
|
+
clientName: nonEmptyStringSchema.optional().describe("The generated client class name."),
|
|
1486
|
+
exportedClientName: nonEmptyStringSchema.optional().describe("The client name exported from the generated package."),
|
|
1487
|
+
environmentTypeName: nonEmptyStringSchema.optional().describe("The generated type name for API environments."),
|
|
1488
|
+
apiErrorName: nonEmptyStringSchema.optional().describe("The generated API error class name."),
|
|
1489
|
+
baseErrorName: nonEmptyStringSchema.optional().describe("The generated base error class name."),
|
|
1490
|
+
pagerName: nonEmptyStringSchema.optional().describe("The generated pagination helper name."),
|
|
1480
1491
|
/** Apply Fern's initialism-aware casing rules when deriving generated identifiers. */
|
|
1481
|
-
smartCasing: zod.z.boolean().optional(),
|
|
1492
|
+
smartCasing: zod.z.boolean().optional().describe("Whether generated identifiers use initialism-aware casing."),
|
|
1482
1493
|
/** Preserve a word boundary after digits when Fern smart casing is enabled. */
|
|
1483
|
-
smartCasingDigitWordBoundary: zod.z.boolean().optional()
|
|
1494
|
+
smartCasingDigitWordBoundary: zod.z.boolean().optional().describe("Whether smart casing preserves a word boundary after digits.")
|
|
1484
1495
|
});
|
|
1485
1496
|
|
|
1486
1497
|
// src/sdk-config/v1/generation.ts
|
|
1487
1498
|
var customerGenerationAssetSchema = zod.z.discriminatedUnion("type", [
|
|
1488
|
-
zod.z.strictObject({
|
|
1489
|
-
|
|
1499
|
+
zod.z.strictObject({
|
|
1500
|
+
type: zod.z.literal("path").describe("Loads the generation asset from a relative path."),
|
|
1501
|
+
location: relativePathSchema.describe("The relative path to the generation asset.")
|
|
1502
|
+
}),
|
|
1503
|
+
zod.z.strictObject({
|
|
1504
|
+
type: zod.z.literal("url").describe("Loads the generation asset from a URL."),
|
|
1505
|
+
location: nonEmptyStringSchema.describe("The URL of the generation asset.")
|
|
1506
|
+
})
|
|
1490
1507
|
]);
|
|
1491
|
-
var hookDependencySchema = zod.z.strictObject({
|
|
1492
|
-
name: nonEmptyStringSchema,
|
|
1493
|
-
version: nonEmptyStringSchema,
|
|
1494
|
-
groupId: nonEmptyStringSchema.optional()
|
|
1495
|
-
});
|
|
1496
|
-
var hooksConfigSchema = zod.z.strictObject({
|
|
1497
|
-
enabled: zod.z.boolean(),
|
|
1498
|
-
source: customerGenerationAssetSchema.optional(),
|
|
1499
|
-
dependencies: zod.z.array(hookDependencySchema).optional()
|
|
1500
|
-
});
|
|
1501
1508
|
var customCodeConfigSchema = zod.z.strictObject({
|
|
1502
|
-
enabled: zod.z.boolean(),
|
|
1503
|
-
source: customerGenerationAssetSchema.optional(),
|
|
1504
|
-
conflictStrategy: zod.z.enum(["mark", "ours", "theirs"]).optional(),
|
|
1505
|
-
trackChanges: zod.z.boolean().optional(),
|
|
1506
|
-
protectedFiles: zod.z.array(nonEmptyStringSchema).optional()
|
|
1509
|
+
enabled: zod.z.boolean().describe("Whether customer-authored code is merged into generated output."),
|
|
1510
|
+
source: customerGenerationAssetSchema.optional().describe("The source containing customer-authored code."),
|
|
1511
|
+
conflictStrategy: zod.z.enum(["mark", "ours", "theirs"]).optional().describe("How merge conflicts between generated and custom code are handled."),
|
|
1512
|
+
trackChanges: zod.z.boolean().optional().describe("Whether custom-code changes are tracked between builds."),
|
|
1513
|
+
protectedFiles: zod.z.array(nonEmptyStringSchema).optional().describe("Generated file paths that custom-code merging must not overwrite.")
|
|
1507
1514
|
});
|
|
1508
|
-
var
|
|
1509
|
-
|
|
1510
|
-
|
|
1515
|
+
var analyticsHeaderSchema = zod.z.strictObject({
|
|
1516
|
+
name: nonEmptyStringSchema.describe("The exported telemetry header name."),
|
|
1517
|
+
value: zod.z.string().describe("The literal telemetry header value.")
|
|
1511
1518
|
});
|
|
1512
|
-
var analyticsHeaderSchema = zod.z.union([
|
|
1513
|
-
zod.z.strictObject({ name: nonEmptyStringSchema, value: zod.z.string() }),
|
|
1514
|
-
zod.z.strictObject({
|
|
1515
|
-
name: nonEmptyStringSchema,
|
|
1516
|
-
valueRef: nonEmptyStringSchema
|
|
1517
|
-
})
|
|
1518
|
-
]);
|
|
1519
1519
|
var analyticsConfigSchema = zod.z.strictObject({
|
|
1520
|
-
enabled: zod.z.boolean(),
|
|
1521
|
-
endpoint: nonEmptyStringSchema.optional(),
|
|
1522
|
-
exporter: zod.z.enum(["otlp-http", "console"]).optional(),
|
|
1523
|
-
headers: zod.z.array(analyticsHeaderSchema).optional(),
|
|
1524
|
-
batchSize: zod.z.number().int().positive().optional(),
|
|
1525
|
-
scheduledDelayMs: zod.z.number().nonnegative().optional(),
|
|
1526
|
-
exportTimeoutMs: zod.z.number().nonnegative().optional()
|
|
1520
|
+
enabled: zod.z.boolean().describe("Whether generated clients export usage telemetry."),
|
|
1521
|
+
endpoint: nonEmptyStringSchema.optional().describe("The telemetry export endpoint."),
|
|
1522
|
+
exporter: zod.z.enum(["otlp-http", "console"]).optional().describe("The telemetry exporter implementation."),
|
|
1523
|
+
headers: zod.z.array(analyticsHeaderSchema).optional().describe("Headers sent by the telemetry exporter."),
|
|
1524
|
+
batchSize: zod.z.number().int().positive().optional().describe("The maximum spans in each export batch."),
|
|
1525
|
+
scheduledDelayMs: zod.z.number().nonnegative().optional().describe("The delay between scheduled exports, in milliseconds."),
|
|
1526
|
+
exportTimeoutMs: zod.z.number().nonnegative().optional().describe("The maximum time allowed for an export, in milliseconds.")
|
|
1527
1527
|
}).superRefine(({ enabled, endpoint }, context) => {
|
|
1528
1528
|
if (enabled && endpoint === void 0) {
|
|
1529
1529
|
context.addIssue({
|
|
@@ -1534,73 +1534,63 @@ var analyticsConfigSchema = zod.z.strictObject({
|
|
|
1534
1534
|
}
|
|
1535
1535
|
});
|
|
1536
1536
|
var wireTestsSchema = zod.z.strictObject({
|
|
1537
|
-
enabled: zod.z.boolean(),
|
|
1538
|
-
exclusions: zod.z.array(nonEmptyStringSchema).optional(),
|
|
1539
|
-
fallbackToGeneratedErrorExamples: zod.z.boolean().optional(),
|
|
1540
|
-
fixtureSource: zod.z.enum(["synthetic", "recorded", "auto"]).optional()
|
|
1537
|
+
enabled: zod.z.boolean().describe("Whether wire-level request and response tests are generated."),
|
|
1538
|
+
exclusions: zod.z.array(nonEmptyStringSchema).optional().describe("Operations excluded from wire tests."),
|
|
1539
|
+
fallbackToGeneratedErrorExamples: zod.z.boolean().optional().describe("Whether missing error fixtures are synthesized from generated examples."),
|
|
1540
|
+
fixtureSource: zod.z.enum(["synthetic", "recorded", "auto"]).optional().describe("Where wire-test fixtures are obtained.")
|
|
1541
1541
|
});
|
|
1542
1542
|
var unitTestsSchema = zod.z.strictObject({
|
|
1543
|
-
enabled: zod.z.boolean(),
|
|
1544
|
-
|
|
1545
|
-
exclusions: zod.z.array(nonEmptyStringSchema).optional()
|
|
1543
|
+
enabled: zod.z.boolean().describe("Whether SDK unit tests are generated."),
|
|
1544
|
+
exclusions: zod.z.array(nonEmptyStringSchema).optional().describe("Operations excluded from unit tests.")
|
|
1546
1545
|
});
|
|
1547
1546
|
var streamsSchema = zod.z.strictObject({
|
|
1548
|
-
enabled: zod.z.boolean(),
|
|
1549
|
-
responseType: zod.z.enum(["wrapper", "native", "web"]).optional(),
|
|
1550
|
-
fileResponseType: zod.z.enum(["stream", "binary-response"]).optional(),
|
|
1551
|
-
defaultChunkSizeBytes: zod.z.number().int().positive().optional()
|
|
1547
|
+
enabled: zod.z.boolean().describe("Whether generated clients expose streaming response APIs."),
|
|
1548
|
+
responseType: zod.z.enum(["wrapper", "native", "web"]).optional().describe("The streaming response abstraction exposed by generated clients."),
|
|
1549
|
+
fileResponseType: zod.z.enum(["stream", "binary-response"]).optional().describe("The response type used for file downloads."),
|
|
1550
|
+
defaultChunkSizeBytes: zod.z.number().int().positive().optional().describe("The default number of bytes yielded by streaming iterators.")
|
|
1552
1551
|
});
|
|
1553
1552
|
var layoutConfigSchema = zod.z.strictObject({
|
|
1554
|
-
outputDirectory: zod.z.enum(["project-root", "source-root"]).optional(),
|
|
1555
|
-
packagePath: nonEmptyStringSchema.optional()
|
|
1553
|
+
outputDirectory: zod.z.enum(["project-root", "source-root"]).optional().describe("Whether generated source is rooted at the project or its source directory."),
|
|
1554
|
+
packagePath: nonEmptyStringSchema.optional().describe("The package-relative path for generated source files.")
|
|
1556
1555
|
});
|
|
1557
1556
|
var serializationConfigSchema = zod.z.strictObject({
|
|
1558
|
-
enumRepresentation: zod.z.enum(["enum", "union", "literal", "forward-compatible-enum", "language-default"]).optional(),
|
|
1559
|
-
additionalProperties: zod.z.enum(["allow", "forbid", "ignore", "language-default"]).optional(),
|
|
1560
|
-
inlineTypes: zod.z.boolean().optional(),
|
|
1561
|
-
omitUndefined: zod.z.boolean().optional()
|
|
1557
|
+
enumRepresentation: zod.z.enum(["enum", "union", "literal", "forward-compatible-enum", "language-default"]).optional().describe("How schema enums are represented in generated code."),
|
|
1558
|
+
additionalProperties: zod.z.enum(["allow", "forbid", "ignore", "language-default"]).optional().describe("How undeclared object properties are handled."),
|
|
1559
|
+
inlineTypes: zod.z.boolean().optional().describe("Whether inline schemas remain nested under their parent types."),
|
|
1560
|
+
omitUndefined: zod.z.boolean().optional().describe("Whether undefined properties are omitted during serialization.")
|
|
1562
1561
|
});
|
|
1563
1562
|
var generationConfigOverrideShape = {
|
|
1564
|
-
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
|
|
1583
|
-
unitTests: unitTestsSchema.optional(),
|
|
1584
|
-
webSockets: zod.z.boolean().optional(),
|
|
1585
|
-
streams: streamsSchema.optional(),
|
|
1586
|
-
naming: namingConfigSchema.optional(),
|
|
1587
|
-
layout: layoutConfigSchema.optional(),
|
|
1588
|
-
serialization: serializationConfigSchema.optional()
|
|
1563
|
+
includeOptionalSnippetParameters: zod.z.boolean().optional().describe("Whether usage snippets include optional request parameters."),
|
|
1564
|
+
buildAllModels: zod.z.boolean().optional().describe("Whether models not referenced by operations are also generated."),
|
|
1565
|
+
inferServiceNames: zod.z.boolean().optional().describe("Whether service names are inferred from API structure."),
|
|
1566
|
+
includeDeprecatedOperations: zod.z.boolean().optional().describe("Whether deprecated API operations are generated."),
|
|
1567
|
+
multipleResponses: zod.z.boolean().optional().describe("Whether operations model multiple successful response types."),
|
|
1568
|
+
devContainer: zod.z.boolean().optional().describe("Whether development-container configuration is generated."),
|
|
1569
|
+
allowMockClient: zod.z.boolean().optional().describe("Whether a mock API client is included in the generated SDK."),
|
|
1570
|
+
ignoreFiles: zod.z.array(nonEmptyStringSchema).optional().describe("Generated paths excluded from the final output."),
|
|
1571
|
+
reservedKeywords: zod.z.array(nonEmptyStringSchema).optional().describe("Additional identifiers treated as reserved words."),
|
|
1572
|
+
customCode: customCodeConfigSchema.optional().describe("Customer-authored code merge configuration."),
|
|
1573
|
+
customQueryPaths: zod.z.array(relativePathSchema).optional().describe("Relative paths to custom query definitions."),
|
|
1574
|
+
analytics: analyticsConfigSchema.optional().describe("Generated client telemetry configuration."),
|
|
1575
|
+
wireTests: wireTestsSchema.optional().describe("Wire-level request and response test generation."),
|
|
1576
|
+
unitTests: unitTestsSchema.optional().describe("SDK unit-test generation."),
|
|
1577
|
+
webSockets: zod.z.boolean().optional().describe("Whether WebSocket clients are generated for supported channels."),
|
|
1578
|
+
streams: streamsSchema.optional().describe("Streaming response generation behavior."),
|
|
1579
|
+
naming: namingConfigSchema.optional().describe("Names and casing used by generated code."),
|
|
1580
|
+
layout: layoutConfigSchema.optional().describe("Generated project and source layout."),
|
|
1581
|
+
serialization: serializationConfigSchema.optional().describe("Generated model serialization behavior.")
|
|
1589
1582
|
};
|
|
1590
1583
|
var sdkConfigV1GenerationConfigOverrideSchema = zod.z.strictObject(
|
|
1591
1584
|
generationConfigOverrideShape
|
|
1592
1585
|
);
|
|
1593
1586
|
var sdkConfigV1GenerationConfigSchema = zod.z.strictObject({
|
|
1594
1587
|
...generationConfigOverrideShape,
|
|
1595
|
-
|
|
1596
|
-
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
generateFullProject: zod.z.boolean().default(false),
|
|
1602
|
-
devContainer: zod.z.boolean().default(false),
|
|
1603
|
-
allowMockClient: zod.z.boolean().default(false)
|
|
1588
|
+
buildAllModels: zod.z.boolean().default(false).describe("Whether models not referenced by operations are also generated."),
|
|
1589
|
+
inferServiceNames: zod.z.boolean().default(false).describe("Whether service names are inferred from API structure."),
|
|
1590
|
+
includeDeprecatedOperations: zod.z.boolean().default(true).describe("Whether deprecated API operations are generated."),
|
|
1591
|
+
multipleResponses: zod.z.boolean().default(false).describe("Whether operations model multiple successful response types."),
|
|
1592
|
+
devContainer: zod.z.boolean().default(false).describe("Whether development-container configuration is generated."),
|
|
1593
|
+
allowMockClient: zod.z.boolean().default(false).describe("Whether a mock API client is included in the generated SDK.")
|
|
1604
1594
|
});
|
|
1605
1595
|
var commonGenerationKeys = new Set(Object.keys(generationConfigOverrideShape));
|
|
1606
1596
|
function splitSdkConfigV1TargetGeneration(generation) {
|
|
@@ -1622,78 +1612,97 @@ var sdkConfigV1PublishRegistrySchema = zod.z.enum([
|
|
|
1622
1612
|
"composer"
|
|
1623
1613
|
]);
|
|
1624
1614
|
var mavenSignatureSchema = zod.z.strictObject({
|
|
1625
|
-
keyId: nonEmptyStringSchema
|
|
1626
|
-
|
|
1627
|
-
|
|
1615
|
+
keyId: nonEmptyStringSchema.describe(
|
|
1616
|
+
"The signing key identifier, or an environment expression that resolves to it."
|
|
1617
|
+
),
|
|
1618
|
+
password: nonEmptyStringSchema.describe(
|
|
1619
|
+
"The signing key password, or an environment expression that resolves to it."
|
|
1620
|
+
),
|
|
1621
|
+
secretKey: nonEmptyStringSchema.describe(
|
|
1622
|
+
"The armored secret key, or an environment expression that resolves to it."
|
|
1623
|
+
)
|
|
1628
1624
|
});
|
|
1629
1625
|
var commonPublishShape = {
|
|
1630
|
-
url: nonEmptyStringSchema.optional(),
|
|
1631
|
-
releaseBranch: nonEmptyStringSchema.optional(),
|
|
1632
|
-
tolerateRepublish: zod.z.boolean().optional()
|
|
1626
|
+
url: nonEmptyStringSchema.optional().describe("A custom package registry URL."),
|
|
1627
|
+
releaseBranch: nonEmptyStringSchema.optional().describe("The branch used by generated package release workflows."),
|
|
1628
|
+
tolerateRepublish: zod.z.boolean().optional().describe("Whether an already-published package version is treated as non-fatal.")
|
|
1633
1629
|
};
|
|
1634
1630
|
var sdkConfigV1PublishConfigSchema = zod.z.discriminatedUnion("registry", [
|
|
1635
1631
|
zod.z.strictObject({
|
|
1636
|
-
registry: zod.z.literal("npm"),
|
|
1637
|
-
token: nonEmptyStringSchema.optional(),
|
|
1632
|
+
registry: zod.z.literal("npm").describe("Publishes the package to an npm-compatible registry."),
|
|
1633
|
+
token: nonEmptyStringSchema.optional().describe("The npm registry token, or an environment expression that resolves to it."),
|
|
1638
1634
|
...commonPublishShape
|
|
1639
1635
|
}),
|
|
1640
1636
|
zod.z.strictObject({
|
|
1641
|
-
registry: zod.z.literal("pypi"),
|
|
1642
|
-
username: nonEmptyStringSchema.optional(),
|
|
1643
|
-
password: nonEmptyStringSchema.optional(),
|
|
1637
|
+
registry: zod.z.literal("pypi").describe("Publishes the package to a PyPI-compatible registry."),
|
|
1638
|
+
username: nonEmptyStringSchema.optional().describe("The PyPI username, or an environment expression that resolves to it."),
|
|
1639
|
+
password: nonEmptyStringSchema.optional().describe("The PyPI password or token, or an environment expression that resolves to it."),
|
|
1644
1640
|
...commonPublishShape
|
|
1645
1641
|
}),
|
|
1646
1642
|
zod.z.strictObject({
|
|
1647
|
-
registry: zod.z.literal("maven"),
|
|
1648
|
-
username: nonEmptyStringSchema.optional(),
|
|
1649
|
-
password: nonEmptyStringSchema.optional(),
|
|
1650
|
-
signature: mavenSignatureSchema.optional(),
|
|
1643
|
+
registry: zod.z.literal("maven").describe("Publishes the package to a Maven-compatible repository."),
|
|
1644
|
+
username: nonEmptyStringSchema.optional().describe("The Maven username, or an environment expression that resolves to it."),
|
|
1645
|
+
password: nonEmptyStringSchema.optional().describe("The Maven password, or an environment expression that resolves to it."),
|
|
1646
|
+
signature: mavenSignatureSchema.optional().describe("Credentials used to sign Maven artifacts."),
|
|
1651
1647
|
...commonPublishShape
|
|
1652
1648
|
}),
|
|
1653
|
-
zod.z.strictObject({ registry: zod.z.literal("nuget"), ...commonPublishShape }),
|
|
1654
|
-
zod.z.strictObject({ registry: zod.z.literal("rubygems"), ...commonPublishShape }),
|
|
1655
1649
|
zod.z.strictObject({
|
|
1656
|
-
registry: zod.z.literal("
|
|
1657
|
-
token: nonEmptyStringSchema.optional(),
|
|
1650
|
+
registry: zod.z.literal("nuget").describe("Publishes the package to a NuGet-compatible registry."),
|
|
1658
1651
|
...commonPublishShape
|
|
1659
1652
|
}),
|
|
1660
|
-
zod.z.strictObject({
|
|
1661
|
-
|
|
1653
|
+
zod.z.strictObject({
|
|
1654
|
+
registry: zod.z.literal("rubygems").describe("Publishes the package to a RubyGems-compatible registry."),
|
|
1655
|
+
...commonPublishShape
|
|
1656
|
+
}),
|
|
1657
|
+
zod.z.strictObject({
|
|
1658
|
+
registry: zod.z.literal("crates").describe("Publishes the crate to a Cargo-compatible registry."),
|
|
1659
|
+
token: nonEmptyStringSchema.optional().describe("The Cargo registry token, or an environment expression that resolves to it."),
|
|
1660
|
+
...commonPublishShape
|
|
1661
|
+
}),
|
|
1662
|
+
zod.z.strictObject({
|
|
1663
|
+
registry: zod.z.literal("go").describe("Publishes the SDK as a Go module."),
|
|
1664
|
+
...commonPublishShape
|
|
1665
|
+
}),
|
|
1666
|
+
zod.z.strictObject({
|
|
1667
|
+
registry: zod.z.literal("composer").describe("Publishes the package to a Composer-compatible registry."),
|
|
1668
|
+
...commonPublishShape
|
|
1669
|
+
})
|
|
1662
1670
|
]);
|
|
1663
1671
|
var reviewersSchema = zod.z.strictObject({
|
|
1664
|
-
teams: zod.z.array(nonEmptyStringSchema).optional(),
|
|
1665
|
-
users: zod.z.array(nonEmptyStringSchema).optional()
|
|
1672
|
+
teams: zod.z.array(nonEmptyStringSchema).optional().describe("GitHub teams requested as reviewers."),
|
|
1673
|
+
users: zod.z.array(nonEmptyStringSchema).optional().describe("GitHub users requested as reviewers.")
|
|
1666
1674
|
});
|
|
1667
1675
|
var githubCredentialsSchema = zod.z.strictObject({
|
|
1668
|
-
username: nonEmptyStringSchema.optional(),
|
|
1669
|
-
password: nonEmptyStringSchema.optional(),
|
|
1670
|
-
token: nonEmptyStringSchema.optional(),
|
|
1671
|
-
apiKey: nonEmptyStringSchema.optional()
|
|
1676
|
+
username: nonEmptyStringSchema.optional().describe("The username used to authenticate with the GitHub host."),
|
|
1677
|
+
password: nonEmptyStringSchema.optional().describe("The password used to authenticate with the GitHub host."),
|
|
1678
|
+
token: nonEmptyStringSchema.optional().describe("A token used to authenticate with the GitHub host."),
|
|
1679
|
+
apiKey: nonEmptyStringSchema.optional().describe("An API key used to authenticate with the GitHub host.")
|
|
1672
1680
|
});
|
|
1673
1681
|
var githubOutputSchema = zod.z.strictObject({
|
|
1674
|
-
repository: nonEmptyStringSchema
|
|
1675
|
-
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
+
repository: nonEmptyStringSchema.describe(
|
|
1683
|
+
"The GitHub repository that receives generated files."
|
|
1684
|
+
),
|
|
1685
|
+
host: nonEmptyStringSchema.optional().describe("The GitHub host for enterprise installations."),
|
|
1686
|
+
branch: nonEmptyStringSchema.optional().describe("The target branch for generated changes."),
|
|
1687
|
+
mode: zod.z.enum(["release", "pull-request", "push", "commit", "commit-and-release"]).optional().describe("How generated changes are delivered to the repository."),
|
|
1688
|
+
reviewers: reviewersSchema.optional().describe("Reviewers requested for generated pull requests."),
|
|
1689
|
+
credentials: githubCredentialsSchema.optional().describe("Credentials used to authenticate GitHub delivery."),
|
|
1690
|
+
privateRepository: zod.z.boolean().optional().describe("Whether the destination repository is private.")
|
|
1682
1691
|
});
|
|
1683
1692
|
var filesOutputSchema = zod.z.strictObject({
|
|
1684
|
-
delivery: zod.z.literal("files"),
|
|
1685
|
-
path: nonEmptyStringSchema.optional(),
|
|
1686
|
-
publish: sdkConfigV1PublishConfigSchema.optional()
|
|
1693
|
+
delivery: zod.z.literal("files").describe("Writes the generated SDK to a directory."),
|
|
1694
|
+
path: nonEmptyStringSchema.optional().describe("The destination directory for generated files."),
|
|
1695
|
+
publish: sdkConfigV1PublishConfigSchema.optional().describe("Optional package registry publication.")
|
|
1687
1696
|
});
|
|
1688
1697
|
var zipOutputSchema = zod.z.strictObject({
|
|
1689
|
-
delivery: zod.z.literal("zip"),
|
|
1690
|
-
fileName: nonEmptyStringSchema.optional(),
|
|
1691
|
-
publish: sdkConfigV1PublishConfigSchema.optional()
|
|
1698
|
+
delivery: zod.z.literal("zip").describe("Packages the generated SDK as a ZIP archive."),
|
|
1699
|
+
fileName: nonEmptyStringSchema.optional().describe("The generated ZIP archive file name."),
|
|
1700
|
+
publish: sdkConfigV1PublishConfigSchema.optional().describe("Optional package registry publication.")
|
|
1692
1701
|
});
|
|
1693
1702
|
var githubDeliverySchema = zod.z.strictObject({
|
|
1694
|
-
delivery: zod.z.literal("github"),
|
|
1695
|
-
github: githubOutputSchema,
|
|
1696
|
-
publish: sdkConfigV1PublishConfigSchema.optional()
|
|
1703
|
+
delivery: zod.z.literal("github").describe("Delivers the generated SDK to GitHub."),
|
|
1704
|
+
github: githubOutputSchema.describe("GitHub repository delivery settings."),
|
|
1705
|
+
publish: sdkConfigV1PublishConfigSchema.optional().describe("Optional package registry publication.")
|
|
1697
1706
|
});
|
|
1698
1707
|
var sdkConfigV1OutputConfigSchema = zod.z.discriminatedUnion(
|
|
1699
1708
|
"delivery",
|
|
@@ -1705,29 +1714,33 @@ var sdkConfigV1OutputConfigSchema = zod.z.discriminatedUnion(
|
|
|
1705
1714
|
var sdkConfigV1DependencySchema = dependencySchema;
|
|
1706
1715
|
var sdkConfigV1PackageConfigSchema = packageConfigSchema;
|
|
1707
1716
|
var sdkConfigV1ReplayConfigSchema = zod.z.strictObject({
|
|
1708
|
-
enabled: zod.z.boolean()
|
|
1717
|
+
enabled: zod.z.boolean().describe("Whether regeneration reapplies customer-authored repository changes.")
|
|
1709
1718
|
});
|
|
1710
1719
|
var apiImportSettingsSchema = zod.z.strictObject({
|
|
1711
|
-
respectNullableSchemas: zod.z.boolean().optional(),
|
|
1712
|
-
titleAsSchemaName: zod.z.boolean().optional(),
|
|
1713
|
-
coerceEnumsToLiterals: zod.z.boolean().optional(),
|
|
1714
|
-
idiomaticRequestNames: zod.z.boolean().optional(),
|
|
1715
|
-
wrapReferencesToNullableInOptional: zod.z.boolean().optional(),
|
|
1716
|
-
coerceOptionalSchemasToNullable: zod.z.boolean().optional(),
|
|
1717
|
-
pathParameterOrder: zod.z.enum(["url-order", "spec-order"]).optional(),
|
|
1718
|
-
onlyIncludeReferencedSchemas: zod.z.boolean().optional(),
|
|
1719
|
-
objectQueryParameters: zod.z.boolean().optional(),
|
|
1720
|
-
typeDatesAsStrings: zod.z.boolean().optional(),
|
|
1721
|
-
groupMultiApiEnvironments: zod.z.boolean().optional()
|
|
1722
|
-
|
|
1723
|
-
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
|
|
1730
|
-
|
|
1720
|
+
respectNullableSchemas: zod.z.boolean().optional().describe("Whether nullable schemas remain nullable in generated types."),
|
|
1721
|
+
titleAsSchemaName: zod.z.boolean().optional().describe("Whether a schema title can determine the generated type name."),
|
|
1722
|
+
coerceEnumsToLiterals: zod.z.boolean().optional().describe("Whether single-value enums are imported as literal values."),
|
|
1723
|
+
idiomaticRequestNames: zod.z.boolean().optional().describe("Whether request types use concise, idiomatic generated names."),
|
|
1724
|
+
wrapReferencesToNullableInOptional: zod.z.boolean().optional().describe("Whether nullable schema references are also treated as optional."),
|
|
1725
|
+
coerceOptionalSchemasToNullable: zod.z.boolean().optional().describe("Whether optional properties are represented as nullable required properties."),
|
|
1726
|
+
pathParameterOrder: zod.z.enum(["url-order", "spec-order"]).optional().describe("Whether path parameters follow their URL order or specification order."),
|
|
1727
|
+
onlyIncludeReferencedSchemas: zod.z.boolean().optional().describe("Whether unreferenced schemas are omitted from the generated SDK."),
|
|
1728
|
+
objectQueryParameters: zod.z.boolean().optional().describe("Whether object-valued query parameters are preserved as objects."),
|
|
1729
|
+
typeDatesAsStrings: zod.z.boolean().optional().describe("Whether date and date-time schemas are generated as strings."),
|
|
1730
|
+
groupMultiApiEnvironments: zod.z.boolean().optional().describe(
|
|
1731
|
+
"Whether environments from multiple API sources are merged into shared named groups."
|
|
1732
|
+
),
|
|
1733
|
+
ignoreTags: zod.z.boolean().optional().describe("Whether API tags are ignored when organizing generated resources."),
|
|
1734
|
+
disambiguateRequestNames: zod.z.boolean().optional().describe("Whether colliding request type names are automatically disambiguated."),
|
|
1735
|
+
respectReadonlySchemas: zod.z.boolean().optional().describe(
|
|
1736
|
+
"Whether read-only properties are modeled separately for request and response types."
|
|
1737
|
+
),
|
|
1738
|
+
discriminatedUnionV2: zod.z.boolean().optional().describe("Whether oneOf and anyOf schemas use the newer discriminator inference rules."),
|
|
1739
|
+
undiscriminatedUnionsWithLiterals: zod.z.boolean().optional().describe("Whether literal-bearing unions remain undiscriminated during import."),
|
|
1740
|
+
inlineAllOfSchemas: zod.z.boolean().optional().describe("Whether schemas composed with allOf are inlined when possible."),
|
|
1741
|
+
resolveSchemaCollisions: zod.z.boolean().optional().describe("Whether colliding imported schema names are resolved automatically."),
|
|
1742
|
+
asyncApiMessageNaming: zod.z.enum(["v1", "v2"]).optional().describe("The naming strategy used for messages imported from AsyncAPI."),
|
|
1743
|
+
defaultIntegerFormat: zod.z.enum(["int32", "int64", "uint32", "uint64"]).optional().describe("The integer format used when a schema does not declare one.")
|
|
1731
1744
|
});
|
|
1732
1745
|
var sourceSpecTypeSchema = zod.z.enum([
|
|
1733
1746
|
"openapi",
|
|
@@ -1739,27 +1752,30 @@ var sourceSpecTypeSchema = zod.z.enum([
|
|
|
1739
1752
|
|
|
1740
1753
|
// src/sdk-config/v1/source.ts
|
|
1741
1754
|
var sourceSpecShape = {
|
|
1742
|
-
id: nonEmptyStringSchema,
|
|
1743
|
-
type: sourceSpecTypeSchema,
|
|
1744
|
-
name: nonEmptyStringSchema.optional(),
|
|
1745
|
-
namespace: nonEmptyStringSchema.optional(),
|
|
1746
|
-
apiImportSettings: apiImportSettingsSchema.optional(),
|
|
1747
|
-
overlays: zod.z.array(relativePathSchema).optional(),
|
|
1748
|
-
overrides: zod.z.array(relativePathSchema).optional()
|
|
1755
|
+
id: nonEmptyStringSchema.describe("A unique identifier for this API source."),
|
|
1756
|
+
type: sourceSpecTypeSchema.describe("The API description format of this source."),
|
|
1757
|
+
name: nonEmptyStringSchema.optional().describe("A human-readable name for this API source."),
|
|
1758
|
+
namespace: nonEmptyStringSchema.optional().describe("A namespace used to isolate this source in a multi-source SDK."),
|
|
1759
|
+
apiImportSettings: apiImportSettingsSchema.optional().describe("Import behavior that overrides the source-level defaults for this spec."),
|
|
1760
|
+
overlays: zod.z.array(relativePathSchema).optional().describe("Relative paths to overlays applied to this source in order."),
|
|
1761
|
+
overrides: zod.z.array(relativePathSchema).optional().describe("Relative paths to source override files applied in order.")
|
|
1749
1762
|
};
|
|
1750
1763
|
var sdkConfigV1SourceSpecSchema = zod.z.union(
|
|
1751
1764
|
[
|
|
1752
|
-
zod.z.strictObject({ ...sourceSpecShape, path: relativePathSchema }),
|
|
1753
1765
|
zod.z.strictObject({
|
|
1754
1766
|
...sourceSpecShape,
|
|
1755
|
-
|
|
1767
|
+
path: relativePathSchema.describe("The relative path to the API source file.")
|
|
1768
|
+
}),
|
|
1769
|
+
zod.z.strictObject({
|
|
1770
|
+
...sourceSpecShape,
|
|
1771
|
+
url: zod.z.url({ protocol: /^https?$/ }).describe("The HTTP or HTTPS URL of the API source file.")
|
|
1756
1772
|
})
|
|
1757
1773
|
],
|
|
1758
1774
|
{ error: "source spec must contain exactly one locator: path or HTTP(S) url" }
|
|
1759
1775
|
);
|
|
1760
1776
|
var sdkConfigV1SourceConfigSchema = zod.z.strictObject({
|
|
1761
|
-
specs: zod.z.array(sdkConfigV1SourceSpecSchema).min(1, "source.specs must contain at least one source spec"),
|
|
1762
|
-
apiImportSettings: apiImportSettingsSchema.optional()
|
|
1777
|
+
specs: zod.z.array(sdkConfigV1SourceSpecSchema).min(1, "source.specs must contain at least one source spec").describe("API source files in authoritative processing order."),
|
|
1778
|
+
apiImportSettings: apiImportSettingsSchema.optional().describe("Default import behavior shared by every source spec.")
|
|
1763
1779
|
}).superRefine(({ specs }, context) => {
|
|
1764
1780
|
const seenIds = /* @__PURE__ */ new Set();
|
|
1765
1781
|
specs.forEach(({ id }, index) => {
|
|
@@ -1774,79 +1790,80 @@ var sdkConfigV1SourceConfigSchema = zod.z.strictObject({
|
|
|
1774
1790
|
});
|
|
1775
1791
|
});
|
|
1776
1792
|
var cliGenerationConfigSchema = zod.z.strictObject({
|
|
1777
|
-
paginationParameters: zod.z.array(nonEmptyStringSchema).optional(),
|
|
1778
|
-
skills: zod.z.boolean().optional()
|
|
1793
|
+
paginationParameters: zod.z.array(nonEmptyStringSchema).optional().describe("Request parameter names treated as pagination controls by the CLI."),
|
|
1794
|
+
skills: zod.z.boolean().optional().describe("Whether the generated CLI includes skills that teach AI agents to invoke commands.")
|
|
1779
1795
|
});
|
|
1780
1796
|
var csharpGenerationConfigSchema = zod.z.strictObject({
|
|
1781
|
-
useOptionalWrapper: zod.z.boolean().optional(),
|
|
1782
|
-
simplifyObjectDictionaries: zod.z.boolean().optional(),
|
|
1783
|
-
explicitNamespaces: zod.z.boolean().optional(),
|
|
1784
|
-
rootNamespaceForCoreClasses: zod.z.boolean().optional(),
|
|
1785
|
-
includeExceptionHandler: zod.z.boolean().optional(),
|
|
1786
|
-
experimentalExplicitNullableOptional: zod.z.boolean().optional()
|
|
1797
|
+
useOptionalWrapper: zod.z.boolean().optional().describe("Whether optional values use an explicit Optional wrapper."),
|
|
1798
|
+
simplifyObjectDictionaries: zod.z.boolean().optional().describe("Whether object schemas with arbitrary values use simplified dictionary types."),
|
|
1799
|
+
explicitNamespaces: zod.z.boolean().optional().describe("Whether generated resource groups use explicit nested namespaces."),
|
|
1800
|
+
rootNamespaceForCoreClasses: zod.z.boolean().optional().describe("Whether shared client classes are emitted in the root namespace."),
|
|
1801
|
+
includeExceptionHandler: zod.z.boolean().optional().describe("Whether generated client operations use a configurable exception handler."),
|
|
1802
|
+
experimentalExplicitNullableOptional: zod.z.boolean().optional().describe(
|
|
1803
|
+
"Whether optional nullable properties distinguish omitted values from explicit nulls."
|
|
1804
|
+
)
|
|
1787
1805
|
});
|
|
1788
1806
|
var goGenerationConfigSchema = zod.z.strictObject({
|
|
1789
|
-
legacyComplexModels: zod.z.boolean().optional(),
|
|
1807
|
+
legacyComplexModels: zod.z.boolean().optional().describe("Whether complex models use the legacy Go representation."),
|
|
1790
1808
|
/** Uppercase common initialisms in generated names (`UserID` rather than `UserId`). */
|
|
1791
|
-
smartCasing: zod.z.boolean().optional(),
|
|
1809
|
+
smartCasing: zod.z.boolean().optional().describe("Whether generated Go names capitalize common initialisms."),
|
|
1792
1810
|
/** Overrides the fern root-client constructor independently from the client type name. */
|
|
1793
|
-
clientConstructorName: nonEmptyStringSchema.optional(),
|
|
1794
|
-
unionVersion: zod.z.enum(["v0", "v1"]).optional(),
|
|
1795
|
-
includeLegacyClientOptions: zod.z.boolean().optional()
|
|
1811
|
+
clientConstructorName: nonEmptyStringSchema.optional().describe("The generated root-client constructor name."),
|
|
1812
|
+
unionVersion: zod.z.enum(["v0", "v1"]).optional().describe("The representation used for generated Go unions."),
|
|
1813
|
+
includeLegacyClientOptions: zod.z.boolean().optional().describe("Whether the client retains legacy constructor option helpers.")
|
|
1796
1814
|
});
|
|
1797
1815
|
var jvmGenerationConfigSchema = zod.z.strictObject({
|
|
1798
|
-
packageLayout: zod.z.enum(["flat", "nested"]).optional(),
|
|
1799
|
-
useLocalDateForDates: zod.z.boolean().optional(),
|
|
1800
|
-
collapseOptionalNullable: zod.z.boolean().optional(),
|
|
1801
|
-
gradleDistributionUrl: zod.z.string().min(1).optional(),
|
|
1802
|
-
gradlePluginManagement: zod.z.string().optional(),
|
|
1803
|
-
gradleCentralDependencyManagement: zod.z.boolean().optional(),
|
|
1816
|
+
packageLayout: zod.z.enum(["flat", "nested"]).optional().describe("Whether generated JVM packages use a flat or nested resource layout."),
|
|
1817
|
+
useLocalDateForDates: zod.z.boolean().optional().describe("Whether date-only values use LocalDate instead of OffsetDateTime."),
|
|
1818
|
+
collapseOptionalNullable: zod.z.boolean().optional().describe("Whether optional nullable values collapse into a single nullable representation."),
|
|
1819
|
+
gradleDistributionUrl: zod.z.string().min(1).optional().describe("The Gradle distribution URL written to the generated wrapper."),
|
|
1820
|
+
gradlePluginManagement: zod.z.string().optional().describe("Plugin management configuration added to the generated Gradle settings."),
|
|
1821
|
+
gradleCentralDependencyManagement: zod.z.boolean().optional().describe("Whether dependency versions are managed centrally in the Gradle project."),
|
|
1804
1822
|
/** Selects co-located async methods or a separate async client surface. */
|
|
1805
|
-
asyncStyle: zod.z.enum(["dedicated-client", "twin-methods"]).optional()
|
|
1823
|
+
asyncStyle: zod.z.enum(["dedicated-client", "twin-methods"]).optional().describe("Whether asynchronous operations use a separate client or co-located methods.")
|
|
1806
1824
|
});
|
|
1807
1825
|
|
|
1808
1826
|
// src/sdk-config-domain/v1/language/java.ts
|
|
1809
1827
|
var javaGenerationConfigSchema = jvmGenerationConfigSchema.extend({
|
|
1810
|
-
includeKotlinSnippets: zod.z.boolean().optional()
|
|
1828
|
+
includeKotlinSnippets: zod.z.boolean().optional().describe("Whether Java SDK documentation includes Kotlin usage snippets.")
|
|
1811
1829
|
});
|
|
1812
1830
|
|
|
1813
1831
|
// src/sdk-config-domain/v1/language/kotlin.ts
|
|
1814
1832
|
var kotlinGenerationConfigSchema = jvmGenerationConfigSchema;
|
|
1815
1833
|
var compilerOptionsSchema = zod.z.strictObject({
|
|
1816
|
-
target: nonEmptyStringSchema.optional(),
|
|
1817
|
-
module: nonEmptyStringSchema.optional(),
|
|
1818
|
-
lib: zod.z.array(nonEmptyStringSchema).optional()
|
|
1834
|
+
target: nonEmptyStringSchema.optional().describe("The JavaScript language target passed to TypeScript."),
|
|
1835
|
+
module: nonEmptyStringSchema.optional().describe("The module format passed to TypeScript."),
|
|
1836
|
+
lib: zod.z.array(nonEmptyStringSchema).optional().describe("The runtime library definitions passed to TypeScript.")
|
|
1819
1837
|
});
|
|
1820
1838
|
var packageScriptSchema = zod.z.strictObject({
|
|
1821
|
-
name: nonEmptyStringSchema,
|
|
1822
|
-
command: nonEmptyStringSchema
|
|
1839
|
+
name: nonEmptyStringSchema.describe("The package script name."),
|
|
1840
|
+
command: nonEmptyStringSchema.describe("The command executed by the package script.")
|
|
1823
1841
|
});
|
|
1824
1842
|
var httpClientSchema = zod.z.strictObject({
|
|
1825
|
-
name: zod.z.enum(["axios", "fetch"])
|
|
1843
|
+
name: zod.z.enum(["axios", "fetch"]).describe("The HTTP client used by generated TypeScript code.")
|
|
1826
1844
|
});
|
|
1827
1845
|
var typescriptGenerationConfigSchema = zod.z.strictObject({
|
|
1828
|
-
typescriptVersion: nonEmptyStringSchema.optional(),
|
|
1829
|
-
zodVersion: nonEmptyStringSchema.optional(),
|
|
1830
|
-
compilerOptions: compilerOptionsSchema.optional(),
|
|
1831
|
-
httpClient: httpClientSchema.optional(),
|
|
1832
|
-
packageManager: zod.z.enum(["pnpm", "yarn"]).optional(),
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
|
|
1838
|
-
exportClassDefault: zod.z.boolean().optional(),
|
|
1846
|
+
typescriptVersion: nonEmptyStringSchema.optional().describe("The TypeScript version used by the generated project."),
|
|
1847
|
+
zodVersion: nonEmptyStringSchema.optional().describe("The Zod version used by generated runtime schemas."),
|
|
1848
|
+
compilerOptions: compilerOptionsSchema.optional().describe("TypeScript compiler options for the generated project."),
|
|
1849
|
+
httpClient: httpClientSchema.optional().describe("The HTTP client used by generated TypeScript code."),
|
|
1850
|
+
packageManager: zod.z.enum(["pnpm", "yarn"]).optional().describe("The package manager used by the generated project."),
|
|
1851
|
+
packageManagerVersion: nonEmptyStringSchema.optional().describe("The package manager version used by the generated project."),
|
|
1852
|
+
testFramework: zod.z.enum(["jest", "vitest"]).optional().describe("The test framework used by generated tests."),
|
|
1853
|
+
namingStrategy: zod.z.enum(["base", "originalPropertyNames"]).optional().describe("How schema property names are converted into TypeScript identifiers."),
|
|
1854
|
+
bundle: zod.z.boolean().optional().describe("Whether the generated package includes bundled output."),
|
|
1855
|
+
exportClassDefault: zod.z.boolean().optional().describe("Whether the client class is also exported as the default export."),
|
|
1839
1856
|
/** Name of the top-level namespace export emitted by Fern-compatible TypeScript SDKs. */
|
|
1840
|
-
namespaceExportName: nonEmptyStringSchema.optional(),
|
|
1841
|
-
consolidateTypeFiles: zod.z.boolean().optional(),
|
|
1842
|
-
allowCustomFetcher: zod.z.boolean().optional(),
|
|
1843
|
-
useBrandedStringAliases: zod.z.boolean().optional(),
|
|
1844
|
-
useLegacyExports: zod.z.boolean().optional(),
|
|
1845
|
-
useBigInt: zod.z.boolean().optional(),
|
|
1846
|
-
serdeLayer: zod.z.boolean().optional(),
|
|
1857
|
+
namespaceExportName: nonEmptyStringSchema.optional().describe("The top-level namespace export name."),
|
|
1858
|
+
consolidateTypeFiles: zod.z.boolean().optional().describe("Whether generated types are consolidated into fewer source files."),
|
|
1859
|
+
allowCustomFetcher: zod.z.boolean().optional().describe("Whether callers can supply a custom fetch implementation."),
|
|
1860
|
+
useBrandedStringAliases: zod.z.boolean().optional().describe("Whether string aliases are emitted as distinct branded types."),
|
|
1861
|
+
useLegacyExports: zod.z.boolean().optional().describe("Whether the package emits the legacy export layout."),
|
|
1862
|
+
useBigInt: zod.z.boolean().optional().describe("Whether 64-bit integer values are represented with bigint."),
|
|
1863
|
+
serdeLayer: zod.z.boolean().optional().describe("Whether generated models use Fern serialization and deserialization helpers."),
|
|
1847
1864
|
/** Ship only the ESM build (drops CJS) to avoid the Node dual-package hazard. */
|
|
1848
|
-
esmOnly: zod.z.boolean().optional(),
|
|
1849
|
-
scripts: zod.z.array(packageScriptSchema).optional()
|
|
1865
|
+
esmOnly: zod.z.boolean().optional().describe("Whether the package emits only ECMAScript modules."),
|
|
1866
|
+
scripts: zod.z.array(packageScriptSchema).optional().describe("Additional scripts added to the generated package manifest.")
|
|
1850
1867
|
});
|
|
1851
1868
|
|
|
1852
1869
|
// src/sdk-config-domain/v1/language/mcp.ts
|
|
@@ -1861,172 +1878,183 @@ var mcpAvailabilityStatuses = [
|
|
|
1861
1878
|
"LEGACY"
|
|
1862
1879
|
];
|
|
1863
1880
|
var mcpToolFilterSchema = zod.z.strictObject({
|
|
1864
|
-
include: zod.z.array(nonEmptyStringSchema).optional(),
|
|
1865
|
-
exclude: zod.z.array(nonEmptyStringSchema).optional()
|
|
1881
|
+
include: zod.z.array(nonEmptyStringSchema).optional().describe("Operations explicitly included as MCP tools."),
|
|
1882
|
+
exclude: zod.z.array(nonEmptyStringSchema).optional().describe("Operations explicitly excluded from MCP tools.")
|
|
1866
1883
|
});
|
|
1867
1884
|
var mcpToolsetNameSchema = nonEmptyStringSchema.refine(
|
|
1868
1885
|
(name) => name !== "default" && /^[a-z0-9-]+$/.test(name),
|
|
1869
1886
|
'toolset names must match [a-z0-9-]+ and cannot be "default"'
|
|
1870
1887
|
);
|
|
1871
1888
|
var mcpGenerationConfigSchema = typescriptGenerationConfigSchema.extend({
|
|
1872
|
-
serverName: nonEmptyStringSchema.optional(),
|
|
1873
|
-
serverDescription: nonEmptyStringSchema.optional(),
|
|
1874
|
-
excludeAvailability: zod.z.array(zod.z.enum(mcpAvailabilityStatuses)).optional(),
|
|
1875
|
-
tools: mcpToolFilterSchema.optional(),
|
|
1876
|
-
toolsets: zod.z.record(mcpToolsetNameSchema, mcpToolFilterSchema).optional()
|
|
1889
|
+
serverName: nonEmptyStringSchema.optional().describe("The name advertised by the generated MCP server."),
|
|
1890
|
+
serverDescription: nonEmptyStringSchema.optional().describe("The description advertised by the generated MCP server."),
|
|
1891
|
+
excludeAvailability: zod.z.array(zod.z.enum(mcpAvailabilityStatuses)).optional().describe("Operation availability statuses excluded from MCP tool generation."),
|
|
1892
|
+
tools: mcpToolFilterSchema.optional().describe("Global operation filters for generated MCP tools."),
|
|
1893
|
+
toolsets: zod.z.record(mcpToolsetNameSchema, mcpToolFilterSchema).optional().describe("Named MCP toolsets and the operation filters for each toolset.")
|
|
1877
1894
|
});
|
|
1878
1895
|
var phpGenerationConfigSchema = zod.z.strictObject({
|
|
1879
|
-
propertyAccess: zod.z.enum(["public", "private"]).optional(),
|
|
1880
|
-
generateClientInterfaces: zod.z.boolean().optional()
|
|
1896
|
+
propertyAccess: zod.z.enum(["public", "private"]).optional().describe("The visibility of generated PHP model properties."),
|
|
1897
|
+
generateClientInterfaces: zod.z.boolean().optional().describe("Whether interfaces are generated for PHP client classes.")
|
|
1881
1898
|
});
|
|
1882
1899
|
var pythonClientSchema = zod.z.strictObject({
|
|
1883
|
-
fileName: nonEmptyStringSchema.optional(),
|
|
1884
|
-
exportedFileName: nonEmptyStringSchema.optional()
|
|
1900
|
+
fileName: nonEmptyStringSchema.optional().describe("The source file name for the Python client."),
|
|
1901
|
+
exportedFileName: nonEmptyStringSchema.optional().describe("The file name used when exporting the Python client.")
|
|
1885
1902
|
});
|
|
1886
1903
|
var pydanticConfigSchema = zod.z.strictObject({
|
|
1887
|
-
versionCompatibility: zod.z.enum(["v1", "v2", "both", "v1-on-v2"]).optional(),
|
|
1888
|
-
frozen: zod.z.boolean().optional(),
|
|
1889
|
-
requireOptionalFields: zod.z.boolean().optional(),
|
|
1890
|
-
unionNaming: zod.z.enum(["v0", "v1"]).optional(),
|
|
1891
|
-
useFieldAliases: zod.z.boolean().optional()
|
|
1904
|
+
versionCompatibility: zod.z.enum(["v1", "v2", "both", "v1-on-v2"]).optional().describe("The Pydantic major versions supported by generated models."),
|
|
1905
|
+
frozen: zod.z.boolean().optional().describe("Whether generated Pydantic models are immutable."),
|
|
1906
|
+
requireOptionalFields: zod.z.boolean().optional().describe("Whether Optional fields remain required unless they declare a default."),
|
|
1907
|
+
unionNaming: zod.z.enum(["v0", "v1"]).optional().describe("The naming strategy for generated union types."),
|
|
1908
|
+
useFieldAliases: zod.z.boolean().optional().describe("Whether Pydantic field aliases preserve wire names.")
|
|
1892
1909
|
});
|
|
1893
1910
|
var additionalInitExportSchema = zod.z.strictObject({
|
|
1894
|
-
from: nonEmptyStringSchema,
|
|
1895
|
-
imports: zod.z.array(nonEmptyStringSchema).min(1)
|
|
1911
|
+
from: nonEmptyStringSchema.describe("The module from which names are re-exported."),
|
|
1912
|
+
imports: zod.z.array(nonEmptyStringSchema).min(1).describe("Names re-exported from the module.")
|
|
1896
1913
|
});
|
|
1897
1914
|
var pythonGenerationConfigSchema = zod.z.strictObject({
|
|
1898
|
-
pythonVersion: nonEmptyStringSchema.optional(),
|
|
1899
|
-
pydanticVersion: nonEmptyStringSchema.optional(),
|
|
1900
|
-
pydantic: pydanticConfigSchema.optional(),
|
|
1901
|
-
client: pythonClientSchema.optional(),
|
|
1915
|
+
pythonVersion: nonEmptyStringSchema.optional().describe("The Python version targeted by the generated project."),
|
|
1916
|
+
pydanticVersion: nonEmptyStringSchema.optional().describe("The Pydantic dependency version requirement."),
|
|
1917
|
+
pydantic: pydanticConfigSchema.optional().describe("Pydantic model-generation behavior."),
|
|
1918
|
+
client: pythonClientSchema.optional().describe("Python client file naming."),
|
|
1902
1919
|
/** Default followed by generated sync and async HTTP clients when the caller does not override it. */
|
|
1903
|
-
followRedirectsByDefault: zod.z.boolean().optional(),
|
|
1920
|
+
followRedirectsByDefault: zod.z.boolean().optional().describe("Whether generated HTTP clients follow redirects by default."),
|
|
1904
1921
|
/** Chunk size passed to Python byte-stream iterators. */
|
|
1905
|
-
defaultBytesStreamChunkSize: zod.z.number().int().positive().optional(),
|
|
1922
|
+
defaultBytesStreamChunkSize: zod.z.number().int().positive().optional().describe("The default byte-stream iterator chunk size."),
|
|
1906
1923
|
/** Python interpreter recursion limit installed by the generated package at import time. */
|
|
1907
|
-
recursionLimit: zod.z.number().int().gt(1e3).optional(),
|
|
1924
|
+
recursionLimit: zod.z.number().int().gt(1e3).optional().describe("The Python recursion limit installed when the generated package is imported."),
|
|
1908
1925
|
/** Published Python extras, keyed by extra name with package dependency names as values. */
|
|
1909
|
-
extras: zod.z.record(nonEmptyStringSchema, zod.z.array(nonEmptyStringSchema)).optional(),
|
|
1910
|
-
alwaysInitializeOptionals: zod.z.boolean().optional(),
|
|
1911
|
-
useTypedDictRequests: zod.z.boolean().optional(),
|
|
1912
|
-
additionalInitExports: zod.z.array(additionalInitExportSchema).optional()
|
|
1926
|
+
extras: zod.z.record(nonEmptyStringSchema, zod.z.array(nonEmptyStringSchema)).optional().describe("Published Python extras and their dependency names."),
|
|
1927
|
+
alwaysInitializeOptionals: zod.z.boolean().optional().describe("Whether optional model fields are initialized even when omitted."),
|
|
1928
|
+
useTypedDictRequests: zod.z.boolean().optional().describe("Whether request bodies are generated as TypedDict types."),
|
|
1929
|
+
additionalInitExports: zod.z.array(additionalInitExportSchema).optional().describe("Additional names re-exported from the package initializer.")
|
|
1913
1930
|
});
|
|
1914
1931
|
var rubyGenerationConfigSchema = zod.z.strictObject({
|
|
1915
|
-
requirePaths: zod.z.array(nonEmptyStringSchema).optional()
|
|
1932
|
+
requirePaths: zod.z.array(nonEmptyStringSchema).optional().describe("Ruby load paths included in the generated gem specification.")
|
|
1916
1933
|
});
|
|
1917
1934
|
var rustGenerationConfigSchema = zod.z.strictObject({
|
|
1918
1935
|
/**
|
|
1919
1936
|
* Rust type for datetime primitives. `offset` maps to `DateTime<FixedOffset>` and preserves the
|
|
1920
1937
|
* timezone the payload carried; `utc` maps to `DateTime<Utc>` and normalizes to UTC.
|
|
1921
1938
|
*/
|
|
1922
|
-
dateTimeType: zod.z.enum(["offset", "utc"]).optional(),
|
|
1939
|
+
dateTimeType: zod.z.enum(["offset", "utc"]).optional().describe("Whether datetime values preserve their offset or normalize to UTC."),
|
|
1923
1940
|
/** Uppercase common initialisms in generated names (`UserID` rather than `UserId`). */
|
|
1924
|
-
capitalizeInitialisms: zod.z.boolean().optional(),
|
|
1941
|
+
capitalizeInitialisms: zod.z.boolean().optional().describe("Whether generated Rust names capitalize common initialisms."),
|
|
1925
1942
|
/** Cargo features, mapping a feature name to the dependencies or features it enables. */
|
|
1926
|
-
features: zod.z.record(zod.z.string(), zod.z.array(nonEmptyStringSchema)).optional(),
|
|
1943
|
+
features: zod.z.record(zod.z.string(), zod.z.array(nonEmptyStringSchema)).optional().describe("Cargo features and the dependencies or features each enables."),
|
|
1927
1944
|
/** Overrides which features make up Cargo's `default` feature set. */
|
|
1928
|
-
defaultFeatures: zod.z.array(nonEmptyStringSchema).optional()
|
|
1945
|
+
defaultFeatures: zod.z.array(nonEmptyStringSchema).optional().describe("Cargo features included in the crate default feature set.")
|
|
1929
1946
|
});
|
|
1930
1947
|
var swiftGenerationConfigSchema = zod.z.strictObject({
|
|
1931
|
-
moduleName: nonEmptyStringSchema.optional(),
|
|
1932
|
-
nullableAsOptional: zod.z.boolean().optional()
|
|
1948
|
+
moduleName: nonEmptyStringSchema.optional().describe("The Swift module name for the generated package."),
|
|
1949
|
+
nullableAsOptional: zod.z.boolean().optional().describe("Whether nullable values are represented as Swift optionals.")
|
|
1933
1950
|
});
|
|
1934
1951
|
var planModifierSourceSchema = zod.z.discriminatedUnion("enabled", [
|
|
1935
|
-
zod.z.strictObject({
|
|
1936
|
-
|
|
1952
|
+
zod.z.strictObject({
|
|
1953
|
+
enabled: zod.z.literal(true).describe("Enables custom Terraform plan modifiers."),
|
|
1954
|
+
sourceDir: nonEmptyStringSchema.describe(
|
|
1955
|
+
"The directory containing custom plan modifier source files."
|
|
1956
|
+
)
|
|
1957
|
+
}),
|
|
1958
|
+
zod.z.strictObject({
|
|
1959
|
+
enabled: zod.z.literal(false).describe("Disables custom Terraform plan modifiers.")
|
|
1960
|
+
})
|
|
1937
1961
|
]);
|
|
1938
1962
|
var planModifiersSchema = zod.z.strictObject({
|
|
1939
|
-
resources: planModifierSourceSchema,
|
|
1940
|
-
attributes: planModifierSourceSchema
|
|
1963
|
+
resources: planModifierSourceSchema.describe("Custom plan modifiers for generated resources."),
|
|
1964
|
+
attributes: planModifierSourceSchema.describe("Custom plan modifiers for generated attributes.")
|
|
1941
1965
|
});
|
|
1942
1966
|
var providerSchemaSchema = zod.z.strictObject({
|
|
1943
|
-
addressKey: nonEmptyStringSchema
|
|
1944
|
-
|
|
1967
|
+
addressKey: nonEmptyStringSchema.describe(
|
|
1968
|
+
"The provider attribute used to configure the API address."
|
|
1969
|
+
),
|
|
1970
|
+
authTokenKey: nonEmptyStringSchema.describe(
|
|
1971
|
+
"The provider attribute used to configure the authentication token."
|
|
1972
|
+
)
|
|
1945
1973
|
});
|
|
1946
1974
|
var terraformGenerationConfigSchema = zod.z.strictObject({
|
|
1947
|
-
providerName: nonEmptyStringSchema.optional(),
|
|
1948
|
-
providerVersion: nonEmptyStringSchema.optional(),
|
|
1949
|
-
providerModulePath: goModulePathSchema.optional(),
|
|
1950
|
-
mockAcceptance: zod.z.boolean().optional(),
|
|
1951
|
-
hideComputedDiff: zod.z.boolean().optional(),
|
|
1952
|
-
providerSchema: providerSchemaSchema.optional(),
|
|
1953
|
-
planModifiers: planModifiersSchema.optional()
|
|
1975
|
+
providerName: nonEmptyStringSchema.optional().describe("The Terraform provider name."),
|
|
1976
|
+
providerVersion: nonEmptyStringSchema.optional().describe("The generated Terraform provider version."),
|
|
1977
|
+
providerModulePath: goModulePathSchema.optional().describe("The Go module path for the generated provider."),
|
|
1978
|
+
mockAcceptance: zod.z.boolean().optional().describe("Whether acceptance tests use a mock API server."),
|
|
1979
|
+
hideComputedDiff: zod.z.boolean().optional().describe("Whether computed-only changes are hidden from Terraform plans."),
|
|
1980
|
+
providerSchema: providerSchemaSchema.optional().describe("Names of provider-level configuration attributes."),
|
|
1981
|
+
planModifiers: planModifiersSchema.optional().describe("Custom plan modifier source configuration.")
|
|
1954
1982
|
});
|
|
1955
1983
|
|
|
1956
1984
|
// src/sdk-config/v1/target.ts
|
|
1957
1985
|
var targetOverrideShape = {
|
|
1958
|
-
generatorVersion: exactSemverSchema.optional(),
|
|
1959
|
-
sdkName: nonEmptyStringSchema.optional(),
|
|
1960
|
-
sdkVersion: nonEmptyStringSchema.optional(),
|
|
1961
|
-
client: sdkConfigV1ClientConfigOverrideSchema.optional(),
|
|
1962
|
-
docs: sdkConfigV1DocsConfigSchema.optional(),
|
|
1963
|
-
package: sdkConfigV1PackageConfigSchema.optional(),
|
|
1964
|
-
output: sdkConfigV1OutputConfigSchema.optional()
|
|
1986
|
+
generatorVersion: exactSemverSchema.optional().describe("The exact generator version used for this target."),
|
|
1987
|
+
sdkName: nonEmptyStringSchema.optional().describe("An SDK name that overrides the root value for this target."),
|
|
1988
|
+
sdkVersion: nonEmptyStringSchema.optional().describe("An SDK version that overrides the root value for this target."),
|
|
1989
|
+
client: sdkConfigV1ClientConfigOverrideSchema.optional().describe("Client settings that override root client configuration for this target."),
|
|
1990
|
+
docs: sdkConfigV1DocsConfigSchema.optional().describe("Documentation settings that override root documentation for this target."),
|
|
1991
|
+
package: sdkConfigV1PackageConfigSchema.optional().describe("Package metadata that overrides root package configuration for this target."),
|
|
1992
|
+
output: sdkConfigV1OutputConfigSchema.optional().describe("Output configuration that replaces the root output for this target.")
|
|
1965
1993
|
};
|
|
1966
1994
|
var sdkConfigV1TargetSchema = zod.z.discriminatedUnion("language", [
|
|
1967
1995
|
zod.z.strictObject({
|
|
1968
|
-
language: zod.z.literal("typescript"),
|
|
1969
|
-
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(typescriptGenerationConfigSchema.shape).optional(),
|
|
1996
|
+
language: zod.z.literal("typescript").describe("Generates a TypeScript SDK."),
|
|
1997
|
+
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(typescriptGenerationConfigSchema.shape).optional().describe("Common and TypeScript-specific generation settings for this target."),
|
|
1970
1998
|
...targetOverrideShape
|
|
1971
1999
|
}),
|
|
1972
2000
|
zod.z.strictObject({
|
|
1973
|
-
language: zod.z.literal("python"),
|
|
1974
|
-
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(pythonGenerationConfigSchema.shape).optional(),
|
|
2001
|
+
language: zod.z.literal("python").describe("Generates a Python SDK."),
|
|
2002
|
+
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(pythonGenerationConfigSchema.shape).optional().describe("Common and Python-specific generation settings for this target."),
|
|
1975
2003
|
...targetOverrideShape
|
|
1976
2004
|
}),
|
|
1977
2005
|
zod.z.strictObject({
|
|
1978
|
-
language: zod.z.literal("java"),
|
|
1979
|
-
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(javaGenerationConfigSchema.shape).optional(),
|
|
2006
|
+
language: zod.z.literal("java").describe("Generates a Java SDK."),
|
|
2007
|
+
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(javaGenerationConfigSchema.shape).optional().describe("Common and Java-specific generation settings for this target."),
|
|
1980
2008
|
...targetOverrideShape
|
|
1981
2009
|
}),
|
|
1982
2010
|
zod.z.strictObject({
|
|
1983
|
-
language: zod.z.literal("kotlin"),
|
|
1984
|
-
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(kotlinGenerationConfigSchema.shape).optional(),
|
|
2011
|
+
language: zod.z.literal("kotlin").describe("Generates a Kotlin SDK."),
|
|
2012
|
+
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(kotlinGenerationConfigSchema.shape).optional().describe("Common and Kotlin-specific generation settings for this target."),
|
|
1985
2013
|
...targetOverrideShape
|
|
1986
2014
|
}),
|
|
1987
2015
|
zod.z.strictObject({
|
|
1988
|
-
language: zod.z.literal("go"),
|
|
1989
|
-
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(goGenerationConfigSchema.shape).optional(),
|
|
2016
|
+
language: zod.z.literal("go").describe("Generates a Go SDK."),
|
|
2017
|
+
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(goGenerationConfigSchema.shape).optional().describe("Common and Go-specific generation settings for this target."),
|
|
1990
2018
|
...targetOverrideShape
|
|
1991
2019
|
}),
|
|
1992
2020
|
zod.z.strictObject({
|
|
1993
|
-
language: zod.z.literal("csharp"),
|
|
1994
|
-
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(csharpGenerationConfigSchema.shape).optional(),
|
|
2021
|
+
language: zod.z.literal("csharp").describe("Generates a C# SDK."),
|
|
2022
|
+
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(csharpGenerationConfigSchema.shape).optional().describe("Common and C#-specific generation settings for this target."),
|
|
1995
2023
|
...targetOverrideShape
|
|
1996
2024
|
}),
|
|
1997
2025
|
zod.z.strictObject({
|
|
1998
|
-
language: zod.z.literal("php"),
|
|
1999
|
-
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(phpGenerationConfigSchema.shape).optional(),
|
|
2026
|
+
language: zod.z.literal("php").describe("Generates a PHP SDK."),
|
|
2027
|
+
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(phpGenerationConfigSchema.shape).optional().describe("Common and PHP-specific generation settings for this target."),
|
|
2000
2028
|
...targetOverrideShape
|
|
2001
2029
|
}),
|
|
2002
2030
|
zod.z.strictObject({
|
|
2003
|
-
language: zod.z.literal("ruby"),
|
|
2004
|
-
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(rubyGenerationConfigSchema.shape).optional(),
|
|
2031
|
+
language: zod.z.literal("ruby").describe("Generates a Ruby SDK."),
|
|
2032
|
+
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(rubyGenerationConfigSchema.shape).optional().describe("Common and Ruby-specific generation settings for this target."),
|
|
2005
2033
|
...targetOverrideShape
|
|
2006
2034
|
}),
|
|
2007
2035
|
zod.z.strictObject({
|
|
2008
|
-
language: zod.z.literal("rust"),
|
|
2009
|
-
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(rustGenerationConfigSchema.shape).optional(),
|
|
2036
|
+
language: zod.z.literal("rust").describe("Generates a Rust SDK."),
|
|
2037
|
+
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(rustGenerationConfigSchema.shape).optional().describe("Common and Rust-specific generation settings for this target."),
|
|
2010
2038
|
...targetOverrideShape
|
|
2011
2039
|
}),
|
|
2012
2040
|
zod.z.strictObject({
|
|
2013
|
-
language: zod.z.literal("swift"),
|
|
2014
|
-
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(swiftGenerationConfigSchema.shape).optional(),
|
|
2041
|
+
language: zod.z.literal("swift").describe("Generates a Swift SDK."),
|
|
2042
|
+
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(swiftGenerationConfigSchema.shape).optional().describe("Common and Swift-specific generation settings for this target."),
|
|
2015
2043
|
...targetOverrideShape
|
|
2016
2044
|
}),
|
|
2017
2045
|
zod.z.strictObject({
|
|
2018
|
-
language: zod.z.literal("cli"),
|
|
2019
|
-
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(cliGenerationConfigSchema.shape).optional(),
|
|
2046
|
+
language: zod.z.literal("cli").describe("Generates a command-line interface."),
|
|
2047
|
+
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(cliGenerationConfigSchema.shape).optional().describe("Common and CLI-specific generation settings for this target."),
|
|
2020
2048
|
...targetOverrideShape
|
|
2021
2049
|
}),
|
|
2022
2050
|
zod.z.strictObject({
|
|
2023
|
-
language: zod.z.literal("mcp"),
|
|
2024
|
-
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(mcpGenerationConfigSchema.shape).optional(),
|
|
2051
|
+
language: zod.z.literal("mcp").describe("Generates an MCP server."),
|
|
2052
|
+
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(mcpGenerationConfigSchema.shape).optional().describe("Common and MCP-specific generation settings for this target."),
|
|
2025
2053
|
...targetOverrideShape
|
|
2026
2054
|
}),
|
|
2027
2055
|
zod.z.strictObject({
|
|
2028
|
-
language: zod.z.literal("terraform"),
|
|
2029
|
-
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(terraformGenerationConfigSchema.shape).optional(),
|
|
2056
|
+
language: zod.z.literal("terraform").describe("Generates a Terraform provider."),
|
|
2057
|
+
generation: sdkConfigV1GenerationConfigOverrideSchema.extend(terraformGenerationConfigSchema.shape).optional().describe("Common and Terraform-specific generation settings for this target."),
|
|
2030
2058
|
...targetOverrideShape
|
|
2031
2059
|
})
|
|
2032
2060
|
]);
|
|
@@ -2119,19 +2147,21 @@ function validateTargetPublishing(target, targetIndex, globalPackage, globalOutp
|
|
|
2119
2147
|
);
|
|
2120
2148
|
}
|
|
2121
2149
|
var sdkConfigV1Schema = zod.z.strictObject({
|
|
2122
|
-
schemaVersion: zod.z.literal(SDK_CONFIG_V1_SCHEMA_VERSION),
|
|
2123
|
-
sdkName: nonEmptyStringSchema,
|
|
2124
|
-
sdkVersion: nonEmptyStringSchema.default("1.0.0"),
|
|
2125
|
-
apiVersion: nonEmptyStringSchema.optional(),
|
|
2126
|
-
source: sdkConfigV1SourceConfigSchema
|
|
2127
|
-
|
|
2128
|
-
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
|
|
2150
|
+
schemaVersion: zod.z.literal(SDK_CONFIG_V1_SCHEMA_VERSION).describe("The version of the customer-facing SDK Config schema."),
|
|
2151
|
+
sdkName: nonEmptyStringSchema.describe("The default name used for generated SDKs."),
|
|
2152
|
+
sdkVersion: nonEmptyStringSchema.default("1.0.0").describe("The default version assigned to generated SDKs."),
|
|
2153
|
+
apiVersion: nonEmptyStringSchema.optional().describe("The version of the API represented by the generated SDKs."),
|
|
2154
|
+
source: sdkConfigV1SourceConfigSchema.describe(
|
|
2155
|
+
"The API descriptions used to generate the SDKs."
|
|
2156
|
+
),
|
|
2157
|
+
api: sdkConfigV1ApiConfigSchema.prefault({}).describe("Shared API behavior for every target."),
|
|
2158
|
+
client: sdkConfigV1ClientConfigSchema.prefault({}).describe("Shared generated-client behavior for every target."),
|
|
2159
|
+
package: sdkConfigV1PackageConfigSchema.prefault({}).describe("Package metadata inherited by every target."),
|
|
2160
|
+
output: sdkConfigV1OutputConfigSchema.optional().describe("The default output delivery and publication configuration."),
|
|
2161
|
+
replay: sdkConfigV1ReplayConfigSchema.optional().describe("Generation replay behavior shared by every target."),
|
|
2162
|
+
docs: sdkConfigV1DocsConfigSchema.prefault({}).describe("Documentation settings inherited by every target."),
|
|
2163
|
+
generation: sdkConfigV1GenerationConfigSchema.prefault({}).describe("Generation settings inherited by every target."),
|
|
2164
|
+
targets: zod.z.array(sdkConfigV1TargetSchema).min(1).describe("Language targets to generate; each language may appear once.")
|
|
2135
2165
|
}).superRefine(({ output, package: globalPackage, targets }, context) => {
|
|
2136
2166
|
const configuredLanguages = /* @__PURE__ */ new Set();
|
|
2137
2167
|
targets.forEach((target, targetIndex) => {
|
|
@@ -2411,9 +2441,6 @@ function mapInvocation(generator, language, activeLanguages, index) {
|
|
|
2411
2441
|
if (generator.keywords?.length) {
|
|
2412
2442
|
generation.reservedKeywords = [...generator.keywords];
|
|
2413
2443
|
}
|
|
2414
|
-
if (generator.generateFullProject !== void 0) {
|
|
2415
|
-
generation.generateFullProject = generator.generateFullProject;
|
|
2416
|
-
}
|
|
2417
2444
|
const settings = isObject(generator.settings) ? generator.settings : void 0;
|
|
2418
2445
|
if (settings) {
|
|
2419
2446
|
const inlinePathParameters = takeBoolean(settings, ["inlinePathParameters"], state, [
|
|
@@ -2444,6 +2471,7 @@ function unsupportedResolvedFields(generator, index) {
|
|
|
2444
2471
|
"disableExamples",
|
|
2445
2472
|
generator.disableExamples === false ? void 0 : generator.disableExamples
|
|
2446
2473
|
],
|
|
2474
|
+
["generateFullProject", generator.generateFullProject],
|
|
2447
2475
|
["apiOverride", generator.apiOverride]
|
|
2448
2476
|
];
|
|
2449
2477
|
return values.flatMap(([field, value]) => {
|
|
@@ -2473,6 +2501,11 @@ function resolvedFieldGuidance(field) {
|
|
|
2473
2501
|
suggestedAction: "Preserve this orchestration setting outside SDK Config; public v1 has no idempotency-generation field."
|
|
2474
2502
|
};
|
|
2475
2503
|
}
|
|
2504
|
+
if (field === "generateFullProject") {
|
|
2505
|
+
return {
|
|
2506
|
+
suggestedAction: "Preserve this packaging setting on the generation request; it is not customer-authored SDK configuration."
|
|
2507
|
+
};
|
|
2508
|
+
}
|
|
2476
2509
|
return {
|
|
2477
2510
|
suggestedAction: "Review this Fern setting and preserve it outside SDK Config, or set an equivalent SDK Config field manually if one is introduced."
|
|
2478
2511
|
};
|
|
@@ -2563,8 +2596,6 @@ function mapCommonConfig(language, config, state, client, generation, packageCon
|
|
|
2563
2596
|
const streams = mapTypescriptStreams(config, state, basePath);
|
|
2564
2597
|
if (streams) generation.streams = streams;
|
|
2565
2598
|
}
|
|
2566
|
-
const generateFullProject = takeBoolean(config, ["generateFullProject"], state, basePath);
|
|
2567
|
-
if (generateFullProject !== void 0) generation.generateFullProject = generateFullProject;
|
|
2568
2599
|
const inlineTypes = takeBoolean(config, ["enableInlineTypes"], state, basePath);
|
|
2569
2600
|
const omitUndefined = takeBoolean(config, ["omitUndefined"], state, basePath);
|
|
2570
2601
|
const forwardEnums = takeBoolean(config, ["enableForwardCompatibleEnums"], state, basePath);
|
|
@@ -3100,71 +3131,90 @@ function takeToolsets(value, aliases, state, basePath) {
|
|
|
3100
3131
|
return Object.fromEntries(entries.filter((entry) => entry !== void 0));
|
|
3101
3132
|
}
|
|
3102
3133
|
var unsupportedFieldSchema = zod.z.strictObject({
|
|
3103
|
-
source: zod.z.enum(["fern", "postman", "sdk-config-ir"]),
|
|
3104
|
-
path: zod.z.array(zod.z.union([nonEmptyStringSchema, zod.z.number().int().nonnegative()])).min(1),
|
|
3105
|
-
code: nonEmptyStringSchema.optional(),
|
|
3106
|
-
reason: nonEmptyStringSchema
|
|
3107
|
-
|
|
3108
|
-
|
|
3109
|
-
|
|
3110
|
-
|
|
3134
|
+
source: zod.z.enum(["fern", "postman", "sdk-config-ir"]).describe("The configuration surface containing the unsupported field."),
|
|
3135
|
+
path: zod.z.array(zod.z.union([nonEmptyStringSchema, zod.z.number().int().nonnegative()])).min(1).describe("The property path to the unsupported field in its source configuration."),
|
|
3136
|
+
code: nonEmptyStringSchema.optional().describe("A stable diagnostic code for the unsupported field."),
|
|
3137
|
+
reason: nonEmptyStringSchema.describe(
|
|
3138
|
+
"Why the field could not be represented in normalized configuration."
|
|
3139
|
+
),
|
|
3140
|
+
severity: zod.z.enum(["error", "warning", "info"]).describe("The diagnostic severity."),
|
|
3141
|
+
risk: zod.z.enum(["high", "medium", "low"]).describe("The migration risk of omitting this field."),
|
|
3142
|
+
owner: nonEmptyStringSchema.describe("The component or team responsible for resolving the gap."),
|
|
3143
|
+
suggestedAction: nonEmptyStringSchema.describe(
|
|
3144
|
+
"Recommended action for preserving the intended behavior."
|
|
3145
|
+
)
|
|
3111
3146
|
});
|
|
3112
3147
|
var postmanLegacyInputSchema = zod.z.strictObject({
|
|
3113
|
-
kind: zod.z.literal("postman-build-parameters"),
|
|
3114
|
-
value: jsonObjectSchema
|
|
3148
|
+
kind: zod.z.literal("postman-build-parameters").describe("Identifies legacy Postman build parameters."),
|
|
3149
|
+
value: jsonObjectSchema.describe("A debugging copy of the original Postman build parameters.")
|
|
3115
3150
|
});
|
|
3116
3151
|
var fernLegacyInputSchema = zod.z.strictObject({
|
|
3117
|
-
kind: zod.z.literal("fern-generator-invocation"),
|
|
3118
|
-
value: jsonObjectSchema
|
|
3152
|
+
kind: zod.z.literal("fern-generator-invocation").describe("Identifies a legacy Fern generator invocation."),
|
|
3153
|
+
value: jsonObjectSchema.describe("A debugging copy of the original Fern generator invocation.")
|
|
3119
3154
|
});
|
|
3120
3155
|
var legacyInputSchema = zod.z.discriminatedUnion("kind", [
|
|
3121
3156
|
postmanLegacyInputSchema,
|
|
3122
3157
|
fernLegacyInputSchema
|
|
3123
3158
|
]);
|
|
3124
3159
|
var compatibilityConfigSchema = zod.z.strictObject({
|
|
3125
|
-
outputProfile: zod.z.enum(["converged", "postman-legacy", "fern-legacy"]),
|
|
3126
|
-
legacyInput: legacyInputSchema.optional(),
|
|
3127
|
-
unsupportedFields: zod.z.array(unsupportedFieldSchema).optional()
|
|
3160
|
+
outputProfile: zod.z.enum(["converged", "postman-legacy", "fern-legacy"]).describe("The output-default profile retained while legacy producers converge."),
|
|
3161
|
+
legacyInput: legacyInputSchema.optional().describe("Original producer input retained only for migration debugging."),
|
|
3162
|
+
unsupportedFields: zod.z.array(unsupportedFieldSchema).optional().describe("Legacy fields that could not be represented in normalized configuration.")
|
|
3128
3163
|
});
|
|
3129
3164
|
var generationAssetSchema = zod.z.discriminatedUnion("type", [
|
|
3130
|
-
zod.z.strictObject({
|
|
3131
|
-
|
|
3132
|
-
|
|
3165
|
+
zod.z.strictObject({
|
|
3166
|
+
type: zod.z.literal("path").describe("Loads the generation asset from a relative path."),
|
|
3167
|
+
location: relativePathSchema.describe("The relative path to the generation asset.")
|
|
3168
|
+
}),
|
|
3169
|
+
zod.z.strictObject({
|
|
3170
|
+
type: zod.z.literal("url").describe("Loads the generation asset from a URL."),
|
|
3171
|
+
location: nonEmptyStringSchema.describe("The URL of the generation asset.")
|
|
3172
|
+
}),
|
|
3173
|
+
zod.z.strictObject({
|
|
3174
|
+
type: zod.z.literal("artifact").describe("Loads the generation asset from stored build output."),
|
|
3175
|
+
location: nonEmptyStringSchema.describe("The artifact identifier or location.")
|
|
3176
|
+
})
|
|
3133
3177
|
]);
|
|
3134
|
-
var
|
|
3135
|
-
name: nonEmptyStringSchema,
|
|
3136
|
-
version: nonEmptyStringSchema,
|
|
3137
|
-
groupId: nonEmptyStringSchema.optional()
|
|
3178
|
+
var hookDependencySchema = zod.z.strictObject({
|
|
3179
|
+
name: nonEmptyStringSchema.describe("The hook dependency name."),
|
|
3180
|
+
version: nonEmptyStringSchema.describe("The hook dependency version requirement."),
|
|
3181
|
+
groupId: nonEmptyStringSchema.optional().describe("The Maven group identifier for the dependency.")
|
|
3138
3182
|
});
|
|
3139
|
-
var
|
|
3140
|
-
enabled: zod.z.boolean(),
|
|
3141
|
-
source: generationAssetSchema.optional(),
|
|
3142
|
-
dependencies: zod.z.array(
|
|
3183
|
+
var hooksConfigSchema = zod.z.strictObject({
|
|
3184
|
+
enabled: zod.z.boolean().describe("Whether custom request and response hooks are generated."),
|
|
3185
|
+
source: generationAssetSchema.optional().describe("The source containing custom hook implementations."),
|
|
3186
|
+
dependencies: zod.z.array(hookDependencySchema).optional().describe("Dependencies required by custom hooks.")
|
|
3143
3187
|
});
|
|
3144
3188
|
var customCodeConfigSchema2 = zod.z.strictObject({
|
|
3145
|
-
enabled: zod.z.boolean(),
|
|
3146
|
-
source: generationAssetSchema.optional(),
|
|
3147
|
-
conflictStrategy: zod.z.enum(["mark", "ours", "theirs"]).optional(),
|
|
3148
|
-
trackChanges: zod.z.boolean().optional(),
|
|
3149
|
-
previousBuildId: zod.z.number().int().positive().optional(),
|
|
3150
|
-
protectedFiles: zod.z.array(nonEmptyStringSchema).optional()
|
|
3189
|
+
enabled: zod.z.boolean().describe("Whether customer-authored code is merged into generated output."),
|
|
3190
|
+
source: generationAssetSchema.optional().describe("The source containing customer-authored code."),
|
|
3191
|
+
conflictStrategy: zod.z.enum(["mark", "ours", "theirs"]).optional().describe("How merge conflicts between generated and custom code are handled."),
|
|
3192
|
+
trackChanges: zod.z.boolean().optional().describe("Whether custom-code changes are tracked between builds."),
|
|
3193
|
+
previousBuildId: zod.z.number().int().positive().optional().describe("The previous build used as the merge baseline."),
|
|
3194
|
+
protectedFiles: zod.z.array(nonEmptyStringSchema).optional().describe("Generated file paths that custom-code merging must not overwrite.")
|
|
3151
3195
|
});
|
|
3152
|
-
var
|
|
3153
|
-
path: relativePathSchema,
|
|
3154
|
-
outputName: nonEmptyStringSchema.optional()
|
|
3196
|
+
var workflowConfigSchema = zod.z.strictObject({
|
|
3197
|
+
path: relativePathSchema.describe("The relative path to the workflow definition."),
|
|
3198
|
+
outputName: nonEmptyStringSchema.optional().describe("The file name used for the generated workflow.")
|
|
3155
3199
|
});
|
|
3156
3200
|
var analyticsHeaderSchema2 = zod.z.union([
|
|
3157
|
-
zod.z.strictObject({
|
|
3158
|
-
|
|
3201
|
+
zod.z.strictObject({
|
|
3202
|
+
name: nonEmptyStringSchema.describe("The exported telemetry header name."),
|
|
3203
|
+
value: zod.z.string().describe("The literal telemetry header value.")
|
|
3204
|
+
}),
|
|
3205
|
+
zod.z.strictObject({
|
|
3206
|
+
name: nonEmptyStringSchema.describe("The exported telemetry header name."),
|
|
3207
|
+
valueRef: nonEmptyStringSchema.describe("A reference to the telemetry header value.")
|
|
3208
|
+
})
|
|
3159
3209
|
]);
|
|
3160
3210
|
var analyticsConfigSchema2 = zod.z.strictObject({
|
|
3161
|
-
enabled: zod.z.boolean(),
|
|
3162
|
-
endpoint: nonEmptyStringSchema.optional(),
|
|
3163
|
-
exporter: zod.z.enum(["otlp-http", "console"]).optional(),
|
|
3164
|
-
headers: zod.z.array(analyticsHeaderSchema2).optional(),
|
|
3165
|
-
batchSize: zod.z.number().int().positive().optional(),
|
|
3166
|
-
scheduledDelayMs: zod.z.number().nonnegative().optional(),
|
|
3167
|
-
exportTimeoutMs: zod.z.number().nonnegative().optional()
|
|
3211
|
+
enabled: zod.z.boolean().describe("Whether generated clients export usage telemetry."),
|
|
3212
|
+
endpoint: nonEmptyStringSchema.optional().describe("The telemetry export endpoint."),
|
|
3213
|
+
exporter: zod.z.enum(["otlp-http", "console"]).optional().describe("The telemetry exporter implementation."),
|
|
3214
|
+
headers: zod.z.array(analyticsHeaderSchema2).optional().describe("Headers sent by the telemetry exporter."),
|
|
3215
|
+
batchSize: zod.z.number().int().positive().optional().describe("The maximum spans in each export batch."),
|
|
3216
|
+
scheduledDelayMs: zod.z.number().nonnegative().optional().describe("The delay between scheduled exports, in milliseconds."),
|
|
3217
|
+
exportTimeoutMs: zod.z.number().nonnegative().optional().describe("The maximum time allowed for an export, in milliseconds.")
|
|
3168
3218
|
}).superRefine(({ enabled, endpoint }, context) => {
|
|
3169
3219
|
if (enabled && endpoint === void 0) {
|
|
3170
3220
|
context.addIssue({
|
|
@@ -3175,91 +3225,93 @@ var analyticsConfigSchema2 = zod.z.strictObject({
|
|
|
3175
3225
|
}
|
|
3176
3226
|
});
|
|
3177
3227
|
var wireTestsSchema2 = zod.z.strictObject({
|
|
3178
|
-
enabled: zod.z.boolean(),
|
|
3179
|
-
exclusions: zod.z.array(nonEmptyStringSchema).optional(),
|
|
3180
|
-
fallbackToGeneratedErrorExamples: zod.z.boolean().optional(),
|
|
3181
|
-
fixtureSource: zod.z.enum(["synthetic", "recorded", "auto"]).optional()
|
|
3228
|
+
enabled: zod.z.boolean().describe("Whether wire-level request and response tests are generated."),
|
|
3229
|
+
exclusions: zod.z.array(nonEmptyStringSchema).optional().describe("Operations excluded from wire tests."),
|
|
3230
|
+
fallbackToGeneratedErrorExamples: zod.z.boolean().optional().describe("Whether missing error fixtures are synthesized from generated examples."),
|
|
3231
|
+
fixtureSource: zod.z.enum(["synthetic", "recorded", "auto"]).optional().describe("Where wire-test fixtures are obtained.")
|
|
3182
3232
|
});
|
|
3183
3233
|
var unitTestsSchema2 = zod.z.strictObject({
|
|
3184
|
-
enabled: zod.z.boolean(),
|
|
3185
|
-
mode: zod.z.enum(["core-runtime", "schema-driven", "both"]).optional(),
|
|
3186
|
-
exclusions: zod.z.array(nonEmptyStringSchema).optional()
|
|
3234
|
+
enabled: zod.z.boolean().describe("Whether SDK unit tests are generated."),
|
|
3235
|
+
mode: zod.z.enum(["core-runtime", "schema-driven", "both"]).optional().describe("The unit-test generation strategy."),
|
|
3236
|
+
exclusions: zod.z.array(nonEmptyStringSchema).optional().describe("Operations excluded from unit tests.")
|
|
3187
3237
|
});
|
|
3188
3238
|
var fernDefinitionMetadataSchema = zod.z.strictObject({
|
|
3189
|
-
definitionS3DownloadUrl: nonEmptyStringSchema
|
|
3190
|
-
|
|
3191
|
-
|
|
3239
|
+
definitionS3DownloadUrl: nonEmptyStringSchema.describe(
|
|
3240
|
+
"The download URL for the materialized Fern definition archive."
|
|
3241
|
+
),
|
|
3242
|
+
outputPath: nonEmptyStringSchema.optional().describe("The destination path for Fern definition support files."),
|
|
3243
|
+
cliVersion: nonEmptyStringSchema.optional().describe("The Fern CLI version associated with the definition.")
|
|
3192
3244
|
});
|
|
3193
3245
|
var streamsSchema2 = zod.z.strictObject({
|
|
3194
|
-
enabled: zod.z.boolean(),
|
|
3195
|
-
responseType: zod.z.enum(["wrapper", "native", "web"]).optional(),
|
|
3196
|
-
fileResponseType: zod.z.enum(["stream", "binary-response"]).optional(),
|
|
3197
|
-
defaultChunkSizeBytes: zod.z.number().int().positive().optional()
|
|
3246
|
+
enabled: zod.z.boolean().describe("Whether generated clients expose streaming response APIs."),
|
|
3247
|
+
responseType: zod.z.enum(["wrapper", "native", "web"]).optional().describe("The streaming response abstraction exposed by generated clients."),
|
|
3248
|
+
fileResponseType: zod.z.enum(["stream", "binary-response"]).optional().describe("The response type used for file downloads."),
|
|
3249
|
+
defaultChunkSizeBytes: zod.z.number().int().positive().optional().describe("The default number of bytes yielded by streaming iterators.")
|
|
3198
3250
|
});
|
|
3199
3251
|
var layoutConfigSchema2 = zod.z.strictObject({
|
|
3200
|
-
outputDirectory: zod.z.enum(["project-root", "source-root"]).optional(),
|
|
3201
|
-
packagePath: nonEmptyStringSchema.optional()
|
|
3252
|
+
outputDirectory: zod.z.enum(["project-root", "source-root"]).optional().describe("Whether generated source is rooted at the project or its source directory."),
|
|
3253
|
+
packagePath: nonEmptyStringSchema.optional().describe("The package-relative path for generated source files.")
|
|
3202
3254
|
});
|
|
3203
3255
|
var serializationConfigSchema2 = zod.z.strictObject({
|
|
3204
|
-
enumRepresentation: zod.z.enum(["enum", "union", "literal", "forward-compatible-enum", "language-default"]).optional(),
|
|
3205
|
-
additionalProperties: zod.z.enum(["allow", "forbid", "ignore", "language-default"]).optional(),
|
|
3206
|
-
inlineTypes: zod.z.boolean().optional(),
|
|
3207
|
-
omitUndefined: zod.z.boolean().optional()
|
|
3256
|
+
enumRepresentation: zod.z.enum(["enum", "union", "literal", "forward-compatible-enum", "language-default"]).optional().describe("How schema enums are represented in generated code."),
|
|
3257
|
+
additionalProperties: zod.z.enum(["allow", "forbid", "ignore", "language-default"]).optional().describe("How undeclared object properties are handled."),
|
|
3258
|
+
inlineTypes: zod.z.boolean().optional().describe("Whether inline schemas remain nested under their parent types."),
|
|
3259
|
+
omitUndefined: zod.z.boolean().optional().describe("Whether undefined properties are omitted during serialization.")
|
|
3208
3260
|
});
|
|
3209
3261
|
var languageGenerationConfigSchema = zod.z.strictObject({
|
|
3210
|
-
typescript: typescriptGenerationConfigSchema.optional(),
|
|
3211
|
-
python: pythonGenerationConfigSchema.optional(),
|
|
3212
|
-
java: javaGenerationConfigSchema.optional(),
|
|
3213
|
-
kotlin: kotlinGenerationConfigSchema.optional(),
|
|
3214
|
-
go: goGenerationConfigSchema.optional(),
|
|
3215
|
-
csharp: csharpGenerationConfigSchema.optional(),
|
|
3216
|
-
php: phpGenerationConfigSchema.optional(),
|
|
3217
|
-
ruby: rubyGenerationConfigSchema.optional(),
|
|
3218
|
-
rust: rustGenerationConfigSchema.optional(),
|
|
3219
|
-
cli: cliGenerationConfigSchema.optional(),
|
|
3220
|
-
mcp: mcpGenerationConfigSchema.optional(),
|
|
3221
|
-
swift: swiftGenerationConfigSchema.optional(),
|
|
3222
|
-
terraform: terraformGenerationConfigSchema.optional()
|
|
3262
|
+
typescript: typescriptGenerationConfigSchema.optional().describe("TypeScript-specific generation settings."),
|
|
3263
|
+
python: pythonGenerationConfigSchema.optional().describe("Python-specific generation settings."),
|
|
3264
|
+
java: javaGenerationConfigSchema.optional().describe("Java-specific generation settings."),
|
|
3265
|
+
kotlin: kotlinGenerationConfigSchema.optional().describe("Kotlin-specific generation settings."),
|
|
3266
|
+
go: goGenerationConfigSchema.optional().describe("Go-specific generation settings."),
|
|
3267
|
+
csharp: csharpGenerationConfigSchema.optional().describe("C#-specific generation settings."),
|
|
3268
|
+
php: phpGenerationConfigSchema.optional().describe("PHP-specific generation settings."),
|
|
3269
|
+
ruby: rubyGenerationConfigSchema.optional().describe("Ruby-specific generation settings."),
|
|
3270
|
+
rust: rustGenerationConfigSchema.optional().describe("Rust-specific generation settings."),
|
|
3271
|
+
cli: cliGenerationConfigSchema.optional().describe("CLI-specific generation settings."),
|
|
3272
|
+
mcp: mcpGenerationConfigSchema.optional().describe("MCP-specific generation settings."),
|
|
3273
|
+
swift: swiftGenerationConfigSchema.optional().describe("Swift-specific generation settings."),
|
|
3274
|
+
terraform: terraformGenerationConfigSchema.optional().describe("Terraform-specific generation settings.")
|
|
3223
3275
|
});
|
|
3224
3276
|
var generationConfigSchema = zod.z.strictObject({
|
|
3225
|
-
includeWatermark: zod.z.boolean().default(false),
|
|
3277
|
+
includeWatermark: zod.z.boolean().default(false).describe("Whether generated files include a generator watermark."),
|
|
3226
3278
|
/** Emits an AI service into the generated SDK. Python, Java and TypeScript honour it. */
|
|
3227
|
-
ai: zod.z.boolean().default(false),
|
|
3228
|
-
includeOptionalSnippetParameters: zod.z.boolean().optional(),
|
|
3229
|
-
buildAllModels: zod.z.boolean().default(false),
|
|
3230
|
-
inferServiceNames: zod.z.boolean().default(false),
|
|
3231
|
-
includeDeprecatedOperations: zod.z.boolean().default(true),
|
|
3232
|
-
multipleResponses: zod.z.boolean().default(false),
|
|
3279
|
+
ai: zod.z.boolean().default(false).describe("Whether the SDK includes generated AI service helpers."),
|
|
3280
|
+
includeOptionalSnippetParameters: zod.z.boolean().optional().describe("Whether usage snippets include optional request parameters."),
|
|
3281
|
+
buildAllModels: zod.z.boolean().default(false).describe("Whether models not referenced by operations are also generated."),
|
|
3282
|
+
inferServiceNames: zod.z.boolean().default(false).describe("Whether service names are inferred from API structure."),
|
|
3283
|
+
includeDeprecatedOperations: zod.z.boolean().default(true).describe("Whether deprecated API operations are generated."),
|
|
3284
|
+
multipleResponses: zod.z.boolean().default(false).describe("Whether operations model multiple successful response types."),
|
|
3233
3285
|
/** Generate the entire SDK project, including package manifests and publishable artifacts. */
|
|
3234
|
-
generateFullProject: zod.z.boolean().default(false),
|
|
3235
|
-
devContainer: zod.z.boolean().default(false),
|
|
3236
|
-
allowMockClient: zod.z.boolean().default(false),
|
|
3237
|
-
ignoreFiles: zod.z.array(nonEmptyStringSchema).optional(),
|
|
3286
|
+
generateFullProject: zod.z.boolean().default(false).describe("Whether generation emits a complete publishable project."),
|
|
3287
|
+
devContainer: zod.z.boolean().default(false).describe("Whether development-container configuration is generated."),
|
|
3288
|
+
allowMockClient: zod.z.boolean().default(false).describe("Whether a mock API client is included in the generated SDK."),
|
|
3289
|
+
ignoreFiles: zod.z.array(nonEmptyStringSchema).optional().describe("Generated paths excluded from the final output."),
|
|
3238
3290
|
/**
|
|
3239
3291
|
* Raw .fernignore file contents supplied to external publishers that need Fern ignore semantics.
|
|
3240
3292
|
* This is separate from generation.ignoreFiles because raw contents preserve comments, ordering,
|
|
3241
3293
|
* blank lines, and negation rules.
|
|
3242
3294
|
*/
|
|
3243
|
-
fernignoreContents: zod.z.string().optional(),
|
|
3295
|
+
fernignoreContents: zod.z.string().optional().describe("The raw .fernignore contents retained for external publishers."),
|
|
3244
3296
|
/**
|
|
3245
3297
|
* Optional Fern definition metadata for publisher paths that need to write definition or
|
|
3246
3298
|
* mock-server support files. This is not required for core GitHub artifact publishing.
|
|
3247
3299
|
*/
|
|
3248
|
-
fernDefinitionMetadata: fernDefinitionMetadataSchema.optional(),
|
|
3249
|
-
reservedKeywords: zod.z.array(nonEmptyStringSchema).optional(),
|
|
3250
|
-
hooks:
|
|
3251
|
-
customCode: customCodeConfigSchema2.optional(),
|
|
3252
|
-
workflows: zod.z.array(
|
|
3253
|
-
customQueryPaths: zod.z.array(relativePathSchema).optional(),
|
|
3254
|
-
analytics: analyticsConfigSchema2.optional(),
|
|
3255
|
-
wireTests: wireTestsSchema2.optional(),
|
|
3256
|
-
unitTests: unitTestsSchema2.optional(),
|
|
3257
|
-
webSockets: zod.z.boolean().optional(),
|
|
3258
|
-
streams: streamsSchema2.optional(),
|
|
3259
|
-
naming: namingConfigSchema.optional(),
|
|
3260
|
-
layout: layoutConfigSchema2.optional(),
|
|
3261
|
-
serialization: serializationConfigSchema2.optional(),
|
|
3262
|
-
language: languageGenerationConfigSchema.optional()
|
|
3300
|
+
fernDefinitionMetadata: fernDefinitionMetadataSchema.optional().describe("Materialized Fern definition metadata used by external publishers."),
|
|
3301
|
+
reservedKeywords: zod.z.array(nonEmptyStringSchema).optional().describe("Additional identifiers treated as reserved words."),
|
|
3302
|
+
hooks: hooksConfigSchema.optional().describe("Custom SDK request and response hook configuration."),
|
|
3303
|
+
customCode: customCodeConfigSchema2.optional().describe("Customer-authored code merge configuration."),
|
|
3304
|
+
workflows: zod.z.array(workflowConfigSchema).optional().describe("Workflow definitions included in generated output."),
|
|
3305
|
+
customQueryPaths: zod.z.array(relativePathSchema).optional().describe("Relative paths to custom query definitions."),
|
|
3306
|
+
analytics: analyticsConfigSchema2.optional().describe("Generated client telemetry configuration."),
|
|
3307
|
+
wireTests: wireTestsSchema2.optional().describe("Wire-level request and response test generation."),
|
|
3308
|
+
unitTests: unitTestsSchema2.optional().describe("SDK unit-test generation."),
|
|
3309
|
+
webSockets: zod.z.boolean().optional().describe("Whether WebSocket clients are generated for supported channels."),
|
|
3310
|
+
streams: streamsSchema2.optional().describe("Streaming response generation behavior."),
|
|
3311
|
+
naming: namingConfigSchema.optional().describe("Names and casing used by generated code."),
|
|
3312
|
+
layout: layoutConfigSchema2.optional().describe("Generated project and source layout."),
|
|
3313
|
+
serialization: serializationConfigSchema2.optional().describe("Generated model serialization behavior."),
|
|
3314
|
+
language: languageGenerationConfigSchema.optional().describe("Settings specific to the selected target language.")
|
|
3263
3315
|
});
|
|
3264
3316
|
var publishRegistrySchema = zod.z.enum([
|
|
3265
3317
|
"npm",
|
|
@@ -3277,154 +3329,160 @@ var credentialResolutionSchema = zod.z.enum([
|
|
|
3277
3329
|
"resolved-by-fiddle"
|
|
3278
3330
|
]);
|
|
3279
3331
|
var registryCredentialsSchema = zod.z.strictObject({
|
|
3280
|
-
username: nonEmptyStringSchema.optional(),
|
|
3281
|
-
password: nonEmptyStringSchema.optional(),
|
|
3282
|
-
token: nonEmptyStringSchema.optional(),
|
|
3283
|
-
apiKey: nonEmptyStringSchema.optional()
|
|
3332
|
+
username: nonEmptyStringSchema.optional().describe("The resolved credential username."),
|
|
3333
|
+
password: nonEmptyStringSchema.optional().describe("The resolved credential password."),
|
|
3334
|
+
token: nonEmptyStringSchema.optional().describe("The resolved credential token."),
|
|
3335
|
+
apiKey: nonEmptyStringSchema.optional().describe("The resolved credential API key.")
|
|
3284
3336
|
});
|
|
3285
3337
|
var commonPublishShape2 = {
|
|
3286
|
-
url: nonEmptyStringSchema.optional(),
|
|
3338
|
+
url: nonEmptyStringSchema.optional().describe("A custom package registry URL."),
|
|
3287
3339
|
/** Reference to registry publishing credentials. */
|
|
3288
|
-
credentialsRef: nonEmptyStringSchema.optional(),
|
|
3340
|
+
credentialsRef: nonEmptyStringSchema.optional().describe("A reference to registry publishing credentials."),
|
|
3289
3341
|
/** Raw registry credentials. These values can be sensitive and must be handled as secrets. */
|
|
3290
|
-
credentials: registryCredentialsSchema.optional(),
|
|
3342
|
+
credentials: registryCredentialsSchema.optional().describe("Resolved registry publishing credentials."),
|
|
3291
3343
|
/**
|
|
3292
3344
|
* Registry-specific package version override. If omitted, the external publisher/orchestrator may
|
|
3293
3345
|
* fall back to target.sdkVersion.
|
|
3294
3346
|
*/
|
|
3295
|
-
version: nonEmptyStringSchema.optional(),
|
|
3296
|
-
releaseBranch: nonEmptyStringSchema.optional(),
|
|
3297
|
-
tolerateRepublish: zod.z.boolean().optional(),
|
|
3347
|
+
version: nonEmptyStringSchema.optional().describe("A registry-specific package version override."),
|
|
3348
|
+
releaseBranch: nonEmptyStringSchema.optional().describe("The branch used by generated package release workflows."),
|
|
3349
|
+
tolerateRepublish: zod.z.boolean().optional().describe("Whether publishing succeeds when this package version already exists."),
|
|
3298
3350
|
/** Generate registry publishing workflow files when publishing through GitHub delivery. */
|
|
3299
|
-
shouldGeneratePublishWorkflow: zod.z.boolean().optional()
|
|
3351
|
+
shouldGeneratePublishWorkflow: zod.z.boolean().optional().describe("Whether GitHub delivery includes a registry publishing workflow.")
|
|
3300
3352
|
};
|
|
3301
3353
|
var trustedPublishingShape = {
|
|
3302
3354
|
/** Use registry trusted publishing / OIDC instead of a static token secret. */
|
|
3303
|
-
trustedPublishing: zod.z.boolean().optional()
|
|
3355
|
+
trustedPublishing: zod.z.boolean().optional().describe("Whether registry publication uses trusted publishing or OIDC.")
|
|
3304
3356
|
};
|
|
3305
3357
|
var mavenCoordinateSchema = nonEmptyStringSchema.regex(
|
|
3306
3358
|
/^[A-Za-z0-9_.-]+:[A-Za-z0-9_.-]+$/,
|
|
3307
3359
|
"Maven coordinate must be in groupId:artifactId form"
|
|
3308
3360
|
);
|
|
3309
3361
|
var mavenSignatureEnvironmentSchema = zod.z.strictObject({
|
|
3310
|
-
keyIdEnvironmentVariable: nonEmptyStringSchema.optional(),
|
|
3311
|
-
passwordEnvironmentVariable: nonEmptyStringSchema.optional(),
|
|
3312
|
-
secretKeyEnvironmentVariable: nonEmptyStringSchema.optional()
|
|
3362
|
+
keyIdEnvironmentVariable: nonEmptyStringSchema.optional().describe("The environment variable containing the signing key ID."),
|
|
3363
|
+
passwordEnvironmentVariable: nonEmptyStringSchema.optional().describe("The environment variable containing the signing key password."),
|
|
3364
|
+
secretKeyEnvironmentVariable: nonEmptyStringSchema.optional().describe("The environment variable containing the armored secret key.")
|
|
3313
3365
|
});
|
|
3314
3366
|
var mavenSignatureSchema2 = zod.z.strictObject({
|
|
3315
|
-
keyId: nonEmptyStringSchema,
|
|
3316
|
-
password: nonEmptyStringSchema,
|
|
3317
|
-
secretKey: nonEmptyStringSchema
|
|
3367
|
+
keyId: nonEmptyStringSchema.describe("The resolved signing key identifier."),
|
|
3368
|
+
password: nonEmptyStringSchema.describe("The resolved signing key password."),
|
|
3369
|
+
secretKey: nonEmptyStringSchema.describe("The resolved armored secret key.")
|
|
3318
3370
|
});
|
|
3319
3371
|
var publishConfigSchema = zod.z.discriminatedUnion("registry", [
|
|
3320
3372
|
zod.z.strictObject({
|
|
3321
|
-
registry: zod.z.literal("npm"),
|
|
3373
|
+
registry: zod.z.literal("npm").describe("Publishes the package to an npm-compatible registry."),
|
|
3322
3374
|
/** Environment variable name containing the npm registry token. */
|
|
3323
|
-
tokenEnvironmentVariable: nonEmptyStringSchema.optional(),
|
|
3375
|
+
tokenEnvironmentVariable: nonEmptyStringSchema.optional().describe("The environment variable containing the npm registry token."),
|
|
3324
3376
|
/** Write npm package metadata as private when the publisher creates/updates package.json. */
|
|
3325
|
-
isPackagePrivate: zod.z.boolean().optional(),
|
|
3377
|
+
isPackagePrivate: zod.z.boolean().optional().describe("Whether generated npm package metadata marks the package as private."),
|
|
3326
3378
|
/** Also publish the TypeScript package to JSR from the npm publishing path. */
|
|
3327
|
-
publishToJsr: zod.z.boolean().optional(),
|
|
3379
|
+
publishToJsr: zod.z.boolean().optional().describe("Whether the npm publishing flow also publishes the package to JSR."),
|
|
3328
3380
|
...trustedPublishingShape,
|
|
3329
3381
|
...commonPublishShape2
|
|
3330
3382
|
}),
|
|
3331
3383
|
zod.z.strictObject({
|
|
3332
|
-
registry: zod.z.literal("pypi"),
|
|
3333
|
-
usernameEnvironmentVariable: nonEmptyStringSchema.optional(),
|
|
3334
|
-
passwordEnvironmentVariable: nonEmptyStringSchema.optional(),
|
|
3384
|
+
registry: zod.z.literal("pypi").describe("Publishes the package to a PyPI-compatible registry."),
|
|
3385
|
+
usernameEnvironmentVariable: nonEmptyStringSchema.optional().describe("The environment variable containing the PyPI username."),
|
|
3386
|
+
passwordEnvironmentVariable: nonEmptyStringSchema.optional().describe("The environment variable containing the PyPI password or token."),
|
|
3335
3387
|
...trustedPublishingShape,
|
|
3336
3388
|
...commonPublishShape2
|
|
3337
3389
|
}),
|
|
3338
3390
|
zod.z.strictObject({
|
|
3339
|
-
registry: zod.z.literal("nuget"),
|
|
3340
|
-
apiKeyEnvironmentVariable: nonEmptyStringSchema.optional(),
|
|
3391
|
+
registry: zod.z.literal("nuget").describe("Publishes the package to a NuGet-compatible registry."),
|
|
3392
|
+
apiKeyEnvironmentVariable: nonEmptyStringSchema.optional().describe("The environment variable containing the NuGet API key."),
|
|
3341
3393
|
...trustedPublishingShape,
|
|
3342
3394
|
...commonPublishShape2
|
|
3343
3395
|
}),
|
|
3344
3396
|
zod.z.strictObject({
|
|
3345
|
-
registry: zod.z.literal("rubygems"),
|
|
3346
|
-
apiKeyEnvironmentVariable: nonEmptyStringSchema.optional(),
|
|
3397
|
+
registry: zod.z.literal("rubygems").describe("Publishes the package to a RubyGems-compatible registry."),
|
|
3398
|
+
apiKeyEnvironmentVariable: nonEmptyStringSchema.optional().describe("The environment variable containing the RubyGems API key."),
|
|
3399
|
+
...commonPublishShape2
|
|
3400
|
+
}),
|
|
3401
|
+
zod.z.strictObject({
|
|
3402
|
+
registry: zod.z.literal("crates").describe("Publishes the crate to a Cargo-compatible registry."),
|
|
3403
|
+
tokenEnvironmentVariable: nonEmptyStringSchema.optional().describe("The environment variable containing the Cargo registry token."),
|
|
3404
|
+
...commonPublishShape2
|
|
3405
|
+
}),
|
|
3406
|
+
zod.z.strictObject({
|
|
3407
|
+
registry: zod.z.literal("go").describe("Publishes the SDK as a Go module."),
|
|
3347
3408
|
...commonPublishShape2
|
|
3348
3409
|
}),
|
|
3349
3410
|
zod.z.strictObject({
|
|
3350
|
-
registry: zod.z.literal("
|
|
3351
|
-
tokenEnvironmentVariable: nonEmptyStringSchema.optional(),
|
|
3411
|
+
registry: zod.z.literal("composer").describe("Publishes the package to a Composer-compatible registry."),
|
|
3352
3412
|
...commonPublishShape2
|
|
3353
3413
|
}),
|
|
3354
|
-
zod.z.strictObject({ registry: zod.z.literal("go"), ...commonPublishShape2 }),
|
|
3355
|
-
zod.z.strictObject({ registry: zod.z.literal("composer"), ...commonPublishShape2 }),
|
|
3356
3414
|
zod.z.strictObject({
|
|
3357
|
-
registry: zod.z.literal("maven"),
|
|
3415
|
+
registry: zod.z.literal("maven").describe("Publishes the package to a Maven-compatible repository."),
|
|
3358
3416
|
/** Maven coordinate in groupId:artifactId form when consumers need the combined value. */
|
|
3359
|
-
coordinate: mavenCoordinateSchema.optional(),
|
|
3360
|
-
usernameEnvironmentVariable: nonEmptyStringSchema.optional(),
|
|
3361
|
-
passwordEnvironmentVariable: nonEmptyStringSchema.optional(),
|
|
3362
|
-
mavenUrlEnvironmentVariable: nonEmptyStringSchema.optional(),
|
|
3363
|
-
signatureEnvironmentVariables: mavenSignatureEnvironmentSchema.optional(),
|
|
3417
|
+
coordinate: mavenCoordinateSchema.optional().describe("The Maven coordinate in groupId:artifactId form."),
|
|
3418
|
+
usernameEnvironmentVariable: nonEmptyStringSchema.optional().describe("The environment variable containing the Maven username."),
|
|
3419
|
+
passwordEnvironmentVariable: nonEmptyStringSchema.optional().describe("The environment variable containing the Maven password."),
|
|
3420
|
+
mavenUrlEnvironmentVariable: nonEmptyStringSchema.optional().describe("The environment variable containing the Maven repository URL."),
|
|
3421
|
+
signatureEnvironmentVariables: mavenSignatureEnvironmentSchema.optional().describe("Environment variables containing Maven signing material."),
|
|
3364
3422
|
/** Reference to Maven signing credentials. */
|
|
3365
|
-
signingCredentialsRef: nonEmptyStringSchema.optional(),
|
|
3423
|
+
signingCredentialsRef: nonEmptyStringSchema.optional().describe("A reference to Maven signing credentials."),
|
|
3366
3424
|
/** Raw Maven signing material. These values can be sensitive and must be handled as secrets. */
|
|
3367
|
-
signature: mavenSignatureSchema2.optional(),
|
|
3425
|
+
signature: mavenSignatureSchema2.optional().describe("Resolved Maven signing material."),
|
|
3368
3426
|
...commonPublishShape2
|
|
3369
3427
|
})
|
|
3370
3428
|
]);
|
|
3371
3429
|
var reviewersSchema2 = zod.z.strictObject({
|
|
3372
|
-
teams: zod.z.array(nonEmptyStringSchema).optional(),
|
|
3373
|
-
users: zod.z.array(nonEmptyStringSchema).optional()
|
|
3430
|
+
teams: zod.z.array(nonEmptyStringSchema).optional().describe("GitHub teams requested as reviewers."),
|
|
3431
|
+
users: zod.z.array(nonEmptyStringSchema).optional().describe("GitHub users requested as reviewers.")
|
|
3374
3432
|
});
|
|
3375
3433
|
var replayControlSchema = zod.z.strictObject({
|
|
3376
|
-
enabled: zod.z.boolean()
|
|
3434
|
+
enabled: zod.z.boolean().describe("Whether regeneration reapplies customer-authored repository changes.")
|
|
3377
3435
|
});
|
|
3378
3436
|
var githubLicenseSchema = zod.z.strictObject({
|
|
3379
3437
|
/** SPDX identifier or license key for the repository license (for example, "MIT"). */
|
|
3380
|
-
type: nonEmptyStringSchema.optional(),
|
|
3438
|
+
type: nonEmptyStringSchema.optional().describe("The SPDX identifier or license key for the repository license."),
|
|
3381
3439
|
/** Path to a custom license file to be committed into the GitHub repository. */
|
|
3382
|
-
customPath: nonEmptyStringSchema.optional()
|
|
3440
|
+
customPath: nonEmptyStringSchema.optional().describe("The path to a custom license file committed to the repository.")
|
|
3383
3441
|
}).refine((value) => value.type !== void 0 || value.customPath !== void 0, {
|
|
3384
3442
|
message: "GitHub license must set type or customPath"
|
|
3385
3443
|
});
|
|
3386
3444
|
var githubOutputSchema2 = zod.z.strictObject({
|
|
3387
|
-
repository: nonEmptyStringSchema,
|
|
3388
|
-
host: nonEmptyStringSchema.optional(),
|
|
3389
|
-
branch: nonEmptyStringSchema.optional(),
|
|
3390
|
-
mode: zod.z.enum(["release", "pull-request", "push", "commit", "commit-and-release"]).optional(),
|
|
3391
|
-
reviewers: reviewersSchema2.optional(),
|
|
3445
|
+
repository: nonEmptyStringSchema.describe("The GitHub repository that receives generated files."),
|
|
3446
|
+
host: nonEmptyStringSchema.optional().describe("The GitHub host for enterprise installations."),
|
|
3447
|
+
branch: nonEmptyStringSchema.optional().describe("The target branch for generated changes."),
|
|
3448
|
+
mode: zod.z.enum(["release", "pull-request", "push", "commit", "commit-and-release"]).optional().describe("How generated changes are delivered to the repository."),
|
|
3449
|
+
reviewers: reviewersSchema2.optional().describe("Reviewers requested for generated pull requests."),
|
|
3392
3450
|
/** Reference to GitHub credentials. */
|
|
3393
|
-
credentialsRef: nonEmptyStringSchema.optional(),
|
|
3451
|
+
credentialsRef: nonEmptyStringSchema.optional().describe("A reference to GitHub credentials."),
|
|
3394
3452
|
/** Raw GitHub credentials. These values can be sensitive and must be handled as secrets. */
|
|
3395
|
-
credentials: registryCredentialsSchema.optional(),
|
|
3396
|
-
privateRepository: zod.z.boolean().optional(),
|
|
3453
|
+
credentials: registryCredentialsSchema.optional().describe("Resolved GitHub credentials."),
|
|
3454
|
+
privateRepository: zod.z.boolean().optional().describe("Whether the destination repository is private."),
|
|
3397
3455
|
/** GitHub license block scoped to repository delivery. */
|
|
3398
|
-
license: githubLicenseSchema.optional(),
|
|
3456
|
+
license: githubLicenseSchema.optional().describe("License configuration for the destination repository."),
|
|
3399
3457
|
/** GitHub replay control. If omitted, the external publisher applies its default behavior. */
|
|
3400
|
-
replay: replayControlSchema.optional(),
|
|
3458
|
+
replay: replayControlSchema.optional().describe("Replay behavior for the external GitHub publisher."),
|
|
3401
3459
|
/** Run GitHub publishing verification. Defaults to false to match current Fiddle job behavior. */
|
|
3402
|
-
verify: zod.z.boolean().default(false),
|
|
3460
|
+
verify: zod.z.boolean().default(false).describe("Whether the GitHub publisher verifies the generated result."),
|
|
3403
3461
|
/** Skip creating/updating a GitHub PR when no files changed. Defaults to false. */
|
|
3404
|
-
skipIfNoDiff: zod.z.boolean().default(false),
|
|
3462
|
+
skipIfNoDiff: zod.z.boolean().default(false).describe("Whether GitHub publication is skipped when no generated files changed."),
|
|
3405
3463
|
/** Automatically merge the GitHub publishing PR. Defaults to false. */
|
|
3406
|
-
autoMerge: zod.z.boolean().default(false)
|
|
3464
|
+
autoMerge: zod.z.boolean().default(false).describe("Whether the GitHub publisher automatically merges its pull request.")
|
|
3407
3465
|
});
|
|
3408
3466
|
var credentialResolutionShape = {
|
|
3409
3467
|
/** Where output credential references are resolved. */
|
|
3410
|
-
credentialResolution: credentialResolutionSchema.default("refs-only")
|
|
3468
|
+
credentialResolution: credentialResolutionSchema.default("refs-only").describe("Where output credential references are resolved.")
|
|
3411
3469
|
};
|
|
3412
3470
|
var filesOutputSchema2 = zod.z.strictObject({
|
|
3413
|
-
delivery: zod.z.literal("files"),
|
|
3414
|
-
path: nonEmptyStringSchema.optional(),
|
|
3415
|
-
publish: publishConfigSchema.optional(),
|
|
3471
|
+
delivery: zod.z.literal("files").describe("Writes the generated SDK to a directory."),
|
|
3472
|
+
path: nonEmptyStringSchema.optional().describe("The destination directory for generated files."),
|
|
3473
|
+
publish: publishConfigSchema.optional().describe("Optional package registry publication."),
|
|
3416
3474
|
...credentialResolutionShape
|
|
3417
3475
|
});
|
|
3418
3476
|
var zipOutputSchema2 = zod.z.strictObject({
|
|
3419
|
-
delivery: zod.z.literal("zip"),
|
|
3420
|
-
fileName: nonEmptyStringSchema.optional(),
|
|
3421
|
-
publish: publishConfigSchema.optional(),
|
|
3477
|
+
delivery: zod.z.literal("zip").describe("Packages the generated SDK as a ZIP archive."),
|
|
3478
|
+
fileName: nonEmptyStringSchema.optional().describe("The generated ZIP archive file name."),
|
|
3479
|
+
publish: publishConfigSchema.optional().describe("Optional package registry publication."),
|
|
3422
3480
|
...credentialResolutionShape
|
|
3423
3481
|
});
|
|
3424
3482
|
var githubDeliverySchema2 = zod.z.strictObject({
|
|
3425
|
-
delivery: zod.z.literal("github"),
|
|
3426
|
-
github: githubOutputSchema2,
|
|
3427
|
-
publish: publishConfigSchema.optional(),
|
|
3483
|
+
delivery: zod.z.literal("github").describe("Delivers the generated SDK to GitHub."),
|
|
3484
|
+
github: githubOutputSchema2.describe("GitHub repository delivery settings."),
|
|
3485
|
+
publish: publishConfigSchema.optional().describe("Optional package registry publication."),
|
|
3428
3486
|
...credentialResolutionShape
|
|
3429
3487
|
});
|
|
3430
3488
|
var outputConfigSchema = zod.z.discriminatedUnion(
|
|
@@ -3435,21 +3493,23 @@ var outputConfigSchema = zod.z.discriminatedUnion(
|
|
|
3435
3493
|
}
|
|
3436
3494
|
);
|
|
3437
3495
|
var replayConfigSchema = zod.z.strictObject({
|
|
3438
|
-
enabled: zod.z.boolean()
|
|
3496
|
+
enabled: zod.z.boolean().describe("Whether regeneration reapplies customer-authored repository changes.")
|
|
3439
3497
|
});
|
|
3440
3498
|
var sourceSpecConfigSchema = zod.z.strictObject({
|
|
3441
|
-
id: nonEmptyStringSchema.optional(),
|
|
3442
|
-
name: nonEmptyStringSchema.optional(),
|
|
3443
|
-
namespace: nonEmptyStringSchema.optional(),
|
|
3444
|
-
specUrl: nonEmptyStringSchema
|
|
3445
|
-
|
|
3446
|
-
|
|
3447
|
-
|
|
3448
|
-
|
|
3499
|
+
id: nonEmptyStringSchema.optional().describe("A unique identifier for this API source."),
|
|
3500
|
+
name: nonEmptyStringSchema.optional().describe("A human-readable name for this API source."),
|
|
3501
|
+
namespace: nonEmptyStringSchema.optional().describe("A namespace used to isolate this source in a multi-source SDK."),
|
|
3502
|
+
specUrl: nonEmptyStringSchema.describe(
|
|
3503
|
+
"The materialized URL from which the generator retrieves the API source."
|
|
3504
|
+
),
|
|
3505
|
+
specType: sourceSpecTypeSchema.describe("The API description format of this source."),
|
|
3506
|
+
apiImportSettings: apiImportSettingsSchema.optional().describe("Import behavior that overrides the source-level defaults for this spec."),
|
|
3507
|
+
overlays: zod.z.array(nonEmptyStringSchema).optional().describe("Materialized overlays applied to this source in order."),
|
|
3508
|
+
overrides: zod.z.array(nonEmptyStringSchema).optional().describe("Materialized source overrides applied in order.")
|
|
3449
3509
|
});
|
|
3450
3510
|
var sourceConfigSchema = zod.z.strictObject({
|
|
3451
|
-
specs: zod.z.array(sourceSpecConfigSchema).min(1, "source.specs must contain at least one source spec"),
|
|
3452
|
-
apiImportSettings: apiImportSettingsSchema.optional()
|
|
3511
|
+
specs: zod.z.array(sourceSpecConfigSchema).min(1, "source.specs must contain at least one source spec").describe("Materialized API sources in authoritative processing order."),
|
|
3512
|
+
apiImportSettings: apiImportSettingsSchema.optional().describe("Default import behavior shared by every source spec.")
|
|
3453
3513
|
}).superRefine(({ specs }, context) => {
|
|
3454
3514
|
const seenIds = /* @__PURE__ */ new Set();
|
|
3455
3515
|
specs.forEach(({ id }, index) => {
|
|
@@ -3481,25 +3541,27 @@ var targetLanguageSchema = zod.z.enum([
|
|
|
3481
3541
|
"terraform"
|
|
3482
3542
|
]);
|
|
3483
3543
|
var targetConfigSchema = zod.z.strictObject({
|
|
3484
|
-
language: targetLanguageSchema
|
|
3485
|
-
|
|
3486
|
-
|
|
3487
|
-
|
|
3544
|
+
language: targetLanguageSchema.describe(
|
|
3545
|
+
"The language or platform generated by this single-target request."
|
|
3546
|
+
),
|
|
3547
|
+
generatorVersion: exactSemverSchema.optional().describe("The exact generator version requested for this target."),
|
|
3548
|
+
sourceOrigin: zod.z.enum(["postman", "fern"]).describe("The configuration system from which this IR was normalized."),
|
|
3549
|
+
sdkName: nonEmptyStringSchema.describe("The name used for the generated SDK."),
|
|
3488
3550
|
/**
|
|
3489
3551
|
* Stable Fern/Fiddle API identity for external publishing.
|
|
3490
3552
|
* Producers must set this explicitly for GitHub or registry publishing; it is not inferred from
|
|
3491
3553
|
* target.sdkName because SDK display names and Fern API names are not equivalent.
|
|
3492
3554
|
*/
|
|
3493
|
-
apiName: nonEmptyStringSchema.optional(),
|
|
3494
|
-
organization: nonEmptyStringSchema.optional(),
|
|
3555
|
+
apiName: nonEmptyStringSchema.optional().describe("The stable API identity used for external publishing."),
|
|
3556
|
+
organization: nonEmptyStringSchema.optional().describe("Source organization metadata retained for generation."),
|
|
3495
3557
|
/**
|
|
3496
3558
|
* Stable Fern/Fiddle organization identity for external publishing.
|
|
3497
3559
|
* Producers must set this explicitly for GitHub or registry publishing; it is not inferred from
|
|
3498
3560
|
* target.organization because source organization metadata is optional and may not match Fern.
|
|
3499
3561
|
*/
|
|
3500
|
-
organizationName: nonEmptyStringSchema.optional(),
|
|
3501
|
-
sdkVersion: nonEmptyStringSchema.default("1.0.0"),
|
|
3502
|
-
apiVersion: nonEmptyStringSchema.optional()
|
|
3562
|
+
organizationName: nonEmptyStringSchema.optional().describe("The stable organization identity used for external publishing."),
|
|
3563
|
+
sdkVersion: nonEmptyStringSchema.default("1.0.0").describe("The version of the generated SDK."),
|
|
3564
|
+
apiVersion: nonEmptyStringSchema.optional().describe("The version of the API represented by the SDK.")
|
|
3503
3565
|
});
|
|
3504
3566
|
|
|
3505
3567
|
// src/sdk-config-ir/v1/sdk-config-ir-v1.ts
|
|
@@ -3561,17 +3623,21 @@ function validatePublishingIdentity2(packageConfig, registry, context) {
|
|
|
3561
3623
|
}
|
|
3562
3624
|
}
|
|
3563
3625
|
var sdkConfigIrV1Schema = zod.z.strictObject({
|
|
3564
|
-
schemaVersion: zod.z.literal(SDK_CONFIG_IR_V1_SCHEMA_VERSION),
|
|
3565
|
-
source: sourceConfigSchema,
|
|
3566
|
-
target: targetConfigSchema
|
|
3567
|
-
|
|
3568
|
-
|
|
3569
|
-
|
|
3570
|
-
|
|
3571
|
-
|
|
3572
|
-
|
|
3573
|
-
|
|
3574
|
-
|
|
3626
|
+
schemaVersion: zod.z.literal(SDK_CONFIG_IR_V1_SCHEMA_VERSION).describe("The version of the normalized SDK Config IR schema."),
|
|
3627
|
+
source: sourceConfigSchema.describe("Materialized API descriptions consumed by generation."),
|
|
3628
|
+
target: targetConfigSchema.describe(
|
|
3629
|
+
"Identity and provenance for this single generation target."
|
|
3630
|
+
),
|
|
3631
|
+
api: apiConfigSchema.describe("API behavior exposed by the generated SDK."),
|
|
3632
|
+
client: clientConfigSchema.describe("Behavior of the generated API client."),
|
|
3633
|
+
package: packageConfigSchema.describe("Package identity and metadata for the generated SDK."),
|
|
3634
|
+
output: outputConfigSchema.describe("Artifact delivery and optional package publication."),
|
|
3635
|
+
replay: replayConfigSchema.optional().describe("Generation replay behavior."),
|
|
3636
|
+
docs: docsConfigSchema.describe("Generated documentation settings."),
|
|
3637
|
+
generation: generationConfigSchema.describe(
|
|
3638
|
+
"Shared and language-specific generation behavior."
|
|
3639
|
+
),
|
|
3640
|
+
compatibility: compatibilityConfigSchema.optional().describe("Temporary provenance and diagnostics retained during legacy migration.")
|
|
3575
3641
|
}).superRefine(({ compatibility, generation, output, package: packageConfig, target }, context) => {
|
|
3576
3642
|
const configuredLanguages = Object.keys(generation.language ?? {});
|
|
3577
3643
|
const requiresExternalPublishIdentity = output.delivery === "github" || output.publish !== void 0;
|