cyberia 3.2.5 → 3.2.12

package/src/api/cyberia-client-hints/cyberia-client-hints.service.js

@@ -0,0 +1,152 @@
+/**
+ * @module src/api/cyberia-client-hints/cyberia-client-hints.service.js
+ *
+ * Read-only service layer for client presentation hints.
+ *
+ * Resolution order (highest priority first):
+ *   1. CyberiaClientHints collection — the dedicated presentation-overrides
+ *      collection. Always preferred when present.
+ *   2. Compatibility read on CyberiaInstanceConf with the same `code` —
+ *      covers instances seeded before CyberiaClientHints existed.
+ *   3. Canonical compile-time defaults from
+ *      SharedDefaultsCyberia.js. The C client bakes the
+ *      same defaults at compile time, so this branch returns exactly the
+ *      values the client already has.
+ *
+ * Caching: in-memory TTL cache keyed by instance code. Read-only on the
+ * hot path; cache writes happen on cache miss + DB hit. CMS writes that
+ * mutate the underlying collection should call `clientHintsInvalidate(code)`.
+ *
+ * Output is a plain JSON-friendly object whose shape matches the C
+ * client's compile-time layout.
+ */
+
+import { DataBaseProviderService } from '../../db/DataBaseProvider.js';
+import { loggerFactory } from '../../server/logger.js';
+import { resolveHostKeyContext } from '../../server/conf.js';
+import {
+  buildClientHints,
+  CYBERIA_CLIENT_HINTS_DEFAULTS,
+} from '../../client/components/cyberia/SharedDefaultsCyberia.js';
+
+const logger = loggerFactory(import.meta);
+
+// TTL chosen long enough that bursty client fetches are absorbed, short
+// enough that an editor change shows up within ~30s without manual flush.
+const CACHE_TTL_MS = 30_000;
+
+// One per instance code. value: { data, expiresAt }
+const cache = new Map();
+
+function now() {
+  return Date.now();
+}
+
+function cacheGet(code) {
+  const entry = cache.get(code);
+  if (!entry) return null;
+  if (entry.expiresAt < now()) {
+    cache.delete(code);
+    return null;
+  }
+  return entry.data;
+}
+
+function cacheSet(code, data) {
+  cache.set(code, { data, expiresAt: now() + CACHE_TTL_MS });
+}
+
+/** Invalidate a cache entry. CMS write paths should call this after
+ *  mutating either CyberiaClientHints or CyberiaInstanceConf for
+ *  the given code. */
+export function clientHintsInvalidate(code) {
+  if (code) {
+    cache.delete(code);
+  } else {
+    cache.clear();
+  }
+}
+
+/**
+ * Resolve the merged client-hints document for an instance code.
+ *
+ * @param {string} code
+ * @param {Object} options  Engine routing context.
+ * @param {string} [options.host='default'] DataBaseProviderService host key.
+ * @param {string} [options.path='/']       DataBaseProviderService path key.
+ * @returns {Promise<{data: object, source: 'cache'|'presentation-hints'|'instance-conf'|'defaults'}>}
+ */
+export async function resolveClientHints(code, options = {}) {
+  if (code) {
+    const cached = cacheGet(code);
+    if (cached) {
+      return { data: cached, source: 'cache' };
+    }
+  }
+
+  const host = options.host || 'default';
+  const path = options.path || '/';
+  const context = { host, path };
+  const id = resolveHostKeyContext(context);
+
+  let HintsModel = null;
+  let ConfModel = null;
+  try {
+    HintsModel = DataBaseProviderService.getModel('CyberiaClientHints', context);
+  } catch {
+    // model may not be mounted on this context
+  }
+  try {
+    ConfModel = DataBaseProviderService.getModel('CyberiaInstanceConf', context);
+  } catch {
+    // model may not be mounted on this context
+  }
+
+  if (!HintsModel && !ConfModel) {
+    logger.warn('client-hints: mongoose models not available for', id, '— returning defaults');
+    return { data: CYBERIA_CLIENT_HINTS_DEFAULTS, source: 'defaults' };
+  }
+
+  // 1. Preferred — CyberiaClientHints collection (src/api/cyberia-client-hints/cyberia-client-hints.model.js).
+  if (HintsModel && code) {
+    const hint = await HintsModel.findOne({ code }).lean().catch(() => null);
+    if (hint) {
+      const merged = buildClientHints(hint);
+      cacheSet(code, merged);
+      return { data: merged, source: 'presentation-hints' };
+    }
+  }
+
+  // 2. Compatibility read — for instances seeded before CyberiaClientHints
+  //    existed, look up the same code in CyberiaInstanceConf and read its
+  //    presentation-shaped fields directly.
+  if (ConfModel && code) {
+    const fromConf =
+      (await ConfModel.findOne({ code }).lean().catch(() => null)) ||
+      (await ConfModel.findById(code).lean().catch(() => null));
+    if (fromConf) {
+      const merged = buildClientHints(fromConf);
+      cacheSet(code, merged);
+      return { data: merged, source: 'instance-conf' };
+    }
+  }
+
+  // 3. Any available CyberiaClientHints document — used when the requested
+  //    code has no record yet but another instance (e.g. the one the Go
+  //    server is currently running) does.  This avoids pure built-in
+  //    defaults in fresh environments where only a different code is seeded.
+  if (HintsModel) {
+    const anyHint = await HintsModel.findOne({}).lean().catch(() => null);
+    if (anyHint) {
+      const merged = buildClientHints(anyHint);
+      // Cache under the requested code so subsequent requests are fast,
+      // but with a shorter TTL (5 s) so a proper seed wins quickly.
+      if (code) cache.set(code, { data: merged, expiresAt: now() + 5_000 });
+      return { data: merged, source: 'presentation-hints-fallback' };
+    }
+  }
+
+  // 4. Canonical defaults. Not cached — we do not poison the cache with
+  //    a default that could mask a later DB insert.
+  return { data: CYBERIA_CLIENT_HINTS_DEFAULTS, source: 'defaults' };
+}

