@silo-code/sdk 0.21.0 → 0.22.0

package/src/types.ts

@@ -1,5 +1,6 @@
 /**
- * The Silo extension API — types only.
+ * The Silo extension API — types-first contract plus a small set of blessed
+ * runtime helpers.
  *
  * Everything an extension author can see at compile time lives here (plus the
  * service interfaces in the sibling `*-service` files, which this module
@@ -8,6 +9,12 @@
  * never import the host. This is the VS Code (`vscode.d.ts`) / Obsidian
  * (`obsidian-api`) model.
  *
+ * **Runtime exports:** the SDK also ships a small set of blessed runtime
+ * helpers (`Tooltip`, `useFocusGroup`, `useServiceState`, `DND_MIME`,
+ * `PathDeniedError`, `NetworkError`) and peer-depends on React 19. Changes to
+ * these can be breaking even when the types are unchanged — treat them with
+ * the same care as the type surface.
+ *
  * Start with {@link Extension} (the unit you export) and
  * {@link ExtensionContext} (the `ctx` the host hands you).
  *
@@ -207,10 +214,10 @@ export interface NewFileTemplate {
 
 /**
  * Declarative metadata about a file extension — the open-ended counterpart to
- * Viewer (which is purely a renderer). A single source of truth that "New File"
- * surfaces (and, later, tab/explorer icons) can enumerate. Registering a
- * FileType does not register a viewer; the two are matched independently by
- * extension at dispatch time.
+ * {@link Editor} (which is purely a presenter/renderer). A single source of
+ * truth that "New File" surfaces (and, later, tab/explorer icons) can
+ * enumerate. Registering a FileType does not register an Editor; the two are
+ * matched independently by extension at dispatch time.
  *
  * @category Registration
  * @public

package/src/workspace-service.ts

@@ -170,6 +170,12 @@ export interface WorkspaceService {
   createFromFolderPicker(): Promise<Workspace | null>;
   create(input: CreateWorkspaceInput): Workspace;
   rename(id: string, name: string): void;
+  /**
+   * Move a workspace to a new position relative to a reference workspace.
+   * @param from - Id of the workspace being dragged / moved.
+   * @param to - Id of the reference workspace (the insertion anchor).
+   * @param position - Whether to place `from` before or after `to`.
+   */
   reorder(from: string, to: string, position: "before" | "after"): void;
   /** Activate (and reopen if closed). */
   activate(id: string): void;
@@ -263,6 +269,13 @@ export interface WorkspaceService {
    *
    * The Workspaces panel subscribes internally to re-render when providers
    * are added or removed.
+   *
+   * **No `invalidateSection` by design.** Unlike status rows and badges, a
+   * section is a live React component that re-renders on its own internal or
+   * context-driven state changes — it is not a snapshot returned from a
+   * `provide()` call, so there is nothing for the host to re-query. If a
+   * section needs to trigger a full workspace-panel refresh (rare), it should
+   * update its own state directly.
    */
   subscribeSection(listener: () => void): Disposable;