COG business rules: isPrimary and isSubstrate

specifyweb/frontend/js_src/lib/components/DataModel/__tests__/__snapshots__/specifyTable.test.ts.snap

@@ -1293,7 +1293,7 @@ exports[`tableScoping 1`] = `
   "CollectionObjectAttribute": undefined,
   "CollectionObjectCitation": "collectionObject",
   "CollectionObjectGroup": "collection",
-  "CollectionObjectGroupJoin": "parentcog > collection",
+  "CollectionObjectGroupJoin": "parentCog > collection",
   "CollectionObjectGroupType": "collection",
   "CollectionObjectProperty": "collectionObject",
   "CollectionObjectType": "collection",

specifyweb/frontend/js_src/lib/components/DataModel/__tests__/businessRules.test.ts

@@ -210,6 +210,48 @@ describe('Collection Object business rules', () => {
   });
 });
 
+describe('CollectionObjectGroup business rules', () => {
+  const getBaseCOG = () => {
+    const cog = new tables.CollectionObjectGroup.Resource({
+      id: 1,
+      cogType: getResourceApiUrl('CollectionObjectGroupType', 1),
+      resource_uri: getResourceApiUrl('CollectionObjectGroup', 1),
+    });
+
+    const cojo1 = new tables.CollectionObjectGroupJoin.Resource({
+      isPrimary: false,
+      isSubstrate: true,
+      childCo: getResourceApiUrl('CollectionObject', 1),
+      parentCog: getResourceApiUrl('CollectionObjectGroup', 1),
+    });
+    const cojo2 = new tables.CollectionObjectGroupJoin.Resource({
+      isPrimary: true,
+      isSubstrate: false,
+      childCo: getResourceApiUrl('CollectionObject', 2),
+      parentCog: getResourceApiUrl('CollectionObjectGroup', 1),
+    });
+
+    cog.set('parentCojos', [cojo1, cojo2]);
+    return { cog, cojo1, cojo2 };
+  };
+
+  test('Only one CO COJO can be primary', () => {
+    const { cojo1, cojo2 } = getBaseCOG();
+    cojo1.set('isPrimary', true);
+
+    expect(cojo1.get('isPrimary')).toBe(true);
+    expect(cojo2.get('isPrimary')).toBe(false);
+  });
+
+  test('Only one CO COJO can be substrate', () => {
+    const { cojo1, cojo2 } = getBaseCOG();
+    cojo2.set('isSubstrate', true);
+
+    expect(cojo1.get('isSubstrate')).toBe(false);
+    expect(cojo2.get('isSubstrate')).toBe(true);
+  });
+});
+
 describe('DNASequence business rules', () => {
   test('fieldCheck geneSequence', async () => {
     const dNASequence = new tables.DNASequence.Resource({

specifyweb/frontend/js_src/lib/components/DataModel/businessRuleDefs.ts

@@ -2,6 +2,13 @@ import { formsText } from '../../localization/forms';
 import { resourcesText } from '../../localization/resources';
 import { f } from '../../utils/functools';
 import type { BusinessRuleResult } from './businessRules';
+import {
+  CURRENT_DETERMINATION_KEY,
+  DETERMINATION_TAXON_KEY,
+  ensureSingleCollectionObjectCheck,
+  hasNoCurrentDetermination,
+} from './businessRuleUtils';
+import { cogTypes } from './helpers';
 import type { AnySchema, TableFields } from './helperTypes';
 import {
   checkPrepAvailability,
@@ -20,6 +27,7 @@ import type {
   Address,
   BorrowMaterial,
   CollectionObject,
+  CollectionObjectGroupJoin,
   Determination,
   DNASequence,
   LoanPreparation,
@@ -49,15 +57,6 @@ type MappedBusinessRuleDefs = {
   readonly [TABLE in keyof Tables]?: BusinessRuleDefs<Tables[TABLE]>;
 };
 
-const CURRENT_DETERMINATION_KEY = 'determination-isCurrent';
-const DETERMINATION_TAXON_KEY = 'determination-taxon';
-
-const hasNoCurrentDetermination = (collection: Collection<Determination>) =>
-  collection.models.length > 0 &&
-  !collection.models.some((determination: SpecifyResource<Determination>) =>
-    determination.get('isCurrent')
-  );
-
 export const businessRuleDefs: MappedBusinessRuleDefs = {
   Address: {
     customInit: (address) => {
@@ -202,6 +201,42 @@ export const businessRuleDefs: MappedBusinessRuleDefs = {
     },
   },
 
+  CollectionObjectGroup: {
+    fieldChecks: {
+      cogType: (cog): void => {
+        // The first COJO CO will automatically have isPrimary set to True when the COG type is 'consolidated'
+        cog.rgetPromise('cogType').then((cogtype) => {
+          if (cogtype.get('type') === cogTypes.CONSOLIDATED) {
+            const cojos = cog.getDependentResource('parentCojos');
+            // Set first CO in COG to primary
+            cojos?.models
+              .find((cojo) => cojo.get('childCo') !== null)
+              ?.set('isPrimary', true);
+          }
+        });
+      },
+    },
+  },
+
+  CollectionObjectGroupJoin: {
+    fieldChecks: {
+      /*
+       * Only a single CO in a COG can be set as primary.
+       * When checking a CO as primary, other COs in that COG will get unchecked.
+       */
+      isPrimary: (cojo: SpecifyResource<CollectionObjectGroupJoin>): void => {
+        ensureSingleCollectionObjectCheck(cojo, 'isPrimary');
+      },
+      /*
+       * Only a single CO in a COG can be set as substrate.
+       * When checking a CO as substrate, other COs in that COG will get unchecked.
+       */
+      isSubstrate: (cojo: SpecifyResource<CollectionObjectGroupJoin>): void => {
+        ensureSingleCollectionObjectCheck(cojo, 'isSubstrate');
+      },
+    },
+  },
+
   Determination: {
     fieldChecks: {
       taxon: async (

specifyweb/frontend/js_src/lib/components/DataModel/businessRuleUtils.ts

@@ -0,0 +1,40 @@
+import type { SpecifyResource } from './legacyTypes';
+import type { Collection } from './specifyTable';
+import type { CollectionObjectGroupJoin, Determination } from './types';
+
+// Save blocker keys used in businessRuleDefs.ts
+export const CURRENT_DETERMINATION_KEY = 'determination-isCurrent';
+export const DETERMINATION_TAXON_KEY = 'determination-taxon';
+
+/**
+ *
+ * Calculates whether a collection of determinations has any current determinations or not
+ * Used in CO -> Determination -> isCurrent business rule
+ */
+export const hasNoCurrentDetermination = (
+  collection: Collection<Determination>
+) =>
+  collection.models.length > 0 &&
+  !collection.models.some((determination: SpecifyResource<Determination>) =>
+    determination.get('isCurrent')
+  );
+
+/**
+ *
+ * Ensures only one CO in a COG can be checked as isPrimary or isSubstrate
+ * Used in COG business rules: https://github.com/specify/specify7/issues/5246
+ */
+export const ensureSingleCollectionObjectCheck = (
+  cojo: SpecifyResource<CollectionObjectGroupJoin>,
+  field: 'isPrimary' | 'isSubstrate'
+) => {
+  if (cojo.get(field) && cojo.collection !== undefined) {
+    cojo.collection.models
+      .filter((resource) => resource.get('childCo') !== null)
+      .forEach((other: SpecifyResource<CollectionObjectGroupJoin>) => {
+        if (other.cid !== cojo.cid) {
+          other.set(field, false);
+        }
+      });
+  }
+};

specifyweb/frontend/js_src/lib/components/DataModel/helpers.ts

@@ -216,3 +216,10 @@ export async function fetchDistantRelated(
         field,
       };
 }
+
+// Cog types: Discrete, Consolidated, Drill Core
+export const cogTypes = {
+  DISCRETE: 'Discrete',
+  CONSOLIDATED: 'Consolidated',
+  DRILL_CORE: 'Drill Core',
+};