framer-cms-markdown 0.0.1 → 0.0.3

package/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: CI
+
+on: pull_request
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+          scope: '@collaborne'
+      - run: npm ci --unsafe-perm
+      - run: npm run build
+      - run: npm test

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,26 @@
+name: Publish to NPM
+
+on:
+  push:
+    tags:
+      - '*'
+
+permissions:
+  id-token: write # Required for npmjs publish (OIDC)
+  contents: read
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+          scope: '@collaborne'
+      - run: npm ci --unsafe-perm
+      - run: npm run build
+      - run: npm test
+      # npmjs requires more recent npm version than Github Action runs by default
+      - run: npx -y npm@^11.5.1 publish

package/dist/src/framer-to-markdown/cli.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 import { runCli } from "./index";
 await runCli().catch((error) => {
     console.error(error instanceof Error ? error.message : error);

package/dist/src/framer-to-markdown/config.js

@@ -1 +1 @@
-export { loadConfig } from "../libs/framer/config";
+export { loadConfig, } from "../libs/framer/config";

package/dist/src/framer-to-markdown/export.js

@@ -115,7 +115,9 @@ export function renderMarkdownBody(item, bodyFieldName) {
             .concat(sectionFields.length > 0 ? "\n" : ""));
     }
     const bodyField = resolveBodyField(item, bodyFieldName);
-    return bodyField ? renderBodyContent(item.fieldData[bodyField]) : Promise.resolve("");
+    return bodyField
+        ? renderBodyContent(item.fieldData[bodyField])
+        : Promise.resolve("");
 }
 export async function exportItemsToMarkdown(items, options = {}) {
     const outputDir = options.outputDir ??

package/dist/src/framer-to-markdown/frontmatter.js

@@ -1 +1 @@
-export { parseFrontmatterDocument, toFrontmatter } from "../libs/framer/frontmatter";
+export { parseFrontmatterDocument, toFrontmatter, } from "../libs/framer/frontmatter";

package/dist/src/libs/framer/framer-client.js

@@ -54,9 +54,13 @@ export function createFieldDataEntryInput(field, value, options = {}) {
                 ? { type: field.type, value }
                 : undefined;
         case "number":
-            return typeof value === "number" ? { type: field.type, value } : undefined;
+            return typeof value === "number"
+                ? { type: field.type, value }
+                : undefined;
         case "string":
-            return typeof value === "string" ? { type: field.type, value } : undefined;
+            return typeof value === "string"
+                ? { type: field.type, value }
+                : undefined;
         case "formattedText":
             return typeof value === "string"
                 ? {
@@ -66,9 +70,13 @@ export function createFieldDataEntryInput(field, value, options = {}) {
                 }
                 : undefined;
         case "enum":
-            return typeof value === "string" ? { type: field.type, value } : undefined;
+            return typeof value === "string"
+                ? { type: field.type, value }
+                : undefined;
         case "link":
-            return typeof value === "string" ? { type: field.type, value } : undefined;
+            return typeof value === "string"
+                ? { type: field.type, value }
+                : undefined;
         case "date":
             return typeof value === "string" || typeof value === "number"
                 ? { type: field.type, value: value }

package/dist/src/markdown-to-framer/__tests__/import.spec.js

@@ -30,10 +30,7 @@ describe("markdown-to-framer import", () => {
             field("s02-title-id", "Section 02 Title", "string"),
             field("s01-title-id", "Section 01 Title", "string"),
         ];
-        expect(resolveSectionHtmlFields(fields).map((entry) => entry.name)).toEqual([
-            "Section 01 HTML",
-            "Section 02 HTML",
-        ]);
+        expect(resolveSectionHtmlFields(fields).map((entry) => entry.name)).toEqual(["Section 01 HTML", "Section 02 HTML"]);
         const item = await buildCollectionItemInput(document, fields, {
             markdown: "sections",
             metadata: ["Title", "Excerpt"],

package/dist/src/markdown-to-framer/__tests__/json-ld-faq.spec.js

@@ -0,0 +1,99 @@
+import { markdownFaqToJsonLd } from "../json-ld-faq";
+describe("markdownFaqToJsonLdScript", () => {
+    it("returns null when no FAQ section exists", () => {
+        const markdown = `
+# Introduction
+
+Some content.
+
+## Features
+
+More content.
+`;
+        expect(markdownFaqToJsonLd(markdown)).toBeNull();
+    });
+    it("converts a FAQ section into JSON-LD", () => {
+        const markdown = `
+# Article
+
+Some text.
+
+## FAQ
+
+### Question 1?
+
+Answer 1.
+
+### Question 2?
+
+Answer 2.
+`;
+        const json = markdownFaqToJsonLd(markdown);
+        expect(json).not.toBeNull();
+        expect(json).toEqual({
+            "@context": "https://schema.org",
+            "@type": "FAQPage",
+            mainEntity: [
+                {
+                    "@type": "Question",
+                    name: "Question 1?",
+                    acceptedAnswer: {
+                        "@type": "Answer",
+                        text: "Answer 1.",
+                    },
+                },
+                {
+                    "@type": "Question",
+                    name: "Question 2?",
+                    acceptedAnswer: {
+                        "@type": "Answer",
+                        text: "Answer 2.",
+                    },
+                },
+            ],
+        });
+    });
+    it("supports FAQ at any heading level", () => {
+        const markdown = `
+# Page
+
+### FAQ
+
+#### What is NEXT?
+
+A platform for customer intelligence.
+`;
+        const json = markdownFaqToJsonLd(markdown);
+        expect(json.mainEntity).toHaveLength(1);
+        expect(json.mainEntity[0].name).toBe("What is NEXT?");
+    });
+    it("stops parsing at the next sibling section", () => {
+        const markdown = `
+## FAQ
+
+### Question 1?
+
+Answer 1.
+
+## Pricing
+
+### Should not be included
+
+Answer 2.
+`;
+        const json = markdownFaqToJsonLd(markdown);
+        expect(json.mainEntity).toHaveLength(1);
+        expect(json.mainEntity[0].name).toBe("Question 1?");
+    });
+    it("normalizes markdown inside answers", () => {
+        const markdown = `
+## FAQ
+
+### What is it?
+
+This is **bold**, *italic*, and a [link](https://example.com).
+`;
+        const json = markdownFaqToJsonLd(markdown);
+        expect(json.mainEntity[0].acceptedAnswer.text).toBe("This is bold, italic, and a link.");
+    });
+});

package/dist/src/markdown-to-framer/cli.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 import { runCli } from "./index";
 await runCli().catch((error) => {
     console.error(error instanceof Error ? error.message : error);

package/dist/src/markdown-to-framer/import.js

@@ -1,9 +1,10 @@
 import fs from "node:fs/promises";
 import path from "node:path";
-import { createFieldDataEntryInput, } from "../libs/framer/framer-client";
 import { slugify } from "../libs/framer/filename";
-import { markdownToHtml, splitMarkdownIntoSections, } from "../libs/framer/markdown";
+import { createFieldDataEntryInput, } from "../libs/framer/framer-client";
 import { parseFrontmatterDocument } from "../libs/framer/frontmatter";
+import { markdownToHtml, splitMarkdownIntoSections, } from "../libs/framer/markdown";
+import { markdownFaqToJsonLd } from "./json-ld-faq";
 const SECTION_HTML_FIELD_PATTERN = /^Section\s+(\d+)\s+HTML$/i;
 const SECTION_TITLE_FIELD_PATTERN = /^Section\s+(\d+)\s+Title$/i;
 export async function listMarkdownFiles(rootDir) {
@@ -36,7 +37,8 @@ export async function readMarkdownDocuments(contentDir) {
 export function resolveSectionHtmlFields(fields) {
     return fields
         .filter((field) => {
-        return field.type === "formattedText" && SECTION_HTML_FIELD_PATTERN.test(field.name);
+        return (field.type === "formattedText" &&
+            SECTION_HTML_FIELD_PATTERN.test(field.name));
     })
         .sort((left, right) => {
         const leftOrder = Number.parseInt(left.name.match(SECTION_HTML_FIELD_PATTERN)?.[1] ?? "0", 10);
@@ -63,6 +65,14 @@ export function extractSectionTitle(markdown) {
 export async function buildFieldDataInput(document, fields, config) {
     const fieldByName = new Map(fields.map((field) => [field.name, field]));
     const fieldData = {};
+    const jsonLd = markdownFaqToJsonLd(document.body);
+    if (jsonLd) {
+        const field = fieldByName.get("JSON-LD");
+        fieldData[field.id] = {
+            type: "string",
+            value: JSON.stringify(jsonLd),
+        };
+    }
     for (const metadataFieldName of config.metadata) {
         const field = fieldByName.get(metadataFieldName);
         if (!field) {

package/dist/src/markdown-to-framer/index.js

@@ -4,7 +4,7 @@ import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 import { loadConfig } from "../libs/framer/config";
 import { FramerClient, } from "../libs/framer/framer-client";
-import { buildCollectionItemInput, readMarkdownDocuments, } from "./import";
+import { buildCollectionItemInput, readMarkdownDocuments } from "./import";
 export async function runCli(argv = hideBin(process.argv)) {
     const args = await yargs(argv)
         .scriptName("markdown-to-framer")

package/dist/src/markdown-to-framer/json-ld-faq.js

@@ -0,0 +1,96 @@
+function parseHeading(line) {
+    const match = /^(#{1,6})\s+(.+?)\s*#*\s*$/.exec(line);
+    if (!match) {
+        return null;
+    }
+    return {
+        level: match[1].length,
+        text: match[2].trim(),
+    };
+}
+function normalizeMarkdownText(markdown) {
+    return markdown
+        .replace(/\[([^\]]+)\]\([^)]+\)/g, "$1")
+        .replace(/[*_`>#-]/g, "")
+        .replace(/\s+/g, " ")
+        .trim();
+}
+function findFaqHeading(lines) {
+    for (let i = 0; i < lines.length; i++) {
+        const heading = parseHeading(lines[i]);
+        if (heading && heading.text.trim().toLowerCase() === "faq") {
+            return { index: i, level: heading.level };
+        }
+    }
+    return null;
+}
+function collectSection(lines, startIndex, parentLevel) {
+    const section = [];
+    for (let i = startIndex; i < lines.length; i++) {
+        const heading = parseHeading(lines[i]);
+        if (heading && heading.level <= parentLevel) {
+            break;
+        }
+        section.push(lines[i]);
+    }
+    return section;
+}
+function extractQuestions(lines, faqLevel) {
+    const items = [];
+    let currentQuestion = null;
+    let currentAnswerLines = [];
+    const flush = () => {
+        if (!currentQuestion) {
+            return;
+        }
+        const answer = normalizeMarkdownText(currentAnswerLines.join("\n"));
+        if (answer.length > 0) {
+            items.push({
+                question: currentQuestion,
+                answer,
+            });
+        }
+    };
+    for (const line of lines) {
+        const heading = parseHeading(line);
+        if (heading && heading.level > faqLevel) {
+            flush();
+            currentQuestion = heading.text;
+            currentAnswerLines = [];
+        }
+        else if (currentQuestion) {
+            currentAnswerLines.push(line);
+        }
+    }
+    flush();
+    return items;
+}
+function extractFaqItems(markdown) {
+    const lines = markdown.split(/\r?\n/);
+    const faqStart = findFaqHeading(lines);
+    if (!faqStart) {
+        return [];
+    }
+    const { index: faqIndex, level: faqLevel } = faqStart;
+    const faqLines = collectSection(lines, faqIndex + 1, faqLevel);
+    return extractQuestions(faqLines, faqLevel);
+}
+export function markdownFaqToJsonLd(markdown) {
+    const items = extractFaqItems(markdown);
+    if (items.length === 0) {
+        return null;
+    }
+    const jsonLd = {
+        "@context": "https://schema.org",
+        "@type": "FAQPage",
+        mainEntity: items.map((item) => ({
+            "@type": "Question",
+            name: item.question,
+            acceptedAnswer: {
+                "@type": "Answer",
+                text: item.answer,
+            },
+        })),
+    };
+    return jsonLd;
+}

package/package.json

@@ -1,17 +1,17 @@
 {
 	"name": "framer-cms-markdown",
-	"version": "0.0.1",
+	"version": "0.0.3",
 	"description": "Sync's Framer CMS content from/to markdown",
 	"type": "module",
 	"main": "dist/src/index.js",
 	"bin": {
-		"framer-to-markdown": "dist/src/framer-to-markdown/cli.js",
-		"markdown-to-framer": "dist/src/markdown-to-framer/cli.js"
+		"framer-to-markdown": "./dist/src/framer-to-markdown/cli.js",
+		"markdown-to-framer": "./dist/src/markdown-to-framer/cli.js"
 	},
 	"scripts": {
 		"build": "tsc -p tsconfig.json",
 		"lint": "eslint --fix \"**/*.ts\"",
-		"test": "npm run test:unit",
+		"test": "npm run lint && npm run test:unit",
 		"test:unit": "NODE_OPTIONS='--experimental-vm-modules --max_old_space_size=3072' jest --maxWorkers=50%",
 		"framer-to-markdown": "AWS_SDK_LOAD_CONFIG=1 tsx -r source-map-support/register src/framer-to-markdown/cli.ts",
 		"markdown-to-framer": "AWS_SDK_LOAD_CONFIG=1 tsx -r source-map-support/register src/markdown-to-framer/cli.ts"

package/src/markdown-to-framer/cli.ts

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 import { runCli } from "./index";
 
 await runCli().catch((error) => {

package/dist/src/__tests__/filename.spec.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const globals_1 = require("@jest/globals");
-const filename_1 = require("../filename");
-(0, globals_1.test)("slugify normalizes text", () => {
-    (0, globals_1.expect)((0, filename_1.slugify)("Hello, Framer CMS!")).toBe("hello-framer-cms");
-});
-(0, globals_1.test)("uniqueName adds suffixes", () => {
-    const existing = new Set(["post", "post-2"]);
-    (0, globals_1.expect)((0, filename_1.uniqueName)("post", existing)).toBe("post-3");
-});
-(0, globals_1.test)("resolveMarkdownFilename prefers slug", () => {
-    const existing = new Set();
-    (0, globals_1.expect)((0, filename_1.resolveMarkdownFilename)({ slug: "hello-world" }, existing)).toBe("hello-world.md");
-});

package/dist/src/__tests__/frontmatter.spec.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const globals_1 = require("@jest/globals");
-const frontmatter_1 = require("../frontmatter");
-(0, globals_1.test)("toFrontmatter serializes yaml frontmatter", () => {
-    const output = (0, frontmatter_1.toFrontmatter)({
-        title: "Hello",
-        tags: ["a", "b"],
-        published: true,
-    });
-    (0, globals_1.expect)(output).toMatch(/^---\n/);
-    (0, globals_1.expect)(output).toMatch(/title: Hello/);
-    (0, globals_1.expect)(output).toMatch(/tags:/);
-    (0, globals_1.expect)(output).toMatch(/published: true/);
-});

package/dist/src/__tests__/markdown.spec.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const globals_1 = require("@jest/globals");
-const markdown_1 = require("../markdown");
-(0, globals_1.test)("htmlToMarkdown converts simple html", () => {
-    const output = (0, markdown_1.htmlToMarkdown)("<h1>Hello</h1><p>World</p>");
-    (0, globals_1.expect)(output).toMatch(/^# Hello/);
-    (0, globals_1.expect)(output).toMatch(/World/);
-});

package/dist/src/cli.js

@@ -1,62 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.runCli = runCli;
-const node_path_1 = __importDefault(require("node:path"));
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const yargs = require("yargs");
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const { hideBin } = require("yargs/helpers");
-const export_1 = require("./export");
-const framer_client_1 = require("./framer-client");
-async function runCli(argv = hideBin(process.argv)) {
-    const args = await yargs(argv)
-        .scriptName("framer-to-markdown")
-        .usage("$0 --token <token> --site <site-id> --collection <collection-id>")
-        .option("token", {
-        type: "string",
-        demandOption: true,
-        describe: "Framer API token",
-    })
-        .option("site", {
-        type: "string",
-        demandOption: true,
-        describe: "Framer site/project identifier",
-    })
-        .option("collection", {
-        type: "string",
-        demandOption: true,
-        describe: "Framer CMS collection identifier",
-    })
-        .option("baseUrl", {
-        type: "string",
-        default: "https://api.framer.com",
-        describe: "Framer API base URL",
-    })
-        .strict()
-        .help()
-        .parse();
-    const cliArgs = args;
-    const client = new framer_client_1.FramerClient({
-        token: cliArgs.token,
-        baseUrl: cliArgs.baseUrl,
-    });
-    const collection = await client.resolveCollection(cliArgs.site, cliArgs.collection);
-    const items = await client.listCollectionItems(cliArgs.site, collection.id);
-    const outputDir = node_path_1.default.join(process.cwd(), "content", "framer");
-    const writtenFiles = await (0, export_1.exportItemsToMarkdown)(items, {
-        outputRoot: outputDir,
-        collectionName: collection.slug ?? collection.name ?? collection.id,
-    });
-    for (const file of writtenFiles) {
-        console.log(file);
-    }
-}
-if (require.main === module) {
-    runCli().catch((error) => {
-        console.error(error instanceof Error ? error.message : error);
-        process.exitCode = 1;
-    });
-}

package/dist/src/export.js

@@ -1,83 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.exportItemsToMarkdown = exportItemsToMarkdown;
-exports.resolveBodyField = resolveBodyField;
-exports.buildFrontmatter = buildFrontmatter;
-const promises_1 = __importDefault(require("node:fs/promises"));
-const node_path_1 = __importDefault(require("node:path"));
-const filename_1 = require("./filename");
-const frontmatter_1 = require("./frontmatter");
-const markdown_1 = require("./markdown");
-const BODY_FIELD_CANDIDATES = ["content", "body", "html", "richText", "rich_text"];
-async function exportItemsToMarkdown(items, options = {}) {
-    const outputRoot = options.outputRoot ?? node_path_1.default.join(process.cwd(), "content", "framer");
-    const collectionFolder = (0, filename_1.slugify)(options.collectionName ?? "collection");
-    const outputDir = node_path_1.default.join(outputRoot, collectionFolder);
-    await promises_1.default.mkdir(outputDir, { recursive: true });
-    const usedNames = new Set();
-    const writtenFiles = [];
-    for (const item of items) {
-        const filename = (0, filename_1.resolveMarkdownFilename)(item, usedNames);
-        const filepath = node_path_1.default.join(outputDir, filename);
-        const bodyField = resolveBodyField(item);
-        const frontmatter = buildFrontmatter(item, bodyField);
-        const markdownBody = bodyField ? (0, markdown_1.htmlToMarkdown)(stringValue(item[bodyField])) : "";
-        const fileContents = `${(0, frontmatter_1.toFrontmatter)(frontmatter)}${markdownBody}`;
-        await promises_1.default.writeFile(filepath, fileContents, "utf8");
-        writtenFiles.push(filepath);
-    }
-    return writtenFiles;
-}
-function resolveBodyField(item) {
-    for (const candidate of BODY_FIELD_CANDIDATES) {
-        if (typeof item[candidate] === "string" && stringValue(item[candidate]).trim().length > 0) {
-            return candidate;
-        }
-    }
-    for (const [key, value] of Object.entries(item)) {
-        if (typeof value === "string" && looksLikeHtml(value)) {
-            return key;
-        }
-    }
-    return undefined;
-}
-function buildFrontmatter(item, bodyField) {
-    const frontmatter = {};
-    for (const [key, value] of Object.entries(item)) {
-        if (key === bodyField) {
-            continue;
-        }
-        if (value === undefined || typeof value === "function" || typeof value === "symbol") {
-            continue;
-        }
-        frontmatter[key] = normalizeFrontmatterValue(value);
-    }
-    return frontmatter;
-}
-function normalizeFrontmatterValue(value) {
-    if (value instanceof Date) {
-        return value.toISOString();
-    }
-    if (Array.isArray(value)) {
-        return value.map(normalizeFrontmatterValue);
-    }
-    if (value && typeof value === "object") {
-        const record = {};
-        for (const [key, nestedValue] of Object.entries(value)) {
-            if (nestedValue !== undefined) {
-                record[key] = normalizeFrontmatterValue(nestedValue);
-            }
-        }
-        return record;
-    }
-    return value;
-}
-function stringValue(value) {
-    return typeof value === "string" ? value : "";
-}
-function looksLikeHtml(value) {
-    return /<\/?[a-z][\s\S]*>/i.test(value);
-}

package/dist/src/filename.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.slugify = slugify;
-exports.uniqueName = uniqueName;
-exports.resolveMarkdownFilename = resolveMarkdownFilename;
-function slugify(input) {
-    const normalized = input
-        .normalize("NFKD")
-        .replace(/[\u0300-\u036f]/g, "")
-        .toLowerCase()
-        .replace(/[^a-z0-9]+/g, "-")
-        .replace(/^-+|-+$/g, "")
-        .replace(/-{2,}/g, "-");
-    return normalized.length > 0 ? normalized : "item";
-}
-function uniqueName(baseName, existingNames) {
-    if (!existingNames.has(baseName)) {
-        return baseName;
-    }
-    let suffix = 2;
-    while (existingNames.has(`${baseName}-${suffix}`)) {
-        suffix += 1;
-    }
-    return `${baseName}-${suffix}`;
-}
-function resolveMarkdownFilename(item, existingNames = new Set()) {
-    const candidates = [item.slug, item.title, item.id != null ? String(item.id) : null];
-    for (const candidate of candidates) {
-        if (!candidate) {
-            continue;
-        }
-        const name = slugify(candidate);
-        if (name) {
-            const unique = uniqueName(name, existingNames);
-            existingNames.add(unique);
-            return `${unique}.md`;
-        }
-    }
-    const fallback = uniqueName("item", existingNames);
-    existingNames.add(fallback);
-    return `${fallback}.md`;
-}