update description

.gitignore

@@ -1,6 +1,20 @@
 .nogit/
-node_modules/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
 .yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,131 +1,122 @@
 # gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
 # ====================
-mirror:
-  stage: security
-  script:
-  - npmci git mirror
-  tags:
-  - docker
-  - notpriv
-
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-  - docker
-  - notpriv
+    - docker
+  allow_failure: true
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+    - docker
+
+testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - docker
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
+  only:
+    - tags
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g typescript
+    - npmci npm prepare
+    - npmci npm install
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install stable 
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command npm run buildDocs
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -133,15 +124,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
-  allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -2,5 +2,31 @@
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
+      "gitrepo": "smartlog-receiver",
+      "description": "A package that acts as a receiver for smartlog-destination-receiver, utilizing plugins for functionality.",
+      "npmPackagename": "@push.rocks/smartlog-receiver",
+      "license": "MIT",
+      "keywords": [
+        "logging",
+        "receiver",
+        "smartlog",
+        "authentication",
+        "validation",
+        "typescript",
+        "plugins",
+        "smartlog integration",
+        "log management",
+        "security"
+      ]
+    }
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
   }
-}
+}

package.json

@@ -1,28 +1,59 @@
 {
-  "name": "@pushrocks/smartlog-receiver",
-  "version": "1.0.9",
+  "name": "@push.rocks/smartlog-receiver",
+  "version": "2.0.0",
   "private": false,
-  "description": "a receiver for smartlog-destination-receiver",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "description": "A package that acts as a receiver for smartlog-destination-receiver, utilizing plugins for functionality.",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)",
-    "format": "(gitzone format)"
+    "build": "(tsbuild --web)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.11.2",
-    "tslint": "^5.20.0",
-    "tslint-config-prettier": "^1.18.0"
+    "@gitzone/tsbuild": "^2.1.63",
+    "@gitzone/tstest": "^1.0.72",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.6.1"
   },
   "dependencies": {
-    "@pushrocks/smarthash": "^2.0.6",
-    "@pushrocks/smartlog": "^2.0.21",
-    "@pushrocks/smartlog-interfaces": "^2.0.7"
+    "@pushrocks/smarthash": "^3.0.1",
+    "@pushrocks/smartlog": "^3.0.1",
+    "@pushrocks/smartlog-interfaces": "^2.0.23"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "type": "module",
+  "keywords": [
+    "logging",
+    "receiver",
+    "smartlog",
+    "authentication",
+    "validation",
+    "typescript",
+    "plugins",
+    "smartlog integration",
+    "log management",
+    "security"
+  ],
+  "homepage": "https://code.foss.global/push.rocks/smartlog-receiver",
+  "repository": {
+    "type": "git",
+    "url": "https://code.foss.global/push.rocks/smartlog-receiver.git"
   }
-}
+}

readme.hints.md

@@ -0,0 +1 @@
+ 

readme.md

