@stacksjs/scheduler 0.52.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2022 Open Web Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,137 @@
+# Stacks SMS
+
+Stacks SMS is driver system for sending SMS messages.
+
+## ☘️ Features
+
+- 📦 Send SMS
+
+## 🤖 Usage
+
+```bash
+pnpm i -D @stacksjs/sms
+```
+
+You may now use it in your project:
+
+```ts
+import * as sms from '@stacksjs/sms'
+
+/* Then choose a driver. E.g for twilio */
+const notification = sms.twilio
+
+notification.send(SMSOptions)
+
+interface SMSOptions {
+  to: string
+  content: string
+  from?: string
+  attachments?: AttachmentOptions[]
+  id?: string
+}
+```
+
+### Drivers
+
+Drivers are configured with the following environment variables:
+
+#### Twilio
+
+```bash
+TWILIO_ACCOUNT_SID=ACtest
+TWILIO_AUTH_TOKEN=testtoken
+TWILIO_FROM_NUMBER=+112345
+TWILIO_TO_NUMBER=+145678
+```
+
+#### Nexmo
+
+```bash
+VONAGE_API_KEY=VN123
+VONAGE_API_SECRET=testkey
+VONAGE_FROM_NUMBER=+112345
+```
+
+#### Gupshup
+
+```bash
+GUPSHUP_USER_ID=GU123
+GUPSHUP_PASSWORD=password
+```
+
+#### Plivo
+
+```bash
+PLIVO_ACCOUNT_ID=PA123
+PLIVO_AUTH_TOKEN=testtoken
+PLIVO_FROM_NUMBER=+112345
+```
+
+#### SMS77
+
+```bash
+SMS77_API_KEY=SA123
+SMS77_FROM=from@example.com
+```
+
+#### SNS
+
+```bash
+SMS77_API_KEY=SA123
+SMS77_FROM=from@example.com
+```
+
+#### Telnyx
+
+```bash
+TELNYX_API_KEY=TA123
+TELNYX_MESSAGE_PROFILE_ID=testprofileid
+TELNYX_FROM=from@example.com
+```
+
+#### Termii
+
+```bash
+TERMII_API_KEY=TermA123
+TERMII_SENDER=from@example.com
+```
+
+Learn more in the docs.
+
+## 🧪 Testing
+
+```bash
+pnpm test
+```
+
+## 📈 Changelog
+
+Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
+
+## 🚜 Contributing
+
+Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
+
+## 🏝 Community
+
+For help, discussion about best practices, or any other conversation that would benefit from being searchable:
+
+[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
+
+For casual chit-chat with others using this package:
+
+[Join the Stacks Discord Server](https://discord.ow3.org)
+
+## 🙏🏼 Credits
+
+Many thanks to the following core technologies & people who have contributed to this package:
+
+- [Chris Breuer](https://github.com/chrisbbreuer)
+- [Novu](https://novu.co/)
+- [All Contributors](../../contributors)
+
+## 📄 License
+
+The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
+
+Made with ❤️

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+export interface Scheduler {
+    everySecond: () => void;
+    everySeconds: (seconds: number) => void;
+    everyMinute: () => void;
+    everyMinutes: (minutes: number) => void;
+    everyTwoMinutes: () => void;
+    everyThreeMinutes: () => void;
+    everyFourMinutes: () => void;
+    everyFiveMinutes: () => void;
+    everyTenMinutes: () => void;
+    everyFifteenMinutes: () => void;
+    everyThirtyMinutes: () => void;
+    hourly: () => void;
+    hourlyAt: (minute: number) => void;
+    everyOddHour: () => void;
+    everyHours: (hours: number) => void;
+    everyTwoHours: () => void;
+    everyThreeHours: () => void;
+    everyFourHours: () => void;
+    everySixHours: () => void;
+    daily: () => void;
+    dailyAt: (hour: number, minute: number) => void;
+    everyDays: (days: number) => void;
+    weekly: () => void;
+    quarterly: () => void;
+    yearly: () => void;
+    cron: (interval: string, timezone?: string) => void;
+}
+declare function run(callback: ((now: Date | 'manual' | 'init') => void) | string): Scheduler;
+export declare function useScheduler(): {
+    run: typeof run;
+};
+export {};

package/dist/index.mjs

@@ -0,0 +1,88 @@
+import cron from "node-cron";
+function run(callback) {
+  return {
+    everySecond: () => {
+      cron.schedule("* * * * * *", callback);
+    },
+    everySeconds: (seconds = 1) => {
+      cron.schedule(`*/${seconds} * * * * *`, callback);
+    },
+    everyMinute: () => {
+      cron.schedule("* * * * *", callback);
+    },
+    everyTwoMinutes: () => {
+      cron.schedule("*/2 * * * *", callback);
+    },
+    everyThreeMinutes: () => {
+      cron.schedule("*/3 * * * *", callback);
+    },
+    everyFourMinutes: () => {
+      cron.schedule("*/4 * * * *", callback);
+    },
+    everyFiveMinutes: () => {
+      cron.schedule("*/5 * * * *", callback);
+    },
+    everyTenMinutes: () => {
+      cron.schedule("*/10 * * * *", callback);
+    },
+    everyFifteenMinutes: () => {
+      cron.schedule("*/15 * * * *", callback);
+    },
+    everyThirtyMinutes: () => {
+      cron.schedule("*/30 * * * *", callback);
+    },
+    everyMinutes: (minutes) => {
+      cron.schedule(`*/${minutes} * * * *`, callback);
+    },
+    hourly: () => {
+      cron.schedule("0 * * * *", callback);
+    },
+    everyHours: (hours) => {
+      cron.schedule(`0 */${hours} * * *`, callback);
+    },
+    hourlyAt: (minute) => {
+      cron.schedule(`${minute} * * * *`, callback);
+    },
+    everyOddHour: () => {
+      cron.schedule("0 */2 * * *", callback);
+    },
+    everyTwoHours: () => {
+      cron.schedule("0 */2 * * *", callback);
+    },
+    everyThreeHours: () => {
+      cron.schedule("0 */3 * * *", callback);
+    },
+    everyFourHours: () => {
+      cron.schedule("0 */4 * * *", callback);
+    },
+    everySixHours: () => {
+      cron.schedule("0 */6 * * *", callback);
+    },
+    dailyAt: (hour, minute) => {
+      cron.schedule(`${minute} ${hour} * * *`, callback);
+    },
+    daily: () => {
+      cron.schedule("0 0 * * *", callback);
+    },
+    everyDays: (days) => {
+      cron.schedule(`0 0 */${days} * *`, callback);
+    },
+    weekly: () => {
+      cron.schedule("0 0 * * 0", callback);
+    },
+    quarterly: () => {
+      cron.schedule("0 0 1 */3 *", callback);
+    },
+    yearly: () => {
+      cron.schedule("0 0 1 1 *", callback);
+    },
+    cron: (interval, timezone) => {
+      timezone ? cron.schedule(interval, callback, { scheduled: true, timezone }) : cron.schedule(interval, callback);
+    }
+  };
+}
+export function useScheduler() {
+  return {
+    run
+  };
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@stacksjs/scheduler",
+  "type": "module",
+  "version": "0.52.0",
+  "packageManager": "pnpm@8.5.1",
+  "description": "The Stacks scheduler.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/scheduler#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/scheduler"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "scheduler",
+    "stacks"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "contributors": [
+    "Chris Breuer <chris@ow3.org>"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "node-cron": "3.0.2"
+  },
+  "devDependencies": {
+    "@types/node-cron": "^3.0.7",
+    "@stacksjs/development": "0.52.0"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --stub",
+    "typecheck": "tsc --noEmit"
+  }
+}