4.0.1

.gitlab-ci.yml

@@ -4,7 +4,7 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
   - security
@@ -20,17 +20,19 @@ 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
 
@@ -38,38 +40,41 @@ snyk:
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
     - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
     - npmci npm install
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
     - docker
-  - notpriv
+    - priv
 
 testBuild:
   stage: test
   script:
     - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
     - npmci npm install
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
     - docker
     - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install lts
+    - npmci node install stable
     - npmci npm publish
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -81,9 +86,11 @@ codequality:
   allow_failure: true
   script:
     - npmci command npm install -g tslint typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
+    - lossless
     - docker
     - priv
 
@@ -94,18 +101,20 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - 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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojoio/cloudflare",
-  "version": "3.0.3",
+  "version": "4.0.1",
   "private": false,
   "description": "easy cloudflare management",
   "main": "dist/index.js",
@@ -24,30 +24,30 @@
   },
   "homepage": "https://gitlab.com/pushrocks/cflare#readme",
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.3",
-    "@pushrocks/smartlog": "^2.0.19",
-    "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/smartrequest": "^1.1.16",
-    "@pushrocks/smartstring": "^3.0.10",
-    "@tsclass/tsclass": "^2.0.1"
+    "@pushrocks/smartdelay": "^2.0.6",
+    "@pushrocks/smartlog": "^2.0.21",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartrequest": "^1.1.47",
+    "@pushrocks/smartstring": "^3.0.18",
+    "@tsclass/tsclass": "^3.0.4"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsbuild": "^2.1.17",
     "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/qenv": "^4.0.0",
-    "@pushrocks/tapbundle": "^3.0.11",
-    "@types/node": "^12.6.6",
-    "tslint": "^5.18.0",
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/qenv": "^4.0.6",
+    "@pushrocks/tapbundle": "^3.2.0",
+    "@types/node": "^13.7.0",
+    "tslint": "^6.0.0",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "dist_ts_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

readme.md

