browser-git-ops 0.0.4 → 0.0.5

package/README.md

@@ -1,119 +1,344 @@
-[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/nojaja/browser-git-ops)
+[![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
 
 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/
+- **Live Demo**: https://nojaja.github.io/browser-git-ops/
 
-**[日本語ドキュメント (Japanese)](README_ja.md)**
+**[English](./README.md)** | **[日本語](./README_ja.md)**
 
-Key features
-- VirtualFS: local workspace snapshoting and change-set generation (create/update/delete).
-- Multiple backends: `OpfsStorage` (OPFS), `IndexedDatabaseStorage` (IndexedDB), and `InMemoryStorage` (testing).
-- Platform adapters: `GitHubAdapter` and `GitLabAdapter` implementing common push/fetch flows via Web APIs, enabling cross-origin operations without CORS proxy workarounds.
+## Overview
 
-Status summary
-- Core VirtualFS functionality implemented (delta generation, index management, local edits).
-- Persistence backends for OPFS and IndexedDB implemented.
-- GitHubAdapter includes primary push flow; GitLab adapter exists but may require extra environment verification.
+![Architecture Overview](docs/asset/browser-git-ops-overview.png)
 
-Quick Install via npm (library consumers)
+## Key Features
+
+- **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
+
+## 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.
+
+## Status
+
+- ✅ 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
+
+## Installation
+
+### For Library Consumers (npm)
 
 ```bash
-npm i browser-git-ops
+npm install browser-git-ops
 ```
 
-Usage (basic)
+### For Development
+
+```bash
+git clone https://github.com/nojaja/browser-git-ops.git
+cd browser-git-ops
+npm ci
+```
 
-```ts
+## Usage
+
+### Basic Example
+
+```typescript
 import { VirtualFS, OpfsStorage, GitHubAdapter } from 'browser-git-ops'
 
 async function example() {
-  const backend = new lib.OpfsStorage('test01')
+  // 1. Initialize VirtualFS with OPFS backend
+  const backend = new OpfsStorage('my-workspace')
   const vfs = new VirtualFS({ backend })
   await vfs.init()
-  await vfs.setAdapter(null, { type: 'gitlab', opts: { projectId: 'ORG', host: 'HOST', token: 'token', branch: 'main' } })
 
+  // 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()
-  const list = await vfs.listPaths()
-  await vfs.writeFile('README.md', 'hello world')
-  const changes = await vfs.getChangeSet()
 
-  const idx = await vfs.getIndex()
-  const pushInput = { parentSha: idx.head, message: 'Example push', changes: changes }
-  const pushRes = await vfs.push(pushInput as any)
+  // 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)
 }
 ```
 
-install
+### Using IndexedDB Backend
+
+```typescript
+import { VirtualFS, IndexedDatabaseStorage } from 'browser-git-ops'
+
+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
+
+### Build
 
 ```bash
-git clone https://github.com/nojaja/browser-git-ops.git
-cd browser-git-ops
-npm ci
+npm run build       # Build browser bundles and TypeScript definitions
 ```
 
-Build & test
+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 build       # build browser bundles and types
-npm run test        # unit tests (Jest)
-npm run test:e2e    # Playwright E2E (runs after build)
+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
 ```
 
-Project layout (excerpt)
+### Documentation
 
-- `src/` — source
-  - `virtualfs/virtualfs.ts` — `VirtualFS` core
-  - `virtualfs/opfsStorage.ts` — OPFS backend
-  - `virtualfs/indexedDatabaseStorage.ts` — IndexedDB backend
-  - `virtualfs/inmemoryStorage.ts` — In-memory backend (tests)
-  - `git/githubAdapter.ts` — GitHub adapter
-  - `git/gitlabAdapter.ts` — GitLab adapter
-- `examples/` — browser sample UI and Playwright scenarios
-- `test/` — Jest unit tests and Playwright E2E tests
+```bash
+npm run docs        # Generate TypeDoc documentation
+```
 
-Configuration
+## Project Structure
 
-- Set `GH_TOKEN` or appropriate credentials when using platform adapters.
-- OPFS availability depends on the browser; polyfills/mocks are used in tests.
+```
+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
+```
 
-Examples
+## 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>
+}
+```
 
-- See the `examples/` directory for a browser sample and Playwright scenarios.
+### 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
+  })
+}
+```
 
-API surface (overview)
+## Examples
 
-- `new VirtualFS(options?)` — options: `{ storageDir?: string, backend?: StorageBackend }`
-- `init()` — initialize backend and load index
-- `writeFile(path, content)`, `deleteFile(path)`, `renameFile(from,to)` — local edits
-- `getChangeSet()` — returns list of create/update/delete changes
-- `applyBaseSnapshot(snapshot, headSha)` — apply remote snapshot, returns conflicts if any
+See the [`examples/`](examples/) directory for:
+- Interactive browser demo with UI
+- Playwright E2E test scenarios
+- Multiple storage backend examples
 
-Testing & CI
+## Contributing
 
-- Run unit tests locally with `npm run test`.
-- `npm run test:e2e` requires a build (`npm run build`) before execution.
+Contributions are welcome! Please follow these guidelines:
 
-Contributing
+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
+   ```
 
