@natlibfi/issn-verify 1.0.6 → 2.0.0-alpha.1

package/.github/workflows/{melinda-node-tests.yml → melinda-node-tests-and-publish.yml}

@@ -4,6 +4,10 @@ name: Melinda-node-tests
 
 on: push
 
+permissions:
+  id-token: write  # Required for OIDC
+  contents: read
+
 jobs:
   build-node-versions:
     name: Node version matrix
@@ -11,14 +15,14 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x, 20.x, 22.x]
+        node-version: [22.x, 24.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
     - name: Checkout the code
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
+      uses: actions/setup-node@v6
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
@@ -33,10 +37,11 @@ jobs:
   njsscan:
     name: Njsscan-check
     runs-on: ubuntu-latest
+    container: node:22
 
     steps:
     - name: Checkout the code
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
     - name: nodejsscan scan
       id: njsscan
       uses: ajinabraham/njsscan-action@master
@@ -46,26 +51,36 @@ jobs:
   license-scan:
     name: License compliance check
     runs-on: ubuntu-latest
+    container: node:22
 
     steps:
-      - uses: actions/checkout@v4
-      - uses: mikaelvesavuori/license-compliance-action@v1.0.3
+      - uses: actions/checkout@v5
+      - uses: mikaelvesavuori/license-compliance-action@v1
         with:
           exclude_pattern: /^@natlibfi/
 
   publish:
     runs-on: ubuntu-latest
+    container: node:22
     needs: [build-node-versions, njsscan]
     if: contains(github.ref, 'refs/tags/')
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       # Setup .npmrc file to publish to npm
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
-          node-version: '18.x'
+          node-version: '22.x'
           registry-url: 'https://registry.npmjs.org'
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.ISSN_VERIFY_NPM_TOKEN }}
+      - name: Update npm
+        run: npm install -g npm@latest
+      - name: Clean install
+        run: npm ci
+      # Publish stable release with --tag latest
+      - name: Publish stable release
+        if: ${{!contains(github.ref, '-alpha')}}
+        run: npm publish --tag=latest
+      # Publish pre-release without --tag latest
+      - name: Publish pre-release
+        if: contains(github.ref, '-alpha')
+        run: npm publish --tag=next

package/README.md

@@ -39,6 +39,6 @@ if ( issn(test) ) {
 ## License and copyright
 **This software is fork of https://github.com/malantonio/issn-verify with updated dependencies**
 
-Copyright (c) 2018, 2023-2024 **University Of Helsinki (The National Library Of Finland)**
+Copyright (c) 2018, 2023-2025 **University Of Helsinki (The National Library Of Finland)**
 
 This project's source code is licensed under the terms of **MIT License** or any later version.

package/dist/issnVerify.js

@@ -0,0 +1,19 @@
+export function issn(input) {
+  if (input.length < 8) {
+    input = input.padStart(8, "0");
+  }
+  const reg = /^\d{4}\-?\d{3}[\dX]$/;
+  if (!input.match(reg)) {
+    return false;
+  }
+  const num = input.substr(0, input.length - 1).replace(/\-/, "").split("").reverse().reduce(function(prv, cur, idx) {
+    let i = idx + 2;
+    return prv + cur * i;
+  }, 0) % 11;
+  const check = num === 0 ? 0 : 11 - num;
+  if (check === 10) {
+    return "X" === input.substr(-1);
+  }
+  return check === parseInt(input.substr(-1));
+}
+//# sourceMappingURL=issnVerify.js.map

package/dist/issnVerify.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/issnVerify.js"],
+  "sourcesContent": ["export function issn(input) {\n    if (input.length < 8) {\n        input = input.padStart(8, '0');\n    }\n\n    const reg = /^\\d{4}\\-?\\d{3}[\\dX]$/;\n    if (!input.match(reg)) {\n        return false;\n    }\n\n    const num = input.substr(0, (input.length - 1))\n        .replace(/\\-/, '')\n        .split('')\n        .reverse()\n        .reduce(function (prv, cur, idx) {\n            let i = idx + 2;\n            return prv + (cur * i);\n        }, 0)\n        % 11;\n\n    const check = num === 0 ? 0 : 11 - num;\n\n    if (check === 10) {\n        return \"X\" === input.substr(-1);\n    }\n\n    return check === parseInt(input.substr(-1));\n}\n"],
+  "mappings": "AAAO,gBAAS,KAAK,OAAO;AACxB,MAAI,MAAM,SAAS,GAAG;AAClB,YAAQ,MAAM,SAAS,GAAG,GAAG;AAAA,EACjC;AAEA,QAAM,MAAM;AACZ,MAAI,CAAC,MAAM,MAAM,GAAG,GAAG;AACnB,WAAO;AAAA,EACX;AAEA,QAAM,MAAM,MAAM,OAAO,GAAI,MAAM,SAAS,CAAE,EACzC,QAAQ,MAAM,EAAE,EAChB,MAAM,EAAE,EACR,QAAQ,EACR,OAAO,SAAU,KAAK,KAAK,KAAK;AAC7B,QAAI,IAAI,MAAM;AACd,WAAO,MAAO,MAAM;AAAA,EACxB,GAAG,CAAC,IACF;AAEN,QAAM,QAAQ,QAAQ,IAAI,IAAI,KAAK;AAEnC,MAAI,UAAU,IAAI;AACd,WAAO,QAAQ,MAAM,OAAO,EAAE;AAAA,EAClC;AAEA,SAAO,UAAU,SAAS,MAAM,OAAO,EAAE,CAAC;AAC9C;",
+  "names": []
+}

