@twin.org/ts-to-schema 0.0.1-next.14 → 0.0.1-next.16

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/actionCommandTsToSchema.md +9 -3
  6. package/docs/reference/functions/buildCommandTsToSchema.md +3 -1
  7. package/docs/reference/functions/tsToSchema.md +9 -3
  8. package/docs/reference/interfaces/ITsToSchemaConfig.md +1 -1
  9. package/package.json +8 -8
package/dist/cjs/index.cjs CHANGED
@@ -238,7 +238,7 @@ class CLI extends cliCore.CLIBase {
238
238
  return this.execute({
239
239
  title: "TWIN TypeScript To Schema",
240
240
  appName: "ts-to-schema",
241
- version: "0.0.1-next.14",
241
+ version: "0.0.1-next.16",
242
242
  icon: "⚙️ ",
243
243
  supportsEnvFiles: false,
244
244
  overrideOutputWidth: options?.overrideOutputWidth
package/dist/esm/index.mjs CHANGED
@@ -235,7 +235,7 @@ class CLI extends CLIBase {
235
235
  return this.execute({
236
236
  title: "TWIN TypeScript To Schema",
237
237
  appName: "ts-to-schema",
238
- version: "0.0.1-next.14",
238
+ version: "0.0.1-next.16",
239
239
  icon: "⚙️ ",
240
240
  supportsEnvFiles: false,
241
241
  overrideOutputWidth: options?.overrideOutputWidth
package/docs/changelog.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # @twin.org/ts-to-schema - Changelog
2
2
 
3
- ## v0.0.1-next.14
3
+ ## v0.0.1-next.16
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/actionCommandTsToSchema.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
- • **outputFolder**: `string`
15
+ ### outputFolder
16
+
17
+ `string`
14
18
 
15
19
  The output folder for the schemas.
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/buildCommandTsToSchema.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/tsToSchema.md CHANGED
@@ -6,15 +6,21 @@ Convert the TypeScript definitions to JSON Schemas.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **config**: [`ITsToSchemaConfig`](../interfaces/ITsToSchemaConfig.md)
9
+ ### config
10
+
11
+ [`ITsToSchemaConfig`](../interfaces/ITsToSchemaConfig.md)
10
12
 
11
13
  The configuration for the app.
12
14
 
13
- • **outputFolder**: `string`
15
+ ### outputFolder
16
+
17
+ `string`
14
18
 
15
19
  The location of the folder to output the JSON schemas.
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/ITsToSchemaConfig.md CHANGED
@@ -36,4 +36,4 @@ External type references
36
36
 
37
37
  #### Index Signature
38
38
 
39
- \[`id`: `string`\]: `string`
39
+ \[`id`: `string`\]: `string`
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@twin.org/ts-to-schema",
3
- "version": "0.0.1-next.14",
3
+ "version": "0.0.1-next.16",
4
4
  "description": "Tool to convert TypeScript definitions to JSON schemas",
5
5
  "repository": {
6
6
  "type": "git",
7
7
  "url": "git+https://github.com/twinfoundation/tools.git",
8
- "directory": "packages/ts-to-schema"
8
+ "directory": "apps/ts-to-schema"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
11
11
  "license": "Apache-2.0",
@@ -16,10 +16,10 @@
16
16
  "dependencies": {
17
17
  "@twin.org/cli-core": "next",
18
18
  "@twin.org/core": "next",
19
- "@twin.org/nameof": "0.0.1-next.14",
20
- "commander": "12.1.0",
21
- "glob": "11.0.0",
22
- "jsonschema": "1.4.1",
19
+ "@twin.org/nameof": "0.0.1-next.16",
20
+ "commander": "13.0.0",
21
+ "glob": "11.0.1",
22
+ "jsonschema": "1.5.0",
23
23
  "ts-json-schema-generator": "2.4.0-next.1"
24
24
  },
25
25
  "main": "./dist/cjs/index.cjs",
@@ -27,9 +27,9 @@
27
27
  "types": "./dist/types/index.d.ts",
28
28
  "exports": {
29
29
  ".": {
30
+ "types": "./dist/types/index.d.ts",
30
31
  "require": "./dist/cjs/index.cjs",
31
- "import": "./dist/esm/index.mjs",
32
- "types": "./dist/types/index.d.ts"
32
+ "import": "./dist/esm/index.mjs"
33
33
  }
34
34
  },
35
35
  "files": [