🗃️ Define location model

Author: Pl217

src/db/index.ts

@@ -14,6 +14,7 @@ import expiredData from './models/expiredData';
 import form from './models/form';
 import governingEntity from './models/governingEntity';
 import governingEntityVersion from './models/governingEntityVersion';
+import location from './models/location';
 import operation from './models/operation';
 import operationCluster from './models/operationCluster';
 import participant from './models/participant';
@@ -44,6 +45,7 @@ export default (conn: Knex) => ({
   form: form(conn),
   governingEntity: governingEntity(conn),
   governingEntityVersion: governingEntityVersion(conn),
+  location: location(conn),
   operation: operation(conn),
   operationCluster: operationCluster(conn),
   participant: participant(conn),

src/db/models/location.ts

@@ -2,7 +2,44 @@ 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 LocationId = Brand<number, { readonly s: unique symbol }, 'job.id'>;
 
 export const LOCATION_ID = brandedType<number, LocationId>(t.number);
+
+const LOCATION_STATUS = {
+  active: null,
+  expired: null,
+};
+
+export default defineIDModel({
+  tableName: 'location',
+  fields: {
+    generated: {
+      id: { kind: 'branded-integer', brand: LOCATION_ID },
+    },
+    optional: {
+      externalId: { kind: 'checked', type: t.string },
+      name: { kind: 'checked', type: t.string },
+      latitude: { kind: 'checked', type: t.number },
+      longitude: { kind: 'checked', type: t.number },
+      iso3: { kind: 'checked', type: t.string },
+      pcode: { kind: 'checked', type: t.string },
+      // Even though this column is defined as int8, it is
+      // fetched as a string by knex, since it is bigint
+      validOn: { kind: 'checked', type: t.string },
+      parentId: { kind: 'branded-integer', brand: LOCATION_ID },
+    },
+    accidentallyOptional: {
+      adminLevel: { kind: 'checked', type: t.number },
+      status: {
+        kind: 'enum',
+        values: LOCATION_STATUS,
+      },
+      itosSync: { kind: 'checked', type: t.boolean },
+    },
+  },
+  idField: 'id',
+  softDeletionEnabled: false,
+});