isOrcidId allows sandbox-prefixed orcids

Author: Morgan Brown

src/utils/assert.ts

@@ -313,13 +313,40 @@ export function assertIsLinkedIdentityId(
   }
 }
 
-// ORCID
+/**
+ * ORCID iDs in the sandbox environment should start with this prefix.
+ */
+export const ORCID_SANDBOX_PREFIX = 'sandbox-';
+
+/**
+ * Regex to match the sandbox prefix at the start of an ORCID iD.
+ */
+const ORCID_SANDBOX_PREFIX_REGEX = new RegExp(`^${ORCID_SANDBOX_PREFIX}`);
+
+/**
+ * Removes the sandbox prefix from an ORCID iD, if present.
+ *
+ * @param orcidId An ORCID iD, possibly with the sandbox prefix.
+ * @returns The ORCID iD without the sandbox prefix.
+ */
+export function unprefixOrcidId(orcidId: string): string {
+  return orcidId.replace(ORCID_SANDBOX_PREFIX_REGEX, '');
+}
+
+/**
+ * Determine if a given string is a valid ORCID iD. ORCID iDs can be
+ * prefixed with "sandbox-".
+ *
+ * @param orcidId An ORCID iD
+ * @returns true if the ORCID iD is valid, false otherwise.
+ */
 export function isOrcidId(orcidId: string): boolean {
   if (typeof orcidId !== 'string') {
     return false;
   }
 
-  const baseStr: string = orcidId.replace(/[-\s]/g, '');
+  const unprefixedOrcidId = unprefixOrcidId(orcidId);
+  const baseStr: string = unprefixedOrcidId.replace(/[-\s]/g, '');
 
   const orcidPattern: RegExp = /^\d{15}[\dX]$/;
   if (!orcidPattern.test(baseStr.toUpperCase())) {

tests/utils/assert.test.ts

@@ -1,16 +1,35 @@
 import { describe, test, expect } from 'vitest';
 import {
   isOrcidId,
+  unprefixOrcidId,
+  ORCID_SANDBOX_PREFIX,
   isLinkedIdentityId,
   assertIsLinkedIdentityId,
 } from '../../src/utils/assert';
 
+describe('unprefixOrcidId', () => {
+  test('should remove sandbox prefix from ORCID ID', () => {
+    expect(unprefixOrcidId(`${ORCID_SANDBOX_PREFIX}0009-0007-1106-8413`)).toBe(
+      '0009-0007-1106-8413',
+    );
+  });
+
+  test('should return ORCID ID unchanged if no sandbox prefix', () => {
+    expect(unprefixOrcidId('0009-0007-1106-8413')).toBe('0009-0007-1106-8413');
+  });
+});
+
 describe('isOrcidId', () => {
   test('should return true for valid ORCID IDs', () => {
     // Valid ORCID ID patterns with correct checksums
     expect(isOrcidId('0000-0003-1527-0030')).toBe(true);
   });
 
+  test('should return true for valid sandbox-prefixed ORCID IDs', () => {
+    // Valid sandbox ORCID ID with correct checksum after removing prefix
+    expect(isOrcidId(`${ORCID_SANDBOX_PREFIX}0009-0007-1106-8413`)).toBe(true);
+  });
+
   test('should return false for invalid ORCID IDs', () => {
     // Invalid patterns
     expect(isOrcidId('0000-0002-1825-009X')).toBe(false); // Invalid checksum
@@ -33,6 +52,11 @@ describe('isOrcidId', () => {
     expect(isOrcidId('abc-def-ghi-jkl')).toBe(false); // Letters instead of digits
     expect(isOrcidId('0000-0000-0000-000@')).toBe(false); // Invalid special character
   });
+
+  test('should return false for sandbox-prefixed invalid ORCID IDs', () => {
+    // Invalid checksum even with sandbox prefix
+    expect(isOrcidId('sandbox-0000-0002-1825-009X')).toBe(false);
+  });
 });
 
 describe('isLinkedIdentityId', () => {