@sdkgen/node-runtime 2.3.2 → 2.5.0

package/package.json

@@ -1,8 +1,15 @@
 {
   "name": "@sdkgen/node-runtime",
-  "version": "2.3.2",
+  "version": "2.5.0",
   "description": "",
-  "main": "dist/src/index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "directories": {
+    "lib": "dist"
+  },
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "test": "TZ=UTC jest --passWithNoTests",
     "eslint:fix": "eslint --fix '{src,spec}/**/*.ts'",
@@ -19,28 +26,55 @@
     "url": "https://github.com/sdkgen/sdkgen/issues"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "homepage": "https://github.com/sdkgen/sdkgen#readme",
+  "dependencies": {
+    "@fnando/cnpj": "^1.0.2",
+    "@fnando/cpf": "^1.0.2",
+    "@sdkgen/csharp-generator": "^2.5.0",
+    "@sdkgen/dart-generator": "^2.5.0",
+    "@sdkgen/fsharp-generator": "^2.5.0",
+    "@sdkgen/kotlin-generator": "^2.5.0",
+    "@sdkgen/parser": "^2.5.0",
+    "@sdkgen/playground": "^2.5.0",
+    "@sdkgen/swift-generator": "^2.5.0",
+    "@sdkgen/typescript-generator": "^2.5.0",
+    "busboy": "1.5.0",
+    "decimal.js": "^10.4.3",
+    "file-type": "^16.5.4",
+    "request-ip": "^3.3.0",
+    "serve-handler": "^6.1.5",
+    "swagger-ui-dist": "^5.11.0"
+  },
   "devDependencies": {
     "@cubos/eslint-config": "^2.2.0",
-    "@types/busboy": "^1.0.0",
-    "@types/jest": "^29.0.0",
-    "@types/node": "^16.7.0",
-    "@types/request-ip": "0.0.37",
-    "@types/serve-handler": "^6.1.1",
-    "@types/swagger-ui-dist": "^3.30.1",
-    "axios": "^0.27.0",
+    "@types/busboy": "^1.5.3",
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.10.8",
+    "@types/request-ip": "0.0.41",
+    "@types/serve-handler": "^6.1.4",
+    "@types/swagger-ui-dist": "^3.30.4",
+    "axios": "^1.6.5",
     "form-data": "^4.0.0",
-    "jest": "^29.0.0",
-    "json-schema-typed": "^8.0.0",
+    "jest": "^29.7.0",
+    "json-schema-typed": "^8.0.1",
     "spec.ts": "^1.1.3",
-    "ts-jest": "^29.0.0",
-    "type-fest": "^3.0.0",
-    "typescript": "^4.3.5"
+    "ts-jest": "^29.1.1",
+    "type-fest": "^4.9.0",
+    "typescript": "~5.2.2"
   },
   "jest": {
     "transform": {
+      "^.+\\.js$": [
+        "babel-jest",
+        {
+          "plugins": [
+            "@babel/plugin-transform-modules-commonjs"
+          ]
+        }
+      ],
       "^.+\\.tsx?$": "ts-jest"
     },
     "transformIgnorePatterns": [
@@ -58,23 +92,5 @@
       "/spec/"
     ]
   },
-  "dependencies": {
-    "@fnando/cnpj": "^1.0.2",
-    "@fnando/cpf": "^1.0.2",
-    "@sdkgen/csharp-generator": "2.3.2",
-    "@sdkgen/dart-generator": "2.3.2",
-    "@sdkgen/fsharp-generator": "2.3.2",
-    "@sdkgen/kotlin-generator": "2.3.2",
-    "@sdkgen/parser": "2.3.2",
-    "@sdkgen/playground": "2.3.2",
-    "@sdkgen/swift-generator": "2.3.2",
-    "@sdkgen/typescript-generator": "2.3.2",
-    "busboy": "1.5.0",
-    "decimal.js": "^10.3.1",
-    "file-type": "^16.5.3",
-    "request-ip": "^3.0.0",
-    "serve-handler": "^6.1.3",
-    "swagger-ui-dist": "^4.0.0"
-  },
-  "types": "dist/src/index.d.ts"
+  "gitHead": "d95908e3e502b4367f0f9c17b122604c7a6f02e8"
 }

