Compare commits

..

130 Commits

Author SHA1 Message Date
d1788dc626 6.0.6 2025-03-19 07:07:08 +00:00
ba49c42dd8 fix(core): Improve logging consistency, record update functionality, and API error handling in Cloudflare modules 2025-03-19 07:07:08 +00:00
4600749442 6.0.5 2024-06-17 01:36:40 +02:00
b0f8d1e4d0 fix(start supporting workers again): update 2024-06-17 01:36:39 +02:00
902ca30529 update license info 2024-06-15 19:56:32 +02:00
5731150157 update readme 2024-06-15 19:55:48 +02:00
f39f8cd33c switch to official cloudflare api client while keeping class based approach 2024-06-15 19:47:09 +02:00
1d2e0974b2 6.0.4 2024-06-15 17:08:04 +02:00
801f86fede fix(core): update 2024-06-15 17:08:03 +02:00
42feb09b4f 6.0.3 2023-06-13 19:01:56 +02:00
d72bb28cf9 fix(core): update 2023-06-13 19:01:56 +02:00
b9f0b798c9 6.0.2 2023-06-13 18:54:26 +02:00
9b5f42ef9b fix(core): update 2023-06-13 18:54:25 +02:00
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
04d70a4d12 3.0.6 2020-02-09 17:36:30 +00:00
8da43a79d3 fix(core): update 2020-02-09 17:36:29 +00:00
3153021190 3.0.5 2019-07-19 12:39:40 +02:00
82701c19e7 fix(core): update 2019-07-19 12:39:39 +02:00
d3a68b4fef 3.0.4 2019-07-18 17:17:49 +02:00
c4c1367306 fix(core): update 2019-07-18 17:17:48 +02:00
1f5352d9f5 3.0.3 2019-07-18 17:12:04 +02:00
f652cc72fe fix(core): update 2019-07-18 17:12:03 +02:00
f510408fce 3.0.2 2019-07-18 15:31:25 +02:00
e250e9b1a2 fix(core): update 2019-07-18 15:31:24 +02:00
5a9b7bbeee 3.0.1 2019-07-18 14:44:45 +02:00
1158b4ff99 fix(core): update 2019-07-18 14:44:45 +02:00
8eb777dd45 3.0.0 2019-07-18 14:25:40 +02:00
acf5c242d3 2.0.2 2019-07-18 14:25:10 +02:00
9e9dd8d935 fix(core): update 2019-07-18 14:25:10 +02:00
b7cc500f4d 2.0.1 2019-07-18 11:51:57 +02:00
8a4126a49c fix(core): update 2019-07-18 11:51:56 +02:00
b86391ca00 2.0.0 2018-08-14 01:53:52 +02:00
92682c1276 BREAKING CHANGE(scope): change scope, tools and package name 2018-08-14 01:53:52 +02:00
05677231f7 1.0.5 2017-06-11 21:07:45 +02:00
9c036925fd now using tsclass 2017-06-11 21:07:41 +02:00
d3d5f72193 1.0.4 2017-06-09 22:25:22 +02:00
3d7c0e6b64 update dependencies 2017-06-09 22:25:19 +02:00
4faefb0bd7 1.0.3 2017-06-05 19:14:29 +02:00
162fff134e now supports purging of assets 2017-06-05 19:14:26 +02:00
426237b2a7 improve test 2017-06-04 18:14:19 +02:00
b2d48d793a 1.0.2 2017-06-04 18:11:39 +02:00
54282bdc14 add npmextra.json 2017-06-04 18:11:37 +02:00
208fba0887 1.0.1 2017-06-04 18:09:49 +02:00
2f065b57fc add type TRecord, update ci 2017-06-04 18:09:46 +02:00
3503fbc7b3 1.0.0 2017-06-04 17:31:10 +02:00
1db3342353 0.0.20 2017-06-04 17:29:20 +02:00
03380b0d28 go async/await 2017-06-04 17:29:19 +02:00
4fe7ec8a66 update brand link 2017-02-12 22:28:26 +01:00
a050271574 0.0.19 2017-02-12 21:24:58 +01:00
d54884ded7 update README 2017-02-12 21:18:32 +01:00
30f7fa9c8a 0.0.18 2017-01-29 18:22:20 +01:00
6bc7edceb9 update README 2017-01-29 18:22:17 +01:00
2ee94dd179 0.0.17 2017-01-29 18:05:42 +01:00
a4a006e490 fix tests to run in parallel 2017-01-29 18:05:39 +01:00
98d5127846 0.0.16 2017-01-29 17:52:28 +01:00
f63d8abfc6 fixed bad request retry 2017-01-29 17:51:53 +01:00
266f84f33a 0.0.15 2017-01-29 17:45:54 +01:00
6400e0f038 fix testing timeouts 2017-01-29 17:45:48 +01:00
b4838566ac 0.0.14 2017-01-29 17:42:22 +01:00
803f1ce41a added random retry times 2017-01-29 17:42:15 +01:00
8a8adb48c6 0.0.13 2017-01-29 17:29:13 +01:00
078731fe7b update to new ci 2017-01-29 17:29:06 +01:00
bf15b8aec7 0.0.12 2017-01-29 17:27:52 +01:00
55b305ca1c now using smartrequest 2017-01-29 17:27:48 +01:00
9699e4bf76 0.0.11 2017-01-22 19:37:04 +01:00
0692d16dd7 now reacting to rate limiting 2017-01-22 19:37:00 +01:00
c76643d700 0.0.10 2016-07-31 23:55:25 +02:00
de088ba550 update dependencies 2016-07-31 23:54:13 +02:00
1ecf660368 0.0.9 2016-06-22 13:30:02 +02:00
a04ce339f2 0.0.8 2016-06-22 13:29:58 +02:00
feed201dc1 0.0.7 2016-06-22 13:01:38 +02:00
cb73164c8f updated dependencies 2016-06-22 13:01:28 +02:00
4758f31132 0.0.6 2016-06-21 19:11:48 +02:00
5a0ab5080d fix stages 2016-06-21 19:11:45 +02:00
26bb194814 0.0.5 2016-06-21 19:08:37 +02:00
4a656cf7f1 fix stages 2016-06-21 19:08:31 +02:00
9a35e69ab6 0.0.4 2016-06-21 19:04:46 +02:00
757a9acd09 now works for most things 2016-06-21 19:04:43 +02:00
9cb3c1508e update to latest dependencies 2016-06-20 22:56:09 +02:00
d25033b84b update .gitlab.yml 2016-06-19 20:09:41 +02:00
941611b7fb update 2016-06-18 15:36:15 +02:00
441d66d6f6 add .gitlab-ci.yml 2016-05-30 06:09:13 +02:00
ba2d6f4237 0.0.3 2016-05-25 07:17:50 +02:00
ff71de8f6c improve domain string handling 2016-05-25 07:06:06 +02:00
e99d597c12 update .getRecord 2016-05-25 06:32:56 +02:00
f44698078e improve .createRecord 2016-05-25 06:26:48 +02:00
0ed9c7f4f4 implemented .createRecord 2016-05-24 23:36:06 +02:00
f4d4bc238b compile 2016-05-16 03:44:02 +02:00
f4c2bb6e5b add functionality 2016-05-16 03:29:29 +02:00
b2182ec63d start with tests 2016-05-15 19:51:48 +02:00
6cc91c0a5e improved request method of cflare class 2016-04-27 06:01:50 +02:00
38 changed files with 8740 additions and 143 deletions

23
.gitignore vendored
View File

@ -1,7 +1,20 @@
.nogit/
# artifacts
coverage/
docs/
ts/typings/
ts/**/*.js
ts/**/*.js.map
.idea/
public/
pages/
# installs
node_modules/
# caches
.yarn/
.cache/
.rpt2_cache
# builds
dist/
dist_*/
# custom

View File

