@researchdatabox/redbox-dev-tools 0.0.1 → 5.0.0-RC2

package/templates/hook-archetype/standard/src/form-config/default-1.0-draft.ts.hbs

@@ -0,0 +1,20 @@
+import type { FormConfigFrame } from '@researchdatabox/sails-ng-common';
+import { FormConfigExports as CoreFormConfigExports } from '@researchdatabox/redbox-core';
+
+function isFormConfigFrame(value: unknown): value is FormConfigFrame {
+	return typeof value === 'object' && value !== null;
+}
+
+if (!('generated-view-only' in CoreFormConfigExports)) {
+	throw new Error("CoreFormConfigExports is missing the 'generated-view-only' form config.");
+}
+
+const generatedViewOnly = CoreFormConfigExports['generated-view-only'];
+
+if (!isFormConfigFrame(generatedViewOnly)) {
+	throw new Error("CoreFormConfigExports['generated-view-only'] is not a valid FormConfigFrame.");
+}
+
+const defaultDraft: FormConfigFrame = generatedViewOnly;
+
+export default defaultDraft;

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

@@ -0,0 +1,8 @@
+import type { FormConfigFrame } from '@researchdatabox/sails-ng-common';
+import { FormConfigExports as CoreFormConfigExports } from '@researchdatabox/redbox-core';
+import defaultDraft from './default-1.0-draft';
+
+export const FormConfigExports: Record<string, FormConfigFrame> = {
+  'default-1.0-draft': defaultDraft,
+  'generated-view-only': CoreFormConfigExports['generated-view-only']
+};

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

@@ -0,0 +1,55 @@
+import '@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 {};
+
+const hook = defineRedboxHook({
+  initialize(_sails, done) {
+    done();
+  },
+  routes() {
+    return {
+      before: {},
+      after: {
+        'GET /hooks/{{hookShortName}}/status': 'ExampleController.index'
+      }
+    };
+  },
+  configure() {},
+  defaults: {
+    __configKey__: {
+      _hookTimeout: 120000
+    },
+    policies: {}
+  },
+  registerRedboxConfig(): HookRegistrationMap {
+    return {
+      brandingConfigurationDefaults,
+      reusableFormDefinitions
+    };
+  },
+  registerRedboxControllers(): HookRedboxControllers {
+    return require('./api/controllers').ControllerExports as HookRedboxControllers;
+  },
+  registerRedboxServices(): HookRedboxServices {
+    return require('./api/services').ServiceExports as HookRedboxServices;
+  },
+  registerRedboxFormConfigs(): Record<string, FormConfigFrame> {
+    return require('./form-config').FormConfigExports as Record<string, FormConfigFrame>;
+  },
+  additionalExports: {
+    ControllerExports: require('./api/controllers').ControllerExports,
+    ServiceExports: require('./api/services').ServiceExports,
+    FormConfigExports: require('./form-config').FormConfigExports,
+    MigrationExports,
+    registerRedboxMigrations
+  }
+});
+
+module.exports = hook;

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/.gitkeep

@@ -0,0 +1 @@
+

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

@@ -0,0 +1,108 @@
+networks:
+  main:
+
+services:
+  rbportal:
+    build:
+      context: '../..'
+      dockerfile: 'Dockerfile'
+      target: '{{packageName}}'
+    ports:
+      - "1500:1500"
+      - "9876:9876"
+    volumes:
+      - "../../:/opt/redbox-portal/node_modules/{{packageName}}"
+      - "../../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_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 &&
+      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
+    networks:
+      main:
+        aliases:
+          - mongodb
+    ports:
+      - "27017:27017"
+    volumes:
+      - ".tmp/mongo:/data/db"
+
+  solr:
+    image: solr:8.11.1
+    networks:
+      main:
+        aliases:
+          - solr
+    expose:
+      - "8983"
+    ports:
+      - "8983:8983"
+    environment:
+      - SOLR_HOME=/var/solr/data
+    entrypoint:
+      - 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

