@tsofist/schema-forge 1.0.0

package/lib/generator.spec.js

@@ -0,0 +1,211 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const promises_1 = require("node:fs/promises");
+const error_1 = require("@tsofist/stem/lib/error");
+const noop_1 = require("@tsofist/stem/lib/noop");
+const generator_1 = require("./generator");
+const types_1 = require("./types");
+const validator_1 = require("./validator");
+describe('generator for a3', () => {
+    const outputSchemaFile = './a3.generated.schema.tmp.json';
+    const outputDefinitionsFile = './a3.generated.definitions.tmp.json';
+    let forgeSchemaResult;
+    beforeAll(() => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        forgeSchemaResult = yield (0, generator_1.forgeSchema)({
+            tsconfigFrom: './tsconfig.build.json',
+            sourcesDirectoryPattern: 'test-sources/a3',
+            sourcesFilesPattern: 'service-api.ts',
+            outputSchemaFile,
+            outputDefinitionsFile,
+        });
+    }));
+    afterAll(() => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        yield (0, promises_1.unlink)(outputSchemaFile).catch(noop_1.noop);
+        yield (0, promises_1.unlink)(outputDefinitionsFile).catch(noop_1.noop);
+    }));
+    it('generated schema should be valid', () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        expect(forgeSchemaResult).toBeTruthy();
+    }));
+});
+describe('generator for a2', () => {
+    const outputSchemaFile = './a2.generated.schema.tmp.json';
+    const outputDefinitionsFile = './a2.generated.definitions.tmp.json';
+    let forgeSchemaResult;
+    beforeAll(() => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        forgeSchemaResult = yield (0, generator_1.forgeSchema)({
+            tsconfigFrom: './tsconfig.build.json',
+            sourcesDirectoryPattern: 'test-sources/a2',
+            sourcesFilesPattern: 'service-api.ts',
+            outputSchemaFile,
+            outputDefinitionsFile,
+        });
+    }));
+    afterAll(() => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        yield (0, promises_1.unlink)(outputSchemaFile).catch(noop_1.noop);
+        yield (0, promises_1.unlink)(outputDefinitionsFile).catch(noop_1.noop);
+    }));
+    it('generated schema should be valid', () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        expect(forgeSchemaResult).toBeTruthy();
+    }));
+});
+describe('generator for a1', () => {
+    const outputSchemaFile = './a1.generated.schema.tmp.json';
+    const outputDefinitionsFile = './a1.generated.definitions.tmp.json';
+    const schemaId = 'test';
+    let forgeSchemaResult;
+    let validator;
+    beforeAll(() => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        forgeSchemaResult = yield (0, generator_1.forgeSchema)({
+            allowUseFallbackDescription: false,
+            explicitPublic: true,
+            schemaId,
+            tsconfigFrom: './tsconfig.build.json',
+            sourcesDirectoryPattern: 'test-sources/a1',
+            sourcesFilesPattern: 'service.api.ts',
+            outputSchemaFile,
+            outputDefinitionsFile,
+        });
+        validator = (0, validator_1.createSchemaForgeValidator)({}, true);
+        const schema = yield (0, generator_1.loadJSONSchema)([outputSchemaFile]);
+        validator.addSchema(schema);
+    }), 10000);
+    afterAll(() => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        yield (0, promises_1.unlink)(outputSchemaFile).catch(noop_1.noop);
+        yield (0, promises_1.unlink)(outputDefinitionsFile).catch(noop_1.noop);
+    }));
+    it('generated schema should be valid', () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        expect(forgeSchemaResult).toBeTruthy();
+        expect(forgeSchemaResult.schema.$id).toStrictEqual(schemaId);
+        expect(forgeSchemaResult.generatedFiles.length).toStrictEqual(1);
+        expect(forgeSchemaResult.refs.length).toStrictEqual(8);
+    }));
+    it('getSchema', () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        expect(validator.getValidator('test#/definitions/Int').schema).toMatchObject({
+            type: 'integer',
+        });
+        expect(validator.getValidator('#/definitions/NotExists')).toStrictEqual(undefined);
+    }));
+    it('hasSchema', () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        expect(validator.hasValidator('test#/definitions/Int')).toStrictEqual(true);
+        expect(validator.hasValidator('test#/definitions/!Int')).toStrictEqual(false);
+    }));
+    it('checkBySchema', () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        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);
+        {
+            const schema = '!test#/definitions/Int';
+            try {
+                validator.checkBySchema(schema, 1.1);
+            }
+            catch (e) {
+                const context = (0, error_1.readErrorContext)(e);
+                const code = (0, error_1.readErrorCode)(e);
+                expect(e.message).toStrictEqual(types_1.SchemaNotFoundErrorCode);
+                expect(code).toStrictEqual(types_1.SchemaNotFoundErrorCode);
+                expect(context).toBeTruthy();
+                expect(context.schema).toStrictEqual(schema);
+                expect(context.errorMessage).toStrictEqual(undefined);
+            }
+        }
+        {
+            const schema = 'test#/definitions/Int';
+            const message = 'ERROR!';
+            try {
+                validator.checkBySchema(schema, 1.1, { errorMessage: message });
+            }
+            catch (e) {
+                const context = (0, error_1.readErrorContext)(e);
+                const code = (0, error_1.readErrorCode)(e);
+                expect(e.message).toStrictEqual(message);
+                expect(code).toStrictEqual(types_1.SchemaForgeValidationErrorCode);
+                expect(context).toBeTruthy();
+                expect(context.schema).toStrictEqual(schema);
+                expect(context.errorMessage).toStrictEqual(message);
+                expect(context.errors.length).toStrictEqual(1);
+            }
+        }
+    }));
+    it('listDefinitions', () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        const defs = [
+            {
+                kind: 1,
+                name: 'ExportedInterfaceB_InterfaceDeclaration',
+                schema: 'test',
+                interface: 'ExportedInterfaceB',
+            },
+            {
+                kind: 3,
+                name: 'ExportedInterfaceB_methodA_Args',
+                schema: 'test',
+                interface: 'ExportedInterfaceB',
+                method: 'methodA',
+            },
+            {
+                kind: 2,
+                name: 'ExportedInterfaceB_methodA_Result',
+                schema: 'test',
+                interface: 'ExportedInterfaceB',
+                method: 'methodA',
+            },
+            {
+                kind: 3,
+                name: 'ExportedInterfaceB_methodB_Args',
+                schema: 'test',
+                interface: 'ExportedInterfaceB',
+                method: 'methodB',
+            },
+            {
+                kind: 2,
+                name: 'ExportedInterfaceB_methodB_Result',
+                schema: 'test',
+                interface: 'ExportedInterfaceB',
+                method: 'methodB',
+            },
+            { kind: 0, name: 'Int', schema: 'test', type: 'Int' },
+            {
+                kind: 1,
+                name: 'NonExportedInterfaceD_InterfaceDeclaration',
+                schema: 'test',
+                interface: 'NonExportedInterfaceD',
+            },
+            {
+                kind: 3,
+                name: 'NonExportedInterfaceD_methodA_Args',
+                schema: 'test',
+                interface: 'NonExportedInterfaceD',
+                method: 'methodA',
+            },
+            {
+                kind: 2,
+                name: 'NonExportedInterfaceD_methodA_Result',
+                schema: 'test',
+                interface: 'NonExportedInterfaceD',
+                method: 'methodA',
+            },
+            { kind: 0, name: 'PositiveInt', schema: 'test', type: 'PositiveInt' },
+        ];
+        const defsByName = {};
+        for (const def of defs) {
+            defsByName[def.name] = def;
+        }
+        expect(validator.listDefinitions()).toStrictEqual(defs);
+        expect(validator.listDefinitions((info) => info.kind === types_1.SchemaDefinitionKind.Type)).toStrictEqual([defsByName['Int'], defsByName['PositiveInt']]);
+        expect(validator.listDefinitions((info) => info.kind === types_1.SchemaDefinitionKind.Interface)).toStrictEqual([
+            defsByName['ExportedInterfaceB_InterfaceDeclaration'],
+            defsByName['NonExportedInterfaceD_InterfaceDeclaration'],
+        ]);
+        expect(validator.listDefinitions((info) => info.kind === types_1.SchemaDefinitionKind.InterfaceMethodResult)).toStrictEqual([
+            defsByName['ExportedInterfaceB_methodA_Result'],
+            defsByName['ExportedInterfaceB_methodB_Result'],
+            defsByName['NonExportedInterfaceD_methodA_Result'],
+        ]);
+        expect(validator.listDefinitions((info) => info.kind === types_1.SchemaDefinitionKind.InterfaceMethodArguments)).toStrictEqual([
+            defsByName['ExportedInterfaceB_methodA_Args'],
+            defsByName['ExportedInterfaceB_methodB_Args'],
+            defsByName['NonExportedInterfaceD_methodA_Args'],
+        ]);
+    }));
+});
+//# sourceMappingURL=generator.spec.js.map

