@process-engine/logging_api_contracts - npm Package Compare versions

Comparing version 0.0.1-3f9af662-b7 to 0.0.1-4d39d36b-b11

dist/commonjs/index.js

@@ -8,3 +8,5 @@ "use strict";
 __export(require("./log_level"));
+__export(require("./rest_settings"));
+__export(require("./write_log_request_payload"));
 
 //# sourceMappingURL=index.js.map

dist/ilogging_repository.d.ts

@@ -1,2 +0,3 @@
-import { ILoggingService } from './ilogging_service';
+import { LogEntry } from './log_entry';
+import { LogLevel } from './log_level';
 /**
@@ -6,3 +7,41 @@ * Contains functions for writing and retrieving content from logfiles.
  */
-export interface ILoggingRepository extends ILoggingService {
+export interface ILoggingRepository {
+    /**
+     * Retrieves the logs for a specific correlation.
+     * @async
+     * @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(correlationId: string, logLevel?: LogLevel): Promise<Array<LogEntry>>;
+    /**
+     * Retrieves the logs for a specific process model of a given correlation.
+     * @async
+     * @param correlationId  The id of the correlation for which to retrieve the logs.
+     * @param processModelId The id of process model 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.
+     */
+    getLogsForProcessInstance(correlationId: string, processModelId: string, logLevel?: LogLevel): Promise<Array<LogEntry>>;
+    /**
+     * Writes a log entry for a specific process model of a correlation.
+     * @async
+     * @param correlationId  The id of the correlation to which the process model belongs.
+     * @param processModelId The id of process model for which to create a log entry.
+     * @param logLevel       The loglevel to use (debug, info, warning, error).
+     * @param message        The message to write into the log entry.
+     */
+    writeLogForProcessInstance(correlationId: string, processModelId: 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 correlationId       The id of the correlation to which the process model belongs.
+     * @param processModelId      The id of process model to which the flow node instance belongs.
+     * @param flowNodeInstanceId  The id of flow node instance for which to create a log entry.
+     * @param logLevel            The loglevel to use (debug, info, warning, error).
+     * @param message             The message to write into the log entry.
+     */
+    writeLogForFlowNodeInstance(correlationId: string, processModelId: string, flowNodeInstanceId: string, logLevel: LogLevel, message: string): Promise<void>;
 }

dist/ilogging_service.d.ts

@@ -11,3 +11,3 @@ import { IIdentity } from '@essential-projects/iam_contracts';
      * Retrieves the logs for a specific correlation.
-     *
+     * @async
      * @param identity       The identity of the requesting user.
@@ -19,9 +19,9 @@ * @param correlationId  The id of the correlation for which to retrieve the logs.
      */
-    getLogsForCorrelation(identity: IIdentity, correlationId: string, logLevel?: LogLevel): Array<LogEntry>;
+    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.
+     * @param correlationId  The id of the correlation for which to retrieve the logs.
      * @param processModelId The id of process model for which to retrieve the logs.
-     * @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.
@@ -31,17 +31,17 @@ *                       If not set, all logs will be returned.
      */
-    getLogsForProcessInstance(identity: IIdentity, processModelId: string, correlationId: string, logLevel?: LogLevel): Array<LogEntry>;
+    getLogsForProcessInstance(identity: IIdentity, correlationId: string, processModelId: string, logLevel?: LogLevel): Promise<Array<LogEntry>>;
     /**
      * Writes a log entry for a specific process model of a correlation.
-     *
+     * @async
+     * @param correlationId  The id of the correlation to which the process model belongs.
      * @param processModelId The id of process model for which to create a log entry.
-     * @param correlationId  The id of the correlation to which the process model belongs.
      * @param logLevel       The loglevel to use (debug, info, warning, error).
      * @param message        The message to write into the log entry.
      */
-    writeLogForProcessModel(processModelId: string, correlationId: string, logLevel: LogLevel, message: string): Promise<void>;
+    writeLogForProcessInstance(correlationId: string, processModelId: 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 correlationId       The id of the correlation to which the process model belongs.
      * @param processModelId      The id of process model to which the flow node instance belongs.
-     * @param correlationId       The id of the correlation to which the process model belongs.
      * @param flowNodeInstanceId  The id of flow node instance for which to create a log entry.
@@ -51,3 +51,3 @@ * @param logLevel            The loglevel to use (debug, info, warning, error).
      */
-    writeLogForFlowNodeInstance(processModelId: string, correlationId: string, flowNodeInstanceId: string, logLevel: LogLevel, message: string): Promise<void>;
+    writeLogForFlowNodeInstance(correlationId: string, processModelId: string, flowNodeInstanceId: string, logLevel: LogLevel, message: string): Promise<void>;
 }

dist/index.d.ts

@@ -5,1 +5,3 @@ export * from './ilogging_repository';
 export * from './log_level';
+export * from './rest_settings';
+export * from './write_log_request_payload';

package.json

 {
   "name": "@process-engine/logging_api_contracts",
-  "version": "0.0.1-3f9af662-b7",
+  "version": "0.0.1-4d39d36b-b11",
   "description": "the api-package for process-engine logging",
@@ -5,0 +5,0 @@ "main": "dist/commonjs/index.js",

src/ilogging_repository.ts

@@ -1,2 +0,3 @@
-import {ILoggingService} from './ilogging_service';
+import {LogEntry} from './log_entry';
+import {LogLevel} from './log_level';
 
@@ -7,3 +8,49 @@ /**
  */
-export interface ILoggingRepository extends ILoggingService {
+export interface ILoggingRepository {
+
+  /**
+   * Retrieves the logs for a specific correlation.
+   * @async
+   * @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(correlationId: string, logLevel?: LogLevel): Promise<Array<LogEntry>>;
+
+  /**
+   * Retrieves the logs for a specific process model of a given correlation.
+   * @async
+   * @param correlationId  The id of the correlation for which to retrieve the logs.
+   * @param processModelId The id of process model 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.
+   */
+  getLogsForProcessInstance(correlationId: string, processModelId: string, logLevel?: LogLevel): Promise<Array<LogEntry>>;
+
+  /**
+   * Writes a log entry for a specific process model of a correlation.
+   * @async
+   * @param correlationId  The id of the correlation to which the process model belongs.
+   * @param processModelId The id of process model for which to create a log entry.
+   * @param logLevel       The loglevel to use (debug, info, warning, error).
+   * @param message        The message to write into the log entry.
+   */
+  writeLogForProcessInstance(correlationId: string, processModelId: 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 correlationId       The id of the correlation to which the process model belongs.
+   * @param processModelId      The id of process model to which the flow node instance belongs.
+   * @param flowNodeInstanceId  The id of flow node instance for which to create a log entry.
+   * @param logLevel            The loglevel to use (debug, info, warning, error).
+   * @param message             The message to write into the log entry.
+   */
+  writeLogForFlowNodeInstance(correlationId: string,
+                              processModelId: string,
+                              flowNodeInstanceId: string,
+                              logLevel: LogLevel,
+                              message: string): Promise<void>;
 }

src/ilogging_service.ts

@@ -14,3 +14,3 @@ import {IIdentity} from '@essential-projects/iam_contracts';
    * Retrieves the logs for a specific correlation.
-   *
+   * @async
    * @param identity       The identity of the requesting user.
@@ -22,10 +22,10 @@ * @param correlationId  The id of the correlation for which to retrieve the logs.
    */
-  getLogsForCorrelation(identity: IIdentity, correlationId: string, logLevel?: LogLevel): Array<LogEntry>;
+  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.
+   * @param correlationId  The id of the correlation for which to retrieve the logs.
    * @param processModelId The id of process model for which to retrieve the logs.
-   * @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.
@@ -35,19 +35,19 @@ *                       If not set, all logs will be returned.
    */
-  getLogsForProcessInstance(identity: IIdentity, processModelId: string, correlationId: string, logLevel?: LogLevel): Array<LogEntry>;
+  getLogsForProcessInstance(identity: IIdentity, correlationId: string, processModelId: string, logLevel?: LogLevel): Promise<Array<LogEntry>>;
 
   /**
    * Writes a log entry for a specific process model of a correlation.
-   *
+   * @async
+   * @param correlationId  The id of the correlation to which the process model belongs.
    * @param processModelId The id of process model for which to create a log entry.
-   * @param correlationId  The id of the correlation to which the process model belongs.
    * @param logLevel       The loglevel to use (debug, info, warning, error).
    * @param message        The message to write into the log entry.
    */
-  writeLogForProcessModel(processModelId: string, correlationId: string, logLevel: LogLevel, message: string): Promise<void>;
+  writeLogForProcessInstance(correlationId: string, processModelId: 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 correlationId       The id of the correlation to which the process model belongs.
    * @param processModelId      The id of process model to which the flow node instance belongs.
-   * @param correlationId       The id of the correlation to which the process model belongs.
    * @param flowNodeInstanceId  The id of flow node instance for which to create a log entry.
@@ -57,4 +57,4 @@ * @param logLevel            The loglevel to use (debug, info, warning, error).
    */
-  writeLogForFlowNodeInstance(processModelId: string,
-                              correlationId: string,
+  writeLogForFlowNodeInstance(correlationId: string,
+                              processModelId: string,
                               flowNodeInstanceId: string,
@@ -61,0 +61,0 @@ logLevel: LogLevel,

src/index.ts

@@ -5,1 +5,3 @@ export * from './ilogging_repository';
 export * from './log_level';
+export * from './rest_settings';
+export * from './write_log_request_payload';

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

28286

increased by45.41%

Number of package files

37

increased by27.59%

Lines of code

439

increased by63.2%

No dependency changes