@@ -0,0 +1,118 @@
+networks:
+  main:
+
+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/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: Dockerfile
+      target: {{packageName}}
+    ports:
+      - "1500:1500"
+    volumes:
+      - "../../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}}"
+      - "./.tmp/attachments/staging:/attachments/staging"
+    depends_on: *rbportal-depends
+    expose:
+      - "1500"
+    environment: *rbportal-env
+    networks:
+      main:
+        aliases:
+          - redboxportal
+    init: true
+    entrypoint:
+      - bash
+      - /opt/redbox-portal/support/integration-testing/run-mocha-hook.sh
+
+  mongodb:
+    image: mongo:7
+    networks:
+      main:
+        aliases:
+          - mongodb
+    ports:
+      - "27017:27017"
+    healthcheck:
+      test: ['CMD-SHELL', "echo 'db.runCommand(\"ping\").ok' | mongosh"]
+      interval: '10s'
+      timeout: '5s'
+      retries: 10
+      start_period: '30s'
+
+  solr:
+    image: solr:8.11.1
+    expose:
+      - "8983"
+    ports:
+      - "8983:8983"
+    healthcheck:
+      test: ['CMD-SHELL', 'curl http://localhost:8983']
+      interval: '10s'
+      timeout: '5s'
+      retries: 10
+      start_period: '30s'
+    networks:
+      main:
+        aliases:
+          - solr
+    entrypoint:
+      - 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

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+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

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

@@ -0,0 +1,100 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+set -o xtrace
+
+cd /opt/redbox-portal
+
+rm -rf /opt/redbox-portal/coverage/mocha/* || true
+rm /opt/redbox-portal/.tmp/junit/backend-mocha/backend-mocha.xml || true
+
+node_cmd=(node)
+
+export TS_NODE_PROJECT=/opt/redbox-portal/tsconfig.json
+export TS_NODE_TRANSPILE_ONLY=true
+export TS_NODE_COMPILER_OPTIONS='{"module":"commonjs","moduleResolution":"node","esModuleInterop":true}'
+
+export RBPORTAL_COVERAGE_DIR=${RBPORTAL_COVERAGE_DIR:-/tmp/coverage/mocha}
+mkdir -p "$RBPORTAL_COVERAGE_DIR"
+chmod 777 "$RBPORTAL_COVERAGE_DIR" || true
+
+export NYC_OUTPUT=${NYC_OUTPUT:-/tmp/nyc_output}
+mkdir -p "$NYC_OUTPUT"
+chmod 777 "$NYC_OUTPUT" || true
+
+test_args=()
+if [[ -n "${RBPORTAL_MOCHA_TEST_PATHS:-}" ]]; then
+  mapfile -t env_test_args <<< "${RBPORTAL_MOCHA_TEST_PATHS}"
+  test_args+=("${env_test_args[@]}")
+fi
+
+if [[ ${#@} -gt 0 ]]; then
+  test_args+=("$@")
+fi
+
+if [[ ${#test_args[@]} -eq 0 ]]; then
+  test_args=(test/integration/**/*.test.ts)
+fi
+
+if [[ ! -x node_modules/.bin/mocha ]] || [[ ! -x node_modules/.bin/nyc ]]; then
+  echo "Test dependencies not found. Running npm install..."
+  npm install
+fi
+
+if [[ ! -f node_modules/redoc/bundles/redoc.standalone.js ]]; then
+  npm install --no-save --ignore-scripts --strict-peer-deps redoc@2.5.2
+fi
+
+npm run webpack
+
+rm -rf node_modules/redoc node_modules/should
+
+echo "Generating shims via redbox-core loader..."
+node -e "
+  const { generateAllShims } = require('@researchdatabox/redbox-core');
+  generateAllShims(process.cwd(), {
+    forceRegenerate: true,
+    verbose: true
+  }).catch(err => {
+    console.error('Shim generation failed:', err);
+    process.exit(1);
+  });
+"
+
+bootstrap_test=test/bootstrap.test.ts
+
+mocha_cmd=(node_modules/.bin/mocha)
+nyc_cmd=(node_modules/.bin/nyc)
+if [[ -n "${RBPORTAL_REMOTE_DEBUG:-}" ]]; then
+  nyc_cmd+=(--inspect="${RBPORTAL_REMOTE_DEBUG}")
+fi
+
+final_args=("${node_cmd[@]}" "${mocha_cmd[@]}")
+
+mocha_config_args=()
+if [[ -f test/integration/.mocharc.js ]]; then
+  mocha_config_args+=(--config test/integration/.mocharc.js)
+else
+  mocha_config_args+=(
+    --require ts-node/register
+    --require chai
+    --extension ts,js
+    --recursive
+    --timeout 30s
+    --ui bdd
+  )
+  if [[ "${CI:-false}" == "true" ]]; then
+    mocha_config_args+=(--reporter mocha-junit-reporter --reporter-option mochaFile=./.tmp/junit/backend-mocha/backend-mocha.xml)
+  else
+    mocha_config_args+=(--reporter spec)
+  fi
+fi
+
+exec "${nyc_cmd[@]}" --no-clean \
+  --temp-dir "$NYC_OUTPUT" \
+  --report-dir "$RBPORTAL_COVERAGE_DIR" \
+  --reporter=lcov --exclude-after-remap=false \
+  "${final_args[@]}" \
+  \
+  "${mocha_config_args[@]}" \
+  --exit "${bootstrap_test}" "${test_args[@]}"

