manifesto.js 4.2.4 → 4.2.8

package/README.md

@@ -6,14 +6,12 @@ IIIF Presentation API client and server utility library.
 
     npm install manifesto.js --save
 
-Getting Started
---
+## Getting Started
 
 ### Documentation
 
 https://iiif-commons.github.io/manifesto/
 
-
 ### Developer Setup
 
     git clone https://github.com/iiif-commons/manifesto.git
@@ -23,8 +21,12 @@ https://iiif-commons.github.io/manifesto/
 
 ### Publishing Package
 
-1. Bump the version locally using `npm version` on a branch other than `master`. Example: `npm version patch -m 'bump to v3.0.42'`
-1. Push the bump version branch to GitHub and create a pull request to `master`.
-1. After the pull request is merged, checkout `master` and pull the latest changes. `git checkout master && git pull`
-1. Run `npm publish`
-1. Push the git tags created `git push --tags`
+`git checkout master`
+
+`npm version patch`
+
+`git add .`
+
+If the new version is e.g. v1.2.3
+
+`git push origin master v1.2.3`

package/dist-commonjs/Annotation.d.ts

@@ -1,10 +1,10 @@
-import { AnnotationMotivation } from "@iiif/vocabulary/dist-commonjs";
-import { AnnotationBody, IManifestoOptions, ManifestResource, Resource } from "./internal";
-export declare class Annotation extends ManifestResource {
-    constructor(jsonld: any, options: IManifestoOptions);
-    getBody(): AnnotationBody[];
-    getMotivation(): AnnotationMotivation | null;
-    getOn(): string;
-    getTarget(): string | null;
-    getResource(): Resource;
-}
+import { AnnotationMotivation } from "@iiif/vocabulary/dist-commonjs";
+import { AnnotationBody, IManifestoOptions, ManifestResource, Resource } from "./internal";
+export declare class Annotation extends ManifestResource {
+    constructor(jsonld: any, options: IManifestoOptions);
+    getBody(): AnnotationBody[];
+    getMotivation(): AnnotationMotivation | null;
+    getOn(): string;
+    getTarget(): string | null;
+    getResource(): Resource;
+}

package/dist-commonjs/Annotation.js

@@ -1,75 +1,75 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-var internal_1 = require("./internal");
-var Annotation = /** @class */ (function (_super) {
-    __extends(Annotation, _super);
-    function Annotation(jsonld, options) {
-        return _super.call(this, jsonld, options) || this;
-    }
-    Annotation.prototype.getBody = function () {
-        var bodies = [];
-        var body = this.getProperty("body");
-        // todo: make this a generic "property that can be an object or array enumerator" util
-        if (body) {
-            if (Array.isArray(body)) {
-                for (var i = 0; i < body.length; i++) {
-                    var b = body[i];
-                    if (b.items) {
-                        for (var i_1 = 0; i_1 < b.items.length; i_1++) {
-                            // todo: don't ignore that it's a choice. maybe add isChoice() to IAnnotationBody?
-                            var c = b.items[i_1];
-                            bodies.push(new internal_1.AnnotationBody(c, this.options));
-                        }
-                    }
-                    else {
-                        bodies.push(new internal_1.AnnotationBody(b, this.options));
-                    }
-                }
-            }
-            else if (body.items) {
-                for (var i = 0; i < body.items.length; i++) {
-                    var b = body.items[i];
-                    bodies.push(new internal_1.AnnotationBody(b, this.options));
-                }
-            }
-            else {
-                bodies.push(new internal_1.AnnotationBody(body, this.options));
-            }
-        }
-        return bodies;
-    };
-    Annotation.prototype.getMotivation = function () {
-        var motivation = this.getProperty("motivation");
-        if (motivation) {
-            //const key: string | undefined = Object.keys(AnnotationMotivationEnum).find(k => AnnotationMotivationEnum[k] === motivation);
-            return motivation;
-        }
-        return null;
-    };
-    // open annotation
-    Annotation.prototype.getOn = function () {
-        return this.getProperty("on");
-    };
-    Annotation.prototype.getTarget = function () {
-        return this.getProperty("target");
-    };
-    Annotation.prototype.getResource = function () {
-        return new internal_1.Resource(this.getProperty("resource"), this.options);
-    };
-    return Annotation;
-}(internal_1.ManifestResource));
-exports.Annotation = Annotation;
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+var internal_1 = require("./internal");
+var Annotation = /** @class */ (function (_super) {
+    __extends(Annotation, _super);
+    function Annotation(jsonld, options) {
+        return _super.call(this, jsonld, options) || this;
+    }
+    Annotation.prototype.getBody = function () {
+        var bodies = [];
+        var body = this.getProperty("body");
+        // todo: make this a generic "property that can be an object or array enumerator" util
+        if (body) {
+            if (Array.isArray(body)) {
+                for (var i = 0; i < body.length; i++) {
+                    var b = body[i];
+                    if (b.items) {
+                        for (var i_1 = 0; i_1 < b.items.length; i_1++) {
+                            // todo: don't ignore that it's a choice. maybe add isChoice() to IAnnotationBody?
+                            var c = b.items[i_1];
+                            bodies.push(new internal_1.AnnotationBody(c, this.options));
+                        }
+                    }
+                    else {
+                        bodies.push(new internal_1.AnnotationBody(b, this.options));
+                    }
+                }
+            }
+            else if (body.items) {
+                for (var i = 0; i < body.items.length; i++) {
+                    var b = body.items[i];
+                    bodies.push(new internal_1.AnnotationBody(b, this.options));
+                }
+            }
+            else {
+                bodies.push(new internal_1.AnnotationBody(body, this.options));
+            }
+        }
+        return bodies;
+    };
+    Annotation.prototype.getMotivation = function () {
+        var motivation = this.getProperty("motivation");
+        if (motivation) {
+            //const key: string | undefined = Object.keys(AnnotationMotivationEnum).find(k => AnnotationMotivationEnum[k] === motivation);
+            return motivation;
+        }
+        return null;
+    };
+    // open annotation
+    Annotation.prototype.getOn = function () {
+        return this.getProperty("on");
+    };
+    Annotation.prototype.getTarget = function () {
+        return this.getProperty("target");
+    };
+    Annotation.prototype.getResource = function () {
+        return new internal_1.Resource(this.getProperty("resource"), this.options);
+    };
+    return Annotation;
+}(internal_1.ManifestResource));
+exports.Annotation = Annotation;
 //# sourceMappingURL=Annotation.js.map

