@domorium/validator 2.2.0 → 2.3.0

package/dist/payload/escape.d.ts

@@ -0,0 +1,4 @@
+import type { PayloadKind } from "../types/structure";
+import type { GedcomDialect } from "../validator/versionRegistry";
+export declare function escapePayload(value: string, dialect: GedcomDialect, kind: PayloadKind["kind"]): string;
+export declare function unescapePayload(value: string, dialect: GedcomDialect, kind: PayloadKind["kind"]): string;

package/dist/payload/fileExtensions.d.ts

@@ -0,0 +1,2 @@
+/** The extensions of the files a genealogy program attaches to a medium. */
+export declare const KNOWN_FILE_EXTENSIONS: ReadonlySet<string>;

package/dist/payload/filePath.d.ts

@@ -0,0 +1,6 @@
+export type FilePathProblem = "absolute" | "parent-folder" | "unescaped-character";
+/**
+ * Why a GEDCOM 7 local file reference, a relative URI reference with no
+ * scheme, names no file beside the document, or nothing where it does.
+ */
+export declare function filePathProblem(path: string): FilePathProblem | undefined;

package/dist/types/errors.d.ts

@@ -1,3 +1,4 @@
+import type { FilePathProblem } from "../payload/filePath";
 import { Range } from "./position";
 /**
  * Every code this package emits. A consumer filters, suppresses or offers a
@@ -39,6 +40,29 @@ export declare enum GedcomErrorCode {
      * silent and held to it, as its calendars are the same ones.
      */
     ImpossibleYear = "VAL016",
+    /**
+     * A line break in a value whose datatype keeps to one line. Answered for a
+     * value about to be written; a file that already has one is not reported.
+     */
+    SpansLines = "VAL017",
+    /**
+     * A value for a structure the standard gives no payload descriptor. Answered
+     * for a value about to be written; a file that already has one is not reported.
+     */
+    ValueNotAllowed = "VAL018",
+    /**
+     * A GEDCOM 7 record an empty value would leave with neither a payload nor a
+     * substructure, which 7.0 forbids of every structure. Answered for a value
+     * about to be written only.
+     */
+    EmptyStructure = "VAL019",
+    /**
+     * A GEDCOM 7 local file path that names no file beside the document. Answered
+     * for a value about to be written; a file that already has one is not reported.
+     */
+    FileTargetUnsupported = "VAL020",
+    /** A 5.5.1 multimedia format outside the standard's list that is a known file extension. */
+    ToleratedForm = "VAL021",
     /** A pointer whose xref names no record of the required type. */
     UnresolvedXref = "unresolved-xref",
     /** A line whose level cannot follow the line above it. */
@@ -56,6 +80,20 @@ export interface GedcomError {
         xref?: string;
         requiredRecordTag?: string;
         expectedLevel?: number;
+        missingTag?: string;
+        /** Absent where the missing structure belongs at the root. */
+        parentTag?: string;
+        /** The document has no `HEAD` record at all, as against one without a version. */
+        missingHeader?: boolean;
+        day?: number;
+        month?: string;
+        monthLength?: number;
+        year?: number;
+        calendar?: string;
+        /** Set only where the tag is a standard one written in the wrong case. */
+        meantTag?: string;
+        tag?: string;
+        pathProblem?: FilePathProblem;
     };
     range: Range;
     level: "error" | "warning" | "info";

package/dist/types/structure.d.ts

@@ -0,0 +1,37 @@
+import type { GedcomError } from "./errors";
+export type PayloadKind = {
+    kind: "text" | "integer" | "boolean" | "date" | "date-period" | "date-exact" | "time" | "age" | "language-tag" | "media-type" | "latitude" | "longitude" | "personal-name" | "tag-definition" | "none";
+} | {
+    kind: "enum";
+    values: string[];
+    multiple: boolean;
+    /** Set where a value outside `values` that is a known file extension is a warning, not an error. */
+    tolerates?: "file-extension";
+} | {
+    kind: "pointer" | "text-or-pointer";
+    to: string;
+};
+export interface StructureField {
+    tag: string;
+    schemaId: string;
+    min: number;
+    max: number | null;
+    payload: PayloadKind;
+    payloadRequired: boolean;
+    lineBreaks: boolean;
+    prose: boolean;
+}
+export interface StructureShape {
+    schemaId: string;
+    payload: PayloadKind;
+    payloadRequired: boolean;
+    lineBreaks: boolean;
+    prose: boolean;
+    fields: StructureField[];
+}
+export interface PayloadProblem {
+    code: string;
+    message: string;
+    data?: GedcomError["data"];
+    level: "error" | "warning" | "info";
+}

package/dist/validator/calendarDays.d.ts

@@ -13,6 +13,7 @@
  */
 import { GedcomScheme } from "../schemes/schema-types";
 import type { GedcomDate } from "../types/date";
