engineering/tpmjs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2.1k
tpmjs/packages/tools/official/release-notes/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.4 KiB
Raw Blame History

@tpmjs/tools-release-notes

Generate release notes from structured changes. Groups changes by type and formats them as markdown.

Installation

npm install @tpmjs/tools-release-notes ai

Usage

import { releaseNotesTool } from '@tpmjs/tools-release-notes';

const result = await releaseNotesTool.execute({
  version: 'v1.2.0',
  changes: [
    {
      type: 'feature',
      description: 'Add dark mode support',
      issue: '123',
    },
    {
      type: 'fix',
      description: 'Fix memory leak in cache manager',
      issue: '456',
    },
    {
      type: 'breaking',
      description: 'Remove deprecated API methods',
    },
    {
      type: 'docs',
      description: 'Update installation guide',
    },
  ],
});

console.log(result.notes);

Output

# v1.2.0 (2025-12-31)

⚠️ **This release contains breaking changes!**

**Changes:** 4 total (1 feature, 1 fix, 1 breaking, 1 other)

---

## 💥 BREAKING CHANGES

- Remove deprecated API methods

## ✨ Features

- Add dark mode support ([#123](../../issues/123))

## 🐛 Bug Fixes

- Fix memory leak in cache manager ([#456](../../issues/456))

## 📝 Documentation

- Update installation guide

Features

  • Groups changes by type with emojis
  • Highlights breaking changes at the top
  • Generates summary statistics
  • Links to GitHub issues (if provided)
  • Clean markdown formatting
  • Automatic date generation

Parameters

  • version (string, required) - Version number (e.g., "1.2.0", "v2.0.0-beta.1")
  • changes (array, required) - Array of change objects:
    • type (string) - One of: feature, fix, breaking, docs, chore, perf, refactor, test, other
    • description (string) - Description of the change
    • issue (string, optional) - Issue number (e.g., "123")

Returns

{
  notes: string;           // Formatted markdown
  version: string;         // Version number
  date: string;           // ISO date (YYYY-MM-DD)
  summary: {
    features: number;
    fixes: number;
    breaking: number;
    other: number;
    total: number;
  };
}

Change Types

The tool supports the following change types:

  • feature - New features
  • fix - Bug fixes
  • breaking - Breaking changes
  • docs - Documentation updates
  • chore - Maintenance tasks
  • perf - Performance improvements
  • refactor - Code refactoring
  • test - Test updates
  • other - Other changes

License

MIT