@open-rpc/typings 1.12.4 → 1.13.1

package/build/cli.js

@@ -43,6 +43,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var commander_1 = __importDefault(require("commander"));
 var schema_utils_js_1 = require("@open-rpc/schema-utils-js");
 var generate_typings_file_1 = require("./generate-typings-file");
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 var version = require("../package.json").version; // tslint:disable-line
 function makeOptions(fileName, dirName, lang) {
     return {

package/build/generate-typings-file.d.ts

@@ -1,5 +1,5 @@
 import { OpenRPCTypingsSupportedLanguages } from "./";
-import { OpenrpcDocument as OpenRPC } from "@open-rpc/meta-schema";
+import { OpenrpcDocument as OpenRPC } from "./types";
 export interface TypingsOptions {
     fileName: string;
     dirName: string;

package/build/generator-interface.d.ts

@@ -1,4 +1,4 @@
-import { OpenrpcDocument as OpenRPC, MethodObject } from "@open-rpc/meta-schema";
+import { OpenrpcDocument as OpenRPC, MethodObject } from "./types";
 export type GetMethodTypings = (openrpcSchema: OpenRPC) => string;
 export type GetParamsTypings = (openrpcSchema: OpenRPC) => string;
 export type GetParamsTyping = (method: MethodObject, joinString?: string) => string;

package/build/go.js

@@ -27,10 +27,13 @@ var getParamsTyping = function (method) {
 };
 var getMethodTyping = function (method) {
     var mResult = method.result;
-    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)));
     var methodAliasName = (0, exports.getMethodAliasName)(method);
     var params = getParamsTyping(method);
+    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) {

package/build/index.d.ts

@@ -1,4 +1,4 @@
-import { OpenrpcDocument as OpenRPC, MethodObject } from "@open-rpc/meta-schema";
+import { OpenrpcDocument as OpenRPC, MethodObject } from "./types";
 export type OpenRPCTypingsSupportedLanguages = "rust" | "rs" | "typescript" | "ts" | "go" | "golang" | "py" | "python";
 interface OpenRPCTypings {
     schemas: 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.
  */
@@ -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;
@@ -73,7 +101,7 @@ var MethodTypings = /** @class */ (function () {
                 var schema = _a.schema;
                 return (0, utils_2.languageSafeName)((0, utils_2.getTitle)((0, titleizer_1.default)(schema)));
             }),
-            result: (0, utils_2.languageSafeName)((0, utils_2.getTitle)((0, 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/openrpc.fixture.d.ts

@@ -1,3 +1,3 @@
-import { OpenrpcDocument as OpenRPC } from "@open-rpc/meta-schema";
+import { OpenrpcDocument as OpenRPC } from "./types";
 declare const testOpenRPCDocument: OpenRPC;
 export default testOpenRPCDocument;

package/build/python.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getParamsTypings = exports.getParamsTyping = exports.getMethodAliasName = exports.getMethodTypings = void 0;
 var utils_1 = require("@json-schema-tools/transpiler/build/utils");
-var getMethodTyping = function (method) {
+var getMethodTyping = function (_method) {
     return "";
 };
 var getMethodTypings = function (openrpcDocument) {
@@ -15,11 +15,11 @@ var getMethodAliasName = function (method) {
     return (0, utils_1.languageSafeName)(method.name);
 };
 exports.getMethodAliasName = getMethodAliasName;
-var getParamsTyping = function (method) {
+var getParamsTyping = function (_method) {
     return "";
 };
 exports.getParamsTyping = getParamsTyping;
-var getParamsTypings = function (method) {
+var getParamsTypings = function (_method) {
     return "";
 };
 exports.getParamsTypings = getParamsTypings;

package/build/rust.js

@@ -27,9 +27,12 @@ var getParamsTyping = function (method) {
 };
 var getMethodTyping = function (method) {
     var mResult = method.result;
-    var mutableSchema = (mResult.schema === true || mResult.schema === false) ? mResult.schema : __assign({}, mResult.schema);
-    var resultName = (0, utils_1.getTitle)((0, titleizer_1.default)(mutableSchema));
-    var result = "RpcRequest<".concat((0, utils_1.languageSafeName)(resultName), ">");
+    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) ? ", ".concat(params) : "";

package/build/types.d.ts

@@ -0,0 +1,5 @@
+import { V1_3, V1_4 } from "@open-rpc/spec-types";
+export type OpenrpcDocument = V1_3.OpenrpcDocument | V1_4.OpenrpcDocument;
+export type MethodObject = V1_3.MethodObject | V1_4.MethodObject;
+export type JSONSchema = V1_3.JSONSchema | V1_4.JSONSchema;
+export type ContentDescriptorObject = V1_3.ContentDescriptorObject | V1_4.ContentDescriptorObject;

package/build/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/typescript.js

@@ -29,12 +29,15 @@ var getParamsTyping = function (method, 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 = (0, utils_1.getTitle)((0, titleizer_1.default)(mutableSchema));
-    var resultTypeName = "Promise<".concat((0, utils_1.languageSafeName)(resultName), ">");
     var methodAliasName = (0, exports.getMethodAliasName)(method);
     var params = getParamsTyping(method);
+    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) {

package/build/utils.d.ts

@@ -1,4 +1,4 @@
-import { JSONSchema, OpenrpcDocument } from "@open-rpc/meta-schema";
+import { JSONSchema, OpenrpcDocument } from "./types";
 export declare const flatten: (arr: any[]) => any[];
 export declare const getSchemasForOpenRPCDocument: (openrpcDocument: OpenrpcDocument) => JSONSchema[];
 export declare const deepClone: (obj: any, hash?: WeakMap<object, any>) => any;

package/build/utils.js

@@ -36,7 +36,7 @@ exports.flatten = flatten;
 var getSchemasForOpenRPCDocument = function (openrpcDocument) {
     var methods = openrpcDocument.methods;
     var params = (0, exports.flatten)(methods.map(function (method) { return method.params; }));
-    var result = methods.map(function (method) { return method.result; });
+    var result = methods.map(function (method) { return method.result; }).filter(function (result) { return result !== undefined; });
     return params
         .concat(result)
         .map(function (_a) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@open-rpc/typings",
   "private": false,
-  "version": "1.12.4",
+  "version": "1.13.1",
   "description": "",
   "main": "build/index.js",
   "bin": {
@@ -31,19 +31,22 @@
   "dependencies": {
     "@json-schema-tools/titleizer": "1.0.9",
     "@json-schema-tools/transpiler": "^1.10.5",
-    "@open-rpc/schema-utils-js": "2.0.2",
+    "@open-rpc/schema-utils-js": "2.2.1",
     "commander": "^6.0.0",
     "fs-extra": "^10.0.0"
   },
   "devDependencies": {
+    "eslint": "^8.57.0",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
     "@open-rpc/examples": "1.7.2",
-    "@open-rpc/meta-schema": "1.14.9",
+    "@open-rpc/spec-types": "0.0.2",
     "@types/commander": "^2.12.2",
     "@types/fs-extra": "^9.0.1",
     "@types/jest": "^29.5.12",
     "jest": "^29.1.2",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "29.4.6",
     "typedoc": "0.25.13",
-    "typescript": "4.9.5"
+    "typescript": "5.4.5"
   }
 }