Vendor-Free Flexibility for Modern APIs

// The Function
import { APIFunction } from './vramework/types' 
const getTodo: APIFunction<{ todoId: string }, Todo> = async (
  services,
  data,
  userSession
) => {
  // This method doesn't exist to make it easier to read
  return await getTodo(services.database, data.todoId)
}

// The Wiring
import { addRoute } from '@vramework/core'
addRoute({
  method: 'get',
  route: '/todo/:todoId',
  func: getTodo,
  permissions: {
    isTodoCreator: [isTodoCreator, withinAPILimits],
    isAdmin
  },
  auth: true,
  docs: {
    errors: [NotFoundError],
    description: 'Updates a todo',
    tags: ['todos']
  }
})

// Scheduled Task Function
const expireTodos: APIFunctionSessionless<void, void> = async (services) => {
  services.logger.info('Expiring all todos')
}

// Scheduled Task Wiring
import { addScheduledTask } from '@vramework/core'

addScheduledTask({
  name: 'expireTodos',
  schedule: '*/1 * * * *',
  func: expireTodos,
  docs: {
    tags: ['todos'],
  },
})

// The Functions
const onConnect: ChannelConnection<'hello!'> = async (
  services,
  channel
) => {
  services.logger.info('A channel has been established')
  channel.send('hello!')
}

const onDisconnect: ChannelDisconnection = async (services, channel) => {
  services.logger.info('A channel has been ended')
}
  
export const authenticate: ChannelMessage<
  { token: string; userId: string },
  { authResult: boolean; action: 'auth' }
> = async (services, channel, data) => {
  const authResult = data.token === 'valid'
  if (authResult) {
    await channel.setUserSession({ userId: data.userId })
  }
  return { authResult, action: 'auth' }
}

const onMessage: ChannelMessage<'hello', 'hey'> = async (
  services,
  channel
) => {
  services.logger.info('Got a generic hello message on callback')
  channel.send('hey')
}

// The Wiring 
addChannel({
  name: 'events',
  route: '/',
  onConnect,
  onDisconnect,
  auth: true,
  onMessage,
  onMessageRoute: {
    action: {
      auth: {
        func: authenticate,
        auth: false,
      },
    },
  },
})