weseek__growi/packages/app/src/server/models/bookmark-folder.ts

import { Ref, IUser } from '@growi/core';
import {
  Types, Document, Model, Schema,
} from 'mongoose';


import loggerFactory from '../../utils/logger';
import { getOrCreateModel } from '../util/mongoose-utils';

const logger = loggerFactory('growi:models:bookmark-folder');

export type IBookmarkFolderDocument = {
  name: string
  owner: Ref<IUser>
  parent?: Ref<IBookmarkFolderDocument>
}
export interface BookmarkFolderDocument extends Document {
  _id: Types.ObjectId
  name: string
  owner: Types.ObjectId
  parent?: IBookmarkFolderDocument
}

export interface BookmarkFolderModel extends Model<BookmarkFolderDocument>{
  createByParameters(params: IBookmarkFolderDocument): IBookmarkFolderDocument
  findByUser(user: string): IBookmarkFolderDocument[]
  deleteFolderAndChildren(bookmarkFolderId: string): void
}

const bookmarkFolderSchema = new Schema<BookmarkFolderDocument, BookmarkFolderModel>({
  name: { type: String },
  owner: { type: Schema.Types.ObjectId, ref: 'User', index: true },
  parent: { type: Schema.Types.ObjectId, refPath: 'BookmarkFolder', required: false },
});


bookmarkFolderSchema.statics.createByParameters = async function(params: IBookmarkFolderDocument): Promise<IBookmarkFolderDocument> {
  const bookmarkFolder = await this.create(params) as unknown as IBookmarkFolderDocument;
  return bookmarkFolder;
};

bookmarkFolderSchema.statics.findByUser = async function(userId: string): Promise<BookmarkFolderDocument[]> {
  // TODO: Get all folder structure
  return this.find({ owner: userId });
};

bookmarkFolderSchema.statics.deleteFolderAndChildren = async function(boookmarkFolderId: string): Promise<void> {
  // Delete parent and all children folder
  const bookmarkFolder = await this.findByIdAndDelete(boookmarkFolderId);
  await this.deleteMany({ parent: bookmarkFolder?.id });
};

export default getOrCreateModel<BookmarkFolderDocument, BookmarkFolderModel>('BookmarkFolder', bookmarkFolderSchema);