@researchdatabox/redbox-dev-tools 0.0.1-beta.9950 → 5.0.0-RC1

package/templates/hook-archetype/standard/.gitignore.hbs

@@ -2,3 +2,4 @@ dist
 node_modules
 .tmp
 coverage
+support/development/.tmp

package/templates/hook-archetype/standard/.npmignore.hbs

@@ -1,3 +1,4 @@
 src
 test
-support
+support/*
+!support/prepare-minio.sh

package/templates/hook-archetype/standard/AGENTS.md.hbs

@@ -1,9 +1,18 @@
 # {{packageName}} Agent Guide
 
-This hook follows the standard ReDBox hook archetype generated by `@researchdatabox/redbox-dev-tools init`.
+This hook follows the richer ReDBox client hook archetype generated by `@researchdatabox/redbox-dev-tools init`.
 
 Keep these rules in place unless the user explicitly asks to change the hook model.
 
+## Project Shape
+
+- `src/index.ts` is the hook entry point and compiles to `dist/index.js`.
+- `src/config/` contains config returned from `registerRedboxConfig()`.
+- `src/form-config/` contains typed form definitions returned from `registerRedboxFormConfigs()`.
+- `src/migrations/` contains the synchronous hook migration registry.
+- `support/bootstrap-data/`, `assets/`, `views/`, and `language-defaults/` hold client material used by the Docker harness and hook runtime.
+- `support/development/` and `support/integration-testing/` contain the local portal and Mocha harnesses.
+
 ## Dependency Contract
 
 - `@researchdatabox/redbox-core` is the runtime compatibility anchor.
@@ -27,8 +36,16 @@ Use the existing scripts in `package.json`.
 
 Do not replace the custom `run-hook-tsc` or `run-hook-mocha` entrypoints with plain `tsc` or `mocha`.
 
+## Config And Migrations
+
+Prefer returning config from `registerRedboxConfig()` instead of mutating `sails.config` in `configure()`.
+
+Keep `registerRedboxMigrations()` synchronous. Add new migration modules to `src/migrations/index.ts`, and give each migration a unique hook-prefixed, sortable name such as `{{packageName}}:20260703T000000-seed-client-defaults`.
+
 ## Docker Runtime
 
 The docker compose files intentionally set `NODE_PATH` so a mounted hook can resolve host-provided runtime dependencies from the Redbox portal dependency tree.
 
 Do not remove that unless the runtime install model changes deliberately.
+
+For mounted-core development, update `support/development/core-mount.env` or pass `REDBOX_PORTAL_PATH` in the environment, then use `npm run dev:run:core`. Do not hand-edit the generated `support/development/.tmp/core-mount.env` file.

package/templates/hook-archetype/standard/Dockerfile.hbs

@@ -1,26 +1,27 @@
-ARG REDBOX_BASE_IMAGE=qcifengineering/redbox-portal:develop-pdfgen
+ARG REDBOX_PORTAL_IMAGE=qcifengineering/redbox-portal:develop-pdfgen
 
-FROM ${REDBOX_BASE_IMAGE} AS builder
+FROM ${REDBOX_PORTAL_IMAGE} AS builder
 
 USER root
 
-COPY {{packageName}} /opt/{{packageName}}
-COPY redbox-portal/packages/redbox-core /opt/redbox-portal/packages/redbox-core
-COPY redbox-portal/packages/sails-ng-common /opt/redbox-portal/packages/sails-ng-common
-COPY redbox-portal/packages/redbox-dev-tools /opt/redbox-portal/packages/redbox-dev-tools
+COPY . /opt/{{packageName}}
 
 RUN --mount=type=cache,target=/root/.npm \
   cd /opt/{{packageName}} \
-  && npm install --include=dev --ignore-scripts --legacy-peer-deps \
+  && npm install --include=dev --ignore-scripts --strict-peer-deps \
   && npm run compile \
+  && HOOK_TARBALL="$(npm pack --pack-destination /tmp --silent)" \
   && cd /opt/redbox-portal \
-  && npm install --legacy-peer-deps --ignore-scripts /opt/{{packageName}} \
-  && mkdir -p /opt/redbox-portal/views /opt/redbox-portal/assets /opt/redbox-portal/language-defaults \
+  && npm install --legacy-peer-deps --ignore-scripts "/tmp/${HOOK_TARBALL}" \
+  && rm -f "/tmp/${HOOK_TARBALL}" \
+  && mkdir -p /opt/redbox-portal/views /opt/redbox-portal/assets /opt/redbox-portal/.tmp/public /opt/redbox-portal/language-defaults /opt/redbox-portal/bootstrap-data \
   && if [ -d /opt/{{packageName}}/views ]; then cp -a /opt/{{packageName}}/views/. /opt/redbox-portal/views/; fi \
   && if [ -d /opt/{{packageName}}/assets ]; then cp -a /opt/{{packageName}}/assets/. /opt/redbox-portal/assets/; fi \
-  && if [ -d /opt/{{packageName}}/language-defaults ]; then cp -a /opt/{{packageName}}/language-defaults/. /opt/redbox-portal/language-defaults/; fi
+  && if [ -d /opt/{{packageName}}/assets ]; then cp -a /opt/{{packageName}}/assets/. /opt/redbox-portal/.tmp/public/; fi \
+  && if [ -d /opt/{{packageName}}/language-defaults ]; then cp -a /opt/{{packageName}}/language-defaults/. /opt/redbox-portal/language-defaults/; fi \
+  && if [ -d /opt/{{packageName}}/support/bootstrap-data ]; then cp -a /opt/{{packageName}}/support/bootstrap-data/. /opt/redbox-portal/bootstrap-data/; fi
 
-FROM ${REDBOX_BASE_IMAGE} AS {{packageName}}
+FROM ${REDBOX_PORTAL_IMAGE} AS {{packageName}}
 USER root
 
 COPY --from=builder --chown=node:node --chmod='u=rwx,g=rx,o=rx' /opt/redbox-portal /opt/redbox-portal

package/templates/hook-archetype/standard/README.md.hbs

@@ -1,13 +1,11 @@
 # {{packageName}}
 
-A generated ReDBox hook archetype.
+A generated ReDBox client hook archetype.
 
-This project keeps its dependency declarations intentionally small:
-
-- `@researchdatabox/redbox-core` is the ReDBox runtime compatibility contract
-- `@researchdatabox/redbox-dev-tools` provides the shared compile and unit-test toolchain
-- direct `dependencies` are reserved for hook-owned runtime libraries only
-- the generated package versions assume `redbox-core` and `redbox-dev-tools` are installed from npm, not from a sibling `redbox-portal` checkout
+This project is shaped for migrating v4 client customisation hooks to the
+current ReDBox hook contract. It includes TypeScript registrations for config,
+form configs, services, controllers, and migrations, plus Docker-backed
+development and Mocha integration harnesses.
 
 ## Development
 
@@ -19,21 +17,41 @@ npm run test:unit
 
 Local installs intentionally allow lifecycle scripts so native modules and other postinstall hooks can run. Use `npm install --ignore-scripts` only in controlled CI or container contexts where that trade-off is deliberate.
 
-For the docker-backed portal harness:
+For the image-backed portal harness:
 
 ```bash
 npm run dev:run:build
 npm run dev:run
 ```
 
-The development compose stack expects a locally trusted CA certificate at `support/development/certs/dev-ca.pem` and mounts it with `NODE_EXTRA_CA_CERTS`. Generate that certificate with your local CA tooling, for example `mkcert -CAROOT`, before starting the stack.
+To test against a local `redbox-portal` checkout, set `REDBOX_PORTAL_PATH` in
+`support/development/core-mount.env` and run:
+
+```bash
+npm run dev:run:core
+```
+
+The helper script resolves relative paths from this hook root, validates the
+portal checkout, installs missing dependencies, compiles the hook, compiles the
+portal server packages, and writes the resolved path to
+`support/development/.tmp/core-mount.env` for Docker Compose.
+
+## Dependency Contract
+
+- `@researchdatabox/redbox-core` is the runtime compatibility contract
+- `@researchdatabox/redbox-dev-tools` provides the shared compile and unit-test toolchain
+- direct `dependencies` are reserved for hook-owned runtime libraries only
+- shared packages such as `axios`, `rxjs`, `lodash`, `mocha`, `chai`, `ts-node`, and `typescript` should not be pinned directly here
 
 ## Structure
 
 - `src/index.ts`: hook entrypoint using `defineRedboxHook()`
 - `src/api/controllers`: hook controllers
 - `src/api/services`: hook services
-- `src/config`: configuration and reusable form definition helpers
+- `src/config`: configuration and reusable form definition helpers registered through `registerRedboxConfig()`
 - `src/form-config`: form config exports
+- `src/migrations`: synchronous hook migration registry
+- `support/bootstrap-data`: bootstrap data copied into the portal image/harness
+- `assets`, `views`, and `language-defaults`: client customisation material copied or resolved by the hook runtime
 - `test/unit`: fast hook-local TypeScript tests
 - `test/integration`: portal integration tests

package/templates/hook-archetype/standard/assets/default/.gitkeep

@@ -0,0 +1 @@
+

package/templates/hook-archetype/standard/assets/images/.gitkeep

@@ -0,0 +1 @@
+

package/templates/hook-archetype/standard/assets/styles/.gitkeep

@@ -0,0 +1 @@
+

package/templates/hook-archetype/standard/language-defaults/README.md.hbs

@@ -0,0 +1,10 @@
+This folder contains hook-provided i18n defaults that can seed the database
+and serve as runtime fallbacks when the database has no matching value.
+
+Expected structure:
+
+- `language-defaults/<lng>/translation.json`
+- `language-defaults/meta.json` for optional category/description metadata
+
+Keep generated client locale assets out of this folder; those belong under
+the portal asset build output, not in the hook source.

package/templates/hook-archetype/standard/language-defaults/en/translation.json.hbs

@@ -0,0 +1,3 @@
+{
+  "@{{hookShortName}}-hook-status": "{{hookPascalName}} hook ready"
+}

package/templates/hook-archetype/standard/language-defaults/meta.json.hbs

@@ -0,0 +1,6 @@
+{
+  "{{hookShortName}}-hook-status": {
+    "category": "{{hookShortName}}",
+    "description": "Example translation seeded by {{packageName}}"
+  }
+}

package/templates/hook-archetype/standard/package.json.hbs

@@ -9,18 +9,22 @@
     "hasControllers": true,
     "hasServices": true,
     "hasConfig": true,
-    "hasFormConfigs": true
+    "hasFormConfigs": true,
+    "hasMigrations": true
   },
   "scripts": {
     "compile": "node ./node_modules/@researchdatabox/redbox-dev-tools/bin/run-hook-tsc.js -p tsconfig.json",
     "test": "npm run test:unit && npm run test:integration:mocha",
-    "test:unit": "TS_NODE_PROJECT=./test/tsconfig.json npm run compile && node ./node_modules/@researchdatabox/redbox-dev-tools/bin/run-hook-mocha.js --config ./test/unit/.mocharc.cjs ./test/unit",
-    "test:integration:mocha": "npm run compile &&docker compose -f ./support/integration-testing/docker-compose.mocha.yml up --build --menu=false --abort-on-container-exit --exit-code-from redboxportal",
+    "test:unit": "TS_NODE_PROJECT=./test/tsconfig.json npm run compile && node ./node_modules/@researchdatabox/redbox-dev-tools/bin/run-hook-mocha.js --config ./test/unit/.mocharc.cjs \"./test/unit/**/*.test.ts\"",
+    "test:integration:mocha": "npm run compile && docker compose -f ./support/integration-testing/docker-compose.mocha.yml up --build --menu=false --abort-on-container-exit --exit-code-from redboxportal",
     "test:integration:mocha:clean": "docker compose -f ./support/integration-testing/docker-compose.mocha.yml down -v --remove-orphans --timeout 180",
