@simple-reporting/base 0.1.112 → 1.0.0

package/livingdocs/110.PDF/040.pdf-chapter-title/ld-conf.json

@@ -0,0 +1,4 @@
+{
+  "name": "pdf-chapter-title",
+  "label": "PDF chapter title"
+}

package/livingdocs/110.PDF/040.pdf-chapter-title/pdf-chapter-title.html

@@ -0,0 +1,7 @@
+<p
+  class="srl-pdf-chapter-title"
+  doc-editable="pdf-chapter-title-text"
+  data-remove-from-web="complete"
+>
+  Chapter title
+</p>

package/livingdocs/110.PDF/050.pdf-chapter-navigation-container/ld-conf.json

@@ -0,0 +1,17 @@
+{
+  "name": "pdf-chapter-navigation-container",
+  "label": "PDF chapter navigation container",
+  "directives": {
+    "pdf-chapter-navigation-list": {
+      "allowedChildren": ["pdf-chapter-navigation-item"],
+      "defaultComponents": {
+        "paragraph": "pdf-chapter-navigation-item"
+      },
+      "defaultContent": [
+        {
+          "component": "pdf-chapter-navigation-item"
+        }
+      ]
+    }
+  }
+}

package/livingdocs/110.PDF/050.pdf-chapter-navigation-container/pdf-chapter-navigation.html

@@ -0,0 +1,10 @@
+<div
+  class="srl-chapter-navigation"
+  data-is-chapter-override="true"
+  data-remove-from-web="complete"
+>
+  <ol
+    class="srl-chapter-navigation__list"
+    doc-container="pdf-chapter-navigation-list"
+  ></ol>
+</div>

package/livingdocs/110.PDF/060.pdf-chapter-navigation-item/ld-conf.json

@@ -0,0 +1,6 @@
+{
+  "name": "pdf-chapter-navigation-item",
+  "label": "PDF chapter navigation item",
+  "properties": ["pdf-chapter-navigation-item-current"],
+  "allowedParents": ["pdf-chapter-navigation"]
+}

package/livingdocs/110.PDF/060.pdf-chapter-navigation-item/pdf-chapter-navigation-item.html

@@ -0,0 +1,7 @@
+<li
+  class="srl-chapter-navigation__list-item"
+  doc-editable="pdf-chapter-navigation-item-text"
+  data-remove-from-web="complete"
+>
+  Chapter Title
+</li>

package/livingdocs/110.PDF/060.pdf-chapter-navigation-item/properties.json

@@ -0,0 +1,7 @@
+{
+  "pdf-chapter-navigation-item-current": {
+    "label": "Is current navigation item",
+    "type": "option",
+    "value": "srl-chapter-navigation__list-item--current"
+  }
+}

package/livingdocs/110.PDF/070.pdf-cover/ld-conf.json

@@ -0,0 +1,25 @@
+{
+  "name": "pdf-cover",
+  "label": "PDF cover",
+  "directives": {
+    "show-logo": {
+      "type": "toggle",
+      "label": "Show logo",
+      "default": false
+    },
+    "show-main-title": {
+      "type": "toggle",
+      "label": "Show main title",
+      "default": true
+    },
+    "show-sub-title": {
+      "type": "toggle",
+      "label": "Show sub title",
+      "default": false
+    },
+    "cover": {
+      "imageRatios": ["a4"],
+      "allowOriginalRatio": false
+    }
+  }
+}

package/livingdocs/110.PDF/070.pdf-cover/pdf-cover.html

@@ -0,0 +1,26 @@
+<div class="srl-pdf-cover" doc-image="cover">
+  <div class="srl-pdf-cover__content">
+    <div class="srl-pdf-cover__top">
+      <div class="srl-pdf-cover__logo-container" doc-toggle="show-logo">
+        <img class="srl-pdf-cover__logo" doc-image="logo" />
+      </div>
+    </div>
+    <div class="srl-pdf-cover__bottom">
+      <h1
+        class="srl-title-h1"
+        doc-editable="pdf-cover-main-title"
+        doc-toggle="show-main-title"
+      >
+        Annual Report 2050
+      </h1>
+
+      <h2
+        class="srl-title-h2"
+        doc-editable="pdf-cover-sub-title"
+        doc-toggle="show-sub-title"
+      >
+        Committed to continuous improvement
+      </h2>
+    </div>
+  </div>
+</div>

