@toa.io/extensions.exposition 1.0.0-alpha.291 → 1.0.0-alpha.292

package/schemas/annotation.cos.yaml

@@ -1,125 +0,0 @@
-properties:
-  class:
-    type: string
-  resources:
-    # `null` deploys the service without any, which every deployment has to state one way
-    # or the other — see `migrations/262.md`.
-    type: object
-    nullable: true
-    properties:
-      cpu:
-        type: array
-        items:
-          type: string
-        minItems: 2
-        maxItems: 2
-      memory:
-        type: array
-        items:
-          type: string
-        minItems: 2
-        maxItems: 2
-  annotations:
-    type: object
-    patternProperties:
-      ^.+$:
-        type: string
-  service:
-    type: object
-    properties:
-      annotations:
-        type: object
-        patternProperties:
-          ^.+$:
-            type: string
-  debug:
-    type: boolean
-  ip:
-    type: string
-    minLength: 1
-  bouncer:
-    type: object
-    properties:
-      attempts:
-        type: integer
-        minimum: 1
-      interval:
-        type: integer
-        minimum: 1
-    additionalProperties: false
-  protocol:
-    type: string
-    enum: [h1, h2c]
-  oauth:
-    type: object
-    properties:
-      authorize:
-        description: The absolute URL of the consent page the application serves
-        type: string
-        pattern: ^https?://
-      resources:
-        description: Paths a token may be restricted to
-        type: array
-        items:
-          type: string
-          pattern: ^/
-      scopes:
-        type: array
-        items:
-          type: string
-      trust:
-        description: Origins whose Client ID Metadata Documents may be read
-        type: array
-        items:
-          type: string
-          pattern: ^https://
-      registration:
-        type: string
-        enum: [open, closed]
-    required:
-      - authorize
-    additionalProperties: false
-  rpc:
-    description: JSON-RPC at `/.rpc`; writing it is what turns the endpoint on
-    type: object
-    properties:
-      batch:
-        description: Calls one request may carry
-        type: integer
-        minimum: 1
-    additionalProperties: false
-  mcp:
-    description: MCP at `/.mcp`; writing it is what turns the endpoint on
-    type: object
-    properties:
-      name:
-        description: What the server calls itself
-        type: string
-        minLength: 1
-      instructions:
-        description: What a model is told before it calls anything here
-        type: string
-      origins:
-        description: Browser origins the endpoint answers; none without it
-        type: array
-        items:
-          type: string
-          pattern: ^https?://
-      anonymous:
-        description: Whether the endpoint answers without a credential
-        type: boolean
-    required:
-      - name
-    additionalProperties: false
-  /: {}
-  authorities:
-    type: object
-    patternProperties:
-      ^.+$:
-        type: string
-type: object
-required:
-  - authorities
-dependencies:
-  bouncer:
-    - ip

package/schemas/call.cos.yaml

@@ -1,18 +0,0 @@
-description: One JSON-RPC call, as the envelope carries it
-properties:
-  jsonrpc:
-    const: '2.0'
-  method:
-    type: string
-    minLength: 1
-  params:
-    description: By name only, because `io:input` validates an object
-    type: object
-  id:
-    description: Absent makes the call a notification, which answers nothing
-    type: [string, number]
-required:
-  - jsonrpc
-  - method
-additionalProperties: false
-type: object

package/schemas/directive.cos.yaml

@@ -1,7 +0,0 @@
-properties:
-  family:
-    type: string
-  name:
-    type: string
-  value: {}
-type: object

package/schemas/method.cos.yaml

@@ -1,23 +0,0 @@
-properties:
-  verb:
-    type: string
-    pattern: ^(GET|HEAD|POST|PUT|PATCH|DELETE|LOCK|UNLOCK)$
-  mapping:
-    properties:
-      namespace:
-        type: string
-      component:
-        type: string
-      endpoint:
-        type: string
-      query:
-        $ref: query
-      paged:
-        type: boolean
-    additionalProperties: false
-    type: object
-  directives:
-    type: array
-    items:
-      $ref: directive
-type: object

package/schemas/node.cos.yaml

@@ -1,22 +0,0 @@
-properties:
-  protected:
-    type: boolean
-  isolated:
-    type: boolean
-  forward:
-    type: string
-  routes:
-    type: array
-    items:
-      $ref: route
-  methods:
-    type: array
-    items:
-      $ref: method
-  directives:
-    type: array
-    items:
-      $ref: directive
-  version:
-    type: string
-type: object

package/schemas/query.cos.yaml

