@feathersjs/generators 5.0.0-pre.35

package/lib/commons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commons.js","sourceRoot":"","sources":["../src/commons.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAmB;AACnB,+BAA2B;AAE3B,0CAAiD;AACjD,+CAS2B;AAC3B,+CAAgC;AAChC,wDAA+D;AAC/D,gDAAuB;AAER,eAAO,GAAK,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,SAAA;AASxG;;;;;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;AA8D3G;;;;;;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;QACzB,iBAAiB,EAAE,eAAO;KAC3B;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;AApBI,QAAA,qBAAqB,yBAoBzB;AAET;;;;;;GAMG;AACI,MAAM,kBAAkB,GAC7B,GAAG,EAAE,CACL,KAAK,EAAiC,GAAM,EAAE,EAAE;IAC9C,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC;;CAErB,CAAC,CAAA;KACG;IAED,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAVU,QAAA,kBAAkB,sBAU5B;AAEH,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;IAEF,OAAO,eAAe,CAAC,eAAe,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAA;AAChE,CAAC,CAAA;AAbY,QAAA,aAAa,iBAazB;AAED,MAAM,WAAW,GAAG,KAAK,EACvB,MAA2B,EAC3B,GAAM,EACN,EAAE,CAAC,GAAG,MAAM,IAAA,oBAAW,EAAC,MAAM,EAAE,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAA;AAExD;;GAEG;AACU,QAAA,UAAU,GAAoB;IACzC,QAAQ,EAAE,CAAC;IACX,OAAO,EAAE,KAAK;IACd,UAAU,EAAE,GAAG;IACf,IAAI,EAAE,KAAK;IACX,aAAa,EAAE,MAAM;IACrB,WAAW,EAAE,IAAI;CAClB,CAAA;AAED;;;;;;;GAOG;AACI,MAAM,QAAQ,GACnB,CACE,MAA2B,EAC3B,UAA2B,kBAAU,EACrC,EAAE,CACJ,KAAK,EAAE,GAAM,EAAE,EAAE;IACf,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC/C,MAAM,MAAM,GAAG,CAAC,MAAM,kBAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,OAAO,CAAA;IACjE,MAAM,OAAO,GAAG,CAAC,MAAM,IAAA,mBAAQ,EAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;IAErD,IAAI;QACF,MAAM,IAAA,oBAAS,EACb,QAAQ,EACR,MAAM,kBAAQ,CAAC,MAAM,CAAC,OAAO,EAAE;YAC7B,MAAM,EAAE,GAAG,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO;YACtD,GAAG,MAAM;SACV,CAAC,CACH,CAAA;KACF;IAAC,OAAO,KAAU,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,qBAAqB,QAAQ,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;KACnE;IAED,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAvBU,QAAA,QAAQ,YAuBlB;AAEH;;;;;;GAMG;AACI,MAAM,YAAY,GACvB,CACE,QAA6B,EAC7B,MAA2B,EAC3B,OAA4B,EAC5B,EAAE,CACJ,KAAK,EAAE,GAAM,EAAE,EAAE;IACf,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAA;IACxB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC/C,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,QAAQ,EAAE,OAAO,CAAC,CAAA;IAE3D,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAA,gBAAQ,EAAC,MAAM,CAAC,CAAC,CAAA;AAC7C,CAAC,CAAA;AAbU,QAAA,YAAY,gBAatB;AAEH;;;;;;;;GAQG;AACI,MAAM,YAAY,GACvB,CACE,QAA6B,EAC7B,QAAqB,EACrB,MAA2B,EAC3B,SAAS,GAAG,IAAI,EAChB,EAAE,CACJ,KAAK,EAAE,GAAM,EAAE,EAAE;IACf,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAA;IACxB,MAAM,MAAM,GACV,QAAQ,KAAK,IAAI,IAAI,SAAS,CAAC,CAAC,CAAC,IAAA,qBAAa,EAAC,MAAM,IAAA,oBAAW,EAAY,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAA;IACxG,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC/C,MAAM,QAAQ,GAAG,IAAA,eAAM,EAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEnD,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAA,gBAAQ,EAAC,MAAM,CAAC,CAAC,CAAA;AAC7C,CAAC,CAAA;AAfU,QAAA,YAAY,gBAetB;AAEH;;;;;GAKG;AACI,MAAM,UAAU,GAAG,CAAC,GAAG,SAAmB,EAAE,EAAE,CAAC,YAAE,CAAC,UAAU,CAAC,IAAA,WAAI,EAAC,GAAG,SAAS,CAAC,CAAC,CAAA;AAA1E,QAAA,UAAU,cAAgE"}

