@toa.io/extensions.exposition 1.0.0-alpha.3 → 1.0.0-alpha.5

package/source/RTD/Method.ts

@@ -1,14 +1,11 @@
-import { type Directives } from './Directives'
-import { type Endpoint } from './Endpoint'
+import type { Endpoint } from './Endpoint'
+import type { Directives } from './Directives'
 
-export class Method<
-  TEndpoint extends Endpoint<TEndpoint> = any,
-  TDirectives extends Directives<TDirectives> = any
-> {
-  public readonly endpoint: TEndpoint | null
-  public readonly directives: TDirectives
+export class Method {
+  public readonly endpoint: Endpoint | null
+  public readonly directives: Directives
 
-  public constructor (endpoint: TEndpoint | null, directives: TDirectives) {
+  public constructor (endpoint: Endpoint | null, directives: Directives) {
     this.endpoint = endpoint
     this.directives = directives
   }
@@ -18,7 +15,4 @@ export class Method<
   }
 }
 
-export type Methods<
-  TEndpoint extends Endpoint<TEndpoint> = any,
-  TDirectives extends Directives<TDirectives> = any
-> = Record<string, Method<TEndpoint, TDirectives>>
+export type Methods = Record<string, Method>

package/source/RTD/Node.ts

@@ -1,20 +1,15 @@
 import { type Route } from './Route'
 import { type Methods } from './Method'
 import { type Match, type Parameter } from './Match'
-import { type Directives } from './Directives'
-import { type Endpoint } from './Endpoint'
 
-export class Node<
-  TEndpoint extends Endpoint<TEndpoint> = any,
-  TDirectives extends Directives<TDirectives> = any
-> {
+export class Node {
   public intermediate: boolean
-  public methods: Methods<TEndpoint, TDirectives>
+  public methods: Methods
   private readonly protected: boolean
   private routes: Route[]
 
   public constructor
-  (routes: Route[], methods: Methods<TEndpoint, TDirectives>, properties: Properties) {
+  (routes: Route[], methods: Methods, properties: Properties) {
     this.routes = routes
     this.methods = methods
     this.protected = properties.protected
@@ -34,26 +29,30 @@ export class Node<
     return null
   }
 
-  public merge (node: Node<TEndpoint, TDirectives>): void {
+  public merge (node: Node): void {
     this.intermediate = node.intermediate
 
-    if (!this.protected) this.replace(node)
-    else this.append(node)
+    if (!this.protected)
+      this.replace(node)
+    else
+      this.append(node)
 
     this.sort()
   }
 
-  private replace (node: Node<TEndpoint, TDirectives>): void {
+  private replace (node: Node): void {
     const methods = Object.values(this.methods)
 
     this.routes = node.routes
     this.methods = node.methods
 
     for (const method of methods)
-      void method.close() // race condition is really unlikely
+      void method.close()
+
+    // race condition is really unlikely
   }
 
-  private append (node: Node<TEndpoint, TDirectives>): void {
+  private append (node: Node): void {
     for (const route of node.routes)
       this.mergeRoute(route)
 

package/source/RTD/Tree.ts

@@ -1,32 +1,32 @@
-import { type Node } from './Node'
 import { createNode } from './factory'
 import { fragment } from './segment'
-import { type Match } from './Match'
-import { type Context } from './Context'
-import { type Directives, type DirectivesFactory } from './Directives'
-import { type Endpoint, type EndpointsFactory } from './Endpoint'
+import type { Node } from './Node'
+import type { Match } from './Match'
+import type { Context } from './Context'
+import type { DirectiveFactory } from './Directives'
+import type { EndpointsFactory } from './Endpoint'
 import type * as syntax from './syntax'
 
-export class Tree<
-  TEndpoint extends Endpoint<TEndpoint> = any,
-  TDirectives extends Directives<TDirectives> = any
-> {
+export class Tree {
   private readonly root: syntax.Node
-  private readonly trunk: Node<TEndpoint, TDirectives>
-  private readonly endpoints: EndpointsFactory<TEndpoint>
-  private readonly directives: DirectivesFactory
+  private readonly trunk: Node
+  private readonly endpoints: EndpointsFactory
+  private readonly directives: DirectiveFactory
 
   public constructor
-  (node: syntax.Node, endpoints: EndpointsFactory, directives: DirectivesFactory) {
+  (node: syntax.Node, endpoints: EndpointsFactory, directives: DirectiveFactory) {
     this.endpoints = endpoints
     this.directives = directives
     this.trunk = this.createNode(node, PROTECTED)
     this.root = node
   }
 
-  public match (path: string): Match<TEndpoint, TDirectives> | null {
+  public match (path: string): Match | null {
     if (path === '/')
-      return { node: this.trunk, parameters: [] }
+      return {
+        node: this.trunk,
+        parameters: []
+      }
 
     const fragments = fragment(path)
 
@@ -39,7 +39,8 @@ export class Tree<
     this.trunk.merge(branch)
   }
 
-  private createNode (node: syntax.Node, protect: boolean, extension?: any): Node {
+  private createNode
+  (node: syntax.Node, protect: boolean, extension?: any): Node {
     const context: Context = {
       protected: protect,
       endpoints: this.endpoints,

package/source/RTD/factory.ts

@@ -1,14 +1,11 @@
 import { Node, type Properties } from './Node'
 import { Route } from './Route'
-import { type Context } from './Context'
 import { segment } from './segment'
 import { Method, type Methods } from './Method'
-import { type Endpoint } from './Endpoint'
-import { type Directives } from './Directives'
+import type { Context } from './Context'
 import type * as syntax from './syntax'
 
-export function createNode<TEndpoint extends Endpoint, TDirectives extends Directives>
-(node: syntax.Node, context: Context): Node<TEndpoint, TDirectives> {
+export function createNode (node: syntax.Node, context: Context): Node {
   if (node.isolated === true)
     context.directives.stack = node.directives
   else

package/source/deployment.ts

@@ -41,6 +41,12 @@ export function deployment (_: unknown, annotation: Annotation | undefined): Dep
       value: '1'
     })
 
+  if (annotation?.trace === true)
+    service.variables.push({
+      name: 'TOA_EXPOSITION_TRACE',
+      value: '1'
+    })
+
   if (annotation !== undefined)
     schemas.annotaion.validate(annotation)
 

package/source/directives/auth/Anonymous.ts

@@ -8,7 +8,8 @@ export class Anonymous implements Directive {
   }
 
   public authorize (_: any, input: Input): boolean {
-    if ('authorization' in input.headers) return false
-    else return this.allow
+    return 'authorization' in input.request.headers
+      ? false
+      : this.allow
   }
 }

package/source/directives/auth/Authorization.ts

@@ -13,8 +13,7 @@ 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 } from '../../Directive'
-import type { Parameter } from '../../RTD'
+import type { Parameter, DirectiveFamily } from '../../RTD'
 import type {
   AuthenticationResult,
   Ban,
@@ -27,7 +26,7 @@ import type {
   Schemes
 } from './types'
 
-export class Authorization implements Family<Directive, Extension> {
+export class Authorization implements DirectiveFamily<Directive, Extension> {
   public readonly depends: string[] = ['Vary']
   public readonly name: string = 'auth'
   public readonly mandatory: boolean = true
@@ -56,7 +55,7 @@ export class Authorization implements Family<Directive, Extension> {
   public async preflight (directives: Directive[],
     input: Input,
     parameters: Parameter[]): Promise<Output> {
-    const identity = await this.resolve(input.headers.authorization)
+    const identity = await this.resolve(input.request.headers.authorization)
 
     input.identity = identity
 
@@ -67,8 +66,10 @@ export class Authorization implements Family<Directive, Extension> {
         return directive.reply?.(identity) ?? null
     }
 
-    if (identity === null) throw new http.Unauthorized()
-    else throw new http.Forbidden()
+    if (identity === null)
+      throw new http.Unauthorized()
+    else
+      throw new http.Forbidden()
   }
 
   public async settle (directives: Directive[],

package/source/directives/auth/Incept.ts

@@ -15,28 +15,33 @@ export class Incept implements Directive {
   }
 
   public authorize (identity: Identity | null, input: Input): boolean {
-    return identity === null && 'authorization' in input.headers
+    return identity === null && 'authorization' in input.request.headers
   }
 
-  public async settle (request: Input, response: http.OutgoingMessage): Promise<void> {
+  public async settle (input: Input, response: http.OutgoingMessage): Promise<void> {
     const id = response.body?.[this.property]
 
     if (id === undefined)
       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!)
+    const [scheme, credentials] = split(input.request.headers.authorization!)
     const provider = PROVIDERS[scheme]
 
     this.schemes[scheme] ??= await this.discovery[provider]
 
     const identity = await this.schemes[scheme]
-      .invoke<Maybe<Identity>>('create', { input: { id, credentials } })
+      .invoke<Maybe<Identity>>('create', {
+      input: {
+        id,
+        credentials
+      }
+    })
 
     if (identity instanceof Error)
       throw new http.Conflict(identity)
 
-    request.identity = identity
-    request.identity.scheme = scheme
+    input.identity = identity
+    input.identity.scheme = scheme
   }
 }

package/source/directives/auth/Role.ts

@@ -14,10 +14,12 @@ export class Role implements Directive {
   public static async set (identity: Identity, discovery: Promise<Component>): Promise<void> {
     this.remote ??= await discovery
 
-    const query: Query = { criteria: `identity==${identity.id}`, limit: 1024 }
-    const roles: string[] = await this.remote.invoke('list', { query })
+    const query: Query = {
+      criteria: `identity==${identity.id}`,
+      limit: 1024
+    }
 
-    identity.roles = roles
+    identity.roles = await this.remote.invoke('list', { query })
   }
 
   public async authorize (identity: Identity | null): Promise<boolean> {

package/source/directives/auth/Scheme.ts

@@ -12,10 +12,10 @@ export class Scheme implements Directive {
   }
 
   public authorize (_: Identity | null, input: Input): boolean {
-    if (input.headers.authorization === undefined)
+    if (input.request.headers.authorization === undefined)
       return false
 
-    const [scheme] = split(input.headers.authorization)
+    const [scheme] = split(input.request.headers.authorization)
 
     if (scheme !== this.scheme)
       throw new http.Forbidden(this.Scheme +

package/source/directives/cache/Cache.ts

@@ -2,10 +2,10 @@ import { Control } from './Control'
 import { Exact } from './Exact'
 import type { Input, Output } from '../../io'
 import type { Directive } from './types'
-import type { Family } from '../../Directive'
+import type { DirectiveFamily } from '../../RTD'
 import type * as http from '../../HTTP'
 
-export class Cache implements Family<Directive> {
+export class Cache implements DirectiveFamily<Directive> {
   public readonly name: string = 'cache'
   public readonly mandatory: boolean = false
 
@@ -23,9 +23,9 @@ export class Cache implements Family<Directive> {
   }
 
   public async settle
-  (directives: Directive[], request: Input, response: http.OutgoingMessage): Promise<void> {
+  (directives: Directive[], input: Input, response: http.OutgoingMessage): Promise<void> {
     response.headers ??= new Headers()
-    directives[0]?.set(request, response.headers)
+    directives[0]?.set(input, response.headers)
   }
 }
 

package/source/directives/cache/Control.ts

@@ -1,5 +1,5 @@
 import { match } from 'matchacho'
-import type { AuthenticatedRequest, Directive } from './types'
+import type { AuthenticatedContext, Directive } from './types'
 
 export class Control implements Directive {
   protected readonly value: string
@@ -9,16 +9,16 @@ export class Control implements Directive {
     this.value = value
   }
 
-  public set (request: AuthenticatedRequest, headers: Headers): void {
-    if (!['GET', 'HEAD', 'OPTIONS'].includes(request.method))
+  public set (context: AuthenticatedContext, headers: Headers): void {
+    if (!['GET', 'HEAD', 'OPTIONS'].includes(context.request.method))
       return
 
-    this.cache ??= this.resolve(request)
+    this.cache ??= this.resolve(context)
 
     headers.set('cache-control', this.cache)
   }
 
-  protected resolve (request: AuthenticatedRequest): string {
+  protected resolve (request: AuthenticatedContext): string {
     if (request.identity === null)
       return this.value
 

package/source/directives/cache/types.ts

@@ -4,6 +4,6 @@ export interface Directive {
   set: (input: Input, headers: Headers) => void
 }
 
-export interface AuthenticatedRequest extends Input {
+export interface AuthenticatedContext extends Input {
   identity?: unknown | null
 }

package/source/directives/cors/CORS.ts

@@ -3,26 +3,32 @@ 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 requestHeaders = new Set<string>([
+    'accept',
+    'authorization',
+    'content-type',
+    'etag',
+    'if-match',
+    'if-none-match'
+  ])
 
   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-allow-headers': Array.from(this.requestHeaders).join(', '),
     'access-control-max-age': '3600',
-    'cache-control': 'public, max-age=3600',
+    'cache-control': 'max-age=3600',
     vary: 'origin'
   })
 
   public intercept (input: Input): Output {
-    const origin = input.headers.origin
+    const origin = input.request.headers.origin
 
     if (origin === undefined)
       return null
 
-    if (input.method === 'OPTIONS')
+    if (input.request.method === 'OPTIONS')
       return this.preflightResponse(origin)
 
     input.pipelines.response.push((output) => {
@@ -31,16 +37,18 @@ export class CORS implements Interceptor {
       output.headers.set('access-control-expose-headers',
         'authorization, content-type, content-length, etag')
 
-      if (input.method === 'GET' || input.method === 'HEAD' || input.method === 'OPTIONS')
+      const method = input.request.method
+
+      if (method === 'GET' || method === 'HEAD' || 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(', '))
+  public allow (header: string): void {
+    this.requestHeaders.add(header.toLowerCase())
+    this.headers.set('access-control-allow-headers', Array.from(this.requestHeaders).join(', '))
   }
 
   private preflightResponse (origin: string): Output {

package/source/directives/dev/Development.ts

@@ -2,13 +2,13 @@ import { Stub } from './Stub'
 import { Throw } from './Throw'
 import { type Directive } from './types'
 import type { Input, Output } from '../../io'
-import type { Family } from '../../Directive'
+import type { DirectiveFamily } from '../../RTD'
 
-export class Development implements Family<Directive> {
+export class Development implements DirectiveFamily<Directive> {
   public readonly name: string = 'dev'
   public readonly mandatory: boolean = false
 
-  public create (name: string, value: any): Directive {
+  public create (name: string, value: unknown): Directive {
     const Class = constructors[name]
 
     if (Class === undefined)

package/source/directives/index.ts

@@ -4,8 +4,8 @@ import { cache } from './cache'
 import { octets } from './octets'
 import { cors } from './cors'
 import { vary } from './vary'
-import type { Family } from '../Directive'
+import type { DirectiveFamily } from '../RTD'
 import type { Interceptor } from '../Interception'
 
-export const families: Family[] = [authorization, cache, octets, vary, dev]
+export const families: DirectiveFamily[] = [authorization, cache, octets, vary, dev]
 export const interceptors: Interceptor[] = [cors]

package/source/directives/octets/Context.ts

@@ -6,7 +6,7 @@ export class Context implements Directive {
   public readonly targeted = false
   public readonly storage: string
 
-  public constructor (value: any) {
+  public constructor (value: unknown) {
     schemas.context.validate(value)
 
     this.storage = value

package/source/directives/octets/Delete.ts

@@ -27,11 +27,16 @@ export class Delete implements Directive {
     this.discovery = discovery
   }
 
-  public async apply (storage: string, request: Input, parameters: Parameter[]): Promise<Output> {
+  public async apply (storage: string, input: Input, parameters: Parameter[]): Promise<Output> {
     this.storage ??= await this.discovery
 
     const entry = await this.storage.invoke<Maybe<Entry>>('get',
-      { input: { storage, path: request.url } })
+      {
+        input: {
+          storage,
+          path: input.request.url
+        }
+      })
 
     if (entry instanceof Error)
       throw new NotFound()
@@ -40,31 +45,36 @@ export class Delete implements Directive {
 
     if (this.workflow !== undefined) {
       output.status = 202
-      output.body = Readable.from(this.execute(request, storage, entry, parameters))
+      output.body = Readable.from(this.execute(input, storage, entry, parameters))
     } else
-      await this.delete(storage, request)
+      await this.delete(storage, input)
 
     return output
   }
 
-  private async delete (storage: string, request: Input): Promise<void> {
+  private async delete (storage: string, input: Input): Promise<void> {
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     await this.storage!.invoke('delete',
-      { input: { storage, path: request.url } })
+      {
+        input: {
+          storage,
+          path: input.request.url
+        }
+      })
   }
 
   // eslint-disable-next-line max-params
   private async * execute
-  (request: Input, storage: string, entry: Entry, parameters: Parameter[]): AsyncGenerator {
+  (input: Input, storage: string, entry: Entry, parameters: Parameter[]): AsyncGenerator {
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    for await (const chunk of this.workflow!.execute(request, storage, entry, parameters)) {
+    for await (const chunk of this.workflow!.execute(input, storage, entry, parameters)) {
       yield chunk
 
       if (typeof chunk === 'object' && chunk !== null && 'error' in chunk)
         return
     }
 
-    await this.delete(storage, request)
+    await this.delete(storage, input)
   }
 }
 

package/source/directives/octets/Fetch.ts

@@ -12,7 +12,11 @@ import type { Directive, Input } from './types'
 export class Fetch implements Directive {
   public readonly targeted = true
 
-  private readonly permissions: Required<Permissions> = { blob: true, meta: false }
+  private readonly permissions: Required<Permissions> = {
+    blob: true,
+    meta: false
+  }
+
   private readonly discovery: Promise<Component>
   private storage: Component = null as unknown as Component
 
@@ -23,30 +27,34 @@ export class Fetch implements Directive {
     this.discovery = discovery
   }
 
-  public async apply (storage: string, request: Input): Promise<Output> {
+  public async apply (storage: string, input: Input): Promise<Output> {
     this.storage ??= await this.discovery
 
-    const variant = posix.basename(request.url).includes('.')
-    const metadata = request.subtype === 'octets.entry'
+    const variant = posix.basename(input.request.url).includes('.')
+    const metadata = input.subtype === 'octets.entry'
 
     if (!variant && metadata)
       if (this.permissions.meta)
-        return this.get(storage, request)
+        return this.get(storage, input)
       else
         throw new Forbidden('Metadata is not accessible.')
 
     if (!variant && !this.permissions.blob)
       throw new Forbidden('BLOB variant must be specified.')
 
-    return await this.fetch(storage, request)
+    return await this.fetch(storage, input)
   }
 
-  private async fetch (storage: string, request: Input): Promise<Output> {
-    if ('if-none-match' in request.headers)
+  private async fetch (storage: string, input: Input): Promise<Output> {
+    if ('if-none-match' in input.request.headers)
       return { status: 304 }
 
-    const input = { storage, path: request.url }
-    const result = await this.storage.invoke<Maybe<FetchResult>>('fetch', { input })
+    const result = await this.storage.invoke<Maybe<FetchResult>>('fetch', {
+      input: {
+        storage,
+        path: input.request.url
+      }
+    })
 
     if (result instanceof Error)
       throw new NotFound()
@@ -57,12 +65,19 @@ export class Fetch implements Directive {
       etag: result.checksum
     })
 
-    return { headers, body: result.stream }
+    return {
+      headers,
+      body: result.stream
+    }
   }
 
-  private async get (storage: string, request: Input): Promise<Output> {
-    const input = { storage, path: request.url }
-    const entry = await this.storage.invoke<Maybe<Entry>>('get', { input })
+  private async get (storage: string, input: Input): Promise<Output> {
+    const entry = await this.storage.invoke<Maybe<Entry>>('get', {
+      input: {
+        storage,
+        path: input.request.url
+      }
+    })
 
     if (entry instanceof Error)
       throw new NotFound()

package/source/directives/octets/List.ts

@@ -22,22 +22,26 @@ export class List implements Directive {
     this.discovery = discovery
   }
 
-  public async apply (storage: string, request: Input): Promise<Output> {
+  public async apply (storage: string, input: Input): Promise<Output> {
     this.storage ??= await this.discovery
 
-    const metadata = request.subtype === 'octets.entries'
+    const metadata = input.subtype === 'octets.entries'
 
     if (metadata && !this.permissions.meta)
       throw new Forbidden('Metadata is not accessible.')
 
-    const input = { storage, path: request.url }
-    const list = await this.storage.invoke<Maybe<string[]>>('list', { input })
+    const list = await this.storage.invoke<Maybe<string[]>>('list', {
+      input: {
+        storage,
+        path: input.request.url
+      }
+    })
 
     if (list instanceof Error)
       throw new NotFound()
 
     const body = metadata
-      ? await this.expand(storage, request.url, list)
+      ? await this.expand(storage, input.request.url, list)
       : list
 
     return { body }
@@ -47,7 +51,11 @@ export class List implements Directive {
   Promise<Array<Maybe<Entry>>> {
     const promises = list.map(async (id) => {
       const path = posix.join(prefix, id)
-      const input = { storage, path }
+
+      const input = {
+        storage,
+        path
+      }
 
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- ensured in `apply`
       return this.storage!.invoke<Maybe<Entry>>('get', { input })