@ -1,12 +0,0 @@
language: node_js
node_js:
- '4'
- stable
deploy:
provider: npm
email: npm@lossless.digital
api_key:
secure: uWqO634z8xMWI8tcIpSvUeVeG4ypX5fppXWxrSKbO5zOHCHGqJK90XiGFfKUekMf0cYQPb5dLT5+J/3nd4mf4KtU3+v1OK6ZikEqn/PcSeqOmK7EnI9wDFZwDTgJWIn0lRwX2mfB9meblSZ7XthTXumX78fmRTyeyImLm9P0ak+CrNzs8rzKauBoqeVryOez4/LaH3f0kxSz7o7zYLxFqx5xjQ7TFqd1kkVTf4pSQanLHY3z+7+mKrkbcNVxx2gF76hyx6E4pntSJHrOEE/VU/KMk2B6yzrVWYUHUiSRGYOV9U17YaaWlC9DZmnS1cvYcqq3YNujTwPWtci3It9S98hLrSTnCCqin6xhj8IuV6U4WADiXOUvNKuTRcd0/leQ4w3xpPJ1FR2gRtEhwQ0NsnY0vL9tuRAW71lf31122TTJI8lJQNrnaeIGbX7eE0Pq0jeTpmM2W/Tl8pl6s6zBjlEC/mCynQq1pBiz7UmxMYCPE162I8V5USeZOBLzDPZV2y7hmPWjMrWTT+i/IpFmXHjQtVrwlyU6fCOeYHgK/5GdyhnrRYYlx+ce6pCn4tmkVxduimC3m1G8cTkPl00fIpy7KSVcaeQrc1N+KQUqK4FpIjeqB904SVPsI5v3P7sdobaT1aqFqszhR+JK5tXaoesew8R2RncjFK69J7DHJWk=
on:
tags: true
repo: pushrocks/cflare

11
.vscode/launch.json vendored Normal file
View File

@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "npm test",
"name": "Run npm test",
"request": "launch",
"type": "node-terminal"
}
]
}

26
.vscode/settings.json vendored Normal file
View 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", "wcc"]
}
}
}
}
}
}
]
}

View File

