@dbml/parse 8.3.0 → 9.0.0-alpha.0

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

@@ -0,0 +1,15 @@
+import { default as Compiler } from '../../../compiler';
+import { CompileError } from '../../types/errors';
+import { ElementDeclarationNode } from '../../types/nodes';
+import { SyntaxToken } from '../../types/tokens';
+export default class DepBinder {
+    private compiler;
+    private declarationNode;
+    constructor(compiler: Compiler, declarationNode: ElementDeclarationNode & {
+        type: SyntaxToken;
+    });
+    bind(): CompileError[];
+    private bindBody;
+    private bindFields;
+    private bindSubElements;
+}

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

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

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

@@ -0,0 +1,34 @@
+import { Dep } from '../../types/schemaJson';
+import { DepMetadata, Filepath } from '../../types';
+import { default as Compiler } from '../../../compiler';
+import { default as Report } from '../../types/report';
+export declare class DepInterpreter {
+    private compiler;
+    private metadata;
+    private declarationNode;
+    private filepath;
+    private dep;
+    constructor(compiler: Compiler, metadata: DepMetadata, filepath: Filepath);
+    interpret(): Report<Dep>;
+    private interpretName;
+    private interpretEdges;
+    /**
+     * Read settings into `dep.note` and `dep.custom`.
+     *
+     * Settings come from THREE sources, in this order:
+     *   1. The top-level attribute list on the Dep header
+     *      (e.g. `Dep my_block [color: 'blue'] { ... }`).
+     *   2. Per-field setting lists inside the body
+     *      (e.g. `Dep { a -> b [note: 'x'] }`).
+     *   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`
+     * 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.
+     */
+    private interpretSettings;
+    private consumeSettings;
+    private extractAttrValue;
+}

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

@@ -4,4 +4,5 @@ import { default as Report } from '../../types/report';
 import { NodeSymbol } from '../../types/symbol';
 import { GlobalModule } from '../types';
 export declare const refModule: GlobalModule;
+export declare function getDefaultSchemaSymbol(compiler: Compiler, globalSymbol: NodeSymbol): NodeSymbol | undefined;
 export declare function nodeRefereeOfRefEndpoint(compiler: Compiler, globalSymbol: NodeSymbol, node: SyntaxNode): Report<NodeSymbol | undefined>;

package/dist/src/core/global_modules/table/bind.d.ts

@@ -9,6 +9,8 @@ export default class TableBinder {
         type: SyntaxToken;
     });
     bind(): CompileError[];
+    private bindHeaderSettings;
+    private bindInlineDepValue;
     private bindBody;
     private bindFields;
     private tryToBindColumnType;

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

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

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

@@ -0,0 +1,18 @@
+import { default as Compiler } from '../../../compiler';
+import { CompileError } from '../../types/errors';
+import { BlockExpressionNode, ElementDeclarationNode, FunctionApplicationNode, ListExpressionNode } from '../../types/nodes';
+import { default as Report } from '../../types/report';
+import { Settings } from '../../utils/validate';
+export default class DepValidator {
+    private declarationNode;
+    private compiler;
+    constructor(compiler: Compiler, declarationNode: ElementDeclarationNode);
+    validate(): CompileError[];
+    private validateContext;
+    private validateName;
+    private validateAlias;
+    validateBody(body?: FunctionApplicationNode | BlockExpressionNode): CompileError[];
+    validateFields(fields: FunctionApplicationNode[]): CompileError[];
+    private validateSubElements;
+}
+export declare function validateDepSettings(settings: ListExpressionNode): Report<Settings>;

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

