tpmjs/packages/tools/official/rows-group-aggregate/README.md
Ajax Davis 5d2096fb5d feat: add 100+ official TPMJS tools
Implements a comprehensive suite of AI SDK v6 tools across multiple categories:

- Research (5): page-brief, compare-pages, source-credibility, claim-checklist, timeline-from-text
- Web (10): fetch-text, links-catalog, extract-meta, extract-json-ld, redirect-trace, sitemap-read, rss-read, table-extract, robots-policy, url-normalize
- Data (15): csv-parse, csv-stringify, json-repair, json-schema-validate, yaml-parse, yaml-stringify, text-chunk, normalize-whitespace, dedupe-by-key, pivot, rows-filter, rows-sort, rows-group-aggregate, rows-join, schema-infer
- Doc (12): toc-generate, glossary-build, faq-from-text, executive-brief, decision-record-adr, prd-outline, acceptance-criteria, style-rewrite
- Eng (12): diff-text-unified, env-var-docs-generate, dependency-audit-lite, conventional-commit-suggest, markdown-lint-basic, test-case-generate, stacktrace-parse, release-notes, changelog-entry, release-checklist
- Security (7): redact-secrets, secret-scan-text, url-risk-heuristic, csp-compose, hardening-checklist-web, access-control-matrix, data-classification-heuristic
- Stats (9): effect-size-suite, bootstrap-ci, permutation-test, multiple-testing-adjust, linear-regression-ols, logistic-regression, time-series-decompose-lite, anomaly-detect-mad
- Ops (7): slo-draft, runbook-draft, postmortem-draft, postmortem-action-extractor, error-log-triage, coverage-tracker, monitoring-gap-analysis
- Agent (15): prompt-to-workflow-skeleton, workflow-validate-io, workflow-explain, workflow-cost-estimate, tool-call-accuracy-score, eval-fixture-build, guardrail-policy-draft, workflow-auto-repair, tool-selection-plan, novelty-score-workflow, workflow-variant-generate, config-normalize, recipe-*
- Utility (8): base64-encode, base64-decode, hash-text, regex-extract, template-render, date-parse, json-path-query, url-parse
- HTML (3): html-sanitize, html-to-markdown, markdown-to-html

All tools follow AI SDK v6 pattern with tool() and jsonSchema<T>().

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-31 22:55:56 +10:00

2 KiB

@tpmjs/tools-rows-group-aggregate

Groups rows by a key field and aggregates values using operations like sum, count, avg, min, max.

Installation

npm install @tpmjs/tools-rows-group-aggregate

Usage

import { rowsGroupAggregateTool } from '@tpmjs/tools-rows-group-aggregate';

const result = await rowsGroupAggregateTool.execute({
  rows: [
    { category: 'A', value: 10, price: 5.5 },
    { category: 'A', value: 20, price: 6.0 },
    { category: 'B', value: 30, price: 7.5 },
    { category: 'B', value: 40, price: 8.0 },
  ],
  groupBy: 'category',
  aggregates: [
    { field: 'value', operation: 'sum' },
    { field: 'value', operation: 'avg' },
    { field: 'price', operation: 'max' },
    { field: 'price', operation: 'min' },
  ],
});

console.log(result);
// {
//   groups: [
//     {
//       groupKey: 'A',
//       aggregates: {
//         value_sum: 30,
//         value_avg: 15,
//         price_max: 6.0,
//         price_min: 5.5
//       },
//       rowCount: 2
//     },
//     {
//       groupKey: 'B',
//       aggregates: {
//         value_sum: 70,
//         value_avg: 35,
//         price_max: 8.0,
//         price_min: 7.5
//       },
//       rowCount: 2
//     }
//   ],
//   groupCount: 2
// }

Parameters

  • rows (required): Array of objects to group and aggregate
  • groupBy (required): Field name to group by (supports nested fields with dot notation like user.id)
  • aggregates (required): Array of aggregation operations, each with:
    • field: Field name to aggregate
    • operation: One of sum, count, avg, min, max

Aggregation Operations

  • sum: Total of all numeric values
  • count: Number of rows in the group
  • avg: Average of numeric values
  • min: Minimum numeric value
  • max: Maximum numeric value

Features

  • Supports nested field access with dot notation
  • Handles null/undefined values gracefully
  • Multiple aggregations per group
  • Type-safe with TypeScript

License

MIT