@feathersjs/generators 5.0.27 → 5.0.29

package/lib/app/templates/app.tpl.ts

@@ -1,141 +0,0 @@
-import { toFile } from '@featherscloud/pinion'
-import { renderSource } from '../../commons.js'
-import { AppGeneratorContext } from '../index.js'
-
-const tsKoaApp = ({
-  transports,
-  schema
-}: AppGeneratorContext) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/application.html
-import { feathers } from '@feathersjs/feathers'
-import configuration from '@feathersjs/configuration'
-import {
-  koa, rest, bodyParser, errorHandler, parseAuthentication, cors, serveStatic
-} from '@feathersjs/koa'
-${transports.includes('websockets') ? "import socketio from '@feathersjs/socketio'" : ''}
-
-${schema !== false ? `import { configurationValidator } from './configuration'` : ''}
-import type { Application } from './declarations'
-import { logError } from './hooks/log-error'
-import { services } from './services/index'
-${transports.includes('websockets') ? `import { channels } from './channels'` : ''}
-
-const app: Application = koa(feathers())
-
-// Load our app configuration (see config/ folder)
-app.configure(configuration(${schema !== false ? 'configurationValidator' : ''}))
-
-// Set up Koa middleware
-app.use(cors())
-app.use(serveStatic(app.get('public')))
-app.use(errorHandler())
-app.use(parseAuthentication())
-app.use(bodyParser())
-
-// Configure services and transports
-app.configure(rest())
-${
-  transports.includes('websockets')
-    ? `app.configure(socketio({
-  cors: {
-    origin: app.get('origins')
-  }
-}))`
-    : ''
-}
-app.configure(services)
-${transports.includes('websockets') ? 'app.configure(channels)' : ''}
-
-
-// Register hooks that run on all service methods
-app.hooks({
-  around: {
-    all: [ logError ]
-  },
-  before: {},
-  after: {},
-  error: {}
-})
-// Register application setup and teardown hooks here
-app.hooks({
-  setup: [],
-  teardown: []
-})
-
-export { app }
-`
-
-const tsExpressApp = ({
-  transports,
-  schema
-}: AppGeneratorContext) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/application.html
-import { feathers } from '@feathersjs/feathers'
-import express, {
-  rest, json, urlencoded, cors,
-  serveStatic, notFound, errorHandler
-} from '@feathersjs/express'
-import configuration from '@feathersjs/configuration'
-${transports.includes('websockets') ? "import socketio from '@feathersjs/socketio'" : ''}
-
-import type { Application } from './declarations'
-${schema !== false ? `import { configurationValidator } from './configuration'` : ''}
-import { logger } from './logger'
-import { logError } from './hooks/log-error'
-import { services } from './services/index'
-${transports.includes('websockets') ? `import { channels } from './channels'` : ''}
-
-const app: Application = express(feathers())
-
-// Load app configuration
-app.configure(configuration(${schema !== false ? 'configurationValidator' : ''}))
-app.use(cors())
-app.use(json())
-app.use(urlencoded({ extended: true }))
-// Host the public folder
-app.use('/', serveStatic(app.get('public')))
-
-// Configure services and real-time functionality
-app.configure(rest())
-${
-  transports.includes('websockets')
-    ? `app.configure(socketio({
-  cors: {
-    origin: app.get('origins')
-  }
-}))`
-    : ''
-}
-app.configure(services)
-${transports.includes('websockets') ? 'app.configure(channels)' : ''}
-
-// Configure a middleware for 404s and the error handler
-app.use(notFound())
-app.use(errorHandler({ logger }))
-
-// Register hooks that run on all service methods
-app.hooks({
-  around: {
-    all: [ logError ]
-  },
-  before: {},
-  after: {},
-  error: {}
-})
-// Register application setup and teardown hooks here
-app.hooks({
-  setup: [],
-  teardown: []
-})
-
-export { app }
-`
-
-const template = (ctx: AppGeneratorContext) =>
-  ctx.framework === 'express' ? tsExpressApp(ctx) : tsKoaApp(ctx)
-
-export const generate = (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    renderSource(
-      template,
-      toFile<AppGeneratorContext>(({ lib }) => lib, 'app')
-    )
-  )

