@sightmap/sightmap 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Fullstory, Inc.
+
+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

@@ -0,0 +1,141 @@
+# @sightmap/sightmap
+
+Library and CLI for the [Sightmap spec](https://github.com/sightmap/spec).
+
+A Sightmap is a YAML description of a web app's views, components, and API requests — the runtime semantics agents need to navigate and interact with the app. This package gives a coding agent a reliable, machine-readable toolkit for curating the `.sightmap/` directory in a customer's repo.
+
+## CLI
+
+```bash
+sightmap validate [path]                                         # default path: .sightmap
+sightmap lint [path] [--strict] [--rules <list>]
+sightmap match <url> [path] [--method <m>] [--require-view]
+sightmap explain <query> [path] [--by name|path] [--type view|component|request] [--require-hit]
+```
+
+Every command supports `--json` for machine-readable output and `--cwd <dir>` for invocation from outside the project.
+
+### Examples
+
+```bash
+# Validate the schema of every YAML file under .sightmap/
+$ sightmap validate
+ok    .sightmap/views.yaml
+ok    .sightmap/components.yaml
+2 file(s) checked.
+
+# Lint, asking for JSON
+$ sightmap lint --json
+{
+  "ok": true,
+  "command": "lint",
+  "diagnostics": [
+    { "severity": "warning", "code": "duplicate-route", "message": "Route \"/\" is defined by both ..." }
+  ],
+  "result": {}
+}
+
+# Resolve everything an agent needs to drive the URL /list/abc123
+$ sightmap match /list/abc123
+view  ListDetailScreen  (route /list/*)
+  source  app/list/[id].tsx
+comp  BottomTabBar  global  selector=[role="tablist"]
+comp  ListCard      global  selector=[data-testid="list-card"]
+...
+
+# Find every entry tied to a particular source file
+$ sightmap explain 'app/(tabs)/index.tsx'
+4 hit(s) for "app/(tabs)/index.tsx":
+  view       ArcList            matchedAs=path  src=app/(tabs)/index.tsx
+  component  CreateArcButton    matchedAs=path  src=app/(tabs)/index.tsx
+  component  StatusFilter       matchedAs=path  src=app/(tabs)/index.tsx
+  component  ArcCard            matchedAs=path  src=app/(tabs)/index.tsx
+```
+
+### Exit codes
+
+- `0` — success
+- `1` — logical failure (validation error, `--strict` warning, `--require-view`/`--require-hit` miss)
+- `2` — usage error
+
+For `lint`, default mode exits `0` even with warnings. Pass `--strict` to upgrade all warnings (including merge-time collisions surfaced by `loadDirectory`) to errors.
+
+### URL handling for `match`
+
+`match` accepts either a pathname (`/foo/bar`) or an absolute URL (`https://example.com/foo/bar`). It strips scheme, host, query string, and fragment before resolving. Trailing slashes are normalized. Matching is case-sensitive.
+
+Routes use the spec's glob syntax: `*` matches one segment, `**` matches any depth, `:param` segments normalize to `*`.
+
+### `--json` envelope
+
+Every command emits the same top-level shape so agents can dispatch on `command`:
+
+```json
+{
+  "ok": true,
+  "command": "match",
+  "diagnostics": [],
+  "result": { "...": "command-specific" }
+}
+```
+
+## Library
+
+```ts
+import {
+  parse,
+  validate,
+  merge,
+  loadDirectory,
+  match,
+  explain,
+  lint,
+} from "@sightmap/sightmap";
+
+const sightmap = await loadDirectory(".sightmap");
+
+const r = match(sightmap, { url: "/search" });
+console.log(r.view?.name, r.components.length);
+
+const hits = explain(sightmap, "src/components/Foo.tsx");
+const issues = await lint(sightmap, { root: process.cwd() });
+```
+
+`parse()` throws on invalid input; `validate()` returns a non-throwing `Result`. **Downstream packages should consume `validate()`,** not `parse()`. `parse()` is sugar for end-user code that knows the input is valid.
+
+### Diagnostics
+
+Lint and validate share a `Diagnostic` shape:
+
+```ts
+type Diagnostic = {
+  severity: "error" | "warning" | "info";
+  code: string;
+  message: string;
+  file?: string;
+  path?: string;                       // JSON pointer within the file
+  loc?: { line: number; column: number };
+  source?: string;
+};
+```
+
+Codes are stable, kebab-case, and exported as constants:
+
+| Code                          | Severity | Source                    |
+| ----------------------------- | -------- | ------------------------- |
+| `parse-error`                 | error    | `parse` / `loadDirectory` |
+| `schema-validation-failed`    | error    | `validate`                |
+| `unknown-version`             | error    | `validate`                |
+| `merge-collision-view`        | warning  | `merge` / `loadDirectory` |
+| `merge-collision-component`   | warning  | `merge` / `loadDirectory` |
+| `duplicate-view-name`         | warning  | `lint`                    |
+| `duplicate-route`             | warning  | `lint`                    |
+| `route-shadowing`             | warning  | `lint`                    |
+| `unknown-source`              | warning  | `lint`                    |
+| `selector-syntax`             | warning  | `lint`                    |
+
+Renames require an SEP. Future SDK ports (Python, Go) MUST emit identical codes for the same conditions.
+
+## License
+
+MIT.

package/dist/cli/index.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node