@arcblock/forge-proto - npm Package Compare versions

Comparing version 0.19.0 to 0.20.0

index.js

@@ -1,237 +0,4 @@
-const fs = require('fs');
-const path = require('path');
-const { get } = require('lodash');
-const debug = require('debug')(`${require('./package.json').name}`);
+const proto = require('./proto-full');
+const init = require('./init');
 
-const txTypePattern = /Tx$/;
-const stateTypePattern = /State$/;
-const stakeTypePattern = /^StakeFor/i;
-const requestTypePattern = /^Request/i;
-const responseTypePattern = /^Response/i;
-const lowerUnder = x =>
-  x
-    .split(/(?=[A-Z])/)
-    .join('_')
-    .toLowerCase();
-
-// extract spec
-const compactSpec = object => {
-  if (object.nested) {
-    object = object.nested;
-  }
-
-  Object.keys(object).forEach(x => {
-    if (object[x] && typeof object[x] === 'object') {
-      object[x] = compactSpec(object[x]);
-    }
-  });
-
-  return object;
-};
-
-/**
- * extract types and services from javascript code
- *
- * @param {FilePath} baseDir
- * @returns Object
- */
-function processJs(baseDir) {
-  if (!fs.existsSync(baseDir)) {
-    throw new Error('ForgeProto.processJs.baseDir: folder does not exist');
-  }
-
-  const types = {};
-  const vendorTypes = {};
-  const services = {};
-  fs.readdirSync(baseDir)
-    .filter(x => /\.js$/.test(x))
-    .forEach(x => {
-      const filePath = path.join(baseDir, x);
-      if (/^vendor_/.test(x)) {
-        if (/_grpc_pb\.js$/.test(x)) {
-          // Ignore vendor services
-        } else if (/_pb\.js$/.test(x)) {
-          const content = require(filePath);
-          Object.assign(vendorTypes, content);
-        }
-      } else {
-        const content = require(filePath);
-        if (/_grpc_pb\.js$/.test(x)) {
-          Object.assign(services, content);
-        } else if (/_pb\.js$/.test(x)) {
-          Object.assign(types, content);
-        }
-      }
-    });
-
-  // extract client constructors
-  const clients = Object.keys(services)
-    .filter(x => x.includes('Client'))
-    .map(x => x.replace(/Client$/, ''))
-    .reduce((clients, x) => {
-      clients[x] = services[`${x}Client`];
-      return clients;
-    }, {});
-
-  const transactions = Object.keys(types).filter(
-    x => txTypePattern.test(x) && !requestTypePattern.test(x) && !responseTypePattern.test(x)
-  );
-  const stakes = Object.keys(types).filter(x => stakeTypePattern.test(x));
-
-  return { types, vendorTypes, services, clients, transactions, stakes };
-}
-
-/**
- * Generate type_url field for google.protobuf.Any
- *
- * @param {*} type
- * @returns String
- */
-function createTypeUrls(abi) {
-  return Object.keys(abi).reduce((typeUrls, type) => {
-    let typeUrl = type;
-    if (!requestTypePattern.test(type) && !responseTypePattern.test(type)) {
-      if (txTypePattern.test(type)) {
-        typeUrl = `fg:t:${lowerUnder(type.replace(txTypePattern, ''))}`;
-      }
-      if (stateTypePattern.test(type)) {
-        typeUrl = `fg:s:${lowerUnder(type.replace(stateTypePattern, ''))}`;
-      }
-      if (stakeTypePattern.test(type)) {
-        typeUrl = `fg:x:${lowerUnder(`Stake${type.replace(stakeTypePattern, '')}`)}`;
-      }
-      if (['TransactionInfo', 'TxStatus'].includes(type)) {
-        typeUrl = `fg:x:${lowerUnder(type)}`;
-      }
-      if (type === 'DummyCodec') {
-        typeUrl = 'fg:x:address';
-      }
-    }
-
-    typeUrls[type] = typeUrl;
-    return typeUrls;
-  }, {});
-}
-
-/**
- * extract rpc descriptors
- *
- * @param {*} filePath
- * @param {*} packageName
- * @returns Object
- */
-function processJson(filePath, packageName) {
-  const json = fs.existsSync(filePath) ? require(filePath) : json;
-  const spec = compactSpec(json);
-
-  const { [packageName]: abi } = spec;
-
-  // extract messages and enums
-  const messages = {};
-  const enums = Object.keys(abi)
-    .filter(x => abi[x].values)
-    .reduce((enums, x) => {
-      messages[x] = {};
-      enums[x] = Object.keys(abi[x].values).reduce((values, k) => {
-        values[k.toUpperCase()] = abi[x].values[k];
-        messages[x][abi[x].values[k]] = k.toUpperCase();
-        return values;
-      }, {});
-
-      return enums;
-    }, {});
-
-  // extract rpcs
-  const rpcs = Object.keys(abi)
-    .filter(x => abi[x].methods)
-    .reduce((rpcs, x) => {
-      rpcs[x] = abi[x].methods;
-      return rpcs;
-    }, {});
-
-  // extract typeUrls
-  const typeUrls = createTypeUrls(abi);
-
-  Object.assign(spec, spec[packageName]);
-  return { messages, enums, rpcs, spec, typeUrls };
-}
-
-const extraTypes = {};
-const extraSpec = {};
-const extraTypeUrls = {};
-const { types, vendorTypes, clients, transactions, stakes } = processJs(
-  path.resolve(__dirname, './lib/')
-);
-const { messages, enums, rpcs, spec, typeUrls } = processJson(
-  path.resolve(__dirname, './lib/spec.json'),
-  'forge_abi'
-);
-
-enums.SupportedTxs = transactions;
-enums.SupportedStakes = stakes;
-
-// Append app specific proto definition into search space
-function addSource({ baseDir, packageName, typeUrls: _typeUrls }) {
-  if (!fs.existsSync(baseDir)) {
-    throw new Error('baseDir does not exists');
-  }
-
-  const jsResult = processJs(baseDir);
-  Object.assign(extraTypes, jsResult.types);
-  debug('addSource.types', jsResult.types);
-  Object.keys(jsResult.types)
-    .filter(x => txTypePattern.test(x))
-    .forEach(x => transactions.push(x));
-
-  if (fs.existsSync(path.join(baseDir, 'spec.json'))) {
-    const jsonResult = processJson(path.join(baseDir, 'spec.json'), packageName);
-    Object.assign(extraSpec, jsonResult.spec[packageName]);
-    Object.assign(extraTypeUrls, createTypeUrls(jsonResult.spec[packageName]), _typeUrls);
-    debug('addSource.spec', jsonResult.spec[packageName]);
-  }
-}
-
-// Search for a type and its fields descriptor
-function getMessageType(type) {
-  const { fields, oneofs } =
-    get(spec, type) || get(extraSpec, type) || get(spec, `abci_vendor.${type}`) || {};
-  return {
-    fn: get(types, type) || get(vendorTypes, type) || get(extraTypes, type),
-    fields,
-    oneofs,
-  };
-}
-
-function toTypeUrl(type) {
-  return get(typeUrls, type) || get(extraTypeUrls, type) || type;
-}
-
-function fromTypeUrl(url) {
-  let found = Object.entries(typeUrls).find(([, value]) => value === url);
-  if (found) {
-    return found[0];
-  }
-  found = Object.entries(extraTypeUrls).find(([, value]) => value === url);
-  if (found) {
-    return found[0];
-  }
-
-  return url;
-}
-
-module.exports = {
-  enums,
-  messages,
-  rpcs: Object.keys(clients).reduce((acc, x) => {
-    acc[x] = clients[x];
-    acc[x].methods = rpcs[x];
-    return acc;
-  }, {}),
-  compactSpec,
-  processJs,
-  processJson,
-  getMessageType,
-  toTypeUrl,
-  fromTypeUrl,
-  addSource,
-};
+module.exports = init(proto);

