import fractionalIndex from "fractional-index"; import { Sequelize, WhereOptions } from "sequelize"; import { Star, User } from "@server/models"; import { APIContext } from "@server/types"; type Props = { /** The user creating the star */ user: User; /** The document to star */ documentId?: string; /** The collection to star */ collectionId?: string; /** The sorted index for the star in the sidebar If no index is provided then it will be at the end */ index?: string; /** The request context */ ctx: APIContext; }; /** * This command creates a "starred" document via the star relation. Stars are * only visible to the user that created them. * * @param Props The properties of the star to create * @returns Star The star that was created */ export default async function starCreator({ user, documentId, collectionId, ctx, ...rest }: Props): Promise { let { index } = rest; const where: WhereOptions = { userId: user.id, }; if (!index) { const stars = await Star.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 first star so we can create an index before it Sequelize.literal('"star"."index" collate "C"'), ["updatedAt", "DESC"], ], transaction: ctx.state.transaction, }); // create a star at the beginning of the list index = fractionalIndex(null, stars.length ? stars[0].index : null); } const [star] = await Star.findOrCreateWithCtx(ctx, { where: documentId ? { userId: user.id, documentId, } : { userId: user.id, collectionId, }, defaults: { index, }, }); return star; }