@redocly/client-generator 0.0.0-snapshot.1787213166 → 0.0.0-snapshot.1787656839
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 +8 -22
- package/eject-assets/AGENTS.md +28 -22
- package/eject-assets/generators/cli/docs.ts +224 -0
- package/eject-assets/generators/cli/engine-source.ts +21 -0
- package/eject-assets/generators/cli/index.ts +90 -0
- package/eject-assets/generators/cli/render.ts +348 -0
- package/eject-assets/generators/go/client.ts +57 -0
- package/eject-assets/generators/go/descriptor.ts +41 -0
- package/eject-assets/generators/go/index.ts +336 -0
- package/eject-assets/generators/go/models.ts +179 -0
- package/eject-assets/generators/go/naming.ts +49 -0
- package/eject-assets/generators/go/operations.ts +296 -0
- package/eject-assets/generators/go/pagination.ts +194 -0
- package/eject-assets/generators/go/types.ts +60 -0
- package/eject-assets/generators/mock/faker.ts +214 -0
- package/eject-assets/generators/mock/index.ts +35 -0
- package/eject-assets/generators/mock/render.ts +282 -0
- package/eject-assets/generators/mock/sample.ts +316 -0
- package/eject-assets/generators/mock/values.ts +63 -0
- package/eject-assets/generators/php/client.ts +63 -0
- package/eject-assets/generators/php/descriptor.ts +58 -0
- package/eject-assets/generators/php/index.ts +237 -0
- package/eject-assets/generators/php/models.ts +275 -0
- package/eject-assets/generators/php/naming.ts +51 -0
- package/eject-assets/generators/php/operations.ts +232 -0
- package/eject-assets/generators/php/pagination.ts +133 -0
- package/eject-assets/generators/php/types.ts +148 -0
- package/eject-assets/generators/python/client.ts +123 -0
- package/eject-assets/generators/python/descriptor.ts +52 -0
- package/eject-assets/generators/python/index.ts +251 -0
- package/eject-assets/generators/python/models.ts +242 -0
- package/eject-assets/generators/python/naming.ts +46 -0
- package/eject-assets/generators/python/operations.ts +147 -0
- package/eject-assets/generators/python/pagination.ts +128 -0
- package/eject-assets/generators/python/types.ts +54 -0
- package/eject-assets/generators/swr/index.ts +37 -0
- package/eject-assets/generators/swr/render.ts +78 -0
- package/eject-assets/generators/tanstack-query/index.ts +48 -0
- package/eject-assets/generators/tanstack-query/render.ts +346 -0
- package/eject-assets/generators/transformers/index.ts +46 -0
- package/eject-assets/generators/transformers/render.ts +506 -0
- package/eject-assets/generators/typescript/banner.ts +35 -0
- package/eject-assets/generators/typescript/client.ts +254 -0
- package/eject-assets/generators/typescript/descriptor.ts +137 -0
- package/eject-assets/generators/typescript/index.ts +101 -0
- package/eject-assets/generators/typescript/inline-runtime.ts +135 -0
- package/eject-assets/generators/typescript/operation-signature.ts +62 -0
- package/eject-assets/generators/typescript/operation-types.ts +17 -0
- package/eject-assets/generators/typescript/operations.ts +524 -0
- package/eject-assets/generators/typescript/response-headers.ts +74 -0
- package/eject-assets/generators/typescript/type-guards.ts +159 -0
- package/eject-assets/generators/typescript/types.ts +172 -0
- package/eject-assets/generators/zod/index.ts +32 -0
- package/eject-assets/generators/{zod.mjs → zod/schemas.ts} +209 -273
- package/eject-assets/skills/cli-generator/SKILL.md +18 -9
- package/eject-assets/skills/client-generators/SKILL.md +28 -22
- package/eject-assets/skills/go-generator/SKILL.md +7 -5
- package/eject-assets/skills/mock-generator/SKILL.md +14 -9
- package/eject-assets/skills/php-generator/SKILL.md +7 -5
- package/eject-assets/skills/python-generator/SKILL.md +7 -5
- package/eject-assets/skills/swr-generator/SKILL.md +15 -9
- package/eject-assets/skills/tanstack-query-generator/SKILL.md +16 -9
- package/eject-assets/skills/transformers-generator/SKILL.md +13 -9
- package/eject-assets/skills/typescript-generator/SKILL.md +34 -19
- package/eject-assets/skills/zod-generator/SKILL.md +14 -9
- package/lib/authoring/index.d.ts +3 -2
- package/lib/authoring/index.d.ts.map +1 -1
- package/lib/authoring/index.js +9 -1
- package/lib/authoring/index.js.map +1 -1
- package/lib/authoring/naming.js +1 -1
- package/lib/authoring/operation.d.ts +47 -0
- package/lib/authoring/operation.d.ts.map +1 -0
- package/lib/authoring/operation.js +86 -0
- package/lib/authoring/operation.js.map +1 -0
- package/lib/authoring/pagination.d.ts +2 -2
- package/lib/authoring/pagination.d.ts.map +1 -1
- package/lib/authoring/pagination.js +1 -1
- package/lib/authoring/pagination.js.map +1 -1
- package/lib/authoring/reference-page.d.ts +2 -0
- package/lib/authoring/reference-page.d.ts.map +1 -1
- package/lib/authoring/reference-page.js +4 -1
- package/lib/authoring/reference-page.js.map +1 -1
- package/lib/authoring/schema.d.ts +2 -0
- package/lib/authoring/schema.d.ts.map +1 -1
- package/lib/authoring/schema.js +8 -3
- package/lib/authoring/schema.js.map +1 -1
- package/lib/{runtime/cli.d.ts → cli-contract.d.ts} +1 -31
- package/lib/cli-contract.d.ts.map +1 -0
- package/lib/cli-contract.js +25 -0
- package/lib/cli-contract.js.map +1 -0
- package/lib/{emitters/wrapper-support.d.ts → contracts/typescript.d.ts} +3 -1
- package/lib/contracts/typescript.d.ts.map +1 -0
- package/lib/{emitters/wrapper-support.js → contracts/typescript.js} +15 -12
- package/lib/contracts/typescript.js.map +1 -0
- package/lib/generate.d.ts +8 -9
- package/lib/generate.d.ts.map +1 -1
- package/lib/generate.js +6 -6
- package/lib/generate.js.map +1 -1
- package/lib/{emitters/cli-docs.d.ts → generators/cli/docs.d.ts} +2 -2
- package/lib/{emitters/cli-docs.d.ts.map → generators/cli/docs.d.ts.map} +1 -1
- package/lib/{emitters/cli-docs.js → generators/cli/docs.js} +2 -3
- package/lib/generators/cli/docs.js.map +1 -0
- package/lib/generators/cli/engine-source.d.ts +5 -0
- package/lib/generators/cli/engine-source.d.ts.map +1 -0
- package/lib/generators/cli/engine-source.js +12 -0
- package/lib/generators/cli/engine-source.js.map +1 -0
- package/lib/generators/cli/index.d.ts +1 -2
- package/lib/generators/cli/index.d.ts.map +1 -1
- package/lib/generators/cli/index.js +24 -16
- package/lib/generators/cli/index.js.map +1 -1
- package/lib/{emitters/cli.d.ts → generators/cli/render.d.ts} +6 -7
- package/lib/generators/cli/render.d.ts.map +1 -0
- package/lib/{emitters/cli.js → generators/cli/render.js} +16 -20
- package/lib/generators/cli/render.js.map +1 -0
- package/lib/generators/cli/runtime/cli.d.ts +42 -0
- package/lib/generators/cli/runtime/cli.d.ts.map +1 -0
- package/lib/{runtime → generators/cli/runtime}/cli.js +3 -19
- package/lib/generators/cli/runtime/cli.js.map +1 -0
- package/lib/generators/go/client.d.ts +5 -0
- package/lib/generators/go/client.d.ts.map +1 -0
- package/lib/generators/go/client.js +34 -0
- package/lib/generators/go/client.js.map +1 -0
- package/lib/generators/go/descriptor.d.ts +6 -0
- package/lib/generators/go/descriptor.d.ts.map +1 -0
- package/lib/generators/go/descriptor.js +26 -0
- package/lib/generators/go/descriptor.js.map +1 -0
- package/lib/generators/go/index.d.ts +3 -7
- package/lib/generators/go/index.d.ts.map +1 -1
- package/lib/generators/go/index.js +114 -722
- package/lib/generators/go/index.js.map +1 -1
- package/lib/generators/go/models.d.ts +4 -0
- package/lib/generators/go/models.d.ts.map +1 -0
- package/lib/generators/go/models.js +125 -0
- package/lib/generators/go/models.js.map +1 -0
- package/lib/generators/go/naming.d.ts +15 -0
- package/lib/generators/go/naming.d.ts.map +1 -0
- package/lib/generators/go/naming.js +36 -0
- package/lib/generators/go/naming.js.map +1 -0
- package/lib/generators/go/operations.d.ts +16 -0
- package/lib/generators/go/operations.d.ts.map +1 -0
- package/lib/generators/go/operations.js +200 -0
- package/lib/generators/go/operations.js.map +1 -0
- package/lib/generators/go/pagination.d.ts +5 -0
- package/lib/generators/go/pagination.d.ts.map +1 -0
- package/lib/generators/go/pagination.js +93 -0
- package/lib/generators/go/pagination.js.map +1 -0
- package/lib/generators/go/types.d.ts +4 -0
- package/lib/generators/go/types.d.ts.map +1 -0
- package/lib/generators/go/types.js +48 -0
- package/lib/generators/go/types.js.map +1 -0
- package/lib/generators/index.d.ts +1 -2
- package/lib/generators/index.d.ts.map +1 -1
- package/lib/generators/index.js.map +1 -1
- package/lib/generators/meta.d.ts +1 -2
- package/lib/generators/meta.d.ts.map +1 -1
- package/lib/generators/meta.js +0 -4
- package/lib/generators/meta.js.map +1 -1
- package/lib/{emitters → generators/mock}/faker.d.ts +2 -3
- package/lib/generators/mock/faker.d.ts.map +1 -0
- package/lib/{emitters → generators/mock}/faker.js +5 -5
- package/lib/generators/mock/faker.js.map +1 -0
- package/lib/generators/mock/index.d.ts +1 -1
- package/lib/generators/mock/index.d.ts.map +1 -1
- package/lib/generators/mock/index.js +7 -7
- package/lib/generators/mock/index.js.map +1 -1
- package/lib/{emitters/mock.d.ts → generators/mock/render.d.ts} +2 -3
- package/lib/generators/mock/render.d.ts.map +1 -0
- package/lib/{emitters/mock.js → generators/mock/render.js} +6 -8
- package/lib/generators/mock/render.js.map +1 -0
- package/lib/{emitters → generators/mock}/sample.d.ts +1 -2
- package/lib/generators/mock/sample.d.ts.map +1 -0
- package/lib/generators/mock/sample.js.map +1 -0
- package/lib/{emitters/mock-value.d.ts → generators/mock/values.d.ts} +1 -1
- package/lib/generators/mock/values.d.ts.map +1 -0
- package/lib/{emitters/mock-value.js → generators/mock/values.js} +2 -3
- package/lib/generators/mock/values.js.map +1 -0
- package/lib/generators/php/client.d.ts +5 -0
- package/lib/generators/php/client.d.ts.map +1 -0
- package/lib/generators/php/client.js +38 -0
- package/lib/generators/php/client.js.map +1 -0
- package/lib/generators/php/descriptor.d.ts +7 -0
- package/lib/generators/php/descriptor.d.ts.map +1 -0
- package/lib/generators/php/descriptor.js +42 -0
- package/lib/generators/php/descriptor.js.map +1 -0
- package/lib/generators/php/index.d.ts +3 -7
- package/lib/generators/php/index.d.ts.map +1 -1
- package/lib/generators/php/index.js +56 -712
- package/lib/generators/php/index.js.map +1 -1
- package/lib/generators/php/models.d.ts +8 -0
- package/lib/generators/php/models.d.ts.map +1 -0
- package/lib/generators/php/models.js +200 -0
- package/lib/generators/php/models.js.map +1 -0
- package/lib/generators/php/naming.d.ts +16 -0
- package/lib/generators/php/naming.d.ts.map +1 -0
- package/lib/generators/php/naming.js +31 -0
- package/lib/generators/php/naming.js.map +1 -0
- package/lib/generators/php/operations.d.ts +21 -0
- package/lib/generators/php/operations.d.ts.map +1 -0
- package/lib/generators/php/operations.js +156 -0
- package/lib/generators/php/operations.js.map +1 -0
- package/lib/generators/php/pagination.d.ts +5 -0
- package/lib/generators/php/pagination.d.ts.map +1 -0
- package/lib/generators/php/pagination.js +68 -0
- package/lib/generators/php/pagination.js.map +1 -0
- package/lib/generators/php/types.d.ts +27 -0
- package/lib/generators/php/types.d.ts.map +1 -0
- package/lib/generators/php/types.js +128 -0
- package/lib/generators/php/types.js.map +1 -0
- package/lib/generators/python/client.d.ts +6 -0
- package/lib/generators/python/client.d.ts.map +1 -0
- package/lib/generators/python/client.js +80 -0
- package/lib/generators/python/client.js.map +1 -0
- package/lib/generators/python/descriptor.d.ts +9 -0
- package/lib/generators/python/descriptor.d.ts.map +1 -0
- package/lib/generators/python/descriptor.js +38 -0
- package/lib/generators/python/descriptor.js.map +1 -0
- package/lib/generators/python/index.d.ts +3 -9
- package/lib/generators/python/index.d.ts.map +1 -1
- package/lib/generators/python/index.js +64 -673
- package/lib/generators/python/index.js.map +1 -1
- package/lib/generators/python/models.d.ts +31 -0
- package/lib/generators/python/models.d.ts.map +1 -0
- package/lib/generators/python/models.js +203 -0
- package/lib/generators/python/models.js.map +1 -0
- package/lib/generators/python/naming.d.ts +22 -0
- package/lib/generators/python/naming.d.ts.map +1 -0
- package/lib/generators/python/naming.js +28 -0
- package/lib/generators/python/naming.js.map +1 -0
- package/lib/generators/python/operations.d.ts +4 -0
- package/lib/generators/python/operations.d.ts.map +1 -0
- package/lib/generators/python/operations.js +108 -0
- package/lib/generators/python/operations.js.map +1 -0
- package/lib/generators/python/pagination.d.ts +5 -0
- package/lib/generators/python/pagination.d.ts.map +1 -0
- package/lib/generators/python/pagination.js +95 -0
- package/lib/generators/python/pagination.js.map +1 -0
- package/lib/generators/python/types.d.ts +4 -0
- package/lib/generators/python/types.d.ts.map +1 -0
- package/lib/generators/python/types.js +45 -0
- package/lib/generators/python/types.js.map +1 -0
- package/lib/generators/resolve.js +19 -2
- package/lib/generators/resolve.js.map +1 -1
- package/lib/generators/swr/index.d.ts +1 -1
- package/lib/generators/swr/index.d.ts.map +1 -1
- package/lib/generators/swr/index.js +5 -7
- package/lib/generators/swr/index.js.map +1 -1
- package/lib/{emitters/swr.d.ts → generators/swr/render.d.ts} +2 -2
- package/lib/generators/swr/render.d.ts.map +1 -0
- package/lib/{emitters/swr.js → generators/swr/render.js} +3 -3
- package/lib/generators/swr/render.js.map +1 -0
- package/lib/generators/tanstack-query/index.d.ts +1 -1
- package/lib/generators/tanstack-query/index.d.ts.map +1 -1
- package/lib/generators/tanstack-query/index.js +8 -8
- package/lib/generators/tanstack-query/index.js.map +1 -1
- package/lib/{emitters/tanstack-query.d.ts → generators/tanstack-query/render.d.ts} +4 -5
- package/lib/generators/tanstack-query/render.d.ts.map +1 -0
- package/lib/{emitters/tanstack-query.js → generators/tanstack-query/render.js} +5 -5
- package/lib/generators/tanstack-query/render.js.map +1 -0
- package/lib/generators/transformers/index.d.ts +1 -1
- package/lib/generators/transformers/index.d.ts.map +1 -1
- package/lib/generators/transformers/index.js +10 -7
- package/lib/generators/transformers/index.js.map +1 -1
- package/lib/{emitters/transformers.d.ts → generators/transformers/render.d.ts} +2 -2
- package/lib/generators/transformers/render.d.ts.map +1 -0
- package/lib/{emitters/transformers.js → generators/transformers/render.js} +2 -3
- package/lib/generators/transformers/render.js.map +1 -0
- package/lib/generators/types.d.ts +108 -8
- package/lib/generators/types.d.ts.map +1 -1
- package/lib/generators/typescript/banner.d.ts +12 -0
- package/lib/generators/typescript/banner.d.ts.map +1 -0
- package/lib/{emitters/emit-options.js → generators/typescript/banner.js} +2 -3
- package/lib/generators/typescript/banner.js.map +1 -0
- package/lib/generators/typescript/client.d.ts +25 -0
- package/lib/generators/typescript/client.d.ts.map +1 -0
- package/lib/{emitters/client-assembly.js → generators/typescript/client.js} +69 -79
- package/lib/generators/typescript/client.js.map +1 -0
- package/lib/{emitters → generators/typescript}/descriptor.d.ts +1 -4
- package/lib/generators/typescript/descriptor.d.ts.map +1 -0
- package/lib/{emitters → generators/typescript}/descriptor.js +9 -28
- package/lib/generators/typescript/descriptor.js.map +1 -0
- package/lib/generators/typescript/index.d.ts +1 -2
- package/lib/generators/typescript/index.d.ts.map +1 -1
- package/lib/generators/typescript/index.js +17 -12
- package/lib/generators/typescript/index.js.map +1 -1
- package/lib/generators/typescript/inline-runtime.d.ts +21 -0
- package/lib/generators/typescript/inline-runtime.d.ts.map +1 -0
- package/lib/{emitters → generators/typescript}/inline-runtime.js +55 -9
- package/lib/generators/typescript/inline-runtime.js.map +1 -0
- package/lib/{emitters → generators/typescript}/operation-signature.d.ts +1 -1
- package/lib/generators/typescript/operation-signature.d.ts.map +1 -0
- package/lib/{emitters → generators/typescript}/operation-signature.js +1 -1
- package/lib/generators/typescript/operation-signature.js.map +1 -0
- package/lib/{emitters → generators/typescript}/operation-types.d.ts +1 -1
- package/lib/generators/typescript/operation-types.d.ts.map +1 -0
- package/lib/generators/typescript/operation-types.js.map +1 -0
- package/lib/{emitters/render-client.d.ts → generators/typescript/operations.d.ts} +20 -4
- package/lib/generators/typescript/operations.d.ts.map +1 -0
- package/lib/{emitters/render-client.js → generators/typescript/operations.js} +10 -12
- package/lib/generators/typescript/operations.js.map +1 -0
- package/lib/{emitters → generators/typescript}/response-headers.d.ts +1 -2
- package/lib/generators/typescript/response-headers.d.ts.map +1 -0
- package/lib/{emitters → generators/typescript}/response-headers.js +2 -3
- package/lib/generators/typescript/response-headers.js.map +1 -0
- package/lib/generators/typescript/runtime/auth.d.ts.map +1 -0
- package/lib/generators/typescript/runtime/auth.js.map +1 -0
- package/lib/generators/typescript/runtime/create-client.d.ts.map +1 -0
- package/lib/generators/typescript/runtime/create-client.js.map +1 -0
- package/lib/generators/typescript/runtime/errors.d.ts.map +1 -0
- package/lib/generators/typescript/runtime/errors.js.map +1 -0
- package/lib/generators/typescript/runtime/index.d.ts.map +1 -0
- package/lib/generators/typescript/runtime/index.js.map +1 -0
- package/lib/generators/typescript/runtime/multipart.d.ts.map +1 -0
- package/lib/generators/typescript/runtime/multipart.js.map +1 -0
- package/lib/generators/typescript/runtime/paginate.d.ts.map +1 -0
- package/lib/generators/typescript/runtime/paginate.js.map +1 -0
- package/lib/generators/typescript/runtime/parse.d.ts.map +1 -0
- package/lib/generators/typescript/runtime/parse.js.map +1 -0
- package/lib/generators/typescript/runtime/retry.d.ts.map +1 -0
- package/lib/generators/typescript/runtime/retry.js.map +1 -0
- package/lib/generators/typescript/runtime/send.d.ts.map +1 -0
- package/lib/generators/typescript/runtime/send.js.map +1 -0
- package/lib/generators/typescript/runtime/setup.d.ts.map +1 -0
- package/lib/generators/typescript/runtime/setup.js.map +1 -0
- package/lib/generators/typescript/runtime/sse.d.ts.map +1 -0
- package/lib/generators/typescript/runtime/sse.js.map +1 -0
- package/lib/{runtime → generators/typescript/runtime}/types.d.ts +5 -95
- package/lib/generators/typescript/runtime/types.d.ts.map +1 -0
- package/lib/generators/typescript/runtime/types.js.map +1 -0
- package/lib/generators/typescript/runtime/url.d.ts.map +1 -0
- package/lib/generators/typescript/runtime/url.js.map +1 -0
- package/lib/{emitters → generators/typescript}/type-guards.d.ts +1 -1
- package/lib/generators/typescript/type-guards.d.ts.map +1 -0
- package/lib/generators/typescript/type-guards.js.map +1 -0
- package/lib/{emitters/ts-type.d.ts → generators/typescript/types.d.ts} +2 -3
- package/lib/generators/typescript/types.d.ts.map +1 -0
- package/lib/{emitters/ts-type.js → generators/typescript/types.js} +2 -3
- package/lib/generators/typescript/types.js.map +1 -0
- package/lib/generators/zod/index.d.ts +1 -1
- package/lib/generators/zod/index.d.ts.map +1 -1
- package/lib/generators/zod/index.js +4 -6
- package/lib/generators/zod/index.js.map +1 -1
- package/lib/{emitters/zod.d.ts → generators/zod/schemas.d.ts} +2 -2
- package/lib/generators/zod/schemas.d.ts.map +1 -0
- package/lib/{emitters/zod.js → generators/zod/schemas.js} +6 -9
- package/lib/generators/zod/schemas.js.map +1 -0
- package/lib/index.d.ts +7 -5
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +15 -13
- package/lib/index.js.map +1 -1
- package/lib/intermediate-representation/build.d.ts +8 -1
- package/lib/intermediate-representation/build.d.ts.map +1 -1
- package/lib/intermediate-representation/build.js +27 -0
- package/lib/intermediate-representation/build.js.map +1 -1
- package/lib/intermediate-representation/model.d.ts +13 -0
- package/lib/intermediate-representation/model.d.ts.map +1 -1
- package/lib/intermediate-representation/model.js.map +1 -1
- package/lib/intermediate-representation/sanitize-identifiers.d.ts.map +1 -1
- package/lib/intermediate-representation/sanitize-identifiers.js +2 -3
- package/lib/intermediate-representation/sanitize-identifiers.js.map +1 -1
- package/lib/{emitters/pagination.d.ts → pagination.d.ts} +34 -3
- package/lib/pagination.d.ts.map +1 -0
- package/lib/{emitters/pagination.js → pagination.js} +4 -5
- package/lib/pagination.js.map +1 -0
- package/lib/pipeline.d.ts +4 -7
- package/lib/pipeline.d.ts.map +1 -1
- package/lib/pipeline.js +23 -7
- package/lib/pipeline.js.map +1 -1
- package/lib/plugin.d.ts +3 -4
- package/lib/plugin.d.ts.map +1 -1
- package/lib/plugin.js +5 -3
- package/lib/plugin.js.map +1 -1
- package/lib/printers/go.d.ts +33 -0
- package/lib/printers/go.d.ts.map +1 -0
- package/lib/printers/go.js +209 -0
- package/lib/printers/go.js.map +1 -0
- package/lib/printers/index.d.ts +5 -0
- package/lib/printers/index.d.ts.map +1 -0
- package/lib/printers/index.js +9 -0
- package/lib/printers/index.js.map +1 -0
- package/lib/printers/php.d.ts +21 -0
- package/lib/printers/php.d.ts.map +1 -0
- package/lib/printers/php.js +68 -0
- package/lib/printers/php.js.map +1 -0
- package/lib/printers/python.d.ts +31 -0
- package/lib/printers/python.d.ts.map +1 -0
- package/lib/printers/python.js +101 -0
- package/lib/printers/python.js.map +1 -0
- package/lib/printers/typescript.d.ts +82 -0
- package/lib/printers/typescript.d.ts.map +1 -0
- package/lib/printers/typescript.js +268 -0
- package/lib/printers/typescript.js.map +1 -0
- package/lib/reserved-names.d.ts.map +1 -0
- package/lib/{emitters/reserved-names.js → reserved-names.js} +1 -1
- package/lib/reserved-names.js.map +1 -0
- package/lib/runtime-contract.d.ts +62 -2
- package/lib/runtime-contract.d.ts.map +1 -1
- package/lib/runtime-contract.js +3 -3
- package/lib/runtime-contract.js.map +1 -1
- package/lib/{emitters/go-runtime-sources.d.ts → runtime-sources/go.d.ts} +1 -1
- package/lib/runtime-sources/go.d.ts.map +1 -0
- package/lib/{emitters/go-runtime-sources.js → runtime-sources/go.js} +1 -1
- package/lib/runtime-sources/go.js.map +1 -0
- package/lib/{emitters/php-runtime-sources.d.ts → runtime-sources/php.d.ts} +1 -1
- package/lib/runtime-sources/php.d.ts.map +1 -0
- package/lib/{emitters/php-runtime-sources.js → runtime-sources/php.js} +1 -1
- package/lib/runtime-sources/php.js.map +1 -0
- package/lib/{emitters/python-runtime-sources.d.ts → runtime-sources/python.d.ts} +1 -1
- package/lib/runtime-sources/python.d.ts.map +1 -0
- package/lib/{emitters/python-runtime-sources.js → runtime-sources/python.js} +1 -1
- package/lib/runtime-sources/python.js.map +1 -0
- package/lib/{emitters/runtime-sources.d.ts → runtime-sources/typescript.d.ts} +1 -1
- package/lib/runtime-sources/typescript.d.ts.map +1 -0
- package/lib/{emitters/runtime-sources.js → runtime-sources/typescript.js} +1 -1
- package/lib/runtime-sources/typescript.js.map +1 -0
- package/lib/runtime-sources.d.ts +4 -3
- package/lib/runtime-sources.d.ts.map +1 -1
- package/lib/runtime-sources.js +5 -4
- package/lib/runtime-sources.js.map +1 -1
- package/lib/setup-bake.d.ts.map +1 -0
- package/lib/{emitters/setup-bake.js → setup-bake.js} +1 -1
- package/lib/setup-bake.js.map +1 -0
- package/lib/types.d.ts +5 -5
- package/lib/types.d.ts.map +1 -1
- package/package.json +32 -2
- package/eject-assets/generators/cli.mjs +0 -796
- package/eject-assets/generators/go.mjs +0 -866
- package/eject-assets/generators/mock.mjs +0 -689
- package/eject-assets/generators/php.mjs +0 -840
- package/eject-assets/generators/python.mjs +0 -823
- package/eject-assets/generators/swr.mjs +0 -193
- package/eject-assets/generators/tanstack-query.mjs +0 -626
- package/eject-assets/generators/transformers.mjs +0 -403
- package/eject-assets/generators/typescript.mjs +0 -1821
- package/lib/emitters/cli-docs.js.map +0 -1
- package/lib/emitters/cli.d.ts.map +0 -1
- package/lib/emitters/cli.js.map +0 -1
- package/lib/emitters/client-assembly.d.ts +0 -15
- package/lib/emitters/client-assembly.d.ts.map +0 -1
- package/lib/emitters/client-assembly.js.map +0 -1
- package/lib/emitters/descriptor.d.ts.map +0 -1
- package/lib/emitters/descriptor.js.map +0 -1
- package/lib/emitters/emit-options.d.ts +0 -81
- package/lib/emitters/emit-options.d.ts.map +0 -1
- package/lib/emitters/emit-options.js.map +0 -1
- package/lib/emitters/faker.d.ts.map +0 -1
- package/lib/emitters/faker.js.map +0 -1
- package/lib/emitters/go-runtime-sources.d.ts.map +0 -1
- package/lib/emitters/go-runtime-sources.js.map +0 -1
- package/lib/emitters/identifier.d.ts +0 -34
- package/lib/emitters/identifier.d.ts.map +0 -1
- package/lib/emitters/identifier.js +0 -114
- package/lib/emitters/identifier.js.map +0 -1
- package/lib/emitters/inline-runtime.d.ts +0 -13
- package/lib/emitters/inline-runtime.d.ts.map +0 -1
- package/lib/emitters/inline-runtime.js.map +0 -1
- package/lib/emitters/jsdoc.d.ts +0 -11
- package/lib/emitters/jsdoc.d.ts.map +0 -1
- package/lib/emitters/jsdoc.js +0 -86
- package/lib/emitters/jsdoc.js.map +0 -1
- package/lib/emitters/mock-value.d.ts.map +0 -1
- package/lib/emitters/mock-value.js.map +0 -1
- package/lib/emitters/mock.d.ts.map +0 -1
- package/lib/emitters/mock.js.map +0 -1
- package/lib/emitters/operation-signature.d.ts.map +0 -1
- package/lib/emitters/operation-signature.js.map +0 -1
- package/lib/emitters/operation-types.d.ts.map +0 -1
- package/lib/emitters/operation-types.js.map +0 -1
- package/lib/emitters/operations.d.ts +0 -33
- package/lib/emitters/operations.d.ts.map +0 -1
- package/lib/emitters/operations.js +0 -2
- package/lib/emitters/operations.js.map +0 -1
- package/lib/emitters/pagination.d.ts.map +0 -1
- package/lib/emitters/pagination.js.map +0 -1
- package/lib/emitters/php-runtime-sources.d.ts.map +0 -1
- package/lib/emitters/php-runtime-sources.js.map +0 -1
- package/lib/emitters/python-runtime-sources.d.ts.map +0 -1
- package/lib/emitters/python-runtime-sources.js.map +0 -1
- package/lib/emitters/render-client.d.ts.map +0 -1
- package/lib/emitters/render-client.js.map +0 -1
- package/lib/emitters/reserved-names.d.ts.map +0 -1
- package/lib/emitters/reserved-names.js.map +0 -1
- package/lib/emitters/response-headers.d.ts.map +0 -1
- package/lib/emitters/response-headers.js.map +0 -1
- package/lib/emitters/runtime-sources.d.ts.map +0 -1
- package/lib/emitters/runtime-sources.js.map +0 -1
- package/lib/emitters/sample.d.ts.map +0 -1
- package/lib/emitters/sample.js.map +0 -1
- package/lib/emitters/setup-bake.d.ts.map +0 -1
- package/lib/emitters/setup-bake.js.map +0 -1
- package/lib/emitters/sse.d.ts +0 -8
- package/lib/emitters/sse.d.ts.map +0 -1
- package/lib/emitters/sse.js +0 -36
- package/lib/emitters/sse.js.map +0 -1
- package/lib/emitters/support.d.ts +0 -18
- package/lib/emitters/support.d.ts.map +0 -1
- package/lib/emitters/support.js +0 -37
- package/lib/emitters/support.js.map +0 -1
- package/lib/emitters/swr.d.ts.map +0 -1
- package/lib/emitters/swr.js.map +0 -1
- package/lib/emitters/tanstack-query.d.ts.map +0 -1
- package/lib/emitters/tanstack-query.js.map +0 -1
- package/lib/emitters/transformers.d.ts.map +0 -1
- package/lib/emitters/transformers.js.map +0 -1
- package/lib/emitters/ts-literal.d.ts +0 -5
- package/lib/emitters/ts-literal.d.ts.map +0 -1
- package/lib/emitters/ts-literal.js +0 -35
- package/lib/emitters/ts-literal.js.map +0 -1
- package/lib/emitters/ts-type.d.ts.map +0 -1
- package/lib/emitters/ts-type.js.map +0 -1
- package/lib/emitters/type-guards.d.ts.map +0 -1
- package/lib/emitters/type-guards.js.map +0 -1
- package/lib/emitters/types.d.ts +0 -2
- package/lib/emitters/types.d.ts.map +0 -1
- package/lib/emitters/types.js +0 -5
- package/lib/emitters/types.js.map +0 -1
- package/lib/emitters/wrapper-support.d.ts.map +0 -1
- package/lib/emitters/wrapper-support.js.map +0 -1
- package/lib/emitters/zod.d.ts.map +0 -1
- package/lib/emitters/zod.js.map +0 -1
- package/lib/generators/anchor.d.ts +0 -9
- package/lib/generators/anchor.d.ts.map +0 -1
- package/lib/generators/anchor.js +0 -10
- package/lib/generators/anchor.js.map +0 -1
- package/lib/runtime/auth.d.ts.map +0 -1
- package/lib/runtime/auth.js.map +0 -1
- package/lib/runtime/cli.d.ts.map +0 -1
- package/lib/runtime/cli.js.map +0 -1
- package/lib/runtime/create-client.d.ts.map +0 -1
- package/lib/runtime/create-client.js.map +0 -1
- package/lib/runtime/errors.d.ts.map +0 -1
- package/lib/runtime/errors.js.map +0 -1
- package/lib/runtime/index.d.ts.map +0 -1
- package/lib/runtime/index.js.map +0 -1
- package/lib/runtime/multipart.d.ts.map +0 -1
- package/lib/runtime/multipart.js.map +0 -1
- package/lib/runtime/paginate.d.ts.map +0 -1
- package/lib/runtime/paginate.js.map +0 -1
- package/lib/runtime/parse.d.ts.map +0 -1
- package/lib/runtime/parse.js.map +0 -1
- package/lib/runtime/retry.d.ts.map +0 -1
- package/lib/runtime/retry.js.map +0 -1
- package/lib/runtime/send.d.ts.map +0 -1
- package/lib/runtime/send.js.map +0 -1
- package/lib/runtime/setup.d.ts.map +0 -1
- package/lib/runtime/setup.js.map +0 -1
- package/lib/runtime/sse.d.ts.map +0 -1
- package/lib/runtime/sse.js.map +0 -1
- package/lib/runtime/types.d.ts.map +0 -1
- package/lib/runtime/types.js.map +0 -1
- package/lib/runtime/url.d.ts.map +0 -1
- package/lib/runtime/url.js.map +0 -1
- /package/lib/{emitters → generators/mock}/sample.js +0 -0
- /package/lib/{emitters → generators/typescript}/operation-types.js +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/auth.d.ts +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/auth.js +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/create-client.d.ts +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/create-client.js +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/errors.d.ts +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/errors.js +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/index.d.ts +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/index.js +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/multipart.d.ts +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/multipart.js +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/paginate.d.ts +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/paginate.js +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/parse.d.ts +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/parse.js +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/retry.d.ts +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/retry.js +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/send.d.ts +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/send.js +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/setup.d.ts +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/setup.js +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/sse.d.ts +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/sse.js +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/types.js +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/url.d.ts +0 -0
- /package/lib/{runtime → generators/typescript/runtime}/url.js +0 -0
- /package/lib/{emitters → generators/typescript}/type-guards.js +0 -0
- /package/lib/{emitters/reserved-names.d.ts → reserved-names.d.ts} +0 -0
- /package/lib/{emitters/setup-bake.d.ts → setup-bake.d.ts} +0 -0
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ See https://github.com/Redocly/redocly-cli for the full project.
|
|
|
11
11
|
The generated client uses only web-standard APIs (`fetch`, `AbortController`, `URLSearchParams`), so by default it is a single self-contained file with zero runtime dependencies that runs in browsers, Node ≥ 18, Bun, Deno, and edge runtimes.
|
|
12
12
|
(Running the generator itself requires the Node version in this package's `engines` field.)
|
|
13
13
|
Code is produced through the TypeScript compiler AST, not string templates; `typescript` is the only peer dependency — optional, needed only when you run generation, and it must be 6.x there (TypeScript 7's native compiler has no compiler API).
|
|
14
|
-
Apps that only consume a
|
|
14
|
+
Apps that only consume a generated client don't need it at all, and can compile the generated code with any TypeScript, including 7.
|
|
15
15
|
|
|
16
16
|
This package is the engine behind the [`generate-client` command](https://redocly.com/docs/cli/commands/generate-client) — install [`@redocly/cli`](https://www.npmjs.com/package/@redocly/cli) to run it from the command line or `redocly.yaml`.
|
|
17
17
|
How to use the generated client — auth, middleware, retries, pagination, Server-Sent Events, and the add-on generators (`zod`, `tanstack-query`, `swr`, `mock`, `transformers`) — is documented in [Use the generated client](https://redocly.com/docs/cli/guides/use-generated-client).
|
|
@@ -41,8 +41,7 @@ For type-safe authoring of a standalone options object, annotate it with `satisf
|
|
|
41
41
|
The generated module exports its operation descriptors, so an app can build additional instances with independent configuration and credentials over the same generated code:
|
|
42
42
|
|
|
43
43
|
```ts
|
|
44
|
-
import { createClient } from '
|
|
45
|
-
import { OPERATIONS, type Ops } from './client.ts';
|
|
44
|
+
import { createClient, OPERATIONS, type Ops } from './client.ts';
|
|
46
45
|
|
|
47
46
|
const internal = createClient<Ops>(OPERATIONS, {
|
|
48
47
|
serverUrl: 'https://api.example.com',
|
|
@@ -50,8 +49,6 @@ const internal = createClient<Ops>(OPERATIONS, {
|
|
|
50
49
|
});
|
|
51
50
|
```
|
|
52
51
|
|
|
53
|
-
With `runtime: 'package'` the generated client also imports its whole engine from this package (instead of embedding it), so engine fixes arrive via `npm update` — install this package as a regular dependency of the consuming app.
|
|
54
|
-
|
|
55
52
|
### Write a custom generator
|
|
56
53
|
|
|
57
54
|
A custom generator reads the same API model the built-ins consume, runs in the same pass, and returns files.
|
|
@@ -65,7 +62,7 @@ import { tsType } from '@redocly/client-generator/generate';
|
|
|
65
62
|
export default defineGenerator({
|
|
66
63
|
name: 'response-map',
|
|
67
64
|
requires: ['typescript'],
|
|
68
|
-
run({ model,
|
|
65
|
+
run({ model, output }) {
|
|
69
66
|
const printer = new Printer();
|
|
70
67
|
// One `ResponseShapes` entry per operation with a JSON success body.
|
|
71
68
|
printer.block(
|
|
@@ -80,7 +77,7 @@ export default defineGenerator({
|
|
|
80
77
|
},
|
|
81
78
|
'};'
|
|
82
79
|
);
|
|
83
|
-
return [{ path:
|
|
80
|
+
return [{ path: output.path.replace(/\.ts$/, '.responses.ts'), content: printer.toString() }];
|
|
84
81
|
},
|
|
85
82
|
});
|
|
86
83
|
```
|
|
@@ -116,7 +113,7 @@ type GenerateClientResult = {
|
|
|
116
113
|
### `collectGeneratedFiles`
|
|
117
114
|
|
|
118
115
|
Runs the configured generators against a built model and returns the files in memory, without writing to disk.
|
|
119
|
-
Imported from `@redocly/client-generator/generate` — the generation-time entry; the package root stays
|
|
116
|
+
Imported from `@redocly/client-generator/generate` — the generation-time entry; the package root stays a small authoring surface:
|
|
120
117
|
|
|
121
118
|
```ts
|
|
122
119
|
function collectGeneratedFiles(
|
|
@@ -133,7 +130,7 @@ function collectGeneratedFiles(
|
|
|
133
130
|
|
|
134
131
|
### `defineGenerator`
|
|
135
132
|
|
|
136
|
-
Authors a custom generator (`{ name, run }` plus optional `requires`/`errorModes`/`dateTypes
|
|
133
|
+
Authors a custom generator (`{ name, run }` plus optional `requires`/`errorModes`/`dateTypes` compatibility metadata, validated up front):
|
|
137
134
|
|
|
138
135
|
```ts
|
|
139
136
|
function defineGenerator(generator: CustomGenerator): CustomGenerator;
|
|
@@ -157,20 +154,9 @@ function defineClientSetup(setup: {
|
|
|
157
154
|
|
|
158
155
|
A setup module may import only from `@redocly/client-generator`, so it never adds a dependency to the client (the import is stripped at generation time).
|
|
159
156
|
|
|
160
|
-
### `createClient`
|
|
161
|
-
|
|
162
|
-
The runtime factory that `runtime: 'package'` clients import, also usable directly to build extra instances over generated descriptors (see [Basic usage](#build-extra-client-instances)):
|
|
163
|
-
|
|
164
|
-
```ts
|
|
165
|
-
function createClient<Ops>(
|
|
166
|
-
operations: Record<string, OperationDescriptor>,
|
|
167
|
-
config?: ClientConfig
|
|
168
|
-
): Client<Ops>;
|
|
169
|
-
```
|
|
170
|
-
|
|
171
157
|
## Examples
|
|
172
158
|
|
|
173
|
-
Runnable examples — from a zero-install quickstart to middleware, publisher setup, SSE streaming, pagination, custom generators
|
|
159
|
+
Runnable examples — from a zero-install quickstart to middleware, publisher setup, SSE streaming, pagination, and custom generators — live in [`tests/e2e/generate-client/examples`](https://github.com/Redocly/redocly-cli/tree/main/tests/e2e/generate-client/examples).
|
|
174
160
|
Each is a standalone Vite app with a checked-in, drift-checked generated client.
|
|
175
161
|
|
|
176
162
|
## Documentation
|
|
@@ -191,4 +177,4 @@ npm run unit # unit tests (this package is held at 100% cover
|
|
|
191
177
|
VITEST_SUITE=e2e npx vitest run tests/e2e/generate-client/ # behavioral e2e
|
|
192
178
|
```
|
|
193
179
|
|
|
194
|
-
|
|
180
|
+
Each generator that embeds a runtime keeps its sources in its own folder (`src/generators/<name>/runtime/` — real, unit-testable modules that generation embeds), the IR lives in `src/intermediate-representation/`, and the generators in `src/generators/`.
|
package/eject-assets/AGENTS.md
CHANGED
|
@@ -15,8 +15,8 @@ client:
|
|
|
15
15
|
/** @type {import('@redocly/client-generator').CustomGenerator} */
|
|
16
16
|
export default {
|
|
17
17
|
name: 'my-generator',
|
|
18
|
-
run({ model,
|
|
19
|
-
return [{ path:
|
|
18
|
+
run({ model, output, outputMode, emit }) {
|
|
19
|
+
return [{ path: output.path.replace(/\.ts$/, '.mine.txt'), content: '…' }];
|
|
20
20
|
},
|
|
21
21
|
// Optional: one idiomatic call snippet per operation for docs (x-codeSamples),
|
|
22
22
|
// collected into an overlay file when `client.codeSamples: true` is set.
|
|
@@ -26,8 +26,8 @@ export default {
|
|
|
26
26
|
// Optional: the reference page for what `run` emits, written when `client.docs` (or
|
|
27
27
|
// --docs) is on. Same `{ path, content }` shape as `run`; `renderReferencePage` gives
|
|
28
28
|
// the standard layout and takes `sample` for its snippets. A generator documents itself.
|
|
29
|
-
docs({ model,
|
|
30
|
-
return [{ path:
|
|
29
|
+
docs({ model, output, emit }) {
|
|
30
|
+
return [{ path: output.path.replace(/\.ts$/, '.mine.md'), content: '…' }];
|
|
31
31
|
},
|
|
32
32
|
};
|
|
33
33
|
```
|
|
@@ -45,9 +45,9 @@ export default {
|
|
|
45
45
|
properties: { groupBy: { enum: ['tag', 'path'], default: 'tag' } },
|
|
46
46
|
additionalProperties: false,
|
|
47
47
|
},
|
|
48
|
-
run({ model,
|
|
48
|
+
run({ model, output, options }) {
|
|
49
49
|
return [
|
|
50
|
-
{ path:
|
|
50
|
+
{ path: output.path.replace(/\.ts$/, '.permissions.md'), content: render(options.groupBy) },
|
|
51
51
|
];
|
|
52
52
|
},
|
|
53
53
|
};
|
|
@@ -91,22 +91,28 @@ discriminated union on `kind`: `scalar`, `array`, `object`, `record`, `ref`,
|
|
|
91
91
|
|
|
92
92
|
## Helpers (import from '@redocly/client-generator')
|
|
93
93
|
|
|
94
|
-
| Helper
|
|
95
|
-
|
|
|
96
|
-
| `flattenAllOf(schema, model)`
|
|
97
|
-
| `
|
|
98
|
-
| `
|
|
99
|
-
| `
|
|
100
|
-
| `
|
|
101
|
-
| `
|
|
102
|
-
| `
|
|
103
|
-
| `
|
|
104
|
-
| `
|
|
105
|
-
| `
|
|
106
|
-
| `
|
|
107
|
-
| `
|
|
108
|
-
| `
|
|
109
|
-
| `
|
|
94
|
+
| Helper | Use |
|
|
95
|
+
| ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
96
|
+
| `flattenAllOf(schema, model)` | The merged property view of allOf compositions — languages without intersection types render this. |
|
|
97
|
+
| `deref(schema, model)` | Follow a `ref` chain to the schema it names (cycle-guarded). |
|
|
98
|
+
| `jsonSuccessSchema(op)` / `sseResponse(op)` | The primary JSON success schema; the `text/event-stream` response when the operation streams. |
|
|
99
|
+
| `isMultipartBody(op)` | Whether the request body is multipart. |
|
|
100
|
+
| `serverUrlParts(server)` | A server-URL template as literal/variable parts, ready for any concatenation syntax. |
|
|
101
|
+
| `securityRequirements(op, model)` | The operation's security as OR-alternatives of AND-sets, denormalized against the declared schemes. |
|
|
102
|
+
| `paginationItemSchema(pageSchema, itemsPointer, model)` | The raw element schema behind a pagination rule's `items` pointer — a `ref` element keeps its name. |
|
|
103
|
+
| `discriminatorCases(schema, model)` | `{ property, cases }` dispatch table for discriminated unions. |
|
|
104
|
+
| `isNullable(schema)` / `unwrapNullable(schema)` | Detect and strip `null` union members (`Optional[T]`, pointers, `Option<T>`). |
|
|
105
|
+
| `enumValues(schema)` | Values plus SCREAMING_SNAKE member-name suggestions. |
|
|
106
|
+
| `headerCoerceType(schema, model)` | Response-header coerce hint (`integer`/`number`/`boolean`/`string`) through refs, nullables, and allOf wrappers. |
|
|
107
|
+
| `casing` / `identifierFor(name, { style, reserved })` | camel/pascal/snake/screaming; keyword-safe identifiers (`RESERVED_WORDS.python/go/typescript` shipped). |
|
|
108
|
+
| `uniqueIdentifiers(names, { style, reserved, taken })` | The same, made unique among themselves and among names you already took — for a signature that takes one argument per parameter. |
|
|
109
|
+
| `Printer` | Indentation-aware text builder — no manual whitespace bookkeeping. |
|
|
110
|
+
| `docText(description)` | Description as trimmed lines for any comment syntax. |
|
|
111
|
+
| `schemaAtPointer(schema, pointer, model)` | Resolve an RFC 6901 JSON pointer over a schema (through refs and allOf) — e.g. a pagination `items` pointer to its element type. |
|
|
112
|
+
| `paginationRuleFor(op, config)` | The pagination rule that applies to an operation (per-op config > extension > fitting convention), normalized. |
|
|
113
|
+
| `renderReferencePage(model, options)` | The Markdown reference page a generator's `docs` hook returns — your `sample` hook supplies its call snippets. |
|
|
114
|
+
| `NotSupportedError` | Throw it to reject an option the generator can't honor — the CLI prints the message as a user error, not a crash. |
|
|
115
|
+
| `AUTHORING_HELPER_NAMES` | The list of the above (introspection). |
|
|
110
116
|
|
|
111
117
|
Worked example: the built-in `python` generator
|
|
112
118
|
(`packages/client-generator/src/generators/python/index.ts` in the Redocly CLI repo) is
|
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
// Ejected from @redocly/client-generator@0.0.0-snapshot.1787656839 — the built-in "cli" generator.
|
|
2
|
+
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
|
+
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
|
+
// `redocly eject-generator cli --update`.
|
|
5
|
+
// The cli-docs emitter: renders the Markdown reference for the generated CLI from the
|
|
6
|
+
// SAME command table `runCli` dispatches on, and the same `groupSlug`/`constantCase` the
|
|
7
|
+
// runtime addresses groups and reads credentials with. A second model would drift from
|
|
8
|
+
// the tool the first time either side changed.
|
|
9
|
+
|
|
10
|
+
import {
|
|
11
|
+
type CliCommand,
|
|
12
|
+
type CliFlag,
|
|
13
|
+
constantCase,
|
|
14
|
+
groupSlug,
|
|
15
|
+
Printer,
|
|
16
|
+
} from '@redocly/client-generator';
|
|
17
|
+
|
|
18
|
+
export type CliDocsOptions = {
|
|
19
|
+
/** Page heading. */
|
|
20
|
+
title: string;
|
|
21
|
+
/** Emit YAML front matter carrying the title, for docs sites that expect it. */
|
|
22
|
+
frontmatter: boolean;
|
|
23
|
+
/** The generated file's stem: what the page calls the command, and what its credential
|
|
24
|
+
* variables derive from. A reader who installs it under another bin name renames only
|
|
25
|
+
* the command — the variables are fixed at generation. */
|
|
26
|
+
name: string;
|
|
27
|
+
/** Auth schemes the description declares, in the order the CLI resolves them. */
|
|
28
|
+
schemes: Array<{ key: string; kind: 'bearer' | 'basic' | 'apiKey' }>;
|
|
29
|
+
};
|
|
30
|
+
|
|
31
|
+
/** Table-cell-safe text: one line, and pipes/backslashes escaped so they don't alter columns/escaping. */
|
|
32
|
+
function cell(text: string | undefined): string {
|
|
33
|
+
return (text ?? '').replace(/\s+/g, ' ').trim().replace(/\\/g, '\\\\').replace(/\|/g, '\\|');
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/** How a command is typed at the prompt: `<group-slug> <name>`, or just `<name>`. */
|
|
37
|
+
function address(command: CliCommand): string {
|
|
38
|
+
return [command.group === undefined ? undefined : groupSlug(command.group), command.name]
|
|
39
|
+
.filter(Boolean)
|
|
40
|
+
.join(' ');
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
function usageLine(name: string, command: CliCommand): string {
|
|
44
|
+
const words = [
|
|
45
|
+
name,
|
|
46
|
+
address(command),
|
|
47
|
+
...command.positionals.map((positional) => `<${positional.name}>`),
|
|
48
|
+
...command.flags.filter((flag) => flag.required).map((flag) => `--${flag.name} <${flag.type}>`),
|
|
49
|
+
...(command.body ? [command.body.required ? "--json '<json>'" : "[--json '<json>']"] : []),
|
|
50
|
+
];
|
|
51
|
+
return words.filter((word) => word !== '').join(' ');
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
function writeFlagTable(printer: Printer, flags: CliFlag[]): void {
|
|
55
|
+
printer.line('| Flag | Type | Required | Description |');
|
|
56
|
+
printer.line('| ---- | ---- | -------- | ----------- |');
|
|
57
|
+
for (const flag of flags) {
|
|
58
|
+
const description = [
|
|
59
|
+
cell(flag.description),
|
|
60
|
+
flag.enum === undefined
|
|
61
|
+
? ''
|
|
62
|
+
: `One of ${flag.enum.map((value) => `\`${value}\``).join(', ')}.`,
|
|
63
|
+
flag.type === 'array' ? 'Repeat the flag for multiple values.' : '',
|
|
64
|
+
]
|
|
65
|
+
.filter((part) => part !== '')
|
|
66
|
+
.join(' ');
|
|
67
|
+
printer.line(
|
|
68
|
+
`| \`--${flag.name}\` | ${flag.type} | ${flag.required ? 'yes' : 'no'} | ${description} |`
|
|
69
|
+
);
|
|
70
|
+
}
|
|
71
|
+
printer.blank();
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
function writeCommand(printer: Printer, command: CliCommand, options: CliDocsOptions): void {
|
|
75
|
+
printer.line(`### \`${address(command)}\``);
|
|
76
|
+
printer.blank();
|
|
77
|
+
if (command.summary !== undefined) {
|
|
78
|
+
printer.line(cell(command.summary));
|
|
79
|
+
printer.blank();
|
|
80
|
+
}
|
|
81
|
+
printer.line(`\`${command.method} ${command.path}\``);
|
|
82
|
+
printer.blank();
|
|
83
|
+
printer.line('```sh');
|
|
84
|
+
printer.line(usageLine(options.name, command));
|
|
85
|
+
printer.line('```');
|
|
86
|
+
printer.blank();
|
|
87
|
+
if (command.positionals.length > 0) {
|
|
88
|
+
printer.line('| Argument | Description |');
|
|
89
|
+
printer.line('| -------- | ----------- |');
|
|
90
|
+
for (const positional of command.positionals) {
|
|
91
|
+
printer.line(`| \`<${positional.name}>\` | ${cell(positional.description)} |`);
|
|
92
|
+
}
|
|
93
|
+
printer.blank();
|
|
94
|
+
}
|
|
95
|
+
if (command.flags.length > 0) writeFlagTable(printer, command.flags);
|
|
96
|
+
const notes = [
|
|
97
|
+
command.body === undefined
|
|
98
|
+
? ''
|
|
99
|
+
: `Takes a JSON body${command.body.required ? ' (required)' : ''}: \`--json '<json>'\`, \`--json @file.json\`, or \`--json @-\` for stdin.`,
|
|
100
|
+
command.unsupportedBody === undefined
|
|
101
|
+
? ''
|
|
102
|
+
: `Takes a \`${command.unsupportedBody}\` body, which the CLI cannot build — call this operation through the generated client instead.`,
|
|
103
|
+
command.paginated === true
|
|
104
|
+
? 'Paginated: `--page-all` follows every page, printing one JSON page per line.'
|
|
105
|
+
: '',
|
|
106
|
+
command.sse === true ? 'Streams server-sent events as one JSON object per line.' : '',
|
|
107
|
+
command.blob === true ? 'Returns binary content, so `--output <path>` is required.' : '',
|
|
108
|
+
].filter((note) => note !== '');
|
|
109
|
+
for (const note of notes) printer.line(note);
|
|
110
|
+
if (notes.length > 0) printer.blank();
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
/** The whole page: heading, global flags, credentials, exit codes, then every command. */
|
|
114
|
+
export function renderCliDocs(commands: CliCommand[], options: CliDocsOptions): string {
|
|
115
|
+
const printer = new Printer();
|
|
116
|
+
if (options.frontmatter) {
|
|
117
|
+
printer.line('---');
|
|
118
|
+
printer.line(`title: ${options.title}`);
|
|
119
|
+
printer.line('---');
|
|
120
|
+
printer.blank();
|
|
121
|
+
}
|
|
122
|
+
printer.line(`# ${options.title}`);
|
|
123
|
+
printer.blank();
|
|
124
|
+
printer.line(
|
|
125
|
+
`Generated command-line reference for \`${options.name}\`, produced from the API description by \`redocly generate-client\`.`
|
|
126
|
+
);
|
|
127
|
+
printer.line('Re-run generation to update it — this file is not hand-edited.');
|
|
128
|
+
printer.blank();
|
|
129
|
+
|
|
130
|
+
printer.line('## Usage');
|
|
131
|
+
printer.blank();
|
|
132
|
+
printer.line('```sh');
|
|
133
|
+
printer.line(`${options.name} <command> [flags]`);
|
|
134
|
+
printer.line(`${options.name} --help`);
|
|
135
|
+
printer.line(`${options.name} schema <command> # request/response schemas`);
|
|
136
|
+
printer.line('```');
|
|
137
|
+
printer.blank();
|
|
138
|
+
printer.line(
|
|
139
|
+
'Install the file under any `bin` name: the command takes that name, and the credential variables below do not change.'
|
|
140
|
+
);
|
|
141
|
+
printer.blank();
|
|
142
|
+
|
|
143
|
+
printer.line('## Global flags');
|
|
144
|
+
printer.blank();
|
|
145
|
+
printer.line('| Flag | Description |');
|
|
146
|
+
printer.line('| ---- | ----------- |');
|
|
147
|
+
// `--token` mirrors the CLI itself: without a bearer scheme the tool rejects the flag,
|
|
148
|
+
// so the reference must not list it.
|
|
149
|
+
const hasBearer = options.schemes.some((scheme) => scheme.kind === 'bearer');
|
|
150
|
+
for (const [flag, description] of [
|
|
151
|
+
['--server-url <url>', 'Override the server URL included in the client.'],
|
|
152
|
+
['--format <json\\|ndjson>', 'Output format.'],
|
|
153
|
+
['--dry-run', 'Print the prepared request, credentials redacted, without sending it.'],
|
|
154
|
+
['--page-all', 'Follow pagination, printing one JSON page per line.'],
|
|
155
|
+
['--output <path>', 'Write the response body to a file. Required for binary responses.'],
|
|
156
|
+
...(hasBearer ? [['--token <token>', 'Bearer token, overriding the environment.']] : []),
|
|
157
|
+
['--json <json\\|@file\\|@->', 'Request body, inline or from a file or stdin.'],
|
|
158
|
+
] as const) {
|
|
159
|
+
printer.line(`| \`${flag}\` | ${description} |`);
|
|
160
|
+
}
|
|
161
|
+
printer.blank();
|
|
162
|
+
|
|
163
|
+
const prefix = constantCase(options.name);
|
|
164
|
+
printer.line('## Credentials');
|
|
165
|
+
printer.blank();
|
|
166
|
+
if (options.schemes.length === 0) {
|
|
167
|
+
printer.line('The description declares no security schemes, so no credentials are read.');
|
|
168
|
+
} else {
|
|
169
|
+
printer.line('Credentials come from the environment:');
|
|
170
|
+
printer.blank();
|
|
171
|
+
printer.line('| Scheme | Variable |');
|
|
172
|
+
printer.line('| ------ | -------- |');
|
|
173
|
+
for (const scheme of options.schemes) {
|
|
174
|
+
const variable =
|
|
175
|
+
scheme.kind === 'bearer'
|
|
176
|
+
? `\`${prefix}_TOKEN\` (or \`--token\`)`
|
|
177
|
+
: scheme.kind === 'basic'
|
|
178
|
+
? `\`${prefix}_USERNAME\` and \`${prefix}_PASSWORD\``
|
|
179
|
+
: `\`${prefix}_API_KEY_${constantCase(scheme.key)}\``;
|
|
180
|
+
printer.line(`| ${scheme.kind} (\`${scheme.key}\`) | ${variable} |`);
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
printer.blank();
|
|
184
|
+
|
|
185
|
+
printer.line('## Exit codes');
|
|
186
|
+
printer.blank();
|
|
187
|
+
printer.line('| Code | Meaning |');
|
|
188
|
+
printer.line('| ---- | ------- |');
|
|
189
|
+
for (const [code, meaning] of [
|
|
190
|
+
[0, 'success'],
|
|
191
|
+
[1, 'API error (status other than 401 or 403)'],
|
|
192
|
+
[2, 'auth error (401 or 403)'],
|
|
193
|
+
[3, 'validation error'],
|
|
194
|
+
[4, 'usage error (unknown command or flag, bad `--json`)'],
|
|
195
|
+
] as const) {
|
|
196
|
+
printer.line(`| ${code} | ${meaning} |`);
|
|
197
|
+
}
|
|
198
|
+
printer.blank();
|
|
199
|
+
printer.line('Errors print one JSON object to stderr, so stdout stays clean for piping.');
|
|
200
|
+
printer.blank();
|
|
201
|
+
|
|
202
|
+
// One section per tag, in the order the description declares them, then the untagged
|
|
203
|
+
// commands — the same order `--help` lists them in.
|
|
204
|
+
const groups = [...new Set(commands.map((command) => command.group))];
|
|
205
|
+
for (const group of groups) {
|
|
206
|
+
const inGroup = commands.filter((command) => command.group === group);
|
|
207
|
+
if (group === undefined) {
|
|
208
|
+
printer.line('## Commands');
|
|
209
|
+
printer.blank();
|
|
210
|
+
} else {
|
|
211
|
+
printer.line(`## ${group}`);
|
|
212
|
+
printer.blank();
|
|
213
|
+
printer.line(`Addressed as \`${options.name} ${groupSlug(group)} <command>\`.`);
|
|
214
|
+
printer.blank();
|
|
215
|
+
}
|
|
216
|
+
for (const command of inGroup) writeCommand(printer, command, options);
|
|
217
|
+
}
|
|
218
|
+
return (
|
|
219
|
+
printer
|
|
220
|
+
.toString()
|
|
221
|
+
.replace(/\n{3,}/g, '\n\n')
|
|
222
|
+
.trimEnd() + '\n'
|
|
223
|
+
);
|
|
224
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
// Ejected from @redocly/client-generator@0.0.0-snapshot.1787656839 — the built-in "cli" generator.
|
|
2
|
+
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
|
+
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
|
+
// `redocly eject-generator cli --update`.
|
|
5
|
+
// The cli engine's embeddable source, snapshotted at prepare time (see
|
|
6
|
+
// scripts/generate-runtime-sources.mjs).
|
|
7
|
+
|
|
8
|
+
import {
|
|
9
|
+
RUNTIME_SOURCES,
|
|
10
|
+
RUNTIME_SOURCES_STRIPPED,
|
|
11
|
+
} from '@redocly/client-generator/runtime-sources';
|
|
12
|
+
|
|
13
|
+
/** The cli engine (`runCli` + types) stripped for embedding into `<stem>.cli.ts`. */
|
|
14
|
+
export function embedCliRuntime(): string {
|
|
15
|
+
return RUNTIME_SOURCES_STRIPPED['cli.ts'];
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
/** The cli engine RAW, for `runtime: 'module'` (written as `runtime/cli.ts`). */
|
|
19
|
+
export function cliRuntimeSource(): string {
|
|
20
|
+
return RUNTIME_SOURCES['cli.ts'];
|
|
21
|
+
}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
// Ejected from @redocly/client-generator@0.0.0-snapshot.1787656839 — the built-in "cli" generator.
|
|
2
|
+
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
|
+
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
|
+
// `redocly eject-generator cli --update`.
|
|
5
|
+
import {
|
|
6
|
+
type CodeSample,
|
|
7
|
+
type Generator,
|
|
8
|
+
groupSlug,
|
|
9
|
+
type OperationModel,
|
|
10
|
+
type SampleContext,
|
|
11
|
+
} from '@redocly/client-generator';
|
|
12
|
+
import { join } from 'node:path';
|
|
13
|
+
|
|
14
|
+
import { renderCliDocs } from './docs.ts';
|
|
15
|
+
import { cliRuntimeSource } from './engine-source.ts';
|
|
16
|
+
import { cliAuthSchemes, commandData, renderCliModule } from './render.ts';
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* The cli generator: a bin-ready `<stem>.cli.ts` — a zero-dependency, typed
|
|
20
|
+
* command-line interface over the sibling client (typed flags, `--json`
|
|
21
|
+
* bodies, env auth, `--page-all`, SSE/blob output, a documented exit-code
|
|
22
|
+
* contract). Requires `typescript` (throw mode); wires zod validation when co-selected.
|
|
23
|
+
*/
|
|
24
|
+
export const cliGenerator: Generator = ({ model, output, banner, emit, selected, pagination }) => {
|
|
25
|
+
const content = renderCliModule(model, {
|
|
26
|
+
stem: output.stem,
|
|
27
|
+
importExt: emit.importExt ?? 'js',
|
|
28
|
+
zodSelected: selected?.includes('zod') ?? false,
|
|
29
|
+
pagination,
|
|
30
|
+
argsStyle: emit.argsStyle ?? 'grouped',
|
|
31
|
+
runtime: emit.runtime ?? 'inline',
|
|
32
|
+
});
|
|
33
|
+
const entry = { path: join(output.dir, `${output.stem}.cli.ts`), content };
|
|
34
|
+
if (emit.runtime !== 'module') return [entry];
|
|
35
|
+
const header = banner.map((line) => `// ${line}`).join('\n');
|
|
36
|
+
return [
|
|
37
|
+
entry,
|
|
38
|
+
{
|
|
39
|
+
path: join(output.dir, 'runtime', 'cli.ts'),
|
|
40
|
+
content: `${header}\n\n${cliRuntimeSource().trim()}\n`,
|
|
41
|
+
},
|
|
42
|
+
];
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* The CLI's own reference page, written when `client.docs` is on: the usage line, the
|
|
47
|
+
* global flags, the credential variables, the exit codes, and one section per command.
|
|
48
|
+
* It renders from `commandData` — the same table `runCli` dispatches on — so the page
|
|
49
|
+
* cannot describe a tool other than the one beside it.
|
|
50
|
+
*/
|
|
51
|
+
export const cliDocs: Generator = ({ model, output, emit, pagination }) => {
|
|
52
|
+
const content = renderCliDocs(commandData(model, { pagination }), {
|
|
53
|
+
title: `${model.title} command-line reference`,
|
|
54
|
+
frontmatter: emit.docsFrontmatter === true,
|
|
55
|
+
name: output.stem,
|
|
56
|
+
schemes: cliAuthSchemes(model),
|
|
57
|
+
});
|
|
58
|
+
return [{ path: join(output.dir, `${output.stem}.cli.md`), content }];
|
|
59
|
+
};
|
|
60
|
+
|
|
61
|
+
/** One shell invocation per operation — feeds `x-codeSamples` for docs. */
|
|
62
|
+
export function cliSample(op: OperationModel, ctx: SampleContext): CodeSample | undefined {
|
|
63
|
+
const command = commandData(ctx.model, { pagination: ctx.pagination }).find(
|
|
64
|
+
(candidate) => candidate.name === op.name
|
|
65
|
+
);
|
|
66
|
+
if (command === undefined) return undefined;
|
|
67
|
+
const words = [
|
|
68
|
+
'client',
|
|
69
|
+
...(command.group ? [groupSlug(command.group)] : []),
|
|
70
|
+
command.name,
|
|
71
|
+
...command.positionals.map((positional) => `<${positional.name}>`),
|
|
72
|
+
...command.flags.filter((flag) => flag.required).map((flag) => `--${flag.name} <${flag.type}>`),
|
|
73
|
+
...(command.body ? ["--json '<json>'"] : []),
|
|
74
|
+
];
|
|
75
|
+
return {
|
|
76
|
+
lang: 'shell',
|
|
77
|
+
label: 'CLI',
|
|
78
|
+
source: `npx tsx client.cli.ts ${words.slice(1).join(' ')}\n`,
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
export default {
|
|
83
|
+
name: 'cli',
|
|
84
|
+
run: cliGenerator,
|
|
85
|
+
sample: cliSample,
|
|
86
|
+
docs: cliDocs,
|
|
87
|
+
requires: ["typescript","zod"],
|
|
88
|
+
errorModes: ["throw"],
|
|
89
|
+
requiresGenerator: '^0.0.0-snapshot.1787656839',
|
|
90
|
+
};
|