@ocap/message 1.28.8 → 1.29.0

package/lib/package.cjs

@@ -0,0 +1,90 @@
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+
+//#region package.json
+var require_package = /* @__PURE__ */ require_rolldown_runtime.__commonJSMin(((exports, module) => {
+	module.exports = {
+		"name": "@ocap/message",
+		"description": "Utility functions to encode and decode message that can send to forge",
+		"version": "1.20.2",
+		"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/blockchain/issues",
+			"email": "shijun@arcblock.io"
+		},
+		"publishConfig": { "access": "public" },
+		"dependencies": {
+			"@ocap/proto": "workspace:*",
+			"@ocap/util": "workspace:*",
+			"debug": "^4.4.3",
+			"google-protobuf": "3.21.0",
+			"lodash": "^4.17.23"
+		},
+		"devDependencies": {
+			"@types/google-protobuf": "^3.15.12",
+			"jsdoc-to-markdown": "^7.1.1",
+			"remark-cli": "^10.0.1",
+			"remark-preset-github": "^4.0.4"
+		},
+		"remarkConfig": { "plugins": ["preset-github", [{ "repository": "ArcBlock/blockchain" }]] },
+		"homepage": "https://github.com/ArcBlock/blockchain/tree/master/core/forge-message",
+		"keywords": [
+			"blockchain",
+			"arcblock",
+			"sdk",
+			"nodejs"
+		],
+		"license": "Apache-2.0",
+		"type": "module",
+		"main": "./lib/index.cjs",
+		"module": "./esm/index.mjs",
+		"types": "./esm/index.d.mts",
+		"exports": {
+			".": {
+				"types": "./esm/index.d.mts",
+				"import": "./esm/index.mjs",
+				"default": "./lib/index.cjs"
+			},
+			"./lib/*.js": {
+				"types": "./esm/*.d.mts",
+				"import": "./esm/*.mjs",
+				"default": "./lib/*.cjs"
+			},
+			"./lib/*": {
+				"types": "./esm/*.d.mts",
+				"import": "./esm/*.mjs",
+				"default": "./lib/*.cjs"
+			}
+		},
+		"files": ["lib", "esm"],
+		"repository": {
+			"type": "git",
+			"url": "https://github.com/ArcBlock/blockchain/tree/master/core/forge-message"
+		},
+		"scripts": {
+			"build": "tsdown",
+			"prebuild": "rm -rf lib esm",
+			"lint": "biome check",
+			"lint:fix": "biome check --write",
+			"docs": "bun run gen-docs && bun run cleanup-docs && bun run format-docs",
+			"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",
+			"test": "bun test",
+			"coverage": "npm run test -- --coverage"
+		},
+		"gitHead": "87990c8b5e215107fc587c1ced0d6b3e2cd2483e"
+	};
+}));
+
+//#endregion
+Object.defineProperty(exports, 'default', {
+  enumerable: true,
+  get: function () {
+    return require_package();
+  }
+});

package/lib/patch.cjs

@@ -0,0 +1,41 @@
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+const require_package$1 = require('./package.cjs');
+let assert = require("assert");
+assert = require_rolldown_runtime.__toESM(assert);
+let debug = require("debug");
+debug = require_rolldown_runtime.__toESM(debug);
+
+//#region src/patch.ts
+/**
+* This patch fixes an issue in `google-protobuf` package
+* After this patch is applied: The deserialize of `map` fields can accept empty values
+*/
+const jspb = require("google-protobuf");
+const debug$1 = (0, debug.default)(`${require_package$1.default.name}:Map`);
+if (typeof jspb.Map.deserializeBinary === "function" && !jspb.Map.deserializeBinary.__patched__) {
+	jspb.Map.deserializeBinary = (map, reader, keyReaderFn, valueReaderFn, opt_valueReaderCallback, opt_defaultKey = 0) => {
+		let key = opt_defaultKey;
+		let value;
+		while (reader.nextField()) {
+			if (reader.isEndGroup()) break;
+			const field = reader.getFieldNumber();
+			debug$1("deserializeBinary.field", field);
+			if (field === 1) {
+				key = keyReaderFn.call(reader);
+				debug$1("deserializeBinary.key", key);
+			} else if (field === 2) {
+				debug$1("deserializeBinary.map", map);
+				if (map.valueCtor_) {
+					(0, assert.default)(opt_valueReaderCallback, "opt_valueReaderCallback");
+					value = new map.valueCtor_();
+					valueReaderFn.call(reader, value, opt_valueReaderCallback);
+				} else value = valueReaderFn.call(reader);
+				debug$1("deserializeBinary.value", typeof value?.toObject === "function" ? value.toObject() : value);
+			}
+		}
+		if (typeof key !== "undefined" && typeof value !== "undefined") map.set(key, value);
+	};
+	jspb.Map.deserializeBinary.__patched__ = true;
+}
+
+//#endregion

package/lib/patch.d.cts

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

package/lib/provider.cjs

