@tsofist/schema-forge 2.8.0 → 2.9.0

package/lib/types/db.types.d.ts

@@ -1,4 +1,4 @@
-import { ArrayMay } from '@tsofist/stem';
+import { ArrayMay, HexString } from '@tsofist/stem';
 /**
  * Database index types.
  *
@@ -38,10 +38,22 @@ export type DBIndexOptions = {
      * @default false
      */
     pk?: boolean;
+    /**
+     * Any important notes.
+     * Can be used in DDL.
+     */
+    note?: string;
+    /**
+     * Any important developer comments.
+     * Can't be used in DDL.
+     */
+    comment?: string;
 };
 export type DBIndexOptionsDef<B extends boolean = boolean> = ArrayMay<DBIndexOptions | string | B>;
 /**
  * Database entity options.
+ *
+ * @see https://dbml.dbdiagram.io/docs/#table-definition dbml spec
  */
 export type DBEntityOptions = {
     /**
@@ -60,5 +72,25 @@ export type DBEntityOptions = {
     indexes?: {
         [field: string]: DBIndexOptionsDef<true>;
     };
+    /**
+     * Any important notes.
+     * Can be used in DDL.
+     */
+    note?: string;
+    /**
+     * Any important developer comments.
+     * Can't be used in DDL.
+     */
+    comment?: string;
+    /**
+     * Table name alias.
+     */
+    alias?: string;
+    /**
+     * Settings.
+     */
+    settings?: {
+        headercolor: HexString;
+    };
 };
 export type DBEntityOptionsDef = DBEntityOptions | string;

package/lib/validator.js

@@ -339,6 +339,8 @@ function addJSDocKeywords(engine) {
             type: 'string',
             enum: db_types_1.DBIndexTypeList,
         },
+        note: { type: 'string' },
+        comment: { type: 'string' },
     };
     const DBIndexSchema = {
         type: ['string', 'boolean', 'object', 'array'],
@@ -374,6 +376,15 @@ function addJSDocKeywords(engine) {
                         pattern: NestedPropertyNamePattern,
                     },
                 },
+                note: { type: 'string' },
+                comment: { type: 'string' },
+                alias: { type: 'string' },
+                settings: {
+                    type: 'object',
+                    properties: {
+                        headercolor: { type: 'string' },
+                    },
+                },
             },
         },
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsofist/schema-forge",
-  "version": "2.8.0",
+  "version": "2.9.0",
   "description": "Generate JSON schema from TypeScript types",
   "author": "Andrew Berdnikov <tsofistgudmen@gmail.com>",
   "license": "LGPL-3.0",