@researchdatabox/redbox-dev-tools 0.0.1-beta.8936 → 0.0.1-beta.9020

package/bin/wrapper-webpack.js

@@ -1,6 +1,10 @@
 // This file is a helper for dev only. It makes it easier to run webpack when parts of the mono repo are in different stages of being built. Refer to the redbox-core webpack.ts for how the hook runs webpack
+const path = require('path');
+const { createRequire } = require('module');
 const redboxCore = require('@researchdatabox/redbox-core');
 
+const requireFromHere = createRequire(__filename);
+
 const ensureTsNode = () => {
   try {
     require('ts-node/register/transpile-only');
@@ -18,7 +22,7 @@ if (!defineWebpackHook) {
 }
 if (!defineWebpackHook && ensureTsNode()) {
   try {
-    defineWebpackHook = require('@researchdatabox/redbox-core/src/hooks/webpack.ts').defineWebpackHook;
+    defineWebpackHook = requireFromHere('@researchdatabox/redbox-core/src/hooks/webpack.ts').defineWebpackHook;
   } catch (e) {}
 }
 
@@ -54,7 +58,7 @@ if (!webpackConfig || (Array.isArray(webpackConfig) && webpackConfig.length ===
 if (!webpackConfig || (Array.isArray(webpackConfig) && webpackConfig.length === 0)) {
   if (ensureTsNode()) {
     try {
-      const srcWebpack = require('@researchdatabox/redbox-core/src/config/webpack.config.ts');
+      const srcWebpack = requireFromHere('@researchdatabox/redbox-core/src/config/webpack.config.ts');
       webpackConfig = srcWebpack && srcWebpack.webpack ? srcWebpack.webpack.config : srcWebpack.config || srcWebpack;
     } catch (e) {}
   }

package/dist/cli.js

@@ -128,6 +128,7 @@ program
 });
 (0, form_config_1.registerMigrateFormConfigCommand)(program);
 (0, form_config_1.registerMigrateDataClassificationCommand)(program);
+(0, form_config_1.registerMigrateFigshareConfigCommand)(program);
 (0, form_config_1.registerClientFormConfigCommand)(program);
 (0, form_config_1.registerQuestionTreeDiagramCommand)(program);
 program

package/dist/commands/form-config.d.ts

@@ -3,3 +3,4 @@ export declare function registerMigrateFormConfigCommand(program: Command): void
 export declare function registerMigrateDataClassificationCommand(program: Command): void;
 export declare function registerClientFormConfigCommand(program: Command): void;
 export declare function registerQuestionTreeDiagramCommand(program: Command): void;
+export declare function registerMigrateFigshareConfigCommand(program: Command): void;

package/dist/commands/form-config.js

@@ -40,6 +40,7 @@ exports.registerMigrateFormConfigCommand = registerMigrateFormConfigCommand;
 exports.registerMigrateDataClassificationCommand = registerMigrateDataClassificationCommand;
 exports.registerClientFormConfigCommand = registerClientFormConfigCommand;
 exports.registerQuestionTreeDiagramCommand = registerQuestionTreeDiagramCommand;
+exports.registerMigrateFigshareConfigCommand = registerMigrateFigshareConfigCommand;
 const fs_1 = __importDefault(require("fs"));
 const path = __importStar(require("path"));
 const redbox_core_1 = require("@researchdatabox/redbox-core");
@@ -192,3 +193,212 @@ function registerQuestionTreeDiagramCommand(program) {
         }
     });
 }
