@event-driven-io/emmett-expressjs 0.43.0-beta.23 → 0.43.0-beta.24

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/dist/index.d.cts CHANGED
@@ -5,26 +5,57 @@ import { Brand, Event, EventStore, InMemoryEventStore, TestEventStream } from "@
5
5
  import supertest, { Response as Response$1, Test } from "supertest";
6
6
  import TestAgent from "supertest/lib/agent.js";
7
7
 
8
- //#region ../almanac/dist/meter-CY9GTIM8.d.ts
9
- //#region src/meters/meter.d.ts
10
- type Counter = {
11
- add(value: number, attributes?: Record<string, unknown>): void;
8
+ //#region ../almanac/dist/tracer-D_p40WEL.d.ts
9
+ //#region src/loggers/logger.d.ts
10
+ type LogLevel = 'silent' | 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
11
+ declare const LogLevel: {
12
+ default: LogLevel;
13
+ silent: LogLevel;
14
+ trace: LogLevel;
15
+ debug: LogLevel;
16
+ info: LogLevel;
17
+ warn: LogLevel;
18
+ error: LogLevel;
19
+ fatal: LogLevel;
12
20
  };
13
- type Histogram = {
14
- record(value: number, attributes?: Record<string, unknown>): void;
21
+ type LogAttributes = Record<string, unknown>;
22
+ type RequireAtLeastOne<T> = { [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>> }[keyof T];
23
+ type LogEventData<Attributes extends LogAttributes = LogAttributes> = RequireAtLeastOne<{
24
+ error?: Error;
25
+ body?: string;
26
+ attributes?: Attributes;
27
+ }>;
28
+ type LogEventMetadata = {
29
+ level: LogLevel;
30
+ timestamp: number;
31
+ traceId?: string;
32
+ spanId?: string;
15
33
  };
16
- type Gauge = {
17
- record(value: number, attributes?: Record<string, unknown>): void;
34
+ type LogEventMetadataInput = {
35
+ level: LogLevel;
36
+ timestamp?: number;
37
+ traceId?: string;
38
+ spanId?: string;
18
39
  };
19
- type Meter = {
20
- counter(name: string): Counter;
21
- histogram(name: string): Histogram;
22
- gauge(name: string): Gauge;
40
+ type LogEventMetadataOverrides = Omit<LogEventMetadataInput, 'level'>;
41
+ type LogEvent<EventName extends string = string, Attributes extends LogAttributes = LogAttributes> = Readonly<{
42
+ name: EventName;
43
+ data: LogEventData<Attributes>;
44
+ metadata: LogEventMetadata;
45
+ }>;
46
+ declare const LogEvent: (<Attributes extends LogAttributes = LogAttributes, EventName extends string = string>(eventName: EventName, data: LogEventData<Attributes>, eventMetadata: LogEventMetadataInput) => LogEvent<EventName, Attributes>) & {
47
+ message: <Attributes extends LogAttributes = LogAttributes, EventName extends string = string>(level: LogLevel, body: EventName, data?: Omit<LogEventData<Attributes>, "body">, eventMetadata?: LogEventMetadataOverrides) => LogEvent<EventName, Attributes>;
48
+ fatal: (msgOrObj: string | LogAttributes | Error, msgOrMetadata?: string | LogEventMetadataOverrides, eventMetadata?: LogEventMetadataOverrides) => LogEvent;
49
+ error: (msgOrObj: string | LogAttributes | Error, msgOrMetadata?: string | LogEventMetadataOverrides, eventMetadata?: LogEventMetadataOverrides) => LogEvent;
50
+ warn: (msgOrObj: string | LogAttributes | Error, msgOrMetadata?: string | LogEventMetadataOverrides, eventMetadata?: LogEventMetadataOverrides) => LogEvent;
51
+ info: (msgOrObj: string | LogAttributes | Error, msgOrMetadata?: string | LogEventMetadataOverrides, eventMetadata?: LogEventMetadataOverrides) => LogEvent;
52
+ debug: (msgOrObj: string | LogAttributes | Error, msgOrMetadata?: string | LogEventMetadataOverrides, eventMetadata?: LogEventMetadataOverrides) => LogEvent;
53
+ trace: (msgOrObj: string | LogAttributes | Error, msgOrMetadata?: string | LogEventMetadataOverrides, eventMetadata?: LogEventMetadataOverrides) => LogEvent;
54
+ silent: (msgOrObj: string | LogAttributes | Error, msgOrMetadata?: string | LogEventMetadataOverrides, eventMetadata?: LogEventMetadataOverrides) => LogEvent;
23
55
  };
56
+ type Logger = (event: LogEvent) => void;
24
57
  //#endregion
25
- //#region ../almanac/dist/tracer-DJWFmYul.d.ts
26
58
  //#region src/tracers/span.d.ts
27
- type SpanEventLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error';
28
59
  type SpanContext = {
29
60
  traceId: string;
30
61
  spanId: string;
@@ -36,8 +67,7 @@ type ActiveSpan = {
36
67
  setAttributes(attrs: Record<string, unknown>): void;
37
68
  spanContext(): SpanContext;
38
69
  addLink(link: SpanLink): void;
39
- addEvent(name: string, attributes?: Record<string, unknown>, level?: SpanEventLevel): void;
40
- recordException(error: Error | string): void;
70
+ log: Logger;
41
71
  };
42
72
  type StartSpanOptions = {
43
73
  parent?: SpanContext;
@@ -53,6 +83,23 @@ type Tracer = {
53
83
  startSpan<T>(name: string, fn: (span: ActiveSpan) => Promise<T>, options?: StartSpanOptions): Promise<T>;
54
84
  };
55
85
  //#endregion
86
+ //#region ../almanac/dist/meter-CIOX3AFP.d.ts
87
+ //#region src/meters/meter.d.ts
88
+ type Counter = {
89
+ add(value: number, attributes?: Record<string, unknown>): void;
90
+ };
91
+ type Histogram = {
92
+ record(value: number, attributes?: Record<string, unknown>): void;
93
+ };
94
+ type Gauge = {
95
+ record(value: number, attributes?: Record<string, unknown>): void;
96
+ };
97
+ type Meter = {
98
+ counter(name: string): Counter;
99
+ histogram(name: string): Histogram;
100
+ gauge(name: string): Gauge;
101
+ };
102
+ //#endregion
56
103
  //#region ../almanac/dist/index.d.ts
57
104
  type AttributeTarget = 'mainSpan' | 'currentSpan' | 'both'; //#endregion
58
105
  //#region src/meters/compositeMeter.d.ts
package/dist/index.d.ts CHANGED
@@ -5,26 +5,57 @@ import { ProblemDocument } from "http-problem-details";
5
5
  import supertest, { Response as Response$1, Test } from "supertest";
6
6
  import TestAgent from "supertest/lib/agent.js";
7
7
 
8
- //#region ../almanac/dist/meter-CY9GTIM8.d.ts
9
- //#region src/meters/meter.d.ts
10
- type Counter = {
11
- add(value: number, attributes?: Record<string, unknown>): void;
8
+ //#region ../almanac/dist/tracer-D_p40WEL.d.ts
9
+ //#region src/loggers/logger.d.ts
10
+ type LogLevel = 'silent' | 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
11
+ declare const LogLevel: {
12
+ default: LogLevel;
13
+ silent: LogLevel;
14
+ trace: LogLevel;
15
+ debug: LogLevel;
16
+ info: LogLevel;
17
+ warn: LogLevel;
18
+ error: LogLevel;
19
+ fatal: LogLevel;
12
20
  };
13
- type Histogram = {
14
- record(value: number, attributes?: Record<string, unknown>): void;
21
+ type LogAttributes = Record<string, unknown>;
22
+ type RequireAtLeastOne<T> = { [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>> }[keyof T];
23
+ type LogEventData<Attributes extends LogAttributes = LogAttributes> = RequireAtLeastOne<{
24
+ error?: Error;
25
+ body?: string;
26
+ attributes?: Attributes;
27
+ }>;
28
+ type LogEventMetadata = {
29
+ level: LogLevel;
30
+ timestamp: number;
31
+ traceId?: string;
32
+ spanId?: string;
15
33
  };
16
- type Gauge = {
17
- record(value: number, attributes?: Record<string, unknown>): void;
34
+ type LogEventMetadataInput = {
35
+ level: LogLevel;
36
+ timestamp?: number;
37
+ traceId?: string;
38
+ spanId?: string;
18
39
  };
19
- type Meter = {
20
- counter(name: string): Counter;
21
- histogram(name: string): Histogram;
22
- gauge(name: string): Gauge;
40
+ type LogEventMetadataOverrides = Omit<LogEventMetadataInput, 'level'>;
41
+ type LogEvent<EventName extends string = string, Attributes extends LogAttributes = LogAttributes> = Readonly<{
42
+ name: EventName;
43
+ data: LogEventData<Attributes>;
44
+ metadata: LogEventMetadata;
45
+ }>;
46
+ declare const LogEvent: (<Attributes extends LogAttributes = LogAttributes, EventName extends string = string>(eventName: EventName, data: LogEventData<Attributes>, eventMetadata: LogEventMetadataInput) => LogEvent<EventName, Attributes>) & {
47
+ message: <Attributes extends LogAttributes = LogAttributes, EventName extends string = string>(level: LogLevel, body: EventName, data?: Omit<LogEventData<Attributes>, "body">, eventMetadata?: LogEventMetadataOverrides) => LogEvent<EventName, Attributes>;
48
+ fatal: (msgOrObj: string | LogAttributes | Error, msgOrMetadata?: string | LogEventMetadataOverrides, eventMetadata?: LogEventMetadataOverrides) => LogEvent;
49
+ error: (msgOrObj: string | LogAttributes | Error, msgOrMetadata?: string | LogEventMetadataOverrides, eventMetadata?: LogEventMetadataOverrides) => LogEvent;
50
+ warn: (msgOrObj: string | LogAttributes | Error, msgOrMetadata?: string | LogEventMetadataOverrides, eventMetadata?: LogEventMetadataOverrides) => LogEvent;
51
+ info: (msgOrObj: string | LogAttributes | Error, msgOrMetadata?: string | LogEventMetadataOverrides, eventMetadata?: LogEventMetadataOverrides) => LogEvent;
52
+ debug: (msgOrObj: string | LogAttributes | Error, msgOrMetadata?: string | LogEventMetadataOverrides, eventMetadata?: LogEventMetadataOverrides) => LogEvent;
53
+ trace: (msgOrObj: string | LogAttributes | Error, msgOrMetadata?: string | LogEventMetadataOverrides, eventMetadata?: LogEventMetadataOverrides) => LogEvent;
54
+ silent: (msgOrObj: string | LogAttributes | Error, msgOrMetadata?: string | LogEventMetadataOverrides, eventMetadata?: LogEventMetadataOverrides) => LogEvent;
23
55
  };
56
+ type Logger = (event: LogEvent) => void;
24
57
  //#endregion
25
- //#region ../almanac/dist/tracer-DJWFmYul.d.ts
26
58
  //#region src/tracers/span.d.ts
27
- type SpanEventLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error';
28
59
  type SpanContext = {
29
60
  traceId: string;
30
61
  spanId: string;
@@ -36,8 +67,7 @@ type ActiveSpan = {
36
67
  setAttributes(attrs: Record<string, unknown>): void;
37
68
  spanContext(): SpanContext;
38
69
  addLink(link: SpanLink): void;
39
- addEvent(name: string, attributes?: Record<string, unknown>, level?: SpanEventLevel): void;
40
- recordException(error: Error | string): void;
70
+ log: Logger;
41
71
  };
42
72
  type StartSpanOptions = {
43
73
  parent?: SpanContext;
@@ -53,6 +83,23 @@ type Tracer = {
53
83
  startSpan<T>(name: string, fn: (span: ActiveSpan) => Promise<T>, options?: StartSpanOptions): Promise<T>;
54
84
  };
55
85
  //#endregion
86
+ //#region ../almanac/dist/meter-CIOX3AFP.d.ts
87
+ //#region src/meters/meter.d.ts
88
+ type Counter = {
89
+ add(value: number, attributes?: Record<string, unknown>): void;
90
+ };
91
+ type Histogram = {
92
+ record(value: number, attributes?: Record<string, unknown>): void;
93
+ };
94
+ type Gauge = {
95
+ record(value: number, attributes?: Record<string, unknown>): void;
96
+ };
97
+ type Meter = {
98
+ counter(name: string): Counter;
99
+ histogram(name: string): Histogram;
100
+ gauge(name: string): Gauge;
101
+ };
102
+ //#endregion
56
103
  //#region ../almanac/dist/index.d.ts
57
104
  type AttributeTarget = 'mainSpan' | 'currentSpan' | 'both'; //#endregion
58
105
  //#region src/meters/compositeMeter.d.ts
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@event-driven-io/emmett-expressjs",
3
- "version": "0.43.0-beta.23",
3
+ "version": "0.43.0-beta.24",
4
4
  "type": "module",
5
5
  "description": "Emmett - Event Sourcing development made simple",
6
6
  "scripts": {
@@ -48,7 +48,7 @@
48
48
  ],
49
49
  "devDependencies": {},
50
50
  "peerDependencies": {
51
- "@event-driven-io/emmett": "0.43.0-beta.23",
51
+ "@event-driven-io/emmett": "0.43.0-beta.24",
52
52
  "@types/express": "^4.17.21",
53
53
  "@types/supertest": "^7.2.0",
54
54
  "express": "^4.22.1",