@jeremysnr/snug-openai 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,59 @@
+# @jeremysnr/snug-openai
+
+[![npm](https://img.shields.io/npm/v/@jeremysnr/snug-openai)](https://www.npmjs.com/package/@jeremysnr/snug-openai)
+[![license](https://img.shields.io/npm/l/@jeremysnr/snug-openai)](./LICENSE)
+
+Fit OpenAI chat messages into a token budget. Pass the result directly to `client.chat.completions.create`.
+
+```ts
+import { fitMessages } from '@jeremysnr/snug-openai';
+
+const { messages } = fitMessages(conversationHistory, {
+  model: 'gpt-4o',
+  budget: 8192,
+  reserve: 1024,
+});
+
+const response = await client.chat.completions.create({ model: 'gpt-4o', messages });
+```
+
+System messages are always kept. Other messages are prioritised by recency — older messages are dropped first when the budget is tight.
+
+## Install
+
+```
+npm install @jeremysnr/snug-openai
+```
+
+`openai` must be installed as a peer dependency.
+
+## API
+
+### `fitMessages(messages, options)`
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `budget` | `number` | — | Token limit |
+| `reserve` | `number` | `0` | Tokens to hold back for the model's reply |
+| `model` | `TiktokenModel` | `'gpt-4o'` | Used to select the tiktoken encoding |
+
+**Returns**
+
+```ts
+{
+  messages: ChatCompletionMessageParam[];  // ready to send
+  dropped: ChatCompletionMessageParam[];   // what didn't fit
+  tokensUsed: number;
+  tokensRemaining: number;
+}
+```
+
+## Part of the snug ecosystem
+
+- [`@jeremysnr/snug`](https://github.com/JeremySNR/snug) — zero-dependency core primitive
+- [`@jeremysnr/snug-tiktoken`](https://github.com/JeremySNR/snug-tiktoken) — snug with tiktoken, model-agnostic
+- [`@jeremysnr/snug-anthropic`](https://github.com/JeremySNR/snug-anthropic) — snug for the Anthropic SDK
+
+## Licence
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,65 @@
+"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, {
+  fitMessages: () => fitMessages
+});
+module.exports = __toCommonJS(index_exports);
+var import_tiktoken = require("tiktoken");
+var import_snug = require("@jeremysnr/snug");
+function messageToText(msg) {
+  if (typeof msg.content === "string") return msg.content;
+  if (Array.isArray(msg.content)) {
+    return msg.content.map((part) => "text" in part ? part.text : "").join("");
+  }
+  return "";
+}
+function fitMessages(messages, options) {
+  const enc = options.model ? (0, import_tiktoken.encoding_for_model)(options.model) : (0, import_tiktoken.get_encoding)("cl100k_base");
+  const MESSAGE_OVERHEAD = 4;
+  try {
+    const tokenizer = (text) => enc.encode(text).length;
+    const items = messages.map((msg, i) => ({
+      id: String(i),
+      content: msg,
+      tokens: tokenizer(messageToText(msg)) + MESSAGE_OVERHEAD,
+      // system = highest priority; others prioritised by recency
+      priority: msg.role === "system" ? 1e4 : i
+    }));
+    const result = (0, import_snug.fit)(items, {
+      budget: options.budget,
+      reserve: options.reserve,
+      suppressApproximationWarning: true
+    });
+    return {
+      messages: result.included.map((i) => i.content),
+      tokensUsed: result.tokensUsed,
+      tokensRemaining: result.tokensRemaining,
+      dropped: result.excluded.map((i) => i.content)
+    };
+  } finally {
+    enc.free();
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  fitMessages
+});

package/dist/index.d.cts

@@ -0,0 +1,33 @@
+import { TiktokenModel } from 'tiktoken';
+import { ChatCompletionMessageParam } from 'openai/resources/chat/completions';
+export { ChatCompletionMessageParam } from 'openai/resources/chat/completions';
+
+interface FitMessagesOptions {
+    /** Token budget for the conversation. */
+    budget: number;
+    /** Tokens to reserve for the model's response. Defaults to 0. */
+    reserve?: number;
+    /**
+     * OpenAI model name — used to select the correct tiktoken encoding.
+     * Defaults to gpt-4o.
+     */
+    model?: TiktokenModel;
+}
+interface FitMessagesResult {
+    /** Messages that fit, in original order. Pass directly to the OpenAI SDK. */
+    messages: ChatCompletionMessageParam[];
+    tokensUsed: number;
+    tokensRemaining: number;
+    /** Messages that were dropped. */
+    dropped: ChatCompletionMessageParam[];
+}
+/**
+ * Fit an array of OpenAI chat messages into a token budget.
+ *
+ * System messages are always highest priority. Other messages are prioritised
+ * by recency — newer messages are kept over older ones when the budget is tight.
+ * The result is ready to pass directly to client.chat.completions.create.
+ */
+declare function fitMessages(messages: ChatCompletionMessageParam[], options: FitMessagesOptions): FitMessagesResult;
+
+export { type FitMessagesOptions, type FitMessagesResult, fitMessages };

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+import { TiktokenModel } from 'tiktoken';
+import { ChatCompletionMessageParam } from 'openai/resources/chat/completions';
+export { ChatCompletionMessageParam } from 'openai/resources/chat/completions';
+
+interface FitMessagesOptions {
+    /** Token budget for the conversation. */
+    budget: number;
+    /** Tokens to reserve for the model's response. Defaults to 0. */
+    reserve?: number;
+    /**
+     * OpenAI model name — used to select the correct tiktoken encoding.
+     * Defaults to gpt-4o.
+     */
+    model?: TiktokenModel;
+}
+interface FitMessagesResult {
+    /** Messages that fit, in original order. Pass directly to the OpenAI SDK. */
+    messages: ChatCompletionMessageParam[];
+    tokensUsed: number;
+    tokensRemaining: number;
+    /** Messages that were dropped. */
+    dropped: ChatCompletionMessageParam[];
+}
+/**
+ * Fit an array of OpenAI chat messages into a token budget.
+ *
+ * System messages are always highest priority. Other messages are prioritised
+ * by recency — newer messages are kept over older ones when the budget is tight.
+ * The result is ready to pass directly to client.chat.completions.create.
+ */
+declare function fitMessages(messages: ChatCompletionMessageParam[], options: FitMessagesOptions): FitMessagesResult;
+
+export { type FitMessagesOptions, type FitMessagesResult, fitMessages };

package/dist/index.js

@@ -0,0 +1,40 @@
+// src/index.ts
+import { encoding_for_model, get_encoding } from "tiktoken";
+import { fit } from "@jeremysnr/snug";
+function messageToText(msg) {
+  if (typeof msg.content === "string") return msg.content;
+  if (Array.isArray(msg.content)) {
+    return msg.content.map((part) => "text" in part ? part.text : "").join("");
+  }
+  return "";
+}
+function fitMessages(messages, options) {
+  const enc = options.model ? encoding_for_model(options.model) : get_encoding("cl100k_base");
+  const MESSAGE_OVERHEAD = 4;
+  try {
+    const tokenizer = (text) => enc.encode(text).length;
+    const items = messages.map((msg, i) => ({
+      id: String(i),
+      content: msg,
+      tokens: tokenizer(messageToText(msg)) + MESSAGE_OVERHEAD,
+      // system = highest priority; others prioritised by recency
+      priority: msg.role === "system" ? 1e4 : i
+    }));
+    const result = fit(items, {
+      budget: options.budget,
+      reserve: options.reserve,
+      suppressApproximationWarning: true
+    });
+    return {
+      messages: result.included.map((i) => i.content),
+      tokensUsed: result.tokensUsed,
+      tokensRemaining: result.tokensRemaining,
+      dropped: result.excluded.map((i) => i.content)
+    };
+  } finally {
+    enc.free();
+  }
+}
+export {
+  fitMessages
+};

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@jeremysnr/snug-openai",
+  "version": "0.1.0",
+  "description": "snug for the OpenAI SDK. Fit chat messages into a token budget, ready to pass to client.chat.completions.create.",
+  "keywords": ["llm", "tokens", "context-window", "openai", "gpt"],
+  "license": "MIT",
+  "author": "Jeremy Smith",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JeremySNR/snug-openai.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"
+  },
+  "dependencies": {
+    "@jeremysnr/snug": "^0.1.0",
+    "tiktoken": "^1.0.22"
+  },
+  "peerDependencies": {
+    "openai": ">=4.0.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.14.0",
+    "jest": "^29.7.0",
+    "openai": "^4.0.0",
+    "ts-jest": "^29.1.5",
+    "tsup": "^8.5.1",
+    "typescript": "^5.5.0"
+  }
+}