feat: add custom cover config handling

Author: jakeaturner

server/api.js

@@ -738,6 +738,14 @@ router
     orgsAPI.getCampusAdmins
   );
 
+router
+  .route("/org/:orgID/custom-cover-config")
+  .get(
+    orgsAPI.validate("getCustomCoverConfig"),
+    middleware.checkValidationErrors,
+    orgsAPI.getCustomCoverConfig
+  );
+
 /* Asset Tag Frameworks */
 router
   .route("/assettagframeworks")

server/api/organizations.ts

@@ -6,7 +6,7 @@
 
 'use strict';
 import logger from "../logger.js";
-import express, {Request, Response, NextFunction} from 'express';
+import express, { Request, Response, NextFunction } from 'express';
 import { body, param, query } from 'express-validator';
 import multer from 'multer';
 import { S3Client, PutObjectCommand } from '@aws-sdk/client-s3';
@@ -71,7 +71,7 @@ async function lookupOrganization(orgID: string) {
       { orgID },
       { _id: 0, defaultProjectLead: 0 },
     ).lean();
-    if(org?.commonsModules){
+    if (org?.commonsModules) {
       // Remove _id and __v fields from commonsModules subdocument
       // @ts-ignore
       delete org.commonsModules._id;
@@ -225,6 +225,45 @@ async function getLibreGridOrganizations(_req: Request, res: Response) {
   }
 }
 
+async function getCustomCoverConfig(req: Request, res: Response) {
+  try {
+    const { orgID } = req.params;
+
+    const orgData = await Organization.findOne(
+      {
+        orgID: { $eq: orgID }
+      },
+      {
+        orgID: 1,
+        name: 1,
+        customCoverConfig: 1,
+      }
+    ).lean();
+
+    if (!orgData) {
+      return res.status(404).send({
+        err: true,
+        errMsg: conductorErrors.err11,
+      });
+    }
+
+    return res.send({
+      err: false,
+      org: {
+        orgID: orgData.orgID,
+        name: orgData.name,
+      },
+      customCoverConfig: orgData.customCoverConfig || null,
+    });
+  } catch (e) {
+    logger.error({ err: e }, "getCustomCoverConfig failed");
+    return res.status(500).send({
+      err: true,
+      errMsg: conductorErrors.err6,
+    });
+  }
+}
+
 /**
  * Updates an Organization's information.
  *
@@ -248,11 +287,11 @@ async function updateOrganizationInfo(req: Request, res: Response) {
       }
     };
 
-    if(req.body.primaryColor) {
+    if (req.body.primaryColor) {
       updateObj.primaryColor = sanitizeCustomColor(req.body.primaryColor)
     }
 
-    if(req.body.footerColor) {
+    if (req.body.footerColor) {
       updateObj.footerColor = sanitizeCustomColor(req.body.footerColor)
     }
 
@@ -274,7 +313,7 @@ async function updateOrganizationInfo(req: Request, res: Response) {
       );
     }
 
-    if(Object.hasOwn(updateObj, 'collectionsDisplayLabel') && isEmptyString(updateObj.collectionsDisplayLabel ?? '')){
+    if (Object.hasOwn(updateObj, 'collectionsDisplayLabel') && isEmptyString(updateObj.collectionsDisplayLabel ?? '')) {
       // Reset label to 'Collections' if empty string was passed 
       updateObj.collectionsDisplayLabel = 'Collections'
     }
@@ -355,9 +394,9 @@ async function updateBrandingImageAsset(req: Request, res: Response) {
         errMsg: conductorErrors.err2,
       });
     }
-    
+
     let assetVersion = 1;
-    
+
     // @ts-ignore
     if (org[assetName].includes(process.env.AWS_ORGDATA_DOMAIN)) {
       //@ts-ignore
@@ -472,7 +511,7 @@ function validateCommonsModules(commonsModules: any) {
     return false;
   }
   for (const module in commonsModules) {
-    if(module === "_id" || module === "__v"){
+    if (module === "_id" || module === "__v") {
       // ignore these fields (mongodb adds them because commonsModules is technically a subdocument of the Organization model)
       continue;
     }
@@ -512,16 +551,20 @@ function validate(method: string) {
       return [
         param('orgID', conductorErrors.err1).exists().isLength({ min: 2, max: 50 }),
       ];
+    case 'getCustomCoverConfig':
+      return [
+        param('orgID', conductorErrors.err1).exists().isLength({ min: 2, max: 50 }),
+      ];
     case 'updateinfo':
       return [
         param('orgID', conductorErrors.err1).exists().isLength({ min: 2, max: 50 }),
         body('aboutLink', conductorErrors.err1).optional({ checkFalsy: true }).isURL(),
         body('commonsHeader', conductorErrors.err1).optional({ checkFalsy: true }).isLength({ max: 200 }),
         body('commonsMessage', conductorErrors.err1).optional({ checkFalsy: true }).isLength({ max: 500 }),
-        body('collectionsDisplayLabel', conductorErrors.err1).optional({checkFalsy: true}).isLength({ max: 200 }),
-        body('collectionsMessage', conductorErrors.err1).optional({checkFalsy: true}).isLength({max: 500}),
-        body('primaryColor', conductorErrors.err1).optional({ checkFalsy: true }).isLength({min: 7, max: 7}).isHexColor(),
-        body('footerColor', conductorErrors.err1).optional({ checkFalsy: true }).isLength({min: 7, max: 7}).isHexColor(),
+        body('collectionsDisplayLabel', conductorErrors.err1).optional({ checkFalsy: true }).isLength({ max: 200 }),
+        body('collectionsMessage', conductorErrors.err1).optional({ checkFalsy: true }).isLength({ max: 500 }),
+        body('primaryColor', conductorErrors.err1).optional({ checkFalsy: true }).isLength({ min: 7, max: 7 }).isHexColor(),
+        body('footerColor', conductorErrors.err1).optional({ checkFalsy: true }).isLength({ min: 7, max: 7 }).isHexColor(),
         body('addToLibreGridList', conductorErrors.err1).optional({ checkFalsy: true }).isBoolean().toBoolean(),
         body('supportTicketNotifiers', conductorErrors.err1).optional({ checkFalsy: true }).isArray().isEmail(),
         body('defaultAssetTagFrameworkUUID', conductorErrors.err1).optional({ checkFalsy: true }).isUUID(),
@@ -549,6 +592,7 @@ export default {
   getOrganizationInfo,
   getCampusAdmins,
   getCurrentOrganization,
+  getCustomCoverConfig,
   getAllOrganizations,
   getLibreGridOrganizations,
   updateOrganizationInfo,

server/api/services/shapeshift-service.ts

@@ -157,6 +157,7 @@ export default class ShapeshiftService {
     bookID,
     contentPageCount,
     timestamp,
+    customCoverOrg,
   }: WebhookParams): Promise<boolean> {
     const result = await Book.updateOne(
       {
@@ -174,6 +175,7 @@ export default class ShapeshiftService {
           ...(contentPageCount !== undefined
             ? { "exportInfo.contentPageCount": contentPageCount }
             : {}),
+          ...(customCoverOrg !== undefined ? { "exportInfo.customCoverOrg": customCoverOrg } : {}),
         },
       }
     );

server/api/validators/shapeshift.ts

@@ -38,5 +38,6 @@ export const WebhookValidator = z.object({
     bookID: bookIDSchema,
     contentPageCount: z.number().int().nonnegative().optional(),
     timestamp: z.number().int().nonnegative(), // Unix timestamp in milliseconds
+    customCoverOrg: z.string().trim().min(1).optional(), // Only set if the book has a custom cover by the producing org
   }),
 });

server/models/book.ts

@@ -19,6 +19,7 @@ export interface BookInterface extends Document {
     lastCompiled?: number;
     compiledBy?: string;
     contentPageCount?: number;
+    customCoverOrg?: string; // The name of the org producing the book if a custom cover is used. Should be used for display/informational purposes only, not for load-bearing logic or validation.
     lastJobID?: string;
     lastJobSubmittedAt?: Date;
     lastJobSubmittedBy?: string;
@@ -131,6 +132,10 @@ const BookSchema = new Schema<BookInterface>(
        * The number of pages in the Book's content PDF, as reported by Shapeshift during compilation.
       */
       contentPageCount: Number,
+      /**
+       * The name of the org producing the book if a custom cover is used. Should be used for display/informational purposes only, not for load-bearing logic or validation.
+       */
+      customCoverOrg: String,
       /**
        * The Shapeshift job ID of the most recent compile submitted from Conductor.
        *

server/models/organization.ts

@@ -21,6 +21,17 @@ export type CommonsModuleSettings = {
   minirepos: CommonsModuleConfig;
 }
 
+export type CustomCoverConfig = {
+  enabled: boolean;
+  casewrapCoverFrontTemplateURL: string;
+  casewrapCoverBackTemplateURL: string;
+  perfectboundCoverFrontTemplateURL: string;
+  perfectboundCoverBackTemplateURL: string;
+  spineHexColor: string;
+  spineImageURL?: string;
+  matchingPaths: string[];
+}
+
 export interface OrganizationInterface extends Document {
   orgID: string;
   active: boolean;
@@ -51,6 +62,7 @@ export interface OrganizationInterface extends Document {
   showCollections?: boolean;
   assetFilterExclusions?: string[];
   autoCatalogMatchingDisabled?: boolean;
+  customCoverConfig?: CustomCoverConfig;
   listenerPriority: number;
   cpuUnitsOverride: number;
   memoryValueOverride: number;
@@ -234,6 +246,23 @@ const OrganizationSchema = new Schema<OrganizationInterface>(
       type: Boolean,
       default: false,
     },
+    /**
+     * Configuration for custom cover templates and spine colors for the Organization.
+     */
+    customCoverConfig: {
+      type: new Schema<CustomCoverConfig>({
+          enabled: Boolean,
+          casewrapCoverFrontTemplateURL: String,
+          casewrapCoverBackTemplateURL: String,
+          perfectboundCoverFrontTemplateURL: String,
+          perfectboundCoverBackTemplateURL: String,
+          spineHexColor: String,
+          spineImageURL: String,
+          matchingPaths: [String],
+        },
+        { _id: false },
+      ),
+    },
     /**
      * Used for deterministic routing in a load-balanced Conductor deployment.
      */