@simple-reporting/base 0.1.112 → 1.0.0

package/scripts/ldd/mapLdd.js

@@ -0,0 +1,204 @@
+import { join } from 'node:path/posix';
+import { glob, globSync } from 'glob';
+import { createRequire } from 'node:module';
+import folders from '../folders.js';
+import {
+  readdirSync,
+  readFileSync,
+  rmSync,
+  statSync,
+  writeFileSync,
+} from 'node:fs';
+import {
+  lddGroupNames,
+  readLivingDocsJson,
+  writeLivingDocsJson,
+} from '../utils.js';
+import { createLogger } from 'vite';
+
+const logger = createLogger();
+const require = createRequire(import.meta.url);
+
+export async function mapLdd() {
+  const lddJson = await readLivingDocsJson();
+
+  await mapGroups(lddJson);
+  await mapComponents(lddJson);
+  await mapProperties(lddJson);
+
+  await writeLivingDocsJson();
+}
+
+/**
+ * map all properties.{json,js,ts} declarations
+ * @returns {Promise<void>}
+ */
+async function mapProperties(lddJson) {
+  const propertiesFiles = await glob(
+    join(folders.ld, '**', 'properties.{json,js,ts}'),
+  );
+  const mapProperties = {};
+
+  for (let i = 0; i < propertiesFiles.length; i++) {
+    const file = propertiesFiles[i];
+    if (file.endsWith('.js') || file.endsWith('.ts')) {
+      const properties = require(propertiesFiles[i]).default;
+      const oKeys = Object.keys(properties);
+
+      for (let j = 0; j < oKeys.length; j++) {
+        mapProperties[oKeys[j]] = properties[oKeys[j]];
+      }
+    } else if (file.endsWith('.json')) {
+      const properties = JSON.parse(readFileSync(propertiesFiles[i]));
+      const oKeys = Object.keys(properties);
+      for (let j = 0; j < oKeys.length; j++) {
+        mapProperties[oKeys[j]] = properties[oKeys[j]];
+      }
+    }
+  }
+
+  lddJson.componentProperties = mapProperties;
+}
+
+/**
+ * map group / component folder structure to design configuration
+ * @param {*} lddJson
+ * @returns
+ */
+async function mapGroups(lddJson) {
+  const groupsPath = folders.ld;
+  const groups = readdirSync(groupsPath);
+
+  lddJson.groups = [];
+
+  for (let x = 0; x < groups.length; x++) {
+    const group = groups[x];
+    const groupName = lddGroupNames(group);
+
+    try {
+      const groupFolderPath = join(groupsPath, group);
+      const stat = statSync(groupFolderPath);
+
+      if (stat.isDirectory()) {
+        const components = getGroupComponents(groupFolderPath);
+          lddJson.groups.push({
+            label: groupName,
+            components: components,
+          });
+      } else {
+        rmSync(groupFolderPath);
+      }
+    } catch (error) {
+      logger.error(e);
+      return false;
+    }
+  }
+}
+
+/**
+ * load and map all ld-conf.json + component.html to component configuration
+ * @param {path} groupFolderPath
+ * @returns {string[]}
+ */
+function getGroupComponents(groupFolderPath) {
+  const componentFolders = readdirSync(groupFolderPath);
+  const components = [];
+
+  for (let j = 0; j < componentFolders.length; j++) {
+    const component = componentFolders[j];
+
+    try {
+      const htmlPath = globSync(join(groupFolderPath, component, `*.html`));
+      const ldConfPath = join(groupFolderPath, component, `ld-conf.json`);
+
+      const htmlStat = statSync(htmlPath[0]);
+      const ldConfStat = statSync(ldConfPath);
+
+      const arrComponent = component.split('.');
+      if (arrComponent.length > 1) {
+        arrComponent.shift()
+      }
+      components.push(arrComponent.join('.'));
+    } catch (e) {}
+  }
+
+  return components;
+}
+
+async function mapComponents(lddJson) {
+  const groupsPath = folders.ld;
+  const groups = readdirSync(groupsPath);
+
+  const lddComponents = [];
+  const vueComponents = [];
+
+  for (let groupIndex = 0; groupIndex < groups.length; groupIndex++) {
+    const group = groups[groupIndex];
+
+    const groupPath = join(groupsPath, group);
+    const components = readdirSync(groupPath);
+
+    components.forEach((component) => {
+      // ldd static component
+      try {
+        const htmlFile =  globSync(join(groupPath, component, '*.html'));
+        if (htmlFile.length) {
+          const htmlPath = htmlFile[0];
+          const ldConfPath = join(groupPath, component, `ld-conf.json`);
+          const ldConfStat = statSync(ldConfPath);
+
+          const componentDeclaration = JSON.parse(
+            readFileSync(ldConfPath, { encoding: 'utf-8' }),
+          );
+          const componentHtml = readFileSync(htmlPath, { encoding: 'utf-8' });
+
+          lddComponents.push({ ...componentDeclaration, html: componentHtml });
+        }
+      } catch (error) {}
+
+      //   vue async component
+      try {
+        const vueFiles = globSync(join(groupPath, component, '*.vue'));
+        if (vueFiles.length) {
+          vueFiles.forEach( c => {
+            const vueName = c.split('/').pop().substring(0, -4);
+            vueComponents.push({
+              name: `SrlLd${toUpperCamelCase(vueName)}`,
+              path: join('#ld', group, component, `${vueName}.vue`),
+            });
+          })
+        }
+      } catch (error) {}
+    });
+  }
+
+  // write ldd components
+  lddJson.components = lddComponents;
+
+  // write async components
+  const asyncComponents = [
+    `import { defineAsyncComponent } from 'vue'`,
+    `export default function asyncLdComponent(app) {`,
+  ];
+
+  for (let i = 0; i < vueComponents.length; i++) {
+    const component = vueComponents[i];
+    asyncComponents.push(
+      ` app.component('${component.name}', defineAsyncComponent(() => import('${component.path}')))`,
+    );
+  }
+
+  asyncComponents.push('}');
+
+  writeFileSync(
+    join(folders.srlPlugins, 'asyncLdComponent.ts'),
+    asyncComponents.join('\n'),
+  );
+}
+
+function toUpperCamelCase(input) {
+  return input
+    .split('-')
+    .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+    .join('');
+}

