@natlibfi/marc-record-merge 6.0.0-beta.2 → 6.0.0-beta.6

package/.github/CODEOWNERS

@@ -0,0 +1,9 @@
+# With this line @NatLibFi/melinda-js-lead owns any files in the /.github/
+# directory at the root of the repository and any of its
+# subdirectories.
+/.github/ @NatLibFi/melinda-js-lead
+
+# With this line @NatLibFi/melinda-js-lead owns any files in the /src/
+# directory at the root of the repository and any of its
+# subdirectories.
+/src/ @NatLibFi/melinda-js-lead

package/.github/dependabot.yml

@@ -0,0 +1,41 @@
+# NatLibFi/Melinda maintenance strategy
+# https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "06:30"
+      timezone: "Europe/Helsinki"
+
+
+  # Minor updates to npm production dependencies daily
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "06:45"
+      timezone: "Europe/Helsinki"
+    versioning-strategy: lockfile-only
+    labels:
+      - "npm minor dependencies"
+    allow:
+      - dependency-type: "production"
+
+  # Major updates to npm dependencies weekly @tuesday
+  # Not possible yet https://github.com/dependabot/dependabot-core/issues/1778
+  # - package-ecosystem: "npm"
+  #   directory: "/"
+  #   schedule:
+  #     interval: "weekly"
+  #     day: "tuesday"
+  #     time: "07:00"
+  #     timezone: "Europe/Helsinki"
+  #   versioning-strategy: increase-if-necessary
+  #   labels:
+  #     - "npm major dependencies"
+  #   reviewers:
+  #     - "natlibfi/melinda-js-lead"

package/.github/workflows/melinda-node-tests.yml

@@ -0,0 +1,60 @@
+# Melinda node tests
+
+name: Melinda node tests
+
+on: push
+
+jobs:
+  build-node-versions:
+    name: Node version matrix
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - name: Checkout the code
+      uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+      env:
+        NPM_CONFIG_IGNORE_SCRIPTS: true
+    - run: npm audit --package-lock-only --production --audit-level=moderate
+    - run: npm ci
+    - run: npm test
+    - run: npm run build --if-present
+
+  njsscan:
+    name: Njsscan check
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout the code
+      uses: actions/checkout@v3
+    - name: nodejsscan scan
+      id: njsscan
+      uses: ajinabraham/njsscan-action@master
+      with:
+        args: '.'
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: [build-node-versions, njsscan]
+    if: contains(github.ref, 'refs/tags/')
+
+    steps:
+      - uses: actions/checkout@v3
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '14.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.MARC_RECORD_MERGE_JS_NPM_TOKEN }}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-current University of Helsinki (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.

package/README.md

@@ -3,9 +3,113 @@
 Merge MARC records
 
 ## Usage
