stacks 0.44.11 → 0.45.0

package/core/{cloud/dist/actions → health}/README.md

@@ -1,23 +1,26 @@
-# Actions
+# Stacks Health Engine
 
-Placeholder for the "On-The-Fly API."
+The Health Engine is a unified driver system to easily manage health checks for your application.
 
 ## ☘️ Features
 
-- ⚡️
+- 🚘 Driver based
+- ⚡️ Oh Dear support
+- 💀 Headless functions & components
 
 ## 🤖 Usage
 
 ```bash
-pnpm i -D @stacksjs/cloud
+pnpm i -D @stacksjs/health
 ```
 
-Now, you can use it in your project:
+You may now use:
 
-```js
-import { actions } from '@stacksjs/cloud'
+```ts
+import { useHealth } from '@stacksjs/health'
 
-// wip
+const health = useHealth()
+// ...
 ```
 
 Learn more in the docs.

package/core/health/node_modules/.bin/mkdist

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/mkdist@1.0.0_typescript@4.9.4/node_modules/mkdist/dist/cli.cjs" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/mkdist@1.0.0_typescript@4.9.4/node_modules/mkdist/dist/cli.cjs" "$@"
+fi

package/core/health/node_modules/.bin/tsc

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/typescript@4.9.4/node_modules/typescript/bin/tsc" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/typescript@4.9.4/node_modules/typescript/bin/tsc" "$@"
+fi

package/core/health/node_modules/.bin/tsserver

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/typescript@4.9.4/node_modules/typescript/bin/tsserver" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/typescript@4.9.4/node_modules/typescript/bin/tsserver" "$@"
+fi

package/core/health/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@stacksjs/health",
+  "type": "module",
+  "version": "0.45.0",
+  "packageManager": "pnpm@7.18.2",
+  "description": "The Stacks Health services.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/health#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/health"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "health",
+    "oh dear",
+    "stacks",
+    "api",
+    "headless"
+  ],
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "contributors": [
+    "Chris Breuer <chris@ow3.org>"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=v18.12.1",
+    "pnpm": ">=7.18.2"
+  },
+  "scripts": {
+    "build": "mkdist -d",
+    "dev": "mkdist -d",
+    "prepublishOnly": "pnpm run build",
+    "typecheck": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "@stacksjs/notifications": "workspace:*"
+  },
+  "devDependencies": {
+    "@stacksjs/testing": "workspace:*",
+    "mkdist": "^1.0.0",
+    "typescript": "^4.9.4"
+  }
+}

package/core/health/src/drivers/ohdear.ts

@@ -0,0 +1 @@
+export {}

package/core/health/src/index.ts

@@ -0,0 +1 @@
+export {}

package/core/health/src/notifications/index.ts

@@ -0,0 +1 @@
+export {}

package/core/lint/node_modules/.bin/eslint

@@ -11,7 +11,7 @@ else
   export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
 fi
 if [ -x "$basedir/node" ]; then
-  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/eslint@8.29.0/node_modules/eslint/bin/eslint.js" "$@"
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/eslint@8.30.0/node_modules/eslint/bin/eslint.js" "$@"
 else
-  exec node  "$basedir/../../../../../node_modules/.pnpm/eslint@8.29.0/node_modules/eslint/bin/eslint.js" "$@"
+  exec node  "$basedir/../../../../../node_modules/.pnpm/eslint@8.30.0/node_modules/eslint/bin/eslint.js" "$@"
 fi

package/core/lint/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/lint",
   "type": "module",
-  "version": "0.44.11",
+  "version": "0.45.0",
   "packageManager": "pnpm@7.18.2",
   "description": "The Stacks way to lint.",
   "author": "Chris Breuer",
@@ -45,9 +45,9 @@
     "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
-    "@ow3/eslint-config": "^0.33.11",
+    "@ow3/eslint-config": "^0.35.0",
     "@types/eslint": "^8.4.10",
-    "eslint": "^8.29.0",
+    "eslint": "^8.30.0",
     "lint-staged": "^13.1.0"
   },
   "devDependencies": {

package/core/logging/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/logging",
   "type": "module",
-  "version": "0.44.11",
+  "version": "0.45.0",
   "packageManager": "pnpm@7.18.2",
   "description": "The Stacks logging system.",
   "author": "Chris Breuer",

package/core/modules/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/modules",
   "type": "module",
-  "version": "0.44.11",
+  "version": "0.45.0",
   "packageManager": "pnpm@7.18.2",
   "description": "The Stacks framework modules.",
   "author": "Chris Breuer",

package/core/modules/src/nprogress.ts

@@ -7,6 +7,8 @@ export const install: UserModule = ({ isClient, router }) => {
       if (to.path !== from.path)
         NProgress.start()
     })
-    router.afterEach(() => { NProgress.done() })
+    router.afterEach(() => {
+      NProgress.done()
+    })
   }
 }

package/core/notifications/README.md

@@ -1,60 +1,227 @@
 # Stacks Notifications
 
-wip
+Stacks Notifications is a unified driver system for sending messages/notifications. It supports sending emails, SMS messages, and chat messages.
 
 ## ☘️ Features
 
-wip
+- 📦 Send Emails
+- 🎨 Email Styling
+- 📱 Send SMS messages
+- 💬 Send Chat messages
 
-- ⚡️
+## TODO
 
-wip
+- [ ] Driver: FCM
+- [ ] Driver: Expo
+- [ ] Driver: SNS (Push)
+- [ ] Driver: Pushwoosh
 
 ## 🤖 Usage
 
-wip
-
 ```bash
 pnpm i -D @stacksjs/notifications
 ```
 
-Now, you can use it in your project:
+You may now use it in your project:
+
+```ts
+import { notification } from '@stacksjs/notifications'
 
