@wukazis/euphony 0.1.45

package/lib/types/harmony-types.d.ts

@@ -0,0 +1,72 @@
+export interface Conversation {
+    id?: string | null;
+    messages: Message[];
+    create_time?: number | null;
+    metadata?: Record<string, unknown>;
+}
+export interface Message {
+    id?: string | null;
+    role: Role;
+    name?: string | null;
+    create_time?: number | null;
+    metadata?: Record<string, unknown>;
+    content: MessageContent[] | string;
+    channel?: string | null;
+    recipient?: string | null;
+    content_type?: string | null;
+}
+export declare enum Role {
+    User = "user",
+    Assistant = "assistant",
+    System = "system",
+    Developer = "developer",
+    Tool = "tool"
+}
+export declare enum RealAuthor {
+    ToolWeb = "tool:web"
+}
+export interface Author {
+    role: Role;
+    name?: string | null;
+}
+export type MessageContent = TextMessageContent | CodeMessageContent | SystemContentMessageContent | DeveloperContentMessageContent;
+export declare const EUPHONY_MESSAGE_CONTENT_TYPES: readonly ["code", "developer", "system", "text"];
+export type EuphonyMessageContentType = (typeof EUPHONY_MESSAGE_CONTENT_TYPES)[number];
+export interface TextMessageContent {
+    text: string;
+}
+export interface CodeMessageContent {
+    content_type: 'code';
+    text: string;
+    language?: string | null;
+}
+export type ReasoningEffort = 'Low' | 'Medium' | 'High';
+export interface ChannelConfig {
+    valid_channels: string[];
+    channel_required: boolean;
+}
+export interface ToolDescription {
+    name: string;
+    description: string;
+    parameters?: Record<string, unknown> | null;
+}
+export interface ToolNamespaceConfig {
+    name: string;
+    description?: string | null;
+    tools: ToolDescription[];
+}
+export interface SystemContentMessageContent {
+    model_identity?: string | null;
+    reasoning_effort?: ReasoningEffort | null;
+    conversation_start_date?: string | null;
+    knowledge_cutoff?: string | null;
+    channel_config?: ChannelConfig | null;
+    tools?: Record<string, ToolNamespaceConfig> | null;
+}
+export interface DeveloperContentMessageContent {
+    instructions?: string | null;
+    tools?: Record<string, ToolNamespaceConfig> | null;
+}
+export declare const getContentTypeFromContent: (content: MessageContent[] | string) => EuphonyMessageContentType;
+export declare const tryGetContentTypeFromContent: (content: MessageContent[] | string) => EuphonyMessageContentType | null;
+export declare const getContentFromContentOrString: (content: MessageContent[] | string) => MessageContent;

package/lib/utils/api-manager.d.ts

@@ -0,0 +1,42 @@
+import { BlobJSONLPayload, HarmonyRenderResponse } from '../types/common-types';
+import { Conversation } from '../types/harmony-types';
+export declare let EUPHONY_API_URL: string;
+export declare const extractConversationFromJSONL: (data: unknown[]) => Conversation[] | null;
+export declare class APIManager {
+    apiBaseURL: string;
+    constructor(apiBaseURL: string);
+    getJSONL: ({ blobURL, offset, limit, noCache, jmespathQuery }: {
+        blobURL: string;
+        offset: number;
+        limit: number;
+        noCache: boolean;
+        jmespathQuery: string;
+    }) => Promise<BlobJSONLPayload>;
+    refreshRendererList: () => Promise<string[]>;
+    harmonyRender: (conversation: string, renderer: string) => Promise<HarmonyRenderResponse>;
+}
+export declare class BrowserAPIManager {
+    getJSONL: ({ blobURL, offset, limit, noCache, jmespathQuery }: {
+        blobURL: string;
+        offset: number;
+        limit: number;
+        noCache: boolean;
+        jmespathQuery: string;
+    }) => Promise<BlobJSONLPayload>;
+    validateOpenAIAPIKey(apiKey: string): Promise<boolean>;
+    /**
+     * Translates the given text using the OpenAI API directly from browser with a
+     * custom API key.
+     * @param text The text to translate.
+     * @param apiKey The OpenAI API key to use for the request.
+     * @returns A promise resolving to the translation result.
+     */
+    translateTextWithOpenAI(text: string, apiKey: string): Promise<{
+        translation: string;
+        is_translated: boolean;
+        language: string;
+        has_command: boolean;
+    }>;
+    refreshRendererList: () => string[];
+    harmonyRender: (conversation: string, renderer: string) => Promise<HarmonyRenderResponse>;
+}