@ -1,31 +0,0 @@
# cflare
allows you to manage multiple cloudflare accounts.
> Note: this package is still in alpha, so some things do not yet work.
I (Phil from Lossless) expect this package to be ready 1. of June 2016.
## Status
[![Build Status](https://travis-ci.org/pushrocks/cflare.svg?branch=master)](https://travis-ci.org/pushrocks/cflare)
## Usage
```javascript
var cflare = require("cflare");
var cflareInstance = new cflare();
cflareInstance.auth({
email:"",
key:""
});
cflareInstance.createRecord(); // returns promise with resolve function getting the response;
cflareInstance.removeRecord(); // returns promise with resolve function getting the response;
cflareInstance.copyRecord(); // returns promise with resolve function getting the response;
cflareInstance.listRecords(); // returns promise with resolve function getting the response;
cflareInstance.listDomains(); // returns promise with resolve function getting the response;
```
### About the authors:
[![Project Phase](https://mediaserve.lossless.digital/lossless.com/img/createdby_github.svg)](https://lossless.com/)
[![Gitter](https://img.shields.io/badge/Support%20us-PayPal-blue.svg)](https://paypal.me/lossless)

219
changelog.md Normal file
View File

@ -0,0 +1,219 @@
# Changelog
## 2025-03-19 - 6.0.6 - fix(core)
Improve logging consistency, record update functionality, and API error handling in Cloudflare modules
- Replaced raw console.log calls with logger.log for unified logging across modules
- Implemented and documented the updateRecord method with proper parameters in CloudflareAccount
- Enhanced API request error handling and added detailed documentation in request methods
- Refactored CloudflareWorker and WorkerManager methods to improve clarity and maintainability
- Updated ZoneManager and CloudflareZone to improve error reporting and zone manipulation
## 2024-06-16 - 6.0.5 no significant changes
_No significant changes in this release._
## 2024-06-16 - 6.0.4 miscellaneous
Several improvements and fixes:
- fix(start supporting workers again): update
- update license info
- update readme
- switch to official cloudflare api client while keeping class based approach
## 2024-06-15 - 6.0.3 core
- fix(core): update
## 2023-06-13 - 6.0.2 core
- fix(core): update
## 2023-06-13 - 6.0.1 core
- fix(core): update
## 2022-09-27 - 6.0.0 core
- fix(core): update
## 2022-09-27 - 5.0.10 core
- BREAKING CHANGE(core): switch to esm
## 2022-09-27 - 5.0.9 core
- fix(core): update
## 2021-01-22 - 5.0.8 core
- fix(core): update
## 2021-01-22 - 5.0.7 core
- fix(core): update
## 2021-01-22 - 5.0.6 core
- fix(core): update
## 2020-06-10 - 5.0.5 core
- fix(core): update
## 2020-06-10 - 5.0.4 core
- fix(core): update
## 2020-02-28 - 5.0.3 core
- fix(core): update
## 2020-02-28 - 5.0.2 core
- fix(core): update
## 2020-02-28 - 5.0.1 core
- fix(core): update
## 2020-02-28 - 5.0.0 core
- fix(core): update
## 2020-02-19 - 4.0.5 account
- BREAKING CHANGE(account): authorization now uses the new Account API
## 2020-02-19 - 4.0.4 core
- fix(core): update
## 2020-02-19 - 4.0.3 core
- fix(core): update
## 2020-02-10 - 4.0.2 core
- fix(core): update
## 2020-02-10 - 4.0.1 core
- fix(core): update
## 2020-02-10 - 4.0.0 core
- fix(core): update
## 2020-02-09 - 3.0.7 API
- BREAKING CHANGE(API): move to .convenience property
## 2020-02-09 - 3.0.6 core
- fix(core): update
## 2020-02-09 - 3.0.5 core
- fix(core): update
## 2019-07-19 - 3.0.4 core
- fix(core): update
## 2019-07-18 - 3.0.3 core
- fix(core): update
## 2019-07-18 - 3.0.2 core
- fix(core): update
## 2019-07-18 - 3.0.1 core
- fix(core): update
## 2019-07-18 - 3.0.0 core
- fix(core): update
## 2019-07-18 - 2.0.1 core
- fix(core): update
## 2019-07-18 - 2.0.0 core
- fix(core): update
## 2019-07-18 - 2.0.2 no significant changes
_No significant changes in this release._
## 2018-08-13 - 1.0.5 scope
- BREAKING CHANGE(scope): change scope, tools and package name
## 2017-06-11 - 1.0.4 misc
- now using tsclass
## 2017-06-09 - 1.0.3 misc
- update dependencies
## 2017-06-05 - 1.0.2 misc
- now supports purging of assets
- improve test
## 2017-06-04 - 1.0.1 misc
- add npmextra.json
## 2017-06-04 - 1.0.0 misc
- add type TRecord, update ci
## 2017-06-04 - 0.0.20 no significant changes
_No significant changes in this release._
## 2017-06-04 - 0.0.19 misc
- go async/await
- update brand link
## 2017-02-12 - 0.0.18 misc
- update README
## 2017-01-29 - 0.0.17 misc
- update README
## 2017-01-29 - 0.0.16 misc
- fix tests to run in parallel
## 2017-01-29 - 0.0.15 misc
- fixed bad request retry
## 2017-01-29 - 0.0.14 misc
- fix testing timeouts
## 2017-01-29 - 0.0.13 misc
- added random retry times
## 2017-01-29 - 0.0.12 misc
- update to new ci
## 2017-01-29 - 0.0.11 misc
- now using smartrequest
## 2017-01-22 - 0.0.10 misc
- now reacting to rate limiting
## 2016-07-31 - 0.0.9 misc
- update dependencies
## 2016-06-22 - 0.0.8 to 0.0.7 no significant changes
_No significant changes in these releases._
## 2016-06-22 - 0.0.6 misc
- updated dependencies
## 2016-06-21 - 0.0.5 misc
- fix stages
## 2016-06-21 - 0.0.4 misc
- fix stages
## 2016-06-21 - 0.0.3 misc
Multiple improvements:
- now works for most things
- update to latest dependencies
- update .gitlab.yml
- update
- add .gitlab-ci.yml
## 2016-05-25 - 0.0.2 misc
Several changes:
- improve domain string handling
- update .getRecord
- improve .createRecord
- implemented .createRecord
- compile
- add functionality
- start with tests
- improved request method of cflare class
## 2016-04-27 - 0.0.1 misc
- now returning promises
- add lossless badge
## 2016-04-27 - 0.0.0 misc
- added travis and improved README
## 2016-04-10 - 0.0.0 misc
- add package.json and README
## 2016-04-10 - unknown misc
- Initial commit
---
_Note: Versions that only contained version bump commits or minor housekeeping (6.0.5; 2.0.2; 0.0.20; 0.0.8 to 0.0.7) have been omitted from detailed entries and are summarized above._

View File

@ -1,3 +0,0 @@
"use strict";
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsImZpbGUiOiJjZmxhcmUuY2xhc3Nlcy5oZWxwZXJzLmpzIiwic291cmNlc0NvbnRlbnQiOltdLCJzb3VyY2VSb290IjoiL3NvdXJjZS8ifQ==

View File

@ -1,10 +0,0 @@
"use strict";
var cflare = (function () {
function cflare() {
}
;
return cflare;
}());
;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImNmbGFyZS5jbGFzc2VzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFJQTtJQUdJO0lBRUEsQ0FBQzs7SUFFTCxhQUFDO0FBQUQsQ0FQQSxBQU9DLElBQUE7QUFBQSxDQUFDIiwiZmlsZSI6ImNmbGFyZS5jbGFzc2VzLmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4vdHlwaW5ncy9tYWluLmQudHNcIiAvPlxuaW1wb3J0IHBsdWdpbnMgPSByZXF1aXJlKFwiLi9jZmxhcmUucGx1Z2luc1wiKTtcbmltcG9ydCBoZWxwZXJzID0gcmVxdWlyZShcIi4vY2ZsYXJlLmNsYXNzZXMuaGVscGVyc1wiKTtcblxuY2xhc3MgY2ZsYXJlIHtcbiAgICBwcml2YXRlIGF1dGhFbWFpbDpzdHJpbmc7XG4gICAgcHJpdmF0ZSBhdXRoS2V5OnN0cmluZztcbiAgICBjb25zdHJ1Y3Rvcigpe1xuICAgICAgICBcbiAgICB9O1xuICAgIFxufTsiXSwic291cmNlUm9vdCI6Ii9zb3VyY2UvIn0=

View File

@ -1,6 +0,0 @@
"use strict";
/// <reference path="./typings/main.d.ts" />
exports.beautylog = require("beautylog");
exports.request = require("request");
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImNmbGFyZS5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSw0Q0FBNEM7QUFDakMsaUJBQVMsR0FBRyxPQUFPLENBQUMsV0FBVyxDQUFDLENBQUM7QUFDakMsZUFBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQyIsImZpbGUiOiJjZmxhcmUucGx1Z2lucy5qcyIsInNvdXJjZXNDb250ZW50IjpbIi8vLyA8cmVmZXJlbmNlIHBhdGg9XCIuL3R5cGluZ3MvbWFpbi5kLnRzXCIgLz5cbmV4cG9ydCBsZXQgYmVhdXR5bG9nID0gcmVxdWlyZShcImJlYXV0eWxvZ1wiKTtcbmV4cG9ydCBsZXQgcmVxdWVzdCA9IHJlcXVpcmUoXCJyZXF1ZXN0XCIpOyJdLCJzb3VyY2VSb290IjoiL3NvdXJjZS8ifQ==

3
dist/index.js vendored
View File

@ -1,3 +0,0 @@
"use strict";
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsImZpbGUiOiJpbmRleC5qcyIsInNvdXJjZXNDb250ZW50IjpbXSwic291cmNlUm9vdCI6Ii9zb3VyY2UvIn0=

View File

@ -1,6 +1,4 @@
The MIT License (MIT)
Copyright (c) 2016 Lossless GmbH
Copyright (c) 2014 Task Venture Capital GmbH (hello@task.vc)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@ -18,4 +16,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.

29
npmextra.json Normal file
View File

@ -0,0 +1,29 @@
{
"npmci": {
"npmGlobalTools": [],
"npmAccessLevel": "public"
},
"gitzone": {
"projectType": "npm",
"module": {
"githost": "gitlab.com",
"gitscope": "mojoio",
"gitrepo": "cloudflare",
"description": "A TypeScript client for managing Cloudflare accounts, zones, DNS records, and workers with ease.",
"npmPackagename": "@apiclient.xyz/cloudflare",
"license": "MIT",
"keywords": [
"Cloudflare",
"DNS management",
"zone management",
"worker management",
"TypeScript",
"API client",
"cloud infrastructure",
"automated DNS",
"CDN management",
"open source"
]
}
}
}

View File

@ -1,31 +1,70 @@
{
"name": "cflare",
"version": "0.0.2",
"description": "cloudflare management for CoreOS",
"main": "dist/index.js",
"name": "@apiclient.xyz/cloudflare",
"version": "6.0.6",
"private": false,
"description": "A TypeScript client for managing Cloudflare accounts, zones, DNS records, and workers with ease.",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module",
"scripts": {
"test": "(npmts)"
"test": "(tstest test/)",
"build": "(tsbuild --web --allowimplicitany)",
"buildDocs": "tsdoc",
"updateOpenapi": "openapi-typescript https://raw.githubusercontent.com/cloudflare/api-schemas/main/openapi.yaml --output ts/openapi.spec.ts"
},
"repository": {
"type": "git",
"url": "git+https://github.com/pushrocks/cflare.git"
"url": "git+https://gitlab.com/pushrocks/cflare.git"
},
"keywords": [
"CoreOS",
"cloudflare"
"Cloudflare",
"DNS management",
"zone management",
"worker management",
"TypeScript",
"API client",
"cloud infrastructure",
"automated DNS",
"CDN management",
"open source"
],
"author": "Lossless GmbH",
"license": "MIT",
"bugs": {
"url": "https://github.com/pushrocks/cflare/issues"
"url": "https://gitlab.com/pushrocks/cflare/issues"
},
"homepage": "https://github.com/pushrocks/cflare#readme",
"homepage": "https://gitlab.com/pushrocks/cflare#readme",
"dependencies": {
"beautylog": "^4.1.2",
"q": "^1.4.1",
"request": "^2.72.0"
"@push.rocks/smartdelay": "^3.0.1",
"@push.rocks/smartlog": "^3.0.2",
"@push.rocks/smartpromise": "^4.0.2",
"@push.rocks/smartrequest": "^2.0.15",
"@push.rocks/smartstring": "^4.0.5",
"@tsclass/tsclass": "^4.0.58",
"cloudflare": "^3.2.0"
},
"devDependencies": {
"npmts": "^5.0.4"
}
"@git.zone/tsbuild": "^2.1.66",
"@git.zone/tsrun": "^1.2.42",
"@git.zone/tstest": "^1.0.74",
"@push.rocks/qenv": "^6.0.5",
"@push.rocks/tapbundle": "^5.0.4",
"@types/node": "^20.3.1",
"openapi-typescript": "^6.7.6"
},
"files": [
"ts/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
"readme.md"
],
"browserslist": [
"last 1 chrome versions"
]
}

6877
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

2
qenv.yml Normal file
View File

@ -0,0 +1,2 @@
required:
- CF_KEY

1
readme.hints.md Normal file
View File

@ -0,0 +1 @@
- unofficial TypeScript cloudflare api client coming with a lot of convenience.

250
readme.md Normal file
View File

@ -0,0 +1,250 @@
# @apiclient.xyz/cloudflare
easy cloudflare management
## Install
To install the `@apiclient.xyz/cloudflare` package, you can use npm. Simply run the following command:
```bash
npm install @apiclient.xyz/cloudflare
```
Make sure to include it in your `dependencies` in `package.json`.
## Usage
### Initial Setup
First, let's start by importing the required modules and setting up an instance of `CloudflareAccount` with your API token. This instance will be used to interact with the Cloudflare API.
```typescript
import * as cflare from '@apiclient.xyz/cloudflare';
// Initialize Cloudflare Account
const myCflareAccount = new cflare.CloudflareAccount('mySuperAwesomeAccountToken');
```
### Managing Zones
#### List All Zones
To list all zones in your Cloudflare account, you can use the `listZones` method:
```typescript
const listAllZones = async () => {
const myZones = await myCflareAccount.convenience.listZones();
console.log(myZones);
};
```
#### Get Zone ID
To get the ID of a specific zone (domain), use the `getZoneId` method:
```typescript
const getZoneId = async (domainName: string) => {
try {
const zoneId = await myCflareAccount.convenience.getZoneId(domainName);
console.log(`Zone ID for ${domainName}:`, zoneId);
} catch (error) {
console.error('Error getting zone ID:', error);
}
};
```
#### Purge Cache for a Zone
To purge all cache for a specific zone:
```typescript
const purgeZoneCache = async (domainName: string) => {
await myCflareAccount.convenience.purgeZone(domainName);
console.log(`Purged cache for ${domainName}`);
};
```
### Managing DNS Records
#### List DNS Records
To list all DNS records for a specific zone:
```typescript
const listDnsRecords = async (domainName: string) => {
try {
const records = await myCflareAccount.convenience.listRecords(domainName);
console.log(`DNS Records for ${domainName}:`, records);
} catch (error) {
console.error('Error listing DNS records:', error);
}
};
```
#### Get a Specific Record
To get a specific DNS record by type (e.g., A, AAAA, CNAME, etc.):
```typescript
const getDnsRecord = async (domainName: string, recordType: string) => {
try {
const record = await myCflareAccount.convenience.getRecord(domainName, recordType);
console.log(`DNS Record (${recordType}) for ${domainName}:`, record);
} catch (error) {
console.error('Error getting DNS record:', error);
}
};
```
#### Create a DNS Record
To create a new DNS record:
```typescript
const createDnsRecord = async (domainName: string, recordType: string, content: string) => {
try {
const response = await myCflareAccount.convenience.createRecord(domainName, recordType, content, 120);
console.log(`Created DNS record (${recordType}) for ${domainName}:`, response);
} catch (error) {
console.error('Error creating DNS record:', error);
}
};
```
#### Remove a DNS Record
To remove a DNS record:
```typescript
const removeDnsRecord = async (domainName: string, recordType: string) => {
try {
await myCflareAccount.convenience.removeRecord(domainName, recordType);
console.log(`Removed DNS record (${recordType}) for ${domainName}`);
} catch (error) {
console.error('Error removing DNS record:', error);
}
};
```
#### Clean a DNS Record
To clean (remove) all records of a specific type for a domain:
```typescript
const cleanDnsRecord = async (domainName: string, recordType: string) => {
try {
await myCflareAccount.convenience.cleanRecord(domainName, recordType);
console.log(`Cleaned DNS records (${recordType}) for ${domainName}`);
} catch (error) {
console.error('Error cleaning DNS record:', error);
}
};
```
### Managing Workers
#### Create a Worker
To create a new Cloudflare Worker:
```typescript
const createWorker = async (workerName: string, workerScript: string) => {
try {
const worker = await myCflareAccount.workerManager.createWorker(workerName, workerScript);
console.log(`Created Worker (${workerName}):`, worker);
} catch (error) {
console.error('Error creating Worker:', error);
}
};
```
#### List Workers
To list all workers in your Cloudflare account:
```typescript
const listWorkers = async () => {
try {
const workers = await myCflareAccount.workerManager.listWorkers();
console.log('Workers:', workers);
} catch (error) {
console.error('Error listing workers:', error);
}
};
```
#### Set Worker Routes
To set routes for a Cloudflare Worker:
```typescript
import { CloudflareWorker } from '@apiclient.xyz/cloudflare';
const setWorkerRoutes = async (worker: CloudflareWorker, routes: Array<{ zoneName: string, pattern: string }>) => {
try {
await worker.setRoutes(routes);
console.log('Routes set successfully for Worker:', worker.id);
} catch (error) {
console.error('Error setting routes for Worker:', error);
}
};
```
#### Sample Complete Workflow
Below is a sample workflow that includes all the above features:
```typescript
import * as cflare from '@apiclient.xyz/cloudflare';
const myCflareAccount = new cflare.CloudflareAccount('mySuperAwesomeAccountToken');
const manageCloudflare = async () => {
try {
// List all zones
const myZones = await myCflareAccount.convenience.listZones();
console.log('Zones:', myZones);
// Get Zone ID for a specific domain
const myZoneId = await myCflareAccount.convenience.getZoneId('example.com');
console.log('Zone ID:', myZoneId);
// Purge cache for a zone
await myCflareAccount.convenience.purgeZone('example.com');
console.log('Cache purged for example.com');
// List DNS records for a domain
const myRecords = await myCflareAccount.convenience.listRecords('example.com');
console.log('DNS Records:', myRecords);
// Get a specific DNS record
const myRecord = await myCflareAccount.convenience.getRecord('sub.example.com', 'A');
console.log('Specific DNS Record:', myRecord);
// Create a DNS record
const createResponse = await myCflareAccount.convenience.createRecord('sub.example.com', 'A', '127.0.0.1');
console.log('Created DNS Record:', createResponse);
// Clean DNS records
await myCflareAccount.convenience.cleanRecord('sub.example.com', 'A');
console.log('Cleaned DNS Records for sub.example.com');
// Create a Cloudflare Worker
const myWorker = await myCflareAccount.workerManager.createWorker('myWorker', `addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })`);
console.log('Created Worker:', myWorker);
// Set routes for the Worker
await myWorker.setRoutes([{ zoneName: 'example.com', pattern: 'https://*example.com/*' }]);
console.log('Routes set for Worker');
// List all Workers
const workers = await myCflareAccount.workerManager.listWorkers();
console.log('Workers:', workers);
} catch (error) {
console.error('Error managing Cloudflare:', error);
}
};
manageCloudflare();
```
This complete guide covers initialization, managing Cloudflare zones, DNS records, and Cloudflare Workers comprehensively using TypeScript for enhanced type safety and intellisense. Always ensure to keep your API keys secure and avoid hardcoding them directly in your scripts.
undefined

104
test/test.ts Normal file
View File

@ -0,0 +1,104 @@
// tslint:disable-next-line: no-implicit-dependencies
import { expect, tap } from '@push.rocks/tapbundle';
// tslint:disable-next-line: no-implicit-dependencies
import { Qenv } from '@push.rocks/qenv';
import * as cloudflare from '../ts/index.js';
const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit');
const randomPrefix = Math.floor(Math.random() * 2000);
let testCloudflareAccount: cloudflare.CloudflareAccount;
tap.test('should create a valid instance of CloudflareAccount', async () => {
testCloudflareAccount = new cloudflare.CloudflareAccount(await testQenv.getEnvVarOnDemand('CF_KEY'));
});
tap.test('should preselect an account', async () => {
await testCloudflareAccount.preselectAccountByName('Sandbox Account');
})
tap.test('.listZones() -> should display an entire account', async (tools) => {
tools.timeout(600000);
const result = await testCloudflareAccount.convenience.listZones();
console.log(result);
// await tools.delayFor(10000);
});
tap.test(
'.getZoneId(domainName) -> should get an Cloudflare Id for a domain string',
async (tools) => {
tools.timeout(600000);
const id = await testCloudflareAccount.convenience.getZoneId('bleu.de');
console.log(`The account id for bleu.de is: ${id}`);
}
);
tap.test(
'.listRecords(domainName) -> should list all records for a specific Domain Name',
async (tools) => {
tools.timeout(600000);
await testCloudflareAccount.convenience.listRecords('bleu.de').then(async (responseArg) => {
console.log(responseArg);
});
}
);
tap.test('should create a valid record for a subdomain', async (tools) => {
tools.timeout(600000);
await testCloudflareAccount.convenience.createRecord(
`${randomPrefix}subdomain.bleu.de`,
'A',
'127.0.0.1',
120
);
});
tap.test('should get a record from Cloudflare', async (tools) => {
tools.timeout(600000);
await testCloudflareAccount.convenience
.getRecord(`${randomPrefix}subdomain.bleu.de`, 'A')
.then((responseArg) => {
console.log(responseArg);
});
});
tap.test('should remove a subdomain record from Cloudflare', async (tools) => {
tools.timeout(600000);
await testCloudflareAccount.convenience
.removeRecord(`${randomPrefix}subdomain.bleu.de`, 'A')
.then(async (responseArg) => {
console.log(responseArg);
});
});
tap.test('.purge(some.domain) -> should purge everything', async () => {
await testCloudflareAccount.convenience.purgeZone('bleu.de');
});
tap.test('should list workers', async () => {
const workerArray = await testCloudflareAccount.workerManager.listWorkerScripts();
console.log(workerArray);
});
// 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 again', async () => {
const workerArray = await testCloudflareAccount.workerManager.listWorkerScripts();
console.log(workerArray);
});
tap.start();

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @push.rocks/commitinfo
*/
export const commitinfo = {
name: '@apiclient.xyz/cloudflare',
version: '6.0.6',
description: 'A TypeScript client for managing Cloudflare accounts, zones, DNS records, and workers with ease.'
}

View File

@ -1,2 +0,0 @@
/// <reference path="./typings/main.d.ts" />
import plugins = require("./cflare.plugins");

View File

@ -1,38 +0,0 @@
/// <reference path="./typings/main.d.ts" />
import plugins = require("./cflare.plugins");
import helpers = require("./cflare.classes.helpers");
class cflare {
private authEmail:string;
private authKey:string;
private authCheck(){
return (this.authEmail && this.authKey); //check if auth is available
}
constructor(){
};
auth(optionsArg:{email:string,key:string}){
this.authEmail = optionsArg.email;
this.authKey = optionsArg.key;
}
createRecord(){
let done = plugins.q.defer();
return done.promise;
};
removeRecord(){
let done = plugins.q.defer();
return done.promise;
};
listRecords(){
let done = plugins.q.defer();
return done.promise;
}
listDomains(){
let done = plugins.q.defer();
return done.promise;
};
request(){
let done = plugins.q.defer();
return done.promise;
}
};

View File

@ -1,4 +0,0 @@
/// <reference path="./typings/main.d.ts" />
export let beautylog = require("beautylog");
export let q = require("q");
export let request = require("request");

View File

@ -0,0 +1,267 @@
import * as plugins from './cloudflare.plugins.js';
import { logger } from './cloudflare.logger.js';
import * as interfaces from './interfaces/index.js';
// interfaces
import { WorkerManager } from './cloudflare.classes.workermanager.js';
import { ZoneManager } from './cloudflare.classes.zonemanager.js';
export class CloudflareAccount {
private authToken: string;
public preselectedAccountId: string;
public workerManager = new WorkerManager(this);
public zoneManager = new ZoneManager(this);
public apiAccount: plugins.cloudflare.Cloudflare;
/**
* constructor sets auth information on the CloudflareAccountInstance
* @param optionsArg
*/
constructor(authTokenArg: string) {
this.authToken = authTokenArg;
this.apiAccount = new plugins.cloudflare.Cloudflare({
apiToken: this.authToken,
});
}
/**
* Make a request to the Cloudflare API
* @param method HTTP method (GET, POST, PUT, DELETE)
* @param endpoint API endpoint path
* @param data Optional request body data
* @returns API response
*/
public async request<T = any>(
method: 'GET' | 'POST' | 'PUT' | 'DELETE',
endpoint: string,
data?: any
): Promise<T> {
try {
const options: plugins.smartrequest.ISmartRequestOptions = {
method,
url: `https://api.cloudflare.com/client/v4${endpoint}`,
headers: {
'Authorization': `Bearer ${this.authToken}`,
'Content-Type': 'application/json',
},
};
if (data) {
options.json = data;
}
const response = await plugins.smartrequest.request(options);
return JSON.parse(response.body);
} catch (error) {
logger.log('error', `Cloudflare API request failed: ${error.message}`);
throw error;
}
}
public async preselectAccountByName(nameArg: string) {
const accounts = await this.convenience.listAccounts();
const account = accounts.find((accountArg) => {
return accountArg.name === nameArg;
});
if (account) {
this.preselectedAccountId = account.id;
} else {
throw new Error(`account with name ${nameArg} not found`);
}
}
public convenience = {
/**
* listAccounts
*/
listAccounts: async () => {
const accounts: plugins.ICloudflareTypes['Account'][] = [];
for await (const account of this.apiAccount.accounts.list()) {
accounts.push(account as interfaces.ICloudflareApiAccountObject);
}
return accounts;
},
/**
* gets a zone id of a domain from cloudflare
* @param domainName
*/
getZoneId: async (domainName: string) => {
const domain = new plugins.smartstring.Domain(domainName);
const zoneArray = await this.convenience.listZones(domain.zoneName);
const filteredResponse = zoneArray.filter((zoneArg) => {
return zoneArg.name === domainName;
});
if (filteredResponse.length >= 1) {
return filteredResponse[0].id;
} else {
logger.log('error', `the domain ${domainName} does not appear to be in this account!`);
throw new Error(`the domain ${domainName} does not appear to be in this account!`);
}
},
/**
* gets a record
* @param domainNameArg
* @param typeArg
*/
getRecord: async (
domainNameArg: string,
typeArg: plugins.tsclass.network.TDnsRecordType
): Promise<plugins.ICloudflareTypes['Record']> => {
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 zoneId = await this.convenience.getZoneId(domain.zoneName);
const response = await this.apiAccount.dns.records.create({
zone_id: zoneId,
type: typeArg as any,
name: domain.fullName,
content: contentArg,
ttl: ttlArg,
})
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 zoneId = await this.convenience.getZoneId(domain.zoneName);
const records = await this.convenience.listRecords(domain.zoneName);
const recordToDelete = records.find((recordArg) => {
return recordArg.name === domainNameArg && recordArg.type === typeArg;
});
if (recordToDelete) {
await this.apiAccount.dns.records.delete(recordToDelete.id, {
zone_id: zoneId,
});
} else {
logger.log('warn', `record ${domainNameArg} of type ${typeArg} not found`);
}
},
/**
* cleanrecord allows the cleaning of any previous records to avoid unwanted sideeffects
*/
cleanRecord: async (domainNameArg: string, typeArg: plugins.tsclass.network.TDnsRecordType) => {
logger.log('info', `Cleaning ${typeArg} records for ${domainNameArg}`);
const records = await this.convenience.listRecords(domainNameArg);
const recordsToDelete = records.filter((recordArg) => {
return recordArg.type === typeArg;
});
for (const recordToDelete of recordsToDelete) {
await this.apiAccount.dns.records.delete(recordToDelete.id, {
zone_id: recordToDelete.zone_id,
});
}
},
/**
* updates a record
* @param domainNameArg Domain name for the record
* @param typeArg Type of DNS record
* @param contentArg New content for the record
* @param ttlArg Time to live in seconds (optional)
* @returns Updated record
*/
updateRecord: async (
domainNameArg: string,
typeArg: plugins.tsclass.network.TDnsRecordType,
contentArg: string,
ttlArg: number = 1
): Promise<plugins.ICloudflareTypes['Record']> => {
const domain = new plugins.smartstring.Domain(domainNameArg);
const zoneId = await this.convenience.getZoneId(domain.zoneName);
// Find existing record
const record = await this.convenience.getRecord(domainNameArg, typeArg);
if (!record) {
logger.log('warn', `Record ${domainNameArg} of type ${typeArg} not found for update, creating instead`);
return this.convenience.createRecord(domainNameArg, typeArg, contentArg, ttlArg);
}
// Update the record
const updatedRecord = await this.apiAccount.dns.records.edit(record.id, {
zone_id: zoneId,
type: typeArg as any,
name: domain.fullName,
content: contentArg,
ttl: ttlArg
});
return updatedRecord;
},
/**
* 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) => {
const domain = new plugins.smartstring.Domain(domainNameArg);
const zoneId = await this.convenience.getZoneId(domain.zoneName);
const records: plugins.ICloudflareTypes['Record'][] = [];
for await (const record of this.apiAccount.dns.records.list({
zone_id: zoneId,
})) {
records.push(record);
}
return records;
},
/**
* list all zones in the associated authenticated account
* @param domainName
*/
listZones: async (domainName?: string) => {
const zones: plugins.ICloudflareTypes['Zone'][] = [];
for await (const zone of this.apiAccount.zones.list()) {
zones.push(zone);
}
return zones;
},
/**
* purges a zone
*/
purgeZone: async (domainName: string): Promise<void> => {
const domain = new plugins.smartstring.Domain(domainName);
const zoneId = await this.convenience.getZoneId(domain.zoneName);
await this.apiAccount.cache.purge({
zone_id: zoneId,
purge_everything: true,
});
},
// acme convenience functions
acmeSetDnsChallenge: async (dnsChallenge: plugins.tsclass.network.IDnsChallenge) => {
await this.convenience.cleanRecord(dnsChallenge.hostName, 'TXT');
await this.convenience.createRecord(
dnsChallenge.hostName,
'TXT',
dnsChallenge.challenge,
120
);
},
acmeRemoveDnsChallenge: async (dnsChallenge: plugins.tsclass.network.IDnsChallenge) => {
await this.convenience.removeRecord(dnsChallenge.hostName, 'TXT');
},
};
}

View File

@ -0,0 +1,96 @@
import * as plugins from './cloudflare.plugins.js';
import { logger } from './cloudflare.logger.js';
export interface ICloudflareRecordInfo {
id: string;
type: plugins.tsclass.network.TDnsRecordType;
name: string;
content: string;
proxiable: boolean;
proxied: boolean;
ttl: number;
locked: boolean;
zone_id: string;
zone_name: string;
created_on: string;
modified_on: string;
}
export class CloudflareRecord {
/**
* Create a CloudflareRecord instance from an API object
* @param apiObject Cloudflare DNS record API object
* @returns CloudflareRecord instance
*/
public static createFromApiObject(apiObject: plugins.ICloudflareTypes['Record']): CloudflareRecord {
const record = new CloudflareRecord();
Object.assign(record, apiObject);
return record;
}
// Record properties
public id: string;
public type: plugins.tsclass.network.TDnsRecordType;
public name: string;
public content: string;
public proxiable: boolean;
public proxied: boolean;
public ttl: number;
public locked: boolean;
public zone_id: string;
public zone_name: string;
public created_on: string;
public modified_on: string;
/**
* Update the record content
* @param cloudflareAccount The Cloudflare account to use
* @param newContent New content for the record
* @param ttl Optional TTL value in seconds
* @returns Updated record
*/
public async update(
cloudflareAccount: any,
newContent: string,
ttl?: number
): Promise<CloudflareRecord> {
logger.log('info', `Updating record ${this.name} (${this.type}) with new content`);
const updatedRecord = await cloudflareAccount.apiAccount.dns.records.edit(this.id, {
zone_id: this.zone_id,
type: this.type as any,
name: this.name,
content: newContent,
ttl: ttl || this.ttl,
proxied: this.proxied
});
// Update this instance
this.content = newContent;
if (ttl) {
this.ttl = ttl;
}
return this;
}
/**
* Delete this record
* @param cloudflareAccount The Cloudflare account to use
* @returns Boolean indicating success
*/
public async delete(cloudflareAccount: any): Promise<boolean> {
try {
logger.log('info', `Deleting record ${this.name} (${this.type})`);
await cloudflareAccount.apiAccount.dns.records.delete(this.id, {
zone_id: this.zone_id
});
return true;
} catch (error) {
logger.log('error', `Failed to delete record: ${error.message}`);
return false;
}
}
}

View File

@ -0,0 +1,101 @@
import * as plugins from './cloudflare.plugins.js';
import * as interfaces from './interfaces/index.js';
import { WorkerManager } from './cloudflare.classes.workermanager.js';
import { logger } from './cloudflare.logger.js';
export interface IWorkerRoute extends interfaces.ICflareWorkerRoute {
zoneName: string;
}
export interface IWorkerRouteDefinition {
zoneName: string;
pattern: 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) {
logger.log('debug', `Processing route: ${route.pattern}`);
logger.log('debug', `Comparing script: ${route.script} with worker ID: ${this.id}`);
if (route.script === this.id) {
this.routes.push({ ...route, zoneName: zone.name });
}
}
}
}
/**
* Sets routes for this worker
* @param routeArray Array of route definitions
*/
public async setRoutes(routeArray: IWorkerRouteDefinition[]) {
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';
logger.log('info', `route already exists, no update needed`);
}
}
}
// lets care about actually setting routes
if (routeStatus === 'new') {
const zoneId = await this.workerManager.cfAccount.convenience.getZoneId(newRoute.zoneName);
const requestRoute = `/zones/${zoneId}/workers/routes`;
await this.workerManager.cfAccount.request('POST', requestRoute, {
pattern: newRoute.pattern,
script: this.id,
});
} else if (routeStatus === 'needsUpdate') {
const zoneId = await this.workerManager.cfAccount.convenience.getZoneId(newRoute.zoneName);
const requestRoute = `/zones/${zoneId}/workers/routes/${routeIdForUpdate}`;
await this.workerManager.cfAccount.request('PUT', requestRoute, {
pattern: newRoute.pattern,
script: this.id,
});
}
}
}
}

