stepzen 0.16.0-beta.3 → 0.16.0-beta.4
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 +1 -1
- package/lib/generate/helpers.d.ts +1 -0
- package/lib/generate/helpers.js +13 -1
- package/lib/generate/index.js +23 -29
- package/oclif.manifest.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -29,7 +29,7 @@ $ npm install -g stepzen
|
|
|
29
29
|
$ stepzen COMMAND
|
|
30
30
|
running command...
|
|
31
31
|
$ stepzen (-v|--version|version)
|
|
32
|
-
stepzen/0.16.0-beta.
|
|
32
|
+
stepzen/0.16.0-beta.4 darwin-x64 node-v14.19.1
|
|
33
33
|
$ stepzen --help [COMMAND]
|
|
34
34
|
USAGE
|
|
35
35
|
$ stepzen COMMAND
|
|
@@ -11,3 +11,4 @@ export declare const getSchema: (arg: string) => string;
|
|
|
11
11
|
export declare const getTemplates: () => Promise<string>;
|
|
12
12
|
export declare const askGeneratorQuestions: (id: string, settings: any, state: any) => Promise<any>;
|
|
13
13
|
export declare const askTemplateQuestions: (id: string, settings: any, state: any) => Promise<any>;
|
|
14
|
+
export declare const mergeFiles: (name: string, source: string, files: string, answers: any) => Promise<string>;
|
package/lib/generate/helpers.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// Copyright (c) 2020,2021,2022, StepZen, Inc.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.askTemplateQuestions = exports.askGeneratorQuestions = exports.getTemplates = exports.getSchema = exports.getConfiguration = exports.createGeneratorFiles = void 0;
|
|
4
|
+
exports.mergeFiles = exports.askTemplateQuestions = exports.askGeneratorQuestions = exports.getTemplates = exports.getSchema = exports.getConfiguration = exports.createGeneratorFiles = void 0;
|
|
5
5
|
const errors_1 = require("@oclif/errors");
|
|
6
6
|
const chalk = require("chalk");
|
|
7
7
|
const debug = require("debug");
|
|
@@ -12,6 +12,7 @@ const lodash_1 = require("lodash");
|
|
|
12
12
|
const os = require("os");
|
|
13
13
|
const path = require("path");
|
|
14
14
|
const shell = require("shelljs");
|
|
15
|
+
const transpiler = require("@stepzen/transpiler");
|
|
15
16
|
const constants_1 = require("../shared/constants");
|
|
16
17
|
const errors_2 = require("../shared/errors");
|
|
17
18
|
const { version } = require('../../package.json');
|
|
@@ -159,3 +160,14 @@ exports.askTemplateQuestions = async (id, settings, state) => {
|
|
|
159
160
|
const answers = await inquirer.prompt(questions);
|
|
160
161
|
return Object.assign(Object.assign({}, state), answers);
|
|
161
162
|
};
|
|
163
|
+
exports.mergeFiles = async (name, source, files, answers) => {
|
|
164
|
+
const output = await transpiler.merge(source, {
|
|
165
|
+
name: name,
|
|
166
|
+
source: files,
|
|
167
|
+
}, {
|
|
168
|
+
answers,
|
|
169
|
+
silent: true,
|
|
170
|
+
output: null,
|
|
171
|
+
});
|
|
172
|
+
return output;
|
|
173
|
+
};
|
package/lib/generate/index.js
CHANGED
|
@@ -6,7 +6,6 @@ const core_1 = require("@oclif/core");
|
|
|
6
6
|
const fs = require("fs-extra");
|
|
7
7
|
const lodash = require("lodash");
|
|
8
8
|
const path = require("path");
|
|
9
|
-
const transpiler_1 = require("@stepzen/transpiler");
|
|
10
9
|
const helpers_1 = require("./helpers");
|
|
11
10
|
exports.default = async (schema, name, source, preAnswered = {}) => {
|
|
12
11
|
var _a;
|
|
@@ -20,13 +19,24 @@ exports.default = async (schema, name, source, preAnswered = {}) => {
|
|
|
20
19
|
core_1.CliUx.ux.action.start('Downloading from StepZen...');
|
|
21
20
|
// Get the generator configuration
|
|
22
21
|
const configure = await helpers_1.getConfiguration(schema, answers);
|
|
23
|
-
if (configure === null || configure === void 0 ? void 0 : configure.questions
|
|
22
|
+
if ((configure === null || configure === void 0 ? void 0 : configure.questions) ||
|
|
23
|
+
((configure === null || configure === void 0 ? void 0 : configure.status) && configure.status >= 0)) {
|
|
24
24
|
generator = {
|
|
25
25
|
questions: configure.questions,
|
|
26
26
|
type: 'generator',
|
|
27
27
|
answers: undefined,
|
|
28
28
|
};
|
|
29
29
|
}
|
|
30
|
+
// For housekeeping
|
|
31
|
+
const tempFiles = [];
|
|
32
|
+
const cleanUp = async () => {
|
|
33
|
+
// Silently ignore temporary files that could not be deleted (error message would be
|
|
34
|
+
// useless and allows simpler mocking by not having to actually create files).
|
|
35
|
+
await Promise.all(tempFiles.map(file => fs
|
|
36
|
+
.access(file, fs.constants.W_OK)
|
|
37
|
+
.then(() => fs.remove(file))
|
|
38
|
+
.catch(() => undefined)));
|
|
39
|
+
};
|
|
30
40
|
// Get the API templates repository
|
|
31
41
|
let templates;
|
|
32
42
|
if (generator === undefined) {
|
|
@@ -40,6 +50,7 @@ exports.default = async (schema, name, source, preAnswered = {}) => {
|
|
|
40
50
|
type: 'template',
|
|
41
51
|
answers: undefined,
|
|
42
52
|
};
|
|
53
|
+
tempFiles.push(templates);
|
|
43
54
|
}
|
|
44
55
|
}
|
|
45
56
|
// Finished downloading
|
|
@@ -48,9 +59,7 @@ exports.default = async (schema, name, source, preAnswered = {}) => {
|
|
|
48
59
|
let result;
|
|
49
60
|
if (generator === undefined) {
|
|
50
61
|
// If you've tried to import non-existent templates, complain and exit
|
|
51
|
-
|
|
52
|
-
fs.removeSync(templates);
|
|
53
|
-
}
|
|
62
|
+
cleanUp();
|
|
54
63
|
throw new errors_1.CLIError(`Cannot find the schema ${schema}`);
|
|
55
64
|
}
|
|
56
65
|
else if (generator.type === 'generator') {
|
|
@@ -62,35 +71,20 @@ exports.default = async (schema, name, source, preAnswered = {}) => {
|
|
|
62
71
|
generator.answers = result;
|
|
63
72
|
answers = lodash.merge(answers, result);
|
|
64
73
|
// We now have all the answers! Generate schemas
|
|
65
|
-
let output;
|
|
66
74
|
console.log();
|
|
67
75
|
core_1.CliUx.ux.action.start('Generating schemas...');
|
|
76
|
+
let files;
|
|
68
77
|
if (generator.type === 'generator') {
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
name: schema,
|
|
72
|
-
source: files,
|
|
73
|
-
}, {
|
|
74
|
-
answers,
|
|
75
|
-
silent: true,
|
|
76
|
-
output: null,
|
|
77
|
-
});
|
|
78
|
-
fs.removeSync(files);
|
|
78
|
+
files = await helpers_1.createGeneratorFiles(schema, generator);
|
|
79
|
+
tempFiles.push(files);
|
|
79
80
|
}
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
source: path.join(templates, schema),
|
|
84
|
-
}, {
|
|
85
|
-
answers,
|
|
86
|
-
silent: true,
|
|
87
|
-
output: null,
|
|
88
|
-
});
|
|
81
|
+
else {
|
|
82
|
+
// if (generator.type === 'template')
|
|
83
|
+
files = path.join(templates, schema);
|
|
89
84
|
}
|
|
90
|
-
|
|
85
|
+
const output = await helpers_1.mergeFiles(name || schema, source, files, answers);
|
|
91
86
|
core_1.CliUx.ux.action.stop();
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
}
|
|
87
|
+
// Housekeeping
|
|
88
|
+
cleanUp();
|
|
95
89
|
return output;
|
|
96
90
|
};
|
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"0.16.0-beta.
|
|
1
|
+
{"version":"0.16.0-beta.4","commands":{"deploy":{"id":"deploy","description":"deploy to stepzen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"configurationsets":{"name":"configurationsets","type":"option","description":"Configurationsets to use","default":""},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"schema":{"name":"schema","type":"option","description":"Schema to use","required":true},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"destination","description":"destination","required":true}]},"import":{"id":"import","description":"import a schema for an external data source or a API endpoint to your GraphQL API","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"working directory"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"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, defaults to the imported schema name"},"prefix":{"name":"prefix","type":"option","description":"[curl] prefix to add every type in the generated schema."},"query-name":{"name":"query-name","type":"option","description":"[curl] property name to add to the Query type as a way to access the imported cURL endpoint."},"query-type":{"name":"query-type","type":"option","description":"[curl] name for the type returned by the cURL endpoint 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'"},"header-param":{"name":"header-param","type":"option","description":"[curl] 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'"},"db-host":{"name":"db-host","type":"option","description":"[mysql, postgresql] database host"},"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-schema":{"name":"db-schema","type":"option","description":"[postgresql] database schema"}},"args":[{"name":"schema","required":true}]},"init":{"id":"init","description":"stepzen init","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"endpoint":{"name":"endpoint","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"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":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"list":{"id":"list","description":"list your items","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"type","description":"type","required":true,"options":["configurationsets","schemas"]}]},"login":{"id":"login","description":"log in to StepZen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"account":{"name":"account","type":"option","char":"a","hidden":true},"adminkey":{"name":"adminkey","type":"option","char":"k","hidden":true},"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},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"logout":{"id":"logout","description":"log out of StepZen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"upload and deploy your schema","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"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"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"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-server":{"name":"no-server","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":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"config":{"name":"config","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"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":"upload to StepZen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"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"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"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":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"folder","required":true}]},"whoami":{"id":"whoami","description":"display your credentials with StepZen whoami","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"showkeys":{"name":"showkeys","type":"boolean","allowNo":false},"apikey":{"name":"apikey","type":"boolean","allowNo":false},"adminkey":{"name":"adminkey","type":"boolean","allowNo":false}},"args":[]}}}
|