@@ -8,7 +8,7 @@ easy cloudflare management
 * [docs (typedoc)](https://mojoio.gitlab.io/cloudflare/)
 
 ## Status for master
-[![build status](https://gitlab.com/mojoio/cloudflare/badges/master/build.svg)](https://gitlab.com/mojoio/cloudflare/commits/master)
+[![pipeline status](https://gitlab.com/mojoio/cloudflare/badges/master/pipeline.svg)](https://gitlab.com/mojoio/cloudflare/commits/master)
 [![coverage report](https://gitlab.com/mojoio/cloudflare/badges/master/coverage.svg)](https://gitlab.com/mojoio/cloudflare/commits/master)
 [![npm downloads per month](https://img.shields.io/npm/dm/@mojoio/cloudflare.svg)](https://www.npmjs.com/package/@mojoio/cloudflare)
 [![Known Vulnerabilities](https://snyk.io/test/npm/@mojoio/cloudflare/badge.svg)](https://snyk.io/test/npm/@mojoio/cloudflare)
@@ -21,30 +21,29 @@ easy cloudflare management
 Use TypeScript for best in class instellisense.
 
 ```javascript
-import * as cflare from 'cflare'
+import * as cflare from '@mojoio/cloudflare';
 
-let myCflareAccount = new cflare.CflareAccount()
+const myCflareAccount = new cflare.CflareAccount();
 testCflareAccount.auth({
   email: 'someuser@example.com',
   key: 'someLongApiKey'
-})
+});
 
-let myAsyncCflareManagement = async () => {
+const myAsyncCflareManagement = async () => {
   // get things
-    let myZones = await myCflareAccount.listZones() // zones are fully typed
-    let myIdForADomain = await myCflareAccount.getZoneId('example.com') // type number
-    let myRecordsForADomain = await myCflareAccount.listRecords('example.com') // records are fully typed
-
-    // set things
-    myCflareAccount.updateRecord(...)
-    myCflareAccount.createRecord(...)
-    myCflareAccount.deleteRecord(...)
-}
+  const myZones = await myCflareAccount.listZones(); // zones are fully typed
+  const myIdForADomain = await myCflareAccount.getZoneId('example.com'); // type number
+  const myRecordsForADomain = await myCflareAccount.listRecords('example.com'); // records are fully typed
+};
 ```
 
+## 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.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://mojoio.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -17,11 +17,9 @@ tap.test('should create a valid instance of CloudflareAccount', async () => {
   });
 });
 
-
-
-tap.skip.test('.listZones() -> should display an entire account', async tools => {
+tap.test('.listZones() -> should display an entire account', async tools => {
   tools.timeout(600000);
-  const result = await testCloudflareAccount.listZones();
+  const result = await testCloudflareAccount.convenience.listZones();
   console.log(result);
 });
 
@@ -37,7 +35,7 @@ tap.test(
   '.listRecords(domainName) -> should list all records for a specific Domain Name',
   async tools => {
     tools.timeout(600000);
-    await testCloudflareAccount.listRecords('bleu.de').then(async responseArg => {
+    await testCloudflareAccount.convenience.listRecords('bleu.de').then(async responseArg => {
       console.log(responseArg);
     });
   }
@@ -45,19 +43,25 @@ tap.test(
 
 tap.test('should create a valid record for a subdomain', async tools => {
   tools.timeout(600000);
-  await testCloudflareAccount.createRecord(`${randomPrefix}subdomain.bleu.de`, 'A', '127.0.0.1');
+  await testCloudflareAccount.convenience.createRecord(
+    `${randomPrefix}subdomain.bleu.de`,
+    'A',
+    '127.0.0.1'
+  );
 });
 
 tap.test('should get a record from Cloudflare', async tools => {
   tools.timeout(600000);
-  await testCloudflareAccount.getRecord(`${randomPrefix}subdomain.bleu.de`, 'A').then(responseArg => {
+  await testCloudflareAccount.convenience
+    .getRecord(`${randomPrefix}subdomain.bleu.de`, 'A')
+    .then(responseArg => {
       console.log(responseArg);
     });
 });
 
 tap.test('should remove a subdomain record from Cloudflare', async tools => {
   tools.timeout(600000);
-  await testCloudflareAccount
+  await testCloudflareAccount.convenience
     .removeRecord(`${randomPrefix}subdomain.bleu.de`, 'A')
     .then(async responseArg => {
       console.log(responseArg);
@@ -65,12 +69,15 @@ tap.test('should remove a subdomain record from Cloudflare', async tools => {
 });
 
 tap.test('.purge(some.domain) -> should purge everything', async () => {
-  await testCloudflareAccount.purgeZone('bleu.de');
+  await testCloudflareAccount.convenience.purgeZone('bleu.de');
 });
 
 // WORKERS
 tap.test('should create a worker', async () => {
-  const worker = await testCloudflareAccount.workerManager.createWorker('myawesomescript', `addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })`);
+  const worker = await testCloudflareAccount.workerManager.createWorker(
+    'myawesomescript',
+    `addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })`
+  );
   await worker.setRoutes([
     {
       zoneName: 'bleu.de',

ts/cloudflare.classes.account.ts

@@ -2,7 +2,6 @@ import plugins = require('./cloudflare.plugins');
 import * as interfaces from './interfaces';
 
 // interfaces
-import { TDnsRecord } from '@tsclass/tsclass';
 import { WorkerManager } from './cloudflare.classes.workermanager';
 import { ZoneManager } from './cloudflare.classes.zonemanager';
 
@@ -23,12 +22,14 @@ export class CloudflareAccount {
     this.authKey = optionsArg.key;
   }
 
+  /**
+   * gets you the account identifier
+   */
   public async getAccountIdentifier() {
     if (!this.accountIdentifier) {
       const route = `/accounts?page=1&per_page=20&direction=desc`;
       const response: any = await this.request('GET', route);
       this.accountIdentifier = response.result[0].id;
-      // console.log('Account identifier is: ' + this.accountIdentifier);
     }
     return this.accountIdentifier;
   }
@@ -39,7 +40,7 @@ export class CloudflareAccount {
    */
   public async getZoneId(domainName: string) {
     const domain = new plugins.smartstring.Domain(domainName);
-    const zoneArray = await this.listZones(domain.zoneName);
+    const zoneArray = await this.convenience.listZones(domain.zoneName);
     const filteredResponse = zoneArray.filter(zoneArg => {
       return zoneArg.name === domainName;
     });
@@ -54,28 +55,31 @@ export class CloudflareAccount {
     }
   }
 
+  public convenience = {
     /**
      * gets a record
      * @param domainNameArg
      * @param typeArg
      */
-  public async getRecord(
+    getRecord: async (
       domainNameArg: string,
-    typeArg: TDnsRecord
-  ): Promise<interfaces.ICflareRecord> {
+      typeArg: plugins.tsclass.network.TDnsRecord
+    ): Promise<interfaces.ICflareRecord> => {
       const domain = new plugins.smartstring.Domain(domainNameArg);
-    const recordArrayArg = await this.listRecords(domain.zoneName);
+      const recordArrayArg = await this.convenience.listRecords(domain.zoneName);
       const filteredResponse = recordArrayArg.filter(recordArg => {
         return recordArg.type === typeArg && recordArg.name === domainNameArg;
       });
       return filteredResponse[0];
-  }
-
-  public async createRecord(
+    },
+    /**
+     * creates a record
+     */
+    createRecord: async (
       domainNameArg: string,
-    typeArg: TDnsRecord,
+      typeArg: plugins.tsclass.network.TDnsRecord,
       contentArg: string
-  ): Promise<any> {
+    ): Promise<any> => {
       const domain = new plugins.smartstring.Domain(domainNameArg);
       const domainIdArg = await this.getZoneId(domain.zoneName);
       const dataObject = {
@@ -89,42 +93,43 @@ export class CloudflareAccount {
         dataObject
       );
       return response;
-  }
-
+    },
     /**
      * removes a record from Cloudflare
      * @param domainNameArg
      * @param typeArg
      */
-  public async removeRecord(domainNameArg: string, typeArg: TDnsRecord): Promise<any> {
+    removeRecord: async (
+      domainNameArg: string,
+      typeArg: plugins.tsclass.network.TDnsRecord
+    ): Promise<any> => {
       const domain = new plugins.smartstring.Domain(domainNameArg);
-    const cflareRecord = await this.getRecord(domain.fullName, typeArg);
+      const cflareRecord = await this.convenience.getRecord(domain.fullName, typeArg);
       if (cflareRecord) {
         const requestRoute: string = `/zones/${cflareRecord.zone_id}/dns_records/${cflareRecord.id}`;
         return await this.request('DELETE', requestRoute);
       } else {
         throw new Error(`could not remove record for ${domainNameArg} with type ${typeArg}`);
       }
-  }
-
+    },
+    /**
+     * cleanrecord allows the cleaning of any previous records to avoid unwanted sideeffects
+     */
     /**
      * updates a record
      * @param domainNameArg
      * @param typeArg
      * @param valueArg
      */
-  public updateRecord(domainNameArg: string, typeArg: string, valueArg) {
+    updateRecord: async (domainNameArg: string, typeArg: string, valueArg) => {
       // TODO: implement
-    const done = plugins.smartpromise.defer();
       const domain = new plugins.smartstring.Domain(domainNameArg);
-    return done.promise;
-  }
-
+    },
     /**
      * list all records of a specified domain name
      * @param domainNameArg - the domain name that you want to get the records from
      */
-  public async listRecords(domainNameArg: string): Promise<interfaces.ICflareRecord[]> {
+    listRecords: async (domainNameArg: string): Promise<interfaces.ICflareRecord[]> => {
       const domain = new plugins.smartstring.Domain(domainNameArg);
       const domainId = await this.getZoneId(domain.zoneName);
       const responseArg: any = await this.request(
@@ -133,13 +138,12 @@ export class CloudflareAccount {
       );
       const result: interfaces.ICflareRecord[] = responseArg.result;
       return result;
-  }
-
+    },
     /**
      * list all zones in the associated authenticated account
      * @param domainName
      */
-  public async listZones(domainName?: string): Promise<interfaces.ICflareZone[]> {
+    listZones: async (domainName?: string): Promise<interfaces.ICflareZone[]> => {
       // TODO: handle pagination
       let requestRoute = `/zones?per_page=50`;
 
@@ -151,9 +155,11 @@ export class CloudflareAccount {
       const response: any = await this.request('GET', requestRoute);
       const result = response.result;
       return result;
-  }
-
-  public async purgeZone(domainName: string) {
+    },
+    /**
+     * purges a zone
+     */
+    purgeZone: async (domainName: string): Promise<void> => {
       const domain = new plugins.smartstring.Domain(domainName);
       const domainId = await this.getZoneId(domain.zoneName);
       const requestUrl = `/zones/${domainId}/purge_cache`;
@@ -161,7 +167,16 @@ export class CloudflareAccount {
         purge_everything: true
       };
       const respone = await this.request('DELETE', requestUrl, payload);
+    },
+    // acme convenience functions
+    acmeSetDnsChallenge: async (dnsChallenge: plugins.tsclass.network.IDnsChallenge) => {
+      await this.convenience.removeRecord(dnsChallenge.hostName, 'TXT');
+      await this.convenience.createRecord(dnsChallenge.hostName, 'TXT', dnsChallenge.challenge);
+    },
+    acmeRemoveDnsChallenge: async (dnsChallenge: plugins.tsclass.network.IDnsChallenge) => {
+      await this.convenience.removeRecord(dnsChallenge.hostName, 'TXT');
     }
+  };
 
   public request(
     methodArg: string,

ts/cloudflare.classes.worker.ts

@@ -6,11 +6,14 @@ export interface IWorkerRoute extends interfaces.ICflareWorkerRoute {
   zoneName: string;
 }
 
-export class Worker {
+export class CloudflareWorker {
   // STATIC
-  public static async fromApiObject(workerManager: WorkerManager, apiObject): Promise<Worker> {
-    const newWorker = new Worker(workerManager);
-    Object.assign(newWorker, apiObject.result);
+  public static async fromApiObject(
+    workerManager: WorkerManager,
+    apiObject
+  ): Promise<CloudflareWorker> {
+    const newWorker = new CloudflareWorker(workerManager);
+    Object.assign(newWorker, apiObject);
     await newWorker.getRoutes();
     return newWorker;
   }
@@ -35,10 +38,12 @@ export class Worker {
    * gets all routes for a worker
    */
   public async getRoutes() {
-    const zones = await this.workerManager.cfAccount.listZones();
+    const zones = await this.workerManager.cfAccount.convenience.listZones();
     for (const zone of zones) {
       const requestRoute = `/zones/${zone.id}/workers/routes`;
-      const response: {result: interfaces.ICflareWorkerRoute[]} = await this.workerManager.cfAccount.request('GET', requestRoute);
+      const response: {
+        result: interfaces.ICflareWorkerRoute[];
+      } = await this.workerManager.cfAccount.request('GET', requestRoute);
       for (const route of response.result) {
         console.log('hey');
         console.log(route);
@@ -50,7 +55,7 @@ export class Worker {
     }
   }
 
-  public async setRoutes(routeArray: Array<{zoneName: string, pattern: string}>) {
+  public async setRoutes(routeArray: Array<{ zoneName: string; pattern: string }>) {
     for (const newRoute of routeArray) {
       // lets determine wether a route is new, needs an update or already up to date.
       let routeStatus: 'new' | 'needsUpdate' | 'alreadyUpToDate' = 'new';

ts/cloudflare.classes.workermanager.ts

@@ -1,6 +1,6 @@
 import * as plugins from './cloudflare.plugins';
 import { CloudflareAccount } from './cloudflare.classes.account';
-import { Worker } from './cloudflare.classes.worker';
+import { CloudflareWorker } from './cloudflare.classes.worker';
 
 export class WorkerManager {
   public cfAccount: CloudflareAccount;
@@ -9,14 +9,14 @@ export class WorkerManager {
     this.cfAccount = cfAccountArg;
   }
 
-  public async createWorker(workerName: string, workerScript: string): Promise<Worker> {
+  public async createWorker(workerName: string, workerScript: string): Promise<CloudflareWorker> {
     const accountIdentifier = await this.cfAccount.getAccountIdentifier();
     const route = `/accounts/${accountIdentifier}/workers/scripts/${workerName}`;
     const responseBody = await this.cfAccount.request('PUT', route, workerScript, {
       'Content-Type': 'application/javascript',
       'Content-Length': Buffer.byteLength(workerScript)
     });
-    return Worker.fromApiObject(this, responseBody);
+    return CloudflareWorker.fromApiObject(this, responseBody.result);
   }
 
   /**
@@ -26,6 +26,11 @@ export class WorkerManager {
     const accountIdentifier = await this.cfAccount.getAccountIdentifier();
     const route = `/accounts/${accountIdentifier}/workers/scripts`;
     const response = await this.cfAccount.request('GET', route);
-    console.log(response);
+    const results = response.result;
+    const workers: CloudflareWorker[] = [];
+    for (const apiObject of results) {
+      workers.push(await CloudflareWorker.fromApiObject(this, apiObject));
+    }
+    return workers;
   }
 }

ts/cloudflare.classes.zone.ts

@@ -0,0 +1,6 @@
+import * as plugins from './cloudflare.plugins';
+import * as interfaces from './interfaces';
+
+export class CloudflareZone {
+  public static async createFromApiObject() {}
+}

ts/cloudflare.classes.zonemanager.ts

@@ -8,4 +8,6 @@ export class ZoneManager {
   constructor(cfAccountArg: CloudflareAccount) {
     this.cfAccount = cfAccountArg;
   }
+
+  public getZones() {}
 }

ts/index.ts

@@ -1 +1,2 @@
 export { CloudflareAccount } from './cloudflare.classes.account';
+export { CloudflareWorker } from './cloudflare.classes.worker';

tslint.json

@@ -3,7 +3,6 @@
   "rules": {
     "semicolon": [true, "always"],
     "no-console": false,
-    "no-return-await": false,
     "ordered-imports": false,
     "object-literal-sort-keys": false,
     "member-ordering": {