alepha 0.11.4 → 0.11.5

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 (47) hide show
  1. package/api/files.d.ts +439 -1
  2. package/api/jobs.d.ts +218 -1
  3. package/api/notifications.d.ts +264 -1
  4. package/api/users.d.ts +924 -1
  5. package/batch.d.ts +588 -1
  6. package/bucket.d.ts +511 -1
  7. package/cache/redis.d.ts +40 -1
  8. package/cache.d.ts +288 -1
  9. package/command.d.ts +252 -1
  10. package/core.d.ts +1827 -1
  11. package/devtools.d.ts +370 -1
  12. package/email.d.ts +144 -1
  13. package/fake.d.ts +73 -1
  14. package/file.d.ts +528 -1
  15. package/lock/redis.d.ts +24 -1
  16. package/lock.d.ts +552 -1
  17. package/logger.d.ts +285 -1
  18. package/package.json +51 -51
  19. package/postgres.d.ts +1861 -1
  20. package/queue/redis.d.ts +29 -1
  21. package/queue.d.ts +760 -1
  22. package/react/auth.d.ts +499 -1
  23. package/react/form.d.ts +188 -1
  24. package/react/head.d.ts +120 -1
  25. package/react/i18n.d.ts +168 -1
  26. package/react.d.ts +1238 -1
  27. package/redis.d.ts +82 -1
  28. package/scheduler.d.ts +145 -1
  29. package/security.d.ts +586 -1
  30. package/server/cache.d.ts +163 -1
  31. package/server/compress.d.ts +32 -1
  32. package/server/cookies.d.ts +144 -1
  33. package/server/cors.d.ts +27 -1
  34. package/server/health.d.ts +59 -1
  35. package/server/helmet.d.ts +69 -1
  36. package/server/links.d.ts +316 -1
  37. package/server/metrics.d.ts +35 -1
  38. package/server/multipart.d.ts +42 -1
  39. package/server/proxy.d.ts +234 -1
  40. package/server/security.d.ts +87 -1
  41. package/server/static.d.ts +119 -1
  42. package/server/swagger.d.ts +148 -1
  43. package/server.d.ts +849 -1
  44. package/topic/redis.d.ts +42 -1
  45. package/topic.d.ts +819 -1
  46. package/ui.d.ts +683 -1
  47. package/vite.d.ts +186 -1
