tsc error? Should llama-index-core support module="commonjs"

[hughesadam87]

We have a nodejs project that has been working fine for a couple of years but adding llamaindex-core to it caused the tsc (typescript compiler) step to fail.

{
  "compilerOptions": {
    "target": "es2020",
    "module": "commonjs",
    "skipLibCheck": true, // For llama-index compatability - turn off compiler checks on node_modules
    "esModuleInterop": true,
    "outDir": "./dist",
    "noImplicitAny": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules"]
}

To workaround we had to enable skipLibCheck. Without it - we're getting these types of errors

There are types at 'C:/Users/adam.hughes/PycharmProjects/ask/ask-server/node_modules/@llamaindex/env/tokenizers/dist/index.d.ts', but this result could not be resolved under your current 'moduleResolution' setting. Consider updating to 'node16', 'nodenext', or 'bundler'.

1 import { Tokenizers } from '@llamaindex/env/tokenizers';

node_modules/@llamaindex/core/llms/dist/index.d.ts:2:10 - error TS2305: Module '"ajv"' has no exported member 'JSONSchemaType'.

2 import { JSONSchemaType } from 'ajv';

Changing commjs to nodenext resolves some of the issues but still seeing

node_modules/@llamaindex/core/llms/dist/index.d.cts:2:10 - error TS2305: Module '"ajv"' has no exported member 'JSONSchemaType'.

2 import { JSONSchemaType } from 'ajv';
           ~~~~~~~~~~~~~~

node_modules/@llamaindex/core/llms/dist/index.d.ts:2:10 - error TS2305: Module '"ajv"' has no exported member 'JSONSchemaType'.

2 import { JSONSchemaType } from 'ajv';

I checked my packagelock.json and we're using an older version of ajv

    "node_modules/ajv": {
      "version": "6.12.6",
      "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
      "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
      "dev": true,
      "dependencies": {
        "fast-deep-equal": "^3.1.1",
        "fast-json-stable-stringify": "^2.0.0",
        "json-schema-traverse": "^0.4.1",
        "uri-js": "^4.2.2"
      },
      "funding": {
        "type": "github",
        "url": "https://github.com/sponsors/epoberezkin"
      }

But I installed the latest version npm i ajv to version ^8.17.1 - which kicks the can to

node_modules/@llamaindex/core/llms/dist/index.d.cts:175:50 - error TS2344: Type 'string' does not satisfy the constraint 'Record<string, unknown>'.

175     metadata: Input extends Known ? ToolMetadata<JSONSchemaType<Input>> : ToolMetadata;
                                                     ~~~~~~~~~~~~~~~~~~~~~

Any suggestions?

[marcusschiesser]

Thanks just, released that we don't need ajv in llamaindex, so I will release: #2012

Why are you using @llamaindex/core and not llamaindex - we have tests and llamaindex should work with commonjs

[hughesadam87]

Thanks! TBH I'm using @llamaindex/core because I want only a few of the shared types (ie. ChatMessage) and I probably GPT told me to use core.... our main use case is to unify requests between llm providers. Other than that, wanted to keep the dependencies as light as possible.

This is my package.json

    "@llamaindex/aws": "^0.0.104",
    "@llamaindex/core": "^0.6.9",
    "@llamaindex/google": "^0.3.7",

What is the difference between llamaindex/core and llamaindex?

[marcusschiesser]

@llamaindex/core is just used internally inside the project, package size should not be that much different to llamaindex - the contract for the later is more stable and it aggregates functionality.

[hughesadam87]

@marcusschiesser - I have tried to patch it. Here's what I did:

1. Completely npm uninstall llamaindex, purge node-modules and dist folders
2. npm i llamaindex @llamaindex/aws @llamaindex/google

Now my package.json has these

"@llamaindex/aws": "^0.0.107",
"@llamaindex/google": "^0.3.11",
"llamaindex": "^0.11.11",

I left the tsconfig.json as before, but set skipLibCheck: False (using True before as the workaround)

{
"compilerOptions": {
"target": "es2020",
"module": "commonjs",
"skipLibCheck": false, // Skip type checking of declaration files (.d.ts) in node_modules to speed up compilation
"esModuleInterop": true,
"outDir": "./dist",
"noImplicitAny": true
},
"include": ["src/**/"],
"exclude": ["node_modules"]
}

Note in my app the imports still refer to @llamaindex/core/llms

 import type {ChatMessage} from '@llamaindex/core/llms';

Which seems correct given that @llamaindex/core is still the correct path in the node modules folder

Seeing erros like this

[marcusschiesser]

Can you try not using core?

[hughesadam87]

I did remove core explicitly from package.json - these are the dependencies now

"@llamaindex/aws": "^0.0.107",
"@llamaindex/google": "^0.3.11",
"llamaindex": "^0.11.11",

But how can I import ChatMessage without referencing core?

import type {ChatMessage} from '@llamaindex/core/llms';

@llamaindex/core is being installed implicitly by the depenency on llamaindex: ^0.11.11