@glassops/scribe 1.0.0

package/LICENSE

@@ -0,0 +1,191 @@
+# Apache License
+
+Version 2.0, January 2004
+<http://www.apache.org/licenses/>
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+        Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+        stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+        that You distribute, all copyright, patent, trademark, and
+        attribution notices from the Source form of the Work,
+        excluding those notices that do not pertain to any part of
+        the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+        distribution, then any Derivative Works that You distribute must
+        include a readable copy of the attribution notices contained
+        within such NOTICE file, excluding those notices that do not
+        pertain to any part of the Derivative Works, in at least one
+        of the following places: within a NOTICE text file distributed
+        as part of the Derivative Works; within the Source form or
+        documentation, if provided along with the Derivative Works; or,
+        within a display generated by the Derivative Works, if and
+        wherever such third-party notices normally appear. The contents
+        of the NOTICE file are for informational purposes only and
+        do not modify the License. You may add Your own attribution
+        notices within Derivative Works that You distribute, alongside
+        or as an addendum to the NOTICE text from the Work, provided
+        that such additional attribution notices cannot be construed
+        as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright [2026] [GlassOps Limited]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+<http://www.apache.org/licenses/LICENSE-2.0>
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,243 @@
+# Scribe
+
+> `@glassops/scribe`
+
+A deterministic, multi‑tenant logging subsystem designed for regulated environments, contributor safety, and zero‑ambiguity operational behavior. Scribe provides structured log streams, deep redaction, scoped metadata, and predictable directory grammars without leaking runtime state or relying on global configuration.
+
+Scribe is the foundation for all logging across GlassOps services.
+
+## Core capabilities
+
+### Deterministic directory grammar
+
+Log directories are derived from the `LoggerScope`:
+
+- Service mode: `<target>/<service>/<tenant>`
+- Non-service mode: `<target>/<tenant>/<environment>`
+
+This ensures production, staging, and development never collide, and that multi‑tenant logs remain strictly partitioned.
+
+### Structured, operationally meaningful logs
+
+- JSON‑structured entries with timestamps.
+- Daily‑rotated files with configurable retention.
+- Semantic log levels (critical, change, http, etc.) mapped to dedicated transports.
+- Request‑scoped metadata (tenant, service, environment, user, correlationId, requestId).
+
+### Deep, case‑insensitive redaction
+
+Sensitive keys are removed at any depth, regardless of casing:
+
+- password, Password, PASSWORD.
+- authorization, Authorization, etc.
+
+Circular references become "[Circular]". Buffers become "[Binary]".
+
+### Transport‑agnostic architecture
+
+File transports are enabled by default, but Scribe supports:
+
+- Console‑only mode.
+- Cloud‑only mode.
+- Hybrid mode.
+
+Using:
+
+- `disableFileTransports`
+- `extraTransports`
+
+### Pure, re‑entrant API
+
+No global state, no shared mutable configuration, no hidden defaults. Every logger instance is fully deterministic and scoped.
+
+## Installation
+
+```sh
+npm install @glassops/scribe
+```
+
+## Mental model
+
+Scribe is built around three principles:
+
+- Identity is explicit — every log entry carries a complete scope describing tenant, environment, service, and correlation identifiers.
+- Streams are semantic — incidents, changes, HTTP traffic, and application logs are treated as distinct operational categories.
+- Safety is mandatory — redaction, sanitization, and directory grammar are enforced before logs reach any transport.
+
+## Directory structure
+
+Scribe derives the log directory from the LoggerScope:
+
+With service: `<target>/<service>/<tenant>`
+Without service: `<target>/<tenant>/<environment>`
+
+All segments are sanitized to prevent traversal or invalid characters.
+
+## Usage
+
+### Creating a directory
+
+```ts
+import { createDirectory } from "@glassops/scribe";
+
+const directory = createDirectory("/var/logs", {
+  tenant: "acme",
+  environment: "production",
+  service: "billing",
+});
+
+
+Creating a logger
+import { createLogger } from "@glassops/scribe";
+
+const logger = createLogger(directory, {
+  tenant: "acme",
+  environment: "production",
+  service: "billing",
+  correlationId: "abc123",
+}, {
+  level: "info",
+  requestLog: "requests-%DATE%.log",
+  appLog: "app-%DATE%.log",
+  incidentLog: "incident-%DATE%.log",
+  changeLog: "change-%DATE%.log",
+  logToConsole: true,
+  sensitiveKeys: ["password", "token"],
+});
+
+
+
+Logging methods
+Each method accepts a message and optional context. Context is deeply redacted before writing.
+- logError(error, context?)
+- logWarn(message, context?)
+- logInfo(message, context?)
+- logDebug(message, context?)
+- logIncident(message, context?)
+- logChange(message, context?)
+Example:
+logger.logInfo("User updated profile", {
+  userId: "123",
+  password: "secret", // redacted
+});
+```
+
+## HTTP logging (Morgan integration)
+
+```ts
+app.use(morgan("combined", { stream: logger.createLoggerStream() }));
+```
+
+ANSI sequences are stripped before writing, ensuring clean machine‑readable logs.
+
+## Redaction behavior
+
+Scribe removes sensitive keys at any depth:
+
+```ts
+{
+  password: "[REDACTED]",
+  nested: {
+    token: "[REDACTED]"
+  }
+}
+```
+
+- Case‑insensitive matching
+- Circular references → "[Circular]"
+- Buffers → "[Binary]"
+
+## Scoping
+
+You can derive a new logger with additional metadata:
+const userLogger = logger.scope({ user: "steven" });
+userLogger.logInfo("User action");
+
+This produces a new logger instance with merged scope.
+
+## Transport configuration
+
+Scribe supports file‑based, console‑only, cloud‑only, and hybrid modes.
+
+```ts
+interface LoggerOptions {
+  level: LogLevel;
+  requestLog: string;
+  appLog: string;
+  changeLog?: string;
+  incidentLog?: string;
+  logToConsole?: boolean;
+  sensitiveKeys?: string[];
+  retention?: string;
+
+  disableFileTransports?: boolean;
+  extraTransports?: Transport[];
+}
+```
+
+## Log levels
+
+- `critical`
+- `error`
+- `warn`
+- `info`
+- `http`
+- `change`
+- `debug`
+
+## Build and publish
+
+Scribe uses a strict file whitelist and a deterministic build pipeline.
+
+## Scripts
+
+```json
+{
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "npm run clean && tsc -p tsconfig.json",
+    "prepack": "npm run build"
+  }
+}
+```
+
+Prepack ensures `dist/` is always built before:
+
+- `npm publish`
+- `npm publish --dry-run`
+- `npm pack`
+
+Files included in the package
+
+```json
+{
+  "files": ["dist", "README.md", "LICENSE"]
+}
+```
+
+This guarantees only compiled output and documentation are published.
+
+## Design rationale
+
+- Directory grammar prevents cross‑environment and cross‑tenant collisions.
+- Semantic log levels allow operational tooling to treat incidents, changes, and HTTP traffic as distinct streams.
+- Deep, case‑insensitive redaction prevents credential leakage.
+- Pure, re‑entrant API ensures deterministic behavior across multi‑tenant and multi‑service deployments.
+- Daily rotation keeps log files predictable for ingestion pipelines.
+- Transport‑agnostic design supports file, console, cloud, and hybrid logging.
+
+## License
+
+Copyright [2026] [GlassOps Limited]
+
+Licensed under the Apache License, Version 2.0 (the ["License"](LICENSE));
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+<http://www.apache.org/licenses/LICENSE-2.0>
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/dist/create-directory.d.ts