package/scripts/prepare.d.ts

@@ -0,0 +1,2 @@
+export default prepare;
+declare function prepare(): void;

package/scripts/prepare.js

@@ -0,0 +1,66 @@
+import folders from './folders.js';
+import fs from 'fs';
+import path from 'path/posix';
+
+const tsConfigIncludes = [
+  '.srl/**/*',
+  '.srl/**/*.d.ts',
+  '.srl/**/*.vue',
+  'livingdocs/**/*',
+  'livingdocs/**/*.vue',
+];
+
+const tsConfigPaths = {
+  '@/*': ['./src/*'],
+  '~/*': ['./*'],
+  '#srl': ['./.srl'],
+  '#srl/*': ['./.srl/*'],
+  '#components': ['./.srl/components'],
+  '#components/*': ['./.srl/components/*'],
+  '#composables': ['./.srl/composables'],
+  '#composables/*': ['./.srl/composables/*'],
+  '#utils': ['./.srl/utils'],
+  '#utils/*': ['./.srl/utils/*'],
+  '#plugins': ['./.srl/plugins'],
+  '#plugins/*': ['./.srl/plugins/*'],
+  '#types': ['./.srl/types'],
+  '#types/*': ['./.srl/types/*'],
+  '#imports': ['./.srl/imports'],
+  '#imports/*': ['./.srl/imports/*'],
+  '#ld': ['./livingdocs'],
+  '#ld/*': ['./livingdocs/*'],
+  assets: ['./src/assets'],
+  'assets/*': ['./src/assets/*'],
+  srl: ['./.srl/srl'],
+  'srl/*': ['./.srl/srl/*'],
+};
+
+function prepare() {
+  if (fs.existsSync(folders.srlRoot)) {
+    fs.rmSync(folders.srlRoot, { recursive: true, force: true });
+  }
+  fs.cpSync(folders.packageSrl, folders.srlRoot, { recursive: true });
+
+  const tsConfigPath = path.join(folders.root, 'tsconfig.app.json');
+  if (fs.existsSync(tsConfigPath)) {
+    const tsConfig = JSON.parse(fs.readFileSync(tsConfigPath, 'utf-8'));
+
+    const mergedIncludes = [
+      ...(tsConfig.include || []),
+      ...tsConfigIncludes.filter((i) => !(tsConfig.include || []).includes(i)),
+    ];
+    tsConfig.include = tsConfig.include || [];
+    tsConfig.include = mergedIncludes;
+
+    const mergedPaths = {
+      ...(tsConfig.compilerOptions?.paths || {}),
+      ...tsConfigPaths,
+    };
+    tsConfig.compilerOptions = tsConfig.compilerOptions || {};
+    tsConfig.compilerOptions.paths = mergedPaths;
+
+    fs.writeFileSync(tsConfigPath, JSON.stringify(tsConfig, null, 2));
+  }
+}
+
+export default prepare;

