Compare commits

...

16 Commits

Author SHA1 Message Date
Lovell Fuller
de9bdcba0a Prerelease 0.33.0-alpha.9 2023-10-13 14:32:21 +01:00
Lovell Fuller
f8b6cb6d5b Update package names to use 'img' npm organisation 2023-10-12 17:03:37 +01:00
Thomas
e6942805b4 TypeScript: withMetadata accepts boolean (#3823) 2023-10-11 20:38:13 +01:00
Lovell Fuller
47e76c9981 Ensure all Error objects contain a stack prop #3653 2023-10-11 14:59:21 +01:00
Lovell Fuller
68fa84ef6f Remove unused gitattributes 2023-10-11 14:48:40 +01:00
Lovell Fuller
ff2fb18c76 Remove extranous quote from help text 2023-10-11 10:03:07 +01:00
Lovell Fuller
28a9b1e9fa CI: Split npm package smoke tests into a matrix 2023-10-11 10:02:20 +01:00
Lovell Fuller
6377d5a73a Prerelease 0.33.0-alpha.8 2023-10-10 20:24:07 +01:00
Lovell Fuller
80e4707af1 Revert "Package managers cannot handle nested optionalDependencies"
This partially reverts commit 51e56f994c.

Ignoring plug'n'play, it looks like yarn and pnpm do get the
filesystem layout right for this scenario, which is good news.

It also looks like npm 10 will get it right too.
2023-10-10 19:34:36 +01:00
Lovell Fuller
ab00e34d0d Prerelease 0.33.0-alpha.7 2023-10-10 14:47:13 +01:00
Lovell Fuller
7c2f883b67 CI: add pnpm and yarn to npm smoke tests 2023-10-10 11:15:55 +01:00
Lovell Fuller
9b5eecba8f Yarn pnp unsupported, use alternative nodeLinker 2023-10-10 11:14:39 +01:00
Lovell Fuller
4b028edfe9 Revert "Remove extraneous rpath"
This reverts commit 3f54ef7525.

The filesystem layout used by pnpm means that a nesting of 2
directories deep is used in the wild and must remain.
2023-10-10 09:56:07 +01:00
Lovell Fuller
7e25dd7be1 Ensure versions prop detects use of global libvips 2023-10-10 09:18:25 +01:00
Lovell Fuller
09460d7af4 CI: use correct version of write-file action 2023-10-09 13:36:03 +01:00
Lovell Fuller
3b22640077 Use std::snprintf to concat libvips version parts 2023-10-09 13:35:20 +01:00
34 changed files with 380 additions and 162 deletions

View File

@@ -38,7 +38,7 @@ jobs:
- run: sudo docker exec sharp sh -c "npm test"
- run: |
sudo docker exec sharp sh -c "npm run package-from-local-build"
sudo docker exec sharp sh -c "npm pkg set \"optionalDependencies.@sharpen/sharp-linux-arm64=file:./npm/linux-arm64\""
sudo docker exec sharp sh -c "npm pkg set \"optionalDependencies.@img/sharp-linux-arm64=file:./npm/linux-arm64\""
sudo docker exec sharp sh -c "npm run clean"
sudo docker exec sharp sh -c "npm install --ignore-scripts"
sudo docker exec sharp sh -c "npm test"
@@ -62,7 +62,7 @@ jobs:
- run: sudo docker exec sharp sh -c "npm test"
- run: |
sudo docker exec sharp sh -c "npm run package-from-local-build"
sudo docker exec sharp sh -c "npm pkg set \"optionalDependencies.@sharpen/sharp-linux-arm64=file:./npm/linux-arm64\""
sudo docker exec sharp sh -c "npm pkg set \"optionalDependencies.@img/sharp-linux-arm64=file:./npm/linux-arm64\""
sudo docker exec sharp sh -c "npm run clean"
sudo docker exec sharp sh -c "npm install --ignore-scripts"
sudo docker exec sharp sh -c "npm test"
@@ -79,7 +79,7 @@ jobs:
- run: sudo docker exec sharp sh -c "npm test"
- run: |
sudo docker exec sharp sh -c "npm run package-from-local-build"
sudo docker exec sharp sh -c "npm pkg set \"optionalDependencies.@sharpen/sharp-linuxmusl-arm64=file:./npm/linuxmusl-arm64\""
sudo docker exec sharp sh -c "npm pkg set \"optionalDependencies.@img/sharp-linuxmusl-arm64=file:./npm/linuxmusl-arm64\""
sudo docker exec sharp sh -c "npm run clean"
sudo docker exec sharp sh -c "npm install --ignore-scripts"
sudo docker exec sharp sh -c "npm test"
@@ -99,7 +99,7 @@ jobs:
- run: sudo docker exec sharp sh -c "npm test"
- run: |
sudo docker exec sharp sh -c "npm run package-from-local-build"
sudo docker exec sharp sh -c "npm pkg set \"optionalDependencies.@sharpen/sharp-linuxmusl-arm64=file:./npm/linuxmusl-arm64\""
sudo docker exec sharp sh -c "npm pkg set \"optionalDependencies.@img/sharp-linuxmusl-arm64=file:./npm/linuxmusl-arm64\""
sudo docker exec sharp sh -c "npm run clean"
sudo docker exec sharp sh -c "npm install --ignore-scripts"
sudo docker exec sharp sh -c "npm test"

1
.gitattributes vendored
View File

@@ -1 +0,0 @@
src/libvips/* linguist-vendored

View File

@@ -106,7 +106,7 @@ jobs:
- name: Test packaging
run: |
npm run package-from-local-build
npm pkg set "optionalDependencies.@sharpen/sharp-${{ matrix.platform }}=file:./npm/${{ matrix.platform }}"
npm pkg set "optionalDependencies.@img/sharp-${{ matrix.platform }}=file:./npm/${{ matrix.platform }}"
npm run clean
npm install --ignore-scripts
npm test
@@ -141,7 +141,7 @@ jobs:
npm install --build-from-source
npx mocha --no-config --spec=test/unit/io.js
npm run package-from-local-build
npm pkg set "optionalDependencies.@sharpen/sharp-linux-arm=file:./npm/linux-arm"
npm pkg set "optionalDependencies.@img/sharp-linux-arm=file:./npm/linux-arm"
npm run clean
npm install --ignore-scripts
npx mocha --no-config --spec=test/unit/io.js --timeout=30000
@@ -182,7 +182,7 @@ jobs:
- name: Test packaging
run: |
npm run package-from-local-build
npm pkg set "optionalDependencies.@sharpen/sharp-${{ matrix.platform }}=file:./npm/${{ matrix.platform }}"
npm pkg set "optionalDependencies.@img/sharp-${{ matrix.platform }}=file:./npm/${{ matrix.platform }}"
npm run clean
npm install --ignore-scripts
npm test

View File

@@ -1,4 +1,4 @@
name: "npm release smoke test"
name: "CI: npm smoke test"
on:
push:
@@ -9,29 +9,84 @@ permissions: {}
jobs:
release-smoke-test:
name: "${{ github.ref }} ${{ matrix.name }}"
runs-on: ${{ matrix.os }}
name: "${{ github.ref_name }} ${{ matrix.name }}"
runs-on: ${{ matrix.runs-on }}
strategy:
fail-fast: false
matrix:
include:
- name: linux-x64
os: ubuntu-22.04
- name: darwin-x64
os: macos-11
- name: win32-x64
os: windows-2019
- name: linux-x64-node-npm
runs-on: ubuntu-22.04
runtime: node
package-manager: npm
- name: linux-x64-node-pnpm
runs-on: ubuntu-22.04
runtime: node
package-manager: pnpm
- name: linux-x64-node-yarn
runs-on: ubuntu-22.04
runtime: node
package-manager: yarn
- name: linux-x64-deno
runs-on: ubuntu-22.04
runtime: deno
- name: linux-x64-bun
runs-on: ubuntu-22.04
runtime: bun
- name: darwin-x64-node-npm
runs-on: macos-11
runtime: node
package-manager: npm
- name: darwin-x64-node-pnpm
runs-on: macos-11
runtime: node
package-manager: pnpm
- name: darwin-x64-node-yarn
runs-on: macos-11
runtime: node
package-manager: yarn
- name: darwin-x64-deno
runs-on: macos-11
runtime: deno
- name: darwin-x64-bun
runs-on: macos-11
runtime: bun
- name: win32-x64-node-npm
runs-on: windows-2019
runtime: node
package-manager: npm
- name: win32-x64-node-pnpm
runs-on: windows-2019
runtime: node
package-manager: pnpm
- name: win32-x64-node-yarn
runs-on: windows-2019
runtime: node
package-manager: yarn
- name: win32-x64-deno
runs-on: windows-2019
runtime: deno
steps:
- name: Install Node.js
if: ${{ matrix.runtime == 'node' }}
uses: actions/setup-node@v3
with:
node-version: 20
- name: Install pnpm
if: ${{ matrix.package-manager == 'pnpm' }}
uses: pnpm/action-setup@v2
with:
version: 8
- name: Install Deno
if: ${{ matrix.runtime == 'deno' }}
uses: denoland/setup-deno@v1
with:
deno-version: v1.x
- name: Install Bun
if: ${{ !contains(matrix.os, 'windows') }}
if: ${{ matrix.runtime == 'bun' }}
uses: oven-sh/setup-bun@v1
with:
bun-version: latest
@@ -43,7 +98,7 @@ jobs:
script: |
core.setOutput('semver', context.ref.replace('refs/tags/v',''))
- name: Create package.json
uses: DamianReeves/write-file-action@v1
uses: DamianReeves/write-file-action@v1.2
with:
path: package.json
contents: |
@@ -53,7 +108,7 @@ jobs:
}
}
- name: Create release.mjs
uses: DamianReeves/write-file-action@v1
uses: DamianReeves/write-file-action@v1.2
with:
path: release.mjs
contents: |
@@ -63,16 +118,35 @@ jobs:
const sharp = require('sharp');
deepStrictEqual(['.jpg', '.jpeg', '.jpe'], sharp.format.jpeg.input.fileSuffix);
- name: Run with Node.js
- name: Run with Node.js + npm
if: ${{ matrix.runtime == 'node' && matrix.package-manager == 'npm' }}
run: |
npm install --ignore-scripts
node release.mjs
- name: Run with Node.js + pnpm
if: ${{ matrix.runtime == 'node' && matrix.package-manager == 'pnpm' }}
run: |
pnpm install --ignore-scripts
node release.mjs
- name: Run with Node.js + yarn
if: ${{ matrix.runtime == 'node' && matrix.package-manager == 'yarn' }}
run: |
corepack enable
yarn set version stable
yarn config set enableImmutableInstalls false
yarn config set enableScripts false
yarn config set nodeLinker node-modules
yarn install
node release.mjs
- name: Run with Deno
if: ${{ matrix.runtime == 'deno' }}
run: deno run --allow-read --allow-ffi release.mjs
- name: Run with Bun
if: ${{ !contains(matrix.os, 'windows') }}
if: ${{ matrix.runtime == 'bun' }}
run: |
bun install --ignore-scripts
bun release.mjs

5
.gitignore vendored
View File

@@ -8,11 +8,6 @@ test/bench/node_modules
test/fixtures/output*
test/fixtures/vips-properties.xml
test/leak/libvips.supp
test/saliency/report.json
test/saliency/Image*
test/saliency/[Uu]serData*
!test/saliency/userData.js
.gitattributes
.DS_Store
.nyc_output
.vscode/

View File

@@ -1,7 +1,8 @@
## versions
> versions
An Object containing the version numbers of sharp, libvips and its dependencies.
An Object containing the version numbers of sharp, libvips
and (when using prebuilt binaries) its dependencies.
**Example**

View File

@@ -14,6 +14,9 @@ Requires libvips v8.14.5
* Remove `sharp.vendor`.
* Ensure all `Error` objects contain a `stack` property.
[#3653](https://github.com/lovell/sharp/issues/3653)
* Make `compression` option of `heif` mandatory to help reduce HEIF vs HEIC confusion.
[#3740](https://github.com/lovell/sharp/issues/3740)

View File

@@ -5,13 +5,15 @@ npm install sharp
```
```sh
yarn add sharp
pnpm add sharp
```
```sh
pnpm add sharp
yarn add sharp
```
Yarn Plug'n'Play is unsupported.
## Prerequisites
* Node.js >= 18.17.0
@@ -104,14 +106,14 @@ must include binaries for either the linux-x64 or linux-arm64 platforms
depending on the chosen architecture.
When building your deployment package on a machine that differs from the target architecture,
you will need to install either `@sharpen/sharp-linux-x64` or `@sharpen/sharp-linux-arm64` package.
you will need to install either `@img/sharp-linux-x64` or `@img/sharp-linux-arm64` package.
```sh
npm install --force @sharpen/sharp-linux-x64
npm install --force @img/sharp-linux-x64
```
```sh
npm install --force @sharpen/sharp-linux-arm64
npm install --force @img/sharp-linux-arm64
```
To get the best performance select the largest memory available.
@@ -163,7 +165,7 @@ custom:
- sharp
packagerOptions:
scripts:
- npm install --force @sharpen/sharp-linux-x64
- npm install --force @img/sharp-linux-x64
```
## TypeScript

File diff suppressed because one or more lines are too long

10
lib/index.d.ts vendored
View File

@@ -640,7 +640,7 @@ declare namespace sharp {
* @param withMetadata
* @throws {Error} Invalid parameters.
*/
withMetadata(withMetadata?: WriteableMetadata): Sharp;
withMetadata(withMetadata?: boolean | WriteableMetadata): Sharp;
/**
* Use these JPEG options for output image.
@@ -1275,10 +1275,10 @@ declare namespace sharp {
}
interface NormaliseOptions {
/** Percentile below which luminance values will be underexposed. */
lower?: number | undefined;
/** Percentile above which luminance values will be overexposed. */
upper?: number | undefined;
/** Percentile below which luminance values will be underexposed. */
lower?: number | undefined;
/** Percentile above which luminance values will be overexposed. */
upper?: number | undefined;
}
interface ResizeOptions {

View File

@@ -483,14 +483,27 @@ function _isStreamInput () {
* @returns {Promise<Object>|Sharp}
*/
function metadata (callback) {
const stack = Error();
if (is.fn(callback)) {
if (this._isStreamInput()) {
this.on('finish', () => {
this._flattenBufferIn();
sharp.metadata(this.options, callback);
sharp.metadata(this.options, (err, metadata) => {
if (err) {
callback(is.nativeError(err, stack));
} else {
callback(null, metadata);
}
});
});
} else {
sharp.metadata(this.options, callback);
sharp.metadata(this.options, (err, metadata) => {
if (err) {
callback(is.nativeError(err, stack));
} else {
callback(null, metadata);
}
});
}
return this;
} else {
@@ -500,7 +513,7 @@ function metadata (callback) {
this._flattenBufferIn();
sharp.metadata(this.options, (err, metadata) => {
if (err) {
reject(err);
reject(is.nativeError(err, stack));
} else {
resolve(metadata);
}
@@ -516,7 +529,7 @@ function metadata (callback) {
return new Promise((resolve, reject) => {
sharp.metadata(this.options, (err, metadata) => {
if (err) {
reject(err);
reject(is.nativeError(err, stack));
} else {
resolve(metadata);
}
@@ -572,14 +585,27 @@ function metadata (callback) {
* @returns {Promise<Object>}
*/
function stats (callback) {
const stack = Error();
if (is.fn(callback)) {
if (this._isStreamInput()) {
this.on('finish', () => {
this._flattenBufferIn();
sharp.stats(this.options, callback);
sharp.stats(this.options, (err, stats) => {
if (err) {
callback(is.nativeError(err, stack));
} else {
callback(null, stats);
}
});
});
} else {
sharp.stats(this.options, callback);
sharp.stats(this.options, (err, stats) => {
if (err) {
callback(is.nativeError(err, stack));
} else {
callback(null, stats);
}
});
}
return this;
} else {
@@ -589,7 +615,7 @@ function stats (callback) {
this._flattenBufferIn();
sharp.stats(this.options, (err, stats) => {
if (err) {
reject(err);
reject(is.nativeError(err, stack));
} else {
resolve(stats);
}
@@ -600,7 +626,7 @@ function stats (callback) {
return new Promise((resolve, reject) => {
sharp.stats(this.options, (err, stats) => {
if (err) {
reject(err);
reject(is.nativeError(err, stack));
} else {
resolve(stats);
}

View File

@@ -137,6 +137,19 @@ const invalidParameterError = function (name, expected, actual) {
);
};
/**
* Ensures an Error from C++ contains a JS stack.
*
* @param {Error} native - Error with message from C++.
* @param {Error} context - Error with stack from JS.
* @returns {Error} Error with message and stack.
* @private
*/
const nativeError = function (native, context) {
context.message = native.message;
return context;
};
module.exports = {
defined,
object,
@@ -151,5 +164,6 @@ module.exports = {
integer,
inRange,
inArray,
invalidParameterError
invalidParameterError,
nativeError
};

View File

@@ -48,7 +48,7 @@ const buildPlatformArch = () => {
const buildSharpLibvipsIncludeDir = () => {
try {
return require('@sharpen/sharp-libvips-dev/include');
return require('@img/sharp-libvips-dev/include');
} catch {}
/* istanbul ignore next */
return '';
@@ -56,7 +56,7 @@ const buildSharpLibvipsIncludeDir = () => {
const buildSharpLibvipsCPlusPlusDir = () => {
try {
return require('@sharpen/sharp-libvips-dev/cplusplus');
return require('@img/sharp-libvips-dev/cplusplus');
} catch {}
/* istanbul ignore next */
return '';
@@ -64,7 +64,7 @@ const buildSharpLibvipsCPlusPlusDir = () => {
const buildSharpLibvipsLibDir = () => {
try {
return require(`@sharpen/sharp-libvips-${buildPlatformArch()}/lib`);
return require(`@img/sharp-libvips-${buildPlatformArch()}/lib`);
} catch {}
/* istanbul ignore next */
return '';

View File

@@ -86,7 +86,8 @@ function toFile (fileOut, callback) {
}
} else {
this.options.fileOut = fileOut;
return this._pipeline(callback);
const stack = Error();
return this._pipeline(callback, stack);
}
return this;
}
@@ -157,7 +158,8 @@ function toBuffer (options, callback) {
this.options.resolveWithObject = false;
}
this.options.fileOut = '';
return this._pipeline(is.fn(options) ? options : callback);
const stack = Error();
return this._pipeline(is.fn(options) ? options : callback, stack);
}
/**
@@ -1282,7 +1284,8 @@ function _read () {
/* istanbul ignore else */
if (!this.options.streamOut) {
this.options.streamOut = true;
this._pipeline();
const stack = Error();
this._pipeline(undefined, stack);
}
}
@@ -1291,18 +1294,30 @@ function _read () {
* Supports callback, stream and promise variants
* @private
*/
function _pipeline (callback) {
function _pipeline (callback, stack) {
if (typeof callback === 'function') {
// output=file/buffer
if (this._isStreamInput()) {
// output=file/buffer, input=stream
this.on('finish', () => {
this._flattenBufferIn();
sharp.pipeline(this.options, callback);
sharp.pipeline(this.options, (err, data, info) => {
if (err) {
callback(is.nativeError(err, stack));
} else {
callback(null, data, info);
}
});
});
} else {
// output=file/buffer, input=file/buffer
sharp.pipeline(this.options, callback);
sharp.pipeline(this.options, (err, data, info) => {
if (err) {
callback(is.nativeError(err, stack));
} else {
callback(null, data, info);
}
});
}
return this;
} else if (this.options.streamOut) {
@@ -1313,7 +1328,7 @@ function _pipeline (callback) {
this._flattenBufferIn();
sharp.pipeline(this.options, (err, data, info) => {
if (err) {
this.emit('error', err);
this.emit('error', is.nativeError(err, stack));
} else {
this.emit('info', info);
this.push(data);
@@ -1329,7 +1344,7 @@ function _pipeline (callback) {
// output=stream, input=file/buffer
sharp.pipeline(this.options, (err, data, info) => {
if (err) {
this.emit('error', err);
this.emit('error', is.nativeError(err, stack));
} else {
this.emit('info', info);
this.push(data);
@@ -1348,7 +1363,7 @@ function _pipeline (callback) {
this._flattenBufferIn();
sharp.pipeline(this.options, (err, data, info) => {
if (err) {
reject(err);
reject(is.nativeError(err, stack));
} else {
if (this.options.resolveWithObject) {
resolve({ data, info });
@@ -1364,7 +1379,7 @@ function _pipeline (callback) {
return new Promise((resolve, reject) => {
sharp.pipeline(this.options, (err, data, info) => {
if (err) {
reject(err);
reject(is.nativeError(err, stack));
} else {
if (this.options.resolveWithObject) {
resolve({ data, info });

View File

@@ -18,7 +18,7 @@ try {
} catch (errLocal) {
try {
// Check for runtime package
module.exports = require(`@sharpen/sharp-${runtimePlatform}/sharp.node`);
module.exports = require(`@img/sharp-${runtimePlatform}/sharp.node`);
} catch (errPackage) {
const help = ['Could not load the "sharp" module at runtime'];
if (errLocal.code !== 'MODULE_NOT_FOUND') {
@@ -30,20 +30,19 @@ try {
help.push('Possible solutions:');
// Common error messages
if (prebuiltPlatforms.includes(runtimePlatform)) {
help.push('- Add explicit dependencies for the runtime platform:');
help.push(` npm install --force @sharpen/sharp-${runtimePlatform}`);
if (!isWindows) {
help.push(` npm install --force @sharpen/sharp-libvips-${runtimePlatform}`);
}
help.push('- Add an explicit dependency for the runtime platform:');
help.push(` npm install --force @img/sharp-${runtimePlatform}`);
} else {
help.push(`- The ${runtimePlatform} platform requires manual installation of libvips >= ${minimumLibvipsVersion}`);
}
if (isLinux && /symbol not found/i.test(errPackage)) {
try {
const { engines } = require(`@sharpen/sharp-libvips-${runtimePlatform}/package`);
const { engines } = require(`@img/sharp-libvips-${runtimePlatform}/package`);
const libcFound = `${familySync()} ${versionSync()}`;
const libcRequires = `${engines.musl ? 'musl' : 'glibc'} ${engines.musl || engines.glibc}`;
help.push(`- Update your OS: found ${libcFound}, requires ${libcRequires}`);
help.push('- Update your OS:');
help.push(` Found ${libcFound}`);
help.push(` Requires ${libcRequires}`);
} catch (errEngines) {}
}
if (isMacOs && /Incompatible library version/.test(errLocal.message)) {
@@ -53,6 +52,10 @@ try {
if (errPackage.code === 'ERR_DLOPEN_DISABLED') {
help.push('- Run Node.js without using the --no-addons flag');
}
if (process.versions.pnp) {
help.push('- Use a supported yarn linker, either pnpm or node-modules:');
help.push(' yarn config set nodeLinker node-modules');
}
// Link to installation docs
if (isLinux && /Module did not self-register/.test(errLocal.message + errPackage.message)) {
help.push('- Using worker threads on Linux? See https://sharp.pixelplumbing.com/install#worker-threads');

View File

@@ -10,6 +10,9 @@ const is = require('./is');
const { runtimePlatformArch } = require('./libvips');
const sharp = require('./sharp');
const runtimePlatform = runtimePlatformArch();
const libvipsVersion = sharp.libvipsVersion();
/**
* An Object containing nested boolean values representing the available input and output formats/methods.
* @member
@@ -44,20 +47,25 @@ const interpolators = {
};
/**
* An Object containing the version numbers of sharp, libvips and its dependencies.
* An Object containing the version numbers of sharp, libvips
* and (when using prebuilt binaries) its dependencies.
*
* @member
* @example
* console.log(sharp.versions);
*/
let versions = {
vips: sharp.libvipsVersion()
vips: libvipsVersion.semver
};
try {
versions = require(`@sharpen/sharp-${runtimePlatformArch()}/versions`);
} catch (_) {
/* istanbul ignore next */
if (!libvipsVersion.isGlobal) {
try {
versions = require(`@sharpen/sharp-libvips-${runtimePlatformArch()}/versions`);
} catch (_) {}
versions = require(`@img/sharp-${runtimePlatform}/versions`);
} catch (_) {
try {
versions = require(`@img/sharp-libvips-${runtimePlatform}/versions`);
} catch (_) {}
}
}
versions.sharp = require('../package.json').version;

View File

@@ -1,7 +1,8 @@
{
"name": "@sharpen/sharp-darwin-arm64",
"version": "0.0.1-alpha.6",
"name": "@img/sharp-darwin-arm64",
"version": "0.33.0-alpha.9",
"description": "Prebuilt sharp for use with macOS ARM64",
"author": "Lovell Fuller <npm@lovell.info>",
"homepage": "https://sharp.pixelplumbing.com",
"repository": {
"type": "git",
@@ -13,6 +14,9 @@
"url": "https://opencollective.com/libvips"
},
"preferUnplugged": true,
"optionalDependencies": {
"@img/sharp-libvips-darwin-arm64": "0.0.1"
},
"files": [
"lib"
],

View File

@@ -1,7 +1,8 @@
{
"name": "@sharpen/sharp-darwin-x64",
"version": "0.0.1-alpha.6",
"name": "@img/sharp-darwin-x64",
"version": "0.33.0-alpha.9",
"description": "Prebuilt sharp for use with macOS x64",
"author": "Lovell Fuller <npm@lovell.info>",
"homepage": "https://sharp.pixelplumbing.com",
"repository": {
"type": "git",
@@ -13,6 +14,9 @@
"url": "https://opencollective.com/libvips"
},
"preferUnplugged": true,
"optionalDependencies": {
"@img/sharp-libvips-darwin-x64": "0.0.1"
},
"files": [
"lib"
],

View File

@@ -5,7 +5,7 @@
// Populate contents of all packages with the current GitHub release
const { writeFile, copyFile, rm } = require('node:fs/promises');
const { readFile, writeFile, appendFile, copyFile, rm } = require('node:fs/promises');
const path = require('node:path');
const { Readable } = require('node:stream');
const { pipeline } = require('node:stream/promises');
@@ -60,11 +60,12 @@ workspaces.map(async platform => {
await copyFile(path.join(__dirname, '..', 'LICENSE'), path.join(dir, 'LICENSE'));
// Copy Windows-specific files
if (platform.startsWith('win32-')) {
const sharpLibvipsDir = path.join(require(`@sharpen/sharp-libvips-${platform}/lib`), '..');
await Promise.all(
['versions.json', 'THIRD-PARTY-NOTICES.md'].map(
filename => copyFile(path.join(sharpLibvipsDir, filename), path.join(dir, filename))
)
);
const sharpLibvipsDir = path.join(require(`@img/sharp-libvips-${platform}/lib`), '..');
// Copy versions.json
await copyFile(path.join(sharpLibvipsDir, 'versions.json'), path.join(dir, 'versions.json'));
// Append third party licensing to README
const readme = await readFile(path.join(sharpLibvipsDir, 'README.md'), { encoding: 'utf-8' });
const thirdParty = readme.substring(readme.indexOf('\nThis software contains'));
appendFile(path.join(dir, 'README.md'), thirdParty);
}
});

View File

@@ -1,7 +1,8 @@
{
"name": "@sharpen/sharp-linux-arm",
"version": "0.0.1-alpha.6",
"name": "@img/sharp-linux-arm",
"version": "0.33.0-alpha.9",
"description": "Prebuilt sharp for use with Linux (glibc) ARM (32-bit)",
"author": "Lovell Fuller <npm@lovell.info>",
"homepage": "https://sharp.pixelplumbing.com",
"repository": {
"type": "git",
@@ -13,6 +14,9 @@
"url": "https://opencollective.com/libvips"
},
"preferUnplugged": true,
"optionalDependencies": {
"@img/sharp-libvips-linux-arm": "0.0.1"
},
"files": [
"lib"
],

View File

@@ -1,7 +1,8 @@
{
"name": "@sharpen/sharp-linux-arm64",
"version": "0.0.1-alpha.6",
"name": "@img/sharp-linux-arm64",
"version": "0.33.0-alpha.9",
"description": "Prebuilt sharp for use with Linux (glibc) ARM64",
"author": "Lovell Fuller <npm@lovell.info>",
"homepage": "https://sharp.pixelplumbing.com",
"repository": {
"type": "git",
@@ -13,6 +14,9 @@
"url": "https://opencollective.com/libvips"
},
"preferUnplugged": true,
"optionalDependencies": {
"@img/sharp-libvips-linux-arm64": "0.0.1"
},
"files": [
"lib"
],

View File

@@ -1,7 +1,8 @@
{
"name": "@sharpen/sharp-linux-x64",
"version": "0.0.1-alpha.6",
"name": "@img/sharp-linux-x64",
"version": "0.33.0-alpha.9",
"description": "Prebuilt sharp for use with Linux (glibc) x64",
"author": "Lovell Fuller <npm@lovell.info>",
"homepage": "https://sharp.pixelplumbing.com",
"repository": {
"type": "git",
@@ -13,6 +14,9 @@
"url": "https://opencollective.com/libvips"
},
"preferUnplugged": true,
"optionalDependencies": {
"@img/sharp-libvips-linux-x64": "0.0.1"
},
"files": [
"lib"
],

View File

@@ -1,7 +1,8 @@
{
"name": "@sharpen/sharp-linuxmusl-arm64",
"version": "0.0.1-alpha.6",
"name": "@img/sharp-linuxmusl-arm64",
"version": "0.33.0-alpha.9",
"description": "Prebuilt sharp for use with Linux (musl) ARM64",
"author": "Lovell Fuller <npm@lovell.info>",
"homepage": "https://sharp.pixelplumbing.com",
"repository": {
"type": "git",
@@ -13,6 +14,9 @@
"url": "https://opencollective.com/libvips"
},
"preferUnplugged": true,
"optionalDependencies": {
"@img/sharp-libvips-linuxmusl-arm64": "0.0.1"
},
"files": [
"lib"
],

View File

@@ -1,7 +1,8 @@
{
"name": "@sharpen/sharp-linuxmusl-x64",
"version": "0.0.1-alpha.6",
"name": "@img/sharp-linuxmusl-x64",
"version": "0.33.0-alpha.9",
"description": "Prebuilt sharp for use with Linux (musl) x64",
"author": "Lovell Fuller <npm@lovell.info>",
"homepage": "https://sharp.pixelplumbing.com",
"repository": {
"type": "git",
@@ -13,6 +14,9 @@
"url": "https://opencollective.com/libvips"
},
"preferUnplugged": true,
"optionalDependencies": {
"@img/sharp-libvips-linuxmusl-x64": "0.0.1"
},
"files": [
"lib"
],

View File

@@ -1,6 +1,6 @@
{
"name": "@sharpen/sharp",
"version": "0.0.1-alpha.1",
"name": "@img/sharp",
"version": "0.33.0-alpha.9",
"private": "true",
"workspaces": [
"darwin-x64",

View File

@@ -1,7 +1,8 @@
{
"name": "@sharpen/sharp-win32-ia32",
"version": "0.0.1-alpha.6",
"name": "@img/sharp-win32-ia32",
"version": "0.33.0-alpha.9",
"description": "Prebuilt sharp for use with Windows x86 (32-bit)",
"author": "Lovell Fuller <npm@lovell.info>",
"homepage": "https://sharp.pixelplumbing.com",
"repository": {
"type": "git",
@@ -15,8 +16,7 @@
"preferUnplugged": true,
"files": [
"lib",
"versions.json",
"THIRD-PARTY-NOTICES.md"
"versions.json"
],
"publishConfig": {
"access": "public"

View File

@@ -1,7 +1,8 @@
{
"name": "@sharpen/sharp-win32-x64",
"version": "0.0.1-alpha.6",
"name": "@img/sharp-win32-x64",
"version": "0.33.0-alpha.9",
"description": "Prebuilt sharp for use with Windows x64",
"author": "Lovell Fuller <npm@lovell.info>",
"homepage": "https://sharp.pixelplumbing.com",
"repository": {
"type": "git",
@@ -15,8 +16,7 @@
"preferUnplugged": true,
"files": [
"lib",
"versions.json",
"THIRD-PARTY-NOTICES.md"
"versions.json"
],
"publishConfig": {
"access": "public"
@@ -24,7 +24,8 @@
"type": "commonjs",
"exports": {
"./sharp.node": "./lib/sharp-win32-x64.node",
"./package": "./package.json"
"./package": "./package.json",
"./versions": "./versions.json"
},
"engines": {
"node": "^18.17.0 || ^20.3.0 || >=21.0.0",

View File

@@ -1,7 +1,7 @@
{
"name": "sharp",
"description": "High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP, GIF, AVIF and TIFF images",
"version": "0.33.0-alpha.6",
"version": "0.33.0-alpha.9",
"author": "Lovell Fuller <npm@lovell.info>",
"homepage": "https://github.com/lovell/sharp",
"contributors": [
@@ -139,27 +139,27 @@
"semver": "^7.5.4"
},
"optionalDependencies": {
"@sharpen/sharp-darwin-arm64": "0.0.1-alpha.6",
"@sharpen/sharp-darwin-x64": "0.0.1-alpha.6",
"@sharpen/sharp-libvips-darwin-arm64": "0.0.1-alpha.2",
"@sharpen/sharp-libvips-darwin-x64": "0.0.1-alpha.2",
"@sharpen/sharp-libvips-linux-arm": "0.0.1-alpha.2",
"@sharpen/sharp-libvips-linux-arm64": "0.0.1-alpha.2",
"@sharpen/sharp-libvips-linux-x64": "0.0.1-alpha.2",
"@sharpen/sharp-libvips-linuxmusl-arm64": "0.0.1-alpha.2",
"@sharpen/sharp-libvips-linuxmusl-x64": "0.0.1-alpha.2",
"@sharpen/sharp-linux-arm": "0.0.1-alpha.6",
"@sharpen/sharp-linux-arm64": "0.0.1-alpha.6",
"@sharpen/sharp-linux-x64": "0.0.1-alpha.6",
"@sharpen/sharp-linuxmusl-arm64": "0.0.1-alpha.6",
"@sharpen/sharp-linuxmusl-x64": "0.0.1-alpha.6",
"@sharpen/sharp-win32-ia32": "0.0.1-alpha.6",
"@sharpen/sharp-win32-x64": "0.0.1-alpha.6"
"@img/sharp-darwin-arm64": "0.33.0-alpha.9",
"@img/sharp-darwin-x64": "0.33.0-alpha.9",
"@img/sharp-libvips-darwin-arm64": "0.0.1",
"@img/sharp-libvips-darwin-x64": "0.0.1",
"@img/sharp-libvips-linux-arm": "0.0.1",
"@img/sharp-libvips-linux-arm64": "0.0.1",
"@img/sharp-libvips-linux-x64": "0.0.1",
"@img/sharp-libvips-linuxmusl-arm64": "0.0.1",
"@img/sharp-libvips-linuxmusl-x64": "0.0.1",
"@img/sharp-linux-arm": "0.33.0-alpha.9",
"@img/sharp-linux-arm64": "0.33.0-alpha.9",
"@img/sharp-linux-x64": "0.33.0-alpha.9",
"@img/sharp-linuxmusl-arm64": "0.33.0-alpha.9",
"@img/sharp-linuxmusl-x64": "0.33.0-alpha.9",
"@img/sharp-win32-ia32": "0.33.0-alpha.9",
"@img/sharp-win32-x64": "0.33.0-alpha.9"
},
"devDependencies": {
"@sharpen/sharp-libvips-dev": "0.0.1-alpha.2",
"@sharpen/sharp-libvips-win32-ia32": "0.0.1-alpha.2",
"@sharpen/sharp-libvips-win32-x64": "0.0.1-alpha.2",
"@img/sharp-libvips-dev": "0.0.1",
"@img/sharp-libvips-win32-ia32": "0.0.1",
"@img/sharp-libvips-win32-x64": "0.0.1",
"@types/node": "*",
"async": "^3.2.4",
"cc": "^3.0.1",

View File

@@ -111,6 +111,9 @@
# Use pkg-config for include and lib
'include_dirs': ['<!@(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --cflags-only-I vips-cpp vips glib-2.0 | sed s\/-I//g)'],
'libraries': ['<!@(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --libs vips-cpp)'],
'defines': [
'SHARP_USE_GLOBAL_LIBVIPS'
],
'conditions': [
['OS == "linux"', {
'defines': [
@@ -154,7 +157,8 @@
'OTHER_LDFLAGS': [
# Ensure runtime linking is relative to sharp.node
'-Wl,-rpath,\'@loader_path/../../sharp-libvips-<(platform_and_arch)/lib\'',
'-Wl,-rpath,\'@loader_path/../../../node_modules/@sharpen/sharp-libvips-<(platform_and_arch)/lib\''
'-Wl,-rpath,\'@loader_path/../../node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\'',
'-Wl,-rpath,\'@loader_path/../../../node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\''
]
}
}],
@@ -174,7 +178,8 @@
'-Wl,-s',
'-Wl,--disable-new-dtags',
'-Wl,-rpath=\'$$ORIGIN/../../sharp-libvips-<(platform_and_arch)/lib\'',
'-Wl,-rpath=\'$$ORIGIN/../../../node_modules/@sharpen/sharp-libvips-<(platform_and_arch)/lib\''
'-Wl,-rpath=\'$$ORIGIN/../../node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\'',
'-Wl,-rpath=\'$$ORIGIN/../../../node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\''
]
}
}]

View File

@@ -3,6 +3,7 @@
#include <cmath>
#include <string>
#include <cstdio>
#include <napi.h>
#include <vips/vips8>
@@ -91,9 +92,18 @@ Napi::Value simd(const Napi::CallbackInfo& info) {
Get libvips version
*/
Napi::Value libvipsVersion(const Napi::CallbackInfo& info) {
char version[9];
g_snprintf(version, sizeof(version), "%d.%d.%d", vips_version(0), vips_version(1), vips_version(2));
return Napi::String::New(info.Env(), version);
Napi::Env env = info.Env();
Napi::Object version = Napi::Object::New(env);
char semver[9];
std::snprintf(semver, sizeof(semver), "%d.%d.%d", vips_version(0), vips_version(1), vips_version(2));
version.Set("semver", Napi::String::New(env, semver));
#ifdef SHARP_USE_GLOBAL_LIBVIPS
version.Set("isGlobal", Napi::Boolean::New(env, true));
#else
version.Set("isGlobal", Napi::Boolean::New(env, false));
#endif
return version;
}
/*

View File

@@ -659,3 +659,6 @@ sharp('input.tiff').webp({ preset: 'drawing' }).toFile('out.webp');
sharp('input.tiff').webp({ preset: 'text' }).toFile('out.webp');
sharp('input.tiff').webp({ preset: 'default' }).toFile('out.webp');
// Allow a boolean or an object for metadata options.
// https://github.com/lovell/sharp/issues/3822
sharp(input).withMetadata().withMetadata({}).withMetadata(false);

View File

@@ -459,27 +459,29 @@ describe('Input/output', function () {
});
});
it('Fail when input is invalid Buffer', function (done) {
sharp(Buffer.from([0x1, 0x2, 0x3, 0x4])).toBuffer().then(function () {
assert(false);
done();
}).catch(function (err) {
assert(err instanceof Error);
assert.strictEqual('Input buffer contains unsupported image format', err.message);
done();
});
});
it('Fail when input is invalid Buffer', async () =>
assert.rejects(
() => sharp(Buffer.from([0x1, 0x2, 0x3, 0x4])).toBuffer(),
(err) => {
assert.strictEqual(err.message, 'Input buffer contains unsupported image format');
assert(err.stack.includes('at Sharp.toBuffer'));
assert(err.stack.includes(__filename));
return true;
}
)
);
it('Fail when input file path is missing', function (done) {
sharp('does-not-exist').toBuffer().then(function () {
assert(false);
done();
}).catch(function (err) {
assert(err instanceof Error);
assert.strictEqual('Input file is missing: does-not-exist', err.message);
done();
});
});
it('Fail when input file path is missing', async () =>
assert.rejects(
() => sharp('does-not-exist').toFile('fail'),
(err) => {
assert.strictEqual(err.message, 'Input file is missing: does-not-exist');
assert(err.stack.includes('at Sharp.toFile'));
assert(err.stack.includes(__filename));
return true;
}
)
);
describe('Fail for unsupported input', function () {
it('Undefined', function () {

View File

@@ -395,13 +395,27 @@ describe('Image metadata', function () {
});
});
it('Non-existent file in, Promise out', function (done) {
sharp('fail').metadata().then(function (metadata) {
throw new Error('Non-existent file');
}, function (err) {
assert.ok(!!err);
done();
});
it('Non-existent file in, Promise out', async () =>
assert.rejects(
() => sharp('fail').metadata(),
(err) => {
assert.strictEqual(err.message, 'Input file is missing: fail');
assert(err.stack.includes('at Sharp.metadata'));
assert(err.stack.includes(__filename));
return true;
}
)
);
it('Invalid stream in, callback out', (done) => {
fs.createReadStream(__filename).pipe(
sharp().metadata((err) => {
assert.strictEqual(err.message, 'Input buffer contains unsupported image format');
assert(err.stack.includes('at Sharp.metadata'));
assert(err.stack.includes(__filename));
done();
})
);
});
it('Stream in, Promise out', function (done) {

View File

@@ -690,11 +690,25 @@ describe('Image Stats', function () {
it('File input with corrupt header fails gracefully', function (done) {
sharp(fixtures.inputJpgWithCorruptHeader)
.stats(function (err) {
assert.strictEqual(true, !!err);
assert(err.message.includes('Input file has corrupt header'));
assert(err.stack.includes('at Sharp.stats'));
assert(err.stack.includes(__filename));
done();
});
});
it('Stream input with corrupt header fails gracefully', function (done) {
fs.createReadStream(fixtures.inputJpgWithCorruptHeader).pipe(
sharp()
.stats(function (err) {
assert(err.message.includes('Input buffer has corrupt header'));
assert(err.stack.includes('at Sharp.stats'));
assert(err.stack.includes(__filename));
done();
})
);
});
it('File input with corrupt header fails gracefully, Promise out', function () {
return sharp(fixtures.inputJpgWithCorruptHeader)
.stats().then(function (stats) {