mirror of
https://github.com/outline/outline.git
synced 2026-06-13 03:14:59 +03:00
Tom Moor
5610df5a26
* chore: Reduce no-explicit-any warnings in server directory Tightens types across test response bodies, decorator signatures, the TestServer wrapper, base class generics, and presenter Record types. Where any is genuinely load-bearing (Sequelize model generics, PropertyDescriptor decorator returns, plugin-registered template classes, Fix mixin), keeps any with a targeted eslint-disable plus reason rather than masking the constraint. Cuts server-only no-explicit-any warnings from 162 to 70. * fix: groups test asserts on first response instead of second Caught by Copilot review on the no-explicit-any cleanup. Also fixes the pre-existing getChangsetSkipped → getChangesetSkipped typo surfaced while reviewing nearby decorator code.
74 lines
2.2 KiB
TypeScript
74 lines
2.2 KiB
TypeScript
import { Hour } from "@shared/utils/time";
|
|
import type Collection from "@server/models/Collection";
|
|
import { DocumentHelper } from "@server/models/helpers/DocumentHelper";
|
|
import type { APIContext } from "@server/types";
|
|
import presentUser from "./user";
|
|
|
|
type Options = {
|
|
/** Whether to render the collection's public fields. */
|
|
isPublic?: boolean;
|
|
/** The root share ID when presenting a shared collection. */
|
|
shareId?: string;
|
|
/** Whether to include the updatedAt timestamp. */
|
|
includeUpdatedAt?: boolean;
|
|
};
|
|
|
|
export default async function presentCollection(
|
|
ctx: APIContext | undefined,
|
|
collection: Collection,
|
|
options: Options = {}
|
|
) {
|
|
const asData = !ctx || Number(ctx?.headers["x-api-version"] ?? 0) >= 3;
|
|
|
|
const res: Record<string, unknown> = {
|
|
id: collection.id,
|
|
url: collection.path,
|
|
urlId: collection.urlId,
|
|
name: collection.name,
|
|
data: asData
|
|
? await DocumentHelper.toJSON(
|
|
collection,
|
|
options.isPublic
|
|
? {
|
|
signedUrls: Hour.seconds,
|
|
teamId: collection.teamId,
|
|
internalUrlBase: `/s/${options.shareId}`,
|
|
}
|
|
: undefined
|
|
)
|
|
: undefined,
|
|
description: asData ? undefined : collection.description,
|
|
sort: collection.sort,
|
|
icon: collection.icon,
|
|
color: collection.color,
|
|
createdAt: collection.createdAt,
|
|
updatedAt: collection.updatedAt,
|
|
archivedBy: undefined,
|
|
};
|
|
|
|
if (options.isPublic && !options.includeUpdatedAt) {
|
|
delete res.updatedAt;
|
|
}
|
|
|
|
if (!options.isPublic) {
|
|
res.index = collection.index;
|
|
res.sharing = collection.sharing;
|
|
res.commenting = collection.commenting;
|
|
res.templateManagement = collection.templateManagement;
|
|
res.permission = collection.permission;
|
|
res.deletedAt = collection.deletedAt;
|
|
res.archivedAt = collection.archivedAt;
|
|
res.archivedBy =
|
|
collection.archivedBy && presentUser(collection.archivedBy);
|
|
res.sourceMetadata = collection.sourceMetadata
|
|
? {
|
|
externalId: collection.sourceMetadata.externalId,
|
|
externalName: collection.sourceMetadata.externalName,
|
|
createdByName: collection.sourceMetadata.createdByName,
|
|
}
|
|
: undefined;
|
|
}
|
|
|
|
return res;
|
|
}
|