@simple-reporting/base 0.0.1

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,25 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: ls -la
+      - run: node scripts/renamePackage.js
+      - run: node scripts/doPublish.js -v ${{ github.ref_name }}
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}

package/.nvmrc

@@ -0,0 +1 @@
+22

package/.prettierrc

@@ -0,0 +1,6 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 80
+}

package/README.md

@@ -0,0 +1,23 @@
+# mms-reporting-library
+
+Starter Package for nswow development
+
+## Installation
+
+> npx @simple-reporting/base@latest init {{ project-name }}
+
+### After installation
+
+> cd {{ project-name }}
+
+> npm install
+
+## Usage
+
+Run dev server:
+
+> npm run dev
+
+Build all required files.
+
+> npm run build

package/cli.js

@@ -0,0 +1,114 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import { readFile } from 'fs/promises';
+import {
+  addComponents,
+  removeComponents,
+  createComponent,
+  addGroups,
+  removeGroups,
+  createGroup,
+} from './scripts/components.js';
+import { build, ddev, map, mapJs } from './scripts/build.js';
+import { beaver } from './scripts/beaver.js';
+
+const packageJson = JSON.parse(
+  await readFile(new URL('./package.json', import.meta.url)),
+);
+
+import { init } from './scripts/init.js';
+
+const commander = new Command();
+
+commander
+  .name(packageJson.name)
+  .description(packageJson.description)
+  .version(packageJson.version);
+
+commander
+  .command('init')
+  .description('Install development environment for nswow')
+  .argument('<folder>', 'Folder where to install the entrypoint')
+  .action(init);
+
+commander
+  .command('add')
+  .description('Add components or groups to development')
+  .argument('[action]', 'Chose action. Could be components or groups')
+  .action((action, options) => {
+    if (action === 'components') {
+      addComponents();
+    } else if (action === 'groups') {
+      addGroups();
+    } else {
+      console.error('You can add components or groups!');
+    }
+  });
+
+commander
+  .command('remove')
+  .description('Remove components or groups from development')
+  .argument('[action]', 'Chose action. Could be components or groups')
+  .action((action, options) => {
+    if (action === 'components') {
+      removeComponents();
+    } else if (action === 'groups') {
+      removeGroups();
+    } else {
+      console.error('You can remove components or groups!');
+    }
+  });
+
+commander
+  .command('create')
+  .description('Create component or group from development')
+  .argument('[action]', 'Chose action. Could be component or group')
+  .argument('[name]', 'The name of component or group.')
+  .action((action, name, options) => {
+    if (action === 'component') {
+      createComponent(name);
+    } else if (action === 'group') {
+      createGroup(name);
+    } else {
+      console.error('You can create component or group!');
+    }
+  });
+
+commander
+  .command('build')
+  .description('Build ldd, app, pdf and word for production')
+  .action(async () => {
+    await build();
+  });
+
+commander
+  .command('ddev')
+  .description('Build app for ddev')
+  .action(async () => {
+    await ddev();
+  });
+
+commander
+  .command('map')
+  .description('Build all necessary scss and livingdocs entries for production')
+  .action(async () => {
+    await map();
+  });
+
+commander
+  .command('mapjs')
+  .description(
+    'Build all necessary javascript and typescript entries for production',
+  )
+  .action(async () => {
+    await mapJs();
+  });
+
+commander
+  .command('beaver')
+  .description('Update beaver configuration')
+  .action(() => {
+    beaver(1);
+  });
+
+commander.parse();

package/dev/.ddev/config.yaml

