logiscout 1.0.1 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (181) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +193 -0
  3. package/dist/cjs/api/Interceptor.cjs +66 -7
  4. package/dist/cjs/api/Interceptor.d.ts +4 -3
  5. package/dist/cjs/api/Interceptor.d.ts.map +1 -1
  6. package/dist/cjs/api/LogApi.cjs +2 -6
  7. package/dist/cjs/api/LogApi.d.ts +2 -3
  8. package/dist/cjs/api/LogApi.d.ts.map +1 -1
  9. package/dist/cjs/core/constants/Levels/LevelsColors.cjs +11 -0
  10. package/dist/cjs/core/constants/Levels/LevelsColors.d.ts +3 -0
  11. package/dist/cjs/core/constants/Levels/LevelsColors.d.ts.map +1 -0
  12. package/dist/cjs/core/constants/Levels/LevelsSeverity.cjs +11 -0
  13. package/dist/cjs/core/constants/Levels/LevelsSeverity.d.ts +3 -0
  14. package/dist/cjs/core/constants/Levels/LevelsSeverity.d.ts.map +1 -0
  15. package/dist/cjs/core/context/RequestContext.cjs +4 -14
  16. package/dist/cjs/core/context/RequestContext.d.ts +0 -3
  17. package/dist/cjs/core/context/RequestContext.d.ts.map +1 -1
  18. package/dist/cjs/core/enum/LogPayLoads.cjs +8 -0
  19. package/dist/cjs/core/enum/LogPayLoads.d.ts +5 -0
  20. package/dist/cjs/core/enum/LogPayLoads.d.ts.map +1 -0
  21. package/dist/cjs/core/formatters/winston/FormatLogs.cjs +18 -0
  22. package/dist/cjs/core/formatters/winston/FormatLogs.d.ts +3 -0
  23. package/dist/cjs/core/formatters/winston/FormatLogs.d.ts.map +1 -0
  24. package/dist/cjs/core/interface/CorrelationSession.cjs +2 -0
  25. package/dist/cjs/core/interface/CorrelationSession.d.ts +32 -0
  26. package/dist/cjs/core/interface/CorrelationSession.d.ts.map +1 -0
  27. package/dist/cjs/core/interface/JsonzierConfig.cjs +2 -0
  28. package/dist/cjs/core/interface/JsonzierConfig.d.ts +6 -0
  29. package/dist/cjs/core/interface/JsonzierConfig.d.ts.map +1 -0
  30. package/dist/cjs/core/interface/RequestContext.cjs +2 -0
  31. package/dist/cjs/core/interface/RequestContext.d.ts +4 -0
  32. package/dist/cjs/core/interface/RequestContext.d.ts.map +1 -0
  33. package/dist/cjs/core/interface/payloads/Payloads.cjs +2 -0
  34. package/dist/cjs/core/interface/payloads/Payloads.d.ts +11 -0
  35. package/dist/cjs/core/interface/payloads/Payloads.d.ts.map +1 -0
  36. package/dist/cjs/core/store/CorrelationStore.cjs +29 -0
  37. package/dist/cjs/core/store/CorrelationStore.d.ts +5 -0
  38. package/dist/cjs/core/store/CorrelationStore.d.ts.map +1 -0
  39. package/dist/cjs/core/types/LogEntry.d.ts +1 -0
  40. package/dist/cjs/core/types/LogEntry.d.ts.map +1 -1
  41. package/dist/cjs/errors/ThrowError.cjs +6 -0
  42. package/dist/cjs/errors/ThrowError.d.ts +2 -0
  43. package/dist/cjs/errors/ThrowError.d.ts.map +1 -0
  44. package/dist/cjs/index.cjs +13 -2
  45. package/dist/cjs/index.d.ts +1 -0
  46. package/dist/cjs/index.d.ts.map +1 -1
  47. package/dist/cjs/init.cjs +13 -0
  48. package/dist/cjs/init.d.ts +3 -0
  49. package/dist/cjs/init.d.ts.map +1 -0
  50. package/dist/cjs/initiator/state.cjs +17 -0
  51. package/dist/cjs/initiator/state.d.ts +8 -0
  52. package/dist/cjs/initiator/state.d.ts.map +1 -0
  53. package/dist/cjs/middlewares/correlationMiddleware.cjs +29 -63
  54. package/dist/cjs/middlewares/correlationMiddleware.d.ts +1 -16
  55. package/dist/cjs/middlewares/correlationMiddleware.d.ts.map +1 -1
  56. package/dist/cjs/services/Levels/Levels.cjs +10 -10
  57. package/dist/cjs/services/Levels/Levels.d.ts +15 -5
  58. package/dist/cjs/services/Levels/Levels.d.ts.map +1 -1
  59. package/dist/cjs/services/Logger/Logger.cjs +59 -114
  60. package/dist/cjs/services/Logger/Logger.d.ts +10 -2
  61. package/dist/cjs/services/Logger/Logger.d.ts.map +1 -1
  62. package/dist/cjs/services/formatters/ConsoleFormatter.cjs +30 -0
  63. package/dist/cjs/services/formatters/ConsoleFormatter.d.ts +12 -0
  64. package/dist/cjs/services/formatters/ConsoleFormatter.d.ts.map +1 -0
  65. package/dist/cjs/services/processors/Jsonizer.cjs +31 -0
  66. package/dist/cjs/services/processors/Jsonizer.d.ts +11 -0
  67. package/dist/cjs/services/processors/Jsonizer.d.ts.map +1 -0
  68. package/dist/cjs/services/transporter/ConsoleTranspoter.cjs +16 -0
  69. package/dist/cjs/services/transporter/ConsoleTranspoter.d.ts +5 -0
  70. package/dist/cjs/services/transporter/ConsoleTranspoter.d.ts.map +1 -0
  71. package/dist/cjs/services/transporter/ServerTransporter.cjs +31 -0
  72. package/dist/cjs/services/transporter/ServerTransporter.d.ts +10 -0
  73. package/dist/cjs/services/transporter/ServerTransporter.d.ts.map +1 -0
  74. package/dist/cjs/utils/GenerateCorrelationId.cjs +10 -0
  75. package/dist/cjs/utils/GenerateCorrelationId.d.ts +2 -0
  76. package/dist/cjs/utils/GenerateCorrelationId.d.ts.map +1 -0
  77. package/dist/cjs/validator/ValidateComponentName.cjs +14 -0
  78. package/dist/cjs/validator/ValidateComponentName.d.ts +2 -0
  79. package/dist/cjs/validator/ValidateComponentName.d.ts.map +1 -0
  80. package/dist/cjs/validator/ValidateLogEntry.cjs +18 -0
  81. package/dist/cjs/validator/ValidateLogEntry.d.ts +3 -0
  82. package/dist/cjs/validator/ValidateLogEntry.d.ts.map +1 -0
  83. package/dist/cjs/validator/ValidateLogLevel.cjs +11 -0
  84. package/dist/cjs/validator/ValidateLogLevel.d.ts +2 -0
  85. package/dist/cjs/validator/ValidateLogLevel.d.ts.map +1 -0
  86. package/dist/cjs/validator/ValidateLogMessage.cjs +10 -0
  87. package/dist/cjs/validator/ValidateLogMessage.d.ts +2 -0
  88. package/dist/cjs/validator/ValidateLogMessage.d.ts.map +1 -0
  89. package/dist/cjs/validator/ValidateRequestContext.cjs +18 -0
  90. package/dist/cjs/validator/ValidateRequestContext.d.ts +2 -0
  91. package/dist/cjs/validator/ValidateRequestContext.d.ts.map +1 -0
  92. package/dist/esm/api/Interceptor.d.ts +4 -3
  93. package/dist/esm/api/Interceptor.d.ts.map +1 -1
  94. package/dist/esm/api/Interceptor.js +64 -7
  95. package/dist/esm/api/LogApi.d.ts +2 -3
  96. package/dist/esm/api/LogApi.d.ts.map +1 -1
  97. package/dist/esm/api/LogApi.js +2 -3
  98. package/dist/esm/core/constants/Levels/LevelsColors.d.ts +3 -0
  99. package/dist/esm/core/constants/Levels/LevelsColors.d.ts.map +1 -0
  100. package/dist/esm/core/constants/Levels/LevelsColors.js +8 -0
  101. package/dist/esm/core/constants/Levels/LevelsSeverity.d.ts +3 -0
  102. package/dist/esm/core/constants/Levels/LevelsSeverity.d.ts.map +1 -0
  103. package/dist/esm/core/constants/Levels/LevelsSeverity.js +8 -0
  104. package/dist/esm/core/context/RequestContext.d.ts +0 -3
  105. package/dist/esm/core/context/RequestContext.d.ts.map +1 -1
  106. package/dist/esm/core/context/RequestContext.js +4 -14
  107. package/dist/esm/core/enum/LogPayLoads.d.ts +5 -0
  108. package/dist/esm/core/enum/LogPayLoads.d.ts.map +1 -0
  109. package/dist/esm/core/enum/LogPayLoads.js +5 -0
  110. package/dist/esm/core/formatters/winston/FormatLogs.d.ts +3 -0
  111. package/dist/esm/core/formatters/winston/FormatLogs.d.ts.map +1 -0
  112. package/dist/esm/core/formatters/winston/FormatLogs.js +15 -0
  113. package/dist/esm/core/interface/CorrelationSession.d.ts +32 -0
  114. package/dist/esm/core/interface/CorrelationSession.d.ts.map +1 -0
  115. package/dist/esm/core/interface/CorrelationSession.js +1 -0
  116. package/dist/esm/core/interface/JsonzierConfig.d.ts +6 -0
  117. package/dist/esm/core/interface/JsonzierConfig.d.ts.map +1 -0
  118. package/dist/esm/core/interface/JsonzierConfig.js +1 -0
  119. package/dist/esm/core/interface/RequestContext.d.ts +4 -0
  120. package/dist/esm/core/interface/RequestContext.d.ts.map +1 -0
  121. package/dist/esm/core/interface/RequestContext.js +1 -0
  122. package/dist/esm/core/interface/payloads/Payloads.d.ts +11 -0
  123. package/dist/esm/core/interface/payloads/Payloads.d.ts.map +1 -0
  124. package/dist/esm/core/interface/payloads/Payloads.js +1 -0
  125. package/dist/esm/core/store/CorrelationStore.d.ts +5 -0
  126. package/dist/esm/core/store/CorrelationStore.d.ts.map +1 -0
  127. package/dist/esm/core/store/CorrelationStore.js +24 -0
  128. package/dist/esm/core/types/LogEntry.d.ts +1 -0
  129. package/dist/esm/core/types/LogEntry.d.ts.map +1 -1
  130. package/dist/esm/errors/ThrowError.d.ts +2 -0
  131. package/dist/esm/errors/ThrowError.d.ts.map +1 -0
  132. package/dist/esm/errors/ThrowError.js +3 -0
  133. package/dist/esm/index.d.ts +1 -0
  134. package/dist/esm/index.d.ts.map +1 -1
  135. package/dist/esm/index.js +11 -1
  136. package/dist/esm/init.d.ts +3 -0
  137. package/dist/esm/init.d.ts.map +1 -0
  138. package/dist/esm/init.js +10 -0
  139. package/dist/esm/initiator/state.d.ts +8 -0
  140. package/dist/esm/initiator/state.d.ts.map +1 -0
  141. package/dist/esm/initiator/state.js +13 -0
  142. package/dist/esm/middlewares/correlationMiddleware.d.ts +1 -16
  143. package/dist/esm/middlewares/correlationMiddleware.d.ts.map +1 -1
  144. package/dist/esm/middlewares/correlationMiddleware.js +28 -58
  145. package/dist/esm/services/Levels/Levels.d.ts +15 -5
  146. package/dist/esm/services/Levels/Levels.d.ts.map +1 -1
  147. package/dist/esm/services/Levels/Levels.js +10 -10
  148. package/dist/esm/services/Logger/Logger.d.ts +10 -2
  149. package/dist/esm/services/Logger/Logger.d.ts.map +1 -1
  150. package/dist/esm/services/Logger/Logger.js +56 -81
  151. package/dist/esm/services/formatters/ConsoleFormatter.d.ts +12 -0
  152. package/dist/esm/services/formatters/ConsoleFormatter.d.ts.map +1 -0
  153. package/dist/esm/services/formatters/ConsoleFormatter.js +26 -0
  154. package/dist/esm/services/processors/Jsonizer.d.ts +11 -0
  155. package/dist/esm/services/processors/Jsonizer.d.ts.map +1 -0
  156. package/dist/esm/services/processors/Jsonizer.js +27 -0
  157. package/dist/esm/services/transporter/ConsoleTranspoter.d.ts +5 -0
  158. package/dist/esm/services/transporter/ConsoleTranspoter.d.ts.map +1 -0
  159. package/dist/esm/services/transporter/ConsoleTranspoter.js +9 -0
  160. package/dist/esm/services/transporter/ServerTransporter.d.ts +10 -0
  161. package/dist/esm/services/transporter/ServerTransporter.d.ts.map +1 -0
  162. package/dist/esm/services/transporter/ServerTransporter.js +27 -0
  163. package/dist/esm/utils/GenerateCorrelationId.d.ts +2 -0
  164. package/dist/esm/utils/GenerateCorrelationId.d.ts.map +1 -0
  165. package/dist/esm/utils/GenerateCorrelationId.js +4 -0
  166. package/dist/esm/validator/ValidateComponentName.d.ts +2 -0
  167. package/dist/esm/validator/ValidateComponentName.d.ts.map +1 -0
  168. package/dist/esm/validator/ValidateComponentName.js +11 -0
  169. package/dist/esm/validator/ValidateLogEntry.d.ts +3 -0
  170. package/dist/esm/validator/ValidateLogEntry.d.ts.map +1 -0
  171. package/dist/esm/validator/ValidateLogEntry.js +15 -0
  172. package/dist/esm/validator/ValidateLogLevel.d.ts +2 -0
  173. package/dist/esm/validator/ValidateLogLevel.d.ts.map +1 -0
  174. package/dist/esm/validator/ValidateLogLevel.js +8 -0
  175. package/dist/esm/validator/ValidateLogMessage.d.ts +2 -0
  176. package/dist/esm/validator/ValidateLogMessage.d.ts.map +1 -0
  177. package/dist/esm/validator/ValidateLogMessage.js +7 -0
  178. package/dist/esm/validator/ValidateRequestContext.d.ts +2 -0
  179. package/dist/esm/validator/ValidateRequestContext.d.ts.map +1 -0
  180. package/dist/esm/validator/ValidateRequestContext.js +15 -0
  181. package/package.json +5 -3
