@postman/sdk-config 0.7.0 → 0.9.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.
Files changed (36) hide show
  1. package/README.md +1 -3
  2. package/dist/index.cjs +882 -747
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +1 -1
  5. package/dist/index.d.ts +1 -1
  6. package/dist/index.js +882 -747
  7. package/dist/index.js.map +1 -1
  8. package/dist/sdk-config/index.cjs +644 -544
  9. package/dist/sdk-config/index.cjs.map +1 -1
  10. package/dist/sdk-config/index.d.cts +1 -1
  11. package/dist/sdk-config/index.d.ts +1 -1
  12. package/dist/sdk-config/index.js +644 -544
  13. package/dist/sdk-config/index.js.map +1 -1
  14. package/dist/sdk-config/v1/index.cjs +644 -544
  15. package/dist/sdk-config/v1/index.cjs.map +1 -1
  16. package/dist/sdk-config/v1/index.d.cts +581 -1047
  17. package/dist/sdk-config/v1/index.d.ts +581 -1047
  18. package/dist/sdk-config/v1/index.js +644 -544
  19. package/dist/sdk-config/v1/index.js.map +1 -1
  20. package/dist/sdk-config-ir/index.cjs +627 -541
  21. package/dist/sdk-config-ir/index.cjs.map +1 -1
  22. package/dist/sdk-config-ir/index.d.cts +1 -1
  23. package/dist/sdk-config-ir/index.d.ts +1 -1
  24. package/dist/sdk-config-ir/index.js +627 -541
  25. package/dist/sdk-config-ir/index.js.map +1 -1
  26. package/dist/sdk-config-ir/v1/index.cjs +627 -541
  27. package/dist/sdk-config-ir/v1/index.cjs.map +1 -1
  28. package/dist/sdk-config-ir/v1/index.d.cts +59 -17
  29. package/dist/sdk-config-ir/v1/index.d.ts +59 -17
  30. package/dist/sdk-config-ir/v1/index.js +627 -541
  31. package/dist/sdk-config-ir/v1/index.js.map +1 -1
  32. package/dist/{typescript-BdDv_kwT.d.cts → typescript-Chge0X4f.d.cts} +1 -2
  33. package/dist/{typescript-BdDv_kwT.d.ts → typescript-Chge0X4f.d.ts} +1 -2
  34. package/package.json +1 -1
  35. package/src/sdk-config/v1/README.md +15 -14
  36. package/src/sdk-config-ir/v1/README.md +29 -15
@@ -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
- omit: zod.z.boolean().optional()
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", "PUT", "DELETE", "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
- required: zod.z.boolean().optional()
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({
@@ -315,27 +329,48 @@ var tokenRefreshConfigSchema = zod.z.strictObject({
315
329
  });
316
330
  }
317
331
  });
332
+ var idempotencyKeyGenerationSchema = zod.z.strictObject({
333
+ enabled: zod.z.boolean().describe("Whether the client generates an idempotency key when the caller supplies none."),
334
+ headerName: nonEmptyStringSchema.optional().describe("The header that carries the generated key. Generators default to Idempotency-Key."),
335
+ methods: zod.z.array(nonEmptyStringSchema).optional().describe("HTTP methods that receive a generated key. Generators default to POST and PUT.")
336
+ });
337
+ var userAgentConfigSchema = zod.z.strictObject({
338
+ template: nonEmptyStringSchema.optional().describe(
339
+ "The User-Agent product token, resolved at generation time. Supports the {packageName}, {version}, {language}, {generatorVersion}, {organization}, and {apiName} placeholders."
340
+ ),
341
+ includePlatformInfo: zod.z.boolean().optional().describe(
342
+ "Whether the User-Agent carries operating system, architecture, and runtime details, as `{product} ({os}; {arch}) {runtime}/{runtimeVersion}`."
343
+ ),
344
+ allowAppInfo: zod.z.boolean().optional().describe(
345
+ "Whether callers can pass application info that is appended to the User-Agent as a `{name}/{version} ({comment})` product token."
346
+ )
347
+ });
318
348
  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()
349
+ retry: clientRetryOverrideSchema.optional().describe("Retry behavior for generated API requests."),
350
+ responseHeaders: zod.z.boolean().optional().describe("Whether generated operations expose HTTP response headers."),
351
+ responseValidation: zod.z.boolean().optional().describe("Whether the client validates API responses against the schema."),
352
+ multiTenant: zod.z.boolean().optional().describe("Whether the client exposes configuration for tenant-specific API access."),
353
+ additionalConstructorParameters: zod.z.array(constructorParameterSchema).optional().describe("Additional parameters added to the generated client constructor."),
354
+ 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.'),
355
+ requestParameterStyle: parameterStyleSchema.optional().describe("Whether generated operation parameters are wrapped or passed inline."),
356
+ pathParameterStyle: parameterStyleSchema.optional().describe("Whether generated path parameters are wrapped or passed inline."),
357
+ filePropertyStyle: parameterStyleSchema.optional().describe("Whether generated file properties are wrapped or passed inline."),
358
+ useDefaultRequestParameterValues: zod.z.boolean().optional().describe("Whether schema defaults are applied to omitted request parameters."),
359
+ respectOptionalRequestBody: zod.z.boolean().optional().describe("Whether an optional request body remains optional in generated methods."),
360
+ tokenRefresh: tokenRefreshConfigSchema.optional().describe("Refresh-token behavior for the generated client."),
361
+ idempotencyKeyGeneration: idempotencyKeyGenerationSchema.optional().describe("Automatic idempotency keys on eligible requests."),
362
+ userAgent: userAgentConfigSchema.optional().describe("The User-Agent header the generated client sends."),
363
+ offsetSemantics: zod.z.enum(["item-index", "page-index"]).optional().describe(
364
+ "How an offset-paginated endpoint advances: by the number of items returned, or by one page."
365
+ )
331
366
  };
332
367
  var clientConfigOverrideSchema = zod.z.strictObject(clientOverrideShape);
333
368
  var clientConfigSchema = zod.z.strictObject({
334
369
  ...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([])
370
+ retry: retryConfigSchema.prefault({}).describe("Retry behavior for generated API requests."),
371
+ responseHeaders: zod.z.boolean().default(false).describe("Whether generated operations expose HTTP response headers."),
372
+ multiTenant: zod.z.boolean().default(false).describe("Whether the client exposes configuration for tenant-specific API access."),
373
+ additionalConstructorParameters: zod.z.array(constructorParameterSchema).default([]).describe("Additional parameters added to the generated client constructor.")
339
374
  });
340
375
 
341
376
  // src/sdk-config/v1/client.ts
@@ -350,75 +385,75 @@ var composerPackageNameSchema = nonEmptyStringSchema.regex(
350
385
  'Composer package name must be a lowercase "vendor/package" name'
351
386
  );
352
387
  var authorSchema = zod.z.strictObject({
353
- name: nonEmptyStringSchema,
354
- email: zod.z.email().optional(),
355
- url: nonEmptyStringSchema.optional()
388
+ name: nonEmptyStringSchema.describe("The package author name."),
389
+ email: zod.z.email().optional().describe("The package author email address."),
390
+ url: nonEmptyStringSchema.optional().describe("The package author website.")
356
391
  });
357
392
  var developerSchema = zod.z.strictObject({
358
- name: nonEmptyStringSchema,
359
- email: zod.z.email().optional(),
360
- organization: nonEmptyStringSchema.optional(),
361
- organizationUrl: nonEmptyStringSchema.optional()
393
+ name: nonEmptyStringSchema.describe("The package developer name."),
394
+ email: zod.z.email().optional().describe("The package developer email address."),
395
+ organization: nonEmptyStringSchema.optional().describe("The developer organization name."),
396
+ organizationUrl: nonEmptyStringSchema.optional().describe("The developer organization website.")
362
397
  });
363
398
  var licenseSchema = zod.z.strictObject({
364
- type: nonEmptyStringSchema,
365
- name: nonEmptyStringSchema.optional(),
366
- url: nonEmptyStringSchema.optional(),
367
- path: nonEmptyStringSchema.optional()
399
+ type: nonEmptyStringSchema.describe("The license identifier or license type."),
400
+ name: nonEmptyStringSchema.optional().describe("The human-readable license name."),
401
+ url: nonEmptyStringSchema.optional().describe("The URL containing the license text."),
402
+ path: nonEmptyStringSchema.optional().describe("The path to a custom license file.")
368
403
  });
369
404
  var dependencySourceSchema = zod.z.discriminatedUnion("type", [
370
405
  zod.z.strictObject({
371
- type: zod.z.literal("registry"),
372
- registry: nonEmptyStringSchema.optional()
406
+ type: zod.z.literal("registry").describe("Resolves the dependency from a package registry."),
407
+ registry: nonEmptyStringSchema.optional().describe("The registry used to resolve the dependency.")
373
408
  }),
374
409
  zod.z.strictObject({
375
- type: zod.z.literal("git"),
376
- url: nonEmptyStringSchema,
377
- ref: nonEmptyStringSchema.optional(),
378
- subdirectory: nonEmptyStringSchema.optional()
410
+ type: zod.z.literal("git").describe("Resolves the dependency from a Git repository."),
411
+ url: nonEmptyStringSchema.describe("The Git repository URL."),
412
+ ref: nonEmptyStringSchema.optional().describe("The Git branch, tag, or commit to use."),
413
+ subdirectory: nonEmptyStringSchema.optional().describe("The package subdirectory within the Git repository.")
379
414
  }),
380
415
  zod.z.strictObject({
381
- type: zod.z.literal("path"),
382
- path: nonEmptyStringSchema
416
+ type: zod.z.literal("path").describe("Resolves the dependency from a local path."),
417
+ path: nonEmptyStringSchema.describe("The local path containing the dependency.")
383
418
  })
384
419
  ]);
385
420
  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()
421
+ name: nonEmptyStringSchema.describe("The dependency name used by the package manager."),
422
+ version: nonEmptyStringSchema.optional().describe("The dependency version requirement."),
423
+ source: dependencySourceSchema.optional().describe("A non-default source for the dependency."),
424
+ packageName: nonEmptyStringSchema.optional().describe("The source package name when it differs from the dependency alias."),
425
+ features: zod.z.array(nonEmptyStringSchema).optional().describe("Cargo features enabled for this dependency."),
426
+ extras: zod.z.array(nonEmptyStringSchema).optional().describe("Python extras enabled for this dependency."),
427
+ optional: zod.z.boolean().optional().describe("Whether the dependency is optional."),
428
+ defaultFeatures: zod.z.boolean().optional().describe("Whether the dependency enables its default Cargo features."),
429
+ environmentMarker: nonEmptyStringSchema.optional().describe("A Python environment marker that conditions this dependency.")
395
430
  }).refine(({ source, version }) => source !== void 0 || version !== void 0, {
396
431
  message: "dependency must define a version or a source"
397
432
  });
398
433
  var projectUrlSchema = zod.z.strictObject({
399
- label: nonEmptyStringSchema,
400
- url: nonEmptyStringSchema
434
+ label: nonEmptyStringSchema.describe("The label displayed for the project link."),
435
+ url: nonEmptyStringSchema.describe("The project link URL.")
401
436
  });
402
437
  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()
