@thornfe/jql2iql 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,221 @@
+import { ParseTree } from "antlr4ts/tree/ParseTree";
+
+//#region src/types.d.ts
+/**
+ * JQL AST 节点类型定义
+ */
+/**
+ * 基础 AST 节点
+ */
+interface BaseASTNode {
+  type: string;
+  [key: string]: any;
+}
+/**
+ * 二元表达式节点 (如: field = value, field in list)
+ */
+interface BinaryExpression extends BaseASTNode {
+  type: 'BinaryExpression';
+  operator: string;
+  left: ASTNode;
+  right: ASTNode;
+}
+/**
+ * 逻辑表达式节点 (如: expr AND expr, expr OR expr, NOT expr)
+ */
+interface LogicalExpression extends BaseASTNode {
+  type: 'LogicalExpression';
+  operator: 'AND' | 'OR' | 'NOT';
+  left: ASTNode;
+  right?: ASTNode;
+}
+/**
+ * 字段节点 (如: project, status, issuetype)
+ */
+interface Field extends BaseASTNode {
+  type: 'Field';
+  value: string;
+}
+/**
+ * 字面量节点 (如: "value", 123, Done)
+ */
+interface Literal extends BaseASTNode {
+  type: 'Literal';
+  value: string | number;
+}
+/**
+ * 标识符节点
+ */
+interface Identifier extends BaseASTNode {
+  type: 'Identifier';
+  value: string;
+}
+/**
+ * 列表节点 (如: (value1, value2, value3))
+ */
+interface List extends BaseASTNode {
+  type: 'List';
+  elements: ASTNode[];
+}
+/**
+ * 函数节点 (如: currentUser(), membersOf("group"))
+ */
+interface FunctionNode extends BaseASTNode {
+  type: 'Function';
+  name: string;
+  arguments: any[];
+}
+/**
+ * 排序方向
+ */
+type OrderDirection = 'ASC' | 'DESC';
+/**
+ * 排序字段节点 (如: priority DESC, updated ASC)
+ */
+interface OrderByField extends BaseASTNode {
+  type: 'OrderByField';
+  field: string;
+  direction: OrderDirection;
+}
+/**
+ * ORDER BY 子句节点
+ */
+interface OrderByClause extends BaseASTNode {
+  type: 'OrderByClause';
+  fields: OrderByField[];
+}
+/**
+ * 完整的 JQL 查询结构
+ */
+interface JQLQuery extends BaseASTNode {
+  type: 'JQLQuery';
+  where: ASTNode | null;
+  orderBy: OrderByClause | null;
+}
+/**
+ * 联合类型：所有可能的 AST 节点类型
+ */
+type ASTNode = BinaryExpression | LogicalExpression | Field | Literal | Identifier | List | FunctionNode | OrderByField | OrderByClause | JQLQuery;
+/**
+ * Jira 字段类型键
+ */
+type FieldTypeKey = 'createdBy' | 'updatedBy' | 'Assignee' | 'Reporter' | 'User' | 'Status' | 'Version' | 'CustomVersion' | 'Sprint' | 'Priority' | 'Workspace' | 'ItemType' | 'Name' | 'Text' | 'LongText' | 'Key' | 'StoryPoint' | 'Number' | 'Date' | 'updatedAt' | 'createdAt' | 'UserGroup' | 'Tree' | 'Tag' | 'Cascade' | 'Checkbox' | 'Dropdown' | 'Radio' | 'HyperLink' | 'BindWorkspace' | 'StatusType' | 'File';
+/**
+ * Jira 字段映射配置
+ */
+interface JiraFieldConfig {
+  objectId: string;
+  customFieldKey: string;
+  fieldTypeKey: FieldTypeKey;
+  fieldTypeId?: string;
+}
+/**
+ * Jira 字段映射表
+ */
+type JiraFieldMap = Record<string, JiraFieldConfig>;
+/**
+ * 常量映射配置
+ */
+interface ConstantsMap {
+  /**
+       * 项目映射：JQL project key -> IQL 空间名称
+       */
+  projectMap?: Record<string, string>;
+  /**
+       * 版本映射：JQL 版本名称 -> IQL 版本 objectId 数组
+       */
+  versionMap?: Record<string, string[]>;
+  /**
+       * 模块映射：JQL component 名称 -> IQL 模块 objectId
+       */
+  component?: Record<string, string>;
+  /**
+       * 级联选项映射：cascadeOption value -> label
+       * 例如：{ "10011": "广东" }
+       */
+  cascade?: Record<string, string>;
+  /**
+       * 字段映射配置
+       */
+  fieldMap?: JiraFieldMap;
+}
+//#endregion
+//#region src/field-transformer.d.ts
+/**
+ * 原始字段对象接口
+ */
+interface RawField {
+  key: string;
+  name: string;
+  objectId: string;
+  fieldType: {
+    objectId: string;
+  };
+  data?: {
+    customData?: Array<{
+      label?: string;
+      value?: string;
+      title?: string;
+    }>;
+  };
+}
+/**
+ * 将原始字段数组转换为 ConstantsMap 格式
+ * 这个函数应该在外部调用一次，然后重复使用返回的 ConstantsMap 进行多次转换
+ *
+ * @param fields 原始字段数组
+ * @param projectMap 项目映射（可选）
+ * @param versionMap 版本映射（可选）
+ * @returns ConstantsMap 对象，可直接传给 jql2iql 使用
+ */
+declare function transformFieldsToConstantsMap(fields: RawField[], projectMap?: Record<string, string>, versionMap?: Record<string, string[]>): ConstantsMap;
+//#endregion
+//#region src/jql-to-ast/parser-utils.d.ts
+/**
+ * 遍历回调函数类型
+ * @param node 当前节点
+ * @param depth 当前深度
+ * @param parent 父节点
+ */
+type TraverseCallback = (node: ParseTree, depth: number, parent?: ParseTree) => void | boolean;
+/**
+ * 遍历 JQL 解析树
+ * @param tree 解析树根节点
+ * @param callback 遍历回调函数，返回 false 可以跳过子节点
+ * @param depth 当前深度（内部使用）
+ * @param parent 父节点（内部使用）
+ */
+declare function traverseJQLTree(tree: ParseTree, callback: TraverseCallback, depth?: number, parent?: ParseTree): void;
+/**
+ * 获取节点信息
+ */
+declare function getNodeInfo(node: ParseTree): {
+  type: 'rule' | 'terminal';
+  text: string;
+  ruleName?: string;
+  tokenType?: string;
+};
+//#endregion
+//#region src/jql-to-ast/ast-builder.d.ts
+/**
+ * 将 JQL 解析树转换为精简的 AST
+ */
+declare function buildAST(node: ParseTree | undefined): ASTNode | null;
+//#endregion
+//#region src/ast-to-iql/iql-converter.d.ts
+/**
+ * 将 AST 节点转换为 IQL 查询字符串
+ */
+declare function astToIQL(ast: ASTNode, constantsMap: ConstantsMap): string;
+//#endregion
+//#region src/index.d.ts
+/**
+ * 解析 JQL 查询字符串为 AST
+ */
+declare function parseJQL(jqlText: string): ASTNode | null;
+/**
+ * 将 JQL 转换为 IQL
+ */
+declare function jql2iql(jqlText: string, constantsMap: ConstantsMap): string;
+//#endregion
+export { ASTNode, BaseASTNode, BinaryExpression, ConstantsMap, Field, FieldTypeKey, FunctionNode, Identifier, JQLQuery, JiraFieldConfig, JiraFieldMap, List, Literal, LogicalExpression, OrderByClause, OrderByField, OrderDirection, type RawField, astToIQL, buildAST, getNodeInfo, jql2iql, parseJQL, transformFieldsToConstantsMap, traverseJQLTree };

