agenda-ts 1.6.9-beta.2 → 1.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +24 -37
  2. package/package.json +5 -3
package/README.md CHANGED
@@ -2,17 +2,24 @@
2
2
  <img src="./agenda.png" width="100" alt="project-logo">
3
3
  </p>
4
4
  <p align="center">
5
- <h1 align="center">AGENDA-TS</h1>
5
+ <h1 align="center">AGENDA-TS</h1>
6
6
  </p>
7
7
  <p align="center">
8
8
  <em>The modern MongoDB-powered job scheduler library for Node.js</em>
9
9
  </p>
10
- <p align="center">
11
- <img src="https://img.shields.io/github/license/meabed/agenda-ts?style=default&logo=opensourceinitiative&logoColor=white&color=24E0A4" alt="license">
12
- <img src="https://img.shields.io/github/last-commit/meabed/agenda-ts?style=default&logo=git&logoColor=white&color=24E0A4" alt="last-commit">
13
- <img src="https://img.shields.io/github/languages/top/meabed/agenda-ts?style=default&color=24E0A4" alt="repo-top-language">
14
- <img src="https://img.shields.io/github/languages/count/meabed/agenda-ts?style=default&color=24E0A4" alt="repo-language-count">
15
- <p>
10
+
11
+ <div align="center">
12
+
13
+ [![NPM version](https://img.shields.io/npm/v/agenda-ts)](https://npm.im/agenda-ts)
14
+ [![Build Status](https://github.com/meabed/agenda-ts/actions/workflows/release.yml/badge.svg)](https://github.com/meabed/agenda-ts/actions)
15
+ [![Test Coverage](https://img.shields.io/badge/coverage-91.62%25-brightgreen)](https://github.com/meabed/agenda-ts)
16
+ [![Downloads](https://img.shields.io/npm/dm/agenda-ts.svg)](https://www.npmjs.com/package/agenda-ts)
17
+ [![License](https://img.shields.io/npm/l/agenda-ts)](https://github.com/meabed/agenda-ts/blob/master/LICENSE)
18
+ [![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue)](https://www.typescriptlang.org/)
19
+ [![Node](https://img.shields.io/node/v/agenda-ts)](https://nodejs.org)
20
+
21
+ </div>
22
+
16
23
  <p align="center">
17
24
  <!-- default option, no dependency badges. -->
18
25
  </p>
@@ -26,14 +33,13 @@
26
33
  <summary>Table of Contents</summary><br>
27
34
 
28
35
  - [Overview](#overview)
29
- - [Related Projects](#related-projects)
36
+ - [Related Projects](#related-projects)
30
37
  - [Unique Features in Agenda-TS](#unique-features-in-agenda-ts)
31
38
  - [Repository Structure](#repository-structure)
32
39
  - [Modules](#modules)
33
40
  - [Getting Started](#getting-started)
34
- - [Installation](#installation)
35
- - [Example](#example)
36
- - [Project Roadmap](#project-roadmap)
41
+ - [Installation](#installation)
42
+ - [Example](#example)
37
43
  - [Contributing](#contributing)
38
44
  - [License](#license)
39
45
  - [Acknowledgments](#acknowledgments)
@@ -46,9 +52,9 @@ Agenda-TS is a modern TypeScript fork of the [Agenda](https://github.com/agenda/
46
52
 
47
53
  <br/>
48
54
 
49
- #### Related Projects
50
- - [agenda-ts](https://github.com/meabed/agenda-ts) - Modern MongoDB-powered job scheduler for Node.js
51
- - [nestjs-agenda-ts](https://github.com/meabed/nestjs-agenda-ts) - official NestJS module for Agenda-TS.
55
+ > This package is forked version from [pulse](https://github.com/pulsecron/pulse/)
56
+ >
57
+ > It has been updated, fixed few bugs, actively adding features and updated dependencies and codebase to the latest packages
52
58
 
53
59
  ---
54
60
 
@@ -56,9 +62,9 @@ Agenda-TS is a modern TypeScript fork of the [Agenda](https://github.com/agenda/
56
62
  <br/>
57
63
 
58
64
 
59
- ## Unique Features in Agenda-TS
65
+ ## Unique Features in Agenda
60
66
 
61
- - **Latest MongoDB Driver Support**: Agenda-TS is fully compatible with the latest MongoDB driver, ensuring users can take advantage of the most current database features and enhancements.
67
+ - **Latest MongoDB Driver Support**: Agenda is fully compatible with the latest MongoDB driver, ensuring users can take advantage of the most current database features and enhancements.
62
68
  - **Resume Incomplete Tasks After System Restart**: When the system restarts, Agenda-TS resumes incomplete tasks that were in progress or queued for execution, providing seamless continuation without manual intervention.
63
69
  - **Retry Failed Tasks**: Agenda-TS offers retry mechanisms using exponential and fixed backoff strategies with configurable attempts, ensuring efficient retries of failed tasks without overwhelming the system.
64
70
  - **Continuous Maintenance**: As an open-source project actively maintained, Agenda-TS is consistently improved, providing users with reliable updates and support.
@@ -71,7 +77,7 @@ Agenda-TS is a modern TypeScript fork of the [Agenda](https://github.com/agenda/
71
77
  ## Repository Structure
72
78
 
73
79
  ```sh
74
- └── agenda-ts/
80
+ └── agenda/
75
81
  ├── LICENSE
76
82
  ├── README.md
77
83
  ├── es.js
@@ -282,17 +288,6 @@ function time() {
282
288
  <br/>
283
289
  <br/>
284
290
 
285
- ## Project Roadmap
286
-
287
- - [X] **Add Support for Latest Mongoose Version(8.x.x)**: Upgrade Agenda-TS to be fully compatible with the latest version of Mongoose. This will enable Agenda-TS to leverage the newest features and improvements in Mongoose, ensuring better performance, stability, and security for applications that rely on MongoDB through Mongoose.
288
- - [X] **Refactoring to Modern TypeScript Syntax**: Undertake a comprehensive refactor of the codebase to utilize modern TypeScript features and syntax. This refactoring will improve code readability, maintainability, and make it easier for new contributors to understand and contribute to the project.
289
- - [X] **Resolving Issues in Existing Agenda Projects**: Actively address and resolve outstanding issues within the original Agenda project. This initiative not only aids the community by improving the legacy codebase but also informs the development of Agenda by identifying and addressing past challenges.
290
- - [ ] **Rewrite Test Code**: Revamp our testing suite to increase coverage and ensure tests are up-to-date with modern testing practices. This rewrite aims to enhance test reliability and efficiency, facilitating smoother development and deployment cycles.
291
- - [X] **Rewrite Documentation**: Completely revise and update the documentation to reflect all new changes and features, ensure clarity of information, and improve navigation and readability for developers. This effort will include new getting started guides, API documentation, and use case examples to facilitate easier adoption and implementation by users.
292
- ---
293
- <br/>
294
- <br/>
295
-
296
291
  ## Contributing
297
292
 
298
293
  Contributions are welcome! Here are several ways you can contribute:
@@ -342,12 +337,4 @@ Contributions are welcome! Here are several ways you can contribute:
342
337
 
343
338
  ## License
344
339
 
345
- This project is protected under the [MIT](https://github.com/meabed/agenda-ts?tab=MIT-1-ov-file#readme) License. For more details, refer to the [LICENSE](https://github.com/meabed/agenda-ts?tab=MIT-1-ov-file#readme) file.
346
-
347
- ---
348
- <br/>
349
- <br/>
350
-
351
-
352
- ## Acknowledgments
353
- - Agenda-TS is maintained by [Mohamed Meabed](https://github.com/meabed) and was forked from the [Agenda](https://github.com/agenda/agenda) project.
340
+ This project is protected under the [MIT](https://github.com/meabed/agenda-ts?tab=MIT-1-ov-file#readme) License.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agenda-ts",
3
- "version": "1.6.9-beta.2",
3
+ "version": "1.7.1",
4
4
  "description": "The modern MongoDB-powered job scheduler library for Node.js",
5
5
  "keywords": [
6
6
  "job",
@@ -13,7 +13,7 @@
13
13
  "queue",
14
14
  "delayed",
15
15
  "scheduler",
16
- "pulse",
16
+ "agenda",
17
17
  "bull",
18
18
  "bee",
19
19
  "kue"
@@ -49,6 +49,8 @@
49
49
  "test": "jest --detectOpenHandles --forceExit",
50
50
  "test:coverage": "jest --coverage",
51
51
  "test:debug": "DEBUG=agenda:** jest",
52
+ "test-prev-vers-6": "yarn add mongodb@6 --dev --ignore-scripts && yarn test && git checkout HEAD -- package.json yarn.lock",
53
+ "test-prev-vers-7": "yarn add mongodb@7 --dev --ignore-scripts && yarn test && git checkout HEAD -- package.json yarn.lock",
52
54
  "typecheck": "tsc --noEmit"
53
55
  },
54
56
  "config": {
@@ -63,7 +65,7 @@
63
65
  "debug": "~4.4.3",
64
66
  "human-interval": "~2.0.1",
65
67
  "moment-timezone": "^0.6.0",
66
- "mongodb": "^7.0.0"
68
+ "mongodb": "^7 || ^6"
67
69
  },
68
70
  "devDependencies": {
69
71
  "@istanbuljs/nyc-config-typescript": "^1.0.2",