Skip to content

Commit 45a52af

Browse files
Sunny TyagiSunny Tyagi
Sunny Tyagi
authored and
Sunny Tyagi
committed
refactor(pkg): update package name and remove tar files
update package name and remove tar files gh-3
1 parent 42efbea commit 45a52af

6 files changed

+60
-29
lines changed

‎README.md

Lines changed: 55 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,65 @@
1-
<p align="center">
2-
<a href="https://sourcefuse.github.io/arc-docs/arc-api-docs" target="blank"><img src="https://github.com/sourcefuse/loopback4-microservice-catalog/blob/master/docs/assets/logo-dark-bg.png?raw=true" width="180" alt="ARC Logo" /></a>
3-
</p>
1+
<a href="https://sourcefuse.github.io/arc-docs/arc-api-docs" target="_blank"><img src="https://github.com/sourcefuse/loopback4-microservice-catalog/blob/master/docs/assets/logo-dark-bg.png?raw=true" alt="ARC By SourceFuse logo" title="ARC By SourceFuse" align="right" width="150" /></a>
42

5-
ARC by SourceFuse is an open-source Rapid Application Development framework for developing cloud-native enterprise applications, utilizing prebuilt microservices and standardized architectures for deployment on private and public clouds.
6-
</p>
3+
# [loopback4-message-queue-connector](https://github.com/sourcefuse/loopback4-message-queue-connector)
74

8-
<p align="center">
9-
<a href="https://sonarcloud.io/summary/new_code?id=sourcefuse_loopback4-message-bus-queue-connector" target="_blank">
10-
<img alt="Sonar Quality Gate" src="https://img.shields.io/sonar/quality_gate/sourcefuse_loopback4-s3?server=https%3A%2F%2Fsonarcloud.io">
5+
<p align="left">
6+
<a href="https://www.npmjs.com/package/loopback4-message-queue-connector">
7+
<img src="https://img.shields.io/npm/v/loopback4-message-queue-connector.svg" alt="npm version" />
8+
</a>
9+
<a href="https://sonarcloud.io/summary/new_code?id=sourcefuse_loopback4-message-queue-connector" target="_blank">
10+
<img alt="Sonar Quality Gate" src="https://img.shields.io/sonar/quality_gate/sourcefuse_loopback4-message-queue-connector?server=https%3A%2F%2Fsonarcloud.io">
1111
</a>
12-
<a href="https://app.snyk.io/org/ashishkaushik/reporting?context[page]=issues-detail&project_target=%255B%2522sourcefuse%252Floopback4-message-bus-queue-connector%2522%255D&project_origin=%255B%2522github%2522%255D&issue_status=%255B%2522Open%2522%255D&issue_by=Severity&table_issues_detail_cols=SEVERITY%257CSCORE%257CCVE%257CCWE%257CPROJECT%257CEXPLOIT%2520MATURITY%257CCOMPUTED%2520FIXABILITY%257CINTRODUCED%257CSNYK%2520PRODUCT&tableRowsPerPage=10&v=1&table_issues_detail_sort=SCORE%2520DESC">
12+
<a href="https://app.snyk.io/org/ashishkaushik/reporting?context[page]=issues-detail&project_target=%255B%2522sourcefuse%252Floopback4-message-queue-connector%2522%255D&project_origin=%255B%2522github%2522%255D&issue_status=%255B%2522Open%2522%255D&issue_by=Severity&table_issues_detail_cols=SCORE%257CCVE%257CCWE%257CPROJECT%257CEXPLOIT%2520MATURITY%257CAUTO%2520FIXABLE%257CINTRODUCED%257CSNYK%2520PRODUCT&v=1">
1313
<img alt="Synk Status" src="https://img.shields.io/badge/SYNK_SECURITY-MONITORED-GREEN">
1414
</a>
15-
<a href="https://github.com/sourcefuse/loopback4-message-bus-queue-connector/graphs/contributors" target="_blank">
16-
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/sourcefuse/loopback4-s3">
15+
<a href="https://github.com/sourcefuse/loopback4-message-queue-connector/graphs/contributors" target="_blank">
16+
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/sourcefuse/loopback4-message-queue-connector?">
1717
</a>
18-
<a href="https://www.npmjs.com/package/loopback4-message-bus-queue-connector" target="_blank">
19-
<img alt="downloads" src="https://img.shields.io/npm/dw/loopback4-s3.svg">
18+
<a href="https://www.npmjs.com/package/loopback4-message-queue-connector" target="_blank">
19+
<img alt="downloads" src="https://img.shields.io/npm/dw/loopback4-message-queue-connector.svg">
2020
</a>
21-
<a href="https://github.com/sourcefuse/loopback4-message-bus-queue-connector/blob/master/LICENSE">
22-
<img src="https://img.shields.io/github/license/sourcefuse/loopback4-s3.svg" alt="License" />
21+
<a href="https://github.com/sourcefuse/loopback4-message-queue-connector/blob/master/LICENSE">
22+
<img src="https://img.shields.io/github/license/sourcefuse/loopback4-message-queue-connector.svg" alt="License" />
2323
</a>
2424
<a href="https://loopback.io/" target="_blank">
2525
<img alt="Powered By LoopBack 4" src="https://img.shields.io/badge/Powered%20by-LoopBack 4-brightgreen" />
2626
</a>
27+
</p>
28+
29+
# Overview
30+
31+
This is a LoopBack 4 extension for adding message queue-based communication to your LoopBack applications. It provides a unified and extensible interface for working with different queuing systems.
32+
33+
✅ Supported Queue Connectors
34+
35+
- SQSConnector – Integrates with AWS SQS using @aws-sdk/client-sqs. Supports both message sending and consumption with polling, visibility timeout, etc.
36+
37+
- BullMQConnector – Integrates with BullMQ (Redis-based queue). Supports advanced job options like retries, backoff, consumer concurrency, and job polling.
38+
39+
- EventBridge - Allows sending events to AWS EventBridge with support for event buses and schemas. Provides the HTTPS endpoint for receiving events.
40+
41+
🧩 Core Features
42+
- Component Based Approach
43+
Central registry for queue components, enabling multi-queue usage in a single application.
44+
45+
- @producer() Decorator
46+
Injects a producer for sending single or multiple typed events to any configured queue.
47+
48+
- @consumer Decorator
49+
Registers a service class as a consumer for a specific event and queue, handling messages automatically.
50+
51+
- IProducer Interface
52+
Exposes send() and sendMultiple() methods to send messages to queues.
53+
54+
- IConsumer Interface
55+
Allows you to implement a handler for a specific event type and queue, supporting strongly typed data flow.
56+
57+
- Typed Event Streams
58+
Encourages defining typed contracts for all events, improving consistency and type safety between producers and consumers.
59+
60+
You can configure one or more of the supported queue types in your application. For each, you simply provide the required connection and queue configuration. The rest—producer/consumer setup, bindings, and event handling—is abstracted and managed by the extension.
2761

