refactor: Add "common" library for shared code (#12)

The `UpdateResponse` interface was previously duplicated between worker
and client. In future patches, additional pieces of similar code can be placed
into common, such as environment variable parsing.

client/Dockerfile

@@ -4,10 +4,12 @@ FROM node:20.18.1-alpine AS build
 WORKDIR /app
 
 COPY ./package*.json ./
+COPY ./common/package*.json ./common/
 COPY ./client/package*.json ./client/
 RUN npm ci
 
 COPY ./tsconfig.json ./
+COPY ./common ./common
 COPY ./client ./client
 RUN npm run build
 
@@ -17,9 +19,11 @@ WORKDIR /app
 RUN apk add --no-cache tini
 
 COPY ./package*.json ./
+COPY ./common/package*.json ./common/
 COPY ./client/package*.json ./client/
 RUN npm ci --omit=dev
 
+COPY --from=build /app/common/dist ./common/dist
 COPY --from=build /app/client/dist ./client/dist
 
 USER node

client/src/client.ts

@@ -1,14 +1,11 @@
+import type { UpdateResponse } from '@meyfa/ddns-common'
+
 export interface UpdateOptions {
   url: URL
   secret: string
   signal?: AbortSignal
 }
 
-export interface UpdateResponse {
-  ip: string
-  modified: boolean
-}
-
 export async function update(options: UpdateOptions): Promise<UpdateResponse> {
   const res = await fetch(options.url, {
     method: 'PUT',

common/package.json

@@ -0,0 +1,11 @@
+{
+  "private": true,
+  "name": "@meyfa/ddns-common",
+  "type": "module",
+  "main": "dist/main.js",
+  "types": "dist/main.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "lint": "tsc --noEmit"
+  }
+}

common/src/main.ts

@@ -0,0 +1,4 @@
+export interface UpdateResponse {
+  ip: string
+  modified: boolean
+}

common/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "sourceMap": true,
+    "declaration": true,
+    "noEmit": false
+  },
+  "include": [
+    "src"
+  ]
+}

package.json

@@ -2,11 +2,12 @@
   "private": true,
   "name": "@meyfa/ddns",
   "scripts": {
-    "lint": "npm run lint --workspaces",
-    "build": "npm run build --workspace=client",
-    "deploy": "npm run deploy --workspace=worker"
+    "lint": "npm run build --workspace=common && npm run lint --workspaces",
+    "build": "npm run build --workspace=common && npm run build --workspace=client",
+    "deploy": "npm run build --workspace=common && npm run deploy --workspace=worker"
   },
   "workspaces": [
+    "common",
     "client",
     "worker"
   ],

worker/src/main.ts

@@ -1,15 +1,12 @@
+import type { UpdateResponse } from '@meyfa/ddns-common'
+
 interface Env {
   DDNS_SECRET?: string
   CLOUDFLARE_API_TOKEN?: string
   CLOUDFLARE_ZONE_ID?: string
   CLOUDFLARE_RECORD_NAME?: string
 }
 
-interface UpdateResponse {
-  ip: string
-  modified: boolean
-}
-
 const API = new URL('https://api.cloudflare.com/client/v4/')
 const RATE_LIMIT_MS = 30_000