tar-xz 0.1.0

package/lib/types.d.ts

@@ -0,0 +1,144 @@
+/**
+ * TAR entry type flags (POSIX ustar format)
+ */
+export declare const TarEntryType: {
+    /** Regular file */
+    readonly FILE: "0";
+    /** Hard link */
+    readonly HARDLINK: "1";
+    /** Symbolic link */
+    readonly SYMLINK: "2";
+    /** Character device */
+    readonly CHARDEV: "3";
+    /** Block device */
+    readonly BLOCKDEV: "4";
+    /** Directory */
+    readonly DIRECTORY: "5";
+    /** FIFO (named pipe) */
+    readonly FIFO: "6";
+    /** Contiguous file */
+    readonly CONTIGUOUS: "7";
+    /** PAX extended header for next file */
+    readonly PAX_HEADER: "x";
+    /** PAX global extended header */
+    readonly PAX_GLOBAL: "g";
+};
+export type TarEntryTypeValue = (typeof TarEntryType)[keyof typeof TarEntryType];
+/**
+ * TAR entry metadata
+ */
+export interface TarEntry {
+    /** File path (relative) */
+    name: string;
+    /** Entry type */
+    type: TarEntryTypeValue;
+    /** File size in bytes */
+    size: number;
+    /** File mode (permissions) */
+    mode: number;
+    /** User ID */
+    uid: number;
+    /** Group ID */
+    gid: number;
+    /** Modification time (seconds since epoch) */
+    mtime: number;
+    /** User name */
+    uname: string;
+    /** Group name */
+    gname: string;
+    /** Device major number (for device files) */
+    devmajor: number;
+    /** Device minor number (for device files) */
+    devminor: number;
+    /** Link target (for symlinks and hardlinks) */
+    linkname: string;
+}
+/**
+ * TAR entry with content data
+ */
+export interface TarEntryWithData extends TarEntry {
+    /** File content */
+    data: Uint8Array;
+}
+/**
+ * Input file for archive creation
+ */
+export interface TarInputFile {
+    /** File path in archive */
+    name: string;
+    /** File content (string, Uint8Array, ArrayBuffer, or Blob) */
+    content: string | Uint8Array | ArrayBuffer | Blob;
+    /** Optional file mode (default: 0o644 for files, 0o755 for directories) */
+    mode?: number;
+    /** Optional modification time (default: current time) */
+    mtime?: Date | number;
+}
+/**
+ * Options for creating tar.xz archives (Node.js)
+ */
+export interface CreateOptions {
+    /** Output file path */
+    file: string;
+    /** Base directory for file paths */
+    cwd?: string;
+    /** Files/directories to include */
+    files: string[];
+    /** XZ compression preset (0-9, default: 6) */
+    preset?: number;
+    /** Follow symbolic links */
+    follow?: boolean;
+    /** Dereference symlinks (archive target, not link) */
+    dereference?: boolean;
+}
+/**
+ * Options for extracting tar.xz archives (Node.js)
+ */
+export interface ExtractOptions {
+    /** Input file path */
+    file: string;
+    /** Output directory */
+    cwd?: string;
+    /** Number of leading path components to strip */
+    strip?: number;
+    /** Filter function to select entries */
+    filter?: (entry: TarEntry) => boolean;
+    /** Preserve file ownership (requires root) */
+    preserveOwner?: boolean;
+}
+/**
+ * Options for listing tar.xz archives (Node.js)
+ */
+export interface ListOptions {
+    /** Input file path */
+    file: string;
+}
+/**
+ * Options for browser-based archive creation
+ */
+export interface BrowserCreateOptions {
+    /** Files to include */
+    files: TarInputFile[];
+    /** XZ compression preset (0-9, default: 3 for browser performance) */
+    preset?: number;
+}
+/**
+ * Options for browser-based archive extraction
+ */
+export interface BrowserExtractOptions {
+    /** Number of leading path components to strip */
+    strip?: number;
+    /** Filter function to select entries */
+    filter?: (entry: TarEntry) => boolean;
+}
+/**
+ * Extracted file from browser API
+ */
+export interface ExtractedFile {
+    /** File path */
+    name: string;
+    /** File content */
+    data: Uint8Array;
+    /** File metadata */
+    entry: TarEntry;
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,YAAY;IACvB,mBAAmB;;IAEnB,gBAAgB;;IAEhB,oBAAoB;;IAEpB,uBAAuB;;IAEvB,mBAAmB;;IAEnB,gBAAgB;;IAEhB,wBAAwB;;IAExB,sBAAsB;;IAEtB,wCAAwC;;IAExC,iCAAiC;;CAEzB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB;IACjB,IAAI,EAAE,iBAAiB,CAAC;IACxB,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,cAAc;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,eAAe;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,QAAQ;IAChD,mBAAmB;IACnB,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,8DAA8D;IAC9D,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,CAAC;IAClD,2EAA2E;IAC3E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,KAAK,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,sDAAsD;IACtD,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAC;IACtC,8CAA8C;IAC9C,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,uBAAuB;IACvB,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,iDAAiD;IACjD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,IAAI,EAAE,UAAU,CAAC;IACjB,oBAAoB;IACpB,KAAK,EAAE,QAAQ,CAAC;CACjB"}

package/lib/types.js

@@ -0,0 +1,26 @@
+/**
+ * TAR entry type flags (POSIX ustar format)
+ */
+export const TarEntryType = {
+    /** Regular file */
+    FILE: '0',
+    /** Hard link */
+    HARDLINK: '1',
+    /** Symbolic link */
+    SYMLINK: '2',
+    /** Character device */
+    CHARDEV: '3',
+    /** Block device */
+    BLOCKDEV: '4',
+    /** Directory */
+    DIRECTORY: '5',
+    /** FIFO (named pipe) */
+    FIFO: '6',
+    /** Contiguous file */
+    CONTIGUOUS: '7',
+    /** PAX extended header for next file */
+    PAX_HEADER: 'x',
+    /** PAX global extended header */
+    PAX_GLOBAL: 'g',
+};
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,mBAAmB;IACnB,IAAI,EAAE,GAAG;IACT,gBAAgB;IAChB,QAAQ,EAAE,GAAG;IACb,oBAAoB;IACpB,OAAO,EAAE,GAAG;IACZ,uBAAuB;IACvB,OAAO,EAAE,GAAG;IACZ,mBAAmB;IACnB,QAAQ,EAAE,GAAG;IACb,gBAAgB;IAChB,SAAS,EAAE,GAAG;IACd,wBAAwB;IACxB,IAAI,EAAE,GAAG;IACT,sBAAsB;IACtB,UAAU,EAAE,GAAG;IACf,wCAAwC;IACxC,UAAU,EAAE,GAAG;IACf,iCAAiC;IACjC,UAAU,EAAE,GAAG;CACP,CAAC"}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "tar-xz",
+  "version": "0.1.0",
+  "description": "Create and extract tar.xz archives with streaming support for Node.js and buffer-based API for browsers",
+  "type": "module",
+  "main": "./lib/index.js",
+  "exports": {
+    ".": {
+      "browser": {
+        "types": "./lib/index.browser.d.ts",
+        "import": "./lib/index.browser.js",
+        "default": "./lib/index.browser.js"
+      },
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js",
+      "default": "./lib/index.js"
+    }
+  },
+  "dependencies": {
+    "node-liblzma": "^3.1.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.3.13",
+    "@types/node": "^25.2.0",
+    "@vitest/coverage-v8": "^4.0.18",
+    "typescript": "^5.9.3",
+    "vite": "^6.3.5",
+    "vitest": "^4.0.18"
+  },
+  "types": "./lib/index.d.ts",
+  "files": [
+    "lib/"
+  ],
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/oorabona/node-liblzma",
+    "directory": "packages/tar-xz"
+  },
+  "keywords": [
+    "tar",
+    "xz",
+    "lzma",
+    "lzma2",
+    "compress",
+    "decompress",
+    "archive",
+    "extract",
+    "browser",
+    "wasm"
+  ],
+  "author": "Olivier ORABONA",
+  "license": "LGPL-3.0",
+  "bugs": {
+    "url": "https://github.com/oorabona/node-liblzma/issues"
+  },
+  "homepage": "https://github.com/oorabona/node-liblzma/tree/master/packages/tar-xz",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "build:demo": "vite build --config demo/vite.config.ts",
+    "dev:demo": "vite --config demo/vite.config.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "type-check": "tsc --noEmit",
+    "clean": "rm -rf lib dist-demo",
+    "lint": "biome lint",
+    "lint:fix": "biome lint --write",
+    "format": "biome format",
+    "format:write": "biome format --write",
+    "check": "biome check",
+    "check:write": "biome check --write"
+  }
+}