@redocly/client-generator 0.8.1 → 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.
- package/README.md +2 -0
- package/eject-assets/generators/cli/docs.ts +1 -1
- package/eject-assets/generators/cli/engine-source.ts +1 -1
- package/eject-assets/generators/cli/index.ts +12 -3
- package/eject-assets/generators/cli/render.ts +21 -8
- package/eject-assets/generators/go/client.ts +1 -1
- package/eject-assets/generators/go/descriptor.ts +1 -1
- package/eject-assets/generators/go/index.ts +27 -11
- package/eject-assets/generators/go/models.ts +1 -1
- package/eject-assets/generators/go/naming.ts +1 -1
- package/eject-assets/generators/go/operations.ts +1 -1
- package/eject-assets/generators/go/pagination.ts +1 -1
- package/eject-assets/generators/go/types.ts +1 -1
- package/eject-assets/generators/java/client.ts +1 -1
- package/eject-assets/generators/java/descriptor.ts +1 -1
- package/eject-assets/generators/java/index.ts +15 -7
- package/eject-assets/generators/java/models.ts +1 -1
- package/eject-assets/generators/java/naming.ts +1 -1
- package/eject-assets/generators/java/operations.ts +1 -1
- package/eject-assets/generators/java/pagination.ts +1 -1
- package/eject-assets/generators/java/types.ts +1 -1
- package/eject-assets/generators/mock/faker.ts +1 -1
- package/eject-assets/generators/mock/index.ts +2 -2
- package/eject-assets/generators/mock/render.ts +1 -1
- package/eject-assets/generators/mock/sample.ts +1 -1
- package/eject-assets/generators/mock/values.ts +1 -1
- package/eject-assets/generators/php/client.ts +1 -1
- package/eject-assets/generators/php/descriptor.ts +1 -1
- package/eject-assets/generators/php/index.ts +31 -13
- package/eject-assets/generators/php/models.ts +1 -1
- package/eject-assets/generators/php/naming.ts +1 -1
- package/eject-assets/generators/php/operations.ts +1 -1
- package/eject-assets/generators/php/pagination.ts +1 -1
- package/eject-assets/generators/php/types.ts +1 -1
- package/eject-assets/generators/python/client.ts +1 -1
- package/eject-assets/generators/python/descriptor.ts +1 -1
- package/eject-assets/generators/python/index.ts +36 -17
- package/eject-assets/generators/python/models.ts +1 -1
- package/eject-assets/generators/python/naming.ts +1 -1
- package/eject-assets/generators/python/operations.ts +1 -1
- package/eject-assets/generators/python/pagination.ts +1 -1
- package/eject-assets/generators/python/types.ts +1 -1
- package/eject-assets/generators/swr/index.ts +4 -3
- package/eject-assets/generators/swr/render.ts +4 -3
- package/eject-assets/generators/tanstack-query/index.ts +4 -3
- package/eject-assets/generators/tanstack-query/render.ts +4 -2
- package/eject-assets/generators/transformers/index.ts +2 -2
- package/eject-assets/generators/transformers/render.ts +1 -1
- package/eject-assets/generators/typescript/banner.ts +1 -1
- package/eject-assets/generators/typescript/client.ts +1 -1
- package/eject-assets/generators/typescript/descriptor.ts +1 -1
- package/eject-assets/generators/typescript/index.ts +2 -2
- package/eject-assets/generators/typescript/inline-runtime.ts +1 -1
- package/eject-assets/generators/typescript/operation-signature.ts +1 -1
- package/eject-assets/generators/typescript/operation-types.ts +1 -1
- package/eject-assets/generators/typescript/operations.ts +1 -1
- package/eject-assets/generators/typescript/response-headers.ts +1 -1
- package/eject-assets/generators/typescript/type-guards.ts +1 -1
- package/eject-assets/generators/typescript/types.ts +1 -1
- package/eject-assets/generators/zod/index.ts +2 -2
- package/eject-assets/generators/zod/schemas.ts +1 -1
- package/eject-assets/skills/go-generator/SKILL.md +19 -0
- package/eject-assets/skills/php-generator/SKILL.md +16 -1
- package/eject-assets/skills/python-generator/SKILL.md +15 -0
- package/lib/contracts/typescript.d.ts +2 -1
- package/lib/contracts/typescript.d.ts.map +1 -1
- package/lib/contracts/typescript.js +15 -8
- package/lib/contracts/typescript.js.map +1 -1
- package/lib/findings.d.ts +9 -0
- package/lib/findings.d.ts.map +1 -0
- package/lib/findings.js +43 -0
- package/lib/findings.js.map +1 -0
- package/lib/generators/cli/index.d.ts.map +1 -1
- package/lib/generators/cli/index.js +2 -1
- package/lib/generators/cli/index.js.map +1 -1
- package/lib/generators/cli/render.d.ts +2 -1
- package/lib/generators/cli/render.d.ts.map +1 -1
- package/lib/generators/cli/render.js +15 -7
- package/lib/generators/cli/render.js.map +1 -1
- package/lib/generators/go/index.d.ts.map +1 -1
- package/lib/generators/go/index.js +18 -11
- package/lib/generators/go/index.js.map +1 -1
- package/lib/generators/java/index.d.ts.map +1 -1
- package/lib/generators/java/index.js +6 -3
- package/lib/generators/java/index.js.map +1 -1
- package/lib/generators/meta.d.ts.map +1 -1
- package/lib/generators/meta.js +18 -5
- package/lib/generators/meta.js.map +1 -1
- package/lib/generators/options.d.ts.map +1 -1
- package/lib/generators/options.js +7 -2
- package/lib/generators/options.js.map +1 -1
- package/lib/generators/php/index.d.ts.map +1 -1
- package/lib/generators/php/index.js +22 -13
- package/lib/generators/php/index.js.map +1 -1
- package/lib/generators/python/index.d.ts.map +1 -1
- package/lib/generators/python/index.js +27 -17
- package/lib/generators/python/index.js.map +1 -1
- package/lib/generators/resolve.d.ts.map +1 -1
- package/lib/generators/resolve.js +7 -2
- package/lib/generators/resolve.js.map +1 -1
- package/lib/generators/swr/index.d.ts.map +1 -1
- package/lib/generators/swr/index.js +2 -1
- package/lib/generators/swr/index.js.map +1 -1
- package/lib/generators/swr/render.d.ts +2 -1
- package/lib/generators/swr/render.d.ts.map +1 -1
- package/lib/generators/swr/render.js +1 -1
- package/lib/generators/swr/render.js.map +1 -1
- package/lib/generators/tanstack-query/index.d.ts.map +1 -1
- package/lib/generators/tanstack-query/index.js +2 -1
- package/lib/generators/tanstack-query/index.js.map +1 -1
- package/lib/generators/tanstack-query/render.d.ts +2 -1
- package/lib/generators/tanstack-query/render.d.ts.map +1 -1
- package/lib/generators/tanstack-query/render.js +1 -1
- package/lib/generators/tanstack-query/render.js.map +1 -1
- package/lib/generators/types.d.ts +7 -0
- package/lib/generators/types.d.ts.map +1 -1
- package/lib/generators/typescript/telemetry/telemetry.js +3 -1
- package/lib/generators/typescript/telemetry/telemetry.js.map +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js.map +1 -1
- package/lib/intermediate-representation/build.d.ts.map +1 -1
- package/lib/intermediate-representation/build.js +18 -5
- package/lib/intermediate-representation/build.js.map +1 -1
- package/lib/intermediate-representation/sanitize-identifiers.d.ts.map +1 -1
- package/lib/intermediate-representation/sanitize-identifiers.js +4 -4
- package/lib/intermediate-representation/sanitize-identifiers.js.map +1 -1
- package/lib/pagination.d.ts.map +1 -1
- package/lib/pagination.js +7 -2
- package/lib/pagination.js.map +1 -1
- package/lib/pipeline.d.ts.map +1 -1
- package/lib/pipeline.js +23 -5
- package/lib/pipeline.js.map +1 -1
- package/lib/reserved-names.d.ts.map +1 -1
- package/lib/reserved-names.js +6 -0
- package/lib/reserved-names.js.map +1 -1
- package/lib/runtime-sources/go-telemetry.d.ts +3 -0
- package/lib/runtime-sources/go-telemetry.d.ts.map +1 -0
- package/lib/runtime-sources/go-telemetry.js +10 -0
- package/lib/runtime-sources/go-telemetry.js.map +1 -0
- package/lib/runtime-sources/go.d.ts +1 -1
- package/lib/runtime-sources/go.d.ts.map +1 -1
- package/lib/runtime-sources/go.js +1 -1
- package/lib/runtime-sources/go.js.map +1 -1
- package/lib/runtime-sources/php-telemetry.d.ts +3 -0
- package/lib/runtime-sources/php-telemetry.d.ts.map +1 -0
- package/lib/runtime-sources/php-telemetry.js +4 -0
- package/lib/runtime-sources/php-telemetry.js.map +1 -0
- package/lib/runtime-sources/php.d.ts +1 -1
- package/lib/runtime-sources/php.d.ts.map +1 -1
- package/lib/runtime-sources/php.js +1 -1
- package/lib/runtime-sources/php.js.map +1 -1
- package/lib/runtime-sources/python-telemetry.d.ts +2 -0
- package/lib/runtime-sources/python-telemetry.d.ts.map +1 -0
- package/lib/runtime-sources/python-telemetry.js +3 -0
- package/lib/runtime-sources/python-telemetry.js.map +1 -0
- package/lib/runtime-sources/python.d.ts +1 -1
- package/lib/runtime-sources/python.js +1 -1
- package/lib/runtime-sources/python.js.map +1 -1
- package/lib/runtime-sources/telemetry.d.ts +1 -1
- package/lib/runtime-sources/telemetry.d.ts.map +1 -1
- package/lib/runtime-sources/telemetry.js +1 -1
- package/lib/runtime-sources/telemetry.js.map +1 -1
- package/lib/runtime-sources.d.ts +3 -0
- package/lib/runtime-sources.d.ts.map +1 -1
- package/lib/runtime-sources.js +3 -0
- package/lib/runtime-sources.js.map +1 -1
- package/lib/types.d.ts +22 -0
- package/lib/types.d.ts.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -105,10 +105,12 @@ type GenerateClientResult = {
|
|
|
105
105
|
outputPath: string; // the `output` anchor path (the entry file in multi-file modes)
|
|
106
106
|
bytes: number; // total bytes written
|
|
107
107
|
files: Array<{ path: string; bytes: number }>; // every file written to disk
|
|
108
|
+
operations: Array<{ id: string; name: string }>; // the operationId (or the generated name) and the generated name
|
|
108
109
|
};
|
|
109
110
|
```
|
|
110
111
|
|
|
111
112
|
`GenerateClientOptions` is the options type ([`src/types.ts`](https://github.com/Redocly/redocly-cli/blob/main/packages/client-generator/src/types.ts)) (`api` and `output` required; `outputMode`, `runtime`, `importExt`, `argsStyle`, `errorMode`, `dateType`, `serverUrl`, `mockData`, `mockSeed`, `generators`, `customGenerators`, `options`, `setup`, `pagination`, `queryKeyPrefix`, `goPackage`, `cliOutput`, `codeSamples`, `docs`, `docsFrontmatter`, `telemetry` optional) plus an optional resolved Redocly `config` used to load the description.
|
|
113
|
+
`onFinding`, when set, receives each warning of the run as `{ kind, message, operations }`, besides the printed text.
|
|
112
114
|
|
|
113
115
|
### `collectGeneratedFiles`
|
|
114
116
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "cli" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator cli --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "cli" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator cli --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "cli" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator cli --update`.
|
|
@@ -21,7 +21,15 @@ import { cliAuthSchemes, commandData, renderCliModule } from './render.ts';
|
|
|
21
21
|
* bodies, env auth, `--page-all`, SSE/blob output, a documented exit-code
|
|
22
22
|
* contract). Requires `typescript` (throw mode); wires zod validation when co-selected.
|
|
23
23
|
*/
|
|
24
|
-
export const cliGenerator: Generator = ({
|
|
24
|
+
export const cliGenerator: Generator = ({
|
|
25
|
+
model,
|
|
26
|
+
output,
|
|
27
|
+
banner,
|
|
28
|
+
emit,
|
|
29
|
+
selected,
|
|
30
|
+
pagination,
|
|
31
|
+
reportFinding,
|
|
32
|
+
}) => {
|
|
25
33
|
const content = renderCliModule(model, {
|
|
26
34
|
stem: output.stem,
|
|
27
35
|
importExt: emit.importExt ?? 'js',
|
|
@@ -29,6 +37,7 @@ export const cliGenerator: Generator = ({ model, output, banner, emit, selected,
|
|
|
29
37
|
pagination,
|
|
30
38
|
argsStyle: emit.argsStyle ?? 'grouped',
|
|
31
39
|
runtime: emit.runtime ?? 'inline',
|
|
40
|
+
reportFinding,
|
|
32
41
|
});
|
|
33
42
|
const entry = { path: join(output.dir, `${output.stem}.cli.ts`), content };
|
|
34
43
|
if (emit.runtime !== 'module') return [entry];
|
|
@@ -86,5 +95,5 @@ export default {
|
|
|
86
95
|
docs: cliDocs,
|
|
87
96
|
requires: ["typescript","zod"],
|
|
88
97
|
errorModes: ["throw"],
|
|
89
|
-
requiresGenerator: '^0.
|
|
98
|
+
requiresGenerator: '^0.9.0',
|
|
90
99
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "cli" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator cli --update`.
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
// the `runCli` engine and dispatches through the sibling generated client.
|
|
8
8
|
|
|
9
9
|
import {
|
|
10
|
+
allOperations,
|
|
10
11
|
type ApiModel,
|
|
11
12
|
casing,
|
|
12
13
|
type CliAuthScheme,
|
|
@@ -17,11 +18,11 @@ import {
|
|
|
17
18
|
isBinaryContentType,
|
|
18
19
|
type ModelPagination,
|
|
19
20
|
type OperationModel,
|
|
21
|
+
type GeneratorInput,
|
|
20
22
|
type ParamModel,
|
|
21
23
|
type SchemaModel,
|
|
22
24
|
} from '@redocly/client-generator';
|
|
23
25
|
import { flatInputShape } from '@redocly/client-generator/contracts/typescript';
|
|
24
|
-
import { logger } from '@redocly/openapi-core';
|
|
25
26
|
|
|
26
27
|
import { embedCliRuntime } from './engine-source.ts';
|
|
27
28
|
|
|
@@ -169,6 +170,7 @@ function codeJson(value: unknown, indent?: number): string {
|
|
|
169
170
|
}
|
|
170
171
|
|
|
171
172
|
export type CliModuleOptions = {
|
|
173
|
+
reportFinding: GeneratorInput['reportFinding'];
|
|
172
174
|
stem: string;
|
|
173
175
|
importExt: string;
|
|
174
176
|
zodSelected: boolean;
|
|
@@ -205,15 +207,26 @@ function shadowedAddress(command: CliCommand): string {
|
|
|
205
207
|
* unreachable either way, but only the description's author can rename a side of the
|
|
206
208
|
* collision, so say it once at generation time.
|
|
207
209
|
*/
|
|
208
|
-
function warnShadowedCommands(
|
|
210
|
+
function warnShadowedCommands(
|
|
211
|
+
model: ApiModel,
|
|
212
|
+
commands: CliCommand[],
|
|
213
|
+
reportFinding: GeneratorInput['reportFinding']
|
|
214
|
+
): void {
|
|
209
215
|
const slugs = new Set(commands.filter((c) => c.group).map((c) => groupSlug(c.group as string)));
|
|
210
216
|
const shadowed = commands.filter((command) => slugs.has(command.name));
|
|
211
217
|
if (shadowed.length === 0) return;
|
|
212
|
-
|
|
213
|
-
|
|
218
|
+
// A command is named after its operation's generated name, which is unique in the model.
|
|
219
|
+
const shadowedNames = new Set(shadowed.map((command) => command.name));
|
|
220
|
+
const operationIds = allOperations(model.services)
|
|
221
|
+
.filter((operation) => shadowedNames.has(operation.name))
|
|
222
|
+
.map((operation) => operation.specName ?? operation.name);
|
|
223
|
+
reportFinding({
|
|
224
|
+
kind: 'command-shadowed',
|
|
225
|
+
message: `cli reads a leading group name as the group, so ${shadowed.length} operation(s) named after a tag resolve unusually — rename the operation or the tag: ${shadowed
|
|
214
226
|
.map(shadowedAddress)
|
|
215
|
-
.join(', ')}
|
|
216
|
-
|
|
227
|
+
.join(', ')}.`,
|
|
228
|
+
operations: operationIds,
|
|
229
|
+
});
|
|
217
230
|
}
|
|
218
231
|
|
|
219
232
|
/** The whole `<stem>.cli.ts` file. */
|
|
@@ -222,7 +235,7 @@ export function renderCliModule(model: ApiModel, options: CliModuleOptions): str
|
|
|
222
235
|
pagination: options.pagination,
|
|
223
236
|
argsStyle: options.argsStyle,
|
|
224
237
|
});
|
|
225
|
-
warnShadowedCommands(commands);
|
|
238
|
+
warnShadowedCommands(model, commands, options.reportFinding);
|
|
226
239
|
const schemes = cliAuthSchemes(model);
|
|
227
240
|
const clientModule = `./${options.stem}.${options.importExt}`;
|
|
228
241
|
const clientImports = ['client', 'configure', ...(options.zodSelected ? ['use'] : [])];
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "go" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator go --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "go" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator go --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "go" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator go --update`.
|
|
@@ -14,6 +14,8 @@ import {
|
|
|
14
14
|
type CodeSample,
|
|
15
15
|
type DateType,
|
|
16
16
|
type EmitOptions,
|
|
17
|
+
GENERATOR_VERSION,
|
|
18
|
+
type GeneratedFile,
|
|
17
19
|
type Generator,
|
|
18
20
|
identifierFor,
|
|
19
21
|
jsonSuccessSchema,
|
|
@@ -25,7 +27,7 @@ import {
|
|
|
25
27
|
sseResponse,
|
|
26
28
|
} from '@redocly/client-generator';
|
|
27
29
|
import { exported, GoPrinter } from '@redocly/client-generator/printers/go';
|
|
28
|
-
import { GO_RUNTIME_SOURCE } from '@redocly/client-generator/runtime-sources';
|
|
30
|
+
import { GO_RUNTIME_SOURCE, GO_TELEMETRY_SOURCE } from '@redocly/client-generator/runtime-sources';
|
|
29
31
|
|
|
30
32
|
import { writeGoServers } from './client.ts';
|
|
31
33
|
import { goPaginationLiteral, goSecurityLiteral } from './descriptor.ts';
|
|
@@ -250,17 +252,31 @@ export const goGenerator: Generator = ({ model, output, banner, emit, pagination
|
|
|
250
252
|
// between declarations and none at the end of the file.
|
|
251
253
|
content: printer.toString(),
|
|
252
254
|
};
|
|
253
|
-
|
|
254
|
-
// The runtime, verbatim except the package clause — same directory, same Go package.
|
|
255
|
+
const files: GeneratedFile[] = [entry];
|
|
255
256
|
const header = banner.map((line) => `// ${line}`).join('\n');
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
{
|
|
257
|
+
// The runtime and the telemetry module, verbatim except the package clause — same
|
|
258
|
+
// directory, same Go package.
|
|
259
|
+
if (!embedRuntime) {
|
|
260
|
+
const runtimeSource = GO_RUNTIME_SOURCE.replace(/^package .*$/m, `package ${packageName}`);
|
|
261
|
+
files.push({
|
|
260
262
|
path: entry.path.replace(/[^\\/]+$/, 'runtime.go'),
|
|
261
263
|
content: `${header}\n${runtimeSource.trimEnd()}\n`,
|
|
262
|
-
}
|
|
263
|
-
|
|
264
|
+
});
|
|
265
|
+
}
|
|
266
|
+
if (emit.telemetry === 'on') {
|
|
267
|
+
const telemetrySource = GO_TELEMETRY_SOURCE.replace(
|
|
268
|
+
/^package .*$/m,
|
|
269
|
+
`package ${packageName}`
|
|
270
|
+
).replace(
|
|
271
|
+
'usageTelemetryGeneratorVersion = "dev"',
|
|
272
|
+
() => `usageTelemetryGeneratorVersion = ${naming.string(GENERATOR_VERSION)}`
|
|
273
|
+
);
|
|
274
|
+
files.push({
|
|
275
|
+
path: entry.path.replace(/[^\\/]+$/, 'telemetry.go'),
|
|
276
|
+
content: `${header}\n${telemetrySource.trimEnd()}\n`,
|
|
277
|
+
});
|
|
278
|
+
}
|
|
279
|
+
return files;
|
|
264
280
|
};
|
|
265
281
|
|
|
266
282
|
/** One idiomatic Go call per operation — feeds `x-codeSamples` for docs. */
|
|
@@ -332,5 +348,5 @@ export default {
|
|
|
332
348
|
"argsStyle": "inputs follow the target language's own idiom",
|
|
333
349
|
"importExt": "the generated file has no relative imports"
|
|
334
350
|
},
|
|
335
|
-
requiresGenerator: '^0.
|
|
351
|
+
requiresGenerator: '^0.9.0',
|
|
336
352
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "go" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator go --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "go" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator go --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "go" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator go --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "go" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator go --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "go" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator go --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "java" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator java --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "java" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator java --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "java" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator java --update`.
|
|
@@ -22,7 +22,6 @@ import {
|
|
|
22
22
|
} from '@redocly/client-generator';
|
|
23
23
|
import { JavaPrinter } from '@redocly/client-generator/printers/java';
|
|
24
24
|
import { JAVA_RUNTIME_SOURCE } from '@redocly/client-generator/runtime-sources';
|
|
25
|
-
import { logger } from '@redocly/openapi-core';
|
|
26
25
|
|
|
27
26
|
import { writeServers } from './client.ts';
|
|
28
27
|
import { writeJavaModels } from './models.ts';
|
|
@@ -60,16 +59,25 @@ function runtimeBody(): string[] {
|
|
|
60
59
|
}
|
|
61
60
|
|
|
62
61
|
/** The whole generated file: package, imports, and the class nesting models, runtime, and methods. */
|
|
63
|
-
export const javaGenerator: Generator = ({
|
|
62
|
+
export const javaGenerator: Generator = ({
|
|
63
|
+
model,
|
|
64
|
+
output,
|
|
65
|
+
banner,
|
|
66
|
+
emit,
|
|
67
|
+
pagination,
|
|
68
|
+
reportFinding,
|
|
69
|
+
}) => {
|
|
64
70
|
const printer = new JavaPrinter();
|
|
65
71
|
const dateType = emit.dateType ?? 'string';
|
|
66
72
|
const className = javaClassName(output.stem, model);
|
|
67
73
|
const packageName = javaPackageName(model.title);
|
|
68
74
|
// A package the reader cannot see in the title would surprise the code that imports it.
|
|
69
75
|
if (packageName !== plainPackageName(model.title)) {
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
76
|
+
reportFinding({
|
|
77
|
+
kind: 'name-changed',
|
|
78
|
+
message: `the API title ${JSON.stringify(model.title)} cannot be a Java package as is, so the java SDK uses package "${packageName}" — rename the API title in the description to choose another.`,
|
|
79
|
+
operations: [],
|
|
80
|
+
});
|
|
73
81
|
}
|
|
74
82
|
const moduleRuntime = emit.runtime === 'module';
|
|
75
83
|
const runtimeClass = `${className}Runtime`;
|
|
@@ -241,5 +249,5 @@ export default {
|
|
|
241
249
|
"argsStyle": "inputs follow the target language's own idiom",
|
|
242
250
|
"importExt": "the generated file has no relative imports"
|
|
243
251
|
},
|
|
244
|
-
requiresGenerator: '^0.
|
|
252
|
+
requiresGenerator: '^0.9.0',
|
|
245
253
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "java" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator java --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "java" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator java --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "java" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator java --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "java" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator java --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "java" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator java --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "mock" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator mock --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "mock" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator mock --update`.
|
|
@@ -32,5 +32,5 @@ export default {
|
|
|
32
32
|
name: 'mock',
|
|
33
33
|
run: mockGenerator,
|
|
34
34
|
requires: ["typescript"],
|
|
35
|
-
requiresGenerator: '^0.
|
|
35
|
+
requiresGenerator: '^0.9.0',
|
|
36
36
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "mock" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator mock --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "mock" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator mock --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "mock" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator mock --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "php" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator php --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "php" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator php --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "php" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator php --update`.
|
|
@@ -11,6 +11,8 @@
|
|
|
11
11
|
|
|
12
12
|
import {
|
|
13
13
|
type CodeSample,
|
|
14
|
+
GENERATOR_VERSION,
|
|
15
|
+
type GeneratedFile,
|
|
14
16
|
type Generator,
|
|
15
17
|
identifierFor,
|
|
16
18
|
jsonSuccessSchema,
|
|
@@ -22,7 +24,10 @@ import {
|
|
|
22
24
|
sseResponse,
|
|
23
25
|
} from '@redocly/client-generator';
|
|
24
26
|
import { PhpPrinter } from '@redocly/client-generator/printers/php';
|
|
25
|
-
import {
|
|
27
|
+
import {
|
|
28
|
+
PHP_RUNTIME_SOURCE,
|
|
29
|
+
PHP_TELEMETRY_SOURCE,
|
|
30
|
+
} from '@redocly/client-generator/runtime-sources';
|
|
26
31
|
|
|
27
32
|
import { writeServers } from './client.ts';
|
|
28
33
|
import { phpPaginationLiteral, phpSecurityLiteral } from './descriptor.ts';
|
|
@@ -167,17 +172,30 @@ export const phpGenerator: Generator = ({ model, output, banner, emit, paginatio
|
|
|
167
172
|
);
|
|
168
173
|
|
|
169
174
|
const entry = { path: output.path.replace(/\.[^.\\/]+$/, '.php'), content: printer.toString() };
|
|
170
|
-
|
|
171
|
-
//
|
|
172
|
-
// namespace spans both files and every bare reference resolves unchanged.
|
|
175
|
+
// The runtime and the telemetry module, verbatim except their namespace: rewritten to
|
|
176
|
+
// the client's, so one namespace spans every file and every bare reference resolves.
|
|
173
177
|
const header = banner.map((line) => `// ${line}`).join('\n');
|
|
174
|
-
const
|
|
175
|
-
.replace(
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
178
|
+
const sibling = (name: string, source: string): GeneratedFile => ({
|
|
179
|
+
path: entry.path.replace(/[^\\/]+$/, name),
|
|
180
|
+
content: `${source
|
|
181
|
+
.replace(/^namespace .*$/m, `namespace ${namespace};`)
|
|
182
|
+
.replace(/^<\?php\n/, `<?php\n\n${header}\n`)
|
|
183
|
+
.trimEnd()}\n`,
|
|
184
|
+
});
|
|
185
|
+
const files: GeneratedFile[] = [entry];
|
|
186
|
+
if (emit.runtime === 'module') {
|
|
187
|
+
files.push(sibling('runtime.php', PHP_RUNTIME_SOURCE));
|
|
188
|
+
}
|
|
189
|
+
if (emit.telemetry === 'on') {
|
|
190
|
+
const telemetrySource = PHP_TELEMETRY_SOURCE.replace(
|
|
191
|
+
"private const GENERATOR_VERSION = 'dev';",
|
|
192
|
+
() => `private const GENERATOR_VERSION = ${phpString(GENERATOR_VERSION)};`
|
|
193
|
+
);
|
|
194
|
+
// Named after the client, so two clients in one folder do not share one telemetry file.
|
|
195
|
+
const clientName = entry.path.replace(/^.*[\\/]/, '');
|
|
196
|
+
files.push(sibling(clientName.replace(/\.php$/, '.telemetry.php'), telemetrySource));
|
|
197
|
+
}
|
|
198
|
+
return files;
|
|
181
199
|
};
|
|
182
200
|
|
|
183
201
|
/** One idiomatic PHP call per operation — feeds `x-codeSamples` for docs. */
|
|
@@ -234,5 +252,5 @@ export default {
|
|
|
234
252
|
"argsStyle": "inputs follow the target language's own idiom",
|
|
235
253
|
"importExt": "the generated file has no relative imports"
|
|
236
254
|
},
|
|
237
|
-
requiresGenerator: '^0.
|
|
255
|
+
requiresGenerator: '^0.9.0',
|
|
238
256
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "php" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator php --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "php" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator php --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "php" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator php --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "php" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator php --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "php" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator php --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "python" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator python --update`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Ejected from @redocly/client-generator@0.
|
|
1
|
+
// Ejected from @redocly/client-generator@0.9.0 — the built-in "python" generator.
|
|
2
2
|
// This file is yours: edit freely; the generated client stays machine-owned and is
|
|
3
3
|
// rebuilt by `redocly generate-client`. Newer generator versions merge in with
|
|
4
4
|
// `redocly eject-generator python --update`.
|