Compare commits

..

40 Commits

Author SHA1 Message Date
4e3355dc43 6.0.1 2022-09-27 19:24:52 +02:00
fc0a27f5b6 fix(core): update 2022-09-27 19:24:52 +02:00
0248d52548 6.0.0 2022-09-27 19:24:00 +02:00
c3984819cc BREAKING CHANGE(core): switch to esm 2022-09-27 19:24:00 +02:00
045b87a4a2 5.0.10 2022-09-27 19:23:21 +02:00
48ca9fdbb9 fix(core): update 2022-09-27 19:23:20 +02:00
e466944c55 5.0.9 2021-01-22 21:12:42 +00:00
6d8deca9d4 fix(core): update 2021-01-22 21:12:42 +00:00
a4518f3068 5.0.8 2021-01-22 20:46:26 +00:00
9e338354c6 fix(core): update 2021-01-22 20:46:26 +00:00
9d8c14d187 5.0.7 2021-01-22 20:45:36 +00:00
5a0b12f6aa fix(core): update 2021-01-22 20:45:35 +00:00
387f00078f 5.0.6 2020-06-10 05:34:48 +00:00
fe2f45e3a9 fix(core): update 2020-06-10 05:34:47 +00:00
90c9bfc906 5.0.5 2020-06-10 05:15:23 +00:00
4f9e81f612 fix(core): update 2020-06-10 05:15:22 +00:00
a4e280f9f0 5.0.4 2020-02-28 14:57:42 +00:00
52bd80aebd fix(core): update 2020-02-28 14:57:41 +00:00
15e3cdae83 5.0.3 2020-02-28 14:55:34 +00:00
c72147b469 fix(core): update 2020-02-28 14:55:33 +00:00
d98c2f89c5 5.0.2 2020-02-28 14:47:04 +00:00
2b722816f6 fix(core): update 2020-02-28 14:47:03 +00:00
91d58277dd 5.0.1 2020-02-28 14:24:37 +00:00
2458da6754 fix(core): update 2020-02-28 14:24:36 +00:00
d4379d19d3 5.0.0 2020-02-19 17:00:32 +00:00
b0fdd520f3 BREAKING CHANGE(account): authorization now uses the new Account API 2020-02-19 17:00:31 +00:00
a746577945 4.0.5 2020-02-19 16:58:47 +00:00
bc4cae3333 fix(core): update 2020-02-19 16:58:46 +00:00
e0614b5956 4.0.4 2020-02-19 14:16:24 +00:00
f568949085 fix(core): update 2020-02-19 14:16:23 +00:00
bee256416f 4.0.3 2020-02-10 14:40:56 +00:00
afa2679501 fix(core): update 2020-02-10 14:40:55 +00:00
7838642fd5 4.0.2 2020-02-10 14:38:45 +00:00
7a992badf4 fix(core): update 2020-02-10 14:38:44 +00:00
c65790e2f9 4.0.1 2020-02-10 11:26:13 +00:00
7ec0fe78fc fix(core): update 2020-02-10 11:26:13 +00:00
12f4456ebd 4.0.0 2020-02-09 18:22:35 +00:00
3e8cf73877 BREAKING CHANGE(API): move to .convenience property 2020-02-09 18:22:34 +00:00
0032292714 3.0.7 2020-02-09 17:54:34 +00:00
ead87ceb63 fix(core): update 2020-02-09 17:54:33 +00:00
22 changed files with 12791 additions and 1512 deletions

4
.gitignore vendored
View File

@ -15,8 +15,6 @@ node_modules/
# builds # builds
dist/ dist/
dist_web/ dist_*/
dist_serve/
dist_ts_web/
# custom # custom

View File

@ -12,29 +12,35 @@ stages:
- release - release
- metadata - metadata
before_script:
- npm install -g @shipzone/npmci
# ==================== # ====================
# security stage # security stage
# ==================== # ====================
mirror: auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci git mirror - npmci npm prepare
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags: tags:
- lossless
- docker - docker
- notpriv allow_failure: true
snyk: auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:snyk image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci npm prepare - npmci npm prepare
- npmci command npm install --ignore-scripts - npmci command npm install --ignore-scripts
- npmci command snyk test - npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags: tags:
- lossless
- docker - docker
- notpriv allow_failure: true
# ==================== # ====================
# test stage # test stage
@ -49,9 +55,7 @@ testStable:
- npmci npm test - npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- lossless
- docker - docker
- priv
testBuild: testBuild:
stage: test stage: test
@ -62,9 +66,7 @@ testBuild:
- 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
release: release:
stage: release stage: release
@ -84,11 +86,12 @@ release:
codequality: codequality:
stage: metadata stage: metadata
allow_failure: true allow_failure: true
only:
- tags
script: script:
- npmci command npm install -g tslint typescript - npmci command npm install -g typescript
- npmci npm prepare - npmci npm prepare
- npmci npm install - npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags: tags:
- lossless - lossless
- docker - docker
@ -108,11 +111,10 @@ trigger:
pages: pages:
stage: metadata stage: metadata
script: script:
- npmci node install lts - npmci node install stable
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare - npmci npm prepare
- npmci npm install - npmci npm install
- npmci command tsdoc - npmci command npm run buildDocs
tags: tags:
- lossless - lossless
- docker - docker