@@ -0,0 +1,19 @@
+/** -------------------------------------------------------------------------
+|* @name            create-directory.ts
+|* @description     Creates a deterministic log directory based on the
+|*                  provided LoggerScope. This is the only step containing
+|*                  side-effects in Scribe's initialization flow.
+\* -------------------------------------------------------------------------- */
+import type { LoggerScope } from "./types.js";
+/**
+ * Resolves and creates the directory where log files will be written.
+ *
+ * - `target`: Must be a valid base directory.
+ * - `tenant` and `environment`: Required for deterministic partitioning.
+ * - `service` (if provided): Switches the grammar to service‑scoped logs.
+ *
+ * The directory is created recursively and returned as an absolute path.
+ * Any filesystem failure is surfaced as a descriptive error.
+ */
+export declare const createDirectory: (target: string, scope: LoggerScope) => string;
+//# sourceMappingURL=create-directory.d.ts.map

package/dist/create-directory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-directory.d.ts","sourceRoot":"","sources":["../src/create-directory.ts"],"names":[],"mappings":"AAAA;;;;;gFAKgF;AAWhF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAM9C;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,OAAO,WAAW,WAoBjE,CAAC"}

package/dist/create-directory.js

@@ -0,0 +1,44 @@
+/** -------------------------------------------------------------------------
+|* @name            create-directory.ts
+|* @description     Creates a deterministic log directory based on the
+|*                  provided LoggerScope. This is the only step containing
+|*                  side-effects in Scribe's initialization flow.
+\* -------------------------------------------------------------------------- */
+/* --------------------------------------------------------------------------
+|* NPM Dependencies
+\* -------------------------------------------------------------------------- */
+import fs from "fs";
+import path from "path";
+import { safe } from "./utilities.js";
+/* -------------------------------------------------------------------------- *\
+|* Create Directory
+\* -------------------------------------------------------------------------- */
+/**
+ * Resolves and creates the directory where log files will be written.
+ *
+ * - `target`: Must be a valid base directory.
+ * - `tenant` and `environment`: Required for deterministic partitioning.
+ * - `service` (if provided): Switches the grammar to service‑scoped logs.
+ *
+ * The directory is created recursively and returned as an absolute path.
+ * Any filesystem failure is surfaced as a descriptive error.
+ */
+export const createDirectory = (target, scope) => {
+    if (!target)
+        throw new Error("Invalid log directory");
+    const { tenant, environment, service } = scope;
+    if (!tenant || !environment) {
+        throw new Error("LoggerScope must include tenant and environment");
+    }
+    const directory = service
+        ? path.join(target, safe(service), safe(tenant))
+        : path.join(target, safe(tenant), safe(environment));
+    try {
+        fs.mkdirSync(directory, { recursive: true });
+    }
+    catch {
+        throw new Error(`Failed to create log directory: ${directory}`);
+    }
+    return directory;
+};
+//# sourceMappingURL=create-directory.js.map

