@knowlearning/agents 0.9.14 → 0.9.15

package/agents/generic.js

@@ -1,6 +1,9 @@
 import MutableProxy from '../persistence/json.js'
 import download from './download.js'
 
+// TODO: consider using something better than name as mechanism
+//       for resoling default scope in context
+const DEFAULT_SCOPE_NAME = '[]'
 const HEARTBEAT_TIMEOUT = 10000
 const SESSION_TYPE = 'application/json;type=session'
 const UPLOAD_TYPE = 'application/json;type=upload'
@@ -297,7 +300,7 @@ export default function Agent({ host, token, WebSocket, protocol='ws', uuid, fet
     })
   }
 
-  function watch(id, fn) {
+  function watch(scope=DEFAULT_SCOPE_NAME, fn) {
     let initialSent = false
     const queue = []
     function cb(update) {
@@ -305,14 +308,14 @@ export default function Agent({ host, token, WebSocket, protocol='ws', uuid, fet
       else queue.push(update)
     }
 
-    const statePromise = state(id)
-    if (!watchers[id]) watchers[id] = []
-    watchers[id].push(cb)
+    const statePromise = state(scope)
+    if (!watchers[scope]) watchers[scope] = []
+    watchers[scope].push(cb)
 
-    metadata(id)
+    metadata(scope)
       .then(async ({ ii }) => {
         fn({
-          scope: id,
+          scope,
           state: await statePromise,
           patch: null,
           ii
@@ -321,7 +324,7 @@ export default function Agent({ host, token, WebSocket, protocol='ws', uuid, fet
         queue.forEach(fn)
       })
 
-    return () => removeWatcher(id, cb)
+    return () => removeWatcher(scope, cb)
   }
 
   //  TODO: if no data, set up streaming upload
@@ -351,7 +354,7 @@ export default function Agent({ host, token, WebSocket, protocol='ws', uuid, fet
   }
 
   //  TODO: addTag option should probably not be exposed
-  async function interact(scope, patch, addTag=true) {
+  async function interact(scope=DEFAULT_SCOPE_NAME, patch, addTag=true) {
     if (addTag) tagIfNotYetTaggedInSession('mutated', scope)
     //  TODO: ensure user is owner of scope
     const response = queueMessage({scope, patch})
@@ -383,7 +386,7 @@ export default function Agent({ host, token, WebSocket, protocol='ws', uuid, fet
     return interact('claims', [{ op: 'add', path: ['active', domain], value: null }])
   }
 
-  function reset(scope) {
+  function reset(scope=DEFAULT_SCOPE_NAME) {
     return interact(scope, [{ op: 'remove', path:['active'] }])
   }
 
@@ -395,7 +398,8 @@ export default function Agent({ host, token, WebSocket, protocol='ws', uuid, fet
     )
   }
 
-  async function metadata(id) {
+  async function metadata(id=DEFAULT_SCOPE_NAME) {
+    // TODO: handle when id is undefined (default like state call?)
     await state(id)
     const md = structuredClone(await states[id])
     delete md.active

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowlearning/agents",
-  "version": "0.9.14",
+  "version": "0.9.15",
   "description": "API for embedding applications in KnowLearning systems.",
   "main": "node.js",
   "browser": "browser.js",