5.0.3

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -36,6 +39,7 @@ auditProductionDependencies:
     - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
+  allow_failure: true
 
 auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
@@ -96,10 +100,9 @@ codequality:
   only:
     - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -119,11 +122,10 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
+    - npmci node install stable 
     - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

.snyk

@@ -1,4 +0,0 @@
-# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
-version: v1.13.3
-ignore: {}
-patch: {}

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
+      "type": "node-terminal"
     }
   ]
 }

npmextra.json

@@ -8,7 +8,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartjson",
-      "shortDescription": "typed json handlers",
+      "description": "typed json handlers",
       "npmPackagename": "@pushrocks/smartjson",
       "license": "MIT"
     }

package.json

@@ -1,13 +1,14 @@
 {
   "name": "@pushrocks/smartjson",
-  "version": "4.0.2",
+  "version": "5.0.3",
   "private": false,
   "description": "typed json handlers",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web)"
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -20,17 +21,17 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartjson#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.2.9",
-    "@types/node": "^14.11.2",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0"
+    "@gitzone/tsbuild": "^2.1.65",
+    "@gitzone/tsrun": "^1.2.37",
+    "@gitzone/tstest": "^1.0.73",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.7.17"
   },
   "dependencies": {
-    "@types/buffer-json": "^2.0.0",
-    "@types/fast-json-stable-stringify": "^2.0.0",
+    "@pushrocks/smartstring": "^4.0.5",
+    "@types/buffer-json": "^2.0.1",
+    "@types/fast-json-stable-stringify": "^2.1.0",
+    "@types/lodash.clonedeep": "^4.5.7",
     "buffer-json": "^2.0.0",
     "fast-json-stable-stringify": "^2.1.0",
     "lodash.clonedeep": "^4.5.0"
@@ -49,5 +50,6 @@
   ],
   "browserslist": [
     "last 1 chrome versions"
-  ]
+  ],
+  "type": "module"
 }

test/test.both.ts

@@ -0,0 +1,62 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+import * as smartjson from '../ts/index.js';
+
+class SomeClass extends smartjson.Smartjson {
+  @smartjson.foldDec() thisis: string = 'test';
+  constructor() {
+    super();
+    console.log(this.saveableProperties);
+  }
+}
+
+let mySomeClass: SomeClass;
+
+tap.test('should create a Foldable extended instance', async () => {
+  mySomeClass = new SomeClass();
+  expect(mySomeClass).toBeInstanceOf(SomeClass);
+  expect(mySomeClass).toBeInstanceOf(smartjson.Smartjson);
+});
+
+tap.test('should create a folded object', async () => {
+  let foldedObject = mySomeClass.foldToObject();
+  expect(foldedObject).property('thisis').toEqual('test');
+});
+
+tap.test('should enfold from object', async () => {
+  const mySomeClass2 = SomeClass.enfoldFromObject({ thisis: 'test2' });
+  expect(mySomeClass2).property('thisis').toEqual('test2');
+});
+
+tap.test('should products stable jsons', async () => {
+  const jsonString = smartjson.stringify({
+    a: 1,
+    f: 6,
+    b: 3,
+    c: 3,
+    e: 5,
+    d: 4,
+  });
+  console.log(jsonString);
+});
+
+tap.test('should work with base64', async() => {
+  const someObject = {
+    hi: 'there',
+    thisIs: 'awesome',
+  };
+
+  const base64Json = smartjson.stringifyBase64(someObject);
+  console.log(base64Json);
+  const decodedObject = smartjson.parseBase64(base64Json);
+  expect(decodedObject).toEqual(someObject);
+});
+
+tap.test('stringify should handle plain string', async () => {
+  const stringifiedString = smartjson.stringify('hello');
+  console.log(stringifiedString);
+  expect(stringifiedString).toEqual('"hello"')
+  expect(smartjson.parse(stringifiedString)).toEqual('hello');
+})
+
+tap.start();

test/test.ts

