@openforis/arena-core 2.3.42 → 2.4.0

package/dist/record/_records/recordCompletion.js.map

@@ -1 +1 @@
-{"version":3,"file":"recordCompletion.js","sourceRoot":"","sources":["../../../src/record/_records/recordCompletion.ts"],"names":[],"mappings":";;;AAAA,qCAAmD;AACnD,2CAA4E;AAC5E,yCAA8C;AAC9C,uCAAqC;AAErC,mDAAsD;AAOtD,MAAM,UAAU,GAAG,GAA0B,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAA;AAEzE,MAAM,QAAQ,GAAG,CAAC,QAA+B,EAAE,UAAiC,EAAQ,EAAE;IAC5F,QAAQ,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAA;IAClC,QAAQ,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAA;AACtC,CAAC,CAAA;AAED,MAAM,2BAA2B,GAAG,CAAC,MAIpC,EAAyB,EAAE;IAC1B,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;IAE1C,IAAI,kBAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAG,YAAK,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;QAC3E,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,QAAQ,IAAI,CAAC;YAAE,OAAO,UAAU,EAAE,CAAA;QAEhE,MAAM,gBAAgB,GAAG,IAAA,2BAAW,EAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,YAAK,CAAC,eAAe,CAAC,CAAC,MAAM,CAAA;QAEvG,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,QAAQ,CAAC,EAAE,CAAA;IAC1E,CAAC;IAED,IAAI,CAAC,kBAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAQ,CAAC,KAAK,CAAC,OAAO,CAAC;QAAE,OAAO,UAAU,EAAE,CAAA;IAElF,MAAM,IAAI,GAAG,IAAA,2BAAW,EAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IACzD,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,IAAI,YAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AAC1E,CAAC,CAAA;AAED,MAAM,6BAA6B,GAAG,CAAC,MAKtC,EAAyB,EAAE;IAC1B,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;IACxD,MAAM,aAAa,GAAG,IAAA,2BAAW,EAAC,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAA;IAErE,IAAI,kBAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,MAAM,WAAW,GAAG,aAAa,CAAC,CAAC,CAAC,CAAA;QACpC,OAAO,WAAW,CAAC,CAAC,CAAC,IAAA,QAAA,wBAAwB,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAA;IACvG,CAAC;IAED,MAAM,WAAW,GAAG,YAAK,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAA;IACpF,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;IACzE,wEAAwE;IACxE,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC9D,IAAI,aAAa,KAAK,CAAC;QAAE,OAAO,UAAU,EAAE,CAAA;IAE5C,MAAM,KAAK,GAAG,UAAU,EAAE,CAAA;IAC1B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC;QACnD,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,CAAA;QACxC,gFAAgF;QAChF,QAAQ,CACN,KAAK,EACL,WAAW,CAAC,CAAC,CAAC,IAAA,QAAA,wBAAwB,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAC1G,CAAA;IACH,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAEM,MAAM,wBAAwB,GAAG,CAAC,MAKxC,EAAyB,EAAE;IAC1B,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,GAAG,IAAI,EAAE,GAAG,MAAM,CAAA;IACvE,MAAM,SAAS,GAAG,gBAAO,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC,CAAA;IAChF,MAAM,SAAS,GAAG,gBAAO,CAAC,kBAAkB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAA;IAE5E,MAAM,KAAK,GAAG,UAAU,EAAE,CAAA;IAC1B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,IAAI,CAAC,YAAK,CAAC,iBAAiB,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC;YAAE,SAAQ;QAE7D,IAAI,kBAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,qBAAqB;gBAAE,SAAQ;YACpC,QAAQ,CAAC,KAAK,EAAE,6BAA6B,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAA;QAC7G,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,KAAK,EAAE,2BAA2B,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAA;QACrF,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAtBY,QAAA,wBAAwB,GAAxB,wBAAwB,CAsBpC;AAED,MAAM,mBAAmB,GAAG,CAAC,KAA4B,EAAU,EAAE;IACnE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IAC/B,IAAI,KAAK,IAAI,CAAC;QAAE,OAAO,GAAG,CAAA;IAC1B,OAAO,eAAO,CAAC,gBAAgB,CAAC,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAA;AAC5D,CAAC,CAAA;AAED;;;;GAIG;AACI,MAAM,0BAA0B,GAAG,CAAC,MAI1C,EAAU,EAAE,CAAC,mBAAmB,CAAC,IAAA,QAAA,wBAAwB,EAAC,MAAM,CAAC,CAAC,CAAA;AAJtD,QAAA,0BAA0B,GAA1B,0BAA0B,CAI4B;AAEnE;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CAAC,MAI7C,EAAU,EAAE,CAAC,mBAAmB,CAAC,IAAA,QAAA,wBAAwB,kCAAM,MAAM,KAAE,qBAAqB,EAAE,KAAK,IAAG,CAAC,CAAA;AAJ3F,QAAA,6BAA6B,GAA7B,6BAA6B,CAI8D;AAExG;;GAEG;AACI,MAAM,0BAA0B,GAAG,CAAC,MAA+C,EAAU,EAAE;IACpG,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IACjC,MAAM,UAAU,GAAG,IAAA,uBAAO,EAAC,MAAM,CAAC,CAAA;IAClC,OAAO,UAAU,CAAC,CAAC,CAAC,IAAA,QAAA,0BAA0B,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAC5F,CAAC,CAAA;AAJY,QAAA,0BAA0B,GAA1B,0BAA0B,CAItC","sourcesContent":["import { ArenaRecordNode, Nodes } from '../../node'\nimport { NodeDef, NodeDefProps, NodeDefs, NodeDefType } from '../../nodeDef'\nimport { Survey, Surveys } from '../../survey'\nimport { Numbers } from '../../utils'\nimport { ArenaRecord } from '../record'\nimport { getChildren, getRoot } from './recordGetters'\n\nexport interface EntityCompletionStats {\n  total: number\n  filled: number\n}\n\nconst emptyStats = (): EntityCompletionStats => ({ total: 0, filled: 0 })\n\nconst addStats = (statsAcc: EntityCompletionStats, statsToAdd: EntityCompletionStats): void => {\n  statsAcc.total += statsToAdd.total\n  statsAcc.filled += statsToAdd.filled\n}\n\nconst getAttributeCompletionStats = (params: {\n  record: ArenaRecord\n  entity: ArenaRecordNode\n  nodeDef: NodeDef<NodeDefType, NodeDefProps>\n}): EntityCompletionStats => {\n  const { record, entity, nodeDef } = params\n\n  if (NodeDefs.isMultiple(nodeDef)) {\n    const minCount = Nodes.getChildrenMinCount({ parentNode: entity, nodeDef })\n    if (Number.isNaN(minCount) || minCount <= 0) return emptyStats()\n\n    const filledNodesCount = getChildren(entity, nodeDef.uuid)(record).filter(Nodes.isValueNotBlank).length\n\n    return { total: minCount, filled: Math.min(filledNodesCount, minCount) }\n  }\n\n  if (!NodeDefs.isRequired(nodeDef) && !NodeDefs.isKey(nodeDef)) return emptyStats()\n\n  const node = getChildren(entity, nodeDef.uuid)(record)[0]\n  return { total: 1, filled: node && Nodes.isValueNotBlank(node) ? 1 : 0 }\n}\n\nconst getChildEntityCompletionStats = (params: {\n  survey: Survey\n  record: ArenaRecord\n  parentEntity: ArenaRecordNode\n  nodeDef: NodeDef<NodeDefType, NodeDefProps>\n}): EntityCompletionStats => {\n  const { survey, record, parentEntity, nodeDef } = params\n  const childEntities = getChildren(parentEntity, nodeDef.uuid)(record)\n\n  if (NodeDefs.isSingle(nodeDef)) {\n    const childEntity = childEntities[0]\n    return childEntity ? getEntityCompletionStats({ survey, record, entity: childEntity }) : emptyStats()\n  }\n\n  const minCountRaw = Nodes.getChildrenMinCount({ parentNode: parentEntity, nodeDef })\n  const minCount = Number.isNaN(minCountRaw) ? 0 : Math.max(minCountRaw, 0)\n  // entities added beyond the min count are still expected to be complete\n  const expectedCount = Math.max(minCount, childEntities.length)\n  if (expectedCount === 0) return emptyStats()\n\n  const stats = emptyStats()\n  for (let index = 0; index < expectedCount; index++) {\n    const childEntity = childEntities[index]\n    // a missing repetition (below the min count) counts as a single incomplete unit\n    addStats(\n      stats,\n      childEntity ? getEntityCompletionStats({ survey, record, entity: childEntity }) : { total: 1, filled: 0 }\n    )\n  }\n  return stats\n}\n\nexport const getEntityCompletionStats = (params: {\n  survey: Survey\n  record: ArenaRecord\n  entity: ArenaRecordNode\n  includeNestedEntities?: boolean\n}): EntityCompletionStats => {\n  const { survey, record, entity, includeNestedEntities = true } = params\n  const entityDef = Surveys.getNodeDefByUuid({ survey, uuid: entity.nodeDefUuid })\n  const childDefs = Surveys.getNodeDefChildren({ survey, nodeDef: entityDef })\n\n  const stats = emptyStats()\n  for (const childDef of childDefs) {\n    if (!Nodes.isChildApplicable(entity, childDef.uuid)) continue\n\n    if (NodeDefs.isEntity(childDef)) {\n      if (!includeNestedEntities) continue\n      addStats(stats, getChildEntityCompletionStats({ survey, record, parentEntity: entity, nodeDef: childDef }))\n    } else {\n      addStats(stats, getAttributeCompletionStats({ record, entity, nodeDef: childDef }))\n    }\n  }\n  return stats\n}\n\nconst toCompletionPercent = (stats: EntityCompletionStats): number => {\n  const { total, filled } = stats\n  if (total <= 0) return 100\n  return Numbers.roundToPrecision((filled / total) * 100, 2)\n}\n\n/**\n * Returns the percentage of completion of the given entity (0-100), considering every descendant recursively.\n * A required or key attribute is considered filled when it has a non empty value; multiple attributes and\n * entities are considered filled based on their min count (see Nodes.getChildrenMinCount).\n */\nexport const getEntityCompletionPercent = (params: {\n  survey: Survey\n  record: ArenaRecord\n  entity: ArenaRecordNode\n}): number => toCompletionPercent(getEntityCompletionStats(params))\n\n/**\n * Returns the percentage of completion of the given entity (0-100), considering only its own attributes\n * (nested entities are ignored).\n */\nexport const getEntityOwnCompletionPercent = (params: {\n  survey: Survey\n  record: ArenaRecord\n  entity: ArenaRecordNode\n}): number => toCompletionPercent(getEntityCompletionStats({ ...params, includeNestedEntities: false }))\n\n/**\n * Returns the percentage of completion of the given record (0-100), i.e. the completion of its root entity.\n */\nexport const getRecordCompletionPercent = (params: { survey: Survey; record: ArenaRecord }): number => {\n  const { survey, record } = params\n  const rootEntity = getRoot(record)\n  return rootEntity ? getEntityCompletionPercent({ survey, record, entity: rootEntity }) : 0\n}\n"]}
+{"version":3,"file":"recordCompletion.js","sourceRoot":"","sources":["../../../src/record/_records/recordCompletion.ts"],"names":[],"mappings":";;;AAAA,qCAAmD;AACnD,2CAA4E;AAC5E,yCAA8C;AAC9C,uCAAqC;AAErC,mDAAsD;AAOtD,MAAM,UAAU,GAAG,GAA0B,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAA;AAEzE,MAAM,QAAQ,GAAG,CAAC,QAA+B,EAAE,UAAiC,EAAQ,EAAE;IAC5F,QAAQ,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAA;IAClC,QAAQ,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAA;AACtC,CAAC,CAAA;AAED,MAAM,2BAA2B,GAAG,CAAC,MAIpC,EAAyB,EAAE;IAC1B,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;IAE1C,IAAI,kBAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAG,YAAK,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;QAC3E,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,QAAQ,IAAI,CAAC;YAAE,OAAO,UAAU,EAAE,CAAA;QAEhE,MAAM,gBAAgB,GAAG,IAAA,2BAAW,EAAC,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CACrG,YAAK,CAAC,eAAe,CACtB,CAAC,MAAM,CAAA;QAER,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,QAAQ,CAAC,EAAE,CAAA;IAC1E,CAAC;IAED,IAAI,CAAC,kBAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAQ,CAAC,KAAK,CAAC,OAAO,CAAC;QAAE,OAAO,UAAU,EAAE,CAAA;IAElF,MAAM,IAAI,GAAG,IAAA,2BAAW,EAAC,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IACvF,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,IAAI,YAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AAC1E,CAAC,CAAA;AAED,MAAM,6BAA6B,GAAG,CAAC,MAKtC,EAAyB,EAAE;IAC1B,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;IACxD,MAAM,aAAa,GAAG,IAAA,2BAAW,EAAC,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAA;IAEnG,IAAI,kBAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,MAAM,WAAW,GAAG,aAAa,CAAC,CAAC,CAAC,CAAA;QACpC,OAAO,WAAW,CAAC,CAAC,CAAC,IAAA,QAAA,wBAAwB,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAA;IACvG,CAAC;IAED,MAAM,WAAW,GAAG,YAAK,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAA;IACpF,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;IACzE,wEAAwE;IACxE,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC9D,IAAI,aAAa,KAAK,CAAC;QAAE,OAAO,UAAU,EAAE,CAAA;IAE5C,MAAM,KAAK,GAAG,UAAU,EAAE,CAAA;IAC1B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC;QACnD,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,CAAA;QACxC,gFAAgF;QAChF,QAAQ,CACN,KAAK,EACL,WAAW,CAAC,CAAC,CAAC,IAAA,QAAA,wBAAwB,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAC1G,CAAA;IACH,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAEM,MAAM,wBAAwB,GAAG,CAAC,MAKxC,EAAyB,EAAE;IAC1B,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,GAAG,IAAI,EAAE,GAAG,MAAM,CAAA;IACvE,MAAM,SAAS,GAAG,gBAAO,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC,CAAA;IAChF,MAAM,SAAS,GAAG,gBAAO,CAAC,kBAAkB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAA;IAE5E,MAAM,KAAK,GAAG,UAAU,EAAE,CAAA;IAC1B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,IAAI,CAAC,YAAK,CAAC,iBAAiB,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC;YAAE,SAAQ;QAE7D,IAAI,kBAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,qBAAqB;gBAAE,SAAQ;YACpC,QAAQ,CAAC,KAAK,EAAE,6BAA6B,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAA;QAC7G,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,KAAK,EAAE,2BAA2B,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAA;QACrF,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAtBY,QAAA,wBAAwB,GAAxB,wBAAwB,CAsBpC;AAED,MAAM,mBAAmB,GAAG,CAAC,KAA4B,EAAU,EAAE;IACnE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IAC/B,IAAI,KAAK,IAAI,CAAC;QAAE,OAAO,GAAG,CAAA;IAC1B,OAAO,eAAO,CAAC,gBAAgB,CAAC,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAA;AAC5D,CAAC,CAAA;AAED;;;;GAIG;AACI,MAAM,0BAA0B,GAAG,CAAC,MAI1C,EAAU,EAAE,CAAC,mBAAmB,CAAC,IAAA,QAAA,wBAAwB,EAAC,MAAM,CAAC,CAAC,CAAA;AAJtD,QAAA,0BAA0B,GAA1B,0BAA0B,CAI4B;AAEnE;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CAAC,MAI7C,EAAU,EAAE,CAAC,mBAAmB,CAAC,IAAA,QAAA,wBAAwB,kCAAM,MAAM,KAAE,qBAAqB,EAAE,KAAK,IAAG,CAAC,CAAA;AAJ3F,QAAA,6BAA6B,GAA7B,6BAA6B,CAI8D;AAExG;;GAEG;AACI,MAAM,0BAA0B,GAAG,CAAC,MAA+C,EAAU,EAAE;IACpG,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IACjC,MAAM,UAAU,GAAG,IAAA,uBAAO,EAAC,MAAM,CAAC,CAAA;IAClC,OAAO,UAAU,CAAC,CAAC,CAAC,IAAA,QAAA,0BAA0B,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAC5F,CAAC,CAAA;AAJY,QAAA,0BAA0B,GAA1B,0BAA0B,CAItC","sourcesContent":["import { ArenaRecordNode, Nodes } from '../../node'\nimport { NodeDef, NodeDefProps, NodeDefs, NodeDefType } from '../../nodeDef'\nimport { Survey, Surveys } from '../../survey'\nimport { Numbers } from '../../utils'\nimport { ArenaRecord } from '../record'\nimport { getChildren, getRoot } from './recordGetters'\n\nexport interface EntityCompletionStats {\n  total: number\n  filled: number\n}\n\nconst emptyStats = (): EntityCompletionStats => ({ total: 0, filled: 0 })\n\nconst addStats = (statsAcc: EntityCompletionStats, statsToAdd: EntityCompletionStats): void => {\n  statsAcc.total += statsToAdd.total\n  statsAcc.filled += statsToAdd.filled\n}\n\nconst getAttributeCompletionStats = (params: {\n  record: ArenaRecord\n  entity: ArenaRecordNode\n  nodeDef: NodeDef<NodeDefType, NodeDefProps>\n}): EntityCompletionStats => {\n  const { record, entity, nodeDef } = params\n\n  if (NodeDefs.isMultiple(nodeDef)) {\n    const minCount = Nodes.getChildrenMinCount({ parentNode: entity, nodeDef })\n    if (Number.isNaN(minCount) || minCount <= 0) return emptyStats()\n\n    const filledNodesCount = getChildren({ parentNode: entity, childDefUuid: nodeDef.uuid })(record).filter(\n      Nodes.isValueNotBlank\n    ).length\n\n    return { total: minCount, filled: Math.min(filledNodesCount, minCount) }\n  }\n\n  if (!NodeDefs.isRequired(nodeDef) && !NodeDefs.isKey(nodeDef)) return emptyStats()\n\n  const node = getChildren({ parentNode: entity, childDefUuid: nodeDef.uuid })(record)[0]\n  return { total: 1, filled: node && Nodes.isValueNotBlank(node) ? 1 : 0 }\n}\n\nconst getChildEntityCompletionStats = (params: {\n  survey: Survey\n  record: ArenaRecord\n  parentEntity: ArenaRecordNode\n  nodeDef: NodeDef<NodeDefType, NodeDefProps>\n}): EntityCompletionStats => {\n  const { survey, record, parentEntity, nodeDef } = params\n  const childEntities = getChildren({ parentNode: parentEntity, childDefUuid: nodeDef.uuid })(record)\n\n  if (NodeDefs.isSingle(nodeDef)) {\n    const childEntity = childEntities[0]\n    return childEntity ? getEntityCompletionStats({ survey, record, entity: childEntity }) : emptyStats()\n  }\n\n  const minCountRaw = Nodes.getChildrenMinCount({ parentNode: parentEntity, nodeDef })\n  const minCount = Number.isNaN(minCountRaw) ? 0 : Math.max(minCountRaw, 0)\n  // entities added beyond the min count are still expected to be complete\n  const expectedCount = Math.max(minCount, childEntities.length)\n  if (expectedCount === 0) return emptyStats()\n\n  const stats = emptyStats()\n  for (let index = 0; index < expectedCount; index++) {\n    const childEntity = childEntities[index]\n    // a missing repetition (below the min count) counts as a single incomplete unit\n    addStats(\n      stats,\n      childEntity ? getEntityCompletionStats({ survey, record, entity: childEntity }) : { total: 1, filled: 0 }\n    )\n  }\n  return stats\n}\n\nexport const getEntityCompletionStats = (params: {\n  survey: Survey\n  record: ArenaRecord\n  entity: ArenaRecordNode\n  includeNestedEntities?: boolean\n}): EntityCompletionStats => {\n  const { survey, record, entity, includeNestedEntities = true } = params\n  const entityDef = Surveys.getNodeDefByUuid({ survey, uuid: entity.nodeDefUuid })\n  const childDefs = Surveys.getNodeDefChildren({ survey, nodeDef: entityDef })\n\n  const stats = emptyStats()\n  for (const childDef of childDefs) {\n    if (!Nodes.isChildApplicable(entity, childDef.uuid)) continue\n\n    if (NodeDefs.isEntity(childDef)) {\n      if (!includeNestedEntities) continue\n      addStats(stats, getChildEntityCompletionStats({ survey, record, parentEntity: entity, nodeDef: childDef }))\n    } else {\n      addStats(stats, getAttributeCompletionStats({ record, entity, nodeDef: childDef }))\n    }\n  }\n  return stats\n}\n\nconst toCompletionPercent = (stats: EntityCompletionStats): number => {\n  const { total, filled } = stats\n  if (total <= 0) return 100\n  return Numbers.roundToPrecision((filled / total) * 100, 2)\n}\n\n/**\n * Returns the percentage of completion of the given entity (0-100), considering every descendant recursively.\n * A required or key attribute is considered filled when it has a non empty value; multiple attributes and\n * entities are considered filled based on their min count (see Nodes.getChildrenMinCount).\n */\nexport const getEntityCompletionPercent = (params: {\n  survey: Survey\n  record: ArenaRecord\n  entity: ArenaRecordNode\n}): number => toCompletionPercent(getEntityCompletionStats(params))\n\n/**\n * Returns the percentage of completion of the given entity (0-100), considering only its own attributes\n * (nested entities are ignored).\n */\nexport const getEntityOwnCompletionPercent = (params: {\n  survey: Survey\n  record: ArenaRecord\n  entity: ArenaRecordNode\n}): number => toCompletionPercent(getEntityCompletionStats({ ...params, includeNestedEntities: false }))\n\n/**\n * Returns the percentage of completion of the given record (0-100), i.e. the completion of its root entity.\n */\nexport const getRecordCompletionPercent = (params: { survey: Survey; record: ArenaRecord }): number => {\n  const { survey, record } = params\n  const rootEntity = getRoot(record)\n  return rootEntity ? getEntityCompletionPercent({ survey, record, entity: rootEntity }) : 0\n}\n"]}

