@sanity/media-library-types 1.0.2 → 1.1.0

package/lib/index.cjs

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=index.cjs.map

package/lib/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/lib/{index.d.mts → index.d.cts}

@@ -5,6 +5,7 @@ import {ComponentType} from 'react'
 import {ElementType} from 'react'
 import {ReactNode} from 'react'
 import {SanityClient} from '@sanity/client'
+import {StackablePerspective} from '@sanity/client'
 
 /**
  * Types of array actions that can be performed
@@ -945,8 +946,10 @@ declare interface File_2 {
 }
 
 /** @public */
-declare interface FileDefinition
-  extends Omit<ObjectDefinition, 'type' | 'fields' | 'options' | 'groups' | 'validation'> {
+declare interface FileDefinition extends Omit<
+  ObjectDefinition,
+  'type' | 'fields' | 'options' | 'groups' | 'validation'
+> {
   type: 'file'
   fields?: ObjectDefinition['fields']
   options?: FileOptions
@@ -1102,8 +1105,10 @@ declare interface ImageCrop {
 }
 
 /** @public */
-declare interface ImageDefinition
-  extends Omit<ObjectDefinition, 'type' | 'fields' | 'options' | 'groups' | 'validation'> {
+declare interface ImageDefinition extends Omit<
+  ObjectDefinition,
+  'type' | 'fields' | 'options' | 'groups' | 'validation'
+> {
   type: 'image'
   fields?: FieldDefinition[]
   options?: ImageOptions
@@ -1514,6 +1519,34 @@ declare type Path = PathSegment[]
 /** @public */
 declare type PathSegment = string | number | KeyedSegment | IndexTuple
 
+/**
+ * Media Library capabilities that the consumer can declare it supports
+ */
+export declare type PluginCapabilities = {
+  privateAssets?: boolean
+}
+
+/**
+ * Filter that the plugin consumer can use to limit the assets shown
+ */
+export declare type PluginFilter = {
+  type: 'groq'
+  name: string
+  query: string
+}
+
+/**
+ * Payload used to configure the plugin behavior
+ */
+export declare type PluginPayload = {
+  auth: 'token' | 'cookie'
+  capabilities?: PluginCapabilities
+  pluginFilters?: PluginFilter[]
+  scheme: 'light' | 'dark'
+  selectAssetTypes: PluginSelectAssetType[]
+  selectionType: 'single' | 'multiple'
+}
+
 export declare type PluginPostMessage =
   | PluginPostMessageAbortUploadRequest
   | PluginPostMessageAssetSelection
@@ -1602,6 +1635,11 @@ export declare type PluginPostMessageUploadFilesResponse = {
   assets: AssetSelectionItemWithLegacySupport[]
 }
 
+/**
+ * Asset types that can be selected by the plugin
+ */
+export declare type PluginSelectAssetType = 'file' | 'image' | 'video'
+
 /** @public */
 declare interface PrepareViewOptions {
   /** @beta */
@@ -1679,6 +1717,7 @@ declare interface ReferenceFilterResolverContext {
   document: SanityDocument
   parent?: Record<string, unknown> | Record<string, unknown>[]
   parentPath: Path
+  perspective: StackablePerspective[]
   getClient: (options: {apiVersion: string}) => SanityClient
 }
 
@@ -1695,7 +1734,7 @@ declare type ReferenceFilterSearchOptions = {
   tag?: string
   maxFieldDepth?: number
   strategy?: SearchStrategy
-  perspective?: ClientPerspective
+  perspective?: Exclude<ClientPerspective, 'raw' | 'previewDrafts'>
 }
 
 /**
@@ -2109,6 +2148,7 @@ declare type SanityFileAsset = {
   path: string
   extension?: string
   url: string
+  previewUrl?: string
 }
 
 declare type SanityImageAsset = {
@@ -2264,6 +2304,11 @@ declare type SanityVideoMetadata = {
       _key: string
     } & SanityVideoMetadataPlayback
   >
+  renditions?: Array<
+    {
+      _key: string
+    } & SanityVideoMetadataRendition
+  >
 }
 
 declare type SanityVideoMetadataPlayback = {
@@ -2273,6 +2318,12 @@ declare type SanityVideoMetadataPlayback = {
   policy: string
 }
 
+export declare type SanityVideoMetadataRendition = {
+  _type: 'sanity.videoMetadata.rendition'
+  name: string
+  resolution: string
+}
+
 /** @public */
 declare interface Schema {
   /** @internal */
@@ -2535,9 +2586,7 @@ declare interface StringDefinition extends BaseSchemaDefinition {
 
 /** @public */
 declare interface StringOptions
-  extends EnumListProps<string>,
-    SearchConfiguration,
-    BaseSchemaTypeOptions {}
+  extends EnumListProps<string>, SearchConfiguration, BaseSchemaTypeOptions {}
 
 /** @public */
 declare interface StringRule extends RuleDef<StringRule, string> {
@@ -2739,6 +2788,13 @@ declare interface ValidationError {
    * the document.
    */
   path?: Path
+  /**
+   * Extra metadata for the validation error. Currently used by the Media Library asset source to ignore
+   * certain validation markers when validating asset source media library assets.
+   *
+   * @internal
+   */
+  __internal_metadata?: unknown
   /**
    * Same as `path` but allows more than one value. If provided, the same
    * message will create two markers from each path with the same message
@@ -2780,6 +2836,13 @@ declare interface ValidationMarker {
    * are not compatible with deep getters like lodash/get
    */
   path: Path
+  /**
+   * Extra metadata for the validation marker. Currently used by the Media Library asset source to ignore
+   * certain validation markers when validating asset source media library assets.
+   *
+   * @internal
+   */
+  __internal_metadata?: unknown
 }
 
 export {}

package/lib/index.d.ts

@@ -5,6 +5,7 @@ import {ComponentType} from 'react'
 import {ElementType} from 'react'
 import {ReactNode} from 'react'
 import {SanityClient} from '@sanity/client'
+import {StackablePerspective} from '@sanity/client'
 
 /**
  * Types of array actions that can be performed
@@ -945,8 +946,10 @@ declare interface File_2 {
 }
 
 /** @public */
-declare interface FileDefinition
-  extends Omit<ObjectDefinition, 'type' | 'fields' | 'options' | 'groups' | 'validation'> {
+declare interface FileDefinition extends Omit<
+  ObjectDefinition,
+  'type' | 'fields' | 'options' | 'groups' | 'validation'
+> {
   type: 'file'
   fields?: ObjectDefinition['fields']
   options?: FileOptions
@@ -1102,8 +1105,10 @@ declare interface ImageCrop {
 }
 
 /** @public */
-declare interface ImageDefinition
-  extends Omit<ObjectDefinition, 'type' | 'fields' | 'options' | 'groups' | 'validation'> {
+declare interface ImageDefinition extends Omit<
+  ObjectDefinition,
+  'type' | 'fields' | 'options' | 'groups' | 'validation'
+> {
   type: 'image'
   fields?: FieldDefinition[]
   options?: ImageOptions
@@ -1514,6 +1519,34 @@ declare type Path = PathSegment[]
 /** @public */
 declare type PathSegment = string | number | KeyedSegment | IndexTuple
 
+/**
+ * Media Library capabilities that the consumer can declare it supports
+ */
+export declare type PluginCapabilities = {
+  privateAssets?: boolean
+}
+
+/**
+ * Filter that the plugin consumer can use to limit the assets shown
+ */
+export declare type PluginFilter = {
+  type: 'groq'
+  name: string
+  query: string
+}
+
+/**
+ * Payload used to configure the plugin behavior
+ */
+export declare type PluginPayload = {
+  auth: 'token' | 'cookie'
+  capabilities?: PluginCapabilities
+  pluginFilters?: PluginFilter[]
+  scheme: 'light' | 'dark'
+  selectAssetTypes: PluginSelectAssetType[]
+  selectionType: 'single' | 'multiple'
+}
+
 export declare type PluginPostMessage =
   | PluginPostMessageAbortUploadRequest
   | PluginPostMessageAssetSelection
@@ -1602,6 +1635,11 @@ export declare type PluginPostMessageUploadFilesResponse = {
   assets: AssetSelectionItemWithLegacySupport[]
 }
 
+/**
+ * Asset types that can be selected by the plugin
+ */
+export declare type PluginSelectAssetType = 'file' | 'image' | 'video'
+
 /** @public */
 declare interface PrepareViewOptions {
   /** @beta */
@@ -1679,6 +1717,7 @@ declare interface ReferenceFilterResolverContext {
   document: SanityDocument
   parent?: Record<string, unknown> | Record<string, unknown>[]
   parentPath: Path
+  perspective: StackablePerspective[]
   getClient: (options: {apiVersion: string}) => SanityClient
 }
 
@@ -1695,7 +1734,7 @@ declare type ReferenceFilterSearchOptions = {
   tag?: string
   maxFieldDepth?: number
   strategy?: SearchStrategy
-  perspective?: ClientPerspective
+  perspective?: Exclude<ClientPerspective, 'raw' | 'previewDrafts'>
 }
 
 /**
@@ -2109,6 +2148,7 @@ declare type SanityFileAsset = {
   path: string
   extension?: string
   url: string
+  previewUrl?: string
 }
 
 declare type SanityImageAsset = {
@@ -2264,6 +2304,11 @@ declare type SanityVideoMetadata = {
       _key: string
     } & SanityVideoMetadataPlayback
   >
+  renditions?: Array<
+    {
+      _key: string
+    } & SanityVideoMetadataRendition
+  >
 }
 
 declare type SanityVideoMetadataPlayback = {
@@ -2273,6 +2318,12 @@ declare type SanityVideoMetadataPlayback = {
   policy: string
 }
 
+export declare type SanityVideoMetadataRendition = {
+  _type: 'sanity.videoMetadata.rendition'
+  name: string
+  resolution: string
+}
+
 /** @public */
 declare interface Schema {
   /** @internal */
@@ -2535,9 +2586,7 @@ declare interface StringDefinition extends BaseSchemaDefinition {
 
 /** @public */
 declare interface StringOptions
-  extends EnumListProps<string>,
-    SearchConfiguration,
-    BaseSchemaTypeOptions {}
+  extends EnumListProps<string>, SearchConfiguration, BaseSchemaTypeOptions {}
 
 /** @public */
 declare interface StringRule extends RuleDef<StringRule, string> {
@@ -2739,6 +2788,13 @@ declare interface ValidationError {
    * the document.
    */
   path?: Path
+  /**
+   * Extra metadata for the validation error. Currently used by the Media Library asset source to ignore
+   * certain validation markers when validating asset source media library assets.
+   *
+   * @internal
+   */
+  __internal_metadata?: unknown
   /**
    * Same as `path` but allows more than one value. If provided, the same
    * message will create two markers from each path with the same message
@@ -2780,6 +2836,13 @@ declare interface ValidationMarker {
    * are not compatible with deep getters like lodash/get
    */
   path: Path
+  /**
+   * Extra metadata for the validation marker. Currently used by the Media Library asset source to ignore
+   * certain validation markers when validating asset source media library assets.
+   *
+   * @internal
+   */
+  __internal_metadata?: unknown
 }
 
 export {}

package/lib/index.js

@@ -1,2 +1,2 @@
-"use strict";
+
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/media-library-types",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Type definitions for common Sanity Media Library data structures",
   "keywords": [
     "sanity",
@@ -19,26 +19,26 @@
   "license": "MIT",
   "author": "Sanity.io <hello@sanity.io>",
   "sideEffects": false,
-  "type": "commonjs",
+  "type": "module",
   "exports": {
     ".": {
       "source": "./src/index.ts",
-      "import": "./lib/index.mjs",
-      "require": "./lib/index.js",
+      "import": "./lib/index.js",
+      "require": "./lib/index.cjs",
       "default": "./lib/index.js"
     },
     "./package.json": "./package.json"
   },
-  "main": "./lib/index.js",
-  "module": "./lib/index.mjs",
+  "main": "./lib/index.cjs",
+  "module": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "files": [
     "lib",
     "src"
   ],
   "devDependencies": {
-    "@sanity/pkg-utils": "^8.1.29",
-    "@sanity/types": "^4.15.0",
+    "@sanity/pkg-utils": "^10.2.5",
+    "@sanity/types": "4.20.0",
     "rimraf": "^5.0.10"
   },
   "scripts": {

package/src/assets.ts

@@ -8,7 +8,11 @@ import {
 } from './schema.types'
 import {type FieldDefinition} from '@sanity/types'
 
-export type {SanityVideoAsset, SanityAssetUploadSession as UploadSession} from './schema.types'
+export type {
+  SanityVideoAsset,
+  SanityAssetUploadSession as UploadSession,
+  SanityVideoMetadataRendition,
+} from './schema.types'
 
 export interface AssetVersion<AssetInstance extends AssetInstanceDocument = AssetInstanceDocument> {
   _key: string

package/src/plugin.ts

@@ -1,5 +1,38 @@
-import { Asset } from "./assets"
-import { FileUpload } from "./files"
+import {Asset} from './assets'
+import {FileUpload} from './files'
+
+/**
+ * Media Library capabilities that the consumer can declare it supports
+ */
+export type PluginCapabilities = {
+  privateAssets?: boolean
+}
+
+/**
+ * Filter that the plugin consumer can use to limit the assets shown
+ */
+export type PluginFilter = {
+  type: 'groq'
+  name: string
+  query: string
+}
+
+/**
+ * Asset types that can be selected by the plugin
+ */
+export type PluginSelectAssetType = 'file' | 'image' | 'video'
+
+/**
+ * Payload used to configure the plugin behavior
+ */
+export type PluginPayload = {
+  auth: 'token' | 'cookie'
+  capabilities?: PluginCapabilities
+  pluginFilters?: PluginFilter[]
+  scheme: 'light' | 'dark'
+  selectAssetTypes: PluginSelectAssetType[]
+  selectionType: 'single' | 'multiple'
+}
 
 /**
  * Message sent from the plugin when files are uploading

package/src/schema.types.ts

@@ -39,6 +39,12 @@ export type SanityAssetCollection = {
   }>
 }
 
+export type SanityVideoMetadataRendition = {
+  _type: 'sanity.videoMetadata.rendition'
+  name: string
+  resolution: string
+}
+
 export type SanityVideoMetadataPlayback = {
   _type: 'sanity.videoMetadata.playback'
   _id: string
@@ -56,6 +62,11 @@ export type SanityVideoMetadata = {
       _key: string
     } & SanityVideoMetadataPlayback
   >
+  renditions?: Array<
+    {
+      _key: string
+    } & SanityVideoMetadataRendition
+  >
 }
 
 export type SanityImageExifTags = {
@@ -261,6 +272,7 @@ export type SanityFileAsset = {
   path: string
   extension?: string
   url: string
+  previewUrl?: string
 }
 
 export type SanityImageAsset = {
@@ -293,6 +305,7 @@ export type AllSanitySchemaTypes =
   | SanitySystem
   | SanityAssetUploadSession
   | SanityAssetCollection
+  | SanityVideoMetadataRendition
   | SanityVideoMetadataPlayback
   | SanityVideoMetadata
   | SanityImageExifTags

package/lib/index.mjs

@@ -1,2 +0,0 @@
-
-//# sourceMappingURL=index.mjs.map

package/lib/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}