@mongoosejs/studio 0.0.77 → 0.0.79

package/README.md

@@ -1,2 +1,86 @@
-# admin
-WIP Mongoose admin panel
+# Mongoose Studio
+
+A sleek, powerful MongoDB UI with built-in dashboarding and auth, seamlessly integrated with your Express, Vercel, or Netlify app.
+
+![NPM Version](https://img.shields.io/npm/v/@mongoosejs/studio)
+
+## Getting Started
+
+Mongoose Studio is meant to run as a [sidecar](https://learn.microsoft.com/en-us/azure/architecture/patterns/sidecar) to your Node.js application, using the same Mongoose connection config.
+If your app runs on `acme.app`, Studio will be on `acme.app/studio` or whichever path you prefer.
+For local dev, if your app runs on `localhost:3000`, Studio will be on `localhost:3000/studio`.
+
+By default, Mongoose Studio does **not** provide any authentication or authorization.
+You can use Mongoose Studio for free for local development, but we recommend [Mongoose Studio Pro](https://studio.mongoosejs.io/#pricing) for when you want to go into production.
+
+First, `npm install @mongoosejs/studio`.
+
+### Express
+
+Mongoose Studio can be mounted as Express middleware as follows.
+
+```javascript
+const mongoose = require('mongoose');
+const studio = require('@mongoosejs/studio/express');
+
+// Mount Mongoose Studio on '/studio'
+// If your models are registered on a different connection, pass in the connection instead of `mongoose`
+app.use('/studio', await studio('/studio/api', mongoose));
+````
+
+If you have a Mongoose Studio Pro API key, you can set it as follows:
+
+```javascript
+const opts = process.env.MONGOOSE_STUDIO_API_KEY ? { apiKey: process.env.MONGOOSE_STUDIO_API_KEY } : {};
+
+// Mount Mongoose Studio on '/studio'
+app.use('/studio', await studio('/studio/api', mongoose, opts));
+```
+
+### Netlify
+
+[Here is a full example of how to add Mongoose Studio to a Netlify repo](https://github.com/mongoosejs/studio.mongoosejs.io/commit/8b02ea367c8a1b7b4bcab290708f57d58f08210b).
+
+1) Copy the Mongoose Studio frontend into `public/studio` automatically in `npm run build`.
+
+```javascript
+const { execSync } = require('child_process');
+
+// Sign up for Mongoose Studio Pro to get an API key, or omit `apiKey` for local dev.
+const opts = {
+  apiKey: process.env.MONGOOSE_STUDIO_API_KEY
+};
+console.log('Creating Mongoose studio', opts);
+require('@mongoosejs/studio/frontend')(`/.netlify/functions/studio`, true, opts).then(() => {
+  execSync(`
+  mkdir -p ./public/imdb
+  cp -r ./node_modules/@mongoosejs/studio/frontend/public/* ./public/imdb/
+  `);
+});
+```
+
+2) Create a `/studio` Netlify function in `netlify/functions/studio.js`, or wherever your Netlify functions directory is. The function path should match the `/.netlify/functions/studio` parameter in the build script above.
+
+```javascript
+const mongoose = require('mongoose');
+
+const handler = require('@mongoosejs/studio/backend/netlify')({
+  apiKey: process.env.MONGOOSE_STUDIO_API_KEY
+}).handler;
+
+let conn = null;
+
+module.exports = {
+  handler: async function studioHandler(params) {
+    if (conn == null) {
+      conn = await mongoose.connect(process.env.MONGODB_CONNECTION_STRING, { serverSelectionTimeoutMS: 3000 });
+    }
+
+    return handler.apply(null, arguments);
+  }
+};
+```
+
+3) Redeploy and you're live!
+
+Try [our IMDB demo](https://studio.mongoosejs.io/imdb/#/) for an example of Mongoose Studio running on Netlify, or check out the [studio.mongoosejs.io GitHub repo](https://github.com/mongoosejs/studio.mongoosejs.io) for the full source code.

package/backend/actions/ChatMessage/executeScript.js

@@ -27,7 +27,7 @@ module.exports = ({ db }) => async function executeScript(params) {
 
   // Create a sandbox with the db object
   const logs = [];
-  const sandbox = { db, console: {} };
+  const sandbox = { db, console: {}, ObjectId: mongoose.Types.ObjectId };
 
   // Capture console logs
   sandbox.console.log = function() {

package/backend/actions/ChatThread/createChatMessage.js

@@ -27,6 +27,8 @@ Keep scripts concise. Avoid unnecessary comments, error handling, and temporary
 
 Do not write any imports or require() statements, that will cause the script to break.
 
+If the user approves the script, the script will run in the Node.js server and then send the response via JSON to the client. Be aware that the result of the query will be serialized to JSON before being displayed to the user.
+
 Assume the user has pre-defined schemas and models. Do not define any new schemas or models for the user.
 
 Use async/await where possible. Assume top-level await is allowed.
@@ -37,7 +39,7 @@ Format output as Markdown, including code fences for any scripts the user reques
 
 Add a brief text description of what the script does.
 
-If the user's query is best answered with a chart, return a Chart.js 4 configuration as \`return { $chart: chartJSConfig };\`. Disable ChartJS animation by default unless user asks for it.
+If the user's query is best answered with a chart, return a Chart.js 4 configuration as \`return { $chart: chartJSConfig };\`. Disable ChartJS animation by default unless user asks for it. Set responsive: true, maintainAspectRatio: false options unless the user explicitly asks.
 
 Example output:
 

package/frontend/public/app.js

@@ -3767,7 +3767,7 @@ module.exports = "<div>\n  <div class=\"mb-2\">\n    <textarea class=\"border bo
 /***/ ((module) => {
 
 "use strict";
-module.exports = "<div class=\"py-2\">\n  <div v-if=\"header\" class=\"border-b border-gray-100 px-2 pb-2 text-xl font-bold\">\n    {{header}}\n  </div>\n  <div class=\"text-xl py-2\">\n    <canvas ref=\"chart\"></canvas>\n  </div>\n</div>";
+module.exports = "<div class=\"py-2 h-full\">\n  <div v-if=\"header\" class=\"border-b border-gray-100 px-2 pb-2 text-xl font-bold\">\n    {{header}}\n  </div>\n  <div class=\"text-xl py-2 h-full\">\n    <canvas ref=\"chart\"></canvas>\n  </div>\n</div>\n";
 
 /***/ }),
 

package/frontend/src/dashboard-result/dashboard-chart/dashboard-chart.html

@@ -1,8 +1,8 @@
-<div class="py-2">
+<div class="py-2 h-full">
   <div v-if="header" class="border-b border-gray-100 px-2 pb-2 text-xl font-bold">
     {{header}}
   </div>
-  <div class="text-xl py-2">
+  <div class="text-xl py-2 h-full">
     <canvas ref="chart"></canvas>
   </div>
-</div>
+</div>

package/package.json

@@ -1,6 +1,12 @@
 {
   "name": "@mongoosejs/studio",
-  "version": "0.0.77",
+  "version": "0.0.79",
+  "description": "A sleek, powerful MongoDB UI with built-in dashboarding and auth, seamlessly integrated with your Express, Vercel, or Netlify app.",
+  "homepage": "https://studio.mongoosejs.io/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mongoosejs/studio"
+  },
   "dependencies": {
     "archetype": "0.13.1",
     "csv-stringify": "6.3.0",