exiftool-vendored 32.1.0 → 33.1.0

package/CHANGELOG.md

@@ -35,6 +35,19 @@ vendored versions of ExifTool match the version that they vendor.
 
 ## History
 
+### v33.1.0
+
+- 🐞 Fixed `GPSTimeStamp` to be `ExifTime | string`
+- 🐞 Removed `GPSPositionRef` (not a thing!)
+
+### v33.0.0
+
+- 🐞/💔 `SubSecMediaCreateDate` was removed from `CompositeTags` and `Tags`. It apparently never _was_ a thing, and, worse: I can't blame AI for hallucinating it, because I added it several years ago. Oops!
+- ✨ `mktags` was enhanced to detect and avoid duplicate field definitions from included static interfaces.
+- ✨ Increased MAX_TAGS from 2500 to 2700 to accommodate additional tags, so there's a bunch of new tags in there! Please open an issue if you see `error TS2590: Expression produces a union type that is too complex to represent` (please be sure to include a reproduction!)
+- 📦 Added jsdocs to many, many fields.
+- 🐞 `mktags` calculates `@frequency` correctly now (it was measuring "average occurrences per file across all groups" rather than "percentage of files containing this tag" -- this led to some tags having a frequency of 200% (!!))
+
 ### v32.1.0
 
 - 🐞 Async `disposable` timeouts are now cancelled properly. Prior versions could prevent the process from exiting until the timeout elapsed.

package/dist/CapturedAtTagNames.d.ts

@@ -1 +1 @@
-export declare const CapturedAtTagNames: readonly ["SubSecDateTimeOriginal", "SubSecCreateDate", "SubSecMediaCreateDate", "DateTimeOriginal", "CreateDate", "MediaCreateDate", "CreationDate", "DateTimeCreated", "TimeCreated"];
+export declare const CapturedAtTagNames: readonly ["SubSecDateTimeOriginal", "SubSecCreateDate", "DateTimeOriginal", "CreateDate", "MediaCreateDate", "CreationDate", "DateTimeCreated", "TimeCreated"];

package/dist/CapturedAtTagNames.js