lib/declare_file_tx_pb.js

@@ -14,4 +14,2 @@ /**
 
-var google_protobuf_any_pb = require('google-protobuf/google/protobuf/any_pb.js');
-goog.object.extend(proto, google_protobuf_any_pb);
 goog.exportSymbol('proto.forge_abi.DeclareFileTx', null, global);
@@ -18,0 +16,0 @@

package.json

 {
   "name": "@arcblock/forge-proto",
   "description": "Static modules generated from forge-sdk protobuf files",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "author": "wangshijun <[e-mail]> (https://www.arcblock.io)",
@@ -35,3 +35,8 @@ "engines": {
   "files": [
+    "lite.js",
     "index.js",
+    "index.d.ts",
+    "init.js",
+    "proto-full.js",
+    "proto-lite.js",
     "lib"
@@ -44,5 +49,6 @@ ],
   "scripts": {
-    "upgrade": "bash ./tools/copy.sh && npm run generate-dts",
-    "copy": "bash ./tools/copy.sh",
-    "generate-dts": "j2d index.js && node tools/generate-dts.js && bash ./tools/patch-dts.sh",
+    "upgrade": "bash tools/copy.sh && npm run gen && npm run generate-dts",
+    "copy": "bash tools/copy.sh",
+    "gen": "node tools/gen-proto-entry.js full && node tools/gen-proto-entry.js lite",
+    "generate-dts": "j2d index.js && node tools/generate-dts.js && bash tools/patch-dts.sh",
     "lint": "eslint tests index.js",
@@ -55,5 +61,6 @@ "precommit": "CI=1 npm run test",
   "dependencies": {
-    "debug": "^4.1.1"
+    "debug": "^4.1.1",
+    "lodash.get": "^4.4.2"
   },
-  "gitHead": "e5e01d6a92dfcfe363c5eb6045666c212611e726"
+  "gitHead": "1bcb6daa62e48486496c3e73518c23ba27489284"
 }

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

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

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

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1876971

increased by2.16%

Number of package files

34

increased by3.03%

Lines of code

53800

increased by2.39%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

2

increased by100%

Number of medium supply chain risk alerts

21

increased by10.53%

Dependency changes

• + Addedlodash.get@^4.4.2

• + Addedlodash.get@4.4.2(transitive)