@simple-reporting/base 0.0.1

package/scripts/preparePublish.js

@@ -0,0 +1,88 @@
+import { join } from 'node:path/posix';
+import { readFileSync, writeFileSync, rmSync } from 'node:fs';
+import { globSync } from 'glob';
+import writeJson from 'write-json';
+import ts from 'typescript';
+import Enquirer from 'enquirer';
+import { packageName } from './config.js';
+
+const { Input } = Enquirer;
+
+async function compile(fileNames, options) {
+  // Create a Program with an in-memory emit
+  const createdFiles = {};
+  const host = ts.createCompilerHost(options);
+  host.writeFile = (fileName, contents) => (createdFiles[fileName] = contents);
+
+  // Prepare and emit the d.ts files
+  const program = ts.createProgram(fileNames, options, host);
+  program.emit();
+
+  for (const file in createdFiles) {
+    const content = createdFiles[file];
+    await writeFileSync(file, content);
+  }
+}
+
+export async function preparePublish(version) {
+
+  if (version) {
+    const packageJson = JSON.parse(
+      await readFileSync(join(process.cwd(), 'package.json')),
+    );
+    packageJson.version = version;
+    await writeJson(join(process.cwd(), 'package.json'), packageJson);
+
+    const devJson = JSON.parse(
+      await readFileSync(join(process.cwd(), 'dev', 'package.json')),
+    );
+    devJson.dependencies[packageName] = `^${version}`;
+    await writeJson(join(process.cwd(), 'dev', 'package.json'), devJson);
+  }
+
+  const typescriptFiles = await globSync(
+    join(process.cwd(), 'scripts', '**', '*.d.ts'),
+  );
+  for (let i = 0; i < typescriptFiles.length; i++) {
+    await rmSync(typescriptFiles[i]);
+  }
+
+  const jsFiles = await globSync(join(process.cwd(), 'scripts', '**', '*.js'));
+
+  await compile(jsFiles, {
+    allowJs: true,
+    declaration: true,
+    emitDeclarationOnly: true,
+  });
+
+  const vueComponents = await globSync(
+    join(process.cwd(), 'src', '**', '*.vue'),
+  );
+  await compile(vueComponents, {
+    allowJs: true,
+    declaration: true,
+    emitDeclarationOnly: true,
+  });
+
+  return version;
+}
+
+if (import.meta.url === `file://${process.argv[1]}`) {
+  try {
+    let version = null;
+    const indexVersion = process.argv.indexOf('-v');
+    if (indexVersion !== -1 && process.argv[indexVersion + 1]) {
+      const newVersion = process.argv[indexVersion + 1];
+      if (/^\d+\.\d+\.\d+$/.test(newVersion)) {
+        version = newVersion;
+      } else {
+        throw new Error(
+          `Invalid version format ${newVersion}. Use $number.$number.$number`,
+        );
+      }
+    }
+    preparePublish(version);
+  } catch (error) {
+    console.error(error);
+  }
+}

package/scripts/renamePackage.d.ts

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

package/scripts/renamePackage.js

@@ -0,0 +1,48 @@
+import fs from 'fs';
+import path from 'path';
+
+const search = '@multivisio/nswow';
+const replace = '@simple-reporting/base';
+const CWD = process.cwd();
+const excludes = [
+  'scripts/renamePackage.js',
+  'scripts/renamePackage.d.ts',
+  '.git',
+  'node_modules',
+  'test-data',
+];
+
+const excludePaths = [...excludes.map((f) => path.join(CWD, ...f.split('/')))];
+
+function replaceInFile(filePath) {
+  const content = fs.readFileSync(filePath, 'utf8');
+  if (content.includes(search)) {
+    const newContent = content.split(search).join(replace);
+    fs.writeFileSync(filePath, newContent, 'utf8');
+    console.log(`Replaced in: ${filePath}`);
+  }
+}
+
+function walkDir(dir) {
+  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+    const fullPath = path.join(dir, entry.name);
+    if (excludePaths.includes(fullPath)) continue;
+    if (entry.isDirectory()) {
+      console.log(fullPath);
+      walkDir(fullPath);
+    } else if (entry.isFile()) {
+      console.log(fullPath);
+      replaceInFile(fullPath);
+    }
+  }
+}
+
+export function renamePackages(startDir = process.cwd()) {
+  console.log(`Starting to rename packages from "${search}" to "${replace}"`);
+  walkDir(startDir);
+  console.log('Done!');
+}
+
+if (import.meta.url === `file://${process.argv[1]}`) {
+  renamePackages();
+}

