Skip to content

feat(types): add middlewares types #1161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
+55 −14
Open

feat(types): add middlewares types #1161

Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
701a479
feat(types): add middlewares types
thib3113 Dec 3, 2022
f577ca2
fix(TU): correct to match tests
thib3113 Dec 3, 2022
f4e0c79
refacto(types):
thib3113 Dec 11, 2022
9b51de9
fix(types):
thib3113 Dec 11, 2022
78f7cc4
Merge branch 'master' into add-defaults-middleware-types
thib3113 Jan 2, 2023
dc47285
refacto(types):
thib3113 Mar 19, 2023
d649e64
Merge remote-tracking branch 'moleculer/master' into add-defaults-mid…
thib3113 Nov 12, 2023
67d0ee7
remove unwanted changes
thib3113 Nov 12, 2023
0ff7493
correct merge
thib3113 Nov 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 66 additions & 14 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { EventEmitter2 } from "eventemitter2";
import type { Kleur } from "kleur";

declare namespace Moleculer {
/**
Expand Down Expand Up @@ -1342,21 +1343,24 @@ declare namespace Moleculer {
sender: string | null;
}

type packetType =
| PACKET_UNKNOWN
| PACKET_EVENT
| PACKET_DISCONNECT
| PACKET_DISCOVER
| PACKET_INFO
| PACKET_HEARTBEAT
| PACKET_REQUEST
| PACKET_PING
| PACKET_PONG
| PACKET_RESPONSE
| PACKET_GOSSIP_REQ
| PACKET_GOSSIP_RES
| PACKET_GOSSIP_HELLO;

interface Packet {
type:
| PACKET_UNKNOWN
| PACKET_EVENT
| PACKET_DISCONNECT
| PACKET_DISCOVER
| PACKET_INFO
| PACKET_HEARTBEAT
| PACKET_REQUEST
| PACKET_PING
| PACKET_PONG
| PACKET_RESPONSE
| PACKET_GOSSIP_REQ
| PACKET_GOSSIP_RES
| PACKET_GOSSIP_HELLO;
type: packetType;

target?: string;
payload: PacketPayload;
}
Expand Down Expand Up @@ -1668,6 +1672,54 @@ declare namespace Moleculer {
}
}

/**
* you can use multiple modifier with a dot
* e.g. `black.bgRed.bold`
*/
type KleurColor = keyof Kleur | string;

type ActionLoggerOptions = {
logger?: LoggerInstance;
logLevel?: LogLevels;
logParams?: boolean;
logResponse?: boolean;
logMeta?: boolean;
folder?: string | null;
extension?: string;
colors?: {
request?: KleurColor;
response?: KleurColor;
error?: KleurColor;
};
whitelist?: Array<string>;
};
type TransitLoggerOptions = {
logger?: LoggerInstance;
logLevel?: LogLevels;
logPacketData?: boolean;
folder?: string | null;
extension?: string;
colors?: {
receive?: KleurColor;
send?: KleurColor;
};
packetFilter?: Array<Packets.packetType>;
};
type CompressionOptions = {
method?: "deflate" | "deflateRaw" | "gzip";
threshold?: number | string;
};
export const Middlewares: {
Debugging: {
ActionLogger(options?: ActionLoggerOptions): Middleware;
TransitLogger(options?: TransitLoggerOptions): Middleware;
};
Transmit: {
Compression(options?: CompressionOptions): Middleware;
Encryption(password: string, algorithm: string, iv: string | Buffer): Middleware;
};
};

interface TransitRequest {
action: string;
nodeID: string;
Expand Down