@@ -0,0 +1,128 @@
+# @push.rocks/smartlog-receiver
+a receiver for smartlog-destination-receiver
+
+## Install
+
+To install `@push.rocks/smartlog-receiver`, use the following command with npm:
+
+```bash
+npm install @push.rocks/smartlog-receiver --save
+```
+
+or with yarn:
+
+```bash
+yarn add @push.rocks/smartlog-receiver
+```
+
+Ensure that you have TypeScript and Node.js installed in your development environment as this module leverages TypeScript for type definitions.
+
+## Usage
+
+The `@push.rocks/smartlog-receiver` module is designed to receive log messages sent from applications using the `smartlog` logging system. It allows for centralized logging by receiving, validating, and processing log messages in a secure and controlled manner. Below, we'll go through how to set up and use `smartlog-receiver` in your project.
+
+### Setting up SmartlogReceiver
+
+First, make sure to import `SmartlogReceiver` from the package, along with the types it depends on if necessary.
+
+```typescript
+import { SmartlogReceiver, ISmartlogReceiverOptions } from '@push.rocks/smartlog-receiver';
+import { Smartlog } from '@pushrocks/smartlog';
+```
+
+`SmartlogReceiver` requires an instance of `Smartlog` for logging internal messages and potentially logging the received log messages. Ensure you initialize `Smartlog` first:
+
+```typescript
+const smartlogInstance = new Smartlog({
+  logContext: {
+    company: 'YourCompany',
+    companyunit: 'YourUnit',
+    environment: 'production',
+    runtime: 'node',
+    version: '1.0.0'
+  },
+  minimumLogLevel: 'info',
+});
+smartlogInstance.enableConsole(); // Enabling console output for demonstration purposes
+```
+
+Now, instantiate the `SmartlogReceiver` with the necessary options. You need to provide a passphrase for authentication and a validator function that decides whether to accept or reject incoming messages based on your criteria.
+
+```typescript
+const smartlogReceiver = new SmartlogReceiver({
+  smartlogInstance: smartlogInstance,
+  passphrase: 'yourSecretPassphrase',
+  validatorFunction: async (logPackage) => {
+    // Example validation: accept only if message contains 'accepted'
+    return logPackage.message.includes('accepted');
+  },
+});
+```
+
+### Handling Log Messages
+
+To handle authenticated log messages, you'd typically have an endpoint in your application that receives log packages. Here, we'll simulate receiving a log package.
+
+```typescript
+import { ILogPackageAuthenticated } from '@pushrocks/smartlog-interfaces';
+import * as smarthash from '@pushrocks/smarthash';
+
+// Simulated received log message
+const receivedLogPackage: ILogPackageAuthenticated = {
+  auth: smarthash.sha256FromStringSync('yourSecretPassphrase'), // Generate hash of your passphrase for authentication
+  logPackage: {
+    timestamp: Date.now(),
+    context: {
+      company: 'YourCompany',
+      companyunit: 'YourUnit',
+      environment: 'production',
+      runtime: 'node',
+      version: '1.0.0'
+    },
+    level: 'info',
+    type: 'log',
+    message: 'This is an accepted log message',
+    correlation: {
+      id: 'unique-correlation-id',
+      type: 'transaction'
+    }
+  }
+};
+
+// Handler function to process received log packages
+async function handleReceivedLog(logPackage: ILogPackageAuthenticated) {
+  const result = await smartlogReceiver.handleAuthenticatedLog(logPackage);
+  console.log(result); // Should output { status: 'ok' } for successfully processed messages
+}
+
+handleReceivedLog(receivedLogPackage);
+```
+
+Ensure your validation and handling logic fits the security and architectural needs of your application.
+
+### Advanced Usage
+
+- **Batch Processing:** `SmartlogReceiver` also supports processing batches of logs efficiently through the method `handleManyAuthenticatedLogs`, facilitating bulk log management.
+
+- **Customizing Smartlog:** Since `SmartlogReceiver` uses `Smartlog` for its operations, you can harness the full power of `Smartlog` for detailed customization, such as setting up different log destinations, filtering log levels, and more.
+
+By setting up `@push.rocks/smartlog-receiver`, you're enabling a robust and flexible system to manage your application's logging infrastructure, making it easier to monitor and debug with centralized logs.
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

test/test.ts

@@ -1,22 +1,25 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, expectAsync, tap } from '@pushrocks/tapbundle';
 import * as smartlog from '@pushrocks/smartlog';
 import * as smarthash from '@pushrocks/smarthash';
 
-import * as smartlogReceiver from '../ts/index';
+import * as smartlogReceiver from '../ts/index.js';
 
 let testReceiver: smartlogReceiver.SmartlogReceiver;
-let testSmartlog = smartlog.defaultLogger;
+let testSmartlog = new smartlog.Smartlog({
+  logContext: null,
+  minimumLogLevel: 'debug',
+});
 testSmartlog.enableConsole();
 
 tap.test('should create a valid SmartlogReceiver', async () => {
   testReceiver = new smartlogReceiver.SmartlogReceiver({
     passphrase: 'hi',
     smartlogInstance: testSmartlog,
-    validatorFunction: () => {
+    validatorFunction: async () => {
       return true;
-    }
+    },
   });
-  expect(testReceiver).to.be.instanceof(smartlogReceiver.SmartlogReceiver);
+  expect(testReceiver).toBeInstanceOf(smartlogReceiver.SmartlogReceiver);
 });
 
 tap.test('should receive a message', async () => {
@@ -30,13 +33,17 @@ tap.test('should receive a message', async () => {
         containerName: null,
         environment: 'staging',
         runtime: 'node',
-        zone: 'gitzone'
+        zone: 'gitzone',
       },
       level: 'info',
       type: 'log',
-      message: 'hi there'
-    }
+      correlation: {
+        id: '123',
+        type: 'none',
+      },
+      message: 'hi there',
+    },
   });
