@dbml/parse 8.3.1-custom-metadata.1 → 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,16 +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, 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;
+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

@@ -17,11 +17,10 @@ export default class ProgramInterpreter {
     private interpretAllSymbols;
     private interpretUseSymbol;
     private interpretAllMetadata;
-    private promoteOverlapKeys;
+    private writeBuiltinFields;
     private attachMetadata;
     private interpretAllAliases;
     private validateRecords;
     private collectPartialRefs;
     private pushElement;
-    private recordEmitted;
 }

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,11 +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
+    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,7 +1,8 @@
 import { NONE_COLOR } from '../../constants';
 import { Filepath } from './filepath';
 import { Position } from './position';
-export type CustomMetadata = Record<string, unknown>;
+import { MetadataTargetKind } from './symbol';
+export type CustomMetadata = Record<string, string>;
 export type Color = `#${string}` | typeof NONE_COLOR;
 export declare enum AliasKind {
     Table = "table"
@@ -245,7 +246,7 @@ export interface TableRecord {
 }
 export interface MetadataElement {
     target: {
-        kind: string;
+        kind: MetadataTargetKind;
         name: string[];
     };
     values: CustomMetadata;

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,7 +1,9 @@
 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): {
@@ -14,3 +16,11 @@ export declare function processDefaultValue(valueNode?: SyntaxNode): {
     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

@@ -54,7 +54,7 @@ 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: {
+export declare function validateCustomInlineMetadata(name: string, attrs: AttributeNode[], errorCodes: {
     duplicate: CompileErrorCode;
     invalidValue: CompileErrorCode;
 }): CompileError[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@dbml/parse",
-  "version": "8.3.1-custom-metadata.1",
+  "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": "152988f537ab87a9d8320bd41b478495c1acbb0c"
+  "gitHead": "6ab830c6b2387ff0c3c9cd0e94c52e62e722ca25"
 }

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

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