@dbml/parse 9.0.0-alpha.1 → 9.0.0-alpha.11

package/dist/src/compiler/index.d.ts

@@ -3,11 +3,10 @@ import { SyntaxNode, SyntaxNodeIdGenerator } from '../core/types/nodes';
 import { NodeSymbolIdGenerator, SymbolFactory } from '../core/types/symbol';
 import { DBMLCompletionItemProvider, DBMLDefinitionProvider, DBMLDiagnosticsProvider, DBMLReferencesProvider } from '../services/index';
 import { DbmlProjectLayout } from './projectLayout';
-import { DiagramViewBlock, findDiagramViewBlocks } from './queries/transform';
 import { addDoubleQuoteIfNeeded, escapeString, formatRecordValue, isValidIdentifier, splitQualifiedIdentifier, unescapeString } from './queries/utils';
 export { ScopeKind } from './types';
-export type { DiagramViewBlock, TableNameInput, TextEdit } from './queries/transform';
-export { addDoubleQuoteIfNeeded, escapeString, formatRecordValue, isValidIdentifier, splitQualifiedIdentifier, unescapeString, findDiagramViewBlocks, };
+export type { TextEdit } from './queries/transform';
+export { addDoubleQuoteIfNeeded, escapeString, formatRecordValue, isValidIdentifier, splitQualifiedIdentifier, unescapeString, };
 export default class Compiler {
     layout: DbmlProjectLayout;
     readonly nodeIdGenerator: SyntaxNodeIdGenerator;
@@ -72,12 +71,16 @@ export default class Compiler {
         };
     }>;
     nodeAtPosition: (filepath: Filepath, offset: number) => SyntaxNode | import('..').SyntaxToken | undefined;
