@cmssy/astro 5.1.0

package/dist/index.cjs

@@ -0,0 +1,170 @@
+'use strict';
+
+var core = require('@cmssy/core');
+
+// src/middleware.ts
+var CMSSY_EDIT_PATH_PREFIX = "/cmssy-edit";
+function cmssyMiddleware(config, options = {}) {
+  return async function onRequest(context, next) {
+    const { pathname } = context.url;
+    context.request.headers.delete(core.CMSSY_EDIT_HEADER);
+    context.request.headers.delete(core.CMSSY_LOCALE_HEADER);
+    const locale = await core.localeForPathname(config, pathname);
+    context.request.headers.set(core.CMSSY_LOCALE_HEADER, locale);
+    if (!pathname.startsWith(CMSSY_EDIT_PATH_PREFIX) && await core.isVerifiedEditUrl(context.url, config)) {
+      context.request.headers.set(core.CMSSY_EDIT_HEADER, "1");
+      const target = `${CMSSY_EDIT_PATH_PREFIX}${pathname === "/" ? "" : pathname}${context.url.search}`;
+      const response = await context.rewrite(target);
+      core.applyCmssyCsp(response, { editorOrigin: config.editorOrigin });
+      return response;
+    }
+    if (options.stripLocalePrefix && pathname.startsWith(`/${locale}`)) {
+      const { defaultLocale } = await core.resolveSiteLocales(config);
+      if (locale !== defaultLocale) {
+        const stripped = pathname.slice(locale.length + 1) || "/";
+        return context.rewrite(`${stripped}${context.url.search}`);
+      }
+    }
+    return next();
+  };
+}
+async function loadCmssyPage(config, request, url) {
+  const isEdit = request.headers.get(core.CMSSY_EDIT_HEADER) === "1";
+  const siteLocales = await core.resolveSiteLocales(config);
+  const segments = url.pathname.replace(/^\/cmssy-edit/, "").split("/").filter(Boolean);
+  const fromPath = core.splitLocaleFromPath(segments, siteLocales);
+  const locale = request.headers.get(core.CMSSY_LOCALE_HEADER) ?? fromPath.locale;
+  const path = fromPath.path;
+  const previewSecret = isEdit ? config.draftSecret : void 0;
+  const [page, layouts] = await Promise.all([
+    core.fetchPage(config, path, { previewSecret }),
+    core.fetchLayouts(config, path, { previewSecret })
+  ]);
+  return {
+    page,
+    layouts,
+    locale,
+    defaultLocale: siteLocales.defaultLocale,
+    enabledLocales: siteLocales.locales,
+    isEdit
+  };
+}
+function xmlEscape(value) {
+  return value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+}
+async function baseUrlFor(config, url) {
+  return (config.siteUrl ?? url.origin).replace(/\/+$/, "");
+}
+function createCmssySitemap(config, options = {}) {
+  return async function GET({ url }) {
+    const baseUrl = await baseUrlFor(config, url);
+    const { defaultLocale, locales } = await core.resolveSiteLocales(config);
+    const pages = await core.fetchPages(config);
+    const entries = [];
+    for (const page of pages) {
+      const slug = core.normalizeSlug(page.slug);
+      for (const locale of locales) {
+        entries.push({
+          url: `${baseUrl}${core.localizedPath(slug, locale, defaultLocale)}`,
+          lastModified: page.updatedAt ?? void 0
+        });
+      }
+    }
+    if (options.extra) {
+      entries.push(
+        ...await options.extra({
+          baseUrl,
+          defaultLocale,
+          locales
+        })
+      );
+    }
+    const body = [
+      '<?xml version="1.0" encoding="UTF-8"?>',
+      '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">',
+      ...entries.map(
+        (entry) => [
+          "  <url>",
+          `    <loc>${xmlEscape(entry.url)}</loc>`,
+          entry.lastModified ? `    <lastmod>${xmlEscape(entry.lastModified)}</lastmod>` : "",
+          "  </url>"
+        ].filter(Boolean).join("\n")
+      ),
+      "</urlset>"
+    ].join("\n");
+    return new Response(body, {
+      headers: { "content-type": "application/xml" }
+    });
+  };
+}
+function createCmssyRobots(config) {
+  return async function GET({ url }) {
+    const baseUrl = await baseUrlFor(config, url);
+    const body = [
+      "User-agent: *",
+      "Allow: /",
+      "Disallow: /cmssy-edit",
+      `Sitemap: ${baseUrl}/sitemap.xml`,
+      ""
+    ].join("\n");
+    return new Response(body, { headers: { "content-type": "text/plain" } });
+  };
+}
+
+Object.defineProperty(exports, "CMSSY_EDIT_HEADER", {
+  enumerable: true,
+  get: function () { return core.CMSSY_EDIT_HEADER; }
+});
+Object.defineProperty(exports, "CMSSY_LOCALE_HEADER", {
+  enumerable: true,
+  get: function () { return core.CMSSY_LOCALE_HEADER; }
+});
+Object.defineProperty(exports, "buildBlockContext", {
+  enumerable: true,
+  get: function () { return core.buildBlockContext; }
+});
+Object.defineProperty(exports, "createCmssyClient", {
+  enumerable: true,
+  get: function () { return core.createCmssyClient; }
+});
+Object.defineProperty(exports, "defineCmssyConfig", {
+  enumerable: true,
+  get: function () { return core.defineCmssyConfig; }
+});
+Object.defineProperty(exports, "fetchLayouts", {
+  enumerable: true,
+  get: function () { return core.fetchLayouts; }
+});
+Object.defineProperty(exports, "fetchPage", {
+  enumerable: true,
+  get: function () { return core.fetchPage; }
+});
+Object.defineProperty(exports, "fetchPageMeta", {
+  enumerable: true,
+  get: function () { return core.fetchPageMeta; }
+});
+Object.defineProperty(exports, "fetchPages", {
+  enumerable: true,
+  get: function () { return core.fetchPages; }
+});
+Object.defineProperty(exports, "fetchProduct", {
+  enumerable: true,
+  get: function () { return core.fetchProduct; }
+});
+Object.defineProperty(exports, "fetchProducts", {
+  enumerable: true,
+  get: function () { return core.fetchProducts; }
+});
+Object.defineProperty(exports, "localizeHref", {
+  enumerable: true,
+  get: function () { return core.localizeHref; }
+});
+Object.defineProperty(exports, "resolveSiteLocales", {
+  enumerable: true,
+  get: function () { return core.resolveSiteLocales; }
+});
+exports.CMSSY_EDIT_PATH_PREFIX = CMSSY_EDIT_PATH_PREFIX;
+exports.cmssyMiddleware = cmssyMiddleware;
+exports.createCmssyRobots = createCmssyRobots;
+exports.createCmssySitemap = createCmssySitemap;
+exports.loadCmssyPage = loadCmssyPage;

