{"id":20528252,"url":"https://github.com/manticoresoftware/manticoresearch-javascript","last_synced_at":"2025-04-14T04:51:11.834Z","repository":{"id":52467399,"uuid":"288426751","full_name":"manticoresoftware/manticoresearch-javascript","owner":"manticoresoftware","description":"Official Javascript client for Manticore Search","archived":false,"fork":false,"pushed_at":"2025-03-12T09:45:40.000Z","size":525,"stargazers_count":32,"open_issues_count":4,"forks_count":4,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-27T18:52:26.472Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/manticoresoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-18T10:38:10.000Z","updated_at":"2025-03-12T09:45:45.000Z","dependencies_parsed_at":"2025-02-12T16:40:56.377Z","dependency_job_id":null,"html_url":"https://github.com/manticoresoftware/manticoresearch-javascript","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-javascript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-javascript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-javascript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-javascript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/manticoresoftware","download_url":"https://codeload.github.com/manticoresoftware/manticoresearch-javascript/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248824693,"owners_count":21167343,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T23:24:10.583Z","updated_at":"2025-04-14T04:51:11.826Z","avatar_url":"https://github.com/manticoresoftware.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Manticore Javascript client\n\nСlient for Manticore Search.\n\n\n❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-javascript/tree/8.0.0\n\n## Compatibility Table\n\nMinimum Manticore Search version is 2.5.1 with HTTP protocol enabled.\n\n| **manticoresearch-javascript*  | **Manticore Search**                | **Node**            | **Compatibility**       |\n| ------------------------------ | ----------------------------------- | ------------------- | ------------------------|\n| `manticoresearch-dev`          | `dev` (latest development version)  | Node 18 or newer    | ✅ Fully Compatible     |\n| 8.0.0 or newer                 | 9.2.14 or newer                     | Node 18 or newer    | ✅ Fully Compatible     |\n| 6.0.0 to 8.0.0                 | 9.2.14 or newer                     | Node 18 or newer    | ⚠️ Partially Compatible |\n| 6.0.0 to 8.0.0                 | 7.0.0 to 9.2.14                     | Node 18 or newer    | ✅ Fully Compatible     |\n| 6.0.0 to 8.0.0                 | 6.2.1 to 7.0.0                      | Node 18 or newer    | ⚠️ Partially Compatible |\n| 3.3.1 to 6.0.0                 | 7.0.0 or newer                      | Node 10 or newer    | ⚠️ Partially Compatible |\n| 3.3.1 to 6.0.0                 | 6.2.1 to 7.0.0                      | Node 10 or newer    | ✅ Fully Compatible     |\n| 3.0.0 to 3.3.1                 | 6.2.0 or newer                      | Node 10 or newer    | ⚠️ Partially Compatible |\n| 3.0.0 to 3.3.1                 | 4.2.1 to 6.2.0                      | Node 10 or newer    | ✅ Fully Compatible     |\n| 2.0.3 to 3.0.0                 | 4.0.2 to 4.2.1                      | Node 10 or newer    | ✅ Fully Compatible     |\n| 2.0.2 to 2.0.3                 | 4.0.2 to 4.2.1                      | Node  8 or newer    | ⚠️ Partially Compatible |\n| 2.0.2 to 2.0.3                 | 2.5.1 to 4.0.2                      | Node  8 or newer    | ✅ Fully Compatible     |\n\n## Installation\n\n```shell\nnpm install manticoresearch\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following JS code:\n\n```javascript\nvar Manticoresearch = require('manticoresearch');\n\n\n# Create instances of API classes\nvar client= new Manticoresearch.ApiClient();\nclient.basePath=\"http://127.0.0.1:9308\";\nindexApi = new Manticoresearch.IndexApi(client);\nsearchApi = new Manticoresearch.SearchApi(client);\n\n# Perform insert and search operations\nawait indexApi.insert({\"index\": \"products\", \"doc\" : {\"title\" : \"Crossbody Bag with Tassel\", \"price\" : 19.85}});\nawait indexApi.insert({\"index\": \"products\", \"doc\" : {\"title\" : \"microfiber sheet set\", \"price\" : 19.99}});\n\nvar search_query = new Manticoresearch.SearchQuery()\nsearch_query.query_string = \"@title bag\"\n      \nvar search_request = new Manticoresearch.SearchRequest()\nsearch_request.index = \"products\"\nsearch_request.query = search_query\nvar query_highlight = new Manticoresearch.Highlight()\nquery_highlight.fields = {\"title\":{}}\nsearch_request.highlight = query_highlight\n  \nvar search_response = await searchApi.search(search_request)\nconsole.log(\"The response of SearchApi-\u003esearch:\\n\")    \nconsole.log(search_response)\n\n# Alternatively, you can pass all request arguments as JSON strings\nsearch_response = await searchApi.search({\"index\": \"products\", \"query\": {\"query_string\": \"@title bag\"}, \"highlight\": {\"fields\": [\"title\"]}});\nconsole.log(\"The response of SearchApi-\u003esearch:\\n\")    \nconsole.log(search_response)\n\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://127.0.0.1:9308*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*Manticoresearch.IndexApi* | [**bulk**](docs/IndexApi.md#bulk) | **POST** /bulk | Bulk table operations\n*Manticoresearch.IndexApi* | [**callDelete**](docs/IndexApi.md#callDelete) | **POST** /delete | Delete a document in a table\n*Manticoresearch.IndexApi* | [**insert**](docs/IndexApi.md#insert) | **POST** /insert | Create a new document in a table\n*Manticoresearch.IndexApi* | [**partialReplace**](docs/IndexApi.md#partialReplace) | **POST** /{table}/_update/{id} | Partially replaces a document in a table\n*Manticoresearch.IndexApi* | [**replace**](docs/IndexApi.md#replace) | **POST** /replace | Replace new document in a table\n*Manticoresearch.IndexApi* | [**update**](docs/IndexApi.md#update) | **POST** /update | Update a document in a table\n*Manticoresearch.SearchApi* | [**autocomplete**](docs/SearchApi.md#autocomplete) | **POST** /autocomplete | Performs an autocomplete search on a table\n*Manticoresearch.SearchApi* | [**percolate**](docs/SearchApi.md#percolate) | **POST** /pq/{table}/search | Perform reverse search on a percolate table\n*Manticoresearch.SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /search | Performs a search on a table\n*Manticoresearch.UtilsApi* | [**sql**](docs/UtilsApi.md#sql) | **POST** /sql | Perform SQL requests\n\n\n## Documentation for Models\n\n - [Manticoresearch.AggComposite](docs/AggComposite.md)\n - [Manticoresearch.AggCompositeSource](docs/AggCompositeSource.md)\n - [Manticoresearch.AggCompositeTerm](docs/AggCompositeTerm.md)\n - [Manticoresearch.AggTerms](docs/AggTerms.md)\n - [Manticoresearch.Aggregation](docs/Aggregation.md)\n - [Manticoresearch.AutocompleteRequest](docs/AutocompleteRequest.md)\n - [Manticoresearch.BoolFilter](docs/BoolFilter.md)\n - [Manticoresearch.BulkResponse](docs/BulkResponse.md)\n - [Manticoresearch.DeleteDocumentRequest](docs/DeleteDocumentRequest.md)\n - [Manticoresearch.DeleteResponse](docs/DeleteResponse.md)\n - [Manticoresearch.ErrorResponse](docs/ErrorResponse.md)\n - [Manticoresearch.FulltextFilter](docs/FulltextFilter.md)\n - [Manticoresearch.GeoDistance](docs/GeoDistance.md)\n - [Manticoresearch.GeoDistanceLocationAnchor](docs/GeoDistanceLocationAnchor.md)\n - [Manticoresearch.Highlight](docs/Highlight.md)\n - [Manticoresearch.HighlightFieldOption](docs/HighlightFieldOption.md)\n - [Manticoresearch.HitsHits](docs/HitsHits.md)\n - [Manticoresearch.InsertDocumentRequest](docs/InsertDocumentRequest.md)\n - [Manticoresearch.Join](docs/Join.md)\n - [Manticoresearch.JoinCond](docs/JoinCond.md)\n - [Manticoresearch.JoinOn](docs/JoinOn.md)\n - [Manticoresearch.KnnQuery](docs/KnnQuery.md)\n - [Manticoresearch.Match](docs/Match.md)\n - [Manticoresearch.MatchAll](docs/MatchAll.md)\n - [Manticoresearch.PercolateRequest](docs/PercolateRequest.md)\n - [Manticoresearch.PercolateRequestQuery](docs/PercolateRequestQuery.md)\n - [Manticoresearch.QueryFilter](docs/QueryFilter.md)\n - [Manticoresearch.Range](docs/Range.md)\n - [Manticoresearch.ReplaceDocumentRequest](docs/ReplaceDocumentRequest.md)\n - [Manticoresearch.ResponseError](docs/ResponseError.md)\n - [Manticoresearch.ResponseErrorDetails](docs/ResponseErrorDetails.md)\n - [Manticoresearch.SearchQuery](docs/SearchQuery.md)\n - [Manticoresearch.SearchRequest](docs/SearchRequest.md)\n - [Manticoresearch.SearchResponse](docs/SearchResponse.md)\n - [Manticoresearch.SearchResponseHits](docs/SearchResponseHits.md)\n - [Manticoresearch.SourceRules](docs/SourceRules.md)\n - [Manticoresearch.SqlObjResponse](docs/SqlObjResponse.md)\n - [Manticoresearch.SqlResponse](docs/SqlResponse.md)\n - [Manticoresearch.SuccessResponse](docs/SuccessResponse.md)\n - [Manticoresearch.UpdateDocumentRequest](docs/UpdateDocumentRequest.md)\n - [Manticoresearch.UpdateResponse](docs/UpdateResponse.md)\n\n\n## Documentation for Authorization\n\nEndpoints do not require authorization.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanticoresoftware%2Fmanticoresearch-javascript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmanticoresoftware%2Fmanticoresearch-javascript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanticoresoftware%2Fmanticoresearch-javascript/lists"}