package/lib/app/templates/channels.tpl.ts

@@ -1,54 +0,0 @@
-import { toFile, when } from '@featherscloud/pinion'
-import { renderSource } from '../../commons.js'
-import { AppGeneratorContext } from '../index.js'
-
-const template = ({
-  language
-}: AppGeneratorContext) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/channels.html
-import type { RealTimeConnection, Params } from '@feathersjs/feathers'
-import type { AuthenticationResult } from '@feathersjs/authentication'
-import '@feathersjs/transport-commons'
-import type { Application, HookContext } from './declarations'
-import { logger } from './logger'
-
-export const channels = (app: Application) => {
-  logger.warn('Publishing all events to all authenticated users. See \`channels.${language}\` and https://dove.feathersjs.com/api/channels.html for more information.')
-
-  app.on('connection', (connection: RealTimeConnection) => {
-    // On a new real-time connection, add it to the anonymous channel
-    app.channel('anonymous').join(connection)
-  })
-
-  app.on('login', (authResult: AuthenticationResult, { connection }: Params) => {
-    // connection can be undefined if there is no
-    // real-time connection, e.g. when logging in via REST
-    if(connection) {
-      // The connection is no longer anonymous, remove it
-      app.channel('anonymous').leave(connection)
-
-      // Add it to the authenticated user channel
-      app.channel('authenticated').join(connection)
-    }
-  })
-
-  // eslint-disable-next-line no-unused-vars
-  app.publish((data: any, context: HookContext) => {
-    // Here you can add event publishers to channels set up in \`channels.js\`
-    // To publish only for a specific event use \`app.publish(eventname, () => {})\`
-
-    // e.g. to publish all service events to all authenticated users use
-    return app.channel('authenticated')
-  })
-}
-`
-
-export const generate = (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    when<AppGeneratorContext>(
-      ({ transports }) => transports.includes('websockets'),
-      renderSource(
-        template,
-        toFile<AppGeneratorContext>(({ lib }) => lib, 'channels')
-      )
-    )
-  )

package/lib/app/templates/client.test.tpl.ts

@@ -1,28 +0,0 @@
-import { toFile, when } from '@featherscloud/pinion'
-import { renderSource } from '../../commons.js'
-import { AppGeneratorContext } from '../index.js'
-
-const template = ({ lib }: AppGeneratorContext) => /* ts */ `import assert from 'assert'
-import axios from 'axios'
-import type { Server } from 'http'
-import { app } from '../${lib}/app'
-import { createClient } from '../${lib}/client' 
-
-import rest from '@feathersjs/rest-client'
-
-const port = app.get('port')
-const appUrl = \`http://\${app.get('host')}:\${port}\`
-
-describe('client tests', () => {
-  const client = createClient(rest(appUrl).axios(axios))
-
-  it('initialized the client', () => {
-    assert.ok(client)
-  })
-})
-`
-
-export const generate = (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    when<AppGeneratorContext>((ctx) => ctx.client, renderSource(template, toFile('test', 'client.test')))
-  )

package/lib/app/templates/client.tpl.ts

