taglib-wasm 0.3.3 → 0.3.9

package/dist/src/file.js

@@ -0,0 +1,47 @@
+import { EnvironmentError, FileOperationError } from "../errors.ts";
+async function readFileData(file) {
+  if (file instanceof Uint8Array) {
+    return file;
+  }
+  if (file instanceof ArrayBuffer) {
+    return new Uint8Array(file);
+  }
+  if (typeof File !== "undefined" && file instanceof File) {
+    return new Uint8Array(await file.arrayBuffer());
+  }
+  if (typeof file === "string") {
+    try {
+      if (typeof Deno !== "undefined") {
+        return await Deno.readFile(file);
+      }
+      if (typeof process !== "undefined" && process.versions && process.versions.node) {
+        const { readFile } = await import("fs/promises");
+        return new Uint8Array(await readFile(file));
+      }
+      if (typeof globalThis.Bun !== "undefined") {
+        const bunFile = globalThis.Bun.file(file);
+        return new Uint8Array(await bunFile.arrayBuffer());
+      }
+    } catch (error) {
+      throw new FileOperationError(
+        "read",
+        error.message,
+        file
+      );
+    }
+    const env = typeof Deno !== "undefined" ? "Deno" : typeof process !== "undefined" ? "Node.js" : typeof globalThis.Bun !== "undefined" ? "Bun" : "Browser";
+    throw new EnvironmentError(
+      env,
+      "does not support file path reading",
+      "filesystem access"
+    );
+  }
+  const inputType = Object.prototype.toString.call(file);
+  throw new FileOperationError(
+    "read",
+    `Invalid file input type: ${inputType}. Expected string path, Uint8Array, ArrayBuffer, or File object.`
+  );
+}
+export {
+  readFileData
+};

package/dist/src/global.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Global type declarations for cross-runtime compatibility
+ */
+
+// Declare Deno global for TypeScript when not in Deno environment
+declare global {
+  const Deno: any;
+}
+
+export {};

package/dist/src/mod.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @fileoverview TagLib WebAssembly TypeScript bindings
+ * Universal audio metadata handling for Deno, Node.js, and browsers
+ */
+export { AudioFileImpl, createTagLib, TagLib } from "./taglib.ts";
+export type { AudioFile, Tag } from "./taglib.ts";
+export type { AudioProperties, FileType, PropertyMap, Tag as BasicTag, } from "./types.ts";
+export type { TagLibModule } from "./wasm.ts";
+//# sourceMappingURL=mod.d.ts.map

package/dist/src/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/mod.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAClE,YAAY,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAGlD,YAAY,EACV,eAAe,EACf,QAAQ,EACR,WAAW,EACX,GAAG,IAAI,QAAQ,GAChB,MAAM,YAAY,CAAC;AAGpB,YAAY,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC"}

package/dist/src/mod.ts

@@ -0,0 +1,19 @@
+/**
+ * @fileoverview TagLib WebAssembly TypeScript bindings
+ * Universal audio metadata handling for Deno, Node.js, and browsers
+ */
+
+// Export from taglib.ts
+export { AudioFileImpl, createTagLib, TagLib } from "./taglib.ts";
+export type { AudioFile, Tag } from "./taglib.ts"; // Export the interfaces
+
+// Export from types.ts (except Tag to avoid conflict)
+export type {
+  AudioProperties,
+  FileType,
+  PropertyMap,
+  Tag as BasicTag, // Rename the basic Tag interface to avoid conflict
+} from "./types.ts";
+
+// Export from wasm.ts
+export type { TagLibModule } from "./wasm.ts";

package/dist/src/simple.d.ts

