@signageos/lib 10.19.2 → 10.19.3-master.1923

package/CHANGELOG.md

@@ -16,9 +16,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - New extension pack of typescript type: `NullableFromPartial`
 
-### Fixed
-- Replaced `isDefinedForEnvironment` with `isValidForEnvironment`
-
 ## [10.18.1] - 2023-05-23
 ### Security
 - Fixed potential NPM vulnerabilities

package/README.md

@@ -1,6 +1,10 @@
 # General Library
 
-Shared code accross all services
+This repository contains all sets of generic TypeScript tools and utils for different technologies, like databases: 'MongoDB, AMQP (RabbitMQ), Redis, PostgreSQL, InfluxDB', monitoring in Prometheus, wrappers and helpers for Azure SDK, Browser Storage, time management, observables, async iterators and a lot more.
+
+It's published as an npm library @signageos/lib that can be used in any project that requires and is using those technologies to simplify the business logic.
+
+The library could be potentially separated into more libraries with a single purpose in the future. Currently, keeping the library in one package is still more practical than maintaining it separately.
 
 1) execute `docker-compose up -d`
 2) fill following file `config/env.test.json`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signageos/lib",
-  "version": "10.19.2",
+  "version": "10.19.3-master.1923",
   "main": "./dist",
   "files": [
     "tools",
@@ -27,7 +27,8 @@
     "test-rabbit-connection": "DEBUG=@signageos/lib:Events:genericGracefulExit NODE_ENV=test node_modules/.bin/mocha --require should --require should-sinon --require ts-node/register --ui bdd  --watch-extensions ts --timeout 120000  tests/**/rabbitmqGracefulExit.connection-spec.ts",
     "watch": "tsc --watch",
     "check": "npm run depcheck && tools/check-deps.js",
-    "depcheck": "depcheck --config .depcheckrc.json"
+    "depcheck": "depcheck --config .depcheckrc.json",
+    "check:forbidden-dependencies": "node tools/check-forbidden-dependencies.js"
   },
   "author": "Michael Zabka <zabka.michael@gmail.com>",
   "license": "MIT",
@@ -61,8 +62,7 @@
   "devDependencies": {
     "@influxdata/influxdb-client": "1.16.0",
     "@istanbuljs/nyc-config-typescript": "1.0.2",
-    "@signageos/codestyle": "0.0.22",
-    "@signageos/common-types": "2.18.0",
+    "@signageos/codestyle": "0.0.23",
     "@types/amqplib": "0.5.13",
     "@types/async-lock": "1.1.1",
     "@types/debug": "0.0.29",

package/tools/check-forbidden-dependencies.js

@@ -0,0 +1,17 @@
+const packageJson = require('../package.json');
+const dependencies = packageJson.dependencies || {};
+const devDependencies = packageJson.devDependencies || {};
+
+const whitelist = ['@signageos/codestyle'];
+const packages = Object.keys(dependencies).concat(Object.keys(devDependencies));
+
+let forbiddenPackages = packages.filter((package) => package.match('@signageos/*'));
+forbiddenPackages = forbiddenPackages.filter((package) => !whitelist.includes(package));
+
+if (forbiddenPackages.length > 0) {
+	console.error(`    Forbidden packages ${forbiddenPackages.join(', ')} found in package.json. 
+@signageos/* modules can't be used as dependencies because they are private while this module is public and may only use public dependencies.
+Only exceptions are whitelisted dependencies: ${whitelist.join(', ')}
+`);
+	process.exit(1);
+}