package/dist-commonjs/AnnotationBody.d.ts

@@ -1,9 +1,9 @@
-import { ExternalResourceType, MediaType } from "@iiif/vocabulary/dist-commonjs";
-import { IManifestoOptions, ManifestResource } from "./internal";
-export declare class AnnotationBody extends ManifestResource {
-    constructor(jsonld?: any, options?: IManifestoOptions);
-    getFormat(): MediaType | null;
-    getType(): ExternalResourceType | null;
-    getWidth(): number;
-    getHeight(): number;
-}
+import { ExternalResourceType, MediaType } from "@iiif/vocabulary/dist-commonjs";
+import { IManifestoOptions, ManifestResource } from "./internal";
+export declare class AnnotationBody extends ManifestResource {
+    constructor(jsonld?: any, options?: IManifestoOptions);
+    getFormat(): MediaType | null;
+    getType(): ExternalResourceType | null;
+    getWidth(): number;
+    getHeight(): number;
+}

package/dist-commonjs/AnnotationBody.js

@@ -1,45 +1,45 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-var internal_1 = require("./internal");
-var AnnotationBody = /** @class */ (function (_super) {
-    __extends(AnnotationBody, _super);
-    function AnnotationBody(jsonld, options) {
-        return _super.call(this, jsonld, options) || this;
-    }
-    AnnotationBody.prototype.getFormat = function () {
-        var format = this.getProperty("format");
-        if (format) {
-            return internal_1.Utils.getMediaType(format);
-        }
-        return null;
-    };
-    AnnotationBody.prototype.getType = function () {
-        var type = this.getProperty("type");
-        if (type) {
-            return (internal_1.Utils.normaliseType(this.getProperty("type")));
-        }
-        return null;
-    };
-    AnnotationBody.prototype.getWidth = function () {
-        return this.getProperty("width");
-    };
-    AnnotationBody.prototype.getHeight = function () {
-        return this.getProperty("height");
-    };
-    return AnnotationBody;
-}(internal_1.ManifestResource));
-exports.AnnotationBody = AnnotationBody;
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+var internal_1 = require("./internal");
+var AnnotationBody = /** @class */ (function (_super) {
+    __extends(AnnotationBody, _super);
+    function AnnotationBody(jsonld, options) {
+        return _super.call(this, jsonld, options) || this;
+    }
+    AnnotationBody.prototype.getFormat = function () {
+        var format = this.getProperty("format");
+        if (format) {
+            return internal_1.Utils.getMediaType(format);
+        }
+        return null;
+    };
+    AnnotationBody.prototype.getType = function () {
+        var type = this.getProperty("type");
+        if (type) {
+            return (internal_1.Utils.normaliseType(this.getProperty("type")));
+        }
+        return null;
+    };
+    AnnotationBody.prototype.getWidth = function () {
+        return this.getProperty("width");
+    };
+    AnnotationBody.prototype.getHeight = function () {
+        return this.getProperty("height");
+    };
+    return AnnotationBody;
+}(internal_1.ManifestResource));
+exports.AnnotationBody = AnnotationBody;
 //# sourceMappingURL=AnnotationBody.js.map