package/dist/record/_records/recordGetters.d.ts

@@ -3,68 +3,117 @@ import { ArenaRecordNode, NodePointer, NodesMap } from '../../node';
 import { NodeDef, NodeDefCode, NodeDefCodeProps, NodeDefProps, NodeDefType } from '../../nodeDef';
 import { Survey, SurveyDependencyType } from '../../survey/survey';
 import { ArenaRecord } from '../record';
+type RecordParams = {
+    record: ArenaRecord;
+};
+/**
+ * Record getter: takes the parameters first and the record as separate (curried) parameter: `getter(params)(record)`.
+ * The deprecated form, with the record inside the parameters (`getter({ record, ...params })`), is still supported.
+ */
+type RecordGetter<P extends RecordParams, R> = {
+    /** @deprecated Pass the record as separate parameter: `getter(params)(record)` */
+    (params: P): R;
+    (params: Omit<P, 'record'>): (record: ArenaRecord) => R;
+};
+/**
+ * Record getter (with parameters object) that also supports the deprecated form with positional parameters:
+ * `getter(arg1, arg2)(record)`.
+ */
+type PositionalRecordGetter<P, A extends unknown[], R> = {
+    (params: P): (record: ArenaRecord) => R;
+    /** @deprecated Pass the parameters as an object: `getter({ ...params })(record)` */
+    (...args: A): (record: ArenaRecord) => R;
+};
 export declare const getCycle: (record: ArenaRecord) => string;
 export declare const getNodes: (record: ArenaRecord) => Dictionary<ArenaRecordNode>;
 export declare const getNodesArray: (record: ArenaRecord) => ArenaRecordNode[];