@@ -56,56 +56,58 @@ export declare enum CompileErrorCode {
     INVALID_REF_FIELD = 3039,
     EMPTY_REF = 3040,
     REF_REDEFINED = 3041,
-    INVALID_NOTE_CONTEXT = 3042,
-    INVALID_NOTE = 3043,
-    NOTE_REDEFINED = 3044,
-    NOTE_CONTENT_REDEFINED = 3045,
-    EMPTY_NOTE = 3046,
-    UNKNOWN_NOTE_SETTING = 3047,
-    DUPLICATE_NOTE_SETTING = 3048,
-    INVALID_NOTE_SETTING_VALUE = 3049,
-    INVALID_INDEXES_CONTEXT = 3050,
-    INVALID_INDEXES_FIELD = 3051,
-    INVALID_INDEX = 3052,
-    UNKNOWN_INDEX_SETTING = 3053,
-    DUPLICATE_INDEX_SETTING = 3054,
-    UNEXPECTED_INDEX_SETTING_VALUE = 3055,
-    INVALID_INDEX_SETTING_VALUE = 3056,
-    INVALID_PROJECT_CONTEXT = 3057,
-    PROJECT_REDEFINED = 3058,
-    INVALID_PROJECT_FIELD = 3059,
-    INVALID_CUSTOM_CONTEXT = 3060,
-    INVALID_CUSTOM_ELEMENT_VALUE = 3061,
-    INVALID_ELEMENT_IN_SIMPLE_BODY = 3062,
-    INVALID_TABLE_PARTIAL_CONTEXT = 3063,
-    INVALID_TABLE_PARTIAL_ELEMENT_NAME = 3064,
-    INVALID_TABLE_PARTIAL_SETTING_VALUE = 3065,
-    DUPLICATE_TABLE_PARTIAL_ELEMENT_NAME = 3066,
-    DUPLICATE_TABLE_PARTIAL_SETTING = 3067,
-    INVALID_TABLE_PARTIAL_INJECTION = 3068,
-    INVALID_TABLE_PARTIAL_INJECTION_OP = 3069,
-    INVALID_TABLE_PARTIAL_INJECTION_NAME = 3070,
-    DUPLICATE_TABLE_PARTIAL_INJECTION_NAME = 3071,
-    UNKNOWN_TABLE_PARTIAL_SETTING = 3072,
-    INVALID_TABLE_SETTING_VALUE = 3073,
-    INVALID_CHECKS_CONTEXT = 3074,
-    INVALID_CHECKS_FIELD = 3075,
-    INVALID_CHECK = 3076,
-    UNKNOWN_CHECK_SETTING = 3077,
-    DUPLICATE_CHECK_SETTING = 3078,
-    INVALID_CHECK_SETTING_VALUE = 3079,
-    INVALID_RECORDS_CONTEXT = 3080,
-    INVALID_RECORDS_NAME = 3081,
-    INVALID_RECORDS_FIELD = 3082,
-    DUPLICATE_COLUMN_REFERENCES_IN_RECORDS = 3083,
-    DUPLICATE_RECORDS_FOR_TABLE = 3084,
-    INVALID_USE_CONTEXT = 3085,
-    INVALID_USE_SPECIFIER_KIND = 3086,
-    INVALID_USE_SPECIFIER_NAME = 3087,
-    INVALID_DIAGRAMVIEW_CONTEXT = 3088,
-    DUPLICATE_DIAGRAMVIEW_NAME = 3089,
-    INVALID_DIAGRAMVIEW_FIELD = 3090,
-    DUPLICATE_DIAGRAMVIEW_FIELD = 3091,
+    INVALID_DEP_CONTEXT = 3042,
+    INVALID_DEP_FIELD = 3043,
+    INVALID_NOTE_CONTEXT = 3044,
+    INVALID_NOTE = 3045,
+    NOTE_REDEFINED = 3046,
+    NOTE_CONTENT_REDEFINED = 3047,
+    EMPTY_NOTE = 3048,
+    UNKNOWN_NOTE_SETTING = 3049,
+    DUPLICATE_NOTE_SETTING = 3050,
+    INVALID_NOTE_SETTING_VALUE = 3051,
+    INVALID_INDEXES_CONTEXT = 3052,
+    INVALID_INDEXES_FIELD = 3053,
+    INVALID_INDEX = 3054,
+    UNKNOWN_INDEX_SETTING = 3055,
+    DUPLICATE_INDEX_SETTING = 3056,
+    UNEXPECTED_INDEX_SETTING_VALUE = 3057,
+    INVALID_INDEX_SETTING_VALUE = 3058,
+    INVALID_PROJECT_CONTEXT = 3059,
+    PROJECT_REDEFINED = 3060,
+    INVALID_PROJECT_FIELD = 3061,
+    INVALID_CUSTOM_CONTEXT = 3062,
+    INVALID_CUSTOM_ELEMENT_VALUE = 3063,
+    INVALID_ELEMENT_IN_SIMPLE_BODY = 3064,
+    INVALID_TABLE_PARTIAL_CONTEXT = 3065,
+    INVALID_TABLE_PARTIAL_ELEMENT_NAME = 3066,
+    INVALID_TABLE_PARTIAL_SETTING_VALUE = 3067,
+    DUPLICATE_TABLE_PARTIAL_ELEMENT_NAME = 3068,
+    DUPLICATE_TABLE_PARTIAL_SETTING = 3069,
+    INVALID_TABLE_PARTIAL_INJECTION = 3070,
+    INVALID_TABLE_PARTIAL_INJECTION_OP = 3071,
+    INVALID_TABLE_PARTIAL_INJECTION_NAME = 3072,
+    DUPLICATE_TABLE_PARTIAL_INJECTION_NAME = 3073,
+    UNKNOWN_TABLE_PARTIAL_SETTING = 3074,
+    INVALID_TABLE_SETTING_VALUE = 3075,
+    INVALID_CHECKS_CONTEXT = 3076,
+    INVALID_CHECKS_FIELD = 3077,
+    INVALID_CHECK = 3078,
+    UNKNOWN_CHECK_SETTING = 3079,
+    DUPLICATE_CHECK_SETTING = 3080,
+    INVALID_CHECK_SETTING_VALUE = 3081,
+    INVALID_RECORDS_CONTEXT = 3082,
+    INVALID_RECORDS_NAME = 3083,
+    INVALID_RECORDS_FIELD = 3084,
+    DUPLICATE_COLUMN_REFERENCES_IN_RECORDS = 3085,
+    DUPLICATE_RECORDS_FOR_TABLE = 3086,
+    INVALID_USE_CONTEXT = 3087,
+    INVALID_USE_SPECIFIER_KIND = 3088,
+    INVALID_USE_SPECIFIER_NAME = 3089,
+    INVALID_DIAGRAMVIEW_CONTEXT = 3090,
+    DUPLICATE_DIAGRAMVIEW_NAME = 3091,
+    INVALID_DIAGRAMVIEW_FIELD = 3092,
+    DUPLICATE_DIAGRAMVIEW_FIELD = 3093,
     BINDING_ERROR = 4000,
     NONEXISTENT_MODULE = 4001,
     UNSUPPORTED = 5000,

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

@@ -2,6 +2,7 @@ export declare enum ElementKind {
     Table = "table",
     Enum = "enum",
     Ref = "ref",
+    Dep = "dep",
     Note = "note",
     Project = "project",
     Indexes = "indexes",
@@ -23,6 +24,7 @@ export declare enum SettingName {
     PrimaryKey = "primary key",
     Unique = "unique",
     Ref = "ref",
+    Dep = "dep",
     NotNull = "not null",
     Null = "null",
     Increment = "increment",

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

@@ -58,6 +58,7 @@ export interface Database {
     tables: Table[];
     notes: Note[];
     refs: Ref[];
+    deps: Dep[];
     enums: Enum[];
     tableGroups: TableGroup[];
     aliases: Alias[];
@@ -110,6 +111,7 @@ export interface Column {
     type: ColumnType;
     token: TokenPosition;
     inline_refs: InlineRef[];
+    inline_deps: InlineDep[];
     checks: Check[];
     pk?: boolean;
     dbdefault?: {
@@ -171,6 +173,35 @@ export interface RefEndpoint {
     token: TokenPosition;
 }
 export type RelationCardinality = '1' | '*';
+export interface Dep {
+    schemaName: string | null;
+    name: string | null;
+    edges: DepEdge[];
+    note?: {
+        value: string;
+        token: TokenPosition;
+    };
+    custom?: Record<string, string | number | boolean | null>;
+    token: TokenPosition;
+}
+export interface DepEdge {
+    upstream: DepEndpoint;
+    downstream: DepEndpoint;
+    token: TokenPosition;
+}
+export interface DepEndpoint {
+    schemaName: string | null;
+    tableName: string;
+    fieldNames: string[];
+    token: TokenPosition;
+}
+export interface InlineDep {
+    schemaName: string | null;
+    tableName: string;
+    fieldNames: string[];
+    direction: '->' | '<-';
+    token: TokenPosition;
+}
 export interface Enum {
     name: string;
     schemaName: string | null;
@@ -252,4 +283,4 @@ export type Project = Record<string, never> | {
     token: TokenPosition;
     [index: string & Omit<any, 'name' | 'tables' | 'refs' | 'enums' | 'tableGroups' | 'note' | 'tablePartials' | 'records'>]: string;
 };
-export type SchemaElement = Database | Project | Table | Note | Column | ColumnType | Index | Check | InlineRef | Ref | RefEndpoint | Enum | EnumField | TableGroup | TableGroupField | Alias | TablePartial | TablePartialInjection | TableRecord | RecordValue;
+export type SchemaElement = Database | Project | Table | Note | Column | ColumnType | Index | Check | InlineRef | InlineDep | Ref | RefEndpoint | Dep | DepEdge | DepEndpoint | Enum | EnumField | TableGroup | TableGroupField | Alias | TablePartial | TablePartialInjection | TableRecord | RecordValue;