v1.0.0

.gitignore

@@ -0,0 +1,106 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+test/exports

.swcrc

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json.schemastore.org/swcrc",
+  "jsc": {
+      "parser": {
+          "syntax": "typescript",
+          "dynamicImport": true,
+          "decorators": true
+      },
+      "transform": {
+          "legacyDecorator": true,
+          "decoratorMetadata": true
+      },
+      "experimental": {
+          "keepImportAssertions": true
+      },
+      "baseUrl": ".",
+      "paths": {},
+      "target": "es2021"
+  },
+  "module": {
+    "type": "es6"
+  },
+  "minify": true
+}

built/index.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import sharp from 'sharp';
+export declare function sharpBmp(source: Buffer | Int8Array | Uint8Array | Uint8ClampedArray | string, type: string, options?: sharp.SharpOptions): Promise<sharp.Sharp>;

built/index.js

@@ -0,0 +1,48 @@
+import sharp from 'sharp';
+import decodeIco from 'decode-ico';
+import decodeBmp from 'decode-bmp';
+import { readFile } from 'node:fs/promises';
+export async function sharpBmp(source, type, options = {}) {
+    if (type === 'image/x-icon' || type === 'image/vnd.microsoft.icon') {
+        const icon = decodeIco(typeof source === 'string' ? await readFile(source, { encoding: null }) : source);
+        // Choose the largest icon
+        const chosen = icon.reduce((prev, curr) => {
+            const prevSize = prev.width * prev.height;
+            const currSize = curr.width * curr.height;
+            if (prevSize < currSize) {
+                // Larger icon
+                return curr;
+            }
+            else if (prevSize === currSize && curr.type === 'png') {
+                // PNG is preferred over BMP
+                return curr;
+            }
+            return prev;
+        }, icon[0]);
+        if (chosen.type === 'png') {
+            return sharp(chosen.data, options);
+        }
+        else {
+            return sharp(chosen.data, {
+                ...options,
+                raw: {
+                    width: chosen.width,
+                    height: chosen.height,
+                    channels: 4,
+                },
+            });
+        }
+    }
+    if (type === 'image/x-bmp' || type === 'image/bmp' || type === 'image/x-ms-bmp') {
+        const bmp = decodeBmp(typeof source === 'string' ? await readFile(source, { encoding: null }) : source);
+        return sharp(bmp.data, {
+            ...options,
+            raw: {
+                width: bmp.width,
+                height: bmp.height,
+                channels: 4,
+            },
+        });
+    }
+    return sharp(source, options);
+}

jest.config.js

