🗃️ Define usageYear model

Author: Pl217

src/db/index.ts

@@ -29,6 +29,7 @@ import projectVersionAttachment from './models/projectVersionAttachment';
 import projectVersionPlan from './models/projectVersionPlan';
 import reportingWindow from './models/reportingWindow';
 import reportingWindowAssignment from './models/reportingWindowAssignment';
+import usageYear from './models/usageYear';
 import workflowStatusOption from './models/workflowStatusOption';
 
 export default (conn: Knex) => ({
@@ -62,5 +63,6 @@ export default (conn: Knex) => ({
   projectVersionPlan: projectVersionPlan(conn),
   reportingWindow: reportingWindow(conn),
   reportingWindowAssignment: reportingWindowAssignment(conn),
+  usageYear: usageYear(conn),
   workflowStatusOption: workflowStatusOption(conn),
 });

src/db/models/usageYear.ts

@@ -2,6 +2,7 @@ import * as t from 'io-ts';
 
 import { brandedType } from '../../util/io-ts';
 import type { Brand } from '../../util/types';
+import { defineIDModel } from '../util/id-model';
 
 export type UsageYearId = Brand<
   number,
@@ -10,3 +11,17 @@ export type UsageYearId = Brand<
 >;
 
 export const USAGE_YEAR_ID = brandedType<number, UsageYearId>(t.number);
+
+export default defineIDModel({
+  tableName: 'usageYear',
+  fields: {
+    generated: {
+      id: { kind: 'branded-integer', brand: USAGE_YEAR_ID },
+    },
+    required: {
+      year: { kind: 'checked', type: t.string },
+    },
+  },
+  idField: 'id',
+  softDeletionEnabled: false,
+});