@open-rpc/typings 1.12.3 → 1.12.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cli.js +3 -3
- package/build/generate-typings-file.js +4 -4
- package/build/generator-interface.d.ts +4 -4
- package/build/go.js +6 -6
- package/build/index.d.ts +1 -1
- package/build/index.js +4 -4
- package/build/python.js +1 -1
- package/build/rust.js +7 -7
- package/build/typescript.js +7 -7
- package/build/utils.js +14 -10
- package/package.json +11 -11
package/build/cli.js
CHANGED
|
@@ -15,7 +15,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
15
15
|
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
16
16
|
function step(op) {
|
|
17
17
|
if (f) throw new TypeError("Generator is already executing.");
|
|
18
|
-
while (_) try {
|
|
18
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
19
19
|
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;
|
|
20
20
|
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
21
21
|
switch (op[0]) {
|
|
@@ -82,11 +82,11 @@ commander_1.default
|
|
|
82
82
|
switch (_a.label) {
|
|
83
83
|
case 0:
|
|
84
84
|
_a.trys.push([0, 3, , 4]);
|
|
85
|
-
return [4 /*yield*/, schema_utils_js_1.parseOpenRPCDocument(commander_1.default.document)];
|
|
85
|
+
return [4 /*yield*/, (0, schema_utils_js_1.parseOpenRPCDocument)(commander_1.default.document)];
|
|
86
86
|
case 1:
|
|
87
87
|
openrpcDocument = _a.sent();
|
|
88
88
|
typingsOptions = parseTypingsOptions(commander_1.default);
|
|
89
|
-
return [4 /*yield*/, generate_typings_file_1.generateTypingsFile(openrpcDocument, typingsOptions)];
|
|
89
|
+
return [4 /*yield*/, (0, generate_typings_file_1.generateTypingsFile)(openrpcDocument, typingsOptions)];
|
|
90
90
|
case 2:
|
|
91
91
|
_a.sent();
|
|
92
92
|
console.log("Done!"); // tslint:disable-line
|
|
@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
14
14
|
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
15
15
|
function step(op) {
|
|
16
16
|
if (f) throw new TypeError("Generator is already executing.");
|
|
17
|
-
while (_) try {
|
|
17
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
18
18
|
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;
|
|
19
19
|
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
20
20
|
switch (op[0]) {
|
|
@@ -63,12 +63,12 @@ function generateTypingsFile(openrpcDocument, options) {
|
|
|
63
63
|
var typings, typingsFileName;
|
|
64
64
|
return __generator(this, function (_a) {
|
|
65
65
|
switch (_a.label) {
|
|
66
|
-
case 0: return [4 /*yield*/, fs_extra_1.ensureDir(option.dirName)];
|
|
66
|
+
case 0: return [4 /*yield*/, (0, fs_extra_1.ensureDir)(option.dirName)];
|
|
67
67
|
case 1:
|
|
68
68
|
_a.sent();
|
|
69
69
|
typings = methodTypings.toString(option.lang);
|
|
70
|
-
typingsFileName = option.dirName
|
|
71
|
-
return [4 /*yield*/, fs_extra_1.writeFile(typingsFileName, typings, "utf8")];
|
|
70
|
+
typingsFileName = "".concat(option.dirName, "/").concat(option.fileName).concat(getExtension(option.lang));
|
|
71
|
+
return [4 /*yield*/, (0, fs_extra_1.writeFile)(typingsFileName, typings, "utf8")];
|
|
72
72
|
case 2: return [2 /*return*/, _a.sent()];
|
|
73
73
|
}
|
|
74
74
|
});
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { OpenrpcDocument as OpenRPC, MethodObject } from "@open-rpc/meta-schema";
|
|
2
|
-
export
|
|
3
|
-
export
|
|
4
|
-
export
|
|
5
|
-
export
|
|
2
|
+
export type GetMethodTypings = (openrpcSchema: OpenRPC) => string;
|
|
3
|
+
export type GetParamsTypings = (openrpcSchema: OpenRPC) => string;
|
|
4
|
+
export type GetParamsTyping = (method: MethodObject, joinString?: string) => string;
|
|
5
|
+
export type GetMethodAliasName = (method: MethodObject) => string;
|
|
6
6
|
export interface Generator {
|
|
7
7
|
getMethodTypings: GetMethodTypings;
|
|
8
8
|
getMethodAliasName: GetMethodAliasName;
|
package/build/go.js
CHANGED
|
@@ -18,25 +18,25 @@ exports.getParamsTypings = exports.getMethodTypings = exports.getMethodAliasName
|
|
|
18
18
|
var utils_1 = require("@json-schema-tools/transpiler/build/utils");
|
|
19
19
|
var titleizer_1 = __importDefault(require("@json-schema-tools/titleizer"));
|
|
20
20
|
var getMethodAliasName = function (method) {
|
|
21
|
-
return utils_1.languageSafeName(method.name);
|
|
21
|
+
return (0, utils_1.languageSafeName)(method.name);
|
|
22
22
|
};
|
|
23
23
|
exports.getMethodAliasName = getMethodAliasName;
|
|
24
24
|
var getParamsTyping = function (method) {
|
|
25
|
-
var params = method.params.map(function (param) { return param.name
|
|
25
|
+
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(", ");
|
|
26
26
|
return params;
|
|
27
27
|
};
|
|
28
28
|
var getMethodTyping = function (method) {
|
|
29
29
|
var mResult = method.result;
|
|
30
30
|
var mutableSchema = (mResult.schema === true || mResult.schema === false) ? mResult.schema : __assign({}, mResult.schema);
|
|
31
|
-
var resultName = utils_1.languageSafeName(utils_1.getTitle(titleizer_1.default(mutableSchema)));
|
|
32
|
-
var methodAliasName = exports.getMethodAliasName(method);
|
|
31
|
+
var resultName = (0, utils_1.languageSafeName)((0, utils_1.getTitle)((0, titleizer_1.default)(mutableSchema)));
|
|
32
|
+
var methodAliasName = (0, exports.getMethodAliasName)(method);
|
|
33
33
|
var params = getParamsTyping(method);
|
|
34
|
-
return "\t"
|
|
34
|
+
return "\t".concat(methodAliasName, "(").concat(params, ") (").concat(resultName, ", error)");
|
|
35
35
|
};
|
|
36
36
|
var getMethodTypings = function (openrpcDocument) {
|
|
37
37
|
var fns = openrpcDocument.methods.map(getMethodTyping);
|
|
38
38
|
return [
|
|
39
|
-
"type "
|
|
39
|
+
"type ".concat((0, utils_1.languageSafeName)(openrpcDocument.info.title), " interface {"),
|
|
40
40
|
fns.join("\n"),
|
|
41
41
|
"}",
|
|
42
42
|
].join("\n");
|
package/build/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { OpenrpcDocument as OpenRPC, MethodObject } from "@open-rpc/meta-schema";
|
|
2
|
-
export
|
|
2
|
+
export type OpenRPCTypingsSupportedLanguages = "rust" | "rs" | "typescript" | "ts" | "go" | "golang" | "py" | "python";
|
|
3
3
|
interface OpenRPCTypings {
|
|
4
4
|
schemas: string;
|
|
5
5
|
methods: string;
|
package/build/index.js
CHANGED
|
@@ -27,8 +27,8 @@ var MethodTypings = /** @class */ (function () {
|
|
|
27
27
|
includeMethodAliasTypings: true,
|
|
28
28
|
includeSchemaTypings: true,
|
|
29
29
|
};
|
|
30
|
-
var schemas = utils_1.getSchemasForOpenRPCDocument(openrpcDocument);
|
|
31
|
-
this.transpiler = new transpiler_1.default(utils_1.deepClone(schemas));
|
|
30
|
+
var schemas = (0, utils_1.getSchemasForOpenRPCDocument)(openrpcDocument);
|
|
31
|
+
this.transpiler = new transpiler_1.default((0, utils_1.deepClone)(schemas));
|
|
32
32
|
}
|
|
33
33
|
/**
|
|
34
34
|
* A method that returns all the typings for the schemas in an [[OpenRPC]] Document.
|
|
@@ -71,9 +71,9 @@ var MethodTypings = /** @class */ (function () {
|
|
|
71
71
|
method: gen.getMethodAliasName(defaultedMethod),
|
|
72
72
|
params: methodParams.map(function (_a) {
|
|
73
73
|
var schema = _a.schema;
|
|
74
|
-
return utils_2.languageSafeName(utils_2.getTitle(titleizer_1.default(schema)));
|
|
74
|
+
return (0, utils_2.languageSafeName)((0, utils_2.getTitle)((0, titleizer_1.default)(schema)));
|
|
75
75
|
}),
|
|
76
|
-
result: utils_2.languageSafeName(utils_2.getTitle(titleizer_1.default(methodResult.schema))),
|
|
76
|
+
result: (0, utils_2.languageSafeName)((0, utils_2.getTitle)((0, titleizer_1.default)(methodResult.schema))),
|
|
77
77
|
};
|
|
78
78
|
};
|
|
79
79
|
/**
|
package/build/python.js
CHANGED
|
@@ -12,7 +12,7 @@ var getMethodTypings = function (openrpcDocument) {
|
|
|
12
12
|
};
|
|
13
13
|
exports.getMethodTypings = getMethodTypings;
|
|
14
14
|
var getMethodAliasName = function (method) {
|
|
15
|
-
return utils_1.languageSafeName(method.name);
|
|
15
|
+
return (0, utils_1.languageSafeName)(method.name);
|
|
16
16
|
};
|
|
17
17
|
exports.getMethodAliasName = getMethodAliasName;
|
|
18
18
|
var getParamsTyping = function (method) {
|
package/build/rust.js
CHANGED
|
@@ -18,22 +18,22 @@ exports.getParamsTypings = exports.getMethodTypings = exports.getMethodAliasName
|
|
|
18
18
|
var utils_1 = require("@json-schema-tools/transpiler/build/utils");
|
|
19
19
|
var titleizer_1 = __importDefault(require("@json-schema-tools/titleizer"));
|
|
20
20
|
var getMethodAliasName = function (method) {
|
|
21
|
-
return utils_1.languageSafeName(method.name);
|
|
21
|
+
return (0, utils_1.languageSafeName)(method.name);
|
|
22
22
|
};
|
|
23
23
|
exports.getMethodAliasName = getMethodAliasName;
|
|
24
24
|
var getParamsTyping = function (method) {
|
|
25
|
-
var params = method.params.map(function (param) { return param.name
|
|
25
|
+
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(", ");
|
|
26
26
|
return params;
|
|
27
27
|
};
|
|
28
28
|
var getMethodTyping = function (method) {
|
|
29
29
|
var mResult = method.result;
|
|
30
30
|
var mutableSchema = (mResult.schema === true || mResult.schema === false) ? mResult.schema : __assign({}, mResult.schema);
|
|
31
|
-
var resultName = utils_1.getTitle(titleizer_1.default(mutableSchema));
|
|
32
|
-
var result = "RpcRequest<"
|
|
33
|
-
var methodAliasName = exports.getMethodAliasName(method);
|
|
31
|
+
var resultName = (0, utils_1.getTitle)((0, titleizer_1.default)(mutableSchema));
|
|
32
|
+
var result = "RpcRequest<".concat((0, utils_1.languageSafeName)(resultName), ">");
|
|
33
|
+
var methodAliasName = (0, exports.getMethodAliasName)(method);
|
|
34
34
|
var params = getParamsTyping(method);
|
|
35
|
-
var paramString = (params.length > 0) ? ", "
|
|
36
|
-
return "pub fn "
|
|
35
|
+
var paramString = (params.length > 0) ? ", ".concat(params) : "";
|
|
36
|
+
return "pub fn ".concat(methodAliasName, "(&mut self").concat(paramString, ") -> ").concat(result, ";");
|
|
37
37
|
};
|
|
38
38
|
var getMethodTypings = function (openrpcDocument) {
|
|
39
39
|
return openrpcDocument.methods
|
package/build/typescript.js
CHANGED
|
@@ -18,24 +18,24 @@ exports.getParamsTypings = exports.getMethodTypings = exports.getMethodAliasName
|
|
|
18
18
|
var utils_1 = require("@json-schema-tools/transpiler/build/utils");
|
|
19
19
|
var titleizer_1 = __importDefault(require("@json-schema-tools/titleizer"));
|
|
20
20
|
var getMethodAliasName = function (method) {
|
|
21
|
-
return utils_1.languageSafeName(method.name);
|
|
21
|
+
return (0, utils_1.languageSafeName)(method.name);
|
|
22
22
|
};
|
|
23
23
|
exports.getMethodAliasName = getMethodAliasName;
|
|
24
24
|
var getParamsTyping = function (method, joinString) {
|
|
25
25
|
var params = method.params.map(function (param) { return [
|
|
26
|
-
""
|
|
27
|
-
""
|
|
26
|
+
"".concat(param.name).concat(param.required === false ? "?" : "", ": "),
|
|
27
|
+
"".concat((0, utils_1.languageSafeName)((0, utils_1.getTitle)((0, titleizer_1.default)(param.schema)))),
|
|
28
28
|
].join(""); }).join(joinString || ", ");
|
|
29
29
|
return params;
|
|
30
30
|
};
|
|
31
31
|
var getMethodTyping = function (method) {
|
|
32
32
|
var result = method.result;
|
|
33
33
|
var mutableSchema = (result.schema === true || result.schema === false) ? result.schema : __assign({}, result.schema);
|
|
34
|
-
var resultName = utils_1.getTitle(titleizer_1.default(mutableSchema));
|
|
35
|
-
var resultTypeName = "Promise<"
|
|
36
|
-
var methodAliasName = exports.getMethodAliasName(method);
|
|
34
|
+
var resultName = (0, utils_1.getTitle)((0, titleizer_1.default)(mutableSchema));
|
|
35
|
+
var resultTypeName = "Promise<".concat((0, utils_1.languageSafeName)(resultName), ">");
|
|
36
|
+
var methodAliasName = (0, exports.getMethodAliasName)(method);
|
|
37
37
|
var params = getParamsTyping(method);
|
|
38
|
-
return "export type "
|
|
38
|
+
return "export type ".concat(methodAliasName, " = (").concat(params, ") => ").concat(resultTypeName, ";");
|
|
39
39
|
};
|
|
40
40
|
var getMethodTypings = function (openrpcDocument) {
|
|
41
41
|
return openrpcDocument.methods
|
package/build/utils.js
CHANGED
|
@@ -10,17 +10,21 @@ var __assign = (this && this.__assign) || function () {
|
|
|
10
10
|
};
|
|
11
11
|
return __assign.apply(this, arguments);
|
|
12
12
|
};
|
|
13
|
-
var __spreadArray = (this && this.__spreadArray) || function (to, from) {
|
|
14
|
-
for (var i = 0,
|
|
15
|
-
|
|
16
|
-
|
|
13
|
+
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
|
14
|
+
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
|
|
15
|
+
if (ar || !(i in from)) {
|
|
16
|
+
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
|
|
17
|
+
ar[i] = from[i];
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
return to.concat(ar || Array.prototype.slice.call(from));
|
|
17
21
|
};
|
|
18
22
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
23
|
exports.deepClone = exports.getSchemasForOpenRPCDocument = exports.flatten = void 0;
|
|
20
24
|
var flatten = function (arr) {
|
|
21
25
|
return arr.reduce(function (memo, val) {
|
|
22
26
|
if (val instanceof Array) {
|
|
23
|
-
return __spreadArray(__spreadArray([], memo), val);
|
|
27
|
+
return __spreadArray(__spreadArray([], memo, true), val, true);
|
|
24
28
|
}
|
|
25
29
|
else {
|
|
26
30
|
memo.push(val);
|
|
@@ -31,7 +35,7 @@ var flatten = function (arr) {
|
|
|
31
35
|
exports.flatten = flatten;
|
|
32
36
|
var getSchemasForOpenRPCDocument = function (openrpcDocument) {
|
|
33
37
|
var methods = openrpcDocument.methods;
|
|
34
|
-
var params = exports.flatten(methods.map(function (method) { return method.params; }));
|
|
38
|
+
var params = (0, exports.flatten)(methods.map(function (method) { return method.params; }));
|
|
35
39
|
var result = methods.map(function (method) { return method.result; });
|
|
36
40
|
return params
|
|
37
41
|
.concat(result)
|
|
@@ -52,7 +56,7 @@ var deepClone = function (obj, hash) {
|
|
|
52
56
|
return hash.get(obj);
|
|
53
57
|
var result = Object(null);
|
|
54
58
|
if (obj instanceof Array) {
|
|
55
|
-
result = obj.map(function (o) { return exports.deepClone(o, hash); });
|
|
59
|
+
result = obj.map(function (o) { return (0, exports.deepClone)(o, hash); });
|
|
56
60
|
}
|
|
57
61
|
else if (obj instanceof Set) {
|
|
58
62
|
result = new Set(obj);
|
|
@@ -60,7 +64,7 @@ var deepClone = function (obj, hash) {
|
|
|
60
64
|
else if (obj instanceof Map) {
|
|
61
65
|
result = new Map(Array.from(obj, function (_a) {
|
|
62
66
|
var key = _a[0], val = _a[1];
|
|
63
|
-
return [key, exports.deepClone(val, hash)];
|
|
67
|
+
return [key, (0, exports.deepClone)(val, hash)];
|
|
64
68
|
}));
|
|
65
69
|
}
|
|
66
70
|
else if (obj instanceof Date) {
|
|
@@ -75,7 +79,7 @@ var deepClone = function (obj, hash) {
|
|
|
75
79
|
hash.set(obj, result);
|
|
76
80
|
return Object.assign.apply(Object, __spreadArray([result], Object.keys(obj).map(function (key) {
|
|
77
81
|
var _a;
|
|
78
|
-
return (_a = {}, _a[key] = exports.deepClone(obj[key], hash), _a);
|
|
79
|
-
})));
|
|
82
|
+
return (_a = {}, _a[key] = (0, exports.deepClone)(obj[key], hash), _a);
|
|
83
|
+
}), false));
|
|
80
84
|
};
|
|
81
85
|
exports.deepClone = deepClone;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@open-rpc/typings",
|
|
3
3
|
"private": false,
|
|
4
|
-
"version": "1.12.
|
|
4
|
+
"version": "1.12.4",
|
|
5
5
|
"description": "",
|
|
6
6
|
"main": "build/index.js",
|
|
7
7
|
"bin": {
|
|
@@ -29,21 +29,21 @@
|
|
|
29
29
|
},
|
|
30
30
|
"homepage": "https://github.com/open-rpc/typings#readme",
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@json-schema-tools/titleizer": "1.0.
|
|
33
|
-
"@json-schema-tools/transpiler": "^1.10.
|
|
34
|
-
"@open-rpc/schema-utils-js": "
|
|
32
|
+
"@json-schema-tools/titleizer": "1.0.9",
|
|
33
|
+
"@json-schema-tools/transpiler": "^1.10.5",
|
|
34
|
+
"@open-rpc/schema-utils-js": "2.0.2",
|
|
35
35
|
"commander": "^6.0.0",
|
|
36
36
|
"fs-extra": "^10.0.0"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
|
-
"@open-rpc/examples": "1.
|
|
40
|
-
"@open-rpc/meta-schema": "1.14.
|
|
39
|
+
"@open-rpc/examples": "1.7.2",
|
|
40
|
+
"@open-rpc/meta-schema": "1.14.9",
|
|
41
41
|
"@types/commander": "^2.12.2",
|
|
42
42
|
"@types/fs-extra": "^9.0.1",
|
|
43
|
-
"@types/jest": "^
|
|
44
|
-
"jest": "^
|
|
45
|
-
"ts-jest": "^
|
|
46
|
-
"typedoc": "0.
|
|
47
|
-
"typescript": "4.
|
|
43
|
+
"@types/jest": "^29.5.12",
|
|
44
|
+
"jest": "^29.1.2",
|
|
45
|
+
"ts-jest": "^29.1.2",
|
|
46
|
+
"typedoc": "0.25.13",
|
|
47
|
+
"typescript": "4.9.5"
|
|
48
48
|
}
|
|
49
49
|
}
|