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

Shapes

Base interfaces every UPG node and edge satisfies.

16 exports · 1 const · 4 type · 11 interface

Since v0.1.0

Quick import

import type { UPGBaseNode, UPGEdge, UPGDocument } from '@unified-product-graph/core/shapes'

Example

// The canonical shape of any UPG document
import type { UPGDocument } from '@unified-product-graph/core/shapes'

const doc: UPGDocument = {
  version: '0.4.3',
  product_id: 'demo',
  nodes: [{ id: 'p1', type: 'persona', title: 'Sarah Chen', status: 'active', created_at: '2026-05-13' }],
  edges: [],
}

Often used with:catalog properties See guide

16 exports

Base interfaces every UPG node and edge satisfies. Import these when writing code that operates on nodes generically. UPGBaseNode, UPGEdge, and the typed UPGProperty wrapper cover the full structural surface without pulling in domain-specific property types.

Exports

Constants

constUPG_CROSS_EDGE_TYPES#source

readonly UPGCrossEdgeType[]

Types

typeUPGCrossEdgeType#source

type UPGCrossEdgeType = | 'shares_persona' | 'shares_competitor' | 'shares_metric' | 'depends_on_product' | 'cannibalises' | 'succeeds'

The set of valid cross-product relationship types

typeUPGEdgeType#source

type UPGEdgeType = keyof typeof UPG_EDGE_CATALOG

Union of all edge type keys from the canonical edge registry

typeUPGMappingConfidence#source

type UPGMappingConfidence = 'high' | 'medium' | 'low' | 'manual'

Confidence level for a type mapping when importing from an external tool.

typeUPGProductStage#source

type UPGProductStage = | 'concept' // napkin idea, no validation yet | 'validation' // testing demand, talking to users | 'build' // activel...

Product lifecycle stages.

Interfaces

interfaceUPGBaseNode#source

interface UPGBaseNode

The structural base shared by every node in a product graph.

interfaceUPGCrossEdge#source

interface UPGCrossEdge

A cross-product edge links entities across different products within a portfolio.

interfaceUPGDocument#source

interface UPGDocument

A UPGDocument is a portable, versioned snapshot of a product's knowledge graph.

interfaceUPGEdge#source

interface UPGEdge

Interface for a semantic relationship between two nodes

interfaceUPGIntegrity#source

interface UPGIntegrity

Checksum-backed tamper-evidence metadata stamped into a `UPGDocument` at save time by the MCP server.

interfaceUPGOrganization#source

interface UPGOrganization

An organisation that owns portfolios and product areas.

interfaceUPGPortfolio#source

interface UPGPortfolio

A portfolio grouping.

interfaceUPGPortfolioDocument#source

interface UPGPortfolioDocument

A UPGPortfolioDocument is a portable, versioned snapshot of a multi-product portfolio.

interfaceUPGProduct#source

interface UPGProduct

The root product described by a `UPGDocument`.

interfaceUPGProductArea#source

interface UPGProductArea

A product area within a portfolio.

interfaceUPGSource#source

interface UPGSource

Identifies the tool that produced a `UPGDocument`.