package/livingdocs/110.PDF/080.pdf-toc-page/ld-conf.json

@@ -0,0 +1,15 @@
+{
+  "name": "pdf-toc-page",
+  "label": "ToC page",
+  "properties": ["pdf-hide-paging-publication-chapter-title", "toc-page-type"],
+  "directives": {
+    "toc": {
+      "allowedChildren": [
+        "pdf-toc-item-title",
+        "pdf-toc-item",
+        "pdf-toc-item-blank"
+      ],
+      "defaultContent": [{ "component": "pdf-toc-item" }]
+    }
+  }
+}

package/livingdocs/110.PDF/080.pdf-toc-page/pdf-toc-page.html

@@ -0,0 +1,8 @@
+<div class="srl-pdf-toc-page">
+  <div class="srl-pdf-toc-page__inner">
+    <div class="srl-pdf-toc-page__title" doc-editable="pdf-toc-page-title">
+      Chapter title
+    </div>
+    <div class="srl-pdf-toc" doc-container="toc"></div>
+  </div>
+</div>

package/livingdocs/{PDF_only/pdf-toc-page → 110.PDF/080.pdf-toc-page}/properties.json

@@ -5,8 +5,16 @@
     "value": "hide-paging-publication-chapter-title"
   },
   "toc-page-type": {
-    "label": "Is main ToC",
-    "type": "option",
-    "value": "lc-pdf-toc-page--main"
+    "label": "ToC page type",
+    "type": "select",
+    "options": [
+      {
+        "caption": "Default"
+      },
+      {
+        "caption": "Main ToC",
+        "value": "srl-pdf-toc-page--main"
+      }
+    ]
   }
 }

package/livingdocs/110.PDF/090.pdf-toc-item-title/ld-conf.json

@@ -0,0 +1,5 @@
+{
+  "name": "pdf-toc-item-title",
+  "label": "ToC item title",
+  "allowedParents": ["pdf-toc-page"]
+}

package/livingdocs/110.PDF/090.pdf-toc-item-title/pdf-toc-item-title.html

@@ -0,0 +1,3 @@
+<div class="srl-pdf-toc-item-title" doc-editable="pdf-toc-item-title-text">
+  ToC item title
+</div>

package/livingdocs/110.PDF/100.pdf-toc-item/ld-conf.json

@@ -0,0 +1,14 @@
+{
+  "name": "pdf-toc-item",
+  "label": "ToC item",
+  "properties": ["toc-title"],
+  "allowedParents": ["pdf-toc-page"],
+  "directives": {
+    "pdf-toc-item-number": {
+      "plainText": true
+    },
+    "pdf-toc-item-text": {
+      "plainText": true
+    }
+  }
+}

package/livingdocs/110.PDF/100.pdf-toc-item/pdf-toc-item.html

@@ -0,0 +1,6 @@
+<a class="srl-pdf-toc__item" doc-link="href" data-page-number="">
+  <div class="srl-pdf-toc__number" doc-editable="pdf-toc-item-number">1</div>
+  <div class="srl-pdf-toc__text" doc-editable="pdf-toc-item-text">
+    Chapter Title
+  </div>
+</a>

package/livingdocs/110.PDF/110.pdf-toc-item-blank/ld-conf.json

@@ -0,0 +1,5 @@
+{
+  "name": "pdf-toc-item-blank",
+  "label": "ToC item blank",
+  "allowedParents": ["pdf-toc-page"]
+}

package/livingdocs/110.PDF/110.pdf-toc-item-blank/pdf-toc-item-blank.html

