@dbml/core 11.0.1 → 11.0.2-metadata-ref.0

package/lib/export/DbmlExporter.cjs

@@ -4,7 +4,7 @@ require("../_virtual/_rolldown/runtime.cjs");const e=require("../node_modules/lo
 `)}\n}\n`});return n.length?n.join(`
 `):``}static getFieldLines(e,t){return t.tables[e].fieldIds.map(e=>{let n=t.fields[e],i=``;n.type.schemaName&&n.type.schemaName!==`public`&&(i=r.hasWhiteSpace(n.type.schemaName)?`"${n.type.schemaName}".`:`${n.type.schemaName}.`);let a=`"${n.name}" ${i}${r.hasWhiteSpace(n.type.type_name)||r.hasSquareBracket(n.type.type_name)?`"${n.type.type_name}"`:n.type.type_name}`,o=[];if(n.unique&&o.push(`unique`),n.pk&&o.push(`pk`),n.not_null&&o.push(`not null`),n.increment&&o.push(`increment`),n.checkIds&&o.push(...n.checkIds.map(e=>`check: \`${t.checks[e].expression}\``)),n.dbdefault&&(n.dbdefault.type!==`boolean`||n.dbdefault.value!==null&&(typeof n.dbdefault.value!=`string`||n.dbdefault.value.toLowerCase()!==`null`))){let e=`default: `;switch(n.dbdefault.type){case`boolean`:case`number`:e+=`${n.dbdefault.value}`;break;case`string`:{let t=String(n.dbdefault.value),r=t.includes(`
 `)?`'''`:`'`;e+=`${r}${t}${r}`;break}case`expression`:e+=`\`${n.dbdefault.value}\``;break;default:e+=`\`${n.dbdefault.value}\``}o.push(e)}return n.note&&o.push(`note: ${r.escapeNote(n.note)}`),o.length>0&&(a+=` [${o.join(`, `)}]`),a})}static getIndexLines(e,t){return t.tables[e].indexIds.map(e=>{let n=``,r=t.indexes[e],i=r.columnIds.map(e=>{let n=t.indexColumns[e],r=n.type===`expression`?`\`${n.value}\``:n.value;return n.sortOrder===`desc`?`${r} [desc]`:r}),a=r.columnIds.some(e=>t.indexColumns[e].sortOrder===`desc`);i.length>1||a?n=`(${i.join(`, `)})`:i.length===1&&(n=i[0]);let o=[];return r.pk&&o.push(`pk`),r.type&&o.push(`type: ${r.type.toLowerCase()}`),r.unique&&o.push(`unique`),r.name&&o.push(`name: "${r.name}"`),o.length>1?n+=` [${o.join(`, `)}]`:o.length===1&&(n+=` [${o[0]}]`),n})}static getCheckLines(e,t){return t.tables[e].checkIds.map(e=>{let n=``,{expression:r,name:i}=t.checks[e];return n+=`\`${r}\``,i&&(n+=` [name: '${i}']`),n})}static getTableContentArr(e,t){return e.map(e=>({tableId:e,fieldContents:r.getFieldLines(e,t),checkContents:r.getCheckLines(e,t),indexContents:r.getIndexLines(e,t)}))}static getTableSettings(e){let t=``;return e.headerColor&&(t+=`headerColor: ${e.headerColor}, `),t.endsWith(`, `)&&(t=t.replace(/,\s$/,``)),t?` [${t}]`:``}static exportTables(e,n){let o=r.getTableContentArr(e,n).map(e=>{let o=n.tables[e.tableId],s=n.schemas[o.schemaId],c=r.getTableSettings(o),l=`"${o.name}"`;i.shouldPrintSchema(s,n)&&(l=`"${s.name}"."${o.name}"`);let u=o.alias?` as ${(0,a.addDoubleQuoteIfNeeded)(o.alias)}`:``,d=e.fieldContents.map(e=>`  ${e}\n`).join(``),f=``;t.default(e.checkContents)||(f=`\n  Checks {\n${e.checkContents.map(e=>`    ${e}\n`).join(``)}  }\n`);let p=``;t.default(e.indexContents)||(p=`\n  Indexes {\n${e.indexContents.map(e=>`    ${e}\n`).join(``)}  }\n`);let m=o.note?`  Note: ${r.escapeNote(o.note)}\n`:``;return`Table ${l}${u}${c} {\n${d}${f}${p}${m}}\n`});return o.length?o.join(`
-`):``}static buildFieldName(e,t){let n=e.map(e=>`"${t.fields[e].name}"`).join(`, `);return e.length===1?n:`(${n})`}static exportRefs(e,t){let n=e.map(e=>{let n=t.refs[e],o=n.endpointIds.findIndex(e=>(0,a.parseCardinality)(t.endpoints[e].relation).max===1),s=o===-1?0:o,c=t.endpoints[n.endpointIds[s]],l=t.endpoints[n.endpointIds[1-s]],u=(0,a.getRelationshipOp)(c.relation,l.relation),d=t.fields[c.fieldIds[0]],f=t.tables[d.tableId],p=t.schemas[f.schemaId],m=r.buildFieldName(c.fieldIds,t),h=`Ref`;n.name&&(h+=` ${i.shouldPrintSchema(t.schemas[n.schemaId],t)?`"${t.schemas[n.schemaId].name}".`:``}"${n.name}"`),h+=`:`,h+=`${i.shouldPrintSchema(p,t)?`"${p.name}".`:``}"${f.name}".${m} `;let g=t.fields[l.fieldIds[0]],_=t.tables[g.tableId],v=t.schemas[_.schemaId],y=r.buildFieldName(l.fieldIds,t);h+=`${u} `,h+=`${i.shouldPrintSchema(v,t)?`"${v.name}".`:``}"${_.name}".${y}`;let b=[];return n.onUpdate&&b.push(`update: ${n.onUpdate.toLowerCase()}`),n.onDelete&&b.push(`delete: ${n.onDelete.toLowerCase()}`),n.inactive&&b.push(`inactive`),b.length>0&&(h+=` [${b.join(`, `)}]`),h+=`
+`):``}static buildFieldName(e,t){let n=e.map(e=>`"${t.fields[e].name}"`).join(`, `);return e.length===1?n:`(${n})`}static exportRefs(e,t){let n=e.map(e=>{let n=t.refs[e],o=n.endpointIds.findIndex(e=>(0,a.parseCardinality)(t.endpoints[e].relation).max===1),s=o===-1?0:o,c=t.endpoints[n.endpointIds[s]],l=t.endpoints[n.endpointIds[1-s]],u=(0,a.getRelationshipOp)(c.relation,l.relation),d=t.fields[c.fieldIds[0]],f=t.tables[d.tableId],p=t.schemas[f.schemaId],m=r.buildFieldName(c.fieldIds,t),h=`Ref`;n.name&&(h+=` ${i.shouldPrintSchema(t.schemas[n.schemaId],t)?`"${t.schemas[n.schemaId].name}".`:``}"${n.name}"`),h+=`:`,h+=`${i.shouldPrintSchema(p,t)?`"${p.name}".`:``}"${f.name}".${m} `;let g=t.fields[l.fieldIds[0]],_=t.tables[g.tableId],v=t.schemas[_.schemaId],y=r.buildFieldName(l.fieldIds,t);h+=`${u} `,h+=`${i.shouldPrintSchema(v,t)?`"${v.name}".`:``}"${_.name}".${y}`;let b=[];return n.onUpdate&&b.push(`update: ${n.onUpdate.toLowerCase()}`),n.onDelete&&b.push(`delete: ${n.onDelete.toLowerCase()}`),n.color&&b.push(`color: ${n.color}`),n.inactive&&b.push(`inactive`),n.note&&b.push(`note: ${r.escapeNote(n.note)}`),Object.entries(n.metadata??{}).forEach(([e,t])=>{b.push(`${e}: ${r.formatMetadataValue(t)}`)}),b.length>0&&(h+=` [${b.join(`, `)}]`),h+=`
 `,h});return n.length?n.join(`
 `):``}static getTableGroupSettings(e){let t=[];return e.color&&t.push(`color: ${e.color}`),t.length?` [${t.join(`, `)}]`:``}static formatDepEndpoint(e){let t=e.schemaName?`"${e.schemaName}".`:``,n=`"${e.tableName}"`;return!e.fieldNames||e.fieldNames.length===0?`${t}${n}`:`${t}${n}.${e.fieldNames.length===1?`"${e.fieldNames[0]}"`:`(${e.fieldNames.map(e=>`"${e}"`).join(`, `)})`}`}static formatDepCustomValue(e){return typeof e==`string`?`'${(0,a.escapeString)(e)}'`:e==null?`null`:String(e)}static exportDeps(e,t){let n=e.map(e=>{let n=t.deps[e],i=n.edgeIds.map(e=>t.depEdges[e]),a=!!n.note,o=n.metadata?Object.entries(n.metadata):[],s=a||o.length>0;if(i.length===1&&!s)return`Dep: ${r.formatDepEndpoint(i[0].upstream)} -> ${r.formatDepEndpoint(i[0].downstream)}\n`;let c=`Dep {
 `;return i.forEach(e=>{c+=`  ${r.formatDepEndpoint(e.upstream)} -> ${r.formatDepEndpoint(e.downstream)}\n`}),s&&(c+=`

package/lib/export/DbmlExporter.mjs

@@ -109,7 +109,9 @@ var d = class r {
 			let _ = t.fields[l.fieldIds[0]], v = t.tables[_.tableId], y = t.schemas[v.schemaId], b = r.buildFieldName(l.fieldIds, t);
 			g += `${d} `, g += `${i(y, t) ? `"${y.name}".` : ""}"${v.name}".${b}`;
 			let x = [];
-			return n.onUpdate && x.push(`update: ${n.onUpdate.toLowerCase()}`), n.onDelete && x.push(`delete: ${n.onDelete.toLowerCase()}`), n.inactive && x.push("inactive"), x.length > 0 && (g += ` [${x.join(", ")}]`), g += "\n", g;
+			return n.onUpdate && x.push(`update: ${n.onUpdate.toLowerCase()}`), n.onDelete && x.push(`delete: ${n.onDelete.toLowerCase()}`), n.color && x.push(`color: ${n.color}`), n.inactive && x.push("inactive"), n.note && x.push(`note: ${r.escapeNote(n.note)}`), Object.entries(n.metadata ?? {}).forEach(([e, t]) => {
+				x.push(`${e}: ${r.formatMetadataValue(t)}`);
+			}), x.length > 0 && (g += ` [${x.join(", ")}]`), g += "\n", g;
 		});
 		return n.length ? n.join("\n") : "";
 	}

package/lib/model_structure/element.cjs

@@ -1 +1 @@
-require("../_virtual/_rolldown/runtime.cjs");var e=class extends Error{constructor(e,t={start:{line:1,column:1}}){super(e),this.location=t,this.error=`error`}},t=class{constructor(e){this.token=e}bind(e){this.selection=e}error(t){throw new e(t,this.token)}};exports.default=t;
+require("../_virtual/_rolldown/runtime.cjs");var e=class extends Error{constructor(e,t){super(e),this.location=t,this.error=`error`}},t=class{constructor(e){this.token=e}bind(e){this.selection=e}error(t){throw new e(t,this.token)}};exports.default=t;

package/lib/model_structure/element.mjs

@@ -1,9 +1,6 @@
-//#region src/model_structure/element.js
+//#region src/model_structure/element.ts
 var e = class extends Error {
-	constructor(e, t = { start: {
-		line: 1,
-		column: 1
-	} }) {
+	constructor(e, t) {
 		super(e), this.location = t, this.error = "error";
 	}
 }, t = class {

package/lib/model_structure/ref.cjs

@@ -1 +1 @@
-require("../_virtual/_rolldown/runtime.cjs"),require("./config.cjs");const e=require("./element.cjs"),t=require("./endpoint.cjs");function n(e,t){return e[0].equals(t[0])&&e[1].equals(t[1])}var r=class extends e.default{constructor({name:e,color:t,endpoints:n,onDelete:r,onUpdate:i,inactive:a,token:o,schema:s={},injectedPartial:c=null}={}){super(o),this.name=e,this.color=t,this.onDelete=r,this.onUpdate=i,this.inactive=a,this.endpoints=[],this.schema=s,this.injectedPartial=c,this.dbState=this.schema.dbState,this.generateId(),this.processEndpoints(n)}generateId(){this.id=this.dbState.generateId(`refId`)}processEndpoints(e){e.forEach(e=>{this.endpoints.push(new t.default({...e,ref:this})),e.schemaName}),this.endpoints[0].equals(this.endpoints[1])&&this.error(`Two endpoints are the same`),this.endpoints[0].fields.length!==this.endpoints[1].fields.length&&this.error(`Two endpoints have unequal number of fields`)}equals(e){return n(this.endpoints,e.endpoints)||n(this.endpoints,e.endpoints.slice().reverse())}export(){return{...this.shallowExport(),...this.exportChild()}}shallowExport(){return{name:this.name,color:this.color,onDelete:this.onDelete,onUpdate:this.onUpdate,inactive:this.inactive,injectedPartialId:this.injectedPartial?.id}}exportChild(){return{endpoints:this.endpoints.map(e=>e.export())}}exportChildIds(){return{endpointIds:this.endpoints.map(e=>e.id)}}exportParentIds(){return{schemaId:this.schema.id}}normalize(e){e.refs[this.id]={id:this.id,...this.shallowExport(),...this.exportChildIds(),...this.exportParentIds()},this.endpoints.forEach(t=>t.normalize(e))}};exports.default=r;
+require("../_virtual/_rolldown/runtime.cjs"),require("./config.cjs");const e=require("./element.cjs"),t=require("../packages/dbml-core/node_modules/lodash/lodash.cjs"),n=require("./endpoint.cjs");var r=t.default;function i(e,t){return e[0].equals(t[0])&&e[1].equals(t[1])}var a=class extends e.default{constructor({name:e,color:t,note:n,noteToken:i=null,endpoints:a,onDelete:o,onUpdate:s,inactive:c,token:l,schema:u={},injectedPartial:d=null,metadata:f={}}={}){super(l),this.name=e,this.color=t,this.note=n?(0,r.get)(n,`value`,n):null,this.noteToken=n?(0,r.get)(n,`token`,i):null,this.onDelete=o,this.onUpdate=s,this.inactive=c,this.metadata=f,this.endpoints=[],this.schema=u,this.injectedPartial=d,this.dbState=this.schema.dbState,this.generateId(),this.processEndpoints(a)}generateId(){this.id=this.dbState.generateId(`refId`)}processEndpoints(e){e.forEach(e=>{this.endpoints.push(new n.default({...e,ref:this})),e.schemaName}),this.endpoints[0].equals(this.endpoints[1])&&this.error(`Two endpoints are the same`),this.endpoints[0].fields.length!==this.endpoints[1].fields.length&&this.error(`Two endpoints have unequal number of fields`)}equals(e){return i(this.endpoints,e.endpoints)||i(this.endpoints,e.endpoints.slice().reverse())}export(){return{...this.shallowExport(),...this.exportChild()}}shallowExport(){return{name:this.name,color:this.color,note:this.note,onDelete:this.onDelete,onUpdate:this.onUpdate,inactive:this.inactive,metadata:this.metadata,injectedPartialId:this.injectedPartial?.id}}exportChild(){return{endpoints:this.endpoints.map(e=>e.export())}}exportChildIds(){return{endpointIds:this.endpoints.map(e=>e.id)}}exportParentIds(){return{schemaId:this.schema.id}}normalize(e){e.refs[this.id]={id:this.id,...this.shallowExport(),...this.exportChildIds(),...this.exportParentIds()},this.endpoints.forEach(t=>t.normalize(e))}};exports.default=a;

package/lib/model_structure/ref.mjs

@@ -1,27 +1,29 @@
 import "./config.mjs";
 import e from "./element.mjs";
-import t from "./endpoint.mjs";
+import { require_lodash as t } from "../packages/dbml-core/node_modules/lodash/lodash.mjs";
+import n from "./endpoint.mjs";
 //#region src/model_structure/ref.js
-function n(e, t) {
+var r = t();
+function i(e, t) {
 	return e[0].equals(t[0]) && e[1].equals(t[1]);
 }
-var r = class extends e {
-	constructor({ name: e, color: t, endpoints: n, onDelete: r, onUpdate: i, inactive: a, token: o, schema: s = {}, injectedPartial: c = null } = {}) {
-		super(o), this.name = e, this.color = t, this.onDelete = r, this.onUpdate = i, this.inactive = a, this.endpoints = [], this.schema = s, this.injectedPartial = c, this.dbState = this.schema.dbState, this.generateId(), this.processEndpoints(n);
+var a = class extends e {
+	constructor({ name: e, color: t, note: n, noteToken: i = null, endpoints: a, onDelete: o, onUpdate: s, inactive: c, token: l, schema: u = {}, injectedPartial: d = null, metadata: f = {} } = {}) {
+		super(l), this.name = e, this.color = t, this.note = n ? (0, r.get)(n, "value", n) : null, this.noteToken = n ? (0, r.get)(n, "token", i) : null, this.onDelete = o, this.onUpdate = s, this.inactive = c, this.metadata = f, this.endpoints = [], this.schema = u, this.injectedPartial = d, this.dbState = this.schema.dbState, this.generateId(), this.processEndpoints(a);
 	}
 	generateId() {
 		this.id = this.dbState.generateId("refId");
 	}
 	processEndpoints(e) {
 		e.forEach((e) => {
-			this.endpoints.push(new t({
+			this.endpoints.push(new n({
 				...e,
 				ref: this
 			})), e.schemaName;
 		}), this.endpoints[0].equals(this.endpoints[1]) && this.error("Two endpoints are the same"), this.endpoints[0].fields.length !== this.endpoints[1].fields.length && this.error("Two endpoints have unequal number of fields");
 	}
 	equals(e) {
-		return n(this.endpoints, e.endpoints) || n(this.endpoints, e.endpoints.slice().reverse());
+		return i(this.endpoints, e.endpoints) || i(this.endpoints, e.endpoints.slice().reverse());
 	}
 	export() {
 		return {
@@ -33,9 +35,11 @@ var r = class extends e {
 		return {
 			name: this.name,
 			color: this.color,
+			note: this.note,
 			onDelete: this.onDelete,
 			onUpdate: this.onUpdate,
 			inactive: this.inactive,
+			metadata: this.metadata,
 			injectedPartialId: this.injectedPartial?.id
 		};
 	}
@@ -58,4 +62,4 @@ var r = class extends e {
 	}
 };
 //#endregion
-export { r as default };
+export { a as default };

package/lib/model_structure/utils.mjs

@@ -1,5 +1,5 @@
 import { DEFAULT_SCHEMA_NAME as e } from "./config.mjs";
-//#region src/model_structure/utils.js
+//#region src/model_structure/utils.ts
 function t(e) {
 	return e.name !== "public" || e.name === "public" && e.database.hasDefaultSchema;
 }

package/lib/packages/dbml-core/package.json.cjs

@@ -1 +1 @@
-require("../../_virtual/_rolldown/runtime.cjs");var e=`11.0.1`;exports.version=e;
+require("../../_virtual/_rolldown/runtime.cjs");var e=`11.0.2-metadata-ref.0`;exports.version=e;

package/lib/packages/dbml-core/package.json.mjs

@@ -1,4 +1,4 @@
 //#region package.json
-var e = "11.0.1";
+var e = "11.0.2-metadata-ref.0";
 //#endregion
 export { e as version };

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@dbml/core",
-  "version": "11.0.1",
+  "version": "11.0.2-metadata-ref.0",
   "description": "> TODO: description",
   "author": "Holistics <dev@holistics.io>",
   "license": "Apache-2.0",
@@ -48,7 +48,7 @@
     "lint:fix": "eslint --fix ."
   },
   "dependencies": {
-    "@dbml/parse": "^11.0.1",
+    "@dbml/parse": "^11.0.2-metadata-ref.0",
     "antlr4": "^4.13.1",
     "lodash": "^4.18.1",
     "lodash-es": "^4.18.1",
@@ -59,7 +59,7 @@
   "devDependencies": {
     "bluebird": "^3.5.5"
   },
-  "gitHead": "0418f4b2e67a160852e500bddf1992e10196d5ac",
+  "gitHead": "e12ad329a8f1b18669f87af891df7b59a9b18789",
   "engines": {
     "node": ">=16"
   }

package/types/model_structure/element.d.ts

@@ -1,32 +1,4 @@
-import type { Filepath } from '@dbml/parse';
+export type { Color, Token, RawNote } from '../../src/model_structure/element';
+import Element from '../../src/model_structure/element';
 
-export type Color = `#${string}` | 'none';
-
-export interface Token {
-    end: {
-        column: number;
-        line: number;
-        offset: number;
-    };
-    start: {
-        column: number;
-        line: number;
-        offset: number;
-    };
-    filepath?: Filepath;
-}
-
-export interface RawNote {
-    value: string;
-    token: Token;
-}
-
-declare class Element {
-    token: Token;
-    id: number;
-    selection: string;
-    constructor(token: Token);
-    bind(selection: any): void;
-    error(message: string): void;
-}
 export default Element;

package/types/model_structure/ref.d.ts

@@ -1,4 +1,5 @@
-import Element, { Token, Color } from './element';
+import type { CustomMetadata } from '@dbml/parse';
+import Element, { Token, Color, RawNote } from './element';
 import Endpoint from './endpoint';
 import Schema from './schema';
 import DbState from './dbState';
@@ -7,26 +8,31 @@ import TablePartial from './tablePartial';
 export interface RawRef {
     name: string;
     color?: Color;
+    note?: RawNote;
     endpoints: Endpoint[];
     onDelete: any;
     onUpdate: any;
     inactive?: boolean;
+    metadata?: CustomMetadata;
     token: Token;
     schema: Schema;
 }
 declare class Ref extends Element {
     name: string;
     color?: Color;
+    note: string;
+    noteToken: Token;
     endpoints: Endpoint[];
     onDelete: any;
     onUpdate: any;
     inactive?: boolean;
+    metadata: CustomMetadata;
     schema: Schema;
     dbState: DbState;
     id: number;
     database: Database;
     injectedPartial?: TablePartial;
-    constructor({ name, endpoints, onDelete, onUpdate, token, schema }: RawRef);
+    constructor({ name, endpoints, onDelete, onUpdate, note, metadata, token, schema }: RawRef);
     generateId(): void;
     processEndpoints(rawEndpoints: any): void;
     equals(ref: any): any;
@@ -40,13 +46,16 @@ declare class Ref extends Element {
         name: string;
         onDelete: any;
         onUpdate: any;
+        metadata: CustomMetadata;
         injectedPartialId?: number;
     };
     shallowExport(): {
         name: string;
         onDelete: any;
         onUpdate: any;
+        metadata: CustomMetadata;
         injectedPartialId?: number;
+        note: string;
     };
     exportChild(): {
         endpoints: {
@@ -71,9 +80,11 @@ export interface NormalizedRef {
     onUpdate?: string;
     onDelete?: string;
     inactive?: boolean;
+    metadata: CustomMetadata;
     schemaId: number;
     endpointIds: number[];
     injectedPartialId?: number;
+    note: string;
 }
 
 export interface NormalizedRefIdMap {