schemata-validator 0.1.0

package/dist/cli.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Runs the validator via the CLI.
+ */
+export declare const cli: () => Promise<void>;

package/dist/cli.js

@@ -0,0 +1,24 @@
+import process from "node:process";
+import { SchemataValidator } from "./schemata-validator.js";
+import { parseArgs } from "./utils/parse-args.js";
+import { showHelp } from "./utils/show-help.js";
+import { showVersion } from "./utils/show-version.js";
+/**
+ * Runs the validator via the CLI.
+ */
+export const cli = async () => {
+    const { argv } = process;
+    const args = argv.slice(2);
+    if (args.includes("--help") || args.includes("-h")) {
+        showHelp();
+    }
+    else if (args.includes("--version") || args.includes("-v")) {
+        showVersion();
+    }
+    else {
+        const validator = new SchemataValidator(parseArgs(args));
+        const reporting = await validator.validate();
+        validator.log(reporting);
+    }
+};
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,cAAc,CAAC;AAEnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD;;GAEG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,KAAK,IAAmB,EAAE;IAC3C,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IACzB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3B,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACnD,QAAQ,EAAE,CAAC;IACb,CAAC;SAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7D,WAAW,EAAE,CAAC;IAChB,CAAC;SAAM,CAAC;QACN,MAAM,SAAS,GAAG,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QACzD,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;QAC7C,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC,CAAC"}

package/dist/constants.d.ts

@@ -0,0 +1,46 @@
+export declare const TAB: string;
+export declare const WORKSPACE_NAME = "schemata-validator";
+export declare const AVAILABLE_CLI_FLAGS: {
+    readonly files: {
+        readonly cliFlagName: "files";
+        readonly flag: "--files";
+        readonly alias: "-f";
+        readonly description: "Files to validate";
+        readonly type: "array";
+    };
+    readonly paths: {
+        readonly cliFlagName: "paths";
+        readonly flag: "--paths";
+        readonly alias: "-p";
+        readonly description: "Folders to include for validation";
+        readonly type: "array";
+    };
+    readonly exclude: {
+        readonly cliFlagName: "exclude";
+        readonly flag: "--exclude";
+        readonly alias: "-e";
+        readonly description: "Paths to skip";
+        readonly type: "array";
+    };
+    readonly dryRun: {
+        readonly cliFlagName: "dryRun";
+        readonly flag: "--dry-run";
+        readonly alias: "-d";
+        readonly description: "Bypass validation";
+        readonly type: "boolean";
+    };
+    readonly version: {
+        readonly cliFlagName: "version";
+        readonly flag: "--version";
+        readonly alias: "-v";
+        readonly description: "Show version number";
+        readonly type: "boolean";
+    };
+    readonly help: {
+        readonly cliFlagName: "help";
+        readonly flag: "--help";
+        readonly alias: "-h";
+        readonly description: "Show help";
+        readonly type: "boolean";
+    };
+};

package/dist/constants.js

