json-object-editor 0.10.623 → 0.10.625

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-object-editor",
-  "version": "0.10.623",
+  "version": "0.10.625",
   "description": "JOE the Json Object Editor | Platform Edition",
   "main": "app.js",
   "scripts": {

package/readme.md

@@ -44,12 +44,12 @@ JOE is software that allows you to manage data models via JSON objects. There ar
 
 - Tools
   - `listSchemas(name?)`, `getSchema(name)`
-  - `getObject(_id, schema?)` (supports optional `flatten` and `depth`)
+  - `getObject(_id, itemtype?)` (supports optional `flatten` and `depth`)
   - `search` (exact): unified tool for cache and storage
-    - Params: `{ schema?, query?, ids?, source?: 'cache'|'storage', limit?, flatten?, depth? }`
-    - Defaults to cache across all collections; add `schema` to filter; set `source:"storage"` to query a specific schema in the DB. Use `fuzzySearch` for typo-tolerant free text.
+    - Params: `{ itemtype?, query?, ids?, source?: 'cache'|'storage', limit?, flatten?, depth? }`
+    - Defaults to cache across all collections; add `itemtype` to filter; set `source:"storage"` to query a specific collection in the DB. Runtime accepts legacy alias `schema` (maps to `itemtype`). Use `fuzzySearch` for typo-tolerant free text.
   - `fuzzySearch` (typo-tolerant free text across weighted fields)
-    - Params: `{ schema?, q, filters?, fields?, threshold?, limit?, offset?, highlight?, minQueryLength? }`
+    - Params: `{ itemtype?, q, filters?, fields?, threshold?, limit?, offset?, highlight?, minQueryLength? }`
     - Defaults: `fields` resolved from schema `searchables` (plural) if present; otherwise weights `name:0.6, info:0.3, description:0.1`. `threshold:0.5`, `limit:50`, `minQueryLength:2`.
     - Returns: `{ items, count }`. Each item may include `_score` (0..1) and `_matches` when `highlight` is true.
   - `saveObject({ object })`
@@ -86,17 +86,17 @@ JOE is software that allows you to manage data models via JSON objects. There ar
     ```
   - fuzzySearch (cache):
     ```powershell
-    $body = @{ jsonrpc="2.0"; id="6"; method="fuzzySearch"; params=@{ schema="<schemaName>"; q="st paal"; threshold=0.35; limit=10 } } | ConvertTo-Json -Depth 10
+    $body = @{ jsonrpc="2.0"; id="6"; method="fuzzySearch"; params=@{ itemtype="<schemaName>"; q="st paal"; threshold=0.35; limit=10 } } | ConvertTo-Json -Depth 10
     Invoke-RestMethod -Method Post -Uri "$base/mcp" -Headers $h -Body $body
     ```
   - search (storage):
     ```powershell
-    $body = @{ jsonrpc="2.0"; id="4"; method="search"; params=@{ schema="<schemaName>"; source="storage"; query=@{ }; limit=10 } } | ConvertTo-Json -Depth 10
+    $body = @{ jsonrpc="2.0"; id="4"; method="search"; params=@{ itemtype="<schemaName>"; source="storage"; query=@{ }; limit=10 } } | ConvertTo-Json -Depth 10
     Invoke-RestMethod -Method Post -Uri "$base/mcp" -Headers $h -Body $body
     ```
   - search (ids + flatten):
     ```powershell
-    $body = @{ jsonrpc="2.0"; id="5"; method="search"; params=@{ schema="<schemaName>"; ids=@("<id1>","<id2>"); flatten=$true; depth=2 } } | ConvertTo-Json -Depth 10
+    $body = @{ jsonrpc="2.0"; id="5"; method="search"; params=@{ itemtype="<schemaName>"; ids=@("<id1>","<id2>"); flatten=$true; depth=2 } } | ConvertTo-Json -Depth 10
     Invoke-RestMethod -Method Post -Uri "$base/mcp" -Headers $h -Body $body
     ```
   - saveObject:
@@ -131,13 +131,13 @@ JOE is software that allows you to manage data models via JSON objects. There ar
     ```bash
     curl -s -X POST http://localhost:<PORT>/mcp \
       -H 'Content-Type: application/json' \
-      -d '{"jsonrpc":"2.0","id":"6","method":"fuzzySearch","params":{"schema":"<schemaName>","q":"st paal","threshold":0.35,"limit":10}}' | jq
+      -d '{"jsonrpc":"2.0","id":"6","method":"fuzzySearch","params":{"itemtype":"<schemaName>","q":"st paal","threshold":0.35,"limit":10}}' | jq
     ```
   - search (storage):
     ```bash
     curl -s -X POST http://localhost:<PORT>/mcp \
       -H 'Content-Type: application/json' \
-      -d '{"jsonrpc":"2.0","id":"4","method":"search","params":{"schema":"<schemaName>","source":"storage","query":{},"limit":10}}' | jq
+      -d '{"jsonrpc":"2.0","id":"4","method":"search","params":{"itemtype":"<schemaName>","source":"storage","query":{},"limit":10}}' | jq
     ```
     ```bash
     curl -s -X POST http://localhost:<PORT>/mcp \

package/server/modules/MCP.js

@@ -125,19 +125,21 @@ MCP.tools = {
     }
   },
 
