@theoremjs/web 0.0.0-stage → 0.3.4-next.375.ga2d1878

package/client/composer-drawer.d.ts

@@ -0,0 +1,19 @@
+import type { ComposerPendingMessage } from '@theoremjs/agents/interface';
+/** What waits in the composer, by kind; the UI words each kind. */
+export type ComposerDrawerKind = 'steer' | 'queue' | 'stash' | 'attached';
+/** Collapsed-drawer header: the total, then each waiting kind's count, in display order. */
+export type ComposerDrawerSummary = {
+    count: number;
+    parts: {
+        kind: ComposerDrawerKind;
+        n: number;
+    }[];
+};
+/**
+ * What's waiting in the composer, by kind: steering, queued, stashed, attached
+ * (files and voice notes). Null when nothing waits.
+ */
+export declare function composerDrawerSummary(args: {
+    pendingMessages: readonly Pick<ComposerPendingMessage, 'kind'>[];
+    attachmentCount: number;
+}): ComposerDrawerSummary | null;

package/client/composer-drawer.js

@@ -0,0 +1,15 @@
+/**
+ * What's waiting in the composer, by kind: steering, queued, stashed, attached
+ * (files and voice notes). Null when nothing waits.
+ */
+export function composerDrawerSummary(args) {
+    const countOf = (kind) => args.pendingMessages.filter((message) => message.kind === kind).length;
+    const parts = [
+        { kind: 'steer', n: countOf('steer') },
+        { kind: 'queue', n: countOf('queue') },
+        { kind: 'stash', n: countOf('stash') },
+        { kind: 'attached', n: args.attachmentCount },
+    ].filter((part) => part.n > 0);
+    const count = parts.reduce((sum, part) => sum + part.n, 0);
+    return count === 0 ? null : { count, parts };
+}

package/client/composer-hints.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Composer hints — ephemeral guidance about the current composer interaction
+ * (not pending-message state). Mirrors seance's `stash-selected-draft` hint.
+ */
+/** Stash shortcut in Astryx `Kbd` notation (`mod` is ⌘ on macOS, Ctrl elsewhere). */
+export declare const STASH_SHORTCUT = "mod+shift+s";
+/** Which hint applies, and its shortcut; the UI words it. */
+export type ComposerHint = {
+    id: 'stash-selected-draft';
+    shortcut: string;
+};
+/** Whether a keydown is the stash shortcut (⌘⇧S / Ctrl+Shift+S). */
+export declare function isStashShortcut(event: {
+    code: string;
+    metaKey: boolean;
+    ctrlKey: boolean;
+    shiftKey: boolean;
+    altKey: boolean;
+}): boolean;
+/** The stash hint — shown while the whole draft is selected in the focused input and it can be stashed. */
+export declare function resolveComposerHint(args: {
+    draftText: string;
+    selectedText: string;
+    canStash: boolean;
+}): ComposerHint | null;

package/client/composer-hints.js

@@ -0,0 +1,20 @@
+/**
+ * Composer hints — ephemeral guidance about the current composer interaction
+ * (not pending-message state). Mirrors seance's `stash-selected-draft` hint.
+ */
+/** Stash shortcut in Astryx `Kbd` notation (`mod` is ⌘ on macOS, Ctrl elsewhere). */
+export const STASH_SHORTCUT = 'mod+shift+s';
+/** Whether a keydown is the stash shortcut (⌘⇧S / Ctrl+Shift+S). */
+export function isStashShortcut(event) {
+    return (event.code === 'KeyS' && event.shiftKey && !event.altKey && (event.metaKey || event.ctrlKey));
+}
+/** The stash hint — shown while the whole draft is selected in the focused input and it can be stashed. */
+export function resolveComposerHint(args) {
+    const draft = args.draftText.trim();
+    if (!args.canStash || !draft || args.selectedText.trim() !== draft)
+        return null;
+    return {
+        id: 'stash-selected-draft',
+        shortcut: STASH_SHORTCUT,
+    };
+}

package/client/composer-primary.d.ts

@@ -0,0 +1,18 @@
+import { type ComposerMenuAction, type ComposerPrimaryAction, type ComposerProfileInterface, type ComposerRunPhase } from '@theoremjs/agents/interface';
+/** Whether the composer holds something to send: text that isn't blank, a file, or a voice note. */
+export declare function composerHasPayload(draftText: string, pendingFiles: readonly File[], pendingVoice: readonly File[]): boolean;
+export type ComposerActionState = {
+    primary: ComposerPrimaryAction;
+    menuActions: ComposerMenuAction[];
+    /** Send is off while recording, with nothing to act on, or with an empty draft to send or queue. */
+    primaryDisabled: boolean;
+};
+/** The composer's primary button and send menu for the current draft and run phase. */
+export declare function composerActionState(args: {
+    iface: ComposerProfileInterface;
+    phase: ComposerRunPhase;
+    draftText: string;
+    pendingFiles: readonly File[];
+    pendingVoice: readonly File[];
+    recording: boolean;
+}): ComposerActionState;

