Skip to content

StoryShelf

Docs Packages HTTP API

GitHub

Select theme

Docs Packages HTTP API

← Back to docs
Overview
Core
- @storyshelf/core
  - Overview
  - API
    
    adapters/capture-queue
    
    Interfaces
    
    CaptureJob
    CaptureQueue
    PollableCaptureQueue
    PollableJob
    QueueEntry
    
    Type Aliases
    
    JobStatus
    LeaseRenewal
    
    adapters/capture-runner
    
    Classes
    
    RenderRuns
    TargetLaunchError
    
    Interfaces
    
    CaptureEnvironment
    CaptureRunner
    ParsedTarget
    RemoteBrowser
    RemoteConnection
    RemoteOptions
    RemoteSupport
    RemoteTarget
    RenderedSnapshot
    RenderFailure
    RenderResult
    RunnerTarget
    StoryEntry
    StorySourceAdapter
    TargetOffers
    TestOutcome
    Viewport
    
    Type Aliases
    
    BrowserName
    CaptureTarget
    RemoteProtocol
    TargetReach
    TargetStatus
    
    Variables
    
    BROWSER_NAMES
    DEFAULT_BROWSER
    TARGET_NAME_PATTERN
    
    Functions
    
    createTargetOffers
    defineRemote
    engineOf
    isBrowserName
    isCaptureTarget
    isRemoteBrowser
    parseTarget
    reachOf
    remoteTargetsOf
    scrubConnection
    tryParseTarget
    unavailableReason
    
    References
    
    JobStatus
    
    adapters/database
    
    Interfaces
    
    DatabaseAdapter
    DatabaseAdapterMetadata
    DrizzleAdapterOptions
    ListOptions
    Tables
    TxStore
    
    Variables
    
    MAX_LIST_LIMIT
    REQUIRED_TABLE_KEYS
    
    Functions
    
    clampListLimit
    
    adapters/design
    
    Classes
    
    InvalidDesignUrlError
    
    Interfaces
    
    DesignAdapterMetadata
    DesignCallOptions
    DesignClient
    DesignMeta
    DesignProvider
    DesignRef
    
    Type Aliases
    
    DesignAuthType
    DesignState
    
    Functions
    
    parseDesignUrl
    
    adapters/email-sender
    
    Interfaces
    
    EmailMessage
    EmailSender
    
    adapters/metadata
    
    Interfaces
    
    Adapter
    AdapterHealth
    AdapterLifecycle
    AdapterMetadata
    AdapterSetupContext
    
    Type Aliases
    
    AdapterCategory
    
    adapters/notifier
    
    Interfaces
    
    BuildStateBuild
    BuildStateChange
    BuildStateFlags
    BuildStateInput
    BuildStateSet
    ChannelOutcome
    ChannelToggles
    DesiredComment
    DesiredStatus
    FormattedNotification
    MessageNotifierAdapter
    MessageNotifierMetadata
    MessageNotifierProvider
    NotificationBrand
    NotificationChannel
    NotificationEvent
    NotifierMetadata
    SetStateInput
    StateAnnotation
    StateNotifierAdapter
    StateNotifierMetadata
    StateNotifierProvider
    SystemNotification
    
    Type Aliases
    
    NotifierAdapter
    NotifierDelivery
    NotifierProvider
    NotifierState
    NotifierStateTarget
    PublishingState
    StatusName
    SystemEventName
    
    Variables
    
    DEFAULT_STATUS_PREFIX
    MAX_ANNOTATIONS
    
    Functions
    
    buildCommentMarkdown
    channelPrefix
    emitNotifications
    emitSystemNotification
    formatNotification
    formatSystemNotification
    isStateProvider
    statusesForBuild
    writeBuildState
    
    adapters/oauth
    
    Interfaces
    
    OAuthClient
    OAuthConnectable
    OAuthTokens
    
    adapters/setup
    
    Classes
    
    AdapterLifecycleError
    
    Interfaces
    
    AdapterSetupFailure
    AdapterSetupResult
    AdapterSetupSources
    HookEntry
    
    Type Aliases
    
    LifecyclePhase
    
    Functions
    
    adapterSourcesOf
    bindAdapterLoggers
    collectSetups
    collectTeardowns
    runAdapterSetups
    runAdapterTeardowns
    validateAdapter
    validateAdapterSources
    validateAuth
    validateBootAssembly
    
    adapters/storage
    
    Interfaces
    
    StorageAdapter
    
    adapters/webhook-events
    
    Interfaces
    
    WebhookEvent
    
    Functions
    
    emitWebhookEvent
    
    ai
    
    Classes
    
    AiError
    
    Interfaces
    
    Ai
    AiBudget
    AiEvidence
    AiHealth
    AiImage
    AiSummarizeInput
    AiSummarizeResult
    AiUsageReport
    
    Type Aliases
    
    AiErrorCode
    AiTask
    
    auth
    
    Interfaces
    
    Auth
    EngineLoginMethod
    EnginePasskeyInfo
    EngineSessionInfo
    
    Type Aliases
    
    EngineLoginMethodKind
    
    Variables
    
    MIN_PASSWORD_LENGTH
    
    Functions
    
    unsignedToken
    
    capture
    
    Classes
    
    ProgressLease
    StorybookAdapter
    ZipLimitError
    
    Interfaces
    
    A11yRunPlan
    AfterPublishContext
    BoundingBox
    BuildStateDeps
    BuildStatePublisher
    BuildStatePublisherOptions
    CaptureAttemptRef
    CaptureConsumer
    CaptureConsumerOptions
    CaptureContext
    CaptureDispatchJob
    CaptureHandlerOptions
    CaptureJobInput
    CaptureJobOptions
    Catalog
    CatalogComponent
    CatalogDeps
    CatalogEntry
    CatalogLoader
    CatalogLoaderOptions
    ChildHost
    ChildProcessHandle
    ComponentBuildRow
    ConsumerConfig
    ConsumerMetrics
    DatabaseCaptureQueue
    DatabaseCaptureQueueOptions
    DatabaseJob
    DispatchDeps
    EntryChanges
    EnvironmentChange
    ExtractionLimits
    ExtractionResult
    Fingerprint
    ForkedCaptureHandler
    ForkedCaptureOptions
    ForkHost
    ForkOptions
    JobFinishedEvent
    JobLease
    JobLeaseKeeper
    JobRunContext
    KindHandler
    LeaseKeeperOptions
    ModeDefinition
    NotifyFailure
    NotifyHandlerOptions
    NotifyJobQueue
    ParentPort
    PollCadence
    PollLoop
    PollLoopOptions
    PublishCompleter
    PublishCompleterOptions
    PublishFacts
    PublishHandlerOptions
    PublishLimits
    PublishZipOptions
    QueueJobInput
    QueueSample
    RediffDeps
    RediffResult
    RetryConfig
    ScratchSweepOptions
    ScreenshotPlan
    SizingOptions
    SlimViolation
    StateTarget
    StoryParameters
    StoryViewportConfig
    StoryViewportDefinition
    TargetPrerequisites
    TestResult
    TestSummary
    
    Type Aliases
    
    AfterPublishHook
    CaptureChildOptions
    ChildMessage
    ComponentChange
    ConsumerJob
    CrashFailureOutcome
    ForkDecision
    JobHandlers
    JobOutcome
    LeaseEnd
    ModeMap
    ModeViewportValue
    ParentMessage
    PublishOutcome
    SkipReason
    StorybookUrlSource
    
    Variables
    
    A11Y_ROOT_SELECTOR
    ACTIVE_POLL_MS
    ACTIVE_WINDOW_MS
    CANCEL_CHECK_MS
    CAPTURE_RETRIES_ENV
    CAPTURE_SHARD_SIZE_ENV
    CAPTURE_WORKER_ROLE
    DATABASE_QUEUE_METADATA
    DEFAULT_BACKOFF_MS
    DEFAULT_CADENCE
    DEFAULT_CATALOG_CACHE_SIZE
    DEFAULT_LEASE_MS
    DEFAULT_MAX_INLINE_UNZIP_SIZE
    DEFAULT_MAX_RETRIES
    DEFAULT_MAX_UNZIPPED_BYTES
    DEFAULT_MAX_ZIP_ENTRIES
    DEFAULT_RETRIES
    DEFAULT_SAMPLE_MS
    DEFAULT_VIEWPORTS
    DEFAULT_WAIT_TIME_SECONDS
    FILE_BY_FILE_HINT
    FORK_MIN_CPUS
    FORK_MIN_MEMORY_BYTES
    IDLE_POLL_MS
    LEASE_EXHAUSTED_ERROR
    MAX_BACKOFF_MS
    MAX_BROWSERS
    MAX_MODES_PER_STORY
    MAX_NACK_DELAY_MS
    MAX_REPORTED_VIOLATIONS
    MIN_BLOCKING_POLL_MS
    NO_ORIGIN_REASON
    NO_SECRET_REASON
    NOTIFY_BACKOFF
    NOTIFY_MAX_ATTEMPTS
    PAUSED_MESSAGE
    POLL_JITTER
    PUBLISH_SCRATCH_ID
    REDIFFABLE_BUILD_STATUSES
    RENEW_THROTTLE_MS
    SCRATCH_DIRNAME
    SCRATCH_MAX_AGE_MS
    SIZING_DEFAULTS
    STORYBOOK_BUILTIN_VIEWPORTS
    
    Functions
    
    assertBrowserCount
    assertSupportedBrowsers
    axeInjectionScript
    backoffDelayMs
    buildFingerprint
    buildGlobalsParam
    buildScratchDir
    canForkCaptureChild
    captureDispatchDeps
    catalogPresence
    catalogueBuild
    changedFields
    componentBuildHistory
    createBuildStatePublisher
    createCaptureConsumer
    createCaptureHandler
    createCatalogHook
    createCatalogLoader
    createDatabaseCaptureQueue
    createDispatchJob
    createForkedCaptureHandler
    createNotifyEnqueuer
    createNotifyHandler
    createPublishCompleter
    createPublishHandler
    decideCaptureProcess
    deliverBuildState
    diffEntries
    executeCaptureJob
    extractionLimitsOf
    extractStorybookToScratch
    extractZipStream
    failCrashedCapture
    filterModes
    fingerprintHash
    forkCaptureChild
    getScreenshotPlan
    groupComponents
    hashEntries
    idleDelayMs
    inPageReadA11yParameters
    inPageRunAxe
    isDisabledStory
    isFastEmptyPoll
    isFinalAttempt
    isFlakyStory
    keepJobLease
    listTargets
    loadAxeSource
    loadBuild
    mapAxeViolations
    mergeParameters
    modeSlug
    nextPollDelay
    notifyExhausted
    offeredTargets
    parseBrowsers
    parseFingerprint
    parseModesAllowlist
    parseStorybookIndex
    parseStorybookIndexText
    parseTestResults
    persistCapture
    persistStorybookStatics
    primaryTargetOf
    publishingOf
    publishRoute
    publishStoredZip
    publishVerdict
    readCatalog
    readPublishedFile
    rediffBuild
    refusalFor
    removeBuildScratch
    removeJobScratch
    requestOpenBuildStates
    resolveA11yRun
    resolveBrowsers
    resolveCaptureViewports
    resolvePublishLimits
    resolveStoryViewports
    runCaptureChild
    sampleQueue
    startPollLoop
    stateTargets
    storybookUrlSource
    summarizeTests
    sweepOrphanedScratch
    toBuildComponent
    writeTo
    
    References
    
    LeaseRenewal
    PollableCaptureQueue
    PollableJob
    StoryEntry
    StorySourceAdapter
    Viewport
    
    config
    
    Interfaces
    
    AdapterSnapshot
    AuthUiConfig
    BrandTheme
    NotificationsConfig
    ObservabilityHandle
    ShelfCompareOptions
    ShelfConfig
    ShelfImagesOptions
    ShelfNotificationsOptions
    ShelfOptions
    ShelfTestingOptions
    ShelfViewport
    UIConfig
    
    Variables
    
    ALLOW_SERVERLESS_ENV
    DEFAULT_MAX_UPLOAD_BYTES
    DEFAULT_SCRATCH_DIR
    notificationsConfigSchema
    shelfConfigSchema
    uiConfigSchema
    
    Functions
    
    assertServerless
    isServerlessHost
    resolveShelfOptions
    validateConfig
    validateUiConfig
    
    diff
    
    Interfaces
    
    DiffOptions
    DiffResult
    
    Type Aliases
    
    ImageEngine
    
    Variables
    
    DEFAULT_DIFF_OPTIONS
    DIFF_WORKERS_ENV
    IMAGE_ENGINE_ENV
    
    Functions
    
    configureDiffPool
    configureImages
    diffImages
    diffImagesAsync
    shutdownDiffPool
    verifyImageEngine
    
    insights
    
    Interfaces
    
    BuildSummary
    BuiltEvidence
    EvidenceLimits
    HealthEvidenceInput
    InputHashParts
    SnapshotEvidence
    TriageEvidenceInput
    
    Type Aliases
    
    HealthEnvelope
    TriageEnvelope
    
    Variables
    
    BUDGET_THRESHOLDS
    DEFAULT_EVIDENCE_LIMITS
    HEALTH_SYSTEM
    healthEnvelopeSchema
    PROMPT_VERSION
    TRIAGE_SYSTEM
    triageEnvelopeSchema
    
    Functions
    
    buildHealthEvidence
    buildTriageEvidence
    computeInputHash
    countedTokens
    crossedThresholds
    rankSnapshots
    redactText
    resolveLimits
    snapshotKey
    utcDay
    utcDayStart
    
    logger
    
    Interfaces
    
    LoggerOptions
    PinoTransport
    
    Functions
    
    createShelfLogger
    
    References
    
    Logger
    
    models
    
    Classes
    
    AiBudgetAlertModel
    AiUsageModel
    BaselineArchiveError
    BaselineModel
    BaselineTransferModel
    BuildComponentModel
    BuildModel
    BuildReviewModel
    CaptureAttemptModel
    CaptureJobModel
    CaptureLogModel
    CaptureShardModel
    CommentModel
    ConnectionModel
    ContentRefModel
    DesignCredentialModel
    DesignModel
    DesignNodeModel
    InsightModel
    LabelModel
    MemberModel
    NotificationChannelModel
    NotificationSubscriptionModel
    PackageUsageModel
    ProjectGroupMappingModel
    ProjectModel
    SiteSettingsModel
    SnapshotModel
    TokenModel
    UserModel
    WebhookModel
    
    Interfaces
    
    AiBudgetAlertTables
    AiUsageInput
    AiUsageTables
    AttemptClaim
    BaselineExportOptions
    BaselineImportResult
    BuildChangeset
    BuildComponentTables
    BuildCreateInput
    BuildListFilter
    BuildReviewTables
    CaptureAttemptTables
    CaptureJobTables
    CaptureLogTables
    CaptureShardTables
    ChangedComponent
    Changeset
    CommentCreateInput
    ComponentHistoryRow
    ConnectionTables
    CredentialProbe
    DesignCredentialTables
    DesignNodeTables
    DesignResolution
    DesignTables
    InheritedRatio
    InsightResultInput
    InsightStartInput
    InsightStartResult
    InsightTables
    NewCaptureJob
    NotificationChannelCreateInput
    NotificationChannelTables
    NotificationSubscriptionInput
    NotificationSubscriptionTables
    PackageUsageInput
    PackageUsageTables
    ProjectCreateInput
    PublicOriginOptions
    PublicOriginResolver
    ReencryptResult
    RefreshOptions
    ResolvedPublicOrigin
    ReviewStatusInput
    SiteSettingsTables
    SnapshotCreateInput
    StoredPublicOrigin
    UnreadableCredential
    UpstreamStory
    WebhookCreateInput
    
    Type Aliases
    
    AttemptLogRecorder
    BaselineManifest
    BaselineManifestEntry
    BaselineStatus
    BuildComponentInput
    ChangesetComponent
    ChannelValidation
    ComponentPresence
    DesignCredentialStatus
    DesignSource
    PublicOriginSource
    
    Variables
    
    BASELINE_ARCHIVE_FORMAT
    BASELINE_ARCHIVE_LIMITS
    BASELINE_ARCHIVE_VERSION
    DESIGN_TTL_MS
    NO_BASELINE
    PROJECT_SCOPE
    PUBLIC_ORIGIN_KEY
    RECENT_BUILDS_FOR_INHERITED_RATIO
    TERMINAL_JOB_STATUSES
    
    Functions
    
    acceptPendingWithoutWork
    attemptRowId
    averageInheritedRatio
    baselineStatus
    changesetOf
    componentHistory
    componentPresence
    computeChangeset
    createPublicOriginResolver
    credentialDaysLeft
    deriveReviewStatus
    emitAttemptLog
    findChangesetBaseline
    isBaselineDrifted
    isDesignStale
    isPublicBuild
    isTerminalJob
    latestVerdicts
    matchUpstreamStory
    normalizeImportPath
    parseAttemptRowId
    probeCredentials
    reencryptCredentials
    resolveDesigns
    worstStatus
    
    Overview
    
    References
    
    AdapterSnapshot
    BrandTheme
    BUILD_STATUSES
    BuildStatus
    createShelfLogger
    DEFAULT_MAX_UPLOAD_BYTES
    LoggerOptions
    PinoTransport
    ProjectRole
    ShelfConfig
    shelfConfigSchema
    ShelfOptions
    ShelfViewport
    SiteRole
    SNAPSHOT_STATUSES
    SnapshotStatus
    TERMINAL_BUILD_STATUSES
    UIConfig
    uiConfigSchema
    validateConfig
    validateUiConfig
    
    retention/purge
    
    Classes
    
    Retention
    
    Interfaces
    
    AiPurgeResult
    BranchGcResult
    PurgeOptions
    PurgeResult
    RetentionTables
    SweepDeps
    SweepResult
    SweepTables
    
    Variables
    
    STALE_RUN_MS
    SWEEP_GRACE_MS
    
    Functions
    
    purgeAiData
    sweepScreenshotContent
    
    schema
    
    Interfaces
    
    AiBudgetAlertRow
    AiUsageRow
    Baseline
    Build
    BuildComponent
    BuildLabel
    BuildPackageUsage
    BuildReview
    CaptureAttempt
    CaptureJobRow
    CaptureLog
    CaptureShard
    Comment
    DesignCredential
    DesignLink
    DesignNode
    InsightRow
    LabelType
    NotificationChannelRow
    NotificationSubscriptionRow
    Project
    ProjectGroupMapping
    ProjectLink
    ProjectMember
    SiteSetting
    Snapshot
    StorybookMeta
    Token
    User
    UserConnection
    Webhook
    
    Type Aliases
    
    CaptureAttemptStatus
    CaptureJobEntry
    CaptureJobKind
    CaptureJobStatus
    CaptureLogLevel
    CaptureShardKind
    CaptureShardStatus
    InsightKind
    InsightStatus
    Schema
    
    types
    
    Interfaces
    
    AuthUser
    
    Type Aliases
    
    BuildStatus
    ProjectRole
    ReviewVerdict
    SiteRole
    SnapshotStatus
    
    Variables
    
    BUILD_STATUSES
    CANCELLABLE_BUILD_STATUSES
    PERSISTENT_LABEL_KEY
    PROJECT_ROLES
    RESERVED_LABEL_KEYS
    REVIEW_VERDICTS
    SEEDED_LABEL_KEYS
    SESSION_COOKIE
    SITE_ROLES
    SNAPSHOT_STATUSES
    TERMINAL_BUILD_STATUSES
    
    Functions
    
    isProjectRole
    
    urls
    
    Interfaces
    
    UrlBuilder
    
    Functions
    
    createUrlBuilder
    safeImageUrl
    
    utils
    
    Classes
    
    AdaptiveConcurrency
    HttpError
    UndecryptableCredentialError
    
    Interfaces
    
    AdaptiveOptions
    BrowserProbe
    CaptureHostSummary
    HostResources
    HttpRequestOptions
    HttpTextOptions
    Observation
    PageLimiter
    PageLimiterOptions
    RetryConnectOptions
    SecretKeys
    SessionGate
    SignStorybookTokenInput
    StorybookTokenClaims
    ZipSource
    
    Type Aliases
    
    Env
    KeyUsed
    SecretInput
    StorybookTokenFailure
    StorybookTokenResult
    TimingMap
    
    Variables
    
    DEFAULT_RECYCLE_BROWSER_EVERY
    DEFAULT_STORYBOOK_URL_TTL
    FONT_PROBE_FAMILIES
    MAX_STORYBOOK_URL_TTL
    MIME_TYPES
    MIN_CAPTURES_PER_SLICE
    MIN_STORYBOOK_URL_TTL
    MIN_STORYBOOK_URL_TTL_OVERRIDE
    PER_CAPTURE_BUDGET_MS
    STORYBOOK_TOKEN_PREFIX
    STORYBOOK_TOKEN_SOURCE
    STORYBOOK_URL_TTL_GRACE
    
    Functions
    
    addTiming
    assertStorybookUrlTtl
    chunk
    createPageLimiter
    createSessionGate
    decrypt
    decryptCredential
    decryptWithKey
    describeCaptureHost
    describeSizing
    detectCaptureEnvironment
    detectPublicBaseUrl
    detectResources
    encrypt
    engineWeight
    hmacSha256
    httpBytes
    httpJson
    httpText
    inPageProbe
    isBlockedTarget
    isPathSafe
    isRetryableConnectError
    isSafeSegment
    isTimeoutError
    mapAdaptive
    mapLimit
    maxPageConcurrency
    mimeFor
    normalizeOrigin
    randomToken
    recommendedBuildConcurrency
    recommendedNavigationTimeoutMs
    recommendedPageConcurrency
    redactSecrets
    remoteEnvironment
    retryConnect
    roundedTimings
    runWithTimings
    sanitizeErrorText
    sessionGateFor
    sha256
    signStorybookToken
    slugify
    storeScreenshot
    storybookBase
    storybookTokenPath
    storybookUrlTtl
    storybookUrlTtlOverrideError
    systemFontsHash
    timed
    timingSafeEqualString
    ulid
    verifyStorybookToken
    zipStream
    
    References
    
    baselinePath
    catalogPath
    contentDir
    contentPath
    designRenderPath
    diffPath
    isContentPath
    modeSegment
    screenshotPath
    storybookDir
    storybookZipPath
    
    utils/paths
    
    Functions
    
    baselinePath
    catalogPath
    contentDir
    contentPath
    designRenderPath
    diffPath
    isContentPath
    modeSegment
    screenshotPath
    storybookDir
    storybookZipPath