@@ -0,0 +1,49 @@
+
+//#region src/provider.ts
+const providers = [];
+const enums = {};
+const messages = {};
+function getMessageType(type) {
+	const provider = providers.find((x) => x.getMessageType(type).fn);
+	if (provider) return provider.getMessageType(type);
+	return {};
+}
+function toTypeUrl(type) {
+	const provider = providers.find((x) => x.toTypeUrl(type) !== type);
+	if (provider) return provider.toTypeUrl(type);
+	return type;
+}
+function fromTypeUrl(url) {
+	const provider = providers.find((x) => x.fromTypeUrl(url) !== url);
+	if (provider) return provider.fromTypeUrl(url);
+	return url;
+}
+/**
+* Add type provider that can be used to format/create messages
+*
+* @param provider - proto generated from @ocap/proto
+*/
+function addProvider(provider) {
+	if ([
+		"getMessageType",
+		"toTypeUrl",
+		"fromTypeUrl"
+	].some((x) => typeof provider[x] !== "function")) throw new Error("addProvider requires a valid proto provider");
+	if (providers.includes(provider) === false) {
+		providers.push(provider);
+		if (provider.enums) Object.assign(enums, provider.enums);
+		if (provider.messages) Object.assign(messages, provider.messages);
+	}
+}
+function resetProviders() {
+	while (providers.length) providers.pop();
+}
+
+//#endregion
+exports.addProvider = addProvider;
+exports.enums = enums;
+exports.fromTypeUrl = fromTypeUrl;
+exports.getMessageType = getMessageType;
+exports.messages = messages;
+exports.resetProviders = resetProviders;
+exports.toTypeUrl = toTypeUrl;

package/lib/provider.d.cts

@@ -0,0 +1,27 @@
+//#region src/provider.d.ts
+interface MessageTypeResult {
+  fn?: new () => unknown;
+  fields?: Record<string, unknown>;
+  oneofs?: Record<string, unknown>;
+}
+interface ProtoProvider {
+  getMessageType(type: string): MessageTypeResult;
+  toTypeUrl(type: string): string;
+  fromTypeUrl(url: string): string;
+  enums?: Record<string, Record<string | number, string | number>>;
+  messages?: Record<string, Record<string | number, string>>;
+}
+declare const enums: Record<string, Record<string | number, string | number>>;
+declare const messages: Record<string, Record<string | number, string>>;
+declare function getMessageType(type: string): MessageTypeResult;
+declare function toTypeUrl(type: string): string;
+declare function fromTypeUrl(url: string): string;
+/**
+ * Add type provider that can be used to format/create messages
+ *
+ * @param provider - proto generated from @ocap/proto
+ */
+declare function addProvider(provider: ProtoProvider): void;
+declare function resetProviders(): void;
+//#endregion
+export { type MessageTypeResult, type ProtoProvider, addProvider, enums, fromTypeUrl, getMessageType, messages, resetProviders, toTypeUrl };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ocap/message",
   "description": "Utility functions to encode and decode message that can send to forge",
-  "version": "1.28.8",
+  "version": "1.29.0",
   "author": {
     "name": "wangshijun",
     "email": "shijun@arcblock.io",
@@ -18,13 +18,14 @@
     "access": "public"
   },
   "dependencies": {
-    "@ocap/proto": "1.28.8",
-    "@ocap/util": "1.28.8",
-    "debug": "^4.3.6",
+    "@ocap/proto": "1.29.0",
+    "@ocap/util": "1.29.0",
+    "debug": "^4.4.3",
     "google-protobuf": "3.21.0",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.23"
   },
   "devDependencies": {
+    "@types/google-protobuf": "^3.15.12",
     "jsdoc-to-markdown": "^7.1.1",
     "remark-cli": "^10.0.1",
     "remark-preset-github": "^4.0.4"
@@ -47,24 +48,44 @@
     "nodejs"
   ],
   "license": "Apache-2.0",
-  "main": "./index.js",
+  "type": "module",
+  "main": "./lib/index.cjs",
+  "module": "./esm/index.mjs",
+  "types": "./esm/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./esm/index.d.mts",
+      "import": "./esm/index.mjs",
+      "default": "./lib/index.cjs"
+    },
+    "./lib/*.js": {
+      "types": "./esm/*.d.mts",
+      "import": "./esm/*.mjs",
+      "default": "./lib/*.cjs"
+    },
+    "./lib/*": {
+      "types": "./esm/*.d.mts",
+      "import": "./esm/*.mjs",
+      "default": "./lib/*.cjs"
+    }
+  },
   "files": [
-    "index.d.ts",
-    "index.js",
-    "lib"
+    "lib",
+    "esm"
   ],
   "repository": {
     "type": "git",
     "url": "https://github.com/ArcBlock/blockchain/tree/master/core/forge-message"
   },
   "scripts": {
+    "build": "tsdown",
+    "prebuild": "rm -rf lib esm",
     "lint": "biome check",
     "lint:fix": "biome check --write",
-    "docs": "bun run gen-dts && bun run gen-docs && bun run cleanup-docs && bun run format-docs",
+    "docs": "bun run gen-docs && bun run cleanup-docs && bun run format-docs",
     "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": "bun test",
     "coverage": "npm run test -- --coverage"
   },

package/index.d.ts

@@ -1,5 +0,0 @@
-// Generate by [js2dts@0.3.3](https://github.com/whxaxes/js2dts#readme)
-
-import * as LibMessage from './lib/message';
-declare const _OcapMessage: typeof LibMessage;
-export = _OcapMessage;

package/index.js

@@ -1,7 +0,0 @@
-require('./lib/patch');
-const forge = require('@ocap/proto');
-const provider = require('./lib/provider');
-
-provider.addProvider(forge);
-
-module.exports = require('./lib/message');

package/lib/message.d.ts

@@ -1,138 +0,0 @@
-/**
- * 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 };