3.0.6

.gitlab-ci.yml

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

README.md

@@ -1,50 +0,0 @@
-# @mojoio/cloudflare
-easy cloudflare management
-
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/cloudflare)
-* [gitlab.com (source)](https://gitlab.com/mojoio/cloudflare)
-* [github.com (source mirror)](https://github.com/mojoio/cloudflare)
-* [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)
-[![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)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
-
-## Usage
-
-Use TypeScript for best in class instellisense.
-
-```javascript
-import * as cflare from 'cflare'
-
-let myCflareAccount = new cflare.CflareAccount()
-testCflareAccount.auth({
-    email: 'someuser@example.com',
-    key: 'someLongApiKey'
-})
-
-let 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(...)
-}
-```
-
-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)
-
-[![repo-footer](https://mojoio.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

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.2",
+  "version": "3.0.6",
   "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"

test/test.ts

@@ -17,9 +17,7 @@ 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();
   console.log(result);
@@ -50,9 +48,11 @@ tap.test('should create a valid record for a subdomain', async tools => {
 
 tap.test('should get a record from Cloudflare', async tools => {
   tools.timeout(600000);
-  await testCloudflareAccount.getRecord(`${randomPrefix}subdomain.bleu.de`, 'A').then(responseArg => {
-    console.log(responseArg);
-  });
+  await testCloudflareAccount
+    .getRecord(`${randomPrefix}subdomain.bleu.de`, 'A')
+    .then(responseArg => {
+      console.log(responseArg);
+    });
 });
 
 tap.test('should remove a subdomain record from Cloudflare', async tools => {
@@ -70,11 +70,22 @@ tap.test('.purge(some.domain) -> should purge everything', async () => {
 
 // WORKERS
 tap.test('should create a worker', async () => {
-  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',
+      pattern: 'https://*bleu.de/hello'
+    }
+  ]);
+  console.log(worker);
 });
 
 tap.test('should get workers', async () => {
-  await testCloudflareAccount.workerManager.listWorkers();
+  const workerArray = await testCloudflareAccount.workerManager.listWorkers();
+  console.log(workerArray);
 });
 
 tap.start();

ts/cloudflare.classes.account.ts

@@ -1,8 +1,7 @@
 import plugins = require('./cloudflare.plugins');
-import * as interfaces from './interfaces/cloudflare.interfaces';
+import * as interfaces from './interfaces';
 
 // interfaces
-import { TDnsRecord } from '@tsclass/tsclass';
 import { WorkerManager } from './cloudflare.classes.workermanager';
 import { ZoneManager } from './cloudflare.classes.zonemanager';
 
@@ -24,10 +23,12 @@ export class CloudflareAccount {
   }
 
   public async getAccountIdentifier() {
-    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);
+    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;
   }
 
@@ -59,7 +60,7 @@ export class CloudflareAccount {
    */
   public async getRecord(
     domainNameArg: string,
-    typeArg: TDnsRecord
+    typeArg: plugins.tsclass.network.TDnsRecord
   ): Promise<interfaces.ICflareRecord> {
     const domain = new plugins.smartstring.Domain(domainNameArg);
     const recordArrayArg = await this.listRecords(domain.zoneName);
@@ -71,7 +72,7 @@ export class CloudflareAccount {
 
   public async createRecord(
     domainNameArg: string,
-    typeArg: TDnsRecord,
+    typeArg: plugins.tsclass.network.TDnsRecord,
     contentArg: string
   ): Promise<any> {
     const domain = new plugins.smartstring.Domain(domainNameArg);
@@ -92,9 +93,12 @@ export class CloudflareAccount {
   /**
    * removes a record from Cloudflare
    * @param domainNameArg
-   * @param typeArg 
+   * @param typeArg
    */
-  public async removeRecord(domainNameArg: string, typeArg: TDnsRecord): Promise<any> {
+  public async removeRecord(
+    domainNameArg: string,
+    typeArg: plugins.tsclass.network.TDnsRecord
+  ): Promise<any> {
     const domain = new plugins.smartstring.Domain(domainNameArg);
     const cflareRecord = await this.getRecord(domain.fullName, typeArg);
     if (cflareRecord) {
@@ -161,7 +165,12 @@ export class CloudflareAccount {
     const respone = await this.request('DELETE', requestUrl, payload);
   }
 
-  public request(methodArg: string, routeArg: string, dataArg: any = {}, requestHeadersArg = {}): Promise<any> {
+  public request(
+    methodArg: string,
+    routeArg: string,
+    dataArg: any = {},
+    requestHeadersArg = {}
+  ): Promise<any> {
     const done = plugins.smartpromise.defer();
     const options: plugins.smartrequest.ISmartRequestOptions = {
       method: methodArg,
@@ -172,7 +181,7 @@ export class CloudflareAccount {
         'Content-Length': Buffer.byteLength(JSON.stringify(dataArg)),
         ...requestHeadersArg
       },
-      requestBody: dataArg,
+      requestBody: dataArg
     };
 
     // console.log(options);
@@ -214,4 +223,6 @@ export class CloudflareAccount {
   private authCheck() {
     return this.authEmail && this.authKey; // check if auth is available
   }
+
+  // acme convenience functions
 }

ts/cloudflare.classes.worker.ts

@@ -1,21 +1,35 @@
+import * as plugins from './cloudflare.plugins';
+import * as interfaces from './interfaces';
 import { WorkerManager } from './cloudflare.classes.workermanager';
 
-export class Worker {
+export interface IWorkerRoute extends interfaces.ICflareWorkerRoute {
+  zoneName: string;
+}
+
+export class CloudflareWorker {
   // STATIC
-  public static async fromApiObject(workerManager: WorkerManager, apiObject): Promise<Worker> {
-    console.log(apiObject);
-    return new Worker(workerManager);
+  public static async fromApiObject(
+    workerManager: WorkerManager,
+    apiObject
+  ): Promise<CloudflareWorker> {
+    const newWorker = new CloudflareWorker(workerManager);
+    Object.assign(newWorker, apiObject.result);
+    await newWorker.getRoutes();
+    return newWorker;
   }
-  
+
   // INSTANCE
   private workerManager: WorkerManager;
-  
+
+  public script: string;
   public id: string;
   public etag: string;
-  public createdOn: string;
-  public modifiedOn: string;
+  // tslint:disable-next-line: variable-name
+  public created_on: string;
+  // tslint:disable-next-line: variable-name
+  public modified_on: string;
 
-  public routes: string[] = [];
+  public routes: IWorkerRoute[] = [];
   constructor(workerManagerArg: WorkerManager) {
     this.workerManager = workerManagerArg;
   }
@@ -23,12 +37,56 @@ export class Worker {
   /**
    * gets all routes for a worker
    */
-  public async getRoutes(){
+  public async getRoutes() {
     const zones = await this.workerManager.cfAccount.listZones();
-    console.log(zones);
+    for (const zone of zones) {
+      const requestRoute = `/zones/${zone.id}/workers/routes`;
+      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 });
+        }
+      }
+    }
   }
-  
-  public setRoutes(routeArray: 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';
+      let routeIdForUpdate: string;
+      for (const existingRoute of this.routes) {
+        if (existingRoute.pattern === newRoute.pattern) {
+          routeStatus = 'needsUpdate';
+          routeIdForUpdate = existingRoute.id;
+          if (existingRoute.script === this.id) {
+            routeStatus = 'alreadyUpToDate';
+            plugins.smartlog.defaultLogger.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 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 requestRoute = `/zones/${zoneId}/workers/routes/${routeIdForUpdate}`;
+        await this.workerManager.cfAccount.request('PUT', requestRoute, {
+          pattern: newRoute.pattern,
+          script: this.id
+        });
+      }
+    }
   }
 }

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);
   }
 
   /**
@@ -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 {
+  // TODO
+}

ts/index.ts

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

ts/interfaces/cloudflare.api.record.ts

@@ -0,0 +1,15 @@
+export interface ICflareRecord {
+  id: string;
+  type: string;
+  name: string;
+  content: string;
+  proxiable: boolean;
+  proxied: boolean;
+  ttl: number;
+  locked: boolean;
+  zone_id: string;
+  zone_name: string;
+  created_on: string;
+  modified_on: string;
+  data: any;
+}

ts/interfaces/cloudflare.api.workerroute.ts

@@ -0,0 +1,5 @@
+export interface ICflareWorkerRoute {
+  id: string;
+  pattern: string;
+  script: string;
+}

ts/interfaces/cloudflare.api.zone.ts

@@ -1,5 +1,3 @@
-import * as plugins from '../cloudflare.plugins';
-
 export interface ICflareZone {
   id: string;
   name: string;
@@ -41,19 +39,3 @@ export interface ICflareZone {
   type: string;
   checked_on: string;
 }
-
-export interface ICflareRecord {
-  id: string;
-  type: string;
-  name: string;
-  content: string;
-  proxiable: boolean;
-  proxied: boolean;
-  ttl: number;
-  locked: boolean;
-  zone_id: string;
-  zone_name: string;
-  created_on: string;
-  modified_on: string;
-  data: any;
-}

ts/interfaces/index.ts

@@ -1 +1,3 @@
-export * from './cloudflare.interfaces';
+export * from './cloudflare.api.record';
+export * from './cloudflare.api.zone';
+export * from './cloudflare.api.workerroute';

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