@simple-reporting/base 0.0.1

package/scripts/init.js

@@ -0,0 +1,45 @@
+import { resolve, dirname } from 'node:path';
+import fs from 'fs-extra';
+import { statSync, readFileSync, writeFileSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
+import { createRequire } from 'node:module';
+import writeJson from 'write-json';
+
+const require = createRequire(import.meta.url);
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+/**
+ * Initializes a new project in the given folder with the provided options.
+ *
+ * @param {string} folder - The path to the folder where the project will be created.
+ * @param {object} options - Additional options for the initialization process.
+ *
+ * @return {Promise<void>} - A promise that resolves when the project initialization is complete.
+ */
+async function init(folder, options) {
+  const projectPath = resolve(process.cwd(), folder);
+
+  try {
+    const stat = statSync(projectPath);
+    console.error(`Folder ${projectPath} already exist!`);
+  } catch (e) {
+    await fs.copy(resolve(__dirname, '../dev/'), projectPath).then(async () => {
+      const packageJsonFile = `${projectPath}/package.json`;
+      const packageJson = JSON.parse(await readFileSync(packageJsonFile));
+      packageJson.name = folder;
+      const writeJson = require('write-json');
+      writeJson.sync(packageJsonFile, packageJson);
+
+      await writeFileSync(
+        `${projectPath}/.gitignore`,
+        `/.output/\n/.nswow/\n/node_modules/\n/public/downloads/\n/public/html/\n/public/images/\n/public/json/\n/public/exclude/\n/dev-dist/`,
+      );
+      console.log(`Project has created`);
+      console.log(`cd ${folder}`);
+      console.log(`npm install`);
+    });
+  }
+}
+
+export { init };

package/scripts/migrate-livingdocs-build/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 mms solutions ag
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/scripts/migrate-livingdocs-build/bin/build.d.ts

@@ -0,0 +1,8 @@
+#! /usr/bin/env node
+export default build;
+/**
+ * Builds the Livingdocs design and components based on the configuration.
+ *
+ * @returns {boolean} - Indicates whether the build was successful or not.
+ */
+export function build(): boolean;

package/scripts/migrate-livingdocs-build/bin/build.js

@@ -0,0 +1,53 @@
+#! /usr/bin/env node
+import LivingdocsDesign from '../dev/livingdocs-design.js';
+import configuration from '../dev/configuration.js';
+import logger from '../dev/logger.js';
+import Build from '../dev/build.js';
+
+/**
+ * Builds the Livingdocs design and components based on the configuration.
+ *
+ * @returns {boolean} - Indicates whether the build was successful or not.
+ */
+async function build() {
+  try {
+    const designData = LivingdocsDesign.loadDesign(configuration);
+    const componentData = LivingdocsDesign.loadComponents(configuration);
+
+    if (!designData) {
+      throw {
+        message: 'design is empty',
+      };
+    }
+
+    if (!componentData) {
+      throw {
+        message: 'no components found',
+      };
+    }
+
+    if (!!designData && designData['v'] === 2) {
+      logger.info(`Building ${designData.name} on V2`);
+      Build.BuildV2(designData, componentData);
+    } else {
+      logger.info(`Building ${designData.name} on V1`);
+      Build.BuildV1(designData, componentData);
+    }
+
+    Build.zipArchive();
+  } catch (error) {
+    if (error.message) {
+      logger.error(error.message);
+    }
+
+    // show js errors
+    if (error.error) {
+      logger.error(error.error);
+    }
+  }
+
+  return true;
+}
+
+export default build;
+export { build };

package/scripts/migrate-livingdocs-build/bin/migrate.d.ts

@@ -0,0 +1,2 @@
+#! /usr/bin/env node
+export {};

package/scripts/migrate-livingdocs-build/bin/migrate.js

@@ -0,0 +1,43 @@
+#! /usr/bin/env node
+
+import configuration from '../dev/configuration.js';
+import LivingdocsDesign from '../dev/livingdocs-design.js';
+import logger from '../dev/logger.js';
+import Migrate from '../dev/migrate.js';
+
+console.log('migrate command here');
+
+try {
+  const designData = LivingdocsDesign.loadDesign(configuration);
+  const componentData = LivingdocsDesign.loadComponents(configuration);
+
+  if (!designData) {
+    throw {
+      message: 'design is empty',
+    };
+  }
+
+  if (!componentData) {
+    throw {
+      message: 'no components found',
+    };
+  }
+
+  const v2Design = Migrate.migrateDesign(designData);
+  // logger.info(JSON.stringify(v2Design));
+  const v2Components = Migrate.migrateComponents(componentData);
+
+  Migrate.writeDesign(v2Design);
+  Migrate.writeComponents(v2Components);
+
+  Migrate.writeManualReviews();
+} catch (error) {
+  if (error.message) {
+    logger.error(error.message);
+  }
+
+  // show js errors
+  if (error.error) {
+    logger.error(error.error);
+  }
+}

package/scripts/migrate-livingdocs-build/dev/build/v1.d.ts

@@ -0,0 +1,9 @@
+export default BuildV1;
+/**
+ * Builds and packages a design version.
+ *
+ * @param {object} designData - The design data object.
+ * @param {object} components - The components object.
+ * @returns {void}
+ */
+declare function BuildV1(designData: object, components: object): void;

package/scripts/migrate-livingdocs-build/dev/build/v1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v1.d.ts","sourceRoot":"","sources":["../../../../scripts/migrate-livingdocs-build/dev/build/v1.js"],"names":[],"mappings":";AAIA;;;;;;GAMG;AACH,qCAJW,MAAM,cACN,MAAM,GACJ,IAAI,CA6BhB"}

package/scripts/migrate-livingdocs-build/dev/build/v1.js

@@ -0,0 +1,51 @@
+import configuration from '../configuration.js';
+import lib from '../lib.js';
+import fs from 'fs';
+
+/**
+ * Builds and packages a design version.
+ *
+ * @param {object} designData - The design data object.
+ * @param {object} components - The components object.
+ * @returns {void}
+ */
+const BuildV1 = (designData, components) => {
+  // critical tests
+  lib.testComponentExistV1(designData, components);
+  lib.testPropertyExistV1(designData, components);
+
+  // // logs when thing is never used
+  lib.testComponentsAllUsedV1(designData, components);
+  lib.testDesignPropertiesV1(designData, components);
+
+  // // cleanup dist and dest zip
+  lib.removeFolder(configuration.build.dist);
+  lib.removeFile(configuration.build.dest + configuration.build.archiveName);
+
+  // // create and make dist
+  fs.mkdirSync(configuration.build.dist);
+
+  // // copy folders
+  configuration.build.requiredFolders.forEach((folder) => {
+    const splitPath = folder.split('/');
+    fs.cpSync(
+      folder,
+      configuration.build.dist + '/' + splitPath[splitPath.length - 1],
+      { recursive: true },
+    );
+  });
+
+  const newDesignData = lib.mergeDesignV1(designData, components);
+
+  // // write json files
+  fs.writeFileSync(
+    configuration.build.dist + '/design.json',
+    JSON.stringify(newDesignData),
+  );
+  fs.writeFileSync(
+    configuration.build.dist + '/design.js',
+    `(function () { var designJSON = ${JSON.stringify(newDesignData)}; if(typeof module !== 'undefined' && module.exports) {return module.exports = designJSON;} else { this.design = this.design || {}; this.design['${newDesignData.name}'] = designJSON;} }).call(this);`,
+  );
+};
+
+export default BuildV1;

package/scripts/migrate-livingdocs-build/dev/build/v2.d.ts

@@ -0,0 +1,2 @@
+export default BuildV2;
+declare function BuildV2(designData: any, components: any): void;

package/scripts/migrate-livingdocs-build/dev/build/v2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v2.d.ts","sourceRoot":"","sources":["../../../../scripts/migrate-livingdocs-build/dev/build/v2.js"],"names":[],"mappings":";AAIA,iEA2BC"}

package/scripts/migrate-livingdocs-build/dev/build/v2.js

@@ -0,0 +1,44 @@
+import configuration from '../configuration.js';
+import lib from '../lib.js';
+import fs from 'fs';
+
+const BuildV2 = (designData, components) => {
+  // critical tests
+  lib.testComponentExistV2(designData, components);
+  lib.testPropertyExistV2(designData, components);
+
+  // logs when thing is never used
+  lib.testComponentsAllUsedV2(designData, components);
+  lib.testDesignPropertiesV2(designData, components);
+
+  // cleanup dist and dest zip
+  lib.removeFolder(configuration.build.dist);
+  lib.removeFile(configuration.build.dest + configuration.build.archiveName);
+
+  // create and make dist
+  fs.mkdirSync(configuration.build.dist);
+
+  // copy folders
+  configuration.build.requiredFolders.forEach((folder) => {
+    const splitPath = folder.split('/');
+    fs.cpSync(
+      folder,
+      configuration.build.dist + '/' + splitPath[splitPath.length - 1],
+      { recursive: true },
+    );
+  });
+
+  const newDesignData = lib.mergeDesignV2(designData, components);
+
+  // write json files
+  fs.writeFileSync(
+    configuration.build.dist + '/design.json',
+    JSON.stringify(newDesignData),
+  );
+  fs.writeFileSync(
+    configuration.build.dist + '/design.js',
+    `(function () { var designJSON = ${JSON.stringify(newDesignData)}; if(typeof module !== 'undefined' && module.exports) {return module.exports = designJSON;} else { this.design = this.design || {}; this.design['${newDesignData.name}'] = designJSON;} }).call(this);`,
+  );
+};
+
+export default BuildV2;

package/scripts/migrate-livingdocs-build/dev/build/zip-archive.d.ts

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

package/scripts/migrate-livingdocs-build/dev/build/zip-archive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zip-archive.d.ts","sourceRoot":"","sources":["../../../../scripts/migrate-livingdocs-build/dev/build/zip-archive.js"],"names":[],"mappings":";AAKA,oCA4BC"}

package/scripts/migrate-livingdocs-build/dev/build/zip-archive.js

@@ -0,0 +1,39 @@
+import configuration from '../configuration.js';
+import fs from 'fs';
+import archiver from 'archiver';
+import logger from '../logger.js';
+
+const zipArchive = () => {
+  // zip em up
+  var output = fs.createWriteStream(
+    `${configuration.build.dest}/${configuration.build.archiveName}`,
+  );
+
+  output.on('close', function () {
+    logger.info('Archiver: ' + archive.pointer() + ' total bytes');
+    logger.info(
+      'Archiver has been finalized and the output file descriptor has closed.',
+    );
+  });
+
+  var archive = archiver('zip');
+
+  archive.on('error', (err) => {
+    logger.error(err);
+    throw {
+      message: 'failed to create archive',
+      error: err,
+    };
+    // throw err;
+  });
+
+  archive.pipe(output);
+
+  // append files from a sub-directory, putting its contents at the root of archive
+  archive.directory(configuration.build.dist, false);
+  archive.finalize();
+
+  return;
+};
+
+export default zipArchive;

package/scripts/migrate-livingdocs-build/dev/build.d.ts

@@ -0,0 +1,9 @@
+export default Build;
+declare namespace Build {
+    export { BuildV1 };
+    export { BuildV2 };
+    export { zipArchive };
+}
+import BuildV1 from './build/v1.js';
+import BuildV2 from './build/v2.js';
+import zipArchive from './build/zip-archive.js';

package/scripts/migrate-livingdocs-build/dev/build.js

@@ -0,0 +1,7 @@
+import BuildV1 from './build/v1.js';
+import BuildV2 from './build/v2.js';
+import zipArchive from './build/zip-archive.js';
+
+const Build = { BuildV1, BuildV2, zipArchive };
+
+export default Build;

package/scripts/migrate-livingdocs-build/dev/configuration-defaults.d.ts

@@ -0,0 +1,20 @@
+export default configurationDefaults;
+declare namespace configurationDefaults {
+    let configurationSelector: string;
+    namespace build {
+        let design: string;
+        let components: string;
+        let requiredFolders: string[];
+        let dist: string;
+        let dest: string;
+        let archiveName: string;
+    }
+    namespace migration {
+        let design_1: string;
+        export { design_1 as design };
+        let components_1: string;
+        export { components_1 as components };
+        let dest_1: string;
+        export { dest_1 as dest };
+    }
+}

package/scripts/migrate-livingdocs-build/dev/configuration-defaults.js

@@ -0,0 +1,18 @@
+const configurationDefaults = {
+  configurationSelector: '[type="ld-conf"]',
+  build: {
+    design: './livingdocs.config.json',
+    components: './livingdocs/**/*.html',
+    requiredFolders: ['./.output/ldd/assets'],
+    dist: './.output/livingdocs',
+    dest: './',
+    archiveName: './.output/livingdocs.zip',
+  },
+  migration: {
+    design: './livingdocs.config.json',
+    components: './livingdocs/**/*.html',
+    dest: './design-v2',
+  },
+};
+
+export default configurationDefaults;

package/scripts/migrate-livingdocs-build/dev/configuration.d.ts

@@ -0,0 +1,2 @@
+export default configuration;
+declare const configuration: any;

package/scripts/migrate-livingdocs-build/dev/configuration.js

@@ -0,0 +1,34 @@
+import configurationDefaults from './configuration-defaults.js';
+import _ from 'lodash';
+
+/*
+import fs from "fs";
+import path from "path";
+
+
+let jsonPackageConfiguration;
+const jsonpath = path.normalize(process.cwd() + "/package.json");
+
+try {
+  jsonPackageConfiguration = JSON.parse(fs.readFileSync(jsonpath).toString());
+} catch (error) {
+  throw {
+    message: "package json not found at " + jsonpath,
+    type: "error",
+    error: error,
+  };
+}
+
+const packageConfiguration = jsonPackageConfiguration["nhs-design-builder"] ? jsonPackageConfiguration["nhs-design-builder"] : {};
+
+ */
+const packageConfiguration = {};
+const configuration = _.merge(configurationDefaults, packageConfiguration);
+
+/*
+if (!!packageConfiguration?.build?.requiredFolders) {
+  configuration.build.requiredFolders = packageConfiguration.build.requiredFolders;
+}
+ */
+
+export default configuration;

package/scripts/migrate-livingdocs-build/dev/lib.d.ts

@@ -0,0 +1,33 @@
+export default lib;
+declare namespace lib {
+    export { bFileExists };
+    export { removeFolder };
+    export { removeFile };
+    export { getAllComponentPaths };
+    export { minifyHtml };
+    export { mergeDesignV1 };
+    export { mergeDesignV2 };
+    export { testComponentExistV1 };
+    export { testComponentExistV2 };
+    export { testPropertyExistV1 };
+    export { testPropertyExistV2 };
+    export { testComponentsAllUsedV1 };
+    export { testComponentsAllUsedV2 };
+    export { testDesignPropertiesV1 };
+    export { testDesignPropertiesV2 };
+}
+declare function bFileExists(path: any): any;
+declare function removeFolder(path: any): void;
+declare function removeFile(path: any): void;
+declare function getAllComponentPaths(componentPath: any): string[];
+declare function minifyHtml(s: any): any;
+declare function mergeDesignV1(designData: any, components: any): any;
+declare function mergeDesignV2(designData: any, components: any): any;
+declare function testComponentExistV1(designData: any, components: any): void;
+declare function testComponentExistV2(designData: any, components: any): boolean;
+declare function testPropertyExistV1(designData: any, components: any): void;
+declare function testPropertyExistV2(designData: any, components: any): void;
+declare function testComponentsAllUsedV1(designData: any, components: any): void;
+declare function testComponentsAllUsedV2(designData: any, components: any): void;
+declare function testDesignPropertiesV1(designData: any, components: any): void;
+declare function testDesignPropertiesV2(designData: any, components: any): void;