@rocketmq/core 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,70 @@
+# @rocketmq/core
+
+The main RocketMQ client SDK for Node.js. It provides a high-level, schema-aware API for AMQP messaging.
+
+## Features
+
+- **Schema-Aware Queues**: Tie a queue directly to a TypeScript class using decorators.
+- **Type-Safe Messaging**: Compile-time type safety for `send()` and `consume()`.
+- **Broker-Side Validation**: Integrates directly with RocketMQ's queue-native schema validation.
+
+## Installation
+
+```bash
+npm install @rocketmq/core
+```
+
+## Quick Start
+
+```typescript
+import { connect, Schema, Field } from '@rocketmq/core';
+
+@Schema()
+class Order {
+  @Field()
+  id!: string;
+
+  @Field({ type: 'int32' })
+  quantity!: number;
+}
+
+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);
+
+  // Type-safe consumption
+  await orders.consume((order) => {
+    console.log(`Received order: ${order.id} for ${order.quantity} items`);
+  });
+
+  // Type-safe publishing
+  orders.send({ id: '123', quantity: 5 });
+}
+```
+
+### 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 consumption
+  await mq.consume('orders', (order) => {
+    console.log(`Received order: ${order.id} for ${order.quantity} items`);
+  });
+
+  // Type-safe publishing
+  mq.sendToQueue('orders', { id: '123', quantity: 5 });
+}
+```
+
+## License
+
+Apache 2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocketmq/core",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "type": "module",
   "exports": {
     ".": {
@@ -9,10 +9,10 @@
     }
   },
   "dependencies": {
-    "@rocketmq/amqp": "0.1.0",
-    "@rocketmq/protobuf": "0.1.0",
-    "@rocketmq/schema": "0.1.0",
-    "@rocketmq/serializer": "0.1.0"
+    "@rocketmq/schema": "0.1.1",
+    "@rocketmq/serializer": "0.1.1",
+    "@rocketmq/protobuf": "0.1.1",
+    "@rocketmq/amqp": "0.1.1"
   },
   "scripts": {
     "build": "tsup",