@dhyasama/totem-models 12.20.0 → 12.21.0

package/index.js

@@ -53,6 +53,7 @@ var bootstrap = function(mongoose, config) {
   require('./lib/Account.js')(mongoose, config);
   require('./lib/Activity.js')(mongoose, config);
   require('./lib/ApiKey.js')(mongoose, config);
+  require('./lib/Brief.js')(mongoose, config);
   require('./lib/CalendarEvent.js')(mongoose, config);
   require('./lib/CapTable.js')(mongoose, config);
   require('./lib/DiffbotArticle')(mongoose, config);
@@ -74,7 +75,6 @@ var bootstrap = function(mongoose, config) {
   require('./lib/Message.js')(mongoose, config);
   require('./lib/MessageRecipient.js')(mongoose, config);
   require('./lib/News.js')(mongoose, config);
-  require('./lib/Overview.js')(mongoose, config);
   require('./lib/Rate.js')(mongoose, config);
   require('./lib/Snapshot.js')(mongoose, config);
   require('./lib/Sync.js')(mongoose, config);

package/lib/Brief.js

@@ -0,0 +1,140 @@
+"use strict";
+
+module.exports = function(mongoose, config) {
+
+  const Schema = mongoose.Schema;
+
+  // Set of models a brief can be generated for. Mirrors the polymorphic
+  // entity pattern used elsewhere in the codebase (Folder, Note, etc.).
+  const ALLOWED_ENTITY_MODELS = ['Organization', 'Fund', 'LimitedPartner'];
+
+  const Brief = new Schema({
+
+    customer: { type: Schema.ObjectId, ref: 'Account', index: true, required: true },
+
+    // What this brief is *about*. The model picks which loader runs to
+    // collect source material (org has emails/meetings/financials; fund has
+    // portfolio rollups; LP has communications/campaigns; etc.).
+    entity: {
+      // refPath lets `.populate('entity.id')` resolve to the correct
+      // collection based on the sibling `entity.model` field.
+      id: { type: Schema.ObjectId, required: true, refPath: 'entity.model' },
+      model: { type: String, enum: ALLOWED_ENTITY_MODELS, required: true }
+    },
+
+    // Lifecycle: 'generating' while the Lambda is producing the next brief,
+    // 'ready' once new content lands, 'error' if generation failed. Any prior
+    // 'ready' html is preserved while regenerating.
+    status: { type: String, enum: ['generating', 'ready', 'error'], default: 'generating', required: true, index: true },
+
+    // The AI-generated brief, as sanitized HTML. The model picks the
+    // layout, sections, ordering, and visualizations that best tell the story
+    // of this particular entity. May include <canvas data-chart='{...}'>
+    // blocks that the client hydrates with Chart.js, and
+    // <a class="cite" data-cite-type data-cite-id> anchors that resolve
+    // against the `references` array below.
+    html: { type: String },
+
+    // Deduped list of source records cited anywhere in `html`. Each entry
+    // appears once regardless of how many times its id is referenced in the
+    // body. Known types: 'email', 'meeting', 'financials' (more added as
+    // additional loaders are wired up). The client uses (type, id) to fetch
+    // the underlying record when a citation is opened.
+    references: {
+      type: [{
+        _id: false,
+        type: { type: String, required: true },
+        id: { type: Schema.ObjectId, required: true }
+      }],
+      default: []
+    },
+
+    // When the latest 'ready' html was produced.
+    generatedOn: { type: Date }
+
+  });
+
+  // One brief per (customer, entity). Generations upsert in place.
+  Brief.index({ customer: 1, 'entity.id': 1, 'entity.model': 1 }, { unique: true });
+
+  const validateCustomerId = function(customerId) {
+    if (!customerId) throw new Error('customerId is required');
+    if (!mongoose.Types.ObjectId.isValid(customerId)) throw new Error('customerId is not a valid ObjectId');
+  };
+
+  const validateEntity = function(entity) {
+    if (!entity || typeof entity !== 'object') throw new Error('entity is required');
+    if (!entity.id) throw new Error('entity.id is required');
+    if (!mongoose.Types.ObjectId.isValid(entity.id)) throw new Error('entity.id is not a valid ObjectId');
+    if (!entity.model) throw new Error('entity.model is required');
+    if (ALLOWED_ENTITY_MODELS.indexOf(entity.model) === -1) {
+      throw new Error('entity.model must be one of: ' + ALLOWED_ENTITY_MODELS.join(', '));
+    }
+  };
+
+  const entityFilter = function(customerId, entity) {
+    return {
+      customer: customerId,
+      'entity.id': entity.id,
+      'entity.model': entity.model
+    };
+  };
+
+  Brief.statics.getByEntity = async function(customerId, entity) {
+    validateCustomerId(customerId);
+    validateEntity(entity);
+    return this.findOne(entityFilter(customerId, entity));
+  };
+
+  // Upserts the brief and sets its status without touching html. Preserves
+  // any prior 'ready' html so the UI keeps showing the previous brief while
+  // the next one is generating (or after an error).
+  const setStatus = async function(Model, customerId, entity, status) {
+    validateCustomerId(customerId);
+    validateEntity(entity);
+
+    return Model.findOneAndUpdate(
+      entityFilter(customerId, entity),
+      {
+        $set: { status },
+        $setOnInsert: { customer: customerId, entity: { id: entity.id, model: entity.model } }
+      },
+      { upsert: true, new: true, setDefaultsOnInsert: true }
+    );
+  };
+
+  Brief.statics.markGenerating = function(customerId, entity) {
+    return setStatus(this, customerId, entity, 'generating');
+  };
+
+  Brief.statics.markError = function(customerId, entity) {
+    return setStatus(this, customerId, entity, 'error');
+  };
+
+  // Writes the finished html + references and flips status to 'ready'.
+  Brief.statics.saveResult = async function(customerId, entity, html, references) {
+    validateCustomerId(customerId);
+    validateEntity(entity);
+    if (!html || typeof html !== 'string') throw new Error('html is required');
+    if (!Array.isArray(references)) throw new Error('references must be an array');
+
+    return this.findOneAndUpdate(
+      entityFilter(customerId, entity),
+      {
+        $set: {
+          status: 'ready',
+          html,
+          references,
+          generatedOn: new Date()
+        },
+        $setOnInsert: { customer: customerId, entity: { id: entity.id, model: entity.model } }
+      },
+      { upsert: true, new: true, setDefaultsOnInsert: true }
+    );
+  };
+
+  Brief.set('autoIndex', false);
+
+  mongoose.model('Brief', Brief);
+
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhyasama/totem-models",
-  "version": "12.20.0",
+  "version": "12.21.0",
   "author": "Jason Reynolds",
   "license": "UNLICENSED",
   "description": "Models for Totem platform",

package/lib/Overview.js

@@ -1,160 +0,0 @@
-"use strict";
-
-module.exports = function(mongoose, config) {
-
-  let Schema = mongoose.Schema;
-
-  // Set of models an overview can be generated for. Mirrors the polymorphic
-  // entity pattern used elsewhere in the codebase (Folder, Note, etc.).
-  const ALLOWED_ENTITY_MODELS = ['Organization', 'Fund', 'LimitedPartner'];
-
-  let Overview = new Schema({
-
-    customer: { type: Schema.ObjectId, ref: 'Account', index: true, required: true },
-
-    // What this overview is *about*. The model picks which loader runs to
-    // collect source material (org has emails/meetings/financials; fund has
-    // portfolio rollups; LP has communications/campaigns; etc.).
-    entity: {
-      // refPath lets `.populate('entity.id')` resolve to the correct
-      // collection based on the sibling `entity.model` field.
-      id: { type: Schema.ObjectId, required: true, refPath: 'entity.model' },
-      model: { type: String, enum: ALLOWED_ENTITY_MODELS, required: true }
-    },
-
-    // Lifecycle: 'generating' while the Lambda is producing the next overview,
-    // 'ready' once new content lands, 'error' if generation failed. Any prior
-    // 'ready' html is preserved while regenerating.
-    status: { type: String, enum: ['generating', 'ready', 'error'], default: 'generating', required: true, index: true },
-
-    // The AI-generated overview, as sanitized HTML. The model picks the
-    // layout, sections, ordering, and visualizations that best tell the story
-    // of this particular entity. May include <canvas data-chart='{...}'>
-    // blocks that the client hydrates with Chart.js.
-    html: { type: String },
-
-    // When the latest 'ready' html was produced.
-    generatedOn: { type: Date }
-
-  });
-
-  // One overview per (customer, entity). Generations upsert in place.
-  Overview.index({ customer: 1, 'entity.id': 1, 'entity.model': 1 }, { unique: true });
-
-  const validateEntity = function(entity) {
-    if (!entity || typeof entity !== 'object') throw new Error('entity is required');
-    if (!entity.id) throw new Error('entity.id is required');
-    if (!mongoose.Types.ObjectId.isValid(entity.id)) throw new Error('entity.id is not a valid ObjectId');
-    if (!entity.model) throw new Error('entity.model is required');
-    if (ALLOWED_ENTITY_MODELS.indexOf(entity.model) === -1) {
-      throw new Error('entity.model must be one of: ' + ALLOWED_ENTITY_MODELS.join(', '));
-    }
-  };
-
-  const entityFilter = function(customerId, entity) {
-    return {
-      customer: customerId,
-      'entity.id': entity.id,
-      'entity.model': entity.model
-    };
-  };
-
-  Overview.statics.getByEntity = function(customerId, entity, cb) {
-
-    const run = async () => {
-      if (!customerId) { throw new Error('customerId is required'); }
-      if (!mongoose.Types.ObjectId.isValid(customerId)) { throw new Error('customerId is not a valid ObjectId'); }
-      validateEntity(entity);
-
-      return await this.findOne(entityFilter(customerId, entity));
-    };
-
-    if (typeof cb === 'function') { run().then(result => cb(null, result), err => cb(err)); return; }
-    else { return run(); }
-
-  };
-
-  // Marks an overview as currently being generated. Creates the record if it
-  // doesn't exist. Preserves any existing 'ready' html so the UI keeps
-  // showing the previous overview while the new one is in flight.
-  Overview.statics.markGenerating = function(customerId, entity, cb) {
-
-    const run = async () => {
-      if (!customerId) { throw new Error('customerId is required'); }
-      validateEntity(entity);
-
-      const update = {
-        $set: { status: 'generating' },
-        $setOnInsert: { customer: customerId, entity: { id: entity.id, model: entity.model } }
-      };
-
-      return await this.findOneAndUpdate(
-        entityFilter(customerId, entity),
-        update,
-        { upsert: true, new: true, setDefaultsOnInsert: true }
-      );
-    };
-
-    if (typeof cb === 'function') { run().then(result => cb(null, result), err => cb(err)); return; }
-    else { return run(); }
-
-  };
-
-  // Writes the finished html + flips status to 'ready'.
-  Overview.statics.saveResult = function(customerId, entity, html, cb) {
-
-    const run = async () => {
-      if (!customerId) { throw new Error('customerId is required'); }
-      validateEntity(entity);
-      if (!html || typeof html !== 'string') { throw new Error('html is required'); }
-
-      const update = {
-        $set: {
-          status: 'ready',
-          html: html,
-          generatedOn: new Date()
-        },
-        $setOnInsert: { customer: customerId, entity: { id: entity.id, model: entity.model } }
-      };
-
-      return await this.findOneAndUpdate(
-        entityFilter(customerId, entity),
-        update,
-        { upsert: true, new: true, setDefaultsOnInsert: true }
-      );
-    };
-
-    if (typeof cb === 'function') { run().then(result => cb(null, result), err => cb(err)); return; }
-    else { return run(); }
-
-  };
-
-  Overview.statics.markError = function(customerId, entity, cb) {
-
-    const run = async () => {
-      if (!customerId) { throw new Error('customerId is required'); }
-      validateEntity(entity);
-
-      const update = {
-        $set: { status: 'error' },
-        $setOnInsert: { customer: customerId, entity: { id: entity.id, model: entity.model } }
-      };
-
-      return await this.findOneAndUpdate(
-        entityFilter(customerId, entity),
-        update,
-        { upsert: true, new: true, setDefaultsOnInsert: true }
-      );
-    };
-
-    if (typeof cb === 'function') { run().then(result => cb(null, result), err => cb(err)); return; }
-    else { return run(); }
-
-  };
-
-  Overview.set('autoIndex', false);
-  Overview.on('index', function(err) { if (err) console.log('error building overview indexes:', err); });
-
-  mongoose.model('Overview', Overview);
-
-};