package/client/composer-primary.js

@@ -0,0 +1,29 @@
+import { resolveComposerMenuActions, resolveComposerPrimary, userDraftHasPayload, } from '@theoremjs/agents/interface';
+function fileSpecs(files) {
+    return files.map((file) => ({
+        name: file.name,
+        mimeType: file.type || 'application/octet-stream',
+        sizeBytes: file.size,
+    }));
+}
+/** Whether the composer holds something to send: text that isn't blank, a file, or a voice note. */
+export function composerHasPayload(draftText, pendingFiles, pendingVoice) {
+    return userDraftHasPayload({
+        ...(draftText.trim() ? { text: draftText } : {}),
+        ...(pendingFiles.length ? { attachments: fileSpecs(pendingFiles) } : {}),
+        ...(pendingVoice.length ? { voice: fileSpecs(pendingVoice) } : {}),
+    });
+}
+/** The composer's primary button and send menu for the current draft and run phase. */
+export function composerActionState(args) {
+    const allowSteering = 'allowSteering' in args.iface && Boolean(args.iface.allowSteering);
+    const hasPayload = composerHasPayload(args.draftText, args.pendingFiles, args.pendingVoice);
+    const context = { phase: args.phase, hasPayload, allowSteering };
+    const primary = resolveComposerPrimary(context);
+    const needsPayload = primary === 'send' || primary === 'queue';
+    return {
+        primary,
+        menuActions: resolveComposerMenuActions(context),
+        primaryDisabled: args.recording || primary === 'none' || (needsPayload && !hasPayload),
+    };
+}

package/client/decision-transport.d.ts

@@ -0,0 +1,70 @@
+/**
+ * The browser side of a decision profile: what the host lets the page see of
+ * it, and the one call that asks its questions about some state.
+ *
+ * @module
+ */
+import { type DecisionAsset, type DecisionJson, type DecisionProfile, type DecisionQuestion, type DecisionResult, type TraceRecord } from '@theoremjs/agents';
+import type { TraceFeed } from './trace-feed.ts';
+import { type HttpOptions } from './transport.ts';
+/** One question as the page sees it: its answer type and the names of its options or levels. Instructions stay on the host. */
+export type DecisionQuestionView = {
+    id: string;
+    type: DecisionQuestion['type'];
+    /** A choice's labels, a score's levels from 0 up; empty for a number. */
+    labels: string[];
+    /**
+     * A box's image: the one its question gives, a reference or a state field, else the field its
+     * instructions first name in backticks.
+     */
+    field?: string;
+};
+/** What a decision profile shows the page. */
+export type DecisionInterface = {
+    type: 'decision';
+    identity: {
+        handle: string;
+    };
+    contract: string;
+    maxStateBytes?: number;
+    questions: DecisionQuestionView[];
+    /** The host's own images, by the reference its questions write, sent with every decision. */
+    images?: Record<string, DecisionAsset>;
+    observability?: {
+        record: boolean;
+    };
+};
+/** The page's view of a decision profile, the questions its host asks, and the host's own images. */
+export declare function decisionInterface(profile: Pick<DecisionProfile, 'identity' | 'decision' | 'inputs' | 'observability'>, questions: Record<string, DecisionQuestion>, images?: Record<string, DecisionAsset>): DecisionInterface;
+/**
+ * The images a decision sends: the host's own and the page's. A page image may not take a name
+ * the host's use, so the questions always read the host's picture.
+ */
+export declare function decisionAssets(host: Record<string, DecisionAsset> | undefined, page: Record<string, DecisionAsset> | undefined): Record<string, DecisionAsset> | undefined;
+/** A decision's reply: the answers, and the trace records a host that delivers them sent back. */
+export type DecisionReply = {
+    result: DecisionResult;
+    traces?: TraceRecord[];
+};
+export interface DecisionTransport {
+    describe(signal?: AbortSignal): Promise<DecisionInterface>;
+    /** `assets` are the images the state names, by reference. */
+    decide(state: Exclude<DecisionJson, null>, signal?: AbortSignal, assets?: Record<string, DecisionAsset>): Promise<DecisionReply>;
+    /** Where the host's trace records land, for the inspector. */
+    traces?: TraceFeed;
+}
+/** Marks a decision's failure with the trace records it left, for the page's inspector. */
+export declare function withFailedTraces(err: unknown, traces: readonly TraceRecord[]): unknown;
+/** The trace records a failed decision left; none when its host sent none. */
+export declare function failedTraces(err: unknown): readonly TraceRecord[];
+export declare const failedDecisionTraces: typeof failedTraces;
+/** POSTs `body` and reads its reply with `read`; a failure keeps the trace records its body carried. */
+export declare function postWithTraces<Reply>(url: string, body: unknown, signal: AbortSignal | undefined, options: HttpOptions, read: (raw: unknown) => Reply): Promise<Reply>;
+/** POSTs a decision and reads its reply; a failure keeps the trace records its body carried. */
+export declare function postDecision(url: string, body: unknown, signal: AbortSignal | undefined, options?: HttpOptions): Promise<DecisionReply>;
+/** A host's decide reply, checked: the answers, and any trace records it delivers. */
+export declare function readDecisionReply(raw: unknown): DecisionReply;
+/** Transport for a host mounted with `createTheoremDecisionHandler`. Default endpoint `/api/decision`. */
+export declare function createDecisionTransport(options?: HttpOptions & {
+    endpoint?: string;
+}): DecisionTransport;

