@sanity/client - npm Package Compare versions

Comparing version 6.24.2 to 6.24.3

dist/csm.d.ts

@@ -1,20 +0,7 @@
-import {Any} from '@sanity/client'
-import {ClientPerspective} from '@sanity/client'
-import {ContentSourceMap} from '@sanity/client'
-import {ContentSourceMapDocument} from '@sanity/client'
-import {ContentSourceMapDocumentBase} from '@sanity/client'
-import {ContentSourceMapDocuments} from '@sanity/client'
-import {ContentSourceMapDocumentValueSource} from '@sanity/client'
-import {ContentSourceMapLiteralSource} from '@sanity/client'
-import {ContentSourceMapMapping} from '@sanity/client'
-import {ContentSourceMapMappings} from '@sanity/client'
-import {ContentSourceMapPaths} from '@sanity/client'
-import {ContentSourceMapRemoteDocument} from '@sanity/client'
-import {ContentSourceMapSource} from '@sanity/client'
-import {ContentSourceMapUnknownSource} from '@sanity/client'
-import {ContentSourceMapValueMapping} from '@sanity/client'
-import {SanityDocument} from '@sanity/client'
+/**
+ * Used to tag types that is set to `any` as a temporary measure, but should be replaced with proper typings in the future
+ * @internal
+ */
+export declare type Any = any
 
-export {Any}
-
 /**
@@ -48,19 +35,58 @@ * Optimistically applies source documents to a result, using the content source map to trace fields.
 
-export {ClientPerspective}
+/** @public */
+export declare type ClientPerspective =
+  | 'previewDrafts'
+  | 'published'
+  | 'drafts'
+  | 'raw'
+  | ('published' | 'drafts' | ReleaseId)[]
 
-export {ContentSourceMap}
+/** @public */
+export declare interface ContentSourceMap {
+  mappings: ContentSourceMapMappings
+  documents: ContentSourceMapDocuments
+  paths: ContentSourceMapPaths
+}
 
-export {ContentSourceMapDocument}
+/** @public */
+export declare interface ContentSourceMapDocument extends ContentSourceMapDocumentBase {
+  _projectId?: undefined
+  _dataset?: undefined
+}
 
-export {ContentSourceMapDocumentBase}
+/** @public */
+export declare interface ContentSourceMapDocumentBase {
+  _id: string
+  _type: string
+}
 
-export {ContentSourceMapDocuments}
+/** @public */
+export declare type ContentSourceMapDocuments = (
+  | ContentSourceMapDocument
+  | ContentSourceMapRemoteDocument
+)[]
 
-export {ContentSourceMapDocumentValueSource}
+/**
+ * DocumentValueSource is a path to a value within a document
+ * @public
+ */
+export declare interface ContentSourceMapDocumentValueSource {
+  type: 'documentValue'
+  document: number
+  path: number
+}
 
-export {ContentSourceMapLiteralSource}
+/**
+ * When a value is not from a source, its a literal
+ * @public
+ */
+export declare interface ContentSourceMapLiteralSource {
+  type: 'literal'
+}
 
-export {ContentSourceMapMapping}
+/** @public */
+export declare type ContentSourceMapMapping = ContentSourceMapValueMapping
 
-export {ContentSourceMapMappings}
+/** @public */
+export declare type ContentSourceMapMappings = Record<string, ContentSourceMapMapping>
 
@@ -86,11 +112,34 @@ /** @alpha */
 
-export {ContentSourceMapPaths}
+/** @public */
+export declare type ContentSourceMapPaths = string[]
 
-export {ContentSourceMapRemoteDocument}
+/** @public */
+export declare interface ContentSourceMapRemoteDocument extends ContentSourceMapDocumentBase {
+  _projectId: string
+  _dataset: string
+}
 
-export {ContentSourceMapSource}
+/** @public */
+export declare type ContentSourceMapSource =
+  | ContentSourceMapDocumentValueSource
+  | ContentSourceMapLiteralSource
+  | ContentSourceMapUnknownSource
 
-export {ContentSourceMapUnknownSource}
+/**
+ * When a field source is unknown
+ * @public
+ */
+export declare interface ContentSourceMapUnknownSource {
+  type: 'unknown'
+}
 
-export {ContentSourceMapValueMapping}
+/**
+ * ValueMapping is a mapping when for value that is from a single source value
+ * It may refer to a field within a document or a literal value
+ * @public
+ */
+export declare interface ContentSourceMapValueMapping {
+  type: 'value'
+  source: ContentSourceMapSource
+}
 
@@ -174,2 +223,5 @@ /** @internal */
 
+/** @public */
+declare type ReleaseId = `r${string}`
+
 /**
@@ -225,3 +277,16 @@ * @internal
 
-export {SanityDocument}
+/** @internal */
+export declare type SanityDocument<T extends Record<string, Any> = Record<string, Any>> = {
+  [P in keyof T]: T[P]
+} & {
+  _id: string
+  _rev: string
+  _type: string
+  _createdAt: string
+  _updatedAt: string
+  /**
+   * Present when `perspective` is set to `previewDrafts`
+   */
+  _originalId?: string
+}
 
@@ -228,0 +293,0 @@ /** @alpha */

package.json

 {
   "name": "@sanity/client",
-  "version": "6.24.2",
+  "version": "6.24.3",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
@@ -131,3 +131,3 @@ "keywords": [
     "@sanity/client-latest": "npm:@sanity/client@latest",
-    "@sanity/pkg-utils": "^6.13.2",
+    "@sanity/pkg-utils": "^6.13.3",
     "@types/json-diff": "^1.0.3",
@@ -156,3 +156,3 @@ "@types/node": "^22.9.0",
     "terser": "^5.37.0",
-    "typescript": "5.7.2",
+    "typescript": "5.7.3",
     "vitest": "2.1.8",
@@ -159,0 +159,0 @@ "vitest-github-actions-reporter": "0.11.1"

No alert changes

Improved metrics

Total package byte prevSize

2630377

increased by18.75%

Lines of code

31417

increased by24.55%

No dependency changes