Skip to content
OpenWaggle
Applies to @openwaggle/[email protected]

@openwaggle/extension-sdk API

Complete public API reference for @openwaggle/extension-sdk 0.3.

This reference inventories every public entry point and named export in @openwaggle/extension-sdk 0.3.

Browser-safe extension schemas, manifest contracts, broker helpers, runtime types, themes, and framework-neutral UI helpers.

@openwaggle/extension-sdk

Convenience entry point that re-exports the complete browser-safe extension author contract.

ExportKind
createNoopExtensionSurfaceSdkfunction
createOpenWaggleExtensionSharedModulesfunction
createOpenWaggleExtensionSurfaceContextfunction
CreateOpenWaggleExtensionSurfaceContextInputinterface
createOpenWaggleExtensionThemefunction
CreateOpenWaggleExtensionThemeOptionsinterface
createOpenWaggleExtensionUiStylesheetfunction
CreateOpenWaggleExtensionUiStylesheetOptionsinterface
CreateOpenWaggleSdkOptionsinterface
createPlainExtensionSyntaxResultfunction
defineExtensionManifestfunction
ExtensionActionSelectProjectResulttype
ExtensionBranchViewtype
ExtensionBrokerCapabilitytype
ExtensionBrokerMethodtype
ExtensionBrokerSdkinterface
ExtensionBrokerTransporttype
ExtensionCapabilityAuditEntrytype
ExtensionCapabilityDeclarationtype
ExtensionCapabilityScopetype
ExtensionCommandContributiontype
ExtensionContributionFamilytype
ExtensionContributionMatchViewtype
ExtensionContributionRegistrationtype
ExtensionContributionRegistryEntryinterface
ExtensionContributionRuntimetype
ExtensionContributionstype
ExtensionContributionTargetViewtype
ExtensionContributionUnregistrationtype
ExtensionDocsDiscoverOperationResulttype
ExtensionDocsDiscoverPayloadtype
ExtensionDocsDiscoverResulttype
ExtensionDocsDiscoveryViewtype
ExtensionDocsResolveTopicOperationResulttype
ExtensionDocsResolveTopicPayloadtype
ExtensionDocsResolveTopicResulttype
ExtensionDocsTopicDeclarationtype
ExtensionEntryContributiontype
ExtensionExecutionPlacementtype
ExtensionHostContextResulttype
ExtensionInstallSourcetype
ExtensionInvokeErrortype
ExtensionInvokeFailuretype
ExtensionInvokeFailureCodetype
ExtensionInvokeInputtype
ExtensionInvokeOutcometype
ExtensionInvokeResulttype
ExtensionInvokeScopetype
ExtensionInvokeSuccessinterface
ExtensionInvokeSuccessValuetype
ExtensionModelPreferencesSettingsPatchtype
ExtensionModelPrefstype
ExtensionNetworkAccessModetype
ExtensionOpenWaggleResourcesSdkinterface
ExtensionOpenWaggleSdkinterface
ExtensionOpenWaggleSessionResourcesSdktype
ExtensionOpenWaggleSettingsSdkinterface
ExtensionOpenWaggleStateSdkinterface
ExtensionOperationSuccesstype
ExtensionPackageScopeKindtype
ExtensionPackageScopeViewinterface
ExtensionPackageStorageKindSdkinterface
ExtensionPackageStorageSdkinterface
ExtensionProjectViewtype
ExtensionRuntimeContributionSdkinterface
ExtensionRuntimeRegisterContributionOperationResulttype
ExtensionRuntimeRegisterContributionPayloadtype
ExtensionRuntimeRegisterContributionResulttype
ExtensionRuntimeRequirementDeclarationtype
ExtensionRuntimeUnregisterContributionOperationResulttype
ExtensionRuntimeUnregisterContributionPayloadtype
ExtensionRuntimeUnregisterContributionResulttype
ExtensionSdkIdentityinterface
ExtensionSdkInvoketype
ExtensionSdkInvokeRequestinterface
ExtensionSelectedStateReadResultinterface
ExtensionSelectProjectOperationResulttype
ExtensionSessionInvokeScopetype
ExtensionSessionResourceKindtype
ExtensionSessionResourcePublishOperationResulttype
ExtensionSessionResourcePublishPayloadtype
ExtensionSessionResourcePublishResulttype
ExtensionSessionResourceRoletype
ExtensionSessionResourcesListOperationResulttype
ExtensionSessionResourcesListPayloadtype
ExtensionSessionResourcesListResulttype
ExtensionSessionResourceViewtype
ExtensionSessionSummaryContributiontype
ExtensionSessionSummaryDisclosuretype
ExtensionSessionSummaryRowtype
ExtensionSessionSummaryStatetype
ExtensionSessionViewtype
ExtensionSettingsGetOperationResulttype
ExtensionSettingsGetResulttype
ExtensionSettingsGetSettingOperationResulttype
ExtensionSettingsGetSettingResulttype
ExtensionSettingsKeytype
ExtensionSettingsSelectedValuetype
ExtensionSettingsUpdateOperationResulttype
ExtensionSettingsUpdatePayloadtype
ExtensionSettingsUpdateResulttype
ExtensionSettingsUpdateSettingOperationResulttype
ExtensionSettingsUpdateSettingResulttype
ExtensionSettingsViewtype
ExtensionSidePanelContributiontype
ExtensionSidePanelIcontype
ExtensionStateCurrentBranchReadOperationResulttype
ExtensionStateCurrentBranchReadResulttype
ExtensionStateCurrentProjectReadOperationResulttype
ExtensionStateCurrentProjectReadResulttype
ExtensionStateCurrentSessionReadOperationResulttype
ExtensionStateCurrentSessionReadResulttype
ExtensionStateModelPreferencesReadOperationResulttype
ExtensionStateModelPreferencesReadResulttype
ExtensionStateReadOperationResulttype
ExtensionStateReadResulttype
ExtensionStateRecentProjectsReadOperationResulttype
ExtensionStateRecentProjectsReadResulttype
ExtensionStateSelectortype
ExtensionStorageDeleteOperationResulttype
ExtensionStorageDeleteResulttype
ExtensionStorageGetOperationResulttype
ExtensionStorageGetResulttype
ExtensionStorageKindtype
ExtensionStorageListOperationResulttype
ExtensionStorageListResulttype
ExtensionStorageResultBasetype
ExtensionStorageScopetype
ExtensionStorageScopeSdkinterface
ExtensionStorageScopeSelectortype
ExtensionStorageSetOperationResulttype
ExtensionStorageSetResulttype
ExtensionSurfaceContributiontype
extensionThemeCssVariableDeclarationsfunction
extensionThemeCssVariableEntriesfunction
ExtensionThemeCssVariableResolvertype
ExtensionValidationIssueinterface
ExtensionValidationResulttype
FirstPartyDocsTopicSummarytype
JsonArraytype
JsonObjectinterface
JsonPrimitivetype
JsonValuetype
OPENWAGGLE_EXTENSIONconst
OPENWAGGLE_EXTENSION_BROKERconst
OPENWAGGLE_EXTENSION_THEME_CSS_VARIABLESconst
OPENWAGGLE_EXTENSION_UI_ATTRIBUTESconst
OPENWAGGLE_EXTENSION_UI_CLASS_NAMESconst
OpenWaggleAgentLoopSurfaceInputtype
OpenWaggleCustomMessageSurfaceInputtype
openWaggleExtensionClassNamefunction
OpenWaggleExtensionClassNameParttype
OpenWaggleExtensionColorSchemetype
OpenWaggleExtensionManifesttype
OpenWaggleExtensionManifestFiletype
OpenWaggleExtensionMountCleanuptype
OpenWaggleExtensionMountContextinterface
OpenWaggleExtensionMountResulttype
OpenWaggleExtensionSdktype
OpenWaggleExtensionSharedModulesinterface
OpenWaggleExtensionSurfaceContextinterface
OpenWaggleExtensionSurfaceSdkinterface
OpenWaggleExtensionSyntaxHighlightInputinterface
OpenWaggleExtensionSyntaxHighlightOptionsinterface
OpenWaggleExtensionSyntaxHighlightResultinterface
OpenWaggleExtensionSyntaxPrioritytype
OpenWaggleExtensionSyntaxSdkinterface
OpenWaggleExtensionSyntaxTokeninterface
OpenWaggleExtensionThemeinterface
OpenWaggleExtensionThemeCssVariableEntryinterface
OpenWaggleExtensionThemeCssVariablestype
OpenWaggleExtensionThemeTokensinterface
OpenWaggleExtensionTypeScaleEntryinterface
OpenWaggleExtensionUiButtonVarianttype
OpenWaggleExtensionUiTonetype
OpenWaggleFederatedModuleinterface
OpenWaggleInteractionSurfaceInputtype
OpenWaggleStatusSurfaceInputtype
OpenWaggleToolCallSurfaceInputtype
OpenWaggleTranscriptSurfaceInputtype

