aiiinotate 0.4.2 → 0.4.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aiiinotate",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "a fast IIIF-compliant annotation server",
   "main": "./cli/index.js",
   "type": "module",

package/src/data/annotations/annotations2.js

@@ -346,7 +346,8 @@ class Annotations2 extends CollectionAbstract {
   }
 
   /**
-   * implementation of the IIIF Search API 1.0
+   * implementation of the IIIF Search API 1.0.
+   * function arguments have been validated by JSONSchemas at route-level so they're clean.
    *
    * NOTE:
    *  - only `motivation` and `q` search params are implemented
@@ -354,6 +355,7 @@ class Annotations2 extends CollectionAbstract {
    *    implemented for `q` and `motivation` (in the IIIF specs, you can supply
    *    multiple space-separated values and the server should return all partial
    *    matches to any of those strings.)
+   * - non-standard `canvasMin` and `canvasMax` parameters are implemented: search by annotation's target canvas position.
    *
    * see:
    *  https://iiif.io/api/search/1.0/
@@ -361,11 +363,13 @@ class Annotations2 extends CollectionAbstract {
    *
    * @param {string} queryUrl
    * @param {string} manifestShortId
-   * @param {string} q
-   * @param {"painting"|"non-painting"|"commenting"|"describing"|"tagging"|"linking"} motivation
+   * @param {string?} q
+   * @param {"painting"|"non-painting"|"commenting"|"describing"|"tagging"|"linking"?} motivation
+   * @param {number?} canvasMin - minimum value of `on.canvasIdx`, inclusive
+   * @param {number?} canvasMax - maximum value of `on.canvasIdx`, inclusive
    * @returns {object} annotationList containing results
    */
-  async search(queryUrl, manifestShortId, q, motivation) {
+  async search(queryUrl, manifestShortId, q, motivation, canvasMin, canvasMax) {
     const
       queryBase = { "on.manifestShortId": manifestShortId },
       queryFilters = { $and: [] };
@@ -379,7 +383,7 @@ class Annotations2 extends CollectionAbstract {
           { "resource.chars": q }
         ]
       });
