ormbridge 0.10.0 → 0.12.0

package/dist/emitters/neo4j.js

@@ -0,0 +1,211 @@
+import { buildGraph, primaryKeyNamesOf, } from './neo4jGraph.js';
+import { oneLine, quoteIdentifier } from './neo4jNames.js';
+import { writeRelationships } from './neo4jRelationships.js';
+import { nodeTarget, StatementWriter, } from './neo4jStatements.js';
+export { isNeo4jStyle, NEO4J_STYLES } from './neo4jTypes.js';
+export function emitNeo4j(schema, options) {
+    const style = options.style ?? 'community';
+    const warnings = schemaWarnings(schema);
+    if (schema.models.length === 0) {
+        return { text: '', warnings };
+    }
+    const graph = buildGraph(schema, { camelFields: options.camelFields }, warnings);
+    const writer = new StatementWriter(style);
+    const sections = [];
+    if (options.header !== false) {
+        sections.push(headerLines(graph, style));
+    }
+    for (const node of graph.nodes) {
+        sections.push(nodeSection(node, writer, warnings));
+    }
+    const relationships = writeRelationships(schema, graph, writer, warnings);
+    if (relationships.lines.length > 0) {
+        sections.push([
+            ...banner('Relationships (documentation; Neo4j keeps no relationship schema)'),
+            ...relationships.lines,
+        ]);
+    }
+    return {
+        text: `${sections.map((lines) => lines.join('\n')).join('\n\n')}\n`,
+        warnings,
+    };
+}
+// ---------------------------------------------------------------------------
+// Warnings for constructs Neo4j has no place for
+// ---------------------------------------------------------------------------
+function schemaWarnings(schema) {
+    const warnings = [];
+    for (const enumDefinition of schema.enums) {
+        if (enumDefinition.schema !== undefined) {
+            warnings.push(`enum ${enumDefinition.name}: the database schema "${enumDefinition.schema}" (@@schema) was ignored.`);
+        }
+    }
+    for (const model of schema.models) {
+        if (model.isView === true) {
+            warnings.push(`${model.name}: this is a database view; it was written as a node label like any other model.`);
+        }
+        if (model.schema !== undefined) {
+            warnings.push(`${model.name}: the database schema "${model.schema}" (@@schema) was ignored.`);
+        }
+    }
+    return warnings;
+}
+// ---------------------------------------------------------------------------
+// Comments
+// ---------------------------------------------------------------------------
+const RULE = `// ${'-'.repeat(75)}`;
+function banner(title) {
+    return [RULE, `// ${title}`, RULE];
+}
+function headerLines(graph, style) {
+    const lines = [
+        '// Neo4j schema (Cypher, Neo4j 5) generated by ormbridge.',
+        style === 'enterprise'
+            ? '// Style: enterprise. Needs Neo4j Enterprise Edition 5.9 or later (IS NOT NULL, NODE KEY and type constraints).'
+            : '// Style: community. IS NOT NULL, NODE KEY and type constraints need Enterprise Edition; use --style enterprise to add them.',
+        '// Every statement uses IF NOT EXISTS, so the script can run again (cypher-shell -f schema.cypher).',
+        '//',
+        '// The graph model is derived: each model is a node label and each foreign key or join table is',
+        '// documented below as a relationship. Neo4j keeps no relationship schema, so the foreign key',
+        '// columns stay as plain properties. Load the nodes first, then create the relationships with the',
+        '// MATCH ... MERGE queries in the relationship comments.',
+    ];
+    const foreignKeys = graph.nodes.flatMap((node) => node.foreignKeys.map((property) => `${node.label}.${property.key}`));
+    if (foreignKeys.length > 0) {
+        lines.push('//', `// Foreign key properties kept: ${foreignKeys.join(', ')}`);
+    }
+    return lines;
+}
+function describeProperty(property) {
+    const notes = [
+        property.required ? 'required' : 'optional',
+        ...property.notes,
+    ];
+    return `//   ${quoteIdentifier(property.key)}: ${property.type.name} (${notes.join('; ')})`;
+}
+// ---------------------------------------------------------------------------
+// One node label
+// ---------------------------------------------------------------------------
+function resolveKeys(node, names) {
+    const keys = [];
+    for (const name of names) {
+        const key = node.keys.get(name);
+        if (key === undefined) {
+            return undefined;
+        }
+        keys.push(key);
+    }
+    return keys;
+}
+function pushAll(target, statement) {
+    if (statement !== undefined) {
+        target.push(statement);
+    }
+}
+function nodeSection(node, writer, warnings) {
+    const model = node.model;
+    const target = nodeTarget(node.label);
+    const lines = banner(`:${quoteIdentifier(node.label)} (model ${oneLine(model.name)}, table ${oneLine(model.tableName)})`);
+    const constraints = [];
+    const typing = [];
+    const indexes = [];
+    const notes = [];
+    const keyed = new Set();
+    // Primary key.
+    const keyNames = primaryKeyNamesOf(model);
+    const keyProperties = resolveKeys(node, keyNames);
+    if (keyNames.length > 0 && keyProperties === undefined) {
+        warnings.push(`${model.name}: the primary key (${keyNames.join(', ')}) names a column that does not exist, so it was dropped.`);
+    }
+    else if (keyProperties !== undefined && keyProperties.length === 1) {
+        pushAll(constraints, writer.unique(target, keyProperties));
+    }
+    else if (keyProperties !== undefined && keyProperties.length > 1) {
+        if (writer.style === 'enterprise') {
+            pushAll(constraints, writer.nodeKey(target, keyProperties));
+            keyProperties.forEach((key) => keyed.add(key));
+        }
+        else {
+            constraints.push(`// Composite primary key (${keyProperties.join(', ')}): NODE KEY needs Enterprise Edition, so a uniqueness constraint is used.`);
+            pushAll(constraints, writer.unique(target, keyProperties));
+        }
+    }
+    // Unique columns and one-to-one foreign keys.
+    for (const field of model.fields) {
+        const key = node.keys.get(field.name);
+        if (field.isUnique && key !== undefined) {
+            pushAll(constraints, writer.unique(target, [key]));
+        }
+    }
+    for (const relation of model.relations) {
+        const key = node.keys.get(relation.name);
+        if (relation.kind === 'oneToOne' && key !== undefined) {
+            pushAll(constraints, writer.unique(target, [key]));
+        }
+    }
+    // Indexes. Uniqueness constraints go first: Neo4j refuses one when a plain index over the same
+    // properties already exists.
+    const ordered = [
+        ...model.indexes.filter(isUniqueIndex),
+        ...model.indexes.filter((index) => !isUniqueIndex(index)),
+    ];
+    for (const index of ordered) {
+        writeIndex(node, index, writer, target, constraints, indexes, warnings);
+    }
+    // Enterprise: existence and type constraints.
+    const required = [];
+    for (const property of node.properties) {
+        if (property.required && !keyed.has(property.key)) {
+            required.push(property.key);
+        }
+    }
+    if (writer.style === 'enterprise') {
+        for (const key of required) {
+            pushAll(constraints, writer.required(target, key));
+        }
+        for (const property of node.properties) {
+            if (property.type.constrainable) {
+                pushAll(typing, writer.typed(target, property.key, property.type));
+            }
+        }
+    }
+    else if (required.length > 0) {
+        notes.push(`// Required properties (IS NOT NULL needs Enterprise Edition): ${required.join(', ')}`);
+    }
+    lines.push(...constraints, ...typing, ...indexes, ...notes);
+    lines.push('//', `// Properties of :${quoteIdentifier(node.label)} and their Neo4j types:`);
+    lines.push(...node.properties.map(describeProperty));
+    return lines;
+}
+function isUniqueIndex(index) {
+    return index.isUnique && index.kind !== 'fulltext';
+}
+/** Writes one IR index as a constraint or an index, or drops it with a warning. */
+function writeIndex(node, index, writer, target, constraints, indexes, warnings) {
+    const label = `${node.model.name} index (${index.fields.join(', ')})`;
+    const keys = resolveKeys(node, index.fields);
+    if (keys === undefined || keys.length === 0) {
+        warnings.push(`${label}: it names a column that does not exist and was dropped.`);
+        return;
+    }
+    if (index.method !== undefined && index.method.toLowerCase() !== 'btree') {
+        warnings.push(`${label}: Neo4j has no ${index.method} index method; the index was dropped.`);
+        return;
+    }
+    const hasOptions = index.clustered !== undefined ||
+        (index.fieldOptions !== undefined &&
+            Object.keys(index.fieldOptions).length > 0);
+    if (hasOptions) {
+        warnings.push(`${label}: clustering, sort order, prefix length and operator class options have no Neo4j equivalent and were dropped.`);
+    }
+    if (index.kind === 'fulltext') {
+        pushAll(indexes, writer.fulltext(target, keys));
+    }
+    else if (index.isUnique) {
+        pushAll(constraints, writer.unique(target, keys));
+    }
+    else {
+        pushAll(indexes, writer.index(target, keys));
+    }
+}
+//# sourceMappingURL=neo4j.js.map

