@toa.io/norm 0.7.1 → 0.7.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/norm",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "description": "Toa declarations normalization and validation",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -19,7 +19,7 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "devDependencies": {
-    "@toa.io/mock": "0.7.1"
+    "@toa.io/mock": "0.7.2"
   },
   "dependencies": {
     "@toa.io/core": "0.7.0",
@@ -28,5 +28,5 @@
     "@toa.io/schemas": "0.7.0",
     "@toa.io/yaml": "0.7.0"
   },
-  "gitHead": "8a50eb96d584d45797d37a64e9a8e019dd956e86"
+  "gitHead": "42b78a9a964d1d8b2925bcf1cc02c737c48d0304"
 }

package/src/.component/dependencies.js

@@ -0,0 +1,29 @@
+'use strict'
+
+const { join, dirname } = require('node:path')
+
+/**
+ * @param {toa.norm.Component} component
+ */
+const dependencies = (component) => {
+  if ('entity' in component) component.entity.storage = resolve(component.path, component.entity.storage)
+}
+
+function resolve (root, reference) {
+  const paths = [root, __dirname]
+  const options = { paths }
+
+  let path
+
+  try { // as package
+    const packageJsonRef = join(reference, 'package.json')
+
+    path = require.resolve(packageJsonRef, options)
+  } catch { // as directory
+    path = require.resolve(reference, options)
+  }
+
+  return dirname(path)
+}
+
+exports.dependencies = dependencies

package/src/.component/index.js

@@ -2,6 +2,7 @@
 
 const { collapse } = require('./collapse')
 const { defaults } = require('./defaults')
+const { dependencies } = require('./dependencies')
 const { dereference } = require('./dereference')
 const { expand } = require('./expand')
 const { merge } = require('./merge')
@@ -10,6 +11,7 @@ const { validate } = require('./validate')
 
 exports.collapse = collapse
 exports.defaults = defaults
+exports.dependencies = dependencies
 exports.dereference = dereference
 exports.expand = expand
 exports.merge = merge

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

@@ -0,0 +1,36 @@
+'use strict'
+
+const { join } = require('node:path')
+
+/**
+ * @param {string} path
+ * @returns {{ metadata: object, module: object }}
+ */
+function load (path) {
+  const metadata = loadMetadata(path)
+  const module = loadModule(path)
+
+  return { metadata, module }
+}
+
+function loadMetadata (reference) {
+  reference = join(reference, 'package.json')
+
+  try {
+    return require(reference)
+  } catch {
+    return null
+  }
+}
+
+/**
+ * @param {string} reference
+ * @returns {object}
+ */
+function loadModule (reference) {
+  const path = require.resolve(reference)
+
+  return require(path)
+}
+
+exports.load = load

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

@@ -1,6 +1,7 @@
 'use strict'
 
 const { join } = require('node:path')
+const { load } = require('./load')
 
 /**
  * @param {toa.norm.context.dependencies.References} references
@@ -12,7 +13,8 @@ const resolve = (references, annotations) => {
   const dependencies = {}
 
   for (const [dependency, components] of Object.entries(references)) {
-    const id = name(dependency)
+    const { metadata, module } = load(dependency)
+    const id = metadata.name
 
     const instances = components.map((component) => ({
       locator: component.locator,
@@ -22,7 +24,6 @@ const resolve = (references, annotations) => {
     dependencies[dependency] = instances
 
     const annotation = annotations?.[id]
-    const module = require(dependency)
 
     if (annotation !== undefined && module.annotation !== undefined) {
       annotations[id] = module.annotation(annotation, instances)
@@ -32,14 +33,4 @@ const resolve = (references, annotations) => {
   return dependencies
 }
 
-/**
- * @param {string} dependency
- * @returns {string}
- */
-const name = (dependency) => {
-  const pkg = require(join(dependency, 'package.json'))
-
-  return pkg.name
-}
-
 exports.resolve = resolve

package/src/component.js

@@ -13,6 +13,7 @@ const {
   collapse,
   dereference,
   defaults,
+  dependencies,
   normalize
 } = require('./.component')
 
@@ -32,7 +33,7 @@ const load = async (path, base) => {
   if (base !== undefined) path = find(path, base, MANIFEST)
 
   const file = join(path, MANIFEST)
-  const manifest = await yaml(file)
+  const manifest = /** @type {toa.norm.Component} */ await yaml(file)
 
   manifest.path = path
 
@@ -50,6 +51,7 @@ const load = async (path, base) => {
   }
 
   dereference(manifest)
+  dependencies(manifest)
 
   return manifest
 }

package/test/component/dependencies.test.js

@@ -0,0 +1,38 @@
+'use strict'
+
+const { resolve } = require('node:path')
+const { dependencies } = require('../../src/.component')
+
+const NORM = resolve(__dirname, '../../')
+
+it('should be', async () => {
+  expect(dependencies).toBeInstanceOf(Function)
+})
+
+/** @type {toa.norm.Component} */
+let component
+
+beforeEach(() => {
+  component = /** @type {toa.norm.Component} */ { path: __dirname }
+})
+
+describe.each(/** @type {[string, string][]} */ [
+  ['package id', '@toa.io/norm'],
+  ['relative path', '../../']
+])('%s', (_, reference) => {
+  it('should resolve storage', async () => {
+    component.entity = { storage: reference, schema: {} }
+
+    dependencies(component)
+
+    expect(component.entity.storage).toStrictEqual(NORM)
+  })
+})
+
+it('should resolve toa packages', async () => {
+  component.entity = { storage: '@toa.io/core', schema: {} }
+
+  dependencies(component)
+
+  expect(component.entity.storage).toBeDefined()
+})

package/test/context/dependencies.load.test.js

@@ -0,0 +1,24 @@
+'use strict'
+
+const { join } = require('node:path')
+const { load } = require('../../src/.context/.dependencies/load')
+
+it('should be', async () => {
+  expect(load).toBeInstanceOf(Function)
+})
+
+it('should load module', async () => {
+  const path = join(__dirname, '../../')
+  const { metadata, module } = load(path)
+
+  expect(metadata.name).toStrictEqual('@toa.io/norm')
+  expect(module.context).toBeInstanceOf(Function)
+})
+
+it('should return null metadata if no package.json', async () => {
+  const path = join(__dirname, '../../src')
+  const { metadata, module } = load(path)
+
+  expect(metadata).toBeNull()
+  expect(module.context).toBeInstanceOf(Function)
+})

package/types/component.d.ts

@@ -45,12 +45,13 @@ export namespace toa.norm {
     }
 
     type Entity = {
-      schema: object
+      schema: Object
       storage?: string
       initialized?: boolean
     }
 
     interface Declaration {
+      prototype: string
       namespace: string
       name: string
       version: string
@@ -60,7 +61,7 @@ export namespace toa.norm {
       events?: Events
       receivers: Record<string, Receiver>
       extensions?: Record<string, object>
-      properties: Record<string, object>
+      properties?: Record<string, object>
     }
 
     type Constructor = (path: string) => Promise<Component>