@toa.io/norm 0.20.0-dev.4 → 0.20.0-dev.40

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/norm",
-  "version": "0.20.0-dev.4",
+  "version": "0.20.0-dev.40",
   "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.4",
-    "@toa.io/generic": "0.20.0-dev.4",
-    "@toa.io/schema": "0.20.0-dev.4",
-    "@toa.io/schemas": "0.20.0-dev.4",
-    "@toa.io/yaml": "0.20.0-dev.4"
+    "@toa.io/core": "0.20.0-dev.40",
+    "@toa.io/generic": "0.20.0-dev.40",
+    "@toa.io/schema": "0.20.0-dev.40",
+    "@toa.io/schemas": "0.20.0-dev.40",
+    "@toa.io/yaml": "0.20.0-dev.40"
   },
-  "gitHead": "a62b12d77a405d18eb92e879672455b6fb2fd9f2"
+  "gitHead": "594543488de934deba3598ec5805744af1b3f4c0"
 }

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/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,15 @@ 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'
+            not:
+              const: context
           path:
             type: string
           conditioned:
@@ -223,7 +226,7 @@ properties:
           adaptive:
             type: boolean
             default: false
-        required: [ operation ]
+        required: [operation]
         additionalProperties: false
 
   extensions:

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

@@ -18,7 +18,8 @@ const resolve = (references, annotations) => {
 
     const instances = components.map((component) => ({
       locator: component.locator,
-      manifest: component.extensions?.[id]
+      manifest: component.extensions?.[id],
+      component
     }))
 
     dependencies[dependency] = instances

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_bar'
+    expect(() => validate(manifest)).toThrow(/must match pattern/)
+
     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)).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/)
   })
@@ -240,4 +240,10 @@ describe('receivers', () => {
 
     expect(() => validate(manifest)).toThrow(/one of the allowed types/)
   })
+
+  it('should throw if source has a name `context`', async () => {
+    manifest.receivers['foo.bar.happened'].source = 'context'
+
+    expect(() => validate(manifest)).toThrow(/must NOT be valid/)
+  })
 })

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,41 @@
 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<T = undefined> {
+  locator: Locator
+  manifest: T,
+  component: _component.Component
+}
 
-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,2 @@
-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'
+export * as component from './component'

package/features/component.operations.feature

@@ -1,54 +0,0 @@
-Feature: Operations declaration
-
-  Scenario Outline: Operation <channel> entity references
-
-  Operation IO schemas may reference entity's properties using syntax:
-  - `.` - entity's property with the same name
-  - '.foo` - entity's property with `foo` name
-
-    Given I have an entity schema:
-      """
-      foo: string
-      bar: 1
-      """
-    When I declare assignment with:
-      """
-      <channel>:
-        foo: .
-        baz: .bar
-      """
-    Then normalized assignment declaration must contain:
-      """
-      <channel>:
-        type: object
-        properties:
-          foo:
-            type: string
-          baz:
-            type: number
-            default: 1
-      """
-
-    Examples:
-      | channel |
-      | input   |
-      | output  |
-
-  Scenario: Prototype property reference
-
-  Operation IO schemas must be able to reference prototype's entity properties.
-
-    When I declare assignment with:
-      """
-      output:
-        id: .
-      """
-
-    Then normalized assignment declaration must contain:
-      """
-      output:
-        type: object
-        properties:
-          id:
-            $ref: https://schemas.toa.io/0.0.0/definitions#/definitions/id
-      """

package/features/steps/.test/manifest.test.js

