@researchdatabox/redbox-dev-tools 0.0.1-beta.10173

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

@@ -0,0 +1,55 @@
+import '@researchdatabox/redbox-core';
+import { defineRedboxHook, type SailsConfig } 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';
+
+export {};
+
+const hook = defineRedboxHook({
+  initialize(_sails, done) {
+    done();
+  },
+  routes() {
+    return {
+      before: {},
+      after: {
+        'GET /hooks/{{hookShortName}}/status': 'ExampleController.index'
+      }
+    };
+  },
+  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;
+  },
+  defaults: {
+    __configKey__: {
+      _hookTimeout: 120000
+    },
+    policies: {}
+  },
+  registerRedboxConfig(): Partial<SailsConfig> {
+    return {};
+  },
+  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
+  }
+});
+
+module.exports = hook;

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1,75 @@
+networks:
+  main:
+
+services:
+  rbportal:
+    build:
+      context: '../../..'
+      dockerfile: '{{packageName}}/Dockerfile'
+      target: '{{packageName}}'
+    ports:
+      - "1500:1500"
+    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"
+      - "./.tmp/attachments/staging:/attachments/staging"
+    expose:
+      - "1500"
+    environment:
+      - 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'
+    networks:
+      main:
+        aliases:
+          - rbportal
+    entrypoint: >-
+      /bin/bash -c "set -x;
+      cd /opt/redbox-portal &&
+      node --enable-source-maps app.js;"
+
+  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

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

@@ -0,0 +1,84 @@
+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__mochaTesting=true
+  - sails_security__csrf=false
+  - LOAD_DEFAULT_FORMS=true
+  - CI=${CI:-false}
+  - RBPORTAL_COVERAGE_DIR=/tmp/coverage/mocha
+
+x-rbportal-depends: &rbportal-depends
+  mongodb:
+    condition: service_healthy
+  solr:
+    condition: service_healthy
+
+services:
+  redboxportal:
+    build:
+      context: ../../..
+      dockerfile: {{packageName}}/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"
+      - "../../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"
+    depends_on: *rbportal-depends
+    expose:
+      - "1500"
+    environment: *rbportal-env
+    networks:
+      main:
+        aliases:
+          - redboxportal
+    init: true
+    entrypoint:
+      - bash
+      - /opt/redbox-portal/node_modules/{{packageName}}/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

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

@@ -0,0 +1,9 @@
+#!/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'}
+
+exec bash /opt/redbox-portal/support/integration-testing/run-mocha-redbox.sh

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

@@ -0,0 +1,13 @@
+const { expect, firstValueFrom } = require('@researchdatabox/redbox-dev-tools/testing');
+
+describe('{{packageName}} integration', function () {
+  it('registers example services and form configs 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.registerRedboxFormConfigs()).to.have.property('generated-view-only');
+  });
+});

package/templates/hook-archetype/standard/test/support/globals.ts.hbs

@@ -0,0 +1,40 @@
+const { _ } = require('@researchdatabox/redbox-dev-tools/testing');
+
+type LogFn = (...args: unknown[]) => void;
+
+const noop: LogFn = () => undefined;
+
+function installHookTestGlobals(overrides: Record<string, unknown> = {}): void {
+  (global as any)._ = _;
+  (global as any).sails = {
+    config: {
+      appPath: process.cwd(),
+      appUrl: 'https://example.redbox.local',
+      http: {
+        rootContext: 'redbox'
+      },
+      brandingConfigurationDefaults: {},
+      reusableFormDefinitions: {},
+      ...overrides
+    },
+    log: {
+      trace: noop,
+      verbose: noop,
+      info: noop,
+      warn: noop,
+      error: noop,
+      debug: noop
+    },
+    services: {}
+  };
+}
+
+function clearHookTestGlobals(): void {
+  delete (global as any)._;
+  delete (global as any).sails;
+}
+
+module.exports = {
+  installHookTestGlobals,
+  clearHookTestGlobals
+};

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

@@ -0,0 +1,8 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "types": ["node", "mocha", "chai"]
+  },
+  "include": ["./**/*.ts", "../src/**/*.ts"]
+}

package/templates/hook-archetype/standard/test/unit/.mocharc.cjs.hbs

@@ -0,0 +1,9 @@
+module.exports = {
+  require: ['ts-node/register'],
+  extension: ['ts'],
+  recursive: true,
+  timeout: '30s',
+  ui: 'bdd',
+  reporter: 'spec',
+  exit: true
+};

package/templates/hook-archetype/standard/test/unit/index.test.ts.hbs

@@ -0,0 +1,40 @@
+const { expect, firstValueFrom } = require('@researchdatabox/redbox-dev-tools/testing');
+const { clearHookTestGlobals, installHookTestGlobals } = require('../support/globals');
+
+const hookModulePath = require.resolve('../../dist/index.js');
+
+let hookModule;
+
+describe('hook entrypoint', function () {
+  beforeEach(() => {
+    installHookTestGlobals();
+    delete require.cache[hookModulePath];
+    hookModule = require(hookModulePath);
+  });
+
+  afterEach(() => {
+    clearHookTestGlobals();
+    delete require.cache[hookModulePath];
+  });
+
+  it('exports the standard hook registrations and aliases', async function () {
+    expect(hookModule.registerRedboxConfig()).to.deep.equal({});
+    expect(hookModule.registerRedboxServices()).to.have.property('ExampleService');
+    expect(hookModule.registerRedboxControllers()).to.have.property('ExampleController');
+    expect(hookModule.registerRedboxFormConfigs()).to.have.property('generated-view-only');
+    expect(hookModule.registerFormConfig()).to.equal(hookModule.registerRedboxFormConfigs());
+
+    const result = await firstValueFrom(hookModule.registerRedboxServices().ExampleService.describe());
+    expect(result).to.deep.equal({ hook: '{{packageName}}', status: 'ready' });
+  });
+
+  it('applies reusable form definitions and branding defaults during configure', function () {
+    const hook = hookModule((global as any).sails);
+
+    hook.configure?.();
+
+    expect((global as any).sails.config.brandingConfigurationDefaults.menu).to.deep.equal({ items: [], showSearch: true });
+    expect((global as any).sails.config.brandingConfigurationDefaults.homePanels).to.deep.equal({ panels: [] });
+    expect((global as any).sails.config.reusableFormDefinitions).to.exist;
+  });
+});

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

@@ -0,0 +1,15 @@
+{
+  "extends": "@researchdatabox/redbox-dev-tools/config/tsconfig.base.json",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./dist",
+    "strict": true,
+    "allowUmdGlobalAccess": true,
+    "typeRoots": [
+      "./node_modules/@types"
+    ]
+  },
+  "include": ["src/**/*.ts", "src/**/*.d.ts"],
+  "exclude": ["dist/**/*.ts", "dist/**/*.d.ts"]
+}

package/templates/hook-archetype/standard/views/.gitkeep

@@ -0,0 +1 @@
+

package/testing.d.ts

@@ -0,0 +1 @@
+export * from './dist/testing';

package/testing.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('./dist/testing.js');