View File

@ -0,0 +1,90 @@
import * as plugins from './cloudflare.plugins.js';
import { CloudflareAccount } from './cloudflare.classes.account.js';
import { CloudflareWorker } from './cloudflare.classes.worker.js';
import { logger } from './cloudflare.logger.js';
export class WorkerManager {
public cfAccount: CloudflareAccount;
constructor(cfAccountArg: CloudflareAccount) {
this.cfAccount = cfAccountArg;
}
/**
* Creates a new worker or updates an existing one
* @param workerName Name of the worker
* @param workerScript JavaScript content of the worker
* @returns The created or updated worker
*/
public async createWorker(workerName: string, workerScript: string): Promise<plugins.ICloudflareTypes['Script']> {
if (!this.cfAccount.preselectedAccountId) {
throw new Error('No account selected. Please select it first on the account.');
}
const worker = await this.cfAccount.apiAccount.workers.scripts.content.update(workerName, {
account_id: this.cfAccount.preselectedAccountId,
"CF-WORKER-BODY-PART": workerScript,
});
return worker;
}
/**
* Get a worker by name
* @param workerName Name of the worker to retrieve
* @returns CloudflareWorker instance or undefined if not found
*/
public async getWorker(workerName: string): Promise<CloudflareWorker | undefined> {
if (!this.cfAccount.preselectedAccountId) {
throw new Error('No account selected. Please select it first on the account.');
}
try {
const script = await this.cfAccount.apiAccount.workers.scripts.get(workerName, {
account_id: this.cfAccount.preselectedAccountId
});
return CloudflareWorker.fromApiObject(this, script);
} catch (error) {
logger.log('warn', `Worker '${workerName}' not found: ${error.message}`);
return undefined;
}
}
/**
* Lists all worker scripts
* @returns Array of worker scripts
*/
public async listWorkerScripts() {
if (!this.cfAccount.preselectedAccountId) {
throw new Error('No account selected. Please select it first on the account.');
}
const workerScripts: plugins.ICloudflareTypes['Script'][] = [];
for await (const scriptArg of this.cfAccount.apiAccount.workers.scripts.list({
account_id: this.cfAccount.preselectedAccountId,
})) {
workerScripts.push(scriptArg);
}
return workerScripts;
}
/**
* Deletes a worker script
* @param workerName Name of the worker to delete
* @returns True if deletion was successful
*/
public async deleteWorker(workerName: string): Promise<boolean> {
if (!this.cfAccount.preselectedAccountId) {
throw new Error('No account selected. Please select it first on the account.');
}
try {
await this.cfAccount.apiAccount.workers.scripts.delete(workerName, {
account_id: this.cfAccount.preselectedAccountId
});
logger.log('info', `Worker '${workerName}' deleted successfully`);
return true;
} catch (error) {
logger.log('error', `Failed to delete worker '${workerName}': ${error.message}`);
return false;
}
}
}

