refactor: urlBuilder to createImageUrlBuilder

Author: rdunk

README.md

@@ -18,9 +18,9 @@ The most common way to use this library in your project is to configure it by pa
 
 ```js
 import myConfiguredSanityClient from './sanityClient'
-import {urlBuilder} from '@sanity/image-url'
+import {createImageUrlBuilder} from '@sanity/image-url'
 
-const builder = urlBuilder(myConfiguredSanityClient)
+const builder = createImageUrlBuilder(myConfiguredSanityClient)
 
 function urlFor(source) {
   return builder.image(source)
@@ -163,9 +163,9 @@ Specifies min/max dimensions when cropping.
 You can specify a custom `baseUrl` in the builder options in order to override the default (`https://cdn.sanity.io`):
 
 ```js
-import {urlBuilder} from '@sanity/image-url'
+import {createImageUrlBuilder} from '@sanity/image-url'
 
-const builder = urlBuilder({
+const builder = createImageUrlBuilder({
   baseUrl: 'https://my.custom.domain',
   projectId: 'abc123',
   dataset: 'production',
@@ -184,10 +184,10 @@ urlFor('image-928ac96d53b0c9049836c86ff25fd3c009039a16-200x200-png')
 If you already have a configured client instance:
 
 ```js
-import {urlBuilder} from '@sanity/image-url'
+import {createImageUrlBuilder} from '@sanity/image-url'
 import myConfiguredClient from './mySanityClient'
 
-const builder = urlBuilder({
+const builder = createImageUrlBuilder({
   ...myConfiguredClient.config(),
   baseUrl: 'https://my.custom.domain',
 })

src/builder.ts

@@ -44,7 +44,7 @@ function rewriteSpecName(key: string) {
 /**
  * @public
  */
-export function urlBuilder(
+export function createImageUrlBuilder(
   options?: SanityClientLike | SanityProjectDetails | SanityModernClientLike
 ) {
   // Did we get a modernish client?

src/index.ts

@@ -1,4 +1,4 @@
-export {urlBuilder} from './builder'
+export {createImageUrlBuilder} from './builder'
 
 export type {
   AutoMode,

test/builder.test.ts

@@ -1,9 +1,9 @@
 import {createClient} from '@sanity/client'
-import {urlBuilder} from '../src/builder'
+import {createImageUrlBuilder} from '../src/builder'
 import {describe, test, expect} from 'vitest'
 import {croppedImage, imageWithNoCropSpecified, noHotspotImage} from './fixtures'
 
-const urlFor = urlBuilder().projectId('zp7mbokg').dataset('production')
+const urlFor = createImageUrlBuilder().projectId('zp7mbokg').dataset('production')
 
 function stripPath(url: string | null): string {
   return (url || '').split('?')[1] || ''
@@ -262,7 +262,7 @@ describe('builder', () => {
 
   test('should allow specifying baseUrl directly', () => {
     expect(
-      urlBuilder({
+      createImageUrlBuilder({
         baseUrl: 'https://cdn.mydomain.com',
         projectId: 'aardvark',
         dataset: 'animals',
@@ -283,7 +283,7 @@ describe('builder', () => {
       },
     }
     expect(
-      urlBuilder(client)
+      createImageUrlBuilder(client)
         .image('image-928ac96d53b0c9049836c86ff25fd3c009039a16-200x200-png')
         .toString()
     ).toBe(
@@ -300,7 +300,7 @@ describe('builder', () => {
       useCdn: false,
     })
     expect(
-      urlBuilder(client)
+      createImageUrlBuilder(client)
         .image('image-928ac96d53b0c9049836c86ff25fd3c009039a16-200x200-png')
         .toString()
     ).toBe(

test/customDomain.test.ts

@@ -1,5 +1,5 @@
 import {describe, test, expect} from 'vitest'
-import {urlBuilder} from '../src/builder'
+import {createImageUrlBuilder} from '../src/builder'
 
 describe('custom domains', () => {
   test('can specify `baseUrl`', () => {
@@ -9,7 +9,7 @@ describe('custom domains', () => {
       baseUrl: 'https://mycustom.domain',
     }
     expect(
-      urlBuilder(options)
+      createImageUrlBuilder(options)
         .image('image-928ac96d53b0c9049836c86ff25fd3c009039a16-200x200-png')
         .toString()
     ).toBe(
@@ -24,7 +24,7 @@ describe('custom domains', () => {
       baseUrl: 'https://mycustom.domain/',
     }
     expect(
-      urlBuilder(options)
+      createImageUrlBuilder(options)
         .image('image-928ac96d53b0c9049836c86ff25fd3c009039a16-200x200-png')
         .toString()
     ).toBe(
@@ -41,7 +41,7 @@ describe('custom domains', () => {
       },
     }
     expect(
-      urlBuilder(options)
+      createImageUrlBuilder(options)
         .image('image-928ac96d53b0c9049836c86ff25fd3c009039a16-200x200-png')
         .toString()
     ).toBe(

test/fromClient.test.ts

@@ -1,12 +1,12 @@
 import {describe, test, expect} from 'vitest'
-import {urlBuilder} from '../src/builder'
+import {createImageUrlBuilder} from '../src/builder'
 
 describe('init from client', () => {
   test('can get config from client', () => {
     const client = {
       clientConfig: {projectId: 'abc123', dataset: 'foo', apiHost: 'https://cdn.sanity.io'},
     }
-    expect(urlBuilder(client).image('image-abc123-200x200-png').toString()).toBe(
+    expect(createImageUrlBuilder(client).image('image-abc123-200x200-png').toString()).toBe(
       'https://cdn.sanity.io/images/abc123/foo/abc123-200x200.png'
     )
   })
@@ -19,7 +19,7 @@ describe('init from client', () => {
         dataset: 'foo',
       },
     }
-    expect(urlBuilder(client).image('image-abc123-200x200-png').toString()).toBe(
+    expect(createImageUrlBuilder(client).image('image-abc123-200x200-png').toString()).toBe(
       'https://cdn.sanity.lol/images/abc123/foo/abc123-200x200.png'
     )
   })