@slicemachine/adapter-next 0.0.1 → 0.0.2

package/dist/hooks/slice-read.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"slice-read.cjs","sources":["../../src/hooks/slice-read.ts"],"sourcesContent":["import type { SliceReadHook } from \"@slicemachine/plugin-kit\";\nimport * as prismicT from \"@prismicio/types\";\n\nimport { readJSONFile } from \"../lib/readJSONFile\";\nimport { pascalCase } from \"../lib/pascalCase\";\n\nimport type { PluginOptions } from \"../types\";\n\nexport const sliceRead: SliceReadHook<PluginOptions> = async (\n\tdata,\n\t{ helpers },\n) => {\n\tconst filePath = helpers.joinPathFromRoot(\n\t\tdata.libraryID,\n\t\tpascalCase(data.sliceID),\n\t\t\"model.json\",\n\t);\n\n\tconst model = await readJSONFile<prismicT.SharedSliceModel>(filePath);\n\n\treturn {\n\t\tmodel,\n\t};\n};\n"],"names":["pascalCase","readJSONFile"],"mappings":";;;;AAQO,MAAM,YAA0C,OACtD,MACA,EAAE,cACC;AACG,QAAA,WAAW,QAAQ,iBACxB,KAAK,WACLA,WAAW,WAAA,KAAK,OAAO,GACvB,YAAY;AAGP,QAAA,QAAQ,MAAMC,0BAAwC,QAAQ;AAE7D,SAAA;AAAA,IACN;AAAA,EAAA;AAEF;;"}

package/dist/hooks/slice-read.d.ts

@@ -0,0 +1,3 @@
+import type { SliceReadHook } from "@slicemachine/plugin-kit";
+import type { PluginOptions } from "../types";
+export declare const sliceRead: SliceReadHook<PluginOptions>;

package/dist/hooks/slice-read.js

@@ -0,0 +1,13 @@
+import { readJSONFile } from "../lib/readJSONFile.js";
+import { pascalCase } from "../lib/pascalCase.js";
+const sliceRead = async (data, { helpers }) => {
+  const filePath = helpers.joinPathFromRoot(data.libraryID, pascalCase(data.sliceID), "model.json");
+  const model = await readJSONFile(filePath);
+  return {
+    model
+  };
+};
+export {
+  sliceRead
+};
+//# sourceMappingURL=slice-read.js.map

package/dist/hooks/slice-read.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"slice-read.js","sources":["../../src/hooks/slice-read.ts"],"sourcesContent":["import type { SliceReadHook } from \"@slicemachine/plugin-kit\";\nimport * as prismicT from \"@prismicio/types\";\n\nimport { readJSONFile } from \"../lib/readJSONFile\";\nimport { pascalCase } from \"../lib/pascalCase\";\n\nimport type { PluginOptions } from \"../types\";\n\nexport const sliceRead: SliceReadHook<PluginOptions> = async (\n\tdata,\n\t{ helpers },\n) => {\n\tconst filePath = helpers.joinPathFromRoot(\n\t\tdata.libraryID,\n\t\tpascalCase(data.sliceID),\n\t\t\"model.json\",\n\t);\n\n\tconst model = await readJSONFile<prismicT.SharedSliceModel>(filePath);\n\n\treturn {\n\t\tmodel,\n\t};\n};\n"],"names":[],"mappings":";;AAQO,MAAM,YAA0C,OACtD,MACA,EAAE,cACC;AACG,QAAA,WAAW,QAAQ,iBACxB,KAAK,WACL,WAAW,KAAK,OAAO,GACvB,YAAY;AAGP,QAAA,QAAQ,MAAM,aAAwC,QAAQ;AAE7D,SAAA;AAAA,IACN;AAAA,EAAA;AAEF;"}

package/dist/hooks/slice-update.cjs

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
+const fs = require("node:fs/promises");
+const path = require("node:path");
+const pascalCase = require("../lib/pascalCase.cjs");
+const upsertGlobalContentTypes = require("../lib/upsertGlobalContentTypes.cjs");
+function _interopNamespace(e) {
+  if (e && e.__esModule)
+    return e;
+  const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
+  if (e) {
+    for (const k in e) {
+      if (k !== "default") {
+        const d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: () => e[k]
+        });
+      }
+    }
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+const fs__namespace = /* @__PURE__ */ _interopNamespace(fs);
+const path__namespace = /* @__PURE__ */ _interopNamespace(path);
+const updateModelFile = async ({ dir, data, helpers, options }) => {
+  const filePath = path__namespace.join(dir, "model.json");
+  let contents = JSON.stringify(data.model);
+  if (options.format) {
+    contents = await helpers.format(contents, filePath);
+  }
+  await fs__namespace.writeFile(filePath, contents);
+};
+const sliceUpdate = async (data, context) => {
+  const dir = context.helpers.joinPathFromRoot(data.libraryID, pascalCase.pascalCase(data.model.id));
+  await updateModelFile({ dir, data, ...context });
+  await upsertGlobalContentTypes.upsertGlobalContentTypes(context);
+};
+exports.sliceUpdate = sliceUpdate;
+//# sourceMappingURL=slice-update.cjs.map

package/dist/hooks/slice-update.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"slice-update.cjs","sources":["../../src/hooks/slice-update.ts"],"sourcesContent":["import type {\n\tSliceMachineContext,\n\tSliceUpdateHook,\n\tSliceUpdateHookData,\n} from \"@slicemachine/plugin-kit\";\nimport * as fs from \"node:fs/promises\";\nimport * as path from \"node:path\";\n\nimport { pascalCase } from \"../lib/pascalCase\";\nimport { upsertGlobalContentTypes } from \"../lib/upsertGlobalContentTypes\";\n\nimport type { PluginOptions } from \"../types\";\n\ntype Args = {\n\tdir: string;\n\tdata: SliceUpdateHookData;\n} & SliceMachineContext<PluginOptions>;\n\nconst updateModelFile = async ({ dir, data, helpers, options }: Args) => {\n\tconst filePath = path.join(dir, \"model.json\");\n\n\tlet contents = JSON.stringify(data.model);\n\n\tif (options.format) {\n\t\tcontents = await helpers.format(contents, filePath);\n\t}\n\n\tawait fs.writeFile(filePath, contents);\n};\n\nexport const sliceUpdate: SliceUpdateHook<PluginOptions> = async (\n\tdata,\n\tcontext,\n) => {\n\tconst dir = context.helpers.joinPathFromRoot(\n\t\tdata.libraryID,\n\t\tpascalCase(data.model.id),\n\t);\n\n\tawait updateModelFile({ dir, data, ...context });\n\n\tawait upsertGlobalContentTypes(context);\n};\n"],"names":["path","fs","pascalCase","upsertGlobalContentTypes"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAkBA,MAAM,kBAAkB,OAAO,EAAE,KAAK,MAAM,SAAS,cAAmB;AACvE,QAAM,WAAWA,gBAAK,KAAK,KAAK,YAAY;AAE5C,MAAI,WAAW,KAAK,UAAU,KAAK,KAAK;AAExC,MAAI,QAAQ,QAAQ;AACnB,eAAW,MAAM,QAAQ,OAAO,UAAU,QAAQ;AAAA,EAClD;AAEK,QAAAC,cAAG,UAAU,UAAU,QAAQ;AACtC;AAEa,MAAA,cAA8C,OAC1D,MACA,YACG;AACG,QAAA,MAAM,QAAQ,QAAQ,iBAC3B,KAAK,WACLC,WAAAA,WAAW,KAAK,MAAM,EAAE,CAAC;AAG1B,QAAM,gBAAgB,EAAE,KAAK,MAAM,GAAG,QAAS,CAAA;AAE/C,QAAMC,yBAAAA,yBAAyB,OAAO;AACvC;;"}

package/dist/hooks/slice-update.d.ts

@@ -0,0 +1,3 @@
+import type { SliceUpdateHook } from "@slicemachine/plugin-kit";
+import type { PluginOptions } from "../types";
+export declare const sliceUpdate: SliceUpdateHook<PluginOptions>;

package/dist/hooks/slice-update.js

@@ -0,0 +1,21 @@
+import * as fs from "node:fs/promises";
+import * as path from "node:path";
+import { pascalCase } from "../lib/pascalCase.js";
+import { upsertGlobalContentTypes } from "../lib/upsertGlobalContentTypes.js";
+const updateModelFile = async ({ dir, data, helpers, options }) => {
+  const filePath = path.join(dir, "model.json");
+  let contents = JSON.stringify(data.model);
+  if (options.format) {
+    contents = await helpers.format(contents, filePath);
+  }
+  await fs.writeFile(filePath, contents);
+};
+const sliceUpdate = async (data, context) => {
+  const dir = context.helpers.joinPathFromRoot(data.libraryID, pascalCase(data.model.id));
+  await updateModelFile({ dir, data, ...context });
+  await upsertGlobalContentTypes(context);
+};
+export {
+  sliceUpdate
+};
+//# sourceMappingURL=slice-update.js.map

package/dist/hooks/slice-update.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"slice-update.js","sources":["../../src/hooks/slice-update.ts"],"sourcesContent":["import type {\n\tSliceMachineContext,\n\tSliceUpdateHook,\n\tSliceUpdateHookData,\n} from \"@slicemachine/plugin-kit\";\nimport * as fs from \"node:fs/promises\";\nimport * as path from \"node:path\";\n\nimport { pascalCase } from \"../lib/pascalCase\";\nimport { upsertGlobalContentTypes } from \"../lib/upsertGlobalContentTypes\";\n\nimport type { PluginOptions } from \"../types\";\n\ntype Args = {\n\tdir: string;\n\tdata: SliceUpdateHookData;\n} & SliceMachineContext<PluginOptions>;\n\nconst updateModelFile = async ({ dir, data, helpers, options }: Args) => {\n\tconst filePath = path.join(dir, \"model.json\");\n\n\tlet contents = JSON.stringify(data.model);\n\n\tif (options.format) {\n\t\tcontents = await helpers.format(contents, filePath);\n\t}\n\n\tawait fs.writeFile(filePath, contents);\n};\n\nexport const sliceUpdate: SliceUpdateHook<PluginOptions> = async (\n\tdata,\n\tcontext,\n) => {\n\tconst dir = context.helpers.joinPathFromRoot(\n\t\tdata.libraryID,\n\t\tpascalCase(data.model.id),\n\t);\n\n\tawait updateModelFile({ dir, data, ...context });\n\n\tawait upsertGlobalContentTypes(context);\n};\n"],"names":[],"mappings":";;;;AAkBA,MAAM,kBAAkB,OAAO,EAAE,KAAK,MAAM,SAAS,cAAmB;AACvE,QAAM,WAAW,KAAK,KAAK,KAAK,YAAY;AAE5C,MAAI,WAAW,KAAK,UAAU,KAAK,KAAK;AAExC,MAAI,QAAQ,QAAQ;AACnB,eAAW,MAAM,QAAQ,OAAO,UAAU,QAAQ;AAAA,EAClD;AAEK,QAAA,GAAG,UAAU,UAAU,QAAQ;AACtC;AAEa,MAAA,cAA8C,OAC1D,MACA,YACG;AACG,QAAA,MAAM,QAAQ,QAAQ,iBAC3B,KAAK,WACL,WAAW,KAAK,MAAM,EAAE,CAAC;AAG1B,QAAM,gBAAgB,EAAE,KAAK,MAAM,GAAG,QAAS,CAAA;AAE/C,QAAM,yBAAyB,OAAO;AACvC;"}

package/dist/hooks/sliceLibrary-read.cjs

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
+const prismicT = require("@prismicio/types");
+const fs = require("node:fs/promises");
+const path = require("node:path");
+const readJSONFile = require("../lib/readJSONFile.cjs");
+function _interopNamespace(e) {
+  if (e && e.__esModule)
+    return e;
+  const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
+  if (e) {
+    for (const k in e) {
+      if (k !== "default") {
+        const d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: () => e[k]
+        });
+      }
+    }
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+const prismicT__namespace = /* @__PURE__ */ _interopNamespace(prismicT);
+const fs__namespace = /* @__PURE__ */ _interopNamespace(fs);
+const path__namespace = /* @__PURE__ */ _interopNamespace(path);
+const isSharedSliceModel = (input) => {
+  return typeof input === "object" && input !== null && "type" in input && input.type === prismicT__namespace.CustomTypeModelSliceType.SharedSlice;
+};
+const sliceLibraryRead = async (data, { helpers }) => {
+  const dirPath = helpers.joinPathFromRoot(data.libraryID);
+  await fs__namespace.mkdir(dirPath, { recursive: true });
+  const childDirs = await fs__namespace.readdir(dirPath);
+  const sliceIDs = [];
+  await Promise.all(childDirs.map(async (childDir) => {
+    const modelPath = path__namespace.join(dirPath, childDir, "model.json");
+    try {
+      const modelContents = await readJSONFile.readJSONFile(modelPath);
+      if (isSharedSliceModel(modelContents)) {
+        sliceIDs.push(modelContents.id);
+      }
+    } catch {
+    }
+  }));
+  return {
+    id: data.libraryID,
+    sliceIDs: sliceIDs.sort()
+  };
+};
+exports.sliceLibraryRead = sliceLibraryRead;
+//# sourceMappingURL=sliceLibrary-read.cjs.map

package/dist/hooks/sliceLibrary-read.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sliceLibrary-read.cjs","sources":["../../src/hooks/sliceLibrary-read.ts"],"sourcesContent":["import type { SliceLibraryReadHook } from \"@slicemachine/plugin-kit\";\nimport * as prismicT from \"@prismicio/types\";\nimport * as fs from \"node:fs/promises\";\nimport * as path from \"node:path\";\n\nimport { readJSONFile } from \"../lib/readJSONFile\";\n\nimport type { PluginOptions } from \"../types\";\n\nconst isSharedSliceModel = (\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tinput: any,\n): input is prismicT.SharedSliceModel => {\n\treturn (\n\t\ttypeof input === \"object\" &&\n\t\tinput !== null &&\n\t\t\"type\" in input &&\n\t\tinput.type === prismicT.CustomTypeModelSliceType.SharedSlice\n\t);\n};\n\nexport const sliceLibraryRead: SliceLibraryReadHook<PluginOptions> = async (\n\tdata,\n\t{ helpers },\n) => {\n\tconst dirPath = helpers.joinPathFromRoot(data.libraryID);\n\n\t// Ensure the directory exists.\n\tawait fs.mkdir(dirPath, { recursive: true });\n\n\tconst childDirs = await fs.readdir(dirPath);\n\n\tconst sliceIDs: string[] = [];\n\tawait Promise.all(\n\t\tchildDirs.map(async (childDir) => {\n\t\t\tconst modelPath = path.join(dirPath, childDir, \"model.json\");\n\n\t\t\ttry {\n\t\t\t\tconst modelContents = await readJSONFile(modelPath);\n\n\t\t\t\tif (isSharedSliceModel(modelContents)) {\n\t\t\t\t\tsliceIDs.push(modelContents.id);\n\t\t\t\t}\n\t\t\t} catch {\n\t\t\t\t// noop\n\t\t\t}\n\t\t}),\n\t);\n\n\treturn {\n\t\tid: data.libraryID,\n\t\tsliceIDs: sliceIDs.sort(),\n\t};\n};\n"],"names":["prismicT","fs","path","readJSONFile"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AASA,MAAM,qBAAqB,CAE1B,UACuC;AAEtC,SAAA,OAAO,UAAU,YACjB,UAAU,QACV,UAAU,SACV,MAAM,SAASA,oBAAS,yBAAyB;AAEnD;AAEO,MAAM,mBAAwD,OACpE,MACA,EAAE,cACC;AACH,QAAM,UAAU,QAAQ,iBAAiB,KAAK,SAAS;AAGvD,QAAMC,cAAG,MAAM,SAAS,EAAE,WAAW,MAAM;AAE3C,QAAM,YAAY,MAAMA,cAAG,QAAQ,OAAO;AAE1C,QAAM,WAAqB,CAAA;AAC3B,QAAM,QAAQ,IACb,UAAU,IAAI,OAAO,aAAY;AAChC,UAAM,YAAYC,gBAAK,KAAK,SAAS,UAAU,YAAY;AAEvD,QAAA;AACG,YAAA,gBAAgB,MAAMC,0BAAa,SAAS;AAE9C,UAAA,mBAAmB,aAAa,GAAG;AAC7B,iBAAA,KAAK,cAAc,EAAE;AAAA,MAC9B;AAAA,IAAA,QACA;AAAA,IAED;AAAA,EACD,CAAA,CAAC;AAGI,SAAA;AAAA,IACN,IAAI,KAAK;AAAA,IACT,UAAU,SAAS,KAAM;AAAA,EAAA;AAE3B;;"}

package/dist/hooks/sliceLibrary-read.d.ts

@@ -0,0 +1,3 @@
+import type { SliceLibraryReadHook } from "@slicemachine/plugin-kit";
+import type { PluginOptions } from "../types";
+export declare const sliceLibraryRead: SliceLibraryReadHook<PluginOptions>;

package/dist/hooks/sliceLibrary-read.js

@@ -0,0 +1,31 @@
+import * as prismicT from "@prismicio/types";
+import * as fs from "node:fs/promises";
+import * as path from "node:path";
+import { readJSONFile } from "../lib/readJSONFile.js";
+const isSharedSliceModel = (input) => {
+  return typeof input === "object" && input !== null && "type" in input && input.type === prismicT.CustomTypeModelSliceType.SharedSlice;
+};
+const sliceLibraryRead = async (data, { helpers }) => {
+  const dirPath = helpers.joinPathFromRoot(data.libraryID);
+  await fs.mkdir(dirPath, { recursive: true });
+  const childDirs = await fs.readdir(dirPath);
+  const sliceIDs = [];
+  await Promise.all(childDirs.map(async (childDir) => {
+    const modelPath = path.join(dirPath, childDir, "model.json");
+    try {
+      const modelContents = await readJSONFile(modelPath);
+      if (isSharedSliceModel(modelContents)) {
+        sliceIDs.push(modelContents.id);
+      }
+    } catch {
+    }
+  }));
+  return {
+    id: data.libraryID,
+    sliceIDs: sliceIDs.sort()
+  };
+};
+export {
+  sliceLibraryRead
+};
+//# sourceMappingURL=sliceLibrary-read.js.map

package/dist/hooks/sliceLibrary-read.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sliceLibrary-read.js","sources":["../../src/hooks/sliceLibrary-read.ts"],"sourcesContent":["import type { SliceLibraryReadHook } from \"@slicemachine/plugin-kit\";\nimport * as prismicT from \"@prismicio/types\";\nimport * as fs from \"node:fs/promises\";\nimport * as path from \"node:path\";\n\nimport { readJSONFile } from \"../lib/readJSONFile\";\n\nimport type { PluginOptions } from \"../types\";\n\nconst isSharedSliceModel = (\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tinput: any,\n): input is prismicT.SharedSliceModel => {\n\treturn (\n\t\ttypeof input === \"object\" &&\n\t\tinput !== null &&\n\t\t\"type\" in input &&\n\t\tinput.type === prismicT.CustomTypeModelSliceType.SharedSlice\n\t);\n};\n\nexport const sliceLibraryRead: SliceLibraryReadHook<PluginOptions> = async (\n\tdata,\n\t{ helpers },\n) => {\n\tconst dirPath = helpers.joinPathFromRoot(data.libraryID);\n\n\t// Ensure the directory exists.\n\tawait fs.mkdir(dirPath, { recursive: true });\n\n\tconst childDirs = await fs.readdir(dirPath);\n\n\tconst sliceIDs: string[] = [];\n\tawait Promise.all(\n\t\tchildDirs.map(async (childDir) => {\n\t\t\tconst modelPath = path.join(dirPath, childDir, \"model.json\");\n\n\t\t\ttry {\n\t\t\t\tconst modelContents = await readJSONFile(modelPath);\n\n\t\t\t\tif (isSharedSliceModel(modelContents)) {\n\t\t\t\t\tsliceIDs.push(modelContents.id);\n\t\t\t\t}\n\t\t\t} catch {\n\t\t\t\t// noop\n\t\t\t}\n\t\t}),\n\t);\n\n\treturn {\n\t\tid: data.libraryID,\n\t\tsliceIDs: sliceIDs.sort(),\n\t};\n};\n"],"names":[],"mappings":";;;;AASA,MAAM,qBAAqB,CAE1B,UACuC;AAEtC,SAAA,OAAO,UAAU,YACjB,UAAU,QACV,UAAU,SACV,MAAM,SAAS,SAAS,yBAAyB;AAEnD;AAEO,MAAM,mBAAwD,OACpE,MACA,EAAE,cACC;AACH,QAAM,UAAU,QAAQ,iBAAiB,KAAK,SAAS;AAGvD,QAAM,GAAG,MAAM,SAAS,EAAE,WAAW,MAAM;AAE3C,QAAM,YAAY,MAAM,GAAG,QAAQ,OAAO;AAE1C,QAAM,WAAqB,CAAA;AAC3B,QAAM,QAAQ,IACb,UAAU,IAAI,OAAO,aAAY;AAChC,UAAM,YAAY,KAAK,KAAK,SAAS,UAAU,YAAY;AAEvD,QAAA;AACG,YAAA,gBAAgB,MAAM,aAAa,SAAS;AAE9C,UAAA,mBAAmB,aAAa,GAAG;AAC7B,iBAAA,KAAK,cAAc,EAAE;AAAA,MAC9B;AAAA,IAAA,QACA;AAAA,IAED;AAAA,EACD,CAAA,CAAC;AAGI,SAAA;AAAA,IACN,IAAI,KAAK;AAAA,IACT,UAAU,SAAS,KAAM;AAAA,EAAA;AAE3B;"}

package/dist/hooks/sliceSimulator-setup-read.cjs

@@ -0,0 +1,217 @@
+"use strict";
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
+const pluginKit = require("@slicemachine/plugin-kit");
+const commonTags = require("common-tags");
+const node_module = require("node:module");
+const http = require("node:http");
+const getJSOrTSXFileExtension = require("../lib/getJSOrTSXFileExtension.cjs");
+function _interopNamespace(e) {
+  if (e && e.__esModule)
+    return e;
+  const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
+  if (e) {
+    for (const k in e) {
+      if (k !== "default") {
+        const d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: () => e[k]
+        });
+      }
+    }
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+const http__namespace = /* @__PURE__ */ _interopNamespace(http);
+const REQUIRED_DEPENDENCIES = [
+  "@prismicio/react",
+  "@prismicio/slice-simulator-react",
+  "@prismicio/client@latest",
+  "@prismicio/helpers"
+];
+const createStep1 = async ({ project }) => {
+  const require2 = node_module.createRequire(project.root);
+  return {
+    title: "Install packages",
+    body: commonTags.stripIndent`
+			The simulator requires extra dependencies. Run the following command to install them.
+
+			~~~sh
+			npm install --save @prismicio/react @prismicio/slice-simulator-react @prismicio/client@latest @prismicio/helpers
+			~~~
+		`,
+    validate: async () => {
+      const missingDependencies = [];
+      for (const dependency of REQUIRED_DEPENDENCIES) {
+        try {
+          require2.resolve(dependency);
+        } catch {
+          missingDependencies.push(dependency);
+        }
+      }
+      if (missingDependencies.length >= REQUIRED_DEPENDENCIES.length) {
+        return {
+          type: pluginKit.SliceSimulatorSetupStepValidationMessageType.Error,
+          title: "Missing all dependencies",
+          message: commonTags.stripIndent`
+						Install the required dependencies to continue.
+					`
+        };
+      }
+      if (missingDependencies.length > 0) {
+        const formattedMissingDependencies = missingDependencies.map((missingDependency) => `\`${missingDependency}\``).join(", ");
+        return {
+          type: pluginKit.SliceSimulatorSetupStepValidationMessageType.Warning,
+          title: "Missing some dependencies",
+          message: commonTags.stripIndent`
+						The following dependencies are missing: ${formattedMissingDependencies}
+					`
+        };
+      }
+    }
+  };
+};
+const createStep2 = async ({ helpers, options }) => {
+  const fileName = `slice-simulator.${getJSOrTSXFileExtension.getJSOrTSXFileExtension}`;
+  const filePath = helpers.joinPathFromRoot("pages", fileName);
+  let fileContents;
+  if (options.typescript) {
+    fileContents = commonTags.stripIndent`
+			import { GetStaticProps } from "next/types";
+			import { SliceSimulator } from "@prismicio/slice-simulator-react";
+			import { SliceZone } from "@prismicio/react";
+
+			import state from "../.slicemachine/libraries-state.json";
+			import { components } from "../slices";
+
+			const SliceSimulatorPage = () => {
+				return (
+					<SliceSimulator
+						sliceZone={(props) => <SliceZone {...props} components={components} />}
+						state={state}
+					/>
+				);
+			};
+
+			export default SliceSimulatorPage;
+
+			export const getStaticProps: GetStaticProps = () => {
+				return {
+					// Exclude this page from production builds.
+					notFound: process.env.NODE_ENV === "production",
+				};
+			};
+		`;
+  } else {
+    fileContents = commonTags.stripIndent`
+			import { SliceSimulator } from "@prismicio/slice-simulator-react";
+			import { SliceZone } from "@prismicio/react";
+
+			import state from "../.slicemachine/libraries-state.json";
+			import { components } from "../slices";
+
+			const SliceSimulatorPage = () => {
+				return (
+					<SliceSimulator
+						sliceZone={(props) => <SliceZone {...props} components={components} />}
+						state={state}
+					/>
+				);
+			};
+
+			export default SliceSimulatorPage;
+
+			export const getStaticProps= () => {
+				return {
+					// Exclude this page from production builds.
+					notFound: process.env.NODE_ENV === "production",
+				};
+			};
+		`;
+  }
+  fileContents = await helpers.format(fileContents, filePath);
+  return {
+    title: "Create a page for the simulator",
+    body: commonTags.stripIndent`
+			In your \`pages\` directory, create a file called \`${fileName}\` and add the following code. This route will be used to simulate and develop your components.
+
+			~~~tsx
+			${fileContents}
+			~~~
+		`
+  };
+};
+const createStep3 = async ({ helpers }) => {
+  const filePath = helpers.joinPathFromRoot("sm.json");
+  const fileContents = await helpers.format(`
+			{
+				"localSliceSimulatorURL": "http://localhost:3000/slice-simulator"
+			}
+		`, filePath);
+  return {
+    title: "Update `sm.json`",
+    body: commonTags.stripIndent`
+			Update your \`sm.json\` file with a \`localSliceSimulatorURL\` property pointing to your \`slice-simulator\` page.
+
+			~~~json
+			${fileContents}
+			~~~
+		`,
+    validate: async () => {
+      const project = await helpers.getProject();
+      if (!("localSliceSimulatorURL" in project.config)) {
+        return {
+          type: pluginKit.SliceSimulatorSetupStepValidationMessageType.Error,
+          title: "Missing `localSliceSimulatorURL` property",
+          message: commonTags.stripIndent`
+						A \`localSliceSimulatorURL\` property was not found in your \`sm.json\` file.
+					`
+        };
+      }
+      try {
+        if (project.config.localSliceSimulatorURL) {
+          new URL(project.config.localSliceSimulatorURL);
+        } else {
+          throw new Error("Undefined Slice Simulator URL");
+        }
+      } catch {
+        return {
+          type: pluginKit.SliceSimulatorSetupStepValidationMessageType.Warning,
+          title: "An invalid URL was provided",
+          message: commonTags.stripIndent`
+						The \`localSliceSimulatorURL\` property should be of the shape \`http://localhost:PORT/PATH\`. See the codeblock for an example.
+					`
+        };
+      }
+      const ok = await new Promise((resolve) => {
+        if (project.config.localSliceSimulatorURL) {
+          http__namespace.get(project.config.localSliceSimulatorURL, (res) => {
+            if (res.statusCode) {
+              resolve(res.statusCode >= 200 && res.statusCode < 300);
+            }
+          });
+        }
+        resolve(false);
+      });
+      if (!ok) {
+        return {
+          type: pluginKit.SliceSimulatorSetupStepValidationMessageType.Warning,
+          title: "Unable to connect to simulator page",
+          message: commonTags.stripIndent`
+						Check that the \`localSliceSimulatorURL\` property in \`sm.json\` is correct and try again. See the [troubleshooting page](https://prismic.io/docs/technologies/setup-slice-simulator-nextjs) for more details.
+					`
+        };
+      }
+    }
+  };
+};
+const sliceSimulatorSetupRead = async (_data, context) => {
+  return Promise.all([
+    createStep1(context),
+    createStep2(context),
+    createStep3(context)
+  ]);
+};
+exports.sliceSimulatorSetupRead = sliceSimulatorSetupRead;
+//# sourceMappingURL=sliceSimulator-setup-read.cjs.map

