Add Checkout Groups (#738)

Author: epodol

common/types/Library.d.ts

@@ -102,6 +102,29 @@ export default interface Library {
     4: string;
     5: string;
   };
+  /**
+   * Groups for maximum checkouts and renews
+   */
+  checkoutGroups: {
+    [key: string]: {
+      /**
+       * The maximum number of checkouts allowed.
+       */
+      maxCheckouts: number;
+      /**
+       * The maximum number of renews allowed.
+       */
+      maxRenews: number;
+      /**
+       * Renew duration in days.
+       */
+      renewDuration: number;
+      /**
+       * Default checkout duration in days.
+       */
+      checkoutDuration: number;
+    };
+  };
   /**
    * The UID of the user who owns this library.
    */

common/types/User.d.ts

@@ -9,13 +9,9 @@ export default interface User {
    */
   activeCheckouts: string[];
   /**
-   * The maximum number of checkouts the user is allowed to have
+   * The checkout group of the user.
    */
-  maxCheckouts: number;
-  /**
-   * The maximum number of renews the user is allowed to have
-   */
-  maxRenews: number;
+  checkoutGroup: string;
   /**
    * The user's first name
    */

emulator-data/auth_export/accounts.json

@@ -1 +1 @@
-{"kind":"identitytoolkit#DownloadAccountResponse","users":[{"localId":"yEjjsFDWcKIxWgXSWfb71XlGpYdN","createdAt":"1621181611766","lastLoginAt":"1658417099640","displayName":"","photoUrl":"","passwordHash":"fakeHash:salt=fakeSaltMRmWNZYR2cyN9tqJkg7N:password=bsclibrary","salt":"fakeSaltMRmWNZYR2cyN9tqJkg7N","passwordUpdatedAt":1659921208629,"customAttributes":"{\"permissions\":{},\"librariesJoined\":[\"bsclibrary\"],\"librariesOwned\":[\"bsclibrary\"]}","providerUserInfo":[{"providerId":"password","email":"admin@bsclibrary.net","federatedId":"admin@bsclibrary.net","rawId":"admin@bsclibrary.net","displayName":"","photoUrl":""}],"validSince":"1659921208","email":"admin@bsclibrary.net","emailVerified":true,"disabled":false,"lastRefreshAt":"2022-08-08T01:13:28.629Z"}]}
+{"kind":"identitytoolkit#DownloadAccountResponse","users":[{"localId":"yEjjsFDWcKIxWgXSWfb71XlGpYdN","createdAt":"1621181611766","lastLoginAt":"1659929396021","displayName":"","photoUrl":"","passwordHash":"fakeHash:salt=fakeSaltMRmWNZYR2cyN9tqJkg7N:password=bsclibrary","salt":"fakeSaltMRmWNZYR2cyN9tqJkg7N","passwordUpdatedAt":1659929194854,"customAttributes":"{\"permissions\":{},\"librariesJoined\":[\"bsclibrary\"],\"librariesOwned\":[\"bsclibrary\"]}","providerUserInfo":[{"providerId":"password","email":"admin@bsclibrary.net","federatedId":"admin@bsclibrary.net","rawId":"admin@bsclibrary.net","displayName":"","photoUrl":""}],"validSince":"1659929194","email":"admin@bsclibrary.net","emailVerified":true,"disabled":false,"lastRefreshAt":"2022-08-08T03:29:56.021Z"}]}

emulator-data/firestore_export/all_namespaces/all_kinds/all_namespaces_all_kinds.export_metadata

@@ -5,6 +5,7 @@ import renewCheckoutData from '@common/functions/renewCheckout';
 import Checkout from '@common/types/Checkout';
 import RecursivePartial from '@common/types/util/RecursivePartial';
 import User from '@common/types/User';
+import Library from '@common/types/Library';
 
 const renewCheckout = functions
   .region('us-west2')
@@ -44,6 +45,8 @@ const renewCheckout = functions
       throw new functions.https.HttpsError('not-found', `Library not found.`);
     }
 
+    const library: Library = libraryDoc.data() as Library;
+
     const userDoc = await firestore
       .collection('libraries')
       .doc(data.libraryID)
@@ -87,7 +90,11 @@ const renewCheckout = functions
         `The checkout with ID ${data.checkoutID} does not belong to the user.`
       );
     }
