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

package/features/timing.feature

@@ -0,0 +1,69 @@
+Feature: Server timing
+
+  Background:
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          POST: create
+      """
+
+  Scenario: Server timing is not available by default
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the reply does not contain:
+      """
+      server-timing:
+      """
+
+  Scenario: Server timing is sent when `trace` is enabled
+    Given the annotation:
+      """
+      trace: true
+      """
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      """
+    # to debug, break it and look at the console
+    Then the following reply is sent:
+      """
+      201 Created
+      server-timing:
+      """
+
+  Scenario: Octets timing
+    Given the annotation:
+      """yaml
+      trace: true
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:store: ~
+      """
+    When the stream of `lenna.png` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-type: application/octet-stream
+      """
+    # to debug, break it and look at the console
+    Then the following reply is sent:
+      """
+      201 Created
+      server-timing:
+      """

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/extensions.exposition",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.200",
   "description": "Toa Exposition",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -17,40 +17,49 @@
     "access": "public"
   },
   "dependencies": {
-    "@toa.io/core": "1.0.0-alpha.2",
-    "@toa.io/generic": "1.0.0-alpha.2",
-    "@toa.io/schemas": "1.0.0-alpha.2",
-    "@toa.io/streams": "1.0.0-alpha.2",
+    "@aws-sdk/protocol-http": "3.370.0",
+    "@simplewebauthn/server": "13.1.1",
+    "@toa.io/core": "1.0.0-alpha.200",
+    "@toa.io/generic": "1.0.0-alpha.173",
+    "@toa.io/schemas": "1.0.0-alpha.200",
     "bcryptjs": "2.4.3",
-    "error-value": "0.3.0",
-    "express": "4.18.2",
-    "js-yaml": "4.1.0",
+    "error-value": "0.4.2",
+    "jose": "5.10.0",
+    "js-yaml": "4.1.1",
+    "lru-cache": "11.0.1",
     "matchacho": "0.3.5",
+    "minimatch": "10.2.1",
     "msgpackr": "1.10.1",
-    "negotiator": "0.6.3",
+    "negotiator": "0.6.4",
+    "openspan": "1.0.0-alpha.173",
     "paseto": "3.1.4"
   },
-  "jest": {
-    "preset": "ts-jest",
-    "testEnvironment": "node"
-  },
   "scripts": {
     "test": "jest",
-    "transpile": "tsc && npm run transpile:basic && npm run transpile:tokens && npm run transpile:roles && npm run transpile:federation",
+    "transpile": "tsc && npm run transpile:bans && npm run transpile:basic && npm run transpile:tokens && npm run transpile:roles && npm run transpile:federation && npm run transpile:keys && npm run transpile:passkeys && npm run transpile:otp",
+    "transpile:bans": "tsc -p ./components/identity.bans",
     "transpile:basic": "tsc -p ./components/identity.basic",
-    "pretranspile:federation": "js-yaml components/identity.federation/manifest.toa.yaml | jq -M '{ type: \"object\", properties: {configuration: .configuration.schema, entity: .entity.schema }, additionalProperties: false}' > schemas.json && json2ts -i schemas.json -o components/identity.federation/source/schemas.ts && rm schemas.json",
-    "transpile:federation": "tsc -p ./components/identity.federation",
     "transpile:tokens": "tsc -p ./components/identity.tokens",
     "transpile:roles": "tsc -p ./components/identity.roles",
-    "features": "cucumber-js"
+    "transpile:federation": "tsc -p ./components/identity.federation",
+    "transpile:keys": "tsc -p ./components/identity.keys",
+    "transpile:passkeys": "tsc -p ./components/identity.passkeys",
+    "transpile:otp": "tsc -p ./components/identity.otp",
+    "features": "cucumber-js",
+    "features:security": "cucumber-js --tags @security",
+    "features:octets": "cucumber-js features/octets.*"
   },
   "devDependencies": {
-    "@toa.io/agent": "1.0.0-alpha.2",
-    "@toa.io/extensions.storages": "1.0.0-alpha.2",
     "@types/bcryptjs": "2.4.3",
     "@types/cors": "2.8.13",
-    "@types/express": "4.17.17",
-    "@types/negotiator": "0.6.1"
+    "@types/negotiator": "0.6.1",
+    "jest-esbuild": "0.4.0"
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.ts$": "jest-esbuild"
+    },
+    "testEnvironment": "node"
   },
-  "gitHead": "7688e6e980a65c82ac2e459be4e355eebf406cd0"
+  "gitHead": "35b4adeedae2e9450ef44a74f42a53eff20ee203"
 }

package/readme.md

@@ -20,7 +20,8 @@ exposition:
 # context.toa.yaml
 
 exposition:
-  host: api.example.com
+  authorities:
+    example: api.example.com
 ```
 
 ```http
@@ -117,32 +118,36 @@ The Exposition annotation declares options for its deployment.
 ```yaml
 annotations:
   '@toa.io/extensions.exposition':
-    host: the.exmaple.com
+    authorities:
+      example: the.example.com
 ```
 
 A shortcut is also available.
 
 ```yaml
 exposition:
-  host: the.example.com
+  authorities:
+    example: the.example.com
 ```
 
-| Option        | Type      | Description                                                      |
-|---------------|-----------|------------------------------------------------------------------|
-| `host`        | `string`  | Domain name to be used for the corresponding Kubernetes Ingress. |
-| `class`       | `string`  | Ingress class                                                    |
-| `annotations` | `object`  | Ingress annotations                                              |
-| `debug`       | `boolean` | Output server errors. Default `false`.                           |
+| Option        | Description                                                                                                       |
+|---------------|-------------------------------------------------------------------------------------------------------------------|
+| `auhorities`  | Mapping of authority identifiers to domain names. See [Authorities](documentation/authorities.md).                |
+| `class`       | Ingress class.                                                                                                    |
+| `annotations` | Ingress annotations.                                                                                              |
+| `debug`       | Output server errors. Default `false`.                                                                            |
+| `trace`       | Output [server timing](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing). Default `false`. |
 
 ### Context resources
 
-Exposition annotaion can contain [resource declaration](documentation/tree.md) under the `/` key.
+Exposition annotation can contain [resource declaration](documentation/tree.md) under the `/` key.
 
 ```yaml
 # context.toa.yaml
 
 exposition:
-  host: the.example.com
+  authorities:
+    example: the.example.com
   /:
     /code:
       GET:
@@ -161,8 +166,9 @@ If component resource branch conflicts with an annotation, the annotation takes
 
 ```yaml
 exposition:
-  host: the.example.com
-  host@staging: the.example.dev
+  authorities:
+    example: the.example.com
+    example@staging: the.example.dev
   class: alb
   debug@staging: true
   annotations:

package/schemas/annotation.cos.yaml

@@ -1,5 +1,13 @@
-host: string
+authorities*: <string>
 class: string
+resources:
+  cpu: &constraint
+    type: array
+    items: { type: string }
+    minItems: 2
+    maxItems: 2
+  memory: *constraint
 annotations: <string>
 debug: boolean
+trace: boolean
 /: ~

package/schemas/io/input.cos.yaml

@@ -0,0 +1,3 @@
+type: array
+items:
+  type: string

package/schemas/io/message.cos.yaml

@@ -0,0 +1,5 @@
+oneOf:
+  - type: object
+  - type: array
+    items:
+      type: object

package/schemas/io/output.cos.yaml

@@ -0,0 +1,5 @@
+oneOf:
+  - type: boolean
+  - type: array
+    items:
+      type: string

package/schemas/io/throttle.cos.yaml

@@ -0,0 +1,36 @@
+definitions:
+  component: &component
+    type: string
+    enum: [ip, path]
+  condition: &condition
+    type: object
+    properties:
+      status:
+        type: number
+type: object
+properties:
+  key:
+    anyOf:
+      - *component
+      - type: array
+        items: *component
+        minItems: 1
+  condition:
+    anyOf:
+      - *condition
+      - type: array
+        items: *condition
+        minItems: 1
+  requests:
+    type: integer
+    minimum: 1
+  interval: &interval
+    description: Seconds
+    type: integer
+    minimum: 1
+  cooldown: *interval
+required:
+  - key
+  - requests
+  - interval
+  - cooldown

package/schemas/method.cos.yaml

@@ -1,8 +1,9 @@
-verb: /^(GET|POST|PUT|PATCH|DELETE)$/
+verb: /^(GET|HEAD|POST|PUT|PATCH|DELETE|LOCK|UNLOCK)$/
 mapping:
   namespace: string
   component: string
   endpoint: string
   query:
     $ref: query
+  ...: false
 directives: [ref:directive]

package/schemas/node.cos.yaml

@@ -1,5 +1,7 @@
 protected: boolean
 isolated: boolean
+forward: string
 routes: [ref:route]
 methods: [ref:method]
 directives: [ref:directive]
+version: string

package/schemas/octets/put.cos.yaml

@@ -0,0 +1,28 @@
+type: object
+nullable: true
+properties:
+  location:
+    type: string
+  accept:
+    anyOf:
+      - type: string
+      - type: array
+        items:
+          type: string
+  limit:
+    type: string
+    pattern: ^(\d+(\.\d+)?)([kmgtKMBGT]i?)?[bB]?$
+  trust:
+    type: array
+    items:
+      type: string
+  workflow:
+    anyOf:
+      - &unit
+        type: object
+        patternProperties:
+          ^.+$:
+            type: string
+      - type: array
+        items: *unit
+additionalProperties: false

package/schemas/octets/workflow.cos.yaml

@@ -0,0 +1,12 @@
+definitions:
+  unit:
+    type: object
+    patternProperties:
+      ^[a-zA-Z0-9_]+$:
+        type: string
+
+oneOf:
+  - $ref: '#/definitions/unit'
+  - type: array
+    items:
+      $ref: '#/definitions/unit'

package/schemas/query.cos.yaml

@@ -1,17 +1,13 @@
-_: true
 id?: string
 criteria?: string
 sort?: string
-omit:
+search?: boolean
+sample?: integer
+omit?:
   $ref: range
-  default:
-    value: 0
-    range: [0, 1000]
-limit:
+limit?:
   $ref: range
-  default:
-    value: 10
-    range: [1, 1000]
-  required: [value]
 selectors?: [string]
 projection?: [string]
+parameters?: [string]
+_: true

package/schemas/querystring.cos.yaml

@@ -1,5 +1,7 @@
 id: string
 criteria: string
+search: string
 sort: string
 omit: number
 limit: number
+version: number

package/source/Annotation.ts

@@ -1,7 +1,11 @@
+import type { Resources } from '@toa.io/operations'
+
 export interface Annotation {
-  host?: string
+  authorities: Record<string, string>
   class?: string
+  resources?: Resources
   annotations?: Record<string, string>
-  debug: boolean
+  debug?: boolean
+  trace?: boolean
   '/'?: object // parsed and validated by RTD.syntax.parse
 }

package/source/Branch.ts

@@ -5,4 +5,5 @@ export interface Branch {
   component: string
   isolated: boolean
   node: RTD.Node
+  version: string
 }

package/source/Composition.ts

@@ -18,12 +18,6 @@ export class Composition extends Connector {
     await composition.connect()
 
     this.depends(composition)
-
-    console.info('Composition complete.')
-  }
-
-  protected override dispose (): void {
-    console.info('Composition shutdown complete.')
   }
 }
 

package/source/Context.ts

@@ -1,6 +1,9 @@
-import { type Endpoint } from './Endpoint'
-import { type Directives } from './Directive'
-import { type Branch } from './Branch'
 import type * as RTD from './RTD'
 
-export type Context = RTD.Context<Endpoint, Directives, Branch>
+export type Context = RTD.Context<Extension>
+
+interface Extension {
+  namespace: string
+  component: string
+  version: string
+}

package/source/Directive.test.ts

@@ -1,24 +1,26 @@
 import assert from 'node:assert'
 import { generate } from 'randomstring'
-import { DirectivesFactory, type Family } from './Directive'
-import { type syntax } from './RTD'
-import { type IncomingMessage } from './HTTP'
-import { type Remotes } from './Remotes'
+import { DirectivesFactory } from './Directive'
+import type { syntax, DirectiveFamily } from './RTD'
+import type { Remotes } from './Remotes'
+import type { Context } from './HTTP'
 
-const families: Array<jest.MockedObjectDeep<Family>> = [
+const families: Array<jest.MockedObjectDeep<DirectiveFamily>> = [
   {
     name: 'foo',
     mandatory: true,
     create: jest.fn((_0: any, _1: any, _2: any) => generate() as any),
     preflight: jest.fn(),
-    settle: jest.fn()
+    settle: jest.fn(),
+    dispose: jest.fn()
   },
   {
     name: 'bar',
     mandatory: false,
     create: jest.fn((_0: string, _1: any, _2: any) => generate() as any),
     preflight: jest.fn(),
-    settle: jest.fn()
+    settle: jest.fn(),
+    dispose: jest.fn()
   }
 ]
 
@@ -65,7 +67,7 @@ it('should throw error if directive family is not found', async () => {
   }
 
   expect(() => factory.create([declaration]))
-    .toThrowError(`Directive family '${declaration.family}' is not found.`)
+    .toThrow(`Directive family '${declaration.family}' is not found`)
 })
 
 it('should apply directive', async () => {
@@ -76,7 +78,7 @@ it('should apply directive', async () => {
   }
 
   const directives = factory.create([declaration])
-  const request = generate() as unknown as IncomingMessage
+  const request = generate() as unknown as Context
   const directive = families[0].create.mock.results[0].value
 
   await directives.preflight(request, [])
@@ -89,7 +91,7 @@ it('should apply directive', async () => {
 
 it('should apply mandatory families', async () => {
   const directives = factory.create([])
-  const request = generate() as unknown as IncomingMessage
+  const request = generate() as unknown as Context
 
   await directives.preflight(request, [])
 

package/source/Directive.ts

@@ -1,49 +1,55 @@
-import type { IncomingMessage, OutgoingMessage } from './HTTP'
+import type { Context, OutgoingMessage } from './HTTP'
 import type { Remotes } from './Remotes'
 import type { Output } from './io'
 import type * as RTD from './RTD'
 
-export class Directives implements RTD.Directives<Directives> {
-  private readonly sets: DirectiveSet[]
+export class Directives implements RTD.Directives {
+  private readonly sets: RTD.DirectiveSet[]
 
-  public constructor (sets: DirectiveSet[]) {
+  public constructor (sets: RTD.DirectiveSet[]) {
     this.sets = sets
   }
 
-  public async preflight (request: IncomingMessage, parameters: RTD.Parameter[]): Promise<Output> {
+  public async preflight (context: Context, parameters: RTD.Parameter[]): Promise<Output> {
+    let output = null
+
     for (const set of this.sets) {
       if (set.family.preflight === undefined)
         continue
 
-      const output = await set.family.preflight(set.directives, request, parameters)
+      const out = await set.family.preflight(set.directives, context, parameters)
 
-      if (output !== null) {
-        await this.settle(request, output)
+      if (out === null)
+        continue
 
-        return output
-      }
+      if (output !== null)
+        throw new Error('Multiple preflight directives responded')
+      else
+        output = out
     }
 
-    return null
+    return output
   }
 
-  public async settle (request: IncomingMessage, response: OutgoingMessage): Promise<void> {
+  public async settle (context: Context, response: OutgoingMessage): Promise<void> {
     for (const set of this.sets)
       if (set.family.settle !== undefined)
-        await set.family.settle(set.directives, request, response)
+        await set.family.settle(set.directives, context, response)
   }
 
-  public merge (directives: Directives): void {
-    this.sets.push(...directives.sets)
+  public dispose (): void {
+    for (const set of this.sets)
+      set.family.dispose?.(set.directives)
   }
 }
 
-export class DirectivesFactory implements RTD.DirectivesFactory<Directives> {
-  private readonly remtoes: Remotes
-  private readonly families: Record<string, Family> = {}
+export class DirectivesFactory implements RTD.DirectiveFactory {
+  private readonly remotes: Remotes
+  private readonly families: Record<string, RTD.DirectiveFamily> = {}
   private readonly mandatory: string[] = []
+  private readonly instances: Directives[] = []
 
-  public constructor (families: Family[], remotes: Remotes) {
+  public constructor (families: RTD.DirectiveFamily[], remotes: Remotes) {
     for (const family of families) {
       this.families[family.name] = family
 
@@ -51,7 +57,7 @@ export class DirectivesFactory implements RTD.DirectivesFactory<Directives> {
         this.mandatory.push(family.name)
     }
 
-    this.remtoes = remotes
+    this.remotes = remotes
   }
 
   public create (declarations: RTD.syntax.Directive[]): Directives {
@@ -65,16 +71,16 @@ export class DirectivesFactory implements RTD.DirectivesFactory<Directives> {
       const family = this.families[declaration.family]
 
       if (family === undefined)
-        throw new Error(`Directive family '${declaration.family}' is not found.`)
+        throw new Error(`Directive family '${declaration.family}' is not found`)
 
-      const directive = family.create(declaration.name, declaration.value, this.remtoes)
+      const directive = family.create(declaration.name, declaration.value, this.remotes)
 
       groups[family.name] ??= []
       groups[family.name].push(directive)
       mandatory.delete(family.name)
     }
 
-    const sets: DirectiveSet[] = []
+    const sets: RTD.DirectiveSet[] = []
 
     for (const family of mandatory)
       sets.push({
@@ -88,36 +94,27 @@ export class DirectivesFactory implements RTD.DirectivesFactory<Directives> {
         directives
       })
 
-    return new Directives(sets)
+    const directives = new Directives(sets)
+
+    this.instances.push(directives)
+
+    return directives
+  }
+
+  public dispose (): void {
+    for (const directives of this.instances)
+      directives.dispose()
   }
 }
 
 export const shortcuts: RTD.syntax.Shortcuts = new Map([
   ['anonymous', 'auth:anonymous'],
+  ['anyone', 'auth:anyone'],
   ['id', 'auth:id'],
   ['role', 'auth:role'],
   ['rule', 'auth:rule'],
-  ['incept', 'auth:incept']
+  ['incept', 'auth:incept'],
+  ['input', 'io:input'],
+  ['output', 'io:output'],
+  ['languages', 'map:languages']
 ])
-
-export interface Family<TDirective = any, TExtension = any> {
-  readonly name: string
-  readonly mandatory: boolean
-
-  // produce: (declarations: RTD.syntax.Directive[], remotes: Remotes) => TDirective[]
-
-  create: (name: string, value: any, remotes: Remotes) => TDirective
-
-  preflight?: (directives: TDirective[],
-    request: IncomingMessage & TExtension,
-    parameters: RTD.Parameter[]) => Output | Promise<Output>
-
-  settle?: (directives: TDirective[],
-    request: IncomingMessage & TExtension,
-    response: OutgoingMessage) => void | Promise<void>
-}
-
-interface DirectiveSet {
-  family: Family
-  directives: any[]
-}