ormbridge 0.11.0 → 0.12.0

package/dist/emitters/neo4jRelationships.js

@@ -0,0 +1,240 @@
+import { findModel } from '../ir.js';
+import { referencedField, } from './neo4jGraph.js';
+import { quoteIdentifier, relationshipTypeOf } from './neo4jNames.js';
+import { relationshipTarget } from './neo4jStatements.js';
+function pattern(source, type, target) {
+    return `(:${quoteIdentifier(source)})-[:${quoteIdentifier(type)}]->(:${quoteIdentifier(target)})`;
+}
+function propertyReference(variable, key) {
+    return `${variable}.${quoteIdentifier(key)}`;
+}
+function onDeleteText(action, source, target, key) {
+    switch (action) {
+        case 'cascade':
+            return `cascade (delete the ${source} when its ${target} is deleted)`;
+        case 'setNull':
+            return `set null (set ${key} to null when the ${target} is deleted)`;
+        case 'setDefault':
+            return `set default (reset ${key} when the ${target} is deleted)`;
+        case 'restrict':
+        case 'noAction':
+            return `${action === 'restrict' ? 'restrict' : 'no action'} (do not delete a ${target} that still has ${source} nodes)`;
+    }
+}
+function comment(lines) {
+    return lines.map((line) => (line === '' ? '//' : `// ${line}`));
+}
+/** The key property of the node a relation points at, or undefined for a composite or unknown key. */
+function targetKey(schema, graph, relation) {
+    const referenced = referencedField(schema, relation);
+    const node = graph.byModel.get(relation.targetModel);
+    return referenced === undefined || node === undefined
+        ? undefined
+        : node.keys.get(referenced.name);
+}
+function foreignKeyBlock(schema, graph, node, relation, warnings) {
+    const target = graph.byModel.get(relation.targetModel);
+    if (target === undefined) {
+        warnings.push(`${node.model.name}.${relation.name}: the target model ${relation.targetModel} is not in the schema, so the relationship was not documented.`);
+        return [];
+    }
+    const type = relationshipTypeOf(relation.name);
+    const key = node.keys.get(relation.name) ?? relation.columnName;
+    const referencedKey = targetKey(schema, graph, relation);
+    const cardinality = relation.kind === 'oneToOne'
+        ? `one ${node.label} to one ${target.label}`
+        : `many ${node.label} to one ${target.label}`;
+    const lines = [
+        pattern(node.label, type, target.label),
+        `  ${cardinality}, ${relation.isNullable ? 'optional' : 'required'}.`,
+        `  foreign key property: ${node.label}.${key}${referencedKey === undefined ? '' : ` references ${target.label}.${referencedKey}`}`,
+        `  on delete: ${onDeleteText(relation.onDelete, node.label, target.label, key)}; Neo4j does not enforce it.`,
+    ];
+    if (relation.onUpdate !== undefined) {
+        lines.push(`  on update: ${relation.onUpdate}; Neo4j does not enforce it.`);
+    }
+    if (relation.relatedName !== undefined) {
+        lines.push(`  reverse accessor in the source: ${target.label}.${relation.relatedName}`);
+    }
+    if (referencedKey !== undefined) {
+        lines.push(`  create: MATCH (s:${quoteIdentifier(node.label)}), (t:${quoteIdentifier(target.label)}) WHERE ${propertyReference('s', key)} = ${propertyReference('t', referencedKey)} MERGE (s)-[:${quoteIdentifier(type)}]->(t);`);
+    }
+    warnings.push(`${node.model.name}.${relation.name}: Neo4j keeps no relationship schema, so the foreign key to ${relation.targetModel} (on delete ${relation.onDelete}) is only documented in a comment; the ${key} property was kept.`);
+    return comment(lines);
+}
+function compositeKeyBlock(graph, node, key, warnings) {
+    const target = graph.byModel.get(key.targetModel);
+    if (target === undefined) {
+        warnings.push(`${node.model.name}.${key.name}: the target model ${key.targetModel} is not in the schema, so the relationship was not documented.`);
+        return [];
+    }
+    const local = key.fields.map((name) => node.keys.get(name) ?? name);
+    const remote = key.references.map((name) => target.keys.get(name) ?? name);
+    const type = relationshipTypeOf(key.name);
+    const where = local
+        .map((name, position) => `${propertyReference('s', name)} = ${propertyReference('t', remote[position] ?? '')}`)
+        .join(' AND ');
+    const lines = [
+        pattern(node.label, type, target.label),
+        `  ${key.kind === 'oneToOne' ? 'one' : 'many'} ${node.label} to one ${target.label}, ${key.isNullable ? 'optional' : 'required'}.`,
+        `  foreign key properties: ${local.map((name) => `${node.label}.${name}`).join(', ')} reference ${remote.map((name) => `${target.label}.${name}`).join(', ')}`,
+        `  on delete: ${onDeleteText(key.onDelete, node.label, target.label, local.join(', '))}; Neo4j does not enforce it.`,
+        `  create: MATCH (s:${quoteIdentifier(node.label)}), (t:${quoteIdentifier(target.label)}) WHERE ${where} MERGE (s)-[:${quoteIdentifier(type)}]->(t);`,
+    ];
+    warnings.push(`${node.model.name}.${key.name}: Neo4j keeps no relationship schema, so the composite foreign key to ${key.targetModel} is only documented in a comment; its properties were kept.`);
+    return comment(lines);
+}
+/** True when `relation` is the same many-to-many pair as one already written from the other model. */
+function isMirror(schema, model, relation, written) {
+    const target = findModel(schema, relation.targetModel);
+    if (target === undefined || relation.relatedName === undefined) {
+        return false;
+    }
+    return target.relations.some((other) => written.has(other) &&
+        other.kind === 'manyToMany' &&
+        other.targetModel === model.name &&
+        other.name === relation.relatedName);
+}
+function manyToManyBlock(node, graph, relation, warnings) {
+    const target = graph.byModel.get(relation.targetModel);
+    if (target === undefined) {
+        warnings.push(`${node.model.name}.${relation.name}: the target model ${relation.targetModel} is not in the schema, so the relationship was not documented.`);
+        return [];
+    }
+    const type = relationshipTypeOf(relation.name);
+    const lines = [
+        pattern(node.label, type, target.label),
+        `  many ${node.label} to many ${target.label}.`,
+        '  The source keeps a join table for this pair; in Neo4j the relationship itself replaces it.',
+    ];
+    if (relation.relatedName !== undefined) {
+        lines.push(`  reverse accessor in the source: ${target.label}.${relation.relatedName}`);
+    }
+    lines.push(`  create: MERGE (s)-[:${quoteIdentifier(type)}]->(t) for each pair of ${node.label} (s) and ${target.label} (t) nodes you want to connect.`);
+    warnings.push(`${node.model.name}.${relation.name}: the many-to-many relation to ${relation.targetModel} is documented as the relationship ${pattern(node.label, type, target.label)}; no join node is created.`);
+    return comment(lines);
+}
+function describeProperty(property) {
+    return `${property.key} ${property.type.name} (${property.required ? 'required' : 'optional'})`;
+}
+function joinBlock(schema, graph, join, writer, warnings) {
+    const source = graph.byModel.get(join.from.targetModel);
+    const target = graph.byModel.get(join.to.targetModel);
+    if (source === undefined || target === undefined) {
+        return [];
+    }
+    const model = join.model;
+    const lines = [
+        pattern(source.label, join.type, target.label),
+        `  many ${source.label} to many ${target.label}, from the join table ${model.tableName} (model ${model.name}).`,
+    ];
+    if (join.extras.length > 0) {
+        lines.push(`  relationship properties: ${join.extras.map(describeProperty).join(', ')}`);
+    }
+    lines.push(`  the pair (${join.pairColumns.join(', ')}) identifies a relationship; Neo4j cannot enforce that for relationships, so create them with MERGE.`);
+    const fromKey = targetKey(schema, graph, join.from);
+    const toKey = targetKey(schema, graph, join.to);
+    if (fromKey !== undefined && toKey !== undefined) {
+        const assignments = join.extras.length === 0
+            ? ''
+            : ` SET ${join.extras.map((property) => `${propertyReference('r', property.key)} = ${propertyReference('row', property.key)}`).join(', ')}`;
+        lines.push(`  create (for each row of the join table, for example UNWIND $rows AS row): MATCH (s:${quoteIdentifier(source.label)} {${quoteIdentifier(fromKey)}: ${propertyReference('row', join.pairColumns[0])}}), (t:${quoteIdentifier(target.label)} {${quoteIdentifier(toKey)}: ${propertyReference('row', join.pairColumns[1])}}) MERGE (s)-[r:${quoteIdentifier(join.type)}]->(t)${assignments};`);
+    }
+    warnings.push(`${model.name}: the join table is documented as the relationship ${pattern(source.label, join.type, target.label)} instead of a node label.`);
+    return [...comment(lines), ...joinStatements(join, writer, warnings)];
+}
+/**
+ * Relationship property constraints, written only for a join table that has unique columns:
+ * uniqueness for each unique extra column or unique index, and (Enterprise) existence for the
+ * required extra columns. Other indexes of the join table have no relationship counterpart here.
+ */
+function joinStatements(join, writer, warnings) {
+    const target = relationshipTarget(join.type);
+    const model = join.model;
+    const uniqueKeys = [];
+    for (const field of model.fields) {
+        const property = join.extras.find((extra) => extra.irName === field.name);
+        if (property !== undefined && field.isUnique) {
+            uniqueKeys.push([property.key]);
+        }
+    }
+    const pairNames = new Set([
+        join.from.name,
+        join.from.columnName,
+        join.to.name,
+        join.to.columnName,
+    ]);
+    for (const index of model.indexes) {
+        if (index.fields.every((name) => pairNames.has(name))) {
+            continue;
+        }
+        const keys = index.fields.map((name) => join.keys.get(name) ?? name);
+        const known = index.fields.every((name) => join.extras.some((extra) => extra.irName === name));
+        if (index.isUnique && index.kind === undefined && known) {
+            uniqueKeys.push(keys);
+        }
+        else {
+            warnings.push(`${model.name} index (${index.fields.join(', ')}): the join table became a relationship, so this index was dropped.`);
+        }
+    }
+    if (uniqueKeys.length === 0) {
+        return [];
+    }
+    const statements = [];
+    for (const keys of uniqueKeys) {
+        const statement = writer.unique(target, keys);
+        if (statement !== undefined) {
+            statements.push(statement);
+        }
+    }
+    if (writer.style === 'enterprise') {
+        for (const property of join.extras) {
+            if (!property.required) {
+                continue;
+            }
+            const statement = writer.required(target, property.key);
+            if (statement !== undefined) {
+                statements.push(statement);
+            }
+        }
+    }
+    return statements;
+}
+/** Writes every relationship block, then the join table constraint statements that follow their block. */
+export function writeRelationships(schema, graph, writer, warnings) {
+    const blocks = [];
+    const written = new Set();
+    for (const node of graph.nodes) {
+        for (const relation of node.model.relations) {
+            if (relation.kind === 'manyToMany') {
+                if (isMirror(schema, node.model, relation, written)) {
+                    continue;
+                }
+                written.add(relation);
+                blocks.push(manyToManyBlock(node, graph, relation, warnings));
+            }
+            else {
+                blocks.push(foreignKeyBlock(schema, graph, node, relation, warnings));
+            }
+        }
+        for (const key of node.model.compositeForeignKeys ?? []) {
+            blocks.push(compositeKeyBlock(graph, node, key, warnings));
+        }
+    }
+    for (const join of graph.joins) {
+        blocks.push(joinBlock(schema, graph, join, writer, warnings));
+    }
+    const filled = blocks.filter((block) => block.length > 0);
+    if (filled.length === 0) {
+        return { lines: [] };
+    }
+    const lines = [];
+    filled.forEach((block, position) => {
+        if (position > 0) {
+            lines.push('');
+        }
+        lines.push(...block);
+    });
+    return { lines };
+}
+//# sourceMappingURL=neo4jRelationships.js.map