package/client/decision-transport.js

@@ -0,0 +1,175 @@
+/**
+ * The browser side of a decision profile: what the host lets the page see of
+ * it, and the one call that asks its questions about some state.
+ *
+ * @module
+ */
+import { resolveObservabilityPolicy, TheoremError, traceRecordSchema, z, } from '@theoremjs/agents';
+import { fetchJson } from "./transport.js";
+import { checkWire } from "./wire-line.js";
+/** A score level's name: its text, or the first text inside a structured entry. */
+function entryLabel(entry, fallback) {
+    if (typeof entry === 'string')
+        return entry;
+    const entries = Array.isArray(entry) ? entry : Object.keys(entry);
+    return entries.length ? entryLabel(entries[0], fallback) : fallback;
+}
+function withField(field) {
+    return field === undefined ? {} : { field };
+}
+/** The first field an entry names in backticks, as in "the mug in `photo`". */
+function namedField(entry) {
+    if (typeof entry === 'string')
+        return /\x60([^\x60\s]+)\x60/.exec(entry)?.[1];
+    const entries = Array.isArray(entry) ? entry : Object.values(entry);
+    for (const each of entries) {
+        const field = namedField(each);
+        if (field !== undefined)
+            return field;
+    }
+    return undefined;
+}
+/** The page's view of a decision profile, the questions its host asks, and the host's own images. */
+export function decisionInterface(profile, questions, images) {
+    return {
+        type: 'decision',
+        identity: { handle: profile.identity.handle },
+        contract: profile.decision.contract,
+        ...(profile.inputs.maxStateBytes === undefined
+            ? {}
+            : { maxStateBytes: profile.inputs.maxStateBytes }),
+        questions: Object.entries(questions).map(([id, question]) => ({
+            id,
+            type: question.type,
+            labels: question.type === 'choice'
+                ? Object.keys(question.criteria)
+                : question.type === 'score'
+                    ? question.criteria.map((entry, level) => entryLabel(entry, String(level)))
+                    : [],
+            ...(question.type === 'box'
+                ? withField(question.image ?? namedField(question.instructions))
+                : {}),
+        })),
+        ...(images && Object.keys(images).length > 0 ? { images } : {}),
+        ...(profile.observability
+            ? { observability: { record: resolveObservabilityPolicy(profile.observability).record } }
+            : {}),
+    };
+}
+/**
+ * The images a decision sends: the host's own and the page's. A page image may not take a name
+ * the host's use, so the questions always read the host's picture.
+ */
+export function decisionAssets(host, page) {
+    const clash = Object.keys(page ?? {}).find((name) => host && Object.hasOwn(host, name));
+    if (clash !== undefined)
+        // labels-exempt: internal diagnostic; the user reads error.request
+        throw new TheoremError('request', `the image ${clash} is the host's, so the page's needs another name`);
+    const all = { ...host, ...page };
+    return Object.keys(all).length > 0 ? all : undefined;
+}
+const probability = z.number().min(0).max(1);
+const probabilities = z
+    .record(z.string(), probability)
+    .refine((record) => Math.abs(Object.values(record).reduce((sum, value) => sum + value, 0) - 1) <= 0.001);
+const answerSchema = z.discriminatedUnion('type', [
+    z.object({
+        type: z.literal('choice'),
+        choice: z.string(),
+        confidence: probability,
+        probabilities,
+    }),
+    z.object({ type: z.literal('noul'), noul: probability }),
+    z.object({
+        type: z.literal('box'),
+        box: z.object({ top: probability, bottom: probability, left: probability, right: probability }),
+        confidence: probability,
+    }),
+    z.object({
+        type: z.literal('score'),
+        score: z.number().nonnegative(),
+        confidence: probability,
+        legend: z.record(z.string(), z.string().min(1)),
+        probabilities,
+    }),
+]);
+const replySchema = z.object({
+    result: z.object({
+        model: z.string().min(1),
+        answers: z.record(z.string(), answerSchema),
+        usage: z
+            .object({
+            inputTokens: z.number().int().nonnegative(),
+            outputTokens: z.number().int().nonnegative(),
+            costUsd: z.number().nonnegative().optional(),
+        })
+            .optional(),
+    }),
+    traces: z.array(traceRecordSchema).optional(),
+});
+/** The trace records a failed decision left, by the failure thrown for it. */
+const traceFailures = new WeakMap();
+/** Marks a decision's failure with the trace records it left, for the page's inspector. */
+export function withFailedTraces(err, traces) {
+    if (traces.length > 0 && typeof err === 'object' && err !== null)
+        traceFailures.set(err, traces);
+    return err;
+}
+/** The trace records a failed decision left; none when its host sent none. */
+export function failedTraces(err) {
+    return (typeof err === 'object' && err !== null && traceFailures.get(err)) || [];
+}
+export const failedDecisionTraces = failedTraces;
+const failedBody = z.object({ traces: z.array(traceRecordSchema) });
+/** POSTs `body` and reads its reply with `read`; a failure keeps the trace records its body carried. */
+export async function postWithTraces(url, body, signal, options, read) {
+    let traces = [];
+    const failed = (raw) => {
+        const parsed = failedBody.safeParse(raw);
+        if (parsed.success)
+            traces = parsed.data.traces;
+    };
+    try {
+        return read(await fetchJson(url, { body, signal, failed }, options));
+    }
+    catch (err) {
+        throw withFailedTraces(err, traces);
+    }
+}
+/** POSTs a decision and reads its reply; a failure keeps the trace records its body carried. */
+export function postDecision(url, body, signal, options = {}) {
+    return postWithTraces(url, body, signal, options, readDecisionReply);
+}
+/** A host's decide reply, checked: the answers, and any trace records it delivers. */
+export function readDecisionReply(raw) {
+    // labels-exempt: internal diagnostic; the user reads error.bad_response
+    return checkWire(replySchema, raw, 'the decision');
+}
+const describedSchema = z.object({
+    interface: z.object({
+        type: z.literal('decision'),
+        identity: z.object({ handle: z.string() }),
+        contract: z.string(),
+        maxStateBytes: z.number().optional(),
+        questions: z.array(z.object({
+            id: z.string(),
+            type: z.enum(['choice', 'noul', 'score', 'box']),
+            labels: z.array(z.string()),
+            field: z.string().optional(),
+        })),
+        images: z
+            .record(z.string(), z.object({ mimeType: z.enum(['image/png', 'image/jpeg']), data: z.string() }))
+            .optional(),
+        observability: z.object({ record: z.boolean() }).optional(),
+    }),
+});
+/** Transport for a host mounted with `createTheoremDecisionHandler`. Default endpoint `/api/decision`. */
+export function createDecisionTransport(options = {}) {
+    const base = (options.endpoint ?? '/api/decision').replace(/\/$/, '');
+    return {
+        async describe(signal) {
+            return checkWire(describedSchema, await fetchJson(base, { signal }, options), 'the decision description').interface;
+        },
+        decide: (state, signal, assets) => postDecision(`${base}/decide`, { state, ...(assets ? { assets } : {}) }, signal, options),
+    };
+}

