@rocketmq/serializer 0.1.0 → 0.1.2

package/.turbo/turbo-build.log

@@ -1,21 +1,23 @@
 
 
-> @rocketmq/serializer@0.1.0 build /home/edilson/learnspace/rocketmq-broker/client-ts/packages/serializer
+> @rocketmq/serializer@0.1.2 build /home/edilson/learnspace/rocketmq-broker/rocketmq.js/packages/serializer
 > tsup
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
 CLI tsup v8.5.1
-CLI Using tsup config: /home/edilson/learnspace/rocketmq-broker/client-ts/packages/serializer/tsup.config.ts
+CLI Using tsup config: /home/edilson/learnspace/rocketmq-broker/rocketmq.js/packages/serializer/tsup.config.ts
 CLI Target: es2022
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-CJS dist/index.cjs 1.25 KB
-CJS ⚡️ Build success in 10ms
-ESM dist/index.js 248.00 B
-ESM ⚡️ Build success in 10ms
+ESM dist/index.js     462.00 B
+ESM dist/index.js.map 1.03 KB
+ESM ⚡️ Build success in 29ms
+CJS dist/index.cjs     1.42 KB
+CJS dist/index.cjs.map 1.17 KB
+CJS ⚡️ Build success in 29ms
 DTS Build start
-DTS ⚡️ Build success in 1037ms
+DTS ⚡️ Build success in 910ms
 DTS dist/index.d.ts  1.17 KB
 DTS dist/index.d.cts 1.17 KB

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @rocketmq/serializer
+
+## 0.1.2
+
+### Patch Changes
+
+- docs: comprehensive README and API docs like Python SDK

package/README.md

@@ -0,0 +1,28 @@
+# @rocketmq/serializer
+
+Serialization adapters for RocketMQ payloads.
+
+This package provides the `Serializer` interface and a default `JsonSerializer` implementation used by the SDK to convert TypeScript objects to and from `Buffer` payloads for AMQP transmission.
+
+## Installation
+
+```bash
+npm install @rocketmq/serializer
+```
+
+## Usage
+
+The `JsonSerializer` is used by default in `@rocketmq/core`. You can implement the `Serializer` interface to create custom formats (e.g., Avro, MessagePack).
+
+```typescript
+import { JsonSerializer } from '@rocketmq/serializer';
+
+const serializer = new JsonSerializer();
+
+const buf = serializer.serialize({ hello: 'world' });
+const obj = serializer.deserialize(buf);
+```
+
+## License
+
+Apache 2.0

package/dist/index.cjs

@@ -3,6 +3,7 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -26,6 +27,9 @@ module.exports = __toCommonJS(index_exports);
 
 // src/json.ts
 var JsonSerializer = class {
+  static {
+    __name(this, "JsonSerializer");
+  }
   contentType = "application/json";
   serialize(value) {
     return Buffer.from(JSON.stringify(value));
@@ -38,3 +42,4 @@ var JsonSerializer = class {
 0 && (module.exports = {
   JsonSerializer
 });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/json.ts"],"sourcesContent":["export type { Serializer } from './types.js';\nexport { JsonSerializer } from './json.js';\n","/**\n * JSON serializer — default encoding for RocketMQ SDK.\n *\n * Produces `application/json` payloads that the Rust broker validates\n * by checking all proto schema fields are present in the JSON object.\n *\n * Usage:\n *   const s = new JsonSerializer();\n *   const buf = s.serialize({ id: \"1\" });\n */\n\nimport type { Serializer } from './types.js';\n\nexport class JsonSerializer implements Serializer {\n  readonly contentType = 'application/json';\n\n  serialize(value: unknown): Buffer {\n    return Buffer.from(JSON.stringify(value));\n  }\n\n  deserialize(buf: Buffer): unknown {\n    return JSON.parse(buf.toString());\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA;;;;;;;ACYO,IAAMA,iBAAN,MAAMA;EAbb,OAaaA;;;EACFC,cAAc;EAEvBC,UAAUC,OAAwB;AAChC,WAAOC,OAAOC,KAAKC,KAAKC,UAAUJ,KAAAA,CAAAA;EACpC;EAEAK,YAAYC,KAAsB;AAChC,WAAOH,KAAKI,MAAMD,IAAIE,SAAQ,CAAA;EAChC;AACF;","names":["JsonSerializer","contentType","serialize","value","Buffer","from","JSON","stringify","deserialize","buf","parse","toString"]}

package/dist/index.js

@@ -1,5 +1,11 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
 // src/json.ts
 var JsonSerializer = class {
+  static {
+    __name(this, "JsonSerializer");
+  }
   contentType = "application/json";
   serialize(value) {
     return Buffer.from(JSON.stringify(value));
@@ -11,3 +17,4 @@ var JsonSerializer = class {
 export {
   JsonSerializer
 };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/json.ts"],"sourcesContent":["/**\n * JSON serializer — default encoding for RocketMQ SDK.\n *\n * Produces `application/json` payloads that the Rust broker validates\n * by checking all proto schema fields are present in the JSON object.\n *\n * Usage:\n *   const s = new JsonSerializer();\n *   const buf = s.serialize({ id: \"1\" });\n */\n\nimport type { Serializer } from './types.js';\n\nexport class JsonSerializer implements Serializer {\n  readonly contentType = 'application/json';\n\n  serialize(value: unknown): Buffer {\n    return Buffer.from(JSON.stringify(value));\n  }\n\n  deserialize(buf: Buffer): unknown {\n    return JSON.parse(buf.toString());\n  }\n}\n"],"mappings":";;;;AAaO,IAAMA,iBAAN,MAAMA;EAbb,OAaaA;;;EACFC,cAAc;EAEvBC,UAAUC,OAAwB;AAChC,WAAOC,OAAOC,KAAKC,KAAKC,UAAUJ,KAAAA,CAAAA;EACpC;EAEAK,YAAYC,KAAsB;AAChC,WAAOH,KAAKI,MAAMD,IAAIE,SAAQ,CAAA;EAChC;AACF;","names":["JsonSerializer","contentType","serialize","value","Buffer","from","JSON","stringify","deserialize","buf","parse","toString"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocketmq/serializer",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "type": "module",
   "exports": {
     ".": {

package/tsup.config.ts

@@ -5,4 +5,5 @@ export default defineConfig({
   format: ["esm", "cjs"],
   dts: true,
   clean: true,
+  sourcemap: true,
 });