package/eslint.config.js

@@ -0,0 +1,53 @@
+// Eslint configuration object for src
+const configSrc = {
+  files: [
+    "src/*",
+    "tests/*"
+  ],
+  linterOptions: {
+    reportUnusedDisableDirectives: true,
+  },
+  rules: {
+    "no-console": "warn",
+    "eqeqeq": ["error", "always"],
+    "no-const-assign": "error",
+    "max-depth": ["warn", 4],
+    "max-lines": ["warn", 500],
+    "max-lines-per-function": ["warn", {"max": 100}],
+    "no-else-return": ["error", {allowElseIf: false}],
+    "no-plusplus": [
+      "error",
+      {
+        "allowForLoopAfterthoughts": true
+      }
+    ],
+    "array-callback-return": [
+      "error",
+      {
+        "checkForEach": false
+      }
+    ],
+    "no-unused-vars": [
+      "error",
+      {
+        "argsIgnorePattern": "next"
+      }
+    ],
+    "no-warning-comments": "off"
+  }
+};
+
+// Eslint configuration object for globally ignoring .js files
+// - ignore all files that start with a dot
+// - ignore all files inside directories named 'dist'
+const configIgnores = {
+  ignores: [
+    "**/.*",
+    "**/dist/"
+  ]
+};
+
+export default [
+  configSrc,
+  configIgnores
+];

package/package.json

@@ -1,31 +1,6 @@
 {
   "name": "@natlibfi/issn-verify",
-  "version": "1.0.6",
-  "homepage": "https://github.com/malantonio/issn-verify-js",
-  "bugs": {
-    "url": "https://github.com/malantonio/issn-verify-js/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/malantonio/issn-verify-js"
-  },
   "description": "Verify ISSN (International Standard Serial Number)",
-  "main": "issnVerify.js",
-  "publishConfig": {
-    "access": "public"
-  },
-  "directories": {
-    "test": "test"
-  },
-  "devDependencies": {
-    "tape": "^5.8.1"
-  },
-  "scripts": {
-    "test": "node test/test.js"
-  },
-  "keywords": [
-    "issn"
-  ],
   "contributors": [
     {
       "name": "Adam Malantonio"
@@ -34,5 +9,36 @@
       "name": "The National Library of Finland"
     }
   ],
-  "license": "MIT"
+  "keywords": [
+    "issn"
+  ],
+  "homepage": "https://www.npmjs.com/package/@natlibfi/issn-verify",
+  "bugs": {
+    "url": "https://github.com/NatLibFi/issn-verify-js/issues"
+  },
+  "repository": {
+    "url": "https://github.com/NatLibFi/issn-verify-js"
+  },
+  "license": "MIT",
+  "version": "2.0.0-alpha.1",
+  "main": "./dist/issnVerify.js",
+  "type": "module",
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "esbuild \"src/**/*.js\" --sourcemap --platform=node --outdir=dist",
+    "lint": "eslint ./src",
+    "test": "npm run lint && npm run test:base",
+    "test:base": "node --test --experimental-test-coverage --test-reporter=spec './test/*.test.js'"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "esbuild": "^0.25.11",
+    "eslint": "^9.38.0"
+  }
 }

