@feathersjs/cli 4.6.2 → 5.0.0-pre.24

package/lib/commons.js

@@ -0,0 +1,137 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSource = exports.renderSource = exports.getJavaScript = exports.initializeBaseContext = exports.addVersions = exports.getDatabaseAdapter = void 0;
+const pinion_1 = require("@feathershq/pinion");
+const ts = __importStar(require("typescript"));
+const prettier_1 = __importDefault(require("prettier"));
+const path_1 = __importDefault(require("path"));
+/**
+ * Returns the name of the Feathers database adapter for a supported database type
+ *
+ * @param database The type of the database
+ * @returns The name of the adapter
+ */
+const getDatabaseAdapter = (database) => (database === 'mongodb' ? 'mongodb' : 'knex');
+exports.getDatabaseAdapter = getDatabaseAdapter;
+/**
+ * Returns dependencies with the versions from the context attached (if available)
+ *
+ * @param dependencies The dependencies to install
+ * @param versions The dependency version list
+ * @returns A list of dependencies with their versions
+ */
+const addVersions = (dependencies, versions) => dependencies.map((dep) => `${dep}@${versions[dep] ? versions[dep] : 'latest'}`);
+exports.addVersions = addVersions;
+/**
+ * Loads the application package.json and populates information like the library and test directory
+ * and Feathers app specific information.
+ *
+ * @returns The updated context
+ */
+const initializeBaseContext = () => (ctx) => Promise.resolve(ctx)
+    .then((0, pinion_1.loadJSON)((0, pinion_1.fromFile)('package.json'), (pkg) => ({ pkg }), {}))
+    .then((0, pinion_1.loadJSON)(path_1.default.join(__dirname, '..', 'package.json'), (pkg) => ({
+    dependencyVersions: {
+        ...pkg.devDependencies,
+        ...ctx.dependencyVersions
+    }
+})))
+    .then((ctx) => {
+    var _a, _b, _c, _d, _e, _f, _g;
+    return ({
+        ...ctx,
+        lib: ((_b = (_a = ctx.pkg) === null || _a === void 0 ? void 0 : _a.directories) === null || _b === void 0 ? void 0 : _b.lib) || 'src',
+        test: ((_d = (_c = ctx.pkg) === null || _c === void 0 ? void 0 : _c.directories) === null || _d === void 0 ? void 0 : _d.test) || 'test',
+        language: ctx.language || ((_f = (_e = ctx.pkg) === null || _e === void 0 ? void 0 : _e.feathers) === null || _f === void 0 ? void 0 : _f.language),
+        feathers: (_g = ctx.pkg) === null || _g === void 0 ? void 0 : _g.feathers
+    });
+});
+exports.initializeBaseContext = initializeBaseContext;
+const importRegex = /from '(\..*)'/g;
+const escapeNewLines = (code) => code.replace(/\n\n/g, '\n/* :newline: */');
+const restoreNewLines = (code) => code.replace(/\/\* :newline: \*\//g, '\n');
+const fixLocalImports = (code) => code.replace(importRegex, "from '$1.js'");
+/**
+ * Returns the transpiled and prettified JavaScript for a TypeScript source code
+ *
+ * @param typescript The TypeScript source code
+ * @param options TypeScript transpilation options
+ * @returns The formatted JavaScript source code
+ */
+const getJavaScript = (typescript, options = {}) => {
+    const source = escapeNewLines(typescript);
+    const transpiled = ts.transpileModule(source, {
+        ...options,
+        compilerOptions: {
+            module: ts.ModuleKind.ESNext,
+            target: ts.ScriptTarget.ES2020,
+            preserveValueImports: true,
+            ...options.compilerOptions
+        }
+    });
+    const code = fixLocalImports(restoreNewLines(transpiled.outputText));
+    return prettier_1.default.format(code, {
+        semi: false,
+        parser: 'babel',
+        singleQuote: true
+    });
+};
+exports.getJavaScript = getJavaScript;
+/**
+ * Render a source file template for the language set in the context. Will do nothing
+ * it there is no template for the selected language.
+ *
+ * @param templates The JavaScript and TypeScript template to render
+ * @param toFile The target filename without extension (will be added based on language)
+ * @returns The updated context
+ */
+const renderSource = (template, toFile, options) => async (ctx) => {
+    if (!template) {
+        return ctx;
+    }
+    const { language } = ctx;
+    const fileName = await (0, pinion_1.getCallable)(toFile, ctx);
+    const content = language === 'js' ? (0, exports.getJavaScript)(await (0, pinion_1.getCallable)(template, ctx)) : template;
+    const renderer = (0, pinion_1.renderTemplate)(content, `${fileName}.${language}`, options);
+    return renderer(ctx);
+};
+exports.renderSource = renderSource;
+/**
+ * Returns the TypeScript or transpiled JavaScript source code
+ *
+ * @param template The source template
+ * @returns
+ */
+const getSource = (template) => async (ctx) => {
+    const { language } = ctx;
+    const source = await (0, pinion_1.getCallable)(template, ctx);
+    return language === 'js' ? (0, exports.getJavaScript)(source) : source;
+};
+exports.getSource = getSource;
+//# sourceMappingURL=commons.js.map

package/lib/commons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commons.js","sourceRoot":"","sources":["../src/commons.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,+CAA6G;AAC7G,+CAAgC;AAChC,wDAA+B;AAC/B,gDAAuB;AASvB;;;;;GAKG;AACI,MAAM,kBAAkB,GAAG,CAAC,QAAsB,EAAE,EAAE,CAAC,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;AAA9F,QAAA,kBAAkB,sBAA4E;AA0D3G;;;;;;GAMG;AACI,MAAM,WAAW,GAAG,CAAC,YAAsB,EAAE,QAA4B,EAAE,EAAE,CAClF,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;AADpE,QAAA,WAAW,eACyD;AAEjF;;;;;GAKG;AACI,MAAM,qBAAqB,GAChC,GAAG,EAAE,CACL,CAAgC,GAAM,EAAE,EAAE,CACxC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC;KACjB,IAAI,CAAC,IAAA,iBAAQ,EAAC,IAAA,iBAAQ,EAAC,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;KAChE,IAAI,CACH,IAAA,iBAAQ,EAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC,GAAgB,EAAE,EAAE,CAAC,CAAC;IAC1E,kBAAkB,EAAE;QAClB,GAAG,GAAG,CAAC,eAAe;QACtB,GAAG,GAAG,CAAC,kBAAkB;KAC1B;CACF,CAAC,CAAC,CACJ;KACA,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;;IAAC,OAAA,CAAC;QACd,GAAG,GAAG;QACN,GAAG,EAAE,CAAA,MAAA,MAAA,GAAG,CAAC,GAAG,0CAAE,WAAW,0CAAE,GAAG,KAAI,KAAK;QACvC,IAAI,EAAE,CAAA,MAAA,MAAA,GAAG,CAAC,GAAG,0CAAE,WAAW,0CAAE,IAAI,KAAI,MAAM;QAC1C,QAAQ,EAAE,GAAG,CAAC,QAAQ,KAAI,MAAA,MAAA,GAAG,CAAC,GAAG,0CAAE,QAAQ,0CAAE,QAAQ,CAAA;QACrD,QAAQ,EAAE,MAAA,GAAG,CAAC,GAAG,0CAAE,QAAQ;KAC5B,CAAC,CAAA;CAAA,CAAC,CAAA;AAnBI,QAAA,qBAAqB,yBAmBzB;AAET,MAAM,WAAW,GAAG,gBAAgB,CAAA;AACpC,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAA;AACnF,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAA;AACpF,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,cAAc,CAAC,CAAA;AAEnF;;;;;;GAMG;AACI,MAAM,aAAa,GAAG,CAAC,UAAkB,EAAE,UAA+B,EAAE,EAAE,EAAE;IACrF,MAAM,MAAM,GAAG,cAAc,CAAC,UAAU,CAAC,CAAA;IACzC,MAAM,UAAU,GAAG,EAAE,CAAC,eAAe,CAAC,MAAM,EAAE;QAC5C,GAAG,OAAO;QACV,eAAe,EAAE;YACf,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM;YAC5B,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM;YAC9B,oBAAoB,EAAE,IAAI;YAC1B,GAAG,OAAO,CAAC,eAAe;SAC3B;KACF,CAAC,CAAA;IACF,MAAM,IAAI,GAAG,eAAe,CAAC,eAAe,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAA;IAEpE,OAAO,kBAAQ,CAAC,MAAM,CAAC,IAAI,EAAE;QAC3B,IAAI,EAAE,KAAK;QACX,MAAM,EAAE,OAAO;QACf,WAAW,EAAE,IAAI;KAClB,CAAC,CAAA;AACJ,CAAC,CAAA;AAlBY,QAAA,aAAa,iBAkBzB;AAED;;;;;;;GAOG;AACI,MAAM,YAAY,GACvB,CACE,QAA6B,EAC7B,MAA2B,EAC3B,OAA4B,EAC5B,EAAE,CACJ,KAAK,EAAE,GAAM,EAAE,EAAE;IACf,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,GAAG,CAAA;KACX;IAED,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAA;IACxB,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAW,EAAY,MAAM,EAAE,GAAG,CAAC,CAAA;IAC1D,MAAM,OAAO,GAAG,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,IAAA,qBAAa,EAAC,MAAM,IAAA,oBAAW,EAAY,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAA;IACzG,MAAM,QAAQ,GAAG,IAAA,uBAAc,EAAC,OAAO,EAAE,GAAG,QAAQ,IAAI,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAA;IAE5E,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAA;AACtB,CAAC,CAAA;AAjBU,QAAA,YAAY,gBAiBtB;AAEH;;;;;GAKG;AACI,MAAM,SAAS,GACpB,CAAsD,QAA6B,EAAE,EAAE,CACvF,KAAK,EAAe,GAAM,EAAE,EAAE;IAC5B,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAA;IACxB,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAW,EAAY,QAAQ,EAAE,GAAG,CAAC,CAAA;IAE1D,OAAO,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;AAC3D,CAAC,CAAA;AAPU,QAAA,SAAS,aAOnB"}

package/lib/commons.ts

@@ -0,0 +1,187 @@
+import { PackageJson } from 'type-fest'
+import { Callable, PinionContext, loadJSON, fromFile, getCallable, renderTemplate } from '@feathershq/pinion'
+import * as ts from 'typescript'
+import prettier from 'prettier'
+import path from 'path'
+
+export type DependencyVersions = { [key: string]: string }
+
+/**
+ * The database types supported by this generator
+ */
+export type DatabaseType = 'mongodb' | 'mysql' | 'postgresql' | 'sqlite' | 'mssql'
+
+/**
+ * Returns the name of the Feathers database adapter for a supported database type
+ *
+ * @param database The type of the database
+ * @returns The name of the adapter
+ */
+export const getDatabaseAdapter = (database: DatabaseType) => (database === 'mongodb' ? 'mongodb' : 'knex')
+
+export type FeathersAppInfo = {
+  /**
+   * The application language
+   */
+  language: 'ts' | 'js'
+  /**
+   * The main database
+   */
+  database: DatabaseType
+  /**
+   * The package manager used
+   */
+  packager: 'yarn' | 'npm'
+  /**
+   * A list of all chosen transports
+   */
+  transports: ('rest' | 'websockets')[]
+  /**
+   * The HTTP framework used
+   */
+  framework: 'koa' | 'express'
+}
+
+export interface AppPackageJson extends PackageJson {
+  feathers?: FeathersAppInfo
+}
+
+export interface FeathersBaseContext extends PinionContext {
+  /**
+   * Information about the Feathers application (like chosen language, database etc.)
+   * usually taken from `package.json`
+   */
+  feathers: FeathersAppInfo
+  /**
+   * The package.json file
+   */
+  pkg: AppPackageJson
+  /**
+   * The folder where source files are put
+   */
+  lib: string
+  /**
+   * The folder where test files are put
+   */
+  test: string
+  /**
+   * The language the app is generated in
+   */
+  language: 'js' | 'ts'
+  /**
+   * A list dependencies that should be installed with a certain version.
+   * Used for installing development dependencies during testing.
+   */
+  dependencyVersions?: DependencyVersions
+}
+
+/**
+ * Returns dependencies with the versions from the context attached (if available)
+ *
+ * @param dependencies The dependencies to install
+ * @param versions The dependency version list
+ * @returns A list of dependencies with their versions
+ */
+export const addVersions = (dependencies: string[], versions: DependencyVersions) =>
+  dependencies.map((dep) => `${dep}@${versions[dep] ? versions[dep] : 'latest'}`)
+
+/**
+ * Loads the application package.json and populates information like the library and test directory
+ * and Feathers app specific information.
+ *
+ * @returns The updated context
+ */
+export const initializeBaseContext =
+  () =>
+  <C extends FeathersBaseContext>(ctx: C) =>
+    Promise.resolve(ctx)
+      .then(loadJSON(fromFile('package.json'), (pkg) => ({ pkg }), {}))
+      .then(
+        loadJSON(path.join(__dirname, '..', 'package.json'), (pkg: PackageJson) => ({
+          dependencyVersions: {
+            ...pkg.devDependencies,
+            ...ctx.dependencyVersions
+          }
+        }))
+      )
+      .then((ctx) => ({
+        ...ctx,
+        lib: ctx.pkg?.directories?.lib || 'src',
+        test: ctx.pkg?.directories?.test || 'test',
+        language: ctx.language || ctx.pkg?.feathers?.language,
+        feathers: ctx.pkg?.feathers
+      }))
+
+const importRegex = /from '(\..*)'/g
+const escapeNewLines = (code: string) => code.replace(/\n\n/g, '\n/* :newline: */')
+const restoreNewLines = (code: string) => code.replace(/\/\* :newline: \*\//g, '\n')
+const fixLocalImports = (code: string) => code.replace(importRegex, "from '$1.js'")
+
+/**
+ * Returns the transpiled and prettified JavaScript for a TypeScript source code
+ *
+ * @param typescript The TypeScript source code
+ * @param options TypeScript transpilation options
+ * @returns The formatted JavaScript source code
+ */
+export const getJavaScript = (typescript: string, options: ts.TranspileOptions = {}) => {
+  const source = escapeNewLines(typescript)
+  const transpiled = ts.transpileModule(source, {
+    ...options,
+    compilerOptions: {
+      module: ts.ModuleKind.ESNext,
+      target: ts.ScriptTarget.ES2020,
+      preserveValueImports: true,
+      ...options.compilerOptions
+    }
+  })
+  const code = fixLocalImports(restoreNewLines(transpiled.outputText))
+
+  return prettier.format(code, {
+    semi: false,
+    parser: 'babel',
+    singleQuote: true
+  })
+}
+
+/**
+ * Render a source file template for the language set in the context. Will do nothing
+ * it there is no template for the selected language.
+ *
+ * @param templates The JavaScript and TypeScript template to render
+ * @param toFile The target filename without extension (will be added based on language)
+ * @returns The updated context
+ */
+export const renderSource =
+  <C extends PinionContext & { language: 'js' | 'ts' }>(
+    template: Callable<string, C>,
+    toFile: Callable<string, C>,
+    options?: { force: boolean }
+  ) =>
+  async (ctx: C) => {
+    if (!template) {
+      return ctx
+    }
+
+    const { language } = ctx
+    const fileName = await getCallable<string, C>(toFile, ctx)
+    const content = language === 'js' ? getJavaScript(await getCallable<string, C>(template, ctx)) : template
+    const renderer = renderTemplate(content, `${fileName}.${language}`, options)
+
+    return renderer(ctx)
+  }
+
+/**
+ * Returns the TypeScript or transpiled JavaScript source code
+ *
+ * @param template The source template
+ * @returns
+ */
+export const getSource =
+  <C extends PinionContext & { language: 'js' | 'ts' }>(template: Callable<string, C>) =>
+  async <T extends C>(ctx: T) => {
+    const { language } = ctx
+    const source = await getCallable<string, C>(template, ctx)
+
+    return language === 'js' ? getJavaScript(source) : source
+  }

package/lib/connection/index.d.ts

@@ -0,0 +1,53 @@
+import { FeathersBaseContext, DatabaseType } from '../commons';
+export interface ConnectionGeneratorContext extends FeathersBaseContext {
+    database: DatabaseType;
+    connectionString: string;
+    dependencies: string[];
+}
+export declare type ConnectionGeneratorArguments = FeathersBaseContext & Partial<Pick<ConnectionGeneratorContext, 'database' | 'connectionString'>>;
+export declare const defaultConnectionString: (type: DatabaseType, name: string) => string;
+export declare const prompts: ({ database, connectionString, pkg }: ConnectionGeneratorArguments) => ({
+    name: string;
+    type: string;
+    when: boolean;
+    message: string;
+    suffix: string;
+    choices: {
+        value: string;
+        name: string;
+    }[];
+    default?: undefined;
+} | {
+    name: string;
+    type: string;
+    when: boolean;
+    message: string;
+    default: (answers: {
+        name?: string;
+        database: DatabaseType;
+    }) => string;
+    suffix?: undefined;
+    choices?: undefined;
+})[];
+export declare const DATABASE_CLIENTS: {
+    mongodb: string;
+    sqlite: string;
+    postgresql: string;
+    mysql: string;
+    mssql: string;
+};
+export declare const getDatabaseClient: (database: DatabaseType) => string;
+export declare const generate: (ctx: ConnectionGeneratorArguments) => Promise<{
+    dependencies: string[];
+    database: DatabaseType;
+    connectionString: string;
+    feathers: import("../commons").FeathersAppInfo;
+    pkg: import("../commons").AppPackageJson;
+    lib: string;
+    test: string;
+    language: "js" | "ts";
+    dependencyVersions?: import("../commons").DependencyVersions;
+    cwd: string;
+    _?: (string | number)[];
+    pinion: import("@feathershq/pinion").Configuration;
+}>;

package/lib/connection/index.js

@@ -0,0 +1,86 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generate = exports.getDatabaseClient = exports.DATABASE_CLIENTS = exports.prompts = exports.defaultConnectionString = void 0;
+const pinion_1 = require("@feathershq/pinion");
+const chalk_1 = __importDefault(require("chalk"));
+const commons_1 = require("../commons");
+const defaultConnectionString = (type, name) => {
+    const connectionStrings = {
+        mongodb: `mongodb://localhost:27017/${name}`,
+        mysql: `mysql://root:@localhost:3306/${name}`,
+        postgresql: `postgres://postgres:@localhost:5432/${name}`,
+        sqlite: `${name}.sqlite`,
+        mssql: `mssql://root:password@localhost:1433/${name}`
+    };
+    return connectionStrings[type];
+};
+exports.defaultConnectionString = defaultConnectionString;
+const prompts = ({ database, connectionString, pkg }) => [
+    {
+        name: 'database',
+        type: 'list',
+        when: !database,
+        message: 'Which database are you connecting to?',
+        suffix: chalk_1.default.grey(' Other databases can be added at any time'),
+        choices: [
+            { value: 'sqlite', name: 'SQLite' },
+            { value: 'mongodb', name: 'MongoDB' },
+            { value: 'postgresql', name: 'PostgreSQL' },
+            { value: 'mysql', name: 'MySQL/MariaDB' },
+            { value: 'mssql', name: 'Microsoft SQL' }
+        ]
+    },
+    {
+        name: 'connectionString',
+        type: 'input',
+        when: !connectionString,
+        message: 'Enter your database connection string',
+        default: (answers) => (0, exports.defaultConnectionString)(answers.database, answers.name || pkg.name)
+    }
+];
+exports.prompts = prompts;
+exports.DATABASE_CLIENTS = {
+    mongodb: 'mongodb',
+    sqlite: 'sqlite3',
+    postgresql: 'pg',
+    mysql: 'mysql',
+    mssql: 'tedious'
+};
+const getDatabaseClient = (database) => exports.DATABASE_CLIENTS[database];
+exports.getDatabaseClient = getDatabaseClient;
+const generate = (ctx) => (0, pinion_1.generator)(ctx)
+    .then((0, pinion_1.prompt)(exports.prompts))
+    .then((0, pinion_1.runGenerator)(__dirname, 'templates', ({ database }) => `${(0, commons_1.getDatabaseAdapter)(database)}.tpl`))
+    .then((0, pinion_1.mergeJSON)(({ connectionString, database }) => (0, commons_1.getDatabaseAdapter)(database) === 'knex'
+    ? {
+        [database]: {
+            client: (0, exports.getDatabaseClient)(database),
+            connection: connectionString,
+            ...(database === 'sqlite' ? { useNullAsDefault: true } : {})
+        }
+    }
+    : {
+        [database]: connectionString
+    }, (0, pinion_1.toFile)('config', 'default.json')))
+    .then((ctx) => {
+    const dependencies = [];
+    const adapter = (0, commons_1.getDatabaseAdapter)(ctx.database);
+    const dbClient = (0, exports.getDatabaseClient)(ctx.database);
+    dependencies.push(`@feathersjs/${adapter}`);
+    if (adapter === 'knex') {
+        dependencies.push('knex');
+    }
+    dependencies.push(dbClient);
+    if (ctx.dependencies) {
+        return {
+            ...ctx,
+            dependencies: [...ctx.dependencies, ...dependencies]
+        };
+    }
+    return (0, pinion_1.install)((0, commons_1.addVersions)(dependencies, ctx.dependencyVersions))(ctx);
+});
+exports.generate = generate;
+//# sourceMappingURL=index.js.map

package/lib/connection/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/connection/index.ts"],"names":[],"mappings":";;;;;;AAAA,+CAAgG;AAChG,kDAAyB;AACzB,wCAA+F;AAWxF,MAAM,uBAAuB,GAAG,CAAC,IAAkB,EAAE,IAAY,EAAE,EAAE;IAC1E,MAAM,iBAAiB,GAAG;QACxB,OAAO,EAAE,6BAA6B,IAAI,EAAE;QAC5C,KAAK,EAAE,gCAAgC,IAAI,EAAE;QAC7C,UAAU,EAAE,uCAAuC,IAAI,EAAE;QACzD,MAAM,EAAE,GAAG,IAAI,SAAS;QACxB,KAAK,EAAE,wCAAwC,IAAI,EAAE;KACtD,CAAA;IAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;AAChC,CAAC,CAAA;AAVY,QAAA,uBAAuB,2BAUnC;AAEM,MAAM,OAAO,GAAG,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,GAAG,EAAgC,EAAE,EAAE,CAAC;IAC5F;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,CAAC,QAAQ;QACf,OAAO,EAAE,uCAAuC;QAChD,MAAM,EAAE,eAAK,CAAC,IAAI,CAAC,2CAA2C,CAAC;QAC/D,OAAO,EAAE;YACP,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE;YACnC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;YACrC,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,YAAY,EAAE;YAC3C,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE;YACzC,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE;SAC1C;KACF;IACD;QACE,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,CAAC,gBAAgB;QACvB,OAAO,EAAE,uCAAuC;QAChD,OAAO,EAAE,CAAC,OAAkD,EAAE,EAAE,CAC9D,IAAA,+BAAuB,EAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC;KACtE;CACF,CAAA;AAvBY,QAAA,OAAO,WAuBnB;AAEY,QAAA,gBAAgB,GAAG;IAC9B,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,SAAS;IACjB,UAAU,EAAE,IAAI;IAChB,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,SAAS;CACjB,CAAA;AAEM,MAAM,iBAAiB,GAAG,CAAC,QAAsB,EAAE,EAAE,CAAC,wBAAgB,CAAC,QAAQ,CAAC,CAAA;AAA1E,QAAA,iBAAiB,qBAAyD;AAEhF,MAAM,QAAQ,GAAG,CAAC,GAAiC,EAAE,EAAE,CAC5D,IAAA,kBAAS,EAAC,GAAG,CAAC;KACX,IAAI,CAAC,IAAA,eAAM,EAA2D,eAAO,CAAC,CAAC;KAC/E,IAAI,CACH,IAAA,qBAAY,EACV,SAAS,EACT,WAAW,EACX,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,GAAG,IAAA,4BAAkB,EAAC,QAAQ,CAAC,MAAM,CACxD,CACF;KACA,IAAI,CACH,IAAA,kBAAS,EACP,CAAC,EAAE,gBAAgB,EAAE,QAAQ,EAAE,EAAE,EAAE,CACjC,IAAA,4BAAkB,EAAC,QAAQ,CAAC,KAAK,MAAM;IACrC,CAAC,CAAC;QACE,CAAC,QAAQ,CAAC,EAAE;YACV,MAAM,EAAE,IAAA,yBAAiB,EAAC,QAAQ,CAAC;YACnC,UAAU,EAAE,gBAAgB;YAC5B,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC7D;KACF;IACH,CAAC,CAAC;QACE,CAAC,QAAQ,CAAC,EAAE,gBAAgB;KAC7B,EACP,IAAA,eAAM,EAAC,QAAQ,EAAE,cAAc,CAAC,CACjC,CACF;KACA,IAAI,CAAC,CAAC,GAA+B,EAAE,EAAE;IACxC,MAAM,YAAY,GAAa,EAAE,CAAA;IACjC,MAAM,OAAO,GAAG,IAAA,4BAAkB,EAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IAChD,MAAM,QAAQ,GAAG,IAAA,yBAAiB,EAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IAEhD,YAAY,CAAC,IAAI,CAAC,eAAe,OAAO,EAAE,CAAC,CAAA;IAE3C,IAAI,OAAO,KAAK,MAAM,EAAE;QACtB,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;KAC1B;IAED,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAE3B,IAAI,GAAG,CAAC,YAAY,EAAE;QACpB,OAAO;YACL,GAAG,GAAG;YACN,YAAY,EAAE,CAAC,GAAG,GAAG,CAAC,YAAY,EAAE,GAAG,YAAY,CAAC;SACrD,CAAA;KACF;IAED,OAAO,IAAA,gBAAO,EAA6B,IAAA,qBAAW,EAAC,YAAY,EAAE,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AACpG,CAAC,CAAC,CAAA;AAhDO,QAAA,QAAQ,YAgDf"}

package/lib/connection/index.ts

@@ -0,0 +1,109 @@
+import { generator, runGenerator, prompt, install, mergeJSON, toFile } from '@feathershq/pinion'
+import chalk from 'chalk'
+import { FeathersBaseContext, DatabaseType, getDatabaseAdapter, addVersions } from '../commons'
+
+export interface ConnectionGeneratorContext extends FeathersBaseContext {
+  database: DatabaseType
+  connectionString: string
+  dependencies: string[]
+}
+
+export type ConnectionGeneratorArguments = FeathersBaseContext &
+  Partial<Pick<ConnectionGeneratorContext, 'database' | 'connectionString'>>
+
+export const defaultConnectionString = (type: DatabaseType, name: string) => {
+  const connectionStrings = {
+    mongodb: `mongodb://localhost:27017/${name}`,
+    mysql: `mysql://root:@localhost:3306/${name}`,
+    postgresql: `postgres://postgres:@localhost:5432/${name}`,
+    sqlite: `${name}.sqlite`,
+    mssql: `mssql://root:password@localhost:1433/${name}`
+  }
+
+  return connectionStrings[type]
+}
+
+export const prompts = ({ database, connectionString, pkg }: ConnectionGeneratorArguments) => [
+  {
+    name: 'database',
+    type: 'list',
+    when: !database,
+    message: 'Which database are you connecting to?',
+    suffix: chalk.grey(' Other databases can be added at any time'),
+    choices: [
+      { value: 'sqlite', name: 'SQLite' },
+      { value: 'mongodb', name: 'MongoDB' },
+      { value: 'postgresql', name: 'PostgreSQL' },
+      { value: 'mysql', name: 'MySQL/MariaDB' },
+      { value: 'mssql', name: 'Microsoft SQL' }
+    ]
+  },
+  {
+    name: 'connectionString',
+    type: 'input',
+    when: !connectionString,
+    message: 'Enter your database connection string',
+    default: (answers: { name?: string; database: DatabaseType }) =>
+      defaultConnectionString(answers.database, answers.name || pkg.name)
+  }
+]
+
+export const DATABASE_CLIENTS = {
+  mongodb: 'mongodb',
+  sqlite: 'sqlite3',
+  postgresql: 'pg',
+  mysql: 'mysql',
+  mssql: 'tedious'
+}
+
+export const getDatabaseClient = (database: DatabaseType) => DATABASE_CLIENTS[database]
+
+export const generate = (ctx: ConnectionGeneratorArguments) =>
+  generator(ctx)
+    .then(prompt<ConnectionGeneratorArguments, ConnectionGeneratorContext>(prompts))
+    .then(
+      runGenerator<ConnectionGeneratorContext>(
+        __dirname,
+        'templates',
+        ({ database }) => `${getDatabaseAdapter(database)}.tpl`
+      )
+    )
+    .then(
+      mergeJSON<ConnectionGeneratorContext>(
+        ({ connectionString, database }) =>
+          getDatabaseAdapter(database) === 'knex'
+            ? {
+                [database]: {
+                  client: getDatabaseClient(database),
+                  connection: connectionString,
+                  ...(database === 'sqlite' ? { useNullAsDefault: true } : {})
+                }
+              }
+            : {
+                [database]: connectionString
+              },
+        toFile('config', 'default.json')
+      )
+    )
+    .then((ctx: ConnectionGeneratorContext) => {
+      const dependencies: string[] = []
+      const adapter = getDatabaseAdapter(ctx.database)
+      const dbClient = getDatabaseClient(ctx.database)
+
+      dependencies.push(`@feathersjs/${adapter}`)
+
+      if (adapter === 'knex') {
+        dependencies.push('knex')
+      }
+
+      dependencies.push(dbClient)
+
+      if (ctx.dependencies) {
+        return {
+          ...ctx,
+          dependencies: [...ctx.dependencies, ...dependencies]
+        }
+      }
+
+      return install<ConnectionGeneratorContext>(addVersions(dependencies, ctx.dependencyVersions))(ctx)
+    })

package/lib/connection/templates/knex.tpl.d.ts

@@ -0,0 +1,2 @@
+import { ConnectionGeneratorContext } from '../index';
+export declare const generate: (ctx: ConnectionGeneratorContext) => Promise<ConnectionGeneratorContext>;

package/lib/connection/templates/knex.tpl.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generate = void 0;
+const pinion_1 = require("@feathershq/pinion");
+const commons_1 = require("../../commons");
+const template = ({ database }) => `import knex from 'knex'
+import type { Knex } from 'knex'
+import type { Application } from './declarations'
+
+declare module './declarations' {
+  interface Configuration {
+    ${database}Client: Knex
+  }
+}
+
+export const ${database} = (app: Application) => {
+  const config = app.get('${database}')
+  const db = knex(config!)
+
+  app.set('${database}Client', db);
+}
+`;
+const knexfile = ({ lib, language, database }) => `
+import { app } from './${lib}/app'
+
+// Load our database connection info from the app configuration
+const config = app.get('${database}')
+
+${language === 'js' ? 'export default config' : 'module.exports = config'}
+`;
+const configurationTemplate = ({ database }) => `    ${database}: {
+    type: 'object',
+    properties: {
+      client: { type: 'string' },
+      connection: { type: 'string' }
+    }
+  },`;
+const importTemplate = ({ database }) => `import { ${database} } from './${database}'`;
+const configureTemplate = ({ database }) => `app.configure(${database})`;
+const toAppFile = (0, pinion_1.toFile)(({ lib, language }) => [lib, `app.${language}`]);
+const generate = (ctx) => (0, pinion_1.generator)(ctx)
+    .then((0, commons_1.renderSource)(template, (0, pinion_1.toFile)(({ lib, database }) => [lib, database])))
+    .then((0, commons_1.renderSource)(knexfile, (0, pinion_1.toFile)('knexfile')))
+    .then((0, pinion_1.mergeJSON)({
+    scripts: {
+        migrate: 'knex migrate:latest',
+        'migrate:create': 'knex migrate:create',
+        test: 'cross-env NODE_ENV=test npm run migrate && npm run mocha'
+    }
+}, (0, pinion_1.toFile)('package.json')))
+    .then((0, pinion_1.inject)(configurationTemplate, (0, pinion_1.before)('authentication: authenticationSettingsSchema'), (0, pinion_1.toFile)(({ lib, language }) => [
+    lib,
+    'schemas',
+    `configuration.schema.${language}`
+])))
+    .then((0, pinion_1.inject)((0, commons_1.getSource)(importTemplate), (0, pinion_1.before)('import { services } from'), toAppFile))
+    .then((0, pinion_1.inject)((0, commons_1.getSource)(configureTemplate), (0, pinion_1.before)('app.configure(services)'), toAppFile));
+exports.generate = generate;
+//# sourceMappingURL=knex.tpl.js.map

package/lib/connection/templates/knex.tpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"knex.tpl.js","sourceRoot":"","sources":["../../../src/connection/templates/knex.tpl.ts"],"names":[],"mappings":";;;AAAA,+CAAiF;AAEjF,2CAAuD;AAEvD,MAAM,QAAQ,GAAG,CAAC,EAAE,QAAQ,EAA8B,EAAE,EAAE,CAC5D;;;;;;MAMI,QAAQ;;;;eAIC,QAAQ;4BACK,QAAQ;;;aAGvB,QAAQ;;CAEpB,CAAA;AAED,MAAM,QAAQ,GAAG,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAA8B,EAAE,EAAE,CAAC;yBACrD,GAAG;;;0BAGF,QAAQ;;EAEhC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,yBAAyB;CACxE,CAAA;AAED,MAAM,qBAAqB,GAAG,CAAC,EAAE,QAAQ,EAA8B,EAAE,EAAE,CAAC,OAAO,QAAQ;;;;;;KAMtF,CAAA;AAEL,MAAM,cAAc,GAAG,CAAC,EAAE,QAAQ,EAA8B,EAAE,EAAE,CAClE,YAAY,QAAQ,cAAc,QAAQ,GAAG,CAAA;AAC/C,MAAM,iBAAiB,GAAG,CAAC,EAAE,QAAQ,EAA8B,EAAE,EAAE,CAAC,iBAAiB,QAAQ,GAAG,CAAA;AACpG,MAAM,SAAS,GAAG,IAAA,eAAM,EAA6B,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,OAAO,QAAQ,EAAE,CAAC,CAAC,CAAA;AAE9F,MAAM,QAAQ,GAAG,CAAC,GAA+B,EAAE,EAAE,CAC1D,IAAA,kBAAS,EAAC,GAAG,CAAC;KACX,IAAI,CACH,IAAA,sBAAY,EACV,QAAQ,EACR,IAAA,eAAM,EAA6B,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAC3E,CACF;KACA,IAAI,CAAC,IAAA,sBAAY,EAAC,QAAQ,EAAE,IAAA,eAAM,EAAC,UAAU,CAAC,CAAC,CAAC;KAChD,IAAI,CACH,IAAA,kBAAS,EACP;IACE,OAAO,EAAE;QACP,OAAO,EAAE,qBAAqB;QAC9B,gBAAgB,EAAE,qBAAqB;QACvC,IAAI,EAAE,0DAA0D;KACjE;CACF,EACD,IAAA,eAAM,EAAC,cAAc,CAAC,CACvB,CACF;KACA,IAAI,CACH,IAAA,eAAM,EACJ,qBAAqB,EACrB,IAAA,eAAM,EAAC,8CAA8C,CAAC,EACtD,IAAA,eAAM,EAA6B,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IACxD,GAAG;IACH,SAAS;IACT,wBAAwB,QAAQ,EAAE;CACnC,CAAC,CACH,CACF;KACA,IAAI,CAAC,IAAA,eAAM,EAAC,IAAA,mBAAS,EAAC,cAAc,CAAC,EAAE,IAAA,eAAM,EAAC,0BAA0B,CAAC,EAAE,SAAS,CAAC,CAAC;KACtF,IAAI,CAAC,IAAA,eAAM,EAAC,IAAA,mBAAS,EAAC,iBAAiB,CAAC,EAAE,IAAA,eAAM,EAAC,yBAAyB,CAAC,EAAE,SAAS,CAAC,CAAC,CAAA;AAjChF,QAAA,QAAQ,YAiCwE"}