@dbml/parse 8.3.1-custom-metadata.0 → 8.3.1-custom-metadata.1

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

@@ -3,8 +3,14 @@ import { Filepath } from '../../types';
 import { MetadataElementMetadata } from '../../types/symbol/metadata';
 import { SyntaxNode } from '../../types/nodes';
 import { default as Report } from '../../types/report';
-import { Color, MetadataElement } from '../../types/schemaJson';
+import { Color, CustomMetadata, MetadataElement } from '../../types/schemaJson';
+import { Settings } from '../../utils/validate';
 export declare function extractValue(node?: SyntaxNode): string | number | boolean | Color | undefined;
+export declare const TABLE_BUILTIN_SETTINGS: readonly ["headercolor", "note"];
+export declare const TABLEGROUP_BUILTIN_SETTINGS: readonly ["color", "note"];
+export declare const NOTE_BUILTIN_SETTINGS: readonly ["color"];
+export declare const COLUMN_BUILTIN_SETTINGS: readonly ["pk", "primary key", "unique", "note", "ref", "default", "check", "increment", "not null", "null"];
+export declare function extractInlineMetadata(settingMap: Settings, builtinSettingNames: readonly string[]): CustomMetadata;
 export default class MetadataInterpreter {
     private declarationNode;
     private compiler;

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

@@ -0,0 +1,14 @@
+import { MetadataTargetKind } from '../../types/symbol';
+export declare enum OverlapValueKind {
+    Note = "note",
+    Color = "color",
+    HeaderColor = "headercolor"
+}
+export type OverlapInlineField = 'note' | 'color' | 'headerColor';
+export interface OverlapKey {
+    metaKey: string;
+    field: OverlapInlineField;
+    reshape: OverlapValueKind;
+}
+export declare const OVERLAP_KEYS: Partial<Record<MetadataTargetKind, OverlapKey[]>>;
+export declare function findOverlapKey(kind: MetadataTargetKind | undefined, key: string): OverlapKey | undefined;

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

@@ -11,13 +11,17 @@ export default class ProgramInterpreter {
     private errors;
     private warnings;
     private db;
+    private emittedBySymbol;
     constructor(compiler: Compiler, symbol: ProgramSymbol, filepath: Filepath);
     interpret(): Report<SchemaElement | SchemaElement[] | undefined>;
     private interpretAllSymbols;
     private interpretUseSymbol;
     private interpretAllMetadata;
+    private promoteOverlapKeys;
+    private attachMetadata;
     private interpretAllAliases;
     private validateRecords;
     private collectPartialRefs;
     private pushElement;
+    private recordEmitted;
 }

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

@@ -118,8 +118,7 @@ export declare enum CompileErrorCode {
     INVALID_METADATA_TARGET_KIND = 5007,
     INVALID_METADATA_FIELD = 5008,
     DUPLICATE_METADATA_FIELD = 5009,
-    METADATA_TARGET_NOT_FOUND = 5010,
-    DUPLICATE_METADATA_KEY_ACROSS_BLOCKS = 5011
+    METADATA_TARGET_NOT_FOUND = 5010
 }
 export declare class CompileError extends Error {
     code: Readonly<CompileErrorCode>;

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';
+export type CustomMetadata = Record<string, unknown>;
 export type Color = `#${string}` | typeof NONE_COLOR;
 export declare enum AliasKind {
     Table = "table"
@@ -66,7 +67,6 @@ export interface Database {
     records: TableRecord[];
     externals: DatabaseExternals;
     diagramViews: DiagramView[];
-    metadataElements: MetadataElement[];
     token?: TokenPosition;
 }
 export interface MasterDatabase {
@@ -86,12 +86,14 @@ export interface Table {
         value: string;
         token: TokenPosition;
     };
+    metadata?: CustomMetadata;
 }
 export interface Note {
     name: string;
     content: string;
     token: TokenPosition;
     color?: Color;
+    metadata?: CustomMetadata;
 }
 export interface ColumnType {
     schemaName: string | null;
@@ -124,6 +126,7 @@ export interface Column {
         value: string;
         token: TokenPosition;
     };
+    metadata?: CustomMetadata;
 }
 export interface Index {
     columns: {
@@ -196,6 +199,7 @@ export interface TableGroup {
         value: string;
         token: TokenPosition;
     };
+    metadata?: CustomMetadata;
 }
 export interface TableGroupField {
     name: string;
@@ -244,9 +248,8 @@ export interface MetadataElement {
         kind: string;
         name: string[];
     };
-    values: {
-        [key: string]: unknown;
-    };
+    values: CustomMetadata;
+    valueTokens: Record<string, TokenPosition>;
     token: TokenPosition;
 }
 export type Project = Record<string, never> | {

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

@@ -8,7 +8,7 @@ export declare function extractElementName(nameNode: SyntaxNode): {
     schemaName: string[];
     name: string;
 };
-export declare function extractColor(node: unknown): Color | undefined;
+export declare function extractColor(node?: SyntaxNode): Color | undefined;
 export declare function processDefaultValue(valueNode?: SyntaxNode): {
     type: 'number' | 'string' | 'boolean' | 'expression';
     value: string | number;

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

@@ -1,3 +1,4 @@
+import { CompileError, CompileErrorCode } from '../types/errors';
 import { AttributeNode, BlockExpressionNode, ElementDeclarationNode, FunctionApplicationNode, FunctionExpressionNode, InfixExpressionNode, ListExpressionNode, LiteralNode, PrefixExpressionNode, PrimaryExpressionNode, ProgramNode, SyntaxNode, TupleExpressionNode, UseDeclarationNode, UseSpecifierNode, VariableNode, WildcardNode } from '../types/nodes';
 import { default as Report } from '../types/report';
 import { SyntaxToken, SyntaxTokenKind } from '../types/tokens';
@@ -24,7 +25,14 @@ export declare function isValidPartialInjection(node?: SyntaxNode): node is Pref
     };
 };
 export declare function isRelationshipOp(op?: string): boolean;
-export declare function isValidColor(value?: SyntaxNode): boolean;
+export declare function isValidHexColor(value?: SyntaxNode): value is PrimaryExpressionNode & {
+    expression: LiteralNode & {
+        literal: {
+            kind: SyntaxTokenKind.COLOR_LITERAL;
+        };
+    };
+};
+export declare function isValidColorOrNone(value?: SyntaxNode): boolean;
 export declare function isValidDefaultValue(value?: SyntaxNode): boolean;
 export type SignedNumberExpression = (PrimaryExpressionNode & {
     expression: LiteralNode & {
@@ -45,6 +53,11 @@ export declare function isTupleOfVariables(value?: SyntaxNode): value is TupleEx
 };
 export declare function isValidColumnType(type: SyntaxNode): boolean;
 export type Settings = Record<SettingName | string, AttributeNode[]>;
+export declare function isValidMetadataValue(value?: SyntaxNode): boolean;
+export declare function validateInlineMetadataSetting(name: string, attrs: AttributeNode[], codes: {
+    duplicate: CompileErrorCode;
+    invalidValue: CompileErrorCode;
+}): CompileError[];
 export declare function aggregateSettingList(settingList?: ListExpressionNode): Report<Settings>;
 export declare function isExpressionAQuotedString(value?: unknown): value is PrimaryExpressionNode & ({
     expression: VariableNode & {

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@dbml/parse",
-  "version": "8.3.1-custom-metadata.0",
+  "version": "8.3.1-custom-metadata.1",
   "description": "DBML parser v2",
   "author": "Holistics <dev@holistics.io>",
   "license": "Apache-2.0",
@@ -50,5 +50,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "cca14935200249a97ec9575cbbe16f5d491c4fc4"
+  "gitHead": "152988f537ab87a9d8320bd41b478495c1acbb0c"
 }