3.0.3

.gitignore

@@ -1,5 +1,22 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
 public/
 pages/
-.nogit/
+
+# 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,62 +20,27 @@ mirror:
   script:
     - npmci git mirror
   tags:
+    - lossless
     - docker
     - notpriv
 
 snyk:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
+    - lossless
     - 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
@@ -84,6 +49,20 @@ testSTABLE:
     - 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
 
@@ -95,6 +74,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -103,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
 
@@ -127,18 +101,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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,24 +1,19 @@
-# smartacme
+# @pushrocks/smartuniverse
+acme with an easy yet powerful interface in TypeScript
 
-acme implementation in TypeScript
+## Availabililty and Links
-
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
-## Availabililty
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartuniverse)
-
+* [github.com (source mirror)](https://github.com/pushrocks/smartuniverse)
-[![npm](https://umbrellazone.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartacme)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartuniverse/)
-[![git](https://umbrellazone.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/umbrellazone/smartacme)
-[![git](https://umbrellazone.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/umbrellazone/smartacme)
-[![docs](https://umbrellazone.gitlab.io/assets/repo-button-docs.svg)](https://umbrellazone.gitlab.io/smartacme/)
 
 ## Status for master
-
+[![build status](https://gitlab.com/pushrocks/smartuniverse/badges/master/build.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
-[![build status](https://GitLab.com/umbrellazone/smartacme/badges/master/build.svg)](https://GitLab.com/umbrellazone/smartacme/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartuniverse/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
-[![coverage report](https://GitLab.com/umbrellazone/smartacme/badges/master/coverage.svg)](https://GitLab.com/umbrellazone/smartacme/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartuniverse.svg)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartacme.svg)](https://www.npmjs.com/package/smartacme)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartuniverse/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartuniverse)
-[![Dependency Status](https://david-dm.org/umbrellazone/smartacme.svg)](https://david-dm.org/umbrellazone/smartacme)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![bitHound Dependencies](https://www.bithound.io/github/umbrellazone/smartacme/badges/dependencies.svg)](https://www.bithound.io/github/umbrellazone/smartacme/master/dependencies/npm)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![bitHound Code](https://www.bithound.io/github/umbrellazone/smartacme/badges/code.svg)](https://www.bithound.io/github/umbrellazone/smartacme)
-[![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
@@ -28,36 +23,14 @@ Use TypeScript for best in class instellisense.
 ```javascript
 import { SmartAcme } from 'smartacme';
 
-let smac = new SmartAcme()(async () => {
+let smac = new SmartAcme()
-  // learn async/await, it'll make your life easier
 
-  // optionally accepts a filePath Arg with a stored acmeaccount.json
+// TODO
-  // will create an account and
-  let myAccount = await smac.createAcmeAccount();
-
-  // will return a dnsHash to set in your DNS record
-  let myCert = await myAccount.createAcmeCert('example.com');
-
-  // gets and accepts the specified challenge
-  // first argument optional, defaults to dns-01 (which is the cleanest method for production use)
-  let myChallenge = await myCert.getChallenge('dns-01');
-
-  /* ----------
-    Now you need to set the challenge in your DNS
-    myChallenge.domainNamePrefixed is the address for the record
-    myChallenge.dnsKeyHash is the ready to use txt record value expected by letsencrypt
-    -------------*/
-})();
 ```
 
-## Other relevant npm modules
+For further information read the linked docs at the top of this readme.
-
-| module name | description                                                         |
-| ----------- | ------------------------------------------------------------------- |
-| cert        | a higlevel production module that uses smartacme to manage certs    |
-| smartnginx  | a highlevel production tool for docker environments to manage nginx |
 
 > 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.html)
 
-[![repo-footer](https://umbrellazone.gitlab.io/assets/repo-footer.svg)](https://umbrella.zone
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

npmextra.json

@@ -1,4 +1,16 @@
 {
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartuniverse",
+      "shortDescription": "acme with an easy yet powerful interface in TypeScript",
+      "npmPackagename": "@pushrocks/smartuniverse",
+      "license": "MIT",
+      "projectDomain": "push.rocks"
+    }
+  },
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@pushrocks/smartacme",
-  "version": "2.0.12",
+  "version": "3.0.3",
   "private": false,
-  "description": "acme implementation in TypeScript",
+  "description": "acme with an easy yet powerful interface in TypeScript",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
@@ -25,26 +25,40 @@
   },
   "homepage": "https://gitlab.com/umbrellazone/smartacme#README",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.4",
+    "@pushrocks/lik": "^3.0.19",
-    "@pushrocks/smartdata": "^3.1.13",
+    "@pushrocks/smartdata": "^3.1.26",
-    "@pushrocks/smartdelay": "^2.0.2",
+    "@pushrocks/smartdelay": "^2.0.6",
-    "@pushrocks/smartdns": "^3.0.8",
+    "@pushrocks/smartdns": "^4.0.2",
-    "@pushrocks/smartexpress": "^3.0.0",
+    "@pushrocks/smartexpress": "^3.0.57",
-    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smartlog": "^2.0.21",
-    "@pushrocks/smartrequest": "^1.1.14",
+    "@pushrocks/smartpromise": "^3.0.6",
-    "@pushrocks/smarttime": "^3.0.5",
+    "@pushrocks/smartrequest": "^1.1.47",
+    "@pushrocks/smartstring": "^3.0.18",
+    "@pushrocks/smarttime": "^3.0.12",
     "@pushrocks/smartunique": "^3.0.1",
-    "acme-client": "^2.2.2"
+    "@tsclass/tsclass": "^3.0.7",
+    "acme-client": "^3.3.1"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.4",
+    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.1.17",
+    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.18",
+    "@gitzone/tstest": "^1.0.28",
-    "@mojoio/cloudflare": "^2.0.0",
+    "@mojoio/cloudflare": "^4.0.3",
-    "@pushrocks/qenv": "^3.0.2",
+    "@pushrocks/qenv": "^4.0.6",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.2.0",
-    "@types/node": "^10.12.18",
+    "@types/node": "^13.7.2",
-    "tslint": "^5.12.0",
+    "tslint": "^6.0.0",
-    "tslint-config-prettier": "^1.17.0"
+    "tslint-config-prettier": "^1.18.0"
-  }
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

test/test.ts

@@ -1,7 +1,12 @@
 import { tap, expect } from '@pushrocks/tapbundle';
 import { Qenv } from '@pushrocks/qenv';
+import * as cloudflare from '@mojoio/cloudflare';
 
 const testQenv = new Qenv('./', './.nogit/');
+const testCloudflare = new cloudflare.CloudflareAccount({
+  email: testQenv.getEnvVarOnDemand('CF_EMAIL'),
+  key: testQenv.getEnvVarOnDemand('CF_KEY')
+});
 
 import * as smartacme from '../ts/index';
 
@@ -11,20 +16,35 @@ tap.test('should create a valid instance of SmartAcme', async () => {
   smartAcmeInstance = new smartacme.SmartAcme({
     accountEmail: 'domains@lossless.org',
     accountPrivateKey: null,
-    removeChallenge: async (...args) => {
-      console.log(args);
-    },
-    setChallenge: async (...args) => {
-      console.log(args);
-    },
     mongoDescriptor: {
-      mongoDbName: testQenv.getEnvVarOnDemand('MONGODB_DATABASE'),
+      mongoDbName: testQenv.getEnvVarRequired('MONGODB_DATABASE'),
-      mongoDbPass: testQenv.getEnvVarOnDemand('MONGODB_PASSWORD'),
+      mongoDbPass: testQenv.getEnvVarRequired('MONGODB_PASSWORD'),
-      mongoDbUrl: testQenv.getEnvVarOnDemand('MONGODB_URL')
+      mongoDbUrl: testQenv.getEnvVarRequired('MONGODB_URL')
-    }
+    },
+    removeChallenge: async (dnsChallenge) => {
+      testCloudflare.convenience.acmeRemoveDnsChallenge(dnsChallenge);
+    },
+    setChallenge: async (dnsChallenge) => {
+      testCloudflare.convenience.acmeSetDnsChallenge(dnsChallenge);
+    },
+    environment: 'integration'
   });
   await smartAcmeInstance.init();
+});
+
+tap.test('should get a domain certificate', async () => {
   await smartAcmeInstance.getCertificateForDomain('bleu.de');
 });
 
+tap.test('certmatcher should correctly match domains', async () => {
+  const certMatcherMod = await import('../ts/smartacme.classes.certmatcher');
+  const certMatcher = new certMatcherMod.CertMatcher();
+  const matchedCert = certMatcher.getCertificateDomainNameByDomainName('level3.level2.level1');
+  expect(matchedCert).to.equal('level2.level1');
+});
+
+tap.test('should stop correctly', async () => {
+  await smartAcmeInstance.stop();
+});
+
 tap.start();

ts/index.ts

@@ -1,3 +1 @@
 export * from './smartacme.classes.smartacme';
-
-export * from './smartacme.classes.certremoteclient';

ts/smartacme.classes.cert.ts

@@ -1,4 +1,7 @@
 import * as plugins from './smartacme.plugins';
+
+import * as interfaces from './interfaces';
+
 import { CertManager } from './smartacme.classes.certmanager';
 
 import { Collection, svDb, unI } from '@pushrocks/smartdata';
@@ -6,29 +9,54 @@ import { Collection, svDb, unI } from '@pushrocks/smartdata';
 @plugins.smartdata.Collection(() => {
   return CertManager.activeDB;
 })
-export class Cert extends plugins.smartdata.SmartDataDbDoc<Cert> {
+export class Cert extends plugins.smartdata.SmartDataDbDoc<Cert, plugins.tsclass.network.ICert> implements plugins.tsclass.network.ICert {
   @unI()
-  public index: string;
+  public id: string;
 
   @svDb()
-  domainName: string;
+  public domainName: string;
 
   @svDb()
-  created: number;
+  public created: number;
 
   @svDb()
-  privateKey: string;
+  public privateKey: string;
 
   @svDb()
-  publicKey: string;
+  public publicKey: string;
 
   @svDb()
-  csr: string;
+  public csr: string;
 
-  constructor(privateKeyArg: string, publicKeyArg: string, csrArg: string) {
+  @svDb()
+  public validUntil: number;
+
+  public isStillValid(): boolean {
+    return this.validUntil >= Date.now();
+  }
+
+  public shouldBeRenewed(): boolean {
+    const shouldBeValidAtLeastUntil =
+      Date.now() +
+      plugins.smarttime.getMilliSecondsFromUnits({
+        days: 10
+      });
+    return !(this.validUntil >= shouldBeValidAtLeastUntil);
+  }
+
+  public update(certDataArg: plugins.tsclass.network.ICert) {
+    Object.keys(certDataArg).forEach(key => {
+      this[key] = certDataArg[key];
+    });
+  }
+
+
+  constructor(optionsArg: plugins.tsclass.network.ICert) {
     super();
-    this.privateKey = privateKeyArg;
+    if (optionsArg) {
-    this.publicKey = publicKeyArg;
+      Object.keys(optionsArg).forEach(key => {
-    this.csr = csrArg;
+        this[key] = optionsArg[key];
+      });
+    }
   }
 }

ts/smartacme.classes.certmanager.ts

@@ -1,6 +1,8 @@
 import * as plugins from './smartacme.plugins';
 import { Cert } from './smartacme.classes.cert';
+import { SmartAcme } from './smartacme.classes.smartacme';
 
+import * as interfaces from './interfaces';
 
 export class CertManager {
   // =========
@@ -8,33 +10,41 @@ export class CertManager {
   // =========
   public static activeDB: plugins.smartdata.SmartdataDb;
 
-  
   // =========
   // INSTANCE
   // =========
   private mongoDescriptor: plugins.smartdata.IMongoDescriptor;
   public smartdataDb: plugins.smartdata.SmartdataDb;
 
-  constructor(optionsArg: {
+  public interestMap: plugins.lik.InterestMap<string, Cert>;
+
+  constructor(
+    smartAcmeArg: SmartAcme,
+    optionsArg: {
       mongoDescriptor: plugins.smartdata.IMongoDescriptor;
-  }) {
+    }
+  ) {
     this.mongoDescriptor = optionsArg.mongoDescriptor;
   }
 
   public async init() {
+    // Smartdata DB
     this.smartdataDb = new plugins.smartdata.SmartdataDb(this.mongoDescriptor);
     await this.smartdataDb.init();
     CertManager.activeDB = this.smartdataDb;
-  };
+
+    // Pending Map
+    this.interestMap = new plugins.lik.InterestMap((certName) => certName);
+  }
 
   /**
    * retrieves a certificate
    * @returns the Cert class or null
-   * @param domainName the domain Name to retrieve the vcertificate for
+   * @param certDomainNameArg the domain Name to retrieve the vcertificate for
    */
-  public async retrieveCertificate(domainName: string): Promise<Cert> {
+  public async retrieveCertificate(certDomainNameArg: string): Promise<Cert> {
     const existingCertificate: Cert = await Cert.getInstance({
-      name: domainName
+      domainName: certDomainNameArg
     });
 
     if (existingCertificate) {
@@ -42,26 +52,26 @@ export class CertManager {
     } else {
       return null;
     }
-
   }
 
   /**
-   * stores the certificate with the 
+   * stores the certificate
-   * @param publicKeyArg 
+   * @param optionsArg
-   * @param privateKeyArg 
-   * @param csrArg 
    */
-  public async storeCertificate(privateKeyArg: string, publicKeyArg: string, csrArg: string) {
+  public async storeCertificate(optionsArg: plugins.tsclass.network.ICert) {
-    const cert = new Cert(privateKeyArg, publicKeyArg, csrArg);
+    const cert = new Cert(optionsArg);
-    cert.save();
+    await cert.save();
-  };
+    const interest = this.interestMap.findInterest(cert.domainName);
-
+    if (interest) {
-  public async deleteCertificate(domainName: string) {
+      interest.fullfillInterest(cert);
-
+      interest.markLost();
-  };
+    }
-
+  }
-  /**
+
-   * checks all certs for expiration
+  public async deleteCertificate(certDomainNameArg: string) {
-   */
+    const cert: Cert = await Cert.getInstance({
-  checkCerts() {}
+      domainName: certDomainNameArg
+    });
+    await cert.delete();
+  }
 }

ts/smartacme.classes.certmatcher.ts

@@ -0,0 +1,19 @@
+import * as plugins from './smartacme.plugins';
+import * as interfaces from './interfaces';
+
+/**
+ * certmatcher is responsible for matching certificates
+ */
+export class CertMatcher {
+  /**
+   * creates a domainName for the certificate that will include the broadest scope
+   * for wild card certificates
+   * @param domainNameArg the domainNameArg to create the scope from
+   */
+  public getCertificateDomainNameByDomainName(domainNameArg: string): string {
+    const originalDomain = new plugins.smartstring.Domain(domainNameArg);
+    if (!originalDomain.level4) {
+      return `${originalDomain.level2}.${originalDomain.level1}`;
+    }
+  }
+}

ts/smartacme.classes.certremoteclient.ts

@@ -1,10 +0,0 @@
-import * as plugins from './smartacme.plugins';
-
-export class CertRemoteClient {
-  constructor(optionsArg: {
-    remoteUrl: string;
-    secret: string;
-  }) {
-    
-  }
-}

ts/smartacme.classes.certremotehandler.ts

@@ -1,3 +0,0 @@
-import * as plugins from './smartacme.plugins';
-
-export class CertRemoteHandler {}

ts/smartacme.classes.smartacme.ts

@@ -1,53 +1,87 @@
 import * as plugins from './smartacme.plugins';
+import { Cert } from './smartacme.classes.cert';
 import { CertManager } from './smartacme.classes.certmanager';
-import { CertRemoteHandler } from './smartacme.classes.certremotehandler';
+import { CertMatcher } from './smartacme.classes.certmatcher';
 
 /**
- *
+ * the options for the class @see SmartAcme
  */
 export interface ISmartAcmeOptions {
   accountPrivateKey?: string;
   accountEmail: string;
-  setChallenge: (domainName: string, keyAuthorization: string) => Promise<any>;
-  removeChallenge: (domainName: string) => Promise<any>;
   mongoDescriptor: plugins.smartdata.IMongoDescriptor;
+  setChallenge: (dnsChallengeArg: plugins.tsclass.network.IDnsChallenge) => Promise<any>;
+  removeChallenge: (dnsChallengeArg: plugins.tsclass.network.IDnsChallenge) => Promise<any>;
+  environment: 'production' | 'integration';
+  logger?: plugins.smartlog.Smartlog;
 }
 
+/**
+ * class SmartAcme
+ * can be used for setting up communication with an ACME authority
+ *
+ * ```ts
+ * const mySmartAcmeInstance = new SmartAcme({
+ *  // see ISmartAcmeOptions for options
+ * })
+ * ```
+ */
 export class SmartAcme {
   private options: ISmartAcmeOptions;
 
   // the acme client
   private client: any;
-  private smartdns = new plugins.smartdns.Smartdns();
+  private smartdns = new plugins.smartdns.Smartdns({});
+  public logger: plugins.smartlog.Smartlog;
 
   // the account private key
   private privateKey: string;
 
   // challenge fullfillment
-  private setChallenge: (domainName: string, keyAuthorization: string) => Promise<any>;
+  private setChallenge: (dnsChallengeArg: plugins.tsclass.network.IDnsChallenge) => Promise<any>;
-  private removeChallenge: (domainName: string) => Promise<any>;
+  private removeChallenge: (dnsChallengeArg: plugins.tsclass.network.IDnsChallenge) => Promise<any>;
 
   // certmanager
   private certmanager: CertManager;
-  private certremoteHandler: CertRemoteHandler;
+  private certmatcher: CertMatcher;
 
   constructor(optionsArg: ISmartAcmeOptions) {
     this.options = optionsArg;
+    this.options.logger
+      ? (this.logger = optionsArg.logger)
+      : (this.logger = plugins.smartlog.defaultLogger);
   }
 
+  /**
+   * inits the instance
+   * ```ts
+   * await myCloudlyInstance.init() // does not support options
+   * ```
+   */
   public async init() {
-    this.privateKey = this.options.accountPrivateKey || (await plugins.acme.forge.createPrivateKey());
+    this.privateKey =
+      this.options.accountPrivateKey || (await plugins.acme.forge.createPrivateKey()).toString();
     this.setChallenge = this.options.setChallenge;
     this.removeChallenge = this.options.removeChallenge;
 
-    this.certmanager = new CertManager({
+    // CertMangaer
+    this.certmanager = new CertManager(this, {
       mongoDescriptor: this.options.mongoDescriptor
     });
     await this.certmanager.init();
-    this.certremoteHandler = new CertRemoteHandler();
 
+    // CertMatcher
+    this.certmatcher = new CertMatcher();
+
+    // ACME Client
     this.client = new plugins.acme.Client({
-      directoryUrl: plugins.acme.directory.letsencrypt.staging,
+      directoryUrl: (() => {
+        if (this.options.environment === 'production') {
+          return plugins.acme.directory.letsencrypt.production;
+        } else {
+          return plugins.acme.directory.letsencrypt.staging;
+        }
+      })(),
       accountKey: this.privateKey
     });
 
@@ -58,18 +92,51 @@ export class SmartAcme {
     });
   }
 
-  public async getCertificateForDomain(domainArg: string) {
+  public async stop() {
-    const domain = domainArg;
+    await this.certmanager.smartdataDb.close();
-
-    const retrievedCertificate = await this.certmanager.retrieveCertificate(domain);
-
-    if(retrievedCertificate) {
-      return retrievedCertificate;
   }
 
+  /**
+   * gets a certificate
+   * it runs through the following steps
+   *
+   * * look in the database
+   * * if in the database and still valid return it
+   * * if not in the database announce it
+   * * then get it from letsencrypt
+   * * store it
+   * * remove it from the pending map (which it go onto by announcing it)
+   * * retrieve it from the databse and return it
+   *
+   * @param domainArg
+   */
+  public async getCertificateForDomain(domainArg: string): Promise<Cert> {
+    const certDomainName = this.certmatcher.getCertificateDomainNameByDomainName(domainArg);
+    const retrievedCertificate = await this.certmanager.retrieveCertificate(certDomainName);
+
+    const shouldberenewed = retrievedCertificate.shouldBeRenewed();
+    const isStillValid = retrievedCertificate.isStillValid();
+
+    if (!retrievedCertificate && await this.certmanager.interestMap.checkInterest(certDomainName)) {
+      const existingCertificateInterest = this.certmanager.interestMap.findInterest(certDomainName);
+      const certificate = existingCertificateInterest.interestFullfilled;
+      return certificate;
+    } else if (retrievedCertificate && !retrievedCertificate.shouldBeRenewed()) {
+      return retrievedCertificate;
+    } else if (retrievedCertificate && retrievedCertificate.shouldBeRenewed()) {
+      // await retrievedCertificate.delete();
+    }
+
+    // lets make sure others get the same interest
+    await this.certmanager.interestMap.addInterest(certDomainName);
+    
+
     /* Place new order */
     const order = await this.client.createOrder({
-      identifiers: [{ type: 'dns', value: domain }, { type: 'dns', value: `*.${domain}` }]
+      identifiers: [
+        { type: 'dns', value: certDomainName },
+        { type: 'dns', value: `*.${certDomainName}` }
+      ]
     });
 
     /* Get authorizations and select challenges */
@@ -77,7 +144,7 @@ export class SmartAcme {
 
     for (const authz of authorizations) {
       console.log(authz);
-      const domainDnsName: string = `_acme-challenge.${authz.identifier.value}`;
+      const fullHostName: string = `_acme-challenge.${authz.identifier.value}`;
       const dnsChallenge: string = authz.challenges.find(challengeArg => {
         return challengeArg.type === 'dns-01';
       });
@@ -86,8 +153,13 @@ export class SmartAcme {
 
       try {
         /* Satisfy challenge */
-        await this.setChallenge(domainDnsName, keyAuthorization);
+        await this.setChallenge({
-        await this.smartdns.checkUntilAvailable(domainDnsName, 'TXT', keyAuthorization, 100, 5000);
+          hostName: fullHostName,
+          challenge: keyAuthorization
+        });
+        await this.smartdns.checkUntilAvailable(fullHostName, 'TXT', keyAuthorization, 100, 5000);
+        console.log('Cool down an extra 60 second for region availability');
+        await plugins.smartdelay.delayFor(60000);
 
         /* Verify that challenge is satisfied */
         await this.client.verifyChallenge(authz, dnsChallenge);
@@ -100,7 +172,10 @@ export class SmartAcme {
       } finally {
         /* Clean up challenge response */
         try {
-          await this.removeChallenge(domainDnsName);
+          await this.removeChallenge({
+            hostName: fullHostName,
+            challenge: keyAuthorization
+          });
         } catch (e) {
           console.log(e);
         }
@@ -109,20 +184,30 @@ export class SmartAcme {
 
     /* Finalize order */
     const [key, csr] = await plugins.acme.forge.createCsr({
-      commonName: `*.${domain}`,
+      commonName: `*.${certDomainName}`,
-      altNames: [domain]
+      altNames: [certDomainName]
     });
 
     await this.client.finalizeOrder(order, csr);
     const cert = await this.client.getCertificate(order);
 
     /* Done */
-    console.log(`CSR:\n${csr.toString()}`);
-    console.log(`Private key:\n${key.toString()}`);
-    console.log(`Certificate:\n${cert.toString()}`);
 
-    this.certmanager.storeCertificate(key.toString(), cert.toString(), csr.toString());
+    await this.certmanager.storeCertificate({
-  }
+      id: plugins.smartunique.shortId(),
+      domainName: certDomainName,
+      privateKey: key.toString(),
+      publicKey: cert.toString(),
+      csr: csr.toString(),
+      created: Date.now(),
+      validUntil:
+        Date.now() +
+        plugins.smarttime.getMilliSecondsFromUnits({
+          days: 90
+        })
+    });
 
-  toStorageObject() {}
+    const newCertificate = await this.certmanager.retrieveCertificate(certDomainName);
+    return newCertificate;
+  }
 }

ts/smartacme.plugins.ts

@@ -4,14 +4,35 @@ import * as smartdata from '@pushrocks/smartdata';
 import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartdns from '@pushrocks/smartdns';
 import * as smartexpress from '@pushrocks/smartexpress';
+import * as smartlog from '@pushrocks/smartlog';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartrequest from '@pushrocks/smartrequest';
 import * as smartunique from '@pushrocks/smartunique';
+import * as smartstring from '@pushrocks/smartstring';
 import * as smarttime from '@pushrocks/smarttime';
 
-export { lik, smartdata, smartdelay, smartdns, smartexpress, smartpromise, smartrequest, smartunique, smarttime };
+export {
+  lik,
+  smartdata,
+  smartdelay,
+  smartdns,
+  smartexpress,
+  smartlog,
+  smartpromise,
+  smartrequest,
+  smartunique,
+  smartstring,
+  smarttime
+};
 
-// thirs party scope
+// @tsclass scope
+import * as tsclass from '@tsclass/tsclass';
+
+export {
+  tsclass
+}
+
+// third party scope
 import * as acme from 'acme-client';
 
 export { acme };