@process-engine/logging_api_contracts
Advanced tools
Comparing version 1.0.3 to 1.1.0-60c84895-b6
@@ -1,27 +0,66 @@ | ||
| #### Describe your issue | ||
| ## BEFORE SUBMITTING | ||
| > Describe the issue or ask your question regarding this module. | ||
| > Provide as much relevant information as you can. If you're not sure if something | ||
| > is relevant or not, include it as well! | ||
| > | ||
| > Logs and screenshots are very welcome! | ||
| > **Please ensure you have followed this guide, _before_ submitting your issue!** | ||
| > | ||
| > - Check if this issue already exists (including closed issues!) | ||
| > - Prefix the issue title according to the [gitmoji guide](https://gitmoji.carloscuesta.me/) | ||
| > - Reference all PRs and issues related to this one | ||
| > | ||
| ><details> | ||
| ><summary> | ||
| >Click here for a list of commonly used issue emojis. | ||
| ></summary> | ||
| > | ||
| >| Description | Glyphe | Emoji| | ||
| >|--------------------------|-----------------------------|------| | ||
| >| Bugfix | `:bug:` | 🐛 | | ||
| >| Fixing Security issues | `:lock:` | 🔒 | | ||
| >| Improving Performance | `:zap:` | ⚡️ | | ||
| >| New Feature | `:sparkles:` | ✨ | | ||
| >| Refactoring Code | `:recycle:` | ♻️ | | ||
| >| CI Pipeline related | `:construction_worker_man:` | 👷 | | ||
| >| Configuration releated | `:wrench:` | 🔧 | | ||
| >| Tests | `:white_check_mark:` | ✅ | | ||
| >| Removing Stuff | `:fire:` | 🔥 | | ||
| >| Dependencies Downgrade | `:arrow_down:` | ⬇️ | | ||
| >| Dependencies Upgrade | `:arrow_up:` | ⬆️ | | ||
| >| Linter | `:rotating_light:` | 🚨 | | ||
| >| Cosmetic | `:lipstick:` | 💄 | | ||
| >| Miscellaneous | `:package:` | 📦 | | ||
| > | ||
| ></details> | ||
| > | ||
| > **Please remove this section when you're done creating this issue.** | ||
| #### How can others reproduce the issue? | ||
| ## Description | ||
| > Describe your issue/question here. | ||
| > | ||
| > Provide as much relevant information as you can. | ||
| > If you're not sure if something is relevant or not, include it as well! | ||
| > | ||
| >**If this is a feature request, please give a short summary as to what you need it for!** | ||
| ## Reproduction | ||
| > You can remove this section, if the issue isn't something that requires reproducton. | ||
| > | ||
| > Describe how others can reproduce this issue as precisely as possible. | ||
| > | ||
| > | ||
| > If you can't reproduce the issue, let us know what you tried! | ||
| > | ||
| > You can remove this section if the issue isn't something reproducable | ||
| > (for example for certain questions or feature requests). | ||
| > | ||
| > Logs, Screenshots and BPMN files are always helpful! | ||
| #### Possible solution | ||
| ## Possible solution | ||
| > If you have a possible solution to this issue or an idea that might | ||
| > help us to find one, describe it here. Let us know what you tried! | ||
| > This section is usually only required when reporting bugs. | ||
| > So you can remove it, if this issue is not something that needs solving. | ||
| > | ||
| > You can remove this section if it'd be empty. | ||
| > Of course, if you make a feature request and already have an idea on how | ||
| > to implement it, you are welcome to describe your proposed solution here as well! | ||
| #### What's your setup | ||
| ## My setup | ||
| > You can remove this section, if it's irrelevant to the issue | ||
| - OS (`Windows/OS X/Linux` + `version`): | ||
@@ -31,93 +70,1 @@ - Node (`node --version`): | ||
| - Docker (`docker version --format '{{.Server.Version}}'`): | ||
| > You can remove this section if it's irrelevant to the issue | ||
| > (for example for certain questions or feature requests). | ||
| #### Issue checklist | ||
| Please check the boxes in this list after submitting your Issue: | ||
| - [ ] I've checked if this issue already exists | ||
| - [ ] I've included all the information that i think is relevant | ||
| - [ ] I've added logs and/or screenshots (if applicable) | ||
| - [ ] I've mentioned PRs and issues that relate to this one | ||
| ## Example | ||
| <details> | ||
| <summary> | ||
| :warning: Before creating the issue, click here to expand and follow the guide. | ||
| </summary> | ||
| <br> | ||
| 1. Be sure to fill out **every** topic presented in this template. | ||
| If a section is not valid or useful for your issue, feel free to remove it. | ||
| 2. Use the attached Checklist to make sure your issue contains all relevant information. | ||
| 3. Attach a label to your issue that reflects what your issue is all about. | ||
| **When your issue concerns only a specific platform, be sure to attach the label for that platform!** | ||
| 4. Please use a fitting emoji at the beginning of your issue title. | ||
| Example 1 - Report a bug: | ||
| ```md | ||
| :bug: Something is not working properly | ||
| ``` | ||
| Example 2 - Report a performance issue: | ||
| ```md | ||
| :zap: Something is slower than it should be | ||
| ``` | ||
| Example 3 - Report a package vulnerability or security issue: | ||
| ```md | ||
| :lock: Package xy produces vulnerabilites | ||
| ``` | ||
| ```md | ||
| :lock: User XY has access to something he shouldn't have | ||
| ``` | ||
| Example 4 - Report missing test coverage: | ||
| ```md | ||
| :white_check_mark: Add tests for... | ||
| ``` | ||
| You can of course phrase your titles however you like. | ||
| Just be sure they are short, to the point and convey the general idea of the issue you are experiencing. | ||
| </details> | ||
| ## Emojis | ||
| <details> | ||
| <summary> | ||
| Expand for a list of most used Emojis. | ||
| </summary> | ||
| <br> | ||
| Please prefix your Issue with an Emoji. | ||
| Ref: https://gitmoji.carloscuesta.me/ | ||
| | Description | Glyphe | Emoji | | ||
| |--------------------------|----------------------|--------| | ||
| | Bugfix | `:bug:` | 🐛 | | ||
| | Fixing Security Issues | `:lock:` | 🔒 | | ||
| | 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> |
@@ -1,17 +0,47 @@ | ||
| :tada: **Thanks for submitting this Pull Request** | ||
| ## BEFORE SUBMITTING | ||
| Please provide a list including your changes. | ||
| > **Please ensure you have followed this guide, _before_ submitting your PR!** | ||
| > | ||
| > - Prefix the PR title according to the [gitmoji guide](https://gitmoji.carloscuesta.me/). | ||
| > - Reference all PRs and issues relevant for this PR. | ||
| > - **Be sure that you have reviewed and tested every change you made here!** | ||
| > - If you're not sure how you can test your changes, don't hesitate to contact us! | ||
| > - List all fixed/closed issues here with `Closes #123` or `Fixes #123`. | ||
| > - **If no issue for this PR exists, please consider creating one!** | ||
| > - Of course, if this just fixes a typo, linter error or is something equally simple, no issue is required. | ||
| > - Add the number of this PR to this PRs body, so you can add it to the commit message. | ||
| > This will allow us to create a nice changelog for the next release. | ||
| > | ||
| ><details> | ||
| ><summary> | ||
| >Click here for a list of commonly used PR emojis. | ||
| ></summary> | ||
| > | ||
| >| Description | Glyphe | Emoji| | ||
| >|--------------------------|-----------------------------|------| | ||
| >| Work In Progress (WIP) | `:construction:` | 🚧 | | ||
| >| Bugfix | `:bug:` | 🐛 | | ||
| >| Fixing Security Issues | `:lock:` | 🔒 | | ||
| >| Improving Performance | `:zap:` | ⚡️ | | ||
| >| New Feature | `:sparkles:` | ✨ | | ||
| >| Refactoring Code | `:recycle:` | ♻️ | | ||
| >| CI Pipeline related | `:construction_worker_man:` | 👷 | | ||
| >| Configuration releated | `:wrench:` | 🔧 | | ||
| >| Tests | `:white_check_mark:` | ✅ | | ||
| >| Removing Stuff | `:fire:` | 🔥 | | ||
| >| Releasing / Version tags | `:bookmark:` | 🔖 | | ||
| >| Dependencies Downgrade | `:arrow_down:` | ⬇️ | | ||
| >| Dependencies Upgrade | `:arrow_up:` | ⬆️ | | ||
| >| Initial commit | `:tada:` | 🎉 | | ||
| >| Linter | `:rotating_light:` | 🚨 | | ||
| >| Cosmetic | `:lipstick:` | 💄 | | ||
| >| Formatting | `:art:` | 🎨 | | ||
| >| Miscellaneous | `:package:` | 📦 | | ||
| > | ||
| ></details> | ||
| > | ||
| > **Please remove this section when you're done creating this PR.** | ||
| To help us to create a meaningful Changelog, we agreed | ||
| to use an emoji-based commit-style. Use the [Emojis](#emojis) | ||
| we provided below. | ||
| ## Changes | ||
| 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 | ||
@@ -21,101 +51,10 @@ 2. Change 2 | ||
| ## Issues | ||
| **Issues:** | ||
| Closes #YourIssueNumber | ||
| Closes #Issue | ||
| Closes #Issue | ||
| Closes (...) | ||
| PR: #PullRequest | ||
| --- | ||
| See the [examples](#example) for inspiration. | ||
| ## How can others test the changes? | ||
| > Describe how others can test your changes (you can remove this section for typo fixes etc.) | ||
| ## PR-Checklist | ||
| Please check the boxes in this list after submitting your PR: | ||
| - [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 | ||
| ## How to test the changes | ||
| <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:` | 🐛 | | ||
| | Fixing Security Issues | `:lock:` | 🔒 | | ||
| | 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> | ||
| > Describe how others can test your changes (not required when fixing typos, linter errors and such) |
| "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| //# sourceMappingURL=ilogging_api.js.map | ||
| //# sourceMappingURL=ilogging_api.js.map |
| "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| //# sourceMappingURL=ilogging_repository.js.map | ||
| //# sourceMappingURL=ilogging_repository.js.map |
@@ -9,3 +9,2 @@ "use strict"; | ||
| __export(require("./rest_settings")); | ||
| //# sourceMappingURL=index.js.map | ||
| //# sourceMappingURL=index.js.map |
| "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| /** | ||
| * 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. | ||
| */ | ||
| class LogEntry { | ||
| } | ||
| exports.LogEntry = LogEntry; | ||
| //# sourceMappingURL=log_entry.js.map | ||
| //# sourceMappingURL=log_entry.js.map |
| "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| /** | ||
| * Contains the definition of log levels. | ||
| */ | ||
| var LogLevel; | ||
@@ -10,3 +13,2 @@ (function (LogLevel) { | ||
| })(LogLevel = exports.LogLevel || (exports.LogLevel = {})); | ||
| //# sourceMappingURL=log_level.js.map | ||
| //# sourceMappingURL=log_level.js.map |
@@ -13,3 +13,2 @@ "use strict"; | ||
| }; | ||
| //# sourceMappingURL=rest_settings.js.map | ||
| //# sourceMappingURL=rest_settings.js.map |
@@ -1,14 +0,5 @@ | ||
| /** | ||
| * Contains the endpoints and various rest parameters used by the logging API. | ||
| */ | ||
| export declare const restSettings: { | ||
| /** | ||
| * A collection of all URL parameters employed by the logging API. | ||
| */ | ||
| params: { | ||
| processModelId: string; | ||
| }; | ||
| /** | ||
| * A collection of all URLs employed by the logging API. | ||
| */ | ||
| paths: { | ||
@@ -15,0 +6,0 @@ getLogForProcessModel: string; |
| { | ||
| "name": "@process-engine/logging_api_contracts", | ||
| "version": "1.0.3", | ||
| "version": "1.1.0-60c84895-b6", | ||
| "description": "the api-package for process-engine logging", | ||
@@ -11,3 +11,3 @@ "main": "dist/commonjs/index.js", | ||
| }, | ||
| "author": "", | ||
| "author": "5Minds IT-Solutions GmbH & Co. KG", | ||
| "contributors": [ | ||
@@ -28,16 +28,17 @@ "Sebastian Meier <sebastian.meier@5minds.de>", | ||
| "devDependencies": { | ||
| "@essential-projects/tslint-config": "^1.1.3", | ||
| "gulp": "^4.0.0", | ||
| "gulptraum": "^3.0.0", | ||
| "gulptraum-typescript": "^3.0.0", | ||
| "@essential-projects/eslint-config": "^1.0.0", | ||
| "eslint": "^5.16.0", | ||
| "tsconfig": "^7.0.0", | ||
| "tslint": "^5.11.0", | ||
| "typescript": "^3.1.6" | ||
| "typescript": "^3.4.5" | ||
| }, | ||
| "scripts": { | ||
| "build": "gulp build", | ||
| "clean": "rm -rf dist", | ||
| "build": "npm run clean && npm run build-commonjs && npm run build-amd", | ||
| "build-commonjs": "tsc", | ||
| "build-amd": "tsc --module amd --outDir ./dist/amd", | ||
| "prepare": "npm run build", | ||
| "lint": "gulp lint", | ||
| "test": "gulp test" | ||
| "lint": "eslint src/*.ts", | ||
| "lint-fix": "eslint --fix src/*.ts", | ||
| "test": ":" | ||
| } | ||
| } |
@@ -37,7 +37,7 @@ import {IIdentity} from '@essential-projects/iam_contracts'; | ||
| writeLogForProcessModel(correlationId: string, | ||
| processModelId: string, | ||
| processInstanceId: string, | ||
| logLevel: LogLevel, | ||
| message: string, | ||
| timestamp?: Date): Promise<void>; | ||
| processModelId: string, | ||
| processInstanceId: string, | ||
| logLevel: LogLevel, | ||
| message: string, | ||
| timestamp?: Date): Promise<void>; | ||
@@ -63,9 +63,9 @@ /** | ||
| writeLogForFlowNode(correlationId: string, | ||
| processModelId: string, | ||
| processInstanceId: string, | ||
| flowNodeInstanceId: string, | ||
| flowNodeId: string, | ||
| logLevel: LogLevel, | ||
| message: string, | ||
| timestamp?: Date): Promise<void>; | ||
| processModelId: string, | ||
| processInstanceId: string, | ||
| flowNodeInstanceId: string, | ||
| flowNodeId: string, | ||
| logLevel: LogLevel, | ||
| message: string, | ||
| timestamp?: Date): Promise<void>; | ||
| } |
@@ -34,7 +34,7 @@ import {LogEntry} from './log_entry'; | ||
| writeLogForProcessModel(correlationId: string, | ||
| processModelId: string, | ||
| processInstanceId: string, | ||
| logLevel: LogLevel, | ||
| message: string, | ||
| timestamp?: Date): Promise<void>; | ||
| processModelId: string, | ||
| processInstanceId: string, | ||
| logLevel: LogLevel, | ||
| message: string, | ||
| timestamp?: Date): Promise<void>; | ||
@@ -60,9 +60,9 @@ /** | ||
| writeLogForFlowNode(correlationId: string, | ||
| processModelId: string, | ||
| processInstanceId: string, | ||
| flowNodeInstanceId: string, | ||
| flowNodeId: string, | ||
| logLevel: LogLevel, | ||
| message: string, | ||
| timestamp?: Date): Promise<void>; | ||
| processModelId: string, | ||
| processInstanceId: string, | ||
| flowNodeInstanceId: string, | ||
| flowNodeId: string, | ||
| logLevel: LogLevel, | ||
| message: string, | ||
| timestamp?: Date): Promise<void>; | ||
| } |
@@ -13,2 +13,3 @@ import {LogLevel} from './log_level'; | ||
| export class LogEntry { | ||
| public timeStamp: Date; | ||
@@ -22,2 +23,3 @@ public correlationId: string; | ||
| public message: string; | ||
| } |
@@ -1,2 +0,1 @@ | ||
| // tslint:disable:typedef | ||
| const params = { | ||
@@ -10,14 +9,5 @@ processModelId: ':process_model_id', | ||
| /** | ||
| * Contains the endpoints and various rest parameters used by the logging API. | ||
| */ | ||
| export const restSettings = { | ||
| /** | ||
| * A collection of all URL parameters employed by the logging API. | ||
| */ | ||
| params: params, | ||
| /** | ||
| * A collection of all URLs employed by the logging API. | ||
| */ | ||
| paths: paths, | ||
| }; |
@@ -6,13 +6,18 @@ { | ||
| "compilerOptions": { | ||
| "rootDir": "./src", | ||
| "outDir": "./dist/commonjs", | ||
| "module": "commonjs", | ||
| "target": "es2017", | ||
| "jsx": "react", | ||
| "moduleResolution": "node", | ||
| "target": "es2018", | ||
| "lib": [ | ||
| "es2017", | ||
| "dom" | ||
| "es2018" | ||
| ], | ||
| "declaration": true, | ||
| "skipLibCheck": true, | ||
| "declarationDir": "./dist", | ||
| "sourceMap": true, | ||
| "downlevelIteration": true, | ||
| "emitDecoratorMetadata": true, | ||
| "experimentalDecorators": true | ||
| } | ||
| }, | ||
| "include": ["src"] | ||
| } |
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
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
Sorry, the diff of this file is not supported yet
New alerts
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2.09%
31839
- Dev dependency count
- decreased by-42.86%
4
- Number of package files
- increased by36.36%
45
- Lines of code
- increased by8.21%
448
Worsened metrics
- Number of low quality alerts
- increased by100%
2
No dependency changes