@simple-reporting/base 0.1.111 → 1.0.0

package/dev/tsconfig.app.json

@@ -1,16 +1,13 @@
-{
-  "extends": "@vue/tsconfig/tsconfig.dom.json",
-  "include": ["env.d.ts", "src/**/*", "src/**/*.vue"],
-  "exclude": ["src/**/__tests__/*"],
-  "compilerOptions": {
-    "composite": true,
-    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
-
-    "baseUrl": ".",
-    "paths": {
-      "@/*": ["./src/*"],
-      "nswow": ["./nswow"],
-      "nswow/*": ["./nswow/*"]
-    }
-  }
-}
+{
+  "extends": "@vue/tsconfig/tsconfig.dom.json",
+  "include": ["env.d.ts", "src/**/*", "src/**/*.vue"],
+  "exclude": ["src/**/__tests__/*"],
+  "compilerOptions": {
+    "composite": true,
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  }
+}

package/dev/tsconfig.node.json

@@ -1,19 +1,20 @@
-{
-  "extends": "@tsconfig/node22/tsconfig.json",
-  "include": [
-    "vite.config.*",
-    "vitest.config.*",
-    "cypress.config.*",
-    "nightwatch.conf.*",
-    "playwright.config.*"
-  ],
-  "compilerOptions": {
-    "composite": true,
-    "noEmit": true,
-    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
-
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "types": ["node"]
-  }
-}
+{
+  "extends": "@tsconfig/node22/tsconfig.json",
+  "include": [
+    "vite.config.*",
+    "vitest.config.*",
+    "cypress.config.*",
+    "nightwatch.conf.*",
+    "playwright.config.*"
+  ],
+
+  "compilerOptions": {
+    "composite": true,
+    "noEmit": true,
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "types": ["node"]
+  }
+}

package/dev/vite.config.ts

@@ -1,27 +1,18 @@
-import { defineConfig } from 'vite'
-import vue from '@vitejs/plugin-vue'
-import VueDevTools from 'vite-plugin-vue-devtools'
-import { fileURLToPath, URL } from 'node:url'
-import { beaver } from '@simple-reporting/base/scripts/beaver.js'
-import { map, mapJs } from '@simple-reporting/base/scripts/build.js'
-import { nswowWatcher } from '@simple-reporting/base/scripts/vite.js'
-
-await beaver()
-await map()
-await mapJs()
-
-// https://vitejs.dev/config/
-export default defineConfig({
-  plugins: [vue(), VueDevTools(), nswowWatcher()],
-  base: './',
-  build: {
-    outDir: './.output/app'
-  },
-  resolve: {
-    alias: {
-      '@': fileURLToPath(new URL('./src', import.meta.url)),
-      nswow: fileURLToPath(new URL('./nswow', import.meta.url))
-    }
-  },
-  publicDir: process.env.NODE_ENV === 'development'
-})
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+import VueDevTools from 'vite-plugin-vue-devtools'
+import viteSrlPlugin from './.srl/plugins/viteSrlPlugin.ts'
+import { fileURLToPath, URL } from 'node:url'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [vue(), VueDevTools(), viteSrlPlugin()],
+  build: {
+    outDir: './.output/app'
+  },
+  resolve: {
+    alias: {
+      '@': fileURLToPath(new URL('./src', import.meta.url))
+    }
+  }
+})

package/initTestProject.js

@@ -0,0 +1,91 @@
+import { init } from './scripts/init.js';
+import { execSync } from 'child_process';
+import { join, resolve } from 'path/posix';
+import { rmSync, existsSync, readFileSync, writeFileSync, cpSync } from 'fs';
+import { packageName } from './scripts/config.js';
+import chalk from 'chalk';
+
+const projectFolder = 'simple-reporting-library-test-project';
+const parentPath = resolve(process.cwd(), '..');
+const projectPath = join(parentPath, projectFolder);
+const packageJsonPath = join(projectPath, 'package.json');
+const testDataPath = resolve(process.cwd(), 'test-data');
+const publicPath = join(projectPath, 'public');
+
+const msg = {
+  info: (text) => chalk.black.bgYellowBright.bold(` INFO: ${text} `),
+  action: (text) => chalk.black.bgBlueBright.bold(` ACTION: ${text} `),
+  error: (text) => chalk.black.bgRedBright.bold(` ERROR: ${text} `),
+  success: (text) => chalk.black.bgGreenBright.bold(` SUCCESS: ${text} `),
+};
+
+if (existsSync(projectPath)) {
+  console.log(msg.info(`Deleting folder: ${projectFolder}`));
+  rmSync(projectPath, { recursive: true, force: true });
+}
+
+process.chdir(parentPath);
+
+console.log(msg.action(`Initializing project in ${projectFolder}...`));
+init(projectFolder)
+  .then(() => {
+    console.log(msg.info(`Project ${projectFolder} initialized successfully.`));
+
+    if (existsSync(testDataPath)) {
+      console.log(msg.action('Copying test-data to public folder...'));
+      cpSync(testDataPath, publicPath, { recursive: true, force: true });
+      console.log(msg.success('test-data copied successfully.'));
+    } else {
+      console.log(msg.info('No test-data folder found.'));
+    }
+
+    if (existsSync(packageJsonPath)) {
+      console.log(msg.action('Updating package.json...'));
+      const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
+
+      if (packageJson.dependencies && packageJson.dependencies[packageName]) {
+        packageJson.dependencies[packageName] =
+          'file:../simple-reporting-library';
+        writeFileSync(
+          packageJsonPath,
+          JSON.stringify(packageJson, null, 2),
+          'utf-8',
+        );
+        console.log(msg.success(`Updated ${packageName} in package.json.`));
+      } else {
+        console.log(msg.error(`${packageName} not found in devDependencies.`));
+      }
+    } else {
+      console.error(msg.error('package.json not found.'));
+    }
+
+    console.log(msg.action('Initializing a new Git repository...'));
+    execSync('git init', { cwd: projectPath, stdio: 'inherit' });
+    console.log(msg.success('Git repository initialized.'));
+
+    console.log(msg.action('Running npm install...'));
+    execSync('npm install', { cwd: projectPath, stdio: 'inherit' });
+    console.log(msg.success('npm install completed.'));
+
+    console.log(msg.action('Adding all files to Git...'));
+    execSync('git add .', { cwd: projectPath, stdio: 'inherit' });
+    console.log(msg.success('All files added to Git.'));
+
+    console.log(msg.action('Creating initial commit...'));
+    execSync('git commit -m "init"', { cwd: projectPath, stdio: 'inherit' });
+    console.log(msg.success('Initial commit created.'));
+
+    console.log('');
+
+    console.log(
+      msg.success(`
+---------------------------------------------------------------------
+Project initialization completed successfully.
+You can now navigate to the project folder: 
+${projectPath}
+---------------------------------------------------------------------`),
+    );
+  })
+  .catch((error) => {
+    console.error(msg.error('Error initializing project:'), error);
+  });

package/jest.config.mjs

@@ -0,0 +1,200 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+/** @type {import('jest').Config} */
+const config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "C:\\Users\\lars.zweifel\\AppData\\Local\\Temp\\jest",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: 'v8',
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "mts",
+  //   "cts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  resetMocks: true,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.?([mc])[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).?([mc])[jt]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "\\\\node_modules\\\\",
+  //   "\\.pnp\\.[^\\\\]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+export default config;

package/livingdocs/010.Titles/010.title-h1/ld-conf.json

@@ -0,0 +1,5 @@
+{
+  "name": "title-h1",
+  "label": "Title (h1)",
+  "properties": ["width-reduced", "pdf-spacer"]
+}

package/livingdocs/010.Titles/010.title-h1/scss/app.scss

@@ -0,0 +1 @@
+@use "web";

package/livingdocs/010.Titles/010.title-h1/scss/editor.scss

@@ -0,0 +1 @@
+@use "web";

package/livingdocs/010.Titles/010.title-h1/scss/general.scss

@@ -0,0 +1,5 @@
+@use 'srl';
+
+.srl-title-h1 {
+  @include srl.typography-title-h1();
+}

package/livingdocs/010.Titles/010.title-h1/scss/xbrl.scss

@@ -0,0 +1 @@
+@use 'general';

package/livingdocs/010.Titles/010.title-h1/title-h1.html

@@ -0,0 +1,5 @@
+<h1 class="srl-grid srl-title-h1 srl-linkable">
+  <span class="srl-grid__inner srl-title-h1__text" doc-editable="title-h1">
+    Title h1 Lorem ipsum dolor sit amet
+  </span>
+</h1>

package/livingdocs/010.Titles/020.title-h2/ld-conf.json

@@ -0,0 +1,10 @@
+{
+  "name": "title-h2",
+  "label": "Title (h2)",
+  "properties": ["h2-as", "width-reduced", "pdf-spacer"],
+  "directives": {
+    "title-h2-number": {
+      "recommendedMaxLength": 2
+    }
+  }
+}

package/livingdocs/010.Titles/020.title-h2/properties.json

@@ -0,0 +1,27 @@
+{
+  "h2-as": {
+    "label": "Title styling",
+    "type": "select",
+    "options": [
+      {
+        "caption": "Default"
+      },
+      {
+        "caption": "Styling from title h3",
+        "value": "srl-title-h3"
+      },
+      {
+        "caption": "Styling from title h4",
+        "value": "srl-title-h4"
+      },
+      {
+        "caption": "Styling from title h5",
+        "value": "srl-title-h5"
+      },
+      {
+        "caption": "Styling from title h6",
+        "value": "srl-title-h6"
+      }
+    ]
+  }
+}

package/livingdocs/010.Titles/020.title-h2/scss/app.scss

@@ -0,0 +1 @@
+@use "web";

package/livingdocs/010.Titles/020.title-h2/scss/editor.scss

@@ -0,0 +1 @@
+@use "web";

package/livingdocs/010.Titles/020.title-h2/scss/general.scss

