@domorium/validator 0.1.0

package/dist/parser/index.d.ts

@@ -0,0 +1,2 @@
+export type { ASTNode, ASTToken } from "./visitor";
+export { resolveValue } from "./visitor";

package/dist/parser/lexer.d.ts

@@ -0,0 +1,30 @@
+import { Lexer, ILexingResult, ILexerConfig } from "chevrotain";
+import { IMultiModeLexerDefinition } from "@chevrotain/types";
+export declare enum TokenNames {
+    LEVEL = "LEVEL",
+    POINTER = "POINTER",
+    TAG = "TAG",
+    XREF = "XREF",
+    VALUE = "VALUE"
+}
+export declare const Level: import("chevrotain").TokenType;
+export declare const Pointer: import("chevrotain").TokenType;
+export declare const Tag: import("chevrotain").TokenType;
+export declare const Xref: import("chevrotain").TokenType;
+export declare const Value: import("chevrotain").TokenType;
+export declare const gedcomLexerDefinition: IMultiModeLexerDefinition;
+export declare const tokens: {
+    Level: import("chevrotain").TokenType;
+    Pointer: import("chevrotain").TokenType;
+    Tag: import("chevrotain").TokenType;
+    Xref: import("chevrotain").TokenType;
+    Value: import("chevrotain").TokenType;
+};
+export interface ConfigurableLexerOptions extends ILexerConfig {
+    zeroBased?: boolean;
+}
+export declare class ConfigurableLexer extends Lexer {
+    private readonly zeroBased;
+    constructor(config?: ConfigurableLexerOptions);
+    tokenize(text: string, initialMode?: string): ILexingResult;
+}

package/dist/parser/parser.d.ts

@@ -0,0 +1,7 @@
+import { CstNode, CstParser, ParserMethod } from "chevrotain";
+import { TokenVocabulary } from "@chevrotain/types";
+export declare class GedcomParser extends CstParser {
+    root: ParserMethod<[], CstNode>;
+    line: ParserMethod<[], CstNode>;
+    constructor(lexerDefinition: TokenVocabulary);
+}

package/dist/parser/visitor.d.ts

@@ -0,0 +1,43 @@
+import { CstNode } from "chevrotain";
+import { CstElement } from "@chevrotain/types";
+import { TokenNames } from "./lexer";
+declare const BaseGedcomVisitor: new (...args: any[]) => import("chevrotain").ICstVisitor<any, any>;
+interface Position {
+    line: number;
+    character: number;
+}
+export interface Range {
+    start: Position;
+    end: Position;
+}
+export interface ASTToken {
+    name: TokenNames;
+    range: Range;
+    value: string;
+}
+export interface ASTNode {
+    range: Range;
+    tokens: Partial<Record<TokenNames, ASTToken>>;
+    parent?: ASTNode;
+    children: ASTNode[];
+    level: number;
+}
+export interface VisitorResult {
+    nodes: ASTNode[];
+    pointers: Map<string, ASTNode[]>;
+    xrefs: Map<string, ASTToken[]>;
+}
+/**
+ * Resolves a node's logical value by following CONT (new line) and CONC
+ * (concatenation) continuation children in document order, per the GEDCOM
+ * line-continuation rules.
+ */
+export declare function resolveValue(node: ASTNode): string;
+export declare class GedcomVisitor extends BaseGedcomVisitor {
+    constructor();
+    root(ctx: CstNode | undefined): VisitorResult;
+    line({ children }: CstNode): ASTNode;
+    getTokens(elements?: CstElement[]): ASTToken[];
+    buildHierarchy(nodes: ASTNode[]): VisitorResult;
+}
+export {};

package/dist/schemes/schema-types.d.ts

@@ -0,0 +1,41 @@
+import { Brand } from "ts-brand";
+export type GedcomTag = Brand<string, "GedcomTag">;
+export declare const GedcomTag: import("ts-brand").Brander<GedcomTag>;
+export type GedcomType = Brand<string, "GedcomType">;
+export declare const GedcomType: import("ts-brand").Brander<GedcomType>;
+export interface GedcomScheme {
+    calendar: Record<GedcomTag, Calendar>;
+    label: Record<GedcomType, Label>;
+    payload: Record<GedcomType, Payload>;
+    set: Record<GedcomType, Set>;
+    substructure: Record<GedcomType, Substructure>;
+    tag: Record<GedcomType, GedcomTag>;
+    tagInContext: TagInContext;
+}
+export interface Calendar {
+    epochs: string[];
+    months: Months;
+    type: GedcomType;
+}
+export type Months = Record<GedcomTag, GedcomType>;
+export type Label = Record<"en-US", string>;
+export interface Payload {
+    to?: GedcomType;
+    set?: GedcomType;
+    type: null | "Y|<NULL>" | string;
+}
+export type Set = Record<string, GedcomType>;
+export type Substructure = Record<GedcomTag, {
+    cardinality: string;
+    type: GedcomType;
+}>;
+export interface TagInContext {
+    cal: Cal;
+    enum: Enum;
+    month: Month;
+    struct: Struct;
+}
+export type Cal = Record<GedcomType, GedcomTag>;
+export type Enum = Record<GedcomType, Record<GedcomType, GedcomTag>>;
+export type Month = Record<GedcomType, Record<GedcomType, GedcomTag>>;
+export type Struct = Record<GedcomType, Record<GedcomType, GedcomTag>>;