package/dist/hooks/sliceSimulator-setup-read.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sliceSimulator-setup-read.cjs","sources":["../../src/hooks/sliceSimulator-setup-read.ts"],"sourcesContent":["import type {\n\tSliceMachineContext,\n\tSliceSimulatorSetupReadHook,\n\tSliceSimulatorSetupStep,\n} from \"@slicemachine/plugin-kit\";\nimport { SliceSimulatorSetupStepValidationMessageType } from \"@slicemachine/plugin-kit\";\nimport { stripIndent } from \"common-tags\";\nimport { createRequire } from \"node:module\";\nimport * as http from \"node:http\";\n\nimport { getJSOrTSXFileExtension } from \"../lib/getJSOrTSXFileExtension\";\n\nimport type { PluginOptions } from \"../types\";\n\nconst REQUIRED_DEPENDENCIES = [\n\t\"@prismicio/react\",\n\t\"@prismicio/slice-simulator-react\",\n\t\"@prismicio/client@latest\",\n\t\"@prismicio/helpers\",\n];\n\ntype Args = SliceMachineContext<PluginOptions>;\n\nconst createStep1 = async ({\n\tproject,\n}: Args): Promise<SliceSimulatorSetupStep> => {\n\tconst require = createRequire(project.root);\n\n\treturn {\n\t\ttitle: \"Install packages\",\n\t\tbody: stripIndent`\n\t\t\tThe simulator requires extra dependencies. Run the following command to install them.\n\n\t\t\t~~~sh\n\t\t\tnpm install --save @prismicio/react @prismicio/slice-simulator-react @prismicio/client@latest @prismicio/helpers\n\t\t\t~~~\n\t\t`,\n\t\tvalidate: async () => {\n\t\t\tconst missingDependencies: string[] = [];\n\n\t\t\tfor (const dependency of REQUIRED_DEPENDENCIES) {\n\t\t\t\ttry {\n\t\t\t\t\t// `require.resolve()` is preferred\n\t\t\t\t\t// over `import()` because we don't\n\t\t\t\t\t// want to load the module. Loading a\n\t\t\t\t\t// module could introduce side-effects.\n\t\t\t\t\trequire.resolve(dependency);\n\t\t\t\t} catch {\n\t\t\t\t\tmissingDependencies.push(dependency);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (missingDependencies.length >= REQUIRED_DEPENDENCIES.length) {\n\t\t\t\treturn {\n\t\t\t\t\ttype: SliceSimulatorSetupStepValidationMessageType.Error,\n\t\t\t\t\ttitle: \"Missing all dependencies\",\n\t\t\t\t\tmessage: stripIndent`\n\t\t\t\t\t\tInstall the required dependencies to continue.\n\t\t\t\t\t`,\n\t\t\t\t};\n\t\t\t}\n\n\t\t\tif (missingDependencies.length > 0) {\n\t\t\t\tconst formattedMissingDependencies = missingDependencies\n\t\t\t\t\t.map((missingDependency) => `\\`${missingDependency}\\``)\n\t\t\t\t\t.join(\", \");\n\n\t\t\t\treturn {\n\t\t\t\t\ttype: SliceSimulatorSetupStepValidationMessageType.Warning,\n\t\t\t\t\ttitle: \"Missing some dependencies\",\n\t\t\t\t\tmessage: stripIndent`\n\t\t\t\t\t\tThe following dependencies are missing: ${formattedMissingDependencies}\n\t\t\t\t\t`,\n\t\t\t\t};\n\t\t\t}\n\t\t},\n\t};\n};\n\nconst createStep2 = async ({\n\thelpers,\n\toptions,\n}: Args): Promise<SliceSimulatorSetupStep> => {\n\tconst fileName = `slice-simulator.${getJSOrTSXFileExtension}`;\n\tconst filePath = helpers.joinPathFromRoot(\"pages\", fileName);\n\n\tlet fileContents: string;\n\n\tif (options.typescript) {\n\t\tfileContents = stripIndent`\n\t\t\timport { GetStaticProps } from \"next/types\";\n\t\t\timport { SliceSimulator } from \"@prismicio/slice-simulator-react\";\n\t\t\timport { SliceZone } from \"@prismicio/react\";\n\n\t\t\timport state from \"../.slicemachine/libraries-state.json\";\n\t\t\timport { components } from \"../slices\";\n\n\t\t\tconst SliceSimulatorPage = () => {\n\t\t\t\treturn (\n\t\t\t\t\t<SliceSimulator\n\t\t\t\t\t\tsliceZone={(props) => <SliceZone {...props} components={components} />}\n\t\t\t\t\t\tstate={state}\n\t\t\t\t\t/>\n\t\t\t\t);\n\t\t\t};\n\n\t\t\texport default SliceSimulatorPage;\n\n\t\t\texport const getStaticProps: GetStaticProps = () => {\n\t\t\t\treturn {\n\t\t\t\t\t// Exclude this page from production builds.\n\t\t\t\t\tnotFound: process.env.NODE_ENV === \"production\",\n\t\t\t\t};\n\t\t\t};\n\t\t`;\n\t} else {\n\t\tfileContents = stripIndent`\n\t\t\timport { SliceSimulator } from \"@prismicio/slice-simulator-react\";\n\t\t\timport { SliceZone } from \"@prismicio/react\";\n\n\t\t\timport state from \"../.slicemachine/libraries-state.json\";\n\t\t\timport { components } from \"../slices\";\n\n\t\t\tconst SliceSimulatorPage = () => {\n\t\t\t\treturn (\n\t\t\t\t\t<SliceSimulator\n\t\t\t\t\t\tsliceZone={(props) => <SliceZone {...props} components={components} />}\n\t\t\t\t\t\tstate={state}\n\t\t\t\t\t/>\n\t\t\t\t);\n\t\t\t};\n\n\t\t\texport default SliceSimulatorPage;\n\n\t\t\texport const getStaticProps= () => {\n\t\t\t\treturn {\n\t\t\t\t\t// Exclude this page from production builds.\n\t\t\t\t\tnotFound: process.env.NODE_ENV === \"production\",\n\t\t\t\t};\n\t\t\t};\n\t\t`;\n\t}\n\n\tfileContents = await helpers.format(fileContents, filePath);\n\n\treturn {\n\t\ttitle: \"Create a page for the simulator\",\n\t\tbody: stripIndent`\n\t\t\tIn your \\`pages\\` directory, create a file called \\`${fileName}\\` and add the following code. This route will be used to simulate and develop your components.\n\n\t\t\t~~~tsx\n\t\t\t${fileContents}\n\t\t\t~~~\n\t\t`,\n\t};\n};\n\nconst createStep3 = async ({\n\thelpers,\n}: Args): Promise<SliceSimulatorSetupStep> => {\n\tconst filePath = helpers.joinPathFromRoot(\"sm.json\");\n\tconst fileContents = await helpers.format(\n\t\t`\n\t\t\t{\n\t\t\t\t\"localSliceSimulatorURL\": \"http://localhost:3000/slice-simulator\"\n\t\t\t}\n\t\t`,\n\t\tfilePath,\n\t);\n\n\treturn {\n\t\ttitle: \"Update `sm.json`\",\n\t\tbody: stripIndent`\n\t\t\tUpdate your \\`sm.json\\` file with a \\`localSliceSimulatorURL\\` property pointing to your \\`slice-simulator\\` page.\n\n\t\t\t~~~json\n\t\t\t${fileContents}\n\t\t\t~~~\n\t\t`,\n\t\tvalidate: async () => {\n\t\t\tconst project = await helpers.getProject();\n\n\t\t\tif (!(\"localSliceSimulatorURL\" in project.config)) {\n\t\t\t\treturn {\n\t\t\t\t\ttype: SliceSimulatorSetupStepValidationMessageType.Error,\n\t\t\t\t\ttitle: \"Missing `localSliceSimulatorURL` property\",\n\t\t\t\t\tmessage: stripIndent`\n\t\t\t\t\t\tA \\`localSliceSimulatorURL\\` property was not found in your \\`sm.json\\` file.\n\t\t\t\t\t`,\n\t\t\t\t};\n\t\t\t}\n\n\t\t\t// Test if the URL is valid.\n\t\t\ttry {\n\t\t\t\tif (project.config.localSliceSimulatorURL) {\n\t\t\t\t\tnew URL(project.config.localSliceSimulatorURL);\n\t\t\t\t} else {\n\t\t\t\t\tthrow new Error(\"Undefined Slice Simulator URL\");\n\t\t\t\t}\n\t\t\t} catch {\n\t\t\t\treturn {\n\t\t\t\t\ttype: SliceSimulatorSetupStepValidationMessageType.Warning,\n\t\t\t\t\ttitle: \"An invalid URL was provided\",\n\t\t\t\t\tmessage: stripIndent`\n\t\t\t\t\t\tThe \\`localSliceSimulatorURL\\` property should be of the shape \\`http://localhost:PORT/PATH\\`. See the codeblock for an example.\n\t\t\t\t\t`,\n\t\t\t\t};\n\t\t\t}\n\n\t\t\t// Check if the URL is accessible.\n\t\t\tconst ok = await new Promise<boolean>((resolve) => {\n\t\t\t\tif (project.config.localSliceSimulatorURL) {\n\t\t\t\t\thttp.get(project.config.localSliceSimulatorURL, (res) => {\n\t\t\t\t\t\tif (res.statusCode) {\n\t\t\t\t\t\t\tresolve(res.statusCode >= 200 && res.statusCode < 300);\n\t\t\t\t\t\t}\n\t\t\t\t\t});\n\t\t\t\t}\n\n\t\t\t\tresolve(false);\n\t\t\t});\n\n\t\t\tif (!ok) {\n\t\t\t\treturn {\n\t\t\t\t\ttype: SliceSimulatorSetupStepValidationMessageType.Warning,\n\t\t\t\t\ttitle: \"Unable to connect to simulator page\",\n\t\t\t\t\tmessage: stripIndent`\n\t\t\t\t\t\tCheck that the \\`localSliceSimulatorURL\\` property in \\`sm.json\\` is correct and try again. See the [troubleshooting page](https://prismic.io/docs/technologies/setup-slice-simulator-nextjs) for more details.\n\t\t\t\t\t`,\n\t\t\t\t};\n\t\t\t}\n\t\t},\n\t};\n};\n\nexport const sliceSimulatorSetupRead: SliceSimulatorSetupReadHook<\n\tPluginOptions\n> = async (_data, context) => {\n\treturn Promise.all([\n\t\tcreateStep1(context),\n\t\tcreateStep2(context),\n\t\tcreateStep3(context),\n\t]);\n};\n"],"names":["require","createRequire","stripIndent","SliceSimulatorSetupStepValidationMessageType","getJSOrTSXFileExtension","http"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAcA,MAAM,wBAAwB;AAAA,EAC7B;AAAA,EACA;AAAA,EACA;AAAA,EACA;;AAKD,MAAM,cAAc,OAAO,EAC1B,cAC4C;AACtC,QAAAA,WAAUC,YAAAA,cAAc,QAAQ,IAAI;AAEnC,SAAA;AAAA,IACN,OAAO;AAAA,IACP,MAAMC,WAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA,IAON,UAAU,YAAW;AACpB,YAAM,sBAAgC,CAAA;AAEtC,iBAAW,cAAc,uBAAuB;AAC3C,YAAA;AAKH,UAAAF,SAAQ,QAAQ,UAAU;AAAA,QAAA,QACzB;AACD,8BAAoB,KAAK,UAAU;AAAA,QACnC;AAAA,MACD;AAEG,UAAA,oBAAoB,UAAU,sBAAsB,QAAQ;AACxD,eAAA;AAAA,UACN,MAAMG,UAA6C,6CAAA;AAAA,UACnD,OAAO;AAAA,UACP,SAASD,WAAAA;AAAAA;AAAAA;AAAAA,QAAA;AAAA,MAIV;AAEG,UAAA,oBAAoB,SAAS,GAAG;AAC7B,cAAA,+BAA+B,oBACnC,IAAI,CAAC,sBAAsB,KAAK,qBAAqB,EACrD,KAAK,IAAI;AAEJ,eAAA;AAAA,UACN,MAAMC,UAA6C,6CAAA;AAAA,UACnD,OAAO;AAAA,UACP,SAASD,WAAAA;AAAAA,gDACkC;AAAA;AAAA,QAAA;AAAA,MAG5C;AAAA,IACF;AAAA,EAAA;AAEF;AAEA,MAAM,cAAc,OAAO,EAC1B,SACA,cAC4C;AAC5C,QAAM,WAAW,mBAAmBE,wBAAAA;AACpC,QAAM,WAAW,QAAQ,iBAAiB,SAAS,QAAQ;AAEvD,MAAA;AAEJ,MAAI,QAAQ,YAAY;AACR,mBAAAF,WAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA,EAAA,OA0BT;AACS,mBAAAA,WAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA,EAyBf;AAED,iBAAe,MAAM,QAAQ,OAAO,cAAc,QAAQ;AAEnD,SAAA;AAAA,IACN,OAAO;AAAA,IACP,MAAMA,WAAAA;AAAAA,yDACiD;AAAA;AAAA;AAAA,KAGpD;AAAA;AAAA;AAAA,EAAA;AAIL;AAEA,MAAM,cAAc,OAAO,EAC1B,cAC4C;AACtC,QAAA,WAAW,QAAQ,iBAAiB,SAAS;AAC7C,QAAA,eAAe,MAAM,QAAQ,OAClC;AAAA;AAAA;AAAA;AAAA,KAKA,QAAQ;AAGF,SAAA;AAAA,IACN,OAAO;AAAA,IACP,MAAMA,WAAAA;AAAAA;AAAAA;AAAAA;AAAAA,KAIH;AAAA;AAAA;AAAA,IAGH,UAAU,YAAW;AACd,YAAA,UAAU,MAAM,QAAQ;AAE1B,UAAA,EAAE,4BAA4B,QAAQ,SAAS;AAC3C,eAAA;AAAA,UACN,MAAMC,UAA6C,6CAAA;AAAA,UACnD,OAAO;AAAA,UACP,SAASD,WAAAA;AAAAA;AAAAA;AAAAA,QAAA;AAAA,MAIV;AAGG,UAAA;AACC,YAAA,QAAQ,OAAO,wBAAwB;AACtC,cAAA,IAAI,QAAQ,OAAO,sBAAsB;AAAA,QAAA,OACvC;AACA,gBAAA,IAAI,MAAM,+BAA+B;AAAA,QAC/C;AAAA,MAAA,QACA;AACM,eAAA;AAAA,UACN,MAAMC,UAA6C,6CAAA;AAAA,UACnD,OAAO;AAAA,UACP,SAASD,WAAAA;AAAAA;AAAAA;AAAAA,QAAA;AAAA,MAIV;AAGD,YAAM,KAAK,MAAM,IAAI,QAAiB,CAAC,YAAW;AAC7C,YAAA,QAAQ,OAAO,wBAAwB;AAC1CG,0BAAK,IAAI,QAAQ,OAAO,wBAAwB,CAAC,QAAO;AACvD,gBAAI,IAAI,YAAY;AACnB,sBAAQ,IAAI,cAAc,OAAO,IAAI,aAAa,GAAG;AAAA,YACrD;AAAA,UAAA,CACD;AAAA,QACD;AAED,gBAAQ,KAAK;AAAA,MAAA,CACb;AAED,UAAI,CAAC,IAAI;AACD,eAAA;AAAA,UACN,MAAMF,UAA6C,6CAAA;AAAA,UACnD,OAAO;AAAA,UACP,SAASD,WAAAA;AAAAA;AAAAA;AAAAA,QAAA;AAAA,MAIV;AAAA,IACF;AAAA,EAAA;AAEF;AAEa,MAAA,0BAET,OAAO,OAAO,YAAW;AAC5B,SAAO,QAAQ,IAAI;AAAA,IAClB,YAAY,OAAO;AAAA,IACnB,YAAY,OAAO;AAAA,IACnB,YAAY,OAAO;AAAA,EAAA,CACnB;AACF;;"}

package/dist/hooks/sliceSimulator-setup-read.d.ts

@@ -0,0 +1,3 @@
+import type { SliceSimulatorSetupReadHook } from "@slicemachine/plugin-kit";
+import type { PluginOptions } from "../types";
+export declare const sliceSimulatorSetupRead: SliceSimulatorSetupReadHook<PluginOptions>;

package/dist/hooks/sliceSimulator-setup-read.js

@@ -0,0 +1,198 @@
+import { SliceSimulatorSetupStepValidationMessageType } from "@slicemachine/plugin-kit";
+import { stripIndent } from "common-tags";
+import { createRequire } from "node:module";
+import * as http from "node:http";
+import { getJSOrTSXFileExtension } from "../lib/getJSOrTSXFileExtension.js";
+const REQUIRED_DEPENDENCIES = [
+  "@prismicio/react",
+  "@prismicio/slice-simulator-react",
+  "@prismicio/client@latest",
+  "@prismicio/helpers"
+];
+const createStep1 = async ({ project }) => {
+  const require2 = createRequire(project.root);
+  return {
+    title: "Install packages",
+    body: stripIndent`
+			The simulator requires extra dependencies. Run the following command to install them.
+
+			~~~sh
+			npm install --save @prismicio/react @prismicio/slice-simulator-react @prismicio/client@latest @prismicio/helpers
+			~~~
+		`,
+    validate: async () => {
+      const missingDependencies = [];
+      for (const dependency of REQUIRED_DEPENDENCIES) {
+        try {
+          require2.resolve(dependency);
+        } catch {
+          missingDependencies.push(dependency);
+        }
+      }
+      if (missingDependencies.length >= REQUIRED_DEPENDENCIES.length) {
+        return {
+          type: SliceSimulatorSetupStepValidationMessageType.Error,
+          title: "Missing all dependencies",
+          message: stripIndent`
+						Install the required dependencies to continue.
+					`
+        };
+      }
+      if (missingDependencies.length > 0) {
+        const formattedMissingDependencies = missingDependencies.map((missingDependency) => `\`${missingDependency}\``).join(", ");
+        return {
+          type: SliceSimulatorSetupStepValidationMessageType.Warning,
+          title: "Missing some dependencies",
+          message: stripIndent`
+						The following dependencies are missing: ${formattedMissingDependencies}
+					`
+        };
+      }
+    }
+  };
+};
+const createStep2 = async ({ helpers, options }) => {
+  const fileName = `slice-simulator.${getJSOrTSXFileExtension}`;
+  const filePath = helpers.joinPathFromRoot("pages", fileName);
+  let fileContents;
+  if (options.typescript) {
+    fileContents = stripIndent`
+			import { GetStaticProps } from "next/types";
+			import { SliceSimulator } from "@prismicio/slice-simulator-react";
+			import { SliceZone } from "@prismicio/react";
+
+			import state from "../.slicemachine/libraries-state.json";
+			import { components } from "../slices";
+
+			const SliceSimulatorPage = () => {
+				return (
+					<SliceSimulator
+						sliceZone={(props) => <SliceZone {...props} components={components} />}
+						state={state}
+					/>
+				);
+			};
+
+			export default SliceSimulatorPage;
+
+			export const getStaticProps: GetStaticProps = () => {
+				return {
+					// Exclude this page from production builds.
+					notFound: process.env.NODE_ENV === "production",
+				};
+			};
+		`;
+  } else {
+    fileContents = stripIndent`
+			import { SliceSimulator } from "@prismicio/slice-simulator-react";
+			import { SliceZone } from "@prismicio/react";
+
+			import state from "../.slicemachine/libraries-state.json";
+			import { components } from "../slices";
+
+			const SliceSimulatorPage = () => {
+				return (
+					<SliceSimulator
+						sliceZone={(props) => <SliceZone {...props} components={components} />}
+						state={state}
+					/>
+				);
+			};
+
+			export default SliceSimulatorPage;
+
+			export const getStaticProps= () => {
+				return {
+					// Exclude this page from production builds.
+					notFound: process.env.NODE_ENV === "production",
+				};
+			};
+		`;
+  }
+  fileContents = await helpers.format(fileContents, filePath);
+  return {
+    title: "Create a page for the simulator",
+    body: stripIndent`
+			In your \`pages\` directory, create a file called \`${fileName}\` and add the following code. This route will be used to simulate and develop your components.
+
+			~~~tsx
+			${fileContents}
+			~~~
+		`
+  };
+};
+const createStep3 = async ({ helpers }) => {
+  const filePath = helpers.joinPathFromRoot("sm.json");
+  const fileContents = await helpers.format(`
+			{
+				"localSliceSimulatorURL": "http://localhost:3000/slice-simulator"
+			}
+		`, filePath);
+  return {
+    title: "Update `sm.json`",
+    body: stripIndent`
+			Update your \`sm.json\` file with a \`localSliceSimulatorURL\` property pointing to your \`slice-simulator\` page.
+
+			~~~json
+			${fileContents}
+			~~~
+		`,
+    validate: async () => {
+      const project = await helpers.getProject();
+      if (!("localSliceSimulatorURL" in project.config)) {
+        return {
+          type: SliceSimulatorSetupStepValidationMessageType.Error,
+          title: "Missing `localSliceSimulatorURL` property",
+          message: stripIndent`
+						A \`localSliceSimulatorURL\` property was not found in your \`sm.json\` file.
+					`
+        };
+      }
+      try {
+        if (project.config.localSliceSimulatorURL) {
+          new URL(project.config.localSliceSimulatorURL);
+        } else {
+          throw new Error("Undefined Slice Simulator URL");
+        }
+      } catch {
+        return {
+          type: SliceSimulatorSetupStepValidationMessageType.Warning,
+          title: "An invalid URL was provided",
+          message: stripIndent`
+						The \`localSliceSimulatorURL\` property should be of the shape \`http://localhost:PORT/PATH\`. See the codeblock for an example.
+					`
+        };
+      }
+      const ok = await new Promise((resolve) => {
+        if (project.config.localSliceSimulatorURL) {
+          http.get(project.config.localSliceSimulatorURL, (res) => {
+            if (res.statusCode) {
+              resolve(res.statusCode >= 200 && res.statusCode < 300);
+            }
+          });
+        }
+        resolve(false);
+      });
+      if (!ok) {
+        return {
+          type: SliceSimulatorSetupStepValidationMessageType.Warning,
+          title: "Unable to connect to simulator page",
+          message: stripIndent`
+						Check that the \`localSliceSimulatorURL\` property in \`sm.json\` is correct and try again. See the [troubleshooting page](https://prismic.io/docs/technologies/setup-slice-simulator-nextjs) for more details.
+					`
+        };
+      }
+    }
+  };
+};
+const sliceSimulatorSetupRead = async (_data, context) => {
+  return Promise.all([
+    createStep1(context),
+    createStep2(context),
+    createStep3(context)
+  ]);
+};
+export {
+  sliceSimulatorSetupRead
+};
+//# sourceMappingURL=sliceSimulator-setup-read.js.map