5.0.3

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -18,60 +18,65 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - 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:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - priv
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci command npm run build
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -81,31 +86,35 @@ 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:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - 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:
@@ -113,5 +122,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   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

@@ -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.4",
+  "version": "5.0.3",
   "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/smartdelay": "^2.0.6",
-    "@pushrocks/smartlog": "^2.0.19",
+    "@pushrocks/smartlog": "^2.0.21",
-    "@pushrocks/smartpromise": "^3.0.2",
+    "@pushrocks/smartpromise": "^3.0.6",
-    "@pushrocks/smartrequest": "^1.1.16",
+    "@pushrocks/smartrequest": "^1.1.47",
-    "@pushrocks/smartstring": "^3.0.10",
+    "@pushrocks/smartstring": "^3.0.18",
-    "@tsclass/tsclass": "^2.0.1"
+    "@tsclass/tsclass": "^3.0.7"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsbuild": "^2.1.17",
     "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.24",
+    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/qenv": "^4.0.0",
+    "@pushrocks/qenv": "^4.0.6",
-    "@pushrocks/tapbundle": "^3.0.11",
+    "@pushrocks/tapbundle": "^3.2.0",
-    "@types/node": "^12.6.6",
+    "@types/node": "^13.7.2",
-    "tslint": "^5.18.0",
+    "tslint": "^6.0.0",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [
-    "ts/*",
+    "ts/**/*",
-    "ts_web/*",
+    "ts_web/**/*",
-    "dist/*",
+    "dist/**/*",
-    "dist_web/*",
+    "dist_web/**/*",
-    "dist_ts_web/*",
+    "dist_ts_web/**/*",
-    "assets/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

qenv.yml

@@ -1,3 +1,2 @@
 required:
-  - CF_EMAIL
   - CF_KEY

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,25 @@ 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('mySuperAwesomeAccountToken');
-testCflareAccount.auth({
-    email: 'someuser@example.com',
-    key: 'someLongApiKey'
-})
 
-let myAsyncCflareManagement = async () => {
+const myAsyncCflareManagement = async () => {
-    // get things
+  // get things
-    let myZones = await myCflareAccount.listZones() // zones are fully typed
+  const myZones = await myCflareAccount.listZones(); // zones are fully typed
-    let myIdForADomain = await myCflareAccount.getZoneId('example.com') // type number
+  const myIdForADomain = await myCflareAccount.getZoneId('example.com'); // type number
-    let myRecordsForADomain = await myCflareAccount.listRecords('example.com') // records are fully typed
+  const myRecordsForADomain = await myCflareAccount.listRecords('example.com'); // records are fully typed
-
+};
-    // set things
-    myCflareAccount.updateRecord(...)
-    myCflareAccount.createRecord(...)
-    myCflareAccount.deleteRecord(...)
-}
 ```
 
+## 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

@@ -11,17 +11,12 @@ const randomPrefix = Math.floor(Math.random() * 2000);
 let testCloudflareAccount: cloudflare.CloudflareAccount;
 
 tap.test('should create a valid instance of CloudflareAccount', async () => {
-  testCloudflareAccount = new cloudflare.CloudflareAccount({
+  testCloudflareAccount = new cloudflare.CloudflareAccount(testQenv.getEnvVarOnDemand('CF_KEY'));
-    email: testQenv.getEnvVarOnDemand('CF_EMAIL'),
-    key: testQenv.getEnvVarOnDemand('CF_KEY')
-  });
 });
 
-
+tap.test('.listZones() -> should display an entire account', async tools => {
-
-tap.skip.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);
 });
 
@@ -29,7 +24,7 @@ tap.test(
   '.getZoneId(domainName) -> should get an Cloudflare Id for a domain string',
   async tools => {
     tools.timeout(600000);
-    await testCloudflareAccount.getZoneId('bleu.de');
+    await testCloudflareAccount.convenience.getZoneId('bleu.de');
   }
 );
 
@@ -37,7 +32,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 +40,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
-    console.log(responseArg);
+    .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 +66,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,13 +2,11 @@ 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';
 
 export class CloudflareAccount {
-  private authEmail: string;
+  private authToken: string;
-  private authKey: string;
   private accountIdentifier: string;
 
   public workerManager = new WorkerManager(this);
@@ -18,192 +16,256 @@ export class CloudflareAccount {
    * constructor sets auth information on the CloudflareAccountInstance
    * @param optionsArg
    */
-  constructor(optionsArg: { email: string; key: string }) {
+  constructor(authTokenArg: string) {
-    this.authEmail = optionsArg.email;
+    this.authToken = authTokenArg;
-    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;
   }
 
-  /**
+  public convenience = {
-   * gets a zone id of a domain from cloudflare
+    /**
-   * @param domainName
+     * gets a zone id of a domain from cloudflare
-   */
+     * @param domainName
-  public async getZoneId(domainName: string) {
+     */
-    const domain = new plugins.smartstring.Domain(domainName);
+    getZoneId: async (domainName: string) => {
-    const zoneArray = await this.listZones(domain.zoneName);
+      const domain = new plugins.smartstring.Domain(domainName);
-    const filteredResponse = zoneArray.filter(zoneArg => {
+      const zoneArray = await this.convenience.listZones(domain.zoneName);
-      return zoneArg.name === domainName;
+      const filteredResponse = zoneArray.filter(zoneArg => {
-    });
+        return zoneArg.name === domainName;
-    if (filteredResponse.length >= 1) {
+      });
-      return filteredResponse[0].id;
+      if (filteredResponse.length >= 1) {
-    } else {
+        return filteredResponse[0].id;
-      plugins.smartlog.defaultLogger.log(
+      } else {
-        'error',
+        plugins.smartlog.defaultLogger.log(
-        `the domain ${domainName} does not appear to be in this account!`
+          'error',
+          `the domain ${domainName} does not appear to be in this account!`
+        );
+        throw new Error(`the domain ${domainName} does not appear to be in this account!`);
+      }
+    },
+    /**
+     * gets a record
+     * @param domainNameArg
+     * @param typeArg
+     */
+    getRecord: async (
+      domainNameArg: string,
+      typeArg: plugins.tsclass.network.TDnsRecordType
+    ): Promise<interfaces.ICflareRecord> => {
+      const domain = new plugins.smartstring.Domain(domainNameArg);
+      const recordArrayArg = await this.convenience.listRecords(domain.zoneName);
+      const filteredResponse = recordArrayArg.filter(recordArg => {
+        return recordArg.type === typeArg && recordArg.name === domainNameArg;
+      });
+      return filteredResponse[0];
+    },
+    /**
+     * creates a record
+     */
+    createRecord: async (
+      domainNameArg: string,
+      typeArg: plugins.tsclass.network.TDnsRecordType,
+      contentArg: string
+    ): Promise<any> => {
+      const domain = new plugins.smartstring.Domain(domainNameArg);
+      const domainIdArg = await this.convenience.getZoneId(domain.zoneName);
+      const dataObject = {
+        name: domain.fullName,
+        type: typeArg,
+        content: contentArg
+      };
+      const response = await this.request(
+        'POST',
+        '/zones/' + domainIdArg + '/dns_records',
+        dataObject
       );
-      throw new Error(`the domain ${domainName} does not appear to be in this account!`);
+      return response;
+    },
+    /**
+     * removes a record from Cloudflare
+     * @param domainNameArg
+     * @param typeArg
+     */
+    removeRecord: async (
+      domainNameArg: string,
+      typeArg: plugins.tsclass.network.TDnsRecordType
+    ): Promise<any> => {
+      const domain = new plugins.smartstring.Domain(domainNameArg);
+      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
+     */
+    cleanRecord: async (domainNameArg: string, typeArg: plugins.tsclass.network.TDnsRecordType) => {
+      console.log(`cleaning record for ${domainNameArg}`);
+    },
+    /**
+     * updates a record
+     * @param domainNameArg
+     * @param typeArg
+     * @param valueArg
+     */
+    updateRecord: async (
+      domainNameArg: string,
+      typeArg: plugins.tsclass.network.TDnsRecordType,
+      valueArg
+    ) => {
+      // TODO: implement
+      const domain = new plugins.smartstring.Domain(domainNameArg);
+    },
+    /**
+     * list all records of a specified domain name
+     * @param domainNameArg - the domain name that you want to get the records from
+     */
+    listRecords: async (domainNameArg: string): Promise<interfaces.ICflareRecord[]> => {
+      const domain = new plugins.smartstring.Domain(domainNameArg);
+      const domainId = await this.convenience.getZoneId(domain.zoneName);
+      const responseArg: any = await this.request(
+        'GET',
+        '/zones/' + domainId + '/dns_records?per_page=100'
+      );
+      const result: interfaces.ICflareRecord[] = responseArg.result;
+      return result;
+    },
+    /**
+     * list all zones in the associated authenticated account
+     * @param domainName
+     */
+    listZones: async (domainName?: string): Promise<interfaces.ICflareZone[]> => {
+      // TODO: handle pagination
+      let requestRoute = `/zones?per_page=50`;
+
+      // may be optionally filtered by domain name
+      if (domainName) {
+        requestRoute = `${requestRoute}&name=${domainName}`;
+      }
+
+      const response: any = await this.request('GET', requestRoute);
+      const result = response.result;
+      return result;
+    },
+    /**
+     * purges a zone
+     */
+    purgeZone: async (domainName: string): Promise<void> => {
+      const domain = new plugins.smartstring.Domain(domainName);
+      const domainId = await this.convenience.getZoneId(domain.zoneName);
+      const requestUrl = `/zones/${domainId}/purge_cache`;
+      const payload = {
+        purge_everything: true
+      };
+      const respone = await this.request('DELETE', requestUrl, payload);
+    },
+    // acme convenience functions
+    acmeSetDnsChallenge: async (dnsChallenge: plugins.tsclass.network.IDnsChallenge) => {
+      await this.convenience.cleanRecord(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 async request(
-   * gets a record
-   * @param domainNameArg
-   * @param typeArg
-   */
-  public async getRecord(
-    domainNameArg: string,
-    typeArg: TDnsRecord
-  ): Promise<interfaces.ICflareRecord> {
-    const domain = new plugins.smartstring.Domain(domainNameArg);
-    const recordArrayArg = await this.listRecords(domain.zoneName);
-    const filteredResponse = recordArrayArg.filter(recordArg => {
-      return recordArg.type === typeArg && recordArg.name === domainNameArg;
-    });
-    return filteredResponse[0];
-  }
-
-  public async createRecord(
-    domainNameArg: string,
-    typeArg: TDnsRecord,
-    contentArg: string
-  ): Promise<any> {
-    const domain = new plugins.smartstring.Domain(domainNameArg);
-    const domainIdArg = await this.getZoneId(domain.zoneName);
-    const dataObject = {
-      name: domain.fullName,
-      type: typeArg,
-      content: contentArg
-    };
-    const response = await this.request(
-      'POST',
-      '/zones/' + domainIdArg + '/dns_records',
-      dataObject
-    );
-    return response;
-  }
-
-  /**
-   * removes a record from Cloudflare
-   * @param domainNameArg
-   * @param typeArg
-   */
-  public async removeRecord(domainNameArg: string, typeArg: TDnsRecord): Promise<any> {
-    const domain = new plugins.smartstring.Domain(domainNameArg);
-    const cflareRecord = await this.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}`);
-    }
-  }
-
-  /**
-   * updates a record
-   * @param domainNameArg
-   * @param typeArg
-   * @param valueArg
-   */
-  public updateRecord(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[]> {
-    const domain = new plugins.smartstring.Domain(domainNameArg);
-    const domainId = await this.getZoneId(domain.zoneName);
-    const responseArg: any = await this.request(
-      'GET',
-      '/zones/' + domainId + '/dns_records?per_page=100'
-    );
-    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[]> {
-    // TODO: handle pagination
-    let requestRoute = `/zones?per_page=50`;
-
-    // may be optionally filtered by domain name
-    if (domainName) {
-      requestRoute = `${requestRoute}&name=${domainName}`;
-    }
-
-    const response: any = await this.request('GET', requestRoute);
-    const result = response.result;
-    return result;
-  }
-
-  public async purgeZone(domainName: string) {
-    const domain = new plugins.smartstring.Domain(domainName);
-    const domainId = await this.getZoneId(domain.zoneName);
-    const requestUrl = `/zones/${domainId}/purge_cache`;
-    const payload = {
-      purge_everything: true
-    };
-    const respone = await this.request('DELETE', requestUrl, payload);
-  }
-
-  public request(
     methodArg: string,
     routeArg: string,
     dataArg: any = {},
     requestHeadersArg = {}
   ): Promise<any> {
-    const done = plugins.smartpromise.defer();
     const options: plugins.smartrequest.ISmartRequestOptions = {
       method: methodArg,
       headers: {
         'Content-Type': 'application/json',
-        'X-Auth-Email': this.authEmail,
+        Authorization: `Bearer ${this.authToken}`,
-        'X-Auth-Key': this.authKey,
         'Content-Length': Buffer.byteLength(JSON.stringify(dataArg)),
         ...requestHeadersArg
       },
       requestBody: dataArg
     };
 
+    // route analysis
+    const routeWithoutQuery = routeArg.split('?')[0];
+    let queryParams: string[] = [];
+    if (routeArg.split('?').length > 1) {
+      queryParams = routeArg.split('?')[1].split('&');
+    }
+
     // console.log(options);
 
     let retryCount = 0; // count the amount of retries
+    let pageCount = 1;
 
-    const makeRequest = async () => {
+    const getQueryParams = () => {
-      const response: any = await plugins.smartrequest.request(
+      let result = '';
-        `https://api.cloudflare.com/client/v4${routeArg}`,
+      if (queryParams.length > 0) {
-        options
+        result += '?';
-      );
+      } else {
+        return result;
+      }
+
+      let isFirst = true;
+      for (const queryParam of queryParams) {
+        if (!isFirst) {
+          result += '&';
+        }
+        isFirst = false;
+        const queryParamSerialized = queryParam.split('=');
+        if (queryParam === 'page') {
+          result += `page=${pageCount}`;
+        } else {
+          result += queryParam;
+        }
+      }
+      return result;
+    };
+
+    const makeRequest = async (): Promise<plugins.smartrequest.IExtendedIncomingMessage> => {
+      const requestUrl = `https://api.cloudflare.com/client/v4${routeWithoutQuery}${getQueryParams()}`;
+      const response = await plugins.smartrequest.request(requestUrl, options);
       if (response.statusCode === 200) {
-        done.resolve(response.body);
+        if (response.body.result_info) {
+          const rI = response.body.result_info;
+          if (rI.total_count / rI.per_page > pageCount) {
+            pageCount++;
+            const subresponse = await makeRequest();
+            response.body.result = response.body.result.concat(subresponse.body.result);
+            return response;
+          } else {
+            return response;
+          }
+        } else {
+          return response;
+        }
       } else if (response.statusCode === 429) {
         console.log('rate limited! Waiting for retry!');
-        retryRequest();
+        return await retryRequest();
       } else if (response.statusCode === 400) {
-        console.log(`bad request for route ${routeArg}! Going to retry!`);
+        console.log(`bad request for route ${requestUrl}!`);
         console.log(response.body);
+        throw new Error(`request failed for ${requestUrl}`);
       } else {
         console.log(response.statusCode);
-        done.reject(new Error('request failed'));
+        console.log(response.body);
+        throw Error('request failed');
       }
     };
+
     const retryRequest = async (
       delayTimeArg = Math.floor(Math.random() * (60000 - 8000) + 8000)
     ) => {
@@ -214,11 +276,11 @@ export class CloudflareAccount {
         return await makeRequest();
       }
     };
-    makeRequest();
+    const response = await makeRequest();
-    return done.promise;
+    return response.body;
   }
 
   private authCheck() {
-    return this.authEmail && this.authKey; // check if auth is available
+    return !!this.authToken; // check if auth is available
   }
 }

ts/cloudflare.classes.record.ts

@@ -0,0 +1,5 @@
+import * as plugins from './cloudflare.plugins';
+
+export class CloudflareRecord {
+
+}

ts/cloudflare.classes.worker.ts

@@ -6,18 +6,21 @@ export interface IWorkerRoute extends interfaces.ICflareWorkerRoute {
   zoneName: string;
 }
 
-export class Worker {
+export class CloudflareWorker {
   // STATIC
-  public static async fromApiObject(workerManager: WorkerManager, apiObject): Promise<Worker> {
+  public static async fromApiObject(
-    const newWorker = new Worker(workerManager);
+    workerManager: WorkerManager,
-    Object.assign(newWorker, apiObject.result);
+    apiObject
+  ): Promise<CloudflareWorker> {
+    const newWorker = new CloudflareWorker(workerManager);
+    Object.assign(newWorker, apiObject);
     await newWorker.getRoutes();
     return newWorker;
   }
 
   // INSTANCE
   private workerManager: WorkerManager;
-  
+
   public script: string;
   public id: string;
   public etag: string;
@@ -35,22 +38,24 @@ 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);
         console.log(this.id);
         if (route.script === this.id) {
-          this.routes.push({...route, zoneName: zone.name});
+          this.routes.push({ ...route, zoneName: zone.name });
         }
       }
     }
   }
 
-  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';
@@ -68,14 +73,14 @@ export class Worker {
 
       // lets care about actually setting routes
       if (routeStatus === 'new') {
-        const zoneId = await this.workerManager.cfAccount.getZoneId(newRoute.zoneName);
+        const zoneId = await this.workerManager.cfAccount.convenience.getZoneId(newRoute.zoneName);
         const requestRoute = `/zones/${zoneId}/workers/routes`;
         await this.workerManager.cfAccount.request('POST', requestRoute, {
           pattern: newRoute.pattern,
           script: this.id
         });
       } else if (routeStatus === 'needsUpdate') {
-        const zoneId = await this.workerManager.cfAccount.getZoneId(newRoute.zoneName);
+        const zoneId = await this.workerManager.cfAccount.convenience.getZoneId(newRoute.zoneName);
         const requestRoute = `/zones/${zoneId}/workers/routes/${routeIdForUpdate}`;
         await this.workerManager.cfAccount.request('PUT', requestRoute, {
           pattern: newRoute.pattern,

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

@@ -1,6 +1,51 @@
 import * as plugins from './cloudflare.plugins';
 import * as interfaces from './interfaces';
 
-export class CloudflareZone {
+export class CloudflareZone implements interfaces.ICflareZone {
-  // TODO
+  public static createFromApiObject(apiObject: interfaces.ICflareZone) {
-}
+    const cloudflareZone = new CloudflareZone();
+    Object.assign(cloudflareZone, apiObject);
+    return cloudflareZone;
+  }
+
+  id: string;
+  name: string;
+  development_mode: number;
+  original_name_servers: string[];
+  original_registrar: string;
+  original_dnshost: string;
+  created_on: string;
+  modified_on: string;
+  name_servers: string[];
+  owner: {
+    id: string;
+    email: string;
+    owner_type: string;
+  };
+  permissions: string[];
+  plan: {
+    id: string;
+    name: string;
+    price: number;
+    currency: string;
+    frequency: string;
+    legacy_id: string;
+    is_subscribed: boolean;
+    can_subscribe: boolean;
+  };
+  plan_pending: {
+    id: string;
+    name: string;
+    price: number;
+    currency: string;
+    frequency: string;
+    legacy_id: string;
+    is_subscribed: string;
+    can_subscribe: string;
+  };
+  status: string;
+  paused: boolean;
+  type: string;
+  checked_on: string;
+
+}

ts/cloudflare.classes.zonemanager.ts

@@ -1,5 +1,7 @@
 import * as plugins from './cloudflare.plugins';
+import * as interfaces from './interfaces';
 import { CloudflareAccount } from './cloudflare.classes.account';
+import { CloudflareZone } from './cloudflare.classes.zone';
 
 export class ZoneManager {
   public cfAccount: CloudflareAccount;
@@ -8,4 +10,23 @@ export class ZoneManager {
   constructor(cfAccountArg: CloudflareAccount) {
     this.cfAccount = cfAccountArg;
   }
+
+  public async getZones(zoneName: string) {
+    let requestRoute = `/zones?per_page=50`;
+    // may be optionally filtered by domain name
+    
+    if (zoneName) {
+      requestRoute = `${requestRoute}&name=${zoneName}`;
+    }
+
+    const response: any = await this.cfAccount.request('GET', requestRoute);
+    const apiObjects: interfaces.ICflareZone[] = response.result;
+    
+    const cloudflareZoneArray = [];
+    for (const apiObject of apiObjects) {
+      cloudflareZoneArray.push(CloudflareZone.createFromApiObject(apiObject));
+    }
+
+    return cloudflareZoneArray;
+  }
 }

ts/index.ts

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

ts/interfaces/cloudflare.api.record.ts

@@ -12,4 +12,4 @@ export interface ICflareRecord {
   created_on: string;
   modified_on: string;
   data: any;
-}
+}

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": {