package/lib/generator.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.spec.js","sourceRoot":"","sources":["../src/generator.spec.ts"],"names":[],"mappings":";;;AAAA,+CAA0C;AAC1C,mDAA0E;AAC1E,iDAA8C;AAC9C,2CAA0D;AAC1D,mCAQiB;AACjB,2CAAyD;AAEzD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAC9B,MAAM,gBAAgB,GAAG,gCAAgC,CAAC;IAC1D,MAAM,qBAAqB,GAAG,qCAAqC,CAAC;IAEpE,IAAI,iBAAgD,CAAC;IAErD,SAAS,CAAC,GAAS,EAAE;QACjB,iBAAiB,GAAG,MAAM,IAAA,uBAAW,EAAC;YAClC,YAAY,EAAE,uBAAuB;YACrC,uBAAuB,EAAE,iBAAiB;YAC1C,mBAAmB,EAAE,gBAAgB;YACrC,gBAAgB;YAChB,qBAAqB;SACxB,CAAC,CAAC;IACP,CAAC,CAAA,CAAC,CAAC;IACH,QAAQ,CAAC,GAAS,EAAE;QAChB,MAAM,IAAA,iBAAM,EAAC,gBAAgB,CAAC,CAAC,KAAK,CAAC,WAAI,CAAC,CAAC;QAC3C,MAAM,IAAA,iBAAM,EAAC,qBAAqB,CAAC,CAAC,KAAK,CAAC,WAAI,CAAC,CAAC;IACpD,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAS,EAAE;QAC9C,MAAM,CAAC,iBAAiB,CAAC,CAAC,UAAU,EAAE,CAAC;IAC3C,CAAC,CAAA,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AACH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAC9B,MAAM,gBAAgB,GAAG,gCAAgC,CAAC;IAC1D,MAAM,qBAAqB,GAAG,qCAAqC,CAAC;IAEpE,IAAI,iBAAgD,CAAC;IAErD,SAAS,CAAC,GAAS,EAAE;QACjB,iBAAiB,GAAG,MAAM,IAAA,uBAAW,EAAC;YAClC,YAAY,EAAE,uBAAuB;YACrC,uBAAuB,EAAE,iBAAiB;YAC1C,mBAAmB,EAAE,gBAAgB;YACrC,gBAAgB;YAChB,qBAAqB;SACxB,CAAC,CAAC;IACP,CAAC,CAAA,CAAC,CAAC;IACH,QAAQ,CAAC,GAAS,EAAE;QAChB,MAAM,IAAA,iBAAM,EAAC,gBAAgB,CAAC,CAAC,KAAK,CAAC,WAAI,CAAC,CAAC;QAC3C,MAAM,IAAA,iBAAM,EAAC,qBAAqB,CAAC,CAAC,KAAK,CAAC,WAAI,CAAC,CAAC;IACpD,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAS,EAAE;QAC9C,MAAM,CAAC,iBAAiB,CAAC,CAAC,UAAU,EAAE,CAAC;IAC3C,CAAC,CAAA,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAC9B,MAAM,gBAAgB,GAAG,gCAAgC,CAAC;IAC1D,MAAM,qBAAqB,GAAG,qCAAqC,CAAC;IACpE,MAAM,QAAQ,GAAG,MAAM,CAAC;IAExB,IAAI,iBAAgD,CAAC;IACrD,IAAI,SAAwD,CAAC;IAE7D,SAAS,CAAC,GAAS,EAAE;QACjB,iBAAiB,GAAG,MAAM,IAAA,uBAAW,EAAC;YAClC,2BAA2B,EAAE,KAAK;YAClC,cAAc,EAAE,IAAI;YAEpB,QAAQ;YACR,YAAY,EAAE,uBAAuB;YACrC,uBAAuB,EAAE,iBAAiB;YAC1C,mBAAmB,EAAE,gBAAgB;YACrC,gBAAgB;YAChB,qBAAqB;SACxB,CAAC,CAAC;QACH,SAAS,GAAG,IAAA,sCAA0B,EAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,MAAM,IAAA,0BAAc,EAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC;QACxD,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC,CAAA,EAAE,KAAM,CAAC,CAAC;IAEX,QAAQ,CAAC,GAAS,EAAE;QAChB,MAAM,IAAA,iBAAM,EAAC,gBAAgB,CAAC,CAAC,KAAK,CAAC,WAAI,CAAC,CAAC;QAC3C,MAAM,IAAA,iBAAM,EAAC,qBAAqB,CAAC,CAAC,KAAK,CAAC,WAAI,CAAC,CAAC;IACpD,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAS,EAAE;QAC9C,MAAM,CAAC,iBAAiB,CAAC,CAAC,UAAU,EAAE,CAAC;QACvC,MAAM,CAAC,iBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAC9D,MAAM,CAAC,iBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAClE,MAAM,CAAC,iBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAC5D,CAAC,CAAA,CAAC,CAAC;IACH,EAAE,CAAC,WAAW,EAAE,GAAS,EAAE;QACvB,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,uBAAuB,CAAE,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YAC1E,IAAI,EAAE,SAAS;SAClB,CAAC,CAAC;QACH,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,yBAAyB,CAAC,CAAC,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IACvF,CAAC,CAAA,CAAC,CAAC;IACH,EAAE,CAAC,WAAW,EAAE,GAAS,EAAE;QACvB,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,uBAAuB,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC5E,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,wBAAwB,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAClF,CAAC,CAAA,CAAC,CAAC;IACH,EAAE,CAAC,eAAe,EAAE,GAAS,EAAE;QAC3B,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAChF,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,aAAa,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CACvE,sCAA8B,CACjC,CAAC;QACF,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,aAAa,CAAC,wBAAwB,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CACtE,+BAAuB,CAC1B,CAAC;QAEF,CAAC;YACG,MAAM,MAAM,GAAG,wBAAwB,CAAC;YACxC,IAAI,CAAC;gBACD,SAAS,CAAC,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YACzC,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBACd,MAAM,OAAO,GAAG,IAAA,wBAAgB,EAA6B,CAAC,CAAC,CAAC;gBAChE,MAAM,IAAI,GAAG,IAAA,qBAAa,EAAC,CAAC,CAAC,CAAC;gBAE9B,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,+BAAuB,CAAC,CAAC;gBACzD,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,+BAAuB,CAAC,CAAC;gBACpD,MAAM,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,CAAC;gBAC7B,MAAM,CAAC,OAAQ,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBAC9C,MAAM,CAAC,OAAQ,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;YAC3D,CAAC;QACL,CAAC;QAED,CAAC;YACG,MAAM,MAAM,GAAG,uBAAuB,CAAC;YACvC,MAAM,OAAO,GAAG,QAAQ,CAAC;YACzB,IAAI,CAAC;gBACD,SAAS,CAAC,aAAa,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;YACpE,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBACd,MAAM,OAAO,GAAG,IAAA,wBAAgB,EAAoC,CAAC,CAAC,CAAC;gBACvE,MAAM,IAAI,GAAG,IAAA,qBAAa,EAAC,CAAC,CAAC,CAAC;gBAE9B,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACzC,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,sCAA8B,CAAC,CAAC;gBAC3D,MAAM,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,CAAC;gBAC7B,MAAM,CAAC,OAAQ,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBAC9C,MAAM,CAAC,OAAQ,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACrD,MAAM,CAAC,OAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;YACpD,CAAC;QACL,CAAC;IACL,CAAC,CAAA,CAAC,CAAC;IACH,EAAE,CAAC,iBAAiB,EAAE,GAAS,EAAE;QAC7B,MAAM,IAAI,GAA2B;YACjC;gBACI,IAAI,EAAE,CAAC;gBACP,IAAI,EAAE,yCAAyC;gBAC/C,MAAM,EAAE,MAAM;gBACd,SAAS,EAAE,oBAAoB;aAClC;YACD;gBACI,IAAI,EAAE,CAAC;gBACP,IAAI,EAAE,iCAAiC;gBACvC,MAAM,EAAE,MAAM;gBACd,SAAS,EAAE,oBAAoB;gBAC/B,MAAM,EAAE,SAAS;aACpB;YACD;gBACI,IAAI,EAAE,CAAC;gBACP,IAAI,EAAE,mCAAmC;gBACzC,MAAM,EAAE,MAAM;gBACd,SAAS,EAAE,oBAAoB;gBAC/B,MAAM,EAAE,SAAS;aACpB;YACD;gBACI,IAAI,EAAE,CAAC;gBACP,IAAI,EAAE,iCAAiC;gBACvC,MAAM,EAAE,MAAM;gBACd,SAAS,EAAE,oBAAoB;gBAC/B,MAAM,EAAE,SAAS;aACpB;YACD;gBACI,IAAI,EAAE,CAAC;gBACP,IAAI,EAAE,mCAAmC;gBACzC,MAAM,EAAE,MAAM;gBACd,SAAS,EAAE,oBAAoB;gBAC/B,MAAM,EAAE,SAAS;aACpB;YACD,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE;YACrD;gBACI,IAAI,EAAE,CAAC;gBACP,IAAI,EAAE,4CAA4C;gBAClD,MAAM,EAAE,MAAM;gBACd,SAAS,EAAE,uBAAuB;aACrC;YACD;gBACI,IAAI,EAAE,CAAC;gBACP,IAAI,EAAE,oCAAoC;gBAC1C,MAAM,EAAE,MAAM;gBACd,SAAS,EAAE,uBAAuB;gBAClC,MAAM,EAAE,SAAS;aACpB;YACD;gBACI,IAAI,EAAE,CAAC;gBACP,IAAI,EAAE,sCAAsC;gBAC5C,MAAM,EAAE,MAAM;gBACd,SAAS,EAAE,uBAAuB;gBAClC,MAAM,EAAE,SAAS;aACpB;YACD,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE;SACxE,CAAC;QACF,MAAM,UAAU,GAAQ,EAAE,CAAC;QAC3B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACrB,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;QAC/B,CAAC;QACD,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAExD,MAAM,CACF,SAAS,CAAC,eAAe,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,4BAAoB,CAAC,IAAI,CAAC,CAC/E,CAAC,aAAa,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAEhE,MAAM,CACF,SAAS,CAAC,eAAe,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,4BAAoB,CAAC,SAAS,CAAC,CACpF,CAAC,aAAa,CAAC;YACZ,UAAU,CAAC,yCAAyC,CAAC;YACrD,UAAU,CAAC,4CAA4C,CAAC;SAC3D,CAAC,CAAC;QAEH,MAAM,CACF,SAAS,CAAC,eAAe,CACrB,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,4BAAoB,CAAC,qBAAqB,CACrE,CACJ,CAAC,aAAa,CAAC;YACZ,UAAU,CAAC,mCAAmC,CAAC;YAC/C,UAAU,CAAC,mCAAmC,CAAC;YAC/C,UAAU,CAAC,sCAAsC,CAAC;SACrD,CAAC,CAAC;QAEH,MAAM,CACF,SAAS,CAAC,eAAe,CACrB,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,4BAAoB,CAAC,wBAAwB,CACxE,CACJ,CAAC,aAAa,CAAC;YACZ,UAAU,CAAC,iCAAiC,CAAC;YAC7C,UAAU,CAAC,iCAAiC,CAAC;YAC7C,UAAU,CAAC,oCAAoC,CAAC;SACnD,CAAC,CAAC;IACP,CAAC,CAAA,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+import { SchemaDefinitionInfo, SchemaForgeSignatureSuffix } from './types';
+export declare function buildInterfaceSchemaSignature(interfaceName: string): string;
+export declare function buildInterfaceSchemaSignature(interfaceName: string, memberName: string): string;
+export declare function buildInterfaceSchemaSignature(interfaceName: string, methodName: string, suffix: SchemaForgeSignatureSuffix): string;
+export declare function parseSchemaDefinitionInfo(name: string, schema: string): SchemaDefinitionInfo;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAwB,0BAA0B,EAAE,MAAM,SAAS,CAAC;AAMjG,wBAAgB,6BAA6B,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,CAAC;AAC7E,wBAAgB,6BAA6B,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;AACjG,wBAAgB,6BAA6B,CACzC,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,0BAA0B,GACnC,MAAM,CAAC;AAkBV,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,oBAAoB,CAiC5F"}