-    if (user.maxRenews - checkout.renewsUsed <= 0) {
+    if (
+      library.checkoutGroups[user.checkoutGroup].maxRenews -
+        checkout.renewsUsed <=
+      0
+    ) {
       throw new functions.https.HttpsError(
         'permission-denied',
         `The checkout with ID ${data.checkoutID} has already been renewed the maximum number of times.`
@@ -96,7 +103,12 @@ const renewCheckout = functions
 
     const newCheckout: RecursivePartial<Checkout> = {
       dueDate: Timestamp.fromMillis(
-        checkout.dueDate.toDate().valueOf() + 7 * 24 * 60 * 60 * 1000
+        checkout.dueDate.toDate().valueOf() +
+          library.checkoutGroups[user.checkoutGroup].renewDuration *
+            24 *
+            60 *
+            60 *
+            1000
       ),
       // Since we can not increment the dueDate, we will not increment the renewsUsed
       renewsUsed: checkout.renewsUsed + 1,

emulator-data/firestore_export/all_namespaces/all_kinds/output-0

@@ -21,6 +21,7 @@ import Checkout from '@common/types/Checkout';
 import NotificationContext from 'src/contexts/NotificationContext';
 import ActiveLibraryID from 'src/contexts/ActiveLibraryID';
 import User from '@common/types/User';
+import Library from '@common/types/Library';
 
 const CheckoutRow = ({ checkoutID }: { checkoutID: string }) => {
   const NotificationHandler = useContext(NotificationContext);
@@ -33,6 +34,10 @@ const CheckoutRow = ({ checkoutID }: { checkoutID: string }) => {
   const user = useUser().data;
   if (!user) throw new Error('No user signed in!');
 
+  const libraryDoc: Library = useFirestoreDocData(
+    doc(firestore, 'libraries', activeLibraryID)
+  ).data as Library;
+
   const userDoc: User = useFirestoreDocData(
     doc(firestore, 'libraries', activeLibraryID, 'users', user.uid)
   ).data as User;
@@ -56,13 +61,18 @@ const CheckoutRow = ({ checkoutID }: { checkoutID: string }) => {
         {checkout?.dueDate?.toDate()?.toDateString() ?? 'Loading'}
       </TableCell>
       <TableCell>
-        {checkout.renewsUsed} / {userDoc?.maxRenews ?? 0}
+        {checkout.renewsUsed} /{' '}
+        {libraryDoc.checkoutGroups[userDoc.checkoutGroup].maxRenews ?? 0}
         <Button
           style={{
             marginLeft: '1rem',
           }}
           variant="contained"
-          disabled={(userDoc?.maxRenews ?? 0) - checkout.renewsUsed <= 0}
+          disabled={
+            (libraryDoc.checkoutGroups[userDoc.checkoutGroup].maxRenews ?? 0) -
+              checkout.renewsUsed <=
+            0
+          }
           onClick={() => {
             httpsCallable(
               functions,
@@ -82,7 +92,8 @@ const CheckoutRow = ({ checkoutID }: { checkoutID: string }) => {
               });
           }}
         >
-          Renew (+7 Days)
+          Renew (+
+          {libraryDoc.checkoutGroups[userDoc.checkoutGroup].renewDuration} Days)
         </Button>
       </TableCell>
       <TableCell>

emulator-data/firestore_export/firestore_export.overall_export_metadata

@@ -96,6 +96,10 @@ const FindUserTable = ({
   const activeLibraryID = useContext(ActiveLibraryID);
   if (!activeLibraryID) throw new Error('No active library found!');
 
+  const libraryDoc: Library = useFirestoreDocData(
+    doc(firestore, 'libraries', activeLibraryID)
+  ).data as Library;
+
   const userQueryRef = query(
     collection(firestore, 'libraries', activeLibraryID, 'users'),
     orderBy(textSearchField),
@@ -141,7 +145,8 @@ const FindUserTable = ({
                   </TableCell>
                   <TableCell>{user.email}</TableCell>
                   <TableCell>
-                    {user.activeCheckouts?.length} / {user.maxCheckouts}
+                    {user.activeCheckouts?.length} /{' '}
+                    {libraryDoc.checkoutGroups[user.checkoutGroup].maxCheckouts}
                   </TableCell>
                 </TableRow>
               );
@@ -322,6 +327,8 @@ const ScanBooks = ({
   const activeLibraryID = useContext(ActiveLibraryID);
   if (!activeLibraryID) throw new Error('No active library found!');
 
+  if (!checkoutData.user) throw new Error('No user found!');
+
   const firestore = useFirestore();
 
   const activeLibraryDoc: Library = useFirestoreDocData(
@@ -406,7 +413,14 @@ const ScanBooks = ({
                 id,
                 parent: parent.id,
                 parentData,
-                dueDate: new Date(new Date().setDate(new Date().getDate() + 14))
+                dueDate: new Date(
+                  new Date().setDate(
+                    new Date().getDate() +
+                      activeLibraryDoc.checkoutGroups[
+                        checkoutData?.user?.checkoutGroup ?? 'default'
+                      ].checkoutDuration
+                  )
+                )
                   .toISOString()
                   .split('T')[0],
               },
@@ -436,26 +450,29 @@ const ScanBooks = ({
           </Form>
         )}
       </Formik>
-      {(checkoutData.user?.maxCheckouts ?? 0) -
+      {(activeLibraryDoc.checkoutGroups[checkoutData.user.checkoutGroup]
+        .maxCheckouts ?? 0) -
         ((checkoutData.user?.activeCheckouts.length ?? 0) +
           checkoutData.books.length) >=
         1 && (
         <p>
           {checkoutData.user?.firstName} {checkoutData.user?.lastName} is only
           allowed{' '}
-          {(checkoutData.user?.maxCheckouts ?? 0) -
+          {(activeLibraryDoc.checkoutGroups[checkoutData.user.checkoutGroup]
+            .maxCheckouts ?? 0) -
             ((checkoutData.user?.activeCheckouts.length ?? 0) +
               checkoutData.books.length)}{' '}
           more checkouts.
         </p>
       )}
-      {(checkoutData.user?.maxCheckouts ?? 0) -
+      {(activeLibraryDoc.checkoutGroups[checkoutData.user.checkoutGroup]
+        .maxCheckouts ?? 0) -
         ((checkoutData.user?.activeCheckouts.length ?? 0) +
           checkoutData.books.length) <
         1 && (
         <h5>
           <b>
-            {checkoutData.user?.firstName} {checkoutData.user?.lastName} is not
+            {checkoutData.user?.firstName} {checkoutData.user.lastName} is not
             allowed any more checkouts.{' '}
           </b>
           You can override this.
@@ -729,6 +746,10 @@ const CheckOut = () => {
     doc(firestore, 'libraries', activeLibraryID)
   ).data as Library;
 
+  const userDoc: User = useFirestoreDocData(
+    doc(firestore, 'libraries', activeLibraryID, 'users', user.uid)
+  ).data as User;
+
   const [activeState, setActiveState] = useState(0);
   const [checkoutData, setCheckoutData] = useState<checkoutData>({
     user: null,
@@ -768,9 +789,17 @@ const CheckOut = () => {
                 currently checked out
               </li>
               <li>
-                Allowed <b>{checkoutData.user?.maxCheckouts ?? 0}</b> checkout
-                {(checkoutData.user?.maxCheckouts ?? 0) === 1 ? '' : 's'} at a
-                time
+                Allowed{' '}
+                <b>
+                  {libraryDoc.checkoutGroups[userDoc.checkoutGroup]
+                    .maxCheckouts ?? 0}
+                </b>{' '}
+                checkout
+                {(libraryDoc.checkoutGroups[userDoc.checkoutGroup]
+                  .maxCheckouts ?? 0) === 1
+                  ? ''
+                  : 's'}{' '}
+                at a time
               </li>
             </ul>
           </div>

functions/src/checkouts/renewCheckout.ts

@@ -171,7 +171,8 @@ const CheckoutDialog = () => {
             </li>
             <br />
             <li>
-              <b>Renews Used:</b> {checkout.renewsUsed} / {user.maxRenews ?? 0}
+              <b>Renews Used:</b> {checkout.renewsUsed} /{' '}
+              {libraryDoc.checkoutGroups[user.checkoutGroup].maxRenews}
             </li>
           </ul>
         </div>