@core / contracts

1.0.0 ▾

1.0.0

verificadoMIT

GitHub

Tipos compartidos entre módulos GenPM: contenido, sitemap, búsqueda, recursos de admin, pagos y eventos

Código10 archivosContexto~532 tokensescaneo superado

~532 tokens→ src/lib/contracts/AGENTS.md→ .cursor/rules/genpm-core-contracts.mdc

Esto es exactamente lo que lee tu IA cuando trabaja en src/lib/contracts. No se añade nada más a su contexto.

@core/contracts — rules for AI agents

Purpose

Types and small zod schemas shared by GenPM catalog modules, so a module can consume "anything that provides content / sitemap URLs / search documents / admin resources / payments" without importing the concrete module. No logic, no tables, no runtime dependency besides zod.

Map

index.ts — public API. Import from here only.
content.ts — ContentSource, ContentEntry (implemented by @core/content and CMS adapters).
sitemap.ts — SitemapSource (consumed by @core/seo).
search.ts — SearchSource, SearchDocument (consumed by @core/search).
admin.ts — AdminResource, AdminField (consumed by @core/admin).
payment.ts — PaymentProvider (implemented by @core/checkout, used by @core/orders).
events.ts — CommerceEvent, LeadEvent and their zod schemas (consumed by @core/pixels).
money.ts — Money (integer minor units + ISO 4217 code).

Integration

Usually installed as a dependency of another module; nothing to wire.
To expose your own data to the admin, sitemap or search, implement the type and register it in the project file the consuming module documents (src/genpm/admin.ts, src/genpm/seo.ts, src/genpm/search.ts):
```
import { defineSitemapSource } from './lib/contracts/index.ts';
export const projects = defineSitemapSource({ name: 'projects', async *urls() { yield { loc: '/projects' }; } });
```
Validate untrusted tracking payloads with TrackedEventSchema.parse(body) before forwarding them.

Conventions

Money is always { amount: integer minor units, currency: 'EUR' }; never floats.
Sources are async iterables: stream rows in pages, don't load whole tables into memory.
AdminResource.input validates create/update input; permissions are <resource>:<action> (posts:update).

Don't

Don't add implementations or helpers with behaviour here; put them in the module that owns the concept.
Don't change an existing type incompatibly: every catalog module depends on it (major version of the whole train).
Don't import other modules from this folder.

# @core/contracts — rules for AI agents

## Purpose
Types and small zod schemas shared by GenPM catalog modules, so a module can consume "anything that provides content /
sitemap URLs / search documents / admin resources / payments" without importing the concrete module. No logic, no
tables, no runtime dependency besides `zod`.

## Map
- `index.ts` — public API. Import from here only.
- `content.ts` — `ContentSource`, `ContentEntry` (implemented by @core/content and CMS adapters).
- `sitemap.ts` — `SitemapSource` (consumed by @core/seo).
- `search.ts` — `SearchSource`, `SearchDocument` (consumed by @core/search).
- `admin.ts` — `AdminResource`, `AdminField` (consumed by @core/admin).
- `payment.ts` — `PaymentProvider` (implemented by @core/checkout, used by @core/orders).
- `events.ts` — `CommerceEvent`, `LeadEvent` and their zod schemas (consumed by @core/pixels).
- `money.ts` — `Money` (integer minor units + ISO 4217 code).

## Integration
1. Usually installed as a dependency of another module; nothing to wire.
2. To expose your own data to the admin, sitemap or search, implement the type and register it in the project file
   the consuming module documents (`src/genpm/admin.ts`, `src/genpm/seo.ts`, `src/genpm/search.ts`):
   ```ts
   import { defineSitemapSource } from './lib/contracts/index.ts';
   export const projects = defineSitemapSource({ name: 'projects', async *urls() { yield { loc: '/projects' }; } });
   ```
3. Validate untrusted tracking payloads with `TrackedEventSchema.parse(body)` before forwarding them.

## Conventions
- Money is always `{ amount: integer minor units, currency: 'EUR' }`; never floats.
- Sources are async iterables: stream rows in pages, don't load whole tables into memory.
- `AdminResource.input` validates create/update input; permissions are `<resource>:<action>` (`posts:update`).

## Don't
- Don't add implementations or helpers with behaviour here; put them in the module that owns the concept.
- Don't change an existing type incompatibly: every catalog module depends on it (major version of the whole train).
- Don't import other modules from this folder.

El árbol exacto que se inyectará, tras aplicar .genpmignore. Anclado a

src/lib/contracts/LICENSEsolo lectura · 7266529

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.