package/lib/index.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseSchemaDefinitionInfo = exports.buildInterfaceSchemaSignature = void 0;
+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 buildInterfaceSchemaSignature(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;
+}
+exports.buildInterfaceSchemaSignature = buildInterfaceSchemaSignature;
+function parseSchemaDefinitionInfo(name, schema) {
+    const kind = name.endsWith(N_I)
+        ? types_1.SchemaDefinitionKind.Interface
+        : name.endsWith(N_A)
+            ? types_1.SchemaDefinitionKind.InterfaceMethodArguments
+            : name.endsWith(N_R)
+                ? types_1.SchemaDefinitionKind.InterfaceMethodResult
+                : types_1.SchemaDefinitionKind.Type;
+    switch (kind) {
+        case types_1.SchemaDefinitionKind.Interface:
+            return {
+                kind,
+                name,
+                schema,
+                interface: (0, substr_1.substr)(name, 0, N_I),
+            };
+        case types_1.SchemaDefinitionKind.InterfaceMethodArguments:
+        case types_1.SchemaDefinitionKind.InterfaceMethodResult:
+            return {
+                kind,
+                name,
+                schema,
+                interface: (0, substr_1.substr)(name, 0, '_'),
+                method: (0, substr_1.substr)(name, '_', '_'),
+            };
+        case types_1.SchemaDefinitionKind.Type:
+            return {
+                kind,
+                name,
+                schema,
+                type: name,
+            };
+    }
+}
+exports.parseSchemaDefinitionInfo = parseSchemaDefinitionInfo;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,4DAAyD;AACzD,mCAAiG;AAEjG,MAAM,GAAG,GAAG,uBAAuB,CAAC;AACpC,MAAM,GAAG,GAAG,OAAO,CAAC;AACpB,MAAM,GAAG,GAAG,SAAS,CAAC;AAStB,SAAgB,6BAA6B,CACzC,aAAqB,EACrB,UAAmB,EACnB,MAAmC;IAEnC,IAAI,MAAM,GAAG,GAAG,aAAa,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;IACtE,QAAQ,MAAM,EAAE,CAAC;QACb,KAAK,kCAA0B,CAAC,eAAe;YAC3C,MAAM,IAAI,GAAG,CAAC;YACd,MAAM;QACV,KAAK,kCAA0B,CAAC,YAAY;YACxC,MAAM,IAAI,GAAG,CAAC;YACd,MAAM;IACd,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAfD,sEAeC;AAED,SAAgB,yBAAyB,CAAC,IAAY,EAAE,MAAc;IAClE,MAAM,IAAI,GAAyB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QACjD,CAAC,CAAC,4BAAoB,CAAC,SAAS;QAChC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YAClB,CAAC,CAAC,4BAAoB,CAAC,wBAAwB;YAC/C,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAClB,CAAC,CAAC,4BAAoB,CAAC,qBAAqB;gBAC5C,CAAC,CAAC,4BAAoB,CAAC,IAAI,CAAC;IACpC,QAAQ,IAAI,EAAE,CAAC;QACX,KAAK,4BAAoB,CAAC,SAAS;YAC/B,OAAO;gBACH,IAAI;gBACJ,IAAI;gBACJ,MAAM;gBACN,SAAS,EAAE,IAAA,eAAM,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,CAAE;aACnC,CAAC;QACN,KAAK,4BAAoB,CAAC,wBAAwB,CAAC;QACnD,KAAK,4BAAoB,CAAC,qBAAqB;YAC3C,OAAO;gBACH,IAAI;gBACJ,IAAI;gBACJ,MAAM;gBACN,SAAS,EAAE,IAAA,eAAM,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,CAAE;gBAChC,MAAM,EAAE,IAAA,eAAM,EAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAE;aAClC,CAAC;QACN,KAAK,4BAAoB,CAAC,IAAI;YAC1B,OAAO;gBACH,IAAI;gBACJ,IAAI;gBACJ,MAAM;gBACN,IAAI,EAAE,IAAI;aACb,CAAC;IACV,CAAC;AACL,CAAC;AAjCD,8DAiCC"}

