@flock/wirespec 0.19.0-RC.3 → 0.19.0

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@flock/wirespec",
-  "version": "0.19.0-RC.3",
+  "version": "0.19.0",
   "main": "wirespec-src-plugin-npm.mjs",
   "types": "wirespec-src-plugin-npm.d.mts",
   "devDependencies": {
     "typescript": "5.9.3"
   },
-  "dependencies": {
-    "@js-joda/core": "3.2.0",
-    "format-util": "^1.0.5"
+  "dependencies": {},
+  "peerDependencies": {
+    "msw": "^2.0.0"
   },
-  "peerDependencies": {},
   "optionalDependencies": {},
   "bundledDependencies": [],
   "bin": {
-    "wirespec": "wirespec-bin.mjs"
+    "wirespec": "wirespec-bin.mjs",
+    "wirespec-lsp": "wirespec-lsp.mjs"
   },
   "description": "Simplify your API development workflows, accelerate implementation, and guarantee strict adherence to defined contract specifications",
   "exports": {
@@ -30,9 +30,14 @@
       "types": "./wirespec-serialization.d.ts",
       "default": "./wirespec-serialization.mjs"
     },
-    "./generator": {
-      "types": "./wirespec-generator.d.ts",
-      "default": "./wirespec-generator.mjs"
+    "./msw": {
+      "types": "./wirespec-msw.d.ts",
+      "default": "./wirespec-msw.mjs"
+    }
+  },
+  "peerDependenciesMeta": {
+    "msw": {
+      "optional": true
     }
   },
   "repository": {

package/wirespec-lsp.mjs

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+import { startLsp } from "./wirespec-src-plugin-npm.mjs";
+
+const args = process.argv.slice(2);
+const useNodeIpc = args.includes("--node-ipc");
+
+startLsp(useNodeIpc);

package/wirespec-msw.d.ts

@@ -0,0 +1,53 @@
+import type { RequestHandler } from 'msw'
+import type { Serialization } from './wirespec-serialization'
+
+// Mirrors the generated `Wirespec.RawRequest` / `RawResponse` so generated endpoint `api`
+// objects are assignable to WirespecMswEndpoint (the method union must match exactly).
+type Method = 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH' | 'TRACE'
+
+type RawRequest = {
+    method: Method
+    path: string[]
+    queries: Record<string, string>
+    headers: Record<string, string>
+    body?: string
+}
+
+type RawResponse = {
+    status: number
+    headers: Record<string, string>
+    body?: string
+}
+
+/**
+ * Structural mirror of the generated `Wirespec.Api<Req, Res>` type. The shipped module
+ * cannot import the consumer's per-project generated `Wirespec` namespace, so the shape
+ * is redeclared here; generated endpoint `api` objects are assignable to it.
+ */
+export type WirespecMswEndpoint<Req, Res> = {
+    method: string
+    path: string
+    server: (serialization: Serialization) => {
+        from: (request: RawRequest) => Req
+        to: (response: Res) => RawResponse
+    }
+}
+
+export type WirespecMswOptions = {
+    /** Host or path prefix prepended to the contract path, e.g. "https://api.example.com" or "/api". */
+    baseUrl?: string
+    /** Override the serialization used to (de)serialize requests/responses. */
+    serialization?: Serialization
+}
+
+/**
+ * Build a typed MSW request handler for a generated Wirespec endpoint.
+ *
+ * The generics are inferred from `api.server`, constraining `resolver` to the endpoint's
+ * own request/response types: returning a response from a different endpoint is a compile error.
+ */
+export declare function wirespec<Req, Res>(
+    api: WirespecMswEndpoint<Req, Res>,
+    resolver: (request: Req) => Res | Promise<Res>,
+    options?: WirespecMswOptions,
+): RequestHandler

package/wirespec-msw.mjs

@@ -0,0 +1,83 @@
+import { http, HttpResponse } from 'msw'
+import { wirespecSerialization } from './wirespec-serialization.mjs'
+
+const METHODS = {
+    GET: 'get',
+    PUT: 'put',
+    POST: 'post',
+    DELETE: 'delete',
+    PATCH: 'patch',
+    HEAD: 'head',
+    OPTIONS: 'options',
+}
+
+const PARAM = /^:(.+)$/
+const BRACE = /^\{(.+)\}$/
+
+const segments = (path) => path.replace(/^\/+/, '').split('/').filter((s) => s.length > 0)
+
+// Normalize a Wirespec contract path into an MSW matcher: `{id}` -> `:id`, single leading slash.
+const normalizePath = (path) => {
+    const colon = path.replace(/\{([^/}]+)\}/g, ':$1')
+    return colon.startsWith('/') ? colon : `/${colon}`
+}
+
+// Without a baseUrl, prefix the contract path with `*` so it matches on any origin
+// (a bare relative path is not matched against absolute request URLs in Node). With a
+// baseUrl, pin the origin/prefix instead.
+const matcher = (baseUrl, path) => {
+    const normalized = normalizePath(path)
+    return baseUrl ? `${baseUrl.replace(/\/+$/, '')}${normalized}` : `*${normalized}`
+}
+
+// Rebuild the positional RawRequest.path from the contract template, substituting MSW's
+// matched params for `:name`/`{name}` segments. Using the template (not the raw URL) keeps
+// path-param indices aligned with the contract even when a baseUrl prefix is present.
+const buildPath = (templatePath, params) =>
+    segments(templatePath).map((segment) => {
+        const match = segment.match(PARAM) ?? segment.match(BRACE)
+        if (!match) return segment
+        const value = params[match[1]]
+        return Array.isArray(value) ? value[0] : value
+    })
+
+const readBody = async (request) => {
+    if (request.method === 'GET' || request.method === 'HEAD') return undefined
+    const text = await request.text()
+    return text.length > 0 ? text : undefined
+}
+
+/**
+ * Build an MSW request handler for a generated Wirespec endpoint `api`.
+ *
+ * The resolver receives the deserialized, typed Wirespec request and must return one of
+ * that endpoint's responses; a response from a different endpoint is a compile error.
+ *
+ * Options:
+ *  - baseUrl: host or path prefix to prepend to the contract path (e.g. "https://api.example.com").
+ *  - serialization: override the (de)serializer (defaults to wirespecSerialization).
+ */
+export function wirespec(api, resolver, options = {}) {
+    const serialization = options.serialization ?? wirespecSerialization
+    const pattern = matcher(options.baseUrl, api.path)
+    const method = METHODS[String(api.method).toUpperCase()] ?? 'all'
+    const endpoint = api.server(serialization)
+
+    return http[method](pattern, async ({ request, params }) => {
+        const url = new URL(request.url)
+        const rawRequest = {
+            method: request.method,
+            path: buildPath(api.path, params),
+            queries: Object.fromEntries(url.searchParams),
+            headers: Object.fromEntries(request.headers),
+            body: await readBody(request),
+        }
+        const typedRequest = endpoint.from(rawRequest)
+        const response = await resolver(typedRequest)
+        const rawResponse = endpoint.to(response)
+        return new HttpResponse(rawResponse.body ?? null, {
+            status: rawResponse.status,
+            headers: rawResponse.headers,
+        })
+    })
+}