package/dist/emitters/neo4jRelationships.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"neo4jRelationships.js","sourceRoot":"","sources":["../../src/emitters/neo4jRelationships.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EACL,eAAe,GAKhB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAwB,MAAM,sBAAsB,CAAC;AAchF,SAAS,OAAO,CAAC,MAAc,EAAE,IAAY,EAAE,MAAc;IAC3D,OAAO,KAAK,eAAe,CAAC,MAAM,CAAC,OAAO,eAAe,CAAC,IAAI,CAAC,QAAQ,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC;AACpG,CAAC;AAED,SAAS,iBAAiB,CAAC,QAAgB,EAAE,GAAW;IACtD,OAAO,GAAG,QAAQ,IAAI,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;AAC/C,CAAC;AAED,SAAS,YAAY,CACnB,MAAkB,EAClB,MAAc,EACd,MAAc,EACd,GAAW;IAEX,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,SAAS;YACZ,OAAO,uBAAuB,MAAM,aAAa,MAAM,cAAc,CAAC;QACxE,KAAK,SAAS;YACZ,OAAO,iBAAiB,GAAG,qBAAqB,MAAM,cAAc,CAAC;QACvE,KAAK,YAAY;YACf,OAAO,sBAAsB,GAAG,aAAa,MAAM,cAAc,CAAC;QACpE,KAAK,UAAU,CAAC;QAChB,KAAK,UAAU;YACb,OAAO,GAAG,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,qBAAqB,MAAM,mBAAmB,MAAM,SAAS,CAAC;IAC5H,CAAC;AACH,CAAC;AAED,SAAS,OAAO,CAAC,KAAe;IAC9B,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC;AAC1E,CAAC;AAED,sGAAsG;AACtG,SAAS,SAAS,CAChB,MAAgB,EAChB,KAAY,EACZ,QAAoB;IAEpB,MAAM,UAAU,GAAwB,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC1E,MAAM,IAAI,GAA0B,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAC5E,OAAO,UAAU,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS;QACnD,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,eAAe,CACtB,MAAgB,EAChB,KAAY,EACZ,IAAe,EACf,QAAoB,EACpB,QAAkB;IAElB,MAAM,MAAM,GAA0B,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAC9E,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CACX,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,sBAAsB,QAAQ,CAAC,WAAW,gEAAgE,CAC9I,CAAC;QACF,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,IAAI,GAAW,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvD,MAAM,GAAG,GAAW,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC;IACxE,MAAM,aAAa,GAAuB,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC7E,MAAM,WAAW,GACf,QAAQ,CAAC,IAAI,KAAK,UAAU;QAC1B,CAAC,CAAC,OAAO,IAAI,CAAC,KAAK,WAAW,MAAM,CAAC,KAAK,EAAE;QAC5C,CAAC,CAAC,QAAQ,IAAI,CAAC,KAAK,WAAW,MAAM,CAAC,KAAK,EAAE,CAAC;IAClD,MAAM,KAAK,GAAa;QACtB,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC;QACvC,KAAK,WAAW,KAAK,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG;QACrE,2BAA2B,IAAI,CAAC,KAAK,IAAI,GAAG,GAAG,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,MAAM,CAAC,KAAK,IAAI,aAAa,EAAE,EAAE;QAClI,gBAAgB,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,8BAA8B;KAC7G,CAAC;IACF,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACpC,KAAK,CAAC,IAAI,CAAC,gBAAgB,QAAQ,CAAC,QAAQ,8BAA8B,CAAC,CAAC;IAC9E,CAAC;IACD,IAAI,QAAQ,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CACR,qCAAqC,MAAM,CAAC,KAAK,IAAI,QAAQ,CAAC,WAAW,EAAE,CAC5E,CAAC;IACJ,CAAC;IACD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CACR,sBAAsB,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,iBAAiB,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,iBAAiB,CAAC,GAAG,EAAE,aAAa,CAAC,gBAAgB,eAAe,CAAC,IAAI,CAAC,SAAS,CACvN,CAAC;IACJ,CAAC;IACD,QAAQ,CAAC,IAAI,CACX,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,+DAA+D,QAAQ,CAAC,WAAW,eAAe,QAAQ,CAAC,QAAQ,0CAA0C,GAAG,qBAAqB,CACzN,CAAC;IACF,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;AACxB,CAAC;AAED,SAAS,iBAAiB,CACxB,KAAY,EACZ,IAAe,EACf,GAA0B,EAC1B,QAAkB;IAElB,MAAM,MAAM,GAA0B,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACzE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CACX,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,sBAAsB,GAAG,CAAC,WAAW,gEAAgE,CACpI,CAAC;QACF,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,KAAK,GAAa,GAAG,CAAC,MAAM,CAAC,GAAG,CACpC,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAC9C,CAAC;IACF,MAAM,MAAM,GAAa,GAAG,CAAC,UAAU,CAAC,GAAG,CACzC,CAAC,IAAY,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAChD,CAAC;IACF,MAAM,IAAI,GAAW,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClD,MAAM,KAAK,GAAW,KAAK;SACxB,GAAG,CACF,CAAC,IAAY,EAAE,QAAgB,EAAE,EAAE,CACjC,GAAG,iBAAiB,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,iBAAiB,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,CACxF;SACA,IAAI,CAAC,OAAO,CAAC,CAAC;IACjB,MAAM,KAAK,GAAa;QACtB,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC;QACvC,KAAK,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,WAAW,MAAM,CAAC,KAAK,KAAK,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG;QAClI,6BAA6B,KAAK,CAAC,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,MAAM,CAAC,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QAC9K,gBAAgB,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,8BAA8B;QACpH,sBAAsB,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,KAAK,gBAAgB,eAAe,CAAC,IAAI,CAAC,SAAS;KACtJ,CAAC;IACF,QAAQ,CAAC,IAAI,CACX,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,yEAAyE,GAAG,CAAC,WAAW,6DAA6D,CACpL,CAAC;IACF,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;AACxB,CAAC;AAED,sGAAsG;AACtG,SAAS,QAAQ,CACf,MAAgB,EAChB,KAAc,EACd,QAAoB,EACpB,OAAwB;IAExB,MAAM,MAAM,GAAwB,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IAC5E,IAAI,MAAM,KAAK,SAAS,IAAI,QAAQ,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QAC/D,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAC1B,CAAC,KAAiB,EAAE,EAAE,CACpB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;QAClB,KAAK,CAAC,IAAI,KAAK,YAAY;QAC3B,KAAK,CAAC,WAAW,KAAK,KAAK,CAAC,IAAI;QAChC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,WAAW,CACtC,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CACtB,IAAe,EACf,KAAY,EACZ,QAAoB,EACpB,QAAkB;IAElB,MAAM,MAAM,GAA0B,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAC9E,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CACX,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,sBAAsB,QAAQ,CAAC,WAAW,gEAAgE,CAC9I,CAAC;QACF,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,IAAI,GAAW,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvD,MAAM,KAAK,GAAa;QACtB,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC;QACvC,UAAU,IAAI,CAAC,KAAK,YAAY,MAAM,CAAC,KAAK,GAAG;QAC/C,8FAA8F;KAC/F,CAAC;IACF,IAAI,QAAQ,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CACR,qCAAqC,MAAM,CAAC,KAAK,IAAI,QAAQ,CAAC,WAAW,EAAE,CAC5E,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,IAAI,CACR,yBAAyB,eAAe,CAAC,IAAI,CAAC,2BAA2B,IAAI,CAAC,KAAK,YAAY,MAAM,CAAC,KAAK,iCAAiC,CAC7I,CAAC;IACF,QAAQ,CAAC,IAAI,CACX,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,kCAAkC,QAAQ,CAAC,WAAW,sCAAsC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,4BAA4B,CACnM,CAAC;IACF,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;AACxB,CAAC;AAED,SAAS,gBAAgB,CAAC,QAAuB;IAC/C,OAAO,GAAG,QAAQ,CAAC,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC;AAClG,CAAC;AAED,SAAS,SAAS,CAChB,MAAgB,EAChB,KAAY,EACZ,IAAe,EACf,MAAuB,EACvB,QAAkB;IAElB,MAAM,MAAM,GAA0B,KAAK,CAAC,OAAO,CAAC,GAAG,CACrD,IAAI,CAAC,IAAI,CAAC,WAAW,CACtB,CAAC;IACF,MAAM,MAAM,GAA0B,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IAC7E,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACjD,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,KAAK,GAAY,IAAI,CAAC,KAAK,CAAC;IAClC,MAAM,KAAK,GAAa;QACtB,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC;QAC9C,UAAU,MAAM,CAAC,KAAK,YAAY,MAAM,CAAC,KAAK,yBAAyB,KAAK,CAAC,SAAS,WAAW,KAAK,CAAC,IAAI,IAAI;KAChH,CAAC;IACF,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CACR,8BAA8B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC7E,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,IAAI,CACR,eAAe,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,sGAAsG,CACjJ,CAAC;IACF,MAAM,OAAO,GAAuB,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACxE,MAAM,KAAK,GAAuB,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IACpE,IAAI,OAAO,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACjD,MAAM,WAAW,GACf,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;YACtB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,QAAQ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,QAAuB,EAAE,EAAE,CAAC,GAAG,iBAAiB,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,MAAM,iBAAiB,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/J,KAAK,CAAC,IAAI,CACR,wFAAwF,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,eAAe,CAAC,OAAO,CAAC,KAAK,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,UAAU,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,eAAe,CAAC,KAAK,CAAC,KAAK,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,mBAAmB,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,WAAW,GAAG,CAC7X,CAAC;IACJ,CAAC;IACD,QAAQ,CAAC,IAAI,CACX,GAAG,KAAK,CAAC,IAAI,sDAAsD,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAC7I,CAAC;IACF,OAAO,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AACxE,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CACrB,IAAe,EACf,MAAuB,EACvB,QAAkB;IAElB,MAAM,MAAM,GAAG,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,KAAK,GAAY,IAAI,CAAC,KAAK,CAAC;IAClC,MAAM,UAAU,GAAe,EAAE,CAAC;IAClC,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjC,MAAM,QAAQ,GAA8B,IAAI,CAAC,MAAM,CAAC,IAAI,CAC1D,CAAC,KAAoB,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,CACtD,CAAC;QACF,IAAI,QAAQ,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YAC7C,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IACD,MAAM,SAAS,GAAgB,IAAI,GAAG,CAAS;QAC7C,IAAI,CAAC,IAAI,CAAC,IAAI;QACd,IAAI,CAAC,IAAI,CAAC,UAAU;QACpB,IAAI,CAAC,EAAE,CAAC,IAAI;QACZ,IAAI,CAAC,EAAE,CAAC,UAAU;KACnB,CAAC,CAAC;IACH,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;QAClC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAC9D,SAAS;QACX,CAAC;QACD,MAAM,IAAI,GAAa,KAAK,CAAC,MAAM,CAAC,GAAG,CACrC,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAC9C,CAAC;QACF,MAAM,KAAK,GAAY,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAY,EAAE,EAAE,CACzD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAoB,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,CAClE,CAAC;QACF,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,EAAE,CAAC;YACxD,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,IAAI,CACX,GAAG,KAAK,CAAC,IAAI,WAAW,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,qEAAqE,CACrH,CAAC;QACJ,CAAC;IACH,CAAC;IACD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAuB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAClE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,KAAK,YAAY,EAAE,CAAC;QAClC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACvB,SAAS;YACX,CAAC;YACD,MAAM,SAAS,GAAuB,MAAM,CAAC,QAAQ,CACnD,MAAM,EACN,QAAQ,CAAC,GAAG,CACb,CAAC;YACF,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,0GAA0G;AAC1G,MAAM,UAAU,kBAAkB,CAChC,MAAgB,EAChB,KAAY,EACZ,MAAuB,EACvB,QAAkB;IAElB,MAAM,MAAM,GAAe,EAAE,CAAC;IAC9B,MAAM,OAAO,GAAoB,IAAI,GAAG,EAAc,CAAC;IACvD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAC/B,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;YAC5C,IAAI,QAAQ,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBACnC,IAAI,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;oBACpD,SAAS;gBACX,CAAC;gBACD,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACtB,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;YAChE,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;YACxE,CAAC;QACH,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,oBAAoB,IAAI,EAAE,EAAE,CAAC;YACxD,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,MAAM,GAAe,MAAM,CAAC,MAAM,CACtC,CAAC,KAAe,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CACtC,CAAC;IACF,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IACvB,CAAC;IACD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,CAAC,OAAO,CAAC,CAAC,KAAe,EAAE,QAAgB,EAAQ,EAAE;QACzD,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;YACjB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;IACH,OAAO,EAAE,KAAK,EAAE,CAAC;AACnB,CAAC"}