package/lib/tmp/p1.d.ts

@@ -0,0 +1,232 @@
+import { ArrayMay, NonEmptyString } from '@tsofist/stem';
+import { UUID } from '@tsofist/stem/lib/crypto/uuid';
+/**
+ * Пакет данных от любого внешнего клиента к шлюзу
+ * Контекст запроса определяется ресурсом, заданным в URL pathname.
+ *
+ * Запрос всегда валидируется средствами gw по сгенерированной JSON-схеме,
+ *  что позволяет не валидировать его повторно внутри сервиса.
+ *
+ * Всегда очень легко представить на примере сервиса (pathname),
+ *   у которого есть методы (action),
+ *   которые принимают аргументы, перечисленные по порядку (args).
+ */
+export interface InternetToGateway<TAction extends string, TArgs extends any[]> {
+    /**
+     * Название действия
+     * @example getList
+     */
+    action: TAction;
+    /**
+     * Аргументы действия
+     * Это всегда массив произвольных данных
+     */
+    args: TArgs;
+}
+/**
+ * Пакет данных от шлюза к сервису
+ * Контекст запроса определяется ресурсом, заданным в URL pathname
+ *
+ * Запрос всегда валидируется средствами gw по сгенерированной JSON-схеме,
+ *  что позволяет не валидировать его повторно внутри сервиса.
+ */
+export interface GatewayToService {
+    /**
+     * Название действия
+     * @example getList
+     */
+    action: NonEmptyString;
+    /**
+     * Аргументы действия
+     * Это всегда массив произвольных данных
+     */
+    args: unknown[];
+    /**
+     * TransactionID
+     * Идентификатор отслеживания запроса
+     *
+     * Этот идентификатор всегда сохраняется при передаче запроса от gw к сервису
+     *  и от сервиса к gw
+     */
+    tid: UUID;
+    /**
+     * Изначальная временная метка формирования запроса от клиента
+     */
+    timestamp: number;
+    /**
+     * Контекст выполнения запроса
+     * Всегда формируется на стороне gw
+     */
+    context: {
+        /**
+         * Предпочитаемый язык клиента
+         */
+        lang: string;
+        /**
+         * Вызывающая сторона
+         */
+        actor: {
+            /**
+             * Данные идентификации клиента
+             * Данные формируются при первичном вызове,
+             *  могут быть заморожены на весь период отслеживания,
+             *  а могут актуализироваться в зависимости от указанной политики
+             */
+            auth: {
+                /**
+                 * Способ входа
+                 */
+                provider: string;
+                /**
+                 * Уникальный идентификатор поставщика способа входа
+                 */
+                authority: string;
+            };
+            /**
+             * Домены, в которых работает клиент
+             */
+            domains: string[];
+            /**
+             * Уникальный идентификатор пользователя
+             */
+            user: UUID;
+            /**
+             * Список актуальных ролей пользователя
+             * @example ['domain1:admin', 'domain1:user', 'domain2:user']
+             */
+            roles: string[];
+            /**
+             * Полный список всех привилегий запрошенных в манифесте сервиса для конкретного запроса
+             * @example
+             *  [
+             *      'domain1:updateUsers',
+             *      'domain1:deleteUsers',
+             *      'domain2:manageBookings'
+             *  ]
+             */
+            privileges: string[];
+        };
+        /**
+         * Информация о запросе от клиента
+         */
+        request: {
+            /**
+             * Непосредственный IP-адрес вызывающей стороны
+             * Это может быть внутренний адрес любого сервиса системы
+             */
+            ip: string;
+            /**
+             * Настоящий IP-адрес клиента заверенный проксирующими сервисами
+             *   (например ingress-контроллером)
+             */
+            realIp: string;
+            /**
+             * Адрес, по которому был получен запрос
+             * Если клиент вызывал /api/gw/mobile - то это будет /gw/mobile
+             */
+            gateway: string;
+            /**
+             * Тип шлюза, через который принял запрос
+             * Каждый gw имеет свой тип, определяемый в его манифесте
+             */
+            gatewayKind: string;
+        };
+    };
+}
+interface Rules {
+    /**
+     * Описание политики перенаправления запроса от Сервиса к Сервису через GW
+     */
+    forwardPolicy?: {
+        /**
+         * Политика обновления авторизационного контекста клиента
+         * Контекст можно хранить весь период отслеживания запроса,
+         *   либо обновлять его при каждом перенаправлении
+         * @default keep
+         */
+        access?: 'keep' | 'renew';
+    };
+    /**
+     * Описание привилегий клиента, сопровождающих запрос
+     */
+    privileges?: {
+        /**
+         * Позволить клиенту выполнять запрос без каких-либо привилегий
+         * Явно указывается что у пользователя может не быть никаких привилегий,
+         *   но при этом пользователь должен быть авторизован (зарегистрирован в системе)
+         */
+        zero?: true;
+        /**
+         * Политика наследования привилегий из контекста, что описан выше
+         * Можно расширять список от родителя, а можно его полностью переопределить
+         */
+        policy?: 'override' | 'extend';
+        /**
+         * Список привилегий, которые обязательно должны быть у пользователя
+         * Каждый элемент списка относится друг к другу как И,
+         *   но при этом если элемент списка это список,
+         *   то каждый внутренний элемент относится к соседу как ИЛИ
+         */
+        mandatory?: ArrayMay<string>[];
+        /**
+         * Список привилегий, которые будут выгружены из считаны из аккаунта пользователя
+         *   и будут переданы в сервис вместе с этом пакетом данных
+         * Конечный сервис получит информацию по всем привилегиям, которые указаны в этом списке
+         *   и в списке обязательных привилегий тоже
+         */
+        requested?: string[];
+    };
+}
+/**
+ * API манифест сервиса
+ * Описывается на уровне GW
+ */
+export interface GatewayResourceManifest extends Rules {
+    /**
+     * Уникальный идентификатор, позволяющий определять хуки для конкретного ресурса
+     * Причем как для всего ресурса, так и для конкретного действия
+     */
+    id: string;
+    /**
+     * Ресурс, к которому привязан манифест
+     * @example
+     *      auth/users
+     *      bookings
+     *      auth/roles
+     */
+    resource: string;
+    /**
+     * Сигнатура схемы для валидатора запросов
+     * Для каждого действия будет запрашиваться схема по этому идентификатору.
+     *
+     *   Например, если сервис это Service1API, а действие это getList, то будет запрошена схема для аргументов по идентификатору
+     *      Service1API_doSomething1_Args
+     *
+     *      и схема для результата по идентификатору
+     *      Service1API_doSomething1_Result
+     *
+     *
+     *   Вся спецификация действия будет доступна по идентификатору
+     *     Service1API_InterfaceDeclaration
+     *   где будут перечислены все доступные для сервиса действия, сигнатуры их аргументов и их результатов
+     *
+     *
+     *   При этом арность аргументов действий тоже будет валидироваться
+     *
+     * @example Service1API
+     */
+    schema: `${string}API`;
+    /**
+     * Внутрисетевой origin сервиса на который будут перенаправляться запросы
+     * tcp пока под вопросом
+     */
+    service: `tcp://${string}` | `http://${string}`;
+    /**
+     * Правила для каждого действия над ресурсом
+     */
+    actions: {
+        [name: string]: Rules;
+    };
+}
+export {};
+//# sourceMappingURL=p1.d.ts.map

