hikoutei 0.10.9-dev → 0.10.11-dev

package/README.ja.md

@@ -12,7 +12,7 @@ Google Sheets を利用する MVP 向けの型付きリポジトリであり、
 Sheets へ非同期で投影されます。
 
 <a href="https://www.npmjs.com/package/hikoutei">npm</a> ·
-<a href="docs/quick-start.md">クイックスタート</a> ·
+<a href="website/guide/quick-start.md">クイックスタート</a> ·
 <a href="https://github.com/ManddarinShop/Hikoutei/issues">Issues</a>
 
 [![npm version](https://img.shields.io/npm/v/hikoutei?style=flat-square)](https://www.npmjs.com/package/hikoutei)
@@ -176,12 +176,12 @@ Hikoutei は、永続的なローカル outbox・冪等な配信・競合を考
 ため、一時的な API 障害でコミット済みのアプリケーション書き込みが失われる
 ことはありません。provider は資格情報・スプレッドシート ID・URL・ペイロードを
 ログに残さず、Google の割り当て枠に収まるようリクエスト開始間隔を調整します。
-詳細な状態機械と復旧ルールは[内部整合性モデル](docs/internal-consistency-model.md)を
+詳細な状態機械と復旧ルールは[内部整合性モデル](website/guide/internal-consistency.md)を
 参照してください。
 
 ライブの Google 呼び出しはオプトインであり、通常の検証経路はフェイク
 provider と SQLite フィクスチャです。詳細なセットアップとトラブルシューティン
-グは[クイックスタート](docs/quick-start.md)を参照してください。
+グは[クイックスタート](website/guide/quick-start.md)を参照してください。
 
 ## インストール
 
@@ -196,15 +196,15 @@ MikroORM は実装の詳細であり、Hikoutei の公開エンティティ API
 
 ## ドキュメント
 
-- [クイックスタート](docs/quick-start.md) — インストール、ORM ライフサイクル、
+- [クイックスタート](website/guide/quick-start.md) — インストール、ORM ライフサイクル、
   サービス側の同期設定
-- [アーキテクチャ](docs/architecture.md) — ローカルストアとシートビューの関係
-- [書き込みと同期フロー](docs/write-and-synchronization-flow.md) — 非同期配信と
+- [アーキテクチャ](website/guide/architecture.md) — ローカルストアとシートビューの関係
+- [書き込みと同期フロー](website/guide/sync-flow.md) — 非同期配信と
   復旧動作
-- [内部整合性モデル](docs/internal-consistency-model.md) — 永続的な outbox、
+- [内部整合性モデル](website/guide/internal-consistency.md) — 永続的な outbox、
   冪等な配信、競合を考慮した更新
-- [開発](docs/development.md) — ローカル開発とテストコマンド
-- [ベンチマークノート](docs/sync-bulk-write-benchmark.md) — 日付付きの測定と
+- [開発](website/guide/contributing.md) — ローカル開発とテストコマンド
+- [ベンチマークノート](website/guide/benchmarks.md) — 日付付きの測定と
   その限界
 
 ## 制限事項

package/README.ko.md

@@ -11,7 +11,7 @@ Google Sheets 기반 MVP를 위한 타입 안전 리포지토리이자 안전한
 사람이 검토하고 가볍게 협업할 수 있도록 Google Sheets에 비동기로 투영됩니다.
 
 <a href="https://www.npmjs.com/package/hikoutei">npm</a> ·
-<a href="docs/quick-start.md">빠른 시작</a> ·
+<a href="website/guide/quick-start.md">빠른 시작</a> ·
 <a href="https://github.com/ManddarinShop/Hikoutei/issues">이슈</a>
 
 [![npm version](https://img.shields.io/npm/v/hikoutei?style=flat-square)](https://www.npmjs.com/package/hikoutei)
@@ -169,11 +169,11 @@ Hikoutei는 내구성 있는 로컬 outbox, 멱등 전달, 충돌을 인지하
 사용하므로 일시적인 API 실패가 커밋된 애플리케이션 쓰기를 잃게 하지 않습니다.
 provider는 자격 증명, 스프레드시트 ID, URL, 페이로드를 로그에 남기지 않으며,
 Google 할당량 창 안에 머물도록 요청 시작 간격을 조절합니다. 상세 상태 머신과
-복구 규칙은 [내부 정합성 모델](docs/internal-consistency-model.md)을
+복구 규칙은 [내부 정합성 모델](website/guide/internal-consistency.md)을
 참고하세요.
 
 라이브 Google 호출은 opt-in이며, 일반적인 검증 경로는 fake provider와 SQLite
-fixture입니다. 자세한 설정과 문제 해결 단계는 [빠른 시작](docs/quick-start.md)을
+fixture입니다. 자세한 설정과 문제 해결 단계는 [빠른 시작](website/guide/quick-start.md)을
 참고하세요.
 
 ## 설치
@@ -190,14 +190,14 @@ MikroORM은 구현 세부 사항이며 Hikoutei의 공개 엔티티 API에는
 
 ## 문서
 
-- [빠른 시작](docs/quick-start.md) — 설치, ORM 생명주기, 서비스 측 동기화 설정
-- [아키텍처](docs/architecture.md) — 로컬 저장소와 Sheet 화면이 맞물리는 방식
-- [쓰기 및 동기화 흐름](docs/write-and-synchronization-flow.md) — 비동기 전달과
+- [빠른 시작](website/guide/quick-start.md) — 설치, ORM 생명주기, 서비스 측 동기화 설정
+- [아키텍처](website/guide/architecture.md) — 로컬 저장소와 Sheet 화면이 맞물리는 방식
+- [쓰기 및 동기화 흐름](website/guide/sync-flow.md) — 비동기 전달과
   복구 동작
-- [내부 정합성 모델](docs/internal-consistency-model.md) — 내구성 outbox,
+- [내부 정합성 모델](website/guide/internal-consistency.md) — 내구성 outbox,
   멱등 전달, 충돌을 인지하는 업데이트
-- [개발](docs/development.md) — 로컬 개발 및 테스트 명령어
-- [벤치마크 노트](docs/sync-bulk-write-benchmark.md) — 날짜가 기록된 측정과
+- [개발](website/guide/contributing.md) — 로컬 개발 및 테스트 명령어
+- [벤치마크 노트](website/guide/benchmarks.md) — 날짜가 기록된 측정과
   그 한계
 
 ## 한계

package/README.md

@@ -123,11 +123,14 @@ client directly.
 
 Google Sheets synchronization is a service-side concern. Applications do not
 import a provider client, pass Sheet routes to `createTypedSheets()`, or choose
-an operation for each write — the root API accepts only `dbName` and
-`entities`. The sync runtime uses one internal Google Sheets API provider with
-a service account — no Apps Script deployment. Sync auto-start is selected by
-`HIKOUTEI_SYNC_SPREADSHEET_URL` plus `GOOGLE_APPLICATION_CREDENTIALS`; there is
-no public `googleSheetsApi` bootstrap option to configure.
+an operation for each write — `CreateTypedSheetsOptions` fields (`dbName`,
+`entities`, `providerOptions`) are all optional. The sync runtime uses one
+internal Google Sheets API provider with a service account — no Apps Script
+deployment. Sync auto-start is selected by `HIKOUTEI_SYNC_SPREADSHEET_URL`
+plus `GOOGLE_APPLICATION_CREDENTIALS`. Optional `providerOptions` tunes the
+sync-path provider (telemetry/timeouts; inert when local-only), and
+`createTypedSheetsWithSync()` exposes the same options with a richer result
+for existing-sheet adoption.
 
 **Fastest path:** install the gcloud CLI, then run `npx hikoutei setup` from your
 project directory. On an interactive terminal it offers (press Enter) to
@@ -247,8 +250,8 @@ shared on the spreadsheet (the error tells you which email to share).
    `GOOGLE_APPLICATION_CREDENTIALS` and `HIKOUTEI_SYNC_SPREADSHEET_URL` set;
    `createTypedSheets()` detects them and starts the internal sync bootstrap —
    it creates and verifies headers on the registered tabs, then starts outbox
-   delivery and User_Input polling. There is no provider option to pass and no
-   internal bootstrap to start by hand.
+   delivery and User_Input polling. Pass `providerOptions` only when sync-path
+   tuning is needed; there is no internal bootstrap to start by hand.
 
 > **Legacy spreadsheet note.** Spreadsheets provisioned by the old Apps Script
 > provider with developer-metadata row anchors are not migrated: `User_Input`
@@ -273,15 +276,15 @@ verification path. The detailed setup and troubleshooting steps are in the
 
 ## Installation
 
-The project and npm package are both called `hikoutei`. The built-in SQLite
-provider currently requires MikroORM:
+The project and npm package are both called `hikoutei`. This repo uses pnpm
+(packageManager `pnpm@11.1.2`):
 
 ```sh
-npm install hikoutei @mikro-orm/core @mikro-orm/sql
+pnpm install --frozen-lockfile
 ```
 
-MikroORM is an implementation detail and does not appear in Hikoutei's public
-entity API.
+`@mikro-orm/core` and `@mikro-orm/sql` are optional peers (`optional: true`),
+lazy-loaded only when a runtime opens. `npm install` still works for consumers.
 
 ## Documentation
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hikoutei",
-  "version": "0.10.9-dev",
+  "version": "0.10.11-dev",
   "description": "Typed repository and safe write layer for Google Sheets-backed MVPs. SQLite-authoritative entity lifecycle with asynchronous Google Sheets projection.",
   "repository": {
     "type": "git",