@biblioteksentralen/marc 0.0.5 → 0.1.1

package/dist/index.cjs

@@ -178,14 +178,22 @@ function createMarcSchema({
   };
 }
 
-// src/marc-record/MarcRecord.ts
-var validator = new ajv.Ajv().compile(createMarcSchema());
-var ValidationFailed = class extends Error {
+// src/marc-record/errors.ts
+var MarcRecordSchemaValidationError = class extends Error {
   constructor(errors) {
-    super("MarcRecord validation failed");
+    super("MarcRecord schema validation failed");
     this.errors = errors;
   }
 };
+var MarcParseError = class extends Error {
+  constructor(message, record) {
+    super(message);
+    this.record = record;
+  }
+};
+
+// src/marc-record/MarcRecord.ts
+var validator = new ajv.Ajv().compile(createMarcSchema());
 var MarcRecord = class _MarcRecord {
   format;
   leader;
@@ -212,6 +220,13 @@ var MarcRecord = class _MarcRecord {
       )
     });
   }
+  toJSON() {
+    return {
+      format: this.format,
+      leader: this.leader,
+      fields: this.fields.map((field) => field.toJSON())
+    };
+  }
   static validateJSON(data, log) {
     if (validator(data)) {
       return data;
@@ -222,7 +237,7 @@ ${validator.errors ? JSON.stringify(validator.errors) : "Unknown error"}.
 Data:
 ${JSON.stringify(data)}`
     );
-    throw new ValidationFailed(validator.errors ?? []);
+    throw new MarcRecordSchemaValidationError(validator.errors ?? []);
   }
   getControlFields() {
     return this.fields.filter(isControlField);
@@ -248,20 +263,43 @@ ${JSON.stringify(data)}`
   getFirstSubfieldValue(tag, code, indicators) {
     return this.getSubfieldValues(tag, code, indicators)[0];
   }
-  toJSON() {
-    return {
+  /**
+   * Returns a new MarcRecord without control fields matching the given predicate, without modifying
+   * the original one.
+   */
+  withoutControlFields(predicate) {
+    return new _MarcRecord({
       format: this.format,
       leader: this.leader,
-      fields: this.fields.map((field) => field.toJSON())
-    };
+      fields: this.fields.filter(
+        (field) => !isControlField(field) || !predicate(field)
+      )
+    });
   }
-};
-
-// src/marc-record/MarcParseError.ts
-var MarcParseError = class extends Error {
-  constructor(message, record) {
-    super(message);
-    this.record = record;
+  /**
+   * Returns a new MarcRecord without data fields matching the given predicate, without modifying
+   * the original one.
+   */
+  withoutDataFields(predicate) {
+    return new _MarcRecord({
+      format: this.format,
+      leader: this.leader,
+      fields: this.fields.filter(
+        (field) => !isDataField(field) || !predicate(field)
+      )
+    });
+  }
+  /**
+   * Returns a new MarcRecord with the given fields added without modifying the original one.
+   */
+  withFields(fields) {
+    return new _MarcRecord({
+      format: this.format,
+      leader: this.leader,
+      fields: [...this.fields, ...fields].toSorted(
+        (a, b) => a.tag.localeCompare(b.tag)
+      )
+    });
   }
 };
 
@@ -370,7 +408,7 @@ var serializer = {
 var escapeSubfieldValue = (value) => {
   return value.replace(/\n/g, " ").replace(/\$/g, "@{2}");
 };
-function serializeMarcXml(input, pretty = false) {
+function buildRecordXml(input) {
   const fields = [
     xmlUtils.createXmlElement("leader", { text: input.leader }),
     ...input.getControlFields().map(
@@ -396,20 +434,33 @@ function serializeMarcXml(input, pretty = false) {
     )
   ];
   const recordNode = xmlUtils.createXmlElement("record", {
-    attributes: { xmlns: "http://www.loc.gov/MARC21/slim" },
     children: fields
   });
-  return xmlUtils.serializeXml(recordNode, pretty);
+  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;
 exports.MarcRecord = MarcRecord;
+exports.MarcRecordSchemaValidationError = MarcRecordSchemaValidationError;
 exports.Subfield = Subfield;
 exports.createControlField = createControlField;
 exports.createDataField = createDataField;
@@ -417,3 +468,4 @@ exports.marcRecordZodSchema = marcRecordZodSchema;
 exports.parseMarcXml = parseMarcXml;
 exports.serializeLineMarc = serializeLineMarc;
 exports.serializeMarcXml = serializeMarcXml;
+exports.serializeMarcXmlCollection = serializeMarcXmlCollection;

package/dist/index.d.cts

@@ -1,6 +1,7 @@
 import { XmlElement } from '@biblioteksentralen/xml-utils';
 import { Logger } from 'ts-log';
 import { z } from 'zod';
+import { ErrorObject } from 'ajv';
 
 type SerializedMarcField = SerializedDataField | SerializedControlField;
 interface SerializedControlField {
@@ -75,6 +76,7 @@ declare class MarcRecord {
         format?: string;
     });
     static fromJSON(data: unknown, log: Logger): MarcRecord;
+    toJSON(): SerializedMarcRecord;
     static validateJSON(data: unknown, log: Logger): SerializedMarcRecord;
     getControlFields(): ControlField[];
     getControlField(tag: string): ControlField | undefined;
@@ -83,7 +85,20 @@ declare class MarcRecord {
     getSubfields(tag: string | RegExp, code: string | RegExp, indicators?: Indicators): Subfield[];
     getSubfieldValues(tag: string | RegExp, code: string | RegExp, indicators?: Indicators): string[];
     getFirstSubfieldValue(tag: string | RegExp, code: string | RegExp, indicators?: Indicators): string | undefined;
-    toJSON(): SerializedMarcRecord;
+    /**
+     * Returns a new MarcRecord without control fields matching the given predicate, without modifying
+     * the original one.
+     */
+    withoutControlFields(predicate: (field: ControlField) => boolean): MarcRecord;
+    /**
+     * Returns a new MarcRecord without data fields matching the given predicate, without modifying
+     * the original one.
+     */
+    withoutDataFields(predicate: (field: DataField) => boolean): MarcRecord;
+    /**
+     * Returns a new MarcRecord with the given fields added without modifying the original one.
+     */
+    withFields(fields: MarcField[]): MarcRecord;
 }
 
 interface MarcXmlOptions {
@@ -191,10 +206,15 @@ declare const marcRecordZodSchema: z.ZodObject<{
 declare function serializeLineMarc(input: MarcRecord): string;
 
 declare function serializeMarcXml(input: MarcRecord, pretty?: boolean): string;
+declare function serializeMarcXmlCollection(input: MarcRecord[], pretty?: boolean): string;
 
+declare class MarcRecordSchemaValidationError extends Error {
+    readonly errors: ErrorObject[];
+    constructor(errors: ErrorObject[]);
+}
 declare class MarcParseError extends Error {
     readonly record: string;
     constructor(message: string, record: string);
 }
 
-export { ControlField, DataField, type MarcField, MarcParseError, MarcRecord, type SerializedControlField, type SerializedDataField, type SerializedMarcField, type SerializedMarcRecord, Subfield, createControlField, createDataField, marcRecordZodSchema, parseMarcXml, serializeLineMarc, serializeMarcXml };
+export { ControlField, DataField, type MarcField, MarcParseError, MarcRecord, MarcRecordSchemaValidationError, type SerializedControlField, type SerializedDataField, type SerializedMarcField, type SerializedMarcRecord, Subfield, createControlField, createDataField, marcRecordZodSchema, parseMarcXml, serializeLineMarc, serializeMarcXml, serializeMarcXmlCollection };

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { XmlElement } from '@biblioteksentralen/xml-utils';
 import { Logger } from 'ts-log';
 import { z } from 'zod';
+import { ErrorObject } from 'ajv';
 
 type SerializedMarcField = SerializedDataField | SerializedControlField;
 interface SerializedControlField {
@@ -75,6 +76,7 @@ declare class MarcRecord {
         format?: string;
     });
     static fromJSON(data: unknown, log: Logger): MarcRecord;
+    toJSON(): SerializedMarcRecord;
     static validateJSON(data: unknown, log: Logger): SerializedMarcRecord;
     getControlFields(): ControlField[];
     getControlField(tag: string): ControlField | undefined;
@@ -83,7 +85,20 @@ declare class MarcRecord {
     getSubfields(tag: string | RegExp, code: string | RegExp, indicators?: Indicators): Subfield[];
     getSubfieldValues(tag: string | RegExp, code: string | RegExp, indicators?: Indicators): string[];
     getFirstSubfieldValue(tag: string | RegExp, code: string | RegExp, indicators?: Indicators): string | undefined;
-    toJSON(): SerializedMarcRecord;
+    /**
+     * Returns a new MarcRecord without control fields matching the given predicate, without modifying
+     * the original one.
+     */
+    withoutControlFields(predicate: (field: ControlField) => boolean): MarcRecord;
+    /**
+     * Returns a new MarcRecord without data fields matching the given predicate, without modifying
+     * the original one.
+     */
+    withoutDataFields(predicate: (field: DataField) => boolean): MarcRecord;
+    /**
+     * Returns a new MarcRecord with the given fields added without modifying the original one.
+     */
+    withFields(fields: MarcField[]): MarcRecord;
 }
 
 interface MarcXmlOptions {
@@ -191,10 +206,15 @@ declare const marcRecordZodSchema: z.ZodObject<{
 declare function serializeLineMarc(input: MarcRecord): string;
 
 declare function serializeMarcXml(input: MarcRecord, pretty?: boolean): string;
+declare function serializeMarcXmlCollection(input: MarcRecord[], pretty?: boolean): string;
 
+declare class MarcRecordSchemaValidationError extends Error {
+    readonly errors: ErrorObject[];
+    constructor(errors: ErrorObject[]);
+}
 declare class MarcParseError extends Error {
     readonly record: string;
     constructor(message: string, record: string);
 }
 
-export { ControlField, DataField, type MarcField, MarcParseError, MarcRecord, type SerializedControlField, type SerializedDataField, type SerializedMarcField, type SerializedMarcRecord, Subfield, createControlField, createDataField, marcRecordZodSchema, parseMarcXml, serializeLineMarc, serializeMarcXml };
+export { ControlField, DataField, type MarcField, MarcParseError, MarcRecord, MarcRecordSchemaValidationError, type SerializedControlField, type SerializedDataField, type SerializedMarcField, type SerializedMarcRecord, Subfield, createControlField, createDataField, marcRecordZodSchema, parseMarcXml, serializeLineMarc, serializeMarcXml, serializeMarcXmlCollection };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { parseXml, createXmlElement, serializeXml } from '@biblioteksentralen/xml-utils';
+import { parseXml, serializeXml, createXmlElement } from '@biblioteksentralen/xml-utils';
 import { Ajv } from 'ajv';
 import { z } from 'zod';
 
@@ -176,14 +176,22 @@ function createMarcSchema({
   };
 }
 
-// src/marc-record/MarcRecord.ts
-var validator = new Ajv().compile(createMarcSchema());
-var ValidationFailed = class extends Error {
+// src/marc-record/errors.ts
+var MarcRecordSchemaValidationError = class extends Error {
   constructor(errors) {
-    super("MarcRecord validation failed");
+    super("MarcRecord schema validation failed");
     this.errors = errors;
   }
 };
+var MarcParseError = class extends Error {
+  constructor(message, record) {
+    super(message);
+    this.record = record;
+  }
+};
+
+// src/marc-record/MarcRecord.ts
+var validator = new Ajv().compile(createMarcSchema());
 var MarcRecord = class _MarcRecord {
   format;
   leader;
@@ -210,6 +218,13 @@ var MarcRecord = class _MarcRecord {
       )
     });
   }
+  toJSON() {
+    return {
+      format: this.format,
+      leader: this.leader,
+      fields: this.fields.map((field) => field.toJSON())
+    };
+  }
   static validateJSON(data, log) {
     if (validator(data)) {
       return data;
@@ -220,7 +235,7 @@ ${validator.errors ? JSON.stringify(validator.errors) : "Unknown error"}.
 Data:
 ${JSON.stringify(data)}`
     );
-    throw new ValidationFailed(validator.errors ?? []);
+    throw new MarcRecordSchemaValidationError(validator.errors ?? []);
   }
   getControlFields() {
     return this.fields.filter(isControlField);
@@ -246,20 +261,43 @@ ${JSON.stringify(data)}`
   getFirstSubfieldValue(tag, code, indicators) {
     return this.getSubfieldValues(tag, code, indicators)[0];
   }
-  toJSON() {
-    return {
+  /**
+   * Returns a new MarcRecord without control fields matching the given predicate, without modifying
+   * the original one.
+   */
+  withoutControlFields(predicate) {
+    return new _MarcRecord({
       format: this.format,
       leader: this.leader,
-      fields: this.fields.map((field) => field.toJSON())
-    };
+      fields: this.fields.filter(
+        (field) => !isControlField(field) || !predicate(field)
+      )
+    });
   }
-};
-
-// src/marc-record/MarcParseError.ts
-var MarcParseError = class extends Error {
-  constructor(message, record) {
-    super(message);
-    this.record = record;
+  /**
+   * Returns a new MarcRecord without data fields matching the given predicate, without modifying
+   * the original one.
+   */
+  withoutDataFields(predicate) {
+    return new _MarcRecord({
+      format: this.format,
+      leader: this.leader,
+      fields: this.fields.filter(
+        (field) => !isDataField(field) || !predicate(field)
+      )
+    });
+  }
+  /**
+   * Returns a new MarcRecord with the given fields added without modifying the original one.
+   */
+  withFields(fields) {
+    return new _MarcRecord({
+      format: this.format,
+      leader: this.leader,
+      fields: [...this.fields, ...fields].toSorted(
+        (a, b) => a.tag.localeCompare(b.tag)
+      )
+    });
   }
 };
 
@@ -368,7 +406,7 @@ var serializer = {
 var escapeSubfieldValue = (value) => {
   return value.replace(/\n/g, " ").replace(/\$/g, "@{2}");
 };
-function serializeMarcXml(input, pretty = false) {
+function buildRecordXml(input) {
   const fields = [
     createXmlElement("leader", { text: input.leader }),
     ...input.getControlFields().map(
@@ -394,14 +432,26 @@ function serializeMarcXml(input, pretty = false) {
     )
   ];
   const recordNode = createXmlElement("record", {
-    attributes: { xmlns: "http://www.loc.gov/MARC21/slim" },
     children: fields
   });
-  return serializeXml(recordNode, pretty);
+  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, Subfield, createControlField, createDataField, marcRecordZodSchema, parseMarcXml, serializeLineMarc, serializeMarcXml };
+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.0.5",
+  "version": "0.1.1",
   "private": false,
   "type": "module",
   "description": "MARC record parser and serializer",