package/lib/tmp/p1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"p1.d.ts","sourceRoot":"","sources":["../../src/tmp/p1.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AAErD;;;;;;;;;;GAUG;AACH,MAAM,WAAW,iBAAiB,CAAC,OAAO,SAAS,MAAM,EAAE,KAAK,SAAS,GAAG,EAAE;IAC1E;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,MAAM,EAAE,cAAc,CAAC;IACvB;;;OAGG;IACH,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB;;;;;;OAMG;IACH,GAAG,EAAE,IAAI,CAAC;IACV;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,OAAO,EAAE;QACL;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,KAAK,EAAE;YACH;;;;;eAKG;YACH,IAAI,EAAE;gBACF;;mBAEG;gBACH,QAAQ,EAAE,MAAM,CAAC;gBACjB;;mBAEG;gBACH,SAAS,EAAE,MAAM,CAAC;aACrB,CAAC;YACF;;eAEG;YACH,OAAO,EAAE,MAAM,EAAE,CAAC;YAClB;;eAEG;YACH,IAAI,EAAE,IAAI,CAAC;YACX;;;eAGG;YACH,KAAK,EAAE,MAAM,EAAE,CAAC;YAChB;;;;;;;;eAQG;YACH,UAAU,EAAE,MAAM,EAAE,CAAC;SACxB,CAAC;QACF;;WAEG;QACH,OAAO,EAAE;YACL;;;eAGG;YACH,EAAE,EAAE,MAAM,CAAC;YACX;;;eAGG;YACH,MAAM,EAAE,MAAM,CAAC;YACf;;;eAGG;YACH,OAAO,EAAE,MAAM,CAAC;YAChB;;;eAGG;YACH,WAAW,EAAE,MAAM,CAAC;SACvB,CAAC;KACL,CAAC;CACL;AAED,UAAU,KAAK;IACX;;OAEG;IACH,aAAa,CAAC,EAAE;QACZ;;;;;WAKG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KAC7B,CAAC;IACF;;OAEG;IACH,UAAU,CAAC,EAAE;QACT;;;;WAIG;QACH,IAAI,CAAC,EAAE,IAAI,CAAC;QACZ;;;WAGG;QACH,MAAM,CAAC,EAAE,UAAU,GAAG,QAAQ,CAAC;QAC/B;;;;;WAKG;QACH,SAAS,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/B;;;;;WAKG;QACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;KACxB,CAAC;CACL;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,KAAK;IAClD;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC;IACvB;;;OAGG;IACH,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,UAAU,MAAM,EAAE,CAAC;IAChD;;OAEG;IACH,OAAO,EAAE;QACL,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;KACzB,CAAC;CACL"}

package/lib/tmp/p1.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// TODO
+// interface JournalRecord {
+//     id: UUID;
+//     timestamp: number;
+//     tid: UUID;
+// }
+//# sourceMappingURL=p1.js.map

package/lib/tmp/p1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"p1.js","sourceRoot":"","sources":["../../src/tmp/p1.ts"],"names":[],"mappings":";;AA2OA,OAAO;AACP,4BAA4B;AAC5B,gBAAgB;AAChB,yBAAyB;AACzB,iBAAiB;AACjB,IAAI"}