@mongoosejs/studio 0.5.14 → 0.6.0

package/backend/actions/Model/createDocument.js

@@ -32,3 +32,6 @@ module.exports = ({ db }) => async function CreateDocument(params) {
 
   return { doc };
 };
+
+module.exports.paramsType = CreateDocumentParams;
+module.exports.tags = [];

package/backend/actions/Model/deleteDocument.js

@@ -2,7 +2,7 @@
 
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
-const omitNullish = require('../../helpers/omitNullish');
+const operationOptions = require('../../helpers/operationOptions');
 
 const DeleteDocumentParams = new Archetype({
   model: {
@@ -15,6 +15,9 @@ const DeleteDocumentParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
   }
 }).compile('DeleteDocumentParams');
 
@@ -31,8 +34,11 @@ module.exports = ({ db, options }) => async function DeleteDocument(params) {
 
   const doc = await Model.
     deleteOne({ _id: documentId }).
-    setOptions(omitNullish({ sanitizeFilter: true, maxTimeMS: options?.maxTimeMS })).
+    setOptions(operationOptions(options, params, { sanitizeFilter: true })).
     orFail();
 
   return { doc };
 };
+
+module.exports.paramsType = DeleteDocumentParams;
+module.exports.tags = ['destructive'];

package/backend/actions/Model/deleteDocuments.js

@@ -2,7 +2,7 @@
 
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
-const omitNullish = require('../../helpers/omitNullish');
+const operationOptions = require('../../helpers/operationOptions');
 
 const DeleteDocumentsParams = new Archetype({
   model: {
@@ -15,6 +15,9 @@ const DeleteDocumentsParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
   }
 }).compile('DeleteDocumentsParams');
 
@@ -31,8 +34,11 @@ module.exports = ({ db, options }) => async function DeleteDocuments(params) {
 
   await Model.
     deleteMany({ _id: { $in: documentIds } }).
-    setOptions(omitNullish({ maxTimeMS: options?.maxTimeMS })).
+    setOptions(operationOptions(options, params)).
     orFail();
 
   return { };
 };
+
+module.exports.paramsType = DeleteDocumentsParams;
+module.exports.tags = ['destructive'];

package/backend/actions/Model/dropCollection.js

@@ -27,3 +27,6 @@ module.exports = ({ db }) => async function dropCollection(params) {
 
   return { ok: true };
 };
+
+module.exports.paramsType = DropCollectionParams;
+module.exports.tags = ['destructive'];

package/backend/actions/Model/dropIndex.js

@@ -34,3 +34,6 @@ module.exports = ({ db }) => async function getIndexes(params) {
     mongoDBIndexes
   };
 };
+
+module.exports.paramsType = DropIndexParams;
+module.exports.tags = ['destructive'];

package/backend/actions/Model/executeDocumentScript.js

@@ -3,7 +3,8 @@
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
 const createSandbox = require('../../sandbox/createSandbox');
