@get-enlace/express 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import express from 'express';
+import { type SpecSource } from './specLoader.js';
+export interface EnlaceOptions {
+    /** A file/URL path or an already-parsed object — the only input this needs is a valid OpenAPI 3.x document, however it's produced or served. */
+    spec: SpecSource;
+}
+/**
+ * Mounts the Enlace canvas.
+ *
+ *   app.use('/enlace', enlace({ spec }))
+ *
+ * This adapter's job is deliberately small — per ARCHITECTURE.md's MVP
+ * model, execution runs entirely client-side in @get-enlace/ui, so there's
+ * no `/api/run` or `/api/credentials` here at all. All this does is:
+ *   - serve the raw OpenAPI document (parsed into an Operation[] list
+ *     client-side, not here — see @get-enlace/ui's engine/specParser.ts)
+ *   - serve the built UI bundle
+ *
+ * This package is testing/dev scaffolding for this repo right now — it's
+ * destined for extraction into a separate `enlace-js` monorepo (alongside
+ * enlace-nest, enlace-fastify, etc.) once that split is real.
+ */
+export declare function enlace(options: EnlaceOptions): express.Router;

package/dist/index.js

@@ -0,0 +1,43 @@
+import express from 'express';
+import path from 'node:path';
+import { createRequire } from 'node:module';
+import { loadSpec } from './specLoader.js';
+const require = createRequire(import.meta.url);
+/**
+ * Mounts the Enlace canvas.
+ *
+ *   app.use('/enlace', enlace({ spec }))
+ *
+ * This adapter's job is deliberately small — per ARCHITECTURE.md's MVP
+ * model, execution runs entirely client-side in @get-enlace/ui, so there's
+ * no `/api/run` or `/api/credentials` here at all. All this does is:
+ *   - serve the raw OpenAPI document (parsed into an Operation[] list
+ *     client-side, not here — see @get-enlace/ui's engine/specParser.ts)
+ *   - serve the built UI bundle
+ *
+ * This package is testing/dev scaffolding for this repo right now — it's
+ * destined for extraction into a separate `enlace-js` monorepo (alongside
+ * enlace-nest, enlace-fastify, etc.) once that split is real.
+ */
+export function enlace(options) {
+    const router = express.Router();
+    // Read fresh on each request, not cached — matches the "not stored, read
+    // fresh each load" rule from ARCHITECTURE.md §4.
+    router.get('/api/spec', (_req, res) => {
+        res.json(loadSpec(options.spec));
+    });
+    // Static canvas UI bundle. Resolved via Node's own module resolution
+    // against the installed `@get-enlace/ui` package (a real dependency, see
+    // package.json) — not a relative path into this monorepo — so this works
+    // identically whether `@get-enlace/ui` got here via an npm workspace
+    // symlink (local dev) or a real `node_modules` install (anyone who
+    // installs @get-enlace/express on its own). There's nothing to copy or
+    // build into this package itself; the bundle lives wherever
+    // @get-enlace/ui's own "files" field ships it (dist/), and it must
+    // already be built (`npm run build --workspace @get-enlace/ui`) before
+    // this resolves.
+    const uiPackageJson = require.resolve('@get-enlace/ui/package.json');
+    const uiDist = path.join(path.dirname(uiPackageJson), 'dist');
+    router.use(express.static(uiDist));
+    return router;
+}

package/dist/specLoader.d.ts

@@ -0,0 +1,6 @@
+export type SpecSource = string | Record<string, any>;
+/**
+ * Reads an OpenAPI 3.x document from a file/URL path or accepts an already-
+ * parsed object directly.
+ */
+export declare function loadSpec(source: SpecSource): Record<string, any>;

package/dist/specLoader.js

@@ -0,0 +1,17 @@
+import { readFileSync } from 'node:fs';
+import { extname } from 'node:path';
+import yaml from 'js-yaml';
+/**
+ * Reads an OpenAPI 3.x document from a file/URL path or accepts an already-
+ * parsed object directly.
+ */
+export function loadSpec(source) {
+    if (typeof source !== 'string')
+        return source;
+    const raw = readFileSync(source, 'utf-8');
+    const ext = extname(source);
+    if (ext === '.yaml' || ext === '.yml') {
+        return yaml.load(raw);
+    }
+    return JSON.parse(raw);
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@get-enlace/express",
+  "private": false,
+  "version": "0.0.1",
+  "description": "Simple Express adapter for @get-enlace/ui. Early dev preview: no persistence yet (serves the spec + UI bundle only), install via the `dev` dist-tag on GitHub Packages.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/get-enlace/enlace-js.git",
+    "directory": "packages/enlace-express"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run"
+  },
+  "peerDependencies": {
+    "express": "^4.17.0 || ^5.0.0"
+  },
+  "dependencies": {
+    "@get-enlace/ui": "0.0.1",
+    "js-yaml": "^4.1.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^20.14.0",
+    "@types/supertest": "^7.2.1",
+    "express": "^4.19.2",
+    "supertest": "^7.2.2",
+    "typescript": "^5.5.4",
+    "vitest": "^4.1.11"
+  }
+}