Release 0.8.8 (#1457)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: himself65 <himself65@users.noreply.github.com>

.github/workflows/test.yml

@@ -119,7 +119,7 @@ jobs:
         run: pnpm run build
       - name: Build ${{ matrix.packages }}
         run: pnpm run build
-        working-directory: packages/llamaindex/e2e/examples/${{ matrix.packages }}
+        working-directory: e2e/examples/${{ matrix.packages }}
 
   typecheck-examples:
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -2,86 +2,58 @@
 
 ## Structure
 
-This is a monorepo built with Turborepo
+LlamaIndex.TS uses pnpm monorepo.
 
-Right now, for first-time contributors, these three packages are of the highest importance:
+We recommend you to understand the basics of Node.js, TypeScript, pnpm, and of course, LLM before contributing.
 
-- `packages/llamaindex` which is the main NPM library `llamaindex`
-- `examples` is where the demo code lives
-- `apps/docs` is where the code for the documentation of https://ts.llamaindex.ai/ is located
+There are some important folders in the repository:
 
-### Turborepo docs
-
-You can checkout how Turborepo works using the default [README-turborepo.md](/README-turborepo.md)
+- `packages/*`: Contains the source code of the packages. Each package is a separate npm package.
+  - `llamaindex`: The starter package for LlamaIndex.TS, which contains the all sub-packages.
+  - `core`: The core package of LlamaIndex.TS, which contains the abstract classes and interfaces. It is designed for
+    all JS runtime environments.
+  - `env`: The environment package of LlamaIndex.TS, which contains the environment-specific classes and interfaces. It
+    includes compatibility layers for Node.js, Deno, Vercel Edge Runtime, Cloudflare Workers...
+- `apps/*`: The applications based on LlamaIndex.TS.
+  - `next`: Our documentation website based on Next.js.
+- `examples`: The code examples of LlamaIndex.TS using Node.js.
 
 ## Getting Started
 
-Install NodeJS. Preferably v18 using nvm or n.
-
-Inside the LlamaIndexTS directory:
+Make sure you have Node.js LIS (Long-term Support) installed. You can check your Node.js version by running:
 
+```shell
+node -v
+# v20.x.x
 ```
-npm i -g pnpm ts-node
+
+### Use pnpm
+
+```shell
+corepack enable
+```
+
+### Install dependencies
+
+```shell
 pnpm install
 ```
 
-Note: we use pnpm in this repo, which has a lot of the same functionality and CLI options as npm but it does do some things better in a monorepo, like centralizing dependencies and caching.
+### Build the packages
 
-PNPM's has documentation on its [workspace feature](https://pnpm.io/workspaces) and Turborepo had some [useful documentation also](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks).
-
-### Running Typescript
-
-When we publish to NPM we will have a tsc compiled version of the library in JS. For now, the easiest thing to do is use ts-node.
-
-### Test cases
-
-To run them, run
-
-```
-pnpm run test
-```
-
-To write new test cases write them in [packages/llamaindex/tests](/packages/llamaindex/tests)
-
-We use Vitest https://vitest.dev to write our test cases. Vitest comes with a bunch of built-in assertions using the expect function: https://vitest.dev/api/expect.html#expect
-
-### Demo applications
-
-There is an existing ["example"](/examples/README.md) demos folder with mainly NodeJS scripts. Feel free to add additional demos to that folder. If you would like to try out your changes in the `llamaindex` package with a new demo, you need to run the build command in the README.
-
-You can create new demo applications in the apps folder. Just run pnpm init in the folder after you create it to create its own package.json
-
-### Installing packages
-
-To install packages for a specific package or demo application, run
-
-```
-pnpm add [NPM Package] --filter [package or application i.e. llamaindex or docs]
-```
-
-To install packages for every package or application run
-
-```
-pnpm add -w [NPM Package]
+```shell
+# Build all packages
+turbo build --filter "./packages/*"
 ```
 
 ### Docs
 
-To contribute to the docs, go to the docs website folder and run the Docusaurus instance.
-
-```bash
-cd apps/docs
-pnpm install
-pnpm start
-```
-
-That should start a webserver which will serve the docs on https://localhost:3000
-
-Any changes you make should be reflected in the browser. If you need to regenerate the API docs and find that your TSDoc isn't getting the updates, feel free to remove apps/docs/api. It will automatically regenerate itself when you run pnpm start again.
+See the [docs](./apps/next/README.md) for more information.
 
 ## Changeset
 
-We use [changesets](https://github.com/changesets/changesets) for managing versions and changelogs. To create a new changeset, run in the root folder:
+We use [changesets](https://github.com/changesets/changesets) for managing versions and changelogs. To create a new
+changeset, run in the root folder:
 
 ```
 pnpm changeset
@@ -95,6 +67,6 @@ The [Release Github Action](.github/workflows/release.yml) is automatically gene
 PR called "Release {version}".
 
 This PR will update the `package.json` and `CHANGELOG.md` files of each package according to
-the current changesets in the [.changeset](.changeset/) folder.
+the current changesets in the [.changeset](.changeset) folder.
 
 If this PR is merged it will automatically add version tags to the repository and publish the updated packages to NPM.

apps/docs/CHANGELOG.md

@@ -1,5 +1,26 @@
 # docs
 
+## 0.0.112
+
+### Patch Changes
+
+- Updated dependencies [ad85bd0]
+  - llamaindex@0.8.8
+  - @llamaindex/examples@0.0.13
+
+## 0.0.111
+
+### Patch Changes
+
+- llamaindex@0.8.7
+
+## 0.0.110
+
+### Patch Changes
+
+- Updated dependencies [95a5cc6]
+  - llamaindex@0.8.6
+
 ## 0.0.109
 
 ### Patch Changes

apps/docs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docs",
-  "version": "0.0.109",
+  "version": "0.0.112",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",

apps/next/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @llamaindex/doc
 
+## 0.0.10
+
+### Patch Changes
+
+- Updated dependencies [ad85bd0]
+  - @llamaindex/core@0.4.5
+  - llamaindex@0.8.8
+  - @llamaindex/node-parser@0.0.6
+  - @llamaindex/workflow@0.0.3
+  - @llamaindex/cloud@2.0.5
+  - @llamaindex/openai@0.1.30
+  - @llamaindex/readers@1.0.6
+
+## 0.0.9
+
+### Patch Changes
+
+- @llamaindex/cloud@2.0.4
+- @llamaindex/core@0.4.4
+- llamaindex@0.8.7
+- @llamaindex/node-parser@0.0.5
+- @llamaindex/openai@0.1.29
+- @llamaindex/readers@1.0.5
+
+## 0.0.8
+
+### Patch Changes
+
+- Updated dependencies [95a5cc6]
+  - @llamaindex/core@0.4.3
+  - llamaindex@0.8.6
+  - @llamaindex/cloud@2.0.3
+  - @llamaindex/node-parser@0.0.4
+  - @llamaindex/openai@0.1.28
+  - @llamaindex/readers@1.0.4
+
 ## 0.0.7
 
 ### Patch Changes

apps/next/README.md

@@ -1,4 +1,4 @@
-# next
+# Docs
 
 This is a Next.js application generated with
 [Create Fumadocs](https://github.com/fuma-nama/fumadocs).
@@ -6,15 +6,10 @@ This is a Next.js application generated with
 Run development server:
 
 ```bash
-npm run dev
-# or
-pnpm dev
-# or
-yarn dev
+turbo run dev
+# turbo will build all required packages before running the dev server
 ```
 
-Open http://localhost:3000 with your browser to see the result.
-
 ## Learn More
 
 To learn more about Next.js and Fumadocs, take a look at the following

apps/next/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/doc",
-  "version": "0.0.7",
+  "version": "0.0.10",
   "private": true,
   "scripts": {
     "build": "pnpm run build:docs && next build",

apps/next/src/content/docs/llamaindex/setup/typescript.mdx

@@ -93,6 +93,35 @@ See more about [moduleResolution](https://www.typescriptlang.org/docs/handbook/m
 	</Accordion>
 </Accordions>
 
+## Enable AsyncIterable for `Web Stream` API
+
+Some modules uses `Web Stream` API like `ReadableStream` and `WritableStream`, you need to enable `DOM.AsyncIterable` in your `tsconfig.json`.
+
+```json5
+{
+  compilerOptions: {
+    // ⬇️ add this lib to your tsconfig.json
+    lib: ["DOM.AsyncIterable"],
+  },
+}
+```
+
+```ts twoslash
+import { OpenAIAgent } from '@llamaindex/openai'
+
+const agent = new OpenAIAgent({
+  tools: []
+})
+
+const response = await agent.chat({
+  message: 'Hello, how are you?',
+  stream: true
+})
+for await (const _ of response) {
+                      //^?
+  // ...
+}
+```
 
 ## Run TypeScript Script in Node.js
 

apps/next/turbo.json

@@ -0,0 +1,8 @@
+{
+  "extends": ["//"],
+  "tasks": {
+    "dev": {
+      "dependsOn": ["^build"]
+    }
+  }
+}

e2e/examples/cloudflare-worker-agent/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @llamaindex/cloudflare-worker-agent-test
 
+## 0.0.104
+
+### Patch Changes
+
+- Updated dependencies [ad85bd0]
+  - llamaindex@0.8.8
+
+## 0.0.103
+
+### Patch Changes
+
+- llamaindex@0.8.7
+
+## 0.0.102
+
+### Patch Changes
+
+- Updated dependencies [95a5cc6]
+  - llamaindex@0.8.6
+
 ## 0.0.101
 
 ### Patch Changes

e2e/examples/cloudflare-worker-agent/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/cloudflare-worker-agent-test",
-  "version": "0.0.101",
+  "version": "0.0.104",
   "type": "module",
   "private": true,
   "scripts": {

e2e/examples/llama-parse-browser/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @llamaindex/llama-parse-browser-test
 
+## 0.0.25
+
+### Patch Changes
+
+- @llamaindex/cloud@2.0.5
+
+## 0.0.24
+
+### Patch Changes
+
+- @llamaindex/cloud@2.0.4
+
+## 0.0.23
+
+### Patch Changes
+
+- @llamaindex/cloud@2.0.3
+
 ## 0.0.22
 
 ### Patch Changes

e2e/examples/llama-parse-browser/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@llamaindex/llama-parse-browser-test",
   "private": true,
-  "version": "0.0.22",
+  "version": "0.0.25",
   "type": "module",
   "scripts": {
     "dev": "vite",

e2e/examples/llama-parse-browser/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../../../../tsconfig.json",
+  "extends": "../../../tsconfig.json",
   "compilerOptions": {
     "target": "ES2020",
     "useDefineForClassFields": true,
@@ -20,7 +20,7 @@
   },
   "references": [
     {
-      "path": "../../../../cloud/tsconfig.json"
+      "path": "../../../packages/cloud/tsconfig.json"
     }
   ]
 }

e2e/examples/nextjs-agent/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @llamaindex/next-agent-test
 
+## 0.1.104
+
+### Patch Changes
+
+- Updated dependencies [ad85bd0]
+  - llamaindex@0.8.8
+
+## 0.1.103
+
+### Patch Changes
+
+- llamaindex@0.8.7
+
+## 0.1.102
+
+### Patch Changes
+
+- Updated dependencies [95a5cc6]
+  - llamaindex@0.8.6
+
 ## 0.1.101
 
 ### Patch Changes

e2e/examples/nextjs-agent/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/next-agent-test",
-  "version": "0.1.101",
+  "version": "0.1.104",
   "private": true,
   "scripts": {
     "dev": "next dev",

e2e/examples/nextjs-agent/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../../../../tsconfig.json",
+  "extends": "../../../tsconfig.json",
   "compilerOptions": {
     "lib": ["dom", "dom.iterable", "esnext"],
     "allowJs": true,

e2e/examples/nextjs-edge-runtime/CHANGELOG.md

@@ -1,5 +1,25 @@
 # test-edge-runtime
 
+## 0.1.103
+
+### Patch Changes
+
+- Updated dependencies [ad85bd0]
+  - llamaindex@0.8.8
+
+## 0.1.102
+
+### Patch Changes
+
+- llamaindex@0.8.7
+
+## 0.1.101
+
+### Patch Changes
+
+- Updated dependencies [95a5cc6]
+  - llamaindex@0.8.6
+
 ## 0.1.100
 
 ### Patch Changes

e2e/examples/nextjs-edge-runtime/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/nextjs-edge-runtime-test",
-  "version": "0.1.100",
+  "version": "0.1.103",
   "private": true,
   "scripts": {
     "dev": "next dev",

e2e/examples/nextjs-node-runtime/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @llamaindex/next-node-runtime
 
+## 0.0.85
+
+### Patch Changes
+
+- Updated dependencies [ad85bd0]
+  - llamaindex@0.8.8
+
+## 0.0.84
+
+### Patch Changes
+
+- llamaindex@0.8.7
+
+## 0.0.83
+
+### Patch Changes
+
+- Updated dependencies [95a5cc6]
+  - llamaindex@0.8.6
+
 ## 0.0.82
 
 ### Patch Changes

e2e/examples/nextjs-node-runtime/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/next-node-runtime-test",
-  "version": "0.0.82",
+  "version": "0.0.85",
   "private": true,
   "scripts": {
     "dev": "next dev",

e2e/examples/nextjs-node-runtime/src/utils/tokenizer.ts

@@ -1,5 +1,5 @@
 // test runtime
-import { Tokenizers, tokenizers } from "@llamaindex/env";
+import { Tokenizers, tokenizers } from "@llamaindex/env/tokenizers";
 import "llamaindex";
 
 // @ts-expect-error EdgeRuntime is not defined in type

e2e/examples/nextjs-node-runtime/tsconfig.json

@@ -1,5 +1,4 @@
 {
-  "extends": "../../../../../tsconfig.json",
   "compilerOptions": {
     "lib": ["dom", "dom.iterable", "esnext"],
     "allowJs": true,

e2e/examples/waku-query-engine/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @llamaindex/waku-query-engine-test
 
+## 0.0.104
+
+### Patch Changes
+
+- Updated dependencies [ad85bd0]
+  - llamaindex@0.8.8
+
+## 0.0.103
+
+### Patch Changes
+
+- llamaindex@0.8.7
+
+## 0.0.102
+
+### Patch Changes
+
+- Updated dependencies [95a5cc6]
+  - llamaindex@0.8.6
+
 ## 0.0.101
 
 ### Patch Changes

e2e/examples/waku-query-engine/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/waku-query-engine-test",
-  "version": "0.0.101",
+  "version": "0.0.104",
   "type": "module",
   "private": true,
   "scripts": {