package/dist/create-directory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-directory.js","sourceRoot":"","sources":["../src/create-directory.ts"],"names":[],"mappings":"AAAA;;;;;gFAKgF;AAEhF;;gFAEgF;AAChF,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAMxB,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAEtC;;gFAEgF;AAChF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,KAAkB,EAAE,EAAE;IAClE,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAEtD,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;IAE/C,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,SAAS,GAAG,OAAO;QACrB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAEzD,IAAI,CAAC;QACD,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC;IAAC,MAAM,CAAC;QACL,MAAM,IAAI,KAAK,CAAC,mCAAmC,SAAS,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC"}

package/dist/create-logger.d.ts

@@ -0,0 +1,30 @@
+import winston from "winston";
+import type { LoggerOptions, LoggerScope } from "./types.js";
+/**
+ * Creates a fully configured Winston logger with:
+ *
+ * - Daily-rotated file transports for request, app, incident, and change logs
+ * - Deep redaction of sensitive fields
+ * - Structured JSON output with timestamps
+ * - Optional colorized console output for development
+ * - Request-scoped metadata (tenant, service, environment, user,
+ *   `correlationId`)
+ *
+ * The returned object exposes high-level semantic logging methods (`logInfo`,
+ * `logError`, `logIncident`, etc.), a Morgan-compatible HTTP stream, and a
+ * `scope()` method for deriving new loggers with extended metadata.
+ */
+export declare const createLogger: (directory: string, scope: LoggerScope, options: LoggerOptions) => {
+    logError: (error: string | Error, context?: Record<string, unknown>) => void;
+    logWarn: (message: string, context?: Record<string, unknown>) => void;
+    logInfo: (message: string, context?: Record<string, unknown>) => void;
+    logDebug: (message: string, context?: Record<string, unknown>) => void;
+    logIncident: (message: string, context?: Record<string, unknown>) => void;
+    logChange: (message: string, context?: Record<string, unknown>) => void;
+    createLoggerStream: () => {
+        write: (message: string) => void;
+    };
+    scope: (partial: Partial<LoggerScope>) => /*elided*/ any;
+    logger: winston.Logger;
+};
+//# sourceMappingURL=create-logger.d.ts.map

package/dist/create-logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-logger.d.ts","sourceRoot":"","sources":["../src/create-logger.ts"],"names":[],"mappings":"AAUA,OAAO,OAAO,MAAM,SAAS,CAAC;AAO9B,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAY,MAAM,YAAY,CAAC;AAmCvE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,GACrB,WAAW,MAAM,EACjB,OAAO,WAAW,EAClB,SAAS,aAAa;sBAkJP,MAAM,GAAG,KAAK,YACZ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;uBAGjB,MAAM,YAAW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;uBAGxC,MAAM,YAAW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;wBAGvC,MAAM,YAAW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;2BAGrC,MAAM,YAAW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;yBAG1C,MAAM,YAAW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;yBAIxC,MAAM;;qBAaV,OAAO,CAAC,WAAW,CAAC;;CAK5C,CAAC"}

package/dist/create-logger.js

