manifesto.js 4.2.21 → 4.2.23

package/eslint.config.cjs

@@ -0,0 +1,25 @@
+// eslint.config.js
+const { defineConfig } = require("eslint/config");
+const tsPlugin = require("@typescript-eslint/eslint-plugin");
+const tsParser = require("@typescript-eslint/parser");
+const prettierConfig = require("eslint-config-prettier");
+
+module.exports = defineConfig([
+  {
+    files: ["**/*.{js,jsx,ts,tsx}"],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        sourceType: "module",
+      },
+    },
+    plugins: {
+      "@typescript-eslint": tsPlugin,
+    },
+    rules: {
+      semi: "error",
+      "prefer-const": "error",
+    },
+  },
+  prettierConfig,
+]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "manifesto.js",
-  "version": "4.2.21",
+  "version": "4.2.23",
   "description": "IIIF Presentation API utility library for client and server",
   "main": "./dist-commonjs/index.js",
   "module": "./dist-esmodule/index.js",
@@ -9,14 +9,16 @@
   "types": "./dist-esmodule/index.d.ts",
   "scripts": {
     "build:commonjs": "tsc",
-    "build:docs": "rimraf -rf docs && typedoc --out docs --name manifesto --theme default --ignoreCompilerErrors --experimentalDecorators --emitDecoratorMetadata --target ES6 --moduleResolution node --preserveConstEnums --stripInternal --suppressExcessPropertyErrors --module commonjs src/ && touch docs/.nojekyll",
+    "docs": "rimraf -rf docs && typedoc --tsconfig tsconfig.docs.json --out docs --name manifesto --theme default src/",
     "build:esmodule": "tsc -m es6 --outDir dist-esmodule",
     "build:types": "dts-bundle-generator --umd-module-name manifesto -o types/index.d.ts dist-esmodule/index.d.ts",
     "build:umd": "webpack",
     "build:var": "cross-env NODE_WEBPACK_LIBRARY_PATH=dist-var NODE_WEBPACK_LIBRARY_TARGET=var webpack",
-    "build": "npm run lint:all && npm run clean && npm run build:commonjs && npm run build:esmodule && npm run build:umd && npm run build:var && npm run build:types",
+    "build": "npm run fix && npm run clean && npm run build:commonjs && npm run build:esmodule && npm run build:umd && npm run build:var && npm run build:types",
     "clean": "rimraf -rf dist-umd dist-commonjs dist-esmodule dist-var types",
-    "lint:all": "prettier --write \"./src/**/*.{js,jsx,json,css,ts,tsx}\"",
+    "lint": "eslint --fix \"./src/**/*.{js,jsx,json,css,ts,tsx}\"",
+    "prettify": "prettier --write \"./src/**/*.{js,jsx,json,css,ts,tsx}\" --ignore-path .prettierignore",
+    "fix": "npm run lint && npm run prettify",
     "prepublishOnly": "npm run build && npm run test",
     "test": "mocha",
     "watch": "npm run build:esmodule -- --watch"
@@ -39,29 +41,31 @@
   },
   "homepage": "https://github.com/iiif-commons/manifesto",
   "devDependencies": {
-    "@types/node": "8.10.52",
-    "chai": "2.3.0",
-    "cross-env": "^5.2.1",
+    "@types/node": "24.0.10",
+    "chai": "5.2.0",
+    "cross-env": "^7.0.3",
     "dts-bundle-generator": "^9.5.1",
-    "finalhandler": "1.3.1",
+    "eslint": "9.27.0",
+    "eslint-config-prettier": "10.1.5",
+    "eslint-plugin-prettier": "5.4.0",
+    "finalhandler": "2.1.0",
     "http": "0.0.0",
-    "mocha": "^10.7.3",
-    "prettier": "^1.19.1",
+    "mocha": "^11.7.1",
+    "prettier": "^3.6.2",
     "prettier-check": "^2.0.0",
-    "rimraf": "^3.0.0",
-    "serve-static": "^1.14.1",
-    "ts-loader": "^8",
-    "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.26.10",
+    "rimraf": "^6.0.1",
+    "serve-static": "^2.2.0",
+    "ts-loader": "^9",
+    "typedoc": "^0.28.7",
     "typescript": "^5",
-    "typescript-tslint-plugin": "^0.5.5",
-    "webpack": "^4.28.3",
-    "webpack-cli": "^3.1.2",
-    "yargs": "3.10.0"
+    "typescript-eslint": "8.32.1",
+    "webpack": "^5.99.9",
+    "webpack-cli": "^6.0.1",
+    "yargs": "18.0.0"
   },
   "dependencies": {
     "@edsilv/http-status-codes": "^1.0.3",
-    "@iiif/vocabulary": "^1.0.26",
+    "@iiif/vocabulary": "^1.0.28",
     "isomorphic-unfetch": "^3.0.0",
     "lodash": "^4.17.21"
   },

