@process-engine/logging_api_contracts - npm Package Compare versions

Comparing version 1.1.0 to 2.0.0-alpha.1

dist/ilogging_api.d.ts

@@ -52,2 +52,12 @@ import { IIdentity } from '@essential-projects/iam_contracts';
     writeLogForFlowNode(correlationId: string, processModelId: string, processInstanceId: string, flowNodeInstanceId: string, flowNodeId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>;
+    /**
+     * Places all logs for the given ProcessModel into the "archive" folder.
+     * Essentially, this is pretty much like "deleting" the logs, as they will no longer be available.
+     *
+     * However, since logs are somewhat sensitive, they will not be deleted, but archived.
+     *
+     * @param identity       The identity of the requesting user.
+     * @param processModelId The ID of the ProcessModel whose logs are to be archived.
+     */
+    archiveProcessModelLogs(identity: IIdentity, processModelId: string): Promise<void>;
 }

dist/ilogging_repository.d.ts

@@ -50,2 +50,11 @@ import { LogEntry } from './log_entry';
     writeLogForFlowNode(correlationId: string, processModelId: string, processInstanceId: string, flowNodeInstanceId: string, flowNodeId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>;
+    /**
+     * Places all logs for the given ProcessModel into the "archive" folder.
+     * Essentially, this is pretty much like "deleting" the logs, as they will no longer be available.
+     *
+     * However, since logs are somewhat sensitive, they will not be deleted, but archived.
+     *
+     * @param processModelId
+     */
+    archiveProcessModelLogs(processModelId: string): Promise<void>;
 }

dist/index.d.ts

 export * from './ilogging_api';
+export * from './ilogging_repository_config';
 export * from './ilogging_repository';
@@ -3,0 +4,0 @@ export * from './log_entry';

package.json

 {
   "name": "@process-engine/logging_api_contracts",
-  "version": "1.1.0",
+  "version": "2.0.0-alpha.1",
   "description": "the api-package for process-engine logging",
@@ -12,5 +12,7 @@ "main": "dist/commonjs/index.js",
   "author": "5Minds IT-Solutions GmbH & Co. KG",
-  "contributors": [
-    "Sebastian Meier <[e-mail]>",
-    "Christian Werner <[e-mail]>"
+  "maintainers": [
+    "Alexander Kasten <[e-mail]>",
+    "Christian Werner <[e-mail]>",
+    "René Föhring <[e-mail]>",
+    "Steffen Knaup <[e-mail]>"
   ],
@@ -24,3 +26,2 @@ "license": "MIT",
     "@essential-projects/iam_contracts": "^3.4.0",
-    "@types/express": "^4.16.0",
     "@types/node": "^10.12.2"
@@ -30,4 +31,4 @@ },
     "@essential-projects/eslint-config": "^1.0.0",
+    "@process-engine/ci_tools": "^2.2.0",
     "eslint": "^5.16.0",
-    "tsconfig": "^7.0.0",
     "typescript": "^3.4.5"
@@ -34,0 +35,0 @@ },

src/ilogging_api.ts

@@ -36,3 +36,4 @@ import {IIdentity} from '@essential-projects/iam_contracts';
    */
-  writeLogForProcessModel(correlationId: string,
+  writeLogForProcessModel(
+    correlationId: string,
     processModelId: string,
@@ -42,3 +43,4 @@ processInstanceId: string,
     message: string,
-    timestamp?: Date): Promise<void>;
+    timestamp?: Date,
+  ): Promise<void>;
 
@@ -63,3 +65,4 @@ /**
    */
-  writeLogForFlowNode(correlationId: string,
+  writeLogForFlowNode(
+    correlationId: string,
     processModelId: string,
@@ -71,3 +74,15 @@ processInstanceId: string,
     message: string,
-    timestamp?: Date): Promise<void>;
+    timestamp?: Date,
+  ): Promise<void>;
+
+  /**
+   * Places all logs for the given ProcessModel into the "archive" folder.
+   * Essentially, this is pretty much like "deleting" the logs, as they will no longer be available.
+   *
+   * However, since logs are somewhat sensitive, they will not be deleted, but archived.
+   *
+   * @param identity       The identity of the requesting user.
+   * @param processModelId The ID of the ProcessModel whose logs are to be archived.
+   */
+  archiveProcessModelLogs(identity: IIdentity, processModelId: string): Promise<void>;
 }

src/ilogging_repository.ts

@@ -33,3 +33,4 @@ import {LogEntry} from './log_entry';
    */
-  writeLogForProcessModel(correlationId: string,
+  writeLogForProcessModel(
+    correlationId: string,
     processModelId: string,
@@ -39,3 +40,4 @@ processInstanceId: string,
     message: string,
-    timestamp?: Date): Promise<void>;
+    timestamp?: Date,
+  ): Promise<void>;
 
@@ -60,3 +62,4 @@ /**
    */
-  writeLogForFlowNode(correlationId: string,
+  writeLogForFlowNode(
+    correlationId: string,
     processModelId: string,
@@ -68,3 +71,14 @@ processInstanceId: string,
     message: string,
-    timestamp?: Date): Promise<void>;
+    timestamp?: Date,
+  ): Promise<void>;
+
+  /**
+   * Places all logs for the given ProcessModel into the "archive" folder.
+   * Essentially, this is pretty much like "deleting" the logs, as they will no longer be available.
+   *
+   * However, since logs are somewhat sensitive, they will not be deleted, but archived.
+   *
+   * @param processModelId
+   */
+  archiveProcessModelLogs(processModelId: string): Promise<void>;
 }

src/index.ts

 export * from './ilogging_api';
+export * from './ilogging_repository_config';
 export * from './ilogging_repository';
@@ -3,0 +4,0 @@ export * from './log_entry';

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Dependency count

2

decreased by-33.33%

Number of package files

48

increased by6.67%

Lines of code

511

increased by14.06%

Worsened metrics

Total package byte prevSize

25674

decreased by-19.33%

Number of low quality alerts

2

increased by100%

Dependency changes

• - Removed@types/express@^4.16.0

• - Removed@types/body-parser@1.19.5(transitive)

• - Removed@types/connect@3.4.38(transitive)

• - Removed@types/express@4.17.21(transitive)

• - Removed@types/express-serve-static-core@4.19.5(transitive)

• - Removed@types/http-errors@2.0.4(transitive)

• - Removed@types/mime@1.3.5(transitive)

• - Removed@types/qs@6.9.15(transitive)

• - Removed@types/range-parser@1.2.7(transitive)

• - Removed@types/send@0.17.4(transitive)

• - Removed@types/serve-static@1.15.7(transitive)