package/dist/emitters/neo4jStatements.d.ts

@@ -0,0 +1,41 @@
+import type { Neo4jStyle, Neo4jType } from './neo4jTypes.js';
+/** What a constraint or index is created on: all nodes of a label, or all relationships of a type. */
+export interface SchemaTarget {
+    /** The pattern after `FOR`, for example `(n:Post)` or `()-[r:TAGS]-()`. */
+    pattern: string;
+    /** The variable the pattern binds, so properties are written `n.title` or `r.note`. */
+    variable: string;
+    /** The label or type as snake_case words, used in constraint and index names. */
+    words: string;
+}
+export declare function nodeTarget(label: string): SchemaTarget;
+export declare function relationshipTarget(type: string): SchemaTarget;
+/**
+ * Builds `CREATE CONSTRAINT` and `CREATE INDEX` statements. Constraint and index names share one
+ * namespace in Neo4j, so one writer hands out every name, `<label_snake>_<properties>_<kind>`, and
+ * adds a number when two objects would get the same one. Asking twice for the same object, or for an
+ * index that a uniqueness or key constraint already backs, returns nothing.
+ */
+export declare class StatementWriter {
+    readonly style: Neo4jStyle;
+    private readonly names;
+    private readonly created;
+    constructor(style: Neo4jStyle);
+    /** `REQUIRE ... IS UNIQUE` on one property or, for several, on their combination. */
+    unique(target: SchemaTarget, keys: string[]): string | undefined;
+    /** `REQUIRE ... IS NODE KEY`: unique and required together (Enterprise Edition). */
+    nodeKey(target: SchemaTarget, keys: string[]): string | undefined;
+    /** `REQUIRE n.prop IS NOT NULL` (Enterprise Edition). */
+    required(target: SchemaTarget, key: string): string | undefined;
+    /** `REQUIRE n.prop IS :: TYPE`, a property type constraint (Enterprise Edition). */
+    typed(target: SchemaTarget, key: string, type: Neo4jType): string | undefined;
+    /** A range index; nothing when a uniqueness or key constraint over the same properties already has one. */
+    index(target: SchemaTarget, keys: string[]): string | undefined;
+    fulltext(target: SchemaTarget, keys: string[]): string | undefined;
+    private properties;
+    private list;
+    private reference;
+    private identity;
+    private constraint;
+    private create;
+}