package/dist/index.d.cts

@@ -0,0 +1,80 @@
+import { CmssyConfig, CmssyPageData, CmssyLayoutGroup } from '@cmssy/core';
+export { CMSSY_EDIT_HEADER, CMSSY_LOCALE_HEADER, CmssyBlockContext, CmssyConfig, CmssyEnvConfig, CmssyLayoutGroup, CmssyPageData, buildBlockContext, createCmssyClient, defineCmssyConfig, fetchLayouts, fetchPage, fetchPageMeta, fetchPages, fetchProduct, fetchProducts, localizeHref, resolveSiteLocales } from '@cmssy/core';
+
+declare const CMSSY_EDIT_PATH_PREFIX = "/cmssy-edit";
+interface CmssyMiddlewareOptions {
+    /**
+     * Strip the language prefix before the app sees it, so a static route like
+     * `/shop` serves `/no/shop` too. Leave it off for a catch-all app that reads
+     * the language off the path itself.
+     */
+    stripLocalePrefix?: boolean;
+}
+interface AstroContextLike {
+    url: URL;
+    request: Request;
+    rewrite: (path: string) => Promise<Response> | Response;
+}
+/**
+ * The whole middleware a cmssy Astro app needs, in the order it has to happen:
+ *
+ *   1. resolve the language and pass it on;
+ *   2. send a VERIFIED editor request to /cmssy-edit, carrying that language and
+ *      the edit flag - a prerendered page never sees the query string that would
+ *      put it in edit mode;
+ *   3. strip the language prefix for everything else, if asked.
+ *
+ * The order is not a detail. Resolve the locale after the rewrite and the editor
+ * preview renders in the wrong language; drop the edit flag and the header and
+ * footer become markup the editor can select but not fill. Both mistakes shipped
+ * in the Next app before this sequence existed - Astro gets it right the first
+ * time by reusing it.
+ */
+declare function cmssyMiddleware(config: CmssyConfig, options?: CmssyMiddlewareOptions): (context: AstroContextLike, next: () => Promise<Response>) => Promise<Response>;
+
+interface CmssyPageResult {
+    page: CmssyPageData | null;
+    layouts: CmssyLayoutGroup[];
+    locale: string;
+    defaultLocale: string;
+    enabledLocales: string[];
+    /** True for a verified editor request. The edit route renders the bridge. */
+    isEdit: boolean;
+}
+/**
+ * Everything a cmssy page needs, from a plain Request. No framework globals: the
+ * locale comes from the header the middleware set (falling back to the path, so
+ * a prerendered page still knows its language), and the editor flag comes from
+ * the same signal the Next adapter uses - because it is the same protocol, not
+ * a Next protocol.
+ */
+declare function loadCmssyPage(config: CmssyConfig, request: Request, url: URL): Promise<CmssyPageResult>;
+
+interface CmssySitemapEntry {
+    url: string;
+    lastModified?: string;
+}
+interface CmssySitemapOptions {
+    /**
+     * Records are not pages, so the sitemap cannot know about your products or
+     * categories. Add them here; you get the same base URL and locales the page
+     * entries use, so the two cannot disagree.
+     */
+    extra?: (context: {
+        baseUrl: string;
+        defaultLocale: string;
+        locales: string[];
+    }) => Promise<CmssySitemapEntry[]> | CmssySitemapEntry[];
+}
+/**
+ * One `<url>` per language, plus x-default - a translated page is not a
+ * duplicate, and telling Google it is keeps the translation out of the index.
+ */
+declare function createCmssySitemap(config: CmssyConfig, options?: CmssySitemapOptions): ({ url }: {
+    url: URL;
+}) => Promise<Response>;
+declare function createCmssyRobots(config: CmssyConfig): ({ url }: {
+    url: URL;
+}) => Promise<Response>;
+
+export { CMSSY_EDIT_PATH_PREFIX, type CmssyMiddlewareOptions, type CmssyPageResult, type CmssySitemapEntry, type CmssySitemapOptions, cmssyMiddleware, createCmssyRobots, createCmssySitemap, loadCmssyPage };

