chore: Move to Typescript (#2783)

This PR moves the entire project to Typescript. Due to the ~1000 ignores this will lead to a messy codebase for a while, but the churn is worth it – all of those ignore comments are places that were never type-safe previously. closes #1282
2021-11-29 06:40:55 -08:00
parent 25ccfb5d04
commit 15b1069bcc
1017 changed files with 17410 additions and 54942 deletions
--- a/server/policies/document.ts
+++ b/server/policies/document.ts
@@ -0,0 +1,189 @@
+import invariant from "invariant";
+import { Document, Revision, User, Team } from "@server/models";
+import policy from "./policy";
+
+const { allow, cannot } = policy;
+
+allow(User, "createDocument", Team, (user, team) => {
+  if (!team || user.isViewer || user.teamId !== team.id) return false;
+  return true;
+});
+
+allow(User, ["read", "download"], Document, (user, document) => {
+  // existence of collection option is not required here to account for share tokens
+  if (document.collection && cannot(user, "read", document.collection)) {
+    return false;
+  }
+
+  return user.teamId === document.teamId;
+});
+
+allow(User, ["star", "unstar"], Document, (user, document) => {
+  if (document.archivedAt) return false;
+  if (document.deletedAt) return false;
+  if (document.template) return false;
+  invariant(
+    document.collection,
+    "collection is missing, did you forget to include in the query scope?"
+  );
+  if (cannot(user, "read", document.collection)) return false;
+  return user.teamId === document.teamId;
+});
+
+allow(User, "share", Document, (user, document) => {
+  if (document.archivedAt) return false;
+  if (document.deletedAt) return false;
+
+  if (cannot(user, "share", document.collection)) {
+    return false;
+  }
+
+  return user.teamId === document.teamId;
+});
+
+allow(User, "update", Document, (user, document) => {
+  if (document.archivedAt) return false;
+  if (document.deletedAt) return false;
+
+  if (cannot(user, "update", document.collection)) {
+    return false;
+  }
+
+  return user.teamId === document.teamId;
+});
+
+allow(User, "createChildDocument", Document, (user, document) => {
+  if (document.archivedAt) return false;
+  if (document.deletedAt) return false;
+  if (document.template) return false;
+  if (!document.publishedAt) return false;
+  invariant(
+    document.collection,
+    "collection is missing, did you forget to include in the query scope?"
+  );
+  if (cannot(user, "update", document.collection)) return false;
+  return user.teamId === document.teamId;
+});
+
+allow(User, "move", Document, (user, document) => {
+  if (document.archivedAt) return false;
+  if (document.deletedAt) return false;
+  if (!document.publishedAt) return false;
+  invariant(
+    document.collection,
+    "collection is missing, did you forget to include in the query scope?"
+  );
+  if (cannot(user, "update", document.collection)) return false;
+  return user.teamId === document.teamId;
+});
+
+allow(User, ["pin", "unpin"], Document, (user, document) => {
+  if (document.archivedAt) return false;
+  if (document.deletedAt) return false;
+  if (document.template) return false;
+  if (!document.publishedAt) return false;
+  invariant(
+    document.collection,
+    "collection is missing, did you forget to include in the query scope?"
+  );
+  if (cannot(user, "update", document.collection)) return false;
+  return user.teamId === document.teamId;
+});
+
+allow(User, "delete", Document, (user, document) => {
+  if (user.isViewer) return false;
+  if (document.deletedAt) return false;
+
+  // allow deleting document without a collection
+  if (document.collection && cannot(user, "update", document.collection)) {
+    return false;
+  }
+
+  // unpublished drafts can always be deleted
+  if (
+    !document.deletedAt &&
+    !document.publishedAt &&
+    user.teamId === document.teamId
+  ) {
+    return true;
+  }
+
+  return user.teamId === document.teamId;
+});
+
+allow(User, "permanentDelete", Document, (user, document) => {
+  if (user.isViewer) return false;
+  if (!document.deletedAt) return false;
+
+  // allow deleting document without a collection
+  if (document.collection && cannot(user, "update", document.collection)) {
+    return false;
+  }
+
+  return user.teamId === document.teamId;
+});
+
+allow(User, "restore", Document, (user, document) => {
+  if (user.isViewer) return false;
+  if (!document.deletedAt) return false;
+
+  if (document.collection && cannot(user, "update", document.collection)) {
+    return false;
+  }
+
+  return user.teamId === document.teamId;
+});
+
+allow(User, "archive", Document, (user, document) => {
+  if (!document.publishedAt) return false;
+  if (document.archivedAt) return false;
+  if (document.deletedAt) return false;
+  invariant(
+    document.collection,
+    "collection is missing, did you forget to include in the query scope?"
+  );
+  if (cannot(user, "update", document.collection)) return false;
+  return user.teamId === document.teamId;
+});
+
+allow(User, "unarchive", Document, (user, document) => {
+  invariant(
+    document.collection,
+    "collection is missing, did you forget to include in the query scope?"
+  );
+  if (cannot(user, "update", document.collection)) return false;
+  if (!document.archivedAt) return false;
+  if (document.deletedAt) return false;
+  return user.teamId === document.teamId;
+});
+
+allow(
+  Document,
+  "restore",
+  Revision,
+  (document, revision) => document.id === revision.documentId
+);
+
+allow(User, "unpublish", Document, (user, document) => {
+  invariant(
+    document.collection,
+    "collection is missing, did you forget to include in the query scope?"
+  );
+  if (!document.publishedAt || !!document.deletedAt || !!document.archivedAt)
+    return false;
+  if (cannot(user, "update", document.collection)) return false;
+  const documentID = document.id;
+
+  // @ts-expect-error ts-migrate(7006) FIXME: Parameter 'documents' implicitly has an 'any' type... Remove this comment to see the full error message
+  const hasChild = (documents) =>
+    // @ts-expect-error ts-migrate(7006) FIXME: Parameter 'doc' implicitly has an 'any' type.
+    documents.some((doc) => {
+      if (doc.id === documentID) return doc.children.length > 0;
+      return hasChild(doc.children);
+    });
+
+  return (
+    !hasChild(document.collection.documentStructure) &&
+    user.teamId === document.teamId
+  );
+});