annosearch 0.0.1

package/README.md

@@ -0,0 +1,97 @@
+
+# Annotation Search
+
+AnnoSearch uses [Quickwit](https://quickwit.io) as its backend database to efficiently index and query [W3C Web Annotation](https://www.w3.org/TR/annotation-model/) data. Quickwit’s fast, scalable search engine enables AnnoSearch to handle large volumes of data and execute complex, full-text queries quickly. AnnoSearch can load data directly from [IIIF](https://iiif.io/) resources and web annotation servers such as [Miiify](https://github.com/nationalarchives/miiify).
+
+## Usage
+
+Make sure you have Quickwit installed and [running](https://quickwit.io/docs/get-started/quickstart) and then install AnnoSearch.
+
+```bash
+npm install annosearch
+```
+
+### Commands
+
+#### `init`
+
+Initialize a new index with a specified ID.
+
+```bash
+annosearch init --index <index-id>
+```
+
+#### `load`
+
+Load an index from a URI, specifying the type of content being loaded (e.g., Manifest, Collection, or AnnotationCollection).
+
+```bash
+annosearch load --index <index-id> --type <type> --uri <uri>
+```
+
+- `type`: The type of content (Manifest, Collection, AnnotationCollection).
+- `uri`: The URI to load the content from.
+
+#### `delete`
+
+Delete an existing index by ID.
+
+```bash
+annosearch delete --index <index-id>
+```
+
+#### `search`
+
+Perform a search on a specified index.
+
+```bash
+annosearch search --index <index-id> --query <search-query> [--page <page-number>]
+```
+
+- `query`: The search query string.
+- `page`: Optional page number (defaults to 0).
+
+#### `serve`
+
+Start a web server that provides a search service using the [IIIF Content Search 2.0 API](https://iiif.io/api/search/2.0/).
+
+```bash
+annosearch serve --port <port> --host <host>
+```
+
+- `port`: The port on which to run the server.
+- `host`: The host on which to run the server.
+
+#### `version`
+
+Display the current version of AnnoSearch.
+
+```bash
+annosearch version
+```
+
+
+## Configuration
+
+Configure AnnoSearch by setting the following environment variables:
+
+- **`ANNOSEARCH_MAX_HITS`**: Maximum number of search results per query.
+  - **Default**: `20`
+  
+- **`ANNOSEARCH_PORT`**: Port on which AnnoSearch runs.
+  - **Default**: `3000`
+
+- **`ANNOSEARCH_HOST`**: Host on which AnnoSearch runs.
+  - **Default**: `localhost`
+
+- **`ANNOSEARCH_PUBLIC_URL`**: URL for public-facing server requests.
+  - **Default**: `http://localhost:3000`
+
+Adjust these values as needed to customize AnnoSearch’s configuration and behavior.
+
+
+## License
+
+This project is licensed under the MIT License.
+
+

package/dist/package.json

@@ -0,0 +1,31 @@
+{
+    "name": "annosearch",
+    "version": "0.0.1",
+    "main": "dist/index.js",
+    "scripts": {
+        "build": "tsc",
+        "start": "ts-node src/index.ts",
+        "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "keywords": [],
+    "author": "John P. T. Moore",
+    "license": "MIT",
+    "description": "",
+    "devDependencies": {
+        "@types/express": "^5.0.0",
+        "@types/node": "^22.8.4",
+        "@types/pino": "^7.0.4",
+        "@types/yargs": "^17.0.33",
+        "maniiifest": "^1.2.9",
+        "typescript": "^5.6.3"
+    },
+    "dependencies": {
+        "axios": "^1.7.7",
+        "express": "^4.21.1",
+        "pino": "^9.5.0",
+        "pino-http": "^10.3.0",
+        "pino-pretty": "^12.1.0",
+        "yaml": "^2.6.0",
+        "yargs": "^17.7.2"
+    }
+}

package/dist/src/AnnoSearch.js

@@ -0,0 +1,65 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const search_1 = require("./search");
+const init_1 = require("./init");
+const delete_1 = require("./delete");
+const load_1 = require("./load");
+function loadConfig() {
+    return {
+        maxHits: parseInt(process.env.ANNOSEARCH_MAX_HITS || '20'),
+        port: parseInt(process.env.ANNOSEARCH_PORT || '3000'),
+        host: process.env.ANNOSEARCH_HOST || 'localhost',
+        searchUrl: process.env.ANNOSEARCH_PUBLIC_URL || 'http://localhost:3000',
+    };
+}
+class AnnoSearch {
+    constructor({ maxHits, port, host, searchUrl } = loadConfig()) {
+        this.maxHits = maxHits;
+        this.port = port;
+        this.host = host;
+        this.searchUrl = searchUrl;
+    }
+    getHost() {
+        return this.host;
+    }
+    getPort() {
+        return this.port;
+    }
+    getMaxHits() {
+        return this.maxHits;
+    }
+    getSearchUrl() {
+        return this.searchUrl;
+    }
+    loadIndex(indexId, uri, type) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield (0, load_1.loadIndex)(indexId, uri, type);
+        });
+    }
+    searchIndex(indexId, query, page) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, search_1.searchIndex)(indexId, query, this.maxHits, page, this.searchUrl);
+        });
+    }
+    initIndex(indexId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield (0, init_1.initIndex)(indexId);
+        });
+    }
+    deleteIndex(indexId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield (0, delete_1.deleteIndex)(indexId);
+        });
+    }
+}
+exports.default = AnnoSearch;
+//# sourceMappingURL=AnnoSearch.js.map

