@dvsa/cvs-db-schemas 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Driver & Vehicle Standards Agency
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,212 @@
+# cvs-microservice-common
+
+Common code used by the various serverless microservices within the Commercial Vehicle Services (CVS) system, published as a GitHub package.
+
+### Pre-requisites
+
+- Node.js (Please see `.nvmrc` for specific version)
+- `npm` (If using [n](https://github.com/tj/n) or [nvm](https://github.com/nvm-sh/nvm), this will be automatically managed)
+- Security
+  - [Git secrets](https://github.com/awslabs/git-secrets)
+  - [ScanRepo](https://github.com/UKHomeOffice/repo-security-scanner)
+    - Unzip `repo-security-scanner_<version>_Darwin_<architercture>.tar.gz` and rename the executable inside the folder
+      to `scanrepo` - Add executable to path (using `echo $PATH` to find your path)
+
+### Getting started
+
+###### Run the following command after cloning the project
+
+1. `npm install` (or `npm i`)
+
+###### The code that will be published lives inside the ./src directory.
+
+If wishing to add new top level directories to the output, then they must be included in the `files` array inside `package.json` as well as included in the `clean:temp` command.
+
+### Publishing
+
+In order to see the output of what will be published, run the following command:
+
+```shell
+npm publish --dry-run
+```
+
+There are two ways in which this package can/should be published:
+
+###### Requires manual version bump via the PR
+
+- Upon merge into `main` branch, the package will be published via a GHA workflow.
+
+# Contents
+
+## EnvironmentVariables
+
+### Overview
+`EnvironmentVariables` is a utility class for managing environment variables in a structured way. It ensures that required environment variables are present and provides default values when necessary.
+
+### Usage
+
+#### Importing the `EnvironmentVariables` Class
+```ts
+import { EnvironmentVariables } from '@dvsa/cvs-microservice-common';
+```
+
+#### Retrieving a Required Environment Variable
+Use the `get` method to retrieve an environment variable. If the variable is missing, an error is thrown.
+
+```ts
+const apiKey = EnvironmentVariables.get("API_KEY");
+console.log("API Key:", apiKey);
+```
+
+##### Example with Missing Variable
+If `API_KEY` is not set in the environment, the following error will be thrown:
+```sh
+Error: Configuration item API_KEY was not provided with a value
+```
+
+#### Using a Default Value When a Variable is Absent
+If an environment variable may be missing, you can use `defaultIfNotPresent` to provide a fallback value.
+
+```ts
+const logLevel = EnvironmentVariables.defaultIfNotPresent(process.env.LOG_LEVEL, "info");
+console.log("Log Level:", logLevel);
+```
+
+#### Ensuring an Environment Variable is Set Before Proceeding
+Use `throwIfNotPresent` when checking a variable's existence but wanting an explicit error if it's missing.
+
+```ts
+const dbHost = EnvironmentVariables.throwIfNotPresent(process.env.DB_HOST, "DB_HOST");
+console.log("Database Host:", dbHost);
+```
+
+### Error Handling
+- If `get` or `throwIfNotPresent` is used on an unset variable, an error is thrown.
+- `defaultIfNotPresent` prevents errors by returning a default value when the variable is missing.
+
+### Example `.env` File
+```sh
+API_KEY=my-secret-api-key
+DB_HOST=database.example.com
+LOG_LEVEL=debug
+```
+## Custom Routing Decorators
+
+### Overview
+This module provides custom decorators (`GET`, `POST`, and `PUT`) for `routing-controllers`, allowing API routes to be automatically prefixed with a branch name when the `BRANCH` environment variable is set.
+
+### Installation
+Ensure you have `routing-controllers` installed in your project:
+
+```sh
+npm install routing-controllers
+```
+
+### Usage
+
+#### Importing the Custom Route Decorators
+```ts
+import { GET, POST, PUT } from '@dvsa/cvs-microservice-common/api/routing-decorators';
+```
+
+#### Defining API Endpoints with Branch-Aware Routing
+These decorators extend `routing-controllers`' `@Get`, `@Post`, and `@Put` decorators by applying both the original route and a prefixed route (if `BRANCH` is set).
+
+```ts
+import { JsonController } from "routing-controllers";
+import { GET, POST, PUT } from "@dvsa/cvs-microservice-common/api/routing-decorators";
+
+@JsonController("/users")
+export class UserController {
+  @GET("/")
+  getUsers() {
+    return { message: "List of users" };
+  }
+
+  @POST("/")
+  createUser() {
+    return { message: "User created" };
+  }
+
+  @PUT("/:id")
+  updateUser() {
+    return { message: "User updated" };
+  }
+}
+```
+
+#### Effect of `BRANCH` Environment Variable
+If `BRANCH=feature-x`, the above routes will be accessible at:
+
+- `GET /users/` → List users
+- `GET /feature-x/users/` → List users (branch-prefixed)
+- `POST /users/` → Create a user
+- `POST /feature-x/users/` → Create a user (branch-prefixed)
+- `PUT /users/:id` → Update a user
+- `PUT /feature-x/users/:id` → Update a user (branch-prefixed)
+
+#### Setting the `BRANCH` Environment Variable
+To enable branch-prefixed routes, set the `BRANCH` environment variable:
+
+```sh
+export BRANCH=feature-x
+```
+
+### Benefits
+- **Supports Feature Branching**: Easily test feature-specific API versions.
+- **Automatic Routing Prefixing**: No need to manually adjust routes for different environments.
+- **Seamless Integration**: Works with `routing-controllers` decorators.
+
+## HttpStatus
+
+### Overview
+`HttpStatus` is an enumeration representing common HTTP status codes. It provides a readable and maintainable way to reference standard HTTP response codes in your application.
+
+### Usage
+
+#### Importing the `HttpStatus` Enum
+```ts
+import { HttpStatus } from '@domain/enums/HttpStatus.enum';
+```
+
+#### Using HTTP Status Codes in API Responses
+The `HttpStatus` enum can be used to improve readability and maintainability in HTTP responses.
+
+##### Example Usage in an Express API
+```ts
+import express from "express";
+import { HttpStatus } from "@domain/enums/HttpStatus.enum";
+
+const app = express();
+
+app.get("/status", (req, res) => {
+  res.status(HttpStatus.OK).json({ message: "Success" });
+});
+
+app.use((req, res) => {
+  res.status(HttpStatus.NOT_FOUND).json({ error: "Not Found" });
+});
+
+app.listen(3000, () => console.log("Server running on port 3000"));
+```
+
+#### Common Status Codes
+| Status Code | Enum Value                 | Description                        |
+|------------|--------------------------|--------------------------------|
+| 200        | `HttpStatus.OK`           | Request was successful         |
+| 201        | `HttpStatus.CREATED`      | Resource was successfully created |
+| 202        | `HttpStatus.ACCEPTED`     | Request has been accepted but not processed yet |
+| 204        | `HttpStatus.NO_CONTENT`   | Request was successful but no content returned |
+| 400        | `HttpStatus.BAD_REQUEST`  | Client error - invalid request |
+| 401        | `HttpStatus.UNAUTHORIZED` | Authentication required         |
+| 403        | `HttpStatus.FORBIDDEN`    | Insufficient permissions        |
+| 404        | `HttpStatus.NOT_FOUND`    | Resource not found              |
+| 500        | `HttpStatus.INTERNAL_SERVER_ERROR` | Server error |
+| 502        | `HttpStatus.BAD_GATEWAY`  | Invalid response from upstream server |
+| 504        | `HttpStatus.GATEWAY_TIMEOUT` | Upstream server timeout |
+
+### Benefits of Using `HttpStatus`
+- **Improved Readability**: Instead of using magic numbers, named constants make code clearer.
+- **Better Maintainability**: Centralized status codes make updates easier.
+- **Reduced Errors**: Avoid mistyping HTTP status codes.
+

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from './misc/outbox';
+export * from './test-facility/activity';
+export * from './test-facility/test-station';

package/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./misc/outbox"), exports);
+__exportStar(require("./test-facility/activity"), exports);
+__exportStar(require("./test-facility/test-station"), exports);

package/misc/outbox.d.ts

@@ -0,0 +1,160 @@
+export declare const outbox: import("drizzle-orm/mysql-core").MySqlTableWithColumns<{
+    name: "outbox";
+    schema: "test_facility";
+    columns: {
+        id: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "id";
+            tableName: "outbox";
+            dataType: "number";
+            columnType: "MySqlBigInt53";
+            data: number;
+            driverParam: string | number;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: true;
+            isAutoincrement: true;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        eventType: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "event_type";
+            tableName: "outbox";
+            dataType: "string";
+            columnType: "MySqlEnumColumn";
+            data: "created" | "updated" | "deleted";
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: ["created", "updated", "deleted"];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        aggregateType: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "aggregate_type";
+            tableName: "outbox";
+            dataType: "string";
+            columnType: "MySqlEnumColumn";
+            data: "activity" | "tech-record" | "test-result" | "test-station";
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: ["activity", "tech-record", "test-result", "test-station"];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        payload: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "payload";
+            tableName: "outbox";
+            dataType: "string";
+            columnType: "MySqlText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        status: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "status";
+            tableName: "outbox";
+            dataType: "string";
+            columnType: "MySqlEnumColumn";
+            data: "pending" | "completed" | "failed";
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: ["pending", "completed", "failed"];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        attemptCount: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "attempt_count";
+            tableName: "outbox";
+            dataType: "number";
+            columnType: "MySqlInt";
+            data: number;
+            driverParam: string | number;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        createdAt: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "created_at";
+            tableName: "outbox";
+            dataType: "string";
+            columnType: "MySqlDateTimeString";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        completedAt: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "completed_at";
+            tableName: "outbox";
+            dataType: "date";
+            columnType: "MySqlDateTime";
+            data: Date;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        errorMessage: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "error_message";
+            tableName: "outbox";
+            dataType: "string";
+            columnType: "MySqlText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+    };
+    dialect: "mysql";
+}>;

package/misc/outbox.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.outbox = void 0;
+const mysql_core_1 = require("drizzle-orm/mysql-core");
+const drizzle_orm_1 = require("drizzle-orm");
+exports.outbox = (0, mysql_core_1.mysqlSchema)('test_facility').table('outbox', {
+    id: (0, mysql_core_1.bigint)({ mode: 'number', unsigned: true }).autoincrement().primaryKey(),
+    eventType: (0, mysql_core_1.mysqlEnum)('event_type', ['created', 'updated', 'deleted']).notNull(),
+    aggregateType: (0, mysql_core_1.mysqlEnum)('aggregate_type', ['activity', 'tech-record', 'test-result', 'test-station']).notNull(),
+    payload: (0, mysql_core_1.text)('payload').notNull(),
+    status: (0, mysql_core_1.mysqlEnum)('status', ['pending', 'completed', 'failed']).notNull().default('pending'),
+    attemptCount: (0, mysql_core_1.int)('attempt_count').notNull().default(0),
+    createdAt: (0, mysql_core_1.datetime)('created_at', { mode: 'string', fsp: 3 }).default((0, drizzle_orm_1.sql) `(CURRENT_TIMESTAMP(3))`),
+    completedAt: (0, mysql_core_1.datetime)('completed_at'),
+    errorMessage: (0, mysql_core_1.text)('error_message'),
+}, (table) => [
+    (0, mysql_core_1.unique)('uq_outbox_aggregate_id_event').on(table.aggregateType, table.id, table.eventType),
+    (0, mysql_core_1.index)('idx_outbox_status_created_at').on(table.status, table.createdAt),
+    (0, mysql_core_1.index)('idx_outbox_event_type').on(table.eventType),
+    (0, mysql_core_1.index)('idx_outbox_aggregate_type').on(table.aggregateType),
+    (0, mysql_core_1.primaryKey)({ columns: [table.id], name: 'outbox_id' }),
+]);

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@dvsa/cvs-db-schemas",
+  "version": "0.0.0",
+  "description": "CVS Drizzle Schema Common Package",
+  "author": "DVSA",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dvsa/appdev-packages.git",
+    "directory": "packages/cvs-db-schemas"
+  },
+  "keywords": [
+    "typescript",
+    "nodejs"
+  ],
+  "publishConfig": {
+    "directory": "dist",
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "rimraf coverage dist",
+    "clean:temp": "rimraf auth api",
+    "lint": "biome check src",
+    "lint:fix": "npm run lint -- --write",
+    "build": "npm run clean && tsc",
+    "build:package": "npm run build",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "prepublishOnly": "npm run build:package && cp -r ./dist/* . && rm -rf ./dist",
+    "postpublish": "git clean -fd && npm run clean:temp",
+    "gitSecrets": "git secrets --scan . && git log -p -- . | scanrepo"
+  },
+  "peerDependencies": {
+    "drizzle-orm": "^0.45.1"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.1.3",
+    "@dvsa/biome-config": "1.0.0",
+    "@types/aws-lambda": "^8.10.160",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.19.7",
+    "husky": "^9.1.7",
+    "jest": "^30.2.0",
+    "lint-staged": "^15.2.10",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.2"
+  },
+  "lint-staged": {
+    "*.{js,ts,mjs,css,md,ts,json}": "npm run lint:fix -- --no-errors-on-unmatched"
+  }
+}

package/test-facility/activity.d.ts

@@ -0,0 +1,330 @@
+export declare const activity: import("drizzle-orm/mysql-core").MySqlTableWithColumns<{
+    name: "activity";
+    schema: "test_facility";
+    columns: {
+        id: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "id";
+            tableName: "activity";
+            dataType: "number";
+            columnType: "MySqlBigInt53";
+            data: number;
+            driverParam: string | number;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: true;
+            isAutoincrement: true;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        activityUuid: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "activity_uuid";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        testerStaffId: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "tester_staff_id";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        testerStaffName: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "tester_staff_name";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        testerStaffEmail: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "tester_staff_email";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        testStationId: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "test_station_id";
+            tableName: "activity";
+            dataType: "number";
+            columnType: "MySqlBigInt53";
+            data: number;
+            driverParam: string | number;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        parentActivityId: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "parent_activity_id";
+            tableName: "activity";
+            dataType: "number";
+            columnType: "MySqlBigInt53";
+            data: number;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        activityType: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "activity_type";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        startDatetime: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "start_datetime";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlDateTimeString";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        endDatetime: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "end_datetime";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlDateTimeString";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        waitReason: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "wait_reason";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        notes: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "notes";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        closureReason: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "closure_reason";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        createdById: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "created_by_id";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        createdByName: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "created_by_name";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        insertedDatetime: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "inserted_datetime";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlDateTimeString";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        lastUpdatedById: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "last_updated_by_id";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        lastUpdatedByName: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "last_updated_by_name";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        lastUpdatedDatetime: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "last_updated_datetime";
+            tableName: "activity";
+            dataType: "string";
+            columnType: "MySqlDateTimeString";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+    };
+    dialect: "mysql";
+}>;

package/test-facility/activity.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.activity = void 0;
+const drizzle_orm_1 = require("drizzle-orm");
+const mysql_core_1 = require("drizzle-orm/mysql-core");
+exports.activity = (0, mysql_core_1.mysqlSchema)('test_facility').table('activity', {
+    id: (0, mysql_core_1.bigint)({ mode: 'number', unsigned: true }).autoincrement().primaryKey(),
+    activityUuid: (0, mysql_core_1.varchar)('activity_uuid', { length: 36 }),
+    testerStaffId: (0, mysql_core_1.varchar)('tester_staff_id', { length: 40 }),
+    testerStaffName: (0, mysql_core_1.varchar)('tester_staff_name', { length: 100 }),
+    testerStaffEmail: (0, mysql_core_1.varchar)('tester_staff_email', { length: 200 }),
+    testStationId: (0, mysql_core_1.bigint)('test_station_id', { mode: 'number', unsigned: true }).notNull(),
+    parentActivityId: (0, mysql_core_1.bigint)('parent_activity_id', { mode: 'number', unsigned: true }),
+    activityType: (0, mysql_core_1.varchar)('activity_type', { length: 50 }),
+    startDatetime: (0, mysql_core_1.datetime)('start_datetime', { mode: 'string', fsp: 3 }),
+    endDatetime: (0, mysql_core_1.datetime)('end_datetime', { mode: 'string', fsp: 3 }),
+    waitReason: (0, mysql_core_1.varchar)('wait_reason', { length: 150 }),
+    notes: (0, mysql_core_1.varchar)({ length: 500 }),
+    closureReason: (0, mysql_core_1.varchar)('closure_reason', { length: 20 }),
+    createdById: (0, mysql_core_1.varchar)('created_by_id', { length: 40 }),
+    createdByName: (0, mysql_core_1.varchar)('created_by_name', { length: 200 }),
+    insertedDatetime: (0, mysql_core_1.datetime)('inserted_datetime', { mode: 'string', fsp: 3 }).default((0, drizzle_orm_1.sql) `(CURRENT_TIMESTAMP(3))`),
+    lastUpdatedById: (0, mysql_core_1.varchar)('last_updated_by_id', { length: 40 }),
+    lastUpdatedByName: (0, mysql_core_1.varchar)('last_updated_by_name', { length: 200 }),
+    lastUpdatedDatetime: (0, mysql_core_1.datetime)('last_updated_datetime', { mode: 'string', fsp: 3 }).default((0, drizzle_orm_1.sql) `(CURRENT_TIMESTAMP(3))`),
+}, (table) => [
+    (0, mysql_core_1.index)('idx_test_station_id').on(table.testStationId),
+    (0, mysql_core_1.index)('idx_tester_staff_id').on(table.testerStaffId),
+    (0, mysql_core_1.index)('idx_activity_type').on(table.activityType),
+    (0, mysql_core_1.foreignKey)({
+        columns: [table.parentActivityId],
+        foreignColumns: [table.id],
+        name: 'fk_parent_activity_id',
+    }),
+    (0, mysql_core_1.primaryKey)({ columns: [table.id], name: 'activity_id' }),
+    (0, mysql_core_1.unique)('idx_activity_uuid_uq').on(table.activityUuid),
+]);

package/test-facility/test-station.d.ts

@@ -0,0 +1,279 @@
+export declare const testStation: import("drizzle-orm/mysql-core").MySqlTableWithColumns<{
+    name: "test_station";
+    schema: "test_facility";
+    columns: {
+        id: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "id";
+            tableName: "test_station";
+            dataType: "number";
+            columnType: "MySqlBigInt53";
+            data: number;
+            driverParam: string | number;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: true;
+            isAutoincrement: true;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        dynamicsTestStationId: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "dynamics_test_station_id";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        accessNotes: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "access_notes";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        address: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "address";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        contactNumber: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "contact_number";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        country: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "country";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        emailAddressesJson: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "email_addresses_json";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        generalNotes: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "general_notes";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        latitude: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "latitude";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlDecimal";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        longitude: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "longitude";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlDecimal";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        name: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "name";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        pNumber: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "p_number";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        postcode: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "postcode";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        status: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "status";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        town: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "town";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        type: import("drizzle-orm/mysql-core").MySqlColumn<{
+            name: "type";
+            tableName: "test_station";
+            dataType: "string";
+            columnType: "MySqlVarChar";
+            data: string;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+    };
+    dialect: "mysql";
+}>;

package/test-facility/test-station.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testStation = void 0;
+const mysql_core_1 = require("drizzle-orm/mysql-core");
+exports.testStation = (0, mysql_core_1.mysqlSchema)('test_facility').table('test_station', {
+    id: (0, mysql_core_1.bigint)({ mode: 'number', unsigned: true }).autoincrement().primaryKey(),
+    dynamicsTestStationId: (0, mysql_core_1.varchar)('dynamics_test_station_id', { length: 36 }),
+    accessNotes: (0, mysql_core_1.text)('access_notes'),
+    address: (0, mysql_core_1.varchar)({ length: 100 }),
+    contactNumber: (0, mysql_core_1.varchar)('contact_number', { length: 30 }),
+    country: (0, mysql_core_1.varchar)({ length: 30 }),
+    emailAddressesJson: (0, mysql_core_1.varchar)('email_addresses_json', { length: 2000 }),
+    generalNotes: (0, mysql_core_1.text)('general_notes'),
+    latitude: (0, mysql_core_1.decimal)({ precision: 9, scale: 6 }),
+    longitude: (0, mysql_core_1.decimal)({ precision: 9, scale: 6 }),
+    name: (0, mysql_core_1.varchar)({ length: 160 }),
+    pNumber: (0, mysql_core_1.varchar)('p_number', { length: 256 }),
+    postcode: (0, mysql_core_1.varchar)({ length: 20 }),
+    status: (0, mysql_core_1.varchar)({ length: 10 }),
+    town: (0, mysql_core_1.varchar)({ length: 30 }),
+    type: (0, mysql_core_1.varchar)({ length: 4 }),
+}, (table) => [
+    (0, mysql_core_1.index)('idx_p_number_idx').on(table.pNumber),
+    (0, mysql_core_1.primaryKey)({ columns: [table.id], name: 'test_station_id' }),
+    (0, mysql_core_1.unique)('idx_dynamics_test_station_id_uq').on(table.dynamicsTestStationId),
+]);