psd 3.4.0 → 4.1.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.
Files changed (216) hide show
  1. package/README.md +196 -149
  2. package/dist/descriptor.d.ts +20 -0
  3. package/dist/descriptor.d.ts.map +1 -0
  4. package/dist/descriptor.js +114 -0
  5. package/dist/descriptor.js.map +1 -0
  6. package/dist/engine-data.d.ts +11 -0
  7. package/dist/engine-data.d.ts.map +1 -0
  8. package/dist/engine-data.js +82 -0
  9. package/dist/engine-data.js.map +1 -0
  10. package/dist/image.d.ts +52 -0
  11. package/dist/image.d.ts.map +1 -0
  12. package/dist/image.js +301 -0
  13. package/dist/image.js.map +1 -0
  14. package/dist/index.d.ts +16 -0
  15. package/dist/index.d.ts.map +1 -0
  16. package/dist/index.js +10 -0
  17. package/dist/index.js.map +1 -0
  18. package/dist/layer-info.d.ts +494 -0
  19. package/dist/layer-info.d.ts.map +1 -0
  20. package/dist/layer-info.js +529 -0
  21. package/dist/layer-info.js.map +1 -0
  22. package/dist/layer-styles.d.ts +160 -0
  23. package/dist/layer-styles.d.ts.map +1 -0
  24. package/dist/layer-styles.js +183 -0
  25. package/dist/layer-styles.js.map +1 -0
  26. package/dist/layer.d.ts +143 -0
  27. package/dist/layer.d.ts.map +1 -0
  28. package/dist/layer.js +249 -0
  29. package/dist/layer.js.map +1 -0
  30. package/dist/nodes.d.ts +233 -0
  31. package/dist/nodes.d.ts.map +1 -0
  32. package/dist/nodes.js +326 -0
  33. package/dist/nodes.js.map +1 -0
  34. package/dist/path-record.d.ts +34 -0
  35. package/dist/path-record.d.ts.map +1 -0
  36. package/dist/path-record.js +44 -0
  37. package/dist/path-record.js.map +1 -0
  38. package/dist/png.d.ts +10 -0
  39. package/dist/png.d.ts.map +1 -0
  40. package/dist/png.js +85 -0
  41. package/dist/png.js.map +1 -0
  42. package/dist/psd.d.ts +49 -0
  43. package/dist/psd.d.ts.map +1 -0
  44. package/dist/psd.js +106 -0
  45. package/dist/psd.js.map +1 -0
  46. package/dist/reader.d.ts +41 -0
  47. package/dist/reader.d.ts.map +1 -0
  48. package/dist/reader.js +100 -0
  49. package/dist/reader.js.map +1 -0
  50. package/dist/resources.d.ts +105 -0
  51. package/dist/resources.d.ts.map +1 -0
  52. package/dist/resources.js +173 -0
  53. package/dist/resources.js.map +1 -0
  54. package/dist/type-tool.d.ts +142 -0
  55. package/dist/type-tool.d.ts.map +1 -0
  56. package/dist/type-tool.js +222 -0
  57. package/dist/type-tool.js.map +1 -0
  58. package/package.json +26 -32
  59. package/src/descriptor.ts +141 -0
  60. package/src/engine-data.ts +86 -0
  61. package/src/image.ts +338 -0
  62. package/src/index.ts +38 -0
  63. package/src/layer-info.ts +578 -0
  64. package/src/layer-styles.ts +339 -0
  65. package/src/layer.ts +334 -0
  66. package/src/nodes.ts +411 -0
  67. package/src/path-record.ts +69 -0
  68. package/src/png.ts +92 -0
  69. package/src/psd.ts +133 -0
  70. package/src/reader.ts +125 -0
  71. package/src/resources.ts +273 -0
  72. package/src/type-tool.ts +270 -0
  73. package/.travis.yml +0 -5
  74. package/Cakefile +0 -61
  75. package/DEVELOPMENT.md +0 -27
  76. package/bower.json +0 -26
  77. package/docs/docco.css +0 -284
  78. package/docs/lib/psd/blend_mode.coffee.html +0 -72
  79. package/docs/lib/psd/channel_image.coffee.html +0 -81
  80. package/docs/lib/psd/color.coffee.html +0 -13
  81. package/docs/lib/psd/descriptor.coffee.html +0 -173
  82. package/docs/lib/psd/file.coffee.html +0 -78
  83. package/docs/lib/psd/header.coffee.html +0 -71
  84. package/docs/lib/psd/image.coffee.html +0 -94
  85. package/docs/lib/psd/image_export.coffee.html +0 -5
  86. package/docs/lib/psd/image_exports/png.coffee.html +0 -19
  87. package/docs/lib/psd/image_format.coffee.html +0 -8
  88. package/docs/lib/psd/image_formats/layer_raw.coffee.html +0 -9
  89. package/docs/lib/psd/image_formats/layer_rle.coffee.html +0 -10
  90. package/docs/lib/psd/image_formats/raw.coffee.html +0 -6
  91. package/docs/lib/psd/image_formats/rle.coffee.html +0 -37
  92. package/docs/lib/psd/image_mode.coffee.html +0 -7
  93. package/docs/lib/psd/image_modes/cmyk.coffee.html +0 -36
  94. package/docs/lib/psd/image_modes/greyscale.coffee.html +0 -17
  95. package/docs/lib/psd/image_modes/rgb.coffee.html +0 -32
  96. package/docs/lib/psd/init.coffee.html +0 -22
  97. package/docs/lib/psd/layer/blend_modes.coffee.html +0 -22
  98. package/docs/lib/psd/layer/blending_ranges.coffee.html +0 -29
  99. package/docs/lib/psd/layer/channel_image.coffee.html +0 -13
  100. package/docs/lib/psd/layer/helpers.coffee.html +0 -19
  101. package/docs/lib/psd/layer/info.coffee.html +0 -69
  102. package/docs/lib/psd/layer/mask.coffee.html +0 -11
  103. package/docs/lib/psd/layer/name.coffee.html +0 -15
  104. package/docs/lib/psd/layer/position_channels.coffee.html +0 -24
  105. package/docs/lib/psd/layer.coffee.html +0 -64
  106. package/docs/lib/psd/layer_info/blend_clipping_elements.coffee.html +0 -11
  107. package/docs/lib/psd/layer_info/blend_interior_elements.coffee.html +0 -11
  108. package/docs/lib/psd/layer_info/fill_opacity.coffee.html +0 -10
  109. package/docs/lib/psd/layer_info/gradient_fill.coffee.html +0 -12
  110. package/docs/lib/psd/layer_info/layer_id.coffee.html +0 -10
  111. package/docs/lib/psd/layer_info/layer_name_source.coffee.html +0 -10
  112. package/docs/lib/psd/layer_info/legacy_typetool.coffee.html +0 -82
  113. package/docs/lib/psd/layer_info/locked.coffee.html +0 -24
  114. package/docs/lib/psd/layer_info/metadata.coffee.html +0 -30
  115. package/docs/lib/psd/layer_info/nested_section_divider.coffee.html +0 -23
  116. package/docs/lib/psd/layer_info/object_effects.coffee.html +0 -12
  117. package/docs/lib/psd/layer_info/section_divider.coffee.html +0 -41
  118. package/docs/lib/psd/layer_info/solid_color.coffee.html +0 -24
  119. package/docs/lib/psd/layer_info/typetool.coffee.html +0 -121
  120. package/docs/lib/psd/layer_info/unicode_name.coffee.html +0 -14
  121. package/docs/lib/psd/layer_info/vector_mask.coffee.html +0 -37
  122. package/docs/lib/psd/layer_info/vector_origination.coffee.html +0 -12
  123. package/docs/lib/psd/layer_info/vector_stroke.coffee.html +0 -12
  124. package/docs/lib/psd/layer_info/vector_stroke_content.coffee.html +0 -12
  125. package/docs/lib/psd/layer_info.coffee.html +0 -11
  126. package/docs/lib/psd/layer_mask.coffee.html +0 -73
  127. package/docs/lib/psd/lazy_execute.coffee.html +0 -80
  128. package/docs/lib/psd/mask.coffee.html +0 -47
  129. package/docs/lib/psd/node.coffee.html +0 -100
  130. package/docs/lib/psd/nodes/ancestry.coffee.html +0 -47
  131. package/docs/lib/psd/nodes/build_preview.coffee.html +0 -6
  132. package/docs/lib/psd/nodes/group.coffee.html +0 -19
  133. package/docs/lib/psd/nodes/layer.coffee.html +0 -17
  134. package/docs/lib/psd/nodes/root.coffee.html +0 -61
  135. package/docs/lib/psd/nodes/search.coffee.html +0 -23
  136. package/docs/lib/psd/path_record.coffee.html +0 -73
  137. package/docs/lib/psd/resource.coffee.html +0 -20
  138. package/docs/lib/psd/resource_section.coffee.html +0 -16
  139. package/docs/lib/psd/resources/layer_comps.coffee.html +0 -31
  140. package/docs/lib/psd/resources.coffee.html +0 -44
  141. package/docs/lib/psd/util.coffee.html +0 -24
  142. package/docs/lib/psd.coffee.html +0 -85
  143. package/index.js +0 -2
  144. package/lib/psd/blend_mode.coffee +0 -78
  145. package/lib/psd/channel_image.coffee +0 -87
  146. package/lib/psd/color.coffee +0 -10
  147. package/lib/psd/descriptor.coffee +0 -189
  148. package/lib/psd/file.coffee +0 -88
  149. package/lib/psd/header.coffee +0 -83
  150. package/lib/psd/image.coffee +0 -107
  151. package/lib/psd/image_export.coffee +0 -2
  152. package/lib/psd/image_exports/png.coffee +0 -28
  153. package/lib/psd/image_format.coffee +0 -5
  154. package/lib/psd/image_formats/layer_raw.coffee +0 -6
  155. package/lib/psd/image_formats/layer_rle.coffee +0 -7
  156. package/lib/psd/image_formats/raw.coffee +0 -3
  157. package/lib/psd/image_formats/rle.coffee +0 -38
  158. package/lib/psd/image_mode.coffee +0 -4
  159. package/lib/psd/image_modes/cmyk.coffee +0 -36
  160. package/lib/psd/image_modes/greyscale.coffee +0 -14
  161. package/lib/psd/image_modes/rgb.coffee +0 -39
  162. package/lib/psd/init.coffee +0 -21
  163. package/lib/psd/layer/blend_modes.coffee +0 -20
  164. package/lib/psd/layer/blending_ranges.coffee +0 -28
  165. package/lib/psd/layer/channel_image.coffee +0 -10
  166. package/lib/psd/layer/helpers.coffee +0 -16
  167. package/lib/psd/layer/info.coffee +0 -76
  168. package/lib/psd/layer/mask.coffee +0 -8
  169. package/lib/psd/layer/name.coffee +0 -12
  170. package/lib/psd/layer/position_channels.coffee +0 -22
  171. package/lib/psd/layer.coffee +0 -64
  172. package/lib/psd/layer_info/artboard.coffee +0 -16
  173. package/lib/psd/layer_info/blend_clipping_elements.coffee +0 -8
  174. package/lib/psd/layer_info/blend_interior_elements.coffee +0 -8
  175. package/lib/psd/layer_info/fill_opacity.coffee +0 -7
  176. package/lib/psd/layer_info/gradient_fill.coffee +0 -9
  177. package/lib/psd/layer_info/layer_id.coffee +0 -7
  178. package/lib/psd/layer_info/layer_name_source.coffee +0 -7
  179. package/lib/psd/layer_info/legacy_typetool.coffee +0 -80
  180. package/lib/psd/layer_info/locked.coffee +0 -21
  181. package/lib/psd/layer_info/metadata.coffee +0 -27
  182. package/lib/psd/layer_info/nested_section_divider.coffee +0 -22
  183. package/lib/psd/layer_info/object_effects.coffee +0 -9
  184. package/lib/psd/layer_info/section_divider.coffee +0 -38
  185. package/lib/psd/layer_info/solid_color.coffee +0 -21
  186. package/lib/psd/layer_info/typetool.coffee +0 -172
  187. package/lib/psd/layer_info/unicode_name.coffee +0 -11
  188. package/lib/psd/layer_info/vector_mask.coffee +0 -35
  189. package/lib/psd/layer_info/vector_origination.coffee +0 -9
  190. package/lib/psd/layer_info/vector_stroke.coffee +0 -9
  191. package/lib/psd/layer_info/vector_stroke_content.coffee +0 -9
  192. package/lib/psd/layer_info.coffee +0 -8
  193. package/lib/psd/layer_mask.coffee +0 -73
  194. package/lib/psd/lazy_execute.coffee +0 -86
  195. package/lib/psd/mask.coffee +0 -52
  196. package/lib/psd/node.coffee +0 -150
  197. package/lib/psd/nodes/ancestry.coffee +0 -44
  198. package/lib/psd/nodes/build_preview.coffee +0 -3
  199. package/lib/psd/nodes/group.coffee +0 -16
  200. package/lib/psd/nodes/layer.coffee +0 -14
  201. package/lib/psd/nodes/root.coffee +0 -59
  202. package/lib/psd/nodes/search.coffee +0 -20
  203. package/lib/psd/path_record.coffee +0 -72
  204. package/lib/psd/resource.coffee +0 -17
  205. package/lib/psd/resource_section.coffee +0 -16
  206. package/lib/psd/resources/guides.coffee +0 -25
  207. package/lib/psd/resources/layer_comps.coffee +0 -28
  208. package/lib/psd/resources/layer_links.coffee +0 -17
  209. package/lib/psd/resources/resolution_info.coffee +0 -26
  210. package/lib/psd/resources.coffee +0 -41
  211. package/lib/psd/util.coffee +0 -23
  212. package/lib/psd.coffee +0 -92
  213. package/output/Logo_Glyph.png +0 -0
  214. package/output/Make a change and save..png +0 -0
  215. package/output/Matte.png +0 -0
  216. package/webpack.config.js +0 -23
