@sanity/media-library-types 1.0.1 → 1.0.2

package/lib/index.d.mts

@@ -117,6 +117,7 @@ export declare interface Asset<
   _createdAt: string
   _updatedAt: string
   _rev: string
+  url?: string
 }
 
 /** @public */
@@ -144,6 +145,7 @@ export declare interface AssetAspectDocument extends BaseDocument {
    */
   assetType?: Asset['assetType']
   definition: FieldDefinition
+  public?: boolean
 }
 
 /** @public */
@@ -2002,6 +2004,7 @@ declare type SanityAsset = {
   >
   assetType: 'sanity.imageAsset' | 'sanity.videoAsset' | 'sanity.fileAsset'
   cdnAccessPolicy: 'public' | 'private'
+  url?: string
 }
 
 declare type SanityAssetCollection = {
@@ -2021,6 +2024,8 @@ declare type SanityAssetCollection = {
   }>
 }
 
+declare type SanityAssetInstanceState = string
+
 declare type SanityAssetVersion = {
   _type: 'sanity.asset.version'
   title?: string
@@ -2095,7 +2100,7 @@ declare type SanityFileAsset = {
     _type: 'block'
     _key: string
   }>
-  state: string
+  state: SanityAssetInstanceState
   sha1hash?: string
   mimeType?: string
   originalFilename?: string
@@ -2113,7 +2118,7 @@ declare type SanityImageAsset = {
   _updatedAt: string
   _rev: string
   altText?: string
-  state: string
+  state: SanityAssetInstanceState
   sha1hash?: string
   mimeType?: string
   originalFilename?: string
@@ -2232,7 +2237,7 @@ export declare type SanityVideoAsset = {
     _type: 'block'
     _key: string
   }>
-  state: string
+  state: SanityAssetInstanceState
   sha1hash?: string
   mimeType?: string
   originalFilename?: string

package/lib/index.d.ts

@@ -117,6 +117,7 @@ export declare interface Asset<
   _createdAt: string
   _updatedAt: string
   _rev: string
+  url?: string
 }
 
 /** @public */
@@ -144,6 +145,7 @@ export declare interface AssetAspectDocument extends BaseDocument {
    */
   assetType?: Asset['assetType']
   definition: FieldDefinition
+  public?: boolean
 }
 
 /** @public */
@@ -2002,6 +2004,7 @@ declare type SanityAsset = {
   >
   assetType: 'sanity.imageAsset' | 'sanity.videoAsset' | 'sanity.fileAsset'
   cdnAccessPolicy: 'public' | 'private'
+  url?: string
 }
 
 declare type SanityAssetCollection = {
@@ -2021,6 +2024,8 @@ declare type SanityAssetCollection = {
   }>
 }
 
+declare type SanityAssetInstanceState = string
+
 declare type SanityAssetVersion = {
   _type: 'sanity.asset.version'
   title?: string
@@ -2095,7 +2100,7 @@ declare type SanityFileAsset = {
     _type: 'block'
     _key: string
   }>
-  state: string
+  state: SanityAssetInstanceState
   sha1hash?: string
   mimeType?: string
   originalFilename?: string
@@ -2113,7 +2118,7 @@ declare type SanityImageAsset = {
   _updatedAt: string
   _rev: string
   altText?: string
-  state: string
+  state: SanityAssetInstanceState
   sha1hash?: string
   mimeType?: string
   originalFilename?: string
@@ -2232,7 +2237,7 @@ export declare type SanityVideoAsset = {
     _type: 'block'
     _key: string
   }>
-  state: string
+  state: SanityAssetInstanceState
   sha1hash?: string
   mimeType?: string
   originalFilename?: string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/media-library-types",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Type definitions for common Sanity Media Library data structures",
   "keywords": [
     "sanity",
@@ -37,8 +37,8 @@
     "src"
   ],
   "devDependencies": {
-    "@sanity/pkg-utils": "^8.1.9",
-    "@sanity/types": "^4.8.1",
+    "@sanity/pkg-utils": "^8.1.29",
+    "@sanity/types": "^4.15.0",
     "rimraf": "^5.0.10"
   },
   "scripts": {

package/src/assets.ts

@@ -34,6 +34,7 @@ export interface Asset<AssetInstance extends AssetInstanceDocument = AssetInstan
   _createdAt: string
   _updatedAt: string
   _rev: string
+  url?: string
 }
 
 export type BaseDocument = {
@@ -53,4 +54,5 @@ export interface AssetAspectDocument extends BaseDocument {
    */
   assetType?: Asset['assetType']
   definition: FieldDefinition
+  public?: boolean
 }

package/src/schema.types.ts

@@ -1,5 +1,10 @@
 export declare const internalGroqTypeReferenceTo: unique symbol
 
+export type SanitySystem = {
+  _type: 'sanity.system'
+  createdBy?: string
+}
+
 export type SanityAssetUploadSession = {
   _id: string
   _type: 'sanity.asset.upload-session'
@@ -17,11 +22,6 @@ export type SanityAssetUploadSession = {
   _system?: SanitySystem
 }
 
-export type SanitySystem = {
-  _type: 'sanity.system'
-  createdBy?: string
-}
-
 export type SanityAssetCollection = {
   _id: string
   _type: 'sanity.asset.collection'
@@ -46,23 +46,16 @@ export type SanityVideoMetadataPlayback = {
   policy: string
 }
 
-export type SanityImagePaletteSwatch = {
-  _type: 'sanity.imagePaletteSwatch'
-  background?: string
-  foreground?: string
-  population?: number
-  title?: string
-}
-
-export type SanityImagePalette = {
-  _type: 'sanity.imagePalette'
-  darkMuted?: SanityImagePaletteSwatch
-  lightVibrant?: SanityImagePaletteSwatch
-  darkVibrant?: SanityImagePaletteSwatch
-  vibrant?: SanityImagePaletteSwatch
-  dominant?: SanityImagePaletteSwatch
-  lightMuted?: SanityImagePaletteSwatch
-  muted?: SanityImagePaletteSwatch
+export type SanityVideoMetadata = {
+  _type: 'sanity.videoMetadata'
+  aspectRatio?: string
+  duration?: number
+  framerate?: number
+  playbacks?: Array<
+    {
+      _key: string
+    } & SanityVideoMetadataPlayback
+  >
 }
 
 export type SanityImageExifTags = {
@@ -103,6 +96,25 @@ export type SanityImageExifMetadata = {
   Artist?: string
 }
 
+export type SanityImagePaletteSwatch = {
+  _type: 'sanity.imagePaletteSwatch'
+  background?: string
+  foreground?: string
+  population?: number
+  title?: string
+}
+
+export type SanityImagePalette = {
+  _type: 'sanity.imagePalette'
+  darkMuted?: SanityImagePaletteSwatch
+  lightVibrant?: SanityImagePaletteSwatch
+  darkVibrant?: SanityImagePaletteSwatch
+  vibrant?: SanityImagePaletteSwatch
+  dominant?: SanityImagePaletteSwatch
+  lightMuted?: SanityImagePaletteSwatch
+  muted?: SanityImagePaletteSwatch
+}
+
 export type SanityImageDimensions = {
   _type: 'sanity.imageDimensions'
   height: number
@@ -110,6 +122,19 @@ export type SanityImageDimensions = {
   aspectRatio: number
 }
 
+export type SanityImageMetadata = {
+  _type: 'sanity.imageMetadata'
+  location?: Geopoint
+  dimensions: SanityImageDimensions
+  exif?: SanityImageExifMetadata
+  image?: SanityImageExifTags
+  palette: SanityImagePalette
+  lqip: string
+  blurHash: string
+  hasAlpha: boolean
+  isOpaque: boolean
+}
+
 export type SanityAsset = {
   _id: string
   _type: 'sanity.asset'
@@ -131,6 +156,7 @@ export type SanityAsset = {
   >
   assetType: 'sanity.imageAsset' | 'sanity.videoAsset' | 'sanity.fileAsset'
   cdnAccessPolicy: 'public' | 'private'
+  url?: string
 }
 
 export type SanityAssetVersion = {
@@ -182,7 +208,7 @@ export type SanityVideoAsset = {
     _type: 'block'
     _key: string
   }>
-  state: string
+  state: SanityAssetInstanceState
   sha1hash?: string
   mimeType?: string
   originalFilename?: string
@@ -199,17 +225,7 @@ export type SanityVideoAsset = {
   metadata: SanityVideoMetadata
 }
 
-export type SanityVideoMetadata = {
-  _type: 'sanity.videoMetadata'
-  aspectRatio?: string
-  duration?: number
-  framerate?: number
-  playbacks?: Array<
-    {
-      _key: string
-    } & SanityVideoMetadataPlayback
-  >
-}
+export type SanityAssetInstanceState = string
 
 export type SanityFileAsset = {
   _id: string
@@ -236,7 +252,7 @@ export type SanityFileAsset = {
     _type: 'block'
     _key: string
   }>
-  state: string
+  state: SanityAssetInstanceState
   sha1hash?: string
   mimeType?: string
   originalFilename?: string
@@ -254,7 +270,7 @@ export type SanityImageAsset = {
   _updatedAt: string
   _rev: string
   altText?: string
-  state: string
+  state: SanityAssetInstanceState
   sha1hash?: string
   mimeType?: string
   originalFilename?: string
@@ -266,19 +282,6 @@ export type SanityImageAsset = {
   metadata: SanityImageMetadata
 }
 
-export type SanityImageMetadata = {
-  _type: 'sanity.imageMetadata'
-  location?: Geopoint
-  dimensions: SanityImageDimensions
-  exif?: SanityImageExifMetadata
-  image?: SanityImageExifTags
-  palette: SanityImagePalette
-  lqip: string
-  blurHash: string
-  hasAlpha: boolean
-  isOpaque: boolean
-}
-
 export type Geopoint = {
   _type: 'geopoint'
   lat?: number
@@ -286,24 +289,22 @@ export type Geopoint = {
   alt?: number
 }
 
-export type SanityAssetInstanceState = string
-
 export type AllSanitySchemaTypes =
-  | SanityAssetUploadSession
   | SanitySystem
+  | SanityAssetUploadSession
   | SanityAssetCollection
   | SanityVideoMetadataPlayback
-  | SanityImagePaletteSwatch
-  | SanityImagePalette
+  | SanityVideoMetadata
   | SanityImageExifTags
   | SanityImageExifMetadata
+  | SanityImagePaletteSwatch
+  | SanityImagePalette
   | SanityImageDimensions
+  | SanityImageMetadata
   | SanityAsset
   | SanityAssetVersion
   | SanityVideoAsset
-  | SanityVideoMetadata
+  | SanityAssetInstanceState
   | SanityFileAsset
   | SanityImageAsset
-  | SanityImageMetadata
   | Geopoint
-  | SanityAssetInstanceState