@nixxie-cms/search 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +23 -0
- package/README.md +42 -0
- package/dist/declarations/src/AlgoliaSearch.d.ts +17 -0
- package/dist/declarations/src/AlgoliaSearch.d.ts.map +1 -0
- package/dist/declarations/src/ElasticsearchSearch.d.ts +15 -0
- package/dist/declarations/src/ElasticsearchSearch.d.ts.map +1 -0
- package/dist/declarations/src/InMemorySearch.d.ts +18 -0
- package/dist/declarations/src/InMemorySearch.d.ts.map +1 -0
- package/dist/declarations/src/MeilisearchSearch.d.ts +15 -0
- package/dist/declarations/src/MeilisearchSearch.d.ts.map +1 -0
- package/dist/declarations/src/TypesenseSearch.d.ts +22 -0
- package/dist/declarations/src/TypesenseSearch.d.ts.map +1 -0
- package/dist/declarations/src/index.d.ts +11 -0
- package/dist/declarations/src/index.d.ts.map +1 -0
- package/dist/declarations/src/types.d.ts +48 -0
- package/dist/declarations/src/types.d.ts.map +1 -0
- package/dist/nixxie-cms-search.cjs.d.ts +2 -0
- package/dist/nixxie-cms-search.cjs.js +433 -0
- package/dist/nixxie-cms-search.esm.js +424 -0
- package/package.json +33 -0
- package/src/AlgoliaSearch.ts +97 -0
- package/src/ElasticsearchSearch.ts +96 -0
- package/src/InMemorySearch.ts +101 -0
- package/src/MeilisearchSearch.ts +72 -0
- package/src/TypesenseSearch.ts +98 -0
- package/src/index.ts +44 -0
- package/src/types.ts +71 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Nixxie International DMCC
|
|
4
|
+
Portions Copyright (c) 2023 Thinkmill Labs Pty Ltd and contributors
|
|
5
|
+
(this software is derived from the KeystoneJS project, https://keystonejs.com)
|
|
6
|
+
|
|
7
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
8
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
9
|
+
in the Software without restriction, including without limitation the rights
|
|
10
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
11
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
12
|
+
furnished to do so, subject to the following conditions:
|
|
13
|
+
|
|
14
|
+
The above copyright notice and this permission notice shall be included in all
|
|
15
|
+
copies or substantial portions of the Software.
|
|
16
|
+
|
|
17
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
18
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
19
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
20
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
21
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
22
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
23
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# @nixxie-cms/search
|
|
2
|
+
|
|
3
|
+
Pluggable full-text search for Nixxie CMS. One interface, five drivers: in-memory (dev/test),
|
|
4
|
+
Meilisearch, Typesense, Algolia and Elasticsearch. The external drivers talk to their HTTP APIs
|
|
5
|
+
directly, so there are **no SDK dependencies** to install.
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import { config } from '@nixxie-cms/core'
|
|
9
|
+
import { createSearch } from '@nixxie-cms/search'
|
|
10
|
+
|
|
11
|
+
export default config({
|
|
12
|
+
search: createSearch({ driver: 'meilisearch', url: 'http://localhost:7700', apiKey: '...' }),
|
|
13
|
+
// ...
|
|
14
|
+
})
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Available everywhere as `context.services.search`:
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
// Keep the index in sync from list hooks
|
|
21
|
+
await context.services.search.index('posts', { id: post.id, title: post.title, body: post.body })
|
|
22
|
+
|
|
23
|
+
// Query
|
|
24
|
+
const { hits, total } = await context.services.search.search('posts', {
|
|
25
|
+
q: 'headless cms',
|
|
26
|
+
limit: 10,
|
|
27
|
+
filter: { published: true },
|
|
28
|
+
sort: ['createdAt:desc'],
|
|
29
|
+
})
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Drivers
|
|
33
|
+
|
|
34
|
+
| driver | notes |
|
|
35
|
+
| --------------- | ----- |
|
|
36
|
+
| `memory` | zero-dependency, ranks by matched terms — for dev/test/small data |
|
|
37
|
+
| `meilisearch` | schemaless; works out of the box |
|
|
38
|
+
| `typesense` | collections must pre-exist; set `queryBy` to your searchable fields |
|
|
39
|
+
| `algolia` | schemaless; uses `id` as `objectID` |
|
|
40
|
+
| `elasticsearch` | auto-creates indexes on first write |
|
|
41
|
+
|
|
42
|
+
A typical pattern is to call `index()`/`remove()` from your list `afterOperation` hooks.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { NixxieSearchDocument, NixxieSearchQuery, NixxieSearchResults, NixxieSearchService } from '@nixxie-cms/core';
|
|
2
|
+
import type { AlgoliaConfig } from "./types.js";
|
|
3
|
+
/** Algolia backend over the REST API (no SDK dependency). */
|
|
4
|
+
export declare class AlgoliaSearch implements NixxieSearchService {
|
|
5
|
+
private appId;
|
|
6
|
+
private apiKey;
|
|
7
|
+
constructor(config: AlgoliaConfig);
|
|
8
|
+
private headers;
|
|
9
|
+
private writeHost;
|
|
10
|
+
private readHost;
|
|
11
|
+
index(indexName: string, documents: NixxieSearchDocument | NixxieSearchDocument[]): Promise<void>;
|
|
12
|
+
remove(indexName: string, id: string): Promise<void>;
|
|
13
|
+
search<T = NixxieSearchDocument>(indexName: string, query: NixxieSearchQuery): Promise<NixxieSearchResults<T>>;
|
|
14
|
+
clear(indexName: string): Promise<void>;
|
|
15
|
+
close(): Promise<void>;
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=AlgoliaSearch.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"AlgoliaSearch.d.ts","sourceRoot":"../../../src","sources":["AlgoliaSearch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAe;AAE5C,6DAA6D;AAC7D,qBAAa,aAAc,YAAW,mBAAmB;IACvD,OAAO,CAAC,KAAK,CAAQ;IACrB,OAAO,CAAC,MAAM,CAAQ;gBAEV,MAAM,EAAE,aAAa;IAKjC,OAAO,CAAC,OAAO;IAQf,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,QAAQ;IAIV,KAAK,CACT,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,GACvD,OAAO,CAAC,IAAI,CAAC;IAWV,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOpD,MAAM,CAAC,CAAC,GAAG,oBAAoB,EACnC,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,iBAAiB,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IA8B5B,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOvC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAC7B"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { NixxieSearchDocument, NixxieSearchQuery, NixxieSearchResults, NixxieSearchService } from '@nixxie-cms/core';
|
|
2
|
+
import type { ElasticsearchConfig } from "./types.js";
|
|
3
|
+
/** Elasticsearch backend over the REST API (no SDK dependency). */
|
|
4
|
+
export declare class ElasticsearchSearch implements NixxieSearchService {
|
|
5
|
+
private node;
|
|
6
|
+
private authHeader?;
|
|
7
|
+
constructor(config: ElasticsearchConfig);
|
|
8
|
+
private request;
|
|
9
|
+
index(indexName: string, documents: NixxieSearchDocument | NixxieSearchDocument[]): Promise<void>;
|
|
10
|
+
remove(indexName: string, id: string): Promise<void>;
|
|
11
|
+
search<T = NixxieSearchDocument>(indexName: string, query: NixxieSearchQuery): Promise<NixxieSearchResults<T>>;
|
|
12
|
+
clear(indexName: string): Promise<void>;
|
|
13
|
+
close(): Promise<void>;
|
|
14
|
+
}
|
|
15
|
+
//# sourceMappingURL=ElasticsearchSearch.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ElasticsearchSearch.d.ts","sourceRoot":"../../../src","sources":["ElasticsearchSearch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,EAAE,mBAAmB,EAAE,mBAAe;AAElD,mEAAmE;AACnE,qBAAa,mBAAoB,YAAW,mBAAmB;IAC7D,OAAO,CAAC,IAAI,CAAQ;IACpB,OAAO,CAAC,UAAU,CAAC,CAAQ;gBAEf,MAAM,EAAE,mBAAmB;YAQzB,OAAO;IAef,KAAK,CACT,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,GACvD,OAAO,CAAC,IAAI,CAAC;IAiBV,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpD,MAAM,CAAC,CAAC,GAAG,oBAAoB,EACnC,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,iBAAiB,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAyB5B,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMvC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAC7B"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { NixxieSearchDocument, NixxieSearchQuery, NixxieSearchResults, NixxieSearchService } from '@nixxie-cms/core';
|
|
2
|
+
/**
|
|
3
|
+
* Zero-dependency in-memory search. Tokenises stringified document values and ranks by the
|
|
4
|
+
* number of query terms matched. Intended for development, tests and small datasets — swap in a
|
|
5
|
+
* real engine (Meilisearch/Typesense/Algolia/Elasticsearch) for production.
|
|
6
|
+
*/
|
|
7
|
+
export declare class InMemorySearch implements NixxieSearchService {
|
|
8
|
+
private indexes;
|
|
9
|
+
private indexFor;
|
|
10
|
+
index(indexName: string, documents: NixxieSearchDocument | NixxieSearchDocument[]): Promise<void>;
|
|
11
|
+
remove(indexName: string, id: string): Promise<void>;
|
|
12
|
+
search<T = NixxieSearchDocument>(indexName: string, query: NixxieSearchQuery): Promise<NixxieSearchResults<T>>;
|
|
13
|
+
clear(indexName: string): Promise<void>;
|
|
14
|
+
close(): Promise<void>;
|
|
15
|
+
private matchesFilter;
|
|
16
|
+
private applySort;
|
|
17
|
+
}
|
|
18
|
+
//# sourceMappingURL=InMemorySearch.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"InMemorySearch.d.ts","sourceRoot":"../../../src","sources":["InMemorySearch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,kBAAkB,CAAA;AAEzB;;;;GAIG;AACH,qBAAa,cAAe,YAAW,mBAAmB;IACxD,OAAO,CAAC,OAAO,CAAuD;IAEtE,OAAO,CAAC,QAAQ;IASV,KAAK,CACT,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,GACvD,OAAO,CAAC,IAAI,CAAC;IAQV,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpD,MAAM,CAAC,CAAC,GAAG,oBAAoB,EACnC,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,iBAAiB,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IA2B5B,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,SAAS;CAgBlB"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { NixxieSearchDocument, NixxieSearchQuery, NixxieSearchResults, NixxieSearchService } from '@nixxie-cms/core';
|
|
2
|
+
import type { MeilisearchConfig } from "./types.js";
|
|
3
|
+
/** Meilisearch backend over the REST API (no SDK dependency). */
|
|
4
|
+
export declare class MeilisearchSearch implements NixxieSearchService {
|
|
5
|
+
private base;
|
|
6
|
+
private apiKey?;
|
|
7
|
+
constructor(config: MeilisearchConfig);
|
|
8
|
+
private request;
|
|
9
|
+
index(indexName: string, documents: NixxieSearchDocument | NixxieSearchDocument[]): Promise<void>;
|
|
10
|
+
remove(indexName: string, id: string): Promise<void>;
|
|
11
|
+
search<T = NixxieSearchDocument>(indexName: string, query: NixxieSearchQuery): Promise<NixxieSearchResults<T>>;
|
|
12
|
+
clear(indexName: string): Promise<void>;
|
|
13
|
+
close(): Promise<void>;
|
|
14
|
+
}
|
|
15
|
+
//# sourceMappingURL=MeilisearchSearch.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MeilisearchSearch.d.ts","sourceRoot":"../../../src","sources":["MeilisearchSearch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,EAAE,iBAAiB,EAAE,mBAAe;AAEhD,iEAAiE;AACjE,qBAAa,iBAAkB,YAAW,mBAAmB;IAC3D,OAAO,CAAC,IAAI,CAAQ;IACpB,OAAO,CAAC,MAAM,CAAC,CAAQ;gBAEX,MAAM,EAAE,iBAAiB;YAKvB,OAAO;IAef,KAAK,CACT,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,GACvD,OAAO,CAAC,IAAI,CAAC;IAKV,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpD,MAAM,CAAC,CAAC,GAAG,oBAAoB,EACnC,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,iBAAiB,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAkB5B,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAC7B"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { NixxieSearchDocument, NixxieSearchQuery, NixxieSearchResults, NixxieSearchService } from '@nixxie-cms/core';
|
|
2
|
+
import type { TypesenseConfig } from "./types.js";
|
|
3
|
+
/**
|
|
4
|
+
* Typesense backend over the REST API (no SDK dependency).
|
|
5
|
+
* Collections must already exist; documents are upserted. Typesense has no wildcard `query_by`,
|
|
6
|
+
* so configure `queryBy` to match your collection's searchable fields.
|
|
7
|
+
* Note: `clear()` drops the entire collection (Typesense has no schema-preserving truncate),
|
|
8
|
+
* so recreate the collection before re-indexing.
|
|
9
|
+
*/
|
|
10
|
+
export declare class TypesenseSearch implements NixxieSearchService {
|
|
11
|
+
private base;
|
|
12
|
+
private apiKey;
|
|
13
|
+
private queryBy;
|
|
14
|
+
constructor(config: TypesenseConfig);
|
|
15
|
+
private headers;
|
|
16
|
+
index(indexName: string, documents: NixxieSearchDocument | NixxieSearchDocument[]): Promise<void>;
|
|
17
|
+
remove(indexName: string, id: string): Promise<void>;
|
|
18
|
+
search<T = NixxieSearchDocument>(indexName: string, query: NixxieSearchQuery): Promise<NixxieSearchResults<T>>;
|
|
19
|
+
clear(indexName: string): Promise<void>;
|
|
20
|
+
close(): Promise<void>;
|
|
21
|
+
}
|
|
22
|
+
//# sourceMappingURL=TypesenseSearch.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"TypesenseSearch.d.ts","sourceRoot":"../../../src","sources":["TypesenseSearch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAe;AAE9C;;;;;;GAMG;AACH,qBAAa,eAAgB,YAAW,mBAAmB;IACzD,OAAO,CAAC,IAAI,CAAQ;IACpB,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,OAAO,CAAQ;gBAEX,MAAM,EAAE,eAAe;IAQnC,OAAO,CAAC,OAAO;IAIT,KAAK,CACT,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,GACvD,OAAO,CAAC,IAAI,CAAC;IAUV,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOpD,MAAM,CAAC,CAAC,GAAG,oBAAoB,EACnC,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,iBAAiB,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IA8B5B,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWvC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAC7B"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { SearchConfig } from "./types.js";
|
|
2
|
+
import { AlgoliaSearch } from "./AlgoliaSearch.js";
|
|
3
|
+
import { ElasticsearchSearch } from "./ElasticsearchSearch.js";
|
|
4
|
+
import { InMemorySearch } from "./InMemorySearch.js";
|
|
5
|
+
import { MeilisearchSearch } from "./MeilisearchSearch.js";
|
|
6
|
+
import { TypesenseSearch } from "./TypesenseSearch.js";
|
|
7
|
+
export declare function createSearch(config: SearchConfig): InMemorySearch | MeilisearchSearch | TypesenseSearch | AlgoliaSearch | ElasticsearchSearch;
|
|
8
|
+
export { InMemorySearch, MeilisearchSearch, TypesenseSearch, AlgoliaSearch, ElasticsearchSearch };
|
|
9
|
+
export type { SearchConfig, InMemorySearchConfig, MeilisearchConfig, TypesenseConfig, AlgoliaConfig, ElasticsearchConfig, } from "./types.js";
|
|
10
|
+
export type { NixxieSearchService, NixxieSearchDocument, NixxieSearchQuery, NixxieSearchHit, NixxieSearchResults, } from '@nixxie-cms/core';
|
|
11
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAe;AAC3C,OAAO,EAAE,aAAa,EAAE,2BAAuB;AAC/C,OAAO,EAAE,mBAAmB,EAAE,iCAA6B;AAC3D,OAAO,EAAE,cAAc,EAAE,4BAAwB;AACjD,OAAO,EAAE,iBAAiB,EAAE,+BAA2B;AACvD,OAAO,EAAE,eAAe,EAAE,6BAAyB;AAEnD,wBAAgB,YAAY,CAC1B,MAAM,EAAE,YAAY,GACnB,cAAc,GAAG,iBAAiB,GAAG,eAAe,GAAG,aAAa,GAAG,mBAAmB,CAiB5F;AAED,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,eAAe,EAAE,aAAa,EAAE,mBAAmB,EAAE,CAAA;AACjG,YAAY,EACV,YAAY,EACZ,oBAAoB,EACpB,iBAAiB,EACjB,eAAe,EACf,aAAa,EACb,mBAAmB,GACpB,mBAAe;AAChB,YAAY,EACV,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,eAAe,EACf,mBAAmB,GACpB,MAAM,kBAAkB,CAAA"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import type { NixxieSearchDocument, NixxieSearchHit, NixxieSearchQuery, NixxieSearchResults, NixxieSearchService } from '@nixxie-cms/core';
|
|
2
|
+
export type { NixxieSearchDocument, NixxieSearchHit, NixxieSearchQuery, NixxieSearchResults, NixxieSearchService, };
|
|
3
|
+
export type InMemorySearchConfig = {
|
|
4
|
+
driver: 'memory';
|
|
5
|
+
};
|
|
6
|
+
export type MeilisearchConfig = {
|
|
7
|
+
driver: 'meilisearch';
|
|
8
|
+
/** Meilisearch host URL, e.g. http://localhost:7700 */
|
|
9
|
+
url: string;
|
|
10
|
+
/** API key (master or scoped). */
|
|
11
|
+
apiKey?: string;
|
|
12
|
+
};
|
|
13
|
+
export type TypesenseConfig = {
|
|
14
|
+
driver: 'typesense';
|
|
15
|
+
/** Host (without protocol), e.g. localhost */
|
|
16
|
+
host: string;
|
|
17
|
+
/** Port. Default: 8108 */
|
|
18
|
+
port?: number;
|
|
19
|
+
/** 'http' or 'https'. Default: 'http' */
|
|
20
|
+
protocol?: 'http' | 'https';
|
|
21
|
+
/** API key. */
|
|
22
|
+
apiKey: string;
|
|
23
|
+
/**
|
|
24
|
+
* Comma-separated fields Typesense should search against (it has no wildcard query_by).
|
|
25
|
+
* Default: 'title,name,body,content'
|
|
26
|
+
*/
|
|
27
|
+
queryBy?: string;
|
|
28
|
+
};
|
|
29
|
+
export type AlgoliaConfig = {
|
|
30
|
+
driver: 'algolia';
|
|
31
|
+
/** Algolia application id. */
|
|
32
|
+
appId: string;
|
|
33
|
+
/** Admin API key (write access). */
|
|
34
|
+
apiKey: string;
|
|
35
|
+
};
|
|
36
|
+
export type ElasticsearchConfig = {
|
|
37
|
+
driver: 'elasticsearch';
|
|
38
|
+
/** Node URL, e.g. http://localhost:9200 */
|
|
39
|
+
node: string;
|
|
40
|
+
/** Optional API key for auth. */
|
|
41
|
+
apiKey?: string;
|
|
42
|
+
/** Optional basic-auth username. */
|
|
43
|
+
username?: string;
|
|
44
|
+
/** Optional basic-auth password. */
|
|
45
|
+
password?: string;
|
|
46
|
+
};
|
|
47
|
+
export type SearchConfig = InMemorySearchConfig | MeilisearchConfig | TypesenseConfig | AlgoliaConfig | ElasticsearchConfig;
|
|
48
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"../../../src","sources":["types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,kBAAkB,CAAA;AAEzB,YAAY,EACV,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,GACpB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,QAAQ,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,aAAa,CAAA;IACrB,uDAAuD;IACvD,GAAG,EAAE,MAAM,CAAA;IACX,kCAAkC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,WAAW,CAAA;IACnB,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,yCAAyC;IACzC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC3B,eAAe;IACf,MAAM,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,SAAS,CAAA;IACjB,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,eAAe,CAAA;IACvB,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAA;IACZ,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,YAAY,GACpB,oBAAoB,GACpB,iBAAiB,GACjB,eAAe,GACf,aAAa,GACb,mBAAmB,CAAA"}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
export * from "./declarations/src/index.js";
|
|
2
|
+
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibml4eGllLWNtcy1zZWFyY2guY2pzLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuL2RlY2xhcmF0aW9ucy9zcmMvaW5kZXguZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSJ9
|