Initial Commit
This commit is contained in:
@@ -0,0 +1,46 @@
|
||||
---
|
||||
name: ab-testing
|
||||
description: Use when implementing or debugging code that uses @suaveplan/ab-testing: Enterprise A/B testing and experimentation: deterministic FNV-1a bucketing, targeting rules, variant assignment, conversion tracking, and OTel instrumentation.
|
||||
---
|
||||
|
||||
# @suaveplan/ab-testing
|
||||
|
||||
Enterprise A/B testing and experimentation engine with deterministic FNV-1a bucketing, targeting rules, variant assignment, conversion tracking, result aggregation, and OpenTelemetry instrumentation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/ab-testing`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/ab-testing";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/feature-flags`, `@suaveplan/logger`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/platform/ab-testing/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/platform/ab-testing/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/platform/ab-testing/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/feature-flags`
|
||||
- `@suaveplan/logger`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: api-schemas
|
||||
description: Use when implementing or debugging code that uses @suaveplan/api-schemas: Shared Zod schemas describing Suaveplan API request/response shapes — single source of truth for server plugins, React data hooks, and generated OpenAPI documents.
|
||||
---
|
||||
|
||||
# @suaveplan/api-schemas
|
||||
|
||||
Shared Zod schemas describing Suaveplan API request/response shapes. The single source of truth for server plugins, React data hooks, and generated OpenAPI documents.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/api-schemas`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/api-schemas";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/api/api-schemas/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/api/api-schemas/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/api/api-schemas/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
name: audit-logging
|
||||
description: Use when implementing or debugging code that uses @suaveplan/audit-logging: Tamper-proof, GDPR-compliant audit logging: cryptographic chain-integrity, pluggable storage, retention policy, GDPR export, and a rich event taxonomy.
|
||||
---
|
||||
|
||||
# @suaveplan/audit-logging
|
||||
|
||||
Tamper-proof, GDPR-compliant audit logging for Suaveplan. Provides a cryptographic chain-integrity engine, pluggable storage adapters, GDPR data export, configurable retention policies, and a rich event taxonomy spanning auth, authorization, data access, system, and GDPR events.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/audit-logging`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/audit-logging";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/crypto`, `@suaveplan/crypto-hash`, `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/logger`, `@suaveplan/serialize`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/platform/audit-logging/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/platform/audit-logging/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/platform/audit-logging/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/crypto`
|
||||
- `@suaveplan/crypto-hash`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/logger`
|
||||
- `@suaveplan/serialize`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
name: auth
|
||||
description: Use when implementing or debugging code that uses @suaveplan/auth: Provider-agnostic authentication: JWT lifecycle, API key management, session management, and request middleware with pluggable storage adapters.
|
||||
---
|
||||
|
||||
# @suaveplan/auth
|
||||
|
||||
Provider-agnostic authentication library for Suaveplan. Ships JWT token lifecycle, API key management, session management, and framework-agnostic middleware — all backed by a pluggable `AuthAdapter` interface.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/auth`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/auth";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/crypto`, `@suaveplan/crypto-keys`, `@suaveplan/error`, `@suaveplan/logger`, `@suaveplan/retry`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/auth/auth/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/auth/auth/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/auth/auth/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/crypto`
|
||||
- `@suaveplan/crypto-keys`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/logger`
|
||||
- `@suaveplan/retry`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: barcode
|
||||
description: Use when implementing or debugging code that uses @suaveplan/barcode: Barcode generation and parsing for common 1D symbologies: Code 128, Code 39, EAN-13, EAN-8, UPC-A, UPC-E, ITF.
|
||||
---
|
||||
|
||||
# @suaveplan/barcode
|
||||
|
||||
Runtime-agnostic 1D barcode generation for seven symbologies — Code 128B, Code 39, EAN-13, EAN-8, UPC-A, UPC-E, and ITF. Outputs inline SVG strings and binary bar-pattern arrays with no canvas, no DOM, and no Node.js built-ins required, making it safe to use in Bun, Deno, edge runtimes, and browsers alike. Includes check-digit calculation, barcode validation, and human-readable text rendering. Use this package to generate product labels, shipping labels (ITF/GTIN-14), retail barcodes (EAN/UPC), and document barcodes (Code 128). For 2D barcodes (QR codes) use `@suaveplan/qrcode`. This package does not support barcode scanning/decoding from images — it is generation-only.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/barcode`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/barcode";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/barcode/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/barcode/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/barcode/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: bitpacker
|
||||
description: Use when implementing or debugging code that uses @suaveplan/bitpacker: Bit-level binary packing and unpacking: arbitrary-width integers, booleans, fixed-point, bit-field schemas, and streaming read/write cursors.
|
||||
---
|
||||
|
||||
# @suaveplan/bitpacker
|
||||
|
||||
Bit-level binary packing and unpacking for TypeScript. Designed for network protocols, game-state serialisation, and compact binary formats. Pure TypeScript, zero runtime deps beyond `@suaveplan/error`.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/bitpacker`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/bitpacker";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/bitpacker/bitpacker/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/bitpacker/bitpacker/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/bitpacker/bitpacker/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: bytes
|
||||
description: Use when implementing or debugging code that uses @suaveplan/bytes: Low-level byte utilities: hex/base64/utf8 encoding, Uint8Array helpers, UUID conversion.
|
||||
---
|
||||
|
||||
# @suaveplan/bytes
|
||||
|
||||
Low-level byte utilities for Suaveplan: lossless hex/base64/UTF-8 encoding, `Uint8Array` manipulation, and UUID conversion. No native addons; depends only on platform globals (`TextEncoder`, `atob`/`btoa`, `crypto.randomUUID`) and `@suaveplan/error` for typed errors.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/bytes`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/bytes";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/bytes/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/bytes/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/bytes/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
44
packages/devtools/tooling/install-agent-skills/assets/skills/cache/SKILL.md
vendored
Normal file
44
packages/devtools/tooling/install-agent-skills/assets/skills/cache/SKILL.md
vendored
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: cache
|
||||
description: Use when implementing or debugging code that uses @suaveplan/cache: Type-safe caching abstraction: LRU/LFU/FIFO/TTL MemoryCache, NamespacedCache, CacheFactory, stale-while-revalidate, multi-get/set, lifecycle events, injectable clock, OTel instrumentation, and structured CACHE.
|
||||
---
|
||||
|
||||
# @suaveplan/cache
|
||||
|
||||
Type-safe caching abstraction for Suaveplan. Provides `MemoryCache` with LRU/LFU/FIFO/TTL eviction, `NamespacedCache` for shared-storage isolation, a `CacheFactory` with module-augmentation-based provider registry, stale-while-revalidate, multi-get/set, injectable clock and event bus, OTel instrumentation, and structured `CACHE.*` error codes.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/cache`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/cache";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/database/cache/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/database/cache/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/database/cache/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: cli
|
||||
description: Use when implementing or debugging code that uses @suaveplan/cli: Zero-dependency CLI toolkit: argument parser, command router, ANSI styling, output formatting, spinner, progress bar, interactive prompts.
|
||||
---
|
||||
|
||||
# @suaveplan/cli
|
||||
|
||||
Enterprise-grade CLI framework for Node.js. Composable fluent API with subcommand routing, option parsing, OTel tracing, and a full set of terminal UI primitives.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/cli`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/cli";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/readline`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/tooling/cli/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/tooling/cli/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/tooling/cli/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/readline`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: compress-image
|
||||
description: Use when implementing or debugging code that uses @suaveplan/compress-image: Runtime-agnostic image compression utilities: resize, quality reduction, format conversion, and metadata stripping via pluggable adapters.
|
||||
---
|
||||
|
||||
# @suaveplan/compress-image
|
||||
|
||||
Runtime-agnostic image compression utilities with pluggable adapters for Node.js (Sharp) and testing (MemoryAdapter). Supports resize, quality reduction, format conversion (JPEG, PNG, WebP, AVIF), and metadata stripping.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/compress-image`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/compress-image";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/image/compress-image/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/image/compress-image/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/image/compress-image/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: compress-svg
|
||||
description: Use when implementing or debugging code that uses @suaveplan/compress-svg: SVG optimisation and minification: whitespace removal, redundant attribute stripping, path data precision reduction, element collapsing, ID mangling, and SVGO-compatible plugin pipeline.
|
||||
---
|
||||
|
||||
# @suaveplan/compress-svg
|
||||
|
||||
SVG optimisation and minification for TypeScript. Pure TypeScript — no DOMParser, no external SVG library. Runs in Bun, Node.js, browsers, and edge runtimes.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/compress-svg`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/compress-svg";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/docs/compress-svg/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/docs/compress-svg/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/docs/compress-svg/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
name: config
|
||||
description: Use when implementing or debugging code that uses @suaveplan/config: Layered configuration management: defaults, file, object, env, CLI layers merged in priority order with deep-merge, Zod validation, OTel instrumentation, and event-bus watch support.
|
||||
---
|
||||
|
||||
# @suaveplan/config
|
||||
|
||||
Layered configuration management for Suaveplan. Resolves an ordered set of typed layers (defaults, file, object, env, CLI) in priority order, deep-merges the results, applies per-environment overrides, validates via a caller-supplied Zod schema or custom function, and exposes an immutable `ConfigStore` with live reload and event-bus change propagation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/config`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/config";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/env`, `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/config/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/config/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/config/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/env`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
name: crdt
|
||||
description: Use when implementing or debugging code that uses @suaveplan/crdt: Conflict-free replicated data types: G-Counter, PN-Counter, OR-Set, LWW-Register, MV-Register, 2P-Set, RGA, Vector Clock, and Sync Manager.
|
||||
---
|
||||
|
||||
# @suaveplan/crdt
|
||||
|
||||
Conflict-free Replicated Data Types (CRDTs) for distributed systems. Provides eight composable CRDT primitives plus a vector-clock and a sync manager that coordinate delta exchange across heterogeneous replicas.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/crdt`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/crdt";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/diff`, `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/crdt/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/crdt/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/crdt/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/diff`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: crypto-browser
|
||||
description: Use when implementing or debugging code that uses @suaveplan/crypto-browser: WebCrypto-backed engine implementations for @suaveplan/crypto — AES-256-GCM, Ed25519, ECDSA-P256/P384, X25519, ECDH, RSA, AES-KW, and non-extractable key support via crypto.
|
||||
---
|
||||
|
||||
# @suaveplan/crypto-browser
|
||||
|
||||
WebCrypto-backed engine implementations for `@suaveplan/crypto` — AES-256-GCM, Ed25519, ECDSA-P256/P384, X25519, ECDH-P256/P384, RSA, AES-KW, and non-extractable key support via `crypto.subtle`. Zero third-party cryptography dependencies.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/crypto-browser`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/crypto-browser";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/crypto`, `@suaveplan/error`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/crypto/crypto-browser/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/crypto/crypto-browser/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/crypto/crypto-browser/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/crypto`
|
||||
- `@suaveplan/error`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: crypto-cipher
|
||||
description: Use when implementing or debugging code that uses @suaveplan/crypto-cipher: AEAD cipher primitives with per-primitive selector layout: aes-256-gcm, chacha20-poly1305, xchacha20-poly1305.
|
||||
---
|
||||
|
||||
# @suaveplan/crypto-cipher
|
||||
|
||||
Low-level AEAD (Authenticated Encryption with Associated Data) cipher primitives for the `@suaveplan/crypto` stack. Provides three algorithms — AES-256-GCM, ChaCha20-Poly1305, and XChaCha20-Poly1305 — each as a standalone subpath export for tree-shaking. Nonces are always caller-supplied: the package validates nonce length but never generates randomness internally, keeping the CSPRNG boundary in the caller's control. Implementation flavour (`'noble'` vs `'native'`) is selected at build time via `crypto.config.ts`; all Phase 0 implementations route to `@noble/ciphers`. Use `@suaveplan/crypto` for the high-level façade that combines nonce generation, engine selection, and structured error handling; use this package only when you need to supply your own cipher engine implementation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/crypto-cipher`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/crypto-cipher";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/crypto-utils`, `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/crypto/crypto-cipher/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/crypto/crypto-cipher/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/crypto/crypto-cipher/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/crypto-utils`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
name: crypto-curve
|
||||
description: Use when implementing or debugging code that uses @suaveplan/crypto-curve: Elliptic-curve primitives with per-primitive selector layout: secp256k1, ed25519, x25519, p256.
|
||||
---
|
||||
|
||||
# @suaveplan/crypto-curve
|
||||
|
||||
Low-level elliptic-curve building blocks for the `@suaveplan/crypto` stack. Exposes four curves — secp256k1, Ed25519, X25519, and NIST P-256 — each as a standalone subpath export so bundlers only ship the primitives actually used. Every curve provides key generation, signing/verification (or key agreement), and raw byte operations. Implementation flavour (`'noble'` vs `'native'`) is selected at build time via the repo-root `crypto.config.ts`; all Phase 0 implementations route to `@noble/curves`. Use this package when you need raw curve operations; for high-level AEAD, signing, or sealed-box use `@suaveplan/crypto` instead.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/crypto-curve`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/crypto-curve";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/crypto-hash`, `@suaveplan/crypto-utils`, `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/crypto/crypto-curve/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/crypto/crypto-curve/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/crypto/crypto-curve/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/crypto-hash`
|
||||
- `@suaveplan/crypto-utils`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: crypto-hash
|
||||
description: Use when implementing or debugging code that uses @suaveplan/crypto-hash: Pure-TypeScript hashing substrate — SHA-2 digests, HMAC, HKDF, PBKDF2, Argon2id, hex/Base64 encoding.
|
||||
---
|
||||
|
||||
# @suaveplan/crypto-hash
|
||||
|
||||
Pure-TypeScript hashing substrate. SHA-2 digests, HMAC, HKDF, PBKDF2, Argon2id, and hex/Base64 encoding — no WASM, no browser globals, fully tree-shakeable.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/crypto-hash`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/crypto-hash";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/crypto-utils`, `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/crypto/crypto-hash/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/crypto/crypto-hash/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/crypto/crypto-hash/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/crypto-utils`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: crypto-keys
|
||||
description: Use when implementing or debugging code that uses @suaveplan/crypto-keys: Keypair generation, validation, and keychain store for @suaveplan/crypto — Ed25519, ECDSA-P256, X25519, pluggable adapters.
|
||||
---
|
||||
|
||||
# @suaveplan/crypto-keys
|
||||
|
||||
Keypair generation, validation, and keychain management for the `@suaveplan` stack. Delegates cryptographic operations to `@suaveplan/crypto` while adding key lifecycle utilities: tagging keypairs with their algorithm, validating structural and cryptographic correctness, and storing named keypairs with pluggable persistence adapters.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/crypto-keys`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/crypto-keys";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/crypto`, `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/crypto/crypto-keys/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/crypto/crypto-keys/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/crypto/crypto-keys/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/crypto`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: crypto-sodium
|
||||
description: Use when implementing or debugging code that uses @suaveplan/crypto-sodium: libsodium-backed engine implementations for @suaveplan/crypto — AEAD (XChaCha20-Poly1305, ChaCha20-Poly1305, AES-256-GCM), Ed25519 sign, X25519 agree, sealed-box, auth-box, KDF, BLAKE2b auth, Argon2id pwhash, Ristretto255 group ops.
|
||||
---
|
||||
|
||||
# @suaveplan/crypto-sodium
|
||||
|
||||
libsodium-backed engine implementations for `@suaveplan/crypto`. Provides AEAD encryption, Ed25519 signing, X25519 key agreement, sealed-box, auth-box, deterministic KDF, BLAKE2b MAC, Argon2id password hashing, and Ristretto255 group operations — all via the `libsodium-wrappers-sumo` WASM module.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/crypto-sodium`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/crypto-sodium";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/crypto`, `@suaveplan/error`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/crypto/crypto-sodium/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/crypto/crypto-sodium/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/crypto/crypto-sodium/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/crypto`
|
||||
- `@suaveplan/error`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: crypto-utils
|
||||
description: Use when implementing or debugging code that uses @suaveplan/crypto-utils: Shared cryptographic utilities: encoding (hex/base64/base64url/base58), byte helpers (concat/xor/i2osp/os2ip), constant-time equality, random bytes, zeroize, Merkle tree helpers, KAT/differential-fuzz test harnesses, PrimitiveId registry, PrimitiveNotImplemented error.
|
||||
---
|
||||
|
||||
# @suaveplan/crypto-utils
|
||||
|
||||
Shared cryptographic utilities consumed internally by all other `@suaveplan/crypto-*` packages. Provides the low-level primitives that every crypto implementation needs but that belong in one place: multi-alphabet encoding (`toHex`/`fromHex`, `toBase64`/`fromBase64`, `toBase64Url`, `toBase58`/`fromBase58`); byte helpers (`concatBytes`, `xor`, `i2osp`/`os2ip` for integer-to-octet-string conversions); `constantTimeEqual` for timing-safe comparisons; `randomBytes` with an injectable `ByteSource`; `zeroize` for wiping key material; Merkle tree helpers (`merkleRoot`, `merkleProof`, `verifyMerkleProof`); a `PrimitiveId` registry and `PrimitiveNotImplemented` sentinel error; and KAT/differential-fuzz harnesses (`runVectors`, `diffFuzz`) used in every crypto primitive's test suite. Zero runtime crypto dependencies — this package provides helpers only, not cryptographic algorithms. Application code should generally import from `@suaveplan/crypto` or `@suaveplan/crypto-hash`; import from this package only when building a new cryptographic primitive or engine adapter.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/crypto-utils`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/crypto-utils";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/bytes`, `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/crypto/crypto-utils/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/crypto/crypto-utils/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/crypto/crypto-utils/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/bytes`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
name: crypto-vault
|
||||
description: Use when implementing or debugging code that uses @suaveplan/crypto-vault: BIP39 mnemonic, Argon2id-locked vault, and chain signer for @suaveplan/crypto — deterministic HD key derivation, zeroize-on-lock, typed events.
|
||||
---
|
||||
|
||||
# @suaveplan/crypto-vault
|
||||
|
||||
BIP39 mnemonic management, Argon2id-hardened hierarchical key derivation, and multi-algorithm signing registry for the Suaveplan platform. The `Vault` class generates or imports a 12/15/18/21/24-word BIP39 mnemonic, unlocks it into a locked/unlocked state machine, derives named signing keys from HD paths (`m/signing/0`, `m/auth/0`, etc.) using either Ed25519 or ECDSA-P256, and zeroizes all key material on `lock()`. The `ChainSigner` is a standalone multi-key registry that associates named keys with signing algorithms for multi-signature workflows. Events (unlock/lock/derive/sign) are emitted via `@suaveplan/events` for audit trails. This package sits above `@suaveplan/crypto-keys` (raw keypair generation) and `@suaveplan/crypto` (primitive operations) — use it when you need mnemonic-seeded key hierarchies, not just raw keypairs.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/crypto-vault`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/crypto-vault";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/crypto`, `@suaveplan/crypto-hash`, `@suaveplan/crypto-keys`, `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/crypto/crypto-vault/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/crypto/crypto-vault/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/crypto/crypto-vault/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/crypto`
|
||||
- `@suaveplan/crypto-hash`
|
||||
- `@suaveplan/crypto-keys`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
name: crypto
|
||||
description: Use when implementing or debugging code that uses @suaveplan/crypto: Universal cryptographic primitives — AEAD (AES-256-GCM, ChaCha20-Poly1305, XChaCha20-Poly1305), Ed25519 / X25519 / ECDSA-P256, sealed-box, auth-box, constant-time compare, zeroize.
|
||||
---
|
||||
|
||||
# @suaveplan/crypto
|
||||
|
||||
Universal cryptographic primitives — engine-pluggable AEAD, Ed25519/ECDSA-P256 signing, X25519 key agreement, sealed-box, and auth-box. Built on audited [@noble/*](https://paulmillr.com/noble/) libraries with zero WASM.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/crypto`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/crypto";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/crypto-cipher`, `@suaveplan/crypto-curve`, `@suaveplan/crypto-hash`, `@suaveplan/crypto-utils`, `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/crypto/crypto/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/crypto/crypto/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/crypto/crypto/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/crypto-cipher`
|
||||
- `@suaveplan/crypto-curve`
|
||||
- `@suaveplan/crypto-hash`
|
||||
- `@suaveplan/crypto-utils`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: data-masking
|
||||
description: Use when implementing or debugging code that uses @suaveplan/data-masking: PII/sensitive data masking for objects and strings: field-level masking rules, nested object traversal, format-preserving masking, tokenization, and FNV-1a hashing.
|
||||
---
|
||||
|
||||
# @suaveplan/data-masking
|
||||
|
||||
PII/sensitive data masking for objects and strings with field-level rules, nested traversal, eight masking strategies, and OpenTelemetry instrumentation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/data-masking`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/data-masking";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/platform/data-masking/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/platform/data-masking/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/platform/data-masking/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: datetime
|
||||
description: Use when implementing or debugging code that uses @suaveplan/datetime: Timezone-aware date/time utilities with business-day arithmetic, recurrence rules, calendar math, and relative time formatting.
|
||||
---
|
||||
|
||||
# @suaveplan/datetime
|
||||
|
||||
Timezone-aware date/time utilities covering the most common application-layer date operations that the native `Date` API leaves unaddressed. The package provides calendar math (`addDuration`, `subtractDuration`, `startOf`, `endOf`, `getCalendarMonth`, leap-year detection), business-day arithmetic with configurable holiday calendars and custom weekend definitions, an RRULE-subset recurrence engine (DAILY/WEEKLY/MONTHLY/YEARLY with BYDAY/BYMONTH/COUNT/UNTIL), and human-readable relative time formatting (`"3 hours ago"`, `"in 2 days"`). All stateful entry points accept an injectable `Clock` for deterministic testing. Use this package for scheduling UIs, calendar components, invoice date calculations, and any domain where "next business day" or "every other Monday" has real meaning. For low-level stopwatches, throttle/debounce, or vector clocks use `@suaveplan/timing`.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/datetime`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/datetime";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/datetime/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/datetime/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/datetime/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: db-sqlite
|
||||
description: Use when implementing or debugging code that uses @suaveplan/db-sqlite: Universal SQLite adapter for Suaveplan: bun:sqlite on the Bun server, @sqlite.
|
||||
---
|
||||
|
||||
# @suaveplan/db-sqlite
|
||||
|
||||
Universal SQLite adapter for Suaveplan: bun:sqlite on the Bun server, @sqlite.org/sqlite-wasm in the browser, unified behind a Drizzle-ORM surface with LRU prepared-statement cache, forward-only migration runner, OTel instrumentation, and structured SQLITE.* error codes.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/db-sqlite`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/db-sqlite";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/db`, `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/database/db-sqlite/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/database/db-sqlite/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/database/db-sqlite/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/db`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: db
|
||||
description: Use when implementing or debugging code that uses @suaveplan/db: Universal relational database adapter interface: DatabaseAdapter (extends DatabaseLike), structured DB.
|
||||
---
|
||||
|
||||
# @suaveplan/db
|
||||
|
||||
Universal relational database adapter interface for Suaveplan. Provides the `DatabaseAdapter` contract (extending `DatabaseLike` from `@suaveplan/types`), injectable connection singletons, structured `DB.*` error codes, Zod-validated config types, a `MigrationRunner` interface, and full OpenTelemetry instrumentation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/db`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/db";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/database/db/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/database/db/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/database/db/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: dedup
|
||||
description: Use when implementing or debugging code that uses @suaveplan/dedup: Entity deduplication engine with pluggable match keys, scoring rules, Jaro-Winkler/Levenshtein similarity, and merge strategies.
|
||||
---
|
||||
|
||||
# @suaveplan/dedup
|
||||
|
||||
Entity deduplication engine for detecting and merging duplicate records in any data set. Given a list of objects with varying representations of the same real-world entity (e.g. `"John Smith"` vs `"J. Smith"`, or the same email in different capitalisation), the `DedupEngine` scores pairs using a weighted combination of field-level similarity algorithms — Jaro-Winkler, Levenshtein, exact match, or phonetic — groups records into connected components via union-find, and merges each group with a pluggable strategy (`latestWins`, `manual`, or `scoredMerge`). Use this package for ETL pipelines, contact deduplication, and data cleansing. For domain-name-specific normalisation and alias resolution use `@suaveplan/domain-normalizer`; for string-similarity primitives only, the scoring module is exported as a standalone subpath.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/dedup`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/dedup";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/dedup/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/dedup/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/dedup/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: diff
|
||||
description: Use when implementing or debugging code that uses @suaveplan/diff: Zero-dependency RFC 6902 JSON Patch engine with structural diffing, patch application/inversion, linear history manager, sync manager, and rich path utilities.
|
||||
---
|
||||
|
||||
# @suaveplan/diff
|
||||
|
||||
Zero-dependency RFC 6902 JSON Patch engine for computing, applying, and inverting structural differences between JSON documents. The `diff(a, b)` function produces a minimal patch using index-based or LCS array strategies; `applyPatch` applies it; `revertPatch` undoes it; and `invertPatch` creates an inverse patch. A `HistoryManager` provides undo/redo with configurable depth and branch truncation on new edits. A `SyncManager` handles optimistic concurrency: apply local changes speculatively, then reconcile when the server responds. RFC 6901 JSON Pointer parsing and formatting is exposed as a standalone `path` module. Use this package for collaborative editing, undo/redo stacks, change-event streams, and any system where you need to track or transmit the delta between two object states rather than the full state itself.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/diff`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/diff";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/diff/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/diff/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/diff/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: dmarc
|
||||
description: Use when implementing or debugging code that uses @suaveplan/dmarc: DMARC report parser — parses aggregate (RUA) and forensic (RUF) DMARC XML reports into typed structures.
|
||||
---
|
||||
|
||||
# @suaveplan/dmarc
|
||||
|
||||
DMARC report parser for `@suaveplan` — parses aggregate (RUA) and forensic (RUF) DMARC XML reports into validated, strongly-typed structures. Accepts raw XML strings or gzip-compressed binary blobs.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/dmarc`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/dmarc";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/emails/dmarc/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/emails/dmarc/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/emails/dmarc/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: domain-normalizer
|
||||
description: Use when implementing or debugging code that uses @suaveplan/domain-normalizer: Normalisation, matching, and alias-canonicalisation for internet domain names.
|
||||
---
|
||||
|
||||
# @suaveplan/domain-normalizer
|
||||
|
||||
Normalisation, matching, and alias-canonicalisation for internet domain names. Given heterogeneous URL or domain input — including common mobile/CDN subdomains and 31 built-in alias mappings (e.g. `m.youtube.com → youtube.com`, `old.reddit.com → reddit.com`) — this package produces a canonical registrable domain via `tldts`, strips `www`/`m`/`mobile` prefixes, resolves the alias map, and returns structured `NormalizedDomain` objects. It also provides Levenshtein-based similarity scoring (`computeSimilarity`), fuzzy matching (`matchDomains`), and a `groupDomains` function that clusters a mixed list by canonical root domain. Use this package for deduplicating contact email domains, canonicalising URLs before storage, and building domain-level blocklists. For full entity deduplication across arbitrary fields use `@suaveplan/dedup`; for MIME or URL content-type detection use `@suaveplan/mime`.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/domain-normalizer`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/domain-normalizer";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/domain-normalizer/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/domain-normalizer/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/domain-normalizer/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
43
packages/devtools/tooling/install-agent-skills/assets/skills/env/SKILL.md
vendored
Normal file
43
packages/devtools/tooling/install-agent-skills/assets/skills/env/SKILL.md
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: env
|
||||
description: Use when implementing or debugging code that uses @suaveplan/env: Type-safe environment variable loading: schema-first validation, field types, dotenv loader, presets, structured errors.
|
||||
---
|
||||
|
||||
# @suaveplan/env
|
||||
|
||||
Type-safe, schema-first environment variable loading for Node.js and edge runtimes. Define a schema of typed field builders, point it at your sources, and receive a frozen record with TypeScript types inferred at compile time — no manual type annotations required.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/env`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/env";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/env/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/env/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/env/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: error
|
||||
description: Use when implementing or debugging code that uses @suaveplan/error: Foundation error substrate — SuaveplanError base class, stable code registry, cause-chain traversal, Zod-validated wire format (JSON + MessagePack), redaction, OTel span-event adapter, i18n resolver hook.
|
||||
---
|
||||
|
||||
# @suaveplan/error
|
||||
|
||||
Foundation error substrate for Suaveplan. Every non-testing `@suaveplan/*` package extends this library's `SuaveplanError` base class and uses its stable code registry. The package provides: `SuaveplanError<TCode>` — an abstract base with literal-typed discriminant codes, injectable clock, context bag, traceId, and cause chaining; `defineCodes(namespace, reasons)` — a frozen, literal-typed registry that makes error codes refactor-safe; `walkCauses(err)` — a cycle-safe, depth-bounded generator for traversing nested error causes; lossless JSON and binary wire formats (`toJSON`/`fromJSON`/`toBinary`/`fromBinary`) with Zod validation; `markSensitive`/`unwrapSensitive` for redaction at serialization boundaries; `toSpanEvent` for OpenTelemetry `exception` span events without an OTel SDK import; and a `setMessageResolver` hook for i18n. Zero `@suaveplan/*` runtime or peer dependencies — this is the lowest-level package in the stack.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/error`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/error";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/error/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/error/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/error/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
name: etl
|
||||
description: Use when implementing or debugging code that uses @suaveplan/etl: Extract-Transform-Load pipeline engine with typed stages, error handling, observable progress, and OTel instrumentation.
|
||||
---
|
||||
|
||||
# @suaveplan/etl
|
||||
|
||||
Extract-Transform-Load pipeline engine with typed stages, error handling, observable progress, and OTel instrumentation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/etl`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/etl";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/serialize`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/platform/etl/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/platform/etl/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/platform/etl/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/serialize`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
name: event-sourcing
|
||||
description: Use when implementing or debugging code that uses @suaveplan/event-sourcing: Event sourcing patterns: aggregate root, typed event store, snapshot support, projections, upcasting, and OTel instrumentation.
|
||||
---
|
||||
|
||||
# @suaveplan/event-sourcing
|
||||
|
||||
Event sourcing patterns for Suaveplan: typed aggregate root, in-memory event store with optimistic concurrency, snapshot support, projections, upcasting, and OTel instrumentation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/event-sourcing`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/event-sourcing";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/diff`, `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/events/event-sourcing/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/events/event-sourcing/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/events/event-sourcing/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/diff`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
name: events-metrics
|
||||
description: Use when implementing or debugging code that uses @suaveplan/events-metrics: OTel metrics companion for @suaveplan/events: dispatch counters, latency histograms, queue-depth gauges, and active-subscriber counts via interceptor API.
|
||||
---
|
||||
|
||||
# @suaveplan/events-metrics
|
||||
|
||||
OTel metrics companion for `@suaveplan/events`. Attaches via the public interceptor API to record dispatch totals, listener error counts, and latency histograms per event name.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/events-metrics`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/events-metrics";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/opentelemetry`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/events/events-metrics/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/events/events-metrics/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/events/events-metrics/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/opentelemetry`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: events-otel
|
||||
description: Use when implementing or debugging code that uses @suaveplan/events-otel: OpenTelemetry tracing companion for @suaveplan/events: wraps each dispatch in a span, propagates W3C Trace Context, and records listener exceptions as span errors.
|
||||
---
|
||||
|
||||
# @suaveplan/events-otel
|
||||
|
||||
OpenTelemetry tracing companion for `@suaveplan/events`. Wraps each dispatch in a span, propagates W3C Trace Context, and records listener exceptions as span errors.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/events-otel`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/events-otel";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/events/events-otel/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/events/events-otel/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/events/events-otel/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
name: events-schema
|
||||
description: Use when implementing or debugging code that uses @suaveplan/events-schema: Runtime schema-validation companion for @suaveplan/events: validates event payloads at dispatch boundaries via Zod schemas with strict/warn/sample modes and sensitive field redaction.
|
||||
---
|
||||
|
||||
# @suaveplan/events-schema
|
||||
|
||||
Runtime schema-validation companion for `@suaveplan/events`. Validates event payloads at dispatch boundaries via Zod schemas with strict/warn/sample modes and sensitive field redaction.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/events-schema`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/events-schema";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/schema-registry`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/events/events-schema/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/events/events-schema/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/events/events-schema/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/schema-registry`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: events-transport
|
||||
description: Use when implementing or debugging code that uses @suaveplan/events-transport: Cross-context event bridges for @suaveplan/events: MessageChannel (at-least-once with ack) and BroadcastChannel (at-most-once) transports with nonce dedup, W3C trace context, and AbortSignal support.
|
||||
---
|
||||
|
||||
# @suaveplan/events-transport
|
||||
|
||||
Cross-context event bridges for `@suaveplan/events`: `MessageChannel` (at-least-once with ack/retry) and `BroadcastChannel` (at-most-once, fan-out) transports with nonce deduplication and AbortSignal support.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/events-transport`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/events-transport";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/events/events-transport/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/events/events-transport/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/events/events-transport/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: events
|
||||
description: Use when implementing or debugging code that uses @suaveplan/events: Typed event-bus substrate: pub/sub with deterministic FIFO, interceptor API, bounded-queue backpressure, idempotent listeners, Zod-validated envelopes, passive observability adapter.
|
||||
---
|
||||
|
||||
# @suaveplan/events
|
||||
|
||||
Typed event-bus substrate for Suaveplan. Pub/sub with deterministic FIFO delivery, interceptor API, bounded-queue backpressure, idempotent listeners, Zod-validated envelopes, and a passive observability adapter.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/events`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/events";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/events/events/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/events/events/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/events/events/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: exif
|
||||
description: Use when implementing or debugging code that uses @suaveplan/exif: Dependency-free, runtime-agnostic EXIF/XMP/IPTC metadata reader, writer, and stripper for JPEG and PNG images.
|
||||
---
|
||||
|
||||
# @suaveplan/exif
|
||||
|
||||
Dependency-free, runtime-agnostic EXIF/XMP/IPTC metadata reader, writer, and stripper for JPEG and PNG images. Parses JPEG segment chains to locate and decode the EXIF IFD (TIFF byte-order aware, including GPS and SubIFD), IPTC IIM (caption, keywords, copyright), and XMP Dublin Core (raw XML string extraction). Writes back a revised EXIF IFD without re-encoding the image pixels, and strips all metadata segments for privacy-preserving image export. Includes a `ByteReader`/`ByteWriter` pair with rational arithmetic helpers and CRC-32 for PNG chunks. Use this package when you need to read camera metadata (make, model, GPS coordinates, orientation, focal length), watermark images with IPTC copyright fields, or scrub location data before publishing user-uploaded photos. For audio file metadata (ID3, MP4 atoms, FLAC Vorbis) use `@suaveplan/audio-metadata`.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/exif`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/exif";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/image/exif/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/image/exif/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/image/exif/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
name: feature-flags
|
||||
description: Use when implementing or debugging code that uses @suaveplan/feature-flags: Provider-agnostic feature flag evaluation with typed flag values, strategy chains, and deterministic bucketing.
|
||||
---
|
||||
|
||||
# @suaveplan/feature-flags
|
||||
|
||||
Provider-agnostic feature flag evaluation engine for controlling feature rollout without code deploys. The package ships a `FlagManager` high-level façade, a `FlagRegistry` backed by any pluggable `FlagProvider`, and an `Evaluator` strategy chain. Five composable strategies cover the full rollout playbook: `PercentageStrategy` (deterministic FNV-1a bucketing for consistent user cohorts), `UserTargetStrategy` (allowlist), `AttributeStrategy` (10 comparison operators for segment targeting), `ScheduleStrategy` (time-window gating), and `CompositeStrategy` (AND/OR combinator). Built-in providers include `MemoryProvider` and `JsonProvider` for file-based flag definitions. Evaluation priority is: flag disabled → in-process override → first matching strategy → default value. This package is for runtime flag evaluation only — it is not a flag management UI or remote config service.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/feature-flags`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/feature-flags";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/logger`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/platform/feature-flags/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/platform/feature-flags/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/platform/feature-flags/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/logger`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: font-compress
|
||||
description: Use when implementing or debugging code that uses @suaveplan/font-compress: BTF (Binary TypeFace) binary packing and unpacking.
|
||||
---
|
||||
|
||||
# @suaveplan/font-compress
|
||||
|
||||
BTF (Binary TypeFace) binary packing and unpacking. Converts `TypefaceFont` (typeface.js JSON format) to a compact `Uint8Array` using dictionary-based integer compression, and reverses it.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/font-compress`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/font-compress";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/font-convert`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/fonts/font-compress/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/fonts/font-compress/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/fonts/font-compress/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/font-convert`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: font-convert
|
||||
description: Use when implementing or debugging code that uses @suaveplan/font-convert: Convert TTF/OTF/WOFF/WOFF2 font files to typeface.
|
||||
---
|
||||
|
||||
# @suaveplan/font-convert
|
||||
|
||||
Converts TTF/OTF/WOFF/WOFF2 font files to the [typeface.js](https://gero3.github.io/facetype.js/) JSON format used by [Three.js `FontLoader`](https://threejs.org/docs/#examples/en/loaders/FontLoader). Also defines the canonical `TypefaceFont`, `TypefaceGlyph`, and `PathCommand` types consumed by `@suaveplan/font-compress`.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/font-convert`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/font-convert";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/fonts/font-convert/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/fonts/font-convert/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/fonts/font-convert/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: font-subset
|
||||
description: Use when implementing or debugging code that uses @suaveplan/font-subset: Font subsetting pipeline: Unicode range subsetting, WOFF2/WOFF encoding, TTF-to-OTF normalisation, feature tag filtering, hinting strip, metadata strip.
|
||||
---
|
||||
|
||||
# @suaveplan/font-subset
|
||||
|
||||
Font subsetting and compression library with a codec-agnostic adapter interface. Supports Unicode range subsetting, WOFF2/WOFF/OTF/TTF output, OpenType feature filtering, hinting strip, and metadata strip. Adapter implementations supply the actual codec; this package provides the orchestration, validation, format detection, and OTel instrumentation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/font-subset`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/font-subset";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/mime`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/fonts/font-subset/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/fonts/font-subset/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/fonts/font-subset/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/mime`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: fsm
|
||||
description: Use when implementing or debugging code that uses @suaveplan/fsm: Typed finite state machine with guards, actions, history tracking, hierarchical states, parallel regions, deferred events, and OTel instrumentation.
|
||||
---
|
||||
|
||||
# @suaveplan/fsm
|
||||
|
||||
Typed, generic finite state machine (FSM) for TypeScript. Ships a synchronous-by-default interpreter with guard predicates, ordered transition actions, context threading, entry/exit lifecycle hooks, history recording, and OTel instrumentation. Zero peer dependencies beyond `@suaveplan/error`, `@suaveplan/events`, and `@suaveplan/types`.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/fsm`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/fsm";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/fsm/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/fsm/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/fsm/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: i18n
|
||||
description: Use when implementing or debugging code that uses @suaveplan/i18n: Internationalization core: message catalog, ICU-like interpolation, pluralization, locale resolution, middleware, date/currency formatting.
|
||||
---
|
||||
|
||||
# @suaveplan/i18n
|
||||
|
||||
Enterprise-grade internationalization (i18n) core for Suaveplan. Works in Bun, Node.js, and modern browsers — zero DOM dependencies, tree-shakeable subpath exports. The package covers the full i18n surface: a namespaced `MessageCatalog` with lazy loaders and missing-key hooks; an `InterpolationEngine` with `{{ variable }}` and HTML-escape support; a `PluralizationEngine` with 14 language rules (including Arabic, Russian, and Celtic forms); an ICU-lite AST message parser for plural/select nodes; a `LocaleResolver` with BCP-47 normalisation, RTL detection, and fallback chains; server-side locale middleware; and `Intl`-backed date and currency formatters. Do not confuse with `@suaveplan/templates`, which handles string interpolation in non-i18n contexts — this package is specifically for locale-keyed message catalogs and locale-sensitive formatting.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/i18n`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/i18n";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/i18n/i18n/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/i18n/i18n/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/i18n/i18n/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: idempotency
|
||||
description: Use when implementing or debugging code that uses @suaveplan/idempotency: Idempotency key guard and dedup: store adapters (memory, database, redis), distributed locking, middleware, key generation, metrics, OTel instrumentation.
|
||||
---
|
||||
|
||||
# @suaveplan/idempotency
|
||||
|
||||
Idempotency key guard and deduplication for async operations. The package provides a complete `pending → completed | failed` state machine, three store backends (memory, database, Redis), distributed locking across multiple processes, request middleware, key generation with payload fingerprinting, version history management, and OTel metrics instrumentation. It is designed to protect any operation that must not execute more than once per request — payment charges, email sends, record creation — regardless of retries or race conditions.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/idempotency`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/idempotency";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/idempotency/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/idempotency/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/idempotency/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: json
|
||||
description: Use when implementing or debugging code that uses @suaveplan/json: Safe JSON parse/stringify with prototype-pollution protection, circular-ref detection, and OTel instrumentation.
|
||||
---
|
||||
|
||||
# @suaveplan/json
|
||||
|
||||
Safe, enterprise-grade JSON utilities with prototype-pollution protection, circular-reference detection, and OpenTelemetry instrumentation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/json`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/json";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/json/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/json/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/json/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: jwt-tenant
|
||||
description: Use when implementing or debugging code that uses @suaveplan/jwt-tenant: JWT-based multi-tenant token issuance and verification with Ed25519/ECDSA signing, JWKS rotation, and injectable clock.
|
||||
---
|
||||
|
||||
# @suaveplan/jwt-tenant
|
||||
|
||||
JWT-based multi-tenant token issuance and verification with Ed25519/ECDSA signing, JWKS rotation, and injectable clock
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/jwt-tenant`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/jwt-tenant";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/retry`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/auth/jwt-tenant/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/auth/jwt-tenant/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/auth/jwt-tenant/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/retry`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: locale-data
|
||||
description: Use when implementing or debugging code that uses @suaveplan/locale-data: Static ISO 3166-1 country data and ISO 639-1 language data with typed lookup functions, OTel instrumentation, and Zod schemas.
|
||||
---
|
||||
|
||||
# @suaveplan/locale-data
|
||||
|
||||
Static ISO 3166-1 country data and ISO 639-1 language data with typed lookup functions, OTel instrumentation, and Zod schemas.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/locale-data`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/locale-data";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/i18n/locale-data/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/i18n/locale-data/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/i18n/locale-data/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: logger
|
||||
description: Use when implementing or debugging code that uses @suaveplan/logger: Foundation logging package — structured JSON output, level filtering, redaction, sampling, OTel correlation, and pluggable sinks.
|
||||
---
|
||||
|
||||
# @suaveplan/logger
|
||||
|
||||
Enterprise-grade structured logger for Suaveplan. Provides a full pipeline: level filtering → OTel trace enrichment → sampling → redaction → sinks. Supports multiple output strategies (console, JSON/NDJSON, event bus, storage) with buffering and backpressure.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/logger`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/logger";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/platform/logger/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/platform/logger/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/platform/logger/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,781 @@
|
||||
{
|
||||
"schemaVersion": 1,
|
||||
"skills": [
|
||||
{
|
||||
"id": "ab-testing",
|
||||
"version": "0.1.0",
|
||||
"dir": "ab-testing",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "api-schemas",
|
||||
"version": "0.1.0",
|
||||
"dir": "api-schemas",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "audit-logging",
|
||||
"version": "0.1.0",
|
||||
"dir": "audit-logging",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "auth",
|
||||
"version": "0.1.0",
|
||||
"dir": "auth",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "barcode",
|
||||
"version": "0.1.0",
|
||||
"dir": "barcode",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "bitpacker",
|
||||
"version": "0.1.0",
|
||||
"dir": "bitpacker",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "bytes",
|
||||
"version": "0.1.0",
|
||||
"dir": "bytes",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "cache",
|
||||
"version": "0.1.0",
|
||||
"dir": "cache",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "cli",
|
||||
"version": "0.1.0",
|
||||
"dir": "cli",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "compress-image",
|
||||
"version": "0.1.0",
|
||||
"dir": "compress-image",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "compress-svg",
|
||||
"version": "0.1.0",
|
||||
"dir": "compress-svg",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "config",
|
||||
"version": "0.1.0",
|
||||
"dir": "config",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "crdt",
|
||||
"version": "0.1.0",
|
||||
"dir": "crdt",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "crypto",
|
||||
"version": "0.1.0",
|
||||
"dir": "crypto",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "crypto-browser",
|
||||
"version": "0.1.0",
|
||||
"dir": "crypto-browser",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "crypto-cipher",
|
||||
"version": "0.1.0",
|
||||
"dir": "crypto-cipher",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "crypto-curve",
|
||||
"version": "0.1.0",
|
||||
"dir": "crypto-curve",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "crypto-hash",
|
||||
"version": "0.1.0",
|
||||
"dir": "crypto-hash",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "crypto-keys",
|
||||
"version": "0.1.0",
|
||||
"dir": "crypto-keys",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "crypto-sodium",
|
||||
"version": "0.1.0",
|
||||
"dir": "crypto-sodium",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "crypto-utils",
|
||||
"version": "0.1.0",
|
||||
"dir": "crypto-utils",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "crypto-vault",
|
||||
"version": "0.1.0",
|
||||
"dir": "crypto-vault",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "data-masking",
|
||||
"version": "0.1.0",
|
||||
"dir": "data-masking",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "datetime",
|
||||
"version": "0.1.0",
|
||||
"dir": "datetime",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "db",
|
||||
"version": "0.1.0",
|
||||
"dir": "db",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "db-sqlite",
|
||||
"version": "0.1.0",
|
||||
"dir": "db-sqlite",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "dedup",
|
||||
"version": "0.1.0",
|
||||
"dir": "dedup",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "diff",
|
||||
"version": "0.1.0",
|
||||
"dir": "diff",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "dmarc",
|
||||
"version": "0.1.0",
|
||||
"dir": "dmarc",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "domain-normalizer",
|
||||
"version": "0.1.0",
|
||||
"dir": "domain-normalizer",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "env",
|
||||
"version": "0.1.0",
|
||||
"dir": "env",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "error",
|
||||
"version": "0.1.0",
|
||||
"dir": "error",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "etl",
|
||||
"version": "0.1.0",
|
||||
"dir": "etl",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "event-sourcing",
|
||||
"version": "0.1.0",
|
||||
"dir": "event-sourcing",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "events",
|
||||
"version": "0.1.0",
|
||||
"dir": "events",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "events-metrics",
|
||||
"version": "0.1.0",
|
||||
"dir": "events-metrics",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "events-otel",
|
||||
"version": "0.1.0",
|
||||
"dir": "events-otel",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "events-schema",
|
||||
"version": "0.1.0",
|
||||
"dir": "events-schema",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "events-transport",
|
||||
"version": "0.1.0",
|
||||
"dir": "events-transport",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "exif",
|
||||
"version": "0.1.0",
|
||||
"dir": "exif",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "feature-flags",
|
||||
"version": "0.1.0",
|
||||
"dir": "feature-flags",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "font-compress",
|
||||
"version": "0.1.0",
|
||||
"dir": "font-compress",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "font-convert",
|
||||
"version": "0.1.0",
|
||||
"dir": "font-convert",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "font-subset",
|
||||
"version": "0.1.0",
|
||||
"dir": "font-subset",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "fsm",
|
||||
"version": "0.1.0",
|
||||
"dir": "fsm",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "i18n",
|
||||
"version": "0.1.0",
|
||||
"dir": "i18n",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "idempotency",
|
||||
"version": "0.1.0",
|
||||
"dir": "idempotency",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "json",
|
||||
"version": "0.1.0",
|
||||
"dir": "json",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "jwt-tenant",
|
||||
"version": "0.1.0",
|
||||
"dir": "jwt-tenant",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "locale-data",
|
||||
"version": "0.1.0",
|
||||
"dir": "locale-data",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "logger",
|
||||
"version": "0.1.0",
|
||||
"dir": "logger",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "metadata",
|
||||
"version": "0.1.0",
|
||||
"dir": "metadata",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "migration",
|
||||
"version": "0.1.0",
|
||||
"dir": "migration",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "mime",
|
||||
"version": "0.1.0",
|
||||
"dir": "mime",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "noise",
|
||||
"version": "0.1.0",
|
||||
"dir": "noise",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "oauth-client",
|
||||
"version": "0.1.0",
|
||||
"dir": "oauth-client",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "opentelemetry",
|
||||
"version": "0.1.0",
|
||||
"dir": "opentelemetry",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "pagination",
|
||||
"version": "0.1.0",
|
||||
"dir": "pagination",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "password-formats",
|
||||
"version": "0.1.0",
|
||||
"dir": "password-formats",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "permissions",
|
||||
"version": "0.1.0",
|
||||
"dir": "permissions",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "pick-plugins",
|
||||
"version": "0.1.0",
|
||||
"dir": "pick-plugins",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "pseudo-random",
|
||||
"version": "0.1.0",
|
||||
"dir": "pseudo-random",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "qrcode",
|
||||
"version": "0.1.0",
|
||||
"dir": "qrcode",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "queue",
|
||||
"version": "0.1.0",
|
||||
"dir": "queue",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "random",
|
||||
"version": "0.1.0",
|
||||
"dir": "random",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "rate-limiter",
|
||||
"version": "0.1.0",
|
||||
"dir": "rate-limiter",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "readline",
|
||||
"version": "0.1.0",
|
||||
"dir": "readline",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "retry",
|
||||
"version": "0.1.0",
|
||||
"dir": "retry",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "schema-registry",
|
||||
"version": "0.1.0",
|
||||
"dir": "schema-registry",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "search",
|
||||
"version": "0.1.0",
|
||||
"dir": "search",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "security-codes",
|
||||
"version": "0.1.0",
|
||||
"dir": "security-codes",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "serialize",
|
||||
"version": "0.1.0",
|
||||
"dir": "serialize",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "sitemap",
|
||||
"version": "0.1.0",
|
||||
"dir": "sitemap",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "slsa",
|
||||
"version": "0.1.0",
|
||||
"dir": "slsa",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "storage",
|
||||
"version": "0.1.0",
|
||||
"dir": "storage",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "storage-s3",
|
||||
"version": "0.1.0",
|
||||
"dir": "storage-s3",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "streams",
|
||||
"version": "0.1.0",
|
||||
"dir": "streams",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "suppression",
|
||||
"version": "0.1.0",
|
||||
"dir": "suppression",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "surrealdb",
|
||||
"version": "0.1.0",
|
||||
"dir": "surrealdb",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "templates",
|
||||
"version": "0.1.0",
|
||||
"dir": "templates",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "testing",
|
||||
"version": "0.1.0",
|
||||
"dir": "testing",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "testing-dom",
|
||||
"version": "0.1.0",
|
||||
"dir": "testing-dom",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "testing-e2e",
|
||||
"version": "0.1.0",
|
||||
"dir": "testing-e2e",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "testing-integration",
|
||||
"version": "0.1.0",
|
||||
"dir": "testing-integration",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "testing-integration-garage-s3",
|
||||
"version": "0.1.0",
|
||||
"dir": "testing-integration-garage-s3",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "testing-integration-mailpit",
|
||||
"version": "0.1.0",
|
||||
"dir": "testing-integration-mailpit",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "testing-integration-postgres",
|
||||
"version": "0.1.0",
|
||||
"dir": "testing-integration-postgres",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "testing-integration-redis",
|
||||
"version": "0.1.0",
|
||||
"dir": "testing-integration-redis",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "testing-integration-surrealdb",
|
||||
"version": "0.1.0",
|
||||
"dir": "testing-integration-surrealdb",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "testing-integration-typesense",
|
||||
"version": "0.1.0",
|
||||
"dir": "testing-integration-typesense",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "timing",
|
||||
"version": "0.1.0",
|
||||
"dir": "timing",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "types",
|
||||
"version": "0.1.0",
|
||||
"dir": "types",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "typescript-config",
|
||||
"version": "0.1.0",
|
||||
"dir": "typescript-config",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "undo",
|
||||
"version": "0.1.0",
|
||||
"dir": "undo",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "utils",
|
||||
"version": "0.1.0",
|
||||
"dir": "utils",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "validation",
|
||||
"version": "0.1.0",
|
||||
"dir": "validation",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "webhook-client",
|
||||
"version": "0.1.0",
|
||||
"dir": "webhook-client",
|
||||
"files": [
|
||||
"SKILL.md"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: metadata
|
||||
description: Use when implementing or debugging code that uses @suaveplan/audio-metadata: Universal audio metadata extractor: parses ID3v1/v2, MP4/M4A atoms, FLAC Vorbis comments, Ogg, WAV, AIFF, and returns a normalised Track record.
|
||||
---
|
||||
|
||||
# @suaveplan/audio-metadata
|
||||
|
||||
Universal audio metadata extractor that parses ID3v1/v2, MP4/M4A atoms, FLAC Vorbis comments, Ogg Vorbis, WAV RIFF, and AIFF/AIFC containers, returning a normalised `Track` record. Works in both Node.js and browser environments — zero native dependencies.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/audio-metadata`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/audio-metadata";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/audio/metadata/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/audio/metadata/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/audio/metadata/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
name: migration
|
||||
description: Use when implementing or debugging code that uses @suaveplan/migration: Database-agnostic migration runner with ledger tracking, dry-run, checksums, lock adapters, and OTel instrumentation.
|
||||
---
|
||||
|
||||
# @suaveplan/migration
|
||||
|
||||
Database-agnostic schema migration runner with ledger tracking, checksum validation, dry-run reporting, distributed locking, event bus integration, and OTel instrumentation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/migration`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/migration";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/db`, `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/logger`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/database/migration/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/database/migration/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/database/migration/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/db`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/logger`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: mime
|
||||
description: Use when implementing or debugging code that uses @suaveplan/mime: Structured MIME-type detection, parsing, and registry: magic-byte sniffing, RFC 7231 Content-Type parsing, IANA-sourced type database.
|
||||
---
|
||||
|
||||
# @suaveplan/mime
|
||||
|
||||
Structured MIME-type detection, parsing, and registry for the Suaveplan platform. Provides RFC 7231 Content-Type parsing, magic-byte file signature detection, charset sniffing, and a 150+ entry IANA-sourced type database — all in a zero-dependency, tree-shakeable package.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/mime`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/mime";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/mime/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/mime/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/mime/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: noise
|
||||
description: Use when implementing or debugging code that uses @suaveplan/noise: Seeded spatial noise fields: Perlin, Simplex, Value, Worley, fBm and Blue-noise sampling for procedural generation.
|
||||
---
|
||||
|
||||
# @suaveplan/noise
|
||||
|
||||
Seeded spatial noise fields for procedural content generation. Provides six field types — Perlin, Simplex (2D/3D/4D), Value, Worley/cellular (F1/F2/F2-F1 modes), fBm (fractal Brownian motion compositor), and Poisson-disk Blue noise sampling — all seeded with `Sfc32Rng` for byte-identical, reproducible output. Every generator is available as both a functional API and a stateful class. Use this package for terrain heightmaps, texture generation, cloud simulation, vegetation scattering, and any procedural system that needs spatially-coherent randomness. For non-spatial random values (UUIDs, shuffles, distributions) use `@suaveplan/random`; for seeded integer/float sequences use `@suaveplan/pseudo-random`.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/noise`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/noise";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/pseudo-random`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/noise/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/noise/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/noise/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/pseudo-random`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: oauth-client
|
||||
description: Use when implementing or debugging code that uses @suaveplan/oauth-client: Universal OAuth 2.
|
||||
---
|
||||
|
||||
# @suaveplan/oauth-client
|
||||
|
||||
Universal OAuth 2.0 / OIDC client for Node.js, browsers, Bun, Deno, and edge runtimes.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/oauth-client`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/oauth-client";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/auth/oauth-client/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/auth/oauth-client/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/auth/oauth-client/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: opentelemetry
|
||||
description: Use when implementing or debugging code that uses @suaveplan/opentelemetry: OpenTelemetry SDK setup and configuration helpers: tracer/meter/logger providers, resource detection, exporter configuration, and sampling strategies.
|
||||
---
|
||||
|
||||
# @suaveplan/opentelemetry
|
||||
|
||||
OpenTelemetry SDK setup and configuration helpers for Suaveplan. Provides batteries-included OTel initialization helpers, resource detection, ergonomic span/metrics wrappers, W3C trace-context propagation utilities, and a no-op SDK façade that works without any heavyweight `@opentelemetry/sdk-*` packages.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/opentelemetry`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/opentelemetry";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/platform/opentelemetry/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/platform/opentelemetry/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/platform/opentelemetry/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: pagination
|
||||
description: Use when implementing or debugging code that uses @suaveplan/pagination: Universal pagination primitives: cursor, offset, keyset strategies with adapters, iterators, and type-safe request/response shapes.
|
||||
---
|
||||
|
||||
# @suaveplan/pagination
|
||||
|
||||
Universal pagination primitives for cursor-based, offset-based, and keyset-based (seek) pagination strategies. The package covers the full pagination surface: request normalisation, response envelope construction, opaque cursor and page-token encoding, async iterators that drain pages automatically, a pluggable adapter interface for any data source, and optional OpenTelemetry instrumentation. All three strategies share the same error hierarchy and Zod schemas so they compose cleanly in multi-strategy APIs.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/pagination`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/pagination";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/pagination/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/pagination/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/pagination/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: password-formats
|
||||
description: Use when implementing or debugging code that uses @suaveplan/password-formats: Universal import/export layer for common password-manager export formats — Apple Passwords CSV, Bitwarden JSON, Chrome CSV, KeePass XML.
|
||||
---
|
||||
|
||||
# @suaveplan/password-formats
|
||||
|
||||
Universal import/export layer for common password-manager export formats. Parses Apple Passwords CSV, Bitwarden JSON, Chrome CSV, and KeePass XML into a normalized `PasswordEntry[]` array, and exports back to a universal CSV format.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/password-formats`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/password-formats";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/crypto/password-formats/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/crypto/password-formats/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/crypto/password-formats/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: permissions
|
||||
description: Use when implementing or debugging code that uses @suaveplan/permissions: Full RBAC/ABAC permissions engine: Ability/AbilityBuilder, RoleManager, PolicyEngine, PermissionCache, conditions, and pluggable storage adapters.
|
||||
---
|
||||
|
||||
# @suaveplan/permissions
|
||||
|
||||
Full RBAC/ABAC permissions engine for Suaveplan. Ships role management, policy evaluation, CASL-inspired ability builder, TTL permission cache, condition evaluation, and framework-agnostic middleware.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/permissions`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/permissions";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/auth/permissions/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/auth/permissions/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/auth/permissions/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,93 @@
|
||||
---
|
||||
name: pick-plugins
|
||||
description: Use when starting a new project, scaffolding a Suaveplan-based codebase, or asking "which plugins do I need". Interrogates the user's use case (password manager, multiplayer game, SaaS, logistics, P2P app, email platform, DMX, astronomy, API service, CLI), matches it to a project archetype, and outputs the recommended `suaveplan-*` plugin install commands plus a build-order hint.
|
||||
---
|
||||
|
||||
# Pick the right Suaveplan plugins for your project
|
||||
|
||||
The Suaveplan marketplace ships ~50 plugins covering everything from cryptographic primitives to 3D game physics. Most projects need 10–20 of them, not all 50. This skill asks what you're building, matches it against the archetype recipes in `data/archetypes.yml`, and produces a curated install list.
|
||||
|
||||
## When to invoke
|
||||
|
||||
- User says "I want to build X" and X involves the Suaveplan stack.
|
||||
- User asks "which plugins do I need for Y".
|
||||
- User is scaffolding a new app, service, or game.
|
||||
- After installing the marketplace and before installing individual plugins.
|
||||
|
||||
## Fast path: deterministic CLI matcher
|
||||
|
||||
If the marketplace repo is checked out locally, prefer running the matcher and presenting its output verbatim:
|
||||
|
||||
```bash
|
||||
bun /path/to/suaveplan-skills/scripts/match-archetype.ts "<the user's description>"
|
||||
# JSON form (if you want to compose with other tools):
|
||||
bun /path/to/suaveplan-skills/scripts/match-archetype.ts --json "<...>"
|
||||
```
|
||||
|
||||
The matcher implements the algorithm in this skill. If the user says "I'm building a password manager", running it returns the password-manager archetype with its install commands ready to paste. Use the output directly; do not re-derive.
|
||||
|
||||
If the matcher is not available (the user hasn't cloned the marketplace repo, or only has the plugin installed), fall back to the manual procedure below.
|
||||
|
||||
## Manual procedure
|
||||
|
||||
1. **Read** `data/archetypes.yml` (sibling of this file via `${CLAUDE_PLUGIN_ROOT}/data/archetypes.yml`).
|
||||
2. **Ask the user** in one short turn: "What are you building?" Give them the archetype names from the YAML as a menu but accept free text.
|
||||
3. **Match** the user's answer to one or more archetypes:
|
||||
- Free text matches via the `signals` field of each archetype (case-insensitive substring match on any signal phrase).
|
||||
- Menu pick matches by archetype key directly.
|
||||
- If multiple archetypes match (e.g. "SaaS with email marketing"), union the `core` lists.
|
||||
4. **Output** in this exact order:
|
||||
- **Recommended plugins** — bulleted list of `suaveplan-<plugin>` for every plugin in `core`, with the plugin's marketplace description.
|
||||
- **Optional extras** — bulleted list from `optional`, prefixed with "consider if:" hint where the YAML's `notes` field calls them out.
|
||||
- **Install commands** — a copy-pastable block:
|
||||
|
||||
```text
|
||||
/plugin install suaveplan-<core-1>@suaveplan
|
||||
/plugin install suaveplan-<core-2>@suaveplan
|
||||
...
|
||||
```
|
||||
|
||||
- **Notes** — verbatim from the archetype's `notes` field, if present.
|
||||
- **Build order hint** — order the plugins by dependency layer (foundation → observability → primitives → domain plugins → UI/api → dev). The order in `core` lists is already roughly correct; preserve it.
|
||||
5. **Offer to refine**: "Anything in this list you don't need?" / "Anything missing? Tell me more about the project."
|
||||
|
||||
## Matching rules
|
||||
|
||||
- **Free text → archetype**: lowercase the user's answer, lowercase each signal, substring match. Sum match counts per archetype; pick the highest. Tie → ask the user to disambiguate.
|
||||
- **No match**: don't guess. Say "I don't have an archetype for that yet — tell me what categories your project touches (auth, data, network, UI, gaming, payment, comms, media, geo, dev) and I'll assemble a plugin set from those."
|
||||
- **Multi-archetype**: if signals from two archetypes both match strongly (≥2 each), confirm with the user before unioning.
|
||||
|
||||
## What this skill does NOT do
|
||||
|
||||
- It does not run `/plugin install` for the user. It produces the commands; the user executes them.
|
||||
- It does not read the user's existing codebase. If the user has an existing project, ask them to describe it rather than scanning files.
|
||||
- It does not modify `data/archetypes.yml`. New archetypes are added by editing the YAML in this plugin and committing.
|
||||
|
||||
## Example interaction
|
||||
|
||||
> **User:** I'm building a password manager
|
||||
>
|
||||
> **You:** That matches the **password-manager** archetype. You'll want these plugins:
|
||||
>
|
||||
> - `suaveplan-foundation` — error hierarchy, types, tsconfig
|
||||
> - `suaveplan-crypto` — hash, curve, cipher, AEAD, signing
|
||||
> - `suaveplan-vaulted` — SRP, OTP, WebAuthn, vault orchestration
|
||||
> - `suaveplan-drive` — encrypted file attachments
|
||||
> - … (full list)
|
||||
>
|
||||
> ```
|
||||
> /plugin install suaveplan-foundation@suaveplan
|
||||
> /plugin install suaveplan-crypto@suaveplan
|
||||
> /plugin install suaveplan-vaulted@suaveplan
|
||||
> ...
|
||||
> ```
|
||||
>
|
||||
> **Notes from the recipe:** `vaulted` depends on `crypto` — install both. `drive` carries encrypted file attachments and sharing.
|
||||
>
|
||||
> Anything you'd like to drop or add?
|
||||
|
||||
## Reference
|
||||
|
||||
- `data/archetypes.yml` — recipe data
|
||||
- `../../README.md` (marketplace root) — how to add the marketplace and install plugins
|
||||
- `docs/design/folder-reorg-by-domain/proposal.md` — full plugin → package mapping
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: pseudo-random
|
||||
description: Use when implementing or debugging code that uses @suaveplan/pseudo-random: Deterministic seeded PRNG implementations (Mulberry32, SFC32, Xoshiro256++, CounterRng) with offset/fork/checkpoint/restore semantics.
|
||||
---
|
||||
|
||||
# @suaveplan/pseudo-random
|
||||
|
||||
Deterministic, seeded pseudo-random number generators (PRNGs) conforming to the `Rng` interface from `@suaveplan/types`. Ships four algorithms — Mulberry32, SFC32, Xoshiro256++, and CounterRng — with a unified `SeededRng` surface that includes `nextUint32`, `nextFloat`, `skip`, `at`, `fork`, `checkpoint`, and `restore`. Use this package when you need reproducible randomness (procedural generation, game simulations, property tests) or seek O(1) access to arbitrary positions in the sequence. For cryptographically secure randomness use `@suaveplan/random` (CSPRNG-backed) or `@suaveplan/crypto` (raw bytes). Utility functions `shuffle`, `sample`, `choice`, and `weightedChoice` accept any `Rng` and work with both seeded and crypto-backed sources.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/pseudo-random`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/pseudo-random";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/pseudo-random/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/pseudo-random/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/pseudo-random/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: qrcode
|
||||
description: Use when implementing or debugging code that uses @suaveplan/qrcode: QR code generation producing SVG, pixel matrix, terminal (Unicode blocks), and data URL representations.
|
||||
---
|
||||
|
||||
# @suaveplan/qrcode
|
||||
|
||||
QR code generation producing SVG, pixel matrix, terminal (Unicode blocks), and data URL representations. Implements QR code versions 1-10, error correction levels L/M/Q/H, automatic version and mode selection.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/qrcode`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/qrcode";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/qrcode/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/qrcode/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/qrcode/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: queue
|
||||
description: Use when implementing or debugging code that uses @suaveplan/queue: Enterprise-grade queue management: memory/priority/delayed queues, concurrent workers with retry and dead-letter, job state machines, OTel instrumentation.
|
||||
---
|
||||
|
||||
# @suaveplan/queue
|
||||
|
||||
Enterprise-grade queue management: memory/priority/delayed queues, concurrent workers with retry and dead-letter forwarding, job state machines, and OTel instrumentation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/queue`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/queue";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/jobs/queue/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/jobs/queue/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/jobs/queue/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: random
|
||||
description: Use when implementing or debugging code that uses @suaveplan/random: High-level CSPRNG-backed randomness: strings, UUID/ULID/Nanoid, collections, objects, game primitives, and a full statistical-distribution suite.
|
||||
---
|
||||
|
||||
# @suaveplan/random
|
||||
|
||||
High-level cryptographically secure randomness for application use. This is the everyday random package — it wraps the CSPRNG with ergonomic helpers for every common randomness task: unique IDs (`randomUUID` v4, `randomUUIDv7`, `randomULID`, `randomNanoid`), random strings with eight charset presets, collection utilities (`shuffle`, `choice`, `sample`, `weightedChoice`), object utilities (`randomKey`, `randomEntry`, `randomSubset`), game primitives (`coin`, `dice`, `roll`), and a full suite of continuous and discrete statistical distributions (Normal, LogNormal, Binomial, Poisson, and eight more). Every function accepts an optional `rng?: Rng` — omit it for crypto-backed defaults, or pass a `SeededRng` from `@suaveplan/pseudo-random` for deterministic tests. Do not confuse with `@suaveplan/pseudo-random` (seeded, deterministic, for procedural generation) or `@suaveplan/crypto` (raw cryptographic byte generation).
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/random`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/random";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/pseudo-random`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/random/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/random/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/random/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/pseudo-random`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
name: rate-limiter
|
||||
description: Use when implementing or debugging code that uses @suaveplan/rate-limiter: Enterprise rate limiter: TokenBucket, SlidingWindow, FixedWindow algorithms; tenant multipliers; rule-based routing; pluggable storage; OTel instrumentation.
|
||||
---
|
||||
|
||||
# @suaveplan/rate-limiter
|
||||
|
||||
Enterprise rate limiter with three algorithms, rule-based routing, tenant multipliers, pluggable storage, and OTel instrumentation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/rate-limiter`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/rate-limiter";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/logger`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/platform/rate-limiter/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/platform/rate-limiter/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/platform/rate-limiter/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/logger`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: readline
|
||||
description: Use when implementing or debugging code that uses @suaveplan/readline: Terminal I/O primitive: AsyncGenerator line reader and interactive prompt interface.
|
||||
---
|
||||
|
||||
# @suaveplan/readline
|
||||
|
||||
AsyncGenerator line reader and interactive prompt interface for Node.js streams, file paths, and Web Streams.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/readline`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/readline";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/readline/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/readline/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/readline/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: retry
|
||||
description: Use when implementing or debugging code that uses @suaveplan/retry: Retry strategies with exponential/linear/constant backoff, jitter, circuit breaker with half-open probing, sleep and timeout helpers.
|
||||
---
|
||||
|
||||
# @suaveplan/retry
|
||||
|
||||
Retry strategies and circuit-breaker for async operations. The package provides constant, linear, and exponential backoff with four jitter modes (full, equal, decorrelated, none), a `sleep` helper with AbortSignal support, a per-attempt `withTimeout` wrapper, and a three-state circuit breaker (closed → open → half-open) with event emission and configurable failure/success thresholds. All entry points accept an injectable `Clock` and `AbortSignal` so they integrate cleanly with test harnesses and request cancellation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/retry`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/retry";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/retry/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/retry/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/retry/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: schema-registry
|
||||
description: Use when implementing or debugging code that uses @suaveplan/schema-registry: Versioned schema registry with forward/backward compatibility checking for evolving data contracts.
|
||||
---
|
||||
|
||||
# @suaveplan/schema-registry
|
||||
|
||||
Versioned schema registry with forward/backward/full compatibility checking for evolving data contracts. Register schemas by subject name, enforce evolution rules, and detect breaking changes before they reach production.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/schema-registry`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/schema-registry";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/schema-registry/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/schema-registry/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/schema-registry/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: search
|
||||
description: Use when implementing or debugging code that uses @suaveplan/search: Full-text and fuzzy search primitives with in-memory BM25 engine, trigram fuzzy matching, faceted search, and pagination support.
|
||||
---
|
||||
|
||||
# @suaveplan/search
|
||||
|
||||
Full-text and fuzzy search primitives with in-memory BM25 engine, trigram fuzzy matching, faceted search, and pagination support.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/search`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/search";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/pagination`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/platform/search/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/platform/search/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/platform/search/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/pagination`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: security-codes
|
||||
description: Use when implementing or debugging code that uses @suaveplan/security-codes: Detect and sanitise sensitive security-code leakage in strings: API keys, JWTs, credit cards, GitHub tokens, Stripe keys, SSH keys, PEM blocks, AWS access keys, and more.
|
||||
---
|
||||
|
||||
# @suaveplan/security-codes
|
||||
|
||||
Detect and sanitise sensitive security-code leakage in strings. Handles API keys, JWTs, credit cards, GitHub tokens, Stripe keys, SSH keys, PEM blocks, AWS access keys, OpenAI keys, Google API keys, and high-entropy heuristics.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/security-codes`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/security-codes";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/platform/security-codes/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/platform/security-codes/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/platform/security-codes/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: serialize
|
||||
description: Use when implementing or debugging code that uses @suaveplan/serialize: Round-trip-preserving structured serialization — tagged JSON, MessagePack binary, streaming, eval-safe by default.
|
||||
---
|
||||
|
||||
# @suaveplan/serialize
|
||||
|
||||
Round-trip-preserving structured serialization for JavaScript's rich type system. The standard `JSON.stringify`/`JSON.parse` pair silently drops `Date` objects, `Map`, `Set`, `BigInt`, `Uint8Array`, `URL`, `RegExp`, `undefined`, `NaN`, and `±Infinity`. This package preserves all of them via a tagged-JSON codec (`serialize`/`deserialize`) and an efficient MessagePack binary codec (`encodeBinary`/`decodeBinary`). It also provides 4-byte-framed streaming codecs for `ReadableStream` pipelines, cycle detection with path context, a pluggable type registry for custom classes, and an opt-in `/unsafe` subpath that handles `Function`-bearing payloads. The default entry point is eval-safe. Use `@suaveplan/serialize` whenever you need to serialise application state across process boundaries, persist structured data, or stream binary payloads — and want to get back exactly what you put in.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/serialize`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/serialize";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/serialize/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/serialize/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/serialize/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: sitemap
|
||||
description: Use when implementing or debugging code that uses @suaveplan/sitemap: Sitemap generation and parsing: sitemap.
|
||||
---
|
||||
|
||||
# @suaveplan/sitemap
|
||||
|
||||
Sitemap generation and parsing for the sitemaps.org XML protocol. Produces valid `sitemap.xml`, sitemap index documents, and parses existing sitemaps. Supports Google image and video extensions as well as hreflang alternate links.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/sitemap`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/sitemap";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/api/sitemap/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/api/sitemap/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/api/sitemap/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
name: slsa
|
||||
description: Use when implementing or debugging code that uses @suaveplan/slsa: SLSA L1-L2 supply-chain security: provenance, SBOM, DSSE attestations, Sigstore Rekor transparency-log client, policy evaluation, OTel audit events.
|
||||
---
|
||||
|
||||
# @suaveplan/slsa
|
||||
|
||||
SLSA L1-L2 supply-chain security for Suaveplan. Generates and verifies in-toto / SLSA v1.0 provenance, CycloneDX 1.5 SBOMs, DSSE attestation envelopes, and RFC 6962 Sigstore Rekor transparency-log proofs. Every capability emits structured OTel span events and raises typed `SlsaError` subclasses with stable error codes.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/slsa`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/slsa";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/crypto`, `@suaveplan/crypto-hash`, `@suaveplan/crypto-utils`, `@suaveplan/error`, `@suaveplan/serialize`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/crypto/slsa/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/crypto/slsa/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/crypto/slsa/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/crypto`
|
||||
- `@suaveplan/crypto-hash`
|
||||
- `@suaveplan/crypto-utils`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/serialize`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
name: storage-s3
|
||||
description: Use when implementing or debugging code that uses @suaveplan/storage-s3: S3-compatible object storage adapter for @suaveplan/storage: implements AbstractStorage backed by @aws-sdk/client-s3 with presigned URLs, multipart upload, retry integration, and OTel instrumentation.
|
||||
---
|
||||
|
||||
# @suaveplan/storage-s3
|
||||
|
||||
S3-compatible object storage adapter for `@suaveplan/storage`. Extends `AbstractStorage` backed by `@aws-sdk/client-s3` with presigned URL generation, multipart upload, retry integration, and OpenTelemetry instrumentation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/storage-s3`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/storage-s3";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/retry`, `@suaveplan/storage`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/storage/storage-s3/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/storage/storage-s3/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/storage/storage-s3/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/retry`
|
||||
- `@suaveplan/storage`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: storage
|
||||
description: Use when implementing or debugging code that uses @suaveplan/storage: Enterprise key-value storage abstractions: AbstractStorage (StorageLike + streaming + hooks + OTel), MemoryStorage (TTL, zero-copy streams), NamespacedStorage, StorageFactory with module-augmentation provider registry, structured STORAGE.
|
||||
---
|
||||
|
||||
# @suaveplan/storage
|
||||
|
||||
Enterprise key-value storage abstractions for Suaveplan. Provides `AbstractStorage` (implementing `StorageLike`), `MemoryStorage` with TTL and zero-copy streaming, `NamespacedStorage` with scoped operations, and `StorageFactory` with a module-augmentation provider registry.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/storage`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/storage";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/storage/storage/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/storage/storage/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/storage/storage/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: streams
|
||||
description: Use when implementing or debugging code that uses @suaveplan/streams: WHATWG-Streams-based primitives: backpressure-first transforms, zero-copy Uint8Array operations, AbortSignal integration, OTel instrumentation.
|
||||
---
|
||||
|
||||
# @suaveplan/streams
|
||||
|
||||
WHATWG-Streams-based primitives: backpressure-first transforms, zero-copy `Uint8Array` operations, `AbortSignal` integration end-to-end, structured errors, OTel instrumentation, and property-based invariant tests.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/streams`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/streams";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/streams/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/streams/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/streams/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: suppression
|
||||
description: Use when implementing or debugging code that uses @suaveplan/suppression: Email suppression list management: in-memory store, bulk import/export (CSV/JSON), domain-level suppression, and OTel instrumentation.
|
||||
---
|
||||
|
||||
# @suaveplan/suppression
|
||||
|
||||
Email suppression list management for Suaveplan. Stores and checks email addresses that should not receive outgoing mail — unsubscribes, hard/soft bounces, complaints, manual suppressions, and invalid addresses. Supports domain-level blocking, bulk CSV/JSON import and export, OTel instrumentation, and full serialisation round-trips.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/suppression`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/suppression";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/emails/suppression/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/emails/suppression/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/emails/suppression/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
name: surrealdb
|
||||
description: Use when implementing or debugging code that uses @suaveplan/surrealdb: Universal SurrealDB client wrapper implementing DatabaseAdapter: connection lifecycle, singleton registry, typed CRUD, schema discovery, initialisation, version detection, OTel instrumentation, retry integration, and structured SURREAL.
|
||||
---
|
||||
|
||||
# @suaveplan/surrealdb
|
||||
|
||||
Universal SurrealDB client wrapper for Suaveplan. Implements `@suaveplan/db`'s `DatabaseAdapter` interface with connection lifecycle management, typed CRUD, schema discovery, database initialisation, version detection, structured `SURREAL.*` error codes, and OTel instrumentation.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/surrealdb`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/surrealdb";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/db`, `@suaveplan/error`, `@suaveplan/retry`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/database/surrealdb/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/database/surrealdb/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/database/surrealdb/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/db`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/retry`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: templates
|
||||
description: Use when implementing or debugging code that uses @suaveplan/templates: Plugin-based template engine with type-safe contexts, variable interpolation, transform and control-flow plugins, and preset bundles.
|
||||
---
|
||||
|
||||
# @suaveplan/templates
|
||||
|
||||
A plugin-based string template engine for TypeScript. Resolves `{variable}` and `{variable:transform}` tokens in strings using a priority-sorted, regex-scan pipeline — no eval, no AST parser overhead. Designed for filling templates in notification messages, email subjects, file name patterns, code generation, and similar string-expansion tasks. Ships nine built-in plugins: dot-notation and array-index variable resolution; case, regex, and split transforms; counter, datetime, and UUID dynamic generators; and conditional/loop control flow. Three preset bundles (`minimal`, `standard`, `full`) let you trade features for bundle size. The injectable `Clock` and `Rng` make every rendering call deterministic in tests. Do not confuse with `@suaveplan/i18n`, which handles locale-keyed message catalogs and plural forms — use this package when your source strings are already in the target language and you only need token substitution.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/templates`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/templates";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/templates/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/templates/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/templates/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: testing-dom
|
||||
description: Use when implementing or debugging code that uses @suaveplan/testing-dom: DOM/React testing — vitest+bun-test conditional re-exports, createTestConfig, polyfills, render helpers, accessibility-first queries, jest-dom matchers, user-event v14.
|
||||
---
|
||||
|
||||
# @suaveplan/testing-dom
|
||||
|
||||
DOM and React component testing utilities for Suaveplan. Provides a single install that covers vitest config generation with WSL2-safe defaults, `@testing-library/react` render helpers, accessibility-first query aliases, `@testing-library/jest-dom` matchers, user-event v14 setup, and a dual-runner shim that routes between vitest and `bun:test` via package.json conditional exports.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/testing-dom`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/testing-dom";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/testing/testing-dom/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/testing/testing-dom/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/testing/testing-dom/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: testing-e2e
|
||||
description: Use when implementing or debugging code that uses @suaveplan/testing-e2e: Playwright E2E utilities — config factory, page objects, fixtures, helpers, structured errors.
|
||||
---
|
||||
|
||||
# @suaveplan/testing-e2e
|
||||
|
||||
Playwright E2E testing utilities for Suaveplan. Provides a config factory with WSL2/CI-safe defaults, an abstract `PageObject` base class, extended test fixtures (`apiContext`, `freshPage`), browser-context helpers (clipboard mock, geolocation mock, network-idle wait, screenshot-on-failure), and structured error types. The package has no `@suaveplan/*` runtime dependencies — it is a Layer 0 utility that anything in the stack can depend on without introducing cycles.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/testing-e2e`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/testing-e2e";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/testing/testing-e2e/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/testing/testing-e2e/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/testing/testing-e2e/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: testing-integration-garage-s3
|
||||
description: Use when implementing or debugging code that uses @suaveplan/testing-integration-garage-s3: Garage S3 v2.
|
||||
---
|
||||
|
||||
# @suaveplan/testing-integration-garage-s3
|
||||
|
||||
Garage S3 v2.0.0 testcontainers fixture for `@suaveplan/testing-integration`.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/testing-integration-garage-s3`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/testing-integration-garage-s3";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/testing-integration`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/testing/testing-integration-garage-s3/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/testing/testing-integration-garage-s3/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/testing/testing-integration-garage-s3/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/testing-integration`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: testing-integration-mailpit
|
||||
description: Use when implementing or debugging code that uses @suaveplan/testing-integration-mailpit: Mailpit testcontainers fixture + assertMail helper for @suaveplan/testing-integration.
|
||||
---
|
||||
|
||||
# @suaveplan/testing-integration-mailpit
|
||||
|
||||
Mailpit testcontainers fixture + `assertMail()` helper for `@suaveplan/testing-integration`.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/testing-integration-mailpit`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/testing-integration-mailpit";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/testing-integration`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/testing/testing-integration-mailpit/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/testing/testing-integration-mailpit/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/testing/testing-integration-mailpit/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/testing-integration`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: testing-integration-postgres
|
||||
description: Use when implementing or debugging code that uses @suaveplan/testing-integration-postgres: PostgreSQL 16 testcontainers fixture for @suaveplan/testing-integration.
|
||||
---
|
||||
|
||||
# @suaveplan/testing-integration-postgres
|
||||
|
||||
PostgreSQL 16 testcontainers fixture for `@suaveplan/testing-integration`.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/testing-integration-postgres`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/testing-integration-postgres";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/testing-integration`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/testing/testing-integration-postgres/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/testing/testing-integration-postgres/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/testing/testing-integration-postgres/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/testing-integration`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: testing-integration-redis
|
||||
description: Use when implementing or debugging code that uses @suaveplan/testing-integration-redis: Redis 7 testcontainers fixture for @suaveplan/testing-integration.
|
||||
---
|
||||
|
||||
# @suaveplan/testing-integration-redis
|
||||
|
||||
Redis 7 testcontainers fixture for `@suaveplan/testing-integration`.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/testing-integration-redis`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/testing-integration-redis";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/testing-integration`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/testing/testing-integration-redis/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/testing/testing-integration-redis/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/testing/testing-integration-redis/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/testing-integration`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: testing-integration-surrealdb
|
||||
description: Use when implementing or debugging code that uses @suaveplan/testing-integration-surrealdb: SurrealDB v3 testcontainers fixture for @suaveplan/testing-integration.
|
||||
---
|
||||
|
||||
# @suaveplan/testing-integration-surrealdb
|
||||
|
||||
SurrealDB v3 testcontainers fixture for `@suaveplan/testing-integration`.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/testing-integration-surrealdb`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/testing-integration-surrealdb";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/testing-integration`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/testing/testing-integration-surrealdb/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/testing/testing-integration-surrealdb/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/testing/testing-integration-surrealdb/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/testing-integration`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: testing-integration-typesense
|
||||
description: Use when implementing or debugging code that uses @suaveplan/testing-integration-typesense: Typesense 27 testcontainers fixture for @suaveplan/testing-integration.
|
||||
---
|
||||
|
||||
# @suaveplan/testing-integration-typesense
|
||||
|
||||
Typesense 27 testcontainers fixture for `@suaveplan/testing-integration`.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/testing-integration-typesense`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/testing-integration-typesense";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/testing-integration`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/testing/testing-integration-typesense/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/testing/testing-integration-typesense/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/testing/testing-integration-typesense/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/testing-integration`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: testing-integration
|
||||
description: Use when implementing or debugging code that uses @suaveplan/testing-integration: Core integration test infrastructure: ServiceFixture<T> interface, TestEnvironment, createIntegrationSetup() factory, HealthPoller, skipIfUnavailable() helper.
|
||||
---
|
||||
|
||||
# @suaveplan/testing-integration
|
||||
|
||||
Core integration test infrastructure for Vitest: fixture lifecycle management, health polling, and the global-setup bridge.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/testing-integration`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/testing-integration";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/testing/testing-integration/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/testing/testing-integration/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/testing/testing-integration/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: testing
|
||||
description: Use when implementing or debugging code that uses @suaveplan/testing: Universal test utilities (FakeClock, Factory, FixtureManager, MemoryStore, builders, helpers, observability) — runner-agnostic, no DOM dependencies.
|
||||
---
|
||||
|
||||
# @suaveplan/testing
|
||||
|
||||
Shared test infrastructure for Suaveplan. Provides runner primitives (Vitest or bun-test via conditional exports), structured builders, a deterministic FakeClock, Factory and FixtureManager, an in-memory store, async helpers, and a WSL2-aware `createTestConfig()` factory. Every other `@suaveplan/*` package imports from here when writing tests.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/testing`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/testing";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/testing/testing/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/testing/testing/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/testing/testing/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: timing
|
||||
description: Use when implementing or debugging code that uses @suaveplan/timing: Timing and scheduling utilities — stopwatch, throttle, debounce, scheduler, decay, timer, countdown, vector clock.
|
||||
---
|
||||
|
||||
# @suaveplan/timing
|
||||
|
||||
Timing and scheduling utilities for application-layer time management. The package covers measurement (stopwatch with lap recording), rate control (throttle and debounce with leading/trailing edge and maxWait), value decay (exponential and linear curves), delayed-task scheduling with drain/dispose lifecycle, repeating interval timers, countdowns with pause/resume, and vector clocks for distributed happens-before ordering. All stateful primitives accept an injectable `Clock` so they can be driven deterministically in tests using `FakeClock` from `@suaveplan/testing`.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/timing`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/timing";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/timing/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/timing/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/timing/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: types
|
||||
description: Use when implementing or debugging code that uses @suaveplan/types: Types-only foundation — canonical shared interfaces (Clock, IdGenerator, Rng, MessageResolver, EventBusLike, LoggerLike, StorageLike, DatabaseLike, common option bundles).
|
||||
---
|
||||
|
||||
# @suaveplan/types
|
||||
|
||||
Types-only foundation package. Zero runtime code, zero dependencies, zero bundle bytes. Provides the canonical shared interfaces that allow every `@suaveplan/*` package to accept and return the same shapes without coupling to a concrete implementation: `Clock` (`() => number`), `IdGenerator` (`() => string`), `Rng` (seeded random interface), `MessageResolver` (i18n hook), `EventBusLike<TMap>` (minimal event-bus contract), `LoggerLike` (minimal structured-logger contract), and three composable option bundles (`CancellableOptions`, `TraceableOptions`, `DeterministicOptions`). Always `import type` from this package — it emits nothing at runtime. This is the only `@suaveplan/*` dependency the testing-infrastructure packages (`testing`, `testing-dom`, `testing-e2e`) are permitted to take, because its build emits no runtime bytes and therefore creates no circular hazard.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/types`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/types";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/types/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/types/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/types/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: typescript-config
|
||||
description: Use when implementing or debugging code that uses @suaveplan/typescript-config: Shared TypeScript configuration presets for Suaveplan.
|
||||
---
|
||||
|
||||
# @suaveplan/typescript-config
|
||||
|
||||
Shared TypeScript configuration presets for Suaveplan. This package ships composable JSON presets consumed via `"extends"` across every workspace package — no runtime code, no build step, zero dependencies.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/typescript-config`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/typescript-config";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: _none_
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/typescript-config/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/typescript-config/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/typescript-config/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- The marketplace root: `../../../README.md`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
name: undo
|
||||
description: Use when implementing or debugging code that uses @suaveplan/undo: Enterprise-grade undo/redo engine with branching history, async commands, history compression, selective undo, and command merging.
|
||||
---
|
||||
|
||||
# @suaveplan/undo
|
||||
|
||||
Enterprise-grade undo/redo engine with branching history, async commands, history compression, selective undo, and command merging. Built for collaborative editors, document tools, and any application requiring robust, reversible state management.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/undo`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/undo";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/diff`, `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/undo/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/undo/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/undo/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/diff`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: utils
|
||||
description: Use when implementing or debugging code that uses @suaveplan/utils: Universal utility library: debug, object, platform, number, random, string, email, sound, validate.
|
||||
---
|
||||
|
||||
# @suaveplan/utils
|
||||
|
||||
Zero-external-dependency utility library for Suaveplan. Covers debug helpers, deep object manipulation, platform detection, IEEE 754 float packing, pseudo-random selection, email normalization, audio sprite management, string generation, hex validation, and byte-size enforcement.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/utils`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/utils";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/utils/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/utils/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/utils/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: validation
|
||||
description: Use when implementing or debugging code that uses @suaveplan/validation: Runtime schema validation with Zod-compatible API — self-contained parse engine, exhaustive schema types, async refinements, hooks, structured errors.
|
||||
---
|
||||
|
||||
# @suaveplan/validation
|
||||
|
||||
Runtime schema validation with a Zod-compatible API. This package is a self-contained parse engine — it does not import Zod or any other validation library — so it is safe to use in environments where Zod is absent or where bundle size is a constraint. It covers the full schema surface expected from a production validator: all primitive and composite types, `parse`/`safeParse`/`parseAsync`, `refine` (sync + async), `transform`, `describe`, object shape builders (`pick`, `omit`, `partial`, `extend`, `merge`), three unknown-key modes, async lifecycle hooks, and composable helpers (`pipe`, `mergeResults`). Structured errors surface via `@suaveplan/error` with stable `VALIDATION.*` codes. When Zod is already a project dependency and you need its ecosystem (inference helpers, plugins), use Zod directly; use this package for internal platform code and zero-dep environments.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/validation`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/validation";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/foundation/validation/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/foundation/validation/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/foundation/validation/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: webhook-client
|
||||
description: Use when implementing or debugging code that uses @suaveplan/webhook-client: Webhook delivery client with retry logic, HMAC signature generation/verification, payload transformation, and delivery tracking.
|
||||
---
|
||||
|
||||
# @suaveplan/webhook-client
|
||||
|
||||
Webhook delivery client with retry logic, HMAC signature generation/verification, payload transformation, and delivery tracking. Runtime-agnostic (injectable fetch).
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/webhook-client`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/webhook-client";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/error`, `@suaveplan/retry`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/messaging/webhook-client/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/messaging/webhook-client/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/messaging/webhook-client/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/retry`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
Reference in New Issue
Block a user