@zhin.js/client 1.1.4 → 1.1.6

package/dist/transport/hooks.d.ts

@@ -0,0 +1,253 @@
+import type { UseConsoleTransportOptions } from "./types.js";
+export declare function useConsoleTransport(options?: UseConsoleTransportOptions): {
+    connected: boolean;
+    connect: () => void;
+    disconnect: () => void;
+    send: (message: unknown) => void;
+    sendRequest: <T = unknown>(message: unknown) => Promise<T>;
+    manager: import("./console-transport.js").ConsoleTransport;
+};
+/**
+ * 按 key 绑定异步加载结果：key（如 pluginName）切换后，旧 key 的残留值视为 null，
+ * 避免 useConfig 的 ready 判断（config != null）被上一插件的 state 挡住而不再加载新配置。
+ * @internal
+ */
+export declare function resolveKeyedValue<T>(entry: {
+    readonly key: string;
+    readonly value: T;
+} | null, key: string): T | null;
+export declare function useConfig(pluginName: string, options?: {
+    autoLoad?: boolean;
+    autoLoadSchema?: boolean;
+}): {
+    config: unknown;
+    schema: unknown;
+    loading: boolean;
+    error: string | null;
+    connected: boolean;
+    getConfig: () => Promise<unknown>;
+    setConfig: (newConfig: unknown) => Promise<{
+        success?: boolean;
+        reloaded?: boolean;
+        message?: string;
+    }>;
+    getSchema: () => Promise<unknown>;
+};
+export declare function useConfigSource(): {
+    source: string;
+    format: "json" | "yaml";
+    revision: string;
+    configKeys: string[];
+    loading: boolean;
+    error: string | null;
+    load: () => Promise<import("@zhin.js/console-protocol").ConsoleConfigSource>;
+    save: (content: string) => Promise<{
+        success: boolean;
+        revision: string;
+        restartRequired: boolean;
+        message?: string;
+    }>;
+};
+/** Shared Console flow for previewing and committing a plugin installation. */
+export declare function usePluginInstall(): {
+    plan: {
+        packageName: string;
+        instanceKey: string;
+        alreadyDeclared: boolean;
+        alreadyInstalled: boolean;
+        restartRequired: boolean;
+        changes: {
+            packageManifest: string;
+            config: string;
+        };
+        warnings: string[];
+    } | null;
+    loading: boolean;
+    error: string | null;
+    preview: (packageName: string) => Promise<{
+        packageName: string;
+        instanceKey: string;
+        alreadyDeclared: boolean;
+        alreadyInstalled: boolean;
+        restartRequired: boolean;
+        changes: {
+            packageManifest: string;
+            config: string;
+        };
+        warnings: string[];
+    }>;
+    install: (packageName: string, expectedRevision?: string) => Promise<{
+        success: boolean;
+        plan: Awaited<ReturnType<import("./console-transport.js").ConsoleTransport["planPluginInstall"]>>;
+        restartRequired: boolean;
+    }>;
+};
+export declare function usePluginConfigValidation(pluginName: string): {
+    loading: boolean;
+    error: string | null;
+    validate: (data: unknown) => Promise<{
+        valid: boolean;
+        errors: {
+            path: string;
+            message: string;
+        }[];
+        missingEnv: string[];
+    }>;
+};
+export declare function usePluginDiagnostics(pluginName: string): {
+    loading: boolean;
+    error: string | null;
+    diagnose: () => Promise<{
+        pluginName: string;
+        plan: unknown;
+        validation: {
+            valid: boolean;
+            errors: {
+                path: string;
+                message: string;
+            }[];
+            missingEnv: string[];
+        };
+    }>;
+};
+export declare function usePluginLifecycle(instanceKey: string): {
+    loading: boolean;
+    error: string | null;
+    setEnabled: (enabled: boolean) => Promise<{
+        success: boolean;
+        instanceKey: string;
+        enabled: boolean;
+        disabled: string[];
+        restartRequired: boolean;
+        message: string;
+    }>;
+};
+export declare function usePluginUninstall(): {
+    loading: boolean;
+    error: string | null;
+    preview: (packageName: string) => Promise<{
+        packageName: string;
+        instanceKey: string;
+        installed: boolean;
+        declared: boolean;
+        hasConfig: boolean;
+        restartRequired: boolean;
+    }>;
+    uninstall: (packageName: string, expectedRevision?: string) => Promise<{
+        success: boolean;
+        plan: Awaited<ReturnType<import("./console-transport.js").ConsoleTransport["planPluginUninstall"]>>;
+        restartRequired: boolean;
+    }>;
+};
+export declare function usePluginUpdate(): {
+    loading: boolean;
+    error: string | null;
+    preview: (packageName: string, targetVersion: string) => Promise<{
+        packageName: string;
+        instanceKey: string;
+        currentVersion: string | null;
+        targetVersion: string;
+        installed: boolean;
+        declared: boolean;
+        alreadyCurrent: boolean;
+        restartRequired: boolean;
+    }>;
+    update: (packageName: string, targetVersion: string, expectedRevision?: string) => Promise<{
+        success: boolean;
+        plan: Awaited<ReturnType<import("./console-transport.js").ConsoleTransport["planPluginUpdate"]>>;
+        installedVersion: string;
+        restartRequired: boolean;
+    }>;
+};
+export declare function useEndpointTest(adapter: string, endpointKey: string): {
+    loading: boolean;
+    error: string | null;
+    test: () => Promise<{
+        reachable: boolean;
+        connected: boolean;
+        status?: "online" | "offline";
+        phase: string;
+        pendingLogin?: boolean;
+        latencyMs: number;
+        message: string;
+    }>;
+};
+export declare function usePluginMarketplace(): {
+    loading: boolean;
+    error: string | null;
+    search: (query?: Parameters<(query?: {
+        keyword?: string;
+        category?: string;
+        official?: boolean;
+        page?: number;
+        pageSize?: number;
+    }) => Promise<unknown>>[0]) => Promise<unknown>;
+    detail: (packageName: string) => Promise<unknown>;
+    updates: () => Promise<Record<string, unknown>[]>;
+    installed: () => Promise<Record<string, unknown>[]>;
+};
+export declare function useFiles(): {
+    tree: import("./types.js").FileTreeNode[];
+    loading: boolean;
+    error: string | null;
+    loadTree: () => Promise<import("./types.js").FileTreeNode[]>;
+    readFile: (filePath: string) => Promise<string>;
+    saveFile: (filePath: string, content: string) => Promise<{
+        success: boolean;
+        message?: string;
+    }>;
+};
+export declare function useEnvFiles(): {
+    files: {
+        name: string;
+        exists: boolean;
+    }[];
+    loading: boolean;
+    error: string | null;
+    listFiles: () => Promise<{
+        name: string;
+        exists: boolean;
+    }[]>;
+    getFile: (filename: string) => Promise<string>;
+    saveFile: (filename: string, content: string) => Promise<{
+        success: boolean;
+        message?: string;
+    }>;
+};
+export declare function useDatabase(): {
+    info: import("./types.js").DatabaseInfo | null;
+    tables: import("./types.js").TableInfo[];
+    loading: boolean;
+    error: string | null;
+    loadInfo: () => Promise<import("./types.js").DatabaseInfo>;
+    loadTables: () => Promise<import("./types.js").TableInfo[]>;
+    dropTable: (table: string) => Promise<{
+        success: boolean;
+    }>;
+    select: (table: string, page?: number, pageSize?: number, where?: unknown) => Promise<import("./types.js").SelectResult>;
+    insert: (table: string, row: unknown) => Promise<{
+        success: boolean;
+    }>;
+    update: (table: string, row: unknown, where: unknown) => Promise<{
+        success: boolean;
+        affected: number;
+    }>;
+    remove: (table: string, where: unknown) => Promise<{
+        success: boolean;
+        deleted: number;
+    }>;
+    kvGet: (table: string, key: string) => Promise<{
+        key: string;
+        value: unknown;
+    }>;
+    kvSet: (table: string, key: string, value: unknown, ttl?: number) => Promise<{
+        success: boolean;
+    }>;
+    kvDelete: (table: string, key: string) => Promise<{
+        success: boolean;
+    }>;
+    kvEntries: (table: string) => Promise<{
+        entries: import("./types.js").KvEntry[];
+    }>;
+};
+//# sourceMappingURL=hooks.d.ts.map

