@sanity/media-library-types 1.2.0 → 1.3.0

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@sanity/media-library-types",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Type definitions for common Sanity Media Library data structures",
   "keywords": [
-    "sanity",
-    "media",
-    "library",
+    "content",
     "headless",
+    "library",
+    "media",
     "realtime",
-    "content",
+    "sanity",
     "types",
     "typescript"
   ],
@@ -18,8 +18,15 @@
   },
   "license": "MIT",
   "author": "Sanity.io <hello@sanity.io>",
-  "sideEffects": false,
+  "files": [
+    "lib",
+    "src"
+  ],
   "type": "module",
+  "sideEffects": false,
+  "main": "./lib/index.cjs",
+  "module": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "exports": {
     ".": {
       "source": "./src/index.ts",
@@ -29,17 +36,10 @@
     },
     "./package.json": "./package.json"
   },
-  "main": "./lib/index.cjs",
-  "module": "./lib/index.js",
-  "types": "./lib/index.d.ts",
-  "files": [
-    "lib",
-    "src"
-  ],
   "devDependencies": {
-    "@sanity/pkg-utils": "^10.2.5",
-    "@sanity/types": "4.20.0",
-    "rimraf": "^5.0.10"
+    "@sanity/pkg-utils": "10.4.10",
+    "@sanity/types": "5.18.0",
+    "rimraf": "5.0.10"
   },
   "scripts": {
     "build": "cp ../../../apps/huey/src/lib/schema.types.ts ./src/ && pkg-utils build --strict --check --clean",

package/src/assets.ts

@@ -25,6 +25,7 @@ export type AssetInstanceDocument = SanityImageAsset | SanityVideoAsset | Sanity
 
 export interface Asset<AssetInstance extends AssetInstanceDocument = AssetInstanceDocument> {
   _id: string
+  _originalId?: string
   _type: SanityAsset['_type']
   title: string
   assetType: AssetInstance['_type']

package/src/schema.types.ts

@@ -1,10 +1,15 @@
-export declare const internalGroqTypeReferenceTo: unique symbol
-
 export type SanitySystem = {
   _type: 'sanity.system'
   createdBy?: string
 }
 
+export type SanityAssetReference = {
+  _ref: string
+  _type: 'reference'
+  _weak?: boolean
+  [internalGroqTypeReferenceTo]?: 'sanity.asset'
+}
+
 export type SanityAssetUploadSession = {
   _id: string
   _type: 'sanity.asset.upload-session'
@@ -12,16 +17,39 @@ export type SanityAssetUploadSession = {
   _updatedAt: string
   _rev: string
   title: string
-  assets?: Array<{
-    _ref: string
-    _type: 'reference'
-    _weak?: boolean
-    _key: string
-    [internalGroqTypeReferenceTo]?: 'sanity.asset'
-  }>
+  assets?: Array<
+    {
+      _key: string
+    } & SanityAssetReference
+  >
   _system?: SanitySystem
 }
 
+export type SanityDirectoryReference = {
+  _ref: string
+  _type: 'reference'
+  _weak?: boolean
+  [internalGroqTypeReferenceTo]?: 'sanity.directory'
+}
+
+export type SanitySymlink = {
+  _id: string
+  _type: 'sanity.symlink'
+  _createdAt: string
+  _updatedAt: string
+  _rev: string
+  parent?: SanityDirectoryReference
+  rootDirectory?: SanityDirectoryReference
+  target?: SanityAssetReference
+}
+
+export type SanityTreeReference = {
+  _ref: string
+  _type: 'reference'
+  _weak?: boolean
+  [internalGroqTypeReferenceTo]?: 'sanity.tree'
+}
+
 export type SanityAssetCollection = {
   _id: string
   _type: 'sanity.asset.collection'
@@ -30,13 +58,13 @@ export type SanityAssetCollection = {
   _rev: string
   title: string
   description?: string
-  assets?: Array<{
-    _ref: string
-    _type: 'reference'
-    _weak?: boolean
-    _key: string
-    [internalGroqTypeReferenceTo]?: 'sanity.asset'
-  }>
+  parent?: SanityDirectoryReference | SanityTreeReference
+  rootDirectory?: SanityDirectoryReference
+  assets?: Array<
+    {
+      _key: string
+    } & SanityAssetReference
+  >
 }
 
 export type SanityVideoMetadataRendition = {
@@ -52,6 +80,13 @@ export type SanityVideoMetadataPlayback = {
   policy: string
 }
 
+export type SanityAssetSubtitleReference = {
+  _ref: string
+  _type: 'reference'
+  _weak?: boolean
+  [internalGroqTypeReferenceTo]?: 'sanity.asset.subtitle'
+}
+
 export type SanityVideoMetadata = {
   _type: 'sanity.videoMetadata'
   aspectRatio?: string
@@ -67,6 +102,11 @@ export type SanityVideoMetadata = {
       _key: string
     } & SanityVideoMetadataRendition
   >
+  subtitles?: Array<
+    {
+      _key: string
+    } & SanityAssetSubtitleReference
+  >
 }
 
 export type SanityImageExifTags = {
@@ -146,6 +186,13 @@ export type SanityImageMetadata = {
   isOpaque: boolean
 }
 
+export type SanityAssetVersionReference = {
+  _ref: string
+  _type: 'reference'
+  _weak?: boolean
+  [internalGroqTypeReferenceTo]?: 'sanity.asset.version'
+}
+
 export type SanityAsset = {
   _id: string
   _type: 'sanity.asset'
@@ -154,12 +201,7 @@ export type SanityAsset = {
   _rev: string
   title?: string
   aspects?: Record<string, unknown>
-  currentVersion: {
-    _ref: string
-    _type: 'reference'
-    _weak?: boolean
-    [internalGroqTypeReferenceTo]?: 'sanity.asset.version'
-  }
+  currentVersion: SanityAssetVersionReference
   versions: Array<
     {
       _key: string
@@ -167,31 +209,37 @@ export type SanityAsset = {
   >
   assetType: 'sanity.imageAsset' | 'sanity.videoAsset' | 'sanity.fileAsset'
   cdnAccessPolicy: 'public' | 'private'
+  parent?: SanityDirectoryReference | SanityTreeReference
+  rootDirectory?: SanityDirectoryReference
   url?: string
+  _system?: SanitySystem
+}
+
+export type SanityImageAssetReference = {
+  _ref: string
+  _type: 'reference'
+  _weak?: boolean
+  [internalGroqTypeReferenceTo]?: 'sanity.imageAsset'
+}
+
+export type SanityFileAssetReference = {
+  _ref: string
+  _type: 'reference'
+  _weak?: boolean
+  [internalGroqTypeReferenceTo]?: 'sanity.fileAsset'
+}
+
+export type SanityVideoAssetReference = {
+  _ref: string
+  _type: 'reference'
+  _weak?: boolean
+  [internalGroqTypeReferenceTo]?: 'sanity.videoAsset'
 }
 
 export type SanityAssetVersion = {
   _type: 'sanity.asset.version'
   title?: string
-  instance:
-    | {
-        _ref: string
-        _type: 'reference'
-        _weak?: boolean
-        [internalGroqTypeReferenceTo]?: 'sanity.imageAsset'
-      }
-    | {
-        _ref: string
-        _type: 'reference'
-        _weak?: boolean
-        [internalGroqTypeReferenceTo]?: 'sanity.fileAsset'
-      }
-    | {
-        _ref: string
-        _type: 'reference'
-        _weak?: boolean
-        [internalGroqTypeReferenceTo]?: 'sanity.videoAsset'
-      }
+  instance: SanityImageAssetReference | SanityFileAssetReference | SanityVideoAssetReference
 }
 
 export type SanityVideoAsset = {
@@ -234,6 +282,8 @@ export type SanityVideoAsset = {
     url?: string
   }
   metadata: SanityVideoMetadata
+  rootDirectory?: SanityDirectoryReference
+  _system?: SanitySystem
 }
 
 export type SanityAssetInstanceState = string
@@ -273,6 +323,8 @@ export type SanityFileAsset = {
   extension?: string
   url: string
   previewUrl?: string
+  rootDirectory?: SanityDirectoryReference
+  _system?: SanitySystem
 }
 
 export type SanityImageAsset = {
@@ -292,6 +344,8 @@ export type SanityImageAsset = {
   extension?: string
   url: string
   metadata: SanityImageMetadata
+  rootDirectory?: SanityDirectoryReference
+  _system?: SanitySystem
 }
 
 export type Geopoint = {
@@ -301,12 +355,62 @@ export type Geopoint = {
   alt?: number
 }
 
+export type SanityAssetSubtitle = {
+  _id: string
+  _type: 'sanity.asset.subtitle'
+  _createdAt: string
+  _updatedAt: string
+  _rev: string
+  languageCode?: string
+  closedCaptions?: boolean
+  status?: string
+  origin?: string
+  source?: {
+    id?: string
+    name?: string
+    url?: string
+  }
+  segments?: Array<{
+    startTime?: number
+    endTime?: number
+    text?: string
+    _key: string
+  }>
+  error?: string
+  rootDirectory?: SanityDirectoryReference
+}
+
+export type SanityDirectory = {
+  _id: string
+  _type: 'sanity.directory'
+  _createdAt: string
+  _updatedAt: string
+  _rev: string
+  name?: string
+  parent?: SanityDirectoryReference | SanityTreeReference
+  rootDirectory?: SanityDirectoryReference
+}
+
+export type SanityTree = {
+  _id: string
+  _type: 'sanity.tree'
+  _createdAt: string
+  _updatedAt: string
+  _rev: string
+  name?: string
+}
+
 export type AllSanitySchemaTypes =
   | SanitySystem
+  | SanityAssetReference
   | SanityAssetUploadSession
+  | SanityDirectoryReference
+  | SanitySymlink
+  | SanityTreeReference
   | SanityAssetCollection
   | SanityVideoMetadataRendition
   | SanityVideoMetadataPlayback
+  | SanityAssetSubtitleReference
   | SanityVideoMetadata
   | SanityImageExifTags
   | SanityImageExifMetadata
@@ -314,10 +418,19 @@ export type AllSanitySchemaTypes =
   | SanityImagePalette
   | SanityImageDimensions
   | SanityImageMetadata
+  | SanityAssetVersionReference
   | SanityAsset
+  | SanityImageAssetReference
+  | SanityFileAssetReference
+  | SanityVideoAssetReference
   | SanityAssetVersion
   | SanityVideoAsset
   | SanityAssetInstanceState
   | SanityFileAsset
   | SanityImageAsset
   | Geopoint
+  | SanityAssetSubtitle
+  | SanityDirectory
+  | SanityTree
+
+export declare const internalGroqTypeReferenceTo: unique symbol