@@ -4,7 +4,6 @@ exports.CapturedAtTagNames = void 0;
 exports.CapturedAtTagNames = [
     "SubSecDateTimeOriginal",
     "SubSecCreateDate",
-    "SubSecMediaCreateDate",
     "DateTimeOriginal",
     "CreateDate",
     "MediaCreateDate",

package/dist/CapturedAtTagNames.js.map

@@ -1 +1 @@
-{"version":3,"file":"CapturedAtTagNames.js","sourceRoot":"","sources":["../src/CapturedAtTagNames.ts"],"names":[],"mappings":";;;AAEa,QAAA,kBAAkB,GAAG;IAChC,wBAAwB;IACxB,kBAAkB;IAClB,uBAAuB;IACvB,kBAAkB;IAClB,YAAY;IACZ,iBAAiB;IACjB,cAAc,EAAE,0CAA0C;IAC1D,iBAAiB;IACjB,aAAa,EAAE,0BAA0B;CACC,CAAC"}
+{"version":3,"file":"CapturedAtTagNames.js","sourceRoot":"","sources":["../src/CapturedAtTagNames.ts"],"names":[],"mappings":";;;AAEa,QAAA,kBAAkB,GAAG;IAChC,wBAAwB;IACxB,kBAAkB;IAClB,kBAAkB;IAClB,YAAY;IACZ,iBAAiB;IACjB,cAAc,EAAE,0CAA0C;IAC1D,iBAAiB;IACjB,aAAa,EAAE,0BAA0B;CACC,CAAC"}

package/dist/DefaultCreateDateTagNames.d.ts

@@ -1,4 +1,4 @@
 /**
  * @deprecated use {@link CapturedAtTagNames} instead.
  */
-export declare const DefaultCreateDateTagNames: readonly ["SubSecDateTimeOriginal", "SubSecCreateDate", "SubSecMediaCreateDate", "DateTimeOriginal", "CreateDate", "MediaCreateDate", "CreationDate", "DateTimeCreated", "TimeCreated"];
+export declare const DefaultCreateDateTagNames: readonly ["SubSecDateTimeOriginal", "SubSecCreateDate", "DateTimeOriginal", "CreateDate", "MediaCreateDate", "CreationDate", "DateTimeCreated", "TimeCreated"];

package/dist/Equal.d.ts

@@ -0,0 +1 @@
+export type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false;

package/dist/Equal.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Equal.js.map

package/dist/Equal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Equal.js","sourceRoot":"","sources":["../src/Equal.ts"],"names":[],"mappings":""}

package/dist/ExifToolVendoredTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExifToolVendoredTags.js","sourceRoot":"","sources":["../src/ExifToolVendoredTags.ts"],"names":[],"mappings":";;;AACA,uCAA0D;AAkC7C,QAAA,wBAAwB,GAAG,IAAA,iBAAO,EAC7C,IAAI,EACJ,MAAM,EACN,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,UAAU,CACmC,CAAC"}
+{"version":3,"file":"ExifToolVendoredTags.js","sourceRoot":"","sources":["../src/ExifToolVendoredTags.ts"],"names":[],"mappings":";;;AAGA,uCAA0D;AAkC7C,QAAA,wBAAwB,GAAG,IAAA,iBAAO,EAC7C,IAAI,EACJ,MAAM,EACN,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,UAAU,CACmC,CAAC"}

package/dist/Expect.d.ts

@@ -0,0 +1 @@
+export type Expect<T extends true> = T;

package/dist/Expect.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Expect.js.map

package/dist/Expect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Expect.js","sourceRoot":"","sources":["../src/Expect.ts"],"names":[],"mappings":""}

package/dist/GeolocationTags.d.ts

@@ -6,38 +6,90 @@ import { StrEnum, StrEnumKeys } from "./StrEnum";
  * @see https://exiftool.org/geolocation.html#Read
  */
 export interface GeolocationTags {
-    /** ☆☆☆☆ ✔ Example: 99 */
+    /**
+     * ☆☆☆☆ ✔ Example: 99
+     *
+     * Compass bearing in degrees from the input GPS position to the returned
+     * city's coordinates. Only generated when GPS coordinates are provided as input.
+     */
     GeolocationBearing?: number;
-    /** ☆☆☆☆ ✔ Example: "Zürich" */
+    /**
+     * ☆☆☆☆ ✔ Example: "Zürich"
+     *
+     * The name of the nearest city or populated place found in the geonames database.
+     * Note: The term "City" here may more aptly be called "Feature Name" since the
+     * database may include features which are not cities.
+     */
     GeolocationCity?: string;
     /** ☆☆☆☆ ✔ Example: "United States" */
     GeolocationCountry?: string;
-    /** ☆☆☆☆ ✔ Example: "US" */
+    /**
+     * ☆☆☆☆ ✔ Example: "US"
+     *
+     * Two-letter ISO country code for the location.
+     */
     GeolocationCountryCode?: string;
-    /** ☆☆☆☆ ✔ Example: "9.60 km" */
+    /**
+     * ☆☆☆☆ ✔ Example: "9.60 km"
+     *
+     * The distance in kilometers from the input GPS point to the GeolocationPosition
+     * of the returned city. Only generated when GPS coordinates are provided as input.
+     */
     GeolocationDistance?: string;
     /**
      * ☆☆☆☆ ✔ Example: "PPLL"
      * @see http://www.geonames.org/export/codes.html#P
      */
     GeolocationFeatureCode?: string;
-    /** ☆☆☆☆ ✔ Example: "Populated Place" */
+    /**
+     * ☆☆☆☆ ✔ Example: "Populated Place"
+     *
+     * Human-readable description of the GeolocationFeatureCode, such as
+     * "Populated Place" or "Seat Of A First-order Administrative Division".
+     */
     GeolocationFeatureType?: string;
-    /** ☆☆☆☆ ✔ Example: 95000 */
+    /**
+     * ☆☆☆☆ ✔ Example: 95000
+     *
+     * Population of the identified city or feature, rounded to 2 significant digits.
+     * Based on geonames database entries for reference purposes.
+     */
     GeolocationPopulation?: number;
-    /** ☆☆☆☆ ✔ Example: "7.3397, 134.4733" */
+    /**
+     * ☆☆☆☆ ✔ Example: "7.3397, 134.4733"
+     *
+     * Latitude and longitude coordinates of the identified city, formatted as
+     * "latitude, longitude" in decimal degrees.
+     */
     GeolocationPosition?: string;
-    /** ☆☆☆☆ ✔ Example: "Île-de-France" */
+    /**
+     * ☆☆☆☆ ✔ Example: "Île-de-France"
+     *
+     * Administrative division corresponding to state or province in North America.
+     * Derived from the geonames database.
+     */
     GeolocationRegion?: string;
-    /** ☆☆☆☆ ✔ Example: "Yokohama Shi" */
-    GeolocationSubregion?: string;
-    /** ☆☆☆☆ ✔ Example: "Pacific/Saipan"
+    /**
+     * ☆☆☆☆ ✔ Example: "Yokohama Shi"
      *
-     * IANA time zone name
+     * Secondary administrative division (typically county in North America).
+     * The meaning varies by country.
+     */
+    GeolocationSubregion?: string;
+    /**
+     * IANA timezone name associated with the matched city location from the geonames database.
      *
      * @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+     * @example "Pacific/Saipan"
      */
     GeolocationTimeZone?: string;
+    /**
+     * Warning messages related to geolocation processing, if any issues occur
+     * during lookup or if the geolocation data may be unreliable.
+     *
+     * Note: This tag is not documented in the official ExifTool geolocation
+     * documentation and may not be consistently returned.
+     */
     GeolocationWarning?: string;
 }
 export declare const GeolocationTagNames: StrEnum<"GeolocationBearing" | "GeolocationCity" | "GeolocationCountry" | "GeolocationCountryCode" | "GeolocationDistance" | "GeolocationFeatureCode" | "GeolocationFeatureType" | "GeolocationPopulation" | "GeolocationPosition" | "GeolocationRegion" | "GeolocationSubregion" | "GeolocationTimeZone" | "GeolocationWarning">;

package/dist/GeolocationTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"GeolocationTags.js","sourceRoot":"","sources":["../src/GeolocationTags.ts"],"names":[],"mappings":";;;AA8DA,4CAEC;AAhED,uCAA0D;AA4C7C,QAAA,mBAAmB,GAAG,IAAA,iBAAO,EACxC,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,wBAAwB,EACxB,wBAAwB,EACxB,uBAAuB,EACvB,qBAAqB,EACrB,mBAAmB,EACnB,sBAAsB,EACtB,qBAAqB,EACrB,oBAAoB,CACoB,CAAC;AAI3C,SAAgB,gBAAgB,CAAC,GAAW;IAC1C,OAAO,2BAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACtC,CAAC"}
+{"version":3,"file":"GeolocationTags.js","sourceRoot":"","sources":["../src/GeolocationTags.ts"],"names":[],"mappings":";;;AAoHA,4CAEC;AApHD,uCAA0D;AAgG7C,QAAA,mBAAmB,GAAG,IAAA,iBAAO,EACxC,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,wBAAwB,EACxB,wBAAwB,EACxB,uBAAuB,EACvB,qBAAqB,EACrB,mBAAmB,EACnB,sBAAsB,EACtB,qBAAqB,EACrB,oBAAoB,CACoB,CAAC;AAI3C,SAAgB,gBAAgB,CAAC,GAAW;IAC1C,OAAO,2BAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACtC,CAAC"}