-const omitNullish = require('../../helpers/omitNullish');
+const readOperationOptions = require('../../helpers/readOperationOptions');
+const operationOptions = require('../../helpers/operationOptions');
 
 const ExecuteDocumentScriptParams = new Archetype({
   model: {
@@ -20,6 +21,13 @@ const ExecuteDocumentScriptParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('ExecuteDocumentScriptParams');
 
@@ -32,12 +40,12 @@ module.exports = ({ db, options }) => async function executeDocumentScript(param
     throw new Error(`Model ${model} not found`);
   }
 
-  const sandbox = createSandbox({ db, maxTimeMS: options?.maxTimeMS });
+  const sandbox = createSandbox(db, { ...readOperationOptions(options, params) });
 
   try {
     const Model = sandbox.db.models[model];
     const doc = await Model.findById(documentId).
-      setOptions(omitNullish({ sanitizeFilter: true, maxTimeMS: options?.maxTimeMS })).
+      setOptions(operationOptions(options, params, { sanitizeFilter: true })).
       orFail();
     sandbox.context.doc = doc;
 
@@ -55,3 +63,6 @@ module.exports = ({ db, options }) => async function executeDocumentScript(param
     }
   }
 };
+
+module.exports.paramsType = ExecuteDocumentScriptParams;
+module.exports.tags = [];

package/backend/actions/Model/exportQueryResults.js

@@ -5,7 +5,7 @@ const mongoose = require('mongoose');
 const { stringify } = require('csv-stringify/sync');
 const authorize = require('../../authorize');
 const evaluateFilter = require('../../helpers/evaluateFilter');
-const omitNullish = require('../../helpers/omitNullish');
+const readOperationOptions = require('../../helpers/readOperationOptions');
 
 const GetDocumentsParams = new Archetype({
   model: {
@@ -27,6 +27,13 @@ const GetDocumentsParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('GetDocumentsParams');
 
@@ -46,7 +53,7 @@ module.exports = ({ db, options }) => async function exportQueryResults(params,
 
   const docs = await Model.
     find(filter).
-    setOptions(omitNullish({ maxTimeMS: options?.maxTimeMS })).
+    setOptions(readOperationOptions(options, params)).
     sort({ _id: -1 });
 
   const rows = [propertiesToInclude];
@@ -68,3 +75,6 @@ module.exports = ({ db, options }) => async function exportQueryResults(params,
   res.setHeader('Content-Disposition', `attachment; filename="${model.toLowerCase()}-export.csv"`);
   return csv;
 };
+
+module.exports.paramsType = GetDocumentsParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/getCollectionInfo.js

@@ -2,7 +2,7 @@
 
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
-const omitNullish = require('../../helpers/omitNullish');
+const readOperationOptions = require('../../helpers/readOperationOptions');
 
 const GetCollectionInfoParams = new Archetype({
   model: {
@@ -11,6 +11,13 @@ const GetCollectionInfoParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('GetCollectionInfoParams');
 
@@ -24,9 +31,9 @@ module.exports = ({ db, options }) => async function getCollectionInfo(params) {
     throw new Error(`Model ${model} not found`);
   }
 
-  const operationOptions = omitNullish({ maxTimeMS: options?.maxTimeMS });
+  const dbOptions = readOperationOptions(options, params);
   const [collectionOptions, stats] = await Promise.all([
-    Model.collection.options(operationOptions),
+    Model.collection.options(dbOptions),
     Model.aggregate([
       {
         $collStats: {
@@ -34,7 +41,7 @@ module.exports = ({ db, options }) => async function getCollectionInfo(params) {
           count: {}
         }
       }
-    ]).option(operationOptions).then(res => res[0] ?? {})
+    ]).option(dbOptions).then(res => res[0] ?? {})
   ]);
 
   return {
@@ -49,3 +56,6 @@ module.exports = ({ db, options }) => async function getCollectionInfo(params) {
     }
   };
 };
+
+module.exports.paramsType = GetCollectionInfoParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/getDocument.js

@@ -4,7 +4,7 @@ const Archetype = require('archetype');
 const getRefFromSchemaType = require('../../helpers/getRefFromSchemaType');
 const removeSpecifiedPaths = require('../../helpers/removeSpecifiedPaths');
 const authorize = require('../../authorize');
-const omitNullish = require('../../helpers/omitNullish');
+const readOperationOptions = require('../../helpers/readOperationOptions');
 
 const GetDocumentParams = new Archetype({
   model: {
@@ -17,6 +17,13 @@ const GetDocumentParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('GetDocumentParams');
 
@@ -32,7 +39,7 @@ module.exports = ({ db, options }) => async function getDocument(params) {
 
   const doc = await Model.
     findById(documentId).
-    setOptions(omitNullish({ sanitizeFilter: true, maxTimeMS: options?.maxTimeMS })).
+    setOptions(readOperationOptions(options, { sanitizeFilter: true })).
     orFail();
   const schemaPaths = {};
   for (const path of Object.keys(Model.schema.paths)) {
@@ -50,3 +57,6 @@ module.exports = ({ db, options }) => async function getDocument(params) {
 
   return { doc: doc.toJSON({ virtuals: true, getters: false, transform: false }), schemaPaths, virtualPaths };
 };
+
+module.exports.paramsType = GetDocumentParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/getDocuments.js

@@ -7,7 +7,7 @@ const getRefFromSchemaType = require('../../helpers/getRefFromSchemaType');
 const getSuggestedProjection = require('../../helpers/getSuggestedProjection');
 const parseProjectionParam = require('../../helpers/parseProjectionParam');
 const authorize = require('../../authorize');
-const omitNullish = require('../../helpers/omitNullish');
+const readOperationOptions = require('../../helpers/readOperationOptions');
 
 const GetDocumentsParams = new Archetype({
   model: {
@@ -38,6 +38,13 @@ const GetDocumentsParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('GetDocumentsParams');
 
@@ -76,7 +83,7 @@ module.exports = ({ db, options }) => async function getDocuments(params) {
   if (projection != null) {
     query = query.select(projection);
   }
-  query.setOptions(omitNullish({ maxTimeMS: options?.maxTimeMS }));
+  query.setOptions(readOperationOptions(options, params));
   const cursor = await query.cursor();
   const docs = [];
   for (let doc = await cursor.next(); doc != null; doc = await cursor.next()) {
@@ -114,7 +121,7 @@ module.exports = ({ db, options }) => async function getDocuments(params) {
   let numDocuments = null;
   let numDocsError = null;
   try {
-    numDocuments = await countQuery.setOptions(omitNullish({ maxTimeMS: options?.maxTimeMS }));
+    numDocuments = await countQuery.setOptions(readOperationOptions(options, params));
   } catch (err) {
     numDocsError = err?.message;
   }
@@ -129,3 +136,6 @@ module.exports = ({ db, options }) => async function getDocuments(params) {
     numDocsError
   };
 };
+
+module.exports.paramsType = GetDocumentsParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/getDocumentsStream.js

@@ -7,7 +7,7 @@ const getRefFromSchemaType = require('../../helpers/getRefFromSchemaType');
 const getSuggestedProjection = require('../../helpers/getSuggestedProjection');
 const parseProjectionParam = require('../../helpers/parseProjectionParam');
 const authorize = require('../../authorize');
-const omitNullish = require('../../helpers/omitNullish');
+const readOperationOptions = require('../../helpers/readOperationOptions');
 
 const GetDocumentsParams = new Archetype({
   model: {
@@ -38,6 +38,13 @@ const GetDocumentsParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('GetDocumentsParams');
 
@@ -76,7 +83,7 @@ module.exports = ({ db, options }) => async function* getDocumentsStream(params)
   if (projection != null) {
     query = query.select(projection);
   }
-  query.setOptions(omitNullish({ maxTimeMS: options?.maxTimeMS }));
+  query.setOptions(readOperationOptions(options, params));
 
   const schemaPaths = {};
   for (const path of Object.keys(Model.schema.paths)) {
@@ -112,7 +119,7 @@ module.exports = ({ db, options }) => async function* getDocumentsStream(params)
     ? Model.estimatedDocumentCount()
     : Model.countDocuments(filter);
   const numDocsPromise = countQuery.
-    setOptions(omitNullish({ maxTimeMS: options?.maxTimeMS })).
+    setOptions(readOperationOptions(options, params)).
     exec();
 
   let numDocsYielded = false;
@@ -159,3 +166,6 @@ module.exports = ({ db, options }) => async function* getDocumentsStream(params)
     await cursor.close();
   }
 };
+
+module.exports.paramsType = GetDocumentsParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/getEstimatedDocumentCounts.js

@@ -2,11 +2,18 @@
 
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
-const omitNullish = require('../../helpers/omitNullish');
+const readOperationOptions = require('../../helpers/readOperationOptions');
 
 const GetEstimatedDocumentCountsParams = new Archetype({
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('GetEstimatedDocumentCountsParams');
 
@@ -22,7 +29,7 @@ module.exports = ({ db, options }) => async function getEstimatedDocumentCounts(
     modelNames.map(name => {
       const Model = db.models[name];
       return Model.estimatedDocumentCount().
-        setOptions(omitNullish({ maxTimeMS: options?.maxTimeMS })).
+        setOptions(readOperationOptions(options, params)).
         exec();
     })
   );
@@ -39,3 +46,6 @@ module.exports = ({ db, options }) => async function getEstimatedDocumentCounts(
 
   return { counts };
 };
+
+module.exports.paramsType = GetEstimatedDocumentCountsParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/getIndexes.js

@@ -35,3 +35,6 @@ module.exports = ({ db }) => async function getIndexes(params) {
     diffIndexes
   };
 };
+
+module.exports.paramsType = GetDocumentsParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/getSuggestedProjection.js

@@ -31,3 +31,6 @@ module.exports = ({ db }) => async function getSuggestedProjectionAction(params)
 
   return { suggestedFields };
 };
+
+module.exports.paramsType = GetSuggestedProjectionParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/listModels.js

@@ -55,3 +55,6 @@ module.exports = ({ db }) => async function listModels(params) {
     readyState
   };
 };
+
+module.exports.paramsType = ListModelsParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/streamChatMessage.js

@@ -78,3 +78,6 @@ const systemPrompt = `
 
   Return only the updated document body as a JavaScript object literal. Do not use Markdown or code fences.
 `.trim();
+
+module.exports.paramsType = StreamChatMessageParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/streamDocumentChanges.js

@@ -122,3 +122,6 @@ module.exports = ({ db, changeStream }) => async function* streamDocumentChanges
     }
   }
 };
+
+module.exports.paramsType = StreamDocumentChangesParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/updateDocument.js

@@ -2,7 +2,7 @@
 
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
-const omitNullish = require('../../helpers/omitNullish');
+const operationOptions = require('../../helpers/operationOptions');
 
 const UpdateDocumentsParams = new Archetype({
   model: {
@@ -22,6 +22,9 @@ const UpdateDocumentsParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
   }
 }).compile('UpdateDocumentsParams');
 
@@ -60,6 +63,9 @@ module.exports = ({ db, options }) => async function updateDocument(params) {
 
   const doc = await Model.
     findByIdAndUpdate(_id, updateOperation, { sanitizeFilter: true, returnDocument: 'after', overwriteImmutable: true, runValidators: false }).
-    setOptions(omitNullish({ maxTimeMS: options?.maxTimeMS }));
+    setOptions(operationOptions(options, params));
   return { doc };
 };
+
+module.exports.paramsType = UpdateDocumentsParams;
+module.exports.tags = [];

package/backend/actions/Model/updateDocuments.js

@@ -2,7 +2,7 @@
 
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
-const omitNullish = require('../../helpers/omitNullish');
+const operationOptions = require('../../helpers/operationOptions');
 
 const UpdateDocumentsParams = new Archetype({
   model: {
@@ -19,6 +19,9 @@ const UpdateDocumentsParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
   }
 }).compile('UpdateDocumentsParams');
 
@@ -62,7 +65,10 @@ module.exports = ({ db, options }) => async function updateDocuments(params) {
 
   const result = await Model.
     updateMany({ _id: { $in: _id } }, updateOperation, { overwriteImmutable: true, runValidators: false }).
-    setOptions(omitNullish({ maxTimeMS: options?.maxTimeMS }));
+    setOptions(operationOptions(options, params));
 
   return { result };
 };
+
+module.exports.paramsType = UpdateDocumentsParams;
+module.exports.tags = [];

package/backend/actions/Model/validateDocument.js

@@ -2,7 +2,7 @@
 
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
-const omitNullish = require('../../helpers/omitNullish');
+const readOperationOptions = require('../../helpers/readOperationOptions');
 const validateDocumentWithTimeout = require('../../helpers/validateDocumentWithTimeout');
 
 const ValidateDocumentParams = new Archetype({
@@ -16,6 +16,13 @@ const ValidateDocumentParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('ValidateDocumentParams');
 
@@ -30,9 +37,12 @@ module.exports = ({ db, options }) => async function validateDocument(params) {
   }
 
   const doc = await Model.findById(documentId).
-    setOptions(omitNullish({ sanitizeFilter: true, maxTimeMS: options?.maxTimeMS })).
+    setOptions(readOperationOptions(options, { sanitizeFilter: true })).
     orFail();
   return {
     result: await validateDocumentWithTimeout(doc)
   };
 };
+
+module.exports.paramsType = ValidateDocumentParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Script/createScript.js

@@ -0,0 +1,36 @@
+'use strict';
+
+const Archetype = require('archetype');
+const mongoose = require('mongoose');
+
+const authorize = require('../../authorize');
+
+const CreateScriptParams = new Archetype({
+  initiatedById: {
+    $type: mongoose.Types.ObjectId
+  },
+  script: {
+    $type: 'string',
+    $required: true
+  },
+  roles: {
+    $type: ['string']
+  }
+}).compile('CreateScriptParams');
+
+module.exports = ({ studioConnection, options }) => async function createScript(params) {
+  const { initiatedById, script, roles } = new CreateScriptParams(params);
+
+  await authorize('Script.createScript', roles);
+
+  const Script = studioConnection.model('__Studio_Script');
+  const createdScript = await Script.create({ script, userId: initiatedById });
+  const baseUrl = options?.workspace?.baseUrl?.replace(/\/+$/, '');
+  const url = `${baseUrl ? `${baseUrl}/` : ''}#/script/${createdScript._id}`;
+
+  return { script: createdScript, url };
+};
+
+module.exports.paramsType = CreateScriptParams;
+module.exports.tags = [];
+module.exports.description = 'Create a script for the user to review, edit, dry run, or run in Mongoose Studio. This tool does not execute the script and returns a review URL.';

package/backend/actions/Script/executeScript.js

@@ -0,0 +1,89 @@
+'use strict';
+
+const Archetype = require('archetype');
+const mongoose = require('mongoose');
+
+const authorize = require('../../authorize');
+const readOperationOptions = require('../../helpers/readOperationOptions');
+const createSandbox = require('../../sandbox/createSandbox');
+
+const ExecuteScriptParams = new Archetype({
+  initiatedById: {
+    $type: mongoose.Types.ObjectId
+  },
+  scriptId: {
+    $type: mongoose.Types.ObjectId,
+    $required: true
+  },
+  script: {
+    $type: 'string'
+  },
+  dryRun: {
+    $type: 'boolean',
+    $default: false
+  },
+  roles: {
+    $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
+  }
+}).compile('ExecuteScriptParams');
+
+module.exports = ({ db, studioConnection, options }) => async function executeScript(params) {
+  const { initiatedById, scriptId, script, dryRun, roles } = new ExecuteScriptParams(params);
+
+  await authorize('Script.executeScript', roles);
+
+  const Script = studioConnection.model('__Studio_Script');
+  const scriptDoc = await Script.findById(scriptId);
+  if (scriptDoc == null) {
+    throw new Error('Script not found');
+  }
+  if (initiatedById && scriptDoc.userId?.toString() !== initiatedById.toString()) {
+    throw new Error('Unauthorized');
+  }
+
+  let output = null;
+  let error = null;
+
+  if (script != null) {
+    scriptDoc.script = script;
+  }
+  scriptDoc.dryRun = dryRun;
+  scriptDoc.executionStartedAt = new Date();
+  scriptDoc.executionFinishedAt = null;
+  scriptDoc.executionResult = null;
+  await scriptDoc.save();
+
+  const sandbox = createSandbox(db, { ...readOperationOptions(options, params) });
+  try {
+    output = await sandbox.runScript({ script: scriptDoc.script, dryRun });
+  } catch (err) {
+    error = err;
+  } finally {
+    try {
+      await sandbox.close();
+    } catch (_) {
+      // Ignore sandbox cleanup errors so they do not mask the primary result.
+    }
+  }
+
+  scriptDoc.executionFinishedAt = new Date();
+  scriptDoc.executionResult = { output, logs: sandbox.getLogs(), error: error?.message ?? null };
+  await scriptDoc.save();
+
+  if (error != null) {
+    throw new Error(`Script execution failed: ${error.message}`);
+  }
+
+  return { script: scriptDoc };
+};
+
+module.exports.paramsType = ExecuteScriptParams;
+module.exports.tags = [];
+module.exports.mcp = false;