@@ -0,0 +1,208 @@
+/*
+* For a detailed explanation regarding each configuration property and type check, visit:
+* https://jestjs.io/docs/en/configuration.html
+*/
+
+export default {
+	// All imported modules in your tests should be mocked automatically
+	// automock: false,
+
+	// Stop running tests after `n` failures
+	// bail: 0,
+
+	// The directory where Jest should store its cached dependency information
+	// cacheDirectory: "C:\\Users\\toastie\\AppData\\Local\\Temp\\jest",
+
+	// Automatically clear mock calls and instances between every test
+	// clearMocks: false,
+
+	// Indicates whether the coverage information should be collected while executing the test
+	// collectCoverage: false,
+
+	// An array of glob patterns indicating a set of files for which coverage information should be collected
+	collectCoverageFrom: ['src/**/*.ts'],
+
+	// The directory where Jest should output its coverage files
+	coverageDirectory: "coverage",
+
+	// An array of regexp pattern strings used to skip coverage collection
+	// coveragePathIgnorePatterns: [
+	//   "\\\\node_modules\\\\"
+	// ],
+
+	// Indicates which provider should be used to instrument code for coverage
+	coverageProvider: "v8",
+
+	// A list of reporter names that Jest uses when writing coverage reports
+	// coverageReporters: [
+	//   "json",
+	//   "text",
+	//   "lcov",
+	//   "clover"
+	// ],
+
+	// An object that configures minimum threshold enforcement for coverage results
+	// coverageThreshold: undefined,
+
+	// A path to a custom dependency extractor
+	// dependencyExtractor: undefined,
+
+	// Make calling deprecated APIs throw helpful error messages
+	// errorOnDeprecated: false,
+
+	// Force coverage collection from ignored files using an array of glob patterns
+	// forceCoverageMatch: [],
+
+	// A path to a module which exports an async function that is triggered once before all test suites
+	// globalSetup: undefined,
+
+	// A path to a module which exports an async function that is triggered once after all test suites
+	// globalTeardown: undefined,
+
+	// A set of global variables that need to be available in all test environments
+	globals: {
+	},
+
+	// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+	// maxWorkers: "50%",
+
+	// An array of directory names to be searched recursively up from the requiring module's location
+	// moduleDirectories: [
+	//   "node_modules"
+	// ],
+
+	// An array of file extensions your modules use
+	// moduleFileExtensions: [
+	//   "js",
+	//   "json",
+	//   "jsx",
+	//   "ts",
+	//   "tsx",
+	//   "node"
+	// ],
+
+	// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+	moduleNameMapper: {
+		// Do not resolve .wasm.js to .wasm by the rule below
+		'^(.+)\\.wasm\\.js$': '$1.wasm.js',
+		// SWC converts @/foo/bar.js to `../../src/foo/bar.js`, and then this rule
+		// converts it again to `../../src/foo/bar` which then can be resolved to
+		// `.ts` files.
+		// See https://github.com/swc-project/jest/issues/64#issuecomment-1029753225
+		// TODO: Use `--allowImportingTsExtensions` on TypeScript 5.0 so that we can
+		// directly import `.ts` files without this hack.
+		'^(\\.{1,2}/.*)\\.js$': '$1',
+	},
+
+	// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+	// modulePathIgnorePatterns: [],
+
+	// Activates notifications for test results
+	// notify: false,
+
+	// An enum that specifies notification mode. Requires { notify: true }
+	// notifyMode: "failure-change",
+
+	// A preset that is used as a base for Jest's configuration
+	//preset: "ts-jest/presets/js-with-ts-esm",
+
+	// Run tests from one or more projects
+	// projects: undefined,
+
+	// Use this configuration option to add custom reporters to Jest
+	// reporters: undefined,
+
+	// Automatically reset mock state between every test
+	// resetMocks: false,
+
+	// Reset the module registry before running each individual test
+	// resetModules: false,
+
+	// A path to a custom resolver
+	// resolver: './jest-resolver.cjs',
+
+	// Automatically restore mock state between every test
+	restoreMocks: true,
+
+	// The root directory that Jest should scan for tests and modules within
+	// rootDir: undefined,
+
+	// A list of paths to directories that Jest should use to search for files in
+	roots: [
+		"<rootDir>"
+	],
+
+	// Allows you to use a custom runner instead of Jest's default test runner
+	// runner: "jest-runner",
+
+	// The paths to modules that run some code to configure or set up the testing environment before each test
+	// setupFiles: [],
+
+	// A list of paths to modules that run some code to configure or set up the testing framework before each test
+	// setupFilesAfterEnv: [],
+
+	// The number of seconds after which a test is considered as slow and reported as such in the results.
+	// slowTestThreshold: 5,
+
+	// A list of paths to snapshot serializer modules Jest should use for snapshot testing
+	// snapshotSerializers: [],
+
+	// The test environment that will be used for testing
+	testEnvironment: "node",
+
+	// Options that will be passed to the testEnvironment
+	// testEnvironmentOptions: {},
+
+	// Adds a location field to test results
+	// testLocationInResults: false,
+
+	// The glob patterns Jest uses to detect test files
+	testMatch: [
+		"<rootDir>/test/index.ts",
+	],
+
+	// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+	// testPathIgnorePatterns: [
+	//   "\\\\node_modules\\\\"
+	// ],
+
+	// The regexp pattern or array of patterns that Jest uses to detect test files
+	// testRegex: [],
+
+	// This option allows the use of a custom results processor
+	// testResultsProcessor: undefined,
+
+	// This option allows use of a custom test runner
+	// testRunner: "jasmine2",
+
+	// This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+	// testURL: "http://localhost",
+
+	// Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+	// timers: "real",
+
+	// A map from regular expressions to paths to transformers
+	transform: {
+		"^.+\\.(t|j)sx?$": ["@swc/jest"],
+	},
+
+	// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+	// transformIgnorePatterns: [
+	//   "\\\\node_modules\\\\",
+	//   "\\.pnp\\.[^\\\\]+$"
+	// ],
+
+	// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+	// unmockedModulePathPatterns: undefined,
+
+	// Indicates whether each individual test should be reported during the run
+	// verbose: undefined,
+
+	// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+	// watchPathIgnorePatterns: [],
+
+	// Whether to use watchman for file crawling
+	// watchman: true,
+
+	extensionsToTreatAsEsm: ['.ts'],
+};

