feat: Import improvements (#3064)

* feat: Split and simplify import/export pages in prep for more options

* minor fixes

* File operations for imports

* test

* icons

server/utils/zip.ts

@@ -1,5 +1,6 @@
 import fs from "fs";
-import JSZip from "jszip";
+import path from "path";
+import JSZip, { JSZipObject } from "jszip";
 import tmp from "tmp";
 import Logger from "@server/logging/logger";
 import Attachment from "@server/models/Attachment";
@@ -10,6 +11,18 @@ import { serializeFilename } from "./fs";
 import parseAttachmentIds from "./parseAttachmentIds";
 import { getFileByKey } from "./s3";
 
+type ItemType = "collection" | "document" | "attachment";
+
+export type Item = {
+  path: string;
+  dir: string;
+  name: string;
+  depth: number;
+  metadata: Record<string, any>;
+  type: ItemType;
+  item: JSZipObject;
+};
+
 async function addToArchive(zip: JSZip, documents: NavigationNode[]) {
   for (const doc of documents) {
     const document = await Document.findByPk(doc.id);
@@ -104,3 +117,78 @@ export async function archiveCollections(collections: Collection[]) {
 
   return archiveToPath(zip);
 }
+
+export async function parseOutlineExport(
+  input: File | Buffer
+): Promise<Item[]> {
+  const zip = await JSZip.loadAsync(input);
+  // this is so we can use async / await a little easier
+  const items: Item[] = [];
+
+  for (const rawPath in zip.files) {
+    const item = zip.files[rawPath];
+
+    if (!item) {
+      throw new Error(
+        `No item at ${rawPath} in zip file. This zip file might be corrupt.`
+      );
+    }
+
+    const itemPath = rawPath.replace(/\/$/, "");
+    const dir = path.dirname(itemPath);
+    const name = path.basename(item.name);
+    const depth = itemPath.split("/").length - 1;
+
+    // known skippable items
+    if (itemPath.startsWith("__MACOSX") || itemPath.endsWith(".DS_Store")) {
+      continue;
+    }
+
+    // attempt to parse extra metadata from zip comment
+    let metadata = {};
+
+    try {
+      metadata = item.comment ? JSON.parse(item.comment) : {};
+    } catch (err) {
+      console.log(
+        `ZIP comment found for ${item.name}, but could not be parsed as metadata: ${item.comment}`
+      );
+    }
+
+    if (depth === 0 && !item.dir) {
+      throw new Error(
+        "Root of zip file must only contain folders representing collections"
+      );
+    }
+
+    let type: ItemType | undefined;
+
+    if (depth === 0 && item.dir && name) {
+      type = "collection";
+    }
+
+    if (depth > 0 && !item.dir && item.name.endsWith(".md")) {
+      type = "document";
+    }
+
+    if (depth > 0 && !item.dir && itemPath.includes("uploads")) {
+      type = "attachment";
+    }
+
+    if (!type) {
+      continue;
+    }
+
+    items.push({
+      path: itemPath,
+      dir,
+      name,
+      depth,
+      type,
+      metadata,
+      item,
+    });
+  }
+
+  return items;
+}