outline/server/commands/collectionExporter.ts

import { randomUUID } from "node:crypto";
import {
  FileOperationFormat,
  FileOperationType,
  FileOperationState,
} from "@shared/types";
import { traceFunction } from "@server/logging/tracing";
import type { Collection, Team, User } from "@server/models";
import { FileOperation } from "@server/models";
import { Buckets } from "@server/models/helpers/AttachmentHelper";
import { type APIContext } from "@server/types";

type Props = {
  collection?: Collection;
  team: Team;
  user: User;
  format?: FileOperationFormat;
  includeAttachments?: boolean;
  includePrivate?: boolean;
  ctx: APIContext;
};

function getKeyForFileOp(
  teamId: string,
  format: FileOperationFormat,
  name: string
) {
  return `${
    Buckets.uploads
  }/${teamId}/${randomUUID()}/${name}-export.${format.replace(/outline-/, "")}.zip`;
}

async function collectionExporter({
  collection,
  team,
  user,
  format = FileOperationFormat.MarkdownZip,
  includeAttachments = true,
  includePrivate = true,
  ctx,
}: Props) {
  const collectionId = collection?.id;
  const key = getKeyForFileOp(
    user.teamId,
    format,
    collection?.name || team.name
  );
  const fileOperation = await FileOperation.createWithCtx(ctx, {
    type: FileOperationType.Export,
    state: FileOperationState.Creating,
    format,
    key,
    url: null,
    size: 0,
    collectionId,
    options: {
      includeAttachments,
      includePrivate,
    },
    userId: user.id,
    teamId: user.teamId,
  });

  fileOperation.user = user;

  if (collection) {
    fileOperation.collection = collection;
  }

  return fileOperation;
}

export default traceFunction({
  spanName: "collectionExporter",
})(collectionExporter);