@process-engine/logging_api_contracts - npm Package Compare versions

Comparing version 0.0.1-9465bdbc-b6 to 0.0.1-98ae9d49-b22

dist/commonjs/index.js

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

dist/commonjs/log_level.js

@@ -5,8 +5,8 @@ "use strict";
 (function (LogLevel) {
-    LogLevel[LogLevel["debug"] = 1] = "debug";
-    LogLevel[LogLevel["info"] = 2] = "info";
-    LogLevel[LogLevel["warn"] = 4] = "warn";
-    LogLevel[LogLevel["error"] = 8] = "error";
+    LogLevel["debug"] = "debug";
+    LogLevel["info"] = "info";
+    LogLevel["warn"] = "warn";
+    LogLevel["error"] = "error";
 })(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
 
 //# sourceMappingURL=log_level.js.map

dist/index.d.ts

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

dist/log_entry.d.ts

 import { LogLevel } from './log_level';
 /**
  * Describes a single log entry.
+ * Contains information about the Correlation, ProcessModel and
+ * FlowNodeInstance to which the entry belongs,
+ * aswell as a timestamp, LogLvel and the concrete message that was logged.
+ *
+ * The properties here are ordered in the same manner as they are in the
+ * actual log file.
  */
 export declare class LogEntry {
-    /**
-     * The id of the process model to which the log entry pertains.
-     */
+    timeStamp: Date;
+    correlationId: string;
     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.
-     */
+    flowNodeId?: string;
     logLevel: LogLevel;
-    /**
-     * The log message.
-     */
     message: string;
-    /**
-     * The date and time at which the log entry was recorded..
-     */
-    timeStamp: Date;
 }

dist/log_level.d.ts

 /**
- * Contains a list of possible log levels.
+ * Contains the definition of log levels.
  */
 export declare enum LogLevel {
-    debug = 1,
-    info = 2,
-    warn = 4,
-    error = 8
+    debug = "debug",
+    info = "info",
+    warn = "warn",
+    error = "error"
 }

package.json

 {
   "name": "@process-engine/logging_api_contracts",
-  "version": "0.0.1-9465bdbc-b6",
+  "version": "0.0.1-98ae9d49-b22",
   "description": "the api-package for process-engine logging",
@@ -5,0 +5,0 @@ "main": "dist/commonjs/index.js",

PULL_REQUEST_TEMPLATE.md

@@ -1,7 +0,34 @@
-## What did you change?
+:tada: **Thanks for submitting this Pull Request**
 
-> Describe the changes introduced by this PR.
->
-> Fixes # (issue, if applicable)
+Please provide a list including your changes.
 
+To help us to create a meaningful Changelog, we agreed
+to use an emoji-based commit-style. Use the [Emojis](#emojis)
+we provided below.
+
+Fill out the following, provide reference to issues
+and this PR- we will use this as merge commit message-body
+and the title of this PR as commit-headline:
+
+---
+
+**Changes:**
+
+1. Change 1
+2. Change 2
+3. (...)
+
+
+**Issues:**
+
+Closes #Issue
+Closes #Issue
+Closes (...)
+
+PR: #PullRequest
+
+---
+
+See the [examples](#example) for inspiration.
+
 ## How can others test the changes?
@@ -15,7 +42,79 @@
 
-- [ ] You can merge this PR **right now** (if not, please prefix the title with "WIP: ")
-- [ ] I've tested **all** changes included in this PR.
-- [ ] I've also reviewed this PR myself before submitting (e.g. for scrambled letters, typos, etc.)
-- [ ] I've merged the `develop` branch into my branch before finishing this PR.
-- [ ] I've **not added any other changes** than the ones described above.
-- [ ] I've mentioned all **PRs, which relate to this one**
+- [x] You can merge this PR **right now** (if not, please prefix the title with "WIP: ")
+- [x] I've tested **all** changes included in this PR.
+- [x] I've also reviewed this PR myself before submitting (e.g. for scrambled letters, typos, etc.).
+- [x] I've rebased the `develop` branch with my branch before finishing this PR.
+- [x] I've **summarized all changes** in a list above.
+- [x] I've mentioned all **PRs, which relate to this one**.
+- [x] I've prefixed my Pull Request title is according to [gitmoji guide](https://gitmoji.carloscuesta.me/).
+
+## Example
+
+<details>
+<summary>
+:warning: Before merging please click here to expand and follow the guide.
+</summary>
+<br>
+
+Please use `:twisted_rightwards_arrows:` at the beginning of your merge commit title.
+
+Example 1:
+
+<pre>
+<code>
+:twisted_rightwards_arrows: :bug: Fix Wrong Text Decoration at ...
+</code>
+</pre>
+
+To get your commit message, just copy the first part of this pull request.
+
+Example 2:
+<pre>
+<code>
+**Changes:**
+
+- Fixes Wrong Text Decoration at ...
+- Fixes some typos
+- ...
+
+**Issues:**
+
+Closes #NumberOfFixedIssue
+
+PR: #NumberOfThisPR
+</code>
+</pre>
+</details>
+
+## Emojis
+
+<details>
+<summary>
+Expand for a list of most used Emojis.
+</summary>
+<br>
+
+Please prefix your commit messages with an Emoji.
+
+Ref: https://gitmoji.carloscuesta.me/
+
+| Description              | Glyphe               | Emoji  |
+|--------------------------|----------------------|--------|
+| Bugfix                   | `:bug:`              | 🐛     |
+| Configuration releated   | `:wrench:`           | 🔧     |
+| Cosmetic                 | `:lipstick:`         | 💄     |
+| Dependencies Downgrade   | `:arrow_down:`       | ⬇️     |
+| Dependencies Upgrade     | `:arrow_up:`         | ⬆️     |
+| Formatting               | `:art:`              | 🎨     |
+| Improving Performance    | `:zap:`              | ⚡️     |
+| Initial commit           | `:tada:`             | 🎉     |
+| Linter                   | `:rotating_light:`   | 🚨     |
+| Miscellaneous            | `:package:`          | 📦     |
+| New Feature              | `:sparkles:`         | ✨     |
+| Refactoring Code         | `:recycle:`          | ♻️     |
+| Releasing / Version tags | `:bookmark:`         | 🔖     |
+| Removing Stuff           | `:fire:`             | 🔥     |
+| Tests                    | `:white_check_mark:` | ✅     |
+| Work In Progress (WIP)   | `:construction:`     | 🚧     |
+
+</details>

src/index.ts

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

src/log_entry.ts

@@ -5,33 +5,17 @@ import {LogLevel} from './log_level';
  * Describes a single log entry.
+ * Contains information about the Correlation, ProcessModel and
+ * FlowNodeInstance to which the entry belongs,
+ * aswell as a timestamp, LogLvel and the concrete message that was logged.
+ *
+ * The properties here are ordered in the same manner as they are in the
+ * actual log file.
  */
 export class LogEntry {
-  /**
-   * The id of the process model to which the log entry pertains.
-   */
+  public timeStamp: Date;
+  public correlationId: string;
   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 flowNodeId?: string;
   public logLevel: LogLevel;
-
-  /**
-   * The log message.
-   */
   public message: string;
-
-  /**
-   * The date and time at which the log entry was recorded..
-   */
-  public timeStamp: Date;
 }

src/log_level.ts

 /**
- * Contains a list of possible log levels.
+ * Contains the definition of log levels.
  */
 export enum LogLevel {
-  debug = 1,
-  info = 2,
-  warn = 4,
-  error = 8,
+  debug = 'debug',
+  info = 'info',
+  warn = 'warn',
+  error = 'error',
 }

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

30352

increased by63.33%

Number of package files

33

increased by32%

Lines of code

452

increased by80.8%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes