@uniformdev/uniform-nuxt 16.0.1-nuxt.179 → 16.0.1-nuxt.181

package/dist/module.d.ts

@@ -1,12 +1,16 @@
+import * as _nuxt_schema from '@nuxt/schema';
 import { ManifestV2 } from '@uniformdev/context';
 
-interface ModuleOptions {
-    projectId?: string;
-    readOnlyApiKey?: string;
+interface UniformModuleOptions {
+    projectId: string;
+    readOnlyApiKey: string;
     apiHost?: string;
     manifest?: ManifestV2;
     outputType?: string;
+    uniformContextPath?: string;
+    defaultConsent?: boolean;
+    enableContextDevTools?: boolean;
 }
-declare const _default: NuxtModule<OptionsT>;
+declare const _default: _nuxt_schema.NuxtModule<UniformModuleOptions>;
 
-export { ModuleOptions, _default as default };
+export { UniformModuleOptions, _default as default };

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "nuxt-uniform",
   "configKey": "uniform",
-  "version": "16.0.1-nuxt.179+842199728"
+  "version": "16.0.1-nuxt.181+d2c9a0bbf"
 }

package/dist/module.mjs

@@ -1,25 +1,56 @@
 import { resolve } from 'path';
 import { fileURLToPath } from 'url';
-import { defineNuxtModule, addPlugin } from '@nuxt/kit';
+import { defineNuxtModule, resolveAlias, addTemplate, addPlugin, extendViteConfig } from '@nuxt/kit';
 
+const uniformContextProxyPath = "uniform/context/instance.ts";
 const module = defineNuxtModule({
   meta: {
     name: "nuxt-uniform",
     configKey: "uniform"
   },
   defaults: {
-    projectId: void 0,
-    readOnlyApiKey: void 0,
+    projectId: "",
+    readOnlyApiKey: "",
     apiHost: "https://uniform.app",
     manifest: void 0,
-    outputType: void 0
+    outputType: void 0,
+    uniformContextPath: void 0,
+    defaultConsent: false,
+    enableContextDevTools: true
   },
   setup(options, nuxt) {
+    if (!options.projectId || !options.readOnlyApiKey) {
+      throw new Error("uniform-nuxt: The module options 'projectId' and 'readOnlyApiKey' are required");
+    }
+    optimizeDeps(["rfdc"]);
     nuxt.options.runtimeConfig.public["$uniform"] = { ...options };
+    if (options.uniformContextPath) {
+      const resolvedUserContextPath = resolveConfigFilePath(nuxt, options.uniformContextPath);
+      addTemplate({
+        filename: uniformContextProxyPath,
+        getContents: () => `export { default } from '${resolvedUserContextPath}';`
+      });
+    } else {
+      addTemplate({
+        filename: uniformContextProxyPath,
+        getContents: () => `export default undefined;`
+      });
+    }
     const runtimeDir = fileURLToPath(new URL("./runtime", import.meta.url));
     nuxt.options.build.transpile.push(runtimeDir);
     addPlugin(resolve(runtimeDir, "plugin"));
   }
 });
+function resolveConfigFilePath(nuxt, filePath) {
+  return resolve(nuxt.options.rootDir, resolveAlias(filePath));
+}
+function optimizeDeps(deps) {
+  extendViteConfig((config) => {
+    config.optimizeDeps = {
+      ...config.optimizeDeps,
+      include: [...config.optimizeDeps?.include ?? [], ...deps]
+    };
+  });
+}
 
 export { module as default };

package/dist/runtime/plugin.mjs

@@ -8,6 +8,8 @@ import {
   useState,
   useCookie
 } from "#app";
