{"id":20528222,"url":"https://github.com/manticoresoftware/manticoresearch-typescript","last_synced_at":"2025-04-14T04:51:18.145Z","repository":{"id":196786522,"uuid":"696671221","full_name":"manticoresoftware/manticoresearch-typescript","owner":"manticoresoftware","description":"Official TypeScript client for Manticore Search","archived":false,"fork":false,"pushed_at":"2024-10-24T05:58:00.000Z","size":176,"stargazers_count":8,"open_issues_count":1,"forks_count":3,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-10-24T19:50:30.195Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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":"2023-09-26T08:03:09.000Z","updated_at":"2024-10-24T05:58:04.000Z","dependencies_parsed_at":"2023-09-27T15:47:20.111Z","dependency_job_id":"bc53698d-e928-4906-bdcf-56df439ff55e","html_url":"https://github.com/manticoresoftware/manticoresearch-typescript","commit_stats":null,"previous_names":["manticoresoftware/manticoresearch-typescript"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-typescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-typescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-typescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-typescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/manticoresoftware","download_url":"https://codeload.github.com/manticoresoftware/manticoresearch-typescript/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:00.844Z","updated_at":"2025-04-14T04:51:18.131Z","avatar_url":"https://github.com/manticoresoftware.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Manticore TypeScript client\n\n❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-typescript/tree/8.0.0\n\n## Compatibility Table\n\n| **manticoresearch-typescript** | **Manticore Search**                | **Node**            | **Compatibility**      |\n| ------------------------------ | ----------------------------------- | ------------------- | -----------------------|\n| `manticoresearch-ts-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 or newer                 | 4.2.1 to 7.0.0                      | Node 18 or newer    | ⚠️ Partially Compatible|\n| 3.3.1 to 6.0.0                 | 6.2.0 or newer                      | Node 18 or newer    | ✅ Fully Compatible    |\n| 3.3.1 to 6.0.0                 | 4.2.1 to 6.2.0                      | Node 18 or newer    | ⚠️ Partially Compatible|\n| 1.0.x to 3.3.1                 | 4.2.1 to 6.2.0                      | Node 18 or newer    | ✅ Fully Compatible    |\n\n## Installation\n\n```shell\nnpm install manticoresearch-ts \n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following typescript code:\n\n```javascript\nimport * as Manticoresearch from \"manticoresearch-ts\";\n(async () =\u003e {\n  try {\n    const serverConfig = new Manticoresearch.ServerConfiguration(\"http://localhost:9308\", {})\n    const config = Manticoresearch.createConfiguration({\n      baseServer: serverConfig,\n    });\n    indexApi = new Manticoresearch.IndexApi(config);\n    searchApi = new Manticoresearch.SearchApi(config);\n  \n    # Perform insert and search operations\n    await indexApi.insert({\"index\": \"products\", \"doc\" : {\"title\" : \"Crossbody Bag with Tassel\", \"price\" : 19.85}});\n    await indexApi.insert({\"index\": \"products\", \"doc\" : {\"title\" : \"microfiber sheet set\", \"price\" : 19.99}});\n\n    var search_query = new Manticoresearch.SearchQuery()\n    search_query.query_string = \"@title bag\"\n      \n    var search_request = new Manticoresearch.SearchRequest()\n    search_request.index = \"products\"\n    search_request.query = search_query\n    var query_highlight = new Manticoresearch.Highlight()\n    query_highlight.fields = {\"title\":{}}\n    search_request.highlight = query_highlight\n  \n    var search_response = await searchApi.search(search_request)\n    console.log(\"The response of SearchApi-\u003esearch:\\n\")    \n    console.log(search_response)\n\n    # Alternatively, you can pass all request arguments as JSON strings\n    search_response = await searchApi.search({\"index\": \"products\", \"query\": {\"query_string\": \"@title bag\"}, \"highlight\": {\"fields\": [\"title\"]}});\n    console.log(\"The response of SearchApi-\u003esearch:\\n\")    \n    console.log(search_response)\n  } catch (error) {\n    console.error(\"Error response:\", JSON.stringify(error));\n  }\n})();\n```\n\n## Documentation\n\nFull documentation on the API Endpoints and Models used is available in [docs](https://github.com/manticoresoftware/manticoresearch-typescript/tree/7.0.0/docs) folder as listed below.\n\nManticore Search server documentation: https://manual.manticoresearch.com.\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**](./IndexApi.md#bulk) | **POST** /bulk | Bulk table operations\n_Manticoresearch.IndexApi_ | [**delete**](./IndexApi.md#delete) | **POST** /delete | Delete a document in a table\n_Manticoresearch.IndexApi_ | [**insert**](./IndexApi.md#insert) | **POST** /insert | Create a new document in a table\n_Manticoresearch.IndexApi_ | [**partialReplace**](./IndexApi.md#partialReplace) | **POST** /{table}/_update/{id} | Partially replaces a document in a table\n_Manticoresearch.IndexApi_ | [**replace**](./IndexApi.md#replace) | **POST** /replace | Replace new document in a table\n_Manticoresearch.IndexApi_ | [**update**](./IndexApi.md#update) | **POST** /update | Update a document in a table\n_Manticoresearch.SearchApi_ | [**autocomplete**](./SearchApi.md#autocomplete) | **POST** /autocomplete | Performs an autocomplete search on a table\n_Manticoresearch.SearchApi_ | [**percolate**](./SearchApi.md#percolate) | **POST** /pq/{table}/search | Perform reverse search on a percolate table\n_Manticoresearch.SearchApi_ | [**search**](./SearchApi.md#search) | **POST** /search | Performs a search on a table\n_Manticoresearch.UtilsApi_ | [**sql**](./UtilsApi.md#sql) | **POST** /sql | Perform SQL requests\n\n\n## Documentation for Authorization\n\nAll endpoints do not require authorization.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanticoresoftware%2Fmanticoresearch-typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmanticoresoftware%2Fmanticoresearch-typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanticoresoftware%2Fmanticoresearch-typescript/lists"}