@tsofist/schema-forge 2.3.0 → 2.4.1

package/lib/fake-generator.js

@@ -32,6 +32,7 @@ function createFakeGeneratorHost(source, options = {}) {
         generator.option({
             alwaysFakeOptionals: true,
             refDepthMax: 1_000,
+            pruneProperties: ['dbEntity', 'dbIndex'],
             ...options,
             resolveJsonPath: false,
         });

package/lib/generator.spec.js

@@ -271,6 +271,8 @@ describe('generator for a5', () => {
                         {
                             type: 'btree',
                         },
+                        'ix_some_indexed_field4_1',
+                        true,
                     ],
                     type: 'number',
                 },

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

@@ -0,0 +1,56 @@
+import { ArrayMay } from '@tsofist/stem';
+/**
+ * Database index types.
+ *
+ * @see https://www.postgresql.org/docs/current/indexes-types.html PostgreSQL
+ */
+export declare const DBIndexTypeList: readonly ["btree", "hash", "gin", "gist", "spgist", "brin"];
+/**
+ * Database index type.
+ *
+ * @see https://www.postgresql.org/docs/current/indexes-types.html PostgreSQL
+ * @default 'btree'
+ */
+export type DBIndexType = (typeof DBIndexTypeList)[number];
+/**
+ * Database index options.
+ */
+export type DBIndexOptions = {
+    /**
+     * Type of index.
+     * @default 'btree'
+     */
+    type?: DBIndexType;
+    /**
+     * Name of index.
+     * @default 'ix_[schema]_[table]_[column]'
+     */
+    name?: string;
+    /**
+     * If true, the index will be unique.
+     * @default false
+     */
+    unique?: boolean;
+};
+export type DBIndexOptionsDef<B extends boolean = boolean> = ArrayMay<DBIndexOptions | string | B>;
+/**
+ * Database entity options.
+ */
+export type DBEntityOptions = {
+    /**
+     * Table name.
+     *
+     * @default '[schema].[table]'
+     */
+    name?: string;
+    /**
+     * Indexes of the table.
+     * They can be overridden/added at the column level.
+     *
+     * Use `true` to apply default index options.
+     * Use string literal to set index name.
+     */
+    indexes?: {
+        [column: string]: DBIndexOptionsDef<true>;
+    };
+};

package/lib/types/db.types.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DBIndexTypeList = void 0;
+/**
+ * Database index types.
+ *
+ * @see https://www.postgresql.org/docs/current/indexes-types.html PostgreSQL
+ */
+exports.DBIndexTypeList = [
+    //
+    'btree',
+    'hash',
+    'gin',
+    'gist',
+    'spgist',
+    'brin',
+];

package/lib/validator.js

@@ -10,6 +10,7 @@ const delay_1 = require("@tsofist/stem/lib/timers/delay");
 const ajv_1 = require("ajv");
 const ajv_formats_1 = require("ajv-formats");
 const types_1 = require("./types");
+const db_types_1 = require("./types/db.types");
 const index_1 = require("./index");
 const DEF_OPTIONS = {
     meta: true,
@@ -329,34 +330,46 @@ function addJSDocKeywords(engine) {
             ],
         },
     });
-    const DBIndexSettingsSchema = {
-        type: 'object',
-        additionalProperties: false,
-        properties: {
-            name: { type: 'string' },
-            unique: { type: 'boolean' },
-            type: {
-                type: 'string',
-                enum: ['btree', 'gin', 'gist'],
-            },
+    const DBIndexOptionsProperties = {
+        name: { type: 'string', pattern: IXNamePattern },
+        unique: { type: 'boolean' },
+        type: {
+            type: 'string',
+            enum: db_types_1.DBIndexTypeList,
         },
     };
+    const DBIndexSchema = {
+        type: ['string', 'boolean', 'object', 'array'],
+        pattern: IXNamePattern,
+        additionalProperties: false,
+        properties: DBIndexOptionsProperties,
+        items: {},
+        minItems: 1,
+    };
+    DBIndexSchema.items = {
+        ...DBIndexSchema,
+        type: ['string', 'boolean', 'object'],
+    };
     engine.addKeyword({
         keyword: 'dbIndex',
-        metaSchema: {
-            type: ['string', 'boolean', 'object', 'array'],
-            pattern: IXNamePattern,
-            additionalProperties: false,
-            properties: DBIndexSettingsSchema.properties,
-            items: DBIndexSettingsSchema,
-            minItems: 1,
-        },
+        metaSchema: DBIndexSchema,
     });
     engine.addKeyword({
         keyword: 'dbEntity',
         metaSchema: {
-            type: 'string',
+            type: ['string', 'object'],
             pattern: EntityNamePattern,
+            additionalProperties: false,
+            properties: {
+                name: {
+                    type: 'string',
+                    pattern: EntityNamePattern,
+                },
+                indexes: {
+                    type: 'array',
+                    items: DBIndexSchema,
+                },
+            },
         },
     });
 }

package/package.json

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