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

Catalog

The canonical list of every UPG entity type and edge type.

13 exports · 4 const · 4 type · 1 interface · 4 fn

Since v0.1.0

Quick import

import { UPG_EDGE_CATALOG, isPolymorphicEdge } from '@unified-product-graph/core/catalog'

Example

// Inspect the canonical shape of an edge type
import { UPG_EDGE_CATALOG, isPolymorphicEdge } from '@unified-product-graph/core/catalog'

const edge = UPG_EDGE_CATALOG.find(e => e.key === 'persona_pursues_job')
console.log(edge?.forward_verb)              // → 'pursues'

isPolymorphicEdge('node_informs_node')       // → true

Often used with:shapes grammar See guide

13 exports

The canonical list of every UPG entity type and edge type. Constants you import for runtime entity-type checks, edge-type enumeration, and pair-lookup (UPG_TYPES, UPG_EDGE_PAIR_MAP). Zero external imports, the absolute foundation of the spec.

Exports

Constants

constLEGACY_PRODUCT_STAGES#source

Readonly<Record<string, UPGProductStage>>

constUPG_EDGE_CATALOG#source

{ product_targets_persona: { forward_verb: string; reverse_verb: string; classification: "semantic"; source_type: str...

constUPG_POLYMORPHIC_EDGE_KEYS#source

readonly ("product_targets_persona" | "persona_pursues_job" | "persona_experiences_need" | "persona_aspires_to_desire...

constUPG_WILDCARD_ENDPOINT#source

"node"

Types

typeAnyUPGEntityType#source

type AnyUPGEntityType = UPGEntityType | DeprecatedUPGEntityType

All entity types.

typeDeprecatedUPGEntityType#source

type DeprecatedUPGEntityType = never

No entity types are currently deprecated; this union is `never`.

typeUPGEntityType#source

type UPGEntityType = | 'product' | 'outcome' | 'objective' | 'key_result' | 'metric' | 'metric_quality_assessment' | 'vision' | 'mission' ...

The union of every active entity type, across 36 flat domains.

typeUPGWildcardEndpoint#source

type UPGWildcardEndpoint = typeof UPG_WILDCARD_ENDPOINT

Interfaces

interfaceUPGEdgeDefinition#source

interface UPGEdgeDefinition

The shape of a single canonical edge in `UPG_EDGE_CATALOG`.

Functions

functionisLegacyProductStage#source

(stage: unknown) => boolean

True when `stage` is a known legacy alias (would migrate to a different canonical value).

functionisPolymorphicEdge#source

(key: _UPGEdgeTypeLocal) => boolean

True if the edge uses the `'node'` wildcard at either endpoint.

functionisRegisteredPolymorphicEdge#source

(key: _UPGEdgeTypeLocal) => boolean

True if the edge is in the registered polymorphic allow-list.

functionmigrateProductStage#source

(stage: T) => T extends string ? string : undefined

Canonicalise a stage value via `LEGACY_PRODUCT_STAGES`.