438
+ packageName: nonEmptyStringSchema.optional().describe("The package name used by the target language registry."),
439
+ moduleName: nonEmptyStringSchema.optional().describe("The generated module or import name when it differs from the package name."),
440
+ modulePath: goModulePathSchema.optional().describe("The Go module path used for imports and publishing."),
441
+ namespace: nonEmptyStringSchema.optional().describe("The namespace or package prefix for generated code."),
442
+ groupId: nonEmptyStringSchema.optional().describe("The Maven group identifier."),
443
+ artifactId: nonEmptyStringSchema.optional().describe("The Maven artifact identifier."),
444
+ description: zod.z.string().optional().describe("The package description used in generated metadata."),
445
+ repository: nonEmptyStringSchema.optional().describe("The source repository for the generated SDK."),
446
+ homepage: nonEmptyStringSchema.optional().describe("The package homepage URL."),
447
+ documentationUrl: nonEmptyStringSchema.optional().describe("The package documentation URL."),
448
+ authors: zod.z.array(authorSchema).optional().describe("Authors credited in package metadata."),
449
+ developers: zod.z.array(developerSchema).optional().describe("Developers credited in package metadata."),
450
+ license: licenseSchema.optional().describe("License metadata for the generated package."),
451
+ keywords: zod.z.array(nonEmptyStringSchema).optional().describe("Search keywords for package metadata."),
452
+ classifiers: zod.z.array(nonEmptyStringSchema).optional().describe("Package classifiers used by registries such as PyPI."),
453
+ projectUrls: zod.z.array(projectUrlSchema).optional().describe("Labeled project links for package metadata."),
454
+ extraDependencies: zod.z.array(dependencySchema).optional().describe("Additional runtime dependencies added to the generated package."),
455
+ extraDevDependencies: zod.z.array(dependencySchema).optional().describe("Additional development dependencies added to the generated package."),
456
+ extraPeerDependencies: zod.z.array(dependencySchema).optional().describe("Additional peer dependencies added to the generated package.")
422
457
  });
423
458
  var httpMethodSchema = zod.z.enum([
424
459
  "GET",
@@ -432,34 +467,34 @@ var httpMethodSchema = zod.z.enum([
432
467
  "CONNECT"
433
468
  ]);
434
469
  var readmeEndpointSchema = zod.z.strictObject({
435
- method: httpMethodSchema,
436
- path: nonEmptyStringSchema,
437
- stream: zod.z.boolean().optional()
470
+ method: httpMethodSchema.describe("The HTTP method of the documented endpoint."),
471
+ path: nonEmptyStringSchema.describe("The endpoint path used in generated examples."),
472
+ stream: zod.z.boolean().optional().describe("Whether the example uses the streaming response API.")
438
473
  });
439
474
  var readmeCustomSectionSchema = zod.z.strictObject({
440
- title: nonEmptyStringSchema,
441
- content: zod.z.string()
475
+ title: nonEmptyStringSchema.describe("The heading displayed for this README section."),
476
+ content: zod.z.string().describe("The Markdown content of this README section.")
442
477
  });
443
478
  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()
479
+ apiName: nonEmptyStringSchema.optional().describe("The API name displayed in the README."),
480
+ introduction: zod.z.string().optional().describe("Custom introductory Markdown for the README."),
481
+ apiReferenceLink: nonEmptyStringSchema.optional().describe("The URL linked as the API reference."),
482
+ bannerLink: nonEmptyStringSchema.optional().describe("The destination URL for the README banner."),
483
+ disabledSections: zod.z.array(nonEmptyStringSchema).optional().describe("Generated README sections to omit."),
484
+ customSections: zod.z.array(readmeCustomSectionSchema).optional().describe("Additional sections inserted into the README."),
485
+ defaultEndpoint: readmeEndpointSchema.optional().describe("The endpoint used for the primary README example."),
486
+ features: zod.z.record(zod.z.string(), zod.z.array(readmeEndpointSchema)).optional().describe("Named feature groups and the endpoints demonstrated by each group.")
452
487
  });
453
488
  var snippetsConfigSchema = zod.z.strictObject({
454
- enabled: zod.z.boolean(),
455
- format: zod.z.enum(["md", "json"]).optional(),
456
- outputPath: nonEmptyStringSchema.optional()
489
+ enabled: zod.z.boolean().describe("Whether standalone usage snippets are generated."),
490
+ format: zod.z.enum(["md", "json"]).optional().describe("The output format for generated snippets."),
491
+ outputPath: nonEmptyStringSchema.optional().describe("The output path for generated snippet files.")
457
492
  });
458
493
  var docsConfigSchema = zod.z.strictObject({
459
- readme: readmeConfigSchema.optional(),
460
- snippets: snippetsConfigSchema.optional(),
461
- referenceBaseUrl: nonEmptyStringSchema.optional(),
462
- includeApiReference: zod.z.boolean().optional()
494
+ readme: readmeConfigSchema.optional().describe("README content and example configuration."),
495
+ snippets: snippetsConfigSchema.optional().describe("Standalone usage snippet generation."),
496
+ referenceBaseUrl: nonEmptyStringSchema.optional().describe("The base URL used for links to generated API reference files."),
497
+ includeApiReference: zod.z.boolean().optional().describe("Whether API reference documentation is included in the SDK output.")
463
498
  });
464
499
 
465
500
  // src/sdk-config/v1/docs.ts
