@dbml/parse 10.0.0-optional-ref.0 → 10.1.0-alpha.0

package/dist/src/core/utils/interpret.d.ts

@@ -1,16 +1,26 @@
 import { default as Compiler } from '../../compiler';
-import { Color, ColumnType, TokenPosition } from '../types/schemaJson';
+import { Color, ColumnType, CustomMetadata, TokenPosition } from '../types/schemaJson';
 import { SyntaxNode } from '../types/nodes';
 import { default as Report } from '../types/report';
+import { Settings } from './validate';
+import { SettingName } from '../types';
 export declare function getTokenPosition(node: SyntaxNode): TokenPosition;
 export declare function normalizeNote(content: string): string;
 export declare function extractElementName(nameNode: SyntaxNode): {
     schemaName: string[];
     name: string;
 };
-export declare function extractColor(node: unknown): Color | undefined;
+export declare function extractColor(node?: SyntaxNode): Color | undefined;
 export declare function processDefaultValue(valueNode?: SyntaxNode): {
     type: 'number' | 'string' | 'boolean' | 'expression';
     value: string | number;
 } | undefined;
 export declare function processColumnType(compiler: Compiler, typeNode: SyntaxNode): Report<ColumnType>;
+/**
+  * Extract inline custom metadata from an aggregated setting list,
+  * excluding keys that are natively attached to the element (headercolor and note in `table`, color in `tablegroup`, .etc).
+  *
+  * NOTE: This is used during interpret phase, so no need to validate values, just extract them
+  */
+export declare function extractCustomInlineMetadata(settingMap: Settings, builtinSettings: readonly SettingName[]): CustomMetadata;
+export declare function extractMetadataValue(node?: SyntaxNode): string | Color | undefined;

package/dist/src/core/utils/note.d.ts

@@ -0,0 +1,18 @@
+import { SyntaxNode } from '../types/nodes';
+import { TextEdit } from '../../compiler/queries/transform/applyTextEdits';
+/**
+ * Produces a TextEdit that updates an existing note's value.
+ * Returns undefined if no note exists.
+ */
+export declare function updateNoteEdit(declaration: SyntaxNode, newValue: string): TextEdit | undefined;
+/**
+ * Produces a TextEdit that removes an existing note.
+ * Returns undefined if no note exists.
+ */
+export declare function removeNoteEdit(declaration: SyntaxNode): TextEdit | undefined;
+/**
+ * Produces a TextEdit that adds a note to an element.
+ * Prioritizes body note form for block elements, falls back to setting attribute.
+ * Returns undefined if a note already exists.
+ */
+export declare function addNoteEdit(declaration: SyntaxNode, value: string): TextEdit | undefined;

package/dist/src/core/utils/setting.d.ts

@@ -1,17 +1,16 @@
-import { SyntaxNode } from '../types/nodes';
+import { ListExpressionNode, AttributeNode, ElementDeclarationNode, SyntaxNode } from '../types/nodes';
 import { TextEdit } from '../../compiler/queries/transform/applyTextEdits';
-/**
- * Produces a TextEdit that adds a setting to a field/element declaration.
- * If the declaration already has a settings block [...], inserts before the closing ].
- * Otherwise, appends a new [setting] block.
- */
+export type SettingLocation = {
+    kind: 'attribute';
+    settingsList: ListExpressionNode;
+    settingNode: AttributeNode;
+    settingIndex: number;
+} | {
+    kind: 'body';
+    declaration: ElementDeclarationNode;
+} | undefined;
+export declare function findSetting(declaration: SyntaxNode, settingName: string): SettingLocation;
 export declare function addSettingEdit(declaration: SyntaxNode, setting: string): TextEdit | undefined;