-```js
-import notifications from '@stacksjs/notifications'
+notification.send(options)
+```
 
-// wip
+## 🏎️ Drivers
+
+There are different option types for Chat, Email, and SMS drivers. To use any driver, simply configure the notification `options` object.
+
+```ts
+interface ChatOptions {
+  webhookUrl: string
+  content: string
+}
+
+interface EmailOptions {
+  to: string | string[]
+  subject: string
+  html: string
+  from?: string
+  text?: string
+  attachments?: AttachmentOptions[]
+  id?: string
+}
+
+interface SMSOptions {
+  to: string
+  content: string
+  from?: string
+  attachments?: AttachmentOptions[]
+  id?: string
+}
 ```
 
-## 🤖 Drivers
+Available drivers are listed below, with the proper variables needed to get started.
 
 ### Email
 
-- Sendgrid
-- Mailgun
-- Mailjet
-- Netcore
-- Nodemailer
-- Post Mark
-- Ses
-- Mandrill
-- EmailJS
+Email drivers are configured with the following environment variables:
+
+#### Sendgrid
+
+```bash
+SENDGRID_API_KEY=SG123
+SENDGRID_FROM=from@example.com
+SENDGRID_SENDER_NAME=Sender
+```
+
+#### Mailgun
+
+```bash
+MAILGUN_API_KEY=MG123
+MAILGUN_DOMAIN=example.com
+MAILGUN_USERNAME=username
+MAILGUN_FROM=from@example.com
+```
+
+#### Mailjet
+
+```bash
+MAILJET_API_KEY=MJ123
+MAILJET_API_SECRET=MJTESTSECRET
+MAILJET_FROM_EMAIL=from@example.com
+```
+
+#### Netcore
+
+```bash
+NETCORE_API_KEY=NC123
+NETCORE_FROM=from@example.com
+```
+
+#### Nodemailer
+
+```bash
+NODEMAILER_FROM_EMAIL=from@example.com
+NODEMAILER_HOST=example.com
+NODEMAILER_USERNAME=username
+NODEMAILER_PASSWORD=password
+NODEMAILER_PORT=25
+NODEMAILER_SECURE=true
+```
+
+#### Postmark
+
+```bash
+POSTMARK_API_KEY=PM123
+POSTMARK_FROM=from@example.com
+```
+
+#### AWS SES
+
+```bash
+SES_REGION=US
+SES_ACCESS_KEY_ID=testkey123
+SES_SECRET_ACCESS_KEY=testaccesskey123
+SES_FROM=from@example.com
+```
+
+#### Mandrill
+
+```bash
+MANDRILL_API_KEY=Ma123
+MANDRILL_EMAIL=from@example.com
+```
+
+#### EmailJS
+
+```bash
+EMAILJS_FROM_EMAIL=from@example.com
+EMAILJS_HOST=example.com
+EMAILJS_USERNAME=username
+EMAILJS_PASSWORD=password
+EMAILJS_PORT=25
+EMAILJS_SECURE=true
+```
 
 ### SMS
 