@openwaggle/extension-sdk/agent-loop

Typed DTOs and schemas for tool, interaction, transcript, custom-message, and run-status surfaces.

ExportKind
OpenWaggleAgentLoopSurfaceInputtype
OpenWaggleCustomMessageSurfaceInputtype
OpenWaggleInteractionSurfaceInputtype
OpenWaggleStatusSurfaceInputtype
OpenWaggleToolCallSurfaceInputtype
OpenWaggleTranscriptSurfaceInputtype

@openwaggle/extension-sdk/constants

Stable extension and broker protocol constants.

ExportKind
OPENWAGGLE_EXTENSIONconst
OPENWAGGLE_EXTENSION_BROKERconst

@openwaggle/extension-sdk/context

Federated-module mount context, surface SDK, and shared-module helpers.

ExportKind
createNoopExtensionSurfaceSdkfunction
createOpenWaggleExtensionSharedModulesfunction
createOpenWaggleExtensionSurfaceContextfunction
CreateOpenWaggleExtensionSurfaceContextInputinterface
OpenWaggleExtensionMountCleanuptype
OpenWaggleExtensionMountContextinterface
OpenWaggleExtensionMountResulttype
OpenWaggleExtensionSdktype
OpenWaggleExtensionSharedModulesinterface
OpenWaggleExtensionSurfaceContextinterface
OpenWaggleExtensionSurfaceSdkinterface
OpenWaggleFederatedModuleinterface

