@postman/sdk-config 0.3.5 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/dist/index.cjs +10 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +9 -1
- package/dist/index.js.map +1 -1
- package/dist/sdk-config/index.cjs +5 -0
- package/dist/sdk-config/index.cjs.map +1 -1
- package/dist/sdk-config/index.d.cts +1 -1
- package/dist/sdk-config/index.d.ts +1 -1
- package/dist/sdk-config/index.js +5 -1
- package/dist/sdk-config/index.js.map +1 -1
- package/dist/sdk-config/v1/index.cjs +5 -0
- package/dist/sdk-config/v1/index.cjs.map +1 -1
- package/dist/sdk-config/v1/index.d.cts +10 -1
- package/dist/sdk-config/v1/index.d.ts +10 -1
- package/dist/sdk-config/v1/index.js +5 -1
- package/dist/sdk-config/v1/index.js.map +1 -1
- package/dist/sdk-config-ir/index.cjs +5 -0
- package/dist/sdk-config-ir/index.cjs.map +1 -1
- package/dist/sdk-config-ir/index.d.cts +1 -1
- package/dist/sdk-config-ir/index.d.ts +1 -1
- package/dist/sdk-config-ir/index.js +5 -1
- package/dist/sdk-config-ir/index.js.map +1 -1
- package/dist/sdk-config-ir/v1/index.cjs +5 -0
- package/dist/sdk-config-ir/v1/index.cjs.map +1 -1
- package/dist/sdk-config-ir/v1/index.d.cts +10 -1
- package/dist/sdk-config-ir/v1/index.d.ts +10 -1
- package/dist/sdk-config-ir/v1/index.js +5 -1
- package/dist/sdk-config-ir/v1/index.js.map +1 -1
- package/package.json +1 -1
- package/src/sdk-config/v1/README.md +3 -0
- package/src/sdk-config-ir/v1/README.md +3 -1
package/README.md
CHANGED
|
@@ -39,6 +39,7 @@ const input: SdkConfigV1Input = {
|
|
|
39
39
|
},
|
|
40
40
|
client: { timeoutMs: 30_000 },
|
|
41
41
|
output: { delivery: 'zip', fileName: 'example-typescript.zip' },
|
|
42
|
+
replay: { enabled: false },
|
|
42
43
|
docs: { includeApiReference: true },
|
|
43
44
|
generation: { includeWatermark: true },
|
|
44
45
|
targets: [
|
|
@@ -59,7 +60,8 @@ Use `parseSdkConfigV1` when entering the runtime boundary and materializing the
|
|
|
59
60
|
defaults. For validation without throwing, use the exported schema:
|
|
60
61
|
|
|
61
62
|
Empty top-level `api`, `client`, `package`, `docs`, and `generation` blocks may be omitted from the
|
|
62
|
-
customer document. Runtime parsing materializes those blocks and their versioned defaults.
|
|
63
|
+
customer document. Runtime parsing materializes those blocks and their versioned defaults. The
|
|
64
|
+
optional top-level `replay` block is preserved only when authored.
|
|
63
65
|
|
|
64
66
|
```ts
|
|
65
67
|
import { sdkConfigV1Schema } from '@postman/sdk-config/sdk-config/v1';
|
package/dist/index.cjs
CHANGED
|
@@ -1248,6 +1248,9 @@ var sdkConfigV1OutputConfigSchema = zod.z.discriminatedUnion(
|
|
|
1248
1248
|
// src/sdk-config/v1/package.ts
|
|
1249
1249
|
var sdkConfigV1DependencySchema = dependencySchema;
|
|
1250
1250
|
var sdkConfigV1PackageConfigSchema = packageConfigSchema;
|
|
1251
|
+
var sdkConfigV1ReplayConfigSchema = zod.z.strictObject({
|
|
1252
|
+
enabled: zod.z.boolean()
|
|
1253
|
+
});
|
|
1251
1254
|
var apiImportSettingsSchema = zod.z.strictObject({
|
|
1252
1255
|
respectNullableSchemas: zod.z.boolean().optional(),
|
|
1253
1256
|
titleAsSchemaName: zod.z.boolean().optional(),
|
|
@@ -1664,6 +1667,7 @@ var sdkConfigV1Schema = zod.z.strictObject({
|
|
|
1664
1667
|
client: sdkConfigV1ClientConfigSchema.prefault({}),
|
|
1665
1668
|
package: sdkConfigV1PackageConfigSchema.prefault({}),
|
|
1666
1669
|
output: sdkConfigV1OutputConfigSchema.optional(),
|
|
1670
|
+
replay: sdkConfigV1ReplayConfigSchema.optional(),
|
|
1667
1671
|
docs: sdkConfigV1DocsConfigSchema.prefault({}),
|
|
1668
1672
|
generation: sdkConfigV1GenerationConfigSchema.prefault({}),
|
|
1669
1673
|
targets: zod.z.array(sdkConfigV1TargetSchema).min(1)
|
|
@@ -2875,6 +2879,9 @@ var outputConfigSchema = zod.z.discriminatedUnion(
|
|
|
2875
2879
|
error: 'output.delivery must be one of "files", "zip", or "github"'
|
|
2876
2880
|
}
|
|
2877
2881
|
);
|
|
2882
|
+
var replayConfigSchema = zod.z.strictObject({
|
|
2883
|
+
enabled: zod.z.boolean()
|
|
2884
|
+
});
|
|
2878
2885
|
var sourceSpecConfigSchema = zod.z.strictObject({
|
|
2879
2886
|
id: nonEmptyStringSchema.optional(),
|
|
2880
2887
|
name: nonEmptyStringSchema.optional(),
|
|
@@ -3006,6 +3013,7 @@ var sdkConfigIrV1Schema = zod.z.strictObject({
|
|
|
3006
3013
|
client: clientConfigSchema,
|
|
3007
3014
|
package: packageConfigSchema,
|
|
3008
3015
|
output: outputConfigSchema,
|
|
3016
|
+
replay: replayConfigSchema.optional(),
|
|
3009
3017
|
docs: docsConfigSchema,
|
|
3010
3018
|
generation: generationConfigSchema,
|
|
3011
3019
|
compatibility: compatibilityConfigSchema.optional()
|
|
@@ -3110,6 +3118,7 @@ exports.pythonGenerationConfigSchema = pythonGenerationConfigSchema;
|
|
|
3110
3118
|
exports.readmeCustomSectionSchema = readmeCustomSectionSchema;
|
|
3111
3119
|
exports.readmeEndpointSchema = readmeEndpointSchema;
|
|
3112
3120
|
exports.relativePathSchema = relativePathSchema;
|
|
3121
|
+
exports.replayConfigSchema = replayConfigSchema;
|
|
3113
3122
|
exports.rubyGenerationConfigSchema = rubyGenerationConfigSchema;
|
|
3114
3123
|
exports.rustGenerationConfigSchema = rustGenerationConfigSchema;
|
|
3115
3124
|
exports.sdkConfigIrV1Schema = sdkConfigIrV1Schema;
|
|
@@ -3141,6 +3150,7 @@ exports.sdkConfigV1PythonGenerationConfigSchema = pythonGenerationConfigSchema;
|
|
|
3141
3150
|
exports.sdkConfigV1ReadmeCustomSectionSchema = sdkConfigV1ReadmeCustomSectionSchema;
|
|
3142
3151
|
exports.sdkConfigV1ReadmeEndpointSchema = sdkConfigV1ReadmeEndpointSchema;
|
|
3143
3152
|
exports.sdkConfigV1RelativePathSchema = relativePathSchema;
|
|
3153
|
+
exports.sdkConfigV1ReplayConfigSchema = sdkConfigV1ReplayConfigSchema;
|
|
3144
3154
|
exports.sdkConfigV1RubyGenerationConfigSchema = rubyGenerationConfigSchema;
|
|
3145
3155
|
exports.sdkConfigV1RustGenerationConfigSchema = rustGenerationConfigSchema;
|
|
3146
3156
|
exports.sdkConfigV1Schema = sdkConfigV1Schema;
|