@paged-media/plugin-api 0.2.26-canary.0 → 0.2.27-canary.1

package/dist/editor.d.ts

@@ -169,6 +169,16 @@ export interface PanelContribution {
     defaultDock?: DockEdge;
     defaultGroup?: string;
     icon?: string;
+    /** K-8 — opt into the editor's PANEL RAIL: hosts that support the
+     *  rail door render a launcher item for this panel after the
+     *  built-ins. Off by default (the Window menu + palette remain the
+     *  baseline discovery surfaces). */
+    rail?: boolean;
+    /** K-8 — a self-contained SVG glyph (the inner markup of a 24×24
+     *  viewBox, currentColor strokes/fills, no script/foreignObject/event
+     *  handlers — the host SANITIZES before rendering). Used when `icon`
+     *  names no host glyph; the honest fallback stays the iconless tab. */
+    iconSvg?: string;
     when?: VisibilityPredicate;
     closable?: boolean;
     movable?: boolean;

package/dist/host.d.ts

@@ -483,6 +483,39 @@ export interface FrameChainLink {
  * The future write-scope (edit-context subtree) attaches at this same
  * chokepoint.
  */
+/**
+ * DOC-03 (protocol v54) — a story's full CONTENT: its paragraphs → runs → text +
+ * applied styles + direct character overrides. Where `collection<StorySummary>
+ * ("stories")` gives only counts, this gives the decoded text + formatting a
+ * content plugin needs to read an EDITED document back (e.g. paged.doc diffs it
+ * against its import baseline to drive edited save-back). Field names mirror the
+ * engine's `CharacterRun`/`Paragraph`; each `null`/absent override = inherit.
+ */
+export interface StoryContent {
+    selfId: string;
+    paragraphs: ParagraphContent[];
+}
+/** DOC-03 — one paragraph's applied style + its runs. */
+export interface ParagraphContent {
+    paragraphStyle?: string | null;
+    runs: RunContent[];
+}
+/** DOC-03 — one run's text + applied character style + direct overrides. A run
+ *  styled only through an applied style carries just `characterStyle`. */
+export interface RunContent {
+    text: string;
+    characterStyle?: string | null;
+    font?: string | null;
+    fontStyle?: string | null;
+    pointSize?: number | null;
+    fillColor?: string | null;
+    underline?: boolean | null;
+    strikethru?: boolean | null;
+    capitalization?: string | null;
+    baselineShift?: number | null;
+    position?: string | null;
+    tracking?: number | null;
+}
 export interface DocumentSurface {
     mutate(mutation: Mutation): Promise<MutationOutcome>;
     undo(): Promise<void>;
@@ -511,6 +544,14 @@ export interface DocumentSurface {
      *  pagination consumer reads this to know the real host chain (rather
      *  than a caller-supplied one). */
     frameChain(storyId: string): Promise<FrameChainLink[]>;
+    /** DOC-03 (protocol v54) — read a story's full content (paragraphs → runs →
+     *  text + applied styles + direct overrides), or `null` when the story id
+     *  doesn't resolve. Where `collection<StorySummary>("stories")` gives counts,
+     *  this gives the decoded text + formatting needed to read an EDITED document
+     *  back and diff it (paged.doc edited save-back). Gated:
+     *  `supports("document.readStory@1")`; a host without the v54 read backend
+     *  throws `PluginApiNotImplemented` (a visible seam, never a fake value). */
+    storyContent(storyId: string): Promise<StoryContent | null>;
     onDidChange(listener: (e: DocumentChangeEvent) => void): Disposable;
     /**
      * Plugin-metadata carrier (protocol v33) — read this plugin's

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export type { PluginId, PluginManifest, PluginCapabilities, PluginContributions, NetworkCapability, DataProvidersCapability, StorageCapability, WasmArtifact, WasmPurpose, WorkersCapability, SecretsCapability, GpuCapability, } from "./manifest";
 export type { BundleHandle, PagedBundle } from "./bundle";
-export type { BundleHost, ContributionSurface, SceneLayerSurface, ImagesSurface, ImageResourceClaimOptions, TileBytes, WorkersSurface, BundleWorker, SpawnWorkerOptions, SecretsSurface, SecretMaterial, DocumentSurface, SelectionSurface, ViewportSurface, TextSurface, TextMetrics, FrameChainLink, OverlaySurface, ShellSurface, FilePickerOptions, PickedFile, StorageSurface, BlobSurface, BlobUsage, PartsSurface, NativeDocumentSurface, NetworkSurface, ConsentResult, DataProvidersSurface, DataProviderRegistration, DataProviderHandle, DataProviderInfo, DataProviderSnapshot, ProviderSchema, ProviderField, ProviderRecordSet, DiagnosticsSurface, BindingsSurface, Diagnostic, DocumentChangeEvent, MutationOutcome, Disposable, PluginLogger, EditContextContribution, ObjectTypeContribution, EditContextCandidate, EnteredEditContext, ContentPointerEvent, EditContextDescriptor, ObjectTypeDescriptor, PluginMetadataEnvelope, ObjectTypeBaker, BakeContext, } from "./host";
+export type { BundleHost, ContributionSurface, SceneLayerSurface, ImagesSurface, ImageResourceClaimOptions, TileBytes, WorkersSurface, BundleWorker, SpawnWorkerOptions, SecretsSurface, SecretMaterial, DocumentSurface, SelectionSurface, ViewportSurface, TextSurface, TextMetrics, FrameChainLink, StoryContent, ParagraphContent, RunContent, OverlaySurface, ShellSurface, FilePickerOptions, PickedFile, StorageSurface, BlobSurface, BlobUsage, PartsSurface, NativeDocumentSurface, NetworkSurface, ConsentResult, DataProvidersSurface, DataProviderRegistration, DataProviderHandle, DataProviderInfo, DataProviderSnapshot, ProviderSchema, ProviderField, ProviderRecordSet, DiagnosticsSurface, BindingsSurface, Diagnostic, DocumentChangeEvent, MutationOutcome, Disposable, PluginLogger, EditContextContribution, ObjectTypeContribution, EditContextCandidate, EnteredEditContext, ContentPointerEvent, EditContextDescriptor, ObjectTypeDescriptor, PluginMetadataEnvelope, ObjectTypeBaker, BakeContext, } from "./host";
 export type { PanelSchema, PanelSchemaSection, PanelSchemaRow, SchemaPanelContribution, SchemaPanelRenderer, SchemaPanelRendererProps, WidgetValueBinding, BindingRef, SchemaGate, } from "./panel-schema";
 export type { WidgetSurface, CodeEditorProps, CodeEditorDiagnostic, CodeEditorLanguage, } from "./widgets";
 export type { AssetSurface, AssetKind, FontFaceAsset, FontFaceFormat, } from "./assets";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paged-media/plugin-api",
-  "version": "0.2.26-canary.0",
+  "version": "0.2.27-canary.1",
   "description": "The Paged plugin contract: manifest, bundle lifecycle, the BundleHost surface, and the contribution + engine wire types. Type-only.",
   "license": "MPL-2.0 OR LicenseRef-PMEL",
   "type": "module",