@openwaggle/extension-sdk/docs

Installed documentation discovery and topic contracts.

ExportKind
ExtensionDocsDiscoverPayloadtype
ExtensionDocsDiscoverResulttype
ExtensionDocsDiscoveryViewtype
ExtensionDocsResolveTopicPayloadtype
ExtensionDocsResolveTopicResulttype
FirstPartyDocsTopicSummarytype

@openwaggle/extension-sdk/json

JSON-safe value types and runtime schemas.

ExportKind
JsonArraytype
JsonObjectinterface
JsonPrimitivetype
JsonValuetype

@openwaggle/extension-sdk/runtime

Runtime contribution registration contracts and SDK helpers.

ExportKind
ExtensionContributionRegistrationtype
ExtensionContributionUnregistrationtype
ExtensionRuntimeRegisterContributionResulttype
ExtensionRuntimeUnregisterContributionResulttype

@openwaggle/extension-sdk/syntax

Public API for the ./syntax package export.

ExportKind
createPlainExtensionSyntaxResultfunction
OpenWaggleExtensionSyntaxHighlightInputinterface
OpenWaggleExtensionSyntaxHighlightOptionsinterface
OpenWaggleExtensionSyntaxHighlightResultinterface
OpenWaggleExtensionSyntaxPrioritytype
OpenWaggleExtensionSyntaxSdkinterface
OpenWaggleExtensionSyntaxTokeninterface

@openwaggle/extension-sdk/testing

Public API for the ./testing package export.

ExportKind
createExtensionBrokerSdkfunction
createExtensionBrokerSdkFromInvokefunction
CreateOpenWaggleSdkOptionsinterface
createRuntimeContributionSdkfunction
ExtensionBrokerSdkinterface
ExtensionBrokerTransporttype
ExtensionSdkIdentityinterface
ExtensionSdkInvoketype
ExtensionSdkInvokeRequestinterface
toInvokeInputconst

@openwaggle/extension-sdk/theme

Host-provided theme tokens and CSS variable helpers.

ExportKind
createOpenWaggleExtensionThemefunction
CreateOpenWaggleExtensionThemeOptionsinterface
extensionThemeCssVariableEntriesfunction
ExtensionThemeCssVariableResolvertype
OPENWAGGLE_EXTENSION_THEME_CSS_VARIABLESconst
OpenWaggleExtensionColorSchemetype
OpenWaggleExtensionThemeinterface
OpenWaggleExtensionThemeCssVariableEntryinterface
OpenWaggleExtensionThemeCssVariablestype
OpenWaggleExtensionThemeTokensinterface
OpenWaggleExtensionTypeScaleEntryinterface

