5.0.13

.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

.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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/smartjson",
-  "version": "5.0.8",
+  "version": "5.0.13",
   "private": false,
   "description": "typed json handlers",
   "main": "dist_ts/index.js",
@@ -21,16 +21,16 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartjson#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.66",
-    "@gitzone/tsrun": "^1.2.44",
-    "@gitzone/tstest": "^1.0.77",
+    "@git.zone/tsbuild": "^2.1.66",
+    "@git.zone/tsrun": "^1.2.44",
+    "@git.zone/tstest": "^1.0.77",
     "@push.rocks/tapbundle": "^5.0.8",
-    "@types/node": "^20.5.0"
+    "@types/node": "^20.11.24"
   },
   "dependencies": {
-    "@push.rocks/smartstring": "^4.0.8",
-    "@types/buffer-json": "^2.0.1",
-    "buffer-json": "^2.0.0",
+    "@push.rocks/smartbuffer": "^1.0.7",
+    "@push.rocks/smartenv": "^5.0.12",
+    "@push.rocks/smartstring": "^4.0.14",
     "fast-json-stable-stringify": "^2.1.0",
     "lodash.clonedeep": "^4.5.0"
   },

test/test.both.ts

@@ -59,4 +59,17 @@ 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.start();

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartjson',
-  version: '5.0.8',
+  version: '5.0.13',
   description: 'typed json handlers'
 }

ts/bufferhandling.ts

@@ -0,0 +1,121 @@
+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 {
+  return btoa(String.fromCharCode(...data));
+}
+
+function base64Decode(str: string): Uint8Array {
+  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)) {
+      if (value.data.length > 0) {
+        bufferData = new Uint8Array(value.data);
+      } else {
+        return ''; // Return empty string for empty data arrays
+      }
+    } 
+    // 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 };

ts/index.ts

@@ -1,9 +1,10 @@
 import * as plugins from './smartjson.plugins.js';
+import * as bufferhandling from './bufferhandling.js';
 
 /**
  * allows you to parse a json
  */
-export const parse = plugins.bufferJson.parse;
+export const parse = bufferhandling.parse;
 
 /**
  *
@@ -15,12 +16,18 @@ 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);
   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);

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: (

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"
+  ]
 }