bright-client 0.1.1 → 0.2.0
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/README.md +8 -75
- package/dist/index.cjs +12 -0
- package/dist/index.d.cts +19 -3
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +19 -3
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +12 -0
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,15 +1,17 @@
|
|
|
1
|
-
# Bright JS
|
|
1
|
+
# Bright JS
|
|
2
2
|
|
|
3
|
-
TypeScript/JavaScript client library for [Bright](https://github.com/nnstd/bright) search database.
|
|
3
|
+
TypeScript/JavaScript client library for [Bright](https://github.com/nnstd/bright) full-search database.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install
|
|
8
|
+
npm install bright-client
|
|
9
9
|
# or
|
|
10
|
-
yarn add
|
|
10
|
+
yarn add bright-client
|
|
11
11
|
# or
|
|
12
|
-
pnpm add
|
|
12
|
+
pnpm add bright-client
|
|
13
|
+
# or
|
|
14
|
+
bun add bright-client
|
|
13
15
|
```
|
|
14
16
|
|
|
15
17
|
## Usage
|
|
@@ -17,7 +19,7 @@ pnpm add @nnstd/bright-js
|
|
|
17
19
|
### Create a Client
|
|
18
20
|
|
|
19
21
|
```typescript
|
|
20
|
-
import { createClient } from '
|
|
22
|
+
import { createClient } from 'bright-client';
|
|
21
23
|
|
|
22
24
|
const client = createClient({
|
|
23
25
|
baseUrl: 'http://localhost:3000'
|
|
@@ -92,75 +94,6 @@ console.log(results.totalHits); // number
|
|
|
92
94
|
console.log(results.totalPages); // number
|
|
93
95
|
```
|
|
94
96
|
|
|
95
|
-
## API Reference
|
|
96
|
-
|
|
97
|
-
### `createClient(options)`
|
|
98
|
-
|
|
99
|
-
Creates a new Bright client instance.
|
|
100
|
-
|
|
101
|
-
**Options:**
|
|
102
|
-
- `baseUrl` (string, required) - Base URL of the Bright server
|
|
103
|
-
- `fetch` (function, optional) - Custom fetch implementation
|
|
104
|
-
|
|
105
|
-
### Index Management
|
|
106
|
-
|
|
107
|
-
#### `createIndex(id, primaryKey?)`
|
|
108
|
-
|
|
109
|
-
Creates a new search index.
|
|
110
|
-
|
|
111
|
-
#### `updateIndex(id, config)`
|
|
112
|
-
|
|
113
|
-
Updates index configuration.
|
|
114
|
-
|
|
115
|
-
#### `deleteIndex(id)`
|
|
116
|
-
|
|
117
|
-
Deletes an index and all its documents.
|
|
118
|
-
|
|
119
|
-
### Document Operations
|
|
120
|
-
|
|
121
|
-
#### `addDocuments(indexId, documents, format?)`
|
|
122
|
-
|
|
123
|
-
Adds documents to an index. Documents with existing IDs will be updated.
|
|
124
|
-
|
|
125
|
-
#### `updateDocument(indexId, documentId, updates)`
|
|
126
|
-
|
|
127
|
-
Updates specific fields of a document.
|
|
128
|
-
|
|
129
|
-
#### `deleteDocument(indexId, documentId)`
|
|
130
|
-
|
|
131
|
-
Deletes a single document.
|
|
132
|
-
|
|
133
|
-
#### `deleteDocuments(indexId, options)`
|
|
134
|
-
|
|
135
|
-
Deletes multiple documents by IDs or filter query.
|
|
136
|
-
|
|
137
|
-
**Options:**
|
|
138
|
-
- `ids` (string[]) - Array of document IDs
|
|
139
|
-
- `filter` (string) - Query filter
|
|
140
|
-
|
|
141
|
-
### Search
|
|
142
|
-
|
|
143
|
-
#### `search<T>(indexId, params?)`
|
|
144
|
-
|
|
145
|
-
Searches for documents in an index.
|
|
146
|
-
|
|
147
|
-
**Params:**
|
|
148
|
-
- `q` (string) - Search query
|
|
149
|
-
- `offset` (number) - Number of results to skip
|
|
150
|
-
- `limit` (number) - Maximum results per page (default: 20)
|
|
151
|
-
- `page` (number) - Page number
|
|
152
|
-
- `sort` (string[]) - Sort fields (prefix with `-` for descending)
|
|
153
|
-
- `attributesToRetrieve` (string[]) - Fields to include
|
|
154
|
-
- `attributesToExclude` (string[]) - Fields to exclude
|
|
155
|
-
|
|
156
|
-
## TypeScript
|
|
157
|
-
|
|
158
|
-
This library is written in TypeScript and includes type definitions.
|
|
159
|
-
|
|
160
|
-
```typescript
|
|
161
|
-
import { BrightClient, SearchParams, SearchResponse } from '@nnstd/bright-js';
|
|
162
|
-
```
|
|
163
|
-
|
|
164
97
|
## License
|
|
165
98
|
|
|
166
99
|
MIT
|
package/dist/index.cjs
CHANGED
|
@@ -69,6 +69,18 @@ var BrightClient = class {
|
|
|
69
69
|
if (params?.attributesToExclude) params.attributesToExclude.forEach((attr) => searchParams.append("attributesToExclude[]", attr));
|
|
70
70
|
return this.request(`/indexes/${indexId}/searches?${searchParams}`, { method: "POST" });
|
|
71
71
|
}
|
|
72
|
+
index(indexId) {
|
|
73
|
+
return {
|
|
74
|
+
id: indexId,
|
|
75
|
+
update: (config) => this.updateIndex(indexId, config),
|
|
76
|
+
delete: () => this.deleteIndex(indexId),
|
|
77
|
+
addDocuments: (documents, format) => this.addDocuments(indexId, documents, format),
|
|
78
|
+
updateDocument: (documentId, updates) => this.updateDocument(indexId, documentId, updates),
|
|
79
|
+
deleteDocument: (documentId) => this.deleteDocument(indexId, documentId),
|
|
80
|
+
deleteDocuments: (options) => this.deleteDocuments(indexId, options),
|
|
81
|
+
search: (params) => this.search(indexId, params)
|
|
82
|
+
};
|
|
83
|
+
}
|
|
72
84
|
};
|
|
73
85
|
function createClient(options) {
|
|
74
86
|
return new BrightClient(options);
|
package/dist/index.d.cts
CHANGED
|
@@ -21,6 +21,21 @@ interface BrightClientOptions {
|
|
|
21
21
|
baseUrl: string;
|
|
22
22
|
fetch?: typeof fetch;
|
|
23
23
|
}
|
|
24
|
+
interface IndexHandle<T = Record<string, any>> {
|
|
25
|
+
readonly id: string;
|
|
26
|
+
update(config: Partial<IndexConfig>): Promise<IndexConfig>;
|
|
27
|
+
delete(): Promise<void>;
|
|
28
|
+
addDocuments(documents: T[], format?: 'jsoneachrow'): Promise<{
|
|
29
|
+
indexed: number;
|
|
30
|
+
}>;
|
|
31
|
+
updateDocument(documentId: string, updates: Partial<T>): Promise<T>;
|
|
32
|
+
deleteDocument(documentId: string): Promise<void>;
|
|
33
|
+
deleteDocuments(options: {
|
|
34
|
+
ids?: string[];
|
|
35
|
+
filter?: string;
|
|
36
|
+
}): Promise<void>;
|
|
37
|
+
search(params?: SearchParams): Promise<SearchResponse<T>>;
|
|
38
|
+
}
|
|
24
39
|
declare class BrightClient {
|
|
25
40
|
private baseUrl;
|
|
26
41
|
private fetchFn;
|
|
@@ -29,18 +44,19 @@ declare class BrightClient {
|
|
|
29
44
|
createIndex(id: string, primaryKey?: string): Promise<IndexConfig>;
|
|
30
45
|
updateIndex(id: string, config: Partial<IndexConfig>): Promise<IndexConfig>;
|
|
31
46
|
deleteIndex(id: string): Promise<void>;
|
|
32
|
-
addDocuments(indexId: string, documents:
|
|
47
|
+
addDocuments<T = Record<string, any>>(indexId: string, documents: T[], format?: 'jsoneachrow'): Promise<{
|
|
33
48
|
indexed: number;
|
|
34
49
|
}>;
|
|
35
|
-
updateDocument(indexId: string, documentId: string, updates:
|
|
50
|
+
updateDocument<T = Record<string, any>>(indexId: string, documentId: string, updates: Partial<T>): Promise<T>;
|
|
36
51
|
deleteDocument(indexId: string, documentId: string): Promise<void>;
|
|
37
52
|
deleteDocuments(indexId: string, options: {
|
|
38
53
|
ids?: string[];
|
|
39
54
|
filter?: string;
|
|
40
55
|
}): Promise<void>;
|
|
41
56
|
search<T = Record<string, any>>(indexId: string, params?: SearchParams): Promise<SearchResponse<T>>;
|
|
57
|
+
index<T = Record<string, any>>(indexId: string): IndexHandle<T>;
|
|
42
58
|
}
|
|
43
59
|
declare function createClient(options: BrightClientOptions): BrightClient;
|
|
44
60
|
//#endregion
|
|
45
|
-
export { BrightClient, BrightClientOptions, IndexConfig, SearchParams, SearchResponse, createClient };
|
|
61
|
+
export { BrightClient, BrightClientOptions, IndexConfig, IndexHandle, SearchParams, SearchResponse, createClient };
|
|
46
62
|
//# sourceMappingURL=index.d.cts.map
|
package/dist/index.d.cts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";UAAiB,WAAA;EAAA,EAAA,EAAA,MAAA;EAKA,UAAA,CAAA,EAAA,MAAY;AAU7B;AAMiB,UAhBA,YAAA,CAgBmB;
|
|
1
|
+
{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";UAAiB,WAAA;EAAA,EAAA,EAAA,MAAA;EAKA,UAAA,CAAA,EAAA,MAAY;AAU7B;AAMiB,UAhBA,YAAA,CAgBmB;EAKnB,CAAA,CAAA,EAAA,MAAA;EAAgB,MAAA,CAAA,EAAA,MAAA;EAIR,KAAA,CAAA,EAAA,MAAA;EAAR,IAAA,CAAA,EAAA,MAAA;EAA+B,IAAA,CAAA,EAAA,MAAA,EAAA;EAAR,oBAAA,CAAA,EAAA,MAAA,EAAA;EAC5B,mBAAA,CAAA,EAAA,MAAA,EAAA;;AAG4C,UAnBvC,cAmBuC,CAAA,IAnBpB,MAmBoB,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA;EACF,IAAA,EAnB9C,CAmB8C,EAAA;EAAR,SAAA,EAAA,MAAA;EAAqB,UAAA,EAAA,MAAA;;AAC7B,UAfrB,mBAAA,CAeqB;EAC2B,OAAA,EAAA,MAAA;EAG/C,KAAA,CAAA,EAAA,OAjBD,KAiBC;;AAAuB,UAdxB,WAcwB,CAAA,IAdR,MAcQ,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA;EAAR,SAAA,EAAA,EAAA,MAAA;EAAO,MAAA,CAAA,MAAA,EAVvB,OAUuB,CAVf,WAUe,CAAA,CAAA,EAVA,OAUA,CAVQ,WAUR,CAAA;EAG3B,MAAA,EAAA,EAZD,OAYa,CAAA,IAAA,CAAA;EAIF,YAAA,CAAA,SAAA,EAbG,CAaH,EAAA,EAAA,MAAA,CAAA,EAAA,aAAA,CAAA,EAbiC,OAajC,CAAA;IAgCuC,OAAA,EAAA,MAAA;EAAR,CAAA,CAAA;EASN,cAAA,CAAA,UAAA,EAAA,MAAA,EAAA,OAAA,EArDF,OAqDE,CArDM,CAqDN,CAAA,CAAA,EArDW,OAqDX,CArDmB,CAqDnB,CAAA;EAAR,cAAA,CAAA,UAAA,EAAA,MAAA,CAAA,EApDF,OAoDE,CAAA,IAAA,CAAA;EAA+B,eAAA,CAAA,OAAA,EAAA;IAAR,GAAA,CAAA,EAAA,MAAA,EAAA;IAO9B,MAAA,CAAA,EAAA,MAAA;EAQR,CAAA,CAAA,EAlEwC,OAkExC,CAAA,IAAA,CAAA;EAEV,MAAA,CAAA,MAAA,CAAA,EAjEG,YAiEH,CAAA,EAjEkB,OAiElB,CAjE0B,cAiE1B,CAjEyC,CAiEzC,CAAA,CAAA;;AAYY,cA1Ed,YAAA,CA0Ec;EAGN,QAAA,OAAA;EAAR,QAAA,OAAA;EACA,WAAA,CAAA,OAAA,EA1EU,mBA0EV;EAAR,QAAA,OAAA;EAOwD,WAAA,CAAA,EAAA,EAAA,MAAA,EAAA,UAAA,CAAA,EAAA,MAAA,CAAA,EAjDP,OAiDO,CAjDC,WAiDD,CAAA;EASxD,WAAA,CAAA,EAAA,EAAA,MAAA,EAAA,MAAA,EAjDmC,OAiDnC,CAjD2C,WAiD3C,CAAA,CAAA,EAjD0D,OAiD1D,CAjDkE,WAiDlE,CAAA;EAkBc,WAAA,CAAA,EAAA,EAAA,MAAA,CAAA,EA5Dc,OA4Dd,CAAA,IAAA,CAAA;EAEN,YAAA,CAAA,IAtDY,MAsDZ,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,OAAA,EAAA,MAAA,EAAA,SAAA,EApDE,CAoDF,EAAA,EAAA,MAAA,CAAA,EAAA,aAAA,CAAA,EAlDR,OAkDQ,CAAA;IACe,OAAA,EAAA,MAAA;EAAf,CAAA,CAAA;EAAR,cAAA,CAAA,IAzCsB,MAyCtB,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,OAAA,EAAA,MAAA,EAAA,UAAA,EAAA,MAAA,EAAA,OAAA,EAtCQ,OAsCR,CAtCgB,CAsChB,CAAA,CAAA,EArCA,OAqCA,CArCQ,CAqCR,CAAA;EA+BO,cAAA,CAAA,OAAA,EAAA,MAAA,EAAA,UAAA,EAAA,MAAA,CAAA,EA7DiD,OA6DjD,CAAA,IAAA,CAAA;EAAmD,eAAA,CAAA,OAAA,EAAA,MAAA,EAAA,OAAA,EAAA;IAAZ,GAAA,CAAA,EAAA,MAAA,EAAA;IAAW,MAAA,CAAA,EAAA,MAAA;EAkB9C,CAAA,CAAA,EAtEX,OAsEW,CAAA,IAAY,CAAA;aApDT,+CAEN,eACR,QAAQ,eAAe;YA+BhB,uCAAuC,YAAY;;iBAkB/C,YAAA,UAAsB,sBAAsB"}
|
package/dist/index.d.mts
CHANGED
|
@@ -21,6 +21,21 @@ interface BrightClientOptions {
|
|
|
21
21
|
baseUrl: string;
|
|
22
22
|
fetch?: typeof fetch;
|
|
23
23
|
}
|
|
24
|
+
interface IndexHandle<T = Record<string, any>> {
|
|
25
|
+
readonly id: string;
|
|
26
|
+
update(config: Partial<IndexConfig>): Promise<IndexConfig>;
|
|
27
|
+
delete(): Promise<void>;
|
|
28
|
+
addDocuments(documents: T[], format?: 'jsoneachrow'): Promise<{
|
|
29
|
+
indexed: number;
|
|
30
|
+
}>;
|
|
31
|
+
updateDocument(documentId: string, updates: Partial<T>): Promise<T>;
|
|
32
|
+
deleteDocument(documentId: string): Promise<void>;
|
|
33
|
+
deleteDocuments(options: {
|
|
34
|
+
ids?: string[];
|
|
35
|
+
filter?: string;
|
|
36
|
+
}): Promise<void>;
|
|
37
|
+
search(params?: SearchParams): Promise<SearchResponse<T>>;
|
|
38
|
+
}
|
|
24
39
|
declare class BrightClient {
|
|
25
40
|
private baseUrl;
|
|
26
41
|
private fetchFn;
|
|
@@ -29,18 +44,19 @@ declare class BrightClient {
|
|
|
29
44
|
createIndex(id: string, primaryKey?: string): Promise<IndexConfig>;
|
|
30
45
|
updateIndex(id: string, config: Partial<IndexConfig>): Promise<IndexConfig>;
|
|
31
46
|
deleteIndex(id: string): Promise<void>;
|
|
32
|
-
addDocuments(indexId: string, documents:
|
|
47
|
+
addDocuments<T = Record<string, any>>(indexId: string, documents: T[], format?: 'jsoneachrow'): Promise<{
|
|
33
48
|
indexed: number;
|
|
34
49
|
}>;
|
|
35
|
-
updateDocument(indexId: string, documentId: string, updates:
|
|
50
|
+
updateDocument<T = Record<string, any>>(indexId: string, documentId: string, updates: Partial<T>): Promise<T>;
|
|
36
51
|
deleteDocument(indexId: string, documentId: string): Promise<void>;
|
|
37
52
|
deleteDocuments(indexId: string, options: {
|
|
38
53
|
ids?: string[];
|
|
39
54
|
filter?: string;
|
|
40
55
|
}): Promise<void>;
|
|
41
56
|
search<T = Record<string, any>>(indexId: string, params?: SearchParams): Promise<SearchResponse<T>>;
|
|
57
|
+
index<T = Record<string, any>>(indexId: string): IndexHandle<T>;
|
|
42
58
|
}
|
|
43
59
|
declare function createClient(options: BrightClientOptions): BrightClient;
|
|
44
60
|
//#endregion
|
|
45
|
-
export { BrightClient, BrightClientOptions, IndexConfig, SearchParams, SearchResponse, createClient };
|
|
61
|
+
export { BrightClient, BrightClientOptions, IndexConfig, IndexHandle, SearchParams, SearchResponse, createClient };
|
|
46
62
|
//# sourceMappingURL=index.d.mts.map
|
package/dist/index.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";UAAiB,WAAA;EAAA,EAAA,EAAA,MAAA;EAKA,UAAA,CAAA,EAAA,MAAY;AAU7B;AAMiB,UAhBA,YAAA,CAgBmB;
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";UAAiB,WAAA;EAAA,EAAA,EAAA,MAAA;EAKA,UAAA,CAAA,EAAA,MAAY;AAU7B;AAMiB,UAhBA,YAAA,CAgBmB;EAKnB,CAAA,CAAA,EAAA,MAAA;EAAgB,MAAA,CAAA,EAAA,MAAA;EAIR,KAAA,CAAA,EAAA,MAAA;EAAR,IAAA,CAAA,EAAA,MAAA;EAA+B,IAAA,CAAA,EAAA,MAAA,EAAA;EAAR,oBAAA,CAAA,EAAA,MAAA,EAAA;EAC5B,mBAAA,CAAA,EAAA,MAAA,EAAA;;AAG4C,UAnBvC,cAmBuC,CAAA,IAnBpB,MAmBoB,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA;EACF,IAAA,EAnB9C,CAmB8C,EAAA;EAAR,SAAA,EAAA,MAAA;EAAqB,UAAA,EAAA,MAAA;;AAC7B,UAfrB,mBAAA,CAeqB;EAC2B,OAAA,EAAA,MAAA;EAG/C,KAAA,CAAA,EAAA,OAjBD,KAiBC;;AAAuB,UAdxB,WAcwB,CAAA,IAdR,MAcQ,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA;EAAR,SAAA,EAAA,EAAA,MAAA;EAAO,MAAA,CAAA,MAAA,EAVvB,OAUuB,CAVf,WAUe,CAAA,CAAA,EAVA,OAUA,CAVQ,WAUR,CAAA;EAG3B,MAAA,EAAA,EAZD,OAYa,CAAA,IAAA,CAAA;EAIF,YAAA,CAAA,SAAA,EAbG,CAaH,EAAA,EAAA,MAAA,CAAA,EAAA,aAAA,CAAA,EAbiC,OAajC,CAAA;IAgCuC,OAAA,EAAA,MAAA;EAAR,CAAA,CAAA;EASN,cAAA,CAAA,UAAA,EAAA,MAAA,EAAA,OAAA,EArDF,OAqDE,CArDM,CAqDN,CAAA,CAAA,EArDW,OAqDX,CArDmB,CAqDnB,CAAA;EAAR,cAAA,CAAA,UAAA,EAAA,MAAA,CAAA,EApDF,OAoDE,CAAA,IAAA,CAAA;EAA+B,eAAA,CAAA,OAAA,EAAA;IAAR,GAAA,CAAA,EAAA,MAAA,EAAA;IAO9B,MAAA,CAAA,EAAA,MAAA;EAQR,CAAA,CAAA,EAlEwC,OAkExC,CAAA,IAAA,CAAA;EAEV,MAAA,CAAA,MAAA,CAAA,EAjEG,YAiEH,CAAA,EAjEkB,OAiElB,CAjE0B,cAiE1B,CAjEyC,CAiEzC,CAAA,CAAA;;AAYY,cA1Ed,YAAA,CA0Ec;EAGN,QAAA,OAAA;EAAR,QAAA,OAAA;EACA,WAAA,CAAA,OAAA,EA1EU,mBA0EV;EAAR,QAAA,OAAA;EAOwD,WAAA,CAAA,EAAA,EAAA,MAAA,EAAA,UAAA,CAAA,EAAA,MAAA,CAAA,EAjDP,OAiDO,CAjDC,WAiDD,CAAA;EASxD,WAAA,CAAA,EAAA,EAAA,MAAA,EAAA,MAAA,EAjDmC,OAiDnC,CAjD2C,WAiD3C,CAAA,CAAA,EAjD0D,OAiD1D,CAjDkE,WAiDlE,CAAA;EAkBc,WAAA,CAAA,EAAA,EAAA,MAAA,CAAA,EA5Dc,OA4Dd,CAAA,IAAA,CAAA;EAEN,YAAA,CAAA,IAtDY,MAsDZ,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,OAAA,EAAA,MAAA,EAAA,SAAA,EApDE,CAoDF,EAAA,EAAA,MAAA,CAAA,EAAA,aAAA,CAAA,EAlDR,OAkDQ,CAAA;IACe,OAAA,EAAA,MAAA;EAAf,CAAA,CAAA;EAAR,cAAA,CAAA,IAzCsB,MAyCtB,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,OAAA,EAAA,MAAA,EAAA,UAAA,EAAA,MAAA,EAAA,OAAA,EAtCQ,OAsCR,CAtCgB,CAsChB,CAAA,CAAA,EArCA,OAqCA,CArCQ,CAqCR,CAAA;EA+BO,cAAA,CAAA,OAAA,EAAA,MAAA,EAAA,UAAA,EAAA,MAAA,CAAA,EA7DiD,OA6DjD,CAAA,IAAA,CAAA;EAAmD,eAAA,CAAA,OAAA,EAAA,MAAA,EAAA,OAAA,EAAA;IAAZ,GAAA,CAAA,EAAA,MAAA,EAAA;IAAW,MAAA,CAAA,EAAA,MAAA;EAkB9C,CAAA,CAAA,EAtEX,OAsEW,CAAA,IAAY,CAAA;aApDT,+CAEN,eACR,QAAQ,eAAe;YA+BhB,uCAAuC,YAAY;;iBAkB/C,YAAA,UAAsB,sBAAsB"}
|
package/dist/index.mjs
CHANGED
|
@@ -68,6 +68,18 @@ var BrightClient = class {
|
|
|
68
68
|
if (params?.attributesToExclude) params.attributesToExclude.forEach((attr) => searchParams.append("attributesToExclude[]", attr));
|
|
69
69
|
return this.request(`/indexes/${indexId}/searches?${searchParams}`, { method: "POST" });
|
|
70
70
|
}
|
|
71
|
+
index(indexId) {
|
|
72
|
+
return {
|
|
73
|
+
id: indexId,
|
|
74
|
+
update: (config) => this.updateIndex(indexId, config),
|
|
75
|
+
delete: () => this.deleteIndex(indexId),
|
|
76
|
+
addDocuments: (documents, format) => this.addDocuments(indexId, documents, format),
|
|
77
|
+
updateDocument: (documentId, updates) => this.updateDocument(indexId, documentId, updates),
|
|
78
|
+
deleteDocument: (documentId) => this.deleteDocument(indexId, documentId),
|
|
79
|
+
deleteDocuments: (options) => this.deleteDocuments(indexId, options),
|
|
80
|
+
search: (params) => this.search(indexId, params)
|
|
81
|
+
};
|
|
82
|
+
}
|
|
71
83
|
};
|
|
72
84
|
function createClient(options) {
|
|
73
85
|
return new BrightClient(options);
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["export interface IndexConfig {\n id: string;\n primaryKey?: string;\n}\n\nexport interface SearchParams {\n q?: string;\n offset?: number;\n limit?: number;\n page?: number;\n sort?: string[];\n attributesToRetrieve?: string[];\n attributesToExclude?: string[];\n}\n\nexport interface SearchResponse<T = Record<string, any>> {\n hits: T[];\n totalHits: number;\n totalPages: number;\n}\n\nexport interface BrightClientOptions {\n baseUrl: string;\n fetch?: typeof fetch;\n}\n\nexport class BrightClient {\n private baseUrl: string;\n private fetchFn: typeof fetch;\n\n constructor(options: BrightClientOptions) {\n this.baseUrl = options.baseUrl.replace(/\\/$/, '');\n this.fetchFn = options.fetch || globalThis.fetch;\n }\n\n private async request<T>(\n path: string,\n options?: RequestInit\n ): Promise<T> {\n const url = `${this.baseUrl}${path}`;\n const response = await this.fetchFn(url, {\n ...options,\n headers: {\n 'Content-Type': 'application/json',\n ...options?.headers,\n },\n });\n\n if (!response.ok) {\n const error = await response.json().catch(() => ({ error: response.statusText }));\n throw new Error(error.error || `HTTP ${response.status}`);\n }\n\n if (response.status === 204) {\n return undefined as T;\n }\n\n return response.json();\n }\n\n // Index Management\n\n async createIndex(id: string, primaryKey?: string): Promise<IndexConfig> {\n const params = new URLSearchParams({ id });\n if (primaryKey) params.append('primaryKey', primaryKey);\n \n return this.request<IndexConfig>(`/indexes?${params}`, {\n method: 'POST',\n });\n }\n\n async updateIndex(id: string, config: Partial<IndexConfig>): Promise<IndexConfig> {\n return this.request<IndexConfig>(`/indexes/${id}`, {\n method: 'PATCH',\n body: JSON.stringify(config),\n });\n }\n\n async deleteIndex(id: string): Promise<void> {\n return this.request<void>(`/indexes/${id}`, {\n method: 'DELETE',\n });\n }\n\n // Document Operations\n\n async addDocuments(\n indexId: string,\n documents:
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["export interface IndexConfig {\n id: string;\n primaryKey?: string;\n}\n\nexport interface SearchParams {\n q?: string;\n offset?: number;\n limit?: number;\n page?: number;\n sort?: string[];\n attributesToRetrieve?: string[];\n attributesToExclude?: string[];\n}\n\nexport interface SearchResponse<T = Record<string, any>> {\n hits: T[];\n totalHits: number;\n totalPages: number;\n}\n\nexport interface BrightClientOptions {\n baseUrl: string;\n fetch?: typeof fetch;\n}\n\nexport interface IndexHandle<T = Record<string, any>> {\n readonly id: string;\n\n // Index operations\n update(config: Partial<IndexConfig>): Promise<IndexConfig>;\n delete(): Promise<void>;\n\n // Document operations\n addDocuments(documents: T[], format?: 'jsoneachrow'): Promise<{ indexed: number }>;\n updateDocument(documentId: string, updates: Partial<T>): Promise<T>;\n deleteDocument(documentId: string): Promise<void>;\n deleteDocuments(options: { ids?: string[]; filter?: string }): Promise<void>;\n\n // Search\n search(params?: SearchParams): Promise<SearchResponse<T>>;\n}\n\nexport class BrightClient {\n private baseUrl: string;\n private fetchFn: typeof fetch;\n\n constructor(options: BrightClientOptions) {\n this.baseUrl = options.baseUrl.replace(/\\/$/, '');\n this.fetchFn = options.fetch || globalThis.fetch;\n }\n\n private async request<T>(\n path: string,\n options?: RequestInit\n ): Promise<T> {\n const url = `${this.baseUrl}${path}`;\n const response = await this.fetchFn(url, {\n ...options,\n headers: {\n 'Content-Type': 'application/json',\n ...options?.headers,\n },\n });\n\n if (!response.ok) {\n const error = await response.json().catch(() => ({ error: response.statusText }));\n throw new Error(error.error || `HTTP ${response.status}`);\n }\n\n if (response.status === 204) {\n return undefined as T;\n }\n\n return response.json();\n }\n\n // Index Management\n\n async createIndex(id: string, primaryKey?: string): Promise<IndexConfig> {\n const params = new URLSearchParams({ id });\n if (primaryKey) params.append('primaryKey', primaryKey);\n \n return this.request<IndexConfig>(`/indexes?${params}`, {\n method: 'POST',\n });\n }\n\n async updateIndex(id: string, config: Partial<IndexConfig>): Promise<IndexConfig> {\n return this.request<IndexConfig>(`/indexes/${id}`, {\n method: 'PATCH',\n body: JSON.stringify(config),\n });\n }\n\n async deleteIndex(id: string): Promise<void> {\n return this.request<void>(`/indexes/${id}`, {\n method: 'DELETE',\n });\n }\n\n // Document Operations\n\n async addDocuments<T = Record<string, any>>(\n indexId: string,\n documents: T[],\n format: 'jsoneachrow' = 'jsoneachrow'\n ): Promise<{ indexed: number }> {\n const body = documents.map(doc => JSON.stringify(doc)).join('\\n');\n const params = new URLSearchParams({ format });\n\n return this.request<{ indexed: number }>(`/indexes/${indexId}/documents?${params}`, {\n method: 'POST',\n body,\n });\n }\n\n async updateDocument<T = Record<string, any>>(\n indexId: string,\n documentId: string,\n updates: Partial<T>\n ): Promise<T> {\n return this.request<T>(`/indexes/${indexId}/documents/${documentId}`, {\n method: 'PATCH',\n body: JSON.stringify(updates),\n });\n }\n\n async deleteDocument(indexId: string, documentId: string): Promise<void> {\n return this.request<void>(`/indexes/${indexId}/documents/${documentId}`, {\n method: 'DELETE',\n });\n }\n\n async deleteDocuments(\n indexId: string,\n options: { ids?: string[]; filter?: string }\n ): Promise<void> {\n const params = new URLSearchParams();\n \n if (options.ids) {\n options.ids.forEach(id => params.append('ids[]', id));\n }\n \n if (options.filter) {\n params.append('filter', options.filter);\n }\n \n return this.request<void>(`/indexes/${indexId}/documents?${params}`, {\n method: 'DELETE',\n });\n }\n\n // Search\n\n async search<T = Record<string, any>>(\n indexId: string,\n params?: SearchParams\n ): Promise<SearchResponse<T>> {\n const searchParams = new URLSearchParams();\n\n if (params?.q) searchParams.append('q', params.q);\n if (params?.offset) searchParams.append('offset', params.offset.toString());\n if (params?.limit) searchParams.append('limit', params.limit.toString());\n if (params?.page) searchParams.append('page', params.page.toString());\n\n if (params?.sort) {\n params.sort.forEach(s => searchParams.append('sort[]', s));\n }\n\n if (params?.attributesToRetrieve) {\n params.attributesToRetrieve.forEach(attr =>\n searchParams.append('attributesToRetrieve[]', attr)\n );\n }\n\n if (params?.attributesToExclude) {\n params.attributesToExclude.forEach(attr =>\n searchParams.append('attributesToExclude[]', attr)\n );\n }\n\n return this.request<SearchResponse<T>>(`/indexes/${indexId}/searches?${searchParams}`, {\n method: 'POST',\n });\n }\n\n // Typed Index Handle\n\n index<T = Record<string, any>>(indexId: string): IndexHandle<T> {\n return {\n id: indexId,\n\n update: (config) => this.updateIndex(indexId, config),\n delete: () => this.deleteIndex(indexId),\n\n addDocuments: (documents, format) => this.addDocuments<T>(indexId, documents, format),\n updateDocument: (documentId, updates) => this.updateDocument<T>(indexId, documentId, updates),\n deleteDocument: (documentId) => this.deleteDocument(indexId, documentId),\n deleteDocuments: (options) => this.deleteDocuments(indexId, options),\n\n search: (params) => this.search<T>(indexId, params),\n };\n }\n}\n\n// Convenience function\nexport function createClient(options: BrightClientOptions): BrightClient {\n return new BrightClient(options);\n}\n"],"mappings":";AA2CA,IAAa,eAAb,MAA0B;CAIxB,YAAY,SAA8B;AACxC,OAAK,UAAU,QAAQ,QAAQ,QAAQ,OAAO,GAAG;AACjD,OAAK,UAAU,QAAQ,SAAS,WAAW;;CAG7C,MAAc,QACZ,MACA,SACY;EACZ,MAAM,MAAM,GAAG,KAAK,UAAU;EAC9B,MAAM,WAAW,MAAM,KAAK,QAAQ,KAAK;GACvC,GAAG;GACH,SAAS;IACP,gBAAgB;IAChB,GAAG,SAAS;IACb;GACF,CAAC;AAEF,MAAI,CAAC,SAAS,IAAI;GAChB,MAAM,QAAQ,MAAM,SAAS,MAAM,CAAC,aAAa,EAAE,OAAO,SAAS,YAAY,EAAE;AACjF,SAAM,IAAI,MAAM,MAAM,SAAS,QAAQ,SAAS,SAAS;;AAG3D,MAAI,SAAS,WAAW,IACtB;AAGF,SAAO,SAAS,MAAM;;CAKxB,MAAM,YAAY,IAAY,YAA2C;EACvE,MAAM,SAAS,IAAI,gBAAgB,EAAE,IAAI,CAAC;AAC1C,MAAI,WAAY,QAAO,OAAO,cAAc,WAAW;AAEvD,SAAO,KAAK,QAAqB,YAAY,UAAU,EACrD,QAAQ,QACT,CAAC;;CAGJ,MAAM,YAAY,IAAY,QAAoD;AAChF,SAAO,KAAK,QAAqB,YAAY,MAAM;GACjD,QAAQ;GACR,MAAM,KAAK,UAAU,OAAO;GAC7B,CAAC;;CAGJ,MAAM,YAAY,IAA2B;AAC3C,SAAO,KAAK,QAAc,YAAY,MAAM,EAC1C,QAAQ,UACT,CAAC;;CAKJ,MAAM,aACJ,SACA,WACA,SAAwB,eACM;EAC9B,MAAM,OAAO,UAAU,KAAI,QAAO,KAAK,UAAU,IAAI,CAAC,CAAC,KAAK,KAAK;EACjE,MAAM,SAAS,IAAI,gBAAgB,EAAE,QAAQ,CAAC;AAE9C,SAAO,KAAK,QAA6B,YAAY,QAAQ,aAAa,UAAU;GAClF,QAAQ;GACR;GACD,CAAC;;CAGJ,MAAM,eACJ,SACA,YACA,SACY;AACZ,SAAO,KAAK,QAAW,YAAY,QAAQ,aAAa,cAAc;GACpE,QAAQ;GACR,MAAM,KAAK,UAAU,QAAQ;GAC9B,CAAC;;CAGJ,MAAM,eAAe,SAAiB,YAAmC;AACvE,SAAO,KAAK,QAAc,YAAY,QAAQ,aAAa,cAAc,EACvE,QAAQ,UACT,CAAC;;CAGJ,MAAM,gBACJ,SACA,SACe;EACf,MAAM,SAAS,IAAI,iBAAiB;AAEpC,MAAI,QAAQ,IACV,SAAQ,IAAI,SAAQ,OAAM,OAAO,OAAO,SAAS,GAAG,CAAC;AAGvD,MAAI,QAAQ,OACV,QAAO,OAAO,UAAU,QAAQ,OAAO;AAGzC,SAAO,KAAK,QAAc,YAAY,QAAQ,aAAa,UAAU,EACnE,QAAQ,UACT,CAAC;;CAKJ,MAAM,OACJ,SACA,QAC4B;EAC5B,MAAM,eAAe,IAAI,iBAAiB;AAE1C,MAAI,QAAQ,EAAG,cAAa,OAAO,KAAK,OAAO,EAAE;AACjD,MAAI,QAAQ,OAAQ,cAAa,OAAO,UAAU,OAAO,OAAO,UAAU,CAAC;AAC3E,MAAI,QAAQ,MAAO,cAAa,OAAO,SAAS,OAAO,MAAM,UAAU,CAAC;AACxE,MAAI,QAAQ,KAAM,cAAa,OAAO,QAAQ,OAAO,KAAK,UAAU,CAAC;AAErE,MAAI,QAAQ,KACV,QAAO,KAAK,SAAQ,MAAK,aAAa,OAAO,UAAU,EAAE,CAAC;AAG5D,MAAI,QAAQ,qBACV,QAAO,qBAAqB,SAAQ,SAClC,aAAa,OAAO,0BAA0B,KAAK,CACpD;AAGH,MAAI,QAAQ,oBACV,QAAO,oBAAoB,SAAQ,SACjC,aAAa,OAAO,yBAAyB,KAAK,CACnD;AAGH,SAAO,KAAK,QAA2B,YAAY,QAAQ,YAAY,gBAAgB,EACrF,QAAQ,QACT,CAAC;;CAKJ,MAA+B,SAAiC;AAC9D,SAAO;GACL,IAAI;GAEJ,SAAS,WAAW,KAAK,YAAY,SAAS,OAAO;GACrD,cAAc,KAAK,YAAY,QAAQ;GAEvC,eAAe,WAAW,WAAW,KAAK,aAAgB,SAAS,WAAW,OAAO;GACrF,iBAAiB,YAAY,YAAY,KAAK,eAAkB,SAAS,YAAY,QAAQ;GAC7F,iBAAiB,eAAe,KAAK,eAAe,SAAS,WAAW;GACxE,kBAAkB,YAAY,KAAK,gBAAgB,SAAS,QAAQ;GAEpE,SAAS,WAAW,KAAK,OAAU,SAAS,OAAO;GACpD;;;AAKL,SAAgB,aAAa,SAA4C;AACvE,QAAO,IAAI,aAAa,QAAQ"}
|