@editor-x/wme-logstream 0.1.0-alpha.1

package/LICENSE

@@ -0,0 +1,190 @@
+                                 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 David Slutsky (Waze username: r0den)
+
+   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,216 @@
+<h1 align="center">WME LogStream</h1>
+
+<p align="center">
+  <b>A lightweight, structured logging and persistence library for Waze Map Editor (WME) userscripts and extensions.</b>
+</p>
+
+<p align="center">
+  <a href="https://github.com/TheEditorX/wme-logstream/actions"><img src="https://img.shields.io/github/actions/workflow/status/TheEditorX/wme-logstream/ci.yml?branch=main&style=flat-square" alt="Build Status" /></a>
+  <a href="https://www.npmjs.com/package/@editor-x/wme-logstream"><img src="https://img.shields.io/npm/v/%40editor-x%2Fwme-logstream?style=flat-square" alt="npm version" /></a>
+  <a href="http://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/License-Apache2-blue.svg?style=flat-square" alt="License: Apache2.0" /></a>
+  <a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-%23007ACC.svg?style=flat-square&logo=typescript&logoColor=white" alt="TypeScript" /></a>
+</p>
+
+---
+
+## 📖 Overview
+
+**WME LogStream** is an asynchronous logging framework designed for developers building userscripts and extensions for the **Waze Map Editor (WME)**.
+
+It handles console branding, multi-tab safe IndexedDB persistence, state delta diffing, and log exporting with a unified, zero-boilerplate API.
+
+### Key Features
+
+- 🌲 **Hierarchical Scoping**: Scope loggers to specific components (e.g., `[MyScript] [API] [Auth]`).
+- 🎨 **Custom Console Styling**: Style console output with custom brand colors and prefixes.
+- 💾 **Asynchronous Persistence**: Buffers and persists logs locally to IndexedDB in the background.
+- 👥 **Multi-Tab Isolation**: Prevents session collisions when the editor is open in multiple browser tabs.
+- ⚡ **State Delta Tracking**: Deep-diff state objects over time and log only modified properties.
+- 📦 **Zip Archive Export & Download**: Bundle and download stored log sessions directly from the browser.
+
+---
+
+## 📐 Architecture
+
+The library decouples logging API interactions from storage and console outputs:
+
+```mermaid
+graph TD
+    LS[LogStream] -->|Dispatches LogPayload| Dispatcher[Dispatcher]
+    Dispatcher -->|write| CP[ConsolePipe]
+    Dispatcher -->|write| IDBP[IndexedDBPipe]
+    CP --> C[Developer Console]
+    IDBP --> IDBM[IndexedDBManager]
+    IDBM --> IDB[(IndexedDB)]
+    SM[SessionManager] -.-> IDBM
+    ZS[ZipStreamer] --> IDBM
+    ZS --> Z[ZIP File Blob]
+```
+
+---
+
+## 🚀 Installation
+
+### 1. For Bundled Scripts and Extensions
+
+Install via npm for projects using a bundler (Webpack, Rollup, Vite):
+
+```bash
+npm install wme-logstream
+```
+
+Then import `LogStream` in your modules:
+
+```typescript
+import { LogStream } from 'wme-logstream';
+```
+
+### 2. For Userscripts (Tampermonkey / Violentmonkey)
+
+To load the pre-built global IIFE library directly in your userscript, import it using **jsDelivr** pointing to the npm package:
+
+```javascript
+// @require https://cdn.jsdelivr.net/npm/editor-x/wme-logstream@latest/dist/index.iife.js
+```
+
+The library will be available on the global `window` object as `EditorXLogStream`.
+
+---
+
+## ⚡ Quick Start
+
+### 1. Simple Console Logging
+
+If you only want customized console logging, setup is synchronous and instant:
+
+```typescript
+import { LogStream } from 'wme-logstream';
+
+const logger = LogStream.create({
+  minLogLevel: 'DEBUG',
+  brand: {
+    prefix: 'MyScript',
+    color: '#00E676',
+  },
+});
+
+logger.info('Logger initialized.');
+logger.debug('Fetching details...', { segmentId: 12345 });
+```
+
+### 2. Logging with IndexedDB Persistence & Multi-Tab Isolation
+
+To automatically persist log history in IndexedDB with safe multi-tab isolation, simply toggle `persist: true`. The library handles the asynchronous database and session setup in the background:
+
+```typescript
+import { LogStream } from 'wme-logstream';
+
+const logger = LogStream.create({
+  minLogLevel: 'DEBUG',
+  persist: true,
+  dbPrefix: 'MyScriptDB',
+  scriptVersion: '1.0.0',
+  wmeSDK: (window as any).WazeMapEditorSDK, // optional
+  brand: { prefix: 'MyScript' },
+});
+
+// Logs are safely buffered and queued immediately on page load!
+logger.info('Script loaded and database logging is active.');
+```
+
+---
+
+## 🛠️ Advanced Usage
+
+### 1. Hierarchical Scoping
+
+Loggers can be nested to show context hierarchies:
+
+```typescript
+const apiLogger = logger.scope('API');
+const authLogger = apiLogger.scope('Auth');
+
+logger.info('Starting...'); // [MyScript] [INFO] Starting...
+apiLogger.debug('Connecting'); // [MyScript] [DEBUG][API] Connecting
+authLogger.error('Failed'); // [MyScript] [ERROR][API][Auth] Failed
+```
+
+### 2. State Delta Tracking
+
+Track state mutations over time by logging only differences. You can create a state tracker function:
+
+```typescript
+const trackSettings = logger.createStateTracker('editorSettings');
+const state = { theme: 'dark', visibleLayers: ['segments'] };
+
+// Initial state call logs the base state
+trackSettings(state);
+
+// Subsequent calls calculate and log only the changed properties
+trackSettings({ theme: 'light', visibleLayers: ['segments'] });
+// Logs only: { theme: ['dark', 'light'] }
+```
+
+### 3. Log Exports (ZIP Download)
+
+Provide users with a simple way to download troubleshooting logs as a compressed ZIP file directly in the browser:
+
+```typescript
+// Triggers a browser download of a zipped archive of all archived log sessions
+await logger.downloadLogs('my-script-logs.zip');
+```
+
+If you need to retrieve the raw compressed Blob (e.g. to upload to a remote server instead of downloading it):
+
+```typescript
+const zipBlob = await logger.exportLogs();
+```
+
+---
+
+## ⚙️ API Configuration Reference
+
+### `LogStream.create(config)`
+
+| Property              | Type                                                                      | Default                       | Description                                                            |
+| :-------------------- | :------------------------------------------------------------------------ | :---------------------------- | :--------------------------------------------------------------------- |
+| `minLogLevel`         | `'TRACE' \| 'DEBUG' \| 'INFO' \| 'WARN' \| 'ERROR' \| 'FATAL'`            | `'INFO'`                      | Minimum level of severity required to log.                             |
+| `persist`             | `boolean`                                                                 | `false`                       | Enable/disable background IndexedDB persistence.                       |
+| `dbPrefix`            | `string`                                                                  | _Required if persist is true_ | Name prefix for the IndexedDB database.                                |
+| `scriptVersion`       | `string`                                                                  | _Required if persist is true_ | Current version of your script/extension.                              |
+| `wmeSDK`              | [`WmeSDK`](https://www.waze.com/editor/sdk/classes/index.SDK.WmeSDK.html) | `undefined`                   | Native WME SDK instance to query editor versions.                      |
+| `maxArchivedSessions` | `number`                                                                  | `15`                          | Maximum number of archived database sessions to preserve.              |
+| `flushIntervalMs`     | `number`                                                                  | `2000`                        | Asynchronous log flush rate to IndexedDB (in ms).                      |
+| `brand`               | `ConsolePipeConfig \| null`                                               | `undefined`                   | Custom branding config for console outputs (set to `null` to disable). |
+
+#### `ConsolePipeConfig`
+
+| Property       | Type     | Default     | Description                          |
+| :------------- | :------- | :---------- | :----------------------------------- |
+| `scriptPrefix` | `string` | `'EditorX'` | Tag prefix displayed in log entries. |
+| `brandColor`   | `string` | `'#00E676'` | Hex color of the brand prefix.       |
+
+---
+
+## 🧪 Development
+
+Install dependencies:
+
+```bash
+npm install
+```
+
+Available scripts:
+
+```bash
+npm run build        # Build package distributions (ESM, CJS, IIFE)
+npm run test         # Run unit tests
+npm run lint         # Run ESLint validation
+npm run format       # Run Prettier format check and fixes
+```
+
+---
+
+## 📄 License
+
+This project is licensed under the **Apache-2.0 License**. See the `LICENSE` file for details.