@core / site

1.1.0 ▾

1.1.0

verifiziertMIT

GitHub

Website-Einstellungen, bearbeitbare verschachtelte Menüs und Weiterleitungen ohne Schleifen und Open Redirects

Code10 DateienKontext~583 TokensPrüfung bestanden

~583 Tokens→ src/lib/site/AGENTS.md→ .cursor/rules/genpm-core-site.mdc

Genau das liest deine KI, wenn sie in src/lib/site arbeitet. Sonst wird ihrem Kontext nichts hinzugefügt.

@core/site — rules for AI agents

Purpose

What every site has: settings (name, logo, contact, social profiles, legal page paths) as a @core/content singleton, editable menus up to 3 levels as a content collection (slug = location: header, footer), and redirects managed from the admin with loop detection, safe targets (site paths or https to allowed hosts) and hit counters. No page content, no SEO tags (@core/seo reads these settings).

Map

index.ts — public API: getSiteSettings, getMenu, upsertRedirect (by from), updateRedirect (by id), resolveRedirect, redirectResponse, siteAdminResources.
content.ts — siteSettings, menus and their schemas. redirects.ts — redirect logic. links.ts — link validation.
adapters/hono.ts — redirectMiddleware. adapters/next.ts — redirectFor(req).

Integration

Env: SITE_URL (https://example.com), optional SITE_REDIRECT_HOSTS (comma-separated external hosts allowed as redirect targets). Migrations as in src/lib/db/AGENTS.md.
Import this module once at startup (it registers the site_settings and menus content definitions).
Seed initial values with seedEntry (@core/content): settings and the header/footer menus, using the site's current ones.
Render: const settings = await getSiteSettings({ locale }), const items = await getMenu('header', { locale }).
Redirects: Hono app.use(redirectMiddleware); Next.js middleware.ts with runtime: 'nodejs' calling redirectFor(req).
Add ...siteAdminResources() to src/genpm/admin.ts.
Verify: create a redirect /old → /new and request /old (301 to /new).

Conventions

Menu links are site paths, https://, mailto: or tel:; open external links with rel="noopener".
Redirect sources are exact paths without query; the incoming query string is preserved.
Permissions: site_settings:*, menus:*, redirects:read|create|update|delete.

Don't

Don't hardcode the site name, logo or menus in components once this module is installed.
Don't build redirects from user input; only from the admin through upsertRedirect / updateRedirect. Editing changes that row by id and fails with invalid_path (422) if the new from belongs to another redirect.
Don't put legal text here; only the paths of the legal pages.

# @core/site — rules for AI agents

## Purpose
What every site has: settings (name, logo, contact, social profiles, legal page paths) as a @core/content singleton,
editable menus up to 3 levels as a content collection (slug = location: `header`, `footer`), and redirects managed
from the admin with loop detection, safe targets (site paths or https to allowed hosts) and hit counters.
No page content, no SEO tags (@core/seo reads these settings).

## Map
- `index.ts` — public API: `getSiteSettings`, `getMenu`, `upsertRedirect` (by `from`), `updateRedirect` (by id), `resolveRedirect`, `redirectResponse`, `siteAdminResources`.
- `content.ts` — `siteSettings`, `menus` and their schemas. `redirects.ts` — redirect logic. `links.ts` — link validation.
- `adapters/hono.ts` — `redirectMiddleware`. `adapters/next.ts` — `redirectFor(req)`.

## Integration
1. Env: `SITE_URL` (`https://example.com`), optional `SITE_REDIRECT_HOSTS` (comma-separated external hosts allowed as redirect targets). Migrations as in `src/lib/db/AGENTS.md`.
2. Import this module once at startup (it registers the `site_settings` and `menus` content definitions).
3. Seed initial values with `seedEntry` (@core/content): settings and the `header`/`footer` menus, using the site's current ones.
4. Render: `const settings = await getSiteSettings({ locale })`, `const items = await getMenu('header', { locale })`.
5. Redirects: Hono `app.use(redirectMiddleware)`; Next.js `middleware.ts` with `runtime: 'nodejs'` calling `redirectFor(req)`.
6. Add `...siteAdminResources()` to `src/genpm/admin.ts`.
7. Verify: create a redirect `/old → /new` and request `/old` (301 to `/new`).

## Conventions
- Menu links are site paths, `https://`, `mailto:` or `tel:`; open external links with `rel="noopener"`.
- Redirect sources are exact paths without query; the incoming query string is preserved.
- Permissions: `site_settings:*`, `menus:*`, `redirects:read|create|update|delete`.

## Don't
- Don't hardcode the site name, logo or menus in components once this module is installed.
- Don't build redirects from user input; only from the admin through `upsertRedirect` / `updateRedirect`. Editing changes that row by id and fails with `invalid_path` (422) if the new `from` belongs to another redirect.
- Don't put legal text here; only the paths of the legal pages.

Der genaue Baum, der nach .genpmignore eingebunden wird. Gepinnt an

src/lib/site/LICENSEschreibgeschützt · b7c13fa

MIT License

Copyright (c) 2026 GenPM

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.