@sanity/client 7.5.0-live-cors.3 → 7.6.0

package/dist/stega.browser.d.cts

@@ -1871,7 +1871,7 @@ export declare type IdentifiedSanityDocumentStub<
  * @see #TransformOperation
  * @beta
  */
-export declare interface ImageDescriptionOperation {
+export declare type ImageDescriptionOperation = {
   type: 'image-description'
   /**
    * When omitted, parent image value will be inferred from the arget path.
@@ -1882,7 +1882,32 @@ export declare interface ImageDescriptionOperation {
    * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
    */
   sourcePath?: AgentActionPath
-}
+} & (
+  | {
+      /**
+       * When omitted, parent image value will be inferred from the target path.
+       *
+       * When specified, the `sourcePath` should be a path to an image (or image asset) field:
+       * - `['image']`
+       * - `['wrapper', 'mainImage']`
+       * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
+       *
+       * Incompatible with `imageUrl`
+       *
+       */
+      sourcePath?: AgentActionPath
+      imageUrl?: never
+    }
+  | {
+      /**
+       * When specified, the image source to be described will be fetched from the URL.
+       *
+       * Incompatible with `sourcePath`
+       */
+      imageUrl?: `https://${string}`
+      sourcePath?: never
+    }
+)
 
 /** @public */
 export declare interface InitializedClientConfig extends ClientConfig {
@@ -5811,6 +5836,11 @@ declare type TransformDocumentSync<T extends Record<string, Any> = Record<string
  * - `target: {path: ['wrapper', 'title'], operation: {type: 'image-description', sourcePath: ['array', {_key: 'abc'}, 'image'] }`
  * - `target: {path: ['wrapper'], include: ['portableTextField'], operation: {type: 'image-description', sourcePath: ['image', 'asset'] }, instruction: 'Use formatting and headings to describe the image in great detail' }`
  *
+ * ### Targeting images outside the document (URL)
+ * If the source image is available on a https URL outside the target document, it is possible to get a description for it using `imageUrl`.
+ *
+ * Example:
+ * - `target: {path: ['description'], operation: operation: {type: 'image-description', imageUrL: 'https://www.sanity.io/static/images/favicons/android-icon-192x192.png?v=2' }`
  * @beta
  */
 export declare type TransformOperation = 'set' | ImageDescriptionOperation

package/dist/stega.browser.d.ts

@@ -1871,7 +1871,7 @@ export declare type IdentifiedSanityDocumentStub<
  * @see #TransformOperation
  * @beta
  */
-export declare interface ImageDescriptionOperation {
+export declare type ImageDescriptionOperation = {
   type: 'image-description'
   /**
    * When omitted, parent image value will be inferred from the arget path.
@@ -1882,7 +1882,32 @@ export declare interface ImageDescriptionOperation {
    * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
    */
   sourcePath?: AgentActionPath
-}
+} & (
+  | {
+      /**
+       * When omitted, parent image value will be inferred from the target path.
+       *
+       * When specified, the `sourcePath` should be a path to an image (or image asset) field:
+       * - `['image']`
+       * - `['wrapper', 'mainImage']`
+       * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
+       *
+       * Incompatible with `imageUrl`
+       *
+       */
+      sourcePath?: AgentActionPath
+      imageUrl?: never
+    }
+  | {
+      /**
+       * When specified, the image source to be described will be fetched from the URL.
+       *
+       * Incompatible with `sourcePath`
+       */
+      imageUrl?: `https://${string}`
+      sourcePath?: never
+    }
+)
 
 /** @public */
 export declare interface InitializedClientConfig extends ClientConfig {
@@ -5811,6 +5836,11 @@ declare type TransformDocumentSync<T extends Record<string, Any> = Record<string
  * - `target: {path: ['wrapper', 'title'], operation: {type: 'image-description', sourcePath: ['array', {_key: 'abc'}, 'image'] }`
  * - `target: {path: ['wrapper'], include: ['portableTextField'], operation: {type: 'image-description', sourcePath: ['image', 'asset'] }, instruction: 'Use formatting and headings to describe the image in great detail' }`
  *
+ * ### Targeting images outside the document (URL)
+ * If the source image is available on a https URL outside the target document, it is possible to get a description for it using `imageUrl`.
+ *
+ * Example:
+ * - `target: {path: ['description'], operation: operation: {type: 'image-description', imageUrL: 'https://www.sanity.io/static/images/favicons/android-icon-192x192.png?v=2' }`
  * @beta
  */
 export declare type TransformOperation = 'set' | ImageDescriptionOperation

package/dist/stega.d.cts

@@ -1871,7 +1871,7 @@ export declare type IdentifiedSanityDocumentStub<
  * @see #TransformOperation
  * @beta
  */
-export declare interface ImageDescriptionOperation {
+export declare type ImageDescriptionOperation = {
   type: 'image-description'
   /**
    * When omitted, parent image value will be inferred from the arget path.
@@ -1882,7 +1882,32 @@ export declare interface ImageDescriptionOperation {
    * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
    */
   sourcePath?: AgentActionPath
-}
+} & (
+  | {
+      /**
+       * When omitted, parent image value will be inferred from the target path.
+       *
+       * When specified, the `sourcePath` should be a path to an image (or image asset) field:
+       * - `['image']`
+       * - `['wrapper', 'mainImage']`
+       * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
+       *
+       * Incompatible with `imageUrl`
+       *
+       */
+      sourcePath?: AgentActionPath
+      imageUrl?: never
+    }
+  | {
+      /**
+       * When specified, the image source to be described will be fetched from the URL.
+       *
+       * Incompatible with `sourcePath`
+       */
+      imageUrl?: `https://${string}`
+      sourcePath?: never
+    }
+)
 
 /** @public */
 export declare interface InitializedClientConfig extends ClientConfig {
@@ -5811,6 +5836,11 @@ declare type TransformDocumentSync<T extends Record<string, Any> = Record<string
  * - `target: {path: ['wrapper', 'title'], operation: {type: 'image-description', sourcePath: ['array', {_key: 'abc'}, 'image'] }`
  * - `target: {path: ['wrapper'], include: ['portableTextField'], operation: {type: 'image-description', sourcePath: ['image', 'asset'] }, instruction: 'Use formatting and headings to describe the image in great detail' }`
  *
+ * ### Targeting images outside the document (URL)
+ * If the source image is available on a https URL outside the target document, it is possible to get a description for it using `imageUrl`.
+ *
+ * Example:
+ * - `target: {path: ['description'], operation: operation: {type: 'image-description', imageUrL: 'https://www.sanity.io/static/images/favicons/android-icon-192x192.png?v=2' }`
  * @beta
  */
 export declare type TransformOperation = 'set' | ImageDescriptionOperation

package/dist/stega.d.ts

@@ -1871,7 +1871,7 @@ export declare type IdentifiedSanityDocumentStub<
  * @see #TransformOperation
  * @beta
  */
-export declare interface ImageDescriptionOperation {
+export declare type ImageDescriptionOperation = {
   type: 'image-description'
   /**
    * When omitted, parent image value will be inferred from the arget path.
@@ -1882,7 +1882,32 @@ export declare interface ImageDescriptionOperation {
    * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
    */
   sourcePath?: AgentActionPath
-}
+} & (
+  | {
+      /**
+       * When omitted, parent image value will be inferred from the target path.
+       *
+       * When specified, the `sourcePath` should be a path to an image (or image asset) field:
+       * - `['image']`
+       * - `['wrapper', 'mainImage']`
+       * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
+       *
+       * Incompatible with `imageUrl`
+       *
+       */
+      sourcePath?: AgentActionPath
+      imageUrl?: never
+    }
+  | {
+      /**
+       * When specified, the image source to be described will be fetched from the URL.
+       *
+       * Incompatible with `sourcePath`
+       */
+      imageUrl?: `https://${string}`
+      sourcePath?: never
+    }
+)
 
 /** @public */
 export declare interface InitializedClientConfig extends ClientConfig {
@@ -5811,6 +5836,11 @@ declare type TransformDocumentSync<T extends Record<string, Any> = Record<string
  * - `target: {path: ['wrapper', 'title'], operation: {type: 'image-description', sourcePath: ['array', {_key: 'abc'}, 'image'] }`
  * - `target: {path: ['wrapper'], include: ['portableTextField'], operation: {type: 'image-description', sourcePath: ['image', 'asset'] }, instruction: 'Use formatting and headings to describe the image in great detail' }`
  *
+ * ### Targeting images outside the document (URL)
+ * If the source image is available on a https URL outside the target document, it is possible to get a description for it using `imageUrl`.
+ *
+ * Example:
+ * - `target: {path: ['description'], operation: operation: {type: 'image-description', imageUrL: 'https://www.sanity.io/static/images/favicons/android-icon-192x192.png?v=2' }`
  * @beta
  */
 export declare type TransformOperation = 'set' | ImageDescriptionOperation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "7.5.0-live-cors.3",
+  "version": "7.6.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",

package/src/agent/actions/transform.ts

@@ -180,7 +180,7 @@ export type TransformTargetDocument =
  * @see #TransformOperation
  * @beta
  */
-export interface ImageDescriptionOperation {
+export type ImageDescriptionOperation = {
   type: 'image-description'
   /**
    * When omitted, parent image value will be inferred from the arget path.
@@ -191,7 +191,32 @@ export interface ImageDescriptionOperation {
    * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
    */
   sourcePath?: AgentActionPath
-}
+} & (
+  | {
+      /**
+       * When omitted, parent image value will be inferred from the target path.
+       *
+       * When specified, the `sourcePath` should be a path to an image (or image asset) field:
+       * - `['image']`
+       * - `['wrapper', 'mainImage']`
+       * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
+       *
+       * Incompatible with `imageUrl`
+       *
+       */
+      sourcePath?: AgentActionPath
+      imageUrl?: never
+    }
+  | {
+      /**
+       * When specified, the image source to be described will be fetched from the URL.
+       *
+       * Incompatible with `sourcePath`
+       */
+      imageUrl?: `https://${string}`
+      sourcePath?: never
+    }
+)
 
 /**
  *
@@ -222,6 +247,11 @@ export interface ImageDescriptionOperation {
  * - `target: {path: ['wrapper', 'title'], operation: {type: 'image-description', sourcePath: ['array', {_key: 'abc'}, 'image'] }`
  * - `target: {path: ['wrapper'], include: ['portableTextField'], operation: {type: 'image-description', sourcePath: ['image', 'asset'] }, instruction: 'Use formatting and headings to describe the image in great detail' }`
  *
+ * ### Targeting images outside the document (URL)
+ * If the source image is available on a https URL outside the target document, it is possible to get a description for it using `imageUrl`.
+ *
+ * Example:
+ * - `target: {path: ['description'], operation: operation: {type: 'image-description', imageUrL: 'https://www.sanity.io/static/images/favicons/android-icon-192x192.png?v=2' }`
  * @beta
  */
 export type TransformOperation = 'set' | ImageDescriptionOperation

package/src/data/live.ts

@@ -125,40 +125,20 @@ export class LiveClient {
       }),
     )
 
-    console.log("YES THIS IS THE CORS VERSION with the allowed origin check")
-    // Check if origin matches Kong's allowed patterns
-    const isAllowedOrigin = (origin: string): boolean => {
-      const patterns = [
-        /^http:\/\/localhost:/,
-        /^http:\/\/127\.0\.0\.1:/,
-        /^https:\/\/[^.]*\.sanity\.studio$/,
-        /^https:\/\/[^.]*\.studio\.sanity\.work$/,
-        /^https:\/\/[^.]*\.sanity\.work$/,
-        /^https:\/\/[^.]*\.sanity\.io$/
-      ]
-      return patterns.some(pattern => pattern.test(origin))
-    }
-
     // Detect if CORS is allowed, the way the CORS is checked supports preflight caching, so when the EventSource boots up it knows it sees the preflight was already made and we're good to go
     const checkCors = fetchObservable(url, {
       method: 'OPTIONS',
       mode: 'cors',
       credentials: esOptions.withCredentials ? 'include' : 'omit',
-      headers: {
-        ...esOptions.headers,
-        'Access-Control-Request-Headers': 'authorization',
-        // for this preflight check, ensure we send what the browser would send if needed
-      },
+      headers: esOptions.headers,
     }).pipe(
       mergeMap(() => EMPTY),
       catchError(() => {
+        // If the request fails, then we assume it was due to CORS, and we rethrow a special error that allows special handling in userland
         throw new CorsOriginError({projectId: projectId!})
       }),
     )
-
-    // Only run CORS check if origin is not in allowed patterns
-    const origin = typeof location !== 'undefined' ? location.origin : ''
-    const observable = (isAllowedOrigin(origin) ? events : concat(checkCors, events)).pipe(
+    const observable = concat(checkCors, events).pipe(
       finalize(() => eventsCache.delete(key)),
       shareReplayLatest({
         predicate: (event) => event.type === 'welcome',

package/umd/sanityClient.js

@@ -3417,30 +3417,17 @@ ${selectionOpts}`);
           }
           return event;
         })
-      );
-      console.log("YES THIS IS THE CORS VERSION with the allowed origin check");
-      const isAllowedOrigin = (origin2) => [
-        /^http:\/\/localhost:/,
-        /^http:\/\/127\.0\.0\.1:/,
-        /^https:\/\/[^.]*\.sanity\.studio$/,
-        /^https:\/\/[^.]*\.studio\.sanity\.work$/,
-        /^https:\/\/[^.]*\.sanity\.work$/,
-        /^https:\/\/[^.]*\.sanity\.io$/
-      ].some((pattern) => pattern.test(origin2)), checkCors = fetchObservable(url, {
+      ), checkCors = fetchObservable(url, {
         method: "OPTIONS",
         mode: "cors",
         credentials: esOptions.withCredentials ? "include" : "omit",
-        headers: {
-          ...esOptions.headers,
-          "Access-Control-Request-Headers": "authorization"
-          // for this preflight check, ensure we send what the browser would send if needed
-        }
+        headers: esOptions.headers
       }).pipe(
         mergeMap(() => EMPTY),
         catchError(() => {
           throw new CorsOriginError({ projectId: projectId2 });
         })
-      ), origin = typeof location < "u" ? location.origin : "", observable2 = (isAllowedOrigin(origin) ? events : concat(checkCors, events)).pipe(
+      ), observable2 = concat(checkCors, events).pipe(
         finalize(() => eventsCache.delete(key)),
         shareReplayLatest({
           predicate: (event) => event.type === "welcome"