fix(types): disambiguate SanityClient imports (#445)

sanity-io · Dec 7, 2023 · b4b9079 · b4b9079
1 parent 527393d
commit b4b9079
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 3 deletions.
diff --git a/src/stega/SanityStegaClient.ts b/src/stega/SanityStegaClient.ts
@@ -2,7 +2,10 @@ import {Observable} from 'rxjs'
 import {map} from 'rxjs/operators'
 
 import {defaultConfig} from '../config'
-import {ObservableSanityClient, SanityClient} from '../SanityClient'
+import {
+  ObservableSanityClient as INTERNAL_DO_NOT_USE_DIRECTLY_ObservableSanityClient,
+  SanityClient as INTERNAL_DO_NOT_USE_DIRECTLY_SanityClient,
+} from '../SanityClient'
 import type {
   Any,
   ClientConfig,
@@ -17,7 +20,7 @@ import {stegaEncodeSourceMap} from './stegaEncodeSourceMap'
 import {ClientStegaConfig, InitializedClientStegaConfig, InitializedStegaConfig} from './types'
 
 /** @public */
-export class ObservableSanityStegaClient extends ObservableSanityClient {
+export class ObservableSanityStegaClient extends INTERNAL_DO_NOT_USE_DIRECTLY_ObservableSanityClient {
   /**
    * Private properties
    */
@@ -143,7 +146,7 @@ export class ObservableSanityStegaClient extends ObservableSanityClient {
 }
 
 /** @public */
-export class SanityStegaClient extends SanityClient {
+export class SanityStegaClient extends INTERNAL_DO_NOT_USE_DIRECTLY_SanityClient {
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
    */
@@ -272,3 +275,8 @@ export class SanityStegaClient extends SanityClient {
       })
   }
 }
+
+export type {
+  INTERNAL_DO_NOT_USE_DIRECTLY_ObservableSanityClient,
+  INTERNAL_DO_NOT_USE_DIRECTLY_SanityClient,
+}
diff --git a/src/stega/index.browser.ts b/src/stega/index.browser.ts
@@ -10,6 +10,7 @@ const exp = defineCreateClientExports<SanityStegaClient, ClientStegaConfig>(
   SanityStegaClient,
 )
 
+export type {ObservableSanityClient, SanityClient} from './shared'
 export * from './shared'
 
 /** @public */

diff --git a/src/stega/index.ts b/src/stega/index.ts
@@ -10,6 +10,7 @@ const exp = defineCreateClientExports<SanityStegaClient, ClientStegaConfig>(
   SanityStegaClient,
 )
 
+export type {ObservableSanityClient, SanityClient} from './shared'
 export * from './shared'
 
 /** @public */

diff --git a/src/stega/shared.ts b/src/stega/shared.ts
@@ -3,3 +3,15 @@ export * from './SanityStegaClient'
 export {stegaEncodeSourceMap} from './stegaEncodeSourceMap'
 export * from './types'
 export {vercelStegaCleanAll} from './vercelStegaCleanAll'
+
+/**
+ * @deprecated -- Use `import type {SanityClient} from '@sanity/client'` instead
+ * @public
+ */
+export type SanityClient = never
+
+/**
+ * @deprecated -- Use `import type {ObservableSanityClient} from '@sanity/client'` instead
+ * @public
+ */
+export type ObservableSanityClient = never