package/dist-commonjs/AnnotationList.d.ts

@@ -1,12 +1,12 @@
-import { IIIFResourceType } from "@iiif/vocabulary/dist-commonjs";
-import { Annotation, IManifestoOptions, JSONLDResource } from "./internal";
-export declare class AnnotationList extends JSONLDResource {
-    options: IManifestoOptions;
-    label: string;
-    isLoaded: boolean;
-    constructor(label: any, jsonld?: any, options?: IManifestoOptions);
-    getIIIFResourceType(): IIIFResourceType;
-    getLabel(): string;
-    getResources(): Annotation[];
-    load(): Promise<AnnotationList>;
-}
+import { IIIFResourceType } from "@iiif/vocabulary/dist-commonjs";
+import { Annotation, IManifestoOptions, JSONLDResource } from "./internal";
+export declare class AnnotationList extends JSONLDResource {
+    options: IManifestoOptions;
+    label: string;
+    isLoaded: boolean;
+    constructor(label: any, jsonld?: any, options?: IManifestoOptions);
+    getIIIFResourceType(): IIIFResourceType;
+    getLabel(): string;
+    getResources(): Annotation[];
+    load(): Promise<AnnotationList>;
+}

package/dist-commonjs/AnnotationList.js

@@ -1,62 +1,62 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-var internal_1 = require("./internal");
-var AnnotationList = /** @class */ (function (_super) {
-    __extends(AnnotationList, _super);
-    function AnnotationList(label, jsonld, options) {
-        var _this = _super.call(this, jsonld) || this;
-        _this.label = label;
-        _this.options = options;
-        return _this;
-    }
-    AnnotationList.prototype.getIIIFResourceType = function () {
-        return internal_1.Utils.normaliseType(this.getProperty("type"));
-    };
-    AnnotationList.prototype.getLabel = function () {
-        return this.label;
-    };
-    AnnotationList.prototype.getResources = function () {
-        var _this = this;
-        var resources = this.getProperty("resources");
-        return resources.map(function (resource) { return new internal_1.Annotation(resource, _this.options); });
-    };
-    AnnotationList.prototype.load = function () {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            if (_this.isLoaded) {
-                resolve(_this);
-            }
-            else {
-                var id = _this.__jsonld.id;
-                if (!id) {
-                    id = _this.__jsonld["@id"];
-                }
-                internal_1.Utils.loadManifest(id)
-                    .then(function (data) {
-                    _this.__jsonld = data;
-                    _this.context = _this.getProperty("context");
-                    _this.id = _this.getProperty("id");
-                    _this.isLoaded = true;
-                    resolve(_this);
-                })
-                    .catch(reject);
-            }
-        });
-    };
-    return AnnotationList;
-}(internal_1.JSONLDResource));
-exports.AnnotationList = AnnotationList;
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+var internal_1 = require("./internal");
+var AnnotationList = /** @class */ (function (_super) {
+    __extends(AnnotationList, _super);
+    function AnnotationList(label, jsonld, options) {
+        var _this = _super.call(this, jsonld) || this;
+        _this.label = label;
+        _this.options = options;
+        return _this;
+    }
+    AnnotationList.prototype.getIIIFResourceType = function () {
+        return internal_1.Utils.normaliseType(this.getProperty("type"));
+    };
+    AnnotationList.prototype.getLabel = function () {
+        return this.label;
+    };
+    AnnotationList.prototype.getResources = function () {
+        var _this = this;
+        var resources = this.getProperty("resources");
+        return resources.map(function (resource) { return new internal_1.Annotation(resource, _this.options); });
+    };
+    AnnotationList.prototype.load = function () {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            if (_this.isLoaded) {
+                resolve(_this);
+            }
+            else {
+                var id = _this.__jsonld.id;
+                if (!id) {
+                    id = _this.__jsonld["@id"];
+                }
+                internal_1.Utils.loadManifest(id)
+                    .then(function (data) {
+                    _this.__jsonld = data;
+                    _this.context = _this.getProperty("context");
+                    _this.id = _this.getProperty("id");
+                    _this.isLoaded = true;
+                    resolve(_this);
+                })
+                    .catch(reject);
+            }
+        });
+    };
+    return AnnotationList;
+}(internal_1.JSONLDResource));
+exports.AnnotationList = AnnotationList;
 //# sourceMappingURL=AnnotationList.js.map