-/**
- * Produces a TextEdit that updates an existing setting's value in a declaration.
- */
-export declare function updateSettingEdit(declaration: SyntaxNode, settingName: string, newValue: string, source: string): TextEdit | undefined;
-/**
- * Produces a TextEdit that removes a setting from a declaration.
- * If it's the only setting, removes the entire settings block [...].
- */
+export declare function updateSettingEdit(declaration: SyntaxNode, settingName: string, value: string | null | undefined, source: string): TextEdit | undefined;
 export declare function removeSettingEdit(declaration: SyntaxNode, settingName: string, source: string): TextEdit | undefined;
+export declare function findBodySetting(declaration: ElementDeclarationNode, settingName: string): ElementDeclarationNode | undefined;

package/dist/src/core/utils/span.d.ts

@@ -1,4 +1,6 @@
+import { default as Compiler } from '../../compiler';
 import { ElementDeclarationNode, SyntaxNode } from '../types/nodes';
 import { SyntaxToken } from '../types/tokens';
 export declare function isOffsetWithinSpan(offset: number, nodeOrToken: SyntaxNode | SyntaxToken): boolean;
 export declare function isOffsetWithinElementHeader(offset: number, element: ElementDeclarationNode): boolean;
+export declare function getSourceSnippet(compiler: Compiler, node: SyntaxNode | SyntaxToken): string | undefined;

package/dist/src/core/utils/tokens.d.ts

@@ -6,6 +6,9 @@ export declare function isAsKeyword(token?: SyntaxToken): token is SyntaxToken &
 export declare function isUseKeyword(token?: SyntaxToken): token is SyntaxToken & {
     kind: SyntaxTokenKind.IDENTIFIER;
 };
+export declare function isMetadataKeyword(token?: SyntaxToken): token is SyntaxToken & {
+    kind: SyntaxTokenKind.IDENTIFIER;
+};
 export declare function isFromKeyword(token?: SyntaxToken): token is SyntaxToken & {
     kind: SyntaxTokenKind.IDENTIFIER;
 };

package/dist/src/core/utils/validate.d.ts

@@ -24,7 +24,15 @@ export declare function isValidPartialInjection(node?: SyntaxNode): node is Pref
     };
 };
 export declare function isRelationshipOp(op?: string): boolean;