View File

@ -0,0 +1,177 @@
import * as plugins from './cloudflare.plugins.js';
import { logger } from './cloudflare.logger.js';
import * as interfaces from './interfaces/index.js';
export class CloudflareZone {
// Zone properties
public id: string;
public name: string;
public status: interfaces.ICflareZone['status'];
public paused: boolean;
public type: interfaces.ICflareZone['type'];
public development_mode: number;
public name_servers: string[];
public original_name_servers: string[];
public original_registrar: string | null;
public original_dnshost: string | null;
public modified_on: string;
public created_on: string;
public activated_on: string;
public meta: interfaces.ICflareZone['meta'];
public owner: interfaces.ICflareZone['owner'];
public account: interfaces.ICflareZone['account'];
public permissions: string[];
public plan: interfaces.ICflareZone['plan'];
private cfAccount: any; // Will be set when created through a manager
/**
* Create a CloudflareZone instance from an API object
* @param apiObject Cloudflare Zone API object
* @param cfAccount Optional Cloudflare account instance
* @returns CloudflareZone instance
*/
public static createFromApiObject(
apiObject: plugins.ICloudflareTypes['Zone'],
cfAccount?: any
): CloudflareZone {
const cloudflareZone = new CloudflareZone();
Object.assign(cloudflareZone, apiObject);
if (cfAccount) {
cloudflareZone.cfAccount = cfAccount;
}
return cloudflareZone;
}
/**
* Check if development mode is currently active
* @returns True if development mode is active
*/
public isDevelopmentModeActive(): boolean {
return this.development_mode > 0;
}
/**
* Enable development mode for the zone
* @param cfAccount Cloudflare account to use if not already set
* @param duration Duration in seconds (default: 3 hours)
* @returns Updated zone
*/
public async enableDevelopmentMode(
cfAccount?: any,
duration: number = 10800
): Promise<CloudflareZone> {
const account = cfAccount || this.cfAccount;
if (!account) {
throw new Error('CloudflareAccount is required to enable development mode');
}
logger.log('info', `Enabling development mode for zone ${this.name}`);
const response = await account.request('PATCH', `/zones/${this.id}/settings/development_mode`, {
value: 'on',
time: duration
});
this.development_mode = duration;
return this;
}
/**
* Disable development mode for the zone
* @param cfAccount Cloudflare account to use if not already set
* @returns Updated zone
*/
public async disableDevelopmentMode(cfAccount?: any): Promise<CloudflareZone> {
const account = cfAccount || this.cfAccount;
if (!account) {
throw new Error('CloudflareAccount is required to disable development mode');
}
logger.log('info', `Disabling development mode for zone ${this.name}`);
const response = await account.request('PATCH', `/zones/${this.id}/settings/development_mode`, {
value: 'off'
});
this.development_mode = 0;
return this;
}
/**
* Purge all cached content for this zone
* @param cfAccount Cloudflare account to use if not already set
* @returns True if successful
*/
public async purgeCache(cfAccount?: any): Promise<boolean> {
const account = cfAccount || this.cfAccount;
if (!account) {
throw new Error('CloudflareAccount is required to purge cache');
}
logger.log('info', `Purging all cache for zone ${this.name}`);
try {
await account.request('POST', `/zones/${this.id}/purge_cache`, {
purge_everything: true
});
return true;
} catch (error) {
logger.log('error', `Failed to purge cache: ${error.message}`);
return false;
}
}
/**
* Purge specific URLs from the cache
* @param urls Array of URLs to purge
* @param cfAccount Cloudflare account to use if not already set
* @returns True if successful
*/
public async purgeUrls(urls: string[], cfAccount?: any): Promise<boolean> {
const account = cfAccount || this.cfAccount;
if (!account) {
throw new Error('CloudflareAccount is required to purge URLs');
}
if (!urls.length) {
return true;
}
logger.log('info', `Purging ${urls.length} URLs from cache for zone ${this.name}`);
try {
await account.request('POST', `/zones/${this.id}/purge_cache`, {
files: urls
});
return true;
} catch (error) {
logger.log('error', `Failed to purge URLs: ${error.message}`);
return false;
}
}
/**
* Check if the zone is active
* @returns True if the zone is active
*/
public isActive(): boolean {
return this.status === 'active' && !this.paused;
}
/**
* Check if the zone is using Cloudflare nameservers
* @returns True if using Cloudflare nameservers
*/
public isUsingCloudflareNameservers(): boolean {
// Check if original nameservers match current nameservers
if (!this.original_name_servers || !this.name_servers) {
return false;
}
// If they're different, and current nameservers are Cloudflare's
return this.name_servers.some(ns => ns.includes('cloudflare'));
}
}

