5.0.5

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@mojoio/cloudflare",
-  "version": "4.0.4",
+  "version": "5.0.5",
   "private": false,
   "description": "easy cloudflare management",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -24,21 +24,21 @@
   },
   "homepage": "https://gitlab.com/pushrocks/cflare#readme",
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.6",
+    "@pushrocks/smartdelay": "^2.0.9",
-    "@pushrocks/smartlog": "^2.0.21",
+    "@pushrocks/smartlog": "^2.0.28",
     "@pushrocks/smartpromise": "^3.0.6",
     "@pushrocks/smartrequest": "^1.1.47",
     "@pushrocks/smartstring": "^3.0.18",
-    "@tsclass/tsclass": "^3.0.7"
+    "@tsclass/tsclass": "^3.0.17"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsbuild": "^2.1.24",
-    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.28",
+    "@gitzone/tstest": "^1.0.33",
-    "@pushrocks/qenv": "^4.0.6",
+    "@pushrocks/qenv": "^4.0.10",
-    "@pushrocks/tapbundle": "^3.2.0",
+    "@pushrocks/tapbundle": "^3.2.1",
-    "@types/node": "^13.7.2",
+    "@types/node": "^14.0.13",
-    "tslint": "^6.0.0",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [

qenv.yml

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

readme.md

@@ -23,11 +23,7 @@ Use TypeScript for best in class instellisense.
 ```javascript
 import * as cflare from '@mojoio/cloudflare';
 
-const myCflareAccount = new cflare.CflareAccount();
+const myCflareAccount = new cflare.CflareAccount('mySuperAwesomeAccountToken');
-testCflareAccount.auth({
-  email: 'someuser@example.com',
-  key: 'someLongApiKey'
-});
 
 const myAsyncCflareManagement = async () => {
   // get things

test/test.ts

@@ -11,10 +11,7 @@ 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 => {
@@ -27,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');
   }
 );
 

ts/cloudflare.classes.account.ts

@@ -1,4 +1,5 @@
 import plugins = require('./cloudflare.plugins');
+import { logger } from './cloudflare.logger';
 import * as interfaces from './interfaces';
 
 // interfaces
@@ -6,8 +7,7 @@ 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);
@@ -17,9 +17,8 @@ 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;
   }
 
   /**
@@ -34,28 +33,27 @@ export class CloudflareAccount {
     return this.accountIdentifier;
   }
 
-  /**
-   * gets a zone id of a domain from cloudflare
-   * @param domainName
-   */
-  public async getZoneId(domainName: string) {
-    const domain = new plugins.smartstring.Domain(domainName);
-    const zoneArray = await this.convenience.listZones(domain.zoneName);
-    const filteredResponse = zoneArray.filter(zoneArg => {
-      return zoneArg.name === domainName;
-    });
-    if (filteredResponse.length >= 1) {
-      return filteredResponse[0].id;
-    } else {
-      plugins.smartlog.defaultLogger.log(
-        '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!`);
-    }
-  }
-
   public convenience = {
+    /**
+     * gets a zone id of a domain from cloudflare
+     * @param domainName
+     */
+    getZoneId: async (domainName: string) => {
+      const domain = new plugins.smartstring.Domain(domainName);
+      const zoneArray = await this.convenience.listZones(domain.zoneName);
+      const filteredResponse = zoneArray.filter(zoneArg => {
+        return zoneArg.name === domainName;
+      });
+      if (filteredResponse.length >= 1) {
+        return filteredResponse[0].id;
+      } else {
+        logger.log(
+          '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
@@ -81,7 +79,7 @@ export class CloudflareAccount {
       contentArg: string
     ): Promise<any> => {
       const domain = new plugins.smartstring.Domain(domainNameArg);
-      const domainIdArg = await this.getZoneId(domain.zoneName);
+      const domainIdArg = await this.convenience.getZoneId(domain.zoneName);
       const dataObject = {
         name: domain.fullName,
         type: typeArg,
@@ -124,7 +122,11 @@ export class CloudflareAccount {
      * @param typeArg
      * @param valueArg
      */
-    updateRecord: async (domainNameArg: string, typeArg: plugins.tsclass.network.TDnsRecordType, valueArg) => {
+    updateRecord: async (
+      domainNameArg: string,
+      typeArg: plugins.tsclass.network.TDnsRecordType,
+      valueArg
+    ) => {
       // TODO: implement
       const domain = new plugins.smartstring.Domain(domainNameArg);
     },
@@ -134,7 +136,7 @@ export class CloudflareAccount {
      */
     listRecords: async (domainNameArg: string): Promise<interfaces.ICflareRecord[]> => {
       const domain = new plugins.smartstring.Domain(domainNameArg);
-      const domainId = await this.getZoneId(domain.zoneName);
+      const domainId = await this.convenience.getZoneId(domain.zoneName);
       const responseArg: any = await this.request(
         'GET',
         '/zones/' + domainId + '/dns_records?per_page=100'
@@ -164,7 +166,7 @@ export class CloudflareAccount {
      */
     purgeZone: async (domainName: string): Promise<void> => {
       const domain = new plugins.smartstring.Domain(domainName);
-      const domainId = await this.getZoneId(domain.zoneName);
+      const domainId = await this.convenience.getZoneId(domain.zoneName);
       const requestUrl = `/zones/${domainId}/purge_cache`;
       const payload = {
         purge_everything: true
@@ -181,47 +183,89 @@ export class CloudflareAccount {
     }
   };
 
-  public request(
+  public async 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);
+        console.log(response.body);
-        done.reject(new Error('request failed'));
+        throw new Error(`request failed for ${requestUrl} with status${response.statusCode}}`);
       }
     };
+
     const retryRequest = async (
       delayTimeArg = Math.floor(Math.random() * (60000 - 8000) + 8000)
     ) => {
@@ -232,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

@@ -1,6 +1,7 @@
 import * as plugins from './cloudflare.plugins';
 import * as interfaces from './interfaces';
 import { WorkerManager } from './cloudflare.classes.workermanager';
+import { logger } from './cloudflare.logger';
 
 export interface IWorkerRoute extends interfaces.ICflareWorkerRoute {
   zoneName: string;
@@ -66,21 +67,21 @@ export class CloudflareWorker {
           routeIdForUpdate = existingRoute.id;
           if (existingRoute.script === this.id) {
             routeStatus = 'alreadyUpToDate';
-            plugins.smartlog.defaultLogger.log('info', `route already exists, no update needed`);
+            logger.log('info', `route already exists, no update needed`);
           }
         }
       }
 
       // 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.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 {
-  public static async createFromApiObject() {}
+  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;
@@ -9,5 +11,22 @@ export class ZoneManager {
     this.cfAccount = cfAccountArg;
   }
 
-  public getZones() {}
+  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/cloudflare.logger.ts

@@ -0,0 +1,3 @@
+import * as plugins from './cloudflare.plugins';
+
+export const logger = new plugins.smartlog.ConsoleLog();