feat(lint): add linting and type checking scripts; update package.json and config files

Author: m-houston

AGENTS.md

@@ -8,9 +8,13 @@ This is a monorepo containing:
 
 - **packages/events** - Event schemas and domain models using Zod
 - **packages/event-builder** - CloudEvent builders for domain objects
+- **packages/file-store** - Loads on-disk config stores and validates records against the Zod schemas
+- **packages/ddb-publisher** - CLI and release bundle for auditing and publishing config-store records into DynamoDB
 - **lambdas/** - Lambda function implementations
 - **infrastructure/** - Terraform infrastructure as code
 - **docs/** - Documentation site
+- **actions/ddb-publish** - Composite GitHub Action wrapper around the bundled DynamoDB publisher
+- **tests/example-config-store** - Minimal end-to-end config-store fixture used by CLI and integration tests
 
 ## Event Builder Package
 
@@ -46,6 +50,8 @@ The event-builder package provides functions to build CloudEvents from domain ob
 
 All functions accept domain objects and a starting counter, returning an array of CloudEvents.
 
+The package also exports single-record builders (`buildLetterVariantEvent()`, `buildPackSpecificationEvent()`, `buildSupplierEvent()`, `buildVolumeGroupEvent()`, `buildSupplierAllocationEvent()`, `buildSupplierPackEvent()`), plus `configFromEnv()`, `buildEventSource()`, and `buildBaseEventEnvelope()` from `packages/event-builder/src/index.ts`.
+
 ### Testing
 
 ```bash
@@ -94,8 +100,25 @@ const description = $Postage.shape.deliveryDays.meta()?.description;
 
 1. Update domain schema in `packages/events/src/domain/`
 2. Update event builder if needed in `packages/event-builder/src/`
-3. Update test files in `__tests__/` directories
-4. Run tests: `npm test`
+3. If the persisted JSON shape or entity folders change, update `packages/file-store/src/`, `packages/ddb-publisher/src/`, and sample records in `tests/example-config-store/`
+4. Update test files in `packages/events/src/**/__tests__/`, `packages/event-builder/src/__tests__/`, `packages/file-store/src/__tests__/`, and `packages/ddb-publisher/src/__tests__/` / `src/__integration__/` as needed
+5. Regenerate schema artefacts from `packages/events` when required: `npm run gen:jsonschema`, `npm run gen:asyncapi`, `npm run gen:erd`
+6. Run tests: `npm run test:unit`
+
+### Working with the Config Store and DDB Publisher
+
+1. Persisted entity directories are fixed to: `volume-group`, `letter-variant`, `pack-specification`, `supplier`, `supplier-allocation`, `supplier-pack`
+2. Use `loadConfigStore()` from `packages/file-store/src/loader/config-store-loader.ts` to read JSON records and `validateConfigStore()` from `packages/file-store/src/validation/config-store-validator.ts` to collect schema issues
+3. Record filenames matter: `supplier/sup-1.json` must contain `"id": "sup-1"`, or validation fails
+4. For local validation without AWS calls, run:
+
+   ```bash
+   npm run cli --workspace @supplier-config/ddb-publisher -- \
+     --source tests/example-config-store \
+     --env draft \
+     --table supplier-config-draft \
+     --dry-run
+   ```
 
 ### Adding Metadata to Schema Fields
 
@@ -139,16 +162,29 @@ Common markdown rules to follow:
 # Install all dependencies
 npm install
 
-# Run tests for specific workspace
-npm test --workspace=packages/events
-npm test --workspace=packages/event-builder
+# Run unit tests for all workspaces
+npm run test:unit
+
+# Run tests for specific workspaces
+npm run test:unit --workspace @nhsdigital/nhs-notify-event-schemas-supplier-config
+npm run test:unit --workspace @supplier-config/event-builder
+
+# Run integration tests for the DynamoDB publisher
+npm run test:integration --workspace @supplier-config/ddb-publisher
 
 # Build all packages
 npm run build --workspaces
 
 # Lint all code
 npm run lint
 
+# Type check all workspaces
+npm run typecheck
+
+# Check/fix dependency version drift across workspaces
+npm run deps:check
+npm run deps:sync
+
 # Check markdown formatting
 ./scripts/githooks/check-markdown-format.sh <file>
 
@@ -173,9 +209,17 @@ Check the error output for specific Zod validation failures. Common issues:
 - Wrong data types (string vs number)
 - Invalid date formats
 
+### Local DynamoDB and Testcontainers
+
+- `SUPPLIER_CONFIG_DDB_ENDPOINT_URL=http://localhost:8000` points `ddb-publisher` at DynamoDB Local; when the endpoint is localhost-based, the CLI supplies default fake AWS credentials if they are unset
+- `packages/ddb-publisher/src/__integration__/publish-action.integration.test.ts` uses Testcontainers; if Docker startup fails under Colima, retry with `TESTCONTAINERS_RYUK_DISABLED=true` or `TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE=/var/run/docker.sock`
+
 ## Agent Notes
 
 - The project uses Zod 4.x for schema validation
 - Metadata is stored in Zod's global registry via `.meta()`
 - Test files should be updated whenever domain models change
 - Always run markdown linter when editing `.md` files to catch formatting issues
