@pondoknusa/log 5.1.0 → 6.0.1

package/README.md

@@ -0,0 +1,70 @@
+# @pondoknusa/log
+
+Structured logging channels — stdout, file, and stack — behind a `LogRepository` facade.
+
+Application code should emit structured logs without caring where they are written, so this
+package separates the `Log` call from the channel that records it. A `LogManager` builds channels
+from `config/log.ts`, `LogRepository` forwards leveled calls to the configured channel, and a
+`stack` channel fans one entry out to several destinations at once.
+
+Each entry is serialized as a single JSON line with a level, timestamp, and context, and sensitive
+context keys are redacted before they are written. Its only dependency is `@pondoknusa/support`
+(for that redaction), so there is no logging framework underneath.
+
+> Part of the [Pondoknusa](https://pondoknusa.dev) framework — a TypeScript-native full-stack
+> framework built on standard Web APIs. Requires **Node.js ≥ 26**.
+
+## Install
+
+```bash
+npm install @pondoknusa/log
+```
+
+## Quick start
+
+```typescript
+import { LogManager, LogRepository } from '@pondoknusa/log';
+
+const manager = new LogManager({
+  default: 'stack',
+  channels: {
+    stdout: { channel: 'stdout' },
+    file: { channel: 'file', path: 'storage/logs/pondoknusa.log' },
+    stack: { channel: 'stack', channels: ['stdout', 'file'] },
+  },
+});
+
+const log = new LogRepository(manager);
+
+log.info('order.placed', { orderId: order.id, userId: user.id });
+log.error('payment.failed', { code: 'card_declined' });
+
+// Target a single channel directly, bypassing the default
+manager.channel('file').warn('cache.miss', { key: 'dashboard' });
+```
+
+The four levels are `debug`, `info`, `warn`, and `error`, and `stack` channels may nest other
+named channels. In an application, `LogServiceProvider` builds the repository from `config/log.ts`
+(`LOG_CHANNEL` selects `stdout`, `file`, or `stack`) and you emit through the `Log` facade from
+`@pondoknusa/core`:
+
+```typescript
+import { Log } from '@pondoknusa/core';
+
+Log.info('order.placed', { orderId: order.id, userId: user.id });
+```
+
+## Related packages
+
+- [`@pondoknusa/support`](https://www.npmjs.com/package/@pondoknusa/support) — provides
+  `redactSensitive()`, used to strip secrets from log context.
+- [`@pondoknusa/core`](https://www.npmjs.com/package/@pondoknusa/core) — `LogServiceProvider`
+  wires the channel from `config/log.ts` and exposes the `Log` facade.
+
+## Documentation
+
+- [Observability guide](https://pondoknusa.dev/cookbook/observability)
+- [Package reference](https://pondoknusa.dev/reference/generated/packages/log)
+- [Source](https://git.simonharms.com/thesimonharms/pondoknusa/src/branch/main/packages/log)
+
+MIT © Pondoknusa Contributors

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pondoknusa/log",
-  "version": "5.1.0",
+  "version": "6.0.1",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -15,7 +15,7 @@
     "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "dependencies": {
-    "@pondoknusa/support": "5.1.0"
+    "@pondoknusa/support": "6.0.1"
   },
   "files": [
     "dist"