-export declare const getNodeByUuid: (uuid: string) => (record: ArenaRecord) => ArenaRecordNode | undefined;
-export declare const getNodesByUuids: (uuids: string[]) => (record: ArenaRecord) => ArenaRecordNode[];
+export declare const getNodeByUuid: PositionalRecordGetter<{
+    uuid: string;
+}, [uuid: string], ArenaRecordNode | undefined>;
+export declare const getNodesByUuids: PositionalRecordGetter<{
+    uuids: string[];
+}, [uuids: string[]], ArenaRecordNode[]>;
 export declare const getRoot: (record: ArenaRecord) => ArenaRecordNode | undefined;
-export declare const getChildren: (parentNode: ArenaRecordNode, childDefUuid?: string) => (record: ArenaRecord) => ArenaRecordNode[];
-export declare const getChild: (parentNode: ArenaRecordNode, childDefUuid: string) => (record: ArenaRecord) => ArenaRecordNode;
-export declare const getParent: (node: ArenaRecordNode) => (record: ArenaRecord) => ArenaRecordNode | undefined;
-export declare const getNodesByDefUuid: (nodeDefUuid: string) => (record: ArenaRecord) => ArenaRecordNode[];
-export declare const isNodeApplicable: (params: {
-    record: ArenaRecord;
+export declare const getChildren: PositionalRecordGetter<{
+    parentNode: ArenaRecordNode;
+    childDefUuid?: string;
+}, [parentNode: ArenaRecordNode, childDefUuid?: string | undefined], ArenaRecordNode[]>;
+export declare const getChild: PositionalRecordGetter<{
+    parentNode: ArenaRecordNode;
+    childDefUuid: string;
+}, [parentNode: ArenaRecordNode, childDefUuid: string], ArenaRecordNode>;
+export declare const getParent: PositionalRecordGetter<{
     node: ArenaRecordNode;
-}) => boolean;
-export declare const isNodeEditable: (params: {
-    record: ArenaRecord;
+}, [node: ArenaRecordNode], ArenaRecordNode | undefined>;
+export declare const getNodesByDefUuid: PositionalRecordGetter<{
+    nodeDefUuid: string;
+}, [nodeDefUuid: string], ArenaRecordNode[]>;
+export declare const isNodeApplicable: RecordGetter<RecordParams & {
     node: ArenaRecordNode;
-}) => boolean;
-export declare const isNodeVisible: (params: {
-    record: ArenaRecord;
+}, boolean>;
+export declare const isNodeEditable: RecordGetter<RecordParams & {
     node: ArenaRecordNode;
-}) => boolean;
-export declare const getDependentCodeAttributes: (node: ArenaRecordNode) => (record: ArenaRecord) => ArenaRecordNode[];
+}, boolean>;
+export declare const isNodeVisible: RecordGetter<RecordParams & {
+    node: ArenaRecordNode;
+}, boolean>;
+export declare const getDependentCodeAttributes: PositionalRecordGetter<{
+    node: ArenaRecordNode;
+}, [node: ArenaRecordNode], ArenaRecordNode[]>;
 export declare const getParentCodeAttribute: (params: {
     parentNode: ArenaRecordNode;
     nodeDef: NodeDefCode;
 }) => (record: ArenaRecord) => ArenaRecordNode | undefined;
