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

package/{src/index.js → dist/index.d.ts}

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

package/dist/index.js

@@ -0,0 +1,4 @@
+export { validateSchema, SchemaValidationError } from "./validation.js";
+import * as model from "./model/index.js";
+export { model };
+//# 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;AAE1C,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/dist/model/index.d.ts

@@ -0,0 +1,179 @@
+export declare class GraphSchemaRepresentation {
+    version: string;
+    graphSchema: GraphSchema;
+    constructor(version: string, graphSchema: GraphSchema);
+    toJson(): string;
+    static parseJson(jsonString: any): GraphSchemaRepresentation;
+}
+export declare class GraphSchema {
+    nodeLabels: NodeLabel[];
+    relationshipTypes: RelationshipType[];
+    nodeObjectTypes: NodeObjectType[];
+    relationshipObjectTypes: RelationshipObjectType[];
+    constructor(nodeLabels: NodeLabel[], relationshipTypes: RelationshipType[], nodeObjectTypes: NodeObjectType[], relationshipObjectTypes: RelationshipObjectType[]);
+    toJsonStruct(): {
+        nodeLabels: {
+            $id: string;
+            token: string;
+        }[];
+        relationshipTypes: {
+            $id: string;
+            token: string;
+        }[];
+        nodeObjectTypes: {
+            $id: string;
+            labels: {
+                $ref: string;
+            }[];
+            properties: {
+                type: any[] | {
+                    type: PropertyTypes;
+                } | {
+                    type: "array";
+                    items: PropertyBaseType;
+                };
+                token: string;
+                mandatory: boolean;
+            }[];
+        }[];
+        relationshipObjectTypes: {
+            $id: string;
+            type: {
+                $ref: string;
+            };
+            from: {
+                $ref: string;
+            };
+            to: {
+                $ref: string;
+            };
+            properties: {
+                type: any[] | {
+                    type: PropertyTypes;
+                } | {
+                    type: "array";
+                    items: PropertyBaseType;
+                };
+                token: string;
+                mandatory: boolean;
+            }[];
+        }[];
+    };
+    static fromJsonStruct(json: any): GraphSchema;
+}
+export declare class NodeLabel {
+    $id: string;
+    token: string;
+    constructor(id: string, token: string);
+    toJsonStruct(): {
+        $id: string;
+        token: string;
+    };
+    toRef(): {
+        $ref: string;
+    };
+}
+export declare class RelationshipType {
+    $id: string;
+    token: string;
+    constructor(id: string, token: string);
+    toJsonStruct(): {
+        $id: string;
+        token: string;
+    };
+    toRef(): {
+        $ref: string;
+    };
+}
+export declare class NodeObjectType {
+    $id: string;
+    labels: NodeLabel[];
+    properties: Property[];
+    constructor(id: string, labels: NodeLabel[], properties: Property[]);
+    toJsonStruct(): {
+        $id: string;
+        labels: {
+            $ref: string;
+        }[];
+        properties: {
+            type: any[] | {
+                type: PropertyTypes;
+            } | {
+                type: "array";
+                items: PropertyBaseType;
+            };
+            token: string;
+            mandatory: boolean;
+        }[];
+    };
+    toRef(): {
+        $ref: string;
+    };
+}
+export declare class RelationshipObjectType {
+    $id: string;
+    type: RelationshipType;
+    from: NodeObjectType;
+    to: NodeObjectType;
+    properties: Property[];
+    constructor(id: string, type: RelationshipType, from: NodeObjectType, to: NodeObjectType, properties: Property[]);
+    toJsonStruct(): {
+        $id: string;
+        type: {
+            $ref: string;
+        };
+        from: {
+            $ref: string;
+        };
+        to: {
+            $ref: string;
+        };
+        properties: {
+            type: any[] | {
+                type: PropertyTypes;
+            } | {
+                type: "array";
+                items: PropertyBaseType;
+            };
+            token: string;
+            mandatory: boolean;
+        }[];
+    };
+}
+export declare class Property {
+    token: string;
+    type: PropertyBaseType | PropertyArrayType;
+    mandatory: boolean;
+    constructor(token: string, type: PropertyBaseType | PropertyArrayType, mandatory: boolean);
+    toJsonStruct(): {
+        type: any[] | {
+            type: PropertyTypes;
+        } | {
+            type: "array";
+            items: PropertyBaseType;
+        };
+        token: string;
+        mandatory: boolean;
+    };
+}
+export declare class PropertyBaseType {
+    type: PropertyTypes;
+    constructor(type: PropertyTypes);
+    toJsonStruct(): {
+        type: PropertyTypes;
+    };
+}
+export declare class PropertyArrayType {
+    items: PropertyBaseType;
+    type: "array";
+    constructor(items: PropertyBaseType);
+    toJsonStruct(): {
+        type: "array";
+        items: PropertyBaseType;
+    };
+}
+export declare class PropertyType {
+    static fromJsonStruct(json: any): any;
+}
+type PropertyTypes = "integer" | "string" | "float" | "boolean" | "point" | "date" | "datetime" | "time" | "localtime" | "localdatetime" | "duration";
+export {};

