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

Properties

Property shape validators and the property extension mechanism.

393 exports · 4 const · 50 type · 331 interface · 8 fn

Since v0.2.0

Quick import

import { UPG_PROPERTY_SCHEMA, getPropertySchema } from '@unified-product-graph/core'

Example

// Inspect the property schema for an entity type
import { getPropertySchema } from '@unified-product-graph/core'

// getPropertySchema returns the property map directly — its keys are the names
const schema = getPropertySchema('persona')
console.log(Object.keys(schema ?? {}))
// → ['context', 'is_primary', 'experience_level', 'motivation', ...]

Often used with:shapes catalog See guide

393 exports

Property shape validators and the property extension mechanism. Every entity type's typed property interface is exported here, plus UPGPropertyMap, UPGNode<T>, and the auto-generated JSON Schema (UPG_PROPERTY_SCHEMA). Use to validate property values at import time or generate typed nodes.

Exports

Constants

constPROPERTY_MODIFIER_SEMANTICS#source

Record<PropertyModifier, string>

constPROPERTY_MODIFIERS#source

readonly ["derived", "snapshot", "volatile"]

constRECORD_ENTITY_TYPES#source

ReadonlySet<string>

constUPG_PROPERTY_SCHEMA#source

Record<string, PropertySchema>

Types

typeCadence#source

type Cadence = | 'continuous' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' | 'on_demand' | 'other'

Canonical cadence primitive for recurring activities, publications, and measurement schedules.

typeCauseConfidence#source

type CauseConfidence = 'hypothesised' | 'likely' | 'confirmed'

Maturity of a root-cause determination during incident debugging.

typeClassificationCapabilitySurface#source

type ClassificationCapabilitySurface = | 'delivery' | 'extensibility' | 'collaboration' | 'preview' | 'localization' | 'developer_experience'

The six canonical capability surfaces of a `classification_value`.

typeComfortLevel#source

type ComfortLevel = 'low' | 'medium' | 'high' | 'expert' | 'other'

A person's comfort level with a tool, technology, or practice.

typeConfidence#source

type Confidence = 'high' | 'medium' | 'low'

Confidence level for assumptions, evidence, and feasibility.

typeConformanceLevel#source

type ConformanceLevel = 'A' | 'AA' | 'AAA'

WCAG conformance level.

typeConstraintKind#source

type ConstraintKind = 'resource' | 'technical' | 'regulatory' | 'temporal' | 'compliance' | 'other'

Kind of constraint.

typeConstraintOrigin#source

type ConstraintOrigin = 'internal' | 'external'

Where a constraint comes from (0.17.2).

typeConstraintStatus#source

type ConstraintStatus = 'binding' | 'advisory' | 'lifted'

Whether a constraint is currently binding.

typeCron#source

type Cron = string

5- or 6-field cron expression.

typeDataSensitivity#source

type DataSensitivity = 'public' | 'internal' | 'confidential' | 'restricted'

Data classification / sensitivity tier.

typeDifficultyLevel#source

type DifficultyLevel = 'beginner' | 'intermediate' | 'advanced'

Learning difficulty tier.

typeDuration#source

type Duration = string

ISO 8601 duration string.

typeEmptyCellRationaleKind#source

type EmptyCellRationaleKind = 'structural' | 'ideological' | 'opportunity'

Reason a (axis_a × axis_b) cell in a 2-axis classification matrix is unoccupied.

typeEvidenceDirection#source

type EvidenceDirection = 'supports' | 'refutes' | 'neutral'

Direction of evidence relative to a claim (supports / refutes / neutral).

typeFrequencyRating#source

type FrequencyRating = 'constant' | 'regular' | 'occasional' | 'rare' | 'other'