@@ -1,53 +0,0 @@
-import { toFile, when } from '@featherscloud/pinion'
-import { renderSource } from '../../commons.js'
-import { AppGeneratorContext } from '../index.js'
-
-const template = ({
-  name,
-  language
-}: AppGeneratorContext) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/client.html
-import { feathers } from '@feathersjs/feathers'
-import type { TransportConnection, Application } from '@feathersjs/feathers'
-import authenticationClient from '@feathersjs/authentication-client'
-import type { AuthenticationClientOptions } from '@feathersjs/authentication-client'
-
-export interface Configuration {
-  connection: TransportConnection<ServiceTypes>
-}
-
-export interface ServiceTypes {}
-
-export type ClientApplication = Application<ServiceTypes, Configuration>
-
-/**
- * Returns a ${language === 'ts' ? 'typed' : ''} client for the ${name} app.
- * 
- * @param connection The REST or Socket.io Feathers client connection
- * @param authenticationOptions Additional settings for the authentication client
- * @see https://dove.feathersjs.com/api/client.html
- * @returns The Feathers client application
- */
-export const createClient = <Configuration = any> (
-  connection: TransportConnection<ServiceTypes>,
-  authenticationOptions: Partial<AuthenticationClientOptions> = {}
-) => {
-  const client: ClientApplication = feathers()
-
-  client.configure(connection)
-  client.configure(authenticationClient(authenticationOptions))
-  client.set('connection', connection)
-
-  return client
-}
-`
-
-export const generate = async (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    when<AppGeneratorContext>(
-      (ctx) => ctx.client,
-      renderSource(
-        template,
-        toFile<AppGeneratorContext>(({ lib }) => lib, 'client')
-      )
-    )
-  )

package/lib/app/templates/configuration.tpl.ts

@@ -1,89 +0,0 @@
-import { toFile, when, writeJSON } from '@featherscloud/pinion'
-import { renderSource } from '../../commons.js'
-import { AppGeneratorContext } from '../index.js'
-
-const defaultConfig = ({}: AppGeneratorContext) => ({
-  host: 'localhost',
-  port: 3030,
-  public: './public/',
-  origins: ['http://localhost:3030'],
-  paginate: {
-    default: 10,
-    max: 50
-  }
-})
-
-const customEnvironment = {
-  port: {
-    __name: 'PORT',
-    __format: 'number'
-  },
-  host: 'HOSTNAME',
-  authentication: {
-    secret: 'FEATHERS_SECRET'
-  }
-}
-
-const testConfig = {
-  port: 8998
-}
-
-const configurationJsonTemplate =
-  ({}: AppGeneratorContext) => `import { defaultAppSettings, getValidator } from '@feathersjs/schema'
-import type { FromSchema } from '@feathersjs/schema'
-
-import { dataValidator } from './validators'
-
-export const configurationSchema = {
-  $id: 'configuration',
-  type: 'object',
-  additionalProperties: false,
-  required: [ 'host', 'port', 'public' ],
-  properties: {
-    ...defaultAppSettings,
-    host: { type: 'string' },
-    port: { type: 'number' },
-    public: { type: 'string' }
-  }
-} as const
-
-export const configurationValidator = getValidator(configurationSchema, dataValidator)
-
-export type ApplicationConfiguration = FromSchema<typeof configurationSchema>
-`
-
-const configurationTypeboxTemplate =
-  ({}: AppGeneratorContext) => `import { Type, getValidator, defaultAppConfiguration } from '@feathersjs/typebox'
-import type { Static } from '@feathersjs/typebox'
-
-import { dataValidator } from './validators'
-
-export const configurationSchema = Type.Intersect([
-  defaultAppConfiguration,
-  Type.Object({
-    host: Type.String(),
-    port: Type.Number(),
-    public: Type.String()
-  })
-])
-
-export type ApplicationConfiguration = Static<typeof configurationSchema>
-
-export const configurationValidator = getValidator(configurationSchema, dataValidator)
-`
-
-export const generate = (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx)
-    .then(writeJSON(defaultConfig, toFile('config', 'default.json')))
-    .then(writeJSON(testConfig, toFile('config', 'test.json')))
-    .then(writeJSON(customEnvironment, toFile('config', 'custom-environment-variables.json')))
-    .then(
-      when<AppGeneratorContext>(
-        (ctx) => ctx.schema !== false,
-        renderSource(
-          async (ctx) =>
-            ctx.schema === 'typebox' ? configurationTypeboxTemplate(ctx) : configurationJsonTemplate(ctx),
-          toFile<AppGeneratorContext>(({ lib }) => lib, 'configuration')
-        )
-      )
-    )

package/lib/app/templates/declarations.tpl.ts

@@ -1,42 +0,0 @@
-import { toFile, when, renderTemplate } from '@featherscloud/pinion'
-import { AppGeneratorContext } from '../index.js'
-
-const template = ({
-  framework,
-  schema
-}: AppGeneratorContext) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/typescript.html
-import { HookContext as FeathersHookContext, NextFunction } from '@feathersjs/feathers'
-import { Application as FeathersApplication } from '@feathersjs/${framework}'
-${
-  schema === false
-    ? `type ApplicationConfiguration = any`
-    : `import { ApplicationConfiguration } from './configuration'`
-}
-
-export type { NextFunction }
-
-// The types for app.get(name) and app.set(name)
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface Configuration extends ApplicationConfiguration {}
-
-// A mapping of service names to types. Will be extended in service files.
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface ServiceTypes {}
-
-// The application instance type that will be used everywhere else
-export type Application = FeathersApplication<ServiceTypes, Configuration>
-
-// The context for hook functions - can be typed with a service class
-export type HookContext<S = any> = FeathersHookContext<Application, S>
-`
-
-export const generate = (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    when<AppGeneratorContext>(
-      ({ language }) => language === 'ts',
-      renderTemplate(
-        template,
-        toFile<AppGeneratorContext>(({ lib }) => lib, 'declarations.ts')
-      )
-    )
-  )