@openwaggle/extension-sdk/types

Shared extension package, contribution, and registry contracts.

ExportKind
ExtensionActionSelectProjectResulttype
ExtensionBranchViewtype
ExtensionBrokerCapabilitytype
ExtensionBrokerMethodtype
ExtensionCapabilityAuditEntrytype
ExtensionCapabilityScopetype
ExtensionContributionFamilytype
ExtensionContributionMatchViewtype
ExtensionContributionRegistryEntryinterface
ExtensionContributionRuntimetype
ExtensionContributionTargetViewtype
ExtensionDocsDiscoverPayloadtype
ExtensionDocsDiscoverResulttype
ExtensionDocsResolveTopicPayloadtype
ExtensionDocsResolveTopicResulttype
ExtensionExecutionPlacementtype
ExtensionHostContextResulttype
ExtensionInstallSourcetype
ExtensionInvokeErrortype
ExtensionInvokeFailuretype
ExtensionInvokeFailureCodetype
ExtensionInvokeInputtype
ExtensionInvokeOutcometype
ExtensionInvokeResulttype
ExtensionInvokeScopetype
ExtensionInvokeSuccessinterface
ExtensionInvokeSuccessValuetype
ExtensionModelPreferencesSettingsPatchtype
ExtensionModelPrefstype
ExtensionNetworkAccessModetype
ExtensionPackageScopeKindtype
ExtensionPackageScopeViewinterface
ExtensionProjectViewtype
ExtensionRuntimeRegisterContributionPayloadtype
ExtensionRuntimeRegisterContributionResulttype
ExtensionRuntimeUnregisterContributionPayloadtype
ExtensionRuntimeUnregisterContributionResulttype
ExtensionSelectedStateReadResultinterface
ExtensionSessionResourceKindtype
ExtensionSessionResourcePublishPayloadtype
ExtensionSessionResourcePublishResulttype
ExtensionSessionResourceRoletype
ExtensionSessionResourcesListPayloadtype
ExtensionSessionResourcesListResulttype
ExtensionSessionResourceViewtype
ExtensionSessionViewtype
ExtensionSettingsGetResulttype
ExtensionSettingsGetSettingResulttype
ExtensionSettingsKeytype
ExtensionSettingsSelectedValuetype
ExtensionSettingsUpdatePayloadtype
ExtensionSettingsUpdateResulttype
ExtensionSettingsUpdateSettingResulttype
ExtensionSettingsViewtype
ExtensionStateCurrentBranchReadResulttype
ExtensionStateCurrentProjectReadResulttype
ExtensionStateCurrentSessionReadResulttype
ExtensionStateModelPreferencesReadResulttype
ExtensionStateReadResulttype
ExtensionStateRecentProjectsReadResulttype
ExtensionStateSelectortype
ExtensionStorageDeleteResulttype
ExtensionStorageGetResulttype
ExtensionStorageKindtype
ExtensionStorageListResulttype
ExtensionStorageResultBasetype
ExtensionStorageScopetype
ExtensionStorageScopeSelectortype
ExtensionStorageSetResulttype
ExtensionValidationIssueinterface
ExtensionValidationResulttype

@openwaggle/extension-sdk/ui

Framework-neutral class names, attributes, and stylesheet generation.

ExportKind
createOpenWaggleExtensionUiStylesheetfunction
CreateOpenWaggleExtensionUiStylesheetOptionsinterface
extensionThemeCssVariableDeclarationsfunction
OPENWAGGLE_EXTENSION_UI_ATTRIBUTESconst
OPENWAGGLE_EXTENSION_UI_CLASS_NAMESconst
openWaggleExtensionClassNamefunction
OpenWaggleExtensionClassNameParttype
OpenWaggleExtensionUiButtonVarianttype
OpenWaggleExtensionUiTonetype

@openwaggle/extension-sdk/validation

Public API for the ./validation package export.

ExportKind
ExtensionValidationIssueinterface
ExtensionValidationResulttype
validateBrokerCapabilityDeclarationconst
validateExtensionManifestconst
validateOpenWaggleExtensionThemeconst