@feathersjs/generators 5.0.27 → 5.0.29

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

@@ -1,57 +0,0 @@
-import { renderTemplate, toFile } from '@featherscloud/pinion'
-import { AppGeneratorContext } from '../index.js'
-
-const template = ({ name, description, language, database }: AppGeneratorContext) => /* md */ `# ${name}
-
-> ${description}
-
-## About
-
-This project uses [Feathers](http://feathersjs.com). An open source framework for building APIs and real-time applications.
-
-## Getting Started
-
-1. Make sure you have [NodeJS](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
-2. Install your dependencies
-
-    \`\`\`
-    cd path/to/${name}
-    npm install
-    \`\`\`
-
-3. Start your app
-
-    \`\`\`${
-      language === 'ts'
-        ? `
-    npm run compile # Compile TypeScript source`
-        : ''
-    }${
-      database !== 'mongodb'
-        ? `
-    npm run migrate # Run migrations to set up the database`
-        : ''
-    }
-    npm start
-    \`\`\`
-
-## Testing
-
-Run \`npm test\` and all your tests in the \`test/\` directory will be run.
-
-## Scaffolding
-
-This app comes with a powerful command line interface for Feathers. Here are a few things it can do:
-
-\`\`\`
-$ npx feathers help                           # Show all commands
-$ npx feathers generate service               # Generate a new Service
-\`\`\`
-
-## Help
-
-For more information on all the things you can do with Feathers visit [docs.feathersjs.com](http://docs.feathersjs.com).
-`
-
-export const generate = (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx).then(renderTemplate(template, toFile('readme.md')))

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

@@ -1,20 +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/application.html#configure-functions
-import type { Application } from '../declarations'
-
-export const services = (app: Application) => {
-  // All services will be registered here
-}
-`
-
-export const generate = (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    renderSource(
-      template,
-      toFile<AppGeneratorContext>(({ lib }) => lib, 'services', 'index')
-    )
-  )

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

@@ -1,29 +0,0 @@
-import { toFile, when, writeJSON } from '@featherscloud/pinion'
-import { AppGeneratorContext } from '../index.js'
-
-export const generate = (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    when<AppGeneratorContext>(
-      (ctx) => ctx.language === 'ts',
-      writeJSON<AppGeneratorContext>(
-        ({ lib }) => ({
-          'ts-node': {
-            files: true
-          },
-          compilerOptions: {
-            target: 'es2020',
-            module: 'commonjs',
-            outDir: './lib',
-            rootDir: `./${lib}`,
-            declaration: true,
-            strict: true,
-            esModuleInterop: true,
-            sourceMap: true
-          },
-          include: [lib],
-          exclude: ['test']
-        }),
-        toFile('tsconfig.json')
-      )
-    )
-  )

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

@@ -1,39 +0,0 @@
-import { toFile } from '@featherscloud/pinion'
-import { renderSource } from '../../commons.js'
-import { AppGeneratorContext } from '../index.js'
-
-const validatorTemplate = /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/validators.html
-import { Ajv, addFormats } from '@feathersjs/schema'
-import type { FormatsPluginOptions } from '@feathersjs/schema'
-
-const formats: FormatsPluginOptions = [
-  'date-time', 
-  'time', 
-  'date', 
-  'email',  
-  'hostname', 
-  'ipv4', 
-  'ipv6', 
-  'uri', 
-  'uri-reference', 
-  'uuid',
-  'uri-template', 
-  'json-pointer', 
-  'relative-json-pointer', 
-  'regex'
-]
-
-export const dataValidator: Ajv = addFormats(new Ajv({}), formats)
-
-export const queryValidator: Ajv = addFormats(new Ajv({
-  coerceTypes: true
-}), formats)
-`
-
-export const generate = (ctx: AppGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    renderSource(
-      validatorTemplate,
-      toFile<AppGeneratorContext>(({ lib }) => lib, 'validators')
-    )
-  )

package/lib/authentication/index.ts

