mirror of
https://github.com/docmost/docmost.git
synced 2026-05-17 23:14:07 +08:00
a689cca7a0
* feat: labels (WIP) * full implementation
346 lines
9.8 KiB
TypeScript
346 lines
9.8 KiB
TypeScript
import { Injectable } from '@nestjs/common';
|
|
import { InjectKysely } from 'nestjs-kysely';
|
|
import { KyselyDB, KyselyTransaction } from '../../types/kysely.types';
|
|
import { Label } from '@docmost/db/types/entity.types';
|
|
import { dbOrTx } from '@docmost/db/utils';
|
|
import { SpaceMemberRepo } from '@docmost/db/repos/space/space-member.repo';
|
|
import { PaginationOptions } from '@docmost/db/pagination/pagination-options';
|
|
import { executeWithCursorPagination } from '@docmost/db/pagination/cursor-pagination';
|
|
import { jsonArrayFrom, jsonObjectFrom } from 'kysely/helpers/postgres';
|
|
import { normalizeLabelName } from '../../../core/label/utils';
|
|
|
|
export const LabelType = {
|
|
PAGE: 'page',
|
|
SPACE: 'space',
|
|
} as const;
|
|
|
|
export type LabelType = (typeof LabelType)[keyof typeof LabelType];
|
|
|
|
@Injectable()
|
|
export class LabelRepo {
|
|
constructor(
|
|
@InjectKysely() private readonly db: KyselyDB,
|
|
private readonly spaceMemberRepo: SpaceMemberRepo,
|
|
) {}
|
|
|
|
async findById(
|
|
labelId: string,
|
|
trx?: KyselyTransaction,
|
|
): Promise<Label | undefined> {
|
|
const db = dbOrTx(this.db, trx);
|
|
return db
|
|
.selectFrom('labels')
|
|
.selectAll()
|
|
.where('id', '=', labelId)
|
|
.executeTakeFirst();
|
|
}
|
|
|
|
async findByNameAndWorkspace(
|
|
name: string,
|
|
workspaceId: string,
|
|
type: LabelType,
|
|
trx?: KyselyTransaction,
|
|
): Promise<Label | undefined> {
|
|
const db = dbOrTx(this.db, trx);
|
|
return db
|
|
.selectFrom('labels')
|
|
.selectAll()
|
|
.where('name', '=', normalizeLabelName(name))
|
|
.where('type', '=', type)
|
|
.where('workspaceId', '=', workspaceId)
|
|
.executeTakeFirst();
|
|
}
|
|
|
|
async findOrCreate(
|
|
name: string,
|
|
workspaceId: string,
|
|
type: LabelType,
|
|
trx?: KyselyTransaction,
|
|
): Promise<Label> {
|
|
const db = dbOrTx(this.db, trx);
|
|
const normalizedName = normalizeLabelName(name);
|
|
|
|
// DO UPDATE (rather than DO NOTHING) so RETURNING always emits a row,
|
|
// even on conflict. Avoids a race where a follow-up SELECT could miss a
|
|
// row inserted by a concurrent transaction. The set is a no-op write.
|
|
return db
|
|
.insertInto('labels')
|
|
.values({ name: normalizedName, type, workspaceId })
|
|
.onConflict((oc) =>
|
|
oc
|
|
.columns(['name', 'type', 'workspaceId'])
|
|
.doUpdateSet({ name: normalizedName }),
|
|
)
|
|
.returningAll()
|
|
.executeTakeFirstOrThrow();
|
|
}
|
|
|
|
async findLabelsByPageId(pageId: string, pagination: PaginationOptions) {
|
|
const query = this.db
|
|
.selectFrom('labels')
|
|
.innerJoin('pageLabels', 'pageLabels.labelId', 'labels.id')
|
|
.select([
|
|
'labels.id',
|
|
'labels.name',
|
|
'labels.type',
|
|
'labels.createdAt',
|
|
'labels.updatedAt',
|
|
'labels.workspaceId',
|
|
'pageLabels.id as joinId',
|
|
])
|
|
.where('pageLabels.pageId', '=', pageId)
|
|
.where('labels.type', '=', LabelType.PAGE);
|
|
|
|
const result = await executeWithCursorPagination(query, {
|
|
perPage: pagination.limit,
|
|
cursor: pagination.cursor,
|
|
beforeCursor: pagination.beforeCursor,
|
|
fields: [
|
|
{ expression: 'pageLabels.id', direction: 'asc', key: 'joinId' },
|
|
],
|
|
parseCursor: (cursor) => ({
|
|
joinId: cursor.joinId,
|
|
}),
|
|
});
|
|
|
|
// joinId is an internal pagination cursor; don't leak it to callers.
|
|
return {
|
|
...result,
|
|
items: result.items.map(({ joinId: _joinId, ...rest }) => rest),
|
|
};
|
|
}
|
|
|
|
async findLabels(
|
|
workspaceId: string,
|
|
userId: string,
|
|
type: LabelType,
|
|
pagination: PaginationOptions,
|
|
) {
|
|
// Label visibility is scoped to space membership: a label surfaces if it
|
|
// is attached to any non-deleted page in a space the user belongs to.
|
|
// Per-page permission restrictions intentionally do not narrow this
|
|
// further — labels are a space-level concept, not a page-level one.
|
|
let query = this.db
|
|
.selectFrom('labels')
|
|
.select(['id', 'name', 'type', 'createdAt', 'updatedAt', 'workspaceId'])
|
|
.where('workspaceId', '=', workspaceId)
|
|
.where('type', '=', type)
|
|
.where(
|
|
'id',
|
|
'in',
|
|
this.db
|
|
.selectFrom('pageLabels')
|
|
.innerJoin('pages', 'pages.id', 'pageLabels.pageId')
|
|
.select('pageLabels.labelId')
|
|
.where('pages.deletedAt', 'is', null)
|
|
.where(
|
|
'pages.spaceId',
|
|
'in',
|
|
this.spaceMemberRepo.getUserSpaceIdsQuery(userId),
|
|
),
|
|
);
|
|
|
|
if (pagination.query) {
|
|
query = query.where(
|
|
'name',
|
|
'like',
|
|
`%${pagination.query.toLowerCase()}%`,
|
|
);
|
|
}
|
|
|
|
return executeWithCursorPagination(query, {
|
|
perPage: pagination.limit,
|
|
cursor: pagination.cursor,
|
|
beforeCursor: pagination.beforeCursor,
|
|
fields: [
|
|
{ expression: 'name', direction: 'asc' },
|
|
{ expression: 'id', direction: 'asc' },
|
|
],
|
|
parseCursor: (cursor) => ({
|
|
name: cursor.name,
|
|
id: cursor.id,
|
|
}),
|
|
});
|
|
}
|
|
|
|
async addLabelToPage(
|
|
pageId: string,
|
|
labelId: string,
|
|
trx?: KyselyTransaction,
|
|
): Promise<void> {
|
|
const db = dbOrTx(this.db, trx);
|
|
await db
|
|
.insertInto('pageLabels')
|
|
.values({ pageId, labelId })
|
|
.onConflict((oc) => oc.doNothing())
|
|
.execute();
|
|
}
|
|
|
|
async removeLabelFromPage(
|
|
pageId: string,
|
|
labelId: string,
|
|
workspaceId: string,
|
|
trx?: KyselyTransaction,
|
|
): Promise<void> {
|
|
const db = dbOrTx(this.db, trx);
|
|
await db
|
|
.deleteFrom('pageLabels')
|
|
.where('pageId', '=', pageId)
|
|
.where('labelId', '=', labelId)
|
|
.where((eb) =>
|
|
eb.exists(
|
|
eb
|
|
.selectFrom('labels')
|
|
.select('id')
|
|
.whereRef('labels.id', '=', 'pageLabels.labelId')
|
|
.where('labels.workspaceId', '=', workspaceId),
|
|
),
|
|
)
|
|
.execute();
|
|
}
|
|
|
|
async getPageLabelCount(
|
|
pageId: string,
|
|
trx?: KyselyTransaction,
|
|
): Promise<number> {
|
|
const db = dbOrTx(this.db, trx);
|
|
const result = await db
|
|
.selectFrom('pageLabels')
|
|
.select((eb) => eb.fn.count('id').as('count'))
|
|
.where('pageId', '=', pageId)
|
|
.executeTakeFirst();
|
|
|
|
return Number(result?.count ?? 0);
|
|
}
|
|
|
|
async getLabelPageCount(
|
|
labelId: string,
|
|
workspaceId: string,
|
|
trx?: KyselyTransaction,
|
|
): Promise<number> {
|
|
const db = dbOrTx(this.db, trx);
|
|
const result = await db
|
|
.selectFrom('pageLabels')
|
|
.innerJoin('labels', 'labels.id', 'pageLabels.labelId')
|
|
.select((eb) => eb.fn.count('pageLabels.id').as('count'))
|
|
.where('pageLabels.labelId', '=', labelId)
|
|
.where('labels.workspaceId', '=', workspaceId)
|
|
.executeTakeFirst();
|
|
|
|
return Number(result?.count ?? 0);
|
|
}
|
|
|
|
async deleteLabel(
|
|
labelId: string,
|
|
workspaceId: string,
|
|
trx?: KyselyTransaction,
|
|
): Promise<void> {
|
|
const db = dbOrTx(this.db, trx);
|
|
await db
|
|
.deleteFrom('labels')
|
|
.where('id', '=', labelId)
|
|
.where('workspaceId', '=', workspaceId)
|
|
.execute();
|
|
}
|
|
|
|
async findPagesByLabelId(
|
|
labelId: string,
|
|
userId: string,
|
|
opts: {
|
|
spaceId?: string;
|
|
query?: string;
|
|
pagination: PaginationOptions;
|
|
},
|
|
) {
|
|
let query = this.db
|
|
.selectFrom('pages')
|
|
.innerJoin('pageLabels', 'pageLabels.pageId', 'pages.id')
|
|
.select((eb) => [
|
|
'pages.id',
|
|
'pages.slugId',
|
|
'pages.title',
|
|
'pages.icon',
|
|
'pages.spaceId',
|
|
'pages.createdAt',
|
|
'pages.updatedAt',
|
|
jsonObjectFrom(
|
|
eb
|
|
.selectFrom('spaces')
|
|
.select(['spaces.id', 'spaces.name', 'spaces.slug', 'spaces.logo'])
|
|
.whereRef('spaces.id', '=', 'pages.spaceId'),
|
|
).as('space'),
|
|
jsonObjectFrom(
|
|
eb
|
|
.selectFrom('users')
|
|
.select(['users.id', 'users.name', 'users.avatarUrl'])
|
|
.whereRef('users.id', '=', 'pages.creatorId'),
|
|
).as('creator'),
|
|
jsonArrayFrom(
|
|
eb
|
|
.selectFrom('labels')
|
|
.innerJoin('pageLabels as pl', 'pl.labelId', 'labels.id')
|
|
.select(['labels.id', 'labels.name'])
|
|
.whereRef('pl.pageId', '=', 'pages.id')
|
|
.where('labels.type', '=', LabelType.PAGE)
|
|
.orderBy('pl.id', 'asc'),
|
|
).as('labels'),
|
|
])
|
|
.where('pageLabels.labelId', '=', labelId)
|
|
.where('pages.deletedAt', 'is', null);
|
|
|
|
if (opts.spaceId) {
|
|
query = query.where('pages.spaceId', '=', opts.spaceId);
|
|
} else {
|
|
query = query.where(
|
|
'pages.spaceId',
|
|
'in',
|
|
this.spaceMemberRepo.getUserSpaceIdsQuery(userId),
|
|
);
|
|
}
|
|
|
|
if (opts.query) {
|
|
query = query.where('pages.title', 'ilike', `%${opts.query}%`);
|
|
}
|
|
|
|
return executeWithCursorPagination(query, {
|
|
perPage: opts.pagination.limit,
|
|
cursor: opts.pagination.cursor,
|
|
beforeCursor: opts.pagination.beforeCursor,
|
|
fields: [
|
|
{ expression: 'pages.updatedAt', direction: 'desc', key: 'updatedAt' },
|
|
{ expression: 'pages.id', direction: 'desc', key: 'id' },
|
|
],
|
|
parseCursor: (cursor) => ({
|
|
updatedAt: new Date(cursor.updatedAt),
|
|
id: cursor.id,
|
|
}),
|
|
});
|
|
}
|
|
|
|
async getLabelPageCountForUser(
|
|
labelId: string,
|
|
userId: string,
|
|
spaceId?: string,
|
|
): Promise<number> {
|
|
let query = this.db
|
|
.selectFrom('pageLabels')
|
|
.innerJoin('pages', 'pages.id', 'pageLabels.pageId')
|
|
.select((eb) => eb.fn.count('pageLabels.id').as('count'))
|
|
.where('pageLabels.labelId', '=', labelId)
|
|
.where('pages.deletedAt', 'is', null);
|
|
|
|
if (spaceId) {
|
|
query = query.where('pages.spaceId', '=', spaceId);
|
|
} else {
|
|
query = query.where(
|
|
'pages.spaceId',
|
|
'in',
|
|
this.spaceMemberRepo.getUserSpaceIdsQuery(userId),
|
|
);
|
|
}
|
|
|
|
const result = await query.executeTakeFirst();
|
|
return Number(result?.count ?? 0);
|
|
}
|
|
}
|