modelfusion 0.131.0 → 0.131.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.131.1 - 2024-01-25
+
+### Fixed
+
+- Add `type-fest` as dependency to fix type inference errors.
+
 ## v0.131.0 - 2024-01-23
 
 ### Added

package/README.md

@@ -7,6 +7,7 @@
 [![Docs](https://img.shields.io/badge/docs-modelfusion.dev-blue)](https://modelfusion.dev)
 [![Discord](https://discordapp.com/api/guilds/1136309340740006029/widget.png?style=shield)](https://discord.gg/GqCwYZATem)
 [![Created by Lars Grammel](https://img.shields.io/badge/created%20by-@lgrammel-4BBAAB.svg)](https://twitter.com/lgrammel)
+[![Follow @modelfusionjs](https://img.shields.io/badge/follow-@modelfusionjs-4BBAAB.svg)](https://twitter.com/modelfusionjs)
 
 [Introduction](#introduction) | [Quick Install](#quick-install) | [Usage](#usage-examples) | [Documentation](#documentation) | [Examples](#more-examples) | [Contributing](#contributing) | [modelfusion.dev](https://modelfusion.dev)
 
@@ -30,7 +31,7 @@
 npm install modelfusion
 ```
 
-Or use a start template:
+Or use a starter template:
 
 - [ModelFusion terminal app starter](https://github.com/lgrammel/modelfusion-terminal-app-starter)
 - [Next.js, Vercel AI SDK, Llama.cpp & ModelFusion starter](https://github.com/lgrammel/modelfusion-llamacpp-nextjs-starter)
@@ -578,7 +579,7 @@ const text = await generateText({
   - [Generate object](https://modelfusion.dev/guide/function/generate-object)
   - [Generate image](https://modelfusion.dev/guide/function/generate-image)
   - [Generate speech](https://modelfusion.dev/guide/function/generate-speech)
-  - [Generate transcription](https://modelfusion.dev/guide/function/generation-transcription)
+  - [Generate transcription](https://modelfusion.dev/guide/function/generate-transcription)
   - [Tokenize Text](https://modelfusion.dev/guide/function/tokenize-text)
   - [Embed Value](https://modelfusion.dev/guide/function/embed)
   - [Classify Value](https://modelfusion.dev/guide/function/classify)

package/core/schema/ZodSchema.d.ts

@@ -1,7 +1,7 @@
+import { PartialDeep } from "type-fest";
 import { z } from "zod";
 import { JsonSchemaProducer } from "./JsonSchemaProducer.js";
 import { Schema } from "./Schema.js";
-import { PartialDeep } from "type-fest";
 export declare function zodSchema<OBJECT>(zodSchema: z.Schema<OBJECT>): ZodSchema<OBJECT>;
 export declare class ZodSchema<OBJECT> implements Schema<OBJECT>, JsonSchemaProducer {
     readonly zodSchema: z.Schema<OBJECT>;

package/model-function/generate-object/ObjectStream.cjs

@@ -2,6 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ObjectStreamFromResponse = exports.ObjectStreamResponse = void 0;
 const parsePartialJson_js_1 = require("../../util/parsePartialJson.cjs");
+/**
+ * Response for ObjectStream. The object stream is encoded as a text stream.
+ *
+ * Example:
+ * ```ts
+ * return new ObjectStreamResponse(objectStream);
+ * ```
+ */
 class ObjectStreamResponse extends Response {
     constructor(stream, init) {
         super(ObjectStreamToTextStream(stream), {
@@ -12,6 +20,12 @@ class ObjectStreamResponse extends Response {
     }
 }
 exports.ObjectStreamResponse = ObjectStreamResponse;
+/**
+ * Convert a Response to a lightweight ObjectStream. The response must be created
+ * using ObjectStreamResponse on the server.
+ *
+ * @see ObjectStreamResponse
+ */
 async function* ObjectStreamFromResponse({ response, }) {
     let text = "";
     const reader = response.body.getReader();

package/model-function/generate-object/ObjectStream.d.ts

@@ -7,9 +7,23 @@ export type ObjectStream<OBJECT> = AsyncIterable<{
     partialText: string;
     textDelta: string;
 }>;
+/**
+ * Response for ObjectStream. The object stream is encoded as a text stream.
+ *
+ * Example:
+ * ```ts
+ * return new ObjectStreamResponse(objectStream);
+ * ```
+ */
 export declare class ObjectStreamResponse extends Response {
     constructor(stream: ObjectStream<unknown>, init?: ResponseInit);
 }
+/**
+ * Convert a Response to a lightweight ObjectStream. The response must be created
+ * using ObjectStreamResponse on the server.
+ *
+ * @see ObjectStreamResponse
+ */
 export declare function ObjectStreamFromResponse<OBJECT>({ response, }: {
     schema: Schema<OBJECT>;
     response: Response;

package/model-function/generate-object/ObjectStream.js

@@ -1,4 +1,12 @@
 import { parsePartialJson } from "../../util/parsePartialJson.js";
+/**
+ * Response for ObjectStream. The object stream is encoded as a text stream.
+ *
+ * Example:
+ * ```ts
+ * return new ObjectStreamResponse(objectStream);
+ * ```
+ */
 export class ObjectStreamResponse extends Response {
     constructor(stream, init) {
         super(ObjectStreamToTextStream(stream), {
@@ -8,6 +16,12 @@ export class ObjectStreamResponse extends Response {
         });
     }
 }
+/**
+ * Convert a Response to a lightweight ObjectStream. The response must be created
+ * using ObjectStreamResponse on the server.
+ *
+ * @see ObjectStreamResponse
+ */
 export async function* ObjectStreamFromResponse({ response, }) {
     let text = "";
     const reader = response.body.getReader();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
   "description": "The TypeScript library for building AI applications.",
-  "version": "0.131.0",
+  "version": "0.131.1",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [
@@ -67,6 +67,7 @@
     "js-tiktoken": "1.0.7",
     "nanoid": "3.3.6",
     "secure-json-parse": "2.7.0",
+    "type-fest": "4.9.0",
     "ws": "8.14.2",
     "zod": "3.22.4",
     "zod-to-json-schema": "3.22.3"
@@ -80,7 +81,6 @@
     "@vitest/ui": "1.1.0",
     "eslint": "^8.45.0",
     "eslint-config-prettier": "9.1.0",
-    "msw": "2.1.2",
-    "type-fest": "4.9.0"
+    "msw": "2.1.2"
   }
 }