algoliasearch v5 not building in a typescript project

OutdatedGuy commented 3 months ago

Steps to reproduce:

Create a typescript project (preferably a firebase cloud function project)
Add algoliasearch with below command
```
npm install algoliasearch@5
```
Build the project using tsc command

See below error

> tsc

node_modules/algoliasearch/dist/algoliasearch/builds/node.d.ts:2:48 - error TS2307: Cannot find module '@algolia/client-abtesting/src/abtestingClient' or its corresponding type declarations.

2 import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
                                                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

node_modules/algoliasearch/dist/algoliasearch/builds/node.d.ts:4:48 - error TS2307: Cannot find module '@algolia/client-analytics/src/analyticsClient' or its corresponding type declarations.

4 import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
                                                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

node_modules/algoliasearch/dist/algoliasearch/builds/node.d.ts:7:54 - error TS2307: Cannot find module '@algolia/client-personalization/src/personalizationClient' or its corresponding type declarations.

7 import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
                                                       ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Found 3 errors in the same file, starting at: node_modules/algoliasearch/dist/algoliasearch/builds/node.d.ts:2

Things Already Tried

Updating/installing packages using npm install and npm update
Deleting node_modules dir and reinstalling npm pacages
Clearing all caches and reinstalling and building project

shortcuts commented 3 months ago

Hey @OutdatedGuy thanks for trying out the v5 client

I've not been able to reproduce the error, it compiles correctly on my side.

However from the error you shared, it seems like the peer dependencies of algoliasearch are not installed. If they do not resolve automatically for you, it might be an exports issue on our side.

Was it working with v4? You can also try to install them manually (@algolia/client-personalization and so on), or use the umd bundled file which contains them, usually for the browser env import {algoliasearch} from "algoliasearch/dist/algoliasearch.umd.js"

OutdatedGuy commented 3 months ago

@shortcuts

Was it working with v4?

Yes. On v4 it was working flawlessly but since v5 I cannot build my project :(

You can also try to install them manually (@algolia/client-personalization and so on)

I installed the dependencies mentioned in the error logs with:

npm install @algolia/client-personalization @algolia/client-analytics @algolia/client-abtesting;

but still the same error occurs.

e-compa commented 3 months ago

Hi,

we've encountered the same error, and we were able to work around it by modifying _node_modules/.pnpm/algoliasearch@5.1.1/nodemodules/algoliasearch/dist/algoliasearch/builds/node.d.ts

from this:

import type { AbtestingClient } from '@algolia/client-abtesting';
import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
import type { AnalyticsClient } from '@algolia/client-analytics';
import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
import type { ClientOptions } from '@algolia/client-common';
import type { PersonalizationClient } from '@algolia/client-personalization';
import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
import type { RecommendClient } from '@algolia/recommend';
import type { InitClientOptions, InitClientRegion, GenerateSecuredApiKeyOptions, GetSecuredApiKeyRemainingValidityOptions } from './models';
export * from './models';
export declare const apiClientVersion = "5.1.1";

to this:

import type { AbtestingClient } from '@algolia/client-abtesting';
import type { Region as AbtestingRegion } from '@algolia/client-abtesting/dist/src/abtestingClient';
import type { AnalyticsClient } from '@algolia/client-analytics';
import type { Region as AnalyticsRegion } from '@algolia/client-analytics/dist/src/analyticsClient';
import type { ClientOptions } from '@algolia/client-common';
import type { PersonalizationClient } from '@algolia/client-personalization';
import type { Region as PersonalizationRegion } from '@algolia/client-personalization/dist/src/personalizationClient';
import type { RecommendClient } from '@algolia/recommend';
import type { InitClientOptions, InitClientRegion, GenerateSecuredApiKeyOptions, GetSecuredApiKeyRemainingValidityOptions } from './models';
export * from './models';
export declare const apiClientVersion = "5.1.1";

since the import path does not match the folder structure

zapobyte commented 2 months ago

I have also managed to reproduce this using version "5.1.1".

Some additional info if it matters, I'm on a Windows machine.

shortcuts commented 2 months ago

Hey there, thanks for providing more context to the issue!

Could you please let me know if the latest version fixes the issue on your side?

OutdatedGuy commented 2 months ago

@shortcuts I tried with the latest version (5.2.1) but having the same issue. So I looked into the error file and saw imports whose paths don't exist (@algolia/client-abtesting/src/abtestingClient). So I just updated code to import from base package and it worked.

Basically:

- import type { AbtestingClient } from '@algolia/client-abtesting';
- import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
+ import type { AbtestingClient, Region as AbtestingRegion } from '@algolia/client-abtesting';

Can you re-open the issue?

shortcuts commented 2 months ago

@shortcuts I tried with the latest version (5.2.1) but having the same issue. So I looked into the error file and saw imports whose paths don't exist (@algolia/client-abtesting/src/abtestingClient). So I just updated code to import from base package and it worked.

Basically:
- import type { AbtestingClient } from '@algolia/client-abtesting';
- import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
+ import type { AbtestingClient, Region as AbtestingRegion } from '@algolia/client-abtesting';
Can you re-open the issue?

Hey, thanks for testing it! it was fixed in 5.2.2, could you retry please?

OutdatedGuy commented 2 months ago

Hi, I tried 5.2.2 and it worked. Thanks.

shortcuts commented 2 months ago

Lets goooo enjoy!! Thanks you

valeriangalliat commented 1 month ago

Encountering the same issue with algoliasearch@5.7.0

../../node_modules/@algolia/client-common/src/transporter/helpers.ts(12,5): error TS2322: Type 'TData | undefined' is not assignable to type 'TData'.
  'TData' could be instantiated with an arbitrary type which could be unrelated to 'TData | undefined'.
../../node_modules/@algolia/client-common/src/transporter/helpers.ts(13,5): error TS2322: Type 'TData | undefined' is not assignable to type 'TData'.
  'TData' could be instantiated with an arbitrary type which could be unrelated to 'TData | undefined'.
../../node_modules/@algolia/client-common/src/transporter/helpers.ts(72,5): error TS2322: Type 'string | undefined' is not assignable to type 'string'.
  Type 'undefined' is not assignable to type 'string'.
husky - pre-commit hook exited with code 1 (error)

It seems TypeScript (5.5.4 but also tried with 5.6.2 (latest)) doesn't respect the package.json exports field and still reads node_modules/@algolia/client-common/index.ts and its subtree from src/ instead of the dist/ files.

Removing node_modules/@algolia/client-common/index.ts solves the issue