5.0.0

.gitignore

@@ -1,4 +1,20 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,16 +1,19 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
@@ -18,127 +21,113 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
+  only:
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
+    - npmci command npm install --production --ignore-scripts
-    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command snyk test
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-  - docker
+    - docker
-  - notpriv
-
-sast:
-  stage: security
-  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
-  variables:
-    DOCKER_DRIVER: overlay2
   allow_failure: true
-  services:
+
-    - docker:stable-dind
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
   script:
     - npmci npm prepare
-    - npmci npm install
+    - npmci command npm install --ignore-scripts
-    - npmci command npm run build
+    - npmci command npm config set registry https://registry.npmjs.org
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - npmci command npm audit --audit-level=high --only=dev
-    - docker run
-        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
-        --volume "$PWD:/code"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
-  artifacts:
-    reports:
-      sast: gl-sast-report.json
   tags:
-  - docker
+    - docker
-  - priv
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
+
-    
+testBuild:
-testSTABLE:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
+  only:
-    - docker:stable-dind
+    - tags
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - npmci command npm install -g typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install stable 
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command npm run buildDocs
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -146,5 +135,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,54 +0,0 @@
-# @pushrocks/smartjson
-typed json handlers
-
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartjson)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartjson)
-* [github.com (source mirror)](https://github.com/pushrocks/smartjson)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartjson/)
-
-## Status for master
-[![build status](https://gitlab.com/pushrocks/smartjson/badges/master/build.svg)](https://gitlab.com/pushrocks/smartjson/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartjson/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartjson/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartjson.svg)](https://www.npmjs.com/package/@pushrocks/smartjson)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartjson/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartjson)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
-
-## Usage
-
-Use TypeScript for best in class instellisense.
-
-### Classes
-
-SmartJson makes it easy to fold and enfold classes into and from JSON
-
-```javascript
-import { Smartjson, foldDec } from 'smartjson';
-
-class AwesomeClass extends Smartjson {
-  static stringify
-
-
-  computedValue: string;
-
-  @foldDec() // mark anotherValueToStore as foldable
-  anotherValueToStore: string = null;
-  constructor() {
-    super(); // this is important
-  }
-}
-
-let myAwesomeInstance = new AwesomeClass();
-let foldedObject = myAwesomeInstance.foldToObject(); // will return {anotherValueToStore: null}
-myAwesomeInstance.enfoldFromObject({ anotherValueToStore: 'hi' });
-foldedObject = myAwesomeInstance.foldToObject(); // will return {anotherValueToStore: 'hi'}
-```
-
-For further information read the linked docs at the top of this readme.
-
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

npmextra.json

@@ -3,11 +3,12 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "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": "3.0.3",
+  "version": "5.0.0",
   "private": false,
   "description": "typed json handlers",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(tstest test/)",
+    "test": "(tstest test/ --web)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -20,15 +21,35 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartjson#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsbuild": "^2.1.63",
-    "@gitzone/tsrun": "^1.2.6",
+    "@gitzone/tsrun": "^1.2.35",
-    "@gitzone/tstest": "^1.0.20",
+    "@gitzone/tstest": "^1.0.71",
-    "@pushrocks/tapbundle": "^3.0.9",
+    "@pushrocks/tapbundle": "^5.0.3",
-    "@types/node": "^12.0.0"
+    "@types/node": "^17.0.41",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@types/fast-json-stable-stringify": "^2.0.0",
+    "@types/buffer-json": "^2.0.1",
-    "fast-json-stable-stringify": "^2.0.0",
+    "@types/fast-json-stable-stringify": "^2.1.0",
-    "lodash": "^4.17.11"
+    "buffer-json": "^2.0.0",
-  }
+    "fast-json-stable-stringify": "^2.1.0",
+    "lodash.clonedeep": "^4.5.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "type": "module"
 }

readme.md

@@ -0,0 +1,66 @@
+# @pushrocks/smartjson
+typed json handlers
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartjson)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartjson)
+* [github.com (source mirror)](https://github.com/pushrocks/smartjson)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartjson/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartjson/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartjson/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartjson)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/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/@pushrocks/smartjson)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartjson)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartjson)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+
+## Usage
+
+Use TypeScript for best in class instellisense.
+
+### Classes
+
+SmartJson makes it easy to fold and enfold classes into and from JSON
+
+```javascript
+import { Smartjson, foldDec } from 'smartjson';
+
+class AwesomeClass extends Smartjson {
+  static stringify;
+
+  computedValue: string;
+
+  @foldDec() // mark anotherValueToStore as foldable
+  anotherValueToStore: string = null;
+  constructor() {
+    super(); // this is important
+  }
+}
+
+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'}
+```
+
+## Contribution
+
+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). :)
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.both.ts

