@feathersjs/generators 5.0.28 → 5.0.29

package/lib/service/templates/schema.json.tpl.ts

@@ -1,143 +0,0 @@
-import { toFile, when } from '@featherscloud/pinion'
-import { fileExists, localTemplate, renderSource } from '../../commons.js'
-import { ServiceGeneratorContext } from '../index.js'
-
-const authFieldsTemplate = (authStrategies: string[]) =>
-  authStrategies
-    .map((name) =>
-      name === 'local'
-        ? `    email: { type: 'string' },
-    password: { type: 'string' }`
-        : `    ${name}Id: { type: 'string' }`
-    )
-    .join(',\n')
-
-const template = ({
-  camelName,
-  upperName,
-  fileName,
-  relative,
-  authStrategies,
-  isEntityService,
-  type,
-  cwd,
-  lib
-}: ServiceGeneratorContext) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/service.schemas.html
-import { resolve, getValidator, querySyntax } from '@feathersjs/schema'${
-  type === 'mongodb'
-    ? `
-import { ObjectIdSchema } from '@feathersjs/schema'`
-    : ''
-}
-import type { FromSchema } from '@feathersjs/schema'
-${localTemplate(authStrategies, `import { passwordHash } from '@feathersjs/authentication-local'`)}
-
-import type { HookContext } from '${relative}/declarations'
-import { dataValidator, queryValidator } from '${relative}/${
-  fileExists(cwd, lib, 'schemas') ? 'schemas/' : '' // This is for legacy backwards compatibility
-}validators'
-import type { ${upperName}Service } from './${fileName}.class'
-
-// Main data model schema
-export const ${camelName}Schema = {
-  $id: '${upperName}',
-  type: 'object',
-  additionalProperties: false,
-  required: [ '${type === 'mongodb' ? '_id' : 'id'}', ${localTemplate(authStrategies, `'email'`, `'text'`)} ],
-  properties: {
-    ${type === 'mongodb' ? `_id: ObjectIdSchema(),` : `id: { type: 'number' },`}
-    ${
-      isEntityService
-        ? authFieldsTemplate(authStrategies)
-        : `
-    text: { type: 'string' }`
-    }
-  }
-} as const
-export type ${upperName} = FromSchema<typeof ${camelName}Schema>
-export const ${camelName}Validator = getValidator(${camelName}Schema, dataValidator)
-export const ${camelName}Resolver = resolve<${upperName}, HookContext<${upperName}Service>>({})
-
-export const ${camelName}ExternalResolver = resolve<${upperName}, HookContext<${upperName}Service>>({
-  ${localTemplate(
-    authStrategies,
-    `// The password should never be visible externally
-  password: async () => undefined`
-  )}
-})
-
-// Schema for creating new data
-export const ${camelName}DataSchema = {
-  $id: '${upperName}Data',
-  type: 'object',
-  additionalProperties: false,
-  required: [ ${localTemplate(authStrategies, `'email'`, `'text'`)} ],
-  properties: {
-    ...${camelName}Schema.properties
-  }
-} as const
-export type ${upperName}Data = FromSchema<typeof ${camelName}DataSchema>
-export const ${camelName}DataValidator = getValidator(${camelName}DataSchema, dataValidator)
-export const ${camelName}DataResolver = resolve<${upperName}Data, HookContext<${upperName}Service>>({
-  ${localTemplate(authStrategies, `password: passwordHash({ strategy: 'local' })`)}
-})
-
-// Schema for updating existing data
-export const ${camelName}PatchSchema = {
-  $id: '${upperName}Patch',
-  type: 'object',
-  additionalProperties: false,
-  required: [],
-  properties: {
-    ...${camelName}Schema.properties
-  }
-} as const
-export type ${upperName}Patch = FromSchema<typeof ${camelName}PatchSchema>
-export const ${camelName}PatchValidator = getValidator(${camelName}PatchSchema, dataValidator)
-export const ${camelName}PatchResolver = resolve<${upperName}Patch, HookContext<${upperName}Service>>({
-  ${localTemplate(authStrategies, `password: passwordHash({ strategy: 'local' })`)}
-})
-
-// Schema for allowed query properties
-export const ${camelName}QuerySchema = {
-  $id: '${upperName}Query',
-  type: 'object',
-  additionalProperties: false,
-  properties: {
-    ...querySyntax(${camelName}Schema.properties)
-  }
-} as const
-export type ${upperName}Query = FromSchema<typeof ${camelName}QuerySchema>
-export const ${camelName}QueryValidator = getValidator(${camelName}QuerySchema, queryValidator)
-export const ${camelName}QueryResolver = resolve<${upperName}Query, HookContext<${upperName}Service>>({
-  ${
-    isEntityService
-      ? `
-  // If there is a user (e.g. with authentication), they are only allowed to see their own data
-  ${type === 'mongodb' ? '_id' : 'id'}: async (value, user, context) => {
-    if (context.params.user) {
-      return context.params.user.${type === 'mongodb' ? '_id' : 'id'}
-    }
-
-    return value
-  }`
-      : ''
-  }
-})
-`
-
-export const generate = (ctx: ServiceGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    when<ServiceGeneratorContext>(
-      ({ schema }) => schema === 'json',
-      renderSource(
-        template,
-        toFile(({ lib, folder, fileName }: ServiceGeneratorContext) => [
-          lib,
-          'services',
-          ...folder,
-          `${fileName}.schema`
-        ])
-      )
-    )
-  )

package/lib/service/templates/schema.typebox.tpl.ts

@@ -1,131 +0,0 @@
-import { toFile, when } from '@featherscloud/pinion'
-import { fileExists, localTemplate, renderSource } from '../../commons.js'
-import { ServiceGeneratorContext } from '../index.js'
-
-const authFieldsTemplate = (authStrategies: string[]) =>
-  authStrategies
-    .map((name) =>
-      name === 'local'
-        ? `  email: Type.String(),
-  password: Type.Optional(Type.String())`
-        : `  ${name}Id: Type.Optional(Type.String())`
-    )
-    .join(',\n')
-
-const template = ({
-  camelName,
-  upperName,
-  fileName,
-  relative,
-  authStrategies,
-  isEntityService,
-  type,
-  cwd,
-  lib
-}: ServiceGeneratorContext) => /* ts */ `// // For more information about this file see https://dove.feathersjs.com/guides/cli/service.schemas.html
-import { resolve } from '@feathersjs/schema'
-import { Type, getValidator, querySyntax } from '@feathersjs/typebox'${
-  type === 'mongodb'
-    ? `
-import { ObjectIdSchema } from '@feathersjs/typebox'`
-    : ''
-}
-import type { Static } from '@feathersjs/typebox'
-${localTemplate(authStrategies, `import { passwordHash } from '@feathersjs/authentication-local'`)}
-
-import type { HookContext } from '${relative}/declarations'
-import { dataValidator, queryValidator } from '${relative}/${
-  fileExists(cwd, lib, 'schemas') ? 'schemas/' : '' // This is for legacy backwards compatibility
-}validators'
-import type { ${upperName}Service } from './${fileName}.class'
-
-// Main data model schema
-export const ${camelName}Schema = Type.Object({
-    ${type === 'mongodb' ? '_id: ObjectIdSchema()' : 'id: Type.Number()'},
-    ${isEntityService ? authFieldsTemplate(authStrategies) : `text: Type.String()`}
-  }, { $id: '${upperName}', additionalProperties: false })
-export type ${upperName} = Static<typeof ${camelName}Schema>
-export const ${camelName}Validator = getValidator(${camelName}Schema, dataValidator)
-export const ${camelName}Resolver = resolve<${upperName}, HookContext<${upperName}Service>>({})
-
-export const ${camelName}ExternalResolver = resolve<${upperName}, HookContext<${upperName}Service>>({
-  ${localTemplate(
-    authStrategies,
-    `// The password should never be visible externally
-  password: async () => undefined`
-  )}  
-})
-
-// Schema for creating new entries
-export const ${camelName}DataSchema = Type.Pick(${camelName}Schema, [
-  ${
-    isEntityService
-      ? authStrategies.map((name) => (name === 'local' ? `'email', 'password'` : `'${name}Id'`)).join(', ')
-      : `'text'`
-  }
-], {
-  $id: '${upperName}Data'
-})
-export type ${upperName}Data = Static<typeof ${camelName}DataSchema>
-export const ${camelName}DataValidator = getValidator(${camelName}DataSchema, dataValidator)
-export const ${camelName}DataResolver = resolve<${upperName}, HookContext<${upperName}Service>>({
-  ${localTemplate(authStrategies, `password: passwordHash({ strategy: 'local' })`)}
-})
-
-// Schema for updating existing entries
-export const ${camelName}PatchSchema = Type.Partial(${camelName}Schema, {
-  $id: '${upperName}Patch'
-})
-export type ${upperName}Patch = Static<typeof ${camelName}PatchSchema>
-export const ${camelName}PatchValidator = getValidator(${camelName}PatchSchema, dataValidator)
-export const ${camelName}PatchResolver = resolve<${upperName}, HookContext<${upperName}Service>>({
-  ${localTemplate(authStrategies, `password: passwordHash({ strategy: 'local' })`)}
-})
-
-// Schema for allowed query properties
-export const ${camelName}QueryProperties = Type.Pick(${camelName}Schema, [
-  '${type === 'mongodb' ? '_id' : 'id'}', ${
-    isEntityService
-      ? authStrategies.map((name) => (name === 'local' ? `'email'` : `'${name}Id'`)).join(', ')
-      : `'text'`
-  }
-])
-export const ${camelName}QuerySchema = Type.Intersect([
-  querySyntax(${camelName}QueryProperties),
-  // Add additional query properties here
-  Type.Object({}, { additionalProperties: false })
-], { additionalProperties: false })
-export type ${upperName}Query = Static<typeof ${camelName}QuerySchema>
-export const ${camelName}QueryValidator = getValidator(${camelName}QuerySchema, queryValidator)
-export const ${camelName}QueryResolver = resolve<${upperName}Query, HookContext<${upperName}Service>>({
-  ${
-    isEntityService
-      ? `
-  // If there is a user (e.g. with authentication), they are only allowed to see their own data
-  ${type === 'mongodb' ? '_id' : 'id'}: async (value, user, context) => {
-    if (context.params.user) {
-      return context.params.user.${type === 'mongodb' ? '_id' : 'id'}
-    }
-
-    return value
-  }`
-      : ''
-  }
-})
-`
-
-export const generate = (ctx: ServiceGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    when<ServiceGeneratorContext>(
-      ({ schema }) => schema === 'typebox',
-      renderSource(
-        template,
-        toFile(({ lib, folder, fileName }: ServiceGeneratorContext) => [
-          lib,
-          'services',
-          ...folder,
-          `${fileName}.schema`
-        ])
-      )
-    )
-  )

package/lib/service/templates/service.tpl.ts

@@ -1,161 +0,0 @@
-import { toFile, after, prepend } from '@featherscloud/pinion'
-import { fileExists, injectSource, renderSource } from '../../commons.js'
-import { ServiceGeneratorContext } from '../index.js'
-
-export const template = ({
-  camelName,
-  authentication,
-  isEntityService,
-  path,
-  lib,
-  language,
-  className,
-  relative,
-  schema,
-  fileName
-}: ServiceGeneratorContext) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/service.html
-${authentication || isEntityService ? `import { authenticate } from '@feathersjs/authentication'` : ''}
-${
-  schema
-    ? `
-import { hooks as schemaHooks } from '@feathersjs/schema'
-    
-import {
-  ${camelName}DataValidator,
-  ${camelName}PatchValidator,
-  ${camelName}QueryValidator,
-  ${camelName}Resolver,
-  ${camelName}ExternalResolver,
-  ${camelName}DataResolver,
-  ${camelName}PatchResolver,
-  ${camelName}QueryResolver
-} from './${fileName}.schema'
-`
-    : ''
-}
-
-import type { Application } from '${relative}/declarations'
-import { ${className}, getOptions } from './${fileName}.class'
-${
-  fileExists(lib, `client.${language}`)
-    ? `import { ${camelName}Path, ${camelName}Methods } from './${fileName}.shared'`
-    : `
-export const ${camelName}Path = '${path}'
-export const ${camelName}Methods: Array<keyof ${className}> = ['find', 'get', 'create', 'patch', 'remove']`
-}
-
-export * from './${fileName}.class'
-${schema ? `export * from './${fileName}.schema'` : ''}
-
-// A configure function that registers the service and its hooks via \`app.configure\`
-export const ${camelName} = (app: Application) => {
-  // Register our service on the Feathers application
-  app.use(${camelName}Path, new ${className}(getOptions(app)), {
-    // A list of all methods this service exposes externally
-    methods: ${camelName}Methods,
-    // You can add additional custom events to be sent to clients here
-    events: []
-  })
-  // Initialize hooks
-  app.service(${camelName}Path).hooks({
-    around: {
-      all: [${
-        authentication
-          ? `
-        authenticate('jwt'),`
-          : ''
-      } ${
-        schema
-          ? `
-        schemaHooks.resolveExternal(${camelName}ExternalResolver),
-        schemaHooks.resolveResult(${camelName}Resolver),`
-          : ''
-      }
-      ],${
-        isEntityService
-          ? `
-      find: [authenticate('jwt')],
-      get: [authenticate('jwt')],
-      create: [],
-      update: [authenticate('jwt')],
-      patch: [authenticate('jwt')],
-      remove: [authenticate('jwt')]`
-          : ''
-      }
-    },
-    before: {
-      all: [${
-        schema
-          ? `
-        schemaHooks.validateQuery(${camelName}QueryValidator),
-        schemaHooks.resolveQuery(${camelName}QueryResolver)
-      `
-          : ''
-      }],
-      find: [],
-      get: [],
-      create: [${
-        schema
-          ? `
-        schemaHooks.validateData(${camelName}DataValidator),
-        schemaHooks.resolveData(${camelName}DataResolver)
-      `
-          : ''
-      }],
-      patch: [${
-        schema
-          ? `
-        schemaHooks.validateData(${camelName}PatchValidator),
-        schemaHooks.resolveData(${camelName}PatchResolver)
-      `
-          : ''
-      }],
-      remove: []
-    },
-    after: {
-      all: []
-    },
-    error: {
-      all: []
-    }
-  })
-}
-
-// Add this service to the service type index
-declare module '${relative}/declarations' {
-  interface ServiceTypes {
-    [${camelName}Path]: ${className}
-  }
-}
-`
-
-const toServiceIndex = toFile(({ lib }: ServiceGeneratorContext) => [lib, 'services', `index`])
-
-export const generate = (ctx: ServiceGeneratorContext) =>
-  Promise.resolve(ctx)
-    .then(
-      renderSource(
-        template,
-        toFile(({ lib, fileName, folder }: ServiceGeneratorContext) => [
-          lib,
-          'services',
-          ...folder,
-          `${fileName}`
-        ])
-      )
-    )
-    .then(
-      injectSource<ServiceGeneratorContext>(
-        ({ camelName, folder, fileName }) =>
-          `import { ${camelName} } from './${folder.join('/')}/${fileName}'`,
-        prepend(),
-        toServiceIndex
-      )
-    )
-    .then(
-      injectSource<ServiceGeneratorContext>(
-        ({ camelName }) => `  app.configure(${camelName})`,
-        after('export const services'),
-        toServiceIndex
-      )
-    )