@@ -0,0 +1,21 @@
+@use 'srl';
+@use "sass:map";
+
+$number-width: srl.spacer-get(map.get(srl.$meta, title, number-width));
+
+.srl-title-h2 {
+  @include srl.typography-title-h2();
+  @include srl.spacer-margin-top(400);
+}
+
+.srl-title-h2__number-text-container {
+  display: flex;
+}
+
+.srl-title-h2__number {
+  width: $number-width;
+}
+
+.srl-title-h2__text {
+  width: calc(100% - #{$number-width});
+}

package/livingdocs/010.Titles/020.title-h2/scss/xbrl.scss

@@ -0,0 +1 @@
+@use 'general';

package/livingdocs/010.Titles/020.title-h2/title-h2.html

@@ -0,0 +1,22 @@
+<h2 class="srl-grid srl-title-h2 srl-linkable">
+  <span
+    class="srl-grid__inner srl-title-h2__number-text-container js-notes-marker"
+    data-category-marker="container"
+  >
+    <span
+      class="srl-title-h2__number js-notes-marker-number"
+      data-category-marker="number"
+      doc-optional
+      doc-editable="title-h2-number"
+    >
+      1
+    </span>
+    <span
+      class="srl-title-h2__text js-notes-marker-text"
+      data-category-marker="text"
+      doc-editable="title-h2-text"
+    >
+      Title h2 Lorem ipsum dolor sit amet
+    </span>
+  </span>
+</h2>

package/livingdocs/010.Titles/030.title-h3/ld-conf.json

@@ -0,0 +1,10 @@
+{
+  "name": "title-h3",
+  "label": "Title (h3)",
+  "properties": ["h3-as", "width-reduced", "pdf-spacer"],
+  "directives": {
+    "title-h3-number": {
+      "recommendedMaxLength": 4
+    }
+  }
+}

package/livingdocs/010.Titles/030.title-h3/properties.json

@@ -0,0 +1,23 @@
+{
+  "h3-as": {
+    "label": "Title styling",
+    "type": "select",
+    "options": [
+      {
+        "caption": "Default"
+      },
+      {
+        "caption": "Styling from title h4",
+        "value": "srl-title-h4"
+      },
+      {
+        "caption": "Styling from title h5",
+        "value": "srl-title-h5"
+      },
+      {
+        "caption": "Styling from title h6",
+        "value": "srl-title-h6"
+      }
+    ]
+  }
+}

package/livingdocs/010.Titles/030.title-h3/scss/app.scss

@@ -0,0 +1 @@
+@use "web";

package/livingdocs/010.Titles/030.title-h3/scss/editor.scss

@@ -0,0 +1 @@
+@use "web";

package/livingdocs/010.Titles/030.title-h3/scss/general.scss

@@ -0,0 +1,21 @@
+@use 'srl';
+@use "sass:map";
+
+$number-width: srl.spacer-get(map.get(srl.$meta, title, number-width));
+
+.srl-title-h3 {
+  @include srl.typography-title-h3();
+  @include srl.spacer-margin-top(300);
+}
+
+.srl-title-h3__number-text-container {
+  display: flex;
+}
+
+.srl-title-h3__number {
+  width: $number-width;
+}
+
+.srl-title-h3__text {
+  width: calc(100% - #{$number-width});
+}

package/livingdocs/010.Titles/030.title-h3/scss/xbrl.scss

@@ -0,0 +1 @@
+@use 'general';

package/livingdocs/010.Titles/030.title-h3/title-h3.html

@@ -0,0 +1,22 @@
+<h3 class="srl-grid srl-title-h3 srl-linkable">
+  <span
+    class="srl-grid__inner srl-title-h3__number-text-container js-notes-marker"
+    data-category-marker="container"
+  >
+    <span
+      class="srl-title-h3__number js-notes-marker-number"
+      data-category-marker="number"
+      doc-optional
+      doc-editable="title-h3-number"
+    >
+      1.1.
+    </span>
+    <span
+      class="srl-title-h3__text js-notes-marker-text"
+      data-category-marker="text"
+      doc-editable="title-h3-text"
+    >
+      Title h3 Lorem ipsum dolor sit amet
+    </span>
+  </span>
+</h3>

package/livingdocs/010.Titles/040.title-h4/ld-conf.json

@@ -0,0 +1,10 @@
+{
+  "name": "title-h4",
+  "label": "Title (h4)",
+  "properties": ["h4-as", "width-reduced", "pdf-spacer"],
+  "directives": {
+    "title-h4-number": {
+      "recommendedMaxLength": 6
+    }
+  }
+}

package/livingdocs/010.Titles/040.title-h4/properties.json

@@ -0,0 +1,19 @@
+{
+  "h4-as": {
+    "label": "Title styling",
+    "type": "select",
+    "options": [
+      {
+        "caption": "Default"
+      },
+      {
+        "caption": "Styling from title h5",
+        "value": "srl-title-h5"
+      },
+      {
+        "caption": "Styling from title h6",
+        "value": "srl-title-h6"
+      }
+    ]
+  }
+}

package/livingdocs/010.Titles/040.title-h4/scss/app.scss

@@ -0,0 +1 @@
+@use "web";

package/livingdocs/010.Titles/040.title-h4/scss/editor.scss

@@ -0,0 +1 @@
+@use "web";