@@ -1,31 +0,0 @@
-properties:
-  id:
-    type: string
-  criteria:
-    type: string
-  sort:
-    type: string
-  search:
-    type: boolean
-  sample:
-    type: integer
-  omit:
-    $ref: range
-  limit:
-    $ref: range
-  selectors:
-    type: array
-    items:
-      type: string
-  projection:
-    type: array
-    items:
-      type: string
-  parameters:
-    type: array
-    items:
-      type: string
-  deleted:
-    type: boolean
-nullable: true
-type: object

package/schemas/querystring.cos.yaml

@@ -1,19 +0,0 @@
-properties:
-  id:
-    type: string
-  criteria:
-    type: string
-  search:
-    type: string
-  sample:
-    type: number
-  sort:
-    type: string
-  omit:
-    type: number
-  limit:
-    type: number
-  version:
-    type: number
-additionalProperties: false
-type: object

package/schemas/range.cos.yaml

@@ -1,10 +0,0 @@
-properties:
-  range:
-    type: array
-    items:
-      type: number
-  value:
-    type: number
-type: object
-required:
-  - range

package/schemas/route.cos.yaml

@@ -1,6 +0,0 @@
-properties:
-  path:
-    type: string
-  node:
-    $ref: node
-type: object

package/source/Annotation.ts

@@ -1,89 +0,0 @@
-import type { Resources } from '@toa.io/operations'
-import type { Protocol } from './HTTP/index.js'
-
-export interface Annotation {
-  authorities: Record<string, string>
-
-  /**
-   * `h2c` requires an ingress controller that proxies cleartext HTTP/2 upstream.
-   * See `documentation/protocol.md`.
-   */
-  protocol?: Protocol
-  class?: string
-  resources?: Resources
-  annotations?: Record<string, string>
-
-  /** The Service, as opposed to the Ingress that `annotations` above describes. */
-  service?: { annotations?: Record<string, string> }
-
-  debug?: boolean
-
-  /** The header the client address is read from; the connection's without one. See `ip.md`. */
-  ip?: string
-
-  /** Failed authentications an address may make; none are metered unless set. See `identity.md`. */
-  bouncer?: Bouncer
-
-  /** The authorization server this context exposes; none is exposed without it. */
-  oauth?: OAuth
-
-  /** JSON-RPC at `/.rpc`; none is served without it. See `documentation/rpc.md`. */
-  rpc?: RPC
-
-  /** MCP at `/.mcp`; none is served without it. See `documentation/mcp.md`. */
-  mcp?: MCP
-  '/'?: object // parsed and validated by RTD.syntax.parse
-}
-
-export interface OAuth {
-  /**
-   * Where a client sends the user to consent. The one endpoint of the flow that needs a
-   * person, and so the one this extension does not serve: an application builds it.
-   */
-  authorize: string
-
-  /** Paths a token may be restricted to, each advertised as a protected resource. */
-  resources?: string[]
-
-  /** What a client may ask for. Each is a role, or a scope within one. */
-  scopes?: string[]
-
-  /** Origins whose Client ID Metadata Documents may be read. None are without it. */
-  trust?: string[]
-
-  /** Dynamic Client Registration, off unless opened. */
-  registration?: 'open' | 'closed'
-}
-
-export interface RPC {
-  /**
-   * Calls one request may carry, 32 by default. One request is one authentication and one
-   * reply however many calls it makes, so what a caller may ask for at once is bounded.
-   */
-  batch?: number
-}
-
-export interface MCP {
-  /** What the server calls itself, which a client shows a user. */
-  name: string
-
-  /** What a model is told before it calls anything here. */
-  instructions?: string
-
-  /**
-   * Browser origins the endpoint answers, which the revision requires against DNS rebinding.
-   * None are admitted without it; a request carrying no `Origin` is not a browser's.
-   */
-  origins?: string[]
-
-  /** Whether the endpoint answers without a credential. It does not unless it says so. */
-  anonymous?: boolean
-}
-
-export interface Bouncer {
-  /** what an address may fail at once, 20 by default */
-  attempts?: number
-
-  /** seconds it takes to earn them back, 60 by default */
-  interval?: number
-}

package/source/RTD/syntax/parse.test.ts

