@uniformdev/uniform-nuxt 18.1.1-alpha.11 → 18.1.2-alpha.7

package/README.md

@@ -8,8 +8,8 @@
     - [Auto-imported composables](#auto-imported-composables)
       - [`useUniformComposition`](#useuniformcomposition)
     - [Components](#components)
-      - [`<Composition />`](#composition-)
-      - [`<SlotContent />`](#slotcontent-)
+      - [`<UniformComposition />`](#uniformcomposition-)
+      - [`<UniformSlot />`](#uniformslot-)
     - [Injected in the Nuxt instance](#injected-in-the-nuxt-instance)
   - [Examples](#examples)
 
@@ -43,7 +43,7 @@ export default defineNuxtConfig({
 - Auto-registers the needed Uniform components.
 - Creates a Canvas client automatically.
 - Creates a Uniform Context instance and provides it through the whole app, without the need of a wrapping component.
-- Provides a handy `$useComposition` composable, built on top of Nuxt's [useAsyncData](https://v3.nuxtjs.org/api/composables/use-async-data).
+- Provides a handy `useUniformComposition` composable, built on top of Nuxt's [useAsyncData](https://v3.nuxtjs.org/api/composables/use-async-data).
 - Handles Live Preview.
 - Watches query string change, which Nuxt doesn't do by default.
 
@@ -89,19 +89,20 @@ const { composition } = useUniformComposition({
 ### Components
 These are the components that the module auto registers for you, so you can use them without import.
 
-#### `<Composition />`
+#### `<UniformComposition />`
 This component wraps the whole composition, it accepts the following props: 
 
 | Prop | Type | Description |
 |---|---|---|
-| `data`* |  string | The data of the composition to be rendered, this is usually the `composition` object that you get from `$useComposition` |
+| `data`* |  string | The data of the composition to be rendered, this is usually the `composition` object that you get from `useUniformComposition` |
 | `resolveRenderer` |  function | This function is responsible for mapping Canvas components to Vue components. It takes a `ComponentInstance` object and should return a Vue component (usually based on the component `type`). If no resolver is provided, it will try to resolve the component on the global context of the app, so if you have globally defined components, it will try to map them based on the `name` of the Vue component and the `type` of the Canvas component.|
+| `contextualEditingEnhancer` |  function | A function to enhance the composition inside Canvas editor. This function runs on the client side. If no value is provided, the enhancer will be inherited from `useUniformComposition` |
 
 \* Required
 
-#### `<SlotContent />`
-This component is used to render the slots of a composition, and it can be only used inside a `<Composition />`.
-You can nest `<SlotContent />` inside each other if you have nested slots.
+#### `<UniformSlot />`
+This component is used to render the slots of a composition, and it can be only used inside a `<UniformComposition />`.
+You can nest `<UniformSlot />` inside each other if you have nested slots.
 
 | Prop | Type | Description |
 |---|---|---|
@@ -118,7 +119,7 @@ These are the properties that the module injects in the Nuxt app instance, so yo
 
 ## Examples
 
-Here are some example where the module is used:
+Here are some examples using the module:
 - https://github.com/uniformdev/uniformconf-nuxt
 - https://github.com/uniformdev/nuxt-canvas-context-helloworld
 

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "nuxt-uniform",
   "configKey": "uniform",
-  "version": "18.1.1-alpha.11+c81a052e2"
+  "version": "18.1.2-alpha.7+682b9aac6"
 }

package/dist/module.mjs

@@ -1,4 +1,4 @@
-import { defineNuxtModule, addTemplate, addPlugin, addImportsDir, resolveAlias, extendViteConfig } from '@nuxt/kit';
+import { defineNuxtModule, addTemplate, addPlugin, addImportsDir, addComponentsDir, resolveAlias, extendViteConfig } from '@nuxt/kit';
 import { resolve } from 'path';
 import { fileURLToPath } from 'url';
 
@@ -41,6 +41,12 @@ const module = defineNuxtModule({
     nuxt.options.build.transpile.push(runtimeDir);
     addPlugin(resolve(runtimeDir, "plugin"));
     addImportsDir(resolve(runtimeDir, `./composables`));
+    addComponentsDir({
+      path: resolve(runtimeDir, "components"),
+      pathPrefix: false,
+      prefix: "",
+      global: true
+    });
   }
 });
 function resolveConfigFilePath(nuxt, filePath) {

package/dist/runtime/components/UniformComposition.d.ts

@@ -0,0 +1 @@
+export { UniformComposition as default } from '@uniformdev/canvas-vue';

package/dist/runtime/components/UniformComposition.mjs

@@ -0,0 +1 @@
+export { UniformComposition as default } from "@uniformdev/canvas-vue";

package/dist/runtime/components/UniformSlot.d.ts

@@ -0,0 +1 @@
+export { UniformSlot as default } from '@uniformdev/canvas-vue';

package/dist/runtime/components/UniformSlot.mjs

@@ -0,0 +1 @@
+export { UniformSlot as default } from "@uniformdev/canvas-vue";

package/dist/runtime/composables/useUniformComposition.d.ts

@@ -2,74 +2,7 @@ import { type CompositionGetByIdParameters, type CompositionGetByNodeIdParameter
 export declare const useUniformComposition: (options: (CompositionGetBySlugParameters | CompositionGetByIdParameters | CompositionGetByNodePathParameters | CompositionGetByNodeIdParameters) & DataResolutionOption & {
     enhance?: ((composition: RootComponentInstance) => RootComponentInstance | Promise<RootComponentInstance>) | undefined;
 }) => Promise<{
-    composition: import("vue-demi").Ref<{
-        type: string;
-        parameters?: {
-            [key: string]: {
-                value: unknown;
-                type: string;
-                connectedData?: {
-                    pointer: string;
-                    syntax: "jptr";
-                    required?: boolean | undefined;
-                } | undefined;
-            };
-        } | undefined;
-        variant?: string | undefined;
-        slots?: {
-            [key: string]: {
-                type: string;
-                parameters?: {
-                    [key: string]: {
-                        value: unknown;
-                        type: string;
-                        connectedData?: {
-                            pointer: string;
-                            syntax: "jptr";
-                            required?: boolean | undefined;
-                        } | undefined;
-                    };
-                } | undefined;
-                variant?: string | undefined;
-                slots?: {
-                    [key: string]: any[];
-                } | undefined;
-                _id?: string | undefined;
-                _pattern?: string | undefined;
-                _dataResources?: {
-                    [key: string]: {
-                        type: string;
-                        isPatternParameter?: boolean | undefined;
-                        variables?: {
-                            [key: string]: string;
-                        } | undefined;
-                    };
-                } | undefined;
-                _patternDataResources?: {
-                    [key: string]: {
-                        type: string;
-                        isPatternParameter?: boolean | undefined;
-                        variables?: {
-                            [key: string]: string;
-                        } | undefined;
-                    };
-                } | undefined;
-                _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
-            }[];
-        } | undefined;
-        _id: string;
-        _slug?: string | null | undefined;
-        _name: string;
-        _dataResources?: {
-            [key: string]: {
-                type: string;
-                isPatternParameter?: boolean | undefined;
-                variables?: {
-                    [key: string]: string;
-                } | undefined;
-            };
-        } | undefined;
-    } | undefined>;
+    composition: any;
     fullResponse: any;
     pending: any;
     error: any;

package/dist/runtime/composables/useUniformComposition.mjs

@@ -2,28 +2,14 @@ import {
   CANVAS_DRAFT_STATE,
   CANVAS_PUBLISHED_STATE
 } from "@uniformdev/canvas";
-import { useContextualEditing } from "@uniformdev/canvas-vue";
-import { ref, toRaw, watch } from "vue-demi";
+import { globalCompositionEnhancerInjectionKey } from "@uniformdev/canvas-vue";
+import { provide } from "vue-demi";
 import { useAsyncData, useNuxtApp } from "#app";
 export const useUniformComposition = async (options) => {
   const { enhance = (c) => c, ...parameters } = options;
   const { $uniformCanvasClient, $preview: preview } = useNuxtApp();
   const canvasClient = $uniformCanvasClient;
-  const activeComposition = ref(void 0);
-  const { composition: contextualEditingComposition } = useContextualEditing({
-    initialCompositionValue: void 0
-  });
-  watch(
-    [contextualEditingComposition],
-    async () => {
-      if (!contextualEditingComposition.value) {
-        return;
-      }
-      const composition = toRaw(contextualEditingComposition.value);
-      activeComposition.value = await enhance(composition);
-    },
-    { deep: true }
-  );
+  provide(globalCompositionEnhancerInjectionKey, enhance);
   const { data, pending, error } = await useAsyncData(
     `composition-${JSON.stringify(parameters)}`,
     async () => {
@@ -59,9 +45,8 @@ export const useUniformComposition = async (options) => {
       return { composition, response };
     }
   );
-  activeComposition.value = data.value?.composition;
   return {
-    composition: activeComposition,
+    composition: data.value?.composition,
     fullResponse: data.value?.response,
     pending,
     error

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/uniform-nuxt",
-  "version": "18.1.1-alpha.11+c81a052e2",
+  "version": "18.1.2-alpha.7+682b9aac6",
   "license": "MIT",
   "type": "module",
   "exports": {
@@ -35,11 +35,11 @@
     "@nuxt/module-builder": "0.2.1",
     "@nuxt/schema": "3.0.0",
     "@nuxtjs/eslint-config-typescript": "12.0.0",
-    "@uniformdev/canvas": "18.1.1-alpha.11+c81a052e2",
-    "@uniformdev/canvas-vue": "18.1.1-alpha.11+c81a052e2",
-    "@uniformdev/context": "18.1.1-alpha.11+c81a052e2",
-    "@uniformdev/context-vue": "18.1.1-alpha.11+c81a052e2",
-    "esbuild": "0.17.2",
+    "@uniformdev/canvas": "18.1.2-alpha.7+682b9aac6",
+    "@uniformdev/canvas-vue": "18.1.2-alpha.7+682b9aac6",
+    "@uniformdev/context": "18.1.2-alpha.7+682b9aac6",
+    "@uniformdev/context-vue": "18.1.2-alpha.7+682b9aac6",
+    "esbuild": "0.17.3",
     "eslint": "^8.31.0",
     "nuxt": "3.0.0",
     "vue": "3.2.45",
@@ -48,5 +48,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c81a052e2c13c6d3d786d7030f11a7724a52b2da"
+  "gitHead": "682b9aac6143d5f462a7126f4ceab55a7c7d0c09"
 }