@@ -0,0 +1,279 @@
+name: nassauische-ld
+type: php
+docroot: .output/ddev
+php_version: '8.3'
+webserver_type: nginx-fpm
+xdebug_enabled: false
+additional_hostnames: []
+additional_fqdns: []
+database:
+  type: mariadb
+  version: '10.11'
+use_dns_when_possible: true
+composer_version: '2'
+web_environment: []
+corepack_enable: false
+# Key features of DDEV's config.yaml:
+
+# name: <projectname> # Name of the project, automatically provides
+#   http://projectname.ddev.site and https://projectname.ddev.site
+
+# type: <projecttype>  # backdrop, cakephp, craftcms, drupal, drupal6, drupal7, drupal8, drupal9, drupal10, drupal11, laravel, magento, magento2, php, shopware6, silverstripe, symfony, typo3, wordpress
+# See https://ddev.readthedocs.io/en/stable/users/quickstart/ for more
+# information on the different project types
+
+# docroot: <relative_path> # Relative path to the directory containing index.php.
+
+# php_version: "8.3"  # PHP version to use, "5.6" through "8.4"
+
+# You can explicitly specify the webimage but this
+# is not recommended, as the images are often closely tied to DDEV's' behavior,
+# so this can break upgrades.
+
+# webimage: <docker_image>  # nginx/php docker image.
+
+# database:
+#   type: <dbtype> # mysql, mariadb, postgres
+#   version: <version> # database version, like "10.11" or "8.0"
+#   MariaDB versions can be 5.5-10.8, 10.11, and 11.4.
+#   MySQL versions can be 5.5-8.0.
+#   PostgreSQL versions can be 9-17.
+
+# router_http_port: <port>  # Port to be used for http (defaults to global configuration, usually 80)
+# router_https_port: <port> # Port for https (defaults to global configuration, usually 443)
+
+# xdebug_enabled: false  # Set to true to enable Xdebug and "ddev start" or "ddev restart"
+# Note that for most people the commands
+# "ddev xdebug" to enable Xdebug and "ddev xdebug off" to disable it work better,
+# as leaving Xdebug enabled all the time is a big performance hit.
+
+# xhprof_enabled: false  # Set to true to enable Xhprof and "ddev start" or "ddev restart"
+# Note that for most people the commands
+# "ddev xhprof" to enable Xhprof and "ddev xhprof off" to disable it work better,
+# as leaving Xhprof enabled all the time is a big performance hit.
+
+# webserver_type: nginx-fpm or apache-fpm
+
+# timezone: Europe/Berlin
+# If timezone is unset, DDEV will attempt to derive it from the host system timezone
+# using the $TZ environment variable or the /etc/localtime symlink.
+# This is the timezone used in the containers and by PHP;
+# it can be set to any valid timezone,
+# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+# For example Europe/Dublin or MST7MDT
+
+# composer_root: <relative_path>
+# Relative path to the Composer root directory from the project root. This is
+# the directory which contains the composer.json and where all Composer related
+# commands are executed.
+
+# composer_version: "2"
+# You can set it to "" or "2" (default) for Composer v2 or "1" for Composer v1
+# to use the latest major version available at the time your container is built.
+# It is also possible to use each other Composer version channel. This includes:
+#   - 2.2 (latest Composer LTS version)
+#   - stable
+#   - preview
+#   - snapshot
+# Alternatively, an explicit Composer version may be specified, for example "2.2.18".
+# To reinstall Composer after the image was built, run "ddev debug rebuild".
+
+# nodejs_version: "22"
+# change from the default system Node.js version to any other version.
+# See https://ddev.readthedocs.io/en/stable/users/configuration/config/#nodejs_version for more information
+# and https://www.npmjs.com/package/n#specifying-nodejs-versions for the full documentation,
+# Note that using of 'ddev nvm' is discouraged because "nodejs_version" is much easier to use,
+# can specify any version, and is more robust than using 'nvm'.
+
+# corepack_enable: false
+# Change to 'true' to 'corepack enable' and gain access to latest versions of yarn/pnpm
+
+# additional_hostnames:
+#  - somename
+#  - someothername
+# would provide http and https URLs for "somename.ddev.site"
+# and "someothername.ddev.site".
+
+# additional_fqdns:
+#  - example.com
+#  - sub1.example.com
+# would provide http and https URLs for "example.com" and "sub1.example.com"
+# Please take care with this because it can cause great confusion.
+
+# upload_dirs: "custom/upload/dir"
+#
+# upload_dirs:
+#   - custom/upload/dir
+#   - ../private
+#
+# would set the destination paths for ddev import-files to <docroot>/custom/upload/dir
+# When Mutagen is enabled this path is bind-mounted so that all the files
+# in the upload_dirs don't have to be synced into Mutagen.
+
+# disable_upload_dirs_warning: false
+# If true, turns off the normal warning that says
+# "You have Mutagen enabled and your 'php' project type doesn't have upload_dirs set"
+
+# ddev_version_constraint: ""
+# Example:
+# ddev_version_constraint: ">= 1.22.4"
+# This will enforce that the running ddev version is within this constraint.
+# See https://github.com/Masterminds/semver#checking-version-constraints for
+# supported constraint formats
+
+# working_dir:
+#   web: /var/www/html
+#   db: /home
+# would set the default working directory for the web and db services.
+# These values specify the destination directory for ddev ssh and the
+# directory in which commands passed into ddev exec are run.
+
+# omit_containers: [db, ddev-ssh-agent]
+# Currently only these containers are supported. Some containers can also be
+# omitted globally in the ~/.ddev/global_config.yaml. Note that if you omit
+# the "db" container, several standard features of DDEV that access the
+# database container will be unusable. In the global configuration it is also
+# possible to omit ddev-router, but not here.
+
+# performance_mode: "global"
+# DDEV offers performance optimization strategies to improve the filesystem
+# performance depending on your host system. Should be configured globally.
+#
+# If set, will override the global config. Possible values are:
+#   - "global":  uses the value from the global config.
+#   - "none":    disables performance optimization for this project.
+#   - "mutagen": enables Mutagen for this project.
+#   - "nfs":     enables NFS for this project.
+#
+# See https://ddev.readthedocs.io/en/stable/users/install/performance/#nfs
+# See https://ddev.readthedocs.io/en/stable/users/install/performance/#mutagen
+
+# fail_on_hook_fail: False
+# Decide whether 'ddev start' should be interrupted by a failing hook
+
+# host_https_port: "59002"
+# The host port binding for https can be explicitly specified. It is
+# dynamic unless otherwise specified.
+# This is not used by most people, most people use the *router* instead
+# of the localhost port.
+
+# host_webserver_port: "59001"
+# The host port binding for the ddev-webserver can be explicitly specified. It is
+# dynamic unless otherwise specified.
+# This is not used by most people, most people use the *router* instead
+# of the localhost port.
+
+# host_db_port: "59002"
+# The host port binding for the ddev-dbserver can be explicitly specified. It is dynamic
+# unless explicitly specified.
+
+# mailpit_http_port: "8025"
+# mailpit_https_port: "8026"
+# The Mailpit ports can be changed from the default 8025 and 8026
+
+# host_mailpit_port: "8025"
+# The mailpit port is not normally bound on the host at all, instead being routed
+# through ddev-router, but it can be bound directly to localhost if specified here.
+
+# webimage_extra_packages: [php7.4-tidy, php-bcmath]
+# Extra Debian packages that are needed in the webimage can be added here
+
+# dbimage_extra_packages: [telnet,netcat]
+# Extra Debian packages that are needed in the dbimage can be added here
+
+# use_dns_when_possible: true
+# If the host has internet access and the domain configured can
+# successfully be looked up, DNS will be used for hostname resolution
+# instead of editing /etc/hosts
+# Defaults to true
+
+# project_tld: ddev.site
+# The top-level domain used for project URLs
+# The default "ddev.site" allows DNS lookup via a wildcard
+# If you prefer you can change this to "ddev.local" to preserve
+# pre-v1.9 behavior.
+
+# ngrok_args: --basic-auth username:pass1234
+# Provide extra flags to the "ngrok http" command, see
+# https://ngrok.com/docs/ngrok-agent/config or run "ngrok http -h"
+
+# disable_settings_management: false
+# If true, DDEV will not create CMS-specific settings files like
+# Drupal's settings.php/settings.ddev.php or TYPO3's additional.php
+# In this case the user must provide all such settings.
+
+# You can inject environment variables into the web container with:
+# web_environment:
+#     - SOMEENV=somevalue
+#     - SOMEOTHERENV=someothervalue
+
+# no_project_mount: false
+# (Experimental) If true, DDEV will not mount the project into the web container;
+# the user is responsible for mounting it manually or via a script.
+# This is to enable experimentation with alternate file mounting strategies.
+# For advanced users only!
+
+# bind_all_interfaces: false
+# If true, host ports will be bound on all network interfaces,
+# not the localhost interface only. This means that ports
+# will be available on the local network if the host firewall
+# allows it.
+
+# default_container_timeout: 120
+# The default time that DDEV waits for all containers to become ready can be increased from
+# the default 120. This helps in importing huge databases, for example.
+
+#web_extra_exposed_ports:
+#- name: nodejs
+#  container_port: 3000
+#  http_port: 2999
+#  https_port: 3000
+#- name: something
+#  container_port: 4000
+#  https_port: 4000
+#  http_port: 3999
+# Allows a set of extra ports to be exposed via ddev-router
+# Fill in all three fields even if you don’t intend to use the https_port!
+# If you don’t add https_port, then it defaults to 0 and ddev-router will fail to start.
+#
+# The port behavior on the ddev-webserver must be arranged separately, for example
+# using web_extra_daemons.
+# For example, with a web app on port 3000 inside the container, this config would
+# expose that web app on https://<project>.ddev.site:9999 and http://<project>.ddev.site:9998
+# web_extra_exposed_ports:
+#  - name: myapp
+#    container_port: 3000
+#    http_port: 9998
+#    https_port: 9999
+
+#web_extra_daemons:
+#- name: "http-1"
+#  command: "/var/www/html/node_modules/.bin/http-server -p 3000"
+#  directory: /var/www/html
+#- name: "http-2"
+#  command: "/var/www/html/node_modules/.bin/http-server /var/www/html/sub -p 3000"
+#  directory: /var/www/html
+
+# override_config: false
+# By default, config.*.yaml files are *merged* into the configuration
+# But this means that some things can't be overridden
+# For example, if you have 'use_dns_when_possible: true'' you can't override it with a merge
+# and you can't erase existing hooks or all environment variables.
+# However, with "override_config: true" in a particular config.*.yaml file,
+# 'use_dns_when_possible: false' can override the existing values, and
+# hooks:
+#   post-start: []
+# or
+# web_environment: []
+# or
+# additional_hostnames: []
+# can have their intended affect. 'override_config' affects only behavior of the
+# config.*.yaml file it exists in.
+
+# Many DDEV commands can be extended to run tasks before or after the
+# DDEV command is executed, for example "post-start", "post-import-db",
+# "pre-composer", "post-composer"
+# See https://ddev.readthedocs.io/en/stable/users/extend/custom-commands/ for more
+# information on the commands that can be extended and the tasks you can define
+# for them. Example:
+#hooks:

package/dev/.ddev/nginx_full/custom.conf

@@ -0,0 +1,12 @@
+# ddev php default (PHP project type) config
+
+#ddev-generated
+# If you want to take over this file and customize it, remove the line above
+# and ddev will respect it and won't overwrite the file.
+# See https://ddev.readthedocs.io/en/stable/users/extend/customization-extendibility/#custom-nginx-configuration
+
+server {
+    location / {
+        rewrite ^.*$ /index.html?$query_string;
+    }
+}

package/dev/.env

@@ -0,0 +1 @@
+VITE_BASE_URL=/

package/dev/.env.development

@@ -0,0 +1 @@
+VITE_BASE_URL=/

package/dev/.eslintrc.cjs

@@ -0,0 +1,15 @@
+/* eslint-env node */
+require('@rushstack/eslint-patch/modern-module-resolution')
+
+module.exports = {
+  root: true,
+  extends: [
+    'plugin:vue/vue3-essential',
+    'eslint:recommended',
+    '@vue/eslint-config-typescript',
+    '@vue/eslint-config-prettier/skip-formatting'
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest'
+  }
+}

package/dev/.nvmrc

@@ -0,0 +1 @@
+22

package/dev/.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "semi": false,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "printWidth": 100,
+  "trailingComma": "none"
+}