package/dist/emitters/neo4jStatements.js

@@ -0,0 +1,92 @@
+import { NameRegistry, nameWords, quoteIdentifier } from './neo4jNames.js';
+export function nodeTarget(label) {
+    return {
+        pattern: `(n:${quoteIdentifier(label)})`,
+        variable: 'n',
+        words: nameWords(label),
+    };
+}
+export function relationshipTarget(type) {
+    return {
+        pattern: `()-[r:${quoteIdentifier(type)}]-()`,
+        variable: 'r',
+        words: nameWords(type),
+    };
+}
+const SUFFIXES = {
+    unique: 'unique',
+    key: 'key',
+    required: 'required',
+    type: 'type',
+    index: 'idx',
+    fulltext: 'fulltext',
+};
+/**
+ * Builds `CREATE CONSTRAINT` and `CREATE INDEX` statements. Constraint and index names share one
+ * namespace in Neo4j, so one writer hands out every name, `<label_snake>_<properties>_<kind>`, and
+ * adds a number when two objects would get the same one. Asking twice for the same object, or for an
+ * index that a uniqueness or key constraint already backs, returns nothing.
+ */
+export class StatementWriter {
+    style;
+    names = new NameRegistry();
+    created = new Set();
+    constructor(style) {
+        this.style = style;
+    }
+    /** `REQUIRE ... IS UNIQUE` on one property or, for several, on their combination. */
+    unique(target, keys) {
+        return this.constraint(target, keys, 'unique', `${this.properties(target, keys)} IS UNIQUE`);
+    }
+    /** `REQUIRE ... IS NODE KEY`: unique and required together (Enterprise Edition). */
+    nodeKey(target, keys) {
+        return this.constraint(target, keys, 'key', `${this.properties(target, keys)} IS NODE KEY`);
+    }
+    /** `REQUIRE n.prop IS NOT NULL` (Enterprise Edition). */
+    required(target, key) {
+        return this.constraint(target, [key], 'required', `${this.properties(target, [key])} IS NOT NULL`);
+    }
+    /** `REQUIRE n.prop IS :: TYPE`, a property type constraint (Enterprise Edition). */
+    typed(target, key, type) {
+        return this.constraint(target, [key], 'type', `${this.properties(target, [key])} IS :: ${type.name}`);
+    }
+    /** A range index; nothing when a uniqueness or key constraint over the same properties already has one. */
+    index(target, keys) {
+        if (this.created.has(this.identity('unique', target, keys)) ||
+            this.created.has(this.identity('key', target, keys))) {
+            return undefined;
+        }
+        return this.create(target, keys, 'index', (name) => `CREATE INDEX ${quoteIdentifier(name)} IF NOT EXISTS FOR ${target.pattern} ON (${this.list(target, keys)});`);
+    }
+    fulltext(target, keys) {
+        return this.create(target, keys, 'fulltext', (name) => `CREATE FULLTEXT INDEX ${quoteIdentifier(name)} IF NOT EXISTS FOR ${target.pattern} ON EACH [${this.list(target, keys)}];`);
+    }
+    properties(target, keys) {
+        return keys.length === 1
+            ? this.reference(target, keys[0] ?? '')
+            : `(${this.list(target, keys)})`;
+    }
+    list(target, keys) {
+        return keys.map((key) => this.reference(target, key)).join(', ');
+    }
+    reference(target, key) {
+        return `${target.variable}.${quoteIdentifier(key)}`;
+    }
+    identity(kind, target, keys) {
+        return `${kind}|${target.pattern}|${keys.join('\u0000')}`;
+    }
+    constraint(target, keys, kind, requirement) {
+        return this.create(target, keys, kind, (name) => `CREATE CONSTRAINT ${quoteIdentifier(name)} IF NOT EXISTS FOR ${target.pattern} REQUIRE ${requirement};`);
+    }
+    create(target, keys, kind, render) {
+        const identity = this.identity(kind, target, keys);
+        if (this.created.has(identity)) {
+            return undefined;
+        }
+        this.created.add(identity);
+        const words = keys.map(nameWords).join('_');
+        const name = this.names.claim(`${target.words}_${words}_${SUFFIXES[kind] ?? kind}`);
+        return render(name);
+    }
+}
+//# sourceMappingURL=neo4jStatements.js.map