package/lib/utils/codex-session.d.ts

@@ -0,0 +1,7 @@
+import { Conversation } from '../types/harmony-types';
+export interface CodexSessionParseResult {
+    conversation: Conversation;
+    customLabels: string[][];
+}
+export declare const isCodexSessionJSONL: (raw: unknown[]) => boolean;
+export declare const parseCodexSession: (raw: unknown[]) => CodexSessionParseResult | null;

package/lib/utils/dompurify-configs.d.ts

@@ -0,0 +1,2 @@
+export declare const allowedTags: string[];
+export declare const allowedAttributes: string[];

package/lib/utils/harmony-render.d.ts

@@ -0,0 +1,4 @@
+import { HarmonyRenderResponse } from '../types/common-types';
+export declare const HARMONY_RENDERER_NAME = "o200k_harmony";
+export declare const renderHarmonyConversationForDisplay: (conversationJSON: string) => string;
+export declare const renderHarmonyConversationInBrowser: (conversation: string, renderer: string) => HarmonyRenderResponse;

package/lib/utils/marked-katex-extension.d.ts

@@ -0,0 +1,22 @@
+export interface MarkedKatexOptions {
+    nonStandard?: boolean;
+    [key: string]: unknown;
+}
+interface Token {
+    text: string;
+    displayMode: boolean;
+}
+export default function (options?: MarkedKatexOptions): {
+    extensions: {
+        name: string;
+        level: string;
+        tokenizer(src: string): {
+            type: string;
+            raw: string;
+            text: string;
+            displayMode: boolean;
+        } | undefined;
+        renderer: (token: Token) => string;
+    }[];
+};
+export {};

package/lib/utils/patch-preview.d.ts

@@ -0,0 +1,2 @@
+import { TemplateResult } from 'lit';
+export declare function renderPatchPreview(text: string): TemplateResult | null;

package/lib/utils/utils.d.ts