- @storyshelf/app
  - Overview
  - API
    
    Interfaces
    
    BrandTheme
    LoggerOptions
    NotificationsConfig
    PinoTransport
    ShelfCompareOptions
    ShelfConfig
    ShelfContext
    ShelfLifecycle
    ShelfNotificationsOptions
    ShelfOptions
    ShelfTestingOptions
    UIConfig
    
    Type Aliases
    
    Logger
    ShelfApp
    ShelfRouter
    
    Functions
    
    createAuthSystemHook
    createShelfApp
    createShelfLogger
- @storyshelf/affected
  - Overview
  - API
    
    Interfaces
    
    AffectedInput
    AffectedResult
    DepGraph
    PackageUsage
    StoryLike
    StoryPartition
    TraceOptions
    TrackedPackage
    
    Type Aliases
    
    GitRepoStatus
    
    Variables
    
    LOCAL_BRANCH
    LOCAL_SHA_PREFIX
    MAX_CHANGED_FILES
    STATS_FILENAME
    
    Functions
    
    buildGraph
    changedFiles
    computeAffected
    extractPackageUsage
    gitBranchName
    gitHeadSha
    gitRepoStatus
    graphModulesFor
    isShallowRepo
    loadDepGraph
    loadStoryImportPaths
    localSha
    matchesAnyGlob
    normalizePath
    selectAffectedStories
    statsPathFor
    traceAffected
