triggerix-editor-preset-war3 0.0.0 → 0.0.4

package/dist/index.d.mts

@@ -0,0 +1,239 @@
+import { BaseItemDef, BaseRegistry, Editor, Preset, ObservableState } from '@triggerix/editor';
+export { BaseItemDef, Preset } from '@triggerix/editor';
+import { Value, Rule } from '@triggerix/core';
+
+interface SlotDef {
+    label: string;
+    tools: string[];
+}
+interface SlotValueEntry {
+    tool: string | null;
+    value: unknown;
+    subSlots?: Record<string, SlotValueEntry>;
+}
+interface LeafToolInput<TValue = unknown> {
+    type: 'text' | 'number' | 'select';
+    placeholder?: string;
+    options?: Array<{
+        value: TValue;
+        label: string;
+    }>;
+}
+interface LeafToolDef<TInput = unknown, TOutput = unknown> {
+    kind: 'leaf';
+    type?: string;
+    label: string;
+    input: LeafToolInput<TInput>;
+    resolve: (input: TInput) => TOutput;
+}
+interface CompositeToolDef<TSlotValues extends Record<string, unknown> = Record<string, unknown>, TOutput = unknown> {
+    kind: 'composite';
+    type?: string;
+    label: string;
+    template: string;
+    slots: Record<keyof TSlotValues & string, SlotDef>;
+    resolve: (slotValues: TSlotValues) => TOutput;
+}
+type ToolDef = LeafToolDef<any, any> | CompositeToolDef<any, any>;
+interface War3EventDef extends BaseItemDef {
+    template: string;
+    slots?: Record<string, SlotDef>;
+}
+interface War3ActionDef extends BaseItemDef {
+    template: string;
+    slots?: Record<string, SlotDef>;
+}
+interface War3ConditionDef<TSlotValues extends Record<string, unknown> = Record<string, unknown>> extends BaseItemDef {
+    template: string;
+    slots?: Record<string, SlotDef>;
+    resolve?: (slotValues: TSlotValues) => unknown;
+}
+type Segment = {
+    type: 'text';
+    content: string;
+} | {
+    type: 'slot';
+    key: string;
+    label: string;
+    tools: string[];
+    value: unknown;
+    entry?: SlotValueEntry;
+};
+interface ItemDescriptor {
+    id: string;
+    segments: Segment[];
+}
+interface LeafToolDescriptor {
+    kind: 'leaf';
+    name: string;
+    label: string;
+    input: LeafToolInput;
+}
+interface CompositeToolDescriptor {
+    kind: 'composite';
+    name: string;
+    label: string;
+    segments: Segment[];
+}
+type ToolDescriptor = LeafToolDescriptor | CompositeToolDescriptor;
+interface ItemState {
+    id: string;
+    slotValues: Record<string, SlotValueEntry>;
+}
+interface War3EditorState {
+    event: ItemState | null;
+    conditions: ItemState[];
+    actions: ItemState[];
+}
+interface War3PresetOptions {
+    name: string;
+    events?: War3EventDef[];
+    actions?: War3ActionDef[];
+    conditions?: War3ConditionDef[];
+    tools?: Record<string, ToolDef>;
+}
+
+/**
+ * War3 注册表 - 继承 BaseRegistry，增加 Tool 注册能力
+ */
+declare class War3Registry extends BaseRegistry<War3EventDef, War3ActionDef, War3ConditionDef> {
+    private tools;
+    registerTool(name: string, def: ToolDef): void;
+    getTool(name: string): ToolDef | undefined;
+    getTools(): Map<string, ToolDef>;
+    getValueSources(valueType?: string): {
+        conditions: War3ConditionDef[];
+        tools: Map<string, ToolDef>;
+    };
+}
+
+interface War3Editor extends Editor<War3EditorState> {
+    registerEvent: (def: War3EventDef) => void;
+    registerAction: (def: War3ActionDef) => void;
+    registerCondition: (def: War3ConditionDef) => void;
+    registerTool: (name: string, def: ToolDef) => void;
+    getRegistry: () => War3Registry;
+    getAvailableEvents: () => War3EventDef[];
+    getAvailableActions: () => War3ActionDef[];
+    getAvailableConditions: () => War3ConditionDef[];
+    getEventDescriptor: () => ItemDescriptor | null;
+    getActionDescriptor: (actionIndex: number) => ItemDescriptor | null;
+    getConditionDescriptor: (conditionIndex: number) => ItemDescriptor | null;
+    getToolDescriptor: (toolName: string, slotValues?: Record<string, SlotValueEntry>) => ToolDescriptor | null;
+    getSlotTools: (slotDef: SlotDef) => ToolDescriptor[];
+    setEvent: (id: string) => void;
+    clearEvent: () => void;
+    setEventSlot: (key: string, entry: SlotValueEntry) => void;
+    addAction: (id: string) => void;
+    removeAction: (index: number) => void;
+    moveAction: (from: number, to: number) => void;
+    setActionSlot: (actionIndex: number, key: string, entry: SlotValueEntry) => void;
+    addCondition: (id: string) => void;
+    removeCondition: (index: number) => void;
+    setConditionSlot: (conditionIndex: number, key: string, entry: SlotValueEntry) => void;
+    getValueSources: (valueType?: string) => {
+        conditions: War3ConditionDef[];
+        tools: Map<string, ToolDef>;
+    };
+    applyPreset: (preset: Preset<War3Editor>) => void;
+    resolveSlotValue: (entry: SlotValueEntry) => unknown;
+}
+declare function createWar3Editor(): War3Editor;
+
+declare function getEventDescriptor(registry: War3Registry, id: string, slotValues?: Record<string, SlotValueEntry>): ItemDescriptor | null;
+declare function getActionDescriptor(registry: War3Registry, id: string, slotValues?: Record<string, SlotValueEntry>): ItemDescriptor | null;
+declare function getConditionDescriptor(registry: War3Registry, id: string, slotValues?: Record<string, SlotValueEntry>): ItemDescriptor | null;
+declare function getToolDescriptor(registry: War3Registry, toolName: string, slotValues?: Record<string, SlotValueEntry>): ToolDescriptor | null;
+declare function getSlotToolDescriptors(registry: War3Registry, slotDef: SlotDef): ToolDescriptor[];
+
+/**
+ * 递归解析 SlotValueEntry 为人类可读的展示文本
+ *
+ * - 如果 entry 为 null/undefined 或未选择 tool，返回 fallbackLabel（slot 占位文案）
+ * - 如果 tool 为 leaf：
+ *   - select 类型：尝试匹配 options 找到对应 label（支持对象值的深比较）
+ *   - 其它类型：返回 value 的字符串形式
+ *   - 若 value 为空：返回 fallbackLabel
+ * - 如果 tool 为 composite：使用 tool 的 template 递归展开
+ */
+declare function resolveSlotDisplayText(entry: SlotValueEntry | null | undefined, registry: War3Registry, fallbackLabel: string): string;
+
+/**
+ * 类型安全地定义 LeafTool
+ * 用户通过回调参数注解来指定输入类型，TS 自动推导输出类型
+ */
+declare function defineLeafTool<TInput, TOutput>(def: {
+    type?: string;
+    label: string;
+    input: LeafToolInput<TInput>;
+    resolve: (input: TInput) => TOutput;
+}): {
+    kind: "leaf";
+    type?: string;
+    label: string;
+    input: LeafToolInput<TInput>;
+    resolve: (input: TInput) => TOutput;
+};
+/**
+ * 类型安全地定义 CompositeTool
+ * 用户注解 resolve 回调参数来指定 slot 值类型，TS 验证 slots keys 一致性
+ */
+declare function defineCompositeTool<TSlotValues extends Record<string, unknown>, TOutput>(def: {
+    type?: string;
+    label: string;
+    template: string;
+    slots: Record<keyof TSlotValues & string, SlotDef>;
+    resolve: (slotValues: TSlotValues) => TOutput;
+}): CompositeToolDef<TSlotValues, TOutput>;
+/**
+ * 类型安全地定义 Condition
+ */
+declare function defineCondition<TSlotValues extends Record<string, unknown> = Record<string, unknown>>(def: Omit<War3ConditionDef<TSlotValues>, 'resolve'> & {
+    resolve?: (slotValues: TSlotValues) => unknown;
+}): War3ConditionDef;
+
+/**
+ * 解析模板字符串为 Segment 数组
+ * 模板格式: "普通文本${slotKey}更多文本"
+ */
+declare function parseTemplate(template: string, slots?: Record<string, SlotDef>, slotValues?: Record<string, SlotValueEntry>): Segment[];
+
+declare function defineWar3Preset(options: War3PresetOptions): Preset<War3Editor>;
+
+/**
+ * 递归解析单个 slot 值
+ */
+declare function resolveSlotValue(entry: SlotValueEntry, registry: War3Registry): Value | undefined;
+/**
+ * 将编辑器状态序列化为标准 Rule JSON
+ *
+ * 输出结构（与 @triggerix/core 兼容）：
+ *   {
+ *     id, event: { type, payload? }, conditions?: { type:'and', conditions:[...] },
+ *     actions: [{ type, params? }]
+ *   }
+ */
+declare function toRule(state: War3EditorState, registry: War3Registry, ruleId?: string): Rule;
+
+/**
+ * War3 编辑器状态管理
+ * 继承 ObservableState，提供模板模式特有的状态操作
+ */
+declare class War3EditorStateManager extends ObservableState<War3EditorState> {
+    constructor();
+    setEvent(id: string): void;
+    clearEvent(): void;
+    setEventSlot(key: string, entry: SlotValueEntry): void;
+    addAction(id: string): void;
+    removeAction(index: number): void;
+    moveAction(from: number, to: number): void;
+    setActionSlot(actionIndex: number, key: string, entry: SlotValueEntry): void;
+    addCondition(id: string): void;
+    removeCondition(index: number): void;
+    setConditionSlot(conditionIndex: number, key: string, entry: SlotValueEntry): void;
+    reset(): void;
+    private setItemSlot;
+}
+
+export { War3EditorStateManager, War3Registry, createWar3Editor, defineCompositeTool, defineCondition, defineLeafTool, defineWar3Preset, getActionDescriptor, getConditionDescriptor, getEventDescriptor, getSlotToolDescriptors, getToolDescriptor, parseTemplate, resolveSlotDisplayText, resolveSlotValue, toRule };
+export type { CompositeToolDef, CompositeToolDescriptor, ItemDescriptor, ItemState, LeafToolDef, LeafToolDescriptor, LeafToolInput, Segment, SlotDef, SlotValueEntry, ToolDef, ToolDescriptor, War3ActionDef, War3ConditionDef, War3Editor, War3EditorState, War3EventDef, War3PresetOptions };