package/dist/emitters/neo4jStatements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"neo4jStatements.js","sourceRoot":"","sources":["../../src/emitters/neo4jStatements.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAa3E,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO;QACL,OAAO,EAAE,MAAM,eAAe,CAAC,KAAK,CAAC,GAAG;QACxC,QAAQ,EAAE,GAAG;QACb,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC;KACxB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,OAAO;QACL,OAAO,EAAE,SAAS,eAAe,CAAC,IAAI,CAAC,MAAM;QAC7C,QAAQ,EAAE,GAAG;QACb,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC;KACvB,CAAC;AACJ,CAAC;AAID,MAAM,QAAQ,GAAqC;IACjD,MAAM,EAAE,QAAQ;IAChB,GAAG,EAAE,KAAK;IACV,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,KAAK;IACZ,QAAQ,EAAE,UAAU;CACrB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,OAAO,eAAe;IAIL;IAHJ,KAAK,GAAiB,IAAI,YAAY,EAAE,CAAC;IACzC,OAAO,GAAgB,IAAI,GAAG,EAAU,CAAC;IAE1D,YAAqB,KAAiB;QAAjB,UAAK,GAAL,KAAK,CAAY;IAAG,CAAC;IAE1C,qFAAqF;IACrF,MAAM,CAAC,MAAoB,EAAE,IAAc;QACzC,OAAO,IAAI,CAAC,UAAU,CACpB,MAAM,EACN,IAAI,EACJ,QAAQ,EACR,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAC7C,CAAC;IACJ,CAAC;IAED,oFAAoF;IACpF,OAAO,CAAC,MAAoB,EAAE,IAAc;QAC1C,OAAO,IAAI,CAAC,UAAU,CACpB,MAAM,EACN,IAAI,EACJ,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAC/C,CAAC;IACJ,CAAC;IAED,yDAAyD;IACzD,QAAQ,CAAC,MAAoB,EAAE,GAAW;QACxC,OAAO,IAAI,CAAC,UAAU,CACpB,MAAM,EACN,CAAC,GAAG,CAAC,EACL,UAAU,EACV,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,cAAc,CAChD,CAAC;IACJ,CAAC;IAED,oFAAoF;IACpF,KAAK,CACH,MAAoB,EACpB,GAAW,EACX,IAAe;QAEf,OAAO,IAAI,CAAC,UAAU,CACpB,MAAM,EACN,CAAC,GAAG,CAAC,EACL,MAAM,EACN,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,UAAU,IAAI,CAAC,IAAI,EAAE,CACvD,CAAC;IACJ,CAAC;IAED,2GAA2G;IAC3G,KAAK,CAAC,MAAoB,EAAE,IAAc;QACxC,IACE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;YACvD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,EACpD,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAChB,MAAM,EACN,IAAI,EACJ,OAAO,EACP,CAAC,IAAY,EAAU,EAAE,CACvB,gBAAgB,eAAe,CAAC,IAAI,CAAC,sBAAsB,MAAM,CAAC,OAAO,QAAQ,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAC/G,CAAC;IACJ,CAAC;IAED,QAAQ,CAAC,MAAoB,EAAE,IAAc;QAC3C,OAAO,IAAI,CAAC,MAAM,CAChB,MAAM,EACN,IAAI,EACJ,UAAU,EACV,CAAC,IAAY,EAAU,EAAE,CACvB,yBAAyB,eAAe,CAAC,IAAI,CAAC,sBAAsB,MAAM,CAAC,OAAO,aAAa,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAC7H,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,MAAoB,EAAE,IAAc;QACrD,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC;YACtB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YACvC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC;IACrC,CAAC;IAEO,IAAI,CAAC,MAAoB,EAAE,IAAc;QAC/C,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3E,CAAC;IAEO,SAAS,CAAC,MAAoB,EAAE,GAAW;QACjD,OAAO,GAAG,MAAM,CAAC,QAAQ,IAAI,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;IACtD,CAAC;IAEO,QAAQ,CAAC,IAAY,EAAE,MAAoB,EAAE,IAAc;QACjE,OAAO,GAAG,IAAI,IAAI,MAAM,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC5D,CAAC;IAEO,UAAU,CAChB,MAAoB,EACpB,IAAc,EACd,IAAoB,EACpB,WAAmB;QAEnB,OAAO,IAAI,CAAC,MAAM,CAChB,MAAM,EACN,IAAI,EACJ,IAAI,EACJ,CAAC,IAAY,EAAU,EAAE,CACvB,qBAAqB,eAAe,CAAC,IAAI,CAAC,sBAAsB,MAAM,CAAC,OAAO,YAAY,WAAW,GAAG,CAC3G,CAAC;IACJ,CAAC;IAEO,MAAM,CACZ,MAAoB,EACpB,IAAc,EACd,IAAY,EACZ,MAAgC;QAEhC,MAAM,QAAQ,GAAW,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAC3D,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC3B,MAAM,KAAK,GAAW,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpD,MAAM,IAAI,GAAW,IAAI,CAAC,KAAK,CAAC,KAAK,CACnC,GAAG,MAAM,CAAC,KAAK,IAAI,KAAK,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CACrD,CAAC;QACF,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;CACF"}