- @storyshelf/image
  - Overview
  - API
    
    Interfaces
    
    DiffOptions
    DiffResult
    ImageSettings
    
    Type Aliases
    
    ImageEngine
    
    Variables
    
    DEFAULT_DIFF_OPTIONS
    DEFAULT_IMAGE_ENGINE
    DIFF_WORKERS_ENV
    IMAGE_ENGINE_ENV
    IMAGE_ENGINES
    
    Functions
    
    configureImages
    currentImageEngine
    diffImages
    diffImagesAsync
    downscalePng
    isImageEngine
    resolveImageEngine
    shutdownDiffPool
    verifyImageEngine
- @storyshelf/observability
  - Overview
  - API
    
    node
    
    Functions
    
    initObservabilityFromEnv
    
    References
    
    ObservabilityConfig
    ObservabilityHandle
    resolveObservabilityConfig
    
    Overview
- @storyshelf/auth
  - Overview
  - API
    
    Interfaces
    
    AcceptInviteInput
    Auth
    AuthBridgeSchema
    EngineLoginMethod
    EnginePasskeyInfo
    EngineSessionInfo
    EngineSessionUser
    EnterpriseClientOptions
    GroupProvisionData
    InviteTokenInput
    IssueInviteInput
    PasswordAdminInput
    RawShelfAuthOptions
    ResolveSecrets
    SAMLGroupOptions
    SAMLIdPOptions
    ShelfAuth
    ShelfAuthInstance
    ShelfAuthOptions
    ShelfOAuthProvider
    ShelfPasskeyOptions
    ShelfSocialProvider
    ShelfSSOGroupSync
    ShelfSSOOidc
    ShelfSSOOptions
    ShelfSSOProvider
    ShelfSSOSaml
    SocialClientOptions
    SSOClientOptions
    SsoGroupSyncInput
    
    Type Aliases
    
    EngineLoginMethodKind
    
    Variables
    
    authAccountPg
    authOptionsSchema
    authPasskeyPg
    authSessionPg
    authSsoProviderPg
    authUserPg
    authVerificationPg
    baseAuthDateFields
    baseAuthDateFieldsPg
    baseAuthTables
    baseAuthTablesPg
    DEFAULT_GROUP_CLAIM
    ENGINE_PROVIDER_ID
    MIN_PASSWORD_LENGTH
    
    Functions
    
    acceptInvite
    auth0Preset
    cognitoPreset
    createShelfAuth
    createShelfDbBridge
    ensurePasswordAdmin
    entraPreset
    extractGroups
    githubPreset
    gitlabPreset
    googlePreset
    hasPasswordCredential
    issueInvite
    keycloakPreset
    listUserPasskeys
    listUserSessions
    oktaPreset
    parseEnvRef
    provisionHook
    resolveAuthOptions
    resolveSiteRole
    samlPreset
    ssoAuth0Preset
    ssoCallbackUrls
    ssoEntraPreset
    ssoGooglePreset
    ssoKeycloakPreset
    ssoOktaPreset
    syncSsoGroups
    unsignedToken
    verifyInvite