+import userProvidedContextInstance from "#build/uniform/context/instance";
+import { watch, toRaw } from "vue-demi";
 import {
   CanvasClient,
   CANVAS_DRAFT_STATE,
@@ -16,45 +18,55 @@ import {
 import {
   Context,
   CookieTransitionDataStore,
+  enableContextDevTools,
   UNIFORM_DEFAULT_COOKIE_NAME
 } from "@uniformdev/context";
 import { Composition, SlotContent, useCompositionEventEffect } from "@uniformdev/canvas-vue";
 import {
-  provideUniformContext
+  provideUniformContext,
+  onRouteChange
 } from "@uniformdev/context-vue";
 export default defineNuxtPlugin((nuxtApp) => {
   if (nuxtApp.$uniformIsSetup) {
     return;
   }
-  nuxtApp.vueApp.provide("hello", "world3");
-  const currentCompositionId = useState("currentCompositionId", () => "");
-  const preview = setupPreview();
-  const uniformContextData = setupContext(nuxtApp);
-  const uniformCanvasClient = setupCanvas(nuxtApp);
-  setupLivePreview(currentCompositionId, Boolean(preview));
-  const useComposition = setupUseComposition(uniformCanvasClient, currentCompositionId, preview);
-  return {
-    provide: {
-      uniformIsSetup: true,
-      preview,
-      uniformCanvasClient,
-      uniformContext: uniformContextData.context,
-      useComposition
-    }
-  };
+  try {
+    const currentCompositionId = useState("currentCompositionId", () => "");
+    const preview = setupPreview();
+    const uniformContextData = setupContext(nuxtApp);
+    const uniformCanvasClient = setupCanvas(nuxtApp);
+    setupLivePreview(currentCompositionId, Boolean(preview));
+    const useComposition = setupUseComposition(uniformCanvasClient, currentCompositionId, preview);
+    return {
+      provide: {
+        uniformIsSetup: true,
+        preview,
+        uniformCanvasClient,
+        uniformContext: uniformContextData.context,
+        useComposition
+      }
+    };
+  } catch (e) {
+    console.log("uniform-nuxt: An error occurred while initializing the Uniform plugin", e);
+  }
 });
 function setupContext(nuxtApp) {
-  const options = useRuntimeConfig().public.$uniform;
+  const options = getModuleOptions();
   const uniformCookie = useCookie(UNIFORM_DEFAULT_COOKIE_NAME).value;
-  let uniformContext;
-  if (options.manifest) {
+  let uniformContext = userProvidedContextInstance;
+  if (uniformContext !== void 0 && !uniformContext.manifest) {
+    throw new Error(`uniform-nuxt: The Uniform Context instance returned by ${options.uniformContextPath} is not valid`);
+  }
+  if (!uniformContext && options.manifest) {
     console.log("uniform-nuxt: \u{1F4DC} found a manifest, will initialize Context");
+    const manifestAsSimpleObject = toRaw(options.manifest);
     uniformContext = new Context({
-      defaultConsent: true,
-      manifest: options.manifest,
+      defaultConsent: Boolean(options.defaultConsent),
+      manifest: manifestAsSimpleObject,
       transitionStore: new CookieTransitionDataStore({
         serverCookieValue: uniformCookie
-      })
+      }),
+      plugins: options.enableContextDevTools ? [enableContextDevTools()] : void 0
     });
   }
   provideUniformContext({
@@ -62,19 +74,15 @@ function setupContext(nuxtApp) {
     outputType: options.outputType,
     vueAppInstance: nuxtApp.vueApp
   });
-  nuxtApp.hook("vue:setup	", (vueApp) => {
-    console.log("\u{1FA9D} vue:setup	", vueApp);
-    provideUniformContext({
-      context: uniformContext,
-      outputType: options.outputType,
-      vueAppInstance: nuxtApp.vueApp
-    });
+  const route = useRoute();
+  watch(() => JSON.stringify(route.query), () => {
+    if (uniformContext)
+      onRouteChange(uniformContext);
   });
-  console.log("setupContext nuxtApp.vueApp._uid", nuxtApp.vueApp._uid);
   return { context: uniformContext, outputType: options.outputType };
 }
 function setupCanvas(nuxtApp) {
-  const options = useRuntimeConfig().public.$uniform;
+  const options = getModuleOptions();
   nuxtApp.vueApp.component("Composition", Composition);
   nuxtApp.vueApp.component("SlotContent", SlotContent);
   const uniformCanvasClient = new CanvasClient({
@@ -96,7 +104,7 @@ function setupPreview() {
   return preview;
 }
 function setupLivePreview(currentCompositionId, isPreview = false) {
-  const { projectId } = useRuntimeConfig().public.$uniform;
+  const { projectId } = getModuleOptions();
   const enabled = isPreview;
   const onCompositionChange = async () => {
     await refreshNuxtData();
@@ -122,3 +130,6 @@ function setupUseComposition(uniformCanvasClient, currentCompositionId, preview)
   };
   return useComposition;
 }
+function getModuleOptions() {
+  return useRuntimeConfig().public.$uniform;
+}

package/dist/types.d.ts

@@ -1,10 +1,6 @@
 
-import { ModuleOptions } from './module'
+import {  } from './module'
 
-declare module '@nuxt/schema' {
-  interface NuxtConfig { ['uniform']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['uniform']?: ModuleOptions }
-}
 
 
 export { default } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/uniform-nuxt",
-  "version": "16.0.1-nuxt.179+842199728",
+  "version": "16.0.1-nuxt.181+d2c9a0bbf",
   "license": "MIT",
   "type": "module",
   "exports": {
@@ -30,17 +30,19 @@
   },
   "devDependencies": {
     "@nuxt/module-builder": "0.1.7",
+    "@nuxt/schema": "3.0.0-rc.4",
     "@nuxtjs/eslint-config-typescript": "10.0.0",
-    "@uniformdev/canvas": "^16.0.1-nuxt.179+842199728",
-    "@uniformdev/canvas-vue": "^16.0.1-nuxt.179+842199728",
-    "@uniformdev/context": "^16.0.1-nuxt.179+842199728",
-    "@uniformdev/context-vue": "^16.0.1-nuxt.179+842199728",
+    "@uniformdev/canvas": "^16.0.1-nuxt.181+d2c9a0bbf",
+    "@uniformdev/canvas-vue": "^16.0.1-nuxt.181+d2c9a0bbf",
+    "@uniformdev/context": "^16.0.1-nuxt.181+d2c9a0bbf",
+    "@uniformdev/context-vue": "^16.0.1-nuxt.181+d2c9a0bbf",
     "esbuild": "0.13.15",
     "eslint": "latest",
-    "nuxt": "^3.0.0-rc.4"
+    "nuxt": "^3.0.0-rc.4",
+    "vue": "3.2.37"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "842199728b5d454c2ca7e82ef7d1fd208f835c4e"
+  "gitHead": "d2c9a0bbf7c8a640213fee2f6eae7c1cfdd08b02"
 }