+import { ExtensionContext } from "./extensions";
 export declare const LENGTHS: Record<string, number>;
 export interface ImpossibleYear {
     year: number;
@@ -26,7 +27,7 @@ export interface ImpossibleDay {
 }
 export declare function isLeapYear(year: number, calendar: string): boolean;
 export declare function daysInMonth(month: string, year: number | null, calendar: string): number | null;
-export declare function impossibleDays(scheme: GedcomScheme, value: string): ImpossibleDay[];
+export declare function impossibleDays(scheme: GedcomScheme, value: string, extensions?: ExtensionContext): ImpossibleDay[];
 /**
  * Judged on what a grammar read rather than on tokens: only the grammar knows
  * that `0BC` is a year and an epoch, or that `_CAL 0` is not Gregorian.

package/dist/validator/checkPayload.d.ts

@@ -0,0 +1,5 @@
+import type { ASTNode } from "../parser";
+import type { GedcomScheme, GedcomType } from "../schemes/schema-types";
+import type { PayloadProblem } from "../types/structure";
+import type { ExtensionContext } from "./extensions";
+export declare function checkPayload(scheme: GedcomScheme, pointers: Map<string, ASTNode[]>, extensions: ExtensionContext, parentType: GedcomType, tag: string, value: string, occurrences: number, replacing?: ASTNode): PayloadProblem[];

package/dist/validator/lineBreaks.d.ts

@@ -0,0 +1,5 @@
+import type { GedcomScheme, GedcomType } from "../schemes/schema-types";
+export declare function lineBreaksOf(scheme: GedcomScheme, type: GedcomType): {
+    lineBreaks: boolean;
+    prose: boolean;
+};

package/dist/validator/rule-node.d.ts

@@ -2,6 +2,7 @@ import { GedcomScheme, GedcomType } from "../schemes/schema-types";
 import { ASTNode } from "../parser";
 import { GedcomError } from "../types/errors";
 import { ExtensionContext } from "./extensions";
+import type { PayloadKind } from "../types/structure";
 type FieldType = "boolean" | "string" | "nonNegativeInteger" | "select" | "multiselect" | "date" | "date-v7" | "date-period" | "date-period-v7" | "date-exact" | "date-exact-v7" | "time" | "time-v7" | "pointer" | "age" | "age-v7" | "personal-name" | "latitude" | "longitude" | "media-type" | "language-tag" | "tag-def" | null;
 export declare const PAYLOAD_FIELD_TYPES: Record<string, Exclude<FieldType, null>>;
 export declare class RuleNode {
@@ -15,6 +16,10 @@ export declare class RuleNode {
         type: FieldType;
         to: GedcomType | undefined;
     };
+    payloadShape(tagType: GedcomType): {
+        payload: PayloadKind;
+        required: boolean;
+    };
     private mayOmitPayload;
     private validateEnumeration;
     getAvailableValues(tagType: GedcomType): string[] | null;

package/dist/validator/structureShape.d.ts

@@ -0,0 +1,6 @@
+import type { GedcomScheme } from "../schemes/schema-types";
+import { GedcomType } from "../schemes/schema-types";
+import type { StructureShape } from "../types/structure";
+import type { RuleNode } from "./rule-node";
+export declare function typeAtPath(scheme: GedcomScheme, path: readonly string[]): GedcomType | undefined;
+export declare function structureShape(scheme: GedcomScheme, ruleNode: RuleNode, type: GedcomType): StructureShape | undefined;

package/dist/validator/validate.d.ts

@@ -1,11 +1,21 @@
-import { GedcomType, GedcomScheme } from "../schemes/schema-types";
+import { GedcomTag, GedcomType, Payload, GedcomScheme } from "../schemes/schema-types";
 import { ASTNode } from "../parser";
 import { GedcomError } from "../types/errors";
+import type { Range } from "../types/position";
 import { ExtensionContext } from "./extensions";
 export declare function parseCardinality(str: string): {
     min: number;
     max: number;
 } | null;
+export interface Rule {
+    min: number;
+    max: number;
+    type: GedcomType;
+    payload: Payload;
+}
+export declare function getRules(scheme: GedcomScheme, parentType: GedcomType): Map<GedcomTag, Rule> | undefined;
+export declare function unknownTagError(rules: Map<GedcomTag, Rule>, tag: GedcomTag, parentTag: string | undefined, range: Range): GedcomError;
+export declare function tooManyError(tag: GedcomTag, parentTag: string | undefined, range: Range): GedcomError;
 export declare function schemeFor(nodes: ASTNode[]): GedcomScheme;
 export declare class GedcomValidator {
     private readonly pointers;

package/dist/validator/versionRegistry.d.ts

@@ -29,6 +29,7 @@ export type VersionResolution = ({
 } | ({
     kind: "undetermined";
     range: Range;
+    missingHeader: boolean;
 } & SchemaChoice);
 /** The schema a caller names outright, for text that carries no header. */
 export declare function schemaForDialect(dialect: GedcomDialect): SchemaChoice;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@domorium/validator",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "GEDCOM 5.5.1 and 7.0 parser and validator",
   "keywords": [
     "gedcom",