@natlibfi/ekirjasto-opds-feed-parser 0.0.0-post.148 → 0.0.0-post.149

package/README.md

@@ -9,7 +9,7 @@ Covers [OPDS 1.1 version](http://opds-spec.org/specs/opds-catalog-1-1-20110627/)
 ## Usage
 
 ```sh
-npm install ekirjasto-opds-feed-parser
+npm install @natlibfi/ekirjasto-opds-feed-parser
 ```
 
 Example:

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@natlibfi/ekirjasto-opds-feed-parser",
   "description": "E-kirjasto OPDS feed parser",
-  "version": "0.0.0-post.148",
+  "version": "0.0.0-post.149",
   "author": {
     "name": "The National Library of Finland"
   },
@@ -15,18 +15,22 @@
   "homepage": "https://github.com/NatLibFi/ekirjasto-opds-feed-parser",
   "repository": {
     "type": "git",
-    "url": "git@github.com:NatLibFi/ekirjasto-opds-feed-parser.git"
-  },
-  "bugs": {
-    "url": "https://github.com/NatLibFi/ekirjasto-opds-feed-parser/issues"
+    "url": "git+ssh://git@github.com/NatLibFi/ekirjasto-opds-feed-parser.git"
   },
   "engines": {
     "node": ">=20"
   },
   "main": "lib/src/index.js",
   "typings": "lib/src/index.d.ts",
+  "files": [
+    "lib/src/**/*",
+    "CHANGELOG",
+    "LICENSE",
+    "README.md"
+  ],
   "scripts": {
-    "prepublish": "rm -rf lib; tsc",
+    "prepare": "rm -rf lib && tsc",
+    "prepublishOnly": "npm test",
     "lint": "tslint -c tslint.json src/*.ts test/*.ts",
     "test": "rm -rf lib && npm run lint && tsc && mocha lib/test/*.js"
   },

package/.github/CODEOWNERS

@@ -1,4 +0,0 @@
-# @NatLibFi/e-kirjasto-maintainers own the repository and
-# will be requested for review when someone opens a pull request.
-
-* @NatLibFi/e-kirjasto-maintainers

package/.github/pull_request_template.md

@@ -1,12 +0,0 @@
-## Description
-<!--- Provide a brief overview of what this pull request accomplishes -->
-
-## Rationale for changes
-<!--- Explain the necessity of this change -->
-<!--- Include a link to the relevant Jira issue here. -->
-
-## Documentation updates
-<!--- Mention any modifications made to the documentation-->
-
-## Review and testing instructions
-<!--- Outline the steps the reviewer should follow to test this pull request -->

package/.github/workflows/release.yml

@@ -1,102 +0,0 @@
-name: npm Publish
-
-on:
-  push:
-    branches:
-      - main
-  release:
-    types: [published]
-  workflow_call:
-    inputs:
-      version-source:
-        description: "Set to 'dunamai' to compute from git, or 'release-tag' to use a provided tag."
-        required: true
-        type: string
-      release-tag:
-        description: "Release tag to use when version-source is release-tag."
-        required: false
-        type: string
-      publish-tag:
-        description: "npm dist-tag to publish with."
-        required: false
-        type: string
-        default: latest
-
-concurrency:
-  group: npm-publish-${{ github.ref_name }}-${{ github.event_name }}
-  cancel-in-progress: true
-
-permissions:
-  id-token: write  # Required for OIDC
-  contents: read
-
-jobs:
-  npm-publish:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Resolve publish parameters (push)
-        if: github.event_name == 'push'
-        run: |
-          echo "VERSION_SOURCE=dunamai" >> "$GITHUB_ENV"
-          echo "PUBLISH_TAG=next" >> "$GITHUB_ENV"
-
-      - name: Resolve publish parameters (release)
-        if: github.event_name == 'release'
-        run: |
-          echo "VERSION_SOURCE=release-tag" >> "$GITHUB_ENV"
-          echo "RELEASE_TAG=${{ github.event.release.tag_name }}" >> "$GITHUB_ENV"
-          echo "PUBLISH_TAG=latest" >> "$GITHUB_ENV"
-
-      - name: Resolve publish parameters (workflow_call)
-        if: github.event_name == 'workflow_call'
-        run: |
-          echo "VERSION_SOURCE=${{ inputs.version-source }}" >> "$GITHUB_ENV"
-          echo "RELEASE_TAG=${{ inputs.release-tag }}" >> "$GITHUB_ENV"
-          echo "PUBLISH_TAG=${{ inputs.publish-tag }}" >> "$GITHUB_ENV"
-
-      - uses: actions/checkout@v4
-        with:
-          persist-credentials: false
-          fetch-depth: 0
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20.17
-          registry-url: https://registry.npmjs.org/
-          cache: npm
-
-      - name: Upgrade npm (trusted publishing requirement) ⬆️
-        run: npm install -g npm@^11.5.1
-
-      - name: Set up Python 🐍
-        if: ${{ github.event_name == 'push' || (github.event_name == 'workflow_call' && inputs.version-source == 'dunamai') }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.10"
-
-      - name: Set up Dunamai 🪄
-        if: ${{ github.event_name == 'push' || (github.event_name == 'workflow_call' && inputs.version-source == 'dunamai') }}
-        run: pip install -r requirements-ci.txt
-
-      - name: Install locked dependencies 🔧
-        run: npm ci
-
-      - name: Version ✅
-        run: |
-          if [ "${VERSION_SOURCE}" = "dunamai" ]; then
-            npm version --no-git-tag-version $(dunamai from git --style semver)
-          else
-            if [ -z "${RELEASE_TAG}" ]; then
-              echo "release-tag input is required when version-source is not 'dunamai'." 1>&2
-              exit 1
-            fi
-            npm version --no-git-tag-version "${RELEASE_TAG}"
-          fi
-
-      - name: Test 🧪
-        env:
-          TZ: Europe/Helsinki
-        run: npm test
-
-      - name: Publish 📚 (OIDC Trusted Publishing)
-        run: npm publish --tag "${PUBLISH_TAG}" --access public --provenance

package/.github/workflows/test.yml

@@ -1,23 +0,0 @@
-name: Test
-on: [push, pull_request]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout 🛎️
-        uses: actions/checkout@v3
-
-      - name: Install Node.js 💻
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-
-      - name: Install locked dependencies 🔧
-        run: npm ci
-
-      - name: Test 🧪
-        env:
-          TZ: Europe/Helsinki
-        run: npm test

package/requirements-ci.txt

@@ -1 +0,0 @@
-dunamai==1.25.0

package/test/accessibility_parser_test.ts

@@ -1,450 +0,0 @@
-import AccessibilityParser from "../src/accessibility_parser";
-import chai = require("chai");
-import ConformanceParser from "../src/conformance_parser";
-import fs = require("fs");
-import OPDSParser, { OPDSEntry, OPDSFeed } from "../src";
-import PrefixMap from "../src/prefix_map";
-import WaysOfReadingParser from "../src/ways_of_reading_parser";
-
-let expect = chai.expect;
-
-
-// OPDS entry parsing test for accessibility
-
-describe("EntryParser, AccessibilityParser, ConformanceParser and WaysOfReadingParser", () => {
-  let opdsParser: OPDSParser;
-
-  beforeEach(() => {
-    opdsParser = new OPDSParser();
-  });
-
-  describe("#parse", () => {
-
-   it("extract accessibility attribute from <accessibility>", (done) => {
-      fs.readFile("test/files/accessibility.xml", "utf8", (error, data) => {
-        if (error) {
-          done(error);
-        } else {
-          let promise: Promise<OPDSFeed | OPDSEntry> = opdsParser.parse(data);
-          promise.then((entry: OPDSEntry) => {
-            expect(entry.title).to.equals("Accessibility XML test");
-            expect(entry.accessibility).to.be.an("object");
-            expect(entry.accessibility).to.have.property("waysOfReading");
-            expect(entry.accessibility.waysOfReading).to.have.property("features").that.is.an("array").that.has.lengthOf(3);
-            expect(entry.accessibility.waysOfReading.features).to.include.members([
-              "Appearance can be modified",
-              "Has alternative text",
-              "Not fully readable in read aloud or dynamic braille"
-            ]);
-            expect(entry.accessibility).to.have.property("conformance");
-            expect(entry.accessibility.conformance).to.have.property("conformsTo", "This publication meets accepted accessibility standards");
-          }).then(done, done);
-        }
-      });
-    });
-
-  });
-
-});
-
-
-// Accessibility parsing tests
-
-describe("AccessibilityParser", () => {
-  let accessibilityParser: AccessibilityParser;
-
-  beforeEach(() => {
-    let prefixes: PrefixMap = {};
-    accessibilityParser = new AccessibilityParser(prefixes);
-  });
-
-  describe("#parse", () => {
-
-    it("extracts conformance attribute", () => {
-
-      const accessibilityTag = {
-        "conformance": [{
-          "conformsTo": [
-            {"_": "This publication meets accepted accessibility standards"}
-          ]
-        }],
-      };
-
-      const result = accessibilityParser.parse(accessibilityTag);
-
-      expect(result).to.be.an("object");
-      expect(result).to.have.property("conformance");
-      expect(result.conformance).to.have.property("conformsTo", "This publication meets accepted accessibility standards");
-      expect(result).to.have.property("waysOfReading");
-      expect(result.waysOfReading).to.be.null;
-    });
-
-    it("extracts ways of reading attribute", () => {
-
-      const accessibilityTag = {
-        "waysOfReading": [{
-          "feature": [
-            {"_": "Appearance can be modified"},
-            {"_": "Has alternative text"},
-            {"_": "Not fully readable in read aloud or dynamic braille"}
-          ]
-        }],
-      };
-
-      const result = accessibilityParser.parse(accessibilityTag);
-
-      expect(result).to.be.an("object");
-      expect(result).to.have.property("waysOfReading");
-      expect(result.waysOfReading).to.have.property("features").that.is.an("array").that.has.lengthOf(3);
-      expect(result.waysOfReading.features).to.include.members([
-        "Appearance can be modified",
-        "Has alternative text",
-        "Not fully readable in read aloud or dynamic braille"
-      ]);
-      expect(result).to.have.property("conformance");
-      expect(result.conformance).to.be.null;
-    });
-
-    it("extracts conformance and ways of reading attributes", () => {
-
-      const accessibilityTag = {
-        "conformance": [{
-          "conformsTo": [
-            {"_": "This publication meets accepted accessibility standards"}
-          ]
-        }],
-        "waysOfReading": [{
-          "feature": [
-            {"_": "Appearance can be modified"},
-            {"_": "Has alternative text"},
-            {"_": "Not fully readable in read aloud or dynamic braille"}
-          ]
-        }]
-      };
-
-      const result = accessibilityParser.parse(accessibilityTag);
-
-      expect(result).to.be.an("object");
-      expect(result).to.have.property("conformance");
-      expect(result.conformance).to.have.property("conformsTo", "This publication meets accepted accessibility standards");
-      expect(result).to.have.property("waysOfReading");
-      expect(result.waysOfReading).to.have.property("features").that.is.an("array").that.has.lengthOf(3);
-      expect(result.waysOfReading.features).to.include.members([
-        "Appearance can be modified",
-        "Has alternative text",
-        "Not fully readable in read aloud or dynamic braille"
-      ]);
-
-    });
-
-    it("extracts only conformance and ways of reading attributes", () => {
-
-      const accessibilityTag = {
-        "conformance": [{
-          "conformsTo": [
-            {"_": "This publication meets accepted accessibility standards"}
-          ]
-        }],
-        "waysOfReading": [{
-          "feature": [
-            {"_": "Appearance can be modified"},
-            {"_": "Has alternative text"},
-            {"_": "Not fully readable in read aloud or dynamic braille"}
-          ]
-        }],
-        "hazards": [{
-          "feature": [
-            {"_": "Sounds"},
-            {"_": "Motion simulation"},
-            {"_": "Flashing content"}
-          ]
-        }]
-      };
-
-      const result = accessibilityParser.parse(accessibilityTag);
-
-      expect(result).to.be.an("object");
-      expect(result).to.have.property("conformance");
-      expect(result.conformance).to.have.property("conformsTo", "This publication meets accepted accessibility standards");
-      expect(result).to.have.property("waysOfReading");
-      expect(result.waysOfReading).to.have.property("features").that.is.an("array").that.has.lengthOf(3);
-      expect(result.waysOfReading.features).to.include.members([
-        "Appearance can be modified",
-        "Has alternative text",
-        "Not fully readable in read aloud or dynamic braille"
-      ]);
-      expect(result).not.to.have.property("hazards");
-    });
-
-    it("extracts conformance and ways of reading attributes if available", () => {
-
-      const accessibilityTag = {};
-
-      const result = accessibilityParser.parse(accessibilityTag);
-
-      expect(result).to.be.an("object");
-      expect(result).to.have.property("conformance");
-      expect(result).to.have.property("waysOfReading");
-      expect(result.conformance).to.be.null;
-      expect(result.waysOfReading).to.be.null;
-    });
-
-    it("extracts only conformance and ways of reading from accessibility if available", () => {
-
-      const accessibilityTag = {
-        "hazards": [{
-          "feature": [
-            {"_": "Sounds"},
-            {"_": "Motion simulation"},
-            {"_": "Flashing content"}
-          ]
-        }]
-      };
-
-      const result = accessibilityParser.parse(accessibilityTag);
-
-      expect(result).to.be.an("object");
-      expect(Object.keys(result)).to.have.lengthOf(2);
-      expect(result).to.have.property("conformance");
-      expect(result).to.have.property("waysOfReading");
-      expect(result).not.to.have.property("hazards");
-      expect(result.conformance).to.be.null;
-      expect(result.waysOfReading).to.be.null;
-    });
-
-  });
-
-});
-
-
-// Conformance parsing tests
-
-describe("ConformanceParser", () => {
-  let conformanceParser: ConformanceParser;
-
-  beforeEach(() => {
-    let prefixes: PrefixMap = {};
-    conformanceParser = new ConformanceParser(prefixes);
-  });
-
-  describe("#parse", () => {
-
-    it("extracts conformsTo attribute", () => {
-
-      const conformanceTag = {
-        "conformsTo": [
-          {
-            "_": "This publication meets accepted accessibility standards"
-          }
-        ]
-      };
-
-      const result = conformanceParser.parse(conformanceTag);
-
-      expect(result).to.be.an("object");
-      expect(result).to.have.property("conformsTo", "This publication meets accepted accessibility standards");
-    });
-
-    it("extracts conformsTo attribute including empty strings", () => {
-
-      const conformanceTag = {
-        "conformsTo": [
-          {
-            "_": ""
-          }
-        ]
-      };
-
-      const result = conformanceParser.parse(conformanceTag);
-
-      expect(result).to.be.an("object");
-      expect(result).to.have.property("conformsTo", "");
-    });
-
-    it("extracts only conformsTo attribute", () => {
-
-      const conformanceTag = {
-        "conformsTo": [
-          {
-            "_": "This publication meets accepted accessibility standards"
-          }
-        ],
-        "certifier": [
-          {
-            "_": "The publication was certified by Certifier"
-          }
-        ]
-      };
-
-      const result = conformanceParser.parse(conformanceTag);
-
-      expect(result).to.be.an("object");
-      expect(Object.keys(result)).to.have.lengthOf(1);
-      expect(result).to.have.property("conformsTo", "This publication meets accepted accessibility standards");
-      expect(result).not.to.have.property("certifier");
-    });
-
-    it("extracts conformsTo attribute if available", () => {
-
-      const conformanceTag = {};
-
-      const result = conformanceParser.parse(conformanceTag);
-
-      expect(result).to.be.an("object");
-      expect(result.conformsTo).to.be.undefined;
-    });
-
-    it("extracts only conformsTo attribute if available", () => {
-
-      const conformanceTag = {
-        "certifier": [
-          {
-            "_": "The publication was certified by Certifier"
-          }
-        ]
-      };
-
-      const result = conformanceParser.parse(conformanceTag);
-
-      expect(result).to.be.an("object");
-      expect(Object.keys(result)).to.have.lengthOf(1);
-      expect(result).to.have.property("conformsTo");
-      expect(result.conformsTo).to.be.undefined;
-      expect(result).not.to.have.property("certifier");
-    });
-
-  });
-});
-
-
-// Ways of reading parsing tests
-
-describe("WaysOfReadingParser", () => {
-  let waysOfReadingParser: WaysOfReadingParser;
-
-  beforeEach(() => {
-    let prefixes: PrefixMap = {};
-    waysOfReadingParser = new WaysOfReadingParser(prefixes);
-  });
-
-  describe("#parse", () => {
-
-   it("extracts waysOfReading attribute", () => {
-
-      const waysOfReadingTag = {
-        "feature": [
-          {
-            "_": "Appearance can be modified"
-          },
-          {
-           "_": "Has alternative text"
-          },
-          {
-           "_": "Not fully readable in read aloud or dynamic braille"
-          }
-        ]
-      };
-
-      const result = waysOfReadingParser.parse(waysOfReadingTag);
-
-      expect(result).to.be.an("object");
-      expect(result).to.have.property("features").that.is.an("array").that.has.lengthOf(3);
-      expect(result.features).to.include.members([
-        "Appearance can be modified",
-        "Has alternative text",
-        "Not fully readable in read aloud or dynamic braille"
-      ]);
-    });
-
-    it("extracts waysOfReading attribute including empty strings", () => {
-
-      const waysOfReadingTag = {
-        "feature": [
-          {
-            "_": "Appearance can be modified"
-          },
-          {
-           "_": ""
-          },
-          {
-           "_": "Not fully readable in read aloud or dynamic braille"
-          }
-        ]
-      };
-
-      const result = waysOfReadingParser.parse(waysOfReadingTag);
-
-      expect(result).to.be.an("object");
-      expect(result).to.have.property("features").that.is.an("array").that.has.lengthOf(3);
-      expect(result.features).to.include.members([
-        "Appearance can be modified",
-        "",
-        "Not fully readable in read aloud or dynamic braille"
-      ]);
-    });
-
-    it("extracts only waysOfReading attribute", () => {
-
-      const waysOfReadingTag = {
-        "feature": [
-          {
-            "_": "Appearance can be modified"
-          },
-          {
-           "_": "Has alternative text"
-          },
-          {
-           "_": "Not fully readable in read aloud or dynamic braille"
-          }
-        ],
-        "additionalAccessibilityInformation": [
-          {
-            "_": "High contrast between foreground text and background"
-          }
-        ]
-      };
-
-      const result = waysOfReadingParser.parse(waysOfReadingTag);
-
-      expect(result).to.be.an("object");
-      expect(Object.keys(result)).to.have.lengthOf(1);
-      expect(result).to.have.property("features").that.is.an("array").that.has.lengthOf(3);
-      expect(result.features).to.include.members([
-        "Appearance can be modified",
-        "Has alternative text",
-        "Not fully readable in read aloud or dynamic braille"
-      ]);
-      expect(result).not.to.have.property("additionalAccessibilityInformation");
-    });
-
-    it("extracts waysOfReading attribute if available", () => {
-
-      const waysOfReadingTag = {};
-
-      const result = waysOfReadingParser.parse(waysOfReadingTag);
-
-      expect(result).to.be.an("object");
-      expect(result).to.have.property("features").that.is.an("array").that.has.lengthOf(0);
-    });
-
-    it("extracts only waysOfReading attribute if available", () => {
-
-      const waysOfReadingTag = {
-        "additionalAccessibilityInformation": [
-          {
-            "_": "High contrast between foreground text and background"
-          }
-        ]
-      };
-
-      const result = waysOfReadingParser.parse(waysOfReadingTag);
-
-      expect(result).to.be.an("object");
-      expect(Object.keys(result)).to.have.lengthOf(1);
-      expect(result).to.have.property("features").that.is.an("array").that.has.lengthOf(0);
-      expect(result).not.to.have.property("additionalAccessibilityInformation");
-    });
-
-  });
-
-});

package/test/availability_parser_test.ts

@@ -1,32 +0,0 @@
-import PrefixMap from "../src/prefix_map";
-import OPDSAvailability from "../src/opds_availability";
-import AvailabilityParser from "../src/availability_parser";
-import NamespaceParser from "../src/namespace_parser";
-import chai = require("chai");
-let expect = chai.expect;
-
-describe("AvailabilityParser", () => {
-  let parser: AvailabilityParser;
-
-  beforeEach(() => {
-    let prefixes: PrefixMap = {};
-    prefixes[NamespaceParser.OPDS_URI] = "opds:";
-    parser = new AvailabilityParser(prefixes);
-  });
-
-  describe("#parse", () => {
-    it("extract attributes", () => {
-      let availability = {
-        $: {
-          status: { value: "reserved" },
-          since: { value: "2016-07-26T15:46:19Z" },
-          until: { value: "2016-11-02T19:46:27Z" }
-        }
-      };
-      let parsed = parser.parse(availability);
-      expect(parsed.status).to.equals("reserved");
-      expect(parsed.since).to.equals("2016-07-26T15:46:19Z");
-      expect(parsed.until).to.equals("2016-11-02T19:46:27Z");
-    });
-  });
-});