Files
Tom MoorandClaude Fable 5 a1d0520c9f Add missing JSDoc to exported members in app and server utils (#12940)
* Add missing JSDoc to exported members in app and server utils

Documents all exported functions, classes, enums, and constants in
app/utils and server/utils that were missing JSDoc, per the project
documentation guidelines.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AsEQYA8zN813thxu7GjjzU

* Use @returns tag to match codebase convention

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AsEQYA8zN813thxu7GjjzU

---------

Co-authored-by: Claude <noreply@anthropic.com>
2026-07-08 08:30:11 -04:00

98 lines
2.6 KiB
TypeScript

import fractionalIndex from "fractional-index";
import type { FindOptions } from "sequelize";
import naturalSort from "@shared/utils/naturalSort";
import { Collection, Document, Star } from "@server/models";
/**
* Ensures all collections in a team have a fractional index, generating
* indexes for any collections without one.
*
* @param teamId the team to index collections for.
* @param options find options including an optional transaction.
* @returns a map of collection ids to their indexes.
*/
export async function collectionIndexing(
teamId: string,
{ transaction }: FindOptions<Collection>
) {
const collections = await Collection.findAll({
where: {
teamId,
},
transaction,
});
const sortable = naturalSort(collections, (collection) => collection.name);
// for each collection with null index, use previous collection index to create new index
let previousIndex = null;
const promises = [];
for (const collection of sortable) {
if (collection.index === null) {
collection.index = fractionalIndex(previousIndex, null);
promises.push(
collection.save({ fields: ["index"], silent: true, transaction })
);
}
previousIndex = collection.index;
}
await Promise.all(promises);
const indexedCollections: Record<string, string | null> = {};
sortable.forEach((collection) => {
indexedCollections[collection.id] = collection.index;
});
return indexedCollections;
}
/**
* Ensures all stars belonging to a user have a fractional index, generating
* indexes for any stars without one.
*
* @param userId the user to index stars for.
* @returns a map of star ids to their indexes.
*/
export async function starIndexing(userId: string) {
const stars = await Star.findAll({
where: { userId },
});
const documents = await Document.findAll({
attributes: ["id", "updatedAt"],
where: {
id: stars.map((star) => star.documentId).filter(Boolean) as string[],
},
order: [["updatedAt", "DESC"]],
});
const sortable = stars.sort(function (a, b) {
return (
documents.findIndex((d) => d.id === a.documentId) -
documents.findIndex((d) => d.id === b.documentId)
);
});
let previousIndex = null;
const promises = [];
for (const star of sortable) {
if (star.index === null) {
star.index = fractionalIndex(previousIndex, null);
promises.push(star.save({ silent: true }));
}
previousIndex = star.index;
}
await Promise.all(promises);
const indexedStars: Record<string, string | null> = {};
sortable.forEach((star) => {
indexedStars[star.id] = star.index;
});
return indexedStars;
}