package/dist/index.d.ts

@@ -0,0 +1,80 @@
+import { CmssyConfig, CmssyPageData, CmssyLayoutGroup } from '@cmssy/core';
+export { CMSSY_EDIT_HEADER, CMSSY_LOCALE_HEADER, CmssyBlockContext, CmssyConfig, CmssyEnvConfig, CmssyLayoutGroup, CmssyPageData, buildBlockContext, createCmssyClient, defineCmssyConfig, fetchLayouts, fetchPage, fetchPageMeta, fetchPages, fetchProduct, fetchProducts, localizeHref, resolveSiteLocales } from '@cmssy/core';
+
+declare const CMSSY_EDIT_PATH_PREFIX = "/cmssy-edit";
+interface CmssyMiddlewareOptions {
+    /**
+     * Strip the language prefix before the app sees it, so a static route like
+     * `/shop` serves `/no/shop` too. Leave it off for a catch-all app that reads
+     * the language off the path itself.
+     */
+    stripLocalePrefix?: boolean;
+}
+interface AstroContextLike {
+    url: URL;
+    request: Request;
+    rewrite: (path: string) => Promise<Response> | Response;
+}
+/**
+ * The whole middleware a cmssy Astro app needs, in the order it has to happen:
+ *
+ *   1. resolve the language and pass it on;
+ *   2. send a VERIFIED editor request to /cmssy-edit, carrying that language and
+ *      the edit flag - a prerendered page never sees the query string that would
+ *      put it in edit mode;
+ *   3. strip the language prefix for everything else, if asked.
+ *
+ * The order is not a detail. Resolve the locale after the rewrite and the editor
+ * preview renders in the wrong language; drop the edit flag and the header and
+ * footer become markup the editor can select but not fill. Both mistakes shipped
+ * in the Next app before this sequence existed - Astro gets it right the first
+ * time by reusing it.
+ */
+declare function cmssyMiddleware(config: CmssyConfig, options?: CmssyMiddlewareOptions): (context: AstroContextLike, next: () => Promise<Response>) => Promise<Response>;
+
+interface CmssyPageResult {
+    page: CmssyPageData | null;
+    layouts: CmssyLayoutGroup[];
+    locale: string;
+    defaultLocale: string;
+    enabledLocales: string[];
+    /** True for a verified editor request. The edit route renders the bridge. */
+    isEdit: boolean;
+}
+/**
+ * Everything a cmssy page needs, from a plain Request. No framework globals: the
+ * locale comes from the header the middleware set (falling back to the path, so
+ * a prerendered page still knows its language), and the editor flag comes from
+ * the same signal the Next adapter uses - because it is the same protocol, not
+ * a Next protocol.
+ */
+declare function loadCmssyPage(config: CmssyConfig, request: Request, url: URL): Promise<CmssyPageResult>;
+
+interface CmssySitemapEntry {
+    url: string;
+    lastModified?: string;
+}
+interface CmssySitemapOptions {
+    /**
+     * Records are not pages, so the sitemap cannot know about your products or
+     * categories. Add them here; you get the same base URL and locales the page
+     * entries use, so the two cannot disagree.
+     */
+    extra?: (context: {
+        baseUrl: string;
+        defaultLocale: string;
+        locales: string[];
+    }) => Promise<CmssySitemapEntry[]> | CmssySitemapEntry[];
+}
+/**
+ * One `<url>` per language, plus x-default - a translated page is not a
+ * duplicate, and telling Google it is keeps the translation out of the index.
+ */
+declare function createCmssySitemap(config: CmssyConfig, options?: CmssySitemapOptions): ({ url }: {
+    url: URL;
+}) => Promise<Response>;
+declare function createCmssyRobots(config: CmssyConfig): ({ url }: {
+    url: URL;
+}) => Promise<Response>;
+
+export { CMSSY_EDIT_PATH_PREFIX, type CmssyMiddlewareOptions, type CmssyPageResult, type CmssySitemapEntry, type CmssySitemapOptions, cmssyMiddleware, createCmssyRobots, createCmssySitemap, loadCmssyPage };

