@toa.io/extensions.exposition 1.0.0-alpha.0 → 1.0.0-alpha.2

package/source/HTTP/formats/msgpack.ts

@@ -1,13 +1,16 @@
 import { type Buffer } from 'node:buffer'
-import * as msgpack from 'msgpackr'
-
-export const type = 'application/msgpack'
-export const multipart = 'multipart/msgpack'
+import { pack, unpack } from 'msgpackr'
 
 export function decode (buffer: Buffer): any {
-  return msgpack.decode(buffer)
+  return unpack(buffer)
 }
 
 export function encode (value: any): Buffer {
-  return msgpack.encode(value)
+  if (typeof value === 'object' && value !== null)
+    Object.setPrototypeOf(value, null)
+
+  return pack(value)
 }
+
+export const type = 'application/msgpack'
+export const multipart = 'multipart/msgpack'

package/source/HTTP/formats/text.ts

@@ -7,6 +7,6 @@ export function decode (buffer: Buffer): any {
   return buffer.toString()
 }
 
-export function encode (value: any): Buffer {
+export function encode (value: { toString: () => string }): Buffer {
   return Buffer.from(value.toString())
 }

package/source/HTTP/formats/yaml.ts

@@ -11,7 +11,7 @@ export function decode (buffer: Buffer): any {
 }
 
 export function encode (value: any): Buffer {
-  const text = yaml.dump(value)
+  const text = yaml.dump(value, { lineWidth: -1, noRefs: true })
 
   return Buffer.from(text)
 }

package/source/HTTP/messages.ts

@@ -9,6 +9,11 @@ import type { Format } from './formats'
 
 export function write
 (request: IncomingMessage, response: Response, message: OutgoingMessage): void {
+  for (const transform of request.pipelines.response)
+    transform(message)
+
+  message.headers?.forEach((value, key) => response.set(key, value))
+
   if (message.body instanceof Readable)
     stream(message, request, response)
   else
@@ -36,7 +41,7 @@ export async function read (request: Request): Promise<any> {
 }
 
 function send (message: OutgoingMessage, request: IncomingMessage, response: Response): void {
-  if (message.body === undefined) {
+  if (message.body === undefined || message.body === null) {
     response.end()
 
     return
@@ -47,8 +52,10 @@ function send (message: OutgoingMessage, request: IncomingMessage, response: Res
 
   const buf = request.encoder.encode(message.body)
 
-  response.set('content-type', request.encoder.type)
-  response.end(buf)
+  response
+    .set('content-type', request.encoder.type)
+    .append('vary', 'accept')
+    .end(buf)
 }
 
 function stream
@@ -97,6 +104,11 @@ export interface IncomingMessage extends Request {
   query: Query
   parse: <T> () => Promise<T>
   encoder: Format | null
+  subtype: string | null
+  pipelines: {
+    body: Array<(input: unknown) => unknown>
+    response: Array<(output: OutgoingMessage) => void>
+  }
 }
 
 export interface OutgoingMessage {

package/source/Interception.ts

@@ -0,0 +1,24 @@
+import type { Input, Output } from './io'
+
+export class Interception implements Interceptor {
+  private readonly interceptors: Interceptor[]
+
+  public constructor (interceptors: Interceptor[]) {
+    this.interceptors = interceptors
+  }
+
+  public async intercept (input: Input): Promise<Output> {
+    for (const interceptor of this.interceptors) {
+      const output = await interceptor.intercept(input)
+
+      if (output !== null)
+        return output
+    }
+
+    return null
+  }
+}
+
+export interface Interceptor {
+  intercept: (input: Input) => Output | Promise<Output>
+}

package/source/RTD/Directives.ts

@@ -1,7 +1,7 @@
 import type * as syntax from './syntax'
 
-export interface Directives<T = any> {
-  merge: (directive: T) => void
+export interface Directives<TDirective = any> {
+  merge: (directive: TDirective) => void
 }
 
 export interface DirectivesFactory<T = any> {

package/source/RTD/Tree.ts

@@ -25,6 +25,9 @@ export class Tree<
   }
 
   public match (path: string): Match<TEndpoint, TDirectives> | null {
+    if (path === '/')
+      return { node: this.trunk, parameters: [] }
+
     const fragments = fragment(path)
 
     return this.trunk.match(fragments)

package/source/RTD/syntax/parse.ts

@@ -28,7 +28,7 @@ function parseNode (input: object, shortcuts?: Shortcuts): Node {
     }
 
     if (key[0] === '/') {
-      const route = parseRoute(key, value, shortcuts)
+      const route = parseRoute(key, value as Node, shortcuts)
 
       node.routes.push(route)
 
@@ -36,7 +36,7 @@ function parseNode (input: object, shortcuts?: Shortcuts): Node {
     }
 
     if (verbs.has(key)) {
-      const method = parseMethod(key, value, shortcuts)
+      const method = parseMethod(key, value as Mapping, shortcuts)
 
       node.methods.push(method)
 
@@ -65,7 +65,7 @@ export function createNode (): Node {
   }
 }
 
-function parseRoute (path: string, value: object, shortcuts?: Shortcuts): Route {
+function parseRoute (path: string, value: Node, shortcuts?: Shortcuts): Route {
   const node = parse(value, shortcuts)
 
   return createRoute(path, node)
@@ -106,10 +106,10 @@ function parseQuery (mapping: any): void {
     return
 
   if (typeof query.limit === 'number')
-    query.limit = expandRange(query.limit)
+    query.limit = expandRange(query.limit as number)
 
   if (typeof query.omit === 'number')
-    query.omit = expandRange(query.omit)
+    query.omit = expandRange(query.omit as number)
 }
 
 function parseDirectives (mapping: Record<string, any>, shortcuts?: Shortcuts): Directive[] {
@@ -132,7 +132,7 @@ function parseDirectives (mapping: Record<string, any>, shortcuts?: Shortcuts):
 
 function parseDirective (key: string, value: any, shortcuts?: Shortcuts): Directive | null {
   if (shortcuts?.has(key) === true)
-    key = shortcuts.get(key) as string
+    key = shortcuts.get(key)! // eslint-disable-line @typescript-eslint/no-non-null-assertion
 
   const match = key.match(DIRECTIVE_RX)
 

package/source/RTD/syntax/types.ts

@@ -45,4 +45,4 @@ export interface Range {
   range: [number, number]
 }
 
-export const verbs = new Set<string>(['GET', 'POST', 'PUT', 'PATCH', 'DELETE'])
+export const verbs = new Set<string>(['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'])

package/source/deployment.ts

@@ -27,8 +27,7 @@ export function deployment (_: unknown, annotation: Annotation | undefined): Dep
     }
 
   if (annotation?.['/'] !== undefined) {
-    const node = { '/': annotation['/'] }
-    const tree = parse(node, shortcuts)
+    const tree = parse(annotation['/'], shortcuts)
 
     service.variables.push({
       name: 'TOA_EXPOSITION',

package/source/directives/auth/{Family.ts → Authorization.ts}

@@ -1,3 +1,4 @@
+import assert from 'node:assert'
 import { match } from 'matchacho'
 import * as http from '../../HTTP'
 import { Anonymous } from './Anonymous'
@@ -9,9 +10,10 @@ import { Echo } from './Echo'
 import { split } from './split'
 import { Scheme } from './Scheme'
 import { PRIMARY, PROVIDERS } from './schemes'
+import type { Output } from '../../io'
 import type { Component } from '@toa.io/core'
 import type { Remotes } from '../../Remotes'
-import type { Family, Output } from '../../Directive'
+import type { Family } from '../../Directive'
 import type { Parameter } from '../../RTD'
 import type {
   AuthenticationResult,
@@ -25,7 +27,8 @@ import type {
   Schemes
 } from './types'
 
-class Authorization implements Family<Directive, Extension> {
+export class Authorization implements Family<Directive, Extension> {
+  public readonly depends: string[] = ['Vary']
   public readonly name: string = 'auth'
   public readonly mandatory: boolean = true
 
@@ -35,23 +38,24 @@ class Authorization implements Family<Directive, Extension> {
   private bans: Component | null = null
 
   public create (name: string, value: any, remotes: Remotes): Directive {
-    const Class = CLASSES[name]
+    assert.ok(name in CLASSES,
+      `Directive '${name}' is not provided by the '${this.name}' family.`)
 
-    if (Class === undefined)
-      throw new Error(`Directive '${name}' is not provided by the '${this.name}' family.`)
+    const Class = CLASSES[name]
 
     for (const name of REMOTES)
       this.discovery[name] ??= remotes.discover('identity', name)
 
     return match(Class,
-      Role, () => new Role(value, this.discovery.roles),
-      Rule, () => new Rule(value, this.create.bind(this)),
-      Incept, () => new Incept(value, this.discovery),
+      Role, () => new Role(value as string | string[], this.discovery.roles),
+      Rule, () => new Rule(value as Record<string, string>, this.create.bind(this)),
+      Incept, () => new Incept(value as string, this.discovery),
       () => new Class(value))
   }
 
-  public async preflight
-  (directives: Directive[], input: Input, parameters: Parameter[]): Promise<Output> {
+  public async preflight (directives: Directive[],
+    input: Input,
+    parameters: Parameter[]): Promise<Output> {
     const identity = await this.resolve(input.headers.authorization)
 
     input.identity = identity
@@ -67,37 +71,32 @@ class Authorization implements Family<Directive, Extension> {
     else throw new http.Forbidden()
   }
 
-  public async settle
-  (directives: Directive[], request: Input, response: http.OutgoingMessage): Promise<void> {
-    for (const directive of directives)
-      await directive.settle?.(request, response)
+  public async settle (directives: Directive[],
+    request: Input,
+    response: http.OutgoingMessage): Promise<void> {
+    for (const directive of directives) await directive.settle?.(request, response)
 
     const identity = request.identity
 
-    if (identity === null)
-      return
+    if (identity === null) return
 
-    if (identity.scheme === PRIMARY && !identity.refresh)
-      return
+    if (identity.scheme === PRIMARY && !identity.refresh) return
 
     // Role directive may have already set the value
-    if (identity.roles === undefined)
-      await Role.set(identity, this.discovery.roles)
+    if (identity.roles === undefined) await Role.set(identity, this.discovery.roles)
 
     this.tokens ??= await this.discovery.tokens
 
     const token = await this.tokens.invoke<string>('encrypt', { input: { identity } })
     const authorization = `Token ${token}`
 
-    if (response.headers === undefined)
-      response.headers = new Headers()
+    if (response.headers === undefined) response.headers = new Headers()
 
     response.headers.set('authorization', authorization)
   }
 
   private async resolve (authorization: string | undefined): Promise<Identity | null> {
-    if (authorization === undefined)
-      return null
+    if (authorization === undefined) return null
 
     const [scheme, credentials] = split(authorization)
     const provider = PROVIDERS[scheme]
@@ -107,16 +106,15 @@ class Authorization implements Family<Directive, Extension> {
 
     this.schemes[scheme] ??= await this.discovery[provider]
 
-    const result = await this.schemes[scheme]
-      .invoke<AuthenticationResult>('authenticate', { input: credentials })
+    const result = await this.schemes[scheme].invoke<AuthenticationResult>('authenticate', {
+      input: credentials
+    })
 
-    if (result instanceof Error)
-      return null
+    if (result instanceof Error) return null
 
     const identity = result.identity
 
-    if (scheme !== PRIMARY && await this.banned(identity))
-      throw new http.Unauthorized()
+    if (scheme !== PRIMARY && (await this.banned(identity))) throw new http.Unauthorized()
 
     identity.scheme = scheme
     identity.refresh = result.refresh
@@ -143,6 +141,4 @@ const CLASSES: Record<string, new (value: any, argument?: any) => Directive> = {
   echo: Echo
 }
 
-const REMOTES: Remote[] = ['basic', 'tokens', 'roles', 'bans']
-
-export = new Authorization()
+const REMOTES: Remote[] = ['basic', 'federation', 'tokens', 'roles', 'bans']

package/source/directives/auth/Incept.ts

@@ -25,7 +25,7 @@ export class Incept implements Directive {
       throw new http.Conflict('Identity inception has failed as the response body ' +
         ` does not contain the '${this.property}' property.`)
 
-    const [scheme, credentials] = split(request.headers.authorization as string)
+    const [scheme, credentials] = split(request.headers.authorization!)
     const provider = PROVIDERS[scheme]
 
     this.schemes[scheme] ??= await this.discovery[provider]

package/source/directives/auth/Rule.ts

@@ -1,5 +1,5 @@
 import { type Parameter } from '../../RTD'
-import { type Directive, type Identity } from './types'
+import type { Input, Directive, Identity } from './types'
 
 export class Rule implements Directive {
   private readonly directives: Directive[] = []
@@ -13,7 +13,7 @@ export class Rule implements Directive {
   }
 
   public async authorize
-  (identity: Identity | null, input: any, parameters: Parameter[]): Promise<boolean> {
+  (identity: Identity | null, input: Input, parameters: Parameter[]): Promise<boolean> {
     for (const directive of this.directives) {
       const authorized = await directive.authorize(identity, input, parameters)
 

package/source/directives/auth/index.ts

@@ -1,3 +1,3 @@
-import Family from './Family'
+import { Authorization } from './Authorization'
 
-export = Family
+export const authorization = new Authorization()

package/source/directives/auth/schemes.ts

@@ -2,7 +2,8 @@ import { type Remote, type Scheme } from './types'
 
 export const PROVIDERS: Record<Scheme, Remote> = {
   basic: 'basic',
-  token: 'tokens'
+  token: 'tokens',
+  bearer: 'federation'
 }
 
 export const PRIMARY: Scheme = 'token'

package/source/directives/auth/types.ts

@@ -2,11 +2,14 @@ import { type Component } from '@toa.io/core'
 import { type Maybe } from '@toa.io/types'
 import { type Parameter } from '../../RTD'
 import type * as http from '../../HTTP'
-import type * as directive from '../../Directive'
+import type * as io from '../../io'
 
 export interface Directive {
-  authorize: (identity: Identity | null, input: Input, parameters: Parameter[]) =>
-  boolean | Promise<boolean>
+  authorize: (
+    identity: Identity | null,
+    input: Input,
+    parameters: Parameter[],
+  ) => boolean | Promise<boolean>
 
   reply?: (identity: Identity | null) => http.OutgoingMessage
 
@@ -28,10 +31,10 @@ export interface Ban {
   banned: boolean
 }
 
-export type Input = directive.Input & Extension
+export type Input = io.Input & Extension
 export type AuthenticationResult = Maybe<{ identity: Identity, refresh: boolean }>
 
-export type Scheme = 'basic' | 'token'
-export type Remote = 'basic' | 'tokens' | 'roles' | 'bans'
+export type Scheme = 'basic' | 'token' | 'bearer'
+export type Remote = 'basic' | 'federation' | 'tokens' | 'roles' | 'bans'
 export type Discovery = Record<Remote, Promise<Component>>
 export type Schemes = Record<Scheme, Component>

package/source/directives/cache/{Family.ts → Cache.ts}

@@ -1,10 +1,11 @@
-import { type Input, type Output, type Family } from '../../Directive'
 import { Control } from './Control'
-import { type Directive } from './types'
 import { Exact } from './Exact'
+import type { Input, Output } from '../../io'
+import type { Directive } from './types'
+import type { Family } from '../../Directive'
 import type * as http from '../../HTTP'
 
-class Cache implements Family<Directive> {
+export class Cache implements Family<Directive> {
   public readonly name: string = 'cache'
   public readonly mandatory: boolean = false
 
@@ -32,5 +33,3 @@ const constructors: Record<string, new (value: any) => Directive> = {
   control: Control,
   exact: Exact
 }
-
-export = new Cache()

package/source/directives/cache/index.ts

@@ -1,3 +1,3 @@
-import Family from './Family'
+import { Cache } from './Cache'
 
-export = Family
+export const cache = new Cache()

package/source/directives/cache/types.ts

@@ -1,4 +1,4 @@
-import { type Input } from '../../Directive'
+import type { Input } from '../../io'
 
 export interface Directive {
   set: (input: Input, headers: Headers) => void

package/source/directives/cors/CORS.ts

@@ -0,0 +1,54 @@
+import type { Input, Output } from '../../io'
+import type { Interceptor } from '../../Interception'
+
+export class CORS implements Interceptor {
+  public readonly name = 'cors'
+  public readonly mandatory = true
+
+  private readonly allowedHeaders = new Set<string>(['accept', 'authorization', 'content-type'])
+
+  private readonly headers = new Headers({
+    'access-control-allow-methods': 'GET, POST, PUT, PATCH, DELETE',
+    'access-control-allow-credentials': 'true',
+    'access-control-allow-headers': Array.from(this.allowedHeaders).join(', '),
+    'access-control-max-age': '3600',
+    'cache-control': 'public, max-age=3600',
+    vary: 'origin'
+  })
+
+  public intercept (input: Input): Output {
+    const origin = input.headers.origin
+
+    if (origin === undefined)
+      return null
+
+    if (input.method === 'OPTIONS')
+      return this.preflightResponse(origin)
+
+    input.pipelines.response.push((output) => {
+      output.headers ??= new Headers()
+      output.headers.set('access-control-allow-origin', origin)
+      output.headers.set('access-control-expose-headers',
+        'authorization, content-type, content-length, etag')
+
+      if (input.method === 'GET' || input.method === 'HEAD' || input.method === 'OPTIONS')
+        output.headers.append('vary', 'origin')
+    })
+
+    return null
+  }
+
+  public allowHeader (header: string): void {
+    this.allowedHeaders.add(header.toLowerCase())
+    this.headers.set('access-control-allow-headers', Array.from(this.allowedHeaders).join(', '))
+  }
+
+  private preflightResponse (origin: string): Output {
+    this.headers.set('access-control-allow-origin', origin)
+
+    return {
+      status: 204,
+      headers: this.headers
+    }
+  }
+}

package/source/directives/cors/index.ts

@@ -0,0 +1,3 @@
+import { CORS } from './CORS'
+
+export const cors = new CORS()

package/source/directives/dev/{Family.ts → Development.ts}

@@ -1,9 +1,10 @@
-import { type Input, type Output, type Family } from '../../Directive'
 import { Stub } from './Stub'
 import { Throw } from './Throw'
 import { type Directive } from './types'
+import type { Input, Output } from '../../io'
+import type { Family } from '../../Directive'
 
-class Development implements Family<Directive> {
+export class Development implements Family<Directive> {
   public readonly name: string = 'dev'
   public readonly mandatory: boolean = false
 
@@ -32,5 +33,3 @@ const constructors: Record<string, new (value: any) => Directive> = {
   stub: Stub,
   throw: Throw
 }
-
-export = new Development()

package/source/directives/dev/Stub.ts

@@ -1,10 +1,10 @@
-import { type Output } from '../../Directive'
-import { type Directive } from './types'
+import type { Output } from '../../io'
+import type { Directive } from './types'
 
 export class Stub implements Directive {
-  private readonly value: any
+  private readonly value: unknown
 
-  public constructor (value: any) {
+  public constructor (value: unknown) {
     this.value = value
   }
 

package/source/directives/dev/Throw.ts

@@ -1,10 +1,10 @@
-import { type Output } from '../../Directive'
-import { type Directive } from './types'
+import type { Output } from '../../io'
+import type { Directive } from './types'
 
 export class Throw implements Directive {
-  private readonly message: any
+  private readonly message: string
 
-  public constructor (message: any) {
+  public constructor (message: string) {
     this.message = message
   }
 

package/source/directives/dev/index.ts

@@ -1,3 +1,3 @@
-import Family from './Family'
+import { Development } from './Development'
 
-export = Family
+export const dev = new Development()

package/source/directives/dev/types.ts

@@ -1,4 +1,4 @@
-import { type Input, type Output } from '../../Directive'
+import type { Input, Output } from '../../io'
 
 export interface Directive {
   apply: (input: Input) => Output

package/source/directives/index.ts

@@ -1,7 +1,11 @@
-import { type Family } from '../Directive'
-import Dev from './dev'
-import Auth from './auth'
-import Cache from './cache'
-import Octets from './octets'
+import { dev } from './dev'
+import { authorization } from './auth'
+import { cache } from './cache'
+import { octets } from './octets'
+import { cors } from './cors'
+import { vary } from './vary'
+import type { Family } from '../Directive'
+import type { Interceptor } from '../Interception'
 
-export const families: Family[] = [Auth, Octets, Dev, Cache]
+export const families: Family[] = [authorization, cache, octets, vary, dev]
+export const interceptors: Interceptor[] = [cors]

package/source/directives/octets/Context.ts

@@ -1,5 +1,5 @@
 import * as schemas from './schemas'
-import type { Output } from '../../Directive'
+import type { Output } from '../../io'
 import type { Directive } from './types'
 
 export class Context implements Directive {