package/dist/src/AnnoSearch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnnoSearch.js","sourceRoot":"","sources":["../../src/AnnoSearch.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,qCAAyD;AACzD,iCAAmD;AACnD,qCAAyD;AACzD,iCAAmD;AASnD,SAAS,UAAU;IACf,OAAO;QACH,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,IAAI,CAAC;QAC1D,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,MAAM,CAAC;QACrD,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,WAAW;QAChD,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAqB,IAAI,uBAAuB;KAC1E,CAAC;AACN,CAAC;AAED,MAAM,UAAU;IAMZ,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,KAAa,UAAU,EAAE;QACjE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IAED,UAAU;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED,YAAY;QACR,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAEK,SAAS,CAAC,OAAe,EAAE,GAAW,EAAE,IAAY;;YACtD,OAAO,MAAM,IAAA,gBAAY,EAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAClD,CAAC;KAAA;IAEK,WAAW,CAAC,OAAe,EAAE,KAAa,EAAE,IAAY;;YAC1D,OAAO,IAAA,oBAAc,EAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9E,CAAC;KAAA;IAEK,SAAS,CAAC,OAAe;;YAC3B,OAAO,MAAM,IAAA,gBAAY,EAAC,OAAO,CAAC,CAAC;QACvC,CAAC;KAAA;IAEK,WAAW,CAAC,OAAe;;YAC7B,OAAO,MAAM,IAAA,oBAAc,EAAC,OAAO,CAAC,CAAC;QACzC,CAAC;KAAA;CACJ;AAED,kBAAe,UAAU,CAAC"}

package/dist/src/delete.js

@@ -0,0 +1,31 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteIndex = deleteIndex;
+const quickwit_1 = require("./quickwit");
+const errors_1 = require("./errors");
+const contentType = 'application/json';
+const quickwitClient = (0, quickwit_1.createClient)(contentType);
+function deleteIndex(indexId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!indexId.trim()) {
+            throw new errors_1.AnnoSearchValidationError('Invalid index parameter');
+        }
+        const response = yield quickwitClient.delete(`indexes/${indexId}`);
+        if (response.status === 200 && response.data) {
+            console.log('Index deleted successfully');
+        }
+        else {
+            throw new errors_1.AnnoSearchValidationError('Failed to delete index');
+        }
+    });
+}
+//# sourceMappingURL=delete.js.map