@@ -0,0 +1,43 @@
+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.start();

test/test.ts

@@ -1,35 +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 () => {
-  mySomeClass.enfoldFromObject({ thisis: 'test2' });
-  expect(mySomeClass)
-    .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.0',
+  description: 'typed json handlers'
+}

ts/index.ts

@@ -1,48 +1,87 @@
-import * as plugins from './smartjson.plugins';
+import * as plugins from './smartjson.plugins.js';
+
+/**
+ * allows you to parse a json
+ */
+export const parse = plugins.bufferJson.parse;
+
+/**
+ *
+ * @param objArg
+ * @param optionsArg
+ */
+export const stringify = (
+  objArg: any,
+  simpleOrderArray?: string[],
+  optionsArg: plugins.IStableJsonTypes['Options'] = {}
+): string => {
+  const bufferedJson = plugins.bufferJson.stringify(objArg);
+  objArg = JSON.parse(bufferedJson);
+  let returnJson = plugins.stableJson(objArg, optionsArg);
+  return returnJson;
+};
 
 export class Smartjson {
-  // ======
+  /**
-  // STATIC
+   * enfolds data from an object
-  // ======
+   */
-  static parse = JSON.parse;
+  public static enfoldFromObject(objectArg) {
+    const newInstance = new this();
+    for (const keyName in objectArg) {
+      if (newInstance.saveableProperties.indexOf(keyName) !== -1) {
+        newInstance[keyName] = objectArg[keyName];
+      }
+    }
+    return newInstance;
+  }
 
-  static stringify = (objArg: any, optionsArg: plugins.stableJson.Options) => {
+  /**
-    return plugins.stableJson(objArg, optionsArg)
+   * enfold from json
-  };
+   */
+  public static enfoldFromJson(jsonArg: string) {
+    const objectFromJson = parse(jsonArg);
+    return this.enfoldFromObject(objectFromJson);
+  }
 
   // ========
   // INSTANCE
   // ========
 
-  saveableProperties: string[];
+  public saveableProperties: string[];
 
   /**
    * folds a class into an object
    */
-  foldToObject() {
+  public foldToObject() {
-    let newFoldedObject: {[key: string]: any} = {};
+    const newFoldedObject: { [key: string]: any } = {};
-    for (let keyName of this.saveableProperties) {
+    const trackMap = [];
-      newFoldedObject[keyName] = plugins.lodash.cloneDeep(this[keyName]);
+    for (const keyName of this.saveableProperties) {
+      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;
   }
 
   /**
-   * enfolds data from an object
+   * folds a class into an object
    */
-  enfoldFromObject(objectArg) {
+  public foldToJson() {
-    for (let keyName in objectArg) {
+    const foldedObject = this.foldToObject();
-      if (this.saveableProperties.indexOf(keyName) !== -1) {
+    return stringify(foldedObject);
-        this[keyName] = objectArg[keyName];
-      }
-    }
   }
 }
 
 /**
  * Decorator that marks a property as foldable
  */
-export let foldDec = () => {
+export const foldDec = () => {
   return (target: any, key: string) => {
     if (!target.saveableProperties) {
       target.saveableProperties = [];
@@ -50,3 +89,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,7 +1,26 @@
-import * as lodash from 'lodash';
+// third party scope
-import stableJson from 'fast-json-stable-stringify';
+import lodashCloneDeep from 'lodash.clonedeep';
+import stableJson2 from 'fast-json-stable-stringify';
+import bufferJson from 'buffer-json';
 
-export {
+const stableJson = stableJson2 as any;
-  lodash,
+
-  stableJson
+export { bufferJson, lodashCloneDeep, stableJson };
+
+export interface IStableJsonTypes {
+  Comparator: (
+    a: IStableJsonTypes['CompareDescriptor'],
+    b: IStableJsonTypes['CompareDescriptor']
+  ) => number;
+  CompareDescriptor: {
+    key: string;
+    value: any;
+  };
+  Options: {
+    cmp?: (
+      a: IStableJsonTypes['CompareDescriptor'],
+      b: IStableJsonTypes['CompareDescriptor']
+    ) => number;
+    cycles?: boolean;
+  };
 }

tsconfig.json

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