@@ -0,0 +1,160 @@
+import DailyRotateFile from "winston-daily-rotate-file";
+import winston from "winston";
+const { combine, timestamp, errors, colorize, json } = winston.format;
+import { redact, stripAnsi } from "./utilities.js";
+/* -------------------------------------------------------------------------- *\
+|* Initialize Variables
+\* -------------------------------------------------------------------------- */
+/**
+ * Defines Scribe's semantic log levels and their associated console colors.
+ * These levels are intentionally non-hierarchical: each level represents a
+ * distinct operational stream rather than a severity threshold. This allows
+ * transports to filter by exact level without relying on numeric ordering.
+ */
+const customLevels = Object.freeze({
+    critical: 0,
+    error: 1,
+    warn: 2,
+    info: 3,
+    http: 4,
+    change: 5,
+    debug: 6,
+});
+const customColors = Object.freeze({
+    critical: "magenta",
+    error: "red",
+    warn: "yellow",
+    info: "green",
+    http: "blue",
+    change: "cyan",
+    debug: "gray",
+});
+winston.addColors(customColors);
+/* -------------------------------------------------------------------------- *\
+|* Create Logger
+\* -------------------------------------------------------------------------- */
+/**
+ * Creates a fully configured Winston logger with:
+ *
+ * - Daily-rotated file transports for request, app, incident, and change logs
+ * - Deep redaction of sensitive fields
+ * - Structured JSON output with timestamps
+ * - Optional colorized console output for development
+ * - Request-scoped metadata (tenant, service, environment, user,
+ *   `correlationId`)
+ *
+ * The returned object exposes high-level semantic logging methods (`logInfo`,
+ * `logError`, `logIncident`, etc.), a Morgan-compatible HTTP stream, and a
+ * `scope()` method for deriving new loggers with extended metadata.
+ */
+export const createLogger = (directory, scope, options) => {
+    const { tenant, service, environment, user, correlationId, requestId } = scope;
+    const sensitiveKeys = [
+        "password",
+        "token",
+        "secret",
+        "authorization",
+        ...(options.sensitiveKeys ?? []),
+    ];
+    const retention = options.retention ?? "14d";
+    const transports = [];
+    if (!options.disableFileTransports) {
+        transports.push(new DailyRotateFile({
+            dirname: directory,
+            filename: options.requestLog,
+            datePattern: "YYYY-MM-DD",
+            level: "http",
+            zippedArchive: true,
+            maxFiles: retention,
+            format: combine(winston.format((log) => log.level === "http" ? log : false)(), timestamp(), json()),
+        }));
+        transports.push(new DailyRotateFile({
+            dirname: directory,
+            filename: options.appLog,
+            datePattern: "YYYY-MM-DD",
+            level: options.level,
+            zippedArchive: true,
+            maxFiles: retention,
+            format: combine(errors({ stack: environment !== "production" }), timestamp(), json()),
+        }));
+        if (options.incidentLog) {
+            transports.push(new DailyRotateFile({
+                dirname: directory,
+                filename: options.incidentLog,
+                datePattern: "YYYY-MM-DD",
+                level: "critical",
+                zippedArchive: true,
+                maxFiles: retention,
+                format: combine(winston.format((log) => log.level === "critical" ? log : false)(), timestamp(), json()),
+            }));
+        }
+        if (options.changeLog) {
+            transports.push(new DailyRotateFile({
+                dirname: directory,
+                filename: options.changeLog,
+                datePattern: "YYYY-MM-DD",
+                level: "change",
+                zippedArchive: true,
+                maxFiles: retention,
+                format: combine(winston.format((log) => log.level === "change" ? log : false)(), timestamp(), json()),
+            }));
+        }
+    }
+    if (options.logToConsole) {
+        transports.push(new winston.transports.Console({
+            format: combine(colorize(), timestamp()),
+        }));
+    }
+    if (options.extraTransports?.length) {
+        transports.push(...options.extraTransports);
+    }
+    const loggerInstance = winston.createLogger({
+        levels: customLevels,
+        level: options.level,
+        transports,
+        defaultMeta: {
+            tenant,
+            service,
+            environment,
+            user,
+            correlationId,
+            requestId,
+            pid: process.pid,
+        },
+    });
+    const log = (level, message, context = {}) => {
+        const safeContext = redact(context, sensitiveKeys);
+        const includeStack = environment !== "production";
+        loggerInstance.log(level, message instanceof Error
+            ? {
+                message: message.message,
+                ...(includeStack && { stack: message.stack }),
+                ...safeContext,
+            }
+            : { message, ...safeContext });
+    };
+    return {
+        logError: (error, context = {}) => log("error", error, context),
+        logWarn: (message, context = {}) => log("warn", message, context),
+        logInfo: (message, context = {}) => log("info", message, context),
+        logDebug: (message, context = {}) => log("debug", message, context),
+        logIncident: (message, context = {}) => log("critical", message, { category: "incident", ...context }),
+        logChange: (message, context = {}) => log("change", message, { category: "change", ...context }),
+        createLoggerStream: () => ({
+            write: (message) => {
+                const clean = stripAnsi(message).replace(/\n$/, "");
+                log("http", clean, {
+                    source: "morgan",
+                    service,
+                    tenant,
+                    environment,
+                    correlationId,
+                    requestId,
+                });
+            },
+        }),
+        scope: (partial) => createLogger(directory, { ...scope, ...partial }, options),
+        logger: loggerInstance,
+    };
+};
+//# sourceMappingURL=create-logger.js.map

