@domorium/validator 1.8.2 → 2.0.0

package/dist/validator/calendarDays.d.ts

@@ -2,10 +2,14 @@
  * The part of a date the grammar cannot express: `31 FEB` is two well-formed
  * tokens naming a day February does not have.
  *
- * GREGORIAN and JULIAN share the twelve month tags and their lengths, and
- * differ only in which years February gets a 29th, which is why one table
- * serves both. HEBREW and FRENCH_R have months of their own.
+ * Which calendars there are and which months each takes is the schema's, read
+ * through calendars.ts. What is here is the arithmetic the specification never
+ * states: how long a month is, and which years February gets a 29th in.
+ * GREGORIAN and JULIAN share the twelve month tags and their lengths and differ
+ * only in that rule, which is why one table serves both.
  */
+import { GedcomScheme } from "../schemes/schema-types";
+export declare const LENGTHS: Record<string, number>;
 export interface ImpossibleDay {
     day: number;
     month: string;
@@ -14,4 +18,4 @@ 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(value: string): ImpossibleDay[];
+export declare function impossibleDays(scheme: GedcomScheme, value: string): ImpossibleDay[];

package/dist/validator/calendars.d.ts

@@ -0,0 +1,38 @@
+/**
+ * The one reader of the schema's `calendar` table, for everything that has to
+ * know which calendars there are, which months each takes and which epoch may
+ * close a year: the 5.5.1 date rules, the GEDCOM 7 date grammar, the day-length
+ * check and date completion.
+ *
+ * Month lengths are not here and not in the schema. The specification gives
+ * `day = Integer` and says no more, so a length is arithmetic rather than
+ * vocabulary; calendarDays.ts holds it, and a test binds its table to this one.
+ */
+import { GedcomScheme, GedcomTag } from "../schemes/schema-types";
+/** An absent calendar means GREGORIAN, in both dialects. */
+export declare const DEFAULT_CALENDAR: GedcomTag;
+export interface Vocabulary {
+    /** Permitted months, or null where the schema describes no such calendar. */
+    months: Set<string> | null;
+    epochs: Set<string> | null;
+}
+export declare function vocabularyOf(scheme: GedcomScheme, calendar: GedcomTag): Vocabulary;
+/**
+ * An extension tag that is not an alias is accepted in any of the three slots a
+ * calendar constrains: an extension calendar defines its own months and epochs,
+ * and rejecting an undeclared one here would report files this validator cannot
+ * prove wrong. An alias resolves to the standard tag it abbreviates and is held
+ * to the calendar's own vocabulary like any other standard tag.
+ */
+export declare function permits(vocabulary: Set<string> | null, token: string): boolean;
+/** How 5.5.1 writes a calendar, which is the form completion has to offer. */
+export declare function calendarEscape(calendar: string): string;
+/** The calendar a token names, in either dialect's form, or null. */
+export declare function calendarNamed(scheme: GedcomScheme, token: string): GedcomTag | null;
+/** The leading calendar escape 5.5.1 puts in front of a date, and the rest. */
+export declare function stripCalendarEscape(value: string): {
+    calendar: GedcomTag | null;
+    rest: string;
+};
+/** The tokens of a date, with an escape kept whole however it is spaced. */
+export declare function dateTokens(value: string): string[];

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

@@ -3,6 +3,7 @@ import { ASTNode } from "../parser";
 import { GedcomError } from "../types/errors";
 import { ExtensionContext } from "./extensions";
 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 {
     private readonly scheme;
     private readonly pointerMap;
@@ -27,5 +28,6 @@ export declare class RuleNode {
     private getUniversalType;
     getNodeType(node: ASTNode): GedcomType;
     validate(node: ASTNode, _tagType?: GedcomType): GedcomError[];
+    collect(errors: GedcomError[], node: ASTNode, _tagType?: GedcomType): void;
 }
 export {};

package/dist/validator/validate.d.ts

@@ -2,6 +2,10 @@ import { GedcomType, GedcomScheme } from "../schemes/schema-types";
 import { ASTNode } from "../parser";
 import { GedcomError } from "../types/errors";
 import { ExtensionContext } from "./extensions";
+export declare function parseCardinality(str: string): {
+    min: number;
+    max: number;
+} | null;
 export declare function schemeFor(nodes: ASTNode[]): GedcomScheme;
 export declare class GedcomValidator {
     private readonly pointers;
@@ -12,7 +16,8 @@ export declare class GedcomValidator {
     /** A fragment is not a document, so nothing is required of its root. */
     fragment?: boolean);
     setScheme(nodes: ASTNode[]): GedcomScheme;
-    validate(nodes: ASTNode[], parentType?: GedcomType, _scheme?: GedcomScheme, 
+    validate(nodes: ASTNode[], parentType?: GedcomType, _scheme?: GedcomScheme, parent?: ASTNode): GedcomError[];
+    collect(errors: GedcomError[], nodes: ASTNode[], parentType: GedcomType, scheme: GedcomScheme, 
     /** Absent at the root, where the start of the document is the honest place. */
-    parent?: ASTNode): GedcomError[];
+    parent?: ASTNode): void;
 }

package/package.json

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