+### COPY
+
+Chosing fields for reducer:
+```
+const copyReducerConfigs = [
+    {tagPattern: /010/u},
+    {tagPattern: /010|020/u},
+    {tagPattern: new RegExp('010', 'u')},
+    {tagPattern: new RegExp(String((/^(?<tags1>010|020$)/u').source))},
+  ]
+```
+
+### compareTagsOnly (Defaults false)
+```
+{tagPattern: /010/u, compareTagsOnly: false}
+```
+
+If base has field with that tag source field is ignored
+
+### doNotCopyIfFieldPresent (Defaults false)
+```
+{tagPattern: /010/u, doNotCopyIfFieldPresent: "^011$"}
+```
+
+If base has field with that tag 011 source field is ignored
+
+### compareWithoutIndicators (Defaults false)
+```
+{tagPattern: /010/u, compareWithoutIndicators: false}
+```
+
+When base and source fields are compared, indicator differences are ignored
+
+### subfieldsMustBeIdentical (Defaults true)
+```
+{tagPattern: /010/u, subfieldsMustBeIdentical: true}
+```
+
+If source subfields are subset of base subfields this option says if it is copied
+| subfieldsMustBeIdentical | base          | source        | copy  |
+|--------------------------|---------------|---------------|-------|
+| true or false            | $a foo        | $a foo        | false |
+| true or false            | $a foo        | $b bar        | true  |
+| true                     | $a foo        | $a foo,$b bar | true  |
+| false                    | $a foo        | $a foo,$b bar | true  |
+| true                     | $a foo,$b bar | $a foo        | true  |
+| false                    | $a foo,$b bar | $a foo        | false |
+
+### excludeSubfields (Defaults [ ])
+```
+{tagPattern: /010/u, excludeSubfields: ['a']}
+```
+
+When base and source fields are compared, excluded subfields are ignored
+
+### swapSubfieldCode (Defaults [ ])
+```
+{tagPattern: /010/u, swapSubfieldCode: [{"from": "a", "to": "b"}]}
+```
+
+When source fields are copied, subfields are checkked and if subfield.code match to 'from' value is that code swapped to 'to' value
+
+### dropSubfields (Defaults [ ])
+```
+{tagPattern: /010/u, dropSubfields: [{"code": "9"}]}
+```
+Drops subfields 9's from all fields tagged 010
+
+```
+{tagPattern: /010/u, dropSubfields: [{"code": "9", "value": "FENNI<KEEP>"}]}
+```
+Drops subfields 9's that have "FENNI<KEEP>" from all fields tagged 010
+
+
+```
+{tagPattern: /010/u, dropSubfields: [{"code": "9", "condition": "unless", "value": "^FENNI<(?<option>KEEP|DROP)>$"}]}
+```
+Drops all subfield 9's unless they have "FENNI<KEEP>" or "FENNI<DROP>" from all fields tagged 010
+
+
+When comparing or copying field dropped fields are ignored
+
+### copyUnless (Defaults [ ])
+```
+{tagPattern: /010/u, copyUnless: [{"code": "9", "value": "FENNI<KEEP>"}]}
+```
+
+When field is otherwise ok to be copied, if it contains given subfield whole field is ignored
+
+### baseValidators (Defaults {subfieldValues: false})
+```
+{tagPattern: /010/u, baseValidators: {fields: true, subfields: true, subfieldValues: true}}
+```
+
+Marc record validators for base record while reducer is working.
+More info can be read here: https://github.com/NatLibFi/marc-record-js
+
+### sourceValidators (Defaults {subfieldValues: false})
+```
+{tagPattern: /010/u, sourceValidators: {fields: true, subfields: true, subfieldValues: true}}
+```
+
+Marc record validators for source record while reducer is working.
+More info can be read here: https://github.com/NatLibFi/marc-record-js
 
 ## License and copyright
 
-Copyright (c) 2017-2019 **University Of Helsinki (The National Library Of Finland)**
+Copyright (c) 2020-2022 **University Of Helsinki (The National Library Of Finland)**
 
-This project's source code is licensed under the terms of **GNU Lesser General Public License Version 3** or any later version.
+This project's source code is licensed under the terms of **MIT** or any later version.

package/dist/index.js

@@ -11,50 +11,15 @@ Object.defineProperty(exports, "Reducers", {
 });
 exports.default = void 0;
 
