5.1.0

feat(smartjson): Add JSONL stringify and ordering comparator; fix empty buffer handling; refactor Smartjson folding/enfolding
5.0.21
2025-09-12 19:30:15 +00:00 · 2025-09-12 19:30:15 +00:00 · 2025-09-12 19:16:52 +00:00 · 2025-09-12 19:16:52 +00:00 · 2024-05-29 14:13:49 +02:00 · 2024-05-28 00:50:30 +02:00
15 changed files with 8335 additions and 4866 deletions
--- a/.gitea/workflows/default_tags.yaml
+++ b/.gitea/workflows/default_tags.yaml
@@ -119,6 +119,6 @@ jobs:
        run: |
          npmci node install stable
          npmci npm install
-          pnpm install -g @gitzone/tsdoc
+          pnpm install -g @git.zone/tsdoc
          npmci command tsdoc
        continue-on-error: true
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -1,128 +0,0 @@
-# gitzone ci_default
-image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-    - .npmci_cache/
-  key: '$CI_BUILD_STAGE'
-
-stages:
-  - security
-  - test
-  - release
-  - metadata
-
-before_script:
-  - pnpm install -g pnpm
-  - pnpm install -g @shipzone/npmci
-  - npmci npm prepare
-
-# ====================
-# security stage
-# ====================
-# ====================
-# security stage
-# ====================
-auditProductionDependencies:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-  stage: security
-  script:
-     - npmci command npm config set registry https://registry.npmjs.org
-     - npmci command pnpm audit --audit-level=high --prod
-  tags:
-    - lossless
-    - docker
-  allow_failure: true
-
-auditDevDependencies:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-  stage: security
-  script:
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command pnpm audit --audit-level=high --dev
-  tags:
-    - lossless
-    - docker
-  allow_failure: true
-
-# ====================
-# test stage
-# ====================
-
-testStable:
-  stage: test
-  script:
-    - npmci node install stable
-    - npmci npm install
-    - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-testBuild:
-  stage: test
-  script:
-    - npmci node install stable
-    - npmci npm install
-    - npmci npm build
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-release:
-  stage: release
-  script:
-    - npmci node install stable
-    - npmci npm publish
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  allow_failure: true
-  only:
-    - tags
-  script:
-    - npmci command npm install -g typescript
-    - npmci npm prepare
-    - npmci npm install
-  tags:
-    - lossless
-    - docker
-    - priv
-
-trigger:
-  stage: metadata
-  script:
-    - npmci trigger
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-pages:
-  stage: metadata
-  script:
-    - npmci node install stable
-    - npmci npm install
-    - npmci command npm run buildDocs
-  tags:
-    - lossless
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-      - public
-  allow_failure: true
--- a/changelog.md
+++ b/changelog.md
@@ -0,0 +1,217 @@
+# Changelog
+
+## 2025-09-12 - 5.1.0 - feat(smartjson)
+Add JSONL stringify and ordering comparator; fix empty buffer handling; refactor Smartjson folding/enfolding
+
+- Export stringifyJsonL(items: any[]) and add README documentation for JSONL stringification
+- stringify(obj, simpleOrderArray) now derives a stable-json comparator from simpleOrderArray when no custom cmp is provided, ensuring predictable key ordering
+- Fix buffer handling: empty Uint8Array values are preserved (no longer serialized to an empty string) and encoding/decoding logic improved
+- Refactor Smartjson.enfoldFromObject to safely use saveableProperties and avoid repeated property access
+- Simplify Smartjson.foldToObject to delegate to an internal foldToObjectInternal with cycle detection and correct nested instance handling
+- Add unit tests for empty buffers, JSONL parse/stringify, deepEqualJsonLStrings, and simpleOrderArray comparator behavior
+
+## 2025-09-12 - 5.0.21 - fix(Smartjson)
+Cross-platform buffer/base64 handling, safer folding with cycle detection, parsing fixes, docs and dependency updates
+
+- bufferhandling: prefer Node Buffer for base64 encode/decode when available and fall back to browser APIs for cross-platform support
+- parseJsonL: more robust parsing of JSON Lines (trim lines and use smartjson.parse to restore buffers/typed arrays)
+- parseBase64: use smartstring.base64.decodeUri or decode fallback before parsing, then parse result via smartjson.parse
+- Smartjson class: add TypeScript generics to enfold methods, introduce foldToObjectInternal and robust cycle detection using Set, properly handle arrays and deep-clone values
+- Tests: updated tap import path to @git.zone/tstest/tapbundle
+- package.json: bumped several devDependencies and dependency versions and added packageManager pin
+- Documentation: expanded README with examples, API reference and usage guidance
+- Repo config: added pnpm-workspace.yaml and .claude/settings.local.json
+
+## 2024-05-29 - 5.0.20 - docs
+Update package description.
+
+- Update package description text.
+
+## 2024-05-27 - 5.0.19 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2024-04-17 - 5.0.18 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2024-04-17 - 5.0.17 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2024-04-17 - 5.0.16 - build/core
+Build/config updates and core fixes.
+
+- Updated tsconfig configuration (2024-04-14).
+- Updated npmextra.json githost entries (multiple updates in early April).
+- Miscellaneous core updates and fixes.
+
+## 2024-03-19 - 5.0.15 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2024-03-19 - 5.0.14 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2024-03-03 - 5.0.13 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2024-03-03 - 5.0.12 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2024-03-03 - 5.0.11 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2024-02-25 - 5.0.10 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2023-08-24 - 5.0.9 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2023-08-19 - 5.0.8 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2023-08-19 - 5.0.7 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2023-07-10 - 5.0.6 - infra/core
+Organization and core updates.
+
+- Switched to new organization scheme.
+- Miscellaneous core updates and fixes.
+
+## 2023-06-03 - 5.0.5 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2022-10-26 - 5.0.4 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2022-10-26 - 5.0.3 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2022-10-26 - 5.0.2 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2022-09-13 - 5.0.1 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2022-06-26 - 5.0.0 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2022-06-09 - 4.0.7 - core (BREAKING CHANGE)
+Breaking change in core.
+
+- BREAKING CHANGE: core-related update (see code/compat notes).
+- Miscellaneous core updates.
+
+## 2022-06-09 - 4.0.6 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2020-10-05 - 4.0.4 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2020-10-05 - 4.0.3 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2020-10-05 - 4.0.2 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2020-10-05 - 4.0.1 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2020-10-05 - 4.0.0 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2020-10-05 - 3.0.12 - core (BREAKING CHANGE)
+Breaking change in core.
+
+- BREAKING CHANGE: core-related update (see migration notes).
+- Miscellaneous core updates.
+
+## 2020-10-03 - 3.0.11 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2020-10-03 - 3.0.10 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2019-02-14 - 3.0.0 - security
+Security-related update.
+
+- Added snyk policy for security scanning.
+
+## 2019-02-14 - 2.0.2 - core (BREAKING CHANGE)
+Breaking change in core API.
+
+- BREAKING CHANGE: renamed Folable to Smartjson and added deterministic stringify.
+- Update consumers accordingly.
+
+## 2018-09-05 - 2.0.1 - core
+Core fixes.
+
+- Miscellaneous core updates and fixes.
+
+## 2018-07-23 - 1.0.1 - scope (BREAKING CHANGE)
+Scope change.
+
+- BREAKING CHANGE: changed package scope.
+- See migration notes for scope changes.
+
+## 2017-02-27 - 1.0.0 - docs/init
+Initial release.
+
+- Added README.
+- Initial project files and setup.
+
+## 2018-07-23 — 2019-12-15 - 2.0.0, 3.0.1, 3.0.9 - version-only releases
+Version-only tags / non-descriptive releases.
+
+- These releases are recorded as version bumps without additional changelog details.
+- Affected tags: 2.0.0, 3.0.1, 3.0.9.
--- a/npmextra.json
+++ b/npmextra.json
@@ -5,12 +5,28 @@
  "gitzone": {
    "projectType": "npm",
    "module": {
-      "githost": "gitlab.com",
+      "githost": "code.foss.global",
      "gitscope": "push.rocks",
      "gitrepo": "smartjson",
-      "description": "typed json handlers",
+      "description": "A library for handling typed JSON data, providing functionalities for parsing, stringifying, and working with JSON objects, including support for encoding and decoding buffers.",
      "npmPackagename": "@push.rocks/smartjson",
-      "license": "MIT"
+      "license": "MIT",
+      "keywords": [
+        "JSON handling",
+        "typed JSON",
+        "JSON parsing",
+        "JSON stringifying",
+        "base64 encoding",
+        "buffer handling",
+        "data serialization",
+        "data deserialization",
+        "TypeScript support",
+        "data encoding",
+        "data decoding"
+      ]
    }
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
  }
 }
