@theenix/token-zap 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Theekshana Nirmal
+
+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,93 @@
+# TokenZap
+<div>
+  <img src="assets/logo.webp" alt="TokenZap Logo" width="800">
+</div>
+
+TokenZap is a lightweight utility designed to optimize text payloads before they are sent to Large Language Models (LLMs). By systematically identifying and removing redundant spacing, unnecessary characters, and structural filler, the tool helps developers reduce API token consumption and lower operational costs.
+
+Because LLM tokenizers process text differently than humans, hidden characters like consecutive spaces, trailing lines, and specific structural markers inflate your token count without adding any semantic value. TokenZap strips away this hidden overhead, enabling you to fit more actual content into the model's context window.
+
+## Installation
+
+You can install TokenZap directly from the npm registry using the following command:
+
+```bash
+npm install @thee-nix/token-zap
+```
+
+## Usage
+### Basic Guide
+
+TokenZap exports a single function called `tokenZap` that accepts a text string and an options object. Here is a simple example:
+
+```js
+import { tokenZap } from "@thee-nix/token-zap";
+
+const text = "This is  a   sample    text with extra spaces.";
+const cleaned = tokenZap(text);
+
+console.log(cleaned);
+// Output: "This is a sample text with extra spaces."
+```
+
+### Options
+
+The `tokenZap` function accepts the following options:
+
+- **removeArticles** (boolean, default: `false`) - When set to `true`, removes articles like "a", "an", and "the" from the text. This can further reduce token count but may affect readability.
+
+- **trimExtraSpaces** (boolean, default: `true`) - When set to `true`, removes extra spaces and collapses multiple spaces into single spaces. This option is enabled by default.
+
+### Examples
+
+#### Remove Extra Spaces Only
+
+```js
+import { tokenZap } from "@thee-nix/token-zap";
+
+const text = "This is  a   line with   extra spaces.";
+const result = tokenZap(text);
+
+console.log(result);
+// Output: "This is a line with extra spaces."
+```
+
+#### Remove Articles and Extra Spaces
+
+```js
+import { tokenZap } from "@thee-nix/token-zap";
+
+const text = "The quick brown fox jumps over the lazy dog.";
+const result = tokenZap(text, { removeArticles: true });
+
+console.log(result);
+// Output: "quick brown fox jumps over lazy dog."
+```
+
+#### Disable Trimming Extra Spaces
+
+```js
+import { tokenZap } from "@thee-nix/token-zap";
+
+const text = "This is  a   sample.";
+const result = tokenZap(text, { trimExtraSpaces: false, removeArticles: true });
+
+console.log(result);
+// Output: "This is     sample."
+```
+
+## Future Plans
+
+TokenZap is actively being developed. Here are some features planned for future releases:
+
+- Support for removing common filler words and stop words to further reduce token count.
+- Language-specific optimization for different languages beyond English.
+- Statistics and reporting features to show how many tokens were saved.
+- Customizable word removal lists for domain-specific text optimization.
+- Performance improvements for processing large text documents.
+- Integration with popular LLM libraries for seamless prompt optimization.
+
+## Repository Link
+
+The source code is available on GitHub:
+[https://github.com/theekshana-nirmal/token-zap](https://www.google.com/search?q=https://github.com/theekshana-nirmal/token-zap)

package/index.js

@@ -0,0 +1,18 @@
+import { removeArticles as rmArticles } from "./utils/removeArticles.js";
+import { trimExtraSpaces as trimSpaces } from "./utils/trimExtraSpaces.js";
+
+export function tokenZap(prompt, options = {}) {
+  const { removeArticles = false, trimExtraSpaces = true } = options;
+
+  // Remove articles if the option is enabled
+  if (removeArticles) {
+    prompt = rmArticles(prompt);
+  }
+
+  // Trim extra spaces by default
+  if (trimExtraSpaces) {
+    prompt = trimSpaces(prompt);
+  }
+
+  return prompt;
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@theenix/token-zap",
+  "version": "1.0.0",
+  "description": "Shrink your LLM prompts instantly. TokenZap removes wasteful spacing and unnecessary characters to keep your API payloads lean and token-efficient.",
+  "main": "index.js",
+  "scripts": {
+    "test": "node test/test.js"
+  },
+  "type": "module",
+  "repository": {
+    "type": "github",
+    "url": "git+https://github.com/theekshana-nirmal/token-zap.git#main"
+  },
+  "homepage": "https://github.com/theekshana-nirmal/token-zap#readme",
+  "bugs": {
+    "url": "https://github.com/theekshana-nirmal/token-zap/issues"
+  },
+  "exports": {
+    ".": "./index.js"
+  },
+  "files": [
+    "index.js",
+    "README.md",
+    "utils/",
+    "LICENSE"
+  ],
+  "keywords": [
+    "llm",
+    "prompt-engineering",
+    "token-reduction",
+    "text-compression",
+    "openai",
+    "minify",
+    "prompt-optimization",
+    "tokenizer"
+  ],
+  "author": "Theekshana Nirmal <131228387+theekshana-nirmal@users.noreply.github.com>",
+  "license": "MIT"
+}

package/utils/removeArticles.js

@@ -0,0 +1,15 @@
+/** 
+  Remove articles from the prompt to reduce token count.
+  This function uses a regular expression to identify and remove the articles "a", "an", and "the" from the input string.
+  The regex is case-insensitive and ensures that only whole words are removed, preventing partial matches. 
+
+  @param {string} prompt - The input string from which to remove articles.
+  @returns {string} - The cleaned string with articles removed.
+*/
+
+export function removeArticles(prompt) {
+  const regex = new RegExp("\\b(a|an|the)\\b", "gi");
+  let cleanText = prompt.replace(regex, "");
+
+  return cleanText;
+}

package/utils/trimExtraSpaces.js

@@ -0,0 +1,10 @@
+/**
+ * Trims extra spaces and new line characters from the input string, and also removes leading and trailing spaces.
+ *
+ * @param {string} prompt - The input string from which to trim extra spaces and new line characters.
+ * @returns {string} - The cleaned string with extra spaces, new line characters removed, and leading/trailing spaces trimmed.
+ */
+export function trimExtraSpaces(prompt) {
+  const cleanPrompt = prompt.replace(/\s+/g, " ").trim();
+  return cleanPrompt;
+}