@sanity/client 6.25.0 → 6.26.0

package/src/csm/createEditUrl.ts

@@ -1,4 +1,4 @@
-import {DRAFTS_PREFIX, getPublishedId} from './getPublishedId'
+import {getPublishedId, isDraftId} from './draftUtils'
 import {jsonPathToStudioPath} from './jsonPath'
 import * as studioPath from './studioPath'
 import type {CreateEditUrlOptions, EditIntentUrl, StudioBaseUrl} from './types'
@@ -56,7 +56,7 @@ export function createEditUrl(options: CreateEditUrlOptions): `${StudioBaseUrl}$
   if (dataset) {
     searchParams.set('dataset', dataset)
   }
-  if (_id.startsWith(DRAFTS_PREFIX)) {
+  if (isDraftId(_id)) {
     searchParams.set('isDraft', '')
   }
 

package/src/csm/draftUtils.ts

@@ -0,0 +1,81 @@
+// nominal/opaque type hack
+type Opaque<T, K> = T & {__opaqueId__: K}
+
+/** @internal */
+export type DraftId = Opaque<string, 'draftId'>
+
+/** @internal */
+export type PublishedId = Opaque<string, 'publishedId'>
+
+/** @internal */
+export const DRAFTS_FOLDER = 'drafts'
+
+/** @internal */
+export const VERSION_FOLDER = 'versions'
+
+const PATH_SEPARATOR = '.'
+const DRAFTS_PREFIX = `${DRAFTS_FOLDER}${PATH_SEPARATOR}`
+const VERSION_PREFIX = `${VERSION_FOLDER}${PATH_SEPARATOR}`
+
+/** @internal */
+export function isDraftId(id: string): id is DraftId {
+  return id.startsWith(DRAFTS_PREFIX)
+}
+
+/** @internal */
+export function isVersionId(id: string): boolean {
+  return id.startsWith(VERSION_PREFIX)
+}
+
+/** @internal */
+export function isPublishedId(id: string): id is PublishedId {
+  return !isDraftId(id) && !isVersionId(id)
+}
+
+/** @internal */
+export function getDraftId(id: string): DraftId {
+  if (isVersionId(id)) {
+    const publishedId = getPublishedId(id)
+    return (DRAFTS_PREFIX + publishedId) as DraftId
+  }
+
+  return isDraftId(id) ? id : ((DRAFTS_PREFIX + id) as DraftId)
+}
+
+/**  @internal */
+export function getVersionId(id: string, version: string): string {
+  if (version === 'drafts' || version === 'published') {
+    throw new Error('Version can not be "published" or "drafts"')
+  }
+
+  return `${VERSION_PREFIX}${version}${PATH_SEPARATOR}${getPublishedId(id)}`
+}
+
+/**
+ *  @internal
+ *  Given an id, returns the versionId if it exists.
+ *  e.g. `versions.summer-drop.foo` = `summer-drop`
+ *  e.g. `drafts.foo` = `undefined`
+ *  e.g. `foo` = `undefined`
+ */
+export function getVersionFromId(id: string): string | undefined {
+  if (!isVersionId(id)) return undefined
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  const [_versionPrefix, versionId, ..._publishedId] = id.split(PATH_SEPARATOR)
+
+  return versionId
+}
+
+/** @internal */
+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
+  }
+
+  if (isDraftId(id)) {
+    return id.slice(DRAFTS_PREFIX.length) as PublishedId
+  }
+
+  return id as PublishedId
+}

package/src/csm/index.ts

@@ -2,7 +2,19 @@ import * as studioPath from './studioPath'
 export {studioPath}
 export * from './applySourceDocuments'
 export {createEditUrl} from './createEditUrl'
-export {getPublishedId} from './getPublishedId'
+export {
+  type DraftId,
+  DRAFTS_FOLDER,
+  getDraftId,
+  getPublishedId,
+  getVersionFromId,
+  getVersionId,
+  isDraftId,
+  isPublishedId,
+  isVersionId,
+  type PublishedId,
+  VERSION_FOLDER,
+} from './draftUtils'
 export {jsonPath, jsonPathToStudioPath, parseJsonPath, studioPathToJsonPath} from './jsonPath'
 export {resolvedKeyedSourcePath} from './resolvedKeyedSourcePath'
 export {resolveEditInfo} from './resolveEditInfo'

package/umd/sanityClient.js

@@ -3619,9 +3619,15 @@ ${selectionOpts}`);
       });
     });
   }
-  const DRAFTS_PREFIX = "drafts.";
+  const DRAFTS_FOLDER = "drafts", VERSION_FOLDER = "versions", PATH_SEPARATOR = ".", DRAFTS_PREFIX = `${DRAFTS_FOLDER}${PATH_SEPARATOR}`, VERSION_PREFIX = `${VERSION_FOLDER}${PATH_SEPARATOR}`;
+  function isDraftId(id) {
+    return id.startsWith(DRAFTS_PREFIX);
+  }
+  function isVersionId(id) {
+    return id.startsWith(VERSION_PREFIX);
+  }
   function getPublishedId(id) {
-    return id.startsWith(DRAFTS_PREFIX) ? id.slice(DRAFTS_PREFIX.length) : id;
+    return isVersionId(id) ? id.split(PATH_SEPARATOR).slice(2).join(PATH_SEPARATOR) : isDraftId(id) ? id.slice(DRAFTS_PREFIX.length) : id;
   }
   function createEditUrl(options) {
     const {
@@ -3648,7 +3654,7 @@ ${selectionOpts}`);
       type,
       path: stringifiedPath
     });
-    workspace && searchParams.set("workspace", workspace), tool && searchParams.set("tool", tool), projectId && searchParams.set("projectId", projectId), dataset && searchParams.set("dataset", dataset), _id.startsWith(DRAFTS_PREFIX) && searchParams.set("isDraft", "");
+    workspace && searchParams.set("workspace", workspace), tool && searchParams.set("tool", tool), projectId && searchParams.set("projectId", projectId), dataset && searchParams.set("dataset", dataset), isDraftId(_id) && searchParams.set("isDraft", "");
     const segments = [baseUrl === "/" ? "" : baseUrl];
     workspace && segments.push(workspace);
     const routerParams = [