-})
+});
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartlog-receiver',
+  version: '2.0.0',
+  description: 'a receiver for smartlog-destination-receiver'
+}

ts/index.ts

@@ -1 +1 @@
-export * from './sl.classes.smartlogreceiver';
+export * from './sl.classes.smartlogreceiver.js';

ts/sl.classes.smartlogreceiver.ts

@@ -1,8 +1,12 @@
-import * as plugins from './sl.receiver.plugins';
+import * as plugins from './sl.receiver.plugins.js';
 
-import { ILogPackage, ILogPackageAuthenticated, ILogDestination } from '@pushrocks/smartlog-interfaces';
+import {
+  ILogPackage,
+  ILogPackageAuthenticated,
+  ILogDestination,
+} from '@pushrocks/smartlog-interfaces';
 
-export type TValidatorFunction = (logPackage: ILogPackage) => boolean;
+export type TValidatorFunction = (logPackage: ILogPackage) => Promise<boolean>;
 
 export interface ISmartlogReceiverOptions {
   smartlogInstance: plugins.smartlog.Smartlog;
@@ -20,7 +24,11 @@ export class SmartlogReceiver {
 
   constructor(smartlogReceiverOptions: ISmartlogReceiverOptions) {
     this.passphrase = smartlogReceiverOptions.passphrase;
-    this.validatorFunction = smartlogReceiverOptions.validatorFunction;
+    this.validatorFunction =
+      smartlogReceiverOptions.validatorFunction ||
+      (async (logpackageArg) => {
+        return true;
+      });
     this.smartlogInstance = smartlogReceiverOptions.smartlogInstance;
   }
 
@@ -31,9 +39,16 @@ export class SmartlogReceiver {
     const authString = authenticatedLogPackageArg.auth;
     const logPackage = authenticatedLogPackageArg.logPackage;
 
-    if(authString === plugins.smarthash.sha256FromStringSync(this.passphrase)) {
-      // this.smartlogInstance.log('ok', 'Message accepted');
-      this.smartlogInstance.handleLogPackage(logPackage);
+    if (
+      authString === plugins.smarthash.sha256FromStringSync(this.passphrase) &&
+      (await this.validatorFunction(logPackage))
+    ) {
+      // Message authenticated lets clean up.
+      logPackage.correlation ? null : (logPackage.correlation = { id: '123', type: 'none' });
+      logPackage.correlation.id ? null : (logPackage.correlation.id = '123');
+      logPackage.correlation.type ? null : (logPackage.correlation.type = 'none');
+
+      this.smartlogInstance.handleLog(logPackage);
       return { status: 'ok' };
     } else {
       this.smartlogInstance.log('error', 'Message rejected because of bad passphrase');
@@ -46,13 +61,13 @@ export class SmartlogReceiver {
    * handles an array of authenticated logs
    * @param authenticatedLogsPackageArrayArg
    */
-  public async handleManyAuthenticatedLogs(authenticatedLogsPackageArrayArg: ILogPackageAuthenticated[]) {
+  public async handleManyAuthenticatedLogs(
+    authenticatedLogsPackageArrayArg: ILogPackageAuthenticated[]
+  ) {
     const promiseArray: Array<Promise<any>> = [];
     for (const logPackage of authenticatedLogsPackageArrayArg) {
       promiseArray.push(this.handleAuthenticatedLog(logPackage));
     }
     await Promise.all(promiseArray);
   }
-
-  
 }

ts/sl.receiver.plugins.ts

@@ -1,7 +1,4 @@
 import * as smarthash from '@pushrocks/smarthash';
 import * as smartlog from '@pushrocks/smartlog';
 
-export {
-  smartlog,
-  smarthash
-};
+export { smartlog, smarthash };

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}