stepzen 0.26.0-beta.0 → 0.26.0-beta.1
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 +12 -1
- package/lib/commands/request.d.ts +6 -2
- package/lib/commands/request.d.ts.map +1 -1
- package/lib/commands/request.js +79 -20
- package/lib/commands/request.js.map +1 -1
- package/oclif.manifest.json +1 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -30,7 +30,7 @@ $ npm install -g stepzen
|
|
|
30
30
|
$ stepzen COMMAND
|
|
31
31
|
running command...
|
|
32
32
|
$ stepzen (-v|--version|version)
|
|
33
|
-
stepzen/0.26.0-beta.
|
|
33
|
+
stepzen/0.26.0-beta.1 linux-x64 node-v14.21.1
|
|
34
34
|
$ stepzen --help [COMMAND]
|
|
35
35
|
USAGE
|
|
36
36
|
$ stepzen COMMAND
|
|
@@ -282,6 +282,14 @@ ARGUMENTS
|
|
|
282
282
|
QUERY GraphQL query (could include a query, a mutation or a subscription)
|
|
283
283
|
|
|
284
284
|
OPTIONS
|
|
285
|
+
-H, --header=header
|
|
286
|
+
Add an additional HTTP header to the request. This is useful for schemas where @rest or @graphql directives enable
|
|
287
|
+
header forwarding with forwardheaders.
|
|
288
|
+
|
|
289
|
+
Example:
|
|
290
|
+
stepzen request '{ user(id: "u123") { email } }' \
|
|
291
|
+
-H "X-API-Token: SecretAPIToken"
|
|
292
|
+
|
|
285
293
|
-h, --help
|
|
286
294
|
Show CLI help
|
|
287
295
|
|
|
@@ -291,6 +299,9 @@ OPTIONS
|
|
|
291
299
|
--endpoint=endpoint
|
|
292
300
|
StepZen endpoint to call (defaults to the endpoint in current StepZen workspace)
|
|
293
301
|
|
|
302
|
+
--operation-name=operation-name
|
|
303
|
+
Specify the operation name (in case if the provided query includes multiple operations)
|
|
304
|
+
|
|
294
305
|
--var=var
|
|
295
306
|
Add a request variable, in the name=value format.
|
|
296
307
|
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import { flags } from '@oclif/command';
|
|
2
2
|
import ZenCommand from '../shared/zen-command';
|
|
3
|
-
import type {
|
|
3
|
+
import type { OperationDefinitionNode } from 'graphql';
|
|
4
4
|
export default class Request extends ZenCommand {
|
|
5
5
|
static description: string;
|
|
6
6
|
static flags: {
|
|
7
7
|
dir: flags.IOptionFlag<string | undefined>;
|
|
8
8
|
endpoint: flags.IOptionFlag<string | undefined>;
|
|
9
|
+
header: flags.IOptionFlag<string[]>;
|
|
10
|
+
'operation-name': flags.IOptionFlag<string | undefined>;
|
|
9
11
|
var: flags.IOptionFlag<string[]>;
|
|
10
12
|
'var-file': flags.IOptionFlag<string | undefined>;
|
|
11
13
|
help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
|
|
@@ -17,6 +19,8 @@ export default class Request extends ZenCommand {
|
|
|
17
19
|
required: boolean;
|
|
18
20
|
}[];
|
|
19
21
|
run(): Promise<void>;
|
|
20
|
-
|
|
22
|
+
getRequestOperation(query: string, operationName?: string): OperationDefinitionNode;
|
|
23
|
+
getRequestVariables(opdef: OperationDefinitionNode, variableFlags?: string[], varFileFlag?: string): Record<string, any>;
|
|
24
|
+
getAdditionalRequestHeaders(headerFlagValues?: string[]): Record<string, string>;
|
|
21
25
|
}
|
|
22
26
|
//# sourceMappingURL=request.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/commands/request.ts"],"names":[],"mappings":"AASA,OAAO,EAAC,KAAK,EAAC,MAAM,gBAAgB,CAAA;AASpC,OAAO,UAAU,MAAM,uBAAuB,CAAA;AAI9C,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/commands/request.ts"],"names":[],"mappings":"AASA,OAAO,EAAC,KAAK,EAAC,MAAM,gBAAgB,CAAA;AASpC,OAAO,UAAU,MAAM,uBAAuB,CAAA;AAI9C,OAAO,KAAK,EAIV,uBAAuB,EACxB,MAAM,SAAS,CAAA;AA2BhB,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,UAAU;IAC7C,MAAM,CAAC,WAAW,SAGH;IAEf,MAAM,CAAC,KAAK;;;;;;;;;MAmDX;IAED,MAAM,CAAC,IAAI;;;;QAOV;IAEK,GAAG;IAuJT,mBAAmB,CACjB,KAAK,EAAE,MAAM,EACb,aAAa,CAAC,EAAE,MAAM,GACrB,uBAAuB;IA2C1B,mBAAmB,CACjB,KAAK,EAAE,uBAAuB,EAC9B,aAAa,CAAC,EAAE,MAAM,EAAE,EACxB,WAAW,CAAC,EAAE,MAAM,GACnB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAyBtB,2BAA2B,CACzB,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAC1B,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CA0B1B"}
|
package/lib/commands/request.js
CHANGED
|
@@ -19,6 +19,7 @@ const zen_command_1 = require("../shared/zen-command");
|
|
|
19
19
|
const constants_1 = require("../shared/constants");
|
|
20
20
|
const utils_1 = require("../shared/utils");
|
|
21
21
|
const request_variables_parser_1 = require("../shared/request-variables-parser");
|
|
22
|
+
const header_1 = require("../shared/header");
|
|
22
23
|
const formatErrorMessage = (errors) => {
|
|
23
24
|
if (/Syntax Error GraphQL request/i.test(errors?.[0]?.message)) {
|
|
24
25
|
// Special case: in this case the error message also contains the
|
|
@@ -38,14 +39,9 @@ const formatErrorMessage = (errors) => {
|
|
|
38
39
|
class Request extends zen_command_1.default {
|
|
39
40
|
async run() {
|
|
40
41
|
const { args, flags } = this.parse(Request);
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
}
|
|
45
|
-
catch (error) {
|
|
46
|
-
throw new errors_1.CLIError(`Failed to parse the GraphQL query\n${error}`);
|
|
47
|
-
}
|
|
48
|
-
const variables = this.getRequestVariables(parsedQuery, flags.var, flags['var-file']);
|
|
42
|
+
const operation = this.getRequestOperation(args.query, flags['operation-name']);
|
|
43
|
+
const variables = this.getRequestVariables(operation, flags.var, flags['var-file']);
|
|
44
|
+
const headers = this.getAdditionalRequestHeaders(flags.header);
|
|
49
45
|
// Make sure the user is logged in
|
|
50
46
|
const { configuration } = await this.ensureStepZenAccount();
|
|
51
47
|
const zenserv = (0, constants_1.getZenServUrl)(configuration);
|
|
@@ -61,9 +57,7 @@ class Request extends zen_command_1.default {
|
|
|
61
57
|
}
|
|
62
58
|
try {
|
|
63
59
|
const { result: userAgent } = await (0, stepzen_sdk_1.tryZenCtl2ThenZenCtl1)(configuration, stepzen => Promise.resolve(stepzen.userAgent));
|
|
64
|
-
|
|
65
|
-
node.operation === 'subscription');
|
|
66
|
-
if (hasSubscription) {
|
|
60
|
+
if (operation.operation === 'subscription') {
|
|
67
61
|
const url = `${zenserv}/stepzen-subscriptions/${endpoint}/__graphql`.replace(/^http/i, 'ws');
|
|
68
62
|
const client = (0, graphql_ws_1.createClient)({
|
|
69
63
|
webSocketImpl: ws_1.WebSocket,
|
|
@@ -71,8 +65,9 @@ class Request extends zen_command_1.default {
|
|
|
71
65
|
connectionParams: () => {
|
|
72
66
|
return {
|
|
73
67
|
headers: {
|
|
74
|
-
|
|
75
|
-
'
|
|
68
|
+
authorization: `APIKey ${configuration.apikey}`,
|
|
69
|
+
'user-agent': userAgent,
|
|
70
|
+
...headers,
|
|
76
71
|
},
|
|
77
72
|
};
|
|
78
73
|
},
|
|
@@ -84,6 +79,7 @@ class Request extends zen_command_1.default {
|
|
|
84
79
|
client.subscribe({
|
|
85
80
|
query: args.query,
|
|
86
81
|
variables,
|
|
82
|
+
operationName: flags['operation-name'],
|
|
87
83
|
}, {
|
|
88
84
|
next: result => {
|
|
89
85
|
if (count === 0) {
|
|
@@ -95,7 +91,7 @@ class Request extends zen_command_1.default {
|
|
|
95
91
|
lastTimestamp = timestamp;
|
|
96
92
|
lastResult = result;
|
|
97
93
|
count += 1;
|
|
98
|
-
this.log(chalk `{grey
|
|
94
|
+
this.log(chalk `{grey event #${count} ({cyan +${elapsed}})}`);
|
|
99
95
|
const prefix = chalk.grey(`${count} | `);
|
|
100
96
|
this.log((0, utils_1.prependEachLine)(JSON.stringify(result, undefined, 2), prefix));
|
|
101
97
|
},
|
|
@@ -124,9 +120,11 @@ class Request extends zen_command_1.default {
|
|
|
124
120
|
url: `${zenserv}/${endpoint}/__graphql`,
|
|
125
121
|
query: args.query,
|
|
126
122
|
variables,
|
|
123
|
+
operationName: flags['operation-name'],
|
|
127
124
|
headers: {
|
|
128
|
-
|
|
129
|
-
'
|
|
125
|
+
authorization: `APIKey ${configuration.apikey}`,
|
|
126
|
+
'user-agent': userAgent,
|
|
127
|
+
...headers,
|
|
130
128
|
},
|
|
131
129
|
});
|
|
132
130
|
if (!result.data && result.errors) {
|
|
@@ -149,11 +147,35 @@ class Request extends zen_command_1.default {
|
|
|
149
147
|
throw new errors_1.CLIError(message);
|
|
150
148
|
}
|
|
151
149
|
}
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
150
|
+
getRequestOperation(query, operationName) {
|
|
151
|
+
let parsedQuery;
|
|
152
|
+
try {
|
|
153
|
+
parsedQuery = (0, graphql_1.parse)(query);
|
|
154
|
+
}
|
|
155
|
+
catch (error) {
|
|
156
|
+
throw new errors_1.CLIError(`Failed to parse the GraphQL query\n${error}`);
|
|
157
|
+
}
|
|
158
|
+
const operations = parsedQuery.definitions.filter(node => node.kind === 'OperationDefinition');
|
|
159
|
+
if (operations.length === 0) {
|
|
160
|
+
throw new errors_1.CLIError(`Please provide a GraphQL request with at least one operation:` +
|
|
161
|
+
` query, mutation or subscription.`);
|
|
162
|
+
}
|
|
163
|
+
if (operationName) {
|
|
164
|
+
const operation = operations.find(odn => odn.name?.value === operationName);
|
|
165
|
+
if (!operation) {
|
|
166
|
+
throw new errors_1.CLIError(chalk `Operation {bold ${operationName}} is not defined in the provided request.`);
|
|
167
|
+
}
|
|
168
|
+
return operation;
|
|
169
|
+
}
|
|
170
|
+
if (operations.length > 1) {
|
|
171
|
+
throw new errors_1.CLIError(chalk `The request contains multiple operations, but the operation` +
|
|
172
|
+
chalk ` name is not provided. Please provide an operation name with` +
|
|
173
|
+
chalk ` the {bold --operation-name} flag, or remove all other` +
|
|
174
|
+
chalk ` operations except the intended one from the request.`);
|
|
156
175
|
}
|
|
176
|
+
return operations[0];
|
|
177
|
+
}
|
|
178
|
+
getRequestVariables(opdef, variableFlags, varFileFlag) {
|
|
157
179
|
if (varFileFlag) {
|
|
158
180
|
try {
|
|
159
181
|
return JSON.parse(fs.readFileSync(varFileFlag, 'utf8'));
|
|
@@ -168,6 +190,29 @@ class Request extends zen_command_1.default {
|
|
|
168
190
|
}
|
|
169
191
|
return variables;
|
|
170
192
|
}
|
|
193
|
+
getAdditionalRequestHeaders(headerFlagValues) {
|
|
194
|
+
const headers = {};
|
|
195
|
+
if (headerFlagValues) {
|
|
196
|
+
headerFlagValues.forEach(headerFlag => {
|
|
197
|
+
const headerOrError = (0, header_1.parseHeader)(headerFlag);
|
|
198
|
+
if (headerOrError && 'error' in headerOrError) {
|
|
199
|
+
throw new errors_1.CLIError(headerOrError.error);
|
|
200
|
+
}
|
|
201
|
+
// A `null` from parseHeader() means a header should NOT be
|
|
202
|
+
// sent. This is not supported by zenserv / the introspection service
|
|
203
|
+
// so the CLI simply omits such headers
|
|
204
|
+
if (!headerOrError) {
|
|
205
|
+
return;
|
|
206
|
+
}
|
|
207
|
+
const name = headerOrError.name.toLowerCase();
|
|
208
|
+
const value = headerOrError.value;
|
|
209
|
+
// Combine repeated headers into one
|
|
210
|
+
// https://stackoverflow.com/questions/3096888
|
|
211
|
+
headers[name] = headers[name] ? `${headers[name]},${value}` : value;
|
|
212
|
+
});
|
|
213
|
+
}
|
|
214
|
+
return headers;
|
|
215
|
+
}
|
|
171
216
|
}
|
|
172
217
|
exports.default = Request;
|
|
173
218
|
Request.description = `Send a GraphQL request to a StepZen endpoint and print the response,` +
|
|
@@ -183,6 +228,20 @@ Request.flags = {
|
|
|
183
228
|
description: 'StepZen endpoint to call (defaults to the endpoint in current StepZen workspace)',
|
|
184
229
|
exclusive: ['dir'],
|
|
185
230
|
}),
|
|
231
|
+
header: command_1.flags.string({
|
|
232
|
+
char: 'H',
|
|
233
|
+
description: chalk `Add an additional HTTP header to the request.` +
|
|
234
|
+
chalk ` This is useful for schemas where {bold @rest} or {bold @graphql}` +
|
|
235
|
+
chalk ` directives enable header forwarding with {bold forwardheaders}.` +
|
|
236
|
+
`\n` +
|
|
237
|
+
`\nExample:` +
|
|
238
|
+
`\nstepzen request '{ user(id: "u123") { email } }' \\` +
|
|
239
|
+
`\n\t-H "X-API-Token: SecretAPIToken"`,
|
|
240
|
+
multiple: true,
|
|
241
|
+
}),
|
|
242
|
+
'operation-name': command_1.flags.string({
|
|
243
|
+
description: chalk `Specify the operation name (in case if the provided query includes multiple operations)`,
|
|
244
|
+
}),
|
|
186
245
|
var: command_1.flags.string({
|
|
187
246
|
description: chalk `Add a request variable, in the {bold name}={underline value} format.` +
|
|
188
247
|
`\n` +
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"request.js","sourceRoot":"","sources":["../../src/commands/request.ts"],"names":[],"mappings":";AAAA,8CAA8C;;AAE9C,iEAAiE;AACjE,sEAAsE;AACtE,4CAA4C;AAC5C,oEAAoE;AAEpE,+BAA8B;AAC9B,yBAAwB;AACxB,4CAAoC;AACpC,0CAAsC;AACtC,2CAAuC;AACvC,qCAA6B;AAC7B,2BAA4B;AAC5B,sCAA8C;AAC9C,gDAA+C;AAE/C,uDAA2D;AAC3D,uDAA8C;AAC9C,mDAAiD;AACjD,2CAA+C;AAQ/C,iFAAwE;
|
|
1
|
+
{"version":3,"file":"request.js","sourceRoot":"","sources":["../../src/commands/request.ts"],"names":[],"mappings":";AAAA,8CAA8C;;AAE9C,iEAAiE;AACjE,sEAAsE;AACtE,4CAA4C;AAC5C,oEAAoE;AAEpE,+BAA8B;AAC9B,yBAAwB;AACxB,4CAAoC;AACpC,0CAAsC;AACtC,2CAAuC;AACvC,qCAA6B;AAC7B,2BAA4B;AAC5B,sCAA8C;AAC9C,gDAA+C;AAE/C,uDAA2D;AAC3D,uDAA8C;AAC9C,mDAAiD;AACjD,2CAA+C;AAQ/C,iFAAwE;AACxE,6CAA4C;AAE5C,MAAM,kBAAkB,GAAG,CAAC,MAA+B,EAAU,EAAE;IACrE,IAAI,+BAA+B,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE;QAC9D,iEAAiE;QACjE,8DAA8D;QAC9D,gEAAgE;QAChE,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;KACzB;IAED,OAAO,CACL,0CAA0C;QAC1C,MAAM;aACH,GAAG,CACF,CAAC,EAAC,OAAO,EAAE,SAAS,EAAC,EAAE,EAAE,CACvB,KAAK;YACL,CAAC,SAAS;gBACR,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG;gBAClE,CAAC,CAAC,EAAE,CAAC;YACP,OAAO,CACV;aACA,IAAI,CAAC,IAAI,CAAC,CACd,CAAA;AACH,CAAC,CAAA;AAED,MAAqB,OAAQ,SAAQ,qBAAU;IAoE7C,KAAK,CAAC,GAAG;QACP,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAEzC,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CACxC,IAAI,CAAC,KAAK,EACV,KAAK,CAAC,gBAAgB,CAAC,CACxB,CAAA;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CACxC,SAAS,EACT,KAAK,CAAC,GAAG,EACT,KAAK,CAAC,UAAU,CAAC,CAClB,CAAA;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAE9D,kCAAkC;QAClC,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAA;QACzD,MAAM,OAAO,GAAG,IAAA,yBAAa,EAAC,aAAa,CAAC,CAAA;QAE5C,IAAI,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAA;QAC7B,IAAI,CAAC,QAAQ,EAAE;YACb,gFAAgF;YAChF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC;gBAClD,SAAS,EAAE,KAAK,CAAC,GAAG;gBACpB,MAAM,EAAE,IAAI;gBACZ,aAAa,EAAE,IAAI;aACpB,CAAC,CAAA;YAEF,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAA;SAC9B;QAED,IAAI;YACF,MAAM,EAAC,MAAM,EAAE,SAAS,EAAC,GAAG,MAAM,IAAA,mCAAqB,EACrD,aAAa,EACb,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAC9C,CAAA;YAED,IAAI,SAAS,CAAC,SAAS,KAAK,cAAc,EAAE;gBAC1C,MAAM,GAAG,GACP,GAAG,OAAO,0BAA0B,QAAQ,YAAY,CAAC,OAAO,CAC9D,QAAQ,EACR,IAAI,CACL,CAAA;gBAEH,MAAM,MAAM,GAAG,IAAA,yBAAY,EAAC;oBAC1B,aAAa,EAAE,cAAS;oBACxB,GAAG;oBACH,gBAAgB,EAAE,GAAG,EAAE;wBACrB,OAAO;4BACL,OAAO,EAAE;gCACP,aAAa,EAAE,UAAU,aAAa,CAAC,MAAM,EAAE;gCAC/C,YAAY,EAAE,SAAS;gCACvB,GAAG,OAAO;6BACX;yBACF,CAAA;oBACH,CAAC;iBACF,CAAC,CAAA;gBAEF,MAAM,MAAM,GAAG,MAAM,IAAI,OAAO,CAC9B,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBAClB,IAAI,KAAK,GAAG,CAAC,CAAA;oBACb,IAAI,aAAa,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;oBACxC,IAAI,UAAuC,CAAA;oBAC3C,MAAM,CAAC,SAAS,CACd;wBACE,KAAK,EAAE,IAAI,CAAC,KAAK;wBACjB,SAAS;wBACT,aAAa,EAAE,KAAK,CAAC,gBAAgB,CAAC;qBACvC,EACD;wBACE,IAAI,EAAE,MAAM,CAAC,EAAE;4BACb,IAAI,KAAK,KAAK,CAAC,EAAE;gCACf,kEAAkE;gCAClE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAA,uBAAuB,GAAG,GAAG,CAAC,CAAA;6BAC7C;4BAED,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;4BACtC,MAAM,OAAO,GAAG,kBAAkB,CAAC,SAAS,GAAG,aAAa,CAAC,CAAA;4BAC7D,aAAa,GAAG,SAAS,CAAA;4BACzB,UAAU,GAAG,MAAM,CAAA;4BACnB,KAAK,IAAI,CAAC,CAAA;4BAEV,IAAI,CAAC,GAAG,CAAC,KAAK,CAAA,gBAAgB,KAAK,YAAY,OAAO,KAAK,CAAC,CAAA;4BAC5D,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,KAAK,CAAC,CAAA;4BACxC,IAAI,CAAC,GAAG,CACN,IAAA,uBAAe,EACb,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,EACpC,MAAM,CACP,CACF,CAAA;wBACH,CAAC;wBACD,KAAK,EAAE,CAAC,KAAU,EAAE,EAAE;4BACpB,IACE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gCACpB,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,IAAI,CAAC,CAAC,EAChC;gCACA,MAAM,MAAM,GAAG,KAAoC,CAAA;gCACnD,MAAM,CAAC,IAAI,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;6BAC9C;iCAAM;gCACL,MAAM,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;6BACzC;wBACH,CAAC;wBACD,QAAQ,EAAE,GAAG,EAAE;4BACb,IAAI,CAAC,GAAG,CAAC,kDAAkD,CAAC,CAAA;4BAC5D,OAAO,CAAC,UAAU,CAAC,CAAA;wBACrB,CAAC;qBACF,CACF,CAAA;gBACH,CAAC,CACF,CAAA;gBAED,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE;oBAC5B,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;iBACb;aACF;iBAAM;gBACL,MAAM,MAAM,GAAG,MAAM,IAAA,uBAAiB,EAAC;oBACrC,GAAG,EAAE,GAAG,OAAO,IAAI,QAAQ,YAAY;oBACvC,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,SAAS;oBACT,aAAa,EAAE,KAAK,CAAC,gBAAgB,CAAC;oBACtC,OAAO,EAAE;wBACP,aAAa,EAAE,UAAU,aAAa,CAAC,MAAM,EAAE;wBAC/C,YAAY,EAAE,SAAS;wBACvB,GAAG,OAAO;qBACX;iBACF,CAAC,CAAA;gBAEF,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,MAAM,EAAE;oBACjC,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;iBACnD;gBAED,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAA;gBAE9C,IAAI,MAAM,CAAC,MAAM,EAAE;oBACjB,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;iBACb;aACF;SACF;QAAC,OAAO,KAAU,EAAE;YACnB,IAAI,KAAK,YAAY,iBAAQ,EAAE;gBAC7B,MAAM,KAAK,CAAA;aACZ;YAED,IAAI,OAAO,GAAG,wCACZ,SAAS,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KACvC,EAAE,CAAA;YACF,IAAI,GAAG,KAAK,EAAE,CAAC,KAAK,CAAC,8BAA8B,CAAC,EAAE;gBACpD,OAAO,IAAI,KAAK,CAAA,gEAAgE,CAAA;aACjF;YACD,MAAM,IAAI,iBAAQ,CAAC,OAAO,CAAC,CAAA;SAC5B;IACH,CAAC;IAED,mBAAmB,CACjB,KAAa,EACb,aAAsB;QAEtB,IAAI,WAAyB,CAAA;QAC7B,IAAI;YACF,WAAW,GAAG,IAAA,eAAK,EAAC,KAAK,CAAC,CAAA;SAC3B;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,iBAAQ,CAAC,sCAAsC,KAAK,EAAE,CAAC,CAAA;SAClE;QAED,MAAM,UAAU,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM,CAC/C,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,qBAAqB,CACf,CAAA;QAE9B,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,iBAAQ,CAChB,+DAA+D;gBAC7D,mCAAmC,CACtC,CAAA;SACF;QAED,IAAI,aAAa,EAAE;YACjB,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAC/B,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,KAAK,aAAa,CACzC,CAAA;YACD,IAAI,CAAC,SAAS,EAAE;gBACd,MAAM,IAAI,iBAAQ,CAChB,KAAK,CAAA,mBAAmB,aAAa,2CAA2C,CACjF,CAAA;aACF;YACD,OAAO,SAAS,CAAA;SACjB;QAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,MAAM,IAAI,iBAAQ,CAChB,KAAK,CAAA,6DAA6D;gBAChE,KAAK,CAAA,8DAA8D;gBACnE,KAAK,CAAA,wDAAwD;gBAC7D,KAAK,CAAA,uDAAuD,CAC/D,CAAA;SACF;QAED,OAAO,UAAU,CAAC,CAAC,CAAC,CAAA;IACtB,CAAC;IAED,mBAAmB,CACjB,KAA8B,EAC9B,aAAwB,EACxB,WAAoB;QAEpB,IAAI,WAAW,EAAE;YACf,IAAI;gBACF,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAA;aACxD;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,iBAAQ,CAChB,sCAAsC,WAAW,MAAM,KAAK,EAAE,CAC/D,CAAA;aACF;SACF;QAED,MAAM,EAAC,SAAS,EAAE,MAAM,EAAC,GAAG,IAAA,gDAAqB,EAC/C,aAAa,IAAI,EAAE,EACnB,KAAK,CACN,CAAA;QAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,MAAM,IAAI,iBAAQ,CAChB,KAAK,CAAA,uCAAuC,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CACrE,CAAA;SACF;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,2BAA2B,CACzB,gBAA2B;QAE3B,MAAM,OAAO,GAA2B,EAAE,CAAA;QAC1C,IAAI,gBAAgB,EAAE;YACpB,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;gBACpC,MAAM,aAAa,GAAG,IAAA,oBAAW,EAAC,UAAU,CAAC,CAAA;gBAC7C,IAAI,aAAa,IAAI,OAAO,IAAI,aAAa,EAAE;oBAC7C,MAAM,IAAI,iBAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;iBACxC;gBAED,2DAA2D;gBAC3D,qEAAqE;gBACrE,uCAAuC;gBACvC,IAAI,CAAC,aAAa,EAAE;oBAClB,OAAM;iBACP;gBAED,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,WAAW,EAAE,CAAA;gBAC7C,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAA;gBAEjC,oCAAoC;gBACpC,8CAA8C;gBAC9C,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;YACrE,CAAC,CAAC,CAAA;SACH;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;;AAjUH,0BAkUC;AAjUQ,mBAAW,GAChB,sEAAsE;IACtE,qEAAqE;IACrE,aAAa,CAAA;AAER,aAAK,GAAG;IACb,GAAG,qBAAU,CAAC,KAAK;IACnB,GAAG,EAAE,eAAK,CAAC,MAAM,CAAC;QAChB,WAAW,EACT,iEAAiE;QACnE,SAAS,EAAE,CAAC,UAAU,CAAC;KACxB,CAAC;IACF,QAAQ,EAAE,eAAK,CAAC,MAAM,CAAC;QACrB,WAAW,EACT,kFAAkF;QACpF,SAAS,EAAE,CAAC,KAAK,CAAC;KACnB,CAAC;IACF,MAAM,EAAE,eAAK,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,GAAG;QACT,WAAW,EACT,KAAK,CAAA,+CAA+C;YACpD,KAAK,CAAA,mEAAmE;YACxE,KAAK,CAAA,kEAAkE;YACvE,IAAI;YACJ,YAAY;YACZ,uDAAuD;YACvD,sCAAsC;QACxC,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,gBAAgB,EAAE,eAAK,CAAC,MAAM,CAAC;QAC7B,WAAW,EAAE,KAAK,CAAA,yFAAyF;KAC5G,CAAC;IACF,GAAG,EAAE,eAAK,CAAC,MAAM,CAAC;QAChB,WAAW,EACT,KAAK,CAAA,sEAAsE;YAC3E,IAAI;YACJ,YAAY;YACZ,uEAAuE;YACvE,+DAA+D;YAC/D,WAAW;YACX,mCAAmC;YACnC,mBAAmB;QACrB,QAAQ,EAAE,IAAI;QACd,SAAS,EAAE,CAAC,UAAU,CAAC;KACxB,CAAC;IACF,UAAU,EAAE,eAAK,CAAC,MAAM,CAAC;QACvB,WAAW,EACT,KAAK,CAAA,yCAAyC;YAC9C,IAAI;YACJ,YAAY;YACZ,uEAAuE;YACvE,+DAA+D;YAC/D,WAAW;YACX,4BAA4B;QAC9B,SAAS,EAAE,CAAC,KAAK,CAAC;KACnB,CAAC;CACH,CAAA;AAEM,YAAI,GAAG;IACZ;QACE,IAAI,EAAE,OAAO;QACb,WAAW,EACT,qEAAqE;QACvE,QAAQ,EAAE,IAAI;KACf;CACF,CAAA"}
|
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"0.26.0-beta.0","commands":{"deploy":{"id":"deploy","description":"Deploy to StepZen.","usage":"deploy [ENDPOINT] [--config=path/to/config.yaml] [--dir=path/to/workspace]\n\n-- OR (deprecated) --\n\n$ stepzen deploy ENDPOINT --schema=schema [--configurationsets=cs1[,cs2[,..]]]","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"Working directory"},"silent":{"name":"silent","type":"boolean","allowNo":false},"configurationsets":{"name":"configurationsets","type":"option","description":"\n Name(s) of configuration sets uploaded earlier with stepzen upload\n [DEPRECATED: this flag will be removed in future versions]\n \n Instead, please use one of these options:\n - stepzen deploy (without the --configurationsets flag)\n \tto use the configuration from the config.yaml file in the current directory (if exists)\n - stepzen deploy --config path/to/config.yaml\n \tto explicitly specify the configuration file"},"config":{"name":"config","type":"option","description":"[default: config.yaml] Configuration file to use (relative to the current directory)","helpValue":"path/to/config.yaml"},"schema":{"name":"schema","type":"option","description":"\n Name of a schema uploaded earlier with stepzen upload\n [DEPRECATED: this flag will be removed in future versions]\n \n Instead, please use one of these options:\n - stepzen deploy (without the --schema flag)\n \tto deploy the schema from a StepZen workspace in your current directory\n - stepzen deploy --dir path/to/workspace\n \tto deploy from a StepZen workspace in another folder"}},"args":[{"name":"endpoint","description":"name of the endpoint (e.g. api/customers)\n [default: use the endpoint property from stepzen.config.json]","required":false}]},"import":{"id":"import","description":"Import a schema for an external data source or an API endpoint to your GraphQL API.","usage":["import curl [[CURLOPTS] URL] [--prefix=PREFIX] [--header=HEADER] [--header-param=HEADER-PARAM] [--query-name=QUERY-NAME] [--query-type=QUERY-TYPE] [--path-params=PATH-PARAMS]","import graphql [URL] [--prefix=PREFIX] [--header=HEADER] [--header-param=HEADER-PARAM]","import mysql [--db-host=DB-HOST] [--db-user=DB-USER] [--db-password=DB-PASSWORD] [--db-database=DB-DATABASE] [--db-link-types] [--db-include=DB-INCLUDE]","import mysql://[USER:PASSWORD@]HOST[:PORT][/DATABASE] [--db-link-types] [--db-include=DB-INCLUDE]","import postgresql [--db-host=DB-HOST] [--db-user=DB-USER] [--db-password=DB-PASSWORD] [--db-database=DB-DATABASE] [--db-link-types] [--db-include=DB-INCLUDE] [--db-schema=DB-SCHEMA]","import postgresql://[USER:PASSWORD@]HOST[:PORT][/DATABASE] [--db-link-types] [--db-include=DB-INCLUDE] [--db-schema=DB-SCHEMA]"],"pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"Working directory"},"silent":{"name":"silent","type":"boolean","hidden":true,"allowNo":false},"name":{"name":"name","type":"option","description":"Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema."},"overwrite":{"name":"overwrite","type":"boolean","description":"Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.","hidden":true,"allowNo":false},"prefix":{"name":"prefix","type":"option","description":"[curl, graphql] Prefix to add to every type in the generated schema"},"header":{"name":"header","type":"option","char":"H","description":"[curl, graphql] Specifies a request header to pass\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\""},"header-param":{"name":"header-param","type":"option","description":"[curl, graphql] Specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing the variable part of the header value with a $paramName placeholder. Repeat this flag once for each header with a parameter.\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\" \\\n\t--header-param 'Authorization: apikey $apikey'"},"query-name":{"name":"query-name","type":"option","description":"[curl] Property name to add to the Query type as a way to access the imported endpoint"},"query-type":{"name":"query-type","type":"option","description":"[curl] Name for the type returned by the curl request in the generated schema. The name specified by --query-type is not prefixed by --prefix if both flags are present."},"path-params":{"name":"path-params","type":"option","description":"[curl] Specifies path parameters in the URL path. Can be formed by taking the original path and replacing the variable segments with $paramName placeholders.\n\nExample:\nstepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/$userId/posts/$postId'"},"db-host":{"name":"db-host","type":"option","description":"[mysql, postgresql] Database host and optional port (as HOST[:PORT])"},"db-user":{"name":"db-user","type":"option","description":"[mysql, postgresql] Database user name"},"db-password":{"name":"db-password","type":"option","description":"[mysql, postgresql] Database password"},"db-database":{"name":"db-database","type":"option","description":"[mysql, postgresql] Name of database to import"},"db-link-types":{"name":"db-link-types","type":"boolean","description":"[mysql, postgresql] Automatically link types based on foreign key relationships using @materializer (https://stepzen.com/docs/features/linking-types)","allowNo":false},"db-include":{"name":"db-include","type":"option","description":"[mysql, postgresql] Should the generated GraphQL schema be based only on database views, only on tables or on both","hidden":false,"helpValue":"(tables-only|views-only|tables-and-views)","options":["tables-only","views-only","tables-and-views"]},"db-schema":{"name":"db-schema","type":"option","description":"[postgresql] PostgreSQL schema to import tables from (default: public)"}},"args":[{"name":"schema","required":true}]},"init":{"id":"init","description":"Initialize a StepZen workspace in the current directory.","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"endpoint":{"name":"endpoint","type":"option","hidden":true},"yes":{"name":"yes","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"directory","hidden":true}]},"lint":{"id":"lint","description":"StepZen lint.","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","hidden":true}},"args":[]},"list":{"id":"list","description":"List endpoints, schemas and configuration sets in your StepZen account.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false}},"args":[{"name":"type","description":"\n \n The type of entities to list:\n \tendpoints - GraphQL API endpoints deployed with stepzen deploy (or stepzen start)\n \tschemas [DEPRECATED] - StepZen schemas uploaded with stepzen upload (or stepzen start)\n \tconfigurationsets [DEPRECATED] - StepZen configuration sets uploaded with stepzen upload (or stepzen start)","options":["endpoints","configurationsets","schemas"],"default":"endpoints"}]},"login":{"id":"login","description":"Log in to StepZen.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"account":{"name":"account","type":"option","char":"a","description":"StepZen account name (copy from https://stepzen.com/account). If not provided, the CLI prompts the users to enter one."},"adminkey":{"name":"adminkey","type":"option","char":"k","description":"Admin key (copy from https://stepzen.com/account) If not provided, the CLI prompts the users to enter one."},"public":{"name":"public","type":"boolean","description":"Create a public anonymous StepZen account and use it. This is handy for trying StepZen out, but it not suitable for handling private data as all endpoints created with a public account will be public.","allowNo":false},"config":{"name":"config","type":"option","hidden":true}},"args":[]},"logout":{"id":"logout","description":"Log out of StepZen.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false}},"args":[]},"request":{"id":"request","description":"Send a GraphQL request to a StepZen endpoint and print the response, using the API key and the target endopint from the current StepZen workspace.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"StepZen workspace directory (defaults to the current directory)"},"endpoint":{"name":"endpoint","type":"option","description":"StepZen endpoint to call (defaults to the endpoint in current StepZen workspace)"},"var":{"name":"var","type":"option","description":"Add a request variable, in the name=value format.\n\nExample:\nstepzen request 'query OrdersQuery($search: String!, $limit: Int) {\n\t\torders(search: $search, limit: $limit) { id createdAt }\n\t}' \\\n\t--var 'search=space ninja' \\\n\t--var limit=5"},"var-file":{"name":"var-file","type":"option","description":"Read request variables from a JSON file\n\nExample:\nstepzen request 'query OrdersQuery($search: String!, $limit: Int) {\n\t\torders(search: $search, limit: $limit) { id createdAt }\n\t}' \\\n\t--var-file ./vars.json"}},"args":[{"name":"query","description":"GraphQL query (could include a query, a mutation or a subscription)","required":true}]},"service":{"id":"service","description":"Manage the local StepZen service instance (requires Docker).\nYou can use a local StepZen service instance instead of the StepZen cloud to develop and test GraphQL endpoints locally. This way you can try StepZen out without giving the StepZen cloud access to your data sources and API endpoints.\n\nLocal StepZen service instances are not suitable for production use. Please refer to the documentation at https://stepzen.com/docs/deployment/local-docker for more information and examples.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"dsn":{"name":"dsn","type":"option","description":"DSN of a StepZen metadata database, e.g. postgres://user:password@172.17.0.1:5432/zenctl"},"reset-auto":{"name":"reset-auto","type":"boolean","description":"Create fresh empty metadata database. Note: all existing endpoints will be deleted and you will be logged out.","allowNo":false},"prompt":{"name":"prompt","type":"boolean","description":"Opens an interactive prompt to ask for database details (or fails, if running in a non-interactive mode).","allowNo":false},"port":{"name":"port","type":"option","description":"Override the TCP port on which the local StepZen service instance will listen for connections (port 9000 by default)."}},"args":[{"name":"action","description":"\n \tstart\tstart a local StepZen service instance in a Docker container\n \t\tThis command pulls the latest StepZen service instance Docker image so that the\n \t\tversion of StepZen you run locally is the same as the one running on\n \t\tstepzen.net.\n \n \tstop\tstop the local StepZen service instance (if running)\n \t\tThis command deletes the Docker container with the StepZen service instance,\n \t\tbut all your endpoints are persistently stored in the metadata database. They\n \t\tremain available when running stepzen service start next time.\n \n \tupgrade\tupgrade the local StepZen service instance if it is running\n \t\tThis command checks if a newer version of the StepZen service instance Docker\n \t\timage is available, and if it is then stops and deletes the currently running\n \t\tcontainer, pulls the latest image, and starts it. All endpoints are preserved.\n\n If no action is provided, print the service status and exit.","required":false,"options":["start","stop","upgrade"]}]},"start":{"id":"start","description":"Deploy your schema to StepZen, and then redeploy on every change.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"Working directory"},"endpoint":{"name":"endpoint","type":"option","description":"Override workspace endpoint"},"no-console":{"name":"no-console","type":"boolean","hidden":true,"allowNo":false},"no-dashboard":{"name":"no-dashboard","type":"boolean","hidden":true,"allowNo":false},"no-init":{"name":"no-init","type":"boolean","hidden":true,"allowNo":false},"no-validate":{"name":"no-validate","type":"boolean","hidden":true,"allowNo":false},"no-watcher":{"name":"no-watcher","type":"boolean","hidden":true,"allowNo":false},"port":{"name":"port","type":"option","default":5001}},"args":[]},"transpile":{"id":"transpile","description":"Transpile a GraphQL schema.","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"config":{"name":"config","type":"option","hidden":true},"hide-output":{"name":"hide-output","type":"boolean","hidden":true,"allowNo":false},"inspect":{"name":"inspect","type":"boolean","char":"i","hidden":true,"allowNo":false},"inspect-after":{"name":"inspect-after","type":"boolean","hidden":true,"allowNo":false},"output-configuration":{"name":"output-configuration","type":"boolean","allowNo":false},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"folder","required":true}]},"upload":{"id":"upload","description":"[DEPRECATED] Upload a schema or a configuration set to StepZen.\nstepzen upload is deprecated in favor of stepzen deploy\nStepZen CLI is moving away from a two-step \"upload\" + \"deploy\" flow to a single-step \"deploy\" flow.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"A directory to upload"},"file":{"name":"file","type":"option","description":"A file to upload"},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"type","description":"type","required":true,"options":["configurationset","schema"]},{"name":"destination","description":"destination","required":true}]},"validate":{"id":"validate","description":"Validate a GraphQL schema.","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false}},"args":[{"name":"folder","required":true}]},"whoami":{"id":"whoami","description":"Display your credentials.","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"showkeys":{"name":"showkeys","type":"boolean","allowNo":false},"account":{"name":"account","type":"boolean","allowNo":false},"adminkey":{"name":"adminkey","type":"boolean","allowNo":false},"apikey":{"name":"apikey","type":"boolean","allowNo":false}},"args":[]}}}
|
|
1
|
+
{"version":"0.26.0-beta.1","commands":{"deploy":{"id":"deploy","description":"Deploy to StepZen.","usage":"deploy [ENDPOINT] [--config=path/to/config.yaml] [--dir=path/to/workspace]\n\n-- OR (deprecated) --\n\n$ stepzen deploy ENDPOINT --schema=schema [--configurationsets=cs1[,cs2[,..]]]","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"Working directory"},"silent":{"name":"silent","type":"boolean","allowNo":false},"configurationsets":{"name":"configurationsets","type":"option","description":"\n Name(s) of configuration sets uploaded earlier with stepzen upload\n [DEPRECATED: this flag will be removed in future versions]\n \n Instead, please use one of these options:\n - stepzen deploy (without the --configurationsets flag)\n \tto use the configuration from the config.yaml file in the current directory (if exists)\n - stepzen deploy --config path/to/config.yaml\n \tto explicitly specify the configuration file"},"config":{"name":"config","type":"option","description":"[default: config.yaml] Configuration file to use (relative to the current directory)","helpValue":"path/to/config.yaml"},"schema":{"name":"schema","type":"option","description":"\n Name of a schema uploaded earlier with stepzen upload\n [DEPRECATED: this flag will be removed in future versions]\n \n Instead, please use one of these options:\n - stepzen deploy (without the --schema flag)\n \tto deploy the schema from a StepZen workspace in your current directory\n - stepzen deploy --dir path/to/workspace\n \tto deploy from a StepZen workspace in another folder"}},"args":[{"name":"endpoint","description":"name of the endpoint (e.g. api/customers)\n [default: use the endpoint property from stepzen.config.json]","required":false}]},"import":{"id":"import","description":"Import a schema for an external data source or an API endpoint to your GraphQL API.","usage":["import curl [[CURLOPTS] URL] [--prefix=PREFIX] [--header=HEADER] [--header-param=HEADER-PARAM] [--query-name=QUERY-NAME] [--query-type=QUERY-TYPE] [--path-params=PATH-PARAMS]","import graphql [URL] [--prefix=PREFIX] [--header=HEADER] [--header-param=HEADER-PARAM]","import mysql [--db-host=DB-HOST] [--db-user=DB-USER] [--db-password=DB-PASSWORD] [--db-database=DB-DATABASE] [--db-link-types] [--db-include=DB-INCLUDE]","import mysql://[USER:PASSWORD@]HOST[:PORT][/DATABASE] [--db-link-types] [--db-include=DB-INCLUDE]","import postgresql [--db-host=DB-HOST] [--db-user=DB-USER] [--db-password=DB-PASSWORD] [--db-database=DB-DATABASE] [--db-link-types] [--db-include=DB-INCLUDE] [--db-schema=DB-SCHEMA]","import postgresql://[USER:PASSWORD@]HOST[:PORT][/DATABASE] [--db-link-types] [--db-include=DB-INCLUDE] [--db-schema=DB-SCHEMA]"],"pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"Working directory"},"silent":{"name":"silent","type":"boolean","hidden":true,"allowNo":false},"name":{"name":"name","type":"option","description":"Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema."},"overwrite":{"name":"overwrite","type":"boolean","description":"Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.","hidden":true,"allowNo":false},"prefix":{"name":"prefix","type":"option","description":"[curl, graphql] Prefix to add to every type in the generated schema"},"header":{"name":"header","type":"option","char":"H","description":"[curl, graphql] Specifies a request header to pass\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\""},"header-param":{"name":"header-param","type":"option","description":"[curl, graphql] Specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing the variable part of the header value with a $paramName placeholder. Repeat this flag once for each header with a parameter.\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\" \\\n\t--header-param 'Authorization: apikey $apikey'"},"query-name":{"name":"query-name","type":"option","description":"[curl] Property name to add to the Query type as a way to access the imported endpoint"},"query-type":{"name":"query-type","type":"option","description":"[curl] Name for the type returned by the curl request in the generated schema. The name specified by --query-type is not prefixed by --prefix if both flags are present."},"path-params":{"name":"path-params","type":"option","description":"[curl] Specifies path parameters in the URL path. Can be formed by taking the original path and replacing the variable segments with $paramName placeholders.\n\nExample:\nstepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/$userId/posts/$postId'"},"db-host":{"name":"db-host","type":"option","description":"[mysql, postgresql] Database host and optional port (as HOST[:PORT])"},"db-user":{"name":"db-user","type":"option","description":"[mysql, postgresql] Database user name"},"db-password":{"name":"db-password","type":"option","description":"[mysql, postgresql] Database password"},"db-database":{"name":"db-database","type":"option","description":"[mysql, postgresql] Name of database to import"},"db-link-types":{"name":"db-link-types","type":"boolean","description":"[mysql, postgresql] Automatically link types based on foreign key relationships using @materializer (https://stepzen.com/docs/features/linking-types)","allowNo":false},"db-include":{"name":"db-include","type":"option","description":"[mysql, postgresql] Should the generated GraphQL schema be based only on database views, only on tables or on both","hidden":false,"helpValue":"(tables-only|views-only|tables-and-views)","options":["tables-only","views-only","tables-and-views"]},"db-schema":{"name":"db-schema","type":"option","description":"[postgresql] PostgreSQL schema to import tables from (default: public)"}},"args":[{"name":"schema","required":true}]},"init":{"id":"init","description":"Initialize a StepZen workspace in the current directory.","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"endpoint":{"name":"endpoint","type":"option","hidden":true},"yes":{"name":"yes","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"directory","hidden":true}]},"lint":{"id":"lint","description":"StepZen lint.","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","hidden":true}},"args":[]},"list":{"id":"list","description":"List endpoints, schemas and configuration sets in your StepZen account.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false}},"args":[{"name":"type","description":"\n \n The type of entities to list:\n \tendpoints - GraphQL API endpoints deployed with stepzen deploy (or stepzen start)\n \tschemas [DEPRECATED] - StepZen schemas uploaded with stepzen upload (or stepzen start)\n \tconfigurationsets [DEPRECATED] - StepZen configuration sets uploaded with stepzen upload (or stepzen start)","options":["endpoints","configurationsets","schemas"],"default":"endpoints"}]},"login":{"id":"login","description":"Log in to StepZen.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"account":{"name":"account","type":"option","char":"a","description":"StepZen account name (copy from https://stepzen.com/account). If not provided, the CLI prompts the users to enter one."},"adminkey":{"name":"adminkey","type":"option","char":"k","description":"Admin key (copy from https://stepzen.com/account) If not provided, the CLI prompts the users to enter one."},"public":{"name":"public","type":"boolean","description":"Create a public anonymous StepZen account and use it. This is handy for trying StepZen out, but it not suitable for handling private data as all endpoints created with a public account will be public.","allowNo":false},"config":{"name":"config","type":"option","hidden":true}},"args":[]},"logout":{"id":"logout","description":"Log out of StepZen.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false}},"args":[]},"request":{"id":"request","description":"Send a GraphQL request to a StepZen endpoint and print the response, using the API key and the target endopint from the current StepZen workspace.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"StepZen workspace directory (defaults to the current directory)"},"endpoint":{"name":"endpoint","type":"option","description":"StepZen endpoint to call (defaults to the endpoint in current StepZen workspace)"},"header":{"name":"header","type":"option","char":"H","description":"Add an additional HTTP header to the request. This is useful for schemas where @rest or @graphql directives enable header forwarding with forwardheaders.\n\nExample:\nstepzen request '{ user(id: \"u123\") { email } }' \\\n\t-H \"X-API-Token: SecretAPIToken\""},"operation-name":{"name":"operation-name","type":"option","description":"Specify the operation name (in case if the provided query includes multiple operations)"},"var":{"name":"var","type":"option","description":"Add a request variable, in the name=value format.\n\nExample:\nstepzen request 'query OrdersQuery($search: String!, $limit: Int) {\n\t\torders(search: $search, limit: $limit) { id createdAt }\n\t}' \\\n\t--var 'search=space ninja' \\\n\t--var limit=5"},"var-file":{"name":"var-file","type":"option","description":"Read request variables from a JSON file\n\nExample:\nstepzen request 'query OrdersQuery($search: String!, $limit: Int) {\n\t\torders(search: $search, limit: $limit) { id createdAt }\n\t}' \\\n\t--var-file ./vars.json"}},"args":[{"name":"query","description":"GraphQL query (could include a query, a mutation or a subscription)","required":true}]},"service":{"id":"service","description":"Manage the local StepZen service instance (requires Docker).\nYou can use a local StepZen service instance instead of the StepZen cloud to develop and test GraphQL endpoints locally. This way you can try StepZen out without giving the StepZen cloud access to your data sources and API endpoints.\n\nLocal StepZen service instances are not suitable for production use. Please refer to the documentation at https://stepzen.com/docs/deployment/local-docker for more information and examples.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"dsn":{"name":"dsn","type":"option","description":"DSN of a StepZen metadata database, e.g. postgres://user:password@172.17.0.1:5432/zenctl"},"reset-auto":{"name":"reset-auto","type":"boolean","description":"Create fresh empty metadata database. Note: all existing endpoints will be deleted and you will be logged out.","allowNo":false},"prompt":{"name":"prompt","type":"boolean","description":"Opens an interactive prompt to ask for database details (or fails, if running in a non-interactive mode).","allowNo":false},"port":{"name":"port","type":"option","description":"Override the TCP port on which the local StepZen service instance will listen for connections (port 9000 by default)."}},"args":[{"name":"action","description":"\n \tstart\tstart a local StepZen service instance in a Docker container\n \t\tThis command pulls the latest StepZen service instance Docker image so that the\n \t\tversion of StepZen you run locally is the same as the one running on\n \t\tstepzen.net.\n \n \tstop\tstop the local StepZen service instance (if running)\n \t\tThis command deletes the Docker container with the StepZen service instance,\n \t\tbut all your endpoints are persistently stored in the metadata database. They\n \t\tremain available when running stepzen service start next time.\n \n \tupgrade\tupgrade the local StepZen service instance if it is running\n \t\tThis command checks if a newer version of the StepZen service instance Docker\n \t\timage is available, and if it is then stops and deletes the currently running\n \t\tcontainer, pulls the latest image, and starts it. All endpoints are preserved.\n\n If no action is provided, print the service status and exit.","required":false,"options":["start","stop","upgrade"]}]},"start":{"id":"start","description":"Deploy your schema to StepZen, and then redeploy on every change.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"Working directory"},"endpoint":{"name":"endpoint","type":"option","description":"Override workspace endpoint"},"no-console":{"name":"no-console","type":"boolean","hidden":true,"allowNo":false},"no-dashboard":{"name":"no-dashboard","type":"boolean","hidden":true,"allowNo":false},"no-init":{"name":"no-init","type":"boolean","hidden":true,"allowNo":false},"no-validate":{"name":"no-validate","type":"boolean","hidden":true,"allowNo":false},"no-watcher":{"name":"no-watcher","type":"boolean","hidden":true,"allowNo":false},"port":{"name":"port","type":"option","default":5001}},"args":[]},"transpile":{"id":"transpile","description":"Transpile a GraphQL schema.","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"config":{"name":"config","type":"option","hidden":true},"hide-output":{"name":"hide-output","type":"boolean","hidden":true,"allowNo":false},"inspect":{"name":"inspect","type":"boolean","char":"i","hidden":true,"allowNo":false},"inspect-after":{"name":"inspect-after","type":"boolean","hidden":true,"allowNo":false},"output-configuration":{"name":"output-configuration","type":"boolean","allowNo":false},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"folder","required":true}]},"upload":{"id":"upload","description":"[DEPRECATED] Upload a schema or a configuration set to StepZen.\nstepzen upload is deprecated in favor of stepzen deploy\nStepZen CLI is moving away from a two-step \"upload\" + \"deploy\" flow to a single-step \"deploy\" flow.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"A directory to upload"},"file":{"name":"file","type":"option","description":"A file to upload"},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"type","description":"type","required":true,"options":["configurationset","schema"]},{"name":"destination","description":"destination","required":true}]},"validate":{"id":"validate","description":"Validate a GraphQL schema.","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false}},"args":[{"name":"folder","required":true}]},"whoami":{"id":"whoami","description":"Display your credentials.","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help","allowNo":false},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Disable all interactive prompts","hidden":true,"allowNo":false},"showkeys":{"name":"showkeys","type":"boolean","allowNo":false},"account":{"name":"account","type":"boolean","allowNo":false},"adminkey":{"name":"adminkey","type":"boolean","allowNo":false},"apikey":{"name":"apikey","type":"boolean","allowNo":false}},"args":[]}}}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "stepzen",
|
|
3
3
|
"description": "The StepZen CLI",
|
|
4
|
-
"version": "0.26.0-beta.
|
|
4
|
+
"version": "0.26.0-beta.1",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Darren Waddell <darren@stepzen.com>",
|
|
7
7
|
"contributors": [
|
|
@@ -32,10 +32,10 @@
|
|
|
32
32
|
"@oclif/errors": "^1.3.5",
|
|
33
33
|
"@oclif/plugin-help": "^5.1.12",
|
|
34
34
|
"@soluble/dsn-parser": "^1.6.0",
|
|
35
|
-
"@stepzen/fetch": "^0.26.0-beta.
|
|
36
|
-
"@stepzen/graphiql-proxy": "^0.26.0-beta.
|
|
37
|
-
"@stepzen/sdk": "^0.26.0-beta.
|
|
38
|
-
"@stepzen/transpiler": "^0.26.0-beta.
|
|
35
|
+
"@stepzen/fetch": "^0.26.0-beta.1",
|
|
36
|
+
"@stepzen/graphiql-proxy": "^0.26.0-beta.1",
|
|
37
|
+
"@stepzen/sdk": "^0.26.0-beta.1",
|
|
38
|
+
"@stepzen/transpiler": "^0.26.0-beta.1",
|
|
39
39
|
"chalk": "^4.1.1",
|
|
40
40
|
"chokidar": "^3.5.2",
|
|
41
41
|
"compare-versions": "^3.6.0",
|
|
@@ -137,5 +137,5 @@
|
|
|
137
137
|
"version": "oclif-dev readme && git add README.md"
|
|
138
138
|
},
|
|
139
139
|
"types": "lib/index.d.ts",
|
|
140
|
-
"gitHead": "
|
|
140
|
+
"gitHead": "9a166ef88e50d66adabb74632f73a120627123b1"
|
|
141
141
|
}
|