@@ -0,0 +1,4 @@
+<div class="srl-pdf-toc__item srl-pdf-toc__item--blank">
+  <div class="srl-pdf-toc__number">&nbsp;</div>
+  <div class="srl-pdf-toc__text">&nbsp;</div>
+</div>

package/livingdocs/999.Properties/alignment/properties.json

@@ -0,0 +1,36 @@
+{
+  "horizontal-alignment": {
+    "label": "Horizontal alignment",
+    "type": "select",
+    "options": [
+      {
+        "caption": "left"
+      },
+      {
+        "caption": "center",
+        "value": "srl-horizontal-center"
+      },
+      {
+        "caption": "right",
+        "value": "srl-horizontal-right"
+      }
+    ]
+  },
+  "vertical-alignment": {
+    "label": "Vertical alignment",
+    "type": "select",
+    "options": [
+      {
+        "caption": "top"
+      },
+      {
+        "caption": "center",
+        "value": "srl-vertical-center"
+      },
+      {
+        "caption": "bottom",
+        "value": "srl-vertical-bottom"
+      }
+    ]
+  }
+}

package/livingdocs/{Text/quote-with-portrait → 999.Properties/hide-quote-characters}/properties.json

@@ -1,9 +1,4 @@
 {
-  "round-portrait": {
-    "label": "Round portrait",
-    "type": "option",
-    "value": "round-portrait"
-  },
   "hide-quote-characters": {
     "label": "Hide quote characters before and after",
     "type": "option",

package/livingdocs/999.Properties/pdf-spacer/properties.json

@@ -0,0 +1,43 @@
+{
+  "pdf-spacer": {
+    "label": "PDF spacer (please use with caution)",
+    "type": "select",
+    "options": [
+      {
+        "caption": "Default"
+      },
+      {
+        "caption": "XXXS spacer",
+        "value": "srl-spacer-xs"
+      },
+      {
+        "caption": "XXS spacer",
+        "value": "srl-spacer-xs"
+      },
+      {
+        "caption": "XS spacer",
+        "value": "srl-spacer-xs"
+      },
+      {
+        "caption": "S spacer",
+        "value": "srl-spacer-sm"
+      },
+      {
+        "caption": "M spacer",
+        "value": "srl-spacer-md"
+      },
+      {
+        "caption": "L spacer",
+        "value": "srl-spacer-lg"
+      },
+      {
+        "caption": "XL spacer",
+        "value": "srl-spacer-xl"
+      },
+      {
+        "caption": "XXL spacer",
+        "value": "srl-spacer-xxl"
+      }
+    ]
+  }
+}

package/livingdocs/999.Properties/width/properties.json

@@ -0,0 +1,32 @@
+{
+  "width-all": {
+    "label": "Width",
+    "type": "select",
+    "options": [
+      {
+        "caption": "Regular"
+      },
+      {
+        "caption": "Wide",
+        "value": "srl-wide-width"
+      },
+      {
+        "caption": "Full",
+        "value": "srl-full-width"
+      }
+    ]
+  },
+  "width-reduced": {
+    "label": "Width",
+    "type": "select",
+    "options": [
+      {
+        "caption": "Regular"
+      },
+      {
+        "caption": "Wide",
+        "value": "srl-wide-width"
+      }
+    ]
+  }
+}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@simple-reporting/base",
-  "version": "0.1.112",
-  "description": "Manage nswow templates, build and publish",
+  "version": "1.0.0",
+  "description": "Manage srl templates, build and publish",
   "bin": {
-    "nswow": "cli.js"
+    "srl": "cli.js"
   },
   "engines": {
     "node": ">=22.12.0",
@@ -11,27 +11,24 @@
   },
   "type": "module",
   "scripts": {
-    "preparePublish": "node preparePublish.cjs && prettier --write --list-different .",
     "lint": "prettier --check .",
-    "lint:fix": "prettier --write ."
+    "lint:fix": "prettier --write .",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
   },
   "main": "cli.js",
   "dependencies": {
     "@kne/color-palette": "^0.1.0",
     "archiver": "^7.0.1",
-    "cheerio": "^1.0.0",
+    "chalk": "^5.4.1",
     "colors": "^1.4.0",
     "commander": "^11.1.0",
     "enquirer": "^2.4.1",
     "fs": "^0.0.1-security",
     "fs-extra": "^11.2.0",
     "glob": "^10.4.5",
-    "globby": "^13.2.2",
-    "html-minifier": "^4.0.0",
-    "lodash": "^4.17.21",
     "modern-css-reset": "^1.4.0",
+    "node-html-parser": "^7.0.1",
     "vite": "^5.4.11",
-    "winston": "^3.17.0",
     "write-json": "^3.0.1"
   },
   "keywords": [
@@ -44,6 +41,7 @@
   "author": "Michael Dörer",
   "license": "ISC",
   "devDependencies": {
+    "jest": "^30.0.2",
     "prettier": "^3.4.2",
     "typescript": "^5.7.2"
   }

package/scripts/beaver.js

@@ -1,8 +1,9 @@
 import { writeFileSync, readFileSync } from 'node:fs';
-import { resolve, relative } from 'node:path';
+import path from 'node:path/posix';
 import { colors } from './colors.js';
 import { readNsWowJson } from './utils.js';
 import colorPalette from '@kne/color-palette';
+import folders from './folders.js';
 /**
  * Maps the values of an object or array recursively.
  *
@@ -45,7 +46,7 @@ function mapValues(values) {
  * @returns {string} - The generated SCSS code.
  */
 function writeTypographyScss(typography) {
-  let r = [`@use "config";`, `@forward "@simple-reporting/base/scss/typography";`];
+  let r = [`@use "config";`, `@forward "../scss/typography";`];
   if (typography) {
     if (typography.typography) {
       let o = [];
@@ -56,7 +57,7 @@ function writeTypographyScss(typography) {
         o.push(`}\n`);
       }
       if (o.length) {
-        r.push(`@use "@simple-reporting/base/scss/typography";\n`);
+        r.push(`@use "../scss/typography";\n`);
         r.push(o.join(`\n`));
       }
     }
@@ -71,7 +72,7 @@ function writeTypographyScss(typography) {
  * @returns {string} - The SCSS code for importing and forwarding colors.
  */
 function writeColorsScss(colors) {
-  let r = [`@use "config";`, `@forward "@simple-reporting/base/scss/colors";`];
+  let r = [`@use "config";`, `@forward "../scss/colors";`];
   if (colors) {
     if (colors.colors) {
       let o = [];
@@ -83,7 +84,7 @@ function writeColorsScss(colors) {
       }
 
       if (o.length) {
-        r.push(`@use "@simple-reporting/base/scss/colors";\n`);
+        r.push(`@use "../scss/colors";\n`);
         r.push(o.join(`\n`));
       }
     }
@@ -169,7 +170,7 @@ function makeScssVariables(values, indent = 2) {
  */
 async function beaver(verbose = 0) {
   const configJson = await readNsWowJson();
-  const nswowPath = resolve(process.cwd(), './nswow');
+  const nswowPath = folders.srlSystem;
 
   if (typeof verbose === 'boolean') {
     verbose = verbose ? 1 : 0;
@@ -186,7 +187,7 @@ async function beaver(verbose = 0) {
   if (typeof configJson.fonts !== 'undefined') {
     const fontBasePath = configJson.fonts['font-base-path'] ?? '';
     if (fontBasePath.length) {
-      configJson.fonts['font-base-path'] = '.' + fontBasePath;
+      configJson.fonts['font-base-path'] = '.' + path.normalize(fontBasePath);
     }
     if (typeof configJson.fonts.fonts !== 'undefined') {
       for (let x = 0; x < configJson.fonts.fonts.length; x++) {
@@ -194,7 +195,7 @@ async function beaver(verbose = 0) {
         if (typeof font === 'string') {
           configJson.fonts.fonts[x] = JSON.parse(
             readFileSync(
-              resolve(process.cwd(), `${fontBasePath}/${font}/styles.json`),
+              path.join(process.cwd(), fontBasePath, font, 'styles.json'),
             ),
           );
         }
@@ -262,7 +263,7 @@ async function beaver(verbose = 0) {
     if (typeof map[file] !== 'undefined') {
       const o = [];
       o.push(
-        `@use "@simple-reporting/base/scss/${file}/variables.scss" as ${file}Variables with (`,
+        `@use "../scss/${file}/variables.scss" as ${file}Variables with (`,
       );
       let v = [];
       for (const variable in map[file]) {
@@ -275,14 +276,14 @@ async function beaver(verbose = 0) {
   });
 
   configOutput = configOutput.join(`\n`);
-  const configFile = `${nswowPath}/config.scss`;
+  const configFile = path.join(nswowPath, 'config.scss');
   writeFileSync(configFile, configOutput);
 
-  const typographyFile = `${nswowPath}/typography.scss`;
+  const typographyFile = path.join(nswowPath, 'typography.scss');
   const typographyOutput = writeTypographyScss(map.typography);
   writeFileSync(typographyFile, typographyOutput);
 
-  const colorsFile = `${nswowPath}/colors.scss`;
+  const colorsFile = path.join(nswowPath, 'colors.scss');
   const colorsOutput = writeColorsScss(map.colors);
   writeFileSync(colorsFile, colorsOutput);
 
@@ -290,21 +291,21 @@ async function beaver(verbose = 0) {
     console.log(colors.info(`\nThe following files has been written.\n`));
 
     console.log(
-      colors.bgWhite(colors.file(relative(process.cwd(), configFile))),
+      colors.bgWhite(colors.file(path.relative(process.cwd(), configFile))),
     );
     if (verbose > 1) {
       console.log(colors.prompt(`\n` + configOutput + `\n`));
     }
 
     console.log(
-      colors.bgWhite(colors.file(relative(process.cwd(), typographyFile))),
+      colors.bgWhite(colors.file(path.relative(process.cwd(), typographyFile))),
     );
     if (verbose > 1) {
       console.log(colors.prompt(`\n` + typographyOutput + `\n`));
     }
 
     console.log(
-      colors.bgWhite(colors.file(relative(process.cwd(), colorsFile))),
+      colors.bgWhite(colors.file(path.relative(process.cwd(), colorsFile))),
     );
     if (verbose > 1) {
       console.log(colors.prompt(`\n` + colorsOutput + `\n`));

package/scripts/build.d.ts

@@ -2,9 +2,10 @@
  * Builds the project sequentially by executing a series of asynchronous tasks in a specific order.
  * This method is used to build the project in a predetermined sequence.
  *
+ * @param {string} version
  * @return {Promise<void>} A Promise that resolves when the build process is completed or rejects if an error occurs.
  */
-export function build(): Promise<void>;
+export function build(version: string): Promise<void>;
 /**
  * Builds the project sequentially by executing a series of asynchronous tasks in a specific order.
  * This method is used to build the project in a predetermined sequence.
@@ -27,14 +28,10 @@ export function map(): Promise<boolean>;
  * @returns {Promise<boolean>} Returns a promise that resolves to true if the SCSS mapping is successful, and false if there's an error.
  */
 export function mapScss(): Promise<boolean>;
-/**
- * Maps the livingdocs properties to components and groups.
- *
- * @returns {Promise<boolean>} Returns a promise that resolves to a boolean indicating the success or failure of the mapping.
- */
-export function mapLdd(): Promise<boolean>;
+import { mapLdd } from './ldd/mapLdd.js';
 /**
  * This function asynchronously maps JavaScript files and imports them into specific files.
  * @returns {Promise<boolean>} - A promise that resolves to true if the mapping and importing is successful.
  */
 export function mapJs(): Promise<boolean>;
+export { mapLdd };