fix: export type definitions like JSONQuery and JSONQueryOptions

Author: josdejong

src/jsonquery.test.ts

@@ -1,45 +1,62 @@
 import { describe, expect, test } from 'vitest'
-import { buildFunction, compile, jsonquery, parse, stringify } from './jsonquery'
+import {
+  type JSONQuery,
+  type JSONQueryOptions,
+  buildFunction,
+  compile,
+  jsonquery,
+  parse,
+  stringify
+} from './jsonquery'
 
 describe('jsonquery', () => {
   test('should execute a JSON query', () => {
-    expect(jsonquery({ name: 'Joe' }, ['get', 'name'])).toEqual('Joe')
+    const query: JSONQuery = ['get', 'name']
+    expect(jsonquery({ name: 'Joe' }, query)).toEqual('Joe')
   })
 
   test('should execute a text query', () => {
     expect(jsonquery({ name: 'Joe' }, '.name')).toEqual('Joe')
   })
 
   test('should execute a JSON query with custom functions', () => {
-    const functions = {
-      customFn: () => (_data: unknown) => 42
+    const options: JSONQueryOptions = {
+      functions: {
+        customFn: () => (_data: unknown) => 42
+      }
     }
 
-    expect(jsonquery({}, ['customFn'], { functions })).toEqual(42)
+    expect(jsonquery({}, ['customFn'], options)).toEqual(42)
   })
 
   test('should execute a text query with custom functions', () => {
-    const functions = {
-      customFn: () => (_data: unknown) => 42
+    const options: JSONQueryOptions = {
+      functions: {
+        customFn: () => (_data: unknown) => 42
+      }
     }
 
-    expect(jsonquery({ name: 'Joe' }, '.name', { functions })).toEqual('Joe')
+    expect(jsonquery({ name: 'Joe' }, '.name', options)).toEqual('Joe')
   })
 
   test('should execute a JSON query with custom operators', () => {
-    const operators = {
-      aboutEq: '~='
+    const options: JSONQueryOptions = {
+      operators: {
+        aboutEq: '~='
+      }
     }
 
-    expect(jsonquery({ name: 'Joe' }, ['get', 'name'], { operators })).toEqual('Joe')
+    expect(jsonquery({ name: 'Joe' }, ['get', 'name'], options)).toEqual('Joe')
   })
 
   test('should execute a text query with custom operators', () => {
-    const operators = {
-      aboutEq: '~='
+    const options: JSONQueryOptions = {
+      operators: {
+        aboutEq: '~='
+      }
     }
 
-    expect(jsonquery({ name: 'Joe' }, '.name', { operators })).toEqual('Joe')
+    expect(jsonquery({ name: 'Joe' }, '.name', options)).toEqual('Joe')
   })
 
   test('have exported all documented functions', () => {

src/jsonquery.ts

@@ -15,3 +15,5 @@ export { compile } from './compile'
 export { stringify } from './stringify'
 export { parse } from './parse'
 export { buildFunction } from './functions'
+
+export * from './types'