-- Twilio
-- Nexmo
-- Gupshup
-- Plivo
-- SMS77
-- SNS
-- Telnyx
-- Termii
+SMS 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
+```
 
 ### Chat
 
-- Discord
-- Slack
+Chat drivers are configured with the following environment variables:
+
+#### Discord
+
+- None
+
+#### Slack
+
+```
+SLACK_APPLICATION_ID=SAID123
+SLACK_CLIENT_ID=SCID123
+SLACK_SECRET_KEY=SSK123
+```
 
 Learn more in the docs.
 
@@ -82,6 +249,14 @@ 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.

package/core/notifications/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/notifications",
   "type": "module",
-  "version": "0.44.11",
+  "version": "0.45.0",
   "packageManager": "pnpm@7.18.2",
   "description": "The Stacks notifications integration.",
   "author": "Chris Breuer",

package/core/notifications/src/drivers/chat/slack.ts

@@ -8,7 +8,7 @@ const env = notification.chat.slack
 
 const provider = new SlackProvider({
   applicationId: env.appId,
-  clientId: env.clientID,
+  clientId: env.clientId,
   secretKey: env.secret,
 })
 

package/core/notifications/src/drivers/email/actions/send.ts

@@ -31,6 +31,6 @@ export async function send(options: EmailOptions, provider: any, providerName: s
 
   return ResultAsync.fromPromise(
     provider.sendMessage(options),
-    () => new Error(`Failed to send message using provider: ${italic('Sendgrid')}`),
+    () => new Error(`Failed to send message using provider: ${italic(providerName)}`),
   )
 }

package/core/notifications/src/drivers/push/expo.ts

@@ -0,0 +1,19 @@
+import { Novu } from '@novu/node'
+import { notification } from '@stacksjs/config'
+import type { ExpoPushNotificationOptions } from '@stacksjs/types'
+import { ResultAsync } from '@stacksjs/error-handling'
+import { italic } from '@stacksjs/cli'
+
+const novu = new Novu(notification.novu.key)
+
+function send(options: ExpoPushNotificationOptions) {
+  return ResultAsync.fromPromise(
+    novu.trigger(options.eventName, {
+      to: options.to,
+      payload: options.payload,
+    }),
+    () => new Error(`Failed to send message using provider: ${italic('Expo')}`),
+  )
+}
+
+export { send as Send, send }

package/core/notifications/src/drivers/push/fcm.ts

@@ -0,0 +1,19 @@
+import { Novu } from '@novu/node'
+import { notification } from '@stacksjs/config'
+import type { FCMPushNotificationOptions } from '@stacksjs/types'
+import { ResultAsync } from '@stacksjs/error-handling'
+import { italic } from '@stacksjs/cli'
+
+const novu = new Novu(notification.novu.key)
+
+function send(options: FCMPushNotificationOptions) {
+  return ResultAsync.fromPromise(
+    novu.trigger(options.eventName, {
+      to: options.to,
+      payload: options.payload,
+    }),
+    () => new Error(`Failed to send message using provider: ${italic('FCM')}`),
+  )
+}
+
+export { send as Send, send }

package/core/notifications/src/index.ts

@@ -1,25 +1,20 @@
-export * as email from './drivers/email'
-export * as chat from './drivers/chat'
-export * as sms from './drivers/sms'
+import * as email from './drivers/email'
+import * as chat from './drivers/chat'
+import * as sms from './drivers/sms'
 
-// const driverMap = {
-//   email,
-//   chat,
-//   sms,
-// }
+const driverMap = {
+  email,
+  chat,
+  sms,
+}
 
-// export function useNotification(driver = 'email') {
-//   // return driverMap?.[driver as keyof typeof driverMap]
-//   if (driver === 'email')
-//     return email
+const useNotification = (driver = 'email') => {
+  return driverMap?.[driver as keyof typeof driverMap]
+}
 
-//   if (driver === 'chat')
-//     return chat
-
-//   if (driver === 'sms')
-//     return sms
-// }
-
-// export default {
-//   useNotification,
-// }
+export {
+  email,
+  chat,
+  sms,
+  useNotification,
+}

package/core/notifications/tests/chat/Slack.test.ts

@@ -1,10 +1,19 @@
 import { describe, expect, it } from 'vitest'
 import { chat } from '@stacksjs/notifications'
 
-const notification = chat.slack
-
 describe('Slack Test', () => {
   it('should send chat', async () => {
+    const notification = chat.slack
+    const test = await notification.send({
+      content: 'Test Slack Message!',
+      webhookUrl: 'https://hooks.slack.com/services/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',
+    })
+
+    expect(test).toBeDefined()
+  })
+
+  it('should send chat using useNotification', async () => {
+    const notification = useNotification('chat').slack
     const test = await notification.send({
       content: 'Test Slack Message!',
       webhookUrl: 'https://hooks.slack.com/services/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',
@@ -14,6 +23,7 @@ describe('Slack Test', () => {
   })
 
   it('should not send chat if webhook is empty', async () => {
+    const notification = chat.slack
     const test = await notification.send({
       content: 'Test Slack Message!',
       webhookUrl: '',

package/core/notifications/tests/email/Mailgun.test.ts

@@ -1,10 +1,21 @@
 import { describe, expect, it } from 'vitest'
 import { email } from '@stacksjs/notifications'
 
-const notification = email.mailgun
-
 describe('Mailgun Test', () => {
   it('should not send email', async () => {
+    const notification = email.mailgun
+    const test = await notification.send({
+      from: 'repuestobrian2@gmail.com',
+      to: 'repuestobrian@gmail',
+      subject: 'Test Email',
+      html: '<p> Test </p>',
+    })
+
+    expect(test).toBeDefined()
+  })
+
+  it('should send email using useNotification', async () => {
+    const notification = useNotification().mailgun
     const test = await notification.send({
       from: 'repuestobrian2@gmail.com',
       to: 'repuestobrian@gmail',
@@ -16,6 +27,7 @@ describe('Mailgun Test', () => {
   })
 
   it('should not send email when receiver is empty', async () => {
+    const notification = email.mailgun
     const test = await notification.send({
       from: env.email.sendgrid.from,
       to: '',
@@ -26,4 +38,3 @@ describe('Mailgun Test', () => {
     expect(test.error).toThrowError(Error)
   })
 })
-