cloudflare-ddns-sync 3.0.2 → 4.0.0-beta.2

package/dist/index.d.ts

@@ -1,19 +1,18 @@
-import { ScheduledTask } from 'node-cron';
-import { Auth, DomainRecordList, MultiSyncCallback, Record, RecordData } from './types/index.js';
+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<Array<RecordData>>;
-    getRecordDataForDomains(domains: Array<string>): Promise<DomainRecordList>;
-    getRecordDataForRecord(record: Record): Promise<RecordData>;
-    getRecordDataForRecords(records: Array<Record>): Promise<Array<RecordData>>;
+    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): ScheduledTask;
+    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): Promise<RecordData>;
-    syncRecords(records: Array<Record>, ip?: string): Promise<Array<RecordData>>;
+    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

@@ -13,10 +13,10 @@ export default class CloudflareDDNSSync {
         return ipUtils.getIpv6();
     }
     getRecordDataForDomain(domain) {
-        return this.cloudflareClient.getRecordDataForDomain(domain);
+        return this.cloudflareClient.getRecordsByDomain(domain);
     }
     getRecordDataForDomains(domains) {
-        return this.cloudflareClient.getRecordDataForDomains(domains);
+        return this.cloudflareClient.getRecordsByDomains(domains);
     }
     getRecordDataForRecord(record) {
         return this.cloudflareClient.getRecordDataForRecord(record);

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

@@ -1,16 +1,16 @@
-import Cloudflare from 'cloudflare';
-import { DomainRecordList, Record, RecordData } from '../types/index.js';
+import Cloudflare, { ClientOptions as CloudflareOptions } from 'cloudflare';
+import { Record } from '../types/index.js';
 export default class CloudflareClient {
     private cloudflare;
     private zoneMap;
-    constructor(auth: Cloudflare.AuthObject);
-    syncRecord(record: Record, ip?: string): Promise<RecordData>;
-    syncRecords(records: Array<Record>, ip?: string): Promise<Array<RecordData>>;
+    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<RecordData>;
-    getRecordDataForRecords(records: Array<Record>): Promise<Array<RecordData>>;
-    getRecordDataForDomains(domains: Array<string>): Promise<DomainRecordList>;
-    getRecordDataForDomain(domain: string): Promise<Array<RecordData>>;
+    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;
@@ -19,7 +19,6 @@ export default class CloudflareClient {
     private getRecordByNameAndType;
     private getRecordIdsForRecords;
     private getRecordIdMapKey;
-    private getRecordsByDomain;
     private getZoneIdByDomain;
     private getDomainsFromRecords;
     private getDomainByRecordName;

package/dist/lib/cloudflare-client.js

@@ -6,8 +6,8 @@ const ipv6Regex = /^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:
 export default class CloudflareClient {
     cloudflare;
     zoneMap = new Map();
-    constructor(auth) {
-        this.cloudflare = new Cloudflare(auth);
+    constructor(cloudflareOptions) {
+        this.cloudflare = new Cloudflare(cloudflareOptions);
         this.updateZoneMap();
     }
     async syncRecord(record, ip) {
@@ -44,7 +44,7 @@ export default class CloudflareClient {
         const recordTypeToUse = recordType ? recordType : 'A';
         const zoneId = await this.getZoneIdByRecordName(recordName);
         const recordId = await this.getRecordIdByNameAndType(recordName, recordTypeToUse);
-        await this.cloudflare.dnsRecords.del(zoneId, recordId);
+        await this.cloudflare.dns.records.delete(recordId, { zone_id: zoneId });
     }
     async getRecordDataForRecord(record) {
         const domain = this.getDomainByRecordName(record.name);
@@ -63,8 +63,8 @@ export default class CloudflareClient {
         const recordData = [].concat(...recordDataForDomains);
         return recordData;
     }
-    async getRecordDataForDomains(domains) {
-        const recordDataPromises = domains.map((domain) => this.getRecordDataForDomain(domain));
+    async getRecordsByDomains(domains) {
+        const recordDataPromises = domains.map((domain) => this.getRecordsByDomain(domain));
         const recordDataForDomains = await Promise.all(recordDataPromises);
         const recordData = {};
         recordDataForDomains.forEach((recordDataForDomain, index) => {
@@ -72,73 +72,83 @@ export default class CloudflareClient {
         });
         return recordData;
     }
-    async getRecordDataForDomain(domain) {
-        const recordData = await this.getRecordsByDomain(domain);
-        return recordData;
-    }
-    async createRecord(zoneId, record, ip) {
-        const dnsRecord = {
-            ...record,
-            name: record.name.toLowerCase(),
-            content: record.content ? record.content : ip,
-            type: record.type ? record.type : 'A',
-            ttl: record.ttl ? record.ttl : 1,
+    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 (!dnsRecord.content) {
-            throw Error(`Could not create Record "${dnsRecord.name}": Content is missing!`);
+        if (!dnsRecordToCreate.content) {
+            throw Error(`Could not create Record "${dnsRecordToCreate.name}": Content is missing!`);
         }
-        if (dnsRecord.type === 'A') {
-            if (!dnsRecord.content.match(ipv4Regex)) {
-                throw Error(`Could not create Record "${dnsRecord.name}": '${dnsRecord.content}' is not a valid ipv4!`);
+        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 (dnsRecord.type === 'AAAA') {
-            if (!dnsRecord.content.match(ipv6Regex)) {
-                throw Error(`Could not create Record "${dnsRecord.name}": '${dnsRecord.content}' is not a valid ipv6!`);
+        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 (dnsRecord.type === 'CNAME') {
-            const parsedDomain = parseDomain(fromUrl(dnsRecord.content));
+        else if (dnsRecordToCreate.type === 'CNAME') {
+            const parsedDomain = parseDomain(fromUrl(dnsRecordToCreate.content));
             if (parsedDomain.type !== ParseResultType.Listed || !parsedDomain.domain) {
-                throw Error(`Could not create Record "${dnsRecord.name}": '${dnsRecord.content}' is not a valid domain name!`);
+                throw Error(`Could not create Record "${dnsRecordToCreate.name}": '${dnsRecordToCreate.content}' is not a valid domain name!`);
             }
         }
-        const response = (await this.cloudflare.dnsRecords.add(zoneId, dnsRecord));
-        return response.result;
+        return this.cloudflare.dns.records.create(dnsRecordToCreate);
     }
-    async updateRecord(zoneId, recordId, record, ip) {
-        const dnsRecord = {
-            ...record,
-            name: record.name.toLowerCase(),
-            content: record.content ? record.content : ip,
-            type: record.type ? record.type : 'A',
-            ttl: record.ttl ? record.ttl : 1,
+    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 (!dnsRecord.content) {
-            throw Error(`Could not update Record "${dnsRecord.name}": Content is missing!`);
+        if (!updatedDnsRecord.content) {
+            throw Error(`Could not update Record "${updatedDnsRecord.name}": Content is missing!`);
         }
-        if (dnsRecord.type === 'A') {
-            if (!dnsRecord.content.match(ipv4Regex)) {
-                throw Error(`Could not update Record "${dnsRecord.name}": '${dnsRecord.content}' is not a valid ipv4!`);
+        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 (dnsRecord.type === 'AAAA') {
-            if (!dnsRecord.content.match(ipv6Regex)) {
-                throw Error(`Could not update Record "${dnsRecord.name}": '${dnsRecord.content}' is not a valid ipv6!`);
+        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 (dnsRecord.type === 'CNAME') {
-            const parsedDomain = parseDomain(fromUrl(dnsRecord.content));
+        else if (updatedDnsRecord.type === 'CNAME') {
+            const parsedDomain = parseDomain(fromUrl(updatedDnsRecord.content));
             if (parsedDomain.type !== ParseResultType.Listed || !parsedDomain.domain) {
-                throw Error(`Could not update Record "${dnsRecord.name}": '${dnsRecord.content}' is not a valid domain name!`);
+                throw Error(`Could not update Record "${updatedDnsRecord.name}": '${updatedDnsRecord.content}' is not a valid domain name!`);
             }
         }
-        const response = (await this.cloudflare.dnsRecords.edit(zoneId, recordId, dnsRecord));
-        return response.result;
+        return await this.cloudflare.dns.records.edit(recordId, updatedDnsRecord);
     }
     async updateZoneMap() {
-        const response = (await this.cloudflare.zones.browse());
-        const zones = response.result;
+        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);
@@ -175,23 +185,6 @@ export default class CloudflareClient {
         const recordType = record.type ? record.type.toLowerCase() : 'a';
         return `"${recordName}"_"${recordType}"`;
     }
-    async getRecordsByDomain(domain) {
-        const zoneId = await this.getZoneIdByDomain(domain);
-        const records = [];
-        let pageIndex = 1;
-        let allRecordsFound = false;
-        const recordsPerPage = 5000;
-        while (!allRecordsFound) {
-            const response = (await this.cloudflare.dnsRecords.browse(zoneId, {
-                page: pageIndex,
-                per_page: recordsPerPage,
-            }));
-            records.push(...response.result);
-            allRecordsFound = response.result.length < recordsPerPage;
-            pageIndex++;
-        }
-        return records;
-    }
     async getZoneIdByDomain(domain) {
         if (this.zoneMap.has(domain)) {
             const zoneId = this.zoneMap.get(domain.toLowerCase());

package/dist/types/Callbacks.d.ts

@@ -1,3 +1,2 @@
-import { RecordData } from './index.js';
-export type SingleSyncCallback = (syncResult: RecordData) => void;
-export type MultiSyncCallback = (syncResult: Array<RecordData>) => void;
+import Cloudflare from 'cloudflare';
+export type MultiSyncCallback = (syncResult: Cloudflare.DNS.DNSRecord[]) => void;

package/dist/types/CloudflareOptions.d.ts

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

package/dist/types/CloudflareOptions.js

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

package/dist/types/Record.d.ts

@@ -1,10 +1,2 @@
-import { RecordTypes as CloudflareRecordTypes } from 'cloudflare';
-export type RecordTypes = Exclude<CloudflareRecordTypes, 'MX' | 'SRV' | 'URI'>;
-export type Record = {
-    name: string;
-    type?: RecordTypes;
-    proxied?: boolean;
-    ttl?: number;
-    priority?: number;
-    content?: string;
-};
+import { Cloudflare } from 'cloudflare';
+export type Record = Cloudflare.DNS.DNSRecord;

package/dist/types/index.d.ts

@@ -1,6 +1,4 @@
-export * from './cloudflare/index.js';
-export * from './Auth.js';
+export * from './CloudflareOptions.js';
 export * from './Callbacks.js';
-export * from './DomainRecordList.js';
 export * from './Record.js';
 export * from './ZoneMap.js';

package/dist/types/index.js

@@ -1,6 +1,4 @@
-export * from './cloudflare/index.js';
-export * from './Auth.js';
+export * from './CloudflareOptions.js';
 export * from './Callbacks.js';
-export * from './DomainRecordList.js';
 export * from './Record.js';
 export * from './ZoneMap.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudflare-ddns-sync",
-  "version": "3.0.2",
+  "version": "4.0.0-beta.2",
   "description": "A simple module to update DNS records on Cloudflare whenever you want",
   "main": "dist/index.js",
   "author": "Steffen Knaup <SteffenKnaup@hotmail.de>",
@@ -29,7 +29,7 @@
     "test:coverage-report": "c8 report"
   },
   "dependencies": {
-    "cloudflare": "2.9.1",
+    "cloudflare": "3.0.0",
     "node-cron": "3.0.3",
     "parse-domain": "8.0.2",
     "public-ip": "6.0.2"
@@ -39,13 +39,13 @@
     "@types/cloudflare": "^2.7.14",
     "@types/minimist": "1.2.5",
     "@types/mocha": "10.0.6",
-    "@types/node": "20.11.30",
+    "@types/node": "20.12.7",
     "@types/node-cron": "3.0.11",
     "c8": "9.1.0",
     "chai": "5.1.0",
     "minimist": "1.2.8",
-    "mocha": "10.3.0",
+    "mocha": "10.4.0",
     "prettier": "^3.2.5",
-    "typescript": "5.4.3"
+    "typescript": "5.4.5"
   }
 }