@xapp/stentor-service-search 1.86.6 → 1.86.8
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 +31 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1 +1,31 @@
|
|
|
1
|
-
|
|
1
|
+
## @xapp/stentor-service-search
|
|
2
|
+
|
|
3
|
+
Podcast episode search service backed by an AWS OpenSearch (Elasticsearch) domain. `ESSearchService` implements the `SearchService` interface to query, store, and load `PodcastEpisode` documents in a `podcast` index, authenticating requests with AWS SigV4 via the default AWS credential provider chain.
|
|
4
|
+
|
|
5
|
+
### Required Environment Variables
|
|
6
|
+
|
|
7
|
+
Both are optional and only used when the matching constructor option is not passed:
|
|
8
|
+
|
|
9
|
+
- `AWS_ES_SERVER` - OpenSearch domain host; defaults to `search-stentor-media-prod.xappmedia.com`
|
|
10
|
+
- `AWS_REGION` - region used for SigV4 signing; defaults to `us-east-1`
|
|
11
|
+
|
|
12
|
+
### Usage
|
|
13
|
+
|
|
14
|
+
```ts
|
|
15
|
+
import { ESSearchService } from "@xapp/stentor-service-search";
|
|
16
|
+
|
|
17
|
+
const search = new ESSearchService({
|
|
18
|
+
host: "search-my-domain.us-east-1.es.amazonaws.com",
|
|
19
|
+
region: "us-east-1"
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
const episodes = await search.queryPodcastEpisode(["podcast-id"], "search term");
|
|
23
|
+
await search.storePodcastEpisode("podcast-id", episode);
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
`removePodcastEpisode` is not yet implemented and throws.
|
|
27
|
+
|
|
28
|
+
### Documentation
|
|
29
|
+
|
|
30
|
+
- [OpenSearch documentation](https://opensearch.org/docs/latest/)
|
|
31
|
+
- [AWS SigV4 request signing](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/request-signing.html)
|
package/package.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
7
|
-
"version": "1.86.
|
|
7
|
+
"version": "1.86.8",
|
|
8
8
|
"description": "PLACEHOLDER DESCRIPTION OF PACKAGE",
|
|
9
9
|
"types": "lib/index",
|
|
10
10
|
"main": "lib/index",
|
|
@@ -18,12 +18,12 @@
|
|
|
18
18
|
"@types/chai": "5.2.3",
|
|
19
19
|
"@xapp/config": "0.3.0",
|
|
20
20
|
"chai": "4.5.0",
|
|
21
|
-
"stentor-media": "1.74.
|
|
21
|
+
"stentor-media": "1.74.11",
|
|
22
22
|
"stentor-models": "1.79.0",
|
|
23
23
|
"typescript": "5.9.3"
|
|
24
24
|
},
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.972.
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.972.83",
|
|
27
27
|
"@opensearch-project/opensearch": "3.6.0"
|
|
28
28
|
},
|
|
29
29
|
"peerDependencies": {
|