package/src/nodes.ts ADDED
@@ -0,0 +1,411 @@
1
+ import type { LayerImage } from './image.ts';
2
+ import type { BlendMode, Layer } from './layer.ts';
3
+ import type { LayerInfo } from './layer-info.ts';
4
+ import type { PSD } from './psd.ts';
5
+ import type { LayerComp } from './resources.ts';
6
+
7
+ export type Node = RootNode | GroupNode | LayerNode;
8
+ export type ChildNode = GroupNode | LayerNode;
9
+
10
+ export type LayerJSON = ReturnType<LayerNode['toJSON']>;
11
+ export interface GroupJSON extends ReturnType<LayerBackedNode['toJSON']> {
12
+ open: boolean;
13
+ children: Array<GroupJSON | LayerJSON>;
14
+ }
15
+
16
+ /** A layer comp, or its name or ID. */
17
+ export type CompRef = LayerComp | string | number;
18
+
19
+ interface Box {
20
+ top: number;
21
+ left: number;
22
+ bottom: number;
23
+ right: number;
24
+ }
25
+
26
+ interface Offset {
27
+ x: number;
28
+ y: number;
29
+ }
30
+
31
+ abstract class BaseNode {
32
+ abstract readonly type: 'root' | 'group' | 'layer';
33
+ abstract readonly name: string;
34
+ readonly children: ChildNode[] = [];
35
+
36
+ abstract get parent(): RootNode | GroupNode | null;
37
+ abstract get root(): RootNode;
38
+ /** Bounds before any layer comp offset. */
39
+ protected abstract get box(): Box;
40
+
41
+ /** The offset applied by the tree's layer comp. */
42
+ protected get offset(): Offset {
43
+ return { x: 0, y: 0 };
44
+ }
45
+
46
+ get top(): number {
47
+ return this.box.top + this.offset.y;
48
+ }
49
+
50
+ get bottom(): number {
51
+ return this.box.bottom + this.offset.y;
52
+ }
53
+
54
+ get left(): number {
55
+ return this.box.left + this.offset.x;
56
+ }
57
+
58
+ get right(): number {
59
+ return this.box.right + this.offset.x;
60
+ }
61
+
62
+ get width(): number {
63
+ return this.right - this.left;
64
+ }
65
+
66
+ get height(): number {
67
+ return this.bottom - this.top;
68
+ }
69
+
70
+ /** Ancestors from the top of the tree down, excluding the root. */
71
+ ancestors(): GroupNode[] {
72
+ const parent = this.parent;
73
+ return parent && parent.type !== 'root' ? [...parent.ancestors(), parent] : [];
74
+ }
75
+
76
+ /** Every child of this node's parent, including this node. */
77
+ get siblings(): ChildNode[] {
78
+ return this.parent?.children ?? [];
79
+ }
80
+
81
+ get nextSibling(): ChildNode | undefined {
82
+ const siblings = this.siblings;
83
+ return siblings[siblings.findIndex((s: BaseNode) => s === this) + 1];
84
+ }
85
+
86
+ get prevSibling(): ChildNode | undefined {
87
+ const siblings = this.siblings;
88
+ const index = siblings.findIndex((s: BaseNode) => s === this);
89
+ return index > 0 ? siblings[index - 1] : undefined;
90
+ }
91
+
92
+ /** All nodes below this one, depth first. */
93
+ descendants(): ChildNode[] {
94
+ return this.children.flatMap((c) => [c, ...c.descendants()]);
95
+ }
96
+
97
+ /** This node followed by its descendants. */
98
+ subtree(this: Node): Node[] {
99
+ return [this, ...this.descendants()];
100
+ }
101
+
102
+ /** 0 for the root. */
103
+ get depth(): number {
104
+ return this.parent ? this.parent.depth + 1 : 0;
105
+ }
106
+
107
+ /** Slash-separated names from the top of the tree, e.g. `Version A/Matte`. */
108
+ get path(): string {
109
+ return [...this.ancestors().map((n) => n.name), this.name].join('/');
110
+ }
111
+
112
+ /**
113
+ * Finds descendants by a path of names, relative to this node. Layer names don't have to be
114
+ * unique, so this always returns an array.
115
+ */
116
+ childrenAtPath(path: string | string[], { caseSensitive = false } = {}): ChildNode[] {
117
+ const [query, ...rest] = Array.isArray(path) ? path : path.split('/').filter(Boolean);
118
+ if (query === undefined) return [];
119
+ const normalize = (s: string) => (caseSensitive ? s : s.toLowerCase());
120
+ const matches = this.children.filter((c) => normalize(c.name) === normalize(query));
121
+ return rest.length === 0 ? matches : matches.flatMap((m) => m.childrenAtPath(rest, { caseSensitive }));
122
+ }
123
+
124
+ findById(id: number): ChildNode | undefined {
125
+ return this.descendants().find((n) => n.id === id);
126
+ }
127
+
128
+ /** The union of the non-empty children's bounds, before layer comp offsets. */
129
+ protected childBounds(): Box | undefined {
130
+ const boxes = this.children.filter((c) => !c.isEmpty).map((c: BaseNode) => c.box);
131
+ if (boxes.length === 0) return undefined;
132
+ return {
133
+ top: Math.min(...boxes.map((b) => b.top)),
134
+ left: Math.min(...boxes.map((b) => b.left)),
135
+ bottom: Math.max(...boxes.map((b) => b.bottom)),
136
+ right: Math.max(...boxes.map((b) => b.right)),
137
+ };
138
+ }
139
+ }
140
+
141
+ /** Shared behavior of groups and layers, which are both backed by a layer record. */
142
+ abstract class LayerBackedNode extends BaseNode {
143
+ abstract override readonly type: 'group' | 'layer';
144
+ readonly layer: Layer;
145
+ readonly #parent: RootNode | GroupNode;
146
+
147
+ constructor(layer: Layer, parent: RootNode | GroupNode) {
148
+ super();
149
+ this.layer = layer;
150
+ this.#parent = parent;
151
+ }
152
+
153
+ get parent(): RootNode | GroupNode {
154
+ return this.#parent;
155
+ }
156
+
157
+ get root(): RootNode {
158
+ return this.#parent.root;
159
+ }
160
+
161
+ protected get box(): Box {
162
+ const { top, left, bottom, right } = this.layer;
163
+ return { top, left, bottom, right };
164
+ }
165
+
166
+ protected override get offset(): Offset {
167
+ const comp = this.root.comp;
168
+ return comp && comp.capturedInfo & 0b010 ? this.#offsetInComp(comp.id) : super.offset;
169
+ }
170
+
171
+ get name(): string {
172
+ return this.layer.name;
173
+ }
174
+
175
+ get id(): number | undefined {
176
+ return this.layer.id;
177
+ }
178
+
179
+ get info(): LayerInfo {
180
+ return this.layer.info;
181
+ }
182
+
183
+ /** Visible, accounting for clipping masks and the tree's layer comp. */
184
+ get visible(): boolean {
185
+ if (this.layer.clipped && this.clippingMask?.visible === false) return false;
186
+ const comp = this.root.comp;
187
+ return comp && comp.capturedInfo & 0b001 ? this.visibleInComp(comp) : this.layer.visible;
188
+ }
189
+
190
+ /** 0 to 1. */
191
+ get opacity(): number {
192
+ return this.layer.opacity / 255;
193
+ }
194
+
195
+ /** 0 to 1. */
196
+ get fillOpacity(): number {
197
+ return this.layer.fillOpacity / 255;
198
+ }
199
+
200
+ get blendMode(): BlendMode | undefined {
201
+ return this.layer.blendMode;
202
+ }
203
+
204
+ /** The node this one is clipped to: the first unclipped sibling below it. */
205
+ get clippingMask(): ChildNode | undefined {
206
+ if (!this.layer.clipped) return undefined;
207
+ let node = this.nextSibling;
208
+ while (node?.layer.clipped) node = node.nextSibling;
209
+ return node;
210
+ }
211
+
212
+ // Locks are inherited from ancestors, but Photoshop only stores them on the locked node.
213
+ #locked(key: 'all' | 'position' | 'composite' | 'transparency'): boolean {
214
+ if (this.layer.info.locked?.[key]) return true;
215
+ return this.parent.type === 'group' && this.parent.#locked(key);
216
+ }
217
+
218
+ get allLocked(): boolean {
219
+ return this.#locked('all');
220
+ }
221
+
222
+ get positionLocked(): boolean {
223
+ return this.#locked('position');
224
+ }
225
+
226
+ get compositeLocked(): boolean {
227
+ return this.#locked('composite');
228
+ }
229
+
230
+ get transparencyLocked(): boolean {
231
+ return this.#locked('transparency');
232
+ }
233
+
234
+ /** The color label, inherited from the nearest labeled ancestor. */
235
+ get colorLabel(): string {
236
+ const color = this.layer.info.sheetColor ?? 'none';
237
+ return color === 'none' && this.parent.type === 'group' ? this.parent.colorLabel : color;
238
+ }
239
+
240
+ /** Whether this node is visible in the given layer comp. */
241
+ visibleInComp(comp: CompRef): boolean {
242
+ const id = this.root.findComp(comp).id;
243
+ let visible = true;
244
+ for (const setting of this.#compSettings()) {
245
+ if (setting.enab !== undefined) visible = setting.enab;
246
+ if (setting.compList.includes(id)) return visible;
247
+ }
248
+ return false;
249
+ }
250
+
251
+ /** This node's bounds in the given layer comp. */
252
+ positionInComp(comp: CompRef): Box {
253
+ const { x, y } = this.#offsetInComp(this.root.findComp(comp).id);
254
+ const { top, left, bottom, right } = this.box;
255
+ return { top: top + y, left: left + x, bottom: bottom + y, right: right + x };
256
+ }
257
+
258
+ #offsetInComp(id: number): Offset {
259
+ let x = 0;
260
+ let y = 0;
261
+ for (const setting of this.#compSettings()) {
262
+ if (setting.Ofst) ({ Hrzn: x, Vrtc: y } = setting.Ofst);
263
+ if (setting.compList.includes(id)) break;
264
+ }
265
+ return { x, y };
266
+ }
267
+
268
+ #compSettings(): Array<{ enab?: boolean; Ofst?: { Hrzn: number; Vrtc: number }; compList: number[] }> {
269
+ return this.layer.info.metadata?.layerComp?.layerSettings ?? [];
270
+ }
271
+
272
+ toJSON() {
273
+ return {
274
+ type: this.type,
275
+ id: this.id,
276
+ name: this.name,
277
+ visible: this.visible,
278
+ opacity: this.opacity,
279
+ blendMode: this.blendMode,
280
+ top: this.top,
281
+ left: this.left,
282
+ bottom: this.bottom,
283
+ right: this.right,
284
+ width: this.width,
285
+ height: this.height,
286
+ };
287
+ }
288
+ }
289
+
290
+ export class GroupNode extends LayerBackedNode {
291
+ readonly type = 'group';
292
+ #box: Box | undefined;
293
+
294
+ /** The bounds of the non-empty children, or the group's own bounds if they're all empty. */
295
+ protected override get box(): Box {
296
+ return (this.#box ??= this.childBounds() ?? super.box);
297
+ }
298
+
299
+ /** Whether the group is expanded in the layers panel. */
300
+ get open(): boolean {
301
+ return this.layer.info.sectionDivider?.type === 'open folder';
302
+ }
303
+
304
+ get isEmpty(): boolean {
305
+ return this.children.every((c) => c.isEmpty);
306
+ }
307
+
308
+ override toJSON(): GroupJSON {
309
+ return { ...super.toJSON(), open: this.open, children: this.children.map((c) => c.toJSON()) };
310
+ }
311
+ }
312
+
313
+ export class LayerNode extends LayerBackedNode {
314
+ readonly type = 'layer';
315
+
316
+ get image(): LayerImage {
317
+ return this.layer.image;
318
+ }
319
+
320
+ get isEmpty(): boolean {
321
+ return this.width === 0 || this.height === 0;
322
+ }
323
+
324
+ override toJSON() {
325
+ return {
326
+ ...super.toJSON(),
327
+ mask: this.layer.mask,
328
+ text: this.layer.info.typeTool?.toJSON(),
329
+ image: { width: this.layer.width, height: this.layer.height },
330
+ };
331
+ }
332
+ }
333
+
334
+ export class RootNode extends BaseNode {
335
+ readonly type = 'root';
336
+ readonly name = '';
337
+ readonly psd: PSD;
338
+ /** The layer comp whose visibility and positions this tree shows, if any. See `filterByComp`. */
339
+ readonly comp: LayerComp | undefined;
340
+
341
+ constructor(psd: PSD, comp?: LayerComp) {
342
+ super();
343
+ this.psd = psd;
344
+ this.comp = comp;
345
+
346
+ let current: RootNode | GroupNode = this;
347
+ const stack: Array<RootNode | GroupNode> = [];
348
+ for (const layer of psd.layers) {
349
+ if (layer.isFolder) {
350
+ const group = new GroupNode(layer, current);
351
+ current.children.push(group);
352
+ stack.push(current);
353
+ current = group;
354
+ } else if (layer.isFolderEnd) {
355
+ // Files from some editors have unbalanced markers. Rather than fail, a stray end marker is
356
+ // ignored, and groups still open at the bottom of the list end there.
357
+ current = stack.pop() ?? current;
358
+ } else {
359
+ current.children.push(new LayerNode(layer, current));
360
+ }
361
+ }
362
+ }
363
+
364
+ get parent(): null {
365
+ return null;
366
+ }
367
+
368
+ get root(): RootNode {
369
+ return this;
370
+ }
371
+
372
+ protected get box(): Box {
373
+ return { top: 0, left: 0, bottom: this.psd.height, right: this.psd.width };
374
+ }
375
+
376
+ get visible(): true {
377
+ return true;
378
+ }
379
+
380
+ /** Looks up a layer comp by name or ID. Throws if it doesn't exist. */
381
+ findComp(comp: CompRef): LayerComp {
382
+ if (typeof comp === 'object') return comp;
383
+ const found = this.psd.resources.layerComps.find((c) => (typeof comp === 'string' ? c.name === comp : c.id === comp));
384
+ if (!found) throw new Error(`Layer comp not found: ${comp}`);
385
+ return found;
386
+ }
387
+
388
+ /** A new tree with the visibility and positions captured by a layer comp applied. */
389
+ filterByComp(comp: CompRef): RootNode {
390
+ return new RootNode(this.psd, this.findComp(comp));
391
+ }
392
+
393
+ toJSON() {
394
+ const { header, resources } = this.psd;
395
+ return {
396
+ children: this.children.map((c) => c.toJSON()),
397
+ document: {
398
+ width: this.width,
399
+ height: this.height,
400
+ depth: header.depth,
401
+ mode: header.modeName,
402
+ resources: {
403
+ layerComps: resources.layerComps,
404
+ guides: resources.guides,
405
+ slices: resources.slices?.slices ?? [],
406
+ resolutionInfo: resources.resolutionInfo,
407
+ },
408
+ },
409
+ };
410
+ }
411
+ }
@@ -0,0 +1,69 @@
1
+ import type { Reader } from './reader.ts';
2
+
3
+ export interface PathPoint {
4
+ vert: number;
5
+ horiz: number;
6
+ }
7
+
8
+ /** One 26-byte record of a vector path (vector masks, saved paths, the work path). */
9
+ export type PathRecord =
10
+ | { recordType: 0 | 3; numPoints: number }
11
+ | {
12
+ recordType: 1 | 2 | 4 | 5;
13
+ /** Closed subpath records are 1 and 2; open are 4 and 5. */
14
+ closed: boolean;
15
+ linked: boolean;
16
+ preceding: PathPoint;
17
+ anchor: PathPoint;
18
+ leaving: PathPoint;
19
+ }
20
+ | { recordType: 6 }
21
+ | { recordType: 7; clipboard: { top: number; left: number; bottom: number; right: number; resolution: number } }
22
+ | { recordType: 8; initialFill: number };
23
+
24
+ export function readPathRecords(r: Reader, count: number): PathRecord[] {
25
+ return Array.from({ length: count }, () => readPathRecord(r));
26
+ }
27
+
28
+ function readPathRecord(r: Reader): PathRecord {
29
+ const start = r.pos;
30
+ const recordType = r.int16();
31
+ let record: PathRecord;
32
+ const point = () => ({ vert: r.pathNumber(), horiz: r.pathNumber() });
33
+
34
+ switch (recordType) {
35
+ case 0:
36
+ case 3:
37
+ record = { recordType, numPoints: r.int16() };
38
+ break;
39
+ case 1:
40
+ case 2:
41
+ case 4:
42
+ case 5:
43
+ record = {
44
+ recordType,
45
+ closed: recordType <= 2,
46
+ linked: recordType === 1 || recordType === 4,
47
+ preceding: point(),
48
+ anchor: point(),
49
+ leaving: point(),
50
+ };
51
+ break;
52
+ case 7: {
53
+ const [top, left, bottom, right, resolution] = [0, 0, 0, 0, 0].map(() => r.pathNumber()) as [number, number, number, number, number];
54
+ record = { recordType, clipboard: { top, left, bottom, right, resolution } };
55
+ break;
56
+ }
57
+ case 8:
58
+ record = { recordType, initialFill: r.int16() };
59
+ break;
60
+ case 6:
61
+ record = { recordType };
62
+ break;
63
+ default:
64
+ throw new Error(`Unknown path record type ${recordType} at offset ${start}`);
65
+ }
66
+
67
+ r.seek(start + 26);
68
+ return record;
69
+ }
package/src/png.ts ADDED
@@ -0,0 +1,92 @@
1
+ /** Pixel data with 1 (grayscale) or 4 (RGBA) bytes per pixel. Compatible with `ImageData`. */
2
+ export interface Pixels {
3
+ width: number;
4
+ height: number;
5
+ data: Uint8Array | Uint8ClampedArray;
6
+ }
7
+
8
+ /** Writes the chunks to a (de)compression stream as they're produced and returns its output chunks. */
9
+ async function transform(input: Iterable<Uint8Array>, stream: CompressionStream | DecompressionStream): Promise<Uint8Array[]> {
10
+ const writer = stream.writable.getWriter();
11
+ const reader = stream.readable.getReader();
12
+ const output: Uint8Array[] = [];
13
+ const write = async () => {
14
+ for (const bytes of input) await writer.write(bytes as Uint8Array<ArrayBuffer>);
15
+ await writer.close();
16
+ };
17
+ const read = async () => {
18
+ for (let r = await reader.read(); !r.done; r = await reader.read()) output.push(r.value);
19
+ };
20
+ await Promise.all([write(), read()]);
21
+ return output;
22
+ }
23
+
24
+ function concat(parts: Uint8Array[]): Uint8Array {
25
+ const out = new Uint8Array(parts.reduce((n, p) => n + p.length, 0));
26
+ let offset = 0;
27
+ for (const p of parts) {
28
+ out.set(p, offset);
29
+ offset += p.length;
30
+ }
31
+ return out;
32
+ }
33
+
34
+ export const inflate = async (bytes: Uint8Array) => concat(await transform([bytes], new DecompressionStream('deflate')));
35
+
36
+ const CRC_TABLE = Array.from({ length: 256 }, (_, n) => {
37
+ for (let k = 0; k < 8; k++) n = n & 1 ? 0xedb88320 ^ (n >>> 1) : n >>> 1;
38
+ return n >>> 0;
39
+ });
40
+
41
+ function crc32(parts: Uint8Array[]): number {
42
+ let crc = 0xffffffff;
43
+ for (const bytes of parts) for (const b of bytes) crc = CRC_TABLE[(crc ^ b) & 0xff]! ^ (crc >>> 8);
44
+ return (crc ^ 0xffffffff) >>> 0;
45
+ }
46
+
47
+ /** A PNG chunk as a list of parts, so large data isn't copied until the file is assembled. */
48
+ function chunk(type: string, data: Uint8Array[]): Uint8Array[] {
49
+ const head = new Uint8Array(8);
50
+ new DataView(head.buffer).setUint32(0, data.reduce((n, d) => n + d.length, 0));
51
+ for (let i = 0; i < 4; i++) head[4 + i] = type.charCodeAt(i);
52
+ const crc = new Uint8Array(4);
53
+ new DataView(crc.buffer).setUint32(0, crc32([head.subarray(4), ...data]));
54
+ return [head, ...data, crc];
55
+ }
56
+
57
+ /** Encodes 8-bit grayscale or RGBA pixels as a PNG file. */
58
+ export async function encodePng({ width, height, data }: Pixels): Promise<Uint8Array> {
59
+ if (width === 0 || height === 0) throw new Error('Cannot encode an empty image as PNG');
60
+ const channels = data.length / (width * height);
61
+ if (channels !== 1 && channels !== 4) throw new Error(`Expected 1 or 4 bytes per pixel, got ${channels}`);
62
+
63
+ const header = new Uint8Array(13);
64
+ const view = new DataView(header.buffer);
65
+ view.setUint32(0, width);
66
+ view.setUint32(4, height);
67
+ header[8] = 8; // bit depth
68
+ header[9] = channels === 4 ? 6 : 0; // RGBA or grayscale
69
+
70
+ // Each row is prefixed with filter type 0 (none). Rows are compressed about 1MB at a time
71
+ // rather than copied into one buffer, which would double the image's memory.
72
+ const rowLength = width * channels;
73
+ const blockRows = Math.max(1, Math.floor(2 ** 20 / (rowLength + 1)));
74
+ function* rows() {
75
+ for (let start = 0; start < height; start += blockRows) {
76
+ const count = Math.min(blockRows, height - start);
77
+ const block = new Uint8Array((rowLength + 1) * count);
78
+ for (let y = 0; y < count; y++) {
79
+ const row = (start + y) * rowLength;
80
+ block.set(data.subarray(row, row + rowLength), y * (rowLength + 1) + 1);
81
+ }
82
+ yield block;
83
+ }
84
+ }
85
+
86
+ return concat([
87
+ new Uint8Array([0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a]),
88
+ ...chunk('IHDR', [header]),
89
+ ...chunk('IDAT', await transform(rows(), new CompressionStream('deflate'))),
90
+ ...chunk('IEND', []),
91
+ ]);
92
+ }
package/src/psd.ts ADDED
@@ -0,0 +1,133 @@
1
+ import { CompositeImage } from './image.ts';
2
+ import { readLayerSection, type GlobalMask, type Layer, type LayerSection } from './layer.ts';
3
+ import { RootNode } from './nodes.ts';
4
+ import { Reader } from './reader.ts';
5
+ import { Resources } from './resources.ts';
6
+
7
+ const MODES = [
8
+ 'Bitmap',
9
+ 'GrayScale',
10
+ 'IndexedColor',
11
+ 'RGBColor',
12
+ 'CMYKColor',
13
+ 'HSLColor',
14
+ 'HSBColor',
15
+ 'Multichannel',
16
+ 'Duotone',
17
+ 'LabColor',
18
+ 'Gray16',
19
+ 'RGB48',
20
+ 'Lab48',
21
+ 'CMYK64',
22
+ 'DeepMultichannel',
23
+ 'Duotone16',
24
+ ] as const;
25
+
26
+ export interface Header {
27
+ /** 1 for PSD, 2 for PSB (large document format). */
28
+ version: 1 | 2;
29
+ /** Whether this is a PSB (large document format) file. */
30
+ isBig: boolean;
31
+ /** Number of channels in the composite image, including alpha channels. */
32
+ channels: number;
33
+ width: number;
34
+ height: number;
35
+ /** Bits per channel: 1, 8, 16 or 32. */
36
+ depth: number;
37
+ /** Color mode ID; see `modeName`. */
38
+ mode: number;
39
+ modeName: (typeof MODES)[number] | 'Unknown';
40
+ /** Color mode data: the palette for indexed images, or duotone specifications. */
41
+ colorModeData: Uint8Array;
42
+ }
43
+
44
+ function readHeader(r: Reader): Header {
45
+ const signature = r.ascii(4);
46
+ if (signature !== '8BPS') throw new Error(`Invalid file signature '${signature}', expected '8BPS'`);
47
+ const version = r.uint16();
48
+ if (version !== 1 && version !== 2) throw new Error(`Unsupported PSD version ${version}`);
49
+ r.skip(6); // reserved
50
+ const channels = r.uint16();
51
+ const height = r.uint32();
52
+ const width = r.uint32();
53
+ const depth = r.uint16();
54
+ const mode = r.uint16();
55
+ const colorModeData = r.bytesView(r.uint32());
56
+ return { version, isBig: version === 2, channels, width, height, depth, mode, modeName: MODES[mode] ?? 'Unknown', colorModeData };
57
+ }
58
+
59
+ /**
60
+ * A Photoshop document (PSD or PSB). Construction only reads the header and locates each
61
+ * section; everything else is parsed on first access.
62
+ *
63
+ * ```ts
64
+ * const psd = new PSD(await readFile('file.psd'));
65
+ * console.log(psd.tree.toJSON());
66
+ * ```
67
+ */
68
+ export class PSD {
69
+ readonly header: Header;
70
+ readonly #reader: Reader;
71
+ readonly #resourcesOffset: number;
72
+ readonly #layersOffset: number;
73
+ readonly #imageOffset: number;
74
+ #resources: Resources | undefined;
75
+ #layerSection: LayerSection | undefined;
76
+ #image: CompositeImage | undefined;
77
+ #tree: RootNode | undefined;
78
+
79
+ constructor(data: ArrayBuffer | ArrayBufferView) {
80
+ const bytes = ArrayBuffer.isView(data) ? new Uint8Array(data.buffer, data.byteOffset, data.byteLength) : new Uint8Array(data);
81
+ const r = new Reader(bytes);
82
+ this.#reader = r;
83
+ this.header = readHeader(r);
84
+
85
+ this.#resourcesOffset = r.pos;
86
+ r.skip(r.uint32());
87
+ this.#layersOffset = r.pos;
88
+ r.skip(this.header.isBig ? r.int64() : r.uint32());
89
+ this.#imageOffset = r.pos;
90
+ if (this.#imageOffset > bytes.length) throw new Error('File is truncated');
91
+ }
92
+
93
+ get width(): number {
94
+ return this.header.width;
95
+ }
96
+
97
+ get height(): number {
98
+ return this.header.height;
99
+ }
100
+
101
+ /** Image resources: layer comps, guides, slices, resolution and more. */
102
+ get resources(): Resources {
103
+ if (!this.#resources) {
104
+ const r = this.#reader.at(this.#resourcesOffset);
105
+ const length = r.uint32();
106
+ this.#resources = new Resources(r, r.pos + length);
107
+ }
108
+ return this.#resources;
109
+ }
110
+
111
+ get #layers(): LayerSection {
112
+ return (this.#layerSection ??= readLayerSection(this.#reader.at(this.#layersOffset), this.header, () => this.resources));
113
+ }
114
+
115
+ /** Every layer record from top to bottom, including group dividers. Use `tree` for the hierarchy. */
116
+ get layers(): Layer[] {
117
+ return this.#layers.layers;
118
+ }
119
+
120
+ get globalMask(): GlobalMask | undefined {
121
+ return this.#layers.globalMask;
122
+ }
123
+
124
+ /** The flattened composite image. */
125
+ get image(): CompositeImage {
126
+ return (this.#image ??= new CompositeImage(this.#reader.at(this.#imageOffset), this.header, () => this.resources));
127
+ }
128
+
129
+ /** The document as a tree of groups and layers. */
130
+ get tree(): RootNode {
131
+ return (this.#tree ??= new RootNode(this));
132
+ }
133
+ }