@sanity/media-library-types 0.0.1

package/lib/index.js

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

package/lib/index.js.map

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

package/lib/index.mjs

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

package/lib/index.mjs.map

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

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@sanity/media-library-types",
+  "version": "0.0.1",
+  "description": "Type definitions for common Sanity Media Library data structures",
+  "keywords": [
+    "sanity",
+    "media",
+    "library",
+    "headless",
+    "realtime",
+    "content",
+    "types",
+    "typescript"
+  ],
+  "homepage": "https://www.sanity.io/",
+  "bugs": {
+    "url": "https://github.com/sanity-io/sanity/issues"
+  },
+  "license": "MIT",
+  "author": "Sanity.io <hello@sanity.io>",
+  "sideEffects": false,
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "import": "./lib/index.mjs",
+      "require": "./lib/index.js",
+      "default": "./lib/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./lib/index.js",
+  "module": "./lib/index.mjs",
+  "types": "./lib/index.d.ts",
+  "files": [
+    "lib",
+    "src"
+  ],
+  "dependencies": {},
+  "devDependencies": {
+    "@sanity/types": "^3.90.0",
+    "@sanity/pkg-utils": "^7.2.3",
+    "rimraf": "^5.0.10"
+  },
+  "scripts": {
+    "build": "cp ../../../apps/huey/src/lib/schema.types.ts ./src/ && pkg-utils build --strict --check --clean",
+    "check:types": "tsc --project tsconfig.json",
+    "clean": "rimraf lib",
+    "schema-types": "cp ../../../apps/huey/src/lib/schema.types.ts ./src/",
+    "watch": "pkg-utils watch"
+  }
+}

package/src/assets.ts

@@ -0,0 +1,159 @@
+import { SanityAsset, SanityAssetCollection, SanityAssetVersion, SanityImageMetadata } from "./schema.types"
+import {type FieldDefinition} from '@sanity/types'
+
+export type SanityVideoAsset = {
+  _id: string
+  _type: 'sanity.videoAsset'
+  _createdAt: string
+  _updatedAt: string
+  _rev: string
+  title?: string
+  description?: Array<{
+    children?: Array<{
+      marks?: Array<string>
+      text?: string
+      _type: 'span'
+      _key: string
+    }>
+    style?: 'normal' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'blockquote'
+    listItem?: 'bullet' | 'number'
+    markDefs?: Array<{
+      href?: string
+      _type: 'link'
+      _key: string
+    }>
+    level?: number
+    _type: 'block'
+    _key: string
+  }>
+  state: string
+  sha1hash?: string
+  mimeType?: string
+  originalFilename?: string
+  size?: number
+  uploadId?: string
+  path?: string
+  url?: string
+  extension?: string
+  metadata: SanityVideoMetadata
+}
+
+export type SanityVideoMetadata = {
+  _type: 'sanity.videoMetadata'
+  muxAssetId: string
+  muxPlaybackIds: Array<{
+    _id: string
+    _type: string
+    policy: string
+    _key: string
+  }>
+}
+
+export type SanityFileAsset = {
+  _id: string
+  _type: 'sanity.fileAsset'
+  _createdAt: string
+  _updatedAt: string
+  _rev: string
+  title?: string
+  description?: Array<{
+    children?: Array<{
+      marks?: Array<string>
+      text?: string
+      _type: 'span'
+      _key: string
+    }>
+    style?: 'normal' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'blockquote'
+    listItem?: 'bullet' | 'number'
+    markDefs?: Array<{
+      href?: string
+      _type: 'link'
+      _key: string
+    }>
+    level?: number
+    _type: 'block'
+    _key: string
+  }>
+  state: string
+  sha1hash?: string
+  mimeType?: string
+  originalFilename?: string
+  size?: number
+  uploadId?: string
+  path: string
+  extension?: string
+  url: string
+}
+
+export type SanityImageAsset = {
+  _id: string
+  _type: 'sanity.imageAsset'
+  _createdAt: string
+  _updatedAt: string
+  _rev: string
+  altText?: string
+  state: string
+  sha1hash?: string
+  mimeType?: string
+  originalFilename?: string
+  size?: number
+  uploadId?: string
+  path?: string
+  extension?: string
+  url: string
+  metadata: SanityImageMetadata
+}
+
+export interface AssetVersion<AssetInstance extends AssetInstanceDocument = AssetInstanceDocument> {
+  _key: string
+  _type: SanityAssetVersion['_type']
+  title?: string
+  instance: AssetInstance
+}
+
+export type AssetInstanceDocument = SanityImageAsset | SanityVideoAsset | SanityFileAsset
+
+export interface Asset<AssetInstance extends AssetInstanceDocument = AssetInstanceDocument> {
+  _id: string
+  _type: SanityAsset['_type']
+  title: string
+  assetType: AssetInstance['_type']
+  cdnAccessPolicy: SanityAsset['cdnAccessPolicy']
+  currentVersion: {
+    _ref: string
+  }
+  aspects?: unknown
+  versions: AssetVersion<AssetInstance>[]
+  collections: SanityAssetCollection[]
+  _createdAt: string
+  _updatedAt: string
+  _rev: string
+}
+
+export type BaseDocument = {
+  _id: string
+  _type: string
+  _rev: string
+  _createdAt: string
+  _updatedAt: string
+  [key: string]: any
+}
+
+export interface AssetAspectDocument extends BaseDocument {
+  _type: 'sanity.asset.aspect'
+  /**
+   * The asset type this aspect definition applies to
+   * Undefined means that it applies to all asset types
+   */
+  assetType?: Asset['assetType']
+  definition: FieldDefinition
+}
+
+export interface UploadSession {
+  _id: string
+  _type: 'sanity.asset.upload-session'
+  title: string
+  assets: Asset[]
+  _createdAt: string
+  _updatedAt: string
+}

package/src/files.ts

@@ -0,0 +1,12 @@
+export type FileStatus = 'pending' | 'uploading' | 'complete' | 'error'
+
+/**
+ * Wrapper object for the file upload with progress and status
+ */
+export interface FileUpload {
+  id: string
+  file: File
+  status: FileStatus
+  progress: number
+  error?: Error
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './assets'
+export * from './plugin'
+export * from './files'

package/src/plugin.ts

@@ -0,0 +1,93 @@
+import { Asset } from "./assets"
+import { FileUpload } from "./files"
+
+/**
+ * Message sent from the plugin when files are uploading
+ */
+export type PluginPostMessageUploadFilesProgress = {
+  type: 'uploadProgress'
+  files: FileUpload[]
+}
+
+/**
+ * Message sent from the app that the pending uploads are uploaded
+ */
+export type PluginPostMessageUploadFilesResponse = {
+  type: 'uploadResponse'
+  assets: AssetSelectionItemWithLegacySupport[]
+}
+
+export interface AssetSelectionItem {
+  asset: Asset
+  assetInstanceId?: string | null
+}
+
+/* This is to support the legacy asset selection API in a transition phase */
+interface AssetSelectionItemWithLegacySupport extends AssetSelectionItem {
+  assetId: string
+  assetType: string
+  assetInstanceId: string // Required
+}
+
+export type PluginPostMessageAssetSelection = {
+  type: 'assetSelection'
+  selection: AssetSelectionItemWithLegacySupport[]
+}
+
+/**
+ * Message sent from the plugin that a document has been updated
+ */
+export type PluginPostMessageDocumentUpdate = {
+  type: 'documentUpdate'
+  document: {_id: string; _type: string; _rev: string}
+}
+
+/**
+ * Message sent from the plugin that the user wants to upload files
+ */
+export type PluginPostMessageUploadFilesRequest = {
+  type: 'uploadRequest'
+  files: {id: string; file: File}[]
+}
+
+export type PluginPostMessageAbortUploadRequest = {
+  type: 'abortUploadRequest'
+  files?: {id: string}[]
+}
+
+export type PluginPostMessageTokenRequest = {
+  type: 'tokenRequest'
+}
+
+export type PluginPostMessageTokenResponse = {
+  type: 'tokenResponse'
+  token: string | null
+}
+
+/**
+ * Message sent from a plugin page to notify the host that the page is loaded and ready to be interacted with
+ */
+export type PluginPostMessagePageLoaded = {
+  type: 'pageLoaded'
+  page: string
+}
+
+/**
+ * Message sent from a plugin page that a page is unloaded by the user (for closing the dialog and similar)
+ */
+export type PluginPostMessagePageUnloaded = {
+  type: 'pageUnloaded'
+  page: string
+}
+
+export type PluginPostMessage =
+  | PluginPostMessageAbortUploadRequest
+  | PluginPostMessageAssetSelection
+  | PluginPostMessageDocumentUpdate
+  | PluginPostMessagePageLoaded
+  | PluginPostMessagePageUnloaded
+  | PluginPostMessageTokenRequest
+  | PluginPostMessageTokenResponse
+  | PluginPostMessageUploadFilesProgress
+  | PluginPostMessageUploadFilesRequest
+  | PluginPostMessageUploadFilesResponse

package/src/schema.types.ts

@@ -0,0 +1,295 @@
+export declare const internalGroqTypeReferenceTo: unique symbol
+
+export type SanityAssetUploadSession = {
+  _id: string
+  _type: 'sanity.asset.upload-session'
+  _createdAt: string
+  _updatedAt: string
+  _rev: string
+  title: string
+  assets?: Array<{
+    _ref: string
+    _type: 'reference'
+    _weak?: boolean
+    _key: string
+    [internalGroqTypeReferenceTo]?: 'sanity.asset'
+  }>
+  _system?: SanitySystem
+}
+
+export type SanitySystem = {
+  _type: 'sanity.system'
+  createdBy?: string
+}
+
+export type SanityAssetCollection = {
+  _id: string
+  _type: 'sanity.asset.collection'
+  _createdAt: string
+  _updatedAt: string
+  _rev: string
+  title: string
+  description?: string
+  assets?: Array<{
+    _ref: string
+    _type: 'reference'
+    _weak?: boolean
+    _key: string
+    [internalGroqTypeReferenceTo]?: 'sanity.asset'
+  }>
+}
+
+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 SanityImageExifTags = {
+  _type: 'sanity.imageExifTags'
+  Make?: string
+  Model?: string
+  Orientation?: number
+  XResolution?: number
+  YResolution?: number
+  ResolutionUnit?: number
+  Software?: string
+  ModifyDate?: string
+  ExifOffset?: number
+  GPSInfo?: number
+}
+
+export type SanityImageExifMetadata = {
+  _type: 'sanity.imageExifMetadata'
+  ApertureValue?: number
+  BrightnessValue?: number
+  DateTimeDigitized?: string
+  DateTimeOriginal?: string
+  ExposureBiasValue?: number
+  ExposureMode?: number
+  ExposureProgram?: number
+  ExposureTime?: number
+  FNumber?: number
+  Flash?: number
+  FocalLength?: number
+  FocalLengthIn35mmFormat?: number
+  ISO?: number
+  LensModel?: string
+  WhiteBalance?: number
+  GPSLatitude?: number
+  GPSLongitude?: number
+  GPSAltitude?: number
+  Copyright?: string
+  Artist?: string
+}
+
+export type SanityImageDimensions = {
+  _type: 'sanity.imageDimensions'
+  height: number
+  width: number
+  aspectRatio: number
+}
+
+export type SanityAsset = {
+  _id: string
+  _type: 'sanity.asset'
+  _createdAt: string
+  _updatedAt: string
+  _rev: string
+  title?: string
+  aspects?: unknown
+  currentVersion: {
+    _ref: string
+    _type: 'reference'
+    _weak?: boolean
+    [internalGroqTypeReferenceTo]?: 'sanity.asset.version'
+  }
+  versions: Array<
+    {
+      _key: string
+    } & SanityAssetVersion
+  >
+  assetType: 'sanity.imageAsset' | 'sanity.videoAsset' | 'sanity.fileAsset'
+  cdnAccessPolicy: 'public' | 'private'
+}
+
+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'
+      }
+}
+
+export type SanityVideoAsset = {
+  _id: string
+  _type: 'sanity.videoAsset'
+  _createdAt: string
+  _updatedAt: string
+  _rev: string
+  title?: string
+  description?: Array<{
+    children?: Array<{
+      marks?: Array<string>
+      text?: string
+      _type: 'span'
+      _key: string
+    }>
+    style?: 'normal' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'blockquote'
+    listItem?: 'bullet' | 'number'
+    markDefs?: Array<{
+      href?: string
+      _type: 'link'
+      _key: string
+    }>
+    level?: number
+    _type: 'block'
+    _key: string
+  }>
+  state: string
+  sha1hash?: string
+  mimeType?: string
+  originalFilename?: string
+  size?: number
+  uploadId?: string
+  path?: string
+  url?: string
+  extension?: string
+  metadata: SanityVideoMetadata
+}
+
+export type SanityVideoMetadata = {
+  _type: 'sanity.videoMetadata'
+  muxAssetId: string
+  muxPlaybackIds: Array<{
+    _id: string
+    _type: string
+    policy: string
+    _key: string
+  }>
+}
+
+export type SanityFileAsset = {
+  _id: string
+  _type: 'sanity.fileAsset'
+  _createdAt: string
+  _updatedAt: string
+  _rev: string
+  title?: string
+  description?: Array<{
+    children?: Array<{
+      marks?: Array<string>
+      text?: string
+      _type: 'span'
+      _key: string
+    }>
+    style?: 'normal' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'blockquote'
+    listItem?: 'bullet' | 'number'
+    markDefs?: Array<{
+      href?: string
+      _type: 'link'
+      _key: string
+    }>
+    level?: number
+    _type: 'block'
+    _key: string
+  }>
+  state: string
+  sha1hash?: string
+  mimeType?: string
+  originalFilename?: string
+  size?: number
+  uploadId?: string
+  path: string
+  extension?: string
+  url: string
+}
+
+export type SanityImageAsset = {
+  _id: string
+  _type: 'sanity.imageAsset'
+  _createdAt: string
+  _updatedAt: string
+  _rev: string
+  altText?: string
+  state: string
+  sha1hash?: string
+  mimeType?: string
+  originalFilename?: string
+  size?: number
+  uploadId?: string
+  path?: string
+  extension?: string
+  url: string
+  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
+  lng?: number
+  alt?: number
+}
+
+export type SanityAssetInstanceState = string
+
+export type AllSanitySchemaTypes =
+  | SanityAssetUploadSession
+  | SanitySystem
+  | SanityAssetCollection
+  | SanityImagePaletteSwatch
+  | SanityImagePalette
+  | SanityImageExifTags
+  | SanityImageExifMetadata
+  | SanityImageDimensions
+  | SanityAsset
+  | SanityAssetVersion
+  | SanityVideoAsset
+  | SanityVideoMetadata
+  | SanityFileAsset
+  | SanityImageAsset
+  | SanityImageMetadata
+  | Geopoint
+  | SanityAssetInstanceState