@ag-ui/encoder 0.0.27 → 0.0.28-alpha.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ag-ui/encoder",
   "author": "Markus Ecker <markus.ecker@gmail.com>",
-  "version": "0.0.27",
+  "version": "0.0.28-alpha.0",
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -10,8 +10,8 @@
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@ag-ui/core": "0.0.27",
-    "@ag-ui/proto": "0.0.27"
+    "@ag-ui/core": "0.0.28-alpha.0",
+    "@ag-ui/proto": "0.0.28-alpha.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.12",

package/.turbo/turbo-build.log

@@ -1,23 +0,0 @@
-
-
-> @ag-ui/encoder@0.0.27 build /Users/mme/Code/ag-ui-protocol/typescript-sdk/packages/encoder
-> tsup
-
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v8.4.0
-CLI Using tsup config: /Users/mme/Code/ag-ui-protocol/typescript-sdk/packages/encoder/tsup.config.ts
-CLI Target: es2017
-CLI Cleaning output folder
-CJS Build start
-ESM Build start
-CJS dist/index.js     7.09 KB
-CJS dist/index.js.map 13.37 KB
-CJS ⚡️ Build success in 8ms
-ESM dist/index.mjs     5.49 KB
-ESM dist/index.mjs.map 13.34 KB
-ESM ⚡️ Build success in 8ms
-DTS Build start
-DTS ⚡️ Build success in 652ms
-DTS dist/index.d.ts  540.00 B
-DTS dist/index.d.mts 540.00 B

package/jest.config.js

@@ -1,6 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-  preset: "ts-jest",
-  testEnvironment: "node",
-  testMatch: ["**/*.test.ts"],
-};

package/src/__tests__/encoder.test.ts

@@ -1,101 +0,0 @@
-import { EventEncoder } from "../encoder";
-import { BaseEvent, EventType, TextMessageStartEvent } from "@ag-ui/core";
-import * as proto from "@ag-ui/proto";
-
-describe("Encoder Tests", () => {
-  // Create a valid TextMessageStartEvent event
-  const testEvent: TextMessageStartEvent = {
-    type: EventType.TEXT_MESSAGE_START,
-    timestamp: 123456789,
-    messageId: "msg123",
-    role: "assistant",
-  };
-
-  describe("encodeBinary method", () => {
-    it("should return protobuf encoded data when accept header includes protobuf media type", () => {
-      // Setup an encoder with protobuf accepted
-      const encoder = new EventEncoder({
-        accept: `text/event-stream, ${proto.AGUI_MEDIA_TYPE}`,
-      });
-
-      // Get the binary encoding
-      const result = encoder.encodeBinary(testEvent);
-
-      // Verify it's a Uint8Array
-      expect(result).toBeInstanceOf(Uint8Array);
-
-      // A protobuf message should start with 4 bytes for length followed by the message
-      // So the length should be greater than 4 at minimum
-      expect(result.length).toBeGreaterThan(4);
-
-      // The first 4 bytes should be a uint32 representing the message length
-      const dataView = new DataView(result.buffer);
-      const messageLength = dataView.getUint32(0, false); // false for big-endian
-
-      // The actual message should match the length specified in the header
-      expect(result.length - 4).toBe(messageLength);
-    });
-
-    it("should return SSE encoded data when accept header doesn't include protobuf media type", () => {
-      // Setup an encoder without protobuf accepted
-      const encoder = new EventEncoder({
-        accept: "text/event-stream",
-      });
-
-      // Get the binary encoding
-      const result = encoder.encodeBinary(testEvent);
-
-      // Verify it's a Uint8Array
-      expect(result).toBeInstanceOf(Uint8Array);
-
-      // Convert back to string to verify it's SSE format
-      const decoder = new TextDecoder();
-      const resultString = decoder.decode(result);
-
-      // Should match the SSE format with the expected JSON
-      expect(resultString).toBe(`data: ${JSON.stringify(testEvent)}\n\n`);
-    });
-
-    it("should return SSE encoded data when no accept header is provided", () => {
-      // Setup an encoder without any accept header
-      const encoder = new EventEncoder();
-
-      // Get the binary encoding
-      const result = encoder.encodeBinary(testEvent);
-
-      // Verify it's a Uint8Array
-      expect(result).toBeInstanceOf(Uint8Array);
-
-      // Convert back to string to verify it's SSE format
-      const decoder = new TextDecoder();
-      const resultString = decoder.decode(result);
-
-      // Should match the SSE format with the expected JSON
-      expect(resultString).toBe(`data: ${JSON.stringify(testEvent)}\n\n`);
-    });
-  });
-
-  describe("encodeProtobuf method", () => {
-    it("should encode event as protobuf with length prefix", () => {
-      const encoder = new EventEncoder();
-
-      const result = encoder.encodeProtobuf(testEvent);
-
-      // Verify it's a Uint8Array
-      expect(result).toBeInstanceOf(Uint8Array);
-
-      // A protobuf message should start with 4 bytes for length followed by the message
-      expect(result.length).toBeGreaterThan(4);
-
-      // The first 4 bytes should be a uint32 representing the message length
-      const dataView = new DataView(result.buffer);
-      const messageLength = dataView.getUint32(0, false); // false for big-endian
-
-      // The actual message should match the length specified in the header
-      expect(result.length - 4).toBe(messageLength);
-
-      // The message length should be greater than zero
-      expect(messageLength).toBeGreaterThan(0);
-    });
-  });
-});

