@sanity/client 7.26.2 → 8.1.0

package/src/csm/applySourceDocuments.ts

@@ -3,12 +3,10 @@ import {parseJsonPath} from './jsonPath'
 import {resolveMapping} from './resolveMapping'
 import * as paths from './studioPath'
 import type {
-  Any,
   ApplySourceDocumentsUpdateFunction,
   ClientPerspective,
   ContentSourceMap,
   ContentSourceMapDocuments,
-  Path,
   SanityDocument,
 } from './types'
 import {walkMap} from './walkMap'
@@ -24,7 +22,9 @@ export function applySourceDocuments<Result = unknown>(
   getCachedDocument: (
     sourceDocument: ContentSourceMapDocuments[number],
   ) =>
-    (Partial<SanityDocument> & Required<Pick<SanityDocument, '_id' | '_type'>>) | null | undefined,
+    | (Partial<SanityDocument> & Required<Pick<SanityDocument, '_id' | '_type'>>)
+    | null
+    | undefined,
   updateFn: ApplySourceDocumentsUpdateFunction,
   perspective: Exclude<ClientPerspective, 'raw'>,
 ): Result {
@@ -53,7 +53,7 @@ export function applySourceDocuments<Result = unknown>(
 
     if (sourceDocument) {
       const parsedPath = parseJsonPath(sourcePath + pathSuffix)
-      const stringifiedPath = paths.toString(parsedPath as Path)
+      const stringifiedPath = paths.toString(parsedPath)
       const cachedDocument = cachedDocuments[mapping.source.document]
 
       if (!cachedDocument) {
@@ -65,7 +65,7 @@ export function applySourceDocuments<Result = unknown>(
         : value
       return value === changedValue
         ? value
-        : updateFn<Result[keyof Result]>(changedValue as Any, {
+        : updateFn<Result[keyof Result]>(changedValue as Result[keyof Result], {
             cachedDocument,
             previousValue: value as Result[keyof Result],
             sourceDocument,

package/src/csm/createEditUrl.ts

@@ -36,7 +36,7 @@ export function createEditUrl(options: CreateEditUrlOptions): `${StudioBaseUrl}$
     ? studioPath.toString(jsonPathToStudioPath(path))
     : path
 
-  // eslint-disable-next-line no-warning-comments
+  // oxlint-disable-next-line no-warning-comments
   // @TODO Using searchParams as a temporary workaround until `@sanity/overlays` can decode state from the path reliably
   const searchParams = new URLSearchParams({
     baseUrl,

package/src/csm/draftUtils.ts

@@ -32,11 +32,24 @@ export function isPublishedId(id: string): id is PublishedId {
   return !isDraftId(id) && !isVersionId(id)
 }
 
+/**
+ * A phantom brand like `DraftId` has no runtime representation, so it can never be produced
+ * by narrowing a string - there's nothing to check. These two functions are the only places
+ * allowed to assert a plain string into a branded id.
+ */
+function asDraftId(value: string): DraftId {
+  return value as DraftId
+}
+
+function asPublishedId(value: string): PublishedId {
+  return value as PublishedId
+}
+
 /** @internal */
 export function getDraftId(id: string): DraftId {
   if (isVersionId(id)) {
     const publishedId = getPublishedId(id)
-    return (DRAFTS_PREFIX + publishedId) as DraftId
+    return asDraftId(DRAFTS_PREFIX + publishedId)
   }
 
   return isDraftId(id) ? id : ((DRAFTS_PREFIX + id) as DraftId)
@@ -60,7 +73,6 @@ export function getVersionId(id: string, version: string): string {
  */
 export function getVersionFromId(id: string): string | undefined {
   if (!isVersionId(id)) return undefined
-  // eslint-disable-next-line unused-imports/no-unused-vars
   const [_versionPrefix, versionId, ..._publishedId] = id.split(PATH_SEPARATOR)
 
   return versionId
@@ -70,12 +82,18 @@ export function getVersionFromId(id: string): string | undefined {
 export function getPublishedId(id: string): PublishedId {
   if (isVersionId(id)) {
     // make sure to only remove the versions prefix and the bundle name
-    return id.split(PATH_SEPARATOR).slice(2).join(PATH_SEPARATOR) as PublishedId as PublishedId
+    return asPublishedId(id.split(PATH_SEPARATOR).slice(2).join(PATH_SEPARATOR))
   }
 
   if (isDraftId(id)) {
-    return id.slice(DRAFTS_PREFIX.length) as PublishedId
+    return asPublishedId(id.slice(DRAFTS_PREFIX.length))
+  }
+
+  if (isPublishedId(id)) {
+    return id
   }
 
-  return id as PublishedId
+  // Unreachable: `isPublishedId` is defined as `!isDraftId(id) && !isVersionId(id)`, both of
+  // which were already checked (and found false) above, so this can never execute.
+  throw new Error(`Unable to resolve a published id from "${id}"`)
 }

package/src/csm/index.ts

@@ -1,5 +1,5 @@
-import * as studioPath from './studioPath'
-export {studioPath}
+/** @alpha */
+export * as studioPath from './studioPath'
 export * from './applySourceDocuments'
 export {createEditUrl} from './createEditUrl'
 export {

package/src/csm/studioPath.ts

@@ -45,6 +45,7 @@ export function isIndexTuple(segment: PathSegment): segment is IndexTuple {
 }
 
 /** @internal */
+// oxlint-disable-next-line typescript/no-unnecessary-type-parameters -- caller-supplied return type; removing it breaks `get<Result>(...)` call sites
 export function get<Result = unknown, Fallback = unknown>(
   obj: unknown,
   path: Path | string,
@@ -55,7 +56,7 @@ export function get<Result = unknown, Fallback = unknown>(
     throw new Error('Path must be an array or a string')
   }
 
-  let acc: unknown | undefined = obj
+  let acc: unknown = obj
   for (let i = 0; i < select.length; i++) {
     const segment = select[i]
     if (isIndexSegment(segment)) {

package/src/csm/types.ts

@@ -33,11 +33,17 @@ export type ContentSourceMapParsedPathKeyedSegment = {_key: string; _index: numb
 
 /** @alpha */
 export type ContentSourceMapParsedPath = (
-  string | number | ContentSourceMapParsedPathKeyedSegment
+  | string
+  | number
+  | ContentSourceMapParsedPathKeyedSegment
 )[]
 
 /** @alpha */
-export type StudioBaseUrl = `/${string}` | `${string}.sanity.studio` | `https://${string}` | string
+export type StudioBaseUrl =
+  | `/${string}`
+  | `${string}.sanity.studio`
+  | `https://${string}`
+  | (string & {})
 
 /** @alpha */
 export type StudioBaseRoute = {baseUrl: StudioBaseUrl; workspace?: string; tool?: string}