# Pekemalu-LocalFileSystem ブラウザの `localStorage` を利用して、Webアプリ内に「ファイル・フォルダ」を扱える仮想ファイルシステムを組み込むための TypeScript / JavaScript ライブラリです。 Webアプリのローカル領域に、ファイルやフォルダという形でデータを整理・保存したいときに利用できます。 React / Vue / Svelte などのフレームワークに依存せず、Vite / webpack / esbuild / Rollup などの一般的なWeb開発環境から利用できます。 --- ## 📁 こんな用途に たとえば、Webアプリにこんな機能を追加したい場合に利用できます。 ・アプリ内にファイルやフォルダを作りたい ・ユーザーが作成したテキストデータをファイルとして保存したい ・ブラウザ上で簡単なファイル管理機能を実現したい ・設定やメモなどをフォルダ構造で整理したい ・Webアプリ内のローカルデータをアップロード / ダウンロードしたい ・複数のファイルをZIPとしてまとめて扱いたい ブラウザ上で完結する、小規模なローカルファイル管理機能などに向いています。 --- ## ✨ 主な機能 ### ファイル / フォルダ ・ファイル / フォルダの作成・削除 ・ファイル / フォルダのコピー・移動 ・ファイル / フォルダの名前変更 ・ファイル / フォルダの存在確認 ・ディレクトリ構造の作成 ・`.` / `..` を含むパスの正規化 ### 💾 ストレージ ・ブラウザの `localStorage` を利用 ・`MemoryStorage` によるメモリ上での利用 ・`StorageLike` によるストレージ差し替え ・ストレージ容量 / クォータ超過の検出 ・保存データの破損検証と安全な初期化 ### 📄 テキストファイル ・テキストファイルの読み書き ・ファイルサイズの取得 ・MIMEタイプの判定 ・MIMEタイプの追加登録 ### 📦 Upload / Download ・ファイルのアップロード ・相対パスを利用したフォルダ構造の再現 ・ファイルのダウンロード ・複数ファイル / フォルダのZIPダウンロード ### 🧪 開発・テスト ・TypeScriptによる型定義を同梱 ・ビルド済み `dist/` を同梱 ・テストコードを同梱 ・ブラウザ上で実際に操作できるDemoを同梱 --- ## 🐰 Demoを同梱 商品ZIPには、ブラウザから実際に動作を確認できるDemoを含めています。 Demoでは、以下のような基本操作をブラウザ上で試すことができます。 ・ファイル / フォルダの作成 ・ファイルの編集 ・ファイル / フォルダの削除 ・コピー / 移動 ・ファイルのアップロード ・ファイル / フォルダのダウンロード ・ZIPダウンロード ・localStorageへの保存状態の確認 購入後、まず `demo/README.md` を確認して、実際に動かしてみることができます。 --- ## 📦 商品に含まれるもの 商品ZIPには、以下を含めています。 ・TypeScriptソースコード (`src/`) ・ビルド済みJavaScript / 型定義 (`dist/`) ・テストコード (`tests/`) ・ブラウザ動作確認用Demo (`demo/`) ・README ・LICENSE ・第三者ソフトウェアに関するNOTICE ・npm / TypeScript / Vitest等の開発用設定ファイル `node_modules/` は含まれていません。 --- ## 🌐 動作環境 ### ライブラリの利用 ・モダンブラウザ ・JavaScript / TypeScript ・`localStorage` が利用可能な環境 Node.jsは、**通常のライブラリ利用には必要ありません**。 ### 開発・テスト・ビルド 商品にはソースコードと開発用設定も含まれているため、ソースからの開発・テスト・ビルドを行う場合はNode.js等の開発環境が必要です。 --- ## ⚠️ 注意事項 このライブラリはブラウザの `localStorage` を利用します。 そのため、保存できるデータ量にはブラウザや利用環境による制限があります。 また、保存対象はテキストデータを基本としており、OSのファイルシステムやサーバー上のファイルシステムを置き換えるものではありません。 --- ## 📜 ライセンス 商用利用・個人利用・企業内利用が可能です。 購入者自身のソフトウェア、Webサービス、システム等へ組み込んで利用・改変することができます。 本ライブラリを組み込んだ**購入者自身のソフトウェアを配布・販売することも可能**です。 一方で、本商品そのものを再配布・再販売したり、ライブラリ・テンプレート・素材等として別の商品に再パッケージして配布・販売することは禁止しています。 詳しい条件については、商品に同梱されている `LICENSE.txt` をご確認ください。 --- ## 📚 第三者ソフトウェア 本商品には、HomePilot由来のコードおよび `fflate` を利用している部分があります。 それぞれのライセンス・著作権表示については、商品に同梱している `THIRD-PARTY-NOTICES.txt` に記載しています。 --- ## 🔖 Version **1.0.0** Pekemalu Works