cloudflare-ddns-sync 4.0.0-beta.1 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## v4
+
+### v4.0.0
+
+- ⬆️ Update dependencies, including Cloudflare 2 → 7, node-cron 3 → 4 and public-ip 6 → 8.
+- ♻️ Preserve public auth fields, key/token precedence, record types, sync methods and DNS defaults while adapting to the new SDK.
+- ♻️ Fetch all zone and DNS record pages; report zone-loading failures through the awaited operation.
+- 🚨 Add a DDNS-oriented API with `createDdns()`, `sync()`, `schedule()`, `watch()`, `list()`, `remove()` and `ip()`
+- 🚨 Allow records to be configured as hostnames; A and AAAA records automatically resolve the matching public IP
+- 🚨 Return a dedicated controllable job from schedules and watchers
+- 🐛 Respect the requested DNS type when listing records with the same hostname
+- ♻️ Validate configuration before network access, make jobs safe to stop and add `sync({ipv4, ipv6})` for configured records
+
 ## v3
 
 ### 3.0.2

package/MIGRATION-V4.md

@@ -0,0 +1,64 @@
+# Migrating from v3 to v4
+
+v4 replaces the class-based API with `createDdns()` and consolidates related methods. Node.js 20 remains the minimum requirement.
+
+## Initialization
+
+```ts
+// v3
+const ddns = new CloudflareDDNSSync({token});
+
+// v4
+const ddns = createDdns({token, records: ['home.example.com']});
+```
+
+If `token` is omitted, v4 reads `CLOUDFLARE_API_TOKEN`. `email`/`key` and user service keys remain supported.
+
+## Synchronizing
+
+```ts
+// v3
+await ddns.syncRecord({name: 'home.example.com'});
+await ddns.syncRecords(records, '203.0.113.10');
+
+// v4
+await ddns.sync('home.example.com');
+await ddns.sync(records, {ipv4: '203.0.113.10'});
+await ddns.sync({ipv4: '203.0.113.10'}); // configured records
+```
+
+`sync()` always returns an array. For a single record, use the first entry: `const [record] = await ddns.sync('home.example.com')`.
+
+For configured records, pass fixed addresses directly as the first argument. The former placeholder form `sync(undefined, {ipv4})` remains supported for compatibility.
+
+A and AAAA records automatically use the matching IP family. Non-IP records now require explicit `content`.
+
+## Scheduling and watching
+
+```ts
+// v3
+const task = ddns.syncByCronTime('*/5 * * * *', records, callback);
+const id = await ddns.syncOnIpChange(records, callback);
+ddns.stopSyncOnIpChange(id);
+
+// v4
+const task = ddns.schedule('*/5 * * * *', {records, onSync: callback});
+const watcher = await ddns.watch({records, onSync: callback});
+await watcher.stop();
+```
+
+`schedule()` and `watch()` return a `SyncJob` with `run()`, `start()` and `stop()`. A v4 job replaces both the listener ID and the direct `node-cron` return value.
+
+## Listing, removing and retrieving IPs
+
+| v3 | v4 |
+| --- | --- |
+| `getRecordDataForRecord(record)` | `list({records: record})` |
+| `getRecordDataForRecords(records)` | `list({records})` |
+| `getRecordDataForDomain(domain)` | `list({domains: domain})` |
+| `getRecordDataForDomains(domains)` | `list({domains, groupBy: 'domain'})` |
+| `removeRecord(name, type?)` | `remove(name)` oder `remove({name, type})` |
+| `getIp()` | `ip()` |
+| `getIpv6()` | `ip(6)` |
+
+`list()` without filters uses the configured records. Without that configuration, a filter is required.

package/README.md

@@ -1,160 +1,134 @@
 <table>
   <tr>
-    <td width="25%"><img src="./logo.png" alt="Logo" width="100%"></td>
+    <td width="25%"><img src="./logo.png" alt="Cloudflare DDNS Sync logo" width="100%"></td>
     <td><h1>Cloudflare DDNS Sync</h1></td>
   </tr>
 </table>
 
