@toa.io/extensions.exposition 1.0.0-alpha.86 → 1.0.0-alpha.89

package/features/{octets.meta.feature → octets.attributes.feature}

@@ -1,6 +1,6 @@
-Feature: Octets `content-meta` header
+Feature: Octets `content-attributes` header
 
-  Scenario: Sending `content-meta` header
+  Scenario: Sending `content-attributes` header
     Given the `octets.tester` is running
     And the annotation:
       """yaml
@@ -10,19 +10,19 @@ Feature: Octets `content-meta` header
         octets:context: octets
         /*:
           POST:
-            octets:store: ~
+            octets:put: ~
           /*:
             GET:
-              octets:fetch:
+              octets:get:
                 meta: true
       """
     When the stream of `lenna.ascii` is received with the following headers:
       """
-      POST /meta-header/ HTTP/1.1
+      POST /attributes-header/ HTTP/1.1
       host: nex.toa.io
       content-type: application/octet-stream
-      content-meta: foo, bar=baz=1
-      content-meta: baz=1
+      content-attributes: foo, bar=baz=1
+      content-attributes: baz=1
       """
     Then the following reply is sent:
       """
@@ -30,7 +30,7 @@ Feature: Octets `content-meta` header
       """
     When the following request is received:
       """
-      GET /meta-header/10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      GET /attributes-header/10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
       host: nex.toa.io
       accept: application/vnd.toa.octets.entry+yaml
       """
@@ -41,19 +41,20 @@ Feature: Octets `content-meta` header
       id: 10cf16b458f759e0d617f2f3d83599ff
       type: application/octet-stream
       size: 8169
-      meta:
+      checksum: 10cf16b458f759e0d617f2f3d83599ff
+      attributes:
         foo: 'true'
         bar: baz=1
         baz: '1'
       """
 
-  Scenario: CORS allows `content-meta` header
+  Scenario: CORS allows `content-attributes` header
     Given the annotation:
       """yaml
       /:
         octets:context: octets
         POST:
-          octets:store: ~
+          octets:put: ~
       """
     When the following request is received:
       """
@@ -65,5 +66,5 @@ Feature: Octets `content-meta` header
       """
       204 No Content
       access-control-allow-origin: https://example.com
-      access-control-allow-headers: accept, authorization, content-type, etag, if-match, if-none-match, content-meta
+      access-control-allow-headers: accept, authorization, content-type, etag, if-match, if-none-match, content-attributes
       """

package/features/octets.cloudinary.feature