package/dist/src/delete.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete.js","sourceRoot":"","sources":["../../src/delete.ts"],"names":[],"mappings":";;;;;;;;;;;AAMA,kCAUC;AAhBD,yCAA0C;AAC1C,qCAAqD;AAErD,MAAM,WAAW,GAAG,kBAAkB,CAAC;AACvC,MAAM,cAAc,GAAG,IAAA,uBAAY,EAAC,WAAW,CAAC,CAAC;AAEjD,SAAsB,WAAW,CAAC,OAAe;;QAC7C,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;YAClB,MAAM,IAAI,kCAAyB,CAAC,yBAAyB,CAAC,CAAC;QACnE,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,WAAW,OAAO,EAAE,CAAC,CAAC;QACnE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC3C,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;QAC9C,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,kCAAyB,CAAC,wBAAwB,CAAC,CAAC;QAClE,CAAC;IACL,CAAC;CAAA"}

package/dist/src/errors.js

@@ -0,0 +1,37 @@
+"use strict";
+// errors.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnnoSearchParseError = exports.AnnoSearchNotFoundError = exports.AnnoSearchNetworkError = exports.AnnoSearchValidationError = exports.AnnoSearchError = void 0;
+class AnnoSearchError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = this.constructor.name;
+        Error.captureStackTrace(this, this.constructor); // Captures the correct stack trace
+    }
+}
+exports.AnnoSearchError = AnnoSearchError;
+class AnnoSearchValidationError extends AnnoSearchError {
+    constructor(message = 'Invalid input data') {
+        super(message);
+    }
+}
+exports.AnnoSearchValidationError = AnnoSearchValidationError;
+class AnnoSearchNetworkError extends AnnoSearchError {
+    constructor(message = 'Network error occurred') {
+        super(message);
+    }
+}
+exports.AnnoSearchNetworkError = AnnoSearchNetworkError;
+class AnnoSearchNotFoundError extends AnnoSearchError {
+    constructor(message = 'Resource not found') {
+        super(message);
+    }
+}
+exports.AnnoSearchNotFoundError = AnnoSearchNotFoundError;
+class AnnoSearchParseError extends AnnoSearchError {
+    constructor(message = 'Error parsing data') {
+        super(message);
+    }
+}
+exports.AnnoSearchParseError = AnnoSearchParseError;
+//# sourceMappingURL=errors.js.map

package/dist/src/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":";AAAA,YAAY;;;AAEZ,MAAa,eAAgB,SAAQ,KAAK;IACtC,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAClC,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,mCAAmC;IACxF,CAAC;CACJ;AAND,0CAMC;AAED,MAAa,yBAA0B,SAAQ,eAAe;IAC1D,YAAY,OAAO,GAAG,oBAAoB;QACtC,KAAK,CAAC,OAAO,CAAC,CAAC;IACnB,CAAC;CACJ;AAJD,8DAIC;AAED,MAAa,sBAAuB,SAAQ,eAAe;IACvD,YAAY,OAAO,GAAG,wBAAwB;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAC;IACnB,CAAC;CACJ;AAJD,wDAIC;AAED,MAAa,uBAAwB,SAAQ,eAAe;IACxD,YAAY,OAAO,GAAG,oBAAoB;QACtC,KAAK,CAAC,OAAO,CAAC,CAAC;IACnB,CAAC;CACJ;AAJD,0DAIC;AAED,MAAa,oBAAqB,SAAQ,eAAe;IACrD,YAAY,OAAO,GAAG,oBAAoB;QACtC,KAAK,CAAC,OAAO,CAAC,CAAC;IACnB,CAAC;CACJ;AAJD,oDAIC"}