+function collectLegacyTemplates(value, pathPrefix = '') {
+    if (typeof value === 'string') {
+        return value.includes('<%') ? [pathPrefix] : [];
+    }
+    if (Array.isArray(value)) {
+        return value.flatMap((entry, index) => collectLegacyTemplates(entry, `${pathPrefix}[${index}]`));
+    }
+    if (value && typeof value === 'object') {
+        return Object.entries(value).flatMap(([key, entry]) => collectLegacyTemplates(entry, pathPrefix ? `${pathPrefix}.${key}` : key));
+    }
+    return [];
+}
+function loadLegacyModule(modulePath) {
+    const resolvedPath = path.resolve(modulePath);
+    const loaded = require(resolvedPath);
+    if (loaded == null || typeof loaded !== 'object') {
+        throw new Error(`Legacy config module '${resolvedPath}' did not export an object`);
+    }
+    return loaded;
+}
+function pickLegacyExport(moduleExports, exportName) {
+    const named = moduleExports[exportName];
+    if (named != null && typeof named === 'object') {
+        return named;
+    }
+    return moduleExports;
+}
+function toNumericStatusCodes(value) {
+    if (!Array.isArray(value)) {
+        return [408, 429, 500, 502, 503, 504];
+    }
+    return value
+        .map((entry) => Number(entry))
+        .filter((entry) => Number.isFinite(entry));
+}
+function createMigratedFigsharePublishingConfig(brand, figshareApi, figshareApiEnv = {}, figshareForMapping = {}) {
+    const overrideArtifacts = figshareApiEnv.overrideArtifacts ?? {};
+    const mapping = {
+        ...(figshareApi.mapping ?? {}),
+        ...(overrideArtifacts.mapping ?? {})
+    };
+    const resolvedBaseUrl = String(overrideArtifacts.baseURL ?? figshareApi.baseURL ?? '');
+    const resolvedFrontEndUrl = String(overrideArtifacts.frontEndURL ?? figshareApi.frontEndURL ?? '');
+    const resolvedToken = String(overrideArtifacts.APIToken ?? figshareApi.APIToken ?? '');
+    return {
+        enabled: Boolean(resolvedToken && resolvedBaseUrl && resolvedFrontEndUrl),
+        connection: {
+            baseUrl: resolvedBaseUrl,
+            frontEndUrl: resolvedFrontEndUrl,
+            token: resolvedToken,
+            timeoutMs: 30000,
+            operationTimeouts: {
+                metadataMs: 30000,
+                uploadInitMs: 30000,
+                uploadPartMs: 120000,
+                publishMs: 60000
+            },
+            retry: {
+                maxAttempts: Number(figshareApi.retry?.maxAttempts ?? 3),
+                baseDelayMs: Number(figshareApi.retry?.baseDelayMs ?? 500),
+                maxDelayMs: Number(figshareApi.retry?.maxDelayMs ?? 4000),
+                retryOnStatusCodes: toNumericStatusCodes(figshareApi.retry?.retryOnStatusCodes),
+                retryOnMethods: ['get', 'put', 'delete']
+            }
+        },
+        article: {
+            itemType: mapping.figshareItemType ?? 'dataset',
+            groupId: mapping.figshareItemGroupId,
+            publishMode: mapping.figshareNeedsPublishAfterFileUpload ? 'afterUploadsComplete' : 'immediate',
+            republishOnMetadataChange: true,
+            republishOnAssetChange: true
+        },
+        record: {
+            articleIdPath: mapping.recordFigArticleId ?? 'metadata.figshare_article_id',
+            articleUrlPaths: Array.isArray(mapping.recordFigArticleURL) ? mapping.recordFigArticleURL : [mapping.recordFigArticleURL ?? 'metadata.figshare_article_location'],
+            dataLocationsPath: mapping.recordDataLocations ?? 'metadata.dataLocations',
+            statusPath: 'metadata.figshareStatus',
+            errorPath: 'metadata.figshareError',
+            syncStatePath: 'metadata.figshareSyncState',
+            allFilesUploadedPath: typeof mapping.recordAllFilesUploaded === 'string' ? mapping.recordAllFilesUploaded : ''
+        },
+        selection: {
+            attachmentMode: mapping.figshareOnlyPublishSelectedAttachmentFiles ? 'selectedOnly' : 'all',
+            urlMode: mapping.figshareOnlyPublishSelectedLocationURLs ? 'selectedOnly' : 'all',
+            selectedFlagPath: 'selected'
+        },
+        authors: {
+            source: 'defaultRedboxContributors',
+            uniqueBy: mapping.recordAuthorUniqueBy ?? 'email',
+            externalNameField: mapping.recordAuthorExternalName ?? 'text_full_name',
+            maxInlineAuthors: 50,
+            contributorPaths: ['metadata.contributor_ci', 'metadata.contributors'],
+            lookup: []
+        },
+        metadata: {
+            title: { kind: 'path', path: 'metadata.title' },
+            description: { kind: 'path', path: 'metadata.description' },
+            keywords: { kind: 'path', path: 'metadata.finalKeywords', defaultValue: [] },
+            funding: { kind: 'path', path: 'metadata.funder' },
+            license: { source: { kind: 'path', path: mapping.recordLicensePath ?? 'metadata.license' }, matchBy: 'urlContains', required: true },
+            categories: { source: { kind: 'path', path: mapping.recordCategoryPath ?? 'metadata.forCodes', defaultValue: [] }, mappingStrategy: 'for2020Mapping' },
+            customFields: []
+        },
+        categories: {
+            strategy: 'for2020Mapping',
+            mappingTable: ((figshareForMapping.FORMapping ?? []).map((entry) => ({
+                sourceCode: String(entry.redboxCode ?? entry.sourceCode ?? ''),
+                figshareCategoryId: Number(entry.figshareCategoryId ?? entry.figCode ?? 0)
+            }))).filter((entry) => entry.sourceCode !== ''),
+            allowUnmapped: false
+        },
+        assets: {
+            enableHostedFiles: true,
+            enableLinkFiles: true,
+            dedupeStrategy: 'sourceId',
+            staging: {
+                tempDir: String(figshareApi.attachmentsFigshareTempDir ?? ''),
+                cleanupPolicy: 'deleteAfterSuccess',
+                diskSpaceThresholdBytes: 1073741824
+            }
+        },
+        embargo: {
+            mode: 'recordDriven',
+            forceSync: Boolean(mapping.figshareForceEmbargoUpdateAlways),
+            accessRights: {
+                accessRights: { kind: 'path', path: 'metadata.accessRights' },
+                fullEmbargoUntil: { kind: 'path', path: 'metadata.embargoUntil' },
+                fileEmbargoUntil: { kind: 'path', path: 'metadata.embargoUntil' },
+                reason: { kind: 'path', path: 'metadata.embargoReason' }
+            }
+        },
+        queue: {
+            publishAfterUploadDelay: typeof mapping.schedulePublishAfterUploadJob === 'string' ? mapping.schedulePublishAfterUploadJob : 'in 2 minutes',
+            uploadedFilesCleanupDelay: typeof mapping.scheduleUploadedFilesCleanupJob === 'string' ? mapping.scheduleUploadedFilesCleanupJob : 'in 5 minutes'
+        },
+        workflow: {
+            transitionRules: [],
+            transitionJob: {
+                enabled: String(mapping.figshareScheduledTransitionRecordWorkflowFromArticlePropertiesJob?.enabled ?? 'false') === 'true',
+                namedQuery: String(mapping.figshareScheduledTransitionRecordWorkflowFromArticlePropertiesJob?.namedQuery ?? ''),
+                targetStep: String(mapping.figshareScheduledTransitionRecordWorkflowFromArticlePropertiesJob?.targetStep ?? ''),
+                paramMap: mapping.figshareScheduledTransitionRecordWorkflowFromArticlePropertiesJob?.paramMap ?? {},
+                figshareTargetFieldKey: String(mapping.figshareScheduledTransitionRecordWorkflowFromArticlePropertiesJob?.figshareTargetFieldKey ?? ''),
+                figshareTargetFieldValue: String(mapping.figshareScheduledTransitionRecordWorkflowFromArticlePropertiesJob?.figshareTargetFieldValue ?? ''),
+                username: String(mapping.figshareScheduledTransitionRecordWorkflowFromArticlePropertiesJob?.username ?? ''),
+                userType: String(mapping.figshareScheduledTransitionRecordWorkflowFromArticlePropertiesJob?.userType ?? '')
+            }
+        },
+        testing: {
+            mode: figshareApi.testMode ? 'fixture' : 'live'
+        },
+        writeBack: {
+            articleId: 'metadata.figshare_article_id',
+            articleUrls: ['metadata.figshare_article_location'],
+            extraFields: []
+        },
+        migrationReport: {
+            brand,
+            unsupportedLegacyTemplates: collectLegacyTemplates(mapping)
+        }
+    };
+}
+function registerMigrateFigshareConfigCommand(program) {
+    program
+        .command('migrate-figshare-config')
+        .description('Migrate legacy Figshare config into figsharePublishing AppConfig JSON files')
+        .requiredOption('--figshare-api <path>', 'Path to the legacy figshareAPI config module')
+        .option('--figshare-api-env <path>', 'Path to the legacy figshareAPIEnv config module')
+        .option('--figshare-for-mapping <path>', 'Path to the legacy figshareReDBoxFORMapping config module')
+        .requiredOption('-o, --output <path>', 'Directory to write migrated figsharePublishing JSON files')
+        .option('-b, --brands <brands...>', 'Brands to generate config for', ['default'])
+        .action(async (options) => {
+        try {
+            const globalOptions = program.opts();
+            const outputDir = path.resolve(options.output);
+            const brands = options.brands;
+            const figshareApi = pickLegacyExport(loadLegacyModule(options.figshareApi), 'figshareAPI');
+            const figshareApiEnv = options.figshareApiEnv
+                ? pickLegacyExport(loadLegacyModule(options.figshareApiEnv), 'figshareAPIEnv')
+                : {};
+            const figshareForMapping = options.figshareForMapping
+                ? pickLegacyExport(loadLegacyModule(options.figshareForMapping), 'figshareReDBoxFORMapping')
+                : {};
+            if (!globalOptions.dryRun) {
+                fs_1.default.mkdirSync(outputDir, { recursive: true });
+            }
+            const report = brands.map((brand) => {
+                const migrated = createMigratedFigsharePublishingConfig(brand, figshareApi, figshareApiEnv, figshareForMapping);
+                const outputPath = path.join(outputDir, `${brand}.figsharePublishing.json`);
+                if (!globalOptions.dryRun) {
+                    fs_1.default.writeFileSync(outputPath, JSON.stringify(migrated, null, 2) + '\n', 'utf8');
+                }
+                return {
+                    brand,
+                    outputPath,
+                    unsupportedLegacyTemplates: migrated.migrationReport.unsupportedLegacyTemplates
+                };
+            });
+            if (globalOptions.dryRun) {
+                console.log('[dry-run] Migration report generated; no files written.');
+            }
+            console.log(JSON.stringify(report, null, 2));
+        }
+        catch (error) {
+            console.error(`\n❌ Error: `, error);
+            process.exit(1);
+        }
+    });
+}

