@dbml/parse 9.0.0-alpha.3 → 9.0.0-optional-ref.0

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

@@ -1,6 +1,7 @@
 import { NONE_COLOR } from '../../constants';
 import { Filepath } from './filepath';
 import { Position } from './position';
+import { RelationshipOp, RelationCardinality } from './relation';
 export type Color = `#${string}` | typeof NONE_COLOR;
 export declare enum AliasKind {
     Table = "table"
@@ -58,7 +59,6 @@ export interface Database {
     tables: Table[];
     notes: Note[];
     refs: Ref[];
-    deps: Dep[];
     enums: Enum[];
     tableGroups: TableGroup[];
     aliases: Alias[];
@@ -111,7 +111,6 @@ export interface Column {
     type: ColumnType;
     token: TokenPosition;
     inline_refs: InlineRef[];
-    inline_deps: InlineDep[];
     checks: Check[];
     pk?: boolean;
     dbdefault?: {
@@ -151,7 +150,7 @@ export interface InlineRef {
     schemaName: string | null;
     tableName: string;
     fieldNames: string[];
-    relation: '>' | '<' | '-' | '<>';
+    relation: RelationshipOp;
     token: TokenPosition;
 }
 export interface Ref {
@@ -172,37 +171,6 @@ export interface RefEndpoint {
     relation: RelationCardinality;
     token: TokenPosition;
 }
-export type RelationCardinality = '1' | '*';
-export interface Dep {
-    schemaName: string | null;
-    name: string | null;
-    edges: DepEdge[];
-    color?: Color;
-    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;
@@ -284,4 +252,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 | InlineDep | Ref | RefEndpoint | Dep | DepEdge | DepEndpoint | Enum | EnumField | TableGroup | TableGroupField | Alias | TablePartial | TablePartialInjection | TableRecord | RecordValue;
+export type SchemaElement = Database | Project | Table | Note | Column | ColumnType | Index | Check | InlineRef | Ref | RefEndpoint | Enum | EnumField | TableGroup | TableGroupField | Alias | TablePartial | TablePartialInjection | TableRecord | RecordValue;

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

@@ -1,10 +1,10 @@
 import { default as Compiler } from '../../../compiler';
-import { AttributeNode, ElementDeclarationNode, InfixExpressionNode, SyntaxNode } from '../nodes';
+import { AttributeNode, ElementDeclarationNode, SyntaxNode } from '../nodes';
 import { ColumnSymbol, NodeSymbol, TablePartialSymbol, TableSymbol } from '../symbol';
 import { Internable } from '../internable';
+import { RelationshipOp, RelationCardinality } from '../relation';
 export declare enum MetadataKind {
     Ref = "ref",
-    Dep = "dep",
     PartialRef = "partial ref",
     TableChecks = "table checks",
     Indexes = "indexes",
@@ -37,25 +37,21 @@ export declare class RefMetadata extends NodeMetadata {
     rightColumns(compiler: Compiler): ColumnSymbol[];
     leftTable(compiler: Compiler): TableSymbol | undefined;
     rightTable(compiler: Compiler): TableSymbol | undefined;
-    op(_compiler: Compiler): '>' | '<' | '-' | '<>' | undefined;
+    op(_compiler: Compiler): RelationshipOp | undefined;
+    cardinalities(compiler: Compiler): [RelationCardinality, RelationCardinality] | undefined;
+    leftCardinality(compiler: Compiler): {
+        min: number;
+        max: number | '*';
+    } | undefined;
+    rightCardinality(compiler: Compiler): {
+        min: number;
+        max: number | '*';
+    } | undefined;
     active(compiler: Compiler): boolean;
     leftToken(): SyntaxNode;
     rightToken(): SyntaxNode;
     owners(compiler: Compiler): NodeSymbol[];
 }
-export declare class DepMetadata extends NodeMetadata {
-    declaration: ElementDeclarationNode | AttributeNode;
-    readonly kind = MetadataKind.Dep;
-    constructor(declaration: ElementDeclarationNode | AttributeNode);
-    container(compiler: Compiler): TableSymbol | undefined;
-    edgeExpressions(): InfixExpressionNode[];
-    upstreamColumns(compiler: Compiler): ColumnSymbol[][];
-    downstreamColumns(compiler: Compiler): ColumnSymbol[][];
-    upstreamTables(compiler: Compiler): (TableSymbol | undefined)[];
-    downstreamTables(compiler: Compiler): (TableSymbol | undefined)[];
-    private hostColumn;
-    owners(compiler: Compiler): NodeSymbol[];
-}
 export declare class PartialRefMetadata extends NodeMetadata {
     readonly kind = MetadataKind.PartialRef;
     constructor(declaration: SyntaxNode);
@@ -64,7 +60,16 @@ export declare class PartialRefMetadata extends NodeMetadata {
     rightColumns(compiler: Compiler): ColumnSymbol[];
     leftTablePartial(compiler: Compiler): TablePartialSymbol | undefined;
     rightTable(compiler: Compiler): TableSymbol | TablePartialSymbol | undefined;
-    op(_compiler: Compiler): '>' | '<' | '-' | '<>' | undefined;
+    op(_compiler: Compiler): RelationshipOp | undefined;
+    cardinalities(compiler: Compiler): [RelationCardinality, RelationCardinality] | undefined;
+    leftCardinality(compiler: Compiler): {
+        min: number;
+        max: number | '*';
+    } | undefined;
+    rightCardinality(compiler: Compiler): {
+        min: number;
+        max: number | '*';
+    } | undefined;
     leftToken(): SyntaxNode;
     rightToken(): SyntaxNode;
     owners(compiler: Compiler): NodeSymbol[];

package/dist/src/index.d.ts

@@ -10,9 +10,9 @@ export { SyntaxToken, SyntaxTokenKind, isTriviaToken, isOp, isOpToken, } from '.
 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 RelationCardinality, 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 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, CARDINALITY_ONE, CARDINALITY_MAYBE, CARDINALITY_SOME, CARDINALITY_MANY, } from './core/types/relation';
 export type { DiagramViewSyncOperation, DiagramViewBlock, TextEdit, } from './compiler/queries/transform';
-export type { DepSyncOperation, DepSyncEdge, DepEndpointRef, DepBlock, } from './compiler/queries/transform';
 export { dbmlLanguageConfig, dbmlMonarchTokensProvider, } from './services/monarch';
 export * from './compiler/projectLayout/layout';
 export { Compiler };

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@dbml/parse",
-  "version": "9.0.0-alpha.3",
+  "version": "9.0.0-optional-ref.0",
   "description": "DBML parser v2",
   "author": "Holistics <dev@holistics.io>",
   "license": "Apache-2.0",
@@ -50,5 +50,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "c25a2e99a38fdfabf87161919e6ba50e93a9bcf1"
+  "gitHead": "01feeb4d524ff11d6cfaad16730a27c73e0d3b1f"
 }

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

@@ -1,98 +0,0 @@
-import { Filepath } from '../../../core/types/filepath';
-import { default as Compiler } from '../../index';
-import { TextEdit } from './applyTextEdits';
-/** One endpoint of a dep edge. `fieldNames` is empty for a table-level edge. */
-export interface DepEndpointRef {
-    schemaName?: string | null;
-    tableName: string;
-    fieldNames?: string[];
-}
-export interface DepSyncEdge {
-    upstream: DepEndpointRef;
-    downstream: DepEndpointRef;
-}
-export interface DepSyncOperation {
-    operation: 'create' | 'update' | 'remove';
-    /** The edge that identifies the target block (table-level: empty fieldNames). */
-    edge: DepSyncEdge;
-    color?: string;
-}
-/**
- * A `color` setting found on a block.
- *
- * `kind` says how to overwrite it:
- *  - `attribute` -> replace just the `color: <hex>` attribute at `start..end`
- *    (inside a `[...]` list that may hold other settings).
- *  - `subDeclaration` -> replace the whole `color: <hex>` body line at
- *    `start..end`.
- */
-interface ColorSetting {
-    kind: 'attribute' | 'subDeclaration';
-    start: number;
-    end: number;
-    /**
-     * Range to delete when removing the color (revert to default). Wider than
-     * `start..end`: for an attribute it swallows the whole enclosing `[...]` when
-     * color is the sole setting, otherwise one adjacent comma; for a
-     * sub-declaration it is the same as `start..end` (the whole body line).
-     */
-    stripStart: number;
-    stripEnd: number;
-}
-export interface DepBlock {
-    startIndex: number;
-    endIndex: number;
-    edges: DepSyncEdge[];
-    /**
-     * An existing header `[...]` attribute list (without a color setting), so a
-     * color can be inserted into it instead of adding a second `[...]`.
-     * Records the offset just before the list's closing `]`.
-     */
-    attributeListInsertAt?: number;
-    attributeListIsEmpty?: boolean;
-    /**
-     * Offset of the block body `{` - where to add a header `[color: ...]` for a
-     * block-form Dep that has no attribute list.
-     */
-    bodyOpenAt?: number;
-    /**
-     * End offset of a short-form (`Dep: a -> b`) body that has no setting list -
-     * where to append ` [color: ...]`.
-     */
-    shortFormEnd?: number;
-    /** The existing color setting (header list, inline list, or sub-declaration), if any. */
-    color?: ColorSetting;
-}
-/**
- * Returns every `Dep` block in `source`.
- * On any lex or parse error, returns [] - there is no reliable way to read
- * dep blocks from malformed DBML (mirrors findDiagramViewBlocks).
- */
-export declare function findDepBlocks(source: string): DepBlock[];
-export interface InlineDep {
-    edge: DepSyncEdge;
-    stripStart: number;
-    stripEnd: number;
-}
-export declare function findInlineDeps(source: string): InlineDep[];
-/**
- * Emit a `Dep` block for one edge with a `[color]` setting:
- *
- *   Dep [color: <hex>] {
- *     <upstream> -> <downstream>
- *   }
- */
-export declare function generateDepBlock(edge: DepSyncEdge, color: string): string;
-/**
- * Synchronizes `Dep` blocks in the DBML source at `filepath`.
- *
- * @param filepath   The file whose source should be rewritten.
- * @param operations Array of create/update operations to apply.
- * @param blocks     Optional pre-parsed blocks from findDepBlocks.
- * @returns The new DBML source and the text edits applied.
- */
-export declare function syncDep(this: Compiler, filepath: Filepath, operations: DepSyncOperation[], blocks?: DepBlock[]): {
-    newDbml: string;
-    edits: TextEdit[];
-};
-export {};

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

@@ -1,15 +0,0 @@
-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

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

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

@@ -1,34 +0,0 @@
-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/local_modules/dep/index.d.ts

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

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

@@ -1,18 +0,0 @@
-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>;