@dbml/parse 8.3.1-custom-metadata.3 → 8.3.1-custom-metadata.4

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

@@ -0,0 +1,29 @@
+import { default as Compiler } from '../../../compiler/index';
+import { Filepath, SettingName } from '../../types';
+import { Column, Note, Table, TableGroup, TokenPosition } from '../../types/schemaJson';
+import { ElementDeclarationNode, SyntaxNode } from '../../types/nodes';
+import { NodeSymbol, SymbolKind, MetadataTargetKind } from '../../types/symbol';
+export type MetadataTarget = Table | TableGroup | Note | Column;
+/**
+  * Specs for builtin metadata (table's note, tablegroup's color, .etc) for different element types. Does 2 things:
+  * - `validate`: Validating if the metadata value is syntactically correct
+  * - `assign`: Write the metadata value to the element builtin props (e.g. write `table.note` instead of `table.metadata`)
+  */
+interface MetadataField<T extends MetadataTarget> {
+    /** Check if the metadata value is syntactically correct */
+    isValidBuiltinFieldValue(node?: SyntaxNode): boolean;
+    message: string;
+    /** Write the metadata value to the element builtin props (e.g. write to `table.note`) */
+    assignBuiltinField(element: Partial<T>, value: string, token: TokenPosition): void;
+}
+export type MetadataFieldRegistry<T extends MetadataTarget, K extends SettingName = SettingName> = Record<K, MetadataField<T>>;
+type NameWithSymbolKind = {
+    name: string;
+    symbolKind: SymbolKind;
+};
+/** @internal Exported for testing only. */
+export declare function mapNamePartToSymbolKind(nameParts: string[], targetKind: MetadataTargetKind): NameWithSymbolKind[];
+export declare function resolveMetadataTarget(compiler: Compiler, metadataNode: ElementDeclarationNode): NodeSymbol | undefined;
+/** Merge every custom-metadata block, reachable from the current program, targeting element to it's `metadata` and other builtin (note/headercolor/...) fields */
+export declare function attachCustomMetadata<T extends MetadataTarget>(compiler: Compiler, targetElement: Partial<T>, targetSymbol: NodeSymbol, fieldsRegistry: MetadataFieldRegistry<T, any>, filepath: Filepath): void;
+export {};

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

@@ -1,8 +1,8 @@
 import { Note } from '../../types/schemaJson';
 import { default as Compiler } from '../../../compiler';
 import { SettingName, Filepath, NoteSymbol } from '../../types';
-import { MetadataFieldRegistry } from '../metadata/metadataField';
 import { default as Report } from '../../types/report';
