@tanstack-ai-browser/apfel 0.0.0-stage → 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 daveycodez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,18 @@
-# Temporary Holding Version
+# @tanstack-ai-browser/apfel
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A [TanStack AI](https://tanstack.com/ai) adapter for Apple's on-device Foundation Model, served on your Mac by [apfel](https://apfel.franzai.com)'s OpenAI-compatible server. The browser streams straight from localhost: start it with `apfel --serve --cors`.
+
+```sh
+npm install @tanstack-ai-browser/apfel @tanstack/ai
+```
+
+```ts
+import { chat } from "@tanstack/ai"
+import { apfel, isApfelAvailable } from "@tanstack-ai-browser/apfel"
+
+if (await isApfelAvailable()) {
+  const stream = chat({ adapter: apfel(), messages, threadId })
+}
+```
+
+**Status:** early (0.0.x); the API may change. See the [repository README](https://github.com/daveycodez/tanstack-ai-browser#readme).

package/dist/adapter.d.ts

@@ -0,0 +1,91 @@
+import type { AdapterYieldChunk, TextOptions } from "@tanstack/ai";
+import { BaseTextAdapter } from "@tanstack/ai/adapters";
+import type { StructuredOutputOptions, StructuredOutputResult } from "@tanstack/ai/adapters";
+/** Where `apfel --serve` listens by default. */
+export declare const APFEL_BASE_URL = "http://127.0.0.1:11434/v1";
+/** The model id apfel serves Apple's Foundation Model under. */
+export declare const APFEL_MODEL = "apple-foundationmodel";
+/**
+ * A model call's token counts and timings. apfel reports token counts only
+ * in the usage at the end of the stream; counts it doesn't report are left
+ * out.
+ */
+export type ApfelStats = {
+    /** Tokens of the prompt. */
+    inputTokens?: number;
+    /** Prompt tokens served from a cache, if apfel reports them. */
+    cachedTokens?: number;
+    /** Tokens the model generated. */
+    outputTokens?: number;
+    /** From sending the request to the first generated token, in ms. */
+    firstTokenMs?: number;
+    /** Tokens generated after the first chunk (estimated, see below). */
+    decodeTokens?: number;
+    /** From the first generated chunk to the last, in ms. */
+    decodeMs?: number;
+};
+export type ApfelOptions = {
+    /** apfel's OpenAI-compatible API, up to `/v1`. */
+    baseUrl?: string;
+    /** The model id to ask apfel for. */
+    model?: string;
+    /**
+     * The call's stats at its first token (`done: false`, time to first token
+     * only) and when it ends (`done: true`). `callId` is unique per model
+     * call; `chat()` makes one per step of its agent loop.
+     */
+    onStats?: (stats: ApfelStats, run: {
+        threadId: string;
+        runId: string;
+        callId: string;
+        done: boolean;
+    }) => void;
+};
+/**
+ * Request fields apfel takes for Apple's model. apfel rejects parameters
+ * the model doesn't support (stop, penalties, n…) with HTTP 400.
+ */
+export type ApfelModelOptions = {
+    temperature?: number;
+    max_tokens?: number;
+    seed?: number;
+};
+type ApfelReasoning = never;
+type MetadataByModality = {
+    text: unknown;
+    image: unknown;
+    audio: unknown;
+    video: unknown;
+    document: unknown;
+};
+export declare class ApfelTextAdapter extends BaseTextAdapter<string, ApfelModelOptions, readonly ["text"], MetadataByModality, ReadonlyArray<string>, unknown, never, ApfelReasoning> {
+    readonly name: "apfel";
+    readonly api: "apfel";
+    private readonly baseUrl;
+    private readonly onStats;
+    constructor(options?: ApfelOptions);
+    chatStream(options: TextOptions<ApfelModelOptions>): AsyncIterable<AdapterYieldChunk>;
+    /**
+     * A JSON answer for `chat({ outputSchema })`, from apfel's JSON mode:
+     * `response_format: json_schema` constrains Apple's model to the schema
+     * (guided generation). `chat()` validates the result.
+     */
+    structuredOutput(options: StructuredOutputOptions<ApfelModelOptions>): Promise<StructuredOutputResult<unknown>>;
+}
+/**
+ * A TanStack AI adapter for Apple's on-device Foundation Model through
+ * apfel (`apfel --serve --cors`).
+ *
+ * @example
+ * ```ts
+ * chat({ adapter: apfel(), messages, threadId })
+ * ```
+ */
+export declare function apfel(options?: ApfelOptions): ApfelTextAdapter;
+/**
+ * Whether apfel is running and serves the model: true if `GET /v1/models`
+ * lists it within 10 seconds.
+ */
+export declare function isApfelAvailable(options?: Pick<ApfelOptions, "baseUrl" | "model">): Promise<boolean>;
+export {};
+//# sourceMappingURL=adapter.d.ts.map

package/dist/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,iBAAiB,EAEjB,WAAW,EAEZ,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EACV,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,uBAAuB,CAAA;AAQ9B,gDAAgD;AAChD,eAAO,MAAM,cAAc,8BAA8B,CAAA;AACzD,gEAAgE;AAChE,eAAO,MAAM,WAAW,0BAA0B,CAAA;AAElD;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gEAAgE;IAChE,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,kCAAkC;IAClC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,qEAAqE;IACrE,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,kDAAkD;IAClD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,qCAAqC;IACrC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,OAAO,CAAC,EAAE,CACR,KAAK,EAAE,UAAU,EACjB,GAAG,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,KACpE,IAAI,CAAA;CACV,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,KAAK,cAAc,GAAG,KAAK,CAAA;AAE3B,KAAK,kBAAkB,GAAG;IACxB,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE,OAAO,CAAA;IACd,KAAK,EAAE,OAAO,CAAA;IACd,KAAK,EAAE,OAAO,CAAA;IACd,QAAQ,EAAE,OAAO,CAAA;CAClB,CAAA;AAmOD,qBAAa,gBAAiB,SAAQ,eAAe,CACnD,MAAM,EACN,iBAAiB,EACjB,SAAS,CAAC,MAAM,CAAC,EACjB,kBAAkB,EAClB,aAAa,CAAC,MAAM,CAAC,EACrB,OAAO,EACP,KAAK,EACL,cAAc,CACf;IACC,QAAQ,CAAC,IAAI,EAAG,OAAO,CAAS;IAChC,SAAkB,GAAG,EAAG,OAAO,CAAS;IACxC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,OAAO,GAAE,YAAiB;IAM/B,UAAU,CACf,OAAO,EAAE,WAAW,CAAC,iBAAiB,CAAC,GACtC,aAAa,CAAC,iBAAiB,CAAC;IAmUnC;;;;OAIG;IACG,gBAAgB,CACpB,OAAO,EAAE,uBAAuB,CAAC,iBAAiB,CAAC,GAClD,OAAO,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;CAsE5C;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY,oBAE3C;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CACpC,OAAO,GAAE,IAAI,CAAC,YAAY,EAAE,SAAS,GAAG,OAAO,CAAM,oBActD"}