@yiyi_zhang/reactflow-ui 1.2.0 → 1.3.0

package/dist/onboarding/naming.d.ts

@@ -0,0 +1,41 @@
+import type { WorkflowDef } from '../types/conductor';
+import type { WorkflowLevel } from '../types/workflowLibrary';
+import type { WorkflowNameType } from '../library/naming';
+/**
+ * 自助接入的命名辅助：纯函数，不依赖 React，可直接单测。
+ * 命名规范：`类型-层级-业务域-产品-功能`（见 src/library/naming.ts）。
+ */
+/** 申请上线时可选的目标类型 */
+export type PromotionTargetType = 'custom' | 'std';
+/** 五段式名称的各段 */
+export interface WorkflowNameParts {
+    type: WorkflowNameType;
+    level: WorkflowLevel;
+    domain: string;
+    product: string;
+    func: string;
+}
+/** 拼出完整流程名称。业务域 / 产品段会被去掉 `-`；功能段保持原样（仅去首尾空白，允许含 `-`） */
+export declare function buildWorkflowName(parts: WorkflowNameParts): string;
+/** 校验各段拼出的名称（空段会得到「xx不能为空」类错误），业务域白名单可选 */
+export declare function validateNameParts(parts: WorkflowNameParts, allowedDomains?: string[]): string[];
+/**
+ * 由用户输入的功能说明建议「功能」段：
+ * - 含中文：保持原样，仅去掉 `-`（避免破坏分段），空白折叠为 `_`；
+ * - 纯 ASCII：转小写 snake_case（驼峰拆词，连字符 / 空格 / 其他符号折叠为 `_`）。
+ */
+export declare function suggestFuncSlug(text: string): string;
+/**
+ * 申请上线后的正式名称：把类型段（第一段）替换为目标类型。
+ * 名称不符合五段规范时返回 null。
+ */
+export declare function promotionTargetName(tmpName: string, targetType: PromotionTargetType): string | null;
+/** 当前流程名称是否是可申请上线的临时流程（类型段为 tmp） */
+export declare function isPromotableName(name: string | undefined | null): boolean;
+export interface SkeletonInput {
+    name: string;
+    description?: string;
+    ownerEmail?: string;
+}
+/** 向导生成的骨架定义：version 1 / schemaVersion 2，空任务 */
+export declare function buildSkeletonWorkflow(input: SkeletonInput): WorkflowDef;

package/dist/onboarding/poll.d.ts

@@ -0,0 +1,39 @@
+import type { OnboardingProvider, PromotionStatus } from '../providers/types';
+/** 上线申请轮询：初始间隔、封顶间隔（毫秒） */
+export declare const POLL_BASE_MS = 2000;
+export declare const POLL_MAX_MS = 30000;
+/** 第 attempt 次（从 0 开始）等待的时长：指数退避 2s → 4s → 8s … 封顶 30s */
+export declare function nextPollDelay(attempt: number): number;
+export type PromotionState = PromotionStatus['state'];
+/** 终态：不会再变化，轮询据此停止 */
+export declare function isTerminalPromotionState(state: PromotionState): boolean;
+export interface TimelineItem {
+    state: PromotionState;
+    label: string;
+    /** done 已完成 / current 进行中 / pending 未到 / failed 被驳回 */
+    status: 'done' | 'current' | 'pending' | 'failed';
+}
+export declare function promotionStateLabel(state: PromotionState): string;
+/**
+ * 进度时间线。正常路径：已提交 → 审批中 → 审批通过 → 已同步到生产；
+ * 被驳回时第三项替换为「已驳回」（failed），之后不再展示「已同步」。
+ */
+export declare function buildPromotionTimeline(state: PromotionState | null): TimelineItem[];
+export declare function isAbortError(e: unknown): boolean;
+/** 可被 AbortSignal 打断的等待 */
+export declare function abortableSleep(ms: number, signal?: AbortSignal): Promise<void>;
+export interface PollOptions {
+    provider: Pick<OnboardingProvider, 'getPromotion'>;
+    requestId: string;
+    signal?: AbortSignal;
+    /** 每次拿到状态时回调（含终态） */
+    onUpdate?: (status: PromotionStatus) => void;
+    /** 注入等待函数（测试用），默认 abortableSleep */
+    sleep?: (ms: number, signal?: AbortSignal) => Promise<void>;
+}
+/**
+ * 轮询上线申请直到终态（APPROVED / REJECTED / SYNCED）：先立即查一次，之后按 nextPollDelay 退避。
+ * APPROVED 视为终态（审批已有结论），轮询随之停止。
+ * 请求失败直接抛出（由界面显示「重试」）；signal 中止时抛 AbortError。
+ */
+export declare function pollPromotion(opts: PollOptions): Promise<PromotionStatus>;