package/dist/transport/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../client/transport/hooks.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAC;AAoB7D,wBAAgB,mBAAmB,CAAC,OAAO,GAAE,0BAA+B;;;;oBAWvC,OAAO;kBAEvC,CAAC,qBAAqB,OAAO;;EASjC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,KAAK,EAAE;IAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAAG,IAAI,EACzD,GAAG,EAAE,MAAM,GACV,CAAC,GAAG,IAAI,CAEV;AAED,wBAAgB,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,cAAc,CAAC,EAAE,OAAO,CAAA;CAAE;;;;;;;2BA6BlF,OAAO;;;;;;EAoC5B;AAED,wBAAgB,eAAe;;;;;;;;oBA+BX,MAAM;;;;;;EA2BzB;AAED,+EAA+E;AAC/E,wBAAgB,gBAAgB;;;;;;;;;;;;;;;2BAMkB,MAAM;;;;;;;;;;;;2BAeN,MAAM,qBAAqB,MAAM;;;;;EAgBlF;AAED,wBAAgB,yBAAyB,CAAC,UAAU,EAAE,MAAM;;;qBAIhB,OAAO;;;;;;;;EAalD;AAED,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM;;;;;;;;;;;;;;;EAiBtD;AAED,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM;;;0BAIL,OAAO;;;;;;;;EAavD;AAED,wBAAgB,kBAAkB;;;2BAIgB,MAAM;;;;;;;;6BAYJ,MAAM,qBAAqB,MAAM;;;;;EAepF;AAED,wBAAgB,eAAe;;;2BAIa,MAAM,iBAAiB,MAAM;;;;;;;;;;0BAU9B,MAAM,iBAAiB,MAAM,qBAAqB,MAAM;;;;;;EAWlG;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;;;;;;;;;;;;EAiBnE;AAED,wBAAgB,oBAAoB;;;qBAiBvB,UAAU;eA8FoB,CAAC;gBAAsB,CAAC;gBAC9C,CAAA;YAAmB,CAAC;gBAEzC,CAAA;2BAjG2D,CAAC,CAAC,CAAC;0BAK5C,MAAM;;;EAQvB;AAED,wBAAgB,QAAQ;;;;;yBAwBwB,MAAM;yBAEjC,MAAM,WAAW,MAAM;;;;EAS3C;AAED,wBAAgB,WAAW;;cAGwB,MAAM;gBAAU,OAAO;;;;;;;;wBAsBrD,MAAM;yBAQN,MAAM,WAAW,MAAM;;;;EAY3C;AAED,wBAAgB,WAAW;;;;;;;uBA0CmB,MAAM;;;oBAJT,MAAM,SAAS,MAAM,aAAa,MAAM,UAAU,OAAO;oBACzD,MAAM,OAAO,OAAO;;;oBACpB,MAAM,OAAO,OAAO,SAAS,OAAO;;;;oBACpC,MAAM,SAAS,OAAO;;;;mBAEvB,MAAM,OAAO,MAAM;;;;mBACnB,MAAM,OAAO,MAAM,SAAS,OAAO,QAAQ,MAAM;;;sBAC9C,MAAM,OAAO,MAAM;;;uBAClB,MAAM;;;EAWnD"}