@contentstack/cli 1.32.1 → 1.33.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 CHANGED
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli
18
18
  $ csdx COMMAND
19
19
  running command...
20
20
  $ csdx (--version|-v)
21
- @contentstack/cli/1.32.1 linux-x64 node-v18.20.5
21
+ @contentstack/cli/1.33.0 linux-x64 node-v18.20.5
22
22
  $ csdx --help [COMMAND]
23
23
  USAGE
24
24
  $ csdx COMMAND
@@ -119,6 +119,7 @@ USAGE
119
119
  * [`csdx plugins:unlink [PLUGIN]`](#csdx-pluginsunlink-plugin)
120
120
  * [`csdx plugins:update`](#csdx-pluginsupdate)
121
121
  * [`csdx tokens`](#csdx-tokens)
122
+ * [`csdx tsgen`](#csdx-tsgen)
122
123
  * [`csdx whoami`](#csdx-whoami)
123
124
 
124
125
  ## `csdx audit`
@@ -3866,7 +3867,7 @@ EXAMPLES
3866
3867
  $ csdx plugins
3867
3868
  ```
3868
3869
 
3869
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/index.ts)_
3870
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.24/src/commands/plugins/index.ts)_
3870
3871
 
3871
3872
  ## `csdx plugins:add PLUGIN`
3872
3873
 
@@ -3940,7 +3941,7 @@ EXAMPLES
3940
3941
  $ csdx plugins:inspect myplugin
3941
3942
  ```
3942
3943
 
3943
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/inspect.ts)_
3944
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.24/src/commands/plugins/inspect.ts)_
3944
3945
 
3945
3946
  ## `csdx plugins:install PLUGIN`
3946
3947
 
@@ -3989,7 +3990,7 @@ EXAMPLES
3989
3990
  $ csdx plugins:install someuser/someplugin
3990
3991
  ```
3991
3992
 
3992
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/install.ts)_
3993
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.24/src/commands/plugins/install.ts)_
3993
3994
 
3994
3995
  ## `csdx plugins:link PATH`
3995
3996
 
@@ -4020,7 +4021,7 @@ EXAMPLES
4020
4021
  $ csdx plugins:link myplugin
4021
4022
  ```
4022
4023
 
4023
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/link.ts)_
4024
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.24/src/commands/plugins/link.ts)_
4024
4025
 
4025
4026
  ## `csdx plugins:remove [PLUGIN]`
4026
4027
 
@@ -4061,7 +4062,7 @@ FLAGS
4061
4062
  --reinstall Reinstall all plugins after uninstalling.
4062
4063
  ```
4063
4064
 
4064
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/reset.ts)_
4065
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.24/src/commands/plugins/reset.ts)_
4065
4066
 
4066
4067
  ## `csdx plugins:uninstall [PLUGIN]`
4067
4068
 
@@ -4089,7 +4090,7 @@ EXAMPLES
4089
4090
  $ csdx plugins:uninstall myplugin
4090
4091
  ```
4091
4092
 
4092
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/uninstall.ts)_
4093
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.24/src/commands/plugins/uninstall.ts)_
4093
4094
 
4094
4095
  ## `csdx plugins:unlink [PLUGIN]`
4095
4096
 
@@ -4133,7 +4134,7 @@ DESCRIPTION
4133
4134
  Update installed plugins.
4134
4135
  ```
4135
4136
 
4136
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/update.ts)_
4137
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.24/src/commands/plugins/update.ts)_
4137
4138
 
4138
4139
  ## `csdx tokens`
4139
4140
 
@@ -4165,6 +4166,44 @@ EXAMPLES
4165
4166
  $ csdx auth:tokens
4166
4167
  ```
4167
4168
 
