@cmssy/remix 6.2.0

package/dist/index.cjs

@@ -0,0 +1,165 @@
+'use strict';
+
+var core = require('@cmssy/core');
+
+// src/loader.ts
+function createCmssyLoader(config) {
+  return async function cmssyLoader({
+    request
+  }) {
+    const url = new URL(request.url);
+    const isEdit = await core.isVerifiedEditUrl(url, config);
+    const siteLocales = await core.resolveSiteLocales(config);
+    const segments = url.pathname.split("/").filter(Boolean);
+    const fromPath = core.splitLocaleFromPath(segments, siteLocales);
+    const locale = request.headers.get(core.CMSSY_LOCALE_HEADER) ?? fromPath.locale;
+    const previewSecret = isEdit ? config.draftSecret : void 0;
+    const [page, layouts] = await Promise.all([
+      core.fetchPage(config, fromPath.path, { previewSecret }),
+      core.fetchLayouts(config, fromPath.path, { previewSecret })
+    ]);
+    return {
+      page,
+      layouts,
+      locale,
+      defaultLocale: siteLocales.defaultLocale,
+      enabledLocales: siteLocales.locales,
+      isEdit,
+      editorOrigin: config.editorOrigin ?? "*"
+    };
+  };
+}
+function createCmssyHeaders(config) {
+  return function cmssyHeaders() {
+    return core.cmssyCspHeaders({ editorOrigin: config.editorOrigin });
+  };
+}
+function xmlEscape(value) {
+  return value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+}
+function baseUrlFor(config, url, request) {
+  if (config.siteUrl) return config.siteUrl.replace(/\/+$/, "");
+  const host = request.headers.get("x-forwarded-host") ?? request.headers.get("host");
+  if (!host) return url.origin.replace(/\/+$/, "");
+  const protocol = request.headers.get("x-forwarded-proto") ?? (host.startsWith("localhost") || host.startsWith("127.0.0.1") ? "http" : "https");
+  return `${protocol}://${host}`.replace(/\/+$/, "");
+}
+function createCmssySitemap(config, options = {}) {
+  return async function loader({
+    request
+  }) {
+    const baseUrl = baseUrlFor(config, new URL(request.url), request);
+    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 loader({
+    request
+  }) {
+    const baseUrl = baseUrlFor(config, new URL(request.url), request);
+    const body = [
+      "User-agent: *",
+      "Allow: /",
+      `Sitemap: ${baseUrl}/sitemap.xml`,
+      ""
+    ].join("\n");
+    return new Response(body, { headers: { "content-type": "text/plain" } });
+  };
+}
+
+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, "isVerifiedEditUrl", {
+  enumerable: true,
+  get: function () { return core.isVerifiedEditUrl; }
+});
+Object.defineProperty(exports, "localizeHref", {
+  enumerable: true,
+  get: function () { return core.localizeHref; }
+});
+Object.defineProperty(exports, "localizedPath", {
+  enumerable: true,
+  get: function () { return core.localizedPath; }
+});
+Object.defineProperty(exports, "resolveSiteLocales", {
+  enumerable: true,
+  get: function () { return core.resolveSiteLocales; }
+});
+exports.createCmssyHeaders = createCmssyHeaders;
+exports.createCmssyLoader = createCmssyLoader;
+exports.createCmssyRobots = createCmssyRobots;
+exports.createCmssySitemap = createCmssySitemap;

package/dist/index.d.cts

@@ -0,0 +1,59 @@
+import { CmssyPageData, CmssyLayoutGroup, CmssyConfig } from '@cmssy/core';
+export { CMSSY_LOCALE_HEADER, CmssyBlockContext, CmssyConfig, CmssyEnvConfig, CmssyLayoutGroup, CmssyPageData, buildBlockContext, createCmssyClient, defineCmssyConfig, fetchLayouts, fetchPage, fetchPageMeta, fetchPages, fetchProduct, fetchProducts, isVerifiedEditUrl, localizeHref, localizedPath, resolveSiteLocales } from '@cmssy/core';
+
+interface CmssyRouteData {
+    page: CmssyPageData | null;
+    layouts: CmssyLayoutGroup[];
+    locale: string;
+    defaultLocale: string;
+    enabledLocales: string[];
+    /** True for a VERIFIED editor request. The route renders the edit bridge. */
+    isEdit: boolean;
+    editorOrigin: string | string[];
+}
+/**
+ * The page loader.
+ *
+ * Note what is NOT here: the `/cmssy-edit` route the Next adapter needs. That
+ * route exists because a Next page can be STATIC, and a static page never sees
+ * the query string that would put it in edit mode. React Router renders on every
+ * request, so the editor can be served from the page itself - verified the same
+ * way, on the same protocol, with less machinery.
+ */
+declare function createCmssyLoader(config: CmssyConfig): ({ request, }: {
+    request: Request;
+}) => Promise<CmssyRouteData>;
+/**
+ * The response headers a cmssy page needs: without them the admin cannot frame
+ * the site, and the editor shows an empty box with no error anywhere.
+ */
+declare function createCmssyHeaders(config: CmssyConfig): () => Record<string, string>;
+
+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): ({ request, }: {
+    request: Request;
+}) => Promise<Response>;
+declare function createCmssyRobots(config: CmssyConfig): ({ request, }: {
+    request: Request;
+}) => Promise<Response>;
+
+export { type CmssyRouteData, type CmssySitemapEntry, type CmssySitemapOptions, createCmssyHeaders, createCmssyLoader, createCmssyRobots, createCmssySitemap };

package/dist/index.d.ts

