fix: add support for using the default export (#117)

runtimes/node/test.cjs

@@ -30,6 +30,8 @@ test('top-level imports', async (t) => {
     assert.deepEqual(cjs, esm)
   })
 
+  // @TODO re-enable in v6
+  /*
   await t.test('throws a deprecation error on the default export', () => {
     const {default: createClient} = require('@sanity/client')
 
@@ -55,4 +57,5 @@ test('top-level imports', async (t) => {
       }
     )
   })
+  // */
 })

runtimes/node/test.mjs

@@ -1,14 +1,7 @@
 import test from 'node:test'
 import assert from 'node:assert/strict'
 
-import deprecatedClient, {
-  createClient,
-  Patch,
-  Transaction,
-  ClientError,
-  ServerError,
-  requester,
-} from '@sanity/client'
+import {createClient, Patch, Transaction, ClientError, ServerError, requester} from '@sanity/client'
 import pkg from '@sanity/client/package.json' assert {type: 'json'}
 
 test('top-level imports', async (t) => {
@@ -26,6 +19,8 @@ test('top-level imports', async (t) => {
     assert.equal(typeof version, 'string')
   })
 
+  // @TODO re-enable in v6
+  /*
   await t.test('throws a deprecation error on the default export', () => {
     assert.throws(
       () => {
@@ -47,4 +42,5 @@ test('top-level imports', async (t) => {
       }
     )
   })
+  // */
 })

src/config.ts

@@ -1,4 +1,4 @@
-import generateHelpUrl from './generateHelpUrl'
+import {generateHelpUrl} from './generateHelpUrl'
 import type {ClientConfig, InitializedClientConfig} from './types'
 import * as validate from './validators'
 import * as warnings from './warnings'

src/data/dataMethods.ts

@@ -1,7 +1,7 @@
 import {type MonoTypeOperatorFunction, Observable} from 'rxjs'
 import {filter, map} from 'rxjs/operators'
 
-import getRequestOptions from '../http/requestOptions'
+import {requestOptions} from '../http/requestOptions'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {
   AllDocumentIdsMutationOptions,
@@ -25,10 +25,10 @@ import type {
   SingleMutationResult,
   UnfilteredResponseQueryOptions,
 } from '../types'
-import getSelection from '../util/getSelection'
+import {getSelection} from '../util/getSelection'
 import * as validate from '../validators'
 import * as validators from '../validators'
-import encodeQueryString from './encodeQueryString'
+import {encodeQueryString} from './encodeQueryString'
 import {ObservablePatch, Patch} from './patch'
 import {ObservableTransaction, Transaction} from './transaction'
 
@@ -301,7 +301,7 @@ export function _requestObservable<R>(
     options.query = {tag: validate.requestTag(tag), ...options.query}
   }
 
-  const reqOptions = getRequestOptions(
+  const reqOptions = requestOptions(
     config,
     Object.assign({}, options, {
       url: _getUrl(client, uri, useCdn),

src/data/encodeQueryString.ts

@@ -1,6 +1,6 @@
 import type {Any, QueryParams} from '../types'
 
-export default ({
+export const encodeQueryString = ({
   query,
   params = {},
   options = {},

src/data/listen.ts

@@ -4,9 +4,9 @@ import {Observable} from 'rxjs'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {Any, ListenEvent, ListenOptions, MutationEvent, QueryParams} from '../types'
 import defaults from '../util/defaults'
-import pick from '../util/pick'
+import {pick} from '../util/pick'
 import {_getDataUrl} from './dataMethods'
-import encodeQueryString from './encodeQueryString'
+import {encodeQueryString} from './encodeQueryString'
 
 // Limit is 16K for a _request_, eg including headers. Have to account for an
 // unknown range of headers, but an average EventSource request from Chrome seems

src/data/patch.ts

@@ -16,7 +16,7 @@ import type {
   SanityDocument,
   SingleMutationResult,
 } from '../types'
-import getSelection from '../util/getSelection'
+import {getSelection} from '../util/getSelection'
 import {validateInsert, validateObject} from '../validators'
 
 /** @internal */

src/generateHelpUrl.ts

@@ -1,5 +1,5 @@
 const BASE_URL = 'https://www.sanity.io/help/'
 
-export default function generateHelpUrl(slug: string) {
+export function generateHelpUrl(slug: string) {
   return BASE_URL + slug
 }

src/http/requestOptions.ts

@@ -4,7 +4,7 @@ import type {Any} from '../types'
 
 const projectHeader = 'X-Sanity-Project-ID'
 
-export default (config: Any, overrides: Any = {}): Omit<RequestOptions, 'url'> => {
+export function requestOptions(config: Any, overrides: Any = {}): Omit<RequestOptions, 'url'> {
   const headers: Any = {}
 
   const token = overrides.token || config.token

src/index.browser.ts

@@ -2,6 +2,7 @@ import envMiddleware from './http/browserMiddleware'
 import {defineHttpRequest} from './http/request'
 import {SanityClient} from './SanityClient'
 import type {ClientConfig} from './types'
+import {printNoDefaultExport} from './warnings'
 
 export * from './data/patch'
 export * from './data/transaction'
@@ -17,4 +18,11 @@ export const requester = httpRequest.defaultRequester
 /** @public */
 export const createClient = (config: ClientConfig) => new SanityClient(httpRequest, config)
 
-export {migrationNotice as default} from './migrationNotice'
+/**
+ * @public
+ * @deprecated Use the named export `createClient` instead of the `default` export
+ */
+export default function deprecatedCreateClient(config: ClientConfig) {
+  printNoDefaultExport()
+  return new SanityClient(httpRequest, config)
+}

src/index.ts

@@ -2,6 +2,7 @@ import envMiddleware from './http/nodeMiddleware'
 import {defineHttpRequest} from './http/request'
 import {SanityClient} from './SanityClient'
 import type {ClientConfig} from './types'
+import {printNoDefaultExport} from './warnings'
 
 export * from './data/patch'
 export * from './data/transaction'
@@ -17,4 +18,11 @@ export const requester = httpRequest.defaultRequester
 /** @public */
 export const createClient = (config: ClientConfig) => new SanityClient(httpRequest, config)
 
-export {migrationNotice as default} from './migrationNotice'
+/**
+ * @public
+ * @deprecated Use the named export `createClient` instead of the `default` export
+ */
+export default function deprecatedCreateClient(config: ClientConfig) {
+  printNoDefaultExport()
+  return new SanityClient(httpRequest, config)
+}

src/util/getSelection.ts

@@ -1,6 +1,6 @@
 import type {MutationSelection} from '../types'
 
-export default function getSelection(sel: unknown): MutationSelection {
+export function getSelection(sel: unknown): MutationSelection {
   if (typeof sel === 'string' || Array.isArray(sel)) {
     return {id: sel}
   }

src/util/once.ts

@@ -1,6 +1,6 @@
 import type {Any} from '../types'
 
-export default (fn: Any) => {
+export function once(fn: Any) {
   let didCall = false
   let returnValue: Any
   return (...args: Any[]) => {

src/util/pick.ts

@@ -1,6 +1,6 @@
 import {Any} from '../types'
 
-export default (obj: Any, props: Any) =>
+export const pick = (obj: Any, props: Any) =>
   props.reduce((selection: Any, prop: Any) => {
     if (typeof obj[prop] === 'undefined') {
       return selection

src/warnings.ts

@@ -1,6 +1,6 @@
-import generateHelpUrl from './generateHelpUrl'
+import {generateHelpUrl} from './generateHelpUrl'
 import {Any} from './types'
-import once from './util/once'
+import {once} from './util/once'
 
 const createWarningPrinter = (message: string[]) =>
   // eslint-disable-next-line no-console
@@ -24,3 +24,7 @@ export const printNoApiVersionSpecifiedWarning = createWarningPrinter([
   'Using the Sanity client without specifying an API version is deprecated.',
   `See ${generateHelpUrl('js-client-api-version')}`,
 ])
+
+export const printNoDefaultExport = createWarningPrinter([
+  'The default export of @sanity/client has been deprecated. Use the named export `createClient` instead',
+])

test/encodeQueryString.test.ts

@@ -1,45 +1,45 @@
 import {expect, test} from 'vitest'
 
-import encode from '../src/data/encodeQueryString'
+import {encodeQueryString} from '../src/data/encodeQueryString'
 
 test('can encode basic query without parameters', () => {
   const query = 'gamedb.game[maxPlayers == 64]'
-  expect(encode({query})).toEqual('?query=gamedb.game%5BmaxPlayers+%3D%3D+64%5D')
+  expect(encodeQueryString({query})).toEqual('?query=gamedb.game%5BmaxPlayers+%3D%3D+64%5D')
 })
 
 test('can encode queries with basic numeric parameters', () => {
   const query = 'gamedb.game[maxPlayers == $maxPlayers && score == $score]'
 
-  expect(encode({query, params: {maxPlayers: 64, score: 3.45678}})).toEqual(
+  expect(encodeQueryString({query, params: {maxPlayers: 64, score: 3.45678}})).toEqual(
     '?query=gamedb.game%5BmaxPlayers+%3D%3D+%24maxPlayers+%26%26+score+%3D%3D+%24score%5D&%24maxPlayers=64&%24score=3.45678'
   )
 })
 
 test('can encode queries with basic string parameters', () => {
   const query = 'gamedb.game[name == $name]'
-  expect(encode({query, params: {name: 'foobar'}})).toEqual(
+  expect(encodeQueryString({query, params: {name: 'foobar'}})).toEqual(
     '?query=gamedb.game%5Bname+%3D%3D+%24name%5D&%24name=%22foobar%22'
   )
 })
 
 test('can encode queries with booleans', () => {
   const query = 'gamedb.game[isReleased == $released]'
-  expect(encode({query, params: {released: true}})).toEqual(
+  expect(encodeQueryString({query, params: {released: true}})).toEqual(
     '?query=gamedb.game%5BisReleased+%3D%3D+%24released%5D&%24released=true'
   )
 })
 
 test('handles options', () => {
   const query = 'gamedb.game[maxPlayers == 64]'
-  expect(encode({query, options: {includeResult: true}})).toEqual(
+  expect(encodeQueryString({query, options: {includeResult: true}})).toEqual(
     '?query=gamedb.game%5BmaxPlayers+%3D%3D+64%5D&includeResult=true'
   )
 })
 
 test('skips falsy options', () => {
   const query = 'gamedb.game[maxPlayers == 64]'
   expect(
-    encode({
+    encodeQueryString({
       query,
       options: {
         extract: null,