package/dist/templates/hook-archetype.js

@@ -86,15 +86,58 @@ function toOutputRelativePath(templateRoot, filePath) {
 function shouldMarkExecutable(relativePath) {
     return relativePath.endsWith('.sh');
 }
-function readPackageVersion(packageRoot, packageName) {
-    const packageJsonPath = path.join(packageRoot, '..', packageName, 'package.json');
-    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
-    if (!packageJson.version) {
-        throw new Error(`Could not determine version for ${packageName}`);
+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);
@@ -104,8 +147,8 @@ function buildTemplateContext(options) {
         hookPascalName,
         description: options.description ?? `ReDBox hook for ${hookPascalName}`,
         integrationDirName: hookShortName,
-        redboxCoreVersion: readPackageVersion(getPackageRoot(), 'redbox-core'),
-        redboxDevToolsVersion: readPackageVersion(getPackageRoot(), 'redbox-dev-tools'),
+        redboxCoreVersion: readDependencyPackageVersion(packageRoot, 'redbox-core'),
+        redboxDevToolsVersion: readOwnPackageVersion(packageRoot),
     };
 }
 function generateHookArchetype(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@researchdatabox/redbox-dev-tools",
-  "version": "0.0.1-beta.8936",
+  "version": "0.0.1-beta.9020",
   "description": "ReDBox customisation dev tools - shared configuration, generators, and migration tooling",
   "type": "commonjs",
   "main": "index.js",
@@ -44,8 +44,8 @@
   },
   "homepage": "https://github.com/redbox-mint/redbox-portal/tree/v4.5.1#readme",
   "dependencies": {
-    "@researchdatabox/redbox-core": "0.0.1-beta.8936",
-    "@researchdatabox/sails-ng-common": "0.0.1-beta.8936",
+    "@researchdatabox/redbox-core": "0.0.1-beta.9020",
+    "@researchdatabox/sails-ng-common": "0.0.1-beta.9020",
     "@tsconfig/node24": "24.0.1",
     "@types/chai": "5.2.3",
     "@types/lodash": "4.17.24",
@@ -64,8 +64,8 @@
     "zod": "3.25.28"
   },
   "devDependencies": {
-    "@types/sinon": "17.0.3",
-    "sinon": "17.0.1"
+    "@types/sinon": "21.0.1",
+    "sinon": "21.1.2"
   },
   "peerDependenciesMeta": {
     "@researchdatabox/redbox-core": {
@@ -73,13 +73,13 @@
     }
   },
   "overrides": {
+    "diff": "8.0.3",
     "mocha": {
       "serialize-javascript": "7.0.5"
     }
   },
   "publishConfig": {
     "access": "public",
-    "registry": "https://registry.npmjs.org/",
-    "provenance": false
+    "registry": "https://registry.npmjs.org/"
   }
 }

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

@@ -1,6 +1,6 @@
 save-exact=true
 save-prefix=
 ignore-scripts=true
-provenance=true
+provenance=false
 registry=https://registry.npmjs.org/
 audit-level=moderate