streamby-core 0.37.0 → 0.38.0

package/dist/middleware/routes/deliverable.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deliverableRouter = deliverableRouter;
+const express_1 = require("express");
+const manager_1 = require("../../models/manager");
+const auth_1 = require("../../utils/auth");
+const nosqlDb_1 = require("../../utils/nosqlDb");
+const assetVersions_1 = require("../../services/assetVersions");
+const deliverables_1 = require("../../services/deliverables");
+const MAX_NOTE = 1000;
+// A project's deliverables (see services/deliverables): marked, listed and removed. Removing
+// one never deletes its asset.
+function deliverableRouter(_config) {
+    const router = (0, express_1.Router)();
+    const Project = (0, manager_1.getModel)('projects');
+    const exportsOf = (project) => project.exports ?? [];
+    // What a list shows of each: its asset's name and kind, its version's number, and the name
+    // of the shot or export it's for.
+    const describe = async (project, deliverables) => {
+        const db = (0, nosqlDb_1.nosqlDb)();
+        const assetIds = [...new Set(deliverables.map(d => d.assetId))];
+        const shotIds = [...new Set(deliverables.map(d => d.shotId).filter(Boolean))];
+        const versionIds = [...new Set(deliverables.map(d => d.versionId).filter(Boolean))];
+        const [files, shots, versions] = db
+            ? await Promise.all([
+                db.collection('storage_files').find({ projectId: project._id?.toString() ?? project.id, fileId: { $in: assetIds } }).toArray(),
+                shotIds.length ? db.collection('production_shots').find({ id: { $in: shotIds } }).toArray() : [],
+                versionIds.length ? db.collection('asset_versions').find({ versionId: { $in: versionIds } }).toArray() : [],
+            ])
+            : [[], [], []];
+        return deliverables.map(d => {
+            const file = files.find((f) => f.fileId === d.assetId);
+            const version = versions.find((v) => v.versionId === d.versionId);
+            return {
+                ...d,
+                asset: file ? { displayName: file.displayName, category: file.category, contentType: file.contentType ?? null } : null,
+                version: version ? version.version : null,
+                shotName: d.shotId ? shots.find((s) => s.id === d.shotId)?.name ?? null : null,
+                exportName: d.exportId ? exportsOf(project).find((e) => e.id?.toString() === d.exportId)?.name ?? null : null,
+            };
+        });
+    };
+    router.get('/projects/:projectId/deliverables', async (req, res) => {
+        try {
+            const auth = req.auth;
+            const { projectId } = req.params;
+            const { shotId, exportId } = req.query;
+            const project = await Project.findOne({ _id: projectId });
+            if (!project)
+                return res.status(404).json({ message: 'Project not found' });
+            if (!(0, auth_1.isProjectMember)(project, auth.userId))
+                return res.status(403).json({ message: 'Unauthorized' });
+            const deliverables = await (0, deliverables_1.listDeliverables)(projectId, { shotId, exportId });
+            res.json({ deliverables: await describe(project, deliverables) });
+        }
+        catch (err) {
+            res.status(500).json({ message: 'Failed to list deliverables', details: err.message });
+        }
+    });
+    router.post('/projects/:projectId/deliverables', async (req, res) => {
+        try {
+            const auth = req.auth;
+            const { projectId } = req.params;
+            const { assetId, versionId, shotId, exportId, note } = req.body ?? {};
+            if (typeof assetId !== 'string' || !assetId)
+                return res.status(400).json({ message: 'assetId is required' });
+            if (versionId !== undefined && versionId !== null && typeof versionId !== 'string') {
+                return res.status(400).json({ message: 'versionId must be a string' });
+            }
+            const forShot = typeof shotId === 'string' && shotId !== '';
+            const forExport = typeof exportId === 'string' && exportId !== '';
+            if (forShot === forExport)
+                return res.status(400).json({ message: 'A deliverable is for a shot (shotId) or for an export (exportId), one of them' });
+            if (note !== undefined && note !== null && (typeof note !== 'string' || note.length > MAX_NOTE)) {
+                return res.status(400).json({ message: `note must be a string of at most ${MAX_NOTE} characters` });
+            }
+            const project = await Project.findOne({ _id: projectId });
+            if (!project)
+                return res.status(404).json({ message: 'Project not found' });
+            if (!(0, auth_1.canEditProject)(project, auth.userId))
+                return res.status(403).json({ message: 'Unauthorized' });
+            const db = (0, nosqlDb_1.nosqlDb)();
+            if (!db)
+                return res.status(500).json({ message: 'Database not available' });
+            if (!(await db.collection('storage_files').findOne({ fileId: assetId, projectId }))) {
+                return res.status(404).json({ message: 'Asset not found' });
+            }
+            if (versionId && !(await (0, assetVersions_1.findVersion)(projectId, assetId, versionId))) {
+                return res.status(404).json({ message: 'Version not found' });
+            }
+            if (forShot && !(await db.collection('production_shots').findOne({ id: shotId, projectId }))) {
+                return res.status(404).json({ message: 'Shot not found' });
+            }
+            if (forExport && !exportsOf(project).some((e) => e.id?.toString() === exportId)) {
+                return res.status(404).json({ message: 'Export not found' });
+            }
+            const deliverable = await (0, deliverables_1.createDeliverable)({
+                projectId,
+                assetId,
+                versionId: versionId || null,
+                shotId: forShot ? shotId : null,
+                exportId: forExport ? exportId : null,
+                note: note || null,
+                createdBy: auth.userId,
+            });
+            const [described] = await describe(project, [deliverable]);
+            res.status(201).json({ deliverable: described });
+        }
+        catch (err) {
+            res.status(500).json({ message: 'Failed to mark the deliverable', details: err.message });
+        }
+    });
+    router.delete('/projects/:projectId/deliverables/:deliverableId', async (req, res) => {
+        try {
+            const auth = req.auth;
+            const { projectId, deliverableId } = req.params;
+            const project = await Project.findOne({ _id: projectId });
+            if (!project)
+                return res.status(404).json({ message: 'Project not found' });
+            if (!(0, auth_1.canEditProject)(project, auth.userId))
+                return res.status(403).json({ message: 'Unauthorized' });
+            if (!(await (0, deliverables_1.deleteDeliverable)(projectId, deliverableId)))
+                return res.status(404).json({ message: 'Deliverable not found' });
+            res.json({ message: 'Deliverable removed' });
+        }
+        catch (err) {
+            res.status(500).json({ message: 'Failed to remove the deliverable', details: err.message });
+        }
+    });
+    return router;
+}