24
.vscode/launch.json vendored
View File

@ -2,28 +2,10 @@
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{ {
"name": "current file", "command": "npm test",
"type": "node", "name": "Run npm test",
"request": "launch", "request": "launch",
"args": [ "type": "node-terminal"
"${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"
} }
] ]
} }

View File

@ -15,7 +15,7 @@
"properties": { "properties": {
"projectType": { "projectType": {
"type": "string", "type": "string",
"enum": ["website", "element", "service", "npm"] "enum": ["website", "element", "service", "npm", "wcc"]
} }
} }
} }

View File

@ -9,7 +9,7 @@
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "mojoio", "gitscope": "mojoio",
"gitrepo": "cloudflare", "gitrepo": "cloudflare",
"shortDescription": "easy cloudflare management", "description": "easy cloudflare management",
"npmPackagename": "@mojoio/cloudflare", "npmPackagename": "@mojoio/cloudflare",
"license": "MIT" "license": "MIT"
} }

13551
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,13 +1,15 @@
{ {
"name": "@mojoio/cloudflare", "name": "@mojoio/cloudflare",
"version": "3.0.6", "version": "6.0.1",
"private": false, "private": false,
"description": "easy cloudflare management", "description": "easy cloudflare management",
"main": "dist/index.js", "main": "dist_ts/index.js",
"typings": "dist/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module",
"scripts": { "scripts": {
"test": "(tstest test/)", "test": "(tstest test/)",
"build": "(tsbuild)" "build": "(tsbuild --web --allowimplicitany)",
"buildDocs": "tsdoc"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@ -24,32 +26,34 @@
}, },
"homepage": "https://gitlab.com/pushrocks/cflare#readme", "homepage": "https://gitlab.com/pushrocks/cflare#readme",
"dependencies": { "dependencies": {
"@pushrocks/smartdelay": "^2.0.6", "@pushrocks/smartdelay": "^2.0.10",
"@pushrocks/smartlog": "^2.0.21", "@pushrocks/smartlog": "^3.0.1",
"@pushrocks/smartpromise": "^3.0.6", "@pushrocks/smartpromise": "^3.1.3",
"@pushrocks/smartrequest": "^1.1.47", "@pushrocks/smartrequest": "^2.0.11",
"@pushrocks/smartstring": "^3.0.18", "@pushrocks/smartstring": "^4.0.5",
"@tsclass/tsclass": "^3.0.4" "@tsclass/tsclass": "^4.0.21"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.17", "@gitzone/tsbuild": "^2.1.65",
"@gitzone/tsrun": "^1.2.8", "@gitzone/tsrun": "^1.2.37",
"@gitzone/tstest": "^1.0.28", "@gitzone/tstest": "^1.0.73",
"@pushrocks/qenv": "^4.0.6", "@pushrocks/qenv": "^5.0.2",
"@pushrocks/tapbundle": "^3.2.0", "@pushrocks/tapbundle": "^5.0.4",
"@types/node": "^13.7.0", "@types/node": "^18.7.23"
"tslint": "^6.0.0",
"tslint-config-prettier": "^1.18.0"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",
"ts_web/**/*", "ts_web/**/*",
"dist/**/*", "dist/**/*",
"dist_web/**/*", "dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*", "dist_ts_web/**/*",
"assets/**/*", "assets/**/*",
"cli.js", "cli.js",
"npmextra.json", "npmextra.json",
"readme.md" "readme.md"
],
"browserslist": [
"last 1 chrome versions"
] ]
} }

View File

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

52
readme.md Normal file
View File

