ag-psd 17.0.2 → 17.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ag-psd",
-  "version": "17.0.2",
+  "version": "17.0.4",
   "description": "Library for reading and writing PSD files",
   "main": "dist/index.js",
   "module": "dist-es/index.js",

package/src/additionalInfo.ts

@@ -9,7 +9,7 @@ import {
 	CurvesAdjustment, CurvesAdjustmentChannel, HueSaturationAdjustment, HueSaturationAdjustmentChannel,
 	PresetInfo, Color, ColorBalanceValues, WriteOptions, LinkedFile, PlacedLayerType, Warp, KeyDescriptorItem,
 	BooleanOperation, LayerEffectsInfo, Annotation, LayerVectorMask, AnimationFrame, Timeline, PlacedLayerFilter,
-	UnitsValue, Filter,
+	UnitsValue, Filter, PlacedLayer,
 } from './psd';
 import {
 	PsdReader, readSignature, readUnicodeString, skipBytes, readUint32, readUint8, readFloat64, readUint16,
@@ -1151,6 +1151,9 @@ addHandler(
 		const placed = target.placedLayer!;
 		writeSignature(writer, 'plcL');
 		writeInt32(writer, 3); // version
+		if (!placed.id || typeof placed.id !== 'string' || !/^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/.test(placed.id)) {
+			throw new Error('Placed layer ID must be in a GUID format (example: 20953ddb-9391-11ec-b4f1-c15674f50bc4)');
+		}
 		writePascalString(writer, placed.id, 1);
 		writeInt32(writer, 1); // pageNumber
 		writeInt32(writer, 1); // totalPages
@@ -1159,9 +1162,10 @@ addHandler(
 		writeInt32(writer, placedLayerTypes.indexOf(placed.type));
 		for (let i = 0; i < 8; i++) writeFloat64(writer, placed.transform[i]);
 		writeInt32(writer, 0); // warp version
-		const isQuilt = placed.warp && isQuiltWarp(placed.warp);
+		const warp = getWarpFromPlacedLayer(placed);
+		const isQuilt = isQuiltWarp(warp);
 		const type = isQuilt ? 'quiltWarp' : 'warp';
-		writeVersionAndDescriptor(writer, '', type, encodeWarp(placed.warp || {}), type);
+		writeVersionAndDescriptor(writer, '', type, encodeWarp(warp), type);
 	},
 );
 
@@ -3113,6 +3117,41 @@ interface SoLdDescriptor {
 
 // let t: any;
 
+function getWarpFromPlacedLayer(placed: PlacedLayer): Warp {
+	if (placed.warp) return placed.warp;
+
+	if (!placed.width || !placed.height) throw new Error('You must provide width and height of the linked image in placedLayer');
+
+	const w = placed.width;
+	const h = placed.height;
+	const x0 = 0, x1 = w / 3, x2 = w * 2 / 3, x3 = w;
+	const y0 = 0, y1 = h / 3, y2 = h * 2 / 3, y3 = h;
+
+	return {
+		style: 'custom',
+		value: 0,
+		perspective: 0,
+		perspectiveOther: 0,
+		rotate: 'horizontal',
+		bounds: {
+			top: { value: 0, units: 'Pixels' },
+			left: { value: 0, units: 'Pixels' },
+			bottom: { value: h, units: 'Pixels' },
+			right: { value: w, units: 'Pixels' },
+		},
+		uOrder: 4,
+		vOrder: 4,
+		customEnvelopeWarp: {
+			meshPoints: [
+				{ x: x0, y: y0 }, { x: x1, y: y0 }, { x: x2, y: y0 }, { x: x3, y: y0 },
+				{ x: x0, y: y1 }, { x: x1, y: y1 }, { x: x2, y: y1 }, { x: x3, y: y1 },
+				{ x: x0, y: y2 }, { x: x1, y: y2 }, { x: x2, y: y2 }, { x: x3, y: y2 },
+				{ x: x0, y: y3 }, { x: x1, y: y3 }, { x: x2, y: y3 }, { x: x3, y: y3 },
+			],
+		},
+	};
+}
+
 addHandler(
 	'SoLd',
 	hasKey('placedLayer'),
@@ -3168,6 +3207,11 @@ addHandler(
 		writeInt32(writer, 4); // version
 
 		const placed = target.placedLayer!;
+
+		if (!placed.id || typeof placed.id !== 'string' || !/^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/.test(placed.id)) {
+			throw new Error('Placed layer ID must be in a GUID format (example: 20953ddb-9391-11ec-b4f1-c15674f50bc4)');
+		}
+
 		const desc: SoLdDescriptor = {
 			Idnt: placed.id,
 			placed: placed.placed ?? placed.id,
@@ -3182,7 +3226,7 @@ addHandler(
 			Trnf: placed.transform,
 			nonAffineTransform: placed.nonAffineTransform ?? placed.transform,
 			// quiltWarp: {} as any,
-			warp: encodeWarp(placed.warp || {}),
+			warp: encodeWarp(getWarpFromPlacedLayer(placed)),
 			'Sz  ': {
 				_name: '',
 				_classID: 'Pnt ',
@@ -3480,7 +3524,10 @@ addHandler(
 			const sizeOffset = writer.offset;
 			writeSignature(writer, file.data ? 'liFD' : 'liFA');
 			writeInt32(writer, version);
-			writePascalString(writer, file.id || '', 1);
+			if (!file.id || typeof file.id !== 'string' || !/^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/.test(file.id)) {
+				throw new Error('Linked file ID must be in a GUID format (example: 20953ddb-9391-11ec-b4f1-c15674f50bc4)');
+			}
+			writePascalString(writer, file.id, 1);
 			writeUnicodeStringWithPadding(writer, file.name || '');
 			writeSignature(writer, file.type ? `${file.type}    `.substring(0, 4) : '    ');
 			writeSignature(writer, file.creator ? `${file.creator}    `.substring(0, 4) : '\0\0\0\0');

package/src/psd.ts

@@ -670,7 +670,7 @@ export interface SelectiveColorAdjustment {
 }
 
 export interface LinkedFile {
-	id: string;
+	id: string; // must be in a GUID format (example: 20953ddb-9391-11ec-b4f1-c15674f50bc4)
 	name: string;
 	type?: string;
 	creator?: string;
@@ -1150,7 +1150,7 @@ export interface PlacedLayerFilter {
 export type PlacedLayerType = 'unknown' | 'vector' | 'raster' | 'image stack';
 
 export interface PlacedLayer {
-	id: string; // id of linked image file (psd.linkedFiles)
+	id: string; // id of linked image file (psd.linkedFiles), must be in a GUID format (example: 20953ddb-9391-11ec-b4f1-c15674f50bc4)
 	placed?: string; // unique id
 	type: PlacedLayerType;
 	pageNumber?: number;
@@ -1160,11 +1160,11 @@ export interface PlacedLayer {
 	frameCount?: number;
 	transform: number[]; // x, y of 4 corners of the transform
 	nonAffineTransform?: number[]; // x, y of 4 corners of the transform
-	width?: number;
-	height?: number;
+	width?: number; // width of the linked image
+	height?: number; // height of the linked image
 	resolution?: UnitsValue;
 	// antialias ?
-	warp?: Warp;
+	warp?: Warp; // warp coordinates are relative to the linked image size
 	crop?: number;
 	comp?: number;
 	compInfo?: { compID: number; originalCompID: number; };