-    renameTable: (filepath: Filepath, oldName: import('.').TableNameInput, newName: import('.').TableNameInput) => Map<string, string>;
-    syncDiagramView: (filepath: Filepath, operations: import('..').DiagramViewSyncOperation[], blocks?: DiagramViewBlock[] | undefined) => {
+    renameTable: (filepath: Filepath, oldName: string | import('..').TableIdentifier, newName: string | import('..').TableIdentifier) => Map<string, string>;
+    updateElementSetting: (filepath: Filepath, target: import('..').ElementIdentifier, settingName: string, value: string | null | undefined) => string;
+    syncDiagramView: (filepath: Filepath, operations: import('..').DiagramViewSyncOperation[], blocks?: import('..').DiagramViewBlock[] | undefined) => {
+        newDbml: string;
+        edits: import('.').TextEdit[];
+    };
+    syncDep: (filepath: Filepath, operations: import('..').DepSyncOperation[], blocks?: import('..').DepBlock[] | undefined) => {
         newDbml: string;
         edits: import('.').TextEdit[];
     };
-    findDiagramViewBlocks(filepath: Filepath): DiagramViewBlock[];
     readonly token: {
         invalidStream: (filepath: Filepath) => readonly import('..').SyntaxToken[];
         flatStream: (filepath: Filepath) => readonly import('..').SyntaxToken[];

package/dist/src/compiler/queries/transform/index.d.ts

@@ -1,4 +1,6 @@
 export { renameTable } from './renameTable';
+export { updateElementSetting } from './updateElementSetting';
 export { syncDiagramView, findDiagramViewBlocks, type DiagramViewSyncOperation, type DiagramViewBlock, } from './syncDiagramView';
+export { syncDep, findDepBlocks, generateDepBlock, type DepSyncOperation, type DepSyncEdge, type DepEndpointRef, type DepBlock, } from './syncDep';
 export { applyTextEdits, type TextEdit } from './applyTextEdits';
-export { type TableNameInput } from './utils';
+export type { ElementIdentifier, SchemaIdentifier, TableIdentifier, ColumnIdentifier, EnumIdentifier, EndpointRef, RefIdentifier, DepIdentifier, NoteIdentifier, TableGroupIdentifier, } from './types';

package/dist/src/compiler/queries/transform/renameTable.d.ts

@@ -1,6 +1,6 @@
 import { Filepath } from '../../../core/types/filepath';
 import { default as Compiler } from '../../index';
-import { TableNameInput } from './utils';
+import { TableIdentifier } from './types';
 /**
  * Renames a table across every file in the project layout.
  *
@@ -23,4 +23,4 @@ import { TableNameInput } from './utils';
  * only the files that were actually changed by the rename. An empty map
  * indicates a no-op (lookup miss, name collision, or alias rename attempt).
  */
-export declare function renameTable(this: Compiler, filepath: Filepath, oldName: TableNameInput, newName: TableNameInput): Map<string, string>;
+export declare function renameTable(this: Compiler, filepath: Filepath, oldName: string | TableIdentifier, newName: string | TableIdentifier): Map<string, string>;

package/dist/src/compiler/queries/transform/syncDep.d.ts

@@ -0,0 +1,60 @@
+import { Filepath } from '../../../core/types/filepath';
+import { ElementDeclarationNode } from '../../../core/types/nodes';
+import { default as Compiler } from '../../index';
+import { TextEdit } from './applyTextEdits';
+export interface DepEndpointRef {
+    schemaName?: string | null;
+    tableName: string;
+    fieldNames?: string[];
+}
+export interface DepSyncEdge {
+    upstream: DepEndpointRef;
+    downstream: DepEndpointRef;
+}
+export interface DepSyncOperation {
+    operation: 'create' | 'update' | 'remove';
+    /** The edge that identifies the target block (table-level: empty fields). */
+    edge: DepSyncEdge;
+    /** Set to a value to create/update, null to remove, undefined to leave unchanged. */
+    color?: string | null;
+    /** Set to a value to create/update, null to remove, undefined to leave unchanged. */
+    note?: string | null;
+}
+export interface DepBlock {
+    startIndex: number;
+    endIndex: number;
+    declaration: ElementDeclarationNode;
+    edges: DepSyncEdge[];
+}
+export interface InlineDep {
+    edge: DepSyncEdge;
+    stripStart: number;
+    stripEnd: number;
+}
+/**
+ * Returns every `Dep` block in `source`.
+ * On any lex or parse error, returns [] - there is no reliable way to read
+ * dep blocks from malformed DBML (mirrors findDiagramViewBlocks).
+ */
+export declare function findDepBlocks(source: string): DepBlock[];
+export declare function findInlineDeps(source: string): InlineDep[];
+/**
+ * Emit a `Dep` block for one edge with a `[color]` setting:
+ *
+ *   Dep [color: <hex>] {
+ *     <upstream> -> <downstream>
+ *   }
+ */
+export declare function generateDepBlock(edge: DepSyncEdge, color: string): string;
+/**
+ * Synchronizes `Dep` blocks in the DBML source at `filepath`.
+ *
+ * @param filepath   The file whose source should be rewritten.
+ * @param operations Array of create/update operations to apply.
+ * @param blocks     Optional pre-parsed blocks from findDepBlocks.
+ * @returns The new DBML source and the text edits applied.
+ */
+export declare function syncDep(this: Compiler, filepath: Filepath, operations: DepSyncOperation[], blocks?: DepBlock[]): {
+    newDbml: string;
+    edits: TextEdit[];
+};

package/dist/src/compiler/queries/transform/types.d.ts

@@ -0,0 +1,48 @@
+import { SymbolKind } from '../../../core/types/symbol';
+import { MetadataKind } from '../../../core/types/symbol/metadata';
+export type ElementIdentifier = (SchemaIdentifier | TableIdentifier | ColumnIdentifier | EnumIdentifier | RefIdentifier | DepIdentifier | NoteIdentifier | TableGroupIdentifier) & {
+    kind: string;
+};
+export interface SchemaIdentifier {
+    kind?: typeof SymbolKind.Schema;
+    schema: string;
+}
+export interface TableIdentifier {
+    kind?: typeof SymbolKind.Table;
+    schema?: string;
+    table: string;
+}
+export interface ColumnIdentifier {
+    kind?: typeof SymbolKind.Column;
+    schema?: string;
+    table: string;
+    column: string;
+}
+export interface EnumIdentifier {
+    kind?: typeof SymbolKind.Enum;
+    schema?: string;
+    name: string;
+}
+export interface EndpointRef {
+    schemaName?: string | null;
+    tableName: string;
+    fieldNames?: string[];
+}
+export interface RefIdentifier {
+    kind?: typeof MetadataKind.Ref;
+    endpoints: [EndpointRef, EndpointRef];
+}
+export interface DepIdentifier {
+    kind?: typeof MetadataKind.Dep;
+    upstream: EndpointRef;
+    downstream: EndpointRef;
+}
+export interface NoteIdentifier {
+    kind?: typeof SymbolKind.StickyNote;
+    name: string;
+}
+export interface TableGroupIdentifier {
+    kind?: typeof SymbolKind.TableGroup;
+    schema?: string;
+    name: string;
+}

package/dist/src/compiler/queries/transform/updateElementSetting.d.ts

@@ -0,0 +1,4 @@
+import { Filepath } from '../../../core/types/filepath';
+import { default as Compiler } from '../../index';
+import { ElementIdentifier } from './types';
+export declare function updateElementSetting(this: Compiler, filepath: Filepath, target: ElementIdentifier, settingName: string, value: string | null | undefined): string;

package/dist/src/compiler/queries/transform/utils.d.ts

@@ -1,22 +1,20 @@
 import { Filepath } from '../../../core/types/filepath';
-import { NodeSymbol } from '../../../core/types/symbol';
+import { NodeSymbol, SymbolKind } from '../../../core/types/symbol';
 import { default as Compiler } from '../../index';
-export type TableNameInput = string | {
+import { EndpointRef } from './types';
+export type { ElementIdentifier } from './types';
+export declare function endpointsEqual(a: EndpointRef, b: EndpointRef): boolean;
+export declare function normalizeTableName(input: string | {
     schema?: string;
     table: string;
-};
-/**
- * Normalizes a table name input to { schema, table } format.
- * Properly handles quoted identifiers with dots inside.
- */
-export declare function normalizeTableName(input: TableNameInput): {
+}): {
     schema: string;
     table: string;
 };
 /**
- * Looks up a table symbol by matching its full qualified name.
+ * Looks up an element symbol by its qualified name and kind.
  */
-export declare function lookupTableSymbol(compiler: Compiler, filepath: Filepath, schema: string, table: string): NodeSymbol | null;
+export declare function lookupElementSymbol(compiler: Compiler, filepath: Filepath, schema: string, name: string, kind?: SymbolKind): NodeSymbol | undefined;
 /**
  * Removes surrounding double quotes from a string if present.
  */

package/dist/src/compiler/queries/utils.d.ts

@@ -99,3 +99,8 @@ export declare function formatRecordValue(recordValue: {
 export declare function splitQualifiedIdentifier(identifier: string): string[];
 export declare function collectTransitiveDependencies(compiler: Compiler, entrypoints: Filepath[]): Filepath[];
 export declare function allVisibleMembers(compiler: Compiler): Report<NodeSymbol[]>;
+/**
+ * Wraps a note value in the appropriate DBML quote style.
+ * Uses triple quotes for multiline content, single quotes otherwise.
+ */
+export declare function quoteNoteValue(value: string): string;

package/dist/src/compiler/types.d.ts

@@ -5,11 +5,12 @@ export declare const enum ScopeKind {
     INDEXES = 3,
     NOTE = 4,
     REF = 5,
-    PROJECT = 6,
-    CUSTOM = 7,
-    TOPLEVEL = 8,
-    TABLEPARTIAL = 9,
-    CHECKS = 10,
-    RECORDS = 11,
-    DIAGRAMVIEW = 12
+    DEP = 6,
+    PROJECT = 7,
+    CUSTOM = 8,
+    TOPLEVEL = 9,
+    TABLEPARTIAL = 10,
+    CHECKS = 11,
+    RECORDS = 12,
+    DIAGRAMVIEW = 13
 }

package/dist/src/core/global_modules/dep/interpret.d.ts

@@ -13,7 +13,7 @@ export declare class DepInterpreter {
     private interpretName;
     private interpretEdges;
     /**
-     * Read settings into `dep.note` and `dep.custom`.
+     * Read settings into `dep.note` and `dep.metadata`.
      *
      * Settings come from THREE sources, in this order:
      *   1. The top-level attribute list on the Dep header
@@ -23,7 +23,7 @@ export declare class DepInterpreter {
      *   3. Sub-element declarations inside the body
      *      (e.g. `Dep { a -> b; note: 'x'; materialized: 'view' }`).
      *
-     * All three sources write into the same `custom` object (with `note`
+     * All three sources write into the same `metadata` object (with `note`
      * routed to the typed slot instead). Precedence is last-write-wins by
      * virtue of plain object assignment — settings later in the source
      * file overwrite earlier ones with the same key.

package/dist/src/core/local_modules/dep/validate.d.ts

@@ -8,6 +8,7 @@ export default class DepValidator {
     private compiler;
     constructor(compiler: Compiler, declarationNode: ElementDeclarationNode);
     validate(): CompileError[];
+    private validateSettings;
     private validateContext;
     private validateName;
     private validateAlias;

package/dist/src/core/types/errors.d.ts

@@ -113,9 +113,10 @@ export declare enum CompileErrorCode {
     UNSUPPORTED = 5000,
     CIRCULAR_REF = 5001,
     SAME_ENDPOINT = 5002,
-    UNEQUAL_FIELDS_BINARY_REF = 5003,
-    CONFLICTING_SETTING = 5004,
-    TABLE_REAPPEAR_IN_TABLEGROUP = 5005
+    DEP_SELF_LOOP = 5003,
+    UNEQUAL_FIELDS_BINARY_REF = 5004,
+    CONFLICTING_SETTING = 5005,
+    TABLE_REAPPEAR_IN_TABLEGROUP = 5006
 }
 export declare class CompileError extends Error {
     code: Readonly<CompileErrorCode>;