package/dist/model/index.js

@@ -0,0 +1,200 @@
+export class GraphSchemaRepresentation {
+    constructor(version, graphSchema) {
+        this.version = version;
+        this.graphSchema = graphSchema;
+    }
+    toJson() {
+        return JSON.stringify({
+            graphSchemaRepresentation: {
+                version: this.version,
+                graphSchema: this.graphSchema.toJsonStruct(),
+            },
+        });
+    }
+    static parseJson(jsonString) {
+        const json = JSON.parse(jsonString);
+        const version = json.graphSchemaRepresentation.version;
+        const graphSchema = GraphSchema.fromJsonStruct(json.graphSchemaRepresentation.graphSchema);
+        return new GraphSchemaRepresentation(version, graphSchema);
+    }
+}
+export class GraphSchema {
+    constructor(nodeLabels, relationshipTypes, nodeObjectTypes, relationshipObjectTypes) {
+        this.nodeLabels = nodeLabels;
+        this.relationshipTypes = relationshipTypes;
+        this.nodeObjectTypes = nodeObjectTypes;
+        this.relationshipObjectTypes = relationshipObjectTypes;
+    }
+    toJsonStruct() {
+        return {
+            nodeLabels: this.nodeLabels.map((nodeLabel) => nodeLabel.toJsonStruct()),
+            relationshipTypes: this.relationshipTypes.map((relationshipType) => relationshipType.toJsonStruct()),
+            nodeObjectTypes: this.nodeObjectTypes.map((nodeObjectType) => nodeObjectType.toJsonStruct()),
+            relationshipObjectTypes: this.relationshipObjectTypes.map((relationshipObjectType) => relationshipObjectType.toJsonStruct()),
+        };
+    }
+    static fromJsonStruct(json) {
+        const nodeLabels = json.nodeLabels.map((nodeLabel) => new NodeLabel(nodeLabel.$id, nodeLabel.token));
+        const relationshipTypes = json.relationshipTypes.map((relationshipType) => new RelationshipType(relationshipType.$id, relationshipType.token));
+        const nodeObjectTypes = json.nodeObjectTypes.map((nodeObjectType) => {
+            const labels = nodeObjectType.labels
+                .map((label) => nodeLabels.find((nodeLabel) => nodeLabel.$id === label.$ref.slice(1)))
+                .filter((label) => label);
+            if (labels.length !== nodeObjectType.labels.length) {
+                throw new Error("Not all label references are defined");
+            }
+            return new NodeObjectType(nodeObjectType.$id, labels, nodeObjectType.properties.map((property) => new Property(property.token, PropertyType.fromJsonStruct(property.type), property.mandatory)));
+        });
+        const relationshipObjectTypes = json.relationshipObjectTypes.map((relationshipObjectType) => {
+            const type = relationshipTypes.find((relationshipType) => relationshipType.$id === relationshipObjectType.type.$ref.slice(1));
+            if (!type) {
+                throw new Error("Not all relationship type references are defined");
+            }
+            const from = nodeObjectTypes.find((nodeObjectType) => nodeObjectType.$id === relationshipObjectType.from.$ref.slice(1));
+            if (!from) {
+                throw new Error("Not all node object type references in from are defined");
+            }
+            const to = nodeObjectTypes.find((nodeObjectType) => nodeObjectType.$id === relationshipObjectType.to.$ref.slice(1));
+            if (!to) {
+                throw new Error("Not all node object type references in to are defined");
+            }
+            return new RelationshipObjectType(relationshipObjectType.$id, type, from, to, relationshipObjectType.properties.map((property) => new Property(property.token, PropertyType.fromJsonStruct(property.type), property.mandatory)));
+        });
+        return new GraphSchema(nodeLabels, relationshipTypes, nodeObjectTypes, relationshipObjectTypes);
+    }
+}
+export class NodeLabel {
+    constructor(id, token) {
+        this.$id = id;
+        this.token = token;
+    }
+    toJsonStruct() {
+        return {
+            $id: this.$id,
+            token: this.token,
+        };
+    }
+    toRef() {
+        return {
+            $ref: `#${this.$id}`,
+        };
+    }
+}
+export class RelationshipType {
+    constructor(id, token) {
+        this.$id = id;
+        this.token = token;
+    }
+    toJsonStruct() {
+        return {
+            $id: this.$id,
+            token: this.token,
+        };
+    }
+    toRef() {
+        return {
+            $ref: `#${this.$id}`,
+        };
+    }
+}
+export class NodeObjectType {
+    constructor(id, labels, properties) {
+        this.$id = id;
+        this.labels = labels;
+        this.properties = properties;
+    }
+    toJsonStruct() {
+        const brokenLabels = this.labels.filter((label) => !label);
+        if (brokenLabels.length > 0) {
+            throw new Error("Not all labels are defined");
+        }
+        return {
+            $id: this.$id,
+            labels: this.labels.map((label) => label.toRef()),
+            properties: this.properties.map((property) => property.toJsonStruct()),
+        };
+    }
+    toRef() {
+        return {
+            $ref: `#${this.$id}`,
+        };
+    }
+}
+export class RelationshipObjectType {
+    constructor(id, type, from, to, properties) {
+        this.$id = id;
+        this.type = type;
+        this.from = from;
+        this.to = to;
+        this.properties = properties;
+    }
+    toJsonStruct() {
+        if (!this.type) {
+            throw new Error("RelationshipObjectType.type is not defined");
+        }
+        if (!this.from) {
+            throw new Error("RelationshipObjectType.from is not defined");
+        }
+        if (!this.to) {
+            throw new Error("RelationshipObjectType.to is not defined");
+        }
+        return {
+            $id: this.$id,
+            type: this.type.toRef(),
+            from: this.from.toRef(),
+            to: this.to.toRef(),
+            properties: this.properties.map((property) => property.toJsonStruct()),
+        };
+    }
+}
+export class Property {
+    constructor(token, type, mandatory) {
+        this.token = token;
+        this.type = type;
+        this.mandatory = mandatory;
+    }
+    toJsonStruct() {
+        const typeVal = Array.isArray(this.type)
+            ? this.type.map((t) => t.toJsonStruct())
+            : this.type.toJsonStruct();
+        return {
+            type: typeVal,
+            token: this.token,
+            mandatory: this.mandatory,
+        };
+    }
+}
+export class PropertyBaseType {
+    constructor(type) {
+        this.type = type;
+    }
+    toJsonStruct() {
+        return {
+            type: this.type,
+        };
+    }
+}
+export class PropertyArrayType {
+    constructor(items) {
+        this.type = "array";
+        this.items = items;
+    }
+    toJsonStruct() {
+        return {
+            type: this.type,
+            items: this.items,
+        };
+    }
+}
+export class PropertyType {
+    static fromJsonStruct(json) {
+        if (Array.isArray(json)) {
+            return json.map((item) => PropertyType.fromJsonStruct(item));
+        }
+        if (json.type === "array") {
+            return new PropertyArrayType(json.items);
+        }
+        return new PropertyBaseType(json.type);
+    }
+}
+//# 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,yBAAyB;IAIpC,YAAY,OAAe,EAAE,WAAwB;QACnD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,SAAS,CAAC;YACpB,yBAAyB,EAAE;gBACzB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE;aAC7C;SACF,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,UAAU;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACpC,MAAM,OAAO,GAAG,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC;QACvD,MAAM,WAAW,GAAG,WAAW,CAAC,cAAc,CAC5C,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAC3C,CAAC;QACF,OAAO,IAAI,yBAAyB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC7D,CAAC;CACF;AAED,MAAM,OAAO,WAAW;IAMtB,YACE,UAAuB,EACvB,iBAAqC,EACrC,eAAiC,EACjC,uBAAiD;QAEjD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;IACzD,CAAC;IACD,YAAY;QACV,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;YACxE,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,EAAE,CACjE,gBAAgB,CAAC,YAAY,EAAE,CAChC;YACD,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAC3D,cAAc,CAAC,YAAY,EAAE,CAC9B;YACD,uBAAuB,EAAE,IAAI,CAAC,uBAAuB,CAAC,GAAG,CACvD,CAAC,sBAAsB,EAAE,EAAE,CAAC,sBAAsB,CAAC,YAAY,EAAE,CAClE;SACF,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,IAAI;QACxB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CACpC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC,CAC7D,CAAC;QACF,MAAM,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAClD,CAAC,gBAAgB,EAAE,EAAE,CACnB,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,GAAG,EAAE,gBAAgB,CAAC,KAAK,CAAC,CACrE,CAAC;QACF,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE;YAClE,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM;iBACjC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACb,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CACtE;iBACA,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;YAC5B,IAAI,MAAM,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM,CAAC,MAAM,EAAE;gBAClD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aACzD;YACD,OAAO,IAAI,cAAc,CACvB,cAAc,CAAC,GAAG,EAClB,MAAM,EACN,cAAc,CAAC,UAAU,CAAC,GAAG,CAC3B,CAAC,QAAQ,EAAE,EAAE,CACX,IAAI,QAAQ,CACV,QAAQ,CAAC,KAAK,EACd,YAAY,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,EAC1C,QAAQ,CAAC,SAAS,CACnB,CACJ,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAC9D,CAAC,sBAAsB,EAAE,EAAE;YACzB,MAAM,IAAI,GAAG,iBAAiB,CAAC,IAAI,CACjC,CAAC,gBAAgB,EAAE,EAAE,CACnB,gBAAgB,CAAC,GAAG,KAAK,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CACrE,CAAC;YACF,IAAI,CAAC,IAAI,EAAE;gBACT,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;aACrE;YACD,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAC/B,CAAC,cAAc,EAAE,EAAE,CACjB,cAAc,CAAC,GAAG,KAAK,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CACnE,CAAC;YACF,IAAI,CAAC,IAAI,EAAE;gBACT,MAAM,IAAI,KAAK,CACb,yDAAyD,CAC1D,CAAC;aACH;YACD,MAAM,EAAE,GAAG,eAAe,CAAC,IAAI,CAC7B,CAAC,cAAc,EAAE,EAAE,CACjB,cAAc,CAAC,GAAG,KAAK,sBAAsB,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CACjE,CAAC;YACF,IAAI,CAAC,EAAE,EAAE;gBACP,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;aACH;YACD,OAAO,IAAI,sBAAsB,CAC/B,sBAAsB,CAAC,GAAG,EAC1B,IAAI,EACJ,IAAI,EACJ,EAAE,EACF,sBAAsB,CAAC,UAAU,CAAC,GAAG,CACnC,CAAC,QAAQ,EAAE,EAAE,CACX,IAAI,QAAQ,CACV,QAAQ,CAAC,KAAK,EACd,YAAY,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,EAC1C,QAAQ,CAAC,SAAS,CACnB,CACJ,CACF,CAAC;QACJ,CAAC,CACF,CAAC;QACF,OAAO,IAAI,WAAW,CACpB,UAAU,EACV,iBAAiB,EACjB,eAAe,EACf,uBAAuB,CACxB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,SAAS;IAIpB,YAAY,EAAU,EAAE,KAAa;QACnC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IACD,YAAY;QACV,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;IACJ,CAAC;IACD,KAAK;QACH,OAAO;YACL,IAAI,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE;SACrB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,gBAAgB;IAI3B,YAAY,EAAU,EAAE,KAAa;QACnC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IACD,YAAY;QACV,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;IACJ,CAAC;IACD,KAAK;QACH,OAAO;YACL,IAAI,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE;SACrB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,cAAc;IAKzB,YAAY,EAAU,EAAE,MAAmB,EAAE,UAAsB;QACjE,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IACD,YAAY;QACV,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;QAC3D,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;QACD,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACjD,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;SACvE,CAAC;IACJ,CAAC;IACD,KAAK;QACH,OAAO;YACL,IAAI,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE;SACrB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,sBAAsB;IAOjC,YACE,EAAU,EACV,IAAsB,EACtB,IAAoB,EACpB,EAAkB,EAClB,UAAsB;QAEtB,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;QACb,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IACD,YAAY;QACV,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;SAC/D;QACD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;SAC/D;QACD,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;SAC7D;QACD,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACvB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACvB,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE;YACnB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;SACvE,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,QAAQ;IAKnB,YACE,KAAa,EACb,IAA0C,EAC1C,SAAkB;QAElB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IACD,YAAY;QACV,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;YACtC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;YACxC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;QAC7B,OAAO;YACL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,gBAAgB;IAE3B,YAAY,IAAmB;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IACD,YAAY;QACV,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;IACJ,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;IACD,YAAY;QACV,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,YAAY;IACvB,MAAM,CAAC,cAAc,CAAC,IAAI;QACxB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;SAC9D;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE;YACzB,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SAC1C;QACD,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;CACF"}

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/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,47 @@
+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) {
+        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;QAClC,MAAM,IAAI,cAAc,CAAC,gCAAgC,CAAC,CAAC;KAC5D;IACD,IAAI,aAAa,CAAC;IAClB,IAAI;QACF,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;KACxC;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,IAAI,cAAc,CAAC,qCAAqC,CAAC,CAAC;KACjE;IAED,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;QACnC,MAAM,IAAI,cAAc,CAAC,iCAAiC,CAAC,CAAC;KAC7D;IAED,IAAI,cAAc,CAAC;IACnB,IAAI;QACF,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;KAC1C;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,IAAI,cAAc,CAAC,sCAAsC,CAAC,CAAC;KAClE;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;QACnB,MAAM,IAAI,qBAAqB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;KAClD;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,23 @@
 {
   "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.3",
+  "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"
   },
   "files": [
-    "src"
+    "dist"
   ],
   "repository": {
     "type": "git",

package/src/model/index.js

@@ -1,330 +0,0 @@
-export class GraphSchemaRepresentation {
-  /**
-   * @param {string} version
-   * @param {GraphSchema} graphSchema
-   */
-  constructor(version, graphSchema) {
-    this.version = version;
-    this.graphSchema = graphSchema;
-  }
-
-  toJson() {
-    return JSON.stringify({
-      graphSchemaRepresentation: {
-        version: this.version,
-        graphSchema: this.graphSchema.toJsonStruct(),
-      },
-    });
-  }
-
-  static parseJson(jsonString) {
-    const json = JSON.parse(jsonString);
-    const version = json.graphSchemaRepresentation.version;
-    const graphSchema = GraphSchema.fromJsonStruct(
-      json.graphSchemaRepresentation.graphSchema
-    );
-    return new GraphSchemaRepresentation(version, graphSchema);
-  }
-}
-
-export class GraphSchema {
-  /**
-   * @param {NodeLabel[]} nodeLabels
-   * @param {RelationshipType[]} relationshipTypes
-   * @param {NodeObjectType[]} nodeObjectTypes
-   * @param {RelationshipObjectType[]} relationshipObjectTypes
-   */
-  constructor(
-    nodeLabels,
-    relationshipTypes,
-    nodeObjectTypes,
-    relationshipObjectTypes
-  ) {
-    this.nodeLabels = nodeLabels;
-    this.relationshipTypes = relationshipTypes;
-    this.nodeObjectTypes = nodeObjectTypes;
-    this.relationshipObjectTypes = relationshipObjectTypes;
-  }
-  toJsonStruct() {
-    return {
-      nodeLabels: this.nodeLabels.map((nodeLabel) => nodeLabel.toJsonStruct()),
-      relationshipTypes: this.relationshipTypes.map((relationshipType) =>
-        relationshipType.toJsonStruct()
-      ),
-      nodeObjectTypes: this.nodeObjectTypes.map((nodeObjectType) =>
-        nodeObjectType.toJsonStruct()
-      ),
-      relationshipObjectTypes: this.relationshipObjectTypes.map(
-        (relationshipObjectType) => relationshipObjectType.toJsonStruct()
-      ),
-    };
-  }
-
-  static fromJsonStruct(json) {
-    const nodeLabels = json.nodeLabels.map(
-      (nodeLabel) => new NodeLabel(nodeLabel.$id, nodeLabel.token)
-    );
-    const relationshipTypes = json.relationshipTypes.map(
-      (relationshipType) =>
-        new RelationshipType(relationshipType.$id, relationshipType.token)
-    );
-    const nodeObjectTypes = json.nodeObjectTypes.map((nodeObjectType) => {
-      const labels = nodeObjectType.labels
-        .map((label) =>
-          nodeLabels.find((nodeLabel) => nodeLabel.$id === label.$ref.slice(1))
-        )
-        .filter((label) => label);
-      if (labels.length !== nodeObjectType.labels.length) {
-        throw new Error("Not all label references are defined");
-      }
-      return new NodeObjectType(
-        nodeObjectType.$id,
-        labels,
-        nodeObjectType.properties.map(
-          (property) =>
-            new Property(
-              property.token,
-              PropertyType.fromJsonStruct(property.type),
-              property.mandatory
-            )
-        )
-      );
-    });
-    const relationshipObjectTypes = json.relationshipObjectTypes.map(
-      (relationshipObjectType) => {
-        const type = relationshipTypes.find(
-          (relationshipType) =>
-            relationshipType.$id === relationshipObjectType.type.$ref.slice(1)
-        );
-        if (!type) {
-          throw new Error("Not all relationship type references are defined");
-        }
-        const from = nodeObjectTypes.find(
-          (nodeObjectType) =>
-            nodeObjectType.$id === relationshipObjectType.from.$ref.slice(1)
-        );
-        if (!from) {
-          throw new Error(
-            "Not all node object type references in from are defined"
-          );
-        }
-        const to = nodeObjectTypes.find(
-          (nodeObjectType) =>
-            nodeObjectType.$id === relationshipObjectType.to.$ref.slice(1)
-        );
-        if (!to) {
-          throw new Error(
-            "Not all node object type references in to are defined"
-          );
-        }
-        return new RelationshipObjectType(
-          relationshipObjectType.$id,
-          type,
-          from,
-          to,
-          relationshipObjectType.properties.map(
-            (property) =>
-              new Property(
-                property.token,
-                PropertyType.fromJsonStruct(property.type),
-                property.mandatory
-              )
-          )
-        );
-      }
-    );
-    return new GraphSchema(
-      nodeLabels,
-      relationshipTypes,
-      nodeObjectTypes,
-      relationshipObjectTypes
-    );
-  }
-}
-
-export class NodeLabel {
-  /**
-   * @param {string} id
-   * @param {string} token
-   */
-  constructor(id, token) {
-    this.$id = id;
-    this.token = token;
-  }
-  toJsonStruct() {
-    return {
-      $id: this.$id,
-      token: this.token,
-    };
-  }
-  toRef() {
-    return {
-      $ref: `#${this.$id}`,
-    };
-  }
-}
-
-export class RelationshipType {
-  /**
-   * @param {string} id
-   * @param {string} token
-   */
-  constructor(id, token) {
-    this.$id = id;
-    this.token = token;
-  }
-  toJsonStruct() {
-    return {
-      $id: this.$id,
-      token: this.token,
-    };
-  }
-  toRef() {
-    return {
-      $ref: `#${this.$id}`,
-    };
-  }
-}
-
-export class NodeObjectType {
-  /**
-   * @param {string} id
-   * @param {NodeLabel[]} labels
-   * @param {Property[]} properties
-   */
-  constructor(id, labels, properties) {
-    this.$id = id;
-    this.labels = labels;
-    this.properties = properties;
-  }
-  toJsonStruct() {
-    const brokenLabels = this.labels.filter((label) => !label);
-    if (brokenLabels.length > 0) {
-      throw new Error("Not all labels are defined");
-    }
-    return {
-      $id: this.$id,
-      labels: this.labels.map((label) => label.toRef()),
-      properties: this.properties.map((property) => property.toJsonStruct()),
-    };
-  }
-  toRef() {
-    return {
-      $ref: `#${this.$id}`,
-    };
-  }
-}
-
-export class RelationshipObjectType {
-  /**
-   * @param {string} id
-   * @param {RelationshipType} type
-   * @param {NodeObjectType} from
-   * @param {NodeObjectType} to
-   * @param {Property[]} properties
-   */
-  constructor(id, type, from, to, properties) {
-    this.$id = id;
-    this.type = type;
-    this.from = from;
-    this.to = to;
-    this.properties = properties;
-  }
-  toJsonStruct() {
-    if (!this.type) {
-      throw new Error("RelationshipObjectType.type is not defined");
-    }
-    if (!this.from) {
-      throw new Error("RelationshipObjectType.from is not defined");
-    }
-    if (!this.to) {
-      throw new Error("RelationshipObjectType.to is not defined");
-    }
-    return {
-      $id: this.$id,
-      type: this.type.toRef(),
-      from: this.from.toRef(),
-      to: this.to.toRef(),
-      properties: this.properties.map((property) => property.toJsonStruct()),
-    };
-  }
-}
-
-export class Property {
-  /** @type {string} */
-  token;
-  /** @type {PropertyBaseType | PropertyArrayType} */
-  type;
-  /** @type {boolean} */
-  mandatory;
-
-  /**
-   * @param {string} token
-   * @param {PropertyBaseType | PropertyArrayType} type
-   * @param {boolean} [mandatory]
-   */
-  constructor(token, type, mandatory) {
-    this.token = token;
-    this.type = type;
-    this.mandatory = mandatory;
-  }
-  toJsonStruct() {
-    const typeVal = Array.isArray(this.type)
-      ? this.type.map((t) => t.toJsonStruct())
-      : this.type.toJsonStruct();
-    return {
-      type: typeVal,
-      token: this.token,
-      mandatory: this.mandatory,
-    };
-  }
-}
-
-export class PropertyBaseType {
-  /** @type {PropertyTypes} */
-  type;
-
-  /**
-   * @param {PropertyTypes} type
-   */
-  constructor(type) {
-    this.type = type;
-  }
-  toJsonStruct() {
-    return {
-      type: this.type,
-    };
-  }
-}
-
-export class PropertyArrayType {
-  /** @type {PropertyBaseType} */
-  items;
-  /**
-   * @param {PropertyBaseType} items
-   */
-  constructor(items) {
-    this.type = "array";
-    this.items = items;
-  }
-  toJsonStruct() {
-    return {
-      type: this.type,
-      items: this.items,
-    };
-  }
-}
-
-export class PropertyType {
-  static fromJsonStruct(json) {
-    if (Array.isArray(json)) {
-      return json.map((item) => PropertyType.fromJsonStruct(item));
-    }
-    if (json.type === "array") {
-      return new PropertyArrayType(json.items);
-    }
-    return new PropertyBaseType(json.type);
-  }
-}
-
-/** @typedef {"integer" | "string" | "float" | "boolean" | "point" | "date" | "datetime" | "time" | "localtime" | "localdatetime" | "duration"} PropertyTypes */

package/src/types.d.ts

@@ -1,5 +0,0 @@
-export type ValidateSchemaFunction = (jsonSchema: string, graphSchema: string) => boolean;
-
-
-
-

package/src/validation.js

@@ -1,65 +0,0 @@
-import Ajv from "ajv";
-
-const ajv = new Ajv({ strict: false, allErrors: true });
-
-/**
- *
- * @type {import ("./types").ValidateSchemaFunction}
- *
- */
-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) {
-    throw new SchemaValidationError(validate.errors);
-  }
-  return true;
-}
-
-export class SchemaValidationError extends Error {
-  /**
-   * @type {string[]}
-   */
-  messages = [];
-
-  /**
-   * @param {string[]} inputMessages
-   */
-  constructor(inputMessages) {
-    super(inputMessages);
-    this.messages = inputMessages;
-    this.name = "SchemaValidationError";
-  }
-}
-
-export class InputTypeError extends Error {
-  /**
-   * @param {string} message
-   */
-  constructor(message) {
-    super(message);
-    this.name = "InputTypeError";
-  }
-}