package/dist/src/iiif.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeSearchResponse = makeSearchResponse;
+function makeSearchResponse(indexId, data, searchUrl, query, maxHits, page) {
+    const totalPages = Math.ceil(data.num_hits / maxHits);
+    const nextPage = page + 1 < totalPages ? page + 1 : null;
+    const prevPage = page > 0 ? page - 1 : null;
+    const q = encodeURIComponent(query);
+    return {
+        "@context": "http://www.w3.org/ns/anno.jsonld",
+        id: `${searchUrl}/${indexId}/search?q=${q}&page=${page}`,
+        type: "AnnotationPage",
+        partOf: totalPages > 1 ? {
+            id: `${searchUrl}/${indexId}/search?q=${q}`,
+            type: "AnnotationCollection",
+            total: data.num_hits,
+            first: {
+                id: `${searchUrl}/${indexId}/search?q=${q}&page=0`,
+                type: "AnnotationPage"
+            },
+            last: {
+                id: `${searchUrl}/${indexId}/search?q=${q}&page=${totalPages - 1}`,
+                type: "AnnotationPage"
+            }
+        } : undefined,
+        startIndex: page * maxHits,
+        items: data.hits.map((hit) => ({
+            "@context": "http://www.w3.org/ns/anno.jsonld",
+            id: hit.id,
+            type: hit.type,
+            body: hit.body,
+            target: hit.target,
+            motivation: hit.motivation,
+        })),
+        next: nextPage !== null ? `${searchUrl}/${indexId}/search?q=${q}&page=${nextPage}` : undefined,
+        prev: prevPage !== null ? `${searchUrl}/${indexId}/search?q=${q}&page=${prevPage}` : undefined,
+    };
+}
+//# sourceMappingURL=iiif.js.map

