aiiinotate 0.3.0 → 0.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aiiinotate",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "a fast IIIF-compliant annotation server",
   "main": "./cli/index.js",
   "type": "module",
@@ -16,7 +16,8 @@
     "start": "sudo systemctl start mongod && npm run cli serve dev",
     "test": "sudo systemctl start mongod && dotenvx run -f ./config/.env -- node --test --test-isolation=none",
     "lint": "npx eslint --fix",
-    "migrate": "npm run cli -- migrate"
+    "migrate": "npm run cli -- migrate",
+    "update_version": "python3 scripts/update_version.py"
   },
   "pre-commit": [
     "lint"
@@ -74,4 +75,4 @@
     "globals": "^16.3.0",
     "pre-commit": "^1.2.2"
   }
-}
+}

package/scripts/update_version.py

@@ -0,0 +1,30 @@
+import re
+import sys
+import json
+import shutil
+import pathlib
+
+curdir = pathlib.Path(__file__).parent.resolve()
+pkg_file = curdir.parent.joinpath("package.json").resolve()
+pkg_lock_file = curdir.parent.joinpath("package-lock.json").resolve()
+
+usage = "\nupdate_version.py: CLI to update NPM version.\nUSAGE: \n\tpython3 update_version.py [VERSION]\n"
+
+if len(sys.argv) != 2:
+    print(usage)
+    exit()
+
+version = sys.argv[1]
+if not re.search(r"^\d+\.\d+\.[^\s]+$", version):
+    print(r"argument VERSION must match '^\d+\.\d+\.[^\s]+$' (i.e. '0.2.1', '1.3.4fix'). exiting...")
+    exit()
+
+for fp in [pkg_file, pkg_lock_file]:
+    shutil.copy2(fp, f"{fp}.bak")
+    with open(fp, mode="r") as fh:
+        data = json.load(fh)
+    data["version"] = version
+    with open(fp, mode="w") as fh:
+        json.dump(data, fh, indent=2)
+
+print(f"\nUpdated NPM package to version: {version}.")

package/src/data/utils/iiif2Utils.js

@@ -58,27 +58,31 @@ const getCanvasShortId = (canvasUri) =>
  * get the `on` of an annotation.
  * reimplemented from SAS: https://github.com/glenrobson/SimpleAnnotationServer/blob/dc7c8c6de9f4693c678643db2a996a49eebfcbb0/src/main/java/uk/org/llgc/annotation/store/AnnotationUtils.java#L147
  * @param {object} annotation