package/dist/emitters/neo4j.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"neo4j.js","sourceRoot":"","sources":["../../src/emitters/neo4j.ts"],"names":[],"mappings":"AACA,OAAO,EACL,UAAU,EACV,iBAAiB,GAIlB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EACL,UAAU,EACV,eAAe,GAEhB,MAAM,sBAAsB,CAAC;AAI9B,OAAO,EAAE,YAAY,EAAE,YAAY,EAAmB,MAAM,iBAAiB,CAAC;AA2B9E,MAAM,UAAU,SAAS,CACvB,MAAgB,EAChB,OAAyB;IAEzB,MAAM,KAAK,GAAe,OAAO,CAAC,KAAK,IAAI,WAAW,CAAC;IACvD,MAAM,QAAQ,GAAa,cAAc,CAAC,MAAM,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC;IAChC,CAAC;IACD,MAAM,KAAK,GAAU,UAAU,CAC7B,MAAM,EACN,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,EACpC,QAAQ,CACT,CAAC;IACF,MAAM,MAAM,GAAoB,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC;IAE3D,MAAM,QAAQ,GAAe,EAAE,CAAC;IAChC,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;QAC7B,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;IAC3C,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAC/B,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IACrD,CAAC;IACD,MAAM,aAAa,GAAG,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC1E,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnC,QAAQ,CAAC,IAAI,CAAC;YACZ,GAAG,MAAM,CACP,mEAAmE,CACpE;YACD,GAAG,aAAa,CAAC,KAAK;SACvB,CAAC,CAAC;IACL,CAAC;IACD,OAAO;QACL,IAAI,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAe,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI;QAC7E,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,iDAAiD;AACjD,8EAA8E;AAE9E,SAAS,cAAc,CAAC,MAAgB;IACtC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QAC1C,IAAI,cAAc,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACxC,QAAQ,CAAC,IAAI,CACX,QAAQ,cAAc,CAAC,IAAI,0BAA0B,cAAc,CAAC,MAAM,2BAA2B,CACtG,CAAC;QACJ,CAAC;IACH,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClC,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,CACX,GAAG,KAAK,CAAC,IAAI,iFAAiF,CAC/F,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC/B,QAAQ,CAAC,IAAI,CACX,GAAG,KAAK,CAAC,IAAI,0BAA0B,KAAK,CAAC,MAAM,2BAA2B,CAC/E,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,8EAA8E;AAC9E,WAAW;AACX,8EAA8E;AAE9E,MAAM,IAAI,GAAW,MAAM,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;AAE5C,SAAS,MAAM,CAAC,KAAa;IAC3B,OAAO,CAAC,IAAI,EAAE,MAAM,KAAK,EAAE,EAAE,IAAI,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,WAAW,CAAC,KAAY,EAAE,KAAiB;IAClD,MAAM,KAAK,GAAa;QACtB,2DAA2D;QAC3D,KAAK,KAAK,YAAY;YACpB,CAAC,CAAC,iHAAiH;YACnH,CAAC,CAAC,8HAA8H;QAClI,qGAAqG;QACrG,IAAI;QACJ,iGAAiG;QACjG,+FAA+F;QAC/F,mGAAmG;QACnG,0DAA0D;KAC3D,CAAC;IACF,MAAM,WAAW,GAAa,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAe,EAAE,EAAE,CACpE,IAAI,CAAC,WAAW,CAAC,GAAG,CAClB,CAAC,QAAuB,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,QAAQ,CAAC,GAAG,EAAE,CAC7D,CACF,CAAC;IACF,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CACR,IAAI,EACJ,mCAAmC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC5D,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,gBAAgB,CAAC,QAAuB;IAC/C,MAAM,KAAK,GAAa;QACtB,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU;QAC3C,GAAG,QAAQ,CAAC,KAAK;KAClB,CAAC;IACF,OAAO,QAAQ,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;AAC9F,CAAC;AAED,8EAA8E;AAC9E,iBAAiB;AACjB,8EAA8E;AAE9E,SAAS,WAAW,CAAC,IAAe,EAAE,KAAe;IACnD,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,GAAG,GAAuB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,OAAO,CAAC,MAAgB,EAAE,SAA6B;IAC9D,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACzB,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAClB,IAAe,EACf,MAAuB,EACvB,QAAkB;IAElB,MAAM,KAAK,GAAY,IAAI,CAAC,KAAK,CAAC;IAClC,MAAM,MAAM,GAAiB,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,KAAK,GAAa,MAAM,CAC5B,IAAI,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CACpG,CAAC;IACF,MAAM,WAAW,GAAa,EAAE,CAAC;IACjC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,KAAK,GAAgB,IAAI,GAAG,EAAU,CAAC;IAE7C,eAAe;IACf,MAAM,QAAQ,GAAa,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,aAAa,GAAyB,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QACvD,QAAQ,CAAC,IAAI,CACX,GAAG,KAAK,CAAC,IAAI,sBAAsB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,0DAA0D,CACjH,CAAC;IACJ,CAAC;SAAM,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;IAC7D,CAAC;SAAM,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnE,IAAI,MAAM,CAAC,KAAK,KAAK,YAAY,EAAE,CAAC;YAClC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;YAC5D,aAAa,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACzD,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,IAAI,CACd,6BAA6B,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,2EAA2E,CACjI,CAAC;YACF,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IAED,8CAA8C;IAC9C,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjC,MAAM,GAAG,GAAuB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1D,IAAI,KAAK,CAAC,QAAQ,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACxC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IACD,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QACvC,MAAM,GAAG,GAAuB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,QAAQ,CAAC,IAAI,KAAK,UAAU,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtD,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAED,+FAA+F;IAC/F,6BAA6B;IAC7B,MAAM,OAAO,GAAc;QACzB,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC;QACtC,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;KACnE,CAAC;IACF,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC1E,CAAC;IAED,8CAA8C;IAC9C,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;QACvC,IAAI,QAAQ,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAClD,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,KAAK,YAAY,EAAE,CAAC;QAClC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;QACrD,CAAC;QACD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACvC,IAAI,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;gBAChC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;YACrE,CAAC;QACH,CAAC;IACH,CAAC;SAAM,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,KAAK,CAAC,IAAI,CACR,kEAAkE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACxF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,EAAE,GAAG,KAAK,CAAC,CAAC;IAC5D,KAAK,CAAC,IAAI,CACR,IAAI,EACJ,qBAAqB,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,yBAAyB,CAC1E,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACrD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC;AACrD,CAAC;AAED,mFAAmF;AACnF,SAAS,UAAU,CACjB,IAAe,EACf,KAAc,EACd,MAAuB,EACvB,MAAoB,EACpB,WAAqB,EACrB,OAAiB,EACjB,QAAkB;IAElB,MAAM,KAAK,GAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,WAAW,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IAC9E,MAAM,IAAI,GAAyB,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACnE,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5C,QAAQ,CAAC,IAAI,CACX,GAAG,KAAK,0DAA0D,CACnE,CAAC;QACF,OAAO;IACT,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,OAAO,EAAE,CAAC;QACzE,QAAQ,CAAC,IAAI,CACX,GAAG,KAAK,kBAAkB,KAAK,CAAC,MAAM,uCAAuC,CAC9E,CAAC;QACF,OAAO;IACT,CAAC;IACD,MAAM,UAAU,GACd,KAAK,CAAC,SAAS,KAAK,SAAS;QAC7B,CAAC,KAAK,CAAC,YAAY,KAAK,SAAS;YAC/B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAChD,IAAI,UAAU,EAAE,CAAC;QACf,QAAQ,CAAC,IAAI,CACX,GAAG,KAAK,+GAA+G,CACxH,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAC9B,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAClD,CAAC;SAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QAC1B,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACpD,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC"}