-export declare const visitAncestorsAndSelf: (node: ArenaRecordNode, visitor: (node: ArenaRecordNode) => void, stopIfFn?: () => boolean) => (record: ArenaRecord) => void;
-export declare const findAncestor: (node: ArenaRecordNode, predicate: (node: ArenaRecordNode) => boolean) => (record: ArenaRecord) => ArenaRecordNode | undefined;
-export declare const getAncestor: (params: {
+/**
+ * Visits the specified node and its ancestors, from the node up to the root: the visit stops when the visitor returns true.
+ */
+export declare const visitAncestorsAndSelf: PositionalRecordGetter<{
+    node: ArenaRecordNode;
+    visitor: (node: ArenaRecordNode) => boolean | void;
+}, [node: ArenaRecordNode, visitor: (node: ArenaRecordNode) => void, stopIfFn?: (() => boolean) | undefined], void>;
+/**
+ * Returns the first node satisfying the predicate among the specified node and its ancestors (from the node up to the root).
+ */
+export declare const findAncestor: (params: {
+    node: ArenaRecordNode;
+    predicate: (node: ArenaRecordNode) => boolean;
+}) => (record: ArenaRecord) => ArenaRecordNode | undefined;
+export declare const getAncestor: RecordGetter<{
     record: ArenaRecord;
     node: ArenaRecordNode;
     ancestorDefUuid: string;
-}) => ArenaRecordNode | undefined;
+}, ArenaRecordNode | undefined>;
 /**
  * Returns the list of ancestors from the given node to the root entity
  */
