Merge pull request #4 from framer/add-publish

Introducing publish example

Author: elmarburke

.github/workflows/pull_request.yml

@@ -19,7 +19,9 @@ jobs:
       - name: Setup env files for type generation
         run: |
           for dir in examples/*/; do
-            [ -f "$dir/.env.example" ] && cp "$dir/.env.example" "$dir/.env"
+            if [ -f "$dir/.env.example" ]; then
+              cp "$dir/.env.example" "$dir/.env"
+            fi
           done
 
       - run: npm ci

examples/csv-importer/package.json

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

examples/json-api/package.json

@@ -9,7 +9,7 @@
     },
     "dependencies": {
         "@hono/node-server": "^1.14.1",
-        "framer-api": "^0.0.1-beta.0",
+        "framer-api": "^0.1.1",
         "hono": "^4.11.4",
         "typescript": "^5.9.3"
     },

examples/notion-automations-sync/package.json

@@ -14,7 +14,7 @@
     },
     "dependencies": {
         "@notionhq/client": "^5.6.0",
-        "framer-api": "beta"
+        "framer-api": "0.1.1"
     },
     "devDependencies": {
         "@types/node": "^24.10.0",

examples/publish/README.md

@@ -0,0 +1,42 @@
+# Publish
+
+Publishes and deploys a Framer project. Designed to run as a one-shot script, making it ideal for cron jobs, CI/CD pipelines, and systemd timers.
+
+## Usage
+
+```bash
+node --env-file=../../.env publish.ts
+
+bun --env-file=../../.env run publish.ts
+
+deno --env-file=../../.env run publish.ts
+```
+
+## Environment Variables
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `EXAMPLE_PROJECT_URL` | Yes | Your Framer project URL |
+
+## Scheduling Examples
+
+### Cron
+
+Publish every 4 hours:
+
+```bash
+# Edit crontab
+crontab -e
+
+# Add this line (adjust paths as needed)
+0 */4 * * * cd /path/to/examples/publish && node --env-file=../../.env publish.ts >> /var/log/framer-publish.log 2>&1
+```
+
+Common cron schedules:
+
+```bash
+0 */4 * * *     # Every 4 hours
+0 9-18/2 * * 1-5  # Every 2 hours between 9:00 and 18:00, mon-fri
+0 9 * * *       # Daily at 9:00
+0 9 * * 1-5     # Weekdays at 9:00
+```

examples/publish/package.json

@@ -0,0 +1,16 @@
+{
+    "name": "publish",
+    "version": "0.0.1",
+    "private": true,
+    "type": "module",
+    "scripts": {
+        "typecheck": "tsc --noEmit"
+    },
+    "dependencies": {
+        "framer-api": "^0.1.1",
+        "typescript": "^5.9.3"
+    },
+    "devDependencies": {
+        "@types/node": "^22.10.2"
+    }
+}

examples/publish/publish.ts

@@ -0,0 +1,40 @@
+import assert from "node:assert";
+import { connect } from "framer-api";
+
+const projectUrl = process.env["EXAMPLE_PROJECT_URL"];
+assert(projectUrl, "EXAMPLE_PROJECT_URL environment variable is required");
+
+using framer = await connect(projectUrl);
+
+// Show changes
+const changedPaths = await framer.getChangedPaths();
+const entries = Object.entries(changedPaths);
+const totalChanges = entries.reduce((sum, [, paths]) => sum + paths.length, 0);
+
+if (totalChanges === 0) {
+    console.log("⛔️ No changes to publish.");
+    process.exit(0);
+}
+
+console.log(`📄 ${totalChanges} change(s):`);
+for (const [type, paths] of entries) {
+    for (const path of paths) {
+        console.log(`   ${type}: ${path}`);
+    }
+}
+
+// Publish
+const { deployment } = await framer.publish();
+console.log(`🚀 Published deployment ${deployment.id}`);
+
+// Deploy to custom domains
+const deployed = await framer.deploy(deployment.id);
+
+if (deployed.length > 0) {
+    console.log(`✅ Deployed to ${deployed.length} custom domain(s):`);
+    for (const hostname of deployed) {
+        console.log(`   https://${hostname.hostname}`);
+    }
+} else {
+    console.log("No custom domains to deploy — default hostname is already live.");
+}

examples/publish/tsconfig.json

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