- @storyshelf/ai
  - Overview
  - API
    
    Interfaces
    
    BudgetOptions
    CreateAiOptions
    ProfileConfig
    ProfileModels
    
    Type Aliases
    
    ModelSlot
    SlotProviderOptions
    
    Functions
    
    createAi
- @storyshelf/mcp
  - Overview
  - API
    
    http
    
    Interfaces
    
    McpHttpOptions
    
    Type Aliases
    
    McpHttpHandler
    
    Functions
    
    createMcpHttpHandler
    serveHttp
    
    Overview
Databases
- @storyshelf/db-sqlite
  - Overview
  - API
    
    better-sqlite3
    
    Interfaces
    
    BetterSqlite3DatabaseOptions
    
    Functions
    
    createBetterSqlite3Database
    
    bun-sqlite
    
    Interfaces
    
    BunSqliteDatabaseOptions
    
    Functions
    
    createBunSqliteDatabase
    
    d1
    
    Interfaces
    
    D1Database
    D1DatabaseOptions
    D1PreparedStatement
    
    Functions
    
    createD1Database
    
    ddl
    
    Variables
    
    DDL
    IDENTITY_STATEMENTS
    
    Functions
    
    tableColumns
    
    drizzle-factory
    
    Functions
    
    createDrizzleAdapter
    withManualTransactions
    
    Overview
    
    schema
    
    Interfaces
    
    AiBudgetAlert
    AiUsage
    Build
    BuildLabel
    BuildPackageUsage
    CaptureAttempt
    CaptureLog
    Comment
    ContentRef
    DesignCredential
    DesignLink
    DesignNode
    Insight
    LabelType
    NotificationChannel
    NotificationSubscription
    Project
    ProjectGroupMapping
    ProjectLink
    ProjectMember
    Snapshot
    StorybookMeta
    Token
    User
    UserInviteToken
    Webhook
    
    Type Aliases
    
    Schema
    UserConnection
    
    Variables
    
    aiBudgetAlerts
    aiUsage
    baselines
    buildComponents
    buildLabels
    buildPackageUsage
    buildReviews
    builds
    captureAttempts
    captureJobs
    captureLogs
    captureShards
    comments
    contentRefs
    designCredentials
    designLinks
    designNodes
    insights
    labelTypes
    notificationChannels
    notificationSubscriptions
    projectGroupMappings
    projectLinks
    projectMembers
    projects
    schema
    siteSettings
    snapshots
    tokens
    userConnections
    userInviteTokens
    users
    webhooks
    
    turso
    
    Interfaces
    
    TursoDatabaseOptions
    
    Functions
    
    createTursoDatabase
