typesense module for Deno

[Sembiance]

It would be awesome if there was a Deno compatible typesense module.

You can almost directly import * as Typsense from src/Typesense.ts but there are some issue:

• Deno requires all local imports to have explict .ts extensions
  So instead of import ApiCall from './ApiCall' use import ApiCall from './ApiCall.ts'
  Also Errors, instead of import { ObjectNotFound } from './Errors' use import { ObjectNotFound } from './Errors/ObjectNotFound.ts'

• Keys.ts needs modified to use the hmac and base64 modules from Deno:
  Change: import { createHmac } from 'crypto' to

import {hmac} from "https://deno.land/x/hmac@v2.0.1/mod.ts";
import {encode as base64Encode} from "https://deno.land/std@0.118.0/encoding/base64.ts"

And change lines

const digest = Buffer.from(createHmac('sha256', searchKey).update(paramsJSON).digest('base64'))
return Buffer.from(rawScopedKey).toString('base64')

to

const digest = hmac("sha256", searchKey, paramsJSON, "utf8", "base64")
return base64Encode(rawScopedKey);

• Configuration.js needs a loglevel replacement. I just used a stub:

this.logger =
{
	trace : v => console.log(v),
	debug : v => console.log(v),
	info : v => console.info(v),
	warn : v => console.warn(v),
	error : v => console.error(v),
	log : v => console.log(v),
	setLevel : () => {}
}

This is where I gave up because there are at least 3 remaining issues:

• Documents.ts needs a ReadStream Deno equilivant

• All of axios needs replaced in ApiCall.ts Maybe you could use the Deno version https://github.com/roonie007/axiod but much more ideally you could use the built in Deno fetch support

• Lastly, there may be other 'nodejs' specific APIs being used in the code that I didn't look for

[jasonbosco]

Thank you for the initial exploration @Sembiance!

CC: @harisarang since you also mentioned you were interested in exploring a Deno version of the library. I'll intro you both in our Slack community to potentially collaborate.

[bradenmacdonald]

@Sembiance I needed a TypeSense Deno client, so I implemented one this week: https://github.com/bradenmacdonald/typesense-deno

Thanks a lot for the research you put in this thread, it saved me some time! If you're curious about the exact changes it took, you can see them in this commit

My use case is fairly limited (indexing documents and generating restricted API keys), so I haven't tested it thoroughly but the parts I am using are working well.

@jasonbosco Let me know if you'd like to move it to the typesense org on GitHub or change it in any way. I'd also like to publish it on https://deno.land/x since that's where most Deno users would look for something like this.

It's also possible to do work to have one version of the code that compiles out to work for either Node or Deno (as I have done with e.g. the Neo4j JavaScript driver), but that can be more work and I think a separate deno-optimized version is preferable in this case :)

[muhaimincs]

Any new version for 2024?

[gabrielstuff]

Would be nice to have an official Deno client version and a node version that does not rely on axios.
I tried to :

import * as typesense from "https://esm.sh/typesense@2.0.1";

Unfortunately, it throws

Stack trace:
TypeError: Cannot read properties of undefined (reading 'href')
    at https://esm.sh/axios@1.7.9/denonext/lib/platform/index.mjs:2:752

[gabrielstuff]

Actually reading through #161 and #255 I understand we can set the axios adaptater: axiosAdapter: 'fetch'

So now, running the following in a deno env works:

import Typesense from "npm:typesense@2.0.1";
const typesenseClient = new Typesense.Client({
  nodes: [
    {
      host: ,
      port: '443',
      protocol: 'https'
    }
  ],
  apiKey: 'xxxxx',
  connectionTimeoutSeconds: 2
})

const mySchema = {
  name: 'demo_from_deno',
  fields: [
    { name: 'id', type: 'string' },
    { name: 'title', type: 'string' },
  ]
}

await typesenseClient.collections().create(mySchema)