Qualitative frequency rating (distinct from the numeric `frequency_5` scale and from `Cadence`'s calendar tiers).

typeGuardrailStatus#source

type GuardrailStatus = 'safe' | 'warning' | 'breached'

Current guardrail health state.

typeHealthStatus#source

type HealthStatus = 'on_track' | 'at_risk' | 'off_track'

Traffic-light health status for initiatives, features, and delivery

typeIncidentSeverity#source

type IncidentSeverity = 'sev1' | 'sev2' | 'sev3' | 'sev4'

Incident severity tier (paging classification).

typeISO4217#source

type ISO4217 = string

ISO 4217 three-character alphabetic currency code.

typeISODate#source

type ISODate = string

ISO 8601 date (e.g.

typeISODateTime#source

type ISODateTime = string

ISO 8601 datetime with timezone (e.g.

typeJourneyType#source

type JourneyType = 'current_state' | 'future_state' | 'day_in_the_life'

Whether a journey maps current or future state.

typeLogLevel#source

type LogLevel = 'critical' | 'warning' | 'info'

Operational log / alert verbosity level.

typeLowMedHigh#source

type LowMedHigh = Confidence

Three-point ordinal scale: low / medium / high.

typeMarketingPlatform#source

type MarketingPlatform = | 'discord' | 'email' | 'google' | 'instagram' | 'linkedin' | 'meta' | 'other' | 'podcast' | 'reddit' | 'tiktok' | 't...

Marketing and advertising platform identifier.

typeMaturityLevel#source

type MaturityLevel = 'initial' | 'developing' | 'defined' | 'managed' | 'optimizing'

Capability/process maturity on the CMMI ladder.

typeMetricCategory#source

type MetricCategory = 'acquisition' | 'activation' | 'retention' | 'referral' | 'revenue' | 'engagement' | 'happiness' | 'task_success' | '...

AARRR or HEART category

typeMetricDesignation#source

type MetricDesignation = 'north_star' | 'kpi' | 'driver' | 'input' | 'guardrail' | 'proxy' | 'health' | 'vanity' | 'metric'

Role a metric plays in the measurement system

typeMetricHealth#source

type MetricHealth = 'healthy' | 'at_risk' | 'unhealthy' | 'unknown'

Universal metric health rollup.

typeMetricImpactLevel#source

type MetricImpactLevel = 'impact' | 'outcome' | 'output'

Where a metric sits in the impact hierarchy

typeMetricIndicatorDirection#source

type MetricIndicatorDirection = 'leading' | 'lagging'

Whether a metric leads or lags the behaviour it measures

typeMetricSegmentType#source

type MetricSegmentType = 'persona' | 'cohort' | 'channel' | 'geography' | 'device' | 'plan' | 'custom'

Type of audience or group a metric segment represents

typeMetricStatisticalFunction#source

type MetricStatisticalFunction = 'average' | 'total' | 'count' | 'median' | 'rate' | 'ratio' | 'percentage' | 'score' | 'min' | 'max' | 'p95' | 'p99' ...

Aggregation function applied to raw data

typeNeedMaturity#source

type NeedMaturity = 'raw' | 'validated' | 'prioritized'

How mature a need is in our understanding

typeNeedValence#source

type NeedValence = 'pain' | 'gap' | 'constraint'

What kind of experience a need represents

typePriority#source

type Priority = 'urgent' | 'high' | 'medium' | 'low' | 'none'

Task or strategic priority level

typePropertyModifier#source

type PropertyModifier = NonNullable<PropertyDefinition['modifier']>

The three property-modifier values.

typePropertySchema#source

type PropertySchema = Record<string, PropertyDefinition>

typeProtocol#source

type Protocol = | 'asyncapi' | 'event' | 'file' | 'graphql' | 'grpc' | 'mqtt' | 'other' | 'rest' | 'soap' | 'webhook' | 'websocket'

Communication protocol for API contracts and data flows.

typeProxyConfidence#source

type ProxyConfidence = 'strong' | 'moderate' | 'weak'

How strongly a proxy metric predicts the direct measure.

typeProxyReason#source

type ProxyReason = 'qualitative' | 'no_direct_measure' | 'not_yet_instrumented' | 'too_expensive'

Why a metric is used as a proxy

typeRuleStrength#source

type RuleStrength = 'must' | 'must_not' | 'exception' | 'warning' | 'guideline'

How strict a rule is.

typeSemver#source

type Semver = string

Semantic version string following semver.org 2.0.0.

typeSignalChannel#source

type SignalChannel = | 'analytics_event' | 'community' | 'email' | 'in_app' | 'interview' | 'other' | 'review' | 'sales_call' | 'social' |...

Channel through which an inbound signal was received.

typeSignalSentiment#source

type SignalSentiment = 'positive' | 'neutral' | 'negative' | 'mixed'

Sentiment polarity of an inbound signal.

typeSignalUrgency#source

type SignalUrgency = 'low' | 'medium' | 'high' | 'critical'

Urgency level of an inbound signal (customer, support, or market).

typeStoryTaskProperties#source

type StoryTaskProperties = Record<string, never>

canonical `task`.

typeTimeframe#source

type Timeframe = string

Flexible, human-readable timeframe label.

typeUPGNode#source

type UPGNode = UPGBaseNode & { type: T properties?: UPGPropertyMap[T] }

A fully typed UPG node.

Interfaces

interfaceA11yAnnotationProperties#source

interface A11yAnnotationProperties

Accessibility annotation.

interfaceA11yAuditProperties#source

interface A11yAuditProperties

Accessibility audit.

interfaceA11yGuidelineProperties#source

interface A11yGuidelineProperties

Accessibility guideline.

interfaceA11yIssueProperties#source

interface A11yIssueProperties

Accessibility issue.

interfaceA11yStandardProperties#source

interface A11yStandardProperties

Accessibility standard.

interfaceAcceptanceCriterionProperties#source

interface AcceptanceCriterionProperties

Acceptance criterion on a story or feature.

interfaceAccessPolicyProperties#source

interface AccessPolicyProperties

Access policy.

interfaceAccountProperties#source

interface AccountProperties

Sales account.

interfaceAcquisitionChannelProperties#source

interface AcquisitionChannelProperties

AcquisitionChannel entity.

interfaceAdCreativeProperties#source

interface AdCreativeProperties

Ad creative.

interfaceAffinityClusterProperties#source

interface AffinityClusterProperties

Affinity cluster grouping observations.

interfaceAgentDefinitionProperties#source

interface AgentDefinitionProperties

Agent definition.

interfaceAgentHookProperties#source

interface AgentHookProperties

Agent hook.

interfaceAgentSessionProperties#source

interface AgentSessionProperties

Agent session.

interfaceAgentSkillProperties#source

interface AgentSkillProperties

Agent skill.

interfaceAgentTaskProperties#source

interface AgentTaskProperties

Agent task.

interfaceAggregateProperties#source

interface AggregateProperties

DDD aggregate.

interfaceAiCostTrackerProperties#source

interface AiCostTrackerProperties

AI cost tracker.

interfaceAiDatasetProperties#source

interface AiDatasetProperties

Versioned AI training or evaluation dataset.

interfaceAiExperimentProperties#source

interface AiExperimentProperties

AI training or fine-tuning experiment.

interfaceAiGuardrailProperties#source

interface AiGuardrailProperties

AI guardrail.

interfaceAiModelProperties#source

interface AiModelProperties

AI model.

interfaceAiTraceProperties#source

interface AiTraceProperties

Single LLM call or chain execution trace.

interfaceAlertRuleProperties#source

interface AlertRuleProperties

Alert rule.

interfaceAnnotationProperties#source

interface AnnotationProperties

Design annotation on a screen.

interfaceApiContractProperties#source

interface ApiContractProperties

API contract.

interfaceApiEcosystemProperties#source

interface ApiEcosystemProperties

API ecosystem.

interfaceApiEndpointProperties#source

interface ApiEndpointProperties

API endpoint.

interfaceApprovalRecordProperties#source

interface ApprovalRecordProperties

Approval record.

interfaceAssumptionProperties#source

interface AssumptionProperties

Assumption entity.

interfaceAttributionModelProperties#source

interface AttributionModelProperties

AttributionModel entity.

interfaceAuditLogPolicyProperties#source

interface AuditLogPolicyProperties

Audit log policy.

interfaceBehavioralSegmentProperties#source

interface BehavioralSegmentProperties

BehavioralSegment entity.

interfaceBetaProgramProperties#source

interface BetaProgramProperties

Beta program.

interfaceBoundedContextProperties#source

interface BoundedContextProperties

DDD bounded context.

interfaceBrandAssetProperties#source

interface BrandAssetProperties

Brand asset.

interfaceBrandColourProperties#source

interface BrandColourProperties

Brand colour.

interfaceBrandIdentityProperties#source

interface BrandIdentityProperties

Brand identity.

interfaceBrandImageryProperties#source

interface BrandImageryProperties

Brand imagery guidelines.

interfaceBrandLogoProperties#source

interface BrandLogoProperties

Brand logo variant.

interfaceBrandTypographyProperties#source

interface BrandTypographyProperties

Brand typography.

interfaceBrandVoiceProperties#source

interface BrandVoiceProperties

Brand voice guidelines.

interfaceBugProperties#source

interface BugProperties

Bug report.

interfaceBuildArtifactProperties#source

interface BuildArtifactProperties

Build artifact.

interfaceBusinessModelProperties#source

interface BusinessModelProperties

BusinessModel: root of a BMC-style model.

interfaceCapabilityProperties#source

interface CapabilityProperties

Capability entity.

interfaceCapacityPlanProperties#source

interface CapacityPlanProperties

CapacityPlan entity.

interfaceCeremonyProperties#source

interface CeremonyProperties

Ceremony entity.

interfaceCertificationProperties#source

interface CertificationProperties

Certification.

interfaceChangelogProperties#source

interface ChangelogProperties

Changelog entry.

interfaceChangeRequestProperties#source

interface ChangeRequestProperties

Change request.

interfaceChurnReasonProperties#source

interface ChurnReasonProperties

Churn reason.

interfaceCiPipelineProperties#source

interface CiPipelineProperties

CI pipeline.

interfaceClassificationAxisProperties#source

interface ClassificationAxisProperties

ClassificationAxis: a dimension along which subjects are classified.

interfaceClassificationCapability#source

interface ClassificationCapability

A capability surface and its bullet list on a `classification_value`.

interfaceClassificationCommitment#source

interface ClassificationCommitment

Defining architectural commitment of a `classification_value`.

interfaceClassificationValueProperties#source

interface ClassificationValueProperties

ClassificationValue: a value on a classification axis.

interfaceCodeRepositoryProperties#source

interface CodeRepositoryProperties

Code repository.

interfaceCohortProperties#source

interface CohortProperties

Cohort entity.

interfaceCommandProperties#source

interface CommandProperties

CQRS command.

interfaceCommunityInitiativeProperties#source

interface CommunityInitiativeProperties

Community initiative.

interfaceCompetitiveAnalysisProperties#source

interface CompetitiveAnalysisProperties

Competitive analysis exercise or snapshot.

interfaceCompetitiveBattleCardProperties#source

interface CompetitiveBattleCardProperties

CompetitiveBattleCard entity.

interfaceCompetitorFeatureProperties#source

interface CompetitorFeatureProperties

Competitor feature or capability.

interfaceCompetitorProperties#source

interface CompetitorProperties

A product or approach competing for the same user need.

interfaceCompetitorSignalProperties#source

interface CompetitorSignalProperties

Competitor signal: a dated competitor move mapped onto our portfolio.

interfaceComplianceFrameworkProperties#source

interface ComplianceFrameworkProperties

Compliance framework.

interfaceComplianceRequirementProperties#source

interface ComplianceRequirementProperties

Compliance requirement.

interfaceConstraintProperties#source

interface ConstraintProperties

Constraint: a named limitation or boundary on product creation.

interfaceContactProperties#source

interface ContactProperties

Contact.

interfaceContentCalendarProperties#source

interface ContentCalendarProperties

Content calendar.

interfaceContentPieceProperties#source

interface ContentPieceProperties

Content piece.

interfaceContentStrategyProperties#source

interface ContentStrategyProperties

ContentStrategy entity.

interfaceContentThemeProperties#source

interface ContentThemeProperties

Content theme.

interfaceContractClauseProperties#source

interface ContractClauseProperties

Contract clause.

interfaceContractProperties#source

interface ContractProperties

Contract.

interfaceCostStructureProperties#source

interface CostStructureProperties

CostStructure.

interfaceCulturalAdaptationProperties#source

interface CulturalAdaptationProperties

Cultural adaptation.

interfaceCustomerFeedbackProperties#source

interface CustomerFeedbackProperties

Customer feedback.

interfaceCustomerHealthScoreProperties#source

interface CustomerHealthScoreProperties

Customer health score.

interfaceCustomerJourneyStageProperties#source

interface CustomerJourneyStageProperties

Customer journey stage.

interfaceCustomerRelationshipProperties#source

interface CustomerRelationshipProperties

CustomerRelationship.

interfaceDashboardProperties#source

interface DashboardProperties

Dashboard entity.

interfaceDatabaseSchemaProperties#source

interface DatabaseSchemaProperties

Database schema.

interfaceDataClassificationProperties#source

interface DataClassificationProperties

Data classification.

interfaceDataContractProperties#source

interface DataContractProperties

Data contract.

interfaceDataDomainProperties#source

interface DataDomainProperties

DataDomain.

interfaceDataFlowProperties#source

interface DataFlowProperties

Data flow between services.

interfaceDataLineageProperties#source

interface DataLineageProperties

DataLineage entity.

interfaceDataModelProperties#source

interface DataModelProperties

DataModel entity.

interfaceDataPipelineProperties#source

interface DataPipelineProperties

DataPipeline entity.

interfaceDataProductProperties#source

interface DataProductProperties

DataProduct entity.

interfaceDataQualityRuleProperties#source

interface DataQualityRuleProperties

DataQualityRule entity.

interfaceDataSourceProperties#source

interface DataSourceProperties

DataSource entity.

interfaceDealProperties#source

interface DealProperties

Deal.

interfaceDecisionProperties#source

interface DecisionProperties

Decision record.

interfaceDeliverableProperties#source

interface DeliverableProperties

Deliverable.

interfaceDemandGenProgramProperties#source

interface DemandGenProgramProperties

DemandGenProgram entity.

interfaceDepartmentProperties#source

interface DepartmentProperties

Department entity.

interfaceDependencyProperties#source

interface DependencyProperties

Dependency entity.

interfaceDeploymentProperties#source

interface DeploymentProperties

Deployment.

interfaceDesignComponentProperties#source

interface DesignComponentProperties

Design system component.

interfaceDesignConceptProperties#source

interface DesignConceptProperties

Design concept being explored.

interfaceDesignGuidelineProperties#source

interface DesignGuidelineProperties

Design guideline.

interfaceDesignPatternProperties#source

interface DesignPatternProperties

Reusable design pattern.

interfaceDesignQuestionProperties#source

interface DesignQuestionProperties

Design question framing an open problem.

interfaceDesignSprintProperties#source

interface DesignSprintProperties

DesignSprint entity.

interfaceDesignSystemProperties#source

interface DesignSystemProperties

Design system as a whole.

interfaceDesignTokenProperties#source

interface DesignTokenProperties

Design token.

interfaceDesiredOutcomeProperties#source

interface DesiredOutcomeProperties

DesiredOutcome entity.

interfaceDeveloperPortalProperties#source

interface DeveloperPortalProperties

Developer portal.

interfaceDiscountStrategyProperties#source

interface DiscountStrategyProperties

Discount strategy.

interfaceDistributionChannelProperties#source

interface DistributionChannelProperties

DistributionChannel.

interfaceDocumentationTemplateProperties#source

interface DocumentationTemplateProperties

Documentation template.

interfaceDocumentProperties#source

interface DocumentProperties

Document.

interfaceDomainEntityProperties#source

interface DomainEntityProperties

DDD domain entity.

interfaceDomainEventProperties#source

interface DomainEventProperties

Domain event in an event-driven architecture.

interfaceEducationProgramProperties#source

interface EducationProgramProperties

Education program.

interfaceEmailSequenceProperties#source

interface EmailSequenceProperties

Email sequence.

interfaceEmptyCell#source

interface EmptyCell

An empty (axis_a_value × axis_b_value) cell with rationale for non-occupancy.

interfaceEpicProperties#source

interface EpicProperties

A collection of related user stories that delivers a feature or capability.

interfaceErrorBudgetProperties#source

interface ErrorBudgetProperties

Error budget.

interfaceEvalBenchmarkProperties#source

interface EvalBenchmarkProperties

Evaluation benchmark.

interfaceEvalRunProperties#source

interface EvalRunProperties

Evaluation run.

interfaceEventProperties#source

interface EventProperties

Event.

interfaceEventSchemaProperties#source

interface EventSchemaProperties

EventSchema entity.

interfaceEvidenceProperties#source

interface EvidenceProperties

Evidence supporting or refuting a hypothesis (P2: lifecycle-free snapshot).

interfaceExperimentPlanProperties#source

interface ExperimentPlanProperties

The validation PLAN: the design for a structured test of a hypothesis (UCS pattern P4: work-unit).

interfaceExperimentProperties#source

interface ExperimentProperties

A structured test designed to validate a hypothesis.

interfaceExperimentRunProperties#source

interface ExperimentRunProperties

Execution evidence for a structured test of a hypothesis (UCS pattern P6: event-occurrence).

interfaceExternalApiProperties#source

interface ExternalApiProperties

External API dependency.

interfaceFeasibilityStudyProperties#source

interface FeasibilityStudyProperties

FeasibilityStudy entity.

interfaceFeatureAreaProperties#source

interface FeatureAreaProperties

A structural grouping of related features within a product.

interfaceFeatureFlagProperties#source

interface FeatureFlagProperties

Feature flag.

interfaceFeatureProperties#source

interface FeatureProperties

A discrete, user-facing capability of the product.

interfaceFeatureRequestProperties#source

interface FeatureRequestProperties

Feature request raised by customer, prospect, or internal stakeholder.

interfaceFeedbackProgramProperties#source

interface FeedbackProgramProperties

Feedback program.

interfaceFeedbackThemeProperties#source

interface FeedbackThemeProperties

Recurring theme identified across feedback signals.

interfaceFeedbackVoteProperties#source

interface FeedbackVoteProperties

Feedback vote.

interfaceFixProperties#source

interface FixProperties

Specific change that resolved an issue.

interfaceForecastProperties#source

interface ForecastProperties

Revenue forecast.

interfaceFrameworkExerciseProperties#source

interface FrameworkExerciseProperties

Framework exercise: one run of a framework over a set of entities.

interfaceFunnelProperties#source

interface FunnelProperties

Funnel entity.

interfaceFunnelStepProperties#source

interface FunnelStepProperties

FunnelStep entity.

interfaceGlossaryTermProperties#source

interface GlossaryTermProperties

GlossaryTerm entity.

interfaceGrowthCampaignProperties#source

interface GrowthCampaignProperties

GrowthCampaign entity.

interfaceGrowthLoopProperties#source

interface GrowthLoopProperties

GrowthLoop entity.

interfaceGtmStrategyProperties#source

interface GtmStrategyProperties

GtmStrategy entity.

interfaceHallucinationReportProperties#source

interface HallucinationReportProperties

Hallucination report.

interfaceHelpVideoProperties#source

interface HelpVideoProperties

Help video.

interfaceHypothesisEvidenceProperties#source

interface HypothesisEvidenceProperties

canonical entity for all evidence: carries both `evidence_rigor` and `evidence_source` axes, plus `weight`, `summary`, and `observed_at`.

interfaceHypothesisProperties#source

interface HypothesisProperties

A testable belief.

interfaceIdealCustomerProfileProperties#source

interface IdealCustomerProfileProperties

IdealCustomerProfile entity.

interfaceIncidentProperties#source

interface IncidentProperties

Incident.

interfaceInfrastructureComponentProperties#source

interface InfrastructureComponentProperties

Infrastructure component.

interfaceInitiativeProperties#source

interface InitiativeProperties

Initiative entity.

interfaceInsightProperties#source

interface InsightProperties

Unified insight, synthesised from evidence and observations.

interfaceIntegrationPartnerProperties#source

interface IntegrationPartnerProperties

Integration partner.

interfaceIntegrationPatternProperties#source

interface IntegrationPatternProperties

Integration pattern between systems.

interfaceInteractionSpecProperties#source

interface InteractionSpecProperties

Interaction specification.

interfaceInternalDocProperties#source

interface InternalDocProperties

Internal document.

interfaceInterviewGuideProperties#source

interface InterviewGuideProperties

Interview guide document.

interfaceInvestigationProperties#source

interface InvestigationProperties

Active thread of inquiry: debugging, architecture exploration, RCA.

interfaceInvoiceProperties#source

interface InvoiceProperties

Invoice.

interfaceIpAssetProperties#source

interface IpAssetProperties

Intellectual property asset.

interfaceJobProperties#source

interface JobProperties

Job-to-be-Done: the underlying goal a user is trying to accomplish.

interfaceJobStepProperties#source

interface JobStepProperties

JobStep entity.

interfaceJourneyActionProperties#source

interface JourneyActionProperties

Discrete action at a journey step, classified by service layer.

interfaceJourneyPhaseProperties#source

interface JourneyPhaseProperties

Phase within a user journey.

interfaceJourneyStepProperties#source

interface JourneyStepProperties

Single step within a user journey.

interfaceKeyActivityProperties#source

interface KeyActivityProperties

KeyActivity.

interfaceKeyResourceProperties#source

interface KeyResourceProperties

KeyResource.

interfaceKeyResultProperties#source

interface KeyResultProperties

A measurable result under an objective.

interfaceKnowledgeBaseArticleProperties#source

interface KnowledgeBaseArticleProperties

Knowledge base article.

interfaceLaunchProperties#source

interface LaunchProperties

Launch entity.

interfaceLeadProperties#source

interface LeadProperties

Lead.

interfaceLearningPathProperties#source

interface LearningPathProperties

Learning path.

interfaceLearningProperties#source

interface LearningProperties

Result of an experiment.

interfaceLegalEntityProperties#source

interface LegalEntityProperties

Legal entity.

interfaceLibraryDependencyProperties#source

interface LibraryDependencyProperties

Library or package dependency.

interfaceLocaleConfigProperties#source

interface LocaleConfigProperties

Locale configuration.

interfaceLocaleProperties#source

interface LocaleProperties

Locale.

interfaceMarketingCampaignPlanProperties#source

interface MarketingCampaignPlanProperties

Marketing campaign plan.

interfaceMarketingChannelProperties#source

interface MarketingChannelProperties

Marketing channel.

interfaceMarketingStrategyProperties#source

interface MarketingStrategyProperties

Marketing strategy.

interfaceMarketplaceListingProperties#source

interface MarketplaceListingProperties

Marketplace listing.

interfaceMarketSegmentProperties#source

interface MarketSegmentProperties

MarketSegment entity.

interfaceMarketTrendProperties#source

interface MarketTrendProperties

Market trend.

interfaceMessagingProperties#source

interface MessagingProperties

Messaging entity.

interfaceMetricDataPoint#source

interface MetricDataPoint

A time-series reading for a metric.

interfaceMetricProperties#source

interface MetricProperties

Unified metric.

interfaceMetricQualityAssessmentProperties#source

interface MetricQualityAssessmentProperties

A point-in-time review of a metric's quality and fitness for purpose.

interfaceMilestoneProperties#source

interface MilestoneProperties

Milestone.

interfaceMissionProperties#source

interface MissionProperties

Mission entity.

interfaceModelComparisonProperties#source

interface ModelComparisonProperties

Model comparison.

interfaceModifiedProperty#source

interface ModifiedProperty

One modified property, located by entity type + top-level property name.

interfaceMonitorProperties#source

interface MonitorProperties

Monitor.

interfaceNeedProperties#source

interface NeedProperties

Unified need.

interfaceNpsCampaignProperties#source

interface NpsCampaignProperties

NPS (Net Promoter Score) measurement campaign.

interfaceObjectionProperties#source

interface ObjectionProperties

Objection entity.

interfaceObjectiveProperties#source

interface ObjectiveProperties

A high-level strategic goal.

interfaceObservationProperties#source

interface ObservationProperties

Discrete observation captured during research.

interfaceOnCallRotationProperties#source

interface OnCallRotationProperties

On-call rotation.

interfaceOperatingLifecycleProperties#source

interface OperatingLifecycleProperties

An operating_lifecycle: a canonical, ordered (often cyclic) operating process that many products' journey phases map onto — e.g.

interfaceOperatingStageProperties#source

interface OperatingStageProperties

An operating_stage: one ordered stage of an `operating_lifecycle`.

interfaceOpportunityProperties#source

interface OpportunityProperties

Opportunity carries no intrinsic scalar properties: it is defined by its title/description and its edges (to the problems/needs it addresses and the solutions proposed against it).

interfaceOrganizationProperties#source

interface OrganizationProperties

Organization entity.

interfaceOutcomeProperties#source

interface OutcomeProperties

A measurable change in user or business state the product drives.

interfaceParticipantProperties#source

interface ParticipantProperties

Research participant.

interfacePartnerProgramProperties#source

interface PartnerProgramProperties

Partner program.

interfacePartnerRevenueShareProperties#source

interface PartnerRevenueShareProperties

Partner revenue share.

interfacePartnershipProperties#source

interface PartnershipProperties

Partnership.

interfacePartnerTierProperties#source

interface PartnerTierProperties

Partner tier.

interfacePaywallProperties#source

interface PaywallProperties

Paywall.

interfacePenetrationTestProperties#source

interface PenetrationTestProperties

Penetration test.

interfacePersonaProperties#source

interface PersonaProperties

User archetype representing a distinct group of users.

interfacePersonProperties#source

interface PersonProperties

Person entity.

interfacePipelineSalesProperties#source

interface PipelineSalesProperties

Sales pipeline.

interfacePipelineStageProperties#source

interface PipelineStageProperties

Pipeline stage.

interfacePlanningCycleProperties#source

interface PlanningCycleProperties

Planning cycle: a named, dated interval work flows through, which nests.

interfacePlaybookProperties#source

interface PlaybookProperties

Customer success playbook.

interfacePortfolioProperties#source

interface PortfolioProperties

Portfolio entity.

interfacePositioningProperties#source

interface PositioningProperties

Positioning entity.

interfacePostmortemProperties#source

interface PostmortemProperties

Postmortem.

interfacePressReleaseProperties#source

interface PressReleaseProperties

Press release.

interfacePricingStrategyProperties#source

interface PricingStrategyProperties

Pricing strategy.

interfacePricingTierProperties#source

interface PricingTierProperties

PricingTier: the central pricing concept (the plan a customer buys).

interfacePrimitiveProperties#source

interface PrimitiveProperties

A foundational compositional unit a specification defines: the noun products pass around and compose with (a Portable Text block, a Sanity reference, a Git commit, a Stripe PaymentIntent).

interfacePrivacyPolicyProperties#source

interface PrivacyPolicyProperties

interfaceProductAreaProperties#source

interface ProductAreaProperties

ProductArea entity.

interfaceProductProperties#source

interface ProductProperties

The product being created.

interfaceProgramProperties#source

interface ProgramProperties

Program.

interfaceProjectProperties#source

interface ProjectProperties

Project.

interfacePromptTemplateProperties#source

interface PromptTemplateProperties

Prompt template.

interfacePromptVersionProperties#source

interface PromptVersionProperties

Prompt version.

interfaceProofPointProperties#source

interface ProofPointProperties

ProofPoint entity.

interfacePropertyDefinition#source

interface PropertyDefinition

UPG Property Registry: Runtime schema for entity types AUTO-GENERATED by scripts/generate-property-registry.ts Do not edit manually.

interfacePrototypeProperties#source

interface PrototypeProperties

Prototype.

interfaceQaSessionProperties#source

interface QaSessionProperties

QA session.

interfaceQueueTopicProperties#source

interface QueueTopicProperties

Message queue or topic.

interfaceQuoteDocumentProperties#source

interface QuoteDocumentProperties

Quote document.

interfaceQuoteProperties#source

interface QuoteProperties

Verbatim quote from a participant.

interfaceReadModelProperties#source

interface ReadModelProperties

CQRS read model / projection.

interfaceRebuttalProperties#source

interface RebuttalProperties

Rebuttal entity.

interfaceRegionalPricingProperties#source

interface RegionalPricingProperties

Regional pricing.

interfaceRegressionTestProperties#source

interface RegressionTestProperties

Regression test.

interfaceReleaseProperties#source

interface ReleaseProperties

A shipped version or milestone of the product.

interfaceReleaseStrategyProperties#source

interface ReleaseStrategyProperties

Release strategy.

interfaceReportProperties#source

interface ReportProperties

Report entity.

interfaceResearchPlanProperties#source

interface ResearchPlanProperties

ResearchPlan entity.

interfaceResearchQuestionProperties#source

interface ResearchQuestionProperties

Research question guiding a study.

interfaceResearchStudyProperties#source

interface ResearchStudyProperties

Structured user research activity.

interfaceResourceAllocationProperties#source

interface ResourceAllocationProperties

Resource allocation.

interfaceRetrospectiveProperties#source

interface RetrospectiveProperties

Retrospective entity.

interfaceRevenueStreamProperties#source

interface RevenueStreamProperties

RevenueStream.

interfaceReviewGateProperties#source

interface ReviewGateProperties

Review gate.

interfaceRiskProperties#source

interface RiskProperties

Risk.

interfaceRiskRegisterProperties#source

interface RiskRegisterProperties

Risk register.

interfaceRoadmapItemProperties#source

interface RoadmapItemProperties

Roadmap item.

interfaceRoadmapProperties#source

interface RoadmapProperties

Product roadmap.

interfaceRoadmapThemeProperties#source

interface RoadmapThemeProperties

Thematic grouping of roadmap work, around the customer problem it solves.

interfaceRoleProperties#source

interface RoleProperties

Role entity.

interfaceRootCauseProperties#source

interface RootCauseProperties

Underlying architectural or systemic issue.

interfaceRunbookProperties#source

interface RunbookProperties

Runbook.

interfaceSalesMotionProperties#source

interface SalesMotionProperties

SalesMotion entity.

interfaceScreenProperties#source

interface ScreenProperties

Screen in the product.

interfaceScreenStateProperties#source

interface ScreenStateProperties

Specific state of a screen.

interfaceSecurityAuditProperties#source

interface SecurityAuditProperties

Security audit.

interfaceSecurityControlProperties#source

interface SecurityControlProperties

Security control.

interfaceSecurityPolicyProperties#source

interface SecurityPolicyProperties

Security policy.

interfaceSecurityReviewProperties#source

interface SecurityReviewProperties

Security review.

interfaceSeoKeywordProperties#source

interface SeoKeywordProperties

SEO keyword.

interfaceServiceBlueprintProperties#source

interface ServiceBlueprintProperties

Service blueprint.

interfaceServiceLevelAgreementProperties#source

interface ServiceLevelAgreementProperties

Service-level agreement (SLA).

interfaceServiceLevelIndicatorProperties#source

interface ServiceLevelIndicatorProperties

Service Level Indicator.

interfaceServiceLevelObjectiveProperties#source

interface ServiceLevelObjectiveProperties

Service Level Objective.

interfaceServiceProperties#source

interface ServiceProperties

Service or microservice.

interfaceSkillProperties#source

interface SkillProperties

Skill entity.

interfaceSocialPostProperties#source

interface SocialPostProperties

Social media post.

interfaceSolutionProperties#source

interface SolutionProperties

A proposed response to an opportunity const properties: SolutionProperties = { timeline: 'Kickoff 2026-04-22, results by 2026-05-15.', } RICE scoring inputs (`reach`, `impact`, `confidence`, `effort`) and the computed `rice_score` were framework-scoped from 0.9.0 and removed from the schema in 0.14.0 (UPG-574): apply the `rice-scoring` framework and read the score off the `framework_exercise` includes-edge, not the entity.

interfaceSpecificationProperties#source

interface SpecificationProperties

A governed specification: a query language, protocol, data format, encoding, or interface contract that one or more products implement, expose, or conform to.

interfaceStakeholderProperties#source

interface StakeholderProperties

Stakeholder entity.

interfaceStatusReportProperties#source

interface StatusReportProperties

Status report.

interfaceStrategicPillarProperties#source

interface StrategicPillarProperties

StrategicPillar entity.

interfaceStrategicQuestionProperties#source

interface StrategicQuestionProperties

StrategicQuestion entity.

interfaceStrategicThemeProperties#source

interface StrategicThemeProperties

StrategicTheme entity.

interfaceSubscriptionProperties#source

interface SubscriptionProperties

Subscription.

interfaceSuccessMilestoneProperties#source

interface SuccessMilestoneProperties

Customer success milestone.

interfaceSupportTicketProperties#source

interface SupportTicketProperties

Support ticket.

interfaceSurveyResponseProperties#source

interface SurveyResponseProperties

Aggregated survey response data.

interfaceSwitchingCostProperties#source

interface SwitchingCostProperties

SwitchingCost entity.

interfaceSymptomProperties#source

interface SymptomProperties

Observable behaviour produced by a root cause.

interfaceTargetCustomerSegmentProperties#source

interface TargetCustomerSegmentProperties

TargetCustomerSegment.

interfaceTaskProperties#source

interface TaskProperties

Task: a discrete unit of work, smaller than a story.

interfaceTeamOkrProperties#source

interface TeamOkrProperties

TeamOkr entity.

interfaceTeamProperties#source

interface TeamProperties

Team entity.

interfaceTechnicalDebtItemProperties#source

interface TechnicalDebtItemProperties

Technical debt item.

interfaceTerritoryProperties#source

interface TerritoryProperties

Territory entity.

interfaceTestCaseProperties#source

interface TestCaseProperties

Test case.

interfaceTestCoverageReportProperties#source

interface TestCoverageReportProperties

Test coverage report.

interfaceTestEnvironmentProperties#source

interface TestEnvironmentProperties

Test environment.

interfaceTestPlanProperties#source

interface TestPlanProperties

Test plan: the QA verification procedure for a product or release.

interfaceTestResultProperties#source

interface TestResultProperties

Single test execution result.

interfaceTestSuiteProperties#source

interface TestSuiteProperties

Test suite.

interfaceThreatModelProperties#source

interface ThreatModelProperties

Threat model.

interfaceThreatProperties#source

interface ThreatProperties

Threat.

interfaceTouchpointProperties#source

interface TouchpointProperties

Customer touchpoint.

interfaceTranslationBundleProperties#source

interface TranslationBundleProperties

Translation bundle.

interfaceTranslationKeyProperties#source

interface TranslationKeyProperties

Translation key.

interfaceTrialConfigProperties#source

interface TrialConfigProperties

Trial configuration.

interfaceTutorialProperties#source

interface TutorialProperties

Tutorial.

interfaceUnitEconomicsProperties#source

interface UnitEconomicsProperties

UnitEconomics.

interfaceUPGAssessment#source

interface UPGAssessment

An assessment is a human judgment mapped to a numeric scale.

interfaceUPGPropertyMap#source

interface UPGPropertyMap

Type-safe lookup from entity type string to its property interface.

interfaceUserAdvisoryBoardProperties#source

interface UserAdvisoryBoardProperties

User advisory board.

interfaceUserFlowProperties#source

interface UserFlowProperties

User flow.

interfaceUserJourneyProperties#source

interface UserJourneyProperties

User journey map.

interfaceUserStoryProperties#source

interface UserStoryProperties

"As X, I want Y so Z" templated promise on a user story (UCS pattern P5).

interfaceValueObjectProperties#source

interface ValueObjectProperties

DDD value object.

interfaceValuePropositionProperties#source

interface ValuePropositionProperties

ValueProposition.

interfaceValueStreamProperties#source

interface ValueStreamProperties

ValueStream entity.

interfaceVariantProperties#source

interface VariantProperties

Variant entity.

interfaceVisionProperties#source

interface VisionProperties

Vision entity.

interfaceVulnerabilityProperties#source

interface VulnerabilityProperties

Vulnerability.

interfaceWalkthroughProperties#source

interface WalkthroughProperties

Product walkthrough.

interfaceWebinarProperties#source

interface WebinarProperties

Webinar.

interfaceWireframeProperties#source

interface WireframeProperties

Wireframe.

interfaceWorkflowArtifactProperties#source

interface WorkflowArtifactProperties

Workflow artifact.

interfaceWorkflowRunProperties#source

interface WorkflowRunProperties

Workflow run.

interfaceWorkflowTemplateProperties#source

interface WorkflowTemplateProperties

Workflow template.

interfaceWorkspaceProperties#source

interface WorkspaceProperties

Workspace: a spatial thinking space for arranging entities.

Functions

functiongetEntityModifierSummary#source

(entityType: string) => Record<PropertyModifier, string[]> | undefined

The modifiers an entity type carries, grouped by kind — `undefined` when the entity has no modified properties.

functiongetPropertyModifier#source

(entityType: string, property: string) => PropertyModifier | undefined

The modifier on a single property, or `undefined` if it is plain/authored.

functiongetPropertySchema#source

(entityType: string) => PropertySchema | undefined

Get the property schema for an entity type.

functionisAggregateShapedProperty#source

(name: string, def: PropertyDefinition) => boolean

Aggregate shape (Pattern B): a numeric count/rollup derivable from edges or children.

functionisRecordEntity#source

(entityType: string) => boolean

Whether an entity legitimately holds live/aggregate values (a record, not a definition).

functionisRuntimeStateShapedProperty#source

(name: string, def: PropertyDefinition) => boolean

Runtime-state shape (Pattern A): a numeric live reading — a rate, percentage, current value, remaining budget, latency percentile, monthly figure, or per-unit rate.

functionlistPropertiesByModifier#source

(modifier?: PropertyModifier) => ModifiedProperty[]

Enumerate every property in the catalog that carries a modifier, optionally filtered to one modifier kind.

functionvalidateEdgeProperties#source

(edgeType: string, properties: Record<string, unknown> | undefined) => string[]

Validate an edge's `properties` bag against its catalog `property_schema`.