const mongoose = require('mongoose'); const Schema = mongoose.Schema; // Which campaign list a folder belongs to. Every sidebar section files its rows into // folders of its own, and all of them share this model: note folders are what it has // always held, and their rows carry no target at all, so anything reading the note tree // asks with `filterForTarget('note')` and keeps finding them. const FOLDER_TARGETS = ['note', 'actor', 'item', 'map']; const FolderSchema = new Schema({ name: { type: String, required: true }, campaign: { type: Schema.Types.ObjectId, ref: 'Campaign', required: true }, parentFolder: { type: Schema.Types.ObjectId, ref: 'Folder' }, target: { type: String, enum: FOLDER_TARGETS, default: 'note' }, // The Foundry item folder this row mirrors, set by the item sync only // (see routes/foundry-link.js). foundryFolderId: { type: String }, color: { type: String }, date: { type: Date, default: Date.now } }); FolderSchema.index( { campaign: 1, foundryFolderId: 1 }, { unique: true, partialFilterExpression: { foundryFolderId: { $type: 'string' } } } ); // The sections a folder can file rows of, and whether a request names one of them. FolderSchema.statics.isTarget = function isTarget(target) { return FOLDER_TARGETS.includes(target); }; // The filter matching one section's folders, to spread into a `find` along with whatever // else the listing asks for. The notes ask for "none of the other sections" because the // rows saved before `target` existed carry none at all and are all note folders. FolderSchema.statics.filterForTarget = function filterForTarget(target) { if (target === 'note') { return { target: { $nin: FOLDER_TARGETS.filter((other) => other !== 'note') } }; } return { target }; }; // The folder an entry of a section may stand in: `null` is the root of that list, and // anything else has to be a folder of the same campaign *and* the same section, so a // move never files an entry where its own list would not show it again. Answers whether // it does — an id that is none of those says `false` rather than throwing. FolderSchema.statics.belongsToSection = async function belongsToSection(folderId, campaignId, target) { if (folderId === null || folderId === undefined || folderId === '') return true; if (!mongoose.isValidObjectId(folderId)) return false; const folder = await this .findOne({ _id: folderId, campaign: campaignId, ...this.filterForTarget(target) }) .lean(); return Boolean(folder); }; module.exports = mongoose.model('Folder', FolderSchema);