@tsofist/schema-forge 2.8.0 → 2.10.0

package/lib/generator/schema-generator.js

@@ -37,6 +37,7 @@ async function generateSchemaByDraftTypes(options) {
     const parser = (0, ts_json_schema_generator_1.createParser)(generatorProgram, options.sourcesTypesGeneratorConfig, (parser) => {
         parser.addNodeParser(new TupleTypeParser(parser, allowUseFallbackDescription));
         parser.addNodeParser(new ArrayLiteralExpressionIdentifierParser(typeChecker));
+        parser.addNodeParser(new TypeofNodeParserEx(typeChecker, parser));
     });
     const formatter = (0, ts_json_schema_generator_1.createFormatter)(options.sourcesTypesGeneratorConfig);
     const generator = new ts_json_schema_generator_1.SchemaGenerator(generatorProgram, parser, formatter, generatorConfig);
@@ -96,6 +97,25 @@ async function generateSchemaByDraftTypes(options) {
 function escapeDefinitionNameForJSONPath(value) {
     return value.replace(/\\/g, '\\\\').replace(/"/g, '\\"');
 }
+class TypeofNodeParserEx extends ts_json_schema_generator_1.TypeofNodeParser {
+    createType(node, context, reference) {
+        const tc = this.typeChecker;
+        let symbol = tc.getSymbolAtLocation(node.exprName);
+        if (symbol && symbol.flags & typescript_1.SymbolFlags.Alias) {
+            symbol = tc.getAliasedSymbol(symbol);
+            const declaration = symbol.valueDeclaration;
+            if (declaration &&
+                (0, typescript_1.isSourceFile)(declaration) &&
+                declaration.fileName.endsWith('.json')) {
+                const statement = declaration.statements.at(0);
+                if (statement && (0, typescript_1.isExpressionStatement)(statement)) {
+                    return this.childNodeParser.createType(statement.expression, context, reference);
+                }
+            }
+        }
+        return super.createType(node, context, reference);
+    }
+}
 class TupleTypeParser {
     constructor(childNodeParser, allowUseFallbackDescription) {
         Object.defineProperty(this, "childNodeParser", {

package/lib/generator.spec.js

@@ -10,6 +10,51 @@ const validator_1 = require("./validator");
 const KEEP_ARTEFACTS = false;
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
+describe('generator for a8', () => {
+    const outputSchemaFile = './a8.generated.schema.tmp.json';
+    const outputSchemaMetadataFile = './a8.generated.definitions.tmp.json';
+    const schemaMetadata = {
+        title: 'Generator TEST',
+        version: '1.0.0',
+        $comment: 'WARN: This is a test schema.',
+    };
+    let forgeSchemaResult;
+    let validator;
+    let loadedSchema;
+    beforeAll(async () => {
+        forgeSchemaResult = await (0, generator_1.forgeSchema)({
+            schemaId: 'test',
+            allowUseFallbackDescription: true,
+            tsconfigFrom: './tsconfig.build-test.json',
+            sourcesDirectoryPattern: 'test-sources/a8',
+            sourcesFilesPattern: ['service-api.ts', 'types.ts'],
+            outputSchemaFile,
+            outputSchemaMetadataFile,
+            expose: 'all',
+            explicitPublic: true,
+            schemaMetadata,
+        });
+        validator = (0, validator_1.createSchemaForgeValidator)({}, true);
+        loadedSchema = await (0, generator_1.loadJSONSchema)([outputSchemaFile]);
+        validator.addSchema(loadedSchema);
+    });
+    afterAll(async () => {
+        if (!KEEP_ARTEFACTS) {
+            await (0, promises_1.unlink)(outputSchemaFile).catch(noop_1.noop);
+            await (0, promises_1.unlink)(outputSchemaMetadataFile).catch(noop_1.noop);
+        }
+    });
+    it('generated schema should have correct metadata', () => {
+        expect(forgeSchemaResult).toBeTruthy();
+        const schema = forgeSchemaResult.schema;
+        expect((0, pick_1.pickProps)(schema, Object.keys(schemaMetadata))).toStrictEqual(schemaMetadata);
+    });
+    it('generated schema should be valid', () => {
+        expect(forgeSchemaResult).toBeTruthy();
+        const schema = validator.getSchema('test#/definitions/TypeFromJSON');
+        expect(schema).toBeTruthy();
+    });
+});
 describe('generator for a7', () => {
     const outputSchemaFile = './a7.generated.schema.tmp.json';
     const outputSchemaMetadataFile = './a7.generated.definitions.tmp.json';

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/util/format.error.js

@@ -5,6 +5,7 @@ const ts_json_schema_generator_1 = require("ts-json-schema-generator");
 const typescript_1 = require("typescript");
 function formatSchemaForgeError(error, dir = '') {
     if (error instanceof ts_json_schema_generator_1.BaseError) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-argument
         return (0, typescript_1.formatDiagnostics)(error.diagnostic.relatedInformation || [], {
             getCanonicalFileName: (fileName) => fileName,
             getCurrentDirectory: () => dir,

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.10.0",
   "description": "Generate JSON schema from TypeScript types",
   "author": "Andrew Berdnikov <tsofistgudmen@gmail.com>",
   "license": "LGPL-3.0",
@@ -20,8 +20,8 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@faker-js/faker": "^9.7.0",
-    "@tsofist/stem": "^4.0.0",
+    "@faker-js/faker": "^9.8.0",
+    "@tsofist/stem": "^4.0.3",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
     "json-schema-faker": "^0.5.9",
@@ -32,12 +32,12 @@
   "devDependencies": {
     "@tsofist/web-buddy": "^1.21.0",
     "@types/jest": "^29.5.14",
-    "@types/node": "^20.17.30",
+    "@types/node": "^20.17.48",
     "@types/supertest": "^6.0.3",
     "jest": "~29.7.0",
     "rimraf": "^6.0.1",
-    "supertest": "^7.1.0",
-    "ts-jest": "~29.3.2",
+    "supertest": "^7.1.1",
+    "ts-jest": "~29.3.4",
     "typescript": "~5.8.3"
   },
   "publishConfig": {