@tpmjs/official-base64-encode 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2025 TPMJS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,82 @@
+# @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

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+import * as ai from 'ai';
+
+/**
+ * Base64 Encode Tool for TPMJS
+ * Encodes string data to base64 format with support for multiple character encodings
+ */
+/**
+ * Supported character encodings for base64 encoding
+ */
+type Encoding = 'utf8' | 'binary' | 'hex';
+/**
+ * Input interface for base64 encoding
+ */
+interface Base64EncodeInput {
+    data: string;
+    encoding?: Encoding;
+}
+/**
+ * Output interface for base64 encode result
+ */
+interface Base64EncodeResult {
+    base64: string;
+    byteLength: number;
+}
+/**
+ * Base64 Encode Tool
+ * Encodes string or buffer data to base64 format
+ */
+declare const base64EncodeTool: ai.Tool<Base64EncodeInput, Base64EncodeResult>;
+
+export { type Base64EncodeResult, base64EncodeTool, base64EncodeTool as default };

package/dist/index.js

@@ -0,0 +1,48 @@
+import { tool, jsonSchema } from 'ai';
+
+// src/index.ts
+var base64EncodeTool = tool({
+  description: "Encode string or buffer to base64 format. Supports utf8 (default), binary, and hex character encodings. Returns the base64 encoded string and the byte length of the original data.",
+  inputSchema: jsonSchema({
+    type: "object",
+    properties: {
+      data: {
+        type: "string",
+        description: "The data to encode to base64"
+      },
+      encoding: {
+        type: "string",
+        enum: ["utf8", "binary", "hex"],
+        description: "Character encoding of the input data (default: utf8)"
+      }
+    },
+    required: ["data"],
+    additionalProperties: false
+  }),
+  execute: async ({ data, encoding = "utf8" }) => {
+    if (typeof data !== "string") {
+      throw new Error("Data must be a string");
+    }
+    const validEncodings = ["utf8", "binary", "hex"];
+    if (!validEncodings.includes(encoding)) {
+      throw new Error(
+        `Invalid encoding: ${encoding}. Must be one of: ${validEncodings.join(", ")}`
+      );
+    }
+    try {
+      const buffer = Buffer.from(data, encoding);
+      const base64 = buffer.toString("base64");
+      return {
+        base64,
+        byteLength: buffer.length
+      };
+    } catch (error) {
+      throw new Error(
+        `Failed to encode data: ${error instanceof Error ? error.message : String(error)}`
+      );
+    }
+  }
+});
+var index_default = base64EncodeTool;
+
+export { base64EncodeTool, index_default as default };

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@tpmjs/official-base64-encode",
+  "version": "0.1.0",
+  "description": "Encode string or buffer to base64 format with support for multiple character encodings",
+  "type": "module",
+  "keywords": [
+    "tpmjs",
+    "data",
+    "base64",
+    "encode",
+    "encoding"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "tsup": "^8.3.5",
+    "typescript": "^5.9.3",
+    "@tpmjs/tsconfig": "0.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/anthropics/tpmjs.git",
+    "directory": "packages/tools/official/base64-encode"
+  },
+  "homepage": "https://tpmjs.com",
+  "license": "MIT",
+  "tpmjs": {
+    "category": "data",
+    "frameworks": [
+      "vercel-ai"
+    ],
+    "tools": [
+      {
+        "name": "base64EncodeTool",
+        "description": "Encode string or buffer to base64 format with support for multiple character encodings",
+        "parameters": [
+          {
+            "name": "data",
+            "type": "string",
+            "description": "The data to encode",
+            "required": true
+          },
+          {
+            "name": "encoding",
+            "type": "string",
+            "description": "Character encoding (utf8, binary, hex)",
+            "required": false
+          }
+        ],
+        "returns": {
+          "type": "Base64EncodeResult",
+          "description": "Object with base64 encoded string and byte length"
+        }
+      }
+    ]
+  },
+  "dependencies": {
+    "ai": "6.0.0-beta.124"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "type-check": "tsc --noEmit",
+    "clean": "rm -rf dist .turbo"
+  }
+}