package/dist/emitters/neo4jTypes.d.ts

@@ -0,0 +1,31 @@
+import type { IrEnum, IrField } from '../ir.js';
+/**
+ * Output style of the Neo4j writer. `community` (the default) writes only what Neo4j Community
+ * Edition accepts; `enterprise` adds the statements that need Enterprise Edition: `IS NOT NULL`
+ * constraints, `IS NODE KEY` for composite primary keys and property type constraints.
+ */
+export type Neo4jStyle = 'community' | 'enterprise';
+export declare const NEO4J_STYLES: readonly Neo4jStyle[];
+/** True when a value is a style of the Neo4j writer. */
+export declare function isNeo4jStyle(value: string): value is Neo4jStyle;
+/** A Neo4j property type. */
+export interface Neo4jType {
+    /** Type name as the Neo4j manual spells it, for example `STRING` or `LIST<INTEGER NOT NULL>`. */
+    name: string;
+    /** False for types that a property type constraint cannot name (byte arrays). */
+    constrainable: boolean;
+}
+/** A property type plus what was approximated to reach it. */
+export interface Neo4jTypeMapping {
+    type: Neo4jType;
+    /** Present when the mapping loses or changes information; the text has no model or field prefix. */
+    warning?: string;
+}
+/**
+ * Maps a field to the Neo4j property type it is documented (and, in the enterprise style, constrained)
+ * with. Enum-backed fields are strings. An array becomes a one-dimensional `LIST<T NOT NULL>`; Neo4j
+ * cannot store lists of lists or lists of byte arrays, so those fall back to a STRING.
+ */
+export declare function mapFieldType(field: IrField): Neo4jTypeMapping;
+/** The stored values of the enum behind a field, or an empty list when the field is not enum-backed. */
+export declare function enumValuesOf(field: IrField, enums: readonly IrEnum[]): string[];

