stepzen 0.45.0-experimental.a6f5273 → 0.45.0-experimental.aa7017c

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 (240) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +93 -116
  3. package/bin/dev.cmd +1 -1
  4. package/bin/dev.js +37 -0
  5. package/bin/run.js +55 -0
  6. package/lib/commands/delete.d.ts +3 -3
  7. package/lib/commands/delete.d.ts.map +1 -1
  8. package/lib/commands/delete.js +36 -34
  9. package/lib/commands/delete.js.map +1 -1
  10. package/lib/commands/deploy.d.ts +10 -12
  11. package/lib/commands/deploy.d.ts.map +1 -1
  12. package/lib/commands/deploy.js +99 -102
  13. package/lib/commands/deploy.js.map +1 -1
  14. package/lib/commands/import/curl.d.ts +17 -24
  15. package/lib/commands/import/curl.d.ts.map +1 -1
  16. package/lib/commands/import/curl.js +86 -86
  17. package/lib/commands/import/curl.js.map +1 -1
  18. package/lib/commands/import/db2.d.ts +12 -60
  19. package/lib/commands/import/db2.d.ts.map +1 -1
  20. package/lib/commands/import/db2.js +52 -168
  21. package/lib/commands/import/db2.js.map +1 -1
  22. package/lib/commands/import/flow.d.ts +10 -71
  23. package/lib/commands/import/flow.d.ts.map +1 -1
  24. package/lib/commands/import/flow.js +39 -43
  25. package/lib/commands/import/flow.js.map +1 -1
  26. package/lib/commands/import/graphql.d.ts +10 -18
  27. package/lib/commands/import/graphql.d.ts.map +1 -1
  28. package/lib/commands/import/graphql.js +38 -42
  29. package/lib/commands/import/graphql.js.map +1 -1
  30. package/lib/commands/import/index.d.ts +7 -10
  31. package/lib/commands/import/index.d.ts.map +1 -1
  32. package/lib/commands/import/index.js +55 -55
  33. package/lib/commands/import/index.js.map +1 -1
  34. package/lib/commands/import/mysql.d.ts +14 -22
  35. package/lib/commands/import/mysql.d.ts.map +1 -1
  36. package/lib/commands/import/mysql.js +54 -57
  37. package/lib/commands/import/mysql.js.map +1 -1
  38. package/lib/commands/import/openapi.d.ts +9 -16
  39. package/lib/commands/import/openapi.d.ts.map +1 -1
  40. package/lib/commands/import/openapi.js +38 -41
  41. package/lib/commands/import/openapi.js.map +1 -1
  42. package/lib/commands/import/oracle.d.ts +12 -55
  43. package/lib/commands/import/oracle.d.ts.map +1 -1
  44. package/lib/commands/import/oracle.js +51 -158
  45. package/lib/commands/import/oracle.js.map +1 -1
  46. package/lib/commands/import/postgresql.d.ts +15 -23
  47. package/lib/commands/import/postgresql.d.ts.map +1 -1
  48. package/lib/commands/import/postgresql.js +55 -58
  49. package/lib/commands/import/postgresql.js.map +1 -1
  50. package/lib/commands/import/presto.d.ts +14 -22
  51. package/lib/commands/import/presto.d.ts.map +1 -1
  52. package/lib/commands/import/presto.js +58 -61
  53. package/lib/commands/import/presto.js.map +1 -1
  54. package/lib/commands/import/snowflake.d.ts +16 -24
  55. package/lib/commands/import/snowflake.d.ts.map +1 -1
  56. package/lib/commands/import/snowflake.js +62 -65
  57. package/lib/commands/import/snowflake.js.map +1 -1
  58. package/lib/commands/init.d.ts +5 -7
  59. package/lib/commands/init.d.ts.map +1 -1
  60. package/lib/commands/init.js +23 -23
  61. package/lib/commands/init.js.map +1 -1
  62. package/lib/commands/lint.d.ts +2 -4
  63. package/lib/commands/lint.d.ts.map +1 -1
  64. package/lib/commands/lint.js +16 -19
  65. package/lib/commands/lint.js.map +1 -1
  66. package/lib/commands/list.d.ts +4 -6
  67. package/lib/commands/list.d.ts.map +1 -1
  68. package/lib/commands/list.js +70 -64
  69. package/lib/commands/list.js.map +1 -1
  70. package/lib/commands/login.d.ts +8 -10
  71. package/lib/commands/login.d.ts.map +1 -1
  72. package/lib/commands/login.js +92 -95
  73. package/lib/commands/login.js.map +1 -1
  74. package/lib/commands/logout.d.ts +2 -3
  75. package/lib/commands/logout.d.ts.map +1 -1
  76. package/lib/commands/logout.js +12 -12
  77. package/lib/commands/logout.js.map +1 -1
  78. package/lib/commands/request.d.ts +10 -12
  79. package/lib/commands/request.d.ts.map +1 -1
  80. package/lib/commands/request.js +131 -130
  81. package/lib/commands/request.js.map +1 -1
  82. package/lib/commands/service.d.ts +12 -11
  83. package/lib/commands/service.d.ts.map +1 -1
  84. package/lib/commands/service.js +238 -206
  85. package/lib/commands/service.js.map +1 -1
  86. package/lib/commands/start.d.ts +13 -15
  87. package/lib/commands/start.d.ts.map +1 -1
  88. package/lib/commands/start.js +65 -61
  89. package/lib/commands/start.js.map +1 -1
  90. package/lib/commands/transpile.d.ts +8 -10
  91. package/lib/commands/transpile.d.ts.map +1 -1
  92. package/lib/commands/transpile.js +32 -35
  93. package/lib/commands/transpile.js.map +1 -1
  94. package/lib/commands/upload.d.ts +6 -8
  95. package/lib/commands/upload.d.ts.map +1 -1
  96. package/lib/commands/upload.js +42 -45
  97. package/lib/commands/upload.js.map +1 -1
  98. package/lib/commands/validate.d.ts +3 -4
  99. package/lib/commands/validate.d.ts.map +1 -1
  100. package/lib/commands/validate.js +24 -27
  101. package/lib/commands/validate.js.map +1 -1
  102. package/lib/commands/whoami.d.ts +6 -8
  103. package/lib/commands/whoami.d.ts.map +1 -1
  104. package/lib/commands/whoami.js +40 -49
  105. package/lib/commands/whoami.js.map +1 -1
  106. package/lib/generate/curl2sdl.d.ts +8 -8
  107. package/lib/generate/curl2sdl.d.ts.map +1 -1
  108. package/lib/generate/curl2sdl.js +17 -21
  109. package/lib/generate/curl2sdl.js.map +1 -1
  110. package/lib/generate/flags.d.ts +12 -11
  111. package/lib/generate/flags.d.ts.map +1 -1
  112. package/lib/generate/flags.js +20 -18
  113. package/lib/generate/flags.js.map +1 -1
  114. package/lib/generate/flow2sdl.d.ts +5 -5
  115. package/lib/generate/flow2sdl.d.ts.map +1 -1
  116. package/lib/generate/flow2sdl.js +14 -20
  117. package/lib/generate/flow2sdl.js.map +1 -1
  118. package/lib/generate/graphql2sdl.d.ts +5 -5
  119. package/lib/generate/graphql2sdl.d.ts.map +1 -1
  120. package/lib/generate/graphql2sdl.js +23 -29
  121. package/lib/generate/graphql2sdl.js.map +1 -1
  122. package/lib/generate/helpers.d.ts +5 -5
  123. package/lib/generate/helpers.d.ts.map +1 -1
  124. package/lib/generate/helpers.js +40 -45
  125. package/lib/generate/helpers.js.map +1 -1
  126. package/lib/generate/import-command.d.ts +7 -13
  127. package/lib/generate/import-command.d.ts.map +1 -1
  128. package/lib/generate/import-command.js +59 -54
  129. package/lib/generate/import-command.js.map +1 -1
  130. package/lib/generate/openapi2sdl.d.ts +4 -4
  131. package/lib/generate/openapi2sdl.d.ts.map +1 -1
  132. package/lib/generate/openapi2sdl.js +11 -17
  133. package/lib/generate/openapi2sdl.js.map +1 -1
  134. package/lib/generate/questions.d.ts +4 -0
  135. package/lib/generate/questions.d.ts.map +1 -1
  136. package/lib/generate/questions.js +28 -12
  137. package/lib/generate/questions.js.map +1 -1
  138. package/lib/generate/sql2sdl.d.ts +20 -14
  139. package/lib/generate/sql2sdl.d.ts.map +1 -1
  140. package/lib/generate/sql2sdl.js +66 -54
  141. package/lib/generate/sql2sdl.js.map +1 -1
  142. package/lib/hooks/init/version.d.ts +1 -1
  143. package/lib/hooks/init/version.d.ts.map +1 -1
  144. package/lib/hooks/init/version.js +12 -10
  145. package/lib/hooks/init/version.js.map +1 -1
  146. package/lib/hooks/prerun/check-upgrade.d.ts +1 -1
  147. package/lib/hooks/prerun/check-upgrade.d.ts.map +1 -1
  148. package/lib/hooks/prerun/check-upgrade.js +43 -47
  149. package/lib/hooks/prerun/check-upgrade.js.map +1 -1
  150. package/lib/hooks/prerun/ensure-config-file.d.ts +1 -1
  151. package/lib/hooks/prerun/ensure-config-file.d.ts.map +1 -1
  152. package/lib/hooks/prerun/ensure-config-file.js +10 -12
  153. package/lib/hooks/prerun/ensure-config-file.js.map +1 -1
  154. package/lib/hooks/prerun/ensure-permissions.d.ts +1 -1
  155. package/lib/hooks/prerun/ensure-permissions.d.ts.map +1 -1
  156. package/lib/hooks/prerun/ensure-permissions.js +16 -12
  157. package/lib/hooks/prerun/ensure-permissions.js.map +1 -1
  158. package/lib/index.js +2 -6
  159. package/lib/index.js.map +1 -1
  160. package/lib/shared/actions.d.ts +2 -2
  161. package/lib/shared/actions.d.ts.map +1 -1
  162. package/lib/shared/actions.js +16 -22
  163. package/lib/shared/actions.js.map +1 -1
  164. package/lib/shared/configuration.d.ts +5 -3
  165. package/lib/shared/configuration.d.ts.map +1 -1
  166. package/lib/shared/configuration.js +40 -53
  167. package/lib/shared/configuration.js.map +1 -1
  168. package/lib/shared/constants.d.ts +4 -4
  169. package/lib/shared/constants.d.ts.map +1 -1
  170. package/lib/shared/constants.js +71 -90
  171. package/lib/shared/constants.js.map +1 -1
  172. package/lib/shared/curl-parser.d.ts +2 -2
  173. package/lib/shared/curl-parser.d.ts.map +1 -1
  174. package/lib/shared/curl-parser.js +10 -14
  175. package/lib/shared/curl-parser.js.map +1 -1
  176. package/lib/shared/docker.d.ts +2 -4
  177. package/lib/shared/docker.d.ts.map +1 -1
  178. package/lib/shared/docker.js +41 -49
  179. package/lib/shared/docker.js.map +1 -1
  180. package/lib/shared/errors.js +8 -12
  181. package/lib/shared/errors.js.map +1 -1
  182. package/lib/shared/header-params-parser.d.ts +2 -4
  183. package/lib/shared/header-params-parser.d.ts.map +1 -1
  184. package/lib/shared/header-params-parser.js +24 -30
  185. package/lib/shared/header-params-parser.js.map +1 -1
  186. package/lib/shared/header.d.ts +7 -7
  187. package/lib/shared/header.d.ts.map +1 -1
  188. package/lib/shared/header.js +6 -11
  189. package/lib/shared/header.js.map +1 -1
  190. package/lib/shared/inquirer.d.ts +7 -6
  191. package/lib/shared/inquirer.d.ts.map +1 -1
  192. package/lib/shared/inquirer.js +29 -37
  193. package/lib/shared/inquirer.js.map +1 -1
  194. package/lib/shared/moniker.js +5 -10
  195. package/lib/shared/moniker.js.map +1 -1
  196. package/lib/shared/path-params-parser.d.ts +2 -2
  197. package/lib/shared/path-params-parser.d.ts.map +1 -1
  198. package/lib/shared/path-params-parser.js +7 -13
  199. package/lib/shared/path-params-parser.js.map +1 -1
  200. package/lib/shared/request-variables-parser.d.ts +4 -4
  201. package/lib/shared/request-variables-parser.d.ts.map +1 -1
  202. package/lib/shared/request-variables-parser.js +11 -15
  203. package/lib/shared/request-variables-parser.js.map +1 -1
  204. package/lib/shared/rmtemp.d.ts +1 -0
  205. package/lib/shared/rmtemp.d.ts.map +1 -1
  206. package/lib/shared/rmtemp.js +8 -11
  207. package/lib/shared/rmtemp.js.map +1 -1
  208. package/lib/shared/segment.d.ts +17 -2
  209. package/lib/shared/segment.d.ts.map +1 -1
  210. package/lib/shared/segment.js +91 -64
  211. package/lib/shared/segment.js.map +1 -1
  212. package/lib/shared/stepzen-sdk.d.ts +8 -8
  213. package/lib/shared/stepzen-sdk.d.ts.map +1 -1
  214. package/lib/shared/stepzen-sdk.js +28 -37
  215. package/lib/shared/stepzen-sdk.js.map +1 -1
  216. package/lib/shared/types.d.ts +13 -11
  217. package/lib/shared/types.d.ts.map +1 -1
  218. package/lib/shared/types.js +1 -2
  219. package/lib/shared/url-helpers.d.ts +4 -0
  220. package/lib/shared/url-helpers.d.ts.map +1 -1
  221. package/lib/shared/url-helpers.js +17 -15
  222. package/lib/shared/url-helpers.js.map +1 -1
  223. package/lib/shared/utils.d.ts +2 -2
  224. package/lib/shared/utils.d.ts.map +1 -1
  225. package/lib/shared/utils.js +56 -72
  226. package/lib/shared/utils.js.map +1 -1
  227. package/lib/shared/validation.js +13 -18
  228. package/lib/shared/validation.js.map +1 -1
  229. package/lib/shared/workspace.d.ts +1 -1
  230. package/lib/shared/workspace.d.ts.map +1 -1
  231. package/lib/shared/workspace.js +35 -46
  232. package/lib/shared/workspace.js.map +1 -1
  233. package/lib/shared/zen-command.d.ts +5 -10
  234. package/lib/shared/zen-command.d.ts.map +1 -1
  235. package/lib/shared/zen-command.js +133 -114
  236. package/lib/shared/zen-command.js.map +1 -1
  237. package/oclif.manifest.json +1254 -972
  238. package/package.json +34 -33
  239. package/bin/dev +0 -23
  240. package/bin/run +0 -36
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright IBM Corp. 2020, 2024
3
+ Copyright IBM Corp. 2020, 2025
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # StepZen CLI
2
2
 
