@kengic/core.react 0.0.2-beta.21 → 0.0.2-beta.22

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kengic/core.react",
-    "version": "0.0.2-beta.21",
+    "version": "0.0.2-beta.22",
     "type": "module",
     "main": "./kengic-core.react.js",
     "module": "./kengic-core.react.js",

package/src/component/Kg/index.store.d.ts

@@ -1,10 +1,20 @@
 import { PayloadAction, Slice, SliceSelectors } from '@reduxjs/toolkit';
 import { type IState } from '../../index.store.ts';
 export interface IKgOption {
+    /** SQL 客户端. */
+    KgSqlClient?: {
+        /**
+         * 是否启用功能.
+         *
+         * @default true
+         */
+        isOn?: boolean;
+    };
     /** 选择工作站. */
     KgWorkStation?: {
         /**
          * 是否启用功能.
+         *
          * @default true
          */
         isOn?: boolean;
@@ -20,4 +30,4 @@ export declare const KgSlice: Slice<IKgState, {
     optionReducer(state: IKgState, action: PayloadAction<IKgOption | null | undefined>): void;
 }, string, string, SliceSelectors<IKgState>>;
 export declare const optionReducer: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<IKgOption | null | undefined, `${string}/optionReducer`>;
-export declare function optionSelector(state: IState): IKgOption;
+export declare function kgOptionSelector(state: IState): IKgOption;

package/src/component/KgSqlClient/KgSqlClient.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import './KgSqlClient.css';
+/**
+ * SQL 客户端.
+ */
+export declare function KgSqlClient(): React.JSX.Element | null;

package/src/component/KgSqlClient/index.d.ts

@@ -0,0 +1,3 @@
+export * from './KgSqlClient.tsx';
+export * from './index.hooks';
+export * from './index.store';

package/src/component/KgSqlClient/index.event.d.ts

@@ -0,0 +1,24 @@
+import { IKgEventListener } from '@kengic/core.core';
+/**
+ * 事件类型.
+ */
+export type IKgSqlClientEvent = 'onMount';
+export type IKgSqlClientOnMountEventListenerParameter = {};
+export type IKgSqlClientOnMountEventListener = ((param: IKgSqlClientOnMountEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export type IKgSqlClientEventListenerParameter = IKgSqlClientOnMountEventListenerParameter;
+export type IKgSqlClientEventListener = IKgSqlClientOnMountEventListener;
+export declare const eventListeners: Record<string, {
+    onMount: Array<IKgSqlClientOnMountEventListener>;
+}>;
+/**
+ * 触发事件.
+ *
+ * @param param.event 事件名称.
+ * @param param.id 唯一标识.
+ * @param param.parameter 事件参数.
+ */
+export declare function emit<P = IKgSqlClientEventListenerParameter>(param: {
+    event: IKgSqlClientEvent;
+    id?: string | undefined;
+    parameter?: P;
+}): Promise<boolean>;

package/src/component/KgSqlClient/index.hooks.d.ts

@@ -0,0 +1,42 @@
+import { IRemoveEventListener } from '@kengic/core.core';
+import { store } from '../../index.store.ts';
+import { IKgSqlClientOnMountEventListener } from './index.event';
+import { IKgSqlClientState } from './index.store';
+export interface IDoKgSqlClient {
+    /**
+     * <p>获取某个状态数据. 在 vue 项目中使用.</p>
+     *
+     * @param fn 获取函数, 该函数由框架调用并传入状态数据作为参数, 调用者从参数中获取想要的数据.
+     * @return 返回一个数组, 包含两个元素, 第一个元素是要获取的数据, 是一个 ref 数据, 第二个元素是一个退订函数, 由调用者负责在合适的时候调用, 用于移除对该数据的变更监听.
+     */
+    get<T extends {
+        value: any;
+    }>(fn: (state: IKgSqlClientState[string]) => any): [T, () => void];
+    id: string;
+    /**
+     * 监听事件: 挂载.
+     *
+     * @param listener 事件监听函数.
+     * @param isOnce 是否只会触发一次. 默认为 undefined.
+     */
+    onMount(listener: IKgSqlClientOnMountEventListener, isOnce?: boolean): IRemoveEventListener;
+    /**
+     * 设置数据.
+     *
+     * @param fn 设置函数.
+     */
+    set(fn: (state: IKgSqlClientState[string]) => void): void;
+    store: typeof store;
+    /**
+     * 订阅数据变更.
+     *
+     * @param fn 回调函数, 可以通过参数 state 获取到最新的数据.
+     */
+    subscribe(fn: (state: IKgSqlClientState[string]) => void): () => void;
+}
+/**
+ * 在 react 中如果函数以 use 为前缀, 会被当成 hook 函数, 因此这个函数使用了 do 作为前缀.
+ *
+ * @param id 唯一标识.
+ */
+export declare function doKgSqlClient(id?: string): IDoKgSqlClient;

package/src/component/KgSqlClient/index.store.d.ts

@@ -0,0 +1,50 @@
+import { PayloadAction } from '@reduxjs/toolkit';
+import { KgSqlClientProps } from './index.vm';
+export type IKgSqlClientState = Record<string, {
+    /**
+     * 是否已经完成挂载.
+     */
+    isMount: boolean;
+    /**
+     * 组件参数.
+     */
+    props?: KgSqlClientProps;
+}>;
+export declare const KgSqlClientSlice: import("@reduxjs/toolkit").Slice<IKgSqlClientState, {
+    /**
+     * 挂载. 组件做初始化.
+     *
+     * @param state
+     * @param action
+     */
+    mountReducer(state: IKgSqlClientState, action: PayloadAction<{
+        id: string | null | undefined;
+    }>): void;
+    /**
+     * 设置数据.
+     *
+     * @param state
+     * @param action
+     */
+    setReducer(state: IKgSqlClientState, action: PayloadAction<{
+        id: string | null | undefined;
+        fn: (state: IKgSqlClientState[string]) => void;
+    }>): void;
+    /**
+     * 卸载. 释放组件资源.
+     *
+     * @param state
+     * @param action
+     */
+    unmountReducer(state: IKgSqlClientState, action: PayloadAction<{
+        id: string | null | undefined;
+    }>): void;
+}, "KgSqlClient", "KgSqlClient", import("@reduxjs/toolkit").SliceSelectors<IKgSqlClientState>>;
+export declare const setReducer: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    id: string | null | undefined;
+    fn: (state: IKgSqlClientState[string]) => void;
+}, "KgSqlClient/setReducer">, mountReducer: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    id: string | null | undefined;
+}, "KgSqlClient/mountReducer">, unmountReducer: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    id: string | null | undefined;
+}, "KgSqlClient/unmountReducer">;

package/src/component/KgSqlClient/index.vm.d.ts

@@ -0,0 +1,2 @@
+export interface KgSqlClientProps {
+}

package/src/component/KgSqlClient/index.wc.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 注册组件.
+ */
+export declare function initKgSqlClientElement(): void;

package/src/component/KgWorkStation/index.event.d.ts

@@ -1,8 +1,6 @@
 import { IKgEventListener } from '@kengic/core.core';
 /**
  * 事件类型.
- *   'onMount':          挂载
- *   'onOk':             确定
  */
 export type IKgWorkStationEvent = 'onMount' | 'onOk';
 export type IKgWorkStationOnMountEventListenerParameter = {};

package/src/component/KgWorkStation/index.store.d.ts

@@ -7,6 +7,9 @@ export type IKgWorkStationState = Record<string, {
      * 是否已经完成挂载.
      */
     isMount: boolean;
+    /**
+     * 组件参数.
+     */
     props?: KgWorkStationProps;
     /**
      * 当前选择的工作站.
@@ -90,7 +93,9 @@ export declare const setReducer: import("@reduxjs/toolkit").ActionCreatorWithPay
     fn: (state: IKgWorkStationState[string]) => void;
 }, "KgWorkStation/setReducer">, mountReducer: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     id: string | null | undefined;
-}, "KgWorkStation/mountReducer">, openModalReducer: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+}, "KgWorkStation/mountReducer">, unmountReducer: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    id: string | null | undefined;
+}, "KgWorkStation/unmountReducer">, openModalReducer: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     id: string | null | undefined;
 }, "KgWorkStation/openModalReducer">, closeModalReducer: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     id: string | null | undefined;
@@ -100,9 +105,7 @@ export declare const setReducer: import("@reduxjs/toolkit").ActionCreatorWithPay
 }, "KgWorkStation/setWorkStationReducer">, setWorkStationAreaReducer: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     id?: string | null | undefined;
     workStationArea: WorkstationAreaDTO | null;
-}, "KgWorkStation/setWorkStationAreaReducer">, unmountReducer: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
-    id: string | null | undefined;
-}, "KgWorkStation/unmountReducer">;
+}, "KgWorkStation/setWorkStationAreaReducer">;
 export declare function isVisibleSelector(id: string): (state: IState) => boolean;
 export declare function isOpenSelector(id: string): (state: IState) => boolean;
 export declare function workStationSelector(id?: string): (state: IState) => WorkstationDTO | null;

package/src/index.d.ts

@@ -1,8 +1,9 @@
 import './asset/index.css';
 import './iconify.init';
 import { IKgOption } from './component/Kg';
-export { doKgWorkStation, type IDoKgWorkStation } from './component/KgWorkStation';
 export { setHttpClient } from './service';
+export { doKgWorkStation, type IDoKgWorkStation } from './component/KgWorkStation';
+export { doKgSqlClient, type IDoKgSqlClient } from './component/KgSqlClient';
 export interface IKgCoreReactOptions {
     /**
      * 选项.

package/src/index.store.d.ts

@@ -1,15 +1,19 @@
 import { IKgState } from './component/Kg';
+import { IKgSqlClientState } from './component/KgSqlClient';
 import { IKgWorkStationState } from './component/KgWorkStation';
 export type IState = {
     Kg: IKgState;
     KgWorkStation: IKgWorkStationState;
+    KgSqlClient: IKgSqlClientState;
 };
 export declare const store: import("@reduxjs/toolkit").EnhancedStore<{
     Kg: IKgState;
     KgWorkStation: IKgWorkStationState;
+    KgSqlClient: IKgSqlClientState;
 }, import("@reduxjs/toolkit").UnknownAction, import("@reduxjs/toolkit").Tuple<[import("@reduxjs/toolkit").StoreEnhancer<{
     dispatch: import("@reduxjs/toolkit").ThunkDispatch<{
         Kg: IKgState;
         KgWorkStation: IKgWorkStationState;
+        KgSqlClient: IKgSqlClientState;
     }, undefined, import("@reduxjs/toolkit").UnknownAction>;
 }>, import("@reduxjs/toolkit").StoreEnhancer]>>;