package/dist/emitters/neo4jTypes.js

@@ -0,0 +1,116 @@
+export const NEO4J_STYLES = ['community', 'enterprise'];
+/** True when a value is a style of the Neo4j writer. */
+export function isNeo4jStyle(value) {
+    return NEO4J_STYLES.includes(value);
+}
+const STRING = { name: 'STRING', constrainable: true };
+/** Column types of databases that store a date and time without a time zone. */
+const LOCAL_DATETIME_TYPES = new Set([
+    'timestamp',
+    'datetime',
+    'datetime2',
+    'smalldatetime',
+]);
+function scalarType(field) {
+    const native = field.nativeType?.name.toLowerCase() ?? '';
+    const type = field.type;
+    switch (type) {
+        case 'string':
+        case 'text':
+        case 'uuid':
+        case 'ipAddress':
+            return { type: STRING };
+        case 'int':
+        case 'bigInt':
+            return { type: { name: 'INTEGER', constrainable: true } };
+        case 'float':
+            return { type: { name: 'FLOAT', constrainable: true } };
+        case 'boolean':
+            return { type: { name: 'BOOLEAN', constrainable: true } };
+        case 'date':
+            return { type: { name: 'DATE', constrainable: true } };
+        case 'dateTime':
+            return {
+                type: {
+                    name: LOCAL_DATETIME_TYPES.has(native)
+                        ? 'LOCAL DATETIME'
+                        : 'ZONED DATETIME',
+                    constrainable: true,
+                },
+            };
+        case 'time':
+            return {
+                type: {
+                    name: native === 'timetz' ? 'ZONED TIME' : 'LOCAL TIME',
+                    constrainable: true,
+                },
+            };
+        case 'duration':
+            return { type: { name: 'DURATION', constrainable: true } };
+        case 'bytes':
+            return { type: { name: 'BYTE ARRAY', constrainable: false } };
+        case 'decimal':
+            return {
+                type: STRING,
+                warning: 'Neo4j has no decimal type; the value is stored as a STRING so no precision is lost (use FLOAT, or an integer count of cents, if you need arithmetic).',
+            };
+        case 'json':
+            return {
+                type: STRING,
+                warning: 'Neo4j properties cannot hold JSON objects; store the value as a serialized JSON STRING.',
+            };
+        case 'hstore':
+            return {
+                type: STRING,
+                warning: 'Neo4j has no key-value property type; the hstore value is stored as a serialized STRING.',
+            };
+        case 'range':
+            return {
+                type: STRING,
+                warning: 'Neo4j has no range type; the value is stored as a STRING such as "[1,10)".',
+            };
+        case 'unsupported':
+            return {
+                type: STRING,
+                warning: `the database type "${field.unsupportedType ?? 'unknown'}" has no Neo4j equivalent; the property is a plain STRING.`,
+            };
+    }
+}
+/**
+ * Maps a field to the Neo4j property type it is documented (and, in the enterprise style, constrained)
+ * with. Enum-backed fields are strings. An array becomes a one-dimensional `LIST<T NOT NULL>`; Neo4j
+ * cannot store lists of lists or lists of byte arrays, so those fall back to a STRING.
+ */
+export function mapFieldType(field) {
+    const element = scalarType(field);
+    const depth = field.arrayDepth ?? 0;
+    if (depth === 0) {
+        return element;
+    }
+    if (depth > 1 || !element.type.constrainable) {
+        return {
+            type: STRING,
+            warning: `Neo4j cannot store ${depth > 1 ? 'nested lists' : 'a list of byte arrays'} as a property; the value is stored as a serialized STRING.`,
+        };
+    }
+    const mapping = {
+        type: {
+            name: `LIST<${element.type.name} NOT NULL>`,
+            constrainable: true,
+        },
+    };
+    return element.warning === undefined
+        ? mapping
+        : { ...mapping, warning: element.warning };
+}
+/** The stored values of the enum behind a field, or an empty list when the field is not enum-backed. */
+export function enumValuesOf(field, enums) {
+    if (field.enumName === undefined) {
+        return [];
+    }
+    const definition = enums.find((candidate) => candidate.name === field.enumName);
+    return definition === undefined
+        ? []
+        : definition.values.map((value) => value.dbValue);
+}
+//# sourceMappingURL=neo4jTypes.js.map

