@sanity/types 6.13.1 → 6.13.2-next.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.d.ts +60 -60
- package/package.json +4 -4
package/lib/index.d.ts
CHANGED
|
@@ -1914,7 +1914,7 @@ type MaybeWidenInitialValue<TSchemaDefinition> = 'initialValue' extends keyof TS
|
|
|
1914
1914
|
*
|
|
1915
1915
|
* @beta
|
|
1916
1916
|
*/
|
|
1917
|
-
declare function defineType<const TType extends IntrinsicTypeName | AutocompleteString, const TName extends string, TSelect extends Record<string, string> | undefined, TPrepareValue extends Record<keyof TSelect, any> | undefined, TAlias extends IntrinsicTypeName | undefined = undefined, TStrict extends StrictDefinition = undefined, const TSchemaDefinition extends DefineTypeDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>> = DefineTypeDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>>>(schemaDefinition: DefineTypeDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>> & InferSchemaDefinition<TSchemaDefinition>, defineOptions?: DefineSchemaOptions<TStrict, TAlias>): TSchemaDefinition;
|
|
1917
|
+
export declare function defineType<const TType extends IntrinsicTypeName | AutocompleteString, const TName extends string, TSelect extends Record<string, string> | undefined, TPrepareValue extends Record<keyof TSelect, any> | undefined, TAlias extends IntrinsicTypeName | undefined = undefined, TStrict extends StrictDefinition = undefined, const TSchemaDefinition extends DefineTypeDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>> = DefineTypeDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>>>(schemaDefinition: DefineTypeDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>> & InferSchemaDefinition<TSchemaDefinition>, defineOptions?: DefineSchemaOptions<TStrict, TAlias>): TSchemaDefinition;
|
|
1918
1918
|
/**
|
|
1919
1919
|
* Define a field within a document, object, image or file definition `fields` array.
|
|
1920
1920
|
*
|
|
@@ -1935,7 +1935,7 @@ declare function defineType<const TType extends IntrinsicTypeName | Autocomplete
|
|
|
1935
1935
|
*
|
|
1936
1936
|
* @beta
|
|
1937
1937
|
*/
|
|
1938
|
-
declare function defineField<const TType extends IntrinsicTypeName | AutocompleteString, const TName extends string, TSelect extends Record<string, string> | undefined, TPrepareValue extends Record<keyof TSelect, any> | undefined, TAlias extends IntrinsicTypeName | undefined = undefined, TStrict extends StrictDefinition = undefined, const TSchemaDefinition extends DefineFieldDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>> = DefineFieldDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>>>(schemaField: DefineFieldDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>> & InferSchemaDefinition<TSchemaDefinition>, defineOptions?: DefineSchemaOptions<TStrict, TAlias>): TSchemaDefinition & MaybeWidenValidation<TSchemaDefinition> & MaybeWidenInitialValue<TSchemaDefinition>;
|
|
1938
|
+
export declare function defineField<const TType extends IntrinsicTypeName | AutocompleteString, const TName extends string, TSelect extends Record<string, string> | undefined, TPrepareValue extends Record<keyof TSelect, any> | undefined, TAlias extends IntrinsicTypeName | undefined = undefined, TStrict extends StrictDefinition = undefined, const TSchemaDefinition extends DefineFieldDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>> = DefineFieldDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>>>(schemaField: DefineFieldDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>> & InferSchemaDefinition<TSchemaDefinition>, defineOptions?: DefineSchemaOptions<TStrict, TAlias>): TSchemaDefinition & MaybeWidenValidation<TSchemaDefinition> & MaybeWidenInitialValue<TSchemaDefinition>;
|
|
1939
1939
|
/**
|
|
1940
1940
|
* Define an array item member type within an array definition `of`-array.
|
|
1941
1941
|
*
|
|
@@ -1956,7 +1956,7 @@ declare function defineField<const TType extends IntrinsicTypeName | Autocomplet
|
|
|
1956
1956
|
*
|
|
1957
1957
|
* @beta
|
|
1958
1958
|
*/
|
|
1959
|
-
declare function defineArrayMember<const TType extends IntrinsicTypeName | AutocompleteString, const TName extends string, TSelect extends Record<string, string> | undefined, TPrepareValue extends Record<keyof TSelect, any> | undefined, TAlias extends IntrinsicTypeName | undefined = undefined, TStrict extends StrictDefinition = undefined, const TSchemaDefinition extends DefineArrayMemberDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>> = DefineArrayMemberDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>>>(arrayOfSchema: DefineArrayMemberDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>> & InferSchemaDefinition<TSchemaDefinition>, defineOptions?: DefineSchemaOptions<TStrict, TAlias>): TSchemaDefinition & MaybeWidenValidation<TSchemaDefinition> & MaybeWidenInitialValue<TSchemaDefinition>;
|
|
1959
|
+
export declare function defineArrayMember<const TType extends IntrinsicTypeName | AutocompleteString, const TName extends string, TSelect extends Record<string, string> | undefined, TPrepareValue extends Record<keyof TSelect, any> | undefined, TAlias extends IntrinsicTypeName | undefined = undefined, TStrict extends StrictDefinition = undefined, const TSchemaDefinition extends DefineArrayMemberDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>> = DefineArrayMemberDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>>>(arrayOfSchema: DefineArrayMemberDefinition<TType, TName, TSelect, TPrepareValue, NoInfer<TAlias>, NoInfer<TStrict>> & InferSchemaDefinition<TSchemaDefinition>, defineOptions?: DefineSchemaOptions<TStrict, TAlias>): TSchemaDefinition & MaybeWidenValidation<TSchemaDefinition> & MaybeWidenInitialValue<TSchemaDefinition>;
|
|
1960
1960
|
/**
|
|
1961
1961
|
* `typed` can be used to ensure that an object conforms to an exact interface.
|
|
1962
1962
|
*
|
|
@@ -1982,7 +1982,7 @@ declare function defineArrayMember<const TType extends IntrinsicTypeName | Autoc
|
|
|
1982
1982
|
*
|
|
1983
1983
|
* @internal
|
|
1984
1984
|
*/
|
|
1985
|
-
declare function typed<T>(input: T): T;
|
|
1985
|
+
export declare function typed<T>(input: T): T;
|
|
1986
1986
|
/**
|
|
1987
1987
|
* Enhances VSCode autocomplete by using a distinct type for strings.
|
|
1988
1988
|
*
|
|
@@ -2525,7 +2525,7 @@ interface SearchConfiguration {
|
|
|
2525
2525
|
/**
|
|
2526
2526
|
* @public
|
|
2527
2527
|
*/
|
|
2528
|
-
declare const searchStrategies: readonly ['groq2024', 'groqLegacy'];
|
|
2528
|
+
export declare const searchStrategies: readonly ['groq2024', 'groqLegacy'];
|
|
2529
2529
|
/**
|
|
2530
2530
|
* @public
|
|
2531
2531
|
*/
|
|
@@ -2943,7 +2943,7 @@ type AssetSourceUploadEvent = AssetSourceUploadEventProgress | AssetSourceUpload
|
|
|
2943
2943
|
/** @beta */
|
|
2944
2944
|
type AssetSourceUploadSubscriber = (event: AssetSourceUploadEvent) => void;
|
|
2945
2945
|
/** @public */
|
|
2946
|
-
declare function isImage(value: unknown): value is Image;
|
|
2946
|
+
export declare function isImage(value: unknown): value is Image;
|
|
2947
2947
|
/** @beta */
|
|
2948
2948
|
interface CrossDatasetReferenceValue {
|
|
2949
2949
|
_type: string;
|
|
@@ -2991,13 +2991,13 @@ interface CrossDatasetReferenceSchemaType extends Omit<ObjectSchemaType, 'option
|
|
|
2991
2991
|
options?: ReferenceFilterOptions;
|
|
2992
2992
|
}
|
|
2993
2993
|
/** @beta */
|
|
2994
|
-
declare function isCrossDatasetReference(reference: unknown): reference is CrossDatasetReferenceValue;
|
|
2994
|
+
export declare function isCrossDatasetReference(reference: unknown): reference is CrossDatasetReferenceValue;
|
|
2995
2995
|
/** @public */
|
|
2996
|
-
declare function isSanityDocument(document: unknown): document is SanityDocument;
|
|
2996
|
+
export declare function isSanityDocument(document: unknown): document is SanityDocument;
|
|
2997
2997
|
/** @public */
|
|
2998
|
-
declare function isTypedObject(obj: unknown): obj is TypedObject;
|
|
2998
|
+
export declare function isTypedObject(obj: unknown): obj is TypedObject;
|
|
2999
2999
|
/** @public */
|
|
3000
|
-
declare function isKeyedObject(obj: unknown): obj is KeyedObject;
|
|
3000
|
+
export declare function isKeyedObject(obj: unknown): obj is KeyedObject;
|
|
3001
3001
|
/** @beta */
|
|
3002
3002
|
interface GlobalDocumentReferenceValue {
|
|
3003
3003
|
_type: string;
|
|
@@ -3049,7 +3049,7 @@ interface GlobalDocumentReferenceSchemaType extends Omit<ObjectSchemaType, 'opti
|
|
|
3049
3049
|
options?: ReferenceFilterOptions;
|
|
3050
3050
|
}
|
|
3051
3051
|
/** @beta */
|
|
3052
|
-
declare function isGlobalDocumentReference(reference: unknown): reference is GlobalDocumentReferenceValue;
|
|
3052
|
+
export declare function isGlobalDocumentReference(reference: unknown): reference is GlobalDocumentReferenceValue;
|
|
3053
3053
|
/**
|
|
3054
3054
|
* NOTE: These are query parameters, so they will eventually be encoded as strings.
|
|
3055
3055
|
* However, since most/all query parameter encoders will accept numbers and encode
|
|
@@ -3099,15 +3099,15 @@ type ImageUrlAutoMode = 'format';
|
|
|
3099
3099
|
/** @internal */
|
|
3100
3100
|
type ImageUrlOrientation = '0' | '90' | '180' | '270';
|
|
3101
3101
|
/** @internal */
|
|
3102
|
-
declare function isValidationErrorMarker(marker: ValidationMarker): marker is ValidationMarker & {
|
|
3102
|
+
export declare function isValidationErrorMarker(marker: ValidationMarker): marker is ValidationMarker & {
|
|
3103
3103
|
level: 'error';
|
|
3104
3104
|
};
|
|
3105
3105
|
/** @internal */
|
|
3106
|
-
declare function isValidationWarningMarker(marker: ValidationMarker): marker is ValidationMarker & {
|
|
3106
|
+
export declare function isValidationWarningMarker(marker: ValidationMarker): marker is ValidationMarker & {
|
|
3107
3107
|
level: 'warning';
|
|
3108
3108
|
};
|
|
3109
3109
|
/** @internal */
|
|
3110
|
-
declare function isValidationInfoMarker(marker: ValidationMarker): marker is ValidationMarker & {
|
|
3110
|
+
export declare function isValidationInfoMarker(marker: ValidationMarker): marker is ValidationMarker & {
|
|
3111
3111
|
level: 'info';
|
|
3112
3112
|
};
|
|
3113
3113
|
/**
|
|
@@ -3124,7 +3124,7 @@ type MediaLibraryAssetAspectDefinition = MediaLibraryAssetAspectSupportedFieldDe
|
|
|
3124
3124
|
/**
|
|
3125
3125
|
* @public
|
|
3126
3126
|
*/
|
|
3127
|
-
declare const MEDIA_LIBRARY_ASSET_ASPECT_TYPE_NAME = "sanity.asset.aspect";
|
|
3127
|
+
export declare const MEDIA_LIBRARY_ASSET_ASPECT_TYPE_NAME = "sanity.asset.aspect";
|
|
3128
3128
|
/**
|
|
3129
3129
|
* @public
|
|
3130
3130
|
*/
|
|
@@ -3160,7 +3160,7 @@ interface MediaLibraryAssetAspectDocument extends SanityDocumentLike {
|
|
|
3160
3160
|
*
|
|
3161
3161
|
* @internal
|
|
3162
3162
|
*/
|
|
3163
|
-
declare function isAssetAspect(maybeAssetAspect: unknown): maybeAssetAspect is MediaLibraryAssetAspectDocument;
|
|
3163
|
+
export declare function isAssetAspect(maybeAssetAspect: unknown): maybeAssetAspect is MediaLibraryAssetAspectDocument;
|
|
3164
3164
|
/**
|
|
3165
3165
|
* Define a Media Library asset aspect.
|
|
3166
3166
|
*
|
|
@@ -3169,7 +3169,7 @@ declare function isAssetAspect(maybeAssetAspect: unknown): maybeAssetAspect is M
|
|
|
3169
3169
|
* @public
|
|
3170
3170
|
* @beta
|
|
3171
3171
|
*/
|
|
3172
|
-
declare function defineAssetAspect(definition: MediaLibraryAssetAspectDefinition): MediaLibraryAssetAspectDocument;
|
|
3172
|
+
export declare function defineAssetAspect(definition: MediaLibraryAssetAspectDefinition): MediaLibraryAssetAspectDocument;
|
|
3173
3173
|
/** @internal */
|
|
3174
3174
|
type InsertPatch = {
|
|
3175
3175
|
before: string;
|
|
@@ -3380,15 +3380,15 @@ interface MendozaEffectPair {
|
|
|
3380
3380
|
revert: MendozaPatch;
|
|
3381
3381
|
}
|
|
3382
3382
|
/** @internal */
|
|
3383
|
-
declare function isCreateMutation(mutation: Mutation | TransactionLogMutation): mutation is CreateMutation;
|
|
3383
|
+
export declare function isCreateMutation(mutation: Mutation | TransactionLogMutation): mutation is CreateMutation;
|
|
3384
3384
|
/** @internal */
|
|
3385
|
-
declare function isCreateIfNotExistsMutation(mutation: Mutation | TransactionLogMutation): mutation is CreateIfNotExistsMutation;
|
|
3385
|
+
export declare function isCreateIfNotExistsMutation(mutation: Mutation | TransactionLogMutation): mutation is CreateIfNotExistsMutation;
|
|
3386
3386
|
/** @internal */
|
|
3387
|
-
declare function isCreateOrReplaceMutation(mutation: Mutation | TransactionLogMutation): mutation is CreateOrReplaceMutation;
|
|
3387
|
+
export declare function isCreateOrReplaceMutation(mutation: Mutation | TransactionLogMutation): mutation is CreateOrReplaceMutation;
|
|
3388
3388
|
/** @internal */
|
|
3389
|
-
declare function isDeleteMutation(mutation: Mutation | TransactionLogMutation): mutation is DeleteMutation;
|
|
3389
|
+
export declare function isDeleteMutation(mutation: Mutation | TransactionLogMutation): mutation is DeleteMutation;
|
|
3390
3390
|
/** @internal */
|
|
3391
|
-
declare function isPatchMutation(mutation: Mutation | TransactionLogMutation): mutation is PatchMutation;
|
|
3391
|
+
export declare function isPatchMutation(mutation: Mutation | TransactionLogMutation): mutation is PatchMutation;
|
|
3392
3392
|
/**
|
|
3393
3393
|
* @internal
|
|
3394
3394
|
* Payload that will be passed by the comments backend to our notifications system to display the notification in dashboard.
|
|
@@ -3439,11 +3439,11 @@ interface DashboardNotificationPayload {
|
|
|
3439
3439
|
};
|
|
3440
3440
|
}
|
|
3441
3441
|
/** @internal */
|
|
3442
|
-
declare function isIndexSegment(segment: PathSegment): segment is number;
|
|
3442
|
+
export declare function isIndexSegment(segment: PathSegment): segment is number;
|
|
3443
3443
|
/** @internal */
|
|
3444
|
-
declare function isKeySegment(segment: PathSegment): segment is KeyedSegment;
|
|
3444
|
+
export declare function isKeySegment(segment: PathSegment): segment is KeyedSegment;
|
|
3445
3445
|
/** @internal */
|
|
3446
|
-
declare function isIndexTuple(segment: PathSegment): segment is IndexTuple;
|
|
3446
|
+
export declare function isIndexTuple(segment: PathSegment): segment is IndexTuple;
|
|
3447
3447
|
/**
|
|
3448
3448
|
* Assert that a given object is a portable-text text-block type object
|
|
3449
3449
|
*
|
|
@@ -3453,7 +3453,7 @@ declare function isIndexTuple(segment: PathSegment): segment is IndexTuple;
|
|
|
3453
3453
|
*
|
|
3454
3454
|
* @alpha
|
|
3455
3455
|
*/
|
|
3456
|
-
declare function isPortableTextTextBlock<T = PortableTextSpan | PortableTextObject>(value: unknown): value is PortableTextTextBlock<T>;
|
|
3456
|
+
export declare function isPortableTextTextBlock<T = PortableTextSpan | PortableTextObject>(value: unknown): value is PortableTextTextBlock<T>;
|
|
3457
3457
|
/**
|
|
3458
3458
|
* Assert that a given object is a portable-text span-type object
|
|
3459
3459
|
*
|
|
@@ -3462,7 +3462,7 @@ declare function isPortableTextTextBlock<T = PortableTextSpan | PortableTextObje
|
|
|
3462
3462
|
*
|
|
3463
3463
|
* @alpha
|
|
3464
3464
|
*/
|
|
3465
|
-
declare function isPortableTextSpan(value: unknown): value is PortableTextSpan;
|
|
3465
|
+
export declare function isPortableTextSpan(value: unknown): value is PortableTextSpan;
|
|
3466
3466
|
/**
|
|
3467
3467
|
* Assert that a given object is a portable-text list-text-block-type object
|
|
3468
3468
|
*
|
|
@@ -3473,9 +3473,9 @@ declare function isPortableTextSpan(value: unknown): value is PortableTextSpan;
|
|
|
3473
3473
|
*
|
|
3474
3474
|
* @alpha
|
|
3475
3475
|
*/
|
|
3476
|
-
declare function isPortableTextListBlock<T = PortableTextSpan | PortableTextObject>(value: unknown): value is PortableTextTextBlock<T>;
|
|
3476
|
+
export declare function isPortableTextListBlock<T = PortableTextSpan | PortableTextObject>(value: unknown): value is PortableTextTextBlock<T>;
|
|
3477
3477
|
/** @internal */
|
|
3478
|
-
declare function isReference(reference: unknown): reference is Reference;
|
|
3478
|
+
export declare function isReference(reference: unknown): reference is Reference;
|
|
3479
3479
|
/**
|
|
3480
3480
|
* Returns wether or not the given type is a document type
|
|
3481
3481
|
* (eg that it was defined as `type: 'document'`)
|
|
@@ -3485,57 +3485,57 @@ declare function isReference(reference: unknown): reference is Reference;
|
|
|
3485
3485
|
*
|
|
3486
3486
|
* @public
|
|
3487
3487
|
*/
|
|
3488
|
-
declare function isDocumentSchemaType(type: unknown): type is ObjectSchemaType;
|
|
3488
|
+
export declare function isDocumentSchemaType(type: unknown): type is ObjectSchemaType;
|
|
3489
3489
|
/** @internal */
|
|
3490
|
-
declare function isObjectSchemaType(type: unknown): type is ObjectSchemaType;
|
|
3490
|
+
export declare function isObjectSchemaType(type: unknown): type is ObjectSchemaType;
|
|
3491
3491
|
/** @internal */
|
|
3492
|
-
declare function isArraySchemaType(type: unknown): type is ArraySchemaType;
|
|
3492
|
+
export declare function isArraySchemaType(type: unknown): type is ArraySchemaType;
|
|
3493
3493
|
/** @internal */
|
|
3494
|
-
declare function isArrayOfBlocksSchemaType(type: unknown): type is ArraySchemaType<ObjectSchemaType>;
|
|
3494
|
+
export declare function isArrayOfBlocksSchemaType(type: unknown): type is ArraySchemaType<ObjectSchemaType>;
|
|
3495
3495
|
/** @internal */
|
|
3496
|
-
declare function isArrayOfObjectsSchemaType(type: unknown): type is ArraySchemaType<ObjectSchemaType>;
|
|
3496
|
+
export declare function isArrayOfObjectsSchemaType(type: unknown): type is ArraySchemaType<ObjectSchemaType>;
|
|
3497
3497
|
/** @internal */
|
|
3498
|
-
declare function isArrayOfPrimitivesSchemaType(type: unknown): type is ArraySchemaType;
|
|
3498
|
+
export declare function isArrayOfPrimitivesSchemaType(type: unknown): type is ArraySchemaType;
|
|
3499
3499
|
/** @internal */
|
|
3500
|
-
declare function isArrayOfStringsSchemaType(type: unknown): type is ArraySchemaType<string>;
|
|
3500
|
+
export declare function isArrayOfStringsSchemaType(type: unknown): type is ArraySchemaType<string>;
|
|
3501
3501
|
/** @internal */
|
|
3502
|
-
declare function isBooleanSchemaType(type: unknown): type is BooleanSchemaType;
|
|
3502
|
+
export declare function isBooleanSchemaType(type: unknown): type is BooleanSchemaType;
|
|
3503
3503
|
/** @internal */
|
|
3504
|
-
declare function isStringSchemaType(type: unknown): type is StringSchemaType;
|
|
3504
|
+
export declare function isStringSchemaType(type: unknown): type is StringSchemaType;
|
|
3505
3505
|
/** @internal */
|
|
3506
|
-
declare function isDateTimeSchemaType(type: unknown): type is StringSchemaType;
|
|
3506
|
+
export declare function isDateTimeSchemaType(type: unknown): type is StringSchemaType;
|
|
3507
3507
|
/** @internal */
|
|
3508
|
-
declare function isNumberSchemaType(type: unknown): type is NumberSchemaType;
|
|
3508
|
+
export declare function isNumberSchemaType(type: unknown): type is NumberSchemaType;
|
|
3509
3509
|
/** @internal */
|
|
3510
|
-
declare function isPrimitiveSchemaType(type: unknown): type is BooleanSchemaType | StringSchemaType | NumberSchemaType;
|
|
3510
|
+
export declare function isPrimitiveSchemaType(type: unknown): type is BooleanSchemaType | StringSchemaType | NumberSchemaType;
|
|
3511
3511
|
/** @internal */
|
|
3512
|
-
declare function isReferenceSchemaType(type: unknown): type is ReferenceSchemaType;
|
|
3512
|
+
export declare function isReferenceSchemaType(type: unknown): type is ReferenceSchemaType;
|
|
3513
3513
|
/** @internal */
|
|
3514
|
-
declare function isImageSchemaType(type: unknown): type is ImageSchemaType;
|
|
3514
|
+
export declare function isImageSchemaType(type: unknown): type is ImageSchemaType;
|
|
3515
3515
|
/** @internal */
|
|
3516
|
-
declare function isFileSchemaType(type: unknown): type is FileSchemaType;
|
|
3516
|
+
export declare function isFileSchemaType(type: unknown): type is FileSchemaType;
|
|
3517
3517
|
/** @internal */
|
|
3518
|
-
declare function isDeprecatedSchemaType<TSchemaType extends BaseSchemaType>(type: TSchemaType): type is DeprecatedSchemaType<TSchemaType>;
|
|
3518
|
+
export declare function isDeprecatedSchemaType<TSchemaType extends BaseSchemaType>(type: TSchemaType): type is DeprecatedSchemaType<TSchemaType>;
|
|
3519
3519
|
/** @internal */
|
|
3520
|
-
declare function isDeprecationConfiguration(type: unknown): type is DeprecationConfiguration;
|
|
3520
|
+
export declare function isDeprecationConfiguration(type: unknown): type is DeprecationConfiguration;
|
|
3521
3521
|
/** @internal */
|
|
3522
|
-
declare function isCrossDatasetReferenceSchemaType(type: unknown): type is CrossDatasetReferenceSchemaType;
|
|
3522
|
+
export declare function isCrossDatasetReferenceSchemaType(type: unknown): type is CrossDatasetReferenceSchemaType;
|
|
3523
3523
|
/** @internal */
|
|
3524
|
-
declare function isTitledListValue(item: unknown): item is TitledListValue;
|
|
3524
|
+
export declare function isTitledListValue(item: unknown): item is TitledListValue;
|
|
3525
3525
|
/** @internal */
|
|
3526
|
-
declare function isSpanSchemaType(type: unknown): type is SpanSchemaType;
|
|
3526
|
+
export declare function isSpanSchemaType(type: unknown): type is SpanSchemaType;
|
|
3527
3527
|
/** @internal */
|
|
3528
|
-
declare function isBlockSchemaType(type: unknown): type is BlockSchemaType;
|
|
3528
|
+
export declare function isBlockSchemaType(type: unknown): type is BlockSchemaType;
|
|
3529
3529
|
/** @internal */
|
|
3530
|
-
declare function isBlockStyleObjectField(field: unknown): field is BlockStyleObjectField;
|
|
3530
|
+
export declare function isBlockStyleObjectField(field: unknown): field is BlockStyleObjectField;
|
|
3531
3531
|
/** @internal */
|
|
3532
|
-
declare function isBlockListObjectField(field: unknown): field is BlockListObjectField;
|
|
3532
|
+
export declare function isBlockListObjectField(field: unknown): field is BlockListObjectField;
|
|
3533
3533
|
/** @internal */
|
|
3534
|
-
declare function isBlockChildrenObjectField(field: unknown): field is BlockChildrenObjectField;
|
|
3534
|
+
export declare function isBlockChildrenObjectField(field: unknown): field is BlockChildrenObjectField;
|
|
3535
3535
|
/**
|
|
3536
3536
|
* @internal
|
|
3537
3537
|
*/
|
|
3538
|
-
declare function isSearchStrategy(maybeSearchStrategy: unknown): maybeSearchStrategy is SearchStrategy;
|
|
3538
|
+
export declare function isSearchStrategy(maybeSearchStrategy: unknown): maybeSearchStrategy is SearchStrategy;
|
|
3539
3539
|
/**
|
|
3540
3540
|
* Checks whether the given `thing` is a slug, eg an object with a `current` string property.
|
|
3541
3541
|
*
|
|
@@ -3543,9 +3543,9 @@ declare function isSearchStrategy(maybeSearchStrategy: unknown): maybeSearchStra
|
|
|
3543
3543
|
* @returns True if slug, false otherwise
|
|
3544
3544
|
* @public
|
|
3545
3545
|
*/
|
|
3546
|
-
declare function isSlug(thing: unknown): thing is Slug;
|
|
3546
|
+
export declare function isSlug(thing: unknown): thing is Slug;
|
|
3547
3547
|
/** @internal */
|
|
3548
|
-
declare function isCreateSquashedMutation(mutation: Mutation | TransactionLogMutation): mutation is CreateSquashedMutation;
|
|
3548
|
+
export declare function isCreateSquashedMutation(mutation: Mutation | TransactionLogMutation): mutation is CreateSquashedMutation;
|
|
3549
3549
|
/** @internal */
|
|
3550
3550
|
interface UploadState {
|
|
3551
3551
|
progress: number;
|
|
@@ -3562,16 +3562,16 @@ interface UploadState {
|
|
|
3562
3562
|
previewImage?: string;
|
|
3563
3563
|
}
|
|
3564
3564
|
/** @internal */
|
|
3565
|
-
declare function isValidationError(node: FormNodeValidation): node is FormNodeValidation & {
|
|
3565
|
+
export declare function isValidationError(node: FormNodeValidation): node is FormNodeValidation & {
|
|
3566
3566
|
level: 'error';
|
|
3567
3567
|
};
|
|
3568
3568
|
/** @internal */
|
|
3569
|
-
declare function isValidationWarning(node: FormNodeValidation): node is FormNodeValidation & {
|
|
3569
|
+
export declare function isValidationWarning(node: FormNodeValidation): node is FormNodeValidation & {
|
|
3570
3570
|
level: 'warning';
|
|
3571
3571
|
};
|
|
3572
3572
|
/** @internal */
|
|
3573
|
-
declare function isValidationInfo(node: FormNodeValidation): node is FormNodeValidation & {
|
|
3573
|
+
export declare function isValidationInfo(node: FormNodeValidation): node is FormNodeValidation & {
|
|
3574
3574
|
level: 'info';
|
|
3575
3575
|
};
|
|
3576
|
-
export {
|
|
3576
|
+
export type { ArrayActionName, ArrayDefinition, ArrayOfEntry, ArrayOfType, ArrayOptions, ArrayRule, ArraySchemaType, ArraySchemaTypeOf, Asset, AssetFromSource, AssetMetadataType, AssetSchemaTypeOptions, AssetSource, AssetSourceComponentAction, AssetSourceComponentProps, AssetSourceOpenInSourceResult, AssetSourceSpec, AssetSourceUploadEvent, AssetSourceUploadEventAbort, AssetSourceUploadEventAllComplete, AssetSourceUploadEventError, AssetSourceUploadEventProgress, AssetSourceUploadEventStatus, AssetSourceUploadFile, AssetSourceUploadSubscriber, AssetSourceUploader, AssetSourceUploaderClass, AutocompleteString, BaseSchemaDefinition, BaseSchemaType, BaseSchemaTypeOptions, BlockAnnotationDefinition, BlockChildrenObjectField, BlockDecoratorDefinition, BlockDefinition, BlockListDefinition, BlockListObjectField, BlockMarksDefinition, BlockOptions, BlockRule, BlockSchemaType, BlockStyleDefinition, BlockStyleObjectField, BooleanDefinition, BooleanOptions, BooleanRule, BooleanSchemaType, CanvasAppOptions, CanvasNotificationPayload, CollapseOptions, ConditionalIndexAccess, ConditionalProperty, ConditionalPropertyCallback, ConditionalPropertyCallbackContext, CreateIfNotExistsMutation, CreateMutation, CreateOrReplaceMutation, CreateSquashedMutation, CrossDatasetReferenceDefinition, CrossDatasetReferenceFilterResolver, CrossDatasetReferenceFilterSearchOptions, CrossDatasetReferenceSchemaType, CrossDatasetReferenceValue, CrossDatasetType, CurrentUser, CurrentUserAttribute, CustomValidator, CustomValidatorResult, DashboardNotificationPayload, DateDefinition, DateOptions, DateRule, DatetimeDefinition, DatetimeOptions, DatetimeRule, DefineArrayMemberBase, DefineSchemaBase, DefineSchemaOptions, DefineSchemaType, DeleteMutation, DeprecatedProperty, DeprecatedSchemaType, DeprecationConfiguration, DocumentDefinition, DocumentOptions, DocumentRule, DocumentSystem, DocumentSystemRef, EmailDefinition, EmailOptions, EmailRule, EmptyProps, EnumListProps, FieldDefinition, FieldDefinitionBase, FieldGroup, FieldGroupDefinition, FieldReference, FieldRules, Fieldset, FieldsetDefinition, File, FileAsset, FileDefinition, FileOptions, FileRule, FileSchemaType, FileValue, FormNodeValidation, GeopointDefinition, GeopointOptions, GeopointRule, GeopointValue, GlobalDocumentReferenceDefinition, GlobalDocumentReferenceFilterResolver, GlobalDocumentReferenceFilterSearchOptions, GlobalDocumentReferenceSchemaType, GlobalDocumentReferenceType, GlobalDocumentReferenceValue, HotspotOptions, HotspotPreview, I18nTextRecord, I18nTitledListValue, Image, ImageAsset, ImageCrop, ImageDefinition, ImageDimensions, ImageHotspot, ImageMetadata, ImageMetadataType, ImageOptions, ImagePalette, ImageRule, ImageSchemaType, ImageSwatch, ImageUrlAutoMode, ImageUrlCropMode, ImageUrlFitMode, ImageUrlFormat, ImageUrlOrientation, ImageUrlParams, ImageValue, IndexTuple, InitialValueProperty, InitialValueResolver, InitialValueResolverContext, InlineFieldDefinition, InsertMenuOptions, InsertPatch, IntrinsicArrayOfBase, IntrinsicArrayOfDefinition, IntrinsicBase, IntrinsicDefinitions, IntrinsicTypeName, KeyedObject, KeyedSegment, LocalizedValidationMessages, MaybeAllowUnknownProps, MaybePreview, MediaAssetTypes, MediaLibraryAssetAspectDefinition, MediaLibraryAssetAspectDocument, MediaLibraryAssetAspectSupportedFieldDefinitions, MediaLibraryAssetAspectTypeName, MediaLibraryAssetType, MediaLibraryFilter, MediaLibraryOptions, MediaValidationValue, MediaValidator, MendozaEffectPair, MendozaPatch, ModalOptions, MultiFieldSet, MultipleMutationResult, Mutation, MutationOperationName, MutationSelection, NarrowPreview, NumberDefinition, NumberOptions, NumberRule, NumberSchemaType, ObjectDefinition, ObjectField, ObjectFieldType, ObjectOptions, ObjectRule, ObjectSchemaType, ObjectSchemaTypeWithOptions, PatchMutation, PatchMutationOperation, PatchOperations, Path, PathSegment, PortableTextBlock, PortableTextChild, PortableTextListBlock, PortableTextObject, PortableTextSpan, PortableTextTextBlock, PrepareViewOptions, PreviewConfig, PreviewValue, Reference, ReferenceBaseOptions, ReferenceDefinition, ReferenceFilterOptions, ReferenceFilterQueryOptions, ReferenceFilterResolver, ReferenceFilterResolverContext, ReferenceFilterResolverOptions, ReferenceFilterSearchOptions, ReferenceOptions, ReferenceRule, ReferenceSchemaType, ReferenceTo, ReferenceTypeFilter, ReferenceTypeFilterContext, ReferenceTypeOption, ReferenceValue, Role, Rule, RuleBuilder, RuleClass, RuleDef, RuleSpec, RuleSpecConstraint, RuleTypeConstraint, SanityCreateOptions, SanityDocument, SanityDocumentLike, Schema, SchemaType, SchemaTypeDefinition, SchemaValidationError, SchemaValidationProblem, SchemaValidationProblemGroup, SchemaValidationProblemPath, SchemaValidationValue, SchemaValidationWarning, SearchConfiguration, SearchStrategy, SingleFieldSet, SingleMutationResult, Slug, SlugDefinition, SlugIsUniqueValidator, SlugOptions, SlugParent, SlugRule, SlugSchemaType, SlugSourceContext, SlugSourceFn, SlugValidationContext, SlugValue, SlugifierFn, SortOrdering, SortOrderingItem, SpanMarksObjectField, SpanSchemaType, SpanTextObjectField, StrictDefinition, StrictVersionLayeringOptions, StringDefinition, StringOptions, StringRule, StringSchemaType, StudioNotificationPayload, SwatchName, TextDefinition, TextOptions, TextRule, TextSchemaType, TitledListValue, TransactionLogEvent, TransactionLogEventWithEffects, TransactionLogEventWithMutations, TransactionLogMutation, TypeAliasDefinition, TypeReference, TypedObject, UploadState, UriValidationOptions, UrlDefinition, UrlOptions, UrlRule, User, UserAttributeType, UserAttributeValue, ValidationBuilder, ValidationContext, ValidationError, ValidationErrorClass, ValidationErrorOptions, ValidationMarker, Validator, Validators, WeakCrossDatasetReferenceValue, WeakGlobalDocumentReferenceValue, WeakReference, WidenInitialValue, WidenValidation };
|
|
3577
3577
|
//# sourceMappingURL=index.d.ts.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sanity/types",
|
|
3
|
-
"version": "6.13.
|
|
3
|
+
"version": "6.13.2-next.18",
|
|
4
4
|
"description": "Type definitions for common Sanity data structures",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"cms",
|
|
@@ -40,10 +40,10 @@
|
|
|
40
40
|
"@repo/test-config": "6.9.2",
|
|
41
41
|
"@repo/tsconfig": "6.9.2",
|
|
42
42
|
"@repo/tsdown.config": "6.9.2",
|
|
43
|
-
"@types/react": "^19.
|
|
43
|
+
"@types/react": "^19.3.0",
|
|
44
44
|
"@vitejs/plugin-react": "^6.1.1",
|
|
45
|
-
"react": "^19.
|
|
46
|
-
"tsdown": "^0.
|
|
45
|
+
"react": "^19.3.0",
|
|
46
|
+
"tsdown": "^0.23.0",
|
|
47
47
|
"typescript": "^7.0.2",
|
|
48
48
|
"vite": "^8.2.2",
|
|
49
49
|
"vitest": "^4.1.11"
|