@adaas/a-frame 0.1.1 → 0.1.2

package/dist/node/A-FrameChannel.types-DwyZRsOy.d.ts

@@ -0,0 +1,205 @@
+import { A_Fragment, A_Error, A_TYPES__Error_Serialized, A_TYPES__Entity_Serialized } from '@adaas/a-concept';
+import { D as DefinitionExtractedMeta } from './A-FrameDefinition.entity-BIF0sclD.js';
+
+declare class A_FrameChannelRequest<_Response = any> extends A_Fragment {
+    method: string;
+    path: string;
+    body?: unknown;
+    protected _response?: _Response;
+    protected _error?: A_Error;
+    constructor(method: string, path: string, body?: unknown);
+    complete(response: _Response): void;
+    fail(error: A_Error): void;
+    get response(): _Response | undefined;
+    get error(): A_Error | undefined;
+}
+
+declare const A_FrameFeatures: {
+    readonly Request: "_A_FRAME_REQUEST";
+    readonly Socket: "_A_FRAME_SOCKET";
+    readonly Stream: "_A_FRAME_STREAM";
+    readonly Send: "_A_FRAME_SEND";
+};
+declare const A_FrameChannelStreamStatuses: {
+    readonly Open: "open";
+    readonly Closed: "closed";
+};
+declare const A_FrameChannelStreamFeatures: {
+    readonly open: "_A_FRAME_CHANNEL_STREAM_OPEN";
+    readonly send: "_A_FRAME_CHANNEL_STREAM_SEND";
+    readonly onEvent: "_A_FRAME_CHANNEL_STREAM_ON_EVENT";
+    readonly onError: "_A_FRAME_CHANNEL_STREAM_ON_ERROR";
+    readonly onComplete: "_A_FRAME_CHANNEL_STREAM_ON_COMPLETE";
+    readonly onClose: "_A_FRAME_CHANNEL_STREAM_ON_CLOSE";
+};
+declare const A_FrameChannelSocketStatuses: {
+    readonly Connecting: "connecting";
+    readonly Open: "open";
+    readonly Closed: "closed";
+};
+declare const A_FrameChannelSocketFeatures: {
+    readonly onEvent: "_A_FRAME_CHANNEL_SOCKET_ON_EVENT";
+    readonly onError: "_A_FRAME_CHANNEL_SOCKET_ON_ERROR";
+    readonly onOpen: "_A_FRAME_CHANNEL_SOCKET_ON_OPEN";
+    readonly onClose: "_A_FRAME_CHANNEL_SOCKET_ON_CLOSE";
+};
+
+/**
+ * Retrieval task hint for asymmetric embedding models (e.g. adaas-antares-v1).
+ * - 'query'    — text is a search query (default for channel.embed)
+ * - 'document' — text is content being indexed (used internally for definitions)
+ * - 'default'  — no prefix / symmetric mode
+ */
+type A_FrameEmbeddingTask = 'document' | 'query' | 'default';
+/**
+ * Options for channel.embed() — mirrors A_FrameCompletionOptions so the
+ * same override pattern is available for both completions and embeddings.
+ */
+interface A_FrameEmbedOptions {
+    /**
+     * Override the embedding model for this request
+     * (e.g. "adaas-antares-v1", "adaas-vega-v1").
+     * Falls back to the server's configured default when omitted.
+     */
+    model?: string;
+    /**
+     * Task hint used by asymmetric embedding models.
+     * Defaults to 'query' when calling channel.embed() for search.
+     */
+    task?: A_FrameEmbeddingTask;
+}
+interface A_Frame_EmbedResponse {
+    data: Array<{
+        embedding: number[];
+        index: number;
+    }>;
+    model: string;
+    /**
+     * Execution backend reported by the server ("local" | "remote" | …)
+     */
+    backend?: string;
+    /**
+     * ISO timestamp of when the embedding was generated, as reported by the server. Useful for cache validation and staleness checks.
+     */
+    date: string;
+    meta: {
+        dimensions: number;
+        input_count: number;
+        /** Embed-server (a-frame-mcp) package version */
+        server_version: string;
+        /** ID of the credential (API key) used for this request */
+        credential_id: string | null;
+    };
+    /** Structural metadata extracted from the source by the server */
+    aFrameMeta?: DefinitionExtractedMeta;
+}
+interface A_Frame_GenerateResponse {
+    data: {
+        text: string;
+    };
+    model: string;
+    /**
+     * Execution backend reported by the server ("local" | "remote" | …)
+     */
+    backend?: string;
+    /**
+     * ISO timestamp of when the embedding was generated, as reported by the server. Useful for cache validation and staleness checks.
+     */
+    date: string;
+    meta: {
+        /** Embed-server (a-frame-mcp) package version */
+        server_version: string;
+        /** ID of the credential (API key) used for this request */
+        credential_id: string | null;
+    };
+}
+interface A_Frame_CompletionResponse {
+    /** The generated text completion. */
+    text: string;
+    /** Embedding of the generated text as a plain number array. */
+    embedding: number[];
+    /** The model used for completion (may differ from the embedding model). */
+    model: string;
+    /** ISO timestamp of when the response was produced. */
+    date: string;
+    meta: {
+        /** Dimensionality of the embedding vector. */
+        dimensions: number;
+        /** Embed-server (a-frame-mcp) package version. */
+        server_version: string;
+        /** ID of the credential (API key) used for this request. */
+        credential_id: string | null;
+    };
+}
+interface A_Frame_CredentialResponse {
+    /** Unique identifier for the credential */
+    id: string;
+    /** Name of the credential */
+    name: string;
+    /** Optional description of the credential */
+    description: string | null;
+    /** The encryption key in base64 format */
+    encryption_key: string;
+    /** Encryption algorithm used (e.g., "AES-256-GCM") */
+    algorithm: string;
+    /** Encoding format of the encryption key (e.g., "base64") */
+    key_encoding: string;
+    /** Usage instructions for the encryption key */
+    usage_note: string;
+    /** Version of the a-frame-mcp server */
+    server_version: string;
+}
+interface IA_Frame_Channel {
+    generate(prompt: string): Promise<A_FrameChannelRequest<A_Frame_GenerateResponse>>;
+    /** Embed one or more raw text strings and return the server response */
+    embed(inputs: string | string[], options?: A_FrameEmbedOptions): Promise<A_FrameChannelRequest<A_Frame_EmbedResponse>>;
+    /** Fetch credential details (incl. encryption key) for the authenticated API key */
+    getCredentials(): Promise<A_FrameChannelRequest<A_Frame_CredentialResponse>>;
+    /** Returns true if the embed server is reachable */
+    ping(): Promise<A_FrameChannelRequest<boolean>>;
+}
+type A_FrameChannelStreamStatusNames = typeof A_FrameChannelStreamStatuses[keyof typeof A_FrameChannelStreamStatuses];
+type A_FrameChannelStreamFeatureNames = typeof A_FrameChannelStreamFeatures[keyof typeof A_FrameChannelStreamFeatures];
+type A_FrameChannelStream_Init<T extends Record<string, any> = Record<string, any>> = {
+    method: string;
+    path: string;
+    body?: T;
+};
+type A_FrameChannelStream_Serialized<T extends Record<string, any> = Record<string, any>> = {
+    method: string;
+    path: string;
+    body?: T;
+    initDate: string;
+    status: A_FrameChannelStreamStatusNames;
+    error?: A_TYPES__Error_Serialized;
+} & A_TYPES__Entity_Serialized;
+type A_FrameChannelSocketStatusNames = typeof A_FrameChannelSocketStatuses[keyof typeof A_FrameChannelSocketStatuses];
+type A_FrameChannelSocketFeatureNames = typeof A_FrameChannelSocketFeatures[keyof typeof A_FrameChannelSocketFeatures];
+interface A_Frame_SchemaResponse<T extends Record<string, unknown> = Record<string, unknown>> {
+    /** The structured data extracted from the prompt. */
+    data: T;
+    /** Physical model name used for extraction. */
+    model: string;
+    /** ISO timestamp of when the extraction was produced. */
+    date: string;
+    meta: {
+        /** Embed-server (a-frame-mcp) package version. */
+        server_version: string;
+    };
+}
+type A_FrameChannelSocket_Init<T extends Record<string, any> = Record<string, any>> = {
+    method: string;
+    path: string;
+    /** Optional JSON body sent as the X-A-Frame-Init header during the upgrade request. */
+    body?: T;
+};
+type A_FrameChannelSocket_Serialized<T extends Record<string, any> = Record<string, any>> = {
+    method: string;
+    path: string;
+    body?: T;
+    initDate: string;
+    status: A_FrameChannelSocketStatusNames;
+    error?: A_TYPES__Error_Serialized;
+} & A_TYPES__Entity_Serialized;
+
+export { A_FrameChannelRequest as A, type IA_Frame_Channel as I, type A_Frame_GenerateResponse as a, type A_FrameEmbedOptions as b, type A_Frame_EmbedResponse as c, type A_Frame_CredentialResponse as d, type A_FrameChannelStream_Init as e, type A_FrameChannelStream_Serialized as f, type A_FrameChannelStreamStatusNames as g, type A_FrameChannelSocketFeatureNames as h, A_FrameChannelSocketFeatures as i, type A_FrameChannelSocketStatusNames as j, A_FrameChannelSocketStatuses as k, type A_FrameChannelSocket_Init as l, type A_FrameChannelSocket_Serialized as m, type A_FrameChannelStreamFeatureNames as n, A_FrameChannelStreamFeatures as o, A_FrameChannelStreamStatuses as p, type A_FrameEmbeddingTask as q, A_FrameFeatures as r, type A_Frame_CompletionResponse as s, type A_Frame_SchemaResponse as t };

