@toa.io/norm 1.0.0-alpha.20 → 1.0.0-alpha.201

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/norm",
-  "version": "1.0.0-alpha.20",
+  "version": "1.0.0-alpha.201",
   "description": "Toa declarations normalization and validation",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -20,11 +20,10 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@toa.io/core": "1.0.0-alpha.20",
-    "@toa.io/generic": "1.0.0-alpha.20",
-    "@toa.io/schema": "1.0.0-alpha.20",
-    "@toa.io/schemas": "1.0.0-alpha.20",
-    "@toa.io/yaml": "1.0.0-alpha.20"
+    "@toa.io/core": "1.0.0-alpha.201",
+    "@toa.io/generic": "1.0.0-alpha.173",
+    "@toa.io/schemas": "1.0.0-alpha.200",
+    "@toa.io/yaml": "1.0.0-alpha.182"
   },
-  "gitHead": "dcde3389a86ab38e377ebc5ab18e5d5a512b85bc"
+  "gitHead": "e4955f36b0f2519516bc4be7c71e55a0e7cfdd44"
 }

package/src/.component/.expand/extensions.js

@@ -14,7 +14,8 @@ const SHORTCUTS = {
   configuration: '@toa.io/extensions.configuration',
   state: '@toa.io/extensions.state',
   stash: '@toa.io/extensions.stash',
-  storages: '@toa.io/extensions.storages'
+  storages: '@toa.io/extensions.storages',
+  mail: '@toa.io/extensions.mail'
 }
 
 exports.extensions = extensions

package/src/.component/.normalize/operations.js

