@biblioteksentralen/marc 0.1.2 → 0.3.0

package/README.md

@@ -100,3 +100,8 @@ const ajv = new Ajv();
 const validate = ajv.compile(schema);
 const result = validate(record.toJSON());
 ```
+
+## Changelog
+
+- 0.3.0: Upgrade to Zod 4
+- 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 {
@@ -281,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,
@@ -310,17 +316,14 @@ var MarcRecord = class _MarcRecord {
   toLineMarc() {
     return serializeLineMarc(this);
   }
-  static validateJSON(data, log) {
+  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);

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,12 +80,12 @@ declare class MarcRecord {
         fields: MarcField[];
         format?: string;
     });
-    static fromJSON(data: unknown, log: Logger): MarcRecord;
+    static fromJSON(data: unknown): MarcRecord;
     toJSON(): SerializedMarcRecord;
     toXML(pretty?: boolean): string;
     toXmlElement(): XmlElement;
     toLineMarc(): string;
-    static validateJSON(data: unknown, log: Logger): SerializedMarcRecord;
+    static validateJSON(data: unknown): SerializedMarcRecord;
     getControlFields(): ControlField[];
     getControlField(tag: string): ControlField | undefined;
     getDataFields(tag?: string | RegExp, indicators?: Indicators): DataField[];
@@ -134,77 +139,19 @@ declare function parseMarcXml(input: string | XmlElement, options?: MarcXmlOptio
 declare const marcRecordZodSchema: z.ZodObject<{
     format: z.ZodOptional<z.ZodString>;
     leader: z.ZodString;
-    fields: z.ZodArray<z.ZodUnion<[z.ZodObject<{
+    fields: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
         tag: z.ZodString;
         value: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        tag: string;
-        value: string;
-    }, {
-        tag: string;
-        value: string;
-    }>, z.ZodObject<{
+    }, z.core.$strip>, z.ZodObject<{
         tag: z.ZodString;
         ind1: z.ZodOptional<z.ZodString>;
         ind2: z.ZodOptional<z.ZodString>;
         subfields: z.ZodArray<z.ZodObject<{
             code: z.ZodString;
             value: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            value: string;
-            code: string;
-        }, {
-            value: string;
-            code: string;
-        }>, "many">;
-    }, "strip", z.ZodTypeAny, {
-        tag: string;
-        subfields: {
-            value: string;
-            code: string;
-        }[];
-        ind1?: string | undefined;
-        ind2?: string | undefined;
-    }, {
-        tag: string;
-        subfields: {
-            value: string;
-            code: string;
-        }[];
-        ind1?: string | undefined;
-        ind2?: string | undefined;
-    }>]>, "many">;
-}, "strip", z.ZodTypeAny, {
-    fields: ({
-        tag: string;
-        value: string;
-    } | {
-        tag: string;
-        subfields: {
-            value: string;
-            code: string;
-        }[];
-        ind1?: string | undefined;
-        ind2?: string | undefined;
-    })[];
-    leader: string;
-    format?: string | undefined;
-}, {
-    fields: ({
-        tag: string;
-        value: string;
-    } | {
-        tag: string;
-        subfields: {
-            value: string;
-            code: string;
-        }[];
-        ind1?: string | undefined;
-        ind2?: string | undefined;
-    })[];
-    leader: string;
-    format?: string | undefined;
-}>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>]>>;
+}, z.core.$strip>;
 
 declare function serializeLineMarc(input: MarcRecord): string;
 
@@ -213,7 +160,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,12 +80,12 @@ declare class MarcRecord {
         fields: MarcField[];
         format?: string;
     });
-    static fromJSON(data: unknown, log: Logger): MarcRecord;
+    static fromJSON(data: unknown): MarcRecord;
     toJSON(): SerializedMarcRecord;
     toXML(pretty?: boolean): string;
     toXmlElement(): XmlElement;
     toLineMarc(): string;
-    static validateJSON(data: unknown, log: Logger): SerializedMarcRecord;
+    static validateJSON(data: unknown): SerializedMarcRecord;
     getControlFields(): ControlField[];
     getControlField(tag: string): ControlField | undefined;
     getDataFields(tag?: string | RegExp, indicators?: Indicators): DataField[];
@@ -134,77 +139,19 @@ declare function parseMarcXml(input: string | XmlElement, options?: MarcXmlOptio
 declare const marcRecordZodSchema: z.ZodObject<{
     format: z.ZodOptional<z.ZodString>;
     leader: z.ZodString;
-    fields: z.ZodArray<z.ZodUnion<[z.ZodObject<{
+    fields: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
         tag: z.ZodString;
         value: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        tag: string;
-        value: string;
-    }, {
-        tag: string;
-        value: string;
-    }>, z.ZodObject<{
+    }, z.core.$strip>, z.ZodObject<{
         tag: z.ZodString;
         ind1: z.ZodOptional<z.ZodString>;
         ind2: z.ZodOptional<z.ZodString>;
         subfields: z.ZodArray<z.ZodObject<{
             code: z.ZodString;
             value: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            value: string;
-            code: string;
-        }, {
-            value: string;
-            code: string;
-        }>, "many">;
-    }, "strip", z.ZodTypeAny, {
-        tag: string;
-        subfields: {
-            value: string;
-            code: string;
-        }[];
-        ind1?: string | undefined;
-        ind2?: string | undefined;
-    }, {
-        tag: string;
-        subfields: {
-            value: string;
-            code: string;
-        }[];
-        ind1?: string | undefined;
-        ind2?: string | undefined;
-    }>]>, "many">;
-}, "strip", z.ZodTypeAny, {
-    fields: ({
-        tag: string;
-        value: string;
-    } | {
-        tag: string;
-        subfields: {
-            value: string;
-            code: string;
-        }[];
-        ind1?: string | undefined;
-        ind2?: string | undefined;
-    })[];
-    leader: string;
-    format?: string | undefined;
-}, {
-    fields: ({
-        tag: string;
-        value: string;
-    } | {
-        tag: string;
-        subfields: {
-            value: string;
-            code: string;
-        }[];
-        ind1?: string | undefined;
-        ind2?: string | undefined;
-    })[];
-    leader: string;
-    format?: string | undefined;
-}>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>]>>;
+}, z.core.$strip>;
 
 declare function serializeLineMarc(input: MarcRecord): string;
 
@@ -213,7 +160,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

@@ -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 {
@@ -279,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,
@@ -308,17 +314,14 @@ var MarcRecord = class _MarcRecord {
   toLineMarc() {
     return serializeLineMarc(this);
   }
-  static validateJSON(data, log) {
+  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);

package/package.json

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