@simple-reporting/base 0.1.111 → 1.0.0

package/srl/plugins/viteSrlPlugin.ts

@@ -0,0 +1,214 @@
+import { type Plugin } from 'vite';
+import { fileURLToPath, URL } from 'node:url';
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path/posix';
+import { execSync } from 'node:child_process';
+import folders from '@simple-reporting/base/scripts/folders.js';
+import { beaver } from '@simple-reporting/base/scripts/beaver.js';
+import { packageName } from '@simple-reporting/base/scripts/config';
+import { updatePackageJson, updateLivingDocsJson, updateNsWowJson } from '@simple-reporting/base/scripts/utils';
+import {
+  map,
+  mapLdd,
+  mapJs,
+  mapScss,
+} from '@simple-reporting/base/scripts/build.js';
+import chalk from 'chalk';
+
+const msgBoxLength = 60;
+
+function centerText(text: string): string {
+  const padding = Math.max(0, (msgBoxLength - text.length) / 2);
+  return (
+    ' '.repeat(Math.floor(padding)) + text + ' '.repeat(Math.ceil(padding))
+  );
+}
+
+function checkSrlVersion() {
+  try {
+    const pkgPath = join(folders.packagePath, 'package.json');
+    const pkg = JSON.parse(readFileSync(pkgPath, 'utf-8'));
+    const current = pkg.version;
+    if (!current) return;
+
+    const tag = `v${current.split('.')[0]}-lts`;
+
+    const latest = execSync(`npm view ${packageName}@${tag} version`)
+      .toString()
+      .trim();
+
+    if (current < latest) {
+      console.log('');
+      console.log(chalk.bgWhiteBright(centerText('')));
+      console.log(
+        chalk.bgWhiteBright.redBright.bold(centerText('Attention !!!')),
+      );
+      console.log(
+        chalk.bgWhiteBright.black.bold(
+          centerText(`New ${packageName} version available.`),
+        ),
+      );
+      console.log(
+        chalk.bgWhiteBright.black.bold(
+          centerText(`Update: ${current} => ${latest}`),
+        ),
+      );
+      console.log(
+        chalk.bgWhiteBright.black.bold(
+          centerText(`Run: npm update -S ${packageName}`),
+        ),
+      );
+      console.log(chalk.bgWhiteBright(centerText('')));
+      console.log('');
+    }
+  } catch (e) {}
+}
+
+let timer: NodeJS.Timeout | null = null;
+
+function triggerAction(callback) {
+  !timer || clearTimeout(timer);
+  timer = setTimeout(async () => {
+    await callback();
+  }, 200);
+}
+
+async function startActions() {
+  checkSrlVersion();
+  await beaver(0);
+  await map();
+  await mapJs();
+}
+
+export default function viteSrlPlugin(): Plugin {
+  return {
+    name: 'vite-srl-plugin',
+    config(config) {
+      startActions();
+
+      config.base = './';
+
+      config.resolve = config.resolve || {};
+      config.resolve.alias['~'] = fileURLToPath(
+        new URL('../..', import.meta.url),
+      );
+      config.resolve.alias['@'] = fileURLToPath(
+        new URL('../../src', import.meta.url),
+      );
+      config.resolve.alias['#components'] = fileURLToPath(
+        new URL('../components', import.meta.url),
+      );
+      config.resolve.alias['#composables'] = fileURLToPath(
+        new URL('../composables', import.meta.url),
+      );
+      config.resolve.alias['#plugins'] = fileURLToPath(
+        new URL('../plugins', import.meta.url),
+      );
+      config.resolve.alias['#types'] = fileURLToPath(
+        new URL('../types', import.meta.url),
+      );
+      config.resolve.alias['#utils'] = fileURLToPath(
+        new URL('../utils', import.meta.url),
+      );
+      config.resolve.alias['#imports'] = fileURLToPath(
+        new URL('../imports', import.meta.url),
+      );
+      config.resolve.alias['#ld'] = fileURLToPath(
+        new URL('../../livingdocs', import.meta.url),
+      );
+      config.resolve.alias['assets'] = fileURLToPath(
+        new URL('../../src/assets', import.meta.url),
+      );
+      config.resolve.alias['srl'] = fileURLToPath(
+        new URL('../srl', import.meta.url),
+      );
+      config.resolve.alias['vue'] = 'vue/dist/vue.esm-bundler.js';
+    },
+    configureServer(server) {
+      const fontPath = join(folders.srlAssets, 'fonts');
+
+      server.watcher.on('change', async (path) => {
+        if (path.endsWith('/package.json')) {
+          await updatePackageJson();
+        }
+        if (path.endsWith('/livingdocs.config.json')) {
+          await updateLivingDocsJson();
+        }
+        if (path.endsWith('/srl.config.json')) {
+          await updateNsWowJson();
+          triggerAction(beaver);
+        }
+      });
+
+      server.watcher.on('add', (path) => {
+        if (
+          path.endsWith('/general.scss') ||
+          path.endsWith('/app.scss') ||
+          path.endsWith('/ldd.scss') ||
+          path.endsWith('/editor.scss') ||
+          path.endsWith('/pdf.scss') ||
+          path.endsWith('/word.scss') ||
+          path.endsWith('/xbrl.scss') ||
+          (
+            path.startsWith(fontPath) &&
+            path.endsWith('.scss')
+          )
+        ) {
+          triggerAction(mapScss);
+        }
+
+        if (
+          path.includes('livingdocs') &&
+          (path.endsWith('/app.js') || path.endsWith('/app.ts'))
+        ) {
+          triggerAction(mapJs);
+        }
+
+        if (
+          path.includes('livingdocs') &&
+          (path.endsWith('/properties.json') ||
+            path.endsWith('/properties.ts') ||
+            path.endsWith('/properties.js') ||
+            path.endsWith('.vue'))
+        ) {
+          triggerAction(mapLdd);
+        }
+      });
+
+      server.watcher.on('unlink', (path) => {
+        if (
+          path.endsWith('/general.scss') ||
+          path.endsWith('/app.scss') ||
+          path.endsWith('/ldd.scss') ||
+          path.endsWith('/editor.scss') ||
+          path.endsWith('/pdf.scss') ||
+          path.endsWith('/word.scss') ||
+          path.endsWith('/xbrl.scss')||
+          (
+            path.startsWith(fontPath) &&
+            path.endsWith('.scss')
+          )
+        ) {
+          triggerAction(mapScss);
+        }
+
+        if (
+          path.includes('livingdocs') &&
+          (path.endsWith('/app.js') || path.endsWith('/app.ts'))
+        ) {
+          triggerAction(mapJs);
+        }
+
+        if (
+          path.includes('livingdocs') &&
+          (path.endsWith('/properties.json') ||
+            path.endsWith('/properties.ts') ||
+            path.endsWith('/properties.js') ||
+            path.endsWith('.vue'))
+        ) {
+          triggerAction(mapLdd);
+        }
+      });
+    },
+  };
+}