-    "dev:run": "docker compose -f ./support/development/docker-compose.yml up --menu=false --abort-on-container-exit --exit-code-from rbportal",
-    "dev:run:build": "docker compose -f ./support/development/docker-compose.yml build",
+    "dev:run:prepare": "mkdir -p ./support/development/.tmp/attachments/staging ./support/development/.tmp/mongo ./support/development/.tmp/minio/data",
+    "dev:run": "npm run dev:run:prepare && docker compose -f ./support/development/docker-compose.yml up --menu=false --abort-on-container-exit --exit-code-from rbportal",
+    "dev:run:build": "docker compose -f ./support/development/docker-compose.yml build --pull",
     "dev:run:clean": "docker compose -f ./support/development/docker-compose.yml down -v --remove-orphans --timeout 180",
-    "dev:run:prepare": "mkdir -p ./support/development/.tmp/attachments/staging"
+    "dev:run:core:prepare": "bash ./support/development/prepare-core-mount.sh",
+    "dev:run:core": "npm run dev:run:core:prepare && docker compose --env-file ./support/development/.tmp/core-mount.env -f ./support/development/docker-compose.yml -f ./support/development/docker-compose.core-mount.yml up --menu=false --abort-on-container-exit --exit-code-from rbportal",
+    "dev:run:core:clean": "REDBOX_PORTAL_PATH=/tmp/unused docker compose -f ./support/development/docker-compose.yml -f ./support/development/docker-compose.core-mount.yml down -v --remove-orphans --timeout 180"
   },
   "keywords": [
     "sails",

package/templates/hook-archetype/standard/src/index.ts.hbs

@@ -1,10 +1,11 @@
 import '@researchdatabox/redbox-core';
-import { defineRedboxHook, type SailsConfig } from '@researchdatabox/redbox-core';
+import { defineRedboxHook, type HookRegistrationMap } from '@researchdatabox/redbox-core';
 import type { FormConfigFrame } from '@researchdatabox/sails-ng-common';
 import type { HookRedboxControllers } from './api/controllers';
 import type { HookRedboxServices } from './api/services';
 import { brandingConfigurationDefaults } from './config/brandingConfigurationDefaults';
 import { reusableFormDefinitions } from './config/reusableFormDefinitions';
+import { MigrationExports, registerRedboxMigrations } from './migrations';
 
 export {};
 
@@ -20,21 +21,18 @@ const hook = defineRedboxHook({
       }
     };
   },