@@ -4,7 +4,7 @@ const operations = (component) => {
   if (component.operations === undefined) return
 
   for (const [endpoint, operation] of Object.entries(component.operations)) {
-    if (operation.type === 'computation' || operation.type === 'effect')
+    if (operation.scope === 'none')
       operation.query = false
 
     if (operation.bindings === undefined) operation.bindings = component.bindings

package/src/.component/collapse.js

@@ -42,6 +42,11 @@ const collapse = (manifest, prototype) => {
     delete prototype.entity.schema.properties.id
   }
 
+  if (prototype.events !== undefined && manifest.events !== undefined)
+    for (const event of Object.keys(prototype.events))
+      if (event in manifest.events)
+        delete prototype.events[event]
+
   merge(manifest, { entity, events, extensions })
 }
 

package/src/.component/defaults.js

@@ -1,11 +1,13 @@
 'use strict'
 
 const { hash } = require('@toa.io/generic')
-const assert = require('node:assert')
 
 // these defaults are required before validation
-const defaults = (manifest) => {
-  if (manifest.name === undefined) manifest.name = protoName(manifest)
+const defaults = (manifest, proto) => {
+  if (manifest.name === undefined)
+    if (proto) manifest.name = protoName(manifest)
+    else nameAfterDir(manifest)
+
   if (manifest.bindings === undefined) manifest.bindings = ['@toa.io/bindings.amqp']
   if (manifest.bridge === undefined) manifest.bridge = '@toa.io/bridges.node'
 
@@ -24,4 +26,13 @@ function protoName (manifest) {
   return 'proto' + hash(manifest.path)
 }
 
+function nameAfterDir (manifest) {
+  const parts = manifest.path.split('/')
+  const dirname = parts[parts.length - 1]
+  const [name, namespace] = dirname.split('.').reverse()
+
+  manifest.name = name
+  manifest.namespace = namespace
+}
+
 exports.defaults = defaults

package/src/.component/dereference.js

@@ -25,7 +25,12 @@ const createResolver = (properties) => (property) => {
 function operations (manifest, resolver) {
   for (const operation of Object.values(manifest.operations)) {
     if (operation.input !== undefined) operation.input = schema(operation.input, resolver)
-    if (operation.output !== undefined) operation.output = schema(operation.output, resolver)
+
+    if (operation.output !== undefined)
+      if (Array.isArray(operation.output) && operation.output.length === 1)
+        operation.output = [schema(operation.output[0], resolver)]
+      else
+        operation.output = schema(operation.output, resolver)
   }
 
   // forwarding

package/src/.component/extensions.js

@@ -3,8 +3,13 @@
 const { directory: { find } } = require('@toa.io/filesystem')
 const { resolve } = require('../shortcuts')
 
+const cache = {}
+
 const extensions = (manifest) => {
-  if (manifest.extensions === undefined) return
+  if (manifest.extensions === undefined)
+    manifest.extensions = PREDEFINED
+  else
+    manifest.extensions = Object.assign({}, PREDEFINED, manifest.extensions)
 
   const extensions = manifest.extensions
 
@@ -14,7 +19,8 @@ const extensions = (manifest) => {
     // relative path
     if (key[0] === '.') key = find(key, manifest.path)
 
-    const extension = require(key)
+    cache[key] ??= require(key)
+    const extension = cache[key]
 
     if (extension.manifest !== undefined) {
       declaration = extension.manifest(declaration, manifest)
@@ -29,4 +35,8 @@ const extensions = (manifest) => {
   }
 }
 
+const PREDEFINED = {
+  '@toa.io/extensions.telemetry': null
+}
+
 exports.extensions = extensions

package/src/.component/merge.js

@@ -6,7 +6,8 @@ const bridge = async (root, manifest) => {
   await Promise.all([
     define(root, manifest, 'operations'),
     define(root, manifest, 'events'),
-    define(root, manifest, 'receivers')
+    define(root, manifest, 'receivers'),
+    define(root, manifest, 'guards')
   ])
 }
 
@@ -19,7 +20,7 @@ const define = async (root, manifest, property) => {
       if (item.bridge === undefined || item.bridge === manifest.bridge) continue // default bridge later
 
       const bridge = item.bridge || manifest.bridge
-      const { define } = require(bridge)
+      const define = req(bridge).define
       const definition = await define[singular](root, endpoint)
 
       merge(item, definition)
@@ -44,14 +45,27 @@ const define = async (root, manifest, property) => {
 
       const declared = manifest[property][endpoint]
 
-      if (declared === undefined) manifest[property][endpoint] = item
-      else merge(declared, item)
+      try {
+        if (declared === undefined) manifest[property][endpoint] = item
+        else merge(declared, item)
+      } catch (error) {
+        console.error(`Error merging ${singular} '${endpoint}' in ${root}`)
+        throw error
+      }
     }
   }
 }
 
+const cache = {}
+
+function req(mod) {
+  cache[mod] ??= require(mod)
+
+  return cache[mod]
+}
+
 const scan = async (bridge, root, property) => {
-  const { define } = require(bridge)
+  const define = req(bridge).define
 
   if (property in define)
     return define[property](root)

package/src/.component/schema.yaml

@@ -8,7 +8,7 @@ definitions:
   binding:
     type: string
     not:
-      const: '@toa.io/bindings.loop' # loop is for system use only
+      const: "@toa.io/bindings.loop" # loop is for system use only
 
 type: object
 properties:
@@ -17,19 +17,19 @@ properties:
     nullable: true
     properties:
       prototype:
-        $ref: '#/properties/prototype'
+        $ref: "#/properties/prototype"
       path:
         type: string
       operations:
         type: object
         propertyNames:
-          $ref: '#/definitions/name'
+          $ref: "#/definitions/name"
         patternProperties:
-          '.*':
+          ".*":
             type: object
             properties:
               bridge:
-                $ref: '#/properties/bridge'
+                $ref: "#/properties/bridge"
 
   path:
     type: string
@@ -38,19 +38,23 @@ properties:
     type: object
     properties:
       id:
-        $ref: 'definitions#/definitions/locator'
+        type: string
+        pattern: ^([a-zA-Z]+([_a-zA-Z0-9]*[a-zA-Z0-9]+)?)(\.([a-zA-Z]+([_a-zA-Z0-9]*[a-zA-Z0-9]+)?))$
       label:
-        $ref: 'definitions#/definitions/label'
+        type: string
+        pattern: ^([a-zA-Z]+([_a-zA-Z0-9]*[a-zA-Z0-9]+)?)(-([a-zA-Z]+([_a-zA-Z0-9]*[a-zA-Z0-9]+)?))*$
 
   name:
-    $ref: 'definitions#/definitions/token'
+    type: string
+    pattern: ^[a-zA-Z]([a-zA-Z0-9]{1,31})?$
 
   namespace:
-    $ref: 'definitions#/definitions/token'
-    default: 'default'
+    type: string
+    pattern: ^[a-zA-Z]([a-zA-Z0-9]{1,31})?$
+    default: "default"
     not:
       oneOf:
-        - const: 'system'
+        - const: "system"
 
   version:
     type: string
@@ -60,15 +64,17 @@ properties:
     properties:
       image:
         type: string
+      run:
+        type: string
 
   entity:
     type: object
     properties:
       storage:
         type: string
-        default: '@toa.io/storages.mongodb'
+        default: "@toa.io/storages.mongodb"
       schema:
-        $ref: 'definitions#/definitions/schema'
+        $ref: https://json-schema.org/draft/2019-09/schema
         type: object
         properties:
           type:
@@ -78,24 +84,24 @@ properties:
             type: object
             propertyNames:
               oneOf:
-                - $ref: '#/definitions/name'
+                - $ref: "#/definitions/name"
                 - enum: [_version, _created, _updated, _deleted]
       unique:
         type: object
         patternProperties:
-          '.*':
+          ".*":
             type: array
             items:
               type: string
       index:
         type: object
         patternProperties:
-          '.*':
+          ".*":
             type: object
             patternProperties:
-              '.*':
+              ".*":
                 type: string
-                enum: [asc, desc, hash]
+                enum: [asc, desc, hash, text]
       associated:
         type: boolean
         default: false
@@ -109,7 +115,7 @@ properties:
     type: array
     uniqueItems: true
     items:
-      $ref: '#/definitions/binding'
+      $ref: "#/definitions/binding"
 
   bridge:
     type: string
@@ -117,27 +123,40 @@ properties:
   operations:
     type: object
     propertyNames:
-      $ref: '#/definitions/name'
+      $ref: "#/definitions/name"
     patternProperties:
-      '.*':
+      ".*":
         type: object
         properties:
           type:
-            enum: [transition, observation, assignment, computation, effect]
+            enum:
+              [
+                transition,
+                observation,
+                assignment,
+                computation,
+                effect,
+                unmanaged,
+              ]
           scope:
-            enum: [object, objects, changeset, none]
+            enum: [object, objects, changeset, stream, none]
           concurrency:
             enum: [none, retry]
           forward:
-            $ref: '#/definitions/name'
+            $ref: "#/definitions/name"
           bridge:
             type: string
           bindings:
-            $ref: '#/properties/bindings'
+            $ref: "#/properties/bindings"
           input:
-            $ref: 'definitions#/definitions/schema'
+            $ref: https://json-schema.org/draft/2019-09/schema
           output:
-            $ref: 'definitions#/definitions/schema'
+            $ref: https://json-schema.org/draft/2019-09/schema
+            default: {}
+          errors:
+            type: array
+            items:
+              type: string
           query:
             type: boolean
         required: [type, scope, bindings]
@@ -149,8 +168,8 @@ properties:
             then:
               properties:
                 scope:
-                  enum: [object]
-              if: # transition query: false
+                  enum: [object, objects]
+              if: # not query: false
                 not:
                   properties:
                     query:
@@ -158,6 +177,17 @@ properties:
                   required: [query]
               then:
                 required: [concurrency]
+          - if: # transition and scope=objects
+              properties:
+                type:
+                  const: transition
+                scope:
+                  const: objects
+            then:
+              properties:
+                query:
+                  not:
+                    const: false
           - if: # not transition
               not:
                 properties:
@@ -174,7 +204,7 @@ properties:
             then:
               properties:
                 scope:
-                  enum: [object, objects, none]
+                  enum: [object, objects, stream, none]
                 query:
                   not:
                     const: false
@@ -189,7 +219,7 @@ properties:
           - if: # computation
               properties:
                 type:
-                  const: computation
+                  enum: [computation, unmanaged]
             then:
               properties:
                 scope:
@@ -205,20 +235,17 @@ properties:
             then:
               properties:
                 scope:
-                  const: none
                   default: none
-                query:
-                  const: false
-                  default: false
+                  enum: [object, objects, stream, none]
         additionalProperties: false
     additionalProperties: false
 
   events:
     type: object
     propertyNames:
-      $ref: 'definitions#/definitions/name'
+      $ref: "#/definitions/name"
     patternProperties:
-      '.*':
+      ".*":
         type: object
         properties:
           bridge:
@@ -226,7 +253,7 @@ properties:
           path:
             type: string
           binding:
-            $ref: '#/definitions/binding'
+            $ref: "#/definitions/binding"
           conditioned:
             type: boolean
             default: false
@@ -239,17 +266,17 @@ properties:
   receivers:
     type: object
     patternProperties:
-      '.*':
+      ".*":
         type: object
         properties:
           operation:
-            $ref: 'definitions#/definitions/name'
+            $ref: "#/definitions/name"
           bridge:
             type: string
           binding:
             type: string
           source:
-            $ref: 'definitions#/definitions/name'
+            $ref: "#/definitions/name"
             not:
               const: context
           path:
@@ -260,9 +287,22 @@ properties:
           adaptive:
             type: boolean
             default: false
+          arguments:
+            type: array
         required: [operation]
         additionalProperties: false
 
+  guards:
+    type: object
+    patternProperties:
+      ".*":
+        type: object
+        properties:
+          bridge: { type: string }
+          path: { type: string }
+        required: [bridge, path]
+        additionalProperties: false
+
   extensions:
     type: object
 

package/src/.component/validate.js

@@ -3,15 +3,15 @@
 const path = require('node:path')
 
 const { load } = require('@toa.io/yaml')
-const { Schema } = require('@toa.io/schema')
+const schemas = require('@toa.io/schemas')
 
 const object = load.sync(path.resolve(__dirname, 'schema.yaml'))
-const schema = new Schema(object)
+const schema = schemas.schema(object)
 
 const validate = (manifest) => {
   const error = schema.fit(manifest)
 
-  if (error) throw new Error(error.message)
+  if (error) throw error
 
   if (manifest.events !== undefined) events(manifest)
   if (manifest.receivers !== undefined) receivers(manifest)
@@ -32,11 +32,11 @@ const receivers = (manifest) => {
     }
 
     if (!TYPES.has(manifest.operations[receiver.operation].type)) {
-      throw new Error(`Receiver '${locator}' must refer to an operation of one of the allowed types: ${Array.from(TYPES).join(', ')}`)
+      throw new Error(`Receiver '${locator}' must refer to an operation of the allowed types: ${Array.from(TYPES).join(', ')}`)
     }
   }
 }
 
-const TYPES = new Set(['transition', 'effect'])
+const TYPES = new Set(['transition', 'assignment', 'effect', 'unmanaged'])
 
 exports.validate = validate

package/src/.context/.dependencies/resolve.js

@@ -24,6 +24,15 @@ const resolve = (references, annotations) => {
     }
   }
 
+  for (const dependency of Object.keys(annotations)) {
+    const { module } = load(dependency)
+
+    if (!module.standalone || (dependency in dependencies))
+      continue
+
+    dependencies[dependency] = []
+  }
+
   return dependencies
 }
 

package/src/.context/schema.yaml

@@ -6,7 +6,8 @@ properties:
   version:
     type: string
   name:
-    $ref: 'definitions#/definitions/label'
+    type: string
+    pattern: ^([a-zA-Z]+([_a-zA-Z0-9]*[a-zA-Z0-9]+)?)(-([a-zA-Z]+([_a-zA-Z0-9]*[a-zA-Z0-9]+)?))*$
   description:
     type: string
   packages:
@@ -46,7 +47,7 @@ properties:
           - linux/amd64
           - linux/arm/v7
           - linux/arm64
-    required: [base, platforms]
+    # required: [base]
   compositions:
     type: array
     minItems: 1
@@ -54,14 +55,16 @@ properties:
       type: object
       properties:
         name:
-          $ref: 'definitions#/definitions/token'
+          type: string
+          pattern: ^[a-zA-Z]([a-zA-Z0-9]{1,31})?$
         image:
           type: string
         components:
           type: array
           minItems: 1
           items:
-            $ref: 'definitions#/definitions/locator'
+            type: string
+            pattern: ^([a-zA-Z]+([_a-zA-Z0-9]*[a-zA-Z0-9]+)?)(\.([a-zA-Z]+([_a-zA-Z0-9]*[a-zA-Z0-9]+)?))$
       required: [name, components]
   annotations:
     type: object

package/src/.context/validate.js

@@ -3,15 +3,12 @@
 const { resolve } = require('node:path')
 
 const { load } = require('@toa.io/yaml')
-const { Schema } = require('@toa.io/schema')
+const schemas = require('@toa.io/schemas')
 
 const path = resolve(__dirname, 'schema.yaml')
 const object = load.sync(path)
-const schema = new Schema(object)
+const schema = schemas.schema(object)
 
-/**
- * @param {toa.norm.context.Declaration} context
- */
 const validate = (context) => {
   schema.validate(context)
 }

package/src/component.js

@@ -20,7 +20,7 @@ const {
 const component = async (path) => {
   const manifest = await load(path)
 
-  normalize(manifest)
+  normalize(manifest, path)
   validate(manifest)
   extensions(manifest)
 
@@ -29,21 +29,21 @@ const component = async (path) => {
   return manifest
 }
 
-const load = async (path, base) => {
+const load = async (path, base, proto = false) => {
   if (base !== undefined) path = find(path, base, MANIFEST)
 
   const file = join(path, MANIFEST)
-  const manifest = /** @type {toa.norm.Component} */ await yaml(file) ?? {}
+  const manifest = await yaml(file) ?? {}
 
   manifest.path = path
 
-  defaults(manifest)
+  defaults(manifest, proto)
   await expand(manifest)
 
   await merge(path, manifest)
 
   if (manifest.prototype !== null) {
-    const prototype = await load(manifest.prototype, path)
+    const prototype = await load(manifest.prototype, path, true)
 
     collapse(manifest, prototype)
   }

package/src/shortcuts.js

@@ -50,7 +50,9 @@ const SHORTCUTS = {
   configuration: '@toa.io/extensions.configuration',
   origins: '@toa.io/extensions.origins',
   stash: '@toa.io/extensions.stash',
-  storages: '@toa.io/extensions.storages'
+  storages: '@toa.io/extensions.storages',
+  telemetry: '@toa.io/extensions.telemetry',
+  mail: '@toa.io/extensions.mail'
 }
 
 exports.recognize = recognize

package/test/component/validate.test.js

@@ -1,5 +1,3 @@
-// noinspection JSUnresolvedVariable
-
 'use strict'
 
 const clone = require('clone-deep')
@@ -20,13 +18,13 @@ it('should be ok', () => {
 it('should provide error', () => {
   manifest.foo = 'bar'
 
-  expect(() => validate(manifest)).toThrow(/must NOT have additional property/)
+  expect(() => validate(manifest)).toThrow()
 })
 
 it('should not have additional properties', () => {
   manifest.foo = 'bar'
 
-  expect(() => validate(manifest)).toThrow(/must NOT have additional property/)
+  expect(() => validate(manifest)).toThrow()
 })
 
 describe('namespace', () => {
@@ -83,13 +81,13 @@ describe('entity', () => {
 
   it('should not have additional properties', () => {
     manifest.entity.foo = 'bar'
-    expect(() => validate(manifest)).toThrow(/must NOT have additional property/)
+    expect(() => validate(manifest)).toThrow()
   })
 
   describe('schema', () => {
     it('should be required', () => {
       delete manifest.entity.schema
-      expect(() => validate(manifest)).toThrow(/must have required property/)
+      expect(() => validate(manifest)).toThrow()
     })
 
     it('should be JSON schema object', () => {
@@ -99,7 +97,7 @@ describe('entity', () => {
 
     it('should be JSON schema object of type object', () => {
       manifest.entity.schema = { type: 'integer' }
-      expect(() => validate(manifest)).toThrow(/must be equal to constant 'object'/)
+      expect(() => validate(manifest)).toThrow(/must be equal to constant/)
 
       manifest.entity.schema = {}
       validate(manifest)
@@ -154,7 +152,7 @@ describe('operations', () => {
 
   it('should not have additional properties', () => {
     manifest.operations.get.foo = 'bar'
-    expect(() => validate(manifest)).toThrow(/additional property/)
+    expect(() => validate(manifest)).toThrow()
   })
 
   it('should have type (transition or observation)', () => {
@@ -176,8 +174,7 @@ describe('operations', () => {
   })
 
   it.each([
-    ['computation', 'compute'],
-    ['effect', 'affect']
+    ['computation', 'compute']
   ])('should set query: false for %s', async (_, operation) => {
     validate(manifest)
 
@@ -250,7 +247,7 @@ describe('receivers', () => {
   it('should throw if transition points to observation', () => {
     manifest.receivers['foo.bar.happened'].operation = 'get'
 
-    expect(() => validate(manifest)).toThrow(/one of the allowed types/)
+    expect(() => validate(manifest)).toThrow(/of the allowed types/)
   })
 
   it('should throw if source has a name `context`', async () => {

package/test/context/validate.test.js

@@ -45,12 +45,6 @@ describe('registry', () => {
     expect(() => validate(context)).toThrow(/required property 'registry'/)
   })
 
-  it('should require base', () => {
-    delete context.registry.base
-
-    expect(() => validate(context)).toThrow(/required property 'base'/)
-  })
-
   it('should set default platforms', () => {
     delete context.registry.platforms