@@ -0,0 +1,80 @@
+import { LitElement, TemplateResult } from 'lit';
+import { BlockContent } from '../types/common-types';
+import { Conversation } from '../types/harmony-types';
+/**
+ * Updates the position and appearance of a popper overlay tooltip.
+ * @param tooltip - The tooltip element.
+ * @param anchor - The anchor element to which the tooltip is attached.
+ * @param placement - The placement of the tooltip relative to the anchor
+ *  ('bottom', 'left', 'top', 'right').
+ * @param withArrow - Indicates whether the tooltip should have an arrow.
+ * @param offsetAmount - The offset amount in pixels.
+ * @param maxWidth - The maximum width of the tooltip in pixels (optional).
+ */
+export declare const updatePopperOverlay: (tooltip: HTMLElement, anchor: HTMLElement, placement: "bottom" | "left" | "top" | "right", withArrow: boolean, offsetAmount?: number, maxWidth?: number) => void;
+/**
+ * Updates the position of a floating element relative to an anchor element.
+ * @param floatingElement - The floating element to be positioned.
+ * @param anchor - The anchor element to which the floating element is attached.
+ * @param placement - The placement of the floating element relative to the
+ *  anchor ('bottom', 'left', 'top', 'right').
+ * @param offsetAmount - The y offset amount in pixels.
+ */
+export declare const updateFloatPosition: (anchor: HTMLElement, floatingElement: HTMLElement, placement: "bottom" | "left" | "top" | "right", offsetAmount?: number) => void;
+/**
+ * Generates an HTML template from a markdown string.
+ *
+ * @param content - The markdown content to be rendered.
+ * @param shouldRenderMarkdown - Whether to render the content as markdown.
+ * @returns The HTML template generated from the markdown content.
+ */
+export declare const getMarkdownTemplate: (content: string, shouldRenderMarkdown: boolean, markdownAllowedTags: string[] | null, markdownAllowedAttributes: string[] | null) => TemplateResult<1>;
+/**
+ * Creates a deferred promise that will be automatically rejected if not
+ * resolved within the specified wait time.
+ *
+ * @template T - The type of the value that the promise resolves with.
+ * @param waitTime - The time in milliseconds to wait before automatically
+ * rejecting the promise.
+ * @returns An object containing the promise, and wrapped resolve and reject
+ * functions.
+ */
+export declare const getDeferredPromise: <T>(waitTime: number) => {
+    promise: Promise<T>;
+    resolve: (value: T) => void;
+    reject: (reason?: unknown) => void;
+};
+/**
+ * Converts a Blob to a base64 string.
+ * @param blob - The Blob to convert.
+ * @returns A promise that resolves to the base64 string.
+ */
+export declare const blobToBase64: (blob: Blob) => Promise<string>;
+/**
+ * Digests a message using SHA-256.
+ * @param message - The message to digest.
+ * @returns A promise that resolves to the digest of the message.
+ */
+export declare const digestMessage: (message: string) => Promise<string>;
+/**
+ * Converts a style object to a string.
+ * @param styles - The style object to convert.
+ * @returns The style string.
+ */
+export declare const styleToString: (styles: Record<string, string>) => string;
+export declare const arrayToTable: (data: unknown[][]) => TemplateResult;
+/**
+ * Get custom convo labels and message labels from magic metadata field
+ * @param conversation - The conversation to get custom labels from
+ * @returns The custom labels
+ */
+export declare const getCustomLabelsFromMagicMetadata: (conversation: Conversation) => {
+    customLabels: string[][];
+    customMessageLabels: ([string | number, string] | [string | number, string, string] | [string | number, string, string, string])[];
+};
+export declare class EuphonyLitElementWithBlockContents extends LitElement {
+    blockContents: BlockContent[];
+}
+export declare const sharedExpandBlockContents: (element: LitElement | EuphonyLitElementWithBlockContents) => void;
+export declare const sharedCollapseBlockContents: (element: LitElement | EuphonyLitElementWithBlockContents) => void;
+export declare const createBase64DataURL: (mimeType: string, dataBase64: string) => string;

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@wukazis/euphony",
+  "private": false,
+  "version": "0.1.45",
+  "type": "module",
+  "types": "./lib/euphony.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/euphony.d.ts",
+        "default": "./lib/euphony.js"
+      }
+    }
+  },
+  "bin": {
+    "euphony": "bin/euphony.js"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "server-dist",
+    "lib",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "dev": "vite --port 3000",
+    "build": "tsc && tsc -p tsconfig.server.json && vite build && vite build --mode server && vite build --mode library",
+    "build:app": "tsc && tsc -p tsconfig.server.json && vite build && vite build --mode server",
+    "build:frontend": "tsc && vite build",
+    "build:frontend-only": "tsc && VITE_EUPHONY_FRONTEND_ONLY=true vite build",
+    "build:github": "tsc && VITE_EUPHONY_FRONTEND_ONLY=true vite build --mode github",
+    "build:library": "tsc && vite build --mode library",
+    "build:server": "tsc -p tsconfig.server.json && vite build --mode server",
+    "start": "node server-dist/node-main.js",
+    "deploy:github": "pnpm run build:github && pnpm gh-pages -m \"Deploy $(git log '--format=format:%H' main -1)\" -d ./dist",
+    "deploy": "pnpm run deploy:github",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "gpt-tokenizer": "^3.4.0",
+    "jmespath": "^0.16.0"
+  },
+  "devDependencies": {
+    "@datastructures-js/priority-queue": "^6.3.5",
+    "@floating-ui/dom": "^1.7.6",
+    "@shoelace-style/shoelace": "^2.20.1",
+    "@types/d3-format": "^3.0.4",
+    "@types/jmespath": "^0.15.2",
+    "@types/node": "^25.9.1",
+    "@types/prismjs": "1.26.6",
+    "@typescript-eslint/eslint-plugin": "8.58.2",
+    "@xiaohk/utils": "^0.1.0",
+    "async-mutex": "^0.5.0",
+    "d3-format": "^3.1.2",
+    "dompurify": "^3.4.0",
+    "eslint": "^9.39.4",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-lit": "^2.2.1",
+    "eslint-plugin-prettier": "^5.5.5",
+    "eslint-plugin-wc": "^3.1.0",
+    "gh-pages": "^6.3.0",
+    "globals": "^16.5.0",
+    "globby": "^14.1.0",
+    "lit": "^3.3.2",
+    "marked": "^15.0.12",
+    "prettier": "^3.8.3",
+    "prismjs": "^1.30.0",
+    "terser": "5.46.1",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "8.58.2",
+    "vite": "^7.3.2",
+    "vite-plugin-dts": "^4.5.4",
+    "vite-plugin-web-components-hmr": "^0.1.3"
+  },
+  "packageManager": "pnpm@10.25.0+sha512.5e82639027af37cf832061bcc6d639c219634488e0f2baebe785028a793de7b525ffcd3f7ff574f5e9860654e098fe852ba8ac5dd5cefe1767d23a020a92f501"
+}