package/lib/service/templates/shared.tpl.ts

@@ -1,64 +0,0 @@
-import { toFile, when } from '@featherscloud/pinion'
-import { fileExists, renderSource } from '../../commons.js'
-import { ServiceGeneratorContext } from '../index.js'
-
-const sharedTemplate = ({
-  camelName,
-  upperName,
-  className,
-  fileName,
-  relative,
-  path
-}: ServiceGeneratorContext) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/service.shared.html
-import type { Params } from '@feathersjs/feathers'
-import type { ClientApplication } from '${relative}/client'
-import type {
-  ${upperName},
-  ${upperName}Data,
-  ${upperName}Patch,
-  ${upperName}Query,
-  ${className}
-} from './${fileName}.class'
-
-export type { ${upperName}, ${upperName}Data, ${upperName}Patch, ${upperName}Query }
-
-export type ${upperName}ClientService = Pick<
-  ${className}<Params<${upperName}Query>>,
-  typeof ${camelName}Methods[number]
->
-
-export const ${camelName}Path = '${path}'
-
-export const ${camelName}Methods: Array<keyof ${className}> = ['find', 'get', 'create', 'patch', 'remove']
-
-export const ${camelName}Client = (client: ClientApplication) => {
-  const connection = client.get('connection')
-
-  client.use(${camelName}Path, connection.service(${camelName}Path), {
-    methods: ${camelName}Methods
-  })
-}
-
-// Add this service to the client service type index
-declare module '${relative}/client' {
-  interface ServiceTypes {
-    [${camelName}Path]: ${upperName}ClientService
-  }
-}
-`
-
-export const generate = async (ctx: ServiceGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    when<ServiceGeneratorContext>(
-      ({ lib, language }) => fileExists(lib, `client.${language}`),
-      renderSource(
-        sharedTemplate,
-        toFile(({ lib, folder, fileName }: ServiceGeneratorContext) => [
-          lib,
-          'services',
-          ...folder,
-          `${fileName}.shared`
-        ])
-      )
-    )
-  )

package/lib/service/templates/test.tpl.ts

@@ -1,33 +0,0 @@
-import { toFile } from '@featherscloud/pinion'
-import { renderSource } from '../../commons.js'
-import { ServiceGeneratorContext } from '../index.js'
-
-const template = ({
-  relative,
-  lib,
-  path
-}: ServiceGeneratorContext) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/service.test.html
-import assert from 'assert'
-import { app } from '../${relative}/${lib}/app'
-
-describe('${path} service', () => {
-  it('registered the service', () => {
-    const service = app.service('${path}')
-
-    assert.ok(service, 'Registered the service')
-  })
-})
-`
-
-export const generate = (ctx: ServiceGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    renderSource(
-      template,
-      toFile<ServiceGeneratorContext>(({ test, folder, fileName }) => [
-        test,
-        'services',
-        ...folder,
-        `${fileName}.test`
-      ])
-    )
-  )