package/dist/types/errors.d.ts

@@ -0,0 +1,8 @@
+import { Range } from "./position";
+export interface GedcomError {
+    code: string;
+    message: string;
+    hint?: string;
+    range: Range;
+    level: "error" | "warning" | "info";
+}

package/dist/types/position.d.ts

@@ -0,0 +1,8 @@
+export interface Position {
+    line: number;
+    character: number;
+}
+export interface Range {
+    start: Position;
+    end: Position;
+}

package/dist/validator/getGedcomVersion.d.ts

@@ -0,0 +1,2 @@
+import { ASTNode } from "../parser";
+export declare function getGedcomVersion(nodes: ASTNode[]): string | undefined;

package/dist/validator/index.d.ts

@@ -0,0 +1 @@
+export { GedcomValidator } from "./validate";

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

@@ -0,0 +1,26 @@
+import { GedcomScheme, GedcomType } from "../schemes/schema-types";
+import { ASTNode } from "../parser";
+import { GedcomError } from "../types/errors";
+type FieldType = "boolean" | "string" | "nonNegativeInteger" | "select" | "multiselect" | "date" | "date-period" | "date-exact" | "time" | "pointer" | "age" | "personal-name" | "media-type" | "language-tag" | null;
+export declare class RuleNode {
+    private readonly scheme;
+    pointers: ASTNode[];
+    constructor(scheme: GedcomScheme, pointers: Map<string, ASTNode[]>);
+    getFieldType(tagType: GedcomType): {
+        type: FieldType;
+        isList: boolean;
+        to: GedcomType | undefined;
+    };
+    getAvailableValues(tagType: GedcomType): string[] | null;
+    /**
+     * CONT/CONC are universal line-continuation tags: they are deliberately
+     * left out of `substructure` (see validate.ts, which skips them before
+     * doing any substructure lookup), so they never appear on the walk done
+     * by getNodeType below. Resolve their type directly from the flat
+     * type->tag table instead.
+     */
+    private getUniversalType;
+    getNodeType(node: ASTNode): GedcomType;
+    validate(node: ASTNode, _tagType?: GedcomType): GedcomError[];
+}
+export {};

package/dist/validator/validate.d.ts

@@ -0,0 +1,9 @@
+import { GedcomType, GedcomScheme } from "../schemes/schema-types";
+import { ASTNode } from "../parser";
+import { GedcomError } from "../types/errors";
+export declare class GedcomValidator {
+    private readonly pointers;
+    constructor(pointers?: Map<string, ASTNode[]>);
+    setScheme(nodes: ASTNode[]): GedcomScheme;
+    validate(nodes: ASTNode[], parentType?: GedcomType, _scheme?: GedcomScheme): GedcomError[];
+}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@domorium/validator",
+  "version": "0.1.0",
+  "description": "GEDCOM 5.5.1 and 7.0 parser and validator",
+  "keywords": [
+    "gedcom",
+    "genealogy",
+    "parser",
+    "validator"
+  ],
+  "homepage": "https://github.com/lavich/domorium#readme",
+  "bugs": {
+    "url": "https://github.com/lavich/domorium/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lavich/domorium.git",
+    "directory": "packages/validator"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Andrey Lobanov",
+    "email": "lobanov.andrey.lavich@gmail.com",
+    "url": "https://github.com/lavich"
+  },
+  "sideEffects": false,
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs.js",
+      "import": "./dist/index.esm.js"
+    }
+  },
+  "files": [
+    "dist",
+    "package.json",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "build": "vite build && tsc --emitDeclarationOnly --declaration --outDir dist",
+    "watch": "vite build --watch",
+    "generate": "tsx scripts/generate-schema.ts",
+    "test": "vitest",
+    "prepack": "npm run build"
+  },
+  "dependencies": {
+    "chevrotain": "^11.0.3",
+    "ts-brand": "^0.2.0"
+  },
+  "devDependencies": {
+    "tsx": "^4.23.1"
+  }
+}