@neo4j/graph-schema-utils 1.0.0-next.1 → 1.0.0-next.11

package/dist/formatters/llm-prompt/index.js

@@ -0,0 +1,102 @@
+import { PropertyBaseType, } from "../../model/index.js";
+export function toTomaz(schema) {
+    let out = [`Node properties are the following:`].concat(schema.nodeObjectTypes.map(nodeObjectTypes).filter(Boolean), [`Relationship properties are the following:`], schema.relationshipObjectTypes.map(relationshipObjectTypes).filter(Boolean), [`The relationships are the following:`], JSON.stringify(schema.relationshipObjectTypes.map(paths)));
+    function nodeObjectTypes(nodeObjectType) {
+        const out = [];
+        const properties = nodeObjectType.getProperties().map((property) => {
+            const base = {
+                property: property.token,
+                type: formatPropertyType(property.type),
+            };
+            if (property.nullable) {
+                base.nullable = true;
+            }
+            return base;
+        });
+        if (!properties.length) {
+            return "";
+        }
+        out.push({
+            properties: properties,
+            labels: nodeObjectType.labels.map((label) => label.token),
+        });
+        return JSON.stringify(out);
+    }
+    function relationshipObjectTypes(relationshipObjectType) {
+        const out = [];
+        const properties = relationshipObjectType
+            .getProperties()
+            .map((property) => {
+            const base = {
+                property: property.token,
+                type: formatPropertyType(property.type),
+            };
+            if (property.nullable) {
+                base.nullable = true;
+            }
+            return base;
+        });
+        if (!properties.length) {
+            return "";
+        }
+        out.push({
+            labels: [relationshipObjectType.type.token],
+            properties: properties,
+        });
+        return JSON.stringify(out);
+    }
+    function paths(relationshipObjectType) {
+        return `(:${relationshipObjectType.from.labels
+            .map((label) => label.token)
+            .join(":")})-[:${relationshipObjectType.type.token}]->(:${relationshipObjectType.to.labels
+            .map((label) => label.token)
+            .join(":")})`;
+    }
+    return out.join("\n");
+}
+export function toOskars(schema) {
+    let out = [`Node types with their properties + types`].concat(schema.nodeObjectTypes.map(nodeObjectTypes), [`Relationship types with properties + types`], schema.relationshipObjectTypes.map(relationshipObjectTypes).filter(Boolean), [
+        `Paths (all combinations of node types and relationship types and the direction of the relationship)`,
+    ], schema.relationshipObjectTypes.map(paths));
+    function nodeObjectTypes(nodeObjectType) {
+        const out = [];
+        const properties = nodeObjectType.getProperties().map((property) => {
+            return `${property.token}: ${formatPropertyType(property.type)}${property.nullable ? " (nullable)" : ""}`;
+        });
+        out.push(`  (:${nodeObjectType.labels.map((label) => label.token).join(":")}${properties.length > 0 ? ` {${properties.join(", ")}}` : ""})`);
+        return out.join("\n");
+    }
+    function relationshipObjectTypes(relationshipObjectType) {
+        const out = [];
+        const properties = relationshipObjectType
+            .getProperties()
+            .map((property) => {
+            return `${property.token}: ${formatPropertyType(property.type)}${property.nullable ? " (nullable)" : ""}`;
+        });
+        if (!properties.length) {
+            return "";
+        }
+        out.push(`  [:${relationshipObjectType.type.token}${properties.length > 0 ? ` {${properties.join(", ")}}` : ""}]`);
+        return out.join("\n");
+    }
+    function paths(relationshipObjectType) {
+        const out = [];
+        out.push(`  (:${relationshipObjectType.from.labels
+            .map((label) => label.token)
+            .join(":")})-[:${relationshipObjectType.type.token}]->(:${relationshipObjectType.to.labels
+            .map((label) => label.token)
+            .join(":")})`);
+        return out.join("\n");
+    }
+    return out.join("\n");
+}
+function formatPropertyType(type) {
+    if (Array.isArray(type)) {
+        return type.map(formatPropertyType).join("|");
+    }
+    if (type instanceof PropertyBaseType) {
+        return type.type;
+    }
+    return `${type.items.type}[]`;
+}
+//# sourceMappingURL=index.js.map