package/.eslintignore

@@ -1 +0,0 @@
-spec/simple/legacyNodeClient.ts

package/.eslintrc.json

@@ -1,3 +0,0 @@
-{
-  "extends": ["@cubos"]
-}

package/.prettierrc

@@ -1,12 +0,0 @@
-{
-  "arrowParens": "avoid",
-  "bracketSpacing": true,
-  "endOfLine": "lf",
-  "parser": "typescript",
-  "printWidth": 150,
-  "semi": true,
-  "singleQuote": false,
-  "tabWidth": 2,
-  "trailingComma": "all",
-  "useTabs": false
-}

package/.vscode/settings.json

@@ -1,14 +0,0 @@
-{
-  "editor.formatOnSave": true,
-  "editor.tabSize": 4,
-  "files.insertFinalNewline": true,
-  "editor.codeActionsOnSave": {
-    "source.organizeImports": true
-  },
-  "eslint.validate": [
-    "javascript",
-    "javascriptreact",
-    "typescript",
-    "typescriptreact"
-  ]
-}

package/dist/spec/error.spec.d.ts

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

package/dist/spec/error.spec.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-const src_1 = require("../src");
-class TestError extends src_1.SdkgenError {
-}
-describe("Error", () => {
-    test("SdkgenError behaves as expected", () => {
-        const err1 = new TestError("the error message");
-        expect(err1.message).toEqual("the error message");
-        expect(err1.type).toEqual("TestError");
-        expect(JSON.parse(JSON.stringify(err1))).toEqual({ message: "the error message", type: "TestError" });
-    });
-});

package/dist/spec/rest/rest.spec.d.ts

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

package/dist/spec/rest/rest.spec.js