package/srl/plugins/vueSrlPlugin.ts

@@ -0,0 +1,23 @@
+import { defineComponent, type App } from 'vue';
+import SrlAriaTabChain from '#components/Srl/Aria/TabChain.vue';
+import SrlArticleAutoload from '#components/Srl/Article/Autoload.vue';
+import SrlArticleRoot from '#components/Srl/Article/Root.vue';
+import SrlArticleDialogButton from '#components/Srl/Article/DialogButton.vue';
+import SrlMenu from '#components/Srl/Menu/List.vue';
+import SrlPageDialog from '#components/Srl/Page/Dialog.vue';
+import asyncLdComponent from './asyncLdComponent.ts';
+
+export default {
+  install(app: App) {
+    app.component('SrlAriaTabChain', defineComponent(SrlAriaTabChain));
+    app.component('SrlArticleAutoload', defineComponent(SrlArticleAutoload));
+    app.component('SrlArticleRoot', defineComponent(SrlArticleRoot));
+    app.component(
+      'SrlArticleDialogButton',
+      defineComponent(SrlArticleDialogButton),
+    );
+    app.component('SrlPageDialog', defineComponent(SrlPageDialog));
+    app.component('SrlMenu', defineComponent(SrlMenu));
+    asyncLdComponent(app);
+  },
+};

package/{scss → srl/scss}/colors/functions.scss

@@ -1,18 +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});
-}
+@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/helpers → srl/scss/colors}/index.scss

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

package/{scss → srl/scss}/colors/mixins.scss

@@ -1,45 +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;
-  }
-}
+@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 → srl/scss}/colors/variables.scss

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

package/srl/scss/config.scss

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

package/{scss → srl/scss}/core-styles.scss

@@ -1,22 +1,23 @@
-@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;
+@use 'config';
+@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 → srl/scss}/fonts/functions.scss

@@ -1,21 +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;
-}
+@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/colors → srl/scss/fonts}/index.scss

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

package/{scss → srl/scss}/fonts/mixins.scss

@@ -1,31 +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')}';
-        }
-      }
-    }
-  }
-}
+@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 → srl/scss}/fonts/variables.scss

@@ -1,8 +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;
+@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 → srl/scss}/grid/functions.scss

@@ -1,29 +1,49 @@
-@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);
-}
+@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);
+}
+
+@function calculate-pdf-col-span-minus-one-gutter($span) {
+  $gaps-inside: $span - 1;
+  $columns: map.get(variables.$columns, print);
+  $gutter: get-gutter-column-gap();
+
+  @return calc(
+          ((100% - (#{$columns - 1} * #{$gutter})) * #{$span} / #{$columns}) + (#{$gaps-inside} * #{$gutter})
+  );
+}
+
+@function calculate-pdf-col-span-plus-one-gutter($span) {
+  $gaps-inside: $span + 1;
+  $columns: map.get(variables.$columns, print);
+  $gutter: get-gutter-column-gap();
+
+  @return calc(
+          ((100% - (#{$columns - 1} * #{$gutter})) * #{$span} / #{$columns}) + (#{$gaps-inside} * #{$gutter})
+  );
+}

package/{scss/fonts → srl/scss/grid}/index.scss

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