package/dist/ICCProfileTags.d.ts

@@ -5,23 +5,112 @@ import { StrEnum, StrEnumKeys } from "./StrEnum";
  * None of these tags are writable.
  */
 export interface ICCProfileTags {
-    /** ☆☆☆☆ ✔ Example: "RGB " */
+    /**
+     * The color space of the device associated with this ICC profile.
+     *
+     * Common values include "RGB ", "CMYK", "Gray", "Lab ", "XYZ ", and others.
+     * Note that color space names are often padded to 4 characters.
+     *
+     * @see https://exiftool.org/TagNames/ICC_Profile.html
+     *
+     * ☆☆☆☆ ✔ Example: "RGB "
+     */
     ColorSpaceData?: string;
-    /** ☆☆☆☆ ✔ Example: "0.9642 1 0.82491" */
+    /**
+     * XYZ values of the illuminant of the Profile Connection Space (PCS).
+     *
+     * This is typically the D50 standard illuminant (0.9642, 1.0, 0.8249) used
+     * as the reference white point for ICC color transformations. The three
+     * numbers represent the X, Y, and Z tristimulus values.
+     *
+     * @see https://exiftool.org/TagNames/ICC_Profile.html
+     *
+     * ☆☆☆☆ ✔ Example: "0.9642 1 0.82491"
+     */
     ConnectionSpaceIlluminant?: string;
-    /** ☆☆☆☆ ✔ Example: "Reflective, Glossy, Positive, Color" */
+    /**
+     * Physical characteristics of the device (reflective vs. transmissive,
+     * glossy vs. matte, positive vs. negative media, color vs. black-and-white).
+     *
+     * These attributes help color management systems understand the nature of
+     * the device and apply appropriate color transformations.
+     *
+     * @see https://exiftool.org/TagNames/ICC_Profile.html
+     *
+     * ☆☆☆☆ ✔ Example: "Reflective, Glossy, Positive, Color"
+     */
     DeviceAttributes?: string;
-    /** ☆☆☆☆ ✔ Example: "none" */
+    /**
+     * Manufacturer signature code identifying the device manufacturer.
+     *
+     * This is typically a 4-character code registered with the ICC, or "none"
+     * for generic profiles. Common manufacturers include Adobe, Apple, Canon,
+     * Nikon, and others.
+     *
+     * @see https://exiftool.org/TagNames/ICC_Profile.html
+     *
+     * ☆☆☆☆ ✔ Example: "none"
+     */
     DeviceManufacturer?: string;
-    /** ☆☆☆☆ ✔ Example: "IEC http://www.iec.ch" */
+    /**
+     * Human-readable description of the device manufacturer.
+     *
+     * This provides a full text description of the manufacturer, often
+     * including URLs or additional contact information, complementing the
+     * 4-character DeviceManufacturer signature code.
+     *
+     * @see https://exiftool.org/TagNames/ICC_Profile.html
+     *
+     * ☆☆☆☆ ✔ Example: "IEC http://www.iec.ch"
+     */
     DeviceMfgDesc?: string;
-    /** ☆☆☆☆ ✔ Example: "sRGB" */
+    /**
+     * Device model signature code.
+     *
+     * This is typically a 4-character code or short identifier that specifies
+     * the particular device model. Works in conjunction with DeviceManufacturer
+     * for complete device identification.
+     *
+     * @see https://exiftool.org/TagNames/ICC_Profile.html
+     *
+     * ☆☆☆☆ ✔ Example: "sRGB"
+     */
     DeviceModel?: string;
-    /** ☆☆☆☆ ✔ Example: "sRGB v1.31 (Canon)" */
+    /**
+     * Human-readable description of the device model.
+     *
+     * This provides a full text description of the device model, complementing
+     * the shorter DeviceModel field with more detailed information such as
+     * version numbers and manufacturer names.
+     *
+     * @see https://exiftool.org/TagNames/ICC_Profile.html
+     *
+     * ☆☆☆☆ ✔ Example: "sRGB v1.31 (Canon)"
+     */
     DeviceModelDesc?: string;
-    /** ☆☆☆☆ ✔ Example: "76.03647 80 87.12462" */
+    /**
+     * Absolute luminance of emissive devices in XYZ tristimulus coordinates.
+     *
+     * The three numbers represent X, Y, and Z values, where the Y component
+     * directly corresponds to the luminance in cd/m² as defined by CIE
+     * absolute colorimetry.
+     *
+     * @see https://exiftool.org/TagNames/ICC_Profile.html
+     *
+     * ☆☆☆☆ ✔ Example: "76.03647 80 87.12462"
+     */
     Luminance?: string;
-    /** ☆☆☆☆ ✔ Example: "sRGB v1.31 (Canon)" */
+    /**
+     * Human-readable description of the ICC profile.
+     *
+     * This is the primary name and description of the color profile, typically
+     * including the profile name, version, and sometimes the intended use case
+     * or device it was created for.
+     *
+     * @see https://exiftool.org/TagNames/ICC_Profile.html
+     *
+     * ☆☆☆☆ ✔ Example: "sRGB v1.31 (Canon)"
+     */
     ProfileDescription?: string;
 }
 export declare const ICCProfileTagNames: StrEnum<"ColorSpaceData" | "ConnectionSpaceIlluminant" | "DeviceAttributes" | "DeviceManufacturer" | "DeviceMfgDesc" | "DeviceModel" | "DeviceModelDesc" | "Luminance" | "ProfileDescription">;