package/dist-commonjs/AnnotationPage.d.ts

@@ -1,5 +1,5 @@
-import { Annotation, IManifestoOptions, ManifestResource } from "./internal";
-export declare class AnnotationPage extends ManifestResource {
-    constructor(jsonld: any, options: IManifestoOptions);
-    getItems(): Annotation[];
-}
+import { Annotation, IManifestoOptions, ManifestResource } from "./internal";
+export declare class AnnotationPage extends ManifestResource {
+    constructor(jsonld: any, options: IManifestoOptions);
+    getItems(): Annotation[];
+}

package/dist-commonjs/AnnotationPage.js

@@ -1,28 +1,28 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-var internal_1 = require("./internal");
-var AnnotationPage = /** @class */ (function (_super) {
-    __extends(AnnotationPage, _super);
-    function AnnotationPage(jsonld, options) {
-        return _super.call(this, jsonld, options) || this;
-    }
-    AnnotationPage.prototype.getItems = function () {
-        return this.getProperty("items");
-    };
-    return AnnotationPage;
-}(internal_1.ManifestResource));
-exports.AnnotationPage = AnnotationPage;
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+var internal_1 = require("./internal");
+var AnnotationPage = /** @class */ (function (_super) {
+    __extends(AnnotationPage, _super);
+    function AnnotationPage(jsonld, options) {
+        return _super.call(this, jsonld, options) || this;
+    }
+    AnnotationPage.prototype.getItems = function () {
+        return this.getProperty("items");
+    };
+    return AnnotationPage;
+}(internal_1.ManifestResource));
+exports.AnnotationPage = AnnotationPage;
 //# sourceMappingURL=AnnotationPage.js.map

package/dist-commonjs/Canvas.d.ts

@@ -1,31 +1,31 @@
-import { ViewingHint } from "@iiif/vocabulary/dist-commonjs";
-import { Annotation, AnnotationList, IManifestoOptions, Range, Resource, Size } from "./internal";
-export declare class Canvas extends Resource {
-    ranges: Range[];
-    constructor(jsonld?: any, options?: IManifestoOptions);
-    getCanonicalImageUri(w?: number): string;
-    getMaxDimensions(): Size | null;
-    getContent(): Annotation[];
-    getDuration(): number | null;
-    getImages(): Annotation[];
-    getIndex(): number;
-    getOtherContent(): Promise<AnnotationList[]>;
-    getWidth(): number;
-    getHeight(): number;
-    getViewingHint(): ViewingHint | null;
-    readonly imageResources: any;
-    readonly resourceAnnotations: any;
-    /**
-     * Returns a given resource Annotation, based on a contained resource or body
-     * id
-     */
-    resourceAnnotation(id: any): any;
-    /**
-     * Returns the fragment placement values if a resourceAnnotation is placed on
-     * a canvas somewhere besides the full extent
-     */
-    onFragment(id: any): any;
-    readonly iiifImageResources: any;
-    readonly imageServiceIds: any;
-    readonly aspectRatio: number;
-}
+import { ViewingHint } from "@iiif/vocabulary/dist-commonjs";
+import { Annotation, AnnotationList, IManifestoOptions, Range, Resource, Size } from "./internal";
+export declare class Canvas extends Resource {
+    ranges: Range[];
+    constructor(jsonld?: any, options?: IManifestoOptions);
+    getCanonicalImageUri(w?: number): string;
+    getMaxDimensions(): Size | null;
+    getContent(): Annotation[];
+    getDuration(): number | null;
+    getImages(): Annotation[];
+    getIndex(): number;
+    getOtherContent(): Promise<AnnotationList[]>;
+    getWidth(): number;
+    getHeight(): number;
+    getViewingHint(): ViewingHint | null;
+    readonly imageResources: any;
+    readonly resourceAnnotations: any;
+    /**
+     * Returns a given resource Annotation, based on a contained resource or body
+     * id
+     */
+    resourceAnnotation(id: any): any;
+    /**
+     * Returns the fragment placement values if a resourceAnnotation is placed on
+     * a canvas somewhere besides the full extent
+     */
+    onFragment(id: any): any;
+    readonly iiifImageResources: any;
+    readonly imageServiceIds: any;
+    readonly aspectRatio: number;
+}