YuzuZensai/Cloudflare-DDNS-Updater
1
0
Fork 0
mirror of https://github.com/YuzuZensai/Cloudflare-DDNS-Updater.git synced 2026-07-29 17:00:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

🎨 style: add Prettier formatting

Browse Source
This commit is contained in:
yuzu
2026-07-01 12:36:15 +07:00
parent 3cf1571070
commit eb242ce953
12 changed files with 627 additions and 570 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.prettierignore
+5
View File
@@ -0,0 +1,5 @@
node_modules
dist
configs
coverage
bun.lock
.prettierrc
+5
View File
@@ -0,0 +1,5 @@
{
"printWidth": 100,
"singleQuote": false,
"trailingComma": "all"
}
bun.lock
+10 -7
View File
@@ -5,15 +5,16 @@
"": {
"name": "cloudflare-ddns-updater",
"dependencies": {
"axios": "latest",
"dotenv": "latest",
"validator": "latest",
"winston": "latest",
"axios": "^1.18.1",
"dotenv": "^17.4.2",
"validator": "^13.15.35",
"winston": "3.19.0",
},
"devDependencies": {
"@types/node": "latest",
"@types/validator": "latest",
"typescript": "latest",
"@types/node": "^26.0.1",
"@types/validator": "^13.15.10",
"prettier": "^3.9.4",
"typescript": "^6.0.3",
},
},
},
@@ -110,6 +111,8 @@
"one-time": ["one-time@1.0.0", "", { "dependencies": { "fn.name": "1.x.x" } }, "sha512-5DXOiRKwuSEcQ/l0kGCF6Q3jcADFv5tSmRaJck/OqkVFcOzutB134KRSfF0xDrL39MNnqxbHBbUUcjZIhTgb2g=="],
"prettier": ["prettier@3.9.4", "", { "bin": { "prettier": "bin/prettier.cjs" } }, "sha512-yWG/o/4oJfo036EKAfK6ACAoDOfHeRHx4tuxkfBZiauURiaSmYwlpOr5LQqKtIkRD2z1PLteme2WoxEnj4tHTg=="],
"proxy-from-env": ["proxy-from-env@2.1.0", "", {}, "sha512-cJ+oHTW1VAEa8cJslgmUZrc+sjRKgAKl3Zyse6+PV38hZe/V6Z14TbCuXcan9F9ghlz4QrFr2c92TNF82UkYHA=="],
"readable-stream": ["readable-stream@3.6.0", "", { "dependencies": { "inherits": "^2.0.3", "string_decoder": "^1.1.1", "util-deprecate": "^1.0.1" } }, "sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA=="],
package.json
+3
View File
@@ -15,10 +15,13 @@
"devDependencies": {
"@types/node": "^26.0.1",
"@types/validator": "^13.15.10",
"prettier": "^3.9.4",
"typescript": "^6.0.3"
},
"scripts": {
"typecheck": "tsc --noEmit",
"format": "prettier --write .",
"format:check": "prettier --check .",
"dev": "bun --watch src/index.ts",
"start": "bun src/index.ts",
"build": "bun run typecheck",
src/index.ts
+1 -1
View File
@@ -1,4 +1,4 @@
import App from './providers/App';
import App from "./providers/App";
App.loadConfig();
App.loadENV();
src/libs/Logger.ts
+20 -22
View File
@@ -1,4 +1,4 @@
import winston from 'winston';
import winston from "winston";
const levels = {
critical: 0,
@@ -11,47 +11,45 @@ const levels = {
};
const level = () => {
const env = process.env.NODE_ENV || 'development';
const isDevelopment = env === 'development';
return isDevelopment ? 'debug' : 'info';
const env = process.env.NODE_ENV || "development";
const isDevelopment = env === "development";
return isDevelopment ? "debug" : "info";
};
const colors = {
critical: 'red',
error: 'red',
alert: 'red',
warn: 'yellow',
info: 'green',
http: 'magenta',
debug: 'white',
critical: "red",
error: "red",
alert: "red",
warn: "yellow",
info: "green",
http: "magenta",
debug: "white",
};
winston.addColors(colors);
const consoleFormat = winston.format.combine(
winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss:ms' }),
winston.format.timestamp({ format: "YYYY-MM-DD HH:mm:ss:ms" }),
winston.format.colorize({ all: true }),
winston.format.printf(
(info) => `[${info.timestamp}] [${info.level}] ${info.message}`
)
winston.format.printf((info) => `[${info.timestamp}] [${info.level}] ${info.message}`),
);
const format = winston.format.combine(
winston.format.timestamp({
format: new Date().toISOString()
format: new Date().toISOString(),
}),
winston.format.json()
)
winston.format.json(),
);
const transports = [
new winston.transports.Console({
format: consoleFormat
format: consoleFormat,
}),
new winston.transports.File({
filename: 'logs/error.log',
level: 'error',
filename: "logs/error.log",
level: "error",
}),
new winston.transports.File({ filename: 'logs/all.log' }),
new winston.transports.File({ filename: "logs/all.log" }),
];
const Logger = winston.createLogger({
src/providers/App.ts
+8 -8
View File
@@ -1,23 +1,23 @@
import Logger from '../libs/Logger';
import Logger from "../libs/Logger";
import Environment from './Environment';
import Configuration from './Configuration';
import Daemon from './Daemon';
import Environment from "./Environment";
import Configuration from "./Configuration";
import Daemon from "./Daemon";
class App {
public loadConfig(): void {
Logger.log('info', 'Loading configuration');
Logger.log("info", "Loading configuration");
Configuration.init();
}
public loadENV(): void {
Logger.log('info', 'Loading environment');
Logger.log("info", "Loading environment");
Environment.init();
}
public loadDaemon(): void {
Logger.log('info', 'Loading daemon');
Logger.log("info", "Loading daemon");
Daemon.init();
}
}
export default new App;
export default new App();
src/providers/Configuration.ts
+10 -12
View File
@@ -3,9 +3,8 @@ import path from "path";
const ConfigurationData: any = [];
class Configuration {
public init(): void {
const dir = path.join(process.cwd(), 'configs/');
const dir = path.join(process.cwd(), "configs/");
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir);
}
@@ -15,7 +14,7 @@ class Configuration {
}
public loadConfig(configFileName: string): void {
const dir = path.join(process.cwd(), 'configs/');
const dir = path.join(process.cwd(), "configs/");
if (!fs.existsSync(path.join(dir, configFileName)))
throw new Error(`Config file ${configFileName} does not exist`);
@@ -24,23 +23,22 @@ class Configuration {
}
public getConfig(key?: string) {
if(!key)
return ConfigurationData;
if (!key) return ConfigurationData;
else {
if(ConfigurationData[key])
return ConfigurationData[key];
else
throw new Error(`No configuration found for ${key}`);
if (ConfigurationData[key]) return ConfigurationData[key];
else throw new Error(`No configuration found for ${key}`);
}
}
private copyExampleIfNotExists(file: string): void {
const dir = path.join(process.cwd(), 'configs/');
const dir = path.join(process.cwd(), "configs/");
if (!fs.existsSync(path.join(dir, file))) {
fs.copyFileSync(path.join(process.cwd(), 'configs_example/', `${file.replace('.json', '.example.json')}`), path.join(dir, file));
fs.copyFileSync(
path.join(process.cwd(), "configs_example/", `${file.replace(".json", ".example.json")}`),
path.join(dir, file),
);
}
}
}
export default new Configuration();
src/providers/Daemon.ts
+152 -99
View File
@@ -3,34 +3,32 @@ import Environment from "./Environment";
import Configuration from "./Configuration";
import axios from "axios";
import validator from 'validator';
import validator from "validator";
interface CloudflareConfig {
token: string,
updateInterval: number,
zone: Array<ZoneConfig>
token: string;
updateInterval: number;
zone: Array<ZoneConfig>;
}
interface ZoneConfig {
id: string,
type: string,
name: string,
content: string,
ttl: number,
proxied: boolean
id: string;
type: string;
name: string;
content: string;
ttl: number;
proxied: boolean;
}
class Deamon {
private config: Array<CloudflareConfig> = [];
constructor () {
}
constructor() {}
public init(): void {
const _config = Configuration.getConfig("UpdaterConfig");
if (!_config) {
Logger.error('No configuration found')
Logger.error("No configuration found");
return;
}
@@ -48,7 +46,7 @@ class Deamon {
}
public start(): void {
Logger.info('Starting deamon');
Logger.info("Starting deamon");
for (const cloudflareConfig of this.config) {
this.update(cloudflareConfig);
setInterval(() => this.update(cloudflareConfig), cloudflareConfig.updateInterval * 1000);
@@ -56,7 +54,6 @@ class Deamon {
}
private async update(cloudflareConfig: CloudflareConfig) {
let token = cloudflareConfig.token;
// Replace placeholders env with value
@@ -64,8 +61,7 @@ class Deamon {
const envTokenName = this.parseEnvironmentTokenPlaceholderName(token)!;
if (process.env[envTokenName]) {
token = process.env[envTokenName]!;
}
else {
} else {
Logger.error(`Environment variable ${envTokenName} not found`);
return;
}
@@ -85,10 +81,12 @@ class Deamon {
for (const zone of cloudflareConfig.zone) {
const api = new CloudflareAPI(token, zone.id);
const records = await api.getRecord({
const records = await api
.getRecord({
type: zone.type,
name: zone.name
}).catch(err => {
name: zone.name,
})
.catch((err) => {
Logger.error(`Unable to get records for zone ${zone.id}`);
return err;
});
@@ -99,15 +97,19 @@ class Deamon {
// No records found, create it
if (!records || records.length === 0) {
const newContent = zone.content.replaceAll("{CURRENT_IPv4}", IPv4).replaceAll("{CURRENT_IPv6}", IPv6);
const newContent = zone.content
.replaceAll("{CURRENT_IPv4}", IPv4)
.replaceAll("{CURRENT_IPv6}", IPv6);
const result = await api.createRecord({
const result = await api
.createRecord({
type: zone.type,
name: zone.name,
content: IPv4,
ttl: zone.ttl,
proxied: zone.proxied
}).catch(err => {
proxied: zone.proxied,
})
.catch((err) => {
Logger.error(`Unable to create record: ${err.message}`);
return err;
});
@@ -116,25 +118,28 @@ class Deamon {
continue;
}
if(result)
Logger.info(`Created [${zone.type}] (${zone.name} -> ${newContent})`);
if (result) Logger.info(`Created [${zone.type}] (${zone.name} -> ${newContent})`);
}
// Only 1 matching records found
else if (records.length === 1) {
const record = records[0];
const newContent = zone.content.replaceAll("{CURRENT_IPv4}", IPv4).replaceAll("{CURRENT_IPv6}", IPv6);
const newContent = zone.content
.replaceAll("{CURRENT_IPv4}", IPv4)
.replaceAll("{CURRENT_IPv6}", IPv6);
// Check if the ip is the same
if (record.content !== IPv4 && record.content !== IPv6) {
const updateResult = await api.updateRecord({
const updateResult = await api
.updateRecord({
record_id: record.id,
type: zone.type,
name: zone.name,
ttl: zone.ttl,
content: newContent,
proxied: zone.proxied
}).catch(err => {
proxied: zone.proxied,
})
.catch((err) => {
Logger.error(`Unable to update record: ${err.message}`);
return err;
});
@@ -144,57 +149,57 @@ class Deamon {
}
if (updateResult)
Logger.info(`[${zone.type}] (${zone.name} -> ${record.content}) updated to (${zone.name} -> ${newContent})`);
}
else if(
record.ttl !== zone.ttl ||
record.proxied !== zone.proxied
) {
const updateResult = await api.updateRecord({
Logger.info(
`[${zone.type}] (${zone.name} -> ${record.content}) updated to (${zone.name} -> ${newContent})`,
);
} else if (record.ttl !== zone.ttl || record.proxied !== zone.proxied) {
const updateResult = await api
.updateRecord({
record_id: record.id,
type: zone.type,
name: zone.name,
ttl: zone.ttl,
content: newContent,
proxied: zone.proxied
}).catch(err => {
proxied: zone.proxied,
})
.catch((err) => {
Logger.error(`Unable to update record: ${err.message}`);
console.log(err);
return;
});
if (updateResult)
Logger.info(`[${zone.type}] (${zone.name} -> ${record.content}) updated proxy status/ttl (TTL: ${record.ttl} -> ${zone.ttl}) (Proxy status: ${record.proxied} -> ${zone.proxied})`);
}
else {
Logger.info(
`[${zone.type}] (${zone.name} -> ${record.content}) updated proxy status/ttl (TTL: ${record.ttl} -> ${zone.ttl}) (Proxy status: ${record.proxied} -> ${zone.proxied})`,
);
} else {
Logger.info(`[${zone.type}] (${zone.name} -> ${record.content}) already up to date`);
continue;
}
}
// Many records found
else if (records.length > 1) {
Logger.error(`Multiple records found for ${zone.type} (${zone.name}) (Multiple records are not supported right now)`);
Logger.error(
`Multiple records found for ${zone.type} (${zone.name}) (Multiple records are not supported right now)`,
);
continue;
}
}
}
private isCloudflareConfig(object: any): object is CloudflareConfig {
if (!this.arraysEqual(Object.keys(object), ["token", "updateInterval", "zone"])) return false;
if(!this.arraysEqual(Object.keys(object), ['token', 'updateInterval', 'zone']))
return false;
const res = object &&
object.token && typeof(object.token) == 'string' &&
object.updateInterval && typeof(object.updateInterval) == 'number';
const res =
object &&
object.token &&
typeof object.token == "string" &&
object.updateInterval &&
typeof object.updateInterval == "number";
for (let zone of object.zone) {
if(!this.isZoneConfig(zone))
return false;
if (!this.isZoneConfig(zone)) return false;
}
if (!res) return false;
@@ -216,18 +221,22 @@ class Deamon {
}
private isZoneConfig(object: any): object is ZoneConfig {
if(!this.arraysEqual(Object.keys(object), ['id', 'type', 'name', 'content', 'ttl', 'proxied']))
if (!this.arraysEqual(Object.keys(object), ["id", "type", "name", "content", "ttl", "proxied"]))
return false;
const res = object &&
object.id && typeof(object.id) == 'string' &&
object.type && typeof(object.type) == 'string' &&
object.name && typeof(object.name) == 'string' &&
object.content && typeof(object.content) == 'string' &&
object.ttl && typeof(object.ttl) == 'number' &&
typeof(object.proxied) == 'boolean';
const res =
object &&
object.id &&
typeof object.id == "string" &&
object.type &&
typeof object.type == "string" &&
object.name &&
typeof object.name == "string" &&
object.content &&
typeof object.content == "string" &&
object.ttl &&
typeof object.ttl == "number" &&
typeof object.proxied == "boolean";
if (!res) return false;
@@ -235,22 +244,20 @@ class Deamon {
}
private isEnviromentTokenPlaceholder(token: string) {
return token.startsWith('{ENV_TOKEN:') && token.endsWith('}');
return token.startsWith("{ENV_TOKEN:") && token.endsWith("}");
}
private parseEnvironmentTokenPlaceholderName(token: string) {
if (!this.isEnviromentTokenPlaceholder(token)) return null;
return token.split('{ENV_TOKEN:')[1].slice(0, -1);
return token.split("{ENV_TOKEN:")[1].slice(0, -1);
}
private async getCurrentIPv4() {
const response = await axios.get("https://api.ipify.org?format=json");
if(!response.data.ip)
throw new Error("Unable to fetch ip address");
if (!response.data.ip) throw new Error("Unable to fetch ip address");
if(!validator.isIP(response.data.ip, 4))
throw new Error("Invalid IP");
if (!validator.isIP(response.data.ip, 4)) throw new Error("Invalid IP");
return response.data.ip;
}
@@ -258,11 +265,9 @@ class Deamon {
private async getCurrentIPv6() {
const response = await axios.get("https://api64.ipify.org/?format=json");
if(!response.data.ip)
throw new Error("Unable to fetch ip address");
if (!response.data.ip) throw new Error("Unable to fetch ip address");
if(!validator.isIP(response.data.ip, 6))
return null;
if (!validator.isIP(response.data.ip, 6)) return null;
return response.data.ip;
}
@@ -277,7 +282,6 @@ class Deamon {
}
return true;
}
}
class CloudflareAPI {
@@ -289,21 +293,36 @@ class CloudflareAPI {
this.zoneId = zoneId;
}
public async getRecord({ name, type, content, proxied, page }: { name?: string, type?: string, content?: string, proxied?: boolean, page?: number }) {
const response = await axios.get(`https://api.cloudflare.com/client/v4/zones/${this.zoneId}/dns_records`, {
public async getRecord({
name,
type,
content,
proxied,
page,
}: {
name?: string;
type?: string;
content?: string;
proxied?: boolean;
page?: number;
}) {
const response = await axios.get(
`https://api.cloudflare.com/client/v4/zones/${this.zoneId}/dns_records`,
{
params: {
name,
type,
perPage: 5000,
content,
proxied,
page
page,
},
headers: {
'Authorization': `Bearer ${this.token}`,
'Content-Type': 'application/json'
}
});
Authorization: `Bearer ${this.token}`,
"Content-Type": "application/json",
},
},
);
if (response.data.success !== true)
throw new Error(`Unable to fetch record: ${response.data.errors[0].message}`);
@@ -311,19 +330,35 @@ class CloudflareAPI {
return response.data.result;
}
public async createRecord ({ name, type, content, ttl, proxied }: { name?: string, type?: string, content?: string, ttl: number, proxied?: boolean }) {
const response = await axios.post(`https://api.cloudflare.com/client/v4/zones/${this.zoneId}/dns_records`, {
public async createRecord({
name,
type,
content,
ttl,
proxied,
}: {
name?: string;
type?: string;
content?: string;
ttl: number;
proxied?: boolean;
}) {
const response = await axios.post(
`https://api.cloudflare.com/client/v4/zones/${this.zoneId}/dns_records`,
{
type,
name,
content,
ttl,
proxied
}, {
proxied,
},
{
headers: {
'Authorization': `Bearer ${this.token}`,
'Content-Type': 'application/json'
}
});
Authorization: `Bearer ${this.token}`,
"Content-Type": "application/json",
},
},
);
if (response.data.success !== true)
throw new Error(`Unable to create record: ${response.data.errors[0].message}`);
@@ -331,19 +366,37 @@ class CloudflareAPI {
return response.data.result;
}
public async updateRecord({ record_id, name, type, content, ttl, proxied }: { record_id: string, name?: string, type?: string, content?: string, ttl: number, proxied?: boolean }) {
const response = await axios.put(`https://api.cloudflare.com/client/v4/zones/${this.zoneId}/dns_records/${record_id}`, {
public async updateRecord({
record_id,
name,
type,
content,
ttl,
proxied,
}: {
record_id: string;
name?: string;
type?: string;
content?: string;
ttl: number;
proxied?: boolean;
}) {
const response = await axios.put(
`https://api.cloudflare.com/client/v4/zones/${this.zoneId}/dns_records/${record_id}`,
{
type,
name,
content,
ttl,
proxied
}, {
proxied,
},
{
headers: {
'Authorization': `Bearer ${this.token}`,
'Content-Type': 'application/json'
}
});
Authorization: `Bearer ${this.token}`,
"Content-Type": "application/json",
},
},
);
if (response.data.success !== true)
throw new Error(`Unable to update record: ${response.data.errors[0].message}`);
src/providers/Environment.ts
+6 -14
View File
@@ -3,12 +3,9 @@ import * as dotenv from "dotenv";
import Logger from "../libs/Logger";
const requiredENV = [
'NODE_ENV',
];
const requiredENV = ["NODE_ENV"];
class Environment {
public init(): void {
dotenv.config({ path: path.resolve(__dirname, "../../.env") });
@@ -21,31 +18,26 @@ class Environment {
if (this.get().NODE_ENV != "production" && this.get().NODE_ENV != "development")
throw new Error('.env NODE_ENV must be either "production" or "development"');
Logger.log('info', `Running in ${process.env.NODE_ENV} environment`);
Logger.log("info", `Running in ${process.env.NODE_ENV} environment`);
}
public get(): any {
const NODE_ENV = process.env.NODE_ENV;
return {
NODE_ENV
NODE_ENV,
};
}
private isUndefinedOrEmpty(value: String | undefined): boolean {
if(typeof value === 'undefined')
return true;
if (typeof value === "undefined") return true;
if(value === undefined)
return true;
if (value === undefined) return true;
if(value === '')
return true;
if (value === "") return true;
return false;
}
}
export default new Environment();
tsconfig.json
+1 -1
View File
@@ -89,7 +89,7 @@
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
// "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
"alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
"alwaysStrict": true /* Ensure 'use strict' is always emitted. */,
// "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */