@tsofist/schema-forge 1.33.0 → 1.34.0

package/lib/generator/types-generator.js

@@ -162,7 +162,7 @@ function processAPIInterfaceDeclaration(statement, context) {
     const interfaceDesc = (0, tsc_1.readJSDocDescription)(statement, allowUseFallbackDescription);
     const interfaceDeprecated = (0, typescript_1.getTextOfJSDocComment)((0, typescript_1.getJSDocDeprecatedTag)(statement)?.comment);
     function onSignature(method, memberName, memberDescription, deprecated) {
-        const minArgsNum = method.parameters.filter((param) => !param.questionToken).length;
+        const minArgsNum = countRequiredParams(method.parameters);
         const maxArgsNum = method.parameters.length;
         const argsNames = [];
         const argsTypesText = method.parameters
@@ -199,7 +199,7 @@ function processAPIInterfaceDeclaration(statement, context) {
             ` * @description Arguments for ${comment} ${argsNames.length ? `(${argsNamesText})` : ''}`,
             ` * @comment ${comment}`,
             ` *`,
-            minArgsNum > 0 ? ` * @minItems ${minArgsNum}` : ` *`,
+            ` * @minItems ${minArgsNum}`,
             ` * @maxItems ${maxArgsNum}`,
             ` */`,
             `export type ${definitionNameArgs} = readonly [\n${argsTypesText}\n];`,
@@ -290,3 +290,14 @@ function processAPIInterfaceDeclaration(statement, context) {
         context.fileContent.push(interfaceText.stringify('\n'));
     }
 }
+function countRequiredParams(params) {
+    let result = 0;
+    for (const param of params) {
+        if (param.questionToken != null)
+            break;
+        if (param.dotDotDotToken != null)
+            (0, error_1.raise)('Rest arguments are not supported yet');
+        result++;
+    }
+    return result;
+}

package/lib/generator.spec.js

@@ -276,6 +276,38 @@ describe('generator for a3', () => {
         expect(props.propWithGeneric).toBeTruthy();
         expect(props.propWithGeneric.$ref).toStrictEqual('#/definitions/NonEmptyString');
     });
+    it('optional args in API methods should works', () => {
+        {
+            const props = forgeSchemaResult.schema.definitions?.API_methodG0_Args;
+            expect(props).toBeTruthy();
+            expect(props.minItems).toStrictEqual(0);
+            expect(props.maxItems).toStrictEqual(1);
+        }
+        {
+            const props = forgeSchemaResult.schema.definitions?.API_methodG1_Args;
+            expect(props).toBeTruthy();
+            expect(props.minItems).toStrictEqual(0);
+            expect(props.maxItems).toStrictEqual(2);
+        }
+        {
+            const props = forgeSchemaResult.schema.definitions?.API_methodG2_Args;
+            expect(props).toBeTruthy();
+            expect(props.minItems).toStrictEqual(1);
+            expect(props.maxItems).toStrictEqual(2);
+        }
+        // {
+        //     const props = forgeSchemaResult!.schema.definitions?.API_methodG3_Args;
+        //     expect(props).toBeTruthy();
+        //     expect(props.minItems).toStrictEqual(0);
+        //     expect(props.maxItems).toBeUndefined();
+        // }
+        // {
+        //     const props = forgeSchemaResult!.schema.definitions?.API_methodG4_Args;
+        //     expect(props).toBeTruthy();
+        //     expect(props.minItems).toStrictEqual(1);
+        //     expect(props.maxItems).toBeUndefined();
+        // }
+    });
     it('extends should works', () => {
         const props = forgeSchemaResult.schema.definitions?.BAPI_InterfaceDeclaration.properties;
         expect(props).toBeTruthy();
@@ -290,6 +322,9 @@ describe('generator for a3', () => {
             'methodE1',
             'methodE2',
             'methodF',
+            'methodG0',
+            'methodG1',
+            'methodG2',
             'methodY',
         ]);
     });

package/lib/validator.d.ts

@@ -4,7 +4,22 @@ import { SchemaDefinitionInfo, SchemaForgeDefinitionRef, SchemaForgeValidationCo
 export type SchemaForgeValidator = ReturnType<typeof createSchemaForgeValidator>;
 export declare function createSchemaForgeValidator(engineOptions?: Options, useAdditionalFormats?: boolean): {
     readonly rev: number;
-    clone: (options?: Omit<Options, "schemas">, onSchema?: (value: SchemaObject) => SchemaObject) => any;
+    clone: (options?: Omit<Options, "schemas">, onSchema?: (value: SchemaObject) => SchemaObject) => {
+        readonly rev: number;
+        clone: /*elided*/ any;
+        removeSchema: (schemaIdentity?: AnySchema | SchemaForgeDefinitionRef | RegExp) => void;
+        hasValidator: (ref: SchemaForgeDefinitionRef) => boolean;
+        getValidator: <TData = unknown>(ref: SchemaForgeDefinitionRef | AnySchema) => SchemaForgeValidationFunction<TData> | undefined;
+        getSchema: (ref: SchemaForgeDefinitionRef) => AnySchema | undefined;
+        getRootSchema: (schemaId: string) => (SchemaObject & {
+            definitions?: AnySchema;
+        }) | undefined;
+        addSchema: (schema: Schema[]) => void;
+        validateBySchema: (ref: SchemaForgeDefinitionRef, data: unknown, instancePath?: string) => SchemaForgeValidationResult;
+        checkBySchema: <T = unknown, Ctx extends SchemaForgeValidationContextBase = SchemaForgeValidationContextBase>(ref: SchemaForgeDefinitionRef, data: unknown, context?: Ctx) => data is T;
+        validationErrorsText: (errors: Nullable<SchemaForgeValidationReport>, options?: ErrorsTextOptions) => string;
+        listDefinitions: (predicate?: (info: SchemaDefinitionInfo) => boolean) => SchemaDefinitionInfo[];
+    };
     removeSchema: (schemaIdentity?: AnySchema | SchemaForgeDefinitionRef | RegExp) => void;
     hasValidator: (ref: SchemaForgeDefinitionRef) => boolean;
     getValidator: <TData = unknown>(ref: SchemaForgeDefinitionRef | AnySchema) => SchemaForgeValidationFunction<TData> | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsofist/schema-forge",
-  "version": "1.33.0",
+  "version": "1.34.0",
   "description": "Generate JSON schema from TypeScript types",
   "author": "Andrew Berdnikov <tsofistgudmen@gmail.com>",
   "license": "MIT",
@@ -20,8 +20,8 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@faker-js/faker": "^9.2.0",
-    "@tsofist/stem": "^1.44.1",
+    "@faker-js/faker": "^9.3.0",
+    "@tsofist/stem": "^1.45.1",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
     "json-schema-faker": "^0.5.8",
@@ -29,15 +29,15 @@
     "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "@tsofist/web-buddy": "^1.20.1",
+    "@tsofist/web-buddy": "^1.21.0",
     "@types/jest": "^29.5.14",
-    "@types/node": "^20.17.8",
+    "@types/node": "^20.17.10",
     "@types/supertest": "^6.0.2",
     "jest": "^29.7.0",
     "rimraf": "^6.0.1",
     "supertest": "^7.0.0",
     "ts-jest": "^29.2.5",
-    "typescript": "~5.6.3"
+    "typescript": "~5.7.2"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",