package/logger.d.ts CHANGED
@@ -1 +1,285 @@
1
- export * from '@alepha/logger';
1
+ import * as _alepha_core0 from "alepha";
2
+ import { Alepha, KIND, LogLevel, LoggerInterface, Static } from "alepha";
3
+ import { DateTime, DateTimeProvider } from "alepha/datetime";
4
+ import * as typebox0 from "typebox";
5
+ import * as dayjs0 from "dayjs";
6
+
7
+ //#region src/schemas/logEntrySchema.d.ts
8
+ declare const logEntrySchema: typebox0.TObject<{
9
+ level: typebox0.TUnsafe<"SILENT" | "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR">;
10
+ message: typebox0.TString;
11
+ service: typebox0.TString;
12
+ module: typebox0.TString;
13
+ context: typebox0.TOptional<typebox0.TString>;
14
+ app: typebox0.TOptional<typebox0.TString>;
15
+ data: typebox0.TOptional<typebox0.TAny>;
16
+ timestamp: typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>;
17
+ }>;
18
+ type LogEntry = Static<typeof logEntrySchema>;
19
+ //#endregion
20
+ //#region src/providers/LogDestinationProvider.d.ts
21
+ declare abstract class LogDestinationProvider {
22
+ abstract write(message: string, entry: LogEntry): void;
23
+ }
24
+ //#endregion
25
+ //#region src/providers/LogFormatterProvider.d.ts
26
+ declare abstract class LogFormatterProvider {
27
+ abstract format(entry: LogEntry): string;
28
+ }
29
+ //#endregion
30
+ //#region src/services/Logger.d.ts
31
+ declare class Logger implements LoggerInterface {
32
+ protected readonly alepha: Alepha;
33
+ protected readonly formatter: LogFormatterProvider;
34
+ protected readonly destination: LogDestinationProvider;
35
+ protected readonly dateTimeProvider: DateTimeProvider;
36
+ protected readonly levels: Record<string, number>;
37
+ protected readonly service: string;
38
+ protected readonly module: string;
39
+ protected readonly app?: string;
40
+ protected appLogLevel: string;
41
+ protected logLevel: LogLevel;
42
+ constructor(service: string, module: string);
43
+ get context(): string | undefined;
44
+ get level(): string;
45
+ parseLevel(level: string, app: string): LogLevel;
46
+ private matchesPattern;
47
+ asLogLevel(something: string): LogLevel;
48
+ error(message: string, data?: unknown): void;
49
+ warn(message: string, data?: unknown): void;
50
+ info(message: string, data?: unknown): void;
51
+ debug(message: string, data?: unknown): void;
52
+ trace(message: string, data?: unknown): void;
53
+ protected log(level: LogLevel, message: string, data?: unknown): void;
54
+ protected emit(entry: LogEntry, message?: string): void;
55
+ }
56
+ //#endregion
57
+ //#region src/descriptors/$logger.d.ts
58
+ /**
59
+ * Create a logger.
60
+ *
61
+ * `name` is optional, by default it will use the name of the service.
62
+ *
63
+ * @example
64
+ * ```ts
65
+ * import { $logger } from "alepha";
66
+ *
67
+ * class MyService {
68
+ * log = $logger();
69
+ *
70
+ * constructor() {
71
+ * this.log.info("Service initialized");
72
+ * // print something like '[23:45:53.326] INFO <app.MyService>: Service initialized'
73
+ * }
74
+ * }
75
+ * ```
76
+ */
77
+ declare const $logger: {
78
+ (options?: LoggerDescriptorOptions): Logger;
79
+ [KIND]: typeof Logger;
80
+ };
81
+ interface LoggerDescriptorOptions {
82
+ name?: string;
83
+ }
84
+ //#endregion
85
+ //#region src/providers/ConsoleColorProvider.d.ts
86
+ declare class ConsoleColorProvider {
87
+ static readonly COLORS: {
88
+ RESET: string;
89
+ BLACK: string;
90
+ RED: string;
91
+ GREEN: string;
92
+ ORANGE: string;
93
+ BLUE: string;
94
+ PURPLE: string;
95
+ CYAN: string;
96
+ GREY_LIGHT: string;
97
+ GREY_LIGHT_BOLD: string;
98
+ GREY_DARK: string;
99
+ GREY_DARK_BOLD: string;
100
+ WHITE: string;
101
+ WHITE_BOLD: string;
102
+ SILENT: string;
103
+ ERROR: string;
104
+ WARN: string;
105
+ INFO: string;
106
+ DEBUG: string;
107
+ TRACE: string;
108
+ };
109
+ protected readonly env: {
110
+ NO_COLOR?: string | undefined;
111
+ FORCE_COLOR?: string | undefined;
112
+ };
113
+ protected readonly alepha: Alepha;
114
+ protected enabled: boolean;
115
+ constructor();
116
+ isEnabled(): boolean;
117
+ set(color: keyof typeof ConsoleColorProvider.COLORS, text: string, reset?: string): string;
118
+ }
119
+ //#endregion
120
+ //#region src/providers/ConsoleDestinationProvider.d.ts
121
+ declare class ConsoleDestinationProvider extends LogDestinationProvider {
122
+ write(message: string): void;
123
+ }
124
+ //#endregion
125
+ //#region src/providers/JsonFormatterProvider.d.ts
126
+ declare class JsonFormatterProvider extends LogFormatterProvider {
127
+ format(entry: LogEntry): string;
128
+ protected formatJsonError(error: Error): object;
129
+ }
130
+ //#endregion
131
+ //#region src/providers/MemoryDestinationProvider.d.ts
132
+ declare class MemoryDestinationProvider extends LogDestinationProvider {
133
+ protected entries: Array<LogEntry & {
134
+ formatted: string;
135
+ }>;
136
+ readonly options: {
137
+ maxEntries: number;
138
+ };
139
+ write(formatted: string, entry: LogEntry): void;
140
+ get logs(): ({
141
+ context?: string | undefined;
142
+ app?: string | undefined;
143
+ data?: any;
144
+ level: "SILENT" | "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR";
145
+ message: string;
146
+ service: string;
147
+ module: string;
148
+ timestamp: dayjs0.Dayjs;
149
+ } & {
150
+ formatted: string;
151
+ })[];
152
+ clear(): void;
153
+ }
154
+ //#endregion
155
+ //#region src/providers/SimpleFormatterProvider.d.ts
156
+ declare class SimpleFormatterProvider extends LogFormatterProvider {
157
+ protected color: ConsoleColorProvider;
158
+ protected alepha: Alepha;
159
+ format(entry: LogEntry): string;
160
+ formatTimestamp(iso: DateTime): string;
161
+ protected pad2: (n: number) => string;
162
+ protected pad3: (n: number) => string;
163
+ /**
164
+ * Avoid to display the whole UUID in development mode
165
+ */
166
+ protected formatContext(context: string): string;
167
+ protected formatError(error: Error): string;
168
+ }
169
+ //#endregion
170
+ //#region src/index.d.ts
171
+ /**
172
+ * Minimalist logger module for Alepha.
173
+ *
174
+ * It offers a global logger interface (info, warn, ...) via the `$logger` descriptor.
175
+ *
176
+ * ```ts
177
+ * import { $logger } from "alepha/logger";
178
+ *
179
+ * class App {
180
+ * log = $logger();
181
+ * }
182
+ * ```
183
+ *
184
+ * ### Formatting and Destinations
185
+ *
186
+ * `AlephaLogger` is **extensible**, destinations and formatters can be added or replaced.
187
+ *
188
+ * Default log destinations are:
189
+ * - ConsoleDestinationProvider: logs to the console.
190
+ * - MemoryDestinationProvider: stores logs in memory for later retrieval.
191
+ *
192
+ * Default log formatters are:
193
+ * - JsonFormatterProvider: formats logs as JSON.
194
+ * - SimpleFormatterProvider: formats logs as simple text (with colors when possible).
195
+ * - RawFormatterProvider: formats logs as raw text without any formatting.
196
+ *
197
+ * ### Event Emission
198
+ *
199
+ * The logger emits 'log' events that can be listened to by external code, allowing for custom log processing and destinations.
200
+ *
201
+ * ```ts
202
+ * class CustomDestination {
203
+ * onLog = $hook({
204
+ * on: "log",
205
+ * handler: (ev) => {
206
+ * // ev.message (formatted message)
207
+ * // ev.entry (level, raw message, ...)
208
+ * }
209
+ * });
210
+ * }
211
+ * ```
212
+ *
213
+ * ### Log Level
214
+ *
215
+ * You can configure the log level and format via environment variables:
216
+ *
217
+ * - `LOG_LEVEL`: Sets the default log level for the application.
218
+ * - `LOG_FORMAT`: Sets the default log format for the application.
219
+ *
220
+ * ```bash
221
+ * LOG_LEVEL=debug LOG_FORMAT=json node src/index.ts
222
+ * ```
223
+ *
224
+ * Log level is also available in the state as `logLevel`, which can be used to dynamically change the log level at runtime.
225
+ * ```ts
226
+ * alepha.state.set("logLevel", "debug");
227
+ * ```
228
+ *
229
+ * Log level is $module aware, meaning you can set different log levels for different modules.
230
+ *
231
+ * **Module-specific configuration:**
232
+ * - `LOG_LEVEL=my.module.name:debug,info` - debug for `my.module.name` (and submodules), info for others
233
+ * - `LOG_LEVEL=alepha:trace,my.app:error,info` - trace for alepha modules, error for my.app modules, info for others
234
+ *
235
+ * **Wildcard patterns (NEW):**
236
+ * - `LOG_LEVEL=alepha.*:debug,info` - debug for all alepha submodules
237
+ * - `LOG_LEVEL=*.test:silent,*.core:trace,info` - silent for test modules, trace for core modules
238
+ *
239
+ * **Robust parsing:**
240
+ * - Empty parts are gracefully skipped: `LOG_LEVEL=",,debug,,"` works fine
241
+ * - Better error messages: "Invalid log level 'bad' for module pattern 'alepha'"
242
+ */
243
+ declare const AlephaLogger: _alepha_core0.Service<_alepha_core0.Module<{}>>;
244
+ declare const envSchema: _alepha_core0.TObject<{
245
+ /**
246
+ * Default log level for the application.
247
+ *
248
+ * Default by environment:
249
+ * - dev = info
250
+ * - prod = info
251
+ * - test = error
252
+ *
253
+ * Levels are: "trace" | "debug" | "info" | "warn" | "error" | "silent"
254
+ *
255
+ * Level can be set for a specific module:
256
+ *
257
+ * @example
258
+ * LOG_LEVEL=my.module.name:debug,info # Set debug level for my.module.name and info for all other modules
259
+ * LOG_LEVEL=alepha:trace, info # Set trace level for all alepha modules and info for all other modules
260
+ */
261
+ LOG_LEVEL: _alepha_core0.TOptional<_alepha_core0.TString>;
262
+ /**
263
+ * Built-in log formats.
264
+ * - "json" - JSON format, useful for structured logging and log aggregation. {@link JsonFormatterProvider}
265
+ * - "text" - Simple text format, human-readable, with colors. {@link SimpleFormatterProvider}
266
+ * - "raw" - Raw format, no formatting, just the message. {@link RawFormatterProvider}
267
+ */
268
+ LOG_FORMAT: _alepha_core0.TOptional<_alepha_core0.TUnsafe<"json" | "text" | "raw">>;
269
+ }>;
270
+ declare module "alepha" {
271
+ interface Env extends Partial<Static<typeof envSchema>> {}
272
+ interface State {
273
+ logLevel?: string;
274
+ }
275
+ interface Hooks {
276
+ log: {
277
+ message?: string;
278
+ entry: LogEntry;
279
+ };
280
+ }
281
+ }
282
+ //# sourceMappingURL=index.d.ts.map
283
+ //#endregion
284
+ export { $logger, AlephaLogger, ConsoleColorProvider, ConsoleDestinationProvider, JsonFormatterProvider, LogDestinationProvider, LogEntry, LogFormatterProvider, Logger, LoggerDescriptorOptions, MemoryDestinationProvider, SimpleFormatterProvider, logEntrySchema };
285
+ //# sourceMappingURL=index.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "alepha",
3
- "version": "0.11.4",
3
+ "version": "0.11.5",
4
4
  "type": "module",