@@ -0,0 +1,59 @@
+import { CmssyPageData, CmssyLayoutGroup, CmssyConfig } from '@cmssy/core';
+export { CMSSY_LOCALE_HEADER, CmssyBlockContext, CmssyConfig, CmssyEnvConfig, CmssyLayoutGroup, CmssyPageData, buildBlockContext, createCmssyClient, defineCmssyConfig, fetchLayouts, fetchPage, fetchPageMeta, fetchPages, fetchProduct, fetchProducts, isVerifiedEditUrl, localizeHref, localizedPath, resolveSiteLocales } from '@cmssy/core';
+
+interface CmssyRouteData {
+    page: CmssyPageData | null;
+    layouts: CmssyLayoutGroup[];
+    locale: string;
+    defaultLocale: string;
+    enabledLocales: string[];
+    /** True for a VERIFIED editor request. The route renders the edit bridge. */
+    isEdit: boolean;
+    editorOrigin: string | string[];
+}
+/**
+ * The page loader.
+ *
+ * Note what is NOT here: the `/cmssy-edit` route the Next adapter needs. That
+ * route exists because a Next page can be STATIC, and a static page never sees
+ * the query string that would put it in edit mode. React Router renders on every
+ * request, so the editor can be served from the page itself - verified the same
+ * way, on the same protocol, with less machinery.
+ */
+declare function createCmssyLoader(config: CmssyConfig): ({ request, }: {
+    request: Request;
+}) => Promise<CmssyRouteData>;
+/**
+ * The response headers a cmssy page needs: without them the admin cannot frame
+ * the site, and the editor shows an empty box with no error anywhere.
+ */
+declare function createCmssyHeaders(config: CmssyConfig): () => Record<string, string>;
+
+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): ({ request, }: {
+    request: Request;
+}) => Promise<Response>;
+declare function createCmssyRobots(config: CmssyConfig): ({ request, }: {
+    request: Request;
+}) => Promise<Response>;
+
+export { type CmssyRouteData, type CmssySitemapEntry, type CmssySitemapOptions, createCmssyHeaders, createCmssyLoader, createCmssyRobots, createCmssySitemap };

package/dist/index.js

@@ -0,0 +1,105 @@
+import { isVerifiedEditUrl, resolveSiteLocales, splitLocaleFromPath, CMSSY_LOCALE_HEADER, fetchPage, fetchLayouts, cmssyCspHeaders, fetchPages, normalizeSlug, localizedPath } from '@cmssy/core';
+export { CMSSY_LOCALE_HEADER, buildBlockContext, createCmssyClient, defineCmssyConfig, fetchLayouts, fetchPage, fetchPageMeta, fetchPages, fetchProduct, fetchProducts, isVerifiedEditUrl, localizeHref, localizedPath, resolveSiteLocales } from '@cmssy/core';
+
+// src/loader.ts
+function createCmssyLoader(config) {
+  return async function cmssyLoader({
+    request
+  }) {
+    const url = new URL(request.url);
+    const isEdit = await isVerifiedEditUrl(url, config);
+    const siteLocales = await resolveSiteLocales(config);
+    const segments = url.pathname.split("/").filter(Boolean);
+    const fromPath = splitLocaleFromPath(segments, siteLocales);
+    const locale = request.headers.get(CMSSY_LOCALE_HEADER) ?? fromPath.locale;
+    const previewSecret = isEdit ? config.draftSecret : void 0;
+    const [page, layouts] = await Promise.all([
+      fetchPage(config, fromPath.path, { previewSecret }),
+      fetchLayouts(config, fromPath.path, { previewSecret })
+    ]);
+    return {
+      page,
+      layouts,
+      locale,
+      defaultLocale: siteLocales.defaultLocale,
+      enabledLocales: siteLocales.locales,
+      isEdit,
+      editorOrigin: config.editorOrigin ?? "*"
+    };
+  };
+}
+function createCmssyHeaders(config) {
+  return function cmssyHeaders() {
+    return cmssyCspHeaders({ editorOrigin: config.editorOrigin });
+  };
+}
+function xmlEscape(value) {
+  return value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+}
+function baseUrlFor(config, url, request) {
+  if (config.siteUrl) return config.siteUrl.replace(/\/+$/, "");
+  const host = request.headers.get("x-forwarded-host") ?? request.headers.get("host");
+  if (!host) return url.origin.replace(/\/+$/, "");
+  const protocol = request.headers.get("x-forwarded-proto") ?? (host.startsWith("localhost") || host.startsWith("127.0.0.1") ? "http" : "https");
+  return `${protocol}://${host}`.replace(/\/+$/, "");
+}
+function createCmssySitemap(config, options = {}) {
+  return async function loader({
+    request
+  }) {
+    const baseUrl = baseUrlFor(config, new URL(request.url), request);
+    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 loader({
+    request
+  }) {
+    const baseUrl = baseUrlFor(config, new URL(request.url), request);
+    const body = [
+      "User-agent: *",
+      "Allow: /",
+      `Sitemap: ${baseUrl}/sitemap.xml`,
+      ""
+    ].join("\n");
+    return new Response(body, { headers: { "content-type": "text/plain" } });
+  };
+}
+
+export { createCmssyHeaders, createCmssyLoader, createCmssyRobots, createCmssySitemap };

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/remix",
+  "version": "6.2.0",
+  "description": "React Router 7 bindings for cmssy headless sites: page loader, framing CSP, 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": {
+    "react-router": ">=7"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.0",
+    "vitest": "^2.1.0"
+  },
+  "dependencies": {
+    "@cmssy/core": "6.2.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}