package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@valkyriecoms/sharp-read-bmp",
+  "version": "1.0.0",
+  "description": "",
+  "main": "built/index.js",
+  "types": "built/index.d.ts",
+  "scripts": {
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --silent=false --verbose false",
+    "build": "tsc"
+  },
+  "files": [
+    "built",
+    "LICENSE"
+  ],
+  "type": "module",
+  "keywords": [],
+  "author": "Toastie <toastie@toastiet0ast.com",
+  "license": "MIT",
+  "dependencies": {
+    "decode-bmp": "^0.2.1",
+    "decode-ico": "^0.4.1",
+    "sharp": "^0.31.3"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.4.3",
+    "@swc/core": "^1.3.37",
+    "@swc/jest": "^0.2.24",
+    "@types/node": "^18.14.5",
+    "@types/sharp": "^0.31.1",
+    "file-type": "^18.2.1",
+    "jest": "^29.4.3",
+    "mkdirp": "^2.1.4",
+    "rimraf": "^4.2.0",
+    "typescript": "^4.9.5"
+  },
+  "packageManager": "pnpm@8.15.6+sha512.77b89e9be77a2b06ad8f403a19cae5e22976f61023f98ad323d5c30194958ebc02ee0a6ae5d13ee454f6134e4e8caf29a05f0b1a0e1d2b17bca6b6a1f1159f86"
+}

src/index.ts

@@ -0,0 +1,55 @@
+import sharp from 'sharp';
+import decodeIco from 'decode-ico';
+import decodeBmp from 'decode-bmp';
+import { readFile } from 'node:fs/promises';
+
+export async function sharpBmp(
+    source: Buffer | Int8Array | Uint8Array | Uint8ClampedArray | string,
+    type: string,
+    options: sharp.SharpOptions = {}
+): Promise<sharp.Sharp> {
+    if (type === 'image/x-icon' || type === 'image/vnd.microsoft.icon') {
+        const icon = decodeIco(typeof source === 'string' ? await readFile(source, { encoding: null }) : source);
+
+        // Choose the largest icon
+        const chosen = icon.reduce((prev, curr) => {
+            const prevSize = prev.width * prev.height;
+            const currSize = curr.width * curr.height;
+            if (prevSize < currSize) {
+                // Larger icon
+                return curr;
+            } else if (prevSize === currSize && curr.type === 'png') {
+                // PNG is preferred over BMP
+                return curr;
+            }
+            return prev;
+        }, icon[0]);
+
+        if (chosen.type === 'png') {
+            return sharp(chosen.data, options);
+        } else {
+            return sharp(chosen.data, {
+                ...options,
+                raw: {
+                    width: chosen.width,
+                    height: chosen.height,
+                    channels: 4,
+                },
+            });
+        }
+    }
+
+    if (type === 'image/x-bmp' || type === 'image/bmp' || type === 'image/x-ms-bmp') {
+        const bmp = decodeBmp(typeof source === 'string' ? await readFile(source, { encoding: null }) : source);
+        return sharp(bmp.data, {
+            ...options,
+            raw: {
+                width: bmp.width,
+                height: bmp.height,
+                channels: 4,
+            },
+        });
+    }
+
+    return sharp(source, options);
+}

