@cargolift-cdi/types 0.1.0 → 0.1.2

package/README.md

@@ -1,22 +1,59 @@
-# cargolift-types
+# @cargolift-cdi/types
 
-Shared TypeScript types and interfaces for Node.js projects.
+Shared TypeScript types and interfaces for Node.js projects. This package is types-only (no runtime JS).
 
 ## Install
 
 ```bash
-npm install cargolift-types
+# npm
+npm install -D @cargolift-cdi/types
+
+# pnpm
+pnpm add -D @cargolift-cdi/types
+
+# yarn
+yarn add -D @cargolift-cdi/types
 ```
 
 ## Usage
 
+Use type-only imports to avoid emitting runtime code:
+
 ```ts
-import { RabbitMQMessage, RabbitMQChannel } from '@cargolift-cdi/types';
+import type { RabbitMQMessage, RabbitMQChannel } from '@cargolift-cdi/types';
+
+function handleMessage(msg: RabbitMQMessage, channel: RabbitMQChannel) {
+	const correlationId = msg.properties.headers['x-correlation-id'];
+	// ...process...
+	channel.ack(msg);
+}
+```
+
+Example with amqplib:
+
+```ts
+import amqp from 'amqplib';
+import type { RabbitMQMessage } from '@cargolift-cdi/types';
+
+const conn = await amqp.connect(process.env.AMQP_URL!);
+const ch = await conn.createChannel();
+await ch.assertQueue('jobs');
+
+ch.consume('jobs', (msg) => {
+	if (!msg) return;
+	const typedMsg = msg as unknown as RabbitMQMessage;
+	// use typedMsg.content, typedMsg.properties.headers, etc.
+	ch.ack(msg);
+});
 ```
 
 ## What’s inside
 
-- `rabbitmq.interfaces`: tipos para mensagens e canal RabbitMQ
+- `rabbitmq.interfaces`: tipos para mensagens e canal RabbitMQ.
+
+Notes
+- This package ships only `.d.ts` files. There is no runtime code.
+- Prefer `import type` (TS 4.5+) so bundlers/Node don’t try to load a runtime module.
 
 ## Development
 

package/dist/{rabbitmq.interfaces.d.ts → amqp.interfaces.d.ts}

@@ -1,4 +1,4 @@
-export interface RabbitMQMessage {
+export interface AMQPMessage {
     fields: any;
     content: Buffer;
     properties: {
@@ -6,10 +6,10 @@ export interface RabbitMQMessage {
         [key: string]: any;
     };
 }
-export interface RabbitMQChannel {
+export interface AMQPChannel {
     publish: (exchange: string, routingKey: string, content: Buffer, options: {
         headers: Record<string, any>;
     }) => boolean;
-    ack: (msg: RabbitMQMessage) => void;
+    ack: (msg: AMQPMessage) => void;
 }
-//# sourceMappingURL=rabbitmq.interfaces.d.ts.map
+//# sourceMappingURL=amqp.interfaces.d.ts.map

package/dist/amqp.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"amqp.interfaces.d.ts","sourceRoot":"","sources":["../src/amqp.interfaces.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,GAAG,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE;QACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,CACP,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,KACtC,OAAO,CAAC;IACb,GAAG,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,IAAI,CAAC;CACjC"}

package/dist/index.d.ts

@@ -2,5 +2,5 @@
  * Public export surface for shared types.
  * Keep exports stable to avoid breaking downstream projects.
  */
-export * from './rabbitmq.interfaces';
+export * from './amqp.interfaces';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,mBAAmB,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cargolift-cdi/types",
-  "version": "0.1.0",
-  "description": "Shared TypeScript types and interfaces for Node.js projects",
+  "version": "0.1.2",
+  "description": "TypeScript types e interfaces comuns para projetos Cargolift CDI",
   "keywords": [
     "typescript",
     "types",

package/dist/rabbitmq.interfaces.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"rabbitmq.interfaces.d.ts","sourceRoot":"","sources":["../src/rabbitmq.interfaces.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,GAAG,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE;QACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,CACP,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,KACtC,OAAO,CAAC;IACb,GAAG,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAC;CACrC"}