@biblioteksentralen/marc 0.1.1 → 0.2.0

package/README.md

@@ -100,3 +100,7 @@ const ajv = new Ajv();
 const validate = ajv.compile(schema);
 const result = validate(record.toJSON());
 ```
+
+## Changelog
+
+- 0.2.0: Removed the logger argument from `MarcRecord.fromJSON()`.

package/dist/index.cjs

@@ -59,8 +59,14 @@ var DataField = class {
       subfields: this.subfields.map((subfield) => subfield.toJSON())
     };
   }
+  /**
+   * Returns a human-readable string representation of this MARC data field.
+   *
+   * The result is intended for debugging, logging, and test output. The format is not guaranteed to
+   * be stable and should not be parsed or relied upon.
+   */
   toString() {
-    return `${this.tag} ${this.subfields.map((subfield) => subfield.toString()).join(" ")}`;
+    return `${this.tag} ${this.ind1 ?? " "}${this.ind2 ?? " "} ${this.subfields.map((subfield) => subfield.toString()).join(" ")}`;
   }
 };
 var isControlField = (field) => field instanceof ControlField;
@@ -180,9 +186,10 @@ function createMarcSchema({
 
 // src/marc-record/errors.ts
 var MarcRecordSchemaValidationError = class extends Error {
-  constructor(errors) {
+  constructor(errors, sourceData) {
     super("MarcRecord schema validation failed");
     this.errors = errors;
+    this.sourceData = sourceData;
   }
 };
 var MarcParseError = class extends Error {
@@ -191,6 +198,80 @@ var MarcParseError = class extends Error {
     this.record = record;
   }
 };
+function buildRecordXml(input) {
+  const fields = [
+    xmlUtils.createXmlElement("leader", { text: input.leader }),
+    ...input.getControlFields().map(
+      (field) => xmlUtils.createXmlElement("controlfield", {
+        attributes: { tag: field.tag },
+        text: field.value
+      })
+    ),
+    ...input.getDataFields().map(
+      (field) => xmlUtils.createXmlElement("datafield", {
+        attributes: withoutEmptyValues({
+          tag: field.tag,
+          ind1: field.ind1,
+          ind2: field.ind2
+        }),
+        children: field.subfields.map(
+          (subfield) => xmlUtils.createXmlElement("subfield", {
+            attributes: { code: subfield.code },
+            text: subfield.value
+          })
+        )
+      })
+    )
+  ];
+  const recordNode = xmlUtils.createXmlElement("record", {
+    children: fields
+  });
+  return recordNode;
+}
+function serializeMarcXml(input, pretty = false) {
+  const record = buildRecordXml(input);
+  record.setAttribute("xmlns", "http://www.loc.gov/MARC21/slim");
+  return xmlUtils.serializeXml(record, pretty);
+}
+var withoutEmptyValues = (obj) => Object.keys(obj).reduce(
+  (acc, key) => obj[key] === void 0 ? { ...acc } : { ...acc, [key]: obj[key] },
+  {}
+);
+function serializeMarcXmlCollection(input, pretty = false) {
+  const records = input.map(buildRecordXml);
+  const collectionNode = xmlUtils.createXmlElement("collection", {
+    attributes: { xmlns: "http://www.loc.gov/MARC21/slim" },
+    children: records
+  });
+  return xmlUtils.serializeXml(collectionNode, pretty);
+}
+
+// src/marc-record/serializeLineMarc.ts
+function serializeLineMarc(input) {
+  const leader = serializer.leader(input.leader);
+  const control = input.getControlFields().map(serializer.controlfield).join("");
+  const data = input.getDataFields().map(serializer.datafield).join("");
+  return `${leader}${control}${data}^
+`;
+}
+var serializer = {
+  leader: (leader) => `*LDR${leader}
+`,
+  controlfield: (field) => `*${field.tag}${field.value}
+`,
+  datafield: (field) => {
+    const ind1 = field.ind1 ?? " ";
+    const ind2 = field.ind2 ?? " ";
+    const subfields = field.subfields.map(
+      (subfield) => `$${subfield.code}${escapeSubfieldValue(subfield.value)}`
+    ).join("");
+    return `*${field.tag}${ind1}${ind2}${subfields}
+`;
+  }
+};
+var escapeSubfieldValue = (value) => {
+  return value.replace(/\n/g, " ").replace(/\$/g, "@{2}");
+};
 
 // src/marc-record/MarcRecord.ts
 var validator = new ajv.Ajv().compile(createMarcSchema());
@@ -207,10 +288,9 @@ var MarcRecord = class _MarcRecord {
     this.leader = leader;
     this.fields = fields;
   }
-  static fromJSON(data, log) {
+  static fromJSON(data) {
     const { format, leader, fields } = this.validateJSON(
-      fixInvalidMarcRecordSerialization(data),
-      log
+      fixInvalidMarcRecordSerialization(data)
     );
     return new _MarcRecord({
       leader,
@@ -227,17 +307,23 @@ var MarcRecord = class _MarcRecord {
       fields: this.fields.map((field) => field.toJSON())
     };
   }
-  static validateJSON(data, log) {
+  toXML(pretty = false) {
+    return serializeMarcXml(this, pretty);
+  }
+  toXmlElement() {
+    return buildRecordXml(this);
+  }
+  toLineMarc() {
+    return serializeLineMarc(this);
+  }
+  static validateJSON(data) {
     if (validator(data)) {
       return data;
     }
-    log.error(
-      `MarcRecord validation failed:
-${validator.errors ? JSON.stringify(validator.errors) : "Unknown error"}.
-Data:
-${JSON.stringify(data)}`
+    throw new MarcRecordSchemaValidationError(
+      validator.errors ?? [],
+      JSON.stringify(data)
     );
-    throw new MarcRecordSchemaValidationError(validator.errors ?? []);
   }
   getControlFields() {
     return this.fields.filter(isControlField);
@@ -382,80 +468,6 @@ var marcRecordZodSchema = zod.z.object({
   fields: zod.z.array(zod.z.union([controlFieldSchema, dataFieldSchema]))
 });
 
-// src/marc-record/serializeLineMarc.ts
-function serializeLineMarc(input) {
-  const leader = serializer.leader(input.leader);
-  const control = input.getControlFields().map(serializer.controlfield).join("");
-  const data = input.getDataFields().map(serializer.datafield).join("");
-  return `${leader}${control}${data}^
-`;
-}
-var serializer = {
-  leader: (leader) => `*LDR${leader}
-`,
-  controlfield: (field) => `*${field.tag}${field.value}
-`,
-  datafield: (field) => {
-    const ind1 = field.ind1 ?? " ";
-    const ind2 = field.ind2 ?? " ";
-    const subfields = field.subfields.map(
-      (subfield) => `$${subfield.code}${escapeSubfieldValue(subfield.value)}`
-    ).join("");
-    return `*${field.tag}${ind1}${ind2}${subfields}
-`;
-  }
-};
-var escapeSubfieldValue = (value) => {
-  return value.replace(/\n/g, " ").replace(/\$/g, "@{2}");
-};
-function buildRecordXml(input) {
-  const fields = [
-    xmlUtils.createXmlElement("leader", { text: input.leader }),
-    ...input.getControlFields().map(
-      (field) => xmlUtils.createXmlElement("controlfield", {
-        attributes: { tag: field.tag },
-        text: field.value
-      })
-    ),
-    ...input.getDataFields().map(
-      (field) => xmlUtils.createXmlElement("datafield", {
-        attributes: withoutEmptyValues({
-          tag: field.tag,
-          ind1: field.ind1,
-          ind2: field.ind2
-        }),
-        children: field.subfields.map(
-          (subfield) => xmlUtils.createXmlElement("subfield", {
-            attributes: { code: subfield.code },
-            text: subfield.value
-          })
-        )
-      })
-    )
-  ];
-  const recordNode = xmlUtils.createXmlElement("record", {
-    children: fields
-  });
-  return recordNode;
-}
-function serializeMarcXml(input, pretty = false) {
-  const record = buildRecordXml(input);
-  record.setAttribute("xmlns", "http://www.loc.gov/MARC21/slim");
-  return xmlUtils.serializeXml(record, pretty);
-}
-var withoutEmptyValues = (obj) => Object.keys(obj).reduce(
-  (acc, key) => obj[key] === void 0 ? { ...acc } : { ...acc, [key]: obj[key] },
-  {}
-);
-function serializeMarcXmlCollection(input, pretty = false) {
-  const records = input.map(buildRecordXml);
-  const collectionNode = xmlUtils.createXmlElement("collection", {
-    attributes: { xmlns: "http://www.loc.gov/MARC21/slim" },
-    children: records
-  });
-  return xmlUtils.serializeXml(collectionNode, pretty);
-}
-
 exports.ControlField = ControlField;
 exports.DataField = DataField;
 exports.MarcParseError = MarcParseError;

package/dist/index.d.cts

@@ -1,5 +1,4 @@
 import { XmlElement } from '@biblioteksentralen/xml-utils';
-import { Logger } from 'ts-log';
 import { z } from 'zod';
 import { ErrorObject } from 'ajv';
 
@@ -42,6 +41,12 @@ declare class DataField {
     getFirstSubfield(code: string | RegExp): Subfield | undefined;
     getFirstSubfieldValue(code: string | RegExp): string | undefined;
     toJSON(): SerializedDataField;
+    /**
+     * Returns a human-readable string representation of this MARC data field.
+     *
+     * The result is intended for debugging, logging, and test output. The format is not guaranteed to
+     * be stable and should not be parsed or relied upon.
+     */
     toString(): string;
 }
 type MarcField = ControlField | DataField;
@@ -75,9 +80,12 @@ declare class MarcRecord {
         fields: MarcField[];
         format?: string;
     });
-    static fromJSON(data: unknown, log: Logger): MarcRecord;
+    static fromJSON(data: unknown): MarcRecord;
     toJSON(): SerializedMarcRecord;
-    static validateJSON(data: unknown, log: Logger): SerializedMarcRecord;
+    toXML(pretty?: boolean): string;
+    toXmlElement(): XmlElement;
+    toLineMarc(): string;
+    static validateJSON(data: unknown): SerializedMarcRecord;
     getControlFields(): ControlField[];
     getControlField(tag: string): ControlField | undefined;
     getDataFields(tag?: string | RegExp, indicators?: Indicators): DataField[];
@@ -210,7 +218,8 @@ declare function serializeMarcXmlCollection(input: MarcRecord[], pretty?: boolea
 
 declare class MarcRecordSchemaValidationError extends Error {
     readonly errors: ErrorObject[];
-    constructor(errors: ErrorObject[]);
+    readonly sourceData?: string | undefined;
+    constructor(errors: ErrorObject[], sourceData?: string | undefined);
 }
 declare class MarcParseError extends Error {
     readonly record: string;

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import { XmlElement } from '@biblioteksentralen/xml-utils';
-import { Logger } from 'ts-log';
 import { z } from 'zod';
 import { ErrorObject } from 'ajv';
 
@@ -42,6 +41,12 @@ declare class DataField {
     getFirstSubfield(code: string | RegExp): Subfield | undefined;
     getFirstSubfieldValue(code: string | RegExp): string | undefined;
     toJSON(): SerializedDataField;
+    /**
+     * Returns a human-readable string representation of this MARC data field.
+     *
+     * The result is intended for debugging, logging, and test output. The format is not guaranteed to
+     * be stable and should not be parsed or relied upon.
+     */
     toString(): string;
 }
 type MarcField = ControlField | DataField;
@@ -75,9 +80,12 @@ declare class MarcRecord {
         fields: MarcField[];
         format?: string;
     });
-    static fromJSON(data: unknown, log: Logger): MarcRecord;
+    static fromJSON(data: unknown): MarcRecord;
     toJSON(): SerializedMarcRecord;
-    static validateJSON(data: unknown, log: Logger): SerializedMarcRecord;
+    toXML(pretty?: boolean): string;
+    toXmlElement(): XmlElement;
+    toLineMarc(): string;
+    static validateJSON(data: unknown): SerializedMarcRecord;
     getControlFields(): ControlField[];
     getControlField(tag: string): ControlField | undefined;
     getDataFields(tag?: string | RegExp, indicators?: Indicators): DataField[];
@@ -210,7 +218,8 @@ declare function serializeMarcXmlCollection(input: MarcRecord[], pretty?: boolea
 
 declare class MarcRecordSchemaValidationError extends Error {
     readonly errors: ErrorObject[];
-    constructor(errors: ErrorObject[]);
+    readonly sourceData?: string | undefined;
+    constructor(errors: ErrorObject[], sourceData?: string | undefined);
 }
 declare class MarcParseError extends Error {
     readonly record: string;

package/dist/index.js

@@ -1,4 +1,4 @@
-import { parseXml, serializeXml, createXmlElement } from '@biblioteksentralen/xml-utils';
+import { serializeXml, createXmlElement, parseXml } from '@biblioteksentralen/xml-utils';
 import { Ajv } from 'ajv';
 import { z } from 'zod';
 
@@ -57,8 +57,14 @@ var DataField = class {
       subfields: this.subfields.map((subfield) => subfield.toJSON())
     };
   }
+  /**
+   * Returns a human-readable string representation of this MARC data field.
+   *
+   * The result is intended for debugging, logging, and test output. The format is not guaranteed to
+   * be stable and should not be parsed or relied upon.
+   */
   toString() {
-    return `${this.tag} ${this.subfields.map((subfield) => subfield.toString()).join(" ")}`;
+    return `${this.tag} ${this.ind1 ?? " "}${this.ind2 ?? " "} ${this.subfields.map((subfield) => subfield.toString()).join(" ")}`;
   }
 };
 var isControlField = (field) => field instanceof ControlField;
@@ -178,9 +184,10 @@ function createMarcSchema({
 
 // src/marc-record/errors.ts
 var MarcRecordSchemaValidationError = class extends Error {
-  constructor(errors) {
+  constructor(errors, sourceData) {
     super("MarcRecord schema validation failed");
     this.errors = errors;
+    this.sourceData = sourceData;
   }
 };
 var MarcParseError = class extends Error {
@@ -189,6 +196,80 @@ var MarcParseError = class extends Error {
     this.record = record;
   }
 };
+function buildRecordXml(input) {
+  const fields = [
+    createXmlElement("leader", { text: input.leader }),
+    ...input.getControlFields().map(
+      (field) => createXmlElement("controlfield", {
+        attributes: { tag: field.tag },
+        text: field.value
+      })
+    ),
+    ...input.getDataFields().map(
+      (field) => createXmlElement("datafield", {
+        attributes: withoutEmptyValues({
+          tag: field.tag,
+          ind1: field.ind1,
+          ind2: field.ind2
+        }),
+        children: field.subfields.map(
+          (subfield) => createXmlElement("subfield", {
+            attributes: { code: subfield.code },
+            text: subfield.value
+          })
+        )
+      })
+    )
+  ];
+  const recordNode = createXmlElement("record", {
+    children: fields
+  });
+  return recordNode;
+}
+function serializeMarcXml(input, pretty = false) {
+  const record = buildRecordXml(input);
+  record.setAttribute("xmlns", "http://www.loc.gov/MARC21/slim");
+  return serializeXml(record, pretty);
+}
+var withoutEmptyValues = (obj) => Object.keys(obj).reduce(
+  (acc, key) => obj[key] === void 0 ? { ...acc } : { ...acc, [key]: obj[key] },
+  {}
+);
+function serializeMarcXmlCollection(input, pretty = false) {
+  const records = input.map(buildRecordXml);
+  const collectionNode = createXmlElement("collection", {
+    attributes: { xmlns: "http://www.loc.gov/MARC21/slim" },
+    children: records
+  });
+  return serializeXml(collectionNode, pretty);
+}
+
+// src/marc-record/serializeLineMarc.ts
+function serializeLineMarc(input) {
+  const leader = serializer.leader(input.leader);
+  const control = input.getControlFields().map(serializer.controlfield).join("");
+  const data = input.getDataFields().map(serializer.datafield).join("");
+  return `${leader}${control}${data}^
+`;
+}
+var serializer = {
+  leader: (leader) => `*LDR${leader}
+`,
+  controlfield: (field) => `*${field.tag}${field.value}
+`,
+  datafield: (field) => {
+    const ind1 = field.ind1 ?? " ";
+    const ind2 = field.ind2 ?? " ";
+    const subfields = field.subfields.map(
+      (subfield) => `$${subfield.code}${escapeSubfieldValue(subfield.value)}`
+    ).join("");
+    return `*${field.tag}${ind1}${ind2}${subfields}
+`;
+  }
+};
+var escapeSubfieldValue = (value) => {
+  return value.replace(/\n/g, " ").replace(/\$/g, "@{2}");
+};
 
 // src/marc-record/MarcRecord.ts
 var validator = new Ajv().compile(createMarcSchema());
@@ -205,10 +286,9 @@ var MarcRecord = class _MarcRecord {
     this.leader = leader;
     this.fields = fields;
   }
-  static fromJSON(data, log) {
+  static fromJSON(data) {
     const { format, leader, fields } = this.validateJSON(
-      fixInvalidMarcRecordSerialization(data),
-      log
+      fixInvalidMarcRecordSerialization(data)
     );
     return new _MarcRecord({
       leader,
@@ -225,17 +305,23 @@ var MarcRecord = class _MarcRecord {
       fields: this.fields.map((field) => field.toJSON())
     };
   }
-  static validateJSON(data, log) {
+  toXML(pretty = false) {
+    return serializeMarcXml(this, pretty);
+  }
+  toXmlElement() {
+    return buildRecordXml(this);
+  }
+  toLineMarc() {
+    return serializeLineMarc(this);
+  }
+  static validateJSON(data) {
     if (validator(data)) {
       return data;
     }
-    log.error(
-      `MarcRecord validation failed:
-${validator.errors ? JSON.stringify(validator.errors) : "Unknown error"}.
-Data:
-${JSON.stringify(data)}`
+    throw new MarcRecordSchemaValidationError(
+      validator.errors ?? [],
+      JSON.stringify(data)
     );
-    throw new MarcRecordSchemaValidationError(validator.errors ?? []);
   }
   getControlFields() {
     return this.fields.filter(isControlField);
@@ -380,78 +466,4 @@ var marcRecordZodSchema = z.object({
   fields: z.array(z.union([controlFieldSchema, dataFieldSchema]))
 });
 
-// src/marc-record/serializeLineMarc.ts
-function serializeLineMarc(input) {
-  const leader = serializer.leader(input.leader);
-  const control = input.getControlFields().map(serializer.controlfield).join("");
-  const data = input.getDataFields().map(serializer.datafield).join("");
-  return `${leader}${control}${data}^
-`;
-}
-var serializer = {
-  leader: (leader) => `*LDR${leader}
-`,
-  controlfield: (field) => `*${field.tag}${field.value}
-`,
-  datafield: (field) => {
-    const ind1 = field.ind1 ?? " ";
-    const ind2 = field.ind2 ?? " ";
-    const subfields = field.subfields.map(
-      (subfield) => `$${subfield.code}${escapeSubfieldValue(subfield.value)}`
-    ).join("");
-    return `*${field.tag}${ind1}${ind2}${subfields}
-`;
-  }
-};
-var escapeSubfieldValue = (value) => {
-  return value.replace(/\n/g, " ").replace(/\$/g, "@{2}");
-};
-function buildRecordXml(input) {
-  const fields = [
-    createXmlElement("leader", { text: input.leader }),
-    ...input.getControlFields().map(
-      (field) => createXmlElement("controlfield", {
-        attributes: { tag: field.tag },
-        text: field.value
-      })
-    ),
-    ...input.getDataFields().map(
-      (field) => createXmlElement("datafield", {
-        attributes: withoutEmptyValues({
-          tag: field.tag,
-          ind1: field.ind1,
-          ind2: field.ind2
-        }),
-        children: field.subfields.map(
-          (subfield) => createXmlElement("subfield", {
-            attributes: { code: subfield.code },
-            text: subfield.value
-          })
-        )
-      })
-    )
-  ];
-  const recordNode = createXmlElement("record", {
-    children: fields
-  });
-  return recordNode;
-}
-function serializeMarcXml(input, pretty = false) {
-  const record = buildRecordXml(input);
-  record.setAttribute("xmlns", "http://www.loc.gov/MARC21/slim");
-  return serializeXml(record, pretty);
-}
-var withoutEmptyValues = (obj) => Object.keys(obj).reduce(
-  (acc, key) => obj[key] === void 0 ? { ...acc } : { ...acc, [key]: obj[key] },
-  {}
-);
-function serializeMarcXmlCollection(input, pretty = false) {
-  const records = input.map(buildRecordXml);
-  const collectionNode = createXmlElement("collection", {
-    attributes: { xmlns: "http://www.loc.gov/MARC21/slim" },
-    children: records
-  });
-  return serializeXml(collectionNode, pretty);
-}
-
 export { ControlField, DataField, MarcParseError, MarcRecord, MarcRecordSchemaValidationError, Subfield, createControlField, createDataField, marcRecordZodSchema, parseMarcXml, serializeLineMarc, serializeMarcXml, serializeMarcXmlCollection };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@biblioteksentralen/marc",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "private": false,
   "type": "module",
   "description": "MARC record parser and serializer",
@@ -26,7 +26,6 @@
   ],
   "dependencies": {
     "ajv": "^8.17.1",
-    "ts-log": "^2.2.5",
     "zod": "^3.23.8",
     "@biblioteksentralen/xml-utils": "^0.0.3"
   },