@ocap/message 1.6.5 → 1.6.10

package/README.md

@@ -2,7 +2,7 @@
 
 [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![docs](https://img.shields.io/badge/powered%20by-arcblock-green.svg)](https://docs.arcblock.io)
-[![Gitter](https://badges.gitter.im/ArcBlock/community.svg)](https://gitter.im/ArcBlock/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![Gitter](https://badges.gitter.im/ArcBlock/community.svg)](https://gitter.im/ArcBlock/community?utm_source=badge\&utm_medium=badge\&utm_campaign=pr-badge)
 
 > Utility function to encode and format message that can be sent to or received from forge framework.
 
@@ -34,10 +34,9 @@ const message = createMessage('Transaction', {
   nonce: 0,
   signature: 'abc',
   itx: {
-    type: 'PokeTx',
+    type: 'TransferTx',
     value: {
-      date: '2019-04-25',
-      address: 'zzzzzzzzzzzzzzzzzzzzz',
+      to: '2019-04-25',
     },
   },
 });
@@ -49,11 +48,11 @@ const buffer = message.serializeBinary();
 
 ## Documentation
 
-For full documentation, checkout [https://ocap-js.netlify.com](https://ocap-js.netlify.com/)
+For full documentation, checkout [https://asset-chain.netlify.com](https://asset-chain.netlify.com/)
 
 
 ## Contributors
 
-| Name           | Website                    |
-| -------------- | -------------------------- |
-| **wangshijun** | <https://ocap.arcblock.io> |
+| Name           | Website                         |
+| -------------- | ------------------------------- |
+| **wangshijun** | <https://github.com/wangshijun> |

package/index.d.ts

@@ -1,166 +1,5 @@
 // Generate by [js2dts@0.3.3](https://github.com/whxaxes/js2dts#readme)
 
-/**
- * Format an message from RPC to UI friendly
- *
- * @public
- * @static
- * @param {string} type - input type
- * @param {object} data - input data
- * @returns {object} [almost same structure as input]
- */
-declare function formatMessage(type: string, data: any): any;
-/**
- * Create an protobuf encoded Typed message with specified data, ready to send to rpc server
- *
- * @public
- * @static
- * @param {string} type - message type defined in forge-proto
- * @param {object} params - message content
- * @returns {object} Message instance
- * @example
- * const { createMessage } = require('@ocap/message');
- * const message = createMessage ('CreateAssetTx', {
- *   moniker: 'asset',
- *   address: 'zaAKEJRKQWsdfjksdfjkASRD',
- * });
- *
- * message.getMoniker();  // 'asset'
- * message.getAddress();  // 'zaAKEJRKQWsdfjksdfjkASRD'
- * message.getReadonly(); // false
- * message.setReadonly(true);
- */
-declare function createMessage(type: string, params: any): any;
-/**
- * Generated a fake message for a type, the message can be RPC request/response
- *
- * @public
- * @static
- * @param {string} type - Message type string, should be defined in forge-abi or forge-core-protocol
- * @returns {object}
- * @example
- * const { fakeMessage} = require('@ocap/message');
- * const message = fakeMessage('CreateAssetTx');
- * // will output
- * {
- *   moniker: 'arcblock',
- *   data: { type: 'string', value: 'ABCD 1234' },
- *   readonly: true,
- *   transferrable: true,
- *   ttl: 2,
- *   parent: 'arcblock',
- *   address: 'F2D072CBD4954A20F26280730795D91AC1039996CEB6E24A31E9CE548DCB5E55',
- * }
- */
-declare function fakeMessage(type: string): any;
-/**
- * Decode an google.protobuf.Any%{ typeUrl, value } => { type, value }
- *
- * @public
- * @static
- * @param {object} data encoded data object
- * @returns {object} Object%{type, value}
- */
-declare function decodeAny(data: any): any;
-/**
- * Encode { type, value } => google.protobuf.Any%{ typeUrl, value }
- * Does nothing on already encoded message
- *
- * @public
- * @static
- * @param {object} data
- * @returns {object} google.protobuf.Any
- */
-declare function encodeAny(data: any): any;
-/**
- * Convert an { seconds, nanos } | date-string to google.protobuf.Timestamp object
- *
- * @public
- * @static
- * @param {string|object} value
- * @returns {object} instanceof google.protobuf.Timestamp
- */
-declare function encodeTimestamp(value: any): any;
-/**
- * Decode google.protobuf.Timestamp message to ISO Date String
- *
- * FIXME: node strictly equal because we rounded the `nanos` field
- *
- * @public
- * @static
- * @param {object} data
- * @returns {strong} String timestamp
- */
-declare function decodeTimestamp(data: any): any;
-/**
- * Encode BigUint and BigSint types defined in forge-sdk, double encoding is avoided
- *
- * @public
- * @static
- * @param {buffer|string|number} value - value to encode
- * @param {string} type - type names defined in forge-proto
- * @returns {object} Message
- */
-declare function encodeBigInt(value: any, type: string): any;
-/**
- * Convert BigUint and BigSint to string representation of numbers
- *
- * @public
- * @static
- * @link https://stackoverflow.com/questions/23948278/how-to-convert-byte-array-into-a-signed-big-integer-in-javascript
- * @param {object} data - usually from encodeBigInt
- * @param {buffer} data.value
- * @param {boolean} data.minus
- * @returns {string} human readable number
- */
-declare function decodeBigInt(data: _OcapMessage.T100): string;
-/**
- * Attach an $format method to rpc response
- *
- * @private
- * @param {object} data
- * @param {string} type
- */
-declare function attachFormatFn(type: string, data: any, key?: string): void;
-/**
- * Attach an example method to
- *
- * @private
- * @param {object} data
- * @param {string} type
- */
-declare function attachExampleFn(type: string, host: any, key: any): void;
-/**
- * Add type provider that can be used to format/create messages
- *
- * @param {object} provider - proto generated from {@see @ocap/proto}
- */
-declare function addProvider(provider: any): void;
-declare function getMessageType(type: any): any;
-declare function toTypeUrl(type: any): any;
-declare function fromTypeUrl(url: any): any;
-declare const _OcapMessage: _OcapMessage.T101;
-declare namespace _OcapMessage {
-  export interface T100 {
-    value: any;
-    minus: boolean;
-  }
-  export interface T101 {
-    formatMessage: typeof formatMessage;
-    createMessage: typeof createMessage;
-    fakeMessage: typeof fakeMessage;
-    decodeAny: typeof decodeAny;
-    encodeAny: typeof encodeAny;
-    encodeTimestamp: typeof encodeTimestamp;
-    decodeTimestamp: typeof decodeTimestamp;
-    encodeBigInt: typeof encodeBigInt;
-    decodeBigInt: typeof decodeBigInt;
-    attachFormatFn: typeof attachFormatFn;
-    attachExampleFn: typeof attachExampleFn;
-    addProvider: typeof addProvider;
-    getMessageType: typeof getMessageType;
-    toTypeUrl: typeof toTypeUrl;
-    fromTypeUrl: typeof fromTypeUrl;
-  }
-}
+import * as LibMessage from './lib/message';
+declare const _OcapMessage: typeof LibMessage;
 export = _OcapMessage;

package/lib/message.d.ts

@@ -0,0 +1,138 @@
+/**
+ * Format an message from RPC to UI friendly
+ *
+ * @public
+ * @static
+ * @param {string} type - input type
+ * @param {object} data - input data
+ * @returns {object} [almost same structure as input]
+ */
+export function formatMessage(type: string, data: object): object;
+/**
+ * Create an protobuf encoded Typed message with specified data, ready to send to rpc server
+ *
+ * @public
+ * @static
+ * @param {string} type - message type defined in forge-proto
+ * @param {object} params - message content
+ * @returns {object} Message instance
+ * @example
+ * const { createMessage } = require('@ocap/message');
+ * const message = createMessage ('CreateAssetTx', {
+ *   moniker: 'asset',
+ *   address: 'zaAKEJRKQWsdfjksdfjkASRD',
+ * });
+ *
+ * message.getMoniker();  // 'asset'
+ * message.getAddress();  // 'zaAKEJRKQWsdfjksdfjkASRD'
+ * message.getReadonly(); // false
+ * message.setReadonly(true);
+ */
+export function createMessage(type: string, params: object): object;
+/**
+ * Generated a fake message for a type, the message can be RPC request/response
+ *
+ * @public
+ * @static
+ * @param {string} type - Message type string, should be defined in forge-abi or forge-core-protocol
+ * @returns {object}
+ * @example
+ * const { fakeMessage} = require('@ocap/message');
+ * const message = fakeMessage('CreateAssetTx');
+ * // will output
+ * {
+ *   moniker: 'arcblock',
+ *   data: { type: 'string', value: 'ABCD 1234' },
+ *   readonly: true,
+ *   transferrable: true,
+ *   ttl: 2,
+ *   parent: 'arcblock',
+ *   address: 'F2D072CBD4954A20F26280730795D91AC1039996CEB6E24A31E9CE548DCB5E55',
+ * }
+ */
+export function fakeMessage(type: string): object;
+/**
+ * Decode an google.protobuf.Any%{ typeUrl, value } => { type, value }
+ *
+ * @public
+ * @static
+ * @param {object} data encoded data object
+ * @returns {object} Object%{type, value}
+ */
+export function decodeAny(data: object): object;
+/**
+ * Encode { type, value } => google.protobuf.Any%{ typeUrl, value }
+ * Does nothing on already encoded message
+ *
+ * @public
+ * @static
+ * @param {object} data
+ * @returns {object} google.protobuf.Any
+ */
+export function encodeAny(data: object): object;
+/**
+ * Convert an { seconds, nanos } | date-string to google.protobuf.Timestamp object
+ *
+ * @public
+ * @static
+ * @param {string|object} value
+ * @returns {object} instanceof google.protobuf.Timestamp
+ */
+export function encodeTimestamp(value: string | object): object;
+/**
+ * Decode google.protobuf.Timestamp message to ISO Date String
+ *
+ * FIXME: node strictly equal because we rounded the `nanos` field
+ *
+ * @public
+ * @static
+ * @param {object} data
+ * @returns {strong} String timestamp
+ */
+export function decodeTimestamp(data: object): strong;
+/**
+ * Encode BigUint and BigSint types defined in forge-sdk, double encoding is avoided
+ *
+ * @public
+ * @static
+ * @param {buffer|string|number} value - value to encode
+ * @param {string} type - type names defined in forge-proto
+ * @returns {object} Message
+ */
+export function encodeBigInt(value: buffer | string | number, type: string): object;
+/**
+ * Convert BigUint and BigSint to string representation of numbers
+ *
+ * @public
+ * @static
+ * @link https://stackoverflow.com/questions/23948278/how-to-convert-byte-array-into-a-signed-big-integer-in-javascript
+ * @param {object} data - usually from encodeBigInt
+ * @param {buffer} data.value
+ * @param {boolean} data.minus
+ * @returns {string} human readable number
+ */
+export function decodeBigInt(data: {
+    value: buffer;
+    minus: boolean;
+}): string;
+/**
+ * Attach an $format method to rpc response
+ *
+ * @private
+ * @param {object} data
+ * @param {string} type
+ */
+export function attachFormatFn(type: string, data: object, key?: string): void;
+/**
+ * Attach an example method to
+ *
+ * @private
+ * @param {object} data
+ * @param {string} type
+ */
+export function attachExampleFn(type: string, host: any, key: any): void;
+import { addProvider } from "./provider";
+import { getMessageType } from "./provider";
+import { toTypeUrl } from "./provider";
+import { fromTypeUrl } from "./provider";
+export { addProvider, getMessageType, toTypeUrl, fromTypeUrl };

package/lib/message.js

@@ -54,7 +54,7 @@ const fakeValues = {
   double: '12.3',
 
   string: 'arcblock',
-  bytes: Uint8Array.from([]),
+  bytes: new Uint8Array(),
   enums: (type) => Object.values(enums[type])[0],
 };
 
@@ -393,9 +393,14 @@ function decodeAny(data) {
     return { type: 'Unknown', value: '' };
   }
 
+  if (data.type && data.value) {
+    return data;
+  }
+
   const { typeUrl, value } = data;
   if (['json', 'vc'].includes(typeUrl)) {
-    return { type: typeUrl, value: JSON.parse(Buffer.from(value, 'base64')) };
+    const decoded = JSON.parse(Buffer.from(value, 'base64'));
+    return { type: typeUrl, value: decoded };
   }
 
   const type = fromTypeUrl(typeUrl);
@@ -431,16 +436,16 @@ function encodeAny(data) {
       if (data.typeUrl === 'fg:x:address') {
         anyMessage.setValue(data.value);
       } else if (['json', 'vc'].includes(data.typeUrl)) {
-        anyMessage.setValue(Uint8Array.from(Buffer.from(JSON.stringify(data.value))));
+        anyMessage.setValue(new Uint8Array(Buffer.from(JSON.stringify(data.value))));
       } else {
-        anyMessage.setValue(Uint8Array.from(Buffer.from(data.value, 'base64')));
+        anyMessage.setValue(new Uint8Array(Buffer.from(data.value, 'base64')));
       }
     } else {
       const { value: anyValue, type: anyType } = data;
       const typeUrl = toTypeUrl(anyType);
       anyMessage.setTypeUrl(typeUrl);
       if (['json', 'vc'].includes(typeUrl)) {
-        anyMessage.setValue(Uint8Array.from(Buffer.from(JSON.stringify(anyValue))));
+        anyMessage.setValue(new Uint8Array(Buffer.from(JSON.stringify(anyValue))));
       } else {
         const anyValueBinary = createMessage(anyType, anyValue);
         anyMessage.setValue(anyValueBinary.serializeBinary());
@@ -526,7 +531,7 @@ function encodeBigInt(value, type) {
 
   const number = toBN(value);
   const zero = toBN(0);
-  message.setValue(Uint8Array.from(number.toArray()));
+  message.setValue(new Uint8Array(number.toArray()));
   if (type === 'BigSint') {
     message.setMinus(number.lt(zero));
   }

package/lib/patch.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/provider.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Add type provider that can be used to format/create messages
+ *
+ * @param {object} provider - proto generated from {@see @ocap/proto}
+ */
+export function addProvider(provider: object): void;
+export function resetProviders(): void;
+export const enums: {};
+export const messages: {};
+export function getMessageType(type: any): any;
+export function toTypeUrl(type: any): any;
+export function fromTypeUrl(url: any): any;

package/package.json

@@ -1,46 +1,47 @@
 {
   "name": "@ocap/message",
   "description": "Utility functions to encode and decode message that can send to forge",
-  "version": "1.6.5",
+  "version": "1.6.10",
   "author": {
     "name": "wangshijun",
     "email": "shijun@arcblock.io",
     "url": "https://github.com/wangshijun"
   },
+  "contributors": [
+    "wangshijun <shijun@arcblock.io> (https://github.com/wangshijun)"
+  ],
   "bugs": {
-    "url": "https://github.com/ArcBlock/ocap-js/issues",
+    "url": "https://github.com/ArcBlock/asset-chain/issues",
     "email": "shijun@arcblock.io"
   },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@ocap/proto": "^1.6.5",
-    "@ocap/util": "^1.6.5",
-    "debug": "^4.3.1",
-    "google-protobuf": "^3.9.0",
+    "@ocap/proto": "1.6.10",
+    "@ocap/util": "1.6.10",
+    "debug": "^4.3.3",
+    "google-protobuf": "3.18.0",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "jest": "^26.6.3",
-    "jsdoc-to-markdown": "^5.0.0",
-    "remark-cli": "^5.0.0",
-    "remark-preset-github": "^0.0.9"
+    "jest": "^27.3.1",
+    "jsdoc-to-markdown": "^7.1.1",
+    "remark-cli": "^10.0.1",
+    "remark-preset-github": "^4.0.1"
   },
   "remarkConfig": {
     "plugins": [
       "preset-github",
       [
-        "validate-links",
         {
-          "repository": "ArcBlock/ocap-js"
+          "repository": "ArcBlock/asset-chain"
         }
       ]
     ]
   },
-  "homepage": "https://github.com/ArcBlock/ocap-js/tree/master/core/forge-message",
+  "homepage": "https://github.com/ArcBlock/asset-chain/tree/master/core/forge-message",
   "keywords": [
-    "forge",
     "blockchain",
     "arcblock",
     "sdk",
@@ -55,18 +56,18 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/ArcBlock/ocap-js/tree/master/core/forge-message"
+    "url": "https://github.com/ArcBlock/asset-chain/tree/master/core/forge-message"
   },
   "scripts": {
     "lint": "eslint lib *.js tests",
     "lint:fix": "eslint --fix lib *.js tests",
     "docs": "yarn gen-dts && yarn gen-docs && yarn cleanup-docs && yarn format-docs",
-    "cleanup-docs": "node ../../tools/cleanup-docs.js docs/README.md $npm_package_name",
+    "cleanup-docs": "node ../../scripts/cleanup-docs.js docs/README.md $npm_package_name",
     "gen-docs": "jsdoc2md lib/message.js > docs/README.md",
     "format-docs": "remark . -o",
     "gen-dts": "j2d index.js",
-    "test": "node tools/jest.js",
+    "test": "jest --forceExit --detectOpenHandles",
     "coverage": "yarn test -- --coverage"
   },
-  "gitHead": "5779448f13824de38978df3c84c9da0c1e1ad989"
+  "gitHead": "ab272e8db3a15c6571cc7fae7cc3d3e0fdd4bdb1"
 }