package/dist/emitters/neo4jGraph.d.ts

@@ -0,0 +1,57 @@
+import type { IrField, IrModel, IrRelation, IrSchema } from '../ir.js';
+import { type Neo4jType } from './neo4jTypes.js';
+/**
+ * The graph model derived from the IR: one node per model, except pure join tables, which become a
+ * single relationship. The statement and comment writers read this model and never the IR directly.
+ */
+/** A property of a node (or of a relationship, for the extra columns of a join table). */
+export interface GraphProperty {
+    /** The property key as written in Cypher (before quoting). */
+    key: string;
+    /** The IR field name, or the relation name for a foreign key column. */
+    irName: string;
+    type: Neo4jType;
+    required: boolean;
+    /** Short remarks shown in the property comment block, for example `primary key`. */
+    notes: string[];
+}
+export interface GraphNode {
+    model: IrModel;
+    label: string;
+    properties: GraphProperty[];
+    /** IR field name, relation name and column name to property key. */
+    keys: Map<string, string>;
+    /** The foreign key properties (a subset of `properties`). */
+    foreignKeys: GraphProperty[];
+}
+/** A join table written as one relationship. */
+export interface GraphJoin {
+    model: IrModel;
+    from: IrRelation;
+    to: IrRelation;
+    type: string;
+    /** The surrogate key column that was dropped, if the table had one. */
+    surrogateKey?: IrField;
+    /** Columns beyond the two foreign keys; they become relationship properties. */
+    extras: GraphProperty[];
+    /** Property keys of the two foreign keys on the join table, in `from`, `to` order. */
+    pairColumns: [string, string];
+    keys: Map<string, string>;
+}
+export interface Graph {
+    nodes: GraphNode[];
+    joins: GraphJoin[];
+    byModel: Map<string, GraphNode>;
+}
+export interface GraphOptions {
+    camelFields: boolean;
+}
+/** IR names (fields and relations) that make up the primary key of a model. */
+export declare function primaryKeyNamesOf(model: IrModel): string[];
+/** The field a foreign key points at: `toField`, or the single primary key field of the target. */
+export declare function referencedField(schema: IrSchema, relation: IrRelation): IrField | undefined;
+/**
+ * Derives the graph model. Warnings for dropped or approximated details are added to `warnings`
+ * in model order.
+ */
+export declare function buildGraph(schema: IrSchema, options: GraphOptions, warnings: string[]): Graph;

