@byscott-io/pagelet 0.0.0-stage → 0.2.0

package/dist/editor.js

@@ -0,0 +1,57 @@
+import { jsx } from 'react/jsx-runtime';
+import { Puck } from '@puckeditor/core';
+import { migrate } from '@puckeditor/core/rsc';
+
+const DOCUMENT_VERSION = 1;
+function emptyData() {
+  return { root: { props: {} }, content: [] };
+}
+function createDocument(data = emptyData()) {
+  return { pagelet: DOCUMENT_VERSION, data };
+}
+function upgradeDocument(document, palette) {
+  if (document == null) return createDocument();
+  if (typeof document !== "object") {
+    throw new TypeError("pagelet: a page document must be an object");
+  }
+  let doc = document;
+  if (!("pagelet" in doc)) {
+    if (!("content" in doc) && !("root" in doc)) {
+      throw new TypeError('pagelet: not a page document (no "pagelet" version and no Puck data)');
+    }
+    doc = createDocument(doc);
+  }
+  if (doc.pagelet > DOCUMENT_VERSION) {
+    throw new Error(
+      `pagelet: this page was saved by a newer pagelet (format ${doc.pagelet}); this version reads up to format ${DOCUMENT_VERSION}. Upgrade @byscott-io/pagelet.`
+    );
+  }
+  const data = { ...emptyData(), ...doc.data };
+  return createDocument(palette && needsPuckMigration(data) ? migrate(data, palette.config) : data);
+}
+function needsPuckMigration(data) {
+  const zones = data.zones ?? {};
+  if (Object.values(zones).some((content) => Array.isArray(content) && content.length > 0)) return true;
+  const root = data.root ?? {};
+  return Object.keys(root).some((key) => key !== "props" && key !== "readOnly");
+}
+
+function PageletEditor({ document, palette, theme, onPublish, onChange, headerTitle, ...rest }) {
+  if (!palette) throw new Error("pagelet: <PageletEditor> needs a palette (see createPalette)");
+  const { data } = upgradeDocument(document, palette);
+  return /* @__PURE__ */ jsx(
+    Puck,
+    {
+      ...rest,
+      config: palette.config,
+      data,
+      metadata: { pageletTheme: theme },
+      headerTitle,
+      onPublish: onPublish ? (next) => onPublish(createDocument(next)) : void 0,
+      onChange: onChange ? (next) => onChange(createDocument(next)) : void 0
+    }
+  );
+}
+
+export { PageletEditor };
+//# sourceMappingURL=editor.js.map

