FuseSortFunctionItem typing is incorrect

[isaachinman]

Is there an existing issue for this?

• I have searched the existing issues

Description of the bug

Just getting up and running with Fuse. It seems the type def for FuseSortFunctionItem is incorrect:

type FuseSortFunctionItem = {
  [key: string]: { $: string } | { $: string; idx: number }[]
}

If I log the output of sortFn: (a, b) => ..., I see:

{
  "idx": 84,
  "item": {
    "0": {
      "v": "todo-tf9oxpoi82b",
      "n": 1
    },
    "1": {
      "v": "2024-12-01T14:50:54.748Z",
      "n": 1
    }
  },
  "matches": [
    {
      "score": 0,
      "key": {
        "path": [
          "id"
        ],
        "id": "id",
        "weight": 0.5,
        "src": "id",
        "getFn": null
      },
      "value": "todo-tf9oxpoi82b",
      "norm": 1
    }
  ],
  "score": 1.4901161193847656e-8
}

So, FuseSortFunctionItem is neither [key: string]: { $: string }, nor { $: string; idx: number }[].

Note that I am on v7.0.0, which I cannot select in the GitHub issue template dropdown. That said, I see the exact same output if I rollback to v6.6.2.

Edit: I've found other occurrences of broken types now, as well. It seems the FuseIndex type itself is wrong – it is missing records, docs, norm, etc. I would be very happy to help improve the typing if you are open to PRs!

The Fuse.js version where this bug is happening.

6.6.2

Is this a regression?

• This is a regression bug

Which version did this behavior use to work in?

None

Steps To Reproduce

const keys = [
  'id',
  {
    getFn: (todo: Todo) => todo.messages[0].date,
    name: 'date'
  }
]

const index = Fuse.createIndex<Todo>(keys, [])

const fuse = new Fuse<Todo>(
  [],
  {
    findAllMatches: true,
    keys,
    sortFn: (a, b) => {
      console.log({
        sortFnA: JSON.stringify(a),
      })
    },
    useExtendedSearch: true,
  },
  index,
)

Expected behavior

Correct types.

Screenshots

No response

Additional context

No response

[github-actions]

This issue is stale because it has been open 120 days with no activity. Remove stale label or comment or this will be closed in 30 days

[isaachinman]