View File

@ -0,0 +1,153 @@
import * as plugins from './cloudflare.plugins.js';
import * as interfaces from './interfaces/index.js';
import { CloudflareAccount } from './cloudflare.classes.account.js';
import { CloudflareZone } from './cloudflare.classes.zone.js';
import { logger } from './cloudflare.logger.js';
export class ZoneManager {
public cfAccount: CloudflareAccount;
constructor(cfAccountArg: CloudflareAccount) {
this.cfAccount = cfAccountArg;
}
/**
* Get all zones, optionally filtered by name
* @param zoneName Optional zone name to filter by
* @returns Array of CloudflareZone instances
*/
public async getZones(zoneName?: string): Promise<CloudflareZone[]> {
let requestRoute = `/zones?per_page=50`;
// May be optionally filtered by domain name
if (zoneName) {
requestRoute = `${requestRoute}&name=${encodeURIComponent(zoneName)}`;
}
try {
const response: { result: interfaces.ICflareZone[] } = await this.cfAccount.request('GET', requestRoute);
return response.result.map(apiObject =>
CloudflareZone.createFromApiObject(apiObject as any, this.cfAccount)
);
} catch (error) {
logger.log('error', `Failed to fetch zones: ${error.message}`);
return [];
}
}
/**
* Get a single zone by name
* @param zoneName Zone name to find
* @returns CloudflareZone instance or undefined if not found
*/
public async getZoneByName(zoneName: string): Promise<CloudflareZone | undefined> {
const zones = await this.getZones(zoneName);
return zones.find(zone => zone.name === zoneName);
}
/**
* Get a zone by its ID
* @param zoneId Zone ID to find
* @returns CloudflareZone instance or undefined if not found
*/
public async getZoneById(zoneId: string): Promise<CloudflareZone | undefined> {
try {
const response: { result: interfaces.ICflareZone } = await this.cfAccount.request(
'GET',
`/zones/${zoneId}`
);
return CloudflareZone.createFromApiObject(response.result as any, this.cfAccount);
} catch (error) {
logger.log('error', `Failed to fetch zone with ID ${zoneId}: ${error.message}`);
return undefined;
}
}
/**
* Create a new zone
* @param zoneName Name of the zone to create
* @param jumpStart Whether to automatically attempt to fetch existing DNS records
* @param accountId Account ID to use (defaults to preselected account)
* @returns The created zone
*/
public async createZone(
zoneName: string,
jumpStart: boolean = false,
accountId?: string
): Promise<CloudflareZone | undefined> {
const useAccountId = accountId || this.cfAccount.preselectedAccountId;
if (!useAccountId) {
throw new Error('No account selected. Please select it first on the account.');
}
try {
logger.log('info', `Creating zone ${zoneName}`);
const response: { result: interfaces.ICflareZone } = await this.cfAccount.request(
'POST',
'/zones',
{
name: zoneName,
jump_start: jumpStart,
account: { id: useAccountId }
}
);
return CloudflareZone.createFromApiObject(response.result as any, this.cfAccount);
} catch (error) {
logger.log('error', `Failed to create zone ${zoneName}: ${error.message}`);
return undefined;
}
}
/**
* Delete a zone
* @param zoneId ID of the zone to delete
* @returns True if successful
*/
public async deleteZone(zoneId: string): Promise<boolean> {
try {
logger.log('info', `Deleting zone with ID ${zoneId}`);
await this.cfAccount.request('DELETE', `/zones/${zoneId}`);
return true;
} catch (error) {
logger.log('error', `Failed to delete zone with ID ${zoneId}: ${error.message}`);
return false;
}
}
/**
* Check if a zone exists
* @param zoneName Name of the zone to check
* @returns True if the zone exists
*/
public async zoneExists(zoneName: string): Promise<boolean> {
const zones = await this.getZones(zoneName);
return zones.some(zone => zone.name === zoneName);
}
/**
* Activate a zone (if it's in pending status)
* @param zoneId ID of the zone to activate
* @returns Updated zone or undefined if activation failed
*/
public async activateZone(zoneId: string): Promise<CloudflareZone | undefined> {
try {
logger.log('info', `Activating zone with ID ${zoneId}`);
const response: { result: interfaces.ICflareZone } = await this.cfAccount.request(
'PUT',
`/zones/${zoneId}/activation_check`
);
return CloudflareZone.createFromApiObject(response.result as any, this.cfAccount);
} catch (error) {
logger.log('error', `Failed to activate zone with ID ${zoneId}: ${error.message}`);
return undefined;
}
}
}

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();

