@tsofist/schema-forge 3.6.0 → 3.7.0

package/lib/schema-dereference/dereference.js

@@ -38,19 +38,23 @@ function dereferenceSchema(raw, options = {}) {
                 }
                 return replacement;
             }
-            if (seen.has(resolvedSchema))
-                return seen.get(resolvedSchema);
+            // if (seen.has(resolvedSchema)) return seen.get(resolvedSchema); // todo?
             if (Array.isArray(resolvedSchema)) {
+                if (seen.has(resolvedSchema))
+                    return seen.get(resolvedSchema);
                 const resolvedArray = resolve(resolvedSchema, current.$ref);
                 seen.set(resolvedSchema, resolvedArray);
                 return resolvedArray;
             }
+            const { $ref, ...additionalProps } = current;
             const placeholder = {};
             seen.set(current, placeholder);
             const result = {
                 ...resolvedSchema,
                 ...resolve(resolvedSchema, current.$ref),
+                ...additionalProps,
             };
+            delete result.$ref; // !
             Object.assign(placeholder, result);
             seen.set(resolvedSchema, result);
             return result;

package/lib/schema-generator/extended-annotations-reader.js

@@ -4,14 +4,13 @@ const error_1 = require("@tsofist/stem/lib/error");
 const is_empty_1 = require("@tsofist/stem/lib/object/is-empty");
 const ts_json_schema_generator_1 = require("ts-json-schema-generator");
 const typescript_1 = require("typescript");
-const helpers_tsc_1 = require("./helpers-tsc");
 {
     // Support for @inheritDoc tag to enforce inheritance of annotations
+    // todo rework
     // eslint-disable-next-line @typescript-eslint/unbound-method
     const getAnnotations = ts_json_schema_generator_1.ExtendedAnnotationsReader.prototype.getAnnotations;
     ts_json_schema_generator_1.ExtendedAnnotationsReader.prototype.getAnnotations = function getAnnotationsWithInheritance(node) {
-        if (!(0, helpers_tsc_1.hasJSDocTag)(node, 'inheritDoc'))
-            return getAnnotations.call(this, node);
+        // if (!hasJSDocTag(node, 'inheritDoc')) return getAnnotations.call(this, node);
         // @ts-expect-error access to private property
         const checker = this.typeChecker || (0, error_1.raise)('TypeChecker is not available');
         const result = {};

package/lib/schema-generator/forge.spec.js

@@ -8,6 +8,7 @@ const pick_1 = require("@tsofist/stem/lib/object/pick");
 const artefacts_policy_1 = require("../artefacts-policy");
 const types_1 = require("../definition-info/types");
 const efc_1 = require("../efc");
+const dereference_1 = require("../schema-dereference/dereference");
 const loader_1 = require("../schema-registry/loader");
 const registry_1 = require("../schema-registry/registry");
 const forge_1 = require("./forge");
@@ -189,8 +190,9 @@ describe('generator for a6', () => {
             description: 'This is Collection item ID (inherits from UUID)',
         });
         expect(registry.getValidator('test#/definitions/CollectionItemID2').schema).toStrictEqual({
+            $ref: '#/definitions/UUID',
             format: 'uuid',
-            type: 'string',
+            description: 'This is Collection item ID (non-inherits from UUID)',
         });
         {
             const rec = registry.getValidator('test#/definitions/PRec<CollectionItem,UUID>').schema;
@@ -248,11 +250,13 @@ describe('generator for a5', () => {
             'DomainNum',
             'DomainValue',
             'DomainValuesType',
+            'FKColumn',
             'NT', // 'NamesType',
             'NamesTypeAbnormal',
             'NumN',
             'Nums',
             'Some',
+            'UUID',
             'Variadic',
             'Variadic1',
             'VariadicList',
@@ -265,6 +269,12 @@ describe('generator for a5', () => {
         expect(registry.getValidator('test#/definitions/NamesTypeAbnormal').schema).toStrictEqual({
             type: 'string',
         });
+        expect(registry.getValidator('test#/definitions/FKColumn').schema).toStrictEqual({
+            $ref: '#/definitions/UUID',
+            dbFK: true,
+            description: 'Foreign Key Column Type.',
+            format: 'uuid',
+        });
         expect(registry.getValidator('test#/definitions/Some').schema).toStrictEqual({
             type: 'object',
             properties: {
@@ -333,6 +343,18 @@ describe('generator for a5', () => {
                     ],
                     type: 'number',
                 },
+                ref0: {
+                    $ref: '#/definitions/UUID',
+                    dbFK: true,
+                    description: 'Inline Foreign Key',
+                },
+                ref1: {
+                    $ref: '#/definitions/FKColumn',
+                },
+                ref2: {
+                    $ref: '#/definitions/FKColumn',
+                    description: 'Inline Foreign Key (2)',
+                },
             },
             required: [
                 'vals',
@@ -349,11 +371,35 @@ describe('generator for a5', () => {
                 'indexedField2',
                 'indexedField3',
                 'indexedField4',
+                'ref0',
+                'ref1',
+                'ref2',
             ],
             additionalProperties: false,
             dbEntity: 'cmn.some',
         });
     });
+    it('should works with dereferenced schema', () => {
+        const v = (0, dereference_1.dereferenceSchema)(registry.getRootSchema('test')).definitions['Some'];
+        expect(v.properties.ref0).toStrictEqual({
+            type: 'string',
+            format: 'uuid',
+            description: 'Inline Foreign Key',
+            dbFK: true,
+        });
+        expect(v.properties.ref1).toStrictEqual({
+            type: 'string',
+            format: 'uuid',
+            description: 'Foreign Key Column Type.',
+            dbFK: true,
+        });
+        expect(v.properties.ref2).toStrictEqual({
+            type: 'string',
+            format: 'uuid',
+            description: 'Inline Foreign Key (2)',
+            dbFK: true,
+        });
+    });
 });
 describe('generator for a4', () => {
     const outputSchemaFile = './a4.generated.schema.tmp.json';

package/package.json

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