package/src/api/cyberia-dialogue/cyberia-dialogue.controller.js

@@ -3,8 +3,8 @@ import { CyberiaDialogueService } from './cyberia-dialogue.service.js';
 
 const logger = loggerFactory(import.meta);
 
-const CyberiaDialogueController = {
-  post: async (req, res, options) => {
+class CyberiaDialogueController {
+  static post = async (req, res, options) => {
     try {
       const result = await CyberiaDialogueService.post(req, res, options);
       return res.status(200).json({
@@ -18,8 +18,8 @@ const CyberiaDialogueController = {
         message: error.message,
       });
     }
-  },
-  get: async (req, res, options) => {
+  };
+  static get = async (req, res, options) => {
     try {
       const { page, limit } = req.query;
       const result = await CyberiaDialogueService.get(
@@ -38,8 +38,8 @@ const CyberiaDialogueController = {
         message: error.message,
       });
     }
-  },
-  put: async (req, res, options) => {
+  };
+  static put = async (req, res, options) => {
     try {
       const result = await CyberiaDialogueService.put(req, res, options);
       return res.status(200).json({
@@ -53,8 +53,8 @@ const CyberiaDialogueController = {
         message: error.message,
       });
     }
-  },
-  delete: async (req, res, options) => {
+  };
+  static delete = async (req, res, options) => {
     try {
       const result = await CyberiaDialogueService.delete(req, res, options);
       return res.status(200).json({
@@ -68,14 +68,14 @@ const CyberiaDialogueController = {
         message: error.message,
       });
     }
-  },
-  getByItemId: async (req, res, options) => {
+  };
+  static getByCode = async (req, res, options) => {
     try {
       if (req && req.headers && req.headers.origin) {
         res.set('Access-Control-Allow-Origin', req.headers.origin);
       } else res.setHeader('Access-Control-Allow-Origin', '*');
       res.setHeader('Cross-Origin-Resource-Policy', 'cross-origin');
-      const result = await CyberiaDialogueService.getByItemId(req, res, options);
+      const result = await CyberiaDialogueService.getByCode(req, res, options);
       return res.status(200).json({
         status: 'success',
         data: result,
@@ -87,7 +87,7 @@ const CyberiaDialogueController = {
         message: error.message,
       });
     }
-  },
-};
+  };
+}
 
 export { CyberiaDialogueController };

package/src/api/cyberia-dialogue/cyberia-dialogue.model.js

@@ -3,20 +3,20 @@ import { Schema, model, Types } from 'mongoose';
 // https://mongoosejs.com/docs/2.7.x/docs/schematypes.html
 
 /**
- * CyberiaDialogue — each document is a single dialogue record tied to an
- * item ID from DefaultCyberiaItems.  One item may have many dialogue records
- * (ordered by `order`).  The client displays them sequentially when the
- * player interacts with an entity whose active item layers match `itemId`.
+ * CyberiaDialogue — each document is one dialogue line that belongs to a
+ * named dialogue group (`code`).  One code groups many ordered lines.
  *
- *   itemId  – references an entry in DefaultCyberiaItems (e.g. "lain", "eiri")
- *   order   – zero-based index governing the display sequence
- *   speaker – display name shown above the dialogue line
- *   text    – the dialogue line itself
- *   mood    – optional emotion hint (neutral / angry / sad / happy / …)
+ * Schema fields:
+ *   code    – primary grouping key, e.g. "default-lain" or "wason-intro".
+ *             The C client fetches all lines for a given code in one request.
+ *   order   – zero-based display sequence within the code group.
+ *   speaker – display name shown above the dialogue line.
+ *   text    – the dialogue line itself.
+ *   mood    – optional emotion hint (neutral / angry / sad / happy / …).
  */
 const CyberiaDialogueSchema = new Schema(
   {
-    itemId: { type: String, required: true, index: true },
+    code: { type: String, required: true, index: true },
     order: { type: Number, default: 0 },
     speaker: { type: String, default: '' },
     text: { type: String, required: true },
@@ -27,7 +27,7 @@ const CyberiaDialogueSchema = new Schema(
   },
 );
 
-CyberiaDialogueSchema.index({ itemId: 1, order: 1 });
+CyberiaDialogueSchema.index({ code: 1, order: 1 });
 
 const CyberiaDialogueModel = model('CyberiaDialogue', CyberiaDialogueSchema);
 

package/src/api/cyberia-dialogue/cyberia-dialogue.router.js

@@ -4,26 +4,31 @@ import express from 'express';
 
 const logger = loggerFactory(import.meta);
 
-const CyberiaDialogueRouter = (options) => {
-  const router = express.Router();
-  const authMiddleware = options.authMiddleware;
-  router.post(`/:id`, async (req, res) => await CyberiaDialogueController.post(req, res, options));
-  router.post(`/`, async (req, res) => await CyberiaDialogueController.post(req, res, options));
-  // Direct lookup by itemId — C client fetches dialogue by item key (same pattern as atlas /metadata/:itemKey)
-  router.get(`/item/:itemId`, async (req, res) => await CyberiaDialogueController.getByItemId(req, res, options));
-  router.get(
-    `/:id`,
-    // authMiddleware,
-    async (req, res) => await CyberiaDialogueController.get(req, res, options),
-  );
-  router.get(`/`, async (req, res) => await CyberiaDialogueController.get(req, res, options));
-  router.put(`/:id`, async (req, res) => await CyberiaDialogueController.put(req, res, options));
-  router.put(`/`, async (req, res) => await CyberiaDialogueController.put(req, res, options));
-  router.delete(`/:id`, async (req, res) => await CyberiaDialogueController.delete(req, res, options));
-  router.delete(`/`, async (req, res) => await CyberiaDialogueController.delete(req, res, options));
-  return router;
-};
+class CyberiaDialogueRouter {
+  /**
+   * @param {import('../types.js').RouterOptions} options
+   * @returns {import('express').Router}
+   */
+  static router(options) {
+    const router = express.Router();
+    router.post(`/:id`, async (req, res) => await CyberiaDialogueController.post(req, res, options));
+    router.post(`/`, async (req, res) => await CyberiaDialogueController.post(req, res, options));
+    // Direct lookup by code — C client fetches dialogue by code (e.g. "default-lain")
+    router.get(`/code/:code`, async (req, res) => await CyberiaDialogueController.getByCode(req, res, options));
+    router.get(
+      `/:id`,
+      // options.authMiddleware,
+      async (req, res) => await CyberiaDialogueController.get(req, res, options),
+    );
+    router.get(`/`, async (req, res) => await CyberiaDialogueController.get(req, res, options));
+    router.put(`/:id`, async (req, res) => await CyberiaDialogueController.put(req, res, options));
+    router.put(`/`, async (req, res) => await CyberiaDialogueController.put(req, res, options));
+    router.delete(`/:id`, async (req, res) => await CyberiaDialogueController.delete(req, res, options));
+    router.delete(`/`, async (req, res) => await CyberiaDialogueController.delete(req, res, options));
+    return router;
+  }
+}
 
-const ApiRouter = CyberiaDialogueRouter;
+const ApiRouter = (options) => CyberiaDialogueRouter.router(options);
 
 export { ApiRouter, CyberiaDialogueRouter };

package/src/api/cyberia-dialogue/cyberia-dialogue.service.js

@@ -1,18 +1,18 @@
-import { DataBaseProvider } from '../../db/DataBaseProvider.js';
+import { DataBaseProviderService } from '../../db/DataBaseProvider.js';
 import { loggerFactory } from '../../server/logger.js';
 import { DataQuery } from '../../server/data-query.js';
 
 const logger = loggerFactory(import.meta);
 
-const CyberiaDialogueService = {
-  post: async (req, res, options) => {
+class CyberiaDialogueService {
+  static post = async (req, res, options) => {
     /** @type {import('./cyberia-dialogue.model.js').CyberiaDialogueModel} */
-    const CyberiaDialogue = DataBaseProvider.instance[`${options.host}${options.path}`].mongoose.models.CyberiaDialogue;
+    const CyberiaDialogue = DataBaseProviderService.getModel("CyberiaDialogue", options);
     return await new CyberiaDialogue(req.body).save();
-  },
-  get: async (req, res, options) => {
+  };
+  static get = async (req, res, options) => {
     /** @type {import('./cyberia-dialogue.model.js').CyberiaDialogueModel} */
-    const CyberiaDialogue = DataBaseProvider.instance[`${options.host}${options.path}`].mongoose.models.CyberiaDialogue;
+    const CyberiaDialogue = DataBaseProviderService.getModel("CyberiaDialogue", options);
     if (req.params.id) return await CyberiaDialogue.findById(req.params.id);
 
     // Parse query parameters using DataQuery helper
@@ -25,27 +25,27 @@ const CyberiaDialogueService = {
 
     const totalPages = Math.ceil(total / limit);
     return { data, total, page, totalPages };
-  },
-  put: async (req, res, options) => {
+  };
+  static put = async (req, res, options) => {
     /** @type {import('./cyberia-dialogue.model.js').CyberiaDialogueModel} */
-    const CyberiaDialogue = DataBaseProvider.instance[`${options.host}${options.path}`].mongoose.models.CyberiaDialogue;
+    const CyberiaDialogue = DataBaseProviderService.getModel("CyberiaDialogue", options);
     return await CyberiaDialogue.findByIdAndUpdate(req.params.id, req.body);
-  },
-  delete: async (req, res, options) => {
+  };
+  static delete = async (req, res, options) => {
     /** @type {import('./cyberia-dialogue.model.js').CyberiaDialogueModel} */
-    const CyberiaDialogue = DataBaseProvider.instance[`${options.host}${options.path}`].mongoose.models.CyberiaDialogue;
+    const CyberiaDialogue = DataBaseProviderService.getModel("CyberiaDialogue", options);
     if (req.params.id) return await CyberiaDialogue.findByIdAndDelete(req.params.id);
     else return await CyberiaDialogue.deleteMany();
-  },
-  getByItemId: async (req, res, options) => {
+  };
+  static getByCode = async (req, res, options) => {
     /** @type {import('./cyberia-dialogue.model.js').CyberiaDialogueModel} */
-    const CyberiaDialogue = DataBaseProvider.instance[`${options.host}${options.path}`].mongoose.models.CyberiaDialogue;
-    const { itemId } = req.params;
-    if (!itemId) throw new Error('itemId parameter is required');
-    const data = await CyberiaDialogue.find({ itemId }).sort({ order: 1 }).lean();
-    if (!data.length) throw new Error(`No dialogue found for itemId: ${itemId}`);
+    const CyberiaDialogue = DataBaseProviderService.getModel("CyberiaDialogue", options);
+    const { code } = req.params;
+    if (!code) throw new Error('code parameter is required');
+    const data = await CyberiaDialogue.find({ code }).sort({ order: 1 }).lean();
+    if (!data.length) throw new Error(`No dialogue found for code: ${code}`);
     return data;
-  },
-};
+  };
+}
 
 export { CyberiaDialogueService };

package/src/api/cyberia-entity/cyberia-entity.controller.js

@@ -3,8 +3,8 @@ import { CyberiaEntityService } from './cyberia-entity.service.js';
 
 const logger = loggerFactory(import.meta);
 
-const CyberiaEntityController = {
-  post: async (req, res, options) => {
+class CyberiaEntityController {
+  static post = async (req, res, options) => {
     try {
       const result = await CyberiaEntityService.post(req, res, options);
       return res.status(200).json({
@@ -18,8 +18,8 @@ const CyberiaEntityController = {
         message: error.message,
       });
     }
-  },
-  get: async (req, res, options) => {
+  };
+  static get = async (req, res, options) => {
     try {
       const { page, limit } = req.query;
       const result = await CyberiaEntityService.get(
@@ -38,8 +38,8 @@ const CyberiaEntityController = {
         message: error.message,
       });
     }
-  },
-  put: async (req, res, options) => {
+  };
+  static put = async (req, res, options) => {
     try {
       const result = await CyberiaEntityService.put(req, res, options);
       return res.status(200).json({
@@ -53,8 +53,8 @@ const CyberiaEntityController = {
         message: error.message,
       });
     }
-  },
-  delete: async (req, res, options) => {
+  };
+  static delete = async (req, res, options) => {
     try {
       const result = await CyberiaEntityService.delete(req, res, options);
       return res.status(200).json({
@@ -68,7 +68,7 @@ const CyberiaEntityController = {
         message: error.message,
       });
     }
-  },
-};
+  };
+}
 
 export { CyberiaEntityController };

package/src/api/cyberia-entity/cyberia-entity.router.js

@@ -4,24 +4,28 @@ import express from 'express';
 
 const logger = loggerFactory(import.meta);
 
-const CyberiaEntityRouter = (options) => {
-  const router = express.Router();
-  const authMiddleware = options.authMiddleware;
-  router.post(`/:id`, async (req, res) => await CyberiaEntityController.post(req, res, options));
-  router.post(`/`, async (req, res) => await CyberiaEntityController.post(req, res, options));
-  router.get(
-    `/:id`,
-    // authMiddleware,
-    async (req, res) => await CyberiaEntityController.get(req, res, options),
-  );
-  router.get(`/`, async (req, res) => await CyberiaEntityController.get(req, res, options));
-  router.put(`/:id`, async (req, res) => await CyberiaEntityController.put(req, res, options));
-  router.put(`/`, async (req, res) => await CyberiaEntityController.put(req, res, options));
-  router.delete(`/:id`, async (req, res) => await CyberiaEntityController.delete(req, res, options));
-  router.delete(`/`, async (req, res) => await CyberiaEntityController.delete(req, res, options));
-  return router;
-};
+class CyberiaEntityRouter {
+  /**
+   * @param {import('../types.js').RouterOptions} options
+   * @returns {import('express').Router}
+   */
+  static router(options) {
+    const router = express.Router();
+    router.post(`/:id`, async (req, res) => await CyberiaEntityController.post(req, res, options));
+    router.post(`/`, async (req, res) => await CyberiaEntityController.post(req, res, options));
+    router.get(`/:id`,
+      // options.authMiddleware,
+      async (req, res) => await CyberiaEntityController.get(req, res, options),
+    );
+    router.get(`/`, async (req, res) => await CyberiaEntityController.get(req, res, options));
+    router.put(`/:id`, async (req, res) => await CyberiaEntityController.put(req, res, options));
+    router.put(`/`, async (req, res) => await CyberiaEntityController.put(req, res, options));
+    router.delete(`/:id`, async (req, res) => await CyberiaEntityController.delete(req, res, options));
+    router.delete(`/`, async (req, res) => await CyberiaEntityController.delete(req, res, options));
+    return router;
+  }
+}
 
-const ApiRouter = CyberiaEntityRouter;
+const ApiRouter = (options) => CyberiaEntityRouter.router(options);
 
 export { ApiRouter, CyberiaEntityRouter };

package/src/api/cyberia-entity/cyberia-entity.service.js

@@ -1,18 +1,18 @@
-import { DataBaseProvider } from '../../db/DataBaseProvider.js';
+import { DataBaseProviderService } from '../../db/DataBaseProvider.js';
 import { loggerFactory } from '../../server/logger.js';
 import { DataQuery } from '../../server/data-query.js';
 
 const logger = loggerFactory(import.meta);
 
-const CyberiaEntityService = {
-  post: async (req, res, options) => {
+class CyberiaEntityService {
+  static post = async (req, res, options) => {
     /** @type {import('./cyberia-entity.model.js').CyberiaEntityModel} */
-    const CyberiaEntity = DataBaseProvider.instance[`${options.host}${options.path}`].mongoose.models.CyberiaEntity;
+    const CyberiaEntity = DataBaseProviderService.getModel("CyberiaEntity", options);
     return await new CyberiaEntity(req.body).save();
-  },
-  get: async (req, res, options) => {
+  };
+  static get = async (req, res, options) => {
     /** @type {import('./cyberia-entity.model.js').CyberiaEntityModel} */
-    const CyberiaEntity = DataBaseProvider.instance[`${options.host}${options.path}`].mongoose.models.CyberiaEntity;
+    const CyberiaEntity = DataBaseProviderService.getModel("CyberiaEntity", options);
     if (req.params.id) return await CyberiaEntity.findById(req.params.id);
 
     // Parse query parameters using DataQuery helper
@@ -25,18 +25,18 @@ const CyberiaEntityService = {
 
     const totalPages = Math.ceil(total / limit);
     return { data, total, page, totalPages };
-  },
-  put: async (req, res, options) => {
+  };
+  static put = async (req, res, options) => {
     /** @type {import('./cyberia-entity.model.js').CyberiaEntityModel} */
-    const CyberiaEntity = DataBaseProvider.instance[`${options.host}${options.path}`].mongoose.models.CyberiaEntity;
+    const CyberiaEntity = DataBaseProviderService.getModel("CyberiaEntity", options);
     return await CyberiaEntity.findByIdAndUpdate(req.params.id, req.body);
-  },
-  delete: async (req, res, options) => {
+  };
+  static delete = async (req, res, options) => {
     /** @type {import('./cyberia-entity.model.js').CyberiaEntityModel} */
-    const CyberiaEntity = DataBaseProvider.instance[`${options.host}${options.path}`].mongoose.models.CyberiaEntity;
+    const CyberiaEntity = DataBaseProviderService.getModel("CyberiaEntity", options);
     if (req.params.id) return await CyberiaEntity.findByIdAndDelete(req.params.id);
     else return await CyberiaEntity.deleteMany();
-  },
-};
+  };
+}
 
 export { CyberiaEntityService };