@core / catalog

1.0.0 ▾

1.0.0

已验证MIT

GitHub

商品目录：带选项的变体、以分计价、分类、合集、翻译和安全的库存预留

代码8 个文件上下文约 576 个 token扫描通过

约 576 个 token→ src/lib/catalog/AGENTS.md→ .cursor/rules/genpm-core-catalog.mdc

这正是你的 AI 在 src/lib/catalog 中工作时读取的内容。不会向其上下文添加其他任何内容。

@core/catalog — rules for AI agents

Purpose

Products for a store: up to 3 options (Size, Color…) and their variants with SKU, price/compare-at/cost in minor units, stock with backorder rules, weight and image; categories (tree), manual ordered collections, tags, attributes, per-locale translations, media references (@core/media ids), sitemap/search sources and admin resources. reserveStock locks the variant row so two buyers can't get the last unit. No cart, prices rules or multi-warehouse.

Map

index.ts — public API: createProduct, updateProduct, getProduct, listProducts, reserveStock, releaseStock, upsertCategory, setCollection, categoryTree, lowStockVariants, catalogAdminResources.
products.ts — products, variants, listing, stock. taxonomy.ts — categories and collections.
sources.ts — productSitemapSource, productSearchSource. admin.ts — admin resources. schema.ts — tables.

Integration

Env: STORE_CURRENCY (ISO code, default EUR). Migrations as in src/lib/db/AGENTS.md.
Product page: const p = await getProduct(slug, { locale }) (404 when null); show p.variants with format(v.price, locale) (@core/money) and v.availability; render p.description with @core/rich-text.
Listing: listProducts({ category, tag, collection, sort, page, minPrice, maxPrice, inStock }).
Register productSitemapSource() (seo), productSearchSource() (search) and ...catalogAdminResources() (admin).
JSON-LD with jsonLd.product (@core/seo) using availability and the real price.
Verify: create a product with two variants in the admin and see it at /products/<slug>.

Conventions

Prices are integers in STORE_CURRENCY; the server price is the only valid price (carts recompute it).
Reserve stock only inside the order transaction (reserveStock(id, qty, tx)); release it on cancel/expiry.
Archive products instead of deleting them: orders keep references to their variants.
Permissions: products:read|create|update|delete.

Don't

Don't show a compare-at price that isn't real (the EU requires the lowest price of the last 30 days for discounts).
Don't decrement stock with plain updates outside reserveStock/releaseStock.
Don't expose costAmount in public pages or APIs.

# @core/catalog — rules for AI agents

## Purpose
Products for a store: up to 3 options (Size, Color…) and their variants with SKU, price/compare-at/cost in minor
units, stock with backorder rules, weight and image; categories (tree), manual ordered collections, tags, attributes,
per-locale translations, media references (@core/media ids), sitemap/search sources and admin resources.
`reserveStock` locks the variant row so two buyers can't get the last unit. No cart, prices rules or multi-warehouse.

## Map
- `index.ts` — public API: `createProduct`, `updateProduct`, `getProduct`, `listProducts`, `reserveStock`, `releaseStock`, `upsertCategory`, `setCollection`, `categoryTree`, `lowStockVariants`, `catalogAdminResources`.
- `products.ts` — products, variants, listing, stock. `taxonomy.ts` — categories and collections.
- `sources.ts` — `productSitemapSource`, `productSearchSource`. `admin.ts` — admin resources. `schema.ts` — tables.

## Integration
1. Env: `STORE_CURRENCY` (ISO code, default `EUR`). Migrations as in `src/lib/db/AGENTS.md`.
2. Product page: `const p = await getProduct(slug, { locale })` (404 when null); show `p.variants` with
   `format(v.price, locale)` (@core/money) and `v.availability`; render `p.description` with @core/rich-text.
3. Listing: `listProducts({ category, tag, collection, sort, page, minPrice, maxPrice, inStock })`.
4. Register `productSitemapSource()` (seo), `productSearchSource()` (search) and `...catalogAdminResources()` (admin).
5. JSON-LD with `jsonLd.product` (@core/seo) using `availability` and the real price.
6. Verify: create a product with two variants in the admin and see it at `/products/<slug>`.

## Conventions
- Prices are integers in `STORE_CURRENCY`; the server price is the only valid price (carts recompute it).
- Reserve stock only inside the order transaction (`reserveStock(id, qty, tx)`); release it on cancel/expiry.
- Archive products instead of deleting them: orders keep references to their variants.
- Permissions: `products:read|create|update|delete`.

## Don't
- Don't show a compare-at price that isn't real (the EU requires the lowest price of the last 30 days for discounts).
- Don't decrement `stock` with plain updates outside `reserveStock`/`releaseStock`.
- Don't expose `costAmount` in public pages or APIs.

应用 .genpmignore 后将被注入的确切目录树。固定于

src/lib/catalog/LICENSE只读 · 79d3468

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.