ormbridge 0.11.0 → 0.12.0

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;

package/dist/emitters/neo4jNames.js

@@ -0,0 +1,58 @@
+import { singularize, toCamelCase, toPascalCase, toSnakeCase, } from '../naming.js';
+const PLAIN_IDENTIFIER = /^[A-Za-z_][A-Za-z0-9_]*$/;
+/**
+ * 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 function quoteIdentifier(name) {
+    return PLAIN_IDENTIFIER.test(name) ? name : `\`${name.replace(/`/g, '``')}\``;
+}
+/** Collapses line breaks and runs of whitespace so text can sit safely inside a one-line `//` comment. */
+export function oneLine(text) {
+    return text.replace(/\s+/g, ' ').trim();
+}
+/** Node label of a model: PascalCase and singular (`blog_posts` and `BlogPosts` both give `BlogPost`). */
+export function labelOf(modelName) {
+    const label = toPascalCase(singularize(toSnakeCase(modelName)));
+    return label === '' ? modelName : label;
+}
+/** Relationship type of a relation field: UPPER_SNAKE_CASE (`edited_by` and `editedBy` give `EDITED_BY`). */
+export function relationshipTypeOf(relationName) {
+    const type = toSnakeCase(relationName).toUpperCase();
+    return type === '' ? 'RELATED_TO' : type;
+}
+/**
+ * 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 function propertyKeyOf(columnName, camelCase) {
+    if (!camelCase) {
+        return columnName;
+    }
+    const camel = toCamelCase(columnName);
+    return camel === '' ? columnName : camel;
+}
+/** Hands out names that are unique within one namespace (labels, or constraint and index names). */
+export class NameRegistry {
+    used = new Set();
+    /** Reserves `base`, or `base2`, `base3`, ... when it is taken, and returns the name reserved. */
+    claim(base) {
+        let candidate = base;
+        let suffix = 2;
+        while (this.used.has(candidate)) {
+            candidate = `${base}${suffix}`;
+            suffix += 1;
+        }
+        this.used.add(candidate);
+        return candidate;
+    }
+    has(name) {
+        return this.used.has(name);
+    }
+}
+/** snake_case words for a constraint or index name (`x` when the text has no letters or digits). */
+export function nameWords(text) {
+    const words = toSnakeCase(text);
+    return words === '' ? 'x' : words;
+}
+//# sourceMappingURL=neo4jNames.js.map

package/dist/emitters/neo4jNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"neo4jNames.js","sourceRoot":"","sources":["../../src/emitters/neo4jNames.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,WAAW,EACX,YAAY,EACZ,WAAW,GACZ,MAAM,cAAc,CAAC;AAEtB,MAAM,gBAAgB,GAAW,0BAA0B,CAAC;AAE5D;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;AAChF,CAAC;AAED,0GAA0G;AAC1G,MAAM,UAAU,OAAO,CAAC,IAAY;IAClC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AAC1C,CAAC;AAED,0GAA0G;AAC1G,MAAM,UAAU,OAAO,CAAC,SAAiB;IACvC,MAAM,KAAK,GAAW,YAAY,CAAC,WAAW,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACxE,OAAO,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;AAC1C,CAAC;AAED,6GAA6G;AAC7G,MAAM,UAAU,kBAAkB,CAAC,YAAoB;IACrD,MAAM,IAAI,GAAW,WAAW,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,CAAC;IAC7D,OAAO,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC;AAC3C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,UAAkB,EAAE,SAAkB;IAClE,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,KAAK,GAAW,WAAW,CAAC,UAAU,CAAC,CAAC;IAC9C,OAAO,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC;AAC3C,CAAC;AAED,oGAAoG;AACpG,MAAM,OAAO,YAAY;IACN,IAAI,GAAgB,IAAI,GAAG,EAAU,CAAC;IAEvD,iGAAiG;IACjG,KAAK,CAAC,IAAY;QAChB,IAAI,SAAS,GAAW,IAAI,CAAC;QAC7B,IAAI,MAAM,GAAW,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YAChC,SAAS,GAAG,GAAG,IAAI,GAAG,MAAM,EAAE,CAAC;YAC/B,MAAM,IAAI,CAAC,CAAC;QACd,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACzB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,GAAG,CAAC,IAAY;QACd,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;CACF;AAED,oGAAoG;AACpG,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,MAAM,KAAK,GAAW,WAAW,CAAC,IAAI,CAAC,CAAC;IACxC,OAAO,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;AACpC,CAAC"}

package/dist/emitters/neo4jRelationships.d.ts

@@ -0,0 +1,15 @@
+import type { IrSchema } from '../ir.js';
+import { type Graph } from './neo4jGraph.js';
+import { type StatementWriter } from './neo4jStatements.js';
+/**
+ * Writes the relationship section. Cypher has no relationship schema, so each foreign key, relation
+ * and join table becomes a comment block that names the pattern, the cardinality, the referential
+ * action and a query that creates the relationships from the foreign key properties. Only a join
+ * table with unique columns gets real statements (relationship property constraints).
+ */
+export interface RelationshipSection {
+    /** Comment lines and statements, one entry per line, blank lines included. */
+    lines: string[];
+}
+/** Writes every relationship block, then the join table constraint statements that follow their block. */
+export declare function writeRelationships(schema: IrSchema, graph: Graph, writer: StatementWriter, warnings: string[]): RelationshipSection;