package/dist/emitters/neo4jTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"neo4jTypes.js","sourceRoot":"","sources":["../../src/emitters/neo4jTypes.ts"],"names":[],"mappings":"AASA,MAAM,CAAC,MAAM,YAAY,GAA0B,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;AAE/E,wDAAwD;AACxD,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,OAAQ,YAAkC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC7D,CAAC;AAiBD,MAAM,MAAM,GAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;AAElE,gFAAgF;AAChF,MAAM,oBAAoB,GAAwB,IAAI,GAAG,CAAC;IACxD,WAAW;IACX,UAAU;IACV,WAAW;IACX,eAAe;CAChB,CAAC,CAAC;AAEH,SAAS,UAAU,CAAC,KAAc;IAChC,MAAM,MAAM,GAAW,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC;IAClE,MAAM,IAAI,GAAiB,KAAK,CAAC,IAAI,CAAC;IACtC,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,QAAQ,CAAC;QACd,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM,CAAC;QACZ,KAAK,WAAW;YACd,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC1B,KAAK,KAAK,CAAC;QACX,KAAK,QAAQ;YACX,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,CAAC;QAC5D,KAAK,OAAO;YACV,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,CAAC;QAC1D,KAAK,SAAS;YACZ,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,CAAC;QAC5D,KAAK,MAAM;YACT,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,CAAC;QACzD,KAAK,UAAU;YACb,OAAO;gBACL,IAAI,EAAE;oBACJ,IAAI,EAAE,oBAAoB,CAAC,GAAG,CAAC,MAAM,CAAC;wBACpC,CAAC,CAAC,gBAAgB;wBAClB,CAAC,CAAC,gBAAgB;oBACpB,aAAa,EAAE,IAAI;iBACpB;aACF,CAAC;QACJ,KAAK,MAAM;YACT,OAAO;gBACL,IAAI,EAAE;oBACJ,IAAI,EAAE,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY;oBACvD,aAAa,EAAE,IAAI;iBACpB;aACF,CAAC;QACJ,KAAK,UAAU;YACb,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,CAAC;QAC7D,KAAK,OAAO;YACV,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC;QAChE,KAAK,SAAS;YACZ,OAAO;gBACL,IAAI,EAAE,MAAM;gBACZ,OAAO,EACL,uJAAuJ;aAC1J,CAAC;QACJ,KAAK,MAAM;YACT,OAAO;gBACL,IAAI,EAAE,MAAM;gBACZ,OAAO,EACL,yFAAyF;aAC5F,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO;gBACL,IAAI,EAAE,MAAM;gBACZ,OAAO,EACL,0FAA0F;aAC7F,CAAC;QACJ,KAAK,OAAO;YACV,OAAO;gBACL,IAAI,EAAE,MAAM;gBACZ,OAAO,EACL,4EAA4E;aAC/E,CAAC;QACJ,KAAK,aAAa;YAChB,OAAO;gBACL,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,sBAAsB,KAAK,CAAC,eAAe,IAAI,SAAS,4DAA4D;aAC9H,CAAC;IACN,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,MAAM,OAAO,GAAqB,UAAU,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,KAAK,GAAW,KAAK,CAAC,UAAU,IAAI,CAAC,CAAC;IAC5C,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAChB,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QAC7C,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,sBACP,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,uBAC/B,6DAA6D;SAC9D,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAqB;QAChC,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ,OAAO,CAAC,IAAI,CAAC,IAAI,YAAY;YAC3C,aAAa,EAAE,IAAI;SACpB;KACF,CAAC;IACF,OAAO,OAAO,CAAC,OAAO,KAAK,SAAS;QAClC,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;AAC/C,CAAC;AAED,wGAAwG;AACxG,MAAM,UAAU,YAAY,CAC1B,KAAc,EACd,KAAwB;IAExB,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACjC,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,UAAU,GAAuB,KAAK,CAAC,IAAI,CAC/C,CAAC,SAAiB,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,QAAQ,CACzD,CAAC;IACF,OAAO,UAAU,KAAK,SAAS;QAC7B,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AACtD,CAAC"}

package/dist/formats.js

@@ -9,6 +9,7 @@ import { emitTypeorm } from './emitters/typeorm.js';
 import { emitJsonSchema } from './emitters/jsonSchema.js';
 import { emitEfcore, isEfcoreStyle, isValidCsharpNamespace, } from './emitters/efcore.js';
 import { emitJpa, isJpaStyle, isValidJavaPackage } from './emitters/jpa.js';
+import { emitNeo4j, isNeo4jStyle } from './emitters/neo4j.js';
 import { emitSequelize, isSequelizeStyle } from './emitters/sequelize.js';
 import { emitSqlAlchemy, isSqlAlchemyStyle } from './emitters/sqlalchemy.js';
 import { emitSqlDdl } from './emitters/sqlDdl.js';
@@ -282,6 +283,28 @@ const zodAdapter = {
         return ok(emitZod(prepared, { camelFields: options.naming === 'normalize' }));
     },
 };
+const neo4jAdapter = {
+    name: 'neo4j',
+    // Output only, and no extension is claimed: ".cypher" is not read by anything here, so pass --to neo4j.
+    extensions: [],
+    description: 'Neo4j Cypher schema: node constraints and indexes, relationships as comments (--style enterprise adds Enterprise Edition constraints)',
+    emit: (schema, options) => {
+        if (options.style !== undefined) {
+            const checked = checkStyle('neo4j', String(options.style), 'style');
+            if (!checked.ok) {
+                return checked;
+            }
+        }
+        const prepared = options.naming === 'normalize' ? normalizeSchema(schema) : schema;
+        return ok(emitNeo4j(prepared, {
+            camelFields: options.naming === 'normalize',
+            header: options.header,
+            ...(options.style === undefined || !isNeo4jStyle(options.style)
+                ? {}
+                : { style: options.style }),
+        }));
+    },
+};
 const sqlAdapter = {
     name: 'sql',
     extensions: ['.sql'],
@@ -419,6 +442,7 @@ const builtIns = [
     registerFormat(grapheneAdapter),
     registerFormat(typescriptAdapter),
     registerFormat(zodAdapter),
+    registerFormat(neo4jAdapter),
     registerFormat(jsonSchemaAdapter),
     registerFormat(sqlAdapter),
     registerFormat(sqlalchemyAdapter),