--- a/package.json
+++ b/package.json
@@ -1,8 +1,8 @@
 {
  "name": "@push.rocks/smartjson",
-  "version": "5.0.8",
+  "version": "5.1.0",
  "private": false,
-  "description": "typed json handlers",
+  "description": "A library for handling typed JSON data, providing functionalities for parsing, stringifying, and working with JSON objects, including support for encoding and decoding buffers.",
  "main": "dist_ts/index.js",
  "typings": "dist_ts/index.d.ts",
  "scripts": {
@@ -12,25 +12,23 @@
  },
  "repository": {
    "type": "git",
-    "url": "git+ssh://git@gitlab.com/pushrocks/smartjson.git"
+    "url": "https://code.foss.global/push.rocks/smartjson.git"
  },
  "author": "Lossless GmbH",
  "license": "MIT",
  "bugs": {
    "url": "https://gitlab.com/pushrocks/smartjson/issues"
  },
-  "homepage": "https://gitlab.com/pushrocks/smartjson#README",
+  "homepage": "https://code.foss.global/push.rocks/smartjson",
  "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.66",
-    "@gitzone/tsrun": "^1.2.44",
-    "@gitzone/tstest": "^1.0.77",
-    "@push.rocks/tapbundle": "^5.0.8",
-    "@types/node": "^20.5.0"
+    "@git.zone/tsbuild": "^2.6.8",
+    "@git.zone/tsrun": "^1.3.3",
+    "@git.zone/tstest": "^2.3.8",
+    "@types/node": "^22"
  },
  "dependencies": {
-    "@push.rocks/smartstring": "^4.0.8",
-    "@types/buffer-json": "^2.0.1",
-    "buffer-json": "^2.0.0",
+    "@push.rocks/smartenv": "^5.0.13",
+    "@push.rocks/smartstring": "^4.1.0",
    "fast-json-stable-stringify": "^2.1.0",
    "lodash.clonedeep": "^4.5.0"
  },
