@toa.io/norm 1.0.0-alpha.0 → 1.0.0-alpha.11

package/package.json

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

package/src/.component/.expand/entity.js

@@ -5,7 +5,7 @@ const { expand } = require('@toa.io/schemas')
 const { resolve } = require('../../shortcuts')
 
 function entity (manifest) {
-  if (manifest.entity === undefined) return
+  if (!('entity' in manifest)) return
   if ('schema' in manifest.entity) manifest.entity.schema = expand(manifest.entity.schema)
 
   manifest.entity.storage = resolve(manifest.entity.storage)

package/src/.component/.expand/index.js

@@ -7,6 +7,7 @@ const { extensions } = require('./extensions')
 const { operations } = require('./operations')
 const { properties } = require('./properties')
 const { receivers } = require('./receivers')
+const { version } = require('./version')
 
 exports.bridge = bridge
 exports.entity = entity
@@ -15,3 +16,4 @@ exports.extensions = extensions
 exports.operations = operations
 exports.properties = properties
 exports.receivers = receivers
+exports.version = version

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

@@ -0,0 +1,45 @@
+'use strict'
+
+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')
+
+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)
+}
+
+/**
+ * @param {string} path
+ * @param {import('node:crypto').Hash} hash
+ */
+async function hashd (path, hash = createHash('sha256')) {
+  const stat = await fs.stat(path)
+
+  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/collapse.js

@@ -34,10 +34,14 @@ const collapse = (manifest, prototype) => {
     }
   }
 
-  delete prototype.entity?.storage // ???
-
   const { entity, events, extensions } = prototype
 
+  if (manifest.entity?.schema?.properties.id !== undefined && entity?.schema?.properties.id !== undefined) {
+    manifest.entity.custom = true
+
+    delete prototype.entity.schema.properties.id
+  }
+
   merge(manifest, { entity, events, extensions })
 }
 

package/src/.component/defaults.js

@@ -1,19 +1,23 @@
 'use strict'
 
 const { hash } = require('@toa.io/generic')