package/scripts/utils.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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.
+ */
+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.
+ */
+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.
+ */
+export function writePackageJson(config: any): 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.
+ */
+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.
+ */
+export function writeLivingDocsJson(config: any): Promise<boolean>;
+/**
+ * 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.
+ */
+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.
+ */
+export function writeNsWowJson(config: any): boolean;
+export { writeJson };

package/scripts/utils.js

@@ -0,0 +1,106 @@
+import { resolve } from 'node:path';
+import { readFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
+
+const require = createRequire(import.meta.url);
+/**
+ * A module for writing JSON data to a file.
+ *
+ * @module writeJson
+ */
+const writeJson = require('write-json');
+
+/**
+ * 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.
+ */
+function lddGroupNames(name) {
+  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.
+ */
+async function readPackageJson() {
+  const file = resolve(process.cwd(), './package.json');
+  return JSON.parse(await readFileSync(file));
+}
+
+/**
+ * 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.
+ */
+async function writePackageJson(config) {
+  if (config) {
+    const file = resolve(process.cwd(), './package.json');
+    writeJson.sync(file, config);
+  }
+  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.
+ */
+async function readLivingDocsJson() {
+  const file = resolve(process.cwd(), './livingdocs.config.json');
+  return JSON.parse(await readFileSync(file));
+}
+
+/**
+ * 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.
+ */
+async function writeLivingDocsJson(config) {
+  if (config) {
+    const file = resolve(process.cwd(), './livingdocs.config.json');
+    writeJson.sync(file, config);
+  }
+  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.
+ */
+async function readNsWowJson() {
+  const file = resolve(process.cwd(), './nswow.config.json');
+  return JSON.parse(await readFileSync(file));
+}
+
+/**
+ * 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.
+ */
+async function writeNsWowJson(config) {
+  if (config) {
+    const file = resolve(process.cwd(), './nswow.config.json');
+    writeJson.sync(file, config);
+  }
+  return true;
+}
+
+export {
+  writeJson,
+  lddGroupNames,
+  readPackageJson,
+  writePackageJson,
+  readLivingDocsJson,
+  writeLivingDocsJson,
+  readNsWowJson,
+  writeNsWowJson,
+};

package/scripts/vite.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Configures the nswow-watcher for the server to monitor changes in specific files.
+ * When a change, add, or unlink event is triggered, corresponding actions are executed.
+ *
+ * @param {Object} server - The server object.
+ */
+export function nswowWatcher(): {
+    name: string;
+    configureServer(server: any): void;
+};

package/scripts/vite.js

@@ -0,0 +1,58 @@
+import { beaver } from './beaver.js';
+import { map, mapLdd, mapJs } from './build.js';
+
+/**
+ * Configures the nswow-watcher for the server to monitor changes in specific files.
+ * When a change, add, or unlink event is triggered, corresponding actions are executed.
+ *
+ * @param {Object} server - The server object.
+ */
+function nswowWatcher() {
+  return {
+    name: 'nswow-watcher',
+    configureServer(server) {
+      server.watcher.on('change', (path) => {
+        if (path.endsWith('/nswow.config.json')) {
+          beaver();
+        }
+
+        if (path.endsWith('/properties.json')) {
+          mapLdd();
+        }
+      });
+      server.watcher.on('add', (path) => {
+        if (
+          path.endsWith('/general.scss') ||
+          path.endsWith('/app.scss') ||
+          path.endsWith('/ldd.scss') ||
+          path.endsWith('/pdf.scss') ||
+          path.endsWith('/word.scss')
+        ) {
+          map();
+        }
+
+        if (path.endsWith('/app.js') || path.endsWith('/app.ts')) {
+          mapJs();
+        }
+      });
+      server.watcher.on('unlink', (path) => {
+        if (
+          path.endsWith('/general.scss') ||
+          path.endsWith('/app.scss') ||
+          path.endsWith('/ldd.scss') ||
+          path.endsWith('/pdf.scss') ||
+          path.endsWith('/word.scss') ||
+          path.endsWith('/properties.json')
+        ) {
+          map();
+        }
+
+        if (path.endsWith('/app.js') || path.endsWith('/app.ts')) {
+          mapJs();
+        }
+      });
+    },
+  };
+}
+
+export { nswowWatcher };

package/scss/colors/functions.scss

@@ -0,0 +1,18 @@
+@use 'sass:map';
+@use 'variables';
+@use '../system';
+
+@function get($colorName, $media: false) {
+  @if not map.has-key(variables.$colors, $colorName) {
+    @error "Invalid color \"#{$colorName}\" specified! Choose one of #{map.keys(variables.$colors)}";
+  }
+
+  @if $media {
+    @return var(
+      --#{variables.$variable-prefix}color-#{$colorName}-#{$media},
+      var(--#{variables.$variable-prefix}color-#{$colorName})
+    );
+  }
+
+  @return var(--#{variables.$variable-prefix}color-#{$colorName});
+}

package/scss/colors/index.scss

@@ -0,0 +1,3 @@
+@forward 'variables';
+@forward 'functions';
+@forward 'mixins';

package/scss/colors/mixins.scss

@@ -0,0 +1,45 @@
+@use 'sass:map';
+@use 'sass:string';
+@use 'variables';
+@use 'functions';
+@use '../system';
+
+@mixin set($colorName, $value, $media: false) {
+  @if not map.has-key(variables.$colors, $colorName) {
+    @error "Invalid color \"#{$colorName}\" specified! Choose one of #{map.keys(variables.$colors)}";
+  }
+  @if $media {
+    --#{variables.$variable-prefix}color-#{"" + $colorName}-#{$media}: #{$value};
+  } @else {
+    --#{variables.$variable-prefix}color-#{"" + $colorName}: #{$value};
+  }
+}
+
+@each $colorName, $colors in variables.$colors {
+  @include system.add-root-style(
+    #{variables.$variable-prefix}color-#{'' + $colorName},
+    map.get($colors, color)
+  );
+}
+
+@mixin core-styles {
+  @at-root {
+    @each $colorName, $colors in variables.$colors {
+      .#{variables.$class-prefix}color-#{'' + $colorName} {
+        color: functions.get($colorName);
+      }
+      $onKey: 'on-' + $colorName;
+      @if string.index($colorName, 'on-') != 1 {
+        .#{variables.$class-prefix}bg-#{'' + $colorName} {
+          background-color: functions.get($colorName);
+          @if map.has-key(variables.$colors, $onKey) {
+            color: functions.get($onKey);
+          }
+        }
+      }
+    }
+  }
+  .#{variables.$class-prefix}bg-transparent {
+    background-color: transparent;
+  }
+}

package/scss/colors/variables.scss

@@ -0,0 +1,6 @@
+@use '../system';
+
+$variable-prefix: system.$variable-prefix !default;
+$class-prefix: system.$class-prefix !default;
+
+$colors: () !default;

package/scss/config.scss

@@ -0,0 +1,7 @@
+@use '@simple-reporting/base/scss/system/variables' as systemVariables;
+@use '@simple-reporting/base/scss/meta/variables' as metaVariables;
+@use '@simple-reporting/base/scss/grid/variables' as gridVariables;
+@use '@simple-reporting/base/scss/colors/variables' as colorsVariables;
+@use '@simple-reporting/base/scss/typography/variables' as typographyVariables;
+@use '@simple-reporting/base/scss/spacer/variables' as spacerVariables;
+@use '@simple-reporting/base/scss/helpers/variables' as helpersVariables;

package/scss/core-styles.scss

@@ -0,0 +1,22 @@
+@use 'index';
+@use 'system/root';
+
+@use 'modern-css-reset';
+
+h5,
+h6,
+ol,
+ul,
+li {
+  margin: 0;
+}
+
+@include root.core-styles;
+@include index.core-styles;
+@include index.system-core-styles;
+@include index.fonts-core-styles;
+@include index.grid-core-styles;
+@include index.colors-core-styles;
+@include index.typography-core-styles;
+@include index.spacer-core-styles;
+@include index.helpers-core-styles;

package/scss/fonts/functions.scss

@@ -0,0 +1,21 @@
+@use 'variables';
+@use 'sass:map';
+
+@function is($font) {
+  @return map.has-key(variables.$fonts, $font);
+}
+
+@function get($font) {
+  @if not map.has-key(variables.$fonts, $font) {
+    @error "Invalid font for fonts specified! Choose one of #{map.keys(variables.$fonts)}";
+  }
+  @return map.get(variables.$fonts, $font);
+}
+
+@function is-default() {
+  @return variables.$default-font != '';
+}
+
+@function get-default() {
+  @return variables.$default-font;
+}

package/scss/fonts/index.scss

@@ -0,0 +1,3 @@
+@forward 'variables';
+@forward 'functions';
+@forward 'mixins';

package/scss/fonts/mixins.scss

@@ -0,0 +1,31 @@
+@use 'sass:map';
+@use 'variables';
+@use '../system';
+
+@mixin core-styles {
+  @each $font-family, $valFontFamily in variables.$fonts {
+    @each $index, $font in map.get($valFontFamily, 'types') {
+      $font-types: ();
+      @each $format, $file in map.get($font, 'src') {
+        $font-types: append(
+          $font-types,
+          'url("#{variables.$font-base-path}/#{$font-family}/#{$file}") format("#{$format}")',
+          comma
+        );
+      }
+      @font-face {
+        font-family: '#{$font-family}';
+        src: #{$font-types};
+        @if map.has-key($font, 'font-weight') {
+          font-weight: map.get($font, 'font-weight');
+        }
+        @if map.has-key($font, 'font-style') {
+          font-style: '#{map.get($font, 'font-style')}';
+        }
+        @if map.has-key($font, 'font-display') {
+          font-display: '#{map.get($font, 'font-display')}';
+        }
+      }
+    }
+  }
+}

package/scss/fonts/variables.scss

@@ -0,0 +1,8 @@
+@use '../system';
+
+$class-prefix: system.$class-prefix !default;
+$variable-prefix: system.$variable-prefix !default;
+
+$font-base-path: '' !default;
+$default-font: '' !default;
+$fonts: () !default;

package/scss/grid/functions.scss

@@ -0,0 +1,29 @@
+@use 'sass:map';
+@use 'variables';
+
+@function get-container-max-width() {
+  @return var(--#{variables.$variable-prefix}container-max-width, 0);
+}
+
+@function get-container-padding() {
+  @return var(--#{variables.$variable-prefix}container-padding, 0);
+}
+
+@function get-breakpoint($breakpoint) {
+  @if not map.has-key(variables.$breakpoints, $breakpoint) {
+    @error "Invalid breakpoint for container specified! Choose one of #{map.keys(variables.$breakpoints)}";
+  }
+  @return var(--#{variables.$variable-prefix}-breakpoint-#{$breakpoint});
+}
+
+@function get-gutter-columns() {
+  @return var(--#{variables.$variable-prefix}gutter-columns);
+}
+
+@function get-gutter-row-gap() {
+  @return var(--#{variables.$variable-prefix}gutter-row-gap);
+}
+
+@function get-gutter-column-gap() {
+  @return var(--#{variables.$variable-prefix}gutter-column-gap);
+}

package/scss/grid/index.scss

@@ -0,0 +1,3 @@
+@forward 'variables';
+@forward 'functions';
+@forward 'mixins';