feat: Pin to home (#2880)

server/commands/pinUpdater.ts

@@ -0,0 +1,53 @@
+import { Event } from "@server/models";
+import { sequelize } from "@server/sequelize";
+
+type Props = {
+  /** The user updating the pin */
+  user: any;
+  /** The existing pin */
+  pin: any;
+  /** The index to pin the document at */
+  index?: string;
+  /** The IP address of the user creating the pin */
+  ip: string;
+};
+
+/**
+ * This command updates a "pinned" document. A pin can only be moved to a new
+ * index (reordered) once created.
+ *
+ * @param Props The properties of the pin to update
+ * @returns Pin The updated pin
+ */
+export default async function pinUpdater({
+  user,
+  pin,
+  index,
+  ip,
+}: Props): Promise<any> {
+  const transaction = await sequelize.transaction();
+
+  try {
+    pin.index = index;
+    await pin.save({ transaction });
+
+    await Event.create(
+      {
+        name: "pins.update",
+        modelId: pin.id,
+        teamId: user.teamId,
+        actorId: user.id,
+        documentId: pin.documentId,
+        collectionId: pin.collectionId,
+        ip,
+      },
+      { transaction }
+    );
+    await transaction.commit();
+  } catch (err) {
+    await transaction.rollback();
+    throw err;
+  }
+
+  return pin;
+}