Skip to content

Commit e2062d4

Browse files
committed
feat!: use named exports, build esm only
1 parent d2aec21 commit e2062d4

17 files changed

+348
-3802
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,19 @@ In addition to the core use case, this library provides a handy builder to acces
88

99
## Getting started
1010

11-
npm install --save @sanity/image-url
11+
```sh
12+
npm install --save @sanity/image-url
13+
```
1214

1315
## Usage
1416

1517
The most common way to use this library in your project is to configure it by passing it [your configured sanityClient](https://www.npmjs.com/package/@sanity/client). That way it will automatically be preconfigured to your current project and dataset:
1618

1719
```js
18-
import React from 'react'
1920
import myConfiguredSanityClient from './sanityClient'
20-
import imageUrlBuilder from '@sanity/image-url'
21+
import {urlBuilder} from '@sanity/image-url'
2122

22-
const builder = imageUrlBuilder(myConfiguredSanityClient)
23+
const builder = urlBuilder(myConfiguredSanityClient)
2324

2425
function urlFor(source) {
2526
return builder.image(source)
@@ -162,9 +163,9 @@ Specifies min/max dimensions when cropping.
162163
You can specify a custom `baseUrl` in the builder options in order to override the default (`https://cdn.sanity.io`):
163164

164165
```js
165-
import imageUrlBuilder from '@sanity/image-url'
166+
import {urlBuilder} from '@sanity/image-url'
166167

167-
const builder = imageUrlBuilder({
168+
const builder = urlBuilder({
168169
baseUrl: 'https://my.custom.domain',
169170
projectId: 'abc123',
170171
dataset: 'production',
@@ -183,10 +184,10 @@ urlFor('image-928ac96d53b0c9049836c86ff25fd3c009039a16-200x200-png')
183184
If you already have a configured client instance:
184185

185186
```js
186-
import imageUrlBuilder from '@sanity/image-url'
187+
import {urlBuilder} from '@sanity/image-url'
187188
import myConfiguredClient from './mySanityClient'
188189

189-
const builder = imageUrlBuilder({
190+
const builder = urlBuilder({
190191
...myConfiguredClient.config(),
191192
baseUrl: 'https://my.custom.domain',
192193
})

build/compat-runtime-stubs.mjs

Lines changed: 0 additions & 44 deletions
This file was deleted.

package.json

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,22 @@
77
".": {
88
"source": "./src/index.ts",
99
"import": "./lib/index.js",
10-
"require": "./lib/index.cjs",
1110
"default": "./lib/index.js"
1211
},
13-
"./lib/types/*": {
14-
"import": "./lib/compat/empty.js",
15-
"require": "./lib/compat/empty.cjs",
16-
"default": "./lib/compat/empty.js"
17-
},
1812
"./package.json": "./package.json"
1913
},
20-
"main": "./lib/index.cjs",
14+
"main": "./lib/index.js",
2115
"module": "./lib/index.js",
2216
"types": "./lib/index.d.ts",
2317
"files": [
2418
"lib",
25-
"src",
26-
"build/compat-shims.mjs"
19+
"src"
2720
],
2821
"sideEffects": false,
29-
"amdName": "SanityImageUrlBuilder",
3022
"scripts": {
3123
"prepublishOnly": "npm run build",
3224
"prebuild": "rimraf lib coverage .rts2*",
3325
"build": "pkg build --strict",
34-
"build:compat": "tsc -p tsconfig.compat.json && node build/compat-runtime-stubs.mjs",
35-
"postbuild": "npm run build:compat",
36-
"prepack": "npm run build:compat",
3726
"lint": "tslint --project tsconfig.json -t codeFrame 'src/**/*.ts' 'test/**/*.ts'",
3827
"test": "vitest run --coverage",
3928
"test:watch": "vitest coverage",
@@ -44,7 +33,7 @@
4433
},
4534
"browserslist": "extends @sanity/browserslist-config",
4635
"engines": {
47-
"node": ">=10.0.0"
36+
"node": ">=20.19.0"
4837
},
4938
"prettier": {
5039
"semi": false,
@@ -64,7 +53,6 @@
6453
"@sanity/pkg-utils": "^8.0.3",
6554
"@types/node": "^24.3.0",
6655
"@vitest/coverage-v8": "^3.2.4",
67-
"microbundle": "^0.15.1",
6856
"prettier": "^2.5.1",
6957
"rimraf": "^3.0.2",
7058
"tslint": "^6.1.3",

0 commit comments

Comments
 (0)