package/dist/create-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-logger.js","sourceRoot":"","sources":["../src/create-logger.ts"],"names":[],"mappings":"AASA,OAAO,eAAe,MAAM,2BAA2B,CAAC;AACxD,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;AAMtE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;gFAEgF;AAChF;;;;;GAKG;AACH,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/B,QAAQ,EAAE,CAAC;IACX,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;IACP,MAAM,EAAE,CAAC;IACT,KAAK,EAAE,CAAC;CACX,CAAC,CAAC;AACH,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/B,QAAQ,EAAE,SAAS;IACnB,KAAK,EAAE,KAAK;IACZ,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE,OAAO;IACb,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,MAAM;IACd,KAAK,EAAE,MAAM;CAChB,CAAC,CAAC;AACH,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;AAEhC;;gFAEgF;AAChF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CACxB,SAAiB,EACjB,KAAkB,EAClB,OAAsB,EACxB,EAAE;IACA,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE,SAAS,EAAE,GAClE,KAAK,CAAC;IAEV,MAAM,aAAa,GAAG;QAClB,UAAU;QACV,OAAO;QACP,QAAQ;QACR,eAAe;QACf,GAAG,CAAC,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC;KACnC,CAAC;IAEF,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,KAAK,CAAC;IAE7C,MAAM,UAAU,GAAgB,EAAE,CAAC;IAEnC,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACjC,UAAU,CAAC,IAAI,CACX,IAAI,eAAe,CAAC;YAChB,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,OAAO,CAAC,UAAU;YAC5B,WAAW,EAAE,YAAY;YACzB,KAAK,EAAE,MAAM;YACb,aAAa,EAAE,IAAI;YACnB,QAAQ,EAAE,SAAS;YACnB,MAAM,EAAE,OAAO,CACX,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CACnB,GAAG,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CACrC,EAAE,EACH,SAAS,EAAE,EACX,IAAI,EAAE,CACT;SACJ,CAAC,CACL,CAAC;QAEF,UAAU,CAAC,IAAI,CACX,IAAI,eAAe,CAAC;YAChB,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,OAAO,CAAC,MAAM;YACxB,WAAW,EAAE,YAAY;YACzB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,aAAa,EAAE,IAAI;YACnB,QAAQ,EAAE,SAAS;YACnB,MAAM,EAAE,OAAO,CACX,MAAM,CAAC,EAAE,KAAK,EAAE,WAAW,KAAK,YAAY,EAAE,CAAC,EAC/C,SAAS,EAAE,EACX,IAAI,EAAE,CACT;SACJ,CAAC,CACL,CAAC;QAEF,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACtB,UAAU,CAAC,IAAI,CACX,IAAI,eAAe,CAAC;gBAChB,OAAO,EAAE,SAAS;gBAClB,QAAQ,EAAE,OAAO,CAAC,WAAW;gBAC7B,WAAW,EAAE,YAAY;gBACzB,KAAK,EAAE,UAAU;gBACjB,aAAa,EAAE,IAAI;gBACnB,QAAQ,EAAE,SAAS;gBACnB,MAAM,EAAE,OAAO,CACX,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CACnB,GAAG,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CACzC,EAAE,EACH,SAAS,EAAE,EACX,IAAI,EAAE,CACT;aACJ,CAAC,CACL,CAAC;QACN,CAAC;QAED,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACpB,UAAU,CAAC,IAAI,CACX,IAAI,eAAe,CAAC;gBAChB,OAAO,EAAE,SAAS;gBAClB,QAAQ,EAAE,OAAO,CAAC,SAAS;gBAC3B,WAAW,EAAE,YAAY;gBACzB,KAAK,EAAE,QAAQ;gBACf,aAAa,EAAE,IAAI;gBACnB,QAAQ,EAAE,SAAS;gBACnB,MAAM,EAAE,OAAO,CACX,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CACnB,GAAG,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CACvC,EAAE,EACH,SAAS,EAAE,EACX,IAAI,EAAE,CACT;aACJ,CAAC,CACL,CAAC;QACN,CAAC;IACL,CAAC;IAED,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACvB,UAAU,CAAC,IAAI,CACX,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;YAC3B,MAAM,EAAE,OAAO,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,CAAC;SAC3C,CAAC,CACL,CAAC;IACN,CAAC;IAED,IAAI,OAAO,CAAC,eAAe,EAAE,MAAM,EAAE,CAAC;QAClC,UAAU,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;QACxC,MAAM,EAAE,YAAY;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,UAAU;QACV,WAAW,EAAE;YACT,MAAM;YACN,OAAO;YACP,WAAW;YACX,IAAI;YACJ,aAAa;YACb,SAAS;YACT,GAAG,EAAE,OAAO,CAAC,GAAG;SACnB;KACJ,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,CACR,KAAe,EACf,OAAgB,EAChB,UAAmC,EAAE,EACvC,EAAE;QACA,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,EAAE,aAAa,CAGhD,CAAC;QAEF,MAAM,YAAY,GAAG,WAAW,KAAK,YAAY,CAAC;QAElD,cAAc,CAAC,GAAG,CACd,KAAK,EACL,OAAO,YAAY,KAAK;YACpB,CAAC,CAAC;gBACI,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,GAAG,CAAC,YAAY,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;gBAC7C,GAAG,WAAW;aACjB;YACH,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,CACpC,CAAC;IACN,CAAC,CAAC;IAEF,OAAO;QACH,QAAQ,EAAE,CACN,KAAqB,EACrB,UAAmC,EAAE,EACvC,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC;QAEjC,OAAO,EAAE,CAAC,OAAe,EAAE,UAAmC,EAAE,EAAE,EAAE,CAChE,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;QAEjC,OAAO,EAAE,CAAC,OAAe,EAAE,UAAmC,EAAE,EAAE,EAAE,CAChE,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;QAEjC,QAAQ,EAAE,CAAC,OAAe,EAAE,UAAmC,EAAE,EAAE,EAAE,CACjE,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC;QAElC,WAAW,EAAE,CAAC,OAAe,EAAE,UAAmC,EAAE,EAAE,EAAE,CACpE,GAAG,CAAC,UAAU,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,CAAC;QAElE,SAAS,EAAE,CAAC,OAAe,EAAE,UAAmC,EAAE,EAAE,EAAE,CAClE,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;QAE9D,kBAAkB,EAAE,GAAG,EAAE,CAAC,CAAC;YACvB,KAAK,EAAE,CAAC,OAAe,EAAE,EAAE;gBACvB,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBACpD,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE;oBACf,MAAM,EAAE,QAAQ;oBAChB,OAAO;oBACP,MAAM;oBACN,WAAW;oBACX,aAAa;oBACb,SAAS;iBACZ,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;QAEF,KAAK,EAAE,CAAC,OAA6B,EAAE,EAAE,CACrC,YAAY,CAAC,SAAS,EAAE,EAAE,GAAG,KAAK,EAAE,GAAG,OAAO,EAAE,EAAE,OAAO,CAAC;QAE9D,MAAM,EAAE,cAAc;KACzB,CAAC;AACN,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+/** ------------------------------------------------------------------------
+|* @package         @glassops/scribe
+|* @version         1.0.0
+|* @see             https://www.jane-io.com
+|* @license         Apache-2.0
+|* -------------------------------------------------------------------------
+|* @name            index.ts
+|* @description     Public entrypoint for Scribe. This file defines the
+|*                  stable, intentional surface area exposed to consumers.
+|*                  All other modules remain internal and are not part of the
+|*                  compatibility contract.
+/* -------------------------------------------------------------------------- */
+/**
+ * Public authoring contracts for configuring logger scope and behavior.
+ */
+export type { LoggerScope, LoggerOptions, LogLevel } from "./types.js";
+/**
+ * Pure, deterministic entrypoints for initializing the log directory and
+ * constructing a scoped logger instance. These are the primary runtime APIs.
+ */
+export { createDirectory } from "./create-directory.js";
+export { createLogger } from "./create-logger.js";
+/**
+ * Internal helpers exposed for advanced use cases. These functions are pure
+ * and side‑effect‑free, but not required for normal operation.
+ */
+export { redact, safe, stripAnsi } from "./utilities.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;gFAWgF;AAKhF;;GAEG;AACH,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAKvE;;;GAGG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAKlD;;;GAGG;AACH,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,30 @@
+/** ------------------------------------------------------------------------
+|* @package         @glassops/scribe
+|* @version         1.0.0
+|* @see             https://www.jane-io.com
+|* @license         Apache-2.0
+|* -------------------------------------------------------------------------
+|* @name            index.ts
+|* @description     Public entrypoint for Scribe. This file defines the
+|*                  stable, intentional surface area exposed to consumers.
+|*                  All other modules remain internal and are not part of the
+|*                  compatibility contract.
+/* -------------------------------------------------------------------------- */
+/* --------------------------------------------------------------------------
+|* Factories
+\* -------------------------------------------------------------------------- */
+/**
+ * Pure, deterministic entrypoints for initializing the log directory and
+ * constructing a scoped logger instance. These are the primary runtime APIs.
+ */
+export { createDirectory } from "./create-directory.js";
+export { createLogger } from "./create-logger.js";
+/* --------------------------------------------------------------------------
+|* Utilities
+\* -------------------------------------------------------------------------- */
+/**
+ * Internal helpers exposed for advanced use cases. These functions are pure
+ * and side‑effect‑free, but not required for normal operation.
+ */
+export { redact, safe, stripAnsi } from "./utilities.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;gFAWgF;AAUhF;;gFAEgF;AAChF;;;GAGG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;gFAEgF;AAChF;;;GAGG;AACH,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,66 @@
+/** -------------------------------------------------------------------------
+|* @name            types.ts
+|* @description     Public authoring contracts for Scribe. These types define
+|*                  the stable, contributor‑safe surface for configuring log
+|*                  scopes and logger behavior.
+/* --------------------------------------------------------------------------
+|* NPM Dependencies
+\* -------------------------------------------------------------------------- */
+import type Transport from "winston-transport";
+/**
+ * Describes the identity of the log stream. Every log entry is tagged with
+ * these fields to ensure deterministic partitioning across tenants,
+ * environments, and optional services. Additional fields (user, correlationId,
+ * requestId) provide request‑level traceability without affecting directory
+ * grammar.
+ */
+export interface LoggerScope {
+    tenant: string;
+    environment: string;
+    service?: string;
+    user?: string;
+    correlationId?: string;
+    requestId?: string;
+}
+/**
+ * Configures the behavior of a logger instance. All fields are explicit and
+ * stable. No defaults are implied beyond what is stated here.
+ *
+ * - `level` sets the minimum application log level.
+ * - `requestLog` and `appLog` define the filenames for daily‑rotated logs.
+ * - `changeLog` and `incidentLog` enable additional semantic streams.
+ * - `logToConsole` enables colorized console output for development.
+ * - `sensitiveKeys` extends the default redaction list.
+ * - `retention` controls how long rotated files are kept (e.g., "14d").
+ *
+ * Transport configuration:
+ *
+ * - File transports are enabled by default and write to the directory
+ *   provided to `createLogger`.
+ * - `disableFileTransports` disables all file‑based transports entirely.
+ *   This is useful for cloud‑only or ephemeral environments.
+ * - `extraTransports` allows callers to append arbitrary Winston transports
+ *   (e.g., CloudWatch, syslog, Kafka). These transports receive the same
+ *   structured, redacted log objects as the built‑in transports.
+ *
+ * These options allow Scribe to operate in file‑based, console‑only,
+ * cloud‑only, or hybrid modes without changing the public API.
+ */
+export interface LoggerOptions {
+    level: LogLevel;
+    requestLog: string;
+    appLog: string;
+    changeLog?: string;
+    incidentLog?: string;
+    logToConsole?: boolean;
+    sensitiveKeys?: string[];
+    retention?: string;
+    extraTransports?: Transport[];
+    disableFileTransports?: boolean;
+}
+/**
+ * Supported semantic log levels. These map directly to Scribe's custom
+ * level hierarchy and determine which transport receives each log entry.
+ */
+export type LogLevel = "critical" | "error" | "warn" | "info" | "http" | "change" | "debug";
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;gFAOgF;AAChF,OAAO,KAAK,SAAS,MAAM,mBAAmB,CAAC;AAK/C;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAKD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,aAAa;IAC1B,KAAK,EAAE,QAAQ,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,SAAS,EAAE,CAAC;IAC9B,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACnC;AAKD;;;GAGG;AACH,MAAM,MAAM,QAAQ,GACd,UAAU,GACV,OAAO,GACP,MAAM,GACN,MAAM,GACN,MAAM,GACN,QAAQ,GACR,OAAO,CAAC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/utilities.d.ts