package/lib/app/templates/index.html.tpl.ts

@@ -1,44 +0,0 @@
-import { renderTemplate, toFile } from '@featherscloud/pinion'
-import { AppGeneratorContext } from '../index.js'
-
-const template = ({ name, description }: AppGeneratorContext) => /* html */ `<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <title>${name}</title>
-    <meta name="description" content="${description}">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-    <style>
-      * {
-        margin: 0;
-        padding: 0;
-        box-sizing: border-box;
-      }
-
-      html {
-        height: 100%;
-      }
-
-      body {
-        min-height: 100%;
-        display: flex;
-        align-items: center;
-      }
-
-      img.logo {
-        display: block;
-        margin: auto auto;
-        width: 30%;
-        max-width: 100%;
-        max-height: 100%;
-      }
-    </style>
-  </head>
-  <body>
-    <img class="logo" src="data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjUwMCIgaGVpZ2h0PSIyNTAwIiB2aWV3Qm94PSIwIDAgMjU2IDI1NiIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiBwcmVzZXJ2ZUFzcGVjdFJhdGlvPSJ4TWlkWU1pZCI+PHBhdGggZD0iTTEyOCA5LjEwMmM2NS42NjUgMCAxMTguODk4IDUzLjIzMyAxMTguODk4IDExOC44OTggMCA2NS42NjUtNTMuMjMzIDExOC44OTgtMTE4Ljg5OCAxMTguODk4QzYyLjMzNSAyNDYuODk4IDkuMTAyIDE5My42NjUgOS4xMDIgMTI4IDkuMTAyIDYyLjMzNSA2Mi4zMzUgOS4xMDIgMTI4IDkuMTAyTTEyOCAwQzU3LjQyMSAwIDAgNTcuNDIxIDAgMTI4YzAgNzAuNTc5IDU3LjQyMSAxMjggMTI4IDEyOCA3MC41NzkgMCAxMjgtNTcuNDIxIDEyOC0xMjhDMjU2IDU3LjQyMSAxOTguNTc5IDAgMTI4IDBtMjAuODMgMjUuNTI0Yy0xMC40My0xLjg5Ni0zNS42NTEgMzYuNDA5LTQzLjk5NCA1OS43MzQtLjYzNCAxLjc2OS0yLjA4NiA4LjI0OS0yLjA4NiA5Ljk1NSAwIDAgNi41MzEgMTQuMDU1IDguMzQzIDE3LjM1MS0zLjAzNC0xLjU4LTkuMzIzLTEzLjc1Ni05LjMyMy0xMy43NTYtMy4wMzQgNS43ODQtNS45NDIgMzIuMzQtNC45OTQgMzcuMjcxIDAgMCA2Ljc2MiAxMC4wNjIgOS4zODcgMTIuNTc4LTMuNjAzLTEuMjAxLTkuNjcxLTkuMzU1LTkuNjcxLTkuMzU1LTEuMTM4IDMuNTA4LS45MTYgMTAuODA3LS4zNzkgMTMuMjc0IDQuNTUxIDYuNjM3IDEwLjYxOSA3LjM5NiAxMC42MTkgNy4zOTZzLTYuNjM3IDY2LjE4MSAzLjQxMyA3MS4xMTFjNi4yNTgtMS4zMjcgNy43NzUtNzMuOTU2IDcuNzc1LTczLjk1NnM3LjU4NS41NjkgOS4yOTItMS4zMjdjMy44NTYtMi42NTUgMTIuODI2LTMwLjIyNCAxMi45NTgtMzQuMjAyIDAgMC0xMC40MSAxLjk1Mi0xNS40ODcgMy45MjQgMy44MjYtMy44IDE2LjA0OS02LjM1MiAxNi4wNDktNi4zNTIgMy4zMTUtMy45NzkgMTAuMjkxLTMxLjA0NyAxMC45OTQtMzkuMzkxLjE3Ni0yLjA5My41ODMtNC42NTcuMjY4LTguMzk4IDAgMC05Ljk0MSAyLjE3Ny0xMi4wMTQgMS40MjQgMi4xMDQtLjIzNyAxMi4yNjMtNC4xNCAxMi4yNjMtNC4xNCAxLjgwMS0xNi4yMTMgMi4zNTgtNDIuMDkxLTMuNDEzLTQzLjE0MXptLTM2LjM4IDE3MS42OTFjLS43OTUgMTkuNDk2LTEuMjk0IDI1LjAwNC0yLjExNSAyOS42MDEtLjM3OS44NTctLjc1OC45OTctMS4xMzgtLjA5NS0zLjQ3Ny0xNS45OTItMy4yMjQtMTM2LjQzOCAzNi40MDktMTkxLjI0MS0yMy4wNSA0Mi4wOTItMzMuNTM1IDEyMi44NjEtMzMuMTU2IDE2MS43MzV6IiBmaWxsPSIjMzMzIi8+PC9zdmc+" />
-  </body>
-</html>
-
-`
-
-export const generate = (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx).then(renderTemplate(template, toFile('public', 'index.html')))

