@prismicio/next 2.1.1 → 2.2.0-canary.070be83
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/SliceSimulator.cjs +49 -0
- package/dist/SliceSimulator.cjs.map +1 -0
- package/dist/SliceSimulator.d.cts +25 -0
- package/dist/SliceSimulatorWrapper.cjs +36 -0
- package/dist/SliceSimulatorWrapper.cjs.map +1 -0
- package/dist/getSlices.cjs +12 -0
- package/dist/getSlices.cjs.map +1 -0
- package/dist/getSlices.d.cts +7 -0
- package/dist/index.cjs +4 -0
- package/dist/index.d.cts +3 -1
- package/dist/package.cjs +1 -1
- package/dist/pages/PrismicPreview.cjs.map +1 -1
- package/dist/pages/SliceSimulator.cjs +41 -0
- package/dist/pages/SliceSimulator.cjs.map +1 -0
- package/dist/pages/SliceSimulator.d.cts +37 -0
- package/dist/pages.cjs +2 -0
- package/dist/pages.d.cts +2 -1
- package/package.json +4 -2
- package/src/SliceSimulator.tsx +95 -0
- package/src/SliceSimulatorWrapper.tsx +68 -0
- package/src/getSlices.ts +11 -0
- package/src/index.ts +8 -0
- package/src/pages/PrismicPreview.tsx +3 -3
- package/src/pages/SliceSimulator.tsx +93 -0
- package/src/pages/index.ts +6 -0
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
|
|
3
|
+
const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
|
|
4
|
+
const require_SliceSimulatorWrapper = require('./SliceSimulatorWrapper.cjs');
|
|
5
|
+
const require_getSlices = require('./getSlices.cjs');
|
|
6
|
+
let next_navigation = require("next/navigation");
|
|
7
|
+
let react = require("react");
|
|
8
|
+
let react_jsx_runtime = require("react/jsx-runtime");
|
|
9
|
+
let _prismicio_simulator_kit = require("@prismicio/simulator/kit");
|
|
10
|
+
let lz_string = require("lz-string");
|
|
11
|
+
|
|
12
|
+
//#region src/SliceSimulator.tsx
|
|
13
|
+
const STATE_PARAMS_KEY = "state";
|
|
14
|
+
const simulatorManager = new _prismicio_simulator_kit.SimulatorManager();
|
|
15
|
+
/**
|
|
16
|
+
* Simulate slices in isolation. The slice simulator enables live slice
|
|
17
|
+
* development in Slice Machine and live previews in the Page Builder.
|
|
18
|
+
*/
|
|
19
|
+
const SliceSimulator = ({ children, background, zIndex, className }) => {
|
|
20
|
+
const [message, setMessage] = (0, react.useState)(() => (0, _prismicio_simulator_kit.getDefaultMessage)());
|
|
21
|
+
const router = (0, next_navigation.useRouter)();
|
|
22
|
+
const hasSlices = require_getSlices.getSlices(typeof window !== "undefined" ? new URL(window.location.href).searchParams.get(STATE_PARAMS_KEY) : void 0).length > 0;
|
|
23
|
+
(0, react.useEffect)(() => {
|
|
24
|
+
simulatorManager.state.on(_prismicio_simulator_kit.StateEventType.Slices, (newSlices) => {
|
|
25
|
+
const url = new URL(window.location.href);
|
|
26
|
+
url.searchParams.set(STATE_PARAMS_KEY, (0, lz_string.compressToEncodedURIComponent)(JSON.stringify(newSlices)));
|
|
27
|
+
window.history.replaceState(null, "", url);
|
|
28
|
+
setTimeout(() => router.refresh(), 0);
|
|
29
|
+
}, "simulator-slices");
|
|
30
|
+
simulatorManager.state.on(_prismicio_simulator_kit.StateEventType.Message, (newMessage) => setMessage(newMessage), "simulator-message");
|
|
31
|
+
simulatorManager.init();
|
|
32
|
+
return () => {
|
|
33
|
+
simulatorManager.state.off(_prismicio_simulator_kit.StateEventType.Slices, "simulator-slices");
|
|
34
|
+
simulatorManager.state.off(_prismicio_simulator_kit.StateEventType.Message, "simulator-message");
|
|
35
|
+
};
|
|
36
|
+
}, [router]);
|
|
37
|
+
return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(require_SliceSimulatorWrapper.SliceSimulatorWrapper, {
|
|
38
|
+
message,
|
|
39
|
+
hasSlices,
|
|
40
|
+
background,
|
|
41
|
+
zIndex,
|
|
42
|
+
className,
|
|
43
|
+
children
|
|
44
|
+
});
|
|
45
|
+
};
|
|
46
|
+
|
|
47
|
+
//#endregion
|
|
48
|
+
exports.SliceSimulator = SliceSimulator;
|
|
49
|
+
//# sourceMappingURL=SliceSimulator.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SliceSimulator.cjs","names":["SimulatorManager","getSlices","StateEventType","SliceSimulatorWrapper"],"sources":["../src/SliceSimulator.tsx"],"sourcesContent":["\"use client\";\n\nimport { SliceSimulatorWrapper } from \"./SliceSimulatorWrapper\";\nimport { getSlices } from \"./getSlices\";\nimport {\n\tSimulatorManager,\n\tStateEventType,\n\tgetDefaultMessage,\n} from \"@prismicio/simulator/kit\";\nimport type { SliceSimulatorProps as BaseSliceSimulatorProps } from \"@prismicio/simulator/kit\";\nimport { compressToEncodedURIComponent } from \"lz-string\";\nimport { useRouter } from \"next/navigation\";\nimport { useEffect, useState } from \"react\";\nimport type { FC, ReactNode } from \"react\";\n\nconst STATE_PARAMS_KEY = \"state\";\n\nconst simulatorManager = new SimulatorManager();\n\n/**\n * Parameters provided to the Slice Simulator page.\n */\nexport type SliceSimulatorParams = {\n\tsearchParams: Promise<{\n\t\tstate?: string;\n\t}>;\n};\n\nexport type SliceSimulatorProps = BaseSliceSimulatorProps & {\n\tchildren: ReactNode;\n\tclassName?: string;\n};\n\n/**\n * Simulate slices in isolation. The slice simulator enables live slice\n * development in Slice Machine and live previews in the Page Builder.\n */\nexport const SliceSimulator: FC<SliceSimulatorProps> = ({\n\tchildren,\n\tbackground,\n\tzIndex,\n\tclassName,\n}) => {\n\tconst [message, setMessage] = useState(() => getDefaultMessage());\n\tconst router = useRouter();\n\n\tconst state =\n\t\ttypeof window !== \"undefined\"\n\t\t\t? new URL(window.location.href).searchParams.get(STATE_PARAMS_KEY)\n\t\t\t: undefined;\n\tconst hasSlices = getSlices(state).length > 0;\n\n\tuseEffect(() => {\n\t\tsimulatorManager.state.on(\n\t\t\tStateEventType.Slices,\n\t\t\t(newSlices) => {\n\t\t\t\tconst url = new URL(window.location.href);\n\t\t\t\turl.searchParams.set(\n\t\t\t\t\tSTATE_PARAMS_KEY,\n\t\t\t\t\tcompressToEncodedURIComponent(JSON.stringify(newSlices)),\n\t\t\t\t);\n\n\t\t\t\twindow.history.replaceState(null, \"\", url);\n\t\t\t\t// Wait until the next tick to prevent URL state race conditions.\n\t\t\t\tsetTimeout(() => router.refresh(), 0);\n\t\t\t},\n\t\t\t\"simulator-slices\",\n\t\t);\n\t\tsimulatorManager.state.on(\n\t\t\tStateEventType.Message,\n\t\t\t(newMessage) => setMessage(newMessage),\n\t\t\t\"simulator-message\",\n\t\t);\n\n\t\tsimulatorManager.init();\n\n\t\treturn () => {\n\t\t\tsimulatorManager.state.off(StateEventType.Slices, \"simulator-slices\");\n\n\t\t\tsimulatorManager.state.off(StateEventType.Message, \"simulator-message\");\n\t\t};\n\t}, [router]);\n\n\treturn (\n\t\t<SliceSimulatorWrapper\n\t\t\tmessage={message}\n\t\t\thasSlices={hasSlices}\n\t\t\tbackground={background}\n\t\t\tzIndex={zIndex}\n\t\t\tclassName={className}\n\t\t>\n\t\t\t{children}\n\t\t</SliceSimulatorWrapper>\n\t);\n};\n"],"mappings":";;;;;;;;;;;;AAeA,MAAM,mBAAmB;AAEzB,MAAM,mBAAmB,IAAIA,2CAAkB;;;;;AAoB/C,MAAa,kBAA2C,EACvD,UACA,YACA,QACA,gBACK;CACL,MAAM,CAAC,SAAS,yFAAgD,CAAC;CACjE,MAAM,yCAAoB;CAM1B,MAAM,YAAYC,4BAHjB,OAAO,WAAW,cACf,IAAI,IAAI,OAAO,SAAS,KAAK,CAAC,aAAa,IAAI,iBAAiB,GAChE,OAC8B,CAAC,SAAS;AAE5C,4BAAgB;AACf,mBAAiB,MAAM,GACtBC,wCAAe,SACd,cAAc;GACd,MAAM,MAAM,IAAI,IAAI,OAAO,SAAS,KAAK;AACzC,OAAI,aAAa,IAChB,+DAC8B,KAAK,UAAU,UAAU,CAAC,CACxD;AAED,UAAO,QAAQ,aAAa,MAAM,IAAI,IAAI;AAE1C,oBAAiB,OAAO,SAAS,EAAE,EAAE;KAEtC,mBACA;AACD,mBAAiB,MAAM,GACtBA,wCAAe,UACd,eAAe,WAAW,WAAW,EACtC,oBACA;AAED,mBAAiB,MAAM;AAEvB,eAAa;AACZ,oBAAiB,MAAM,IAAIA,wCAAe,QAAQ,mBAAmB;AAErE,oBAAiB,MAAM,IAAIA,wCAAe,SAAS,oBAAoB;;IAEtE,CAAC,OAAO,CAAC;AAEZ,QACC,2CAACC;EACS;EACE;EACC;EACJ;EACG;EAEV;GACsB"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { FC, ReactNode } from "react";
|
|
2
|
+
import { SliceSimulatorProps } from "@prismicio/simulator/kit";
|
|
3
|
+
|
|
4
|
+
//#region src/SliceSimulator.d.ts
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Parameters provided to the Slice Simulator page.
|
|
8
|
+
*/
|
|
9
|
+
type SliceSimulatorParams = {
|
|
10
|
+
searchParams: Promise<{
|
|
11
|
+
state?: string;
|
|
12
|
+
}>;
|
|
13
|
+
};
|
|
14
|
+
type SliceSimulatorProps$1 = SliceSimulatorProps & {
|
|
15
|
+
children: ReactNode;
|
|
16
|
+
className?: string;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* Simulate slices in isolation. The slice simulator enables live slice
|
|
20
|
+
* development in Slice Machine and live previews in the Page Builder.
|
|
21
|
+
*/
|
|
22
|
+
declare const SliceSimulator: FC<SliceSimulatorProps$1>;
|
|
23
|
+
//#endregion
|
|
24
|
+
export { SliceSimulator, SliceSimulatorParams, SliceSimulatorProps$1 as SliceSimulatorProps };
|
|
25
|
+
//# sourceMappingURL=SliceSimulator.d.cts.map
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
|
|
2
|
+
let react_jsx_runtime = require("react/jsx-runtime");
|
|
3
|
+
let _prismicio_simulator_kit = require("@prismicio/simulator/kit");
|
|
4
|
+
|
|
5
|
+
//#region src/SliceSimulatorWrapper.tsx
|
|
6
|
+
/**
|
|
7
|
+
* A wrapper for the slice simulator that isolates the given children from the
|
|
8
|
+
* page's layout.
|
|
9
|
+
*/
|
|
10
|
+
const SliceSimulatorWrapper = ({ className, children, zIndex, background, message, hasSlices }) => {
|
|
11
|
+
const defaultProps = (0, _prismicio_simulator_kit.getDefaultProps)();
|
|
12
|
+
return /* @__PURE__ */ (0, react_jsx_runtime.jsx)("div", {
|
|
13
|
+
className: [_prismicio_simulator_kit.simulatorClass, className].filter(Boolean).join(" "),
|
|
14
|
+
style: {
|
|
15
|
+
zIndex: typeof zIndex === "undefined" ? defaultProps.zIndex : zIndex ?? void 0,
|
|
16
|
+
position: "fixed",
|
|
17
|
+
top: 0,
|
|
18
|
+
left: 0,
|
|
19
|
+
width: "100%",
|
|
20
|
+
height: "100vh",
|
|
21
|
+
overflow: "auto",
|
|
22
|
+
background: typeof background === "undefined" ? defaultProps.background : background ?? void 0
|
|
23
|
+
},
|
|
24
|
+
children: message ? /* @__PURE__ */ (0, react_jsx_runtime.jsx)("article", { dangerouslySetInnerHTML: { __html: message } }) : hasSlices ? /* @__PURE__ */ (0, react_jsx_runtime.jsx)("div", {
|
|
25
|
+
id: "root",
|
|
26
|
+
className: _prismicio_simulator_kit.simulatorRootClass,
|
|
27
|
+
onClickCapture: _prismicio_simulator_kit.onClickHandler,
|
|
28
|
+
onSubmitCapture: _prismicio_simulator_kit.disableEventHandler,
|
|
29
|
+
children
|
|
30
|
+
}) : null
|
|
31
|
+
});
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
//#endregion
|
|
35
|
+
exports.SliceSimulatorWrapper = SliceSimulatorWrapper;
|
|
36
|
+
//# sourceMappingURL=SliceSimulatorWrapper.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SliceSimulatorWrapper.cjs","names":["simulatorClass","simulatorRootClass","onClickHandler","disableEventHandler"],"sources":["../src/SliceSimulatorWrapper.tsx"],"sourcesContent":["import {\n\tdisableEventHandler,\n\tgetDefaultProps,\n\tonClickHandler,\n\tsimulatorClass,\n\tsimulatorRootClass,\n} from \"@prismicio/simulator/kit\";\nimport type { SliceSimulatorProps } from \"@prismicio/simulator/kit\";\nimport type { FC, ReactNode } from \"react\";\n\ntype SliceSimulatorWrapperProps = SliceSimulatorProps & {\n\tchildren: ReactNode;\n\tclassName?: string;\n\tmessage?: string;\n\thasSlices: boolean;\n};\n\n/**\n * A wrapper for the slice simulator that isolates the given children from the\n * page's layout.\n */\nexport const SliceSimulatorWrapper: FC<SliceSimulatorWrapperProps> = ({\n\tclassName,\n\tchildren,\n\tzIndex,\n\tbackground,\n\tmessage,\n\thasSlices,\n}) => {\n\tconst defaultProps = getDefaultProps();\n\n\treturn (\n\t\t<div\n\t\t\tclassName={[simulatorClass, className].filter(Boolean).join(\" \")}\n\t\t\tstyle={{\n\t\t\t\tzIndex:\n\t\t\t\t\ttypeof zIndex === \"undefined\"\n\t\t\t\t\t\t? defaultProps.zIndex\n\t\t\t\t\t\t: (zIndex ?? undefined),\n\t\t\t\tposition: \"fixed\",\n\t\t\t\ttop: 0,\n\t\t\t\tleft: 0,\n\t\t\t\twidth: \"100%\",\n\t\t\t\theight: \"100vh\",\n\t\t\t\toverflow: \"auto\",\n\t\t\t\tbackground:\n\t\t\t\t\ttypeof background === \"undefined\"\n\t\t\t\t\t\t? defaultProps.background\n\t\t\t\t\t\t: (background ?? undefined),\n\t\t\t}}\n\t\t>\n\t\t\t{message ? (\n\t\t\t\t<article dangerouslySetInnerHTML={{ __html: message }} />\n\t\t\t) : hasSlices ? (\n\t\t\t\t<div\n\t\t\t\t\tid=\"root\"\n\t\t\t\t\tclassName={simulatorRootClass}\n\t\t\t\t\tonClickCapture={onClickHandler as unknown as React.MouseEventHandler}\n\t\t\t\t\tonSubmitCapture={\n\t\t\t\t\t\tdisableEventHandler as unknown as React.FormEventHandler\n\t\t\t\t\t}\n\t\t\t\t>\n\t\t\t\t\t{children}\n\t\t\t\t</div>\n\t\t\t) : null}\n\t\t</div>\n\t);\n};\n"],"mappings":";;;;;;;;;AAqBA,MAAa,yBAAyD,EACrE,WACA,UACA,QACA,YACA,SACA,gBACK;CACL,MAAM,8DAAgC;AAEtC,QACC,2CAAC;EACA,WAAW,CAACA,yCAAgB,UAAU,CAAC,OAAO,QAAQ,CAAC,KAAK,IAAI;EAChE,OAAO;GACN,QACC,OAAO,WAAW,cACf,aAAa,SACZ,UAAU;GACf,UAAU;GACV,KAAK;GACL,MAAM;GACN,OAAO;GACP,QAAQ;GACR,UAAU;GACV,YACC,OAAO,eAAe,cACnB,aAAa,aACZ,cAAc;GACnB;YAEA,UACA,2CAAC,aAAQ,yBAAyB,EAAE,QAAQ,SAAS,GAAI,GACtD,YACH,2CAAC;GACA,IAAG;GACH,WAAWC;GACX,gBAAgBC;GAChB,iBACCC;GAGA;IACI,GACH;GACC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
|
|
2
|
+
let _prismicio_simulator_kit = require("@prismicio/simulator/kit");
|
|
3
|
+
let lz_string = require("lz-string");
|
|
4
|
+
|
|
5
|
+
//#region src/getSlices.ts
|
|
6
|
+
const getSlices = (state) => {
|
|
7
|
+
return state ? JSON.parse((0, lz_string.decompressFromEncodedURIComponent)(state)) : (0, _prismicio_simulator_kit.getDefaultSlices)();
|
|
8
|
+
};
|
|
9
|
+
|
|
10
|
+
//#endregion
|
|
11
|
+
exports.getSlices = getSlices;
|
|
12
|
+
//# sourceMappingURL=getSlices.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getSlices.cjs","names":[],"sources":["../src/getSlices.ts"],"sourcesContent":["import { getDefaultSlices } from \"@prismicio/simulator/kit\";\nimport type { StateEvents, StateEventType } from \"@prismicio/simulator/kit\";\nimport { decompressFromEncodedURIComponent } from \"lz-string\";\n\nexport const getSlices = (\n\tstate: string | null | undefined,\n): StateEvents[StateEventType.Slices] => {\n\treturn state\n\t\t? JSON.parse(decompressFromEncodedURIComponent(state))\n\t\t: getDefaultSlices();\n};\n"],"mappings":";;;;;AAIA,MAAa,aACZ,UACwC;AACxC,QAAO,QACJ,KAAK,uDAAwC,MAAM,CAAC,mDAClC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { StateEventType, StateEvents } from "@prismicio/simulator/kit";
|
|
2
|
+
|
|
3
|
+
//#region src/getSlices.d.ts
|
|
4
|
+
declare const getSlices: (state: string | null | undefined) => StateEvents[StateEventType.Slices];
|
|
5
|
+
//#endregion
|
|
6
|
+
export { getSlices };
|
|
7
|
+
//# sourceMappingURL=getSlices.d.cts.map
|
package/dist/index.cjs
CHANGED
|
@@ -5,13 +5,17 @@ const require_enableAutoPreviews = require('./enableAutoPreviews.cjs');
|
|
|
5
5
|
const require_redirectToPreviewURL = require('./redirectToPreviewURL.cjs');
|
|
6
6
|
const require_imgixLoader = require('./imgixLoader.cjs');
|
|
7
7
|
const require_PrismicNextImage = require('./PrismicNextImage.cjs');
|
|
8
|
+
const require_getSlices = require('./getSlices.cjs');
|
|
9
|
+
const require_SliceSimulator = require('./SliceSimulator.cjs');
|
|
8
10
|
const require_createLocaleRedirect = require('./createLocaleRedirect.cjs');
|
|
9
11
|
|
|
10
12
|
exports.PrismicNextImage = require_PrismicNextImage.PrismicNextImage;
|
|
11
13
|
exports.PrismicNextLink = require_PrismicNextLink.PrismicNextLink;
|
|
12
14
|
exports.PrismicPreview = require_PrismicPreview.PrismicPreview;
|
|
15
|
+
exports.SliceSimulator = require_SliceSimulator.SliceSimulator;
|
|
13
16
|
exports.createLocaleRedirect = require_createLocaleRedirect.createLocaleRedirect;
|
|
14
17
|
exports.enableAutoPreviews = require_enableAutoPreviews.enableAutoPreviews;
|
|
15
18
|
exports.exitPreview = require_exitPreview.exitPreview;
|
|
19
|
+
exports.getSlices = require_getSlices.getSlices;
|
|
16
20
|
exports.imgixLoader = require_imgixLoader.imgixLoader;
|
|
17
21
|
exports.redirectToPreviewURL = require_redirectToPreviewURL.redirectToPreviewURL;
|
package/dist/index.d.cts
CHANGED
|
@@ -5,6 +5,8 @@ import { EnableAutoPreviewsConfig, enableAutoPreviews } from "./enableAutoPrevie
|
|
|
5
5
|
import { CreateClientConfig } from "./types.cjs";
|
|
6
6
|
import { RedirectToPreviewURLConfig, redirectToPreviewURL } from "./redirectToPreviewURL.cjs";
|
|
7
7
|
import { PrismicNextImage, PrismicNextImageProps } from "./PrismicNextImage.cjs";
|
|
8
|
+
import { SliceSimulator, SliceSimulatorParams, SliceSimulatorProps } from "./SliceSimulator.cjs";
|
|
9
|
+
import { getSlices } from "./getSlices.cjs";
|
|
8
10
|
import { imgixLoader } from "./imgixLoader.cjs";
|
|
9
11
|
import { CreateLocaleRedirectConfig, createLocaleRedirect } from "./createLocaleRedirect.cjs";
|
|
10
|
-
export { type CreateClientConfig, type CreateLocaleRedirectConfig, type EnableAutoPreviewsConfig, PrismicNextImage, type PrismicNextImageProps, PrismicNextLink, type PrismicNextLinkProps, PrismicPreview, type PrismicPreviewProps, type RedirectToPreviewURLConfig, createLocaleRedirect, enableAutoPreviews, exitPreview, imgixLoader, redirectToPreviewURL };
|
|
12
|
+
export { type CreateClientConfig, type CreateLocaleRedirectConfig, type EnableAutoPreviewsConfig, PrismicNextImage, type PrismicNextImageProps, PrismicNextLink, type PrismicNextLinkProps, PrismicPreview, type PrismicPreviewProps, type RedirectToPreviewURLConfig, SliceSimulator, type SliceSimulatorParams, type SliceSimulatorProps, createLocaleRedirect, enableAutoPreviews, exitPreview, getSlices, imgixLoader, redirectToPreviewURL };
|
package/dist/package.cjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PrismicPreview.cjs","names":["Script","prismicCookie"],"sources":["../../src/pages/PrismicPreview.tsx"],"sourcesContent":["import
|
|
1
|
+
{"version":3,"file":"PrismicPreview.cjs","names":["Script","prismicCookie"],"sources":["../../src/pages/PrismicPreview.tsx"],"sourcesContent":["import { getToolbarSrc, cookie as prismicCookie } from \"@prismicio/client\";\nimport { useRouter } from \"next/router\";\nimport Script from \"next/script\";\nimport type { FC } from \"react\";\nimport { type ReactNode, useEffect } from \"react\";\n\n/** Props for `<PrismicPreview>`. */\nexport type PrismicPreviewProps = {\n\t/**\n\t * The name of your Prismic repository. A Prismic Toolbar will be registered\n\t * using this repository.\n\t */\n\trepositoryName: string;\n\n\t/**\n\t * The URL of your app's Prismic preview endpoint (default: `/api/preview`).\n\t * This URL will be fetched on preview update events.\n\t */\n\tupdatePreviewURL?: string;\n\n\t/**\n\t * The URL of your app's exit preview endpoint (default: `/api/exit-preview`).\n\t * This URL will be fetched on preview exit events.\n\t */\n\texitPreviewURL?: string;\n\n\t/** Children to render adjacent to the Prismic Toolbar. */\n\tchildren?: ReactNode;\n};\n\n/**\n * React component that sets up Prismic Previews using the Prismic Toolbar. When\n * the Prismic Toolbar send events to the browser, such as on preview updates\n * and exiting, this component will automatically refresh the page with the\n * changes.\n *\n * This component can be wrapped around your app or added anywhere in your app's\n * tree. It must be rendered on every page.\n */\nexport const PrismicPreview: FC<PrismicPreviewProps> = (props) => {\n\tconst {\n\t\trepositoryName,\n\t\tupdatePreviewURL = \"/api/preview\",\n\t\texitPreviewURL = \"/api/exit-preview\",\n\t\tchildren,\n\t} = props;\n\n\tconst router = useRouter();\n\n\tconst toolbarSrc = getToolbarSrc(repositoryName);\n\n\tuseEffect(() => {\n\t\tconst controller = new AbortController();\n\n\t\twindow.addEventListener(\"prismicPreviewUpdate\", onUpdate, {\n\t\t\tsignal: controller.signal,\n\t\t});\n\t\twindow.addEventListener(\"prismicPreviewEnd\", onEnd, {\n\t\t\tsignal: controller.signal,\n\t\t});\n\n\t\t// Start the preview for preview share links. Previews from\n\t\t// share links do not go to the `updatePreviewURL` like a normal\n\t\t// preview.\n\t\t//\n\t\t// We check that the current URL is a descendant of the base\n\t\t// path to prevent infinite refrehes.\n\t\tif (\n\t\t\twindow.location.href.startsWith(\n\t\t\t\twindow.location.origin + router.basePath,\n\t\t\t) &&\n\t\t\tgetPreviewCookieRepositoryName() === repositoryName &&\n\t\t\t!router.isPreview\n\t\t) {\n\t\t\tstart();\n\t\t}\n\n\t\tfunction onEnd(event: Event) {\n\t\t\tevent.preventDefault();\n\t\t\tfetch(router.basePath + exitPreviewURL, { signal: controller.signal })\n\t\t\t\t.then((res) => {\n\t\t\t\t\tif (!res.ok) {\n\t\t\t\t\t\tconsole.error(\n\t\t\t\t\t\t\t`[<PrismicPreview>] Failed to exit Preview Mode using the \"${exitPreviewURL}\" API endpoint. Does it exist?`,\n\t\t\t\t\t\t);\n\n\t\t\t\t\t\treturn;\n\t\t\t\t\t}\n\n\t\t\t\t\trefresh();\n\t\t\t\t})\n\t\t\t\t.catch(() => {});\n\t\t}\n\n\t\tfunction onUpdate(event: Event) {\n\t\t\tevent.preventDefault();\n\t\t\tstart();\n\t\t}\n\n\t\tfunction start() {\n\t\t\t// We check `opaqueredirect` because we don't care if\n\t\t\t// the redirect was successful or not. As long as it\n\t\t\t// redirects, we know the endpoint exists and at least\n\t\t\t// attempted to set preview data.\n\t\t\tfetch(router.basePath + updatePreviewURL, {\n\t\t\t\tredirect: \"manual\",\n\t\t\t\tsignal: controller.signal,\n\t\t\t})\n\t\t\t\t.then((res) => {\n\t\t\t\t\tif (res.type !== \"opaqueredirect\") {\n\t\t\t\t\t\tconsole.error(\n\t\t\t\t\t\t\t`[<PrismicPreview>] Failed to start or update the preview using \"${updatePreviewURL}\". Does it exist?`,\n\t\t\t\t\t\t);\n\n\t\t\t\t\t\treturn;\n\t\t\t\t\t}\n\n\t\t\t\t\trefresh();\n\t\t\t\t})\n\t\t\t\t.catch(() => {});\n\t\t}\n\n\t\tfunction refresh() {\n\t\t\trouter.replace(router.asPath, undefined, { scroll: false });\n\t\t}\n\n\t\treturn () => controller.abort();\n\t}, [exitPreviewURL, updatePreviewURL, repositoryName, router]);\n\n\treturn (\n\t\t<>\n\t\t\t{children}\n\t\t\t<Script src={toolbarSrc} strategy=\"lazyOnload\" />\n\t\t</>\n\t);\n};\n\nfunction getPreviewCookieRepositoryName() {\n\tconst cookie = window.document.cookie\n\t\t.split(\"; \")\n\t\t.find((row) => row.startsWith(`${prismicCookie.preview}=`))\n\t\t?.split(\"=\")[1];\n\n\treturn (decodeURIComponent(cookie ?? \"\").match(/\"([^\"]+)\\.prismic\\.io\"/) ||\n\t\t[])[1];\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAuCA,MAAa,kBAA2C,UAAU;CACjE,MAAM,EACL,gBACA,mBAAmB,gBACnB,iBAAiB,qBACjB,aACG;CAEJ,MAAM,qCAAoB;CAE1B,MAAM,kDAA2B,eAAe;AAEhD,4BAAgB;EACf,MAAM,aAAa,IAAI,iBAAiB;AAExC,SAAO,iBAAiB,wBAAwB,UAAU,EACzD,QAAQ,WAAW,QACnB,CAAC;AACF,SAAO,iBAAiB,qBAAqB,OAAO,EACnD,QAAQ,WAAW,QACnB,CAAC;AAQF,MACC,OAAO,SAAS,KAAK,WACpB,OAAO,SAAS,SAAS,OAAO,SAChC,IACD,gCAAgC,KAAK,kBACrC,CAAC,OAAO,UAER,QAAO;EAGR,SAAS,MAAM,OAAc;AAC5B,SAAM,gBAAgB;AACtB,SAAM,OAAO,WAAW,gBAAgB,EAAE,QAAQ,WAAW,QAAQ,CAAC,CACpE,MAAM,QAAQ;AACd,QAAI,CAAC,IAAI,IAAI;AACZ,aAAQ,MACP,6DAA6D,eAAe,gCAC5E;AAED;;AAGD,aAAS;KACR,CACD,YAAY,GAAG;;EAGlB,SAAS,SAAS,OAAc;AAC/B,SAAM,gBAAgB;AACtB,UAAO;;EAGR,SAAS,QAAQ;AAKhB,SAAM,OAAO,WAAW,kBAAkB;IACzC,UAAU;IACV,QAAQ,WAAW;IACnB,CAAC,CACA,MAAM,QAAQ;AACd,QAAI,IAAI,SAAS,kBAAkB;AAClC,aAAQ,MACP,mEAAmE,iBAAiB,mBACpF;AAED;;AAGD,aAAS;KACR,CACD,YAAY,GAAG;;EAGlB,SAAS,UAAU;AAClB,UAAO,QAAQ,OAAO,QAAQ,QAAW,EAAE,QAAQ,OAAO,CAAC;;AAG5D,eAAa,WAAW,OAAO;IAC7B;EAAC;EAAgB;EAAkB;EAAgB;EAAO,CAAC;AAE9D,QACC,qFACE,UACD,2CAACA;EAAO,KAAK;EAAY,UAAS;GAAe,IAC/C;;AAIL,SAAS,iCAAiC;CACzC,MAAM,SAAS,OAAO,SAAS,OAC7B,MAAM,KAAK,CACX,MAAM,QAAQ,IAAI,WAAW,GAAGC,yBAAc,QAAQ,GAAG,CAAC,EACzD,MAAM,IAAI,CAAC;AAEd,SAAQ,mBAAmB,UAAU,GAAG,CAAC,MAAM,yBAAyB,IACvE,EAAE,EAAE"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
|
|
2
|
+
const require_SliceSimulatorWrapper = require('../SliceSimulatorWrapper.cjs');
|
|
3
|
+
let react = require("react");
|
|
4
|
+
let react_jsx_runtime = require("react/jsx-runtime");
|
|
5
|
+
let _prismicio_simulator_kit = require("@prismicio/simulator/kit");
|
|
6
|
+
|
|
7
|
+
//#region src/pages/SliceSimulator.tsx
|
|
8
|
+
const simulatorManager = new _prismicio_simulator_kit.SimulatorManager();
|
|
9
|
+
/**
|
|
10
|
+
* Simulate slices in isolation. The slice simulator enables live slice
|
|
11
|
+
* development in Slice Machine and live previews in the Page Builder.
|
|
12
|
+
*/
|
|
13
|
+
const SliceSimulator = ({ background, zIndex, className, sliceZone: SliceZoneComp }) => {
|
|
14
|
+
const [slices, setSlices] = (0, react.useState)(() => (0, _prismicio_simulator_kit.getDefaultSlices)());
|
|
15
|
+
const [message, setMessage] = (0, react.useState)(() => (0, _prismicio_simulator_kit.getDefaultMessage)());
|
|
16
|
+
(0, react.useEffect)(() => {
|
|
17
|
+
simulatorManager.state.on(_prismicio_simulator_kit.StateEventType.Slices, (_slices) => {
|
|
18
|
+
setSlices(_slices);
|
|
19
|
+
}, "simulator-slices");
|
|
20
|
+
simulatorManager.state.on(_prismicio_simulator_kit.StateEventType.Message, (_message) => {
|
|
21
|
+
setMessage(_message);
|
|
22
|
+
}, "simulator-message");
|
|
23
|
+
simulatorManager.init();
|
|
24
|
+
return () => {
|
|
25
|
+
simulatorManager.state.off(_prismicio_simulator_kit.StateEventType.Slices, "simulator-slices");
|
|
26
|
+
simulatorManager.state.off(_prismicio_simulator_kit.StateEventType.Message, "simulator-message");
|
|
27
|
+
};
|
|
28
|
+
}, []);
|
|
29
|
+
return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(require_SliceSimulatorWrapper.SliceSimulatorWrapper, {
|
|
30
|
+
message,
|
|
31
|
+
hasSlices: slices.length > 0,
|
|
32
|
+
background,
|
|
33
|
+
zIndex,
|
|
34
|
+
className,
|
|
35
|
+
children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(SliceZoneComp, { slices })
|
|
36
|
+
});
|
|
37
|
+
};
|
|
38
|
+
|
|
39
|
+
//#endregion
|
|
40
|
+
exports.SliceSimulator = SliceSimulator;
|
|
41
|
+
//# sourceMappingURL=SliceSimulator.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SliceSimulator.cjs","names":["SimulatorManager","StateEventType","SliceSimulatorWrapper"],"sources":["../../src/pages/SliceSimulator.tsx"],"sourcesContent":["import { SliceSimulatorWrapper } from \"../SliceSimulatorWrapper\";\nimport {\n\tSimulatorManager,\n\tStateEventType,\n\tgetDefaultMessage,\n\tgetDefaultSlices,\n} from \"@prismicio/simulator/kit\";\nimport type {\n\tSliceSimulatorProps as BaseSliceSimulatorProps,\n\tSliceSimulatorState,\n} from \"@prismicio/simulator/kit\";\nimport { useEffect, useState } from \"react\";\nimport type { ComponentType, FC } from \"react\";\n\nconst simulatorManager = new SimulatorManager();\n\nexport type SliceSimulatorSliceZoneProps = {\n\tslices: SliceSimulatorState[\"slices\"];\n};\n\nexport type SliceSimulatorProps = BaseSliceSimulatorProps & {\n\t/**\n\t * React component to render simulated Slices.\n\t *\n\t * @example\n\t *\n\t * ```tsx\n\t * import { SliceSimulator } from \"@slicemachine/adapter-next/simulator\";\n\t * import { SliceZone } from \"@prismicio/react\";\n\t *\n\t * import { components } from \"../slices\";\n\t *\n\t * <SliceSimulator\n\t * \tsliceZone={({ slices }) => (\n\t * \t\t<SliceZone slices={slices} components={components} />\n\t * \t)}\n\t * />;\n\t * ```\n\t */\n\tsliceZone: ComponentType<SliceSimulatorSliceZoneProps>;\n\tclassName?: string;\n};\n\n/**\n * Simulate slices in isolation. The slice simulator enables live slice\n * development in Slice Machine and live previews in the Page Builder.\n */\nexport const SliceSimulator: FC<SliceSimulatorProps> = ({\n\tbackground,\n\tzIndex,\n\tclassName,\n\tsliceZone: SliceZoneComp,\n}) => {\n\tconst [slices, setSlices] = useState(() => getDefaultSlices());\n\tconst [message, setMessage] = useState(() => getDefaultMessage());\n\n\tuseEffect(() => {\n\t\tsimulatorManager.state.on(\n\t\t\tStateEventType.Slices,\n\t\t\t(_slices) => {\n\t\t\t\tsetSlices(_slices);\n\t\t\t},\n\t\t\t\"simulator-slices\",\n\t\t);\n\t\tsimulatorManager.state.on(\n\t\t\tStateEventType.Message,\n\t\t\t(_message) => {\n\t\t\t\tsetMessage(_message);\n\t\t\t},\n\t\t\t\"simulator-message\",\n\t\t);\n\n\t\tsimulatorManager.init();\n\n\t\treturn () => {\n\t\t\tsimulatorManager.state.off(StateEventType.Slices, \"simulator-slices\");\n\n\t\t\tsimulatorManager.state.off(StateEventType.Message, \"simulator-message\");\n\t\t};\n\t}, []);\n\n\treturn (\n\t\t<SliceSimulatorWrapper\n\t\t\tmessage={message}\n\t\t\thasSlices={slices.length > 0}\n\t\t\tbackground={background}\n\t\t\tzIndex={zIndex}\n\t\t\tclassName={className}\n\t\t>\n\t\t\t<SliceZoneComp slices={slices} />\n\t\t</SliceSimulatorWrapper>\n\t);\n};\n"],"mappings":";;;;;;;AAcA,MAAM,mBAAmB,IAAIA,2CAAkB;;;;;AAiC/C,MAAa,kBAA2C,EACvD,YACA,QACA,WACA,WAAW,oBACN;CACL,MAAM,CAAC,QAAQ,uFAA8C,CAAC;CAC9D,MAAM,CAAC,SAAS,yFAAgD,CAAC;AAEjE,4BAAgB;AACf,mBAAiB,MAAM,GACtBC,wCAAe,SACd,YAAY;AACZ,aAAU,QAAQ;KAEnB,mBACA;AACD,mBAAiB,MAAM,GACtBA,wCAAe,UACd,aAAa;AACb,cAAW,SAAS;KAErB,oBACA;AAED,mBAAiB,MAAM;AAEvB,eAAa;AACZ,oBAAiB,MAAM,IAAIA,wCAAe,QAAQ,mBAAmB;AAErE,oBAAiB,MAAM,IAAIA,wCAAe,SAAS,oBAAoB;;IAEtE,EAAE,CAAC;AAEN,QACC,2CAACC;EACS;EACT,WAAW,OAAO,SAAS;EACf;EACJ;EACG;YAEX,2CAAC,iBAAsB,SAAU;GACV"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { ComponentType, FC } from "react";
|
|
2
|
+
import { SliceSimulatorProps, SliceSimulatorState } from "@prismicio/simulator/kit";
|
|
3
|
+
|
|
4
|
+
//#region src/pages/SliceSimulator.d.ts
|
|
5
|
+
type SliceSimulatorSliceZoneProps = {
|
|
6
|
+
slices: SliceSimulatorState["slices"];
|
|
7
|
+
};
|
|
8
|
+
type SliceSimulatorProps$1 = SliceSimulatorProps & {
|
|
9
|
+
/**
|
|
10
|
+
* React component to render simulated Slices.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
*
|
|
14
|
+
* ```tsx
|
|
15
|
+
* import { SliceSimulator } from "@slicemachine/adapter-next/simulator";
|
|
16
|
+
* import { SliceZone } from "@prismicio/react";
|
|
17
|
+
*
|
|
18
|
+
* import { components } from "../slices";
|
|
19
|
+
*
|
|
20
|
+
* <SliceSimulator
|
|
21
|
+
* sliceZone={({ slices }) => (
|
|
22
|
+
* <SliceZone slices={slices} components={components} />
|
|
23
|
+
* )}
|
|
24
|
+
* />;
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
sliceZone: ComponentType<SliceSimulatorSliceZoneProps>;
|
|
28
|
+
className?: string;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Simulate slices in isolation. The slice simulator enables live slice
|
|
32
|
+
* development in Slice Machine and live previews in the Page Builder.
|
|
33
|
+
*/
|
|
34
|
+
declare const SliceSimulator: FC<SliceSimulatorProps$1>;
|
|
35
|
+
//#endregion
|
|
36
|
+
export { SliceSimulator, SliceSimulatorProps$1 as SliceSimulatorProps, SliceSimulatorSliceZoneProps };
|
|
37
|
+
//# sourceMappingURL=SliceSimulator.d.cts.map
|
package/dist/pages.cjs
CHANGED
|
@@ -2,6 +2,7 @@ const require_PrismicNextLink = require('./PrismicNextLink.cjs');
|
|
|
2
2
|
const require_imgixLoader = require('./imgixLoader.cjs');
|
|
3
3
|
const require_PrismicNextImage = require('./PrismicNextImage.cjs');
|
|
4
4
|
const require_createLocaleRedirect = require('./createLocaleRedirect.cjs');
|
|
5
|
+
const require_SliceSimulator = require('./pages/SliceSimulator.cjs');
|
|
5
6
|
const require_PrismicPreview = require('./pages/PrismicPreview.cjs');
|
|
6
7
|
const require_enableAutoPreviews = require('./pages/enableAutoPreviews.cjs');
|
|
7
8
|
const require_redirectToPreviewURL = require('./pages/redirectToPreviewURL.cjs');
|
|
@@ -11,6 +12,7 @@ const require_setPreviewData = require('./pages/setPreviewData.cjs');
|
|
|
11
12
|
exports.PrismicNextImage = require_PrismicNextImage.PrismicNextImage;
|
|
12
13
|
exports.PrismicNextLink = require_PrismicNextLink.PrismicNextLink;
|
|
13
14
|
exports.PrismicPreview = require_PrismicPreview.PrismicPreview;
|
|
15
|
+
exports.SliceSimulator = require_SliceSimulator.SliceSimulator;
|
|
14
16
|
exports.createLocaleRedirect = require_createLocaleRedirect.createLocaleRedirect;
|
|
15
17
|
exports.enableAutoPreviews = require_enableAutoPreviews.enableAutoPreviews;
|
|
16
18
|
exports.exitPreview = require_exitPreview.exitPreview;
|
package/dist/pages.d.cts
CHANGED
|
@@ -2,10 +2,11 @@ import { PrismicNextLink, PrismicNextLinkProps } from "./PrismicNextLink.cjs";
|
|
|
2
2
|
import { PrismicNextImage, PrismicNextImageProps } from "./PrismicNextImage.cjs";
|
|
3
3
|
import { imgixLoader } from "./imgixLoader.cjs";
|
|
4
4
|
import { CreateLocaleRedirectConfig, createLocaleRedirect } from "./createLocaleRedirect.cjs";
|
|
5
|
+
import { SliceSimulator, SliceSimulatorProps, SliceSimulatorSliceZoneProps } from "./pages/SliceSimulator.cjs";
|
|
5
6
|
import { PrismicPreview, PrismicPreviewProps } from "./pages/PrismicPreview.cjs";
|
|
6
7
|
import { CreateClientConfig } from "./pages/types.cjs";
|
|
7
8
|
import { EnableAutoPreviewsConfig, enableAutoPreviews } from "./pages/enableAutoPreviews.cjs";
|
|
8
9
|
import { RedirectToPreviewURLConfig, redirectToPreviewURL } from "./pages/redirectToPreviewURL.cjs";
|
|
9
10
|
import { ExitPreviewAPIRouteConfig, exitPreview } from "./pages/exitPreview.cjs";
|
|
10
11
|
import { SetPreviewDataConfig, setPreviewData } from "./pages/setPreviewData.cjs";
|
|
11
|
-
export { type CreateClientConfig, type CreateLocaleRedirectConfig, type EnableAutoPreviewsConfig, type ExitPreviewAPIRouteConfig, PrismicNextImage, type PrismicNextImageProps, PrismicNextLink, type PrismicNextLinkProps, PrismicPreview, type PrismicPreviewProps, type RedirectToPreviewURLConfig, type SetPreviewDataConfig, createLocaleRedirect, enableAutoPreviews, exitPreview, imgixLoader, redirectToPreviewURL, setPreviewData };
|
|
12
|
+
export { type CreateClientConfig, type CreateLocaleRedirectConfig, type EnableAutoPreviewsConfig, type ExitPreviewAPIRouteConfig, PrismicNextImage, type PrismicNextImageProps, PrismicNextLink, type PrismicNextLinkProps, PrismicPreview, type PrismicPreviewProps, type RedirectToPreviewURLConfig, type SetPreviewDataConfig, SliceSimulator, type SliceSimulatorProps, type SliceSimulatorSliceZoneProps, createLocaleRedirect, enableAutoPreviews, exitPreview, imgixLoader, redirectToPreviewURL, setPreviewData };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@prismicio/next",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.2.0-canary.070be83",
|
|
4
4
|
"description": "Helpers to integrate Prismic into Next.js apps",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"typescript",
|
|
@@ -55,7 +55,9 @@
|
|
|
55
55
|
"types": "tsc --noEmit"
|
|
56
56
|
},
|
|
57
57
|
"dependencies": {
|
|
58
|
-
"
|
|
58
|
+
"@prismicio/simulator": "^0.2.0",
|
|
59
|
+
"imgix-url-builder": "^0.0.5",
|
|
60
|
+
"lz-string": "^1.5.0"
|
|
59
61
|
},
|
|
60
62
|
"devDependencies": {
|
|
61
63
|
"@playwright/test": "^1.49.1",
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
|
|
3
|
+
import { SliceSimulatorWrapper } from "./SliceSimulatorWrapper";
|
|
4
|
+
import { getSlices } from "./getSlices";
|
|
5
|
+
import {
|
|
6
|
+
SimulatorManager,
|
|
7
|
+
StateEventType,
|
|
8
|
+
getDefaultMessage,
|
|
9
|
+
} from "@prismicio/simulator/kit";
|
|
10
|
+
import type { SliceSimulatorProps as BaseSliceSimulatorProps } from "@prismicio/simulator/kit";
|
|
11
|
+
import { compressToEncodedURIComponent } from "lz-string";
|
|
12
|
+
import { useRouter } from "next/navigation";
|
|
13
|
+
import { useEffect, useState } from "react";
|
|
14
|
+
import type { FC, ReactNode } from "react";
|
|
15
|
+
|
|
16
|
+
const STATE_PARAMS_KEY = "state";
|
|
17
|
+
|
|
18
|
+
const simulatorManager = new SimulatorManager();
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Parameters provided to the Slice Simulator page.
|
|
22
|
+
*/
|
|
23
|
+
export type SliceSimulatorParams = {
|
|
24
|
+
searchParams: Promise<{
|
|
25
|
+
state?: string;
|
|
26
|
+
}>;
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
export type SliceSimulatorProps = BaseSliceSimulatorProps & {
|
|
30
|
+
children: ReactNode;
|
|
31
|
+
className?: string;
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* Simulate slices in isolation. The slice simulator enables live slice
|
|
36
|
+
* development in Slice Machine and live previews in the Page Builder.
|
|
37
|
+
*/
|
|
38
|
+
export const SliceSimulator: FC<SliceSimulatorProps> = ({
|
|
39
|
+
children,
|
|
40
|
+
background,
|
|
41
|
+
zIndex,
|
|
42
|
+
className,
|
|
43
|
+
}) => {
|
|
44
|
+
const [message, setMessage] = useState(() => getDefaultMessage());
|
|
45
|
+
const router = useRouter();
|
|
46
|
+
|
|
47
|
+
const state =
|
|
48
|
+
typeof window !== "undefined"
|
|
49
|
+
? new URL(window.location.href).searchParams.get(STATE_PARAMS_KEY)
|
|
50
|
+
: undefined;
|
|
51
|
+
const hasSlices = getSlices(state).length > 0;
|
|
52
|
+
|
|
53
|
+
useEffect(() => {
|
|
54
|
+
simulatorManager.state.on(
|
|
55
|
+
StateEventType.Slices,
|
|
56
|
+
(newSlices) => {
|
|
57
|
+
const url = new URL(window.location.href);
|
|
58
|
+
url.searchParams.set(
|
|
59
|
+
STATE_PARAMS_KEY,
|
|
60
|
+
compressToEncodedURIComponent(JSON.stringify(newSlices)),
|
|
61
|
+
);
|
|
62
|
+
|
|
63
|
+
window.history.replaceState(null, "", url);
|
|
64
|
+
// Wait until the next tick to prevent URL state race conditions.
|
|
65
|
+
setTimeout(() => router.refresh(), 0);
|
|
66
|
+
},
|
|
67
|
+
"simulator-slices",
|
|
68
|
+
);
|
|
69
|
+
simulatorManager.state.on(
|
|
70
|
+
StateEventType.Message,
|
|
71
|
+
(newMessage) => setMessage(newMessage),
|
|
72
|
+
"simulator-message",
|
|
73
|
+
);
|
|
74
|
+
|
|
75
|
+
simulatorManager.init();
|
|
76
|
+
|
|
77
|
+
return () => {
|
|
78
|
+
simulatorManager.state.off(StateEventType.Slices, "simulator-slices");
|
|
79
|
+
|
|
80
|
+
simulatorManager.state.off(StateEventType.Message, "simulator-message");
|
|
81
|
+
};
|
|
82
|
+
}, [router]);
|
|
83
|
+
|
|
84
|
+
return (
|
|
85
|
+
<SliceSimulatorWrapper
|
|
86
|
+
message={message}
|
|
87
|
+
hasSlices={hasSlices}
|
|
88
|
+
background={background}
|
|
89
|
+
zIndex={zIndex}
|
|
90
|
+
className={className}
|
|
91
|
+
>
|
|
92
|
+
{children}
|
|
93
|
+
</SliceSimulatorWrapper>
|
|
94
|
+
);
|
|
95
|
+
};
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import {
|
|
2
|
+
disableEventHandler,
|
|
3
|
+
getDefaultProps,
|
|
4
|
+
onClickHandler,
|
|
5
|
+
simulatorClass,
|
|
6
|
+
simulatorRootClass,
|
|
7
|
+
} from "@prismicio/simulator/kit";
|
|
8
|
+
import type { SliceSimulatorProps } from "@prismicio/simulator/kit";
|
|
9
|
+
import type { FC, ReactNode } from "react";
|
|
10
|
+
|
|
11
|
+
type SliceSimulatorWrapperProps = SliceSimulatorProps & {
|
|
12
|
+
children: ReactNode;
|
|
13
|
+
className?: string;
|
|
14
|
+
message?: string;
|
|
15
|
+
hasSlices: boolean;
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* A wrapper for the slice simulator that isolates the given children from the
|
|
20
|
+
* page's layout.
|
|
21
|
+
*/
|
|
22
|
+
export const SliceSimulatorWrapper: FC<SliceSimulatorWrapperProps> = ({
|
|
23
|
+
className,
|
|
24
|
+
children,
|
|
25
|
+
zIndex,
|
|
26
|
+
background,
|
|
27
|
+
message,
|
|
28
|
+
hasSlices,
|
|
29
|
+
}) => {
|
|
30
|
+
const defaultProps = getDefaultProps();
|
|
31
|
+
|
|
32
|
+
return (
|
|
33
|
+
<div
|
|
34
|
+
className={[simulatorClass, className].filter(Boolean).join(" ")}
|
|
35
|
+
style={{
|
|
36
|
+
zIndex:
|
|
37
|
+
typeof zIndex === "undefined"
|
|
38
|
+
? defaultProps.zIndex
|
|
39
|
+
: (zIndex ?? undefined),
|
|
40
|
+
position: "fixed",
|
|
41
|
+
top: 0,
|
|
42
|
+
left: 0,
|
|
43
|
+
width: "100%",
|
|
44
|
+
height: "100vh",
|
|
45
|
+
overflow: "auto",
|
|
46
|
+
background:
|
|
47
|
+
typeof background === "undefined"
|
|
48
|
+
? defaultProps.background
|
|
49
|
+
: (background ?? undefined),
|
|
50
|
+
}}
|
|
51
|
+
>
|
|
52
|
+
{message ? (
|
|
53
|
+
<article dangerouslySetInnerHTML={{ __html: message }} />
|
|
54
|
+
) : hasSlices ? (
|
|
55
|
+
<div
|
|
56
|
+
id="root"
|
|
57
|
+
className={simulatorRootClass}
|
|
58
|
+
onClickCapture={onClickHandler as unknown as React.MouseEventHandler}
|
|
59
|
+
onSubmitCapture={
|
|
60
|
+
disableEventHandler as unknown as React.FormEventHandler
|
|
61
|
+
}
|
|
62
|
+
>
|
|
63
|
+
{children}
|
|
64
|
+
</div>
|
|
65
|
+
) : null}
|
|
66
|
+
</div>
|
|
67
|
+
);
|
|
68
|
+
};
|
package/src/getSlices.ts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { getDefaultSlices } from "@prismicio/simulator/kit";
|
|
2
|
+
import type { StateEvents, StateEventType } from "@prismicio/simulator/kit";
|
|
3
|
+
import { decompressFromEncodedURIComponent } from "lz-string";
|
|
4
|
+
|
|
5
|
+
export const getSlices = (
|
|
6
|
+
state: string | null | undefined,
|
|
7
|
+
): StateEvents[StateEventType.Slices] => {
|
|
8
|
+
return state
|
|
9
|
+
? JSON.parse(decompressFromEncodedURIComponent(state))
|
|
10
|
+
: getDefaultSlices();
|
|
11
|
+
};
|
package/src/index.ts
CHANGED
|
@@ -15,6 +15,14 @@ export type { RedirectToPreviewURLConfig } from "./redirectToPreviewURL";
|
|
|
15
15
|
export { PrismicNextImage } from "./PrismicNextImage";
|
|
16
16
|
export type { PrismicNextImageProps } from "./PrismicNextImage";
|
|
17
17
|
|
|
18
|
+
export { SliceSimulator } from "./SliceSimulator";
|
|
19
|
+
export type {
|
|
20
|
+
SliceSimulatorProps,
|
|
21
|
+
SliceSimulatorParams,
|
|
22
|
+
} from "./SliceSimulator";
|
|
23
|
+
|
|
24
|
+
export { getSlices } from "./getSlices";
|
|
25
|
+
|
|
18
26
|
export { imgixLoader } from "./imgixLoader";
|
|
19
27
|
|
|
20
28
|
export type { CreateClientConfig } from "./types";
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import
|
|
2
|
-
import { type ReactNode, useEffect } from "react";
|
|
1
|
+
import { getToolbarSrc, cookie as prismicCookie } from "@prismicio/client";
|
|
3
2
|
import { useRouter } from "next/router";
|
|
4
3
|
import Script from "next/script";
|
|
5
|
-
import {
|
|
4
|
+
import type { FC } from "react";
|
|
5
|
+
import { type ReactNode, useEffect } from "react";
|
|
6
6
|
|
|
7
7
|
/** Props for `<PrismicPreview>`. */
|
|
8
8
|
export type PrismicPreviewProps = {
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
import { SliceSimulatorWrapper } from "../SliceSimulatorWrapper";
|
|
2
|
+
import {
|
|
3
|
+
SimulatorManager,
|
|
4
|
+
StateEventType,
|
|
5
|
+
getDefaultMessage,
|
|
6
|
+
getDefaultSlices,
|
|
7
|
+
} from "@prismicio/simulator/kit";
|
|
8
|
+
import type {
|
|
9
|
+
SliceSimulatorProps as BaseSliceSimulatorProps,
|
|
10
|
+
SliceSimulatorState,
|
|
11
|
+
} from "@prismicio/simulator/kit";
|
|
12
|
+
import { useEffect, useState } from "react";
|
|
13
|
+
import type { ComponentType, FC } from "react";
|
|
14
|
+
|
|
15
|
+
const simulatorManager = new SimulatorManager();
|
|
16
|
+
|
|
17
|
+
export type SliceSimulatorSliceZoneProps = {
|
|
18
|
+
slices: SliceSimulatorState["slices"];
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
export type SliceSimulatorProps = BaseSliceSimulatorProps & {
|
|
22
|
+
/**
|
|
23
|
+
* React component to render simulated Slices.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
*
|
|
27
|
+
* ```tsx
|
|
28
|
+
* import { SliceSimulator } from "@slicemachine/adapter-next/simulator";
|
|
29
|
+
* import { SliceZone } from "@prismicio/react";
|
|
30
|
+
*
|
|
31
|
+
* import { components } from "../slices";
|
|
32
|
+
*
|
|
33
|
+
* <SliceSimulator
|
|
34
|
+
* sliceZone={({ slices }) => (
|
|
35
|
+
* <SliceZone slices={slices} components={components} />
|
|
36
|
+
* )}
|
|
37
|
+
* />;
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
sliceZone: ComponentType<SliceSimulatorSliceZoneProps>;
|
|
41
|
+
className?: string;
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Simulate slices in isolation. The slice simulator enables live slice
|
|
46
|
+
* development in Slice Machine and live previews in the Page Builder.
|
|
47
|
+
*/
|
|
48
|
+
export const SliceSimulator: FC<SliceSimulatorProps> = ({
|
|
49
|
+
background,
|
|
50
|
+
zIndex,
|
|
51
|
+
className,
|
|
52
|
+
sliceZone: SliceZoneComp,
|
|
53
|
+
}) => {
|
|
54
|
+
const [slices, setSlices] = useState(() => getDefaultSlices());
|
|
55
|
+
const [message, setMessage] = useState(() => getDefaultMessage());
|
|
56
|
+
|
|
57
|
+
useEffect(() => {
|
|
58
|
+
simulatorManager.state.on(
|
|
59
|
+
StateEventType.Slices,
|
|
60
|
+
(_slices) => {
|
|
61
|
+
setSlices(_slices);
|
|
62
|
+
},
|
|
63
|
+
"simulator-slices",
|
|
64
|
+
);
|
|
65
|
+
simulatorManager.state.on(
|
|
66
|
+
StateEventType.Message,
|
|
67
|
+
(_message) => {
|
|
68
|
+
setMessage(_message);
|
|
69
|
+
},
|
|
70
|
+
"simulator-message",
|
|
71
|
+
);
|
|
72
|
+
|
|
73
|
+
simulatorManager.init();
|
|
74
|
+
|
|
75
|
+
return () => {
|
|
76
|
+
simulatorManager.state.off(StateEventType.Slices, "simulator-slices");
|
|
77
|
+
|
|
78
|
+
simulatorManager.state.off(StateEventType.Message, "simulator-message");
|
|
79
|
+
};
|
|
80
|
+
}, []);
|
|
81
|
+
|
|
82
|
+
return (
|
|
83
|
+
<SliceSimulatorWrapper
|
|
84
|
+
message={message}
|
|
85
|
+
hasSlices={slices.length > 0}
|
|
86
|
+
background={background}
|
|
87
|
+
zIndex={zIndex}
|
|
88
|
+
className={className}
|
|
89
|
+
>
|
|
90
|
+
<SliceZoneComp slices={slices} />
|
|
91
|
+
</SliceSimulatorWrapper>
|
|
92
|
+
);
|
|
93
|
+
};
|
package/src/pages/index.ts
CHANGED
|
@@ -4,6 +4,12 @@ export { type PrismicNextLinkProps } from "../PrismicNextLink";
|
|
|
4
4
|
export { PrismicNextImage } from "../PrismicNextImage";
|
|
5
5
|
export { type PrismicNextImageProps } from "../PrismicNextImage";
|
|
6
6
|
|
|
7
|
+
export { SliceSimulator } from "./SliceSimulator";
|
|
8
|
+
export type {
|
|
9
|
+
SliceSimulatorProps,
|
|
10
|
+
SliceSimulatorSliceZoneProps,
|
|
11
|
+
} from "./SliceSimulator";
|
|
12
|
+
|
|
7
13
|
export { imgixLoader } from "../imgixLoader";
|
|
8
14
|
|
|
9
15
|
export { PrismicPreview } from "./PrismicPreview";
|