Socket
Socket
Sign inDemoInstall

@process-engine/logging_api_contracts

Package Overview
Dependencies
Maintainers
10
Versions
104
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@process-engine/logging_api_contracts - npm Package Compare versions

Comparing version 0.0.1-7c450668-b3 to 0.0.1-8b57ef55-b13

dist/commonjs/ilogging_repository.js

2

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

@@ -0,8 +1,51 @@

import { IIdentity } from '@essential-projects/iam_contracts';
import { LogEntry } from './log_entry';
import { LogLevel } from './log_level';
import { IIdentity } from '@essential-projects/iam_contracts';
/**
* Contains functions for writing and retrieving content from logfiles.
* Each logfile relates to a specific process model and correlation.
*/
export interface ILoggingService {
getLogsForProcessInstance(identity: IIdentity, processModelId: string, correlationId: string, logLevel?: LogLevel): Array<LogEntry>;
writeLogForProcessModel(processModelId: string, correlationId: string, logLevel: LogLevel, message: string): Promise<void>;
writeLogForFlowNodeInstance(processModelId: string, correlationId: string, flowNodeInstanceId: string, logLevel: LogLevel, message: string): Promise<void>;
/**
* 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.
* @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(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 logLevel The loglevel to use (debug, info, warning, error).
* @param message The message to write into the log entry.
* @param timestamp Optional: The timestamp to use for the log entry. Defaults to "now".
*/
writeLogForProcessInstance(correlationId: string, processModelId: string, logLevel: LogLevel, message: string, timestamp?: Date): 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.
* @param timestamp Optional: The timestamp to use for the log entry. Defaults to "now".
*/
writeLogForFlowNodeInstance(correlationId: string, processModelId: string, flowNodeInstanceId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>;
}

@@ -0,3 +1,6 @@

export * from './ilogging_repository';
export * from './ilogging_service';
export * from './log_entry';
export * from './log_level';
export * from './rest_settings';
export * from './write_log_request_payload';
import { LogLevel } from './log_level';
/**
* Describes a single log entry.
*/
export declare class LogEntry {
/**
* The id of the process model to which the log entry pertains.
*/
processModelId: string;
/**
* The id of the correlation to which the log entry pertains.
*/
correlationId: string;
/**
* The id of the flow node instance to which the log entry pertains.
*/
flowNodeInstanceId?: string;
/**
* The log level.
*/
logLevel: LogLevel;
/**
* The log message.
*/
message: string;
/**
* The date and time at which the log entry was recorded..
*/
timeStamp: Date;
}

@@ -0,1 +1,4 @@

/**
* Contains a list of possible log levels.
*/
export declare enum LogLevel {

@@ -2,0 +5,0 @@ debug = 1,

2

package.json
{
"name": "@process-engine/logging_api_contracts",
"version": "0.0.1-7c450668-b3",
"version": "0.0.1-8b57ef55-b13",
"description": "the api-package for process-engine logging",

@@ -5,0 +5,0 @@ "main": "dist/commonjs/index.js",

@@ -0,14 +1,62 @@

import {IIdentity} from '@essential-projects/iam_contracts';
import {LogEntry} from './log_entry';
import {LogLevel} from './log_level';
import {IIdentity} from '@essential-projects/iam_contracts';
/**
* Contains functions for writing and retrieving content from logfiles.
* Each logfile relates to a specific process model and correlation.
*/
export interface ILoggingService {
export interface ILoggingService {
getLogsForProcessInstance(identity: IIdentity, processModelId: string, correlationId: string, logLevel?: LogLevel): Array<LogEntry>;
writeLogForProcessModel(processModelId: string, correlationId: string, logLevel: LogLevel, message: string): Promise<void>;
writeLogForFlowNodeInstance(processModelId: string,
correlationId: string,
/**
* 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.
* @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(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 logLevel The loglevel to use (debug, info, warning, error).
* @param message The message to write into the log entry.
* @param timestamp Optional: The timestamp to use for the log entry. Defaults to "now".
*/
writeLogForProcessInstance(correlationId: string, processModelId: string, logLevel: LogLevel, message: string, timestamp?: Date): 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.
* @param timestamp Optional: The timestamp to use for the log entry. Defaults to "now".
*/
writeLogForFlowNodeInstance(correlationId: string,
processModelId: string,
flowNodeInstanceId: string,
logLevel: LogLevel,
message: string): Promise<void>;
message: string,
timestamp?: Date): Promise<void>;
}

@@ -0,3 +1,6 @@

export * from './ilogging_repository';
export * from './ilogging_service';
export * from './log_entry';
export * from './log_level';
export * from './rest_settings';
export * from './write_log_request_payload';
import {LogLevel} from './log_level';
/**
* Describes a single log entry.
*/
export class LogEntry {
/**
* The id of the process model to which the log entry pertains.
*/
public processModelId: string;
/**
* The id of the correlation to which the log entry pertains.
*/
public correlationId: string;
/**
* The id of the flow node instance to which the log entry pertains.
*/
public flowNodeInstanceId?: string;
/**
* The log level.
*/
public logLevel: LogLevel;
/**
* The log message.
*/
public message: string;
/**
* The date and time at which the log entry was recorded..
*/
public timeStamp: Date;
}

@@ -0,1 +1,4 @@

/**
* Contains a list of possible log levels.
*/
export enum LogLevel {

@@ -2,0 +5,0 @@ debug = 1,

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc