@scm-js/plugin-api 1.26.0 → 1.28.0

package/index.d.ts

@@ -2179,8 +2179,34 @@ export interface BuildStepSpec {
 	 */
 	run(input: BuildStepInput): Promise<Uint8Array>;
 }
+/**
+ * Work a plugin does on the *document* before the map's bytes are produced for Save, Test
+ * Map or `export` — the place to bring generated content up to date, such as writing a
+ * script's triggers into the trigger list with `document.update`. It runs before any
+ * build step is asked whether it applies, so a step can rely on what it did.
+ */
+export interface BeforeBuildSpec {
+	/** Unique within the plugin. */
+	id: string;
+	/** What a failure notice names: "TrigScript". */
+	label: string;
+	/** Whether there is anything to do for the open map. Cheap and synchronous; every save asks. Always, when omitted. */
+	applies?(): boolean;
+	/**
+	 * May be asynchronous and may write to the document. A throw does not stop the save:
+	 * the map is written as it stands and a notice shows the error's message, so word it
+	 * for the user. Inside it `document.export()` answers the map as it stands, without
+	 * running anything.
+	 */
+	run(ctx: {
+		purpose: BuildPurpose;
+		signal: AbortSignal;
+	}): void | Promise<void>;
+}
 export interface BuildStepsApi {
 	add(spec: BuildStepSpec): Disposable;
+	/** Run `spec.run` before the map's bytes are produced, every time the map leaves the editor. */
+	before(spec: BeforeBuildSpec): Disposable;
 	/** The steps behind the file the open map came from or was last saved to; null for a plain map. */
 	builtBy(): BuiltBy[] | null;
 }
@@ -3903,8 +3929,14 @@ export interface DialogSpec {
 	tall?: boolean;
 	/** Fill `body` (an empty `<div>` inside the dialog); return a cleanup if you need one. */
 	mount(body: HTMLElement, dialog: DialogHandle): void | (() => void);
-	/** Footer buttons, left to right; a single Close when omitted. */
+	/**
+	 * Footer buttons, left to right; a single Close when omitted. An empty list leaves the
+	 * dialog without a footer — for a dialog that is a workspace of its own, with its own
+	 * controls, closed by the title strip's × (`setBusy` and a `slot` then have nowhere to show).
+	 */
 	buttons?: DialogButton[];
+	/** The body runs edge to edge, without the dialog's padding: for content that draws its own frame (an editor with its own bars). */
+	flush?: boolean;
 	/**
 	 * Ctrl+V anywhere in the dialog (while it is the topmost one). Files come from the
 	 * clipboard's items — a screenshot pastes as one `image/png` file — and `text` is the
@@ -3976,6 +4008,8 @@ export interface PanelSpec {
 	dock?: "float" | "right";
 	/** A docked panel that takes the dock's spare height (a transcript, a long list); off by default. */
 	grow?: boolean;
+	/** Floating only: the body runs edge to edge, without the panel's padding — for content that draws its own frame. */
+	flush?: boolean;
 	/** Fill `body` (an empty `<div>` inside the panel); return a cleanup if you need one. */
 	mount(body: HTMLElement, panel: PanelHandle): void | (() => void);
 	/** The panel closed, whichever way. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scm-js/plugin-api",
-  "version": "1.26.0",
+  "version": "1.28.0",
   "description": "Type declarations for the scmJS plugin API",
   "license": "MIT",
   "types": "index.d.ts",