Merge pull request #3 from framer/example/http-server

Introducing JSON server example

Author: elmarburke

examples/csv-importer/package.json

@@ -7,7 +7,7 @@
         "typecheck": "tsc --noEmit"
     },
     "dependencies": {
-        "framer-api": "^0.0.1-alpha.6",
+        "framer-api": "^0.0.1-beta.0",
         "papaparse": "^5.5.3",
         "typescript": "^5.9.3"
     },

examples/json-api/README.md

@@ -0,0 +1,38 @@
+# JSON API
+
+A simple HTTP/JSON server that exposes Framer collections via REST endpoints using [Hono](https://hono.dev).
+
+## Usage
+
+```bash
+EXAMPLE_PROJECT_URL="https://framer.com/projects/..." npm run dev
+```
+
+The server runs on port 3000 by default.
+
+## Endpoints
+
+### List Collections
+
+```
+GET /collections
+```
+
+Returns all collections in the project.
+
+### List Items
+
+```
+GET /collections/:collectionId
+```
+
+Returns all items in a collection by ID.
+
+### Get Item
+
+```
+GET /collections/:collectionId/:itemId
+```
+
+Returns a single item with its field data.
+

examples/json-api/package.json

@@ -0,0 +1,19 @@
+{
+    "name": "json-api",
+    "version": "0.0.1",
+    "private": true,
+    "type": "module",
+    "scripts": {
+        "dev": "node --watch src/index.ts",
+        "typecheck": "tsc --noEmit"
+    },
+    "dependencies": {
+        "@hono/node-server": "^1.14.1",
+        "framer-api": "^0.0.1-beta.0",
+        "hono": "^4.7.10",
+        "typescript": "^5.9.3"
+    },
+    "devDependencies": {
+        "@types/node": "^22.10.2"
+    }
+}

examples/json-api/src/index.ts

@@ -0,0 +1,79 @@
+import assert from "node:assert";
+import { serve } from "@hono/node-server";
+import { connect, type Framer } from "framer-api";
+import { Hono } from "hono";
+
+const projectUrl = process.env["EXAMPLE_PROJECT_URL"];
+assert(projectUrl, "EXAMPLE_PROJECT_URL environment variable is required");
+
+interface Variables {
+    framer: Framer;
+}
+
+const app = new Hono<{ Variables: Variables }>();
+
+// Middleware to connect to Framer and set the framer client in the context.
+// Will not share the instance between requests
+app.use(async (c, next) => {
+    // The `using` keyword is used to ensure that the Framer client is closed after the block is executed.
+    // This will automatically end the connection when the request is complete
+    // See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/using
+    using framer = await connect(projectUrl);
+    c.set("framer", framer);
+    await next();
+});
+
+app.get("/collections", async (c) => {
+    const allCollections = await c.var.framer.getCollections();
+
+    const collections = allCollections.map((col) => ({
+        id: col.id,
+        name: col.name,
+    }));
+
+    return c.json({ collections });
+});
+
+app.get("/collections/:collectionId", async (c) => {
+    const collectionId = c.req.param("collectionId");
+    const allCollections = await c.var.framer.getCollections();
+    const collection = allCollections.find((col) => col.id === collectionId);
+
+    if (!collection) {
+        return c.json({ error: "Collection not found" }, 404);
+    }
+
+    const allItems = await collection.getItems();
+
+    const items = allItems.map((item) => ({
+        id: item.id,
+        slug: item.slug,
+    }));
+
+    return c.json({ items });
+});
+
+app.get("/collections/:collectionId/:itemId", async (c) => {
+    const collectionId = c.req.param("collectionId");
+    const itemId = c.req.param("itemId");
+    const allCollections = await c.var.framer.getCollections();
+    const collection = allCollections.find((col) => col.id === collectionId);
+
+    if (!collection) {
+        return c.json({ error: "Collection not found" }, 404);
+    }
+
+    const allItems = await collection.getItems();
+
+    const item = allItems.find((i) => i.id === itemId);
+
+    if (!item) {
+        return c.json({ error: "Item not found" }, 404);
+    }
+
+    return c.json(item);
+});
+
+serve(app, (info) => {
+    console.log(`Server running at http://localhost:${info.port}`);
+});

examples/json-api/tsconfig.json

@@ -0,0 +1,4 @@
+{
+    "extends": "../../tsconfig.base.json",
+    "include": ["**/*.ts"]
+}