@@ -1,111 +0,0 @@
-'use strict'
-
-const { AssertionError } = require('assert')
-const { generate } = require('randomstring')
-const { dump } = require('@toa.io/yaml')
-const gherkin = require('@toa.io/tomato')
-
-const mock = { gherkin }
-
-jest.mock('@cucumber/cucumber', () => mock.gherkin)
-require('../manifest')
-
-it('should be', () => undefined)
-
-/** @type {toa.norm.features.Context} */
-let context
-
-beforeEach(() => {
-  const manifest = /** @type {toa.norm.component.Declaration} */ {
-    name: 'test',
-    namespace: 'features',
-    version: '1.0.0',
-    entity: null
-  }
-
-  context = { manifest }
-})
-
-describe('Given I have an entity schema:', () => {
-  const step = gherkin.steps.Gi('I have an entity schema:')
-
-  it('should be', () => undefined)
-
-  it('should set entity schema', () => {
-    const schema = { foo: 'string' }
-    const yaml = dump(schema)
-
-    step.call(context, yaml)
-
-    expect(context.manifest.entity).toStrictEqual({ schema })
-  })
-})
-
-describe('When I declare {operation} with:', () => {
-  const step = gherkin.steps.Wh('I declare {operation} with:')
-
-  it('should be', () => undefined)
-
-  it('should declare operation', () => {
-    const type = 'assignment'
-    const scope = 'changeset'
-    const input = {}
-    const yaml = dump(input)
-
-    step.call(context, type, yaml)
-
-    expect(context.manifest.operations[type]).toStrictEqual({ type, scope })
-  })
-})
-
-describe('Then normalized {operation} declaration must contain:', () => {
-  const step = gherkin.steps.Th('normalized {operation} declaration must contain:')
-
-  it('should be', () => undefined)
-
-  it('should throw if does not contain', async () => {
-    const type = 'assignment'
-
-    context.manifest.operations = {
-      [type]: {
-        type,
-        input: { bar: 'number' },
-        scope: 'changeset'
-      }
-    }
-
-    const input = {
-      type: 'object',
-      properties: {
-        bar: { type: 'string' }
-      }
-    }
-
-    const yaml = dump({ input })
-
-    await expect(step.call(context, type, yaml)).rejects.toThrow(AssertionError)
-  })
-
-  it('should not throw if contain', async () => {
-    const type = 'assignment'
-
-    context.manifest.operations = {
-      [type]: {
-        type,
-        input: { bar: 'number' },
-        scope: 'changeset'
-      }
-    }
-
-    const input = {
-      type: 'object',
-      properties: {
-        bar: { type: 'number' }
-      }
-    }
-
-    const yaml = dump({ input })
-
-    await expect(step.call(context, type, yaml)).resolves.not.toThrow()
-  })
-})

package/features/steps/.types/context.d.ts

@@ -1,9 +0,0 @@
-import { Declaration } from '../../../types/component'
-
-declare namespace toa.norm.features {
-
-  type Context = {
-    manifest?: Declaration
-  }
-
-}

package/features/steps/hooks.js

@@ -1,18 +0,0 @@
-'use strict'
-
-const { Before } = require('@cucumber/cucumber')
-
-Before(
-  /**
-   * @this {toa.norm.features.Context}
-   */
-  function () {
-    this.manifest = {
-      name: 'test',
-      namespace: 'features',
-      version: '1.0.0',
-      entity: {
-        storage: null
-      }
-    }
-  })

package/features/steps/manifest.js

@@ -1,66 +0,0 @@
-'use strict'
-
-const assert = require('node:assert')
-const { join } = require('node:path')
-const { parse, save } = require('@toa.io/yaml')
-const { directory } = require('@toa.io/filesystem')
-const { match } = require('@toa.io/generic')
-
-const { component: load } = require('../../src')
-
-const { Given, When, Then } = require('@cucumber/cucumber')
-
-Given('I have an entity schema:',
-  /**
-   * @param {string} yaml
-   * @this {toa.norm.features.Context}
-   */
-  function (yaml) {
-    const schema = parse(yaml)
-
-    this.manifest.entity = { schema }
-  })
-
-When('I declare {operation} with:',
-  /**
-   * @param {toa.norm.component.operations.Type} type
-   * @param {string} yaml
-   * @this {toa.norm.features.Context}
-   */
-  function (type, yaml) {
-    /** @type {toa.norm.component.Operation} */
-    const declaration = parse(yaml)
-
-    declaration.type = type
-    declaration.scope = scope(type)
-
-    this.manifest.operations = { [type]: declaration }
-  })
-
-Then('normalized {operation} declaration must contain:',
-  /**
-   * @param {toa.norm.component.operations.Type} type
-   * @param {string} yaml
-   * @this {toa.norm.features.Context}
-   */
-  async function (type, yaml) {
-    const temp = await directory.temp()
-    const path = join(temp, 'manifest.toa.yaml')
-
-    await save(this.manifest, path)
-
-    const manifest = await load(temp)
-    const operation = manifest.operations[type]
-    const query = parse(yaml)
-    const contains = match(operation, query)
-
-    assert.equal(contains, true)
-  })
-
-/**
- * @param {toa.norm.component.operations.Type} type
- * @returns {toa.norm.component.operations.Scope}
- */
-const scope = (type) => {
-  return type === 'assignment' ? 'changeset' : 'object'
-}

package/features/steps/parameters.js

@@ -1,9 +0,0 @@
-'use strict'
-
-const { defineParameterType } = require('@cucumber/cucumber')
-
-defineParameterType({
-  name: 'operation',
-  regexp: /transition|observation|assignment/,
-  transformer: (type) => type
-})