package/dist/onboarding/wizardState.d.ts

@@ -0,0 +1,44 @@
+import type { WorkflowLevel } from '../types/workflowLibrary';
+import type { ProductInfo } from '../providers/types';
+import type { WorkflowNameType } from '../library/naming';
+import type { WorkflowNameParts } from './naming';
+/** 向导步骤：产品 → 命名 → 起点 */
+export type WizardStep = 'product' | 'naming' | 'start';
+export declare const WIZARD_STEPS: readonly WizardStep[];
+export declare const WIZARD_STEP_LABEL: Record<WizardStep, string>;
+export type StartSource = 'blank' | 'template' | 'import';
+export interface WizardDraft {
+    /** existing：选择已有产品；new：登记新产品（仅试用环境） */
+    productMode: 'existing' | 'new';
+    productName: string;
+    domain: string;
+    systemCode: string;
+    type: WorkflowNameType;
+    level: WorkflowLevel;
+    func: string;
+    description: string;
+    source: StartSource;
+}
+export interface WizardContextLite {
+    trial: boolean;
+    products: ProductInfo[];
+}
+/** 初始草稿：有产品时默认选第一个；没有产品时（试用环境）进入登记模式 */
+export declare function createInitialDraft(ctx: WizardContextLite, level?: WorkflowLevel): WizardDraft;
+/** 产品名规则：非空、不含 `-` 与空白（会破坏五段切分） */
+export declare function validateProductName(name: string): string | null;
+/** 第 1 步的校验错误（null = 可继续） */
+export declare function productStepError(draft: WizardDraft, ctx: WizardContextLite, domains: string[]): string | null;
+/** 草稿 → 五段名称 */
+export declare function draftToNameParts(draft: WizardDraft, trial: boolean): WorkflowNameParts;
+/** 第 2 步的校验错误列表 */
+export declare function namingStepErrors(draft: WizardDraft, trial: boolean, domains: string[]): string[];
+/** 当前步骤是否允许进入下一步 */
+export declare function canAdvance(step: WizardStep, draft: WizardDraft, ctx: WizardContextLite, domains: string[]): boolean;
+export declare function nextStep(step: WizardStep): WizardStep;
+export declare function prevStep(step: WizardStep): WizardStep;
+/** 可选的起点：未提供对应回调时隐藏该选项（空白始终可用） */
+export declare function availableSources(opts: {
+    hasTemplate: boolean;
+    hasImport: boolean;
+}): StartSource[];

package/dist/providers/WorkflowIdeProvider.d.ts

@@ -0,0 +1,23 @@
+import type { ReactNode } from 'react';
+import type { IdeProviders } from './types';
+export interface WorkflowIdeProviderProps {
+    providers: IdeProviders;
+    children: ReactNode;
+}
+/**
+ * 统一注册扩展点：宿主配置一次，其下所有 `WorkflowIDE` / `AiWorkflowIDE` 共用。
+ * `providers` 对象每次渲染重新创建也没关系——只有某个 provider 引用变化时才会通知下游。
+ *
+ * ```tsx
+ * <WorkflowIdeProvider providers={{ library, telemetry }}>
+ *   <WorkflowIDE … />
+ * </WorkflowIdeProvider>
+ * ```
+ */
+export declare function WorkflowIdeProvider({ providers, children }: WorkflowIdeProviderProps): import("react/jsx-runtime").JSX.Element;
+/** 读取外层 `WorkflowIdeProvider` 提供的扩展点；没有外层时返回空对象（不抛错） */
+export declare function useIdeProviders(): IdeProviders;
+/**
+ * IDE 内部使用：合并「专用 prop > 组件 providers prop > 外层 Provider」，结果按字段引用稳定。
+ */
+export declare function useResolvedProviders(componentProviders: IdeProviders | undefined, override?: Partial<IdeProviders>): IdeProviders;