package/dist/middleware/routes/export.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.exportRouter = exportRouter;
 const express_1 = require("express");
+const deliverables_1 = require("../../services/deliverables");
 const manager_1 = require("../../models/manager");
 const auth_1 = require("../../utils/auth");
 const export_1 = require("../../services/export");
@@ -292,6 +293,7 @@ function exportRouter(config) {
                 return res.status(404).json({ message: 'Export not found in this project' });
             }
             await (0, export_1.deleteExport)(config, projectId, exportId, project.dbType);
+            await (0, deliverables_1.deleteDeliverablesOf)(projectId, { exportId });
             res.status(200).json({ message: 'Export deleted successfully' });
         }
         catch (err) {

package/dist/middleware/routes/production.js

@@ -9,12 +9,16 @@ const auth_1 = require("../../utils/auth");
 const connectionManager_1 = require("../../adapters/database/connectionManager");
 const manager_1 = require("../../models/manager");
 const crypto_1 = __importDefault(require("crypto"));
+const deliverables_1 = require("../../services/deliverables");
+const productionFields_1 = require("../../services/productionFields");
 function getDb() {
     const ids = (0, connectionManager_1.getConnectedIds)().filter(id => (0, connectionManager_1.getConnection)(id).type === 'nosql');
     if (!ids.length)
         return null;
     return (0, connectionManager_1.getConnection)(ids[0]).client.db();
 }
+const SHOT_FIELDS = ['name', 'description', 'status', 'assignees', 'assetId', 'exportId', 'dueDate', 'order'];
+const TASK_FIELDS = ['name', 'status', 'priority', 'assignee', 'dueDate', 'notes'];
 function productionRouter(_config) {
     const router = (0, express_1.Router)();
     const Project = (0, manager_1.getModel)('projects');
@@ -45,14 +49,15 @@ function productionRouter(_config) {
         try {
             const auth = req.auth;
             const { projectId } = req.params;
-            const { name, description, order } = req.body;
-            if (!name)
-                return res.status(400).json({ message: 'name is required' });
             const project = await Project.findOne({ _id: projectId });
             if (!project)
                 return res.status(404).json({ message: 'Project not found' });
             if (!(0, auth_1.canEditProject)(project, auth.userId))
                 return res.status(403).json({ message: 'Unauthorized' });
+            const checked = (0, productionFields_1.checkProductionFields)(req.body, ['name', 'description', 'order'], project, { creating: true });
+            if ('error' in checked)
+                return res.status(400).json({ message: checked.error });
+            const { values } = checked;
             const db = getDb();
             if (!db)
                 return res.status(500).json({ message: 'Database not available' });
@@ -60,9 +65,9 @@ function productionRouter(_config) {
             const sequence = {
                 id: crypto_1.default.randomUUID(),
                 projectId,
-                name,
-                description: description ?? null,
-                order: order ?? 0,
+                name: values.name,
+                description: values.description ?? null,
+                order: values.order ?? 0,
                 createdBy: auth.userId,
                 createdAt: now,
                 updatedAt: now,
@@ -86,14 +91,10 @@ function productionRouter(_config) {
             const db = getDb();
             if (!db)
                 return res.status(500).json({ message: 'Database not available' });
-            const { name, description, order } = req.body;
-            const $set = { updatedAt: new Date() };
-            if (name !== undefined)
-                $set.name = name;
-            if (description !== undefined)
-                $set.description = description;
-            if (order !== undefined)
-                $set.order = order;
+            const checked = (0, productionFields_1.checkProductionFields)(req.body, ['name', 'description', 'order'], project);
+            if ('error' in checked)
+                return res.status(400).json({ message: checked.error });
+            const $set = { ...checked.values, updatedAt: new Date() };
             const result = await db.collection('production_sequences').findOneAndUpdate({ id: seqId, projectId }, { $set }, { returnDocument: 'after' });
             if (!result)
                 return res.status(404).json({ message: 'Sequence not found' });
@@ -115,8 +116,15 @@ function productionRouter(_config) {
             const db = getDb();
             if (!db)
                 return res.status(500).json({ message: 'Database not available' });
-            await db.collection('production_sequences').deleteOne({ id: seqId, projectId });
+            // With its shots, and their tasks and deliverables: nothing is left behind.
+            const shotIds = (await db.collection('production_shots').find({ sequenceId: seqId, projectId }).toArray()).map(s => s.id);
+            const { deletedCount } = await db.collection('production_sequences').deleteOne({ id: seqId, projectId });
+            if (!deletedCount)
+                return res.status(404).json({ message: 'Sequence not found' });
             await db.collection('production_shots').deleteMany({ sequenceId: seqId, projectId });
+            if (shotIds.length)
+                await db.collection('production_tasks').deleteMany({ projectId, shotId: { $in: shotIds } });
+            await (0, deliverables_1.deleteDeliverablesOf)(projectId, { shotIds });
             res.json({ message: 'Sequence deleted' });
         }
         catch (err) {
@@ -150,30 +158,34 @@ function productionRouter(_config) {
         try {
             const auth = req.auth;
             const { projectId, seqId } = req.params;
-            const { name, description, status, assignedTo, assetId, exportId, dueDate, order } = req.body;
-            if (!name)
-                return res.status(400).json({ message: 'name is required' });
             const project = await Project.findOne({ _id: projectId });
             if (!project)
                 return res.status(404).json({ message: 'Project not found' });
             if (!(0, auth_1.canEditProject)(project, auth.userId))
                 return res.status(403).json({ message: 'Unauthorized' });
+            const checked = (0, productionFields_1.checkProductionFields)(req.body, SHOT_FIELDS, project, { creating: true });
+            if ('error' in checked)
+                return res.status(400).json({ message: checked.error });
+            const { values } = checked;
             const db = getDb();
             if (!db)
                 return res.status(500).json({ message: 'Database not available' });
+            if (!(await db.collection('production_sequences').findOne({ id: seqId, projectId }))) {
+                return res.status(404).json({ message: 'Sequence not found' });
+            }
             const now = new Date();
             const shot = {
                 id: crypto_1.default.randomUUID(),
                 sequenceId: seqId,
                 projectId,
-                name,
-                description: description ?? null,
-                order: order ?? 0,
-                status: status ?? 'todo',
-                assignedTo: assignedTo ?? [],
-                assetId: assetId ?? null,
-                exportId: exportId ?? null,
-                dueDate: dueDate ? new Date(dueDate) : null,
+                name: values.name,
+                description: values.description ?? null,
+                order: values.order ?? 0,
+                status: values.status ?? 'todo',
+                assignedTo: values.assignedTo ?? [],
+                assetId: values.assetId ?? null,
+                exportId: values.exportId ?? null,
+                dueDate: values.dueDate ?? null,
                 createdBy: auth.userId,
                 createdAt: now,
                 updatedAt: now,
@@ -197,24 +209,10 @@ function productionRouter(_config) {
             const db = getDb();
             if (!db)
                 return res.status(500).json({ message: 'Database not available' });
-            const { name, description, status, assignedTo, assetId, exportId, dueDate, order } = req.body;
-            const $set = { updatedAt: new Date() };
-            if (name !== undefined)
-                $set.name = name;
-            if (description !== undefined)
-                $set.description = description;
-            if (status !== undefined)
-                $set.status = status;
-            if (assignedTo !== undefined)
-                $set.assignedTo = assignedTo;
-            if (assetId !== undefined)
-                $set.assetId = assetId;
-            if (exportId !== undefined)
-                $set.exportId = exportId;
-            if (dueDate !== undefined)
-                $set.dueDate = dueDate ? new Date(dueDate) : null;
-            if (order !== undefined)
-                $set.order = order;
+            const checked = (0, productionFields_1.checkProductionFields)(req.body, SHOT_FIELDS, project);
+            if ('error' in checked)
+                return res.status(400).json({ message: checked.error });
+            const $set = { ...checked.values, updatedAt: new Date() };
             const result = await db.collection('production_shots').findOneAndUpdate({ id: shotId, projectId }, { $set }, { returnDocument: 'after' });
             if (!result)
                 return res.status(404).json({ message: 'Shot not found' });
@@ -238,6 +236,7 @@ function productionRouter(_config) {
                 return res.status(500).json({ message: 'Database not available' });
             await db.collection('production_shots').deleteOne({ id: shotId, projectId });
             await db.collection('production_tasks').deleteMany({ shotId, projectId });
+            await (0, deliverables_1.deleteDeliverablesOf)(projectId, { shotIds: [shotId] });
             res.json({ message: 'Shot deleted' });
         }
         catch (err) {
@@ -271,28 +270,32 @@ function productionRouter(_config) {
         try {
             const auth = req.auth;
             const { projectId, shotId } = req.params;
-            const { name, status, priority, assignedTo, dueDate, notes } = req.body;
-            if (!name)
-                return res.status(400).json({ message: 'name is required' });
             const project = await Project.findOne({ _id: projectId });
             if (!project)
                 return res.status(404).json({ message: 'Project not found' });
             if (!(0, auth_1.canEditProject)(project, auth.userId))
                 return res.status(403).json({ message: 'Unauthorized' });
+            const checked = (0, productionFields_1.checkProductionFields)(req.body, TASK_FIELDS, project, { creating: true });
+            if ('error' in checked)
+                return res.status(400).json({ message: checked.error });
+            const { values } = checked;
             const db = getDb();
             if (!db)
                 return res.status(500).json({ message: 'Database not available' });
+            if (!(await db.collection('production_shots').findOne({ id: shotId, projectId }))) {
+                return res.status(404).json({ message: 'Shot not found' });
+            }
             const now = new Date();
             const task = {
                 id: crypto_1.default.randomUUID(),
                 shotId,
                 projectId,
-                name,
-                status: status ?? 'todo',
-                priority: priority ?? 'medium',
-                assignedTo: assignedTo ?? null,
-                dueDate: dueDate ? new Date(dueDate) : null,
-                notes: notes ?? null,
+                name: values.name,
+                status: values.status ?? 'todo',
+                priority: values.priority ?? 'medium',
+                assignedTo: values.assignedTo ?? null,
+                dueDate: values.dueDate ?? null,
+                notes: values.notes ?? null,
                 createdBy: auth.userId,
                 createdAt: now,
                 updatedAt: now,
@@ -316,20 +319,10 @@ function productionRouter(_config) {
             const db = getDb();
             if (!db)
                 return res.status(500).json({ message: 'Database not available' });
-            const { name, status, priority, assignedTo, dueDate, notes } = req.body;
-            const $set = { updatedAt: new Date() };
-            if (name !== undefined)
-                $set.name = name;
-            if (status !== undefined)
-                $set.status = status;
-            if (priority !== undefined)
-                $set.priority = priority;
-            if (assignedTo !== undefined)
-                $set.assignedTo = assignedTo;
-            if (dueDate !== undefined)
-                $set.dueDate = dueDate ? new Date(dueDate) : null;
-            if (notes !== undefined)
-                $set.notes = notes;
+            const checked = (0, productionFields_1.checkProductionFields)(req.body, TASK_FIELDS, project);
+            if ('error' in checked)
+                return res.status(400).json({ message: checked.error });
+            const $set = { ...checked.values, updatedAt: new Date() };
             const result = await db.collection('production_tasks').findOneAndUpdate({ id: taskId, shotId, projectId }, { $set }, { returnDocument: 'after' });
             if (!result)
                 return res.status(404).json({ message: 'Task not found' });

package/dist/middleware/routes/project.js

@@ -10,6 +10,8 @@ const sanitize_1 = require("../../utils/sanitize");
 const projectIntegration_1 = require("../../services/projectIntegration");
 const auth_2 = require("../../services/auth");
 const apiTokens_1 = require("../../services/apiTokens");
+const nosqlDb_1 = require("../../utils/nosqlDb");
+const production_1 = require("../../services/production");
 function projectRouter(config) {
     const router = (0, express_1.Router)();
     const Project = (0, manager_1.getModel)('projects');
@@ -204,7 +206,10 @@ function projectRouter(config) {
                 useCredentials: e.useCredentials,
             }));
             const sanitized = (0, sanitize_1.sanitizeProject)({ ...project, id: project._id || project.id, _id: undefined, connections: project.connections || [], exports });
-            res.json({ project: sanitized, message: 'Project fetched successfully' });
+            // Whether it has production data, for its Production section to show even without a
+            // production node in its workflow.
+            const hasProductionData = !!(await (0, nosqlDb_1.nosqlDb)()?.collection('production_sequences').findOne({ projectId }));
+            res.json({ project: { ...sanitized, hasProductionData }, message: 'Project fetched successfully' });
         }
         catch (err) {
             res.status(500).json({ message: 'Failed to fetch project', details: err.message });
@@ -257,8 +262,9 @@ function projectRouter(config) {
                 return res.status(403).json({ message: 'Only a project admin can delete it' });
             }
             await Project.useDbType(project.dbType).delete({ _id: projectId });
-            // Its tokens have nothing left to reach.
+            // Its tokens have nothing left to reach, and its production data nothing to belong to.
             await (0, apiTokens_1.deleteProjectApiTokens)(String(projectId));
+            await (0, production_1.deleteProductionData)(String(projectId));
             const allProjects = await Project.find({});
             const projects = allProjects
                 .filter(project => {