package/scripts/preparePublish.d.ts

@@ -1 +1 @@
-export function preparePublish(version: any): Promise<any>;
+export function preparePublish(version?: any): Promise<any>;

package/scripts/preparePublish.js

@@ -5,6 +5,7 @@ import writeJson from 'write-json';
 import ts from 'typescript';
 import Enquirer from 'enquirer';
 import { packageName } from './config.js';
+import { getPackageVersion } from './utils.js';
 
 const { Input } = Enquirer;
 
@@ -24,7 +25,39 @@ async function compile(fileNames, options) {
   }
 }
 
-export async function preparePublish(version) {
+export async function preparePublish(version = null) {
+  try {
+    if (version === null) {
+      const packageVersion = await getPackageVersion(packageName);
+
+      const currentVersion = packageVersion.split('.');
+      let major = parseInt(currentVersion[0]);
+      let minor = parseInt(currentVersion[1]);
+      let patch = parseInt(currentVersion[2]);
+
+      if (process.argv.includes('major')) {
+        major++;
+        minor = 0;
+        patch = 0;
+      } else if (process.argv.includes('minor')) {
+        minor++;
+        patch = 0;
+      } else {
+        patch++;
+      }
+
+      version = `${major}.${minor}.${patch}`;
+
+      const prompt = new Input({
+        message: 'Package version',
+        initial: version,
+      });
+      version = await prompt.run();
+    }
+  } catch (error) {
+    console.error('Error during preparePublish:', error);
+    return;
+  }
 
   if (version) {
     const packageJson = JSON.parse(

package/scripts/renamePackage.d.ts

@@ -1 +1 @@
-export function renamePackages(startDir?: any): void;
+export function renamePackages(startDir?: string): void;

package/scripts/utils.d.ts

@@ -1,49 +1,64 @@
 /**
- * Replaces underscore (_) placeholders with spaces and replaces '_and_' with a forward slash (/) separator.
- *
- * @param {string} name - The name to modify.
- * @return {string} The modified name with replaced placeholders.
+ * Formats a group name for Livingdocs.
+ * @param {string} name - The original group name.
+ * @returns {string} The formatted group name.
  */
 export function lddGroupNames(name: string): string;
 /**
- * Reads the contents of the package.json file.
- *
- * @returns {Promise<Object>} A Promise that resolves to the parsed contents of the package.json file.
+ * Reads and caches the package.json file.
+ * @returns {Promise<Object>} The parsed package.json object.
+ */
+export function updatePackageJson(): Promise<any>;
+/**
+ * Returns the cached package.json object or reads it if not cached.
+ * @returns {Promise<Object>} The package.json object.
  */
 export function readPackageJson(): Promise<any>;
 /**
- * Writes a package.json file with the given configuration object.
- *
- * @param {Object} config - The configuration object for the package.json file.
- * @return {Boolean} - Returns true if the package.json file is successfully written, else returns false.
+ * Writes the current package.json object to the file.
+ * @returns {Promise<boolean>} True if successful.
  */
-export function writePackageJson(config: any): boolean;
+export function writePackageJson(): Promise<boolean>;
 /**
- * Reads the contents of the "livingdocs.config.json" file and returns the parsed JSON.
- *
- * @return {Promise<Object>} A promise that resolves to the parsed JSON from the file.
+ * Reads and caches the livingdocs.config.json file.
+ * @returns {Promise<Object>} The parsed livingdocs.config.json object.
+ */
+export function updateLivingDocsJson(): Promise<any>;
+/**
+ * Returns the cached livingdocs.config.json object or reads it if not cached.
+ * @returns {Promise<Object>} The livingdocs.config.json object.
  */
 export function readLivingDocsJson(): Promise<any>;
 /**
- * Writes the given configuration object to a JSON file.
- *
- * @param {Object} config - The configuration object to write.
- * @returns {Promise<boolean>} - A Promise that resolves to true if the file was successfully written, otherwise false.
+ * Writes the current livingdocs.config.json object to the file.
+ * @returns {Promise<boolean>} True if successful.
+ */
+export function writeLivingDocsJson(): Promise<boolean>;
+/**
+ * Reads and caches the srl.config.json file.
+ * @returns {Promise<Object>} The parsed srl.config.json object.
  */
-export function writeLivingDocsJson(config: any): Promise<boolean>;
+export function updateNsWowJson(): Promise<any>;
 /**
- * Reads the contents of the `nswow.config.json` file and returns the parsed JSON object.
- *
- * @returns {Promise<Object>} - Resolves to the parsed JSON object from the `nswow.config.json` file.
+ * Returns the cached srl.config.json object or reads it if not cached.
+ * @returns {Promise<Object>} The srl.config.json object.
  */
 export function readNsWowJson(): Promise<any>;
 /**
- * Writes the given configuration object to an nswow.config.json file.
- * If no configuration object is provided, the method does nothing.
- *
- * @param {Object} config - The configuration object to write.
- *
- * @return {boolean} - Returns true if the configuration was successfully written, otherwise false.
+ * Writes the current srl.config.json object to the file.
+ * @returns {Promise<boolean>} True if successful.
+ */
+export function writeNsWowJson(): Promise<boolean>;
+/**
+ * Converts a string to camelCase.
+ * @param {string} str - The input string.
+ * @returns {string} The camelCase string.
+ */
+export function camelCase(str: string): string;
+/**
+ * Gets the version of an npm package.
+ * @param {string} packageName - The name of the npm package.
+ * @returns {Promise<string>} The package version.
  */
-export function writeNsWowJson(config: any): boolean;
+export function getPackageVersion(packageName: string): Promise<string>;
 export { writeJson };

package/scripts/utils.js

@@ -1,106 +1,163 @@
-import { resolve } from 'node:path';
+import { join } from 'node:path/posix';
 import { readFileSync } from 'node:fs';
 import { createRequire } from 'node:module';
+import { exec } from 'child_process';
 
 const require = createRequire(import.meta.url);
-/**
- * A module for writing JSON data to a file.
- *
- * @module writeJson
- */
+
 const writeJson = require('write-json');
 
+const data = {
+  packageJson: null,
+  livingDocsJson: null,
+  nsWowJson: null,
+}
+
 /**
- * Replaces underscore (_) placeholders with spaces and replaces '_and_' with a forward slash (/) separator.
- *
- * @param {string} name - The name to modify.
- * @return {string} The modified name with replaced placeholders.
+ * Formats a group name for Livingdocs.
+ * @param {string} name - The original group name.
+ * @returns {string} The formatted group name.
  */
 function lddGroupNames(name) {
+  const arrName = name.split('.');
+  if (arrName.length > 1) {
+    arrName.shift();
+    name = arrName.join('.');
+  }
   return name.replace('_and_', ' / ').replace('_', ' ');
 }
 
 /**
- * Reads the contents of the package.json file.
- *
- * @returns {Promise<Object>} A Promise that resolves to the parsed contents of the package.json file.
+ * Reads and caches the package.json file.
+ * @returns {Promise<Object>} The parsed package.json object.
+ */
+async function updatePackageJson() {
+  data.packageJson = JSON.parse(
+    await readFileSync(
+      join(process.cwd(), 'package.json')
+    )
+  );
+  return data.packageJson;
+}
+
+/**
+ * Returns the cached package.json object or reads it if not cached.
+ * @returns {Promise<Object>} The package.json object.
  */
 async function readPackageJson() {
-  const file = resolve(process.cwd(), './package.json');
-  return JSON.parse(await readFileSync(file));
+  return data.packageJson || updatePackageJson();
 }
 
 /**
- * Writes a package.json file with the given configuration object.
- *
- * @param {Object} config - The configuration object for the package.json file.
- * @return {Boolean} - Returns true if the package.json file is successfully written, else returns false.
+ * Writes the current package.json object to the file.
+ * @returns {Promise<boolean>} True if successful.
  */
-async function writePackageJson(config) {
-  if (config) {
-    const file = resolve(process.cwd(), './package.json');
-    writeJson.sync(file, config);
-  }
+async function writePackageJson() {
+  const file = join(process.cwd(), 'package.json');
+  await writeJson.sync(file, data.packageJson);
   return true;
 }
 
 /**
- * Reads the contents of the "livingdocs.config.json" file and returns the parsed JSON.
- *
- * @return {Promise<Object>} A promise that resolves to the parsed JSON from the file.
+ * Reads and caches the livingdocs.config.json file.
+ * @returns {Promise<Object>} The parsed livingdocs.config.json object.
+ */
+async function updateLivingDocsJson() {
+  data.livingDocsJson = JSON.parse(
+    await readFileSync(
+      join(process.cwd(), 'livingdocs.config.json')
+    )
+  );
+  return data.livingDocsJson;
+}
+
+/**
+ * Returns the cached livingdocs.config.json object or reads it if not cached.
+ * @returns {Promise<Object>} The livingdocs.config.json object.
  */
 async function readLivingDocsJson() {
-  const file = resolve(process.cwd(), './livingdocs.config.json');
-  return JSON.parse(await readFileSync(file));
+  return data.livingDocsJson || updateLivingDocsJson();
 }
 
 /**
- * Writes the given configuration object to a JSON file.
- *
- * @param {Object} config - The configuration object to write.
- * @returns {Promise<boolean>} - A Promise that resolves to true if the file was successfully written, otherwise false.
+ * Writes the current livingdocs.config.json object to the file.
+ * @returns {Promise<boolean>} True if successful.
  */
-async function writeLivingDocsJson(config) {
-  if (config) {
-    const file = resolve(process.cwd(), './livingdocs.config.json');
-    writeJson.sync(file, config);
-  }
+async function writeLivingDocsJson() {
+  const file = join(process.cwd(), 'livingdocs.config.json');
+  await writeJson.sync(file, data.livingDocsJson);
   return true;
 }
 
 /**
- * Reads the contents of the `nswow.config.json` file and returns the parsed JSON object.
- *
- * @returns {Promise<Object>} - Resolves to the parsed JSON object from the `nswow.config.json` file.
+ * Reads and caches the srl.config.json file.
+ * @returns {Promise<Object>} The parsed srl.config.json object.
+ */
+async function updateNsWowJson() {
+  data.nsWowJson = JSON.parse(
+    await readFileSync(
+      join(process.cwd(), 'srl.config.json')
+    )
+  );
+  return data.nsWowJson;
+}
+
+/**
+ * Returns the cached srl.config.json object or reads it if not cached.
+ * @returns {Promise<Object>} The srl.config.json object.
  */
 async function readNsWowJson() {
-  const file = resolve(process.cwd(), './nswow.config.json');
-  return JSON.parse(await readFileSync(file));
+  return data.nsWowJson || updateNsWowJson();
 }
 
 /**
- * Writes the given configuration object to an nswow.config.json file.
- * If no configuration object is provided, the method does nothing.
- *
- * @param {Object} config - The configuration object to write.
- *
- * @return {boolean} - Returns true if the configuration was successfully written, otherwise false.
+ * Writes the current srl.config.json object to the file.
+ * @returns {Promise<boolean>} True if successful.
  */
-async function writeNsWowJson(config) {
-  if (config) {
-    const file = resolve(process.cwd(), './nswow.config.json');
-    writeJson.sync(file, config);
-  }
+async function writeNsWowJson() {
+  const file = join(process.cwd(), 'srl.config.json');
+  await writeJson.sync(file, data.nsWowJson);
   return true;
 }
 
+/**
+ * Converts a string to camelCase.
+ * @param {string} str - The input string.
+ * @returns {string} The camelCase string.
+ */
+function camelCase(str) {
+  return str.replace(/[._-](\w|$)/g, (_, x) => x.toUpperCase());
+}
+
+/**
+ * Gets the version of an npm package.
+ * @param {string} packageName - The name of the npm package.
+ * @returns {Promise<string>} The package version.
+ */
+function getPackageVersion(packageName) {
+  return new Promise((resolve, reject) => {
+    exec(`npm view ${packageName} version`, (error, stdout, stderr) => {
+      let version = stdout.trim();
+      if (version === '') {
+        version = '0.0.0';
+      }
+      resolve(version);
+    });
+  });
+}
+
 export {
   writeJson,
   lddGroupNames,
+  updatePackageJson,
   readPackageJson,
   writePackageJson,
+  updateLivingDocsJson,
   readLivingDocsJson,
   writeLivingDocsJson,
+  updateNsWowJson,
   readNsWowJson,
   writeNsWowJson,
-};
+  camelCase,
+  getPackageVersion,
+};