ag-psd 32.0.0 → 33.0.0

package/src/jpeg.ts

@@ -761,7 +761,7 @@ function parse(data: Uint8Array) {
             };
           }
         }
-        // TODO APP1 - Exif
+        // APP1 - Exif
         if (fileMarker === 0xFFE1) {
           if (appData[0] === 0x45 &&
             appData[1] === 0x78 &&
@@ -952,11 +952,11 @@ function parse(data: Uint8Array) {
   // set each frame's components quantization table
   for (let i = 0; i < frames.length; i++) {
     const cp = frames[i].components;
-    for (let j in cp) { // TODO: don't use `in`
-      const table = quantizationTables[cp[j].quantizationIdx!];
-      if (!table) throw new Error(`Missing quantization table ${cp[j].quantizationIdx}`);
-      cp[j].quantizationTable = table;
-      delete cp[j].quantizationIdx; // TODO: why ???
+    for (const key of Object.keys(cp)) {
+      const component = cp[+key];
+      const table = quantizationTables[component.quantizationIdx!];
+      if (!table) throw new Error(`Missing quantization table ${component.quantizationIdx}`);
+      component.quantizationTable = table;
     }
   }
 
@@ -1021,8 +1021,8 @@ function getData(decoded: Decoded) {
       break;
     }
     case 3: {
-      // The default transform for three components is true, the adobe transform marker overrides it
-      colorTransform = decoded.adobe ? !!decoded.adobe.transformCode : true;
+      // The default transform for three components is true, JFIF marker implies YCbCr, otherwise the adobe transform marker overrides it
+      colorTransform = decoded.jfif ? true : decoded.adobe ? !!decoded.adobe.transformCode : true;
 
       const component1 = decoded.components[0];
       const component2 = decoded.components[1];

package/src/psd.ts

@@ -40,8 +40,7 @@ export interface EffectContour {
 
 export interface EffectPattern {
 	name: string;
-	id: string;
-	// TODO: add fields
+	id: string; // pattern data is stored in `patterns` field of the document
 }
 
 export interface LayerEffectShadow {
@@ -70,12 +69,15 @@ export interface LayerEffectsOuterGlow {
 	blendMode?: BlendMode;
 	opacity?: number;
 	source?: GlowSource;
+	technique?: GlowTechnique;
 	antialiased?: boolean;
 	noise?: number;
 	range?: number;
 	choke?: UnitsValue;
 	jitter?: number;
 	contour?: EffectContour;
+	gradient?: EffectSolidGradient | EffectNoiseGradient;
+	interpolationMethod?: InterpolationMethod;
 }
 
 export interface LayerEffectInnerGlow {
@@ -94,6 +96,8 @@ export interface LayerEffectInnerGlow {
 	choke?: UnitsValue; // spread
 	jitter?: number;
 	contour?: EffectContour;
+	gradient?: EffectSolidGradient | EffectNoiseGradient;
+	interpolationMethod?: InterpolationMethod;
 }
 
 export interface LayerEffectBevel {
@@ -118,7 +122,10 @@ export interface LayerEffectBevel {
 	useTexture?: boolean;
 	useShape?: boolean;
 	antialiasGloss?: boolean;
-	contour?: EffectContour;
+	contour?: EffectContour; // gloss contour
+	shapeContour?: EffectContour; // contour of the bevel shape, used when `useShape` is enabled
+	range?: number;
+	antialiased?: boolean;
 }
 
 export interface LayerEffectSolidFill {
@@ -142,7 +149,7 @@ export interface LayerEffectStroke {
 	opacity?: number;
 	color?: Color;
 	gradient?: (EffectSolidGradient | EffectNoiseGradient) & ExtraGradientInfo;
-	pattern?: EffectPattern & {}; // TODO: additional pattern info
+	pattern?: EffectPattern & ExtraPatternInfo;
 }
 
 export interface LayerEffectSatin {
@@ -160,7 +167,6 @@ export interface LayerEffectSatin {
 	contour?: EffectContour;
 }
 
-// not supported yet because of `Patt` section not implemented
 export interface LayerEffectPatternOverlay {
 	present?: boolean;
 	showInDialog?: boolean;
@@ -168,6 +174,7 @@ export interface LayerEffectPatternOverlay {
 	blendMode?: BlendMode;
 	opacity?: number;
 	scale?: number;
+	angle?: number;
 	pattern?: EffectPattern;
 	phase?: { x: number; y: number; };
 	align?: boolean;
@@ -222,7 +229,7 @@ export interface LayerEffectsInfo {
 	satin?: LayerEffectSatin;
 	stroke?: LayerEffectStroke[];
 	gradientOverlay?: LayerEffectGradientOverlay[];
-	patternOverlay?: LayerEffectPatternOverlay; // not supported yet because of `Patt` section not implemented
+	patternOverlay?: LayerEffectPatternOverlay; // pattern is referenced only by name/id
 }
 
 export type PixelArray = Uint8ClampedArray | Uint8Array | Uint16Array | Float32Array;
@@ -250,7 +257,7 @@ export interface LayerMaskData {
 	imageData?: PixelData;
 }
 
-export type TextGridding = 'none' | 'round'; // TODO: other values (no idea where to set it up in Photoshop)
+export type TextGridding = 'none' | 'round';
 export type Orientation = 'horizontal' | 'vertical';
 export type AntiAlias = 'none' | 'sharp' | 'crisp' | 'strong' | 'smooth' | 'platform' | 'platformLCD';
 export type WarpStyle =
@@ -497,6 +504,8 @@ export interface ExtraGradientInfo {
 export interface ExtraPatternInfo {
 	linked?: boolean;
 	phase?: { x: number; y: number; };
+	scale?: number;
+	angle?: number;
 }
 
 export type VectorContent = { type: 'color'; color: Color; } |
@@ -506,7 +515,7 @@ export type VectorContent = { type: 'color'; color: Color; } |
 
 export type RenderingIntent = 'perceptual' | 'saturation' | 'relative colorimetric' | 'absolute colorimetric';
 
-export type Units = 'Pixels' | 'Points' | 'Picas' | 'Millimeters' | 'Centimeters' | 'Inches' | 'None' | 'Density';
+export type Units = 'Pixels' | 'Points' | 'Picas' | 'Millimeters' | 'Centimeters' | 'Inches' | 'None' | 'Density' | 'Distance'; // Distance is in points (1/72 inch)
 
 export interface UnitsValue {
 	units: Units;
@@ -538,22 +547,18 @@ export interface PresetInfo {
 
 export interface LevelsAdjustment extends PresetInfo {
 	type: 'levels';
-	// TODO: change to generic array of channels (because of other document type CMYK, Lab, etc)
-	rgb?: LevelsAdjustmentChannel;
-	red?: LevelsAdjustmentChannel;
-	green?: LevelsAdjustmentChannel;
-	blue?: LevelsAdjustmentChannel;
+	// levels for each channel, index 0 is composite channel, followed by document color channels (red, green, blue for RGB,
+	// cyan, magenta, yellow, black for CMYK, gray for Grayscale), missing channels use default values (no change)
+	channels?: LevelsAdjustmentChannel[];
 }
 
 export type CurvesAdjustmentChannel = { input: number; output: number; }[];
 
 export interface CurvesAdjustment extends PresetInfo {
 	type: 'curves';
-	// TODO: change to generic array of channels (because of other document type CMYK, Lab, etc)
-	rgb?: CurvesAdjustmentChannel;
-	red?: CurvesAdjustmentChannel;
-	green?: CurvesAdjustmentChannel;
-	blue?: CurvesAdjustmentChannel;
+	// curve for each channel, index 0 is composite channel, followed by document color channels (red, green, blue for RGB,
+	// cyan, magenta, yellow, black for CMYK, gray for Grayscale), missing or empty curve means no change to the channel
+	channels?: CurvesAdjustmentChannel[];
 }
 
 export interface ExposureAdjustment extends PresetInfo {
@@ -581,7 +586,17 @@ export interface HueSaturationAdjustmentChannel {
 
 export interface HueSaturationAdjustment extends PresetInfo {
 	type: 'hue/saturation';
-	master?: HueSaturationAdjustmentChannel;
+	colorize?: boolean;
+	colorization?: {
+		hue: number; // 0..360
+		saturation: number; // 0..100
+		lightness: number; // -100..100
+	};
+	master?: {
+		hue: number;
+		saturation: number;
+		lightness: number;
+	};
 	reds?: HueSaturationAdjustmentChannel;
 	yellows?: HueSaturationAdjustmentChannel;
 	greens?: HueSaturationAdjustmentChannel;
@@ -670,6 +685,7 @@ export interface ColorStop {
 	color: Color;
 	location: number;
 	midpoint: number;
+	type?: 'foreground' | 'background'; // stop uses foreground/background color (`color` is the color at the time of saving)
 }
 
 export interface OpacityStop {
@@ -737,6 +753,15 @@ export type LinkedFile = {
 	};
 }
 
+export interface LevelsFilterAdjustment {
+	channels: ('composite' | 'red' | 'green' | 'blue')[];
+	shadowInput?: number; // 0..255
+	highlightInput?: number; // 0..255
+	shadowOutput?: number; // 0..255
+	highlightOutput?: number; // 0..255
+	midtoneInput?: number; // gamma, 1 by default
+}
+
 type FilterVariant = {
 	type: 'average' | 'blur' | 'blur more';
 } | {
@@ -1164,7 +1189,7 @@ type FilterVariant = {
 } | {
 	type: 'curves';
 	filter: {
-		presetKind: 'custom' | 'default';
+		presetKind?: 'custom' | 'default';
 		adjustments?: ({
 			channels: ('composite' | 'red' | 'green' | 'blue')[];
 			curve: { x: number; y: number; curved?: boolean; }[];
@@ -1173,6 +1198,12 @@ type FilterVariant = {
 			values: number[];
 		})[];
 	};
+} | {
+	type: 'levels';
+	filter: {
+		presetKind?: 'custom' | 'default';
+		adjustments?: LevelsFilterAdjustment[];
+	};
 } | {
 	type: 'invert';
 } | {
@@ -1234,6 +1265,7 @@ export interface PlacedLayer {
 	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;
+	external?: boolean; // linked smart object (linked file is stored outside of the document)
 	pageNumber?: number;
 	totalPages?: number;
 	frameStep?: { numerator: number; denominator: number; };
@@ -1262,7 +1294,7 @@ export type LayerColor = 'none' | 'red' | 'orange' | 'yellow' | 'green' | 'blue'
 
 export interface KeyDescriptorItem {
 	keyShapeInvalidated?: boolean;
-	keyOriginType?: number;
+	keyOriginType?: number; // shape type: 1 - rectangle, 2 - rounded rectangle, 4 - line, 5 - ellipse, 8 - polygon
 	keyOriginResolution?: number;
 	keyOriginRRectRadii?: {
 		topRight: UnitsValue;
@@ -1280,10 +1312,7 @@ export interface KeyDescriptorItem {
 	transform?: number[]; // 2d transform matrix [xx, xy, yx, yy, tx, ty]
 }
 
-export interface LayerVectorMask {
-	invert?: boolean;
-	notLink?: boolean;
-	disable?: boolean;
+export interface VectorPathData {
 	fillStartsWithAllPixels?: boolean;
 	clipboard?: {
 		top: number;
@@ -1295,6 +1324,20 @@ export interface LayerVectorMask {
 	paths: BezierPath[];
 }
 
+export interface LayerVectorMask extends VectorPathData {
+	invert?: boolean;
+	notLink?: boolean;
+	disable?: boolean;
+}
+
+export interface SavedPath extends VectorPathData {
+	name: string;
+	symmetryMode?: string; // raw enum value, e.g. 'pathSymmetryModeBasicPath'
+	vectorOrigination?: {
+		keyDescriptorList: KeyDescriptorItem[];
+	};
+}
+
 export interface AnimationFrame {
 	frames: number[]; // IDs of frames that this modifiers applies to
 	enable?: boolean;
@@ -1376,6 +1419,7 @@ export interface LayerAdditionalInfo {
 		composite?: boolean;
 		position?: boolean;
 		artboards?: boolean;
+		all?: boolean;
 	};
 	layerColor?: LayerColor;
 	referencePoint?: {
@@ -1393,7 +1437,7 @@ export interface LayerAdditionalInfo {
 	};
 	effects?: LayerEffectsInfo;
 	text?: LayerTextData;
-	patterns?: PatternInfo[]; // not supported yet
+	patterns?: PatternInfo[];
 	vectorFill?: VectorContent;
 	vectorStroke?: {
 		strokeEnabled?: boolean;
@@ -1415,9 +1459,15 @@ export interface LayerAdditionalInfo {
 	vectorMask?: LayerVectorMask;
 	usingAlignedRendering?: boolean;
 	timestamp?: number; // seconds
-	pathList?: {
-		// TODO: ...
-	}[];
+	generatorSettings?: { // Generator (Export As) settings
+		exportAs?: {
+			exportOption?: string; // JSON string
+			scaleSettings?: string; // JSON string
+		};
+		assets?: string; // JSON string, Generator image assets settings (only on document)
+		layerTime?: number; // seconds
+		crema?: string; // JSON string, Export As document settings (only on document)
+	};
 	adjustment?: AdjustmentLayer;
 	placedLayer?: PlacedLayer;
 	vectorOrigination?: {
@@ -1525,6 +1575,20 @@ export enum LayerCompCapturedInfo {
 	Appearance = 4,
 }
 
+export interface HalftoneScreen {
+	frequency: number;
+	frequencyUnits: 'lines/inch' | 'lines/cm';
+	angle: number; // degrees
+	shape: 'round' | 'ellipse' | 'line' | 'square' | 'cross' | 'diamond';
+	accurateScreens: boolean;
+	printerDefaultScreens: boolean;
+}
+
+export interface PrintTransferFunction {
+	curve: number[]; // 13 points, values 0..1000 (0% - 100%), -1 for missing points (first and last point are always set)
+	override: boolean;
+}
+
 export interface ImageResources {
 	layerState?: number;
 	layerSelectionIds?: number[];
@@ -1554,6 +1618,8 @@ export interface ImageResources {
 		guides?: {
 			location: number;
 			direction: 'horizontal' | 'vertical';
+			color?: RGB; // Photoshop default is cyan (74, 255, 255)
+			id?: string; // unique id (GUID)
 		}[];
 	};
 	resolutionInfo?: {
@@ -1578,6 +1644,7 @@ export interface ImageResources {
 		printerManagesColors?: boolean;
 		printerName?: string;
 		printerProfile?: string;
+		printerProfileColorSpace?: 'rgb' | 'grayscale'; // color space of printer profile, missing value means 'rgb'
 		printSixteenBit?: boolean;
 		renderingIntent?: RenderingIntent;
 		hardProof?: boolean;
@@ -1605,7 +1672,63 @@ export interface ImageResources {
 		printFlags?: boolean;
 	};
 	iccUntaggedProfile?: boolean;
+	colorSamplers?: {
+		x: number; // pixels
+		y: number; // pixels
+		colorSpace: number; // -1 - actual color, 0 - RGB, 1 - HSB, 2 - CMYK, 7 - Lab, 8 - grayscale, ...
+	}[];
+	effectsVisible?: boolean; // global flag to show or hide all layer effects
+	iccProfile?: Uint8Array; // raw ICC profile data
+	exifData?: Uint8Array; // raw EXIF data (TIFF format)
+	iptcData?: Uint8Array; // raw IPTC-NAA record
+	windowsDevMode?: Uint8Array; // raw Windows DEVMODE structure (printer settings)
+	outputSettings?: any; // Save for Web output settings (raw descriptor)
+	colorHalftoneScreens?: HalftoneScreen[]; // cyan, magenta, yellow and black
+	grayscaleHalftoneScreens?: HalftoneScreen[];
+	colorTransferFunctions?: PrintTransferFunction[]; // one for each of 4 printing plates
+	grayscaleTransferFunctions?: PrintTransferFunction[];
+	printStyle?: {
+		caption?: boolean;
+		calibrationBars?: boolean;
+		registrationMarks?: boolean;
+		cornerCropMarks?: boolean;
+		centerCropMarks?: boolean;
+		labels?: boolean;
+		negative?: boolean;
+		emulsionDown?: boolean;
+		interpolate?: boolean;
+		backgroundColor?: Color;
+		border?: UnitsValue;
+		bleed?: UnitsValue;
+		resolution?: UnitsValue;
+		vectorData?: boolean;
+		pagePosition?: string; // 'centered' or raw enum value
+		left?: UnitsValue;
+		top?: UnitsValue;
+		scale?: number; // 0..1
+		cropWhenPrinting?: boolean;
+		cropRect?: { top: number; left: number; bottom: number; right: number; };
+	};
+	printFlagsInfo?: {
+		centerCropMarks: boolean;
+		bleedWidth: number;
+		bleedWidthScale: number;
+	};
+	indexedColorCount?: number; // number of used colors in indexed color palette
+	transparencyIndex?: number; // index of transparent color in indexed color palette
+	alphaChannelDisplayInfo?: {
+		color?: Color;
+		rawColor?: { colorSpace: number; values: number[]; }; // color in color space not supported by this library (instead of `color`)
+		opacity: number; // 0..1
+		kind: 'selected' | 'protected' | 'spot'; // color indicates selected areas, protected (masked) areas or spot color
+	}[];
 	pathSelectionState?: string[];
+	savedPaths?: SavedPath[]; // paths from the paths panel
+	workPath?: VectorPathData;
+	clippingPath?: {
+		name: string; // name of the saved path used as clipping path
+		flatness: number; // device pixels, 0 for printer default
+	};
 	imageReadyVariables?: string;
 	imageReadyDataSets?: string;
 	animations?: Animations;
@@ -1794,7 +1917,7 @@ export interface Psd extends LayerAdditionalInfo {
 	imageData?: PixelData;
 	rawCompositeData?: Uint8Array;
 	/** Information needed to decode `rawCompositeData` (see `getCompositeImageData`) */
-	rawCompositeDataInfo?: { large: boolean; globalAlpha: boolean; };
+	rawCompositeDataInfo?: { large: boolean; globalAlpha: boolean; layersInGlobalInfo?: boolean; };
 	imageResources?: ImageResources;
 	linkedFiles?: LinkedFile[]; // used in smart objects
 	artboards?: {
@@ -1865,4 +1988,7 @@ export interface WriteOptions {
 	/** Uses zip compression when writing PSD file, will result in smaller file size but may be incompatible
 	 *  with some software. It may also be significantly slower. */
 	compress?: boolean;
+
+	/** Used only for development. */
+	log?: (...args: any[]) => void;
 }