@toa.io/norm 0.10.1-dev.0 → 0.20.0-dev.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/norm",
-  "version": "0.10.1-dev.0",
+  "version": "0.20.0-dev.10",
   "description": "Toa declarations normalization and validation",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -18,15 +18,12 @@
   "scripts": {
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
-  "devDependencies": {
-    "@toa.io/mock": "0.7.7-dev.0"
-  },
   "dependencies": {
-    "@toa.io/core": "0.8.1",
-    "@toa.io/generic": "0.9.0",
-    "@toa.io/schema": "0.7.3",
-    "@toa.io/schemas": "0.8.1",
-    "@toa.io/yaml": "0.7.3"
+    "@toa.io/core": "0.20.0-dev.10",
+    "@toa.io/generic": "0.20.0-dev.10",
+    "@toa.io/schema": "0.20.0-dev.10",
+    "@toa.io/schemas": "0.20.0-dev.10",
+    "@toa.io/yaml": "0.20.0-dev.10"
   },
-  "gitHead": "7f1fdbfe3aa33eb4a06cb1a33d15be18854bcd88"
+  "gitHead": "cd3ffb1ae1af014f13a62ef9fc8ada58d8688e4a"
 }

package/src/.component/.expand/receivers.js

@@ -6,7 +6,7 @@ function receivers (manifest) {
   if (manifest.receivers === undefined) return
 
   for (const [locator, receiver] of Object.entries(manifest.receivers)) {
-    if (typeof receiver === 'string') manifest.receivers[locator] = { transition: receiver }
+    if (typeof receiver === 'string') manifest.receivers[locator] = { operation: receiver }
 
     if (receiver.binding !== undefined) receiver.binding = resolve(receiver.binding)
     if (receiver.bridge !== undefined) receiver.bridge = resolve(receiver.bridge)

package/src/.component/defaults.js

@@ -1,19 +1,13 @@
 'use strict'
 
+const { hash } = require('@toa.io/generic')
+
 // these defaults are required before validation
 const defaults = (manifest) => {
   if (manifest.prototype === undefined) manifest.prototype = '@toa.io/prototype'
-
-  if (manifest.bindings === undefined) {
-    const local = process.env.TOA_DEV === '1'
-
-    manifest.bindings = local
-      ? ['@toa.io/bindings.amqp']
-      : ['@toa.io/bindings.http', '@toa.io/bindings.amqp']
-  }
-
+  if (manifest.name === undefined) manifest.name = protoName(manifest)
+  if (manifest.bindings === undefined) manifest.bindings = ['@toa.io/bindings.amqp']
   if (manifest.bridge === undefined) manifest.bridge = '@toa.io/bridges.node'
-
   if (manifest.entity === null || manifest.entity === undefined) manifest.entity = { storage: null }
   if (manifest.entity.storage === undefined) manifest.entity.storage = '@toa.io/storages.mongodb'
   if (manifest.entity.storage === null) manifest.entity.storage = '@toa.io/storages.null'
@@ -22,4 +16,8 @@ const defaults = (manifest) => {
   if (manifest.version === undefined) manifest.version = '0.0.0'
 }
 
+function protoName (manifest) {
+  return 'proto' + hash(manifest.path)
+}
+
 exports.defaults = defaults

package/src/.component/schema.yaml

@@ -20,7 +20,7 @@ properties:
       operations:
         type: object
         propertyNames:
-          $ref: 'definitions#/definitions/token'
+          $ref: 'definitions#/definitions/name'
         patternProperties:
           '.*':
             type: object
@@ -39,14 +39,15 @@ properties:
       label:
         $ref: 'definitions#/definitions/label'
 
+  name:
+    $ref: 'definitions#/definitions/token'
+
   namespace:
     $ref: 'definitions#/definitions/token'
     default: 'default'
     not:
       oneOf:
         - const: 'system'
-  name:
-    $ref: 'definitions#/definitions/token'
 
   version:
     $ref: 'definitions#/definitions/version'
@@ -67,12 +68,12 @@ properties:
             type: object
             propertyNames:
               oneOf:
-                - $ref: 'definitions#/definitions/token'
-                - enum: [ _version ]
+                - $ref: 'definitions#/definitions/name'
+                - enum: [_version]
       initialized:
         type: boolean
         default: false
-    required: [ schema ]
+    required: [schema]
     additionalProperties: false
 
   bindings:
@@ -88,19 +89,19 @@ properties:
   operations:
     type: object
     propertyNames:
-      $ref: 'definitions#/definitions/token'
+      $ref: 'definitions#/definitions/name'
     patternProperties:
       '.*':
         type: object
         properties:
           type:
-            enum: [ transition, observation, assignment, computation, effect ]
+            enum: [transition, observation, assignment, computation, effect]
           scope:
-            enum: [ object, objects, changeset, none ]
+            enum: [object, objects, changeset, none]
           concurrency:
-            enum: [ none, retry ]
+            enum: [none, retry]
           forward:
-            $ref: 'definitions#/definitions/token'
+            $ref: 'definitions#/definitions/name'
           bridge:
             type: string
           bindings:
@@ -111,7 +112,7 @@ properties:
             $ref: 'definitions#/definitions/schema'
           query:
             type: boolean
-        required: [ type, scope, bindings ]
+        required: [type, scope, bindings]
         allOf:
           - if: # transition
               properties:
@@ -120,15 +121,15 @@ properties:
             then:
               properties:
                 scope:
-                  enum: [ object ]
+                  enum: [object]
               if: # transition query: false
                 not:
                   properties:
                     query:
                       const: false
-                  required: [ query ]
+                  required: [query]
               then:
-                required: [ concurrency ]
+                required: [concurrency]
           - if: # not transition
               not:
                 properties:
@@ -145,7 +146,7 @@ properties:
             then:
               properties:
                 scope:
-                  enum: [ object, objects, none ]
+                  enum: [object, objects, none]
                 query:
                   not:
                     const: false
@@ -156,7 +157,7 @@ properties:
             then:
               properties:
                 scope:
-                  enum: [ changeset ]
+                  enum: [changeset]
           - if: # computation
               properties:
                 type:
@@ -181,7 +182,7 @@ properties:
   events:
     type: object
     propertyNames:
-      $ref: 'definitions#/definitions/token'
+      $ref: 'definitions#/definitions/name'
     patternProperties:
       '.*':
         type: object
@@ -198,7 +199,7 @@ properties:
           subjective:
             type: boolean
             default: false
-        required: [ bridge, path ]
+        required: [bridge, path]
         additionalProperties: false
 
   receivers:
@@ -207,14 +208,14 @@ properties:
       '.*':
         type: object
         properties:
-          transition:
-            $ref: 'definitions#/definitions/token'
+          operation:
+            $ref: 'definitions#/definitions/name'
           bridge:
             type: string
           binding:
             type: string
           source:
-            $ref: 'definitions#/definitions/token'
+            $ref: 'definitions#/definitions/name'
           path:
             type: string
           conditioned:
@@ -223,7 +224,7 @@ properties:
           adaptive:
             type: boolean
             default: false
-        required: [ transition, bridge, path ]
+        required: [operation]
         additionalProperties: false
 
   extensions:

package/src/.component/validate.js

@@ -27,14 +27,16 @@ const events = (manifest) => {
 
 const receivers = (manifest) => {
   for (const [locator, receiver] of Object.entries(manifest.receivers)) {
-    if (manifest.operations?.[receiver.transition] === undefined) {
-      throw new Error(`Receiver '${locator}' refers to undefined transition '${receiver.transition}'`)
+    if (manifest.operations?.[receiver.operation] === undefined) {
+      throw new Error(`Receiver '${locator}' refers to undefined operation '${receiver.operation}'`)
     }
 
-    if (manifest.operations[receiver.transition].type !== 'transition') {
-      throw new Error(`Receiver '${locator}' refers to non-transition '${receiver.transition}'`)
+    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(', ')}`)
     }
   }
 }
 
+const TYPES = new Set(['transition', 'effect'])
+
 exports.validate = validate

package/src/.context/schema.yaml

@@ -11,7 +11,13 @@ properties:
     type: string
   packages:
     type: string
+  build:
+    type: object
+    properties:
+      command:
+        type: string
   runtime:
+    type: object
     properties:
       version:
         $ref: 'definitions#/definitions/version'

package/src/component.js

@@ -35,7 +35,7 @@ const load = async (path, base) => {
   if (base !== undefined) path = find(path, base, MANIFEST)
 
   const file = join(path, MANIFEST)
-  const manifest = /** @type {toa.norm.Component} */ await yaml(file)
+  const manifest = /** @type {toa.norm.Component} */ await yaml(file) ?? {}
 
   manifest.path = path
 

package/src/context.js

@@ -19,7 +19,7 @@ const {
 /**
  * @type {toa.norm.context.Constructor}
  */
-const context = async (root, environment = undefined) => {
+const context = async (root, environment = process.env.TOA_ENV) => {
   const path = resolve(root, CONTEXT)
   const context = /** @type {toa.norm.Context} */ await load(path)
   const pattern = resolve(root, context.packages)

package/test/component/expand.fixtures.js

@@ -53,7 +53,7 @@ const source = {
     two: {
       binding: 'amqp',
       bridge: 'node',
-      transition: 'transit'
+      operation: 'transit'
     }
   }
 }
@@ -123,12 +123,12 @@ const target = {
   },
   receivers: {
     one: {
-      transition: 'transit'
+      operation: 'transit'
     },
     two: {
       bridge: '@toa.io/bridges.node',
       binding: '@toa.io/bindings.amqp',
-      transition: 'transit'
+      operation: 'transit'
     }
   }
 }

package/test/component/validate.fixtures.js

@@ -47,7 +47,7 @@ const ok = {
   },
   receivers: {
     'foo.bar.happened': {
-      transition: 'add',
+      operation: 'add',
       bridge: 'whatever',
       binding: 'amqp',
       path: '/somewhere'

package/test/component/validate.test.js

@@ -37,14 +37,14 @@ describe('namespace', () => {
     manifest.namespace = 'foo_'
     expect(() => validate(manifest)).toThrow(/must match pattern/)
 
-    manifest.namespace = 'foo-'
+    manifest.namespace = 'foo_bar'
     expect(() => validate(manifest)).toThrow(/must match pattern/)
 
-    manifest.namespace = 'foo-BAR'
-    expect(() => validate(manifest)).not.toThrow()
+    manifest.namespace = 'foo-'
+    expect(() => validate(manifest)).toThrow(/must match pattern/)
 
-    manifest.namespace = 'foo_bar'
-    expect(() => validate(manifest)).not.toThrow()
+    manifest.namespace = 'foo-bar'
+    expect(() => validate(manifest)).toThrow('must match pattern')
 
     manifest.namespace = 'FooBar12'
     expect(() => validate(manifest)).not.toThrow()
@@ -229,15 +229,15 @@ describe('operations', () => {
 })
 
 describe('receivers', () => {
-  it('should throw if transition points to undefined transition', () => {
-    manifest.receivers['foo.bar.happened'].transition = 'not-exists'
+  it('should throw if transition points to undefined operation', () => {
+    manifest.receivers['foo.bar.happened'].operation = 'notExists'
 
-    expect(() => validate(manifest)).toThrow(/refers to undefined transition/)
+    expect(() => validate(manifest)).toThrow(/refers to undefined operation/)
   })
 
-  it('should throw if transition points to non transition', () => {
-    manifest.receivers['foo.bar.happened'].transition = 'get'
+  it('should throw if transition points to observation', () => {
+    manifest.receivers['foo.bar.happened'].operation = 'get'
 
-    expect(() => validate(manifest)).toThrow(/refers to non-transition/)
+    expect(() => validate(manifest)).toThrow(/one of the allowed types/)
   })
 })

package/test/context/validate.fixtures.js

@@ -8,6 +8,9 @@ const context = {
   description: 'context fixture',
   version: '0.0.0',
   packages: 'namespaces/**/*',
+  build: {
+    command: 'echo test'
+  },
   registry: {
     base: 'localhost:5000',
     platforms: ['linux/amd64', 'linux/arm/v7', 'linux/arm64']

package/types/component.d.ts

@@ -1,4 +1,4 @@
-import type { Locator } from '@toa.io/core/types'
+import type {Locator} from '@toa.io/core/types'
 
 export namespace toa.norm {
 
@@ -36,7 +36,7 @@ export namespace toa.norm {
     }
 
     interface Receiver {
-      transition: string
+      operation: string
       adaptive: boolean
       conditioned: boolean
       bridge: string

package/types/context.d.ts

@@ -1,6 +1,4 @@
-// noinspection ES6UnusedImports
-
-import { Component } from './component'
+import * as _component from './component'
 import { Locator } from '@toa.io/core/types'
 
 declare namespace toa.norm {
@@ -14,13 +12,17 @@ declare namespace toa.norm {
     }
 
     interface Registry {
-      base: string
+      base?: string
       platforms?: string[] | null
+      build?: {
+        arguments?: string[]
+        run?: string
+      }
     }
 
     interface Composition {
       name: string,
-      components: string[] | Component[]
+      components: string[] | _component.Component[]
     }
 
     namespace dependencies {
@@ -31,7 +33,7 @@ declare namespace toa.norm {
       }
 
       type References = {
-        [reference: string]: Component[]
+        [reference: string]: _component.Component[]
       }
 
     }
@@ -42,11 +44,11 @@ declare namespace toa.norm {
 
     interface Declaration {
       name: string
-      description: string
-      version: string
-      runtime: Runtime | string
-      registry: Registry | string
-      packages: string
+      description?: string
+      version?: string
+      runtime?: Runtime | string
+      registry?: Registry | string
+      packages?: string
       compositions?: Composition[]
       annotations?: Record<string, object>
     }
@@ -55,11 +57,10 @@ declare namespace toa.norm {
   }
 
   interface Context extends context.Declaration {
-    locator: Locator
-    runtime: context.Runtime
+    runtime?: context.Runtime
     environment?: string
-    registry: context.Registry
-    components: Component[]
+    registry?: context.Registry
+    components?: _component.Component[]
     dependencies?: context.Dependencies
   }