@peter.prib/renderengine 0.2.10 → 0.2.11

package/REFERENCE.md

@@ -875,6 +875,12 @@ types — see `ARCHITECTURE.md`):
   a comment where one cannot be made; `COMMENT ON`s for definitions (`comments: false` leaves them out). Names SQL
   would not take bare are quoted. ANSI SQL as PostgreSQL reads it.
 
+  A table's name may be schema-qualified (`sales.customer`, as a database lists its tables): the DDL names it in its
+  schema (`sales.customer`, each part quoted as it needs, `SqlDdl.tableName()`), and a reference to it is
+  `sales.customer` or `sales.customer.id`. The check and the DDL read a reference the one way,
+  `LevelSchema.resolveReference(ref)`: the whole text as a table (by id or name, any case), else what is before its
+  last dot as the table and the rest as its column — `{ entity, column }`, or null.
+
   **A dimensional scheme.** At the logical and physical levels an entity may have a role (`EntityRole`, registered as
   relationship kinds are): a **fact** (`FactRole`, `role: 'fact'`: what is measured, at a stated `grain`, its
   attributes' `measure` additive, semi-additive or non-additive) or a **dimension** (`DimensionRole`: its `scdType`,

package/dist/renderengine-workspace.umd.js

@@ -44885,6 +44885,29 @@
             return this.entities.find(e => e.id === id) ?? null;
         }
 
