SDK type reference
This reference documents the public types and helpers for Plugin API 3.0.0, provided by the @phoundry/phials-plugin-sdk package.
Use the workflow guides for permissions, lifecycle consequences, and complete examples. Every declaration below has one canonical page and one owning category.
Plugin
Provider union
File viewing and editing
PreviewProviderPreviewDestinationPreviewSessionPreviewSessionFactoryPropsPreviewSurfacePropsPreviewToolbarContributionPropsPreviewDestinationCapabilitiesThumbnailIntrinsicDimensionsThumbnailProviderThumbnailRenderContextThumbnailRenderResultThumbnailNativeResultThumbnailNativeAccessThumbnailDirectorySelectionThumbnailInputDeclarationThumbnailContentAccessThumbnailContentSnapshotThumbnailRasterFormatThumbnailHostFeatureEditorHistoryHandlePreviewToolbarEditorState
Metadata
MetadataProviderRawMetadataExtractedMetadataFileMetadataMetadataSchemaFieldMetadataSchemaMetadataColumnPolicyFilterValueOptionDirectoryMetadataProfileOptionsMetadataProviderDirectoryStatsDirectoryMetadataProfile
File views
Panels and tabs
ModuleProviderModuleProviderPropsModuleAPIModulesAPIModuleOpenResultModulePositionModuleInstanceItemShortcutConfig
Settings and database
PluginSettingsSchemaSettingsFieldSettingsFieldTypeSettingsFieldBaseBooleanSettingsFieldStringSettingsFieldNumberSettingsFieldSelectSettingsFieldPathSettingsFieldPluginDatabaseSchemaPluginDatabaseMigrationPluginDatabaseTransactionPluginDatabaseSchemaOperationsPluginTableDefinitionPluginColumnDefinitionPluginIndexDefinitionPluginColumnType
Base and scoped APIs
PluginAPIPreviewAPIMetadataAPIExplorerAPIGitAPIWorkspaceFoldersAPIClipboardAPIPluginSettingsPluginSettingsChangePluginSettingsSubscriptionPluginStorageAPIPluginSecretsAPIPluginDatabaseAPIDatabaseExecuteResultReadonlyAppSettingsModalAPINotifyAPIFileUtilsAPIPluginPreparedWritePluginTextFileSnapshotPluginTextWriteResultPluginBinaryFileSnapshotPluginBinaryWriteResultPluginDirectoryReadResultPluginPathOutcomePluginFileErrorPluginFileErrorCodePluginFileFailurePluginDirectoryWatchFileMatchAPIEventsAPIViewAPI
Explorer
PluginPaneContextPluginPaneListingPluginPaneSelectionPluginPaneNavigationPluginPaneViewPluginPaneColumnPluginPaneSortPluginPaneWorkspaceFolder
Workspace Folders
WorkspaceFolderSchemaWorkspaceFolderPropertyDefinitionWorkspaceFolderPropertyOptionWorkspaceFolderPropertyTypeWorkspaceFolderPropertyValueWorkspaceFolderCalendarValueWorkspaceFolderFileRefWorkspaceFolderPropertyWriteKnownWorkspaceFolder
Repository inspection
GitInfoGitFileStatusGitCommitGitBranchGitDiffOptionsGitLogOptionsRepositoryLanguageFolderSummary
Commands
CommandContextKeyCommandContextCommandShortcutCommandPlacementAreaCommandPlacementBaseContextMenuPlacementConfigCommandPlacementCommandCommandProvider
File model
Shortcuts
Events
EventMapEventHandlerEventSubscriptionCoreEventsPluginEventsEventPayloadColumnLayoutChangedPayloadLayoutSettledPayloadLayoutSettledReason
Manifest
PluginManifestPluginPermissionPluginIdentityPluginIdentityProjectionPluginCandidateIdentityValidationResult