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

Playbooks

v0.4 region-anchored bootstrap sequences.

47 exports · 24 const · 5 type · 11 interface · 7 fn

Since v0.4.0

Quick import

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

Example

// Region-anchored playbooks scaffold a graph from cold start
import { BUSINESS_GTM_GROWTH_PLAYBOOK } from '@unified-product-graph/core/playbooks'

console.log(BUSINESS_GTM_GROWTH_PLAYBOOK.region)
// → 'business_gtm_growth' — the canonical region this playbook anchors to

Often used with:regions approaches

47 exports

v0.4 region-anchored bootstrap sequences. The 23 playbooks that scaffold a graph from cold start, each anchored to one of the 10 canonical regions. Helpers getPlaybookById, getCanonicalPlaybookForRegion, and getPlaybooksForRegion are the runtime API the MCP list_playbooks and get_playbook tools consume.

Exports

Constants

constANALYTICS_DATA_PLAYBOOK#source

UPGPlaybook

constBUSINESS_GROWTH_FUNNEL_PLAYBOOK#source

UPGPlaybook

constBUSINESS_GROWTH_METRIC_DRIVEN_PLAYBOOK#source

UPGPlaybook

constBUSINESS_GTM_GROWTH_PLAYBOOK#source

UPGPlaybook

constBUSINESS_MARKETING_AUDIENCE_FIRST_PLAYBOOK#source

UPGPlaybook

constBUSINESS_MARKETING_PLAYBOOK#source

UPGPlaybook

constBUSINESS_MODEL_BMC_PLAYBOOK#source

UPGPlaybook

constBUSINESS_PRICING_PLAYBOOK#source

UPGPlaybook

constDISCOVERY_RESEARCH_VALIDATION_PLAYBOOK#source

UPGPlaybook

constDISCOVERY_VALIDATION_HYPOTHESIS_PLAYBOOK#source

UPGPlaybook

constENGINEERING_ARCHITECTURE_ONLY_PLAYBOOK#source

UPGPlaybook

constENGINEERING_PLATFORM_PLAYBOOK#source

UPGPlaybook

constEXPERIENCE_CONTENT_PLAYBOOK#source

UPGPlaybook

constEXPERIENCE_DESIGN_BRAND_PLAYBOOK#source

UPGPlaybook

constEXPERIENCE_DESIGN_SYSTEM_PLAYBOOK#source

UPGPlaybook

constEXPERIENCE_UX_DOMAIN_ONLY_PLAYBOOK#source

UPGPlaybook

constMARKET_COMPETITIVE_PLAYBOOK#source

UPGPlaybook

constOPERATIONS_QUALITY_PLAYBOOK#source

UPGPlaybook

constOPERATIONS_TEAM_RITUALS_PLAYBOOK#source

UPGPlaybook

constPRODUCT_DELIVERY_PLAYBOOK#source

UPGPlaybook

constPRODUCT_FEEDBACK_SYNTHESIS_PLAYBOOK#source

UPGPlaybook

constSTRATEGY_OUTCOMES_PLAYBOOK#source

UPGPlaybook

constUPG_PLAYBOOKS#source

readonly UPGPlaybook[]

constUSERS_NEEDS_PLAYBOOK#source

UPGPlaybook

Types

typeEntryMode#source

type EntryMode = 'domain' | 'stage' | 'gap' | 'framework'

How a playbook or technique is entered.

typeStep#source

type Step = | DomainGuideStep | FrameworkInvocationStep | EntitySequenceStep | SubSequenceStep

A single step in a playbook or technique, discriminated by `kind`.

typeStepKind#source

type StepKind = 'domain_guide' | 'framework' | 'entity_sequence' | 'sub_sequence'

Discriminator for step behaviour.

typeStepOutputKind#source

type StepOutputKind = | 'entities_created' | 'entities_updated' | 'response' | 'skipped'

What a step produced when recorded.

typeSurfaceId#source

type SurfaceId = 'cli' | 'entopo' | 'mcp_tool' | (string & {})

Surface identifier.

Interfaces

interfaceDomainGuideStep#source

interface DomainGuideStep

Step that defers to a domain's `DomainUsageGuide.creation_sequence`.

interfaceEntitySequenceStep#source

interface EntitySequenceStep

Step that creates entities of an explicit, fixed list of types.

interfaceFrameworkInvocationStep#source

interface FrameworkInvocationStep

Step that applies a named framework.

interfacePlaybookBinding#source

interface PlaybookBinding

Per-surface experience binding for a `UPGPlaybook`.

interfacePlaybookFilter#source

interface PlaybookFilter

Narrowing filter for `listPlaybooks`.

interfacePlaybookRun#source

interface PlaybookRun

A concrete execution of a `UPGPlaybook`.

interfacePlaybookRuntime#source

interface PlaybookRuntime

The minimum interface a playbook runtime must expose.

interfaceRunContext#source

interface RunContext

Runtime context handed to `startRun`.

interfaceStepOutput#source

interface StepOutput

The runtime record of what a single step produced.

interfaceSubSequenceStep#source

interface SubSequenceStep

Step that chains into a nested playbook or technique.

interfaceUPGPlaybook#source

interface UPGPlaybook

The canonical playbook primitive.

Functions

functiongetCanonicalPlaybookForRegion#source

(region: UPGRegionId) => UPGPlaybook | null

Return the single canonical playbook for a region (the "start here" path).

functiongetPlaybookById#source

(id: string) => UPGPlaybook | undefined

Look up a canonical playbook shipped with `@unified-product-graph/core` by id.

functiongetPlaybooksForRegion#source

(region: UPGRegionId) => readonly UPGPlaybook[]

Return every playbook (canonical + specialised) anchored at a region.

functionisDomainGuideStep#source

(step: Step) => boolean

functionisEntitySequenceStep#source

(step: Step) => boolean

functionisFrameworkInvocationStep#source

(step: Step) => boolean

functionisSubSequenceStep#source

(step: Step) => boolean