browser-git-ops 0.0.2 → 0.0.5

package/README.md

@@ -1,145 +1,344 @@
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/nojaja/browser-git-ops) [![日本語ドキュメント](https://img.shields.io/badge/docs-日本語-blue.svg)](https://github.com/nojaja/browser-git-ops/blob/main/README_ja.md)
+
 # browser-git-ops
 
-軽量なブラウザ向け Git 操作用ライブラリ（VirtualFS + GitHub/GitLab アダプタ）。
-ブラウザの永続化レイヤは OPFS と IndexedDB を個別のバックエンド実装として提供し、VirtualFS が抽象化して利用します。
+A browser-native Git operations library that provides a VirtualFS and platform adapters for GitHub and GitLab. It implements multiple persistent backends (OPFS, IndexedDB, and an in-memory backend) and abstracts them behind a common VirtualFS API.
 
----
+- **Live Demo**: https://nojaja.github.io/browser-git-ops/
 
-**主要ポイント**
-- `VirtualFS`：ローカルワークスペースとベーススナップショットを管理し、create/update/delete の変更セットを生成します。
-- ストレージ分離：`OpfsStorage`（OPFS 対応）と `IndexedDbStorage`（IndexedDB 対応）を個別実装として提供。
-- `GitHubAdapter` / `GitLabAdapter`：各プラットフォーム向けのアダプタ実装（HTTP 再試行や blob/tree/commit フローを含む）。
+**[English](./README.md)** | **[日本語](./README_ja.md)**
 
----
+## Overview
 
-**変更履歴（最近の重要な変更点）**
-- ブラウザ永続化を `BrowserStorage` から分離し、`OpfsStorage` と `IndexedDbStorage` を新規追加しました。
-- `VirtualFS` の既定バックエンドを `OpfsStorage` に切替え、従来の `canUseOpfs`（インスタンス委譲）は廃止しました。
-- ルートエクスポートに `IndexedDbStorage` / `OpfsStorage` を追加し、examples と E2E ヘルパーを OPFS 検出の新 API に合わせて更新しました。
-- 単体テストを複数更新・追加し、OPFS / IndexedDB の分岐やトランザクションエラー経路のカバレッジを強化しました。
+![Architecture Overview](docs/asset/browser-git-ops-overview.png)
 
----
+## Key Features
 
-**公開 API（ライブラリエントリ）**
-ライブラリはバンドル／パッケージとして次をエクスポートします（`src/index.ts` を参照）：
+- **VirtualFS**: Local workspace snapshotting and change-set generation (create/update/delete)
+- **Multiple Storage Backends**:
+  - `OpfsStorage` - Origin Private File System (OPFS)
+  - `IndexedDatabaseStorage` - IndexedDB for broader browser compatibility
+  - `InMemoryStorage` - In-memory storage for testing
+- **Platform Adapters**: `GitHubAdapter` and `GitLabAdapter` implementing common push/pull flows via Web APIs
+- **CORS-Free Operations**: Direct API integration without proxy workarounds
+- **TypeScript Support**: Fully typed API with TypeScript definitions
 
-- `VirtualFS` (default exportと命名エクスポート)
-- `OpfsStorage` — OPFS（origin private file system）用バックエンド
-- `IndexedDbStorage` — IndexedDB 用バックエンド
-- `GitHubAdapter`, `GitLabAdapter` — 各プラットフォーム向けアダプタ
+## v0.0.5: FS-compatible API
 
-例：基本的な利用
+- Adds Node-like filesystem methods on `VirtualFS`: `stat`, `unlink`, `mkdir`, `rmdir`, `readdir`.
+- `Stats` objects now include Git identifiers when available (`gitBlobSha`, `gitCommitSha`).
+- `deleteFile` is removed from the public API; use `unlink` instead.
 
-```ts
-import { VirtualFS, OpfsStorage, GitHubAdapter } from 'browser-git-ops'
+## Status
 
-async function example() {
-  const vfs = new VirtualFS({ backend: new OpfsStorage() })
-  await vfs.init()
+- ✅ Core VirtualFS functionality (delta generation, index management, local edits)
+- ✅ Persistence backends for OPFS and IndexedDB
+- ✅ GitHubAdapter with primary push/pull flows
+- ✅ GitLabAdapter with primary push/pull flows
 
-  await vfs.writeWorkspace('README.md', 'hello world')
-  const changes = await vfs.getChangeSet()
+## Installation
 
-  const gh = new GitHubAdapter({ owner: 'ORG', repo: 'REPO', token: process.env.GH_TOKEN })
-  // push の呼び出しは VirtualFS の API に依存（詳細は src/virtualfs/virtualfs.ts）
-}
+### For Library Consumers (npm)
+
+```bash
+npm install browser-git-ops
 ```
 
----
+### For Development
 
-## プロジェクト構成（抜粋）
+```bash
+git clone https://github.com/nojaja/browser-git-ops.git
+cd browser-git-ops
+npm ci
+```
 
-- `src/` - ソースコード
-  - `virtualfs/virtualfs.ts` - `VirtualFS` 本体
-  - `virtualfs/opfsStorage.ts` - OPFS バックエンド
-  - `virtualfs/indexedDbStorage.ts` - IndexedDB バックエンド
-  - `git/githubAdapter.ts` - GitHub 向けアダプタ
-  - `git/gitlabAdapter.ts` - GitLab 向けアダプタ
-- `examples/` - ブラウザ実行用のサンプル UI
-- `test/` - Jest（unit）および Playwright（e2e）テスト
+## Usage
 
-（詳細はソース内のファイル参照を推奨）
+### Basic Example
 
----
+```typescript
+import { VirtualFS, OpfsStorage, GitHubAdapter } from 'browser-git-ops'
 
-## 技術スタック
+async function example() {
+  // 1. Initialize VirtualFS with OPFS backend
+  const backend = new OpfsStorage('my-workspace')
+  const vfs = new VirtualFS({ backend })
+  await vfs.init()
 
-- TypeScript
-- ビルド: `esbuild`（ブラウザ向けバンドル） + `tsc`（型定義出力）
-- テスト: Jest（unit） / Playwright（e2e）
+  // 2. Configure adapter (GitHub or GitLab)
+  await vfs.setAdapter(null, {
+    type: 'github',
+    opts: {
+      owner: 'your-username',
+      repo: 'your-repo',
+      token: 'your-github-token',
+      branch: 'main'
+    }
+  })
+
+  // 3. Pull latest content from remote
+  await vfs.pull()
+
+  // 4. List files (use the FS-compatible API)
+  const files = await vfs.readdir('.')
+  console.log('Files:', files)
+
+  // 5. Make local changes
+  await vfs.writeFile('README.md', '# Hello World')
+  await vfs.writeFile('docs/guide.md', '## Getting Started')
+
+  // 6. Stat a file (Stats includes gitBlobSha/gitCommitSha when available)
+  const s = await vfs.stat('README.md')
+  console.log('size=', s.size, 'isFile=', s.isFile())
+
+  // 7. Delete a file (use unlink instead of deleteFile)
+  await vfs.unlink('docs/guide.md')
+
+  // 8. Create/remove directories
+  await vfs.mkdir('notes')
+  await vfs.rmdir('notes', { recursive: true })
+  // 9. Get change set and push
+  const changes = await vfs.getChangeSet()
+  console.log('Changes:', changes)
+
+  const index = await vfs.getIndex()
+  const result = await vfs.push({
+    parentSha: index.head,
+    message: 'Update documentation',
+    changes: changes
+  })
+  console.log('Push result:', result)
+}
+```
 
----
+### Using IndexedDB Backend
 
-## 特記事項 / 現在のステータス
+```typescript
+import { VirtualFS, IndexedDatabaseStorage } from 'browser-git-ops'
 
-- 実装済み
-  - `VirtualFS` のコア機能（差分生成・index 管理・ローカル編集）
-  - `OpfsStorage` と `IndexedDbStorage` の永続化 API
-  - `GitHubAdapter` の主要な push フロー
-- テスト
-  - unit テストは多数あり、OPFS/IndexedDB 分岐やトランザクションエラー経路をカバー
-  - E2E は Playwright ベースのサンプル UI を含む
-- 要検証 / ⚠️ 注意
-  - GitLab の API 実装は環境差異を考慮した追加検証が必要です。
-  - OPFS の利用可否はブラウザ実装に依存します（polyfill でテストは行っていますが、実ブラウザでの動作確認を推奨）。
+const backend = new IndexedDatabaseStorage('my-workspace')
+const vfs = new VirtualFS({ backend })
+await vfs.init()
+```
 
----
+### Using GitLab Adapter
+
+```typescript
+await vfs.setAdapter(null, {
+  type: 'gitlab',
+  opts: {
+    projectId: 'username/project',
+    host: 'gitlab.com',
+    token: 'your-gitlab-token',
+    branch: 'main'
+  }
+})
+```
 
-## セットアップ（開発者向け）
+## Development
 
-1. リポジトリをクローン
+### Build
 
 ```bash
-git clone https://github.com/nojaja/browser-git-ops.git
-cd APIGitWorkspace01
-npm ci
+npm run build       # Build browser bundles and TypeScript definitions
 ```
 
-2. 開発コマンド
+This generates:
+- `dist/index.js` - IIFE bundle for browser (global `APIGitLib`)
+- `dist/index.mjs` - ESM bundle
+- `dist/index.d.ts` - TypeScript definitions
+
+### Testing
 
 ```bash
-npm run test        # unit テスト (Jest)
-npm run test:e2e    # Playwright E2E
+npm run test        # Unit tests (Jest)
+npm run test:spec   # Specification tests only
+npm run test:coverage # Tests with coverage report
+npm run test:e2e    # E2E tests (Playwright)
 npm run lint        # ESLint
-npm run build       # 型定義 + ブラウザバンドル出力 (dist/)
 ```
 
-実行時のヒント: テストスクリプトは ESM を扱うため、package.json の `test` スクリプトは `node --experimental-vm-modules` を付与して起動します。
+### Documentation
+
+```bash
+npm run docs        # Generate TypeDoc documentation
+```
 
----
+## Project Structure
 
-## ライブラリ利用ガイド（API 概略）
+```
+src/
+├── index.ts                     # Package entry point
+├── virtualfs/
+│   ├── virtualfs.ts            # VirtualFS core implementation
+│   ├── opfsStorage.ts          # OPFS storage backend
+│   ├── indexedDatabaseStorage.ts # IndexedDB storage backend
+│   ├── inmemoryStorage.ts      # In-memory storage (for testing)
+│   ├── changeTracker.ts        # Change detection and tracking
+│   ├── conflictManager.ts      # Merge conflict resolution
+│   ├── indexManager.ts         # Index file management
+│   └── types.ts                # Type definitions
+└── git/
+    ├── abstractAdapter.ts      # Base adapter interface
+    ├── githubAdapter.ts        # GitHub API adapter
+    └── gitlabAdapter.ts        # GitLab API adapter
+
+examples/                        # Browser demo application
+test/
+├── unit/                        # Jest unit tests
+└── e2e/                         # Playwright E2E tests
+```
 
-- `new VirtualFS(options?)` — オプション: `{ storageDir?: string, backend?: StorageBackend }`。
-- `init()` — バックエンド初期化・index 読み込み。
-- `writeWorkspace(path, content)` / `deleteWorkspace(path)` / `renameWorkspace(from,to)` — ローカル編集操作。
-- `getChangeSet()` — create/update/delete の変更配列を取得。
-- `applyBaseSnapshot(snapshot, headSha)` — リモートスナップショット適用（conflicts を返す）。
+## Configuration
+
+### GitHub Adapter
+
+To use the GitHub adapter, you need:
+- **Personal Access Token** with `repo` scope
+- Repository owner and name
+- Target branch (default: `main`)
+
+### GitLab Adapter
+
+To use the GitLab adapter, you need:
+- **Personal Access Token** or **Project Access Token**
+- Project ID (format: `username/project` or numeric ID)
+- GitLab instance host (default: `gitlab.com`)
+- Target branch (default: `main`)
+
+### Browser Compatibility
+
+- **OPFS**: Requires modern browsers with OPFS support (Chrome 102+, Edge 102+)
+- **IndexedDB**: Broader compatibility, works in most modern browsers
+- **CORS**: No proxy required - uses direct API authentication
+
+## API Reference
+
+- See [docs/typedoc-md/README.md](docs/typedoc-md/README.md).
+
+### VirtualFS
+
+Main class for file system operations.
+
+```typescript
+class VirtualFS {
+  constructor(options?: { backend?: StorageBackend; logger?: Logger })
+  
+  // Initialization
+  async init(): Promise<void>
+  
+  // File Operations
+  async writeFile(path: string, content: string): Promise<void>
+  async readFile(path: string): Promise<string>
+  async deleteFile(path: string): Promise<void>
+  async renameFile(fromPath: string, toPath: string): Promise<void>
+  async listPaths(): Promise<string[]>
+  
+  // Change Management
+  async getChangeSet(): Promise<ChangeItem[]>
+  async revertChanges(): Promise<void>
+  
+  // Remote Synchronization
+  async setAdapter(adapter: any, meta?: any): Promise<void>
+  async pull(reference?: string, baseSnapshot?: Record<string, string>): Promise<any>
+  async push(input: CommitInput): Promise<any>
+  
+  // Conflict Resolution
+  async getConflicts(): Promise<ConflictItem[]>
+  async resolveConflict(path: string, resolution: 'local' | 'remote'): Promise<void>
+  
+  // Index Management
+  async getIndex(): Promise<IndexFile>
+  async saveIndex(): Promise<void>
+}
+```
+
+### Storage Backends
+
+```typescript
+// OPFS Backend
+class OpfsStorage implements StorageBackend {
+  constructor(rootName?: string)
+}
+
+// IndexedDB Backend
+class IndexedDatabaseStorage implements StorageBackend {
+  constructor(rootName?: string)
+}
+
+// In-Memory Backend (for testing)
+class InMemoryStorage implements StorageBackend {
+  constructor()
+}
+```
+
+### Platform Adapters
+
+```typescript
+// GitHub Adapter
+class GitHubAdapter {
+  constructor(options: {
+    owner: string
+    repo: string
+    token: string
+    branch: string
+  })
+}
+
+// GitLab Adapter
+class GitLabAdapter {
+  constructor(options: {
+    projectId: string
+    host: string
+    token: string
+    branch: string
+  })
+}
+```
 
-詳細は `src/virtualfs/virtualfs.ts` の JSDoc コメントを参照してください。
+## Examples
 
----
+See the [`examples/`](examples/) directory for:
+- Interactive browser demo with UI
+- Playwright E2E test scenarios
+- Multiple storage backend examples
 
-## テストと CI
+## Contributing
 
-- ローカルでの unit テスト実行: `npm run test`
-- E2E 実行前に `npm run build` を実行する必要があります（`test:e2e` の `pretest:e2e` を参照）。
+Contributions are welcome! Please follow these guidelines:
 
----
+1. **Open an Issue**: For significant changes, please open an issue first to discuss your proposal
+2. **Follow Conventions**: 
+   - Use TypeScript
+   - Follow ESLint rules (`npm run lint`)
+   - Write tests for new features
+   - Update documentation as needed
+3. **Testing**: Ensure all tests pass before submitting PR
+   ```bash
+   npm run lint
+   npm run build
+   npm run test
+   npm run test:e2e
+   ```
 
-## 貢献
+## Support
 
-- Issue / PR を歓迎します。まず Issue にて目的・設計方針を共有してください。
-- コーディング規約: TypeScript + ESLint。PR ではテスト追加を推奨します。
+- **Issues**: https://github.com/nojaja/browser-git-ops/issues
+- **Discussions**: https://github.com/nojaja/browser-git-ops/discussions
+- **Documentation**: https://nojaja.github.io/browser-git-ops/
 
----
+## License
 
-## ライセンス
+MIT License - see the [LICENSE](LICENSE) file for details.
 
-- MIT — 詳細は `LICENSE` ファイル参照
+## Author
 
----
+Maintained by [nojaja](https://github.com/nojaja) ([free.riccia@gmail.com](mailto:free.riccia@gmail.com))
 
-## 連絡先
+## Acknowledgments
 
-- 作者: nojaja — https://github.com/nojaja
+This project uses:
+- OPFS (Origin Private File System) for persistent storage
+- GitHub and GitLab Web APIs for remote synchronization
+- Jest for unit testing
+- Playwright for E2E testing

package/dist/git/abstractAdapter.d.ts

@@ -0,0 +1,167 @@
+export type FetchWithRetryFunction = (_input: RequestInfo, _init: RequestInit, _attempts?: number, _baseDelay?: number) => Promise<Response>;
+/**
+ * Simple logger interface for dependency injection.
+ * If a caller injects an object matching this interface, the adapter
+ * will forward debug/info/warn/error messages to it. If no logger is
+ * provided, no logging will be performed by the adapter.
+ */
+export interface Logger {
+    debug: (..._messages: any[]) => void;
+    info: (..._messages: any[]) => void;
+    warn: (..._messages: any[]) => void;
+    error: (..._messages: any[]) => void;
+}
+/**
+ * Compute SHA-1 of string content using Web Crypto
+ * @param content The input string
+ * @returns Promise resolving to hex-encoded SHA-1
+ */
+export declare function shaOf(content: string): Promise<string>;
+/**
+ * Determine whether an HTTP status should be considered retryable
+ * @param status HTTP status code
+ * @returns true if retryable (5xx or 429)
+ */
+export declare function classifyStatus(status: number): boolean;
+/**
+ * Calculate delay before retrying based on response or exponential backoff
+ * @param response Response or null when not available
+ * @param index Attempt index (0-based)
+ * @param baseDelay Base delay in ms
+ * @returns delay in milliseconds
+ */
+export declare function getDelayForResponse(response: Response | null, index: number, baseDelay: number): number;
+/**
+ * Process HTTP response and throw on non-ok. If retryable, delay before throwing.
+ * @param response Fetch Response
+ * @param index Attempt index
+ * @param baseDelay Base delay in ms
+ * @returns Promise resolving to the response when ok
+ */
+export declare function processResponseWithDelay(response: Response, index: number, baseDelay: number): Promise<Response>;
+/**
+ * Perform fetch with retry/backoff logic
+ * @param input RequestInfo
+ * @param init RequestInit
+ * @param attempts number of attempts
+ * @param baseDelay base delay in ms
+ * @returns Promise resolving to Response
+ */
+export declare function fetchWithRetry(input: RequestInfo, init: RequestInit, attempts?: number, baseDelay?: number): Promise<Response>;
+/**
+ * Error indicating the operation is retryable and may succeed on later attempts.
+ */
+export declare class RetryableError extends Error {
+}
+/**
+ * Error indicating the operation failed in a non-retryable way.
+ */
+export declare class NonRetryableError extends Error {
+}
+/**
+ * Map items with limited concurrency
+ * @template T,R
+ * @param items Array of items to map
+ * @param mapper Async mapper function
+ * @param concurrency concurrency limit
+ * @returns Promise resolving to array of mapped results
+ */
+export declare function mapWithConcurrency<T, R>(items: T[], mapper: (_t: T) => Promise<R>, concurrency?: number): Promise<R[]>;
+/**
+ * Abstract base class providing shared utilities for Git adapters
+ */
+export declare abstract class AbstractGitAdapter {
+    protected baseUrl: string;
+    protected headers: Record<string, string>;
+    protected options: any;
+    protected logger?: Logger;
+    protected maxRetries: number;
+    protected baseBackoff: number;
+    /**
+     * Construct base adapter
+     * @param options adapter options
+     */
+    constructor(options?: any);
+    /**
+     * Delegate to shared shaOf implementation
+     * @param content input string
+     * @returns hex sha1
+     */
+    protected shaOf(content: string): Promise<string>;
+    /**
+     * Replace or set the logger at runtime.
+     * Use this if DI happens after construction.
+     * @param logger optional logger instance to set (or undefined to clear)
+     * @returns void
+     */
+    setLogger(logger: Logger | undefined): void;
+    /**
+     * Log debug messages when a logger is present.
+     * @param _messages messages to log (unused when no logger)
+     */
+    protected logDebug(..._messages: any[]): void;
+    /**
+     * Log an informational message if a logger is present.
+     * @param args items to log
+     */
+    protected logInfo(..._messages: any[]): void;
+    /**
+     * Log a warning message if a logger is present.
+     * @param args items to log
+     */
+    protected logWarn(..._messages: any[]): void;
+    /**
+     * Log an error message if a logger is present.
+     * @param args items to log
+     */
+    protected logError(..._messages: any[]): void;
+    /**
+     * Normalize different header-like shapes into a plain object.
+     * @param headerLike headers in Headers, array, or plain object form
+     * @returns plain header map
+     */
+    private normalizeHeaders;
+    /**
+     * Format a fetch request into a minimal object suitable for logging.
+     * @returns formatted request log object
+     */
+    private formatRequestForLog;
+    /**
+     * Format a fetch Response into a minimal object suitable for logging.
+     * @returns formatted response log object
+     */
+    private formatResponseForLog;
+    /**
+     * Proxy to shared `fetchWithRetry` implementation while emitting
+     * minimal request/response logs for debugging and test inspection.
+     * @param input fetch input
+     * @param init fetch init
+     * @param attempts retry attempts
+     * @param baseDelay base delay ms
+     * @returns Promise resolving to Response
+     */
+    protected fetchWithRetry(input: RequestInfo, init: RequestInit, attempts?: number, baseDelay?: number): Promise<Response>;
+    /**
+     * Determine if a status code is retryable
+     * @param status HTTP status code
+     * @returns boolean
+     */
+    protected isRetryableStatus(status: number): boolean;
+    /**
+     * Compute backoff milliseconds for attempt
+     * @param attempt attempt number (1..)
+     * @returns milliseconds to wait
+     */
+    protected backoffMs(attempt: number): number;
+    /**
+     * Map items with limited concurrency by delegating to the shared helper.
+     * @template T,R
+     * @param items items to map
+     * @param mapper async mapper
+     * @param concurrency concurrency limit
+     * @returns Promise resolving to mapped results
+     */
+    protected mapWithConcurrency<T, R>(items: T[], mapper: (_t: T) => Promise<R>, concurrency?: number): Promise<R[]>;
+}
+export default AbstractGitAdapter;
+//# sourceMappingURL=abstractAdapter.d.ts.map

package/dist/git/abstractAdapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstractAdapter.d.ts","sourceRoot":"","sources":["../../src/git/abstractAdapter.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,sBAAsB,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;AAK5I;;;;;GAKG;AACH,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;IACpC,IAAI,EAAE,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;IACnC,IAAI,EAAE,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;IACnC,KAAK,EAAE,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;CACrC;AAED;;;;GAIG;AACH,wBAAsB,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAK5D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEtD;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAcvG;AAED;;;;;;GAMG;AACH,wBAAsB,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAQtH;AAED;;;;;;;GAOG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,SAAI,EAAE,SAAS,SAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAkB5H;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,KAAK;CAAI;AAE7C;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,KAAK;CAAI;AAEhD;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,WAAW,SAAI,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAkBjH;AAED;;GAEG;AACH,8BAAsB,kBAAkB;IACtC,SAAS,CAAC,OAAO,SAAK;IACtB,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAK;IAC9C,SAAS,CAAC,OAAO,EAAE,GAAG,CAAK;IAC3B,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACzB,SAAS,CAAC,UAAU,SAAI;IACxB,SAAS,CAAC,WAAW,SAAM;IAE3B;;;OAGG;gBACS,OAAO,CAAC,EAAE,GAAG;IAMzB;;;;OAIG;cACa,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvD;;;;;OAKG;IACI,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IAI3C;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE;IAUtC;;;OAGG;IACH,SAAS,CAAC,OAAO,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE;IAUrC;;;OAGG;IACH,SAAS,CAAC,OAAO,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE;IAUrC;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE;IAUtC;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAqBxB;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAQ3B;;;OAGG;YACW,oBAAoB;IAiBlC;;;;;;;;OAQG;cACa,cAAc,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,SAAI,EAAE,SAAS,SAAM;IA2BnG;;;;OAIG;IACH,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM;IAI1C;;;;OAIG;IACH,SAAS,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM;IAMnC;;;;;;;OAOG;IACH,SAAS,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,WAAW,SAAI;CAG9F;AAED,eAAe,kBAAkB,CAAA"}

package/dist/git/adapter.d.ts

@@ -7,10 +7,32 @@ export interface Change {
 export interface CommitResult {
     commitSha: string;
 }
+export type CommitHistoryQuery = {
+    ref: string;
+    perPage?: number;
+    page?: number;
+};
+export type CommitSummary = {
+    sha: string;
+    message: string;
+    author: string;
+    date: string;
+    parents: string[];
+};
+export type CommitHistoryPage = {
+    items: CommitSummary[];
+    nextPage?: number;
+    lastPage?: number;
+};
 export interface GitAdapter {
     createBlobs(_changes: Change[], _concurrency?: number): Promise<Record<string, string>>;
     createTree(_changes: Change[], _baseTreeSha?: string): Promise<string>;
     createCommit(_message: string, _parentSha: string, _treeSha: string): Promise<string>;
-    updateRef(_ref: string, _commitSha: string, _force?: boolean): Promise<void>;
+    updateRef(_reference: string, _commitSha: string, _force?: boolean): Promise<void>;
+    listCommits?(_query: CommitHistoryQuery): Promise<CommitHistoryPage>;
+    listBranches?(_query?: import('../virtualfs/types.ts').BranchListQuery): Promise<import('../virtualfs/types.ts').BranchListPage>;
+    getRepositoryMetadata?(): Promise<import('../virtualfs/types.ts').RepositoryMetadata>;
+    resolveRef?(_reference: string): Promise<string>;
+    createBranch?(_branchName: string, _fromSha: string): Promise<import('../virtualfs/types.ts').CreateBranchResult>;
 }
 //# sourceMappingURL=adapter.d.ts.map

package/dist/git/adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/git/adapter.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;IACpC,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,UAAU;IAEzB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IAEvF,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEtE,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAErF,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC7E"}
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/git/adapter.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;IACpC,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,aAAa,EAAE,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,WAAW,UAAU;IAEzB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IAEvF,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEtE,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAErF,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAElF,WAAW,CAAC,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAEpE,YAAY,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,uBAAuB,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,uBAAuB,EAAE,cAAc,CAAC,CAAA;IAEhI,qBAAqB,CAAC,IAAI,OAAO,CAAC,OAAO,uBAAuB,EAAE,kBAAkB,CAAC,CAAA;IAErF,UAAU,CAAC,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEhD,YAAY,CAAC,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,uBAAuB,EAAE,kBAAkB,CAAC,CAAA;CAClH"}