@jeremysnr/snug 0.1.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Jeremy Smith
+
+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,108 @@
+# snug
+
+**Fit prioritised content into a token budget.**
+
+Every LLM application has the same problem: you have a context window of N tokens and need to fit a system prompt, conversation history, retrieved documents, and tool definitions into it — with space left for the model's reply. Every team writes their own solution from scratch.
+
+`snug` is a single function that solves this once.
+
+```ts
+import { fit } from 'snug';
+
+const { included } = fit(
+  [
+    { id: 'system',  content: systemPrompt,  priority: 100 },
+    { id: 'history', content: chatHistory,   priority:  60 },
+    { id: 'rag',     content: retrievedDocs, priority:  40 },
+  ],
+  { budget: 8192, reserve: 1024, tokenizer: myTokenizer },
+);
+
+// included — items that fit, in original input order
+// excluded — items that didn't fit
+```
+
+Items are selected greedily in descending priority order. The result preserves original input order. Zero dependencies. Works in Node, Deno, Bun, and edge runtimes.
+
+## Install
+
+```
+npm install snug
+```
+
+## API
+
+### `fit(items, options)`
+
+```ts
+fit(items: Item[], options: FitOptions): FitResult
+```
+
+**Item**
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `id` | `string` | Unique identifier |
+| `content` | `unknown` | Your content — not inspected by snug |
+| `priority` | `number` | Higher = included first |
+| `tokens` | `number` | Pre-counted cost (optional — see below) |
+| `pairId` | `string` | Atomic pair group (optional — see below) |
+
+**FitOptions**
+
+| Field | Type | Default | Description |
+|-------|------|---------|-------------|
+| `budget` | `number` | — | Token limit for included items |
+| `tokenizer` | `(text: string) => number` | built-in approx | Your token counter |
+| `reserve` | `number` | `0` | Tokens to hold back (e.g. for model response) |
+| `suppressApproximationWarning` | `boolean` | `false` | Silence the no-tokenizer warning |
+
+**FitResult**
+
+```ts
+{
+  included: Item[];     // items that fit, original order
+  excluded: Item[];     // items that didn't fit
+  tokensUsed: number;
+  tokensRemaining: number;
+}
+```
+
+## Pair constraints
+
+Anthropic's API requires strict 1:1 pairing between `tool_use` and `tool_result` messages — orphaning either half causes a 400 error. Mark paired items with a shared `pairId` and snug treats them as an atomic unit: both are included or neither is.
+
+```ts
+fit(
+  [
+    { id: 'use',    content: toolUse,    priority: 80, pairId: 'call-1' },
+    { id: 'result', content: toolResult, priority: 80, pairId: 'call-1' },
+  ],
+  { budget: 2048, tokenizer },
+);
+```
+
+All items in a pair group must share the same `priority`.
+
+## Token counting
+
+Pass any `(text: string) => number` function:
+
+```ts
+// tiktoken (OpenAI / Anthropic)
+import { encoding_for_model } from 'tiktoken';
+const enc = encoding_for_model('gpt-4o');
+const tokenizer = (text: string) => enc.encode(text).length;
+```
+
+If you already have a token count (e.g. from an API usage response), pass it directly via the `tokens` field and skip counting entirely:
+
+```ts
+{ id: 'msg', content: msg, priority: 50, tokens: 342 }
+```
+
+When no tokenizer is supplied, snug falls back to `Math.ceil(text.length / 4)` and prints a warning. This is useful for prototyping but can be off by up to 37% in production.
+
+## Licence
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,109 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  approximateTokens: () => approximateTokens,
+  fit: () => fit
+});
+module.exports = __toCommonJS(index_exports);
+var APPROX_WARNING = "[snug] No tokenizer supplied. Using a character-based approximation (~4 chars/token). This can be off by up to 37% on large payloads. Pass a real tokenizer via options.tokenizer for production use.";
+function approximateTokens(text) {
+  return Math.ceil(text.length / 4);
+}
+function resolveTokens(item, tokenizer) {
+  if (item.tokens !== void 0) return item.tokens;
+  if (typeof item.content === "string") return tokenizer(item.content);
+  throw new Error(
+    `[snug] Item "${item.id}" has no \`tokens\` field and its \`content\` is not a string.`
+  );
+}
+function validateItems(items) {
+  const pairPriority = /* @__PURE__ */ new Map();
+  for (const item of items) {
+    if (!Number.isFinite(item.priority)) {
+      throw new Error(`[snug] Item "${item.id}" has a non-finite priority: ${item.priority}`);
+    }
+    if (item.pairId !== void 0) {
+      const existing = pairPriority.get(item.pairId);
+      if (existing === void 0) {
+        pairPriority.set(item.pairId, item.priority);
+      } else if (existing !== item.priority) {
+        throw new Error(
+          `[snug] All items in pair group "${item.pairId}" must have the same priority. Found ${existing} and ${item.priority}.`
+        );
+      }
+    }
+  }
+}
+function fit(items, options) {
+  const { budget, reserve = 0, suppressApproximationWarning = false } = options;
+  if (!Number.isFinite(budget) || budget <= 0) {
+    throw new Error(`[snug] budget must be a positive finite number. Got: ${budget}`);
+  }
+  if (!Number.isFinite(reserve) || reserve < 0) {
+    throw new Error(`[snug] reserve must be a non-negative finite number. Got: ${reserve}`);
+  }
+  const effectiveBudget = budget - reserve;
+  if (effectiveBudget <= 0) {
+    throw new Error(`[snug] reserve (${reserve}) must be less than budget (${budget}).`);
+  }
+  const tokenizer = options.tokenizer ?? (() => {
+    if (!suppressApproximationWarning) console.warn(APPROX_WARNING);
+    return approximateTokens;
+  })();
+  validateItems(items);
+  const costs = new Map(
+    items.map((item) => [item.id, resolveTokens(item, tokenizer)])
+  );
+  const groupMap = /* @__PURE__ */ new Map();
+  for (let i = 0; i < items.length; i++) {
+    const item = items[i];
+    const key = item.pairId ?? item.id;
+    if (!groupMap.has(key)) {
+      groupMap.set(key, { items: [], totalTokens: 0, priority: item.priority, firstIndex: i });
+    }
+    const g = groupMap.get(key);
+    g.items.push(item);
+    g.totalTokens += costs.get(item.id);
+  }
+  const groups = [...groupMap.values()].sort(
+    (a, b) => b.priority - a.priority || a.firstIndex - b.firstIndex
+  );
+  const includedIds = /* @__PURE__ */ new Set();
+  let tokensUsed = 0;
+  for (const g of groups) {
+    if (tokensUsed + g.totalTokens <= effectiveBudget) {
+      for (const item of g.items) includedIds.add(item.id);
+      tokensUsed += g.totalTokens;
+    }
+  }
+  const included = [];
+  const excluded = [];
+  for (const item of items) {
+    (includedIds.has(item.id) ? included : excluded).push(item);
+  }
+  return { included, excluded, tokensUsed, tokensRemaining: effectiveBudget - tokensUsed };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  approximateTokens,
+  fit
+});