28-
# Message bus queue connectors
2962

30-
This is the package for the message bus queue connectors component for LoopBack 4 applications.
31-
It provides components to work with queues such as SQS, BullMQ and EventBridge
3263

3364
[![LoopBack](<https://github.com/loopbackio/loopback-next/raw/master/docs/site/imgs/branding/Powered-by-LoopBack-Badge-(blue)-@2x.png>)](http://loopback.io/)
3465

@@ -37,7 +68,7 @@ It provides components to work with queues such as SQS, BullMQ and EventBridge
3768
Install EventStreamConnectorComponent using `npm`;
3869

3970
```sh
40-
$ [npm install | yarn add] @sourceloop/message-bus-queue-connectors
71+
$ [npm install | yarn add] loopback4-message-queue-connector
4172
```
4273
## Flow Diagram
4374

@@ -51,7 +82,7 @@ as shown below.
5182
```ts
5283
import {
5384
EventStreamConnectorComponent
54-
} from '@sourceloop/message-bus-queue-connectors';
85+
} from 'loopback4-message-queue-connector';
5586

5687
// ...
5788
export class MyApplication extends BootMixin(
@@ -75,7 +106,7 @@ import {
75106
SQSConnector,
76107
SQSBindings,
77108
EventStreamConnectorComponent
78-
} from '@sourceloop/message-bus-queue-connectors';
109+
} from 'loopback4-message-queue-connector';
79110

80111
// ...
81112
export class MyApplication extends BootMixin(
@@ -134,7 +165,7 @@ import {
134165
BullMQConnector,
135166
BullMQBindings,
136167
EventStreamConnectorComponent,
137-
} from '@sourceloop/message-bus-queue-connectors';
168+
} from 'loopback4-message-queue-connector';
138169

139170
// ...
140171
export class MyApplication extends BootMixin(
@@ -183,7 +214,7 @@ const config = {
183214

184215
## Integration
185216

186-
@sourceloop/message-bus-queue-connectors provides a decorator '@producer()' that can be used to access the producer of each msg queue. It expects one arguement defining the type of queue, of which producer u want to use. like
217+
loopback4-message-queue-connector provides a decorator '@producer()' that can be used to access the producer of each msg queue. It expects one arguement defining the type of queue, of which producer u want to use. like
187218

188219
```ts
189220
@injectable({scope: BindingScope.TRANSIENT})
@@ -228,7 +259,7 @@ import {
228259
IConsumer,
229260
QueueType,
230261
consumer,
231-
} from '@sourceloop/message-bus-queue-connectors';
262+
} from 'loopback4-message-queue-connector';
232263
import { OrchestratorStream, EventTypes, ProvisioningInputs } from '../../types';
233264

234265
@consumer

‎local-message-bus-queue-connectors-0.0.1.tgz

-32.2 KB
Binary file not shown.

‎package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "@sourceloop/message-bus-queue-connectors",
2+
"name": "loopback4-message-queue-connector",
33
"version": "0.0.1",
4-
"description": "message-bus-queue-connectors",
4+
"description": "loopback4-message-queue-connectors",
55
"keywords": [
66
"loopback-extension",
77
"loopback"

‎sourceloop-message-bus-queue-connectors-0.0.1.tgz

-32.2 KB
Binary file not shown.

‎tsconfig.tsbuildinfo

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)