@sliprail/sdk 0.1.10 → 0.1.12

package/lib/index.d.ts

@@ -59,9 +59,13 @@ export type LivePreviewContent = {
     content: string;
     type?: 'info' | 'warn' | 'error' | 'hint';
 };
+/**
+ * @public
+ */
 export type ShortcutContext = SliprailMain & {
     parameter: any;
     subShortcutId: string;
+    subShortcutFilter: string | undefined;
     getSettings: (keys?: string[]) => Promise<Record<string, unknown>>;
     createWindow: (options: WindowOptions) => WindowControl;
     createStorage: () => KVStorage;
@@ -83,6 +87,10 @@ export type ShortcutPreview = {
     text: string;
     style?: CSSProperties;
 };
+export type ShortcutContextMenu = {
+    displayName: string;
+    executeShortcutId: string;
+};
 export type Shortcut = {
     id: string;
     displayName: string;
@@ -97,7 +105,9 @@ export type Shortcut = {
     prependKeywords?: string[];
     appendKeywords?: string[];
     handle?: (context: ShortcutContext) => Promise<unknown> | unknown;
+    subShortcutFilters?: string[];
     subShortcuts?: SubShortcut[] | ((context: LoadSubShortcutsContext) => Promise<SubShortcut[]> | SubShortcut[]);
+    onSubShortcutContextMenu?: (context: ShortcutContext) => ShortcutContextMenu[] | Promise<ShortcutContextMenu[]>;
     subShortcutPreview?: (context: ShortcutContext) => Promise<ShortcutPreview | undefined> | ShortcutPreview | undefined;
     livePreview?: (parameters: string) => Promise<LivePreviewContent | undefined> | LivePreviewContent | undefined;
 };
@@ -177,6 +187,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;
@@ -215,6 +228,7 @@ export type SliprailMain = {
         message: string;
     }) => any;
     showAlert: (message: string) => void;
+    showConfirm: (message: string) => Promise<boolean>;
     writeTextToClipboard: (content: string) => void;
     writeHTMLToClipboard: (content: {
         html: string;
@@ -239,6 +253,7 @@ export type SliprailRenderer = {
         extensionId: string;
         shortcutId: string;
         parameter?: string;
+        subShortcutId?: string;
     }) => Promise<unknown>;
     getParameters: () => Promise<Record<string, unknown>>;
     openExtensionSettings: () => void;
@@ -260,6 +275,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.10",
+  "version": "0.1.12",
   "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.24",
     "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"
+      }
+    }
   }
 }