yamlite 0.36.0 → 0.38.0

package/README.md

@@ -200,7 +200,8 @@ The UI is available in English and Japanese. It follows your browser language on
 When the data folder is in a git repository with an `origin` remote, the bottom of the sidebar shows the current branch and how many files under the data folder changed. **Send for review** lists the changed files by table and record, asks for a title and an optional description, and sends the files you keep checked:
 
 - On the default branch, it creates a branch with the name you enter, or `yamlite/review-<date>-<time>` when you leave it blank, commits the files there, pushes it and opens a draft pull request. The UI stays on the new branch, so later edits go to the same pull request.
-- On any other branch, it commits and pushes to that branch. If the branch already has an open pull request, it links to it; otherwise it opens a draft pull request.
+- On any other branch, it commits and pushes to that branch. If the branch already has an open pull request (`gh` tells), the dialog links to it and asks only for a commit message; otherwise it opens a draft pull request.
+- With [Ask AI](#ask-ai) set up, **Write with AI** drafts the title and description (or the commit message) from the records and files you keep checked, in the UI's language. A new pull request's description follows the repository's `pull_request_template.md` (in `.github/`, the root or `docs/`, as GitHub looks for it; a `PULL_REQUEST_TEMPLATE/` folder of several is not used), and then the [AI instructions](#ai-instructions). You can edit the draft before sending.
 - With [`gh`](https://cli.github.com) installed and logged in, the pull request is created for you. Without it, you get a GitHub link that opens the pull request form already filled in. For other hosts the branch is pushed and you open the pull request there.
 - Only files under the data folder are committed. Git runs without prompts, so pushing needs credentials that already work without asking.
 - Each record is listed under its file, with the fields it changed; the arrow shows them as committed and now. ↶ puts a changed or deleted record back as committed, and the bin removes a record that was never committed, after a second click. These go through the same writes as the form, so comments and the safety checks apply. **Put back** does it for the changed and deleted records of the checked files. The toast that follows can undo it. `yamlite.yaml`, pages and other files are listed but never changed.
@@ -225,6 +226,23 @@ Set `ANTHROPIC_API_KEY` or `OPENAI_API_KEY` before `yamlite serve`, or enter a k
 - If [GitHub CLI](https://cli.github.com) is installed and logged in, the pull request is created for you and linked in the chat. Without it, the card links to GitHub's pull request form with the title and body filled in.
 - Switching branches changes the YAML files, and the database follows them, like an edit in your editor, even when many records disappear. If a declared table's folder doesn't exist on the target branch, the switch still happens but the database sync fails, and the card says so.
 
+#### AI instructions
+
+`ai:` in `yamlite.yaml` tells the AI features what everyone working in the folder wants: the language to write in, what the data's values mean, how pull requests are written. Edit it in the file, or with the scroll button in the Ask AI panel or **Edit instructions** under **Write with AI**; a save there changes only these keys and leaves `yamlite.yaml` as a change to send like any other.
+
+```yaml
+ai:
+  # Ask AI and pull request drafts
+  instructions: |
+    Write in English.
+    In tasks, status todo means not started.
+  # pull request drafts only, after instructions
+  pullRequests: Start titles with a verb. Say why in the description.
+```
+
+- Each is text of at most 4,000 characters; an empty one counts as none. They come after YAMLite's own prompt and win where they differ, `pullRequests` last. Pages' AI does not get them: a page sends its own prompt.
+- They are read for every answer and draft, so a change applies at once.
+
 ## Pages
 
 Add your own screens — a kanban board, a dashboard — to `serve`. A page is one HTML file that reads and writes your data through `window.yamlite`, limited to what `yamlite.yaml` allows it.

package/dist/browser/sqlite.d.mts

@@ -1,7 +1,7 @@
 //#region src/browser/sqlite.d.ts
 export declare const sqlite3: any;
-export declare const opfs: any;
 export declare function registerVfs(name: string): void;
+export declare function installOpfs(name?: string): Promise<any>;
 type Value = null | number | bigint | string | Uint8Array;
 type Row = Record<string, Value>;
 export declare const constants: Record<string, number>;

package/dist/browser/sqlite.mjs

@@ -1,11 +1,15 @@
 import sqlite3InitModule from "@sqlite.org/sqlite-wasm";
 //#region src/browser/sqlite.ts
 const sqlite3 = await sqlite3InitModule();
-const opfs = typeof globalThis.FileSystemHandle !== "undefined" ? await sqlite3.installOpfsSAHPoolVfs({ name: "yamlite" }) : null;
-let VFS = opfs?.vfsName;
+let VFS;
 function registerVfs(name) {
 	VFS = name;
 }
+async function installOpfs(name = "yamlite") {
+	const pool = await sqlite3.installOpfsSAHPoolVfs({ name });
+	VFS = pool.vfsName;
+	return pool;
+}
 const { capi, oo1 } = sqlite3;
 const constants = Object.fromEntries(Object.entries(capi).filter(([k, v]) => k.startsWith("SQLITE_") && typeof v === "number"));
 var SqliteError = class extends Error {
@@ -216,4 +220,4 @@ var DatabaseSync = class {
 	}
 };
 //#endregion
-export { DatabaseSync, StatementSync, constants, opfs, registerVfs, sqlite3 };
+export { DatabaseSync, StatementSync, constants, installOpfs, registerVfs, sqlite3 };

package/dist/cli.mjs

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-import { I as isLoopback, L as loopbackHosts, P as createHandler, R as check, a as query, c as exportSite, i as formatTable, n as formatCsv, o as generateConfig, r as formatJson, s as init, t as open } from "./src-O1FTGCot.mjs";
-import { n as guide, r as envKeys, t as createWorkspace } from "./workspace-1vCIMAfl.mjs";
+import { F as createHandler, L as isLoopback, R as loopbackHosts, a as query, c as exportSite, i as formatTable, n as formatCsv, o as generateConfig, r as formatJson, s as init, t as open, z as check } from "./src-DdRmp-vT.mjs";
+import { n as guide, r as envKeys, t as createWorkspace } from "./workspace-B4WnIeHR.mjs";
 import { createRequire } from "node:module";
 import { relative, resolve } from "node:path";
 import { homedir } from "node:os";

package/dist/core.d.mts

@@ -1,4 +1,4 @@
-import { A as parseConfig, B as HistoryEntry, C as Decision, D as OpenOptions, E as DeclaredTable, F as ColumnType, G as Rec, H as IndexSpec, I as ConflictInfo, J as ViewRecord, K as SchemaChange, L as DbRow, M as Capture, N as Change, O as TableInput, P as ChangeOp, R as DbValue, S as BaseHashes, T as Config, U as PageAccess, V as HistoryPage, W as PageSpec, _ as check, a as formatCsv, b as Watcher, c as query, d as init, f as ExportOptions, g as CheckTable, h as CheckResult, i as QueryResult, j as readsFile, k as TableLocation, l as InitOptions, m as exportSite, n as open, o as formatJson, p as ExportResult, q as TableSpec, r as QueryOptions, s as formatTable, t as Yamlite, u as generateConfig, v as WatchHandlers, w as CONFIG_NAMES, x as TableResult, y as WatchOptions, z as FieldChange } from "./index-BBHZ8yok.mjs";
+import { A as parseConfig, B as HistoryEntry, C as Decision, D as OpenOptions, E as DeclaredTable, F as ColumnType, G as Rec, H as IndexSpec, I as ConflictInfo, J as ViewRecord, K as SchemaChange, L as DbRow, M as Capture, N as Change, O as TableInput, P as ChangeOp, R as DbValue, S as BaseHashes, T as Config, U as PageAccess, V as HistoryPage, W as PageSpec, _ as check, a as formatCsv, b as Watcher, c as query, d as init, f as ExportOptions, g as CheckTable, h as CheckResult, i as QueryResult, j as readsFile, k as TableLocation, l as InitOptions, m as exportSite, n as open, o as formatJson, p as ExportResult, q as TableSpec, r as QueryOptions, s as formatTable, t as Yamlite, u as generateConfig, v as WatchHandlers, w as CONFIG_NAMES, x as TableResult, y as WatchOptions, z as FieldChange } from "./index-OSyELQEX.mjs";
 import { DatabaseSync } from "node:sqlite";
 import { LanguageModel, ModelMessage } from "ai";
 //#region src/store.d.ts
@@ -276,6 +276,8 @@ interface GitDriver {
   }, o: {
     afterTreeChange: () => Promise<void>;
   }): Promise<ReviewOutcome>;
+  openPr?(): Promise<string | null>;
+  pullRequestTemplate?(): Promise<string | null>;
   readonly namesBranch?: boolean;
   readonly defaultBranchFiles?: DefaultBranchFiles;
   readonly steps?: StepRunner;
@@ -430,6 +432,7 @@ interface HostOptions {
   tools: (conversationId: string) => AgentTool[];
   feedback: (conversationId: string) => string[];
   notes?: string[];
+  instructions?: () => string | null;
   keys?: Record<string, string>;
   viewerKeys?: boolean;
   models?: Record<string, string[]>;
@@ -459,6 +462,11 @@ declare class AgentHost {
     hasKey: boolean;
   }[];
   start(input: StartInput): Conversation;
+  viewerModel(input: StartInput): {
+    provider: string;
+    model: string;
+    languageModel: LanguageModel;
+  };
   pageProvider(): {
     provider: string;
     models: string[];
@@ -469,6 +477,7 @@ declare class AgentHost {
     languageModel: LanguageModel;
   };
   pageSlot(): () => void;
+  private system;
   private build;
   private listed;
   private modelsOf;
@@ -529,4 +538,7 @@ interface Workspace {
 }
 export declare function createWorkspace(o: WorkspaceOptions): Promise<Workspace>;
 //#endregion
+//#region src/git/pr.d.ts
+export declare function templatePath(paths: readonly string[]): string | null;
+//#endregion
 export { type AiOptions, type ApiContext, CONFIG_NAMES, type Capture, type Change, type ChangeOp, type CheckResult, type CheckTable, type ColumnType, type Config, type ConflictInfo, type Credentials, type Decision, type DeclaredTable, type DefaultBranchFiles, type DiffResult, type ExportOptions, type ExportResult, type Extract, type Extracted, type GitDriver, type GitStatus, type GitStep, type HistoryEntry, type HistoryPage, type HistoryTarget, type IndexSpec, type InitOptions, type OpenOptions, type PageSpec, type QueryOptions, type QueryResult, type Repo, type ReviewOutcome, type ReviewRequest, type RunOptions, type SchemaChange, type StepResult, type StepRunner, type TableInput, type TableLocation, type TableResult, type TableSpec, type WatchHandlers, type WatchOptions, type Watcher, type Workspace, type WorkspaceOptions, Yamlite, check, exportSite, formatCsv, formatJson, formatTable, generateConfig, init, open, parseConfig, query, readsFile };

package/dist/core.mjs

@@ -1,3 +1,3 @@
-import { C as fieldChanges, F as HttpError, H as readsFile, R as check, S as describeChange, V as parseConfig, a as query, c as exportSite, f as ReviewRefused, i as formatTable, n as formatCsv, o as generateConfig, r as formatJson, s as init, t as open, w as worthShowing, z as CONFIG_NAMES } from "./src-O1FTGCot.mjs";
-import { t as createWorkspace } from "./workspace-1vCIMAfl.mjs";
-export { CONFIG_NAMES, HttpError, ReviewRefused, check, createWorkspace, describeChange, exportSite, fieldChanges, formatCsv, formatJson, formatTable, generateConfig, init, open, parseConfig, query, readsFile, worthShowing };
+import { B as CONFIG_NAMES, C as describeChange, H as parseConfig, I as HttpError, T as worthShowing, U as readsFile, a as query, c as exportSite, f as ReviewRefused, h as templatePath, i as formatTable, n as formatCsv, o as generateConfig, r as formatJson, s as init, t as open, w as fieldChanges, z as check } from "./src-DdRmp-vT.mjs";
+import { t as createWorkspace } from "./workspace-B4WnIeHR.mjs";
+export { CONFIG_NAMES, HttpError, ReviewRefused, check, createWorkspace, describeChange, exportSite, fieldChanges, formatCsv, formatJson, formatTable, generateConfig, init, open, parseConfig, query, readsFile, templatePath, worthShowing };

package/dist/guide.md

@@ -169,3 +169,5 @@ Keys of a table under `tables:`. Details: https://github.com/yamlite-hq/yamlite#
 | `split`      | a column (declared in `columns`, not the key or body) or a field path whose values the sidebar lists under the table                                                            |
 
 The top-level `pages:` key adds custom pages to the web UI; see the README's Pages section.
+
+The top-level `ai:` key holds instructions for the AI features, each text of at most 4,000 characters: `instructions` for Ask AI and pull request drafts, `pullRequests` for pull request drafts only. See the README's AI instructions section.

package/dist/{index-BBHZ8yok.d.mts → index-OSyELQEX.d.mts}

@@ -70,6 +70,10 @@ interface TableSpec {
   captures: Capture[];
 }
 type PageAccess = "read" | "write";
+interface AiInstructions {
+  instructions: string | null;
+  pullRequests: string | null;
+}
 interface PageSpec {
   name: string;
   path: string;
@@ -172,6 +176,7 @@ type DeclaredTable = Omit<TableSpec, "path" | "mode" | "glob" | "captures" | "pe
 interface Config {
   tables: DeclaredTable[];
   pages: PageSpec[];
+  ai: AiInstructions;
 }
 declare function readsFile(l: TableLocation, file: string): boolean;
 declare function parseConfig(text: string, name?: string): Config;
@@ -300,6 +305,7 @@ declare function formatCsv(r: QueryResult): string;
 interface Yamlite {
   readonly tables: readonly TableSpec[];
   readonly pages: readonly PageSpec[];
+  readonly ai: AiInstructions;
   status(opts?: {
     tables?: string[];
   }): Promise<TableResult[]>;

package/dist/index.d.mts

@@ -1,2 +1,2 @@
-import { C as Decision, D as OpenOptions, F as ColumnType, H as IndexSpec, I as ConflictInfo, K as SchemaChange, N as Change, O as TableInput, P as ChangeOp, W as PageSpec, _ as check, a as formatCsv, b as Watcher, c as query, d as init, f as ExportOptions, g as CheckTable, h as CheckResult, i as QueryResult, l as InitOptions, m as exportSite, n as open, o as formatJson, p as ExportResult, q as TableSpec, r as QueryOptions, s as formatTable, t as Yamlite, u as generateConfig, v as WatchHandlers, x as TableResult, y as WatchOptions } from "./index-BBHZ8yok.mjs";
+import { C as Decision, D as OpenOptions, F as ColumnType, H as IndexSpec, I as ConflictInfo, K as SchemaChange, N as Change, O as TableInput, P as ChangeOp, W as PageSpec, _ as check, a as formatCsv, b as Watcher, c as query, d as init, f as ExportOptions, g as CheckTable, h as CheckResult, i as QueryResult, l as InitOptions, m as exportSite, n as open, o as formatJson, p as ExportResult, q as TableSpec, r as QueryOptions, s as formatTable, t as Yamlite, u as generateConfig, v as WatchHandlers, x as TableResult, y as WatchOptions } from "./index-OSyELQEX.mjs";
 export { type Change, type ChangeOp, type CheckResult, type CheckTable, type ColumnType, type ConflictInfo, type Decision, type ExportOptions, type ExportResult, type IndexSpec, type InitOptions, type OpenOptions, type PageSpec, type QueryOptions, type QueryResult, type SchemaChange, type TableInput, type TableResult, type TableSpec, type WatchHandlers, type WatchOptions, type Watcher, Yamlite, check, exportSite, formatCsv, formatJson, formatTable, generateConfig, init, open, query };

package/dist/index.mjs

@@ -1 +1 @@
-export { R as check, c as exportSite, n as formatCsv, r as formatJson, i as formatTable, o as generateConfig, s as init, t as open, a as query } from "./src-O1FTGCot.mjs";
+export { z as check, c as exportSite, n as formatCsv, r as formatJson, i as formatTable, o as generateConfig, s as init, t as open, a as query } from "./src-DdRmp-vT.mjs";