package/dist/index.d.ts

@@ -0,0 +1,239 @@
+import { BaseItemDef, BaseRegistry, Editor, Preset, ObservableState } from '@triggerix/editor';
+export { BaseItemDef, Preset } from '@triggerix/editor';
+import { Value, Rule } from '@triggerix/core';
+
+interface SlotDef {
+    label: string;
+    tools: string[];
+}
+interface SlotValueEntry {
+    tool: string | null;
+    value: unknown;
+    subSlots?: Record<string, SlotValueEntry>;
+}
+interface LeafToolInput<TValue = unknown> {
+    type: 'text' | 'number' | 'select';
+    placeholder?: string;
+    options?: Array<{
+        value: TValue;
+        label: string;
+    }>;
+}
+interface LeafToolDef<TInput = unknown, TOutput = unknown> {
+    kind: 'leaf';
+    type?: string;
+    label: string;
+    input: LeafToolInput<TInput>;
+    resolve: (input: TInput) => TOutput;
+}
+interface CompositeToolDef<TSlotValues extends Record<string, unknown> = Record<string, unknown>, TOutput = unknown> {
+    kind: 'composite';
+    type?: string;
+    label: string;
+    template: string;
+    slots: Record<keyof TSlotValues & string, SlotDef>;
+    resolve: (slotValues: TSlotValues) => TOutput;
+}
+type ToolDef = LeafToolDef<any, any> | CompositeToolDef<any, any>;
+interface War3EventDef extends BaseItemDef {
+    template: string;
+    slots?: Record<string, SlotDef>;
+}
+interface War3ActionDef extends BaseItemDef {
+    template: string;
+    slots?: Record<string, SlotDef>;
+}
+interface War3ConditionDef<TSlotValues extends Record<string, unknown> = Record<string, unknown>> extends BaseItemDef {
+    template: string;
+    slots?: Record<string, SlotDef>;
+    resolve?: (slotValues: TSlotValues) => unknown;
+}
+type Segment = {
+    type: 'text';
+    content: string;
+} | {
+    type: 'slot';
+    key: string;
+    label: string;
+    tools: string[];
+    value: unknown;
+    entry?: SlotValueEntry;
+};
+interface ItemDescriptor {
+    id: string;
+    segments: Segment[];
+}
+interface LeafToolDescriptor {
+    kind: 'leaf';
+    name: string;
+    label: string;
+    input: LeafToolInput;
+}
+interface CompositeToolDescriptor {
+    kind: 'composite';
+    name: string;
+    label: string;
+    segments: Segment[];
+}
+type ToolDescriptor = LeafToolDescriptor | CompositeToolDescriptor;
+interface ItemState {
+    id: string;
+    slotValues: Record<string, SlotValueEntry>;
+}
+interface War3EditorState {
+    event: ItemState | null;
+    conditions: ItemState[];
+    actions: ItemState[];
+}
+interface War3PresetOptions {
+    name: string;
+    events?: War3EventDef[];
+    actions?: War3ActionDef[];
+    conditions?: War3ConditionDef[];
+    tools?: Record<string, ToolDef>;
+}
+
+/**
+ * War3 注册表 - 继承 BaseRegistry，增加 Tool 注册能力
+ */
+declare class War3Registry extends BaseRegistry<War3EventDef, War3ActionDef, War3ConditionDef> {
+    private tools;
+    registerTool(name: string, def: ToolDef): void;
+    getTool(name: string): ToolDef | undefined;
+    getTools(): Map<string, ToolDef>;
+    getValueSources(valueType?: string): {
+        conditions: War3ConditionDef[];
+        tools: Map<string, ToolDef>;
+    };
+}
+
+interface War3Editor extends Editor<War3EditorState> {
+    registerEvent: (def: War3EventDef) => void;
+    registerAction: (def: War3ActionDef) => void;
+    registerCondition: (def: War3ConditionDef) => void;
+    registerTool: (name: string, def: ToolDef) => void;
+    getRegistry: () => War3Registry;
+    getAvailableEvents: () => War3EventDef[];
+    getAvailableActions: () => War3ActionDef[];
+    getAvailableConditions: () => War3ConditionDef[];
+    getEventDescriptor: () => ItemDescriptor | null;
+    getActionDescriptor: (actionIndex: number) => ItemDescriptor | null;
+    getConditionDescriptor: (conditionIndex: number) => ItemDescriptor | null;
+    getToolDescriptor: (toolName: string, slotValues?: Record<string, SlotValueEntry>) => ToolDescriptor | null;
+    getSlotTools: (slotDef: SlotDef) => ToolDescriptor[];
+    setEvent: (id: string) => void;
+    clearEvent: () => void;
+    setEventSlot: (key: string, entry: SlotValueEntry) => void;
+    addAction: (id: string) => void;
+    removeAction: (index: number) => void;
+    moveAction: (from: number, to: number) => void;
+    setActionSlot: (actionIndex: number, key: string, entry: SlotValueEntry) => void;
+    addCondition: (id: string) => void;
+    removeCondition: (index: number) => void;
+    setConditionSlot: (conditionIndex: number, key: string, entry: SlotValueEntry) => void;
+    getValueSources: (valueType?: string) => {
+        conditions: War3ConditionDef[];
+        tools: Map<string, ToolDef>;
+    };
+    applyPreset: (preset: Preset<War3Editor>) => void;
+    resolveSlotValue: (entry: SlotValueEntry) => unknown;
+}
+declare function createWar3Editor(): War3Editor;
+
+declare function getEventDescriptor(registry: War3Registry, id: string, slotValues?: Record<string, SlotValueEntry>): ItemDescriptor | null;
+declare function getActionDescriptor(registry: War3Registry, id: string, slotValues?: Record<string, SlotValueEntry>): ItemDescriptor | null;
+declare function getConditionDescriptor(registry: War3Registry, id: string, slotValues?: Record<string, SlotValueEntry>): ItemDescriptor | null;
+declare function getToolDescriptor(registry: War3Registry, toolName: string, slotValues?: Record<string, SlotValueEntry>): ToolDescriptor | null;
+declare function getSlotToolDescriptors(registry: War3Registry, slotDef: SlotDef): ToolDescriptor[];
+
+/**
+ * 递归解析 SlotValueEntry 为人类可读的展示文本
+ *
+ * - 如果 entry 为 null/undefined 或未选择 tool，返回 fallbackLabel（slot 占位文案）
+ * - 如果 tool 为 leaf：
+ *   - select 类型：尝试匹配 options 找到对应 label（支持对象值的深比较）
+ *   - 其它类型：返回 value 的字符串形式
+ *   - 若 value 为空：返回 fallbackLabel
+ * - 如果 tool 为 composite：使用 tool 的 template 递归展开
+ */
+declare function resolveSlotDisplayText(entry: SlotValueEntry | null | undefined, registry: War3Registry, fallbackLabel: string): string;
+
+/**
+ * 类型安全地定义 LeafTool
+ * 用户通过回调参数注解来指定输入类型，TS 自动推导输出类型
+ */
+declare function defineLeafTool<TInput, TOutput>(def: {
+    type?: string;
+    label: string;
+    input: LeafToolInput<TInput>;
+    resolve: (input: TInput) => TOutput;
+}): {
+    kind: "leaf";
+    type?: string;
+    label: string;
+    input: LeafToolInput<TInput>;
+    resolve: (input: TInput) => TOutput;
+};
+/**
+ * 类型安全地定义 CompositeTool
+ * 用户注解 resolve 回调参数来指定 slot 值类型，TS 验证 slots keys 一致性
+ */
+declare function defineCompositeTool<TSlotValues extends Record<string, unknown>, TOutput>(def: {
+    type?: string;
+    label: string;
+    template: string;
+    slots: Record<keyof TSlotValues & string, SlotDef>;
+    resolve: (slotValues: TSlotValues) => TOutput;
+}): CompositeToolDef<TSlotValues, TOutput>;
+/**
+ * 类型安全地定义 Condition
+ */
+declare function defineCondition<TSlotValues extends Record<string, unknown> = Record<string, unknown>>(def: Omit<War3ConditionDef<TSlotValues>, 'resolve'> & {
+    resolve?: (slotValues: TSlotValues) => unknown;
+}): War3ConditionDef;
+
+/**
+ * 解析模板字符串为 Segment 数组
+ * 模板格式: "普通文本${slotKey}更多文本"
+ */
+declare function parseTemplate(template: string, slots?: Record<string, SlotDef>, slotValues?: Record<string, SlotValueEntry>): Segment[];
+
+declare function defineWar3Preset(options: War3PresetOptions): Preset<War3Editor>;
+
+/**
+ * 递归解析单个 slot 值
+ */
+declare function resolveSlotValue(entry: SlotValueEntry, registry: War3Registry): Value | undefined;
+/**
+ * 将编辑器状态序列化为标准 Rule JSON
+ *
+ * 输出结构（与 @triggerix/core 兼容）：
+ *   {
+ *     id, event: { type, payload? }, conditions?: { type:'and', conditions:[...] },
+ *     actions: [{ type, params? }]
+ *   }
+ */
+declare function toRule(state: War3EditorState, registry: War3Registry, ruleId?: string): Rule;
+
+/**
+ * War3 编辑器状态管理
+ * 继承 ObservableState，提供模板模式特有的状态操作
+ */
+declare class War3EditorStateManager extends ObservableState<War3EditorState> {
+    constructor();
+    setEvent(id: string): void;
+    clearEvent(): void;
+    setEventSlot(key: string, entry: SlotValueEntry): void;
+    addAction(id: string): void;
+    removeAction(index: number): void;
+    moveAction(from: number, to: number): void;
+    setActionSlot(actionIndex: number, key: string, entry: SlotValueEntry): void;
+    addCondition(id: string): void;
+    removeCondition(index: number): void;
+    setConditionSlot(conditionIndex: number, key: string, entry: SlotValueEntry): void;
+    reset(): void;
+    private setItemSlot;
+}
+
+export { War3EditorStateManager, War3Registry, createWar3Editor, defineCompositeTool, defineCondition, defineLeafTool, defineWar3Preset, getActionDescriptor, getConditionDescriptor, getEventDescriptor, getSlotToolDescriptors, getToolDescriptor, parseTemplate, resolveSlotDisplayText, resolveSlotValue, toRule };
+export type { CompositeToolDef, CompositeToolDescriptor, ItemDescriptor, ItemState, LeafToolDef, LeafToolDescriptor, LeafToolInput, Segment, SlotDef, SlotValueEntry, ToolDef, ToolDescriptor, War3ActionDef, War3ConditionDef, War3Editor, War3EditorState, War3EventDef, War3PresetOptions };