@@ -0,0 +1,47 @@
+export const TAB = " ".repeat(2);
+export const WORKSPACE_NAME = "schemata-validator";
+export const AVAILABLE_CLI_FLAGS = {
+    files: {
+        cliFlagName: "files",
+        flag: "--files",
+        alias: "-f",
+        description: "Files to validate",
+        type: "array"
+    },
+    paths: {
+        cliFlagName: "paths",
+        flag: "--paths",
+        alias: "-p",
+        description: "Folders to include for validation",
+        type: "array"
+    },
+    exclude: {
+        cliFlagName: "exclude",
+        flag: "--exclude",
+        alias: "-e",
+        description: "Paths to skip",
+        type: "array"
+    },
+    dryRun: {
+        cliFlagName: "dryRun",
+        flag: "--dry-run",
+        alias: "-d",
+        description: "Bypass validation",
+        type: "boolean"
+    },
+    version: {
+        cliFlagName: "version",
+        flag: "--version",
+        alias: "-v",
+        description: "Show version number",
+        type: "boolean"
+    },
+    help: {
+        cliFlagName: "help",
+        flag: "--help",
+        alias: "-h",
+        description: "Show help",
+        type: "boolean"
+    }
+};
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACjC,MAAM,CAAC,MAAM,cAAc,GAAG,oBAAoB,CAAC;AACnD,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,KAAK,EAAE;QACL,WAAW,EAAE,OAAO;QACpB,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,mBAAmB;QAChC,IAAI,EAAE,OAAO;KACd;IACD,KAAK,EAAE;QACL,WAAW,EAAE,OAAO;QACpB,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,mCAAmC;QAChD,IAAI,EAAE,OAAO;KACd;IACD,OAAO,EAAE;QACP,WAAW,EAAE,SAAS;QACtB,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,eAAe;QAC5B,IAAI,EAAE,OAAO;KACd;IACD,MAAM,EAAE;QACN,WAAW,EAAE,QAAQ;QACrB,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,mBAAmB;QAChC,IAAI,EAAE,SAAS;KAChB;IACD,OAAO,EAAE;QACP,WAAW,EAAE,SAAS;QACtB,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,qBAAqB;QAClC,IAAI,EAAE,SAAS;KAChB;IACD,IAAI,EAAE;QACJ,WAAW,EAAE,MAAM;QACnB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,WAAW;QACxB,IAAI,EAAE,SAAS;KAChB;CACO,CAAC"}

package/dist/format-parsers/html-parser.d.ts

@@ -0,0 +1,15 @@
+import type { SchemaGraph } from "../types.js";
+export declare class HTMLParser {
+    private readonly html;
+    /**
+     * Constructs an instance of the HTMLParser class.
+     * @param html - The HTML document.
+     */
+    constructor(html: string);
+    /**
+     * Parses the HTML document.
+     *
+     * @return The intermediate representation tree of the Schema.org vocabulary used by the HTML document.
+     */
+    parse(): SchemaGraph;
+}

package/dist/format-parsers/html-parser.js

