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

package/dist/runtime-resolver.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getResolutionPaths = getResolutionPaths;
+exports.resolveFromRedboxContract = resolveFromRedboxContract;
+exports.requireFromRedboxContract = requireFromRedboxContract;
+const path_1 = __importDefault(require("path"));
+function getResolutionPaths() {
+    const paths = [];
+    try {
+        const redboxCorePackageJson = require.resolve('@researchdatabox/redbox-core/package.json');
+        paths.push(path_1.default.dirname(redboxCorePackageJson));
+    }
+    catch (_error) {
+    }
+    paths.push(__dirname);
+    paths.push(process.cwd());
+    return paths;
+}
+function resolveFromRedboxContract(request) {
+    return require.resolve(request, { paths: getResolutionPaths() });
+}
+function requireFromRedboxContract(request) {
+    return require(resolveFromRedboxContract(request));
+}

package/dist/templates/hook-archetype.d.ts

@@ -0,0 +1,12 @@
+export interface HookArchetypeOptions {
+    cwd: string;
+    packageName: string;
+    description?: string;
+    force?: boolean;
+    templateName?: string;
+}
+export interface HookArchetypeResult {
+    created: string[];
+    skipped: string[];
+}
+export declare function generateHookArchetype(options: HookArchetypeOptions): HookArchetypeResult;

package/dist/templates/hook-archetype.js

@@ -0,0 +1,187 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateHookArchetype = generateHookArchetype;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const handlebars_1 = __importDefault(require("handlebars"));
+const handlebars = handlebars_1.default.create();
+handlebars.registerHelper('json', (value) => JSON.stringify(value));
+function toPascalCase(value) {
+    return value
+        .split(/[^A-Za-z0-9]+/)
+        .filter(Boolean)
+        .map(part => part.charAt(0).toUpperCase() + part.slice(1))
+        .join('');
+}
+function normalizePackageName(value) {
+    const cleaned = value.trim().toLowerCase().replace(/[^a-z0-9-_]/g, '-');
+    return cleaned.startsWith('redbox-hook-') ? cleaned : `redbox-hook-${cleaned}`;
+}
+function getPackageRoot() {
+    return path.resolve(__dirname, '..', '..');
+}
+function getTemplateRoot(templateName) {
+    return path.join(getPackageRoot(), 'templates', 'hook-archetype', templateName);
+}
+function walkTemplateFiles(dir) {
+    const entries = fs.readdirSync(dir, { withFileTypes: true });
+    const files = [];
+    for (const entry of entries) {
+        const fullPath = path.join(dir, entry.name);
+        if (entry.isDirectory()) {
+            files.push(...walkTemplateFiles(fullPath));
+        }
+        else if (entry.isFile()) {
+            files.push(fullPath);
+        }
+    }
+    return files;
+}
+function renderTemplate(sourcePath, context) {
+    const templateSource = fs.readFileSync(sourcePath, 'utf8');
+    const template = handlebars.compile(templateSource, { noEscape: true });
+    return template(context);
+}
+function toOutputRelativePath(templateRoot, filePath) {
+    const relativePath = path.relative(templateRoot, filePath);
+    return relativePath.endsWith('.hbs')
+        ? relativePath.slice(0, -4)
+        : relativePath;
+}
+function shouldMarkExecutable(relativePath) {
+    return relativePath.endsWith('.sh');
+}
+function readPackageJson(packageJsonPath) {
+    return JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+}
+function tryReadPackageJson(packageJsonPath) {
+    return fs.existsSync(packageJsonPath)
+        ? readPackageJson(packageJsonPath)
+        : undefined;
+}
+function getScopedPackageName(packageName) {
+    return `@researchdatabox/${packageName}`;
+}
+function readOwnPackageVersion(packageRoot) {
+    const packageJson = tryReadPackageJson(path.join(packageRoot, 'package.json'));
+    if (!packageJson?.version) {
+        throw new Error('Could not determine version for @researchdatabox/redbox-dev-tools');
+    }
+    return packageJson.version;
+}
+function tryReadInstalledPackageVersion(packageRoot, packageName) {
+    const packageJsonPath = path.join(packageRoot, 'node_modules', ...getScopedPackageName(packageName).split('/'), 'package.json');
+    return tryReadPackageJson(packageJsonPath)?.version;
+}
+function isReusableDependencySpecifier(versionSpecifier) {
+    return !/^(file:|workspace:|link:|portal:)/.test(versionSpecifier);
+}
+function readDeclaredDependencyVersion(packageRoot, packageName) {
+    const packageJson = tryReadPackageJson(path.join(packageRoot, 'package.json'));
+    const dependencyName = getScopedPackageName(packageName);
+    const versionSpecifier = packageJson?.dependencies?.[dependencyName]
+        ?? packageJson?.peerDependencies?.[dependencyName]
+        ?? packageJson?.devDependencies?.[dependencyName];
+    return versionSpecifier && isReusableDependencySpecifier(versionSpecifier)
+        ? versionSpecifier
+        : undefined;
+}
+function readDependencyPackageVersion(packageRoot, packageName) {
+    const installedVersion = tryReadInstalledPackageVersion(packageRoot, packageName);
+    if (installedVersion) {
+        return installedVersion;
+    }
+    const siblingPackageJson = tryReadPackageJson(path.join(packageRoot, '..', packageName, 'package.json'));
+    if (siblingPackageJson?.version) {
+        return siblingPackageJson.version;
+    }
+    const declaredVersion = readDeclaredDependencyVersion(packageRoot, packageName);
+    if (declaredVersion) {
+        return declaredVersion;
+    }
+    throw new Error(`Could not determine version for ${getScopedPackageName(packageName)}`);
+}
+function buildTemplateContext(options) {
+    const packageRoot = getPackageRoot();
+    const packageName = normalizePackageName(options.packageName);
+    const hookShortName = packageName.replace(/^redbox-hook-/, '');
+    const hookPascalName = toPascalCase(hookShortName);
+    return {
+        packageName,
+        hookShortName,
+        hookPascalName,
+        description: options.description ?? `ReDBox hook for ${hookPascalName}`,
+        integrationDirName: `hook-${hookShortName}`,
+        redboxCoreVersion: readDependencyPackageVersion(packageRoot, 'redbox-core'),
+        redboxDevToolsVersion: readOwnPackageVersion(packageRoot),
+    };
+}
+function generateHookArchetype(options) {
+    const force = options.force ?? false;
+    const templateName = options.templateName ?? 'standard';
+    const templateRoot = getTemplateRoot(templateName);
+    if (!fs.existsSync(templateRoot)) {
+        throw new Error(`Unknown hook archetype template: ${templateName}`);
+    }
+    const context = buildTemplateContext(options);
+    const templateFiles = walkTemplateFiles(templateRoot);
+    const created = [];
+    const skipped = [];
+    for (const templateFile of templateFiles) {
+        const relativePath = toOutputRelativePath(templateRoot, templateFile);
+        const outputPath = path.join(options.cwd, relativePath);
+        const alreadyExists = fs.existsSync(outputPath);
+        if (alreadyExists && !force) {
+            skipped.push(relativePath);
+            continue;
+        }
+        fs.mkdirSync(path.dirname(outputPath), { recursive: true });
+        if (templateFile.endsWith('.hbs')) {
+            fs.writeFileSync(outputPath, renderTemplate(templateFile, context));
+        }
+        else {
+            fs.copyFileSync(templateFile, outputPath);
+        }
+        if (shouldMarkExecutable(relativePath)) {
+            fs.chmodSync(outputPath, 0o755);
+        }
+        created.push(relativePath);
+    }
+    return { created, skipped };
+}