package/dist/emitters/neo4jGraph.js

@@ -0,0 +1,311 @@
+import { findModel } from '../ir.js';
+import { enumValuesOf, mapFieldType, } from './neo4jTypes.js';
+import { labelOf, NameRegistry, oneLine, propertyKeyOf, relationshipTypeOf, } from './neo4jNames.js';
+/** IR names (fields and relations) that make up the primary key of a model. */
+export function primaryKeyNamesOf(model) {
+    if (model.compositePrimaryKey !== undefined &&
+        model.compositePrimaryKey.length > 0) {
+        return model.compositePrimaryKey;
+    }
+    return [
+        ...model.fields
+            .filter((field) => field.isPrimaryKey)
+            .map((field) => field.name),
+        ...model.relations
+            .filter((relation) => relation.isPrimaryKey === true)
+            .map((relation) => relation.name),
+    ];
+}
+/** The field a foreign key points at: `toField`, or the single primary key field of the target. */
+export function referencedField(schema, relation) {
+    const target = findModel(schema, relation.targetModel);
+    if (target === undefined) {
+        return undefined;
+    }
+    if (relation.toField !== undefined) {
+        return target.fields.find((field) => field.name === relation.toField || field.columnName === relation.toField);
+    }
+    const keys = target.fields.filter((field) => field.isPrimaryKey);
+    return keys.length === 1 ? keys[0] : undefined;
+}
+function describeDefault(field) {
+    const value = field.default;
+    if (value === undefined) {
+        return undefined;
+    }
+    switch (value.kind) {
+        case 'literal':
+            return `the default ${JSON.stringify(value.value)}`;
+        case 'autoIncrement':
+            return undefined;
+        case 'now':
+            return 'the default of the current time';
+        case 'uuid':
+            return 'the default of a generated UUID';
+        case 'enumValue':
+            return `the default "${value.value}"`;
+        case 'clientGenerated':
+            return `the ${value.generator}() default`;
+        case 'dbExpression':
+            return `the database default ${oneLine(value.expression)}`;
+    }
+}
+function fieldWarnings(context, model, field, mapping) {
+    const label = `${model.name}.${field.name}`;
+    if (mapping.warning !== undefined) {
+        context.warnings.push(`${label}: ${mapping.warning}`);
+    }
+    const defaultText = describeDefault(field);
+    if (defaultText !== undefined) {
+        context.warnings.push(`${label}: ${defaultText} has no Neo4j schema representation and was dropped; set the value when you create the node.`);
+    }
+    if (field.default?.kind === 'autoIncrement') {
+        context.warnings.push(`${label}: auto-increment has no Neo4j equivalent; supply the value yourself (or use randomUUID() and a STRING key).`);
+    }
+    if (field.generated !== undefined) {
+        context.warnings.push(`${label}: the generated column expression (${oneLine(field.generated.expression)}) is not computed by Neo4j; the property is a plain value.`);
+    }
+    if (field.isAutoUpdated) {
+        context.warnings.push(`${label}: the value is refreshed on every save in the source; Neo4j has no such feature, so set it in your queries.`);
+    }
+}
+function fieldProperty(context, model, field) {
+    const mapping = mapFieldType(field);
+    fieldWarnings(context, model, field, mapping);
+    const notes = [];
+    if (field.isPrimaryKey) {
+        notes.push('primary key');
+    }
+    else if (field.isUnique) {
+        notes.push('unique');
+    }
+    const values = enumValuesOf(field, context.schema.enums);
+    if (values.length > 0) {
+        notes.push(`one of: ${values.map((value) => `"${oneLine(value)}"`).join(', ')}`);
+    }
+    if (field.type === 'decimal' && field.maxDigits !== undefined) {
+        notes.push(`decimal with ${field.maxDigits} digits${field.decimalPlaces === undefined
+            ? ''
+            : `, ${field.decimalPlaces} after the point`}`);
+    }
+    return {
+        key: propertyKeyOf(field.columnName, context.options.camelFields),
+        irName: field.name,
+        type: mapping.type,
+        required: !field.isNullable,
+        notes,
+    };
+}
+/** Maps a foreign key to a property typed like the column it references. */
+function foreignKeyProperty(context, relation, targetKey) {
+    const referenced = referencedField(context.schema, relation);
+    const type = referenced === undefined
+        ? { name: 'INTEGER', constrainable: true }
+        : mapFieldType({ ...referenced, arrayDepth: undefined }).type;
+    const notes = [
+        `foreign key to ${relation.targetModel}${targetKey === undefined ? '' : `.${targetKey}`}`,
+    ];
+    if (relation.isPrimaryKey === true) {
+        notes.unshift('primary key');
+    }
+    return {
+        key: propertyKeyOf(relation.columnName, context.options.camelFields),
+        irName: relation.name,
+        type,
+        required: !relation.isNullable,
+        notes,
+    };
+}
+function targetKeyName(context, relation) {
+    const referenced = referencedField(context.schema, relation);
+    return referenced === undefined
+        ? undefined
+        : propertyKeyOf(referenced.columnName, context.options.camelFields);
+}
+/** Properties of a model: its columns, then one property per foreign key column. */
+function buildProperties(context, model) {
+    const properties = [];
+    const keys = new Map();
+    const foreignKeys = [];
+    const taken = new Set();
+    for (const field of model.fields) {
+        const property = fieldProperty(context, model, field);
+        keys.set(field.name, property.key);
+        keys.set(field.columnName, property.key);
+        if (!taken.has(property.key)) {
+            taken.add(property.key);
+            properties.push(property);
+        }
+    }
+    for (const relation of model.relations) {
+        if (relation.kind === 'manyToMany') {
+            continue;
+        }
+        const property = foreignKeyProperty(context, relation, targetKeyName(context, relation));
+        keys.set(relation.name, property.key);
+        keys.set(relation.columnName, property.key);
+        if (!taken.has(property.key)) {
+            taken.add(property.key);
+            properties.push(property);
+            foreignKeys.push(property);
+        }
+    }
+    return { properties, keys, foreignKeys };
+}
+function maxLengthWarning(model) {
+    const names = model.fields
+        .filter((field) => field.maxLength !== undefined)
+        .map((field) => field.name);
+    return names.length === 0
+        ? undefined
+        : `${model.name}: the maximum length of ${names.join(', ')} has no Neo4j schema representation and was dropped.`;
+}
+function referencedElsewhere(schema, model) {
+    return schema.models.some((other) => other.relations.some((relation) => relation.targetModel === model.name) ||
+        (other.compositeForeignKeys ?? []).some((key) => key.targetModel === model.name));
+}
+function relationMatches(relation, name) {
+    return relation.name === name || relation.columnName === name;
+}
+function hasUniquePair(model, a, b) {
+    return model.indexes.some((index) => index.isUnique &&
+        index.kind === undefined &&
+        index.fields.length === 2 &&
+        index.fields.some((name) => relationMatches(a, name)) &&
+        index.fields.some((name) => relationMatches(b, name)));
+}
+/**
+ * A pure join table has exactly two required foreign keys, nothing else refers to it, and either the
+ * two keys together are its primary key or a surrogate key column is paired with a unique pair of
+ * the two keys (the table Django and Prisma write for a many-to-many field).
+ */
+function joinCandidate(schema, model) {
+    if (model.isView === true ||
+        (model.compositeForeignKeys ?? []).length > 0 ||
+        model.relations.length !== 2 ||
+        referencedElsewhere(schema, model)) {
+        return undefined;
+    }
+    const [from, to] = model.relations;
+    if (from === undefined ||
+        to === undefined ||
+        from.kind !== 'foreignKey' ||
+        to.kind !== 'foreignKey' ||
+        from.isNullable ||
+        to.isNullable) {
+        return undefined;
+    }
+    const keyNames = primaryKeyNamesOf(model);
+    const keyIsPair = keyNames.length === 2 &&
+        keyNames.every((name) => relationMatches(from, name) || relationMatches(to, name));
+    if (keyIsPair) {
+        return { model, from, to };
+    }
+    const surrogate = keyNames.length === 1
+        ? model.fields.find((field) => field.name === keyNames[0])
+        : undefined;
+    if (surrogate !== undefined &&
+        (model.isJoinTable === true || hasUniquePair(model, from, to))) {
+        return { model, from, to, surrogateKey: surrogate };
+    }
+    return undefined;
+}
+function joinType(join) {
+    return relationshipTypeOf(join.from.relatedName ?? join.to.name);
+}
+/**
+ * Derives the graph model. Warnings for dropped or approximated details are added to `warnings`
+ * in model order.
+ */
+export function buildGraph(schema, options, warnings) {
+    const context = { schema, options, warnings };
+    const candidates = new Map();
+    for (const model of schema.models) {
+        const candidate = joinCandidate(schema, model);
+        if (candidate !== undefined) {
+            candidates.set(model.name, candidate);
+        }
+    }
+    // A join table that points at another join table stays an ordinary node, so both ends exist.
+    for (const [name, candidate] of [...candidates]) {
+        if (candidates.has(candidate.from.targetModel) ||
+            candidates.has(candidate.to.targetModel) ||
+            findModel(schema, candidate.from.targetModel) === undefined ||
+            findModel(schema, candidate.to.targetModel) === undefined) {
+            candidates.delete(name);
+        }
+    }
+    const labels = new NameRegistry();
+    const nodes = [];
+    const joins = [];
+    const byModel = new Map();
+    for (const model of schema.models) {
+        const candidate = candidates.get(model.name);
+        if (candidate !== undefined) {
+            continue;
+        }
+        const wanted = labelOf(model.name);
+        const label = labels.claim(wanted);
+        if (label !== wanted) {
+            warnings.push(`${model.name}: the label ${wanted} is already used by another model; this model uses ${label}.`);
+        }
+        const built = buildProperties(context, model);
+        const node = {
+            model,
+            label,
+            properties: built.properties,
+            keys: built.keys,
+            foreignKeys: built.foreignKeys,
+        };
+        nodes.push(node);
+        byModel.set(model.name, node);
+        const lengths = maxLengthWarning(model);
+        if (lengths !== undefined) {
+            warnings.push(lengths);
+        }
+    }
+    for (const model of schema.models) {
+        const candidate = candidates.get(model.name);
+        if (candidate === undefined) {
+            continue;
+        }
+        joins.push(buildJoin(context, candidate));
+    }
+    return { nodes, joins, byModel };
+}
+function buildJoin(context, candidate) {
+    const { model, from, to, surrogateKey } = candidate;
+    const extras = model.fields
+        .filter((field) => field !== surrogateKey)
+        .map((field) => fieldProperty(context, model, field));
+    const keys = new Map();
+    for (const field of model.fields) {
+        keys.set(field.name, propertyKeyOf(field.columnName, context.options.camelFields));
+    }
+    if (surrogateKey !== undefined) {
+        context.warnings.push(`${model.name}: the join table became a relationship, so its surrogate key ${surrogateKey.name} was dropped.`);
+    }
+    const lengths = maxLengthWarning(model);
+    if (lengths !== undefined) {
+        context.warnings.push(lengths);
+    }
+    const pairColumns = [
+        propertyKeyOf(from.columnName, context.options.camelFields),
+        propertyKeyOf(to.columnName, context.options.camelFields),
+    ];
+    keys.set(from.name, pairColumns[0]);
+    keys.set(from.columnName, pairColumns[0]);
+    keys.set(to.name, pairColumns[1]);
+    keys.set(to.columnName, pairColumns[1]);
+    return {
+        model,
+        from,
+        to,
+        type: joinType(candidate),
+        ...(surrogateKey === undefined ? {} : { surrogateKey }),
+        extras,
+        pairColumns,
+        keys,
+    };
+}
+//# sourceMappingURL=neo4jGraph.js.map