@@ -49,5 +47,19 @@
  "browserslist": [
    "last 1 chrome versions"
  ],
-  "type": "module"
+  "type": "module",
+  "keywords": [
+    "JSON handling",
+    "typed JSON",
+    "JSON parsing",
+    "JSON stringifying",
+    "base64 encoding",
+    "buffer handling",
+    "data serialization",
+    "data deserialization",
+    "TypeScript support",
+    "data encoding",
+    "data decoding"
+  ],
+  "packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748"
 }
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
--- a/pnpm-workspace.yaml
+++ b/pnpm-workspace.yaml
@@ -0,0 +1,3 @@
+onlyBuiltDependencies:
+  - esbuild
+  - puppeteer
--- a/readme.hints.md
+++ b/readme.hints.md
@@ -0,0 +1 @@
+ 
--- a/readme.md
+++ b/readme.md
@@ -1,64 +1,376 @@
 # @push.rocks/smartjson
-typed json handlers
+**🚀 Typed JSON handling for modern Node.js and TypeScript applications**

-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartjson)
-* [gitlab.com (source)](https://gitlab.com/push.rocks/smartjson)
-* [github.com (source mirror)](https://github.com/push.rocks/smartjson)
-* [docs (typedoc)](https://push.rocks.gitlab.io/smartjson/)
+A powerful library for working with JSON in TypeScript, providing type-safe serialization, advanced buffer handling, deep object comparison, and support for complex class instances. Perfect for applications that need reliable JSON manipulation with full TypeScript support.

-## Status for master
+## Installation

-Status Category | Status Badge
-- | --
-GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/smartjson/badges/master/pipeline.svg)](https://lossless.cloud)
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/smartjson/badges/master/coverage.svg)](https://lossless.cloud)
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartjson)](https://lossless.cloud)
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/smartjson)](https://lossless.cloud)
-TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
-node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
-PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/smartjson)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartjson)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartjson)](https://lossless.cloud)
+```bash
+# Using npm
+npm install @push.rocks/smartjson --save

-## Usage
+# Using yarn
+yarn add @push.rocks/smartjson

-Use TypeScript for best in class instellisense.
+# Using pnpm (recommended)
+pnpm add @push.rocks/smartjson
+```

-### Classes
+## Features

-SmartJson makes it easy to fold and enfold classes into and from JSON
+✨ **Type-Safe JSON Operations** - Full TypeScript support with proper typing  
+🎯 **Class Instance Serialization** - Fold and unfold class instances to/from JSON  
+🔐 **Buffer & Binary Support** - Seamless handling of Buffers and Typed Arrays  
+📊 **JSON Lines Support** - Parse and compare JSONL data streams  
+🎨 **Pretty Printing** - Beautiful formatted JSON output  
+⚡ **Stable Stringification** - Consistent key ordering for reliable comparisons  
+🔍 **Deep Equality Checks** - Compare complex objects and JSON structures  
+🌐 **Base64 Encoding** - Built-in base64 JSON encoding/decoding  

-```javascript
-import { Smartjson, foldDec } from 'smartjson';
+## Quick Start

-class AwesomeClass extends Smartjson {
-  static stringify;
+```typescript
+import * as smartjson from '@push.rocks/smartjson';

-  computedValue: string;
+// Parse JSON with automatic buffer handling
+const parsed = smartjson.parse('{"name":"example","data":{"type":"Buffer","data":[1,2,3]}}');

-  @foldDec() // mark anotherValueToStore as foldable
-  anotherValueToStore: string = null;
-  constructor() {
-    super(); // this is important
+// Stringify with stable key ordering
+const json = smartjson.stringify({ z: 1, a: 2, m: 3 });
+// Result: '{"a":2,"m":3,"z":1}'
+
+// Pretty print for human readability
+const pretty = smartjson.stringifyPretty({ hello: 'world', count: 42 });
+// Result:
+// {
+//   "hello": "world",
+//   "count": 42
+// }
+```
+
+## Core Functions
+
+### JSON Parsing and Stringification
+
+```typescript
+// Standard parsing with automatic Buffer detection
+const obj = smartjson.parse('{"hello":"world"}');
+
+// Stable stringification (consistent key ordering)
+const jsonStr = smartjson.stringify({ name: 'test', id: 1 });
+
+// Pretty printing for debugging
+const prettyJson = smartjson.stringifyPretty({ 
+  nested: { 
+    data: 'value' 
+  } 
+});
+```
+
+### Base64 JSON Encoding
+
+Encode JSON data as base64 for safe transmission:
+
+```typescript
+const myData = { 
+  message: 'Hello World',
+  timestamp: Date.now() 
+};
+
+// Encode to base64
+const encoded = smartjson.stringifyBase64(myData);
+console.log(encoded); // Base64 string
+
+// Decode back to object
+const decoded = smartjson.parseBase64(encoded);
+console.log(decoded); // Original object
+```
+
+### JSON Lines (JSONL) Support
+
+Perfect for streaming data and log processing:
+
+```typescript
+// Parse JSON Lines format
+const jsonLines = `{"event":"start","time":1234}
+{"event":"data","value":42}
+{"event":"end","time":5678}`;
+
+const events = smartjson.parseJsonL(jsonLines);
+// Result: Array of parsed objects
+
+// Produce JSONL from objects
+const jsonlOut = smartjson.stringifyJsonL([
+  { event: 'start', time: 1234 },
+  { event: 'data', value: 42 },
+  { event: 'end', time: 5678 }
+]);
+
+// Compare JSON Lines data
+const jsonL1 = `{"id":1}\n{"id":2}`;
+const jsonL2 = `{"id":1}\n{"id":2}`;
+const isEqual = smartjson.deepEqualJsonLStrings(jsonL1, jsonL2); // true
+```
+
+## Advanced Class Serialization
+
+### Creating Serializable Classes
+
+Transform class instances to JSON and back while preserving type safety:
+
+```typescript
+import { Smartjson, foldDec } from '@push.rocks/smartjson';
+
+class User extends Smartjson {
+  @foldDec() public username: string;
+  @foldDec() public email: string;
+  @foldDec() public settings: UserSettings;
+  
+  // Properties without @foldDec won't be serialized
+  private internalId: string;
+  
+  constructor(username: string, email: string) {
+    super();
+    this.username = username;
+    this.email = email;
+    this.settings = new UserSettings();
+    this.internalId = Math.random().toString();
  }
 }

-let myAwesomeInstance = new AwesomeClass();
-let foldedObject = myAwesomeInstance.foldToObject(); // will return {anotherValueToStore: null}
-// You can also fold to Json, with support for buffers
-// const jsonString = myAwesomeInstance.foldToJson();
-myAwesomeInstance = AwesomeClass.enfoldFromObject({ anotherValueToStore: 'hi' });
-foldedObject = myAwesomeInstance.foldToObject(); // will return {anotherValueToStore: 'hi'}
+class UserSettings extends Smartjson {
+  @foldDec() public theme: 'light' | 'dark' = 'light';
+  @foldDec() public notifications: boolean = true;
+}
+
+// Create and serialize
+const user = new User('john_doe', 'john@example.com');
+user.settings.theme = 'dark';
+
+// Convert to JSON
+const jsonString = user.foldToJson();
+console.log(jsonString);
+// {"username":"john_doe","email":"john@example.com","settings":{"theme":"dark","notifications":true}}
+
+// Restore from JSON with correct typing
+const restoredUser = User.enfoldFromJson(jsonString);
+console.log(restoredUser instanceof User); // true
+console.log(restoredUser.settings instanceof UserSettings); // true
 ```

-## Contribution
+### Working with Nested Objects

-We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+```typescript
+class Company extends Smartjson {
+  @foldDec() public name: string;
+  @foldDec() public employees: Employee[] = [];
+  
+  addEmployee(employee: Employee) {
+    this.employees.push(employee);
+  }
+}

-For further information read the linked docs at the top of this readme.
+class Employee extends Smartjson {
+  @foldDec() public name: string;
+  @foldDec() public role: string;
+  @foldDec() public salary: number;
+  
+  constructor(name: string, role: string, salary: number) {
+    super();
+    this.name = name;
+    this.role = role;
+    this.salary = salary;
+  }
+}

-## Legal
-> MIT licensed | **&copy;** [Task Venture Capital GmbH](https://task.vc)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+const company = new Company();
+company.name = 'TechCorp';
+company.addEmployee(new Employee('Alice', 'Developer', 100000));
+company.addEmployee(new Employee('Bob', 'Designer', 90000));
+
+// Serialize entire object graph
+const json = company.foldToJson();
+
+// Deserialize with all nested objects properly instantiated
+const restored = Company.enfoldFromJson(json);
+```
+
+## Buffer and Binary Data Handling
+
+SmartJson seamlessly handles binary data in JSON:
+
+```typescript
+// Automatic Buffer handling
+const dataWithBuffer = {
+  name: 'BinaryData',
+  buffer: Buffer.from('Hello World'),
+  typedArray: new Uint8Array([1, 2, 3, 4, 5])
+};
+
+// Stringify (buffers are automatically encoded)
+const jsonStr = smartjson.stringify(dataWithBuffer);
+
+// Parse (buffers are automatically restored)
+const restored = smartjson.parse(jsonStr);
+console.log(restored.buffer); // Buffer
+console.log(restored.typedArray); // Uint8Array
+```
+
+## Deep Comparison
+
+Compare complex objects with automatic normalization:
+
+```typescript
+// Deep object comparison
+const obj1 = {
+  nested: { 
+    array: [1, 2, { deep: 'value' }],
+    flag: true 
+  },
+  name: 'test'
+};
+
+const obj2 = {
+  name: 'test',  // Different order
+  nested: {
+    flag: true,   // Different order
+    array: [1, 2, { deep: 'value' }]
+  }
+};
+
+const isEqual = smartjson.deepEqualObjects(obj1, obj2); // true
+```
+
+## Real-World Examples
+
+### API Response Caching
+
+```typescript
+class CachedAPIResponse extends Smartjson {
+  @foldDec() public data: any;
+  @foldDec() public timestamp: number;
+  @foldDec() public endpoint: string;
+  
+  isExpired(maxAge: number = 3600000): boolean {
+    return Date.now() - this.timestamp > maxAge;
+  }
+  
+  static fromAPICall(endpoint: string, data: any): CachedAPIResponse {
+    const response = new CachedAPIResponse();
+    response.endpoint = endpoint;
+    response.data = data;
+    response.timestamp = Date.now();
+    return response;
+  }
+}
+
+// Store API response
+const apiData = await fetch('/api/users');
+const cached = CachedAPIResponse.fromAPICall('/api/users', await apiData.json());
+localStorage.setItem('cached_users', cached.foldToJson());
+
+// Retrieve and check
+const stored = localStorage.getItem('cached_users');
+if (stored) {
+  const cached = CachedAPIResponse.enfoldFromJson(stored);
+  if (!cached.isExpired()) {
+    return cached.data; // Use cached data
+  }
+}
+```
+
+### Configuration Management
+
+```typescript
+class AppConfig extends Smartjson {
+  @foldDec() public apiUrl: string;
+  @foldDec() public features: Map<string, boolean> = new Map();
+  @foldDec() public limits: {
+    maxUploadSize: number;
+    maxConcurrentRequests: number;
+  };
+  
+  enableFeature(name: string) {
+    this.features.set(name, true);
+  }
+  
+  save() {
+    fs.writeFileSync('config.json', this.foldToJson());
+  }
+  
+  static load(): AppConfig {
+    const json = fs.readFileSync('config.json', 'utf-8');
+    return AppConfig.enfoldFromJson(json);
+  }
+}
+```
+
+## API Reference
+
+### Core Functions
+
+- `parse(jsonString: string): any` - Parse JSON with automatic buffer handling
+- `stringify(obj: any, simpleOrderArray?: string[], options?: Options): string` - Convert to JSON with stable ordering
+- `stringifyPretty(obj: any): string` - Pretty print JSON with 2-space indentation
+- `stringifyBase64(obj: any): string` - Encode JSON as base64
+- `parseBase64(base64String: string): any` - Decode base64 JSON
+- `parseJsonL(jsonLinesString: string): any[]` - Parse JSON Lines format
+- `stringifyJsonL(items: any[]): string` - Stringify array to JSON Lines
+- `deepEqualObjects(obj1: any, obj2: any): boolean` - Deep comparison of objects
+- `deepEqualJsonLStrings(jsonL1: string, jsonL2: string): boolean` - Compare JSON Lines strings
+
+### Smartjson Class
+
+- `Smartjson.enfoldFromObject<T>(obj: any): T` - Create instance from plain object
+- `Smartjson.enfoldFromJson<T>(json: string): T` - Create instance from JSON string
+- `instance.foldToObject(): any` - Convert instance to plain object
+- `instance.foldToJson(): string` - Convert instance to JSON string
+
+### Decorators
+
+- `@foldDec()` - Mark class property for serialization
+
+## Performance Tips
+
+1. **Use stable stringification** for consistent hashing and comparison
+2. **Enable pretty printing** only for debugging (it's slower)
+3. **Cache base64 encodings** when repeatedly sending the same data
+4. **Use JSON Lines** for streaming large datasets
+5. **Avoid circular references** in objects being serialized
+
+## Migration Guide
+
+If you're migrating from native JSON:
+
+```typescript
+// Before
+JSON.parse(jsonString);
+JSON.stringify(object);
+
+// After
+smartjson.parse(jsonString);  // Adds buffer support
+smartjson.stringify(object);  // Adds stable ordering & buffer support
+```
+
+## Browser Support
+
+This library supports modern browsers and Node.js environments. For older browsers, ensure you have appropriate polyfills for `TextEncoder` and `TextDecoder`.
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
--- a/test/test.both.ts
+++ b/test/test.both.ts
@@ -1,4 +1,4 @@
-import { tap, expect } from '@push.rocks/tapbundle';
+import { tap, expect } from '@git.zone/tstest/tapbundle';

 import * as smartjson from '../ts/index.js';

@@ -59,4 +59,49 @@ tap.test('stringify should handle plain string', async () => {
  expect(smartjson.parse(stringifiedString)).toEqual('hello');
 });

+tap.test('should work with buffers', async () => {
+  const someObject = {
+    myBuffer: new TextEncoder().encode('hello')
+  };
+  console.log(someObject.myBuffer);
+  const stringified = smartjson.stringify(someObject);
+  console.log(stringified);
+  const decoded = smartjson.parse(stringified);
+  console.log(decoded.myBuffer);
+  let text = new TextDecoder().decode(decoded.myBuffer);
+  expect(text).toEqual('hello');
+});
+
+tap.test('should handle empty buffers', async () => {
+  const someObject = { empty: new Uint8Array([]) };
+  const json = smartjson.stringify(someObject);
+  const parsed = smartjson.parse(json);
+  expect(parsed.empty).toBeInstanceOf(Uint8Array);
+  expect(parsed.empty.length).toEqual(0);
+});
+
+tap.test('should parse and stringify JSONL', async () => {
+  const items = [
+    { id: 1, name: 'a' },
+    { id: 2, name: 'b' }
+  ];
+  const jsonl = smartjson.stringifyJsonL(items);
+  const parsed = smartjson.parseJsonL(jsonl);
+  expect(parsed).toEqual(items);
+});
+
+tap.test('should deep-compare JSONL strings', async () => {
+  const a = '{"id":2,"name":"b"}\n{"id":1,"name":"a"}';
+  const b = '{"id":2,"name":"b"}\n{"id":1,"name":"a"}';
+  expect(smartjson.deepEqualJsonLStrings(a, b)).toEqual(true);
+});
+
+tap.test('should respect simpleOrderArray comparator', async () => {
+  const obj = { c: 3, a: 1, b: 2 };
+  const ordered = smartjson.stringify(obj, ['b', 'a']);
+  // ensure keys b, a come before c
+  expect(ordered.indexOf('"b"')).toBeLessThan(ordered.indexOf('"a"'));
+  expect(ordered.indexOf('"a"')).toBeLessThan(ordered.indexOf('"c"'));
+});
+
 tap.start();
--- a/ts/00_commitinfo_data.ts
+++ b/ts/00_commitinfo_data.ts
@@ -1,8 +1,8 @@
 /**
- * autocreated commitinfo by @pushrocks/commitinfo
+ * autocreated commitinfo by @push.rocks/commitinfo
 */
 export const commitinfo = {
  name: '@push.rocks/smartjson',
-  version: '5.0.8',
-  description: 'typed json handlers'
+  version: '5.1.0',
+  description: 'A library for handling typed JSON data, providing functionalities for parsing, stringifying, and working with JSON objects, including support for encoding and decoding buffers.'
 }
--- a/ts/bufferhandling.ts
+++ b/ts/bufferhandling.ts
@@ -0,0 +1,130 @@
+import * as plugins from './smartjson.plugins.js';
+
+// Define interfaces and types for better type checking and readability
+interface IBufferLike {
+  type: 'Buffer';
+  data: string | any[]; // `any[]` for array data representation
+}
+
+interface IEncodedBuffer {
+  type: 'EncodedBuffer',
+  data: string;
+}
+
+type TParseReviver = (this: any, key: string, value: any) => any;
+type TParseReplacer = (this: any, key: string, value: any) => any;
+
+// Utility functions to handle base64 encoding/decoding in a cross-platform way
+function base64Encode(data: Uint8Array): string {
+  // Prefer Node's Buffer when available
+  if (typeof Buffer !== 'undefined') {
+    // @ts-ignore Buffer might not exist in browser builds
+    return Buffer.from(data).toString('base64');
+  }
+  // Fallback for browsers
+  return btoa(String.fromCharCode(...data));
+}
+
+function base64Decode(str: string): Uint8Array {
+  // Prefer Node's Buffer when available
+  if (typeof Buffer !== 'undefined') {
+    // @ts-ignore Buffer might not exist in browser builds
+    const buf = Buffer.from(str, 'base64');
+    return new Uint8Array(buf.buffer, buf.byteOffset, buf.byteLength);
+  }
+  // Fallback for browsers
+  return new Uint8Array(Array.from(atob(str)).map((char) => char.charCodeAt(0)));
+}
+
+// Main functionality with cross-platform support
+function stringify(value: any, space?: string | number): string {
+  return JSON.stringify(value, replacer, space);
+}
+
+function parse(text: string): any {
+  return JSON.parse(text, reviver);
+}
+
+const replacer: TParseReplacer = (key, value) => {
+  // Check if value is IBufferLike
+  if (isBufferLike(value)) {
+    let bufferData: Uint8Array;
+
+    // Handle IBufferLike objects with a .data property
+    if ('data' in value && isArray(value.data)) {
+      bufferData = new Uint8Array(value.data);
+    } 
+    // Handle Uint8Array directly
+    else if (value instanceof Uint8Array) {
+      bufferData = value;
+    } else {
+      // If not a recognized format, return value as is
+      return value;
+    }
+
+    // Encode the bufferData (Uint8Array) to base64
+    const base64Data = 'base64:' + base64Encode(bufferData);
+    return {
+      type: 'EncodedBuffer',
+      data: base64Data,
+    };
+  }
+
+  // Return value unchanged if not buffer-like
+  return value;
+};
+
+const reviver: TParseReviver = (key, value) => {
+  if (isEncodedBuffer(value)) {
+    if (isString(value.data) && value.data.startsWith('base64:')) {
+      // Correctly slice the 'base64:' prefix before decoding
+      const base64Data = value.data.slice(7); // Skip 'base64:' prefix
+      const buffer = base64Decode(base64Data);
+      // Assuming the rest of your application can work directly with Uint8Array,
+      // otherwise, you might need to convert it to another format
+      return buffer;
+    }
+  }
+  return value;
+};
+
+function isEncodedBuffer(x: any): x is IEncodedBuffer {
+  return isObject(x) && (x as any).type === 'EncodedBuffer' && isString((x as any).data);
+}
+
+function isBufferLike(x: any): x is IBufferLike | Uint8Array {
+  return (
+    (isObject(x) &&
+      ((x as any).type === 'Buffer' &&
+      (isArray((x as any).data) || isString((x as any).data)))) ||
+    x instanceof Uint8Array
+  );
+}
+
+/**
+ * We use this function to check if a value is an array
+ * @param x
+ * @returns 
+ */
+function isArray(x: any): x is any[] {
+  return Array.isArray(x);
+}
+
+/**
+ * We use this function to check if a value is a string
+ * @param x
+ * @returns 
+ */
+function isString(x: any): x is string {
+  return typeof x === 'string';
+}
+
+/**
+ * We use this function to check if a value is an object
+ * @param x
+ */
+function isObject(x: any): x is object {
+  return typeof x === 'object' && x !== null;
+}
+
+export { stringify, parse, replacer, reviver };
--- a/ts/index.ts
+++ b/ts/index.ts
@@ -1,9 +1,30 @@
 import * as plugins from './smartjson.plugins.js';
+import * as bufferhandling from './bufferhandling.js';
+
+interface JsonObject {
+  [key: string]: any;
+}

 /**
 * allows you to parse a json
 */
-export const parse = plugins.bufferJson.parse;
+export const parse = bufferhandling.parse;
+
+export const parseJsonL = (jsonlData: string): JsonObject[] => {
+  const lines = jsonlData.split('\n');
+  const parsedData: JsonObject[] = lines.reduce((acc, line) => {
+    const trimmed = line.trim();
+    if (trimmed.length > 0) {
+      acc.push(parse(trimmed));
+    }
+    return acc;
+  }, [] as JsonObject[]);
+  return parsedData;
+}
+
+export const stringifyJsonL = (items: any[]): string => {
+  return items.map((item) => stringify(item)).join('\n');
+}

 /**
 *
@@ -15,33 +36,53 @@ export const stringify = (
  simpleOrderArray?: string[],
  optionsArg: plugins.IStableJsonTypes['Options'] = {}
 ): string => {
-  const bufferedJson = plugins.bufferJson.stringify(objArg);
+  const bufferedJson = bufferhandling.stringify(objArg);
  objArg = JSON.parse(bufferedJson);
-  let returnJson = plugins.stableJson(objArg, optionsArg);
+  // derive a simple comparator from simpleOrderArray if provided and no custom cmp supplied
+  let options = { ...optionsArg };
+  if (simpleOrderArray && !options.cmp) {
+    const order = new Map<string, number>();
+    simpleOrderArray.forEach((key, idx) => order.set(key, idx));
+    options.cmp = (a, b) => {
+      const aIdx = order.has(a.key) ? (order.get(a.key) as number) : Number.POSITIVE_INFINITY;
+      const bIdx = order.has(b.key) ? (order.get(b.key) as number) : Number.POSITIVE_INFINITY;
+      if (aIdx !== bIdx) return aIdx - bIdx;
+      // fallback to lexicographic order for stable behavior
+      return a.key < b.key ? -1 : a.key > b.key ? 1 : 0;
+    };
+  }
+  let returnJson = plugins.stableJson(objArg, options);
  return returnJson;
 };

+export const stringifyPretty = (objectArg: any) => {
+  const stringified = stringify(objectArg);
+  const object = JSON.parse(stringified);
+  return JSON.stringify(object, null, 2);
+}
+
 export const stringifyBase64 = (...args: Parameters<typeof stringify>): string => {
  const stringifiedResult = stringify(...args);
  return plugins.smartstring.base64.encodeUri(stringifiedResult);
 };

 export const parseBase64 = (base64JsonStringArg: string) => {
-  const simpleStringified = plugins.smartstring.base64.decode(base64JsonStringArg);
+  const base64 = plugins.smartstring.base64 as any;
+  const decodeFn: (input: string) => string = base64.decodeUri || base64.decode;
+  const simpleStringified = decodeFn(base64JsonStringArg);
  return parse(simpleStringified);
 };

-parse;
-
 export class Smartjson {
  /**
   * enfolds data from an object
   */
-  public static enfoldFromObject(objectArg) {
-    const newInstance = new this();
+  public static enfoldFromObject<T extends typeof Smartjson>(this: T, objectArg: any): InstanceType<T> {
+    const newInstance = new this() as InstanceType<T>;
+    const saveables: string[] = (newInstance as any).saveableProperties || [];
    for (const keyName in objectArg) {
-      if (newInstance.saveableProperties.indexOf(keyName) !== -1) {
-        newInstance[keyName] = objectArg[keyName];
+      if (saveables.indexOf(keyName) !== -1) {
+        (newInstance as any)[keyName] = objectArg[keyName];
      }
    }
    return newInstance;
@@ -50,7 +91,7 @@ export class Smartjson {
  /**
   * enfold from json
   */
-  public static enfoldFromJson(jsonArg: string) {
+  public static enfoldFromJson<T extends typeof Smartjson>(this: T, jsonArg: string): InstanceType<T> {
    const objectFromJson = parse(jsonArg);
    return this.enfoldFromObject(objectFromJson);
  }
@@ -65,20 +106,32 @@ export class Smartjson {
   * folds a class into an object
   */
  public foldToObject() {
-    const newFoldedObject: { [key: string]: any } = {};
-    const trackMap = [];
-    for (const keyName of this.saveableProperties) {
-      let value = this[keyName];
-      if (value instanceof Smartjson) {
-        if (trackMap.includes(value)) {
+    const trackSet = new Set<Smartjson>();
+    trackSet.add(this);
+    return this.foldToObjectInternal(trackSet);
+  }
+
+  private foldToObjectInternal(trackSet: Set<Smartjson>) {
+    const result: { [key: string]: any } = {};
+    const foldValue = (val: any): any => {
+      if (val instanceof Smartjson) {
+        if (trackSet.has(val)) {
          throw new Error('cycle detected');
        }
-        trackMap.push(value);
-        value = value.foldToObject();
+        trackSet.add(val);
+        return val.foldToObjectInternal(trackSet);
      }
-      newFoldedObject[keyName] = plugins.lodashCloneDeep(value);
+      if (Array.isArray(val)) {
+        return val.map((item) => foldValue(item));
+      }
+      return plugins.lodashCloneDeep(val);
+    };
+    const props: string[] = (this as any).saveableProperties || [];
+    for (const keyName of props) {
+      const value = this[keyName];
+      result[keyName] = foldValue(value);
    }
-    return newFoldedObject;
+    return result;
  }

  /**
@@ -107,3 +160,9 @@ export const deepEqualObjects = (object1: any, object2: any): boolean => {
  const object2String = stringify(object2);
  return object1String === object2String;
 };
+
+export const deepEqualJsonLStrings = (jsonLString1: string, jsonLString2: string): boolean => {
+  const firstArray = parseJsonL(jsonLString1);
+  const secondArray = parseJsonL(jsonLString2);
+  return deepEqualObjects(firstArray, secondArray);
+}
--- a/ts/smartjson.plugins.ts
+++ b/ts/smartjson.plugins.ts
@@ -1,16 +1,16 @@
 // @pushrocks scope
+import * as smartenv from '@push.rocks/smartenv';
 import * as smartstring from '@push.rocks/smartstring';

-export { smartstring };
+export { smartenv, smartstring };

 // third party scope
 import lodashCloneDeep from 'lodash.clonedeep';
 import stableJson2 from 'fast-json-stable-stringify';
-import bufferJson from 'buffer-json';

 const stableJson = stableJson2 as any;

-export { bufferJson, lodashCloneDeep, stableJson };
+export { lodashCloneDeep, stableJson };

 export interface IStableJsonTypes {
  Comparator: (
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -3,8 +3,12 @@
    "experimentalDecorators": true,
    "useDefineForClassFields": false,
    "target": "ES2022",
-    "module": "ES2022",
-    "moduleResolution": "nodenext",
-    "esModuleInterop": true
-  }
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
 }
Author	SHA1	Message	Date
Juergen Kunz	374a8e411a	5.1.0	2025-09-12 19:30:15 +00:00
Juergen Kunz	fe8b5ce7c0	feat(smartjson): Add JSONL stringify and ordering comparator; fix empty buffer handling; refactor Smartjson folding/enfolding	2025-09-12 19:30:15 +00:00
Juergen Kunz	58322d23f4	5.0.21	2025-09-12 19:16:52 +00:00
Juergen Kunz	2f012fc0ad	fix(Smartjson): Cross-platform buffer/base64 handling, safer folding with cycle detection, parsing fixes, docs and dependency updates	2025-09-12 19:16:52 +00:00
Philipp Kunz	9bb6e0b497	update description	2024-05-29 14:13:49 +02:00
Philipp Kunz	5275e13360	5.0.20	2024-05-28 00:50:30 +02:00
Philipp Kunz	03fe2174d1	fix(core): update	2024-05-28 00:50:30 +02:00
Philipp Kunz	7df82ce64d	5.0.19	2024-04-17 20:19:18 +02:00
Philipp Kunz	09b74e4053	fix(core): update	2024-04-17 20:19:17 +02:00
Philipp Kunz	096cd74773	5.0.18	2024-04-17 20:11:19 +02:00
Philipp Kunz	e9a45ac993	fix(core): update	2024-04-17 20:11:18 +02:00
Philipp Kunz	b3856cb94a	5.0.17	2024-04-17 20:10:59 +02:00
Philipp Kunz	e44d014733	fix(core): update	2024-04-17 20:10:59 +02:00
Philipp Kunz	777d7ae1b3	update tsconfig	2024-04-14 17:45:36 +02:00
Philipp Kunz	f1f6b5fa79	update npmextra.json: githost	2024-04-01 21:35:43 +02:00
Philipp Kunz	65673e9710	update npmextra.json: githost	2024-04-01 19:58:33 +02:00
Philipp Kunz	66f1094cfe	update npmextra.json: githost	2024-03-30 21:47:32 +01:00
Philipp Kunz	8e93b8cb73	5.0.16	2024-03-19 13:50:07 +01:00
Philipp Kunz	e38ccd221a	fix(core): update	2024-03-19 13:50:06 +01:00
Philipp Kunz	969b892ed8	5.0.15	2024-03-19 13:30:15 +01:00
Philipp Kunz	d1d679ac34	fix(core): update	2024-03-19 13:30:15 +01:00
Philipp Kunz	8937dfb553	5.0.14	2024-03-03 10:35:27 +01:00
Philipp Kunz	09d45b1f45	fix(core): update	2024-03-03 10:35:26 +01:00
Philipp Kunz	a897f01ec6	5.0.13	2024-03-03 10:30:12 +01:00
Philipp Kunz	f951e0e70d	fix(core): update	2024-03-03 10:30:11 +01:00
Philipp Kunz	e79a2514ef	5.0.12	2024-03-03 10:29:19 +01:00
Philipp Kunz	d77c104915	fix(core): update	2024-03-03 10:29:18 +01:00
Philipp Kunz	45593168b0	5.0.11	2024-02-25 01:43:07 +01:00
Philipp Kunz	0227f22ca6	fix(core): update	2024-02-25 01:43:07 +01:00
Philipp Kunz	cece00a9b0	5.0.10	2023-08-24 12:01:21 +02:00
Philipp Kunz	e90ae7649f	fix(core): update	2023-08-24 12:01:21 +02:00
Philipp Kunz	70e6150708	5.0.9	2023-08-24 10:48:52 +02:00
Philipp Kunz	52928e0b9b	fix(core): update	2023-08-24 10:48:51 +02:00