🗃️ Define planVersion model

Author: Pl217

src/db/index.ts

@@ -22,6 +22,7 @@ import project from './models/project';
 import plan from './models/plan';
 import planEntity from './models/planEntity';
 import planEntityVersion from './models/planEntityVersion';
+import planVersion from './models/planVersion';
 import projectVersion from './models/projectVersion';
 import projectVersionAttachment from './models/projectVersionAttachment';
 import projectVersionPlan from './models/projectVersionPlan';
@@ -52,6 +53,7 @@ export default (conn: Knex) => ({
   plan: plan(conn),
   planEntity: planEntity(conn),
   planEntityVersion: planEntityVersion(conn),
+  planVersion: planVersion(conn),
   project: project(conn),
   projectVersion: projectVersion(conn),
   projectVersionAttachment: projectVersionAttachment(conn),

src/db/models/planVersion.ts

@@ -2,6 +2,10 @@ import * as t from 'io-ts';
 
 import { brandedType } from '../../util/io-ts';
 import type { Brand } from '../../util/types';
+import { DATE } from '../util/datatypes';
+import { defineLegacyVersionedModel } from '../util/legacy-versioned-model';
+import { PLAN_ID } from './plan';
+import { PLAN_REPORTING_PERIOD_ID } from './planReportingPeriod';
 
 export type PlanVersionId = Brand<
   number,
@@ -10,3 +14,43 @@ export type PlanVersionId = Brand<
 >;
 
 export const PLAN_VERSION_ID = brandedType<number, PlanVersionId>(t.number);
+
+const PLAN_VERSION_CLUSTER_SELECTION_TYPE = {
+  single: null,
+  multi: null,
+};
+
+export default defineLegacyVersionedModel({
+  tableName: 'planVersion',
+  fields: {
+    generated: {
+      id: { kind: 'branded-integer', brand: PLAN_VERSION_ID },
+    },
+    nonNullWithDefault: {
+      isForHPCProjects: { kind: 'checked', type: t.boolean },
+    },
+    accidentallyOptional: {
+      planId: { kind: 'branded-integer', brand: PLAN_ID },
+      name: { kind: 'checked', type: t.string },
+      startDate: { kind: 'checked', type: DATE },
+      endDate: { kind: 'checked', type: DATE },
+    },
+    optional: {
+      comments: { kind: 'checked', type: t.string },
+      code: { kind: 'checked', type: t.string },
+      customLocationCode: { kind: 'checked', type: t.string },
+      currentReportingPeriodId: {
+        kind: 'branded-integer',
+        brand: PLAN_REPORTING_PERIOD_ID,
+      },
+      lastPublishedReportingPeriodId: { kind: 'checked', type: t.number },
+      // Even though this column isn't defined using DB enum only two values are used
+      clusterSelectionType: {
+        kind: 'enum',
+        values: PLAN_VERSION_CLUSTER_SELECTION_TYPE,
+      },
+    },
+  },
+  idField: 'id',
+  softDeletionEnabled: false,
+});