@atlaspack/transformer-image 3.1.5-canary.36 → 3.1.5-canary.361

package/dist/validateConfig.js

@@ -0,0 +1,247 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateConfig = validateConfig;
+const utils_1 = require("@atlaspack/utils");
+// https://sharp.pixelplumbing.com/api-output#jpeg
+const JPEG_OUTPUT_SCHEMA = {
+    type: 'object',
+    properties: {
+        quality: {
+            type: 'number',
+        },
+        progressive: {
+            type: 'boolean',
+        },
+        chromaSubsampling: {
+            type: 'string',
+        },
+        optimiseCoding: {
+            type: 'boolean',
+        },
+        optimizeCoding: {
+            type: 'boolean',
+        },
+        mozjpeg: {
+            type: 'boolean',
+        },
+        trellisQuantisation: {
+            type: 'boolean',
+        },
+        overshootDeringing: {
+            type: 'boolean',
+        },
+        optimiseScans: {
+            type: 'boolean',
+        },
+        optimizeScans: {
+            type: 'boolean',
+        },
+        quantisationTable: {
+            type: 'number',
+        },
+        quantizationTable: {
+            type: 'number',
+        },
+        force: {
+            type: 'boolean',
+        },
+    },
+    additionalProperties: true,
+};
+// https://sharp.pixelplumbing.com/api-output#png
+const PNG_OUTPUT_SCHEMA = {
+    type: 'object',
+    properties: {
+        quality: {
+            type: 'number',
+        },
+        progressive: {
+            type: 'boolean',
+        },
+        compressionLevel: {
+            type: 'number',
+        },
+        adaptiveFiltering: {
+            type: 'boolean',
+        },
+        palette: {
+            type: 'boolean',
+        },
+        colours: {
+            type: 'number',
+        },
+        colors: {
+            type: 'number',
+        },
+        dither: {
+            type: 'number',
+        },
+        force: {
+            type: 'boolean',
+        },
+    },
+    additionalProperties: true,
+};
+// https://sharp.pixelplumbing.com/api-output#webp
+const WEBP_OUTPUT_SCHEMA = {
+    type: 'object',
+    properties: {
+        quality: {
+            type: 'number',
+        },
+        alphaQuality: {
+            type: 'number',
+        },
+        lossless: {
+            type: 'boolean',
+        },
+        nearLossless: {
+            type: 'boolean',
+        },
+        smartSubsample: {
+            type: 'boolean',
+        },
+        reductionEffort: {
+            type: 'number',
+        },
+        pageHeight: {
+            type: 'number',
+        },
+        loop: {
+            type: 'number',
+        },
+        delay: {
+            type: 'array',
+            items: {
+                type: 'number',
+            },
+        },
+        force: {
+            type: 'boolean',
+        },
+    },
+    additionalProperties: true,
+};
+// https://sharp.pixelplumbing.com/api-output#gif
+const GIF_OUTPUT_SCHEMA = {
+    type: 'object',
+    properties: {
+        pageHeight: {
+            type: 'number',
+        },
+        loop: {
+            type: 'number',
+        },
+        delay: {
+            type: 'array',
+            items: {
+                type: 'number',
+            },
+        },
+        force: {
+            type: 'boolean',
+        },
+    },
+    additionalProperties: true,
+};
+// https://sharp.pixelplumbing.com/api-output#tiff
+const TIFF_OUTPUT_SCHEMA = {
+    type: 'object',
+    properties: {
+        quality: {
+            type: 'number',
+        },
+        force: {
+            type: 'boolean',
+        },
+        compression: {
+            type: 'string',
+        },
+        predictor: {
+            type: 'string',
+        },
+        pyramid: {
+            type: 'boolean',
+        },
+        tile: {
+            type: 'boolean',
+        },
+        tileWidth: {
+            type: 'number',
+        },
+        tileHeight: {
+            type: 'number',
+        },
+        xres: {
+            type: 'number',
+        },
+        yres: {
+            type: 'number',
+        },
+        bitdepth: {
+            type: 'number',
+        },
+    },
+    additionalProperties: true,
+};
+// https://sharp.pixelplumbing.com/api-output#avif
+const AVIF_OUTPUT_SCHEMA = {
+    type: 'object',
+    properties: {
+        quality: {
+            type: 'number',
+        },
+        lossless: {
+            type: 'boolean',
+        },
+        speed: {
+            type: 'number',
+        },
+        chromaSubsampling: {
+            type: 'string',
+        },
+    },
+    additionalProperties: true,
+};
+// https://sharp.pixelplumbing.com/api-output#heif
+const HEIF_OUTPUT_SCHEMA = {
+    type: 'object',
+    properties: {
+        quality: {
+            type: 'number',
+        },
+        compression: {
+            type: 'string',
+        },
+        lossless: {
+            type: 'boolean',
+        },
+        speed: {
+            type: 'number',
+        },
+        chromaSubsampling: {
+            type: 'string',
+        },
+    },
+    additionalProperties: true,
+};
+const CONFIG_SCHEMA = {
+    type: 'object',
+    properties: {
+        // Fallback quality
+        quality: {
+            type: 'number',
+        },
+        jpeg: JPEG_OUTPUT_SCHEMA,
+        png: PNG_OUTPUT_SCHEMA,
+        webp: WEBP_OUTPUT_SCHEMA,
+        gif: GIF_OUTPUT_SCHEMA,
+        tiff: TIFF_OUTPUT_SCHEMA,
+        avif: AVIF_OUTPUT_SCHEMA,
+        heif: HEIF_OUTPUT_SCHEMA,
+    },
+    additionalProperties: false,
+};
+function validateConfig(data, filePath) {
+    utils_1.validateSchema.diagnostic(CONFIG_SCHEMA, { data, filePath }, '@atlaspack/transformer-image', 'Invalid sharp config');
+}