24
ts/cloudflare.plugins.ts Normal file
View File

@ -0,0 +1,24 @@
import * as smartlog from '@push.rocks/smartlog';
import * as smartpromise from '@push.rocks/smartpromise';
import * as smartdelay from '@push.rocks/smartdelay';
import * as smartrequest from '@push.rocks/smartrequest';
import * as smartstring from '@push.rocks/smartstring';
import * as tsclass from '@tsclass/tsclass';
export { smartlog, smartpromise, smartdelay, smartrequest, smartstring, tsclass };
// third party
import * as cloudflare from 'cloudflare';
import * as interfaces from './interfaces/index.js';
import type { Zone } from 'cloudflare/resources/zones/zones.js';
import type { Record } from 'cloudflare/resources/dns/records.js';
import type { Script } from 'cloudflare/resources/workers/scripts/index.js';
export interface ICloudflareTypes {
Account: interfaces.ICloudflareApiAccountObject;
Record: Record;
Zone: Zone;
Script: Script;
}
export { cloudflare };

130
ts/cloudflare.utils.ts Normal file
View File

@ -0,0 +1,130 @@
import * as plugins from './cloudflare.plugins.js';
import { logger } from './cloudflare.logger.js';
export class CloudflareUtils {
/**
* Validates if a domain name is properly formatted
* @param domainName Domain name to validate
* @returns True if the domain is valid
*/
public static isValidDomain(domainName: string): boolean {
try {
const domain = new plugins.smartstring.Domain(domainName);
return domain.isValid();
} catch (error) {
return false;
}
}
/**
* Extracts the zone name (apex domain) from a full domain
* @param domainName Domain name to process
* @returns Zone name (apex domain)
*/
public static getZoneName(domainName: string): string {
try {
const domain = new plugins.smartstring.Domain(domainName);
return domain.zoneName;
} catch (error) {
logger.log('error', `Invalid domain name: ${domainName}`);
throw new Error(`Invalid domain name: ${domainName}`);
}
}
/**
* Checks if a string is a valid Cloudflare API token
* @param token API token to validate
* @returns True if the token format is valid
*/
public static isValidApiToken(token: string): boolean {
// Cloudflare API tokens are typically 40+ characters long and start with specific patterns
return /^[A-Za-z0-9_-]{40,}$/.test(token);
}
/**
* Validates a DNS record type
* @param type DNS record type to validate
* @returns True if it's a valid DNS record type
*/
public static isValidRecordType(type: string): boolean {
const validTypes: plugins.tsclass.network.TDnsRecordType[] = [
'A', 'AAAA', 'CNAME', 'TXT', 'SRV', 'LOC', 'MX',
'NS', 'SPF', 'CERT', 'DNSKEY', 'DS', 'NAPTR', 'SMIMEA',
'SSHFP', 'TLSA', 'URI'
];
return validTypes.includes(type as any);
}
/**
* Formats a URL for cache purging (ensures it starts with http/https)
* @param url URL to format
* @returns Properly formatted URL
*/
public static formatUrlForPurge(url: string): string {
if (!url.startsWith('http://') && !url.startsWith('https://')) {
return `https://${url}`;
}
return url;
}
/**
* Converts a TTL value in seconds to a human-readable string
* @param ttl TTL in seconds
* @returns Human-readable TTL
*/
public static formatTtl(ttl: number): string {
if (ttl === 1) {
return 'Automatic';
} else if (ttl === 120) {
return '2 minutes';
} else if (ttl === 300) {
return '5 minutes';
} else if (ttl === 600) {
return '10 minutes';
} else if (ttl === 900) {
return '15 minutes';
} else if (ttl === 1800) {
return '30 minutes';
} else if (ttl === 3600) {
return '1 hour';
} else if (ttl === 7200) {
return '2 hours';
} else if (ttl === 18000) {
return '5 hours';
} else if (ttl === 43200) {
return '12 hours';
} else if (ttl === 86400) {
return '1 day';
} else {
return `${ttl} seconds`;
}
}
/**
* Safely handles API pagination for Cloudflare requests
* @param makeRequest Function that makes the API request with page parameters
* @returns Combined results from all pages
*/
public static async paginateResults<T>(
makeRequest: (page: number, perPage: number) => Promise<{ result: T[], result_info: { total_pages: number } }>
): Promise<T[]> {
const perPage = 50; // Cloudflare's maximum
let page = 1;
let totalPages = 1;
const allResults: T[] = [];
do {
try {
const response = await makeRequest(page, perPage);
allResults.push(...response.result);
totalPages = response.result_info.total_pages;
page++;
} catch (error) {
logger.log('error', `Pagination error on page ${page}: ${error.message}`);
break;
}
} while (page <= totalPages);
return allResults;
}
}