@@ -0,0 +1,347 @@
+/**
+ * @fileoverview Simplified API for taglib-wasm matching go-taglib's interface
+ *
+ * This module provides a dead-simple API for reading and writing audio metadata,
+ * inspired by go-taglib's excellent developer experience.
+ *
+ * @example
+ * ```typescript
+ * import { readTags, writeTags, readProperties } from "taglib-wasm/simple";
+ *
+ * // Read tags
+ * const tags = await readTags("song.mp3");
+ * console.log(tags.album);
+ *
+ * // Write tags
+ * await writeTags("song.mp3", {
+ *   album: "New Album",
+ *   artist: "New Artist"
+ * });
+ *
+ * // Read audio properties
+ * const props = await readProperties("song.mp3");
+ * console.log(`Duration: ${props.length}s, Bitrate: ${props.bitrate}kbps`);
+ * ```
+ */
+import type { AudioProperties, Tag, Picture } from "./types.ts";
+import { PictureType } from "./types.ts";
+/**
+ * Read metadata tags from an audio file
+ *
+ * @param file - File path, Uint8Array buffer, ArrayBuffer, or File object
+ * @returns Object containing all metadata tags
+ *
+ * @example
+ * ```typescript
+ * const tags = await readTags("song.mp3");
+ * console.log(tags.title, tags.artist, tags.album);
+ * ```
+ */
+export declare function readTags(file: string | Uint8Array | ArrayBuffer | File): Promise<Tag>;
+/**
+ * Apply metadata tags to an audio file and return the modified buffer
+ *
+ * This function loads the file, applies the tag changes, and returns
+ * the modified file as a buffer. The original file is not modified.
+ *
+ * @param file - File path, Uint8Array buffer, ArrayBuffer, or File object
+ * @param tags - Object containing tags to apply (undefined values are ignored)
+ * @param options - Write options (currently unused, for go-taglib compatibility)
+ * @returns Modified file buffer with new tags applied
+ *
+ * @example
+ * ```typescript
+ * const modifiedBuffer = await applyTags("song.mp3", {
+ *   title: "New Title",
+ *   artist: "New Artist",
+ *   album: "New Album",
+ *   year: 2025
+ * });
+ * // Save modifiedBuffer to file or use as needed
+ * ```
+ */
+export declare function applyTags(file: string | Uint8Array | ArrayBuffer | File, tags: Partial<Tag>, options?: number): Promise<Uint8Array>;
+/**
+ * @deprecated Use `applyTags` instead. This alias will be removed in v1.0.0.
+ */
+export declare const writeTags: typeof applyTags;
+/**
+ * Update metadata tags in an audio file and save to disk
+ *
+ * This function modifies the file on disk by applying the specified tags
+ * and writing the changes back to the original file path.
+ *
+ * @param file - File path as a string (required for disk operations)
+ * @param tags - Object containing tags to write (undefined values are ignored)
+ * @param options - Write options (currently unused, for go-taglib compatibility)
+ * @throws {InvalidInputError} If file is not a string
+ * @throws {FileOperationError} If file write fails
+ * @returns Promise that resolves when the file has been updated on disk
+ *
+ * @example
+ * ```typescript
+ * // Update tags and save to disk
+ * await updateTags("song.mp3", {
+ *   title: "New Title",
+ *   artist: "New Artist"
+ * });
+ * // File on disk now has updated tags
+ * ```
+ *
+ * @see applyTags - For getting a modified buffer without writing to disk
+ */
+export declare function updateTags(file: string, tags: Partial<Tag>, options?: number): Promise<void>;
+/**
+ * Read audio properties from a file
+ *
+ * @param file - File path, Uint8Array buffer, ArrayBuffer, or File object
+ * @returns Audio properties including duration, bitrate, sample rate, etc.
+ *
+ * @example
+ * ```typescript
+ * const props = await readProperties("song.mp3");
+ * console.log(`Duration: ${props.length} seconds`);
+ * console.log(`Bitrate: ${props.bitrate} kbps`);
+ * console.log(`Sample rate: ${props.sampleRate} Hz`);
+ * ```
+ */
+export declare function readProperties(file: string | Uint8Array | ArrayBuffer | File): Promise<AudioProperties>;
+/**
+ * Tag field constants for go-taglib compatibility.
+ * These match the constants used in go-taglib for consistent API.
+ *
+ * @example
+ * ```typescript
+ * import { Title, Artist, Album } from "taglib-wasm/simple";
+ *
+ * const tags = await readTags("song.mp3");
+ * console.log(tags[Title]);  // Same as tags.title
+ * console.log(tags[Artist]); // Same as tags.artist
+ * ```
+ */
+export declare const Title = "title";
+export declare const Artist = "artist";
+export declare const Album = "album";
+export declare const Comment = "comment";
+export declare const Genre = "genre";
+export declare const Year = "year";
+export declare const Track = "track";
+export declare const AlbumArtist = "albumartist";
+export declare const Composer = "composer";
+export declare const DiscNumber = "discnumber";
+/**
+ * Check if a file is a valid audio file
+ *
+ * @param file - File path, Uint8Array buffer, ArrayBuffer, or File object
+ * @returns true if the file is a valid audio file
+ *
+ * @example
+ * ```typescript
+ * if (await isValidAudioFile("maybe-audio.bin")) {
+ *   const tags = await readTags("maybe-audio.bin");
+ * }
+ * ```
+ */
+export declare function isValidAudioFile(file: string | Uint8Array | ArrayBuffer | File): Promise<boolean>;
+/**
+ * Get the audio format of a file
+ *
+ * @param file - File path, Uint8Array buffer, ArrayBuffer, or File object
+ * @returns Audio format string (e.g., "MP3", "FLAC", "OGG") or undefined
+ *
+ * @example
+ * ```typescript
+ * const format = await getFormat("song.mp3");
+ * console.log(`File format: ${format}`); // "MP3"
+ * ```
+ */
+export declare function getFormat(file: string | Uint8Array | ArrayBuffer | File): Promise<string | undefined>;
+/**
+ * Clear all tags from a file
+ *
+ * @param file - File path, Uint8Array buffer, ArrayBuffer, or File object
+ * @returns Modified file buffer with tags removed
+ *
+ * @example
+ * ```typescript
+ * const cleanBuffer = await clearTags("song.mp3");
+ * // Save cleanBuffer to remove all metadata
+ * ```
+ */
+export declare function clearTags(file: string | Uint8Array | ArrayBuffer | File): Promise<Uint8Array>;
+/**
+ * Read cover art/pictures from an audio file
+ *
+ * @param file - File path, Uint8Array buffer, ArrayBuffer, or File object
+ * @returns Array of Picture objects containing cover art
+ *
+ * @example
+ * ```typescript
+ * const pictures = await readPictures("song.mp3");
+ * for (const pic of pictures) {
+ *   console.log(`Type: ${pic.type}, MIME: ${pic.mimeType}, Size: ${pic.data.length}`);
+ * }
+ * ```
+ */
+export declare function readPictures(file: string | Uint8Array | ArrayBuffer | File): Promise<Picture[]>;
+/**
+ * Apply pictures/cover art to an audio file and return the modified buffer
+ *
+ * This function loads the file, replaces all existing pictures with the new ones,
+ * and returns the modified file as a buffer. The original file is not modified.
+ *
+ * @param file - File path, Uint8Array buffer, ArrayBuffer, or File object
+ * @param pictures - Array of Picture objects to set (replaces all existing)
+ * @returns Modified file buffer with new pictures applied
+ *
+ * @example
+ * ```typescript
+ * const coverArt = {
+ *   mimeType: "image/jpeg",
+ *   data: jpegData, // Uint8Array
+ *   type: PictureType.FrontCover,
+ *   description: "Album cover"
+ * };
+ * const modifiedBuffer = await applyPictures("song.mp3", [coverArt]);
+ * ```
+ */
+export declare function applyPictures(file: string | Uint8Array | ArrayBuffer | File, pictures: Picture[]): Promise<Uint8Array>;
+/**
+ * Add a single picture to an audio file and return the modified buffer
+ *
+ * This function loads the file, adds the picture to existing ones,
+ * and returns the modified file as a buffer. The original file is not modified.
+ *
+ * @param file - File path, Uint8Array buffer, ArrayBuffer, or File object
+ * @param picture - Picture object to add
+ * @returns Modified file buffer with picture added
+ *
+ * @example
+ * ```typescript
+ * const backCover = {
+ *   mimeType: "image/png",
+ *   data: pngData, // Uint8Array
+ *   type: PictureType.BackCover,
+ *   description: "Back cover"
+ * };
+ * const modifiedBuffer = await addPicture("song.mp3", backCover);
+ * ```
+ */
+export declare function addPicture(file: string | Uint8Array | ArrayBuffer | File, picture: Picture): Promise<Uint8Array>;
+/**
+ * Clear all pictures from a file
+ *
+ * @param file - File path, Uint8Array buffer, ArrayBuffer, or File object
+ * @returns Modified file buffer with pictures removed
+ *
+ * @example
+ * ```typescript
+ * const cleanBuffer = await clearPictures("song.mp3");
+ * // Save cleanBuffer to remove all cover art
+ * ```
+ */
+export declare function clearPictures(file: string | Uint8Array | ArrayBuffer | File): Promise<Uint8Array>;
+/**
+ * Get the primary cover art from an audio file
+ *
+ * Returns the front cover if available, otherwise the first picture found.
+ * Returns null if no pictures are present.
+ *
+ * @param file - File path, Uint8Array buffer, ArrayBuffer, or File object
+ * @returns Primary cover art data or null
+ *
+ * @example
+ * ```typescript
+ * const coverArt = await getCoverArt("song.mp3");
+ * if (coverArt) {
+ *   console.log(`Cover art size: ${coverArt.length} bytes`);
+ * }
+ * ```
+ */
+export declare function getCoverArt(file: string | Uint8Array | ArrayBuffer | File): Promise<Uint8Array | null>;
+/**
+ * Set the primary cover art for an audio file
+ *
+ * Replaces all existing pictures with a single front cover image.
+ *
+ * @param file - File path, Uint8Array buffer, ArrayBuffer, or File object
+ * @param imageData - Image data as Uint8Array
+ * @param mimeType - MIME type of the image (e.g., "image/jpeg", "image/png")
+ * @returns Modified file buffer with cover art set
+ *
+ * @example
+ * ```typescript
+ * const jpegData = await Deno.readFile("cover.jpg");
+ * const modifiedBuffer = await setCoverArt("song.mp3", jpegData, "image/jpeg");
+ * ```
+ */
+export declare function setCoverArt(file: string | Uint8Array | ArrayBuffer | File, imageData: Uint8Array, mimeType: string): Promise<Uint8Array>;
+/**
+ * Find a picture by its type
+ *
+ * @param pictures - Array of pictures to search
+ * @param type - Picture type to find
+ * @returns Picture matching the type or null
+ *
+ * @example
+ * ```typescript
+ * const pictures = await readPictures("song.mp3");
+ * const backCover = findPictureByType(pictures, PictureType.BackCover);
+ * if (backCover) {
+ *   console.log("Found back cover art");
+ * }
+ * ```
+ */
+export declare function findPictureByType(pictures: Picture[], type: PictureType): Picture | null;
+/**
+ * Replace or add a picture of a specific type
+ *
+ * If a picture of the given type already exists, it will be replaced.
+ * Otherwise, the new picture will be added to the existing ones.
+ *
+ * @param file - File path, Uint8Array buffer, ArrayBuffer, or File object
+ * @param newPicture - Picture to add or replace
+ * @returns Modified file buffer with picture updated
+ *
+ * @example
+ * ```typescript
+ * const backCover: Picture = {
+ *   mimeType: "image/png",
+ *   data: pngData,
+ *   type: PictureType.BackCover,
+ *   description: "Back cover"
+ * };
+ * const modifiedBuffer = await replacePictureByType("song.mp3", backCover);
+ * ```
+ */
+export declare function replacePictureByType(file: string | Uint8Array | ArrayBuffer | File, newPicture: Picture): Promise<Uint8Array>;
+/**
+ * Get picture metadata without the actual image data
+ *
+ * Useful for checking what pictures are present without loading
+ * potentially large image data into memory.
+ *
+ * @param file - File path, Uint8Array buffer, ArrayBuffer, or File object
+ * @returns Array of picture metadata (type, mimeType, description, size)
+ *
+ * @example
+ * ```typescript
+ * const metadata = await getPictureMetadata("song.mp3");
+ * for (const info of metadata) {
+ *   console.log(`${info.description}: ${info.mimeType}, ${info.size} bytes`);
+ * }
+ * ```
+ */
+export declare function getPictureMetadata(file: string | Uint8Array | ArrayBuffer | File): Promise<Array<{
+    type: PictureType;
+    mimeType: string;
+    description?: string;
+    size: number;
+}>>;
+/**
+ * Re-export commonly used types for convenience.
+ * These types define the structure of metadata and audio properties.
+ */
+export type { AudioProperties, Tag, Picture } from "./types.ts";
+export { PictureType } from "./types.ts";
+//# sourceMappingURL=simple.d.ts.map