test/index.ts

@@ -0,0 +1,54 @@
+import { sharpBmp } from '../src';
+import { fileTypeFromFile, fileTypeFromBuffer } from 'file-type';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { readFile } from 'node:fs/promises';
+import {expect, jest, test, describe} from '@jest/globals';
+import { rimraf } from 'rimraf';
+import { mkdirp } from 'mkdirp';
+
+const _filename = fileURLToPath(import.meta.url);
+const _dirname = dirname(_filename);
+
+await rimraf(resolve(_dirname, 'exports'));
+await mkdirp(resolve(_dirname, 'exports'));
+
+const favicon = resolve(_dirname, 'favicon.ico');
+const faviconPng = resolve(_dirname, 'exports', 'favicon.png');
+
+describe('test', () => {
+    test('check file-type works', async () => {
+        const type = await fileTypeFromFile(favicon);
+        expect(type?.mime).toBe('image/x-icon');
+    });
+    test('favicon.ico (string)', async () => {
+        const type = await fileTypeFromFile(favicon);
+        if (!type) throw new Error('file type not found');
+        const sharpCtx = await sharpBmp(favicon, type.mime);
+        const metadata = await sharpCtx.metadata();
+        expect(metadata.format).toBe('raw');
+        expect(metadata.width).toBe(128);
+        expect(metadata.height).toBe(128);
+
+        await sharpCtx.png().toFile(faviconPng);
+        const pngType = await fileTypeFromFile(faviconPng);
+        expect(pngType?.mime).toBe('image/png');
+    });
+    test('favicon.ico (buffer)', async () => {
+        const type = await fileTypeFromFile(favicon);
+        if (!type) throw new Error('file type not found');
+        const buffer = await readFile(favicon);
+        const sharpCtx = await sharpBmp(buffer, type.mime);
+        const metadata = await sharpCtx.metadata();
+        expect(metadata.format).toBe('raw');
+        expect(metadata.width).toBe(128);
+        expect(metadata.height).toBe(128);
+    });
+    test('favicon.png', async () => {
+        const type = await fileTypeFromFile(faviconPng);
+        if (!type) throw new Error('file type not found');
+        const sharpCtx = await sharpBmp(faviconPng, type.mime);
+        expect(sharpCtx).toBeTruthy();
+        expect((await sharpCtx.metadata()).format).toBe('png');
+    });
+});

tsconfig.json

@@ -0,0 +1,49 @@
+{
+	"compilerOptions": {
+		"allowJs": true,
+		"noEmitOnError": false,
+		"noImplicitAny": true,
+		"noImplicitReturns": true,
+		"noUnusedParameters": false,
+		"noUnusedLocals": false,
+		"noFallthroughCasesInSwitch": true,
+		"declaration": true,
+		"sourceMap": false,
+		"target": "es2021",
+		"module": "esnext",
+		"moduleResolution": "node",
+		"allowSyntheticDefaultImports": true,
+		"removeComments": false,
+		"noLib": false,
+		"strict": true,
+		"strictNullChecks": true,
+		"strictPropertyInitialization": false,
+		"skipLibCheck": true,
+		"experimentalDecorators": true,
+		"emitDecoratorMetadata": true,
+		"resolveJsonModule": true,
+		"isolatedModules": true,
+		"rootDir": "./src",
+		"baseUrl": "./",
+		"paths": {
+			"@/*": [
+				"./src/*"
+			]
+		},
+		"outDir": "./built",
+		"types": [
+			"node"
+		],
+		"typeRoots": [
+			"./node_modules/@types",
+			"./src/@types"
+		],
+		"lib": [
+			"esnext"
+		]
+	},
+	"compileOnSave": false,
+	"include": [
+		"./src/**/*.ts"
+	],
+}