View File

@ -1,2 +1,11 @@
/// <reference path="./typings/main.d.ts" />
import plugins = require("./cflare.plugins");
export { CloudflareAccount } from './cloudflare.classes.account.js';
export { CloudflareWorker, type IWorkerRoute, type IWorkerRouteDefinition } from './cloudflare.classes.worker.js';
export { WorkerManager } from './cloudflare.classes.workermanager.js';
export { CloudflareRecord, type ICloudflareRecordInfo } from './cloudflare.classes.record.js';
export { CloudflareZone } from './cloudflare.classes.zone.js';
export { ZoneManager } from './cloudflare.classes.zonemanager.js';
export { CloudflareUtils } from './cloudflare.utils.js';
export { commitinfo } from './00_commitinfo_data.js';
// Re-export interfaces
export * from './interfaces/index.js';

View File

@ -0,0 +1,20 @@
export interface ICloudflareApiAccountObject {
id: string;
name: string;
type: 'standard' | 'enterprise' | 'pro' | 'free'; // Assuming other possible types
settings: {
enforce_twofactor: boolean;
api_access_enabled: boolean | null;
access_approval_expiry: string | null; // Assuming ISO date string or null
use_account_custom_ns_by_default: boolean;
default_nameservers: string;
};
legacy_flags: {
enterprise_zone_quota: {
maximum: number;
current: number;
available: number;
};
};
created_on: string; // Assuming ISO date string
}

View File

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

View File

@ -0,0 +1,45 @@
export interface ICflareZone {
id: string;
name: string;
status: 'active' | 'pending' | 'initializing' | 'moved' | 'deleted' | 'deactivated';
paused: boolean;
type: 'full' | 'partial' | 'secondary';
development_mode: number;
name_servers: string[];
original_name_servers: string[];
original_registrar: string | null;
original_dnshost: string | null;
modified_on: string;
created_on: string;
activated_on: string;
meta: {
step: number;
wildcard_proxiable: boolean;
custom_certificate_quota: number;
page_rule_quota: number;
phishing_detected: boolean;
multiple_railguns_allowed: boolean;
};
owner: {
id: string | null;
type: 'user' | 'organization';
email: string | null;
};
account: {
id: string;
name: string;
};
permissions: string[];
plan: {
id: string;
name: string;
price: number;
currency: string;
frequency: string;
is_subscribed: boolean;
can_subscribe: boolean;
legacy_id: string;
legacy_discount: boolean;
externally_managed: boolean;
};
}

3
ts/interfaces/index.ts Normal file
View File

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

View File

@ -1,8 +0,0 @@
{
"version": false,
"dependencies": {},
"ambientDependencies": {
"colors": "registry:dt/colors#0.6.0-1+20160425153322",
"node": "registry:dt/node#4.0.0+20160423143914"
}
}

14
tsconfig.json Normal file
View File

@ -0,0 +1,14 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
}