@process-engine/logging_api_contracts - npm Package Compare versions

Comparing version 0.0.1-50d36d33-b4 to 0.0.1-61538728-b8

dist/ilogging_service.d.ts

@@ -0,4 +1,4 @@
+import { IIdentity } from '@essential-projects/iam_contracts';
 import { LogEntry } from './log_entry';
 import { LogLevel } from './log_level';
-import { IIdentity } from '@essential-projects/iam_contracts';
 /**
@@ -10,4 +10,14 @@ * Contains functions for writing and retrieving content from logfiles.
     /**
+     * Retrieves the logs for a specific correlation.
+     * @async
+     * @param identity       The identity of the requesting user.
+     * @param correlationId  The id of the correlation for which to retrieve the logs.
+     * @param logLevel       Optional: If set, only logs with a matching log level are returned.
+     *                       If not set, all logs will be returned.
+     * @returns              A list of log entries.
+     */
+    getLogsForCorrelation(identity: IIdentity, correlationId: string, logLevel?: LogLevel): Promise<Array<LogEntry>>;
+    /**
      * Retrieves the logs for a specific process model of a given correlation.
-     *
+     * @async
      * @param identity       The identity of the requesting user.
@@ -20,6 +30,6 @@ * @param processModelId The id of process model for which to retrieve the logs.
      */
-    getLogsForProcessInstance(identity: IIdentity, processModelId: string, correlationId: string, logLevel?: LogLevel): Array<LogEntry>;
+    getLogsForProcessInstance(identity: IIdentity, processModelId: string, correlationId: string, logLevel?: LogLevel): Promise<Array<LogEntry>>;
     /**
      * Writes a log entry for a specific process model of a correlation.
-     *
+     * @async
      * @param processModelId The id of process model for which to create a log entry.
@@ -33,3 +43,3 @@ * @param correlationId  The id of the correlation to which the process model belongs.
      * Writes a log entry for a specific flow node instance of a process model within a correlation.
-     *
+     * @async
      * @param processModelId      The id of process model to which the flow node instance belongs.
@@ -36,0 +46,0 @@ * @param correlationId       The id of the correlation to which the process model belongs.

dist/index.d.ts

@@ -0,3 +1,4 @@
+export * from './ilogging_repository';
 export * from './ilogging_service';
 export * from './log_entry';
 export * from './log_level';

package.json

 {
   "name": "@process-engine/logging_api_contracts",
-  "version": "0.0.1-50d36d33-b4",
+  "version": "0.0.1-61538728-b8",
   "description": "the api-package for process-engine logging",
@@ -5,0 +5,0 @@ "main": "dist/commonjs/index.js",

src/ilogging_service.ts

@@ -0,6 +1,6 @@
+import {IIdentity} from '@essential-projects/iam_contracts';
+
 import {LogEntry} from './log_entry';
 import {LogLevel} from './log_level';
 
-import {IIdentity} from '@essential-projects/iam_contracts';
-
 /**
@@ -11,5 +11,17 @@ * Contains functions for writing and retrieving content from logfiles.
 export interface ILoggingService {
+
   /**
+   * Retrieves the logs for a specific correlation.
+   * @async
+   * @param identity       The identity of the requesting user.
+   * @param correlationId  The id of the correlation for which to retrieve the logs.
+   * @param logLevel       Optional: If set, only logs with a matching log level are returned.
+   *                       If not set, all logs will be returned.
+   * @returns              A list of log entries.
+   */
+  getLogsForCorrelation(identity: IIdentity, correlationId: string, logLevel?: LogLevel): Promise<Array<LogEntry>>;
+
+  /**
    * Retrieves the logs for a specific process model of a given correlation.
-   *
+   * @async
    * @param identity       The identity of the requesting user.
@@ -22,6 +34,7 @@ * @param processModelId The id of process model for which to retrieve the logs.
    */
-  getLogsForProcessInstance(identity: IIdentity, processModelId: string, correlationId: string, logLevel?: LogLevel): Array<LogEntry>;
+  getLogsForProcessInstance(identity: IIdentity, processModelId: string, correlationId: string, logLevel?: LogLevel): Promise<Array<LogEntry>>;
+
   /**
    * Writes a log entry for a specific process model of a correlation.
-   *
+   * @async
    * @param processModelId The id of process model for which to create a log entry.
@@ -33,5 +46,6 @@ * @param correlationId  The id of the correlation to which the process model belongs.
   writeLogForProcessModel(processModelId: string, correlationId: string, logLevel: LogLevel, message: string): Promise<void>;
+
   /**
    * Writes a log entry for a specific flow node instance of a process model within a correlation.
-   *
+   * @async
    * @param processModelId      The id of process model to which the flow node instance belongs.
@@ -38,0 +52,0 @@ * @param correlationId       The id of the correlation to which the process model belongs.

src/index.ts

@@ -0,3 +1,4 @@
+export * from './ilogging_repository';
 export * from './ilogging_service';
 export * from './log_entry';
 export * from './log_level';

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

24410

increased by39.59%

Number of package files

29

increased by16%

Lines of code

351

increased by52.61%

No dependency changes