@sliprail/sdk 0.1.12 → 0.1.14

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,10 @@ export type LivePreviewContent = {
     content: string;
     type?: 'info' | 'warn' | 'error' | 'hint';
 };
+type WindowScope = 'shortcut' | 'extension';
+export type GetWindowsOptions = {
+    scope?: WindowScope;
+};
 /**
  * @public
  */
@@ -69,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;
@@ -88,14 +93,20 @@ export type ShortcutPreview = {
     style?: CSSProperties;
 };
 export type ShortcutContextMenu = {
-    displayName: string;
+    displayName: LocalizedString;
     executeShortcutId: string;
 };
+export type SupportedLanguage = 'en' | 'zh-hans';
+export type LocalizedString = string | ({
+    en: string;
+} & {
+    [key in Exclude<SupportedLanguage, 'en'>]?: string;
+});
 export type Shortcut = {
     id: string;
-    displayName: string;
+    displayName: LocalizedString;
     hidden?: boolean;
-    description?: string;
+    description?: LocalizedString;
     icon?: string | {
         src: string;
         template?: boolean;
@@ -118,9 +129,9 @@ export type ExtensionSettingValue = undefined | boolean | string | string[] | Ex
 export type ExtensionSettings = Record<string, ExtensionSettingValue>;
 type CommonSettingOptions = {
     id: string;
-    displayName: string;
+    displayName: LocalizedString;
     prependDescription?: string | string[];
-    description?: string;
+    description?: LocalizedString;
     defaultValue?: unknown;
     refreshOnOtherChange?: boolean | string | string[];
     showRefreshOnError?: boolean;
@@ -192,7 +203,7 @@ export type SettingDefinition = BooleanSetting | NumberSetting | StringSetting |
  */
 export type Extension = {
     id?: string;
-    name?: string;
+    name?: LocalizedString;
     role?: string;
     icon?: string | {
         src: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sliprail/sdk",
-  "version": "0.1.12",
+  "version": "0.1.14",
   "license": "MIT",
   "type": "module",
   "main": "lib/index.mjs",
@@ -12,7 +12,7 @@
     "@types/react": "^18.3.24"
   },
   "devDependencies": {
-    "@types/node": "^20.19.24",
+    "@types/node": "^20.19.25",
     "typescript": "5.6.3"
   },
   "engines": {