-- Issues and PRs are welcome. Please open an Issue first to discuss design when appropriate.
-- Follow TypeScript + ESLint conventions; include tests for new behavior.
+## Support
 
-Support / Getting help
+- **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/
 
-- Report issues at: https://github.com/nojaja/browser-git-ops/issues
+## License
 
-License
+MIT License - see the [LICENSE](LICENSE) file for details.
 
-- Licensed under the MIT License — see the `LICENSE` file for details.
+## Author
 
-Maintainers
+Maintained by [nojaja](https://github.com/nojaja) ([free.riccia@gmail.com](mailto:free.riccia@gmail.com))
 
-- Maintained by `nojaja` (https://github.com/nojaja). See repository for contributors and history.
+## Acknowledgments
 
-TODO
-- Add code examples that demonstrate push/pull flows end-to-end.
-- Add a CONTRIBUTING.md with contributor guidelines and PR checklist.
+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

@@ -115,14 +115,6 @@ export declare abstract class AbstractGitAdapter {
      * @param args items to log
      */
     protected logError(..._messages: any[]): void;
-    /**
-     * Proxy to shared fetchWithRetry implementation
-     * @param input RequestInfo
-     * @param init RequestInit
-     * @param attempts retry attempts
-     * @param baseDelay base delay ms
-     * @returns Promise resolving to Response
-     */
     /**
      * Normalize different header-like shapes into a plain object.
      * @param headerLike headers in Headers, array, or plain object form
@@ -161,14 +153,6 @@ export declare abstract class AbstractGitAdapter {
      * @returns milliseconds to wait
      */
     protected backoffMs(attempt: number): number;
-    /**
-     * Delegate to shared mapWithConcurrency implementation
-     * @template T,R
-     * @param items items to map
-     * @param mapper async mapper
-     * @param concurrency concurrency limit
-     * @returns Promise resolving to mapped results
-     */
     /**
      * Map items with limited concurrency by delegating to the shared helper.
      * @template T,R

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

@@ -1 +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;AACD;;;;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;AAGD;;GAEG;AACH,qBAAa,cAAe,SAAQ,KAAK;CAAG;AAE5C;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,KAAK;CAAG;AAE/C;;;;;;;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;IAK3C;;;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;;;;;;;OAOG;IACH;;;;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;;;;;;;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"}
+{"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/githubAdapter.d.ts

@@ -7,8 +7,8 @@ type GHOptions = {
     host?: string;
 };
 /**
- * 指定ミリ秒だけ sleep するユーティリティ
- * @param ms ミリ秒
+ * GitHub 向けの `GitAdapter` 実装。
+ * GitHub API をラップしてリポジトリ操作（コミット作成、ブランチ一覧、ファイル取得等）を提供します。
  */
 export declare class GitHubAdapter extends AbstractGitAdapter implements GitAdapter {
     private _fetchWithRetry;
@@ -57,11 +57,6 @@ export declare class GitHubAdapter extends AbstractGitAdapter implements GitAdap
      * @returns {import('./adapter').CommitSummary}
      */
     private _mapGithubCommitToSummary;
-    /**
-     * コンテンツから sha1 を算出します。
-     * @param {string} content コンテンツ
-     * @returns {string} sha1 ハッシュ
-     */
     /**
      * ブロブを作成またはキャッシュから取得します。
      * @param {any[]} changes 変更一覧（create/update を含む）
@@ -69,11 +64,6 @@ export declare class GitHubAdapter extends AbstractGitAdapter implements GitAdap
      * @returns {Promise<Record<string,string>>} パス→blobSha のマップ
      */
     createBlobs(changes: any[], concurrency?: number): Promise<Record<string, string>>;
-    /**
-     * ブロブ作成用のヘルパー（createBlobs から抽出）
-     * @param {any} ch 変更エントリ
-      * @returns {Promise<{path:string,sha:string}>}
-     */
     /**
      * Create a blob for a change or return cached blobSha.
      * @param {any} ch change entry
@@ -163,10 +153,6 @@ export declare class GitHubAdapter extends AbstractGitAdapter implements GitAdap
       * @returns {Promise<string>} 参照先のコミット SHA
      */
     getRef(reference: string): Promise<string>;
-    /**
-     * Helper to fetch a ref URL and extract a SHA if present.
-     * Returns null when SHA not found.
-     */
     /**
      * Fetch a ref URL and extract a SHA if present.
      * @param {string} url API URL to fetch
@@ -207,18 +193,6 @@ export declare class GitHubAdapter extends AbstractGitAdapter implements GitAdap
         content: any;
         encoding: any;
     }>;
-    /**
-     * Resolve a commit-ish (branch, tag, or SHA) to a commit SHA.
-     * Resolution order: branch -> tag -> commit endpoint -> treat as SHA
-     * Throws if resolution fails.
-     */
-    /**
-     * Resolve a commit-ish (branch, tag, or SHA) to a commit SHA.
-     * Resolution order: branch -> tag -> commit endpoint -> treat as SHA
-     * Throws if resolution fails.
-     * @param {string} reference commit-ish to resolve
-     * @returns {Promise<string>} resolved commit SHA
-     */
     /**
      * Resolve a commit-ish (branch, tag, or SHA) to a commit SHA.
      * Resolution order: branch -> tag -> commit endpoint -> treat as SHA
@@ -234,44 +208,24 @@ export declare class GitHubAdapter extends AbstractGitAdapter implements GitAdap
      * @returns {Promise<string|null>} resolved sha or null
      */
     private _runResolvers;
-    /**
-     * Try to resolve reference as a branch and return its sha.
-     * @param {string} reference branch name
-     * @returns {Promise<string|null>} resolved sha or null
-     */
     /**
      * Try to resolve a branch name to a commit SHA.
      * @param {string} reference branch name
      * @returns {Promise<string|null>}
      */
     private _tryResolveByBranch;
-    /**
-     * Try to resolve reference as a tag and return its sha.
-     * @param {string} reference tag name
-     * @returns {Promise<string|null>} resolved sha or null
-     */
     /**
      * Try to resolve a tag name to a commit SHA.
      * @param {string} reference tag name
      * @returns {Promise<string|null>}
      */
     private _tryResolveByTag;
-    /**
-     * Try to resolve reference using commits endpoint (could be SHA or other form).
-     * @param {string} reference commit-ish
-     * @returns {Promise<string|null>} resolved sha or null
-     */
     /**
      * Try to resolve via commits endpoint (may accept SHA or other forms).
      * @param {string} reference commit-ish
      * @returns {Promise<string|null>}
      */
     private _tryResolveByCommitEndpoint;
-    /**
-     * Blob を取得して content を返す。取得失敗時は content=null を返す。
-     * @param {{sha:string,path:string}} f blob 情報
-     * @returns {Promise<{path:string,content:string|null}>}
-     */
     /**
      * Fetch a blob's content; return null content on failure.
      * @param {any} f blob metadata
@@ -284,16 +238,6 @@ export declare class GitHubAdapter extends AbstractGitAdapter implements GitAdap
      * @returns {string} decoded UTF-8 string
      */
     private _decodeBase64ToString;
-    /**
-     * Fetch a blob's content; return null content on failure.
-     * @param {any} f blob metadata
-     * @returns {Promise<{path:string,content:string|null}>}
-     */
-    /**
-     * リポジトリのスナップショットを取得します。
-     * @param {string} branch ブランチ名 (default: 'main')
-      * @returns {Promise<{headSha:string,shas:Record<string,string>,fetchContent:Function,snapshot:Record<string,string>}>}
-     */
     /**
      * Fetch repository snapshot: headSha, shas map and a fetchContent helper.
      * @param {string} branch branch name
@@ -337,22 +281,6 @@ export declare class GitHubAdapter extends AbstractGitAdapter implements GitAdap
      * @returns {Promise<null>}
      */
     private _mapperForFetch;
-    /**
-     * 指定パスのコンテンツを取得し、キャッシュと snapshot を更新します。
-     * @param {Map<string, any>} fileMap ファイルメタ情報マップ
-     * @param {Map<string, string>} contentCache キャッシュマップ
-     * @param {Record<string,string>} snapshot スナップショット出力マップ
-     * @param {string} p 取得対象パス
-     * @returns {Promise<string|null>} ファイル内容または null
-     */
-    /**
-     * Fetch single path content, update cache and snapshot.
-     * @param {Map<string, any>} fileMap file map
-     * @param {Map<string,string>} contentCache cache map
-     * @param {Record<string,string>} snapshot snapshot map
-     * @param {string} p path to fetch
-     * @returns {Promise<string|null>} content or null
-     */
     /**
      * Fetch single path content, update cache and snapshot.
      * @param {Map<string, any>} fileMap file map

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

@@ -1 +1 @@
-{"version":3,"file":"githubAdapter.d.ts","sourceRoot":"","sources":["../../src/git/githubAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,kBAAkB,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,KAAK,EAAqB,MAAM,sBAAsB,CAAA;AAGtL,KAAK,SAAS,GAAG;IACf,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;GAGG;AAGH,qBAAa,aAAc,SAAQ,kBAAmB,YAAW,UAAU;IACzE,OAAO,CAAC,eAAe,CAAqF;IAC5G,OAAO,CAAC,YAAY,CAAkE;IAEtF,OAAO,CAAC,SAAS,CAAiC;IAElD;;;OAGG;gBACS,OAAO,EAAE,SAAS;IAgB9B;;;;OAIG;IACG,WAAW,CAAC,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE;;;;;;;;;;;IAgBzE;;;;OAIG;IACH,OAAO,CAAC,eAAe;IASvB;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAc9B;;;;OAIG;IACH,OAAO,CAAC,yBAAyB;IAWjC;;;;OAIG;IAGH;;;;;OAKG;IACG,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,WAAW,SAAI;IAQjD;;;;OAIG;IACH;;;;OAIG;YACW,oBAAoB;IAiBlC;;;;;OAKG;IACG,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,WAAW,CAAC,EAAE,MAAM;IAkBrD;;;;;;OAMG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAYtE;;;OAGG;IACG,qBAAqB,IAAI,OAAO,CAAC,OAAO,uBAAuB,EAAE,kBAAkB,CAAC;IAc1F;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAQzB;;;OAGG;IACG,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,uBAAuB,EAAE,eAAe;;;;;;;;;;;;;IAgB1E;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IASvB;;;;;OAKG;IACG,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,UAAQ;IASnE;;;;;OAKG;IACG,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,uBAAuB,EAAE,kBAAkB,CAAC;IAcpH;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAUhC;;;;OAIG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM;IAOxC;;;;OAIG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM;IAmB9B;;;OAGG;IACH;;;;OAIG;YACW,iBAAiB;IAS/B;;;;OAIG;YACW,iBAAiB;IAwB/B;;;;OAIG;YACW,mBAAmB;IAQjC;;;;OAIG;YACW,qBAAqB;IAQnC;;;;;OAKG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,UAAQ;IAQhD;;;;OAIG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM;;;;IAU7B;;;;OAIG;IACH;;;;;;OAMG;IACH;;;;;;OAMG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAepD;;;;;OAKG;YACW,aAAa;IAY3B;;;;OAIG;IACH;;;;OAIG;YACW,mBAAmB;IAKjC;;;;OAIG;IACH;;;;OAIG;YACW,gBAAgB;IAK9B;;;;OAIG;IACH;;;;OAIG;YACW,2BAA2B;IAUzC;;;;OAIG;IACH;;;;OAIG;YACW,uBAAuB;IAgBrC;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAe7B;;;;OAIG;IAEH;;;;OAIG;IACD;;;;;OAKG;IACC,aAAa,CAAC,MAAM,SAAS,EAAE,WAAW,SAAI,GAAG,OAAO,CAAC,GAAG,CAAC;IAWnE;;;;;;;;OAQG;YACW,wBAAwB;IAItC;;;;OAIG;YACW,qBAAqB;IAanC;;;;;;;;OAQG;YACW,oBAAoB;IAalC;;;;;;;;OAQG;YACW,eAAe;IAM7B;;;;;;;OAOG;IACH;;;;;;;OAOG;IACH;;;;;;;OAOG;YACW,oBAAoB;CAenC;AAED,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAA;AAEnH,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxE,eAAe,aAAa,CAAA"}
+{"version":3,"file":"githubAdapter.d.ts","sourceRoot":"","sources":["../../src/git/githubAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,kBAAkB,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,KAAK,EAAqB,MAAM,sBAAsB,CAAA;AAEtL,KAAK,SAAS,GAAG;IACf,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAGD;;;GAGG;AACH,qBAAa,aAAc,SAAQ,kBAAmB,YAAW,UAAU;IACzE,OAAO,CAAC,eAAe,CAAqF;IAC5G,OAAO,CAAC,YAAY,CAAkE;IAEtF,OAAO,CAAC,SAAS,CAAiC;IAElD;;;OAGG;gBACS,OAAO,EAAE,SAAS;IAgB9B;;;;OAIG;IACG,WAAW,CAAC,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE;;;;;;;;;;;IAgBzE;;;;OAIG;IACH,OAAO,CAAC,eAAe;IASvB;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAc9B;;;;OAIG;IACH,OAAO,CAAC,yBAAyB;IAWjC;;;;;OAKG;IACG,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,WAAW,SAAI;IAQjD;;;;OAIG;YACW,oBAAoB;IAiBlC;;;;;OAKG;IACG,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,WAAW,CAAC,EAAE,MAAM;IAkBrD;;;;;;OAMG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAYtE;;;OAGG;IACG,qBAAqB,IAAI,OAAO,CAAC,OAAO,uBAAuB,EAAE,kBAAkB,CAAC;IAc1F;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAQzB;;;OAGG;IACG,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,uBAAuB,EAAE,eAAe;;;;;;;;;;;;;IAgB1E;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IASvB;;;;;OAKG;IACG,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,UAAQ;IASnE;;;;;OAKG;IACG,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,uBAAuB,EAAE,kBAAkB,CAAC;IAcpH;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAUhC;;;;OAIG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM;IAOxC;;;;OAIG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM;IAmB9B;;;;OAIG;YACW,iBAAiB;IAS/B;;;;OAIG;YACW,iBAAiB;IAwB/B;;;;OAIG;YACW,mBAAmB;IAQjC;;;;OAIG;YACW,qBAAqB;IAQnC;;;;;OAKG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,UAAQ;IAQhD;;;;OAIG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM;;;;IAU7B;;;;;;OAMG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAepD;;;;;OAKG;YACW,aAAa;IAY3B;;;;OAIG;YACW,mBAAmB;IAKjC;;;;OAIG;YACW,gBAAgB;IAK9B;;;;OAIG;YACW,2BAA2B;IAUzC;;;;OAIG;YACW,uBAAuB;IAgBrC;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAe7B;;;;;OAKG;IACG,aAAa,CAAC,MAAM,SAAS,EAAE,WAAW,SAAI,GAAG,OAAO,CAAC,GAAG,CAAC;IAWnE;;;;;;;;OAQG;YACW,wBAAwB;IAItC;;;;OAIG;YACW,qBAAqB;IAanC;;;;;;;;OAQG;YACW,oBAAoB;IAalC;;;;;;;;OAQG;YACW,eAAe;IAM7B;;;;;;;OAOG;YACW,oBAAoB;CAenC;AAED,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAA;AAEnH,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxE,eAAe,aAAa,CAAA"}