- @storyshelf/db-postgres
  - Overview
  - API
    
    ddl
    
    Variables
    
    DDL
    
    neon
    
    Interfaces
    
    NeonDatabaseOptions
    
    Functions
    
    createNeonDatabase
    
    neon-http
    
    Interfaces
    
    NeonHttpDatabaseOptions
    
    Functions
    
    createNeonHttpDatabase
    
    Overview
    
    pg
    
    Interfaces
    
    PgDatabaseOptions
    
    Functions
    
    createPgDatabase
    
    pglite
    
    Interfaces
    
    PgliteDatabaseOptions
    
    Functions
    
    createPgliteDatabase
    
    schema
    
    Interfaces
    
    AiBudgetAlert
    AiUsage
    Baseline
    Build
    BuildLabel
    BuildPackageUsage
    CaptureAttempt
    CaptureLog
    Comment
    ContentRef
    DesignCredential
    DesignLink
    DesignNode
    Insight
    LabelType
    NotificationChannel
    NotificationSubscription
    Project
    ProjectGroupMapping
    ProjectLink
    ProjectMember
    Snapshot
    StorybookMeta
    Token
    User
    UserInviteToken
    Webhook
    
    Type Aliases
    
    Schema
    UserConnection
    
    Variables
    
    aiBudgetAlerts
    aiUsage
    baselines
    buildComponents
    buildLabels
    buildPackageUsage
    buildReviews
    builds
    captureAttempts
    captureJobs
    captureLogs
    captureShards
    comments
    contentRefs
    designCredentials
    designLinks
    designNodes
    insights
    labelTypes
    notificationChannels
    notificationSubscriptions
    projectGroupMappings
    projectLinks
    projectMembers
    projects
    schema
    siteSettings
    snapshots
    tokens
    userConnections
    userInviteTokens
    users
    webhooks
    
    vercel
    
    Interfaces
    
    VercelDatabaseOptions
    
    Functions
    
    createVercelDatabase
