variable-parser.js 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  1. /**
  2. * 统一解析结点入参、出参:将 action 中的变量引用用 variableContext 解析为实际值。
  3. * 规则:{var}、{{var}} 为变量(替换为变量值);{arr}[{idx}]、{arr}[数字] 为数组下标,解析为对应元素;"hello{var}" 为字符串+变量拼接。
  4. * 所有函数的入参、出参都经本脚本解析后再传给对应结点。
  5. */
  6. const setParser = require('./actions/set-parser.js')
  7. const resolveValue = setParser.resolveValue
  8. const replaceVariablesInString = setParser.replaceVariablesInString
  9. const extractVarName = setParser.extractVarName
  10. /** 视为入参的字段(会被解析);inVars 由本脚本统一解析后传给各结点。 */
  11. const INPUT_KEYS = [
  12. 'value', 'target', 'template', 'area', 'savePath', 'condition', 'delay', 'interval',
  13. 'items', 'screenshot', 'region', 'method', 'clear', 'timeout', 'retry',
  14. 'min', 'max', 'avatar1', 'avatar2', 'friendAvatar', 'avatar', 'path', 'filePath',
  15. 'inputDataString', 'textVariable', 'senderVariable', 'appendMode',
  16. 'summaryPrompt', 'historyPrompt', 'model', 'prompt', 'systemPrompt',
  17. 'regionArea', 'saveDir', 'url', 'filename', 'imageUrl',
  18. 'imagePath', 'squareSpec', 'scale', 'method',
  19. 'recursive',
  20. ]
  21. /**
  22. * 将数组下标取值结果转为可嵌入字符串的形式
  23. */
  24. function toEmbedString(v) {
  25. if (v === undefined || v === null) return ''
  26. if (typeof v === 'string') return v
  27. if (typeof v === 'number' || typeof v === 'boolean') return String(v)
  28. try {
  29. return JSON.stringify(v)
  30. } catch (e) {
  31. return String(v)
  32. }
  33. }
  34. /**
  35. * 解析字符串中的数组下标:{arr}[{idx}]、{arr}[数字],替换为实际元素值。
  36. * 先于普通变量替换执行,以便 {img-prompt-arr}[{idx}] 能解析为当前项。
  37. */
  38. function replaceArrayIndexInString(str, variableContext) {
  39. if (typeof str !== 'string' || !variableContext) return str
  40. // {var}[{indexVar}]
  41. let out = str.replace(/\{([\w-]+)\}\s*\[\s*\{([\w-]+)\}\s*\]/g, (_, arrName, idxName) => {
  42. const arr = variableContext[arrName]
  43. const idxVal = variableContext[idxName]
  44. if (!Array.isArray(arr)) return toEmbedString(arr)
  45. const i = typeof idxVal === 'number' ? idxVal : parseInt(idxVal, 10)
  46. if (Number.isNaN(i) || i < 0 || i >= arr.length) return ''
  47. return toEmbedString(arr[i])
  48. })
  49. // {var}[数字]
  50. out = out.replace(/\{([\w-]+)\}\s*\[\s*(\d+)\s*\]/g, (_, arrName, numStr) => {
  51. const arr = variableContext[arrName]
  52. if (!Array.isArray(arr)) return toEmbedString(arr)
  53. const i = parseInt(numStr, 10)
  54. if (i < 0 || i >= arr.length) return ''
  55. return toEmbedString(arr[i])
  56. })
  57. return out
  58. }
  59. /**
  60. * 解析单值:先解析数组下标 {arr}[{idx}] / {arr}[n],再做 {{var}}、{var} 替换,最后对整体做引用解析。
  61. */
  62. function resolveInputValue(val, variableContext) {
  63. if (variableContext == null) return val
  64. if (typeof val === 'string') {
  65. const afterIndex = replaceArrayIndexInString(val, variableContext)
  66. const replaced = replaceVariablesInString(afterIndex, variableContext)
  67. let result = resolveValue(replaced, variableContext)
  68. if (result === val && /^[\w-]+$/.test(val) && variableContext[val] !== undefined) result = variableContext[val]
  69. return result
  70. }
  71. if (Array.isArray(val)) return val.map(item => resolveInputValue(item, variableContext))
  72. if (typeof val === 'object' && val !== null) {
  73. const out = {}
  74. for (const k in val) out[k] = resolveInputValue(val[k], variableContext)
  75. return out
  76. }
  77. return val
  78. }
  79. /**
  80. * 解析整条 action 的入参,返回新对象(不修改原 action)
  81. * @param {object} action - 原始或已 parse 的 action
  82. * @param {object} variableContext - 变量表
  83. * @returns {object} 入参解析后的 action 副本
  84. */
  85. function resolveActionInputs(action, variableContext) {
  86. if (!action || typeof action !== 'object') return action
  87. if (!variableContext || typeof variableContext !== 'object') return Object.assign({}, action)
  88. const resolved = Object.assign({}, action)
  89. for (const key of INPUT_KEYS) {
  90. if (key in resolved && resolved[key] !== undefined && resolved[key] !== null) {
  91. resolved[key] = resolveInputValue(resolved[key], variableContext)
  92. }
  93. }
  94. if (resolved.inVars && Array.isArray(resolved.inVars)) {
  95. resolved.inVars = resolved.inVars.map((v) => resolveInputValue(v, variableContext))
  96. }
  97. if (resolved.outVars && Array.isArray(resolved.outVars)) {
  98. resolved.outVars = resolved.outVars.map((v) => (typeof v === 'string' ? extractVarName(v) : v))
  99. }
  100. if (resolved.condition && typeof resolved.condition === 'object' && !Array.isArray(resolved.condition)) {
  101. const c = resolved.condition
  102. if (c.interval != null) resolved.condition = Object.assign({}, c, { interval: resolveInputValue(c.interval, variableContext) })
  103. if (c.repeat != null) resolved.condition = Object.assign({}, resolved.condition, { repeat: resolveInputValue(c.repeat, variableContext) })
  104. }
  105. return resolved
  106. }
  107. /**
  108. * 从字符串或数组中提取所有变量引用名({var}、{{var}}、{arr}[{idx}] 中的 var/arr/idx)
  109. * @returns {string[]} 变量名列表(可能重复)
  110. */
  111. function extractVarNamesFromValue(val) {
  112. const names = []
  113. function collect(str) {
  114. if (typeof str !== 'string') return
  115. const doubleBrace = /\{\{([\w-]+)\}\}/g
  116. const singleBrace = /\{([\w-]+)\}/g
  117. let m
  118. while ((m = doubleBrace.exec(str)) !== null) names.push(m[1])
  119. while ((m = singleBrace.exec(str)) !== null) names.push(m[1])
  120. }
  121. if (typeof val === 'string') {
  122. collect(val)
  123. return names
  124. }
  125. if (Array.isArray(val)) {
  126. val.forEach((v) => names.push(...extractVarNamesFromValue(v)))
  127. return names
  128. }
  129. if (typeof val === 'object' && val !== null) {
  130. Object.keys(val).forEach((k) => names.push(...extractVarNamesFromValue(val[k])))
  131. return names
  132. }
  133. return names
  134. }
  135. /**
  136. * 校验 action 的 inVars/outVars 中引用的变量是否均在 declaredVariableNames 中声明
  137. * @param {object} action - 当前 action(含 inVars、outVars)
  138. * @param {Set|string[]} declaredVariableNames - 在 workflow.variables 中声明的变量名集合
  139. * @returns {{ valid: boolean, undeclared: string[] }}
  140. */
  141. function validateInOutVars(action, declaredVariableNames) {
  142. const declared = declaredVariableNames instanceof Set ? declaredVariableNames : new Set(declaredVariableNames || [])
  143. const undeclared = []
  144. function check(names) {
  145. names.forEach((n) => {
  146. if (n && typeof n === 'string' && !declared.has(n)) undeclared.push(n)
  147. })
  148. }
  149. if (action.inVars && Array.isArray(action.inVars)) {
  150. action.inVars.forEach((v) => check(extractVarNamesFromValue(v)))
  151. }
  152. if (action.outVars && Array.isArray(action.outVars)) {
  153. action.outVars.forEach((v) => {
  154. const name = typeof v === 'string' ? extractVarName(v) : v
  155. if (name) check([name])
  156. })
  157. }
  158. const unique = [...new Set(undeclared)]
  159. return { valid: unique.length === 0, undeclared: unique }
  160. }
  161. module.exports = {
  162. resolveActionInputs,
  163. resolveInputValue,
  164. replaceArrayIndexInString,
  165. extractVarName,
  166. extractVarNamesFromValue,
  167. validateInOutVars,
  168. }