@@ -1,119 +0,0 @@
-import chalk from 'chalk'
-import { dirname } from 'path'
-import { runGenerators, prompt } from '@featherscloud/pinion'
-import { fileURLToPath } from 'url'
-import {
-  addVersions,
-  checkPreconditions,
-  FeathersBaseContext,
-  initializeBaseContext,
-  install
-} from '../commons.js'
-import { generate as serviceGenerator, ServiceGeneratorContext } from '../service/index.js'
-
-// Set __dirname in es module
-const __dirname = dirname(fileURLToPath(import.meta.url))
-
-export interface AuthenticationGeneratorContext extends ServiceGeneratorContext {
-  service: string
-  entity: string
-  authStrategies: string[]
-  dependencies: string[]
-}
-
-export type AuthenticationGeneratorArguments = FeathersBaseContext &
-  Partial<Pick<AuthenticationGeneratorContext, 'service' | 'authStrategies' | 'path' | 'schema' | 'type'>>
-
-export const generate = (ctx: AuthenticationGeneratorArguments) =>
-  Promise.resolve(ctx)
-    .then(initializeBaseContext())
-    .then(checkPreconditions())
-    .then(
-      prompt((ctx: AuthenticationGeneratorArguments) => [
-        {
-          type: 'checkbox',
-          name: 'authStrategies',
-          when: !ctx.authStrategies,
-          message: 'Which authentication methods do you want to use?',
-          suffix: chalk.grey(' Other methods and providers can be added at any time.'),
-          choices: [
-            {
-              name: 'Email + Password',
-              value: 'local',
-              checked: true
-            },
-            {
-              name: 'Google',
-              value: 'google'
-            },
-            {
-              name: 'Facebook',
-              value: 'facebook'
-            },
-            {
-              name: 'Twitter',
-              value: 'twitter'
-            },
-            {
-              name: 'GitHub',
-              value: 'github'
-            },
-            {
-              name: 'Auth0',
-              value: 'auth0'
-            }
-          ]
-        },
-        {
-          name: 'service',
-          type: 'input',
-          when: !ctx.service,
-          message: 'What is your authentication service name?',
-          default: 'user'
-        },
-        {
-          name: 'path',
-          type: 'input',
-          when: !ctx.path,
-          message: 'What path should the service be registered on?',
-          default: 'users'
-        }
-      ])
-    )
-    .then(async (ctx) => {
-      const serviceContext = await serviceGenerator({
-        ...ctx,
-        name: ctx.service,
-        isEntityService: true
-      })
-
-      return {
-        ...ctx,
-        entity: ctx.service,
-        ...serviceContext
-      }
-    })
-    .then(runGenerators(__dirname, 'templates'))
-    .then((ctx) => ctx as AuthenticationGeneratorContext)
-    .then((ctx) => {
-      const dependencies: string[] = []
-
-      dependencies.push('@feathersjs/authentication-oauth')
-
-      if (ctx.authStrategies.includes('local')) {
-        dependencies.push('@feathersjs/authentication-local')
-      }
-
-      if (ctx.dependencies) {
-        return {
-          ...ctx,
-          dependencies: [...ctx.dependencies, ...dependencies]
-        }
-      }
-
-      return install<AuthenticationGeneratorContext>(
-        addVersions(dependencies, ctx.dependencyVersions),
-        false,
-        ctx.feathers.packager
-      )(ctx)
-    })

package/lib/authentication/templates/authentication.tpl.ts

@@ -1,52 +0,0 @@
-import { before, toFile } from '@featherscloud/pinion'
-import { injectSource, renderSource } from '../../commons.js'
-import { AuthenticationGeneratorContext } from '../index.js'
-import { localTemplate, oauthTemplate } from '../../commons.js'
-
-const template = ({
-  authStrategies
-}: AuthenticationGeneratorContext) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/authentication.html
-import { AuthenticationService, JWTStrategy } from '@feathersjs/authentication'
-${localTemplate(authStrategies, `import { LocalStrategy } from '@feathersjs/authentication-local'`)}
-${oauthTemplate(authStrategies, `import { oauth, OAuthStrategy } from '@feathersjs/authentication-oauth'`)}
-
-import type { Application } from './declarations'
-
-declare module './declarations' {
-  interface ServiceTypes {
-    'authentication': AuthenticationService
-  }
-}
-
-export const authentication = (app: Application) => {
-  const authentication = new AuthenticationService(app)
-
-  authentication.register('jwt', new JWTStrategy())
-  ${authStrategies
-    .map(
-      (strategy) =>
-        `  authentication.register('${strategy}', ${
-          strategy === 'local' ? `new LocalStrategy()` : `new OAuthStrategy()`
-        })`
-    )
-    .join('\n')}
-
-  app.use('authentication', authentication)
-  ${oauthTemplate(authStrategies, `app.configure(oauth())`)}
-}
-`
-
-const importTemplate = "import { authentication } from './authentication'"
-const configureTemplate = 'app.configure(authentication)'
-const toAppFile = toFile<AuthenticationGeneratorContext>(({ lib }) => [lib, 'app'])
-
-export const generate = (ctx: AuthenticationGeneratorContext) =>
-  Promise.resolve(ctx)
-    .then(
-      renderSource(
-        template,
-        toFile<AuthenticationGeneratorContext>(({ lib }) => lib, 'authentication')
-      )
-    )
-    .then(injectSource(importTemplate, before('import { services } from'), toAppFile))
-    .then(injectSource(configureTemplate, before('app.configure(services)'), toAppFile))

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

@@ -1,78 +0,0 @@
-import { toFile, when } from '@featherscloud/pinion'
-import { fileExists, renderSource } from '../../commons.js'
-import { AuthenticationGeneratorContext } from '../index.js'
-import { localTemplate } from '../../commons.js'
-
-const template = ({
-  authStrategies,
-  upperName,
-  type,
-  lib
-}: AuthenticationGeneratorContext) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/client.test.html
-import assert from 'assert'
-import axios from 'axios'
-
-import rest from '@feathersjs/rest-client'
-${localTemplate(authStrategies, `import authenticationClient from '@feathersjs/authentication-client'`)}
-import { app } from '../${lib}/app'
-import { createClient } from '../${lib}/client' 
-${localTemplate(authStrategies, `import type { ${upperName}Data } from '../${lib}/client'`)}
-
-const port = app.get('port')
-const appUrl = \`http://\${app.get('host')}:\${port}\`
-
-describe('application client tests', () => {
-  const client = createClient(rest(appUrl).axios(axios))
-
-  before(async () => {
-    await app.listen(port)
-  })
-
-  after(async () => {
-    await app.teardown()
-  })
-
-  it('initialized the client', () => {
-    assert.ok(client)
-  })
-
-  ${localTemplate(
-    authStrategies,
-    `
-  it('creates and authenticates a user with email and password', async () => {
-    const userData: ${upperName}Data = {
-      email: 'someone@example.com',
-      password: 'supersecret'
-    }
-
-    await client.service('users').create(userData)
-    
-    const { user, accessToken } = await client.authenticate({
-      strategy: 'local',
-      ...userData
-    })
-    
-    assert.ok(accessToken, 'Created access token for user')
-    assert.ok(user, 'Includes user in authentication data')
-    assert.strictEqual(user.password, undefined, 'Password is hidden to clients')
-
-    await client.logout()
-
-    // Remove the test user on the server
-    await app.service('users').remove(user.${type === 'mongodb' ? '_id' : 'id'})
-  })`
-  )}
-})
-`
-
-export const generate = (ctx: AuthenticationGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    when<AuthenticationGeneratorContext>(
-      ({ lib, language }) => fileExists(lib, `client.${language}`),
-      renderSource(
-        template,
-        toFile<AuthenticationGeneratorContext>(({ test }) => test, 'client.test'),
-        { force: true }
-      )
-    )
-  )