@@ -1258,16 +1293,10 @@ function finishOutputMapping(mapping, outputMode, sourcePath, state, index) {
1258
1293
  for (const path of collectLeafPaths(outputMode, sourcePath)) {
1259
1294
  if (path[path.length - 1] === "_visit") consume(state, path);
1260
1295
  }
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
1296
  const unsupported = collectUnsupported(outputMode, sourcePath, state);
1267
1297
  const hasCredentials = unsupported.some((diagnostic) => isCredentialPath(diagnostic.path));
1268
1298
  return {
1269
1299
  ...mapping,
1270
- ...generationShape,
1271
1300
  unsupportedFields: [
1272
1301
  ...state.credentialDiagnostics ?? [],
1273
1302
  ...hasCredentials ? [
@@ -1338,6 +1367,9 @@ function outputDiagnostic(path, index) {
1338
1367
  homepageLink: {
1339
1368
  sdkConfigPath: ["targets", index, "package", "homepage"],
1340
1369
  suggestedAction: "Set target.package.homepage manually to a valid URL."
1370
+ },
1371
+ generateFullProject: {
1372
+ suggestedAction: "Preserve this packaging setting on the generation request; it is not customer-authored SDK configuration."
1341
1373
  }
1342
1374
  };
1343
1375
  const fieldGuidance = field ? guidance[field] : void 0;
@@ -1459,59 +1491,48 @@ function deepEqual(left, right) {
1459
1491
  return false;
1460
1492
  }
1461
1493
  var namingConfigSchema = zod.z.strictObject({
1462
- clientName: nonEmptyStringSchema.optional(),
1463
- exportedClientName: nonEmptyStringSchema.optional(),
1464
- environmentTypeName: nonEmptyStringSchema.optional(),
1465
- apiErrorName: nonEmptyStringSchema.optional(),
1466
- baseErrorName: nonEmptyStringSchema.optional(),
1467
- pagerName: nonEmptyStringSchema.optional(),
1494
+ clientName: nonEmptyStringSchema.optional().describe("The generated client class name."),
1495
+ exportedClientName: nonEmptyStringSchema.optional().describe("The client name exported from the generated package."),
1496
+ environmentTypeName: nonEmptyStringSchema.optional().describe("The generated type name for API environments."),
1497
+ apiErrorName: nonEmptyStringSchema.optional().describe("The generated API error class name."),
1498
+ baseErrorName: nonEmptyStringSchema.optional().describe("The generated base error class name."),
1499
+ pagerName: nonEmptyStringSchema.optional().describe("The generated pagination helper name."),
1468
1500
  /** Apply Fern's initialism-aware casing rules when deriving generated identifiers. */
1469
- smartCasing: zod.z.boolean().optional(),
1501
+ smartCasing: zod.z.boolean().optional().describe("Whether generated identifiers use initialism-aware casing."),
1470
1502
  /** Preserve a word boundary after digits when Fern smart casing is enabled. */
1471
- smartCasingDigitWordBoundary: zod.z.boolean().optional()
1503
+ smartCasingDigitWordBoundary: zod.z.boolean().optional().describe("Whether smart casing preserves a word boundary after digits.")
1472
1504
  });
1473
1505
 
1474
1506
  // src/sdk-config/v1/generation.ts
1475
1507
  var customerGenerationAssetSchema = zod.z.discriminatedUnion("type", [
1476
- zod.z.strictObject({ type: zod.z.literal("path"), location: relativePathSchema }),
1477
- zod.z.strictObject({ type: zod.z.literal("url"), location: nonEmptyStringSchema })
1478
- ]);
1479
- var hookDependencySchema = zod.z.strictObject({
1480
- name: nonEmptyStringSchema,
1481
- version: nonEmptyStringSchema,
1482
- groupId: nonEmptyStringSchema.optional()
1483
- });
1484
- var hooksConfigSchema = zod.z.strictObject({
1485
- enabled: zod.z.boolean(),
1486
- source: customerGenerationAssetSchema.optional(),
1487
- dependencies: zod.z.array(hookDependencySchema).optional()
1488
- });
1489
- var customCodeConfigSchema = zod.z.strictObject({
1490
- enabled: zod.z.boolean(),
1491
- source: customerGenerationAssetSchema.optional(),
1492
- conflictStrategy: zod.z.enum(["mark", "ours", "theirs"]).optional(),
1493
- trackChanges: zod.z.boolean().optional(),
1494
- protectedFiles: zod.z.array(nonEmptyStringSchema).optional()
1495
- });
1496
- var workflowConfigSchema = zod.z.strictObject({
1497
- path: relativePathSchema,
1498
- outputName: nonEmptyStringSchema.optional()
1499
- });
1500
- var analyticsHeaderSchema = zod.z.union([
1501
- zod.z.strictObject({ name: nonEmptyStringSchema, value: zod.z.string() }),
1502
1508
  zod.z.strictObject({
1503
- name: nonEmptyStringSchema,
1504
- valueRef: nonEmptyStringSchema
1509
+ type: zod.z.literal("path").describe("Loads the generation asset from a relative path."),
1510
+ location: relativePathSchema.describe("The relative path to the generation asset.")
1511
+ }),
1512
+ zod.z.strictObject({
1513
+ type: zod.z.literal("url").describe("Loads the generation asset from a URL."),
1514
+ location: nonEmptyStringSchema.describe("The URL of the generation asset.")
1505
1515
  })
1506
1516
  ]);
1517
+ var customCodeConfigSchema = zod.z.strictObject({
1518
+ enabled: zod.z.boolean().describe("Whether customer-authored code is merged into generated output."),
1519
+ source: customerGenerationAssetSchema.optional().describe("The source containing customer-authored code."),
1520
+ conflictStrategy: zod.z.enum(["mark", "ours", "theirs"]).optional().describe("How merge conflicts between generated and custom code are handled."),
1521
+ trackChanges: zod.z.boolean().optional().describe("Whether custom-code changes are tracked between builds."),
1522
+ protectedFiles: zod.z.array(nonEmptyStringSchema).optional().describe("Generated file paths that custom-code merging must not overwrite.")
1523
+ });
1524
+ var analyticsHeaderSchema = zod.z.strictObject({
1525
+ name: nonEmptyStringSchema.describe("The exported telemetry header name."),
1526
+ value: zod.z.string().describe("The literal telemetry header value.")
1527
+ });
1507
1528
  var analyticsConfigSchema = zod.z.strictObject({
1508
- enabled: zod.z.boolean(),
1509
- endpoint: nonEmptyStringSchema.optional(),
1510
- exporter: zod.z.enum(["otlp-http", "console"]).optional(),
1511
- headers: zod.z.array(analyticsHeaderSchema).optional(),
1512
- batchSize: zod.z.number().int().positive().optional(),
1513
- scheduledDelayMs: zod.z.number().nonnegative().optional(),
1514
- exportTimeoutMs: zod.z.number().nonnegative().optional()
1529
+ enabled: zod.z.boolean().describe("Whether generated clients export usage telemetry."),
1530
+ endpoint: nonEmptyStringSchema.optional().describe("The telemetry export endpoint."),
1531
+ exporter: zod.z.enum(["otlp-http", "console"]).optional().describe("The telemetry exporter implementation."),
1532
+ headers: zod.z.array(analyticsHeaderSchema).optional().describe("Headers sent by the telemetry exporter."),
1533
+ batchSize: zod.z.number().int().positive().optional().describe("The maximum spans in each export batch."),
1534
+ scheduledDelayMs: zod.z.number().nonnegative().optional().describe("The delay between scheduled exports, in milliseconds."),
1535
+ exportTimeoutMs: zod.z.number().nonnegative().optional().describe("The maximum time allowed for an export, in milliseconds.")
1515
1536
  }).superRefine(({ enabled, endpoint }, context) => {
1516
1537
  if (enabled && endpoint === void 0) {
1517
1538
  context.addIssue({
@@ -1522,73 +1543,63 @@ var analyticsConfigSchema = zod.z.strictObject({
1522
1543
  }
1523
1544
  });
1524
1545
  var wireTestsSchema = zod.z.strictObject({
1525
- enabled: zod.z.boolean(),
1526
- exclusions: zod.z.array(nonEmptyStringSchema).optional(),
1527
- fallbackToGeneratedErrorExamples: zod.z.boolean().optional(),
1528
- fixtureSource: zod.z.enum(["synthetic", "recorded", "auto"]).optional()
1546
+ enabled: zod.z.boolean().describe("Whether wire-level request and response tests are generated."),
1547
+ exclusions: zod.z.array(nonEmptyStringSchema).optional().describe("Operations excluded from wire tests."),
1548
+ fallbackToGeneratedErrorExamples: zod.z.boolean().optional().describe("Whether missing error fixtures are synthesized from generated examples."),
1549
+ fixtureSource: zod.z.enum(["synthetic", "recorded", "auto"]).optional().describe("Where wire-test fixtures are obtained.")
1529
1550
  });
1530
1551
  var unitTestsSchema = zod.z.strictObject({
1531
- enabled: zod.z.boolean(),
1532
- mode: zod.z.enum(["core-runtime", "schema-driven", "both"]).optional(),
1533
- exclusions: zod.z.array(nonEmptyStringSchema).optional()
1552
+ enabled: zod.z.boolean().describe("Whether SDK unit tests are generated."),
1553
+ exclusions: zod.z.array(nonEmptyStringSchema).optional().describe("Operations excluded from unit tests.")
1534
1554
  });
1535
1555
  var streamsSchema = zod.z.strictObject({
1536
- enabled: zod.z.boolean(),
1537
- responseType: zod.z.enum(["wrapper", "native", "web"]).optional(),
1538
- fileResponseType: zod.z.enum(["stream", "binary-response"]).optional(),
1539
- defaultChunkSizeBytes: zod.z.number().int().positive().optional()
1556
+ enabled: zod.z.boolean().describe("Whether generated clients expose streaming response APIs."),
1557
+ responseType: zod.z.enum(["wrapper", "native", "web"]).optional().describe("The streaming response abstraction exposed by generated clients."),
1558
+ fileResponseType: zod.z.enum(["stream", "binary-response"]).optional().describe("The response type used for file downloads."),
1559
+ defaultChunkSizeBytes: zod.z.number().int().positive().optional().describe("The default number of bytes yielded by streaming iterators.")
1540
1560
  });
1541
1561
  var layoutConfigSchema = zod.z.strictObject({
1542
- outputDirectory: zod.z.enum(["project-root", "source-root"]).optional(),
1543
- packagePath: nonEmptyStringSchema.optional()
1562
+ outputDirectory: zod.z.enum(["project-root", "source-root"]).optional().describe("Whether generated source is rooted at the project or its source directory."),
1563
+ packagePath: nonEmptyStringSchema.optional().describe("The package-relative path for generated source files.")
1544
1564
  });
1545
1565
  var serializationConfigSchema = zod.z.strictObject({
1546
- enumRepresentation: zod.z.enum(["enum", "union", "literal", "forward-compatible-enum", "language-default"]).optional(),
1547
- additionalProperties: zod.z.enum(["allow", "forbid", "ignore", "language-default"]).optional(),
1548
- inlineTypes: zod.z.boolean().optional(),
1549
- omitUndefined: zod.z.boolean().optional()
1566
+ enumRepresentation: zod.z.enum(["enum", "union", "literal", "forward-compatible-enum", "language-default"]).optional().describe("How schema enums are represented in generated code."),
1567
+ additionalProperties: zod.z.enum(["allow", "forbid", "ignore", "language-default"]).optional().describe("How undeclared object properties are handled."),
1568
+ inlineTypes: zod.z.boolean().optional().describe("Whether inline schemas remain nested under their parent types."),
1569
+ omitUndefined: zod.z.boolean().optional().describe("Whether undefined properties are omitted during serialization.")
1550
1570
  });
1551
1571
  var generationConfigOverrideShape = {
1552
- includeWatermark: zod.z.boolean().optional(),
1553
- ai: zod.z.boolean().optional(),
1554
- includeOptionalSnippetParameters: zod.z.boolean().optional(),
1555
- buildAllModels: zod.z.boolean().optional(),
1556
- inferServiceNames: zod.z.boolean().optional(),
1557
- includeDeprecatedOperations: zod.z.boolean().optional(),
1558
- multipleResponses: zod.z.boolean().optional(),
1559
- /** Generate the entire SDK project, including package manifests and publishable artifacts. */
1560
- generateFullProject: zod.z.boolean().optional(),
1561
- devContainer: zod.z.boolean().optional(),
1562
- allowMockClient: zod.z.boolean().optional(),
1563
- ignoreFiles: zod.z.array(nonEmptyStringSchema).optional(),
1564
- reservedKeywords: zod.z.array(nonEmptyStringSchema).optional(),
1565
- hooks: hooksConfigSchema.optional(),
1566
- customCode: customCodeConfigSchema.optional(),
1567
- workflows: zod.z.array(workflowConfigSchema).optional(),
1568
- customQueryPaths: zod.z.array(relativePathSchema).optional(),
1569
- analytics: analyticsConfigSchema.optional(),
1570
- wireTests: wireTestsSchema.optional(),
1571
- unitTests: unitTestsSchema.optional(),
1572
- webSockets: zod.z.boolean().optional(),
1573
- streams: streamsSchema.optional(),
1574
- naming: namingConfigSchema.optional(),
1575
- layout: layoutConfigSchema.optional(),
1576
- serialization: serializationConfigSchema.optional()
1572
+ includeOptionalSnippetParameters: zod.z.boolean().optional().describe("Whether usage snippets include optional request parameters."),
1573
+ buildAllModels: zod.z.boolean().optional().describe("Whether models not referenced by operations are also generated."),
1574
+ inferServiceNames: zod.z.boolean().optional().describe("Whether service names are inferred from API structure."),
1575
+ includeDeprecatedOperations: zod.z.boolean().optional().describe("Whether deprecated API operations are generated."),
1576
+ multipleResponses: zod.z.boolean().optional().describe("Whether operations model multiple successful response types."),
1577
+ devContainer: zod.z.boolean().optional().describe("Whether development-container configuration is generated."),
1578
+ allowMockClient: zod.z.boolean().optional().describe("Whether a mock API client is included in the generated SDK."),
1579
+ ignoreFiles: zod.z.array(nonEmptyStringSchema).optional().describe("Generated paths excluded from the final output."),
1580
+ reservedKeywords: zod.z.array(nonEmptyStringSchema).optional().describe("Additional identifiers treated as reserved words."),
1581
+ customCode: customCodeConfigSchema.optional().describe("Customer-authored code merge configuration."),
1582
+ customQueryPaths: zod.z.array(relativePathSchema).optional().describe("Relative paths to custom query definitions."),
1583
+ analytics: analyticsConfigSchema.optional().describe("Generated client telemetry configuration."),
1584
+ wireTests: wireTestsSchema.optional().describe("Wire-level request and response test generation."),
1585
+ unitTests: unitTestsSchema.optional().describe("SDK unit-test generation."),
1586
+ webSockets: zod.z.boolean().optional().describe("Whether WebSocket clients are generated for supported channels."),
1587
+ streams: streamsSchema.optional().describe("Streaming response generation behavior."),
1588
+ naming: namingConfigSchema.optional().describe("Names and casing used by generated code."),
1589
+ layout: layoutConfigSchema.optional().describe("Generated project and source layout."),
1590
+ serialization: serializationConfigSchema.optional().describe("Generated model serialization behavior.")
1577
1591
  };
1578
1592
  var sdkConfigV1GenerationConfigOverrideSchema = zod.z.strictObject(
1579
1593
  generationConfigOverrideShape
1580
1594
  );
1581
1595
  var sdkConfigV1GenerationConfigSchema = zod.z.strictObject({
1582
1596
  ...generationConfigOverrideShape,
1583
- includeWatermark: zod.z.boolean().default(false),
1584
- ai: zod.z.boolean().default(false),
1585
- buildAllModels: zod.z.boolean().default(false),
1586
- inferServiceNames: zod.z.boolean().default(false),
1587
- includeDeprecatedOperations: zod.z.boolean().default(true),
1588
- multipleResponses: zod.z.boolean().default(false),
1589
- generateFullProject: zod.z.boolean().default(false),
1590
- devContainer: zod.z.boolean().default(false),
1591
- allowMockClient: zod.z.boolean().default(false)
1597
+ buildAllModels: zod.z.boolean().default(false).describe("Whether models not referenced by operations are also generated."),
1598
+ inferServiceNames: zod.z.boolean().default(false).describe("Whether service names are inferred from API structure."),
1599
+ includeDeprecatedOperations: zod.z.boolean().default(true).describe("Whether deprecated API operations are generated."),
1600
+ multipleResponses: zod.z.boolean().default(false).describe("Whether operations model multiple successful response types."),
1601
+ devContainer: zod.z.boolean().default(false).describe("Whether development-container configuration is generated."),
1602
+ allowMockClient: zod.z.boolean().default(false).describe("Whether a mock API client is included in the generated SDK.")
1592
1603
  });
1593
1604
  var commonGenerationKeys = new Set(Object.keys(generationConfigOverrideShape));
1594
1605
  function splitSdkConfigV1TargetGeneration(generation) {
@@ -1610,78 +1621,97 @@ var sdkConfigV1PublishRegistrySchema = zod.z.enum([
1610
1621
  "composer"
1611
1622
  ]);
1612
1623
  var mavenSignatureSchema = zod.z.strictObject({
1613
- keyId: nonEmptyStringSchema,
1614
- password: nonEmptyStringSchema,
1615
- secretKey: nonEmptyStringSchema
1624
+ keyId: nonEmptyStringSchema.describe(
1625
+ "The signing key identifier, or an environment expression that resolves to it."
1626
+ ),
1627
+ password: nonEmptyStringSchema.describe(
1628
+ "The signing key password, or an environment expression that resolves to it."
1629
+ ),
1630
+ secretKey: nonEmptyStringSchema.describe(
1631
+ "The armored secret key, or an environment expression that resolves to it."
1632
+ )
1616
1633
  });
1617
1634
  var commonPublishShape = {
1618
- url: nonEmptyStringSchema.optional(),
1619
- releaseBranch: nonEmptyStringSchema.optional(),
1620
- tolerateRepublish: zod.z.boolean().optional()
1635
+ url: nonEmptyStringSchema.optional().describe("A custom package registry URL."),
1636
+ releaseBranch: nonEmptyStringSchema.optional().describe("The branch used by generated package release workflows."),
1637
+ tolerateRepublish: zod.z.boolean().optional().describe("Whether an already-published package version is treated as non-fatal.")
1621
1638
  };
1622
1639
  var sdkConfigV1PublishConfigSchema = zod.z.discriminatedUnion("registry", [
1623
1640
  zod.z.strictObject({
1624
- registry: zod.z.literal("npm"),
1625
- token: nonEmptyStringSchema.optional(),
1641
+ registry: zod.z.literal("npm").describe("Publishes the package to an npm-compatible registry."),
1642
+ token: nonEmptyStringSchema.optional().describe("The npm registry token, or an environment expression that resolves to it."),
1626
1643
  ...commonPublishShape
1627
1644
  }),
1628
1645
  zod.z.strictObject({
1629
- registry: zod.z.literal("pypi"),
1630
- username: nonEmptyStringSchema.optional(),
1631
- password: nonEmptyStringSchema.optional(),
1646
+ registry: zod.z.literal("pypi").describe("Publishes the package to a PyPI-compatible registry."),
1647
+ username: nonEmptyStringSchema.optional().describe("The PyPI username, or an environment expression that resolves to it."),
1648
+ password: nonEmptyStringSchema.optional().describe("The PyPI password or token, or an environment expression that resolves to it."),
1632
1649
  ...commonPublishShape
1633
1650
  }),
1634
1651
  zod.z.strictObject({
1635
- registry: zod.z.literal("maven"),
1636
- username: nonEmptyStringSchema.optional(),
1637
- password: nonEmptyStringSchema.optional(),
1638
- signature: mavenSignatureSchema.optional(),
1652
+ registry: zod.z.literal("maven").describe("Publishes the package to a Maven-compatible repository."),
1653
+ username: nonEmptyStringSchema.optional().describe("The Maven username, or an environment expression that resolves to it."),
1654
+ password: nonEmptyStringSchema.optional().describe("The Maven password, or an environment expression that resolves to it."),
1655
+ signature: mavenSignatureSchema.optional().describe("Credentials used to sign Maven artifacts."),
1639
1656
  ...commonPublishShape
1640
1657
  }),
1641
- zod.z.strictObject({ registry: zod.z.literal("nuget"), ...commonPublishShape }),
1642
- zod.z.strictObject({ registry: zod.z.literal("rubygems"), ...commonPublishShape }),
1643
1658
  zod.z.strictObject({
1644
- registry: zod.z.literal("crates"),
1645
- token: nonEmptyStringSchema.optional(),
1659
+ registry: zod.z.literal("nuget").describe("Publishes the package to a NuGet-compatible registry."),
1646
1660
  ...commonPublishShape
1647
1661
  }),
1648
- zod.z.strictObject({ registry: zod.z.literal("go"), ...commonPublishShape }),
1649
- zod.z.strictObject({ registry: zod.z.literal("composer"), ...commonPublishShape })
1662
+ zod.z.strictObject({
1663
+ registry: zod.z.literal("rubygems").describe("Publishes the package to a RubyGems-compatible registry."),
1664
+ ...commonPublishShape
1665
+ }),
1666
+ zod.z.strictObject({
1667
+ registry: zod.z.literal("crates").describe("Publishes the crate to a Cargo-compatible registry."),
1668
+ token: nonEmptyStringSchema.optional().describe("The Cargo registry token, or an environment expression that resolves to it."),
1669
+ ...commonPublishShape
1670
+ }),
1671
+ zod.z.strictObject({
1672
+ registry: zod.z.literal("go").describe("Publishes the SDK as a Go module."),
1673
+ ...commonPublishShape
1674
+ }),
1675
+ zod.z.strictObject({
1676
+ registry: zod.z.literal("composer").describe("Publishes the package to a Composer-compatible registry."),
1677
+ ...commonPublishShape
1678
+ })
1650
1679
  ]);
1651
1680
  var reviewersSchema = zod.z.strictObject({
1652
- teams: zod.z.array(nonEmptyStringSchema).optional(),
1653
- users: zod.z.array(nonEmptyStringSchema).optional()
1681
+ teams: zod.z.array(nonEmptyStringSchema).optional().describe("GitHub teams requested as reviewers."),
1682
+ users: zod.z.array(nonEmptyStringSchema).optional().describe("GitHub users requested as reviewers.")
1654
1683
  });
1655
1684
  var githubCredentialsSchema = zod.z.strictObject({
1656
- username: nonEmptyStringSchema.optional(),
1657
- password: nonEmptyStringSchema.optional(),
1658
- token: nonEmptyStringSchema.optional(),
1659
- apiKey: nonEmptyStringSchema.optional()
1685
+ username: nonEmptyStringSchema.optional().describe("The username used to authenticate with the GitHub host."),
1686
+ password: nonEmptyStringSchema.optional().describe("The password used to authenticate with the GitHub host."),
1687
+ token: nonEmptyStringSchema.optional().describe("A token used to authenticate with the GitHub host."),
1688
+ apiKey: nonEmptyStringSchema.optional().describe("An API key used to authenticate with the GitHub host.")
1660
1689
  });
1661
1690
  var githubOutputSchema = zod.z.strictObject({
1662
- repository: nonEmptyStringSchema,
1663
- host: nonEmptyStringSchema.optional(),
1664
- branch: nonEmptyStringSchema.optional(),
1665
- mode: zod.z.enum(["release", "pull-request", "push", "commit", "commit-and-release"]).optional(),
1666
- reviewers: reviewersSchema.optional(),
1667
- /** Raw GitHub credentials. These values can be sensitive and must be handled as secrets. */
1668
- credentials: githubCredentialsSchema.optional(),
1669
- privateRepository: zod.z.boolean().optional()
1691
+ repository: nonEmptyStringSchema.describe(
1692
+ "The GitHub repository that receives generated files."
1693
+ ),
1694
+ host: nonEmptyStringSchema.optional().describe("The GitHub host for enterprise installations."),
1695
+ branch: nonEmptyStringSchema.optional().describe("The target branch for generated changes."),
1696
+ mode: zod.z.enum(["release", "pull-request", "push", "commit", "commit-and-release"]).optional().describe("How generated changes are delivered to the repository."),
1697
+ reviewers: reviewersSchema.optional().describe("Reviewers requested for generated pull requests."),
1698
+ credentials: githubCredentialsSchema.optional().describe("Credentials used to authenticate GitHub delivery."),
1699
+ privateRepository: zod.z.boolean().optional().describe("Whether the destination repository is private.")
1670
1700
  });
1671
1701
  var filesOutputSchema = zod.z.strictObject({
1672
- delivery: zod.z.literal("files"),
1673
- path: nonEmptyStringSchema.optional(),
1674
- publish: sdkConfigV1PublishConfigSchema.optional()
1702
+ delivery: zod.z.literal("files").describe("Writes the generated SDK to a directory."),
1703
+ path: nonEmptyStringSchema.optional().describe("The destination directory for generated files."),
1704
+ publish: sdkConfigV1PublishConfigSchema.optional().describe("Optional package registry publication.")
1675
1705
  });
1676
1706
  var zipOutputSchema = zod.z.strictObject({
1677
- delivery: zod.z.literal("zip"),
1678
- fileName: nonEmptyStringSchema.optional(),
1679
- publish: sdkConfigV1PublishConfigSchema.optional()
1707
+ delivery: zod.z.literal("zip").describe("Packages the generated SDK as a ZIP archive."),
1708
+ fileName: nonEmptyStringSchema.optional().describe("The generated ZIP archive file name."),
1709
+ publish: sdkConfigV1PublishConfigSchema.optional().describe("Optional package registry publication.")
1680
1710
  });
1681
1711
  var githubDeliverySchema = zod.z.strictObject({
1682
- delivery: zod.z.literal("github"),
1683
- github: githubOutputSchema,
1684
- publish: sdkConfigV1PublishConfigSchema.optional()
1712
+ delivery: zod.z.literal("github").describe("Delivers the generated SDK to GitHub."),
1713
+ github: githubOutputSchema.describe("GitHub repository delivery settings."),
1714
+ publish: sdkConfigV1PublishConfigSchema.optional().describe("Optional package registry publication.")
1685
1715
  });
1686
1716
  var sdkConfigV1OutputConfigSchema = zod.z.discriminatedUnion(
1687
1717
  "delivery",
@@ -1693,29 +1723,33 @@ var sdkConfigV1OutputConfigSchema = zod.z.discriminatedUnion(
1693
1723
  var sdkConfigV1DependencySchema = dependencySchema;
1694
1724
  var sdkConfigV1PackageConfigSchema = packageConfigSchema;
1695
1725
  var sdkConfigV1ReplayConfigSchema = zod.z.strictObject({
1696
- enabled: zod.z.boolean()
1726
+ enabled: zod.z.boolean().describe("Whether regeneration reapplies customer-authored repository changes.")
1697
1727
  });
1698
1728
  var apiImportSettingsSchema = zod.z.strictObject({
1699
- respectNullableSchemas: zod.z.boolean().optional(),
1700
- titleAsSchemaName: zod.z.boolean().optional(),
1701
- coerceEnumsToLiterals: zod.z.boolean().optional(),
1702
- idiomaticRequestNames: zod.z.boolean().optional(),
1703
- wrapReferencesToNullableInOptional: zod.z.boolean().optional(),
1704
- coerceOptionalSchemasToNullable: zod.z.boolean().optional(),
1705
- pathParameterOrder: zod.z.enum(["url-order", "spec-order"]).optional(),
1706
- onlyIncludeReferencedSchemas: zod.z.boolean().optional(),
1707
- objectQueryParameters: zod.z.boolean().optional(),
1708
- typeDatesAsStrings: zod.z.boolean().optional(),
1709
- groupMultiApiEnvironments: zod.z.boolean().optional(),
1710
- ignoreTags: zod.z.boolean().optional(),
1711
- disambiguateRequestNames: zod.z.boolean().optional(),
1712
- respectReadonlySchemas: zod.z.boolean().optional(),
1713
- discriminatedUnionV2: zod.z.boolean().optional(),
1714
- undiscriminatedUnionsWithLiterals: zod.z.boolean().optional(),
1715
- inlineAllOfSchemas: zod.z.boolean().optional(),
1716
- resolveSchemaCollisions: zod.z.boolean().optional(),
1717
- asyncApiMessageNaming: zod.z.enum(["v1", "v2"]).optional(),
1718
- defaultIntegerFormat: zod.z.enum(["int32", "int64", "uint32", "uint64"]).optional()
1729
+ respectNullableSchemas: zod.z.boolean().optional().describe("Whether nullable schemas remain nullable in generated types."),
1730
+ titleAsSchemaName: zod.z.boolean().optional().describe("Whether a schema title can determine the generated type name."),
1731
+ coerceEnumsToLiterals: zod.z.boolean().optional().describe("Whether single-value enums are imported as literal values."),
1732
+ idiomaticRequestNames: zod.z.boolean().optional().describe("Whether request types use concise, idiomatic generated names."),
1733
+ wrapReferencesToNullableInOptional: zod.z.boolean().optional().describe("Whether nullable schema references are also treated as optional."),
1734
+ coerceOptionalSchemasToNullable: zod.z.boolean().optional().describe("Whether optional properties are represented as nullable required properties."),
1735
+ pathParameterOrder: zod.z.enum(["url-order", "spec-order"]).optional().describe("Whether path parameters follow their URL order or specification order."),
1736
+ onlyIncludeReferencedSchemas: zod.z.boolean().optional().describe("Whether unreferenced schemas are omitted from the generated SDK."),
1737
+ objectQueryParameters: zod.z.boolean().optional().describe("Whether object-valued query parameters are preserved as objects."),
1738
+ typeDatesAsStrings: zod.z.boolean().optional().describe("Whether date and date-time schemas are generated as strings."),
1739
+ groupMultiApiEnvironments: zod.z.boolean().optional().describe(
1740
+ "Whether environments from multiple API sources are merged into shared named groups."
1741
+ ),
1742
+ ignoreTags: zod.z.boolean().optional().describe("Whether API tags are ignored when organizing generated resources."),
1743
+ disambiguateRequestNames: zod.z.boolean().optional().describe("Whether colliding request type names are automatically disambiguated."),
1744
+ respectReadonlySchemas: zod.z.boolean().optional().describe(
1745
+ "Whether read-only properties are modeled separately for request and response types."
1746
+ ),
1747
+ discriminatedUnionV2: zod.z.boolean().optional().describe("Whether oneOf and anyOf schemas use the newer discriminator inference rules."),
1748
+ undiscriminatedUnionsWithLiterals: zod.z.boolean().optional().describe("Whether literal-bearing unions remain undiscriminated during import."),
1749
+ inlineAllOfSchemas: zod.z.boolean().optional().describe("Whether schemas composed with allOf are inlined when possible."),
1750
+ resolveSchemaCollisions: zod.z.boolean().optional().describe("Whether colliding imported schema names are resolved automatically."),
1751
+ asyncApiMessageNaming: zod.z.enum(["v1", "v2"]).optional().describe("The naming strategy used for messages imported from AsyncAPI."),
1752
+ defaultIntegerFormat: zod.z.enum(["int32", "int64", "uint32", "uint64"]).optional().describe("The integer format used when a schema does not declare one.")
1719
1753
  });
1720
1754
  var sourceSpecTypeSchema = zod.z.enum([
1721
1755
  "openapi",
@@ -1727,27 +1761,30 @@ var sourceSpecTypeSchema = zod.z.enum([
1727
1761
 
1728
1762
  // src/sdk-config/v1/source.ts
1729
1763
  var sourceSpecShape = {
1730
- id: nonEmptyStringSchema,
1731
- type: sourceSpecTypeSchema,
1732
- name: nonEmptyStringSchema.optional(),
1733
- namespace: nonEmptyStringSchema.optional(),
1734
- apiImportSettings: apiImportSettingsSchema.optional(),
1735
- overlays: zod.z.array(relativePathSchema).optional(),
1736
- overrides: zod.z.array(relativePathSchema).optional()
1764
+ id: nonEmptyStringSchema.describe("A unique identifier for this API source."),
1765
+ type: sourceSpecTypeSchema.describe("The API description format of this source."),
1766
+ name: nonEmptyStringSchema.optional().describe("A human-readable name for this API source."),
1767
+ namespace: nonEmptyStringSchema.optional().describe("A namespace used to isolate this source in a multi-source SDK."),
1768
+ apiImportSettings: apiImportSettingsSchema.optional().describe("Import behavior that overrides the source-level defaults for this spec."),
1769
+ overlays: zod.z.array(relativePathSchema).optional().describe("Relative paths to overlays applied to this source in order."),
1770
+ overrides: zod.z.array(relativePathSchema).optional().describe("Relative paths to source override files applied in order.")
1737
1771
  };
1738
1772
  var sdkConfigV1SourceSpecSchema = zod.z.union(
1739
1773
  [
1740
- zod.z.strictObject({ ...sourceSpecShape, path: relativePathSchema }),
1741
1774
  zod.z.strictObject({
1742
1775
  ...sourceSpecShape,
1743
- url: zod.z.url({ protocol: /^https?$/ })
1776
+ path: relativePathSchema.describe("The relative path to the API source file.")
1777
+ }),
1778
+ zod.z.strictObject({
1779
+ ...sourceSpecShape,
1780
+ url: zod.z.url({ protocol: /^https?$/ }).describe("The HTTP or HTTPS URL of the API source file.")
1744
1781
  })
1745
1782
  ],
1746
1783
  { error: "source spec must contain exactly one locator: path or HTTP(S) url" }
1747
1784
  );
1748
1785
  var sdkConfigV1SourceConfigSchema = zod.z.strictObject({
1749
- specs: zod.z.array(sdkConfigV1SourceSpecSchema).min(1, "source.specs must contain at least one source spec"),
1750
- apiImportSettings: apiImportSettingsSchema.optional()
1786
+ specs: zod.z.array(sdkConfigV1SourceSpecSchema).min(1, "source.specs must contain at least one source spec").describe("API source files in authoritative processing order."),
1787
+ apiImportSettings: apiImportSettingsSchema.optional().describe("Default import behavior shared by every source spec.")
1751
1788
  }).superRefine(({ specs }, context) => {
1752
1789
  const seenIds = /* @__PURE__ */ new Set();
1753
1790
  specs.forEach(({ id }, index) => {
@@ -1762,79 +1799,80 @@ var sdkConfigV1SourceConfigSchema = zod.z.strictObject({
1762
1799
  });
1763
1800
  });
1764
1801
  var cliGenerationConfigSchema = zod.z.strictObject({
1765
- paginationParameters: zod.z.array(nonEmptyStringSchema).optional(),
1766
- skills: zod.z.boolean().optional()
1802
+ paginationParameters: zod.z.array(nonEmptyStringSchema).optional().describe("Request parameter names treated as pagination controls by the CLI."),
1803
+ skills: zod.z.boolean().optional().describe("Whether the generated CLI includes skills that teach AI agents to invoke commands.")
1767
1804
  });
1768
1805
  var csharpGenerationConfigSchema = zod.z.strictObject({
1769
- useOptionalWrapper: zod.z.boolean().optional(),
1770
- simplifyObjectDictionaries: zod.z.boolean().optional(),
1771
- explicitNamespaces: zod.z.boolean().optional(),
1772
- rootNamespaceForCoreClasses: zod.z.boolean().optional(),
1773
- includeExceptionHandler: zod.z.boolean().optional(),
1774
- experimentalExplicitNullableOptional: zod.z.boolean().optional()
1806
+ useOptionalWrapper: zod.z.boolean().optional().describe("Whether optional values use an explicit Optional wrapper."),
1807
+ simplifyObjectDictionaries: zod.z.boolean().optional().describe("Whether object schemas with arbitrary values use simplified dictionary types."),
1808
+ explicitNamespaces: zod.z.boolean().optional().describe("Whether generated resource groups use explicit nested namespaces."),
1809
+ rootNamespaceForCoreClasses: zod.z.boolean().optional().describe("Whether shared client classes are emitted in the root namespace."),
1810
+ includeExceptionHandler: zod.z.boolean().optional().describe("Whether generated client operations use a configurable exception handler."),
1811
+ experimentalExplicitNullableOptional: zod.z.boolean().optional().describe(
1812
+ "Whether optional nullable properties distinguish omitted values from explicit nulls."
1813
+ )
1775
1814
  });
1776
1815
  var goGenerationConfigSchema = zod.z.strictObject({
1777
- legacyComplexModels: zod.z.boolean().optional(),
1816
+ legacyComplexModels: zod.z.boolean().optional().describe("Whether complex models use the legacy Go representation."),
1778
1817
  /** Uppercase common initialisms in generated names (`UserID` rather than `UserId`). */
1779
- smartCasing: zod.z.boolean().optional(),
1818
+ smartCasing: zod.z.boolean().optional().describe("Whether generated Go names capitalize common initialisms."),
1780
1819
  /** Overrides the fern root-client constructor independently from the client type name. */
1781
- clientConstructorName: nonEmptyStringSchema.optional(),
1782
- unionVersion: zod.z.enum(["v0", "v1"]).optional(),
1783
- includeLegacyClientOptions: zod.z.boolean().optional()
1820
+ clientConstructorName: nonEmptyStringSchema.optional().describe("The generated root-client constructor name."),
1821
+ unionVersion: zod.z.enum(["v0", "v1"]).optional().describe("The representation used for generated Go unions."),
1822
+ includeLegacyClientOptions: zod.z.boolean().optional().describe("Whether the client retains legacy constructor option helpers.")
1784
1823
  });
1785
1824
  var jvmGenerationConfigSchema = zod.z.strictObject({
1786
- packageLayout: zod.z.enum(["flat", "nested"]).optional(),
1787
- useLocalDateForDates: zod.z.boolean().optional(),
1788
- collapseOptionalNullable: zod.z.boolean().optional(),
1789
- gradleDistributionUrl: zod.z.string().min(1).optional(),
1790
- gradlePluginManagement: zod.z.string().optional(),
1791
- gradleCentralDependencyManagement: zod.z.boolean().optional(),
1825
+ packageLayout: zod.z.enum(["flat", "nested"]).optional().describe("Whether generated JVM packages use a flat or nested resource layout."),
1826
+ useLocalDateForDates: zod.z.boolean().optional().describe("Whether date-only values use LocalDate instead of OffsetDateTime."),
1827
+ collapseOptionalNullable: zod.z.boolean().optional().describe("Whether optional nullable values collapse into a single nullable representation."),
1828
+ gradleDistributionUrl: zod.z.string().min(1).optional().describe("The Gradle distribution URL written to the generated wrapper."),
1829
+ gradlePluginManagement: zod.z.string().optional().describe("Plugin management configuration added to the generated Gradle settings."),
1830
+ gradleCentralDependencyManagement: zod.z.boolean().optional().describe("Whether dependency versions are managed centrally in the Gradle project."),
1792
1831
  /** Selects co-located async methods or a separate async client surface. */
1793
- asyncStyle: zod.z.enum(["dedicated-client", "twin-methods"]).optional()
1832
+ asyncStyle: zod.z.enum(["dedicated-client", "twin-methods"]).optional().describe("Whether asynchronous operations use a separate client or co-located methods.")
1794
1833
  });
1795
1834
 
1796
1835
  // src/sdk-config-domain/v1/language/java.ts
1797
1836
  var javaGenerationConfigSchema = jvmGenerationConfigSchema.extend({
1798
- includeKotlinSnippets: zod.z.boolean().optional()
1837
+ includeKotlinSnippets: zod.z.boolean().optional().describe("Whether Java SDK documentation includes Kotlin usage snippets.")
1799
1838
  });
1800
1839
 
1801
1840
  // src/sdk-config-domain/v1/language/kotlin.ts
1802
1841
  var kotlinGenerationConfigSchema = jvmGenerationConfigSchema;
1803
1842
  var compilerOptionsSchema = zod.z.strictObject({
1804
- target: nonEmptyStringSchema.optional(),
1805
- module: nonEmptyStringSchema.optional(),
1806
- lib: zod.z.array(nonEmptyStringSchema).optional()
1843
+ target: nonEmptyStringSchema.optional().describe("The JavaScript language target passed to TypeScript."),
1844
+ module: nonEmptyStringSchema.optional().describe("The module format passed to TypeScript."),
1845
+ lib: zod.z.array(nonEmptyStringSchema).optional().describe("The runtime library definitions passed to TypeScript.")
1807
1846
  });
1808
1847
  var packageScriptSchema = zod.z.strictObject({
1809
- name: nonEmptyStringSchema,
1810
- command: nonEmptyStringSchema
1848
+ name: nonEmptyStringSchema.describe("The package script name."),
1849
+ command: nonEmptyStringSchema.describe("The command executed by the package script.")
1811
1850
  });
1812
1851
  var httpClientSchema = zod.z.strictObject({
1813
- name: zod.z.enum(["axios", "fetch"])
1852
+ name: zod.z.enum(["axios", "fetch"]).describe("The HTTP client used by generated TypeScript code.")
1814
1853
  });
1815
1854
  var typescriptGenerationConfigSchema = zod.z.strictObject({
1816
- typescriptVersion: nonEmptyStringSchema.optional(),
1817
- zodVersion: nonEmptyStringSchema.optional(),
1818
- compilerOptions: compilerOptionsSchema.optional(),
1819
- httpClient: httpClientSchema.optional(),
1820
- packageManager: zod.z.enum(["pnpm", "yarn"]).optional(),
1821
- /** e.g. `1.22.22` — from the customer's own `config.packageJson.packageManager` (`yarn@1.22.22`). */
1822
- packageManagerVersion: nonEmptyStringSchema.optional(),
1823
- testFramework: zod.z.enum(["jest", "vitest"]).optional(),
1824
- namingStrategy: zod.z.enum(["base", "originalPropertyNames"]).optional(),
1825
- bundle: zod.z.boolean().optional(),
1826
- exportClassDefault: zod.z.boolean().optional(),
1855
+ typescriptVersion: nonEmptyStringSchema.optional().describe("The TypeScript version used by the generated project."),
1856
+ zodVersion: nonEmptyStringSchema.optional().describe("The Zod version used by generated runtime schemas."),
1857
+ compilerOptions: compilerOptionsSchema.optional().describe("TypeScript compiler options for the generated project."),
1858
+ httpClient: httpClientSchema.optional().describe("The HTTP client used by generated TypeScript code."),
1859
+ packageManager: zod.z.enum(["pnpm", "yarn"]).optional().describe("The package manager used by the generated project."),
1860
+ packageManagerVersion: nonEmptyStringSchema.optional().describe("The package manager version used by the generated project."),
1861
+ testFramework: zod.z.enum(["jest", "vitest"]).optional().describe("The test framework used by generated tests."),
1862
+ namingStrategy: zod.z.enum(["base", "originalPropertyNames"]).optional().describe("How schema property names are converted into TypeScript identifiers."),
1863
+ bundle: zod.z.boolean().optional().describe("Whether the generated package includes bundled output."),
1864
+ exportClassDefault: zod.z.boolean().optional().describe("Whether the client class is also exported as the default export."),
1827
1865
  /** Name of the top-level namespace export emitted by Fern-compatible TypeScript SDKs. */
1828
- namespaceExportName: nonEmptyStringSchema.optional(),
1829
- consolidateTypeFiles: zod.z.boolean().optional(),
1830
- allowCustomFetcher: zod.z.boolean().optional(),
1831
- useBrandedStringAliases: zod.z.boolean().optional(),
1832
- useLegacyExports: zod.z.boolean().optional(),
1833
- useBigInt: zod.z.boolean().optional(),
1834
- serdeLayer: zod.z.boolean().optional(),
1866
+ namespaceExportName: nonEmptyStringSchema.optional().describe("The top-level namespace export name."),
1867
+ consolidateTypeFiles: zod.z.boolean().optional().describe("Whether generated types are consolidated into fewer source files."),
1868
+ allowCustomFetcher: zod.z.boolean().optional().describe("Whether callers can supply a custom fetch implementation."),
1869
+ useBrandedStringAliases: zod.z.boolean().optional().describe("Whether string aliases are emitted as distinct branded types."),
1870
+ useLegacyExports: zod.z.boolean().optional().describe("Whether the package emits the legacy export layout."),
1871
+ useBigInt: zod.z.boolean().optional().describe("Whether 64-bit integer values are represented with bigint."),
1872
+ serdeLayer: zod.z.boolean().optional().describe("Whether generated models use Fern serialization and deserialization helpers."),
1835
1873
  /** Ship only the ESM build (drops CJS) to avoid the Node dual-package hazard. */
1836
- esmOnly: zod.z.boolean().optional(),
1837
- scripts: zod.z.array(packageScriptSchema).optional()
1874
+ esmOnly: zod.z.boolean().optional().describe("Whether the package emits only ECMAScript modules."),
1875
+ scripts: zod.z.array(packageScriptSchema).optional().describe("Additional scripts added to the generated package manifest.")
1838
1876
  });
1839
1877
 
1840
1878
  // src/sdk-config-domain/v1/language/mcp.ts
@@ -1849,172 +1887,183 @@ var mcpAvailabilityStatuses = [
1849
1887
  "LEGACY"
1850
1888
  ];
1851
1889
  var mcpToolFilterSchema = zod.z.strictObject({
1852
- include: zod.z.array(nonEmptyStringSchema).optional(),
1853
- exclude: zod.z.array(nonEmptyStringSchema).optional()
1890
+ include: zod.z.array(nonEmptyStringSchema).optional().describe("Operations explicitly included as MCP tools."),
1891
+ exclude: zod.z.array(nonEmptyStringSchema).optional().describe("Operations explicitly excluded from MCP tools.")
1854
1892
  });
1855
1893
  var mcpToolsetNameSchema = nonEmptyStringSchema.refine(
1856
1894
  (name) => name !== "default" && /^[a-z0-9-]+$/.test(name),
1857
1895
  'toolset names must match [a-z0-9-]+ and cannot be "default"'
1858
1896
  );
1859
1897
  var mcpGenerationConfigSchema = typescriptGenerationConfigSchema.extend({
1860
- serverName: nonEmptyStringSchema.optional(),
1861
- serverDescription: nonEmptyStringSchema.optional(),
1862
- excludeAvailability: zod.z.array(zod.z.enum(mcpAvailabilityStatuses)).optional(),
1863
- tools: mcpToolFilterSchema.optional(),
1864
- toolsets: zod.z.record(mcpToolsetNameSchema, mcpToolFilterSchema).optional()
1898
+ serverName: nonEmptyStringSchema.optional().describe("The name advertised by the generated MCP server."),
1899
+ serverDescription: nonEmptyStringSchema.optional().describe("The description advertised by the generated MCP server."),
1900
+ excludeAvailability: zod.z.array(zod.z.enum(mcpAvailabilityStatuses)).optional().describe("Operation availability statuses excluded from MCP tool generation."),
1901
+ tools: mcpToolFilterSchema.optional().describe("Global operation filters for generated MCP tools."),
1902
+ toolsets: zod.z.record(mcpToolsetNameSchema, mcpToolFilterSchema).optional().describe("Named MCP toolsets and the operation filters for each toolset.")
1865
1903
  });
1866
1904
  var phpGenerationConfigSchema = zod.z.strictObject({
1867
- propertyAccess: zod.z.enum(["public", "private"]).optional(),
1868
- generateClientInterfaces: zod.z.boolean().optional()
1905
+ propertyAccess: zod.z.enum(["public", "private"]).optional().describe("The visibility of generated PHP model properties."),
1906
+ generateClientInterfaces: zod.z.boolean().optional().describe("Whether interfaces are generated for PHP client classes.")
1869
1907
  });
1870
1908
  var pythonClientSchema = zod.z.strictObject({
1871
- fileName: nonEmptyStringSchema.optional(),
1872
- exportedFileName: nonEmptyStringSchema.optional()
1909
+ fileName: nonEmptyStringSchema.optional().describe("The source file name for the Python client."),
1910
+ exportedFileName: nonEmptyStringSchema.optional().describe("The file name used when exporting the Python client.")
1873
1911
  });
1874
1912
  var pydanticConfigSchema = zod.z.strictObject({
1875
- versionCompatibility: zod.z.enum(["v1", "v2", "both", "v1-on-v2"]).optional(),
1876
- frozen: zod.z.boolean().optional(),
1877
- requireOptionalFields: zod.z.boolean().optional(),
1878
- unionNaming: zod.z.enum(["v0", "v1"]).optional(),
1879
- useFieldAliases: zod.z.boolean().optional()
1913
+ versionCompatibility: zod.z.enum(["v1", "v2", "both", "v1-on-v2"]).optional().describe("The Pydantic major versions supported by generated models."),
1914
+ frozen: zod.z.boolean().optional().describe("Whether generated Pydantic models are immutable."),
1915
+ requireOptionalFields: zod.z.boolean().optional().describe("Whether Optional fields remain required unless they declare a default."),
1916
+ unionNaming: zod.z.enum(["v0", "v1"]).optional().describe("The naming strategy for generated union types."),
1917
+ useFieldAliases: zod.z.boolean().optional().describe("Whether Pydantic field aliases preserve wire names.")
1880
1918
  });
1881
1919
  var additionalInitExportSchema = zod.z.strictObject({
1882
- from: nonEmptyStringSchema,
1883
- imports: zod.z.array(nonEmptyStringSchema).min(1)
1920
+ from: nonEmptyStringSchema.describe("The module from which names are re-exported."),
1921
+ imports: zod.z.array(nonEmptyStringSchema).min(1).describe("Names re-exported from the module.")
1884
1922
  });
1885
1923
  var pythonGenerationConfigSchema = zod.z.strictObject({
1886
- pythonVersion: nonEmptyStringSchema.optional(),
1887
- pydanticVersion: nonEmptyStringSchema.optional(),
1888
- pydantic: pydanticConfigSchema.optional(),
1889
- client: pythonClientSchema.optional(),
1924
+ pythonVersion: nonEmptyStringSchema.optional().describe("The Python version targeted by the generated project."),
1925
+ pydanticVersion: nonEmptyStringSchema.optional().describe("The Pydantic dependency version requirement."),
1926
+ pydantic: pydanticConfigSchema.optional().describe("Pydantic model-generation behavior."),
1927
+ client: pythonClientSchema.optional().describe("Python client file naming."),
1890
1928
  /** Default followed by generated sync and async HTTP clients when the caller does not override it. */
1891
- followRedirectsByDefault: zod.z.boolean().optional(),
1929
+ followRedirectsByDefault: zod.z.boolean().optional().describe("Whether generated HTTP clients follow redirects by default."),
1892
1930
  /** Chunk size passed to Python byte-stream iterators. */
1893
- defaultBytesStreamChunkSize: zod.z.number().int().positive().optional(),
1931
+ defaultBytesStreamChunkSize: zod.z.number().int().positive().optional().describe("The default byte-stream iterator chunk size."),
1894
1932
  /** Python interpreter recursion limit installed by the generated package at import time. */
1895
- recursionLimit: zod.z.number().int().gt(1e3).optional(),
1933
+ recursionLimit: zod.z.number().int().gt(1e3).optional().describe("The Python recursion limit installed when the generated package is imported."),
1896
1934
  /** Published Python extras, keyed by extra name with package dependency names as values. */
1897
- extras: zod.z.record(nonEmptyStringSchema, zod.z.array(nonEmptyStringSchema)).optional(),
1898
- alwaysInitializeOptionals: zod.z.boolean().optional(),
1899
- useTypedDictRequests: zod.z.boolean().optional(),
1900
- additionalInitExports: zod.z.array(additionalInitExportSchema).optional()
1935
+ extras: zod.z.record(nonEmptyStringSchema, zod.z.array(nonEmptyStringSchema)).optional().describe("Published Python extras and their dependency names."),
1936
+ alwaysInitializeOptionals: zod.z.boolean().optional().describe("Whether optional model fields are initialized even when omitted."),
1937
+ useTypedDictRequests: zod.z.boolean().optional().describe("Whether request bodies are generated as TypedDict types."),
1938
+ additionalInitExports: zod.z.array(additionalInitExportSchema).optional().describe("Additional names re-exported from the package initializer.")
1901
1939
  });
1902
1940
  var rubyGenerationConfigSchema = zod.z.strictObject({
1903
- requirePaths: zod.z.array(nonEmptyStringSchema).optional()
1941
+ requirePaths: zod.z.array(nonEmptyStringSchema).optional().describe("Ruby load paths included in the generated gem specification.")
1904
1942
  });
1905
1943
  var rustGenerationConfigSchema = zod.z.strictObject({
1906
1944
  /**
1907
1945
  * Rust type for datetime primitives. `offset` maps to `DateTime<FixedOffset>` and preserves the
1908
1946
  * timezone the payload carried; `utc` maps to `DateTime<Utc>` and normalizes to UTC.
1909
1947
  */
1910
- dateTimeType: zod.z.enum(["offset", "utc"]).optional(),
1948
+ dateTimeType: zod.z.enum(["offset", "utc"]).optional().describe("Whether datetime values preserve their offset or normalize to UTC."),
1911
1949
  /** Uppercase common initialisms in generated names (`UserID` rather than `UserId`). */
1912
- capitalizeInitialisms: zod.z.boolean().optional(),
1950
+ capitalizeInitialisms: zod.z.boolean().optional().describe("Whether generated Rust names capitalize common initialisms."),
1913
1951
  /** Cargo features, mapping a feature name to the dependencies or features it enables. */
1914
- features: zod.z.record(zod.z.string(), zod.z.array(nonEmptyStringSchema)).optional(),
1952
+ features: zod.z.record(zod.z.string(), zod.z.array(nonEmptyStringSchema)).optional().describe("Cargo features and the dependencies or features each enables."),
1915
1953
  /** Overrides which features make up Cargo's `default` feature set. */
1916
- defaultFeatures: zod.z.array(nonEmptyStringSchema).optional()
1954
+ defaultFeatures: zod.z.array(nonEmptyStringSchema).optional().describe("Cargo features included in the crate default feature set.")
1917
1955
  });
1918
1956
  var swiftGenerationConfigSchema = zod.z.strictObject({
1919
- moduleName: nonEmptyStringSchema.optional(),
1920
- nullableAsOptional: zod.z.boolean().optional()
1957
+ moduleName: nonEmptyStringSchema.optional().describe("The Swift module name for the generated package."),
1958
+ nullableAsOptional: zod.z.boolean().optional().describe("Whether nullable values are represented as Swift optionals.")
1921
1959
  });
1922
1960
  var planModifierSourceSchema = zod.z.discriminatedUnion("enabled", [
1923
- zod.z.strictObject({ enabled: zod.z.literal(true), sourceDir: nonEmptyStringSchema }),
1924
- zod.z.strictObject({ enabled: zod.z.literal(false) })
1961
+ zod.z.strictObject({
1962
+ enabled: zod.z.literal(true).describe("Enables custom Terraform plan modifiers."),
1963
+ sourceDir: nonEmptyStringSchema.describe(
1964
+ "The directory containing custom plan modifier source files."
1965
+ )
1966
+ }),
1967
+ zod.z.strictObject({
1968
+ enabled: zod.z.literal(false).describe("Disables custom Terraform plan modifiers.")
1969
+ })
1925
1970
  ]);
1926
1971
  var planModifiersSchema = zod.z.strictObject({
1927
- resources: planModifierSourceSchema,
1928
- attributes: planModifierSourceSchema
1972
+ resources: planModifierSourceSchema.describe("Custom plan modifiers for generated resources."),
1973
+ attributes: planModifierSourceSchema.describe("Custom plan modifiers for generated attributes.")
1929
1974
  });
1930
1975
  var providerSchemaSchema = zod.z.strictObject({
1931
- addressKey: nonEmptyStringSchema,
1932
- authTokenKey: nonEmptyStringSchema
1976
+ addressKey: nonEmptyStringSchema.describe(
1977
+ "The provider attribute used to configure the API address."
1978
+ ),
1979
+ authTokenKey: nonEmptyStringSchema.describe(
1980
+ "The provider attribute used to configure the authentication token."
1981
+ )
1933
1982
  });
1934
1983
  var terraformGenerationConfigSchema = zod.z.strictObject({
1935
- providerName: nonEmptyStringSchema.optional(),
1936
- providerVersion: nonEmptyStringSchema.optional(),
1937
- providerModulePath: goModulePathSchema.optional(),
1938
- mockAcceptance: zod.z.boolean().optional(),
1939
- hideComputedDiff: zod.z.boolean().optional(),
1940
- providerSchema: providerSchemaSchema.optional(),
1941
- planModifiers: planModifiersSchema.optional()
1984
+ providerName: nonEmptyStringSchema.optional().describe("The Terraform provider name."),
1985
+ providerVersion: nonEmptyStringSchema.optional().describe("The generated Terraform provider version."),
1986
+ providerModulePath: goModulePathSchema.optional().describe("The Go module path for the generated provider."),
1987
+ mockAcceptance: zod.z.boolean().optional().describe("Whether acceptance tests use a mock API server."),
1988
+ hideComputedDiff: zod.z.boolean().optional().describe("Whether computed-only changes are hidden from Terraform plans."),
1989
+ providerSchema: providerSchemaSchema.optional().describe("Names of provider-level configuration attributes."),
1990
+ planModifiers: planModifiersSchema.optional().describe("Custom plan modifier source configuration.")
1942
1991
  });
1943
1992
 
1944
1993
  // src/sdk-config/v1/target.ts
1945
1994
  var targetOverrideShape = {
1946
- generatorVersion: exactSemverSchema.optional(),
1947
- sdkName: nonEmptyStringSchema.optional(),
1948
- sdkVersion: nonEmptyStringSchema.optional(),
1949
- client: sdkConfigV1ClientConfigOverrideSchema.optional(),
1950
- docs: sdkConfigV1DocsConfigSchema.optional(),
1951
- package: sdkConfigV1PackageConfigSchema.optional(),
1952
- output: sdkConfigV1OutputConfigSchema.optional()
1995
+ generatorVersion: exactSemverSchema.optional().describe("The exact generator version used for this target."),
1996
+ sdkName: nonEmptyStringSchema.optional().describe("An SDK name that overrides the root value for this target."),
1997
+ sdkVersion: nonEmptyStringSchema.optional().describe("An SDK version that overrides the root value for this target."),
1998
+ client: sdkConfigV1ClientConfigOverrideSchema.optional().describe("Client settings that override root client configuration for this target."),
1999
+ docs: sdkConfigV1DocsConfigSchema.optional().describe("Documentation settings that override root documentation for this target."),
2000
+ package: sdkConfigV1PackageConfigSchema.optional().describe("Package metadata that overrides root package configuration for this target."),
2001
+ output: sdkConfigV1OutputConfigSchema.optional().describe("Output configuration that replaces the root output for this target.")
1953
2002
  };
1954
2003
  var sdkConfigV1TargetSchema = zod.z.discriminatedUnion("language", [
1955
2004
  zod.z.strictObject({
1956
- language: zod.z.literal("typescript"),
1957
- generation: sdkConfigV1GenerationConfigOverrideSchema.extend(typescriptGenerationConfigSchema.shape).optional(),
2005
+ language: zod.z.literal("typescript").describe("Generates a TypeScript SDK."),
2006
+ generation: sdkConfigV1GenerationConfigOverrideSchema.extend(typescriptGenerationConfigSchema.shape).optional().describe("Common and TypeScript-specific generation settings for this target."),
1958
2007
  ...targetOverrideShape
1959
2008
  }),
1960
2009
  zod.z.strictObject({
1961
- language: zod.z.literal("python"),
1962
- generation: sdkConfigV1GenerationConfigOverrideSchema.extend(pythonGenerationConfigSchema.shape).optional(),
2010
+ language: zod.z.literal("python").describe("Generates a Python SDK."),
2011
+ generation: sdkConfigV1GenerationConfigOverrideSchema.extend(pythonGenerationConfigSchema.shape).optional().describe("Common and Python-specific generation settings for this target."),
1963
2012
  ...targetOverrideShape
1964
2013
  }),
1965
2014
  zod.z.strictObject({
1966
- language: zod.z.literal("java"),
1967
- generation: sdkConfigV1GenerationConfigOverrideSchema.extend(javaGenerationConfigSchema.shape).optional(),
2015
+ language: zod.z.literal("java").describe("Generates a Java SDK."),
2016
+ generation: sdkConfigV1GenerationConfigOverrideSchema.extend(javaGenerationConfigSchema.shape).optional().describe("Common and Java-specific generation settings for this target."),
1968
2017
  ...targetOverrideShape
1969
2018
  }),
1970
2019
  zod.z.strictObject({
1971
- language: zod.z.literal("kotlin"),
1972
- generation: sdkConfigV1GenerationConfigOverrideSchema.extend(kotlinGenerationConfigSchema.shape).optional(),
2020
+ language: zod.z.literal("kotlin").describe("Generates a Kotlin SDK."),
2021
+ generation: sdkConfigV1GenerationConfigOverrideSchema.extend(kotlinGenerationConfigSchema.shape).optional().describe("Common and Kotlin-specific generation settings for this target."),
1973
2022
  ...targetOverrideShape
1974
2023
  }),
1975
2024
  zod.z.strictObject({
1976
- language: zod.z.literal("go"),
1977
- generation: sdkConfigV1GenerationConfigOverrideSchema.extend(goGenerationConfigSchema.shape).optional(),
2025
+ language: zod.z.literal("go").describe("Generates a Go SDK."),
2026
+ generation: sdkConfigV1GenerationConfigOverrideSchema.extend(goGenerationConfigSchema.shape).optional().describe("Common and Go-specific generation settings for this target."),
1978
2027
  ...targetOverrideShape
1979
2028
  }),
1980
2029
  zod.z.strictObject({
1981
- language: zod.z.literal("csharp"),
1982
- generation: sdkConfigV1GenerationConfigOverrideSchema.extend(csharpGenerationConfigSchema.shape).optional(),
2030
+ language: zod.z.literal("csharp").describe("Generates a C# SDK."),
2031
+ generation: sdkConfigV1GenerationConfigOverrideSchema.extend(csharpGenerationConfigSchema.shape).optional().describe("Common and C#-specific generation settings for this target."),
1983
2032
  ...targetOverrideShape
1984
2033
  }),
1985
2034
  zod.z.strictObject({
1986
- language: zod.z.literal("php"),
1987
- generation: sdkConfigV1GenerationConfigOverrideSchema.extend(phpGenerationConfigSchema.shape).optional(),
2035
+ language: zod.z.literal("php").describe("Generates a PHP SDK."),
2036
+ generation: sdkConfigV1GenerationConfigOverrideSchema.extend(phpGenerationConfigSchema.shape).optional().describe("Common and PHP-specific generation settings for this target."),
1988
2037
  ...targetOverrideShape
1989
2038
  }),
1990
2039
  zod.z.strictObject({
1991
- language: zod.z.literal("ruby"),
1992
- generation: sdkConfigV1GenerationConfigOverrideSchema.extend(rubyGenerationConfigSchema.shape).optional(),
2040
+ language: zod.z.literal("ruby").describe("Generates a Ruby SDK."),
2041
+ generation: sdkConfigV1GenerationConfigOverrideSchema.extend(rubyGenerationConfigSchema.shape).optional().describe("Common and Ruby-specific generation settings for this target."),
1993
2042
  ...targetOverrideShape
1994
2043
  }),
1995
2044
  zod.z.strictObject({
1996
- language: zod.z.literal("rust"),
1997
- generation: sdkConfigV1GenerationConfigOverrideSchema.extend(rustGenerationConfigSchema.shape).optional(),
2045
+ language: zod.z.literal("rust").describe("Generates a Rust SDK."),
2046
+ generation: sdkConfigV1GenerationConfigOverrideSchema.extend(rustGenerationConfigSchema.shape).optional().describe("Common and Rust-specific generation settings for this target."),
1998
2047
  ...targetOverrideShape
1999
2048
  }),
2000
2049
  zod.z.strictObject({
2001
- language: zod.z.literal("swift"),
2002
- generation: sdkConfigV1GenerationConfigOverrideSchema.extend(swiftGenerationConfigSchema.shape).optional(),
2050
+ language: zod.z.literal("swift").describe("Generates a Swift SDK."),
2051
+ generation: sdkConfigV1GenerationConfigOverrideSchema.extend(swiftGenerationConfigSchema.shape).optional().describe("Common and Swift-specific generation settings for this target."),
2003
2052
  ...targetOverrideShape
2004
2053
  }),
2005
2054
  zod.z.strictObject({
2006
- language: zod.z.literal("cli"),
2007
- generation: sdkConfigV1GenerationConfigOverrideSchema.extend(cliGenerationConfigSchema.shape).optional(),
2055
+ language: zod.z.literal("cli").describe("Generates a command-line interface."),
2056
+ generation: sdkConfigV1GenerationConfigOverrideSchema.extend(cliGenerationConfigSchema.shape).optional().describe("Common and CLI-specific generation settings for this target."),
2008
2057
  ...targetOverrideShape
2009
2058
  }),
2010
2059
  zod.z.strictObject({
2011
- language: zod.z.literal("mcp"),
2012
- generation: sdkConfigV1GenerationConfigOverrideSchema.extend(mcpGenerationConfigSchema.shape).optional(),
2060
+ language: zod.z.literal("mcp").describe("Generates an MCP server."),
2061
+ generation: sdkConfigV1GenerationConfigOverrideSchema.extend(mcpGenerationConfigSchema.shape).optional().describe("Common and MCP-specific generation settings for this target."),
2013
2062
  ...targetOverrideShape
2014
2063
  }),
2015
2064
  zod.z.strictObject({
2016
- language: zod.z.literal("terraform"),
2017
- generation: sdkConfigV1GenerationConfigOverrideSchema.extend(terraformGenerationConfigSchema.shape).optional(),
2065
+ language: zod.z.literal("terraform").describe("Generates a Terraform provider."),
2066
+ generation: sdkConfigV1GenerationConfigOverrideSchema.extend(terraformGenerationConfigSchema.shape).optional().describe("Common and Terraform-specific generation settings for this target."),
2018
2067
  ...targetOverrideShape
2019
2068
  })
2020
2069
  ]);
@@ -2107,19 +2156,21 @@ function validateTargetPublishing(target, targetIndex, globalPackage, globalOutp
2107
2156
  );
2108
2157
  }
2109
2158
  var sdkConfigV1Schema = zod.z.strictObject({
2110
- schemaVersion: zod.z.literal(SDK_CONFIG_V1_SCHEMA_VERSION),
2111
- sdkName: nonEmptyStringSchema,
2112
- sdkVersion: nonEmptyStringSchema.default("1.0.0"),
2113
- apiVersion: nonEmptyStringSchema.optional(),
2114
- source: sdkConfigV1SourceConfigSchema,
2115
- api: sdkConfigV1ApiConfigSchema.prefault({}),
2116
- client: sdkConfigV1ClientConfigSchema.prefault({}),
2117
- package: sdkConfigV1PackageConfigSchema.prefault({}),
2118
- output: sdkConfigV1OutputConfigSchema.optional(),
2119
- replay: sdkConfigV1ReplayConfigSchema.optional(),
2120
- docs: sdkConfigV1DocsConfigSchema.prefault({}),
2121
- generation: sdkConfigV1GenerationConfigSchema.prefault({}),
2122
- targets: zod.z.array(sdkConfigV1TargetSchema).min(1)
2159
+ schemaVersion: zod.z.literal(SDK_CONFIG_V1_SCHEMA_VERSION).describe("The version of the customer-facing SDK Config schema."),
2160
+ sdkName: nonEmptyStringSchema.describe("The default name used for generated SDKs."),
2161
+ sdkVersion: nonEmptyStringSchema.default("1.0.0").describe("The default version assigned to generated SDKs."),
2162
+ apiVersion: nonEmptyStringSchema.optional().describe("The version of the API represented by the generated SDKs."),
2163
+ source: sdkConfigV1SourceConfigSchema.describe(
2164
+ "The API descriptions used to generate the SDKs."
2165
+ ),
2166
+ api: sdkConfigV1ApiConfigSchema.prefault({}).describe("Shared API behavior for every target."),
2167
+ client: sdkConfigV1ClientConfigSchema.prefault({}).describe("Shared generated-client behavior for every target."),
2168
+ package: sdkConfigV1PackageConfigSchema.prefault({}).describe("Package metadata inherited by every target."),
2169
+ output: sdkConfigV1OutputConfigSchema.optional().describe("The default output delivery and publication configuration."),
2170
+ replay: sdkConfigV1ReplayConfigSchema.optional().describe("Generation replay behavior shared by every target."),
2171
+ docs: sdkConfigV1DocsConfigSchema.prefault({}).describe("Documentation settings inherited by every target."),
2172
+ generation: sdkConfigV1GenerationConfigSchema.prefault({}).describe("Generation settings inherited by every target."),
2173
+ targets: zod.z.array(sdkConfigV1TargetSchema).min(1).describe("Language targets to generate; each language may appear once.")
2123
2174
  }).superRefine(({ output, package: globalPackage, targets }, context) => {
2124
2175
  const configuredLanguages = /* @__PURE__ */ new Set();
2125
2176
  targets.forEach((target, targetIndex) => {
@@ -2381,6 +2432,14 @@ function mapInvocation(generator, language, activeLanguages, index) {
2381
2432
  ...prefix,
2382
2433
  "config"
2383
2434
  ]);
2435
+ const apiWideIdempotency = idempotencyKeyGenerationFrom(
2436
+ generator.idempotencyKeyGenerationConfig,
2437
+ [...prefix, "idempotencyKeyGenerationConfig"],
2438
+ state
2439
+ );
2440
+ if (apiWideIdempotency && client.idempotencyKeyGeneration === void 0) {
2441
+ client.idempotencyKeyGeneration = apiWideIdempotency;
2442
+ }
2384
2443
  const rawGenerator = isObject(generator.raw) ? generator.raw : void 0;
2385
2444
  const smartCasing = typeof rawGenerator?.["smart-casing"] === "boolean" ? rawGenerator["smart-casing"] : generator.smartCasing === false ? false : void 0;
2386
2445
  const smartCasingDigitWordBoundary = typeof rawGenerator?.["smart-casing-digit-word-boundary"] === "boolean" ? rawGenerator["smart-casing-digit-word-boundary"] : generator.smartCasingDigitWordBoundary === true ? true : void 0;
@@ -2399,9 +2458,6 @@ function mapInvocation(generator, language, activeLanguages, index) {
2399
2458
  if (generator.keywords?.length) {
2400
2459
  generation.reservedKeywords = [...generator.keywords];
2401
2460
  }
2402
- if (generator.generateFullProject !== void 0) {
2403
- generation.generateFullProject = generator.generateFullProject;
2404
- }
2405
2461
  const settings = isObject(generator.settings) ? generator.settings : void 0;
2406
2462
  if (settings) {
2407
2463
  const inlinePathParameters = takeBoolean(settings, ["inlinePathParameters"], state, [
@@ -2417,21 +2473,25 @@ function mapInvocation(generator, language, activeLanguages, index) {
2417
2473
  ...collectUnsupported(config, [...prefix, "config"], state),
2418
2474
  ...settings ? collectUnsupported(settings, [...prefix, "settings"], state) : [],
2419
2475
  ...isObject(generator.readme) ? collectUnsupported(generator.readme, [...prefix, "readme"], state) : [],
2420
- ...unsupportedResolvedFields(generator, index)
2476
+ ...unsupportedResolvedFields(generator, index, apiWideIdempotency !== void 0)
2421
2477
  ];
2422
2478
  return { client, docs, generation, package: packageConfig, targetGeneration, unsupportedFields };
2423
2479
  }
2424
- function unsupportedResolvedFields(generator, index) {
2480
+ function unsupportedResolvedFields(generator, index, idempotencyMapped) {
2425
2481
  const values = [
2426
2482
  ["automation", isDefaultAutomation(generator.automation) ? void 0 : generator.automation],
2427
2483
  ["containerImage", generator.containerImage],
2428
2484
  ["irVersionOverride", generator.irVersionOverride],
2429
- ["idempotencyKeyGenerationConfig", generator.idempotencyKeyGenerationConfig],
2485
+ [
2486
+ "idempotencyKeyGenerationConfig",
2487
+ idempotencyMapped ? void 0 : generator.idempotencyKeyGenerationConfig
2488
+ ],
2430
2489
  ["absolutePathToLocalSnippets", generator.absolutePathToLocalSnippets],
2431
2490
  [
2432
2491
  "disableExamples",
2433
2492
  generator.disableExamples === false ? void 0 : generator.disableExamples
2434
2493
  ],
2494
+ ["generateFullProject", generator.generateFullProject],
2435
2495
  ["apiOverride", generator.apiOverride]
2436
2496
  ];
2437
2497
  return values.flatMap(([field, value]) => {
@@ -2458,7 +2518,13 @@ function resolvedFieldGuidance(field) {
2458
2518
  }
2459
2519
  if (field === "idempotencyKeyGenerationConfig") {
2460
2520
  return {
2461
- suggestedAction: "Preserve this orchestration setting outside SDK Config; public v1 has no idempotency-generation field."
2521
+ sdkConfigPath: ["client", "idempotencyKeyGeneration"],
2522
+ suggestedAction: "Use true, false, or an object with header-name and methods, or set client.idempotencyKeyGeneration manually."
2523
+ };
2524
+ }
2525
+ if (field === "generateFullProject") {
2526
+ return {
2527
+ suggestedAction: "Preserve this packaging setting on the generation request; it is not customer-authored SDK configuration."
2462
2528
  };
2463
2529
  }
2464
2530
  return {
@@ -2468,6 +2534,20 @@ function resolvedFieldGuidance(field) {
2468
2534
  function isDefaultAutomation(value) {
2469
2535
  return isObject(value) && value.generate === true && value.upgrade === true && value.preview === true && value.verify === true;
2470
2536
  }
2537
+ var HTTP_METHODS = ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"];
2538
+ function idempotencyKeyGenerationFrom(value, path, state) {
2539
+ if (typeof value === "boolean") {
2540
+ consume(state, path);
2541
+ return { enabled: value };
2542
+ }
2543
+ if (!isObject(value)) return void 0;
2544
+ const probe = { consumedPaths: /* @__PURE__ */ new Set() };
2545
+ const headerName = takeString(value, ["headerName"], probe, path);
2546
+ const methods = takeEnumArray(value, ["methods"], HTTP_METHODS, probe, path);
2547
+ if (probe.consumedPaths.size !== Object.keys(value).length) return void 0;
2548
+ consume(state, path);
2549
+ return { enabled: true, ...optional("headerName", headerName), ...optional("methods", methods) };
2550
+ }
2471
2551
  function mapCommonConfig(language, config, state, client, generation, packageConfig, basePath) {
2472
2552
  const inlinePath = takeBoolean(config, ["inlinePathParameters"], state, basePath);
2473
2553
  const inlineFile = takeBoolean(config, ["inlineFileProperties"], state, basePath);
@@ -2492,6 +2572,23 @@ function mapCommonConfig(language, config, state, client, generation, packageCon
2492
2572
  if (useDefaults !== void 0) client.useDefaultRequestParameterValues = useDefaults;
2493
2573
  const respectOptionalBody = takeBoolean(config, ["respectOptionalRequestBody"], state, basePath);
2494
2574
  if (respectOptionalBody !== void 0) client.respectOptionalRequestBody = respectOptionalBody;
2575
+ const idempotency = locate(config, ["autoGenerateIdempotencyKey"], basePath);
2576
+ const idempotencyKeyGeneration = idempotency && idempotencyKeyGenerationFrom(idempotency.value, idempotency.path, state);
2577
+ if (idempotencyKeyGeneration) client.idempotencyKeyGeneration = idempotencyKeyGeneration;
2578
+ const userAgent = compact({
2579
+ template: takeString(config, ["userAgent"], state, basePath),
2580
+ includePlatformInfo: takeBoolean(config, ["includePlatformHeaders"], state, basePath),
2581
+ allowAppInfo: takeBoolean(config, ["allowUserAgentAppInfo"], state, basePath)
2582
+ });
2583
+ if (Object.keys(userAgent).length) client.userAgent = userAgent;
2584
+ const offsetSemantics = takeEnum(
2585
+ config,
2586
+ ["offsetSemantics"],
2587
+ ["item-index", "page-index"],
2588
+ state,
2589
+ basePath
2590
+ );
2591
+ if (offsetSemantics !== void 0) client.offsetSemantics = offsetSemantics;
2495
2592
  const maxRetries = takeNumber(config, ["maxRetries"], state, basePath);
2496
2593
  const statusCodeProfile = takeEnum(
2497
2594
  config,
@@ -2509,7 +2606,10 @@ function mapCommonConfig(language, config, state, client, generation, packageCon
2509
2606
  const pythonClient = language === "python" ? takeObject(config, ["client"], state, basePath) : void 0;
2510
2607
  const typescriptNaming = language === "typescript" || language === "mcp" ? takeObject(config, ["naming"], state, basePath) : void 0;
2511
2608
  const directClientName = takeString(config, ["clientName", "clientClassName"], state, basePath);
2512
- const nestedClientName = pythonClient ? takeString(pythonClient.value, ["className"], state, pythonClient.path) : typescriptNaming ? takeString(typescriptNaming.value, ["client"], state, typescriptNaming.path) : void 0;
2609
+ const nestedClientName = pythonClient ? takeString(pythonClient.value, ["className"], state, pythonClient.path) : typescriptNaming ? takeString(typescriptNaming.value, ["client"], state, typescriptNaming.path) : language === "ruby" ? (
2610
+ // Fern's Ruby generator renames the root client class (`Auth0::Management`) with it.
2611
+ takeString(config, ["clientModuleName"], state, basePath)
2612
+ ) : void 0;
2513
2613
  const directExportedClientName = takeString(
2514
2614
  config,
2515
2615
  ["exportedClientName", "exportedClientClassName"],
@@ -2551,8 +2651,6 @@ function mapCommonConfig(language, config, state, client, generation, packageCon
2551
2651
  const streams = mapTypescriptStreams(config, state, basePath);
2552
2652
  if (streams) generation.streams = streams;
2553
2653
  }
2554
- const generateFullProject = takeBoolean(config, ["generateFullProject"], state, basePath);
2555
- if (generateFullProject !== void 0) generation.generateFullProject = generateFullProject;
2556
2654
  const inlineTypes = takeBoolean(config, ["enableInlineTypes"], state, basePath);
2557
2655
  const omitUndefined = takeBoolean(config, ["omitUndefined"], state, basePath);
2558
2656
  const forwardEnums = takeBoolean(config, ["enableForwardCompatibleEnums"], state, basePath);
@@ -2782,6 +2880,8 @@ function mapComposerRequirements(manifest, state, packageConfig) {
2782
2880
  function mapRuby(config, state, packageConfig, basePath) {
2783
2881
  const moduleName = takeString(config, ["moduleName"], state, basePath);
2784
2882
  if (moduleName !== void 0) packageConfig.moduleName = moduleName;
2883
+ const packageName = takeString(config, ["package-name"], state, basePath);
2884
+ if (packageName !== void 0) packageConfig.packageName = packageName;
2785
2885
  return compact({ requirePaths: takeStringArray(config, ["requirePaths"], state, basePath) });
2786
2886
  }
2787
2887
  function mapRust(config, state, packageConfig, basePath) {