#community-help

Typesense js client upgrade: API key and SearchClient issues

TLDR Janaka had issues with the API key showing in the query string after upgrading the Typesense js client and noticed a change in the retrieve() method's behavior. Jason explained the change and advised on the API key issue, asking Janaka to create a Github issue for it which was done.

24mo

Join the chat

Jan 15, 2022 (24 months ago)

Photo of md5-3ecfadbfb82a962691e2d6cb42f876b4

Janaka

02:49 PM

Hey all, long time. It's been a couple of months since I last hacked on top of Typesense. Upgraded the js client to see if it resolved a minor issue I was spotting in js client v0.14.0 (API key was appearing in query string even with the respective config set to false)

My app broke 😅. The cause a breaking change in the client lib API introduced in v1.0.0-3. Seems like this change. I'm unblocked now but thought I'd share some details and check if I'm missing somewhere that tracks the js client API changes? it doesn't seen to mirror what on the docs site.

Since then collection('mycollectionname').retrieve() returns a different type. It used to return as per the docs here. I'm using the SearchClient and accessing the num_documents property. In the PR I see references to a SearchOnlyCollection. I've not managed to find docs for this type. Am I missing something?

02:55

Janaka

02:55 PM

re: api key passed in the query string

on js client v1.1.3-0 it's still doing it. In code I see the default is supposed to be false . Even when the client instantiation config has sendApiKeyAsQueryParam: false,

Photo of md5-8813087cccc512313602b6d9f9ece19f

Jason

04:50 PM

Janaka SearchClient does not expose a collection('name').retrieve() method. It is meant to only allow searches on documents.

If you use Client instead, you should see num_documents like this:

04:51

Jason

04:51 PM

Here's where it's defined: https://github.com/typesense/typesense-js/blob/fec463676eaea3e6a1f32c397e292cd37f3b696b/src/Typesense/Collection.ts#L37

04:57

Jason

04:57 PM

re: API Key, looks like in the SearchClient we force sending the API key as a query param and ignore the configuration: https://github.com/typesense/typesense-js/blob/a21d4101bc21fe59e0e85b41e64ba14d6fe88667/src/Typesense/SearchClient.ts#L14-L17

That almost sounds like a bug... Could you open a Github issue for this? I think we should respect the config passed into the config

Janaka

04:59 PM

Can you expand on "only search on documents" pls? In contrast to?

Jason

05:00 PM

In contrast to allowing all operations on collections like retrieve

05:01

Jason

05:01 PM

SearchClient is intended to only be used for search in say the browser to reduce bundle size.

Client has all the methods that Typesense supports

Janaka

09:55 PM

gotcha. makes sense. sorry, was a slightly silly question to ask.

Jan 16, 2022 (24 months ago)

Janaka

07:20 PM

Created an GH issue for sendApiKeyAsQueryParam 🙏

Typesense

Lightning-fast, open source search engine for everyone | Knowledge Base powered by Struct.AI

Indexed 3015 threads (79% resolved)

Join Our Community

Similar Threads

Resolving Typesense Server Connection with Correct API Keys and Paths

Rubai had trouble creating a working API key for Typesense and understanding number_hits versus num_documents. Jason provided clarification and correct code for generating a search-only API Key and using correct server configurations.

4mo

Resolving Issues with Scoped API Keys in Typesense with Golang

Suvarna had problems with generating and using scoped API keys in Typesense with Golang. Several bugs misleading the user were found and fixed by Kishore Nallan.

158

28mo

Issues with Generating Scope API Keys in Python

Danny had issues generating a valid scope API key in a Python GraphQL server. Jason suggested encoding changes and confirmed that the key length varies. Issue unresolved with Python, although JS library worked.

19mo

Trouble Spotting API Error in Dart vs Shell Operations

Erick is having issues with the typesense API, receiving errors in Dart that are not present in shell operations. Despite Kishore Nallan trying to help, no solution has been found, leading Erick to post the issue on the dart client repository.

23mo

Troubleshooting Typesense Document Update Error

Mehdi had an issue with updating Typesense documents which returned a '404 Not Found' error. Kishore Nallan after several debugging steps, discovered Mehdi was using an outdated Typesense version. The issue was resolved after upgrading Typesense.

30mo