@process-engine/logging_api_contracts - npm Package Compare versions

Comparing version 1.0.3-9ec612a7-b16 to 1.0.3-ea7f658b-b1

dist/commonjs/rest_settings.js

@@ -5,5 +5,7 @@ "use strict";
     processModelId: ':process_model_id',
+    processInstanceId: ':process_instance_id',
 };
 const paths = {
     getLogForProcessModel: `/process_model/${params.processModelId}`,
+    getLogForProcessInstance: `/process_model/${params.processInstanceId}`,
 };
@@ -10,0 +12,0 @@ exports.restSettings = {

dist/ilogging_api.d.ts

@@ -20,2 +20,14 @@ import { IIdentity } from '@essential-projects/iam_contracts';
     /**
+     * Retrieves the logs for a specific ProcessModel of a given Correlation.
+     * @async
+     * @param identity          The identity of the requesting user.
+     * @param processModelId    The ID of the ProcessModel for which to retrieve
+     *                          the logs.
+     * @param processInstanceId The ID of the ProcessInstance for which to retrieve
+     *                          the logs.
+     *                          If not set, all logs will be returned.
+     * @returns                 A list of log entries.
+     */
+    readLogForProcessInstance(identity: IIdentity, processModelId: string, processInstanceId: string): Promise<Array<LogEntry>>;
+    /**
      * Writes a log entry for a specific ProcessModel of a Correlation.
@@ -22,0 +34,0 @@ * @async

dist/ilogging_repository.d.ts

@@ -18,2 +18,13 @@ import { LogEntry } from './log_entry';
     /**
+     * Retrieves the logs for a specific ProcessInstance.
+     * @async
+     * @param processModelId The ID of the ProcessModel for which to retrieve
+     *                       the logs.
+     * @async
+     * @param processModelId The ID of the ProcessInstance for which to retrieve
+     *                       the logs.
+     * @returns              A list of log entries.
+     */
+    readLogForProcessInstance(processModelId: string, processInstanceId: string): Promise<Array<LogEntry>>;
+    /**
      * Writes a log entry for a specific ProcessModel of a Correlation.
@@ -20,0 +31,0 @@ * @async

dist/rest_settings.d.ts

@@ -10,2 +10,3 @@ /**
         processModelId: string;
+        processInstanceId: string;
     };
@@ -17,3 +18,4 @@ /**
         getLogForProcessModel: string;
+        getLogForProcessInstance: string;
     };
 };

package.json

 {
   "name": "@process-engine/logging_api_contracts",
-  "version": "1.0.3-9ec612a7-b16",
+  "version": "1.0.3-ea7f658b-b1",
   "description": "the api-package for process-engine logging",
@@ -5,0 +5,0 @@ "main": "dist/commonjs/index.js",

src/ilogging_api.ts

@@ -24,2 +24,15 @@ import {IIdentity} from '@essential-projects/iam_contracts';
   /**
+   * Retrieves the logs for a specific ProcessModel of a given Correlation.
+   * @async
+   * @param identity          The identity of the requesting user.
+   * @param processModelId    The ID of the ProcessModel for which to retrieve
+   *                          the logs.
+   * @param processInstanceId The ID of the ProcessInstance for which to retrieve
+   *                          the logs.
+   *                          If not set, all logs will be returned.
+   * @returns                 A list of log entries.
+   */
+  readLogForProcessInstance(identity: IIdentity, processModelId: string, processInstanceId: string): Promise<Array<LogEntry>>;
+
+  /**
    * Writes a log entry for a specific ProcessModel of a Correlation.
@@ -26,0 +39,0 @@ * @async

src/ilogging_repository.ts

@@ -21,2 +21,14 @@ import {LogEntry} from './log_entry';
   /**
+   * Retrieves the logs for a specific ProcessInstance.
+   * @async
+   * @param processModelId The ID of the ProcessModel for which to retrieve
+   *                       the logs.
+   * @async
+   * @param processModelId The ID of the ProcessInstance for which to retrieve
+   *                       the logs.
+   * @returns              A list of log entries.
+   */
+  readLogForProcessInstance(processModelId: string, processInstanceId: string): Promise<Array<LogEntry>>;
+
+  /**
    * Writes a log entry for a specific ProcessModel of a Correlation.
@@ -23,0 +35,0 @@ * @async

src/rest_settings.ts

 // tslint:disable:typedef
 const params = {
   processModelId: ':process_model_id',
+  processInstanceId: ':process_instance_id',
 };
@@ -8,2 +9,3 @@
   getLogForProcessModel: `/process_model/${params.processModelId}`,
+  getLogForProcessInstance: `/process_model/${params.processInstanceId}`,
 };
@@ -10,0 +12,0 @@

No alert changes

Improved metrics

Total package byte prevSize

33906

increased by8.67%

Lines of code

466

increased by12.56%

No dependency changes