package/src/encoder.ts

@@ -1,69 +0,0 @@
-import { BaseEvent } from "@ag-ui/core";
-import * as proto from "@ag-ui/proto";
-import { preferredMediaTypes } from "./media-type";
-
-export interface EventEncoderParams {
-  accept?: string;
-}
-
-export class EventEncoder {
-  private acceptsProtobuf: boolean;
-
-  constructor(params?: EventEncoderParams) {
-    this.acceptsProtobuf = params?.accept ? this.isProtobufAccepted(params.accept) : false;
-  }
-
-  getContentType(): string {
-    if (this.acceptsProtobuf) {
-      return proto.AGUI_MEDIA_TYPE;
-    } else {
-      return "text/event-stream";
-    }
-  }
-
-  encode(event: BaseEvent): string {
-    return this.encodeSSE(event);
-  }
-
-  encodeSSE(event: BaseEvent): string {
-    return `data: ${JSON.stringify(event)}\n\n`;
-  }
-
-  encodeBinary(event: BaseEvent): Uint8Array {
-    if (this.acceptsProtobuf) {
-      return this.encodeProtobuf(event);
-    } else {
-      const sseString = this.encodeSSE(event);
-      // Convert string to Uint8Array using TextEncoder
-      const encoder = new TextEncoder();
-      return encoder.encode(sseString);
-    }
-  }
-
-  encodeProtobuf(event: BaseEvent): Uint8Array {
-    const messageBytes = proto.encode(event);
-    const length = messageBytes.length;
-
-    // Create a buffer for 4 bytes (for the uint32 length) plus the message bytes
-    const buffer = new ArrayBuffer(4 + length);
-    const dataView = new DataView(buffer);
-
-    // Write the length as a uint32
-    // Set the third parameter to `false` for big-endian or `true` for little-endian
-    dataView.setUint32(0, length, false);
-
-    // Create a Uint8Array view and copy in the message bytes after the 4-byte header
-    const result = new Uint8Array(buffer);
-    result.set(messageBytes, 4);
-
-    return result;
-  }
-
-  private isProtobufAccepted(acceptHeader: string): boolean {
-    // Pass the Accept header and an array with your media type
-    const preferred = preferredMediaTypes(acceptHeader, [proto.AGUI_MEDIA_TYPE]);
-
-    // If the returned array includes your media type, it's acceptable
-    return preferred.includes(proto.AGUI_MEDIA_TYPE);
-  }
-}

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from "./encoder";
-export { AGUI_MEDIA_TYPE } from "@ag-ui/proto";

package/src/media-type.ts

