@dbml/parse 10.3.0 → 10.4.0-alpha.0

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

@@ -50,7 +50,26 @@ export default class Compiler {
     symbolMetadata: (symbol: import('../core/types/symbol').NodeSymbol) => import('../core/types/symbol').NodeMetadata[];
     symbolAliases: (symbol: import('../core/types/symbol').NodeSymbol) => import('../core/types/report').default<import('../core/types/symbol').AliasSymbol[]>;
     symbolUses: (symbol: import('../core/types/symbol').NodeSymbol) => import('../core/types/report').default<import('../core/types/symbol').UseSymbol[]>;
+    /**
+      * A global query
+      * Return the named refs visible from a program (refs are not imported via `use`).
+      */
+    visibleSymbols: (program: import('../core/types/symbol').ProgramSymbol, kind: import('../core/types/symbol').SymbolKind) => import('../core/types/symbol').RefSymbol[];
+    /**
+      * A global query
+      * Whether a symbol is visible from a program
+      */
+    isSymbolVisible: (program: import('../core/types/symbol').ProgramSymbol, symbol: import('../core/types/symbol').NodeSymbol) => boolean;
+    /**
+      * A global query
+      * Resolve all candidates that a metadata block can target
+      */
+    metadataTargets: (block: import('../core/types/symbol').MetadataElementMetadata) => import('../core/types/symbol').NodeSymbol[];
     fileDependencies: (filepath: Filepath) => Filepath[];
+    /**
+      * A global query
+      * BFS-traverse imports from an entry filepath and return all reachable files. Related: fileDependencies.
+      */
     reachableFiles: (entry?: Filepath | undefined) => Filepath[];
     usableMembers: (symbolOrFilepath: Filepath | import('../core/types/symbol').SchemaSymbol | import('../core/types/symbol').ProgramSymbol) => import('../core/types/report').default<{
         nonSchemaMembers: import('../core/types/symbol').NodeSymbol[];

package/dist/src/compiler/queries/metadata/isSymbolVisible.d.ts

@@ -0,0 +1,10 @@
+import { NodeSymbol, ProgramSymbol } from '../../../core/types/symbol';
+import { default as Compiler } from '../../index';
+/**
+  * Whether `symbol` is visible from `program`.
+  * - Column: visible when its table is (a column is not a direct schema member)
+  * - Ref: refs are not imported via `use`, a ref is visible when it shows up in the program's output,
+  *   i.e. the program reaches the ref's file and sees both endpoint tables (RefMetadata.owners)
+  * - otherwise: the symbol sits in the program's schemas, directly or through `use`
+  */
+export declare function isSymbolVisible(this: Compiler, program: ProgramSymbol, symbol: NodeSymbol): boolean;

package/dist/src/compiler/queries/metadata/metadataTargets.d.ts

@@ -0,0 +1,7 @@
+import { NodeSymbol } from '../../../core/types/symbol';
+import { MetadataElementMetadata } from '../../../core/types/symbol/metadata';
+import { default as Compiler } from '../../index';
+/**
+  * Resolve the candidates a Metadata block targets, from its `<target-kind> <name>` header.
+  */
+export declare function metadataTargets(this: Compiler, block: MetadataElementMetadata): NodeSymbol[];

package/dist/src/compiler/queries/symbol/visibleSymbols.d.ts

@@ -0,0 +1,7 @@
+import { ProgramSymbol, RefSymbol, SymbolKind } from '../../../core/types/symbol';
+import { default as Compiler } from '../../index';
+/**
+  * Named refs usable from `program`: refs are not imported via `use`, a named ref is visible
+  * wherever it shows up in the output (see isSymbolVisible).
+  */
+export declare function visibleSymbols(this: Compiler, program: ProgramSymbol, kind: SymbolKind): RefSymbol[];

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

@@ -1,9 +1,9 @@
 import { default as Compiler } from '../../../compiler/index';
 import { Filepath, SettingName } from '../../types';
-import { Column, Note, Table, TableGroup, TokenPosition } from '../../types/schemaJson';
-import { ElementDeclarationNode, SyntaxNode } from '../../types/nodes';
+import { Column, Note, Ref, Table, TableGroup, TokenPosition } from '../../types/schemaJson';
+import { SyntaxNode } from '../../types/nodes';
 import { NodeSymbol, SymbolKind, MetadataTargetKind } from '../../types/symbol';
-export type MetadataTarget = Table | TableGroup | Note | Column;
+export type MetadataTarget = Table | TableGroup | Note | Column | Ref;
 /**
   * Specs for builtin metadata (table's note, tablegroup's color, .etc) for different element types. Does 2 things:
   * - `validate`: Validating if the metadata value is syntactically correct
@@ -17,13 +17,15 @@ interface MetadataField<T extends MetadataTarget> {
     assignBuiltinField(element: Partial<T>, value: string, token: TokenPosition): void;
 }
 export type MetadataFieldRegistry<T extends MetadataTarget, K extends SettingName = SettingName> = Record<K, MetadataField<T>>;
-type NameWithSymbolKind = {
+export type NameWithSymbolKind = {
     name: string;
     symbolKind: SymbolKind;
 };
 /** @internal Exported for testing only. */
-export declare function mapNamePartToSymbolKind(nameParts: string[], targetKind: MetadataTargetKind): NameWithSymbolKind[];
-export declare function resolveMetadataTarget(compiler: Compiler, metadataNode: ElementDeclarationNode): NodeSymbol | undefined;
-/** Merge every custom-metadata block, reachable from the current program, targeting element to it's `metadata` and other builtin (note/headercolor/...) fields */
+export declare function mapNamePartToSymbolKind(nameParts: string[], targetKind: Exclude<MetadataTargetKind, MetadataTargetKind.Ref>): NameWithSymbolKind[];
+/**
+  * Merge every custom-metadata block applying to the target in the current program (in precedence order) to its `metadata` and other builtin (note/headercolor/...) fields
+  * NOTE: Only run during interpret phase
+  */
 export declare function attachCustomMetadata<T extends MetadataTarget>(compiler: Compiler, targetElement: Partial<T>, targetSymbol: NodeSymbol, fieldsRegistry: MetadataFieldRegistry<T, any>, filepath: Filepath): void;
 export {};

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

@@ -2,6 +2,10 @@ import { default as Compiler } from '../../../compiler/index';
 import { SyntaxNode } from '../../types/nodes';
 import { default as Report } from '../../types/report';
 import { NodeSymbol } from '../../types/symbol';
+import { CompileError } from '../../types';
 import { GlobalModule } from '../types';
+export declare const refUtils: {
+    getDuplicateError(name: string, schemaLabel: string, errorNode: SyntaxNode): CompileError;
+};
 export declare const refModule: GlobalModule;
 export declare function nodeRefereeOfRefEndpoint(compiler: Compiler, globalSymbol: NodeSymbol, node: SyntaxNode): Report<NodeSymbol | undefined>;

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

@@ -1,7 +1,9 @@
 import { Ref } from '../../types/schemaJson';
-import { RefMetadata, Filepath } from '../../types';
+import { RefMetadata, SettingName, Filepath } from '../../types';
 import { default as Compiler } from '../../../compiler';
 import { default as Report } from '../../types/report';
+import { MetadataFieldRegistry } from '../metadata/utils';
+export declare const REF_METADATA_FIELDS: MetadataFieldRegistry<Ref, SettingName.Color>;
 export declare class RefInterpreter {
     private compiler;
     private metadata;

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

@@ -167,6 +167,7 @@ export interface Ref {
     onDelete?: string;
     onUpdate?: string;
     inactive?: boolean;
+    metadata?: CustomMetadata;
     token: TokenPosition;
 }
 export type RefEndpointPair = [RefEndpoint, RefEndpoint];

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

@@ -16,6 +16,7 @@ export declare enum SymbolKind {
     Enum = "Enum",
     EnumField = "Enum field",
     StickyNote = "Note",
+    Ref = "Ref",
     TablePartial = "TablePartial",
     PartialInjection = "PartialInjection",
     DiagramView = "DiagramView",
@@ -41,7 +42,8 @@ export declare enum MetadataTargetKind {
     Table = "Table",
     Column = "Column",
     TableGroup = "TableGroup",
-    Note = "Note"
+    Note = "Note",
+    Ref = "Ref"
 }
 declare const __nodeSymbolBrand: unique symbol;
 export type NodeSymbolId = number & {
@@ -211,6 +213,14 @@ export declare class NoteSymbol extends NodeSymbol {
     get canBeImported(): boolean;
     get originalSymbol(): NodeSymbol;
 }
+export declare class RefSymbol extends NodeSymbol {
+    constructor({ declaration, name, }: {
+        declaration?: SyntaxNode;
+        name?: string;
+    }, id: NodeSymbolId, filepath: Filepath);
+    get canBeImported(): boolean;
+    get originalSymbol(): NodeSymbol;
+}
 export declare class TablePartialSymbol extends NodeSymbol {
     constructor({ declaration, name, }: {
         declaration?: SyntaxNode;

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

@@ -27,4 +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")[];
+export declare const TOP_LEVEL_SUGGESTION_LABELS: ("Table" | "Enum" | "TableGroup" | "TablePartial" | "Note" | "Ref" | "DiagramView" | "Metadata" | "Dep" | "Project" | "Records")[];

package/package.json

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