package/dist/formatters/llm-prompt/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/formatters/llm-prompt/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,gBAAgB,GAIjB,MAAM,sBAAsB,CAAC;AAG9B,MAAM,UAAU,OAAO,CAAC,MAAmB;IACzC,IAAI,GAAG,GAAa,CAAC,oCAAoC,CAAC,CAAC,MAAM,CAC/D,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,EAC3D,CAAC,4CAA4C,CAAC,EAC9C,MAAM,CAAC,uBAAuB,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,EAC3E,CAAC,sCAAsC,CAAC,EACxC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,uBAAuB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAC1D,CAAC;IAEF,SAAS,eAAe,CAAC,cAA8B;QACrD,MAAM,GAAG,GAAG,EAAE,CAAC;QACf,MAAM,UAAU,GAAG,cAAc,CAAC,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjE,MAAM,IAAI,GAA0B;gBAClC,QAAQ,EAAE,QAAQ,CAAC,KAAK;gBACxB,IAAI,EAAE,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC;aACxC,CAAC;YACF,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACtB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACvB,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACvB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,GAAG,CAAC,IAAI,CAAC;YACP,UAAU,EAAE,UAAU;YACtB,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;SAC1D,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED,SAAS,uBAAuB,CAC9B,sBAA8C;QAE9C,MAAM,GAAG,GAAG,EAAE,CAAC;QACf,MAAM,UAAU,GAAG,sBAAsB;aACtC,aAAa,EAAE;aACf,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YAChB,MAAM,IAAI,GAA0B;gBAClC,QAAQ,EAAE,QAAQ,CAAC,KAAK;gBACxB,IAAI,EAAE,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC;aACxC,CAAC;YACF,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACtB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACvB,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACL,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACvB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,GAAG,CAAC,IAAI,CAAC;YACP,MAAM,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC;YAC3C,UAAU,EAAE,UAAU;SACvB,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IACD,SAAS,KAAK,CAAC,sBAA8C;QAC3D,OAAO,KAAK,sBAAsB,CAAC,IAAI,CAAC,MAAM;aAC3C,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;aAC3B,IAAI,CAAC,GAAG,CAAC,OACV,sBAAsB,CAAC,IAAI,CAAC,KAC9B,QAAQ,sBAAsB,CAAC,EAAE,CAAC,MAAM;aACrC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;aAC3B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAClB,CAAC;IACD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAmB;IAC1C,IAAI,GAAG,GAAa,CAAC,0CAA0C,CAAC,CAAC,MAAM,CACrE,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,EAC3C,CAAC,4CAA4C,CAAC,EAC9C,MAAM,CAAC,uBAAuB,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,EAC3E;QACE,qGAAqG;KACtG,EACD,MAAM,CAAC,uBAAuB,CAAC,GAAG,CAAC,KAAK,CAAC,CAC1C,CAAC;IAEF,SAAS,eAAe,CAAC,cAA8B;QACrD,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,MAAM,UAAU,GAAG,cAAc,CAAC,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjE,OAAO,GAAG,QAAQ,CAAC,KAAK,KAAK,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,GAC5D,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EACtC,EAAE,CAAC;QACL,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,IAAI,CACN,OAAO,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAChE,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAC1D,GAAG,CACJ,CAAC;QACF,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IACD,SAAS,uBAAuB,CAC9B,sBAA8C;QAE9C,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,MAAM,UAAU,GAAG,sBAAsB;aACtC,aAAa,EAAE;aACf,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YAChB,OAAO,GAAG,QAAQ,CAAC,KAAK,KAAK,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,GAC5D,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EACtC,EAAE,CAAC;QACL,CAAC,CAAC,CAAC;QACL,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACvB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,GAAG,CAAC,IAAI,CACN,OAAO,sBAAsB,CAAC,IAAI,CAAC,KAAK,GACtC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAC1D,GAAG,CACJ,CAAC;QAEF,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IACD,SAAS,KAAK,CAAC,sBAA8C;QAC3D,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,GAAG,CAAC,IAAI,CACN,OAAO,sBAAsB,CAAC,IAAI,CAAC,MAAM;aACtC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;aAC3B,IAAI,CAAC,GAAG,CAAC,OACV,sBAAsB,CAAC,IAAI,CAAC,KAC9B,QAAQ,sBAAsB,CAAC,EAAE,CAAC,MAAM;aACrC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;aAC3B,IAAI,CAAC,GAAG,CAAC,GAAG,CAChB,CAAC;QAEF,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC;AAED,SAAS,kBAAkB,CAAC,IAA2B;IACrD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IACD,IAAI,IAAI,YAAY,gBAAgB,EAAE,CAAC;QACrC,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC;AAChC,CAAC"}

