import fractionalIndex from "fractional-index"; import { Sequelize, Op, WhereOptions } from "sequelize"; import { PinValidation } from "@shared/validations"; import { ValidationError } from "@server/errors"; import { Pin, User } from "@server/models"; import { APIContext } from "@server/types"; type Props = { /** The request context */ ctx: APIContext; /** The user creating the pin */ user: User; /** The document to pin */ documentId: string; /** The collection to pin the document in. If no collection is provided then it will be pinned to home */ collectionId?: string | null; /** The index to pin the document at. If no index is provided then it will be pinned to the end of the collection */ index?: string; }; /** * This command creates a "pinned" document via the pin relation. A document can * be pinned to a collection or to the home screen. * * @param Props The properties of the pin to create * @returns Pin The pin that was created */ export default async function pinCreator({ ctx, user, documentId, collectionId, ...rest }: Props): Promise { let { index } = rest; const where: WhereOptions = { teamId: user.teamId, ...(collectionId ? { collectionId } : { collectionId: { [Op.is]: null } }), }; const count = await Pin.count({ where }); if (count >= PinValidation.max) { throw ValidationError( `You cannot pin more than ${PinValidation.max} documents` ); } if (!index) { const pins = await Pin.findAll({ where, attributes: ["id", "index", "updatedAt"], limit: 1, order: [ // using LC_COLLATE:"C" because we need byte order to drive the sorting // find only the last pin so we can create an index after it Sequelize.literal('"pin"."index" collate "C" DESC'), ["updatedAt", "ASC"], ], }); // create a pin at the end of the list index = fractionalIndex(pins.length ? pins[0].index : null, null); } const [pin] = await Pin.findOrCreateWithCtx(ctx, { where: { collectionId: collectionId ?? null, documentId, teamId: user.teamId, }, defaults: { index, createdById: user.id }, }); return pin; }