Compare commits
19 Commits
Author | SHA1 | Date | |
---|---|---|---|
12f4456ebd | |||
3e8cf73877 | |||
0032292714 | |||
ead87ceb63 | |||
04d70a4d12 | |||
8da43a79d3 | |||
3153021190 | |||
82701c19e7 | |||
d3a68b4fef | |||
c4c1367306 | |||
1f5352d9f5 | |||
f652cc72fe | |||
f510408fce | |||
e250e9b1a2 | |||
5a9b7bbeee | |||
1158b4ff99 | |||
8eb777dd45 | |||
acf5c242d3 | |||
9e9dd8d935 |
@ -4,13 +4,13 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|||||||
cache:
|
cache:
|
||||||
paths:
|
paths:
|
||||||
- .npmci_cache/
|
- .npmci_cache/
|
||||||
key: "$CI_BUILD_STAGE"
|
key: '$CI_BUILD_STAGE'
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
- security
|
- security
|
||||||
- test
|
- test
|
||||||
- release
|
- release
|
||||||
- metadata
|
- metadata
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# security stage
|
# security stage
|
||||||
@ -20,17 +20,19 @@ mirror:
|
|||||||
script:
|
script:
|
||||||
- npmci git mirror
|
- npmci git mirror
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
snyk:
|
snyk:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci command npm install -g snyk
|
|
||||||
- npmci command npm install --ignore-scripts
|
- npmci command npm install --ignore-scripts
|
||||||
- npmci command snyk test
|
- npmci command snyk test
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
@ -38,38 +40,41 @@ snyk:
|
|||||||
# test stage
|
# test stage
|
||||||
# ====================
|
# ====================
|
||||||
|
|
||||||
testLTS:
|
testStable:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
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/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- priv
|
||||||
|
|
||||||
testBuild:
|
testBuild:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
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/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
release:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
script:
|
script:
|
||||||
- npmci node install lts
|
- npmci node install stable
|
||||||
- npmci npm publish
|
- npmci npm publish
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
@ -81,9 +86,11 @@ codequality:
|
|||||||
allow_failure: true
|
allow_failure: true
|
||||||
script:
|
script:
|
||||||
- npmci command npm install -g tslint typescript
|
- npmci command npm install -g tslint typescript
|
||||||
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- priv
|
- priv
|
||||||
|
|
||||||
@ -94,18 +101,20 @@ trigger:
|
|||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
pages:
|
pages:
|
||||||
image: hosttoday/ht-docker-node:npmci
|
|
||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
|
- npmci node install lts
|
||||||
- npmci command npm install -g @gitzone/tsdoc
|
- npmci command npm install -g @gitzone/tsdoc
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command tsdoc
|
- npmci command tsdoc
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
only:
|
only:
|
||||||
|
29
.vscode/launch.json
vendored
Normal file
29
.vscode/launch.json
vendored
Normal file
@ -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"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -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"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
@ -4,6 +4,7 @@
|
|||||||
"npmAccessLevel": "public"
|
"npmAccessLevel": "public"
|
||||||
},
|
},
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "mojoio",
|
"gitscope": "mojoio",
|
||||||
|
855
package-lock.json
generated
855
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
40
package.json
40
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@mojoio/cloudflare",
|
"name": "@mojoio/cloudflare",
|
||||||
"version": "2.0.1",
|
"version": "4.0.0",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "easy cloudflare management",
|
"description": "easy cloudflare management",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
@ -24,30 +24,30 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/cflare#readme",
|
"homepage": "https://gitlab.com/pushrocks/cflare#readme",
|
||||||
"dependencies": {
|
"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.4"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.11",
|
"@gitzone/tsbuild": "^2.1.17",
|
||||||
"@gitzone/tsrun": "^1.2.6",
|
"@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.0",
|
||||||
"tslint": "^5.18.0",
|
"tslint": "^6.0.0",
|
||||||
"tslint-config-prettier": "^1.18.0"
|
"tslint-config-prettier": "^1.18.0"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/*",
|
"ts/**/*",
|
||||||
"ts_web/*",
|
"ts_web/**/*",
|
||||||
"dist/*",
|
"dist/**/*",
|
||||||
"dist_web/*",
|
"dist_web/**/*",
|
||||||
"dist_ts_web/*",
|
"dist_ts_web/**/*",
|
||||||
"assets/*",
|
"assets/**/*",
|
||||||
"cli.js",
|
"cli.js",
|
||||||
"npmextra.json",
|
"npmextra.json",
|
||||||
"readme.md"
|
"readme.md"
|
||||||
|
@ -8,7 +8,7 @@ easy cloudflare management
|
|||||||
* [docs (typedoc)](https://mojoio.gitlab.io/cloudflare/)
|
* [docs (typedoc)](https://mojoio.gitlab.io/cloudflare/)
|
||||||
|
|
||||||
## Status for master
|
## Status for master
|
||||||
[](https://gitlab.com/mojoio/cloudflare/commits/master)
|
[](https://gitlab.com/mojoio/cloudflare/commits/master)
|
||||||
[](https://gitlab.com/mojoio/cloudflare/commits/master)
|
[](https://gitlab.com/mojoio/cloudflare/commits/master)
|
||||||
[](https://www.npmjs.com/package/@mojoio/cloudflare)
|
[](https://www.npmjs.com/package/@mojoio/cloudflare)
|
||||||
[](https://snyk.io/test/npm/@mojoio/cloudflare)
|
[](https://snyk.io/test/npm/@mojoio/cloudflare)
|
||||||
@ -21,30 +21,29 @@ easy cloudflare management
|
|||||||
Use TypeScript for best in class instellisense.
|
Use TypeScript for best in class instellisense.
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import * as cflare from 'cflare'
|
import * as cflare from '@mojoio/cloudflare'
|
||||||
|
|
||||||
let myCflareAccount = new cflare.CflareAccount()
|
const myCflareAccount = new cflare.CflareAccount()
|
||||||
testCflareAccount.auth({
|
testCflareAccount.auth({
|
||||||
email: 'someuser@example.com',
|
email: 'someuser@example.com',
|
||||||
key: 'someLongApiKey'
|
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.
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
> 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)
|
||||||
|
|
||||||
[](https://maintainedby.lossless.com)
|
[](https://maintainedby.lossless.com)
|
52
test/test.ts
52
test/test.ts
@ -1,19 +1,25 @@
|
|||||||
|
// tslint:disable-next-line: no-implicit-dependencies
|
||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
import cloudflare = require('../ts/index');
|
// tslint:disable-next-line: no-implicit-dependencies
|
||||||
import { Qenv } from '@pushrocks/qenv';
|
import { Qenv } from '@pushrocks/qenv';
|
||||||
|
|
||||||
|
import cloudflare = require('../ts/index');
|
||||||
|
|
||||||
const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit');
|
const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit');
|
||||||
|
|
||||||
const testCloudflareAccount = new cloudflare.CloudflareAccount();
|
const randomPrefix = Math.floor(Math.random() * 2000);
|
||||||
testCloudflareAccount.auth({
|
let testCloudflareAccount: cloudflare.CloudflareAccount;
|
||||||
|
|
||||||
|
tap.test('should create a valid instance of CloudflareAccount', async () => {
|
||||||
|
testCloudflareAccount = new cloudflare.CloudflareAccount({
|
||||||
email: testQenv.getEnvVarOnDemand('CF_EMAIL'),
|
email: testQenv.getEnvVarOnDemand('CF_EMAIL'),
|
||||||
key: testQenv.getEnvVarOnDemand('CF_KEY')
|
key: testQenv.getEnvVarOnDemand('CF_KEY')
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
const randomPrefix = Math.floor(Math.random() * 2000);
|
tap.test('.listZones() -> should display an entire account', async tools => {
|
||||||
|
|
||||||
tap.skip.test('.listZones() -> should display an entire account', async tools => {
|
|
||||||
tools.timeout(600000);
|
tools.timeout(600000);
|
||||||
const result = await testCloudflareAccount.listZones();
|
const result = await testCloudflareAccount.convenience.listZones();
|
||||||
console.log(result);
|
console.log(result);
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -29,7 +35,7 @@ tap.test(
|
|||||||
'.listRecords(domainName) -> should list all records for a specific Domain Name',
|
'.listRecords(domainName) -> should list all records for a specific Domain Name',
|
||||||
async tools => {
|
async tools => {
|
||||||
tools.timeout(600000);
|
tools.timeout(600000);
|
||||||
await testCloudflareAccount.listRecords('bleu.de').then(async responseArg => {
|
await testCloudflareAccount.convenience.listRecords('bleu.de').then(async responseArg => {
|
||||||
console.log(responseArg);
|
console.log(responseArg);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@ -37,12 +43,15 @@ tap.test(
|
|||||||
|
|
||||||
tap.test('should create a valid record for a subdomain', async tools => {
|
tap.test('should create a valid record for a subdomain', async tools => {
|
||||||
tools.timeout(600000);
|
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 => {
|
tap.test('should get a record from Cloudflare', async tools => {
|
||||||
tools.timeout(600000);
|
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);
|
console.log(responseArg);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@ -50,6 +59,7 @@ tap.test('should get a record from Cloudflare', async tools => {
|
|||||||
tap.test('should remove a subdomain record from Cloudflare', async tools => {
|
tap.test('should remove a subdomain record from Cloudflare', async tools => {
|
||||||
tools.timeout(600000);
|
tools.timeout(600000);
|
||||||
await testCloudflareAccount
|
await testCloudflareAccount
|
||||||
|
.convenience
|
||||||
.removeRecord(`${randomPrefix}subdomain.bleu.de`, 'A')
|
.removeRecord(`${randomPrefix}subdomain.bleu.de`, 'A')
|
||||||
.then(async responseArg => {
|
.then(async responseArg => {
|
||||||
console.log(responseArg);
|
console.log(responseArg);
|
||||||
@ -57,7 +67,27 @@ tap.test('should remove a subdomain record from Cloudflare', async tools => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
tap.test('.purge(some.domain) -> should purge everything', async () => {
|
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)) })`
|
||||||
|
);
|
||||||
|
await worker.setRoutes([
|
||||||
|
{
|
||||||
|
zoneName: 'bleu.de',
|
||||||
|
pattern: 'https://*bleu.de/hello'
|
||||||
|
}
|
||||||
|
]);
|
||||||
|
console.log(worker);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should get workers', async () => {
|
||||||
|
const workerArray = await testCloudflareAccount.workerManager.listWorkers();
|
||||||
|
console.log(workerArray);
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.start();
|
tap.start();
|
||||||
|
@ -1,34 +1,46 @@
|
|||||||
import plugins = require('./cloudflare.plugins');
|
import plugins = require('./cloudflare.plugins');
|
||||||
import * as interfaces from './interfaces/cloudflare.interfaces';
|
import * as interfaces from './interfaces';
|
||||||
|
|
||||||
// interfaces
|
// interfaces
|
||||||
import { TDnsRecord } from '@tsclass/tsclass';
|
|
||||||
import { WorkerManager } from './cloudflare.classes.workermanager';
|
import { WorkerManager } from './cloudflare.classes.workermanager';
|
||||||
import { ZoneManager } from './cloudflare.classes.zonemanager';
|
import { ZoneManager } from './cloudflare.classes.zonemanager';
|
||||||
|
|
||||||
export class CloudflareAccount {
|
export class CloudflareAccount {
|
||||||
private authEmail: string;
|
private authEmail: string;
|
||||||
private authKey: string;
|
private authKey: string;
|
||||||
|
private accountIdentifier: string;
|
||||||
|
|
||||||
public workerManager = new WorkerManager(this);
|
public workerManager = new WorkerManager(this);
|
||||||
public zoneManager = new ZoneManager(this);
|
public zoneManager = new ZoneManager(this);
|
||||||
|
|
||||||
constructor() {
|
/**
|
||||||
// Nothing here
|
* constructor sets auth information on the CloudflareAccountInstance
|
||||||
}
|
* @param optionsArg
|
||||||
|
*/
|
||||||
public auth(optionsArg: { email: string; key: string }) {
|
constructor(optionsArg: { email: string; key: string }) {
|
||||||
this.authEmail = optionsArg.email;
|
this.authEmail = optionsArg.email;
|
||||||
this.authKey = optionsArg.key;
|
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;
|
||||||
|
}
|
||||||
|
return this.accountIdentifier;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* gets a zone id of a domain from cloudflare
|
* gets a zone id of a domain from cloudflare
|
||||||
* @param domainName
|
* @param domainName
|
||||||
*/
|
*/
|
||||||
public async getZoneId(domainName: string) {
|
public async getZoneId(domainName: string) {
|
||||||
const domain = new plugins.smartstring.Domain(domainName);
|
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 => {
|
const filteredResponse = zoneArray.filter(zoneArg => {
|
||||||
return zoneArg.name === domainName;
|
return zoneArg.name === domainName;
|
||||||
});
|
});
|
||||||
@ -43,28 +55,31 @@ export class CloudflareAccount {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public convenience = {
|
||||||
/**
|
/**
|
||||||
* gets a record
|
* gets a record
|
||||||
* @param domainNameArg
|
* @param domainNameArg
|
||||||
* @param typeArg
|
* @param typeArg
|
||||||
*/
|
*/
|
||||||
public async getRecord(
|
getRecord: async (
|
||||||
domainNameArg: string,
|
domainNameArg: string,
|
||||||
typeArg: TDnsRecord
|
typeArg: plugins.tsclass.network.TDnsRecord
|
||||||
): Promise<interfaces.ICflareRecord> {
|
): Promise<interfaces.ICflareRecord> => {
|
||||||
const domain = new plugins.smartstring.Domain(domainNameArg);
|
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 => {
|
const filteredResponse = recordArrayArg.filter(recordArg => {
|
||||||
return recordArg.type === typeArg && recordArg.name === domainNameArg;
|
return recordArg.type === typeArg && recordArg.name === domainNameArg;
|
||||||
});
|
});
|
||||||
return filteredResponse[0];
|
return filteredResponse[0];
|
||||||
}
|
},
|
||||||
|
/**
|
||||||
public async createRecord(
|
* creates a record
|
||||||
|
*/
|
||||||
|
createRecord: async (
|
||||||
domainNameArg: string,
|
domainNameArg: string,
|
||||||
typeArg: TDnsRecord,
|
typeArg: plugins.tsclass.network.TDnsRecord,
|
||||||
contentArg: string
|
contentArg: string
|
||||||
): Promise<any> {
|
): Promise<any> => {
|
||||||
const domain = new plugins.smartstring.Domain(domainNameArg);
|
const domain = new plugins.smartstring.Domain(domainNameArg);
|
||||||
const domainIdArg = await this.getZoneId(domain.zoneName);
|
const domainIdArg = await this.getZoneId(domain.zoneName);
|
||||||
const dataObject = {
|
const dataObject = {
|
||||||
@ -78,36 +93,40 @@ export class CloudflareAccount {
|
|||||||
dataObject
|
dataObject
|
||||||
);
|
);
|
||||||
return response;
|
return response;
|
||||||
}
|
},
|
||||||
|
/**
|
||||||
public removeRecord(domainNameArg: string, typeArg: TDnsRecord) {
|
* removes a record from Cloudflare
|
||||||
const done = plugins.smartpromise.defer();
|
* @param domainNameArg
|
||||||
|
* @param typeArg
|
||||||
|
*/
|
||||||
|
removeRecord: async (
|
||||||
|
domainNameArg: string,
|
||||||
|
typeArg: plugins.tsclass.network.TDnsRecord
|
||||||
|
): Promise<any> => {
|
||||||
const domain = new plugins.smartstring.Domain(domainNameArg);
|
const domain = new plugins.smartstring.Domain(domainNameArg);
|
||||||
this.getRecord(domain.fullName, typeArg).then(responseArg => {
|
const cflareRecord = await this.convenience.getRecord(domain.fullName, typeArg);
|
||||||
if (responseArg) {
|
if (cflareRecord) {
|
||||||
const requestRoute: string =
|
const requestRoute: string = `/zones/${cflareRecord.zone_id}/dns_records/${cflareRecord.id}`;
|
||||||
'/zones/' + responseArg.zone_id + '/dns_records/' + responseArg.id;
|
return await this.request('DELETE', requestRoute);
|
||||||
this.request('DELETE', requestRoute).then(responseArg => {
|
|
||||||
done.resolve(responseArg);
|
|
||||||
});
|
|
||||||
} else {
|
} else {
|
||||||
done.reject();
|
throw new Error(`could not remove record for ${domainNameArg} with type ${typeArg}`);
|
||||||
}
|
}
|
||||||
});
|
},
|
||||||
return done.promise;
|
/**
|
||||||
}
|
* updates a record
|
||||||
|
* @param domainNameArg
|
||||||
public updateRecord(domainNameArg: string, typeArg: string, valueArg) {
|
* @param typeArg
|
||||||
const done = plugins.smartpromise.defer();
|
* @param valueArg
|
||||||
|
*/
|
||||||
|
updateRecord: async (domainNameArg: string, typeArg: string, valueArg) => {
|
||||||
|
// TODO: implement
|
||||||
const domain = new plugins.smartstring.Domain(domainNameArg);
|
const domain = new plugins.smartstring.Domain(domainNameArg);
|
||||||
return done.promise;
|
},
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* list all records of a specified domain name
|
* list all records of a specified domain name
|
||||||
* @param domainNameArg - the domain name that you want to get the records from
|
* @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 domain = new plugins.smartstring.Domain(domainNameArg);
|
||||||
const domainId = await this.getZoneId(domain.zoneName);
|
const domainId = await this.getZoneId(domain.zoneName);
|
||||||
const responseArg: any = await this.request(
|
const responseArg: any = await this.request(
|
||||||
@ -116,13 +135,12 @@ export class CloudflareAccount {
|
|||||||
);
|
);
|
||||||
const result: interfaces.ICflareRecord[] = responseArg.result;
|
const result: interfaces.ICflareRecord[] = responseArg.result;
|
||||||
return result;
|
return result;
|
||||||
}
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* list all zones in the associated authenticated account
|
* list all zones in the associated authenticated account
|
||||||
* @param domainName
|
* @param domainName
|
||||||
*/
|
*/
|
||||||
public async listZones(domainName?: string): Promise<interfaces.ICflareZone[]> {
|
listZones: async (domainName?: string): Promise<interfaces.ICflareZone[]> => {
|
||||||
// TODO: handle pagination
|
// TODO: handle pagination
|
||||||
let requestRoute = `/zones?per_page=50`;
|
let requestRoute = `/zones?per_page=50`;
|
||||||
|
|
||||||
@ -134,9 +152,11 @@ export class CloudflareAccount {
|
|||||||
const response: any = await this.request('GET', requestRoute);
|
const response: any = await this.request('GET', requestRoute);
|
||||||
const result = response.result;
|
const result = response.result;
|
||||||
return 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 domain = new plugins.smartstring.Domain(domainName);
|
||||||
const domainId = await this.getZoneId(domain.zoneName);
|
const domainId = await this.getZoneId(domain.zoneName);
|
||||||
const requestUrl = `/zones/${domainId}/purge_cache`;
|
const requestUrl = `/zones/${domainId}/purge_cache`;
|
||||||
@ -145,8 +165,14 @@ export class CloudflareAccount {
|
|||||||
};
|
};
|
||||||
const respone = await this.request('DELETE', requestUrl, payload);
|
const respone = await this.request('DELETE', requestUrl, payload);
|
||||||
}
|
}
|
||||||
|
};
|
||||||
|
|
||||||
public request(methodArg: string, routeArg: string, dataArg = {}) {
|
public request(
|
||||||
|
methodArg: string,
|
||||||
|
routeArg: string,
|
||||||
|
dataArg: any = {},
|
||||||
|
requestHeadersArg = {}
|
||||||
|
): Promise<any> {
|
||||||
const done = plugins.smartpromise.defer();
|
const done = plugins.smartpromise.defer();
|
||||||
const options: plugins.smartrequest.ISmartRequestOptions = {
|
const options: plugins.smartrequest.ISmartRequestOptions = {
|
||||||
method: methodArg,
|
method: methodArg,
|
||||||
@ -154,11 +180,14 @@ export class CloudflareAccount {
|
|||||||
'Content-Type': 'application/json',
|
'Content-Type': 'application/json',
|
||||||
'X-Auth-Email': this.authEmail,
|
'X-Auth-Email': this.authEmail,
|
||||||
'X-Auth-Key': this.authKey,
|
'X-Auth-Key': this.authKey,
|
||||||
'Content-Length': Buffer.byteLength(JSON.stringify(dataArg))
|
'Content-Length': Buffer.byteLength(JSON.stringify(dataArg)),
|
||||||
|
...requestHeadersArg
|
||||||
},
|
},
|
||||||
requestBody: dataArg
|
requestBody: dataArg
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// console.log(options);
|
||||||
|
|
||||||
let retryCount = 0; // count the amount of retries
|
let retryCount = 0; // count the amount of retries
|
||||||
|
|
||||||
const makeRequest = async () => {
|
const makeRequest = async () => {
|
||||||
@ -173,7 +202,7 @@ export class CloudflareAccount {
|
|||||||
retryRequest();
|
retryRequest();
|
||||||
} else if (response.statusCode === 400) {
|
} else if (response.statusCode === 400) {
|
||||||
console.log(`bad request for route ${routeArg}! Going to retry!`);
|
console.log(`bad request for route ${routeArg}! Going to retry!`);
|
||||||
retryRequest();
|
console.log(response.body);
|
||||||
} else {
|
} else {
|
||||||
console.log(response.statusCode);
|
console.log(response.statusCode);
|
||||||
done.reject(new Error('request failed'));
|
done.reject(new Error('request failed'));
|
||||||
|
92
ts/cloudflare.classes.worker.ts
Normal file
92
ts/cloudflare.classes.worker.ts
Normal file
@ -0,0 +1,92 @@
|
|||||||
|
import * as plugins from './cloudflare.plugins';
|
||||||
|
import * as interfaces from './interfaces';
|
||||||
|
import { WorkerManager } from './cloudflare.classes.workermanager';
|
||||||
|
|
||||||
|
export interface IWorkerRoute extends interfaces.ICflareWorkerRoute {
|
||||||
|
zoneName: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class CloudflareWorker {
|
||||||
|
// STATIC
|
||||||
|
public static async fromApiObject(
|
||||||
|
workerManager: WorkerManager,
|
||||||
|
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;
|
||||||
|
// tslint:disable-next-line: variable-name
|
||||||
|
public created_on: string;
|
||||||
|
// tslint:disable-next-line: variable-name
|
||||||
|
public modified_on: string;
|
||||||
|
|
||||||
|
public routes: IWorkerRoute[] = [];
|
||||||
|
constructor(workerManagerArg: WorkerManager) {
|
||||||
|
this.workerManager = workerManagerArg;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* gets all routes for a worker
|
||||||
|
*/
|
||||||
|
public async getRoutes() {
|
||||||
|
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);
|
||||||
|
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 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
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@ -1,5 +1,6 @@
|
|||||||
import * as plugins from './cloudflare.plugins';
|
import * as plugins from './cloudflare.plugins';
|
||||||
import { CloudflareAccount } from './cloudflare.classes.account';
|
import { CloudflareAccount } from './cloudflare.classes.account';
|
||||||
|
import { CloudflareWorker } from './cloudflare.classes.worker';
|
||||||
|
|
||||||
export class WorkerManager {
|
export class WorkerManager {
|
||||||
public cfAccount: CloudflareAccount;
|
public cfAccount: CloudflareAccount;
|
||||||
@ -7,4 +8,29 @@ export class WorkerManager {
|
|||||||
constructor(cfAccountArg: CloudflareAccount) {
|
constructor(cfAccountArg: CloudflareAccount) {
|
||||||
this.cfAccount = cfAccountArg;
|
this.cfAccount = cfAccountArg;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
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 CloudflareWorker.fromApiObject(this, responseBody.result);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* lists workers
|
||||||
|
*/
|
||||||
|
public async listWorkers() {
|
||||||
|
const accountIdentifier = await this.cfAccount.getAccountIdentifier();
|
||||||
|
const route = `/accounts/${accountIdentifier}/workers/scripts`;
|
||||||
|
const response = await this.cfAccount.request('GET', route);
|
||||||
|
const results = response.result;
|
||||||
|
const workers: CloudflareWorker[] = [];
|
||||||
|
for (const apiObject of results) {
|
||||||
|
workers.push(await CloudflareWorker.fromApiObject(this, apiObject));
|
||||||
|
}
|
||||||
|
return workers;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
6
ts/cloudflare.classes.zone.ts
Normal file
6
ts/cloudflare.classes.zone.ts
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
import * as plugins from './cloudflare.plugins';
|
||||||
|
import * as interfaces from './interfaces';
|
||||||
|
|
||||||
|
export class CloudflareZone {
|
||||||
|
// TODO
|
||||||
|
}
|
@ -1 +1,2 @@
|
|||||||
export { CloudflareAccount } from './cloudflare.classes.account';
|
export { CloudflareAccount } from './cloudflare.classes.account';
|
||||||
|
export { CloudflareWorker } from './cloudflare.classes.worker';
|
||||||
|
15
ts/interfaces/cloudflare.api.record.ts
Normal file
15
ts/interfaces/cloudflare.api.record.ts
Normal file
@ -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;
|
||||||
|
}
|
5
ts/interfaces/cloudflare.api.workerroute.ts
Normal file
5
ts/interfaces/cloudflare.api.workerroute.ts
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
export interface ICflareWorkerRoute {
|
||||||
|
id: string;
|
||||||
|
pattern: string;
|
||||||
|
script: string;
|
||||||
|
}
|
@ -1,5 +1,3 @@
|
|||||||
import * as plugins from '../cloudflare.plugins';
|
|
||||||
|
|
||||||
export interface ICflareZone {
|
export interface ICflareZone {
|
||||||
id: string;
|
id: string;
|
||||||
name: string;
|
name: string;
|
||||||
@ -41,19 +39,3 @@ export interface ICflareZone {
|
|||||||
type: string;
|
type: string;
|
||||||
checked_on: 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;
|
|
||||||
}
|
|
@ -1 +1,3 @@
|
|||||||
export * from './cloudflare.interfaces';
|
export * from './cloudflare.api.record';
|
||||||
|
export * from './cloudflare.api.zone';
|
||||||
|
export * from './cloudflare.api.workerroute';
|
||||||
|
Reference in New Issue
Block a user