package/templates/hook-archetype/standard/support/prepare-minio.sh.hbs

@@ -0,0 +1,74 @@
+#! /bin/sh
+MINIO_URL="${HOOK_S3_ENDPOINT:-http://minio:9000}"
+MINIO_WAIT_SECONDS="${MINIO_WAIT_SECONDS:-180}"
+
+wait_for_minio() {
+  echo "Waiting for MinIO at ${MINIO_URL}..."
+  for _ in $(seq 1 "${MINIO_WAIT_SECONDS}"); do
+    if curl -fsS "${MINIO_URL}/minio/health/ready" >/dev/null; then
+      return 0
+    fi
+    sleep 1
+  done
+  echo "MinIO did not become ready within ${MINIO_WAIT_SECONDS} seconds." >&2
+  return 1
+}
+
+ensure_mc() {
+  if [ ! -x /tmp/mc ]; then
+    case "$(uname -m)" in
+      x86_64) mc_arch=amd64 ;;
+      aarch64|arm64) mc_arch=arm64 ;;
+      *) echo "Unsupported architecture: $(uname -m)" >&2; return 1 ;;
+    esac
+    curl -fsSL -o /tmp/mc "https://dl.min.io/client/mc/release/linux-${mc_arch}/mc"
+    chmod +x /tmp/mc
+  fi
+}
+
+ensure_alias() {
+  /tmp/mc alias set local "${MINIO_URL}" "${HOOK_S3_ACCESS_KEY}" "${HOOK_S3_SECRET_KEY}" >/dev/null
+}
+
+ensure_bucket() {
+  if /tmp/mc stat "local/${HOOK_S3_BUCKET}" >/dev/null 2>&1; then
+    echo "Attachments bucket exists, skipping creation."
+    return 0
+  fi
+
+  /tmp/mc mb "local/${HOOK_S3_BUCKET}"
+}
+
+ensure_credentials() {
+  CREDS_DIR=/home/node/.aws
+  CREDS_FILE="${CREDS_DIR}/credentials"
+  DESIRED_CREDS_FILE=/tmp/minio-credentials
+
+  cat > "${DESIRED_CREDS_FILE}" <<EOF
+[default]
+aws_access_key_id = ${HOOK_S3_ACCESS_KEY}
+aws_secret_access_key = ${HOOK_S3_SECRET_KEY}
+EOF
+
+  mkdir -p "${CREDS_DIR}"
+
+  if [ -f "${CREDS_FILE}" ] && cmp -s "${CREDS_FILE}" "${DESIRED_CREDS_FILE}"; then
+    echo "Reusing existing credentials file: ${CREDS_FILE}"
+    rm -f "${DESIRED_CREDS_FILE}"
+    return 0
+  fi
+
+  echo "Writing credentials file: ${CREDS_FILE}"
+  mv "${DESIRED_CREDS_FILE}" "${CREDS_FILE}"
+}
+
+if [ -z "${HOOK_S3_BUCKET:-}" ]; then
+  echo "HOOK_S3_BUCKET is not set; skipping MinIO preparation."
+  exit 0
+fi
+
+ensure_mc
+wait_for_minio
+ensure_alias
+ensure_bucket
+ensure_credentials

package/templates/hook-archetype/standard/test/integration/hook-registration.test.ts.hbs

@@ -0,0 +1,15 @@
+const { expect, firstValueFrom } = require('@researchdatabox/redbox-dev-tools/testing');
+
+describe('{{packageName}} integration', function () {
+  it('registers example services, form configs, config, and migrations with the lifted portal', async function () {
+    expect(sails.services.exampleservice).to.exist;
+
+    const result = await firstValueFrom(sails.services.exampleservice.describe());
+    expect(result).to.deep.equal({ hook: '{{packageName}}', status: 'ready' });
+
+    const hookModule = require('{{packageName}}');
+    expect(hookModule.registerRedboxConfig()).to.have.property('brandingConfigurationDefaults');
+    expect(hookModule.registerRedboxFormConfigs()).to.have.property('generated-view-only');
+    expect(hookModule.registerRedboxMigrations()).to.deep.equal([]);
+  });
+});