package/dist/index.d.mts

@@ -0,0 +1,221 @@
+import { ParseTree } from "antlr4ts/tree/ParseTree";
+
+//#region src/types.d.ts
+/**
+ * JQL AST 节点类型定义
+ */
+/**
+ * 基础 AST 节点
+ */
+interface BaseASTNode {
+  type: string;
+  [key: string]: any;
+}
+/**
+ * 二元表达式节点 (如: field = value, field in list)
+ */
+interface BinaryExpression extends BaseASTNode {
+  type: 'BinaryExpression';
+  operator: string;
+  left: ASTNode;
+  right: ASTNode;
+}
+/**
+ * 逻辑表达式节点 (如: expr AND expr, expr OR expr, NOT expr)
+ */
+interface LogicalExpression extends BaseASTNode {
+  type: 'LogicalExpression';
+  operator: 'AND' | 'OR' | 'NOT';
+  left: ASTNode;
+  right?: ASTNode;
+}
+/**
+ * 字段节点 (如: project, status, issuetype)
+ */
+interface Field extends BaseASTNode {
+  type: 'Field';
+  value: string;
+}
+/**
+ * 字面量节点 (如: "value", 123, Done)
+ */
+interface Literal extends BaseASTNode {
+  type: 'Literal';
+  value: string | number;
+}
+/**
+ * 标识符节点
+ */
+interface Identifier extends BaseASTNode {
+  type: 'Identifier';
+  value: string;
+}
+/**
+ * 列表节点 (如: (value1, value2, value3))
+ */
+interface List extends BaseASTNode {
+  type: 'List';
+  elements: ASTNode[];
+}
+/**
+ * 函数节点 (如: currentUser(), membersOf("group"))
+ */
+interface FunctionNode extends BaseASTNode {
+  type: 'Function';
+  name: string;
+  arguments: any[];
+}
+/**
+ * 排序方向
+ */
+type OrderDirection = 'ASC' | 'DESC';
+/**
+ * 排序字段节点 (如: priority DESC, updated ASC)
+ */
+interface OrderByField extends BaseASTNode {
+  type: 'OrderByField';
+  field: string;
+  direction: OrderDirection;
+}
+/**
+ * ORDER BY 子句节点
+ */
+interface OrderByClause extends BaseASTNode {
+  type: 'OrderByClause';
+  fields: OrderByField[];
+}
+/**
+ * 完整的 JQL 查询结构
+ */
+interface JQLQuery extends BaseASTNode {
+  type: 'JQLQuery';
+  where: ASTNode | null;
+  orderBy: OrderByClause | null;
+}
+/**
+ * 联合类型：所有可能的 AST 节点类型
+ */
+type ASTNode = BinaryExpression | LogicalExpression | Field | Literal | Identifier | List | FunctionNode | OrderByField | OrderByClause | JQLQuery;
+/**
+ * Jira 字段类型键
+ */
+type FieldTypeKey = 'createdBy' | 'updatedBy' | 'Assignee' | 'Reporter' | 'User' | 'Status' | 'Version' | 'CustomVersion' | 'Sprint' | 'Priority' | 'Workspace' | 'ItemType' | 'Name' | 'Text' | 'LongText' | 'Key' | 'StoryPoint' | 'Number' | 'Date' | 'updatedAt' | 'createdAt' | 'UserGroup' | 'Tree' | 'Tag' | 'Cascade' | 'Checkbox' | 'Dropdown' | 'Radio' | 'HyperLink' | 'BindWorkspace' | 'StatusType' | 'File';
+/**
+ * Jira 字段映射配置
+ */
+interface JiraFieldConfig {
+  objectId: string;
+  customFieldKey: string;
+  fieldTypeKey: FieldTypeKey;
+  fieldTypeId?: string;
+}
+/**
+ * Jira 字段映射表
+ */
+type JiraFieldMap = Record<string, JiraFieldConfig>;
+/**
+ * 常量映射配置
+ */
+interface ConstantsMap {
+  /**
+       * 项目映射：JQL project key -> IQL 空间名称
+       */
+  projectMap?: Record<string, string>;
+  /**
+       * 版本映射：JQL 版本名称 -> IQL 版本 objectId 数组
+       */
+  versionMap?: Record<string, string[]>;
+  /**
+       * 模块映射：JQL component 名称 -> IQL 模块 objectId
+       */
+  component?: Record<string, string>;
+  /**
+       * 级联选项映射：cascadeOption value -> label
+       * 例如：{ "10011": "广东" }
+       */
+  cascade?: Record<string, string>;
+  /**
+       * 字段映射配置
+       */
+  fieldMap?: JiraFieldMap;
+}
+//#endregion
+//#region src/field-transformer.d.ts
+/**
+ * 原始字段对象接口
+ */
+interface RawField {
+  key: string;
+  name: string;
+  objectId: string;
+  fieldType: {
+    objectId: string;
+  };
+  data?: {
+    customData?: Array<{
+      label?: string;
+      value?: string;
+      title?: string;
+    }>;
+  };
+}
+/**
+ * 将原始字段数组转换为 ConstantsMap 格式
+ * 这个函数应该在外部调用一次，然后重复使用返回的 ConstantsMap 进行多次转换
+ *
+ * @param fields 原始字段数组
+ * @param projectMap 项目映射（可选）
+ * @param versionMap 版本映射（可选）
+ * @returns ConstantsMap 对象，可直接传给 jql2iql 使用
+ */
+declare function transformFieldsToConstantsMap(fields: RawField[], projectMap?: Record<string, string>, versionMap?: Record<string, string[]>): ConstantsMap;
+//#endregion
+//#region src/jql-to-ast/parser-utils.d.ts
+/**
+ * 遍历回调函数类型
+ * @param node 当前节点
+ * @param depth 当前深度
+ * @param parent 父节点
+ */
+type TraverseCallback = (node: ParseTree, depth: number, parent?: ParseTree) => void | boolean;
+/**
+ * 遍历 JQL 解析树
+ * @param tree 解析树根节点
+ * @param callback 遍历回调函数，返回 false 可以跳过子节点
+ * @param depth 当前深度（内部使用）
+ * @param parent 父节点（内部使用）
+ */
+declare function traverseJQLTree(tree: ParseTree, callback: TraverseCallback, depth?: number, parent?: ParseTree): void;
+/**
+ * 获取节点信息
+ */
+declare function getNodeInfo(node: ParseTree): {
+  type: 'rule' | 'terminal';
+  text: string;
+  ruleName?: string;
+  tokenType?: string;
+};
+//#endregion
+//#region src/jql-to-ast/ast-builder.d.ts
+/**
+ * 将 JQL 解析树转换为精简的 AST
+ */
+declare function buildAST(node: ParseTree | undefined): ASTNode | null;
+//#endregion
+//#region src/ast-to-iql/iql-converter.d.ts
+/**
+ * 将 AST 节点转换为 IQL 查询字符串
+ */
+declare function astToIQL(ast: ASTNode, constantsMap: ConstantsMap): string;
+//#endregion
+//#region src/index.d.ts
+/**
+ * 解析 JQL 查询字符串为 AST
+ */
+declare function parseJQL(jqlText: string): ASTNode | null;
+/**
+ * 将 JQL 转换为 IQL
+ */
+declare function jql2iql(jqlText: string, constantsMap: ConstantsMap): string;
+//#endregion
+export { ASTNode, BaseASTNode, BinaryExpression, ConstantsMap, Field, FieldTypeKey, FunctionNode, Identifier, JQLQuery, JiraFieldConfig, JiraFieldMap, List, Literal, LogicalExpression, OrderByClause, OrderByField, OrderDirection, type RawField, astToIQL, buildAST, getNodeInfo, jql2iql, parseJQL, transformFieldsToConstantsMap, traverseJQLTree };