package/dist/src/iiif.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iiif.js","sourceRoot":"","sources":["../../src/iiif.ts"],"names":[],"mappings":";;AAwCA,gDAmCC;AAnCD,SAAgB,kBAAkB,CAAC,OAAe,EAAE,IAAS,EAAE,SAAiB,EAAE,KAAa,EAAE,OAAe,EAAE,IAAY;IAC1H,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,CAAC;IACtD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5C,MAAM,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAEpC,OAAO;QACH,UAAU,EAAE,kCAAkC;QAC9C,EAAE,EAAE,GAAG,SAAS,IAAI,OAAO,aAAa,CAAC,SAAS,IAAI,EAAE;QACxD,IAAI,EAAE,gBAAgB;QACtB,MAAM,EAAE,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC;YACrB,EAAE,EAAE,GAAG,SAAS,IAAI,OAAO,aAAa,CAAC,EAAE;YAC3C,IAAI,EAAE,sBAAsB;YAC5B,KAAK,EAAE,IAAI,CAAC,QAAQ;YACpB,KAAK,EAAE;gBACH,EAAE,EAAE,GAAG,SAAS,IAAI,OAAO,aAAa,CAAC,SAAS;gBAClD,IAAI,EAAE,gBAAgB;aACzB;YACD,IAAI,EAAE;gBACF,EAAE,EAAE,GAAG,SAAS,IAAI,OAAO,aAAa,CAAC,SAAS,UAAU,GAAG,CAAC,EAAE;gBAClE,IAAI,EAAE,gBAAgB;aACzB;SACJ,CAAC,CAAC,CAAC,SAAS;QACb,UAAU,EAAE,IAAI,GAAG,OAAO;QAC1B,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,CAAC;YAChC,UAAU,EAAE,kCAAkC;YAC9C,EAAE,EAAE,GAAG,CAAC,EAAE;YACV,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,UAAU,EAAE,GAAG,CAAC,UAAU;SAC7B,CAAC,CAAC;QACH,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,OAAO,aAAa,CAAC,SAAS,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;QAC9F,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,OAAO,aAAa,CAAC,SAAS,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;KACjG,CAAC;AACN,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,181 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
+const AnnoSearch_1 = __importDefault(require("./AnnoSearch"));
+const server_1 = require("./server");
+const utils_1 = require("./utils");
+const package_json_1 = require("../package.json"); // Import version from package.json
+const client = new AnnoSearch_1.default();
+function searchOptions(yargs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yargs
+            .option('index', {
+            alias: 'i',
+            type: 'string',
+            description: 'Index ID',
+            demandOption: true,
+        })
+            .option('query', {
+            alias: 'q',
+            type: 'string',
+            description: 'Search query',
+            demandOption: true,
+        })
+            .option('page', {
+            alias: 'p',
+            type: 'number',
+            description: 'Page number',
+            default: 0, // Default page number if not specified
+        });
+    });
+}
+function searchCommand(argv) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const results = yield client.searchIndex(argv.index, argv.query, argv.page);
+            (0, utils_1.printJson)(results);
+        }
+        catch (error) {
+            (0, utils_1.logError)(error);
+        }
+    });
+}
+function initCommand(argv) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            yield client.initIndex(argv.index);
+        }
+        catch (error) {
+            (0, utils_1.logError)(error);
+        }
+    });
+}
+function initOptions(yargs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yargs.option('index', {
+            alias: 'i',
+            type: 'string',
+            description: 'Index ID',
+            demandOption: true,
+        });
+    });
+}
+function loadCommand(argv) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            yield client.loadIndex(argv.index, argv.uri, argv.type);
+        }
+        catch (error) {
+            (0, utils_1.logError)(error);
+        }
+    });
+}
+function loadOptions(yargs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yargs
+            .option('index', {
+            alias: 'i',
+            type: 'string',
+            description: 'Index ID',
+            demandOption: true,
+        })
+            .option('type', {
+            alias: 't',
+            type: 'string',
+            description: 'Type of IIIF specification or W3C web annotation collection',
+            choices: ['Manifest', 'Collection', 'AnnotationCollection'],
+            demandOption: true,
+        })
+            .option('uri', {
+            alias: 'u',
+            type: 'string',
+            description: 'URI to load the index from',
+            demandOption: true,
+        });
+    });
+}
+function deleteCommand(argv) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            yield client.deleteIndex(argv.index);
+        }
+        catch (error) {
+            (0, utils_1.logError)(error);
+        }
+    });
+}
+function deleteOptions(yargs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yargs.option('index', {
+            alias: 'i',
+            type: 'string',
+            description: 'Index ID',
+            demandOption: true,
+        });
+    });
+}
+function serveOptions(yargs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yargs.option('port', {
+            type: 'number',
+            description: 'Port to run the server on',
+            default: client.getPort(),
+        })
+            .option('host', {
+            type: 'string',
+            description: 'Host to run the server on',
+            default: client.getHost(),
+        });
+    });
+}
+function serveCommand(yargs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        (0, server_1.serve)(client);
+    });
+}
+function versionOptions(yargs) {
+    return __awaiter(this, void 0, void 0, function* () { });
+}
+function versionCommand() {
+    (0, utils_1.printJson)({ version: package_json_1.version });
+}
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            yield (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+                .scriptName('annosearch')
+                .usage('$0 <command> [options]')
+                .command('init', 'Initialize an index with the provided ID', initOptions, initCommand)
+                .command('load', 'Load an index with the provided ID from a URI', loadOptions, loadCommand)
+                .command('delete', 'Delete an index with the provided ID', deleteOptions, deleteCommand)
+                .command('search', 'Perform a search query on a specified index', searchOptions, searchCommand)
+                .command('serve', 'Start an Express server to call search', serveOptions, serveCommand)
+                .command('version', 'Show the version of the application', versionOptions, versionCommand)
+                .demandCommand(1, 'You need to specify a command (e.g., search, version)')
+                .strict()
+                .help()
+                .alias('h', 'help')
+                .alias('v', 'version')
+                .showHelpOnFail(true)
+                .parseAsync();
+        }
+        catch (error) {
+            (0, utils_1.logError)(error);
+        }
+    });
+}
+main();
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,kDAAsC;AACtC,2CAAwC;AACxC,8DAAsC;AACtC,qCAAiC;AACjC,mCAA8C;AAC9C,kDAA0C,CAAC,mCAAmC;AAG9E,MAAM,MAAM,GAAG,IAAI,oBAAU,EAAE,CAAC;AAEhC,SAAe,aAAa,CAAC,KAAU;;QACnC,OAAO,KAAK;aACP,MAAM,CAAC,OAAO,EAAE;YACb,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,UAAU;YACvB,YAAY,EAAE,IAAI;SACrB,CAAC;aACD,MAAM,CAAC,OAAO,EAAE;YACb,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,cAAc;YAC3B,YAAY,EAAE,IAAI;SACrB,CAAC;aACD,MAAM,CAAC,MAAM,EAAE;YACZ,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,CAAC,EAAE,uCAAuC;SACtD,CAAC,CAAC;IACX,CAAC;CAAA;AAED,SAAe,aAAa,CAAC,IAAS;;QAClC,IAAI,CAAC;YACD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,KAAe,EAAE,IAAI,CAAC,KAAe,EAAE,IAAI,CAAC,IAAc,CAAC,CAAC;YAC1G,IAAA,iBAAS,EAAC,OAAO,CAAC,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAA,gBAAQ,EAAC,KAAK,CAAC,CAAC;QACpB,CAAC;IACL,CAAC;CAAA;AAED,SAAe,WAAW,CAAC,IAAS;;QAChC,IAAI,CAAC;YACD,MAAM,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,KAAe,CAAC,CAAC;QACjD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAA,gBAAQ,EAAC,KAAK,CAAC,CAAC;QACpB,CAAC;IACL,CAAC;CAAA;AAED,SAAe,WAAW,CAAC,KAAU;;QACjC,OAAO,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE;YACzB,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,UAAU;YACvB,YAAY,EAAE,IAAI;SACrB,CAAC,CAAC;IACP,CAAC;CAAA;AAED,SAAe,WAAW,CAAC,IAAS;;QAChC,IAAI,CAAC;YACD,MAAM,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,KAAe,EAAE,IAAI,CAAC,GAAa,EAAE,IAAI,CAAC,IAAc,CAAC,CAAC;QAC1F,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAA,gBAAQ,EAAC,KAAK,CAAC,CAAC;QACpB,CAAC;IACL,CAAC;CAAA;AAED,SAAe,WAAW,CAAC,KAAU;;QACjC,OAAO,KAAK;aACP,MAAM,CAAC,OAAO,EAAE;YACb,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,UAAU;YACvB,YAAY,EAAE,IAAI;SACrB,CAAC;aACD,MAAM,CAAC,MAAM,EAAE;YACZ,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,6DAA6D;YAC1E,OAAO,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,sBAAsB,CAAC;YAC3D,YAAY,EAAE,IAAI;SACrB,CAAC;aACD,MAAM,CAAC,KAAK,EAAE;YACX,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,4BAA4B;YACzC,YAAY,EAAE,IAAI;SACrB,CAAC,CAAC;IACX,CAAC;CAAA;AAED,SAAe,aAAa,CAAC,IAAS;;QAClC,IAAI,CAAC;YACD,MAAM,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,KAAe,CAAC,CAAC;QACnD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAA,gBAAQ,EAAC,KAAK,CAAC,CAAC;QACpB,CAAC;IACL,CAAC;CAAA;AAED,SAAe,aAAa,CAAC,KAAU;;QACnC,OAAO,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE;YACzB,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,UAAU;YACvB,YAAY,EAAE,IAAI;SACrB,CAAC,CAAC;IACP,CAAC;CAAA;AAED,SAAe,YAAY,CAAC,KAAU;;QAClC,OAAO,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE;YACxB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,2BAA2B;YACxC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;SAC5B,CAAC;aACG,MAAM,CAAC,MAAM,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,2BAA2B;YACxC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;SAC5B,CAAC,CAAC;IACX,CAAC;CAAA;AAED,SAAe,YAAY,CAAC,KAAU;;QAClC,IAAA,cAAK,EAAC,MAAM,CAAC,CAAC;IAClB,CAAC;CAAA;AAED,SAAe,cAAc,CAAC,KAAU;0DAAI,CAAC;CAAA;AAE7C,SAAS,cAAc;IACnB,IAAA,iBAAS,EAAC,EAAE,OAAO,EAAP,sBAAO,EAAE,CAAC,CAAC;AAC3B,CAAC;AAED,SAAe,IAAI;;QACf,IAAI,CAAC;YACD,MAAM,IAAA,eAAK,EAAC,IAAA,iBAAO,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC;iBAC7B,UAAU,CAAC,YAAY,CAAC;iBACxB,KAAK,CAAC,wBAAwB,CAAC;iBAC/B,OAAO,CAAC,MAAM,EAAE,0CAA0C,EAAE,WAAW,EAAE,WAAW,CAAC;iBACrF,OAAO,CAAC,MAAM,EAAE,+CAA+C,EAAE,WAAW,EAAE,WAAW,CAAC;iBAC1F,OAAO,CAAC,QAAQ,EAAE,sCAAsC,EAAE,aAAa,EAAE,aAAa,CAAC;iBACvF,OAAO,CAAC,QAAQ,EAAE,6CAA6C,EAAE,aAAa,EAAE,aAAa,CAAC;iBAC9F,OAAO,CAAC,OAAO,EAAE,wCAAwC,EAAE,YAAY,EAAE,YAAY,CAAC;iBACtF,OAAO,CAAC,SAAS,EAAE,qCAAqC,EAAE,cAAc,EAAE,cAAc,CAAC;iBACzF,aAAa,CAAC,CAAC,EAAE,uDAAuD,CAAC;iBACzE,MAAM,EAAE;iBACR,IAAI,EAAE;iBACN,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC;iBAClB,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC;iBACrB,cAAc,CAAC,IAAI,CAAC;iBACpB,UAAU,EAAE,CAAC;QACtB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAA,gBAAQ,EAAC,KAAK,CAAC,CAAC;QACpB,CAAC;IACL,CAAC;CAAA;AAED,IAAI,EAAE,CAAC"}