- @storyshelf/db-mysql
  - Overview
  - API
    
    ddl
    
    Variables
    
    DDL
    
    Overview
    
    planetscale
    
    Type Aliases
    
    PlanetscaleDatabaseOptions
    
    Functions
    
    createPlanetscaleDatabase
    
    schema
    
    Interfaces
    
    AiBudgetAlert
    AiUsage
    Baseline
    Build
    BuildLabel
    BuildPackageUsage
    CaptureAttempt
    CaptureLog
    Comment
    ContentRef
    DesignCredential
    DesignLink
    DesignNode
    Insight
    LabelType
    NotificationChannel
    NotificationSubscription
    Project
    ProjectGroupMapping
    ProjectLink
    ProjectMember
    Snapshot
    StorybookMeta
    Token
    User
    UserInviteToken
    Webhook
    
    Type Aliases
    
    Schema
    UserConnection
    
    Variables
    
    aiBudgetAlerts
    aiUsage
    baselines
    buildComponents
    buildLabels
    buildPackageUsage
    buildReviews
    builds
    captureAttempts
    captureJobs
    captureLogs
    captureShards
    comments
    contentRefs
    designCredentials
    designLinks
    designNodes
    insights
    labelTypes
    notificationChannels
    notificationSubscriptions
    projectGroupMappings
    projectLinks
    projectMembers
    projects
    schema
    siteSettings
    snapshots
    tokens
    userConnections
    userInviteTokens
    users
    webhooks
    
    tidb
    
    Type Aliases
    
    TidbDatabaseOptions
    
    Functions
    
    createTidbDatabase