@ -0,0 +1,52 @@
# @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
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/mojoio/cloudflare/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/mojoio/cloudflare/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@mojoio/cloudflare)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/mojoio/cloudflare)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@mojoio/cloudflare)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@mojoio/cloudflare)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@mojoio/cloudflare)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage
Use TypeScript for best in class instellisense.
```javascript
import * as cflare from '@mojoio/cloudflare';
const myCflareAccount = new cflare.CflareAccount('mySuperAwesomeAccountToken');
const myAsyncCflareManagement = async () => {
// get things
const myZones = await myCflareAccount.listZones(); // zones are fully typed
const myIdForADomain = await myCflareAccount.getZoneId('example.com'); // type number
const myRecordsForADomain = await myCflareAccount.listRecords('example.com'); // records are fully typed
};
```
## Contribution
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

View File

@ -3,7 +3,7 @@ import { expect, tap } from '@pushrocks/tapbundle';
// tslint:disable-next-line: no-implicit-dependencies // tslint:disable-next-line: no-implicit-dependencies
import { Qenv } from '@pushrocks/qenv'; import { Qenv } from '@pushrocks/qenv';
import cloudflare = require('../ts/index'); import * as cloudflare from '../ts/index.js';
const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit'); const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit');
@ -11,61 +11,63 @@ const randomPrefix = Math.floor(Math.random() * 2000);
let testCloudflareAccount: cloudflare.CloudflareAccount; let testCloudflareAccount: cloudflare.CloudflareAccount;
tap.test('should create a valid instance of CloudflareAccount', async () => { 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.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);
}); });
tap.test( tap.test(
'.getZoneId(domainName) -> should get an Cloudflare Id for a domain string', '.getZoneId(domainName) -> should get an Cloudflare Id for a domain string',
async tools => { async (tools) => {
tools.timeout(600000); tools.timeout(600000);
await testCloudflareAccount.getZoneId('bleu.de'); await testCloudflareAccount.convenience.getZoneId('bleu.de');
} }
); );
tap.test( 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);
}); });
} }
); );
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',
120
);
}); });
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 await testCloudflareAccount.convenience
.getRecord(`${randomPrefix}subdomain.bleu.de`, 'A') .getRecord(`${randomPrefix}subdomain.bleu.de`, 'A')
.then(responseArg => { .then((responseArg) => {
console.log(responseArg); console.log(responseArg);
}); });
}); });
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);
}); });
}); });
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 // WORKERS
@ -77,8 +79,8 @@ tap.test('should create a worker', async () => {
await worker.setRoutes([ await worker.setRoutes([
{ {
zoneName: 'bleu.de', zoneName: 'bleu.de',
pattern: 'https://*bleu.de/hello' pattern: 'https://*bleu.de/hello',
} },
]); ]);
console.log(worker); console.log(worker);
}); });

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@mojoio/cloudflare',
version: '6.0.1',
description: 'easy cloudflare management'
}

View File