3
- The StepZen Command Line Interface (CLI) tool enables you to set up and manage StepZen using commands in your command-line shell.
3
+ The StepZen Command Line Interface (CLI) tool enables you to set up and manage StepZen using commands in your command-line shell.
4
4
 
5
5
  After you have written or imported your GraphQL schema in the form of a Schema Definition Language (SDL) file, and defined your "configuration" in a YAML files, you can upload and deploy them to StepZen using the StepZen CLI - resulting in a live GraphQL endpoint.
6
6
 
@@ -9,16 +9,22 @@ After you have written or imported your GraphQL schema in the form of a Schema D
9
9
  `npm install -g stepzen`
10
10
 
11
11
  # Verifying your installation
12
+
12
13
  To verify your CLI installation, use the `stepzen --version` command:
13
14
 
14
15
  `$ stepzen (-v|--version|version)`
15
16
 
17
+ # Supported OS and Node versions
18
+
19
+ Last minor of Node LTS versions 18 or newer on Windows (and WSL2), Linux and macOS.
20
+
16
21
  ----------------------------------------
17
22
 
18
23
  <!-- toc -->
19
24
  * [StepZen CLI](#stepzen-cli)
20
25
  * [Installing](#installing)
21
26
  * [Verifying your installation](#verifying-your-installation)
27
+ * [Supported OS and Node versions](#supported-os-and-node-versions)
22
28
  * [Usage](#usage)
23
29
  * [QA from cloned repo](#qa-from-cloned-repo)
24
30
  * [Commands](#commands)
@@ -30,7 +36,7 @@ $ npm install -g stepzen
30
36
  $ stepzen COMMAND
31
37
  running command...
32
38
  $ stepzen (--version|-v)
33
- stepzen/0.45.0-experimental.a6f5273 linux-x64 node-v18.20.4
39
+ stepzen/0.45.0-experimental.aa7017c linux-x64 node-v18.20.5
34
40
  $ stepzen --help [COMMAND]
35
41
  USAGE
36
42
  $ stepzen COMMAND
@@ -38,7 +44,7 @@ USAGE
38
44
  ```
39
45
  <!-- usagestop -->
40
46
 
41
- # QA from cloned repo
47
+ # QA from cloned repo
42
48
  <!-- QA -->
43
49
  To run from code: `path-to-repo/bin/run start` (start or whatever command you're QAing)
44
50
  <!-- QAstop -->
@@ -51,14 +57,14 @@ To run from code: `path-to-repo/bin/run start` (start or whatever command you're
51
57
  -- OR (deprecated) --
52
58
 
53
59
  $ stepzen deploy ENDPOINT --schema=schema [--configurationsets=cs1[,cs2[,..]]]`](#stepzen-deploy-endpoint---configpathtoconfigyaml---dirpathtoworkspace---or-deprecated----stepzen-deploy-endpoint---schemaschema---configurationsetscs1cs2)
54
- * [`stepzen help [COMMANDS]`](#stepzen-help-commands)
60
+ * [`stepzen help [COMMAND]`](#stepzen-help-command)
55
61
  * [`stepzen import [SOURCE]`](#stepzen-import-source)
56
62
  * [`stepzen import curl`](#stepzen-import-curl)
57
- * [`stepzen import db2 [DSN]`](#stepzen-import-db2-dsn)
63
+ * [`stepzen import db2 [JDBCURL]`](#stepzen-import-db2-jdbcurl)
58
64
  * [`stepzen import flow [FLOW]`](#stepzen-import-flow-flow)
59
65
  * [`stepzen import graphql [URL]`](#stepzen-import-graphql-url)
60
66
  * [`stepzen import mysql [DSN]`](#stepzen-import-mysql-dsn)
61
- * [`stepzen import oracle [DSN]`](#stepzen-import-oracle-dsn)
67
+ * [`stepzen import oracle [JDBCURL]`](#stepzen-import-oracle-jdbcurl)
62
68
  * [`stepzen import postgres [DSN]`](#stepzen-import-postgres-dsn)
63
69
  * [`stepzen import postgresql [DSN]`](#stepzen-import-postgresql-dsn)
64
70
  * [`stepzen import singlestore [DSN]`](#stepzen-import-singlestore-dsn)
@@ -80,14 +86,14 @@ Delete an endpoint from your StepZen account.
80
86
 
81
87
  ```
82
88
  USAGE
83
- $ stepzen delete [ENDPOINT] [-h] [--non-interactive]
89
+ $ stepzen delete ENDPOINT [-h] [--non-interactive]
84
90
 
85
91
  ARGUMENTS
86
92
  ENDPOINT name of the endpoint (e.g. api/customers)
87
93
 
88
94
  FLAGS
89
- -h, --help Show CLI help
90
- --non-interactive Disable all interactive prompts
95
+ -h, --help Show CLI help
96
+ --non-interactive Disable all interactive prompts
91
97
 
92
98
  DESCRIPTION
93
99
  Delete an endpoint from your StepZen account.
@@ -105,10 +111,10 @@ Deploy to StepZen.
105
111
  USAGE
106
112
  $ stepzen deploy [ENDPOINT] [--config=path/to/config.yaml] [--dir=path/to/workspace]
107
113
 
108
- -- OR (deprecated) --
114
+ -- OR (deprecated)
115
+ --
109
116
 
110
- $
111
- stepzen deploy ENDPOINT --schema=schema [--configurationsets=cs1[,cs2[,..]]]
117
+ $ stepzen deploy ENDPOINT --schema=schema [--configurationsets=cs1[,cs2[,..]]]
112
118
 
113
119
  ARGUMENTS
114
120
  ENDPOINT name of the endpoint (e.g. api/customers)
@@ -153,16 +159,16 @@ DESCRIPTION
153
159
  Deploy to StepZen.
154
160
  ```
155
161
 
156
- ## `stepzen help [COMMANDS]`
162
+ ## `stepzen help [COMMAND]`
157
163
 
158
164
  Display help for stepzen.
159
165
 
160
166
  ```
161
167
  USAGE
162
- $ stepzen help [COMMANDS] [-n]
168
+ $ stepzen help [COMMAND...] [-n]
163
169
 
164
170
  ARGUMENTS
165
- COMMANDS Command to show help for.
171
+ COMMAND... Command to show help for.
166
172
 
167
173
  FLAGS
168
174
  -n, --nested-commands Include all nested commands in the output.
@@ -171,7 +177,7 @@ DESCRIPTION
171
177
  Display help for stepzen.
172
178
  ```
173
179
 
174
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.4/src/commands/help.ts)_
180
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.18/src/commands/help.ts)_
175
181
 
176
182
  ## `stepzen import [SOURCE]`
177
183
 
@@ -179,15 +185,15 @@ Import a schema for an external data source or an API endpoint into your GraphQL
179
185
 
180
186
  ```
181
187
  USAGE
182
- $ stepzen import [SOURCE] [-h] [--non-interactive] [--dir <value>]
188
+ $ stepzen import [SOURCE...] [-h] [--non-interactive] [--dir <value>]
183
189
 
184
190
  ARGUMENTS
185
- SOURCE kind of the data source: curl, graphql, mysql, postgresql, snowflake, db2, oracle (or a full DSN string)
191
+ SOURCE... kind of the data source: curl, graphql, mysql, postgresql, snowflake, db2, oracle (or a full DSN string)
186
192
 
187
193
  FLAGS
188
- -h, --help Show CLI help
189
- --dir=<value> Working directory
190
- --non-interactive Disable all interactive prompts
194
+ -h, --help Show CLI help
195
+ --dir=<value> Working directory
196
+ --non-interactive Disable all interactive prompts
191
197
 
192
198
  DESCRIPTION
193
199
  Import a schema for an external data source or an API endpoint into your GraphQL API.
@@ -200,8 +206,8 @@ Import a schema for a REST endpoint into your GraphQL API (uses the curl syntax)
200
206
 
201
207
  ```
202
208
  USAGE
203
- $ stepzen import curl [-h] [--non-interactive] [--dir <value>] [--name <value>] [--prefix <value>] [-H <value>]
204
- [--header-param <value>] [--query-name <value>] [--query-type <value>] [--path-params <value>]
209
+ $ stepzen import curl [-h] [--non-interactive] [--dir <value>] [--name <value>] [--prefix <value>] [-H
210
+ <value>...] [--header-param <value>...] [--query-name <value>] [--query-type <value>] [--path-params <value>]
205
211
 
206
212
  FLAGS
207
213
  -H, --header=<value>...
@@ -257,32 +263,25 @@ DESCRIPTION
257
263
  through a StepZen API, and adds the generated types and a query field into your GraphQL schema.
258
264
  ```
259
265
 
260
- ## `stepzen import db2 [DSN]`
266
+ ## `stepzen import db2 [JDBCURL]`
261
267
 
262
268
  Import a schema for a Db2 data source into your GraphQL API.
263
269
 
264
270
  ```
265
271
  USAGE
266
- $ stepzen import db2 [DSN] [-h] [--non-interactive] [--dir <value>] [--name <value>] [--db-host <value>]
267
- [--db-user <value>] [--db-password <value>] [--db-database <value>] [--db-schema <value>] [--db-link-types]
268
- [--db-include tables-only|views-only|tables-and-views] [--db-use-deprecated-2022-naming] [--ssl-connection]
272
+ $ stepzen import db2 [JDBCURL] [-h] [--non-interactive] [--dir <value>] [--name <value>] [--db-schema <value>]
273
+ [--db-link-types] [--db-include tables-only|views-only|tables-and-views] [--db-use-deprecated-2022-naming]
269
274
 
270
275
  ARGUMENTS
271
- DSN (optional) Data Source Name (DSN) of a Db2 database.
272
- Example: 'jdbc:db2://host:port/db:user=username;password=password;schema=schema;sslConnection=true/false;'
276
+ JDBCURL (optional) JDBC URL of a Db2 database.
277
+ Example: 'jdbc:db2://host:port/db:user=username;password=password;schema=schema;sslConnection=true/false;'
273
278
 
274
- Flags, such as --db-host, override the corresponding parts of the DSN (if both are provided).
279
+ The --db-schema flag overrides the schema part of the JDBC URL (if both are provided).
275
280
 
276
281
  FLAGS
277
282
  -h, --help
278
283
  Show CLI help
279
284
 
280
- --db-database=<value>
281
- Name of database to import
282
-
283
- --db-host=<value>
284
- Database host and optional port (as HOST[:PORT])
285
-
286
285
  --db-include=<option>
287
286
  Should the generated GraphQL schema be based only on database views, only on tables or on both
288
287
  <options: tables-only|views-only|tables-and-views>
@@ -291,9 +290,6 @@ FLAGS
291
290
  Automatically link types based on foreign key relationships using @materializer
292
291
  (https://stepzen.com/docs/features/linking-types)
293
292
 
294
- --db-password=<value>
295
- Database password
296
-
297
293
  --db-schema=<value>
298
294
  Database schema to import tables from (default: public)
299
295
 
@@ -306,9 +302,6 @@ FLAGS
306
302
  - the generated type and property names match exactly the DB table and column names
307
303
  - the generated field names use the customer and customerList style.
308
304
 
309
- --db-user=<value>
310
- Database user name
311
-
312
305
  --dir=<value>
313
306
  Working directory
314
307
 
@@ -319,9 +312,6 @@ FLAGS
319
312
  --non-interactive
320
313
  Disable all interactive prompts
321
314
 
322
- --ssl-connection
323
- Is SSL enabled?
324
-
325
315
  DESCRIPTION
326
316
  Import a schema for a Db2 data source into your GraphQL API.
327
317
 
@@ -335,8 +325,8 @@ Import StepZen flow expression as a query field into your GraphQL API.
335
325
 
336
326
  ```
337
327
  USAGE
338
- $ stepzen import flow [FLOW] [-h] [--non-interactive] [--dir <value>] [--name <value>] [-H <value> --endpoint
339
- <value>]
328
+ $ stepzen import flow [FLOW] [-h] [--non-interactive] [--dir <value>] [--name <value>] [-H <value>...
329
+ --endpoint <value>]
340
330
 
341
331
  FLAGS
342
332
  -H, --header=<value>... Specifies a request header to pass
@@ -345,12 +335,12 @@ FLAGS
345
335
  stepzen import curl https://example.com/api/customers \
346
336
  -H "Authorization: apikey SecretAPIKeyValue"
347
337
  -h, --help Show CLI help
348
- --dir=<value> Working directory
349
- --endpoint=<value> Use a custom GraphQL schema instead of the project's schema as the schema providing the steps
338
+ --dir=<value> Working directory
339
+ --endpoint=<value> Use a custom GraphQL schema instead of the project's schema as the schema providing the steps
350
340
  in the flow.
351
- --name=<value> Subfolder inside the workspace folder to save the imported schema files to. Defaults to the
341
+ --name=<value> Subfolder inside the workspace folder to save the imported schema files to. Defaults to the
352
342
  name of the imported schema.
353
- --non-interactive Disable all interactive prompts
343
+ --non-interactive Disable all interactive prompts
354
344
 
355
345
  DESCRIPTION
356
346
  Import StepZen flow expression as a query field into your GraphQL API.
@@ -366,7 +356,7 @@ Import a GraphQL API as a subgraph into your GraphQL API.
366
356
  ```
367
357
  USAGE
368
358
  $ stepzen import graphql [URL] [-h] [--non-interactive] [--dir <value>] [--name <value>] [--prefix <value>] [-H
369
- <value>] [--header-param <value>]
359
+ <value>...] [--header-param <value>...]
370
360
 
371
361
  FLAGS
372
362
  -H, --header=<value>...
@@ -478,32 +468,25 @@ ALIASES
478
468
  $ stepzen import singlestore
479
469
  ```
480
470
 
481
- ## `stepzen import oracle [DSN]`
471
+ ## `stepzen import oracle [JDBCURL]`
482
472
 
483
473
  Import a schema for a oracle data source into your GraphQL API.
484
474
 
485
475
  ```
486
476
  USAGE
487
- $ stepzen import oracle [DSN] [-h] [--non-interactive] [--dir <value>] [--name <value>] [--db-host <value>]
488
- [--db-user <value>] [--db-password <value>] [--db-database <value>] [--db-schema <value>] [--db-link-types]
489
- [--db-include tables-only|views-only|tables-and-views] [--db-use-deprecated-2022-naming]
477
+ $ stepzen import oracle [JDBCURL] [-h] [--non-interactive] [--dir <value>] [--name <value>] [--db-schema <value>]
478
+ [--db-link-types] [--db-include tables-only|views-only|tables-and-views] [--db-use-deprecated-2022-naming]
490
479
 
491
480
  ARGUMENTS
492
- DSN (optional) Data Source Name (DSN) of an Oracle database.
493
- Example: 'jdbc:oracle:thin:user/password@//host:port/db?currentschema=schema'
481
+ JDBCURL (optional) JDBC URL of an Oracle database.
482
+ Example: 'jdbc:oracle:thin:user/password@//host:port/db?currentschema=schema'
494
483
 
495
- Flags, such as --db-host, override the corresponding parts of the DSN (if both are provided).
484
+ The --db-schema flag overrides the schema part of the JDBC URL (if both are provided).
496
485
 
497
486
  FLAGS
498
487
  -h, --help
499
488
  Show CLI help
500
489
 
501
- --db-database=<value>
502
- Name of database to import
503
-
504
- --db-host=<value>
505
- Database host and optional port (as HOST[:PORT])
506
-
507
490
  --db-include=<option>
508
491
  Should the generated GraphQL schema be based only on database views, only on tables or on both
509
492
  <options: tables-only|views-only|tables-and-views>
@@ -512,9 +495,6 @@ FLAGS
512
495
  Automatically link types based on foreign key relationships using @materializer
513
496
  (https://stepzen.com/docs/features/linking-types)
514
497
 
515
- --db-password=<value>
516
- Database password
517
-
518
498
  --db-schema=<value>
519
499
  Database schema to import tables from (default: public)
520
500
 
@@ -527,9 +507,6 @@ FLAGS
527
507
  - the generated type and property names match exactly the DB table and column names
528
508
  - the generated field names use the customer and customerList style.
529
509
 
530
- --db-user=<value>
531
- Database user name
532
-
533
510
  --dir=<value>
534
511
  Working directory
535
512
 
@@ -844,10 +821,10 @@ USAGE
844
821
  $ stepzen init [DIRECTORY] [-h] [--non-interactive] [--endpoint <value>] [--yes]
845
822
 
846
823
  FLAGS
847
- -h, --help Show CLI help
848
- --endpoint=<value> Endpoint name (e.g. api/myapp)
849
- --non-interactive Disable all interactive prompts
850
- --yes Accept default answers to interactive prompts
824
+ -h, --help Show CLI help
825
+ --endpoint=<value> Endpoint name (e.g. api/myapp)
826
+ --non-interactive Disable all interactive prompts
827
+ --yes Accept default answers to interactive prompts
851
828
 
852
829
  DESCRIPTION
853
830
  Initialize a StepZen workspace in the current directory.
@@ -871,12 +848,12 @@ ARGUMENTS
871
848
  configurationsets [DEPRECATED] - StepZen configuration sets uploaded with stepzen upload (or stepzen start)
872
849
 
873
850
  FLAGS
874
- -h, --help Show CLI help
875
- --folder=<value> Filter the list to only show endpoints within a specific folder. example usage --folder folder_name
876
- or --folder !folder_name
877
- --name=<value> Filter the list to only show endpoints with a specific name. example usage --name endpoint_name or
878
- --name '!endpoint_name'
879
- --non-interactive Disable all interactive prompts
851
+ -h, --help Show CLI help
852
+ --folder=<value> Filter the list to only show endpoints within a specific folder. example usage --folder
853
+ folder_name or --folder !folder_name
854
+ --name=<value> Filter the list to only show endpoints with a specific name. example usage --name endpoint_name
855
+ or --name '!endpoint_name'
856
+ --non-interactive Disable all interactive prompts
880
857
 
881
858
  DESCRIPTION
882
859
  List endpoints, schemas and configuration sets in your StepZen account.
@@ -897,20 +874,20 @@ ARGUMENTS
897
874
  no domain is provided, stepzen.net is used by default. Check you domain from the StepZen Dashboard.
898
875
 
899
876
  FLAGS
900
- -a, --account=<value> StepZen account name (copy from https://stepzen.com/account). If not provided, the CLI
901
- prompts the users to enter one.
902
- -h, --help Show CLI help
903
- -k, --adminkey=<value> Admin key (copy from https://stepzen.com/account) If not provided, the CLI prompts the users
904
- to enter one.
905
- --introspection=<value> Override the default StepZen introspection service URL for all stepzen import commands. If
906
- not provided, use the default introspection URL.
907
-
908
- Example:
909
- stepzen login --introspection stepzen-introspection.mydomain.com
910
- --non-interactive Disable all interactive prompts
911
- --public Create a public anonymous StepZen account and use it. This is handy for trying StepZen out,
912
- but it not suitable for handling private data as all endpoints created with a public account
913
- will be public.
877
+ -a, --account=<value> StepZen account name (copy from https://stepzen.com/account). If not provided, the CLI
878
+ prompts the users to enter one.
879
+ -h, --help Show CLI help
880
+ -k, --adminkey=<value> Admin key (copy from https://stepzen.com/account) If not provided, the CLI prompts the
881
+ users to enter one.
882
+ --introspection=<value> Override the default StepZen introspection service URL for all stepzen import commands.
883
+ If not provided, use the default introspection URL.
884
+
885
+ Example:
886
+ stepzen login --introspection stepzen-introspection.mydomain.com
887
+ --non-interactive Disable all interactive prompts
888
+ --public Create a public anonymous StepZen account and use it. This is handy for trying StepZen
889
+ out, but it not suitable for handling private data as all endpoints created with a public
890
+ account will be public.
914
891
 
915
892
  DESCRIPTION
916
893
  Log in to StepZen.
@@ -925,8 +902,8 @@ USAGE
925
902
  $ stepzen logout [-h] [--non-interactive]
926
903
 
927
904
  FLAGS
928
- -h, --help Show CLI help
929
- --non-interactive Disable all interactive prompts
905
+ -h, --help Show CLI help
906
+ --non-interactive Disable all interactive prompts
930
907
 
931
908
  DESCRIPTION
932
909
  Log out of StepZen.
@@ -938,8 +915,8 @@ Send a GraphQL request to a StepZen endpoint and print the response, using the A
938
915
 
939
916
  ```
940
917
  USAGE
941
- $ stepzen request [QUERY] [-h] [--non-interactive] [--dir <value> | --endpoint <value>] [-H <value>]
942
- [--operation-name <value>] [--var <value>] [--var-file <value>] [-f <value>]
918
+ $ stepzen request [QUERY] [-h] [--non-interactive] [--dir <value> | --endpoint <value>] [-H <value>...]
919
+ [--operation-name <value>] [--var <value>...] [--var-file <value>] [-f <value>]
943
920
 
944
921
  ARGUMENTS
945
922
  QUERY GraphQL query (could include a query, a mutation or a subscription).
@@ -1033,15 +1010,15 @@ ARGUMENTS
1033
1010
  If no action is provided, print the service status and exit.
1034
1011
 
1035
1012
  FLAGS
1036
- -h, --help Show CLI help
1037
- --dsn=<value> DSN of a StepZen metadata database, e.g. postgres://user:password@172.17.0.1:5432/zenctl
1038
- --non-interactive Disable all interactive prompts
1039
- --port=<value> Override the TCP port on which the local StepZen service instance will listen for connections (port
1040
- 9000 by default).
1041
- --prompt Opens an interactive prompt to ask for database details (or fails, if running in a non-interactive
1042
- mode).
1043
- --reset-auto Create fresh empty metadata database. Note: all existing endpoints will be deleted and you will be
1044
- logged out.
1013
+ -h, --help Show CLI help
1014
+ --dsn=<value> DSN of a StepZen metadata database, e.g. postgres://user:password@172.17.0.1:5432/zenctl
1015
+ --non-interactive Disable all interactive prompts
1016
+ --port=<value> Override the TCP port on which the local StepZen service instance will listen for connections
1017
+ (port 9000 by default).
1018
+ --prompt Opens an interactive prompt to ask for database details (or fails, if running in a
1019
+ non-interactive mode).
1020
+ --reset-auto Create fresh empty metadata database. Note: all existing endpoints will be deleted and you will
1021
+ be logged out.
1045
1022
 
1046
1023
  DESCRIPTION
1047
1024
  Manage the local StepZen service instance (requires Docker).
@@ -1095,17 +1072,17 @@ DESCRIPTION
1095
1072
 
1096
1073
  ```
1097
1074
  USAGE
1098
- $ stepzen upload [TYPE] [DESTINATION] [-h] [--non-interactive] [--dir <value> | --file <value>] [--silent]
1075
+ $ stepzen upload TYPE DESTINATION [-h] [--non-interactive] [--dir <value> | --file <value>] [--silent]
1099
1076
 
1100
1077
  ARGUMENTS
1101
1078
  TYPE (configurationset|schema) type
1102
1079
  DESTINATION destination
1103
1080
 
1104
1081
  FLAGS
1105
- -h, --help Show CLI help
1106
- --dir=<value> A directory to upload
1107
- --file=<value> A file to upload
1108
- --non-interactive Disable all interactive prompts
1082
+ -h, --help Show CLI help
1083
+ --dir=<value> A directory to upload
1084
+ --file=<value> A file to upload
1085
+ --non-interactive Disable all interactive prompts
1109
1086
  --silent
1110
1087
 
1111
1088
  DESCRIPTION
@@ -1132,7 +1109,7 @@ FLAG DESCRIPTIONS
1132
1109
  Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
1133
1110
  ```
1134
1111
 
1135
- _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.2.1/src/commands/version.ts)_
1112
+ _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v2.2.16/src/commands/version.ts)_
1136
1113
 
1137
1114
  ## `stepzen whoami`
1138
1115
 
@@ -1143,12 +1120,12 @@ USAGE
1143
1120
  $ stepzen whoami [-h] [--non-interactive] [--showkeys | --account | --adminkey | --apikey | --domain]
1144
1121
 
1145
1122
  FLAGS
1146
- -h, --help Show CLI help
1123
+ -h, --help Show CLI help
1147
1124
  --account
1148
1125
  --adminkey
1149
1126
  --apikey
1150
1127
  --domain
1151
- --non-interactive Disable all interactive prompts
1128
+ --non-interactive Disable all interactive prompts
1152
1129
  --showkeys
1153
1130
 
1154
1131
  DESCRIPTION
package/bin/dev.cmd CHANGED
@@ -1,3 +1,3 @@
1
1
  @echo off
2
2
 
3
- node "%~dp0\dev" %*
3
+ node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*
package/bin/dev.js ADDED
@@ -0,0 +1,37 @@
1
+ #!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
2
+ /* eslint-disable n/shebang */
3
+
4
+ const performanceEnabled =
5
+ process.env.STEPZEN_ENABLE_PERF !== undefined &&
6
+ process.env.STEPZEN_ENABLE_PERF.toLocaleLowerCase() !== 'false'
7
+
8
+ if (performanceEnabled) {
9
+ process.env.DEBUG = process.env.DEBUG
10
+ ? `${process.env.DEBUG},oclif:non-oclif-perf`
11
+ : 'oclif:non-oclif-perf'
12
+ }
13
+
14
+ const {execute, settings} = await import('@oclif/core')
15
+ settings.performanceEnabled = performanceEnabled
16
+
17
+ try {
18
+ await execute({development: true, dir: import.meta.url})
19
+ } finally {
20
+ const start = Date.now()
21
+ const {analytics} = await import('../lib/shared/segment.js')
22
+ await analytics?.closeAndFlush()
23
+
24
+ // mimic oclif's Performance.mark() output
25
+ //
26
+ // Not using oclif's Performance API directly since at this point oclif is
27
+ // already shut down
28
+ if (settings.performanceEnabled) {
29
+ const boldred = '\u001B[38;5;196;1m'
30
+ const reset = '\u001B[0m'
31
+ console.log(
32
+ ` ${boldred}oclif:non-oclif-perf${reset} segment.flush: ${
33
+ Date.now() - start
34
+ }ms`,
35
+ )
36
+ }
37
+ }
package/bin/run.js ADDED
@@ -0,0 +1,55 @@
1
+ #!/usr/bin/env -S node --no-deprecation
2
+ /* eslint-disable n/shebang */
3
+
4
+ const message = `
5
+ ┌───────────────────────────────────────────────────────────────────┐
6
+ │ │
7
+ │ StepZen CLI does not support this version of NodeJS: $$version. │
8
+ │ Please upgrade to NodeJS 18 or newer. │
9
+ │ │
10
+ └───────────────────────────────────────────────────────────────────┘
11
+ `
12
+
13
+ const nodeMajor = Number.parseInt(process.version.match(/\d+\./), 10)
14
+ if (nodeMajor > 0 && nodeMajor < 18) {
15
+ const yellow = '\u001B[33m'
16
+ const reset = '\u001B[0m'
17
+ let version = `${process.version}.`
18
+ version += ' '.slice(0, '$$version'.length - version.length + 1)
19
+ console.warn(yellow + message.replace('$$version.', version) + reset)
20
+ }
21
+
22
+ const performanceEnabled =
23
+ process.env.STEPZEN_ENABLE_PERF !== undefined &&
24
+ process.env.STEPZEN_ENABLE_PERF.toLocaleLowerCase() !== 'false'
25
+
26
+ if (performanceEnabled) {
27
+ process.env.DEBUG = process.env.DEBUG
28
+ ? `${process.env.DEBUG},oclif:non-oclif-perf`
29
+ : 'oclif:non-oclif-perf'
30
+ }
31
+
32
+ const {execute, settings} = await import('@oclif/core')
33
+ settings.performanceEnabled = performanceEnabled
34
+
35
+ try {
36
+ await execute({dir: import.meta.url})
37
+ } finally {
38
+ const start = Date.now()
39
+ const {analytics} = await import('../lib/shared/segment.js')
40
+ await analytics?.closeAndFlush()
41
+
42
+ // mimic oclif's Performance.mark() output
43
+ //
44
+ // Not using oclif's Performance API directly since at this point oclif is
45
+ // already shut down
46
+ if (settings.performanceEnabled) {
47
+ const boldred = '\u001B[38;5;196;1m'
48
+ const reset = '\u001B[0m'
49
+ console.log(
50
+ ` ${boldred}oclif:non-oclif-perf${reset} segment.flush: ${
51
+ Date.now() - start
52
+ }ms`,
53
+ )
54
+ }
55
+ }
@@ -1,9 +1,9 @@
1
- import { type SDKClientV2 } from '@stepzen/sdk';
2
- import ZenCommand from '../shared/zen-command';
1
+ import type { SDKClientV2 } from '@stepzen/sdk';
2
+ import ZenCommand from '../shared/zen-command.js';
3
3
  export default class Delete extends ZenCommand {
4
4
  static description: string;
5
5
  static args: {
6
- endpoint: import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
6
+ endpoint: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
7
7
  };
8
8
  run(): Promise<void>;
9
9
  executeDelete({ client, endpoint, }: {
@@ -1 +1 @@
1
- {"version":3,"file":"delete.d.ts","sourceRoot":"","sources":["../../src/commands/delete.ts"],"names":[],"mappings":"AAKA,OAAO,EAAC,KAAK,WAAW,EAAC,MAAM,cAAc,CAAA;AAY7C,OAAO,UAAU,MAAM,uBAAuB,CAAA;AAE9C,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,UAAU;IAC5C,MAAM,CAAC,WAAW,SAAkD;IAEpE,MAAM,CAAC,IAAI;;MAKV;IAEK,GAAG;IAsFH,aAAa,CAAC,EAClB,MAAM,EACN,QAAQ,GACT,EAAE;QACD,MAAM,EAAE,WAAW,CAAA;QACnB,QAAQ,EAAE,MAAM,CAAA;KACjB;CAoCF"}
1
+ {"version":3,"file":"delete.d.ts","sourceRoot":"","sources":["../../src/commands/delete.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,cAAc,CAAA;AAiB7C,OAAO,UAAU,MAAM,0BAA0B,CAAA;AAEjD,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,UAAU;IAC5C,MAAM,CAAC,WAAW,SAAkD;IAEpE,MAAM,CAAC,IAAI;;MAKV;IAEK,GAAG;IA2FH,aAAa,CAAC,EAClB,MAAM,EACN,QAAQ,GACT,EAAE;QACD,MAAM,EAAE,WAAW,CAAA;QACnB,QAAQ,EAAE,MAAM,CAAA;KACjB;CAoCF"}