@huh-david/bmp-js 0.5.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,48 @@
1
+ interface BmpPaletteColor {
2
+ red: number;
3
+ green: number;
4
+ blue: number;
5
+ quad: number;
6
+ }
7
+ type BmpBinaryInput = ArrayBuffer | ArrayBufferView;
8
+ type EncodeBitDepth = 1 | 4 | 8 | 16 | 24 | 32;
9
+ interface BmpImageData {
10
+ data: Uint8Array;
11
+ width: number;
12
+ height: number;
13
+ }
14
+ interface EncodeOptions {
15
+ orientation?: "top-down" | "bottom-up";
16
+ bitPP?: EncodeBitDepth;
17
+ palette?: BmpPaletteColor[];
18
+ }
19
+ interface DecodeOptions {
20
+ treat16BitAs15BitAlpha?: boolean;
21
+ toRGBA?: boolean;
22
+ }
23
+ interface EncodedBmp {
24
+ data: Uint8Array;
25
+ width: number;
26
+ height: number;
27
+ }
28
+ interface DecodedBmp {
29
+ fileSize: number;
30
+ reserved: number;
31
+ offset: number;
32
+ headerSize: number;
33
+ width: number;
34
+ height: number;
35
+ planes: number;
36
+ bitPP: number;
37
+ compress: number;
38
+ rawSize: number;
39
+ hr: number;
40
+ vr: number;
41
+ colors: number;
42
+ importantColors: number;
43
+ palette?: BmpPaletteColor[];
44
+ data: Uint8Array;
45
+ getData(): Uint8Array;
46
+ }
47
+
48
+ export type { BmpPaletteColor as B, DecodedBmp as D, EncodeOptions as E, BmpBinaryInput as a, DecodeOptions as b, BmpImageData as c, EncodedBmp as d, EncodeBitDepth as e };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@huh-david/bmp-js",
3
- "version": "0.5.0",
3
+ "version": "0.7.0",
4
4
  "description": "A pure TypeScript BMP encoder and decoder for Node.js",
5
5
  "keywords": [
6
6
  "bmp",
@@ -11,7 +11,7 @@
11
11
  "image",
12
12
  "typescript"
13
13
  ],
14
- "homepage": "https://github.com/Huh-David/bmp-js#readme",
14
+ "homepage": "https://huh-david.github.io/bmp-js/",
15
15
  "bugs": {
16
16
  "url": "https://github.com/Huh-David/bmp-js/issues"
17
17
  },
@@ -41,6 +41,12 @@
41
41
  "require": "./dist/index.cjs",
42
42
  "default": "./dist/index.js"
43
43
  },
44
+ "./sharp": {
45
+ "types": "./dist/sharp/index.d.ts",
46
+ "import": "./dist/sharp/index.js",
47
+ "require": "./dist/sharp/index.cjs",
48
+ "default": "./dist/sharp/index.js"
49
+ },
44
50
  "./package.json": "./package.json"
45
51
  },
46
52
  "publishConfig": {
@@ -53,10 +59,22 @@
53
59
  "oxfmt": "^0.42.0",
54
60
  "oxlint": "^1.57.0",
55
61
  "rimraf": "^6.0.1",
62
+ "sharp": "^0.33.5",
56
63
  "tsup": "^8.5.1",
64
+ "typedoc": "^0.28.14",
65
+ "typedoc-plugin-markdown": "^4.9.0",
57
66
  "typescript": "^5.9.3",
67
+ "vitepress": "^1.6.3",
58
68
  "vitest": "^3.2.4"
59
69
  },
70
+ "peerDependencies": {
71
+ "sharp": "^0.33.5"
72
+ },
73
+ "peerDependenciesMeta": {
74
+ "sharp": {
75
+ "optional": true
76
+ }
77
+ },
60
78
  "engines": {
61
79
  "node": ">=22"
62
80
  },
@@ -71,6 +89,11 @@
71
89
  "typecheck": "tsc --project tsconfig.json --noEmit && tsc --project tsconfig.test.json --noEmit",
72
90
  "fixtures:generate": "node scripts/generate-bmp-fixtures.mjs",
73
91
  "fixtures:validate": "node scripts/validate-fixture-provenance.mjs",
92
+ "docs:api": "rimraf site/api/reference && typedoc --options typedoc.json",
93
+ "docs:dev": "pnpm docs:api && vitepress dev site",
94
+ "docs:build": "pnpm docs:api && vitepress build site",
95
+ "docs:preview": "vitepress preview site",
96
+ "docs:check": "pnpm docs:build",
74
97
  "pack:check": "npm pack --dry-run > /dev/null",
75
98
  "check": "pnpm format:check && pnpm lint && pnpm fixtures:validate && pnpm typecheck && pnpm test && pnpm pack:check",
76
99
  "changeset": "changeset",