package/dist/ICCProfileTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"ICCProfileTags.js","sourceRoot":"","sources":["../src/ICCProfileTags.ts"],"names":[],"mappings":";;;AAAA,uCAA0D;AA4B7C,QAAA,kBAAkB,GAAG,IAAA,iBAAO,EACvC,gBAAgB,EAChB,2BAA2B,EAC3B,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,aAAa,EACb,iBAAiB,EACjB,WAAW,EACX,oBAAoB,CACmB,CAAC"}
+{"version":3,"file":"ICCProfileTags.js","sourceRoot":"","sources":["../src/ICCProfileTags.ts"],"names":[],"mappings":";;;AAEA,uCAA0D;AA6H7C,QAAA,kBAAkB,GAAG,IAAA,iBAAO,EACvC,gBAAgB,EAChB,2BAA2B,EAC3B,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,aAAa,EACb,iBAAiB,EACjB,WAAW,EACX,oBAAoB,CACmB,CAAC"}

package/dist/IPTCApplicationRecordTags.d.ts

@@ -20,51 +20,179 @@ export interface IPTCApplicationRecordTags {
     EditStatus?: string;
     EditorialUpDate?: ExifDateTime | ExifDate;
     /**
-     * "0 (reserved)" | "1 (most urgent)" | "2" | "3" | "4" | "5 (normal urgency)" | "6" | "7" | "8 (least urgent)" | "9 (user-defined priority)"
+     * Editorial urgency rating (1-9 scale, deprecated).
+     *
+     * @remarks Valid values: '1' (Highest), '2'-'4', '5' (Normal), '6'-'7', '8' (Lowest), '9' (User defined).
+     * Note: This field was deprecated when IPTC Core 1.0 was released in 2005.
      */
     Urgency?: string;
+    /**
+     * Structured subject classification reference (13-236+ characters).
+     *
+     * @remarks Used for formal subject taxonomies and classification systems.
+     */
     SubjectReference?: string;
+    /**
+     * Content category code.
+     *
+     * @remarks Max 3 characters. Single category code for primary content classification.
+     * Note: This field was deprecated when IPTC Core 1.0 was released in 2005.
+     */
     Category?: string;
+    /**
+     * Additional category assignments for the content.
+     *
+     * @remarks Max 32 characters per entry, repeatable. Supplements the primary Category field.
+     * Note: This field was deprecated when IPTC Core 1.0 was released in 2005.
+     */
     SupplementalCategories?: string;
+    /**
+     * Identifier for recurring or regularly updated content (e.g., "Daily Market Report").
+     *
+     * @remarks Max 32 characters. Used to identify content that appears repeatedly or is part of a series.
+     */
     FixtureIdentifier?: string;
     ContentLocationCode?: string;
     ContentLocationName?: string;
+    /**
+     * Date when the content is eligible for publication (format: YYYYMMDD).
+     */
     ReleaseDate?: ExifDateTime | ExifDate;
+    /**
+     * Time when the content is eligible for publication (includes timezone offset).
+     */
     ReleaseTime?: ExifDateTime | ExifTime;
+    /**
+     * Date when the content validity expires (format: YYYYMMDD).
+     */
     ExpirationDate?: ExifDateTime | ExifDate;
+    /**
+     * Time when the content validity expires (includes timezone offset).
+     */
     ExpirationTime?: string | ExifDateTime | ExifTime;
+    /**
+     * Editorial handling or usage instructions for the image.
+     *
+     * @remarks Max 256 characters. Used for special directives about how the content should be used or handled.
+     */
     SpecialInstructions?: string;
+    /**
+     * Action required for this content.
+     *
+     * @remarks Valid values: 01 (Kill/delete), 02 (Replace with new version), 03 (Append to existing), 04 (Reference only)
+     */
     ActionAdvised?: number;
     ReferenceService?: string;
     ReferenceDate?: ExifDateTime | ExifDate;
     ReferenceNumber?: number;
     OriginatingProgram?: string;
     ProgramVersion?: string;
+    /**
+     * Publication cycle timing.
+     *
+     * @remarks Valid values: 'a' (morning), 'b' (both morning and evening), 'p' (evening)
+     */
     ObjectCycle?: string;
+    /**
+     * Creator or photographer name (e.g., "John Smith").
+     *
+     * @remarks Despite the hyphenated name, this is the standard field for crediting the image creator. Max 32 characters per entry, repeatable.
+     */
     "By-line"?: string;
+    /**
+     * Creator's professional title (e.g., "Staff Photographer", "Freelance Journalist").
+     *
+     * @remarks Max 32 characters per entry, repeatable.
+     */
     "By-lineTitle"?: string;
     City?: string;
+    /**
+     * Location details within a city (e.g., "Central Park", "Brooklyn Bridge", "Building 5").
+     *
+     * @remarks Max 32 characters. Use for specific locations more granular than city level.
+     */
     "Sub-location"?: string;
+    /**
+     * Province, state, or administrative region name (e.g., "California", "Ontario", "Bavaria").
+     *
+     * @remarks Max 32 characters.
+     */
     "Province-State"?: string;
+    /**
+     * ISO 3166 country code (typically 3-character alpha-3 format like "USA", "GBR", "JPN").
+     *
+     * @remarks The field expects 3-character codes per IPTC IIM specification, though ISO 3166 also defines 2-character alpha-2 codes.
+     */
     "Country-PrimaryLocationCode"?: string;
+    /**
+     * Full country name (e.g., "United States", "United Kingdom", "Japan").
+     *
+     * @remarks Max 64 characters.
+     */
     "Country-PrimaryLocationName"?: string;
+    /**
+     * Originally for transmission reference, now commonly used as a job identifier or assignment code.
+     *
+     * @remarks Max 32 characters.
+     */
     OriginalTransmissionReference?: string;
     Headline?: string;
+    /**
+     * Provider or agency that supplied the image (e.g., "Associated Press", "Getty Images").
+     *
+     * @remarks Max 32 characters. Acknowledges the source provider.
+     */
     Credit?: string;
+    /**
+     * Original owner or source of the image (e.g., "Reuters", "NASA").
+     *
+     * @remarks Max 32 characters. Indicates the originating source, distinct from the provider.
+     */
     Source?: string;
     CopyrightNotice?: string;
     Contact?: string;
+    /**
+     * Detailed description or caption of the image content.
+     *
+     * @remarks Max 2000 characters. Despite the hyphenated name, this is the standard field for comprehensive image descriptions.
+     */
     "Caption-Abstract"?: string;
     LocalCaption?: string;
+    /**
+     * Caption writer or editor name (e.g., "Jane Doe").
+     *
+     * @remarks Max 32 characters per entry, repeatable. Credits the person who wrote or edited the caption, not the photographer.
+     */
     "Writer-Editor"?: string;
     ImageType?: string;
-    /** 'L' = Landscape, 'P' = Portrait, 'S' = Square. */
+    /**
+     * Image orientation.
+     *
+     * @remarks Valid values: 'L' (Landscape), 'P' (Portrait), 'S' (Square)
+     */
     ImageOrientation?: string;
     LanguageIdentifier?: string;
+    /**
+     * Audio format type (2 characters indicating mono/stereo with content type).
+     */
     AudioType?: string;
+    /**
+     * Audio sampling frequency in Hz (6 digits).
+     */
     AudioSamplingRate?: number;
+    /**
+     * Audio bit resolution (2 digits, e.g., 16 for 16-bit audio).
+     */
     AudioSamplingResolution?: number;
+    /**
+     * Audio length in HHMMSS format (6 digits).
+     */
     AudioDuration?: number;
+    /**
+     * Ending audio identifier or outcue text.
+     *
+     * @remarks Max 64 characters. Identifies what audio ends with, useful for broadcast synchronization.
+     */
     AudioOutcue?: string;
     JobID?: string;
     MasterDocumentID?: string;
@@ -80,5 +208,5 @@ export interface IPTCApplicationRecordTags {
     DocumentHistory?: string;
     ExifCameraInfo?: string;
 }
-export declare const IPTCApplicationRecordTagNames: StrEnum<"Category" | "ApplicationRecordVersion" | "ObjectTypeReference" | "ObjectAttributeReference" | "ObjectName" | "EditStatus" | "EditorialUpDate" | "Urgency" | "SubjectReference" | "SupplementalCategories" | "FixtureIdentifier" | "ContentLocationCode" | "ContentLocationName" | "ReleaseDate" | "ReleaseTime" | "ExpirationDate" | "ExpirationTime" | "SpecialInstructions" | "ActionAdvised" | "ReferenceService" | "ReferenceDate" | "ReferenceNumber" | "OriginatingProgram" | "ProgramVersion" | "ObjectCycle" | "By-line" | "By-lineTitle" | "City" | "Sub-location" | "Province-State" | "Country-PrimaryLocationCode" | "Country-PrimaryLocationName" | "OriginalTransmissionReference" | "Headline" | "Credit" | "Source" | "CopyrightNotice" | "Contact" | "Caption-Abstract" | "LocalCaption" | "Writer-Editor" | "ImageType" | "ImageOrientation" | "LanguageIdentifier" | "AudioType" | "AudioSamplingRate" | "AudioSamplingResolution" | "AudioDuration" | "AudioOutcue" | "JobID" | "MasterDocumentID" | "ShortDocumentID" | "UniqueDocumentID" | "OwnerID" | "ObjectPreviewFileFormat" | "ObjectPreviewFileVersion" | "Prefs" | "ClassifyState" | "SimilarityIndex" | "DocumentNotes" | "DocumentHistory" | "ExifCameraInfo">;
+export declare const IPTCApplicationRecordTagNames: StrEnum<"ApplicationRecordVersion" | "ObjectTypeReference" | "ObjectAttributeReference" | "ObjectName" | "EditStatus" | "EditorialUpDate" | "Urgency" | "SubjectReference" | "Category" | "SupplementalCategories" | "FixtureIdentifier" | "ContentLocationCode" | "ContentLocationName" | "ReleaseDate" | "ReleaseTime" | "ExpirationDate" | "ExpirationTime" | "SpecialInstructions" | "ActionAdvised" | "ReferenceService" | "ReferenceDate" | "ReferenceNumber" | "OriginatingProgram" | "ProgramVersion" | "ObjectCycle" | "By-line" | "By-lineTitle" | "City" | "Sub-location" | "Province-State" | "Country-PrimaryLocationCode" | "Country-PrimaryLocationName" | "OriginalTransmissionReference" | "Headline" | "Credit" | "Source" | "CopyrightNotice" | "Contact" | "Caption-Abstract" | "LocalCaption" | "Writer-Editor" | "ImageType" | "ImageOrientation" | "LanguageIdentifier" | "AudioType" | "AudioSamplingRate" | "AudioSamplingResolution" | "AudioDuration" | "AudioOutcue" | "JobID" | "MasterDocumentID" | "ShortDocumentID" | "UniqueDocumentID" | "OwnerID" | "ObjectPreviewFileFormat" | "ObjectPreviewFileVersion" | "Prefs" | "ClassifyState" | "SimilarityIndex" | "DocumentNotes" | "DocumentHistory" | "ExifCameraInfo">;
 export type IPTCApplicationRecordTagName = StrEnumKeys<typeof IPTCApplicationRecordTagNames>;

package/dist/IPTCApplicationRecordTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"IPTCApplicationRecordTags.js","sourceRoot":"","sources":["../src/IPTCApplicationRecordTags.ts"],"names":[],"mappings":";;;AAGA,uCAA0D;AAiF7C,QAAA,6BAA6B,GAAG,IAAA,iBAAO,EAClD,0BAA0B,EAC1B,qBAAqB,EACrB,0BAA0B,EAC1B,YAAY,EACZ,YAAY,EACZ,iBAAiB,EACjB,SAAS,EACT,kBAAkB,EAClB,UAAU,EACV,wBAAwB,EACxB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,qBAAqB,EACrB,eAAe,EACf,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,oBAAoB,EACpB,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,cAAc,EACd,MAAM,EACN,cAAc,EACd,gBAAgB,EAChB,6BAA6B,EAC7B,6BAA6B,EAC7B,+BAA+B,EAC/B,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,iBAAiB,EACjB,SAAS,EACT,kBAAkB,EAClB,cAAc,EACd,eAAe,EACf,WAAW,EACX,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,EACX,mBAAmB,EACnB,yBAAyB,EACzB,eAAe,EACf,aAAa,EACb,OAAO,EACP,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,SAAS,EACT,yBAAyB,EACzB,0BAA0B,EAC1B,OAAO,EACP,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,gBAAgB,CACkC,CAAC"}
+{"version":3,"file":"IPTCApplicationRecordTags.js","sourceRoot":"","sources":["../src/IPTCApplicationRecordTags.ts"],"names":[],"mappings":";;;AAKA,uCAA0D;AAiN7C,QAAA,6BAA6B,GAAG,IAAA,iBAAO,EAClD,0BAA0B,EAC1B,qBAAqB,EACrB,0BAA0B,EAC1B,YAAY,EACZ,YAAY,EACZ,iBAAiB,EACjB,SAAS,EACT,kBAAkB,EAClB,UAAU,EACV,wBAAwB,EACxB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,qBAAqB,EACrB,eAAe,EACf,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,oBAAoB,EACpB,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,cAAc,EACd,MAAM,EACN,cAAc,EACd,gBAAgB,EAChB,6BAA6B,EAC7B,6BAA6B,EAC7B,+BAA+B,EAC/B,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,iBAAiB,EACjB,SAAS,EACT,kBAAkB,EAClB,cAAc,EACd,eAAe,EACf,WAAW,EACX,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,EACX,mBAAmB,EACnB,yBAAyB,EACzB,eAAe,EACf,aAAa,EACb,OAAO,EACP,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,SAAS,EACT,yBAAyB,EACzB,0BAA0B,EAC1B,OAAO,EACP,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,gBAAgB,CACkC,CAAC"}

