@tsofist/schema-forge 2.5.0 → 2.6.0

package/lib/generator/schema-generator.d.ts

@@ -1,7 +1,6 @@
 import '../util/patch.extended-annotations-reader';
 import { SchemaObject } from 'ajv';
-import { ChainNodeParser, CompletedConfig, Context, SubNodeParser, TupleType } from 'ts-json-schema-generator';
-import { Node, TupleTypeNode } from 'typescript';
+import { CompletedConfig } from 'ts-json-schema-generator';
 import { SchemaForgeOptions } from '../types';
 import { TypeExposeKind } from './types';
 interface Options {
@@ -18,11 +17,4 @@ interface Options {
     shrinkDefinitionNames: SchemaForgeOptions['shrinkDefinitionNames'];
 }
 export declare function generateSchemaByDraftTypes(options: Options): Promise<SchemaObject>;
-export declare class TupleTypeParser implements SubNodeParser {
-    protected readonly childNodeParser: ChainNodeParser;
-    protected readonly allowUseFallbackDescription: boolean | undefined;
-    constructor(childNodeParser: ChainNodeParser, allowUseFallbackDescription: boolean | undefined);
-    supportsNode(node: Node): boolean;
-    createType(node: TupleTypeNode, context: Context): TupleType;
-}
 export {};

package/lib/generator/schema-generator.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TupleTypeParser = void 0;
 exports.generateSchemaByDraftTypes = generateSchemaByDraftTypes;
 require("../util/patch.extended-annotations-reader");
 const error_1 = require("@tsofist/stem/lib/error");
@@ -59,7 +58,6 @@ async function generateSchemaByDraftTypes(options) {
         const replacement = new Set();
         // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
         for (const name of Object.keys(result.definitions)) {
-            console.log('DEF::::', name);
             const r = options.shrinkDefinitionNames(name);
             if (r) {
                 if (replacement.has(r) || r in result.definitions) {
@@ -72,11 +70,11 @@ async function generateSchemaByDraftTypes(options) {
                 delete result.definitions[name];
                 // rename references
                 const targets = (0, jsonpath_plus_1.JSONPath)({
-                    path: `$..[?(@ && @.$ref == "#/definitions/${name}")]`,
+                    path: `$..[?(@ && @.$ref == "#/definitions/${escapeDefinitionNameForJSONPath(name)}")]`,
                     json: result,
                     eval: 'safe',
                 });
-                targets.forEach((item) => {
+                targets?.forEach((item) => {
                     item.$ref = item.$ref.replace(`#/definitions/${name}`, `#/definitions/${r}`);
                 });
             }
@@ -95,6 +93,9 @@ async function generateSchemaByDraftTypes(options) {
     }).validateSchema(result, true);
     return result;
 }
+function escapeDefinitionNameForJSONPath(value) {
+    return value.replace(/\\/g, '\\\\').replace(/"/g, '\\"');
+}
 class TupleTypeParser {
     constructor(childNodeParser, allowUseFallbackDescription) {
         Object.defineProperty(this, "childNodeParser", {
@@ -119,8 +120,6 @@ class TupleTypeParser {
             if ((0, typescript_1.isNamedTupleMember)(element)) {
                 const description = (0, tsc_1.readJSDocDescription)(element, this.allowUseFallbackDescription);
                 const nullable = type instanceof ts_json_schema_generator_1.AnnotatedType ? type.isNullable() : false;
-                if (nullable)
-                    console.log(description, nullable);
                 return description ? new ts_json_schema_generator_1.AnnotatedType(type, { description }, nullable) : type;
             }
             return type;
@@ -128,7 +127,6 @@ class TupleTypeParser {
         return new ts_json_schema_generator_1.TupleType(items);
     }
 }
-exports.TupleTypeParser = TupleTypeParser;
 class ArrayLiteralExpressionIdentifierParser {
     constructor(checker) {
         Object.defineProperty(this, "checker", {

package/lib/generator.spec.js

@@ -95,7 +95,7 @@ describe('validator for a7', () => {
         expect(initial).toStrictEqual(2);
         validator.warmupCacheSync();
         const warmed = validator.compilationArtifactCount;
-        expect(warmed).toStrictEqual(10);
+        expect(warmed).toStrictEqual(9);
         validator.clear();
         const cleared = validator.compilationArtifactCount;
         expect(cleared).toStrictEqual(1);
@@ -471,7 +471,8 @@ describe('generator for a1', () => {
         expect(forgeSchemaResult.refs.length).toStrictEqual(10);
     });
     it('getSchema', () => {
-        expect(validator.getValidator('test#/definitions/Int').schema).toStrictEqual({
+        expect(validator.getValidator('test#/definitions/PositiveInt').schema).toStrictEqual({
+            minimum: 1,
             type: 'integer',
         });
         expect(validator.getValidator('#/definitions/NotExists')).toStrictEqual(undefined);
@@ -486,14 +487,16 @@ describe('generator for a1', () => {
         });
     });
     it('hasSchema', () => {
-        expect(validator.hasValidator('test#/definitions/Int')).toStrictEqual(true);
+        expect(validator.hasValidator('test#/definitions/SomeType1')).toStrictEqual(true);
+        expect(validator.hasValidator('test#/definitions/PositiveInt')).toStrictEqual(true);
+        expect(validator.hasValidator('test#/definitions/Int')).toStrictEqual(false);
         expect(validator.hasValidator('test#/definitions/!Int')).toStrictEqual(false);
     });
     it('checkBySchema', () => {
         expect(() => validator.checkBySchema('test#/definitions/ExportedInterfaceB_InterfaceDeclaration', {})).toThrow(types_1.SchemaForgeValidationErrorCode);
-        expect(validator.checkBySchema('test#/definitions/Int', 1)).toStrictEqual(true);
-        expect(() => validator.checkBySchema('test#/definitions/Int', 1.1)).toThrow(types_1.SchemaForgeValidationErrorCode);
-        expect(() => validator.checkBySchema('!test#/definitions/Int', 1)).toThrow(types_1.SchemaNotFoundErrorCode);
+        expect(validator.checkBySchema('test#/definitions/PositiveInt', 1)).toStrictEqual(true);
+        expect(() => validator.checkBySchema('test#/definitions/PositiveInt', 1.1)).toThrow(types_1.SchemaForgeValidationErrorCode);
+        expect(() => validator.checkBySchema('!test#/definitions/PositiveInt', 1)).toThrow(types_1.SchemaNotFoundErrorCode);
         {
             const schema = '!test#/definitions/Int';
             try {
@@ -510,7 +513,7 @@ describe('generator for a1', () => {
             }
         }
         {
-            const schema = 'test#/definitions/Int';
+            const schema = 'test#/definitions/PositiveInt';
             const message = 'ERROR!';
             try {
                 validator.checkBySchema(schema, 1.1, { errorMessage: message });
@@ -568,13 +571,6 @@ describe('generator for a1', () => {
                 interface: 'ExportedInterfaceB',
                 method: 'methodB',
             },
-            {
-                ref: 'test#/definitions/Int',
-                kind: 0,
-                name: 'Int',
-                schemaId: 'test',
-                type: 'Int',
-            },
             {
                 ref: 'test#/definitions/NonExportedInterfaceD_InterfaceDeclaration',
                 kind: 1,
@@ -625,7 +621,7 @@ describe('generator for a1', () => {
             defsByName[def.name] = def;
         }
         expect(validator.listDefinitions()).toStrictEqual(defs);
-        expect(validator.listDefinitions((info) => info.kind === types_1.SchemaDefinitionKind.Type && !info.name.startsWith('Some'))).toStrictEqual([defsByName['Int'], defsByName['PositiveInt']]);
+        expect(validator.listDefinitions((info) => info.kind === types_1.SchemaDefinitionKind.Type && !info.name.startsWith('Some'))).toStrictEqual([defsByName['PositiveInt']]);
         expect(validator.listDefinitions((info) => info.kind === types_1.SchemaDefinitionKind.API)).toStrictEqual([
             defsByName['ExportedInterfaceB_InterfaceDeclaration'],
             defsByName['NonExportedInterfaceD_InterfaceDeclaration'],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsofist/schema-forge",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Generate JSON schema from TypeScript types",
   "author": "Andrew Berdnikov <tsofistgudmen@gmail.com>",
   "license": "LGPL-3.0",
@@ -21,10 +21,10 @@
   },
   "dependencies": {
     "@faker-js/faker": "^9.6.0",
-    "@tsofist/stem": "^2.2.0",
+    "@tsofist/stem": "^3.0.2",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
-    "json-schema-faker": "^0.5.8",
+    "json-schema-faker": "^0.5.9",
     "jsonpath-plus": "^10.3.0",
     "ts-json-schema-generator": "~2.3.0",
     "tslib": "^2.8.1"
@@ -32,13 +32,13 @@
   "devDependencies": {
     "@tsofist/web-buddy": "^1.21.0",
     "@types/jest": "^29.5.14",
-    "@types/node": "^20.17.28",
+    "@types/node": "^20.17.30",
     "@types/supertest": "^6.0.3",
     "jest": "^29.7.0",
     "rimraf": "^6.0.1",
     "supertest": "^7.1.0",
-    "ts-jest": "^29.3.0",
-    "typescript": "~5.8.2"
+    "ts-jest": "^29.3.1",
+    "typescript": "~5.8.3"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",