package/dev/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["Vue.volar", "dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
+}

package/dev/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode"
+}

package/dev/README.md

@@ -0,0 +1,45 @@
+# standard-ld
+
+This template should help get you started developing with Vue 3 in Vite.
+
+## Recommended IDE Setup
+
+[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
+
+## Type Support for `.vue` Imports in TS
+
+TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
+
+## Customize configuration
+
+See [Vite Configuration Reference](https://vitejs.dev/config/).
+
+## Project Setup
+
+```sh
+npm install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+npm run dev
+```
+
+### Type-Check, Compile and Minify for Production
+
+```sh
+npm run build
+```
+
+### Run Unit Tests with [Vitest](https://vitest.dev/)
+
+```sh
+npm run test:unit
+```
+
+### Lint with [ESLint](https://eslint.org/)
+
+```sh
+npm run lint
+```

package/dev/env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

package/dev/index.html

@@ -0,0 +1,17 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="UTF-8" />
+    <base href="%VITE_BASE_URL%" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Skeleton</title>
+  </head>
+  <body>
+    <noscript
+      >this page requires javascript to work properly. please enable javascript in your
+      browser</noscript
+    >
+    <div id="app"></div>
+    <script type="module" src="src/main.ts"></script>
+  </body>
+</html>

package/dev/ldd.html

@@ -0,0 +1,7 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <link href=".nswow/ldd.scss" />
+  </head>
+  <body></body>
+</html>

package/dev/livingdocs/Media/image/app.scss

@@ -0,0 +1,25 @@
+@use 'web';
+
+@use 'nswow';
+
+.srl-image {
+  &:not(.show-mobile-image) {
+    @include nswow.grid-media(phone) {
+      .srl-image__image-container--desktop {
+        display: none;
+      }
+    }
+
+    @include nswow.grid-media-up(portrait) {
+      .srl-image__image-container--mobile {
+        display: none;
+      }
+    }
+  }
+
+  &.show-mobile-image {
+    .srl-image__image-container--desktop {
+      display: none;
+    }
+  }
+}

package/dev/livingdocs/Media/image/general.scss

@@ -0,0 +1,11 @@
+@use 'nswow';
+
+.srl-image {
+  &__img {
+    width: 100%;
+  }
+
+  &__caption {
+    @include nswow.typography-blockquote();
+  }
+}

package/dev/livingdocs/Media/image/image.html

@@ -0,0 +1,46 @@
+<script type="ld-conf">
+  {
+  	"name": "image",
+  	"label": "Image",
+  	"iconUrl": "https://mms-xbrl.s3.eu-central-1.amazonaws.com/design/svg/editor/icon-image.min.svg",
+  	"properties": [
+  		"show-mobile-image",
+  		"web-width",
+  		"pdf-width"
+  	],
+  	"directives": {
+  		"desktop-image": {
+  			"imageRatios": ["1:1", "3:2", "4:3", "16:9"],
+  			"allowOriginalRatio": true
+  		},
+  		"mobile-image": {
+  			"imageRatios": ["1:1", "3:2", "4:3", "16:9"],
+  			"allowOriginalRatio": true
+  		}
+  	}
+  }
+</script>
+<figure class="srl-image srl-article__grid srl-article__grid--indent">
+  <div class="srl-article__grid--inner">
+    <div class="lc-image__alt-text" doc-editable="alt-tag" optional data-alt-text-source="alt">
+      Write the alt text here
+    </div>
+    <div class="srl-image__image-container srl-image__image-container--desktop">
+      <img
+        class="srl-image__img srl-image__img--desktop"
+        doc-image="desktop-image"
+        data-alt-text-target="alt"
+      />
+    </div>
+    <div class="srl-image__image-container srl-image__image-container--mobile">
+      <img
+        class="srl-image__img srl-image__img--mobile"
+        doc-image="mobile-image"
+        data-alt-text-target="alt"
+      />
+    </div>
+    <figcaption class="srl-linkable srl-image__caption" doc-editable="legend" doc-optional>
+      Bildlegende
+    </figcaption>
+  </div>
+</figure>

package/dev/livingdocs/Media/image/ldd.scss

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

package/dev/livingdocs/Media/image/pdf.scss

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