package/dist/providers/resolve.d.ts

@@ -0,0 +1,20 @@
+import type { IdeProviders } from './types';
+/** 各层来源，按优先级从高到低排列 */
+export interface ProviderSources {
+    /** 组件上的专用 prop（如 `libraryProvider`），优先级最高 */
+    override?: Partial<IdeProviders>;
+    /** 组件的 `providers` prop */
+    component?: Partial<IdeProviders>;
+    /** 外层 `WorkflowIdeProvider` */
+    context?: Partial<IdeProviders>;
+}
+/**
+ * 按字段解析：专用 prop > 组件 `providers` prop > 外层 `WorkflowIdeProvider` > 无。
+ * 某一层的字段为 undefined 时才落到下一层（不是整个对象覆盖）。纯函数，每次返回新对象。
+ */
+export declare function resolveProviders(sources?: ProviderSources): IdeProviders;
+/**
+ * 稳定化：各字段引用都与 prev 相同时返回 prev 本身。
+ * 宿主每次渲染新建 `providers` 对象、但 provider 实例不变时，下游拿到的仍是同一个对象，不会触发目录重载。
+ */
+export declare function stabilizeProviders(prev: IdeProviders | undefined, next: IdeProviders): IdeProviders;

package/dist/providers/types.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 扩展点注册：统一的 Provider 集合与自助接入（Onboarding）契约。
+ * 设计见 docs/design/v1.3.0-自助接入设计.md 第 2、3.2 节。
+ */
+import type { LibraryProvider } from '../library/types';
+import type { TelemetrySink } from '../telemetry/types';
+export interface OnboardingContext {
+    env: 'TEST' | 'PROD';
+    user: {
+        id: string;
+        name: string;
+    };
+    /** 当前环境是否开放自助试用（生产为 false） */
+    trialEnabled: boolean;
+}
+export interface ProductInfo {
+    name: string;
+    domain: string;
+    status: 'PENDING' | 'ACTIVE';
+    role: 'OWNER' | 'MEMBER';
+}
+export type StartTrialResult = {
+    status: 'ok';
+    product: ProductInfo;
+} | {
+    status: 'conflict';
+    owners: {
+        id: string;
+        name: string;
+    }[];
+};
+export interface PromotionStatus {
+    requestId: string;
+    state: 'SUBMITTED' | 'REVIEWING' | 'APPROVED' | 'REJECTED' | 'SYNCED';
+    targetName?: string;
+    comment?: string;
+    updatedAt: string;
+}
+export interface OnboardingProvider {
+    getContext(signal?: AbortSignal): Promise<OnboardingContext>;
+    listDomains(signal?: AbortSignal): Promise<string[]>;
+    listMyProducts(signal?: AbortSignal): Promise<ProductInfo[]>;
+    startTrial(input: {
+        productName: string;
+        domain: string;
+        systemCode?: string;
+    }): Promise<StartTrialResult>;
+    requestPromotion(input: {
+        workflowName: string;
+        version: number;
+        targetType: 'custom' | 'std';
+    }): Promise<{
+        requestId: string;
+    }>;
+    getPromotion(requestId: string, signal?: AbortSignal): Promise<PromotionStatus>;
+}
+/** 宿主配置一次、页面内所有 IDE 共用的扩展点集合 */
+export interface IdeProviders {
+    /** 流程库数据源（1.2.0 已有） */
+    library?: LibraryProvider;
+    /** 自助接入（1.3.0；B1 仅定义契约，界面在 B2） */
+    onboarding?: OnboardingProvider;
+    /** 接入埋点（1.3.0） */
+    telemetry?: TelemetrySink;
+}