package/dist/MWGTags.d.ts

@@ -1,32 +1,107 @@
 import { StrEnum, StrEnumKeys } from "./StrEnum";
+/**
+ * Root structure for MWG hierarchical keyword metadata.
+ *
+ * Contains the top-level hierarchy of keyword structures organized in a tree format.
+ */
 export interface KeywordInfoStruct {
+    /**
+     * Array of keyword structures representing the top level of the keyword hierarchy.
+     */
     Hierarchy?: KeywordStruct[];
 }
+/**
+ * Individual keyword node in a hierarchical keyword tree.
+ *
+ * The MWG standard supports unlimited nesting depth, but ExifTool limits
+ * extraction to 6 levels to prevent infinite recursion.
+ * Example: "Nature > Animals > Mammals > Dogs".
+ */
 export interface KeywordStruct {
+    /**
+     * Array of nested keyword structures representing child keywords in the hierarchy.
+     *
+     * Enables multi-level keyword organization by recursively containing additional KeywordStruct entries.
+     */
     Children?: KeywordStruct[];
+    /**
+     * The keyword text value for this node in the hierarchy.
+     *
+     * This is the actual keyword string that appears at this level.
+     */
     Keyword: string;
+    /**
+     * Indicates whether this keyword has been applied/activated in the image metadata.
+     */
+    Applied?: boolean;
 }
 /**
+ * MWG (Metadata Working Group) Keywords tags for standardized hierarchical keyword metadata.
+ *
+ * These tags enable consistent keyword organization across different metadata formats (XMP, IPTC, EXIF).
+ * ExifTool extracts hierarchical keywords up to 6 levels deep to avoid infinite recursion.
+ *
  * Note: this is a partial interface: ExifTool extracts more fields from this
  * group type (but I haven't seen those in the wild).
  *
  * @see https://exiftool.org/TagNames/MWG.html#Keywords
  */
 export interface MWGKeywordTags {
+    /**
+     * Array of structured hierarchical keyword information.
+     *
+     * Each entry contains a Hierarchy field with nested KeywordStruct objects representing
+     * the complete keyword tree. This is the primary field for accessing full keyword hierarchies.
+     */
     KeywordInfo?: KeywordInfoStruct[];
+    /**
+     * Direct array of hierarchical keyword structures.
+     *
+     * Alternative representation providing direct access to keyword tree nodes without
+     * the KeywordInfo wrapper. Supports multi-level keyword organization with recursive Children fields.
+     */
     HierarchicalKeywords?: KeywordStruct[];
 }
