@sanity/client 7.10.0 → 7.11.0-cors-check.1

package/README.md

@@ -142,6 +142,9 @@ export async function updateDocumentTitle(_id, title) {
       - [Example: Storing language in a field](#example-storing-language-in-a-field)
     - [Prompt the LLM](#prompt-the-llm)
     - [Patch with a schema-aware API](#patch-with-a-schema-aware-api)
+  - [Media Library API](#media-library-api)
+    - [Getting video playback information](#getting-video-playback-information)
+    - [Working with signed playback information](#working-with-signed-playback-information)
 - [License](#license)
 - [From `v5`](#from-v5)
   - [The default `useCdn` is changed to `true`](#the-default-usecdn-is-changed-to-true)
@@ -2273,6 +2276,104 @@ const result = await client.agent.action.patch({
 })
 ```
 
+### Media Library API
+
+The Media Library provides centralized asset management for your organization. Store, organize, and manage digital assets across multiple applications and datasets with programmatic access through the `client.mediaLibrary` interface.
+
+👉 Read more about [Media Library in Sanity](https://www.sanity.io/docs/media-library)
+
+#### Getting video playback information
+
+```js
+const client = createClient({
+  token: 'valid-token',
+  useCdn: false,
+  '~experimental_resource': {
+    type: 'media-library',
+    id: 'mediaLibraryId',
+  },
+})
+
+// Basic usage with video asset ID
+const playbackInfo = await client.mediaLibrary.video.getPlaybackInfo('video-30rh9U3GDEK3ToiId1Zje4uvalC-mp4')
+
+// With transformations
+const playbackInfo = await client.mediaLibrary.video.getPlaybackInfo('video-30rh9U3GDEK3ToiId1Zje4uvalC-mp4', {
+  transformations: {
+    thumbnail: { width: 300, format: 'webp', fit: 'smartcrop' },
+    animated: { width: 200, fps: 15, format: 'webp' }
+  },
+  expiration: 3600  // seconds
+})
+
+// Using Global Dataset Reference (GDR)
+const playbackInfo = await client.mediaLibrary.video.getPlaybackInfo({
+  _ref: 'media-library:mlZxz9rvqf76:30rh9U3GDEK3ToiId1Zje4uvalC'
+})
+```
+
+The response contains playback URLs and metadata:
+
+```js
+// Public playback response
+{
+  id: "30rh9U3GDEK3ToiId1Zje4uvalC",
+  stream: { url: "https://stream.m.sanity-cdn.com/..." },
+  thumbnail: { url: "https://image.m.sanity-cdn.com/..." },
+  animated: { url: "https://image.m.sanity-cdn.com/..." },
+  storyboard: { url: "https://storyboard.m.sanity-cdn.com/..." },
+  duration: 120.5,
+  aspectRatio: 1.77
+}
+
+// Signed playback response (when video requires authentication)
+{
+  id: "30rh9U3GDEK3ToiId1Zje4uvalC",
+  stream: { 
+    url: "https://stream.m.sanity-cdn.com/...",
+    token: "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
+  },
+  thumbnail: { 
+    url: "https://image.m.sanity-cdn.com/...",
+    token: "eyJ0a2VuIjoiVGh1bWJuYWlsVG9rZW4tMTIz..."
+  },
+  animated: { 
+    url: "https://image.m.sanity-cdn.com/...",
+    token: "eyJ0a2VuIjoiQW5pbWF0ZWRUb2tlbi1kZWY..."
+  },
+  storyboard: { 
+    url: "https://storyboard.m.sanity-cdn.com/...",
+    token: "eyJ0a2VuIjoiU3Rvcnlib2FyZFRva2VuLTc4..."
+  },
+  duration: 120.5,
+  aspectRatio: 1.77
+}
+```
+
+#### Working with signed playback information
+
+```js
+import {getPlaybackTokens, isSignedPlaybackInfo} from '@sanity/client/media-library'
+
+const playbackInfo = await client.mediaLibrary.video.getPlaybackInfo('video-30rh9U3GDEK3ToiId1Zje4uvalC-mp4')
+
+// Check if the response requires signed URLs
+if (isSignedPlaybackInfo(playbackInfo)) {
+  // Extract tokens for use with video players
+  const tokens = getPlaybackTokens(playbackInfo)
+  console.log(tokens)
+  // {
+  //   stream: "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
+  //   thumbnail: "eyJ0a2VuIjoiVGh1bWJuYWlsVG9rZW4tMTIz...",
+  //   animated: "eyJ0a2VuIjoiQW5pbWF0ZWRUb2tlbi1kZWY...",
+  //   storyboard: "eyJ0a2VuIjoiU3Rvcnlib2FyZFRva2VuLTc4..."
+  // }
+  
+  // Use with Mux Player or other compatible players
+  // The tokens authenticate access to the video resources
+}
+```
+
 ## License
 
 MIT © [Sanity.io](https://www.sanity.io/)

package/dist/index.browser.cjs

@@ -929,11 +929,19 @@ function _getDocument(client, httpRequest, id, opts = {}) {
     uri: _getDataUrl(client, "doc", docId),
     json: !0,
     tag: opts.tag,
-    signal: opts.signal
+    signal: opts.signal,
+    query: opts.includeAllVersions !== void 0 ? { includeAllVersions: opts.includeAllVersions } : void 0
   };
-  return _requestObservable(client, httpRequest, options).pipe(
+  return _requestObservable(
+    client,
+    httpRequest,
+    options
+  ).pipe(
     operators.filter(isResponse),
-    operators.map((event) => event.body.documents && event.body.documents[0])
+    operators.map((event) => {
+      const documents = event.body.documents;
+      return documents ? opts.includeAllVersions ? documents : documents[0] : opts.includeAllVersions ? [] : void 0;
+    })
   );
 }
 function _getDocuments(client, httpRequest, ids, opts = {}) {
@@ -1473,26 +1481,31 @@ class LiveClient {
       "welcome",
       "reconnect",
       "goaway"
-    ]).pipe(
-      reconnectOnConnectionFailure(),
-      operators.map((event) => {
-        if (event.type === "message") {
-          const { data, ...rest } = event;
-          return { ...rest, tags: data.tags };
-        }
-        return event;
-      })
-    ), checkCors = fetchObservable(url, {
+    ]), checkCors$ = fetchObservable(url, {
       method: "OPTIONS",
       mode: "cors",
       credentials: esOptions.withCredentials ? "include" : "omit",
       headers: esOptions.headers
     }).pipe(
-      rxjs.mergeMap(() => rxjs.EMPTY),
       rxjs.catchError(() => {
         throw new CorsOriginError({ projectId: projectId2 });
+      }),
+      operators.shareReplay(1)
+      // run only once
+    ), observable = events.pipe(
+      // Do our best to detect CORS errors first
+      rxjs.catchError((err) => checkCors$.pipe(rxjs.mergeMap(() => {
+        throw err;
+      }))),
+      reconnectOnConnectionFailure(),
+      operators.map((event) => {
+        if (event.type === "message") {
+          const { data, ...rest } = event;
+          return { ...rest, tags: data.tags };
+        }
+        return event;
       })
-    ), observable = rxjs.concat(checkCors, events).pipe(
+    ).pipe(
       operators.finalize(() => eventsCache.delete(key)),
       shareReplayLatest({
         predicate: (event) => event.type === "welcome"
@@ -1616,6 +1629,80 @@ function _modify(client, httpRequest, method, name, options) {
     tag: null
   });
 }
+class ObservableMediaLibraryVideoClient {
+  #client;
+  #httpRequest;
+  constructor(client, httpRequest) {
+    this.#client = client, this.#httpRequest = httpRequest;
+  }
+  /**
+   * Get video playback information for a media library asset
+   *
+   * @param assetIdentifier - Asset instance identifier (GDR, video-prefixed ID, or container ID)
+   * @param options - Options for transformations and expiration
+   */
+  getPlaybackInfo(assetIdentifier, options = {}) {
+    const configMediaLibraryId = this.#client.config()["~experimental_resource"]?.id, { instanceId, libraryId } = parseAssetInstanceId(assetIdentifier), effectiveLibraryId = libraryId || configMediaLibraryId;
+    if (!effectiveLibraryId)
+      throw new Error(
+        "Could not determine Media Library ID - you need to provide a valid Media Library ID in the client config or a Media Library GDR"
+      );
+    const uri = buildVideoPlaybackInfoUrl(instanceId, effectiveLibraryId), queryParams = buildQueryParams(options);
+    return _request(this.#client, this.#httpRequest, {
+      method: "GET",
+      uri,
+      query: queryParams
+    });
+  }
+}
+class MediaLibraryVideoClient {
+  #client;
+  #httpRequest;
+  constructor(client, httpRequest) {
+    this.#client = client, this.#httpRequest = httpRequest;
+  }
+  /**
+   * Get video playback information for a media library asset
+   *
+   * @param assetIdentifier - Asset instance identifier (GDR, video-prefixed ID, or container ID)
+   * @param options - Options for transformations and expiration
+   */
+  getPlaybackInfo(assetIdentifier, options = {}) {
+    return rxjs.lastValueFrom(
+      new ObservableMediaLibraryVideoClient(
+        this.#client.observable,
+        this.#httpRequest
+      ).getPlaybackInfo(assetIdentifier, options)
+    );
+  }
+}
+const ML_GDR_PATTERN = /^media-library:(ml[^:]+):([^:]+)$/;
+function isSanityReference(assetIdentifier) {
+  return typeof assetIdentifier == "object" && "_ref" in assetIdentifier;
+}
+function parseAssetInstanceId(assetIdentifier) {
+  const ref = isSanityReference(assetIdentifier) ? assetIdentifier._ref : assetIdentifier, match = ML_GDR_PATTERN.exec(ref);
+  if (match) {
+    const [, libraryId, instanceId] = match;
+    return { libraryId, instanceId };
+  }
+  if (typeof assetIdentifier == "string" && assetIdentifier.startsWith("video-"))
+    return { instanceId: assetIdentifier };
+  throw new Error(
+    `Invalid video asset instance identifier "${ref}": must be a valid video instance id or a Global Dataset Reference (GDR) to the video asset in the Media Library`
+  );
+}
+function buildVideoPlaybackInfoUrl(instanceId, libraryId) {
+  return `/media-libraries/${libraryId}/video/${instanceId}/playback-info`;
+}
+function buildQueryParams(options) {
+  const params = {};
+  if (options.transformations) {
+    const { thumbnail, animated, storyboard } = options.transformations;
+    thumbnail && (thumbnail.width && (params.thumbnailWidth = thumbnail.width), thumbnail.height && (params.thumbnailHeight = thumbnail.height), thumbnail.time !== void 0 && (params.thumbnailTime = thumbnail.time), thumbnail.fit && (params.thumbnailFit = thumbnail.fit), thumbnail.format && (params.thumbnailFormat = thumbnail.format)), animated && (animated.width && (params.animatedWidth = animated.width), animated.height && (params.animatedHeight = animated.height), animated.start !== void 0 && (params.animatedStart = animated.start), animated.end !== void 0 && (params.animatedEnd = animated.end), animated.fps && (params.animatedFps = animated.fps), animated.format && (params.animatedFormat = animated.format)), storyboard && storyboard.format && (params.storyboardFormat = storyboard.format);
+  }
+  return options.expiration && (params.expiration = options.expiration), params;
+}
 class ObservableProjectsClient {
   #client;
   #httpRequest;
@@ -2190,6 +2277,7 @@ class ObservableSanityClient {
   assets;
   datasets;
   live;
+  mediaLibrary;
   projects;
   users;
   agent;
@@ -2204,7 +2292,9 @@ class ObservableSanityClient {
    */
   listen = _listen;
   constructor(httpRequest, config = defaultConfig) {
-    this.config(config), this.#httpRequest = httpRequest, this.assets = new ObservableAssetsClient(this, this.#httpRequest), this.datasets = new ObservableDatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.projects = new ObservableProjectsClient(this, this.#httpRequest), this.users = new ObservableUsersClient(this, this.#httpRequest), this.agent = {
+    this.config(config), this.#httpRequest = httpRequest, this.assets = new ObservableAssetsClient(this, this.#httpRequest), this.datasets = new ObservableDatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.mediaLibrary = {
+      video: new ObservableMediaLibraryVideoClient(this, this.#httpRequest)
+    }, this.projects = new ObservableProjectsClient(this, this.#httpRequest), this.users = new ObservableUsersClient(this, this.#httpRequest), this.agent = {
       action: new ObservableAgentsActionClient(this, this.#httpRequest)
     }, this.releases = new ObservableReleasesClient(this, this.#httpRequest);
   }
@@ -2249,14 +2339,19 @@ class ObservableSanityClient {
       options
     );
   }
-  /**
-   * Fetch a single document with the given ID.
-   *
-   * @param id - Document ID to fetch
-   * @param options - Request options
-   */
   getDocument(id, options) {
-    return _getDocument(this, this.#httpRequest, id, options);
+    if (options?.includeAllVersions === !0)
+      return _getDocument(this, this.#httpRequest, id, {
+        ...options,
+        includeAllVersions: !0
+      });
+    const opts = {
+      signal: options?.signal,
+      tag: options?.tag,
+      releaseId: options?.releaseId,
+      ...options && "includeAllVersions" in options ? { includeAllVersions: !1 } : {}
+    };
+    return _getDocument(this, this.#httpRequest, id, opts);
   }
   /**
    * Fetch multiple documents in one request.
@@ -2442,6 +2537,7 @@ class SanityClient {
   assets;
   datasets;
   live;
+  mediaLibrary;
   projects;
   users;
   agent;
@@ -2460,7 +2556,9 @@ class SanityClient {
    */
   listen = _listen;
   constructor(httpRequest, config = defaultConfig) {
-    this.config(config), this.#httpRequest = httpRequest, this.assets = new AssetsClient(this, this.#httpRequest), this.datasets = new DatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.projects = new ProjectsClient(this, this.#httpRequest), this.users = new UsersClient(this, this.#httpRequest), this.agent = {
+    this.config(config), this.#httpRequest = httpRequest, this.assets = new AssetsClient(this, this.#httpRequest), this.datasets = new DatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.mediaLibrary = {
+      video: new MediaLibraryVideoClient(this, this.#httpRequest)
+    }, this.projects = new ProjectsClient(this, this.#httpRequest), this.users = new UsersClient(this, this.#httpRequest), this.agent = {
       action: new AgentActionsClient(this, this.#httpRequest)
     }, this.releases = new ReleasesClient(this, this.#httpRequest), this.observable = new ObservableSanityClient(httpRequest, config);
   }
@@ -2507,14 +2605,21 @@ class SanityClient {
       )
     );
   }
-  /**
-   * Fetch a single document with the given ID.
-   *
-   * @param id - Document ID to fetch
-   * @param options - Request options
-   */
   getDocument(id, options) {
-    return rxjs.lastValueFrom(_getDocument(this, this.#httpRequest, id, options));
+    if (options?.includeAllVersions === !0)
+      return rxjs.lastValueFrom(
+        _getDocument(this, this.#httpRequest, id, {
+          ...options,
+          includeAllVersions: !0
+        })
+      );
+    const opts = {
+      signal: options?.signal,
+      tag: options?.tag,
+      releaseId: options?.releaseId,
+      ...options && "includeAllVersions" in options ? { includeAllVersions: !1 } : {}
+    };
+    return rxjs.lastValueFrom(_getDocument(this, this.#httpRequest, id, opts));
   }
   /**
    * Fetch multiple documents in one request.