4.0.0

.gitignore

@@ -1,4 +1,22 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,5 +1,7 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+variables:
+  GIT_STRATEGY: clone
 
 cache:
   paths:
@@ -34,48 +36,11 @@ snyk:
   - 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
-  script:
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command npm run build
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - 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
-  - priv
-
 # ====================
 # test stage
 # ====================
 
-testLTS:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+testStable:
   stage: test
   script:
   - npmci npm prepare
@@ -85,12 +50,24 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - priv
+
+testBuild:
+  stage: test
+  script:
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - docker
   - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+  - npmci node install lts
   - npmci npm publish
   only:
   - tags
@@ -103,19 +80,11 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   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 install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
   - docker
   - priv
@@ -131,13 +100,15 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:18-dind
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - 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:
     - docker
     - notpriv

README.md

@@ -14,7 +14,7 @@ typed json handlers
 [![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/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
 
 ## Usage
 
@@ -28,8 +28,7 @@ SmartJson makes it easy to fold and enfold classes into and from JSON
 import { Smartjson, foldDec } from 'smartjson';
 
 class AwesomeClass extends Smartjson {
-  static stringify
-
+  static stringify;
 
   computedValue: string;
 
@@ -49,6 +48,6 @@ foldedObject = myAwesomeInstance.foldToObject(); // will return {anotherValueToS
 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)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

npmextra.json

@@ -3,6 +3,7 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/smartjson",
-  "version": "3.0.4",
+  "version": "4.0.0",
   "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,15 +20,30 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartjson#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tsrun": "^1.2.6",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.11",
-    "@types/node": "^12.0.12"
+    "@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": {
+    "@types/buffer-json": "^2.0.0",
     "@types/fast-json-stable-stringify": "^2.0.0",
-    "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_web/*",
+    "dist_ts_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

test/test.ts

@@ -26,8 +26,8 @@ tap.test('should create a folded object', async () => {
 });
 
 tap.test('should enfold from object', async () => {
-  mySomeClass.enfoldFromObject({ thisis: 'test2' });
-  expect(mySomeClass)
+  const mySomeClass2 = SomeClass.enfoldFromObject({ thisis: 'test2' });
+  expect(mySomeClass2)
     .property('thisis')
     .to.equal('test2');
 });

ts/index.ts

@@ -1,41 +1,66 @@
 import * as plugins from './smartjson.plugins';
 
-export class Smartjson {
-  // ======
-  // STATIC
-  // ======
-  static parse = JSON.parse;
+/**
+ * allows you to parse a json
+ */
+export const parse = plugins.bufferJson.parse;
 
-  static stringify = (objArg: any, optionsArg: plugins.stableJson.Options) => {
-    return plugins.stableJson(objArg, optionsArg)
-  };
+/**
+ * 
+ * @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
   // ========
 
-  saveableProperties: string[];
+  public saveableProperties: string[];
 
   /**
    * folds a class into an object
    */
-  foldToObject() {
-    let newFoldedObject: {[key: string]: any} = {};
-    for (let keyName of this.saveableProperties) {
+  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

@@ -1,7 +1,20 @@
+// third party scope
 import lodashCloneDeep from 'lodash.clonedeep';
-import stableJson from 'fast-json-stable-stringify';
+import stableJson2 from 'fast-json-stable-stringify';
+import bufferJson from 'buffer-json';
 
-export {
-  lodashCloneDeep,
-  stableJson
+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;
+  };
 }