@sanity/media-library-types 1.3.0 → 1.4.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>
@@ -415,6 +415,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;
@@ -967,7 +981,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 */
@@ -1662,6 +1679,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 =
@@ -2635,7 +2659,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>
@@ -415,6 +415,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;
@@ -967,7 +981,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 */
@@ -1662,6 +1679,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 =
@@ -2635,7 +2659,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.4.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.4.15",
+    "@sanity/types": "5.21.0",
     "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

@@ -186,6 +186,10 @@ export type SanityImageMetadata = {
   isOpaque: boolean
 }
 
+export type SanityFileMetadata = {
+  _type: 'sanity.fileMetadata'
+}
+
 export type SanityAssetVersionReference = {
   _ref: string
   _type: 'reference'
@@ -418,6 +422,7 @@ export type AllSanitySchemaTypes =
   | SanityImagePalette
   | SanityImageDimensions
   | SanityImageMetadata
+  | SanityFileMetadata
   | SanityAssetVersionReference
   | SanityAsset
   | SanityImageAssetReference