package/dist/editor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor.js","sources":["../src/document.js","../src/PageletEditor.jsx"],"sourcesContent":["import { migrate } from '@puckeditor/core/rsc';\n\n// What an app stores for a page: Puck's data inside an envelope that carries\n// pagelet's own format version. The version lets a stored page be upgraded when\n// pagelet or Puck changes shape, so apps never hold raw Puck data whose format\n// they do not control.\nexport const DOCUMENT_VERSION = 1;\n\nexport function emptyData() {\n  return { root: { props: {} }, content: [] };\n}\n\nexport function createDocument(data = emptyData()) {\n  return { pagelet: DOCUMENT_VERSION, data };\n}\n\n// Bring a stored document up to the current format.\n//\n// Accepts bare Puck data too, since an app adopting pagelet may already hold\n// some. Passing the palette also runs Puck's own migrate(), which converts\n// older Puck structures (DropZone zones) into the current one (slots).\nexport function upgradeDocument(document, palette) {\n  if (document == null) return createDocument();\n  if (typeof document !== 'object') {\n    throw new TypeError('pagelet: a page document must be an object');\n  }\n\n  let doc = document;\n  if (!('pagelet' in doc)) {\n    if (!('content' in doc) && !('root' in doc)) {\n      throw new TypeError('pagelet: not a page document (no \"pagelet\" version and no Puck data)');\n    }\n    doc = createDocument(doc);\n  }\n\n  if (doc.pagelet > DOCUMENT_VERSION) {\n    throw new Error(\n      `pagelet: this page was saved by a newer pagelet (format ${doc.pagelet}); ` +\n        `this version reads up to format ${DOCUMENT_VERSION}. Upgrade @byscott-io/pagelet.`,\n    );\n  }\n\n  // Format migrations go here, one step per version:\n  //   if (doc.pagelet === 1) doc = migrateV1toV2(doc);\n\n  const data = { ...emptyData(), ...doc.data };\n  return createDocument(palette && needsPuckMigration(data) ? migrate(data, palette.config) : data);\n}\n\n// Puck's migrate() logs to the console every time it is given a config, even\n// when there is nothing to convert. On a public page that would be a log line\n// per page view, so only call it for data in an older Puck shape: DropZone\n// zones holding content, or a root whose fields sit outside `props`.\nexport function needsPuckMigration(data) {\n  const zones = data.zones ?? {};\n  if (Object.values(zones).some((content) => Array.isArray(content) && content.length > 0)) return true;\n  const root = data.root ?? {};\n  return Object.keys(root).some((key) => key !== 'props' && key !== 'readOnly');\n}\n\n// A page's own settings (title, background), for the app to use outside the\n// page body, e.g. the browser title.\nexport function pageSettings(document) {\n  const props = upgradeDocument(document)?.data?.root?.props ?? {};\n  return { title: props.title || '', background: props.background ?? 'site' };\n}\n","import { Puck } from '@puckeditor/core';\nimport { createDocument, upgradeDocument } from './document.js';\n\n// The visual editor. Import from \"@byscott-io/pagelet/editor\" (and its\n// stylesheet from \"@byscott-io/pagelet/editor.css\") in admin screens only.\n//\n// onPublish and onChange receive a pagelet document, ready to store as-is.\nexport function PageletEditor({ document, palette, theme, onPublish, onChange, headerTitle, ...rest }) {\n  if (!palette) throw new Error('pagelet: <PageletEditor> needs a palette (see createPalette)');\n  const { data } = upgradeDocument(document, palette);\n  return (\n    <Puck\n      {...rest}\n      config={palette.config}\n      data={data}\n      metadata={{ pageletTheme: theme }}\n      headerTitle={headerTitle}\n      onPublish={onPublish ? (next) => onPublish(createDocument(next)) : undefined}\n      onChange={onChange ? (next) => onChange(createDocument(next)) : undefined}\n    />\n  );\n}\n"],"names":[],"mappings":";;;;AAMO,MAAM,gBAAA,GAAmB,CAAA;AAEzB,SAAS,SAAA,GAAY;AAC1B,EAAA,OAAO,EAAE,MAAM,EAAE,KAAA,EAAO,EAAC,EAAE,EAAG,OAAA,EAAS,EAAC,EAAE;AAC5C;AAEO,SAAS,cAAA,CAAe,IAAA,GAAO,SAAA,EAAU,EAAG;AACjD,EAAA,OAAO,EAAE,OAAA,EAAS,gBAAA,EAAkB,IAAA,EAAK;AAC3C;AAOO,SAAS,eAAA,CAAgB,UAAU,OAAA,EAAS;AACjD,EAAA,IAAI,QAAA,IAAY,IAAA,EAAM,OAAO,cAAA,EAAe;AAC5C,EAAA,IAAI,OAAO,aAAa,QAAA,EAAU;AAChC,IAAA,MAAM,IAAI,UAAU,4CAA4C,CAAA;AAAA,EAClE;AAEA,EAAA,IAAI,GAAA,GAAM,QAAA;AACV,EAAA,IAAI,EAAE,aAAa,GAAA,CAAA,EAAM;AACvB,IAAA,IAAI,EAAE,SAAA,IAAa,GAAA,CAAA,IAAQ,EAAE,UAAU,GAAA,CAAA,EAAM;AAC3C,MAAA,MAAM,IAAI,UAAU,sEAAsE,CAAA;AAAA,IAC5F;AACA,IAAA,GAAA,GAAM,eAAe,GAAG,CAAA;AAAA,EAC1B;AAEA,EAAA,IAAI,GAAA,CAAI,UAAU,gBAAA,EAAkB;AAClC,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,wDAAA,EAA2D,GAAA,CAAI,OAAO,CAAA,mCAAA,EACjC,gBAAgB,CAAA,8BAAA;AAAA,KACvD;AAAA,EACF;AAKA,EAAA,MAAM,OAAO,EAAE,GAAG,WAAU,EAAG,GAAG,IAAI,IAAA,EAAK;AAC3C,EAAA,OAAO,cAAA,CAAe,OAAA,IAAW,kBAAA,CAAmB,IAAI,CAAA,GAAI,QAAQ,IAAA,EAAM,OAAA,CAAQ,MAAM,CAAA,GAAI,IAAI,CAAA;AAClG;AAMO,SAAS,mBAAmB,IAAA,EAAM;AACvC,EAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,KAAA,IAAS,EAAC;AAC7B,EAAA,IAAI,MAAA,CAAO,MAAA,CAAO,KAAK,CAAA,CAAE,KAAK,CAAC,OAAA,KAAY,KAAA,CAAM,OAAA,CAAQ,OAAO,CAAA,IAAK,OAAA,CAAQ,MAAA,GAAS,CAAC,GAAG,OAAO,IAAA;AACjG,EAAA,MAAM,IAAA,GAAO,IAAA,CAAK,IAAA,IAAQ,EAAC;AAC3B,EAAA,OAAO,MAAA,CAAO,IAAA,CAAK,IAAI,CAAA,CAAE,IAAA,CAAK,CAAC,GAAA,KAAQ,GAAA,KAAQ,OAAA,IAAW,GAAA,KAAQ,UAAU,CAAA;AAC9E;;ACnDO,SAAS,aAAA,CAAc,EAAE,QAAA,EAAU,OAAA,EAAS,KAAA,EAAO,WAAW,QAAA,EAAU,WAAA,EAAa,GAAG,IAAA,EAAK,EAAG;AACrG,EAAA,IAAI,CAAC,OAAA,EAAS,MAAM,IAAI,MAAM,8DAA8D,CAAA;AAC5F,EAAA,MAAM,EAAE,IAAA,EAAK,GAAI,eAAA,CAAgB,UAAU,OAAO,CAAA;AAClD,EAAA,uBACE,GAAA;AAAA,IAAC,IAAA;AAAA,IAAA;AAAA,MACE,GAAG,IAAA;AAAA,MACJ,QAAQ,OAAA,CAAQ,MAAA;AAAA,MAChB,IAAA;AAAA,MACA,QAAA,EAAU,EAAE,YAAA,EAAc,KAAA,EAAM;AAAA,MAChC,WAAA;AAAA,MACA,SAAA,EAAW,YAAY,CAAC,IAAA,KAAS,UAAU,cAAA,CAAe,IAAI,CAAC,CAAA,GAAI,MAAA;AAAA,MACnE,QAAA,EAAU,WAAW,CAAC,IAAA,KAAS,SAAS,cAAA,CAAe,IAAI,CAAC,CAAA,GAAI;AAAA;AAAA,GAClE;AAEJ;;"}