-![](https://github.com/SteffenKn/cloudflare-ddns-sync/actions/workflows/push.yml/badge.svg)
-[![npm version](https://badge.fury.io/js/cloudflare-ddns-sync.svg)](https://www.npmjs.com/package/cloudflare-ddns-sync)
-[![Downloads](https://img.shields.io/npm/dm/cloudflare-ddns-sync.svg)](https://www.npmjs.com/package/cloudflare-ddns-sync)
-[![CLI](https://img.shields.io/badge/CLI-npm-important.svg)](https://www.npmjs.com/package/cloudflare-ddns-sync-cli)
+Cloudflare DDNS Sync synchronizes DNS records with the current public IP address. Version 4 provides a small, DDNS-oriented API.
 
-## Overview
+## Voraussetzungen
 
-Cloudflare-DDNS-Sync is a simple module that updates Cloudflare DNS records.
+- Node.js 20 or newer
+- A Cloudflare API token with permission to read zones and edit DNS records
 
-For a more detailed overview, have a look at the [Documentation](https://cddnss.knaup.pw/)
+```sh
+npm install cloudflare-ddns-sync
+```
 
-You may also have a look at the **official** [CLI version](https://www.npmjs.com/package/cloudflare-ddns-sync-cli) of Cloudflare-DDNS-Sync.
+## Einstieg
 
-## How do I set this project up?
+Set `CLOUDFLARE_API_TOKEN` and configure the hostnames once:
 
-### Prerequisites
+```ts
+import {createDdns} from 'cloudflare-ddns-sync';
 
-- Node
-- Cloudflare Account
+const ddns = createDdns({
+  records: ['home.example.com', {name: 'app.example.com', proxied: true}],
+});
 
-### Installation
+await ddns.sync();
+```
 
-To install Cloudflare-DDNS-Sync simply run:
+A string represents an A record. Missing A and AAAA records are created; existing records with the same name and type are updated. A records automatically receive the public IPv4 address, and AAAA records receive the IPv6 address.
 
-```
-npm install cloudflare-ddns-sync
+```ts
+const ddns = createDdns({
+  token: process.env.CLOUDFLARE_API_TOKEN,
+  records: [
+    'home.example.com',
+    {name: 'home.example.com', type: 'AAAA'},
+    {name: 'alias.example.com', type: 'CNAME', content: 'home.example.com'},
+  ],
+});
+
+await ddns.sync();
 ```
 
-in your project folder.
+Explicit `token`, `email`/`key` and user service keys remain supported. If no credentials are provided, only `CLOUDFLARE_API_TOKEN` is used.
 
-## Usage
+## Synchronizing
 
-> Hint: If a record is not existing, CDS will automatically create it when
-> syncing.
+```ts
+await ddns.sync();
+await ddns.sync('temporary.example.com');
+await ddns.sync(['home.example.com', {name: 'vpn.example.com', proxied: true}]);
 
-### Javascript Example
+await ddns.sync({
+  ipv4: '203.0.113.10',
+  ipv6: '2001:db8::1',
+});
+```
 
-```javascript
-const Cddnss = require('cloudflare-ddns-sync').default;
+`sync()` always returns an array of updated DNS records. Explicit `content` on a record takes precedence. Record types other than A and AAAA require `content`.
 
-// either email and key or token
-const cddnss = new Cddnss({
-  email: 'your@email.com',
-  key: '<your-cloudflare-api-key>',
-  token: '<your-cloudflare-api-token>',
-});
+Use `plan()` to inspect the same operation without writing DNS records. Each entry has an `action` of `create`, `update` or `unchanged`. `sync()` leaves unchanged records untouched. If one or more writes fail, it throws `SyncError` with `succeeded` and `failed` entries.
 
-const records = [
-  {
-    name: 'test-1.domain.com',
-    type: 'A', // optional
-    proxied: true, // optional
-    ttl: 1, // optional
-    priority: 0, // optional
-    content: '1.2.3.4', // optional
-  },
-  {
-    name: 'test-2.domain.com',
-  },
-];
-
-cddnss.syncRecords(records).then((result) => {
-  console.log(result);
-});
+```ts
+const changes = await ddns.plan();
 ```
 
-### Typescript Example
+## Scheduling and IP watching
 
-```typescript
-import Cddnss, {Record, RecordData} from 'cloudflare-ddns-sync';
+```ts
+const scheduled = ddns.schedule('*/5 * * * *');
+await scheduled.stop();
 
-// either email and key or token
-const cddnss = new Cddnss({
-  email: 'your@email.com',
-  key: '<your-cloudflare-api-key>',
-  token: '<your-cloudflare-api-token>',
+const watching = await ddns.watch({
+  onError: error => console.error(error),
 });
 
-const records: Array<Record> = [
-  {
-    name: 'test-1.yourdomain.com',
-    type: 'A', // optional
-    proxied: true, // optional
-    ttl: 1, // optional
-    priority: 0, // optional
-    content: '1.2.3.4', // optional
-  },
-  {
-    name: 'test-2.yourdomain.com',
-  },
-];
-
-cddnss.syncRecords(records).then((result: Array<RecordData>) => {
-  console.log(result);
-});
+await watching.stop();
 ```
 
-### Cron Expression Syntax
+`schedule()` starts immediately and synchronizes at the next cron interval. `watch()` synchronizes first and then watches only the required IP families; the default interval is ten seconds. Fixed addresses and records with explicit `content` are not polled. Both return a job with `run()`, `start()` and `stop()` methods. Errors from `run()` reject its promise; automatic runs call `onError` once.
 
-Cron expressions have the following syntax:
+Configuration errors are `DdnsError`s with `code: 'INVALID_CONFIG'`; errors while looking up a public address have `code: 'IP_UNAVAILABLE'`.
 
+## Listing and removing records
+
+```ts
+const records = await ddns.list({records: 'home.example.com'});
+const ipv6Records = await ddns.list({records: {name: 'home.example.com', type: 'AAAA'}});
+const domainRecords = await ddns.list({domains: 'example.com'});
+const grouped = await ddns.list({domains: ['example.com', 'example.org'], groupBy: 'domain'});
+
+await ddns.remove('home.example.com');
+await ddns.remove({name: 'home.example.com', type: 'AAAA'});
 ```
-* * * * * *
-┬ ┬ ┬ ┬ ┬ ┬
-│ │ │ │ │ │
-│ │ │ │ │ └──── weekday (0-7, sunday is 0 or 7)
-│ │ │ │ └────── month (1-12)
-│ │ │ └──────── day (1-31)
-│ │ └────────── hour (0-23)
-│ └──────────── minute (0-59)
-└────────────── second (0-59) [optional]
+
+`remove('name')` removes an A record. Use a record object for other types. `list()` without filters uses the records configured when creating the DDNS instance. A record filter with `type` returns only that DNS type.
+
+## Public IP
+
+```ts
+const ipv4 = await ddns.ip();
+const ipv6 = await ddns.ip(6);
 ```
 
-## Methods
-
-- getIp(): Promise\<string\>
-- getIpv6(): Promise\<string\>
-- getRecordDataForDomain(domain: string): Promise\<Array\<[RecordData](https://cddnss.knaup.pw/types/recorddata)\>\>
-- getRecordDataForDomains(domains: Array\<string\>): Promise\<[DomainRecordList](https://cddnss.knaup.pw/types/domainrecordlist)\>
-- getRecordDataForRecord(record: [Record](https://cddnss.knaup.pw/types/record)): Promise\<[RecordData](https://cddnss.knaup.pw/types/recorddata)\>
-- getRecordDataForRecords(records: Array\<[Record](https://cddnss.knaup.pw/types/record)\>): Promise\<Array\<[RecordData](https://cddnss.knaup.pw/types/recorddata)\>\>
-- removeRecord(recordName: string, recordType?: string): Promise\<void\>
-- stopSyncOnIpChange(changeListenerId: string): void
-- syncByCronTime(cronExpression: string, records: Array\<[Record](https://cddnss.knaup.pw/types/recorddata)\>, callback: [MultiSyncCallback](https://cddnss.knaup.pw/types/multisynccallback), ip?: string): [ScheduledTask](https://www.npmjs.com/package/node-cron#scheduledtask-methods)
-- syncOnIpChange(records: Array\<[Record](https://cddnss.knaup.pw/types/record)\>, callback: multisynccallback): Promise\<string\>
-- syncRecord(record: [Record](https://cddnss.knaup.pw/types/record), ip?: string): Promise\<[RecordData](https://cddnss.knaup.pw/types/recorddata)\>
-- syncRecords(records: Array\<[Record](https://cddnss.knaup.pw/types/record)\>, ip?: string): Promise\<Array\<[RecordData](https://cddnss.knaup.pw/types/recorddata)\>\>
-
-For a more detailed view, have a look at the [Documentation](https://cddnss.knaup.pw/)
-
-## Get Your Cloudflare API Key
-
-- Go to **[Cloudflare](https://www.cloudflare.com)**
-- **Log In**
-- In the upper right corner: **click on the user icon**
-- Go to **"My Profile"**
-- In the "API Tokens"-Section: **click on the "View"-Button of the Global Key**
-- **Enter your password** and **fill the captcha**
-- **Copy the API Key**
+## Optional: eigene IP-Quelle und Zone
 
-## Tests
+```ts
+const ddns = createDdns({
+  zone: 'example.com',
+  records: ['@', 'home'],
+  resolveIp: family => readAddressFromRouter(family),
+});
+
+await ddns.close();
+```
 
-In order to run the tests there are two ways to do so
+With `zone`, `@` means the zone apex and simple labels are expanded. `resolveIp` is used by both `sync()` and `watch()`.
 
-### Use `test-data.json`
+## Migrating from v3
 
-- Open the `test-data.json` which can be found under `src/tests/test-service/`
-- Configure the email, cloudflare api key and the domain
-- Run `npm test`
+v4 is a breaking release. See [MIGRATION-V4.md](./MIGRATION-V4.md) for the complete mapping of the previous API.
 
-### Use `npm test` Only
+## Tests
+
+The integration tests create and remove records in a Cloudflare test zone:
 
-- Run `npm test -- --email="your@email.com" --key="your_cloudflare_api_key" --domain="yourdomain.com"`
+```sh
+npm run build
+npm test -- --token="$CLOUDFLARE_API_TOKEN" --domain="example.com"
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudflare-ddns-sync",
-  "version": "4.0.0-beta.1",
+  "version": "4.0.0",
   "description": "A simple module to update DNS records on Cloudflare whenever you want",
   "main": "dist/index.js",
   "author": "Steffen Knaup <SteffenKnaup@hotmail.de>",
@@ -20,7 +20,8 @@
     "url": "git://github.com:Steffen982/cloudflare-ddns-sync.git"
   },
   "scripts": {
-    "build": "tsc",
+    "clean": "node --input-type=module -e \"import {rm} from 'node:fs/promises'; await rm('dist', {recursive: true, force: true});\"",
+    "build": "npm run clean && tsc",
     "lint": "prettier -c ./src",
     "lint:fix": "prettier -w ./src",
     "test": "c8 mocha dist/tests/*.js --timeout 15000 --exit",
@@ -29,23 +30,24 @@
     "test:coverage-report": "c8 report"
   },
   "dependencies": {
-    "cloudflare": "3.0.0-beta.12",
-    "node-cron": "3.0.3",
-    "parse-domain": "8.0.2",
-    "public-ip": "6.0.2"
+    "cloudflare": "7.1.0",
+    "node-cron": "4.6.0",
+    "parse-domain": "8.4.0",
+    "public-ip": "8.0.0"
   },
   "devDependencies": {
-    "@types/chai": "4.3.14",
-    "@types/cloudflare": "^2.7.14",
+    "@types/chai": "5.2.3",
     "@types/minimist": "1.2.5",
-    "@types/mocha": "10.0.6",
-    "@types/node": "20.11.30",
-    "@types/node-cron": "3.0.11",
-    "c8": "9.1.0",
-    "chai": "5.1.0",
+    "@types/mocha": "10.0.10",
+    "@types/node": "26.5.0",
+    "c8": "12.0.0",
+    "chai": "6.2.2",
     "minimist": "1.2.8",
-    "mocha": "10.3.0",
-    "prettier": "^3.2.5",
-    "typescript": "5.4.3"
+    "mocha": "12.0.0",
+    "prettier": "3.9.6",
+    "typescript": "7.0.2"
+  },
+  "engines": {
+    "node": ">=20"
   }
 }

package/dist/index.d.ts

@@ -1,18 +0,0 @@
-import { Auth, MultiSyncCallback, Record } from './types/index.js';
-export default class CloudflareDDNSSync {
-    private cloudflareClient;
-    constructor(auth: Auth);
-    getIp(): Promise<string>;
-    getIpv6(): Promise<string>;
-    getRecordDataForDomain(domain: string): Promise<import("cloudflare/resources/dns/records.mjs").DNSRecord[]>;
-    getRecordDataForDomains(domains: Array<string>): Promise<{}>;
-    getRecordDataForRecord(record: Record): Promise<import("cloudflare/resources/dns/records.mjs").DNSRecord>;
-    getRecordDataForRecords(records: Array<Record>): Promise<any[]>;
-    removeRecord(recordName: string, recordType?: string): Promise<void>;
-    stopSyncOnIpChange(changeListenerId: string): void;
-    syncByCronTime(cronExpression: string, records: Array<Record>, callback: MultiSyncCallback, ip?: string): import("node-cron").ScheduledTask;
-    syncOnIpChange(records: Array<Record>, callback: MultiSyncCallback): Promise<string>;
-    syncRecord(record: Record, ip?: string): any;
-    syncRecords(records: Array<Record>, ip?: string): Promise<import("cloudflare/resources/dns/records.mjs").DNSRecord[]>;
-}
-export * from './types/index.js';

package/dist/index.js

@@ -1,58 +0,0 @@
-import CloudflareClient from './lib/cloudflare-client.js';
-import Cron from './lib/cron.js';
-import ipUtils from './lib/ip-utils.js';
-export default class CloudflareDDNSSync {
-    cloudflareClient;
-    constructor(auth) {
-        this.cloudflareClient = new CloudflareClient(auth);
-    }
-    getIp() {
-        return ipUtils.getIpv4();
-    }
-    getIpv6() {
-        return ipUtils.getIpv6();
-    }
-    getRecordDataForDomain(domain) {
-        return this.cloudflareClient.getRecordsByDomain(domain);
-    }
-    getRecordDataForDomains(domains) {
-        return this.cloudflareClient.getRecordsByDomains(domains);
-    }
-    getRecordDataForRecord(record) {
-        return this.cloudflareClient.getRecordDataForRecord(record);
-    }
-    getRecordDataForRecords(records) {
-        return this.cloudflareClient.getRecordDataForRecords(records);
-    }
-    removeRecord(recordName, recordType) {
-        return this.cloudflareClient.removeRecordByNameAndType(recordName, recordType);
-    }
-    stopSyncOnIpChange(changeListenerId) {
-        ipUtils.removeIpChangeListener(changeListenerId);
-    }
-    syncByCronTime(cronExpression, records, callback, ip) {
-        return Cron.createCronJob(cronExpression, async () => {
-            const result = await this.syncRecords(records, ip);
-            callback(result);
-        });
-    }
-    async syncOnIpChange(records, callback) {
-        const changeListenerId = await ipUtils.addIpChangeListener(async (ip) => {
-            const result = await this.syncRecords(records, ip);
-            callback(result);
-        });
-        // Sync records to make sure the current ip is already set.
-        const currentIp = await ipUtils.getIpv4();
-        this.syncRecords(records, currentIp).then((syncedRecords) => {
-            callback(syncedRecords);
-        });
-        return changeListenerId;
-    }
-    syncRecord(record, ip) {
-        return this.cloudflareClient.syncRecord(record, ip);
-    }
-    syncRecords(records, ip) {
-        return this.cloudflareClient.syncRecords(records, ip);
-    }
-}
-export * from './types/index.js';

package/dist/lib/cloudflare-client.d.ts

@@ -1,25 +0,0 @@
-import Cloudflare, { ClientOptions as CloudflareOptions } from 'cloudflare';
-import { Record } from '../types/index.js';
-export default class CloudflareClient {
-    private cloudflare;
-    private zoneMap;
-    constructor(cloudflareOptions: CloudflareOptions);
-    syncRecord(record: Record, ip?: string): Promise<Cloudflare.DNS.Records.DNSRecord>;
-    syncRecords(records: Array<Record>, ip?: string): Promise<Cloudflare.DNS.Records.DNSRecord[]>;
-    removeRecordByNameAndType(recordName: string, recordType?: string): Promise<void>;
-    getRecordDataForRecord(record: Record): Promise<Cloudflare.DNS.Records.DNSRecord>;
-    getRecordDataForRecords(records: Array<Record>): Promise<any[]>;
-    getRecordsByDomains(domains: Array<string>): Promise<{}>;
-    getRecordsByDomain(domain: string): Promise<Cloudflare.DNS.Records.DNSRecord[]>;
-    private createRecord;
-    private updateRecord;
-    private updateZoneMap;
-    private getRecordIdByNameAndType;
-    private getZoneIdByRecordName;
-    private getRecordByNameAndType;
-    private getRecordIdsForRecords;
-    private getRecordIdMapKey;
-    private getZoneIdByDomain;
-    private getDomainsFromRecords;
-    private getDomainByRecordName;
-}

package/dist/lib/cloudflare-client.js

@@ -1,216 +0,0 @@
-import { ParseResultType, fromUrl, parseDomain } from 'parse-domain';
-import Cloudflare from 'cloudflare';
-import IPUtils from './ip-utils.js';
-const ipv4Regex = /^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$/u;
-const ipv6Regex = /^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::))))$/u;
-export default class CloudflareClient {
-    cloudflare;
-    zoneMap = new Map();
-    constructor(cloudflareOptions) {
-        this.cloudflare = new Cloudflare(cloudflareOptions);
-        this.updateZoneMap();
-    }
-    async syncRecord(record, ip) {
-        const recordIds = await this.getRecordIdsForRecords([record]);
-        const ipToUse = ip ? ip : await IPUtils.getIpv4();
-        const zoneId = await this.getZoneIdByRecordName(record.name);
-        const recordId = recordIds.get(this.getRecordIdMapKey(record));
-        const recordExists = recordId !== undefined;
-        if (recordExists) {
-            const result = await this.updateRecord(zoneId, recordId, record, ipToUse);
-            return result;
-        }
-        const result = await this.createRecord(zoneId, record, ipToUse);
-        return result;
-    }
-    async syncRecords(records, ip) {
-        const recordIds = await this.getRecordIdsForRecords(records);
-        const ipToUse = ip ? ip : await IPUtils.getIpv4();
-        const resultPromises = records.map(async (record) => {
-            const zoneId = await this.getZoneIdByRecordName(record.name);
-            const recordId = recordIds.get(this.getRecordIdMapKey(record));
-            const recordExists = recordId !== undefined;
-            if (recordExists) {
-                const currentResult = await this.updateRecord(zoneId, recordId, record, ipToUse);
-                return currentResult;
-            }
-            const currentResult = await this.createRecord(zoneId, record, ipToUse);
-            return currentResult;
-        });
-        const results = await Promise.all(resultPromises);
-        return results;
-    }
-    async removeRecordByNameAndType(recordName, recordType) {
-        const recordTypeToUse = recordType ? recordType : 'A';
-        const zoneId = await this.getZoneIdByRecordName(recordName);
-        const recordId = await this.getRecordIdByNameAndType(recordName, recordTypeToUse);
-        await this.cloudflare.dns.records.delete(recordId, { zone_id: zoneId });
-    }
-    async getRecordDataForRecord(record) {
-        const domain = this.getDomainByRecordName(record.name);
-        const recordDataForDomain = await this.getRecordsByDomain(domain);
-        const recordData = recordDataForDomain.find((singleRecordData) => record.name.toLowerCase() === singleRecordData.name.toLowerCase());
-        return recordData;
-    }
-    async getRecordDataForRecords(records) {
-        const domains = this.getDomainsFromRecords(records);
-        const recordDataPromises = domains.map(async (domain) => {
-            const recordDataForDomain = await this.getRecordsByDomain(domain);
-            const recordDataForDomainFilteredByRecords = recordDataForDomain.filter((singleRecordData) => records.some((record) => record.name.toLowerCase() === singleRecordData.name.toLowerCase()));
-            return recordDataForDomainFilteredByRecords;
-        });
-        const recordDataForDomains = await Promise.all(recordDataPromises);
-        const recordData = [].concat(...recordDataForDomains);
-        return recordData;
-    }
-    async getRecordsByDomains(domains) {
-        const recordDataPromises = domains.map((domain) => this.getRecordsByDomain(domain));
-        const recordDataForDomains = await Promise.all(recordDataPromises);
-        const recordData = {};
-        recordDataForDomains.forEach((recordDataForDomain, index) => {
-            recordData[domains[index]] = recordDataForDomain;
-        });
-        return recordData;
-    }
-    async getRecordsByDomain(domain) {
-        const zoneId = await this.getZoneIdByDomain(domain);
-        const allRecords = [];
-        for await (const recordListResponse of this.cloudflare.dns.records.list({ zone_id: zoneId })) {
-            allRecords.push(recordListResponse);
-        }
-        return allRecords;
-    }
-    async createRecord(zoneId, recordData, ip) {
-        const dnsRecordToCreate = {
-            ...recordData,
-            name: recordData.name.toLowerCase(),
-            content: (recordData.content ? recordData.content : ip),
-            type: (recordData.type ? recordData.type : 'A'),
-            ttl: recordData.ttl ? recordData.ttl : 1,
-            zone_id: zoneId,
-        };
-        if (!dnsRecordToCreate.content) {
-            throw Error(`Could not create Record "${dnsRecordToCreate.name}": Content is missing!`);
-        }
-        if (dnsRecordToCreate.type === 'A') {
-            if (!dnsRecordToCreate.content.match(ipv4Regex)) {
-                throw Error(`Could not create Record "${dnsRecordToCreate.name}": '${dnsRecordToCreate.content}' is not a valid ipv4!`);
-            }
-        }
-        else if (dnsRecordToCreate.type === 'AAAA') {
-            if (!dnsRecordToCreate.content.match(ipv6Regex)) {
-                throw Error(`Could not create Record "${dnsRecordToCreate.name}": '${dnsRecordToCreate.content}' is not a valid ipv6!`);
-            }
-        }
-        else if (dnsRecordToCreate.type === 'CNAME') {
-            const parsedDomain = parseDomain(fromUrl(dnsRecordToCreate.content));
-            if (parsedDomain.type !== ParseResultType.Listed || !parsedDomain.domain) {
-                throw Error(`Could not create Record "${dnsRecordToCreate.name}": '${dnsRecordToCreate.content}' is not a valid domain name!`);
-            }
-        }
-        return this.cloudflare.dns.records.create(dnsRecordToCreate);
-    }
-    async updateRecord(zoneId, recordId, recordData, ip) {
-        const updatedDnsRecord = {
-            ...recordData,
-            name: recordData.name.toLowerCase(),
-            content: (recordData.content ? recordData.content : ip),
-            type: (recordData.type ? recordData.type : 'A'),
-            ttl: recordData.ttl ? recordData.ttl : 1,
-            zone_id: zoneId,
-        };
-        if (!updatedDnsRecord.content) {
-            throw Error(`Could not update Record "${updatedDnsRecord.name}": Content is missing!`);
-        }
-        if (updatedDnsRecord.type === 'A') {
-            if (!updatedDnsRecord.content.match(ipv4Regex)) {
-                throw Error(`Could not update Record "${updatedDnsRecord.name}": '${updatedDnsRecord.content}' is not a valid ipv4!`);
-            }
-        }
-        else if (updatedDnsRecord.type === 'AAAA') {
-            if (!updatedDnsRecord.content.match(ipv6Regex)) {
-                throw Error(`Could not update Record "${updatedDnsRecord.name}": '${updatedDnsRecord.content}' is not a valid ipv6!`);
-            }
-        }
-        else if (updatedDnsRecord.type === 'CNAME') {
-            const parsedDomain = parseDomain(fromUrl(updatedDnsRecord.content));
-            if (parsedDomain.type !== ParseResultType.Listed || !parsedDomain.domain) {
-                throw Error(`Could not update Record "${updatedDnsRecord.name}": '${updatedDnsRecord.content}' is not a valid domain name!`);
-            }
-        }
-        return await this.cloudflare.dns.records.edit(recordId, updatedDnsRecord);
-    }
-    async updateZoneMap() {
-        const response = await this.cloudflare.zones.list();
-        let zones = response.result;
-        let nextPageExists = response.hasNextPage();
-        while (nextPageExists) {
-            const nextPageResponse = await response.getNextPage();
-            zones = zones.concat(nextPageResponse.result);
-            nextPageExists = nextPageResponse.hasNextPage();
-        }
-        this.zoneMap = new Map();
-        for (const zone of zones) {
-            this.zoneMap.set(zone.name, zone.id);
-        }
-    }
-    async getRecordIdByNameAndType(recordName, recordType) {
-        const record = await this.getRecordByNameAndType(recordName, recordType);
-        return record.id;
-    }
-    getZoneIdByRecordName(recordName) {
-        const domain = this.getDomainByRecordName(recordName);
-        return this.getZoneIdByDomain(domain);
-    }
-    async getRecordByNameAndType(recordName, recordType) {
-        const domain = this.getDomainByRecordName(recordName);
-        const records = await this.getRecordsByDomain(domain);
-        const record = records.find((currentRecord) => currentRecord.name.toLowerCase() === recordName.toLowerCase() && currentRecord.type.toLowerCase() === recordType.toLowerCase());
-        const recordNotFound = record === undefined;
-        if (recordNotFound) {
-            throw new Error(`Record '${recordName}' not found.`);
-        }
-        return record;
-    }
-    async getRecordIdsForRecords(records) {
-        const recordIdMap = new Map();
-        const recordData = await this.getRecordDataForRecords(records);
-        for (const record of recordData) {
-            recordIdMap.set(this.getRecordIdMapKey(record), record.id);
-        }
-        return recordIdMap;
-    }
-    getRecordIdMapKey(record) {
-        const recordName = record.name.toLowerCase();
-        const recordType = record.type ? record.type.toLowerCase() : 'a';
-        return `"${recordName}"_"${recordType}"`;
-    }
-    async getZoneIdByDomain(domain) {
-        if (this.zoneMap.has(domain)) {
-            const zoneId = this.zoneMap.get(domain.toLowerCase());
-            return zoneId;
-        }
-        await this.updateZoneMap();
-        if (!this.zoneMap.has(domain)) {
-            throw new Error(`Could not find domain '${domain}'. Make sure the domain is set up for your cloudflare account.`);
-        }
-        const zoneId = this.zoneMap.get(domain.toLowerCase());
-        return zoneId;
-    }
-    getDomainsFromRecords(records) {
-        const domains = records.map((record) => this.getDomainByRecordName(record.name)).filter((domain, index, domainList) => domainList.indexOf(domain.toLowerCase()) === index);
-        return domains;
-    }
-    getDomainByRecordName(recordName) {
-        const parsedDomain = parseDomain(fromUrl(recordName));
-        if (parsedDomain.type !== ParseResultType.Listed || !parsedDomain.domain) {
-            throw new Error(`Could not parse domain. '${JSON.stringify(recordName)}' is not a valid record name.`);
-        }
-        let domain = '';
-        domain += parsedDomain.domain;
-        for (const tld of parsedDomain.topLevelDomains) {
-            domain += `.${tld}`;
-        }
-        return domain.toLowerCase();
-    }
-}

package/dist/lib/cron.d.ts

@@ -1,5 +0,0 @@
-import { ScheduledTask } from 'node-cron';
-export default class Cron {
-    static createCronJob(cronExpression: string, callback: Function): ScheduledTask;
-    static isValid(cronExpression: string): boolean;
-}

package/dist/lib/cron.js

@@ -1,15 +0,0 @@
-import cron from 'node-cron';
-export default class Cron {
-    static createCronJob(cronExpression, callback) {
-        const cronExpressionIsInvalid = !this.isValid(cronExpression);
-        if (cronExpressionIsInvalid) {
-            throw new Error(`'${cronExpression}' is not a valid cron expression.\nHere you can see how cron expressions work: https://cddnss.knaup.pw/cron-expression-syntax`);
-        }
-        return cron.schedule(cronExpression, () => {
-            callback();
-        }, undefined);
-    }
-    static isValid(cronExpression) {
-        return cron.validate(cronExpression);
-    }
-}

package/dist/lib/ip-utils.d.ts

@@ -1,9 +0,0 @@
-export default class IPUtils {
-    private static readonly ipPollingDelay;
-    private static ipChangeEventListeners;
-    static getIpv4(): Promise<string>;
-    static getIpv6(): Promise<string>;
-    static addIpChangeListener(callback: Function): Promise<string>;
-    static removeIpChangeListener(eventListenerId: string): void;
-    private static getId;
-}

package/dist/lib/ip-utils.js

@@ -1,49 +0,0 @@
-import { publicIpv4, publicIpv6 } from 'public-ip';
-export default class IPUtils {
-    static ipPollingDelay = 10 * 1000;
-    static ipChangeEventListeners = new Map();
-    static async getIpv4() {
-        /* c8 ignore start*/
-        try {
-            return await publicIpv4();
-        }
-        catch (error) {
-            return publicIpv4();
-        }
-        /* c8 ignore stop*/
-    }
-    static async getIpv6() {
-        /* c8 ignore start */
-        try {
-            return await publicIpv6();
-        }
-        catch (error) {
-            return publicIpv6();
-        }
-        /* c8 ignore stop*/
-    }
-    static async addIpChangeListener(callback) {
-        const eventListenerId = this.getId();
-        let previousIp = await this.getIpv4();
-        /* c8 ignore start */
-        const intervalId = setInterval(async () => {
-            const currentIp = await this.getIpv4();
-            const ipMustBeUpdated = currentIp !== previousIp;
-            if (ipMustBeUpdated) {
-                previousIp = currentIp;
-                callback(currentIp);
-            }
-        }, this.ipPollingDelay);
-        /* c8 ignore stop*/
-        this.ipChangeEventListeners.set(eventListenerId, intervalId);
-        return eventListenerId;
-    }
-    static removeIpChangeListener(eventListenerId) {
-        const eventListenerIntervalId = this.ipChangeEventListeners.get(eventListenerId);
-        clearInterval(eventListenerIntervalId);
-        IPUtils.ipChangeEventListeners.delete(eventListenerId);
-    }
-    static getId() {
-        return Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
-    }
-}

package/dist/types/Auth.d.ts

@@ -1,2 +0,0 @@
-import Cloudflare from 'cloudflare';
-export type Auth = Cloudflare.AuthObject;

package/dist/types/Auth.js

@@ -1 +0,0 @@
-export {};

package/dist/types/Callbacks.d.ts

@@ -1,2 +0,0 @@
-import Cloudflare from 'cloudflare';
-export type MultiSyncCallback = (syncResult: Cloudflare.DNS.DNSRecord[]) => void;

package/dist/types/Callbacks.js

@@ -1 +0,0 @@
-export {};

package/dist/types/CloudflareOptions.d.ts

@@ -1,2 +0,0 @@
-import { ClientOptions } from 'cloudflare';
-export type Auth = ClientOptions;

package/dist/types/CloudflareOptions.js

@@ -1 +0,0 @@
-export {};

package/dist/types/DomainRecordList.d.ts

@@ -1,4 +0,0 @@
-import { RecordData } from './index.js';
-export type DomainRecordList = {
-    [domain: string]: Array<RecordData>;
-};

package/dist/types/DomainRecordList.js

@@ -1 +0,0 @@
-export {};

package/dist/types/Record.d.ts

@@ -1,2 +0,0 @@
-import { Cloudflare } from 'cloudflare';
-export type Record = Cloudflare.DNS.DNSRecord;

package/dist/types/Record.js

@@ -1 +0,0 @@
-export {};

package/dist/types/ZoneMap.d.ts

@@ -1 +0,0 @@
-export type ZoneMap = Map<string, string>;

package/dist/types/ZoneMap.js

@@ -1 +0,0 @@
-export {};

package/dist/types/cloudflare/RecordData.d.ts

@@ -1,21 +0,0 @@
-import { RecordTypes } from '../index.js';
-export type RecordData = {
-    id: string;
-    type: RecordTypes;
-    name: string;
-    content: string;
-    proxiable: boolean;
-    proxied: boolean;
-    ttl: number;
-    locked: boolean;
-    zone_id: string;
-    zone_name: string;
-    modified_on: string;
-    created_on: string;
-    meta: RecordMetaData;
-};
-export type RecordMetaData = {
-    auto_added: boolean;
-    managed_by_apps: boolean;
-    managed_by_argo_tunnel: boolean;
-};

package/dist/types/cloudflare/RecordData.js

@@ -1 +0,0 @@
-export {};

package/dist/types/cloudflare/ZoneData.d.ts

@@ -1,43 +0,0 @@
-export type ZoneData = {
-    id: string;
-    name: string;
-    status: string;
-    paused: boolean;
-    type: string;
-    development_mode: number;
-    name_servers: Array<string>;
-    original_name_servers: Array<string>;
-    modified_on: Date;
-    created_on: Date;
-    activated_on: Date;
-    meta: {
-        step: number;
-        wildcard_proxiable: boolean;
-        custom_certificate_quota: number;
-        page_rule_quota: number;
-        phishing_detected: boolean;
-        multiple_railguns_allowed: boolean;
-    };
-    owner: {
-        id: string;
-        type: string;
-        email: string;
-    };
-    account: {
-        id: string;
-        name: string;
-    };
-    permissions: Array<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;
-    };
-};

package/dist/types/cloudflare/ZoneData.js

@@ -1 +0,0 @@
-export {};

package/dist/types/cloudflare/index.d.ts

@@ -1,2 +0,0 @@
-export * from './RecordData.js';
-export * from './ZoneData.js';

package/dist/types/cloudflare/index.js

@@ -1,2 +0,0 @@
-export * from './RecordData.js';
-export * from './ZoneData.js';

package/dist/types/index.d.ts

@@ -1,4 +0,0 @@
-export * from './CloudflareOptions.js';
-export * from './Callbacks.js';
-export * from './Record.js';
-export * from './ZoneMap.js';

package/dist/types/index.js

@@ -1,4 +0,0 @@
-export * from './CloudflareOptions.js';
-export * from './Callbacks.js';
-export * from './Record.js';
-export * from './ZoneMap.js';