package/lib/ImageTransformer.js

@@ -28,6 +28,8 @@ function _workers() {
 }
 var _loadSharp = _interopRequireDefault(require("./loadSharp"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// @ts-expect-error TS1192
+
 // from https://github.com/lovell/sharp/blob/df7b8ba73808fc494be413e88cfb621b6279218c/lib/output.js#L6-L17
 const FORMATS = new Map([['jpeg', 'jpeg'], ['jpg', 'jpeg'], ['png', 'png'], ['webp', 'webp'], ['gif', 'gif'], ['tiff', 'tiff'], ['avif', 'avif'], ['heic', 'heif'], ['heif', 'heif']]);
 let isSharpLoadedOnMainThread = false;
@@ -58,9 +60,15 @@ var _default = exports.default = new (_plugin().Transformer)({
     if (!originalFormat) {
       throw new Error(`The image transformer does not support ${asset.type} images.`);
     }
-    const width = asset.query.has('width') ? parseInt(asset.query.get('width'), 10) : null;
-    const height = asset.query.has('height') ? parseInt(asset.query.get('height'), 10) : null;
-    const quality = asset.query.has('quality') ? parseInt(asset.query.get('quality'), 10) : config.quality;
+    const width = asset.query.has('width') ?
+    // @ts-expect-error TS2345
+    parseInt(asset.query.get('width'), 10) : null;
+    const height = asset.query.has('height') ?
+    // @ts-expect-error TS2345
+    parseInt(asset.query.get('height'), 10) : null;
+    const quality = asset.query.has('quality') ?
+    // @ts-expect-error TS2345
+    parseInt(asset.query.get('quality'), 10) : config.quality;
     let targetFormat = (_asset$query$get = asset.query.get('as')) === null || _asset$query$get === void 0 ? void 0 : _asset$query$get.toLowerCase().trim();
     if (targetFormat && !FORMATS.has(targetFormat)) {
       throw new Error(`The image transformer does not support ${targetFormat} images.`);

package/lib/types/ImageTransformer.d.ts

@@ -0,0 +1,3 @@
+import { Transformer } from '@atlaspack/plugin';
+declare const _default: Transformer<unknown>;
+export default _default;

package/lib/types/loadSharp.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/validateConfig.d.ts

@@ -0,0 +1 @@
+export declare function validateConfig(data: any, filePath: string): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaspack/transformer-image",
-  "version": "3.1.5-canary.36+2d10c6656",
+  "version": "3.1.5-canary.361+405bbaf61",
   "license": "(MIT OR Apache-2.0)",
   "publishConfig": {
     "access": "public"
@@ -9,23 +9,27 @@
     "type": "git",
     "url": "https://github.com/atlassian-labs/atlaspack.git"
   },
-  "main": "lib/ImageTransformer.js",
-  "source": "src/ImageTransformer.js",
+  "main": "./lib/ImageTransformer.js",
+  "source": "./src/ImageTransformer.ts",
+  "types": "./lib/types/ImageTransformer.d.ts",
   "engines": {
     "node": ">= 16.0.0"
   },
   "dependencies": {
-    "@atlaspack/plugin": "2.14.5-canary.36+2d10c6656",
-    "@atlaspack/utils": "2.14.5-canary.36+2d10c6656",
-    "@atlaspack/workers": "2.14.5-canary.36+2d10c6656",
+    "@atlaspack/plugin": "2.14.5-canary.361+405bbaf61",
+    "@atlaspack/utils": "2.14.5-canary.361+405bbaf61",
+    "@atlaspack/workers": "2.14.5-canary.361+405bbaf61",
     "nullthrows": "^1.1.1"
   },
   "devDependencies": {
     "sharp": "^0.31.1"
   },
   "peerDependencies": {
-    "@atlaspack/core": "^2.13.1"
+    "@atlaspack/core": "2.31.3"
   },
   "type": "commonjs",
-  "gitHead": "2d10c6656fc58743c5dbed1d2b6c5666887f9fe4"
-}
+  "scripts": {
+    "build:lib": "gulp build --gulpfile ../../../gulpfile.js --cwd ."
+  },
+  "gitHead": "405bbaf619f634cf9e58cc618d9a911f7db2998d"
+}

package/src/{ImageTransformer.js → ImageTransformer.ts}

@@ -1,8 +1,8 @@
-// @flow
 import {validateConfig} from './validateConfig';
 import {Transformer} from '@atlaspack/plugin';
 import nullthrows from 'nullthrows';
 import WorkerFarm from '@atlaspack/workers';
+// @ts-expect-error TS1192
 import loadSharp from './loadSharp';
 
 // from https://github.com/lovell/sharp/blob/df7b8ba73808fc494be413e88cfb621b6279218c/lib/output.js#L6-L17
@@ -20,7 +20,7 @@ const FORMATS = new Map([
 
 let isSharpLoadedOnMainThread = false;
 
-export default (new Transformer({
+export default new Transformer({
   async loadConfig({config}) {
     let configFile: any = await config.getConfig(
       ['sharp.config.json'], // '.sharprc', '.sharprc.json'
@@ -46,13 +46,16 @@ export default (new Transformer({
     }
 
     const width = asset.query.has('width')
-      ? parseInt(asset.query.get('width'), 10)
+      ? // @ts-expect-error TS2345
+        parseInt(asset.query.get('width'), 10)
       : null;
     const height = asset.query.has('height')
-      ? parseInt(asset.query.get('height'), 10)
+      ? // @ts-expect-error TS2345
+        parseInt(asset.query.get('height'), 10)
       : null;
     const quality = asset.query.has('quality')
-      ? parseInt(asset.query.get('quality'), 10)
+      ? // @ts-expect-error TS2345
+        parseInt(asset.query.get('quality'), 10)
       : config.quality;
     let targetFormat = asset.query.get('as')?.toLowerCase().trim();
     if (targetFormat && !FORMATS.has(targetFormat)) {
@@ -117,4 +120,4 @@ export default (new Transformer({
 
     return [asset];
   },
-}): Transformer);
+}) as Transformer<unknown>;

package/src/{loadSharp.js → loadSharp.ts}

@@ -1,4 +1,3 @@
-// @flow
 import type {PackageManager} from '@atlaspack/package-manager';
 import type {FilePath} from '@atlaspack/types';
 

package/src/{validateConfig.js → validateConfig.ts}

@@ -1,4 +1,3 @@
-// @flow
 import type {SchemaEntity} from '@atlaspack/utils';
 import {validateSchema} from '@atlaspack/utils';
 

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "include": ["src"],
+  "compilerOptions": {
+    "composite": true
+  },
+  "references": [
+    {
+      "path": "../../core/plugin/tsconfig.json"
+    },
+    {
+      "path": "../../core/utils/tsconfig.json"
+    },
+    {
+      "path": "../../core/workers/tsconfig.json"
+    }
+  ]
+}