package/dist/src/init.js

@@ -0,0 +1,51 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initIndex = initIndex;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const yaml_1 = __importDefault(require("yaml"));
+const quickwit_1 = require("./quickwit");
+const errors_1 = require("./errors");
+const contentType = 'application/yaml';
+const quickwitClient = (0, quickwit_1.createClient)(contentType);
+// Function to read YAML configuration file
+function readYamlConfig(filePath) {
+    const yamlData = fs_1.default.readFileSync(filePath, 'utf8');
+    return yaml_1.default.parse(yamlData);
+}
+// Function to modify the configuration with the provided index ID
+function modifyConfig(config, indexId) {
+    config.index_id = indexId;
+    return yaml_1.default.stringify(config);
+}
+// Initialization function
+function initIndex(indexId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!indexId.trim()) {
+            throw new errors_1.AnnoSearchValidationError('Invalid index parameter');
+        }
+        const filePath = path_1.default.resolve(__dirname, 'index-config.yaml');
+        const config = readYamlConfig(filePath);
+        const modifiedYamlData = modifyConfig(config, indexId);
+        const response = yield quickwitClient.post('indexes', modifiedYamlData);
+        if (response.status === 200 && response.data) {
+            console.log('Index created successfully');
+        }
+        else {
+            throw new errors_1.AnnoSearchValidationError('Failed to create index');
+        }
+    });
+}
+//# sourceMappingURL=init.js.map