package/dist/src/simple.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple.d.ts","sourceRoot":"","sources":["../../src/simple.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AA4BzC;;;;;;;;;;;GAWG;AACH,wBAAsB,QAAQ,CAC5B,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,GAC7C,OAAO,CAAC,GAAG,CAAC,CAcd;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,SAAS,CAC7B,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,EAC9C,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,EAClB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,UAAU,CAAC,CAiCrB;AAED;;GAEG;AACH,eAAO,MAAM,SAAS,kBAAY,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,UAAU,CAC9B,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,EAClB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC,CAUf;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,cAAc,CAClC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,GAC7C,OAAO,CAAC,eAAe,CAAC,CAsB1B;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,KAAK,UAAU,CAAC;AAC7B,eAAO,MAAM,MAAM,WAAW,CAAC;AAC/B,eAAO,MAAM,KAAK,UAAU,CAAC;AAC7B,eAAO,MAAM,OAAO,YAAY,CAAC;AACjC,eAAO,MAAM,KAAK,UAAU,CAAC;AAC7B,eAAO,MAAM,IAAI,SAAS,CAAC;AAC3B,eAAO,MAAM,KAAK,UAAU,CAAC;AAC7B,eAAO,MAAM,WAAW,gBAAgB,CAAC;AACzC,eAAO,MAAM,QAAQ,aAAa,CAAC;AACnC,eAAO,MAAM,UAAU,eAAe,CAAC;AAIvC;;;;;;;;;;;;GAYG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,GAC7C,OAAO,CAAC,OAAO,CAAC,CAWlB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,SAAS,CAC7B,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,GAC7C,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAY7B;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,SAAS,CAC7B,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,GAC7C,OAAO,CAAC,UAAU,CAAC,CAUrB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,YAAY,CAChC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,GAC7C,OAAO,CAAC,OAAO,EAAE,CAAC,CAcpB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,EAC9C,QAAQ,EAAE,OAAO,EAAE,GAClB,OAAO,CAAC,UAAU,CAAC,CA0BrB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,UAAU,CAC9B,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,EAC9C,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,UAAU,CAAC,CA0BrB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,GAC7C,OAAO,CAAC,UAAU,CAAC,CAErB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,WAAW,CAC/B,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,GAC7C,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAc5B;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,WAAW,CAC/B,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,EAC9C,SAAS,EAAE,UAAU,EACrB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,UAAU,CAAC,CAQrB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,OAAO,EAAE,EACnB,IAAI,EAAE,WAAW,GAChB,OAAO,GAAG,IAAI,CAEhB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,EAC9C,UAAU,EAAE,OAAO,GAClB,OAAO,CAAC,UAAU,CAAC,CAUrB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,GAC7C,OAAO,CAAC,KAAK,CAAC;IACf,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC,CAAC,CAQF;AAED;;;GAGG;AACH,YAAY,EAAE,eAAe,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC"}