@dbml/parse 10.0.0 → 10.1.0

package/dist/src/core/global_modules/records/utils/constraints/fk.d.ts

@@ -1,5 +1,5 @@
 import { default as Compiler } from '../../../../../compiler/index';
-import { CompileWarning } from '../../../../types/errors';
+import { CompileInfo } from '../../../../types/errors';
 import { Filepath } from '../../../../types/filepath';
 import { SyntaxNode } from '../../../../types/nodes';
 import { Ref, TableRecord } from '../../../../types/schemaJson';
@@ -10,4 +10,4 @@ export type TableInfo = {
     record: TableRecord | undefined;
     recordBlock: SyntaxNode | undefined;
 };
-export declare function validateForeignKeys(compiler: Compiler, allRefs: Ref[], allRecords: Map<InternedNodeSymbol, TableInfo>, filepath: Filepath): CompileWarning[];
+export declare function validateForeignKeys(compiler: Compiler, allRefs: Ref[], allRecords: Map<InternedNodeSymbol, TableInfo>, filepath: Filepath): CompileInfo[];

package/dist/src/core/global_modules/records/utils/constraints/helper.d.ts

@@ -1,5 +1,4 @@
 import { default as Compiler } from '../../../../../compiler/index';
-import { CompileWarning } from '../../../../types/errors';
 import { RecordValue, TableRecord } from '../../../../types/schemaJson';
 import { ColumnSymbol } from '../../../../types/symbol';
 export declare function toKeyedRows(record: TableRecord): Record<string, RecordValue>[];
