@open-rpc/typings 1.12.3 → 1.13.0

package/build/cli.js

@@ -15,7 +15,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -82,11 +82,11 @@ commander_1.default
         switch (_a.label) {
             case 0:
                 _a.trys.push([0, 3, , 4]);
-                return [4 /*yield*/, schema_utils_js_1.parseOpenRPCDocument(commander_1.default.document)];
+                return [4 /*yield*/, (0, schema_utils_js_1.parseOpenRPCDocument)(commander_1.default.document)];
             case 1:
                 openrpcDocument = _a.sent();
                 typingsOptions = parseTypingsOptions(commander_1.default);
-                return [4 /*yield*/, generate_typings_file_1.generateTypingsFile(openrpcDocument, typingsOptions)];
+                return [4 /*yield*/, (0, generate_typings_file_1.generateTypingsFile)(openrpcDocument, typingsOptions)];
             case 2:
                 _a.sent();
                 console.log("Done!"); // tslint:disable-line

package/build/generate-typings-file.js

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -63,12 +63,12 @@ function generateTypingsFile(openrpcDocument, options) {
                             var typings, typingsFileName;
                             return __generator(this, function (_a) {
                                 switch (_a.label) {
-                                    case 0: return [4 /*yield*/, fs_extra_1.ensureDir(option.dirName)];
+                                    case 0: return [4 /*yield*/, (0, fs_extra_1.ensureDir)(option.dirName)];
                                     case 1:
                                         _a.sent();
                                         typings = methodTypings.toString(option.lang);
-                                        typingsFileName = option.dirName + "/" + option.fileName + getExtension(option.lang);
-                                        return [4 /*yield*/, fs_extra_1.writeFile(typingsFileName, typings, "utf8")];
+                                        typingsFileName = "".concat(option.dirName, "/").concat(option.fileName).concat(getExtension(option.lang));
+                                        return [4 /*yield*/, (0, fs_extra_1.writeFile)(typingsFileName, typings, "utf8")];
                                     case 2: return [2 /*return*/, _a.sent()];
                                 }
                             });

package/build/generator-interface.d.ts

@@ -1,8 +1,8 @@
 import { OpenrpcDocument as OpenRPC, MethodObject } from "@open-rpc/meta-schema";
-export declare type GetMethodTypings = (openrpcSchema: OpenRPC) => string;
-export declare type GetParamsTypings = (openrpcSchema: OpenRPC) => string;
-export declare type GetParamsTyping = (method: MethodObject, joinString?: string) => string;
-export declare type GetMethodAliasName = (method: MethodObject) => string;
+export type GetMethodTypings = (openrpcSchema: OpenRPC) => string;
+export type GetParamsTypings = (openrpcSchema: OpenRPC) => string;
+export type GetParamsTyping = (method: MethodObject, joinString?: string) => string;
+export type GetMethodAliasName = (method: MethodObject) => string;
 export interface Generator {
     getMethodTypings: GetMethodTypings;
     getMethodAliasName: GetMethodAliasName;

package/build/go.js

@@ -18,25 +18,28 @@ exports.getParamsTypings = exports.getMethodTypings = exports.getMethodAliasName
 var utils_1 = require("@json-schema-tools/transpiler/build/utils");
 var titleizer_1 = __importDefault(require("@json-schema-tools/titleizer"));
 var getMethodAliasName = function (method) {
-    return utils_1.languageSafeName(method.name);
+    return (0, utils_1.languageSafeName)(method.name);
 };
 exports.getMethodAliasName = getMethodAliasName;
 var getParamsTyping = function (method) {
-    var params = method.params.map(function (param) { return param.name + " " + utils_1.languageSafeName(utils_1.getTitle(titleizer_1.default(param.schema))); }).join(", ");
+    var params = method.params.map(function (param) { return "".concat(param.name, " ").concat((0, utils_1.languageSafeName)((0, utils_1.getTitle)((0, titleizer_1.default)(param.schema)))); }).join(", ");
     return params;
 };
 var getMethodTyping = function (method) {
     var mResult = method.result;
-    var mutableSchema = (mResult.schema === true || mResult.schema === false) ? mResult.schema : __assign({}, mResult.schema);
-    var resultName = utils_1.languageSafeName(utils_1.getTitle(titleizer_1.default(mutableSchema)));
-    var methodAliasName = exports.getMethodAliasName(method);
+    var methodAliasName = (0, exports.getMethodAliasName)(method);
     var params = getParamsTyping(method);
-    return "\t" + methodAliasName + "(" + params + ") (" + resultName + ", error)";
+    if (mResult === undefined) {
+        return "\t".concat(methodAliasName, "(").concat(params, ") error");
+    }
+    var mutableSchema = (mResult.schema === true || mResult.schema === false) ? mResult.schema : __assign({}, mResult.schema);
+    var resultName = (0, utils_1.languageSafeName)((0, utils_1.getTitle)((0, titleizer_1.default)(mutableSchema)));
+    return "\t".concat(methodAliasName, "(").concat(params, ") (").concat(resultName, ", error)");
 };
 var getMethodTypings = function (openrpcDocument) {
     var fns = openrpcDocument.methods.map(getMethodTyping);
     return [
-        "type " + utils_1.languageSafeName(openrpcDocument.info.title) + " interface {",
+        "type ".concat((0, utils_1.languageSafeName)(openrpcDocument.info.title), " interface {"),
         fns.join("\n"),
         "}",
     ].join("\n");

package/build/index.d.ts

@@ -1,5 +1,5 @@
 import { OpenrpcDocument as OpenRPC, MethodObject } from "@open-rpc/meta-schema";
-export declare type OpenRPCTypingsSupportedLanguages = "rust" | "rs" | "typescript" | "ts" | "go" | "golang" | "py" | "python";
+export type OpenRPCTypingsSupportedLanguages = "rust" | "rs" | "typescript" | "ts" | "go" | "golang" | "py" | "python";
 interface OpenRPCTypings {
     schemas: string;
     methods: string;
@@ -45,6 +45,7 @@ export default class MethodTypings {
     getMethodTypings(language: OpenRPCTypingsSupportedLanguages): string;
     getParamsTypings(language: OpenRPCTypingsSupportedLanguages): string;
     getParamsTyping(language: OpenRPCTypingsSupportedLanguages, method: MethodObject, joinString: string): string;
+    getEmptyResultType(language: OpenRPCTypingsSupportedLanguages): string;
     getTypingNames(language: OpenRPCTypingsSupportedLanguages, method: MethodObject): OpenRPCMethodTypingNames;
     /**
      * A configurable way to output the typings into a string.

package/build/index.js

@@ -17,6 +17,16 @@ var generators = {
     rust: rust_1.default,
     typescript: typescript_1.default,
 };
+var languageAliases = {
+    "ts": "typescript",
+    "rs": "rust",
+    "golang": "go",
+    "py": "python",
+    "rust": "rust",
+    "typescript": "typescript",
+    "go": "go",
+    "python": "python",
+};
 /**
  * A class to handle all the tasks relating to types for the OpenRPC Document.
  */
@@ -27,8 +37,8 @@ var MethodTypings = /** @class */ (function () {
             includeMethodAliasTypings: true,
             includeSchemaTypings: true,
         };
-        var schemas = utils_1.getSchemasForOpenRPCDocument(openrpcDocument);
-        this.transpiler = new transpiler_1.default(utils_1.deepClone(schemas));
+        var schemas = (0, utils_1.getSchemasForOpenRPCDocument)(openrpcDocument);
+        this.transpiler = new transpiler_1.default((0, utils_1.deepClone)(schemas));
     }
     /**
      * A method that returns all the typings for the schemas in an [[OpenRPC]] Document.
@@ -59,8 +69,26 @@ var MethodTypings = /** @class */ (function () {
     MethodTypings.prototype.getParamsTyping = function (language, method, joinString) {
         return generators[language].getParamsTyping(method, joinString);
     };
+    MethodTypings.prototype.getEmptyResultType = function (language) {
+        var standardizedLanguage = languageAliases[language];
+        switch (standardizedLanguage) {
+            case "typescript":
+                return "Promise<void>";
+            case "rust":
+                return "RpcRequest<void>";
+            case "go":
+                return "void";
+            case "python":
+                return "None";
+            /* istanbul ignore next */
+            default:
+                /* istanbul ignore next */
+                throw new Error("Cannot resolve empty result type for unknown language: ".concat(language));
+        }
+    };
     MethodTypings.prototype.getTypingNames = function (language, method) {
-        var gen = generators[language];
+        var standardizedLanguage = languageAliases[language];
+        var gen = generators[standardizedLanguage];
         var defaultedMethod = this.openrpcDocument.methods.find(function (_a) {
             var name = _a.name;
             return name === method.name;
@@ -71,9 +99,9 @@ var MethodTypings = /** @class */ (function () {
             method: gen.getMethodAliasName(defaultedMethod),
             params: methodParams.map(function (_a) {
                 var schema = _a.schema;
-                return utils_2.languageSafeName(utils_2.getTitle(titleizer_1.default(schema)));
+                return (0, utils_2.languageSafeName)((0, utils_2.getTitle)((0, titleizer_1.default)(schema)));
             }),
-            result: utils_2.languageSafeName(utils_2.getTitle(titleizer_1.default(methodResult.schema))),
+            result: methodResult ? (0, utils_2.languageSafeName)((0, utils_2.getTitle)((0, titleizer_1.default)(methodResult.schema))) : this.getEmptyResultType(standardizedLanguage),
         };
     };
     /**

package/build/python.js

@@ -12,7 +12,7 @@ var getMethodTypings = function (openrpcDocument) {
 };
 exports.getMethodTypings = getMethodTypings;
 var getMethodAliasName = function (method) {
-    return utils_1.languageSafeName(method.name);
+    return (0, utils_1.languageSafeName)(method.name);
 };
 exports.getMethodAliasName = getMethodAliasName;
 var getParamsTyping = function (method) {

package/build/rust.js

@@ -18,22 +18,25 @@ exports.getParamsTypings = exports.getMethodTypings = exports.getMethodAliasName
 var utils_1 = require("@json-schema-tools/transpiler/build/utils");
 var titleizer_1 = __importDefault(require("@json-schema-tools/titleizer"));
 var getMethodAliasName = function (method) {
-    return utils_1.languageSafeName(method.name);
+    return (0, utils_1.languageSafeName)(method.name);
 };
 exports.getMethodAliasName = getMethodAliasName;
 var getParamsTyping = function (method) {
-    var params = method.params.map(function (param) { return param.name + ": " + utils_1.languageSafeName(utils_1.getTitle(titleizer_1.default(param.schema))); }).join(", ");
+    var params = method.params.map(function (param) { return "".concat(param.name, ": ").concat((0, utils_1.languageSafeName)((0, utils_1.getTitle)((0, titleizer_1.default)(param.schema)))); }).join(", ");
     return params;
 };
 var getMethodTyping = function (method) {
     var mResult = method.result;
-    var mutableSchema = (mResult.schema === true || mResult.schema === false) ? mResult.schema : __assign({}, mResult.schema);
-    var resultName = utils_1.getTitle(titleizer_1.default(mutableSchema));
-    var result = "RpcRequest<" + utils_1.languageSafeName(resultName) + ">";
-    var methodAliasName = exports.getMethodAliasName(method);
+    var result = "RpcRequest<void>";
+    if (mResult !== undefined) {
+        var mutableSchema = (mResult.schema === true || mResult.schema === false) ? mResult.schema : __assign({}, mResult.schema);
+        var resultName = (0, utils_1.getTitle)((0, titleizer_1.default)(mutableSchema));
+        result = "RpcRequest<".concat((0, utils_1.languageSafeName)(resultName), ">");
+    }
+    var methodAliasName = (0, exports.getMethodAliasName)(method);
     var params = getParamsTyping(method);
-    var paramString = (params.length > 0) ? ", " + params : "";
-    return "pub fn " + methodAliasName + "(&mut self" + paramString + ") -> " + result + ";";
+    var paramString = (params.length > 0) ? ", ".concat(params) : "";
+    return "pub fn ".concat(methodAliasName, "(&mut self").concat(paramString, ") -> ").concat(result, ";");
 };
 var getMethodTypings = function (openrpcDocument) {
     return openrpcDocument.methods

package/build/typescript.js

@@ -18,24 +18,27 @@ exports.getParamsTypings = exports.getMethodTypings = exports.getMethodAliasName
 var utils_1 = require("@json-schema-tools/transpiler/build/utils");
 var titleizer_1 = __importDefault(require("@json-schema-tools/titleizer"));
 var getMethodAliasName = function (method) {
-    return utils_1.languageSafeName(method.name);
+    return (0, utils_1.languageSafeName)(method.name);
 };
 exports.getMethodAliasName = getMethodAliasName;
 var getParamsTyping = function (method, joinString) {
     var params = method.params.map(function (param) { return [
-        "" + param.name + (param.required === false ? "?" : "") + ": ",
-        "" + utils_1.languageSafeName(utils_1.getTitle(titleizer_1.default(param.schema))),
+        "".concat(param.name).concat(param.required === false ? "?" : "", ": "),
+        "".concat((0, utils_1.languageSafeName)((0, utils_1.getTitle)((0, titleizer_1.default)(param.schema)))),
     ].join(""); }).join(joinString || ", ");
     return params;
 };
 var getMethodTyping = function (method) {
-    var result = method.result;
-    var mutableSchema = (result.schema === true || result.schema === false) ? result.schema : __assign({}, result.schema);
-    var resultName = utils_1.getTitle(titleizer_1.default(mutableSchema));
-    var resultTypeName = "Promise<" + utils_1.languageSafeName(resultName) + ">";
-    var methodAliasName = exports.getMethodAliasName(method);
+    var methodAliasName = (0, exports.getMethodAliasName)(method);
     var params = getParamsTyping(method);
-    return "export type " + methodAliasName + " = (" + params + ") => " + resultTypeName + ";";
+    var result = method.result;
+    var resultTypeName = "Promise<void>";
+    if (result !== undefined) {
+        var mutableSchema = (result.schema === true || result.schema === false) ? result.schema : __assign({}, result.schema);
+        var resultName = (0, utils_1.getTitle)((0, titleizer_1.default)(mutableSchema));
+        resultTypeName = "Promise<".concat((0, utils_1.languageSafeName)(resultName), ">");
+    }
+    return "export type ".concat(methodAliasName, " = (").concat(params, ") => ").concat(resultTypeName, ";");
 };
 var getMethodTypings = function (openrpcDocument) {
     return openrpcDocument.methods

package/build/utils.js

@@ -10,17 +10,21 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
-var __spreadArray = (this && this.__spreadArray) || function (to, from) {
-    for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
-        to[j] = from[i];
-    return to;
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deepClone = exports.getSchemasForOpenRPCDocument = exports.flatten = void 0;
 var flatten = function (arr) {
     return arr.reduce(function (memo, val) {
         if (val instanceof Array) {
-            return __spreadArray(__spreadArray([], memo), val);
+            return __spreadArray(__spreadArray([], memo, true), val, true);
         }
         else {
             memo.push(val);
@@ -31,8 +35,8 @@ var flatten = function (arr) {
 exports.flatten = flatten;
 var getSchemasForOpenRPCDocument = function (openrpcDocument) {
     var methods = openrpcDocument.methods;
-    var params = exports.flatten(methods.map(function (method) { return method.params; }));
-    var result = methods.map(function (method) { return method.result; });
+    var params = (0, exports.flatten)(methods.map(function (method) { return method.params; }));
+    var result = methods.map(function (method) { return method.result; }).filter(function (result) { return result !== undefined; });
     return params
         .concat(result)
         .map(function (_a) {
@@ -52,7 +56,7 @@ var deepClone = function (obj, hash) {
         return hash.get(obj);
     var result = Object(null);
     if (obj instanceof Array) {
-        result = obj.map(function (o) { return exports.deepClone(o, hash); });
+        result = obj.map(function (o) { return (0, exports.deepClone)(o, hash); });
     }
     else if (obj instanceof Set) {
         result = new Set(obj);
@@ -60,7 +64,7 @@ var deepClone = function (obj, hash) {
     else if (obj instanceof Map) {
         result = new Map(Array.from(obj, function (_a) {
             var key = _a[0], val = _a[1];
-            return [key, exports.deepClone(val, hash)];
+            return [key, (0, exports.deepClone)(val, hash)];
         }));
     }
     else if (obj instanceof Date) {
@@ -75,7 +79,7 @@ var deepClone = function (obj, hash) {
     hash.set(obj, result);
     return Object.assign.apply(Object, __spreadArray([result], Object.keys(obj).map(function (key) {
         var _a;
-        return (_a = {}, _a[key] = exports.deepClone(obj[key], hash), _a);
-    })));
+        return (_a = {}, _a[key] = (0, exports.deepClone)(obj[key], hash), _a);
+    }), false));
 };
 exports.deepClone = deepClone;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@open-rpc/typings",
   "private": false,
-  "version": "1.12.3",
+  "version": "1.13.0",
   "description": "",
   "main": "build/index.js",
   "bin": {
@@ -29,21 +29,21 @@
   },
   "homepage": "https://github.com/open-rpc/typings#readme",
   "dependencies": {
-    "@json-schema-tools/titleizer": "1.0.8",
-    "@json-schema-tools/transpiler": "^1.10.3",
-    "@open-rpc/schema-utils-js": "1.16.1",
+    "@json-schema-tools/titleizer": "1.0.9",
+    "@json-schema-tools/transpiler": "^1.10.5",
+    "@open-rpc/schema-utils-js": "2.0.2",
     "commander": "^6.0.0",
     "fs-extra": "^10.0.0"
   },
   "devDependencies": {
-    "@open-rpc/examples": "1.6.1",
-    "@open-rpc/meta-schema": "1.14.2",
+    "@open-rpc/examples": "1.7.2",
+    "@open-rpc/meta-schema": "1.14.9",
     "@types/commander": "^2.12.2",
     "@types/fs-extra": "^9.0.1",
-    "@types/jest": "^26.0.7",
-    "jest": "^26.1.0",
-    "ts-jest": "^26.1.4",
-    "typedoc": "0.21.5",
-    "typescript": "4.3.5"
+    "@types/jest": "^29.5.12",
+    "jest": "^29.1.2",
+    "ts-jest": "^29.1.2",
+    "typedoc": "0.25.13",
+    "typescript": "4.9.5"
   }
 }