@toa.io/norm 1.0.0-alpha.6 → 1.0.0-alpha.63

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/norm",
-  "version": "1.0.0-alpha.6",
+  "version": "1.0.0-alpha.63",
   "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.6",
-    "@toa.io/generic": "1.0.0-alpha.6",
-    "@toa.io/schema": "1.0.0-alpha.6",
-    "@toa.io/schemas": "1.0.0-alpha.6",
-    "@toa.io/yaml": "1.0.0-alpha.6"
+    "@toa.io/core": "1.0.0-alpha.63",
+    "@toa.io/generic": "1.0.0-alpha.63",
+    "@toa.io/schemas": "1.0.0-alpha.63",
+    "@toa.io/yaml": "1.0.0-alpha.63"
   },
-  "gitHead": "f28d629a9477646e267a8af8479cc1bb10d62c80"
+  "gitHead": "9acf69d3135ea69bb9080c4f2f654d119f7b8a82"
 }

package/src/.component/.expand/version.js

@@ -1,19 +1,45 @@
 'use strict'
 
-function version (manifest) {
-  if (manifest.version === undefined) {
-    const bridge = require(manifest.bridge)
+const { join } = require('node:path')
+const { createHash } = require('node:crypto')
+const fs = require('node:fs/promises')
+const { createReadStream } = require('node:fs')
+const { once } = require('node:events')
 
-    if ('version' in bridge)
-      manifest.version = bridge.version(manifest)
-  }
+async function version (manifest) {
+  manifest.version ??= await hash(manifest.path)
+}
+
+async function hash (path) {
+  const hash = await hashd(path)
+
+  return hash.digest('hex').slice(0, 8)
+}
 
-  if (manifest.version === undefined) {
-    console.warn(`Component '${manifest.namespace ? manifest.namespace + '.' : ''}${manifest.name}' has no version`)
+/**
+ * @param {string} path
+ * @param {import('node:crypto').Hash} hash
+ */
+async function hashd (path, hash = createHash('sha256')) {
+  const stat = await fs.stat(path)
 
-    manifest.version = Math.random().toString(36).slice(2)
+  if (stat.isFile()) {
+    const stream = createReadStream(path)
+
+    stream.pipe(hash, { end: false })
+
+    return await once(stream, 'end')
   }
 
+  if (stat.isDirectory()) {
+    const entries = await fs.opendir(path)
+
+    for await (const entry of entries) {
+      await hashd(join(path, entry.name), hash)
+    }
+
+    return hash
+  }
 }
 
 exports.version = version

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/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/expand.js

@@ -11,7 +11,7 @@ const {
   version
 } = require('./.expand')
 
-const expand = (manifest) => {
+async function expand (manifest) {
   entity(manifest)
   bridge(manifest)
   operations(manifest)
@@ -19,7 +19,8 @@ const expand = (manifest) => {
   receivers(manifest)
   properties(manifest)
   extensions(manifest)
-  version(manifest)
+
+  await version(manifest)
 }
 
 exports.expand = expand

package/src/.component/extensions.js

@@ -4,7 +4,10 @@ const { directory: { find } } = require('@toa.io/filesystem')
 const { resolve } = require('../shortcuts')
 
 const extensions = (manifest) => {
-  if (manifest.extensions === undefined) return
+  if (manifest.extensions === undefined)
+    manifest.extensions = PREDEFINED
+  else
+    Object.assign({}, PREDEFINED, manifest.extensions)
 
   const extensions = manifest.extensions
 
@@ -29,4 +32,8 @@ const extensions = (manifest) => {
   }
 }
 
+const PREDEFINED = {
+  '@toa.io/extensions.telemetry': null
+}
+
 exports.extensions = extensions

package/src/.component/schema.yaml

@@ -38,15 +38,19 @@ 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'
+    type: string
+    pattern: ^[a-zA-Z]([a-zA-Z0-9]{1,31})?$
     default: 'default'
     not:
       oneOf:
@@ -68,7 +72,7 @@ properties:
         type: string
         default: '@toa.io/storages.mongodb'
       schema:
-        $ref: 'definitions#/definitions/schema'
+        $ref: https://json-schema.org/draft/2019-09/schema
         type: object
         properties:
           type:
@@ -79,8 +83,24 @@ properties:
             propertyNames:
               oneOf:
                 - $ref: '#/definitions/name'
-                - enum: [_version]
-      dependent:
+                - 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]
+      associated:
         type: boolean
         default: false
       custom:
@@ -109,7 +129,7 @@ properties:
           type:
             enum: [transition, observation, assignment, computation, effect]
           scope:
-            enum: [object, objects, changeset, none]
+            enum: [object, objects, changeset, stream, none]
           concurrency:
             enum: [none, retry]
           forward:
@@ -119,9 +139,14 @@ 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]
@@ -158,7 +183,7 @@ properties:
             then:
               properties:
                 scope:
-                  enum: [object, objects, none]
+                  enum: [object, objects, stream, none]
                 query:
                   not:
                     const: false
@@ -189,18 +214,15 @@ 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
@@ -227,13 +249,13 @@ properties:
         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:
@@ -244,6 +266,8 @@ properties:
           adaptive:
             type: boolean
             default: false
+          arguments:
+            type: array
         required: [operation]
         additionalProperties: false
 

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)

package/src/.context/schema.yaml

@@ -6,11 +6,13 @@ 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:
     type: string
+    default: components/*
   build:
     type: object
     properties:
@@ -53,16 +55,18 @@ 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
-required: [runtime, name, packages, registry]
+required: [runtime, name, registry]
 additionalProperties: false

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)
-  expand(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,8 @@ 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'
 }
 
 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)
@@ -112,15 +110,18 @@ describe('entity', () => {
     })
 
     it('should allow default id', () => {
-      manifest.entity.schema.properties.id = { type: 'string', pattern: '^[a-fA-F0-9]+$' }
+      manifest.entity.schema.properties.id = {
+        type: 'string',
+        pattern: '^[a-fA-F0-9]+$'
+      }
       expect(() => validate(manifest)).not.toThrow()
     })
   })
 
-  describe('dependent', () => {
+  describe('associated', () => {
     it('should provide default', () => {
       expect(() => validate(manifest)).not.toThrow()
-      expect(manifest.entity.dependent).toBe(false)
+      expect(manifest.entity.associated).toBe(false)
     })
   })
 })
@@ -151,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)', () => {
@@ -173,8 +174,7 @@ describe('operations', () => {
   })
 
   it.each([
-    ['computation', 'compute'],
-    ['effect', 'affect']
+    ['computation', 'compute']
   ])('should set query: false for %s', async (_, operation) => {
     validate(manifest)
 

package/test/context/validate.test.js

@@ -72,9 +72,10 @@ it('should require name as label', () => {
   expect(() => validate(context)).not.toThrow(/pattern/)
 })
 
-it('should require packages location', () => {
+it('should set default packages location', () => {
   delete context.packages
-  expect(() => validate(context)).toThrow(/required/)
+  expect(() => validate(context)).not.toThrow()
+  expect(context.packages).toBe('components/*')
 })
 
 it('should require registry url', () => {

package/types/component.d.ts

@@ -37,7 +37,7 @@ type Receiver = {
 type Entity = {
   schema: Object
   storage?: string
-  dependent?: boolean
+  associated?: boolean
 }
 
 type Declaration = {