llaminate 0.1.0

package/scripts/prebuild.js

@@ -0,0 +1,43 @@
+const fs = require('fs');
+const path = require('path');
+
+// Define source and destination paths, package information, and files to copy
+
+const src = path.join(__dirname, "../src");
+const dist = path.join(__dirname, "../dist");
+
+const package = require("../package.json");
+const files = ["config.schema.json", "system.hbs"];
+
+// Ensure the dist directory exists
+
+console.log('Preparing the dist directory.');
+
+if (fs.existsSync(dist)) {
+  fs.rmSync(dist, { recursive: true, force: true });
+}
+fs.mkdirSync(dist);
+
+// Generate build-info.json
+
+console.log("Generating build-info.json.");
+
+const build = {
+  name: package.name,
+  version: package.version,
+  date: new Date().toISOString(),
+};
+
+fs.writeFileSync(
+  path.join(dist, "build-info.json"),
+  JSON.stringify(build, null, 2)
+);
+
+// Copy config.schema.json to dist directory
+
+console.log("Copying files to dist directory:");
+
+files.forEach(file => {
+  fs.copyFileSync(path.join(src, file), path.join(dist, file));
+  console.log(`  - ${file}`);
+});

package/scripts/prepare.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+# Remove development files not to be packed or published.
+echo "Removing development files not to be packed or published."
+rm .env
+rm tests/jest.config.json
+rm tests/scratch.*
+
+# Build the package.
+echo "Building the package."
+npm run build

package/scripts/pretest.js

@@ -0,0 +1,14 @@
+const fs = require("fs");
+const dotenvx = require('@dotenvx/dotenvx');
+dotenvx.config();
+
+const jestConfig = {
+    displayName: `${process.env.TEST_MODEL} @ ${process.env.TEST_ENDPOINT}`,
+    "silent": true,
+    "setupFiles": ["@dotenvx/dotenvx/config"],
+    "testTimeout": 3600000,
+    "openHandlesTimeout": 3600000,
+    "passWithNoTests": true
+};
+
+fs.writeFileSync("./tests/jest.config.json", JSON.stringify(jestConfig, null, 2));

package/src/config.schema.json

@@ -0,0 +1,126 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "properties": {
+        "endpoint": { "type": "string" },
+        "key": { "type": "string" },
+        "model": { "type": "string" },
+        "schema": {
+            "type": "object",
+            "properties": {
+                "type": { "type": "string" },
+                "properties": { "type": "object" },
+                "required": { "type": "array", "items": { "type": "string" } }
+            },
+            "additionalProperties": true
+        },
+        "system": {
+            "type": "array",
+            "items": { "type": "string" }
+        },
+        "history": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "role": { "type": "string", "enum": ["user", "assistant", "system", "tool", "developer"] },
+                    "content": {},
+                    "name": { "type": "string" },
+                    "tool_calls": { "type": "array" },
+                    "tool_call_id": { "type": "string" }
+                },
+                "required": ["role", "content"],
+                "additionalProperties": true
+            }
+        },
+        "attachments": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "type": { "type": "string" },
+                    "url": { "type": "string" }
+                },
+                "required": ["type", "url"]
+            }
+        },
+        "window": {
+            "type": "integer",
+            "minimum": 1
+        },
+        "tools": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "function": {
+                        "type": "object",
+                        "properties": {
+                            "name": { "type": "string" },
+                            "description": { "type": "string" },
+                            "parameters": { "type": "object" },
+                            "strict": { "type": "boolean" }
+                        },
+                        "required": ["name"]
+                    },
+                    "handler": { "not": { "type": "null" } }
+                },
+                "required": ["function"]
+            }
+        },
+        "handler": { "not": { "type": "null" } },
+        "options": {
+            "type": "object",
+            "additionalProperties": true
+        },
+        "headers": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "rpm": {
+            "type": "integer",
+            "minimum": 1
+        },
+        "quirks": {
+            "type": "object",
+            "properties": {
+                "attachments": {
+                    "type": "object",
+                    "properties": {
+                        "document_url": { "type": "string", "enum": ["image_url"] },
+                        "file": { "type": "boolean" },
+                        "source": { "type": "boolean" }
+                    },
+                    "additionalProperties": true
+                },
+                "input_schema": { "type": "boolean" },
+                "json_schema": { "type": "boolean" },
+                "max_tokens": { "type": "integer", "minimum": 1 },
+                "output_config": { "type": "boolean" },
+                "role": {
+                    "type": "object",
+                    "properties": {
+                        "system": { "type": "boolean" },
+                        "tool": { "type": "boolean" }
+                    },
+                    "additionalProperties": true
+                },
+                "stream_options": { "type": "boolean" },
+                "tools": {
+                    "type": "object",
+                    "properties": {
+                        "json_schema": { "type": "boolean" },
+                        "json_object": { "type": "boolean" }
+                    },
+                    "additionalProperties": true
+                }
+            },
+            "additionalProperties": true
+        },
+        "fetch": { "not": { "type": "null" } }
+    },
+    "required": ["endpoint", "key", "model"],
+    "additionalProperties": false
+}

