@feathersjs/typebox/src/default-schemas.ts

TypeBox integration for @feathersjs/schema

import { Type, Static } from '@sinclair/typebox'

export const authenticationSettingsSchema = Type.Object({
  secret: Type.String({ description: 'The JWT signing secret' }),
  entity: Type.Optional(
    Type.Union([
      Type.String({ description: 'The name of the authentication entity (e.g. user)' }),
      Type.Null()
    ])
  ),
  entityId: Type.Optional(Type.String({ description: 'The name of the authentication entity id property' })),
  service: Type.Optional(Type.String({ description: 'The path of the entity service' })),
  authStrategies: Type.Array(Type.String(), {
    description: 'A list of authentication strategy names that are allowed to create JWT access tokens'
  }),
  parseStrategies: Type.Optional(
    Type.Array(Type.String(), {
      description:
        'A list of authentication strategy names that should parse HTTP headers for authentication information (defaults to `authStrategies`)'
    })
  ),
  jwtOptions: Type.Optional(Type.Object({})),
  jwt: Type.Optional(
    Type.Object({
      header: Type.String({ default: 'Authorization', description: 'The HTTP header containing the JWT' }),
      schemes: Type.String({ description: 'An array of schemes to support' })
    })
  ),
  local: Type.Optional(
    Type.Object({
      usernameField: Type.String({ description: 'Name of the username field (e.g. `email`)' }),
      passwordField: Type.String({ description: 'Name of the password field (e.g. `password`)' }),
      hashSize: Type.Optional(Type.Number({ description: 'The BCrypt salt length' })),
      errorMessage: Type.Optional(Type.String({ description: 'The error message to return on errors' })),
      entityUsernameField: Type.Optional(
        Type.String({
          description:
            'Name of the username field on the entity if authentication request data and entity field names are different'
        })
      ),
      entityPasswordField: Type.Optional(
        Type.String({
          description:
            'Name of the password field on the entity if authentication request data and entity field names are different'
        })
      )
    })
  ),
  oauth: Type.Optional(
    Type.Object({
      redirect: Type.Optional(Type.String()),
      origins: Type.Optional(Type.Array(Type.String())),
      defaults: Type.Optional(
        Type.Object({
          key: Type.Optional(Type.String()),
          secret: Type.Optional(Type.String())
        })
      )
    })
  )
})

export const sqlSettingsSchema = Type.Optional(
  Type.Object({
    client: Type.String(),
    connection: Type.Union([
      Type.String(),
      Type.Partial(
        Type.Object({
          host: Type.String(),
          port: Type.Number(),
          user: Type.String(),
          password: Type.String(),
          database: Type.String()
        })
      )
    ]),
    pool: Type.Optional(
      Type.Object({
        min: Type.Number(),
        max: Type.Number()
      })
    )
  })
)

export const defaultAppConfiguration = Type.Object(
  {
    authentication: Type.Optional(authenticationSettingsSchema),
    paginate: Type.Optional(
      Type.Object(
        {
          default: Type.Number(),
          max: Type.Number()
        },
        { additionalProperties: false }
      )
    ),
    origins: Type.Optional(Type.Array(Type.String())),
    mongodb: Type.Optional(Type.String()),
    mysql: sqlSettingsSchema,
    postgresql: sqlSettingsSchema,
    sqlite: sqlSettingsSchema,
    mssql: sqlSettingsSchema
  },
  { $id: 'ApplicationConfiguration', additionalProperties: false }
)

export type DefaultAppConfiguration = Static<typeof defaultAppConfiguration>