@dbml/parse 11.0.0-alpha.5 → 11.0.0

package/dist/src/core/types/symbol/symbols.d.ts

@@ -25,8 +25,6 @@ export declare enum SymbolKind {
     DiagramViewNote = "DiagramView note",
     DiagramViewSchema = "DiagramView schema",
     Metadata = "Metadata",
-    Element = "Element",
-    Kind = "Kind",
     Program = "Program"
 }
 export declare const ImportKind: {
@@ -205,22 +203,6 @@ export declare class TableGroupFieldSymbol extends NodeSymbol {
     get canBeImported(): boolean;
     get originalSymbol(): NodeSymbol;
 }
-export declare class ElementSymbol extends NodeSymbol {
-    constructor({ declaration, name, }: {
-        declaration?: SyntaxNode;
-        name?: string;
-    }, id: NodeSymbolId, filepath: Filepath);
-    get canBeImported(): boolean;
-    get originalSymbol(): NodeSymbol;
-}
-export declare class KindSymbol extends NodeSymbol {
-    constructor({ declaration, name, }: {
-        declaration?: SyntaxNode;
-        name?: string;
-    }, id: NodeSymbolId, filepath: Filepath);
-    get canBeImported(): boolean;
-    get originalSymbol(): NodeSymbol;
-}
 export declare class NoteSymbol extends NodeSymbol {
     constructor({ declaration, name, }: {
         declaration?: SyntaxNode;

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

@@ -25,7 +25,6 @@ export declare enum SyntaxTokenKind {
     COLON = "<colon>",
     SINGLE_LINE_COMMENT = "<single-line-comment>",
     MULTILINE_COMMENT = "<multiline-comment>",
-    FRONT_MATTER = "<front-matter>",
     WILDCARD = "<wildcard>"
 }
 export declare function isTriviaToken(token: SyntaxToken): boolean;

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

@@ -23,6 +23,8 @@ export declare function destructureIndexNode(node?: SyntaxNode): {
 } | undefined;
 export declare function extractQuotedStringToken(value?: SyntaxNode): string | undefined;
 export declare function extractNumericLiteral(node?: SyntaxNode): number | null;
+export declare function extractSignedNumber(node: SyntaxNode): number | null;
+export declare function extractBooleanLiteral(node?: SyntaxNode): boolean | null;
 export declare function destructureCallExpression(node?: SyntaxNode): {
     variables: (PrimaryExpressionNode & {
         expression: VariableNode;

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

@@ -1,15 +1,18 @@
 import { default as Compiler } from '../../compiler';
-import { Color, ColumnType, CustomMetadata, TokenPosition } from '../types/schemaJson';
+import { Color, ColumnType, CustomMetadata, CustomMetadataValue, TokenPosition } from '../types/schemaJson';
 import { SyntaxNode } from '../types/nodes';
 import { default as Report } from '../types/report';
 import { Settings } from './validate';
 import { SettingName } from '../types';
+import { MetadataFieldRegistry, MetadataTarget } from '../global_modules/metadata/utils';
 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 extractNote(node?: SyntaxNode): string | undefined;
+export declare function extractHexColor(node?: SyntaxNode): Color | undefined;
 export declare function extractColor(node?: SyntaxNode): Color | undefined;
 export declare function processDefaultValue(valueNode?: SyntaxNode): {
     type: 'number' | 'string' | 'boolean' | 'expression';
@@ -17,10 +20,18 @@ export declare function processDefaultValue(valueNode?: SyntaxNode): {
 } | 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).
+  * Extract inline custom metadata from an aggregated setting list, excluding the given recognized settings.
+  * Used for columns, whose recognized settings (pk, ref, note, .etc) are interpreted by the column symbol rather than field specs.
   *
   * 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;
+/**
+  * Interpret an element's aggregated setting list as metadata:
+  * - Builtin fields (headercolor and note in `table`, color in `tablegroup`, .etc) are parsed and assigned onto the element by their field spec
+  * - Every other key becomes free-form custom metadata on `element.metadata`
+  *
+  * Invalid values are skipped (reported at validate phase).
+  */
+export declare function assignInlineMetadata<T extends MetadataTarget>(element: Partial<T>, settingMap: Settings, registry: MetadataFieldRegistry<T, any>): void;
+export declare function extractMetadataValue(node?: SyntaxNode): Omit<CustomMetadataValue, 'token'> | undefined;

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

@@ -54,7 +54,6 @@ 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 & {

package/dist/src/index.d.ts

@@ -8,24 +8,17 @@ 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 { CompileError, CompileErrorCode, CompileWarning, CompileInfo, } from './core/types/errors';
+export type { Diagnostic, DiagnosticQuickFix } from './services/diagnostics/provider';
 export type { Position, } from './core/types';
 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, type Node, type Group, type Link, type LinkOp, type Kind, type KindCategory, type ArchSettings, type ArchSettingValue, } from './core/types/schemaJson';
-export { type FileKind, ARCH_DIAGRAM_TYPES, isArchDiagramType } from './compiler/queries/files/fileKind';
-export { BUILTIN_KINDS, RESERVED, isReserved, suggestKind, suggestIcon, type KindSpec, } from './core/arch/vocabulary';
-export { ICON_ALIAS, ICON_NAMES, isIconName, resolveIcon, } from './core/arch/icons';
+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, type CustomMetadataValue, type CustomMetadataValueType, } 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 } from './compiler/queries/transform';
 export type { DepSyncOperation, DepSyncEdge, DepEndpointRef } from './compiler/queries/transform';
-export type { ElementIdentifier, SchemaIdentifier, TableIdentifier, ColumnIdentifier, EnumIdentifier, EndpointRef, RefIdentifier, DepIdentifier, NoteIdentifier, TableGroupIdentifier, ArchElementIdentifier, ArchLinkIdentifier, } 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 { dbmlModules } from './core/global_modules';
-export type { GlobalModule } from './core/global_modules/types';
-export type { ParserOptions } from './core/parser/parser';
-export type { LexerOptions } from './core/lexer/lexer';
-export type { DialectOptions } from './compiler/index';
 export { Compiler };
 export * from './services';

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

@@ -4,4 +4,5 @@ export default class DBMLDefinitionProvider implements DefinitionProvider {
     private compiler;
     constructor(compiler: Compiler);
     provideDefinition(model: TextModel, position: Position): Definition;
+    private resolveImportPath;
 }

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

@@ -20,11 +20,13 @@ export declare const TABLE_BODY_SUGGESTION_LABELS: ("indexes" | "checks" | "Note
 export declare const PROJECT_FIELD_SUGGESTION_LABELS: ("Table" | "Enum" | "TableGroup" | "TablePartial" | "Note" | "Ref" | "Dep")[];
 export interface DBMLCompletionItemProviderOptions {
     triggerCharacters?: string[];
+    fileListDepth?: number;
 }
 export default class DBMLCompletionItemProvider implements CompletionItemProvider {
     private compiler;
     triggerCharacters: string[];
+    fileListDepth: number;
     constructor(compiler: Compiler, options?: DBMLCompletionItemProviderOptions);
     provideCompletionItems(model: TextModel, position: Position): CompletionList;
 }
-export declare const TOP_LEVEL_SUGGESTION_LABELS: ("Table" | "Enum" | "TableGroup" | "TablePartial" | "Note" | "Metadata" | "Ref" | "Project" | "DiagramView" | "Dep" | "Records")[];
+export declare const TOP_LEVEL_SUGGESTION_LABELS: ("Table" | "Enum" | "TableGroup" | "TablePartial" | "Note" | "DiagramView" | "Metadata" | "Ref" | "Dep" | "Project" | "Records")[];

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

@@ -2,4 +2,7 @@ import { default as Compiler } from '../../compiler';
 import { Filepath } from '../../core/types/filepath';
 import { SyntaxToken } from '../../core/types/tokens';
 import { CompletionList, TextModel } from '../types';
-export declare function suggestUseCompletion(compiler: Compiler, filepath: Filepath, offset: number, bOcToken: SyntaxToken | undefined, model: TextModel): CompletionList | null;
+export interface SuggestUseCompletionOptions {
+    fileListDepth?: number;
+}
+export declare function suggestUseCompletion(compiler: Compiler, filepath: Filepath, offset: number, bOcToken: SyntaxToken | undefined, model: TextModel, options?: SuggestUseCompletionOptions): CompletionList | null;

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@dbml/parse",
-  "version": "11.0.0-alpha.5",
+  "version": "11.0.0",
   "description": "DBML parser v2",
   "author": "Holistics <dev@holistics.io>",
   "license": "Apache-2.0",
@@ -25,7 +25,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "rm -rf ./dist && tsc --noEmit && vite build",
+    "build": "rimraf ./dist && tsc --noEmit && vite build",
     "dev": "vite build --watch",
     "test": "vitest run",
     "test:watch": "vitest watch",
@@ -51,5 +51,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "994edca3bccaf94e0cfc80dfd4f9faf488152787"
+  "gitHead": "4b89ec80f0a469407953b7c670f8c5fda4638b28"
 }

package/dist/src/compiler/queries/files/fileKind.d.ts

@@ -1,18 +0,0 @@
-import { SyntaxToken } from '../../../core/types/tokens';
-export type FileKind = 'dbml' | 'arch';
-export declare const ARCH_DIAGRAM_TYPES: Set<string>;
-export declare const isArchDiagramType: (type: string | null | undefined) => boolean;
-export interface FileScan {
-    frontMatter: Record<string, string>;
-    topWords: string[];
-    kindNames: string[];
-    usePaths: string[];
-}
-export declare function readFrontMatter(block: string): Record<string, string>;
-export declare function frontMatterToken(tokens: readonly SyntaxToken[]): SyntaxToken | undefined;
-export declare function scanTokens(tokens: readonly SyntaxToken[]): FileScan;
-export interface FileKindResult {
-    kind: FileKind;
-    dependsOnImports: boolean;
-}
-export declare function decideFileKind(scan: FileScan, importedScans: () => FileScan[]): FileKindResult;

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

@@ -1,8 +0,0 @@
-import { Filepath } from '../../../core/types/filepath';
-import { default as Compiler } from '../../index';
-/**
- * With an `as` alias only the name changes. Without one, every link endpoint, group member and
- * metadata target in the same file that names it is renamed too.
- * An empty map means no change (lookup miss or name collision).
- */
-export declare function renameElement(this: Compiler, filepath: Filepath, oldHandle: string, newName: string): Map<string, string>;

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

@@ -1,17 +0,0 @@
-import { Filepath } from '../../../../core/types/filepath';
-import { AttributeNode, ElementDeclarationNode, ListExpressionNode } from '../../../../core/types/nodes';
-import { default as Compiler } from '../../../index';
-import { TextEdit } from '../applyTextEdits';
-export declare function archDeclarations(compiler: Compiler, filepath: Filepath): ElementDeclarationNode[];
-export declare function findArchElement(compiler: Compiler, filepath: Filepath, handle: string): ElementDeclarationNode | undefined;
-export type ArchLinkDefinition = {
-    kind: 'standalone';
-    declaration: ElementDeclarationNode;
-} | {
-    kind: 'inline';
-    element: ElementDeclarationNode;
-    attribute: AttributeNode;
-    op: string;
-};
-export declare function findArchLink(compiler: Compiler, filepath: Filepath, from: string, to: string): ArchLinkDefinition | undefined;
-export declare function removeAttributeEdit(list: ListExpressionNode, attribute: AttributeNode, source: string): TextEdit;

package/dist/src/core/arch/icons.d.ts

@@ -1,6 +0,0 @@
-export declare const DRAWN_ICONS: string[];
-export declare const BRAND_ICONS: string[];
-export declare const ICON_NAMES: string[];
-export declare const ICON_ALIAS: Record<string, string>;
-export declare const resolveIcon: (name: string) => string;
-export declare const isIconName: (name: string) => boolean;

package/dist/src/core/arch/read.d.ts

@@ -1,59 +0,0 @@
-import { AttributeNode, ElementDeclarationNode, ListExpressionNode, SyntaxNode } from '../types/nodes';
-import { ArchSettingValue, ArchSettings } from '../types/schemaJson';
-export type ArchSort = 'node' | 'group' | 'kind' | 'link' | 'metadata' | 'project';
-export declare const declarationWord: (node: ElementDeclarationNode) => string | undefined;
-export declare function isTopLevel(node: SyntaxNode): node is ElementDeclarationNode;
-export declare function archSort(node: SyntaxNode): ArchSort | undefined;
-export declare const isTopLevelNote: (node: SyntaxNode) => boolean;
-export declare function topLevelDeclaration(node: SyntaxNode): ElementDeclarationNode | undefined;
-export declare function nameOf(node?: SyntaxNode): string | undefined;
-export declare const handleOf: (node: ElementDeclarationNode) => string | undefined;
-export declare function numberOf(node?: SyntaxNode): number | null;
-export declare function valueOf(node: SyntaxNode): ArchSettingValue | undefined;
-export declare const isInlineLinkKey: (key: string) => boolean;
-export declare function settingsOf(list?: ListExpressionNode): ArchSettings;
-export declare function bodyOf(node: ElementDeclarationNode): SyntaxNode[];
-export interface Row {
-    callee: SyntaxNode | undefined;
-    args: SyntaxNode[];
-    settings: ListExpressionNode | undefined;
-}
-export declare function rowOf(node: SyntaxNode | undefined): Row | undefined;
-export interface Infix {
-    left: SyntaxNode;
-    op: string;
-    right: SyntaxNode;
-}
-export declare function infixOf(node?: SyntaxNode): Infix | undefined;
-export declare function endpointNode(node: SyntaxNode): SyntaxNode;
-export declare const LINK_OPS: Set<string>;
-export interface LinkParts {
-    row: Row | undefined;
-    infix: Infix;
-}
-export declare function linkPartsOf(declaration: ElementDeclarationNode): LinkParts | undefined;
-export declare function isInlineLink(attribute: AttributeNode): boolean;
-export declare function inlineLinksOf(declaration: ElementDeclarationNode): AttributeNode[];
-export interface InlineLink {
-    op: string;
-    target: SyntaxNode;
-}
-export declare function inlineLinkOf(attribute: AttributeNode): InlineLink | undefined;
-export interface Property {
-    key: string;
-    value: ArchSettingValue | undefined;
-}
-export declare function propertyOf(node: SyntaxNode): Property | undefined;
-export declare function noteDeclarationOf(declaration: ElementDeclarationNode): ElementDeclarationNode | undefined;
-export declare function noteTextOf(note: ElementDeclarationNode): string;
-export declare const IMAGE_URL: RegExp;
-export declare const IMAGE_REFUSED = "A picture must be an https: URL or a data:image/ URI.";
-export interface BodyRead {
-    settings: ArchSettings;
-    problems: {
-        code: 'bad' | 'duplicate';
-        message: string;
-        node: SyntaxNode;
-    }[];
-}
-export declare function readBody(declaration: ElementDeclarationNode, settings: ArchSettings, bareWordIsAFlag: boolean): BodyRead;

package/dist/src/core/arch/vocabulary.d.ts

@@ -1,11 +0,0 @@
-export type Category = 'compute' | 'data' | 'net' | 'edge' | 'people' | 'ops' | 'custom';
-export interface KindSpec {
-    icon: string;
-    category: Category;
-}
-export declare const BUILTIN_KINDS: Record<string, KindSpec>;
-export declare const builtinKindName: (typed: string) => string | undefined;
-export declare function suggestKind(typed: string): string;
-export declare const RESERVED: Set<string>;
-export declare const isReserved: (word: string) => boolean;
-export declare function suggestIcon(typed: string): string;

package/dist/src/core/global_modules/arch/index.d.ts

@@ -1,2 +0,0 @@
-import { GlobalModule } from '../types';
-export declare const archModule: GlobalModule;

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

@@ -1,11 +0,0 @@
-import { default as Compiler } from '../../../compiler';
-import { Filepath } from '../../types/filepath';
-import { default as Report } from '../../types/report';
-import { ArchSettings, Group, Kind, Link, Node } from '../../types/schemaJson';
-import { ElementSymbol, KindSymbol } from '../../types/symbol';
-import { ArchMetadataElementMetadata, LinkMetadata } from '../../types/symbol/metadata';
-export declare function interpretElement(compiler: Compiler, symbol: ElementSymbol, filepath: Filepath): Report<Node | Group | undefined>;
-export declare function interpretKind(symbol: KindSymbol): Report<Kind | undefined>;
-export declare function builtinKinds(): Kind[];
-export declare function interpretLink(compiler: Compiler, metadata: LinkMetadata, filepath: Filepath): Report<Link | undefined>;
-export declare function interpretArchMetadata(metadata: ArchMetadataElementMetadata): Report<ArchSettings>;

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

@@ -1,7 +0,0 @@
-import { default as Compiler } from '../../../compiler';
-import { Filepath } from '../../types/filepath';
-import { NodeSymbol, SymbolKind } from '../../types/symbol';
-export declare function lookupVisible(compiler: Compiler, filepath: Filepath, kind: SymbolKind, name: string): NodeSymbol | undefined;
-export declare function visibleKinds(compiler: Compiler, filepath: Filepath): Map<string, NodeSymbol>;
-export declare function resolveRole(compiler: Compiler, filepath: Filepath, word: string): string | undefined;
-export declare function originalHandle(compiler: Compiler, symbol: NodeSymbol, filepath: Filepath): string | undefined;

package/dist/src/core/local_modules/arch/index.d.ts

@@ -1,2 +0,0 @@
-import { LocalModule } from '../types';
-export declare const archModule: LocalModule;