@devite/nuxt-sanity 1.3.0 → 1.5.1

package/README.md

@@ -22,11 +22,14 @@ That's it! You can now use data from Sanity in your Nuxt app ✨
   
   ```bash
   # Install dependencies
-  pnpm install && cd playground/cms && pnpm install
+  pnpm install && cd playground/cms && pnpm install && cd -
   
   # Generate type stubs
   pnpm dev:prepare
   
+  # Generate module types and build the module
+  pnpm prepack
+  
   # Develop with the playground
   pnpm dev
   

package/dist/module.d.mts

@@ -1,5 +1,54 @@
 import * as _nuxt_schema from '@nuxt/schema';
+import { Image, Slug, PortableTextBlock } from '@sanity/types';
+
+interface SEO {
+    _type: 'seo';
+    indexable: boolean;
+    title: string;
+    shortTitle: string;
+    description: string;
+    image?: Image;
+}
+
+interface Page {
+    _id: string;
+    _type: 'page';
+    title: string;
+    slug: Slug;
+    modules: Array<object>;
+    seo: SEO;
+}
+
+interface GlobalSEO {
+    siteName: string;
+    image: Image;
+}
+
+interface LinkExternal {
+    _type: 'linkExternal';
+    url: string;
+    newWindow: boolean;
+}
+
+interface LinkInternal {
+    _type: 'linkInternal';
+    slug: string;
+}
+
+type RichText = PortableTextBlock[];
+
+interface Home {
+    _type: 'home';
+    modules: Array<object>;
+    seo: SEO;
+}
+
+interface NotFound {
+    _type: 'notFound';
+    modules: Array<object>;
+    seo: SEO;
+}
 
 declare const _default: _nuxt_schema.NuxtModule<_nuxt_schema.ModuleOptions, _nuxt_schema.ModuleOptions, false>;
 
-export { _default as default };
+export { type GlobalSEO, type Home, type LinkExternal, type LinkInternal, type NotFound, type Page, type RichText, type SEO, _default as default };

package/dist/module.d.ts

@@ -1,5 +1,54 @@
 import * as _nuxt_schema from '@nuxt/schema';
+import { Image, Slug, PortableTextBlock } from '@sanity/types';
+
+interface SEO {
+    _type: 'seo';
+    indexable: boolean;
+    title: string;
+    shortTitle: string;
+    description: string;
+    image?: Image;
+}
+
+interface Page {
+    _id: string;
+    _type: 'page';
+    title: string;
+    slug: Slug;
+    modules: Array<object>;
+    seo: SEO;
+}
+
+interface GlobalSEO {
+    siteName: string;
+    image: Image;
+}
+
+interface LinkExternal {
+    _type: 'linkExternal';
+    url: string;
+    newWindow: boolean;
+}
+
+interface LinkInternal {
+    _type: 'linkInternal';
+    slug: string;
+}
+
+type RichText = PortableTextBlock[];
+
+interface Home {
+    _type: 'home';
+    modules: Array<object>;
+    seo: SEO;
+}
+
+interface NotFound {
+    _type: 'notFound';
+    modules: Array<object>;
+    seo: SEO;
+}
 
 declare const _default: _nuxt_schema.NuxtModule<_nuxt_schema.ModuleOptions, _nuxt_schema.ModuleOptions, false>;
 
-export { _default as default };
+export { type GlobalSEO, type Home, type LinkExternal, type LinkInternal, type NotFound, type Page, type RichText, type SEO, _default as default };

package/dist/module.json

@@ -1,9 +1,9 @@
 {
   "name": "@devite/nuxt-sanity",
   "configKey": "@devite/nuxt-sanity",
-  "version": "1.3.0",
+  "version": "1.5.1",
   "builder": {
     "@nuxt/module-builder": "0.8.4",
-    "unbuild": "2.0.0"
+    "unbuild": "unknown"
   }
 }

package/dist/runtime/components/SanityLinkExternal.vue

@@ -8,7 +8,7 @@
 </template>
 
 <script setup lang="ts">
-import type { LinkExternal } from '../types/objects/link/LinkExternal'
+import type { LinkExternal } from '@devite/nuxt-sanity'
 
 defineProps<{ data: LinkExternal }>()
 </script>

package/dist/runtime/components/SanityLinkInternal.vue

@@ -1,13 +1,16 @@
 <template>
   <NuxtLink
-    :to="data.slug"
+    v-if="resolvedLink"
+    :to="resolvedLink.slug"
   >
     <slot />
   </NuxtLink>
 </template>
 
 <script setup lang="ts">
-import type { LinkInternal } from '../types/objects/link/LinkInternal'
+import type { LinkInternal } from '@devite/nuxt-sanity'
+import type { Ref } from '#imports'
 
-defineProps<{ data: LinkInternal }>()
+const { data } = defineProps<{ data: LinkInternal }>()
+const resolvedLink: Ref<LinkInternal | undefined> | undefined = 'reference' in data ? await resolveInternalLink(data.reference) : data
 </script>

package/dist/runtime/components/SanityPage.vue

@@ -13,10 +13,7 @@ import { useSanityQuery } from '@nuxtjs/sanity/runtime/composables/visual-editin
 import { groq } from '@nuxtjs/sanity/runtime/groq'
 import type { ComputedRef } from 'vue'
 import type { ImageAsset } from '@sanity/types'
-import type { Home } from '../types/singletons/Home'
-import type { Page } from '../types/documents/Page'
-import type { NotFound } from '../types/singletons/NotFound'
-import type { GlobalSEO } from '../types/objects/global/GlobalSEO'
+import type { Home, Page, NotFound, GlobalSEO } from '@devite/nuxt-sanity'
 import { IMAGE_WITHOUT_PREVIEW_PROJECTION } from '../utils/projections'
 import { useHead, useRoute, useRuntimeConfig, useSeoMeta, computed } from '#imports'
 

package/dist/runtime/components/SanityRichText.vue

@@ -7,11 +7,11 @@
 
 <script setup lang="ts">
 import { PortableText, type PortableTextComponents } from '@portabletext/vue'
-import type { RichText } from '../types/richText/RichText'
+import type { RichText } from '@devite/nuxt-sanity'
 import { computed, h } from '#imports'
 import { SanityLinkExternal, SanityLinkInternal } from '#components'
 
-const { data, placeholders = {} } = defineProps<{ data: RichText, placeholders?: object }>()
+const { data, placeholders = {} as object } = defineProps<{ data: RichText, placeholders?: object }>()
 const currentData = computed(() => {
   return data.map((block) => {
     return {

package/dist/runtime/utils/projections.d.ts

@@ -1,3 +1,4 @@
 export declare const IMAGE_ASSET_PROJECTION: any;
 export declare const IMAGE_WITHOUT_PREVIEW_PROJECTION: any;
 export declare const IMAGE_WITH_PREVIEW_PROJECTION: any;
+export declare const LINK_PROJECTION: any;

package/dist/runtime/utils/projections.js

@@ -15,3 +15,8 @@ export const IMAGE_WITH_PREVIEW_PROJECTION = groq`{
   _type,
   asset-> ${IMAGE_ASSET_PROJECTION}
 }`;
+export const LINK_PROJECTION = groq`{
+  '_type': @._type,
+  _type == 'linkExternal' => { url, newWindow },
+  _type == 'linkInternal' => { 'slug': coalesce(@.reference->slug.current, '/') }
+}`;

package/dist/runtime/utils/resolveImageAssetById.js

@@ -1,4 +1,4 @@
-import { useSanityQuery } from "@nuxtjs/sanity/runtime/composables";
+import { useSanityQuery } from "@nuxtjs/sanity/runtime/composables/visual-editing";
 import { IMAGE_ASSET_PROJECTION } from "./projections.js";
 export const resolveImageAssetById = async (id) => {
   return (await useSanityQuery(`*[_type == "sanity.imageAsset" && _id == $assetId][0] ${IMAGE_ASSET_PROJECTION}`, { assetId: id })).data;

package/dist/runtime/utils/resolveInternalLink.d.ts

@@ -0,0 +1,4 @@
+import type { Reference } from '@sanity/types';
+import type { LinkInternal } from '@devite/nuxt-sanity';
+import type { Ref } from '#imports';
+export declare const resolveInternalLink: (reference: Reference) => Promise<Ref<LinkInternal | undefined>>;

package/dist/runtime/utils/resolveInternalLink.js

@@ -0,0 +1,4 @@
+import { useSanityQuery } from "@nuxtjs/sanity/runtime/composables/visual-editing";
+export const resolveInternalLink = async (reference) => {
+  return (await useSanityQuery(`*[_id == $documentId][0] { '_type': 'linkInternal', 'slug': coalesce(slug.current, '/') }`, { documentId: reference._ref })).data;
+};

package/dist/types.d.mts

@@ -4,4 +4,4 @@ import type { default as Module } from './module.js'
 
 export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
 
-export { default } from './module.js'
+export { type GlobalSEO, type Home, type LinkExternal, type LinkInternal, type NotFound, type Page, type RichText, type SEO, default } from './module.js'

package/dist/types.d.ts

@@ -4,4 +4,4 @@ import type { default as Module } from './module'
 
 export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
 
-export { default } from './module'
+export { type GlobalSEO, type Home, type LinkExternal, type LinkInternal, type NotFound, type Page, type RichText, type SEO, default } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devite/nuxt-sanity",
-  "version": "1.3.0",
+  "version": "1.5.1",
   "description": "Provides additional helper components and utilities for the Nuxt.js Sanity module",
   "repository": "devite-io/nuxt-sanity",
   "license": "MIT",
@@ -22,26 +22,26 @@
     "dist"
   ],
   "dependencies": {
-    "@nuxt/image": "^1.8.0",
+    "@nuxt/image": "^1.8.1",
     "@nuxt/kit": "^3.13.2",
-    "@nuxtjs/sanity": "^1.12.1",
+    "@nuxtjs/sanity": "^1.12.2",
     "@portabletext/vue": "^1.0.11",
-    "@sanity/client": "^6.22.0",
-    "@sanity/types": "^3.59.0"
+    "@sanity/client": "^6.24.1",
+    "@sanity/types": "^3.66.1"
   },
   "devDependencies": {
-    "@nuxt/devtools": "^1.5.1",
+    "@devite/nuxt-sanity": "link:",
     "@nuxt/eslint-config": "^0.5.7",
     "@nuxt/module-builder": "^0.8.4",
     "@nuxt/schema": "^3.13.2",
-    "@nuxt/test-utils": "^3.14.2",
-    "@types/node": "latest",
+    "@nuxt/test-utils": "^3.15.1",
+    "@types/node": "^22.10.1",
     "changelogen": "^0.5.7",
-    "eslint": "^9.11.1",
+    "eslint": "^9.12.0",
     "nuxt": "^3.13.2",
-    "typescript": "latest",
-    "vitest": "^2.1.1",
-    "vue-tsc": "^2.1.6"
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8",
+    "vue-tsc": "^2.1.10"
   },
   "scripts": {
     "dev": "nuxi dev playground",

package/dist/runtime/types/documents/Page.d.ts

@@ -1,10 +0,0 @@
-import type { Slug } from '@sanity/types';
-import type { SEO } from '../objects/SEO.js';
-export interface Page {
-    _id: string;
-    _type: 'page';
-    title: string;
-    slug: Slug;
-    modules: Array<object>;
-    seo: SEO;
-}

package/dist/runtime/types/objects/SEO.d.ts

@@ -1,9 +0,0 @@
-import type { Image } from '@sanity/types';
-export interface SEO {
-    _type: 'seo';
-    indexable: boolean;
-    title: string;
-    shortTitle: string;
-    description: string;
-    image?: Image;
-}

package/dist/runtime/types/objects/global/GlobalSEO.d.ts

@@ -1,5 +0,0 @@
-import type { Image } from '@sanity/types';
-export interface GlobalSEO {
-    siteName: string;
-    image: Image;
-}

package/dist/runtime/types/objects/link/LinkExternal.d.ts

@@ -1,5 +0,0 @@
-export interface LinkExternal {
-    _type: 'linkExternal';
-    url: string;
-    newWindow: boolean;
-}

package/dist/runtime/types/objects/link/LinkInternal.d.ts

@@ -1,4 +0,0 @@
-export interface LinkInternal {
-    _type: 'linkInternal';
-    slug: string;
-}

package/dist/runtime/types/richText/RichText.d.ts

@@ -1,2 +0,0 @@
-import type { PortableTextBlock } from '@sanity/types';
-export type RichText = PortableTextBlock[];

package/dist/runtime/types/singletons/Home.d.ts

@@ -1,6 +0,0 @@
-import type { SEO } from '../objects/SEO.js';
-export interface Home {
-    _type: 'home';
-    modules: Array<object>;
-    seo: SEO;
-}

package/dist/runtime/types/singletons/NotFound.d.ts

@@ -1,6 +0,0 @@
-import type { SEO } from '../objects/SEO.js';
-export interface NotFound {
-    _type: 'notFound';
-    modules: Array<object>;
-    seo: SEO;
-}