@qevm/properties 5.7.1
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/LICENSE.md +21 -0
- package/README.md +42 -0
- package/lib/_version.d.ts +2 -0
- package/lib/_version.d.ts.map +1 -0
- package/lib/_version.js +5 -0
- package/lib/_version.js.map +1 -0
- package/lib/index.d.ts +17 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +130 -0
- package/lib/index.js.map +1 -0
- package/package.json +30 -0
- package/src.ts/_version.ts +1 -0
- package/src.ts/index.ts +172 -0
package/LICENSE.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2019 Richard Moore
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
Property Utilities
|
|
2
|
+
==================
|
|
3
|
+
|
|
4
|
+
This sub-module is part of the qethers, a fork of [ethers project](https://github.com/ethers-io/ethers.js).
|
|
5
|
+
|
|
6
|
+
It contains several useful utility methods for managing simple objects with
|
|
7
|
+
defined properties.
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
Importing
|
|
11
|
+
---------
|
|
12
|
+
|
|
13
|
+
Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/@qevm/qethers),
|
|
14
|
+
but for those with more specific needs, individual components can be imported.
|
|
15
|
+
|
|
16
|
+
```javascript
|
|
17
|
+
const {
|
|
18
|
+
|
|
19
|
+
defineReadOnly,
|
|
20
|
+
|
|
21
|
+
getStatic,
|
|
22
|
+
|
|
23
|
+
resolveProperties,
|
|
24
|
+
checkProperties,
|
|
25
|
+
|
|
26
|
+
shallowCopy,
|
|
27
|
+
deepCopy,
|
|
28
|
+
|
|
29
|
+
Description,
|
|
30
|
+
|
|
31
|
+
// Types
|
|
32
|
+
|
|
33
|
+
Deferrable
|
|
34
|
+
|
|
35
|
+
} = require("@qevm/properties");
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
License
|
|
40
|
+
-------
|
|
41
|
+
|
|
42
|
+
MIT License
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"_version.d.ts","sourceRoot":"","sources":["../src.ts/_version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,qBAAqB,CAAC"}
|
package/lib/_version.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"_version.js","sourceRoot":"","sources":["../src.ts/_version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,kBAAkB,CAAC"}
|
package/lib/index.d.ts
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
export declare function defineReadOnly<T, K extends keyof T>(object: T, name: K, value: T[K]): void;
|
|
2
|
+
export declare function getStatic<T>(ctor: any, key: string): T;
|
|
3
|
+
export type Deferrable<T> = {
|
|
4
|
+
[K in keyof T]: T[K] | Promise<T[K]>;
|
|
5
|
+
};
|
|
6
|
+
export declare function resolveProperties<T>(object: Readonly<Deferrable<T>>): Promise<T>;
|
|
7
|
+
export declare function checkProperties(object: any, properties: {
|
|
8
|
+
[name: string]: boolean;
|
|
9
|
+
}): void;
|
|
10
|
+
export declare function shallowCopy<T>(object: T): T;
|
|
11
|
+
export declare function deepCopy<T>(object: T): T;
|
|
12
|
+
export declare class Description<T = any> {
|
|
13
|
+
constructor(info: {
|
|
14
|
+
[K in keyof T]: T[K];
|
|
15
|
+
});
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src.ts/index.ts"],"names":[],"mappings":"AAMA,wBAAgB,cAAc,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,EAC/C,MAAM,EAAE,CAAC,EACT,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GACZ,IAAI,CAMN;AAGD,wBAAgB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,CAWtD;AAED,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACvC,CAAC;AAIF,wBAAsB,iBAAiB,CAAC,CAAC,EACrC,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAChC,OAAO,CAAC,CAAC,CAAC,CAeZ;AAED,wBAAgB,eAAe,CAC3B,MAAM,EAAE,GAAG,EACX,UAAU,EAAE;IAAE,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,GACxC,IAAI,CAcN;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAM3C;AA+ED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAExC;AAED,qBAAa,WAAW,CAAC,CAAC,GAAG,GAAG;gBAChB,IAAI,EAAE;SAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KAAE;CAK7C"}
|
package/lib/index.js
ADDED
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Description = void 0;
|
|
4
|
+
exports.defineReadOnly = defineReadOnly;
|
|
5
|
+
exports.getStatic = getStatic;
|
|
6
|
+
exports.resolveProperties = resolveProperties;
|
|
7
|
+
exports.checkProperties = checkProperties;
|
|
8
|
+
exports.shallowCopy = shallowCopy;
|
|
9
|
+
exports.deepCopy = deepCopy;
|
|
10
|
+
const logger_1 = require("@qevm/logger");
|
|
11
|
+
const _version_1 = require("./_version");
|
|
12
|
+
const logger = new logger_1.Logger(_version_1.version);
|
|
13
|
+
function defineReadOnly(object, name, value) {
|
|
14
|
+
Object.defineProperty(object, name, {
|
|
15
|
+
enumerable: true,
|
|
16
|
+
value: value,
|
|
17
|
+
writable: false,
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
// Crawl up the constructor chain to find a static method
|
|
21
|
+
function getStatic(ctor, key) {
|
|
22
|
+
for (let i = 0; i < 32; i++) {
|
|
23
|
+
if (ctor[key]) {
|
|
24
|
+
return ctor[key];
|
|
25
|
+
}
|
|
26
|
+
if (!ctor.prototype || typeof ctor.prototype !== "object") {
|
|
27
|
+
break;
|
|
28
|
+
}
|
|
29
|
+
ctor = Object.getPrototypeOf(ctor.prototype).constructor;
|
|
30
|
+
}
|
|
31
|
+
return null;
|
|
32
|
+
}
|
|
33
|
+
async function resolveProperties(object) {
|
|
34
|
+
const promises = Object.keys(object).map((key) => {
|
|
35
|
+
const value = object[key];
|
|
36
|
+
return Promise.resolve(value).then((v) => ({ key: key, value: v }));
|
|
37
|
+
});
|
|
38
|
+
const results = await Promise.all(promises);
|
|
39
|
+
return results.reduce((accum, result) => {
|
|
40
|
+
accum[result.key] = result.value;
|
|
41
|
+
return accum;
|
|
42
|
+
}, {});
|
|
43
|
+
}
|
|
44
|
+
function checkProperties(object, properties) {
|
|
45
|
+
if (!object || typeof object !== "object") {
|
|
46
|
+
logger.throwArgumentError("invalid object", "object", object);
|
|
47
|
+
}
|
|
48
|
+
Object.keys(object).forEach((key) => {
|
|
49
|
+
if (!properties[key]) {
|
|
50
|
+
logger.throwArgumentError("invalid object key - " + key, "transaction:" + key, object);
|
|
51
|
+
}
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
function shallowCopy(object) {
|
|
55
|
+
const result = {};
|
|
56
|
+
for (const key in object) {
|
|
57
|
+
result[key] = object[key];
|
|
58
|
+
}
|
|
59
|
+
return result;
|
|
60
|
+
}
|
|
61
|
+
const opaque = {
|
|
62
|
+
bigint: true,
|
|
63
|
+
boolean: true,
|
|
64
|
+
function: true,
|
|
65
|
+
number: true,
|
|
66
|
+
string: true,
|
|
67
|
+
};
|
|
68
|
+
function _isFrozen(object) {
|
|
69
|
+
// Opaque objects are not mutable, so safe to copy by assignment
|
|
70
|
+
if (object === undefined || object === null || opaque[typeof object]) {
|
|
71
|
+
return true;
|
|
72
|
+
}
|
|
73
|
+
if (Array.isArray(object) || typeof object === "object") {
|
|
74
|
+
if (!Object.isFrozen(object)) {
|
|
75
|
+
return false;
|
|
76
|
+
}
|
|
77
|
+
const keys = Object.keys(object);
|
|
78
|
+
for (let i = 0; i < keys.length; i++) {
|
|
79
|
+
let value = null;
|
|
80
|
+
try {
|
|
81
|
+
value = object[keys[i]];
|
|
82
|
+
}
|
|
83
|
+
catch (error) {
|
|
84
|
+
// If accessing a value triggers an error, it is a getter
|
|
85
|
+
// designed to do so (e.g. Result) and is therefore "frozen"
|
|
86
|
+
continue;
|
|
87
|
+
}
|
|
88
|
+
if (!_isFrozen(value)) {
|
|
89
|
+
return false;
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
return true;
|
|
93
|
+
}
|
|
94
|
+
return logger.throwArgumentError(`Cannot deepCopy ${typeof object}`, "object", object);
|
|
95
|
+
}
|
|
96
|
+
// Returns a new copy of object, such that no properties may be replaced.
|
|
97
|
+
// New properties may be added only to objects.
|
|
98
|
+
function _deepCopy(object) {
|
|
99
|
+
if (_isFrozen(object)) {
|
|
100
|
+
return object;
|
|
101
|
+
}
|
|
102
|
+
// Arrays are mutable, so we need to create a copy
|
|
103
|
+
if (Array.isArray(object)) {
|
|
104
|
+
return Object.freeze(object.map((item) => deepCopy(item)));
|
|
105
|
+
}
|
|
106
|
+
if (typeof object === "object") {
|
|
107
|
+
const result = {};
|
|
108
|
+
for (const key in object) {
|
|
109
|
+
const value = object[key];
|
|
110
|
+
if (value === undefined) {
|
|
111
|
+
continue;
|
|
112
|
+
}
|
|
113
|
+
defineReadOnly(result, key, deepCopy(value));
|
|
114
|
+
}
|
|
115
|
+
return result;
|
|
116
|
+
}
|
|
117
|
+
return logger.throwArgumentError(`Cannot deepCopy ${typeof object}`, "object", object);
|
|
118
|
+
}
|
|
119
|
+
function deepCopy(object) {
|
|
120
|
+
return _deepCopy(object);
|
|
121
|
+
}
|
|
122
|
+
class Description {
|
|
123
|
+
constructor(info) {
|
|
124
|
+
for (const key in info) {
|
|
125
|
+
this[key] = deepCopy(info[key]);
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
exports.Description = Description;
|
|
130
|
+
//# sourceMappingURL=index.js.map
|
package/lib/index.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src.ts/index.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;AAMb,wCAUC;AAGD,8BAWC;AAQD,8CAiBC;AAED,0CAiBC;AAED,kCAMC;AA+ED,4BAEC;AAjKD,yCAAsC;AACtC,yCAAqC;AACrC,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC,kBAAO,CAAC,CAAC;AAEnC,SAAgB,cAAc,CAC1B,MAAS,EACT,IAAO,EACP,KAAW;IAEX,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE;QAChC,UAAU,EAAE,IAAI;QAChB,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,KAAK;KAClB,CAAC,CAAC;AACP,CAAC;AAED,yDAAyD;AACzD,SAAgB,SAAS,CAAI,IAAS,EAAE,GAAW;IAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YACxD,MAAM;QACV,CAAC;QACD,IAAI,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC;IAC7D,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAQM,KAAK,UAAU,iBAAiB,CACnC,MAA+B;IAE/B,MAAM,QAAQ,GAA2B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACrE,MAAM,KAAK,GAAG,MAAM,CAAsB,GAAG,CAAC,CAAC;QAC/C,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE5C,OAAO,OAAO,CAAC,MAAM,CACjB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QACd,KAAK,CAAU,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;QAC1C,OAAO,KAAK,CAAC;IACjB,CAAC,EACE,EAAE,CACR,CAAC;AACN,CAAC;AAED,SAAgB,eAAe,CAC3B,MAAW,EACX,UAAuC;IAEvC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QACxC,MAAM,CAAC,kBAAkB,CAAC,gBAAgB,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAChC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACnB,MAAM,CAAC,kBAAkB,CACrB,uBAAuB,GAAG,GAAG,EAC7B,cAAc,GAAG,GAAG,EACpB,MAAM,CACT,CAAC;QACN,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAgB,WAAW,CAAI,MAAS;IACpC,MAAM,MAAM,GAAQ,EAAE,CAAC;IACvB,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACvB,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,MAAM,MAAM,GAA+B;IACvC,MAAM,EAAE,IAAI;IACZ,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;CACf,CAAC;AAEF,SAAS,SAAS,CAAC,MAAW;IAC1B,gEAAgE;IAChE,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,OAAO,MAAM,CAAC,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QACtD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACnC,IAAI,KAAK,GAAQ,IAAI,CAAC;YACtB,IAAI,CAAC;gBACD,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,yDAAyD;gBACzD,4DAA4D;gBAC5D,SAAS;YACb,CAAC;YAED,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;gBACpB,OAAO,KAAK,CAAC;YACjB,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,MAAM,CAAC,kBAAkB,CAC5B,mBAAmB,OAAO,MAAM,EAAE,EAClC,QAAQ,EACR,MAAM,CACT,CAAC;AACN,CAAC;AAED,yEAAyE;AACzE,+CAA+C;AAC/C,SAAS,SAAS,CAAC,MAAW;IAC1B,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QACpB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,kDAAkD;IAClD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACxB,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC7B,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACvB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YAC1B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACtB,SAAS;YACb,CAAC;YACD,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACjD,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,OAAO,MAAM,CAAC,kBAAkB,CAC5B,mBAAmB,OAAO,MAAM,EAAE,EAClC,QAAQ,EACR,MAAM,CACT,CAAC;AACN,CAAC;AAED,SAAgB,QAAQ,CAAI,MAAS;IACjC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC;AAC7B,CAAC;AAED,MAAa,WAAW;IACpB,YAAY,IAA8B;QACtC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACf,IAAK,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3C,CAAC;IACL,CAAC;CACJ;AAND,kCAMC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
{
|
|
2
|
+
"contributors": [
|
|
3
|
+
"Eugene Kuleshov <kulevgen32@gmail.com>",
|
|
4
|
+
"Richard Moore <me@ricmoo.com>"
|
|
5
|
+
],
|
|
6
|
+
"dependencies": {
|
|
7
|
+
"@qevm/logger": "^5.7.1"
|
|
8
|
+
},
|
|
9
|
+
"description": "Properties utility functions for qethers.",
|
|
10
|
+
"keywords": [
|
|
11
|
+
"Ethereum",
|
|
12
|
+
"qethers"
|
|
13
|
+
],
|
|
14
|
+
"license": "MIT",
|
|
15
|
+
"main": "./lib/index.js",
|
|
16
|
+
"module": "./lib.esm/index.js",
|
|
17
|
+
"name": "@qevm/properties",
|
|
18
|
+
"publishConfig": {
|
|
19
|
+
"access": "public"
|
|
20
|
+
},
|
|
21
|
+
"scripts": {
|
|
22
|
+
"auto-build": "npm run build -- -w",
|
|
23
|
+
"build": "tsc -p ./tsconfig.json",
|
|
24
|
+
"test": "echo \"Error: no test specified\" && exit 1"
|
|
25
|
+
},
|
|
26
|
+
"sideEffects": false,
|
|
27
|
+
"tarballHash": "0xae19a78858ce5d385611b26f4f7d576681f7352281e38f0916bba8f3fa04f5b5",
|
|
28
|
+
"types": "./lib/index.d.ts",
|
|
29
|
+
"version": "5.7.1"
|
|
30
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export const version = "properties/5.7.1";
|
package/src.ts/index.ts
ADDED
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
import { Logger } from "@qevm/logger";
|
|
4
|
+
import { version } from "./_version";
|
|
5
|
+
const logger = new Logger(version);
|
|
6
|
+
|
|
7
|
+
export function defineReadOnly<T, K extends keyof T>(
|
|
8
|
+
object: T,
|
|
9
|
+
name: K,
|
|
10
|
+
value: T[K],
|
|
11
|
+
): void {
|
|
12
|
+
Object.defineProperty(object, name, {
|
|
13
|
+
enumerable: true,
|
|
14
|
+
value: value,
|
|
15
|
+
writable: false,
|
|
16
|
+
});
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
// Crawl up the constructor chain to find a static method
|
|
20
|
+
export function getStatic<T>(ctor: any, key: string): T {
|
|
21
|
+
for (let i = 0; i < 32; i++) {
|
|
22
|
+
if (ctor[key]) {
|
|
23
|
+
return ctor[key];
|
|
24
|
+
}
|
|
25
|
+
if (!ctor.prototype || typeof ctor.prototype !== "object") {
|
|
26
|
+
break;
|
|
27
|
+
}
|
|
28
|
+
ctor = Object.getPrototypeOf(ctor.prototype).constructor;
|
|
29
|
+
}
|
|
30
|
+
return null;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
export type Deferrable<T> = {
|
|
34
|
+
[K in keyof T]: T[K] | Promise<T[K]>;
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
type Result = { key: string; value: any };
|
|
38
|
+
|
|
39
|
+
export async function resolveProperties<T>(
|
|
40
|
+
object: Readonly<Deferrable<T>>,
|
|
41
|
+
): Promise<T> {
|
|
42
|
+
const promises: Array<Promise<Result>> = Object.keys(object).map((key) => {
|
|
43
|
+
const value = object[<keyof Deferrable<T>>key];
|
|
44
|
+
return Promise.resolve(value).then((v) => ({ key: key, value: v }));
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
const results = await Promise.all(promises);
|
|
48
|
+
|
|
49
|
+
return results.reduce(
|
|
50
|
+
(accum, result) => {
|
|
51
|
+
accum[<keyof T>result.key] = result.value;
|
|
52
|
+
return accum;
|
|
53
|
+
},
|
|
54
|
+
<T>{},
|
|
55
|
+
);
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export function checkProperties(
|
|
59
|
+
object: any,
|
|
60
|
+
properties: { [name: string]: boolean },
|
|
61
|
+
): void {
|
|
62
|
+
if (!object || typeof object !== "object") {
|
|
63
|
+
logger.throwArgumentError("invalid object", "object", object);
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
Object.keys(object).forEach((key) => {
|
|
67
|
+
if (!properties[key]) {
|
|
68
|
+
logger.throwArgumentError(
|
|
69
|
+
"invalid object key - " + key,
|
|
70
|
+
"transaction:" + key,
|
|
71
|
+
object,
|
|
72
|
+
);
|
|
73
|
+
}
|
|
74
|
+
});
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function shallowCopy<T>(object: T): T {
|
|
78
|
+
const result: any = {};
|
|
79
|
+
for (const key in object) {
|
|
80
|
+
result[key] = object[key];
|
|
81
|
+
}
|
|
82
|
+
return result;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
const opaque: { [key: string]: boolean } = {
|
|
86
|
+
bigint: true,
|
|
87
|
+
boolean: true,
|
|
88
|
+
function: true,
|
|
89
|
+
number: true,
|
|
90
|
+
string: true,
|
|
91
|
+
};
|
|
92
|
+
|
|
93
|
+
function _isFrozen(object: any): boolean {
|
|
94
|
+
// Opaque objects are not mutable, so safe to copy by assignment
|
|
95
|
+
if (object === undefined || object === null || opaque[typeof object]) {
|
|
96
|
+
return true;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
if (Array.isArray(object) || typeof object === "object") {
|
|
100
|
+
if (!Object.isFrozen(object)) {
|
|
101
|
+
return false;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
const keys = Object.keys(object);
|
|
105
|
+
for (let i = 0; i < keys.length; i++) {
|
|
106
|
+
let value: any = null;
|
|
107
|
+
try {
|
|
108
|
+
value = object[keys[i]];
|
|
109
|
+
} catch (error) {
|
|
110
|
+
// If accessing a value triggers an error, it is a getter
|
|
111
|
+
// designed to do so (e.g. Result) and is therefore "frozen"
|
|
112
|
+
continue;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
if (!_isFrozen(value)) {
|
|
116
|
+
return false;
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
return true;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
return logger.throwArgumentError(
|
|
124
|
+
`Cannot deepCopy ${typeof object}`,
|
|
125
|
+
"object",
|
|
126
|
+
object,
|
|
127
|
+
);
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
// Returns a new copy of object, such that no properties may be replaced.
|
|
131
|
+
// New properties may be added only to objects.
|
|
132
|
+
function _deepCopy(object: any): any {
|
|
133
|
+
if (_isFrozen(object)) {
|
|
134
|
+
return object;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
// Arrays are mutable, so we need to create a copy
|
|
138
|
+
if (Array.isArray(object)) {
|
|
139
|
+
return Object.freeze(object.map((item) => deepCopy(item)));
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
if (typeof object === "object") {
|
|
143
|
+
const result: { [key: string]: any } = {};
|
|
144
|
+
for (const key in object) {
|
|
145
|
+
const value = object[key];
|
|
146
|
+
if (value === undefined) {
|
|
147
|
+
continue;
|
|
148
|
+
}
|
|
149
|
+
defineReadOnly(result, key, deepCopy(value));
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
return result;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
return logger.throwArgumentError(
|
|
156
|
+
`Cannot deepCopy ${typeof object}`,
|
|
157
|
+
"object",
|
|
158
|
+
object,
|
|
159
|
+
);
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
export function deepCopy<T>(object: T): T {
|
|
163
|
+
return _deepCopy(object);
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
export class Description<T = any> {
|
|
167
|
+
constructor(info: { [K in keyof T]: T[K] }) {
|
|
168
|
+
for (const key in info) {
|
|
169
|
+
(<any>this)[key] = deepCopy(info[key]);
|
|
170
|
+
}
|
|
171
|
+
}
|
|
172
|
+
}
|