@@ -1,305 +0,0 @@
-/**
- * negotiator
- * Copyright(c) 2012 Isaac Z. Schlueter
- * Copyright(c) 2014 Federico Romero
- * Copyright(c) 2014-2015 Douglas Christopher Wilson
- * MIT Licensed
- */
-
-// modified from https://github.com/jshttp/negotiator/blob/master/lib/mediaType.js
-
-/**
- * Module exports.
- * @public
- */
-
-export function preferredMediaTypes(accept?: string, provided?: string[]): string[] {
-  // RFC 2616 sec 14.2: no header = */*
-  const accepts = parseAccept(accept === undefined ? "*/*" : accept || "");
-
-  if (!provided) {
-    // sorted list of all types
-    return accepts
-      .filter((spec): spec is MediaType => spec.q > 0)
-      .sort((a, b) => {
-        return b.q - a.q || b.i - a.i || 0;
-      })
-      .map(getFullType);
-  }
-
-  const priorities = provided.map(function getPriority(type: string, index: number) {
-    return getMediaTypePriority(type, accepts, index);
-  });
-
-  // sorted list of accepted types
-  return priorities
-    .filter((spec): spec is Priority => spec.q > 0)
-    .sort(compareSpecs)
-    .map(function getType(priority: Priority) {
-      return provided[priorities.indexOf(priority)];
-    });
-}
-
-/**
- * Module variables.
- * @private
- */
-
-const simpleMediaTypeRegExp = /^\s*([^\s\/;]+)\/([^;\s]+)\s*(?:;(.*))?$/;
-
-/**
- * Media type interface
- * @private
- */
-interface MediaType {
-  type: string;
-  subtype: string;
-  params: Record<string, string>;
-  q: number;
-  i: number;
-}
-
-/**
- * Priority interface
- * @private
- */
-interface Priority {
-  o: number;
-  q: number;
-  s: number;
-  i?: number;
-}
-
-/**
- * Parse the Accept header.
- * @private
- */
-function parseAccept(accept: string): MediaType[] {
-  const accepts = splitMediaTypes(accept);
-  const result: MediaType[] = [];
-
-  for (let i = 0, j = 0; i < accepts.length; i++) {
-    const mediaType = parseMediaType(accepts[i].trim(), i);
-
-    if (mediaType) {
-      result[j++] = mediaType;
-    }
-  }
-
-  return result;
-}
-
-/**
- * Parse a media type from the Accept header.
- * @private
- */
-function parseMediaType(str: string, i: number): MediaType | null {
-  const match = simpleMediaTypeRegExp.exec(str);
-  if (!match) return null;
-
-  const params: Record<string, string> = Object.create(null);
-  let q = 1;
-  const subtype = match[2];
-  const type = match[1];
-
-  if (match[3]) {
-    const kvps = splitParameters(match[3]).map(splitKeyValuePair);
-
-    for (let j = 0; j < kvps.length; j++) {
-      const pair = kvps[j];
-      const key = pair[0].toLowerCase();
-      const val = pair[1];
-
-      // get the value, unwrapping quotes
-      const value = val && val[0] === '"' && val[val.length - 1] === '"' ? val.slice(1, -1) : val;
-
-      if (key === "q") {
-        q = parseFloat(value);
-        break;
-      }
-
-      // store parameter
-      params[key] = value;
-    }
-  }
-
-  return {
-    type: type,
-    subtype: subtype,
-    params: params,
-    q: q,
-    i: i,
-  };
-}
-
-/**
- * Get the priority of a media type.
- * @private
- */
-function getMediaTypePriority(type: string, accepted: MediaType[], index: number): Priority {
-  const priority: Priority = { o: -1, q: 0, s: 0 };
-
-  for (let i = 0; i < accepted.length; i++) {
-    const spec = specify(type, accepted[i], index);
-
-    if (spec && (priority.s - spec.s || priority.q - spec.q || priority.o - spec.o) < 0) {
-      priority.o = spec.o;
-      priority.q = spec.q;
-      priority.s = spec.s;
-      priority.i = spec.i;
-    }
-  }
-
-  return priority;
-}
-
-/**
- * Get the specificity of the media type.
- * @private
- */
-function specify(type: string, spec: MediaType, index: number): Priority | null {
-  const p = parseMediaType(type, 0);
-  let s = 0;
-
-  if (!p) {
-    return null;
-  }
-
-  if (spec.type.toLowerCase() == p.type.toLowerCase()) {
-    s |= 4;
-  } else if (spec.type != "*") {
-    return null;
-  }
-
-  if (spec.subtype.toLowerCase() == p.subtype.toLowerCase()) {
-    s |= 2;
-  } else if (spec.subtype != "*") {
-    return null;
-  }
-
-  const keys = Object.keys(spec.params);
-  if (keys.length > 0) {
-    if (
-      keys.every(function (k) {
-        return (
-          spec.params[k] == "*" ||
-          (spec.params[k] || "").toLowerCase() == (p.params[k] || "").toLowerCase()
-        );
-      })
-    ) {
-      s |= 1;
-    } else {
-      return null;
-    }
-  }
-
-  return {
-    i: index,
-    o: spec.i,
-    q: spec.q,
-    s: s,
-  };
-}
-
-/**
- * Compare two specs.
- * @private
- */
-function compareSpecs(a: Priority, b: Priority): number {
-  return b.q - a.q || b.s - a.s || (a.o || 0) - (b.o || 0) || (a.i || 0) - (b.i || 0) || 0;
-}
-
-/**
- * Get full type string.
- * @private
- */
-function getFullType(spec: MediaType): string {
-  return spec.type + "/" + spec.subtype;
-}
-
-/**
- * Check if a spec has any quality.
- * @private
- */
-function isQuality(spec: Priority | MediaType): boolean {
-  return spec.q > 0;
-}
-
-/**
- * Count the number of quotes in a string.
- * @private
- */
-function quoteCount(string: string): number {
-  let count = 0;
-  let index = 0;
-
-  while ((index = string.indexOf('"', index)) !== -1) {
-    count++;
-    index++;
-  }
-
-  return count;
-}
-
-/**
- * Split a key value pair.
- * @private
- */
-function splitKeyValuePair(str: string): [string, string] {
-  const index = str.indexOf("=");
-  let key: string;
-  let val: string = "";
-
-  if (index === -1) {
-    key = str;
-  } else {
-    key = str.slice(0, index);
-    val = str.slice(index + 1);
-  }
-
-  return [key, val];
-}
-
-/**
- * Split an Accept header into media types.
- * @private
- */
-function splitMediaTypes(accept: string): string[] {
-  const accepts = accept.split(",");
-  const result: string[] = [accepts[0]];
-
-  for (let i = 1, j = 0; i < accepts.length; i++) {
-    if (quoteCount(result[j]) % 2 == 0) {
-      result[++j] = accepts[i];
-    } else {
-      result[j] += "," + accepts[i];
-    }
-  }
-
-  // trim result
-  return result;
-}
-
-/**
- * Split a string of parameters.
- * @private
- */
-function splitParameters(str: string): string[] {
-  const parameters = str.split(";");
-  const result: string[] = [parameters[0]];
-
-  for (let i = 1, j = 0; i < parameters.length; i++) {
-    if (quoteCount(result[j]) % 2 == 0) {
-      result[++j] = parameters[i];
-    } else {
-      result[j] += ";" + parameters[i];
-    }
-  }
-
-  // trim parameters
-  for (let i = 0; i < result.length; i++) {
-    result[i] = result[i].trim();
-  }
-
-  return result;
-}

package/tsconfig.json

@@ -1,23 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2017",
-    "module": "esnext",
-    "lib": ["dom", "dom.iterable", "esnext"],
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "moduleResolution": "node",
-    "skipLibCheck": true,
-    "strict": true,
-    "jsx": "react-jsx",
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "baseUrl": ".",
-    "paths": {
-      "@/*": ["./src/*"]
-    }
-  },
-  "include": ["src"],
-  "exclude": ["node_modules", "dist"]
-}

package/tsup.config.ts

@@ -1,10 +0,0 @@
-import { defineConfig } from "tsup";
-
-export default defineConfig({
-  entry: ["src/index.ts"],
-  format: ["cjs", "esm"],
-  dts: true,
-  splitting: false,
-  sourcemap: true,
-  clean: true,
-});