1.0.13

.gitignore

@@ -1,6 +1,22 @@
 .nogit/
-node_modules/
+
+# 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,10 +1,10 @@
-# 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
@@ -20,53 +20,49 @@ mirror:
   script:
     - npmci git mirror
   tags:
+    - lossless
     - docker
     - notpriv
 
 snyk:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
   stage: security
   script:
-    - npmci command npm install -g snyk
+    - npmci npm prepare
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
+    - lossless
     - docker
     - notpriv
 
 # ====================
 # 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
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
   stage: test
   script:
+    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
+    - docker
+    - priv
+
+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:
+    - lossless
     - docker
     - notpriv
 
@@ -78,6 +74,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -86,20 +83,14 @@ 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/')
+    - 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
 
@@ -110,16 +101,20 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g npmpage
+    - npmci node install lts
-    - npmci command npmpage
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -129,13 +124,3 @@ pages:
     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
-  allow_failure: true

.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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -2,5 +2,16 @@
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartcache",
+      "shortDescription": "cache things in smart ways",
+      "npmPackagename": "@pushrocks/smartcache",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartcache",
-  "version": "1.0.8",
+  "version": "1.0.13",
   "private": false,
   "description": "cache things in smart ways",
   "main": "dist/index.js",
@@ -12,17 +12,30 @@
     "build": "(tsbuild)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.1.12",
+    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.5",
+    "@pushrocks/tapbundle": "^3.2.0",
-    "@types/node": "^10.7.1"
+    "@types/node": "^13.7.0",
+    "tslint": "^6.0.0",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.2",
+    "@pushrocks/smartdelay": "^2.0.6",
     "@pushrocks/smarterror": "^2.0.1",
-    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smarthash": "^2.1.6",
-    "@pushrocks/smarttime": "^2.0.2",
+    "@pushrocks/smartpromise": "^3.0.6",
-    "nodehash": "^1.0.4"
+    "@pushrocks/smarttime": "^3.0.12"
-  }
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -0,0 +1,31 @@
+# @pushrocks/smartcache
+cache things in smart ways
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartcache)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartcache)
+* [github.com (source mirror)](https://github.com/pushrocks/smartcache)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartcache/)
+
+## Status for master
+[![pipeline status](https://gitlab.com/pushrocks/smartcache/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartcache/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartcache/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartcache/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartcache.svg)](https://www.npmjs.com/package/@pushrocks/smartcache)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartcache/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartcache)
+[![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-prettier-ff69b4.svg)](https://prettier.io/)
+
+## Usage
+
+
+## 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.ts

@@ -1,48 +1,48 @@
-import { expect, tap } from "@pushrocks/tapbundle";
+import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartcache from "../ts/index";
+import * as smartcache from '../ts/index';
-import * as smartdelay from "@pushrocks/smartdelay";
+import * as smartdelay from '@pushrocks/smartdelay';
 
 let smartcacheInstance: smartcache.SmartCache;
 
-tap.test("should create a valid instance of SmartCache", async () => {
+tap.test('should create a valid instance of SmartCache', async () => {
   smartcacheInstance = new smartcache.SmartCache();
   expect(smartcacheInstance).to.be.instanceof(smartcache.SmartCache);
 });
 
-tap.test("try to get async responses", async () => {
+tap.test('try to get async responses', async () => {
   const getResponse = async () => {
     const response = await smartcacheInstance
       .cacheReturn(async () => {
-        console.log("function ran");
+        console.log('function 1 ran');
-        return "hello";
+        return 'hello';
       }, 1000)
       .catch(err => {
         console.log(err);
       });
-    console.log("response is:");
+    console.log('response is:');
     console.log(response);
   };
 
   const getResponse2 = async () => {
     const response = await smartcacheInstance
       .cacheReturn(async () => {
-        console.log("function 2 ran");
+        console.log('function 2 ran');
-        return "hello";
+        return 'hello there!';
       }, 1000)
       .catch(err => {
         console.log(err);
       });
-    console.log("response is:");
+    console.log('response is:');
     console.log(response);
   };
 
-  getResponse();
+  await getResponse();
-  getResponse();
+  await getResponse();
-  getResponse2();
+  await getResponse2();
-  getResponse2();
+  await getResponse2();
-  smartdelay.delayFor(1000).then(() => {
+  await smartdelay.delayFor(2000).then(async () => {
-    getResponse();
+    await getResponse();
-    // getResponse2();
+    await getResponse2();
   });
 });
 

ts/smartcache.classes.smartcache.ts

@@ -5,8 +5,8 @@ export class SmartCache {
   private _cacheManager = new CacheManager();
 
   async cacheReturn(asyncCachedFuncArg: () => Promise<any>, cacheDuration: number = 5000) {
-    let callStack: string = new plugins.smarterror.SmartError('').cleanFullStack;
+    const callStack: string = new plugins.smarterror.SmartError('Cache Creation Point').cleanFullStack.split('\n')[2];
-    let callHash = plugins.nodehash.sha256FromStringSync(callStack);
+    const callHash = plugins.smarthash.sha256FromStringSync(callStack);
 
     // console.log(callHash);
     if (
@@ -17,7 +17,7 @@ export class SmartCache {
       return this._cacheManager.getCache(callHash).cachedObject;
     } else {
       this._cacheManager.announceCache(callHash, cacheDuration);
-      let newCachedObject = await asyncCachedFuncArg();
+      const newCachedObject = await asyncCachedFuncArg();
       this._cacheManager.setCache(callHash, newCachedObject, cacheDuration);
       return newCachedObject;
     }

ts/smartcache.plugins.ts

@@ -2,6 +2,6 @@ import * as smartdelay from '@pushrocks/smartdelay';
 import * as smarterror from '@pushrocks/smarterror';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smarttime from '@pushrocks/smarttime';
-import * as nodehash from 'nodehash';
+import * as smarthash from '@pushrocks/smarthash';
 
-export { smarterror, smartdelay, smartpromise, smarttime, nodehash };
+export { smarterror, smartdelay, smartpromise, smarttime, smarthash };

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"
 }