package/lib/app/templates/index.tpl.ts

@@ -1,26 +0,0 @@
-import { toFile } from '@featherscloud/pinion'
-import { renderSource } from '../../commons.js'
-import { AppGeneratorContext } from '../index.js'
-
-const template = ({}: AppGeneratorContext) => /* ts */ `import { app } from './app'
-import { logger } from './logger'
-
-const port = app.get('port')
-const host = app.get('host')
-
-process.on('unhandledRejection', (reason) =>
-  logger.error('Unhandled Rejection %O', reason)
-)
-
-app.listen(port).then(() => {
-  logger.info(\`Feathers app listening on http://\${host}:\${port}\`)
-})
-`
-
-export const generate = (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    renderSource(
-      template,
-      toFile<AppGeneratorContext>(({ lib }) => lib, 'index')
-    )
-  )

package/lib/app/templates/logger.tpl.ts

@@ -1,56 +0,0 @@
-import { toFile } from '@featherscloud/pinion'
-import { renderSource } from '../../commons.js'
-import { AppGeneratorContext } from '../index.js'
-
-const template =
-  ({}: AppGeneratorContext) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/logging.html
-import { createLogger, format, transports } from 'winston'
-
-// Configure the Winston logger. For the complete documentation see https://github.com/winstonjs/winston
-export const logger = createLogger({
-  // To see more detailed errors, change this to 'debug'
-  level: 'info',
-  format: format.combine(
-    format.splat(),
-    format.simple()
-  ),
-  transports: [
-    new transports.Console()
-  ]
-})
-`
-
-export const logErrorTemplate = /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/log-error.html
-import type { HookContext, NextFunction } from '../declarations'
-import { logger } from '../logger'
-
-export const logError = async (context: HookContext, next: NextFunction) => {
-  try {
-    await next()
-  } catch (error: any) {
-    logger.error(error.stack)
-    
-    // Log validation errors
-    if (error.data) {
-      logger.error('Data: %O', error.data)
-    }
-
-    throw error
-  }
-}
-`
-
-export const generate = (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx)
-    .then(
-      renderSource(
-        template,
-        toFile<AppGeneratorContext>(({ lib }) => lib, 'logger')
-      )
-    )
-    .then(
-      renderSource(
-        logErrorTemplate,
-        toFile<AppGeneratorContext>(({ lib }) => lib, 'hooks', 'log-error')
-      )
-    )