-    }
+    };
     if ( motivation ) {
       queryFilters.$and.push(
         motivation === "non-painting"
@@ -388,6 +392,23 @@ class Annotations2 extends CollectionAbstract {
             ? { motivation: "sc:painting" }
             : { motivation: `oa:${motivation}` }
       );
+    };
+    // TODO test
+    if ( canvasMin ) {
+      // if canvasMax is undefined, then search for canvasIdx===canvasMin
+      if ( !canvasMax ) {
+        queryFilters.$and.push({ "on.canvasIdx": canvasMin })
+      // if canvasMin and canvasMax, canvasIdx must be in [canvasMin, canvasMax] (inclusive).
+      } else {
+        queryFilters.$and.push({
+          "on.canvasIdx": {
+            $and: [
+              { $gte: canvasMin },
+              { $lte: canvasMax },
+            ]
+          }
+        })
+      }
     }
     const query =
       queryFilters.$and.length

package/src/data/annotations/annotations3.js

@@ -4,12 +4,12 @@ import CollectionAbstract from "#data/collectionAbstract.js";
 
 /** @typedef {import("#types").FastifyInstanceType} FastifyInstanceType */
 
-/** @typedef {Annnotations3} Annotations3InstanceType */
+/** @typedef {Annotations3} Annotations3InstanceType */
 
 /**
  * @extends {CollectionAbstract}
  */
-class Annnotations3 extends CollectionAbstract {
+class Annotations3 extends CollectionAbstract {
   /**
    * @param {FastifyInstanceType} fastify
    */
@@ -17,14 +17,10 @@ class Annnotations3 extends CollectionAbstract {
     super(fastify, "annotations3");
   }
 
-  notImplementedError() {
-    throw this.errorNoAction(`${this.constructor.name}: not implemented`);
-  }
-
 }
 
 export default fastifyPlugin((fastify, options, done) => {
-  fastify.decorate("annnotations3", new Annnotations3(fastify));
+  fastify.decorate("annotations3", new Annotations3(fastify));
   done();
 }, {
   name: "annotations3",

package/src/data/collectionAbstract.js

@@ -20,8 +20,8 @@ class CollectionAbstractError extends Error {
    */
   constructor(collectionName, operation, message, errInfo) {
     const
-      collInfo = collectionName ? `on collection '${collectionName}',` : "",
-      operationInfo = operation ? `when performing operation '${operation.toLocaleLowerCase()}'`: "";
+      collInfo = collectionName ? `on collection '${collectionName}'` : "",
+      operationInfo = operation ? `, when performing operation '${operation.toLocaleLowerCase()}'`: "";
     super(`CollectionAbstractError: ${collInfo} ${operationInfo}: ${message}`);
     this.info = errInfo;
   }
@@ -176,6 +176,10 @@ class CollectionAbstract {
     throw this.errorConstructor(operation)(err.message, err.errorResponse);
   }
 
+  notImplementedError() {
+    throw this.errorNoAction("not implemented");
+  }
+
   //////////////////////////////////////
   // INSERT/UPDATE
 

package/src/data/routes.js

@@ -1,6 +1,6 @@
 import fastifyPlugin from "fastify-plugin"
 
-import { pathToUrl, ajvCompile, inspectObj, getFirstNonEmptyPair } from "#utils/utils.js";
+import { pathToUrl, ajvCompile, inspectObj, getFirstNonEmptyPair, visibleLog } from "#utils/utils.js";
 import { returnError, makeResponsePostSchema } from "#utils/routeUtils.js";
 
 /** @typedef {import("#types").Manifests2InstanceType} Manifests2InstanceType */
@@ -53,22 +53,42 @@ function commonRoutes(fastify, options, done) {
             motivation: {
               type: "string",
               enum: ["painting", "non-painting", "commenting", "describing", "tagging", "linking"]
+            },
+            canvasMin: {
+              type: "integer",
+              minimum: 0
+            },
+            canvasMax: {
+              type: ["integer","null"],
+              minimum: 0
             }
           }
         },
         response: {
           200: iiifAnnotationListSchema
         }
+      },
+      preValidation: async (request, reply) => {
+        const
+          { canvasMin, canvasMax } = request.query,
+          error = new Error(`Error validating GET search-api route: 'canvasMin' must be smaller than 'canvasMax'. If 'canvasMax' is defined, 'canvasMin' must be defined as well. Got canvasMin=${canvasMin}, canvasMax=${canvasMax}`);
+        if (
+          (canvasMin == null && canvasMax != null)
+          || (canvasMin > canvasMax)
+        ) {
+          returnError(request, reply, error, {}, 400);
+        }
+        return;
       }
     },
     async (request, reply) => {
       const
         queryUrl = pathToUrl(request.url),
         { iiifSearchVersion, manifestShortId } = request.params,
-        { q, motivation } = request.query;
+        { q, motivation, canvasMin, canvasMax } = request.query;
 
       if ( iiifSearchVersion===1 ) {
-        return await annotations2.search(queryUrl, manifestShortId, q, motivation);
+        return await annotations2.search(queryUrl, manifestShortId, q, motivation, canvasMin, canvasMax);
       } else {
         annotations3.notImplementedError();
       }

package/src/data/routes.test.js

@@ -32,6 +32,19 @@ test("test common routes", async (t) => {
     throw err;
   }
 
+  ////////////////////////////////////////////////
+  // GET routes
+
+  await t.test("test route /search-api/:iiifSearchVersion/manifests/:manifestShortId/search", async (t) => {
+
+    // TODO
+    // q
+    // motivation
+    // canvasMin
+    // canvasMax
+
+  })
+
   ////////////////////////////////////////////////
   // DELETE routes