+        /** An entity by id, else by name (any case), or null. */
+        named(text) {
+            const s = String(text ?? '').trim();
+            return this.entity(s) ?? this.entities.find(e => String(e.name ?? '').toLowerCase() === s.toLowerCase()) ?? null;
+        }
+
+        /**
+         * What a foreign key's `references` names: `{ entity, column }` (column
+         * null when it names the table alone), or null. `table` or `table.column`,
+         * the table by id or name; a table's own name may hold dots (a
+         * schema-qualified `sales.customer`), so the whole text is tried as a
+         * table first, then what is before its last dot, the rest its column.
+         */
+        resolveReference(ref) {
+            const text = String(ref ?? '').trim();
+            if (!text) return null;
+            const whole = this.named(text);
+            if (whole) return { entity: whole, column: null };
+            const dot = text.lastIndexOf('.');
+            const entity = dot > 0 ? this.named(text.slice(0, dot)) : null;
+            return entity ? { entity, column: text.slice(dot + 1).trim() || null } : null;
+        }
+
         /** Add an entity (its id unique at this level). */
         addEntity(entity) {
             if (!entity?.id) throw new TypeError('An entity needs an id');
@@ -45325,17 +45348,13 @@
         foreignKeys() {
             return ATTRIBUTED.flatMap(level => {
                 const schema = this.model.level(level);
-                const find = (ref) => {
-                    const [name] = String(ref).split('.');
-                    return schema.entity(name) ?? schema.entities.find(e => e.name.toLowerCase() === name.trim().toLowerCase()) ?? null;
-                };
                 const related = (a, b) => schema.relationships.some(r => (r.source === a && r.target === b) || (r.source === b && r.target === a));
                 return schema.entities.flatMap(e => (e.attributes ?? []).filter(a => a.isFK).flatMap(a => {
                     if (!a.references) {
                         return schema.relationships.some(r => r.source === e.id || r.target === e.id) ? []
                             : [this._entity(level, e, 'foreign-key-unrelated', 'info', `"${e.name}.${a.name}" is a foreign key, but "${e.name}" has no relationship`)];
                     }
-                    const target = find(a.references);
+                    const target = schema.resolveReference(a.references)?.entity;
                     if (!target) return [this._entity(level, e, 'reference-missing', 'warning', `"${e.name}.${a.name}" references "${a.references}", which is not at the ${level} level`)];
                     return related(e.id, target.id) ? []
                         : [this._entity(level, e, 'foreign-key-without-relationship', 'warning', `"${e.name}.${a.name}" references "${target.name}", but they have no relationship`)];
@@ -48277,6 +48296,15 @@
             return /^[a-z_][a-z0-9_]*$/.test(s) && !RESERVED.has(s) ? s : `"${s.replace(/"/g, '""')}"`;
         }
 
+        /**
+         * A table's name as SQL takes it: a schema-qualified one (`sales.customer`)
+         * each part as name() has it, so it names the table in its schema rather
+         * than one table called "sales.customer".
+         */
+        static tableName(text) {
+            return String(text).split('.').map(SqlDdl.name).join('.');
+        }
+
         /** A text as an SQL string literal. */
         static literal(text) {
             return `'${String(text).replace(/'/g, "''")}'`;
@@ -48286,11 +48314,7 @@
         write(model) {
             const schema = model.level('physical');
             const tables = schema.entities;
-            const find = (ref) => {
-                const [table, column] = String(ref).split('.').map(s => s.trim());
-                const target = schema.entity(table) ?? tables.find(t => t.name.toLowerCase() === table.toLowerCase());
-                return target ? { target, column } : null;
-            };
+            const table = SqlDdl.tableName;
             const out = [`-- ${model.name || 'Data model'}: the physical level, ${tables.length} table${tables.length === 1 ? '' : 's'}`, ''];
             for (const t of tables) {
                 const columns = t.attributes ?? [];
@@ -48300,28 +48324,28 @@
                     ...(keys.length ? [`    PRIMARY KEY (${keys.join(', ')})`] : []),
                     ...columns.filter(c => c.isUnique && !c.isPK).map(c => `    UNIQUE (${SqlDdl.name(c.name)})`),
                 ];
-                out.push(`CREATE TABLE ${SqlDdl.name(t.name)} (`, lines.join(',\n'), ');', '');
+                out.push(`CREATE TABLE ${table(t.name)} (`, lines.join(',\n'), ');', '');
             }
             for (const t of tables) {
                 for (const c of (t.attributes ?? []).filter(a => a.isFK && a.references)) {
-                    const ref = find(c.references);
+                    const ref = schema.resolveReference(c.references);
                     if (!ref) {
                         out.push(`-- ${t.name}.${c.name} references ${c.references}, which is not a table here`);
                         continue;
                     }
-                    const theirs = ref.column ? [ref.column] : (ref.target.attributes ?? []).filter(a => a.isPK).map(a => a.name);
+                    const theirs = ref.column ? [ref.column] : (ref.entity.attributes ?? []).filter(a => a.isPK).map(a => a.name);
                     if (!theirs.length) {
-                        out.push(`-- ${t.name}.${c.name} references ${ref.target.name}, which has no primary key`);
+                        out.push(`-- ${t.name}.${c.name} references ${ref.entity.name}, which has no primary key`);
                         continue;
                     }
-                    out.push(`ALTER TABLE ${SqlDdl.name(t.name)} ADD CONSTRAINT ${SqlDdl.name(`fk_${t.name}_${c.name}`.toLowerCase().replace(/[^a-z0-9_]+/g, '_'))}`
-                        + ` FOREIGN KEY (${SqlDdl.name(c.name)}) REFERENCES ${SqlDdl.name(ref.target.name)} (${theirs.map(SqlDdl.name).join(', ')});`);
+                    out.push(`ALTER TABLE ${table(t.name)} ADD CONSTRAINT ${SqlDdl.name(`fk_${t.name}_${c.name}`.toLowerCase().replace(/[^a-z0-9_]+/g, '_'))}`
+                        + ` FOREIGN KEY (${SqlDdl.name(c.name)}) REFERENCES ${table(ref.entity.name)} (${theirs.map(SqlDdl.name).join(', ')});`);
                 }
             }
             if (this.comments) {
                 const notes = tables.flatMap(t => [
-                    ...(t.description ? [`COMMENT ON TABLE ${SqlDdl.name(t.name)} IS ${SqlDdl.literal(t.description)};`] : []),
-                    ...(t.attributes ?? []).filter(c => c.description).map(c => `COMMENT ON COLUMN ${SqlDdl.name(t.name)}.${SqlDdl.name(c.name)} IS ${SqlDdl.literal(c.description)};`),
+                    ...(t.description ? [`COMMENT ON TABLE ${table(t.name)} IS ${SqlDdl.literal(t.description)};`] : []),
+                    ...(t.attributes ?? []).filter(c => c.description).map(c => `COMMENT ON COLUMN ${table(t.name)}.${SqlDdl.name(c.name)} IS ${SqlDdl.literal(c.description)};`),
                 ]);
                 if (notes.length) out.push('', ...notes);
             }

package/dist/renderengine.umd.js

@@ -41279,6 +41279,29 @@
             return this.entities.find(e => e.id === id) ?? null;
         }
 
+        /** An entity by id, else by name (any case), or null. */
+        named(text) {
+            const s = String(text ?? '').trim();
+            return this.entity(s) ?? this.entities.find(e => String(e.name ?? '').toLowerCase() === s.toLowerCase()) ?? null;
+        }
+
+        /**
+         * What a foreign key's `references` names: `{ entity, column }` (column
+         * null when it names the table alone), or null. `table` or `table.column`,
+         * the table by id or name; a table's own name may hold dots (a
+         * schema-qualified `sales.customer`), so the whole text is tried as a
+         * table first, then what is before its last dot, the rest its column.
+         */
+        resolveReference(ref) {
+            const text = String(ref ?? '').trim();
+            if (!text) return null;
+            const whole = this.named(text);
+            if (whole) return { entity: whole, column: null };
+            const dot = text.lastIndexOf('.');
+            const entity = dot > 0 ? this.named(text.slice(0, dot)) : null;
+            return entity ? { entity, column: text.slice(dot + 1).trim() || null } : null;
+        }
+
         /** Add an entity (its id unique at this level). */
         addEntity(entity) {
             if (!entity?.id) throw new TypeError('An entity needs an id');
@@ -41719,17 +41742,13 @@
         foreignKeys() {
             return ATTRIBUTED.flatMap(level => {
                 const schema = this.model.level(level);
-                const find = (ref) => {
-                    const [name] = String(ref).split('.');
-                    return schema.entity(name) ?? schema.entities.find(e => e.name.toLowerCase() === name.trim().toLowerCase()) ?? null;
-                };
                 const related = (a, b) => schema.relationships.some(r => (r.source === a && r.target === b) || (r.source === b && r.target === a));
                 return schema.entities.flatMap(e => (e.attributes ?? []).filter(a => a.isFK).flatMap(a => {
                     if (!a.references) {
                         return schema.relationships.some(r => r.source === e.id || r.target === e.id) ? []
                             : [this._entity(level, e, 'foreign-key-unrelated', 'info', `"${e.name}.${a.name}" is a foreign key, but "${e.name}" has no relationship`)];
                     }
-                    const target = find(a.references);
+                    const target = schema.resolveReference(a.references)?.entity;
                     if (!target) return [this._entity(level, e, 'reference-missing', 'warning', `"${e.name}.${a.name}" references "${a.references}", which is not at the ${level} level`)];
                     return related(e.id, target.id) ? []
                         : [this._entity(level, e, 'foreign-key-without-relationship', 'warning', `"${e.name}.${a.name}" references "${target.name}", but they have no relationship`)];
@@ -44671,6 +44690,15 @@
             return /^[a-z_][a-z0-9_]*$/.test(s) && !RESERVED.has(s) ? s : `"${s.replace(/"/g, '""')}"`;
         }
 
+        /**
+         * A table's name as SQL takes it: a schema-qualified one (`sales.customer`)
+         * each part as name() has it, so it names the table in its schema rather
+         * than one table called "sales.customer".
+         */
+        static tableName(text) {
+            return String(text).split('.').map(SqlDdl.name).join('.');
+        }
+
         /** A text as an SQL string literal. */
         static literal(text) {
             return `'${String(text).replace(/'/g, "''")}'`;
@@ -44680,11 +44708,7 @@
         write(model) {
             const schema = model.level('physical');
             const tables = schema.entities;
-            const find = (ref) => {
-                const [table, column] = String(ref).split('.').map(s => s.trim());
-                const target = schema.entity(table) ?? tables.find(t => t.name.toLowerCase() === table.toLowerCase());
-                return target ? { target, column } : null;
-            };
+            const table = SqlDdl.tableName;
             const out = [`-- ${model.name || 'Data model'}: the physical level, ${tables.length} table${tables.length === 1 ? '' : 's'}`, ''];
             for (const t of tables) {
                 const columns = t.attributes ?? [];
@@ -44694,28 +44718,28 @@
                     ...(keys.length ? [`    PRIMARY KEY (${keys.join(', ')})`] : []),
                     ...columns.filter(c => c.isUnique && !c.isPK).map(c => `    UNIQUE (${SqlDdl.name(c.name)})`),
                 ];
-                out.push(`CREATE TABLE ${SqlDdl.name(t.name)} (`, lines.join(',\n'), ');', '');
+                out.push(`CREATE TABLE ${table(t.name)} (`, lines.join(',\n'), ');', '');
             }
             for (const t of tables) {
                 for (const c of (t.attributes ?? []).filter(a => a.isFK && a.references)) {
-                    const ref = find(c.references);
+                    const ref = schema.resolveReference(c.references);
                     if (!ref) {
                         out.push(`-- ${t.name}.${c.name} references ${c.references}, which is not a table here`);
                         continue;
                     }
-                    const theirs = ref.column ? [ref.column] : (ref.target.attributes ?? []).filter(a => a.isPK).map(a => a.name);
+                    const theirs = ref.column ? [ref.column] : (ref.entity.attributes ?? []).filter(a => a.isPK).map(a => a.name);
                     if (!theirs.length) {
-                        out.push(`-- ${t.name}.${c.name} references ${ref.target.name}, which has no primary key`);
+                        out.push(`-- ${t.name}.${c.name} references ${ref.entity.name}, which has no primary key`);
                         continue;
                     }
-                    out.push(`ALTER TABLE ${SqlDdl.name(t.name)} ADD CONSTRAINT ${SqlDdl.name(`fk_${t.name}_${c.name}`.toLowerCase().replace(/[^a-z0-9_]+/g, '_'))}`
-                        + ` FOREIGN KEY (${SqlDdl.name(c.name)}) REFERENCES ${SqlDdl.name(ref.target.name)} (${theirs.map(SqlDdl.name).join(', ')});`);
+                    out.push(`ALTER TABLE ${table(t.name)} ADD CONSTRAINT ${SqlDdl.name(`fk_${t.name}_${c.name}`.toLowerCase().replace(/[^a-z0-9_]+/g, '_'))}`
+                        + ` FOREIGN KEY (${SqlDdl.name(c.name)}) REFERENCES ${table(ref.entity.name)} (${theirs.map(SqlDdl.name).join(', ')});`);
                 }
             }
             if (this.comments) {
                 const notes = tables.flatMap(t => [
-                    ...(t.description ? [`COMMENT ON TABLE ${SqlDdl.name(t.name)} IS ${SqlDdl.literal(t.description)};`] : []),
-                    ...(t.attributes ?? []).filter(c => c.description).map(c => `COMMENT ON COLUMN ${SqlDdl.name(t.name)}.${SqlDdl.name(c.name)} IS ${SqlDdl.literal(c.description)};`),
+                    ...(t.description ? [`COMMENT ON TABLE ${table(t.name)} IS ${SqlDdl.literal(t.description)};`] : []),
+                    ...(t.attributes ?? []).filter(c => c.description).map(c => `COMMENT ON COLUMN ${table(t.name)}.${SqlDdl.name(c.name)} IS ${SqlDdl.literal(c.description)};`),
                 ]);
                 if (notes.length) out.push('', ...notes);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peter.prib/renderengine",
-  "version": "0.2.10",
+  "version": "0.2.11",
   "description": "ArchiMate modeller, diagram editor and chart library for the browser, with no runtime dependencies.",
   "type": "module",
   "main": "src/index.js",

package/src/charting/datamodel/DataModelChecker.js

@@ -53,17 +53,13 @@ export class DataModelChecker extends ModelChecker {
     foreignKeys() {
         return ATTRIBUTED.flatMap(level => {
             const schema = this.model.level(level);
-            const find = (ref) => {
-                const [name] = String(ref).split('.');
-                return schema.entity(name) ?? schema.entities.find(e => e.name.toLowerCase() === name.trim().toLowerCase()) ?? null;
-            };
             const related = (a, b) => schema.relationships.some(r => (r.source === a && r.target === b) || (r.source === b && r.target === a));
             return schema.entities.flatMap(e => (e.attributes ?? []).filter(a => a.isFK).flatMap(a => {
                 if (!a.references) {
                     return schema.relationships.some(r => r.source === e.id || r.target === e.id) ? []
                         : [this._entity(level, e, 'foreign-key-unrelated', 'info', `"${e.name}.${a.name}" is a foreign key, but "${e.name}" has no relationship`)];
                 }
-                const target = find(a.references);
+                const target = schema.resolveReference(a.references)?.entity;
                 if (!target) return [this._entity(level, e, 'reference-missing', 'warning', `"${e.name}.${a.name}" references "${a.references}", which is not at the ${level} level`)];
                 return related(e.id, target.id) ? []
                     : [this._entity(level, e, 'foreign-key-without-relationship', 'warning', `"${e.name}.${a.name}" references "${target.name}", but they have no relationship`)];

package/src/charting/datamodel/LevelSchema.js

@@ -27,6 +27,29 @@ export class LevelSchema {
         return this.entities.find(e => e.id === id) ?? null;
     }
 
+    /** An entity by id, else by name (any case), or null. */
+    named(text) {
+        const s = String(text ?? '').trim();
+        return this.entity(s) ?? this.entities.find(e => String(e.name ?? '').toLowerCase() === s.toLowerCase()) ?? null;
+    }
+
+    /**
+     * What a foreign key's `references` names: `{ entity, column }` (column
+     * null when it names the table alone), or null. `table` or `table.column`,
+     * the table by id or name; a table's own name may hold dots (a
+     * schema-qualified `sales.customer`), so the whole text is tried as a
+     * table first, then what is before its last dot, the rest its column.
+     */
+    resolveReference(ref) {
+        const text = String(ref ?? '').trim();
+        if (!text) return null;
+        const whole = this.named(text);
+        if (whole) return { entity: whole, column: null };
+        const dot = text.lastIndexOf('.');
+        const entity = dot > 0 ? this.named(text.slice(0, dot)) : null;
+        return entity ? { entity, column: text.slice(dot + 1).trim() || null } : null;
+    }
+
     /** Add an entity (its id unique at this level). */
     addEntity(entity) {
         if (!entity?.id) throw new TypeError('An entity needs an id');

package/src/charting/datamodel/SqlDdl.js

@@ -27,6 +27,15 @@ export class SqlDdl {
         return /^[a-z_][a-z0-9_]*$/.test(s) && !RESERVED.has(s) ? s : `"${s.replace(/"/g, '""')}"`;
     }
 
+    /**
+     * A table's name as SQL takes it: a schema-qualified one (`sales.customer`)
+     * each part as name() has it, so it names the table in its schema rather
+     * than one table called "sales.customer".
+     */
+    static tableName(text) {
+        return String(text).split('.').map(SqlDdl.name).join('.');
+    }
+
     /** A text as an SQL string literal. */
     static literal(text) {
         return `'${String(text).replace(/'/g, "''")}'`;
@@ -36,11 +45,7 @@ export class SqlDdl {
     write(model) {
         const schema = model.level('physical');
         const tables = schema.entities;
-        const find = (ref) => {
-            const [table, column] = String(ref).split('.').map(s => s.trim());
-            const target = schema.entity(table) ?? tables.find(t => t.name.toLowerCase() === table.toLowerCase());
-            return target ? { target, column } : null;
-        };
+        const table = SqlDdl.tableName;
         const out = [`-- ${model.name || 'Data model'}: the physical level, ${tables.length} table${tables.length === 1 ? '' : 's'}`, ''];
         for (const t of tables) {
             const columns = t.attributes ?? [];
@@ -50,28 +55,28 @@ export class SqlDdl {
                 ...(keys.length ? [`    PRIMARY KEY (${keys.join(', ')})`] : []),
                 ...columns.filter(c => c.isUnique && !c.isPK).map(c => `    UNIQUE (${SqlDdl.name(c.name)})`),
             ];
-            out.push(`CREATE TABLE ${SqlDdl.name(t.name)} (`, lines.join(',\n'), ');', '');
+            out.push(`CREATE TABLE ${table(t.name)} (`, lines.join(',\n'), ');', '');
         }
         for (const t of tables) {
             for (const c of (t.attributes ?? []).filter(a => a.isFK && a.references)) {
-                const ref = find(c.references);
+                const ref = schema.resolveReference(c.references);
                 if (!ref) {
                     out.push(`-- ${t.name}.${c.name} references ${c.references}, which is not a table here`);
                     continue;
                 }
-                const theirs = ref.column ? [ref.column] : (ref.target.attributes ?? []).filter(a => a.isPK).map(a => a.name);
+                const theirs = ref.column ? [ref.column] : (ref.entity.attributes ?? []).filter(a => a.isPK).map(a => a.name);
                 if (!theirs.length) {
-                    out.push(`-- ${t.name}.${c.name} references ${ref.target.name}, which has no primary key`);
+                    out.push(`-- ${t.name}.${c.name} references ${ref.entity.name}, which has no primary key`);
                     continue;
                 }
-                out.push(`ALTER TABLE ${SqlDdl.name(t.name)} ADD CONSTRAINT ${SqlDdl.name(`fk_${t.name}_${c.name}`.toLowerCase().replace(/[^a-z0-9_]+/g, '_'))}`
-                    + ` FOREIGN KEY (${SqlDdl.name(c.name)}) REFERENCES ${SqlDdl.name(ref.target.name)} (${theirs.map(SqlDdl.name).join(', ')});`);
+                out.push(`ALTER TABLE ${table(t.name)} ADD CONSTRAINT ${SqlDdl.name(`fk_${t.name}_${c.name}`.toLowerCase().replace(/[^a-z0-9_]+/g, '_'))}`
+                    + ` FOREIGN KEY (${SqlDdl.name(c.name)}) REFERENCES ${table(ref.entity.name)} (${theirs.map(SqlDdl.name).join(', ')});`);
             }
         }
         if (this.comments) {
             const notes = tables.flatMap(t => [
-                ...(t.description ? [`COMMENT ON TABLE ${SqlDdl.name(t.name)} IS ${SqlDdl.literal(t.description)};`] : []),
-                ...(t.attributes ?? []).filter(c => c.description).map(c => `COMMENT ON COLUMN ${SqlDdl.name(t.name)}.${SqlDdl.name(c.name)} IS ${SqlDdl.literal(c.description)};`),
+                ...(t.description ? [`COMMENT ON TABLE ${table(t.name)} IS ${SqlDdl.literal(t.description)};`] : []),
+                ...(t.attributes ?? []).filter(c => c.description).map(c => `COMMENT ON COLUMN ${table(t.name)}.${SqlDdl.name(c.name)} IS ${SqlDdl.literal(c.description)};`),
             ]);
             if (notes.length) out.push('', ...notes);
         }