package/dist/node/A-FrameCompletion.entity-Brx11JMp.d.ts

@@ -0,0 +1,72 @@
+import { A_TYPES__Entity_Serialized, A_Entity, A_Scope } from '@adaas/a-concept';
+import { A_FrameVector } from './vector.js';
+
+type A_FrameCompletionOptions = {
+    /**
+     * Override the AI model for this completion.
+     * Defaults to `A_FRAME_MODELS.RIGEL` ('adaas-rigel-v1') — the
+     * code-generation model optimised for TypeScript/JavaScript output.
+     * Pass any other `A_FRAME_MODELS` constant or a raw model name to override.
+     */
+    model?: string;
+    /** Optional system prompt prepended before the user message. */
+    system?: string;
+    /** Max tokens to generate. */
+    max_tokens?: number;
+    /** Temperature 0–1. Lower = more deterministic. */
+    temperature?: number;
+};
+
+type A_FrameCompletion_Init = {
+    /** The input prompt to generate a completion for. */
+    prompt: string;
+    options?: A_FrameCompletionOptions;
+};
+type A_FrameCompletion_Serialized = {
+    prompt: string;
+    text?: string;
+    embedding?: Float32Array;
+    model?: string;
+    date?: string;
+    aFrameVersion?: string;
+    aFrameServerVersion?: string;
+} & A_TYPES__Entity_Serialized;
+
+declare class A_FrameCompletion extends A_Entity<A_FrameCompletion_Init, A_FrameCompletion_Serialized> {
+    static get concept(): string;
+    protected _prompt: string;
+    protected _options?: A_FrameCompletionOptions;
+    protected _text?: string;
+    protected _vector?: A_FrameVector;
+    protected _model?: string;
+    protected _date?: string;
+    protected _aFrameVersion?: string;
+    protected _aFrameServerVersion?: string;
+    get prompt(): string;
+    get options(): A_FrameCompletionOptions | undefined;
+    get text(): string | undefined;
+    get vector(): A_FrameVector | undefined;
+    get embedding(): Float32Array | null;
+    get model(): string | undefined;
+    get date(): string | undefined;
+    get isGenerated(): boolean;
+    fromNew(init: A_FrameCompletion_Init): void;
+    fromJSON(serialized: A_FrameCompletion_Serialized): void;
+    toJSON(): A_FrameCompletion_Serialized;
+    /**
+     * Generates a text completion for the prompt and stores the resulting text
+     * along with its embedding vector. The actual implementation is provided by
+     * the A_FrameCompletionFeatures.Generate feature (supplied by A_FrameChannel).
+     */
+    generate(scope?: A_Scope): Promise<void> | void;
+    hydrateFromGeneration(result: {
+        text: string;
+        embedding: Float32Array;
+        model?: string;
+        date?: string;
+        aFrameVersion?: string;
+        aFrameServerVersion?: string;
+    }): void;
+}
+
+export { A_FrameCompletion as A, type A_FrameCompletionOptions as a, type A_FrameCompletion_Init as b, type A_FrameCompletion_Serialized as c };

