@rocketmq/serializer 0.1.0

package/.turbo/turbo-build.log

@@ -0,0 +1,21 @@
+
+
+> @rocketmq/serializer@0.1.0 build /home/edilson/learnspace/rocketmq-broker/client-ts/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 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
+DTS Build start
+DTS ⚡️ Build success in 1037ms
+DTS dist/index.d.ts  1.17 KB
+DTS dist/index.d.cts 1.17 KB

package/dist/index.cjs

@@ -0,0 +1,40 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  JsonSerializer: () => JsonSerializer
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/json.ts
+var JsonSerializer = class {
+  contentType = "application/json";
+  serialize(value) {
+    return Buffer.from(JSON.stringify(value));
+  }
+  deserialize(buf) {
+    return JSON.parse(buf.toString());
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  JsonSerializer
+});

package/dist/index.d.cts

@@ -0,0 +1,38 @@
+/**
+ * Pluggable serialization interface.
+ *
+ * Decouples the SDK from any specific encoding format so users can
+ * swap JSON for Protobuf, Avro, or custom encodings without touching
+ * the publish/consume pipeline.
+ *
+ * Usage:
+ *   class MySerializer implements Serializer { ... }
+ *   const mq = await connect({ serializer: new MySerializer() });
+ */
+interface Serializer {
+    /** MIME content type sent in AMQP message properties. */
+    readonly contentType: string;
+    /** Encodes a value to a Buffer for AMQP transmission. */
+    serialize(value: unknown): Buffer;
+    /** Decodes a Buffer back into a structured value. */
+    deserialize(buf: Buffer): unknown;
+}
+
+/**
+ * JSON serializer — default encoding for RocketMQ SDK.
+ *
+ * Produces `application/json` payloads that the Rust broker validates
+ * by checking all proto schema fields are present in the JSON object.
+ *
+ * Usage:
+ *   const s = new JsonSerializer();
+ *   const buf = s.serialize({ id: "1" });
+ */
+
+declare class JsonSerializer implements Serializer {
+    readonly contentType = "application/json";
+    serialize(value: unknown): Buffer;
+    deserialize(buf: Buffer): unknown;
+}
+
+export { JsonSerializer, type Serializer };

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Pluggable serialization interface.
+ *
+ * Decouples the SDK from any specific encoding format so users can
+ * swap JSON for Protobuf, Avro, or custom encodings without touching
+ * the publish/consume pipeline.
+ *
+ * Usage:
+ *   class MySerializer implements Serializer { ... }
+ *   const mq = await connect({ serializer: new MySerializer() });
+ */
+interface Serializer {
+    /** MIME content type sent in AMQP message properties. */
+    readonly contentType: string;
+    /** Encodes a value to a Buffer for AMQP transmission. */
+    serialize(value: unknown): Buffer;
+    /** Decodes a Buffer back into a structured value. */
+    deserialize(buf: Buffer): unknown;
+}
+
+/**
+ * JSON serializer — default encoding for RocketMQ SDK.
+ *
+ * Produces `application/json` payloads that the Rust broker validates
+ * by checking all proto schema fields are present in the JSON object.
+ *
+ * Usage:
+ *   const s = new JsonSerializer();
+ *   const buf = s.serialize({ id: "1" });
+ */
+
+declare class JsonSerializer implements Serializer {
+    readonly contentType = "application/json";
+    serialize(value: unknown): Buffer;
+    deserialize(buf: Buffer): unknown;
+}
+
+export { JsonSerializer, type Serializer };

package/dist/index.js

@@ -0,0 +1,13 @@
+// src/json.ts
+var JsonSerializer = class {
+  contentType = "application/json";
+  serialize(value) {
+    return Buffer.from(JSON.stringify(value));
+  }
+  deserialize(buf) {
+    return JSON.parse(buf.toString());
+  }
+};
+export {
+  JsonSerializer
+};

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@rocketmq/serializer",
+  "version": "0.1.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run"
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export type { Serializer } from './types.js';
+export { JsonSerializer } from './json.js';

package/src/json.test.ts