@@ -0,0 +1,68 @@
+Feature: Octets with Cloudinary storage
+
+  Background:
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: cloudinary
+        POST:
+          octets:put: ~
+        /*:
+          GET:
+            octets:get: ~
+          DELETE:
+            octets:delete: ~
+      """
+
+  Scenario: Upload an image
+    When the stream of `lenna.png` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      content-type: application/yaml
+
+      id: 814a0034f5549e957ee61360d87457e5
+      type: image/png
+      size: 473831
+      """
+    When the following request is received:
+      """
+      GET /814a0034f5549e957ee61360d87457e5 HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the stream equals to `lenna.png` is sent with the following headers:
+      """
+      200 OK
+      content-type: image/png
+      content-length: 473831
+      """
+
+  Scenario: Image transformations
+    When the stream of `lenna.png` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-type: image/png
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+    When the following request is received:
+      """
+      GET /814a0034f5549e957ee61360d87457e5.48x48.jpeg HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the stream equals to `lenna.48x48.jpeg` is sent with the following headers:
+      """
+      200 OK
+      content-type: image/jpeg
+      """

package/features/octets.download.feature

@@ -1,4 +1,4 @@
-Feature: Download and store
+Feature: Download external resources
 
   Scenario Outline: Download from trusted location defined as <type>
     Given the annotation:
@@ -8,13 +8,13 @@ Feature: Download and store
         auth:anonymous: true
         octets:context: octets
         POST:
-          octets:store:
+          octets:put:
             trust:
               - <location> # <type>
               - https://github.com
         /*:
           GET:
-            octets:fetch:
+            octets:get:
               meta: true
       """
 
@@ -143,7 +143,7 @@ Feature: Download and store
         auth:anonymous: true
         octets:context: octets
         POST:
-          octets:store:
+          octets:put:
             limit: 1kb
             trust:
               - https://avatars.githubusercontent.com
@@ -171,7 +171,7 @@ Feature: Download and store
         auth:anonymous: true
         octets:context: octets
         POST:
-          octets:store:
+          octets:put:
             limit: 1kb
             trust:
               - https://avatars.githubusercontent.com
@@ -185,5 +185,5 @@ Feature: Download and store
     Then the following reply is sent:
       """
       204 No Content
-      access-control-allow-headers: accept, authorization, content-type, etag, if-match, if-none-match, content-meta, content-location
+      access-control-allow-headers: accept, authorization, content-type, etag, if-match, if-none-match, content-attributes, content-location
       """

package/features/octets.entries.feature

@@ -1,6 +1,6 @@
-Feature: Accessing entries
+Feature: Accessing metadata
 
-  Scenario: Entries are not accessible by default
+  Scenario: Metadata is not accessible by default
     Given the annotation:
       """yaml
       /:
@@ -8,12 +8,10 @@ Feature: Accessing entries
         auth:anonymous: true
         octets:context: octets
         POST:
-          octets:store: ~
-        GET:
-          octets:list: ~
+          octets:put: ~
         /*:
           GET:
-            octets:fetch: ~
+            octets:get: ~
       """
     When the stream of `lenna.ascii` is received with the following headers:
       """
@@ -25,18 +23,6 @@ Feature: Accessing entries
       """
       201 Created
       """
-    When the following request is received:
-      """
-      GET / HTTP/1.1
-      host: nex.toa.io
-      accept: application/vnd.toa.octets.entries+yaml
-      """
-    Then the following reply is sent:
-      """
-      403 Forbidden
-
-      Metadata is not accessible.
-      """
     When the following request is received:
       """
       GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
@@ -47,10 +33,10 @@ Feature: Accessing entries
       """
       403 Forbidden
 
-      Metadata is not accessible.
+      Metadata is not accessible
       """
 
-  Scenario: Accessing entries
+  Scenario: Accessing metadata
     Given the annotation:
       """yaml
       /:
@@ -58,13 +44,10 @@ Feature: Accessing entries
         auth:anonymous: true
         octets:context: octets
         POST:
-          octets:store: ~
-        GET:
-          octets:list:
-            meta: true
+          octets:put: ~
         /*:
           GET:
-            octets:fetch:
+            octets:get:
               meta: true
       """
     When the stream of `lenna.ascii` is received with the following headers:
@@ -81,38 +64,6 @@ Feature: Accessing entries
       accept: application/yaml
       content-type: application/octet-stream
       """
-    When the following request is received:
-      """
-      GET / HTTP/1.1
-      host: nex.toa.io
-      accept: application/yaml
-      """
-    Then the following reply is sent:
-      """
-      200 OK
-      content-type: application/yaml
-
-      - 10cf16b458f759e0d617f2f3d83599ff
-      - 814a0034f5549e957ee61360d87457e5
-      """
-    When the following request is received:
-      """
-      GET / HTTP/1.1
-      host: nex.toa.io
-      accept: application/vnd.toa.octets.entries+yaml
-      """
-    Then the following reply is sent:
-      """
-      200 OK
-      content-type: application/yaml
-
-      - id: 10cf16b458f759e0d617f2f3d83599ff
-        size: 8169
-        type: application/octet-stream
-      - id: 814a0034f5549e957ee61360d87457e5
-        size: 473831
-        type: image/png
-      """
     When the following request is received:
       """
       GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1

package/features/octets.feature

@@ -8,39 +8,37 @@ Feature: Octets directive family
         auth:anonymous: true
         octets:context: octets
         POST:
-          octets:store: ~
-        GET:
-          octets:list: ~
+          octets:put: ~
         /*:
           GET:
-            octets:fetch: ~
+            octets:get: ~
           DELETE:
             octets:delete: ~
         /media:
           /jpeg:
             POST:
-              octets:store:
+              octets:put:
                 accept: image/jpeg
           /jpeg-or-png:
             POST:
-              octets:store:
+              octets:put:
                 accept:
                   - image/jpeg
                   - image/png
           /images:
             POST:
-              octets:store:
+              octets:put:
                 accept: image/*
             /*:
               GET:
-                octets:fetch: ~
+                octets:get: ~
         /limit-1kb:
           POST:
-            octets:store:
+            octets:put:
               limit: 1kb
         /limit-100kb:
           POST:
-            octets:store:
+            octets:put:
               limit: 100kb
       """
 
@@ -83,19 +81,6 @@ Feature: Octets directive family
       """
       304 Not Modified
       """
-    When the following request is received:
-      """
-      GET / HTTP/1.1
-      host: nex.toa.io
-      accept: application/yaml
-      """
-    Then the following reply is sent:
-      """
-      200 OK
-      content-type: application/yaml
-
-      - 10cf16b458f759e0d617f2f3d83599ff
-      """
     When the following request is received:
       """
       GET /10cf16b458f759e0d617f2f3d83599ff?foo=bar HTTP/1.1
@@ -260,40 +245,3 @@ Feature: Octets directive family
 
       Trailing slash is redundant.
       """
-
-  Scenario: Original BLOB is not accessible
-    Given the annotation:
-      """yaml
-      /:
-        io:output: true
-        auth:anonymous: true
-        octets:context: octets
-        POST:
-          octets:store: ~
-        /*:
-          GET:
-            octets:fetch:
-              meta: true
-              blob: false
-      """
-    When the stream of `lenna.ascii` is received with the following headers:
-      """
-      POST / HTTP/1.1
-      host: nex.toa.io
-      """
-    Then the following reply is sent:
-      """
-      201 Created
-      """
-    When the following request is received:
-      """
-      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
-      host: nex.toa.io
-      accept: text/plain
-      """
-    Then the following reply is sent:
-      """
-      403 Forbidden
-
-      BLOB variant must be specified.
-      """

package/features/octets.workflows.feature

@@ -13,7 +13,6 @@ Feature: Octets storage workflows
               - add-foo: octets.tester.foo
                 add-bar: octets.tester.bar
               - add-baz: octets.tester.baz
-              - diversify: octets.tester.diversify
         /*:
           io:output: true
           GET:
@@ -51,43 +50,8 @@ Feature: Octets storage workflows
 
       step: add-baz
       status: completed
-      --cut
-
-      step: diversify
-      output: hello
-      status: completed
       --cut--
       """
-    When the following request is received:
-      """
-      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
-      host: nex.toa.io
-      accept: application/vnd.toa.octets.entry+yaml
-      """
-    Then the following reply is sent:
-      """
-      200 OK
-      content-type: application/yaml
-
-      id: 10cf16b458f759e0d617f2f3d83599ff
-      type: application/octet-stream
-      size: 8169
-      meta:
-        foo: bar
-        bar: baz
-        baz: qux
-      """
-    When the following request is received:
-      """
-      GET /10cf16b458f759e0d617f2f3d83599ff.hello.png HTTP/1.1
-      host: nex.toa.io
-      """
-    Then the stream equals to `lenna.png` is sent with the following headers:
-      """
-      200 OK
-      content-type: image/png
-      content-length: 473831
-      """
 
   Scenario: Getting error when running workflow on `store`
     Given the `octets.tester` is running

package/features/steps/.env.example

@@ -0,0 +1,3 @@
+CLOUDINARY_ENVIRONMENT=
+TOA_STORAGES_CLOUDINARY_API_KEY=
+TOA_STORAGES_CLOUDINARY_API_SECRET=

package/features/steps/Parameters.ts

@@ -1,7 +1,11 @@
+import { join } from 'node:path'
+import * as dotenv from 'dotenv'
 import { setDefaultTimeout } from '@cucumber/cucumber'
 import { encode } from '@toa.io/generic'
 import { console } from 'openspan'
 
+dotenv.config({ path: join(__dirname, '.env') })
+
 export class Parameters {
   public readonly origin: string
 
@@ -20,5 +24,41 @@ process.env.TOA_STORAGES = encode({
   octets: {
     provider: 'tmp',
     directory: Math.random().toString(36).substring(2)
+  },
+  cloudinary: {
+    provider: 'cloudinary',
+    environment: process.env.CLOUDINARY_ENVIRONMENT ?? 'nope',
+    type: 'image',
+    prefix: 'toa-dev',
+    transformations: [
+      {
+        extension: '(?<width>\\d*)x(?<height>\\d*)(z(?<zoom>\\d*))?',
+        transformation: {
+          width: '<width>',
+          height: '<height>',
+          zoom: '<zoom>',
+          crop: 'thumb',
+          gravity: 'face'
+        },
+        optional: true
+      },
+      {
+        extension: '\\[(?<width>\\d*)x(?<height>\\d*)\\](z(?<zoom>\\d+))?',
+        transformation: {
+          width: '<width>',
+          height: '<height>',
+          zoom: '<zoom>',
+          crop: 'fit'
+        },
+        optional: true
+      },
+      {
+        extension: '(?<format>jpeg|webp)',
+        transformation: {
+          fetch_format: '<format>'
+        },
+        optional: true
+      }
+    ]
   }
 })

package/features/steps/components/octets.tester/manifest.toa.yaml

@@ -17,7 +17,6 @@ operations:
   err: *operation
   echo: *operation
   concat: *operation
-  diversify: *operation
   yield: *operation
   yex: *operation
   authority: *operation

package/features/steps/components/octets.tester/operations/bar.js

@@ -4,7 +4,6 @@ import { setTimeout } from 'node:timers/promises'
 
 async function bar (input, context) {
   await setTimeout(10)
-  await context.storages.octets.annotate(input.path, 'bar', 'baz')
 
   return { bar: 'baz' }
 }

package/features/steps/components/octets.tester/operations/baz.js

@@ -4,7 +4,6 @@ import { setTimeout } from 'node:timers/promises'
 
 async function baz (input, context) {
   await setTimeout(30)
-  await context.storages.octets.annotate(input.path, 'baz', 'qux')
 }
 
 exports.effect = baz

package/features/steps/components/octets.tester/operations/foo.js

@@ -1,7 +1,6 @@
 'use strict'
 
 async function foo (input, context) {
-  await context.storages.octets.annotate(input.path, 'foo', 'bar')
 }
 
 exports.effect = foo

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/extensions.exposition",
-  "version": "1.0.0-alpha.86",
+  "version": "1.0.0-alpha.89",
   "description": "Toa Exposition",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -52,11 +52,11 @@
     "@swc/core": "1.6.6",
     "@swc/helpers": "0.5.11",
     "@toa.io/agent": "1.0.0-alpha.79",
-    "@toa.io/extensions.storages": "1.0.0-alpha.86",
+    "@toa.io/extensions.storages": "1.0.0-alpha.89",
     "@types/bcryptjs": "2.4.3",
     "@types/cors": "2.8.13",
     "@types/negotiator": "0.6.1",
     "jest-esbuild": "0.3.0"
   },
-  "gitHead": "9379190c388da1327a70f23e0b6f3ae47f0724fb"
+  "gitHead": "2234ef78c649dbe51f9c68f11d720d34e666ab08"
 }

package/source/Endpoint.ts

@@ -113,7 +113,7 @@ export class Endpoint implements RTD.Endpoint {
     const match = etag.match(ETAG)
 
     if (match === null)
-      throw new http.BadRequest('Invalid ETag.')
+      throw new http.BadRequest('Invalid ETag')
 
     return Number.parseInt(match.groups!.version)
   }
@@ -128,14 +128,14 @@ export class EndpointsFactory implements RTD.EndpointsFactory {
 
   public create (method: RTD.syntax.Method, context: Context): Endpoint {
     if (method.mapping === undefined)
-      throw new Error('Cannot create Endpoint without mapping.')
+      throw new Error('Cannot create Endpoint without mapping')
 
     const mapping = Mapping.create(method.mapping.query)
     const namespace = method.mapping.namespace ?? context.extension.namespace
     const component = method.mapping.component ?? context.extension.component
 
     if (namespace === undefined || component === undefined)
-      throw new Error('Annotation endpoints must be fully qualified.')
+      throw new Error('Annotation endpoints must be fully qualified')
 
     const discovery = this.remotes.discover(namespace, component, context.extension.version)
 

package/source/HTTP/Server.ts

@@ -25,6 +25,10 @@ export class Server extends Connector {
     this.authorities = Object.fromEntries(Object.entries(properties.authorities).map(([key, value]) => [value, key]))
 
     this.server.on('request', (req, res) => this.listener(req, res))
+
+    if (this.properties.debug)
+      this.server.on('connection', (socket) =>
+        console.debug('Connected', { address: socket.remoteAddress }))
   }
 
   public static create (options: Options): Server {

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

@@ -148,7 +148,7 @@ describe('validation', () => {
   it('should throw on unknown key', async () => {
     const declaration = { hello: 'world' }
 
-    expect(() => parse(declaration)).toThrow('RTD parse error: unknown key \'hello\'.')
+    expect(() => parse(declaration)).toThrow('RTD parse error: unknown key \'hello\'')
   })
 
   it('should throw on invalid mapping', async () => {

package/source/directives/auth/Scheme.ts

@@ -19,7 +19,7 @@ export class Scheme implements Directive {
 
     if (scheme !== this.scheme)
       throw new http.Forbidden(this.Scheme +
-        ' authentication scheme is required to access this resource.')
+        ' authentication scheme is required to access this resource')
 
     return false
   }

package/source/directives/io/Output.ts

@@ -41,7 +41,7 @@ export class Output implements Directive {
 
       if (typeof message.body !== 'object' || this.permissions.length === 0) {
         if (this.omitted)
-          console.warn('Permissions for \'io:output\' are not specified properly. Response omitted.',
+          console.warn('Permissions for \'io:output\' are not specified properly, response omitted',
             { path: context.url.pathname })
 
         delete message.body

package/source/directives/octets/Delete.ts

@@ -32,20 +32,20 @@ export class Delete extends Directive {
   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: input.request.url
-        }
-      })
-
-    if (entry instanceof Error)
-      throw new NotFound()
-
     const output: Output = {}
 
     if (this.workflow !== undefined) {
+      const entry = await this.storage.invoke<Maybe<Entry>>('head',
+        {
+          input: {
+            storage,
+            path: input.request.url
+          }
+        })
+
+      if (entry instanceof Error)
+        throw new NotFound()
+
       output.status = 202
       output.body = Readable.from(this.execute(input, storage, entry, parameters))
     } else