@toa.io/norm 0.20.0-dev.3 → 0.20.0-dev.30

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/norm",
-  "version": "0.20.0-dev.3",
+  "version": "0.20.0-dev.30",
   "description": "Toa declarations normalization and validation",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -12,6 +12,7 @@
     "url": "https://github.com/toa-io/toa/issues"
   },
   "main": "src/index.js",
+  "types": "types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -19,11 +20,11 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@toa.io/core": "0.20.0-dev.3",
-    "@toa.io/generic": "0.20.0-dev.3",
-    "@toa.io/schema": "0.20.0-dev.3",
-    "@toa.io/schemas": "0.20.0-dev.3",
-    "@toa.io/yaml": "0.20.0-dev.3"
+    "@toa.io/core": "0.20.0-dev.30",
+    "@toa.io/generic": "0.20.0-dev.30",
+    "@toa.io/schema": "0.20.0-dev.30",
+    "@toa.io/schemas": "0.20.0-dev.30",
+    "@toa.io/yaml": "0.20.0-dev.30"
   },
-  "gitHead": "3eabf45761f4cf211e1e4c331933ec60b4a828a7"
+  "gitHead": "61c8e74a336385265767e9fd37d49128cb51b17f"
 }

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

@@ -10,7 +10,9 @@ function extensions (manifest) {
 const SHORTCUTS = {
   exposition: '@toa.io/extensions.exposition',
   origins: '@toa.io/extensions.origins',
-  configuration: '@toa.io/extensions.configuration'
+  configuration: '@toa.io/extensions.configuration',
+  state: '@toa.io/extensions.state',
+  stash: '@toa.io/extensions.stash'
 }
 
 exports.extensions = extensions

package/src/.component/defaults.js

@@ -1,11 +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.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'
@@ -14,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/normalize.js

@@ -1,10 +1,8 @@
 'use strict'
 
-const { convolve } = require('@toa.io/generic')
 const { events, operations, extensions, receivers } = require('./.normalize')
 
 const normalize = (component, environment) => {
-  convolve(component, environment)
   operations(component)
   events(component)
   receivers(component)

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:
@@ -208,13 +209,13 @@ properties:
         type: object
         properties:
           operation:
-            $ref: 'definitions#/definitions/token'
+            $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: [ operation ]
+        required: [operation]
         additionalProperties: false
 
   extensions:

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/src/shortcuts.js

@@ -47,7 +47,8 @@ const SHORTCUTS = {
   queues: '@toa.io/storages.queues',
   exposition: '@toa.io/extensions.exposition',
   configuration: '@toa.io/extensions.configuration',
-  origins: '@toa.io/extensions.origins'
+  origins: '@toa.io/extensions.origins',
+  stash: '@toa.io/extensions.stash'
 }
 
 exports.recognize = recognize

package/test/component/normalize.test.js

@@ -12,13 +12,6 @@ beforeEach(() => {
   manifest = clone(fixtures.operations)
 })
 
-describe('environment', () => {
-  it('should convolve with environment argument', () => {
-    normalize(manifest, 'local')
-    expect(manifest.operations.add.bindings).toStrictEqual(['foo'])
-  })
-})
-
 describe('operations', () => {
   it('should set default bindings', () => {
     normalize(manifest)

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()
@@ -230,7 +230,7 @@ describe('operations', () => {
 
 describe('receivers', () => {
   it('should throw if transition points to undefined operation', () => {
-    manifest.receivers['foo.bar.happened'].operation = 'not-exists'
+    manifest.receivers['foo.bar.happened'].operation = 'notExists'
 
     expect(() => validate(manifest)).toThrow(/refers to undefined operation/)
   })

package/types/context/declaration.d.ts

@@ -0,0 +1,17 @@
+import { Composition, Registry, Runtime } from '../context'
+
+interface Composition {
+  name: string,
+  components: string[]
+}
+
+export interface Declaration {
+  name: string
+  description?: string
+  version?: string
+  runtime?: Runtime | string
+  registry?: Registry | string
+  packages?: string
+  compositions?: Composition[]
+  annotations?: Record<string, object>
+}

package/types/context.d.ts

@@ -1,76 +1,40 @@
 import * as _component from './component'
 import { Locator } from '@toa.io/core/types'
+import type { Declaration } from './context/declaration'
 
-declare namespace toa.norm {
-
-  namespace context {
-
-    interface Runtime {
-      version: string
-      registry?: string
-      proxy?: string
-    }
-
-    interface Registry {
-      base?: string
-      platforms?: string[] | null
-      build?: {
-        arguments?: string[]
-        run?: string
-      }
-    }
-
-    interface Composition {
-      name: string,
-      components: string[] | _component.Component[]
-    }
-
-    namespace dependencies {
-
-      type Instance = {
-        locator: Locator
-        manifest?: Object
-      }
-
-      type References = {
-        [reference: string]: _component.Component[]
-      }
-
-    }
-
-    interface Dependencies {
-      [reference: string]: dependencies.Instance[]
-    }
-
-    interface Declaration {
-      name: string
-      description?: string
-      version?: string
-      runtime?: Runtime | string
-      registry?: Registry | string
-      packages?: string
-      compositions?: Composition[]
-      annotations?: Record<string, object>
-    }
-
-    type Constructor = (path: string, environment?: string) => Promise<Context>
-  }
+interface Runtime {
+  version: string
+  registry?: string
+  proxy?: string
+}
 
-  interface Context extends context.Declaration {
-    runtime?: context.Runtime
-    environment?: string
-    registry?: context.Registry
-    components?: _component.Component[]
-    dependencies?: context.Dependencies
-  }
+interface Registry {
+  base?: string
+  platforms?: string[] | null
+  build?: {
+    arguments?: string[]
+    run?: string
+  },
+  credentials: string
+}
 
+interface Composition {
+  name: string,
+  components: _component.Component[]
 }
 
-export type Composition = toa.norm.context.Composition
-export type Context = toa.norm.Context
+export interface Dependency {
+  locator: Locator
+  manifest?: object
+}
 
-export namespace dependencies {
-  export type Instance = toa.norm.context.dependencies.Instance
+interface Context extends Declaration {
+  runtime?: Runtime
+  environment?: string
+  registry?: Registry
+  compositions?: Composition[]
+  components?: _component.Component[]
+  dependencies?: Record<string, Dependency[]>
 }
 
-export const context: toa.norm.context.Constructor
+export function context (path: string, environment?: string): Promise<Context>

package/types/index.d.ts

@@ -1,5 +1 @@
-export { component } from './component'
-export { context } from './context'
-
-export type { Composition, dependencies } from './context'
-export type { Component, Operation } from './component'
+export * as context from './context'