@mongoosejs/studio 0.3.3 → 0.3.4

package/backend/actions/Model/getDocuments.js

@@ -4,6 +4,8 @@ const Archetype = require('archetype');
 const removeSpecifiedPaths = require('../../helpers/removeSpecifiedPaths');
 const evaluateFilter = require('../../helpers/evaluateFilter');
 const getRefFromSchemaType = require('../../helpers/getRefFromSchemaType');
+const getSuggestedProjection = require('../../helpers/getSuggestedProjection');
+const parseFieldsParam = require('../../helpers/parseFieldsParam');
 const authorize = require('../../authorize');
 
 const GetDocumentsParams = new Archetype({
@@ -30,6 +32,9 @@ const GetDocumentsParams = new Archetype({
   sortDirection: {
     $type: 'number'
   },
+  fields: {
+    $type: 'string'
+  },
   roles: {
     $type: ['string']
   }
@@ -40,7 +45,7 @@ module.exports = ({ db }) => async function getDocuments(params) {
   const { roles } = params;
   await authorize('Model.getDocuments', roles);
 
-  const { model, limit, skip, sortKey, sortDirection, searchText } = params;
+  const { model, limit, skip, sortKey, sortDirection, searchText, fields } = params;
 
   const Model = db.models[model];
   if (Model == null) {
@@ -61,12 +66,13 @@ module.exports = ({ db }) => async function getDocuments(params) {
   if (!sortObj.hasOwnProperty('_id')) {
     sortObj._id = -1;
   }
-  const cursor = await Model.
-    find(filter).
-    limit(limit).
-    skip(skip).
-    sort(sortObj).
-    cursor();
+
+  let query = Model.find(filter).limit(limit).skip(skip).sort(sortObj);
+  const projection = parseFieldsParam(fields);
+  if (projection != null) {
+    query = query.select(projection);
+  }
+  const cursor = await query.cursor();
   const docs = [];
   for (let doc = await cursor.next(); doc != null; doc = await cursor.next()) {
     docs.push(doc);
@@ -101,9 +107,12 @@ module.exports = ({ db }) => async function getDocuments(params) {
     await Model.estimatedDocumentCount() :
     await Model.countDocuments(filter);
 
+  const suggestedFields = getSuggestedProjection(Model);
+
   return {
     docs: docs.map(doc => doc.toJSON({ virtuals: false, getters: false, transform: false })),
     schemaPaths,
+    suggestedFields,
     numDocs: numDocuments
   };
 };

package/backend/actions/Model/getDocumentsStream.js

@@ -4,6 +4,8 @@ const Archetype = require('archetype');
 const removeSpecifiedPaths = require('../../helpers/removeSpecifiedPaths');
 const evaluateFilter = require('../../helpers/evaluateFilter');
 const getRefFromSchemaType = require('../../helpers/getRefFromSchemaType');
+const getSuggestedProjection = require('../../helpers/getSuggestedProjection');
+const parseFieldsParam = require('../../helpers/parseFieldsParam');
 const authorize = require('../../authorize');
 
 const GetDocumentsParams = new Archetype({
@@ -30,6 +32,9 @@ const GetDocumentsParams = new Archetype({
   sortDirection: {
     $type: 'number'
   },
+  fields: {
+    $type: 'string'
+  },
   roles: {
     $type: ['string']
   }
@@ -40,7 +45,7 @@ module.exports = ({ db }) => async function* getDocumentsStream(params) {
   const { roles } = params;
   await authorize('Model.getDocumentsStream', roles);
 
-  const { model, limit, skip, sortKey, sortDirection, searchText } = params;
+  const { model, limit, skip, sortKey, sortDirection, searchText, fields } = params;
 
   const Model = db.models[model];
   if (Model == null) {
@@ -62,6 +67,12 @@ module.exports = ({ db }) => async function* getDocumentsStream(params) {
     sortObj._id = -1;
   }
 
+  let query = Model.find(filter).limit(limit).skip(skip).sort(sortObj).batchSize(1);
+  const projection = parseFieldsParam(fields);
+  if (projection != null) {
+    query = query.select(projection);
+  }
+
   const schemaPaths = {};
   for (const path of Object.keys(Model.schema.paths)) {
     const schemaType = Model.schema.paths[path];
@@ -87,20 +98,16 @@ module.exports = ({ db }) => async function* getDocumentsStream(params) {
   }
   removeSpecifiedPaths(schemaPaths, '.$*');
 
-  yield { schemaPaths };
+  const suggestedFields = getSuggestedProjection(Model);
+
+  yield { schemaPaths, suggestedFields };
 
   // Start counting documents in parallel with streaming documents
   const numDocsPromise = (parsedFilter == null)
     ? Model.estimatedDocumentCount().exec()
     : Model.countDocuments(filter).exec();
 
-  const cursor = await Model.
-    find(filter).
-    limit(limit).
-    skip(skip).
-    sort(sortObj).
-    batchSize(1).
-    cursor();
+  const cursor = await query.cursor();
 
   let numDocsYielded = false;
   let numDocumentsPromiseResolved = false;

package/backend/actions/Model/getSuggestedProjection.js

@@ -0,0 +1,33 @@
+'use strict';
+
+const Archetype = require('archetype');
+const getSuggestedProjection = require('../../helpers/getSuggestedProjection');
+const authorize = require('../../authorize');
+
+const GetSuggestedProjectionParams = new Archetype({
+  model: {
+    $type: 'string',
+    $required: true
+  },
+  roles: {
+    $type: ['string']
+  }
+}).compile('GetSuggestedProjectionParams');
+
+module.exports = ({ db }) => async function getSuggestedProjectionAction(params) {
+  params = new GetSuggestedProjectionParams(params);
+  const { roles } = params;
+  await authorize('Model.getSuggestedProjection', roles);
+
+  const { model } = params;
+
+  const Model = db.models[model];
+  if (Model == null) {
+    throw new Error(`Model ${model} not found`);
+  }
+
+  // Default columns: first N schema paths (no scoring).
+  const suggestedFields = getSuggestedProjection(Model);
+
+  return { suggestedFields };
+};

package/backend/actions/Model/index.js

@@ -11,6 +11,7 @@ exports.exportQueryResults = require('./exportQueryResults');
 exports.getDocument = require('./getDocument');
 exports.getDocuments = require('./getDocuments');
 exports.getDocumentsStream = require('./getDocumentsStream');
+exports.getSuggestedProjection = require('./getSuggestedProjection');
 exports.getCollectionInfo = require('./getCollectionInfo');
 exports.getIndexes = require('./getIndexes');
 exports.getEstimatedDocumentCounts = require('./getEstimatedDocumentCounts');

package/backend/authorize.js

@@ -22,6 +22,7 @@ const actionsToRequiredRoles = {
   'Model.getDocument': ['owner', 'admin', 'member', 'readonly'],
   'Model.getDocuments': ['owner', 'admin', 'member', 'readonly'],
   'Model.getDocumentsStream': ['owner', 'admin', 'member', 'readonly'],
+  'Model.getSuggestedProjection': ['owner', 'admin', 'member', 'readonly'],
   'Model.getEstimatedDocumentCounts': ['owner', 'admin', 'member', 'readonly'],
   'Model.getIndexes': ['owner', 'admin', 'member', 'readonly'],
   'Model.listModels': ['owner', 'admin', 'member', 'readonly'],

package/backend/helpers/getSuggestedProjection.js

@@ -0,0 +1,37 @@
+'use strict';
+
+/** Max number of paths to use for the default table projection. */
+const DEFAULT_SUGGESTED_LIMIT = 6;
+
+/**
+ * Default projection for the models table: the first N schema paths (definition order),
+ * excluding Mongoose internals. No scoring — stable and predictable.
+ *
+ * @param {import('mongoose').Model} Model - Mongoose model
+ * @param {{ limit?: number }} options - max paths returned
+ * @returns {string[]} Path names in schema order
+ */
+function getSuggestedProjection(Model, options = {}) {
+  const limit = typeof options.limit === 'number' && options.limit > 0
+    ? options.limit
+    : DEFAULT_SUGGESTED_LIMIT;
+
+  const pathNames = Object.keys(Model.schema.paths).filter(key =>
+    !key.includes('.$*') &&
+    key !== '__v'
+  );
+
+  pathNames.sort((k1, k2) => {
+    if (k1 === '_id' && k2 !== '_id') {
+      return -1;
+    }
+    if (k1 !== '_id' && k2 === '_id') {
+      return 1;
+    }
+    return 0;
+  });
+
+  return pathNames.slice(0, limit);
+}
+
+module.exports = getSuggestedProjection;

package/backend/helpers/parseFieldsParam.js

@@ -0,0 +1,36 @@
+'use strict';
+
+/**
+ * Parse the `fields` request param for Model.getDocuments / getDocumentsStream.
+ * Expects JSON: either `["a","b"]` (inclusion list) or `{"a":1,"b":1}` (Mongo projection).
+ *
+ * @param {string|undefined} fields
+ * @returns {string|object|null} Argument suitable for Query.select(), or null when unset/invalid.
+ */
+function parseFieldsParam(fields) {
+  if (fields == null || typeof fields !== 'string') {
+    return null;
+  }
+  const trimmed = fields.trim();
+  if (!trimmed) {
+    return null;
+  }
+
+  let parsed;
+  try {
+    parsed = JSON.parse(trimmed);
+  } catch (e) {
+    return null;
+  }
+
+  if (Array.isArray(parsed)) {
+    const list = parsed.map(x => String(x).trim()).filter(Boolean);
+    return list.length > 0 ? list.join(' ') : null;
+  }
+  if (parsed != null && typeof parsed === 'object' && !Array.isArray(parsed)) {
+    return Object.keys(parsed).length > 0 ? parsed : null;
+  }
+  return null;
+}
+
+module.exports = parseFieldsParam;