package/lib/service/type/custom.tpl.ts

@@ -1,112 +0,0 @@
-import { toFile } from '@featherscloud/pinion'
-import { renderSource } from '../../commons.js'
-import { ServiceGeneratorContext } from '../index.js'
-
-export const template = ({
-  className,
-  upperName,
-  schema,
-  fileName,
-  relative
-}: ServiceGeneratorContext) => /* ts */ `// For more information about this file see https://dove.feathersjs.com/guides/cli/service.class.html#custom-services
-import type { Id, NullableId, Params, ServiceInterface } from '@feathersjs/feathers'
-
-import type { Application } from '${relative}/declarations'
-${
-  schema
-    ? `import type {
-  ${upperName},
-  ${upperName}Data,
-  ${upperName}Patch,
-  ${upperName}Query
-} from './${fileName}.schema'
-`
-    : `
-type ${upperName} = any
-type ${upperName}Data = any
-type ${upperName}Patch = any
-type ${upperName}Query = any
-`
-}
-
-export type { ${upperName}, ${upperName}Data, ${upperName}Patch, ${upperName}Query }
-
-export interface ${className}Options {
-  app: Application
-}
-
-export interface ${upperName}Params extends Params<${upperName}Query> {
-
-}
-
-// This is a skeleton for a custom service class. Remove or add the methods you need here
-export class ${className}<ServiceParams extends ${upperName}Params = ${upperName}Params>
-    implements ServiceInterface<${upperName}, ${upperName}Data, ServiceParams, ${upperName}Patch> {
-  constructor (public options: ${className}Options) {
-  }
-
-  async find (_params?: ServiceParams): Promise<${upperName}[]> {
-    return []
-  }
-
-  async get (id: Id, _params?: ServiceParams): Promise<${upperName}> {
-    return {
-      id: 0,
-      text: \`A new message with ID: \${id}!\`
-    }
-  }
-
-  async create (data: ${upperName}Data, params?: ServiceParams): Promise<${upperName}>
-  async create (data: ${upperName}Data[], params?: ServiceParams): Promise<${upperName}[]>
-  async create (data: ${upperName}Data|${upperName}Data[], params?: ServiceParams): Promise<${upperName}|${upperName}[]> {
-    if (Array.isArray(data)) {
-      return Promise.all(data.map(current => this.create(current, params)));
-    }
-
-    return {
-      id: 0,
-      ...data
-    }
-  }
-
-  // This method has to be added to the 'methods' option to make it available to clients
-  async update (id: NullableId, data: ${upperName}Data, _params?: ServiceParams): Promise<${upperName}> {
-    return {
-      id: 0,
-      ...data
-    }
-  }
-
-  async patch (id: NullableId, data: ${upperName}Patch, _params?: ServiceParams): Promise<${upperName}> {
-    return {
-      id: 0,
-      text: \`Fallback for \${id}\`,
-      ...data
-    }
-  }
-
-  async remove (id: NullableId, _params?: ServiceParams): Promise<${upperName}> {
-    return {
-      id: 0,
-      text: 'removed'
-    }
-  }
-}
-
-export const getOptions = (app: Application) => {
-  return { app }
-}
-`
-
-export const generate = (ctx: ServiceGeneratorContext) =>
-  Promise.resolve(ctx).then(
-    renderSource(
-      template,
-      toFile<ServiceGeneratorContext>(({ lib, folder, fileName }) => [
-        lib,
-        'services',
-        ...folder,
-        `${fileName}.class`
-      ])
-    )
-  )