package/dist/index.js

@@ -0,0 +1,113 @@
+import { CMSSY_EDIT_HEADER, CMSSY_LOCALE_HEADER, localeForPathname, isVerifiedEditUrl, applyCmssyCsp, resolveSiteLocales, splitLocaleFromPath, fetchPage, fetchLayouts, fetchPages, normalizeSlug, localizedPath } from '@cmssy/core';
+export { CMSSY_EDIT_HEADER, CMSSY_LOCALE_HEADER, buildBlockContext, createCmssyClient, defineCmssyConfig, fetchLayouts, fetchPage, fetchPageMeta, fetchPages, fetchProduct, fetchProducts, localizeHref, resolveSiteLocales } from '@cmssy/core';
+
+// src/middleware.ts
+var CMSSY_EDIT_PATH_PREFIX = "/cmssy-edit";
+function cmssyMiddleware(config, options = {}) {
+  return async function onRequest(context, next) {
+    const { pathname } = context.url;
+    context.request.headers.delete(CMSSY_EDIT_HEADER);
+    context.request.headers.delete(CMSSY_LOCALE_HEADER);
+    const locale = await localeForPathname(config, pathname);
+    context.request.headers.set(CMSSY_LOCALE_HEADER, locale);
+    if (!pathname.startsWith(CMSSY_EDIT_PATH_PREFIX) && await isVerifiedEditUrl(context.url, config)) {
+      context.request.headers.set(CMSSY_EDIT_HEADER, "1");
+      const target = `${CMSSY_EDIT_PATH_PREFIX}${pathname === "/" ? "" : pathname}${context.url.search}`;
+      const response = await context.rewrite(target);
+      applyCmssyCsp(response, { editorOrigin: config.editorOrigin });
+      return response;
+    }
+    if (options.stripLocalePrefix && pathname.startsWith(`/${locale}`)) {
+      const { defaultLocale } = await resolveSiteLocales(config);
+      if (locale !== defaultLocale) {
+        const stripped = pathname.slice(locale.length + 1) || "/";
+        return context.rewrite(`${stripped}${context.url.search}`);
+      }
+    }
+    return next();
+  };
+}
+async function loadCmssyPage(config, request, url) {
+  const isEdit = request.headers.get(CMSSY_EDIT_HEADER) === "1";
+  const siteLocales = await resolveSiteLocales(config);
+  const segments = url.pathname.replace(/^\/cmssy-edit/, "").split("/").filter(Boolean);
+  const fromPath = splitLocaleFromPath(segments, siteLocales);
+  const locale = request.headers.get(CMSSY_LOCALE_HEADER) ?? fromPath.locale;
+  const path = fromPath.path;
+  const previewSecret = isEdit ? config.draftSecret : void 0;
+  const [page, layouts] = await Promise.all([
+    fetchPage(config, path, { previewSecret }),
+    fetchLayouts(config, path, { previewSecret })
+  ]);
+  return {
+    page,
+    layouts,
+    locale,
+    defaultLocale: siteLocales.defaultLocale,
+    enabledLocales: siteLocales.locales,
+    isEdit
+  };
+}
+function xmlEscape(value) {
+  return value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+}
+async function baseUrlFor(config, url) {
+  return (config.siteUrl ?? url.origin).replace(/\/+$/, "");
+}
+function createCmssySitemap(config, options = {}) {
+  return async function GET({ url }) {
+    const baseUrl = await baseUrlFor(config, url);
+    const { defaultLocale, locales } = await resolveSiteLocales(config);
+    const pages = await fetchPages(config);
+    const entries = [];
+    for (const page of pages) {
+      const slug = normalizeSlug(page.slug);
+      for (const locale of locales) {
+        entries.push({
+          url: `${baseUrl}${localizedPath(slug, locale, defaultLocale)}`,
+          lastModified: page.updatedAt ?? void 0
+        });
+      }
+    }
+    if (options.extra) {
+      entries.push(
+        ...await options.extra({
+          baseUrl,
+          defaultLocale,
+          locales
+        })
+      );
+    }
+    const body = [
+      '<?xml version="1.0" encoding="UTF-8"?>',
+      '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">',
+      ...entries.map(
+        (entry) => [
+          "  <url>",
+          `    <loc>${xmlEscape(entry.url)}</loc>`,
+          entry.lastModified ? `    <lastmod>${xmlEscape(entry.lastModified)}</lastmod>` : "",
+          "  </url>"
+        ].filter(Boolean).join("\n")
+      ),
+      "</urlset>"
+    ].join("\n");
+    return new Response(body, {
+      headers: { "content-type": "application/xml" }
+    });
+  };
+}
+function createCmssyRobots(config) {
+  return async function GET({ url }) {
+    const baseUrl = await baseUrlFor(config, url);
+    const body = [
+      "User-agent: *",
+      "Allow: /",
+      "Disallow: /cmssy-edit",
+      `Sitemap: ${baseUrl}/sitemap.xml`,
+      ""
+    ].join("\n");
+    return new Response(body, { headers: { "content-type": "text/plain" } });
+  };
+}
+
+export { CMSSY_EDIT_PATH_PREFIX, cmssyMiddleware, createCmssyRobots, createCmssySitemap, loadCmssyPage };

