chore: init

Author: danielroe

.env.example

@@ -0,0 +1,2 @@
+GANDI_API_KEY=
+CLOUDFLARE_API_TOKEN=

.gitignore

@@ -0,0 +1,169 @@
+# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
+
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+\*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+\*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+\*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+\*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.cache
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+.cache/
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+.cache
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.\*

README.md

@@ -0,0 +1,23 @@
+# domain-sync
+
+> This is a tiny script for my use that migrates all my Gandi domains to use Cloudflare DNS.
+
+To install dependencies, ensure you have the [latest version of bun](https://bun.sh/) installed, and then run:
+
+```bash
+bun install
+```
+
+Create a file called `.env` with your Gandi API token and a Cloudflare token with the following permissions:
+
+ - User > Memberships > Edit
+ - Zone > Zone Settings > Edit
+ - Zone > Zone > Edit
+
+Then simply run:
+
+```bash
+bun run index.ts
+```
+
+This script is idempotent; it's safe to run more than once as it will skip domains that already have their nameservers updated to CF.

api/cloudflare.ts

@@ -0,0 +1,77 @@
+import { $fetch } from 'ofetch'
+import { z } from 'zod'
+
+const api = $fetch.create({
+  baseURL: 'https://api.cloudflare.com/client/v4',
+  headers: {
+    Authorization: `Bearer ${Bun.env.CLOUDFLARE_API_TOKEN}`,
+  },
+})
+
+const zoneSchema = z.object({
+  result: z.object({
+    id: z.string(),
+    name: z.string(),
+    status: z.string(),
+    paused: z.boolean(),
+    type: z.string(),
+    development_mode: z.number(),
+    name_servers: z.array(z.string()),
+    original_name_servers: z.array(z.string()),
+    original_registrar: z.string().nullable(),
+    original_dnshost: z.string().nullable(),
+    modified_on: z.string(),
+    created_on: z.string(),
+    activated_on: z.string().nullable(),
+    meta: z.object({
+      step: z.number(),
+      custom_certificate_quota: z.number(),
+      page_rule_quota: z.number(),
+      phishing_detected: z.boolean(),
+      multiple_railguns_allowed: z.boolean(),
+    }),
+    owner: z.object({
+      id: z.string().nullable(),
+      type: z.string(),
+      email: z.string().nullable(),
+    }),
+    account: z.object({
+      id: z.string(),
+      name: z.string(),
+    }),
+    tenant: z.object({
+      id: z.string().nullable(),
+      name: z.string().nullable(),
+    }),
+    tenant_unit: z.object({
+      id: z.string().nullable(),
+    }),
+    permissions: z.array(z.string()),
+    plan: z.object({
+      id: z.string(),
+      name: z.string(),
+      price: z.number(),
+      currency: z.string(),
+      frequency: z.string(),
+      is_subscribed: z.boolean(),
+      can_subscribe: z.boolean(),
+      legacy_id: z.string(),
+      legacy_discount: z.boolean(),
+      externally_managed: z.boolean(),
+    }),
+  }),
+  success: z.boolean(),
+  errors: z.array(z.unknown()),
+  messages: z.array(z.unknown()),
+})
+
+export async function createNewDomain(domain: string) {
+  return await api('/zones', {
+    method: 'POST',
+    body: {
+      name: domain,
+      jump_start: true,
+      type: 'full',
+    },
+  }).then(zone => zoneSchema.parse(zone))
+}

api/gandi.ts

@@ -0,0 +1,49 @@
+import { $fetch } from 'ofetch'
+import { z } from 'zod'
+
+const api = $fetch.create({
+  baseURL: 'https://api.gandi.net/v5/domain/domains',
+  headers: {
+    Authorization: `Apikey ${Bun.env.GANDI_API_KEY}`,
+  },
+})
+
+const domain = z.object({
+  fqdn: z.string(),
+  tld: z.string(),
+  status: z.array(z.string()),
+  dates: z.object({
+    created_at: z.string(),
+    registry_created_at: z.string(),
+    registry_ends_at: z.string(),
+    updated_at: z.string(),
+  }),
+  nameserver: z.object({
+    current: z.string(),
+  }),
+  autorenew: z.boolean(),
+  domain_owner: z.string(),
+  orga_owner: z.string(),
+  owner: z.string(),
+  id: z.string(),
+  tags: z.array(z.string()),
+  href: z.string(),
+  fqdn_unicode: z.string(),
+})
+
+export async function listDomains() {
+  return await api('/').then(domains => z.array(domain).parse(domains))
+}
+
+export async function setNameservers(domain: string, nameservers: string[]) {
+  return await api(`/${domain}/nameservers`, {
+    method: 'PUT',
+    body: {
+      nameservers,
+    },
+  })
+}
+
+export async function getNameservers(domain: string) {
+  return (await api(`/${domain}/nameservers`)) as string[]
+}

bun.lockb

@@ -0,0 +1,21 @@
+import { createNewDomain } from './api/cloudflare'
+import { getNameservers, listDomains, setNameservers } from './api/gandi'
+
+const domains = await listDomains()
+
+for (const domain of domains) {
+  console.log(`--- ${domain.fqdn} ---`)
+
+  if (domain.nameserver.current === 'other') {
+    const nameservers = await getNameservers(domain.fqdn)
+    if (nameservers.some(n => n.includes('cloudflare'))) {
+      continue
+    }
+  }
+
+  console.log('Creating new domain on Cloudflare')
+  const response = await createNewDomain(domain.fqdn)
+
+  console.log('Setting new nameservers')
+  await setNameservers(domain.fqdn, response.result.name_servers)
+}

index.ts

@@ -0,0 +1,15 @@
+{
+  "dependencies": {
+    "ofetch": "^1.1.0",
+    "zod": "^3.21.4"
+  },
+  "devDependencies": {
+    "bun-types": "^0.6.9"
+  },
+  "name": "domain-sync",
+  "module": "index.ts",
+  "type": "module",
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

package.json

@@ -0,0 +1,7 @@
+module.exports = {
+  semi: false,
+  singleQuote: true,
+  printWidth: 100,
+  trailingComma: 'es5',
+  arrowParens: 'avoid',
+}

prettier.config.cjs

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "lib": ["ESNext"],
+    "module": "esnext",
+    "target": "esnext",
+    "moduleResolution": "bundler",
+    "moduleDetection": "force",
+    "allowImportingTsExtensions": true,
+    "strict": true,
+    "downlevelIteration": true,
+    "skipLibCheck": true,
+    "jsx": "preserve",
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "allowJs": true,
+    "noEmit": true,
+    "types": [
+      "bun-types" // add Bun global
+    ]
+  }
+}