Allow to generate services without schema

feathersjs · daffl · Oct 7, 2022 · Oct 3, 2022 · Oct 3, 2022 · Oct 4, 2022
commit aeeb0d2507628d84883604c09cec77768d1d134d
diff --git a/packages/cli/src/app/index.ts b/packages/cli/src/app/index.ts
@@ -109,37 +109,44 @@ export const generate = (ctx: AppGeneratorArguments) =>
             { value: 'pnpm', name: 'pnpm' }
           ]
         },
+        {
+          type: 'list',
+          name: 'schema',
+          when: !ctx.schema,
+          message: 'What is your preferred schema (model) definition format?',
+          choices: [
+            { value: 'typebox', name: `TypeBox ${chalk.grey('(recommended)')}` },
+            { value: 'json', name: 'JSON schema' }
+          ]
+        },
         ...connectionPrompts(ctx),
         ...authenticationPrompts({
           ...ctx,
-          service: 'users',
+          service: 'user',
+          path: 'users',
           entity: 'user'
         })
       ])
     )
     .then(runGenerators(__dirname, 'templates'))
     .then(copyFiles(fromFile(__dirname, 'static'), toFile('.')))
     .then(initializeBaseContext())
-    .then(
-      when<AppGeneratorContext>(
-        ({ authStrategies }) => authStrategies.length > 0,
-        async (ctx) => {
-          const { dependencies } = await connectionGenerator(ctx)
+    .then(async (ctx) => {
+      const { dependencies } = await connectionGenerator(ctx)
 
-          return {
-            ...ctx,
-            dependencies
-          }
-        }
-      )
-    )
+      return {
+        ...ctx,
+        dependencies
+      }
+    })
     .then(
       when<AppGeneratorContext>(
         ({ authStrategies }) => authStrategies.length > 0,
         async (ctx) => {
           const { dependencies } = await authenticationGenerator({
             ...ctx,
-            service: 'users',
+            service: 'user',
+            path: 'users',
             entity: 'user'
           })
 

diff --git a/packages/cli/src/app/templates/package.json.tpl.ts b/packages/cli/src/app/templates/package.json.tpl.ts
@@ -33,7 +33,8 @@ const packageJson = ({
   framework,
   transports,
   lib,
-  test
+  test,
+  schema
 }: AppGeneratorContext) => ({
   name,
   description,
@@ -52,7 +53,8 @@ const packageJson = ({
     packager,
     database,
     framework,
-    transports
+    transports,
+    schema
   },
   directories: {
     lib,

diff --git a/packages/cli/src/authentication/index.ts b/packages/cli/src/authentication/index.ts
@@ -17,7 +17,7 @@ export interface AuthenticationGeneratorContext extends ServiceGeneratorContext
 }
 
 export type AuthenticationGeneratorArguments = FeathersBaseContext &
-  Partial<Pick<AuthenticationGeneratorContext, 'service' | 'authStrategies' | 'entity'>>
+  Partial<Pick<AuthenticationGeneratorContext, 'service' | 'authStrategies' | 'entity' | 'path'>>
 
 export const prompts = (ctx: AuthenticationGeneratorArguments) => [
   {
@@ -59,6 +59,13 @@ export const prompts = (ctx: AuthenticationGeneratorArguments) => [
     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'
   },
   {
@@ -80,7 +87,6 @@ export const generate = (ctx: AuthenticationGeneratorArguments) =>
       const serviceContext = await serviceGenerator({
         ...ctx,
         name: ctx.service,
-        path: ctx.service,
         isEntityService: true,
         type: getDatabaseAdapter(ctx.feathers?.database)
       })

diff --git a/packages/cli/src/authentication/templates/config.tpl.ts b/packages/cli/src/authentication/templates/config.tpl.ts
@@ -8,7 +8,7 @@ export const generate = (ctx: AuthenticationGeneratorContext) =>
       mergeJSON<AuthenticationGeneratorContext>(({ authStrategies }) => {
         const authentication: any = {
           entity: ctx.entity,
-          service: ctx.service,
+          service: ctx.path,
           secret: crypto.randomBytes(24).toString('base64'),
           authStrategies: ['jwt'],
           jwtOptions: {

diff --git a/packages/cli/src/authentication/templates/test.tpl.ts b/packages/cli/src/authentication/templates/test.tpl.ts
@@ -4,6 +4,7 @@ import { AuthenticationGeneratorContext } from '../index'
 
 const template = ({
   authStrategies,
+  path,
   lib
 }: AuthenticationGeneratorContext) => /* ts */ `import assert from 'assert';
 import { app } from '../${lib}/app';
@@ -19,7 +20,7 @@ describe('authentication', () => {
 
   before(async () => {
     try {
-      await app.service('users').create(userInfo)
+      await app.service('${path}').create(userInfo)
     } catch (error) {
       // Do nothing, it just means the user already exists and can be tested
     }

diff --git a/packages/cli/src/commons.ts b/packages/cli/src/commons.ts
@@ -54,6 +54,10 @@ export type FeathersAppInfo = {
    * The HTTP framework used
    */
   framework: 'koa' | 'express'
+  /**
+   * The main schema definition format
+   */
+  schema: 'typebox' | 'json'
 }
 
 export interface AppPackageJson extends PackageJson {

diff --git a/packages/cli/src/service/index.ts b/packages/cli/src/service/index.ts
@@ -49,6 +49,10 @@ export interface ServiceGeneratorContext extends FeathersBaseContext {
    * The chosen service type
    */
   type: 'knex' | 'mongodb' | 'custom'
+  /**
+   * Which schema definition format to use
+   */
+  schema: 'typebox' | 'json' | false
   /**
    * Wether this service uses authentication
    */
@@ -63,15 +67,17 @@ export interface ServiceGeneratorContext extends FeathersBaseContext {
  * Parameters the generator is called with
  */
 export type ServiceGeneratorArguments = FeathersBaseContext &
-  Partial<Pick<ServiceGeneratorContext, 'name' | 'path' | 'type' | 'authentication' | 'isEntityService'>>
+  Partial<
+    Pick<ServiceGeneratorContext, 'name' | 'path' | 'type' | 'authentication' | 'isEntityService' | 'schema'>
+  >
 
 export const generate = (ctx: ServiceGeneratorArguments) =>
   generator(ctx)
     .then(initializeBaseContext())
     .then(checkPreconditions())
     .then(
       prompt<ServiceGeneratorArguments, ServiceGeneratorContext>(
-        ({ name, path, type, authentication, isEntityService }) => [
+        ({ name, path, type, schema, authentication, isEntityService }) => [
           {
             name: 'name',
             type: 'input',
@@ -111,6 +117,27 @@ export const generate = (ctx: ServiceGeneratorArguments) =>
                 name: 'A custom service'
               }
             ]
+          },
+          {
+            name: 'schema',
+            type: 'list',
+            when: schema === undefined,
+            message: 'Which schema definition format do you want to use?',
+            choices: [
+              {
+                value: 'json',
+                name: 'JSON schema'
+              },
+              {
+                value: 'typebox',
+                name: 'TypeBox',
+                disabled: true
+              },
+              {
+                value: false,
+                name: 'No schema'
+              }
+            ]
           }
         ]
       )

diff --git a/packages/cli/src/service/service.tpl.ts b/packages/cli/src/service/service.tpl.ts
@@ -28,14 +28,17 @@ export const serviceImportTemplate = ({
   camelName,
   upperName,
   fileName,
-  relative
+  relative,
+  schema
 }: ServiceGeneratorContext) => `
 ${authentication || isEntityService ? `import { authenticate } from '@feathersjs/authentication'` : ''}
-import { schemaHooks } from '@feathersjs/schema'
+${schema ? `import { hooks as schemaHooks } from '@feathersjs/schema'` : ''}
 
 import type { Application } from '${relative}/declarations'
 
-import {
+${
+  schema
+    ? `import {
   ${camelName}DataValidator,
   ${camelName}QueryValidator,
   ${camelName}Resolver,
@@ -48,15 +51,25 @@ import type {
   ${upperName},
   ${upperName}Data,
   ${upperName}Query
-} from './${fileName}.schema'`
+} from './${fileName}.schema'
+
+export * from './${fileName}.schema'
+`
+    : `
+export type ${upperName} = any
+export type ${upperName}Data = any
+export type ${upperName}Query = any
+`
+}`
 
 export const serviceRegistrationTemplate = ({
   camelName,
   authentication,
   isEntityService,
   path,
   className,
-  relative
+  relative,
+  schema
 }: ServiceGeneratorContext) => /* ts */ `
 export const ${camelName}Hooks = {
   around: {
@@ -79,20 +92,30 @@ export const ${camelName}Hooks = {
     }
   },
   before: {
-    all: [
+    all: [${
+      schema
+        ? `
       schemaHooks.validateQuery(${camelName}QueryValidator),
       schemaHooks.validateData(${camelName}DataValidator),
       schemaHooks.resolveQuery(${camelName}QueryResolver),
       schemaHooks.resolveData(${camelName}DataResolver)
-    ]
+    `
+        : ''
+    }]
   },
   after: {
-    all: [
+    all: [${
+      schema
+        ? `
       schemaHooks.resolveResult(${camelName}Resolver),
       schemaHooks.resolveExternal(${camelName}ExternalResolver)
-    ]
+    `
+        : ''
+    }]
   },
-  error: {}
+  error: {
+    all: []
+  }
 }
 
 // A configure function that registers the service and its hooks via \`app.configure\`

diff --git a/packages/cli/src/service/templates/client.tpl.ts b/packages/cli/src/service/templates/client.tpl.ts
@@ -5,7 +5,7 @@ const schemaImports = ({ upperName, folder, fileName }: ServiceGeneratorContext)
   ${upperName},
   ${upperName}Data,
   ${upperName}Query,
-} from './services/${folder.join('/')}/${fileName}.schema'
+} from './services/${folder.join('/')}/${fileName}.service'
 
 export type {
   ${upperName},

diff --git a/packages/cli/src/service/templates/schema.tpl.ts b/packages/cli/src/service/templates/schema.tpl.ts
@@ -1,4 +1,4 @@
-import { generator, toFile } from '@feathershq/pinion'
+import { generator, toFile, when } from '@feathershq/pinion'
 import { renderSource } from '../../commons'
 import { ServiceGeneratorContext } from '../index'
 
@@ -79,13 +79,16 @@ export const ${camelName}QueryResolver = resolve<${upperName}Query, HookContext>
 
 export const generate = (ctx: ServiceGeneratorContext) =>
   generator(ctx).then(
-    renderSource(
-      template,
-      toFile(({ lib, folder, fileName }: ServiceGeneratorContext) => [
-        lib,
-        'services',
-        ...folder,
-        `${fileName}.schema`
-      ])
+    when<ServiceGeneratorContext>(
+      ({ schema }) => schema !== false,
+      renderSource(
+        template,
+        toFile(({ lib, folder, fileName }: ServiceGeneratorContext) => [
+          lib,
+          'services',
+          ...folder,
+          `${fileName}.schema`
+        ])
+      )
     )
   )
diff --git a/packages/cli/test/generators.test.ts b/packages/cli/test/generators.test.ts
@@ -53,7 +53,7 @@ describe('@feathersjs/cli', () => {
               connectionString: `${name}.sqlite`,
               transports: ['rest', 'websockets'],
               authStrategies: ['local', 'github'],
-              _: ['generate', 'app']
+              schema: 'typebox'
             },
             { cwd }
           )
@@ -73,8 +73,7 @@ describe('@feathersjs/cli', () => {
             {
               dependencyVersions,
               database: 'mongodb' as const,
-              connectionString: `mongodb://localhost:27017/${name}`,
-              _: ['generate', 'connection']
+              connectionString: `mongodb://localhost:27017/${name}`
             },
             { cwd }
           )
@@ -87,7 +86,7 @@ describe('@feathersjs/cli', () => {
               path: 'path/to/test',
               authentication: true,
               type: 'mongodb',
-              _: ['generate', 'service']
+              schema: false
             },
             { cwd }
           )
@@ -104,11 +103,11 @@ describe('@feathersjs/cli', () => {
           getContext<ServiceGeneratorArguments>(
             {
               dependencyVersions,
-              name: 'Custom Service',
-              path: 'custom',
+              name: 'Custom',
+              path: 'customized',
               authentication: false,
               type: 'custom',
-              _: ['generate', 'service']
+              schema: 'typebox'
             },
             { cwd }
           )

diff --git a/packages/schema/src/index.ts b/packages/schema/src/index.ts
@@ -6,7 +6,7 @@ export * from './resolver'
 export * from './hooks'
 export * from './json-schema'
 
-export * as schemaHooks from './hooks'
+export * as hooks from './hooks'
 export * as jsonSchema from './json-schema'
 
 export type Infer<S extends { _type: any }> = S['_type']