@ -1,13 +1,13 @@
import plugins = require('./cloudflare.plugins'); import * as plugins from './cloudflare.plugins.js';
import * as interfaces from './interfaces'; import { logger } from './cloudflare.logger.js';
import * as interfaces from './interfaces/index.js';
// interfaces // interfaces
import { WorkerManager } from './cloudflare.classes.workermanager'; import { WorkerManager } from './cloudflare.classes.workermanager.js';
import { ZoneManager } from './cloudflare.classes.zonemanager'; import { ZoneManager } from './cloudflare.classes.zonemanager.js';
export class CloudflareAccount { export class CloudflareAccount {
private authEmail: string; private authToken: string;
private authKey: string;
private accountIdentifier: string; private accountIdentifier: string;
public workerManager = new WorkerManager(this); public workerManager = new WorkerManager(this);
@ -17,195 +17,259 @@ export class CloudflareAccount {
* constructor sets auth information on the CloudflareAccountInstance * constructor sets auth information on the CloudflareAccountInstance
* @param optionsArg * @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() { public async getAccountIdentifier() {
if (!this.accountIdentifier) { if (!this.accountIdentifier) {
const route = `/accounts?page=1&per_page=20&direction=desc`; const route = `/accounts?page=1&per_page=20&direction=desc`;
const response: any = await this.request('GET', route); const response: any = await this.request('GET', route);
this.accountIdentifier = response.result[0].id; this.accountIdentifier = response.result[0].id;
// console.log('Account identifier is: ' + this.accountIdentifier);
} }
return 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', logger.log('error', `the domain ${domainName} does not appear to be in this account!`);
`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,
ttlArg = 1
): 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,
ttl: ttlArg,
};
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
* gets a record if (domainName) {
* @param domainNameArg requestRoute = `${requestRoute}&name=${domainName}`;
* @param typeArg }
*/
public async getRecord(
domainNameArg: string,
typeArg: plugins.tsclass.network.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( const response: any = await this.request('GET', requestRoute);
domainNameArg: string, const result = response.result;
typeArg: plugins.tsclass.network.TDnsRecord, return result;
contentArg: string },
): Promise<any> { /**
const domain = new plugins.smartstring.Domain(domainNameArg); * purges a zone
const domainIdArg = await this.getZoneId(domain.zoneName); */
const dataObject = { purgeZone: async (domainName: string): Promise<void> => {
name: domain.fullName, const domain = new plugins.smartstring.Domain(domainName);
type: typeArg, const domainId = await this.convenience.getZoneId(domain.zoneName);
content: contentArg const requestUrl = `/zones/${domainId}/purge_cache`;
}; const payload = {
const response = await this.request( purge_everything: true,
'POST', };
'/zones/' + domainIdArg + '/dns_records', const respone = await this.request('DELETE', requestUrl, payload);
dataObject },
); // acme convenience functions
return response; acmeSetDnsChallenge: async (dnsChallenge: plugins.tsclass.network.IDnsChallenge) => {
} await this.convenience.cleanRecord(dnsChallenge.hostName, 'TXT');
await this.convenience.createRecord(
dnsChallenge.hostName,
'TXT',
dnsChallenge.challenge,
120
);
},
acmeRemoveDnsChallenge: async (dnsChallenge: plugins.tsclass.network.IDnsChallenge) => {
await this.convenience.removeRecord(dnsChallenge.hostName, 'TXT');
},
};
/** public async request(
* removes a record from Cloudflare
* @param domainNameArg
* @param typeArg
*/
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) {
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, methodArg: string,
routeArg: string, routeArg: string,
dataArg: any = {}, dataArg: any = {},
requestHeadersArg = {} requestHeadersArg = {}
): Promise<any> { ): Promise<any> {
const done = plugins.smartpromise.defer();
const options: plugins.smartrequest.ISmartRequestOptions = { const options: plugins.smartrequest.ISmartRequestOptions = {
method: methodArg, method: methodArg,
headers: { headers: {
'Content-Type': 'application/json', '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)), 'Content-Length': Buffer.byteLength(JSON.stringify(dataArg)),
...requestHeadersArg ...requestHeadersArg,
}, },
requestBody: dataArg 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); // console.log(options);
let retryCount = 0; // count the amount of retries 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) { 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) { } else if (response.statusCode === 429) {
console.log('rate limited! Waiting for retry!'); console.log('rate limited! Waiting for retry!');
retryRequest(); return await 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 ${requestUrl}!`);
console.log(response.body); console.log(response.body);
throw new Error(`request failed for ${requestUrl}`);
} else { } 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 ( const retryRequest = async (
delayTimeArg = Math.floor(Math.random() * (60000 - 8000) + 8000) delayTimeArg = Math.floor(Math.random() * (60000 - 8000) + 8000)
) => { ) => {
@ -216,13 +280,11 @@ export class CloudflareAccount {
return await makeRequest(); return await makeRequest();
} }
}; };
makeRequest(); const response = await makeRequest();
return done.promise; return response.body;
} }
private authCheck() { private authCheck() {
return this.authEmail && this.authKey; // check if auth is available return !!this.authToken; // check if auth is available
} }
// acme convenience functions
} }

View File

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

View File

