@sanity/media-library-types 1.0.0 → 1.0.1

package/lib/index.d.mts

@@ -1,3 +1,5 @@
+import {Asset as Asset_3} from '@sanity/media-library-types'
+import {AssetInstanceDocument as AssetInstanceDocument_2} from '@sanity/media-library-types'
 import {ClientPerspective} from '@sanity/client'
 import {ComponentType} from 'react'
 import {ElementType} from 'react'
@@ -178,14 +180,14 @@ declare interface AssetSource {
   component: ComponentType<AssetSourceComponentProps>
   icon?: ComponentType<EmptyProps>
   /** @beta */
-  uploader?: AssetSourceUploader
+  Uploader?: AssetSourceUploaderClass
 }
 
 /** @public */
 declare interface AssetSourceComponentProps {
   action?: 'select' | 'upload'
   assetSource: AssetSource
-  assetType?: 'file' | 'image'
+  assetType?: 'file' | 'image' | 'sanity.video'
   accept: string
   selectionType: 'single'
   dialogHeaderTitle?: React.ReactNode
@@ -193,6 +195,8 @@ declare interface AssetSourceComponentProps {
   onClose: () => void
   onSelect: (assetFromSource: AssetFromSource[]) => void
   schemaType?: ImageSchemaType | FileSchemaType
+  /** @beta */
+  uploader?: AssetSourceUploader
 }
 
 /** @public */
@@ -248,6 +252,9 @@ declare interface AssetSourceUploader {
   reset(): void
 }
 
+/** @beta */
+declare type AssetSourceUploaderClass = new (...args: any[]) => AssetSourceUploader
+
 /** @beta */
 declare type AssetSourceUploadEvent =
   | AssetSourceUploadEventProgress
@@ -309,7 +316,7 @@ declare interface AssetSourceUploadFile {
   id: string
   file: globalThis.File
   progress: number
-  status: 'pending' | 'uploading' | 'complete' | 'error' | 'aborted'
+  status: 'pending' | 'uploading' | 'complete' | 'error' | 'aborted' | 'alreadyExists'
   error?: Error
   result?: unknown
 }
@@ -368,6 +375,9 @@ declare interface BaseSchemaType extends Partial<DeprecationConfiguration> {
     input?: ComponentType<any>
     item?: ComponentType<any>
     preview?: ComponentType<any>
+    portableText?: {
+      plugins?: ComponentType<any>
+    }
   }
   /**
    * @deprecated This will be removed.
@@ -405,7 +415,7 @@ declare interface BaseSchemaTypeOptions {
  *           {title: 'Strong', value: 'strong'},
  *           {title: 'Emphasis', value: 'em'},
  *           {title: 'Underline', value: 'underline'},
- *           {title: 'Strike', value: 'strike'},
+ *           {title: 'Strike', value: 'strike-through'},
  *           {title: 'Code', value: 'code'},
  *         ]
  *       }
@@ -439,7 +449,7 @@ declare interface BlockDecoratorDefinition {
  *           {title: 'Strong', value: 'strong'},
  *           {title: 'Emphasis', value: 'em'},
  *           {title: 'Underline', value: 'underline'},
- *           {title: 'Strike', value: 'strike'},
+ *           {title: 'Strike', value: 'strike-through'},
  *           {title: 'Code', value: 'code'},
  *         ],
  *         annotations: [
@@ -532,6 +542,16 @@ declare interface BlockOptions extends BaseSchemaTypeOptions {
    */
   spellCheck?: boolean
   unstable_whitespaceOnPasteMode?: 'preserve' | 'normalize' | 'remove'
+  /**
+   * When enabled, the editor will restrict all line breaks and soft breaks,
+   * forcing content to remain on a single line. This will also update
+   * the styling of the editor to reflect the single-line constraint.
+   *
+   * Pasting content that is on multiple lines will be normalized to a single line, if possible.
+   *
+   * @defaultValue false
+   */
+  oneLine?: boolean
 }
 
 /** @public */
@@ -754,6 +774,8 @@ declare interface DatetimeOptions extends BaseSchemaTypeOptions {
   dateFormat?: string
   timeFormat?: string
   timeStep?: number
+  displayTimeZone?: string
+  allowTimeZoneSwitch?: boolean
 }
 
 /** @public */
@@ -935,6 +957,7 @@ declare interface FileOptions extends ObjectOptions {
   storeOriginalFilename?: boolean
   accept?: string
   sources?: AssetSource[]
+  mediaLibrary?: MediaLibraryOptions
 }
 
 /** @public */
@@ -960,7 +983,7 @@ declare interface FileSchemaType extends Omit<ObjectSchemaType, 'options'> {
   options?: FileOptions
 }
 
