@hyperledger/cactus-core-api - npm Package Compare versions

Comparing version 0.4.2-main.b067fdd.29 to 0.5.0-alpha.0

CHANGELOG.md

@@ -6,2 +6,15 @@ # Change Log
 
+# [0.5.0-alpha.0](https://github.com/hyperledger/cactus/compare/v0.4.1...v0.5.0-alpha.0) (2021-05-06)
+
+
+### Features
+
+* **core-api:** decouple web service install & registration [#771](https://github.com/hyperledger/cactus/issues/771) ([b50e148](https://github.com/hyperledger/cactus/commit/b50e148f43c0b27138471c972aab391486e761e6))
+* **core-api:** hasTransactionFinality() on connector API [#354](https://github.com/hyperledger/cactus/issues/354) ([a2d0582](https://github.com/hyperledger/cactus/commit/a2d058218780e5e4c81e5f847cc875879a946e3f))
+* **core-api:** jwt authorization [#770](https://github.com/hyperledger/cactus/issues/770) ([2016750](https://github.com/hyperledger/cactus/commit/2016750849b4333bb4dd78897468771f0642a4f5))
+
+
+
+
+
 ## [0.4.1](https://github.com/hyperledger/cactus/compare/v0.4.0...v0.4.1) (2021-04-02)
@@ -8,0 +21,0 @@

dist/lib/main/typescript/generated/openapi/typescript-axios/api.js

@@ -16,4 +16,23 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PluginImportType = exports.LedgerType = exports.ConsensusAlgorithmFamily = void 0;
+exports.PluginImportType = exports.LedgerType = exports.ConsensusAlgorithmFamily = exports.ConsensusAlgorithmFamiliesWithTxFinality = exports.ConsensusAlgorithmFamiliesWithOutTxFinality = void 0;
 /**
+ * Enumerates a list of consensus algorithm families that do not provide immediate finality
+ * @export
+ * @enum {string}
+ */
+var ConsensusAlgorithmFamiliesWithOutTxFinality;
+(function (ConsensusAlgorithmFamiliesWithOutTxFinality) {
+    ConsensusAlgorithmFamiliesWithOutTxFinality["WORK"] = "org.hyperledger.cactus.consensusalgorithm.PROOF_OF_WORK";
+})(ConsensusAlgorithmFamiliesWithOutTxFinality = exports.ConsensusAlgorithmFamiliesWithOutTxFinality || (exports.ConsensusAlgorithmFamiliesWithOutTxFinality = {}));
+/**
+ * Enumerates a list of consensus algorithm families that provide immediate finality
+ * @export
+ * @enum {string}
+ */
+var ConsensusAlgorithmFamiliesWithTxFinality;
+(function (ConsensusAlgorithmFamiliesWithTxFinality) {
+    ConsensusAlgorithmFamiliesWithTxFinality["AUTHORITY"] = "org.hyperledger.cactus.consensusalgorithm.PROOF_OF_AUTHORITY";
+    ConsensusAlgorithmFamiliesWithTxFinality["STAKE"] = "org.hyperledger.cactus.consensusalgorithm.PROOF_OF_STAKE";
+})(ConsensusAlgorithmFamiliesWithTxFinality = exports.ConsensusAlgorithmFamiliesWithTxFinality || (exports.ConsensusAlgorithmFamiliesWithTxFinality = {}));
+/**
  * Enumerates a list of consensus algorithm families in existence. Does not intend to be an exhaustive list, just a practical one, meaning that we only include items here that are relevant to Hyperledger Cactus in fulfilling its own duties. This can be extended later as more sophisticated features of Cactus get implemented. This enum is meant to be first and foremest a useful abstraction for achieving practical tasks, not an encyclopedia and therefore we ask of everyone that this to be extended only in ways that serve a practical purpose for the runtime behavior of Cactus or Cactus plugins in general. The bottom line is that we can accept this enum being not 100% accurate as long as it 100% satisfies what it was designed to do.
@@ -55,2 +74,2 @@ * @export
 })(PluginImportType = exports.PluginImportType || (exports.PluginImportType = {}));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vLi4vLi4vc3JjL21haW4vdHlwZXNjcmlwdC9nZW5lcmF0ZWQvb3BlbmFwaS90eXBlc2NyaXB0LWF4aW9zL2FwaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsb0JBQW9CO0FBQ3BCLG9CQUFvQjtBQUNwQjs7Ozs7Ozs7OztHQVVHOzs7QUFrSEg7Ozs7R0FJRztBQUNILElBQVksd0JBSVg7QUFKRCxXQUFZLHdCQUF3QjtJQUNoQyxzR0FBMEUsQ0FBQTtJQUMxRSw4RkFBa0UsQ0FBQTtJQUNsRSw0RkFBZ0UsQ0FBQTtBQUNwRSxDQUFDLEVBSlcsd0JBQXdCLEdBQXhCLGdDQUF3QixLQUF4QixnQ0FBd0IsUUFJbkM7QUFvTUQ7Ozs7R0FJRztBQUNILElBQVksVUFTWDtBQVRELFdBQVksVUFBVTtJQUNsQixnQ0FBa0IsQ0FBQTtJQUNsQixnQ0FBa0IsQ0FBQTtJQUNsQixvQ0FBc0IsQ0FBQTtJQUN0QixrQ0FBb0IsQ0FBQTtJQUNwQixzQ0FBd0IsQ0FBQTtJQUN4QixrQ0FBb0IsQ0FBQTtJQUNwQixvQ0FBc0IsQ0FBQTtJQUN0Qix3Q0FBMEIsQ0FBQTtBQUM5QixDQUFDLEVBVFcsVUFBVSxHQUFWLGtCQUFVLEtBQVYsa0JBQVUsUUFTckI7QUEyQkQ7Ozs7R0FJRztBQUNILElBQVksZ0JBR1g7QUFIRCxXQUFZLGdCQUFnQjtJQUN4Qiw2RUFBeUQsQ0FBQTtJQUN6RCwrRUFBMkQsQ0FBQTtBQUMvRCxDQUFDLEVBSFcsZ0JBQWdCLEdBQWhCLHdCQUFnQixLQUFoQix3QkFBZ0IsUUFHM0IifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vLi4vLi4vc3JjL21haW4vdHlwZXNjcmlwdC9nZW5lcmF0ZWQvb3BlbmFwaS90eXBlc2NyaXB0LWF4aW9zL2FwaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsb0JBQW9CO0FBQ3BCLG9CQUFvQjtBQUNwQjs7Ozs7Ozs7OztHQVVHOzs7QUFrSEg7Ozs7R0FJRztBQUNILElBQVksMkNBRVg7QUFGRCxXQUFZLDJDQUEyQztJQUNuRCwrR0FBZ0UsQ0FBQTtBQUNwRSxDQUFDLEVBRlcsMkNBQTJDLEdBQTNDLG1EQUEyQyxLQUEzQyxtREFBMkMsUUFFdEQ7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSx3Q0FHWDtBQUhELFdBQVksd0NBQXdDO0lBQ2hELHNIQUEwRSxDQUFBO0lBQzFFLDhHQUFrRSxDQUFBO0FBQ3RFLENBQUMsRUFIVyx3Q0FBd0MsR0FBeEMsZ0RBQXdDLEtBQXhDLGdEQUF3QyxRQUduRDtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLHdCQUlYO0FBSkQsV0FBWSx3QkFBd0I7SUFDaEMsc0dBQTBFLENBQUE7SUFDMUUsOEZBQWtFLENBQUE7SUFDbEUsNEZBQWdFLENBQUE7QUFDcEUsQ0FBQyxFQUpXLHdCQUF3QixHQUF4QixnQ0FBd0IsS0FBeEIsZ0NBQXdCLFFBSW5DO0FBb01EOzs7O0dBSUc7QUFDSCxJQUFZLFVBU1g7QUFURCxXQUFZLFVBQVU7SUFDbEIsZ0NBQWtCLENBQUE7SUFDbEIsZ0NBQWtCLENBQUE7SUFDbEIsb0NBQXNCLENBQUE7SUFDdEIsa0NBQW9CLENBQUE7SUFDcEIsc0NBQXdCLENBQUE7SUFDeEIsa0NBQW9CLENBQUE7SUFDcEIsb0NBQXNCLENBQUE7SUFDdEIsd0NBQTBCLENBQUE7QUFDOUIsQ0FBQyxFQVRXLFVBQVUsR0FBVixrQkFBVSxLQUFWLGtCQUFVLFFBU3JCO0FBMkJEOzs7O0dBSUc7QUFDSCxJQUFZLGdCQUdYO0FBSEQsV0FBWSxnQkFBZ0I7SUFDeEIsNkVBQXlELENBQUE7SUFDekQsK0VBQTJELENBQUE7QUFDL0QsQ0FBQyxFQUhXLGdCQUFnQixHQUFoQix3QkFBZ0IsS0FBaEIsd0JBQWdCLFFBRzNCIn0=

dist/lib/main/typescript/public-api.js

@@ -13,3 +13,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PluginAspect = exports.isICactusPlugin = exports.PluginFactory = exports.isIPluginWebService = void 0;
+exports.isIEndpointAuthzOptions = exports.PluginAspect = exports.isICactusPlugin = exports.PluginFactory = exports.isIPluginWebService = void 0;
 __exportStar(require("./generated/openapi/typescript-axios/index"), exports);
@@ -25,2 +25,4 @@ __exportStar(require("./generated/openapi/typescript-axios/base"), exports);
 Object.defineProperty(exports, "PluginAspect", { enumerable: true, get: function () { return plugin_aspect_1.PluginAspect; } });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHVibGljLWFwaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9tYWluL3R5cGVzY3JpcHQvcHVibGljLWFwaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7O0FBQUEsNkVBQTJEO0FBQzNELDRFQUEwRDtBQU8xRCxrRkFHbUQ7QUFEakQsMkhBQUEsbUJBQW1CLE9BQUE7QUFJckIsMERBQXdEO0FBQS9DLCtHQUFBLGFBQWEsT0FBQTtBQUV0Qiw0REFJa0M7QUFEaEMsa0hBQUEsZUFBZSxPQUFBO0FBR2pCLHdEQUFzRDtBQUE3Qyw2R0FBQSxZQUFZLE9BQUEifQ==
+var i_endpoint_authz_options_1 = require("./plugin/web-service/i-endpoint-authz-options");
+Object.defineProperty(exports, "isIEndpointAuthzOptions", { enumerable: true, get: function () { return i_endpoint_authz_options_1.isIEndpointAuthzOptions; } });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHVibGljLWFwaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9tYWluL3R5cGVzY3JpcHQvcHVibGljLWFwaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7O0FBQUEsNkVBQTJEO0FBQzNELDRFQUEwRDtBQU8xRCxrRkFHbUQ7QUFEakQsMkhBQUEsbUJBQW1CLE9BQUE7QUFJckIsMERBQXdEO0FBQS9DLCtHQUFBLGFBQWEsT0FBQTtBQUV0Qiw0REFJa0M7QUFEaEMsa0hBQUEsZUFBZSxPQUFBO0FBR2pCLHdEQUFzRDtBQUE3Qyw2R0FBQSxZQUFZLE9BQUE7QUFNckIsMEZBR3VEO0FBRHJELG1JQUFBLHVCQUF1QixPQUFBIn0=

dist/types/main/typescript/generated/openapi/typescript-axios/api.d.ts

@@ -118,2 +118,19 @@ /**
 /**
+ * Enumerates a list of consensus algorithm families that do not provide immediate finality
+ * @export
+ * @enum {string}
+ */
+export declare enum ConsensusAlgorithmFamiliesWithOutTxFinality {
+    WORK = "org.hyperledger.cactus.consensusalgorithm.PROOF_OF_WORK"
+}
+/**
+ * Enumerates a list of consensus algorithm families that provide immediate finality
+ * @export
+ * @enum {string}
+ */
+export declare enum ConsensusAlgorithmFamiliesWithTxFinality {
+    AUTHORITY = "org.hyperledger.cactus.consensusalgorithm.PROOF_OF_AUTHORITY",
+    STAKE = "org.hyperledger.cactus.consensusalgorithm.PROOF_OF_STAKE"
+}
+/**
  * Enumerates a list of consensus algorithm families in existence. Does not intend to be an exhaustive list, just a practical one, meaning that we only include items here that are relevant to Hyperledger Cactus in fulfilling its own duties. This can be extended later as more sophisticated features of Cactus get implemented. This enum is meant to be first and foremest a useful abstraction for achieving practical tasks, not an encyclopedia and therefore we ask of everyone that this to be extended only in ways that serve a practical purpose for the runtime behavior of Cactus or Cactus plugins in general. The bottom line is that we can accept this enum being not 100% accurate as long as it 100% satisfies what it was designed to do.
@@ -120,0 +137,0 @@ * @export

dist/types/main/typescript/plugin/ledger-connector/i-plugin-ledger-connector.d.ts

@@ -25,2 +25,3 @@ import { ICactusPlugin } from "../i-cactus-plugin";
     getConsensusAlgorithmFamily(): Promise<ConsensusAlgorithmFamily>;
+    hasTransactionFinality(): Promise<boolean>;
 }

dist/types/main/typescript/plugin/web-service/i-web-service-endpoint.d.ts

 import { Express } from "express";
+import { IAsyncProvider } from "@hyperledger/cactus-common";
+import { IEndpointAuthzOptions } from "./i-endpoint-authz-options";
 import { IExpressRequestHandler } from "./i-express-request-handler";
@@ -19,3 +21,3 @@ /**
      */
-    registerExpress(expressApp: Express): IWebServiceEndpoint;
+    registerExpress(expressApp: Express): Promise<IWebServiceEndpoint>;
     /**
@@ -38,2 +40,6 @@ * Returns the lower case HTTP verb name that this endpoint is designed to
     getExpressRequestHandler(): IExpressRequestHandler;
+    /**
+     * Returns an
+     */
+    getAuthorizationOptionsProvider(): IAsyncProvider<IEndpointAuthzOptions>;
 }

dist/types/main/typescript/public-api.d.ts

@@ -14,1 +14,2 @@ export * from "./generated/openapi/typescript-axios/index";
 export { PluginFactoryFactory } from "./plugin-factory-factory";
+export { IEndpointAuthzOptions, isIEndpointAuthzOptions, } from "./plugin/web-service/i-endpoint-authz-options";

package.json

 {
   "name": "@hyperledger/cactus-core-api",
-  "version": "0.4.2-main.b067fdd.29+b067fdd",
+  "version": "0.5.0-alpha.0",
   "description": "Contains type definitions/interfaces for the kernel of the codebase. Kept separate from the implementation so that it is easier to use it as a dependency.",
@@ -89,2 +89,3 @@ "main": "dist/lib/main/typescript/index.js",
   "dependencies": {
+    "@hyperledger/cactus-common": "0.5.0-alpha.0",
     "axios": "0.21.1",
@@ -94,3 +95,3 @@ "express": "4.17.1",
   },
-  "gitHead": "b067fdd1e7e9fbae4a18fa8efdba19bf977d86df"
+  "gitHead": "26fd7f54ccdfee0c37586c51a1fdfd0746a9a512"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 6 instances in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 2 instances in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11697659

increased by1656.25%

Number of package files

52

increased by6.12%

Lines of code

7220

increased by108.07%

Worsened metrics

Dependency count

4

increased by33.33%

Number of low supply chain risk alerts

20

increased by53.85%

Dependency changes

• + Added@hyperledger/cactus-common@0.5.0-alpha.0

• + Added@hyperledger/cactus-common@0.5.0-alpha.0(transitive)

• + Added@types/bn.js@5.1.6(transitive)

• + Added@types/elliptic@6.4.18(transitive)

• + Added@types/node@22.5.5(transitive)

• + Addedasn1.js@5.4.1(transitive)

• + Addedbase64-js@1.5.1(transitive)

• + Addedbn.js@4.12.0(transitive)

• + Addedbrorand@1.1.0(transitive)

• + Addedbuffer@5.6.0(transitive)

• + Addedelliptic@6.5.7(transitive)

• + Addedhash.js@1.1.7(transitive)

• + Addedhmac-drbg@1.0.1(transitive)

• + Addedieee754@1.2.1(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedjson-stable-stringify@1.0.1(transitive)

• + Addedjsonify@0.0.1(transitive)

• + Addedkey-encoder@2.0.3(transitive)

• + Addedloglevel@1.6.7(transitive)

• + Addedloglevel-plugin-prefix@0.8.4(transitive)

• + Addedminimalistic-assert@1.0.1(transitive)

• + Addedminimalistic-crypto-utils@1.0.1(transitive)

• + Addednode-addon-api@2.0.2(transitive)

• + Addednode-gyp-build@4.8.2(transitive)

• + Addedsecp256k1@4.0.2(transitive)

• + Addedsha3@2.1.3(transitive)

• + Addedundici-types@6.19.8(transitive)