next-sanity 8.4.2 → 8.4.4

package/dist/image/index.d.cts

@@ -0,0 +1,31 @@
+/// <reference types="react" />
+
+import {ImageLoaderProps} from 'next/image'
+import {ImageProps as ImageProps_2} from 'next/image'
+
+/**
+ * @alpha
+ */
+declare function Image_2(props: ImageProps): JSX.Element
+export {Image_2 as Image}
+
+/**
+ * @alpha
+ */
+export declare const imageLoader: ({src, width, quality}: ImageLoaderProps) => string
+
+/**
+ * @alpha
+ */
+export declare interface ImageProps extends Omit<ImageProps_2, 'loader' | 'src'> {
+  /**
+   * The `loader` prop is not supported on `Image` components. Use `next/image` directly to use a custom loader.
+   */
+  loader?: never
+  /**
+   * Must be a string that is a valid URL to an image on the Sanity Image CDN.
+   */
+  src: string
+}
+
+export {}

package/dist/index.d.cts

@@ -0,0 +1,44 @@
+/// <reference types="react" />
+
+import {createClient} from '@sanity/client'
+import {CreateDataAttribute} from '@sanity/visual-editing/create-data-attribute'
+import {createDataAttribute} from '@sanity/visual-editing/create-data-attribute'
+import {CreateDataAttributeProps} from '@sanity/visual-editing/create-data-attribute'
+import {default as groq} from 'groq'
+import {unstable__adapter} from '@sanity/client'
+import {unstable__environment} from '@sanity/client'
+import {VisualEditingOptions} from '@sanity/visual-editing'
+
+export {createClient}
+
+export {CreateDataAttribute}
+
+export {createDataAttribute}
+
+export {CreateDataAttributeProps}
+
+export {groq}
+
+export {unstable__adapter}
+
+export {unstable__environment}
+
+/**
+ * @public
+ */
+export declare function VisualEditing(props: VisualEditingProps): React.ReactElement
+
+/**
+ * @public
+ */
+export declare interface VisualEditingProps extends Omit<VisualEditingOptions, 'history'> {
+  /**
+   * @deprecated The histoy adapter is already implemented
+   */
+  history?: never
+}
+
+export * from '@portabletext/react'
+export * from '@sanity/client'
+
+export {}

package/dist/preview/index.d.cts

@@ -0,0 +1,41 @@
+import {CacheOptions} from '@sanity/preview-kit'
+import {default as default_2} from '@sanity/preview-kit'
+import {DefineListenerContext} from '@sanity/preview-kit'
+import {isEqualFn} from '@sanity/preview-kit'
+import {ListenerGetSnapshot} from '@sanity/preview-kit'
+import {ListenerSubscribe} from '@sanity/preview-kit'
+import {LiveQueryHookOptions} from '@sanity/preview-kit'
+import {LiveQueryProvider} from '@sanity/preview-kit'
+import {LiveQueryProviderProps} from '@sanity/preview-kit'
+import {Logger} from '@sanity/preview-kit'
+import {QueryEnabled} from '@sanity/preview-kit'
+import {QueryLoading} from '@sanity/preview-kit'
+import {useLiveQuery} from '@sanity/preview-kit'
+
+export {CacheOptions}
+
+export default default_2
+
+export {DefineListenerContext}
+
+export {isEqualFn}
+
+export {ListenerGetSnapshot}
+
+export {ListenerSubscribe}
+
+export {LiveQueryHookOptions}
+
+export {LiveQueryProvider}
+
+export {LiveQueryProviderProps}
+
+export {Logger}
+
+export {QueryEnabled}
+
+export {QueryLoading}
+
+export {useLiveQuery}
+
+export {}

package/dist/preview/live-query.d.cts

@@ -0,0 +1,12 @@
+import {LiveQuery} from '@sanity/preview-kit/live-query'
+import {LiveQueryClientComponentProps} from '@sanity/preview-kit/live-query'
+import {LiveQueryProps} from '@sanity/preview-kit/live-query'
+
+export {LiveQuery}
+export default LiveQuery
+
+export {LiveQueryClientComponentProps}
+
+export {LiveQueryProps}
+
+export {}

package/dist/studio/index.d.cts