+- `tests/example-config-store/` is the shared fixture for local CLI runs and `ddb-publisher` integration tests
+- Persisted entity directory names are enforced by `packages/file-store/src/types.ts` and `packages/file-store/src/loader/config-store-loader.ts`
+- Root automation entry points are `npm run test:unit`, `npm run test:integration`, and `npm run typecheck`

eslint.config.mjs

@@ -20,23 +20,14 @@ import {
 } from 'eslint-config-airbnb-extended';
 import { rules as prettierConfigRules } from 'eslint-config-prettier';
 
-import { dirname } from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { FlatCompat } from '@eslint/eslintrc';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-const compat = new FlatCompat({
-  baseDirectory: __dirname,
-});
 
 export default defineConfig([
   globalIgnores([
     '**/*/coverage/*',
     '**/.build',
     '**/node_modules',
     '**/dist',
+    '**/artifacts/**',
     '**/test-results',
     '**/playwright-report*',
     'eslint.config.mjs',
@@ -61,7 +52,17 @@ export default defineConfig([
     ignores: ['**/*.json'],
     languageOptions: {
       parserOptions: {
-        projectService: true,
+        projectService: {
+          allowDefaultProject: [
+            '*.js',
+            '*.mjs',
+            '*.ts',
+            'packages/*/jest*.config.ts',
+            'packages/*/scripts/*.{js,mjs,ts}',
+            'scripts/*.{js,mjs,ts}',
+            'scripts/*/*.{js,mjs,ts}',
+          ],
+        },
         tsconfigRootDir: import.meta.dirname,
       },
     },
@@ -72,6 +73,11 @@ export default defineConfig([
     extends: [tseslint.configs.disableTypeChecked],
   },
 
+  {
+    files: ['**/*.config.ts', '**/jest*.config.ts'],
+    extends: [tseslint.configs.disableTypeChecked],
+  },
+
   {
     settings: {
       'import-x/resolver-next': [
@@ -196,6 +202,7 @@ export default defineConfig([
         },
       ],
       'import-x/extensions': 0,
+      'unicorn/no-array-callback-reference': 0,
     },
   },
   {
@@ -205,14 +212,21 @@ export default defineConfig([
     },
   },
   {
-    files: ['**/__tests__/**'],
+    files: [
+      '**/__tests__/**',
+      '**/__integration__/**',
+      'tests/**',
+      '**/*.{test,spec}.{js,jsx,ts,tsx,mjs,cjs}',
+    ],
     rules: {
       'import-x/no-extraneous-dependencies': [
         2,
         {
           devDependencies: true,
         },
       ],
+      'security/detect-non-literal-fs-filename': 0,
+      'sonarjs/publicly-writable-directories': 0,
     },
   },
   {
@@ -230,23 +244,33 @@ export default defineConfig([
     },
   },
   {
-    files: ['scripts/**'],
+    files: [
+      'scripts/**',
+      'packages/*/scripts/*.{js,mjs,ts}',
+    ],
+    extends: [tseslint.configs.disableTypeChecked],
     rules: {
       'import-x/no-extraneous-dependencies': [
         'error',
         { devDependencies: true },
       ],
+      'no-console': 0,
+      'security/detect-non-literal-fs-filename': 0,
     },
   },
   // Add CLI directory override to allow console usage
   {
-    files: ['**/cli/**/*.{js,jsx,ts,tsx,mjs,cjs}'],
+    files: [
+      '**/cli.{js,jsx,ts,tsx,mjs,cjs}',
+      '**/cli/**/*.{js,jsx,ts,tsx,mjs,cjs}',
+    ],
     rules: {
       'no-console': 0,
       'import-x/no-extraneous-dependencies': [
         'error',
         { devDependencies: true },
       ],
+      'security/detect-non-literal-fs-filename': 0,
     },
   },
   // misc rule overrides
@@ -256,6 +280,7 @@ export default defineConfig([
       'no-underscore-dangle': 0,
       'no-await-in-loop': 0,
       'no-plusplus': [2, { allowForLoopAfterthoughts: true }],
+      'import-x/prefer-default-export': 0,
       'unicorn/prefer-top-level-await': 0, // top level await is not available in commonjs
     },
   },