package/lib/authentication/templates/config.tpl.ts

@@ -1,60 +0,0 @@
-import crypto from 'crypto'
-import { toFile, mergeJSON } from '@featherscloud/pinion'
-import { AuthenticationGeneratorContext } from '../index.js'
-
-export const generate = (ctx: AuthenticationGeneratorContext) =>
-  Promise.resolve(ctx)
-    .then(
-      mergeJSON<AuthenticationGeneratorContext>(
-        ({ authStrategies }) => {
-          const authentication: any = {
-            entity: ctx.entity,
-            service: ctx.path,
-            secret: crypto.randomBytes(24).toString('base64'),
-            authStrategies: ['jwt'],
-            jwtOptions: {
-              header: {
-                typ: 'access'
-              },
-              audience: 'https://yourdomain.com',
-              algorithm: 'HS256',
-              expiresIn: '1d'
-            }
-          }
-
-          if (authStrategies.includes('local')) {
-            authentication.authStrategies.push('local')
-            authentication.local = {
-              usernameField: 'email',
-              passwordField: 'password'
-            }
-          }
-
-          const oauthStrategies = authStrategies.filter((name) => name !== 'local')
-
-          if (oauthStrategies.length) {
-            authentication.oauth = oauthStrategies.reduce((oauth, name) => {
-              oauth[name] = {
-                key: '<Client ID>',
-                secret: '<Client secret>'
-              }
-
-              return oauth
-            }, {} as any)
-          }
-
-          return { authentication }
-        },
-        toFile('config', 'default.json')
-      )
-    )
-    .then(
-      mergeJSON<AuthenticationGeneratorContext>(
-        {
-          authentication: {
-            secret: 'FEATHERS_SECRET'
-          }
-        },
-        toFile('config', 'custom-environment-variables.json')
-      )
-    )

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

@@ -1,38 +0,0 @@
-import { inject, before, toFile, when, append } from '@featherscloud/pinion'
-import { AuthenticationGeneratorContext } from '../index.js'
-
-const importTemplate = ({
-  upperName,
-  folder,
-  fileName
-}: AuthenticationGeneratorContext) => /* ts */ `import { ${upperName} } from './services/${folder.join(
-  '/'
-)}/${fileName}'
-`
-
-const paramsTemplate = ({
-  entity,
-  upperName
-}: AuthenticationGeneratorContext) => /* ts */ `// Add the ${entity} as an optional property to all params
-declare module '@feathersjs/feathers' {
-  interface Params {
-    ${entity}?: ${upperName}
-  }
-}
-`
-
-const toDeclarationFile = toFile<AuthenticationGeneratorContext>(({ lib }) => lib, 'declarations.ts')
-
-export const generate = (ctx: AuthenticationGeneratorContext) =>
-  Promise.resolve(ctx)
-    .then(
-      when(
-        (ctx) => ctx.language === 'ts',
-        inject(
-          importTemplate,
-          before(/export \{ NextFunction \}|export type \{ NextFunction \}/),
-          toDeclarationFile
-        )
-      )
-    )
-    .then(when((ctx) => ctx.language === 'ts', inject(paramsTemplate, append(), toDeclarationFile)))