@@ -0,0 +1,35 @@
+/** -------------------------------------------------------------------------
+|* @name            utilities.ts
+|* @description     Internal helpers used by Scribe for deterministic
+|*                  directory naming, ANSI‑safe console output, and deep
+|*                  redaction of sensitive fields. These functions are pure,
+|*                  side‑effect‑free, and part of the public API.
+/* --------------------------------------------------------------------------
+
+/* -------------------------------------------------------------------------- *\
+|* Safe
+\* -------------------------------------------------------------------------- */
+/**
+ * Normalizes a string for use in filesystem paths. Converts to lowercase and
+ * replaces any character outside [a–z0–9-_] with a hyphen. This ensures
+ * deterministic, cross‑platform directory names and prevents path traversal
+ * or invalid characters from entering the log directory grammar.
+ */
+export declare const safe: (value: string) => string;
+/**
+ * Removes ANSI escape sequences from log messages. Used primarily for
+ * console‑originated logs (e.g., Morgan) to ensure that rotated log files
+ * contain clean, machine‑readable text without color codes or terminal
+ * control characters.
+ */
+export declare const stripAnsi: (log: string) => string;
+/**
+ * Recursively removes sensitive fields from an input object. Supports nested
+ * objects, arrays, and circular references. Sensitive keys are replaced with
+ * "[REDACTED]". Buffers are replaced with "[Binary]" to avoid dumping raw
+ * binary data into logs. All other values are preserved as‑is.
+ *
+ * This function never mutates the input and guarantees deterministic output.
+ */
+export declare const redact: (input: unknown, sensitiveKeys: string[], seen?: WeakSet<object>) => unknown;
+//# sourceMappingURL=utilities.d.ts.map

