Add sketch of typed api

modules/api-definition/.gitignore

@@ -0,0 +1,4 @@
+v8-compile-cache-*
+dist
+*.tsbuildinfo
+.*-audit.json

modules/api-definition/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@myrepo/api-definition",
+  "version": "0.0.0",
+  "scripts": {
+    "test": "vitest run --coverage",
+    "compile": "tsc --noEmit",
+    "test:watch": "vitest",
+    "changeset": "echo 'Please run `pnpm changeset` from the monorepo root'",
+    "prepublishOnly": "pnpm run build",
+    "build": "vite build"
+  },
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "@myrepo": "./src/index.ts",
+        "types": "./dist/api-definition/src/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/api-definition/src/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "dependencies": {
+    "@myrepo/sum": "workspace:^",
+    "@zodios/core": "^10.9.6",
+    "zod": "^3.24.3"
+  },
+  "files": [
+    "README.md",
+    "dist",
+    "src"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cefn/nextjs-typescript-monorepo.git",
+    "directory": "modules/api-definition"
+  },
+  "homepage": "https://github.com/cefn/nextjs-typescript-monorepo/tree/main/modules/api-definition/README.md",
+  "bugs": {
+    "url": "https://github.com/cefn/nextjs-typescript-monorepo/issues"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@vitest/coverage-v8": "^2.1.8",
+    "typescript": "^5.8.3",
+    "vite": "^6.0.6",
+    "vite-plugin-dts": "^4.4.0",
+    "vite-plugin-externalize-deps": "^0.8.0",
+    "vitest": "^2.1.8"
+  }
+}

modules/api-definition/src/api.ts

@@ -0,0 +1,60 @@
+import { makeApi } from "@zodios/core";
+import { z } from "zod";
+
+const DEFINITION_SCHEMA = z.object({
+  definition: z.string(),
+  synonyms: z.array(z.string()),
+  antonyms: z.array(z.string()),
+});
+
+const WORD_SCHEMA = z.object({
+  word: z.string(),
+  phonetic: z.string(),
+  meanings: z.object({
+    partOfSpeech: z.string(),
+    definitions: z.array(DEFINITION_SCHEMA),
+  }),
+  sourceUrls: z.array(z.string().url()),
+});
+
+export const DICTIONARY_DOWNSTREAM_RESPONSE_SCHEMA = z.array(WORD_SCHEMA);
+
+export type DictionaryDownstreamResponse = z.infer<
+  typeof DICTIONARY_DOWNSTREAM_RESPONSE_SCHEMA
+>;
+
+const DICTIONARY_BFF_SUCCESS_SCHEMA = z.object({
+  httpStatus: z.literal(200),
+  data: DICTIONARY_DOWNSTREAM_RESPONSE_SCHEMA,
+});
+
+const DICTIONARY_BFF_FAILURE_SCHEMA = z.object({
+  httpStatus: z.union([z.literal(400), z.literal(500), z.literal(503)]),
+  message: z.string(),
+});
+
+const DICTIONARY_BFF_RESPONSE_SCHEMA = z.union([
+  DICTIONARY_BFF_SUCCESS_SCHEMA,
+  DICTIONARY_BFF_FAILURE_SCHEMA,
+]);
+
+export type DictionaryBffResponse = z.infer<
+  typeof DICTIONARY_BFF_RESPONSE_SCHEMA
+>;
+
+export const API = makeApi([
+  {
+    method: "get",
+    path: "/dictionary/:query",
+    description: "Lookup a word",
+    parameters: [
+      {
+        name: "query",
+        type: "Path",
+        schema: z.string(),
+        description: "The word to look up",
+      },
+    ],
+    response: DICTIONARY_BFF_RESPONSE_SCHEMA,
+  },
+]);

modules/api-definition/src/client.ts

@@ -0,0 +1,7 @@
+import { Zodios } from "@zodios/core";
+
+import { API } from "./api.ts";
+
+export function createClient(endpoint: string) {
+  return new Zodios(endpoint, API);
+}

modules/api-definition/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./api.ts";
+export * from "./client.ts";

modules/api-definition/tsconfig.json

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

modules/api-definition/vite.config.ts

@@ -0,0 +1,39 @@
+import typescript from "@rollup/plugin-typescript";
+import path from "path";
+import dts from "vite-plugin-dts";
+import { externalizeDeps } from "vite-plugin-externalize-deps";
+import { defineConfig } from "vitest/config";
+
+import { coverage } from "./vite.coverage.ts";
+
+export default defineConfig({
+  resolve: {
+    conditions: ["@myrepo"],
+  },
+  build: {
+    rollupOptions: {
+      plugins: [
+        typescript({
+          project: "./tsconfig.json",
+          sourceMap: true,
+          declaration: true,
+          outDir: "dist",
+          module: "nodeNext",
+        }),
+      ],
+    },
+    sourcemap: "inline",
+    minify: false,
+    lib: {
+      entry: path.resolve(__dirname, "src/index.ts"),
+      fileName: "index",
+      formats: ["es", "cjs"],
+    },
+  },
+  plugins: [dts(), externalizeDeps()],
+  test: {
+    reporters: ["verbose"],
+    disableConsoleIntercept: true,
+    coverage,
+  },
+});

servers/express-with-dependencies/package.json

@@ -10,16 +10,19 @@
   "private": true,
   "type": "module",
   "dependencies": {
+    "@myrepo/api-definition": "workspace:^",
     "@myrepo/multiply": "workspace:^",
     "@myrepo/sum": "workspace:^",
+    "@zodios/core": "^10.9.6",
+    "@zodios/express": "^10.6.1",
     "express": "^4.21.2",
     "tsx": "^4.19.2"
   },
   "devDependencies": {
     "@types/express": "^5.0.0",
-    "wait-on": "^8.0.2",
     "typescript": "^5.8.3",
-    "vitest": "^2.1.8"
+    "vitest": "^2.1.8",
+    "wait-on": "^8.0.2"
   },
   "repository": {
     "type": "git",
@@ -30,4 +33,4 @@
   "bugs": {
     "url": "https://github.com/cefn/nextjs-typescript-monorepo/issues"
   }
-}
+}