package/pkg-tests/node-umd.js

@@ -1,6 +1,9 @@
 // @todo works, but with these specific workarounds.
 globalThis.window = globalThis.window || {};
 globalThis.fetch = require('node-fetch');
+if (typeof self === 'undefined') {
+    global.self = global;
+}
 
 const Manifesto = require('../dist-umd/manifesto');
 

package/test/fixtures/manifests.js

@@ -61,7 +61,8 @@ module.exports = {
     "riksmuseumimageapiv3thumbnails": "http://localhost:3001/riksmuseum-image-api-v3-thumbnails.json",
     //"query-bodleian": "http://iiif.bodleian.ox.ac.uk/iiif/manifest/f22e9dae-c070-48eb-be0b-aa6c5bc195a6.json",
     //"query-gams": "http://gams.uni-graz.at/cocoon/mets2json?source=http%3A%2F%2Fgams.uni-graz.at%2Farchive%2Fget%2Fo%3Asrbas.1535%2FMETS_SOURCE",
-    "v3ProviderNoLogo": "http://localhost:3001/YaleCanterburyTalesV3ProviderNoLogo.json"
+    "v3ProviderNoLogo": "http://localhost:3001/YaleCanterburyTalesV3ProviderNoLogo.json",
+    "pres3AnnotationsEmbedded": "http://localhost:3001/pres3-annotations-embedded.json"
 };
 
 //BBoM: http://wellcomelibrary.org/iiif/b18031511/manifest

package/test/fixtures/pres3-annotations-embedded.json

