assistsx-js 0.2.1 → 0.2.3

package/dist/step-flow/index.d.mts

@@ -0,0 +1,83 @@
+import { S as Step, h as StepImpl, f as StepData } from '../step-DnFA4DEb.mjs';
+
+/** 流程步骤执行结果：事件 / 重复 / 结束 / 委托 legacy StepImpl */
+type StepFlowOutcome = {
+    type: "event";
+    name: string;
+} | {
+    type: "repeat";
+} | {
+    type: "end";
+} | {
+    type: "legacy";
+    impl: StepImpl;
+};
+/** 流程步骤实现：只描述 UI 与分支事件，不直接决定下一状态 */
+type FlowStepImpl = (step: Step) => Promise<StepFlowOutcome>;
+/** 单个流程状态定义 */
+interface FlowStateDef {
+    run: FlowStepImpl;
+    /** 事件名 -> 下一状态名 */
+    on: Record<string, string>;
+}
+/** StepFlow 运行配置 */
+interface StepFlowConfig {
+    id?: string;
+    initial: string;
+    states: Record<string, FlowStateDef>;
+    /** 写入 step.data.payload 的初始业务数据 */
+    data?: StepData;
+}
+/** 库写入 step.data.__flow 的结构 */
+interface StepFlowMeta {
+    id?: string;
+    state: string;
+}
+/** step.data 推荐结构（payload 用户读写，__flow 库维护） */
+interface StepFlowData {
+    payload?: StepData;
+    __flow?: StepFlowMeta;
+    finishMethod?: StepImpl;
+    [key: string]: unknown;
+}
+
+/** 产生流程事件，由当前状态的 on 表决定下一状态 */
+declare function flowEvent(name: string): StepFlowOutcome;
+/** 重复当前流程状态（沿用 Step.repeat 语义） */
+declare function flowRepeat(): StepFlowOutcome;
+/** 结束整个流程 */
+declare function flowEnd(): StepFlowOutcome;
+
+/** 读取业务 payload（不存在时返回空对象） */
+declare function getFlowPayload<T extends StepData = StepData>(step: Step): T;
+/** 浅合并写入 payload */
+declare function assignFlowPayload(step: Step, partial: StepData): void;
+
+/**
+ * 为 legacy 步骤（如 app-launch）创建 finishMethod：
+ * 应用打开成功后跳回 StepFlow dispatcher 并切换到指定状态。
+ */
+declare function createFinishHandoff(dispatcher: StepImpl, nextState: string): StepImpl;
+/**
+ * 创建 launch 类流程状态：写入 finishMethod 后委托执行 legacy StepImpl 链。
+ */
+declare function createLaunchState(dispatcher: StepImpl, launchImpl: StepImpl, nextState: string, 
+/** legacy 步骤从 step.data 读取的字段名（默认与 payload 键一致） */
+legacyDataKeys?: string[]): FlowStateDef;
+
+/** 创建流程调度 StepImpl（需先填充 config.states，见 createLaunchState） */
+declare function createFlowDispatcher(config: StepFlowConfig): StepImpl;
+declare function buildFlowInitialData(config: StepFlowConfig): StepFlowData;
+declare class StepFlow {
+    /**
+     * 按状态机配置运行流程，内部复用 Step.run 与现有步骤循环。
+     */
+    static run(config: StepFlowConfig, options?: {
+        stepId?: string;
+        tag?: string;
+        delayMs?: number;
+        exceptionRetryCountMax?: number;
+    }): Promise<Step | undefined>;
+}
+
+export { type FlowStateDef, type FlowStepImpl, StepFlow, type StepFlowConfig, type StepFlowData, type StepFlowMeta, type StepFlowOutcome, assignFlowPayload, buildFlowInitialData, createFinishHandoff, createFlowDispatcher, createLaunchState, flowEnd, flowEvent, flowRepeat, getFlowPayload };

package/dist/step-flow/index.d.ts

@@ -0,0 +1,83 @@
+import { S as Step, h as StepImpl, f as StepData } from '../step-DnFA4DEb.js';
+
+/** 流程步骤执行结果：事件 / 重复 / 结束 / 委托 legacy StepImpl */
+type StepFlowOutcome = {
+    type: "event";
+    name: string;
+} | {
+    type: "repeat";
+} | {
+    type: "end";
+} | {
+    type: "legacy";
+    impl: StepImpl;
+};
+/** 流程步骤实现：只描述 UI 与分支事件，不直接决定下一状态 */
+type FlowStepImpl = (step: Step) => Promise<StepFlowOutcome>;
+/** 单个流程状态定义 */
+interface FlowStateDef {
+    run: FlowStepImpl;
+    /** 事件名 -> 下一状态名 */
+    on: Record<string, string>;
+}
+/** StepFlow 运行配置 */
+interface StepFlowConfig {
+    id?: string;
+    initial: string;
+    states: Record<string, FlowStateDef>;
+    /** 写入 step.data.payload 的初始业务数据 */
+    data?: StepData;
+}
+/** 库写入 step.data.__flow 的结构 */
+interface StepFlowMeta {
+    id?: string;
+    state: string;
+}
+/** step.data 推荐结构（payload 用户读写，__flow 库维护） */
+interface StepFlowData {
+    payload?: StepData;
+    __flow?: StepFlowMeta;
+    finishMethod?: StepImpl;
+    [key: string]: unknown;
+}
+
+/** 产生流程事件，由当前状态的 on 表决定下一状态 */
+declare function flowEvent(name: string): StepFlowOutcome;
+/** 重复当前流程状态（沿用 Step.repeat 语义） */
+declare function flowRepeat(): StepFlowOutcome;
+/** 结束整个流程 */
+declare function flowEnd(): StepFlowOutcome;
+
+/** 读取业务 payload（不存在时返回空对象） */
+declare function getFlowPayload<T extends StepData = StepData>(step: Step): T;
+/** 浅合并写入 payload */
+declare function assignFlowPayload(step: Step, partial: StepData): void;
+
+/**
+ * 为 legacy 步骤（如 app-launch）创建 finishMethod：
+ * 应用打开成功后跳回 StepFlow dispatcher 并切换到指定状态。
+ */
+declare function createFinishHandoff(dispatcher: StepImpl, nextState: string): StepImpl;
+/**
+ * 创建 launch 类流程状态：写入 finishMethod 后委托执行 legacy StepImpl 链。
+ */
+declare function createLaunchState(dispatcher: StepImpl, launchImpl: StepImpl, nextState: string, 
+/** legacy 步骤从 step.data 读取的字段名（默认与 payload 键一致） */
+legacyDataKeys?: string[]): FlowStateDef;
+
+/** 创建流程调度 StepImpl（需先填充 config.states，见 createLaunchState） */
+declare function createFlowDispatcher(config: StepFlowConfig): StepImpl;
+declare function buildFlowInitialData(config: StepFlowConfig): StepFlowData;
+declare class StepFlow {
+    /**
+     * 按状态机配置运行流程，内部复用 Step.run 与现有步骤循环。
+     */
+    static run(config: StepFlowConfig, options?: {
+        stepId?: string;
+        tag?: string;
+        delayMs?: number;
+        exceptionRetryCountMax?: number;
+    }): Promise<Step | undefined>;
+}
+
+export { type FlowStateDef, type FlowStepImpl, StepFlow, type StepFlowConfig, type StepFlowData, type StepFlowMeta, type StepFlowOutcome, assignFlowPayload, buildFlowInitialData, createFinishHandoff, createFlowDispatcher, createLaunchState, flowEnd, flowEvent, flowRepeat, getFlowPayload };