-var _marcRecord = require("@natlibfi/marc-record");
-
 var _reducers = _interopRequireDefault(require("./reducers"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
-*
-* @licstart  The following is the entire license notice for the JavaScript code in this file.
-*
-* Merge MARC records
-*
-* Copyright (C) 2015-2019 University Of Helsinki (The National Library Of Finland)
-*
-* This file is part of marc-record-merge-js
-
-* marc-record-merge-js program is free software: you can redistribute it and/or modify
-* it under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation, either version 3 of the
-* License, or (at your option) any later version.
-*
-* marc-record-merge-js is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-* GNU Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public License
-* along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*
-* @licend  The above is the entire license notice
-* for the JavaScript code in this file.
-*
-*/
 var _default = ({
   base,
   source,
-  reducers,
-  baseValidators = {},
-  sourceValidators = {}
-}) => {
-  const sourceRecord = _marcRecord.MarcRecord.clone(source, sourceValidators);
-
-  return reducers.reduce((baseRecord, reducer) => reducer(baseRecord, sourceRecord), _marcRecord.MarcRecord.clone(base, baseValidators));
-};
+  reducers
+}) => reducers.reduce((base, reducer) => reducer(base, source), base);
 
 exports.default = _default;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.js"],"names":["base","source","reducers","baseValidators","sourceValidators","sourceRecord","MarcRecord","clone","reduce","baseRecord","reducer"],"mappings":";;;;;;;;;;;;;AA4BA;;AACA;;;;AA7BA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;eAMe,CAAC;AAACA,EAAAA,IAAD;AAAOC,EAAAA,MAAP;AAAeC,EAAAA,QAAf;AAAyBC,EAAAA,cAAc,GAAG,EAA1C;AAA8CC,EAAAA,gBAAgB,GAAG;AAAjE,CAAD,KAA0E;AACvF,QAAMC,YAAY,GAAGC,uBAAWC,KAAX,CAAiBN,MAAjB,EAAyBG,gBAAzB,CAArB;;AACA,SAAOF,QAAQ,CAACM,MAAT,CAAgB,CAACC,UAAD,EAAaC,OAAb,KAAyBA,OAAO,CAACD,UAAD,EAAaJ,YAAb,CAAhD,EAA4EC,uBAAWC,KAAX,CAAiBP,IAAjB,EAAuBG,cAAvB,CAA5E,CAAP;AACD,C","sourcesContent":["/**\n*\n* @licstart  The following is the entire license notice for the JavaScript code in this file.\n*\n* Merge MARC records\n*\n* Copyright (C) 2015-2019 University Of Helsinki (The National Library Of Finland)\n*\n* This file is part of marc-record-merge-js\n\n* marc-record-merge-js program is free software: you can redistribute it and/or modify\n* it under the terms of the GNU Lesser General Public License as\n* published by the Free Software Foundation, either version 3 of the\n* License, or (at your option) any later version.\n*\n* marc-record-merge-js is distributed in the hope that it will be useful,\n* but WITHOUT ANY WARRANTY; without even the implied warranty of\n* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n* GNU Lesser General Public License for more details.\n*\n* You should have received a copy of the GNU Lesser General Public License\n* along with this program.  If not, see <http://www.gnu.org/licenses/>.\n*\n* @licend  The above is the entire license notice\n* for the JavaScript code in this file.\n*\n*/\n\nimport {MarcRecord} from '@natlibfi/marc-record';\nimport Reducers from './reducers';\n\nexport {Reducers};\nexport default ({base, source, reducers, baseValidators = {}, sourceValidators = {}}) => {\n  const sourceRecord = MarcRecord.clone(source, sourceValidators);\n  return reducers.reduce((baseRecord, reducer) => reducer(baseRecord, sourceRecord), MarcRecord.clone(base, baseValidators));\n};\n"],"file":"index.js"}
+{"version":3,"file":"index.js","names":["base","source","reducers","reduce","reducer"],"sources":["../src/index.js"],"sourcesContent":["import Reducers from './reducers';\n\nexport {Reducers};\nexport default ({base, source, reducers}) => reducers.reduce((base, reducer) => reducer(base, source), base);\n"],"mappings":";;;;;;;;;;;;;AAAA;;;;eAGe,CAAC;EAACA,IAAD;EAAOC,MAAP;EAAeC;AAAf,CAAD,KAA8BA,QAAQ,CAACC,MAAT,CAAgB,CAACH,IAAD,EAAOI,OAAP,KAAmBA,OAAO,CAACJ,IAAD,EAAOC,MAAP,CAA1C,EAA0DD,IAA1D,C"}