@@ -0,0 +1,97 @@
+/// <reference types="react" />
+
+import {JSX as JSX_2} from 'react'
+import {MemoExoticComponent} from 'react'
+import {StudioProps} from 'sanity'
+
+/**
+ * In router segments (`/app/studio/[[...index]]/page.tsx`):
+ * ```tsx
+ * // If you don't want to change any defaults you can just re-export the metadata directly:
+ * export {metadata} from 'next-sanity/studio'
+ *
+ * // To customize the metadata, spread it on the export:
+ * import {metadata as studioMetadata} from 'next-sanity/studio'
+ * import type { Metadata } from 'next'
+ *
+ * export const metadata: Metadata = {
+ *   ...studioMetadata,
+ *   // Set another title
+ *   title: 'My Studio',
+ * })
+ * ```
+ * @public
+ */
+export declare const metadata: {
+  referrer: 'same-origin'
+  robots: 'noindex'
+}
+
+/**
+ * Override how the Studio renders by passing children.
+ * This is useful for advanced use cases where you're using StudioProvider and StudioLayout instead of Studio:
+ * ```
+ * import {StudioProvider, StudioLayout} from 'sanity'
+ * import {NextStudio} from 'next-sanity/studio'
+ * <NextStudio config={config}>
+ *   <StudioProvider config={config}>
+ *     <CustomComponentThatUsesContextFromStudioProvider />
+ *     <StudioLayout />
+ *   </StudioProvider>
+ * </NextStudio>
+ * ```
+ * @public
+ */
+export declare const NextStudio: MemoExoticComponent<
+  ({children, config, unstable__noScript, scheme, ...props}: NextStudioProps) => JSX_2.Element
+>
+
+/** @public */
+export declare const NextStudioLayout: MemoExoticComponent<
+  ({children}: NextStudioLayoutProps) => JSX_2.Element
+>
+
+/** @public */
+export declare interface NextStudioLayoutProps {
+  children: React.ReactNode
+}
+
+/** @internal */
+export declare const NextStudioNoScript: () => JSX.Element
+
+/** @public */
+export declare interface NextStudioProps extends StudioProps {
+  children?: React.ReactNode
+  /**
+   * Render the <noscript> tag
+   * @defaultValue true
+   * @alpha
+   */
+  unstable__noScript?: boolean
+}
+
+/**
+ * In router segments (`/app/studio/[[...index]]/page.tsx`):
+ * ```tsx
+ * // If you don't want to change any defaults you can just re-export the viewport config directly:
+ * export {viewport} from 'next-sanity/studio'
+ *
+ * // To customize the viewport config, spread it on the export:
+ * import {viewport as studioViewport} from 'next-sanity/studio'
+ * import type { Viewport } from 'next'
+ *
+ * export const viewport: Viewport = {
+ *   ...studioViewport,
+ *   // Overrides the viewport to resize behavior
+ *   interactiveWidget: 'resizes-content'
+ * })
+ * ```
+ * @public
+ */
+export declare const viewport: {
+  width: string
+  initialScale: number
+  viewportFit: 'cover'
+}
+
+export {}

package/dist/studio/metadata.d.cts

@@ -0,0 +1,10 @@
+/**
+ * @public
+ * @deprecated use `export {metadata} from 'next-sanity/studio'` instead
+ */
+export declare const metadata: {
+  referrer: 'same-origin'
+  robots: 'noindex'
+}
+
+export {}

package/dist/studio/viewport.d.cts

@@ -0,0 +1,11 @@
+/**
+ * @public
+ * @deprecated use `export {viewport} from 'next-sanity/studio'` instead
+ */
+export declare const viewport: {
+  width: string
+  initialScale: number
+  viewportFit: 'cover'
+}
+
+export {}

package/dist/webhook.d.cts

