From 7245a549eff543f2881432da6417c9c7fb97cc6f Mon Sep 17 00:00:00 2001 From: uppinote Date: Thu, 28 May 2026 07:47:08 +0900 Subject: [PATCH] docs(readme): correct vault API disclosure list MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 이전 disclosure는 실제 호출하지 않는 API를 나열하고 실제로 사용하는 API는 빠뜨려서 grep으로 검증 가능한 부정확함이 있었음. - 제거: vault.cachedRead, vault.getFiles, vault.getMarkdownFiles (src/ 어디서도 호출하지 않음) - 추가: vault.getAbstractFileByPath, vault.createFolder, vault.adapter.exists - 신규 섹션: Vault change events (vault.on / vault.offref) · "Watch for file changes" 토글의 동작 표면을 명시 --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7c044e2..259197d 100644 --- a/README.md +++ b/README.md @@ -247,12 +247,15 @@ This plugin emits Bases-compatible YAML frontmatter with proper data types for s What the plugin accesses and why — full transparency. Nothing is sent anywhere except the database APIs you configure; there is no telemetry. -- **Vault file enumeration** (`vault.getFiles`, `vault.getMarkdownFiles`, `vault.getAllLoadedFiles`) +- **Vault file enumeration** (`vault.getAllLoadedFiles`, `vault.getAbstractFileByPath`) - **Why**: find notes to sync, scope sync to your destination folder, and power folder / file autocomplete in settings. - **Scope**: file *paths* only. Contents are read on demand by the sync flow (see below), not during enumeration. -- **Vault read & write** (`vault.read`, `vault.cachedRead`, `vault.modify`, `vault.create`) - - **Why**: import remote records into `.md` files, parse frontmatter to push edits back, and write computed values returned by formulas / rollups. +- **Vault read & write** (`vault.read`, `vault.create`, `vault.modify`, `vault.createFolder`, `vault.adapter.exists`) + - **Why**: import remote records into `.md` files, parse frontmatter to push edits back, create destination subfolders, and write computed values returned by formulas / rollups. - **Scope**: only files inside the destination folder you configure per sync config. +- **Vault change events** (`vault.on`, `vault.offref`) + - **Why**: detect file edits when "Watch for file changes" is enabled, so edits can be queued for push. + - **Scope**: events on all files; the handler filters to your configured destination folder before queuing. - **Clipboard write** (`navigator.clipboard.writeText`) - **Why**: the Supabase credential form's "Copy SQL" button copies a one-time `SECURITY DEFINER` setup function for you to paste into the Supabase SQL Editor. A `Notice` fallback is shown when clipboard access is denied. - **Scope**: clipboard is only ever *written* (never read), and only when you click that specific button.