tar-vern 0.1.0

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/packer.ts","../src/utils.ts"],"sourcesContent":["// tar-vern - Tape archiver library for Typescript\n// Copyright (c) Kouji Matsui (@kekyo@mi.kekyo.net)\n// Under MIT.\n// https://github.com/kekyo/tar-vern/\n\nimport { Readable } from \"stream\";\nimport { CompressionTypes, EntryItem } from \"./types\";\nimport { createGzip } from \"zlib\";\n\n/**\n * Get the byte length of a string in UTF-8\n * @param str - The string to get the byte length of\n * @returns The byte length of the string\n */\nconst utf8ByteLength = (str: string) => {\n  return Buffer.byteLength(str, \"utf8\");\n}\n\n/**\n * Truncate a string to a maximum byte length in UTF-8\n * @param str - The string to truncate\n * @param maxBytes - The maximum byte length\n * @returns The truncated string\n */\nconst truncateUtf8Safe = (str: string, maxBytes: number) => {\n  let total = 0;\n  let i = 0;\n  while (i < str.length) {\n    const codePoint = str.codePointAt(i)!;\n    const char = String.fromCodePoint(codePoint);\n    const charBytes = Buffer.byteLength(char, \"utf8\");\n    if (total + charBytes > maxBytes) break;\n    total += charBytes;\n    i += char.length;\n  }\n  return str.slice(0, i);\n}\n\n// Tar specification: name max 100 bytes, prefix max 155 bytes\nconst MAX_NAME = 100;\nconst MAX_PREFIX = 155;\n\n/**\n * Split a path into a name and a prefix\n * @param path - The path to split\n * @returns The name and prefix\n */\nconst splitPath = (path: string) => {\n  if (utf8ByteLength(path) <= MAX_NAME) {\n    return { prefix: \"\", name: path };\n  }\n\n  // Split by '/' and find the part that fits in name from the end\n  const parts = path.split(\"/\");\n  let name = parts.pop() ?? \"\";\n  let prefix = parts.join(\"/\");\n\n  // Truncate if name exceeds 100 bytes\n  if (utf8ByteLength(name) > MAX_NAME) {\n    name = truncateUtf8Safe(name, MAX_NAME);\n  }\n\n  // Truncate if prefix exceeds 155 bytes\n  while (utf8ByteLength(prefix) > MAX_PREFIX) {\n    prefix = truncateUtf8Safe(prefix, MAX_PREFIX);\n  }\n\n  return { prefix, name };\n}\n\n///////////////////////////////////////////////////////////////////////////////////\n\n/**\n * Get octal bytes from a number\n * @param value - The number to get octal bytes from\n * @param length - The length of the octal bytes\n * @returns The octal bytes\n */\nconst getOctalBytes = (value: number, length: number) => {\n  const str = value.toString(8).padStart(length - 1, \"0\") + \"\\0\";\n  return Buffer.from(str, \"ascii\");\n};\n\n/**\n * Get padded bytes from a buffer\n * @param buffer - The buffer to get padded bytes from\n * @returns The padded bytes\n */\nconst getPaddedBytes = (buffer: Buffer) => {\n  const extra = buffer.length % 512;\n  if (extra === 0) {\n    return buffer;\n  } else {\n    return Buffer.concat([buffer, Buffer.alloc(512 - extra, 0)]);\n  }\n}\n\n/**\n * The terminator bytes\n */\nconst terminatorBytes = Buffer.alloc(1024, 0);\n\n/**\n * Create a tar header\n * @param type - The type of the entry\n * @param path - The path of the entry\n * @param size - The size of the entry\n * @param mode - The mode of the entry\n * @param uname - The user name of the entry\n * @param gname - The group name of the entry\n */\nconst createTarHeader = (\n  type: 'file' | 'directory',\n  path: string,\n  size: number,\n  mode: number,\n  uname: string,\n  gname: string,\n  uid: number,\n  gid: number,\n  date: Date\n) => {\n  // Allocate header bytes\n  const buffer = Buffer.alloc(512, 0);\n\n  // Split path into name and prefix\n  const { name, prefix } = splitPath(path);\n\n  // Write name, mode, uid, gid, size, mtime, typeflag, prefix, checksum\n  buffer.write(name, 0, 100, \"utf8\");\n  getOctalBytes(mode & 0o7777, 8).copy(buffer, 100);\n  getOctalBytes(uid, 8).copy(buffer, 108);\n  getOctalBytes(gid, 8).copy(buffer, 116);\n  getOctalBytes(size, 12).copy(buffer, 124);\n  getOctalBytes(Math.floor(date.getTime() / 1000), 12).copy(buffer, 136);\n\n  // Check sum space\n  Buffer.from(\"        \", \"ascii\").copy(buffer, 148);\n\n  if (type === 'file') {\n    buffer.write(\"0\", 156, 1, \"ascii\");    // typeflag (file)\n  } else {\n    buffer.write(\"5\", 156, 1, \"ascii\");    // typeflag (directory)\n  }\n  buffer.write(\"ustar\\0\", 257, 6, \"ascii\");\n  buffer.write(\"00\", 263, 2, \"ascii\");     // version\n  buffer.write(uname, 265, 32, \"utf8\");\n  buffer.write(gname, 297, 32, \"utf8\");\n  buffer.write(prefix, 345, 155, \"utf8\");  // Path prefix\n\n  // Calculate check sum\n  let sum = 0;\n  for (let i = 0; i < 512; i++) {\n    sum += buffer[i];\n  }\n  getOctalBytes(sum, 8).copy(buffer, 148);\n\n  return buffer;\n}\n\n///////////////////////////////////////////////////////////////////////////////////\n\n/**\n * Create a tar packer\n * @param entryItemGenerator - The async generator of the entry items\n * @param compressionType - The compression type to use (Default: 'none')\n * @param signal - The abort signal to cancel the tar packer\n * @returns Readable stream of the tar packer\n */\nexport const createTarPacker = (\n  entryItemGenerator: AsyncGenerator<EntryItem, void, unknown>,\n  compressionType?: CompressionTypes,\n  signal?: AbortSignal) => {\n\n  // Create async generator function from entry item iterator\n  const entryItemIterator = async function*() {\n    // Iterate over the entry items\n    for await (const entryItem of entryItemGenerator) {\n      signal?.throwIfAborted();\n\n      switch (entryItem.kind) {\n        // Entry is a file\n        case 'file': {\n          const entryItemContent = entryItem.content;\n          // Content is a string\n          if (typeof entryItemContent === 'string') {\n            // Get content bytes from string\n            const contentBytes = Buffer.from(entryItemContent, \"utf8\");\n\n            // Create and produce tar header bytes\n            const tarHeaderBytes = createTarHeader(\n              'file',\n              entryItem.path,\n              contentBytes.length,\n              entryItem.mode,\n              entryItem.uname,\n              entryItem.gname,\n              entryItem.uid,\n              entryItem.gid,\n              entryItem.date);\n            yield tarHeaderBytes;\n\n            // Content bytes to adjust padding space and produce\n            const paddedContentBytes = getPaddedBytes(contentBytes);\n            yield paddedContentBytes;\n\n          // Content is a buffer\n          } else if (Buffer.isBuffer(entryItemContent)) {\n            // Create and produce tar header bytes\n            const tarHeaderBytes = createTarHeader(\n              'file',\n              entryItem.path,\n              entryItemContent.length,\n              entryItem.mode,\n              entryItem.uname,\n              entryItem.gname,\n              entryItem.uid,\n              entryItem.gid,\n              entryItem.date);\n            yield tarHeaderBytes;\n\n            // Content bytes to adjust padding space and produce\n            const paddedContentBytes = getPaddedBytes(entryItemContent);\n            yield paddedContentBytes;\n\n          } else {\n            // Create and produce tar header bytes\n            const tarHeaderBytes = createTarHeader(\n              'file',\n              entryItem.path,\n              entryItemContent.length,\n              entryItem.mode,\n              entryItem.uname,\n              entryItem.gname,\n              entryItem.uid,\n              entryItem.gid,\n              entryItem.date);\n            yield tarHeaderBytes;\n\n            switch (entryItemContent.kind) {\n              // Content is a generator\n              case 'generator': {\n                let position = 0;\n                for await (const contentFragmentBytes of entryItemContent.generator) {\n                  signal?.throwIfAborted();\n                  yield contentFragmentBytes;\n                  position += contentFragmentBytes.length;\n                }\n\n                // Padding space\n                if (position % 512 !== 0) {\n                  signal?.throwIfAborted();\n                  yield Buffer.alloc(512 - (position % 512), 0);\n                }\n                break;\n              }\n              // Content is a readable stream\n              case 'readable': {\n                let position = 0;\n                for await (const content of entryItemContent.readable) {\n                  signal?.throwIfAborted();\n                  if (typeof content === 'string') {\n                    const stringBytes = Buffer.from(content, \"utf8\");\n                    yield stringBytes;\n                    position += stringBytes.length;\n                  } else if (Buffer.isBuffer(content)) {\n                    yield content;\n                    position += content.length;\n                  }\n                }\n\n                // Padding space\n                if (position % 512 !== 0) {\n                  signal?.throwIfAborted();\n                  yield Buffer.alloc(512 - (position % 512), 0);\n                }\n                break;\n              }\n            }\n          }\n          break;\n        }\n        // Entry is a directory\n        case 'directory': {\n          // Create and produce tar header bytes\n          const tarHeaderBytes = createTarHeader(\n            'directory',\n            entryItem.path,\n            0,\n            entryItem.mode,\n            entryItem.uname,\n            entryItem.gname,\n            entryItem.uid,\n            entryItem.gid,\n            entryItem.date\n          );\n          yield tarHeaderBytes;\n          break;\n        }\n      }\n    }\n\n    // Terminates for tar stream\n    yield terminatorBytes;\n  };\n\n  const ct = compressionType ?? 'none';\n\n  switch (ct) {\n    // No compression\n    case 'none': {\n      // Create readable stream from entry item iterator\n      return Readable.from(entryItemIterator());\n    }\n    // Gzip compression\n    case 'gzip': {\n      // Create gzip stream\n      const gzipStream = createGzip({ level: 9 });\n      // Create readable stream from entry item iterator\n      const entryItemStream = Readable.from(entryItemIterator());\n      // Pipe the entry item stream to the gzip stream\n      entryItemStream.pipe(gzipStream);\n      // Return the gzip stream\n      return gzipStream;\n    }\n  }\n};\n","// tar-vern - Tape archiver library for Typescript\n// Copyright (c) Kouji Matsui (@kekyo@mi.kekyo.net)\n// Under MIT.\n// https://github.com/kekyo/tar-vern/\n\nimport { createReadStream, createWriteStream } from \"fs\";\nimport { stat } from \"fs/promises\";\nimport { Readable } from \"stream\";\nimport { CreateItemOptions, CreateReadableItemOptions, FileItem, DirectoryItem, ReflectStats, CreateDirectoryItemOptions } from \"./types\";\n\n/**\n * Get the user/group name from the candidate name or ID\n * @param candidateName - The candidate user/group name\n * @param candidateId - The candidate user/group ID\n * @param reflectStat - Whether to reflect the stat (all, exceptName, none)\n * @returns The user/group name\n */\nconst getUName = (candidateName: string | undefined, candidateId: number, reflectStat: ReflectStats | undefined) => {\n  return candidateName ?? (reflectStat === 'all' ? candidateId.toString() : 'root');\n}\n\n/**\n * Create a DirectoryItem\n * @param path - The path to the directory in the tar archive\n * @param reflectStat - Whether to reflect optional stat of the file (mode, uid, gid, mtime. Default: 'none')\n * @param options - Metadata for the directory including path in tar archive\n * @returns A DirectoryItem\n * @remarks When reflectStat is 'all' or 'exceptName', `options.directoryPath` must be provided.\n */\nexport const createDirectoryItem = async (\n  path: string,\n  reflectStat?: ReflectStats,\n  options?: CreateDirectoryItemOptions\n): Promise<DirectoryItem> => {\n  const rs = reflectStat ?? 'none';\n\n  if (rs !== 'none' && options?.directoryPath) {\n    const stats = await stat(options.directoryPath);\n    const mode = options?.mode ?? stats.mode;\n    const uid = options?.uid ?? stats.uid;\n    const gid = options?.gid ?? stats.gid;\n    const date = options?.date ?? stats.mtime;\n    const uname = getUName(options?.uname, stats.uid, rs);\n    const gname = getUName(options?.gname, stats.gid, rs);\n    return {\n      kind: 'directory',\n      path, mode, uname, gname, uid, gid, date,\n    };\n  } else {\n    const mode = options?.mode ?? 0o755;\n    const uid = options?.uid ?? 0;\n    const gid = options?.gid ?? 0;\n    const date = options?.date ?? new Date();\n    const uname = getUName(options?.uname, undefined, rs);\n    const gname = getUName(options?.gname, undefined, rs);\n    return {\n      kind: 'directory',\n      path, mode, uname, gname, uid, gid, date,\n    };\n  }\n};\n\n/**\n * Create a FileItem from a Readable stream\n * @param path - The path to the file in the tar archive\n * @param reader - The readable stream\n * @param options - Metadata for the file including path in tar archive\n * @returns A FileItem\n */\nexport const createReadableItem = async (\n  path: string,\n  reader: Readable,\n  options?: CreateReadableItemOptions\n): Promise<FileItem> => {\n  let readable = reader;\n\n  // When length is not provided, calculate the total size by reading all chunks\n  let length = options?.length;\n  if (!length) {\n    // Calculate the total size by reading all chunks\n    const chunks: Buffer[] = [];\n    length = 0;\n\n    // Collect all chunks to calculate size\n    for await (const chunk of reader) {\n      const buffer = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk, 'utf8');\n      chunks.push(buffer);\n      length += buffer.length;\n    }\n\n    // Create a new readable stream from the collected chunks\n    readable = Readable.from(chunks);\n  }\n\n  const mode = options?.mode ?? 0o644;\n  const uid = options?.uid ?? 0;\n  const gid = options?.gid ?? 0;\n  const date = options?.date ?? new Date();\n\n  const uname = options?.uname ?? 'root';\n  const gname = options?.gname ?? 'root';\n\n  // Create a FileItem\n  return {\n    kind: 'file',\n    path, mode, uname, gname, uid, gid, date,\n    content: {\n      kind: 'readable',\n      length: length,\n      readable: readable\n    }\n  };\n};\n\n/**\n * Create a FileItem from a local file path\n * @param path - The path to the file in the tar archive\n * @param filePath - The path to the file to read from real filesystem\n * @param reflectStat - Whether to reflect optional stat of the file (mode, uid, gid, mtime. Default: 'exceptName')\n * @param options - Metadata for the file including path in tar archive\n * @returns A FileItem\n */\nexport const createReadFileItem = async (\n  path: string,\n  filePath: string,\n  reflectStat?: ReflectStats,\n  options?: CreateItemOptions\n): Promise<FileItem> => {\n  const rs = reflectStat ?? 'exceptName';\n\n  // Get file stats to extract metadata\n  const stats = await stat(filePath);\n  // Create readable stream from file\n  const reader = createReadStream(filePath);\n\n  const mode = options?.mode ?? (rs !== 'none' ? stats.mode : undefined);\n  const uid = options?.uid ?? (rs !== 'none' ? stats.uid : undefined);\n  const gid = options?.gid ?? (rs !== 'none' ? stats.gid : undefined);\n  const date = options?.date ?? (rs !== 'none' ? stats.mtime : undefined);\n\n  const uname = getUName(options?.uname, stats.uid, rs);\n  const gname = getUName(options?.gname, stats.gid, rs);\n\n  // Create a FileItem\n  return await createReadableItem(path, reader, {\n    length: stats.size, mode, uname, gname, uid, gid, date,\n  });\n};\n\n/**\n * Store a readable stream to a file\n * @param reader - The readable stream\n * @param path - The path to the file to store the readable stream to\n * @returns A promise that resolves when the stream is finished\n */\nexport const storeReaderToFile = (reader: Readable, path: string) => {\n  const writer = createWriteStream(path);\n  reader.pipe(writer);\n  return new Promise<void>((res, rej) => {\n    writer.on('finish', res);\n    writer.on('error', rej);\n  });\n};\n"],"names":["Readable","createGzip","stat","createReadStream","createWriteStream"],"mappings":";;;;;;AAcA,MAAM,iBAAiB,CAAC,QAAgB;AACtC,SAAO,OAAO,WAAW,KAAK,MAAM;AACtC;AAQA,MAAM,mBAAmB,CAAC,KAAa,aAAqB;AAC1D,MAAI,QAAQ;AACZ,MAAI,IAAI;AACR,SAAO,IAAI,IAAI,QAAQ;AACrB,UAAM,YAAY,IAAI,YAAY,CAAC;AACnC,UAAM,OAAO,OAAO,cAAc,SAAS;AAC3C,UAAM,YAAY,OAAO,WAAW,MAAM,MAAM;AAChD,QAAI,QAAQ,YAAY,SAAU;AAClC,aAAS;AACT,SAAK,KAAK;AAAA,EACZ;AACA,SAAO,IAAI,MAAM,GAAG,CAAC;AACvB;AAGA,MAAM,WAAW;AACjB,MAAM,aAAa;AAOnB,MAAM,YAAY,CAAC,SAAiB;AAClC,MAAI,eAAe,IAAI,KAAK,UAAU;AACpC,WAAO,EAAE,QAAQ,IAAI,MAAM,KAAA;AAAA,EAC7B;AAGA,QAAM,QAAQ,KAAK,MAAM,GAAG;AAC5B,MAAI,OAAO,MAAM,IAAA,KAAS;AAC1B,MAAI,SAAS,MAAM,KAAK,GAAG;AAG3B,MAAI,eAAe,IAAI,IAAI,UAAU;AACnC,WAAO,iBAAiB,MAAM,QAAQ;AAAA,EACxC;AAGA,SAAO,eAAe,MAAM,IAAI,YAAY;AAC1C,aAAS,iBAAiB,QAAQ,UAAU;AAAA,EAC9C;AAEA,SAAO,EAAE,QAAQ,KAAA;AACnB;AAUA,MAAM,gBAAgB,CAAC,OAAe,WAAmB;AACvD,QAAM,MAAM,MAAM,SAAS,CAAC,EAAE,SAAS,SAAS,GAAG,GAAG,IAAI;AAC1D,SAAO,OAAO,KAAK,KAAK,OAAO;AACjC;AAOA,MAAM,iBAAiB,CAAC,WAAmB;AACzC,QAAM,QAAQ,OAAO,SAAS;AAC9B,MAAI,UAAU,GAAG;AACf,WAAO;AAAA,EACT,OAAO;AACL,WAAO,OAAO,OAAO,CAAC,QAAQ,OAAO,MAAM,MAAM,OAAO,CAAC,CAAC,CAAC;AAAA,EAC7D;AACF;AAKA,MAAM,kBAAkB,OAAO,MAAM,MAAM,CAAC;AAW5C,MAAM,kBAAkB,CACtB,MACA,MACA,MACA,MACA,OACA,OACA,KACA,KACA,SACG;AAEH,QAAM,SAAS,OAAO,MAAM,KAAK,CAAC;AAGlC,QAAM,EAAE,MAAM,WAAW,UAAU,IAAI;AAGvC,SAAO,MAAM,MAAM,GAAG,KAAK,MAAM;AACjC,gBAAc,OAAO,MAAQ,CAAC,EAAE,KAAK,QAAQ,GAAG;AAChD,gBAAc,KAAK,CAAC,EAAE,KAAK,QAAQ,GAAG;AACtC,gBAAc,KAAK,CAAC,EAAE,KAAK,QAAQ,GAAG;AACtC,gBAAc,MAAM,EAAE,EAAE,KAAK,QAAQ,GAAG;AACxC,gBAAc,KAAK,MAAM,KAAK,QAAA,IAAY,GAAI,GAAG,EAAE,EAAE,KAAK,QAAQ,GAAG;AAGrE,SAAO,KAAK,YAAY,OAAO,EAAE,KAAK,QAAQ,GAAG;AAEjD,MAAI,SAAS,QAAQ;AACnB,WAAO,MAAM,KAAK,KAAK,GAAG,OAAO;AAAA,EACnC,OAAO;AACL,WAAO,MAAM,KAAK,KAAK,GAAG,OAAO;AAAA,EACnC;AACA,SAAO,MAAM,WAAW,KAAK,GAAG,OAAO;AACvC,SAAO,MAAM,MAAM,KAAK,GAAG,OAAO;AAClC,SAAO,MAAM,OAAO,KAAK,IAAI,MAAM;AACnC,SAAO,MAAM,OAAO,KAAK,IAAI,MAAM;AACnC,SAAO,MAAM,QAAQ,KAAK,KAAK,MAAM;AAGrC,MAAI,MAAM;AACV,WAAS,IAAI,GAAG,IAAI,KAAK,KAAK;AAC5B,WAAO,OAAO,CAAC;AAAA,EACjB;AACA,gBAAc,KAAK,CAAC,EAAE,KAAK,QAAQ,GAAG;AAEtC,SAAO;AACT;AAWO,MAAM,kBAAkB,CAC7B,oBACA,iBACA,WAAyB;AAGzB,QAAM,oBAAoB,mBAAkB;AAE1C,qBAAiB,aAAa,oBAAoB;AAChD,cAAQ,eAAA;AAER,cAAQ,UAAU,MAAA;AAAA;AAAA,QAEhB,KAAK,QAAQ;AACX,gBAAM,mBAAmB,UAAU;AAEnC,cAAI,OAAO,qBAAqB,UAAU;AAExC,kBAAM,eAAe,OAAO,KAAK,kBAAkB,MAAM;AAGzD,kBAAM,iBAAiB;AAAA,cACrB;AAAA,cACA,UAAU;AAAA,cACV,aAAa;AAAA,cACb,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,YAAA;AACZ,kBAAM;AAGN,kBAAM,qBAAqB,eAAe,YAAY;AACtD,kBAAM;AAAA,UAGR,WAAW,OAAO,SAAS,gBAAgB,GAAG;AAE5C,kBAAM,iBAAiB;AAAA,cACrB;AAAA,cACA,UAAU;AAAA,cACV,iBAAiB;AAAA,cACjB,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,YAAA;AACZ,kBAAM;AAGN,kBAAM,qBAAqB,eAAe,gBAAgB;AAC1D,kBAAM;AAAA,UAER,OAAO;AAEL,kBAAM,iBAAiB;AAAA,cACrB;AAAA,cACA,UAAU;AAAA,cACV,iBAAiB;AAAA,cACjB,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,YAAA;AACZ,kBAAM;AAEN,oBAAQ,iBAAiB,MAAA;AAAA;AAAA,cAEvB,KAAK,aAAa;AAChB,oBAAI,WAAW;AACf,iCAAiB,wBAAwB,iBAAiB,WAAW;AACnE,0BAAQ,eAAA;AACR,wBAAM;AACN,8BAAY,qBAAqB;AAAA,gBACnC;AAGA,oBAAI,WAAW,QAAQ,GAAG;AACxB,0BAAQ,eAAA;AACR,wBAAM,OAAO,MAAM,MAAO,WAAW,KAAM,CAAC;AAAA,gBAC9C;AACA;AAAA,cACF;AAAA;AAAA,cAEA,KAAK,YAAY;AACf,oBAAI,WAAW;AACf,iCAAiB,WAAW,iBAAiB,UAAU;AACrD,0BAAQ,eAAA;AACR,sBAAI,OAAO,YAAY,UAAU;AAC/B,0BAAM,cAAc,OAAO,KAAK,SAAS,MAAM;AAC/C,0BAAM;AACN,gCAAY,YAAY;AAAA,kBAC1B,WAAW,OAAO,SAAS,OAAO,GAAG;AACnC,0BAAM;AACN,gCAAY,QAAQ;AAAA,kBACtB;AAAA,gBACF;AAGA,oBAAI,WAAW,QAAQ,GAAG;AACxB,0BAAQ,eAAA;AACR,wBAAM,OAAO,MAAM,MAAO,WAAW,KAAM,CAAC;AAAA,gBAC9C;AACA;AAAA,cACF;AAAA,YAAA;AAAA,UAEJ;AACA;AAAA,QACF;AAAA;AAAA,QAEA,KAAK,aAAa;AAEhB,gBAAM,iBAAiB;AAAA,YACrB;AAAA,YACA,UAAU;AAAA,YACV;AAAA,YACA,UAAU;AAAA,YACV,UAAU;AAAA,YACV,UAAU;AAAA,YACV,UAAU;AAAA,YACV,UAAU;AAAA,YACV,UAAU;AAAA,UAAA;AAEZ,gBAAM;AACN;AAAA,QACF;AAAA,MAAA;AAAA,IAEJ;AAGA,UAAM;AAAA,EACR;AAEA,QAAM,KAAK,mBAAmB;AAE9B,UAAQ,IAAA;AAAA;AAAA,IAEN,KAAK,QAAQ;AAEX,aAAOA,OAAAA,SAAS,KAAK,mBAAmB;AAAA,IAC1C;AAAA;AAAA,IAEA,KAAK,QAAQ;AAEX,YAAM,aAAaC,KAAAA,WAAW,EAAE,OAAO,GAAG;AAE1C,YAAM,kBAAkBD,OAAAA,SAAS,KAAK,kBAAA,CAAmB;AAEzD,sBAAgB,KAAK,UAAU;AAE/B,aAAO;AAAA,IACT;AAAA,EAAA;AAEJ;ACrTA,MAAM,WAAW,CAAC,eAAmC,aAAqB,gBAA0C;AAClH,SAAO,kBAAkB,gBAAgB,QAAQ,YAAY,aAAa;AAC5E;AAUO,MAAM,sBAAsB,OACjC,MACA,aACA,YAC2B;AAC3B,QAAM,KAAK,eAAe;AAE1B,MAAI,OAAO,UAAU,SAAS,eAAe;AAC3C,UAAM,QAAQ,MAAME,cAAK,QAAQ,aAAa;AAC9C,UAAM,OAAO,SAAS,QAAQ,MAAM;AACpC,UAAM,MAAM,SAAS,OAAO,MAAM;AAClC,UAAM,MAAM,SAAS,OAAO,MAAM;AAClC,UAAM,OAAO,SAAS,QAAQ,MAAM;AACpC,UAAM,QAAQ,SAAS,SAAS,OAAO,MAAM,KAAK,EAAE;AACpD,UAAM,QAAQ,SAAS,SAAS,OAAO,MAAM,KAAK,EAAE;AACpD,WAAO;AAAA,MACL,MAAM;AAAA,MACN;AAAA,MAAM;AAAA,MAAM;AAAA,MAAO;AAAA,MAAO;AAAA,MAAK;AAAA,MAAK;AAAA,IAAA;AAAA,EAExC,OAAO;AACL,UAAM,OAAO,SAAS,QAAQ;AAC9B,UAAM,MAAM,SAAS,OAAO;AAC5B,UAAM,MAAM,SAAS,OAAO;AAC5B,UAAM,OAAO,SAAS,QAAQ,oBAAI,KAAA;AAClC,UAAM,QAAQ,SAAS,SAAS,OAAO,QAAW,EAAE;AACpD,UAAM,QAAQ,SAAS,SAAS,OAAO,QAAW,EAAE;AACpD,WAAO;AAAA,MACL,MAAM;AAAA,MACN;AAAA,MAAM;AAAA,MAAM;AAAA,MAAO;AAAA,MAAO;AAAA,MAAK;AAAA,MAAK;AAAA,IAAA;AAAA,EAExC;AACF;AASO,MAAM,qBAAqB,OAChC,MACA,QACA,YACsB;AACtB,MAAI,WAAW;AAGf,MAAI,SAAS,SAAS;AACtB,MAAI,CAAC,QAAQ;AAEX,UAAM,SAAmB,CAAA;AACzB,aAAS;AAGT,qBAAiB,SAAS,QAAQ;AAChC,YAAM,SAAS,OAAO,SAAS,KAAK,IAAI,QAAQ,OAAO,KAAK,OAAO,MAAM;AACzE,aAAO,KAAK,MAAM;AAClB,gBAAU,OAAO;AAAA,IACnB;AAGA,eAAWF,OAAAA,SAAS,KAAK,MAAM;AAAA,EACjC;AAEA,QAAM,OAAO,SAAS,QAAQ;AAC9B,QAAM,MAAM,SAAS,OAAO;AAC5B,QAAM,MAAM,SAAS,OAAO;AAC5B,QAAM,OAAO,SAAS,QAAQ,oBAAI,KAAA;AAElC,QAAM,QAAQ,SAAS,SAAS;AAChC,QAAM,QAAQ,SAAS,SAAS;AAGhC,SAAO;AAAA,IACL,MAAM;AAAA,IACN;AAAA,IAAM;AAAA,IAAM;AAAA,IAAO;AAAA,IAAO;AAAA,IAAK;AAAA,IAAK;AAAA,IACpC,SAAS;AAAA,MACP,MAAM;AAAA,MACN;AAAA,MACA;AAAA,IAAA;AAAA,EACF;AAEJ;AAUO,MAAM,qBAAqB,OAChC,MACA,UACA,aACA,YACsB;AACtB,QAAM,KAAK,eAAe;AAG1B,QAAM,QAAQ,MAAME,SAAAA,KAAK,QAAQ;AAEjC,QAAM,SAASC,GAAAA,iBAAiB,QAAQ;AAExC,QAAM,OAAO,SAAS,SAAS,OAAO,SAAS,MAAM,OAAO;AAC5D,QAAM,MAAM,SAAS,QAAQ,OAAO,SAAS,MAAM,MAAM;AACzD,QAAM,MAAM,SAAS,QAAQ,OAAO,SAAS,MAAM,MAAM;AACzD,QAAM,OAAO,SAAS,SAAS,OAAO,SAAS,MAAM,QAAQ;AAE7D,QAAM,QAAQ,SAAS,SAAS,OAAO,MAAM,KAAK,EAAE;AACpD,QAAM,QAAQ,SAAS,SAAS,OAAO,MAAM,KAAK,EAAE;AAGpD,SAAO,MAAM,mBAAmB,MAAM,QAAQ;AAAA,IAC5C,QAAQ,MAAM;AAAA,IAAM;AAAA,IAAM;AAAA,IAAO;AAAA,IAAO;AAAA,IAAK;AAAA,IAAK;AAAA,EAAA,CACnD;AACH;AAQO,MAAM,oBAAoB,CAAC,QAAkB,SAAiB;AACnE,QAAM,SAASC,GAAAA,kBAAkB,IAAI;AACrC,SAAO,KAAK,MAAM;AAClB,SAAO,IAAI,QAAc,CAAC,KAAK,QAAQ;AACrC,WAAO,GAAG,UAAU,GAAG;AACvB,WAAO,GAAG,SAAS,GAAG;AAAA,EACxB,CAAC;AACH;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * name: tar-vern
+ * version: 0.1.0
+ * description: Tape archiver library for Typescript
+ * author: Kouji Matsui (@kekyo@mi.kekyo.net)
+ * license: MIT
+ * repository.url: https://github.com/kekyo/tar-vern.git
+ */
+
+export type * from './types';
+export * from './packer';
+export * from './utils';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,mBAAmB,SAAS,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,324 @@
+/*!
+ * name: tar-vern
+ * version: 0.1.0
+ * description: Tape archiver library for Typescript
+ * author: Kouji Matsui (@kekyo@mi.kekyo.net)
+ * license: MIT
+ * repository.url: https://github.com/kekyo/tar-vern.git
+ */
+import { Readable } from "stream";
+import { createGzip } from "zlib";
+import { createReadStream, createWriteStream } from "fs";
+import { stat } from "fs/promises";
+const utf8ByteLength = (str) => {
+  return Buffer.byteLength(str, "utf8");
+};
+const truncateUtf8Safe = (str, maxBytes) => {
+  let total = 0;
+  let i = 0;
+  while (i < str.length) {
+    const codePoint = str.codePointAt(i);
+    const char = String.fromCodePoint(codePoint);
+    const charBytes = Buffer.byteLength(char, "utf8");
+    if (total + charBytes > maxBytes) break;
+    total += charBytes;
+    i += char.length;
+  }
+  return str.slice(0, i);
+};
+const MAX_NAME = 100;
+const MAX_PREFIX = 155;
+const splitPath = (path) => {
+  if (utf8ByteLength(path) <= MAX_NAME) {
+    return { prefix: "", name: path };
+  }
+  const parts = path.split("/");
+  let name = parts.pop() ?? "";
+  let prefix = parts.join("/");
+  if (utf8ByteLength(name) > MAX_NAME) {
+    name = truncateUtf8Safe(name, MAX_NAME);
+  }
+  while (utf8ByteLength(prefix) > MAX_PREFIX) {
+    prefix = truncateUtf8Safe(prefix, MAX_PREFIX);
+  }
+  return { prefix, name };
+};
+const getOctalBytes = (value, length) => {
+  const str = value.toString(8).padStart(length - 1, "0") + "\0";
+  return Buffer.from(str, "ascii");
+};
+const getPaddedBytes = (buffer) => {
+  const extra = buffer.length % 512;
+  if (extra === 0) {
+    return buffer;
+  } else {
+    return Buffer.concat([buffer, Buffer.alloc(512 - extra, 0)]);
+  }
+};
+const terminatorBytes = Buffer.alloc(1024, 0);
+const createTarHeader = (type, path, size, mode, uname, gname, uid, gid, date) => {
+  const buffer = Buffer.alloc(512, 0);
+  const { name, prefix } = splitPath(path);
+  buffer.write(name, 0, 100, "utf8");
+  getOctalBytes(mode & 4095, 8).copy(buffer, 100);
+  getOctalBytes(uid, 8).copy(buffer, 108);
+  getOctalBytes(gid, 8).copy(buffer, 116);
+  getOctalBytes(size, 12).copy(buffer, 124);
+  getOctalBytes(Math.floor(date.getTime() / 1e3), 12).copy(buffer, 136);
+  Buffer.from("        ", "ascii").copy(buffer, 148);
+  if (type === "file") {
+    buffer.write("0", 156, 1, "ascii");
+  } else {
+    buffer.write("5", 156, 1, "ascii");
+  }
+  buffer.write("ustar\0", 257, 6, "ascii");
+  buffer.write("00", 263, 2, "ascii");
+  buffer.write(uname, 265, 32, "utf8");
+  buffer.write(gname, 297, 32, "utf8");
+  buffer.write(prefix, 345, 155, "utf8");
+  let sum = 0;
+  for (let i = 0; i < 512; i++) {
+    sum += buffer[i];
+  }
+  getOctalBytes(sum, 8).copy(buffer, 148);
+  return buffer;
+};
+const createTarPacker = (entryItemGenerator, compressionType, signal) => {
+  const entryItemIterator = async function* () {
+    for await (const entryItem of entryItemGenerator) {
+      signal?.throwIfAborted();
+      switch (entryItem.kind) {
+        // Entry is a file
+        case "file": {
+          const entryItemContent = entryItem.content;
+          if (typeof entryItemContent === "string") {
+            const contentBytes = Buffer.from(entryItemContent, "utf8");
+            const tarHeaderBytes = createTarHeader(
+              "file",
+              entryItem.path,
+              contentBytes.length,
+              entryItem.mode,
+              entryItem.uname,
+              entryItem.gname,
+              entryItem.uid,
+              entryItem.gid,
+              entryItem.date
+            );
+            yield tarHeaderBytes;
+            const paddedContentBytes = getPaddedBytes(contentBytes);
+            yield paddedContentBytes;
+          } else if (Buffer.isBuffer(entryItemContent)) {
+            const tarHeaderBytes = createTarHeader(
+              "file",
+              entryItem.path,
+              entryItemContent.length,
+              entryItem.mode,
+              entryItem.uname,
+              entryItem.gname,
+              entryItem.uid,
+              entryItem.gid,
+              entryItem.date
+            );
+            yield tarHeaderBytes;
+            const paddedContentBytes = getPaddedBytes(entryItemContent);
+            yield paddedContentBytes;
+          } else {
+            const tarHeaderBytes = createTarHeader(
+              "file",
+              entryItem.path,
+              entryItemContent.length,
+              entryItem.mode,
+              entryItem.uname,
+              entryItem.gname,
+              entryItem.uid,
+              entryItem.gid,
+              entryItem.date
+            );
+            yield tarHeaderBytes;
+            switch (entryItemContent.kind) {
+              // Content is a generator
+              case "generator": {
+                let position = 0;
+                for await (const contentFragmentBytes of entryItemContent.generator) {
+                  signal?.throwIfAborted();
+                  yield contentFragmentBytes;
+                  position += contentFragmentBytes.length;
+                }
+                if (position % 512 !== 0) {
+                  signal?.throwIfAborted();
+                  yield Buffer.alloc(512 - position % 512, 0);
+                }
+                break;
+              }
+              // Content is a readable stream
+              case "readable": {
+                let position = 0;
+                for await (const content of entryItemContent.readable) {
+                  signal?.throwIfAborted();
+                  if (typeof content === "string") {
+                    const stringBytes = Buffer.from(content, "utf8");
+                    yield stringBytes;
+                    position += stringBytes.length;
+                  } else if (Buffer.isBuffer(content)) {
+                    yield content;
+                    position += content.length;
+                  }
+                }
+                if (position % 512 !== 0) {
+                  signal?.throwIfAborted();
+                  yield Buffer.alloc(512 - position % 512, 0);
+                }
+                break;
+              }
+            }
+          }
+          break;
+        }
+        // Entry is a directory
+        case "directory": {
+          const tarHeaderBytes = createTarHeader(
+            "directory",
+            entryItem.path,
+            0,
+            entryItem.mode,
+            entryItem.uname,
+            entryItem.gname,
+            entryItem.uid,
+            entryItem.gid,
+            entryItem.date
+          );
+          yield tarHeaderBytes;
+          break;
+        }
+      }
+    }
+    yield terminatorBytes;
+  };
+  const ct = compressionType ?? "none";
+  switch (ct) {
+    // No compression
+    case "none": {
+      return Readable.from(entryItemIterator());
+    }
+    // Gzip compression
+    case "gzip": {
+      const gzipStream = createGzip({ level: 9 });
+      const entryItemStream = Readable.from(entryItemIterator());
+      entryItemStream.pipe(gzipStream);
+      return gzipStream;
+    }
+  }
+};
+const getUName = (candidateName, candidateId, reflectStat) => {
+  return candidateName ?? (reflectStat === "all" ? candidateId.toString() : "root");
+};
+const createDirectoryItem = async (path, reflectStat, options) => {
+  const rs = reflectStat ?? "none";
+  if (rs !== "none" && options?.directoryPath) {
+    const stats = await stat(options.directoryPath);
+    const mode = options?.mode ?? stats.mode;
+    const uid = options?.uid ?? stats.uid;
+    const gid = options?.gid ?? stats.gid;
+    const date = options?.date ?? stats.mtime;
+    const uname = getUName(options?.uname, stats.uid, rs);
+    const gname = getUName(options?.gname, stats.gid, rs);
+    return {
+      kind: "directory",
+      path,
+      mode,
+      uname,
+      gname,
+      uid,
+      gid,
+      date
+    };
+  } else {
+    const mode = options?.mode ?? 493;
+    const uid = options?.uid ?? 0;
+    const gid = options?.gid ?? 0;
+    const date = options?.date ?? /* @__PURE__ */ new Date();
+    const uname = getUName(options?.uname, void 0, rs);
+    const gname = getUName(options?.gname, void 0, rs);
+    return {
+      kind: "directory",
+      path,
+      mode,
+      uname,
+      gname,
+      uid,
+      gid,
+      date
+    };
+  }
+};
+const createReadableItem = async (path, reader, options) => {
+  let readable = reader;
+  let length = options?.length;
+  if (!length) {
+    const chunks = [];
+    length = 0;
+    for await (const chunk of reader) {
+      const buffer = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk, "utf8");
+      chunks.push(buffer);
+      length += buffer.length;
+    }
+    readable = Readable.from(chunks);
+  }
+  const mode = options?.mode ?? 420;
+  const uid = options?.uid ?? 0;
+  const gid = options?.gid ?? 0;
+  const date = options?.date ?? /* @__PURE__ */ new Date();
+  const uname = options?.uname ?? "root";
+  const gname = options?.gname ?? "root";
+  return {
+    kind: "file",
+    path,
+    mode,
+    uname,
+    gname,
+    uid,
+    gid,
+    date,
+    content: {
+      kind: "readable",
+      length,
+      readable
+    }
+  };
+};
+const createReadFileItem = async (path, filePath, reflectStat, options) => {
+  const rs = reflectStat ?? "exceptName";
+  const stats = await stat(filePath);
+  const reader = createReadStream(filePath);
+  const mode = options?.mode ?? (rs !== "none" ? stats.mode : void 0);
+  const uid = options?.uid ?? (rs !== "none" ? stats.uid : void 0);
+  const gid = options?.gid ?? (rs !== "none" ? stats.gid : void 0);
+  const date = options?.date ?? (rs !== "none" ? stats.mtime : void 0);
+  const uname = getUName(options?.uname, stats.uid, rs);
+  const gname = getUName(options?.gname, stats.gid, rs);
+  return await createReadableItem(path, reader, {
+    length: stats.size,
+    mode,
+    uname,
+    gname,
+    uid,
+    gid,
+    date
+  });
+};
+const storeReaderToFile = (reader, path) => {
+  const writer = createWriteStream(path);
+  reader.pipe(writer);
+  return new Promise((res, rej) => {
+    writer.on("finish", res);
+    writer.on("error", rej);
+  });
+};
+export {
+  createDirectoryItem,
+  createReadFileItem,
+  createReadableItem,
+  createTarPacker,
+  storeReaderToFile
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/packer.ts","../src/utils.ts"],"sourcesContent":["// tar-vern - Tape archiver library for Typescript\n// Copyright (c) Kouji Matsui (@kekyo@mi.kekyo.net)\n// Under MIT.\n// https://github.com/kekyo/tar-vern/\n\nimport { Readable } from \"stream\";\nimport { CompressionTypes, EntryItem } from \"./types\";\nimport { createGzip } from \"zlib\";\n\n/**\n * Get the byte length of a string in UTF-8\n * @param str - The string to get the byte length of\n * @returns The byte length of the string\n */\nconst utf8ByteLength = (str: string) => {\n  return Buffer.byteLength(str, \"utf8\");\n}\n\n/**\n * Truncate a string to a maximum byte length in UTF-8\n * @param str - The string to truncate\n * @param maxBytes - The maximum byte length\n * @returns The truncated string\n */\nconst truncateUtf8Safe = (str: string, maxBytes: number) => {\n  let total = 0;\n  let i = 0;\n  while (i < str.length) {\n    const codePoint = str.codePointAt(i)!;\n    const char = String.fromCodePoint(codePoint);\n    const charBytes = Buffer.byteLength(char, \"utf8\");\n    if (total + charBytes > maxBytes) break;\n    total += charBytes;\n    i += char.length;\n  }\n  return str.slice(0, i);\n}\n\n// Tar specification: name max 100 bytes, prefix max 155 bytes\nconst MAX_NAME = 100;\nconst MAX_PREFIX = 155;\n\n/**\n * Split a path into a name and a prefix\n * @param path - The path to split\n * @returns The name and prefix\n */\nconst splitPath = (path: string) => {\n  if (utf8ByteLength(path) <= MAX_NAME) {\n    return { prefix: \"\", name: path };\n  }\n\n  // Split by '/' and find the part that fits in name from the end\n  const parts = path.split(\"/\");\n  let name = parts.pop() ?? \"\";\n  let prefix = parts.join(\"/\");\n\n  // Truncate if name exceeds 100 bytes\n  if (utf8ByteLength(name) > MAX_NAME) {\n    name = truncateUtf8Safe(name, MAX_NAME);\n  }\n\n  // Truncate if prefix exceeds 155 bytes\n  while (utf8ByteLength(prefix) > MAX_PREFIX) {\n    prefix = truncateUtf8Safe(prefix, MAX_PREFIX);\n  }\n\n  return { prefix, name };\n}\n\n///////////////////////////////////////////////////////////////////////////////////\n\n/**\n * Get octal bytes from a number\n * @param value - The number to get octal bytes from\n * @param length - The length of the octal bytes\n * @returns The octal bytes\n */\nconst getOctalBytes = (value: number, length: number) => {\n  const str = value.toString(8).padStart(length - 1, \"0\") + \"\\0\";\n  return Buffer.from(str, \"ascii\");\n};\n\n/**\n * Get padded bytes from a buffer\n * @param buffer - The buffer to get padded bytes from\n * @returns The padded bytes\n */\nconst getPaddedBytes = (buffer: Buffer) => {\n  const extra = buffer.length % 512;\n  if (extra === 0) {\n    return buffer;\n  } else {\n    return Buffer.concat([buffer, Buffer.alloc(512 - extra, 0)]);\n  }\n}\n\n/**\n * The terminator bytes\n */\nconst terminatorBytes = Buffer.alloc(1024, 0);\n\n/**\n * Create a tar header\n * @param type - The type of the entry\n * @param path - The path of the entry\n * @param size - The size of the entry\n * @param mode - The mode of the entry\n * @param uname - The user name of the entry\n * @param gname - The group name of the entry\n */\nconst createTarHeader = (\n  type: 'file' | 'directory',\n  path: string,\n  size: number,\n  mode: number,\n  uname: string,\n  gname: string,\n  uid: number,\n  gid: number,\n  date: Date\n) => {\n  // Allocate header bytes\n  const buffer = Buffer.alloc(512, 0);\n\n  // Split path into name and prefix\n  const { name, prefix } = splitPath(path);\n\n  // Write name, mode, uid, gid, size, mtime, typeflag, prefix, checksum\n  buffer.write(name, 0, 100, \"utf8\");\n  getOctalBytes(mode & 0o7777, 8).copy(buffer, 100);\n  getOctalBytes(uid, 8).copy(buffer, 108);\n  getOctalBytes(gid, 8).copy(buffer, 116);\n  getOctalBytes(size, 12).copy(buffer, 124);\n  getOctalBytes(Math.floor(date.getTime() / 1000), 12).copy(buffer, 136);\n\n  // Check sum space\n  Buffer.from(\"        \", \"ascii\").copy(buffer, 148);\n\n  if (type === 'file') {\n    buffer.write(\"0\", 156, 1, \"ascii\");    // typeflag (file)\n  } else {\n    buffer.write(\"5\", 156, 1, \"ascii\");    // typeflag (directory)\n  }\n  buffer.write(\"ustar\\0\", 257, 6, \"ascii\");\n  buffer.write(\"00\", 263, 2, \"ascii\");     // version\n  buffer.write(uname, 265, 32, \"utf8\");\n  buffer.write(gname, 297, 32, \"utf8\");\n  buffer.write(prefix, 345, 155, \"utf8\");  // Path prefix\n\n  // Calculate check sum\n  let sum = 0;\n  for (let i = 0; i < 512; i++) {\n    sum += buffer[i];\n  }\n  getOctalBytes(sum, 8).copy(buffer, 148);\n\n  return buffer;\n}\n\n///////////////////////////////////////////////////////////////////////////////////\n\n/**\n * Create a tar packer\n * @param entryItemGenerator - The async generator of the entry items\n * @param compressionType - The compression type to use (Default: 'none')\n * @param signal - The abort signal to cancel the tar packer\n * @returns Readable stream of the tar packer\n */\nexport const createTarPacker = (\n  entryItemGenerator: AsyncGenerator<EntryItem, void, unknown>,\n  compressionType?: CompressionTypes,\n  signal?: AbortSignal) => {\n\n  // Create async generator function from entry item iterator\n  const entryItemIterator = async function*() {\n    // Iterate over the entry items\n    for await (const entryItem of entryItemGenerator) {\n      signal?.throwIfAborted();\n\n      switch (entryItem.kind) {\n        // Entry is a file\n        case 'file': {\n          const entryItemContent = entryItem.content;\n          // Content is a string\n          if (typeof entryItemContent === 'string') {\n            // Get content bytes from string\n            const contentBytes = Buffer.from(entryItemContent, \"utf8\");\n\n            // Create and produce tar header bytes\n            const tarHeaderBytes = createTarHeader(\n              'file',\n              entryItem.path,\n              contentBytes.length,\n              entryItem.mode,\n              entryItem.uname,\n              entryItem.gname,\n              entryItem.uid,\n              entryItem.gid,\n              entryItem.date);\n            yield tarHeaderBytes;\n\n            // Content bytes to adjust padding space and produce\n            const paddedContentBytes = getPaddedBytes(contentBytes);\n            yield paddedContentBytes;\n\n          // Content is a buffer\n          } else if (Buffer.isBuffer(entryItemContent)) {\n            // Create and produce tar header bytes\n            const tarHeaderBytes = createTarHeader(\n              'file',\n              entryItem.path,\n              entryItemContent.length,\n              entryItem.mode,\n              entryItem.uname,\n              entryItem.gname,\n              entryItem.uid,\n              entryItem.gid,\n              entryItem.date);\n            yield tarHeaderBytes;\n\n            // Content bytes to adjust padding space and produce\n            const paddedContentBytes = getPaddedBytes(entryItemContent);\n            yield paddedContentBytes;\n\n          } else {\n            // Create and produce tar header bytes\n            const tarHeaderBytes = createTarHeader(\n              'file',\n              entryItem.path,\n              entryItemContent.length,\n              entryItem.mode,\n              entryItem.uname,\n              entryItem.gname,\n              entryItem.uid,\n              entryItem.gid,\n              entryItem.date);\n            yield tarHeaderBytes;\n\n            switch (entryItemContent.kind) {\n              // Content is a generator\n              case 'generator': {\n                let position = 0;\n                for await (const contentFragmentBytes of entryItemContent.generator) {\n                  signal?.throwIfAborted();\n                  yield contentFragmentBytes;\n                  position += contentFragmentBytes.length;\n                }\n\n                // Padding space\n                if (position % 512 !== 0) {\n                  signal?.throwIfAborted();\n                  yield Buffer.alloc(512 - (position % 512), 0);\n                }\n                break;\n              }\n              // Content is a readable stream\n              case 'readable': {\n                let position = 0;\n                for await (const content of entryItemContent.readable) {\n                  signal?.throwIfAborted();\n                  if (typeof content === 'string') {\n                    const stringBytes = Buffer.from(content, \"utf8\");\n                    yield stringBytes;\n                    position += stringBytes.length;\n                  } else if (Buffer.isBuffer(content)) {\n                    yield content;\n                    position += content.length;\n                  }\n                }\n\n                // Padding space\n                if (position % 512 !== 0) {\n                  signal?.throwIfAborted();\n                  yield Buffer.alloc(512 - (position % 512), 0);\n                }\n                break;\n              }\n            }\n          }\n          break;\n        }\n        // Entry is a directory\n        case 'directory': {\n          // Create and produce tar header bytes\n          const tarHeaderBytes = createTarHeader(\n            'directory',\n            entryItem.path,\n            0,\n            entryItem.mode,\n            entryItem.uname,\n            entryItem.gname,\n            entryItem.uid,\n            entryItem.gid,\n            entryItem.date\n          );\n          yield tarHeaderBytes;\n          break;\n        }\n      }\n    }\n\n    // Terminates for tar stream\n    yield terminatorBytes;\n  };\n\n  const ct = compressionType ?? 'none';\n\n  switch (ct) {\n    // No compression\n    case 'none': {\n      // Create readable stream from entry item iterator\n      return Readable.from(entryItemIterator());\n    }\n    // Gzip compression\n    case 'gzip': {\n      // Create gzip stream\n      const gzipStream = createGzip({ level: 9 });\n      // Create readable stream from entry item iterator\n      const entryItemStream = Readable.from(entryItemIterator());\n      // Pipe the entry item stream to the gzip stream\n      entryItemStream.pipe(gzipStream);\n      // Return the gzip stream\n      return gzipStream;\n    }\n  }\n};\n","// tar-vern - Tape archiver library for Typescript\n// Copyright (c) Kouji Matsui (@kekyo@mi.kekyo.net)\n// Under MIT.\n// https://github.com/kekyo/tar-vern/\n\nimport { createReadStream, createWriteStream } from \"fs\";\nimport { stat } from \"fs/promises\";\nimport { Readable } from \"stream\";\nimport { CreateItemOptions, CreateReadableItemOptions, FileItem, DirectoryItem, ReflectStats, CreateDirectoryItemOptions } from \"./types\";\n\n/**\n * Get the user/group name from the candidate name or ID\n * @param candidateName - The candidate user/group name\n * @param candidateId - The candidate user/group ID\n * @param reflectStat - Whether to reflect the stat (all, exceptName, none)\n * @returns The user/group name\n */\nconst getUName = (candidateName: string | undefined, candidateId: number, reflectStat: ReflectStats | undefined) => {\n  return candidateName ?? (reflectStat === 'all' ? candidateId.toString() : 'root');\n}\n\n/**\n * Create a DirectoryItem\n * @param path - The path to the directory in the tar archive\n * @param reflectStat - Whether to reflect optional stat of the file (mode, uid, gid, mtime. Default: 'none')\n * @param options - Metadata for the directory including path in tar archive\n * @returns A DirectoryItem\n * @remarks When reflectStat is 'all' or 'exceptName', `options.directoryPath` must be provided.\n */\nexport const createDirectoryItem = async (\n  path: string,\n  reflectStat?: ReflectStats,\n  options?: CreateDirectoryItemOptions\n): Promise<DirectoryItem> => {\n  const rs = reflectStat ?? 'none';\n\n  if (rs !== 'none' && options?.directoryPath) {\n    const stats = await stat(options.directoryPath);\n    const mode = options?.mode ?? stats.mode;\n    const uid = options?.uid ?? stats.uid;\n    const gid = options?.gid ?? stats.gid;\n    const date = options?.date ?? stats.mtime;\n    const uname = getUName(options?.uname, stats.uid, rs);\n    const gname = getUName(options?.gname, stats.gid, rs);\n    return {\n      kind: 'directory',\n      path, mode, uname, gname, uid, gid, date,\n    };\n  } else {\n    const mode = options?.mode ?? 0o755;\n    const uid = options?.uid ?? 0;\n    const gid = options?.gid ?? 0;\n    const date = options?.date ?? new Date();\n    const uname = getUName(options?.uname, undefined, rs);\n    const gname = getUName(options?.gname, undefined, rs);\n    return {\n      kind: 'directory',\n      path, mode, uname, gname, uid, gid, date,\n    };\n  }\n};\n\n/**\n * Create a FileItem from a Readable stream\n * @param path - The path to the file in the tar archive\n * @param reader - The readable stream\n * @param options - Metadata for the file including path in tar archive\n * @returns A FileItem\n */\nexport const createReadableItem = async (\n  path: string,\n  reader: Readable,\n  options?: CreateReadableItemOptions\n): Promise<FileItem> => {\n  let readable = reader;\n\n  // When length is not provided, calculate the total size by reading all chunks\n  let length = options?.length;\n  if (!length) {\n    // Calculate the total size by reading all chunks\n    const chunks: Buffer[] = [];\n    length = 0;\n\n    // Collect all chunks to calculate size\n    for await (const chunk of reader) {\n      const buffer = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk, 'utf8');\n      chunks.push(buffer);\n      length += buffer.length;\n    }\n\n    // Create a new readable stream from the collected chunks\n    readable = Readable.from(chunks);\n  }\n\n  const mode = options?.mode ?? 0o644;\n  const uid = options?.uid ?? 0;\n  const gid = options?.gid ?? 0;\n  const date = options?.date ?? new Date();\n\n  const uname = options?.uname ?? 'root';\n  const gname = options?.gname ?? 'root';\n\n  // Create a FileItem\n  return {\n    kind: 'file',\n    path, mode, uname, gname, uid, gid, date,\n    content: {\n      kind: 'readable',\n      length: length,\n      readable: readable\n    }\n  };\n};\n\n/**\n * Create a FileItem from a local file path\n * @param path - The path to the file in the tar archive\n * @param filePath - The path to the file to read from real filesystem\n * @param reflectStat - Whether to reflect optional stat of the file (mode, uid, gid, mtime. Default: 'exceptName')\n * @param options - Metadata for the file including path in tar archive\n * @returns A FileItem\n */\nexport const createReadFileItem = async (\n  path: string,\n  filePath: string,\n  reflectStat?: ReflectStats,\n  options?: CreateItemOptions\n): Promise<FileItem> => {\n  const rs = reflectStat ?? 'exceptName';\n\n  // Get file stats to extract metadata\n  const stats = await stat(filePath);\n  // Create readable stream from file\n  const reader = createReadStream(filePath);\n\n  const mode = options?.mode ?? (rs !== 'none' ? stats.mode : undefined);\n  const uid = options?.uid ?? (rs !== 'none' ? stats.uid : undefined);\n  const gid = options?.gid ?? (rs !== 'none' ? stats.gid : undefined);\n  const date = options?.date ?? (rs !== 'none' ? stats.mtime : undefined);\n\n  const uname = getUName(options?.uname, stats.uid, rs);\n  const gname = getUName(options?.gname, stats.gid, rs);\n\n  // Create a FileItem\n  return await createReadableItem(path, reader, {\n    length: stats.size, mode, uname, gname, uid, gid, date,\n  });\n};\n\n/**\n * Store a readable stream to a file\n * @param reader - The readable stream\n * @param path - The path to the file to store the readable stream to\n * @returns A promise that resolves when the stream is finished\n */\nexport const storeReaderToFile = (reader: Readable, path: string) => {\n  const writer = createWriteStream(path);\n  reader.pipe(writer);\n  return new Promise<void>((res, rej) => {\n    writer.on('finish', res);\n    writer.on('error', rej);\n  });\n};\n"],"names":[],"mappings":";;;;AAcA,MAAM,iBAAiB,CAAC,QAAgB;AACtC,SAAO,OAAO,WAAW,KAAK,MAAM;AACtC;AAQA,MAAM,mBAAmB,CAAC,KAAa,aAAqB;AAC1D,MAAI,QAAQ;AACZ,MAAI,IAAI;AACR,SAAO,IAAI,IAAI,QAAQ;AACrB,UAAM,YAAY,IAAI,YAAY,CAAC;AACnC,UAAM,OAAO,OAAO,cAAc,SAAS;AAC3C,UAAM,YAAY,OAAO,WAAW,MAAM,MAAM;AAChD,QAAI,QAAQ,YAAY,SAAU;AAClC,aAAS;AACT,SAAK,KAAK;AAAA,EACZ;AACA,SAAO,IAAI,MAAM,GAAG,CAAC;AACvB;AAGA,MAAM,WAAW;AACjB,MAAM,aAAa;AAOnB,MAAM,YAAY,CAAC,SAAiB;AAClC,MAAI,eAAe,IAAI,KAAK,UAAU;AACpC,WAAO,EAAE,QAAQ,IAAI,MAAM,KAAA;AAAA,EAC7B;AAGA,QAAM,QAAQ,KAAK,MAAM,GAAG;AAC5B,MAAI,OAAO,MAAM,IAAA,KAAS;AAC1B,MAAI,SAAS,MAAM,KAAK,GAAG;AAG3B,MAAI,eAAe,IAAI,IAAI,UAAU;AACnC,WAAO,iBAAiB,MAAM,QAAQ;AAAA,EACxC;AAGA,SAAO,eAAe,MAAM,IAAI,YAAY;AAC1C,aAAS,iBAAiB,QAAQ,UAAU;AAAA,EAC9C;AAEA,SAAO,EAAE,QAAQ,KAAA;AACnB;AAUA,MAAM,gBAAgB,CAAC,OAAe,WAAmB;AACvD,QAAM,MAAM,MAAM,SAAS,CAAC,EAAE,SAAS,SAAS,GAAG,GAAG,IAAI;AAC1D,SAAO,OAAO,KAAK,KAAK,OAAO;AACjC;AAOA,MAAM,iBAAiB,CAAC,WAAmB;AACzC,QAAM,QAAQ,OAAO,SAAS;AAC9B,MAAI,UAAU,GAAG;AACf,WAAO;AAAA,EACT,OAAO;AACL,WAAO,OAAO,OAAO,CAAC,QAAQ,OAAO,MAAM,MAAM,OAAO,CAAC,CAAC,CAAC;AAAA,EAC7D;AACF;AAKA,MAAM,kBAAkB,OAAO,MAAM,MAAM,CAAC;AAW5C,MAAM,kBAAkB,CACtB,MACA,MACA,MACA,MACA,OACA,OACA,KACA,KACA,SACG;AAEH,QAAM,SAAS,OAAO,MAAM,KAAK,CAAC;AAGlC,QAAM,EAAE,MAAM,WAAW,UAAU,IAAI;AAGvC,SAAO,MAAM,MAAM,GAAG,KAAK,MAAM;AACjC,gBAAc,OAAO,MAAQ,CAAC,EAAE,KAAK,QAAQ,GAAG;AAChD,gBAAc,KAAK,CAAC,EAAE,KAAK,QAAQ,GAAG;AACtC,gBAAc,KAAK,CAAC,EAAE,KAAK,QAAQ,GAAG;AACtC,gBAAc,MAAM,EAAE,EAAE,KAAK,QAAQ,GAAG;AACxC,gBAAc,KAAK,MAAM,KAAK,QAAA,IAAY,GAAI,GAAG,EAAE,EAAE,KAAK,QAAQ,GAAG;AAGrE,SAAO,KAAK,YAAY,OAAO,EAAE,KAAK,QAAQ,GAAG;AAEjD,MAAI,SAAS,QAAQ;AACnB,WAAO,MAAM,KAAK,KAAK,GAAG,OAAO;AAAA,EACnC,OAAO;AACL,WAAO,MAAM,KAAK,KAAK,GAAG,OAAO;AAAA,EACnC;AACA,SAAO,MAAM,WAAW,KAAK,GAAG,OAAO;AACvC,SAAO,MAAM,MAAM,KAAK,GAAG,OAAO;AAClC,SAAO,MAAM,OAAO,KAAK,IAAI,MAAM;AACnC,SAAO,MAAM,OAAO,KAAK,IAAI,MAAM;AACnC,SAAO,MAAM,QAAQ,KAAK,KAAK,MAAM;AAGrC,MAAI,MAAM;AACV,WAAS,IAAI,GAAG,IAAI,KAAK,KAAK;AAC5B,WAAO,OAAO,CAAC;AAAA,EACjB;AACA,gBAAc,KAAK,CAAC,EAAE,KAAK,QAAQ,GAAG;AAEtC,SAAO;AACT;AAWO,MAAM,kBAAkB,CAC7B,oBACA,iBACA,WAAyB;AAGzB,QAAM,oBAAoB,mBAAkB;AAE1C,qBAAiB,aAAa,oBAAoB;AAChD,cAAQ,eAAA;AAER,cAAQ,UAAU,MAAA;AAAA;AAAA,QAEhB,KAAK,QAAQ;AACX,gBAAM,mBAAmB,UAAU;AAEnC,cAAI,OAAO,qBAAqB,UAAU;AAExC,kBAAM,eAAe,OAAO,KAAK,kBAAkB,MAAM;AAGzD,kBAAM,iBAAiB;AAAA,cACrB;AAAA,cACA,UAAU;AAAA,cACV,aAAa;AAAA,cACb,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,YAAA;AACZ,kBAAM;AAGN,kBAAM,qBAAqB,eAAe,YAAY;AACtD,kBAAM;AAAA,UAGR,WAAW,OAAO,SAAS,gBAAgB,GAAG;AAE5C,kBAAM,iBAAiB;AAAA,cACrB;AAAA,cACA,UAAU;AAAA,cACV,iBAAiB;AAAA,cACjB,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,YAAA;AACZ,kBAAM;AAGN,kBAAM,qBAAqB,eAAe,gBAAgB;AAC1D,kBAAM;AAAA,UAER,OAAO;AAEL,kBAAM,iBAAiB;AAAA,cACrB;AAAA,cACA,UAAU;AAAA,cACV,iBAAiB;AAAA,cACjB,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,cACV,UAAU;AAAA,YAAA;AACZ,kBAAM;AAEN,oBAAQ,iBAAiB,MAAA;AAAA;AAAA,cAEvB,KAAK,aAAa;AAChB,oBAAI,WAAW;AACf,iCAAiB,wBAAwB,iBAAiB,WAAW;AACnE,0BAAQ,eAAA;AACR,wBAAM;AACN,8BAAY,qBAAqB;AAAA,gBACnC;AAGA,oBAAI,WAAW,QAAQ,GAAG;AACxB,0BAAQ,eAAA;AACR,wBAAM,OAAO,MAAM,MAAO,WAAW,KAAM,CAAC;AAAA,gBAC9C;AACA;AAAA,cACF;AAAA;AAAA,cAEA,KAAK,YAAY;AACf,oBAAI,WAAW;AACf,iCAAiB,WAAW,iBAAiB,UAAU;AACrD,0BAAQ,eAAA;AACR,sBAAI,OAAO,YAAY,UAAU;AAC/B,0BAAM,cAAc,OAAO,KAAK,SAAS,MAAM;AAC/C,0BAAM;AACN,gCAAY,YAAY;AAAA,kBAC1B,WAAW,OAAO,SAAS,OAAO,GAAG;AACnC,0BAAM;AACN,gCAAY,QAAQ;AAAA,kBACtB;AAAA,gBACF;AAGA,oBAAI,WAAW,QAAQ,GAAG;AACxB,0BAAQ,eAAA;AACR,wBAAM,OAAO,MAAM,MAAO,WAAW,KAAM,CAAC;AAAA,gBAC9C;AACA;AAAA,cACF;AAAA,YAAA;AAAA,UAEJ;AACA;AAAA,QACF;AAAA;AAAA,QAEA,KAAK,aAAa;AAEhB,gBAAM,iBAAiB;AAAA,YACrB;AAAA,YACA,UAAU;AAAA,YACV;AAAA,YACA,UAAU;AAAA,YACV,UAAU;AAAA,YACV,UAAU;AAAA,YACV,UAAU;AAAA,YACV,UAAU;AAAA,YACV,UAAU;AAAA,UAAA;AAEZ,gBAAM;AACN;AAAA,QACF;AAAA,MAAA;AAAA,IAEJ;AAGA,UAAM;AAAA,EACR;AAEA,QAAM,KAAK,mBAAmB;AAE9B,UAAQ,IAAA;AAAA;AAAA,IAEN,KAAK,QAAQ;AAEX,aAAO,SAAS,KAAK,mBAAmB;AAAA,IAC1C;AAAA;AAAA,IAEA,KAAK,QAAQ;AAEX,YAAM,aAAa,WAAW,EAAE,OAAO,GAAG;AAE1C,YAAM,kBAAkB,SAAS,KAAK,kBAAA,CAAmB;AAEzD,sBAAgB,KAAK,UAAU;AAE/B,aAAO;AAAA,IACT;AAAA,EAAA;AAEJ;ACrTA,MAAM,WAAW,CAAC,eAAmC,aAAqB,gBAA0C;AAClH,SAAO,kBAAkB,gBAAgB,QAAQ,YAAY,aAAa;AAC5E;AAUO,MAAM,sBAAsB,OACjC,MACA,aACA,YAC2B;AAC3B,QAAM,KAAK,eAAe;AAE1B,MAAI,OAAO,UAAU,SAAS,eAAe;AAC3C,UAAM,QAAQ,MAAM,KAAK,QAAQ,aAAa;AAC9C,UAAM,OAAO,SAAS,QAAQ,MAAM;AACpC,UAAM,MAAM,SAAS,OAAO,MAAM;AAClC,UAAM,MAAM,SAAS,OAAO,MAAM;AAClC,UAAM,OAAO,SAAS,QAAQ,MAAM;AACpC,UAAM,QAAQ,SAAS,SAAS,OAAO,MAAM,KAAK,EAAE;AACpD,UAAM,QAAQ,SAAS,SAAS,OAAO,MAAM,KAAK,EAAE;AACpD,WAAO;AAAA,MACL,MAAM;AAAA,MACN;AAAA,MAAM;AAAA,MAAM;AAAA,MAAO;AAAA,MAAO;AAAA,MAAK;AAAA,MAAK;AAAA,IAAA;AAAA,EAExC,OAAO;AACL,UAAM,OAAO,SAAS,QAAQ;AAC9B,UAAM,MAAM,SAAS,OAAO;AAC5B,UAAM,MAAM,SAAS,OAAO;AAC5B,UAAM,OAAO,SAAS,QAAQ,oBAAI,KAAA;AAClC,UAAM,QAAQ,SAAS,SAAS,OAAO,QAAW,EAAE;AACpD,UAAM,QAAQ,SAAS,SAAS,OAAO,QAAW,EAAE;AACpD,WAAO;AAAA,MACL,MAAM;AAAA,MACN;AAAA,MAAM;AAAA,MAAM;AAAA,MAAO;AAAA,MAAO;AAAA,MAAK;AAAA,MAAK;AAAA,IAAA;AAAA,EAExC;AACF;AASO,MAAM,qBAAqB,OAChC,MACA,QACA,YACsB;AACtB,MAAI,WAAW;AAGf,MAAI,SAAS,SAAS;AACtB,MAAI,CAAC,QAAQ;AAEX,UAAM,SAAmB,CAAA;AACzB,aAAS;AAGT,qBAAiB,SAAS,QAAQ;AAChC,YAAM,SAAS,OAAO,SAAS,KAAK,IAAI,QAAQ,OAAO,KAAK,OAAO,MAAM;AACzE,aAAO,KAAK,MAAM;AAClB,gBAAU,OAAO;AAAA,IACnB;AAGA,eAAW,SAAS,KAAK,MAAM;AAAA,EACjC;AAEA,QAAM,OAAO,SAAS,QAAQ;AAC9B,QAAM,MAAM,SAAS,OAAO;AAC5B,QAAM,MAAM,SAAS,OAAO;AAC5B,QAAM,OAAO,SAAS,QAAQ,oBAAI,KAAA;AAElC,QAAM,QAAQ,SAAS,SAAS;AAChC,QAAM,QAAQ,SAAS,SAAS;AAGhC,SAAO;AAAA,IACL,MAAM;AAAA,IACN;AAAA,IAAM;AAAA,IAAM;AAAA,IAAO;AAAA,IAAO;AAAA,IAAK;AAAA,IAAK;AAAA,IACpC,SAAS;AAAA,MACP,MAAM;AAAA,MACN;AAAA,MACA;AAAA,IAAA;AAAA,EACF;AAEJ;AAUO,MAAM,qBAAqB,OAChC,MACA,UACA,aACA,YACsB;AACtB,QAAM,KAAK,eAAe;AAG1B,QAAM,QAAQ,MAAM,KAAK,QAAQ;AAEjC,QAAM,SAAS,iBAAiB,QAAQ;AAExC,QAAM,OAAO,SAAS,SAAS,OAAO,SAAS,MAAM,OAAO;AAC5D,QAAM,MAAM,SAAS,QAAQ,OAAO,SAAS,MAAM,MAAM;AACzD,QAAM,MAAM,SAAS,QAAQ,OAAO,SAAS,MAAM,MAAM;AACzD,QAAM,OAAO,SAAS,SAAS,OAAO,SAAS,MAAM,QAAQ;AAE7D,QAAM,QAAQ,SAAS,SAAS,OAAO,MAAM,KAAK,EAAE;AACpD,QAAM,QAAQ,SAAS,SAAS,OAAO,MAAM,KAAK,EAAE;AAGpD,SAAO,MAAM,mBAAmB,MAAM,QAAQ;AAAA,IAC5C,QAAQ,MAAM;AAAA,IAAM;AAAA,IAAM;AAAA,IAAO;AAAA,IAAO;AAAA,IAAK;AAAA,IAAK;AAAA,EAAA,CACnD;AACH;AAQO,MAAM,oBAAoB,CAAC,QAAkB,SAAiB;AACnE,QAAM,SAAS,kBAAkB,IAAI;AACrC,SAAO,KAAK,MAAM;AAClB,SAAO,IAAI,QAAc,CAAC,KAAK,QAAQ;AACrC,WAAO,GAAG,UAAU,GAAG;AACvB,WAAO,GAAG,SAAS,GAAG;AAAA,EACxB,CAAC;AACH;"}

package/dist/packer.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * name: tar-vern
+ * version: 0.1.0
+ * description: Tape archiver library for Typescript
+ * author: Kouji Matsui (@kekyo@mi.kekyo.net)
+ * license: MIT
+ * repository.url: https://github.com/kekyo/tar-vern.git
+ */
+
+import { Readable } from 'stream';
+import { CompressionTypes, EntryItem } from './types';
+/**
+ * Create a tar packer
+ * @param entryItemGenerator - The async generator of the entry items
+ * @param compressionType - The compression type to use (Default: 'none')
+ * @param signal - The abort signal to cancel the tar packer
+ * @returns Readable stream of the tar packer
+ */
+export declare const createTarPacker: (entryItemGenerator: AsyncGenerator<EntryItem, void, unknown>, compressionType?: CompressionTypes, signal?: AbortSignal) => Readable;
+//# sourceMappingURL=packer.d.ts.map

package/dist/packer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"packer.d.ts","sourceRoot":"","sources":["../src/packer.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AA4JtD;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAC1B,oBAAoB,cAAc,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,EAC5D,kBAAkB,gBAAgB,EAClC,SAAS,WAAW,aA0JrB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,159 @@
+/*!
+ * name: tar-vern
+ * version: 0.1.0
+ * description: Tape archiver library for Typescript
+ * author: Kouji Matsui (@kekyo@mi.kekyo.net)
+ * license: MIT
+ * repository.url: https://github.com/kekyo/tar-vern.git
+ */
+
+import { Readable } from 'stream';
+/**
+ * Base interface for all entry item contents
+ */
+export interface EntryItemContentBase {
+    readonly kind: 'generator' | 'readable';
+    /**
+     * The length of the item
+     */
+    readonly length: number;
+}
+/**
+ * Interface for all entry item contents that are generators
+ */
+export interface EntryItemGeneratorContent extends EntryItemContentBase {
+    readonly kind: 'generator';
+    /**
+     * The generator function
+     */
+    readonly generator: AsyncGenerator<Buffer, void, unknown>;
+}
+/**
+ * Interface for all entry item contents that are readable streams
+ */
+export interface EntryItemReadableContent extends EntryItemContentBase {
+    readonly kind: 'readable';
+    /**
+     * The readable stream
+     */
+    readonly readable: Readable;
+}
+/**
+ * Union type for all entry item contents
+ */
+export type EntryItemContent = EntryItemGeneratorContent | EntryItemReadableContent;
+/**
+ * Base interface for all entry items
+ */
+export interface EntryItemBase {
+    readonly kind: 'file' | 'directory';
+    /**
+     * The path of the item
+     */
+    readonly path: string;
+    /**
+     * The mode of the item
+     */
+    readonly mode: number;
+    /**
+     * The user name of the item
+     */
+    readonly uname: string;
+    /**
+     * The group name of the item
+     */
+    readonly gname: string;
+    /**
+     * The user ID of the item
+     */
+    readonly uid: number;
+    /**
+     * The group ID of the item
+     */
+    readonly gid: number;
+    /**
+     * The date of the item
+     */
+    readonly date: Date;
+}
+/**
+ * Interface for all file entry items
+ */
+export interface FileItem extends EntryItemBase {
+    readonly kind: 'file';
+    /**
+     * The content of the item
+     */
+    readonly content: string | Buffer | EntryItemContent;
+}
+/**
+ * Interface for all directory entry items
+ */
+export interface DirectoryItem extends EntryItemBase {
+    readonly kind: 'directory';
+}
+/**
+ * Union type for all entry items
+ */
+export type EntryItem = FileItem | DirectoryItem;
+/**
+ * The type of stat reflection
+ * - all: Reflect all stats
+ * - exceptName: Reflect all stats except uname and gname
+ * - none: Do not reflect any stats
+ */
+export type ReflectStats = 'all' | 'exceptName' | 'none';
+/**
+ * The type of compression
+ * - none: No compression
+ * - gzip: Gzip compression
+ */
+export type CompressionTypes = 'none' | 'gzip';
+/**
+ * Options for creating an item
+ */
+export interface CreateItemOptions {
+    /**
+     * The mode of the item
+     */
+    readonly mode?: number;
+    /**
+     * The user name of the item
+     */
+    readonly uname?: string;
+    /**
+     * The group name of the item
+     */
+    readonly gname?: string;
+    /**
+     * The user ID of the item
+     */
+    readonly uid?: number;
+    /**
+     * The group ID of the item
+     */
+    readonly gid?: number;
+    /**
+     * The date of the item
+     */
+    readonly date?: Date;
+}
+/**
+ * Options for creating a directory item
+ */
+export interface CreateDirectoryItemOptions extends CreateItemOptions {
+    /**
+     * The real directory path
+     */
+    readonly directoryPath?: string;
+}
+/**
+ * Options for creating a readable item
+ */
+export interface CreateReadableItemOptions extends CreateItemOptions {
+    /**
+     * The length of the item
+     */
+    readonly length?: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,UAAU,CAAC;IACxC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,yBAAyB,GAAG,wBAAwB,CAAC;AAIpF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,aAAa;IAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,gBAAgB,CAAC;CACtD;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,aAAa;IAClD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,aAAa,CAAC;AAIjD;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,YAAY,GAAG,MAAM,CAAC;AAEzD;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACnE;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAClE;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B"}