@sliprail/sdk 0.1.0

package/lib/index.d.ts

@@ -0,0 +1,221 @@
+export type SelectFilesOptions = {
+    type?: 'single-file' | 'multiple-files' | 'directory';
+    extensions?: string[];
+};
+export type WindowInfo = {
+    title: string;
+    pid: number;
+    handle: number;
+    appName: string;
+    filePath: string;
+    icon?: string;
+};
+export type WindowChannel = {
+    on: (event: string, callback: (...data: any[]) => void) => void;
+    off: (event: string, callback: (...data: any[]) => void) => void;
+    once: (event: string, callback: (...data: any[]) => void) => void;
+    emit: (event: string, ...data: unknown[]) => void;
+    removeAllListeners: () => void;
+    destroy: () => void;
+    _window: unknown;
+    _emitter: unknown;
+};
+export type ShowWindowOptions = {
+    htmlFile: string;
+    title?: string;
+    width?: number;
+    height?: number;
+    maximize?: boolean;
+    parameters?: Record<string, unknown>;
+    channel?: WindowChannel;
+    resizable?: boolean;
+    onClose?: () => void;
+};
+export type WindowControl = {
+    close: () => void;
+    show: () => void;
+    _runtime?: unknown;
+};
+export type KVStorage = {
+    set: (key: string, value: unknown) => Promise<void>;
+    get: (key: string) => Promise<unknown | undefined>;
+    has: (key: string) => Promise<boolean>;
+    remove: (key: string) => Promise<void>;
+};
+export type LoadChildShortcutsContext = {
+    signal: AbortSignal;
+};
+export type LivePreviewContent = {
+    content: string;
+    type?: 'info' | 'warn' | 'error' | 'hint';
+};
+export type ShortcutContext = {
+    parameter: any;
+    getSettings: () => Promise<Record<string, unknown>>;
+    showWindow: (showWindow: ShowWindowOptions) => WindowControl;
+    createStorage: () => KVStorage;
+    channel: WindowChannel | undefined;
+    events: {
+        on: (event: 'settingsChange', callback: () => unknown) => void;
+    };
+};
+export type Shortcut = {
+    id: string;
+    displayName: string;
+    hidden?: boolean;
+    description?: string;
+    icon?: string | {
+        src: string;
+        template?: boolean;
+        fallbackIcon?: string;
+    };
+    prependKeywords?: string[];
+    appendKeywords?: string[];
+    handle?: (context: ShortcutContext) => Promise<unknown> | unknown;
+    childShortcuts?: Shortcut[] | ((context: LoadChildShortcutsContext) => Promise<Shortcut[]> | Shortcut[]);
+    livePreview?: (parameters: string) => Promise<LivePreviewContent | undefined> | LivePreviewContent | undefined;
+};
+export type ExtensionSettingValue = undefined | boolean | string | string[] | ExtensionSettings[];
+export type ExtensionSettings = Record<string, ExtensionSettingValue>;
+export type ExtensionInfo = {
+    id: string;
+    displayName?: string;
+    settingValues: Record<string, any>;
+    settingDefinitions?: SettingDefinition[];
+    hasSettings: boolean;
+    hasStatus: boolean;
+};
+type CommonSettingOptions = {
+    id: string;
+    displayName: string;
+    prependDescription?: string | string[];
+    description?: string;
+    defaultValue?: unknown;
+    refreshOnOtherChange?: boolean | string | string[];
+    showRefreshOnError?: boolean;
+};
+export type BooleanSetting = CommonSettingOptions & {
+    type: 'boolean';
+    enableConfirmMessage?: string;
+    disableConfirmMessage?: string;
+};
+export type NumberSetting = CommonSettingOptions & {
+    type: 'number';
+    control?: 'input' | {
+        type: 'select';
+        options: OptionItem[];
+    };
+};
+export type StringSetting = CommonSettingOptions & {
+    type: 'string';
+    placeholder?: string;
+    control?: 'input' | 'textarea' | {
+        type: 'textarea';
+        autoHeight?: boolean;
+        rows?: number;
+        maxRows?: number;
+    };
+};
+export type ArrayObjectSetting = CommonSettingOptions & {
+    type: 'array-object';
+    subSettings: SettingDefinition[];
+};
+export type OptionItem = {
+    label?: string;
+    value: string;
+    group?: string;
+    description?: string;
+};
+export type ArrayStringSetting = CommonSettingOptions & {
+    type: 'array-string';
+    control: {
+        type: 'checkbox-group';
+        options: OptionItem[];
+    };
+};
+type StatusOk = {
+    status: 'ok';
+    message?: string;
+};
+type StatusLoading = {
+    status: 'loading';
+    message?: string;
+};
+type StatusError = {
+    status: 'error';
+    message: string;
+    onRetry?: () => unknown;
+};
+type StatusWarning = {
+    status: 'warning';
+    message: string;
+};
+export type ExtensionStatus = StatusOk | StatusLoading | StatusError | StatusWarning;
+export type SettingDefinition = BooleanSetting | NumberSetting | StringSetting | ArrayStringSetting | ArrayObjectSetting;
+export type Extension = {
+    id?: string;
+    name?: string;
+    role?: string;
+    icon?: string | {
+        src: string;
+        template?: boolean;
+    };
+    shortcuts: Shortcut[] | ((context: ShortcutContext) => Shortcut[] | Promise<Shortcut[]>);
+    settings?: SettingDefinition[] | ((context: ShortcutContext) => SettingDefinition[] | Promise<SettingDefinition[]>);
+    onReady?: (context: ShortcutContext) => unknown;
+    onDisabled?: (context: ShortcutContext) => unknown;
+    defaultCloudSync?: boolean;
+    beforeSaveSettings?: (context: ShortcutContext, settings: ExtensionSettings) => ExtensionSettings | Promise<ExtensionSettings>;
+    getStatus?: (context: ShortcutContext) => ExtensionStatus | Promise<ExtensionStatus>;
+};
+export type SliprailMain = {
+    openUrl: (url: string) => void;
+    openPath: (path: string) => void;
+    openFileLocation: (path: string) => void;
+    copyFilesToClipboard: (paths: string[]) => void;
+    saveTextFile: (options: {
+        filename: string;
+        content: string;
+    }) => Promise<void>;
+    cutFilesToClipboard: (paths: string[]) => void;
+    selectFiles: (options?: SelectFilesOptions) => Promise<string[]>;
+    showNotification: (options: {
+        title: string;
+        message: string;
+    }) => any;
+    showAlert: (message: string) => void;
+    copyToClipboard: (content: string) => void;
+    pasteFromClipboard: () => string;
+    getSystemWindows: () => Promise<WindowInfo[]>;
+    captureAllDisplays: () => Promise<string[]>;
+    createWindowChannel: () => WindowChannel;
+    debugLog: (...logs: unknown[]) => void;
+};
+export type SliprailRenderer = {
+    executeShortcut: (parameters: {
+        extensionId: string;
+        shortcutId: string;
+        parameter?: string;
+    }) => Promise<unknown>;
+    getParameters: () => Promise<Record<string, unknown>>;
+    openExtensionSettings: () => void;
+    createWindowChannel: () => WindowChannel;
+    openUrl: (url: string) => void;
+    openPath: (path: string) => void;
+    openFileLocation: (path: string) => void;
+    copyFilesToClipboard: (paths: string[]) => void;
+    cutFilesToClipboard: (paths: string[]) => void;
+    selectDirectory: () => Promise<string | undefined>;
+    openSettings: () => Promise<void>;
+    saveTextFile: (options: {
+        filename: string;
+        content: string;
+    }) => Promise<void>;
+    saveFile: (file: File) => Promise<void>;
+    saveBase64File: (filename: string, base64Content: string) => Promise<void>;
+};
+declare global {
+    var sliprailMain: SliprailMain;
+    var sliprailRenderer: SliprailRenderer;
+}
+export {};

package/lib/index.mjs

@@ -0,0 +1,2 @@
+/* eslint-disable */export {};
+//# sourceMappingURL=index.mjs.map

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@sliprail/sdk",
+  "version": "0.1.0",
+  "license": "MIT",
+  "type": "module",
+  "main": "lib/index.mjs",
+  "files": [
+    "lib/index.mjs",
+    "lib/index.d.ts"
+  ],
+  "devDependencies": {
+    "@types/node": "^20.19.9",
+    "typescript": "5.6.3"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}