@ocap/message 1.16.8 → 1.16.12

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.
 
@@ -53,6 +53,6 @@ For full documentation, checkout [https://asset-chain.netlify.com](https://asset
 
 ## Contributors
 
-| Name           | Website                    |
-| -------------- | -------------------------- |
-| **wangshijun** | <https://ocap.arcblock.io> |
+| Name           | Website                         |
+| -------------- | ------------------------------- |
+| **wangshijun** | <https://github.com/wangshijun> |

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/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,12 +1,15 @@
 {
   "name": "@ocap/message",
   "description": "Utility functions to encode and decode message that can send to forge",
-  "version": "1.16.8",
+  "version": "1.16.12",
   "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/asset-chain/issues",
     "email": "shijun@arcblock.io"
@@ -15,23 +18,22 @@
     "access": "public"
   },
   "dependencies": {
-    "@ocap/proto": "1.16.8",
-    "@ocap/util": "1.16.8",
+    "@ocap/proto": "1.16.12",
+    "@ocap/util": "1.16.12",
     "debug": "^4.3.3",
     "google-protobuf": "3.18.0",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
     "jest": "^27.3.1",
-    "jsdoc-to-markdown": "^5.0.0",
-    "remark-cli": "^5.0.0",
-    "remark-preset-github": "^0.0.9"
+    "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/asset-chain"
         }
@@ -40,7 +42,6 @@
   },
   "homepage": "https://github.com/ArcBlock/asset-chain/tree/master/core/forge-message",
   "keywords": [
-    "forge",
     "blockchain",
     "arcblock",
     "sdk",
@@ -68,5 +69,5 @@
     "test": "jest --forceExit --detectOpenHandles",
     "coverage": "yarn test -- --coverage"
   },
-  "gitHead": "15e9623edafa6fcb628f67f0c9e26e64ab01bcd2"
+  "gitHead": "fbae535a1a8b38bb6942a5d80c4e20f88163833a"
 }