+export declare const MWGKeywordTagNames: StrEnum<"KeywordInfo" | "HierarchicalKeywords">;
+export type MWGKeywordTagName = StrEnumKeys<typeof MWGKeywordTagNames>;
+/**
+ * Information about a single collection that groups related images.
+ *
+ * Collections enable organizing images into named groups (e.g., "Summer Vacation 2024", "Portfolio Selections").
+ * The MWG standard uses both a human-readable name and a unique identifier for each collection.
+ */
 export interface CollectionInfo {
+    /**
+     * Human-readable display name for the collection.
+     *
+     * This is the name users see when browsing collections (e.g., "Best Photos 2024").
+     */
     CollectionName: string;
+    /**
+     * Unique identifier (URI) for the collection.
+     *
+     * Provides a globally unique reference to distinguish between collections with the same name.
+     * Typically formatted as a URI or UUID to ensure uniqueness across different systems.
+     */
     CollectionURI: string;
 }
 /**
+ * MWG (Metadata Working Group) Collections tags for standardized image grouping metadata.
+ *
+ * Collections allow images to be organized into named groups while maintaining their physical location.
+ * This provides a standardized way to group related images across different metadata formats (XMP, IPTC, EXIF).
+ *
  * @see https://exiftool.org/TagNames/MWG.html#Collections
  */
 export interface MWGCollectionsTags {
+    /**
+     * Array of collections that include this image.
+     *
+     * An image can belong to multiple collections. Each collection is identified by both a
+     * human-readable name and a unique URI, enabling consistent collection management across
+     * different applications and systems.
+     */
     Collections?: CollectionInfo[];
 }