package/src/llaminate.d.ts

@@ -0,0 +1,99 @@
+// PUBLIC INTERFACES
+
+interface LlaminateConfig {
+    endpoint: string;
+    key: string;
+    model?: string;
+    schema?: Record<string, any>;
+    system?: string[];
+    tools?: Tool[];
+    attachments?: URLAttachment[];
+    window?: number;
+    headers?: Record<string, string>;
+    options?: Record<string, any>;
+    rpm?: number;
+    history?: LlaminateMessage[];
+    fetch?: (endpoint: string, options: Record<string, any>) => Promise<Response>;
+    handler?: (name: string, args: Record<string, any>) => Promise<any>;
+    quirks?: LlaminateQuirks;
+}
+
+interface LlaminateResponse {
+    message: string | any;
+    result: LlaminateMessage[];
+    tokens: Tokens;
+    uuid: string;
+}
+
+interface LlaminateMessage {
+    role: "assistant" | "developer" | "system" | "user" | "tool";
+    content?: string | any; // Content can be a string or any JSON-serializable object, especially for tool messages
+    name?: string; // For tool messages
+    tool_calls?: ToolCall[]; // For assistant messages with tool calls
+    tool_call_id?: string; // For tool messages to link back to the call
+}
+
+// SUBJECT TO CHANGE WITHOUT A MAJOR VERSION BUMP
+
+interface LlaminateQuirks {
+    attachments?: {
+        document_url?: "image_url";
+        file?: boolean;
+        source?: boolean;
+    },
+    json_schema?: boolean;
+    input_schema?: boolean;
+    max_tokens?: number;
+    output_config?: boolean;
+    parallel_tool_calls?: boolean;
+    role?: {
+        system?: boolean;
+        tool?: boolean;
+    };
+    stream_options?: boolean;
+    tools?: {
+        json_schema?: boolean;
+        json_object?: boolean;
+    };
+}
+
+// PRIVATE INTERFACES (USED INTERNALLY)
+
+interface Context {
+    messages: LlaminateMessage[];
+    result: LlaminateMessage[];
+    tools: Tool[];
+    subtotal: Tokens;
+    config: LlaminateConfig;
+    recurse: (messages: LlaminateMessage[], subtotal: Tokens) => AsyncGenerator<LlaminateResponse> | Promise<LlaminateResponse>;
+}
+
+interface Tool {
+    function: {
+        name: string;
+        description?: string;
+        parameters: Record<string, any>;
+        strict?: boolean;
+    };
+    handler?: (id: string, args: Record<string, any>) => Promise<any>;
+}
+
+interface ToolCall {
+    type: string;
+    function: {
+        name: string;
+        arguments: Record<string, any>;
+    }
+    id: string;
+}
+
+interface URLAttachment {
+    type: string;
+    url: string;
+}
+
+interface Tokens {
+    input: number;
+    output: number;
+    total: number;
+}