@dbml/parse 9.0.0-alpha.3 → 9.0.0-alpha.5

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

@@ -6,7 +6,7 @@ import { DbmlProjectLayout } from './projectLayout';
 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, DepBlock, TableNameInput, TextEdit } from './queries/transform';
+export type { DiagramViewBlock, DepBlock, TableNameInput, TextEdit, } from './queries/transform';
 export { addDoubleQuoteIfNeeded, escapeString, formatRecordValue, isValidIdentifier, splitQualifiedIdentifier, unescapeString, findDiagramViewBlocks, findDepBlocks, };
 export default class Compiler {
     layout: DbmlProjectLayout;

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

@@ -1,7 +1,7 @@
 import { Filepath } from '../../../core/types/filepath';
+import { ElementDeclarationNode } from '../../../core/types/nodes';
 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;
@@ -15,53 +15,21 @@ 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;
+    /** Set to a value to create/update, null to remove, undefined to leave unchanged. */
+    color?: string | null;
+    /** Set to a value to create/update, null to remove, undefined to leave unchanged. */
+    note?: string | null;
 }
 export interface DepBlock {
     startIndex: number;
     endIndex: number;
+    declaration: ElementDeclarationNode;
     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;
+}
+export interface InlineDep {
+    edge: DepSyncEdge;
+    stripStart: number;
+    stripEnd: number;
 }
 /**
  * Returns every `Dep` block in `source`.
@@ -69,11 +37,6 @@ export interface DepBlock {
  * 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:
@@ -95,4 +58,3 @@ export declare function syncDep(this: Compiler, filepath: Filepath, operations:
     newDbml: string;
     edits: TextEdit[];
 };
-export {};

package/dist/src/compiler/queries/utils.d.ts

@@ -99,3 +99,8 @@ export declare function formatRecordValue(recordValue: {
 export declare function splitQualifiedIdentifier(identifier: string): string[];
 export declare function collectTransitiveDependencies(compiler: Compiler, entrypoints: Filepath[]): Filepath[];
 export declare function allVisibleMembers(compiler: Compiler): Report<NodeSymbol[]>;
+/**
+ * Wraps a note value in the appropriate DBML quote style.
+ * Uses triple quotes for multiline content, single quotes otherwise.
+ */
+export declare function quoteNoteValue(value: string): string;

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

@@ -13,7 +13,7 @@ export declare class DepInterpreter {
     private interpretName;
     private interpretEdges;
     /**
-     * Read settings into `dep.note` and `dep.custom`.
+     * Read settings into `dep.note` and `dep.metadata`.
      *
      * Settings come from THREE sources, in this order:
      *   1. The top-level attribute list on the Dep header
@@ -23,7 +23,7 @@ export declare class DepInterpreter {
      *   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`
+     * All three sources write into the same `metadata` 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.

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

@@ -8,6 +8,7 @@ export default class DepValidator {
     private compiler;
     constructor(compiler: Compiler, declarationNode: ElementDeclarationNode);
     validate(): CompileError[];
+    private validateSettings;
     private validateContext;
     private validateName;
     private validateAlias;

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

@@ -182,7 +182,7 @@ export interface Dep {
         value: string;
         token: TokenPosition;
     };
-    custom?: Record<string, string | number | boolean | null>;
+    metadata?: Record<string, string | number | boolean | null>;
     token: TokenPosition;
 }
 export interface DepEdge {
@@ -196,11 +196,14 @@ export interface DepEndpoint {
     fieldNames: string[];
     token: TokenPosition;
 }
+export declare const DEP_DOWNSTREAM: "->";
+export declare const DEP_UPSTREAM: "<-";
+export type DepDirection = typeof DEP_DOWNSTREAM | typeof DEP_UPSTREAM;
 export interface InlineDep {
     schemaName: string | null;
     tableName: string;
     fieldNames: string[];
-    direction: '->' | '<-';
+    direction: DepDirection;
     token: TokenPosition;
 }
 export interface Enum {

package/dist/src/core/utils/note.d.ts

@@ -0,0 +1,18 @@
+import { SyntaxNode } from '../types/nodes';
+import { TextEdit } from '../../compiler/queries/transform/applyTextEdits';
+/**
+ * Produces a TextEdit that updates an existing note's value.
+ * Returns undefined if no note exists.
+ */
+export declare function updateNoteEdit(declaration: SyntaxNode, newValue: string): TextEdit | undefined;
+/**
+ * Produces a TextEdit that removes an existing note.
+ * Returns undefined if no note exists.
+ */
+export declare function removeNoteEdit(declaration: SyntaxNode): TextEdit | undefined;
+/**
+ * Produces a TextEdit that adds a note to an element.
+ * Prioritizes body note form for block elements, falls back to setting attribute.
+ * Returns undefined if a note already exists.
+ */
+export declare function addNoteEdit(declaration: SyntaxNode, value: string): TextEdit | undefined;

package/dist/src/core/utils/setting.d.ts

@@ -0,0 +1,17 @@
+import { SyntaxNode } from '../types/nodes';
+import { TextEdit } from '../../compiler/queries/transform/applyTextEdits';
+/**
+ * Produces a TextEdit that adds a setting to a field/element declaration.
+ * If the declaration already has a settings block [...], inserts before the closing ].
+ * Otherwise, appends a new [setting] block.
+ */
+export declare function addSettingEdit(declaration: SyntaxNode, setting: string): TextEdit | undefined;
+/**
+ * Produces a TextEdit that updates an existing setting's value in a declaration.
+ */
+export declare function updateSettingEdit(declaration: SyntaxNode, settingName: string, newValue: string, source: string): TextEdit | undefined;
+/**
+ * Produces a TextEdit that removes a setting from a declaration.
+ * If it's the only setting, removes the entire settings block [...].
+ */
+export declare function removeSettingEdit(declaration: SyntaxNode, settingName: string, source: string): TextEdit | undefined;