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

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

@@ -0,0 +1,11 @@
+import { SyntaxNode } from '../../types/nodes';
+import { Column, Note, Table, TableGroup, TokenPosition } from '../../types/schemaJson';
+import { SettingName } from '../../types';
+export type MetadataTarget = Table | TableGroup | Note | Column;
+export interface FieldValidateSpec {
+    predicate(valueNode?: SyntaxNode): boolean;
+    message: string;
+}
+export type FieldValidateMap<T extends SettingName = SettingName> = Record<T, FieldValidateSpec>;
+export type FieldAssign<T extends MetadataTarget> = (element: T, value: string, token: TokenPosition) => void;
+export type FieldAssignMap<T extends MetadataTarget = MetadataTarget, P extends SettingName = SettingName> = Record<P, FieldAssign<T>>;

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

@@ -1,10 +1,12 @@
 import { default as Compiler } from '../../../compiler';
-import { Filepath } from '../../types';
+import { SettingName, 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';
-export declare function extractValue(node?: SyntaxNode): string | number | boolean | Color | undefined;
+import { MetadataElement } from '../../types/schemaJson';
+export declare const TABLE_BUILTIN_SETTINGS: readonly SettingName[];
+export declare const TABLEGROUP_BUILTIN_SETTINGS: readonly SettingName[];
+export declare const NOTE_BUILTIN_SETTINGS: readonly SettingName[];
+export declare const COLUMN_BUILTIN_SETTINGS: readonly SettingName[];
 export default class MetadataInterpreter {
     private declarationNode;
     private compiler;

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

@@ -1,6 +1,7 @@
 import { Note } from '../../types/schemaJson';
 import { default as Compiler } from '../../../compiler';
-import { Filepath, NoteSymbol } from '../../types';
+import { SettingName, Filepath, NoteSymbol } from '../../types';
+import { FieldAssignMap } from '../metadata/fieldSpec';
 import { default as Report } from '../../types/report';
 export declare class StickyNoteInterpreter {
     private declarationNode;
@@ -15,3 +16,4 @@ export declare class StickyNoteInterpreter {
     private interpretBody;
     private interpretNote;
 }
+export declare const NOTE_FIELD_ASSIGNS: FieldAssignMap<Note, SettingName.Color>;

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

@@ -11,11 +11,14 @@ 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 writeBuiltinFields;
+    private attachMetadata;
     private interpretAllAliases;
     private validateRecords;
     private collectPartialRefs;

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

@@ -1,7 +1,9 @@
 import { default as Compiler } from '../../../compiler';
+import { SettingName } from '../../types/keywords';
 import { ElementDeclarationNode } from '../../types/nodes';
 import { default as Report } from '../../types/report';
-import { Table } from '../../types/schemaJson';
+import { Column, Table } from '../../types/schemaJson';
+import { FieldAssignMap } from '../metadata/fieldSpec';
 import { Filepath } from '../../types/filepath';
 import { TableSymbol } from '../../types/symbol/symbols';
 export declare class TableInterpreter {
@@ -24,3 +26,5 @@ export declare class TableInterpreter {
     private interpretIndexes;
     private interpretChecks;
 }
+export declare const TABLE_FIELD_ASSIGNS: FieldAssignMap<Table, SettingName.Note | SettingName.HeaderColor>;
+export declare const COLUMN_FIELD_ASSIGNS: FieldAssignMap<Column, SettingName.Note | SettingName.PK | SettingName.Unique | SettingName.Increment>;

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

@@ -1,6 +1,7 @@
 import { TableGroup } from '../../types/schemaJson';
 import { default as Compiler } from '../../../compiler';
-import { Filepath, TableGroupSymbol } from '../../types';
+import { SettingName, Filepath, TableGroupSymbol } from '../../types';
+import { FieldAssignMap } from '../metadata/fieldSpec';
 import { default as Report } from '../../types/report';
 export declare class TableGroupInterpreter {
     private compiler;
@@ -16,3 +17,4 @@ export declare class TableGroupInterpreter {
     private interpretFields;
     private interpretSettingList;
 }
+export declare const TABLEGROUP_FIELD_ASSIGNS: FieldAssignMap<TableGroup, SettingName.Note | SettingName.Color>;

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

@@ -1,6 +1,9 @@
 import { default as Compiler } from '../../../compiler';
 import { CompileError } from '../../types/errors';
+import { SettingName } from '../../types/keywords';
 import { BlockExpressionNode, ElementDeclarationNode, FunctionApplicationNode } from '../../types/nodes';
+import { FieldValidateMap } from '../../global_modules/metadata/fieldSpec';
+export declare const NOTE_FIELD_SPECS: FieldValidateMap<SettingName.Color>;
 export default class NoteValidator {
     private compiler;
     private declarationNode;

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

@@ -1,8 +1,12 @@
 import { default as Compiler } from '../../../compiler';
 import { CompileError } from '../../types/errors';
+import { SettingName } from '../../types/keywords';
 import { ElementDeclarationNode, ExpressionNode, ListExpressionNode } from '../../types/nodes';
 import { default as Report } from '../../types/report';
 import { Settings } from '../../utils/validate';
+import { FieldValidateMap } from '../../global_modules/metadata/fieldSpec';
+export declare const TABLE_FIELD_SPECS: FieldValidateMap<SettingName.Note | SettingName.HeaderColor>;
+export declare const COLUMN_FIELD_SPECS: FieldValidateMap<SettingName.Note | SettingName.PK | SettingName.Unique | SettingName.Increment>;
 export default class TableValidator {
     private declarationNode;
     private compiler;

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

@@ -1,8 +1,11 @@
 import { default as Compiler } from '../../../compiler';
 import { CompileError } from '../../types/errors';
+import { SettingName } from '../../types/keywords';
 import { BlockExpressionNode, ElementDeclarationNode, FunctionApplicationNode, ListExpressionNode } from '../../types/nodes';
 import { default as Report } from '../../types/report';
 import { Settings } from '../../utils/validate';
+import { FieldValidateMap } from '../../global_modules/metadata/fieldSpec';
+export declare const TABLEGROUP_FIELD_SPECS: FieldValidateMap<SettingName.Note | SettingName.Color>;
 export default class TableGroupValidator {
     private declarationNode;
     private compiler;

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

@@ -114,12 +114,9 @@ export declare enum CompileErrorCode {
     UNEQUAL_FIELDS_BINARY_REF = 5003,
     CONFLICTING_SETTING = 5004,
     TABLE_REAPPEAR_IN_TABLEGROUP = 5005,
-    INVALID_METADATA_CONTEXT = 5006,
-    INVALID_METADATA_TARGET_KIND = 5007,
-    INVALID_METADATA_FIELD = 5008,
-    DUPLICATE_METADATA_FIELD = 5009,
-    METADATA_TARGET_NOT_FOUND = 5010,
-    DUPLICATE_METADATA_KEY_ACROSS_BLOCKS = 5011
+    INVALID_METADATA_TARGET_KIND = 5006,
+    INVALID_METADATA_FIELD = 5007,
+    DUPLICATE_METADATA_FIELD = 5008
 }
 export declare class CompileError extends Error {
     code: Readonly<CompileErrorCode>;

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

@@ -13,8 +13,7 @@ export declare enum ElementKind {
     DiagramViewTables = "tables",
     DiagramViewNotes = "notes",
     DiagramViewTableGroups = "tablegroups",
-    DiagramViewSchemas = "schemas",
-    Metadata = "metadata"
+    DiagramViewSchemas = "schemas"
 }
 export declare enum SettingName {
     Color = "color",

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

@@ -88,13 +88,11 @@ export declare class UseDeclarationNode extends SyntaxNode {
 }
 export declare class UseSpecifierNode extends SyntaxNode {
     importKind?: SyntaxToken;
-    subKind?: SyntaxToken;
     name?: NormalExpressionNode;
     asKeyword?: SyntaxToken;
     alias?: NormalExpressionNode;
-    constructor({ importKind, subKind, name, asKeyword, alias, }: {
+    constructor({ importKind, name, asKeyword, alias, }: {
         importKind?: SyntaxToken;
-        subKind?: SyntaxToken;
         name?: NormalExpressionNode;
         asKeyword?: SyntaxToken;
         alias?: NormalExpressionNode;

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

@@ -1,6 +1,8 @@
 import { NONE_COLOR } from '../../constants';
 import { Filepath } from './filepath';
 import { Position } from './position';
+import { MetadataTargetKind } from './symbol';
+export type CustomMetadata = Record<string, string>;
 export type Color = `#${string}` | typeof NONE_COLOR;
 export declare enum AliasKind {
     Table = "table"
@@ -66,7 +68,6 @@ export interface Database {
     records: TableRecord[];
     externals: DatabaseExternals;
     diagramViews: DiagramView[];
-    metadataElements: MetadataElement[];
     token?: TokenPosition;
 }
 export interface MasterDatabase {
@@ -86,12 +87,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 +127,7 @@ export interface Column {
         value: string;
         token: TokenPosition;
     };
+    metadata?: CustomMetadata;
 }
 export interface Index {
     columns: {
@@ -196,6 +200,7 @@ export interface TableGroup {
         value: string;
         token: TokenPosition;
     };
+    metadata?: CustomMetadata;
 }
 export interface TableGroupField {
     name: string;
@@ -241,12 +246,11 @@ export interface TableRecord {
 }
 export interface MetadataElement {
     target: {
-        kind: string;
+        kind: MetadataTargetKind;
         name: string[];
     };
-    values: {
-        [key: string]: unknown;
-    };
+    values: CustomMetadata;
+    valueTokens: Record<string, TokenPosition>;
     token: TokenPosition;
 }
 export type Project = Record<string, never> | {

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

@@ -34,7 +34,6 @@ export declare const ImportKind: {
     TablePartial: SymbolKind;
     Note: SymbolKind;
     Schema: SymbolKind;
-    Metadata: SymbolKind;
 };
 export type ImportKind = (typeof ImportKind)[keyof typeof ImportKind];
 export declare enum MetadataTargetKind {

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

@@ -1,16 +1,26 @@
 import { default as Compiler } from '../../compiler';
-import { Color, ColumnType, TokenPosition } from '../types/schemaJson';
+import { Color, ColumnType, CustomMetadata, TokenPosition } from '../types/schemaJson';
 import { SyntaxNode } from '../types/nodes';
 import { default as Report } from '../types/report';
+import { Settings } from './validate';
+import { SettingName } from '../types';
 export declare function getTokenPosition(node: SyntaxNode): TokenPosition;
 export declare function normalizeNote(content: string): string;
 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;
 } | undefined;
 export declare function processColumnType(compiler: Compiler, typeNode: SyntaxNode): Report<ColumnType>;
+/**
+  * Extract inline custom metadata from an aggregated setting list,
+  * excluding keys that are natively attached to the element (headercolor and note in `table`, color in `tablegroup`, .etc).
+  *
+  * NOTE: This is used during interpret phase, so no need to validate values, just extract them
+  */
+export declare function extractCustomInlineMetadata(settingMap: Settings, builtinSettings: readonly SettingName[]): CustomMetadata;
+export declare function extractMetadataValue(node?: SyntaxNode): string | Color | undefined;

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 validateCustomInlineMetadata(name: string, attrs: AttributeNode[], errorCodes: {
+    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.2",
   "description": "DBML parser v2",
   "author": "Holistics <dev@holistics.io>",
   "license": "Apache-2.0",
@@ -50,5 +50,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "cca14935200249a97ec9575cbbe16f5d491c4fc4"
+  "gitHead": "6ab830c6b2387ff0c3c9cd0e94c52e62e722ca25"
 }