package/dist/emitters/neo4jGraph.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"neo4jGraph.js","sourceRoot":"","sources":["../../src/emitters/neo4jGraph.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EACL,YAAY,EACZ,YAAY,GAGb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,OAAO,EACP,YAAY,EACZ,OAAO,EACP,aAAa,EACb,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AA6DzB,+EAA+E;AAC/E,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,IACE,KAAK,CAAC,mBAAmB,KAAK,SAAS;QACvC,KAAK,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,EACpC,CAAC;QACD,OAAO,KAAK,CAAC,mBAAmB,CAAC;IACnC,CAAC;IACD,OAAO;QACL,GAAG,KAAK,CAAC,MAAM;aACZ,MAAM,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC;aAC9C,GAAG,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;QACtC,GAAG,KAAK,CAAC,SAAS;aACf,MAAM,CAAC,CAAC,QAAoB,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,KAAK,IAAI,CAAC;aAChE,GAAG,CAAC,CAAC,QAAoB,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;KAChD,CAAC;AACJ,CAAC;AAED,mGAAmG;AACnG,MAAM,UAAU,eAAe,CAC7B,MAAgB,EAChB,QAAoB;IAEpB,MAAM,MAAM,GAAwB,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IAC5E,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CACvB,CAAC,KAAc,EAAE,EAAE,CACjB,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,OAAO,IAAI,KAAK,CAAC,UAAU,KAAK,QAAQ,CAAC,OAAO,CAC3E,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAc,MAAM,CAAC,MAAM,CAAC,MAAM,CAC1C,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CACvC,CAAC;IACF,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACjD,CAAC;AAED,SAAS,eAAe,CAAC,KAAc;IACrC,MAAM,KAAK,GAAuB,KAAK,CAAC,OAAO,CAAC;IAChD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,SAAS;YACZ,OAAO,eAAe,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QACtD,KAAK,eAAe;YAClB,OAAO,SAAS,CAAC;QACnB,KAAK,KAAK;YACR,OAAO,iCAAiC,CAAC;QAC3C,KAAK,MAAM;YACT,OAAO,iCAAiC,CAAC;QAC3C,KAAK,WAAW;YACd,OAAO,gBAAgB,KAAK,CAAC,KAAK,GAAG,CAAC;QACxC,KAAK,iBAAiB;YACpB,OAAO,OAAO,KAAK,CAAC,SAAS,YAAY,CAAC;QAC5C,KAAK,cAAc;YACjB,OAAO,wBAAwB,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CACpB,OAAqB,EACrB,KAAc,EACd,KAAc,EACd,OAAyB;IAEzB,MAAM,KAAK,GAAW,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;IACpD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACxD,CAAC;IACD,MAAM,WAAW,GAAuB,eAAe,CAAC,KAAK,CAAC,CAAC;IAC/D,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,CAAC,QAAQ,CAAC,IAAI,CACnB,GAAG,KAAK,KAAK,WAAW,8FAA8F,CACvH,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,EAAE,IAAI,KAAK,eAAe,EAAE,CAAC;QAC5C,OAAO,CAAC,QAAQ,CAAC,IAAI,CACnB,GAAG,KAAK,6GAA6G,CACtH,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO,CAAC,QAAQ,CAAC,IAAI,CACnB,GAAG,KAAK,sCAAsC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,4DAA4D,CAC9I,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;QACxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CACnB,GAAG,KAAK,6GAA6G,CACtH,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CACpB,OAAqB,EACrB,KAAc,EACd,KAAc;IAEd,MAAM,OAAO,GAAqB,YAAY,CAAC,KAAK,CAAC,CAAC;IACtD,aAAa,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC5B,CAAC;SAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvB,CAAC;IACD,MAAM,MAAM,GAAa,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACnE,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,KAAK,CAAC,IAAI,CACR,WAAW,MAAM,CAAC,GAAG,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC7E,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAC9D,KAAK,CAAC,IAAI,CACR,gBAAgB,KAAK,CAAC,SAAS,UAC7B,KAAK,CAAC,aAAa,KAAK,SAAS;YAC/B,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,KAAK,KAAK,CAAC,aAAa,kBAC9B,EAAE,CACH,CAAC;IACJ,CAAC;IACD,OAAO;QACL,GAAG,EAAE,aAAa,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;QACjE,MAAM,EAAE,KAAK,CAAC,IAAI;QAClB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,QAAQ,EAAE,CAAC,KAAK,CAAC,UAAU;QAC3B,KAAK;KACN,CAAC;AACJ,CAAC;AAED,4EAA4E;AAC5E,SAAS,kBAAkB,CACzB,OAAqB,EACrB,QAAoB,EACpB,SAA6B;IAE7B,MAAM,UAAU,GAAwB,eAAe,CACrD,OAAO,CAAC,MAAM,EACd,QAAQ,CACT,CAAC;IACF,MAAM,IAAI,GACR,UAAU,KAAK,SAAS;QACtB,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE;QAC1C,CAAC,CAAC,YAAY,CAAC,EAAE,GAAG,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC;IAClE,MAAM,KAAK,GAAa;QACtB,kBAAkB,QAAQ,CAAC,WAAW,GAAG,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,EAAE;KAC1F,CAAC;IACF,IAAI,QAAQ,CAAC,YAAY,KAAK,IAAI,EAAE,CAAC;QACnC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO;QACL,GAAG,EAAE,aAAa,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;QACpE,MAAM,EAAE,QAAQ,CAAC,IAAI;QACrB,IAAI;QACJ,QAAQ,EAAE,CAAC,QAAQ,CAAC,UAAU;QAC9B,KAAK;KACN,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CACpB,OAAqB,EACrB,QAAoB;IAEpB,MAAM,UAAU,GAAwB,eAAe,CACrD,OAAO,CAAC,MAAM,EACd,QAAQ,CACT,CAAC;IACF,OAAO,UAAU,KAAK,SAAS;QAC7B,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;AACxE,CAAC;AAED,oFAAoF;AACpF,SAAS,eAAe,CACtB,OAAqB,EACrB,KAAc;IAMd,MAAM,UAAU,GAAoB,EAAE,CAAC;IACvC,MAAM,IAAI,GAAwB,IAAI,GAAG,EAAkB,CAAC;IAC5D,MAAM,WAAW,GAAoB,EAAE,CAAC;IACxC,MAAM,KAAK,GAAgB,IAAI,GAAG,EAAU,CAAC;IAC7C,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAkB,aAAa,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QACrE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACxB,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QACvC,IAAI,QAAQ,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YACnC,SAAS;QACX,CAAC;QACD,MAAM,QAAQ,GAAkB,kBAAkB,CAChD,OAAO,EACP,QAAQ,EACR,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CACjC,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC5C,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACxB,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC1B,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IACD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;AAC3C,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,MAAM,KAAK,GAAa,KAAK,CAAC,MAAM;SACjC,MAAM,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;SACzD,GAAG,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACvC,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;QACvB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,2BAA2B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,sDAAsD,CAAC;AACrH,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAgB,EAAE,KAAc;IAC3D,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CACvB,CAAC,KAAc,EAAE,EAAE,CACjB,KAAK,CAAC,SAAS,CAAC,IAAI,CAClB,CAAC,QAAoB,EAAE,EAAE,CAAC,QAAQ,CAAC,WAAW,KAAK,KAAK,CAAC,IAAI,CAC9D;QACD,CAAC,KAAK,CAAC,oBAAoB,IAAI,EAAE,CAAC,CAAC,IAAI,CACrC,CAAC,GAA0B,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,KAAK,KAAK,CAAC,IAAI,CAC/D,CACJ,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,QAAoB,EAAE,IAAY;IACzD,OAAO,QAAQ,CAAC,IAAI,KAAK,IAAI,IAAI,QAAQ,CAAC,UAAU,KAAK,IAAI,CAAC;AAChE,CAAC;AAED,SAAS,aAAa,CAAC,KAAc,EAAE,CAAa,EAAE,CAAa;IACjE,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CACvB,CAAC,KAAc,EAAE,EAAE,CACjB,KAAK,CAAC,QAAQ;QACd,KAAK,CAAC,IAAI,KAAK,SAAS;QACxB,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;QACzB,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAC7D,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAChE,CAAC;AACJ,CAAC;AASD;;;;GAIG;AACH,SAAS,aAAa,CACpB,MAAgB,EAChB,KAAc;IAEd,IACE,KAAK,CAAC,MAAM,KAAK,IAAI;QACrB,CAAC,KAAK,CAAC,oBAAoB,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC;QAC7C,KAAK,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;QAC5B,mBAAmB,CAAC,MAAM,EAAE,KAAK,CAAC,EAClC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,GAA+B,KAAK,CAAC,SAAS,CAAC;IAC/D,IACE,IAAI,KAAK,SAAS;QAClB,EAAE,KAAK,SAAS;QAChB,IAAI,CAAC,IAAI,KAAK,YAAY;QAC1B,EAAE,CAAC,IAAI,KAAK,YAAY;QACxB,IAAI,CAAC,UAAU;QACf,EAAE,CAAC,UAAU,EACb,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,QAAQ,GAAa,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,SAAS,GACb,QAAQ,CAAC,MAAM,KAAK,CAAC;QACrB,QAAQ,CAAC,KAAK,CACZ,CAAC,IAAY,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,eAAe,CAAC,EAAE,EAAE,IAAI,CAAC,CAC3E,CAAC;IACJ,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IAC7B,CAAC;IACD,MAAM,SAAS,GACb,QAAQ,CAAC,MAAM,KAAK,CAAC;QACnB,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC;QACnE,CAAC,CAAC,SAAS,CAAC;IAChB,IACE,SAAS,KAAK,SAAS;QACvB,CAAC,KAAK,CAAC,WAAW,KAAK,IAAI,IAAI,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,EAC9D,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC;IACtD,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,QAAQ,CAAC,IAAmB;IACnC,OAAO,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;AACnE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CACxB,MAAgB,EAChB,OAAqB,EACrB,QAAkB;IAElB,MAAM,OAAO,GAAiB,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;IAC5D,MAAM,UAAU,GAA+B,IAAI,GAAG,EAGnD,CAAC;IACJ,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClC,MAAM,SAAS,GAA8B,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC1E,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IACD,6FAA6F;IAC7F,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC;QAChD,IACE,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC;YAC1C,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC;YACxC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,SAAS;YAC3D,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,SAAS,EACzD,CAAC;YACD,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAiB,IAAI,YAAY,EAAE,CAAC;IAChD,MAAM,KAAK,GAAgB,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAgB,EAAE,CAAC;IAC9B,MAAM,OAAO,GAA2B,IAAI,GAAG,EAAqB,CAAC;IACrE,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClC,MAAM,SAAS,GAA8B,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;QACD,MAAM,MAAM,GAAW,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,KAAK,GAAW,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;YACrB,QAAQ,CAAC,IAAI,CACX,GAAG,KAAK,CAAC,IAAI,eAAe,MAAM,sDAAsD,KAAK,GAAG,CACjG,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9C,MAAM,IAAI,GAAc;YACtB,KAAK;YACL,KAAK;YACL,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,WAAW,EAAE,KAAK,CAAC,WAAW;SAC/B,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9B,MAAM,OAAO,GAAuB,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClC,MAAM,SAAS,GAA8B,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AACnC,CAAC;AAED,SAAS,SAAS,CAAC,OAAqB,EAAE,SAAwB;IAChE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,YAAY,EAAE,GAAG,SAAS,CAAC;IACpD,MAAM,MAAM,GAAoB,KAAK,CAAC,MAAM;SACzC,MAAM,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK,KAAK,YAAY,CAAC;SAClD,GAAG,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;IACjE,MAAM,IAAI,GAAwB,IAAI,GAAG,EAAkB,CAAC;IAC5D,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjC,IAAI,CAAC,GAAG,CACN,KAAK,CAAC,IAAI,EACV,aAAa,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAC7D,CAAC;IACJ,CAAC;IACD,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,CAAC,QAAQ,CAAC,IAAI,CACnB,GAAG,KAAK,CAAC,IAAI,gEAAgE,YAAY,CAAC,IAAI,eAAe,CAC9G,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAuB,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC5D,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IACD,MAAM,WAAW,GAAqB;QACpC,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;QAC3D,aAAa,CAAC,EAAE,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;KAC1D,CAAC;IACF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAClC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACxC,OAAO;QACL,KAAK;QACL,IAAI;QACJ,EAAE;QACF,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC;QACzB,GAAG,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC;QACvD,MAAM;QACN,WAAW;QACX,IAAI;KACL,CAAC;AACJ,CAAC"}

