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

package/dist/types/Auth.d.ts

@@ -1,2 +1,5 @@
-import Cloudflare from 'cloudflare';
-export type Auth = Cloudflare.AuthObject;
+export type Auth = {
+    email?: string | undefined;
+    key?: string | undefined;
+    token?: string | undefined;
+};

package/dist/types/Callbacks.d.ts

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

package/dist/types/Options.d.ts

@@ -0,0 +1,48 @@
+import { Auth } from './Auth.js';
+import { DnsRecord } from './cloudflare/RecordData.js';
+import { RecordInput } from './Record.js';
+export type RecordSelection = RecordInput | Array<RecordInput>;
+export type DdnsOptions = Auth & {
+    records?: RecordSelection;
+    zone?: string;
+    resolveIp?: (family: 4 | 6) => string | Promise<string>;
+};
+export type SyncOptions = {
+    ipv4?: string;
+    ipv6?: string;
+};
+export type SyncChange = {
+    record: RecordInput;
+    action: 'create' | 'update' | 'unchanged';
+    before?: DnsRecord;
+    after: RecordInput;
+};
+export type JobOptions = SyncOptions & {
+    records?: RecordSelection;
+    onSync?: (records: Array<DnsRecord>) => void | Promise<void>;
+    onError?: (error: Error) => void | Promise<void>;
+};
+export type WatchOptions = JobOptions & {
+    intervalMs?: number;
+};
+export type RecordListOptions = {
+    records?: RecordSelection;
+    domains?: never;
+    groupBy?: never;
+};
+export type DomainListOptions = {
+    records?: never;
+    domains?: string | Array<string>;
+    groupBy?: never;
+};
+export type GroupedDomainListOptions = {
+    records?: never;
+    domains: string | Array<string>;
+    groupBy: 'domain';
+};
+export type ListOptions = RecordListOptions | DomainListOptions | GroupedDomainListOptions;
+export type SyncJob = {
+    run(): Promise<Array<DnsRecord>>;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+};

package/dist/types/Record.d.ts

@@ -1,2 +1,11 @@
-import { Cloudflare } from 'cloudflare';
-export type Record = Cloudflare.DNS.DNSRecord;
+export type RecordTypes = 'A' | 'AAAA' | 'CNAME' | 'HTTPS' | 'TXT' | 'LOC' | 'NS' | 'SPF' | 'CERT' | 'DNSKEY' | 'DS' | 'NAPTR' | 'SMIMEA' | 'SSHFP' | 'SVCB' | 'TLSA';
+export type Record = {
+    name: string;
+    type?: RecordTypes;
+    proxied?: boolean;
+    ttl?: number;
+    priority?: number;
+    content?: string;
+};
+/** A hostname or a DNS record with explicit options. */
+export type RecordInput = string | Record;

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

@@ -1,5 +1,5 @@
 import { RecordTypes } from '../index.js';
-export type RecordData = {
+export type DnsRecord = {
     id: string;
     type: RecordTypes;
     name: string;
@@ -14,6 +14,8 @@ export type RecordData = {
     created_on: string;
     meta: RecordMetaData;
 };
+/** @deprecated Use DnsRecord. */
+export type RecordData = DnsRecord;
 export type RecordMetaData = {
     auto_added: boolean;
     managed_by_apps: boolean;

package/dist/types/index.d.ts

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

package/dist/types/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudflare-ddns-sync",
-  "version": "4.0.0-beta.2",
+  "version": "4.0.0-rc.1",
   "description": "A simple module to update DNS records on Cloudflare whenever you want",
   "main": "dist/index.js",
   "author": "Steffen Knaup <SteffenKnaup@hotmail.de>",
@@ -20,32 +20,35 @@
     "url": "git://github.com:Steffen982/cloudflare-ddns-sync.git"
   },
   "scripts": {
-    "build": "tsc",
+    "clean": "rm -rf dist coverage",
+    "build": "npm run clean && tsc",
     "lint": "prettier -c ./src",
     "lint:fix": "prettier -w ./src",
+    "prepublishOnly": "npm run lint && npm run build",
     "test": "c8 mocha dist/tests/*.js --timeout 15000 --exit",
     "test:coverage": "npm run test:coverage-check && npm run test:coverage-report",
     "test:coverage-check": "c8 check-coverage --lines 70 --functions 70 --branches 70",
     "test:coverage-report": "c8 report"
   },
   "dependencies": {
-    "cloudflare": "3.0.0",
-    "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.12.7",
-    "@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.4.0",
-    "prettier": "^3.2.5",
-    "typescript": "5.4.5"
+    "mocha": "12.0.0",
+    "prettier": "3.9.6",
+    "typescript": "7.0.2"
+  },
+  "engines": {
+    "node": ">=20"
   }
 }

package/dist/types/CloudflareOptions.d.ts

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