+import { MetadataFieldRegistry } from '../metadata/utils';
 export declare const NOTE_METADATA_FIELDS: MetadataFieldRegistry<Note, SettingName.Color>;
 export declare class StickyNoteInterpreter {
     private declarationNode;

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

@@ -3,9 +3,9 @@ import { SettingName } from '../../types/keywords';
 import { ElementDeclarationNode } from '../../types/nodes';
 import { default as Report } from '../../types/report';
 import { Column, Table } from '../../types/schemaJson';
-import { MetadataFieldRegistry } from '../metadata/metadataField';
 import { Filepath } from '../../types/filepath';
 import { TableSymbol } from '../../types/symbol/symbols';
+import { MetadataFieldRegistry } from '../metadata/utils';
 export declare class TableInterpreter {
     private declarationNode;
     private compiler;
@@ -27,6 +27,11 @@ export declare class TableInterpreter {
     private interpretIndexes;
     private interpretChecks;
 }
+/**
+  * Settings that are excluded from custom metadata for inline metadata for Column
+  * Different from what we extract from metadata block for Column because some settings value types are not supported yet, mostly boolean keys without values ([pk, not null])
+  * TODO: Catch these settings when we support more data types for custom metadata
+  */
 export declare const RECOGNIZED_COLUMN_SETTINGS: readonly SettingName[];
 export declare const TABLE_METADATA_FIELDS: MetadataFieldRegistry<Table, SettingName.Note | SettingName.HeaderColor>;
 export declare const COLUMN_METADATA_FIELDS: MetadataFieldRegistry<Column, SettingName.Note>;

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

@@ -1,8 +1,8 @@
 import { TableGroup } from '../../types/schemaJson';
 import { default as Compiler } from '../../../compiler';
 import { SettingName, Filepath, TableGroupSymbol } from '../../types';
-import { MetadataFieldRegistry } from '../metadata/metadataField';
 import { default as Report } from '../../types/report';
+import { MetadataFieldRegistry } from '../metadata/utils';
 export declare const TABLEGROUP_METADATA_FIELDS: MetadataFieldRegistry<TableGroup, SettingName.Note | SettingName.Color>;
 export declare class TableGroupInterpreter {
     private compiler;

package/dist/src/services/suggestions/provider.d.ts

@@ -1,5 +1,23 @@
 import { default as Compiler } from '../../compiler';
+import { SettingName } from '../../core/types/keywords';
 import { CompletionItemProvider, CompletionList, Position, TextModel } from '../types';
+export declare const COLUMN_TYPE_SUGGESTION_LABELS: readonly ["integer", "int", "tinyint", "smallint", "mediumint", "bigint", "bit", "bool", "binary", "varbinary", "logical", "char", "nchar", "varchar", "varchar2", "nvarchar", "nvarchar2", "binary_float", "binary_double", "float", "double", "decimal", "dec", "real", "money", "smallmoney", "enum", "tinyblob", "tinytext", "blob", "text", "mediumblob", "mediumtext", "longblob", "longtext", "ntext", "set", "inet6", "uuid", "image", "date", "time", "datetime", "datetime2", "timestamp", "year", "smalldatetime", "datetimeoffset", "XML", "sql_variant", "uniqueidentifier", "CURSOR", "BFILE", "CLOB", "NCLOB", "RAW"];
+export declare const TABLE_SETTING_SUGGESTION_LABELS: readonly [SettingName.HeaderColor, SettingName.Note];
+export declare const TABLE_SETTING_SUGGESTION_TEXT_INSERTS: string[];
+export declare const COLUMN_SUGGESTION_LABELS: (SettingName.Note | SettingName.PK | SettingName.PrimaryKey | SettingName.Unique | SettingName.Ref | SettingName.NotNull | SettingName.Null | SettingName.Increment | SettingName.Default | SettingName.Check)[];
+export declare const COLUMN_SUGGESTION_TEXT_INSERTS: string[];
+export declare const INDEX_SETTING_SUGGESTION_LABELS: (SettingName.Note | SettingName.PK | SettingName.Unique | SettingName.Name | SettingName.Type)[];
+export declare const INDEX_SETTING_SUGGESTION_TEXT_INSERTS: string[];
+export declare const REF_SETTING_SUGGESTION_LABELS: (SettingName.Color | SettingName.Update | SettingName.Delete | SettingName.Inactive)[];
+export declare const REF_SETTING_SUGGESTION_TEXT_INSERTS: string[];
+export declare const ENUM_SETTING_SUGGESTION_LABELS: readonly [SettingName.Note];
+export declare const ENUM_SETTING_SUGGESTION_TEXT_INSERTS: string[];
+export declare const CHECK_SETTING_SUGGESTION_LABELS: readonly [SettingName.Name];
+export declare const CHECK_SETTING_SUGGESTION_TEXT_INSERTS: string[];
+export declare const REF_ACTION_VALUE_SUGGESTIONS: readonly ["cascade", "set default", "set null", "restrict"];
+export declare const INDEX_TYPE_VALUE_SUGGESTIONS: readonly ["btree", "hash"];
+export declare const TABLE_BODY_SUGGESTION_LABELS: ("indexes" | "checks" | "Note" | "Records")[];
+export declare const PROJECT_FIELD_SUGGESTION_LABELS: ("Table" | "Enum" | "TableGroup" | "TablePartial" | "Note" | "Ref")[];
 export interface DBMLCompletionItemProviderOptions {
     triggerCharacters?: string[];
 }
@@ -9,3 +27,4 @@ export default class DBMLCompletionItemProvider implements CompletionItemProvide
     constructor(compiler: Compiler, options?: DBMLCompletionItemProviderOptions);
     provideCompletionItems(model: TextModel, position: Position): CompletionList;
 }
+export declare const TOP_LEVEL_SUGGESTION_LABELS: ("Table" | "Enum" | "TableGroup" | "TablePartial" | "Note" | "DiagramView" | "Metadata" | "Ref" | "Project" | "Records")[];

package/package.json

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

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

@@ -1,6 +0,0 @@
-import { default as Compiler } from '../../../compiler/index';
-import { Filepath } from '../../types/filepath';
-import { NodeSymbol } from '../../types/symbol';
-import { MetadataFieldRegistry, MetadataTarget } from './metadataField';
-/** Merge every custom-metadata block, reachable from the current program, targeting element to it's `metadata` and other builtin (note/headercolor/...) fields */
-export declare function attachCustomMetadata<T extends MetadataTarget>(compiler: Compiler, targetElement: Partial<T>, targetSymbol: NodeSymbol, fieldsRegistry: MetadataFieldRegistry<T, any>, filepath: Filepath): void;

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

@@ -1,4 +0,0 @@
-import { MetadataTargetKind } from '../../types/symbol';
-import { MetadataFieldRegistry, MetadataTarget } from './metadataField';
-export declare const METADATA_FIELDS_BY_KIND: Record<MetadataTargetKind, MetadataFieldRegistry<any, any>>;
-export type { MetadataFieldRegistry, MetadataTarget };

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

@@ -1,17 +0,0 @@
-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;
-/**
-  * Specs for builtin metadata (table's note, tablegroup's color, .etc) for different element types. Does 2 things:
-  * - `validate`: Validating if the metadata value is syntactically correct
-  * - `assign`: Write the metadata value to the element builtin props (e.g. write `table.note` instead of `table.metadata`)
-  */
-export interface MetadataField<T extends MetadataTarget> {
-    /** Check if the metadata value is syntactically correct */
-    isValidBuiltinFieldValue(node?: SyntaxNode): boolean;
-    message: string;
-    /** Write the metadata value to the element builtin props (e.g. write to `table.note`) */
-    assignBuiltinField(element: Partial<T>, value: string, token: TokenPosition): void;
-}
-export type MetadataFieldRegistry<T extends MetadataTarget, K extends SettingName = SettingName> = Record<K, MetadataField<T>>;

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

@@ -1,11 +0,0 @@
-import { default as Compiler } from '../../../compiler/index';
-import { ElementDeclarationNode } from '../../types/nodes';
-import { NodeSymbol, SymbolKind, MetadataTargetKind } from '../../types/symbol';
-type NameWithSymbolKind = {
-    name: string;
-    symbolKind: SymbolKind;
-};
-/** @internal Exported for testing only. */
-export declare function mapNamePartToSymbolKind(nameParts: string[], targetKind: MetadataTargetKind): NameWithSymbolKind[];
-export declare function resolveMetadataTarget(compiler: Compiler, metadataNode: ElementDeclarationNode): NodeSymbol | undefined;
-export {};