@@ -0,0 +1,27 @@
1
+ import { LogApi } from "../../api/LogApi.js";
2
+ import { LogPayloadType } from "../../core/enum/LogPayLoads.js";
3
+ export class ServerTransporter {
4
+ transport(session) {
5
+ if (this.isFrontendSession(session)) {
6
+ this.sendSingle(session);
7
+ return;
8
+ }
9
+ this.sendCorrelation(session);
10
+ }
11
+ sendCorrelation(session) {
12
+ LogApi({
13
+ type: LogPayloadType.SESSION,
14
+ data: session,
15
+ });
16
+ }
17
+ sendSingle(session) {
18
+ LogApi({
19
+ type: LogPayloadType.SINGLE,
20
+ data: session,
21
+ });
22
+ }
23
+ isFrontendSession(session) {
24
+ // Decide ONLY based on session shape/data
25
+ return session.correlationId === "no-correlation-id";
26
+ }
27
+ }
@@ -0,0 +1,2 @@
1
+ export declare function generateCorrelationId(projectName: string, componentName: string): string;
2
+ //# sourceMappingURL=GenerateCorrelationId.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"GenerateCorrelationId.d.ts","sourceRoot":"","sources":["../../../src/utils/GenerateCorrelationId.ts"],"names":[],"mappings":"AAEA,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM,GACpB,MAAM,CAER"}
@@ -0,0 +1,4 @@
1
+ import crypto from "crypto";
2
+ export function generateCorrelationId(projectName, componentName) {
3
+ return `${projectName}-${componentName}-${crypto.randomUUID()}`;
4
+ }
@@ -0,0 +1,2 @@
1
+ export default function validateComponentName(componentName: string): void;
2
+ //# sourceMappingURL=ValidateComponentName.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ValidateComponentName.d.ts","sourceRoot":"","sources":["../../../src/validator/ValidateComponentName.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAAC,aAAa,EAAC,MAAM,QAajE"}
@@ -0,0 +1,11 @@
1
+ import { throwError } from "../errors/ThrowError.js";
2
+ export default function validateComponentName(componentName) {
3
+ if (!componentName || typeof componentName !== "string") {
4
+ throwError("Logger: Component name must be a non-empty string. " +
5
+ "Usage: createLogger('ComponentName')");
6
+ }
7
+ if (componentName.length > 100) {
8
+ throwError("Logger: Component name cannot exceed 100 characters. " +
9
+ `Received: '${componentName.substring(0, 20)}...'`);
10
+ }
11
+ }
@@ -0,0 +1,3 @@
1
+ import { LogEntry } from "../core/types/LogEntry.js";
2
+ export default function validateLogEntry(entry: LogEntry): void;
3
+ //# sourceMappingURL=ValidateLogEntry.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ValidateLogEntry.d.ts","sourceRoot":"","sources":["../../../src/validator/ValidateLogEntry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAGrD,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAoB9D"}
@@ -0,0 +1,15 @@
1
+ import { throwError } from "../errors/ThrowError.js";
2
+ export default function validateLogEntry(entry) {
3
+ if (!entry) {
4
+ throwError("[Logiscout] Log entry is undefined or null");
5
+ }
6
+ if (!entry.message || typeof entry.message !== "string") {
7
+ throwError("[Logiscout] Log message must be a non-empty string. " +
8
+ `Usage: logiscout.${entry.level}('Your message', { meta })`);
9
+ }
10
+ if (entry.message.length > 10000) {
11
+ console.error("[Logiscout] Log message exceeds 10000 characters. Message truncated.");
12
+ entry.message =
13
+ entry.message.substring(0, 10000) + "... [truncated]";
14
+ }
15
+ }
@@ -0,0 +1,2 @@
1
+ export default function validateLogLevel(logLevel: any): void;
2
+ //# sourceMappingURL=ValidateLogLevel.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ValidateLogLevel.d.ts","sourceRoot":"","sources":["../../../src/validator/ValidateLogLevel.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,QAAQ,EAAE,GAAG,GAAG,IAAI,CAO5D"}
@@ -0,0 +1,8 @@
1
+ import { LogLevels } from "../core/enum/LogLevels.js";
2
+ import { throwError } from "../errors/ThrowError.js";
3
+ export default function validateLogLevel(logLevel) {
4
+ if (!Object.values(LogLevels).includes(logLevel)) {
5
+ throwError(`Logger: Invalid log level '${logLevel}'. ` +
6
+ `Valid levels: ${Object.values(LogLevels).join(", ")}`);
7
+ }
8
+ }
@@ -0,0 +1,2 @@
1
+ export default function validateLogMessage(message: string): void;
2
+ //# sourceMappingURL=ValidateLogMessage.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ValidateLogMessage.d.ts","sourceRoot":"","sources":["../../../src/validator/ValidateLogMessage.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAShE"}
@@ -0,0 +1,7 @@
1
+ import { throwError } from "../errors/ThrowError.js";
2
+ export default function validateLogMessage(message) {
3
+ if (!message || typeof message !== "string") {
4
+ throwError(`Logger: Message must be a non-empty string. ` +
5
+ `Received: ${typeof message === "undefined" ? "undefined" : typeof message}`);
6
+ }
7
+ }
@@ -0,0 +1,2 @@
1
+ export declare function validateRequestContext(fn: () => void, correlationId: string | undefined): void;
2
+ //# sourceMappingURL=ValidateRequestContext.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ValidateRequestContext.d.ts","sourceRoot":"","sources":["../../../src/validator/ValidateRequestContext.ts"],"names":[],"mappings":"AAEA,wBAAgB,sBAAsB,CACpC,EAAE,EAAE,MAAM,IAAI,EACd,aAAa,EAAE,MAAM,GAAC,SAAS,GAC9B,IAAI,CAqBN"}
@@ -0,0 +1,15 @@
1
+ import { throwError } from "../errors/ThrowError.js";
2
+ export function validateRequestContext(fn, correlationId) {
3
+ if (typeof fn !== "function") {
4
+ throwError("RequestContext.run() requires a function as the first parameter. " +
5
+ "Usage: RequestContext.run(() => { ... }, correlationId?)");
6
+ }
7
+ // Validate correlationId if provided
8
+ if (correlationId !== undefined && typeof correlationId !== "string") {
9
+ throwError("RequestContext.run(): correlationId must be a string if provided. " +
10
+ `Received: ${typeof correlationId}`);
11
+ }
12
+ if (correlationId && correlationId.length > 100) {
13
+ throwError("RequestContext.run(): correlationId cannot exceed 100 characters.");
14
+ }
15
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "logiscout",
3
- "version": "1.0.1",
3
+ "version": "1.0.4",
4
4
  "description": "Logiscout — a structured logger library",
5
5
  "type": "module",
6
6
  "main": "./dist/cjs/index.cjs",
@@ -43,10 +43,12 @@
43
43
  "node": ">=18"
44
44
  },
45
45
  "dependencies": {
46
+ "axios": "^1.13.2",
46
47
  "winston": "^3.11.0"
47
48
  },
48
49
  "devDependencies": {
49
- "typescript": "^5.3.3",
50
- "@types/node": "^20.10.0"
50
+ "@types/node": "^20.10.0",
51
+ "ts-node": "^10.9.2",
52
+ "typescript": "^5.9.3"
51
53
  }
52
54
  }