@rocketmq/core 0.1.1 → 0.1.3

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
 
-> @rocketmq/core@0.1.0 build /home/edilson/learnspace/rocketmq-broker/rocketmq.js/packages/core
+> @rocketmq/core@0.1.3 build /home/edilson/learnspace/rocketmq-broker/rocketmq.js/packages/core
 > tsup
 
 CLI Building entry: src/index.ts
@@ -11,11 +11,13 @@ CLI Target: es2022
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-CJS dist/index.cjs 11.01 KB
-CJS ⚡️ Build success in 14ms
-ESM dist/index.js 9.47 KB
-ESM ⚡️ Build success in 15ms
+ESM dist/index.js     140.69 KB
+ESM dist/index.js.map 287.29 KB
+ESM ⚡️ Build success in 93ms
+CJS dist/index.cjs     142.39 KB
+CJS dist/index.cjs.map 287.10 KB
+CJS ⚡️ Build success in 93ms
 DTS Build start
-DTS ⚡️ Build success in 521ms
-DTS dist/index.d.ts  6.69 KB
-DTS dist/index.d.cts 6.69 KB
+DTS ⚡️ Build success in 719ms
+DTS dist/index.d.ts  15.18 KB
+DTS dist/index.d.cts 15.18 KB

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# @rocketmq/core
+
+## 0.1.3
+
+### Patch Changes
+
+- docs: comprehensive README and API docs like Python SDK
+
+- Updated dependencies []:
+  - @rocketmq/schema@0.1.2
+  - @rocketmq/amqp@0.1.2
+  - @rocketmq/zod@0.1.1
+  - @rocketmq/protobuf@0.1.2
+  - @rocketmq/serializer@0.1.2

package/README.md

@@ -30,7 +30,7 @@ class Order {
 
 async function main() {
   const mq = await connect();
-  
+
   // Creates a typed queue handle and registers the schema with the broker
   const orders = await mq.queue('orders', Order);
 
@@ -44,6 +44,88 @@ async function main() {
 }
 ```
 
+### Classic API Style
+
+If you prefer the classic AMQP interface over the `QueueHandle` abstraction, you can use `assertQueue` directly while still benefiting from broker-side schema validation and client-side type inference:
+
+```typescript
+async function classicApiExample() {
+  const mq = await connect();
+
+  // Asserts the queue and registers the schema with the broker
+  await mq.assertQueue('orders', Order);
+
+  // Type-safe publishing
+  mq.sendToQueue('orders', { id: '123', quantity: 5 });
+
+  // Type-safe consumption — annotate the handler parameter for
+  // compile-time safety, and pass consumerSchema for broker-side
+  // validation (TypeScript erases types at runtime).
+  await mq.consume('orders', (order: Order) => {
+    console.log(`Received order: ${order.id} for ${order.quantity} items`);
+  }, { consumerSchema: Order });
+}
+```
+
+### Schema Lifecycle
+
+The broker enforces schema contracts on every publish. You can evolve or remove schemas at runtime using `schemaOverride` and `schemaDelete`.
+
+```typescript
+import { connect, Schema, Field } from '@rocketmq/core';
+
+@Schema()
+class OrderV1 {
+  @Field()
+  id!: string;
+
+  @Field({ type: 'int32' })
+  quantity!: number;
+
+  @Field()
+  customer!: string;
+}
+
+@Schema()
+class OrderV2 {
+  @Field()
+  id!: string;
+
+  @Field({ type: 'int32' })
+  quantity!: number;
+}
+
+async function schemaLifecycle() {
+  const mq = await connect();
+
+  // ── Step 1: Declare with schema ────────────────────────────
+  // The broker compiles OrderV1 into a proto descriptor and
+  // validates every published message against it.
+  await mq.assertQueue('orders', OrderV1);
+
+  mq.sendToQueue('orders', { id: '1', quantity: 5, customer: 'Acme' });
+  // ✅ Accepted — payload matches OrderV1
+
+  // ── Step 2: Override with a new schema ─────────────────────
+  // OrderV2 drops the "customer" field. Without schemaOverride
+  // this would fail with a PRECONDITION_FAILED (406) error.
+  await mq.assertQueue('orders', OrderV2, { schemaOverride: true });
+
+  mq.sendToQueue('orders', { id: '2', quantity: 10 });
+  // ✅ Accepted — payload matches OrderV2
+
+  // ── Step 3: Delete schema (schemaless mode) ────────────────
+  // Removes the schema binding entirely. The queue now accepts
+  // any JSON payload without validation.
+  await mq.assertQueue('orders', OrderV2, { schemaDelete: true });
+
+  mq.sendToQueue('orders', { anything: 'goes', nested: { ok: true } });
+  // ✅ Accepted — no schema to enforce
+}
+```
+
+> **Note**: `schemaOverride` and `schemaDelete` map to the AMQP queue arguments `x-schema-override` and `x-schema-delete` respectively.
+
 ## License
 
 Apache 2.0