aiiinotate 0.4.0 → 0.4.2

package/docs/endpoints.md

@@ -38,7 +38,7 @@ Implementation of the [IIIF Search API](https://iiif.io/api/search/2.0/), to sea
         - if `iiif_version=1`, `q` is searched in the fields: `@id`, `resource.@id` or `resource.chars` fields
     - `motivation` (`painting | non-painting | commenting | describing | tagging | linking`): values for the `motivation` field of an annotation
 
-#### Reply
+#### Response
 
 Returns a JSON. If `iiif_version` is `1`, an `AnnotationList` is returned. Otherwise, an `AnnotationPage` is returned.
 
@@ -69,7 +69,7 @@ DELETE /{collection_name}/{iiif_version}/delete
         - `manifestShortId`: a manifest's identifier, to delete all annotations for a manifest
         - `canvasUri`: the full URI to an annotation's target canvas, to delete all annotatons for the canvas
 
-#### Reply
+#### Response
 
 ```
 { deletedCount: <integer> }
@@ -92,7 +92,7 @@ Returns a Collection of all manifests in your **aiiinotate** instance.
 - Variables:
     - `iiif_version` (`2 | 3`): the IIIF Presentation API version
 
-#### Reply
+#### Response
 
 A IIIF `Collection`, following the IIIF Presentation API 2 or 3, depending of the value of `iiif_version`.
 
@@ -110,7 +110,7 @@ POST /manifests/{iiif_version}/create
     - `iiif_version` (`2 | 3`): the IIIF Presentation API version of your manifest
 - Body (`JSON`): the manifest  to index in the database
 
-#### Reply
+#### Response
 
 ```
 { 
@@ -142,12 +142,35 @@ GET /annotations/{iiif_version}/search
     - `uri` (`string`): the URI of the target canvas
     - `asAnnotationList` (`true | false`):  format of the response
 
-#### Reply
+#### Response
 
 `Object[] | Object`: if `true`, return an array of annotations. Otherwise, return an `AnnotationList`.
 
 ---
 
+### Count annotations
+
+```
+GET /annotations/{iiif_version}/count
+```
+
+#### Request
+
+- Variables:
+    - `iiif_version` (`2 | 3`): the IIIF Presentation API of your manifests
+- Parameters:
+    - `uri` (`string`): the annotation's `@id`
+    - `canvasUri` (`string`): the annotation's target canvas (`on.full`)
+    - `manifestShortId` (`string`): the short ID of the annotation's target manifest (`on.manifestShortId`)
+
+#### Response
+
+```
+{ count: integer }
+```
+
+---
+
 ### Get a single annotation
 
 ```
@@ -163,7 +186,7 @@ This route allows to query an annotation by its ID by defering its `@id | id` fi
     - `manifest_short_id` (`string`): the identifier of the manifest the annotation is related to
     - `annotation_short_id`: the unique part of the annotation URL
 
-#### Reply
+#### Response
 
 `Object`: the annotation. Its format follows the IIIF Presentation specification 2 or 3, based on the value of `iiif_version`.
 
@@ -184,7 +207,7 @@ Create or update a single annotation
     - `action` (`create | update`): the action to perform: create or update an annotation
 - Body (`Object`): a IIIF annotation that follows the IIIF Presentation API 2 or 3 (depending on the value of `iiif_version`)
 
-#### Reply
+#### Response
 
 ```
 { 
@@ -226,7 +249,7 @@ Batch insert multiple annotations.
     - `{ uri: string }`: an object containing a reference to an `AnnotationList` or `AnnotationPage`
     - `{ uri: string }[]`: an array of objects containing a reference to an `AnnotationList` or `AnnotationPage`.
 
-#### Reply
+#### Response
 
 ```
 { 

package/package.json

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

package/src/data/annotations/annotations2.js

@@ -201,7 +201,7 @@ class Annotations2 extends CollectionAbstract {
     // 1. get all distinct manifest URIs
     const manifestUris = [];
     annotationData.map((ann) => ann.on.map((target) => {
-      if ( target.manifestUri !== undefined && !manifestUris.includes(target.manifestUri) ) {
+      if ( target.manifestUri != null && !manifestUris.includes(target.manifestUri) ) {
         manifestUris.push(target.manifestUri);
       }
     }));
@@ -229,7 +229,6 @@ class Annotations2 extends CollectionAbstract {
               target.manifestUri
                 ? await this.manifestsPlugin.getCanvasIdx(target.manifestUri, target.full)
                 : undefined;
-            // console.log(">>> #insertManifestsAndGetCanvasIdx: target", target);
             return target;
           })
         )

package/src/data/manifests/manifests2.js

@@ -1,7 +1,7 @@
 import fastifyPlugin from "fastify-plugin";
 
 import CollectionAbstract from "#data/collectionAbstract.js";
-import { getManifestShortId, manifestUri } from "#utils/iiif2Utils.js";
+import { getManifestShortId } from "#utils/iiif2Utils.js";
 import { formatInsertResponse } from "#src/data/utils/routeUtils.js";
 import { inspectObj, visibleLog, ajvCompile } from "#utils/utils.js";
 import { IIIF_PRESENTATION_2_CONTEXT } from "#utils/iiifUtils.js";
@@ -147,9 +147,11 @@ class Manifests2 extends CollectionAbstract {
     const
       mongoResponse =
         await this.collection.find(
-          { "@id": {
-            $in: cleanManifestArray.map((manifest) => manifest["@id"])
-          }},
+          {
+            "@id": {
+              $in: cleanManifestArray.map((manifest) => manifest["@id"])
+            }
+          },
           { projection: { "@id": 1 } }
         )
           .toArray(),
@@ -206,7 +208,12 @@ class Manifests2 extends CollectionAbstract {
     await Promise.all(
       manifestUriArray.map(async (manifestUri) => {
         try {
-          manifestArray.push(await this.#fetchManifestFromUri(manifestUri));
+          const r = await this.#fetchManifestFromUri(manifestUri);
+          if ( ! r.error ) {
+            manifestArray.push(r);
+          } else {
+            fetchErrorIds.push(r);
+          }
         } catch (err) {
           if ( throwOnError ) {
             throw err;
@@ -218,6 +225,9 @@ class Manifests2 extends CollectionAbstract {
     const result = await this.insertManifestArray(manifestArray, throwOnError);
     // if there has been an error but error-throwing was disabled, complete the response object with description of the errors
     if ( !throwOnError ) {
+      if ( fetchErrorIds.length ) {
+        console.error(`${this.funcName(this.insertManifestsFromUriArray)}: error inserting ${fetchErrorIds} manifests`, fetchErrorIds);
+      }
       result.fetchErrorIds = fetchErrorIds;
     }
     return result;

package/src/data/utils/iiif2Utils.js

@@ -85,6 +85,26 @@ const getAnnotationTarget = (annotation) => {
   return maybeToArray(annotation.on).map(getSingleAnnotationTarget);
 }
 
+/**
+ * @example "127.0.0.1:3000/data/2/wit9_man11_anno165/annotation/c26_abda6e3c-2926-4495-9787-cb3f3588e47c"
+ * @param {string} manifestShortId
+ * @param {string} canvasId
+ * @returns {string}
+ */
+const toAiiinotateAnnotationUri = (manifestShortId, canvasId) =>
+  `${process.env.AIIINOTATE_BASE_URL}/data/${IIIF_PRESENTATION_2}/${manifestShortId}/annotation/${canvasId}_${uuid4()}`;
+
+const toAiiinotateManifestUri = (manifestShortId) =>
+  `${process.env.AIIINOTATE_BASE_URL}/data/${IIIF_PRESENTATION_2}/${manifestShortId}/manifest.json`;
+
+/**
+ * if `canvasUri` follows the recommended IIIF 2.1 recommended URI pattern, convert it to a JSON manifest URI.
+ * @param {string} canvasUri
+ * @returns {string} : the manifest URI
+ */
+const canvasUriToManifestUri = (canvasUri) =>
+  canvasUri.split("/").slice(0,-2).join("/") + "/manifest.json";
+
 /**
  * convert the annotation's `on` to a SpecificResource
  * reimplemented from SAS: https://github.com/glenrobson/SimpleAnnotationServer/blob/dc7c8c6de9f4693c678643db2a996a49eebfcbb0/src/main/java/uk/org/llgc/annotation/store/AnnotationUtils.java#L123-L135
@@ -128,7 +148,7 @@ const makeTarget = (annotation) => {
     }
     if ( objectHasKey(specificResource, "full") ) {
       specificResource.manifestShortId = getManifestShortId(specificResource.full);
-      specificResource.manifestUri = manifestUri(specificResource.manifestShortId);
+      specificResource.manifestUri = canvasUriToManifestUri(specificResource.full);
     }
     return specificResource
   }
@@ -157,29 +177,9 @@ const makeAnnotationId = (annotation, manifestShortId) => {
     throw new Error(`${makeAnnotationId.name}: could not make an 'annotationId' (with manifestShortId=${manifestShortId}, annotation=${annotation})`)
   }
 
-  return annotationUri(manifestShortId, canvasId);
+  return toAiiinotateAnnotationUri(manifestShortId, canvasId);
 }
 
-/**
- * @example "127.0.0.1:3000/data/2/wit9_man11_anno165/annotation/c26_abda6e3c-2926-4495-9787-cb3f3588e47c"
- * @param {string} manifestShortId
- * @param {string} canvasId
- * @returns {string}
- */
-const annotationUri = (manifestShortId, canvasId) =>
-  `${process.env.AIIINOTATE_BASE_URL}/data/${IIIF_PRESENTATION_2}/${manifestShortId}/annotation/${canvasId}_${uuid4()}`;
-
-const manifestUri = (manifestShortId) =>
-  `${process.env.AIIINOTATE_BASE_URL}/data/${IIIF_PRESENTATION_2}/${manifestShortId}/manifest.json`;
-
-/**
- * if `canvasUri` follows the recommended IIIF 2.1 recommended URI pattern, convert it to a JSON manifest URI.
- * @param {string} canvasUri
- * @returns {string} : the manifest URI
- */
-const canvasUriToManifestUri = (canvasUri) =>
-  canvasUri.split("/").slice(0,-2).join("/") + "/manifest.json";
-
 /**
  *
  * @param {object[]} resources: the annotatons
@@ -203,8 +203,8 @@ const toAnnotationList = (resources, annotationListId, label) => {
 export {
   makeTarget,
   makeAnnotationId,
-  annotationUri,
-  manifestUri,
+  toAiiinotateAnnotationUri,
+  toAiiinotateManifestUri,
   toAnnotationList,
   getManifestShortId,
   getCanvasShortId,