@@ -1,353 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable @typescript-eslint/require-await */
-/* eslint-disable @typescript-eslint/no-unsafe-return */
-/* eslint-disable @typescript-eslint/naming-convention */
-/* eslint-disable @typescript-eslint/no-require-imports */
-/* eslint-disable @typescript-eslint/no-var-requires */
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-const fs_1 = require("fs");
-const parser_1 = require("@sdkgen/parser");
-const typescript_generator_1 = require("@sdkgen/typescript-generator");
-const axios_1 = __importDefault(require("axios"));
-const form_data_1 = __importDefault(require("form-data"));
-const src_1 = require("../../src");
-const ast = new parser_1.Parser(`${__dirname}/api.sdkgen`).parse();
-(0, fs_1.writeFileSync)(`${__dirname}/api.ts`, (0, typescript_generator_1.generateNodeServerSource)(ast).replace(/@sdkgen\/node-runtime/gu, "../../src"));
-const { api, TestError } = require(`${__dirname}/api.ts`);
-(0, fs_1.unlinkSync)(`${__dirname}/api.ts`);
-api.fn.add = async (_ctx, { first, second }) => {
-    return `${first}${second}`;
-};
-api.fn.maybe = async (_ctx, { bin }) => {
-    return bin === null ? null : Buffer.from(bin, "hex");
-};
-api.fn.hex = async (_ctx, { bin }) => {
-    return bin.toString("hex");
-};
-api.fn.obj = async (_ctx, { obj }) => {
-    if (obj.val === 0) {
-        throw new Error("Value is zero ~ Fatal");
-    }
-    if (obj.val === -100) {
-        throw new TestError("Value is -100 ~ TestError");
-    }
-    return obj;
-};
-api.fn.returnArg = async (_ctx, { arg }) => {
-    return arg;
-};
-api.fn.returnNoArg = async (_ctx) => {
-    return "no-arg";
-};
-api.fn.returnArgConcat = async (_ctx, { arg, arg2 }) => {
-    return `${arg}${arg2}`;
-};
-async function readAllStream(stream) {
-    return new Promise((resolve, reject) => {
-        const chunks = [];
-        stream.on("error", err => reject(err));
-        stream.on("data", data => chunks.push(Buffer.from(data)));
-        stream.on("end", () => resolve(Buffer.concat(chunks)));
-    });
-}
-api.fn.uploadFile = async (ctx) => {
-    return Promise.all(ctx.request.files.map(async ({ name, contents }) => ({
-        data: await readAllStream(contents),
-        name,
-    })));
-};
-api.fn.getHtml = async () => {
-    return "<h1>Hello world!</h1>";
-};
-api.fn.getXml = async () => {
-    return "<h1>Hello world!</h1>";
-};
-(0, fs_1.writeFileSync)(`${__dirname}/nodeClient.ts`, (0, typescript_generator_1.generateNodeClientSource)(ast).replace(/@sdkgen\/node-runtime/gu, "../../src"));
-const { ApiClient: NodeApiClient } = require(`${__dirname}/nodeClient.ts`);
-(0, fs_1.unlinkSync)(`${__dirname}/nodeClient.ts`);
-const nodeClient = new NodeApiClient("http://localhost:8001");
-const server = new src_1.SdkgenHttpServer(api, {});
-describe("Rest API", () => {
-    beforeAll(async () => {
-        await server.listen(8001);
-    });
-    afterAll(async () => {
-        await server.close();
-    });
-    test("add with sdkgen", async () => {
-        expect(await nodeClient.add(null, { first: 1, second: "aa" })).toEqual("1aa");
-    });
-    const table = [
-        { method: "GET", path: "/add1/1/aa", result: "1aa" },
-        { method: "GET", path: "/add1/1/aa/", result: "1aa" },
-        {
-            headers: {
-                accept: "application/json",
-            },
-            method: "GET",
-            path: "/add1/1/aa",
-            result: '"1aa"',
-        },
-        { method: "GET", path: "/add2&second=aa&first=1", result: "", statusCode: 404 },
-        { method: "GET", path: "/add2?second=aa&first=1", result: "1aa" },
-        { method: "GET", path: "/add2?first=1&second=aa", result: "1aa" },
-        {
-            headers: {
-                "x-second": "aa",
-            },
-            method: "GET",
-            path: "/add3?first=1",
-            result: "1aa",
-        },
-        {
-            headers: {
-                accept: "application/json",
-                "x-second": "aa",
-            },
-            method: "GET",
-            path: "/add3?first=1",
-            result: '"1aa"',
-        },
-        {
-            data: "1",
-            headers: {
-                "x-second": "aa",
-            },
-            method: "POST",
-            path: "/add4",
-            result: "1aa",
-        },
-        {
-            data: "1",
-            headers: {
-                accept: "application/json",
-                "x-second": "aa",
-            },
-            method: "POST",
-            path: "/add4",
-            result: '"1aa"',
-        },
-        {
-            data: "aa",
-            headers: {
-                "x-first": "1",
-            },
-            method: "POST",
-            path: "/add5",
-            result: "1aa",
-        },
-        {
-            data: '"aa"',
-            headers: {
-                "content-type": "application/json",
-                "x-first": "1",
-            },
-            method: "POST",
-            path: "/add5",
-            result: "1aa",
-        },
-        {
-            data: '"aa"',
-            headers: {
-                accept: "application/json",
-                "content-type": "application/json",
-                "x-first": "1",
-            },
-            method: "POST",
-            path: "/add5",
-            result: '"1aa"',
-        },
-        { method: "POST", path: "/add6?second=aa&first=1", result: "1aa" },
-        { method: "POST", path: "/add6?first=1&second=aa", result: "1aa" },
-        {
-            data: "second=aa&first=1",
-            headers: { "content-type": "application/x-www-form-urlencoded" },
-            method: "POST",
-            path: "/add6",
-            result: "1aa",
-        },
-        {
-            data: "first=1&second=aa",
-            headers: { "content-type": "application/x-www-form-urlencoded" },
-            method: "POST",
-            path: "/add6",
-            result: "1aa",
-        },
-        {
-            method: "GET",
-            path: "/maybe",
-            result: "",
-            statusCode: 404,
-        },
-        {
-            method: "GET",
-            path: "/maybe?bin=4d546864",
-            result: "MThd",
-            resultHeaders: {
-                "content-type": "audio/midi",
-            },
-        },
-        {
-            method: "GET",
-            path: "/maybe?bin=61",
-            result: "a",
-            resultHeaders: {
-                "content-type": "application/octet-stream",
-            },
-        },
-        {
-            headers: {
-                accept: "application/json",
-            },
-            method: "GET",
-            path: "/maybe?bin=61",
-            result: '"YQ=="',
-        },
-        {
-            method: "POST",
-            path: "/maybe",
-            result: "",
-            statusCode: 204,
-        },
-        {
-            data: "61",
-            method: "POST",
-            path: "/maybe",
-            result: "a",
-            resultHeaders: {
-                "content-type": "application/octet-stream",
-            },
-        },
-        {
-            data: "a",
-            method: "POST",
-            path: "/hex",
-            result: "61",
-        },
-        {
-            data: `{"val":15}`,
-            method: "POST",
-            path: "/obj",
-            result: `{"val":15}`,
-            resultHeaders: {
-                "content-type": "application/json",
-            },
-        },
-        {
-            data: `{"val":0}`,
-            method: "POST",
-            path: "/obj",
-            result: `{"message":"Value is zero ~ Fatal","type":"Fatal"}`,
-            resultHeaders: {
-                "content-type": "application/json",
-            },
-            statusCode: 500,
-        },
-        {
-            data: `{"val":-100}`,
-            method: "POST",
-            path: "/obj",
-            result: `{"message":"Value is -100 ~ TestError","type":"TestError"}`,
-            resultHeaders: {
-                "content-type": "application/json",
-            },
-            statusCode: 400,
-        },
-        {
-            method: "POST",
-            path: "/upload",
-            result: `[]`,
-            resultHeaders: {
-                "content-type": "application/json",
-            },
-            statusCode: 200,
-        },
-        {
-            method: "GET",
-            path: "/html",
-            result: "<h1>Hello world!</h1>",
-            resultHeaders: {
-                "content-type": "text/html",
-            },
-        },
-        {
-            method: "GET",
-            path: "/xml",
-            result: "<h1>Hello world!</h1>",
-            resultHeaders: {
-                "content-type": "text/xml",
-            },
-        },
-        {
-            method: "GET",
-            path: "/foo/haha/hello",
-            result: "haha",
-        },
-        {
-            method: "GET",
-            path: "/foo/barhaha/hello",
-            result: "haha",
-        },
-        {
-            method: "GET",
-            path: "/foo/bar/hello",
-            result: "bar",
-        },
-        {
-            method: "GET",
-            path: "/foo/baz/hello",
-            result: "no-arg",
-        },
-        {
-            method: "GET",
-            path: "/foo/haha/hello/hehe/world",
-            result: "hahahehe",
-        },
-        {
-            method: "GET",
-            path: "/foo/barhaha/hello/barhehe/world",
-            result: "hahahehe",
-        },
-        {
-            method: "GET",
-            path: "/foo/bar/hello/bar/world",
-            result: "barbar",
-        },
-        (() => {
-            const form = new form_data_1.default();
-            form.append("file", Buffer.from("Hello"), "test.txt");
-            return {
-                data: form.getBuffer(),
-                headers: Object.assign({}, form.getHeaders()),
-                method: "POST",
-                path: "/upload",
-                result: `[{"name":"test.txt","data":"SGVsbG8="}]`,
-                resultHeaders: {
-                    "content-type": "application/json",
-                },
-                statusCode: 200,
-            };
-        })(),
-    ];
-    for (const { method, path, result, headers, data, statusCode, resultHeaders } of table) {
-        test(`${method} ${path}${headers ? ` with headers ${JSON.stringify(headers)}` : ""}`, async () => {
-            const response = await axios_1.default.request({
-                data,
-                headers,
-                method,
-                transformResponse: [x => x],
-                url: `http://localhost:8001${path}`,
-                validateStatus: () => true,
-            });
-            expect(response.data).toEqual(result);
-            expect(response.status).toEqual(statusCode !== null && statusCode !== void 0 ? statusCode : 200);
-            expect(response.headers).toMatchObject(resultHeaders !== null && resultHeaders !== void 0 ? resultHeaders : {});
-        });
-    }
-});

