stepzen 0.19.0-beta.0 → 0.19.0

package/lib/commands/upload.js

@@ -37,7 +37,7 @@ class Upload extends zen_command_1.default {
         if (!flags.silent) {
             this.log('Uploading...');
         }
-        const response = await actions_1.upload(args.type, args.destination, source);
+        const response = await (0, actions_1.upload)(args.type, args.destination, source);
         if (response.success) {
             if (!flags.silent) {
                 this.log(response.message);

package/lib/commands/validate.js

@@ -7,17 +7,19 @@ const errors_1 = require("@oclif/errors");
 const transpiler_1 = require("@stepzen/transpiler");
 const utils_1 = require("../shared/utils");
 const zen_command_1 = require("../shared/zen-command");
+const core_1 = require("@oclif/core");
 class Validate extends zen_command_1.default {
     async run() {
         const { args } = this.parse(Validate);
-        const folder = utils_1.getDirectory(args.folder);
+        const folder = (0, utils_1.getDirectory)(args.folder);
         try {
-            const schema = transpiler_1.stitch(folder);
-            transpiler_1.validate(schema, {
-                extensions: await utils_1.getStepZenExtensions(),
+            const schema = (0, transpiler_1.stitch)(folder);
+            (0, transpiler_1.validate)(schema, {
+                extensions: await (0, utils_1.getStepZenExtensions)(),
             });
         }
         catch (error) {
+            core_1.CliUx.ux.action.stop(chalk.red('fail'));
             throw new errors_1.CLIError(chalk.red(error));
         }
     }

package/lib/commands/whoami.js

@@ -9,7 +9,7 @@ const zen_command_1 = require("../shared/zen-command");
 class WhoAmI extends zen_command_1.default {
     async run() {
         const { flags } = this.parse(WhoAmI);
-        const configuration = await configuration_1.readConfiguration();
+        const configuration = await (0, configuration_1.readConfiguration)();
         if (!('account' in configuration)) {
             this.log('You are not logged in.');
             return;
@@ -36,7 +36,7 @@ class WhoAmI extends zen_command_1.default {
                 details.adminkey = configuration.adminkey;
             }
             else {
-                details.adminkey = utils_1.maskStepZenKey(configuration.adminkey);
+                details.adminkey = (0, utils_1.maskStepZenKey)(configuration.adminkey);
             }
         }
         if (configuration.apikey) {
@@ -44,7 +44,7 @@ class WhoAmI extends zen_command_1.default {
                 details.apikey = configuration.apikey;
             }
             else {
-                details.apikey = utils_1.maskStepZenKey(configuration.apikey);
+                details.apikey = (0, utils_1.maskStepZenKey)(configuration.apikey);
             }
         }
         this.log();

package/lib/generate/curl2sdl.d.ts

@@ -10,7 +10,7 @@ export declare type Curl2SdlOptions = CommonImportOptions & {
     pathParams: readonly PathParam[];
     headers: readonly HeaderInput[];
 };
-export declare type EditableCurl2SdlOptions = Pick<Curl2SdlOptions, 'curlArgs' | 'queryName' | 'rootType' | 'typePrefix' | 'pathParams'>;
+export declare type InteractiveCurl2SdlOptions = Pick<Curl2SdlOptions, 'curlArgs' | 'queryName' | 'rootType' | 'typePrefix' | 'pathParams'>;
 export declare type CurlAnswers = {
     url: string;
     queryName: string;
@@ -45,7 +45,7 @@ export declare const compileParameterList: (headers: HeaderInput[], pathParams:
  *              there are no duplicates
  */
 export declare const makeDuplicateParamsMessage: (headers: HeaderInput[], pathParams: PathParam[], url: string) => string | null;
-export declare const askCurlQuestions: (defaultAnswers?: Partial<CurlAnswers>) => Promise<EditableCurl2SdlOptions>;
+export declare const askCurlQuestions: (defaultAnswers?: Partial<CurlAnswers>) => Promise<InteractiveCurl2SdlOptions>;
 export declare const curl2sdl: ({ curlArgs, name, source, queryName, rootType, typePrefix, pathParams, headers, onConflict, }: Curl2SdlOptions) => Promise<{
     error: string;
 } | {

package/lib/generate/curl2sdl.js

@@ -19,12 +19,12 @@ const constants_1 = require("../shared/constants");
  * @param {*} pathname full pathname of the REST endpoint
  * @returns {*} combined list of query parameters in a uniform format
  */
-exports.compileParameterList = (headers, pathParams, pathname) => {
+const compileParameterList = (headers, pathParams, pathname) => {
     // Drop empty segments, including empty string before the leading slash
     const pathSegments = pathname.split('/').filter(Boolean);
     // For each header, make a list of the parameters it contains.
     // `flatMap()` concatenates each header's param lists into a single list.
-    return lodash_1.flatMap(headers, header => {
+    return (0, lodash_1.flatMap)(headers, header => {
         // skip headers that don't contain parameters
         if (!('parts' in header)) {
             return [];
@@ -53,6 +53,7 @@ exports.compileParameterList = (headers, pathParams, pathname) => {
         context: `pathname ${chalk.dim(`(${pathname})`)}`,
     })));
 };
+exports.compileParameterList = compileParameterList;
 /**
  * Check the header and path parameters for duplicates, and construct a
  * user-friendly error message describing identified problems (if any).
@@ -64,15 +65,15 @@ exports.compileParameterList = (headers, pathParams, pathname) => {
  * @returns {*} a message describing duplicate query parameters, or null if
  *              there are no duplicates
  */
-exports.makeDuplicateParamsMessage = (headers, pathParams, url) => {
+const makeDuplicateParamsMessage = (headers, pathParams, url) => {
     // Create a uniform list of query parameters from the headers and path
-    const parameters = exports.compileParameterList(headers, pathParams, new URL(url).pathname);
-    const errors = Object.entries(lodash_1.groupBy(parameters, 'name'))
+    const parameters = (0, exports.compileParameterList)(headers, pathParams, new URL(url).pathname);
+    const errors = Object.entries((0, lodash_1.groupBy)(parameters, 'name'))
         // Create groups for each unique parameter name,
         // and then sub-groups for each unique [name, value] tuple.
         .map(([name, group]) => ({
         name,
-        values: Object.entries(lodash_1.groupBy(group, 'value')),
+        values: Object.entries((0, lodash_1.groupBy)(group, 'value')),
     }))
         // ignore the [name, value] tuples that occur only once
         .filter(({ values }) => values.length > 1)
@@ -88,7 +89,8 @@ exports.makeDuplicateParamsMessage = (headers, pathParams, url) => {
     }
     return null;
 };
-exports.askCurlQuestions = async (defaultAnswers = {}) => {
+exports.makeDuplicateParamsMessage = makeDuplicateParamsMessage;
+const askCurlQuestions = async (defaultAnswers = {}) => {
     const questions = [
         {
             name: 'url',
@@ -111,15 +113,15 @@ exports.askCurlQuestions = async (defaultAnswers = {}) => {
             message: 'Prefix to add to all generated type names (leave blank to use defaults)',
         },
     ];
-    const answers = await inquirer.prompt(helpers_1.overrideDefaults(questions, defaultAnswers));
-    const curlArgs = curl_parser_1.parseCurlArgv(string_argv_1.default(answers.url));
+    const answers = await inquirer.prompt((0, helpers_1.overrideDefaults)(questions, defaultAnswers));
+    const curlArgs = (0, curl_parser_1.parseCurlArgv)((0, string_argv_1.default)(answers.url));
     if ('error' in curlArgs) {
         console.log();
         console.log(chalk.red('A problem occurred while parsing the curl command:\n', curlArgs.error), '\nPlease enter a URL or a supported curl command.');
         console.log();
-        return exports.askCurlQuestions(answers);
+        return (0, exports.askCurlQuestions)(answers);
     }
-    const parsedPathParamsOrError = path_params_parser_1.parsePathParamsPattern(curlArgs.url, answers.pathParams);
+    const parsedPathParamsOrError = (0, path_params_parser_1.parsePathParamsPattern)(curlArgs.url, answers.pathParams);
     if ('error' in parsedPathParamsOrError) {
         console.log();
         console.log(chalk.red('A problem occurred while parsing path parameters pattern:\n', parsedPathParamsOrError.error));
@@ -132,7 +134,7 @@ exports.askCurlQuestions = async (defaultAnswers = {}) => {
             `\tendpoint URL: https://example.com/users/jane/posts/12\n ` +
             `\tpath parameters: /users/${chalk.bold('$userId')}/posts/${chalk.bold('$postId')}`);
         console.log();
-        return exports.askCurlQuestions(answers);
+        return (0, exports.askCurlQuestions)(answers);
     }
     return {
         curlArgs,
@@ -142,8 +144,9 @@ exports.askCurlQuestions = async (defaultAnswers = {}) => {
         pathParams: parsedPathParamsOrError,
     };
 };
-exports.curl2sdl = async ({ curlArgs, name, source, queryName, rootType, typePrefix, pathParams, headers, onConflict, }) => {
-    const response = await helpers_1.queryIntrospectionService(constants_1.STEPZEN_JSON2SDL_SERVER_URL, {
+exports.askCurlQuestions = askCurlQuestions;
+const curl2sdl = async ({ curlArgs, name, source, queryName, rootType, typePrefix, pathParams, headers, onConflict, }) => {
+    const response = await (0, helpers_1.queryIntrospectionService)(constants_1.STEPZEN_JSON2SDL_SERVER_URL, {
         operation: 'getSDLFromCurl',
         variables: {
             command: {
@@ -183,5 +186,11 @@ exports.curl2sdl = async ({ curlArgs, name, source, queryName, rootType, typePre
     if (response.error) {
         return { error: response.error };
     }
-    return helpers_1.writeSdlAndConfig(name || 'curl', source, onConflict, response);
+    return (0, helpers_1.writeSdlAndConfig)({
+        name: name || 'curl',
+        source,
+        onConflict,
+        response,
+    });
 };
+exports.curl2sdl = curl2sdl;

package/lib/generate/graphql2sdl.d.ts

@@ -6,14 +6,14 @@ export declare type GraphQL2SdlOptions = CommonImportOptions & {
     includeRootOperations?: boolean;
     headers: readonly HeaderInput[];
 };
-export declare type EditableGraphQL2SdlOptions = Pick<GraphQL2SdlOptions, 'endpoint' | 'typePrefix' | 'includeRootOperations' | 'headers'>;
+export declare type InteractiveGraphQL2SdlOptions = Pick<GraphQL2SdlOptions, 'endpoint' | 'typePrefix' | 'includeRootOperations' | 'headers'>;
 export declare type GraphQLAnswers = {
     endpoint: string;
     typePrefix: string;
     includeRootOperations: boolean;
-    headers: readonly HeaderInput[];
+    header: string;
 };
-export declare const askGraphQLQuestions: (defaultAnswers?: Partial<GraphQLAnswers>) => Promise<EditableGraphQL2SdlOptions>;
+export declare const askGraphQLQuestions: (defaultAnswers?: Partial<GraphQLAnswers>) => Promise<InteractiveGraphQL2SdlOptions>;
 export declare const graphql2sdl: ({ name, source, endpoint, typePrefix, includeRootOperations, headers, onConflict, }: GraphQL2SdlOptions) => Promise<{
     error: string;
 } | {

package/lib/generate/graphql2sdl.js

@@ -6,7 +6,7 @@ const inquirer = require("inquirer");
 const header_1 = require("../shared/header");
 const helpers_1 = require("./helpers");
 const constants_1 = require("../shared/constants");
-exports.askGraphQLQuestions = async (defaultAnswers = {}) => {
+const askGraphQLQuestions = async (defaultAnswers = {}) => {
     const questions = [
         {
             name: 'endpoint',
@@ -30,10 +30,18 @@ exports.askGraphQLQuestions = async (defaultAnswers = {}) => {
             validate: input => input === '' || header_1.HEADER_REGEX.test(input.trim()) || 'invalid header',
         },
     ];
-    return inquirer.prompt(helpers_1.overrideDefaults(questions, defaultAnswers));
+    const answers = await inquirer.prompt((0, helpers_1.overrideDefaults)(questions, defaultAnswers));
+    const header = (0, header_1.parseHeader)(answers.header);
+    return {
+        endpoint: answers.endpoint,
+        typePrefix: answers.typePrefix.trim() === '' ? undefined : answers.typePrefix.trim(),
+        includeRootOperations: answers.includeRootOperations,
+        headers: header && !('error' in header) ? [header] : [],
+    };
 };
-exports.graphql2sdl = async ({ name, source, endpoint, typePrefix, includeRootOperations, headers, onConflict, }) => {
-    const response = await helpers_1.queryIntrospectionService(constants_1.STEPZEN_JSON2SDL_SERVER_URL, {
+exports.askGraphQLQuestions = askGraphQLQuestions;
+const graphql2sdl = async ({ name, source, endpoint, typePrefix, includeRootOperations, headers, onConflict, }) => {
+    const response = await (0, helpers_1.queryIntrospectionService)(constants_1.STEPZEN_JSON2SDL_SERVER_URL, {
         operation: 'getSDLFromGraphQL',
         variables: {
             endpoint: {
@@ -57,5 +65,11 @@ exports.graphql2sdl = async ({ name, source, endpoint, typePrefix, includeRootOp
     if (response.error) {
         return { error: response.error };
     }
-    return helpers_1.writeSdlAndConfig(name || 'graphql', source, onConflict, response);
+    return (0, helpers_1.writeSdlAndConfig)({
+        name: name || 'graphql',
+        source,
+        onConflict,
+        response,
+    });
 };
+exports.graphql2sdl = graphql2sdl;

package/lib/generate/helpers.d.ts

@@ -27,7 +27,13 @@ export declare type IntrospectionServiceResponse = {
     error?: string;
 };
 export declare const queryIntrospectionService: (serverUrl: string, query: IntrospectionServiceQuery) => Promise<IntrospectionServiceResponse>;
-export declare const writeSdlAndConfig: (name: string, source: string, onConflict: 'overwrite' | 'append', { config, sdl }: IntrospectionServiceResponse) => Promise<{
+export declare const writeSdlAndConfig: ({ name, source, mergeTypes, onConflict, response, }: {
+    name: string;
+    source: string;
+    mergeTypes?: boolean | undefined;
+    onConflict: 'overwrite' | 'append';
+    response: IntrospectionServiceResponse;
+}) => Promise<{
     outPath: string;
 }>;
 export declare const overrideDefaults: <Options>(questions: inquirer.DistinctQuestion<Options>[], defaultAnswers: Partial<Options>) => inquirer.DistinctQuestion<Options>[];

package/lib/generate/helpers.js

@@ -17,12 +17,12 @@ const prettier = require("prettier");
 const constants_1 = require("../shared/constants");
 const errors_2 = require("../shared/errors");
 const { version } = require('../../package.json');
-exports.createGeneratorFiles = async (id, details) => {
+const createGeneratorFiles = async (id, details) => {
     const url = `${constants_1.STEPZEN_DIRECT_GENERATOR_ENGINES_URL}/create`;
     debug('stepzen:generate')(`calling the generator engine ${id} via ${url}`);
     const engineErrorMessageWrap = (msg) => `An error has occurred when creating the schema: ${msg}. Please check your parameters and try again.`;
     try {
-        const response = await node_fetch_1.default(url, {
+        const response = await (0, node_fetch_1.default)(url, {
             body: JSON.stringify({
                 id,
                 details: JSON.stringify(details.answers),
@@ -62,11 +62,12 @@ exports.createGeneratorFiles = async (id, details) => {
             : new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
     }
 };
-exports.getConfiguration = async (id, details = {}) => {
+exports.createGeneratorFiles = createGeneratorFiles;
+const getConfiguration = async (id, details = {}) => {
     const url = `${constants_1.STEPZEN_DIRECT_GENERATOR_ENGINES_URL}/configure`;
     debug('stepzen:generate')(`calling the generator engine ${id} via ${url}`);
     try {
-        const response = await node_fetch_1.default(url, {
+        const response = await (0, node_fetch_1.default)(url, {
             body: JSON.stringify({
                 id,
                 details: JSON.stringify(details),
@@ -90,7 +91,8 @@ exports.getConfiguration = async (id, details = {}) => {
         throw new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
     }
 };
-exports.getSchema = (arg) => {
+exports.getConfiguration = getConfiguration;
+const getSchema = (arg) => {
     const schema = arg.trim();
     // Now supports importing only one schema at a time:
     // https://github.com/steprz/stepzen-cli/issues/628
@@ -104,7 +106,8 @@ exports.getSchema = (arg) => {
     }
     return schema;
 };
-exports.getTemplates = async () => {
+exports.getSchema = getSchema;
+const getTemplates = async () => {
     const tmp = path.join(os.tmpdir(), `stepzen-api-templates-${Date.now()}`);
     fs.ensureDirSync(tmp);
     const repository = constants_1.STEPZEN_API_TEMPLATES_REPOSITORY;
@@ -115,7 +118,8 @@ exports.getTemplates = async () => {
     }
     return tmp;
 };
-exports.askGeneratorQuestions = async (id, settings, state) => {
+exports.getTemplates = getTemplates;
+const askGeneratorQuestions = async (id, settings, state) => {
     var _a, _b;
     let status = -1;
     do {
@@ -123,14 +127,14 @@ exports.askGeneratorQuestions = async (id, settings, state) => {
             return Object.assign(Object.assign({ type: 'password' }, question), { 
                 // set the previous iteration's answer as the default value, except for password fields
                 default: question.type && question.type !== 'password'
-                    ? lodash_1.get(state, question.name)
+                    ? (0, lodash_1.get)(state, question.name)
                     : undefined });
         });
         // eslint-disable-next-line no-await-in-loop
         const answers = await inquirer.prompt(questions);
-        state = lodash_1.merge(state, answers);
+        state = (0, lodash_1.merge)(state, answers);
         // eslint-disable-next-line no-await-in-loop
-        const result = await exports.getConfiguration(id, state);
+        const result = await (0, exports.getConfiguration)(id, state);
         if (!result) {
             // at this point the generator ${id} should have been validated
             throw new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
@@ -150,18 +154,20 @@ exports.askGeneratorQuestions = async (id, settings, state) => {
                 questions: result.questions,
             };
             // eslint-disable-next-line require-atomic-updates
-            state = lodash_1.merge(state, result.answers);
+            state = (0, lodash_1.merge)(state, result.answers);
         }
         status = result.status;
     } while (status === -1);
     return state;
 };
-exports.askTemplateQuestions = async (id, settings, state) => {
+exports.askGeneratorQuestions = askGeneratorQuestions;
+const askTemplateQuestions = async (id, settings, state) => {
     const questions = settings.questions.map((question) => (Object.assign({ type: 'password' }, question)));
     const answers = await inquirer.prompt(questions);
     return Object.assign(Object.assign({}, state), answers);
 };
-exports.queryIntrospectionService = async (serverUrl, query) => {
+exports.askTemplateQuestions = askTemplateQuestions;
+const queryIntrospectionService = async (serverUrl, query) => {
     let json;
     try {
         debug('stepzen:introspection')(serverUrl);
@@ -177,10 +183,10 @@ exports.queryIntrospectionService = async (serverUrl, query) => {
         debug('stepzen:introspection')(query.variables);
         const payload = JSON.stringify({
             query: queryString,
-            variables: lodash_1.mapValues(query.variables, ({ value }) => value),
+            variables: (0, lodash_1.mapValues)(query.variables, ({ value }) => value),
         });
         debug('stepzen:introspection')(payload);
-        const response = await node_fetch_1.default(serverUrl, {
+        const response = await (0, node_fetch_1.default)(serverUrl, {
             method: 'POST',
             headers: { 'Content-Type': 'application/json' },
             body: payload,
@@ -200,9 +206,17 @@ exports.queryIntrospectionService = async (serverUrl, query) => {
     }
     if (json.errors) {
         const compileError = (error) => {
-            var _a;
+            var _a, _b, _c;
             return error.message +
-                (((_a = error.extensions) === null || _a === void 0 ? void 0 : _a.details) ? `: ${JSON.stringify(error.extensions.details)}`
+                // error.extensions.Message: DB introspection API (e.g. wrong password)
+                (((_a = error.extensions) === null || _a === void 0 ? void 0 : _a.Message) ? `: ${error.extensions.Message}` : '') +
+                // error.extensions.details: REST instrospection API (e.g. 401 / unauthorized)
+                (((_b = error.extensions) === null || _b === void 0 ? void 0 : _b.details)
+                    ? `: ${JSON.stringify(error.extensions.details)}`
+                    : '') +
+                // error.extensions.cause: DB introspection API (e.g. --db-include=views-only and there are no views)
+                (((_c = error.extensions) === null || _c === void 0 ? void 0 : _c.cause)
+                    ? `: ${JSON.stringify(error.extensions.cause)}`
                     : '');
         };
         return { error: json.errors.map(compileError).join('\n') };
@@ -221,7 +235,9 @@ exports.queryIntrospectionService = async (serverUrl, query) => {
     }
     return { config, sdl };
 };
-exports.writeSdlAndConfig = async (name, source, onConflict, { config, sdl }) => {
+exports.queryIntrospectionService = queryIntrospectionService;
+const writeSdlAndConfig = async ({ name, source, mergeTypes = false, onConflict, response, }) => {
+    const { config, sdl } = response;
     // write out the generated config and schema files
     const tmp = path.join(os.tmpdir(), `stepzen-introspection-${Date.now()}`);
     fs.ensureDirSync(tmp);
@@ -239,14 +255,16 @@ exports.writeSdlAndConfig = async (name, source, onConflict, { config, sdl }) =>
         answers: {},
         output: null,
         silent: true,
-        mergeTypes: false,
+        mergeTypes,
         onConflict,
     });
     return { outPath: result };
 };
-exports.overrideDefaults = (questions, defaultAnswers) => {
+exports.writeSdlAndConfig = writeSdlAndConfig;
+const overrideDefaults = (questions, defaultAnswers) => {
     return questions.map(question => {
-        const def = lodash_1.get(defaultAnswers, question.name);
+        const def = (0, lodash_1.get)(defaultAnswers, question.name);
         return def === undefined ? question : Object.assign(Object.assign({}, question), { default: def });
     });
 };
+exports.overrideDefaults = overrideDefaults;

package/lib/generate/index.js

@@ -19,7 +19,7 @@ exports.default = async ({ schema, name, onConflict, source, preAnswered = {}, }
     // Start downloading
     core_1.CliUx.ux.action.start('Downloading from StepZen...');
     // Get the generator configuration
-    const configure = await helpers_1.getConfiguration(schema, answers);
+    const configure = await (0, helpers_1.getConfiguration)(schema, answers);
     if (((_a = configure === null || configure === void 0 ? void 0 : configure.questions) === null || _a === void 0 ? void 0 : _a.length) ||
         ((configure === null || configure === void 0 ? void 0 : configure.status) && configure.status >= 0)) {
         generator = {
@@ -44,7 +44,7 @@ exports.default = async ({ schema, name, onConflict, source, preAnswered = {}, }
     // Get the API templates repository
     let templates;
     if (generator === undefined) {
-        templates = await helpers_1.getTemplates();
+        templates = await (0, helpers_1.getTemplates)();
         if (fs.existsSync(`${templates}/${schema}`)) {
             const file = path.join(templates, schema, 'stepzen.config.json');
             const config = fs.readFileSync(file, 'utf8');
@@ -67,19 +67,19 @@ exports.default = async ({ schema, name, onConflict, source, preAnswered = {}, }
         throw new errors_1.CLIError(`Cannot find the schema ${schema}`);
     }
     else if (generator.type === 'generator') {
-        result = await helpers_1.askGeneratorQuestions(schema, generator, answers);
+        result = await (0, helpers_1.askGeneratorQuestions)(schema, generator, answers);
     }
     else if (generator.type === 'template') {
-        result = await helpers_1.askTemplateQuestions(schema, generator, answers);
+        result = await (0, helpers_1.askTemplateQuestions)(schema, generator, answers);
     }
     generator.answers = result;
-    answers = lodash_1.merge(answers, result);
+    answers = (0, lodash_1.merge)(answers, result);
     // We now have all the answers! Generate schemas
     console.log();
     core_1.CliUx.ux.action.start('Generating schemas...');
     let files;
     if (generator.type === 'generator') {
-        files = await helpers_1.createGeneratorFiles(schema, generator);
+        files = await (0, helpers_1.createGeneratorFiles)(schema, generator);
         tempFiles.push(files);
     }
     else {

package/lib/generate/sql2sdl.d.ts

@@ -1,21 +1,22 @@
 import type { CommonImportOptions } from '.';
 export declare type DBType = 'mysql' | 'postgresql';
-export declare type SQLOptions = CommonImportOptions & {
+export declare type Sql2SdlOptions = CommonImportOptions & {
     host: string;
     database: string;
     user: string;
     password: string;
     linkTypes?: boolean;
     schema?: string;
+    include?: 'tables-only' | 'views-only' | 'tables-and-views';
 };
-export declare type EditableSQLOptions = Pick<SQLOptions, 'host' | 'database' | 'user' | 'password' | 'linkTypes' | 'schema'>;
-export declare const parseHost: (host?: string | undefined) => {
+export declare type InteractiveSql2SdlOptions = Pick<Sql2SdlOptions, 'host' | 'database' | 'user' | 'password' | 'linkTypes' | 'schema'>;
+export declare const parseHost: (host?: string) => {
     host?: string | undefined;
     port?: string | undefined;
     isValid: boolean;
 };
-export declare const askSqlQuestions: (dbType: DBType, defaultAnswers?: Partial<SQLOptions>) => Promise<EditableSQLOptions>;
-export declare const sql2sdl: (dbType: DBType, { name, source, host, database, user, password, linkTypes, schema, onConflict, }: SQLOptions) => Promise<{
+export declare const askSqlQuestions: (dbType: DBType, defaultAnswers?: Partial<Sql2SdlOptions>) => Promise<InteractiveSql2SdlOptions>;
+export declare const sql2sdl: (dbType: DBType, { name, source, host, database, user, password, linkTypes, include, schema, onConflict, }: Sql2SdlOptions) => Promise<{
     error: string;
 } | {
     outPath: string;

package/lib/generate/sql2sdl.js

@@ -6,7 +6,7 @@ const chalk = require("chalk");
 const inquirer = require("inquirer");
 const helpers_1 = require("./helpers");
 const constants_1 = require("../shared/constants");
-exports.parseHost = (host) => {
+const parseHost = (host) => {
     if (!host) {
         return { host: undefined, port: undefined, isValid: false };
     }
@@ -35,12 +35,13 @@ exports.parseHost = (host) => {
         isValid: true,
     };
 };
-exports.askSqlQuestions = async (dbType, defaultAnswers = {}) => {
+exports.parseHost = parseHost;
+const askSqlQuestions = async (dbType, defaultAnswers = {}) => {
     let questions = [
         {
             name: 'host',
             message: 'What is your host?',
-            validate: input => exports.parseHost(input).isValid || `Could not parse "${input}" as a hostname.`,
+            validate: input => (0, exports.parseHost)(input).isValid || `Could not parse "${input}" as a hostname.`,
         },
         {
             name: 'database',
@@ -59,8 +60,8 @@ exports.askSqlQuestions = async (dbType, defaultAnswers = {}) => {
         },
         {
             name: 'linkTypes',
-            message: 'Automatically link types with @materializer whenever there is database support' +
-                `\n  ${chalk.dim('(https://stepzen.com/docs/features/linking-types)')}`,
+            message: `Automatically link types based on foreign key relationships using @materializer` +
+                `\n ${chalk.dim('(https://stepzen.com/docs/features/linking-types)')}`,
             type: 'confirm',
             default: false,
         },
@@ -73,12 +74,27 @@ exports.askSqlQuestions = async (dbType, defaultAnswers = {}) => {
             },
         ]);
     }
-    return inquirer.prompt(helpers_1.overrideDefaults(questions, defaultAnswers));
+    return inquirer.prompt((0, helpers_1.overrideDefaults)(questions, defaultAnswers));
 };
-exports.sql2sdl = async (dbType, { name, source, host, database, user, password, linkTypes, schema, onConflict, }) => {
+exports.askSqlQuestions = askSqlQuestions;
+const sql2sdl = async (dbType, { name, source, host, database, user, password, linkTypes, include, schema, onConflict, }) => {
+    let inludeAsTableOptions;
+    switch (include) {
+        case 'tables-only':
+            inludeAsTableOptions = 'ONLYTABLES';
+            break;
+        case 'views-only':
+            inludeAsTableOptions = 'ONLYVIEWS';
+            break;
+        case 'tables-and-views':
+            inludeAsTableOptions = 'TABLESANDVIEWS';
+            break;
+        default:
+            inludeAsTableOptions = null;
+    }
     const effectiveName = name || dbType;
-    const hostDetails = exports.parseHost(host);
-    const response = await helpers_1.queryIntrospectionService(constants_1.STEPZEN_DBINTROSPECTION_SERVER_URL, {
+    const hostDetails = (0, exports.parseHost)(host);
+    const response = await (0, helpers_1.queryIntrospectionService)(constants_1.STEPZEN_DBINTROSPECTION_SERVER_URL, {
         operation: 'generateSDL',
         variables: {
             driver: {
@@ -111,6 +127,10 @@ exports.sql2sdl = async (dbType, { name, source, host, database, user, password,
                 type: 'Boolean',
                 value: !linkTypes,
             },
+            include: {
+                type: 'TableOptions',
+                value: inludeAsTableOptions,
+            },
             schema: {
                 type: 'String',
                 value: schema,
@@ -124,5 +144,12 @@ exports.sql2sdl = async (dbType, { name, source, host, database, user, password,
     if (response.error) {
         return { error: response.error };
     }
-    return helpers_1.writeSdlAndConfig(effectiveName, source, onConflict, response);
+    return (0, helpers_1.writeSdlAndConfig)({
+        name: effectiveName,
+        source,
+        mergeTypes: true,
+        onConflict,
+        response,
+    });
 };
+exports.sql2sdl = sql2sdl;