Allow catalogNumber format to be determined by CollectionObjectType

config/common/common.views.xml

@@ -2083,10 +2083,12 @@
 				<row>
 					<cell type="label" labelfor="1"/>
 					<cell type="field" id="1" name="name" uitype="text" isrequired="true"/>
+					<cell type="label" labelfor="2"/>
+					<cell type="field" id="2" name="catalogNumberFormatName" uitype="combobox"/>
 				</row>
 				<row>
-					<cell type="label" labelfor="2"/>
-					<cell type="field" id="2" name="taxontreedef" uitype="querycbx" isrequired="true"/>
+					<cell type="label" labelfor="3"/>
+					<cell type="field" id="3" name="taxontreedef" uitype="querycbx" isrequired="true"/>
 				</row>
 			</rows>
 		</viewdef>

specifyweb/context/views.py

@@ -26,7 +26,7 @@
     check_permission_targets, skip_collection_access_check, query_pt, \
     CollectionAccessPT
 from specifyweb.specify.models import Collection, Institution, \
-    Specifyuser, Spprincipal, Spversion
+    Specifyuser, Spprincipal, Spversion, Collectionobjecttype
 from specifyweb.specify.schema import base_schema
 from specifyweb.specify.api import uri_for_model
 from specifyweb.specify.serialize_datamodel import datamodel_to_json
@@ -341,7 +341,10 @@ def domain(request):
         'embeddedPaleoContext': collection.discipline.ispaleocontextembedded,
         'paleoContextChildTable': collection.discipline.paleocontextchildtable,
         'catalogNumFormatName': collection.catalognumformatname,
-        'defaultCollectionObjectType': uri_for_model(collection.collectionobjecttype.__class__, collection.collectionobjecttype.id) if collection.collectionobjecttype is not None else None
+        'defaultCollectionObjectType': uri_for_model(collection.collectionobjecttype.__class__, collection.collectionobjecttype.id) if collection.collectionobjecttype is not None else None,
+        'collectionObjectTypeCatalogNumberFormats': {
+            uri_for_model(cot.__class__, cot.id): cot.catalognumberformatname for cot in collection.cotypes.all()
+        }
     }
 
     return HttpResponse(json.dumps(domain), content_type='application/json')

specifyweb/frontend/js_src/lib/components/AttachmentsBulkImport/__tests__/utils.test.ts

@@ -55,7 +55,8 @@ const fileNameTestSpec: TestDefinition = {
           byYear: false,
         }),
       ],
-      tables.CollectionObject
+      tables.CollectionObject,
+      tables.CollectionObject?.getLiteralField('catalogNumber')
     ),
     testCases: [
       ['000.jpg', '000'],
@@ -79,7 +80,8 @@ const fileNameTestSpec: TestDefinition = {
           byYear: false,
         }),
       ],
