@toa.io/norm 1.0.0-alpha.274 → 1.0.0-alpha.277

package/src/.context/.dependencies/load.js

@@ -1,23 +1,26 @@
-'use strict'
+import { createRequire } from 'node:module'
+import { readFileSync } from 'node:fs'
+import { join } from 'node:path'
+import { pathToFileURL } from 'node:url'
 
-const { join } = require('node:path')
+// import.meta.resolve takes no paths, and a dependency is named rather than
+// written as a path
+const require = createRequire(import.meta.url)
 
 /**
  * @param {string} path
- * @returns {{ metadata: object, module: object }}
+ * @returns {Promise<{ metadata: object, module: object }>}
  */
-function load (path) {
+export async function load (path) {
   const metadata = loadMetadata(path)
-  const module = loadModule(path)
+  const module = await loadModule(path)
 
   return { metadata, module }
 }
 
 function loadMetadata (reference) {
-  reference = join(reference, 'package.json')
-
   try {
-    return require(reference)
+    return JSON.parse(readFileSync(require.resolve(join(reference, 'package.json')), 'utf8'))
   } catch {
     return null
   }
@@ -25,12 +28,10 @@ function loadMetadata (reference) {
 
 /**
  * @param {string} reference
- * @returns {object}
+ * @returns {Promise<object>}
  */
-function loadModule (reference) {
+async function loadModule (reference) {
   const path = require.resolve(reference)
 
-  return require(path)
+  return await import(pathToFileURL(path).href)
 }
-
-exports.load = load

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

@@ -1,12 +1,10 @@
-'use strict'
+import { load } from './load.js'
 
-const { load } = require('./load')
-
-const resolve = (references, annotations) => {
+export const resolve = async (references, annotations) => {
   const dependencies = {}
 
   for (const [dependency, components] of Object.entries(references)) {
-    const { metadata, module } = load(dependency)
+    const { metadata, module } = await load(dependency)
     const id = metadata.name
 
     const instances = components.map((component) => ({
@@ -28,7 +26,7 @@ const resolve = (references, annotations) => {
     if (dependency in dependencies) continue
 
     // an annotation may be keyed by a dependency id rather than by a module reference
-    const module = optional(dependency)
+    const module = await optional(dependency)
 
     if (module?.standalone === true) dependencies[dependency] = []
   }
@@ -40,12 +38,10 @@ const resolve = (references, annotations) => {
  * @param {string} reference
  * @returns {object | null}
  */
-function optional (reference) {
+async function optional (reference) {
   try {
-    return load(reference).module
+    return (await load(reference)).module
   } catch {
     return null
   }
 }
-
-exports.resolve = resolve

package/src/.context/complete.js

@@ -1,11 +1,9 @@
-'use strict'
-
 /**
  * Completes missing compositions with unused components
  * @param {toa.norm.Context} context
  * @returns {void}
  */
-const complete = (context) => {
+export const complete = (context) => {
   /** @type {Set<string>} */
   const composed = new Set()
 
@@ -29,5 +27,3 @@ const complete = (context) => {
     context.compositions.push({ name, components: [component] })
   }
 }
-
-exports.complete = complete

package/src/.context/dependencies.js

@@ -1,13 +1,9 @@
-'use strict'
+import { connectors, extensions, resolve } from './.dependencies/index.js'
 
-const { connectors, extensions, resolve } = require('./.dependencies')
-
-const dependencies = async (context) => {
+export const dependencies = async (context) => {
   const { extensions: e, components } = await extensions(context)
   const c = connectors(context, components)
   const references = { ...c, ...e }
 
   return resolve(references, context.annotations)
 }
-
-exports.dependencies = dependencies

package/src/.context/dereference.js

@@ -1,11 +1,9 @@
-'use strict'
-
 /**
  * Resolves component IDs within compositions with Component objects
  * @param {toa.norm.Context} context
  * @returns {void}
  */
-const dereference = (context) => {
+export const dereference = (context) => {
   const components = map(context.components)
 
   if (context.compositions !== undefined) {
@@ -27,5 +25,3 @@ const map = (components) => {
 
   return map
 }
-
-exports.dereference = dereference

package/src/.context/expand.js

@@ -1,13 +1,9 @@
-'use strict'
-
-const shortcuts = require('../shortcuts')
+import * as shortcuts from '../shortcuts.js'
 
 /**
  * @param {toa.norm.context.Declaration | object} context
  */
-const expand = (context) => {
+export const expand = (context) => {
   shortcuts.recognize(shortcuts.SHORTCUTS, context, 'annotations')
   shortcuts.recognize(shortcuts.SHORTCUTS, context.annotations)
 }
-
-exports.expand = expand

package/src/.context/index.js

@@ -1,15 +1,6 @@
-'use strict'
-
-const { complete } = require('./complete')
-const { dependencies } = require('./dependencies')
-const { dereference } = require('./dereference')
-const { expand } = require('./expand')
-const { normalize } = require('./normalize')
-const { validate } = require('./validate')
-
-exports.complete = complete
-exports.dependencies = dependencies
-exports.dereference = dereference
-exports.expand = expand
-exports.normalize = normalize
-exports.validate = validate
+export { complete } from './complete.js'
+export { dependencies } from './dependencies.js'
+export { dereference } from './dereference.js'
+export { expand } from './expand.js'
+export { normalize } from './normalize.js'
+export { validate } from './validate.js'

package/src/.context/normalize.js

@@ -1,11 +1,9 @@
-'use strict'
+import * as runtime from '@toa.io/runtime'
 
 /**
  * @param {toa.norm.context.Declaration | Object} context
  */
-const normalize = (context) => {
-  const runtime = require('@toa.io/runtime')
-
+export const normalize = (context) => {
   if (context.runtime === undefined) context.runtime = { version: runtime.version }
   if (typeof context.runtime === 'string') context.runtime = { version: context.runtime }
 
@@ -15,5 +13,3 @@ const normalize = (context) => {
 
   if (typeof context.registry === 'string') context.registry = { base: context.registry }
 }
-
-exports.normalize = normalize

package/src/.context/validate.js

@@ -1,17 +1,13 @@
-'use strict'
+import { resolve } from 'node:path'
 
-const { resolve } = require('node:path')
+import { readFileSync } from 'node:fs'
+import { yaml } from '@toa.io/generic'
+import * as schemas from '@toa.io/schemas'
 
-const { readFileSync } = require('node:fs')
-const { load: parseYAML } = require('js-yaml')
-const schemas = require('@toa.io/schemas')
-
-const path = resolve(__dirname, 'schema.yaml')
-const object = parseYAML(readFileSync(path, 'utf8'))
+const path = resolve(import.meta.dirname, 'schema.yaml')
+const object = yaml.load(readFileSync(path, 'utf8'))
 const schema = schemas.schema(object)
 
-const validate = (context) => {
+export const validate = (context) => {
   schema.validate(context)
 }
-
-exports.validate = validate

package/src/component.js

@@ -1,29 +1,18 @@
-'use strict'
-
-const { join } = require('node:path')
-
-const { readFile } = require('node:fs/promises')
-const jsyaml = require('js-yaml')
-const { find } = require('@toa.io/generic')
-const { Locator } = require('@toa.io/core')
-
-const {
-  expand,
-  merge,
-  validate,
-  collapse,
-  dereference,
-  defaults,
-  normalize,
-  extensions
-} = require('./.component')
-
-const component = async (path) => {
+import { join } from 'node:path'
+
+import { readFile } from 'node:fs/promises'
+import { yaml as jsyaml } from '@toa.io/generic'
+import { find } from '@toa.io/generic'
+import { Locator } from '@toa.io/core'
+
+import { expand, merge, validate, collapse, dereference, defaults, normalize, extensions } from './.component/index.js'
+
+export const component = async (path) => {
   const manifest = await load(path)
 
-  normalize(manifest, path)
-  validate(manifest)
-  extensions(manifest)
+  await normalize(manifest, path)
+  await validate(manifest)
+  await extensions(manifest)
 
   manifest.locator = new Locator(manifest.name, manifest.namespace)
 
@@ -57,7 +46,7 @@ const load = async (path, base, proto = false) => {
 
 const MANIFEST = 'manifest.toa.yaml'
 
-exports.component = component
+
 
 /**
  * Reads a YAML file, resolving anchors into distinct objects so that

package/src/context.js

@@ -1,23 +1,14 @@
-'use strict'
-
-const { resolve } = require('node:path')
-const { convolve } = require('@toa.io/generic')
-const glob = require('fast-glob')
-const { readFile } = require('node:fs/promises')
-const jsyaml = require('js-yaml')
-
-const { component } = require('./component')
-
-const {
-  dependencies,
-  normalize,
-  complete,
-  dereference,
-  expand,
-  validate
-} = require('./.context')
-
-const context = async (root, environment = process.env.TOA_ENV) => {
+import { resolve } from 'node:path'
+import { convolve } from '@toa.io/generic'
+import glob from 'fast-glob'
+import { readFile } from 'node:fs/promises'
+import { yaml as jsyaml } from '@toa.io/generic'
+
+import { component } from './component.js'
+
+import { dependencies, normalize, complete, dereference, expand, validate } from './.context/index.js'
+
+export const context = async (root, environment = process.env.TOA_ENV) => {
   const path = resolve(root, CONTEXT)
   const context = /** @type {toa.norm.Context} */ await read(path)
 
@@ -46,7 +37,7 @@ const COMPONENTS = 'components/*'
 
 const GLOB = { onlyDirectories: true, absolute: true }
 
-exports.context = context
+
 
 /**
  * Reads a YAML file, resolving anchors into distinct objects so that

package/src/index.js

@@ -1,9 +1,3 @@
-'use strict'
-
-const { context } = require('./context')
-const { component } = require('./component')
-
-exports.shortcuts = require('./shortcuts')
-
-exports.context = context
-exports.component = component
+export { context } from './context.js'
+export { component } from './component.js'
+export * as shortcuts from './shortcuts.js'

package/src/shortcuts.js

@@ -1,6 +1,4 @@
-'use strict'
-
-const { empty, merge } = require('@toa.io/generic')
+import { empty, merge } from '@toa.io/generic'
 
 /**
  * Resolves shortcuts
@@ -8,7 +6,7 @@ const { empty, merge } = require('@toa.io/generic')
  * @param {string} token
  * @returns {string}
  */
-const resolve = (token) => {
+export const resolve = (token) => {
   if (token in SHORTCUTS) return SHORTCUTS[token]
   else return token
 }
@@ -20,7 +18,7 @@ const resolve = (token) => {
  * @param {Object} object
  * @param {string} [group]
  */
-const recognize = (shortcuts, object, group) => {
+export const recognize = (shortcuts, object, group) => {
   if (object === undefined) return
 
   const target = group === undefined ? object : {}
@@ -38,7 +36,7 @@ const recognize = (shortcuts, object, group) => {
   if (group !== undefined && !empty(target)) object[group] = merge(object[group], target)
 }
 
-const SHORTCUTS = {
+export const SHORTCUTS = {
   amqp: '@toa.io/bindings.amqp',
   node: '@toa.io/bridges.node',
   bash: '@toa.io/bridges.bash',
@@ -53,7 +51,3 @@ const SHORTCUTS = {
   telemetry: '@toa.io/extensions.telemetry',
   introspection: '@toa.io/extensions.introspection'
 }
-
-exports.recognize = recognize
-exports.resolve = resolve
-exports.SHORTCUTS = SHORTCUTS

package/test/component/collapse.fixtures.js

@@ -1,6 +1,4 @@
-'use strict'
-
-const { generate } = require('randomstring')
+import { generate } from 'randomstring'
 
 const entity = {
   manifest: {
@@ -88,7 +86,6 @@ const operations = {
   result: {
     prototype: {
       prototype: null,
-      path: expect.any(String),
       operations: {
         add: {
           bridge: 'a'
@@ -131,4 +128,4 @@ const remotes = {
   }
 }
 
-exports.samples = { entity, operations, remotes }
+export const samples = { entity, operations, remotes }

package/test/component/collapse.test.js

@@ -1,9 +1,10 @@
-'use strict'
+import { describe, it, beforeEach } from 'node:test'
+import assert from 'node:assert/strict'
 
-const clone = require('clone-deep')
+import clone from 'clone-deep'
 
-const fixtures = require('./collapse.fixtures')
-const { collapse } = require('../../src/.component')
+import * as fixtures from './collapse.fixtures.js'
+import { collapse } from '../../src/.component/index.js'
 
 let samples
 
@@ -18,7 +19,7 @@ it('should ignore locator', () => {
 
   collapse(manifest, prototype)
 
-  expect(manifest).toStrictEqual(source)
+  assert.deepStrictEqual(manifest, source)
 })
 
 it('should remove prototype property', () => {
@@ -26,7 +27,7 @@ it('should remove prototype property', () => {
 
   collapse(manifest, {})
 
-  expect(manifest).toStrictEqual({})
+  assert.deepStrictEqual(manifest, {})
 })
 
 describe('entity', () => {
@@ -34,7 +35,7 @@ describe('entity', () => {
     const manifest = clone(samples.entity.manifest)
 
     collapse(manifest, samples.entity.prototype)
-    expect(manifest).toStrictEqual(samples.entity.result)
+    assert.deepStrictEqual(manifest, samples.entity.result)
   })
 })
 
@@ -44,12 +45,12 @@ it('should ignore bindings', () => {
   const manifest = clone(source)
 
   collapse(manifest, prototype)
-  expect(manifest).toStrictEqual(source)
+  assert.deepStrictEqual(manifest, source)
 
   delete manifest.bindings
 
   collapse(manifest, prototype)
-  expect(manifest).toStrictEqual({})
+  assert.deepStrictEqual(manifest, {})
 })
 
 it('should merge operations', () => {
@@ -57,5 +58,11 @@ it('should merge operations', () => {
   const prototype = clone(samples.operations.prototype)
 
   collapse(manifest, prototype, '/somewhere')
-  expect(manifest).toStrictEqual(samples.operations.result)
+
+  // the prototype's path is generated, so it is checked apart from the shape
+  assert.strictEqual(typeof manifest.prototype.path, 'string')
+
+  const { path, ...rest } = manifest.prototype
+
+  assert.deepStrictEqual({ ...manifest, prototype: rest }, samples.operations.result)
 })

package/test/component/dependencies.test.js

@@ -1,31 +1,33 @@
-'use strict'
+import { describe, it, beforeEach } from 'node:test'
+import assert from 'node:assert/strict'
 
-const { resolve } = require('node:path')
-const { dependencies } = require('../../src/.component')
+import { resolve } from 'node:path'
+import { dependencies } from '../../src/.component/index.js'
 
-const NORM = resolve(__dirname, '../../')
+const NORM = resolve(import.meta.dirname, '../../')
 
 it('should be', async () => {
-  expect(dependencies).toBeInstanceOf(Function)
+  assert.ok(dependencies instanceof Function)
 })
 
 /** @type {toa.norm.Component} */
 let component
 
 beforeEach(() => {
-  component = /** @type {toa.norm.Component} */ { path: __dirname }
+  component = /** @type {toa.norm.Component} */ { path: import.meta.dirname }
 })
 
-describe.each(/** @type {[string, string][]} */ [
+for (const [_, reference] of [
   ['package id', '@toa.io/norm'],
   ['relative path', '../../']
-])('%s', (_, reference) => {
+])
+   describe(`${_}`, () => {
   it('should resolve storage', async () => {
     component.entity = { storage: reference, schema: {} }
 
     dependencies(component)
 
-    expect(component.entity.storage).toStrictEqual(NORM)
+    assert.deepStrictEqual(component.entity.storage, NORM)
   })
 })
 
@@ -34,5 +36,5 @@ it('should resolve toa packages', async () => {
 
   dependencies(component)
 
-  expect(component.entity.storage).toBeDefined()
+  assert.notStrictEqual(component.entity.storage, undefined)
 })

package/test/component/dereference.fixtures.js

@@ -1,6 +1,4 @@
-'use strict'
-
-const source = {
+export const source = {
   entity: {
     schema: {
       properties: {
@@ -66,7 +64,7 @@ const source = {
   }
 }
 
-const target = {
+export const target = {
   entity: {
     schema: {
       properties: {
@@ -160,6 +158,3 @@ const target = {
     }
   }
 }
-
-exports.source = source
-exports.target = target

package/test/component/dereference.test.js

@@ -1,9 +1,10 @@
-'use strict'
+import { it, beforeEach } from 'node:test'
+import assert from 'node:assert/strict'
 
-const clone = require('clone-deep')
+import clone from 'clone-deep'
 
-const { dereference } = require('../../src/.component')
-const fixtures = require('./dereference.fixtures')
+import { dereference } from '../../src/.component/index.js'
+import * as fixtures from './dereference.fixtures.js'
 
 let source
 
@@ -14,18 +15,18 @@ beforeEach(() => {
 it('should dereference', () => {
   dereference(source)
 
-  expect(source).toStrictEqual(fixtures.target)
+  assert.deepStrictEqual(source, fixtures.target)
 })
 
 it('should throw on invalid schema reference', () => {
   source.operations.transit.output.properties.baz = { type: 'string', default: '.' }
-  expect(() => dereference(source)).toThrow(/is not defined/)
+  assert.throws(() => dereference(source), (error) => /is not defined/.test(error.message))
 
   source.operations.transit.output.properties.baz = { type: 'string', default: '.baz' }
-  expect(() => dereference(source)).toThrow(/is not defined/)
+  assert.throws(() => dereference(source), (error) => /is not defined/.test(error.message))
 })
 
 it('should throw on invalid forwarding', () => {
   source.operations.create.forward = 'foo'
-  expect(() => dereference(source)).toThrow(/is not defined/)
+  assert.throws(() => dereference(source), (error) => /is not defined/.test(error.message))
 })

package/test/component/dummies/extension/index.js

@@ -1,9 +1,5 @@
-'use strict'
-
-const manifest = (declaration) => {
+export const manifest = (declaration) => {
   if (declaration.ok !== true) return
 
   return declaration
 }
-
-exports.manifest = manifest

package/test/component/expand.fixtures.js

@@ -1,7 +1,5 @@
-'use strict'
-
-const source = {
-  path: __dirname, // `version` hashes the component directory
+export const source = {
+  path: import.meta.dirname, // `version` hashes the component directory
   entity: {
     schema: {
       type: 'object',
@@ -64,7 +62,7 @@ const source = {
   }
 }
 
-const target = {
+export const target = {
   entity: {
     schema: {
       type: 'object',
@@ -138,6 +136,3 @@ const target = {
     }
   }
 }
-
-exports.source = source
-exports.target = target