mod-build 4.0.79-beta.1 → 4.0.80-beta.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 4.0.80
+
+- Add `grab-jsdoc` task to serve process
+
+## 4.0.79
+
+- Add `grab-b2b-data` task to serve process
+
 ## 4.0.78
 
 - Updating `mergeDefaultFormFieldConfig` to be recursive and merge to nested fields (so we can wrap multiple fields in a `fieldset`).

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mod-build",
-	"version": "4.0.79-beta.1",
+	"version": "4.0.80-beta.1",
 	"description": "Share components for S3 sites.",
 	"type": "module",
 	"scripts": {

package/tasks/grab-jsdoc.js

@@ -0,0 +1,125 @@
+import { defaultSettings } from '../src/data/config.js';
+import axios from 'axios';
+import { createWriteStream } from 'node:fs';
+import * as stream from 'node:stream';
+import { promisify } from 'node:util';
+import fs from 'node:fs';
+import path from 'node:path';
+import { responseInterceptor } from '../src/scripts/retry-axios.js';
+
+const resourcePath = 'quote/resources/mod-form/form';
+const axiosInstance = axios.create();
+const jsdocAxiosInstance = axios.create();
+responseInterceptor(axiosInstance);
+responseInterceptor(jsdocAxiosInstance);
+
+// helper to allow us to define an "end" event to multiple streams
+const streamToDestination = (filePath) => {
+	if (!filePath) {
+		return false;
+	}
+
+	const finished = promisify(stream.finished);
+	// Add cachebuster to avoid server/browser caching issues
+	const cachebuster = Math.round(new Date().getTime() / 1000);
+	const url = `https://${defaultSettings.nodeEnv}/${resourcePath}/${filePath}?cb=${cachebuster}`;
+	const fileName = path.basename(filePath);
+	const dirPath = path.dirname(filePath);
+	// If dirPath is '.', use root directory, otherwise use the directory path
+	const destPath = dirPath === '.' ? '.' : dirPath;
+
+	return new Promise(resolve => {
+		// Create directory if it doesn't exist
+		if (destPath !== '.' && !fs.existsSync(destPath)) {
+			fs.mkdirSync(destPath, { recursive: true });
+		}
+
+		const fileFullPath = destPath === '.' ? fileName : `${destPath}/${fileName}`;
+
+		// if file exists, do not create it again
+		if (fs.existsSync(fileFullPath)) {
+			resolve();
+		} else {
+			const writer = createWriteStream(fileFullPath);
+			const options = {
+				url,
+				method: 'get',
+				responseType: 'stream'
+			};
+
+			axiosInstance(options).then(resp => {
+				if (resp.status !== 200) {
+					throw new Error(`${resp.status}: Error while fetching ${url}`);
+				}
+				resp.data.pipe(writer);
+				console.log(`${fileFullPath} created...`);
+				return finished(writer);
+			}).then(() => {
+				resolve();
+			}).catch(error => {
+				console.error(error);
+				process.exit(1);
+			}).finally(() => {
+				axiosInstance.interceptors.response.eject(responseInterceptor);
+			});
+		}
+	});
+}
+
+async function getJSDocFiles() {
+	let files = [];
+	await new Promise((resolve, reject) => {
+		// Add cachebuster to avoid server/browser caching issues
+		const cachebuster = Math.round(new Date().getTime() / 1000);
+		const options = {
+			url: `https://${defaultSettings.nodeEnv}/${resourcePath}/jsdoc.json?cb=${cachebuster}`,
+			method: 'get'
+		}
+
+		jsdocAxiosInstance(options).then(resp => {
+			if (resp.status !== 200) {
+				reject(new Error(`${resp.status}: Error while fetching ${options.url}`));
+				return;
+			}
+			try {
+				// axios may parse JSON automatically, so check if it's already an object
+				if (typeof resp.data === 'string') {
+					files = JSON.parse(resp.data);
+				} else {
+					files = resp.data;
+				}
+			} catch (parseError) {
+				reject(new Error(`Error parsing jsdoc.json: ${parseError.message}`));
+				return;
+			}
+			resolve();
+		}).catch(error => {
+			console.error(error);
+			reject(error);
+		}).finally(() => {
+			jsdocAxiosInstance.interceptors.response.eject(responseInterceptor);
+		});
+	});
+
+	return files;
+}
+
+export default async function() {
+	const { nodeEnv, isLocal } = defaultSettings;
+
+	if (!isLocal) {
+		return;
+	}
+
+	if (!nodeEnv) {
+		throw new Error('Missing environment variables. Did you start with gulp instead of npm run...?');
+	}
+
+	const files = await getJSDocFiles();
+	const filesPromiseMap = files.map(async filePath => {
+		await streamToDestination(filePath);
+	});
+
+	await Promise.all(filesPromiseMap);
+}
+

package/tasks/serve.js

@@ -5,6 +5,7 @@ import grabCdn from './grab-cdn.js';
 import grabB2BData from './grab-b2b-data.js';
 import getDefaultTradeQuestions from './get-default-trade-questions.js';
 import grabFormHelpers from './grab-form-helpers.js';
+import grabJSDoc from './grab-jsdoc.js';
 import templates from './templates.js';
 import { createStylelintFile, updateConfig } from '../src/scripts/plugins.js';
 
@@ -17,6 +18,7 @@ export async function startModBuild(config) {
 	await Promise.all([
 		grabSharedComponents(config),
 		grabFormHelpers(config),
+		grabJSDoc(),
 		templates(config)
 	]).then(async () => {
 		await grabSharedScripts(config);