from @unified-product-graph/core/presentation · re-exported by @sdk

Presentation

Display-layer metadata: type labels, framework labels, and domain rings.

40 exports · 11 const · 1 type · 10 interface · 18 fn

Since v0.3.0

Quick import

import { UPG_TYPE_LABELS_MAP } from '@unified-product-graph/core'

Example

// Render a human-readable label for any entity type
import { UPG_TYPE_LABELS_MAP } from '@unified-product-graph/core'

UPG_TYPE_LABELS_MAP.get('value_proposition')?.canonical_label         // → 'Value Proposition'
UPG_TYPE_LABELS_MAP.get('metric_quality_assessment')?.canonical_label // → 'Metric Quality Assessment'

Often used with:shapes registry

40 exports

Display-layer metadata: type labels, framework labels, and domain rings. Everything used by UI to render entity types in human-readable form lives here: UPG_TYPE_LABELS, UPG_LENSES, UPG_DOMAIN_RINGS. Presentation concerns are applied on read and never stored in the graph.

Exports

Constants

constDEFAULT_ENTITY_EMOJI#source

"📦"

constENTITY_EMOJI#source

Record<string, string>

constUPG_AREA_TAXONOMY#source

readonly UPGAreaTaxonomyEntry[]

constUPG_AREA_TAXONOMY_BY_COVERAGE_KEY#source

Readonly<Record<string, UPGAreaTaxonomyEntry>>

constUPG_DOMAIN_RINGS#source

readonly UPGDomainRing[]

constUPG_LENSES#source

readonly UPGLens[]

constUPG_TREE_PATTERNS#source

readonly UPGTreePattern[]

constUPG_TREE_PATTERNS_BY_ID#source

Record<string, UPGTreePattern>

constUPG_TYPE_ALIASES#source

Record<string, string>

constUPG_TYPE_LABELS#source

UPGTypeLabel[]

constUPG_TYPE_LABELS_MAP#source

ReadonlyMap<string, UPGTypeLabel>

Types

typeUPGTreeGapPolicy#source

type UPGTreeGapPolicy = 'required-children-only' | 'all-optional'

How a pattern decides what counts as a structural gap.

Interfaces

interfaceUPGAreaTaxonomyEntry#source

interface UPGAreaTaxonomyEntry

One row of the area-taxonomy cross-walk, keyed by a `digest.coverage` key.

interfaceUPGDomainRing#source

interface UPGDomainRing

interfaceUPGLens#source

interface UPGLens

A contextual projection of the product graph for a specific role, framework, or mode of thinking.

interfaceUPGLensIntelligencePrompt#source

interface UPGLensIntelligencePrompt

A single context-sensitive nudge belonging to a lens's intelligence layer.

interfaceUPGTreeChild#source

interface UPGTreeChild

One child slot in a pattern: a child entity type and whether it is gap-worthy.

interfaceUPGTreePattern#source

interface UPGTreePattern

A canonical tree shape for `get_tree`.

interfaceUPGTreePatternDetail#source

interface UPGTreePatternDetail

A pattern with its child map resolved to concrete edges (for introspection).

interfaceUPGTreePatternEdge#source

interface UPGTreePatternEdge

One resolved edge in a pattern's child map: the (parent -> child) pair plus the canonical edge that wires it, resolved LIVE from the edge catalogue (not stored on the pattern).

interfaceUPGTreePatternSummary#source

interface UPGTreePatternSummary

A pattern summary row (no child_map) for list_tree_patterns.

interfaceUPGTypeLabel#source

interface UPGTypeLabel

Functions

functionbuildTypeAliases#source

() => Record<string, string>

Build the TYPE_ALIASES map from alt_labels.

functiondescribeTreePattern#source

(id: string) => UPGTreePatternDetail | undefined

The full declarative record for one pattern: the pattern plus its child_map resolved to concrete edges.

functiongetAreaTaxonomyEntry#source

(coverageKey: string) => UPGAreaTaxonomyEntry | undefined

The cross-walk row for a `digest.coverage` key, or undefined.

functiongetBusinessAreasForRegion#source

(regionId: string) => string[]

The "8 business area" ids that map to a given region (deduped).

functiongetCoverageKeysForRegion#source

(regionId: string) => string[]

The `digest.coverage` keys whose entities live (partly) in a given region.

functiongetDefaultLens#source

() => UPGLens

Get the default lens (Full).

functiongetDomainsInRing#source

(ringId: string) => string[]

Get all domain IDs in a given ring.

functiongetLens#source

(id: string) => UPGLens | undefined

Get a lens by its id.

functiongetLensesForDomain#source

(domainId: string) => UPGLens[]

Get all lenses that include a given domain in their visible_domains.

functiongetLensIds#source

() => string[]

Get all lens IDs.

functiongetLensPlaybook#source

(lens: UPGLens) => UPGPlaybook | undefined

Resolve a lens to its associated `UPGPlaybook`.

functiongetRingForDomain#source

(domainId: string) => UPGDomainRing | undefined

Look up which ring a domain belongs to.

functiongetTreePattern#source

(id: string) => UPGTreePattern | undefined

Look up a tree pattern by id.

functiongetVisibleTypes#source

(lens: UPGLens) => string[]

Get all entity types visible through a given lens.

functionlistTreePatternSummaries#source

() => UPGTreePatternSummary[]

Every pattern as a summary row (the list_tree_patterns surface).

functionresolveLabel#source

(entityType: string, frameworkId?: string, designation?: string) => string

Resolve the display label for an entity type, with optional framework context.

functionresolveTreePatternEdges#source

(pattern: UPGTreePattern) => UPGTreePatternEdge[]

Flatten a pattern's child_map to resolved (parent, child, via, kind) edges.

functionringOrderedDomainIds#source

() => string[]

Every domain id in canonical ring order (nucleus outward, then within-ring order).