Storage
- @storyshelf/storage-local
  - Overview
  - API
    
    Functions
    
    createLocalStorage
- @storyshelf/storage-s3
  - Overview
  - API
    
    Interfaces
    
    S3StorageOptions
    
    Functions
    
    createS3Storage
    s3Key
- @storyshelf/storage-azure
  - Overview
  - API
    
    Interfaces
    
    AzureStorageOptions
    
    Functions
    
    azureKey
    createAzureStorage
- @storyshelf/storage-gcs
  - Overview
  - API
    
    Interfaces
    
    GcsStorageOptions
    
    Functions
    
    createGcsStorage
    gcsKey
Capture runners
- @storyshelf/runner-playwright
  - Overview
  - API
    
    Overview
    
    remote
    
    Interfaces
    
    AzurePlaywrightOptions
    BrowserStackOptions
    PlaywrightServerOptions
    RemoteBrowser
    RemoteConnection
    RemoteOptions
    
    Type Aliases
    
    BrowserName
    
    Functions
    
    azurePlaywright
    browserstack
    playwrightServer
    remote
- @storyshelf/runner-puppeteer
  - Overview
  - API
    
    Overview
    
    remote
    
    Interfaces
    
    CdpOptions
    RemoteBrowser
    
    Functions
    
    cdp