@@ -0,0 +1,32 @@
+import { JSONLDParser } from "./json-ld-parser.js";
+export class HTMLParser {
+    html;
+    /**
+     * Constructs an instance of the HTMLParser class.
+     * @param html - The HTML document.
+     */
+    constructor(html) {
+        this.html = html;
+    }
+    /**
+     * Parses the HTML document.
+     *
+     * @return The intermediate representation tree of the Schema.org vocabulary used by the HTML document.
+     */
+    parse() {
+        const roots = [];
+        const jsonLDDataSet = this.html
+            .replace(/<!-{2}.*?-{2}>/gms, "")
+            .matchAll(/<script\s+type=["']?application\/ld\+json["']?>(?<jsonld>.*?)<\/script>/gms);
+        for (const jsonLDData of jsonLDDataSet) {
+            const jsonLD = jsonLDData.groups?.jsonld ?? "";
+            const jsonLDParser = new JSONLDParser(jsonLD);
+            if (jsonLD)
+                roots.push(...jsonLDParser.parse().roots);
+        }
+        return {
+            roots
+        };
+    }
+}
+//# sourceMappingURL=html-parser.js.map

package/dist/format-parsers/html-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"html-parser.js","sourceRoot":"","sources":["../../src/format-parsers/html-parser.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,MAAM,OAAO,UAAU;IACJ,IAAI,CAAS;IAE9B;;;OAGG;IACH,YAAY,IAAY;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,MAAM,KAAK,GAAiB,EAAE,CAAC;QAC/B,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI;aAC5B,OAAO,CAAC,mBAAmB,EAAE,EAAE,CAAC;aAChC,QAAQ,CAAC,4EAA4E,CAAC,CAAC;QAC1F,KAAK,MAAM,UAAU,IAAI,aAAa,EAAE,CAAC;YACvC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,EAAE,MAAM,IAAI,EAAE,CAAC;YAC/C,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;YAC9C,IAAI,MAAM;gBAAE,KAAK,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;QACxD,CAAC;QACD,OAAO;YACL,KAAK;SACN,CAAC;IACJ,CAAC;CACF"}

package/dist/format-parsers/json-ld-parser.d.ts

@@ -0,0 +1,34 @@
+import type { JSONLDData, SchemaGraph, SchemaNode, SchemaValue } from "../types.js";
+export declare class JSONLDParser {
+    private readonly jsonLD;
+    /**
+     * Constructs an instance of the JSONLDParser class.
+     * @param jsonLD - The JSON-LD data
+     */
+    constructor(jsonLD: string);
+    /**
+     * Sets the schema value.
+     * @param value - The value from the JSON-LD to use as a value.
+     * @param index - The index of the value in its property array.
+     * @param parentPath - The JSON-LD path of the parent property.
+     * @return The schema value.
+     */
+    setSchemaValue: (value: unknown, index: number, parentPath: string) => SchemaValue;
+    /**
+     * Sets the schema node.
+     * @param node - The object from the JSON-LD to use as a node.
+     * @param index - The index of the node in its parent array.
+     * @param [parentPath] - The JSON-LD path of the parent property (the string is empty for root nodes).
+     * @return The schema node.
+     */
+    setSchemaNode: (node: JSONLDData, index: number, parentPath?: string) => SchemaNode;
+    /**
+     * Parses the JSON-LD data.
+     *
+     * Contexts other than Schema.org are skipped.
+     *
+     * Any commented parts of the JSON-LD are ignored.
+     * @return The intermediate representation tree of the Schema.org vocabulary used by the JSON-LD data.
+     */
+    parse(): SchemaGraph;
+}

package/dist/format-parsers/json-ld-parser.js

@@ -0,0 +1,96 @@
+export class JSONLDParser {
+    jsonLD;
+    /**
+     * Constructs an instance of the JSONLDParser class.
+     * @param jsonLD - The JSON-LD data
+     */
+    constructor(jsonLD) {
+        this.jsonLD = jsonLD;
+    }
+    /**
+     * Sets the schema value.
+     * @param value - The value from the JSON-LD to use as a value.
+     * @param index - The index of the value in its property array.
+     * @param parentPath - The JSON-LD path of the parent property.
+     * @return The schema value.
+     */
+    setSchemaValue = (value, index, parentPath) => {
+        const parentPathWithIndex = `${parentPath}[${index}]`;
+        if (typeof value === "object" && value !== null) {
+            if ("@value" in value) {
+                const nestedValue = value["@value"];
+                return {
+                    kind: "literal",
+                    location: {
+                        jsonLDPath: parentPathWithIndex
+                    },
+                    value: String(nestedValue)
+                };
+            }
+            return {
+                kind: "node",
+                linkLocation: {
+                    jsonLDPath: parentPathWithIndex
+                },
+                node: this.setSchemaNode(value, index, parentPath)
+            };
+        }
+        return {
+            kind: "literal",
+            location: {
+                jsonLDPath: parentPathWithIndex
+            },
+            value: String(value)
+        };
+    };
+    /**
+     * Sets the schema node.
+     * @param node - The object from the JSON-LD to use as a node.
+     * @param index - The index of the node in its parent array.
+     * @param [parentPath] - The JSON-LD path of the parent property (the string is empty for root nodes).
+     * @return The schema node.
+     */
+    setSchemaNode = (node, index, parentPath = "") => {
+        const nodePath = `${parentPath}[${index}]`;
+        const type = typeof node["@type"] === "string" ? node["@type"] : "Thing";
+        const id = typeof node["@id"] === "string" ? node["@id"] : undefined;
+        const schemaNode = id ? { type, id } : { type };
+        const properties = new Map();
+        for (const [key, rawValues] of Object.entries(node)) {
+            if (key.startsWith("@"))
+                continue;
+            const propertyPath = `${nodePath}.${key}`;
+            const values = (Array.isArray(rawValues) ? rawValues : [rawValues]).map((value, index) => this.setSchemaValue(value, index, propertyPath));
+            properties.set(key, values);
+        }
+        return {
+            ...schemaNode,
+            properties,
+            sourceFormat: "jsonld",
+            location: {
+                jsonLDPath: nodePath
+            }
+        };
+    };
+    /**
+     * Parses the JSON-LD data.
+     *
+     * Contexts other than Schema.org are skipped.
+     *
+     * Any commented parts of the JSON-LD are ignored.
+     * @return The intermediate representation tree of the Schema.org vocabulary used by the JSON-LD data.
+     */
+    parse() {
+        const parsedJSONLD = JSON.parse(this.jsonLD);
+        const nodes = (Array.isArray(parsedJSONLD) ? parsedJSONLD : [parsedJSONLD])
+            .filter(node => "@context" in node &&
+            typeof node["@context"] === "string" &&
+            node["@context"].match(/^ht{2}ps?:\/{2}schema\.org\/?$/))
+            .map(node => node);
+        const roots = nodes.flatMap((value, index) => this.setSchemaNode(value, index));
+        return {
+            roots
+        };
+    }
+}
+//# sourceMappingURL=json-ld-parser.js.map

package/dist/format-parsers/json-ld-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-ld-parser.js","sourceRoot":"","sources":["../../src/format-parsers/json-ld-parser.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,YAAY;IACN,MAAM,CAAS;IAEhC;;;OAGG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACH,cAAc,GAAG,CAAC,KAAc,EAAE,KAAa,EAAE,UAAkB,EAAe,EAAE;QAClF,MAAM,mBAAmB,GAAG,GAAG,UAAU,IAAI,KAAK,GAAG,CAAC;QACtD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YAChD,IAAI,QAAQ,IAAI,KAAK,EAAE,CAAC;gBACtB,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;gBACpC,OAAO;oBACL,IAAI,EAAE,SAAS;oBACf,QAAQ,EAAE;wBACR,UAAU,EAAE,mBAAmB;qBAChC;oBACD,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC;iBAC3B,CAAC;YACJ,CAAC;YACD,OAAO;gBACL,IAAI,EAAE,MAAM;gBACZ,YAAY,EAAE;oBACZ,UAAU,EAAE,mBAAmB;iBAChC;gBACD,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,KAAmB,EAAE,KAAK,EAAE,UAAU,CAAC;aACjE,CAAC;QACJ,CAAC;QACD,OAAO;YACL,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE;gBACR,UAAU,EAAE,mBAAmB;aAChC;YACD,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;SACrB,CAAC;IACJ,CAAC,CAAC;IAEF;;;;;;OAMG;IACH,aAAa,GAAG,CAAC,IAAgB,EAAE,KAAa,EAAE,UAAU,GAAG,EAAE,EAAc,EAAE;QAC/E,MAAM,QAAQ,GAAG,GAAG,UAAU,IAAI,KAAK,GAAG,CAAC;QAC3C,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QACzE,MAAM,EAAE,GAAG,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACrE,MAAM,UAAU,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;QAChD,MAAM,UAAU,GAAG,IAAI,GAAG,EAAE,CAAC;QAC7B,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACpD,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,SAAS;YAClC,MAAM,YAAY,GAAG,GAAG,QAAQ,IAAI,GAAG,EAAE,CAAC;YAC1C,MAAM,MAAM,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,SAAuB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CACpF,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,EAAE,YAAY,CAAC,CAClE,CAAC;YACF,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO;YACL,GAAG,UAAU;YACb,UAAU;YACV,YAAY,EAAE,QAAQ;YACtB,QAAQ,EAAE;gBACR,UAAU,EAAE,QAAQ;aACrB;SACF,CAAC;IACJ,CAAC,CAAC;IAEF;;;;;;;OAOG;IACH,KAAK;QACH,MAAM,YAAY,GAA8B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACxE,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;aACxE,MAAM,CACL,IAAI,CAAC,EAAE,CACL,UAAU,IAAI,IAAI;YAClB,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,QAAQ;YACpC,IAAI,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAC3D;aACA,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAkB,CAAC,CAAC;QACnC,MAAM,KAAK,GAAiB,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QAC9F,OAAO;YACL,KAAK;SACN,CAAC;IACJ,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { cli } from "./cli.js";
+export { SchemataValidator } from "./schemata-validator.js";

package/dist/index.js

@@ -0,0 +1,3 @@
+export { cli } from "./cli.js";
+export { SchemataValidator } from "./schemata-validator.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/schemata-validator.d.ts

@@ -0,0 +1,19 @@
+import type { SchemataValidatorOptions, ValidationReporting } from "./types.js";
+export declare class SchemataValidator {
+    private readonly options;
+    /**
+     * Constructs an instance of the SchemataValidator class.
+     * @param [options] - The options to use.
+     */
+    constructor(options?: SchemataValidatorOptions);
+    /**
+     * Validates the Schema.org vocabulary.
+     * @return The validation reporting if not on dry-run mode, `undefined` otherwise.
+     */
+    validate(): Promise<ValidationReporting[] | undefined>;
+    /**
+     * Logs the reporting in the console.
+     * @param reporting - The reporting to log.
+     */
+    log(reporting: ValidationReporting[] | undefined): void;
+}

package/dist/schemata-validator.js

@@ -0,0 +1,69 @@
+import { HTMLParser } from "./format-parsers/html-parser.js";
+import { JSONLDParser } from "./format-parsers/json-ld-parser.js";
+import { displayReporting } from "./utils/display-reporting.js";
+import { dryRunNotice } from "./utils/dry-run-notice.js";
+import { getFileContent } from "./utils/get-file-content.js";
+import { getFilesToValidate } from "./utils/get-files-to-validate.js";
+import { prepareReporting } from "./utils/prepare-reporting.js";
+import { SchemaGraphValidator } from "./validator/schema-graph-validator.js";
+export class SchemataValidator {
+    options = {};
+    /**
+     * Constructs an instance of the SchemataValidator class.
+     * @param [options] - The options to use.
+     */
+    constructor(options) {
+        this.options = options ?? {};
+    }
+    /**
+     * Validates the Schema.org vocabulary.
+     * @return The validation reporting if not on dry-run mode, `undefined` otherwise.
+     */
+    async validate() {
+        try {
+            const { dryRun } = this.options;
+            if (dryRun)
+                dryRunNotice();
+            else {
+                const { data } = this.options;
+                const contents = data?.map((datum, index) => ({
+                    type: "data",
+                    resource: `data[${index}]`,
+                    source: datum
+                })) ?? [];
+                if (!data) {
+                    const filesToValidate = await getFilesToValidate(this.options);
+                    for (const file of filesToValidate) {
+                        const content = getFileContent(file);
+                        if (content)
+                            contents.push({ type: "file", resource: file, source: content });
+                    }
+                }
+                const reporting = [];
+                for (const content of contents) {
+                    const { type, resource, source } = content;
+                    const contentSchemaGraph = type === "file" ? new HTMLParser(source).parse() : new JSONLDParser(source).parse();
+                    const schemaGraphValidator = new SchemaGraphValidator(contentSchemaGraph);
+                    const result = schemaGraphValidator.validate();
+                    reporting.push(prepareReporting(resource, result));
+                }
+                return reporting;
+            }
+        }
+        catch (error) {
+            console.error("\x1b[1;31m%s %s\x1b[0m", "Failed to validate the Schema.org vocabulary.", error instanceof Error ? error.message : String(error));
+        }
+    }
+    /**
+     * Logs the reporting in the console.
+     * @param reporting - The reporting to log.
+     */
+    log(reporting) {
+        if (reporting) {
+            for (const reportingItem of reporting) {
+                displayReporting(reportingItem, Date.now());
+            }
+        }
+    }
+}
+//# sourceMappingURL=schemata-validator.js.map

package/dist/schemata-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemata-validator.js","sourceRoot":"","sources":["../src/schemata-validator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAE7E,MAAM,OAAO,iBAAiB;IACX,OAAO,GAA6B,EAAE,CAAC;IAExD;;;OAGG;IACH,YAAY,OAAkC;QAC5C,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ;QACZ,IAAI,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,MAAM;gBAAE,YAAY,EAAE,CAAC;iBACtB,CAAC;gBACJ,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;gBAC9B,MAAM,QAAQ,GACZ,IAAI,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;oBAC3B,IAAI,EAAE,MAAM;oBACZ,QAAQ,EAAE,QAAQ,KAAK,GAAG;oBAC1B,MAAM,EAAE,KAAK;iBACd,CAAC,CAAC,IAAI,EAAE,CAAC;gBACZ,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,MAAM,eAAe,GAAG,MAAM,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC/D,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE,CAAC;wBACnC,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;wBACrC,IAAI,OAAO;4BAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;oBAChF,CAAC;gBACH,CAAC;gBACD,MAAM,SAAS,GAA0B,EAAE,CAAC;gBAC5C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;oBAC/B,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;oBAC3C,MAAM,kBAAkB,GACtB,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC;oBACtF,MAAM,oBAAoB,GAAG,IAAI,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;oBAC1E,MAAM,MAAM,GAAG,oBAAoB,CAAC,QAAQ,EAAE,CAAC;oBAC/C,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;gBACrD,CAAC;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CACX,wBAAwB,EACxB,+CAA+C,EAC/C,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CACvD,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,SAA4C;QAC9C,IAAI,SAAS,EAAE,CAAC;YACd,KAAK,MAAM,aAAa,IAAI,SAAS,EAAE,CAAC;gBACtC,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/dist/types.d.ts

@@ -0,0 +1,59 @@
+export type SchemataValidatorOptions = {
+    data?: string[];
+    files?: string[];
+    paths?: string[];
+    exclude?: string[];
+    dryRun?: boolean;
+};
+export type JSONLDData = Record<string, unknown>;
+type SourceLocation = {
+    jsonLDPath?: string;
+};
+type LiteralSchemaValue = {
+    kind: "literal";
+    location: SourceLocation;
+    value: string;
+};
+type NodeSchemaValue = {
+    kind: "node";
+    linkLocation: SourceLocation;
+    node: SchemaNode;
+};
+export type SchemaValue = LiteralSchemaValue | NodeSchemaValue;
+export type SchemaNode = {
+    type: string;
+    id?: string;
+    sourceFormat: "jsonld" | "microdata";
+    location: SourceLocation;
+    properties: Map<string, SchemaValue[]>;
+};
+export type SchemaGraph = {
+    roots: SchemaNode[];
+};
+export interface ClassDefinition {
+    isPending: boolean;
+    extends?: string[];
+    supersededBy?: string;
+}
+export interface PropertyDefinition extends ClassDefinition {
+    propertyOf?: string[];
+    type?: string[];
+}
+export type ValidationResult = {
+    type: "error" | "warning";
+    path: string;
+    message: string;
+};
+interface ValidationReportingCommonProperties {
+    resource: string;
+}
+interface ValidationReportingFail extends ValidationReportingCommonProperties {
+    status: "fail";
+    result: ValidationResult[];
+}
+interface ValidationReportingPass extends ValidationReportingCommonProperties {
+    status: "pass";
+    result?: ValidationResult[];
+}
+export type ValidationReporting = ValidationReportingFail | ValidationReportingPass;
+export {};

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/utils/browse-folders.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Browses the folders recursively from the given folder.
+ * @param folder - The folder from which to start the browsing.
+ * @return An array of all the directories found recursively, including the given folder.
+ */
+export declare const browseFolders: (folder: string) => Promise<string[]>;

package/dist/utils/browse-folders.js

@@ -0,0 +1,18 @@
+import fs from "node:fs/promises";
+import path from "node:path";
+/**
+ * Browses the folders recursively from the given folder.
+ * @param folder - The folder from which to start the browsing.
+ * @return An array of all the directories found recursively, including the given folder.
+ */
+export const browseFolders = async (folder) => {
+    const entries = (await fs.readdir(folder, { withFileTypes: true })).map(async (entry) => {
+        const pathToEntry = path.join(folder, entry.name);
+        if (entry.isDirectory())
+            return await browseFolders(pathToEntry);
+        return [];
+    });
+    const directories = await Promise.all(entries);
+    return [folder, ...directories.flat()];
+};
+//# sourceMappingURL=browse-folders.js.map

package/dist/utils/browse-folders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browse-folders.js","sourceRoot":"","sources":["../../src/utils/browse-folders.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAAE,MAAc,EAAqB,EAAE;IACvE,MAAM,OAAO,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAC,KAAK,EAAC,EAAE;QACpF,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,KAAK,CAAC,WAAW,EAAE;YAAE,OAAO,MAAM,aAAa,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;IACH,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC/C,OAAO,CAAC,MAAM,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;AACzC,CAAC,CAAC"}

package/dist/utils/display-cli-flags.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Displays the CLI flags when running the CLI with the `--help` or `-h` flags.
+ * @return The CLI flags, with their alias (if available), flag, description and type.
+ */
+export declare const displayCliFlags: () => string;

package/dist/utils/display-cli-flags.js

@@ -0,0 +1,24 @@
+import { AVAILABLE_CLI_FLAGS, TAB } from "../constants.js";
+/**
+ * Displays the CLI flags when running the CLI with the `--help` or `-h` flags.
+ * @return The CLI flags, with their alias (if available), flag, description and type.
+ */
+export const displayCliFlags = () => {
+    const availableCliFlagsValues = Object.values(AVAILABLE_CLI_FLAGS);
+    const aliasMaxLength = Math.max(...availableCliFlagsValues.map(cliFlag => "alias" in cliFlag && cliFlag.alias ? cliFlag.alias.length : 0));
+    const flagMaxLength = Math.max(...availableCliFlagsValues.map(option => option.flag.length));
+    const descriptionMaxLength = Math.max(...availableCliFlagsValues.map(cliOption => cliOption.description.length));
+    const typeMaxLength = Math.max(...availableCliFlagsValues.map(option => option.type.length)) + 2;
+    const header = "Options";
+    const cliOptions = [];
+    for (const cliFlag of availableCliFlagsValues) {
+        const alias = "alias" in cliFlag ? `${cliFlag.alias}, ` : " ".repeat(aliasMaxLength + 2);
+        const cliOptionName = `${TAB}${alias}${cliFlag.flag.padEnd(flagMaxLength, " ")}`;
+        const description = `${cliFlag.description.padEnd(descriptionMaxLength, " ")}`;
+        const type = `[${cliFlag.type}]`.padStart(typeMaxLength, " ");
+        const cliOptionElements = [cliOptionName, description, type];
+        cliOptions.push(cliOptionElements.join(TAB));
+    }
+    return `${header}\n${cliOptions.join("\n")}`;
+};
+//# sourceMappingURL=display-cli-flags.js.map

package/dist/utils/display-cli-flags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"display-cli-flags.js","sourceRoot":"","sources":["../../src/utils/display-cli-flags.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAE3D;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,GAAW,EAAE;IAC1C,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACnE,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAC7B,GAAG,uBAAuB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CACvC,OAAO,IAAI,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAC/D,CACF,CAAC;IACF,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,uBAAuB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7F,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,CACnC,GAAG,uBAAuB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAC1E,CAAC;IACF,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,uBAAuB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;IACjG,MAAM,MAAM,GAAG,SAAS,CAAC;IACzB,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,KAAK,MAAM,OAAO,IAAI,uBAAuB,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAG,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;QACzF,MAAM,aAAa,GAAG,GAAG,GAAG,GAAG,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,GAAG,CAAC,EAAE,CAAC;QACjF,MAAM,WAAW,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,oBAAoB,EAAE,GAAG,CAAC,EAAE,CAAC;QAC/E,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;QAC9D,MAAM,iBAAiB,GAAG,CAAC,aAAa,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;QAC7D,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,GAAG,MAAM,KAAK,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AAC/C,CAAC,CAAC"}

package/dist/utils/display-reporting.d.ts

@@ -0,0 +1,7 @@
+import type { ValidationReporting } from "../types.js";
+/**
+ * Displays the reporting in the console.
+ * @param reporting - The reporting to display.
+ * @param timestamp - The timestamp of the reporting.
+ */
+export declare const displayReporting: (reporting: ValidationReporting, timestamp: number) => void;

package/dist/utils/display-reporting.js

@@ -0,0 +1,38 @@
+import { WORKSPACE_NAME } from "../constants.js";
+/**
+ * Displays the reporting in the console.
+ * @param reporting - The reporting to display.
+ * @param timestamp - The timestamp of the reporting.
+ */
+export const displayReporting = (reporting, timestamp) => {
+    const { resource, status, result } = reporting;
+    const statusIcon = status === "pass" ? "\u2714" : "\u2718";
+    const statusColour = status === "pass" ? 32 : 31;
+    const dateTime = Intl.DateTimeFormat(undefined, {
+        hour: "2-digit",
+        minute: "2-digit",
+        second: "2-digit",
+        hour12: false,
+        timeZone: "UTC"
+    }).format(timestamp);
+    console.group(`[${dateTime}]`, `[${WORKSPACE_NAME}]`, resource);
+    if (status === "fail") {
+        console.info(`\x1b[1;${statusColour}m${statusIcon} ${status}\x1b[0m`, `(messages: ${reporting.result.length})`);
+    }
+    else {
+        console.info(`\x1b[1;${statusColour}m${statusIcon} ${status}\x1b[0m`);
+    }
+    if (result) {
+        for (const reportingMessage of result) {
+            const { type, path, message } = reportingMessage;
+            if (type === "error") {
+                console.error("\x1b[1;31mError:\x1b[0m", message);
+            }
+            else
+                console.warn("\x1b[1;33mWarning:\x1b[0m", message);
+            console.info(path);
+        }
+    }
+    console.groupEnd();
+};
+//# sourceMappingURL=display-reporting.js.map

package/dist/utils/display-reporting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"display-reporting.js","sourceRoot":"","sources":["../../src/utils/display-reporting.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,SAA8B,EAAE,SAAiB,EAAQ,EAAE;IAC1F,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC/C,MAAM,UAAU,GAAG,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC3D,MAAM,YAAY,GAAG,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE;QAC9C,IAAI,EAAE,SAAS;QACf,MAAM,EAAE,SAAS;QACjB,MAAM,EAAE,SAAS;QACjB,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACrB,OAAO,CAAC,KAAK,CAAC,IAAI,QAAQ,GAAG,EAAE,IAAI,cAAc,GAAG,EAAE,QAAQ,CAAC,CAAC;IAChE,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CACV,UAAU,YAAY,IAAI,UAAU,IAAI,MAAM,SAAS,EACvD,cAAc,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,CACzC,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,IAAI,CAAC,UAAU,YAAY,IAAI,UAAU,IAAI,MAAM,SAAS,CAAC,CAAC;IACxE,CAAC;IACD,IAAI,MAAM,EAAE,CAAC;QACX,KAAK,MAAM,gBAAgB,IAAI,MAAM,EAAE,CAAC;YACtC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,gBAAgB,CAAC;YACjD,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;gBACrB,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;YACpD,CAAC;;gBAAM,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;YAC1D,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IACD,OAAO,CAAC,QAAQ,EAAE,CAAC;AACrB,CAAC,CAAC"}

package/dist/utils/dry-run-notice.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Prints a notice that the validation is skipped in dry-run mode.
+ */
+export declare const dryRunNotice: () => void;

package/dist/utils/dry-run-notice.js

@@ -0,0 +1,8 @@
+import { WORKSPACE_NAME } from "../constants.js";
+/**
+ * Prints a notice that the validation is skipped in dry-run mode.
+ */
+export const dryRunNotice = () => {
+    console.info(`[${WORKSPACE_NAME}]`, "Dry-run mode: validation skipped.");
+};
+//# sourceMappingURL=dry-run-notice.js.map

package/dist/utils/dry-run-notice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dry-run-notice.js","sourceRoot":"","sources":["../../src/utils/dry-run-notice.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,GAAS,EAAE;IACrC,OAAO,CAAC,IAAI,CAAC,IAAI,cAAc,GAAG,EAAE,mCAAmC,CAAC,CAAC;AAC3E,CAAC,CAAC"}