@sliprail/sdk 0.1.20 → 0.1.22

package/lib/activity.d.ts

@@ -0,0 +1,29 @@
+import { LocalizedString } from './index';
+export type ActivityState = 'running' | 'paused' | 'completed' | 'failed' | 'canceled';
+export type ActivityUpdateOptions = {
+    progressFraction?: number;
+    statusText?: LocalizedString;
+    state?: ActivityState;
+};
+export type Activity = {
+    id: string;
+    update: (options: ActivityUpdateOptions) => void;
+};
+export type ActivityOptions = {
+    title: LocalizedString;
+    subtitle?: LocalizedString;
+    statusText?: LocalizedString;
+    progressFraction?: number;
+    onClick?: () => void | Promise<void>;
+    onAbort?: () => void | Promise<void>;
+    onPause?: () => void | Promise<void>;
+    onResume?: () => void | Promise<void>;
+};
+/**
+ * @public
+ */
+export type SliprailActivity = {
+    create: (options: ActivityOptions) => Activity;
+    get: (id: string) => Activity | undefined;
+    list: () => Activity[];
+};

package/lib/ai.d.ts

@@ -0,0 +1,119 @@
+export type AIModelTier = 'fast' | 'balanced' | 'advanced';
+export type AIJsonPrimitive = string | number | boolean | null;
+export type AIJsonObject = {
+    [key: string]: AIJsonValue;
+};
+export type AIJsonValue = AIJsonPrimitive | AIJsonObject | AIJsonValue[];
+export type AIJsonSchema = {
+    type: 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'null';
+    description: string;
+    enum?: AIJsonPrimitive[];
+    const?: AIJsonValue;
+    properties?: Record<string, AIJsonSchema>;
+    required?: string[];
+    items?: AIJsonSchema;
+    additionalProperties?: boolean | AIJsonSchema;
+};
+export type AIObjectSchema = AIJsonSchema & {
+    type: 'object';
+    properties?: Record<string, AIJsonSchema>;
+};
+export type AITool = {
+    name: string;
+    description: string;
+    parameters: AIObjectSchema;
+};
+export type AIFileSource = {
+    type: 'inline';
+    data: Blob | ArrayBuffer | Uint8Array;
+} | {
+    type: 'url';
+    url: string;
+} | {
+    type: 'path';
+    path: string;
+};
+export type AIInputPart = {
+    type: 'text';
+    text: string;
+} | {
+    type: 'file';
+    mimeType: string;
+    filename?: string;
+    source: AIFileSource;
+} | {
+    type: 'tool-result';
+    id: string;
+    name: string;
+    result: AIJsonValue;
+};
+export type AIInput = string | AIInputPart[];
+export type AISessionRequest = {
+    input: AIInput;
+    tools?: AITool[];
+    signal?: AbortSignal;
+};
+export type AIRequest = AISessionRequest & {
+    modelTier?: AIModelTier;
+    instructions?: string;
+};
+export type AIOutputFile = {
+    mimeType: string;
+    url: string;
+    filename?: string;
+};
+export type AIChunk = {
+    type: 'text';
+    text: string;
+} | {
+    type: 'file';
+    file: AIOutputFile;
+} | {
+    type: 'tool';
+    id: string;
+    name: string;
+    arguments: AIJsonObject;
+} | {
+    type: 'done';
+    reason: 'completed' | 'tool' | 'cancelled';
+} | {
+    type: 'done';
+    reason: 'error';
+    error: string;
+};
+export type AIResponse = AsyncIterable<AIChunk>;
+export type AISessionSummary = {
+    id: string;
+    title?: string;
+    modelTier?: AIModelTier;
+    tag?: string;
+    createdAt: string;
+    updatedAt: string;
+};
+export type AISessionOptions = {
+    title?: string;
+    modelTier?: AIModelTier;
+    instructions?: string;
+    tag?: string;
+};
+export type AIListSessionsOptions = {
+    tag?: string;
+};
+export type AISession = {
+    request: (request: AISessionRequest) => AIResponse;
+    delete: () => Promise<void>;
+    id: string;
+    title?: string;
+    modelTier?: AIModelTier;
+    tag?: string;
+};
+/**
+ * @public
+ */
+export type SliprailAI = {
+    request: (request: AIRequest) => AIResponse;
+    createSession: (options?: AISessionOptions) => Promise<AISession>;
+    getSession: (sessionId: string) => Promise<AISession | undefined>;
+    listSessions: (options?: AIListSessionsOptions) => Promise<AISessionSummary[]>;
+    deleteSession: (sessionId: string) => Promise<void>;
+};

package/lib/index.d.ts

@@ -1,4 +1,6 @@
 import type { CSSProperties } from 'react';
+import type { SliprailAI } from './ai';
+import { SliprailActivity } from './activity';
 export type SelectFilesOptions = {
     type?: 'single-file' | 'multiple-files' | 'directory';
     extensions?: string[];
@@ -77,6 +79,8 @@ export type ShortcutContext = SliprailMain & {
     createStorage: () => KVStorage;
     getWindows: (options?: GetWindowsOptions) => WindowControl[];
     channel: WindowChannel | undefined;
+    ai: SliprailAI;
+    activity: SliprailActivity;
     toPreviewUrl: (filePath: string) => string;
     events: {
         on: (event: 'settingsChange', callback: () => unknown) => void;
@@ -261,6 +265,7 @@ export type SliprailMain = {
     getPath: (name: 'home' | 'appData' | 'userData' | 'sessionData' | 'temp' | 'exe' | 'module' | 'desktop' | 'documents' | 'downloads' | 'music' | 'pictures' | 'videos' | 'recent' | 'logs' | 'crashDumps') => string;
 };
 export type SliprailRenderer = {
+    ai: SliprailAI;
     executeShortcut: (parameters: {
         extensionId: string;
         shortcutId: string;

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@sliprail/sdk",
-  "version": "0.1.20",
+  "version": "0.1.22",
   "license": "MIT",
   "type": "module",
   "main": "lib/index.mjs",
   "files": [
-    "lib/index.d.ts"
+    "lib/*.d.ts"
   ],
   "types": "lib/index.d.ts",
   "dependencies": {
     "@types/react": "^18.3.27"
   },
   "devDependencies": {
-    "@types/node": "^20.19.27",
-    "typescript": "5.6.3"
+    "@types/node": "^20.19.37",
+    "typescript": "5.9.3"
   },
   "engines": {
     "node": ">=20"