+const assert = require('node:assert')
 
 // these defaults are required before validation
 const defaults = (manifest) => {
-  if (manifest.prototype === undefined) manifest.prototype = '@toa.io/prototype'
   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'
 
-  // TODO: bridge.version()
-  if (manifest.version === undefined) manifest.version = '0.0.0'
+  if ('entity' in manifest) {
+    if (manifest.entity.storage === null)
+      manifest.entity.storage = '@toa.io/storages.null'
+  } else {
+    if (manifest.prototype === undefined)
+      manifest.prototype = null
+  }
+
+  if (manifest.prototype === undefined) manifest.prototype = '@toa.io/prototype'
 }
 
 function protoName (manifest) {

package/src/.component/dereference.js

@@ -4,13 +4,28 @@ const { merge } = require('@toa.io/generic')
 
 const dereference = (manifest) => {
   // schemas
-  const property = resolve(manifest.entity.schema.properties)
+  const resolver = createResolver(manifest.entity?.schema?.properties)
 
-  schema(manifest.entity.schema, property)
+  if (manifest.entity !== undefined)
+    schema(manifest.entity.schema, resolver)
 
+  if ('operations' in manifest)
+    operations(manifest, resolver)
+
+}
+
+const createResolver = (properties) => (property) => {
+  if (properties?.[property] === undefined) {
+    throw new Error(`Referenced property '${property}' is not defined`)
+  }
+
+  return properties[property]
+}
+
+function operations (manifest, resolver) {
   for (const operation of Object.values(manifest.operations)) {
-    if (operation.input !== undefined) operation.input = schema(operation.input, property)
-    if (operation.output !== undefined) operation.output = schema(operation.output, property)
+    if (operation.input !== undefined) operation.input = schema(operation.input, resolver)
+    if (operation.output !== undefined) operation.output = schema(operation.output, resolver)
   }
 
   // forwarding
@@ -21,14 +36,7 @@ const dereference = (manifest) => {
   for (const operation of Object.values(manifest.operations)) {
     delete operation.forwarded
   }
-}
-
-const resolve = (schema) => (property) => {
-  if (schema[property] === undefined) {
-    throw new Error(`Referenced property '${property}' is not defined`)
-  }
 
-  return schema[property]
 }
 
 const schema = (object, resolve) => {

package/src/.component/expand.js

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

package/src/.component/merge.js

@@ -28,6 +28,10 @@ const define = async (root, manifest, property) => {
 
   // default bridge
   const definition = await scan(manifest.bridge, root, property)
+
+  if (definition === undefined)
+    return
+
   const items = Object.entries(definition)
 
   if (items.length) {
@@ -49,7 +53,9 @@ const define = async (root, manifest, property) => {
 const scan = async (bridge, root, property) => {
   const { define } = require(bridge)
 
-  return define[property](root)
+  if (property in define)
+    return define[property](root)
+  else return undefined
 }
 
 exports.merge = bridge

package/src/.component/schema.yaml

@@ -2,6 +2,9 @@ $schema: https://json-schema.org/draft/2019-09/schema
 $id: https://schemas.toa.io/0.0.0/manifest
 
 definitions:
+  name:
+    type: string
+    pattern: ^[a-zA-Z]+([_a-zA-Z0-9]*[a-zA-Z0-9]+)?$
   binding:
     type: string
     not:
@@ -20,7 +23,7 @@ properties:
       operations:
         type: object
         propertyNames:
-          $ref: 'definitions#/definitions/name'
+          $ref: '#/definitions/name'
         patternProperties:
           '.*':
             type: object
@@ -50,13 +53,20 @@ properties:
         - const: 'system'
 
   version:
-    $ref: 'definitions#/definitions/version'
+    type: string
+
+  build:
+    type: object
+    properties:
+      image:
+        type: string
 
   entity:
     type: object
     properties:
       storage:
         type: string
+        default: '@toa.io/storages.mongodb'
       schema:
         $ref: 'definitions#/definitions/schema'
         type: object
@@ -68,9 +78,28 @@ properties:
             type: object
             propertyNames:
               oneOf:
-                - $ref: 'definitions#/definitions/name'
+                - $ref: '#/definitions/name'
                 - enum: [_version]
-      initialized:
+      unique:
+        type: object
+        patternProperties:
+          '.*':
+            type: array
+            items:
+              type: string
+      index:
+        type: object
+        patternProperties:
+          '.*':
+            type: object
+            patternProperties:
+              '.*':
+                type: string
+                enum: [asc, desc, hash]
+      dependent:
+        type: boolean
+        default: false
+      custom:
         type: boolean
         default: false
     required: [schema]
@@ -88,7 +117,7 @@ properties:
   operations:
     type: object
     propertyNames:
-      $ref: 'definitions#/definitions/name'
+      $ref: '#/definitions/name'
     patternProperties:
       '.*':
         type: object
@@ -100,7 +129,7 @@ properties:
           concurrency:
             enum: [none, retry]
           forward:
-            $ref: 'definitions#/definitions/name'
+            $ref: '#/definitions/name'
           bridge:
             type: string
           bindings:

package/src/.context/.dependencies/connectors.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const { resolve } = require('node:path')
+
 const connectors = (context, extracted) => {
   const connectors = {}
 
@@ -9,11 +11,16 @@ const connectors = (context, extracted) => {
   ) ?? []
 
   for (const component of components) {
-    if (connectors[component.entity.storage] === undefined) {
-      connectors[component.entity.storage] = []
-    }
+    if (component.entity !== undefined) {
+      let storage = component.entity.storage
 
-    connectors[component.entity.storage].push(component)
+      if (storage[0] === '.') {
+        storage = resolve(component.path, storage)
+      }
+
+      connectors[storage] ??= []
+      connectors[storage].push(component)
+    }
 
     const bindings = new Set()
 

package/src/.context/schema.yaml

@@ -4,7 +4,7 @@ $id: https://schemas.toa.io/0.0.0/context
 type: object
 properties:
   version:
-    $ref: 'definitions#/definitions/version'
+    type: string
   name:
     $ref: 'definitions#/definitions/label'
   description:
@@ -20,7 +20,7 @@ properties:
     type: object
     properties:
       version:
-        $ref: 'definitions#/definitions/version'
+        type: string
       registry:
         type: string
         format: uri
@@ -54,6 +54,8 @@ properties:
       properties:
         name:
           $ref: 'definitions#/definitions/token'
+        image:
+          type: string
         components:
           type: array
           minItems: 1

package/src/component.js

@@ -13,7 +13,6 @@ const {
   collapse,
   dereference,
   defaults,
-  dependencies,
   normalize,
   extensions
 } = require('./.component')
@@ -39,7 +38,7 @@ const load = async (path, base) => {
   manifest.path = path
 
   defaults(manifest)
-  expand(manifest)
+  await expand(manifest)
 
   await merge(path, manifest)
 
@@ -50,7 +49,7 @@ const load = async (path, base) => {
   }
 
   dereference(manifest)
-  dependencies(manifest)
+  // dependencies(manifest)
 
   return manifest
 }

package/src/shortcuts.js

@@ -41,6 +41,7 @@ const recognize = (shortcuts, object, group) => {
 const SHORTCUTS = {
   amqp: '@toa.io/bindings.amqp',
   node: '@toa.io/bridges.node',
+  bash: '@toa.io/bridges.bash',
   mongodb: '@toa.io/storages.mongodb',
   sql: '@toa.io/storages.sql',
   queues: '@toa.io/storages.queues',

package/test/component/collapse.test.js

@@ -30,19 +30,6 @@ it('should remove prototype property', () => {
 })
 
 describe('entity', () => {
-  it('should ignore storage', () => {
-    const source = { entity: { storage: 'foo' } }
-    const prototype = { entity: { storage: 'bar' } }
-    const manifest = clone(source)
-
-    collapse(manifest, prototype)
-    expect(manifest).toStrictEqual(source)
-
-    delete manifest.entity.storage
-    collapse(manifest, prototype)
-    expect(manifest).toStrictEqual({ entity: {} })
-  })
-
   it('should merge entity schema', () => {
     const manifest = clone(samples.entity.manifest)
 

package/test/component/expand.fixtures.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const source = {
+  path: '',
   entity: {
     schema: {
       properties: {

package/test/component/validate.test.js

@@ -117,10 +117,10 @@ describe('entity', () => {
     })
   })
 
-  describe('initialized', () => {
+  describe('dependent', () => {
     it('should provide default', () => {
       expect(() => validate(manifest)).not.toThrow()
-      expect(manifest.entity.initialized).toBe(false)
+      expect(manifest.entity.dependent).toBe(false)
     })
   })
 })

package/test/context/dereference.fixtures.js

@@ -18,8 +18,7 @@ const component = (id) => {
       name,
       id,
       label: `${namespace}-${name}`
-    },
-    entity: null
+    }
   }
 }
 

package/test/context/validate.test.js

@@ -21,14 +21,6 @@ describe('runtime', () => {
     expect(() => validate(context)).toThrow(/required/)
   })
 
-  it('should require version as semver', () => {
-    delete context.runtime.version
-    expect(() => validate(context)).toThrow(/required/)
-
-    context.runtime.version = '.'
-    expect(() => validate(context)).toThrow(/pattern/)
-  })
-
   it('should require registry to match uri format', () => {
     context.runtime.registry = 'not-a-uri'
     expect(() => validate(context)).toThrow(/must match format/)

package/types/component.d.ts

@@ -4,7 +4,7 @@ type Map = {
   [id: string]: Component
 }
 
-type Operation = {
+export type Operation = {
   type: operations.type
   scope?: operations.scope
   bindings?: string[]
@@ -14,9 +14,7 @@ type Operation = {
   query?: boolean
 }
 
-type Operations = {
-  [key: string]: Operation
-}
+export type Operations = Record<string, Operation>
 
 type Event = {
   binding: string
@@ -39,7 +37,7 @@ type Receiver = {
 type Entity = {
   schema: Object
   storage?: string
-  initialized?: boolean
+  dependent?: boolean
 }
 
 type Declaration = {

package/types/context.d.ts

@@ -1,5 +1,5 @@
 import { Manifest } from './component'
-import { Locator } from '@toa.io/core/types'
+import { Locator } from '@toa.io/core'
 import type { Declaration } from './context/declaration'
 
 interface Runtime{