@process-engine/logging_api_contracts - npm Package Compare versions

Comparing version 0.1.5 to 0.2.0-02ffd326-b2

dist/ilogging_api.d.ts

@@ -22,12 +22,13 @@ import { IIdentity } from '@essential-projects/iam_contracts';
      * @async
-     * @param correlationId  The ID of the Correlation to which the
-     *                       ProcessModel belongs.
-     * @param processModelId The ID of ProcessModel for which to create a
-     *                       log entry.
-     * @param logLevel       The loglevel to use.
-     * @param message        The message to write into the log entry.
-     * @param timestamp      Optional: The timestamp to use for the log entry.
-     *                       Defaults to "now".
+     * @param correlationId     The ID of the Correlation to which the
+     *                          ProcessModel belongs.
+     * @param processModelId    The ID of ProcessModel for which to create a
+     *                          log entry.
+     * @param processInstanceId The instance ID of the ProcessModel.
+     * @param logLevel          The loglevel to use.
+     * @param message           The message to write into the log entry.
+     * @param timestamp         Optional: The timestamp to use for the log entry.
+     *                          Defaults to "now".
      */
-    writeLogForProcessModel(correlationId: string, processModelId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>;
+    writeLogForProcessModel(correlationId: string, processModelId: string, processInstanceId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>;
     /**
@@ -41,2 +42,3 @@ * Writes a log entry for a specific FlowNode of a ProcessModel within a
      *                           belongs.
+     * @param processInstanceId  The instance ID of the ProcessModel.
      * @param flowNodeInstanceId The instance ID of FlowNode for which to create
@@ -51,3 +53,3 @@ *                           a log entry.
      */
-    writeLogForFlowNode(correlationId: string, processModelId: string, flowNodeInstanceId: string, flowNodeId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>;
+    writeLogForFlowNode(correlationId: string, processModelId: string, processInstanceId: string, flowNodeInstanceId: string, flowNodeId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>;
 }

dist/ilogging_repository.d.ts

@@ -18,14 +18,15 @@ import { LogEntry } from './log_entry';
     /**
-     * Writes a log entry for a specific ProcessModel.
+     * Writes a log entry for a specific ProcessModel of a Correlation.
      * @async
-     * @param correlationId  The ID of the Correlation to which the
-     *                       ProcessModel belongs.
-     * @param processModelId The ID of ProcessModel for which to create a
-     *                       log entry.
-     * @param logLevel       The loglevel to use.
-     * @param message        The message to write into the log entry.
-     * @param timestamp      Optional: The timestamp to use for the log entry.
-     *                       Defaults to "now".
+     * @param correlationId     The ID of the Correlation to which the
+     *                          ProcessModel belongs.
+     * @param processModelId    The ID of ProcessModel for which to create a
+     *                          log entry.
+     * @param processInstanceId The instance ID of the ProcessModel.
+     * @param logLevel          The loglevel to use.
+     * @param message           The message to write into the log entry.
+     * @param timestamp         Optional: The timestamp to use for the log entry.
+     *                          Defaults to "now".
      */
-    writeLogForProcessModel(correlationId: string, processModelId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>;
+    writeLogForProcessModel(correlationId: string, processModelId: string, processInstanceId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>;
     /**
@@ -39,2 +40,3 @@ * Writes a log entry for a specific FlowNode of a ProcessModel within a
      *                           belongs.
+     * @param processInstanceId  The instance ID of the ProcessModel.
      * @param flowNodeInstanceId The instance ID of FlowNode for which to create
@@ -49,3 +51,3 @@ *                           a log entry.
      */
-    writeLogForFlowNode(correlationId: string, processModelId: string, flowNodeInstanceId: string, flowNodeId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>;
+    writeLogForFlowNode(correlationId: string, processModelId: string, processInstanceId: string, flowNodeInstanceId: string, flowNodeId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>;
 }

dist/log_entry.d.ts

@@ -15,2 +15,3 @@ import { LogLevel } from './log_level';
     processModelId: string;
+    processInstanceId: string;
     flowNodeInstanceId?: string;
@@ -17,0 +18,0 @@ flowNodeId?: string;

package.json

 {
   "name": "@process-engine/logging_api_contracts",
-  "version": "0.1.5",
+  "version": "0.2.0-02ffd326-b2",
   "description": "the api-package for process-engine logging",
@@ -5,0 +5,0 @@ "main": "dist/commonjs/index.js",

src/ilogging_api.ts

@@ -26,13 +26,15 @@ import {IIdentity} from '@essential-projects/iam_contracts';
    * @async
-   * @param correlationId  The ID of the Correlation to which the
-   *                       ProcessModel belongs.
-   * @param processModelId The ID of ProcessModel for which to create a
-   *                       log entry.
-   * @param logLevel       The loglevel to use.
-   * @param message        The message to write into the log entry.
-   * @param timestamp      Optional: The timestamp to use for the log entry.
-   *                       Defaults to "now".
+   * @param correlationId     The ID of the Correlation to which the
+   *                          ProcessModel belongs.
+   * @param processModelId    The ID of ProcessModel for which to create a
+   *                          log entry.
+   * @param processInstanceId The instance ID of the ProcessModel.
+   * @param logLevel          The loglevel to use.
+   * @param message           The message to write into the log entry.
+   * @param timestamp         Optional: The timestamp to use for the log entry.
+   *                          Defaults to "now".
    */
   writeLogForProcessModel(correlationId: string,
                           processModelId: string,
+                          processInstanceId: string,
                           logLevel: LogLevel,
@@ -50,2 +52,3 @@ message: string,
    *                           belongs.
+   * @param processInstanceId  The instance ID of the ProcessModel.
    * @param flowNodeInstanceId The instance ID of FlowNode for which to create
@@ -62,2 +65,3 @@ *                           a log entry.
                       processModelId: string,
+                      processInstanceId: string,
                       flowNodeInstanceId: string,
@@ -64,0 +68,0 @@ flowNodeId: string,

src/ilogging_repository.ts

@@ -21,15 +21,17 @@ import {LogEntry} from './log_entry';
   /**
-   * Writes a log entry for a specific ProcessModel.
+   * Writes a log entry for a specific ProcessModel of a Correlation.
    * @async
-   * @param correlationId  The ID of the Correlation to which the
-   *                       ProcessModel belongs.
-   * @param processModelId The ID of ProcessModel for which to create a
-   *                       log entry.
-   * @param logLevel       The loglevel to use.
-   * @param message        The message to write into the log entry.
-   * @param timestamp      Optional: The timestamp to use for the log entry.
-   *                       Defaults to "now".
+   * @param correlationId     The ID of the Correlation to which the
+   *                          ProcessModel belongs.
+   * @param processModelId    The ID of ProcessModel for which to create a
+   *                          log entry.
+   * @param processInstanceId The instance ID of the ProcessModel.
+   * @param logLevel          The loglevel to use.
+   * @param message           The message to write into the log entry.
+   * @param timestamp         Optional: The timestamp to use for the log entry.
+   *                          Defaults to "now".
    */
   writeLogForProcessModel(correlationId: string,
                           processModelId: string,
+                          processInstanceId: string,
                           logLevel: LogLevel,
@@ -47,2 +49,3 @@ message: string,
    *                           belongs.
+   * @param processInstanceId  The instance ID of the ProcessModel.
    * @param flowNodeInstanceId The instance ID of FlowNode for which to create
@@ -59,2 +62,3 @@ *                           a log entry.
                       processModelId: string,
+                      processInstanceId: string,
                       flowNodeInstanceId: string,
@@ -61,0 +65,0 @@ flowNodeId: string,

src/log_entry.ts

@@ -16,2 +16,3 @@ import {LogLevel} from './log_level';
   public processModelId: string;
+  public processInstanceId: string;
   public flowNodeInstanceId?: string;
@@ -18,0 +19,0 @@ public flowNodeId?: string;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

28416

increased by3.91%

Lines of code

408

increased by3.55%

No dependency changes