package/dist/utilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.d.ts","sourceRoot":"","sources":["../src/utilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;gFAUgF;AAChF;;;;;GAKG;AACH,eAAO,MAAM,IAAI,GAAI,OAAO,MAAM,WACqB,CAAC;AAKxD;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,KAAK,MAAM,WAEY,CAAC;AAKlD;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,GACf,OAAO,OAAO,EACd,eAAe,MAAM,EAAE,EACvB,sBAAoB,KACrB,OA2BF,CAAC"}

package/dist/utilities.js

@@ -0,0 +1,67 @@
+/** -------------------------------------------------------------------------
+|* @name            utilities.ts
+|* @description     Internal helpers used by Scribe for deterministic
+|*                  directory naming, ANSI‑safe console output, and deep
+|*                  redaction of sensitive fields. These functions are pure,
+|*                  side‑effect‑free, and part of the public API.
+/* --------------------------------------------------------------------------
+
+/* -------------------------------------------------------------------------- *\
+|* Safe
+\* -------------------------------------------------------------------------- */
+/**
+ * Normalizes a string for use in filesystem paths. Converts to lowercase and
+ * replaces any character outside [a–z0–9-_] with a hyphen. This ensures
+ * deterministic, cross‑platform directory names and prevents path traversal
+ * or invalid characters from entering the log directory grammar.
+ */
+export const safe = (value) => value.toLowerCase().replace(/[^a-zA-Z0-9-_]/g, "-");
+/* -------------------------------------------------------------------------- *\
+|* Strip ANSI
+\* -------------------------------------------------------------------------- */
+/**
+ * Removes ANSI escape sequences from log messages. Used primarily for
+ * console‑originated logs (e.g., Morgan) to ensure that rotated log files
+ * contain clean, machine‑readable text without color codes or terminal
+ * control characters.
+ */
+export const stripAnsi = (log) => 
+// eslint-disable-next-line no-control-regex
+log.replace(/\u001b\[[0-?]*[ -/]*[@-~]/g, "");
+/* -------------------------------------------------------------------------- *\
+|* Redact
+\* -------------------------------------------------------------------------- */
+/**
+ * Recursively removes sensitive fields from an input object. Supports nested
+ * objects, arrays, and circular references. Sensitive keys are replaced with
+ * "[REDACTED]". Buffers are replaced with "[Binary]" to avoid dumping raw
+ * binary data into logs. All other values are preserved as‑is.
+ *
+ * This function never mutates the input and guarantees deterministic output.
+ */
+export const redact = (input, sensitiveKeys, seen = new WeakSet()) => {
+    if (Array.isArray(input)) {
+        return input.map((value) => redact(value, sensitiveKeys, seen));
+    }
+    if (input && typeof input === "object") {
+        if (seen.has(input))
+            return "[Circular]";
+        seen.add(input);
+        const clone = {};
+        for (const [key, value] of Object.entries(input)) {
+            const normalized = sensitiveKeys.map((k) => k.toLowerCase());
+            if (normalized.includes(key.toLowerCase())) {
+                clone[key] = "[REDACTED]";
+            }
+            else if (value instanceof Buffer) {
+                clone[key] = "[Binary]";
+            }
+            else {
+                clone[key] = redact(value, sensitiveKeys, seen);
+            }
+        }
+        return clone;
+    }
+    return input;
+};
+//# sourceMappingURL=utilities.js.map

package/dist/utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.js","sourceRoot":"","sources":["../src/utilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;gFAUgF;AAChF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,EAAE,CAClC,KAAK,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;AAExD;;gFAEgF;AAChF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,EAAE;AACrC,4CAA4C;AAC5C,GAAG,CAAC,OAAO,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;AAElD;;gFAEgF;AAChF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAClB,KAAc,EACd,aAAuB,EACvB,IAAI,GAAG,IAAI,OAAO,EAAE,EACb,EAAE;IACT,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE,CAAC;IAED,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,IAAI,IAAI,CAAC,GAAG,CAAC,KAAe,CAAC;YAAE,OAAO,YAAY,CAAC;QACnD,IAAI,CAAC,GAAG,CAAC,KAAe,CAAC,CAAC;QAE1B,MAAM,KAAK,GAA4B,EAAE,CAAC;QAE1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/C,MAAM,UAAU,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAE7D,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;gBACzC,KAAK,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;YAC9B,CAAC;iBAAM,IAAI,KAAK,YAAY,MAAM,EAAE,CAAC;gBACjC,KAAK,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACJ,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;YACpD,CAAC;QACL,CAAC;QAED,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,61 @@
+{
+    "name": "@glassops/scribe",
+    "version": "1.0.0",
+    "description": "Deterministic, multi-tenant logging subsystem for GlassOps services.",
+    "license": "Apache-2.0",
+    "author": "GlassOps Limited",
+    "type": "module",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "engines": {
+        "node": ">=20"
+    },
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "types": "./dist/index.d.ts"
+        }
+    },
+    "files": [
+        "dist",
+        "README.md",
+        "LICENSE"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "prepack": "npm run build",
+        "format": "prettier --write .",
+        "typecheck": "tsc --noEmit",
+        "lint": "eslint .",
+        "lint-staged": "lint-staged",
+        "clean": "rimraf dist",
+        "build": "npm run clean && tsc -p tsconfig.json"
+    },
+    "keywords": [
+        "logging",
+        "winston",
+        "multi-tenant",
+        "audit",
+        "compliance",
+        "glassops"
+    ],
+    "dependencies": {
+        "winston": "^3.19.0",
+        "winston-daily-rotate-file": "^5.0.0"
+    },
+    "devDependencies": {
+        "@commitlint/cli": "^20.4.2",
+        "@commitlint/config-conventional": "^20.4.2",
+        "@eslint/js": "^10.0.1",
+        "@types/node": "^25.3.3",
+        "eslint": "^10.0.2",
+        "husky": "^9.1.7",
+        "lint-staged": "^16.3.1",
+        "prettier": "^3.8.1",
+        "rimraf": "^6.1.3",
+        "typescript": "^5.9.3",
+        "typescript-eslint": "^8.56.1"
+    }
+}