@sliprail/sdk 0.1.11 → 0.1.13

package/lib/index.d.ts

@@ -41,6 +41,7 @@ export type WindowOptions = {
     onClose?: () => void;
 };
 export type WindowControl = {
+    shortcutId: string;
     close: () => void;
     show: () => void;
     hide: () => void;
@@ -59,6 +60,13 @@ export type LivePreviewContent = {
     content: string;
     type?: 'info' | 'warn' | 'error' | 'hint';
 };
+type WindowScope = 'shortcut' | 'extension';
+export type GetWindowsOptions = {
+    scope?: WindowScope;
+};
+/**
+ * @public
+ */
 export type ShortcutContext = SliprailMain & {
     parameter: any;
     subShortcutId: string;
@@ -66,7 +74,7 @@ export type ShortcutContext = SliprailMain & {
     getSettings: (keys?: string[]) => Promise<Record<string, unknown>>;
     createWindow: (options: WindowOptions) => WindowControl;
     createStorage: () => KVStorage;
-    getWindows: () => WindowControl[];
+    getWindows: (options?: GetWindowsOptions) => WindowControl[];
     channel: WindowChannel | undefined;
     events: {
         on: (event: 'settingsChange', callback: () => unknown) => void;
@@ -184,6 +192,9 @@ type StatusWarning = {
 };
 export type ExtensionStatus = StatusOk | StatusLoading | StatusError | StatusWarning;
 export type SettingDefinition = BooleanSetting | NumberSetting | StringSetting | ArrayStringSetting | ArrayObjectSetting;
+/**
+ * @public
+ */
 export type Extension = {
     id?: string;
     name?: string;
@@ -222,6 +233,7 @@ export type SliprailMain = {
         message: string;
     }) => any;
     showAlert: (message: string) => void;
+    showConfirm: (message: string) => Promise<boolean>;
     writeTextToClipboard: (content: string) => void;
     writeHTMLToClipboard: (content: {
         html: string;
@@ -268,6 +280,10 @@ export type SliprailRenderer = {
     debugLog: (...logs: unknown[]) => void;
 };
 declare global {
+    /**
+     * @public
+     * A global constant that can be called in the sliprail extension window.
+     */
     var sliprail: SliprailRenderer;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sliprail/sdk",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "license": "MIT",
   "type": "module",
   "main": "lib/index.mjs",
@@ -9,13 +9,22 @@
   ],
   "types": "lib/index.d.ts",
   "dependencies": {
-    "@types/react": "^18.3.23"
+    "@types/react": "^18.3.24"
   },
   "devDependencies": {
-    "@types/node": "^20.19.11",
+    "@types/node": "^20.19.25",
     "typescript": "5.6.3"
   },
   "engines": {
     "node": ">=20"
+  },
+  "magis": {
+    "doc": {
+      "backUrl": {
+        "url": "https://sliprail.fengcen.io",
+        "title": "Sliprail",
+        "logo": "../../../packages/react-commons/src/assets/sliprail.svg"
+      }
+    }
   }
 }