package/dist/formatters/llm-prompt/types.d.ts

@@ -0,0 +1,5 @@
+export type ElementPropertyObject = {
+    property: string;
+    type: string;
+    nullable?: boolean;
+};

package/dist/formatters/llm-prompt/types.js

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

package/dist/formatters/llm-prompt/types.js.map

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

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { validateSchema, SchemaValidationError } from "./validation.js";
+import * as model from "./model/index.js";
+import * as json from "./formatters/json/index.js";
+declare const formatters: {
+    json: typeof json;
+};
+export { model, formatters };

package/dist/index.js

@@ -0,0 +1,6 @@
+export { validateSchema, SchemaValidationError } from "./validation.js";
+import * as model from "./model/index.js";
+import * as json from "./formatters/json/index.js";
+const formatters = { json };
+export { model, formatters };
+//# 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,cAAc,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,4BAA4B,CAAC;AAEnD,MAAM,UAAU,GAAG,EAAE,IAAI,EAAE,CAAC;AAC5B,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC"}

package/dist/model/index.d.ts

@@ -0,0 +1,116 @@
+export declare class GraphSchema {
+    nodeLabels: NodeLabel[];
+    relationshipTypes: RelationshipType[];
+    nodeObjectTypes: NodeObjectType[];
+    relationshipObjectTypes: RelationshipObjectType[];
+    constraints: Constraint[];
+    indexes: Index[];
+    constructor(nodeObjectTypes: NodeObjectType[], relationshipObjectTypes: RelationshipObjectType[], constraints?: Constraint[], indexes?: Index[]);
+    private extractNodeLabels;
+    private extractRelationshipTypes;
+    getAllNodeLabelTokens(): string[];
+    getAllRelationshipTypeTokens(): string[];
+    getAllPropertyTokens(): string[];
+}
+export declare class NodeLabel {
+    $id: string;
+    token: string;
+    properties: Property[];
+    constructor(id: string, token: string, properties?: Property[]);
+    getPropertyTokens(): string[];
+}
+export declare class RelationshipType {
+    $id: string;
+    token: string;
+    properties: Property[];
+    constructor(id: string, token: string, properties?: Property[]);
+    getPropertyTokens(): string[];
+}
+export declare class NodeObjectType {
+    $id: string;
+    labels: NodeLabel[];
+    constructor(id: string, labels: NodeLabel[]);
+    getProperties(): Property[];
+    getPropertyTokens(): string[];
+}
+export declare class RelationshipObjectType {
+    $id: string;
+    type: RelationshipType;
+    from: NodeObjectType;
+    to: NodeObjectType;
+    constructor(id: string, type: RelationshipType, from: NodeObjectType, to: NodeObjectType);
+    getProperties(): Property[];
+    getPropertyTokens(): string[];
+}
+export type Constraint = NodeLabelConstraint | RelationshipTypeConstraint;
+export type Index = NodeLabelIndex | RelationshipTypeIndex | LookupIndex;
+export declare const isNodeLabelConstraint: (constraint: Constraint) => constraint is NodeLabelConstraint;
+export declare const isRelationshipTypeConstraint: (constraint: Constraint) => constraint is RelationshipTypeConstraint;
+export declare const isNodeLabelIndex: (index: Index) => index is NodeLabelIndex;
+export declare const isRelationshipTypeIndex: (index: Index) => index is RelationshipTypeIndex;
+export declare const isLookupIndex: (index: Index) => index is LookupIndex;
+export declare class NodeLabelConstraint {
+    $id: string;
+    name: string;
+    constraintType: ConstraintType;
+    nodeLabel: NodeLabel;
+    properties: Property[];
+    entityType: EntityType;
+    constructor($id: string, name: string, constraintType: ConstraintType, nodeLabel: NodeLabel, properties: Property[]);
+}
+export declare class RelationshipTypeConstraint {
+    $id: string;
+    name: string;
+    constraintType: ConstraintType;
+    relationshipType: RelationshipType;
+    properties: Property[];
+    entityType: EntityType;
+    constructor($id: string, name: string, constraintType: ConstraintType, relationshipType: RelationshipType, properties: Property[]);
+}
+export declare class NodeLabelIndex {
+    $id: string;
+    name: string;
+    indexType: Exclude<IndexType, "lookup">;
+    entityType: EntityType;
+    nodeLabel: NodeLabel;
+    properties: Property[];
+    constructor($id: string, name: string, indexType: Exclude<IndexType, "lookup">, nodeLabel: NodeLabel, properties: Property[]);
+}
+export declare class RelationshipTypeIndex {
+    $id: string;
+    name: string;
+    indexType: Exclude<IndexType, "lookup">;
+    entityType: EntityType;
+    relationshipType: RelationshipType;
+    properties: Property[];
+    constructor($id: string, name: string, indexType: Exclude<IndexType, "lookup">, relationshipType: RelationshipType, properties: Property[]);
+}
+export declare class LookupIndex {
+    $id: string;
+    name: string;
+    entityType: EntityType;
+    indexType: IndexType;
+    constructor($id: string, name: string, entityType: EntityType);
+}
+export type ConstraintType = "uniqueness" | "propertyExistence" | "propertyType" | "key";
+export type IndexType = "range" | "lookup" | "text" | "full-text" | "point" | "default";
+export type EntityType = "node" | "relationship";
+export type PropertyTypes = PropertyBaseType | PropertyArrayType;
+export type PropertyTypeRecursive = PropertyTypes | Array<PropertyTypes | PropertyTypeRecursive[]>;
+export declare class Property {
+    $id: string;
+    token: string;
+    type: PropertyTypeRecursive;
+    nullable: boolean;
+    constructor($id: string, token: string, type: PropertyTypeRecursive, nullable: boolean);
+}
+export declare class PropertyBaseType {
+    type: PrimitivePropertyTypes;
+    constructor(type: PrimitivePropertyTypes);
+}
+export declare class PropertyArrayType {
+    items: PropertyBaseType;
+    type: "array";
+    constructor(items: PropertyBaseType);
+}
+export type PrimitivePropertyTypes = "integer" | "string" | "float" | "boolean" | "point" | "date" | "datetime" | "time" | "localtime" | "localdatetime" | "duration";