package/dist/src/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../src/init.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAwBA,8BAcC;AAtCD,4CAAoB;AACpB,gDAAwB;AACxB,gDAAwB;AACxB,yCAA0C;AAC1C,qCAAqD;AAGrD,MAAM,WAAW,GAAG,kBAAkB,CAAC;AACvC,MAAM,cAAc,GAAG,IAAA,uBAAY,EAAC,WAAW,CAAC,CAAC;AAEjD,2CAA2C;AAC3C,SAAS,cAAc,CAAC,QAAgB;IACpC,MAAM,QAAQ,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACnD,OAAO,cAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;AAChC,CAAC;AAED,kEAAkE;AAClE,SAAS,YAAY,CAAC,MAAW,EAAE,OAAe;IAC9C,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,OAAO,cAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAClC,CAAC;AAGD,0BAA0B;AAC1B,SAAsB,SAAS,CAAC,OAAe;;QAC3C,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;YAClB,MAAM,IAAI,kCAAyB,CAAC,yBAAyB,CAAC,CAAC;QACnE,CAAC;QACD,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,gBAAgB,GAAG,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACvD,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACxE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC3C,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;QAC9C,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,kCAAyB,CAAC,wBAAwB,CAAC,CAAC;QAClE,CAAC;IAEL,CAAC;CAAA"}