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>
82 lines
1.6 KiB
Markdown
82 lines
1.6 KiB
Markdown
# @tpmjs/official-base64-encode
|
|
|
|
Encode string or buffer to base64 format with support for multiple character encodings.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @tpmjs/official-base64-encode
|
|
```
|
|
|
|
## Usage
|
|
|
|
```typescript
|
|
import { base64EncodeTool } from '@tpmjs/official-base64-encode';
|
|
import { generateText } from 'ai';
|
|
|
|
const result = await generateText({
|
|
model: yourModel,
|
|
tools: {
|
|
base64Encode: base64EncodeTool,
|
|
},
|
|
prompt: 'Encode "Hello, World!" to base64',
|
|
});
|
|
```
|
|
|
|
## Parameters
|
|
|
|
- `data` (string, required): The data to encode to base64
|
|
- `encoding` (string, optional): Character encoding of the input data
|
|
- Options: `'utf8'` (default), `'binary'`, `'hex'`
|
|
|
|
## Returns
|
|
|
|
```typescript
|
|
{
|
|
base64: string; // The base64 encoded string
|
|
byteLength: number; // The byte length of the original data
|
|
}
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Encode UTF-8 text (default)
|
|
|
|
```typescript
|
|
const result = await base64EncodeTool.execute({
|
|
data: 'Hello, World!',
|
|
});
|
|
// { base64: 'SGVsbG8sIFdvcmxkIQ==', byteLength: 13 }
|
|
```
|
|
|
|
### Encode binary data
|
|
|
|
```typescript
|
|
const result = await base64EncodeTool.execute({
|
|
data: '\x00\x01\x02\x03',
|
|
encoding: 'binary',
|
|
});
|
|
// { base64: 'AAECAw==', byteLength: 4 }
|
|
```
|
|
|
|
### Encode hex string
|
|
|
|
```typescript
|
|
const result = await base64EncodeTool.execute({
|
|
data: 'deadbeef',
|
|
encoding: 'hex',
|
|
});
|
|
// { base64: '3q2+7w==', byteLength: 4 }
|
|
```
|
|
|
|
## Use Cases
|
|
|
|
- Encoding text for data URIs
|
|
- Preparing binary data for transmission
|
|
- Converting hex strings to base64
|
|
- Encoding authentication credentials
|
|
- Creating base64-encoded images or files
|
|
|
|
## License
|
|
|
|
MIT
|