@toa.io/bridges.node 0.6.0 → 0.7.0-dev.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/bridges.node",
-  "version": "0.6.0",
+  "version": "0.7.0-dev.1",
   "description": "Toa Node Bridge (inproc)",
   "homepage": "https://toa.io",
   "author": {
@@ -26,13 +26,13 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@toa.io/core": "0.6.0",
-    "@toa.io/filesystem": "0.6.0",
-    "@toa.io/generic": "0.6.0",
+    "@toa.io/core": "0.7.0-dev.1",
+    "@toa.io/filesystem": "0.7.0-dev.1",
+    "@toa.io/generic": "0.7.0-dev.1",
     "fast-glob": "3.2.7"
   },
   "devDependencies": {
     "clone-deep": "4.0.1"
   },
-  "gitHead": "a807d9906db194f5851613a1ead5450d277f4939"
+  "gitHead": "1ebdef6733499671422b624ee4e11ab4aa5dd21a"
 }

package/src/context.js

@@ -3,6 +3,8 @@
 const { Connector } = require('@toa.io/core')
 const { underlay } = require('@toa.io/generic')
 
+const shortcuts = require('./shortcuts')
+
 /**
  * @implements {toa.node.Context}
  */
@@ -48,39 +50,11 @@ class Context extends Connector {
 
       map[aspect.name] = aspect.invoke.bind(aspect)
 
-      // well-known aspects
-      if (aspect.name === 'configuration') this.#configuration(aspect)
-      if (aspect.name === 'origins') this.origins = this.#origins(aspect)
+      if (aspect.name in shortcuts) shortcuts[aspect.name](this, aspect)
     }
 
     return map
   }
-
-  /**
-   * @param {toa.core.extensions.Aspect} aspect
-   */
-  #origins (aspect) {
-    return underlay(async (segs, args) => {
-      if (segs.length < 2) throw new Error(`Origins call requires at least 2 arguments, ${segs.length} given`)
-
-      const name = segs.shift()
-      const method = segs.pop().toUpperCase()
-      const path = segs.join('/')
-      const request = { method, ...args[0] }
-      const options = args[1]
-
-      return await aspect.invoke(name, path, request, options)
-    })
-  }
-
-  /**
-   * @param {toa.core.extensions.Aspect} aspect
-   */
-  #configuration (aspect) {
-    Object.defineProperty(this, 'configuration', {
-      get: () => aspect.invoke()
-    })
-  }
 }
 
 exports.Context = Context

package/src/shortcuts/configuration.js

@@ -0,0 +1,10 @@
+'use strict'
+
+/** @type {toa.node.shortcut} */
+const configuration = (context, aspect) => {
+  Object.defineProperty(context, 'configuration', {
+    get: () => aspect.invoke()
+  })
+}
+
+exports.configuration = configuration

package/src/shortcuts/index.js

@@ -0,0 +1,9 @@
+'use strict'
+
+const { origins } = require('./origins')
+const { configuration } = require('./configuration')
+const { state } = require('./state')
+
+exports.origins = origins
+exports.configuration = configuration
+exports.state = state

package/src/shortcuts/origins.js

@@ -0,0 +1,20 @@
+'use strict'
+
+const { underlay } = require('@toa.io/generic')
+
+/** @type {toa.node.shortcut} */
+const origins = (context, aspect) => {
+  context.origins = underlay(async (segs, args) => {
+    if (segs.length < 2) throw new Error(`Origins call requires at least 2 arguments, ${segs.length} given`)
+
+    const name = segs.shift()
+    const method = segs.pop().toUpperCase()
+    const path = segs.join('/')
+    const request = { method, ...args[0] }
+    const options = args[1]
+
+    return await aspect.invoke(name, path, request, options)
+  })
+}
+
+exports.origins = origins

package/src/shortcuts/state.js

@@ -0,0 +1,54 @@
+'use strict'
+
+const { generate } = require('@toa.io/generic')
+
+/** @type {toa.node.shortcut} */
+const state = (context, aspect) => {
+  context.state = generate((segs, value) => {
+    if (value === undefined) return get(aspect, segs)
+    else set(aspect, segs, value)
+  })
+}
+
+/**
+ * @param {toa.core.extensions.Aspect} aspect
+ * @param {string[]} segs
+ * @return {any}
+ */
+function get (aspect, segs) {
+  let cursor = aspect.invoke()
+
+  for (const seg of segs) cursor = cursor[seg]
+
+  return cursor
+}
+
+/**
+ * @param {toa.core.extensions.Aspect} aspect
+ * @param {string[]} segs
+ * @param {any} value
+ */
+function set (aspect, segs, value) {
+  const object = build(segs, value)
+
+  aspect.invoke(object)
+}
+
+/**
+ * @param {string[]} segs
+ * @param {any} value
+ */
+function build (segs, value) {
+  const object = {}
+  let cursor = object
+  const key = segs.pop()
+
+  for (const seg of segs) cursor = cursor[seg] = {}
+
+  if (value !== undefined) cursor[key] = value
+  else cursor[key] = {}
+
+  return object
+}
+
+exports.state = state

package/test/context.state.fixtures.js

@@ -0,0 +1,16 @@
+'use strict'
+
+const context = {
+  apply: jest.fn(),
+  call: jest.fn(),
+  aspects: [
+    {
+      name: 'state',
+      invoke: jest.fn()
+    }
+  ],
+  link: jest.fn(),
+  connect: jest.fn()
+}
+
+exports.context = context

package/test/context.state.test.js

@@ -0,0 +1,40 @@
+'use strict'
+
+const fixtures = require('./context.state.fixtures')
+const { Context } = require('../src/context')
+const { generate } = require('randomstring')
+
+const state = fixtures.context.aspects[0]
+
+/** @type {Context} */
+let context
+
+beforeEach(async () => {
+  jest.clearAllMocks()
+
+  context = new Context(fixtures.context)
+
+  await context.connect()
+})
+
+it('should expose aspect', async () => {
+  expect(context.aspects.state).toBeDefined()
+})
+
+it('should set value', async () => {
+  context.state.a = 1
+
+  expect(state.invoke).toHaveBeenCalledWith({ a: 1 })
+})
+
+it('should get value', async () => {
+  const b = generate()
+
+  state.invoke.mockImplementation(() => ({ a: { b } }))
+
+  const value = context.state.a.b
+
+  expect(value).toStrictEqual(b)
+
+  state.invoke.mockClear()
+})

package/types/context.d.ts

@@ -1,22 +1,22 @@
 import { Underlay } from '@toa.io/generic/types'
-import { Connector } from "@toa.io/core/types";
+import { Connector } from '@toa.io/core/types'
+import { Aspect } from '@toa.io/core/types/extensions'
 
 declare namespace toa.node {
 
-  interface Aspectes {
-    [key: string]: Function
-  }
-
   interface Context extends Connector {
     local: Underlay
     remote: Underlay
-    aspects: Aspectes
+    aspects: Record<string, Function>
 
     // known extensions
     origins?: Underlay
-    configuration?: Underlay
+    configuration?: object
+    state?: object
   }
 
+  type shortcut = (context: Context, aspect: Aspect) => void
+
 }
 
 export type Context = toa.node.Context