package/dist/emitters/neo4jNames.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Writes a label, relationship type, property key or constraint name. Names that are not plain
+ * identifiers are wrapped in backticks, and a backtick inside the name is doubled.
+ */
+export declare function quoteIdentifier(name: string): string;
+/** Collapses line breaks and runs of whitespace so text can sit safely inside a one-line `//` comment. */
+export declare function oneLine(text: string): string;
+/** Node label of a model: PascalCase and singular (`blog_posts` and `BlogPosts` both give `BlogPost`). */
+export declare function labelOf(modelName: string): string;
+/** Relationship type of a relation field: UPPER_SNAKE_CASE (`edited_by` and `editedBy` give `EDITED_BY`). */
+export declare function relationshipTypeOf(relationName: string): string;
+/**
+ * Property key of a column. The `preserve` naming mode keeps the column name; `normalize` uses
+ * camelCase, the Neo4j convention. A name with no letters or digits is kept as it is.
+ */
+export declare function propertyKeyOf(columnName: string, camelCase: boolean): string;
+/** Hands out names that are unique within one namespace (labels, or constraint and index names). */
+export declare class NameRegistry {
+    private readonly used;
+    /** Reserves `base`, or `base2`, `base3`, ... when it is taken, and returns the name reserved. */
+    claim(base: string): string;
+    has(name: string): boolean;
+}
+/** snake_case words for a constraint or index name (`x` when the text has no letters or digits). */
+export declare function nameWords(text: string): string;