-      tables.CollectionObject
+      tables.CollectionObject,
+      tables.CollectionObject?.getLiteralField('catalogNumber')
     ),
     testCases: [
       ['45265.jpg', '45265'],

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

@@ -100,6 +100,7 @@ describe('serializeResource', () => {
           isNot: false,
           isPrompt: null,
           isRelFld: null,
+          isStrict: false,
           modifiedByAgent: null,
           operEnd: null,
           operStart: 0,

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

@@ -6,6 +6,11 @@ requireContext();
 test('domain data is fetched and parsed correctly', async () =>
   expect(fetchContext).resolves.toEqual({
     catalogNumFormatName: 'CatalogNumberNumeric',
+    collectionObjectTypeCatalogNumberFormats: {
+      '/api/specify/collectionobjecttype/1/': null,
+      '/api/specify/collectionobjecttype/2/': 'CatalogNumber',
+      '/api/specify/collectionobjecttype/3/': 'CatalogNumberNumericRegex',
+    },
     domainLevelIds: {
       collection: 4,
       discipline: 3,

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

@@ -12,7 +12,7 @@
  * schema, but it's here for now.
  */
 
-import type { RR, Writable } from '../../utils/types';
+import type { IR, RR, Writable } from '../../utils/types';
 import { load } from '../InitialContext';
 
 type Schema = {
@@ -21,6 +21,7 @@ type Schema = {
   readonly embeddedPaleoContext: boolean;
   readonly paleoContextChildTable: string;
   readonly catalogNumFormatName: string;
+  readonly collectionObjectTypeCatalogNumberFormats: IR<string | null>;
   readonly defaultCollectionObjectType: string | null;
   readonly orgHierarchy: readonly [
     'CollectionObject',
@@ -51,6 +52,8 @@ const schemaBase: Writable<Schema> = {
   paleoContextChildTable: undefined!,
   catalogNumFormatName: undefined!,
 
+  collectionObjectTypeCatalogNumberFormats: {},
+
   // Default collectionObjectType for the collection
   defaultCollectionObjectType: undefined!,
 
@@ -94,6 +97,8 @@ export const fetchContext = load<
   schemaBase.embeddedPaleoContext = data.embeddedPaleoContext;
   schemaBase.paleoContextChildTable = data.paleoContextChildTable;
   schemaBase.catalogNumFormatName = data.catalogNumFormatName;
+  schemaBase.collectionObjectTypeCatalogNumberFormats =
+    data.collectionObjectTypeCatalogNumberFormats;
   schemaBase.defaultCollectionObjectType = data.defaultCollectionObjectType;
   return schemaBase;
 });

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

@@ -5,10 +5,11 @@
 import type { IR, RA, RR } from '../../utils/types';
 import { getField } from './helpers';
 import type { TableFields } from './helperTypes';
+import type { SpecifyResource } from './legacyTypes';
 import { schema } from './schema';
 import { LiteralField, Relationship } from './specifyField';
 import type { SpecifyTable } from './specifyTable';
-import type { Tables } from './types';
+import type { CollectionObject, Tables } from './types';
 
 export const schemaAliases: RR<'', IR<string>> & {
   readonly [TABLE_NAME in keyof Tables]?: IR<TableFields<Tables[TABLE_NAME]>>;
@@ -106,12 +107,21 @@ export const schemaExtras: {
       collection.otherSideName = 'collectionObjects';
 
       /*
-       * Catalog number formatter is taken from the field on the collection,
-       * if present
+       * The Catalog number format is determined in the following heirarchy,
+       * using the 'next level' if the format is not defined (or falsy):
+       *
+       * - The Collection Object's collectionObjectType -> catalogNumberFormatName
+       * - Collection -> catalogNumFormatName
+       * - Schema Configuration format for catalognumber
        */
       const catalognumber = getField(table, 'catalogNumber');
-      catalognumber.getFormat = (): string | undefined =>
-        schema.catalogNumFormatName ||
+      catalognumber.getFormat = (
+        resource?: SpecifyResource<CollectionObject>
+      ): string | undefined =>
+        (schema.collectionObjectTypeCatalogNumberFormats[
+          resource?.get('collectionObjectType') ?? ''
+        ] ??
+          schema.catalogNumFormatName) ||
         LiteralField.prototype.getFormat.call(catalognumber);
     },
   ],

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

@@ -10,6 +10,7 @@ import { camelToHuman } from '../../utils/utils';
 import { type UiFormatter, getUiFormatters } from '../FieldFormatters';
 import { isTreeTable } from '../InitialContext/treeRanks';
 import { getFrontEndPickLists } from '../PickLists/definitions';
+import { AnySchema } from './helperTypes';
 import type { SpecifyResource } from './legacyTypes';
 import { schema, unescape } from './schema';
 import { getFieldOverwrite, getGlobalFieldOverwrite } from './schemaOverrides';
@@ -273,13 +274,15 @@ export class LiteralField extends FieldBase {
   }
 
   // Returns the name of the UIFormatter for the field from the schema config.
-  public getFormat(): string | undefined {
+  public getFormat(_resource?: SpecifyResource<AnySchema>): string | undefined {
     return this.localization.format ?? undefined;
   }
 
   // Returns the UIFormatter for the field specified in the schema config.
-  public getUiFormatter(): UiFormatter | undefined {
-    return getUiFormatters()[this.getFormat() ?? ''];
+  public getUiFormatter(
+    resource?: SpecifyResource<AnySchema>
+  ): UiFormatter | undefined {
+    return getUiFormatters()[this.getFormat(resource) ?? ''];
   }
 }
 

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

@@ -6471,6 +6471,7 @@ export type Spdataset = {
 export type CollectionObjectType = {
   readonly tableName: 'CollectionObjectType';
   readonly fields: {
+    readonly catalogNumberFormatName: string | null;
     readonly name: string;
     readonly text1: string | null;
     readonly text2: string | null;

specifyweb/frontend/js_src/lib/components/FieldFormatters/__tests__/__snapshots__/index.test.ts.snap

@@ -3,6 +3,7 @@
 exports[`field formatters are fetched and parsed correctly 1`] = `
 {
   "AccessionNumber": UiFormatter {
+    "field": "[literalField Accession.accessionNumber]",
     "fields": [
       YearField {
         "autoIncrement": false,
@@ -50,6 +51,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "AccessionNumber",
   },
   "AccessionNumberByYear": UiFormatter {
+    "field": "[literalField Accession.accessionNumber]",
     "fields": [
       YearField {
         "autoIncrement": false,
@@ -97,6 +99,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "AccessionNumberByYear",
   },
   "AccessionStringFormatter": UiFormatter {
+    "field": "[literalField Accession.accessionNumber]",
     "fields": [
       AlphaNumberField {
         "autoIncrement": false,
@@ -112,6 +115,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "AccessionStringFormatter",
   },
   "CatalogNumber": UiFormatter {
+    "field": "[literalField CollectionObject.catalogNumber]",
     "fields": [
       YearField {
         "autoIncrement": false,
@@ -143,6 +147,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "CatalogNumber",
   },
   "CatalogNumberAlphaNumByYear": UiFormatter {
+    "field": "[literalField CollectionObject.catalogNumber]",
     "fields": [
       YearField {
         "autoIncrement": false,
@@ -174,6 +179,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "CatalogNumberAlphaNumByYear",
   },
   "CatalogNumberNumeric": CatalogNumberNumeric {
+    "field": "[literalField CollectionObject.catalogNumber]",
     "fields": [
       CatalogNumberNumericField {
         "autoIncrement": true,
@@ -189,6 +195,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "Catalog Number Numeric",
   },
   "CatalogNumberNumericRegex": UiFormatter {
+    "field": "[literalField CollectionObject.catalogNumber]",
     "fields": [
       RegexField {
         "autoIncrement": false,
@@ -204,12 +211,14 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "CatalogNumberNumericRegex",
   },
   "Date": UiFormatter {
+    "field": undefined,
     "fields": [],
     "isSystem": true,
     "table": undefined,
     "title": "Date",
   },
   "DeaccessionNumber": UiFormatter {
+    "field": "[literalField Deaccession.deaccessionNumber]",
     "fields": [
       YearField {
         "autoIncrement": false,
@@ -257,6 +266,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "DeaccessionNumber",
   },
   "GiftNumber": UiFormatter {
+    "field": "[literalField Gift.giftNumber]",
     "fields": [
       YearField {
         "autoIncrement": false,
@@ -288,6 +298,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "GiftNumber",
   },
   "InfoRequestNumber": UiFormatter {
+    "field": "[literalField InfoRequest.infoReqNumber]",
     "fields": [
       YearField {
         "autoIncrement": false,
@@ -319,6 +330,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "InfoRequestNumber",
   },
   "KUITeach": CatalogNumberNumeric {
+    "field": "[literalField CollectionObject.catalogNumber]",
     "fields": [
       CatalogNumberNumericField {
         "autoIncrement": true,
@@ -334,6 +346,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "Catalog Number Numeric",
   },
   "LoanNumber": UiFormatter {
+    "field": "[literalField Loan.loanNumber]",
     "fields": [
       YearField {
         "autoIncrement": false,
@@ -365,6 +378,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "LoanNumber",
   },
   "NumericBigDecimal": UiFormatter {
+    "field": undefined,
     "fields": [
       NumericField {
         "autoIncrement": false,
@@ -380,6 +394,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "NumericBigDecimal",
   },
   "NumericByte": UiFormatter {
+    "field": undefined,
     "fields": [
       NumericField {
         "autoIncrement": false,
@@ -395,6 +410,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "NumericByte",
   },
   "NumericDouble": UiFormatter {
+    "field": undefined,
     "fields": [
       NumericField {
         "autoIncrement": false,
@@ -410,6 +426,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "NumericDouble",
   },
   "NumericFloat": UiFormatter {
+    "field": undefined,
     "fields": [
       NumericField {
         "autoIncrement": false,
@@ -425,6 +442,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "NumericFloat",
   },
   "NumericInteger": UiFormatter {
+    "field": undefined,
     "fields": [
       NumericField {
         "autoIncrement": false,
@@ -440,6 +458,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "NumericInteger",
   },
   "NumericLong": UiFormatter {
+    "field": undefined,
     "fields": [
       NumericField {
         "autoIncrement": false,
@@ -455,6 +474,7 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "NumericLong",
   },
   "NumericShort": UiFormatter {
+    "field": undefined,
     "fields": [
       NumericField {
         "autoIncrement": false,
@@ -470,24 +490,28 @@ exports[`field formatters are fetched and parsed correctly 1`] = `
     "title": "NumericShort",
   },
   "PartialDate": UiFormatter {
+    "field": undefined,
     "fields": [],
     "isSystem": false,
     "table": undefined,
     "title": "PartialDate",
   },
   "PartialDateMonth": UiFormatter {
+    "field": undefined,
     "fields": [],
     "isSystem": false,
     "table": undefined,
     "title": "PartialDateMonth",
   },
   "PartialDateYear": UiFormatter {
+    "field": undefined,
     "fields": [],
     "isSystem": false,
     "table": undefined,
     "title": "PartialDateYear",
   },
   "SearchDate": UiFormatter {
+    "field": undefined,
     "fields": [],
     "isSystem": true,
     "table": undefined,