Search Against Annotation Text Indexes (#223)

* Bring in search logic

* It searches!

* idNegotiation on search results

* All the search logic

* Lint, and add support for passing search options into the endpoint

* polish

* Update API documentation

* polish

* polish

* polish

* polish

* polish

* polish

* polish

* polish

* exists test for new routes

* Update public/API.html

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update public/API.html

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update public/API.html

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update controllers/search.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update controllers/search.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* get rid of utils. prefix from createExpressError

* Update public/API.html

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update public/API.html

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* slop formatting

* Touch ups to API.html as discussed at standup.

* bump version because of new search feature

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: thehabes

.github/copilot-instructions.md

@@ -28,7 +28,7 @@ RERUM API v1 is a NodeJS web service for interaction with the RERUM digital obje
 3. **Create .env configuration file** (required for operation):
    ```bash
    # Create .env file in repository root
-   RERUM_API_VERSION=1.0.0
+   RERUM_API_VERSION=1.1.0
    RERUM_BASE=http://localhost:3005
    RERUM_PREFIX=http://localhost:3005/v1/
    RERUM_ID_PREFIX=http://localhost:3005/v1/id/

CONTRIBUTING.md

@@ -39,7 +39,7 @@ npm install
 Create a file named `.env` in the root folder.  In the above example, the root is `/code_folder/rerum_api`.  `/code_folder/rerum_api/.env` looks like this:
 
 ```shell
-RERUM_API_VERSION = 1.0.0
+RERUM_API_VERSION = 1.1.0
 COLLECTION_ACCEPTEDSERVER = acceptedServer
 COLLECTION_V0 = annotation
 AUDIENCE = http://rerum.io/api

README.md

@@ -64,7 +64,7 @@ npm install
 Create a file named `.env` in the root folder.  In the above example, the root is `/code_folder/rerum_api`.  `/code_folder/rerum_api/.env` looks like this:
 
 ```shell
-RERUM_API_VERSION = 1.0.0
+RERUM_API_VERSION = 1.1.0
 RERUM_BASE = URL_OF_YOUR_DEPLOYMENT
 RERUM_PREFIX = URL_OF_YOUR_DEPLOYMENT/v1/
 RERUM_ID_PREFIX = URL_OF_YOUR_DEPLOYMENT/v1/id/

__tests__/routes_mounted.test.js

@@ -105,6 +105,14 @@ describe('Check to see that all /v1/api/ route patterns exist.', () => {
     expect(routeExists(api_stack, '/api/release')).toBe(true)
   })
 
+  it('/v1/api/search -- mounted ', () => {
+    expect(routeExists(api_stack, '/api/search')).toBe(true)
+  })
+
+  it('/v1/api/search/phrase -- mounted ', () => {
+    expect(routeExists(api_stack, '/api/search/phrase')).toBe(true)
+  })
+
 })
 
 describe('Check to see that critical static files are present', () => {

app.js

@@ -58,6 +58,7 @@ app.use(
 )
 app.use(logger('dev'))
 app.use(express.json())
+app.use(express.text())
 app.use(express.urlencoded({ extended: true }))
 app.use(cookieParser())