@dbml/parse 9.0.0-alpha.1 → 9.0.0-alpha.2

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

@@ -3,11 +3,11 @@ import { SyntaxNode, SyntaxNodeIdGenerator } from '../core/types/nodes';
 import { NodeSymbolIdGenerator, SymbolFactory } from '../core/types/symbol';
 import { DBMLCompletionItemProvider, DBMLDefinitionProvider, DBMLDiagnosticsProvider, DBMLReferencesProvider } from '../services/index';
 import { DbmlProjectLayout } from './projectLayout';
-import { DiagramViewBlock, findDiagramViewBlocks } from './queries/transform';
+import { DiagramViewBlock, DepBlock, findDiagramViewBlocks, findDepBlocks } from './queries/transform';
 import { addDoubleQuoteIfNeeded, escapeString, formatRecordValue, isValidIdentifier, splitQualifiedIdentifier, unescapeString } from './queries/utils';
 export { ScopeKind } from './types';
-export type { DiagramViewBlock, TableNameInput, TextEdit } from './queries/transform';
-export { addDoubleQuoteIfNeeded, escapeString, formatRecordValue, isValidIdentifier, splitQualifiedIdentifier, unescapeString, findDiagramViewBlocks, };
+export type { DiagramViewBlock, DepBlock, TableNameInput, TextEdit } from './queries/transform';
+export { addDoubleQuoteIfNeeded, escapeString, formatRecordValue, isValidIdentifier, splitQualifiedIdentifier, unescapeString, findDiagramViewBlocks, findDepBlocks, };
 export default class Compiler {
     layout: DbmlProjectLayout;
     readonly nodeIdGenerator: SyntaxNodeIdGenerator;
@@ -78,6 +78,11 @@ export default class Compiler {
         edits: import('.').TextEdit[];
     };
     findDiagramViewBlocks(filepath: Filepath): DiagramViewBlock[];
+    syncDep: (filepath: Filepath, operations: import('..').DepSyncOperation[], blocks?: DepBlock[] | undefined) => {
+        newDbml: string;
+        edits: import('.').TextEdit[];
+    };
+    findDepBlocks(filepath: Filepath): DepBlock[];
     readonly token: {
         invalidStream: (filepath: Filepath) => readonly import('..').SyntaxToken[];
         flatStream: (filepath: Filepath) => readonly import('..').SyntaxToken[];

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

@@ -1,4 +1,5 @@
 export { renameTable } from './renameTable';
 export { syncDiagramView, findDiagramViewBlocks, type DiagramViewSyncOperation, type DiagramViewBlock, } from './syncDiagramView';
+export { syncDep, findDepBlocks, generateDepBlock, type DepSyncOperation, type DepSyncEdge, type DepEndpointRef, type DepBlock, } from './syncDep';
 export { applyTextEdits, type TextEdit } from './applyTextEdits';
 export { type TableNameInput } from './utils';

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

@@ -0,0 +1,90 @@
+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';
+    /** 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;
+}
+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/types/schemaJson.d.ts

@@ -177,6 +177,7 @@ export interface Dep {
     schemaName: string | null;
     name: string | null;
     edges: DepEdge[];
+    color?: Color;
     note?: {
         value: string;
         token: TokenPosition;

package/dist/src/index.d.ts

@@ -12,6 +12,7 @@ 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 { 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.1",
+  "version": "9.0.0-alpha.2",
   "description": "DBML parser v2",
   "author": "Holistics <dev@holistics.io>",
   "license": "Apache-2.0",
@@ -50,5 +50,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "a5d691bdc91c0f35dd988e5a2537650466146c5e"
+  "gitHead": "29e83a7d46ba317c1011a43021860348b8c829b5"
 }