@flowcore/pathways 0.2.3 → 0.2.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.
- package/CHANGELOG.md +7 -0
- package/esm/pathways/logger.d.ts +21 -12
- package/esm/pathways/logger.d.ts.map +1 -1
- package/esm/pathways/logger.js +27 -8
- package/package.json +1 -1
- package/script/pathways/logger.d.ts +21 -12
- package/script/pathways/logger.d.ts.map +1 -1
- package/script/pathways/logger.js +27 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.2.4](https://github.com/flowcore-io/flowcore-pathways/compare/v0.2.3...v0.2.4) (2025-03-15)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* **logger:** :art: Update error method signatures and improve JSDoc documentation ([07ab772](https://github.com/flowcore-io/flowcore-pathways/commit/07ab77237c7aa88f6bc5999ff95148873c2e45d0))
|
|
9
|
+
|
|
3
10
|
## [0.2.3](https://github.com/flowcore-io/flowcore-pathways/compare/v0.2.2...v0.2.3) (2025-03-15)
|
|
4
11
|
|
|
5
12
|
|
package/esm/pathways/logger.d.ts
CHANGED
|
@@ -31,12 +31,15 @@ export interface Logger {
|
|
|
31
31
|
*/
|
|
32
32
|
warn(message: string, context?: LoggerMeta): void;
|
|
33
33
|
/**
|
|
34
|
-
* Log error messages
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
34
|
+
* Log error messages - supports two different method signatures:
|
|
35
|
+
* 1. error(message: string, error?: Error, context?: LoggerMeta)
|
|
36
|
+
* 2. error(messageOrError: string | Error, meta?: LoggerMeta)
|
|
37
|
+
*
|
|
38
|
+
* @param messageOrError The message to log or Error object
|
|
39
|
+
* @param errorOrContext Optional error object or context data
|
|
40
|
+
* @param context Optional context data (only for signature 1)
|
|
38
41
|
*/
|
|
39
|
-
error(
|
|
42
|
+
error(messageOrError: string | Error, errorOrContext?: Error | LoggerMeta, context?: LoggerMeta): void;
|
|
40
43
|
}
|
|
41
44
|
/**
|
|
42
45
|
* A default console logger that logs to the console
|
|
@@ -62,11 +65,15 @@ export declare class ConsoleLogger implements Logger {
|
|
|
62
65
|
warn(message: string, context?: LoggerMeta): void;
|
|
63
66
|
/**
|
|
64
67
|
* Log error messages to the console
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
+
* Supports both signature formats:
|
|
69
|
+
* 1. error(message: string, error?: Error, context?: LoggerMeta)
|
|
70
|
+
* 2. error(messageOrError: string | Error, meta?: LoggerMeta)
|
|
71
|
+
*
|
|
72
|
+
* @param messageOrError The message to log or Error object
|
|
73
|
+
* @param errorOrContext Optional error object or context data
|
|
74
|
+
* @param context Optional context data (only for signature 1)
|
|
68
75
|
*/
|
|
69
|
-
error(
|
|
76
|
+
error(messageOrError: string | Error, errorOrContext?: Error | LoggerMeta, context?: LoggerMeta): void;
|
|
70
77
|
}
|
|
71
78
|
/**
|
|
72
79
|
* A no-operation logger that does nothing
|
|
@@ -92,10 +99,12 @@ export declare class NoopLogger implements Logger {
|
|
|
92
99
|
warn(_message: string, _context?: LoggerMeta): void;
|
|
93
100
|
/**
|
|
94
101
|
* No-op error log
|
|
95
|
-
*
|
|
96
|
-
*
|
|
102
|
+
* Supports both signature formats
|
|
103
|
+
*
|
|
104
|
+
* @param _messageOrError The message to log or Error object (ignored)
|
|
105
|
+
* @param _errorOrContext Optional error object or context data (ignored)
|
|
97
106
|
* @param _context Optional context data (ignored)
|
|
98
107
|
*/
|
|
99
|
-
error(
|
|
108
|
+
error(_messageOrError: string | Error, _errorOrContext?: Error | LoggerMeta, _context?: LoggerMeta): void;
|
|
100
109
|
}
|
|
101
110
|
//# sourceMappingURL=logger.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/pathways/logger.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;IACtB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,OAAO,CAAC,EAAE,KAAK,CAAA;IACf,SAAS,CAAC,EAAE,KAAK,CAAA;CAClB;AAED,MAAM,WAAW,MAAM;IACrB;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAElD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEjD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEjD
|
|
1
|
+
{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/pathways/logger.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;IACtB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,OAAO,CAAC,EAAE,KAAK,CAAA;IACf,SAAS,CAAC,EAAE,KAAK,CAAA;CAClB;AAED,MAAM,WAAW,MAAM;IACrB;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAElD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEjD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEjD;;;;;;;;OAQG;IACH,KAAK,CAAC,cAAc,EAAE,MAAM,GAAG,KAAK,EAAE,cAAc,CAAC,EAAE,KAAK,GAAG,UAAU,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;CACvG;AAED;;GAEG;AACH,qBAAa,aAAc,YAAW,MAAM;IAC1C;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI;IAIlD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI;IAIjD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI;IAIjD;;;;;;;;;OASG;IACH,KAAK,CAAC,cAAc,EAAE,MAAM,GAAG,KAAK,EAAE,cAAc,CAAC,EAAE,KAAK,GAAG,UAAU,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI;CAcvG;AAED;;GAEG;AACH,qBAAa,UAAW,YAAW,MAAM;IACvC;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,UAAU,GAAG,IAAI;IAEpD;;;;OAIG;IACH,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,UAAU,GAAG,IAAI;IAEnD;;;;OAIG;IACH,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,UAAU,GAAG,IAAI;IAEnD;;;;;;;OAOG;IACH,KAAK,CAAC,eAAe,EAAE,MAAM,GAAG,KAAK,EAAE,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,EAAE,QAAQ,CAAC,EAAE,UAAU,GAAG,IAAI;CAC1G"}
|
package/esm/pathways/logger.js
CHANGED
|
@@ -31,12 +31,29 @@ export class ConsoleLogger {
|
|
|
31
31
|
}
|
|
32
32
|
/**
|
|
33
33
|
* Log error messages to the console
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
34
|
+
* Supports both signature formats:
|
|
35
|
+
* 1. error(message: string, error?: Error, context?: LoggerMeta)
|
|
36
|
+
* 2. error(messageOrError: string | Error, meta?: LoggerMeta)
|
|
37
|
+
*
|
|
38
|
+
* @param messageOrError The message to log or Error object
|
|
39
|
+
* @param errorOrContext Optional error object or context data
|
|
40
|
+
* @param context Optional context data (only for signature 1)
|
|
37
41
|
*/
|
|
38
|
-
error(
|
|
39
|
-
|
|
42
|
+
error(messageOrError, errorOrContext, context) {
|
|
43
|
+
if (typeof messageOrError === 'string') {
|
|
44
|
+
if (errorOrContext instanceof Error) {
|
|
45
|
+
// Signature 1: error(message: string, error: Error, context?: LoggerMeta)
|
|
46
|
+
console.error(messageOrError, errorOrContext, context ? JSON.stringify(context) : '');
|
|
47
|
+
}
|
|
48
|
+
else {
|
|
49
|
+
// Signature 1 (no error) or Signature 2: error(message: string, context?: LoggerMeta)
|
|
50
|
+
console.error(messageOrError, errorOrContext ? JSON.stringify(errorOrContext) : '');
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
else {
|
|
54
|
+
// Signature 2: error(error: Error, context?: LoggerMeta)
|
|
55
|
+
console.error(messageOrError, errorOrContext ? JSON.stringify(errorOrContext) : '');
|
|
56
|
+
}
|
|
40
57
|
}
|
|
41
58
|
}
|
|
42
59
|
/**
|
|
@@ -63,9 +80,11 @@ export class NoopLogger {
|
|
|
63
80
|
warn(_message, _context) { }
|
|
64
81
|
/**
|
|
65
82
|
* No-op error log
|
|
66
|
-
*
|
|
67
|
-
*
|
|
83
|
+
* Supports both signature formats
|
|
84
|
+
*
|
|
85
|
+
* @param _messageOrError The message to log or Error object (ignored)
|
|
86
|
+
* @param _errorOrContext Optional error object or context data (ignored)
|
|
68
87
|
* @param _context Optional context data (ignored)
|
|
69
88
|
*/
|
|
70
|
-
error(
|
|
89
|
+
error(_messageOrError, _errorOrContext, _context) { }
|
|
71
90
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flowcore/pathways",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.4",
|
|
4
4
|
"description": "A TypeScript Library for creating Flowcore Pathways, simplifying the integration with the flowcore platform",
|
|
5
5
|
"homepage": "https://github.com/flowcore-io/flowcore-sdk#readme",
|
|
6
6
|
"repository": {
|
|
@@ -31,12 +31,15 @@ export interface Logger {
|
|
|
31
31
|
*/
|
|
32
32
|
warn(message: string, context?: LoggerMeta): void;
|
|
33
33
|
/**
|
|
34
|
-
* Log error messages
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
34
|
+
* Log error messages - supports two different method signatures:
|
|
35
|
+
* 1. error(message: string, error?: Error, context?: LoggerMeta)
|
|
36
|
+
* 2. error(messageOrError: string | Error, meta?: LoggerMeta)
|
|
37
|
+
*
|
|
38
|
+
* @param messageOrError The message to log or Error object
|
|
39
|
+
* @param errorOrContext Optional error object or context data
|
|
40
|
+
* @param context Optional context data (only for signature 1)
|
|
38
41
|
*/
|
|
39
|
-
error(
|
|
42
|
+
error(messageOrError: string | Error, errorOrContext?: Error | LoggerMeta, context?: LoggerMeta): void;
|
|
40
43
|
}
|
|
41
44
|
/**
|
|
42
45
|
* A default console logger that logs to the console
|
|
@@ -62,11 +65,15 @@ export declare class ConsoleLogger implements Logger {
|
|
|
62
65
|
warn(message: string, context?: LoggerMeta): void;
|
|
63
66
|
/**
|
|
64
67
|
* Log error messages to the console
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
+
* Supports both signature formats:
|
|
69
|
+
* 1. error(message: string, error?: Error, context?: LoggerMeta)
|
|
70
|
+
* 2. error(messageOrError: string | Error, meta?: LoggerMeta)
|
|
71
|
+
*
|
|
72
|
+
* @param messageOrError The message to log or Error object
|
|
73
|
+
* @param errorOrContext Optional error object or context data
|
|
74
|
+
* @param context Optional context data (only for signature 1)
|
|
68
75
|
*/
|
|
69
|
-
error(
|
|
76
|
+
error(messageOrError: string | Error, errorOrContext?: Error | LoggerMeta, context?: LoggerMeta): void;
|
|
70
77
|
}
|
|
71
78
|
/**
|
|
72
79
|
* A no-operation logger that does nothing
|
|
@@ -92,10 +99,12 @@ export declare class NoopLogger implements Logger {
|
|
|
92
99
|
warn(_message: string, _context?: LoggerMeta): void;
|
|
93
100
|
/**
|
|
94
101
|
* No-op error log
|
|
95
|
-
*
|
|
96
|
-
*
|
|
102
|
+
* Supports both signature formats
|
|
103
|
+
*
|
|
104
|
+
* @param _messageOrError The message to log or Error object (ignored)
|
|
105
|
+
* @param _errorOrContext Optional error object or context data (ignored)
|
|
97
106
|
* @param _context Optional context data (ignored)
|
|
98
107
|
*/
|
|
99
|
-
error(
|
|
108
|
+
error(_messageOrError: string | Error, _errorOrContext?: Error | LoggerMeta, _context?: LoggerMeta): void;
|
|
100
109
|
}
|
|
101
110
|
//# sourceMappingURL=logger.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/pathways/logger.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;IACtB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,OAAO,CAAC,EAAE,KAAK,CAAA;IACf,SAAS,CAAC,EAAE,KAAK,CAAA;CAClB;AAED,MAAM,WAAW,MAAM;IACrB;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAElD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEjD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEjD
|
|
1
|
+
{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/pathways/logger.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;IACtB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,OAAO,CAAC,EAAE,KAAK,CAAA;IACf,SAAS,CAAC,EAAE,KAAK,CAAA;CAClB;AAED,MAAM,WAAW,MAAM;IACrB;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAElD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEjD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEjD;;;;;;;;OAQG;IACH,KAAK,CAAC,cAAc,EAAE,MAAM,GAAG,KAAK,EAAE,cAAc,CAAC,EAAE,KAAK,GAAG,UAAU,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;CACvG;AAED;;GAEG;AACH,qBAAa,aAAc,YAAW,MAAM;IAC1C;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI;IAIlD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI;IAIjD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI;IAIjD;;;;;;;;;OASG;IACH,KAAK,CAAC,cAAc,EAAE,MAAM,GAAG,KAAK,EAAE,cAAc,CAAC,EAAE,KAAK,GAAG,UAAU,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI;CAcvG;AAED;;GAEG;AACH,qBAAa,UAAW,YAAW,MAAM;IACvC;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,UAAU,GAAG,IAAI;IAEpD;;;;OAIG;IACH,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,UAAU,GAAG,IAAI;IAEnD;;;;OAIG;IACH,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,UAAU,GAAG,IAAI;IAEnD;;;;;;;OAOG;IACH,KAAK,CAAC,eAAe,EAAE,MAAM,GAAG,KAAK,EAAE,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,EAAE,QAAQ,CAAC,EAAE,UAAU,GAAG,IAAI;CAC1G"}
|
|
@@ -34,12 +34,29 @@ class ConsoleLogger {
|
|
|
34
34
|
}
|
|
35
35
|
/**
|
|
36
36
|
* Log error messages to the console
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
37
|
+
* Supports both signature formats:
|
|
38
|
+
* 1. error(message: string, error?: Error, context?: LoggerMeta)
|
|
39
|
+
* 2. error(messageOrError: string | Error, meta?: LoggerMeta)
|
|
40
|
+
*
|
|
41
|
+
* @param messageOrError The message to log or Error object
|
|
42
|
+
* @param errorOrContext Optional error object or context data
|
|
43
|
+
* @param context Optional context data (only for signature 1)
|
|
40
44
|
*/
|
|
41
|
-
error(
|
|
42
|
-
|
|
45
|
+
error(messageOrError, errorOrContext, context) {
|
|
46
|
+
if (typeof messageOrError === 'string') {
|
|
47
|
+
if (errorOrContext instanceof Error) {
|
|
48
|
+
// Signature 1: error(message: string, error: Error, context?: LoggerMeta)
|
|
49
|
+
console.error(messageOrError, errorOrContext, context ? JSON.stringify(context) : '');
|
|
50
|
+
}
|
|
51
|
+
else {
|
|
52
|
+
// Signature 1 (no error) or Signature 2: error(message: string, context?: LoggerMeta)
|
|
53
|
+
console.error(messageOrError, errorOrContext ? JSON.stringify(errorOrContext) : '');
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
else {
|
|
57
|
+
// Signature 2: error(error: Error, context?: LoggerMeta)
|
|
58
|
+
console.error(messageOrError, errorOrContext ? JSON.stringify(errorOrContext) : '');
|
|
59
|
+
}
|
|
43
60
|
}
|
|
44
61
|
}
|
|
45
62
|
exports.ConsoleLogger = ConsoleLogger;
|
|
@@ -67,10 +84,12 @@ class NoopLogger {
|
|
|
67
84
|
warn(_message, _context) { }
|
|
68
85
|
/**
|
|
69
86
|
* No-op error log
|
|
70
|
-
*
|
|
71
|
-
*
|
|
87
|
+
* Supports both signature formats
|
|
88
|
+
*
|
|
89
|
+
* @param _messageOrError The message to log or Error object (ignored)
|
|
90
|
+
* @param _errorOrContext Optional error object or context data (ignored)
|
|
72
91
|
* @param _context Optional context data (ignored)
|
|
73
92
|
*/
|
|
74
|
-
error(
|
|
93
|
+
error(_messageOrError, _errorOrContext, _context) { }
|
|
75
94
|
}
|
|
76
95
|
exports.NoopLogger = NoopLogger;
|