package/dist/spec/runtime/errors.spec.d.ts

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

package/dist/spec/runtime/errors.spec.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable @typescript-eslint/require-await */
-/* eslint-disable @typescript-eslint/no-unsafe-return */
-/* eslint-disable @typescript-eslint/naming-convention */
-/* eslint-disable @typescript-eslint/no-require-imports */
-/* eslint-disable @typescript-eslint/no-var-requires */
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-const fs_1 = require("fs");
-const parser_1 = require("@sdkgen/parser");
-const typescript_generator_1 = require("@sdkgen/typescript-generator");
-const src_1 = require("../../src");
-const ast = new parser_1.Parser(`${__dirname}/api.sdkgen`).parse();
-(0, fs_1.writeFileSync)(`${__dirname}/errors-api.ts`, (0, typescript_generator_1.generateNodeServerSource)(ast).replace(/@sdkgen\/node-runtime/gu, "../../src"));
-const { api, CustomError } = require(`${__dirname}/errors-api.ts`);
-(0, fs_1.unlinkSync)(`${__dirname}/errors-api.ts`);
-api.fn.throwCustomError = async (_ctx, args) => {
-    throw new CustomError("Some message", args);
-};
-(0, fs_1.writeFileSync)(`${__dirname}/errors-nodeClient.ts`, (0, typescript_generator_1.generateNodeClientSource)(ast).replace(/@sdkgen\/node-runtime/gu, "../../src"));
-const { ApiClient: NodeApiClient } = require(`${__dirname}/errors-nodeClient.ts`);
-(0, fs_1.unlinkSync)(`${__dirname}/errors-nodeClient.ts`);
-const nodeClient = new NodeApiClient("http://localhost:35437");
-const server = new src_1.SdkgenHttpServer(api, {});
-describe("Errors", () => {
-    beforeAll(async () => {
-        await server.listen(35437);
-    });
-    afterAll(async () => {
-        await server.close();
-    });
-    test("Errors are passed correctly", async () => {
-        await expect(nodeClient.throwCustomError(null, { value: 235 })).rejects.toMatchObject({
-            data: {
-                value: 235,
-            },
-            message: "Some message",
-            type: "CustomError",
-        });
-    });
-});