@@ -1,196 +0,0 @@
-import { describe, it } from 'node:test'
-import assert from 'node:assert/strict'
-
-import { parse } from './parse.js'
-
-describe('routes', () => {
-  it('should parse route', async () => {
-    const declaration = {
-      '/': {},
-      '/foo': {}
-    }
-
-    const node = parse(declaration)
-
-    assert.strictEqual(node.routes.length, 2)
-    assert.strictEqual(node.routes[0].path, '/')
-    assert.strictEqual(node.routes[1].path, '/foo')
-  })
-
-  it('should parse nested routes', async () => {
-    const declaration = {
-      '/': {
-        '/foo': {},
-        '/bar': {}
-      }
-    }
-
-    const node = parse(declaration)
-    const root = node.routes[0].node
-
-    assert.strictEqual(root.routes.length, 2)
-    assert.strictEqual(root.routes[0].path, '/foo')
-    assert.strictEqual(root.routes[1].path, '/bar')
-  })
-})
-
-describe('methods', () => {
-  it('should parse methods', () => {
-    const declaration = {
-      '/': {
-        GET: {
-          endpoint: 'observe'
-        }
-      }
-    }
-
-    const node = parse(declaration)
-    const root = node.routes[0].node
-
-    assert.strictEqual(root.methods.length, 1)
-    assert.strictEqual(root.methods[0].verb, 'GET')
-    assert.partialDeepStrictEqual(root.methods[0].mapping, { endpoint: 'observe' })
-  })
-
-  it('should parse endpoint shortcut', async () => {
-    const declaration = {
-      '/': {
-        GET: 'observe'
-      }
-    }
-
-    const node = parse(declaration)
-    const root = node.routes[0].node
-
-    assert.strictEqual(root.methods.length, 1)
-    assert.strictEqual(root.methods[0].verb, 'GET')
-    assert.partialDeepStrictEqual(root.methods[0].mapping, { endpoint: 'observe' })
-  })
-
-  it('should parse fq endpoint', async () => {
-    const declaration = {
-      '/': {
-        GET: 'dummies.dummy.observe'
-      }
-    }
-
-    const node = parse(declaration)
-    const root = node.routes[0].node
-
-    assert.strictEqual(root.methods.length, 1)
-    assert.strictEqual(root.methods[0].verb, 'GET')
-
-    assert.partialDeepStrictEqual(root.methods[0].mapping, {
-      namespace: 'dummies',
-      component: 'dummy',
-      endpoint: 'observe'
-    })
-  })
-
-  it('should parse fq endpoint within default namespace', async () => {
-    const declaration = {
-      '/': {
-        GET: 'dummy.observe'
-      }
-    }
-
-    const node = parse(declaration)
-    const root = node.routes[0].node
-
-    assert.strictEqual(root.methods.length, 1)
-    assert.strictEqual(root.methods[0].verb, 'GET')
-
-    assert.partialDeepStrictEqual(root.methods[0].mapping, {
-      namespace: 'default',
-      component: 'dummy',
-      endpoint: 'observe'
-    })
-  })
-
-  it('should parse directives', async () => {
-    const declaration = {
-      '/': {
-        GET: {
-          'auth:incept': 'id',
-          endpoint: 'observe'
-        }
-      }
-    }
-
-    const node = parse(declaration)
-    const root = node.routes[0].node
-
-    assert.deepStrictEqual(root.methods[0].directives, [
-      { family: 'auth', name: 'incept', value: 'id' }
-    ])
-  })
-})
-
-describe('directives', () => {
-  it('should parse shortcuts', async () => {
-    const declaration = {
-      '/': {
-        foo: 'baz'
-      }
-    }
-
-    const shortcuts = new Map<string, string>([['foo', 'dev:foo']])
-
-    const node = parse(declaration, shortcuts)
-    const root = node.routes[0].node
-
-    assert.strictEqual(root.directives.length, 1)
-    assert.strictEqual(root.directives[0].family, 'dev')
-    assert.strictEqual(root.directives[0].name, 'foo')
-    assert.strictEqual(root.directives[0].value, 'baz')
-  })
-})
-
-describe('validation', () => {
-  it('should throw on unknown key', async () => {
-    const declaration = { hello: 'world' }
-
-    assert.throws(
-      () => parse(declaration),
-      (error: any) => /RTD parse error: unknown key 'hello'/.test(error.message)
-    )
-  })
-
-  it('should throw on invalid mapping', async () => {
-    const declaration = {
-      '/': {
-        GET: {
-          endpoint: 'observe',
-          hello: 'world'
-        }
-      }
-    }
-
-    assert.throws(
-      () => parse(declaration),
-      (error: any) => /\/methods\/0\/mapping/.test(error.message)
-    )
-  })
-})
-
-it('should expand ranges', async () => {
-  const declaration = {
-    '/': {
-      GET: {
-        endpoint: 'enumerate',
-        query: {
-          omit: 3,
-          limit: 2
-        }
-      }
-    }
-  }
-
-  const node = parse(declaration)
-  const query = node.routes[0].node.methods[0].mapping?.query
-
-  assert.partialDeepStrictEqual(query, {
-    omit: { value: 3, range: [3, 3] },
-    limit: { value: 2, range: [2, 2] }
-  })
-})