osmassist 0.0.0-stage → 1.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Andreas Neumann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,146 @@
-# Temporary Holding Version
+# osmAssist
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Suggests [OpenStreetMap](https://www.openstreetmap.org) tag changes from a
+feature's own website with the help of an AI model: opening hours, phone and
+fax numbers, e-mail addresses, a new website address and linked profiles on
+social networks, plus signals that the business has closed, moved, or that
+the domain is parked or belongs to someone else.
+
+The library only makes suggestions. Every suggestion comes with a verbatim
+quote and the page it is from, and must be checked and approved by a human
+before anything is changed in OpenStreetMap. It is used by
+[osmCorrection](https://github.com/cyper85/osmCorrection).
+
+## Principles
+
+- **One feature at a time, on request.** No bulk edits.
+- **The user's own API key.** The caller pays for the tokens.
+- **Only the feature's website** (the domain from the OSM tag) is fetched.
+  Closed or paid networks (Facebook, Instagram, Google …) are never fetched;
+  links to profiles are taken from the website only.
+- **No knowledge of the model.** A suggestion is rejected unless its quote is
+  found on a fetched page of the site; links and e-mail addresses must
+  appear on the page as well.
+
+## Installation
+
+```bash
+npm install osmassist
+```
+
+ES module with TypeScript types, for Node.js ≥ 22 and browsers (via a
+bundler). The Claude provider is a separate entry point
+(`osmassist/claude`), so a web app loads the Anthropic SDK only where it is
+used. The JSON Schema of the answer files is part of the package
+(`osmassist/schema/answer-file.schema.json`).
+
+## Usage
+
+```ts
+import { aiAssistedTag } from 'osmassist';
+// separate entry point, so a web app can load the SDK only when it is needed
+import { createClaudeProvider } from 'osmassist/claude';
+
+const provider = createClaudeProvider({ apiKey: userKey }); // Claude Sonnet 5.5 by default
+
+const result = await provider.analyze(
+  {
+    element: { type: 'node', id: 123, tags: { shop: 'bakery', website: 'https://example.org/' } },
+    url: 'https://example.org/',
+    today: '2026-11-01',
+    country: 'DE',
+  },
+  {
+    // format check of the caller, e.g. with osmValidation; returns the preferred form
+    validate: (key, value) => ({ valid: true, value }),
+  },
+);
+
+result.proposals; // [{ key: 'opening_hours', value: 'Mo-Fr 06:00-18:00', oldValue?, quote, sourceUrl }]
+result.signals;   // [{ kind: 'closed' | 'moved' | 'parked' | 'new_owner', quote, sourceUrl }]
+result.rejected;  // suggestions that failed a check, with reason
+result.pages;     // fetched pages, with an error code where fetching failed
+result.usage;     // tokens and estimated cost in USD
+aiAssistedTag([result.model]); // 'Anthropic Claude Sonnet 5.5', for the changeset
+```
+
+`analyze` is `read` and `assess` in one step. `read` costs tokens and does
+not depend on the current tags: the model reports everything the site says.
+`assess(reading, request, validate)` compares it with the tags of one
+element and costs nothing, so a reading can be reused for other elements
+with the same website (and the same address, if the site lists several
+locations):
+
+```ts
+import { assess } from 'osmassist';
+
+const reading = await provider.read(request);
+assess(reading, request, validate);
+assess(reading, { ...request, element: otherElement }, validate);
+```
+
+Keys follow the form the feature already uses (`phone` or `contact:phone`);
+new contact tags get `contact:*`.
+
+Errors are thrown as `AssistError` with a `code` (`auth`, `rate_limit`,
+`refused`, `incomplete`, `invalid_response`, `api`, `aborted`). Messages are
+in English; callers translate them by code.
+
+## Analysis by an AI agent (e.g. Claude Code)
+
+To use an AI plan instead of API credits, the analysis can run in an AI
+agent on the user's computer, e.g. Claude Code with a Claude plan, Kiro or
+Codex CLI: `jobFile` writes the instructions with the element IDs
+(`auftrag.md`), the agent saves the pages (headless browser or `curl`) and
+writes one answer file per job, and the app reads them back:
+
+```ts
+import { assess, parseAnswerFile, readingFromAnswer } from 'osmassist';
+
+const answer = parseAnswerFile(json);                       // antworten/a1.json
+answer.ai;                                                  // { vendor, model, tool }, as the agent states it
+const reading = readingFromAnswer(answer, pages, vendor);   // pages: path → saved HTML; vendor: confirmed by the user
+assess(reading, { element, url: answer.url, today }, validate);
+```
+
+The format of the answer files is described in
+[docs/answer-file.md](docs/answer-file.md), with the JSON Schema in
+[schema/answer-file.schema.json](schema/answer-file.schema.json) (also
+exported as `ANSWER_FILE_SCHEMA` and as the package file
+`osmassist/schema/answer-file.schema.json`).
+
+`htmlToText` turns the saved HTML into text without a DOM; links keep their
+address, so profile links and e-mail addresses can be checked. `decodeHtml`
+reads saved files in UTF-8, UTF-16 or the charset the page declares.
+
+## Claude
+
+- Web fetch tool (`web_fetch_20250910`) restricted to the site's domain, at
+  most 4 pages of at most 20,000 tokens each. Anthropic fetches the pages, so
+  the library also works in the browser without a proxy.
+- Structured output with a fixed JSON schema (`ANSWER_SCHEMA`).
+- Server-side fallback on refusals (`fallbacks: "default"`); the model that
+  actually answered is reported in `result.model`.
+- Calls from the browser are enabled (`dangerouslyAllowBrowser`): the key is
+  the user's own and only goes to `api.anthropic.com`. Recommend a key with a
+  short expiry that is used for nothing else.
+
+## Development
+
+```bash
+npm install
+npm test        # vitest, with recorded API responses (no real API calls)
+npm run build   # dist/
+npm run schema  # schema/answer-file.schema.json from the code
+```
+
+Releases: a GitHub release with a tag like `v1.0.0-alpha.1` (matching `version` in
+`package.json`) publishes the package to npm (`.github/workflows/publish.yaml`,
+npm trusted publishing, no token). Versions with a suffix such as
+`1.0.0-alpha.1` get the npm tag `next`, others `latest`; as long as `latest`
+is only npm's placeholder from reserving the name (`0.0.0-stage`), a
+pre-release becomes `latest` as well.
+
+## License
+
+MIT

package/dist/answerFile.d.ts

@@ -0,0 +1,185 @@
+import { type RawAnswer, type SiteReading } from './types.js';
+export declare const ANSWER_FORMAT = "osmcorrection-assist-answer";
+/** Where the schema file is published (schema/answer-file.schema.json in this repository). */
+export declare const ANSWER_FILE_SCHEMA_ID = "https://raw.githubusercontent.com/cyper85/osmAssist/master/schema/answer-file.schema.json";
+export interface ElementId {
+    type: 'node' | 'way' | 'relation';
+    id: number;
+}
+export interface AnswerPage {
+    url: string;
+    /** the saved HTML, relative to the working folder */
+    file?: string;
+    error?: string;
+}
+/** The AI that wrote the answer, as it states itself. */
+export interface AnswerAi {
+    /** maker of the model, e.g. "Anthropic", "OpenAI", "Google" (not the maker of the tool) */
+    vendor: string;
+    /** e.g. "claude-opus-5-5" */
+    model: string;
+    /** the agent it ran in, e.g. "Claude Code", "Kiro", "Codex CLI" */
+    tool: string;
+}
+export interface AnswerFile extends RawAnswer {
+    format: typeof ANSWER_FORMAT;
+    version: 1;
+    /** required by the schema; older answers (first run, 2026-11-02) do not have it */
+    ai?: AnswerAi;
+    job: string;
+    elements: ElementId[];
+    url: string;
+    fetched_with?: string;
+    pages: AnswerPage[];
+}
+/**
+ * JSON Schema of an answer file, given to the model in the job file. The
+ * entries of `proposals` and `signals` are the ones of the API (ANSWER_SCHEMA).
+ */
+export declare const ANSWER_FILE_SCHEMA: {
+    readonly $schema: 'https://json-schema.org/draft/2020-12/schema';
+    readonly $id: "https://raw.githubusercontent.com/cyper85/osmAssist/master/schema/answer-file.schema.json";
+    readonly title: 'osmAssist answer file';
+    readonly description: 'What an AI agent found on the website of one job (one website, one or more OpenStreetMap elements). See docs/answer-file.md.';
+    readonly type: 'object';
+    readonly additionalProperties: false;
+    readonly required: readonly ['format', 'version', 'ai', 'job', 'elements', 'url', 'fetched_with', 'pages', 'proposals', 'signals'];
+    readonly properties: {
+        readonly format: {
+            readonly const: "osmcorrection-assist-answer";
+        };
+        readonly version: {
+            readonly const: 1;
+        };
+        readonly ai: {
+            readonly type: 'object';
+            readonly description: 'The AI that wrote this answer. Used for the changeset tag ai_assisted, after the user confirmed it.';
+            readonly additionalProperties: false;
+            readonly required: readonly ['vendor', 'model', 'tool'];
+            readonly properties: {
+                readonly vendor: {
+                    readonly type: 'string';
+                    readonly minLength: 1;
+                    readonly description: 'Maker of the model (not of the tool), e.g. "Anthropic", "OpenAI", "Google", "Amazon".';
+                };
+                readonly model: {
+                    readonly type: 'string';
+                    readonly minLength: 1;
+                    readonly description: 'The model, e.g. "claude-opus-5-5"; "unknown" if not known.';
+                };
+                readonly tool: {
+                    readonly type: 'string';
+                    readonly minLength: 1;
+                    readonly description: 'The agent it ran in, e.g. "Claude Code", "Kiro", "Codex CLI".';
+                };
+            };
+        };
+        readonly job: {
+            readonly type: 'string';
+            readonly description: 'ID of the job, e.g. "a1".';
+        };
+        readonly elements: {
+            readonly type: 'array';
+            readonly minItems: 1;
+            readonly items: {
+                readonly type: 'string';
+                readonly pattern: '^(node|way|relation)/[0-9]+$';
+            };
+            readonly description: 'The elements of the job, as in the job list.';
+        };
+        readonly url: {
+            readonly type: 'string';
+            readonly description: 'The website from the OpenStreetMap data.';
+        };
+        readonly fetched_with: {
+            readonly enum: readonly ['browser', 'curl'];
+            readonly description: 'How the pages were saved.';
+        };
+        readonly pages: {
+            readonly type: 'array';
+            readonly description: 'Every page fetched, with "file" (saved) or "error" (could not be fetched).';
+            readonly items: {
+                readonly type: 'object';
+                readonly additionalProperties: false;
+                readonly required: readonly ['url'];
+                readonly properties: {
+                    readonly url: {
+                        readonly type: 'string';
+                    };
+                    readonly file: {
+                        readonly type: 'string';
+                        readonly pattern: '^seiten/[^/]+\\.html$';
+                    };
+                    readonly error: {
+                        readonly type: 'string';
+                    };
+                };
+                readonly oneOf: readonly [{
+                    readonly required: readonly ['file'];
+                }, {
+                    readonly required: readonly ['error'];
+                }];
+            };
+        };
+        readonly proposals: {
+            readonly type: 'array';
+            readonly items: {
+                readonly type: 'object';
+                readonly additionalProperties: false;
+                readonly required: readonly ['field', 'network', 'value', 'quote', 'source_url'];
+                readonly properties: {
+                    readonly field: {
+                        readonly type: 'string';
+                        readonly enum: readonly ["opening_hours", "phone", "fax", "email", "website", "social"];
+                    };
+                    readonly network: {
+                        readonly type: 'string';
+                        readonly enum: readonly ["none", "facebook", "twitter", "instagram", "tiktok", "youtube", "linkedin", "xing", "pinterest", "vimeo", "flickr", "vk", "mastodon", "bluesky", "mobilizon", "diaspora", "gnusocial", "telegram", "whatsapp", "matrix", "tripadvisor"];
+                    };
+                    readonly value: {
+                        readonly type: 'string';
+                    };
+                    readonly quote: {
+                        readonly type: 'string';
+                    };
+                    readonly source_url: {
+                        readonly type: 'string';
+                    };
+                };
+            };
+        };
+        readonly signals: {
+            readonly type: 'array';
+            readonly items: {
+                readonly type: 'object';
+                readonly additionalProperties: false;
+                readonly required: readonly ['kind', 'quote', 'source_url'];
+                readonly properties: {
+                    readonly kind: {
+                        readonly type: 'string';
+                        readonly enum: readonly ["closed", "moved", "parked", "new_owner"];
+                    };
+                    readonly quote: {
+                        readonly type: 'string';
+                    };
+                    readonly source_url: {
+                        readonly type: 'string';
+                    };
+                };
+            };
+        };
+    };
+};
+/** "node/42" → { type: 'node', id: 42 } */
+export declare function parseElementId(text: string): ElementId | undefined;
+/** Reads an answer file; throws with a reason if it does not have the format. */
+export declare function parseAnswerFile(json: string): AnswerFile;
+/** Normalizes a path inside the working folder ("./seiten\\a1.html" → "seiten/a1.html"). */
+export declare function folderPath(path: string): string;
+/**
+ * The reading of one answer file, with the text of its saved pages. A page
+ * whose file is missing counts as not fetched, so its quotes are rejected.
+ * `vendor` is the maker of the model as confirmed by the user; without it,
+ * the one the answer states.
+ */
+export declare function readingFromAnswer(answer: AnswerFile, files: Map<string, string>, vendor?: string): SiteReading;

package/dist/answerFile.js

@@ -0,0 +1,215 @@
+import { isRawAnswer } from './check.js';
+import { htmlToText } from './html.js';
+import { ANSWER_SCHEMA } from './prompt.js';
+import { FIELDS, NETWORKS, SIGNAL_KINDS } from './types.js';
+/*
+ * Analysis outside the app by an AI agent on the user's computer, e.g. Claude
+ * Code with the user's Claude plan (docs/answer-file.md): the app exports a
+ * job file with the element IDs, the agent saves the pages and writes one
+ * answer file per job, and the app imports them. The checks are the same as
+ * for the API.
+ */
+export const ANSWER_FORMAT = 'osmcorrection-assist-answer';
+/** Where the schema file is published (schema/answer-file.schema.json in this repository). */
+export const ANSWER_FILE_SCHEMA_ID = 'https://raw.githubusercontent.com/cyper85/osmAssist/master/schema/answer-file.schema.json';
+/**
+ * JSON Schema of an answer file, given to the model in the job file. The
+ * entries of `proposals` and `signals` are the ones of the API (ANSWER_SCHEMA).
+ */
+export const ANSWER_FILE_SCHEMA = {
+    $schema: 'https://json-schema.org/draft/2020-12/schema',
+    $id: ANSWER_FILE_SCHEMA_ID,
+    title: 'osmAssist answer file',
+    description: 'What an AI agent found on the website of one job (one website, one or more OpenStreetMap elements). See docs/answer-file.md.',
+    type: 'object',
+    additionalProperties: false,
+    required: ['format', 'version', 'ai', 'job', 'elements', 'url', 'fetched_with', 'pages', 'proposals', 'signals'],
+    properties: {
+        format: { const: ANSWER_FORMAT },
+        version: { const: 1 },
+        ai: {
+            type: 'object',
+            description: 'The AI that wrote this answer. Used for the changeset tag ai_assisted, after the user confirmed it.',
+            additionalProperties: false,
+            required: ['vendor', 'model', 'tool'],
+            properties: {
+                vendor: {
+                    type: 'string',
+                    minLength: 1,
+                    description: 'Maker of the model (not of the tool), e.g. "Anthropic", "OpenAI", "Google", "Amazon".',
+                },
+                model: { type: 'string', minLength: 1, description: 'The model, e.g. "claude-opus-5-5"; "unknown" if not known.' },
+                tool: { type: 'string', minLength: 1, description: 'The agent it ran in, e.g. "Claude Code", "Kiro", "Codex CLI".' },
+            },
+        },
+        job: { type: 'string', description: 'ID of the job, e.g. "a1".' },
+        elements: {
+            type: 'array',
+            minItems: 1,
+            items: { type: 'string', pattern: '^(node|way|relation)/[0-9]+$' },
+            description: 'The elements of the job, as in the job list.',
+        },
+        url: { type: 'string', description: 'The website from the OpenStreetMap data.' },
+        fetched_with: { enum: ['browser', 'curl'], description: 'How the pages were saved.' },
+        pages: {
+            type: 'array',
+            description: 'Every page fetched, with "file" (saved) or "error" (could not be fetched).',
+            items: {
+                type: 'object',
+                additionalProperties: false,
+                required: ['url'],
+                properties: {
+                    url: { type: 'string' },
+                    file: { type: 'string', pattern: '^seiten/[^/]+\\.html$' },
+                    error: { type: 'string' },
+                },
+                oneOf: [{ required: ['file'] }, { required: ['error'] }],
+            },
+        },
+        proposals: ANSWER_SCHEMA.properties.proposals,
+        signals: ANSWER_SCHEMA.properties.signals,
+    },
+};
+const isObject = (value) => typeof value === 'object' && value !== null;
+/** "node/42" → { type: 'node', id: 42 } */
+export function parseElementId(text) {
+    const match = /^(node|way|relation)\/(\d+)$/.exec(text.trim());
+    return match === null ? undefined : { type: match[1], id: Number(match[2]) };
+}
+/** Reads an answer file; throws with a reason if it does not have the format. */
+export function parseAnswerFile(json) {
+    let data;
+    try {
+        data = JSON.parse(json);
+    }
+    catch {
+        throw new Error('not valid JSON');
+    }
+    if (!isObject(data) || data.format !== ANSWER_FORMAT || data.version !== 1) {
+        throw new Error(`not an answer file (format "${ANSWER_FORMAT}", version 1)`);
+    }
+    if (typeof data.job !== 'string' || typeof data.url !== 'string') {
+        throw new Error('"job" or "url" missing');
+    }
+    const elements = Array.isArray(data.elements)
+        ? data.elements.map((e) => (typeof e === 'string' ? parseElementId(e) : undefined))
+        : [];
+    if (elements.length === 0 || elements.some((e) => e === undefined)) {
+        throw new Error('"elements" must list IDs like "node/42"');
+    }
+    const pages = Array.isArray(data.pages) ? data.pages : [];
+    const pageOk = (p) => isObject(p) &&
+        typeof p.url === 'string' &&
+        (p.file === undefined || typeof p.file === 'string') &&
+        (p.error === undefined || typeof p.error === 'string');
+    if (!pages.every(pageOk)) {
+        throw new Error('"pages" must have "url" and "file" or "error"');
+    }
+    // models sometimes name the kind of a signal "signal" or "type" (first run, 2026-11-02)
+    const signals = Array.isArray(data.signals)
+        ? data.signals.map((s) => (isObject(s) && s.kind === undefined ? { ...s, kind: s.signal ?? s.type } : s))
+        : data.signals;
+    const answer = {
+        proposals: data.proposals,
+        signals: Array.isArray(signals)
+            ? signals.map((s) => (isObject(s) ? { kind: s.kind, quote: s.quote, source_url: s.source_url } : s))
+            : signals,
+    };
+    if (!isRawAnswer(answer)) {
+        throw new Error(schemaProblem(answer.proposals, answer.signals));
+    }
+    const ai = isObject(data.ai) && typeof data.ai.vendor === 'string' && data.ai.vendor.trim() !== '' ? data.ai : undefined;
+    return {
+        format: ANSWER_FORMAT,
+        version: 1,
+        ...(ai === undefined
+            ? {}
+            : {
+                ai: {
+                    vendor: String(ai.vendor).trim(),
+                    model: typeof ai.model === 'string' ? ai.model : 'unknown',
+                    tool: typeof ai.tool === 'string' ? ai.tool : 'unknown',
+                },
+            }),
+        job: data.job,
+        elements: elements,
+        url: data.url,
+        ...(typeof data.fetched_with === 'string' ? { fetched_with: data.fetched_with } : {}),
+        pages: pages,
+        ...answer,
+    };
+}
+/** Names the first entry that does not match the schema, e.g. 'signals[0]: "kind" …'. */
+function schemaProblem(proposals, signals) {
+    const fields = (entry, rules) => rules.find(([name, ok]) => !ok(entry[name]));
+    const text = (v) => typeof v === 'string';
+    const listCheck = (name, list, rules) => {
+        if (!Array.isArray(list)) {
+            return `"${name}" must be a list`;
+        }
+        for (const [i, entry] of list.entries()) {
+            if (!isObject(entry)) {
+                return `${name}[${i}] is not an object`;
+            }
+            const wrong = fields(entry, rules);
+            if (wrong !== undefined) {
+                return `${name}[${i}]: "${wrong[0]}" ${wrong[2]}`;
+            }
+        }
+        return undefined;
+    };
+    const oneOf = (list) => (v) => typeof v === 'string' && list.includes(v);
+    return (listCheck('proposals', proposals, [
+        ['field', oneOf(FIELDS), `must be one of ${FIELDS.join(', ')}`],
+        ['network', oneOf(['none', ...NETWORKS]), 'must be "none" or a network'],
+        ['value', text, 'must be a text'],
+        ['quote', text, 'must be a text'],
+        ['source_url', text, 'must be a text'],
+    ]) ??
+        listCheck('signals', signals, [
+            ['kind', oneOf(SIGNAL_KINDS), `must be one of ${SIGNAL_KINDS.join(', ')}`],
+            ['quote', text, 'must be a text'],
+            ['source_url', text, 'must be a text'],
+        ]) ??
+        '"proposals" or "signals" do not match the schema');
+}
+/** Normalizes a path inside the working folder ("./seiten\\a1.html" → "seiten/a1.html"). */
+export function folderPath(path) {
+    return path.replace(/\\/g, '/').replace(/^(\.\/)+/, '');
+}
+/**
+ * The reading of one answer file, with the text of its saved pages. A page
+ * whose file is missing counts as not fetched, so its quotes are rejected.
+ * `vendor` is the maker of the model as confirmed by the user; without it,
+ * the one the answer states.
+ */
+export function readingFromAnswer(answer, files, vendor) {
+    const texts = {};
+    const pages = answer.pages.map((page) => {
+        if (page.file === undefined) {
+            return { url: page.url, error: page.error ?? 'not fetched' };
+        }
+        const html = files.get(folderPath(page.file));
+        if (html === undefined) {
+            return { url: page.url, error: `file missing: ${page.file}` };
+        }
+        if (html.trim() === '') {
+            return { url: page.url, error: `file empty: ${page.file}` };
+        }
+        texts[page.url] = htmlToText(html, page.url);
+        return { url: page.url };
+    });
+    return {
+        url: answer.url,
+        answer: { proposals: answer.proposals, signals: answer.signals },
+        texts,
+        pages,
+        model: {
+            vendor: vendor ?? answer.ai?.vendor ?? 'unknown',
+            name: answer.ai === undefined ? 'unknown' : `${answer.ai.model} (${answer.ai.tool})`,
+            id: answer.ai?.model ?? 'unknown',
+        },
+        usage: { inputTokens: 0, outputTokens: 0 },
+    };
+}
+//# sourceMappingURL=answerFile.js.map

package/dist/answerFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"answerFile.js","sourceRoot":"","sources":["../src/answerFile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAsD,MAAM,YAAY,CAAC;AAEhH;;;;;;GAMG;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG,6BAA6B,CAAC;AAE3D,8FAA8F;AAC9F,MAAM,CAAC,MAAM,qBAAqB,GAAG,2FAA2F,CAAC;AAoCjI;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,OAAO,EAAE,8CAA8C;IACvD,GAAG,EAAE,qBAAqB;IAC1B,KAAK,EAAE,uBAAuB;IAC9B,WAAW,EACT,8HAA8H;IAChI,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,CAAC;IAChH,UAAU,EAAE;QACV,MAAM,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE;QAChC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;QACrB,EAAE,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qGAAqG;YAClH,oBAAoB,EAAE,KAAK;YAC3B,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC;YACrC,UAAU,EAAE;gBACV,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,SAAS,EAAE,CAAC;oBACZ,WAAW,EAAE,uFAAuF;iBACrG;gBACD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,WAAW,EAAE,4DAA4D,EAAE;gBAClH,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,WAAW,EAAE,+DAA+D,EAAE;aACrH;SACF;QACD,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,2BAA2B,EAAE;QACjE,QAAQ,EAAE;YACR,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC;YACX,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,8BAA8B,EAAE;YAClE,WAAW,EAAE,8CAA8C;SAC5D;QACD,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,0CAA0C,EAAE;QAChF,YAAY,EAAE,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,2BAA2B,EAAE;QACrF,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,4EAA4E;YACzF,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,KAAK;gBAC3B,QAAQ,EAAE,CAAC,KAAK,CAAC;gBACjB,UAAU,EAAE;oBACV,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACvB,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,uBAAuB,EAAE;oBAC1D,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAC1B;gBACD,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;aACzD;SACF;QACD,SAAS,EAAE,aAAa,CAAC,UAAU,CAAC,SAAS;QAC7C,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,OAAO;KAC1C;CACO,CAAC;AAEX,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AAEnH,2CAA2C;AAC3C,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,MAAM,KAAK,GAAG,8BAA8B,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/D,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAsB,EAAE,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACpG,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,IAAI,IAAa,CAAC;IAClB,IAAI,CAAC;QACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,aAAa,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,+BAA+B,aAAa,eAAe,CAAC,CAAC;IAC/E,CAAC;IACD,IAAI,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;QACjE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IACD,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC3C,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACnF,CAAC,CAAC,EAAE,CAAC;IACP,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1D,MAAM,MAAM,GAAG,CAAC,CAAU,EAAE,EAAE,CAC5B,QAAQ,CAAC,CAAC,CAAC;QACX,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ;QACzB,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC;QACpD,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC;IACzD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACnE,CAAC;IACD,wFAAwF;IACxF,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;QACzC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACzG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACjB,MAAM,MAAM,GAAG;QACb,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;YAC7B,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACpG,CAAC,CAAC,OAAO;KACZ,CAAC;IACF,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IACnE,CAAC;IACD,MAAM,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,OAAO,IAAI,CAAC,EAAE,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IACzH,OAAO;QACL,MAAM,EAAE,aAAa;QACrB,OAAO,EAAE,CAAC;QACV,GAAG,CAAC,EAAE,KAAK,SAAS;YAClB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC;gBACE,EAAE,EAAE;oBACF,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE;oBAChC,KAAK,EAAE,OAAO,EAAE,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;oBAC1D,IAAI,EAAE,OAAO,EAAE,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;iBACxD;aACF,CAAC;QACN,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,QAAQ,EAAE,QAAuB;QACjC,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,GAAG,CAAC,OAAO,IAAI,CAAC,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrF,KAAK,EAAE,KAAqB;QAC5B,GAAG,MAAM;KACV,CAAC;AACJ,CAAC;AAED,yFAAyF;AACzF,SAAS,aAAa,CAAC,SAAkB,EAAE,OAAgB;IACzD,MAAM,MAAM,GAAG,CAAC,KAA8B,EAAE,KAAkD,EAAE,EAAE,CACpG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/C,MAAM,IAAI,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;IACnD,MAAM,SAAS,GAAG,CAChB,IAAY,EACZ,IAAa,EACb,KAAkD,EAC9B,EAAE;QACtB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,OAAO,IAAI,IAAI,kBAAkB,CAAC;QACpC,CAAC;QACD,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;YACxC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,OAAO,GAAG,IAAI,IAAI,CAAC,oBAAoB,CAAC;YAC1C,CAAC;YACD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACnC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO,GAAG,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACpD,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IACF,MAAM,KAAK,GAAG,CAAC,IAAuB,EAAE,EAAE,CAAC,CAAC,CAAU,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACrG,OAAO,CACL,SAAS,CAAC,WAAW,EAAE,SAAS,EAAE;QAChC,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,kBAAkB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/D,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAC,EAAE,6BAA6B,CAAC;QACxE,CAAC,OAAO,EAAE,IAAI,EAAE,gBAAgB,CAAC;QACjC,CAAC,OAAO,EAAE,IAAI,EAAE,gBAAgB,CAAC;QACjC,CAAC,YAAY,EAAE,IAAI,EAAE,gBAAgB,CAAC;KACvC,CAAC;QACF,SAAS,CAAC,SAAS,EAAE,OAAO,EAAE;YAC5B,CAAC,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,EAAE,kBAAkB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1E,CAAC,OAAO,EAAE,IAAI,EAAE,gBAAgB,CAAC;YACjC,CAAC,YAAY,EAAE,IAAI,EAAE,gBAAgB,CAAC;SACvC,CAAC;QACF,kDAAkD,CACnD,CAAC;AACJ,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,UAAU,CAAC,IAAY;IACrC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAkB,EAAE,KAA0B,EAAE,MAAe;IAC/F,MAAM,KAAK,GAA2B,EAAE,CAAC;IACzC,MAAM,KAAK,GAAkB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACrD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,aAAa,EAAE,CAAC;QAC/D,CAAC;QACD,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,iBAAiB,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;QAChE,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACvB,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,eAAe,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;QAC9D,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7C,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC;IAC3B,CAAC,CAAC,CAAC;IACH,OAAO;QACL,GAAG,EAAE,MAAM,CAAC,GAAG;QACf,MAAM,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;QAChE,KAAK;QACL,KAAK;QACL,KAAK,EAAE;YACL,MAAM,EAAE,MAAM,IAAI,MAAM,CAAC,EAAE,EAAE,MAAM,IAAI,SAAS;YAChD,IAAI,EAAE,MAAM,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,KAAK,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,GAAG;YACpF,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,KAAK,IAAI,SAAS;SAClC;QACD,KAAK,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE;KAC3C,CAAC;AACJ,CAAC"}

package/dist/check.d.ts

@@ -0,0 +1,22 @@
+import { type AssistRequest, type AssistResult, type Proposal, type RawAnswer, type Rejected, type Signal, type SiteReading, type Compare, type Validate } from './types.js';
+/** Checks the structure of the answer; the schema should already guarantee it. */
+export declare function isRawAnswer(value: unknown): value is RawAnswer;
+/**
+ * The key for a suggestion in the form the element already uses: an existing
+ * `contact:<name>`, else an existing `<name>`, else `contact:<name>`. The
+ * website stays `website` if it is new, opening hours are always
+ * `opening_hours`.
+ */
+export declare function targetKey(base: string, tags: Record<string, string>): string;
+/**
+ * Turns the answer into suggestions. A suggestion is rejected if its quote is
+ * not on a fetched page of the site, if a link or address is not on the page,
+ * if the value is invalid, or if it is the current value.
+ */
+export declare function checkAnswer(answer: RawAnswer, pages: Map<string, string>, request: AssistRequest, validate?: Validate, compare?: Compare): {
+    proposals: Proposal[];
+    signals: Signal[];
+    rejected: Rejected[];
+};
+/** Compares what was read on the website with the tags of one element. Costs nothing. */
+export declare function assess(reading: SiteReading, request: AssistRequest, validate?: Validate, compare?: Compare): AssistResult;