feat: eslint license header plugin

Closes #214

.changeset/cold-years-listen.md

@@ -0,0 +1,5 @@
+---
+"@openstapps/easy-ast": patch
+---
+
+Fixed docs generation

.changeset/rich-rats-guess.md

@@ -0,0 +1,5 @@
+---
+"@openstapps/backend": patch
+---
+
+fix for geo.point mapping

backend/backend/CHANGELOG.md

@@ -1,18 +1,5 @@
 # @openstapps/backend
 
-## 3.3.2
-
-### Patch Changes
-
-- @openstapps/core@3.3.2
-- @openstapps/core-tools@3.3.2
-
-## 3.3.1
-
-### Patch Changes
-
-- 67ab1fd6: fix for geo.point mapping
-
 ## 3.3.0
 
 ### Minor Changes

backend/backend/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openstapps/backend",
   "description": "A reference implementation for a StApps backend",
-  "version": "3.3.2",
+  "version": "3.3.0",
   "private": true,
   "type": "module",
   "license": "AGPL-3.0-only",

configuration/eslint-config/index.js

@@ -22,7 +22,7 @@ const config = {
         'plugin:unicorn/recommended',
         'prettier',
       ],
-      plugins: ['eslint-plugin-unicorn', 'eslint-plugin-jsdoc'],
+      plugins: ['eslint-plugin-unicorn', 'eslint-plugin-jsdoc', 'header'],
       settings: {
         jsdoc: {
           mode: 'typescript',
@@ -36,6 +36,7 @@ const config = {
         'unicorn/prefer-node-protocol': 'off',
         'unicorn/no-process-exit': 'off',
         'unicorn/no-array-reduce': 'off',
+        'unicorn/prefer-event-target': 'off',
         'unicorn/prevent-abbreviations': [
           'error',
           {
@@ -77,6 +78,27 @@ const config = {
           },
         ],
 
+        'header/header': [
+          2,
+          'block',
+          [
+            '',
+            ' * Copyright (C) 2023 StApps',
+            ' * This program is free software: you can redistribute it and/or modify it',
+            ' * under the terms of the GNU General Public License as published by the Free',
+            ' * Software Foundation, version 3.',
+            ' *',
+            ' * This program is distributed in the hope that it will be useful, but WITHOUT',
+            ' * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or',
+            ' * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for',
+            ' * more details.',
+            ' *',
+            ' * You should have received a copy of the GNU General Public License along with',
+            ' * this program. If not, see <https://www.gnu.org/licenses/>.',
+            ' ',
+          ],
+        ],
+
         '@typescript-eslint/explicit-module-boundary-types': 'off',
         '@typescript-eslint/no-unused-vars': [
           'error',

configuration/eslint-config/licenses/GPL-3.0-only.txt

@@ -1,14 +0,0 @@
-Copyright (C) {{year}}  {{author}}
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.

configuration/eslint-config/package.json

@@ -22,11 +22,13 @@
     "typescript": "5.4.2"
   },
   "peerDependencies": {
-    "@typescript-eslint/eslint-plugin": "7.2.0",
-    "@typescript-eslint/parser": "7.2.0",
-    "eslint": "8.57.0",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-jsdoc": "48.2.1",
-    "eslint-plugin-unicorn": "51.0.1"
+    "@typescript-eslint/eslint-plugin": "5.60.1",
+    "@typescript-eslint/parser": "5.60.1",
+    "eslint": "8.43.0",
+    "eslint-config-prettier": "8.8.0",
+    "eslint-plugin-jsdoc": "46.4.2",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-unicorn": "47.0.0",
+    "eslint-plugin-header": "3.1.1"
   }
 }

examples/minimal-connector/CHANGELOG.md

@@ -1,12 +1,5 @@
 # @openstapps/minimal-connector
 
-## 3.3.2
-
-### Patch Changes
-
-- @openstapps/core@3.3.2
-- @openstapps/api@3.3.2
-
 ## 3.3.0
 
 ### Patch Changes

examples/minimal-connector/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openstapps/minimal-connector",
   "description": "This is a minimal connector which serves as an example",
-  "version": "3.3.2",
+  "version": "3.3.0",
   "private": true,
   "type": "module",
   "license": "GPL-3.0-only",

examples/minimal-plugin/CHANGELOG.md

@@ -1,14 +1,5 @@
 # @openstapps/minimal-plugin
 
-## 3.3.2
-
-### Patch Changes
-
-- @openstapps/core@3.3.2
-- @openstapps/core-tools@3.3.2
-- @openstapps/api-plugin@3.3.2
-- @openstapps/api@3.3.2
-
 ## 3.3.0
 
 ### Patch Changes

examples/minimal-plugin/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openstapps/minimal-plugin",
   "description": "Minimal Plugin",
-  "version": "3.3.2",
+  "version": "3.3.0",
   "private": true,
   "type": "module",
   "license": "GPL-3.0-only",

frontend/app/.eslintignore

@@ -1,2 +1,3 @@
 src/app/_helpers/data
 node_modules
+src/index.html

frontend/app/.eslintrc.json

@@ -1,76 +1,43 @@
 {
   "root": true,
   "ignorePatterns": ["projects/**/*"],
+  "extends": ["@openstapps/eslint-config"],
   "overrides": [
     {
       "files": ["*.ts"],
-      "parser": "@typescript-eslint/parser",
-      "parserOptions": {
-        "ecmaVersion": 2020,
-        "sourceType": "module",
-        "project": ["tsconfig.json", "tsconfig.spec.json", "cypress/tsconfig.json"],
-        "createDefaultProgram": true
-      },
       "extends": [
-        "plugin:@typescript-eslint/recommended",
         "plugin:@angular-eslint/recommended",
-        "plugin:@angular-eslint/template/process-inline-templates",
-        "plugin:jsdoc/recommended",
-        "plugin:unicorn/recommended",
-        "prettier"
+        "plugin:@angular-eslint/template/process-inline-templates"
       ],
-      "plugins": ["eslint-plugin-unicorn", "eslint-plugin-jsdoc"],
-      "settings": {
-        "jsdoc": {
-          "mode": "typescript"
-        }
-      },
       "rules": {
-        "unicorn/filename-case": "error",
-        "unicorn/no-array-reduce": "off",
-        "unicorn/no-array-callback-reference": "off",
-        "unicorn/no-await-expression-member": "off",
-        "unicorn/prefer-object-from-entries": "off",
-        "unicorn/prefer-node-protocol": "off",
-        "unicorn/no-process-exit": "off",
-        "unicorn/prefer-event-target": "off",
-        "unicorn/prevent-abbreviations": [
-          "warn",
-          {
-            "replacements": {
-              "ref": false,
-              "i": false
-            }
-          }
-        ],
-        "unicorn/no-nested-ternary": "off",
-        "unicorn/better-regex": "off",
-        "unicorn/no-non-null-assertion": "off",
-        "unicorn/consistent-function-scoping": ["error", {"checkArrowFunctions": false}],
-        "jsdoc/no-types": "error",
-        "jsdoc/require-param": "off",
-        "jsdoc/require-param-description": "error",
-        "jsdoc/check-param-names": "error",
-        "jsdoc/require-returns": "off",
-        "jsdoc/require-param-type": "off",
-        "jsdoc/require-returns-type": "off",
-        "@typescript-eslint/explicit-module-boundary-types": "off",
-        "@typescript-eslint/no-non-null-assertion": "off",
-        "@typescript-eslint/no-unused-vars": [
-          "error",
-          {
-            "args": "after-used",
-            "argsIgnorePattern": "^_"
-          }
-        ],
-        "@typescript-eslint/lines-between-class-members": ["error", "always"],
-        "@typescript-eslint/no-explicit-any": "error",
-        "@angular-eslint/use-lifecycle-interface": "error"
+        "@angular-eslint/use-lifecycle-interface": "error",
+        "no-console": "off"
       }
     },
     {
       "files": ["*.html"],
-      "extends": ["plugin:@angular-eslint/template/recommended", "prettier"]
+      "plugins": ["header"],
+      "extends": ["plugin:@angular-eslint/template/recommended", "prettier"],
+      "rules": {
+        "header/header": [
+          2,
+          "block-html",
+          [
+            "~ Copyright (C) 2023 StApps",
+            "  ~ This program is free software: you can redistribute it and/or modify it",
+            "  ~ under the terms of the GNU General Public License as published by the Free",
+            "  ~ Software Foundation, version 3.",
+            "  ~",
+            "  ~ This program is distributed in the hope that it will be useful, but WITHOUT",
+            "  ~ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or",
+            "  ~ FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for",
+            "  ~ more details.",
+            "  ~",
+            "  ~ You should have received a copy of the GNU General Public License along with",
+            "  ~ this program. If not, see <https://www.gnu.org/licenses/>."
+          ]
+        ]
+      }
     }
   ]
 }

frontend/app/CHANGELOG.md

@@ -1,13 +1,5 @@
 # @openstapps/app
 
-## 3.3.2
-
-### Patch Changes
-
-- 7afc24f1: fixed config version comparison
-  - @openstapps/core@3.3.2
-  - @openstapps/api@3.3.2
-
 ## 3.3.0
 
 ### Minor Changes

frontend/app/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openstapps/app",
   "description": "The generic app tailored to fulfill needs of German universities, written using Ionic Framework.",
-  "version": "3.3.2",
+  "version": "3.3.0",
   "private": true,
   "license": "GPL-3.0-only",
   "author": "Karl-Philipp Wulfert <krlwlfrt@gmail.com>",
@@ -138,6 +138,7 @@
     "@ionic/angular-toolkit": "11.0.1",
     "@ionic/cli": "7.2.0",
     "@openstapps/prettier-config": "workspace:*",
+    "@openstapps/eslint-config": "workspace:*",
     "@openstapps/tsconfig": "workspace:*",
     "@types/fontkit": "2.0.7",
     "@types/geojson": "1.0.6",
@@ -154,11 +155,6 @@
     "@typescript-eslint/parser": "7.2.0",
     "cordova-res": "0.15.4",
     "cypress": "13.7.0",
-    "eslint": "8.57.0",
-    "eslint-plugin-jsdoc": "48.2.1",
-    "eslint-plugin-prettier": "5.1.3",
-    "eslint-plugin-unicorn": "51.0.1",
-    "fast-deep-equal": "3.1.3",
     "fontkit": "2.0.2",
     "glob": "10.3.10",
     "http-server": "14.1.1",

frontend/app/src/app/modules/config/config.provider.spec.ts

@@ -132,8 +132,6 @@ describe('ConfigProvider', () => {
     wrongConfig.backend.SCVersion = '0.1.0';
     storageProviderSpy.get.and.returnValue(Promise.resolve(wrongConfig));
     spyOn(configProvider.client, 'handshake').and.returnValue(Promise.resolve(sampleIndexResponse));
-    // sets StApps core version which has a different major version
-    configProvider.scVersion = '1.0.0';
     await configProvider.init();
 
     expect(ngxLogger.warn).toHaveBeenCalledWith(
@@ -141,19 +139,6 @@ describe('ConfigProvider', () => {
     );
   });
 
-  it('should load from storage if offline and same major version stored', async () => {
-    internetConnectionServiceMock = {offline$: new BehaviorSubject<boolean>(true)};
-    storageProviderSpy.has.and.returnValue(Promise.resolve(true));
-    const configInStorage = structuredClone(sampleIndexResponse);
-    configInStorage.backend.SCVersion = '1.0.0';
-    storageProviderSpy.get.and.returnValue(Promise.resolve(configInStorage));
-    // sets StApps core version which has the same major version
-    configProvider.scVersion = '1.1.1';
-    await configProvider.init();
-
-    expect(configProvider.getAnyValue('app')).toEqual(configInStorage.app);
-  });
-
   it('should throw error on saved app configuration not available', async () => {
     storageProviderSpy.has.and.returnValue(Promise.resolve(false));
     // eslint-disable-next-line unicorn/error-message

frontend/app/src/app/modules/config/config.provider.ts

@@ -132,7 +132,7 @@ export class ConfigProvider {
       this.config = await this.loadLocal();
       this.firstSession = false;
       this.logger.log(`initialised configuration from storage`);
-      if (this.config.backend.SCVersion.split('.')[0] !== this.scVersion.split('.')[0]) {
+      if (this.config.backend.SCVersion !== this.scVersion) {
         loadError = new WrongConfigVersionInStorage(this.scVersion, this.config.backend.SCVersion);
       }
     } catch (error) {

frontend/app/src/app/modules/library/account/profile/profile-page.component.ts

@@ -25,6 +25,8 @@ import {PAIAPatron} from '../../types';
 export class ProfilePageComponent {
   patron?: PAIAPatron;
 
+  propertiesToShow: (keyof PAIAPatron)[] = ['id', 'name', 'email', 'address', 'expires'];
+
   constructor(private readonly libraryAccountService: LibraryAccountService) {}
 
   async ionViewWillEnter(): Promise<void> {

frontend/app/src/app/modules/library/account/profile/profile-page.html

@@ -26,45 +26,27 @@
     <ion-card>
       <ion-card-content>
         <ion-grid>
-          <ion-row>
-            <ion-col> {{ 'library.account.pages.profile.labels.id' | translate }}: </ion-col>
-            <ion-col>
-              {{ patron.id }}
-            </ion-col>
-          </ion-row>
-          <ion-row>
-            <ion-col> {{ 'library.account.pages.profile.labels.name' | translate }}: </ion-col>
-            <ion-col> {{ patron.name_details?.title ?? '' }} {{ patron.name }} </ion-col>
-          </ion-row>
-          @if (patron.email) {
-            <ion-row>
-              <ion-col> {{ 'library.account.pages.profile.labels.email' | translate }}: </ion-col>
-              <ion-col>
-                {{ patron.email }}
-              </ion-col>
-            </ion-row>
-          }
-          @if (patron.address) {
-            <ion-row>
-              <ion-col> {{ 'library.account.pages.profile.labels.address' | translate }}: </ion-col>
-              <ion-col>
-                {{ patron.address }}
-              </ion-col>
-            </ion-row>
-          }
-          @if (patron.expires) {
-            <ion-row>
-              <ion-col> {{ 'library.account.pages.profile.labels.expires' | translate }}: </ion-col>
-              <ion-col>
-                @if (isUnlimitedExpiry(patron.expires)) {
-                  {{ 'library.account.pages.profile.values.unlimited' | translate }}
-                } @else {
-                  {{ 'library.account.pages.profile.values.expires' | translate }}:&nbsp;{{
-                    patron.expires | amDateFormat: 'll'
-                  }}
-                }
-              </ion-col>
-            </ion-row>
+          @for (property of propertiesToShow; track property) {
+            @if (patron[property]) {
+              <ion-row>
+                <ion-col>
+                  {{ 'library.account.pages.profile.labels' + '.' + property | translate }}:
+                </ion-col>
+                <ion-col>
+                  @if (!['expires'].includes(property)) {
+                    {{ patron[property] }}
+                  } @else {
+                    @if (isUnlimitedExpiry(patron['expires'])) {
+                      {{ 'library.account.pages.profile.values.unlimited' | translate }}
+                    } @else {
+                      {{ 'library.account.pages.profile.values.expires' | translate }}:&nbsp;{{
+                        patron['expires'] | amDateFormat: 'll'
+                      }}
+                    }
+                  }
+                </ion-col>
+              </ion-row>
+            }
           }
         </ion-grid>
       </ion-card-content>

frontend/app/src/app/modules/library/types.ts

@@ -22,13 +22,6 @@ export interface PAIAPatron {
   status?: PAIAPatronStatus;
   type?: string;
   note?: string;
-  // HeBIS specific property (not in PAIA documentation)
-  name_details?: {
-    firstname?: string;
-    lastname?: string;
-    gender?: string;
-    title?: string;
-  };
 }
 
 export enum PAIAPatronStatus {

frontend/app/src/environments/environment.production.ts

@@ -21,7 +21,7 @@ export const environment = {
   backend_url: 'https://mobile.server.uni-frankfurt.de',
   app_host: 'mobile.app.uni-frankfurt.de',
   custom_url_scheme: 'de.anyschool.app',
-  backend_version: '3.3.0',
+  backend_version: '999.0.0',
   production: true,
 };
 

images/app-builder/Dockerfile

@@ -8,7 +8,7 @@ LABEL version="2.0.0" \
 ### Configure versions to install
 ENV	ANDROID_APIS="android-33" \
   ANDROID_BUILD_TOOLS_VERSION="30.0.2" \
-  NPM_VERSION="^10.0.0" \
+  NPM_VERSION="^9.0.0" \
   IONIC_VERSION="^6.0.0" \
   CORDOVA_RES_VERSION="latest" \
   ### Configure download URLs

images/app-builder/scripts/node_setup.sh

@@ -1,108 +1,372 @@
 #!/bin/bash
 
-# Logger Function
-log() {
-  local message="$1"
-  local type="$2"
-  local timestamp=$(date '+%Y-%m-%d %H:%M:%S')
-  local color
-  local endcolor="\033[0m"
+# Discussion, issues and change requests at:
+#   https://github.com/nodesource/distributions
+#
+# Script to install the NodeSource Node.js 18.x repo onto a
+# Debian or Ubuntu system.
+#
+# Run as root or insert `sudo -E` before `bash`:
+#
+# curl -sL https://deb.nodesource.com/setup_18.x | bash -
+#   or
+# wget -qO- https://deb.nodesource.com/setup_18.x | bash -
+#
+# CONTRIBUTIONS TO THIS SCRIPT
+#
+# This script is built from a template in
+# https://github.com/nodesource/distributions/tree/master/deb/src
+# please don't submit pull requests against the built scripts.
+#
 
-  case "$type" in
-    "info") color="\033[38;5;79m" ;;
-    "success") color="\033[1;32m" ;;
-    "error") color="\033[1;31m" ;;
-    *) color="\033[1;34m" ;;
-  esac
 
-  echo -e "${color}${timestamp} - ${message}${endcolor}"
+export DEBIAN_FRONTEND=noninteractive
+SCRSUFFIX="_18.x"
+NODENAME="Node.js 18.x"
+NODEREPO="node_18.x"
+NODEPKG="nodejs"
+
+print_status() {
+    echo
+    echo "## $1"
+    echo
 }
 
-# Error handler function
-handle_error() {
-  local exit_code=$1
-  local error_message="$2"
-  log "Error: $error_message (Exit Code: $exit_code)" "error"
-  exit $exit_code
+if test -t 1; then # if terminal
+    ncolors=$(which tput > /dev/null && tput colors) # supports color
+    if test -n "$ncolors" && test $ncolors -ge 8; then
+        termcols=$(tput cols)
+        bold="$(tput bold)"
+        underline="$(tput smul)"
+        standout="$(tput smso)"
+        normal="$(tput sgr0)"
+        black="$(tput setaf 0)"
+        red="$(tput setaf 1)"
+        green="$(tput setaf 2)"
+        yellow="$(tput setaf 3)"
+        blue="$(tput setaf 4)"
+        magenta="$(tput setaf 5)"
+        cyan="$(tput setaf 6)"
+        white="$(tput setaf 7)"
+    fi
+fi
+
+print_bold() {
+    title="$1"
+    text="$2"
+
+    echo
+    echo "${red}================================================================================${normal}"
+    echo "${red}================================================================================${normal}"
+    echo
+    echo -e "  ${bold}${yellow}${title}${normal}"
+    echo
+    echo -en "  ${text}"
+    echo
+    echo "${red}================================================================================${normal}"
+    echo "${red}================================================================================${normal}"
 }
 
-# Function to check for command availability
-command_exists() {
-  command -v "$1" &> /dev/null
+bail() {
+    echo 'Error executing command, exiting'
+    exit 1
 }
 
-check_os() {
-    if ! [ -f "/etc/debian_version" ]; then
-        echo "Error: This script is only supported on Debian-based systems."
-        exit 1
+exec_cmd_nobail() {
+    echo "+ $1"
+    bash -c "$1"
+}
+
+exec_cmd() {
+    exec_cmd_nobail "$1" || bail
+}
+
+node_deprecation_warning() {
+    if [[ "X${NODENAME}" == "Xio.js 1.x" ||
+          "X${NODENAME}" == "Xio.js 2.x" ||
+          "X${NODENAME}" == "Xio.js 3.x" ||
+          "X${NODENAME}" == "XNode.js 0.10" ||
+          "X${NODENAME}" == "XNode.js 0.12" ||
+          "X${NODENAME}" == "XNode.js 4.x LTS Argon" ||
+          "X${NODENAME}" == "XNode.js 5.x" ||
+          "X${NODENAME}" == "XNode.js 6.x LTS Boron" ||
+          "X${NODENAME}" == "XNode.js 7.x" ||
+          "X${NODENAME}" == "XNode.js 8.x LTS Carbon" ||
+          "X${NODENAME}" == "XNode.js 9.x" ||
+          "X${NODENAME}" == "XNode.js 10.x" ||
+          "X${NODENAME}" == "XNode.js 11.x" || 
+          "X${NODENAME}" == "XNode.js 12.x" ||
+          "X${NODENAME}" == "XNode.js 13.x" ||
+          "X${NODENAME}" == "XNode.js 14.x" ||
+          "X${NODENAME}" == "XNode.js 15.x" ||
+          "X${NODENAME}" == "XNode.js 17.x" ]]; then
+
+        print_bold \
+"                            DEPRECATION WARNING                            " "\
+${bold}${NODENAME} is no longer actively supported!${normal}
+
+  ${bold}You will not receive security or critical stability updates${normal} for this version.
+
+  You should migrate to a supported version of Node.js as soon as possible.
+  Use the installation script that corresponds to the version of Node.js you
+  wish to install. e.g.
+
+   * ${green}https://deb.nodesource.com/setup_16.x — Node.js 16 \"Gallium\"${normal}
+   * ${green}https://deb.nodesource.com/setup_18.x — Node.js 18 LTS \"Hydrogen\"${normal} (recommended)
+   * ${green}https://deb.nodesource.com/setup_19.x — Node.js 19 \"Nineteen\"${normal}
+   * ${green}https://deb.nodesource.com/setup_20.x — Node.js 20 \"Iron\"${normal} (current)
+
+  Please see ${bold}https://github.com/nodejs/Release${normal} for details about which
+  version may be appropriate for you.
+
+  The ${bold}NodeSource${normal} Node.js distributions repository contains
+  information both about supported versions of Node.js and supported Linux
+  distributions. To learn more about usage, see the repository:
+    ${bold}https://github.com/nodesource/distributions${normal}
+"
+        echo
+        echo "Continuing in 20 seconds ..."
+        echo
+        sleep 20
     fi
 }
 
-# Function to Install the script pre-requisites
-install_pre_reqs() {
-    log "Installing pre-requisites" "info"
+script_deprecation_warning() {
+    if [ "X${SCRSUFFIX}" == "X" ]; then
+        print_bold \
+"                         SCRIPT DEPRECATION WARNING                         " "\
+This script, located at ${bold}https://deb.nodesource.com/setup${normal}, used to
+  install Node.js 0.10, is deprecated and will eventually be made inactive.
 
-    # Run 'apt-get update'
-    if ! apt-get update -y; then
-        handle_error "$?" "Failed to run 'apt-get update'"
-    fi
+  You should use the script that corresponds to the version of Node.js you
+  wish to install. e.g.
 
-    # Run 'apt-get install'
-    if ! apt-get install -y apt-transport-https ca-certificates curl gnupg; then
-        handle_error "$?" "Failed to install packages"
-    fi
+   * ${green}https://deb.nodesource.com/setup_16.x — Node.js 16 \"Gallium\"${normal}
+   * ${green}https://deb.nodesource.com/setup_18.x — Node.js 18 LTS \"Hydrogen\"${normal} (recommended)
+   * ${green}https://deb.nodesource.com/setup_19.x — Node.js 19 \"Nineteen\"${normal}
+   * ${green}https://deb.nodesource.com/setup_20.x — Node.js 20 \"Iron\"${normal} (current)
 
-    if ! mkdir -p /usr/share/keyrings; then
-      handle_error "$?" "Makes sure the path /usr/share/keyrings exist or run ' mkdir -p /usr/share/keyrings' with sudo"
-    fi
+  Please see ${bold}https://github.com/nodejs/Release${normal} for details about which
+  version may be appropriate for you.
 
-    rm -f /usr/share/keyrings/nodesource.gpg || true
-    rm -f /etc/apt/sources.list.d/nodesource.list || true
+  The ${bold}NodeSource${normal} Node.js Linux distributions GitHub repository contains
+  information about which versions of Node.js and which Linux distributions
+  are supported and how to use the install scripts.
+    ${bold}https://github.com/nodesource/distributions${normal}
+"
 
-    # Run 'curl' and 'gpg'
-    if ! curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /usr/share/keyrings/nodesource.gpg; then
-      handle_error "$?" "Failed to download and import the NodeSource signing key"
+        echo
+        echo "Continuing in 20 seconds (press Ctrl-C to abort) ..."
+        echo
+        sleep 20
     fi
 }
 
-# Function to configure the Repo
-configure_repo() {
-    local node_version=$1
+setup() {
 
-    arch=$(dpkg --print-architecture)
-    if [ "$arch" != "amd64" ] && [ "$arch" != "arm64" ] && [ "$arch" != "armhf" ]; then
-      handle_error "1" "Unsupported architecture: $arch. Only amd64, arm64, and armhf are supported."
-    fi
+script_deprecation_warning
+node_deprecation_warning
 
-    echo "deb [arch=$arch signed-by=/usr/share/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$node_version nodistro main" | tee /etc/apt/sources.list.d/nodesource.list > /dev/null
+print_status "Installing the NodeSource ${NODENAME} repo..."
 
-    # N|solid Config
-    echo "Package: nsolid" | tee /etc/apt/preferences.d/nsolid > /dev/null
-    echo "Pin: origin deb.nodesource.com" | tee -a /etc/apt/preferences.d/nsolid > /dev/null
-    echo "Pin-Priority: 600" | tee -a /etc/apt/preferences.d/nsolid > /dev/null
+if $(uname -m | grep -Eq ^armv6); then
+    print_status "You appear to be running on ARMv6 hardware. Unfortunately this is not currently supported by the NodeSource Linux distributions. Please use the 'linux-armv6l' binary tarballs available directly from nodejs.org for Node.js 4 and later."
+    exit 1
+fi
 
-    # Nodejs Config
-    echo "Package: nodejs" | tee /etc/apt/preferences.d/nodejs > /dev/null
-    echo "Pin: origin deb.nodesource.com" | tee -a /etc/apt/preferences.d/nodejs > /dev/null
-    echo "Pin-Priority: 600" | tee -a /etc/apt/preferences.d/nodejs > /dev/null
+PRE_INSTALL_PKGS=""
 
-    # Run 'apt-get update'
-    if ! apt-get update -y; then
-        handle_error "$?" "Failed to run 'apt-get update'"
-    else
-        log "Repository configured successfully."
-        log "To install Node.js, run: apt-get install nodejs -y" "info"
-        log "You can use N|solid Runtime as a node.js alternative" "info"
-        log "To install N|solid Runtime, run: apt-get install nsolid -y \n" "success"
+# Check that HTTPS transport is available to APT
+# (Check snaked from: https://get.docker.io/ubuntu/)
+
+if [ ! -e /usr/lib/apt/methods/https ]; then
+    PRE_INSTALL_PKGS="${PRE_INSTALL_PKGS} apt-transport-https"
+fi
+
+if [ ! -x /usr/bin/lsb_release ]; then
+    PRE_INSTALL_PKGS="${PRE_INSTALL_PKGS} lsb-release"
+fi
+
+if [ ! -x /usr/bin/curl ] && [ ! -x /usr/bin/wget ]; then
+    PRE_INSTALL_PKGS="${PRE_INSTALL_PKGS} curl"
+fi
+
+# Used by apt-key to add new keys
+
+if [ ! -x /usr/bin/gpg ]; then
+    PRE_INSTALL_PKGS="${PRE_INSTALL_PKGS} gnupg"
+fi
+
+# Populating Cache
+print_status "Populating apt-get cache..."
+exec_cmd 'apt-get update'
+
+if [ "X${PRE_INSTALL_PKGS}" != "X" ]; then
+    print_status "Installing packages required for setup:${PRE_INSTALL_PKGS}..."
+    # This next command needs to be redirected to /dev/null or the script will bork
+    # in some environments
+    exec_cmd "apt-get install -y${PRE_INSTALL_PKGS} > /dev/null 2>&1"
+fi
+
+IS_PRERELEASE=$(lsb_release -d | grep 'Ubuntu .*development' >& /dev/null; echo $?)
+if [[ $IS_PRERELEASE -eq 0 ]]; then
+    print_status "Your distribution, identified as \"$(lsb_release -d -s)\", is a pre-release version of Ubuntu. NodeSource does not maintain official support for Ubuntu versions until they are formally released. You can try using the manual installation instructions available at https://github.com/nodesource/distributions and use the latest supported Ubuntu version name as the distribution identifier, although this is not guaranteed to work."
+    exit 1
+fi
+
+DISTRO=$(lsb_release -c -s)
+
+check_alt() {
+    if [ "X${DISTRO}" == "X${2}" ]; then
+        echo
+        echo "## You seem to be using ${1} version ${DISTRO}."
+        echo "## This maps to ${3} \"${4}\"... Adjusting for you..."
+        DISTRO="${4}"
     fi
 }
 
-# Define Node.js version
-NODE_VERSION="18.x"
+check_alt "Astra Linux"    "orel"            "Debian"        "stretch"
+check_alt "BOSS"           "anokha"          "Debian"        "wheezy"
+check_alt "BOSS"           "anoop"           "Debian"        "jessie"
+check_alt "BOSS"           "drishti"         "Debian"        "stretch"
+check_alt "BOSS"           "unnati"          "Debian"        "buster"
+check_alt "BOSS"           "urja"            "Debian"        "bullseye"
+check_alt "bunsenlabs"     "bunsen-hydrogen" "Debian"        "jessie"
+check_alt "bunsenlabs"     "helium"          "Debian"        "stretch"
+check_alt "bunsenlabs"     "lithium"         "Debian"        "buster"
+check_alt "Devuan"         "jessie"          "Debian"        "jessie"
+check_alt "Devuan"         "ascii"           "Debian"        "stretch"
+check_alt "Devuan"         "beowulf"         "Debian"        "buster"
+check_alt "Devuan"         "chimaera"        "Debian"        "bullseye"
+check_alt "Devuan"         "ceres"           "Debian"        "sid"
+check_alt "Devuan"         "daedalus"        "Debian"        "bookworm"
+check_alt "Deepin"         "panda"           "Debian"        "sid"
+check_alt "Deepin"         "unstable"        "Debian"        "sid"
+check_alt "Deepin"         "stable"          "Debian"        "buster"
+check_alt "Deepin"         "apricot"         "Debian"        "buster"
+check_alt "Deepin"         "beige"           "Debian"        "bookworm"
+check_alt "elementaryOS"   "luna"            "Ubuntu"        "precise"
+check_alt "elementaryOS"   "freya"           "Ubuntu"        "trusty"
+check_alt "elementaryOS"   "loki"            "Ubuntu"        "xenial"
+check_alt "elementaryOS"   "juno"            "Ubuntu"        "bionic"
+check_alt "elementaryOS"   "hera"            "Ubuntu"        "bionic"
+check_alt "elementaryOS"   "odin"            "Ubuntu"        "focal"
+check_alt "elementaryOS"   "jolnir"          "Ubuntu"        "focal"
+check_alt "elementaryOS"   "horus"           "Ubuntu"        "jammy"
+check_alt "Kali"           "sana"            "Debian"        "jessie"
+check_alt "Kali"           "kali-rolling"    "Debian"        "bullseye"
+check_alt "Linux Mint"     "maya"            "Ubuntu"        "precise"
+check_alt "Linux Mint"     "qiana"           "Ubuntu"        "trusty"
+check_alt "Linux Mint"     "rafaela"         "Ubuntu"        "trusty"
+check_alt "Linux Mint"     "rebecca"         "Ubuntu"        "trusty"
+check_alt "Linux Mint"     "rosa"            "Ubuntu"        "trusty"
+check_alt "Linux Mint"     "sarah"           "Ubuntu"        "xenial"
+check_alt "Linux Mint"     "serena"          "Ubuntu"        "xenial"
+check_alt "Linux Mint"     "sonya"           "Ubuntu"        "xenial"
+check_alt "Linux Mint"     "sylvia"          "Ubuntu"        "xenial"
+check_alt "Linux Mint"     "tara"            "Ubuntu"        "bionic"
+check_alt "Linux Mint"     "tessa"           "Ubuntu"        "bionic"
+check_alt "Linux Mint"     "tina"            "Ubuntu"        "bionic"
+check_alt "Linux Mint"     "tricia"          "Ubuntu"        "bionic"
+check_alt "Linux Mint"     "ulyana"          "Ubuntu"        "focal"
+check_alt "Linux Mint"     "ulyssa"          "Ubuntu"        "focal"
+check_alt "Linux Mint"     "uma"             "Ubuntu"        "focal"
+check_alt "Linux Mint"     "una"             "Ubuntu"        "focal"
+check_alt "Linux Mint"     "vanessa"         "Ubuntu"        "jammy"
+check_alt "Linux Mint"     "vera"            "Ubuntu"        "jammy"
+check_alt "Liquid Lemur"   "lemur-3"         "Debian"        "stretch"
+check_alt "LMDE"           "betsy"           "Debian"        "jessie"
+check_alt "LMDE"           "cindy"           "Debian"        "stretch"
+check_alt "LMDE"           "debbie"          "Debian"        "buster"
+check_alt "LMDE"           "elsie"           "Debian"        "bullseye"
+check_alt "MX Linux 17"    "Horizon"         "Debian"        "stretch"
+check_alt "MX Linux 18"    "Continuum"       "Debian"        "stretch"
+check_alt "MX Linux 19"    "patito feo"      "Debian"        "buster"
+check_alt "MX Linux 21"    "wildflower"      "Debian"        "bullseye"
+check_alt "Pardus"         "onyedi"          "Debian"        "stretch"
+check_alt "Parrot"         "ara"             "Debian"        "bullseye"
+check_alt "PureOS"         "green"           "Debian"        "sid"
+check_alt "PureOS"         "amber"           "Debian"        "buster"
+check_alt "PureOS"         "byzantium"       "Debian"        "bullseye"
+check_alt "SolydXK"        "solydxk-9"       "Debian"        "stretch"
+check_alt "Sparky Linux"   "Tyche"           "Debian"        "stretch"
+check_alt "Sparky Linux"   "Nibiru"          "Debian"        "buster"
+check_alt "Sparky Linux"   "Po-Tolo"         "Debian"        "bullseye"
+check_alt "Tanglu"         "chromodoris"     "Debian"        "jessie"
+check_alt "Trisquel"       "toutatis"        "Ubuntu"        "precise"
+check_alt "Trisquel"       "belenos"         "Ubuntu"        "trusty"
+check_alt "Trisquel"       "flidas"          "Ubuntu"        "xenial"
+check_alt "Trisquel"       "etiona"          "Ubuntu"        "bionic"
+check_alt "Ubilinux"       "dolcetto"        "Debian"        "stretch"
+check_alt "Uruk GNU/Linux" "lugalbanda"      "Ubuntu"        "xenial"
 
-# Check OS
-check_os
+if [ "X${DISTRO}" == "Xdebian" ]; then
+  print_status "Unknown Debian-based distribution, checking /etc/debian_version..."
+  NEWDISTRO=$([ -e /etc/debian_version ] && cut -d/ -f1 < /etc/debian_version)
+  if [ "X${NEWDISTRO}" == "X" ]; then
+    print_status "Could not determine distribution from /etc/debian_version..."
+  else
+    DISTRO=$NEWDISTRO
+    print_status "Found \"${DISTRO}\" in /etc/debian_version..."
+  fi
+fi
 
-# Main execution
-install_pre_reqs || handle_error $? "Failed installing pre-requisites"
-configure_repo "$NODE_VERSION" || handle_error $? "Failed configuring repository"
+print_status "Confirming \"${DISTRO}\" is supported..."
+
+if [ -x /usr/bin/curl ]; then
+    exec_cmd_nobail "curl -sLf -o /dev/null 'https://deb.nodesource.com/${NODEREPO}/dists/${DISTRO}/Release'"
+    RC=$?
+else
+    exec_cmd_nobail "wget -qO /dev/null -o /dev/null 'https://deb.nodesource.com/${NODEREPO}/dists/${DISTRO}/Release'"
+    RC=$?
+fi
+
+if [[ $RC != 0 ]]; then
+    print_status "Your distribution, identified as \"${DISTRO}\", is not currently supported, please contact NodeSource at https://github.com/nodesource/distributions/issues if you think this is incorrect or would like your distribution to be considered for support"
+    exit 1
+fi
+
+if [ -f "/etc/apt/sources.list.d/chris-lea-node_js-$DISTRO.list" ]; then
+    print_status 'Removing Launchpad PPA Repository for NodeJS...'
+
+    exec_cmd_nobail 'add-apt-repository -y -r ppa:chris-lea/node.js'
+    exec_cmd "rm -f /etc/apt/sources.list.d/chris-lea-node_js-${DISTRO}.list"
+fi
+
+print_status 'Adding the NodeSource signing key to your keyring...'
+keyring='/usr/share/keyrings'
+node_key_url="https://deb.nodesource.com/gpgkey/nodesource.gpg.key"
+local_node_key="$keyring/nodesource.gpg"
+
+if [ -x /usr/bin/curl ]; then
+    exec_cmd "curl -s $node_key_url | gpg --dearmor | tee $local_node_key >/dev/null"
+else
+    exec_cmd "wget -q -O - $node_key_url | gpg --dearmor | tee $local_node_key >/dev/null"
+fi
+
+print_status "Creating apt sources list file for the NodeSource ${NODENAME} repo..."
+
+exec_cmd "echo 'deb [signed-by=$local_node_key] https://deb.nodesource.com/${NODEREPO} ${DISTRO} main' > /etc/apt/sources.list.d/nodesource.list"
+exec_cmd "echo 'deb-src [signed-by=$local_node_key] https://deb.nodesource.com/${NODEREPO} ${DISTRO} main' >> /etc/apt/sources.list.d/nodesource.list"
+
+print_status 'Running `apt-get update` for you...'
+
+exec_cmd 'apt-get update'
+
+yarn_site='https://dl.yarnpkg.com/debian'
+yarn_key_url="$yarn_site/pubkey.gpg"
+local_yarn_key="$keyring/yarnkey.gpg"
+
+print_status """Run \`${bold}sudo apt-get install -y ${NODEPKG}${normal}\` to install ${NODENAME} and npm
+## You may also need development tools to build native addons:
+     sudo apt-get install gcc g++ make
+## To install the Yarn package manager, run:
+     curl -sL $yarn_key_url | gpg --dearmor | sudo tee $local_yarn_key >/dev/null
+     echo \"deb [signed-by=$local_yarn_key] $yarn_site stable main\" | sudo tee /etc/apt/sources.list.d/yarn.list
+     sudo apt-get update && sudo apt-get install yarn
+"""
+
+}
+
+## Defer setup until we have the complete script
+setup

package.json

@@ -18,7 +18,7 @@
     "format:fix": "dotenv -c -- turbo run format:fix",
     "lint": "dotenv -c -- turbo run lint",
     "lint:fix": "dotenv -c -- turbo run lint:fix",
-    "publish-packages": "pnpm changeset version && pnpm syncpack:fix && pnpm install && pnpm format:fix && git add . && git commit -m \"docs: update changelogs for release\" -m \"ci: publish release\" && git push && pnpm changeset tag && git push --follow-tags",
+    "publish-packages": "pnpm changeset version && pnpm syncpack:fix && pnpm install && git add . && git commit -m \"docs: update changelogs for release\n\nci: publish release\" && git push && pnpm changeset tag && git push --follow-tags",
     "syncpack": "syncpack list-mismatches && syncpack lint-semver-ranges --types dev,peer,prod",
     "syncpack:fix": "syncpack format && syncpack fix-mismatches",
     "test": "trap 'node coverage.mjs' EXIT && dotenv -c -- turbo run test",
@@ -43,5 +43,10 @@
     "turbo-ignore": "1.10.16",
     "typedoc": "0.25.12",
     "typescript": "5.4.2"
+  },
+  "pnpm": {
+    "patchedDependencies": {
+      "eslint-plugin-header@3.1.1": "patches/eslint-plugin-header@3.1.1.patch"
+    }
   }
 }

packages/api-cli/CHANGELOG.md

@@ -1,13 +1,5 @@
 # @openstapps/api-cli
 
-## 3.3.2
-
-### Patch Changes
-
-- @openstapps/core@3.3.2
-- @openstapps/core-tools@3.3.2
-- @openstapps/api@3.3.2
-
 ## 3.3.0
 
 ### Minor Changes

packages/api-cli/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openstapps/api-cli",
   "description": "CLI client for @openstapps/api",
-  "version": "3.3.2",
+  "version": "3.3.0",
   "type": "module",
   "license": "GPL-3.0-only",
   "repository": "git@gitlab.com:openstapps/api.git",

packages/api-plugin/CHANGELOG.md

@@ -1,13 +1,5 @@
 # @openstapps/api-plugin
 
-## 3.3.2
-
-### Patch Changes
-
-- @openstapps/core@3.3.2
-- @openstapps/core-tools@3.3.2
-- @openstapps/api@3.3.2
-
 ## 3.3.0
 
 ### Patch Changes

packages/api-plugin/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openstapps/api-plugin",
   "description": "Node.js library to interact with the StApps backend service",
-  "version": "3.3.2",
+  "version": "3.3.0",
   "type": "module",
   "license": "GPL-3.0-only",
   "repository": "git@gitlab.com:openstapps/api.git",

packages/api/CHANGELOG.md

@@ -1,11 +1,5 @@
 # @openstapps/api
 
-## 3.3.2
-
-### Patch Changes
-
-- @openstapps/core@3.3.2
-
 ## 3.3.0
 
 ### Minor Changes

packages/api/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openstapps/api",
   "description": "Node.js library to interact with the StApps backend service",
-  "version": "3.3.2",
+  "version": "3.3.0",
   "type": "module",
   "license": "GPL-3.0-only",
   "repository": "git@gitlab.com:openstapps/api.git",

packages/core-tools/CHANGELOG.md

@@ -1,12 +1,5 @@
 # @openstapps/core-tools
 
-## 3.3.2
-
-### Patch Changes
-
-- Updated dependencies [802a7a3f]
-  - @openstapps/easy-ast@3.3.2
-
 ## 3.3.0
 
 ### Patch Changes

packages/core-tools/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openstapps/core-tools",
   "description": "Tools to convert and validate StAppsCore",
-  "version": "3.3.2",
+  "version": "3.3.0",
   "type": "module",
   "license": "GPL-3.0-only",
   "repository": "git@gitlab.com:openstapps/core-tools.git",

packages/core/CHANGELOG.md

@@ -1,11 +1,5 @@
 # @openstapps/core
 
-## 3.3.2
-
-### Patch Changes
-
-- @openstapps/core-tools@3.3.2
-
 ## 3.3.0
 
 ### Minor Changes

packages/core/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openstapps/core",
   "description": "StAppsCore - Generalized model of data",
-  "version": "3.3.2",
+  "version": "3.3.0",
   "type": "module",
   "license": "GPL-3.0-only",
   "repository": "git@gitlab.com:openstapps/core.git",

packages/easy-ast/CHANGELOG.md

@@ -1,11 +1,5 @@
 # @openstapps/easy-ast
 
-## 3.3.2
-
-### Patch Changes
-
-- 802a7a3f: Fixed docs generation
-
 ## 3.3.0
 
 ### Minor Changes

packages/easy-ast/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openstapps/easy-ast",
   "description": "Tool to easily handle TypeScript AST",
-  "version": "3.3.2",
+  "version": "3.3.0",
   "type": "module",
   "license": "GPL-3.0-only",
   "repository": "git@gitlab.com:openstapps/core-tools.git",

patches/eslint-plugin-header@3.1.1.patch

@@ -0,0 +1,41 @@
+diff --git a/lib/rules/header.js b/lib/rules/header.js
+index 3504b6fc59b780674e652ad1ca944cb3577b8fed..d86dc0b490845c22f54ae83dbc52efcf448e628b 100644
+--- a/lib/rules/header.js
++++ b/lib/rules/header.js
+@@ -27,6 +27,9 @@ function excludeShebangs(comments) {
+ // check if they are at the start of the file since that is already checked by
+ // hasHeader().
+ function getLeadingComments(context, node) {
++    if (!node.body) {
++        return context.getSourceCode().ast.comments;
++    }
+     var all = excludeShebangs(context.getSourceCode().getAllComments(node.body.length ? node.body[0] : node));
+     if (all[0].type.toLowerCase() === "block") {
+         return [all[0]];
+@@ -44,6 +47,8 @@ function genCommentBody(commentType, textArray, eol, numNewlines) {
+     var eols = eol.repeat(numNewlines);
+     if (commentType === "block") {
+         return "/*" + textArray.join(eol) + "*/" + eols;
++    } else if (commentType === "block-html") {
++        return "<!--\n  " + textArray.join(eol) + "\n  -->" + eols;
+     } else {
+         return "//" + textArray.join(eol + "//") + eols;
+     }
+@@ -103,7 +108,7 @@ function hasHeader(src) {
+             src = src.slice(m.index + m[0].length);
+         }
+     }
+-    return src.substr(0, 2) === "/*" || src.substr(0, 2) === "//";
++    return src.substr(0, 2) === "/*" || src.substr(0, 2) === "//" || src.substr(0, 4) === "<!--";
+ }
+
+ function matchesLineEndings(src, num) {
+@@ -180,7 +185,7 @@ module.exports = {
+                             message: "missing header",
+                             fix: canFix ? genPrependFixer(commentType, node, fixLines, eol, numNewlines) : null
+                         });
+-                    } else if (leadingComments[0].type.toLowerCase() !== commentType) {
++                    } else if (leadingComments[0].type.toLowerCase() !== commentType.replace(/-html$/, '')) {
+                         context.report({
+                             loc: node.loc,
+                             message: "header should be a {{commentType}} comment",

pnpm-lock.yaml

@@ -4,6 +4,11 @@ settings:
   autoInstallPeers: true
   excludeLinksFromLockfile: false
 
+patchedDependencies:
+  eslint-plugin-header@3.1.1:
+    hash: pgohhqwij7scbwihbawhnhtg3i
+    path: patches/eslint-plugin-header@3.1.1.patch
+
 importers:
 
   .: