fix(env): align export APIs

.changeset/early-kings-flash.md

@@ -0,0 +1,5 @@
+---
+"@llamaindex/env": patch
+---
+
+fix(env): align export APIs

packages/env/package.json

@@ -3,8 +3,9 @@
   "description": "environment wrapper, supports all JS environment including node, deno, bun, edge runtime, and cloudflare worker",
   "version": "0.1.14",
   "type": "module",
-  "types": "dist/type/index.d.ts",
-  "main": "dist/cjs/index.js",
+  "types": "dist/index.d.ts",
+  "module": "dist/index.js",
+  "main": "dist/index.cjs",
   "keywords": [
     "llm",
     "llama",
@@ -24,29 +25,30 @@
   "exports": {
     ".": {
       "node": {
-        "types": "./dist/type/index.d.ts",
+        "types": "./dist/index.d.ts",
         "import": "./dist/index.js",
-        "default": "./dist/cjs/index.js"
+        "require": "./dist/index.cjs",
+        "default": "./dist/index.cjs"
       },
       "workerd": {
-        "types": "./dist/type/index.workerd.d.ts",
+        "types": "./dist/index.workerd.d.ts",
         "default": "./dist/index.workerd.js"
       },
       "edge-light": {
-        "types": "./dist/type/index.edge-light.d.ts",
+        "types": "./dist/index.edge-light.d.ts",
         "default": "./dist/index.edge-light.js"
       },
       "browser": {
-        "types": "./dist/type/index.browser.d.ts",
+        "types": "./dist/index.browser.d.ts",
         "default": "./dist/index.browser.js"
       },
       "import": {
-        "types": "./dist/type/index.d.ts",
+        "types": "./dist/index.d.ts",
         "default": "./dist/index.js"
       },
       "require": {
-        "types": "./dist/type/index.d.ts",
-        "default": "./dist/cjs/index.js"
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
       }
     }
   },
@@ -61,27 +63,19 @@
     "directory": "packages/env"
   },
   "scripts": {
-    "build": "rm -rf ./dist && pnpm run build:esm && pnpm run build:cjs && pnpm run build:type",
-    "build:esm": "swc src -d dist --strip-leading-paths --config-file ../../.swcrc",
-    "build:cjs": "swc src -d dist/cjs --strip-leading-paths --config-file ../../.cjs.swcrc",
-    "build:type": "tsc -p tsconfig.json",
-    "postbuild": "node -e \"require('fs').writeFileSync('./dist/cjs/package.json', JSON.stringify({ type: 'commonjs' }))\"",
-    "dev": "concurrently \"pnpm run build:esm --watch\" \"pnpm run build:cjs --watch\" \"pnpm run build:type --watch\"",
+    "dev": "bunchee --watch",
+    "build": "bunchee",
     "test": "vitest"
   },
   "devDependencies": {
-    "@aws-crypto/sha256-js": "^5.2.0",
-    "@swc/cli": "^0.4.0",
-    "@swc/core": "^1.7.22",
+    "@types/node": "^22.5.1",
+    "@types/readable-stream": "^4.0.15",
     "@xenova/transformers": "^2.17.2",
-    "concurrently": "^8.2.2",
+    "bunchee": "5.5.1",
     "gpt-tokenizer": "^2.5.0",
     "pathe": "^1.1.2",
     "vitest": "^2.0.5"
   },