package/dist/model/index.js

@@ -0,0 +1,167 @@
+export class GraphSchema {
+    constructor(nodeObjectTypes, relationshipObjectTypes, constraints = [], indexes = []) {
+        this.nodeLabels = [];
+        this.relationshipTypes = [];
+        this.nodeObjectTypes = nodeObjectTypes;
+        this.relationshipObjectTypes = relationshipObjectTypes;
+        this.constraints = constraints;
+        this.indexes = indexes;
+        this.extractNodeLabels();
+        this.extractRelationshipTypes();
+    }
+    extractNodeLabels() {
+        const nodeLabels = this.nodeObjectTypes.flatMap((nodeObjectType) => nodeObjectType.labels);
+        this.nodeLabels = [...new Set(nodeLabels)];
+    }
+    extractRelationshipTypes() {
+        const relationshipTypes = this.relationshipObjectTypes.flatMap((relationshipObjectType) => relationshipObjectType.type);
+        this.relationshipTypes = [...new Set(relationshipTypes)];
+    }
+    getAllNodeLabelTokens() {
+        return this.nodeLabels.map((nodeLabel) => nodeLabel.token);
+    }
+    getAllRelationshipTypeTokens() {
+        return this.relationshipTypes.map((relationshipType) => relationshipType.token);
+    }
+    getAllPropertyTokens() {
+        const nodeProperties = this.nodeObjectTypes.flatMap((nodeObjectType) => nodeObjectType.getPropertyTokens());
+        const relationshipProperties = this.relationshipObjectTypes.flatMap((relationshipObjectType) => relationshipObjectType.getPropertyTokens());
+        // return all tokens without duplicates
+        return [...new Set([...nodeProperties, ...relationshipProperties])];
+    }
+}
+export class NodeLabel {
+    constructor(id, token, properties = []) {
+        this.$id = id;
+        this.token = token;
+        this.properties = properties;
+    }
+    getPropertyTokens() {
+        return this.properties.map((property) => property.token);
+    }
+}
+export class RelationshipType {
+    constructor(id, token, properties = []) {
+        this.$id = id;
+        this.token = token;
+        this.properties = properties;
+    }
+    getPropertyTokens() {
+        return this.properties.map((property) => property.token);
+    }
+}
+export class NodeObjectType {
+    constructor(id, labels) {
+        this.$id = id;
+        this.labels = labels;
+    }
+    getProperties() {
+        return this.labels.flatMap((l) => l.properties);
+    }
+    getPropertyTokens() {
+        // return all tokens without duplicates
+        return [...new Set(this.getProperties().map((property) => property.token))];
+    }
+}
+export class RelationshipObjectType {
+    constructor(id, type, from, to) {
+        this.$id = id;
+        this.type = type;
+        this.from = from;
+        this.to = to;
+    }
+    getProperties() {
+        return this.type.properties;
+    }
+    getPropertyTokens() {
+        // return all tokens without duplicates
+        return [...new Set(this.getProperties().map((property) => property.token))];
+    }
+}
+export const isNodeLabelConstraint = (constraint) => {
+    return constraint.entityType === "node" && "nodeLabel" in constraint;
+};
+export const isRelationshipTypeConstraint = (constraint) => {
+    return (constraint.entityType === "relationship" && "relationshipType" in constraint);
+};
+export const isNodeLabelIndex = (index) => {
+    return (index.entityType === "node" &&
+        index.indexType !== "lookup" &&
+        "nodeLabel" in index);
+};
+export const isRelationshipTypeIndex = (index) => {
+    return (index.entityType === "relationship" &&
+        index.indexType !== "lookup" &&
+        "relationshipType" in index);
+};
+export const isLookupIndex = (index) => {
+    return index.indexType === "lookup";
+};
+export class NodeLabelConstraint {
+    constructor($id, name, constraintType, nodeLabel, properties) {
+        this.$id = $id;
+        this.name = name;
+        this.constraintType = constraintType;
+        this.nodeLabel = nodeLabel;
+        this.properties = properties;
+        this.entityType = "node";
+    }
+}
+export class RelationshipTypeConstraint {
+    constructor($id, name, constraintType, relationshipType, properties) {
+        this.$id = $id;
+        this.name = name;
+        this.constraintType = constraintType;
+        this.relationshipType = relationshipType;
+        this.properties = properties;
+        this.entityType = "relationship";
+    }
+}
+export class NodeLabelIndex {
+    constructor($id, name, indexType, nodeLabel, properties) {
+        this.$id = $id;
+        this.name = name;
+        this.nodeLabel = nodeLabel;
+        this.indexType = indexType;
+        this.properties = properties;
+        this.entityType = "node";
+    }
+}
+export class RelationshipTypeIndex {
+    constructor($id, name, indexType, relationshipType, properties) {
+        this.$id = $id;
+        this.name = name;
+        this.indexType = indexType;
+        this.entityType = "relationship";
+        this.relationshipType = relationshipType;
+        this.properties = properties;
+    }
+}
+export class LookupIndex {
+    constructor($id, name, entityType) {
+        this.$id = $id;
+        this.name = name;
+        this.indexType = "lookup";
+        this.entityType = entityType;
+    }
+}
+export class Property {
+    constructor($id, token, type, nullable) {
+        this.$id = $id;
+        this.token = token;
+        this.type = type;
+        this.nullable = nullable;
+    }
+}
+export class PropertyBaseType {
+    constructor(type) {
+        this.type = type;
+    }
+}
+export class PropertyArrayType {
+    constructor(items) {
+        this.type = "array";
+        this.items = items;
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/model/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/model/index.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,WAAW;IAQtB,YACE,eAAiC,EACjC,uBAAiD,EACjD,cAA4B,EAAE,EAC9B,UAAmB,EAAE;QAXvB,eAAU,GAAgB,EAAE,CAAC;QAC7B,sBAAiB,GAAuB,EAAE,CAAC;QAYzC,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;QACvD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAClC,CAAC;IACO,iBAAiB;QACvB,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAC7C,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,CAC1C,CAAC;QACF,IAAI,CAAC,UAAU,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7C,CAAC;IACO,wBAAwB;QAC9B,MAAM,iBAAiB,GAAG,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAC5D,CAAC,sBAAsB,EAAE,EAAE,CAAC,sBAAsB,CAAC,IAAI,CACxD,CAAC;QACF,IAAI,CAAC,iBAAiB,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,qBAAqB;QACnB,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC7D,CAAC;IAED,4BAA4B;QAC1B,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAC/B,CAAC,gBAAgB,EAAE,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAC7C,CAAC;IACJ,CAAC;IAED,oBAAoB;QAClB,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE,CACrE,cAAc,CAAC,iBAAiB,EAAE,CACnC,CAAC;QACF,MAAM,sBAAsB,GAAG,IAAI,CAAC,uBAAuB,CAAC,OAAO,CACjE,CAAC,sBAAsB,EAAE,EAAE,CAAC,sBAAsB,CAAC,iBAAiB,EAAE,CACvE,CAAC;QACF,uCAAuC;QACvC,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,cAAc,EAAE,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;IACtE,CAAC;CACF;AAED,MAAM,OAAO,SAAS;IAKpB,YAAY,EAAU,EAAE,KAAa,EAAE,aAAyB,EAAE;QAChE,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,gBAAgB;IAK3B,YAAY,EAAU,EAAE,KAAa,EAAE,aAAyB,EAAE;QAChE,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,cAAc;IAIzB,YAAY,EAAU,EAAE,MAAmB;QACzC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IACD,aAAa;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAClD,CAAC;IACD,iBAAiB;QACf,uCAAuC;QACvC,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9E,CAAC;CACF;AAED,MAAM,OAAO,sBAAsB;IAMjC,YACE,EAAU,EACV,IAAsB,EACtB,IAAoB,EACpB,EAAkB;QAElB,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACf,CAAC;IACD,aAAa;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;IAC9B,CAAC;IACD,iBAAiB;QACf,uCAAuC;QACvC,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9E,CAAC;CACF;AAMD,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,UAAsB,EACa,EAAE;IACrC,OAAO,UAAU,CAAC,UAAU,KAAK,MAAM,IAAI,WAAW,IAAI,UAAU,CAAC;AACvE,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,UAAsB,EACoB,EAAE;IAC5C,OAAO,CACL,UAAU,CAAC,UAAU,KAAK,cAAc,IAAI,kBAAkB,IAAI,UAAU,CAC7E,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAY,EAA2B,EAAE;IACxE,OAAO,CACL,KAAK,CAAC,UAAU,KAAK,MAAM;QAC3B,KAAK,CAAC,SAAS,KAAK,QAAQ;QAC5B,WAAW,IAAI,KAAK,CACrB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,KAAY,EACoB,EAAE;IAClC,OAAO,CACL,KAAK,CAAC,UAAU,KAAK,cAAc;QACnC,KAAK,CAAC,SAAS,KAAK,QAAQ;QAC5B,kBAAkB,IAAI,KAAK,CAC5B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,KAAY,EAAwB,EAAE;IAClE,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,OAAO,mBAAmB;IAQ9B,YACE,GAAW,EACX,IAAY,EACZ,cAA8B,EAC9B,SAAoB,EACpB,UAAsB;QAEtB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC;IAC3B,CAAC;CACF;AAED,MAAM,OAAO,0BAA0B;IAQrC,YACE,GAAW,EACX,IAAY,EACZ,cAA8B,EAC9B,gBAAkC,EAClC,UAAsB;QAEtB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,cAAc,CAAC;IACnC,CAAC;CACF;AAED,MAAM,OAAO,cAAc;IAQzB,YACE,GAAW,EACX,IAAY,EACZ,SAAuC,EACvC,SAAoB,EACpB,UAAsB;QAEtB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC;IAC3B,CAAC;CACF;AAED,MAAM,OAAO,qBAAqB;IAQhC,YACE,GAAW,EACX,IAAY,EACZ,SAAuC,EACvC,gBAAkC,EAClC,UAAsB;QAEtB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,cAAc,CAAC;QACjC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAED,MAAM,OAAO,WAAW;IAMtB,YAAY,GAAW,EAAE,IAAY,EAAE,UAAsB;QAC3D,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAsBD,MAAM,OAAO,QAAQ;IAMnB,YACE,GAAW,EACX,KAAa,EACb,IAA2B,EAC3B,QAAiB;QAEjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED,MAAM,OAAO,gBAAgB;IAE3B,YAAY,IAA4B;QACtC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,MAAM,OAAO,iBAAiB;IAI5B,YAAY,KAAuB;QACjC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF"}

package/dist/validation.d.ts

@@ -0,0 +1,9 @@
+import AjvModule from "ajv";
+export declare function validateSchema(jsonSchema: string, graphSchema: string): boolean;
+export declare class SchemaValidationError extends Error {
+    messages: AjvModule.ErrorObject<string, Record<string, any>, unknown>[];
+    constructor(inputMessages: AjvModule.ErrorObject<string, Record<string, any>, unknown>[]);
+}
+export declare class InputTypeError extends Error {
+    constructor(message: string);
+}

package/dist/validation.js

@@ -0,0 +1,49 @@
+import AjvModule from "ajv";
+// FIXME: https://github.com/ajv-validator/ajv/issues/2047
+const Ajv = AjvModule.default;
+const ajv = new Ajv({ strict: false, allErrors: true });
+export function validateSchema(jsonSchema, graphSchema) {
+    if (typeof jsonSchema !== "string") {
+        throw new InputTypeError("JSON schema should be a string");
+    }
+    let jsonSchemaObj;
+    try {
+        jsonSchemaObj = JSON.parse(jsonSchema);
+    }
+    catch (_) {
+        throw new InputTypeError("Cannot JSON.parse JSON schema input");
+    }
+    if (typeof graphSchema !== "string") {
+        throw new InputTypeError("Graph schema should be a string");
+    }
+    let graphSchemaObj;
+    try {
+        graphSchemaObj = JSON.parse(graphSchema);
+    }
+    catch (_) {
+        throw new InputTypeError("Cannot JSON.parse graph schema input");
+    }
+    const validate = ajv.compile(jsonSchemaObj);
+    const result = validate(graphSchemaObj);
+    if (result !== true) {
+        if (validate.errors) {
+            throw new SchemaValidationError(validate.errors);
+        }
+    }
+    return true;
+}
+export class SchemaValidationError extends Error {
+    constructor(inputMessages) {
+        super(`See error.messages for details`);
+        this.messages = [];
+        this.messages = inputMessages;
+        this.name = "SchemaValidationError";
+    }
+}
+export class InputTypeError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "InputTypeError";
+    }
+}
+//# sourceMappingURL=validation.js.map

