@awesomeness-js/utils 1.2.11 → 1.2.13

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@awesomeness-js/utils",
-    "version": "1.2.11",
+    "version": "1.2.13",
     "description": "Awesomeness - Utils",
     "repository": {
         "type": "git",

package/src/build.js

@@ -25,6 +25,7 @@ async function build({
 
 	const gen = () => generateFile({
 		src,
+		dest,
 		exportRoots,
 		ignore,
 		includeComments,

package/src/utils/clean.js

@@ -165,6 +165,18 @@ function cleanArray(arr, schema = {}, {
 					
 					} else {
 
+
+						if(schema.requiredIfPresent === true){
+
+							throw {
+								message: 'requiredIfPresent item is null',
+								item,
+								key
+							};
+
+						}
+
+
 						return; // skip this item if it's not required and is null
 					
 					}
@@ -410,6 +422,22 @@ function cleanObject(obj, schema, {
 		}
 
 
+		if(
+			schema.properties[key].required === false
+            &&  schema.properties[key].requiredIfPresent === true
+            && cleanedValue === null
+		){
+
+			throw {
+				message: 'value invalid',
+				value,
+				key,
+				requirements: schema.properties[key],
+			};
+
+		}
+
+
 		cleanObj[key] = cleanedValue;
 
 	});

package/src/utils/generateFile.js

@@ -7,6 +7,7 @@ import generateNamedExports from './generateNamedExports.js';
 
 export default function generateFile({
 	src, 
+	dest,
 	exportRoots, 
 	ignore, 
 	includeComments, 
@@ -32,7 +33,8 @@ export default function generateFile({
 	const importStatements = generateImportStatements({
 		fileDataList,
 		dts,
-		src
+		src,
+		dest
 	});
 
 	const flatExportLines = generateFlatExportLines({

package/src/utils/generateImportStatements.js

@@ -1,18 +1,36 @@
+import { dirname, relative } from 'path';
+
 export default function generateImportStatements({
 	fileDataList, 
 	dts, 
-	src
+	src,
+	dest
 }) {
 
 	let statements = '';
+	const destDir = dirname(dest);
 
 	fileDataList.forEach(({
 		importVarName, importPath 
 	}) => {
 
-		statements += dts
-			? `import type ${importVarName} from '.${importPath.replace(src,'')}';\n`
-			: `import ${importVarName} from '${importPath}.js';\n`;
+		if (dts) {
+
+			const normalizedDtsPath = `.${importPath.replace(src, '')}`.replace(/\\/g, '/');
+
+			statements += `import type ${importVarName} from '${normalizedDtsPath}';\n`;
+			
+			return;
+		
+		}
+
+		const targetPath = `${importPath}.js`;
+		const normalizedRelativePath = relative(destDir, targetPath).replace(/\\/g, '/');
+		const importSpecifier = normalizedRelativePath.startsWith('.')
+			? normalizedRelativePath
+			: `./${normalizedRelativePath}`;
+
+		statements += `import ${importVarName} from '${importSpecifier}';\n`;
 	
 	});
 	

package/test/buildSpotCheck/deeperNonRoot/src/hello.js

@@ -0,0 +1 @@
+export default () => true;

package/test/buildSpotCheck/deeperNonRoot/test/nested/justATest.js

@@ -0,0 +1,13 @@
+/**
+ * This file is auto-generated by the build script.
+ * It consolidates API functions for use in the application.
+ * Do not edit manually.
+ */
+import _hello from '../../src/hello.js';
+
+export { _hello as hello };
+
+
+export default {
+	hello: _hello,
+};

package/test/buildSpotCheck/nested/sites/abetterbibleapp.com/api/app.js

@@ -0,0 +1,18 @@
+/**
+ * This file is auto-generated by the build script.
+ * It consolidates API functions for use in the application.
+ * Do not edit manually.
+ */
+import _user_bibleVersion from './functions/user/bibleVersion.js';
+
+
+export const user = {
+	bibleVersion: _user_bibleVersion
+};
+
+
+export default {
+	user: {
+		bibleVersion: _user_bibleVersion,
+	},
+};

package/test/buildSpotCheck/nested/sites/abetterbibleapp.com/api/functions/user/bibleVersion.js

@@ -0,0 +1 @@
+export default () => true;

package/test/buildSpotCheck/nonRoot/src/hello.js

@@ -0,0 +1 @@
+export default () => true;

package/test/buildSpotCheck/nonRoot/test/justATest.js

@@ -0,0 +1,13 @@
+/**
+ * This file is auto-generated by the build script.
+ * It consolidates API functions for use in the application.
+ * Do not edit manually.
+ */
+import _hello from '../src/hello.js';
+
+export { _hello as hello };
+
+
+export default {
+	hello: _hello,
+};

package/tests/build.test.js

@@ -0,0 +1,104 @@
+import { expect, test } from 'vitest';
+import { mkdirSync, readFileSync, rmSync, writeFileSync } from 'fs';
+import { dirname, join } from 'path';
+import utils from '../index.js';
+
+function writeJs(filePath, content = 'export default () => true;\n') {
+
+	mkdirSync(dirname(filePath), {
+		recursive: true
+	});
+	writeFileSync(filePath, content);
+
+}
+
+test('build generates imports relative to nested destination', async () => {
+
+	const root = join('test', 'buildSpotCheck', 'nested');
+
+	rmSync(root, {
+		recursive: true,
+		force: true
+	});
+
+	const src = join(root, 'sites', 'abetterbibleapp.com', 'api', 'functions');
+	const dest = join(root, 'sites', 'abetterbibleapp.com', 'api', 'app.js');
+	const functionFile = join(src, 'user', 'bibleVersion.js');
+
+	writeJs(functionFile);
+
+	await utils.build({
+		src,
+		dest,
+		dts: false,
+		ignore: [
+			'*.test.js'
+		]
+	});
+
+	const output = readFileSync(dest, 'utf8');
+
+	expect(output).toContain("import _user_bibleVersion from './functions/user/bibleVersion.js';");
+	expect(output).not.toContain("./sites/abetterbibleapp.com/api/functions/user/bibleVersion.js");
+
+});
+
+test('build generates correct imports for non-root destination', async () => {
+
+	const root = join('test', 'buildSpotCheck', 'nonRoot');
+
+	rmSync(root, {
+		recursive: true,
+		force: true
+	});
+
+	const src = join(root, 'src');
+	const dest = join(root, 'test', 'justATest.js');
+	const functionFile = join(src, 'hello.js');
+
+	writeJs(functionFile);
+	mkdirSync(dirname(dest), {
+		recursive: true
+	});
+
+	await utils.build({
+		src,
+		dest,
+		dts: false
+	});
+
+	const output = readFileSync(dest, 'utf8');
+
+	expect(output).toContain("import _hello from '../src/hello.js';");
+
+});
+
+test('build generates correct imports for deeper non-root destination', async () => {
+
+	const root = join('test', 'buildSpotCheck', 'deeperNonRoot');
+
+	rmSync(root, {
+		recursive: true,
+		force: true
+	});
+
+	const src = join(root, 'src');
+	const dest = join(root, 'test', 'nested', 'justATest.js');
+	const functionFile = join(src, 'hello.js');
+
+	writeJs(functionFile);
+	mkdirSync(dirname(dest), {
+		recursive: true
+	});
+
+	await utils.build({
+		src,
+		dest,
+		dts: false
+	});
+
+	const output = readFileSync(dest, 'utf8');
+
+	expect(output).toContain("import _hello from '../../src/hello.js';");
+
+});

package/types/utils/generateFile.d.ts

@@ -1,5 +1,6 @@
-export default function generateFile({ src, exportRoots, ignore, includeComments, dts, useTabs }: {
+export default function generateFile({ src, dest, exportRoots, ignore, includeComments, dts, useTabs }: {
     src: any;
+    dest: any;
     exportRoots: any;
     ignore: any;
     includeComments: any;

package/types/utils/generateImportStatements.d.ts

@@ -1,5 +1,6 @@
-export default function generateImportStatements({ fileDataList, dts, src }: {
+export default function generateImportStatements({ fileDataList, dts, src, dest }: {
     fileDataList: any;
     dts: any;
     src: any;
+    dest: any;
 }): string;