package/lib/commons.ts

@@ -0,0 +1,284 @@
+import fs from 'fs'
+import { join } from 'path'
+import { PackageJson } from 'type-fest'
+import { readFile, writeFile } from 'fs/promises'
+import {
+  Callable,
+  PinionContext,
+  loadJSON,
+  fromFile,
+  getCallable,
+  renderTemplate,
+  inject,
+  Location
+} from '@feathershq/pinion'
+import * as ts from 'typescript'
+import prettier, { Options as PrettierOptions } from 'prettier'
+import path from 'path'
+
+export const { version } = JSON.parse(fs.readFileSync(join(__dirname, '..', 'package.json')).toString())
+
+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'
+  /**
+   * The main schema definition format
+   */
+  schema: 'typebox' | 'json'
+}
+
+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,
+            '@feathersjs/cli': version
+          }
+        }))
+      )
+      .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
+      }))
+
+/**
+ * Checks if the current context contains a valid generated application. This is necesary for most
+ * generators (besides the app generator).
+ *
+ * @param ctx The context to check against
+ * @returns Throws an error or returns the original context
+ */
+export const checkPreconditions =
+  () =>
+  async <T extends FeathersBaseContext>(ctx: T) => {
+    if (!ctx.feathers) {
+      throw new Error(`Can not run generator since the current folder does not appear to be a Feathers application.
+Either your package.json is missing or it does not have \`feathers\` property.
+`)
+    }
+
+    return ctx
+  }
+
+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
+    }
+  })
+
+  return fixLocalImports(restoreNewLines(transpiled.outputText))
+}
+
+const getFileName = async <C extends PinionContext & { language: 'js' | 'ts' }>(
+  target: Callable<string, C>,
+  ctx: C
+) => `${await getCallable(target, ctx)}.${ctx.language}`
+
+/**
+ * The default configuration for prettifying files
+ */
+export const PRETTIERRC: PrettierOptions = {
+  tabWidth: 2,
+  useTabs: false,
+  printWidth: 110,
+  semi: false,
+  trailingComma: 'none',
+  singleQuote: true
+}
+
+/*
+ * Format a source file using Prettier. Will use the local configuration, the settings set in
+ * `options` or a default configuration
+ *
+ * @param target The file to prettify
+ * @param options The Prettier options
+ * @returns The updated context
+ */
+export const prettify =
+  <C extends PinionContext & { language: 'js' | 'ts' }>(
+    target: Callable<string, C>,
+    options: PrettierOptions = PRETTIERRC
+  ) =>
+  async (ctx: C) => {
+    const fileName = await getFileName(target, ctx)
+    const config = (await prettier.resolveConfig(ctx.cwd)) || options
+    const content = (await readFile(fileName)).toString()
+
+    try {
+      await writeFile(
+        fileName,
+        await prettier.format(content, {
+          parser: ctx.language === 'ts' ? 'typescript' : 'babel',
+          ...config
+        })
+      )
+    } catch (error: any) {
+      throw new Error(`Error prettifying ${fileName}: ${error.message}`)
+    }
+
+    return ctx
+  }
+
+/**
+ * Render a source file template for the language set in the context.
+ *
+ * @param templates The JavaScript and TypeScript template to render
+ * @param target 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>,
+    target: Callable<string, C>,
+    options?: { force: boolean }
+  ) =>
+  async (ctx: C) => {
+    const { language } = ctx
+    const fileName = await getFileName(target, ctx)
+    const content = language === 'js' ? getJavaScript(await getCallable<string, C>(template, ctx)) : template
+    const renderer = renderTemplate(content, fileName, options)
+
+    return renderer(ctx).then(prettify(target))
+  }
+
+/**
+ * Inject a source template as the language set in the context.
+ *
+ * @param template The source template to render
+ * @param location The location to inject the code to. Must use the target language.
+ * @param target The target file name
+ * @param transpile Set to `false` if the code should not be transpiled to JavaScript
+ * @returns
+ */
+export const injectSource =
+  <C extends PinionContext & { language: 'js' | 'ts' }>(
+    template: Callable<string, C>,
+    location: Location<C>,
+    target: Callable<string, C>,
+    transpile = true
+  ) =>
+  async (ctx: C) => {
+    const { language } = ctx
+    const source =
+      language === 'js' && transpile ? getJavaScript(await getCallable<string, C>(template, ctx)) : template
+    const fileName = await getFileName(target, ctx)
+    const injector = inject(source, location, fileName)
+
+    return injector(ctx).then(prettify(target))
+  }
+
+/**
+ * Synchronously checks if a file exits
+ * @param context The base context
+ * @param filenames The filenames to check
+ * @returns Wether the file exists or not
+ */
+export const fileExists = (...filenames: string[]) => fs.existsSync(join(...filenames))

