refactor(ts): enable strict type checking and tighten tsconfig rules

jujaga · jujaga · commit 6f1f66e00885 · 2026-04-01T09:55:23.000-07:00
Updated tsconfig.json to enforce stricter type safety and modern module
resolution. These changes align the project with TypeScript best practices
and prevent common runtime errors.

Key configuration changes:
- Enabled `strict` mode for comprehensive type checking.
- Added `noUncheckedIndexedAccess` to handle potentially undefined
  array/object lookups.
- Added `noImplicitOverride` to ensure subclass methods are explicitly
  marked.
- Set `moduleDetection` to 'force' to treat all files as modules.
- Explicitly defined `include` and `exclude` patterns.

Signed-off-by: Jeremy Ho &lt;jujaga@gmail.com&gt;
diff --git a/branch.helper.ts b/branch.helper.ts
@@ -24,7 +24,7 @@ function getGitDir(): string {
       if (stats.isFile()) {
         const content = readFileSync(dotGitPath, 'utf-8');
         const match = /^gitdir:\s+(.*)$/m.exec(content);
-        if (match) {
+        if (match?.[1]) {
           const gitDir = match[1].trim();
           // If worktree path is relative, resolve it relative to the .git file location
           return isAbsolute(gitDir) ? gitDir : resolve(currentDir, gitDir);
diff --git a/src/docs/docs.ts b/src/docs/docs.ts
@@ -50,10 +50,10 @@ export function getDocHTML(version = 'v1'): string {
 export function getSpec(): OpenAPISpec {
   const rawSpec = readFileSync('src/docs/openapi.yaml', 'utf8');
   const spec = load(rawSpec) as OpenAPISpec;
-  spec.servers[0].url = '/api/v1';
-  if (process.env.AUTH_ISSUER) {
+  if (spec.servers?.[0]) spec.servers[0].url = '/api/v1';
+  if (process.env.AUTH_ISSUER && spec.components.securitySchemes?.OpenID) {
     // eslint-disable-next-line max-len
-    spec.components.securitySchemes!.OpenID.openIdConnectUrl = `${process.env.AUTH_ISSUER}/.well-known/openid-configuration`;
+    spec.components.securitySchemes.OpenID.openIdConnectUrl = `${process.env.AUTH_ISSUER}/.well-known/openid-configuration`;
   }
   if (state.authMode && state.authMode === 'none') {
     delete spec.security;
diff --git a/src/middlewares/helpers/oauth.ts b/src/middlewares/helpers/oauth.ts
@@ -25,7 +25,7 @@ export function getBearerToken(req: Request): string | undefined | null {
   const [scheme, token] = parts;
   if (parts.length !== 2 || scheme !== 'Bearer') return null;
 
-  return /^[A-Za-z0-9\-._~+/]+=*$/.test(token) ? token : null; // RFC 6750 Section 2.1
+  return token && /^[A-Za-z0-9\-._~+/]+=*$/.test(token) ? token : null; // RFC 6750 Section 2.1
 }
 
 /**
diff --git a/src/repositories/base.ts b/src/repositories/base.ts
@@ -175,7 +175,7 @@ export abstract class BaseRepository<TB extends keyof DB, C extends string = str
    */
   upsert(data: InsertObject<DB, TB>, constraint?: C): InsertQueryBuilder<DB, TB, Selectable<DB[TB]>> {
     return this.create(data).onConflict((oc) => {
-      if (this.constraints.length) return oc.constraint(constraint ?? this.constraints[0]).doNothing();
+      if (this.constraints.length) return oc.constraint((constraint ?? this.constraints[0]) as string).doNothing();
       return oc.column(this.idColumn).doNothing();
     });
   }
@@ -188,7 +188,7 @@ export abstract class BaseRepository<TB extends keyof DB, C extends string = str
    */
   upsertMany(data: readonly InsertObject<DB, TB>[], constraint?: C): InsertQueryBuilder<DB, TB, Selectable<DB[TB]>> {
     return this.createMany(data).onConflict((oc) => {
-      if (this.constraints.length) return oc.constraint(constraint ?? this.constraints[0]).doNothing();
+      if (this.constraints.length) return oc.constraint((constraint ?? this.constraints[0]) as string).doNothing();
       return oc.column(this.idColumn).doNothing();
     });
   }
diff --git a/src/services/helpers/event.ts b/src/services/helpers/event.ts
@@ -30,7 +30,7 @@ export function dateTimePartsToEvent(parts: {
     return {
       start_date: startDate.toISOString().split('T')[0],
       end_date: endDate ? endDate.toISOString().split('T')[0] : undefined
-    };
+    } as Event;
   }
 }
 
@@ -50,9 +50,9 @@ export function eventToDateTimeParts(event: Event): {
   const eventEnd = end_datetime ?? end_date;
 
   return {
-    endDate: eventEnd?.split('T')[0],
-    endTime: end_datetime ? eventEnd?.split('T')[1] : undefined,
-    startDate: eventStart.split('T')[0],
+    endDate: eventEnd?.split('T')[0] ?? undefined,
+    endTime: end_datetime && eventEnd ? eventEnd.split('T')[1] : undefined,
+    startDate: eventStart?.split('T')[0] ?? '',
     startTime: start_datetime ? eventStart.split('T')[1] : undefined
   };
 }
@@ -70,17 +70,17 @@ export function mergeDateAndTimeToISOString(date: Date, time: string): string {
   const day = date.getUTCDate();
 
   // Strip anything after the time (Z, +00:00, etc.) and split
-  const cleanTime = time.split(/[Z+-]/)[0];
+  const cleanTime = time.split(/[Z+-]/)[0] ?? '';
   const timeParts = cleanTime.split(':');
   if (timeParts.length < 2) throw new Error(`Invalid time format: ${time}`);
 
-  const hour = Number.parseInt(timeParts[0], 10);
-  const minute = Number.parseInt(timeParts[1], 10);
+  const hour = Number.parseInt(timeParts[0] ?? '', 10);
+  const minute = Number.parseInt(timeParts[1] ?? '', 10);
 
   // Handle optional seconds and milliseconds
-  const secondsPart = timeParts[2]?.split('.') || ['0', '0'];
-  const second = Number.parseInt(secondsPart[0], 10);
-  const ms = Number.parseInt(secondsPart[1] || '0', 10);
+  const secondsPart = timeParts[2]?.split('.') ?? ['0', '0'];
+  const second = Number.parseInt(secondsPart[0] ?? '', 10);
+  const ms = Number.parseInt(secondsPart[1] ?? '0', 10);
   if ([hour, minute, second].some((num) => Number.isNaN(num))) {
     throw new Error(`Invalid numeric values in time: ${time}`);
   }
diff --git a/src/services/record.ts b/src/services/record.ts
@@ -67,8 +67,8 @@ export const findRecordService = (systemRecord: Selectable<PiesSystemRecord>): P
 
             const coding: Coding = {
               code: codingRaw.code,
-              code_display: CodingDictionary[codingRaw.codeSystem][codingRaw.code].display,
-              code_set: CodingDictionary[codingRaw.codeSystem][codingRaw.code].codeSet,
+              code_display: CodingDictionary[codingRaw.codeSystem]?.[codingRaw.code]?.display ?? '',
+              code_set: CodingDictionary[codingRaw.codeSystem]?.[codingRaw.code]?.codeSet ?? [codingRaw.code],
               code_system: codingRaw.codeSystem
             };
             return { coding, event } satisfies CodingEvent;
@@ -94,8 +94,8 @@ export const findRecordService = (systemRecord: Selectable<PiesSystemRecord>): P
 
             const process: Process = {
               code: coding.code,
-              code_display: CodingDictionary[coding.codeSystem][coding.code].display,
-              code_set: CodingDictionary[coding.codeSystem][coding.code].codeSet,
+              code_display: CodingDictionary[coding.codeSystem]?.[coding.code]?.display ?? '',
+              code_set: CodingDictionary[coding.codeSystem]?.[coding.code]?.codeSet ?? [coding.code],
               code_system: coding.codeSystem,
               status: pe.status ?? undefined,
               status_code: pe.statusCode ?? undefined,
@@ -122,7 +122,7 @@ export const findRecordService = (systemRecord: Selectable<PiesSystemRecord>): P
 };
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export const mergeRecordService = (data: Record, principal?: string): Promise<void> => {
+export const mergeRecordService = (_data: Record, _principal?: string): Promise<void> => {
   throw new Error('mergeRecordService not implemented');
 };
 
diff --git a/src/services/systemRecord.ts b/src/services/systemRecord.ts
@@ -49,7 +49,7 @@ export const findSingleSystemRecordService = async (
         );
       }
 
-      return systemRecords[0];
+      return systemRecords[0] as Selectable<PiesSystemRecord>;
     },
     { accessMode: 'read only' }
   );
diff --git a/src/utils/problem.ts b/src/utils/problem.ts
@@ -80,7 +80,7 @@ export default class Problem extends Error {
    * Converts the `Problem` instance to a string representation.
    * @returns A string in the format `[status] title (type)`.
    */
-  toString() {
+  override toString() {
     return `[${this.status}] ${this.title} (${this.type})`;
   }
 
diff --git a/src/utils/utils.ts b/src/utils/utils.ts
@@ -68,7 +68,7 @@ export function getGitRevision(): string | undefined {
 
     const content = readFileSync(gitPath, 'utf8').trim();
     const match = /^gitdir: (.+)$/.exec(content);
-    return match ? join(cwd(), match[1]) : gitPath;
+    return match?.[1] ? join(cwd(), match[1]) : gitPath;
   };
 
   const readRef = (gitDir: string, ref: string): string | undefined => {
diff --git a/src/validators/integrity/auditor.ts b/src/validators/integrity/auditor.ts
@@ -6,7 +6,8 @@ const codeSystemCache = new Set<keyof typeof CodingDictionary>(Object.keys(Codin
 /** Caches sets of codes for each code system. */
 const codeSetCache: Record<string, Set<string>> = {};
 for (const codeSystem of codeSystemCache) {
-  codeSetCache[codeSystem] = new Set(Object.keys(CodingDictionary[codeSystem]));
+  const codes = CodingDictionary[codeSystem];
+  if (codes) codeSetCache[codeSystem] = new Set(Object.keys(codes));
 }
 
 /**
@@ -66,7 +67,7 @@ export function auditProcess(data: Process, index: number): IntegrityError[] {
       value: data.code_system
     });
   }
-  if (!codeSystemCache.has(data.code_system) || !codeSetCache[data.code_system].has(data.code)) {
+  if (!codeSystemCache.has(data.code_system) || !codeSetCache[data.code_system]?.has(data.code)) {
     errors.push({
       instancePath: `/process_event/${index}/process`,
       message: `Invalid Process in ProcessEvent element at index ${index}`,
diff --git a/src/validators/schema/schema.ts b/src/validators/schema/schema.ts
@@ -68,5 +68,7 @@ export async function loadSchema(schema: string): Promise<SchemaObject> {
     }
   }
 
-  return schemaCache[schema];
+  const result = schemaCache[schema];
+  if (!result) throw new Error(`Schema ${schema} was not found in cache after loading.`);
+  return result;
 }
diff --git a/tests/load/getRecords.ts b/tests/load/getRecords.ts
@@ -15,7 +15,7 @@ const CLIENT_ID = __ENV.CLIENT_ID ?? env.CLIENT_ID;
 const CLIENT_SECRET = __ENV.CLIENT_SECRET ?? env.CLIENT_SECRET;
 const RECORD_ID = 'k6-test-1';
 const SYSTEM_ID = 'ITSM-5917';
-const TOKEN_ENDPOINT = __ENV.CLIENT_SECRET ?? env.TOKEN_ENDPOINT;
+const TOKEN_ENDPOINT = __ENV.TOKEN_ENDPOINT ?? env.TOKEN_ENDPOINT;
 
 export { options } from './helpers/index.ts';
 
@@ -24,6 +24,10 @@ export { options } from './helpers/index.ts';
  * @returns - Data created in setup to be used by VU execution
  */
 export function setup() {
+  if (!CLIENT_ID || !CLIENT_SECRET || !TOKEN_ENDPOINT) {
+    throw new Error('Missing required environment variables for authentication');
+  }
+
   const token = fetchBearerToken(CLIENT_ID, CLIENT_SECRET, TOKEN_ENDPOINT);
   const res = http.get(`${BASE_URL}${API_RECORD}?record_id=${RECORD_ID}&system_id=${SYSTEM_ID}`, {
     headers: {
diff --git a/tests/load/helpers/generators.ts b/tests/load/helpers/generators.ts
@@ -14,7 +14,7 @@ const RECORD_PREFIX = 'k6-test-';
  */
 export function generateCoding(): Coding {
   const codeSystem = 'https://bcgov.github.io/nr-pies/docs/spec/code_system/on_hold_process';
-  const code = randomItem(Object.entries(CodingDictionary[codeSystem]));
+  const code = randomItem(Object.entries(CodingDictionary[codeSystem] ?? {}));
   return {
     code: code[0],
     code_display: code[1].display,
@@ -63,7 +63,7 @@ export function generateOnHoldEvent(): CodingEvent {
  */
 export function generateProcess(): Process {
   const codeSystem = 'https://bcgov.github.io/nr-pies/docs/spec/code_system/application_process';
-  const code = randomItem(Object.entries(CodingDictionary[codeSystem]));
+  const code = randomItem(Object.entries(CodingDictionary[codeSystem] ?? {}));
   return {
     code: code[0],
     code_display: code[1].display,
diff --git a/tests/load/helpers/utils.ts b/tests/load/helpers/utils.ts
@@ -25,7 +25,9 @@ export function fetchBearerToken(clientId: string, secret: string, tokenEndpoint
  */
 export function parseEnv(): Record<string, string> {
   const env: Record<string, string> = {};
-  const data = open(import.meta.resolve('../.env'));
+  const envPath = import.meta.resolve('../.env');
+  if (!envPath) throw new Error('Could not resolve .env file path');
+  const data = open(envPath);
   const lines = data.split(/\r?\n/); // Handles Windows (\r\n) and Unix (\n)
 
   lines.forEach((line) => {
@@ -73,7 +75,9 @@ export function randomIntBetween(min: number, max: number): number {
  * @returns A randomly selected item from the array.
  */
 export function randomItem<T>(arrayOfItems: readonly T[]): T {
-  return arrayOfItems[Math.floor(secureRandom() * arrayOfItems.length)];
+  const item = arrayOfItems[Math.floor(secureRandom() * arrayOfItems.length)];
+  if (item === undefined || item === null) throw new Error('randomItem: Selected item is null or undefined');
+  return item;
 }
 
 /**
@@ -94,7 +98,7 @@ export function randomString(length: number, charset = 'abcdefghijklmnopqrstuvwx
  */
 export function secureRandom(): number {
   const view = new Uint32Array(crypto.randomBytes(4));
-  return view[0] / 4294967296; // Divide by 2^32 (4294967296) to get a value between 0 and 1
+  return (view[0] ?? 0) / 4294967296; // Divide by 2^32 (4294967296) to get a value between 0 and 1
 }
 
 /**
@@ -151,7 +155,7 @@ export function uuidv7(): string {
     '7' +
     rand.slice(0, 3) + // 12 bits random
     '-' +
-    ((Number.parseInt(rand[3], 16) & 0x3) | 0x8).toString(16) +
+    ((Number.parseInt(rand.charAt(3), 16) & 0x3) | 0x8).toString(16) +
     rand.slice(4, 7) +
     '-' +
     rand.slice(7, 19); // remaining 62 bits random
diff --git a/tests/load/putRecords.ts b/tests/load/putRecords.ts
@@ -21,9 +21,9 @@ const DATA_FILE_PATH = __ENV.DATA_FILE_PATH ?? env.DATA_FILE_PATH;
 const MAX_RECORD_ID = +(__ENV.MAX_RECORD_ID ?? env.MAX_RECORD_ID ?? 50);
 const RECORD_PREFIX = 'k6-test-';
 const SYSTEM_ID = 'ITSM-5917';
-const TOKEN_ENDPOINT = __ENV.CLIENT_SECRET ?? env.TOKEN_ENDPOINT;
+const TOKEN_ENDPOINT = __ENV.TOKEN_ENDPOINT ?? env.TOKEN_ENDPOINT;
 
-const dataFile: readonly Record[] | undefined = (() => {
+const dataFile: readonly Record[] = (() => {
   if (DATA_FILE_PATH) {
     return new SharedArray<Record>('data', () =>
       open(DATA_FILE_PATH)
@@ -32,6 +32,7 @@ const dataFile: readonly Record[] | undefined = (() => {
         .map((line) => JSON.parse(line) as Record)
     );
   }
+  return [];
 })();
 
 export { options } from './helpers/index.ts';
@@ -41,6 +42,10 @@ export { options } from './helpers/index.ts';
  * @returns - Data created in setup to be used by VU execution
  */
 export function setup() {
+  if (!CLIENT_ID || !CLIENT_SECRET || !TOKEN_ENDPOINT) {
+    throw new Error('Missing required environment variables for authentication');
+  }
+
   const token = fetchBearerToken(CLIENT_ID, CLIENT_SECRET, TOKEN_ENDPOINT);
   console.log('Test setup complete'); // eslint-disable-line no-console
 
@@ -54,14 +59,14 @@ export function setup() {
  */
 export default function main(data: { token: string }) {
   let body: Record;
-  if (dataFile) {
+  if (dataFile.length > 0) {
     if (scenario.iterationInTest >= dataFile.length) {
       // eslint-disable-next-line no-console
       console.log(`Data exhausted at iteration ${scenario.iterationInTest}. Stopping test.`);
       test.abort();
       return;
     }
-    body = dataFile[scenario.iterationInTest];
+    body = dataFile[scenario.iterationInTest]!;
   } else {
     body = generateRecord(5917);
   }
diff --git a/tests/unit/docs/docs.test.ts b/tests/unit/docs/docs.test.ts
@@ -73,7 +73,7 @@ describe('getSpec', () => {
     const spec = getSpec();
     expect(readFileSync).toHaveBeenCalledWith('src/docs/openapi.yaml', 'utf8');
     expect(load).toHaveBeenCalledWith('yaml');
-    expect(spec.servers[0].url).toBe('/api/v1');
+    expect(spec.servers?.[0]?.url).toBe('/api/v1');
   });
 
   it('should update openIdConnectUrl if AUTH_ISSUER is set', () => {
diff --git a/tests/unit/repositories/base.test.ts b/tests/unit/repositories/base.test.ts
@@ -64,7 +64,14 @@ describe('BaseRepository', () => {
       expect(compiled.sql).toBe(
         'insert into "schema"."test_table" ("id", "foo", "bar") values ($1, $2, $3), ($4, $5, $6) returning *'
       );
-      expect(compiled.parameters).toEqual([data[0].id, data[0].foo, data[0].bar, data[1].id, data[1].foo, data[1].bar]);
+      expect(compiled.parameters).toEqual([
+        data[0]?.id,
+        data[0]?.foo,
+        data[0]?.bar,
+        data[1]?.id,
+        data[1]?.foo,
+        data[1]?.bar
+      ]);
     });
   });
 
@@ -267,7 +274,14 @@ describe('BaseRepository', () => {
           'values ($1, $2, $3), ($4, $5, $6) ' +
           'on conflict ("id") do nothing returning *'
       );
-      expect(compiled.parameters).toEqual([data[0].id, data[0].foo, data[0].bar, data[1].id, data[1].foo, data[1].bar]);
+      expect(compiled.parameters).toEqual([
+        data[0]?.id,
+        data[0]?.foo,
+        data[0]?.bar,
+        data[1]?.id,
+        data[1]?.foo,
+        data[1]?.bar
+      ]);
     });
 
     it('should build an insert query with a default named constraint for the multiple entities', () => {
@@ -291,7 +305,14 @@ describe('BaseRepository', () => {
           'values ($1, $2, $3), ($4, $5, $6) ' +
           'on conflict on constraint "first_constraint" do nothing returning *'
       );
-      expect(compiled.parameters).toEqual([data[0].id, data[0].foo, data[0].bar, data[1].id, data[1].foo, data[1].bar]);
+      expect(compiled.parameters).toEqual([
+        data[0]?.id,
+        data[0]?.foo,
+        data[0]?.bar,
+        data[1]?.id,
+        data[1]?.foo,
+        data[1]?.bar
+      ]);
     });
 
     it('should build an insert query with a specified constraint for the multiple entities', () => {
@@ -315,7 +336,14 @@ describe('BaseRepository', () => {
           'values ($1, $2, $3), ($4, $5, $6) ' +
           'on conflict on constraint "second_constraint" do nothing returning *'
       );
-      expect(compiled.parameters).toEqual([data[0].id, data[0].foo, data[0].bar, data[1].id, data[1].foo, data[1].bar]);
+      expect(compiled.parameters).toEqual([
+        data[0]?.id,
+        data[0]?.foo,
+        data[0]?.bar,
+        data[1]?.id,
+        data[1]?.foo,
+        data[1]?.bar
+      ]);
     });
   });
 });
diff --git a/tests/unit/routes/docs.test.ts b/tests/unit/routes/docs.test.ts
@@ -48,15 +48,15 @@ describe('Docs Router', () => {
 
       expect(helmet.contentSecurityPolicy).toHaveBeenCalled();
 
-      const config = vi.mocked(helmet.contentSecurityPolicy).mock.calls[0][0];
+      const config = vi.mocked(helmet.contentSecurityPolicy).mock.calls[0]?.[0] ?? {};
       const { 'img-src': imgSrc, 'media-src': mediaSrc } = config?.directives as Record<string, unknown[]>;
       const mockRes = { locals: { cspNonce: 'test-nonce' } } as unknown as express.Response;
 
-      const imgNonceFn = imgSrc.find((fn: unknown) => typeof fn === 'function') as (
+      const imgNonceFn = imgSrc?.find((fn: unknown) => typeof fn === 'function') as (
         req: unknown,
         res: express.Response
       ) => string;
-      const mediaNonceFn = mediaSrc.find((fn: unknown) => typeof fn === 'function') as (
+      const mediaNonceFn = mediaSrc?.find((fn: unknown) => typeof fn === 'function') as (
         req: unknown,
         res: express.Response
       ) => string;
diff --git a/tests/unit/services/helpers/lruCache.test.ts b/tests/unit/services/helpers/lruCache.test.ts
diff --git a/tests/unit/services/helpers/repo.test.ts b/tests/unit/services/helpers/repo.test.ts
diff --git a/tests/unit/services/record.test.ts b/tests/unit/services/record.test.ts
diff --git a/tests/unit/utils/coding.test.ts b/tests/unit/utils/coding.test.ts
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ export function getBearerToken(req: Request): string \| undefined \| null {`
`25`	`25`	`const [scheme, token] = parts;`
`26`	`26`	`if (parts.length !== 2 \|\| scheme !== 'Bearer') return null;`
`27`	`27`
`28`		`- return /^[A-Za-z0-9\-._~+/]+=*$/.test(token) ? token : null; // RFC 6750 Section 2.1`
	`28`	`+ return token && /^[A-Za-z0-9\-._~+/]+=*$/.test(token) ? token : null; // RFC 6750 Section 2.1`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ export const findSingleSystemRecordService = async (`
`49`	`49`	`);`
`50`	`50`	`}`
`51`	`51`
`52`		`- return systemRecords[0];`
	`52`	`+ return systemRecords[0] as Selectable<PiesSystemRecord>;`
`53`	`53`	`},`
`54`	`54`	`{ accessMode: 'read only' }`
`55`	`55`	`);`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ export default class Problem extends Error {`
`80`	`80`	* Converts the `Problem` instance to a string representation.
`81`	`81`	* @returns A string in the format `[status] title (type)`.
`82`	`82`	`*/`
`83`		`- toString() {`
	`83`	`+ override toString() {`
`84`	`84`	return `[${this.status}] ${this.title} (${this.type})`;
`85`	`85`	`}`
`86`	`86`