package/lib/app/templates/package.json.tpl.ts

@@ -1,78 +0,0 @@
-import { toFile, writeJSON } from '@featherscloud/pinion'
-import { AppGeneratorContext } from '../index.js'
-
-const jsPackageJson = (lib: string) => ({
-  type: 'module',
-  scripts: {
-    start: `node ${lib}`,
-    dev: `nodemon ${lib}/`,
-    prettier: 'npx prettier "**/*.js" --write',
-    mocha: 'cross-env NODE_ENV=test mocha test/ --recursive --exit',
-    test: 'npm run mocha',
-    'bundle:client': 'npm pack --pack-destination ./public'
-  }
-})
-
-const tsPackageJson = (lib: string) => ({
-  scripts: {
-    dev: `nodemon -x ts-node ${lib}/index.ts`,
-    compile: 'shx rm -rf lib/ && tsc',
-    start: 'node lib/',
-    prettier: 'npx prettier "**/*.ts" --write',
-    mocha:
-      'cross-env NODE_ENV=test mocha test/ --require ts-node/register --recursive --extension .ts --exit',
-    test: 'npm run mocha',
-    'bundle:client': 'npm run compile && npm pack --pack-destination ./public'
-  }
-})
-
-const packageJson = ({
-  name,
-  description,
-  client,
-  language,
-  packager,
-  database,
-  framework,
-  transports,
-  lib,
-  test,
-  schema
-}: AppGeneratorContext) => ({
-  name,
-  description,
-  version: '0.0.0',
-  homepage: '',
-  private: true,
-  keywords: ['feathers'],
-  author: {},
-  contributors: [] as string[],
-  bugs: {},
-  engines: {
-    node: `>= ${process.version.substring(1)}`
-  },
-  feathers: {
-    language,
-    packager,
-    database,
-    framework,
-    transports,
-    schema
-  },
-  directories: {
-    lib,
-    test
-  },
-  ...(client
-    ? {
-        files: ['lib/client.js', 'lib/**/*.d.ts', 'lib/**/*.shared.js'],
-        main: language === 'ts' ? 'lib/client' : `${lib}/client`
-      }
-    : {
-        main: 'lib/index'
-      }),
-  ...(language === 'ts' ? tsPackageJson(lib) : jsPackageJson(lib))
-})
-
-export const generate = (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx).then(writeJSON(packageJson, toFile('package.json')))

package/lib/app/templates/prettierrc.tpl.ts

@@ -1,14 +0,0 @@
-import { toFile, writeJSON } from '@featherscloud/pinion'
-import { AppGeneratorContext } from '../index.js'
-import { PRETTIERRC } from '../../commons.js'
-
-export const generate = (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    writeJSON<AppGeneratorContext>(
-      (ctx) => ({
-        ...PRETTIERRC,
-        parser: ctx.language === 'ts' ? 'typescript' : 'babel'
-      }),
-      toFile('.prettierrc')
-    )
-  )