@tsofist/schema-forge 2.8.0 → 2.10.0-next.1

package/lib/types.d.ts

@@ -1,18 +1,35 @@
-import { NonEmptyString, Nullable, PRec } from '@tsofist/stem';
-import { ErrorCode } from '@tsofist/stem/lib/error';
-import { ErrorObject, ErrorsTextOptions, SchemaObject, ValidateFunction } from 'ajv';
-import { SchemaForgeBaseOptions } from './generator/types';
-export declare enum SchemaForgeSignatureSuffix {
-    MethodArguments = 0,
-    MethodResult = 1
-}
-export interface SchemaForgeOptions extends SchemaForgeBaseOptions {
+import type { NonEmptyString, Nullable, PRec } from '@tsofist/stem';
+import type { ErrorObject, ErrorsTextOptions, SchemaObject, ValidateFunction } from 'ajv';
+import type { Config } from 'ts-json-schema-generator';
+export interface ForgeSchemaOptions {
+    /**
+     * Generate schema definitions for public types only
+     * This option can help to protect leaked internal types
+     */
+    readonly explicitPublic?: boolean;
+    /**
+     * By default, generator use description jsdoc-tag
+     * If this option is true, then generator will use fallback description from type comment
+     */
+    readonly allowUseFallbackDescription?: boolean;
+    /**
+     * Filter for definitions
+     * Important: dependencies will not be filtered
+     */
+    readonly definitionsFilter?: (name: string) => boolean;
+    /**
+     * Create shared $ref definitions for all types.
+     *   Or: Do not create shared $ref definitions.
+     *   Or: (default) Create shared $ref definitions only for exported types (not tagged as `@internal`).
+     */
+    readonly expose?: TypeExposeKind;
     /**
      * $id for generated schema
      */
     readonly schemaId?: string;
     /**
      * Metadata keywords for schema
+     *
      * @see https://ajv.js.org/json-schema.html#metadata-keywords ajv
      */
     readonly schemaMetadata?: {
@@ -24,16 +41,18 @@ export interface SchemaForgeOptions extends SchemaForgeBaseOptions {
     };
     /**
      * Directories pattern for searching source files
+     *
      * @example
-     *      src/**
-     *      {src,types}/**
+     *   src/**
+     *   {src,types}/**
      */
     readonly sourcesDirectoryPattern: string;
     /**
      * Filenames pattern of source files
+     *
      * @example
-     *      service-api.ts
-     *      *.{api,api-types}.ts
+     *   service-api.ts
+     *   *.{api,api-types}.ts
      */
     readonly sourcesFilesPattern: string | string[];
     /**
@@ -46,39 +65,39 @@ export interface SchemaForgeOptions extends SchemaForgeBaseOptions {
     readonly tsconfigFrom?: string;
     /**
      * Schema file locations
+     *
      * @example
-     *      result.schema.json
-     *      /absolute/path/to/result.schema.json
+     *   result.schema.json
+     *   /absolute/path/to/result.schema.json
      */
     readonly outputSchemaFile: string;
     /**
      * Definitions file location
+     *
      * @example
-     *      result.schema-metadata.json
-     *      /absolute/path/to/result.schema-metadata.json
+     *   result.schema-metadata.json
+     *   /absolute/path/to/result.schema-metadata.json
      */
     readonly outputSchemaMetadataFile?: string;
-    /**
-     * Generate openapi compatible schema
-     * @default false
-     */
-    readonly openapiCompatible?: boolean;
+    readonly discriminatorType?: DiscriminatorType;
     /**
      * Determines whether to sort the properties of object schemas in alphabetical order.
-     *      If set to `true`, the tool will sort both the fields in the `properties` section
-     *        and the field names in the `required` array for object-schema definitions.
-     *      Sorting can improve readability and consistency,
-     *        but may affect the order in which properties appear in generated outputs.
-     *      Applicable only to schemas of type `object`.
+     *   If set to `true`, the tool will sort both the fields in the `properties` section
+     *     and the field names in the `required` array for object-schema definitions.
+     *   Sorting can improve readability and consistency,
+     *     but may affect the order in which properties appear in generated outputs.
+     *   Applicable only to schemas of type `object`.
+     *
      * @default false
      */
     readonly sortObjectProperties?: boolean;
     /**
-     * If you want to shrink the schema definition names, you have to provide a replacement function.
+     * 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;
@@ -92,29 +111,12 @@ export interface SchemaForgeMetadata {
     serviceRefs: PRec<string, SchemaForgeDefinitionRef>;
     serviceNames: PRec<SchemaForgeDefinitionRef>;
 }
-export interface SchemaForgeResult {
+export interface ForgeSchemaResult {
     schema: SchemaObject;
     refs: readonly SchemaForgeDefinitionRef[];
     generatedTemporaryFiles: readonly string[];
     generatedNamesBySourceFile: ReadonlyMap<string, ReadonlySet<string>>;
 }
-export declare const SchemaNotFoundErrorCode: ErrorCode;
-export type SchemaNotFoundErrorContext = SchemaForgeValidationContextBase & {
-    schema: SchemaForgeDefinitionRef;
-};
-export declare const SchemaForgeValidationErrorCode: ErrorCode;
-export type SchemaForgeValidationErrorContext = SchemaForgeValidationErrorContextBase & {
-    schema: SchemaForgeDefinitionRef;
-    errors: SchemaForgeValidationReport;
-};
-export interface SchemaForgeValidationContextBase {
-    errorMessage?: string;
-    instancePath?: string;
-}
-export interface SchemaForgeValidationErrorContextBase extends SchemaForgeValidationContextBase {
-    schema: SchemaForgeDefinitionRef;
-    errors: SchemaForgeValidationReport;
-}
 /**
  * Reference to schema definition
  * @example
@@ -123,37 +125,6 @@ export interface SchemaForgeValidationErrorContextBase extends SchemaForgeValida
  *     'SomeSchemaId#/definitions/MyType'
  */
 export type SchemaForgeDefinitionRef = '' | `${string}#/definitions/${string}`;
-export declare enum SchemaDefinitionKind {
-    Type = 0,
-    API = 1,
-    APIMethodResult = 2,
-    APIMethodArguments = 3
-}
-interface SDIBase {
-    name: string;
-    schemaId: string;
-    ref: SchemaForgeDefinitionRef;
-    kind: SchemaDefinitionKind;
-}
-export interface SDIType extends SDIBase {
-    kind: SchemaDefinitionKind.Type;
-    type: string;
-}
-export interface SDIAPIInterface extends SDIBase {
-    kind: SchemaDefinitionKind.API;
-    interface: string;
-}
-export interface SDIMethodArguments extends SDIBase {
-    kind: SchemaDefinitionKind.APIMethodArguments;
-    interface: string;
-    method: string;
-}
-export interface SDIMethodResult extends SDIBase {
-    kind: SchemaDefinitionKind.APIMethodResult;
-    interface: string;
-    method: string;
-}
-export type SchemaDefinitionInfo = SDIType | SDIAPIInterface | SDIMethodArguments | SDIMethodResult;
 export interface SchemaForgeValidationResult {
     valid: boolean;
     errors: Nullable<SchemaForgeValidationReport>;
@@ -161,4 +132,7 @@ export interface SchemaForgeValidationResult {
 }
 export type SchemaForgeValidationFunction<T = unknown> = ValidateFunction<T>;
 export type SchemaForgeValidationReport = ErrorObject[];
+type TypeExposeKind = Config['expose'];
+type DiscriminatorType = Config['discriminatorType'];
 export {};
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,KAAK,CAAC;AAC1F,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAEvD,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,2BAA2B,CAAC,EAAE,OAAO,CAAC;IAC/C;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;IACvD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC;IACjC;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE;QACtB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;KACzD,CAAC;IACF;;;;;;OAMG;IACH,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC;;;;;;OAMG;IACH,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAChD;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;;;OAMG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC;;;;;;OAMG;IACH,QAAQ,CAAC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAE3C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IAC/C;;;;;;;;;OASG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IACxC;;;;;OAKG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EACzB,OAAO,GACP,CAAC,CAAC,cAAc,EAAE,MAAM,KAAK,SAAS,GAAG,cAAc,CAAC,CAAC;CAClE;AAED,MAAM,WAAW,mBAAmB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAC7C,KAAK,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACtC,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IACpD,YAAY,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,iBAAiB;IAC9B,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE,SAAS,wBAAwB,EAAE,CAAC;IAC1C,uBAAuB,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3C,0BAA0B,EAAE,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;CACxE;AAED;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,GAAG,EAAE,GAAG,GAAG,MAAM,iBAAiB,MAAM,EAAE,CAAC;AAE/E,MAAM,WAAW,2BAA2B;IACxC,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,QAAQ,CAAC,2BAA2B,CAAC,CAAC;IAC9C,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,iBAAiB,KAAK,MAAM,CAAC;CACvD;AAED,MAAM,MAAM,6BAA6B,CAAC,CAAC,GAAG,OAAO,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAC7E,MAAM,MAAM,2BAA2B,GAAG,WAAW,EAAE,CAAC;AAExD,KAAK,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;AACvC,KAAK,iBAAiB,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC"}

package/lib/types.js

@@ -1,17 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SchemaDefinitionKind = exports.SchemaForgeValidationErrorCode = exports.SchemaNotFoundErrorCode = exports.SchemaForgeSignatureSuffix = void 0;
-var SchemaForgeSignatureSuffix;
-(function (SchemaForgeSignatureSuffix) {
-    SchemaForgeSignatureSuffix[SchemaForgeSignatureSuffix["MethodArguments"] = 0] = "MethodArguments";
-    SchemaForgeSignatureSuffix[SchemaForgeSignatureSuffix["MethodResult"] = 1] = "MethodResult";
-})(SchemaForgeSignatureSuffix || (exports.SchemaForgeSignatureSuffix = SchemaForgeSignatureSuffix = {}));
-exports.SchemaNotFoundErrorCode = 'EC_SCHEMA_NOT_FOUND';
-exports.SchemaForgeValidationErrorCode = 'EC_SCHEMA_VALIDATION_FAILED';
-var SchemaDefinitionKind;
-(function (SchemaDefinitionKind) {
-    SchemaDefinitionKind[SchemaDefinitionKind["Type"] = 0] = "Type";
-    SchemaDefinitionKind[SchemaDefinitionKind["API"] = 1] = "API";
-    SchemaDefinitionKind[SchemaDefinitionKind["APIMethodResult"] = 2] = "APIMethodResult";
-    SchemaDefinitionKind[SchemaDefinitionKind["APIMethodArguments"] = 3] = "APIMethodArguments";
-})(SchemaDefinitionKind || (exports.SchemaDefinitionKind = SchemaDefinitionKind = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsofist/schema-forge",
-  "version": "2.8.0",
+  "version": "2.10.0-next.1",
   "description": "Generate JSON schema from TypeScript types",
   "author": "Andrew Berdnikov <tsofistgudmen@gmail.com>",
   "license": "LGPL-3.0",
@@ -20,10 +20,12 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@faker-js/faker": "^9.7.0",
-    "@tsofist/stem": "^4.0.0",
+    "@dbml/core": "~3.13.5",
+    "@faker-js/faker": "^9.8.0",
+    "@tsofist/stem": "^5.1.0",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
+    "json-schema": "^0.4.0",
     "json-schema-faker": "^0.5.9",
     "jsonpath-plus": "^10.3.0",
     "ts-json-schema-generator": "~2.3.0",
@@ -32,12 +34,12 @@
   "devDependencies": {
     "@tsofist/web-buddy": "^1.21.0",
     "@types/jest": "^29.5.14",
-    "@types/node": "^20.17.30",
+    "@types/node": "^20.19.0",
     "@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.4.0",
     "typescript": "~5.8.3"
   },
   "publishConfig": {
@@ -66,6 +68,7 @@
     "collectCoverageFrom": [
       "**/*.(t|j)s"
     ],
+    "prettierPath": null,
     "cacheDirectory": ".jest-cache",
     "coverageDirectory": ".coverage",
     "testEnvironment": "node",

package/lib/fake-generator.d.ts

@@ -1,21 +0,0 @@
-import * as fakerModule from '@faker-js/faker';
-import { ArrayMay } from '@tsofist/stem';
-import { JSONSchemaFaker, JSONSchemaFakerOptions } from 'json-schema-faker';
-import { SchemaForgeDefinitionRef } from './types';
-import { SchemaForgeValidator } from './validator';
-export type SetupFakerModules = (faker: fakerModule.Faker) => object;
-export type FakerRangeNum = Parameters<fakerModule.HelpersModule['rangeToNumber']>[0];
-export type FakeGeneratorLocaleName = keyof typeof fakerModule.allLocales;
-export interface FakeGeneratorOptions extends JSONSchemaFakerOptions {
-    locale?: ArrayMay<FakeGeneratorLocaleName>;
-    setupFakerModules?: SetupFakerModules[];
-}
-export interface FakeGeneratorHost {
-    readonly validator: SchemaForgeValidator;
-    readonly faker: fakerModule.Faker;
-    readonly generator: typeof JSONSchemaFaker;
-    readonly rebuild: () => this;
-}
-export declare function createFakeGeneratorHost(source: SchemaForgeValidator, options?: FakeGeneratorOptions): FakeGeneratorHost;
-export declare function generateFakeData<T = unknown>(validator: SchemaForgeValidator, source: SchemaForgeDefinitionRef, options?: FakeGeneratorOptions): T;
-export declare function generateFakeData<T = unknown>(host: FakeGeneratorHost, source: SchemaForgeDefinitionRef): T;

package/lib/fake-generator.js

@@ -1,158 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createFakeGeneratorHost = createFakeGeneratorHost;
-exports.generateFakeData = generateFakeData;
-const fakerModule = require("@faker-js/faker");
-const as_array_1 = require("@tsofist/stem/lib/as-array");
-const native_date_1 = require("@tsofist/stem/lib/cldr/date-time/native-date");
-const types_1 = require("@tsofist/stem/lib/cldr/date-time/types");
-const entries_1 = require("@tsofist/stem/lib/object/entries");
-const substr_1 = require("@tsofist/stem/lib/string/substr");
-const json_schema_faker_1 = require("json-schema-faker");
-function createFakeGeneratorHost(source, options = {}) {
-    const rebuild = () => {
-        const validator = source;
-        const faker = new fakerModule.Faker({
-            locale: (0, as_array_1.asArray)(options.locale || ['en']).map((name) => fakerModule.allLocales[name]),
-        });
-        const generator = json_schema_faker_1.JSONSchemaFaker.extend('faker', () => {
-            Object.assign(faker, {
-                date: proxyFakerDateModule(faker.date),
-            });
-            for (const item of [
-                //
-                ...EmbeddedModules,
-                ...(options.setupFakerModules || []),
-            ]) {
-                const modules = item(faker);
-                Object.assign(faker, modules);
-            }
-            return faker;
-        });
-        generator.option({
-            alwaysFakeOptionals: true,
-            refDepthMax: 1_000,
-            pruneProperties: ['dbEntity', 'dbIndex'],
-            ...options,
-            resolveJsonPath: false,
-        });
-        return {
-            rebuild,
-            generator,
-            faker,
-            validator,
-        };
-    };
-    return rebuild();
-}
-function generateFakeData(validatorOrHost, source, options = {}) {
-    const host = 'validator' in validatorOrHost
-        ? validatorOrHost
-        : createFakeGeneratorHost(validatorOrHost, options);
-    const { validator, generator } = host;
-    const refs = {};
-    {
-        const rootSchemaId = (0, substr_1.substr)(source, 0, '#');
-        for (const def of validator.listDefinitions()) {
-            const schema = validator.getSchema(def.ref);
-            if (rootSchemaId === def.schemaId) {
-                refs[`#/definitions/${def.name}`] = schema;
-            }
-            else {
-                refs[def.ref] = schema;
-            }
-        }
-    }
-    const schema = validator.getSchema(source);
-    if (schema == null)
-        throw new Error(`Schema not found: ${source}`);
-    const result = generator.generate(schema, refs);
-    cleanJSFQuirksArtefacts(result);
-    return result;
-}
-const EmbeddedModules = [
-    (faker) => ({
-        sf: {
-            /** FakerModule: sf.url */
-            url(origin = 'https://example.com', paths = { min: 1, max: 5 }, pathWords = { min: 1, max: 3 }) {
-                const pathParts = new Array(faker.helpers.rangeToNumber(paths))
-                    .fill('')
-                    .map(() => faker.lorem.slug(pathWords));
-                return `${origin}/${pathParts.join('/')}`;
-            },
-        },
-        cldr: {
-            /** FakerModule: cldr.localDateTime */
-            localDateTime() {
-                return (0, native_date_1.dateToTypedString)(new Date(), types_1.ISODateTimeType.LocalDateTime, true);
-            },
-            /** FakerModule: cldr.localDate */
-            localDate() {
-                return (0, native_date_1.dateToTypedString)(new Date(), types_1.ISODateTimeType.LocalDate);
-            },
-            /** FakerModule: cldr.localTime */
-            localTime() {
-                return (0, native_date_1.dateToTypedString)(new Date(), types_1.ISODateTimeType.LocalTime, true);
-            },
-            /** FakerModule: cldr.zuluDateTime */
-            zuluDateTime() {
-                return (0, native_date_1.dateToTypedString)(new Date(), types_1.ISODateTimeType.ZuluDateTime);
-            },
-            /** FakerModule: cldr.zuluDate */
-            zuluDate() {
-                return (0, native_date_1.dateToTypedString)(new Date(), types_1.ISODateTimeType.ZuluDate);
-            },
-            /** FakerModule: cldr.zuluTime */
-            zuluTime() {
-                return (0, native_date_1.dateToTypedString)(new Date(), types_1.ISODateTimeType.ZuluTime);
-            },
-        },
-    }),
-];
-function proxyFakerDateModule(obj) {
-    return new Proxy(obj, {
-        get(target, prop, receiver) {
-            const originalValue = Reflect.get(target, prop, receiver);
-            if (typeof originalValue === 'function') {
-                return function (...args) {
-                    const result = originalValue.apply(this, args);
-                    return result instanceof Date ? result.toISOString() : result;
-                };
-            }
-            return originalValue;
-        },
-    });
-}
-function cleanJSFQuirksArtefacts(target) {
-    const stack = [[target]];
-    const hasProblem = (item) => {
-        return (typeof item === 'object' &&
-            item !== null &&
-            ('$ref' in item || 'anyOf' in item || 'allOf' in item || 'not' in item));
-    };
-    while (stack.length > 0) {
-        const [current] = stack.pop();
-        if (Array.isArray(current)) {
-            for (let i = current.length - 1; i >= 0; i--) {
-                const element = current[i];
-                if (hasProblem(element)) {
-                    current.splice(i, 1);
-                }
-                else if (typeof element === 'object' && element !== null) {
-                    stack.push([element]);
-                }
-            }
-        }
-        else if (current != null && typeof current === 'object') {
-            for (const [propKey, propValue] of (0, entries_1.entries)(current)) {
-                if (hasProblem(propValue)) {
-                    delete current[propKey];
-                }
-                else if (typeof propValue === 'object' && propValue !== null) {
-                    stack.push([propValue]);
-                }
-            }
-        }
-    }
-    return target;
-}

package/lib/fake-generator.spec.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,20 +0,0 @@
-import '../util/patch.extended-annotations-reader';
-import { SchemaObject } from 'ajv';
-import { CompletedConfig } from 'ts-json-schema-generator';
-import { SchemaForgeOptions } from '../types';
-import { TypeExposeKind } from './types';
-interface Options {
-    tsconfig: string;
-    sourcesDirectoryPattern: string;
-    sourcesTypesGeneratorConfig: CompletedConfig;
-    outputSchemaFile: string;
-    definitions: string[];
-    schemaId?: string;
-    expose?: TypeExposeKind;
-    openapiCompatible?: boolean;
-    sortObjectProperties?: boolean;
-    allowUseFallbackDescription?: boolean;
-    shrinkDefinitionNames: SchemaForgeOptions['shrinkDefinitionNames'];
-}
-export declare function generateSchemaByDraftTypes(options: Options): Promise<SchemaObject>;
-export {};

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

@@ -1,13 +0,0 @@
-import { CompletedConfig } from 'ts-json-schema-generator/dist/src/Config';
-import { SchemaForgeBaseOptions } from './types';
-interface Options extends SchemaForgeBaseOptions {
-    tsconfig: string;
-    sourcesPattern: string[];
-}
-export declare function generateDraftTypeFiles(options: Options): Promise<{
-    sourcesTypesGeneratorConfig: CompletedConfig;
-    files: string[];
-    definitions: string[];
-    namesBySourceFile: Map<string, Set<string>>;
-}>;
-export {};

package/lib/generator/types.d.ts

@@ -1,40 +0,0 @@
-import { Config } from 'ts-json-schema-generator';
-export type TypeExposeKind = Config['expose'];
-export declare const TMP_FILES_SUFFIX = ".schema-forge.temporary-generated.tmp";
-export declare const SG_CONFIG_MANDATORY: Config;
-export declare const SG_CONFIG_DEFAULTS: {
-    sortProps: true;
-    additionalProperties: false;
-    expose: "export";
-    strictTuples: true;
-    extraTags: string[];
-    encodeRefs: false;
-    markdownDescription: false;
-    discriminatorType: undefined;
-    functions: "hide";
-};
-export interface SchemaForgeBaseOptions {
-    /**
-     * Generate schema definitions for public types only
-     * This option can help to protect leaked internal types
-     * @default true
-     */
-    readonly explicitPublic?: boolean;
-    /**
-     * By default, generator use description jsdoc-tag
-     * If this option is true, then generator will use fallback description from type comment
-     */
-    readonly allowUseFallbackDescription?: boolean;
-    /**
-     * Filter for definitions
-     * Important: dependencies will not be filtered
-     */
-    readonly definitionsFilter?: (name: string) => boolean;
-    /**
-     * Create shared $ref definitions for all types
-     *
-     * Or: Do not create shared $ref definitions
-     * Or: (default) Create shared $ref definitions only for exported types (not tagged as `@internal`)
-     */
-    readonly expose?: TypeExposeKind;
-}

package/lib/generator.d.ts

@@ -1,5 +0,0 @@
-import { SchemaObject } from 'ajv';
-import { SchemaForgeOptions, SchemaForgeResult } from './types';
-export declare function forgeSchema(options: SchemaForgeOptions): Promise<SchemaForgeResult>;
-export declare function loadJSONSchema(files: string[]): Promise<SchemaObject[]>;
-export declare function loadJSONSchemaSync(files: string[]): SchemaObject[];

package/lib/generator.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/index.d.ts

@@ -1,7 +0,0 @@
-import '@total-typescript/ts-reset';
-import { SchemaDefinitionInfo, SchemaForgeDefinitionRef, SchemaForgeSignatureSuffix } from './types';
-export declare function buildAPIInterfaceSchemaSignature(interfaceName: string): string;
-export declare function buildAPIInterfaceSchemaSignature(interfaceName: string, memberName: string): string;
-export declare function buildAPIInterfaceSchemaSignature(interfaceName: string, methodName: string, suffix: SchemaForgeSignatureSuffix): string;
-export declare function buildSchemaDefinitionRef(definitionName: string, schemaId: string | undefined): SchemaForgeDefinitionRef;
-export declare function parseSchemaDefinitionInfo(name: string, schemaId: string): SchemaDefinitionInfo;

package/lib/index.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildAPIInterfaceSchemaSignature = buildAPIInterfaceSchemaSignature;
-exports.buildSchemaDefinitionRef = buildSchemaDefinitionRef;
-exports.parseSchemaDefinitionInfo = parseSchemaDefinitionInfo;
-require("@total-typescript/ts-reset");
-const substr_1 = require("@tsofist/stem/lib/string/substr");
-const types_1 = require("./types");
-const N_I = '_InterfaceDeclaration';
-const N_A = '_Args';
-const N_R = '_Result';
-function buildAPIInterfaceSchemaSignature(interfaceName, memberName, suffix) {
-    let result = `${interfaceName}${memberName ? `_${memberName}` : N_I}`;
-    switch (suffix) {
-        case types_1.SchemaForgeSignatureSuffix.MethodArguments:
-            result += N_A;
-            break;
-        case types_1.SchemaForgeSignatureSuffix.MethodResult:
-            result += N_R;
-            break;
-    }
-    return result;
-}
-function buildSchemaDefinitionRef(definitionName, schemaId) {
-    return `${schemaId || ''}#/definitions/${definitionName}`;
-}
-function parseSchemaDefinitionInfo(name, schemaId) {
-    const kind = name.endsWith(N_I)
-        ? types_1.SchemaDefinitionKind.API
-        : name.endsWith(N_A)
-            ? types_1.SchemaDefinitionKind.APIMethodArguments
-            : name.endsWith(N_R)
-                ? types_1.SchemaDefinitionKind.APIMethodResult
-                : types_1.SchemaDefinitionKind.Type;
-    const ref = buildSchemaDefinitionRef(name, schemaId);
-    switch (kind) {
-        case types_1.SchemaDefinitionKind.API:
-            return {
-                ref,
-                kind,
-                name,
-                schemaId,
-                interface: (0, substr_1.substr)(name, 0, N_I),
-            };
-        case types_1.SchemaDefinitionKind.APIMethodArguments:
-        case types_1.SchemaDefinitionKind.APIMethodResult:
-            return {
-                ref,
-                kind,
-                name,
-                schemaId,
-                interface: (0, substr_1.substr)(name, 0, '_'),
-                method: (0, substr_1.substr)(name, '_', '_'),
-            };
-        case types_1.SchemaDefinitionKind.Type:
-            return {
-                ref,
-                kind,
-                name,
-                schemaId,
-                type: name,
-            };
-    }
-}