- * @returns {string}
+ * @returns {string[]}
  */
 const getAnnotationTarget = (annotation) => {
-  const target = annotation.on;  // either string or SpecificResource
-  let targetOut;
-
-  if ( typeof(target) === "string" ) {
-    // remove the fragment if necesary to get the full Canvas Id
-    const hashIdx = target.indexOf("#");
-    targetOut = hashIdx === -1
-      ? target
-      : target.substring(0, hashIdx);
-
-  } else {
-    // it's a SpecificResource => get the full image's id.
-    targetOut = target["full"];
-  }
-  if ( isNullish(targetOut) ) {
-    throw new Error(`${getAnnotationTarget.name}: 'annotation.on' is not a valid IIIF 2.1 annotation target (with annotation=${target})`)
+  /** annotation.on is converted to an array of targets => extract the target for each item of the array */
+  const getSingleAnnotationTarget = (_target) => {
+    let _targetOut;
+
+    if ( typeof(_target) === "string" ) {
+      // remove the fragment if necesary to get the full Canvas Id
+      const hashIdx = _target.indexOf("#");
+      _targetOut = hashIdx === -1
+        ? _target
+        : _target.substring(0, hashIdx);
+
+    } else {
+      // it's a SpecificResource => get the full image's id.
+      _targetOut = _target["full"];
+    }
+    if ( isNullish(_targetOut) ) {
+      throw new Error(`${getAnnotationTarget.name}: 'annotation.on' is not a valid IIIF 2.1 annotation target (with annotation=${_target})`)
+    }
+    return _targetOut;
   }
-  return targetOut;
+
+  return maybeToArray(annotation.on).map(getSingleAnnotationTarget);
 }
 
 /**
@@ -138,11 +142,16 @@ const makeTarget = (annotation) => {
  * NOTE this should never fail, but results will only be reliable if the `annotation.on` follows the IIIF 2.1 canvas URI scheme
  */
 const makeAnnotationId = (annotation, manifestShortId) => {
+  // we consider that all targets point to the same canvas and manifest => extract canvas and manifest info from the 1st target.
+  const targetArray = getAnnotationTarget(annotation);
+  if ( targetArray.length < 1 ) {
+    throw new Error(`${makeAnnotationId.name}: could not extract target from annotation`)
+  }
   const
-    target = getAnnotationTarget(annotation),
-    canvasId = getCanvasShortId(target);
+    firstTarget = targetArray[0],
+    canvasId = getCanvasShortId(firstTarget);
   // if manifestShortId hasn't aldready been extracted, re-extract it
-  manifestShortId = manifestShortId || getManifestShortId(target);
+  manifestShortId = manifestShortId || getManifestShortId(firstTarget);
 
   if ( isNullish(manifestShortId) || isNullish(canvasId) ) {
     throw new Error(`${makeAnnotationId.name}: could not make an 'annotationId' (with manifestShortId=${manifestShortId}, annotation=${annotation})`)

package/src/schemas/schemasRoutes.js

@@ -47,10 +47,10 @@ function addSchemas(fastify, options, done) {
           { type: "object" },
           {
             type: "array",
-            items: [
+            items: { anyOf: [
               { type: "string" },
               { type: "object" }
-            ],
+            ]},
             minItems: 1
           }
         ]
@@ -75,10 +75,10 @@ function addSchemas(fastify, options, done) {
           { type: "object" },
           {
             type: "array",
-            items: [
+            items: { anyOf: [
               { type: "string" },
               { type: "object" }
-            ],
+            ]},
             minItems: 1
           }
         ]

package/test.json

@@ -0,0 +1,77 @@
+{
+  "name": "aiiinotate",
+  "version": "0.0.0",
+  "description": "a fast IIIF-compliant annotation server",
+  "main": "./cli/index.js",
+  "type": "module",
+  "directories": {
+    "doc": "docs"
+  },
+  "bin": {
+    "aiiinotate": "./cli/index.js"
+  },
+  "scripts": {
+    "cli": "node ./cli/index.js --env=./config/.env",
+    "setup": "sudo systemctl start mongod && npm run cli migrate apply",
+    "start": "sudo systemctl start mongod && npm run cli serve dev",
+    "test": "sudo systemctl start mongod && dotenvx run -f ./config/.env -- node --test --test-isolation=none",
+    "lint": "npx eslint --fix",
+    "migrate": "npm run cli -- migrate"
+  },
+  "pre-commit": [
+    "lint"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Aikon-platform/aiiinotate.git"
+  },
+  "keywords": [
+    "annotation-server",
+    "iiif",
+    "annotation",
+    "international-image-interoperability-framework"
+  ],
+  "author": "Aikon",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Aikon-platform/aiiinotate/issues"
+  },
+  "homepage": "https://github.com/Aikon-platform/aiiinotate#readme",
+  "imports": {
+    "#types": "./src/types.js",
+    "#cli/*.js": "./cli/*.js",
+    "#src/*.js": "./src/*.js",
+    "#migrations/*.js": "./migrations/*.js",
+    "#db/*.js": "./src/db/*.js",
+    "#schemas/*.js": "./src/schemas/*.js",
+    "#config/*.js": "./config/*.js",
+    "#data/*.js": "./src/data/*.js",
+    "#utils/*.js": "./src/data/utils/*.js",
+    "#fixtures/*.js": "./src/fixtures/*.js",
+    "#fixtures/*.json": "./src/fixtures/*.json",
+    "#manifests/*.js": "./src/data/manifests/*.js",
+    "#annotations/*.js": "./src/data/annotations/*.js"
+  },
+  "dependencies": {
+    "@dotenvx/dotenvx": "^1.49.0",
+    "@fastify/ajv-compiler": "^4.0.2",
+    "@fastify/cors": "^11.1.0",
+    "@fastify/mongodb": "^9.0.2",
+    "@fastify/swagger": "^9.5.2",
+    "commander": "^14.0.0",
+    "fastify": "^5.5.0",
+    "migrate-mongo": "^12.1.3",
+    "mongodb": "^6.18.0",
+    "swagger-markdown": "^3.0.0",
+    "uuid": "^11.1.0"
+  },
+  "devDependencies": {
+    "@eslint/css": "^0.10.0",
+    "@eslint/js": "^9.33.0",
+    "@eslint/json": "^0.13.1",
+    "@stylistic/eslint-plugin": "^5.2.3",
+    "eslint": "^9.33.0",
+    "globals": "^16.3.0",
+    "pre-commit": "^1.2.2"
+  }
+}