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
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -19,63 +19,41 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - 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
+
+auditDevDependencies:
+  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 --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
     - 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:
+testStable:
-  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:
   stage: test
   script:
     - npmci npm prepare
@@ -85,7 +63,17 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
-  - notpriv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
 
 release:
   stage: release
@@ -95,6 +83,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -103,20 +92,16 @@ release:
 # ====================
 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 tslint typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --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:
+    - lossless
     - docker
     - priv
 
@@ -127,18 +112,20 @@ trigger:
   only:
     - tags
   tags:
+    - 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:

.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,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,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.1",
+  "version": "4.0.1",
   "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)"
   },
   "repository": {
     "type": "git",
@@ -20,15 +20,34 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartjson#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.8",
+    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsrun": "^1.1.17",
+    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.18",
+    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.2.9",
-    "@types/node": "^11.9.4"
+    "@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",
-    "lodash": "^4.17.11"
+    "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

@@ -20,16 +20,12 @@ tap.test('should create a Foldable extended instance', async () => {
 
 tap.test('should create a folded object', async () => {
   let foldedObject = mySomeClass.foldToObject();
-  expect(foldedObject)
+  expect(foldedObject).property('thisis').to.equal('test');
-    .property('thisis')
-    .to.equal('test');
 });
 
 tap.test('should enfold from object', async () => {
-  mySomeClass.enfoldFromObject({ thisis: 'test2' });
+  const mySomeClass2 = SomeClass.enfoldFromObject({ thisis: 'test2' });
-  expect(mySomeClass)
+  expect(mySomeClass2).property('thisis').to.equal('test2');
-    .property('thisis')
-    .to.equal('test2');
 });
 
 tap.start();

ts/index.ts

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

ts/smartjson.plugins.ts

@@ -1,7 +1,26 @@
-import * as lodash from 'lodash';
+// third party scope
-import * as 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,7 +1,8 @@
 {
     "compilerOptions": {
         "experimentalDecorators": true,
-        "target": "es2016",
+        "esModuleInterop": true,
+        "target": "es2017",
         "module": "commonjs"
     }
 }