@@ -0,0 +1,66 @@
+{
+  "@context": "http://iiif.io/api/presentation/3/context.json",
+  "id": "https://iiif.io/api/cookbook/recipe/0266-full-canvas-annotation/manifest.json",
+  "type": "Manifest",
+  "label": {
+    "en": [
+      "Picture of Göttingen taken during the 2019 IIIF Conference"
+    ]
+  },
+  "items": [
+    {
+      "id": "https://iiif.io/api/cookbook/recipe/0266-full-canvas-annotation/canvas-1",
+      "type": "Canvas",
+      "height": 3024,
+      "width": 4032,
+      "items": [
+        {
+          "id": "https://iiif.io/api/cookbook/recipe/0266-full-canvas-annotation/canvas-1/annopage-1",
+          "type": "AnnotationPage",
+          "items": [
+            {
+              "id": "https://iiif.io/api/cookbook/recipe/0266-full-canvas-annotation/canvas-1/annopage-1/anno-1",
+              "type": "Annotation",
+              "motivation": "painting",
+              "body": {
+                "id": "https://iiif.io/api/image/3.0/example/reference/918ecd18c2592080851777620de9bcb5-gottingen/full/max/0/default.jpg",
+                "type": "Image",
+                "format": "image/jpeg",
+                "height": 3024,
+                "width": 4032,
+                "service": [
+                  {
+                    "id": "https://iiif.io/api/image/3.0/example/reference/918ecd18c2592080851777620de9bcb5-gottingen",
+                    "profile": "level1",
+                    "type": "ImageService3"
+                  }
+                ]
+              },
+              "target": "https://iiif.io/api/cookbook/recipe/0266-full-canvas-annotation/canvas-1"
+            }
+          ]
+        }
+      ],
+      "annotations": [
+        {
+          "id": "https://iiif.io/api/cookbook/recipe/0266-full-canvas-annotation/canvas-1/annopage-2",
+          "type": "AnnotationPage",
+          "items": [
+            {
+              "id": "https://iiif.io/api/cookbook/recipe/0266-full-canvas-annotation/canvas-1/annopage-2/anno-1",
+              "type": "Annotation",
+              "motivation": "commenting",
+              "body": {
+                "type": "TextualBody",
+                "language": "de",
+                "format": "text/plain",
+                "value": "Göttinger Marktplatz mit Gänseliesel Brunnen"
+              },
+              "target": "https://iiif.io/api/cookbook/recipe/0266-full-canvas-annotation/canvas-1"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

package/test/index.js

@@ -94,3 +94,4 @@ importTest('translations', './tests/translations');
 importTest('witnesstopeter', './tests/witnesstopeter');
 importTest('Utils', './tests/Utils.test');
 importTest('v3ProviderNoLogo', './tests/v3ProviderNoLogo');
+importTest('pres3AnnotationsEmbedded', './tests/pres3-annotations-embedded');

package/test/tests/pres3-annotations-embedded.js

@@ -0,0 +1,55 @@
+var expect = require('chai').expect;
+var should = require('chai').should();
+var manifesto = require('../../dist-commonjs/');
+var manifests = require('../fixtures/manifests');
+var manifest, canvas, annotationPages, annotations, annotation, body
+
+describe('#getAnnotations', function() {
+  it('manifest loads successfully', function (done) {
+    manifesto.loadManifest(manifests.pres3AnnotationsEmbedded).then(function(data) {
+      manifest = manifesto.parseManifest(data);
+      done();
+    });
+  });
+
+it('has a sequence', function() {
+    sequence = manifest.getSequenceByIndex(0);
+    expect(sequence).to.exist;
+});
+
+it('has a canvas', function() {
+    canvas = sequence.getCanvases()[0];
+    expect(canvas).to.exist;
+});
+
+  it('has annotation pages', function () {
+    annotationPages = canvas.getAnnotations();
+    expect(annotationPages).to.be.an('array');
+    expect(annotationPages).to.have.lengthOf(1);
+  });
+
+  it('annotation page has correct id', function () {
+    expect(annotationPages[0].id).to.equal('https://iiif.io/api/cookbook/recipe/0266-full-canvas-annotation/canvas-1/annopage-2');
+  });
+
+  it('annotation page contains annotations', function () {
+    annotations = annotationPages[0].getItems();
+    expect(annotations).to.be.an('array');
+    expect(annotations).to.have.lengthOf(1);
+  });
+
+  it('annotation has commenting motivation', function () {
+    annotations = annotationPages[0].getItems();
+    annotation = new manifesto.Annotation(annotations[0]);
+    expect(annotation.getMotivation()).to.equal('commenting');
+  });
+
+  it('annotation body has value', function () {
+    body = annotation.getBody()[0];
+    expect(body.getValue()).to.equal('Göttinger Marktplatz mit Gänseliesel Brunnen');
+  });
+
+  it('annotation body has language', function () {
+    expect(body.getLanguage()).to.equal('de');
+  });
+});

package/tsconfig.docs.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "target": "ES5",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "preserveConstEnums": true,
+    "stripInternal": true
+  },
+  "include": ["src/**/*"]
+}

package/types/index.d.ts

@@ -80,6 +80,8 @@ export declare class AnnotationBody extends ManifestResource {
 	constructor(jsonld?: any, options?: IManifestoOptions);
 	getFormat(): MediaType | null;
 	getType(): ExternalResourceType | null;
+	getValue(): string | null;
+	getLanguage(): string | null;
 	getWidth(): number;
 	getHeight(): number;
 }
@@ -103,6 +105,7 @@ export declare class Canvas extends Resource {
 	getCanonicalImageUri(w?: number): string;
 	getMaxDimensions(): Size | null;
 	getContent(): Annotation[];
+	getAnnotations(): AnnotationPage[];
 	getDuration(): number | null;
 	getImages(): Annotation[];
 	getIndex(): number;
@@ -477,7 +480,7 @@ export declare class Utils {
 	 * @example Utils.traverseAndFind({foo: 'bar'}, 'foo', 'bar')
 	 */
 	static traverseAndFind(object: any, k: string, v: string): object | undefined;
-	static getServices(resource: any, { onlyService, onlyServices, skipParentResources }?: {
+	static getServices(resource: any, { onlyService, onlyServices, skipParentResources, }?: {
 		onlyServices?: boolean;
 		skipParentResources?: boolean;
 		onlyService?: boolean;