@tsofist/schema-forge 1.33.0 → 2.0.0

package/LICENSE

@@ -1,21 +1,167 @@
-The MIT License (MIT)
-
 Copyright (c) 2024-present, Andrew Berdnikov
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -18,3 +18,7 @@ Main idea is to create type descriptions by whose schemes in the future it will
 ## Validator
  
 todo
+
+
+#### License
+This project is licensed under the **LGPL-3.0** License – see the [LICENSE](LICENSE) file for details.

package/lib/fake-generator.js

@@ -4,6 +4,8 @@ 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");
@@ -33,9 +35,6 @@ function createFakeGeneratorHost(source, options = {}) {
             ...options,
             resolveJsonPath: false,
         });
-        generator.format('iso-time', () => {
-            return (0, substr_1.substr)(faker.date.anytime(), 'T', '.');
-        });
         return {
             rebuild,
             generator,
@@ -81,6 +80,32 @@ const EmbeddedModules = [
                 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) {

package/lib/fake-generator.spec.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const guards_1 = require("@tsofist/stem/lib/number/guards");
+const guards_1 = require("@tsofist/stem/lib/cldr/date-time/guards");
+const types_1 = require("@tsofist/stem/lib/cldr/date-time/types");
+const enum_1 = require("@tsofist/stem/lib/enum");
+const guards_2 = require("@tsofist/stem/lib/number/guards");
+const entries_1 = require("@tsofist/stem/lib/object/entries");
+const camel_1 = require("@tsofist/stem/lib/string/case/camel");
 const fake_generator_1 = require("./fake-generator");
 const validator_1 = require("./validator");
 /* eslint-disable @typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-argument */
@@ -122,7 +127,7 @@ describe('generateFakeData', () => {
                     },
                     time: {
                         type: 'string',
-                        format: 'iso-time',
+                        faker: 'cldr.localTime',
                     },
                     refs: {
                         type: 'object',
@@ -156,16 +161,35 @@ describe('generateFakeData', () => {
             },
         },
     };
+    const testSchema4 = {
+        $schema: 'http://json-schema.org/draft-07/schema#',
+        $id: 'test-4',
+        definitions: {
+            CLDR: {
+                type: 'object',
+                properties: {},
+            },
+        },
+    };
+    {
+        for (const name of (0, enum_1.extractEnumKeys)(types_1.ISODateTimeType)) {
+            const method = (0, camel_1.camelCase)(name);
+            testSchema4.definitions.CLDR.properties[name] = {
+                type: 'string',
+                faker: `cldr.${method}`,
+            };
+        }
+    }
     let validator;
     beforeEach(() => {
-        validator = (0, validator_1.createSchemaForgeValidator)({ schemas: [testSchema1, testSchema2, testSchema3] }, true);
+        validator = (0, validator_1.createSchemaForgeValidator)({ schemas: [testSchema1, testSchema2, testSchema3, testSchema4] }, true);
     });
     it('default behavior', async () => {
         {
             const data = await (0, fake_generator_1.generateFakeData)(validator, 'test-1#/definitions/Int');
             expect(data).toBeDefined();
             expect(data).toBeGreaterThanOrEqual(0);
-            expect((0, guards_1.isInt)(data)).toStrictEqual(true);
+            expect((0, guards_2.isInt)(data)).toStrictEqual(true);
         }
         {
             const data = await (0, fake_generator_1.generateFakeData)(validator, 'test-2#/definitions/Url');
@@ -178,7 +202,7 @@ describe('generateFakeData', () => {
         const data = await (0, fake_generator_1.generateFakeData)(validator, source);
         expect(data).toBeDefined();
         expect(data).toBeGreaterThanOrEqual(0);
-        expect((0, guards_1.isInt)(data)).toStrictEqual(true);
+        expect((0, guards_2.isInt)(data)).toStrictEqual(true);
         expect(validator.validateBySchema(source, data).valid).toStrictEqual(true);
     });
     it('complex, nested data should be handled correctly', async () => {
@@ -234,4 +258,21 @@ describe('generateFakeData', () => {
             expect(validator.validateBySchema(source, data).valid).toStrictEqual(true);
         }
     });
+    it('should handle CLDR formats', async () => {
+        const data = await (0, fake_generator_1.generateFakeData)(validator, 'test-4#/definitions/CLDR');
+        const guards = {
+            [types_1.ISODateTimeType.LocalDate]: guards_1.isLocalISODateString,
+            [types_1.ISODateTimeType.LocalTime]: guards_1.isLocalISOTimeString,
+            [types_1.ISODateTimeType.LocalDateTime]: guards_1.isLocalISODateTimeString,
+            [types_1.ISODateTimeType.ZuluDate]: guards_1.isZuluISODateString,
+            [types_1.ISODateTimeType.ZuluTime]: guards_1.isZuluISOTimeString,
+            [types_1.ISODateTimeType.ZuluDateTime]: guards_1.isZuluISODateTimeString,
+        };
+        expect(data).toBeDefined();
+        for (const [name, value] of (0, entries_1.entries)(data)) {
+            const g = guards[types_1.ISODateTimeType[name]];
+            expect(g).toBeDefined();
+            expect(g(value)).toStrictEqual(true);
+        }
+    });
 });

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,9 +1,9 @@
 {
   "name": "@tsofist/schema-forge",
-  "version": "1.33.0",
+  "version": "2.0.0",
   "description": "Generate JSON schema from TypeScript types",
   "author": "Andrew Berdnikov <tsofistgudmen@gmail.com>",
-  "license": "MIT",
+  "license": "LGPL-3.0",
   "main": "lib/types",
   "types": "lib/types",
   "type": "commonjs",
@@ -20,8 +20,8 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@faker-js/faker": "^9.2.0",
-    "@tsofist/stem": "^1.44.1",
+    "@faker-js/faker": "^9.4.0",
+    "@tsofist/stem": "^2.0.0",
     "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.17",
     "@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.3"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",