@decantr/registry

@decantr/registry

Support status: core-supported
Release channel: stable

Certified vocabulary contracts, schemas, API client, ranking helpers, and content utilities for Decantr.

Install

npm install @decantr/registry

What It Exports

• strong types for patterns, themes, starter-kit blueprints, archetypes, shells, and intelligence metadata
• ContentHealthReport types for vocabulary supply-chain health artifacts
• RegistryAPIClient for server-side and tool-side registry access
• @decantr/registry/client for web-safe API usage
• public schema exports for vocabulary content, content health, and summary responses
• ranking and sorting helpers for public vocabulary content
• Brownfield-aware pattern discovery helpers: patternToDiscoveryCandidate(), scorePatternCandidate(), and rankPatternCandidates()
• blueprint portfolio metadata helpers for public All, Featured, Certified, and Labs registry cuts

Example

Node/runtime usage:

import { RegistryAPIClient } from '@decantr/registry';

const client = new RegistryAPIClient({ baseUrl: 'https://api.decantr.ai/v1' });
const results = await client.search({
  q: 'dashboard',
  type: 'blueprint',
  blueprintSet: 'featured',
});

Browser-safe usage:

import { createRegistryClient } from '@decantr/registry/client';

const client = createRegistryClient({ baseUrl: 'https://api.decantr.ai/v1' });
const summary = await client.getIntelligenceSummary();

Pattern discovery usage:

import { patternToDiscoveryCandidate, rankPatternCandidates } from '@decantr/registry';

const matches = rankPatternCandidates(
  { query: 'recipe feed with avatars and infinite scroll', route: '/feed' },
  patterns.map((pattern) => patternToDiscoveryCandidate(pattern)),
);

Related Schemas

This package owns the canonical registry schemas published under @decantr/registry/schema/*, including content-health-report.v1.json for local content repository health reports emitted by decantr content-health.

Blueprint records can include blueprint_portfolio metadata. List/search summaries expose that metadata so clients can show public-facing blueprint sets without leaking internal maturity labels:

• all — supported public starter-kit blueprints, excluding Labs and folded slugs by default
• featured — curated default discovery picks
• certified — starter kits with certified artifact metadata
• labs — opt-in experimental directions

Compatibility

@decantr/registry is part of the stable public Decantr package surface in the 2.x line.

• exported schema paths and documented client entrypoints are expected to remain stable across 1.x
• additive response fields may be introduced without breaking the stable contract
• breaking client, schema, or path changes require a major version

Security And Permissions

@decantr/registry provides registry schemas, content utilities, and API clients. It may read explicit local registry JSON files when resolver helpers are used, and it may call the configured Decantr API base URL when client methods are invoked. It does not write files, spawn processes, emit telemetry, or upload source by itself. See security permissions.

License

MIT