@@ -10,4 +9,4 @@ export declare function formatFullColumnName(schemaName: string | null, tableNam
 export declare function formatFullColumnNames(schemaName: string | null, tableName: string, columnNames: string[]): string;
 export declare function formatValues(compiler: Compiler, row: Record<string, RecordValue>, columns: ColumnSymbol[]): string;
 export declare function getDiagnosticAnchorValues(row: Record<string, RecordValue>, columnNames: string[]): RecordValue[];
-export declare function createConstraintWarning(compiler: Compiler, recordValue: RecordValue, message: string): CompileWarning;
+export declare function resolveRecordValueNode(compiler: Compiler, recordValue: RecordValue): import('../../../../..').SyntaxNode | import('../../../../..').SyntaxToken | Readonly<import('../../../../..').ProgramNode>;

package/dist/src/core/global_modules/records/utils/constraints/pk.d.ts

@@ -1,6 +1,6 @@
 import { default as Compiler } from '../../../../../compiler/index';
-import { CompileWarning } from '../../../../types/errors';
+import { CompileInfo } from '../../../../types/errors';
 import { SyntaxNode } from '../../../../types/nodes';
 import { TableRecord } from '../../../../types/schemaJson';
 import { TableSymbol } from '../../../../types/symbol';
-export declare function validatePrimaryKey(compiler: Compiler, tableSymbol: TableSymbol, recordBlock: SyntaxNode, record: TableRecord): CompileWarning[];
+export declare function validatePrimaryKey(compiler: Compiler, tableSymbol: TableSymbol, recordBlock: SyntaxNode, record: TableRecord): CompileInfo[];

package/dist/src/core/global_modules/records/utils/constraints/unique.d.ts

@@ -1,5 +1,5 @@
 import { default as Compiler } from '../../../../../compiler/index';
-import { CompileWarning } from '../../../../types/errors';
+import { CompileInfo } from '../../../../types/errors';
 import { TableRecord } from '../../../../types/schemaJson';
 import { TableSymbol } from '../../../../types/symbol';
-export declare function validateUnique(compiler: Compiler, tableSymbol: TableSymbol, record: TableRecord): CompileWarning[];
+export declare function validateUnique(compiler: Compiler, tableSymbol: TableSymbol, record: TableRecord): CompileInfo[];

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

@@ -129,39 +129,62 @@ export interface RelatedLocation {
     nodeOrToken: SyntaxNode | SyntaxToken;
     message: string;
 }
-export declare class CompileError extends Error {
+export interface QuickFix {
+    title: string;
+    shortTitle?: string;
+    filepath: Filepath;
+    edits: TextEdit[];
+    isPreferred?: boolean;
+}
+export declare enum DiagnosticCategory {
+    RefColumnMismatch = "Mismatched optional ref constraints",
+    RecordValueTypeMismatch = "Record type errors",
+    RecordConstraintViolation = "Record constraint violations",
+    Other = "Other"
+}
+export interface CompileDetails {
+    category?: DiagnosticCategory;
+    explanation?: string;
+    quickFixes?: QuickFix[];
+}
+export interface CompileDiagnostic extends Error {
     code: Readonly<CompileErrorCode>;
     diagnostic: Readonly<string>;
+    details?: Readonly<CompileDetails>;
     nodeOrToken: Readonly<SyntaxNode | SyntaxToken>;
     start: Readonly<number>;
     end: Readonly<number>;
-    constructor(code: number, message: string, nodeOrToken: SyntaxNode | SyntaxToken);
+    filepath: Filepath;
+}
+export declare class CompileError extends Error implements CompileDiagnostic {
+    code: Readonly<CompileErrorCode>;
+    diagnostic: Readonly<string>;
+    details?: Readonly<CompileDetails>;
+    nodeOrToken: Readonly<SyntaxNode | SyntaxToken>;
+    start: Readonly<number>;
+    end: Readonly<number>;
+    constructor(code: number, message: string, nodeOrToken: SyntaxNode | SyntaxToken, details?: CompileDetails);
     toWarning(): CompileWarning;
     get filepath(): Filepath;
 }
-export declare class CompileWarning extends Error {
+export declare class CompileWarning extends Error implements CompileDiagnostic {
     code: Readonly<CompileErrorCode>;
     diagnostic: Readonly<string>;
+    details?: Readonly<CompileDetails>;
     nodeOrToken: Readonly<SyntaxNode | SyntaxToken>;
     start: Readonly<number>;
     end: Readonly<number>;
-    constructor(code: number, message: string, nodeOrToken: SyntaxNode | SyntaxToken);
+    constructor(code: number, message: string, nodeOrToken: SyntaxNode | SyntaxToken, details?: CompileDetails);
     get filepath(): Filepath;
 }
-export interface QuickFix {
-    title: string;
-    filepath: Filepath;
-    edits: TextEdit[];
-}
-export declare class CompileInfo extends Error {
+export declare class CompileInfo extends Error implements CompileDiagnostic {
     code: Readonly<CompileErrorCode>;
     diagnostic: Readonly<string>;
+    details?: Readonly<CompileDetails>;
     nodeOrToken: Readonly<SyntaxNode | SyntaxToken>;
     start: Readonly<number>;
     end: Readonly<number>;
-    quickFixes?: QuickFix[];
-    constructor(code: number, message: string, nodeOrToken: SyntaxNode | SyntaxToken, options?: {
-        quickFixes?: QuickFix[];
-    });
+    constructor(code: number, message: string, nodeOrToken: SyntaxNode | SyntaxToken, details?: CompileDetails);
+    get quickFixes(): QuickFix[] | undefined;
     get filepath(): Filepath;
 }

package/dist/src/core/utils/diagnostics_reporter/index.d.ts

@@ -0,0 +1,2 @@
+export { refNullableMismatch, refNotNullMismatch, refUniqueMismatch, refNonUniqueMismatch, } from './ref';
+export { recordsNullNotAllowed, recordsInvalidEnum, recordsInvalidNumeric, recordsInvalidInteger, recordsExceedsPrecision, recordsExceedsScale, recordsInvalidBoolean, recordsInvalidDatetime, recordsInvalidString, recordsStringTooLong, recordsPkNull, recordsPkDuplicate, recordsPkMissing, recordsFkNull, recordsFkNotFound, recordsUniqueDuplicate, } from './records';

package/dist/src/core/utils/diagnostics_reporter/records.d.ts

@@ -0,0 +1,87 @@
+import { default as Compiler } from '../../../compiler';
+import { CompileInfo } from '../../types/errors';
+import { SyntaxNode } from '../../types/nodes';
+import { SyntaxToken } from '../../types/tokens';
+import { ColumnSymbol } from '../../types/symbol';
+import { Filepath } from '../../types/filepath';
+import { TableSymbol } from '../../types/symbol/symbols';
+export declare function recordsNullNotAllowed(node: SyntaxNode | SyntaxToken, options: {
+    colName: string;
+}): CompileInfo;
+export declare function recordsInvalidEnum(node: SyntaxNode | SyntaxToken, options: {
+    colName: string;
+}): CompileInfo;
+export declare function recordsInvalidNumeric(node: SyntaxNode | SyntaxToken, options: {
+    colName: string;
+    typeName: string;
+}): CompileInfo;
+export declare function recordsInvalidInteger(node: SyntaxNode | SyntaxToken, options: {
+    colName: string;
+    value: number;
+}): CompileInfo;
+export declare function recordsExceedsPrecision(node: SyntaxNode | SyntaxToken, options: {
+    colName: string;
+    typeName: string;
+    value: number;
+    precision: number;
+    scale: number;
+    totalDigits: number;
+}): CompileInfo;
+export declare function recordsExceedsScale(node: SyntaxNode | SyntaxToken, options: {
+    colName: string;
+    typeName: string;
+    value: number;
+    precision: number;
+    scale: number;
+    decimalDigits: number;
+}): CompileInfo;
+export declare function recordsInvalidBoolean(node: SyntaxNode | SyntaxToken, options: {
+    colName: string;
+}): CompileInfo;
+export declare function recordsInvalidDatetime(node: SyntaxNode | SyntaxToken, options: {
+    colName: string;
+}): CompileInfo;
+export declare function recordsInvalidString(node: SyntaxNode | SyntaxToken, options: {
+    colName: string;
+}): CompileInfo;
+export declare function recordsStringTooLong(node: SyntaxNode | SyntaxToken, options: {
+    colName: string;
+    typeName: string;
+    typeArg: string;
+    maxLength: number;
+    actualLength: number;
+}): CompileInfo;
+export declare function recordsPkNull(compiler: Compiler, node: SyntaxNode | SyntaxToken, options: {
+    table: TableSymbol;
+    columns: ColumnSymbol[];
+}): CompileInfo;
+export declare function recordsPkDuplicate(compiler: Compiler, node: SyntaxNode | SyntaxToken, options: {
+    table: TableSymbol;
+    columns: ColumnSymbol[];
+    valueStr: string;
+}): CompileInfo;
+export declare function recordsPkMissing(compiler: Compiler, node: SyntaxNode | SyntaxToken, options: {
+    table: TableSymbol;
+    columns: ColumnSymbol[];
+}): CompileInfo;
+export declare function recordsFkNull(compiler: Compiler, node: SyntaxNode | SyntaxToken, options: {
+    leftTable: TableSymbol;
+    leftColumns: ColumnSymbol[];
+    rightTable: TableSymbol;
+    rightColumns: ColumnSymbol[];
+    filepath: Filepath;
+    valueStr: string;
+}): CompileInfo;
+export declare function recordsFkNotFound(compiler: Compiler, node: SyntaxNode | SyntaxToken, options: {
+    leftTable: TableSymbol;
+    leftColumns: ColumnSymbol[];
+    rightTable: TableSymbol;
+    rightColumns: ColumnSymbol[];
+    filepath: Filepath;
+    valueStr: string;
+}): CompileInfo;
+export declare function recordsUniqueDuplicate(compiler: Compiler, node: SyntaxNode | SyntaxToken, options: {
+    table: TableSymbol;
+    columns: ColumnSymbol[];
+    valueStr: string;
+}): CompileInfo;

package/dist/src/core/utils/diagnostics_reporter/ref.d.ts

@@ -0,0 +1,30 @@
+import { default as Compiler } from '../../../compiler';
+import { CompileInfo, QuickFix } from '../../types/errors';
+import { SyntaxNode } from '../../types/nodes';
+import { SyntaxToken } from '../../types/tokens';
+import { ColumnSymbol } from '../../types/symbol';
+import { RelationshipOp } from '../../types/relation';
+export declare function refNullableMismatch(compiler: Compiler, node: SyntaxNode | SyntaxToken, options: {
+    relOp: RelationshipOp;
+    columns: ColumnSymbol[];
+    refNode: SyntaxNode;
+    quickFixes?: QuickFix[];
+}): CompileInfo;
+export declare function refNotNullMismatch(compiler: Compiler, node: SyntaxNode | SyntaxToken, options: {
+    relOp: RelationshipOp;
+    columns: ColumnSymbol[];
+    refNode: SyntaxNode;
+    quickFixes?: QuickFix[];
+}): CompileInfo;
+export declare function refUniqueMismatch(compiler: Compiler, node: SyntaxNode | SyntaxToken, options: {
+    relOp: RelationshipOp;
+    columns: ColumnSymbol[];
+    refNode: SyntaxNode;
+    quickFixes?: QuickFix[];
+}): CompileInfo;
+export declare function refNonUniqueMismatch(compiler: Compiler, node: SyntaxNode | SyntaxToken, options: {
+    relOp: RelationshipOp;
+    columns: ColumnSymbol[];
+    refNode: SyntaxNode;
+    quickFixes?: QuickFix[];
+}): CompileInfo;

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/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/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@dbml/parse",
-  "version": "10.0.0",
+  "version": "10.1.0",
   "description": "DBML parser v2",
   "author": "Holistics <dev@holistics.io>",
   "license": "Apache-2.0",
@@ -51,5 +51,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "399f6352a3cb4f1bffc1cb355301af28f84dc09b"
+  "gitHead": "e4fd7e7fcffba12b467b1679aa1aba5093e098db"
 }