-  // Convenience: fetch a single object by _id (schema optional). Prefer cache; fallback to storage.
-  getObject: async ({ _id, schema, flatten = false, depth = 1 }, _ctx) => {
+  // Convenience: fetch a single object by _id (itemtype optional). Prefer cache; fallback to storage.
+  // Accepts legacy alias 'schema' for itemtype.
+  getObject: async ({ _id, itemtype, schema, flatten = false, depth = 1 }, _ctx) => {
     if (!_id) throw new Error("Missing required param '_id'");
+    itemtype = itemtype || schema; // legacy alias
     // Fast path via global lookup
     let obj = (JOE && JOE.Cache && JOE.Cache.findByID) ? (JOE.Cache.findByID(_id) || null) : null;
-    if (!obj && schema) {
-      const results = await loadFromStorage(schema, { _id });
+    if (!obj && itemtype) {
+      const results = await loadFromStorage(itemtype, { _id });
       obj = (results && results[0]) || null;
     }
-    if (!obj && schema && JOE && JOE.Cache && JOE.Cache.findByID) {
-      obj = JOE.Cache.findByID(schema, _id) || null;
+    if (!obj && itemtype && JOE && JOE.Cache && JOE.Cache.findByID) {
+      obj = JOE.Cache.findByID(itemtype, _id) || null;
     }
-    if (!obj) throw new Error(`Object not found${schema?(' in '+schema):''} with _id: ${_id}`);
+    if (!obj) throw new Error(`Object not found${itemtype?(' in '+itemtype):''} with _id: ${_id}`);
     if (flatten && JOE && JOE.Utils && JOE.Utils.flattenObject) {
       try { return sanitizeItems(JOE.Utils.flattenObject(_id, { recursive: true, depth }))[0]; } catch(e) {}
     }
@@ -153,23 +155,25 @@ MCP.tools = {
   searchCache: async () => { throw new Error('Use search instead'); },
   */
 
-  // Unified search: defaults to cache; set source="storage" to query DB for a schema
-  search: async ({ schema, query = {}, ids, source = 'cache', limit = 50, offset = 0, flatten = false, depth = 1, countOnly = false, withCount = false, sortBy, sortDir = 'desc', slim = false }, _ctx) => {
+  // Unified search: defaults to cache; set source="storage" to query DB for a given itemtype
+  // Accepts legacy alias 'schema' for itemtype.
+  search: async ({ itemtype, schema, query = {}, ids, source = 'cache', limit = 50, offset = 0, flatten = false, depth = 1, countOnly = false, withCount = false, sortBy, sortDir = 'desc', slim = false }, _ctx) => {
+    itemtype = itemtype || schema; // legacy alias
     const useCache = !source || source === 'cache';
     const useStorage = source === 'storage';
 
     if (ids && !Array.isArray(ids)) throw new Error("'ids' must be an array if provided");
 
-    // When ids are provided and a schema is known, prefer cache for safety/speed
-    if (Array.isArray(ids) && schema) {
+    // When ids are provided and an itemtype is known, prefer cache for safety/speed
+    if (Array.isArray(ids) && itemtype) {
       let items = [];
       if (JOE && JOE.Cache && JOE.Cache.findByID) {
-        const found = JOE.Cache.findByID(schema, ids.join(',')) || [];
+        const found = JOE.Cache.findByID(itemtype, ids.join(',')) || [];
         items = Array.isArray(found) ? found : (found ? [found] : []);
       }
       if (useStorage && (!items || items.length === 0)) {
         try {
-          const fromStorage = await loadFromStorage(schema, { _id: { $in: ids } });
+          const fromStorage = await loadFromStorage(itemtype, { _id: { $in: ids } });
           items = fromStorage || [];
         } catch (e) { /* ignore storage errors here */ }
       }
@@ -192,7 +196,7 @@ MCP.tools = {
     if (useCache) {
       if (!JOE || !JOE.Cache || !JOE.Cache.search) throw new Error('Cache not initialized');
       let results = JOE.Cache.search(query || {});
-      if (schema) results = (results || []).filter(i => i && i.itemtype === schema);
+      if (itemtype) results = (results || []).filter(i => i && i.itemtype === itemtype);
       results = sortItems(results, sortBy, sortDir);
       if (countOnly) {
         return { count: (results || []).length };
@@ -206,8 +210,8 @@ MCP.tools = {
     }
 
     if (useStorage) {
-      if (!schema) throw new Error("'schema' is required when source=storage");
-      const results = await loadFromStorage(schema, query || {});
+      if (!itemtype) throw new Error("'itemtype' is required when source=storage");
+      const results = await loadFromStorage(itemtype, query || {});
       let sorted = sortItems(results, sortBy, sortDir);
       if (countOnly) {
         return { count: (sorted || []).length };
@@ -227,7 +231,9 @@ MCP.tools = {
   },
 
   // Fuzzy, typo-tolerant search over cache with weighted fields
-  fuzzySearch: async ({ schema, q, filters = {}, fields, threshold = 0.35, limit = 50, offset = 0, highlight = false, minQueryLength = 2 }, _ctx) => {
+  // Accepts legacy alias 'schema' for itemtype.
+  fuzzySearch: async ({ itemtype, schema, q, filters = {}, fields, threshold = 0.35, limit = 50, offset = 0, highlight = false, minQueryLength = 2 }, _ctx) => {
+    itemtype = itemtype || schema; // legacy alias
     if (!q || (q+'').length < (minQueryLength||2)) {
       return { items: [] };
     }
@@ -235,7 +241,7 @@ MCP.tools = {
     var query = Object.assign({}, filters || {});
     query.$fuzzy = { q, fields, threshold, limit, offset, highlight, minQueryLength };
     var results = JOE.Cache.search(query) || [];
-    if (schema) { results = results.filter(function(i){ return i && i.itemtype === schema; }); }
+    if (itemtype) { results = results.filter(function(i){ return i && i.itemtype === itemtype; }); }
     var total = (typeof results.count === 'number') ? results.count : results.length;
     if (typeof limit === 'number' && limit > 0) { results = results.slice(0, limit); }
     return { items: sanitizeItems(results), count: total };
@@ -372,12 +378,12 @@ MCP.descriptions = {
   listSchemas: "List all available JOE schema names.",
   getSchema: "Retrieve schema by name. Set summaryOnly=true for normalized summary instead of full schema.",
   getSchemas: "Retrieve multiple schemas. With summaryOnly=true, returns summaries; if names omitted, returns all.",
-  getObject: "Fetch a single object by _id (schema optional). Supports optional flatten.",
+  getObject: "Fetch a single object by _id (itemtype optional). Supports optional flatten. Accepts legacy alias 'schema' for itemtype.",
   // getObjectsByIds: "Deprecated - use 'search' with ids.",
   // queryObjects: "Deprecated - use 'search'.",
   // searchCache: "Deprecated - use 'search'.",
-  search: "Exact search. Defaults to cache; set source=storage to query DB. Supports sortBy/sortDir, offset/limit paging, withCount, and slim response for {_id,itemtype,name,info,joeUpdated,created}. Use fuzzySearch for typo-tolerant free text.",
-  fuzzySearch: "Fuzzy free‑text search. Candidates are prefiltered by 'filters' (e.g., { itemtype: 'user' }) and then scored. If 'fields' are omitted, the schema's searchables (strings) are used with best-field scoring; provide 'fields' (strings or {path,weight}) to use weighted sums. Examples: { q: 'corey hadden', filters: { itemtype: 'user' } } or { q: 'backyard', filters: { itemtype: 'house' } }.",
+  search: "Exact search. Defaults to cache; set source=storage to query DB. Supports sortBy/sortDir, offset/limit paging, withCount, and slim response for {_id,itemtype,name,info,joeUpdated,created}. Accepts legacy alias 'schema' for itemtype. Use fuzzySearch for typo-tolerant free text.",
+  fuzzySearch: "Fuzzy free‑text search. Candidates are prefiltered by 'filters' (e.g., { itemtype: 'user' }) and then scored. Accepts legacy alias 'schema' for itemtype. If 'fields' are omitted, the schema's searchables (strings) are used with best-field scoring; provide 'fields' (strings or {path,weight}) to use weighted sums. Examples: { q: 'corey hadden', filters: { itemtype: 'user' } } or { q: 'backyard', filters: { itemtype: 'house' } }.",
   saveObject: "Create/update an object; triggers events/history.",
   saveObjects: "Batch save objects with bounded concurrency; per-item history/events preserved.",
   hydrate: "Loads and merges the full JOE context, including core and organization-specific schemas, relationships, universal fields (tags and statuses), and datasets. Returns a single unified object describing the active environment for use by agents, UIs, and plugins.",
@@ -406,7 +412,7 @@ MCP.params = {
     type: "object",
     properties: {
       _id: { type: "string" },
-      schema: { type: "string" },
+      itemtype: { type: "string" },
       flatten: { type: "boolean" },
       depth: { type: "integer" }
     },
@@ -418,7 +424,7 @@ MCP.params = {
   search: {
     type: "object",
     properties: {
-      schema: { type: "string" },
+      itemtype: { type: "string" },
       query: { type: "object" },
       ids: { type: "array", items: { type: "string" } },
       source: { type: "string", enum: ["cache","storage"] },
@@ -437,7 +443,7 @@ MCP.params = {
   fuzzySearch: {
     type: "object",
     properties: {
-      schema: { type: "string" },
+      itemtype: { type: "string" },
       q: { type: "string" },
       filters: { type: "object" },
       fields: {