@@ -0,0 +1,45 @@
+import type {NextApiRequest} from 'next'
+import type {NextRequest} from 'next/server'
+import type {PageConfig} from 'next/types'
+import type {SanityDocument} from '@sanity/types'
+
+/**
+ * Configurates the API function with the right runtime and body parsing to handle Sanity Webhook events.
+ * @public
+ * @deprecated using `parseBody` with `NextApiRequest` is deprecated and will be removed in the next major version. Use `parseBody` with `NextRequest` instead from a Route Handler in App Router.
+ */
+export declare const config: PageConfig
+
+/**
+ * Handles parsing the body JSON, and validating its signature. Also waits for Content Lake eventual consistency so you can run your queries
+ * without worrying about getting stale data.
+ * @public
+ */
+export declare function parseBody<Body = SanityDocument>(
+  req: NextRequest,
+  secret?: string,
+  waitForContentLakeEventualConsistency?: boolean,
+): Promise<ParsedBody<Body>>
+
+/**
+ * Handles parsing the body JSON, and validating its signature. Also waits for Content Lake eventual consistency so you can run your queries
+ * without worrying about getting stale data.
+ * @public
+ * @deprecated using `parseBody` with `NextApiRequest` is deprecated and will be removed in the next major version. Use `parseBody` with `NextRequest` instead from a Route Handler in App Router.
+ */
+export declare function parseBody<Body = SanityDocument>(
+  req: NextApiRequest,
+  secret?: string,
+  waitForContentLakeEventualConsistency?: boolean,
+): Promise<ParsedBody<Body>>
+
+/** @public */
+export declare type ParsedBody<T> = {
+  /**
+   * If a secret is given then it returns a boolean. If no secret is provided then no validation is done on the signature, and it'll return `null`
+   */
+  isValidSignature: boolean | null
+  body: T | null
+}
+
+export {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-sanity",
-  "version": "8.4.2",
+  "version": "8.4.4",
   "description": "Sanity.io toolkit for Next.js",
   "keywords": [
     "sanity",
@@ -26,56 +26,48 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
       "source": "./src/index.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs",
       "default": "./dist/index.js"
     },
     "./image": {
-      "types": "./dist/image/index.d.ts",
       "source": "./src/image/index.ts",
       "import": "./dist/image/index.js",
       "require": "./dist/image/index.cjs",
       "default": "./dist/image/index.js"
     },
     "./preview": {
-      "types": "./dist/preview/index.d.ts",
       "source": "./src/preview/index.ts",
       "import": "./dist/preview/index.js",
       "require": "./dist/preview/index.cjs",
       "default": "./dist/preview/index.js"
     },
     "./preview/live-query": {
-      "types": "./dist/preview/live-query.d.ts",
       "source": "./src/preview/LiveQuery/index.ts",
       "import": "./dist/preview/live-query.js",
       "require": "./dist/preview/live-query.cjs",
       "default": "./dist/preview/live-query.js"
     },
     "./studio": {
-      "types": "./dist/studio/index.d.ts",
       "source": "./src/studio/index.ts",
       "import": "./dist/studio/index.js",
       "require": "./dist/studio/index.cjs",
       "default": "./dist/studio/index.js"
     },
     "./studio/metadata": {
-      "types": "./dist/studio/metadata.d.ts",
       "source": "./src/studio/metadata.ts",
       "import": "./dist/studio/metadata.js",
       "require": "./dist/studio/metadata.cjs",
       "default": "./dist/studio/metadata.js"
     },
     "./studio/viewport": {
-      "types": "./dist/studio/viewport.d.ts",
       "source": "./src/studio/viewport.ts",
       "import": "./dist/studio/viewport.js",
       "require": "./dist/studio/viewport.cjs",
       "default": "./dist/studio/viewport.js"
     },
     "./webhook": {
-      "types": "./dist/webhook.d.ts",
       "source": "./src/webhook/index.ts",
       "import": "./dist/webhook.js",
       "require": "./dist/webhook.cjs",
@@ -112,43 +104,42 @@
       ]
     }
   },
-  "typings": "dist/index.d.ts",
   "files": [
     "dist",
     "src"
   ],
   "browserslist": "extends @sanity/browserslist-config",
   "dependencies": {
-    "@portabletext/react": "^3.0.12",
-    "@sanity/client": "^6.15.5",
-    "@sanity/preview-kit": "5.0.33",
-    "@sanity/visual-editing": "1.8.1",
+    "@portabletext/react": "^3.0.13",
+    "@sanity/client": "^6.15.7",
+    "@sanity/preview-kit": "5.0.35",
+    "@sanity/visual-editing": "1.8.2",
     "@sanity/webhook": "4.0.2-bc",
     "groq": "^3.19"
   },
   "devDependencies": {
     "@sanity/browserslist-config": "^1.0.3",
     "@sanity/eslint-config-studio": "^3.0.1",
-    "@sanity/pkg-utils": "^5.0.2",
-    "@types/react": "^18.2.66",
-    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "@sanity/pkg-utils": "^5.1.1",
+    "@types/react": "^18.2.67",
+    "@typescript-eslint/eslint-plugin": "^7.3.1",
     "@vitest/coverage-v8": "^1.4.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-config-sanity": "^7.1.1",
+    "eslint-config-sanity": "^7.1.2",
     "eslint-gitignore": "^0.1.0",
     "eslint-plugin-simple-import-sort": "^12.0.0",
     "ls-engines": "^0.9.1",
-    "next": "14.1.3",
+    "next": "14.1.4",
     "react": "^18.2.0",
     "rimraf": "^5.0.5",
     "styled-components": "^6.1.8",
-    "typescript": "5.3.3",
+    "typescript": "5.4.2",
     "vitest": "^1.4.0",
     "vitest-github-actions-reporter": "^0.11.1"
   },
   "peerDependencies": {
-    "@sanity/client": "^6.15.5",
+    "@sanity/client": "^6.15.7",
     "@sanity/icons": "^2.8",
     "@sanity/types": "^3.25",
     "@sanity/ui": "^1.8 || ^2.0.0-beta || ^2.0",