-export declare const MWGKeywordTagNames: StrEnum<"KeywordInfo" | "HierarchicalKeywords">;
-export type MWGKeywordTagName = StrEnumKeys<typeof MWGKeywordTagNames>;
 export declare const MWGCollectionsTagNames: StrEnum<"Collections">;
 export type MWGCollectionsTagName = StrEnumKeys<typeof MWGCollectionsTagNames>;

package/dist/MWGTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"MWGTags.js","sourceRoot":"","sources":["../src/MWGTags.ts"],"names":[],"mappings":";;;AAAA,uCAA0D;AAkC7C,QAAA,kBAAkB,GAAG,IAAA,iBAAO,EACvC,aAAa,EACb,sBAAsB,CACiB,CAAC;AAG7B,QAAA,sBAAsB,GAAG,IAAA,iBAAO,EAAC,aAAa,CAE1D,CAAC"}
+{"version":3,"file":"MWGTags.js","sourceRoot":"","sources":["../src/MWGTags.ts"],"names":[],"mappings":";;;AAEA,uCAA0D;AAyE7C,QAAA,kBAAkB,GAAG,IAAA,iBAAO,EACvC,aAAa,EACb,sBAAsB,CACiB,CAAC;AAkD7B,QAAA,sBAAsB,GAAG,IAAA,iBAAO,EAAC,aAAa,CAE1D,CAAC"}

package/dist/StrEnum.d.ts

@@ -171,5 +171,3 @@ export type StrEnumHelpers<T extends string> = {
 export type StrEnum<T extends string> = StrEnumType<T> & StrEnumHelpers<T>;
 export type StrEnumKeys<Type> = Type extends StrEnum<infer X> ? X : never;
 export declare function strEnum<T extends string>(...o: T[]): StrEnum<T>;
-export declare const Directions: StrEnum<"North" | "South" | "East" | "West">;
-export type Direction = StrEnumKeys<typeof Directions>;

package/dist/StrEnum.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Directions = void 0;
 exports.strEnum = strEnum;
 function lessThan(a, b) {
     return a == null || b == null ? false : a < b;
@@ -71,5 +70,8 @@ function strEnum(...o) {
     };
 }
 // Example usage:
-exports.Directions = strEnum("North", "South", "East", "West");
+// export const Directions = strEnum("North", "South", "East", "West");
+// export type Direction = StrEnumKeys<typeof Directions>;
+// assert the strEnum exactly matches the field names of an interface:
+// declare const _: Expect<Equal<Direction, keyof DirectionInterface>>
 //# sourceMappingURL=StrEnum.js.map