-export declare type FileStatus = 'pending' | 'uploading' | 'complete' | 'error'
+export declare type FileStatus = 'pending' | 'uploading' | 'complete' | 'error' | 'alreadyExists'
 
 /**
  * Wrapper object for the file upload with progress and status
@@ -1217,24 +1240,28 @@ declare interface InsertMenuOptions {
    * `filter: 'auto'` automatically turns on filtering if there are more than 5
    * schema types added to the menu.
    */
-  filter?: 'auto' | boolean
-  groups?: Array<{
-    name: string
-    title?: string
-    of?: Array<string>
-  }>
+  filter?: 'auto' | boolean | undefined
+  groups?:
+    | Array<{
+        name: string
+        title?: string
+        of?: Array<string>
+      }>
+    | undefined
   /** defaultValue `true` */
-  showIcons?: boolean
+  showIcons?: boolean | undefined
   /** @defaultValue `[{name: 'list'}]` */
-  views?: Array<
-    | {
-        name: 'list'
-      }
-    | {
-        name: 'grid'
-        previewImageUrl?: (schemaTypeName: string) => string | undefined
-      }
-  >
+  views?:
+    | Array<
+        | {
+            name: 'list'
+          }
+        | {
+            name: 'grid'
+            previewImageUrl?: (schemaTypeName: string) => string | undefined
+          }
+      >
+    | undefined
 }
 
 declare const internalGroqTypeReferenceTo: unique symbol
@@ -1317,6 +1344,52 @@ declare interface LocalizedValidationMessages {
   [locale: string]: string
 }
 
+/** @public */
+declare type MediaAssetTypes = AssetInstanceDocument_2['_type']
+
+/** @public */
+declare interface MediaLibraryFilter {
+  name: string
+  query: string
+}
+
+/** @public */
+declare interface MediaLibraryOptions {
+  filters?: MediaLibraryFilter[]
+}
+
+/** @public */
+declare interface MediaValidationValue<T extends MediaAssetTypes = MediaAssetTypes> {
+  /**
+   * Media information
+   */
+  media: {
+    /**
+     * The Media Library Asset.
+     */
+    asset: Asset_3 & {
+      currentVersion: Extract<
+        AssetInstanceDocument_2,
+        {
+          _type: T
+        }
+      >
+    }
+  }
+  /**
+   * The field value which the media is used in.
+   */
+  value: unknown
+}
+
+/** @public */
+declare interface MediaValidator<T extends MediaAssetTypes = MediaAssetTypes> {
+  (
+    value: MediaValidationValue<T>,
+    context: ValidationContext,
+  ): CustomValidatorResult | Promise<CustomValidatorResult>
+}
+
 /** @public */
 declare interface MultiFieldSet {
   name: string
@@ -1741,6 +1814,7 @@ declare interface Rule {
       bypassConcurrencyLimit?: boolean
     },
   ): Rule
+  media<T extends MediaAssetTypes = MediaAssetTypes>(fn: MediaValidator<T>): Rule
   min(len: number | string | FieldReference): Rule
   max(len: number | string | FieldReference): Rule
   length(len: number | FieldReference): Rule
@@ -1844,15 +1918,15 @@ declare type RuleSpec =
     }
   | {
       flag: 'min'
-      constraint: number | string
+      constraint: number | string | FieldReference
     }
   | {
       flag: 'max'
-      constraint: number | string
+      constraint: number | string | FieldReference
     }
   | {
       flag: 'length'
-      constraint: number
+      constraint: number | FieldReference
     }
   | {
       flag: 'valid'
@@ -1860,15 +1934,15 @@ declare type RuleSpec =
     }
   | {
       flag: 'precision'
-      constraint: number
+      constraint: number | FieldReference
     }
   | {
       flag: 'lessThan'
-      constraint: number
+      constraint: number | FieldReference
     }
   | {
       flag: 'greaterThan'
-      constraint: number
+      constraint: number | FieldReference
     }
   | {
       flag: 'stringCasing'
@@ -1880,6 +1954,10 @@ declare type RuleSpec =
         assetType: 'asset' | 'image' | 'file'
       }
     }