package/dist/spec/runtime/middleware.spec.d.ts

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

package/dist/spec/runtime/middleware.spec.js

@@ -1,100 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable @typescript-eslint/require-await */
-/* eslint-disable @typescript-eslint/no-unsafe-return */
-/* eslint-disable @typescript-eslint/naming-convention */
-/* eslint-disable @typescript-eslint/no-require-imports */
-/* eslint-disable @typescript-eslint/no-var-requires */
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-const fs_1 = require("fs");
-const parser_1 = require("@sdkgen/parser");
-const typescript_generator_1 = require("@sdkgen/typescript-generator");
-const src_1 = require("../../src");
-const ast = new parser_1.Parser(`${__dirname}/api.sdkgen`).parse();
-(0, fs_1.writeFileSync)(`${__dirname}/middleware-api.ts`, (0, typescript_generator_1.generateNodeServerSource)(ast).replace(/@sdkgen\/node-runtime/gu, "../../src"));
-const { api } = require(`${__dirname}/middleware-api.ts`);
-(0, fs_1.unlinkSync)(`${__dirname}/middleware-api.ts`);
-api.fn.identity = async (_ctx, args) => {
-    return args.value;
-};
-api.fn.sum = async (_ctx, args) => {
-    return args.a + args.b;
-};
-(0, fs_1.writeFileSync)(`${__dirname}/middleware-nodeClient.ts`, (0, typescript_generator_1.generateNodeClientSource)(ast).replace(/@sdkgen\/node-runtime/gu, "../../src"));
-const { ApiClient: NodeApiClient } = require(`${__dirname}/middleware-nodeClient.ts`);
-(0, fs_1.unlinkSync)(`${__dirname}/middleware-nodeClient.ts`);
-const nodeClient = new NodeApiClient("http://localhost:32542");
-const server = new src_1.SdkgenHttpServer(api, {});
-describe("Middleware", () => {
-    beforeAll(async () => {
-        await server.listen(32542);
-    });
-    afterAll(async () => {
-        await server.close();
-    });
-    test("A single middeware can intercept calls", async () => {
-        expect(await nodeClient.identity(null, { value: 1 })).toBe(1);
-        expect(await nodeClient.identity(null, { value: 2 })).toBe(2);
-        expect(await nodeClient.identity(null, { value: 3 })).toBe(3);
-        api.use(async (ctx, next) => {
-            if (ctx.request.args.value === 2) {
-                return {
-                    result: 17,
-                };
-            }
-            return next();
-        });
-        expect(await nodeClient.identity(null, { value: 1 })).toBe(1);
-        expect(await nodeClient.identity(null, { value: 2 })).toBe(17);
-        expect(await nodeClient.identity(null, { value: 3 })).toBe(3);
-        api.middlewares.pop();
-    });
-    test("Multiple middlewares stack", async () => {
-        expect(await nodeClient.identity(null, { value: 1 })).toBe(1);
-        expect(await nodeClient.identity(null, { value: 2 })).toBe(2);
-        expect(await nodeClient.identity(null, { value: 3 })).toBe(3);
-        api.use(async (ctx, next) => {
-            if (ctx.request.args.value === 2) {
-                return {
-                    result: 17,
-                };
-            }
-            return next();
-        });
-        api.use(async (ctx, next) => {
-            if (ctx.request.args.value < 3) {
-                return {
-                    result: 10,
-                };
-            }
-            return next();
-        });
-        expect(await nodeClient.identity(null, { value: 1 })).toBe(10);
-        expect(await nodeClient.identity(null, { value: 2 })).toBe(17);
-        expect(await nodeClient.identity(null, { value: 3 })).toBe(3);
-        api.middlewares.pop();
-        api.middlewares.pop();
-    });
-    test("A middeware can redirect calls", async () => {
-        expect(await nodeClient.identity(null, { value: 1 })).toBe(1);
-        expect(await nodeClient.identity(null, { value: 2 })).toBe(2);
-        expect(await nodeClient.identity(null, { value: 3 })).toBe(3);
-        api.use(async (ctx, next) => {
-            if (ctx.request.name === "identity") {
-                ctx.request.name = "sum";
-                const { value } = ctx.request.args;
-                ctx.request.args = {
-                    a: value,
-                    b: value,
-                };
-            }
-            return next();
-        });
-        expect(await nodeClient.identity(null, { value: 1 })).toBe(2);
-        expect(await nodeClient.identity(null, { value: 2 })).toBe(4);
-        expect(await nodeClient.identity(null, { value: 3 })).toBe(6);
-        api.middlewares.pop();
-    });
-});