@sanity/media-library-types 1.3.0 → 1.5.0

package/lib/index.d.cts

@@ -57,7 +57,7 @@ declare type ArrayOfType<
   TAlias extends IntrinsicTypeName | undefined = undefined,
 > =
   | IntrinsicArrayOfDefinition[TType]
-  | ArrayOfEntry<TypeAliasDefinition<string, TAlias>>;
+  | ArrayOfEntry<TypeAliasDefinition<AutocompleteString, TAlias>>;
 
 /** @public */
 declare interface ArrayOptions<V = unknown>
@@ -67,10 +67,7 @@ declare interface ArrayOptions<V = unknown>
   /** @deprecated This option does not have any effect anymore */
   direction?: "horizontal" | "vertical";
   sortable?: boolean;
-  modal?: {
-    type?: "dialog" | "popover";
-    width?: number | "auto";
-  };
+  modal?: ModalOptions;
   /** @alpha This API may change */
   insertMenu?: InsertMenuOptions;
   /**
@@ -415,6 +412,20 @@ export declare interface AssetVersion<
   instance: AssetInstance;
 }
 
+/**
+ * Enhances VSCode autocomplete by using a distinct type for strings.
+ *
+ * `AllowOtherStrings` is defined as `string & {}`, an intersection that behaves
+ * like `string` but is treated differently by TypeScript's type system for
+ * internal processing. This helps in improving the specificity and relevance of
+ * autocomplete suggestions by potentially prioritizing `IntrinsicTypeName`
+ * over general string inputs, addressing issues where `string` type suggestions
+ * might overshadow more useful specific literals.
+ *
+ * @beta
+ */
+declare type AutocompleteString = string & {};
+
 export declare type BaseDocument = {
   _id: string;
   _type: string;
@@ -575,9 +586,10 @@ declare interface BlockDefinition extends BaseSchemaDefinition {
   lists?: BlockListDefinition[];
   marks?: BlockMarksDefinition;
   of?: ArrayOfType<"object" | "reference">[];
-  initialValue?: InitialValueProperty<any, any[]>;
+  /** Block types do not support initialValue - the runtime schema validation rejects it. */
+  initialValue?: never;
   options?: BlockOptions;
-  validation?: ValidationBuilder<BlockRule, any[]>;
+  validation?: ValidationBuilder<BlockRule, PortableTextBlock>;
 }
 
 /**
@@ -640,7 +652,7 @@ declare interface BlockOptions extends BaseSchemaTypeOptions {
 }
 
 /** @public */
-declare interface BlockRule extends RuleDef<BlockRule, any[]> {}
+declare interface BlockRule extends RuleDef<BlockRule, PortableTextBlock> {}
 
 /**
  * Schema definition for a text block style.
@@ -967,7 +979,10 @@ declare interface EnumListProps<V = unknown> {
 declare type FieldDefinition<
   TType extends IntrinsicTypeName = IntrinsicTypeName,
   TAlias extends IntrinsicTypeName | undefined = undefined,
-> = (InlineFieldDefinition[TType] | TypeAliasDefinition<string, TAlias>) &
+> = (
+  | InlineFieldDefinition[TType]
+  | TypeAliasDefinition<AutocompleteString, TAlias>
+) &
   FieldDefinitionBase;
 
 /** @public */
@@ -1509,6 +1524,13 @@ declare interface MediaValidator<T extends MediaAssetTypes = MediaAssetTypes> {
   ): CustomValidatorResult | Promise<CustomValidatorResult>;
 }
 
