tar-vern 0.3.0 → 1.0.0

package/README.md

@@ -1,212 +0,0 @@
-# tar-vern
-
-Streaming tape archiver (tar) library for TypeScript/JavaScript.
-
-[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![npm version](https://img.shields.io/npm/v/tar-vern.svg)](https://www.npmjs.com/package/tar-vern)
-
-----
-
-## What is this?
-
-A modern TypeScript library for creating tape archives (tar/ustar format) using streaming API. Supports both files and directories with metadata preservation, GZip compression, readable streaming, and flexible content sources.
-
-```mermaid
-graph LR
-  A[Content Items<br/>* Files<br/>* Directories<br/>* String content<br/>* Buffer content<br/>* Async generators] -->|Stream pipe| B[Writer Stream<br/>'createWriteStream']
-  B --> C[TAR File<br/>'foobar.tar']
-```
-
-## Packing minimum example
-
-tar-vern supplies file and directory information to pack through "TypeScript async generator."
-This allows you to specify pack data with very concise code.
-
-```typescript
-import {
-  createTarPacker, storeReaderToFile,
-  createFileItem, createDirectoryItem } from 'tar-vern';
-
-// Create an async generator for tar entries
-const itemGenerator = async function*() {
-  // Add a simple text file
-  yield await createFileItem(
-    'hello.txt',      // file name
-    'Hello, world!'   // text contents
-  );
-  
-  // Add a directory
-  yield await createDirectoryItem('mydir');
-
-  // (Make your own entries with yield expression...)
-};
-
-// Create tar stream and write to file
-const packer = createTarPacker(itemGenerator());
-await storeReaderToFile(packer, 'archive.tar.gz');   // Use helper to awaitable
-```
-
-## Features
-
-- Streaming API: Memory-efficient processing of large files
-- Multiple content sources: String, Buffer, ReadableStream, file paths and async generators
-- Metadata preservation: File permissions, ownership, timestamps
-- Built-in compression: GZip compression support (`tar.gz` format)
-- No external dependencies.
-
-----
-
-## Installation
-
-```bash
-npm install tar-vern
-```
-
-## Usage for tar packing
-
-### EntryItem basis
-
-The async generator needs to produce `EntryItem` objects.
-These objects hold information about files and directories to be stored in the tar archive, and for files, they also contain content data information.
-
-There are no special requirements for this information, so you can construct everything manually:
-
-```typescript
-// Create an async generator for tar entries
-const itemGenerator = async function*() {
-  // Construct a simple text file item
-  yield {
-    kind: 'file',
-    path: 'hello.txt',
-    mode: 0o644,
-    uname: 'user',
-    gname: 'group',
-    uid: 1000,
-    gid: 1000,
-    date: new Date(),
-    content: 'Hello, world!'   // text contents
-  } as EntryItem;
-  
-  // Construct a directory item
-  yield {
-    kind: 'directory',
-    path: 'mydir',
-    mode: 0o755,
-    uname: 'user',
-    gname: 'group',
-    uid: 1000,
-    gid: 1000,
-    date: new Date()
-  } as EntryItem;
-};
-```
-
-However, constructing all `EntryItem` objects manually can be tedious. Therefore, helper functions are provided as follows.
-
-### Helper functions
-
-Helper functions are provided to simplify the construction of `EntryItem` objects. The following types are available:
-
-|Function|Details|
-|:----|:----|
-|`createDirectoryItem()`|Construct directory item|
-|`createFileItem()`|Construct basic file item from string or `Buffer`|
-|`createReadableFileItem()`|Construct file item from readable stream (`stream.Readable`)|
-|`createGeneratorFileItem()`|Construct file item from async generator|
-|`createReadFileItem()`|Construct file item from a file on real filesystem|
-
-For example:
-
-```typescript
-import { createReadStream } from 'fs';
-import { 
-  createReadFileItem, createDirectoryItem,
-  createReadableFileItem, storeReaderToFile } from 'tar-vern';
-
-// Configuration easier with item creation functions
-const itemGenerator = async function*() {
-  // Add file from filesystem (auto-detects metadata)
-  yield await createReadFileItem('archived-name.txt', '/path/to/real/source.txt');
-
-  // Add directory from filesystem
-  yield await createDirectoryItem('dir/sub/name', 'exceptName', { 
-    directoryPath: '/path/to/real/dir' 
-  });
-
-  // Add from readable stream
-  const stream = createReadStream('/path/to/real/large-file.bin');
-  yield await createReadableFileItem('large-file.bin', stream);
-};
-
-// The `packer` generally `stream.Readable`
-const packer = createTarPacker(itemGenerator());
-
-// Safer awaitable store file from `stream.Readable`
-await storeReaderToFile(packer, 'output.tar');
-```
-
-NOTE: The tar format requires file sizes to be stored in the header. This means when using `stream.Readable` or async generators for streaming data, the file size must be known in advance. You can provide this via the `length` option in `createReadableFileItem()` and `createGeneratorFileItem()`. However, if `length` is omitted, all data will be buffered in memory before being written to the tar archive, which could cause performance issues with very large files.
-
-### Stat reflection options
-
-When `createReadFileItem()` or `createDirectoryItem()` can access real files or directories, their "stats" metadata can be reflected in the tar archive:
-
-```typescript
-import { createReadFileItem, ReflectStats } from 'tar-vern';
-
-// Don't reflect any file stats (use provided `options` parameter)
-yield await createReadFileItem('file.txt', '/source.txt',
-  'none',   // Don't reflect
-  {
-    mode: 0o644,   // Mode flags
-    uid: 1000,     // user id
-    gid: 1000,     // group id
-    uname: "foo",  // user name
-    gname: "bar"   // group name
-  });
-
-// Reflect all stats except user/group name
-yield await createReadFileItem('file.txt', '/source.txt',
-  'exceptName');   // reflect except names
-
-// Reflect all stats including numeric uid/gid as names
-yield await createReadFileItem('file.txt', '/source.txt',
-  'all');   // reflect all stats
-```
-
-### With GZip compression
-
-Supported `CompressionTypes`:
-
-|`CompressionTypes`|Details|
-|:----|:----|
-|`none`|Uncompression (default)|
-|`gzip`|Combined GZip compression stream|
-
-```typescript
-import { createTarPacker, storeReaderToFile } from 'tar-vern';
-
-const itemGenerator = async function*() {
-  yield await createFileItem(
-    'data.txt',
-    'Large amount of data...'
-  );
-};
-
-// Create uncompressed tar stream
-const packer = createTarPacker(itemGenerator(), 'none');
-await storeReaderToFile(packer, 'archive.tar');
-```
-
-----
-
-## Usage for tar unpacking
-
-TODO:
-
-----
-
-## License
-
-Under MIT.

package/dist/generated/packageMetadata.d.ts

@@ -1,16 +0,0 @@
-/*!
- * name: tar-vern
- * version: 0.3.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 declare const name = "tar-vern";
-export declare const version = "0.3.0";
-export declare const description = "Tape archiver library for Typescript";
-export declare const author = "Kouji Matsui (@kekyo@mi.kekyo.net)";
-export declare const license = "MIT";
-export declare const repository_url = "https://github.com/kekyo/tar-vern.git";
-//# sourceMappingURL=packageMetadata.d.ts.map

package/dist/generated/packageMetadata.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"packageMetadata.d.ts","sourceRoot":"","sources":["../../src/generated/packageMetadata.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,IAAI,aAAa,CAAC;AAC/B,eAAO,MAAM,OAAO,UAAU,CAAC;AAC/B,eAAO,MAAM,WAAW,yCAAyC,CAAC;AAClE,eAAO,MAAM,MAAM,uCAAuC,CAAC;AAC3D,eAAO,MAAM,OAAO,QAAQ,CAAC;AAC7B,eAAO,MAAM,cAAc,0CAA0C,CAAC"}