chore: wip

Author: chrisbbreuer

.stacks/core/actions/src/clean.ts

@@ -1,25 +1,14 @@
 import { log, runCommand } from '@stacksjs/cli'
-import { type CleanOptions, ExitCode, NpmScript } from '@stacksjs/types'
+import { ExitCode, NpmScript } from '@stacksjs/types'
 
-export async function invoke(options?: CleanOptions) {
-  log.info('Running clean command...')
+log.info('Running clean command...')
 
-  const result = await runCommand(NpmScript.Clean, options)
+const result = await runCommand(NpmScript.Clean)
 
-  if (result.isOk()) {
-    log.success('Cleaned up')
-    process.exit(ExitCode.Success)
-  }
-
-  log.error(result.error)
-  process.exit(ExitCode.FatalError)
+if (result.isOk()) {
+  log.success('Cleaned up')
+  process.exit(ExitCode.Success)
 }
 
-/**
- * An alias of the invoke method.
- * @param options
- * @returns
- */
-export async function clean(options: CleanOptions) {
-  return invoke(options)
-}
+log.error(result.error)
+process.exit(ExitCode.FatalError)

.stacks/core/alias/src/index.ts

@@ -74,6 +74,8 @@ const alias: Record<string, string> = {
   '@stacksjs/serverless/*': p.serverlessPath('src/*'),
   '@stacksjs/sms': p.smsPath('src/index.ts'),
   '@stacksjs/sms/*': p.smsPath('src/*'),
+  '@stacksjs/scheduler': p.schedulerPath('src/index.ts'),
+  '@stacksjs/scheduler/*': p.schedulerPath('src/*'),
   '@stacksjs/signals': p.signalsPath('src/index.ts'),
   '@stacksjs/signals/*': p.signalsPath('src/*'),
   '@stacksjs/storage': p.storagePath('src/index.ts'),

.stacks/core/buddy/src/commands/clean.ts

@@ -1,5 +1,6 @@
 import type { CLI, CleanOptions } from '@stacksjs/types'
-import { invoke } from '@stacksjs/actions/clean'
+import { runAction } from '@stacksjs/actions'
+import { Action } from '@stacksjs/types'
 
 async function clean(buddy: CLI) {
   const descriptions = {
@@ -13,7 +14,7 @@ async function clean(buddy: CLI) {
     .option('--verbose', descriptions.verbose, { default: false })
     .option('--debug', descriptions.debug, { default: false })
     .action(async (options: CleanOptions) => {
-      await invoke(options)
+      await runAction(Action.Clean, options)
     })
 }
 

.stacks/core/path/src/index.ts

@@ -290,6 +290,10 @@ export function smsPath(path?: string) {
   return corePath(`sms/${path || ''}`)
 }
 
+export function schedulerPath(path?: string) {
+  return corePath(`scheduler/${path || ''}`)
+}
+
 export function signalsPath(path?: string) {
   return corePath(`signals/${path || ''}`)
 }
@@ -402,6 +406,7 @@ export const path = {
   routerPath,
   routesPath,
   searchEnginePath,
+  schedulerPath,
   settingsPath,
   smsPath,
   signalsPath,

.stacks/core/scheduler/README.md

@@ -0,0 +1,136 @@
+# 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 ❤️

.stacks/core/scheduler/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@stacksjs/scheduler",
+  "type": "module",
+  "version": "0.51.0",
+  "packageManager": "pnpm@7.29.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"
+  ],
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "contributors": [
+    "Chris Breuer <chris@ow3.org>"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=v18.15.0",
+    "pnpm": ">=7.29.1"
+  },
+  "scripts": {
+    "build": "mkdist -d",
+    "dev": "mkdist -d",
+    "prepublishOnly": "pnpm run build",
+    "typecheck": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "node-cron": "3.0.2"
+  },
+  "devDependencies": {
+    "@stacksjs/testing": "workspace:*",
+    "mkdist": "^1.1.2",
+    "typescript": "^4.9.5"
+  }
+}

.stacks/core/scheduler/src/index.ts

@@ -0,0 +1,119 @@
+import cron from 'node-cron'
+
+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) => void
+}
+
+function run(callback: Function): Scheduler {
+  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: number) => {
+      cron.schedule(`*/${minutes} * * * *`, callback)
+    },
+    hourly: () => {
+      cron.schedule('0 * * * *', callback)
+    },
+    everyHours: (hours: number) => {
+      cron.schedule(`0 */${hours} * * *`, callback)
+    },
+    hourlyAt: (minute: number) => {
+      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: number, minute: number) => {
+      cron.schedule(`${minute} ${hour} * * *`, callback)
+    },
+    daily: () => {
+      cron.schedule('0 0 * * *', callback)
+    },
+    everyDays: (days: number) => {
+      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: string) => {
+      cron.schedule(interval, callback)
+    },
+  }
+}
+
+export function useScheduler() {
+  return {
+    run,
+  }
+}

.stacks/core/scheduler/tests/example.test.ts

@@ -0,0 +1,7 @@
+import { assert, describe, test } from 'vitest'
+
+describe('example test', () => {
+  test('assert', () => {
+    assert.equal(1, 1)
+  })
+})