-export declare function isValidColor(value?: SyntaxNode): boolean;
+export declare function isDependencyOp(op?: string): boolean;
+export declare function isValidHexColor(value?: SyntaxNode): value is PrimaryExpressionNode & {
+    expression: LiteralNode & {
+        literal: {
+            kind: SyntaxTokenKind.COLOR_LITERAL;
+        };
+    };
+};
+export declare function isValidColorOrNone(value?: SyntaxNode): boolean;
 export declare function isValidDefaultValue(value?: SyntaxNode): boolean;
 export type SignedNumberExpression = (PrimaryExpressionNode & {
     expression: LiteralNode & {
@@ -38,6 +46,7 @@ export type SignedNumberExpression = (PrimaryExpressionNode & {
 });
 export declare function isExpressionASignedNumberExpression(value?: SyntaxNode): value is SignedNumberExpression;
 export declare function isUnaryRelationship(value?: SyntaxNode): value is PrefixExpressionNode;
+export declare function isUnaryDependency(value?: SyntaxNode): value is PrefixExpressionNode;
 export declare function isTupleOfVariables(value?: SyntaxNode): value is TupleExpressionNode & {
     elementList: (PrimaryExpressionNode & {
         expression: VariableNode;
@@ -45,6 +54,7 @@ export declare function isTupleOfVariables(value?: SyntaxNode): value is TupleEx
 };
 export declare function isValidColumnType(type: SyntaxNode): boolean;
 export type Settings = Record<SettingName | string, AttributeNode[]>;
+export declare function isValidMetadataValue(value?: SyntaxNode): boolean;
 export declare function aggregateSettingList(settingList?: ListExpressionNode): Report<Settings>;
 export declare function isExpressionAQuotedString(value?: unknown): value is PrimaryExpressionNode & ({
     expression: VariableNode & {
@@ -84,7 +94,11 @@ type DotDelimitedIdentifier = PrimaryExpressionNode | (AccessExpression & {
 });
 export declare function isAccessExpression(node?: SyntaxNode): node is AccessExpression;
 export declare function isDotDelimitedIdentifier(node?: SyntaxNode): node is DotDelimitedIdentifier;
-export declare function isElementNode(node: SyntaxNode | undefined, kind: ElementKind): node is ElementDeclarationNode;
+export declare function isElementNode<T extends ElementKind>(node: SyntaxNode | undefined, kind: T): node is ElementDeclarationNode & {
+    type: {
+        value: T;
+    };
+};
 export declare function isUseDeclaration(node: SyntaxNode): node is UseDeclarationNode;
 export declare function isUseSpecifier(node: SyntaxNode, kind?: ImportKind): node is UseSpecifierNode;
 export declare function isWildcardSpecifier(node: SyntaxNode): node is WildcardNode;

package/dist/src/index.d.ts

@@ -4,15 +4,19 @@ export { Filepath } from './core/types/filepath';
 export { UNHANDLED, type Unhandled, } from './core/types/module';
 export { ElementKind } from './core/types/keywords';
 export { type NodeSymbol, SymbolKind, } from './core/types/symbol';
+export { MetadataKind } from './core/types/symbol/metadata';
 export * from './core/global_modules/records/utils';
 export * from './core/types/nodes';
 export { SyntaxToken, SyntaxTokenKind, isTriviaToken, isOp, isOpToken, } from './core/types/tokens';
 export { CompileError, CompileErrorCode, } from './core/types/errors';
 export type { Position, } from './core/types';
-export { ScopeKind, splitQualifiedIdentifier, unescapeString, escapeString, formatRecordValue, isValidIdentifier, addDoubleQuoteIfNeeded, } from './compiler/index';
-export { type Database, type MasterDatabase, type Table, type Note, type Column, type ColumnType, type Index, type Check, type InlineRef, type Ref, type RefEndpointPair, type RefEndpoint, type Enum, type EnumField, type TableGroup, type TableGroupField, type Alias, type AliasKind, type TablePartial, type TablePartialInjection, type RecordValue, type RecordValueType, type TableRecord, type Project, type SchemaElement, type TokenPosition, type ElementRef, type FilterConfig, type DiagramView, } from './core/types/schemaJson';
-export { type RelationCardinality, type RelationshipOp, getRelationshipOp, getMultiplicities, parseCardinality, makeCardinalityRequired, makeCardinalityOptional, CARDINALITY_ONE, CARDINALITY_MAYBE, CARDINALITY_SOME, CARDINALITY_MANY, } from './core/types/relation';
+export { ScopeKind, splitQualifiedIdentifier, unescapeString, escapeString, formatRecordValue, isValidIdentifier, addDoubleQuoteIfNeeded, normalizeQualifiedName, } from './compiler/index';
+export { type Database, type MasterDatabase, type Table, type Note, type Column, type ColumnType, type Index, type Check, type InlineRef, type Ref, type RefEndpointPair, type RefEndpoint, type Enum, type EnumField, type TableGroup, type TableGroupField, type Alias, type AliasKind, type TablePartial, type TablePartialInjection, type RecordValue, type RecordValueType, type TableRecord, type Project, type SchemaElement, type TokenPosition, type ElementRef, type FilterConfig, type DiagramView, type CustomMetadata, } from './core/types/schemaJson';
+export { type RelationCardinality, type RelationshipOp, getRelationshipOp, getMultiplicities, parseCardinality, makeCardinalityRequired, makeCardinalityOptional, makeRelationshipRequired, isEndpointOneSide, isEndpointManySide, isEndpointOptional, isEndpointRequired, CARDINALITY_ONE, CARDINALITY_MAYBE, CARDINALITY_SOME, CARDINALITY_MANY, } from './core/types/relation';
 export type { DiagramViewSyncOperation, DiagramViewBlock, TextEdit, } from './compiler/queries/transform';
+export { findDiagramViewBlocks, findDepBlocks } from './compiler/queries/transform';
+export type { DepSyncOperation, DepSyncEdge, DepEndpointRef, DepBlock, } from './compiler/queries/transform';
+export type { ElementIdentifier, SchemaIdentifier, TableIdentifier, ColumnIdentifier, EnumIdentifier, EndpointRef, RefIdentifier, DepIdentifier, NoteIdentifier, TableGroupIdentifier, } from './compiler/queries/transform';
 export { dbmlLanguageConfig, dbmlMonarchTokensProvider, } from './services/monarch';
 export * from './compiler/projectLayout/layout';
 export { Compiler };

package/dist/src/services/diagnostics/provider.d.ts

@@ -1,6 +1,16 @@
 import { default as Compiler } from '../../compiler';
 import { Filepath } from '../../core/types/filepath';
 import { MarkerData } from '../types';
+export interface DiagnosticQuickFix {
+    title: string;
+    shortTitle?: string;
+    edits: {
+        start: number;
+        end: number;
+        newText: string;
+    }[];
+    isPreferred?: boolean;
+}
 export interface Diagnostic {
     type: 'error' | 'warning' | 'info';
     text: string;
@@ -9,7 +19,10 @@ export interface Diagnostic {
     endRow: number;
     endColumn: number;
     code?: string | number;
+    category?: string;
+    explanation?: string;
     filepath: Filepath;
+    quickFixes?: DiagnosticQuickFix[];
 }
 export default class DBMLDiagnosticsProvider {
     private compiler;

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

@@ -3,7 +3,7 @@ import { default as DBMLDefinitionProvider } from './definition/provider';
 import { default as DBMLDiagnosticsProvider } from './diagnostics/provider';
 import { default as DBMLReferencesProvider } from './references/provider';
 import { default as DBMLCompletionItemProvider } from './suggestions/provider';
-export type { Diagnostic } from './diagnostics/provider';
+export type { Diagnostic, DiagnosticQuickFix } from './diagnostics/provider';
 export * from './types';
 export { DBMLCodeActionProvider, DBMLCompletionItemProvider, DBMLDefinitionProvider, DBMLReferencesProvider, DBMLDiagnosticsProvider, };
 export { dbmlMonarchTokensProvider } from './monarch';

package/dist/src/services/suggestions/provider.d.ts

@@ -1,5 +1,23 @@
 import { default as Compiler } from '../../compiler';
+import { SettingName } from '../../core/types/keywords';
 import { CompletionItemProvider, CompletionList, Position, TextModel } from '../types';
+export declare const COLUMN_TYPE_SUGGESTION_LABELS: readonly ["integer", "int", "tinyint", "smallint", "mediumint", "bigint", "bit", "bool", "binary", "varbinary", "logical", "char", "nchar", "varchar", "varchar2", "nvarchar", "nvarchar2", "binary_float", "binary_double", "float", "double", "decimal", "dec", "real", "money", "smallmoney", "enum", "tinyblob", "tinytext", "blob", "text", "mediumblob", "mediumtext", "longblob", "longtext", "ntext", "set", "inet6", "uuid", "image", "date", "time", "datetime", "datetime2", "timestamp", "year", "smalldatetime", "datetimeoffset", "XML", "sql_variant", "uniqueidentifier", "CURSOR", "BFILE", "CLOB", "NCLOB", "RAW"];
+export declare const TABLE_SETTING_SUGGESTION_LABELS: readonly [SettingName.HeaderColor, SettingName.Note];
+export declare const TABLE_SETTING_SUGGESTION_TEXT_INSERTS: string[];
+export declare const COLUMN_SUGGESTION_LABELS: (SettingName.Note | SettingName.PK | SettingName.PrimaryKey | SettingName.Unique | SettingName.Ref | SettingName.Dep | SettingName.NotNull | SettingName.Null | SettingName.Increment | SettingName.Default | SettingName.Check)[];
+export declare const COLUMN_SUGGESTION_TEXT_INSERTS: string[];
+export declare const INDEX_SETTING_SUGGESTION_LABELS: (SettingName.Note | SettingName.PK | SettingName.Unique | SettingName.Name | SettingName.Type)[];
+export declare const INDEX_SETTING_SUGGESTION_TEXT_INSERTS: string[];
+export declare const REF_SETTING_SUGGESTION_LABELS: (SettingName.Color | SettingName.Update | SettingName.Delete | SettingName.Inactive)[];
+export declare const REF_SETTING_SUGGESTION_TEXT_INSERTS: string[];
+export declare const ENUM_SETTING_SUGGESTION_LABELS: readonly [SettingName.Note];
+export declare const ENUM_SETTING_SUGGESTION_TEXT_INSERTS: string[];
+export declare const CHECK_SETTING_SUGGESTION_LABELS: readonly [SettingName.Name];
+export declare const CHECK_SETTING_SUGGESTION_TEXT_INSERTS: string[];
+export declare const REF_ACTION_VALUE_SUGGESTIONS: readonly ["cascade", "set default", "set null", "restrict"];
+export declare const INDEX_TYPE_VALUE_SUGGESTIONS: readonly ["btree", "hash"];
+export declare const TABLE_BODY_SUGGESTION_LABELS: ("indexes" | "checks" | "Note" | "Records")[];
+export declare const PROJECT_FIELD_SUGGESTION_LABELS: ("Table" | "Enum" | "TableGroup" | "TablePartial" | "Note" | "Ref" | "Dep")[];
 export interface DBMLCompletionItemProviderOptions {
     triggerCharacters?: string[];
 }
@@ -9,3 +27,4 @@ export default class DBMLCompletionItemProvider implements CompletionItemProvide
     constructor(compiler: Compiler, options?: DBMLCompletionItemProviderOptions);
     provideCompletionItems(model: TextModel, position: Position): CompletionList;
 }
+export declare const TOP_LEVEL_SUGGESTION_LABELS: ("Table" | "Enum" | "TableGroup" | "TablePartial" | "Note" | "DiagramView" | "Metadata" | "Ref" | "Dep" | "Project" | "Records")[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@dbml/parse",
-  "version": "10.0.0-optional-ref.0",
+  "version": "10.1.0-alpha.0",
   "description": "DBML parser v2",
   "author": "Holistics <dev@holistics.io>",
   "license": "Apache-2.0",
@@ -31,7 +31,8 @@
     "test:watch": "vitest watch",
     "coverage": "vitest run --coverage",
     "prepare": "npm run build",
-    "lint": "eslint .",
+    "lint": "eslint $(git diff --relative --name-only --diff-filter=ACMRTUXB master -- . | grep -E '\\.ts$')",
+    "lint:all": "eslint .",
     "lint:fix": "eslint --fix .",
     "bench": "npx tsx __benchmarks__/compiler.benchmark.ts",
     "profile:build": "vite build --config vite.profile.config.mts && cp -r __benchmarks__/input dist-profile/input",
@@ -50,5 +51,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "b8daf0503d91ec322d427ab1f5e71a8a7f2ca12f"
+  "gitHead": "b9c9c643d79c2ab0677852a1742fb3cc57561f73"
 }

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

@@ -1,23 +0,0 @@
-import { Filepath } from '../../../core/types/filepath';
-import { NodeSymbol } from '../../../core/types/symbol';
-import { default as Compiler } from '../../index';
-export type TableNameInput = 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.
- */
-export declare function lookupTableSymbol(compiler: Compiler, filepath: Filepath, schema: string, table: string): NodeSymbol | null;
-/**
- * Removes surrounding double quotes from a string if present.
- */
-export declare function stripQuotes(str: string): string;

package/dist/src/core/global_modules/program/utils.d.ts

@@ -1,3 +0,0 @@
-import { Database, ElementRef } from '../../types/schemaJson';
-import { NodeSymbol } from '../../types/symbol';
-export declare function pushExternal(db: Database, member: NodeSymbol, ref: ElementRef): void;