-  "dependencies": {
-    "@types/node": "^22.5.1"
-  },
   "peerDependencies": {
     "@aws-crypto/sha256-js": "^5.2.0",
     "@xenova/transformers": "^2.17.2",

packages/env/src/fs/memory.ts

@@ -5,4 +5,7 @@
  */
 import memFS from "./memfs/index.js";
 
+export function createWriteStream() {
+  throw new Error("Not supported in this environment.");
+}
 export const fs = memFS.promises;

packages/env/src/index.browser.ts

@@ -4,7 +4,6 @@
  * @module
  */
 import "./global-check.js";
-export * from "./web-polyfill.js";
 
 export { consoleLogger, emptyLogger, type Logger } from "./logger/index.js";
 export {
@@ -15,6 +14,7 @@ export {
 } from "./multi-model/index.browser.js";
 export { Tokenizers, tokenizers, type Tokenizer } from "./tokenizers/js.js";
 export { NotSupportCurrentRuntimeClass } from "./utils/shared.js";
+export * from "./web-polyfill.js";
 // @ts-expect-error
 if (typeof window === "undefined") {
   console.warn(

packages/env/src/index.edge-light.ts

@@ -4,14 +4,13 @@
  * @module
  */
 import "./global-check.js";
-export * from "./node-polyfill.js";
-
 export { consoleLogger, emptyLogger, type Logger } from "./logger/index.js";
 export {
   loadTransformers,
   setTransformers,
   type LoadTransformerEvent,
   type OnLoad,
 } from "./multi-model/index.non-nodejs.js";
+export * from "./node-polyfill.js";
 export { Tokenizers, tokenizers, type Tokenizer } from "./tokenizers/js.js";
 export { NotSupportCurrentRuntimeClass } from "./utils/shared.js";

packages/env/src/node-polyfill.ts

@@ -9,9 +9,12 @@
  */
 import { Sha256 } from "@aws-crypto/sha256-js";
 import pathe from "pathe";
-import { fs } from "./fs/memory.js";
+import { NotSupportCurrentRuntimeClass } from "./utils/shared.js";
 
-export { fs, pathe as path };
+export { createWriteStream, fs } from "./fs/memory.js";
+export { fileURLToPath } from "./url/index.js";
+export { pathe as path };
+export const Readable = NotSupportCurrentRuntimeClass.bind("non-Node.js");
 
 export interface SHA256 {
   update(data: string | Uint8Array): void;

packages/env/src/url/index.ts

@@ -0,0 +1,172 @@
+// Copyright (c) 2000-2006, The Perl Foundation.
+//
+// 	Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+//
+// 	Preamble
+//
+// This license establishes the terms under which a given free software Package may be copied, modified, distributed, and/or redistributed. The intent is that the Copyright Holder maintains some artistic control over the development of that Package while still keeping the Package available as open source and free software.
+//
+// 	You are always permitted to make arrangements wholly outside of this license directly with the Copyright Holder of a given Package.  If the terms of this license do not permit the full use that you propose to make of the Package, you should contact the Copyright Holder and seek a different licensing arrangement.
+//
+// 	Definitions
+//
+// "Copyright Holder" means the individual(s) or organization(s) named in the copyright notice for the entire Package.
+//
+// "Contributor" means any party that has contributed code or other material to the Package, in accordance with the Copyright Holder's procedures.
+//
+// "You" and "your" means any person who would like to copy, distribute, or modify the Package.
+//
+// "Package" means the collection of files distributed by the Copyright Holder, and derivatives of that collection and/or of those files. A given Package may consist of either the Standard Version, or a Modified Version.
+//
+// "Distribute" means providing a copy of the Package or making it accessible to anyone else, or in the case of a company or organization, to others outside of your company or organization.
+//
+// "Distributor Fee" means any fee that you charge for Distributing this Package or providing support for this Package to another party.  It does not mean licensing fees.
+//
+// "Standard Version" refers to the Package if it has not been modified, or has been modified only in ways explicitly requested by the Copyright Holder.
+//
+// "Modified Version" means the Package, if it has been changed, and such changes were not explicitly requested by the Copyright Holder.
+//
+// "Original License" means this Artistic License as Distributed with the Standard Version of the Package, in its current version or as it may be modified by The Perl Foundation in the future.
+//
+// "Source" form means the source code, documentation source, and configuration files for the Package.
+//
+// "Compiled" form means the compiled bytecode, object code, binary, or any other form resulting from mechanical transformation or translation of the Source form.
+//
+// 	Permission for Use and Modification Without Distribution
+//
+// (1) You are permitted to use the Standard Version and create and use Modified Versions for any purpose without restriction, provided that you do not Distribute the Modified Version.
+//
+// 	Permissions for Redistribution of the Standard Version
+//
+// (2) You may Distribute verbatim copies of the Source form of the Standard Version of this Package in any medium without restriction, either gratis or for a Distributor Fee, provided that you duplicate all of the original copyright notices and associated disclaimers.  At your discretion, such verbatim copies may or may not include a Compiled form of the Package.
+//
+// 	(3) You may apply any bug fixes, portability changes, and other modifications made available from the Copyright Holder.  The resulting Package will still be considered the Standard Version, and as such will be subject to the Original License.
+//
+// 	Distribution of Modified Versions of the Package as Source
+//
+// (4) You may Distribute your Modified Version as Source (either gratis or for a Distributor Fee, and with or without a Compiled form of the Modified Version) provided that you clearly document how it differs from the Standard Version, including, but not limited to, documenting any non-standard features, executables, or modules, and provided that you do at least ONE of the following:
+//
+// 	(a) make the Modified Version available to the Copyright Holder of the Standard Version, under the Original License, so that the Copyright Holder may include your modifications in the Standard Version.
+// 	(b) ensure that installation of your Modified Version does not prevent the user installing or running the Standard Version. In addition, the Modified Version must bear a name that is different from the name of the Standard Version.
+// 	(c) allow anyone who receives a copy of the Modified Version to make the Source form of the Modified Version available to others under
+//
+// (i) the Original License or
+// (ii) a license that permits the licensee to freely copy, modify and redistribute the Modified Version using the same licensing terms that apply to the copy that the licensee received, and requires that the Source form of the Modified Version, and of any works derived from it, be made freely available in that license fees are prohibited but Distributor Fees are allowed.
+//
+// 	Distribution of Compiled Forms of the Standard Version or Modified Versions without the Source
+//
+// (5)  You may Distribute Compiled forms of the Standard Version without the Source, provided that you include complete instructions on how to get the Source of the Standard Version.  Such instructions must be valid at the time of your distribution.  If these instructions, at any time while you are carrying out such distribution, become invalid, you must provide new instructions on demand or cease further distribution. If you provide valid instructions or cease distribution within thirty days after you become aware that the instructions are invalid, then you do not forfeit any of your rights under this license.
+//
+// 	(6)  You may Distribute a Modified Version in Compiled form without the Source, provided that you comply with Section 4 with respect to the Source of the Modified Version.
+//
+// 	Aggregating or Linking the Package
+//
+// (7)  You may aggregate the Package (either the Standard Version or Modified Version) with other packages and Distribute the resulting aggregation provided that you do not charge a licensing fee for the Package.  Distributor Fees are permitted, and licensing fees for other components in the aggregation are permitted. The terms of this license apply to the use and Distribution of the Standard or Modified Versions as included in the aggregation.
+//
+// 	(8) You are permitted to link Modified and Standard Versions with other works, to embed the Package in a larger work of your own, or to build stand-alone binary or bytecode versions of applications that include the Package, and Distribute the result without restriction, provided the result does not expose a direct interface to the Package.
+//
+// 	Items That are Not Considered Part of a Modified Version
+//
+// (9) Works (including, but not limited to, modules and scripts) that merely extend or make use of the Package, do not, by themselves, cause the Package to be a Modified Version.  In addition, such works are not considered parts of the Package itself, and are not subject to the terms of this license.
+//
+// 	General Provisions
+//
+// (10)  Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.
+//
+// 	(11)  If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.
+//
+// 	(12)  This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
+//
+// 	(13)  This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.
+//
+// 	(14)  Disclaimer of Warranty:
+// 	THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+/**
+ * This function ensures the correct decodings of percent-encoded characters as
+ * well as ensuring a cross-platform valid absolute path string.
+ */
+export function fileURLToPath(href: string, separator: string): string {
+  // conform with Node.js fileURLToPath
+  if (!href.includes(":/")) {
+    const error = new Error("Invalid URL") as any;
+    error.code = "ERR_INVALID_URL";
+    throw error;
+  }
+  if (!href.startsWith("file:")) {
+    const error = new Error("The URL must be of scheme file") as any;
+    error.code = "ERR_INVALID_URL_SCHEME";
+    throw error;
+  }
+
+  // https://en.wikipedia.org/wiki/File_URI_scheme#Examples
+  // https://nodejs.org/api/url.html#urlfileurltopathurl
+  // file:/path (no hostname)
+  // file://hostname/path
+  // file:///path (empty hostname)
+  let file;
+  if (separator === "\\") {
+    // is windows
+    if (href.startsWith("file:///")) {
+      // is full path, e.g. file:///foo
+      file = href.substring(8);
+      if (file[1] !== ":") {
+        const error = new Error("File URL path must be absolute") as any;
+        error.code = "ERR_INVALID_FILE_URL_PATH";
+        throw error;
+      }
+    } else if (href.startsWith("file://localhost/")) {
+      // is localhost path, e.g. file://localhost/foo
+      // conform with Node.js fileURLToPath
+      file = href.substring(17); // trim leading slash
+      if (file[1] !== ":") {
+        const error = new Error("File URL path must be absolute") as any;
+        error.code = "ERR_INVALID_FILE_URL_PATH";
+        throw error;
+      }
+    } else if (href.startsWith("file://")) {
+      // is host path, e.g. file://hostname/foo
+      // conform with Node.js fileURLToPath, which does not error
+      file = href.substring(7);
+      file = separator + separator + file;
+    } else if (href.startsWith("file:/")) {
+      // is full path with unknown drive letter
+      // conform with Node.js fileURLToPath
+      file = href.substring(6);
+      if (file[1] !== ":") {
+        const error = new Error("File URL path must be absolute") as any;
+        error.code = "ERR_INVALID_FILE_URL_PATH";
+        throw error;
+      }
+    } else {
+      file = href;
+    }
+
+    // replace slashes with backslashes
+    file = file.replace(/[/]/g, separator);
+  } else if (separator === "/") {
+    // is posix
+    if (href.startsWith("file:///")) {
+      // is full path, e.g. file:///foo
+      file = href.substring(7); // keep leading slash
+    } else if (href.startsWith("file://")) {
+      // is host path, e.g. file://localhost/foo
+      if (!href.startsWith("file://localhost/")) {
+        const error = new Error(
+          'File URL host must be "localhost" or empty',
+        ) as any;
+        error.code = "ERR_INVALID_FILE_URL_HOST";
+        throw error;
+      }
+      file = href.substring(16); // keep leading slash
+    } else if (href.startsWith("file:/")) {
+      // is full path, e.g. file:/foo
+      file = href.substring(5); // keep leading slash
+    } else {
+      file = href;
+    }
+  } else {
+    file = href;
+  }
+  return file;
+}

packages/env/src/web-polyfill.ts

@@ -9,9 +9,12 @@
  */
 import { Sha256 } from "@aws-crypto/sha256-js";
 import pathe from "pathe";
-import { fs } from "./fs/memory.js";
+import { NotSupportCurrentRuntimeClass } from "./utils/shared.js";
 
-export { fs, pathe as path };
+export { createWriteStream, fs } from "./fs/memory.js";
+export { fileURLToPath } from "./url/index.js";
+export { pathe as path };
+export const Readable = NotSupportCurrentRuntimeClass.bind("browser");
 
 export interface SHA256 {
   update(data: string | Uint8Array): void;

packages/llamaindex/package.json

@@ -54,6 +54,7 @@
     "ajv": "^8.17.1",
     "assemblyai": "^4.7.0",
     "chromadb": "1.9.2",
+    "chromadb-default-embed": "^2.13.2",
     "cohere-ai": "7.13.0",
     "discord-api-types": "^0.37.98",
     "gpt-tokenizer": "^2.5.0",