+  | {
+      flag: 'media'
+      constraint: MediaValidator<any>
+    }
   | {
       flag: 'regex'
       constraint: {

package/lib/index.d.ts

@@ -1,3 +1,5 @@
+import {Asset as Asset_3} from '@sanity/media-library-types'
+import {AssetInstanceDocument as AssetInstanceDocument_2} from '@sanity/media-library-types'
 import {ClientPerspective} from '@sanity/client'
 import {ComponentType} from 'react'
 import {ElementType} from 'react'
@@ -178,14 +180,14 @@ declare interface AssetSource {
   component: ComponentType<AssetSourceComponentProps>
   icon?: ComponentType<EmptyProps>
   /** @beta */
-  uploader?: AssetSourceUploader
+  Uploader?: AssetSourceUploaderClass
 }
 
 /** @public */
 declare interface AssetSourceComponentProps {
   action?: 'select' | 'upload'
   assetSource: AssetSource
-  assetType?: 'file' | 'image'
+  assetType?: 'file' | 'image' | 'sanity.video'
   accept: string
   selectionType: 'single'
   dialogHeaderTitle?: React.ReactNode
@@ -193,6 +195,8 @@ declare interface AssetSourceComponentProps {
   onClose: () => void
   onSelect: (assetFromSource: AssetFromSource[]) => void
   schemaType?: ImageSchemaType | FileSchemaType
+  /** @beta */
+  uploader?: AssetSourceUploader
 }
 
 /** @public */
@@ -248,6 +252,9 @@ declare interface AssetSourceUploader {
   reset(): void
 }
 
+/** @beta */
+declare type AssetSourceUploaderClass = new (...args: any[]) => AssetSourceUploader
+
 /** @beta */
 declare type AssetSourceUploadEvent =
   | AssetSourceUploadEventProgress
@@ -309,7 +316,7 @@ declare interface AssetSourceUploadFile {
   id: string
   file: globalThis.File
   progress: number
-  status: 'pending' | 'uploading' | 'complete' | 'error' | 'aborted'
+  status: 'pending' | 'uploading' | 'complete' | 'error' | 'aborted' | 'alreadyExists'
   error?: Error
   result?: unknown
 }
@@ -368,6 +375,9 @@ declare interface BaseSchemaType extends Partial<DeprecationConfiguration> {
     input?: ComponentType<any>
     item?: ComponentType<any>
     preview?: ComponentType<any>
+    portableText?: {
+      plugins?: ComponentType<any>
+    }
   }
   /**
    * @deprecated This will be removed.
@@ -405,7 +415,7 @@ declare interface BaseSchemaTypeOptions {
  *           {title: 'Strong', value: 'strong'},
  *           {title: 'Emphasis', value: 'em'},
  *           {title: 'Underline', value: 'underline'},
- *           {title: 'Strike', value: 'strike'},
+ *           {title: 'Strike', value: 'strike-through'},
  *           {title: 'Code', value: 'code'},
  *         ]
  *       }
@@ -439,7 +449,7 @@ declare interface BlockDecoratorDefinition {
  *           {title: 'Strong', value: 'strong'},
  *           {title: 'Emphasis', value: 'em'},
  *           {title: 'Underline', value: 'underline'},
- *           {title: 'Strike', value: 'strike'},
+ *           {title: 'Strike', value: 'strike-through'},
  *           {title: 'Code', value: 'code'},
  *         ],
  *         annotations: [
@@ -532,6 +542,16 @@ declare interface BlockOptions extends BaseSchemaTypeOptions {
    */
   spellCheck?: boolean
   unstable_whitespaceOnPasteMode?: 'preserve' | 'normalize' | 'remove'
+  /**
+   * When enabled, the editor will restrict all line breaks and soft breaks,
+   * forcing content to remain on a single line. This will also update
+   * the styling of the editor to reflect the single-line constraint.
+   *
+   * Pasting content that is on multiple lines will be normalized to a single line, if possible.
+   *
+   * @defaultValue false
+   */
+  oneLine?: boolean
 }
 
 /** @public */
@@ -754,6 +774,8 @@ declare interface DatetimeOptions extends BaseSchemaTypeOptions {
   dateFormat?: string
   timeFormat?: string
   timeStep?: number
+  displayTimeZone?: string
+  allowTimeZoneSwitch?: boolean
 }
 
 /** @public */
@@ -935,6 +957,7 @@ declare interface FileOptions extends ObjectOptions {
   storeOriginalFilename?: boolean
   accept?: string
   sources?: AssetSource[]
+  mediaLibrary?: MediaLibraryOptions
 }
 
 /** @public */
@@ -960,7 +983,7 @@ declare interface FileSchemaType extends Omit<ObjectSchemaType, 'options'> {
   options?: FileOptions
 }
 
-export declare type FileStatus = 'pending' | 'uploading' | 'complete' | 'error'
+export declare type FileStatus = 'pending' | 'uploading' | 'complete' | 'error' | 'alreadyExists'
 
 /**
  * Wrapper object for the file upload with progress and status
@@ -1217,24 +1240,28 @@ declare interface InsertMenuOptions {
    * `filter: 'auto'` automatically turns on filtering if there are more than 5
    * schema types added to the menu.
    */
-  filter?: 'auto' | boolean
-  groups?: Array<{
-    name: string
-    title?: string
-    of?: Array<string>
-  }>
+  filter?: 'auto' | boolean | undefined
+  groups?:
+    | Array<{
+        name: string
+        title?: string
+        of?: Array<string>
+      }>
+    | undefined
   /** defaultValue `true` */
-  showIcons?: boolean
+  showIcons?: boolean | undefined
   /** @defaultValue `[{name: 'list'}]` */
-  views?: Array<
-    | {
-        name: 'list'
-      }
-    | {
-        name: 'grid'
-        previewImageUrl?: (schemaTypeName: string) => string | undefined
-      }
-  >
+  views?:
+    | Array<
+        | {
+            name: 'list'
+          }
+        | {
+            name: 'grid'
+            previewImageUrl?: (schemaTypeName: string) => string | undefined
+          }
+      >
+    | undefined
 }
 
 declare const internalGroqTypeReferenceTo: unique symbol
@@ -1317,6 +1344,52 @@ declare interface LocalizedValidationMessages {
   [locale: string]: string
 }
 
+/** @public */
+declare type MediaAssetTypes = AssetInstanceDocument_2['_type']
+
+/** @public */
+declare interface MediaLibraryFilter {
+  name: string
+  query: string
+}
+
+/** @public */
+declare interface MediaLibraryOptions {
+  filters?: MediaLibraryFilter[]
+}
+
+/** @public */
+declare interface MediaValidationValue<T extends MediaAssetTypes = MediaAssetTypes> {
+  /**
+   * Media information
+   */
+  media: {
+    /**
+     * The Media Library Asset.
+     */
+    asset: Asset_3 & {
+      currentVersion: Extract<
+        AssetInstanceDocument_2,
+        {
+          _type: T
+        }
+      >
+    }
+  }
+  /**
+   * The field value which the media is used in.
+   */
+  value: unknown
+}
+
+/** @public */
+declare interface MediaValidator<T extends MediaAssetTypes = MediaAssetTypes> {
+  (
+    value: MediaValidationValue<T>,
+    context: ValidationContext,
+  ): CustomValidatorResult | Promise<CustomValidatorResult>
+}
+
 /** @public */
 declare interface MultiFieldSet {
   name: string
@@ -1741,6 +1814,7 @@ declare interface Rule {
       bypassConcurrencyLimit?: boolean
     },
   ): Rule
+  media<T extends MediaAssetTypes = MediaAssetTypes>(fn: MediaValidator<T>): Rule
   min(len: number | string | FieldReference): Rule
   max(len: number | string | FieldReference): Rule
   length(len: number | FieldReference): Rule
@@ -1844,15 +1918,15 @@ declare type RuleSpec =
     }
   | {
       flag: 'min'
-      constraint: number | string
+      constraint: number | string | FieldReference
     }
   | {
       flag: 'max'
-      constraint: number | string
+      constraint: number | string | FieldReference
     }
   | {
       flag: 'length'
-      constraint: number
+      constraint: number | FieldReference
     }
   | {
       flag: 'valid'
@@ -1860,15 +1934,15 @@ declare type RuleSpec =
     }
   | {
       flag: 'precision'
-      constraint: number
+      constraint: number | FieldReference
     }
   | {
       flag: 'lessThan'
-      constraint: number
+      constraint: number | FieldReference
     }
   | {
       flag: 'greaterThan'
-      constraint: number
+      constraint: number | FieldReference
     }
   | {
       flag: 'stringCasing'
@@ -1880,6 +1954,10 @@ declare type RuleSpec =
         assetType: 'asset' | 'image' | 'file'
       }
     }
+  | {
+      flag: 'media'
+      constraint: MediaValidator<any>
+    }
   | {
       flag: 'regex'
       constraint: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/media-library-types",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Type definitions for common Sanity Media Library data structures",
   "keywords": [
     "sanity",
@@ -36,10 +36,9 @@
     "lib",
     "src"
   ],
-  "dependencies": {},
   "devDependencies": {
-    "@sanity/types": "^3.90.0",
-    "@sanity/pkg-utils": "^7.2.3",
+    "@sanity/pkg-utils": "^8.1.9",
+    "@sanity/types": "^4.8.1",
     "rimraf": "^5.0.10"
   },
   "scripts": {

package/src/files.ts

@@ -1,4 +1,4 @@
-export type FileStatus = 'pending' | 'uploading' | 'complete' | 'error'
+export type FileStatus = 'pending' | 'uploading' | 'complete' | 'error' | 'alreadyExists'
 
 /**
  * Wrapper object for the file upload with progress and status