deck-plugin-sdk 1.12.0 → 1.12.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "deck-plugin-sdk",
-  "version": "1.12.0",
+  "version": "1.12.1",
   "description": "Build a plugin for Deck, outside the Deck repository.",
   "type": "module",
   "license": "MIT",

package/template/plugin.json

@@ -5,6 +5,6 @@
   "icon": "Sparkles",
   "color": "#a78bfa",
   "version": "0.1.0",
-  "minDeck": "1.12.0",
+  "minDeck": "1.12.1",
   "permissions": []
 }

package/types/core/browser/browser.d.ts

@@ -1,6 +1,7 @@
 // GENERATED by sdk/gen-types.mjs from Deck's source — do not edit.
 import { type RecentPage } from "./browserurl";
 import { type Bookmarks } from "./bookmarks";
+import "./webnotify";
 /**
  * `home`: the pane shows Deck's start page, and its webview (if it has one) is hidden. `back` and
  * `forward`: whether the page has history that way. `private`: nothing it visits is kept.
@@ -129,6 +130,7 @@ export declare function registerZoomTarget(pane: string, holds: () => boolean):
 export declare const activeBrowserPage: () => string | undefined;
 /** Zoom the pane's page a step in or out, or back to 100% (0). */
 export declare function stepZoom(pane: string, dir: -1 | 0 | 1): void;
+export declare const hostOf: (url: string) => string;
 /** The URL a just-opened browser pane should show, if a page asked for it. */
 export declare const takeWaitingUrl: () => {
     url: string;

package/types/core/browser/sitenotify.d.ts

@@ -0,0 +1,11 @@
+// GENERATED by sdk/gen-types.mjs from Deck's source — do not edit.
+export interface SiteNote {
+    title: string;
+    body: string;
+    /** Under the text: where it came from ("#hapster-tech · Slack"). */
+    source: string;
+    /** A person's message (the card shows them as one): a rule here found a sender. */
+    message: boolean;
+}
+/** How a page's notification (its host, title and text) is shown in Deck. */
+export declare function siteNote(host: string, title: string, body: string): SiteNote;

package/types/core/browser/webnotify.d.ts

@@ -0,0 +1,2 @@
+// GENERATED by sdk/gen-types.mjs from Deck's source — do not edit.
+export {};

package/types/core/notifications/notifications.d.ts

@@ -15,6 +15,8 @@ export interface NotifAction {
     nav?: string;
     act?: string;
     run?: () => void;
+    /** What a click on the card does (open the tab, the file): no button of its own. */
+    open?: boolean;
 }
 export interface Notif {
     id: string;
@@ -33,6 +35,14 @@ export interface Notif {
     /** Who posted it, shown beside the time: a plugin's name. */
     source?: string;
     actions?: NotifAction[];
+    /**
+     * A person's message (a chat, a mail): the card shows the sender, `title`, with their picture
+     * (`image`, else their initials) and the app's icon on it (`badge`), and the whole of `body`.
+     */
+    message?: {
+        image?: string;
+        badge?: string;
+    };
     /** Seen: the bell has been opened since it came. Read: the bell was closed after that. */
     seen?: boolean;
     read?: boolean;
@@ -79,8 +89,21 @@ export declare function clearNotifs(): void;
 /** The bell was opened: the badge clears, the rows stay lifted until it closes. */
 export declare function markSeen(): void;
 export declare function markRead(): void;
+/**
+ * The tab of the plugin named `source`, where a click on its notification goes when the plugin
+ * gave it no open action. Set by the plugin loader (plugins.ts), so that this file and the plugin
+ * API in notifyapi.ts do not import the loader, which would put all of it in the SDK's types.
+ */
+declare let tabOfPlugin: (source: string) => string | undefined;
+export declare const setPluginTabs: (f: typeof tabOfPlugin) => void;
+export declare const pluginTabOf: (source: string) => string | undefined;
 /** What a persisted action's `act` runs. Registered by the module that posts it, at import. */
 export declare function onNotifAction(name: string, run: () => unknown): void;
-/** A click on the card or the row itself: where it is about, then the card goes. */
+/** Whether a click on the card or its row goes anywhere: it is drawn as clickable only then. */
+export declare const opens: (n: Notif) => boolean;
+/** The actions shown as buttons: all but the one the card's click runs. */
+export declare const buttons: (n: Notif) => NotifAction[];
+/** A click on the card or the row itself: its open action, or where it is about; then the card goes. */
 export declare function openNotif(n: Notif): void;
 export declare function runAction(n: Notif, a: NotifAction): void;
+export {};

package/types/core/notifications/notifyapi.d.ts

@@ -23,12 +23,22 @@ export interface PluginNotification {
     /**
      * Buttons on the card and on its bell row. `run` is the plugin's own function, so it lasts only
      * as long as this session: after a restart the row is still in the bell, without its buttons.
+     * `open`: what a click anywhere on the card does (open the mail, the build); it has no button.
+     * Without one, a click opens the plugin's own tab, when it has one.
      */
     actions?: {
         label: string;
         primary?: boolean;
+        open?: boolean;
         run: () => void;
     }[];
+    /**
+     * A person's message (new mail, a chat): the card shows `title` as the sender, with their picture
+     * (`image`, an https: or data: address; else their initials), and the whole of `body`.
+     */
+    message?: {
+        image?: string;
+    };
 }
 /**
  * Post a notification: a card in the corner and a row in the bell, as Settings › Notifications