package/dist/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,KAAK,CAAC;AAE5B,0DAA0D;AAC1D,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC;AAE9B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;AAExD,MAAM,UAAU,cAAc,CAC5B,UAAkB,EAClB,WAAmB;IAEnB,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACnC,MAAM,IAAI,cAAc,CAAC,gCAAgC,CAAC,CAAC;IAC7D,CAAC;IACD,IAAI,aAAa,CAAC;IAClB,IAAI,CAAC;QACH,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,cAAc,CAAC,qCAAqC,CAAC,CAAC;IAClE,CAAC;IAED,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,IAAI,cAAc,CAAC,iCAAiC,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,cAAc,CAAC;IACnB,IAAI,CAAC;QACH,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,cAAc,CAAC,sCAAsC,CAAC,CAAC;IACnE,CAAC;IAED,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;IACxC,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpB,MAAM,IAAI,qBAAqB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,OAAO,qBAAsB,SAAQ,KAAK;IAG9C,YACE,aAA4E;QAE5E,KAAK,CAAC,gCAAgC,CAAC,CAAC;QAL1C,aAAQ,GAAkE,EAAE,CAAC;QAM3E,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;IACtC,CAAC;CACF;AAED,MAAM,OAAO,cAAe,SAAQ,KAAK;IACvC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;IAC/B,CAAC;CACF"}

package/package.json

@@ -1,15 +1,24 @@
 {
   "name": "@neo4j/graph-schema-utils",
-  "version": "1.0.0-next.1",
-  "description": "Utilities for the Neo4j Graph Schema JSON representation",
-  "module": "src/index.js",
+  "version": "1.0.0-next.11",
+  "description": "Utilities for Neo4j Graph Schema JSON representation",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
   "type": "module",
   "scripts": {
     "test:watch": "vitest",
-    "test": "vitest run"
+    "test": "vitest run",
+    "build": "tsc --project tsconfig.build.json",
+    "check": "tsc --project tsconfig.check.json"
   },
   "files": [
-    "src"
+    "dist"
   ],
   "repository": {
     "type": "git",
@@ -27,8 +36,6 @@
     "graph schema"
   ],
   "devDependencies": {
-    "@vitest/coverage-c8": "^0.25.3",
-    "vitest": "^0.25.3",
-    "@neo4j/graph-json-schema": "*"
+    "@neo4j/graph-json-schema": "1.0.0-next.4"
   }
 }

package/src/index.js

@@ -1,4 +0,0 @@
-export { validateSchema, SchemaValidationError } from "./validation.js";
-import * as model from "./model";
-
-export { model };