5
5
  "engines": {
6
6
  "node": ">=22.0.0"
@@ -15,56 +15,56 @@
15
15
  "main": "./core.js",
16
16
  "types": "./core.d.ts",
17
17
  "dependencies": {
18
- "@alepha/api-files": "0.11.4",
19
- "@alepha/api-jobs": "0.11.4",
20
- "@alepha/api-notifications": "0.11.4",
21
- "@alepha/api-users": "0.11.4",
22
- "@alepha/api-verifications": "0.11.4",
23
- "@alepha/batch": "0.11.4",
24
- "@alepha/bucket": "0.11.4",
25
- "@alepha/cache": "0.11.4",
26
- "@alepha/cache-redis": "0.11.4",
27
- "@alepha/command": "0.11.4",
28
- "@alepha/core": "0.11.4",
29
- "@alepha/datetime": "0.11.4",
30
- "@alepha/devtools": "0.11.4",
31
- "@alepha/email": "0.11.4",
32
- "@alepha/fake": "0.11.4",
33
- "@alepha/file": "0.11.4",
34
- "@alepha/lock": "0.11.4",
35
- "@alepha/lock-redis": "0.11.4",
36
- "@alepha/logger": "0.11.4",
37
- "@alepha/postgres": "0.11.4",
38
- "@alepha/queue": "0.11.4",
39
- "@alepha/queue-redis": "0.11.4",
40
- "@alepha/react": "0.11.4",
41
- "@alepha/react-auth": "0.11.4",
42
- "@alepha/react-form": "0.11.4",
43
- "@alepha/react-head": "0.11.4",
44
- "@alepha/react-i18n": "0.11.4",
45
- "@alepha/redis": "0.11.4",
46
- "@alepha/retry": "0.11.4",
47
- "@alepha/router": "0.11.4",
48
- "@alepha/scheduler": "0.11.4",
49
- "@alepha/security": "0.11.4",
50
- "@alepha/server": "0.11.4",
51
- "@alepha/server-cache": "0.11.4",
52
- "@alepha/server-compress": "0.11.4",
53
- "@alepha/server-cookies": "0.11.4",
54
- "@alepha/server-cors": "0.11.4",
55
- "@alepha/server-health": "0.11.4",
56
- "@alepha/server-helmet": "0.11.4",
57
- "@alepha/server-links": "0.11.4",
58
- "@alepha/server-metrics": "0.11.4",
59
- "@alepha/server-multipart": "0.11.4",
60
- "@alepha/server-proxy": "0.11.4",
61
- "@alepha/server-security": "0.11.4",
62
- "@alepha/server-static": "0.11.4",
63
- "@alepha/server-swagger": "0.11.4",
64
- "@alepha/topic": "0.11.4",
65
- "@alepha/topic-redis": "0.11.4",
66
- "@alepha/ui": "0.11.4",
67
- "@alepha/vite": "0.11.4",
18
+ "@alepha/api-files": "0.11.5",
19
+ "@alepha/api-jobs": "0.11.5",
20
+ "@alepha/api-notifications": "0.11.5",
21
+ "@alepha/api-users": "0.11.5",
22
+ "@alepha/api-verifications": "0.11.5",
23
+ "@alepha/batch": "0.11.5",
24
+ "@alepha/bucket": "0.11.5",
25
+ "@alepha/cache": "0.11.5",
26
+ "@alepha/cache-redis": "0.11.5",
27
+ "@alepha/command": "0.11.5",
28
+ "@alepha/core": "0.11.5",
29
+ "@alepha/datetime": "0.11.5",
30
+ "@alepha/devtools": "0.11.5",
31
+ "@alepha/email": "0.11.5",
32
+ "@alepha/fake": "0.11.5",
33
+ "@alepha/file": "0.11.5",
34
+ "@alepha/lock": "0.11.5",
35
+ "@alepha/lock-redis": "0.11.5",
36
+ "@alepha/logger": "0.11.5",
37
+ "@alepha/postgres": "0.11.5",
38
+ "@alepha/queue": "0.11.5",
39
+ "@alepha/queue-redis": "0.11.5",
40
+ "@alepha/react": "0.11.5",
41
+ "@alepha/react-auth": "0.11.5",
42
+ "@alepha/react-form": "0.11.5",
43
+ "@alepha/react-head": "0.11.5",
44
+ "@alepha/react-i18n": "0.11.5",
45
+ "@alepha/redis": "0.11.5",
46
+ "@alepha/retry": "0.11.5",
47
+ "@alepha/router": "0.11.5",
48
+ "@alepha/scheduler": "0.11.5",
49
+ "@alepha/security": "0.11.5",
50
+ "@alepha/server": "0.11.5",
51
+ "@alepha/server-cache": "0.11.5",
52
+ "@alepha/server-compress": "0.11.5",
53
+ "@alepha/server-cookies": "0.11.5",
54
+ "@alepha/server-cors": "0.11.5",
55
+ "@alepha/server-health": "0.11.5",
56
+ "@alepha/server-helmet": "0.11.5",
57
+ "@alepha/server-links": "0.11.5",
58
+ "@alepha/server-metrics": "0.11.5",
59
+ "@alepha/server-multipart": "0.11.5",
60
+ "@alepha/server-proxy": "0.11.5",
61
+ "@alepha/server-security": "0.11.5",
62
+ "@alepha/server-static": "0.11.5",
63
+ "@alepha/server-swagger": "0.11.5",
64
+ "@alepha/topic": "0.11.5",
65
+ "@alepha/topic-redis": "0.11.5",
66
+ "@alepha/ui": "0.11.5",
67
+ "@alepha/vite": "0.11.5",
68
68
  "react": "^19.2.0",
69
69
  "react-dom": "^19.2.0"
70
70
  },