@@ -0,0 +1,54 @@
+/**
+ * Tests for JsonSerializer.
+ *
+ * Covers serialize/deserialize round-trip, content type,
+ * and edge cases (empty object, nested, arrays).
+ */
+
+import { describe, it, expect } from 'vitest';
+import { JsonSerializer } from './json.js';
+
+describe('JsonSerializer', () => {
+  const serializer = new JsonSerializer();
+
+  it('has content type application/json', () => {
+    expect(serializer.contentType).toBe('application/json');
+  });
+
+  it('serializes an object to a Buffer', () => {
+    const buf = serializer.serialize({ id: '1', qty: 5 });
+    expect(Buffer.isBuffer(buf)).toBe(true);
+    expect(buf.toString()).toBe('{"id":"1","qty":5}');
+  });
+
+  it('deserializes a Buffer back to the original object', () => {
+    const original = { name: 'Alice', age: 30 };
+    const buf = serializer.serialize(original);
+    const result = serializer.deserialize(buf);
+    expect(result).toEqual(original);
+  });
+
+  it('round-trips empty object', () => {
+    const buf = serializer.serialize({});
+    expect(serializer.deserialize(buf)).toEqual({});
+  });
+
+  it('round-trips nested objects', () => {
+    const nested = { a: { b: { c: 1 } } };
+    const buf = serializer.serialize(nested);
+    expect(serializer.deserialize(buf)).toEqual(nested);
+  });
+
+  it('round-trips arrays', () => {
+    const arr = [1, 2, 3];
+    const buf = serializer.serialize(arr);
+    expect(serializer.deserialize(buf)).toEqual(arr);
+  });
+
+  it('serializes null and primitives', () => {
+    expect(serializer.deserialize(serializer.serialize(null))).toBeNull();
+    expect(serializer.deserialize(serializer.serialize(42))).toBe(42);
+    expect(serializer.deserialize(serializer.serialize('hello'))).toBe('hello');
+    expect(serializer.deserialize(serializer.serialize(true))).toBe(true);
+  });
+});

package/src/json.ts

@@ -0,0 +1,24 @@
+/**
+ * JSON serializer — default encoding for RocketMQ SDK.
+ *
+ * Produces `application/json` payloads that the Rust broker validates
+ * by checking all proto schema fields are present in the JSON object.
+ *
+ * Usage:
+ *   const s = new JsonSerializer();
+ *   const buf = s.serialize({ id: "1" });
+ */
+
+import type { Serializer } from './types.js';
+
+export class JsonSerializer implements Serializer {
+  readonly contentType = 'application/json';
+
+  serialize(value: unknown): Buffer {
+    return Buffer.from(JSON.stringify(value));
+  }
+
+  deserialize(buf: Buffer): unknown {
+    return JSON.parse(buf.toString());
+  }
+}

package/src/types.test.ts

@@ -0,0 +1,18 @@
+/**
+ * Tests for Serializer interface compliance.
+ *
+ * Verifies that JsonSerializer satisfies the Serializer contract.
+ */
+
+import { describe, it, expect } from 'vitest';
+import { JsonSerializer } from './json.js';
+import type { Serializer } from './types.js';
+
+describe('Serializer interface', () => {
+  it('JsonSerializer satisfies the Serializer interface', () => {
+    const s: Serializer = new JsonSerializer();
+    expect(s.contentType).toBeDefined();
+    expect(typeof s.serialize).toBe('function');
+    expect(typeof s.deserialize).toBe('function');
+  });
+});

package/src/types.ts

@@ -0,0 +1,21 @@
+/**
+ * Pluggable serialization interface.
+ *
+ * Decouples the SDK from any specific encoding format so users can
+ * swap JSON for Protobuf, Avro, or custom encodings without touching
+ * the publish/consume pipeline.
+ *
+ * Usage:
+ *   class MySerializer implements Serializer { ... }
+ *   const mq = await connect({ serializer: new MySerializer() });
+ */
+export interface Serializer {
+  /** MIME content type sent in AMQP message properties. */
+  readonly contentType: string;
+
+  /** Encodes a value to a Buffer for AMQP transmission. */
+  serialize(value: unknown): Buffer;
+
+  /** Decodes a Buffer back into a structured value. */
+  deserialize(buf: Buffer): unknown;
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src"]
+}

package/tsup.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: ["src/index.ts"],
+  format: ["esm", "cjs"],
+  dts: true,
+  clean: true,
+});