package/dist/index.d.cts

@@ -0,0 +1,25 @@
+type Tokenizer = (text: string) => number;
+interface Item {
+    id: string;
+    content: unknown;
+    tokens?: number;
+    priority: number;
+    /** Items sharing a pairId are included or excluded as a unit. */
+    pairId?: string;
+}
+interface FitOptions {
+    budget: number;
+    tokenizer?: Tokenizer;
+    reserve?: number;
+    suppressApproximationWarning?: boolean;
+}
+interface FitResult<T extends Item = Item> {
+    included: T[];
+    excluded: T[];
+    tokensUsed: number;
+    tokensRemaining: number;
+}
+declare function approximateTokens(text: string): number;
+declare function fit<T extends Item>(items: T[], options: FitOptions): FitResult<T>;
+
+export { type FitOptions, type FitResult, type Item, type Tokenizer, approximateTokens, fit };

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+type Tokenizer = (text: string) => number;
+interface Item {
+    id: string;
+    content: unknown;
+    tokens?: number;
+    priority: number;
+    /** Items sharing a pairId are included or excluded as a unit. */
+    pairId?: string;
+}
+interface FitOptions {
+    budget: number;
+    tokenizer?: Tokenizer;
+    reserve?: number;
+    suppressApproximationWarning?: boolean;
+}
+interface FitResult<T extends Item = Item> {
+    included: T[];
+    excluded: T[];
+    tokensUsed: number;
+    tokensRemaining: number;
+}
+declare function approximateTokens(text: string): number;
+declare function fit<T extends Item>(items: T[], options: FitOptions): FitResult<T>;
+
+export { type FitOptions, type FitResult, type Item, type Tokenizer, approximateTokens, fit };

