@twin.org/ts-to-openapi 0.0.1-next.13 → 0.0.1-next.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/dist/cjs/index.cjs +1 -1
  2. package/dist/esm/index.mjs +1 -1
  3. package/docs/changelog.md +1 -1
  4. package/docs/reference/classes/CLI.md +13 -5
  5. package/docs/reference/functions/actionCommandTsToOpenApi.md +9 -3
  6. package/docs/reference/functions/buildCommandTsToOpenApi.md +3 -1
  7. package/docs/reference/functions/tsToOpenApi.md +9 -3
  8. package/docs/reference/interfaces/ITsToOpenApiConfig.md +25 -1
  9. package/package.json +3 -3
package/dist/cjs/index.cjs CHANGED
@@ -1110,7 +1110,7 @@ class CLI extends cliCore.CLIBase {
1110
1110
  return this.execute({
1111
1111
  title: "TWIN TypeScript To OpenAPI",
1112
1112
  appName: "ts-to-openapi",
1113
- version: "0.0.1-next.13",
1113
+ version: "0.0.1-next.15",
1114
1114
  icon: "⚙️ ",
1115
1115
  supportsEnvFiles: false,
1116
1116
  overrideOutputWidth: options?.overrideOutputWidth
package/dist/esm/index.mjs CHANGED
@@ -1107,7 +1107,7 @@ class CLI extends CLIBase {
1107
1107
  return this.execute({
1108
1108
  title: "TWIN TypeScript To OpenAPI",
1109
1109
  appName: "ts-to-openapi",
1110
- version: "0.0.1-next.13",
1110
+ version: "0.0.1-next.15",
1111
1111
  icon: "⚙️ ",
1112
1112
  supportsEnvFiles: false,
1113
1113
  overrideOutputWidth: options?.overrideOutputWidth
package/docs/changelog.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # @twin.org/ts-to-openapi - Changelog
2
2
 
3
- ## v0.0.1-next.13
3
+ ## v0.0.1-next.15
4
4
 
5
5
  - Initial Release
package/docs/reference/classes/CLI.md CHANGED
@@ -30,19 +30,25 @@ Run the app.
30
30
 
31
31
  #### Parameters
32
32
 
33
- • **argv**: `string`[]
33
+ ##### argv
34
+
35
+ `string`[]
34
36
 
35
37
  The process arguments.
36
38
 
37
- • **localesDirectory?**: `string`
39
+ ##### localesDirectory?
40
+
41
+ `string`
38
42
 
39
43
  The directory for the locales, default to relative to the script.
40
44
 
41
- • **options?**
45
+ ##### options?
42
46
 
43
47
  Additional options.
44
48
 
45
- • **options.overrideOutputWidth?**: `number`
49
+ ###### overrideOutputWidth
50
+
51
+ `number`
46
52
 
47
53
  Override the output width.
48
54
 
@@ -62,7 +68,9 @@ Configure any options or actions at the root program level.
62
68
 
63
69
  #### Parameters
64
70
 
65
- • **program**: `Command`
71
+ ##### program
72
+
73
+ `Command`
66
74
 
67
75
  The root program command.
68
76
 
package/docs/reference/functions/actionCommandTsToOpenApi.md CHANGED
@@ -6,15 +6,21 @@ Action the root command.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **configFile**: `string`
9
+ ### configFile
10
+
11
+ `string`
10
12
 
11
13
  The optional configuration file.
12
14
 
13
- • **outputFile**: `string`
15
+ ### outputFile
16
+
17
+ `string`
14
18
 
15
19
  The output file for the generation OpenApi spec.
16
20
 
17
- • **opts**: `unknown`
21
+ ### opts
22
+
23
+ `unknown`
18
24
 
19
25
  The options for the command.
20
26
 
package/docs/reference/functions/buildCommandTsToOpenApi.md CHANGED
@@ -6,7 +6,9 @@ Build the root command to be consumed by the CLI.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **program**: `Command`
9
+ ### program
10
+
11
+ `Command`
10
12
 
11
13
  The command to build on.
12
14
 
package/docs/reference/functions/tsToOpenApi.md CHANGED
@@ -6,15 +6,21 @@ Convert the TypeScript definitions to OpenAPI spec.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **config**: [`ITsToOpenApiConfig`](../interfaces/ITsToOpenApiConfig.md)
9
+ ### config
10
+
11
+ [`ITsToOpenApiConfig`](../interfaces/ITsToOpenApiConfig.md)
10
12
 
11
13
  The configuration for the app.
12
14
 
13
- • **outputFile**: `string`
15
+ ### outputFile
16
+
17
+ `string`
14
18
 
15
19
  The location of the file to output the OpenAPI spec.
16
20
 
17
- • **workingDirectory**: `string`
21
+ ### workingDirectory
22
+
23
+ `string`
18
24
 
19
25
  The folder the app was run from.
20
26
 
package/docs/reference/interfaces/ITsToOpenApiConfig.md CHANGED
@@ -66,6 +66,30 @@ The authentication methods.
66
66
 
67
67
  The packages containing routes.
68
68
 
69
+ #### package?
70
+
71
+ > `optional` **package**: `string`
72
+
73
+ The package containing the routes.
74
+
75
+ #### version?
76
+
77
+ > `optional` **version**: `string`
78
+
79
+ The version of the package to use, defaults to latest.
80
+
81
+ #### packageRoot?
82
+
83
+ > `optional` **packageRoot**: `string`
84
+
85
+ To point to a local instance of a package use this property instead of package/version.
86
+
87
+ #### entryPoints?
88
+
89
+ > `optional` **entryPoints**: [`ITsToOpenApiConfigEntryPoint`](ITsToOpenApiConfigEntryPoint.md)[]
90
+
91
+ The rest entry points to include, defaults to all exported entry points.
92
+
69
93
  ***
70
94
 
71
95
  ### externalReferences?
@@ -76,4 +100,4 @@ External type references
76
100
 
77
101
  #### Index Signature
78
102
 
79
- \[`id`: `string`\]: `string`
103
+ \[`id`: `string`\]: `string`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/ts-to-openapi",
3
- "version": "0.0.1-next.13",
3
+ "version": "0.0.1-next.15",
4
4
  "description": "Tool to convert TypeScript REST route definitions to OpenAPI Specifications",
5
5
  "repository": {
6
6
  "type": "git",
@@ -17,9 +17,9 @@
17
17
  "@twin.org/api-models": "next",
18
18
  "@twin.org/cli-core": "next",
19
19
  "@twin.org/core": "next",
20
- "@twin.org/nameof": "0.0.1-next.13",
20
+ "@twin.org/nameof": "0.0.1-next.15",
21
21
  "@twin.org/web": "next",
22
- "commander": "12.1.0",
22
+ "commander": "13.0.0",
23
23
  "glob": "11.0.0",
24
24
  "jsonschema": "1.4.1",
25
25
  "ts-json-schema-generator": "2.4.0-next.1"