@nuxtjs/prismic 1.4.2 → 1.5.0-alpha.0

package/README.md

@@ -61,9 +61,9 @@ Thanks to [James Pegg](https://github.com/jamespeggsh) for the initial implement
 [npm-version-href]: https://npmjs.com/package/@nuxtjs/prismic
 [npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/prismic.svg
 [npm-downloads-href]: https://npmjs.com/package/@nuxtjs/prismic
-[github-actions-ci-src]: https://github.com/nuxt-community/prismic-module/workflows/ci/badge.svg
-[github-actions-ci-href]: https://github.com/nuxt-community/prismic-module/actions?query=workflow%3Aci
-[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-community/prismic-module.svg
-[codecov-href]: https://codecov.io/gh/nuxt-community/prismic-module
+[github-actions-ci-src]: https://github.com/nuxt-modules/prismic/workflows/ci/badge.svg
+[github-actions-ci-href]: https://github.com/nuxt-modules/prismic/actions?query=workflow%3Aci
+[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-modules/prismic.svg
+[codecov-href]: https://codecov.io/gh/nuxt-modules/prismic
 [license-src]: https://img.shields.io/npm/l/@nuxtjs/prismic.svg
 [license-href]: https://npmjs.com/package/@nuxtjs/prismic

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxtjs/prismic",
-  "version": "1.4.2",
+  "version": "1.5.0-alpha.0",
   "description": "Easily connect your Nuxt.js application to your content hosted on Prismic",
   "keywords": [
     "nuxt",
@@ -9,7 +9,7 @@
     "prismic",
     "cms"
   ],
-  "repository": "nuxt-community/prismic-module",
+  "repository": "nuxt-modules/prismic",
   "license": "MIT",
   "main": "src/module.js",
   "files": [
@@ -27,13 +27,16 @@
     "test": "npm run lint && npm run unit"
   },
   "dependencies": {
-    "@prismicio/client": "^4.0.0 || ^5.1.0",
-    "@prismicio/vue": "^2.1.0",
+    "@prismicio/client": "^5.1.1 || ^4.0.0",
+    "@prismicio/vue": "^2.2.0",
+    "@slicemachine/manager": "0.1.1-dev-plugins.3",
     "consola": "^2.15.3",
-    "prismic-dom": "^2.2.6"
+    "io-ts-types": "^0.5.19",
+    "prismic-dom": "^2.2.7"
   },
   "devDependencies": {
     "@nuxtjs/eslint-config": "latest",
+    "@prismicio/slice-simulator-vue": "^0.2.3",
     "@types/jest": "latest",
     "babel-eslint": "latest",
     "eslint": "latest",

package/src/module.js

@@ -3,10 +3,11 @@ const fs = require('fs')
 const logger = require('./logger')
 const generate = require('./generator')
 
-function install (moduleOptions) {
+async function install (moduleOptions) {
   const options = {
     preview: true,
     previewReloadType: 'hot',
+    simulator: true,
     components: true,
     modern: false,
     ...moduleOptions,
@@ -24,6 +25,7 @@ function install (moduleOptions) {
   }
   const repo = options.endpoint.replace(/^https?:\/\//, '').replace(/(\.cdn)?\.prismic.+/, '')
   const app = this.options.dir.app || 'app'
+  const pages = this.options.dir.pages || 'pages'
 
   // Add in Prismic libraries to enable preview
   if (options.preview) {
@@ -31,6 +33,12 @@ function install (moduleOptions) {
     const userPreviewPage = path.join(this.options.srcDir, app, 'prismic', 'pages', 'preview.vue')
     const userPreviewPageExists = fs.existsSync(userPreviewPage)
 
+    if (userPreviewPageExists) {
+      logger.info(`Using user-defined preview page, available at \`${options.preview}\``)
+    } else {
+      logger.info(`Using default preview page, available at \`${options.preview}\``)
+    }
+
     this.addTemplate({
       fileName: 'prismic/pages/preview.vue',
       src: userPreviewPageExists ? userPreviewPage : path.join(__dirname, '../templates/pages/preview.vue')
@@ -44,6 +52,121 @@ function install (moduleOptions) {
     })
   }
 
+  // Add in Prismic Simulator for Slice Machine
+  if (options.simulator) {
+    // Skip on existing simulator (legacy)
+    const slashSliceSimulator = path.join(this.options.srcDir, pages, 'slice-simulator.vue')
+    if (fs.existsSync(slashSliceSimulator)) {
+      logger.info('Using user-defined simulator page within the `pages` directory, available at `/slice-simulator')
+    } else {
+      // Detect Simulator provider (flavor)
+      let flavor
+      try {
+        require('@slicemachine/adapter-nuxt/simulator')
+        flavor = 'adapter'
+      } catch {
+        try {
+          require('@prismicio/slice-simulator-vue')
+          flavor = 'standalone'
+        } catch {
+          if (options.simulator !== true) {
+            logger.warn('Could not injected simulator page, `@slicemachine/adapter-nuxt` is not installed')
+          }
+        }
+      }
+
+      // Add page if flavor was detected
+      if (flavor) {
+        const simulatorPath = options.simulator === true ? '/simulator' : options.simulator
+
+        const userSimulatorPage = path.join(this.options.srcDir, app, 'prismic', 'pages', 'simulator.vue')
+        const userSimulatorPageExists = fs.existsSync(userSimulatorPage)
+
+        let registerPage = false
+
+        // Only needed for built-in Simulator
+        if (!userSimulatorPageExists) {
+          try {
+            const { createSliceMachineManager } = require('@slicemachine/manager')
+
+            const manager = createSliceMachineManager({ cwd: this.options.rootDir })
+
+            let root
+
+            try {
+              root = await manager.project.getRoot()
+            } catch {
+              root = this.options.rootDir
+            }
+
+            let config
+            try {
+              config = await manager.project.getSliceMachineConfig()
+            } catch {
+              let configPath
+              try {
+                configPath = await manager.project.getSliceMachineConfigPath()
+                config = JSON.parse(fs.readFileSync(configPath))
+              } catch {
+                configPath = path.join(root, 'sm.json')
+                config = JSON.parse(fs.readFileSync(configPath))
+              }
+
+              if (!Array.isArray(config.libraries)) {
+                throw new TypeError(`\`${configPath}\` is missing \`libraries\` array`)
+              }
+            }
+            const rawLibraries = config.libraries
+            const libraries = []
+
+            for (const rawLibrary of rawLibraries) {
+              if (/^[@~.]\//.test(rawLibrary)) {
+                const libraryAbsolutePath = path.resolve(root, rawLibrary.replace(/^[@~.]/, '.'))
+                const libraryRelativePath = path.relative(this.options.rootDir, libraryAbsolutePath).replaceAll('\\', '/')
+                libraries.push(`~~/${libraryRelativePath}`)
+              } else {
+                libraries.push(rawLibrary)
+              }
+            }
+
+            this.addTemplate({
+              fileName: 'prismic/all-slices.js',
+              src: path.join(__dirname, '../templates/all-slices.js'),
+              options: { libraries }
+            })
+            this.addTemplate({
+              fileName: 'prismic/pages/simulator.vue',
+              src: path.join(__dirname, `../templates/pages/simulator-${flavor}.vue`)
+            })
+
+            registerPage = true
+            logger.info(`Using default simulator page, available at \`${simulatorPath}\``)
+          } catch (error) {
+            logger.warn("Could not resolve slice libraries, simulator page won't work\n\n", error)
+          }
+        } else {
+          this.addTemplate({
+            fileName: 'prismic/pages/simulator.vue',
+            src: userSimulatorPage
+          })
+
+          registerPage = true
+          logger.info(`Using user-defined simulator page, available at \`${simulatorPath}\``)
+        }
+
+        if (registerPage) {
+          this.extendRoutes((routes, resolve) => {
+            routes.unshift({
+              name: 'prismic-slice-simulator',
+              path: simulatorPath,
+              component: resolve(this.options.buildDir, 'prismic/pages/simulator.vue')
+            })
+          })
+        }
+      }
+    }
+  }
+
   // Add components
   if (options.components) {
     this.addPlugin({

package/templates/all-slices.js

@@ -0,0 +1,7 @@
+<% options.libraries.forEach((library, index) => { %>import { components as library<%= index %> } from '<%= library %>'
+<% }); %>
+
+export default {
+<% options.libraries.forEach((library, index) => { %>  ...library<%= index %>,
+<% }); %>
+}

package/templates/pages/simulator-adapter.vue

@@ -0,0 +1,20 @@
+<template>
+	<SliceSimulator #default="{ slices }">
+		<SliceZone :slices="slices" :components="components" />
+	</SliceSimulator>
+</template>
+
+<script>
+import { SliceSimulator } from "@slicemachine/adapter-nuxt/simulator";
+
+import components from "../all-slices.js";
+
+export default {
+	components: {
+		SliceSimulator
+  },
+	data() {
+		return { components };
+	}
+};
+</script>

package/templates/pages/simulator-standalone.vue

@@ -0,0 +1,20 @@
+<template>
+	<SliceSimulator #default="{ slices }" :state="{}">
+		<SliceZone :slices="slices" :components="components" />
+	</SliceSimulator>
+</template>
+
+<script>
+import { SliceSimulator } from "@prismicio/slice-simulator-vue";
+
+import components from "../all-slices.js";
+
+export default {
+	components: {
+		SliceSimulator
+  },
+	data() {
+		return { components };
+	}
+};
+</script>