package/lib/connection/index.d.ts

@@ -0,0 +1,55 @@
+import { FeathersBaseContext, DatabaseType } from '../commons';
+export interface ConnectionGeneratorContext extends FeathersBaseContext {
+    name?: string;
+    database: DatabaseType;
+    connectionString: string;
+    dependencies: string[];
+}
+export type ConnectionGeneratorArguments = FeathersBaseContext & Partial<Pick<ConnectionGeneratorContext, 'database' | 'connectionString' | 'name'>>;
+export declare const defaultConnectionString: (type: DatabaseType, name: string) => string;
+export declare const prompts: ({ database, connectionString, pkg, name }: 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[];
+    name?: string;
+    database: DatabaseType;
+    connectionString: string;
+    feathers: import("../commons").FeathersAppInfo;
+    pkg: import("../commons").AppPackageJson;
+    lib: string;
+    test: string;
+    language: "ts" | "js";
+    dependencyVersions?: import("../commons").DependencyVersions;
+    cwd: string;
+    _?: (string | number)[];
+    pinion: import("@feathershq/pinion").Configuration;
+}>;

package/lib/connection/index.js

@@ -0,0 +1,88 @@
+"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://127.0.0.1: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 }) => [
+    {
+        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 || name || pkg.name)
+    }
+];
+exports.prompts = prompts;
+exports.DATABASE_CLIENTS = {
+    mongodb: 'mongodb',
+    sqlite: 'sqlite3',
+    postgresql: 'pg',
+    mysql: 'mysql',
+    mssql: 'mssql'
+};
+const getDatabaseClient = (database) => exports.DATABASE_CLIENTS[database];
+exports.getDatabaseClient = getDatabaseClient;
+const generate = (ctx) => (0, pinion_1.generator)(ctx)
+    .then((0, commons_1.initializeBaseContext)())
+    .then((0, commons_1.checkPreconditions)())
+    .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), false, ctx.feathers.packager)(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,wCAOmB;AAYZ,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,EAAE,IAAI,EAAgC,EAAE,EAAE,CAAC;IAClG;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,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC;KAC9E;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,OAAO;CACf,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,+BAAqB,GAAE,CAAC;KAC7B,IAAI,CAAC,IAAA,4BAAkB,GAAE,CAAC;KAC1B,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,EACZ,IAAA,qBAAW,EAAC,YAAY,EAAE,GAAG,CAAC,kBAAkB,CAAC,EACjD,KAAK,EACL,GAAG,CAAC,QAAQ,CAAC,QAAQ,CACtB,CAAC,GAAG,CAAC,CAAA;AACR,CAAC,CAAC,CAAA;AAtDO,QAAA,QAAQ,YAsDf"}

package/lib/connection/index.ts

@@ -0,0 +1,123 @@
+import { generator, runGenerator, prompt, install, mergeJSON, toFile } from '@feathershq/pinion'
+import chalk from 'chalk'
+import {
+  FeathersBaseContext,
+  DatabaseType,
+  getDatabaseAdapter,
+  addVersions,
+  checkPreconditions,
+  initializeBaseContext
+} from '../commons'
+
+export interface ConnectionGeneratorContext extends FeathersBaseContext {
+  name?: string
+  database: DatabaseType
+  connectionString: string
+  dependencies: string[]
+}
+
+export type ConnectionGeneratorArguments = FeathersBaseContext &
+  Partial<Pick<ConnectionGeneratorContext, 'database' | 'connectionString' | 'name'>>
+
+export const defaultConnectionString = (type: DatabaseType, name: string) => {
+  const connectionStrings = {
+    mongodb: `mongodb://127.0.0.1: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, name }: 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 || name || pkg.name)
+  }
+]
+
+export const DATABASE_CLIENTS = {
+  mongodb: 'mongodb',
+  sqlite: 'sqlite3',
+  postgresql: 'pg',
+  mysql: 'mysql',
+  mssql: 'mssql'
+}
+
+export const getDatabaseClient = (database: DatabaseType) => DATABASE_CLIENTS[database]
+
+export const generate = (ctx: ConnectionGeneratorArguments) =>
+  generator(ctx)
+    .then(initializeBaseContext())
+    .then(checkPreconditions())
+    .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),
+        false,
+        ctx.feathers.packager
+      )(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,48 @@
+"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 }) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/databases.html
+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 }) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/databases.html
+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 importTemplate = ({ database }) => `import { ${database} } from './${database}'`;
+const configureTemplate = ({ database }) => `app.configure(${database})`;
+const toAppFile = (0, pinion_1.toFile)(({ lib }) => [lib, 'app']);
+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:make': 'knex migrate:make',
+        test: 'cross-env NODE_ENV=test npm run migrate && npm run mocha'
+    }
+}, (0, pinion_1.toFile)('package.json')))
+    .then((0, commons_1.injectSource)(importTemplate, (0, pinion_1.before)('import { services } from'), toAppFile))
+    .then((0, commons_1.injectSource)(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,+CAAyE;AAEzE,2CAA0D;AAE1D,MAAM,QAAQ,GAAG,CAAC,EAChB,QAAQ,EACmB,EAAE,EAAE,CAAC,QAAQ,CAAC;;;;;;;MAOrC,QAAQ;;;;eAIC,QAAQ;4BACK,QAAQ;;;aAGvB,QAAQ;;CAEpB,CAAA;AAED,MAAM,QAAQ,GAAG,CAAC,EAChB,GAAG,EACH,QAAQ,EACR,QAAQ,EACmB,EAAE,EAAE,CAAC,QAAQ,CAAC;yBAClB,GAAG;;;0BAGF,QAAQ;;EAEhC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,yBAAyB;CACxE,CAAA;AAED,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;AAEpG,MAAM,SAAS,GAAG,IAAA,eAAM,EAA6B,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAA;AAExE,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,cAAc,EAAE,mBAAmB;QACnC,IAAI,EAAE,0DAA0D;KACjE;CACF,EACD,IAAA,eAAM,EAAC,cAAc,CAAC,CACvB,CACF;KACA,IAAI,CAAC,IAAA,sBAAY,EAAC,cAAc,EAAE,IAAA,eAAM,EAAC,0BAA0B,CAAC,EAAE,SAAS,CAAC,CAAC;KACjF,IAAI,CAAC,IAAA,sBAAY,EAAC,iBAAiB,EAAE,IAAA,eAAM,EAAC,yBAAyB,CAAC,EAAE,SAAS,CAAC,CAAC,CAAA;AAtB3E,QAAA,QAAQ,YAsBmE"}