package/client/decode-composer-draft.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Restore composer fields from a serializable pending `UserTurnDraft`.
+ */
+import type { UserTurnDraft } from '@theoremjs/agents/interface';
+export type ComposerDraftFields = {
+    text: string;
+    files: File[];
+    voice: File[];
+};
+/** Map an encoded pending draft back into live composer file fields. */
+export declare function composerFieldsFromDraft(draft: UserTurnDraft): ComposerDraftFields;

package/client/decode-composer-draft.js

@@ -0,0 +1,12 @@
+/**
+ * Restore composer fields from a serializable pending `UserTurnDraft`.
+ */
+import { pendingAttachmentsToFiles } from "./encode-files.js";
+/** Map an encoded pending draft back into live composer file fields. */
+export function composerFieldsFromDraft(draft) {
+    return {
+        text: draft.text ?? '',
+        files: pendingAttachmentsToFiles(draft.attachments ?? []),
+        voice: pendingAttachmentsToFiles(draft.voice ?? []),
+    };
+}

package/client/embedding-input.d.ts

@@ -0,0 +1,84 @@
+/**
+ * The rules behind an embedding console: the inputs as the JSON a request
+ * sends, text split into documents, documents packed into the requests the
+ * profile allows, all checked the way the kernel checks them, and documents
+ * ranked by how alike they point to a query.
+ *
+ * @module
+ */
+import { type EmbeddingInput, type EmbeddingPart, type EmbeddingUsage } from '@theoremjs/agents';
+import type { AttachmentValidationIssue } from '@theoremjs/agents/interface';
+import type { EmbeddingInterface } from './embedding-transport.ts';
+/** A part that is not text: a file sent inline, or one the provider already holds. */
+export type EmbeddingMediaPart = Exclude<EmbeddingPart, {
+    type: 'text';
+}>;
+export type EmbeddingInputCheck = {
+    ok: true;
+    inputs: EmbeddingInput[];
+} | {
+    ok: false;
+    reason: 'invalid_json' | 'no_inputs';
+} | {
+    ok: false;
+    reason: 'too_many_inputs';
+    max: number;
+    inputs: EmbeddingInput[];
+} | {
+    ok: false;
+    reason: 'empty_input' | 'text_off';
+    index: number;
+    inputs: EmbeddingInput[];
+} | {
+    ok: false;
+    reason: 'attachments';
+    issues: AttachmentValidationIssue[];
+    inputs: EmbeddingInput[];
+};
+/** The request's inputs, read from its JSON; `undefined` when it is not a list of inputs. */
+export declare function readEmbeddingInputs(text: string): EmbeddingInput[] | undefined;
+/** One input, read from its JSON; `undefined` when it is not one. */
+export declare function readEmbeddingInput(text: string): EmbeddingInput | undefined;
+/** One input as fields edit it: its words, and the files beside them. */
+export type EmbeddingFields = {
+    text: string;
+    media: EmbeddingMediaPart[];
+};
+/** The input as fields, or `null` when it holds more than one text part and fields would lose it. */
+export declare function inputFields(input: EmbeddingInput): EmbeddingFields | null;
+/** Fields as the input they send: plain text alone, else its parts with the text first. */
+export declare function fieldsInput(fields: EmbeddingFields): EmbeddingInput;
+/** The inputs, held to the profile's rules and its model's limits as the kernel holds them in one request. */
+export declare function checkInputs(inputs: readonly EmbeddingInput[], rules: EmbeddingInterface['inputs']): EmbeddingInputCheck;
+/** The request's JSON as the inputs it sends, held to the profile's rules. */
+export declare function checkEmbeddingInputs(text: string, rules: EmbeddingInterface['inputs']): EmbeddingInputCheck;
+/** Where text is cut into documents: not at all, at each line, at blank lines, at commas, or at a separator of your own. */
+export type EmbeddingSplit = 'whole' | 'lines' | 'paragraphs' | 'commas' | {
+    separator: string;
+};
+/** The text as documents, each trimmed, none empty. */
+export declare function splitText(text: string, split: EmbeddingSplit): string[];
+/** A file read as words and split, not sent as media: plain text, Markdown, CSV, and JSON. */
+export declare function readsAsText(file: {
+    name: string;
+    type: string;
+}): boolean;
+/** The most inputs the console sends in one request when the model sets no cap. */
+export declare const MAX_BATCH_INPUTS = 100;
+/**
+ * The inputs, in order, as the fewest requests the profile and its model
+ * allow: each holds at most `most` inputs and passes {@linkcode checkInputs}.
+ * An input refused on its own goes alone, for the kernel to refuse.
+ */
+export declare function embeddingBatches(inputs: readonly EmbeddingInput[], rules: EmbeddingInterface['inputs'], most?: number): EmbeddingInput[][];
+/** Two calls' usage as one: token counts and costs added, estimated when either was. */
+export declare function addUsage(a: EmbeddingUsage | undefined, b: EmbeddingUsage | undefined): EmbeddingUsage | undefined;
+/** How alike two vectors point, from -1 to 1. */
+export declare function cosineSimilarity(a: readonly number[], b: readonly number[]): number;
+/** A document and how alike it points to the query, from -1 to 1. */
+export type EmbeddingMatch = {
+    index: number;
+    score: number;
+};
+/** The documents, most alike to the query first; a vector of another width is left out. */
+export declare function rankMatches(query: readonly number[], documents: readonly (readonly number[])[]): EmbeddingMatch[];