feat: favorites (#2103)

* feat: favorites and templates(ee) * rename migrations * fix sidebar * cleanup tabs * fix * turn off templates * cleanup * uuid validation
2026-07-22 23:02:46 +10:00 · 2026-04-12 22:06:25 +01:00
parent 57efb91bd3
commit d42091ccb1
90 changed files with 4557 additions and 187 deletions
@@ -0,0 +1,216 @@
+import { Injectable } from '@nestjs/common';
+import { InjectKysely } from 'nestjs-kysely';
+import { KyselyDB, KyselyTransaction } from '@docmost/db/types/kysely.types';
+import { InsertableFavorite, Favorite } from '@docmost/db/types/entity.types';
+import { PaginationOptions } from '@docmost/db/pagination/pagination-options';
+import { executeWithCursorPagination } from '@docmost/db/pagination/cursor-pagination';
+import { jsonObjectFrom } from 'kysely/helpers/postgres';
+import { ExpressionBuilder, sql } from 'kysely';
+import { DB } from '@docmost/db/types/db';
+import { dbOrTx } from '@docmost/db/utils';
+
+export const FavoriteType = {
+  PAGE: 'page',
+  SPACE: 'space',
+  TEMPLATE: 'template',
+} as const;
+
+export type FavoriteType = (typeof FavoriteType)[keyof typeof FavoriteType];
+
+@Injectable()
+export class FavoriteRepo {
+  constructor(@InjectKysely() private readonly db: KyselyDB) {}
+
+  async insert(favorite: InsertableFavorite): Promise<Favorite | undefined> {
+    try {
+      return await this.db
+        .insertInto('favorites')
+        .values(favorite)
+        .returningAll()
+        .executeTakeFirst();
+    } catch (err: any) {
+      if (err?.code === '23505') return undefined;
+      throw err;
+    }
+  }
+
+  async deleteByUserAndPage(userId: string, pageId: string): Promise<void> {
+    await this.db
+      .deleteFrom('favorites')
+      .where('userId', '=', userId)
+      .where('pageId', '=', pageId)
+      .execute();
+  }
+
+  async deleteByUserAndSpace(userId: string, spaceId: string): Promise<void> {
+    await this.db
+      .deleteFrom('favorites')
+      .where('userId', '=', userId)
+      .where('spaceId', '=', spaceId)
+      .where('type', '=', FavoriteType.SPACE)
+      .execute();
+  }
+
+  async deleteByUserAndTemplate(
+    userId: string,
+    templateId: string,
+  ): Promise<void> {
+    await this.db
+      .deleteFrom('favorites')
+      .where('userId', '=', userId)
+      .where('templateId', '=', templateId)
+      .execute();
+  }
+
+  async findUserFavorites(
+    userId: string,
+    workspaceId: string,
+    pagination: PaginationOptions,
+    type?: FavoriteType,
+  ) {
+    let query = this.db
+      .selectFrom('favorites')
+      .selectAll('favorites')
+      .where('favorites.userId', '=', userId)
+      .where('favorites.workspaceId', '=', workspaceId);
+
+    if (type) {
+      query = query.where('favorites.type', '=', type);
+    }
+
+    if (type === FavoriteType.PAGE || !type) {
+      query = query.select((eb) => this.withPage(eb));
+    }
+
+    if (type === FavoriteType.PAGE) {
+      query = query.select((eb) => this.withPageSpace(eb));
+    } else if (type === FavoriteType.SPACE) {
+      query = query.select((eb) => this.withSpace(eb));
+    } else {
+      query = query.select((eb) => this.withSpaceResolved(eb));
+    }
+
+    if (type === FavoriteType.TEMPLATE || !type) {
+      query = query.select((eb) => this.withTemplate(eb));
+    }
+
+    return executeWithCursorPagination(query, {
+      perPage: pagination.limit,
+      cursor: pagination.cursor,
+      beforeCursor: pagination.beforeCursor,
+      fields: [{ expression: 'favorites.id', direction: 'desc' }],
+      parseCursor: (cursor) => ({
+        id: cursor.id,
+      }),
+    });
+  }
+
+  async deleteByUsersWithoutSpaceAccess(
+    userIds: string[],
+    spaceId: string,
+    opts?: { trx?: KyselyTransaction },
+  ): Promise<void> {
+    if (userIds.length === 0) return;
+
+    const { trx } = opts;
+    const db = dbOrTx(this.db, trx);
+
+    const usersWithAccess = db
+      .selectFrom('spaceMembers')
+      .select('userId')
+      .where('spaceId', '=', spaceId)
+      .where('userId', 'is not', null)
+      .union(
+        db
+          .selectFrom('spaceMembers')
+          .innerJoin('groupUsers', 'groupUsers.groupId', 'spaceMembers.groupId')
+          .select('groupUsers.userId')
+          .where('spaceMembers.spaceId', '=', spaceId),
+      );
+
+    await db
+      .deleteFrom('favorites')
+      .where('userId', 'in', userIds)
+      .where('spaceId', '=', spaceId)
+      .where('userId', 'not in', usersWithAccess)
+      .execute();
+  }
+
+  async deleteByUserAndWorkspace(
+    userId: string,
+    workspaceId: string,
+    opts?: { trx?: KyselyTransaction },
+  ): Promise<void> {
+    const { trx } = opts;
+    const db = dbOrTx(this.db, trx);
+
+    await db
+      .deleteFrom('favorites')
+      .where('userId', '=', userId)
+      .where('workspaceId', '=', workspaceId)
+      .execute();
+  }
+
+  private withPage(eb: ExpressionBuilder<DB, 'favorites'>) {
+    return jsonObjectFrom(
+      eb
+        .selectFrom('pages')
+        .select([
+          'pages.id',
+          'pages.slugId',
+          'pages.title',
+          'pages.icon',
+          'pages.spaceId',
+        ])
+        .whereRef('pages.id', '=', 'favorites.pageId'),
+    ).as('page');
+  }
+
+  private withSpace(eb: ExpressionBuilder<DB, 'favorites'>) {
+    return jsonObjectFrom(
+      eb
+        .selectFrom('spaces')
+        .select(['spaces.id', 'spaces.name', 'spaces.slug', 'spaces.logo'])
+        .whereRef('spaces.id', '=', 'favorites.spaceId'),
+    ).as('space');
+  }
+
+  private withPageSpace(eb: ExpressionBuilder<DB, 'favorites'>) {
+    return jsonObjectFrom(
+      eb
+        .selectFrom('spaces')
+        .innerJoin('pages', 'pages.spaceId', 'spaces.id')
+        .select(['spaces.id', 'spaces.name', 'spaces.slug', 'spaces.logo'])
+        .whereRef('pages.id', '=', 'favorites.pageId'),
+    ).as('space');
+  }
+
+  private withSpaceResolved(eb: ExpressionBuilder<DB, 'favorites'>) {
+    return jsonObjectFrom(
+      eb
+        .selectFrom('spaces')
+        .select(['spaces.id', 'spaces.name', 'spaces.slug', 'spaces.logo'])
+        .where(({ or, ref }) =>
+          or([
+            sql<boolean>`${ref('spaces.id')} = ${ref('favorites.spaceId')}`,
+            sql<boolean>`${ref('spaces.id')} = (SELECT pages.space_id FROM pages WHERE pages.id = ${ref('favorites.pageId')})`,
+          ]),
+        ),
+    ).as('space');
+  }
+
+  private withTemplate(eb: ExpressionBuilder<DB, 'favorites'>) {
+    return jsonObjectFrom(
+      eb
+        .selectFrom('templates')
+        .select([
+          'templates.id',
+          'templates.title',
+          'templates.description',
+          'templates.icon',
+          'templates.spaceId',
+        ])
+        .whereRef('templates.id', '=', 'favorites.templateId'),
+    ).as('template');
+  }
+}