Missing typing for sqlite3Worker1Promiser

[realGriss]

Type

Bug Report

Description

Hi,

I still get typing problems in the current version "3.51.2-build7". Trying to import with

import { sqlite3Worker1Promiser } from '@sqlite.org/sqlite-wasm'

gives me an error. This should be fixed with #54 Or am I missing something?

[jurerotar]

Hey, thank you for raising this! 😄

I'll take a look and keep you updated!

[jurerotar]

Sorry about this! I've prepared a PR (#156) that should resolve this issue. I've also touched a bit on the types, specifically Worker1Promiser type is now exported, so you'll be able to use it for explicitly typing your variable, should you need to, and specific calls like config-get should now no longer require redundant second arguments 😄

[mmomtchev]

The Node.js version (dist/node.mjs) does not export it. I think this is the problem.

[tomayac]

Fixed by #156.

[jurerotar]

@realGriss, new release was just published, please let me know if the issue is solved! 😄

[realGriss]

Types seems to work fine now. Thanks for the quick update.

The only problem I'm running into is that I get a error with the current example:

import {
  sqlite3Worker1Promiser,
  type Worker1Promiser,
} from '@sqlite.org/sqlite-wasm';

const log = console.log;
const error = console.error;

const initializeSQLite = async () => {
  try {
    log('Loading and initializing SQLite3 module...');

    const promiser = await new Promise<Worker1Promiser>((resolve) => {
      sqlite3Worker1Promiser({
        onready: resolve,
      });
    });

    log('Done initializing. Running demo...');

    const configResponse = await promiser('config-get');
    log('Running SQLite3 version', configResponse.result.version.libVersion);

    const openResponse = await promiser('open', {
      filename: 'file:mydb.sqlite3?vfs=opfs',
    });
    const { dbId } = openResponse;
    log(
      'OPFS is available, created persisted database at',
      openResponse.result.filename.replace(/^file:(.*?)\?vfs=opfs$/, '$1'),
    );
    // Your SQLite code here.
  } catch (err) {
    if (!(err instanceof Error)) {
      err = new Error(err.result.message);
    }
    error(err.name, err.message);
  }
};

await initializeSQLite();

TypeError: Cannot create property 'dbId' on string 'config-get'

Not sure if I'm doing something wrong here or this is a bug.

Edit:
It works if I use it like this:

promiser('config-get', {});

[jurerotar]

Not sure if I'm doing something wrong here or this is a bug

This is on me, being overzealous with the type improvements. Promiser API makes an explicit check for amount of parameters and assigns properties based on it. I missed that, sorry!

I don't want to bother tomayac with preparing yet another build, so I'll just prepare a PR that updates the example and makes sure the types require all required params from now on 😄

[solodeveloping]

The first example in the doc is still not working for me, I went back to using the example types in one of the threads.

I get this in vscode: "Type '(value: any) => void' is not assignable to type 'OnreadyFunction'.
Target signature provides too few arguments. Expected 1 or more, but got 0."

And then the other methods are not typed either 😥

[jurerotar]

Thank you for raising the issue, I have the fix ready! 😄

@tomayac, should we update the README promiser example to v2 style (using promises instead of callbacks)? It's a bit cleaner imo 😄

const initializeSQLite = async () => {
  try {
    console.log('Loading and initializing SQLite3 module (v2 promise style)...');

    const promiser = await sqlite3Worker1Promiser.v2();

    console.log('Done initializing (v2 promise style). Running demo...');

    const configResponse = await promiser('config-get', {});
    console.log('Running SQLite3 version', configResponse.result.version.libVersion);

    const openResponse = await promiser('open', {
      filename: 'file:mydb-v2.sqlite3?vfs=opfs',
    });
    console.log(
      'OPFS is available, created persisted database at',
      openResponse.result.filename.replace(/^file:(.*?)\?vfs=opfs$/, '$1'),
    );
  } catch (err: any) {
    if (!(err instanceof Error)) {
      err = new Error(err.result.message || 'Unknown error');
    }
    console.error(err.name, err.message);
  }
};

[tomayac]

I'd happily merge a quick PR that does that, yes.

[jurerotar]

I opened a PR here: #160

I tried both v1 and v2 api versions and types seemed to work fine. Hopefully I didn't miss anything 😄

[solodeveloping]

It's strange, in the current version, I have an error indicating that the v2 is not a function, and the default version seem to be the v2 when debugging the code.

Is it normal?

[jurerotar]

It's strange, in the current version, I have an error indicating that the v2 is not a function

Current version is incorrect. This PR should resolve this, see here: https://github.com/sqlite/sqlite-wasm/pull/160/changes#diff-619cc2239a7eb4ef05041767e6ab0e4fb069e98ee9d2c83c2d8e1865c475e141

@tomayac, could I ask for a new release, please? 😄

[tomayac]

Released as https://github.com/sqlite/sqlite-wasm/releases/tag/3.51.2-build9. Thanks for the work on this!