-  configure(sails) {
-    const brandingDefaults = (sails.config.brandingConfigurationDefaults || {}) as SailsConfig['brandingConfigurationDefaults'];
-    brandingDefaults.menu = brandingConfigurationDefaults.menu as SailsConfig['brandingConfigurationDefaults']['menu'];
-    brandingDefaults.homePanels = brandingConfigurationDefaults.homePanels as SailsConfig['brandingConfigurationDefaults']['homePanels'];
-    sails.config.brandingConfigurationDefaults = brandingDefaults;
-    sails.config.reusableFormDefinitions = reusableFormDefinitions;
-  },
+  configure() {},
   defaults: {
     __configKey__: {
       _hookTimeout: 120000
     },
     policies: {}
   },
-  registerRedboxConfig(): Partial<SailsConfig> {
-    return {};
+  registerRedboxConfig(): HookRegistrationMap {
+    return {
+      brandingConfigurationDefaults,
+      reusableFormDefinitions
+    };
   },
   registerRedboxControllers(): HookRedboxControllers {
     return require('./api/controllers').ControllerExports as HookRedboxControllers;
@@ -48,7 +46,9 @@ const hook = defineRedboxHook({
   additionalExports: {
     ControllerExports: require('./api/controllers').ControllerExports,
     ServiceExports: require('./api/services').ServiceExports,
-    FormConfigExports: require('./form-config').FormConfigExports
+    FormConfigExports: require('./form-config').FormConfigExports,
+    MigrationExports,
+    registerRedboxMigrations
   }
 });
 

package/templates/hook-archetype/standard/src/migrations/index.ts.hbs

@@ -0,0 +1,19 @@
+import type { RedboxMigration } from '@researchdatabox/redbox-core';
+
+export const MigrationExports: RedboxMigration[] = [];
+
+/**
+ * Hook migration registry. The ReDBox loader discovers this via
+ * `package.json` -> `sails.hasMigrations: true` and calls it through the
+ * generated `config/migrations.js` shim.
+ *
+ * Keep this function synchronous. Migrations are ordered lexically by `name`,
+ * so prefix new migration names with the hook package name and a sortable
+ * timestamp, for example:
+ * `{{packageName}}:20260703T000000-seed-client-defaults`.
+ */
+export function registerRedboxMigrations(): RedboxMigration[] {
+  return MigrationExports;
+}
+
+export default registerRedboxMigrations;

package/templates/hook-archetype/standard/support/bootstrap-data/namedqueries/.gitkeep

@@ -0,0 +1 @@
+

package/templates/hook-archetype/standard/support/bootstrap-data/records/.gitkeep

@@ -0,0 +1 @@
+

package/templates/hook-archetype/standard/support/bootstrap-data/reports/.gitkeep

@@ -0,0 +1 @@
+

package/templates/hook-archetype/standard/support/bootstrap-data/vocabularies/.gitkeep

@@ -0,0 +1 @@
+

package/templates/hook-archetype/standard/support/development/core-mount.env.hbs

@@ -0,0 +1,3 @@
+# Local redbox-portal checkout used by `npm run dev:run:core`.
+# Relative paths are resolved from this hook root by prepare-core-mount.sh.
+REDBOX_PORTAL_PATH=../redbox-portal

package/templates/hook-archetype/standard/support/development/docker-compose.core-mount.yml.hbs

@@ -0,0 +1,37 @@
+networks:
+  main:
+
+services:
+  rbportal:
+    environment:
+      - sails_angularDev=true
+    volumes:
+      - "../../:/opt/redbox-portal/node_modules/{{packageName}}"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/app.js:/opt/redbox-portal/app.js:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/agenda-sqs-backend:/opt/redbox-portal/packages/agenda-sqs-backend:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/raido:/opt/redbox-portal/packages/raido:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/redbox-core:/opt/redbox-portal/packages/redbox-core:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/redbox-dev-tools:/opt/redbox-portal/packages/redbox-dev-tools:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/rva-registry:/opt/redbox-portal/packages/rva-registry:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/sails-hook-redbox-storage-mongo:/opt/redbox-portal/packages/sails-hook-redbox-storage-mongo:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/sails-ng-common:/opt/redbox-portal/packages/sails-ng-common:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/views:/opt/redbox-portal/views:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/agenda-sqs-backend:/opt/redbox-portal/node_modules/@researchdatabox/agenda-sqs-backend:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/raido:/opt/redbox-portal/node_modules/@researchdatabox/raido-openapi-generated-node:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/redbox-core:/opt/redbox-portal/node_modules/@researchdatabox/redbox-core:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/redbox-core:/opt/redbox-portal/node_modules/@researchdatabox/redbox-core-types:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/redbox-dev-tools:/opt/redbox-portal/node_modules/@researchdatabox/redbox-dev-tools:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/rva-registry:/opt/redbox-portal/node_modules/@researchdatabox/rva-registry-openapi-generated-node:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/sails-hook-redbox-storage-mongo:/opt/redbox-portal/node_modules/@researchdatabox/sails-hook-redbox-storage-mongo:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/sails-ng-common:/opt/redbox-portal/node_modules/@researchdatabox/sails-ng-common:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/agenda-sqs-backend:/opt/redbox-portal/node_modules/{{packageName}}/node_modules/@researchdatabox/agenda-sqs-backend:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/raido:/opt/redbox-portal/node_modules/{{packageName}}/node_modules/@researchdatabox/raido-openapi-generated-node:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/redbox-core:/opt/redbox-portal/node_modules/{{packageName}}/node_modules/@researchdatabox/redbox-core:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/redbox-core:/opt/redbox-portal/node_modules/{{packageName}}/node_modules/@researchdatabox/redbox-core-types:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/redbox-dev-tools:/opt/redbox-portal/node_modules/{{packageName}}/node_modules/@researchdatabox/redbox-dev-tools:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/rva-registry:/opt/redbox-portal/node_modules/{{packageName}}/node_modules/@researchdatabox/rva-registry-openapi-generated-node:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/sails-hook-redbox-storage-mongo:/opt/redbox-portal/node_modules/{{packageName}}/node_modules/@researchdatabox/sails-hook-redbox-storage-mongo:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/packages/sails-ng-common:/opt/redbox-portal/node_modules/{{packageName}}/node_modules/@researchdatabox/sails-ng-common:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/assets/angular:/opt/redbox-portal/assets/angular:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/assets/angular:/opt/redbox-portal/.tmp/public/angular:delegated"
+      - "${REDBOX_PORTAL_PATH:?Run dev:run:core:prepare first}/.tmp/public/default/default/js:/opt/redbox-portal/.tmp/public/default/default/js:delegated"

package/templates/hook-archetype/standard/support/development/docker-compose.yml.hbs

@@ -4,47 +4,58 @@ networks:
 services:
   rbportal:
     build:
-      context: '../../..'
-      dockerfile: '{{packageName}}/Dockerfile'
+      context: '../..'
+      dockerfile: 'Dockerfile'
       target: '{{packageName}}'
     ports:
       - "1500:1500"
+      - "9876:9876"
     volumes:
       - "../../:/opt/redbox-portal/node_modules/{{packageName}}"
-      - "../../../redbox-portal/packages/redbox-core:/opt/redbox-portal/packages/redbox-core"
-      - "../../../redbox-portal/packages/redbox-dev-tools:/opt/redbox-portal/packages/redbox-dev-tools"
-      - "../../../redbox-portal/packages/sails-ng-common:/opt/redbox-portal/packages/sails-ng-common"
-      - "../../../redbox-portal/.tmp/public/angular/form:/opt/redbox-portal/.tmp/public/angular/form"
-      - "../../../redbox-portal/.tmp/public/angular/local-auth:/opt/redbox-portal/.tmp/public/angular/local-auth"
-      - "../../../redbox-portal/.tmp/public/angular/export:/opt/redbox-portal/.tmp/public/angular/export"
-      - "../../../redbox-portal/.tmp/public/angular/dashboard:/opt/redbox-portal/.tmp/public/angular/dashboard"
-      - "../../../redbox-portal/.tmp/public/angular/report:/opt/redbox-portal/.tmp/public/angular/report"
-      - "../../../redbox-portal/.tmp/public/angular/manage-users:/opt/redbox-portal/.tmp/public/angular/manage-users"
-      - "../../../redbox-portal/.tmp/public/angular/admin-vocabulary:/opt/redbox-portal/.tmp/public/angular/admin-vocabulary"
-      - "../../../redbox-portal/.tmp/public/angular/manage-roles:/opt/redbox-portal/.tmp/public/angular/manage-roles"
-      - "../../../redbox-portal/.tmp/public/angular/app-config:/opt/redbox-portal/.tmp/public/angular/app-config"
-      - "../../../redbox-portal/.tmp/public/angular/deleted-records:/opt/redbox-portal/.tmp/public/angular/deleted-records"
-      - "../../../redbox-portal/.tmp/public/angular/branding:/opt/redbox-portal/.tmp/public/angular/branding"
-      - "../../../redbox-portal/.tmp/public/angular/translation:/opt/redbox-portal/.tmp/public/angular/translation"
-      - "../../../redbox-portal/.tmp/public/angular/record-search:/opt/redbox-portal/.tmp/public/angular/record-search"
+      - "../../language-defaults:/opt/redbox-portal/language-defaults"
+      - "../../support/bootstrap-data:/opt/redbox-portal/bootstrap-data"
       - "./.tmp/attachments/staging:/attachments/staging"
     expose:
       - "1500"
     environment:
+      - sails_appUrl=http://localhost:1500
       - NODE_ENV=docker
       - NODE_PATH=/opt/redbox-portal/node_modules:/opt/redbox-portal/node_modules/@researchdatabox/redbox-core/node_modules
       - LOAD_DEFAULT_FORMS=true
       - PORT=1500
       - NODE_TLS_REJECT_UNAUTHORIZED=0
-      - sails_angularDev='true'
+      - sails_security__csrf=false
+      - sails_redbox__apiKey=development-api-key
+      - sails_auth__default__local__default__token=development-token
+      - sails_brandingConfigurationDefaults__auth__local__default__token=development-token
+      - HOOK_S3_ACCESS_KEY=minioadmin
+      - HOOK_S3_SECRET_KEY=minioadmin
+      - HOOK_S3_REGION=ap-southeast-2
+      - HOOK_S3_BUCKET=test-aws-{{packageName}}-attachments
+      - HOOK_S3_ENDPOINT=http://minio:9000
+      - HOOK_S3_KEY_PREFIX=attachments/
+      - HOOK_ATTACHMENTS_STAGE_DIR=/attachments/staging
+      - HOOK_S3_FORCE_PATH_STYLE=true
+      - HOOK_S3_SUPPORTS_ACL=false
+      - MINIO_WAIT_SECONDS=180
+      - REGENERATE_SHIMS=true
     networks:
       main:
         aliases:
           - rbportal
     entrypoint: >-
       /bin/bash -c "set -x;
+      if [ -n \"$${HOOK_S3_BUCKET:-}\" ]; then bash /opt/redbox-portal/node_modules/{{packageName}}/support/prepare-minio.sh development || true; fi;
       cd /opt/redbox-portal &&
-      node --enable-source-maps app.js;"
+      npm --prefix /opt/redbox-portal/node_modules/{{packageName}} run compile &&
+      node --enable-source-maps --inspect=0.0.0.0:9876 app.js;"
+    depends_on:
+      mongodb:
+        condition: service_started
+      solr:
+        condition: service_started
+      minio:
+        condition: service_healthy
 
   mongodb:
     image: mongo:7
@@ -73,3 +84,25 @@ services:
       - docker-entrypoint.sh
       - solr-precreate
       - redbox
+
+  minio:
+    image: minio/minio:latest
+    command: server /data --console-address ":9001"
+    networks:
+      main:
+        aliases:
+          - minio
+    ports:
+      - "9000:9000"
+      - "9001:9001"
+    environment:
+      - MINIO_ROOT_USER=minioadmin
+      - MINIO_ROOT_PASSWORD=minioadmin
+    volumes:
+      - "./.tmp/minio/data:/data"
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:9000/minio/health/ready"]
+      interval: 2s
+      timeout: 5s
+      retries: 90
+      start_period: 5s

package/templates/hook-archetype/standard/support/development/prepare-core-mount.sh.hbs

@@ -0,0 +1,61 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
+HOOK_ROOT="$(cd "${SCRIPT_DIR}/../.." && pwd -P)"
+DEFAULT_ENV_FILE="${SCRIPT_DIR}/core-mount.env"
+TMP_DIR="${HOOK_ROOT}/support/development/.tmp"
+RESOLVED_ENV_FILE="${TMP_DIR}/core-mount.env"
+
+if [[ -z "${REDBOX_PORTAL_PATH:-}" && -f "${DEFAULT_ENV_FILE}" ]]; then
+  set -a
+  # shellcheck disable=SC1090
+  source "${DEFAULT_ENV_FILE}"
+  set +a
+fi
+
+if [[ -z "${REDBOX_PORTAL_PATH:-}" ]]; then
+  echo "FATAL: Set REDBOX_PORTAL_PATH to the redbox-portal checkout you want to mount." >&2
+  exit 1
+fi
+
+if [[ "${REDBOX_PORTAL_PATH}" = /* ]]; then
+  PORTAL_ROOT="$(cd "${REDBOX_PORTAL_PATH}" && pwd -P)"
+else
+  PORTAL_ROOT="$(cd "${HOOK_ROOT}/${REDBOX_PORTAL_PATH}" && pwd -P)"
+fi
+
+for required_path in \
+  package.json \
+  app.js \
+  packages/redbox-core/package.json \
+  packages/redbox-dev-tools/package.json \
+  packages/sails-ng-common/package.json \
+  packages/raido/package.json \
+  packages/rva-registry/package.json \
+  packages/sails-hook-redbox-storage-mongo/package.json
+do
+  if [[ ! -e "${PORTAL_ROOT}/${required_path}" ]]; then
+    echo "FATAL: Missing required portal path: ${PORTAL_ROOT}/${required_path}" >&2
+    exit 1
+  fi
+done
+
+mkdir -p "${TMP_DIR}/attachments/staging" "${TMP_DIR}/mongo" "${TMP_DIR}/minio/data"
+chmod -R 777 "${TMP_DIR}" || true
+
+printf 'REDBOX_PORTAL_PATH=%s\n' "${PORTAL_ROOT}" > "${RESOLVED_ENV_FILE}"
+
+if [[ ! -d "${PORTAL_ROOT}/node_modules" ]]; then
+  (cd "${PORTAL_ROOT}" && npm install --ignore-scripts --strict-peer-deps)
+fi
+
+if [[ ! -d "${HOOK_ROOT}/node_modules" ]]; then
+  (cd "${HOOK_ROOT}" && npm install --ignore-scripts)
+fi
+
+(cd "${HOOK_ROOT}" && npm run compile)
+(cd "${PORTAL_ROOT}" && npm run compile:server)
+
+echo "Prepared core mount against: ${PORTAL_ROOT}"

package/templates/hook-archetype/standard/support/integration-testing/docker-compose.mocha.yml.hbs

@@ -5,35 +5,49 @@ x-rbportal-env: &rbportal-env
   - NODE_ENV=integrationtest
   - NODE_PATH=/opt/redbox-portal/node_modules:/opt/redbox-portal/node_modules/@researchdatabox/redbox-core/node_modules
   - PORT=1500
+  - sails_redbox__apiKey=integration-api-key
   - sails_redbox__mochaTesting=true
+  - sails_brandingConfigurationDefaults__auth__local__default__token=integration-token
   - sails_security__csrf=false
   - LOAD_DEFAULT_FORMS=true
+  - HOOK_S3_ACCESS_KEY=minioadmin
+  - HOOK_S3_SECRET_KEY=minioadmin
+  - HOOK_S3_REGION=ap-southeast-2
+  - HOOK_S3_BUCKET=test-aws-{{packageName}}-attachments
+  - HOOK_S3_ENDPOINT=http://minio:9000
+  - HOOK_S3_KEY_PREFIX=attachments/
+  - HOOK_ATTACHMENTS_STAGE_DIR=/attachments/staging
+  - HOOK_S3_FORCE_PATH_STYLE=true
+  - HOOK_S3_SUPPORTS_ACL=false
+  - MINIO_WAIT_SECONDS=180
+  - REGENERATE_SHIMS=true
   - CI=${CI:-false}
-  - RBPORTAL_COVERAGE_DIR=/tmp/coverage/mocha
+  - RBPORTAL_COVERAGE_DIR=/tmp/redbox-coverage/mocha
 
 x-rbportal-depends: &rbportal-depends
   mongodb:
     condition: service_healthy
   solr:
     condition: service_healthy
+  minio:
+    condition: service_healthy
 
 services:
   redboxportal:
     build:
-      context: ../../..
-      dockerfile: {{packageName}}/Dockerfile
+      context: ../..
+      dockerfile: Dockerfile
       target: {{packageName}}
     ports:
       - "1500:1500"
     volumes:
-      - "../../:/opt/redbox-portal/node_modules/{{packageName}}:delegated"
-      - "../../../redbox-portal/test:/opt/redbox-portal/test"
-      - "../../../redbox-portal/support/integration-testing:/opt/redbox-portal/support/integration-testing"
-      - "../../../redbox-portal/tsconfig.json:/opt/redbox-portal/tsconfig.json"
+      - "../../language-defaults:/opt/redbox-portal/language-defaults"
+      - "../../support/bootstrap-data:/opt/redbox-portal/bootstrap-data:ro"
+      - "../../support/prepare-minio.sh:/opt/redbox-portal/support/prepare-minio.sh:ro"
+      - "../../support/integration-testing:/opt/redbox-portal/support/integration-testing:ro"
+      - "../../tsconfig.json:/opt/redbox-portal/tsconfig.json:ro"
       - "../../test/integration:/opt/redbox-portal/test/integration/{{integrationDirName}}"
-      - "../../../redbox-portal/packages/redbox-core:/opt/redbox-portal/packages/redbox-core"
-      - "../../../redbox-portal/packages/redbox-dev-tools:/opt/redbox-portal/packages/redbox-dev-tools"
-      - "../../../redbox-portal/packages/sails-ng-common:/opt/redbox-portal/packages/sails-ng-common"
+      - "./.tmp/attachments/staging:/attachments/staging"
     depends_on: *rbportal-depends
     expose:
       - "1500"
@@ -45,7 +59,7 @@ services:
     init: true
     entrypoint:
       - bash
-      - /opt/redbox-portal/node_modules/{{packageName}}/support/integration-testing/run-mocha-hook.sh
+      - /opt/redbox-portal/support/integration-testing/run-mocha-hook.sh
 
   mongodb:
     image: mongo:7
@@ -82,3 +96,23 @@ services:
       - docker-entrypoint.sh
       - solr-precreate
       - redbox
+
+  minio:
+    image: minio/minio:latest
+    command: server /data --console-address ":9001"
+    networks:
+      main:
+        aliases:
+          - minio
+    expose:
+      - "9000"
+      - "9001"
+    environment:
+      - MINIO_ROOT_USER=minioadmin
+      - MINIO_ROOT_PASSWORD=minioadmin
+    healthcheck:
+      test: [ 'CMD-SHELL', 'curl -fsS http://localhost:9000/minio/health/ready' ]
+      interval: '5s'
+      timeout: '5s'
+      retries: 20
+      start_period: '10s'

package/templates/hook-archetype/standard/support/integration-testing/run-mocha-hook.sh.hbs

@@ -5,5 +5,10 @@ set -euo pipefail
 cd /opt/redbox-portal
 
 export RBPORTAL_MOCHA_TEST_PATHS=${RBPORTAL_MOCHA_TEST_PATHS:-$'test/integration/{{integrationDirName}}/**/*.test.ts'}
+export RBPORTAL_SAILS_LOG_LEVEL=${RBPORTAL_SAILS_LOG_LEVEL:-error}
+
+if [ -n "${HOOK_S3_BUCKET:-}" ] && [ -f /opt/redbox-portal/support/prepare-minio.sh ]; then
+  bash /opt/redbox-portal/support/prepare-minio.sh integration
+fi
 
 exec bash /opt/redbox-portal/support/integration-testing/run-mocha-redbox.sh