+/** @public */
+/** @public */
+declare interface ModalOptions {
+  type?: "dialog" | "popover";
+  width?: 1 | 2 | 3 | 4 | 5 | "auto" | (1 | 2 | 3 | 4 | 5 | "auto")[];
+}
+
 /** @public */
 declare interface MultiFieldSet {
   name: string;
@@ -1590,10 +1612,7 @@ declare interface ObjectOptions extends BaseSchemaTypeOptions {
   collapsible?: boolean;
   collapsed?: boolean;
   columns?: number;
-  modal?: {
-    type?: "dialog" | "popover";
-    width?: number | number[] | "auto";
-  };
+  modal?: ModalOptions;
 }
 
 /** @public */
@@ -1662,6 +1681,13 @@ export declare type PluginPayload = {
   scheme: "light" | "dark";
   selectAssetTypes: PluginSelectAssetType[];
   selectionType: "single" | "multiple";
+  /**
+   * Opaque string the host generates to **partition persisted picker UI state** (e.g. folder path,
+   * search query, filters) in the Media Library iframe. Huey derives `localStorage` key suffixes
+   * from this value; embedders often derive it from project + dataset + workspace (or any stable
+   * context).
+   */
+  pickerPersistenceKey?: string;
 };
 
 export declare type PluginPostMessage =
@@ -1757,6 +1783,37 @@ export declare type PluginPostMessageUploadFilesResponse = {
  */
 export declare type PluginSelectAssetType = "file" | "image" | "video";
 
+/** @public */
+declare type PortableTextBlock = PortableTextTextBlock | PortableTextObject;
+
+/** @public */
+declare interface PortableTextObject {
+  _type: string;
+  _key: string;
+  [other: string]: unknown;
+}
+
+/** @public */
+declare interface PortableTextSpan {
+  _key: string;
+  _type: "span";
+  text: string;
+  marks?: string[];
+}
+
+/** @public */
+declare interface PortableTextTextBlock<
+  TChild = PortableTextSpan | PortableTextObject,
+> {
+  _type: string;
+  _key: string;
+  children: TChild[];
+  markDefs?: PortableTextObject[];
+  listItem?: string;
+  style?: string;
+  level?: number;
+}
+
 /** @public */
 declare interface PrepareViewOptions {
   /** @beta */
@@ -2263,6 +2320,7 @@ declare type SanityAssetCollection = {
       _key: string;
     } & SanityAssetReference
   >;
+  _system?: SanitySystem;
 };
 
 declare type SanityAssetInstanceState = string;
@@ -2635,7 +2693,7 @@ declare type SchemaTypeDefinition<
   TType extends IntrinsicTypeName = IntrinsicTypeName,
 > =
   | IntrinsicDefinitions[IntrinsicTypeName]
-  | TypeAliasDefinition<string, TType>;
+  | TypeAliasDefinition<AutocompleteString, TType>;
 
 /** @public */
 declare interface SchemaValidationError {

package/lib/index.d.ts

@@ -57,7 +57,7 @@ declare type ArrayOfType<
   TAlias extends IntrinsicTypeName | undefined = undefined,
 > =
   | IntrinsicArrayOfDefinition[TType]
-  | ArrayOfEntry<TypeAliasDefinition<string, TAlias>>;
+  | ArrayOfEntry<TypeAliasDefinition<AutocompleteString, TAlias>>;
 
 /** @public */
 declare interface ArrayOptions<V = unknown>
@@ -67,10 +67,7 @@ declare interface ArrayOptions<V = unknown>
   /** @deprecated This option does not have any effect anymore */
   direction?: "horizontal" | "vertical";
   sortable?: boolean;
-  modal?: {
-    type?: "dialog" | "popover";
-    width?: number | "auto";
-  };
+  modal?: ModalOptions;
   /** @alpha This API may change */
   insertMenu?: InsertMenuOptions;
   /**
@@ -415,6 +412,20 @@ export declare interface AssetVersion<
   instance: AssetInstance;
 }
 
+/**
+ * Enhances VSCode autocomplete by using a distinct type for strings.
+ *
+ * `AllowOtherStrings` is defined as `string & {}`, an intersection that behaves
+ * like `string` but is treated differently by TypeScript's type system for
+ * internal processing. This helps in improving the specificity and relevance of
+ * autocomplete suggestions by potentially prioritizing `IntrinsicTypeName`
+ * over general string inputs, addressing issues where `string` type suggestions
+ * might overshadow more useful specific literals.
+ *
+ * @beta
+ */
+declare type AutocompleteString = string & {};
+
 export declare type BaseDocument = {
   _id: string;
   _type: string;
@@ -575,9 +586,10 @@ declare interface BlockDefinition extends BaseSchemaDefinition {
   lists?: BlockListDefinition[];
   marks?: BlockMarksDefinition;
   of?: ArrayOfType<"object" | "reference">[];
-  initialValue?: InitialValueProperty<any, any[]>;
+  /** Block types do not support initialValue - the runtime schema validation rejects it. */
+  initialValue?: never;
   options?: BlockOptions;
-  validation?: ValidationBuilder<BlockRule, any[]>;
+  validation?: ValidationBuilder<BlockRule, PortableTextBlock>;
 }
 
 /**
@@ -640,7 +652,7 @@ declare interface BlockOptions extends BaseSchemaTypeOptions {
 }
 
 /** @public */
-declare interface BlockRule extends RuleDef<BlockRule, any[]> {}
+declare interface BlockRule extends RuleDef<BlockRule, PortableTextBlock> {}
 
 /**
  * Schema definition for a text block style.
@@ -967,7 +979,10 @@ declare interface EnumListProps<V = unknown> {
 declare type FieldDefinition<
   TType extends IntrinsicTypeName = IntrinsicTypeName,
   TAlias extends IntrinsicTypeName | undefined = undefined,
-> = (InlineFieldDefinition[TType] | TypeAliasDefinition<string, TAlias>) &
+> = (
+  | InlineFieldDefinition[TType]
+  | TypeAliasDefinition<AutocompleteString, TAlias>
+) &
   FieldDefinitionBase;
 
 /** @public */
@@ -1509,6 +1524,13 @@ declare interface MediaValidator<T extends MediaAssetTypes = MediaAssetTypes> {
   ): CustomValidatorResult | Promise<CustomValidatorResult>;
 }
 
+/** @public */
+/** @public */
+declare interface ModalOptions {
+  type?: "dialog" | "popover";
+  width?: 1 | 2 | 3 | 4 | 5 | "auto" | (1 | 2 | 3 | 4 | 5 | "auto")[];
+}
+
 /** @public */
 declare interface MultiFieldSet {
   name: string;
@@ -1590,10 +1612,7 @@ declare interface ObjectOptions extends BaseSchemaTypeOptions {
   collapsible?: boolean;
   collapsed?: boolean;
   columns?: number;
-  modal?: {
-    type?: "dialog" | "popover";
-    width?: number | number[] | "auto";
-  };
+  modal?: ModalOptions;
 }
 
 /** @public */
@@ -1662,6 +1681,13 @@ export declare type PluginPayload = {
   scheme: "light" | "dark";
   selectAssetTypes: PluginSelectAssetType[];
   selectionType: "single" | "multiple";
+  /**
+   * Opaque string the host generates to **partition persisted picker UI state** (e.g. folder path,
+   * search query, filters) in the Media Library iframe. Huey derives `localStorage` key suffixes
+   * from this value; embedders often derive it from project + dataset + workspace (or any stable
+   * context).
+   */
+  pickerPersistenceKey?: string;
 };
 
 export declare type PluginPostMessage =
@@ -1757,6 +1783,37 @@ export declare type PluginPostMessageUploadFilesResponse = {
  */
 export declare type PluginSelectAssetType = "file" | "image" | "video";
 
+/** @public */
+declare type PortableTextBlock = PortableTextTextBlock | PortableTextObject;
+
+/** @public */
+declare interface PortableTextObject {
+  _type: string;
+  _key: string;
+  [other: string]: unknown;
+}
+
+/** @public */
+declare interface PortableTextSpan {
+  _key: string;
+  _type: "span";
+  text: string;
+  marks?: string[];
+}
+
+/** @public */
+declare interface PortableTextTextBlock<
+  TChild = PortableTextSpan | PortableTextObject,
+> {
+  _type: string;
+  _key: string;
+  children: TChild[];
+  markDefs?: PortableTextObject[];
+  listItem?: string;
+  style?: string;
+  level?: number;
+}
+
 /** @public */
 declare interface PrepareViewOptions {
   /** @beta */
@@ -2263,6 +2320,7 @@ declare type SanityAssetCollection = {
       _key: string;
     } & SanityAssetReference
   >;
+  _system?: SanitySystem;
 };
 
 declare type SanityAssetInstanceState = string;
@@ -2635,7 +2693,7 @@ declare type SchemaTypeDefinition<
   TType extends IntrinsicTypeName = IntrinsicTypeName,
 > =
   | IntrinsicDefinitions[IntrinsicTypeName]
-  | TypeAliasDefinition<string, TType>;
+  | TypeAliasDefinition<AutocompleteString, TType>;
 
 /** @public */
 declare interface SchemaValidationError {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/media-library-types",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Type definitions for common Sanity Media Library data structures",
   "keywords": [
     "content",
@@ -37,8 +37,8 @@
     "./package.json": "./package.json"
   },
   "devDependencies": {
-    "@sanity/pkg-utils": "10.4.10",
-    "@sanity/types": "5.18.0",
+    "@sanity/pkg-utils": "10.5.6",
+    "@sanity/types": "5.31.1",
     "rimraf": "5.0.10"
   },
   "scripts": {

package/src/plugin.ts

@@ -33,6 +33,13 @@ export type PluginPayload = {
   scheme: 'light' | 'dark'
   selectAssetTypes: PluginSelectAssetType[]
   selectionType: 'single' | 'multiple'
+  /**
+   * Opaque string the host generates to **partition persisted picker UI state** (e.g. folder path,
+   * search query, filters) in the Media Library iframe. Huey derives `localStorage` key suffixes
+   * from this value; embedders often derive it from project + dataset + workspace (or any stable
+   * context).
+   */
+  pickerPersistenceKey?: string
 }
 
 /**

package/src/schema.types.ts

@@ -41,6 +41,7 @@ export type SanitySymlink = {
   parent?: SanityDirectoryReference
   rootDirectory?: SanityDirectoryReference
   target?: SanityAssetReference
+  _system?: SanitySystem
 }
 
 export type SanityTreeReference = {
@@ -65,6 +66,7 @@ export type SanityAssetCollection = {
       _key: string
     } & SanityAssetReference
   >
+  _system?: SanitySystem
 }
 
 export type SanityVideoMetadataRendition = {
@@ -186,6 +188,10 @@ export type SanityImageMetadata = {
   isOpaque: boolean
 }
 
+export type SanityFileMetadata = {
+  _type: 'sanity.fileMetadata'
+}
+
 export type SanityAssetVersionReference = {
   _ref: string
   _type: 'reference'
@@ -389,6 +395,7 @@ export type SanityDirectory = {
   name?: string
   parent?: SanityDirectoryReference | SanityTreeReference
   rootDirectory?: SanityDirectoryReference
+  _system?: SanitySystem
 }
 
 export type SanityTree = {
@@ -398,6 +405,7 @@ export type SanityTree = {
   _updatedAt: string
   _rev: string
   name?: string
+  _system?: SanitySystem
 }
 
 export type AllSanitySchemaTypes =
@@ -418,6 +426,7 @@ export type AllSanitySchemaTypes =
   | SanityImagePalette
   | SanityImageDimensions
   | SanityImageMetadata
+  | SanityFileMetadata
   | SanityAssetVersionReference
   | SanityAsset
   | SanityImageAssetReference