-export declare const getAncestorsAndSelf: (params: {
+export declare const getAncestorsAndSelf: RecordGetter<{
     record: ArenaRecord;
     node: ArenaRecordNode;
-}) => Array<ArenaRecordNode>;
-export declare const getDescendantsOrSelf: (params: {
+}, ArenaRecordNode[]>;
+export declare const getDescendantsOrSelf: RecordGetter<{
     record: ArenaRecord;
     node: ArenaRecordNode;
     nodeDefDescendant: NodeDef<any>;
-}) => ArenaRecordNode[];
-export declare const getDescendant: (params: {
+}, ArenaRecordNode[]>;
+export declare const getDescendant: RecordGetter<{
     record: ArenaRecord;
     node: ArenaRecordNode;
     nodeDefDescendant: NodeDef<any>;
-}) => ArenaRecordNode;
+}, ArenaRecordNode>;
 export declare const isDescendantOf: (params: {
     node: ArenaRecordNode;
     ancestor: ArenaRecordNode;
 }) => boolean;
-export declare const visitDescendantsAndSelf: (params: {
+export declare const visitDescendantsAndSelf: RecordGetter<{
     record: ArenaRecord;
     node: ArenaRecordNode;
     visitor: (node: ArenaRecordNode) => boolean | void;
     traverseMethod?: TraverseMethod;
-}) => void;
-export declare const findDescendantOrSelf: (node: ArenaRecordNode, predicate: (node: ArenaRecordNode) => boolean) => (record: ArenaRecord) => ArenaRecordNode | undefined;
+}, void>;
+export declare const findDescendantOrSelf: (params: {
+    node: ArenaRecordNode;
+    predicate: (node: ArenaRecordNode) => boolean;
+}) => (record: ArenaRecord) => ArenaRecordNode | undefined;
 type EntityKeyNodesGetterParams = {
     survey: Survey;
     cycle?: string;
@@ -72,62 +121,66 @@ type EntityKeyNodesGetterParams = {
     entity: ArenaRecordNode;
     keyDefs?: NodeDef<NodeDefType, NodeDefProps>[];
 };
-export declare const getEntityKeyNodesByDefUuid: (params: EntityKeyNodesGetterParams) => NodesMap;
-export declare const getEntityKeyNodes: (params: EntityKeyNodesGetterParams) => ArenaRecordNode[];
-export declare const getEntityKeyValuesByDefUuid: (params: EntityKeyNodesGetterParams) => Dictionary<any>;
-export declare const getEntityKeyValues: (params: EntityKeyNodesGetterParams) => any[];
-export declare const getEntitySiblings: (params: {
+export declare const getEntityKeyNodesByDefUuid: RecordGetter<EntityKeyNodesGetterParams, NodesMap>;
+export declare const getEntityKeyNodes: RecordGetter<EntityKeyNodesGetterParams, ArenaRecordNode[]>;
+export declare const getEntityKeyValuesByDefUuid: RecordGetter<EntityKeyNodesGetterParams, Dictionary<any>>;
+export declare const getEntityKeyValues: RecordGetter<EntityKeyNodesGetterParams, any[]>;
+export declare const getEntitySiblings: RecordGetter<{
     record: ArenaRecord;
     entity: ArenaRecordNode;
     includeSelf?: boolean;
-}) => ArenaRecordNode[];
-export declare const getAttributeSiblings: (params: {
+}, ArenaRecordNode[]>;
+export declare const getAttributeSiblings: RecordGetter<{
     record: ArenaRecord;
     node: ArenaRecordNode;
     nodeDef: NodeDef<NodeDefType, NodeDefProps>;
-}) => ArenaRecordNode[];
-export declare const getNodeIndex: (params: {
+}, ArenaRecordNode[]>;
+export declare const getNodeIndex: RecordGetter<{
     record: ArenaRecord;
     node: ArenaRecordNode;
-}) => number;
-export declare const findEntityByKeyValues: (params: {
+}, number>;
+export declare const findEntityByKeyValues: RecordGetter<{
     survey: Survey;
     cycle: string;
     record: ArenaRecord;
     parentEntity: ArenaRecordNode;
     entityDefUuid: string;
     keyValuesByDefUuid: Dictionary<any>;
-}) => ArenaRecordNode | undefined;
-export declare const findEntityWithSameKeysInAnotherRecord: (params: {
+}, ArenaRecordNode | undefined>;
+export declare const findEntityWithSameKeysInAnotherRecord: RecordGetter<{
     survey: Survey;
     cycle: string;
     entityUuid: string;
     record: ArenaRecord;
     recordOther: ArenaRecord;
-}) => ArenaRecordNode | undefined;
-export declare const getDependentNodePointers: (params: {
+}, ArenaRecordNode | undefined>;
+export declare const getDependentNodePointers: RecordGetter<{
     survey: Survey;
     record: ArenaRecord;
     node: ArenaRecordNode;
     dependencyType: SurveyDependencyType;
     includeSelf?: boolean;
     filterFn?: (nodePointer: NodePointer) => boolean;
-}) => NodePointer[];
-export declare const getAncestorCodePath: (params: {
+}, NodePointer[]>;
+export declare const getAncestorCodePath: RecordGetter<{
     survey: Survey;
     record: ArenaRecord;
     parentNode: ArenaRecordNode;
     nodeDef: NodeDef<NodeDefType.code, NodeDefCodeProps>;
-}) => string[];
-export declare const getCategoryItemUuid: (params: {
+}, string[]>;
+export declare const getCategoryItemUuid: RecordGetter<{
     survey: Survey;
     nodeDef: NodeDef<NodeDefType.code, NodeDefCodeProps>;
     record: ArenaRecord;
     parentNode: ArenaRecordNode;
     code: string;
-}) => string | undefined;
-export declare const isNodeFilledByUser: (node: ArenaRecordNode) => (record: ArenaRecord) => boolean;
-export declare const isNodeEmpty: (node: ArenaRecordNode) => (record: ArenaRecord) => boolean;
+}, string | undefined>;
+export declare const isNodeFilledByUser: PositionalRecordGetter<{
+    node: ArenaRecordNode;
+}, [node: ArenaRecordNode], boolean>;
+export declare const isNodeEmpty: PositionalRecordGetter<{
+    node: ArenaRecordNode;
+}, [node: ArenaRecordNode], boolean>;
 export declare const isEmpty: (record: ArenaRecord) => boolean;
 export declare const getStep: (record: ArenaRecord) => string;
 export declare const isInAnalysisStep: (record: ArenaRecord) => boolean;