4.0.1

.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,16 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,109 +18,114 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
+  only:
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-  - docker
-  - notpriv
+    - docker
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+    - docker
+
+testBuild:
   stage: test
   script:
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - docker
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
+  only:
+    - tags
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --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]
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -128,15 +133,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
-  allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
+      - public
   allow_failure: true

.snyk

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

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "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"
+    }
+  ]
+}

.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,56 +0,0 @@
-# smartjson
-
-typed json handlers
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartjson)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartjson)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartjson)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](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/smartjson.svg)](https://www.npmjs.com/package/smartjson)
-[![Dependency Status](https://david-dm.org/pushrocks/smartjson.svg)](https://david-dm.org/pushrocks/smartjson)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartjson/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartjson/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartjson/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartjson)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.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 { Foldable, foldDec } from 'smartjson';
-
-class AwesomeClass extends Foldable {
-  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://push.rocks)

npmextra.json

@@ -1,5 +1,16 @@
 {
   "npmci": {
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartjson",
+      "shortDescription": "typed json handlers",
+      "npmPackagename": "@pushrocks/smartjson",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/smartjson",
-  "version": "2.0.2",
+  "version": "4.0.1",
   "private": false,
   "description": "typed json handlers",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -20,13 +20,34 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartjson#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tsrun": "^1.1.12",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.1",
-    "@types/node": "^10.9.4"
+    "@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"
   },
   "dependencies": {
-    "lodash": "^4.17.10"
-  }
+    "@types/buffer-json": "^2.0.0",
+    "@types/fast-json-stable-stringify": "^2.0.0",
+    "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"
+  ]
 }

test/test.ts

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

ts/index.ts

@@ -1,28 +1,66 @@
-let lodash = require('lodash');
+import * as plugins from './smartjson.plugins';
 
-export class Foldable {
-  saveableProperties: string[];
+/**
+ * allows you to parse a json
+ */
+export const parse = plugins.bufferJson.parse;
+
+/**
+ *
+ * @param objArg
+ * @param optionsArg
+ */
+export const stringify = (objArg: any, optionsArg: plugins.IStableJsonTypes['Options'] = {}) => {
+  const bufferedJson = plugins.bufferJson.stringify(objArg);
+  objArg = JSON.parse(bufferedJson);
+  return plugins.stableJson(objArg, optionsArg);
+};
+
+export class Smartjson {
+  /**
+   * enfolds data from an object
+   */
+  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;
+  }
+
+  /**
+   * enfold from json
+   */
+  public static enfoldFromJson(jsonArg: string) {
+    const objectFromJson = parse(jsonArg);
+    return this.enfoldFromObject(objectFromJson);
+  }
+
+  // ========
+  // INSTANCE
+  // ========
+
+  public saveableProperties: string[];
 
   /**
    * folds a class into an object
    */
-  foldToObject() {
-    let newFoldedObject = {};
-    for (let keyName of this.saveableProperties) {
-      newFoldedObject[keyName] = lodash.cloneDeep(this[keyName]);
+  public foldToObject() {
+    const newFoldedObject: { [key: string]: any } = {};
+    for (const keyName of this.saveableProperties) {
+      newFoldedObject[keyName] = plugins.lodashCloneDeep(this[keyName]);
     }
     return newFoldedObject;
   }
 
   /**
-   * enfolds data from an object
+   * folds a class into an object
    */
-  enfoldFromObject(objectArg) {
-    for (let keyName in objectArg) {
-      if (this.saveableProperties.indexOf(keyName) !== -1) {
-        this[keyName] = objectArg[keyName];
-      }
-    }
+  public foldToJson() {
+    const foldedObject = this.foldToObject();
+    return stringify(foldedObject, {});
   }
 }
 

ts/smartjson.plugins.ts

@@ -0,0 +1,26 @@
+// 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 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,7 +1,8 @@
 {
     "compilerOptions": {
         "experimentalDecorators": true,
-        "target": "es2016",
+        "esModuleInterop": true,
+        "target": "es2017",
         "module": "commonjs"
     }
 }

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "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"
 }