package/dist/node/A-FrameCompletion.entity-Dzy9sIa8.d.mts

@@ -0,0 +1,72 @@
+import { A_TYPES__Entity_Serialized, A_Entity, A_Scope } from '@adaas/a-concept';
+import { A_FrameVector } from './vector.mjs';
+
+type A_FrameCompletionOptions = {
+    /**
+     * Override the AI model for this completion.
+     * Defaults to `A_FRAME_MODELS.RIGEL` ('adaas-rigel-v1') — the
+     * code-generation model optimised for TypeScript/JavaScript output.
+     * Pass any other `A_FRAME_MODELS` constant or a raw model name to override.
+     */
+    model?: string;
+    /** Optional system prompt prepended before the user message. */
+    system?: string;
+    /** Max tokens to generate. */
+    max_tokens?: number;
+    /** Temperature 0–1. Lower = more deterministic. */
+    temperature?: number;
+};
+
+type A_FrameCompletion_Init = {
+    /** The input prompt to generate a completion for. */
+    prompt: string;
+    options?: A_FrameCompletionOptions;
+};
+type A_FrameCompletion_Serialized = {
+    prompt: string;
+    text?: string;
+    embedding?: Float32Array;
+    model?: string;
+    date?: string;
+    aFrameVersion?: string;
+    aFrameServerVersion?: string;
+} & A_TYPES__Entity_Serialized;
+
+declare class A_FrameCompletion extends A_Entity<A_FrameCompletion_Init, A_FrameCompletion_Serialized> {
+    static get concept(): string;
+    protected _prompt: string;
+    protected _options?: A_FrameCompletionOptions;
+    protected _text?: string;
+    protected _vector?: A_FrameVector;
+    protected _model?: string;
+    protected _date?: string;
+    protected _aFrameVersion?: string;
+    protected _aFrameServerVersion?: string;
+    get prompt(): string;
+    get options(): A_FrameCompletionOptions | undefined;
+    get text(): string | undefined;
+    get vector(): A_FrameVector | undefined;
+    get embedding(): Float32Array | null;
+    get model(): string | undefined;
+    get date(): string | undefined;
+    get isGenerated(): boolean;
+    fromNew(init: A_FrameCompletion_Init): void;
+    fromJSON(serialized: A_FrameCompletion_Serialized): void;
+    toJSON(): A_FrameCompletion_Serialized;
+    /**
+     * Generates a text completion for the prompt and stores the resulting text
+     * along with its embedding vector. The actual implementation is provided by
+     * the A_FrameCompletionFeatures.Generate feature (supplied by A_FrameChannel).
+     */
+    generate(scope?: A_Scope): Promise<void> | void;
+    hydrateFromGeneration(result: {
+        text: string;
+        embedding: Float32Array;
+        model?: string;
+        date?: string;
+        aFrameVersion?: string;
+        aFrameServerVersion?: string;
+    }): void;
+}
+
+export { A_FrameCompletion as A, type A_FrameCompletionOptions as a, type A_FrameCompletion_Init as b, type A_FrameCompletion_Serialized as c };