Design
- @storyshelf/design-figma
  - Overview
  - API
    
    Interfaces
    
    FigmaDesignOptions
    FigmaOAuthOptions
    
    Functions
    
    createFigmaClient
    createFigmaDesign
    createFigmaOAuth
    fetchFigmaMetas
    fetchFigmaRenders
    figmaOAuthFromEnv
    parseFigmaUrl
Notifications
- @storyshelf/notify-chat
  - Overview
  - API
    
    log
    
    Variables
    
    logConfigSchema
    logNotifier
    
    Functions
    
    getMetadata
    
    Overview
    
    References
    
    logConfigSchema
    logNotifier
    slackWebhookConfigSchema
    slackWebhookNotifier
    teamsWorkflowConfigSchema
    teamsWorkflowNotifier
    
    slack
    
    Variables
    
    slackWebhookConfigSchema
    slackWebhookNotifier
    
    Functions
    
    getMetadata
    
    References
    
    ChatToggles
    
    teams
    
    Variables
    
    teamsWorkflowConfigSchema
    teamsWorkflowNotifier
    
    Functions
    
    getMetadata
    
    References
    
    ChatToggles
- @storyshelf/notify-email
  - Overview
  - API
    
    email
    
    Interfaces
    
    EmailNotifierDefaults
    
    Functions
    
    createEmailNotifier
    getMetadata
    
    http
    
    Functions
    
    httpPreset
    
    log
    
    Functions
    
    logPreset
    
    mailpit
    
    Functions
    
    mailpitPreset
    
    Overview
    
    References
    
    createEmailNotifier
    EmailNotifierDefaults
    httpPreset
    logPreset
    mailpitPreset
    smtpPreset
    smtpPresetFromEnv
    
    smtp
    
    Functions
    
    smtpPreset
    smtpPresetFromEnv
- @storyshelf/notify-git
  - Overview
  - API
    
    Variables
    
    githubConfigSchema
    gitHubNotifier
    gitlabConfigSchema
    gitLabNotifier
    gitLogNotifier
    gitNotifiers
    logConfigSchema

Docs Packages HTTP API

GitHub

Select theme

On this page

Overview
Interfaces

adapters/email-sender

Interfaces

Section titled “Interfaces”

EmailMessage
EmailSender