@ -1,6 +1,7 @@
import * as plugins from './cloudflare.plugins'; import * as plugins from './cloudflare.plugins.js';
import * as interfaces from './interfaces'; import * as interfaces from './interfaces/index.js';
import { WorkerManager } from './cloudflare.classes.workermanager'; import { WorkerManager } from './cloudflare.classes.workermanager.js';
import { logger } from './cloudflare.logger.js';
export interface IWorkerRoute extends interfaces.ICflareWorkerRoute { export interface IWorkerRoute extends interfaces.ICflareWorkerRoute {
zoneName: string; zoneName: string;
@ -13,7 +14,7 @@ export class CloudflareWorker {
apiObject apiObject
): Promise<CloudflareWorker> { ): Promise<CloudflareWorker> {
const newWorker = new CloudflareWorker(workerManager); const newWorker = new CloudflareWorker(workerManager);
Object.assign(newWorker, apiObject.result); Object.assign(newWorker, apiObject);
await newWorker.getRoutes(); await newWorker.getRoutes();
return newWorker; return newWorker;
} }
@ -38,7 +39,7 @@ export class CloudflareWorker {
* gets all routes for a worker * gets all routes for a worker
*/ */
public async getRoutes() { public async getRoutes() {
const zones = await this.workerManager.cfAccount.listZones(); const zones = await this.workerManager.cfAccount.convenience.listZones();
for (const zone of zones) { for (const zone of zones) {
const requestRoute = `/zones/${zone.id}/workers/routes`; const requestRoute = `/zones/${zone.id}/workers/routes`;
const response: { const response: {
@ -66,25 +67,25 @@ export class CloudflareWorker {
routeIdForUpdate = existingRoute.id; routeIdForUpdate = existingRoute.id;
if (existingRoute.script === this.id) { if (existingRoute.script === this.id) {
routeStatus = 'alreadyUpToDate'; 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 // lets care about actually setting routes
if (routeStatus === 'new') { 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`; const requestRoute = `/zones/${zoneId}/workers/routes`;
await this.workerManager.cfAccount.request('POST', requestRoute, { await this.workerManager.cfAccount.request('POST', requestRoute, {
pattern: newRoute.pattern, pattern: newRoute.pattern,
script: this.id script: this.id,
}); });
} else if (routeStatus === 'needsUpdate') { } 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}`; const requestRoute = `/zones/${zoneId}/workers/routes/${routeIdForUpdate}`;
await this.workerManager.cfAccount.request('PUT', requestRoute, { await this.workerManager.cfAccount.request('PUT', requestRoute, {
pattern: newRoute.pattern, pattern: newRoute.pattern,
script: this.id script: this.id,
}); });
} }
} }

View File

@ -1,6 +1,6 @@
import * as plugins from './cloudflare.plugins'; import * as plugins from './cloudflare.plugins.js';
import { CloudflareAccount } from './cloudflare.classes.account'; import { CloudflareAccount } from './cloudflare.classes.account.js';
import { CloudflareWorker } from './cloudflare.classes.worker'; import { CloudflareWorker } from './cloudflare.classes.worker.js';
export class WorkerManager { export class WorkerManager {
public cfAccount: CloudflareAccount; public cfAccount: CloudflareAccount;
@ -14,9 +14,9 @@ export class WorkerManager {
const route = `/accounts/${accountIdentifier}/workers/scripts/${workerName}`; const route = `/accounts/${accountIdentifier}/workers/scripts/${workerName}`;
const responseBody = await this.cfAccount.request('PUT', route, workerScript, { const responseBody = await this.cfAccount.request('PUT', route, workerScript, {
'Content-Type': 'application/javascript', 'Content-Type': 'application/javascript',
'Content-Length': Buffer.byteLength(workerScript) 'Content-Length': Buffer.byteLength(workerScript),
}); });
return CloudflareWorker.fromApiObject(this, responseBody); return CloudflareWorker.fromApiObject(this, responseBody.result);
} }
/** /**

View File

@ -1,6 +1,50 @@
import * as plugins from './cloudflare.plugins'; import * as plugins from './cloudflare.plugins.js';
import * as interfaces from './interfaces'; import * as interfaces from './interfaces/index.js';
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;
} }

View File

@ -1,5 +1,7 @@
import * as plugins from './cloudflare.plugins'; import * as plugins from './cloudflare.plugins.js';
import { CloudflareAccount } from './cloudflare.classes.account'; import * as interfaces from './interfaces/index.js';
import { CloudflareAccount } from './cloudflare.classes.account.js';
import { CloudflareZone } from './cloudflare.classes.zone.js';
export class ZoneManager { export class ZoneManager {
public cfAccount: CloudflareAccount; public cfAccount: CloudflareAccount;
@ -8,4 +10,23 @@ export class ZoneManager {
constructor(cfAccountArg: CloudflareAccount) { constructor(cfAccountArg: CloudflareAccount) {
this.cfAccount = cfAccountArg; 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;
}
} }

3
ts/cloudflare.logger.ts Normal file
View File

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

View File

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

View File

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

10
tsconfig.json Normal file
View File

@ -0,0 +1,10 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "nodenext",
"esModuleInterop": true
}
}

View File

@ -1,17 +0,0 @@
{
"extends": ["tslint:latest", "tslint-config-prettier"],
"rules": {
"semicolon": [true, "always"],
"no-console": false,
"ordered-imports": false,
"object-literal-sort-keys": false,
"member-ordering": {
"options":{
"order": [
"static-method"
]
}
}
},
"defaultSeverity": "warning"
}