4169
+ ## `csdx tsgen`
4170
+
4171
+ generate TypeScript typings from a Stack
4172
+
4173
+ ```
4174
+ USAGE
4175
+ $ csdx tsgen -a <value> -o <value> [-p <value>] [-d] [--branch <value>] [--include-system-fields]
4176
+ [--api-type rest|graphql] [--namespace <value>]
4177
+
4178
+ FLAGS
4179
+ -a, --token-alias=<value> (required) delivery token alias
4180
+ -d, --[no-]doc include documentation comments
4181
+ -o, --output=<value> (required) full path to output
4182
+ -p, --prefix=<value> interface prefix, e.g. "I"
4183
+ --api-type=<option> [default: rest] [Optional] Please enter an API type to generate the type definitions.
4184
+ <options: rest|graphql>
4185
+ --branch=<value> branch
4186
+ --include-system-fields include system fields in generated types
4187
+ --namespace=<value> [Optional]Please enter a namespace for the GraphQL API type to organize the generated
4188
+ types.
4189
+
4190
+ DESCRIPTION
4191
+ generate TypeScript typings from a Stack
4192
+
4193
+ EXAMPLES
4194
+ $ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts"
4195
+
4196
+ $ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" -p "I"
4197
+
4198
+ $ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --no-doc
4199
+
4200
+ $ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --api-type graphql
4201
+
4202
+ $ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --api-type graphql --namespace "GraphQL"
4203
+ ```
4204
+
4205
+ _See code: [contentstack-cli-tsgen](https://github.com/Contentstack-Solutions/contentstack-cli-tsgen/blob/v3.0.1/src/commands/tsgen.ts)_
4206
+
4168
4207
  ## `csdx whoami`
4169
4208
 
4170
4209
  Display current users email address
@@ -1,4 +1,4 @@
1
1
  {
2
- "version": "1.32.1",
2
+ "version": "1.33.0",
3
3
  "commands": {}
4
4
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@contentstack/cli",
3
3
  "description": "Command-line tool (CLI) to interact with Contentstack",
4
- "version": "1.32.1",
4
+ "version": "1.33.0",
5
5
  "author": "Contentstack",
6
6
  "bin": {
7
7
  "csdx": "./bin/run.js"
@@ -22,30 +22,31 @@
22
22
  "prepack": "pnpm compile && oclif manifest && oclif readme"
23
23
  },
24
24
  "dependencies": {
25
- "@contentstack/cli-audit": "~1.7.3",
25
+ "@contentstack/cli-audit": "~1.7.4",
26
26
  "@contentstack/cli-auth": "~1.3.22",
27
27
  "@contentstack/cli-cm-bootstrap": "~1.13.0",
28
28
  "@contentstack/cli-cm-branches": "~1.2.0",
29
29
  "@contentstack/cli-cm-bulk-publish": "~1.7.1",
30
- "@contentstack/cli-cm-export": "~1.14.1",
31
30
  "@contentstack/cli-cm-clone": "~1.13.0",
31
+ "@contentstack/cli-cm-export": "~1.14.1",
32
32
  "@contentstack/cli-cm-export-to-csv": "~1.7.3",
33
33
  "@contentstack/cli-cm-import": "~1.19.3",
34
+ "@contentstack/cli-cm-import-setup": "1.0.0-beta.1",
34
35
  "@contentstack/cli-cm-migrate-rte": "~1.4.20",
35
36
  "@contentstack/cli-cm-seed": "~1.10.0",
36
37
  "@contentstack/cli-command": "~1.3.2",
37
38
  "@contentstack/cli-config": "~1.9.0",
38
- "@contentstack/cli-launch": "~1.3.0",
39
+ "@contentstack/cli-launch": "~1.3.1",
39
40
  "@contentstack/cli-migration": "~1.6.4",
40
41
  "@contentstack/cli-utilities": "~1.8.0",
41
- "@contentstack/management": "~1.18.4",
42
42
  "@contentstack/cli-variants": "~1.1.4",
43
- "@contentstack/cli-cm-import-setup": "1.0.0-beta.1",
43
+ "@contentstack/management": "~1.18.4",
44
44
  "@oclif/core": "^3.27.0",
45
- "@oclif/plugin-help": "^5",
45
+ "@oclif/plugin-help": "^5.2.20",
46
46
  "@oclif/plugin-not-found": "^2.4.3",
47
- "@oclif/plugin-plugins": "^5.4.22",
47
+ "@oclif/plugin-plugins": "^5.4.24",
48
48
  "chalk": "^4.1.2",
49
+ "contentstack-cli-tsgen": "^3.0.1",
49
50
  "debug": "^4.4.0",
50
51
  "figlet": "^1.8.0",
51
52
  "inquirer": "8.2.6",
@@ -57,7 +58,7 @@
57
58
  "winston": "^3.17.0"
58
59
  },
59
60
  "devDependencies": {
60
- "@oclif/test": "^4.1.3",
61
+ "@oclif/test": "^4.1.6",
61
62
  "@types/chai": "^4.3.20",
62
63
  "@types/inquirer": "^9.0.7",
63
64
  "@types/mkdirp": "^1.0.2",
@@ -152,7 +153,8 @@
152
153
  "@contentstack/cli-cm-branches",
153
154
  "@contentstack/cli-launch",
154
155
  "@contentstack/cli-audit",
155
- "@contentstack/cli-cm-import-setup"
156
+ "@contentstack/cli-cm-import-setup",
157
+ "contentstack-cli-tsgen"
156
158
  ],
157
159
  "hooks": {
158
160
  "prerun": [