@@ -1,31 +0,0 @@
-import { tap, expect } from '@pushrocks/tapbundle';
-
-import { Smartjson, foldDec } from '../ts/index';
-
-class SomeClass extends Smartjson {
-  @foldDec() thisis: string = 'test';
-  constructor() {
-    super();
-    console.log(this.saveableProperties);
-  }
-}
-
-let mySomeClass: SomeClass;
-
-tap.test('should create a Foldable extended instance', async () => {
-  mySomeClass = new SomeClass();
-  expect(mySomeClass).to.be.instanceof(SomeClass);
-  expect(mySomeClass).to.be.instanceof(Smartjson);
-});
-
-tap.test('should create a folded object', async () => {
-  let foldedObject = mySomeClass.foldToObject();
-  expect(foldedObject).property('thisis').to.equal('test');
-});
-
-tap.test('should enfold from object', async () => {
-  const mySomeClass2 = SomeClass.enfoldFromObject({ thisis: 'test2' });
-  expect(mySomeClass2).property('thisis').to.equal('test2');
-});
-
-tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartjson',
+  version: '5.0.3',
+  description: 'typed json handlers'
+}

ts/index.ts

@@ -1,4 +1,4 @@
-import * as plugins from './smartjson.plugins';
+import * as plugins from './smartjson.plugins.js';
 
 /**
  * allows you to parse a json
@@ -10,12 +10,29 @@ export const parse = plugins.bufferJson.parse;
  * @param objArg
  * @param optionsArg
  */
-export const stringify = (objArg: any, optionsArg: plugins.IStableJsonTypes['Options'] = {}) => {
+export const stringify = (
+  objArg: any,
+  simpleOrderArray?: string[],
+  optionsArg: plugins.IStableJsonTypes['Options'] = {}
+): string => {
   const bufferedJson = plugins.bufferJson.stringify(objArg);
   objArg = JSON.parse(bufferedJson);
-  return plugins.stableJson(objArg, optionsArg);
+  let returnJson = plugins.stableJson(objArg, optionsArg);
+  return returnJson;
 };
 
+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);
+  return parse(simpleStringified);
+}
+
+parse
+
 export class Smartjson {
   /**
    * enfolds data from an object
@@ -49,8 +66,17 @@ export class Smartjson {
    */
   public foldToObject() {
     const newFoldedObject: { [key: string]: any } = {};
+    const trackMap = [];
     for (const keyName of this.saveableProperties) {
-      newFoldedObject[keyName] = plugins.lodashCloneDeep(this[keyName]);
+      let value = this[keyName];
+      if (value instanceof Smartjson) {
+        if (trackMap.includes(value)) {
+          throw new Error('cycle detected');
+        }
+        trackMap.push(value);
+        value = value.foldToObject();
+      }
+      newFoldedObject[keyName] = plugins.lodashCloneDeep(value);
     }
     return newFoldedObject;
   }
@@ -60,14 +86,14 @@ export class Smartjson {
    */
   public foldToJson() {
     const foldedObject = this.foldToObject();
-    return stringify(foldedObject, {});
+    return stringify(foldedObject);
   }
 }
 
 /**
  * Decorator that marks a property as foldable
  */
-export let foldDec = () => {
+export const foldDec = () => {
   return (target: any, key: string) => {
     if (!target.saveableProperties) {
       target.saveableProperties = [];
@@ -75,3 +101,9 @@ export let foldDec = () => {
     target.saveableProperties.push(key);
   };
 };
+
+export const deepEqualObjects = (object1: any, object2: any): boolean => {
+  const object1String = stringify(object1);
+  const object2String = stringify(object2);
+  return object1String === object2String;
+};

ts/smartjson.plugins.ts

@@ -1,3 +1,10 @@
+// @pushrocks scope
+import * as smartstring from '@pushrocks/smartstring';
+
+export {
+  smartstring
+}
+
 // third party scope
 import lodashCloneDeep from 'lodash.clonedeep';
 import stableJson2 from 'fast-json-stable-stringify';

tsconfig.json

@@ -1,8 +1,10 @@
 {
   "compilerOptions": {
     "experimentalDecorators": true,
-        "esModuleInterop": true,
-        "target": "es2017",
-        "module": "commonjs"
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
   }
 }

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}