package/dist/index.js

@@ -0,0 +1,83 @@
+// src/index.ts
+var APPROX_WARNING = "[snug] No tokenizer supplied. Using a character-based approximation (~4 chars/token). This can be off by up to 37% on large payloads. Pass a real tokenizer via options.tokenizer for production use.";
+function approximateTokens(text) {
+  return Math.ceil(text.length / 4);
+}
+function resolveTokens(item, tokenizer) {
+  if (item.tokens !== void 0) return item.tokens;
+  if (typeof item.content === "string") return tokenizer(item.content);
+  throw new Error(
+    `[snug] Item "${item.id}" has no \`tokens\` field and its \`content\` is not a string.`
+  );
+}
+function validateItems(items) {
+  const pairPriority = /* @__PURE__ */ new Map();
+  for (const item of items) {
+    if (!Number.isFinite(item.priority)) {
+      throw new Error(`[snug] Item "${item.id}" has a non-finite priority: ${item.priority}`);
+    }
+    if (item.pairId !== void 0) {
+      const existing = pairPriority.get(item.pairId);
+      if (existing === void 0) {
+        pairPriority.set(item.pairId, item.priority);
+      } else if (existing !== item.priority) {
+        throw new Error(
+          `[snug] All items in pair group "${item.pairId}" must have the same priority. Found ${existing} and ${item.priority}.`
+        );
+      }
+    }
+  }
+}
+function fit(items, options) {
+  const { budget, reserve = 0, suppressApproximationWarning = false } = options;
+  if (!Number.isFinite(budget) || budget <= 0) {
+    throw new Error(`[snug] budget must be a positive finite number. Got: ${budget}`);
+  }
+  if (!Number.isFinite(reserve) || reserve < 0) {
+    throw new Error(`[snug] reserve must be a non-negative finite number. Got: ${reserve}`);
+  }
+  const effectiveBudget = budget - reserve;
+  if (effectiveBudget <= 0) {
+    throw new Error(`[snug] reserve (${reserve}) must be less than budget (${budget}).`);
+  }
+  const tokenizer = options.tokenizer ?? (() => {
+    if (!suppressApproximationWarning) console.warn(APPROX_WARNING);
+    return approximateTokens;
+  })();
+  validateItems(items);
+  const costs = new Map(
+    items.map((item) => [item.id, resolveTokens(item, tokenizer)])
+  );
+  const groupMap = /* @__PURE__ */ new Map();
+  for (let i = 0; i < items.length; i++) {
+    const item = items[i];
+    const key = item.pairId ?? item.id;
+    if (!groupMap.has(key)) {
+      groupMap.set(key, { items: [], totalTokens: 0, priority: item.priority, firstIndex: i });
+    }
+    const g = groupMap.get(key);
+    g.items.push(item);
+    g.totalTokens += costs.get(item.id);
+  }
+  const groups = [...groupMap.values()].sort(
+    (a, b) => b.priority - a.priority || a.firstIndex - b.firstIndex
+  );
+  const includedIds = /* @__PURE__ */ new Set();
+  let tokensUsed = 0;
+  for (const g of groups) {
+    if (tokensUsed + g.totalTokens <= effectiveBudget) {
+      for (const item of g.items) includedIds.add(item.id);
+      tokensUsed += g.totalTokens;
+    }
+  }
+  const included = [];
+  const excluded = [];
+  for (const item of items) {
+    (includedIds.has(item.id) ? included : excluded).push(item);
+  }
+  return { included, excluded, tokensUsed, tokensRemaining: effectiveBudget - tokensUsed };
+}
+export {
+  approximateTokens,
+  fit
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@jeremysnr/snug",
+  "version": "0.1.0",
+  "description": "Fit prioritised content into a token budget. Zero dependencies.",
+  "keywords": [
+    "llm",
+    "tokens",
+    "context-window",
+    "budget",
+    "priority"
+  ],
+  "license": "MIT",
+  "author": "Jeremy Smith",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JeremySNR/snug.git"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "test": "node node_modules/jest/bin/jest.js",
+    "prepublishOnly": "npm run build",
+    "demo": "npx tsx examples/demo.ts"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.14.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.5",
+    "tsup": "^8.5.1",
+    "typescript": "^5.5.0"
+  }
+}