@tsofist/schema-forge 2.10.0 → 2.12.0

package/lib/generator/schema-generator.js

@@ -7,6 +7,7 @@ const ajv_1 = require("ajv");
 const jsonpath_plus_1 = require("jsonpath-plus");
 const ts_json_schema_generator_1 = require("ts-json-schema-generator");
 const typescript_1 = require("typescript");
+const shrink_names_1 = require("../shrink-names");
 const sort_properties_1 = require("../util/sort-properties");
 const tsc_1 = require("../util/tsc");
 const types_1 = require("./types");
@@ -55,11 +56,16 @@ async function generateSchemaByDraftTypes(options) {
         const schema = generator.createSchema(definitionName);
         Object.assign(result.definitions, schema.definitions);
     }
-    if (options.shrinkDefinitionNames) {
+    const shrinkDefinitionNames = !options.shrinkDefinitionNames
+        ? undefined
+        : options.shrinkDefinitionNames === true
+            ? shrink_names_1.shrinkDefinitionName
+            : options.shrinkDefinitionNames;
+    if (shrinkDefinitionNames) {
         const replacement = new Set();
         // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
         for (const name of Object.keys(result.definitions)) {
-            const r = options.shrinkDefinitionNames(name);
+            const r = shrinkDefinitionNames(name);
             if (r) {
                 if (replacement.has(r) || r in result.definitions) {
                     (0, error_1.raise)(`Duplicate replacement definition name: ${r}`);

package/lib/generator.spec.js

@@ -399,6 +399,10 @@ describe('generator for a3', () => {
     it('generated schema should be valid', () => {
         expect(forgeSchemaResult).toBeTruthy();
     });
+    it('should generate root schema normally', () => {
+        const registry = (0, validator_1.createSchemaForgeValidator)({ schemas: [forgeSchemaResult.schema] });
+        expect(registry.getRootSchema('')).toBeTruthy();
+    });
     it('interface generics should works', () => {
         const props = forgeSchemaResult.schema.definitions?.InterfaceWithGeneric_InterfaceDeclaration
             .properties;

package/lib/shrink-names.d.ts

@@ -0,0 +1,6 @@
+import { NonEmptyString } from '@tsofist/stem';
+/**
+ * Shrink definition name by removing generic type parameters
+ *   and appending a digest of the removed part.
+ */
+export declare function shrinkDefinitionName(definitionName: string, suffixLength?: number): NonEmptyString | undefined;

package/lib/shrink-names.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shrinkDefinitionName = shrinkDefinitionName;
+const node_crypto_1 = require("node:crypto");
+/**
+ * Shrink definition name by removing generic type parameters
+ *   and appending a digest of the removed part.
+ */
+function shrinkDefinitionName(definitionName, suffixLength = 8) {
+    const gPos = definitionName.indexOf('<');
+    if (gPos >= 0) {
+        const prefix = definitionName.substring(0, gPos);
+        const hashSource = definitionName.substring(gPos);
+        const digest = (0, node_crypto_1.createHash)('sha512')
+            .update(hashSource)
+            .digest('hex')
+            .substring(0, suffixLength);
+        return `${prefix}_H${digest}`;
+    }
+    return undefined;
+}

package/lib/types.d.ts

@@ -75,10 +75,11 @@ export interface SchemaForgeOptions extends SchemaForgeBaseOptions {
     readonly sortObjectProperties?: boolean;
     /**
      * If you want to shrink the schema definition names, you have to provide a replacement function.
-     *
      * WARN: this functionality is not compatible (yet) with `encodeRefs=true` option.
+     *
+     * @see shrinkDefinitionName
      */
-    readonly shrinkDefinitionNames?: (definitionName: string) => undefined | NonEmptyString;
+    readonly shrinkDefinitionNames?: boolean | ((definitionName: string) => undefined | NonEmptyString);
 }
 export interface SchemaForgeMetadata {
     $id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsofist/schema-forge",
-  "version": "2.10.0",
+  "version": "2.12.0",
   "description": "Generate JSON schema from TypeScript types",
   "author": "Andrew Berdnikov <tsofistgudmen@gmail.com>",
   "license": "LGPL-3.0",
@@ -21,7 +21,7 @@
   },
   "dependencies": {
     "@faker-js/faker": "^9.8.0",
-    "@tsofist/stem": "^4.0.3",
+    "@tsofist/stem": "^5.1.0",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
     "json-schema-faker": "^0.5.9",
@@ -31,8 +31,8 @@
   },
   "devDependencies": {
     "@tsofist/web-buddy": "^1.21.0",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^20.17.48",
+    "@types/jest": "~29.5.14",
+    "@types/node": "^20.19.0",
     "@types/supertest": "^6.0.3",
     "jest": "~29.7.0",
     "rimraf": "^6.0.1",