package/src/issnVerify.js

@@ -0,0 +1,28 @@
+export function issn(input) {
+    if (input.length < 8) {
+        input = input.padStart(8, '0');
+    }
+
+    const reg = /^\d{4}\-?\d{3}[\dX]$/;
+    if (!input.match(reg)) {
+        return false;
+    }
+
+    const num = input.substr(0, (input.length - 1))
+        .replace(/\-/, '')
+        .split('')
+        .reverse()
+        .reduce(function (prv, cur, idx) {
+            let i = idx + 2;
+            return prv + (cur * i);
+        }, 0)
+        % 11;
+
+    const check = num === 0 ? 0 : 11 - num;
+
+    if (check === 10) {
+        return "X" === input.substr(-1);
+    }
+
+    return check === parseInt(input.substr(-1));
+}

package/test/issnVerify.test.js

@@ -0,0 +1,26 @@
+import assert from 'node:assert';
+import {describe, it} from 'node:test';
+import {issn} from '../src/issnVerify.js';
+
+describe('issn validation tests', function () {
+    it('returns false for non-matching numbers', () => {
+        assert.equal(issn('000000000'), false);
+    });
+
+    it('matches oclc examples', () => {
+        assert.equal(issn('7369956'), true);
+        assert.equal(issn('07369956'), true);
+        assert.equal(issn('0736-9956'), true);
+    });
+
+    it('works with "X" check digit', () => {
+        assert.equal(issn('1550-235X'), true);
+    });
+
+    it('rejects strings', () => {
+        assert.equal(issn('a123-4567'), false);
+    });
+});
+
+
+

package/issnVerify.js

@@ -1,61 +0,0 @@
-/**
-*
-* @licstart  The following is the entire license notice for the JavaScript code in this file.
-*
-* Copyright 2014 Adam Malantonio
-* Copyright 2020 University Of Helsinki (The National Library Of Finland)
-*
-* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-*
-* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-*
-* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-*
-* @licend  The above is the entire license notice
-* for the JavaScript code in this file.
-*
-*/
-
-if ( module && typeof module.exports !== 'undefined' ) {
-    module.exports = issnVerify;
-}
-
-function issnVerify(input) {
-    var reg = /^\d{4}\-?\d{3}[\dX]$/
-      , check
-      , num
-        ;
-
-    if ( input.length < 8 ) {
-        input = pad(input);
-    }
-
-    if ( !input.match(reg) ) {
-        return false;
-    }
-
-    num = input.substr(0, (input.length - 1))
-               .replace(/\-/, '')
-               .split('')
-               .reverse()
-               .reduce(function(prv, cur, idx) {
-                    var i = idx + 2;
-                    return prv + (cur * i);
-                }, 0)
-          % 11;
-
-    check = num == 0 ? 0 : 11 - num;
-
-    if ( check == 10 ) {
-        check = "X";
-    }
-
-    return check == input.substr(-1);
-}
-
-function pad(inp) {
-    while ( inp.length < 8 ) {
-        inp = "0" + inp;
-    }
-    return inp;
-}

package/test/test.js

@@ -1,49 +0,0 @@
-/**
-*
-* @licstart  The following is the entire license notice for the JavaScript code in this file.
-*
-* Copyright 2014 Adam Malantonio
-* Copyright 2020 University Of Helsinki (The National Library Of Finland)
-*
-* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-*
-* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-*
-* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-*
-* @licend  The above is the entire license notice
-* for the JavaScript code in this file.
-*
-*/
-
-var test = require('tape');
-var issn = require('../issnVerify');
-
-test('returns false for non-matching numbers', function(t) {
-    t.notOk(issn('000000000'));
-    t.end();
-});
-
-test('matches oclc examples', function(t) {
-    var ex = [
-        '7369956'
-      , '07369956'
-      , '0736-9956'
-    ];
-
-    ex.forEach(function(num) {
-        t.ok(issn(num));
-    });
-
-    t.end();
-});
-
-test('works with "X" check digit', function(t) {
-    t.ok(issn('1550-235X'));
-    t.end()
-});
-
-test('rejects strings', function(t) {
-    t.notOk(issn('a123-4567'));
-    t.end();
-})