package/dist/testing.cjs

@@ -0,0 +1,10 @@
+'use strict';
+
+var testing = require('@cmssy/core/testing');
+
+
+
+Object.defineProperty(exports, "checkCmssyEditMode", {
+  enumerable: true,
+  get: function () { return testing.checkCmssyEditMode; }
+});

package/dist/testing.d.cts

@@ -0,0 +1 @@
+export { EditSmokeOptions, EditSmokeResult, checkCmssyEditMode } from '@cmssy/core/testing';

package/dist/testing.d.ts

@@ -0,0 +1 @@
+export { EditSmokeOptions, EditSmokeResult, checkCmssyEditMode } from '@cmssy/core/testing';

package/dist/testing.js

@@ -0,0 +1 @@
+export { checkCmssyEditMode } from '@cmssy/core/testing';

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@cmssy/astro",
+  "version": "5.1.0",
+  "description": "Astro bindings for cmssy headless sites: middleware, page loader, sitemap and robots.",
+  "keywords": [
+    "cmssy",
+    "cms",
+    "headless",
+    "astro"
+  ],
+  "homepage": "https://cmssy.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cmssy-io/cmssy-sdk.git",
+    "directory": "packages/astro"
+  },
+  "type": "module",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./testing": {
+      "types": "./dist/testing.d.ts",
+      "import": "./dist/testing.js",
+      "require": "./dist/testing.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "astro": ">=4"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.0",
+    "vitest": "^2.1.0"
+  },
+  "dependencies": {
+    "@cmssy/core": "5.1.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}