Prepare for npm package

Author: manisandro

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 icons/build
 static/themes.json
+dist/

package.json

@@ -5,7 +5,18 @@
     "author": "Sourcepole AG",
     "license": "BSD-2-Clause",
     "repository": "[email protected]:qgis/qwc2.git",
+    "homepage": "https://https://qwc-services.github.io/",
+    "bugs": {
+        "url": "https://github.com/qgis/qwc2/issues"
+    },
+    "keywords": [
+        "qgis",
+        "webgis",
+        "mapping",
+        "geospatial"
+    ],
     "dependencies": {
+        "@furkot/webfonts-generator": "^2.0.2",
         "@giro3d/giro3d": "^0.42.2",
         "@kayahr/text-encoding": "^2.0.0",
         "@loaders.gl/core": "^4.3.3",
@@ -36,8 +47,10 @@
         "lodash.isequal": "^4.5.0",
         "lodash.omit": "^4.5.0",
         "mime-to-extensions": "^1.0.2",
+        "mkdirp": "^3.0.1",
         "mousetrap": "^1.6.5",
         "nearley": "^2.20.1",
+        "object-path": "^0.11.8",
         "ol": "^10.3.1",
         "ol-ext": "^4.0.24",
         "ol-mapbox-style": "^12.3.5",
@@ -74,13 +87,13 @@
         "uuid": "^11.0.3"
     },
     "devDependencies": {
+        "@babel/cli": "^7.27.0",
         "@babel/core": "^7.26.0",
         "@babel/eslint-parser": "^7.25.9",
         "@babel/plugin-transform-class-properties": "^7.25.9",
         "@babel/plugin-transform-object-rest-spread": "^7.25.9",
         "@babel/preset-env": "^7.26.0",
         "@babel/preset-react": "^7.26.3",
-        "@furkot/webfonts-generator": "^2.0.2",
         "@microsoft/eslint-formatter-sarif": "^3.1.0",
         "@types/react": "^18.3.1",
         "babel-loader": "^9.2.1",
@@ -92,8 +105,6 @@
         "eslint-plugin-perfectionist": "^2.10.0",
         "eslint-plugin-react": "^7.37.2",
         "html-webpack-plugin": "^5.6.3",
-        "mkdirp": "^3.0.1",
-        "object-path": "^0.11.8",
         "react-docgen": "^5.4.3",
         "source-map-loader": "^5.0.0",
         "style-loader": "^4.0.0",
@@ -103,13 +114,19 @@
         "webpack-cli": "^5.1.4",
         "webpack-dev-server": "^5.1.0"
     },
+    "bin": {
+        "qwc_build_iconfont": "./scripts/makeIconkit.js",
+        "qwc_gen_themesconfig": "./scripts/themesConfig.js",
+        "qwc_update_translations": "./scripts/updateTranslations.js"
+    },
     "scripts": {
         "prod": "npm run tsupdate && npm run themesconfig && npm run iconfont && webpack --mode production --progress",
         "start": "npm run tsupdate && npm run themesconfig && npm run iconfont && webpack serve --mode development --progress --host 0.0.0.0 --port 8081",
         "iconfont": "node scripts/makeIconkit.js",
         "themesconfig": "node scripts/themesConfig.js || :",
         "tsupdate": "node scripts/updateTranslations.js",
         "plugindoc": "node scripts/gen-plugin-docs.js",
+        "dist": "./scripts/dist.sh",
         "build": "npm run prod",
         "analyze": "webpack --mode production --json | webpack-bundle-size-analyzer",
         "release": "node -e \"process.exit(require('os').platform() === 'win32' ? 0 : 1)\" && scripts\\package-commands.bat release || ./scripts/package-commands.sh release"

scripts/dist.sh

@@ -0,0 +1,16 @@
+#/bin/bash
+
+rm -rf dist
+for dir in actions components libs plugins reducers scripts selectors stores utils;
+do
+mkdir -p dist/$dir
+npx babel $dir --copy-files --out-dir dist/$dir --extensions ".js,.jsx" --minified
+done
+mkdir -p dist/static/translations
+mkdir -p dist/icons
+cp -a icons/*.svg dist/icons/
+cp -a static/translations/*.json dist/static/translations/
+cp -a {package.json,LICENSE,README.md} dist/
+
+echo "Ready to publish!"
+echo "Run publish in the dist folder to publish the package."

scripts/gen-plugin-docs.js

@@ -1,3 +1,14 @@
+#!/usr/bin/env node
+
+/**
+ * Copyright 2024 Sourcepole AG
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+
 const fs = require("fs");
 const path = require("path");
 const reactDocs = require("react-docgen");

scripts/makeIconkit.js

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 const webfontsGenerator = require('@furkot/webfonts-generator');
 const glob = require('glob');
 const mkdirp = require('mkdirp');
@@ -12,12 +14,18 @@ const readJSON = (filename) => {
     }
 };
 
-const workspaces = readJSON('/package.json').workspaces || [];
+// Determine workspaces / dependencies
+const packageJson = readJSON('/package.json');
+const workspaces = packageJson.workspaces || [];
+const qwcDeps = Object.keys(packageJson.dependencies ?? {"qwc2": "0"}).filter(dep => dep.startsWith("qwc"));
 
 let icons = [];
 for (const workspace of workspaces) {
     icons = icons.concat(glob.sync(workspace + "/icons/*.svg"));
 }
+for (const qwcDep of qwcDeps) {
+    icons = icons.concat(glob.sync('node_modules/' + qwcDep + '/icons/*.svg'));
+}
 icons = icons.concat(glob.sync("icons/*.svg"));
 
 // Filter duplicate icons (user icons can override submodule icons, hence reverse)

scripts/themesConfig.js

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 /**
  * Copyright 2016-2024 Sourcepole AG
  * All rights reserved.

scripts/updateTranslations.js

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 /**
  * Copyright 2017-2024 Sourcepole AG
  * All rights reserved.
@@ -89,8 +91,10 @@ const updateTsConfig = (topdir, tsconfig, collectedMsgIds = null) => {
     return msgIds;
 };
 
-// Determine workspaces
-const workspaces = readJSON('/package.json').workspaces || [];
+// Determine workspaces / dependencies
+const packageJson = readJSON('/package.json');
+const workspaces = packageJson.workspaces || [];
+const qwcDeps = Object.keys(packageJson.dependencies ?? {qwc2: "0"}).filter(dep => dep.startsWith("qwc"));
 
 // Generate workspace translations
 let collectedMsgIds = new Set();
@@ -141,6 +145,10 @@ for (const lang of config.languages || []) {
     for (const workspace of workspaces) {
         data = merge(data, readJSON('/' + workspace + '/static/translations/' + lang + '.json'));
     }
+    // Merge translations from dependencies
+    for (const qwcDep of qwcDeps) {
+        data = merge(data, readJSON('/node_modules/' + qwcDep + '/static/translations/' + lang + '.json'));
+    }
 
     // Revert to original values for strings specified in overrides
     for (const path of config.overrides || []) {