Fix #538 (#541)

packages/docs/pages/open-source/usage/typescript.mdx

@@ -4,6 +4,8 @@ import { Callout } from 'nextra-theme-docs'
 
 ## Usage
 
+You may want to types your variables. If needed, you can do it like this:
+
 ```ts copy
 import type { TypedDocument, Orama, Results, SearchParams } from '@orama/orama'
 import { create, insert, search } from '@orama/orama'
@@ -35,6 +37,29 @@ const result: Results<MovieDocument> = await search(movieDB, searchParams)
 const title = result.hits[0].document.title // well typed!
 ```
 
+## Enrich type of documents
+
+Orama schema considers only the properties that are indexed.
+Anyway, the added documents can have other properties that are not indexed.
+The following example shows how to enrich the type of the documents.
+
+```ts copy
+const movieSchema = {
+  title: 'string',
+} as const
+const db = await create({ schema: movieSchema })
+
+interface Movie {
+  title: string,
+  year: number,
+}
+
+//             this is important ---v
+const r = await search<typeof db, Movie>(db, { term: '' })
+const title = r.hits[0].document.title // well typed!
+const year = r.hits[0].document.year // well typed!
+```
+
 ## Configuration
 
 Set `moduleResolution` in the `compilerOptions` in your `tsconfig.json` to be either `Node16` or `NodeNext`.

packages/orama/tests/type/issue_538.test-d.ts

@@ -0,0 +1,18 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+// https://github.com/oramasearch/orama/issues/538
+import { expectAssignable } from 'tsd'
+import { create, search } from '../../src/index.ts'
+
+const movieSchema = {
+  title: 'string',
+} as const
+const db = await create({ schema: movieSchema })
+
+interface Movie {
+  title: string,
+  year: number,
+}
+
+const r = await search<typeof db, Movie>(db, { term: '' })
+expectAssignable<string>(r.hits[0].document.title)
+expectAssignable<number>(r.hits[0].document.year)