package/dist/testing.d.ts

@@ -0,0 +1,7 @@
+import * as chai from 'chai';
+import _ from 'lodash';
+import * as rxjs from 'rxjs';
+declare const should: Chai.Should;
+declare const expect: Chai.ExpectStatic, assert: Chai.AssertStatic;
+declare const firstValueFrom: typeof rxjs.firstValueFrom;
+export { chai, expect, assert, should, _, _ as lodash, rxjs, firstValueFrom, };

package/dist/testing.js

@@ -0,0 +1,53 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.firstValueFrom = exports.rxjs = exports.lodash = exports._ = exports.should = exports.assert = exports.expect = exports.chai = void 0;
+const chai = __importStar(require("chai"));
+exports.chai = chai;
+const lodash_1 = __importDefault(require("lodash"));
+exports._ = lodash_1.default;
+exports.lodash = lodash_1.default;
+const rxjs = __importStar(require("rxjs"));
+exports.rxjs = rxjs;
+const should = chai.should();
+exports.should = should;
+const { expect, assert } = chai;
+exports.expect = expect;
+exports.assert = assert;
+const { firstValueFrom } = rxjs;
+exports.firstValueFrom = firstValueFrom;

package/dist/utils/config-helper.d.ts

@@ -0,0 +1,71 @@
+import { Project } from 'ts-morph';
+import { RedboxPaths } from './paths';
+export type NavigationTarget = 'menu' | 'menuRoot' | 'homePanel' | 'adminSection' | 'adminFooter';
+export interface NavigationMapping {
+    action?: string;
+    target: NavigationTarget;
+    containerId?: string;
+    itemId?: string;
+    labelKey: string;
+    href?: string;
+}
+export interface LanguageDefaultEntry {
+    key: string;
+    value: string;
+    language?: string;
+}
+export declare function updateModelIndex(params: {
+    project: Project;
+    paths: RedboxPaths;
+    root: string;
+    modelName: string;
+    dryRun: boolean;
+}): Promise<void>;
+export declare function updateControllerIndex(params: {
+    project: Project;
+    paths: RedboxPaths;
+    root: string;
+    controllerName: string;
+    className: string;
+    webservice: boolean;
+    dryRun: boolean;
+}): Promise<void>;
+export declare function updateServiceIndex(params: {
+    project: Project;
+    paths: RedboxPaths;
+    root: string;
+    serviceName: string;
+    className: string;
+    dryRun: boolean;
+}): Promise<void>;
+export declare function updateRoutes(params: {
+    project: Project;
+    paths: RedboxPaths;
+    root: string;
+    route: string;
+    controllerName: string;
+    action: string;
+    webservice: boolean;
+    csrf?: boolean;
+    dryRun: boolean;
+}): Promise<void>;
+export declare function updateAuth(params: {
+    project: Project;
+    paths: RedboxPaths;
+    root: string;
+    route: string;
+    auth: string[];
+    dryRun: boolean;
+}): Promise<void>;
+export declare function updateNavigationConfig(params: {
+    project: Project;
+    paths: RedboxPaths;
+    root: string;
+    mapping: NavigationMapping;
+    dryRun: boolean;
+}): Promise<void>;
+export declare function updateLanguageDefaults(params: {
+    root: string;
+    entries: LanguageDefaultEntry[];
+    dryRun: boolean;
+}): Promise<void>;