stacks 0.47.4 → 0.48.2

package/core/domains/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/domains",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "Easily manage your domains.",
   "author": "Chris Breuer",

package/core/drivers/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/drivers",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "Easily create a driver-based system.",
   "author": "Chris Breuer",

package/core/email/README.md

@@ -1,60 +1,118 @@
-# Stacks Notifications
+# Stacks SMS
 
-wip
+Stacks Email is driver system for sending Emails.
 
 ## ☘️ Features
 
-wip
+- 📦 Send Email
 
-- ⚡️
+## 🤖 Usage
 
-wip
+```bash
+pnpm i -D @stacksjs/email
+```
 
-## 🤖 Usage
+You may now use it in your project:
+
+```ts
+import * as email from '@stacksjs/email'
+
+/* Then choose a driver. E.g for sendgrid */
+const notification = email.sendgrid
+
+notification.send(EmailOptions)
+
+interface EmailOptions {
+  to: string | string[]
+  subject: string
+  html: string
+  from?: string
+  text?: string
+  attachments?: AttachmentOptions[]
+  id?: string
+}
+```
 
-wip
+### Drivers
+
+Drivers are configured with the following environment variables:
+
+#### Sendgrid
 
 ```bash
-pnpm i -D @stacksjs/notifications
+SENDGRID_API_KEY=SG123
+SENDGRID_FROM=from@example.com
+SENDGRID_SENDER_NAME=Sender
 ```
 
-Now, you can use it in your project:
+#### Mailgun
+
+```bash
+MAILGUN_API_KEY=MG123
+MAILGUN_DOMAIN=example.com
+MAILGUN_USERNAME=username
+MAILGUN_FROM=from@example.com
+```
 
-```js
-import notifications from '@stacksjs/notifications'
+#### Mailjet
 
-// wip
+```bash
+MAILJET_API_KEY=MJ123
+MAILJET_API_SECRET=MJTESTSECRET
+MAILJET_FROM_EMAIL=from@example.com
 ```
 
-## 🤖 Drivers
+#### Netcore
 
-### Email
+```bash
+NETCORE_API_KEY=NC123
+NETCORE_FROM=from@example.com
+```
 
-- Sendgrid
-- Mailgun
-- Mailjet
-- Netcore
-- Nodemailer
-- Post Mark
-- Ses
-- Mandrill
-- EmailJS
+#### Nodemailer
 
-### SMS
+```bash
+NODEMAILER_FROM_EMAIL=from@example.com
+NODEMAILER_HOST=example.com
+NODEMAILER_USERNAME=username
+NODEMAILER_PASSWORD=password
+NODEMAILER_PORT=25
+NODEMAILER_SECURE=true
+```
 
-- Twilio
-- Nexmo
-- Gupshup
-- Plivo
-- SMS77
-- SNS
-- Telnyx
-- Termii
+#### Postmark
 
-### Chat
+```bash
+POSTMARK_API_KEY=PM123
+POSTMARK_FROM=from@example.com
+```
 
-- Discord
-- Slack
+#### 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
+```
 
 Learn more in the docs.
 
@@ -82,6 +140,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/email/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/email",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "The Stacks Email integration. Painlessly create & manage your inboxes, templates, and send emails.",
   "author": "Chris Breuer",

package/core/error-handling/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/error-handling",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "Type safe error handling.",
   "author": "Chris Breuer",
@@ -44,7 +44,7 @@
     "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
-    "@ow3/eslint-config": "^0.35.0",
+    "@ow3/eslint-config": "^0.35.2",
     "neverthrow": "^6.0.0"
   },
   "devDependencies": {

package/core/events/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/events",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "Functional event emitting.",
   "author": "Chris Breuer",

package/core/git/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/git",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "The Stacks git utilities & conventions.",
   "author": "Chris Breuer",

package/core/health/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/health",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "The Stacks Health services.",
   "author": "Chris Breuer",

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.30.0/node_modules/eslint/bin/eslint.js" "$@"
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/eslint@8.31.0/node_modules/eslint/bin/eslint.js" "$@"
 else
-  exec node  "$basedir/../../../../../node_modules/.pnpm/eslint@8.30.0/node_modules/eslint/bin/eslint.js" "$@"
+  exec node  "$basedir/../../../../../node_modules/.pnpm/eslint@8.31.0/node_modules/eslint/bin/eslint.js" "$@"
 fi

package/core/lint/package.json

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

package/core/logging/package.json

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

package/core/modules/package.json

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

package/core/notifications/README.md

@@ -11,8 +11,6 @@ Stacks Notifications is a unified driver system for sending messages/notificatio
 
 ## TODO
 
-- [ ] Driver: FCM
-- [ ] Driver: Expo
 - [ ] Driver: SNS (Push)
 - [ ] Driver: Pushwoosh
 
@@ -22,6 +20,13 @@ Stacks Notifications is a unified driver system for sending messages/notificatio
 pnpm i -D @stacksjs/notifications
 ```
 
+Set these variables in your env:
+
+```bash
+NOTIFICATION_TYPE=email
+NOTIFICATION_DRIVER=sendgrid
+```
+
 You may now use it in your project:
 
 ```ts

package/core/notifications/package.json

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

package/core/notifications/src/index.ts

@@ -1,20 +1,48 @@
-import * as email from './drivers/email'
-import * as chat from './drivers/chat'
-import * as sms from './drivers/sms'
+import { err } from '@stacksjs/error-handling'
+import { notification as config } from '@stacksjs/config'
+import { email } from './drivers/email'
+import { chat } from './drivers/chat'
+import { sms } from './drivers/sms'
 
-const driverMap = {
-  email,
-  chat,
-  sms,
+const useChat = (driver = 'slack') => {
+  return chat[driver as keyof typeof chat]
+}
+
+const useEmail = (driver = 'sendgrid') => {
+  return email[driver as keyof typeof email]
+}
+
+const useSMS = (driver = 'twilio') => {
+  return sms[driver as keyof typeof sms]
+}
+
+const useNotification = (typeParam = null, driverParam = null) => {
+  const type = typeParam || config.type
+  const driver = driverParam || config.driver
+
+  switch (type) {
+    case 'email':
+      return useEmail(driver)
+    case 'chat':
+      return useChat(driver)
+    case 'sms':
+      return useSMS(driver)
+    default:
+      return err(`Type ${type} not supported`)
+  }
 }
 
-const useNotification = (driver = 'email') => {
-  return driverMap?.[driver as keyof typeof driverMap]
+const notification = () => {
+  return useNotification()
 }
 
 export {
   email,
   chat,
   sms,
+  notification,
+  useEmail,
+  useChat,
+  useSMS,
   useNotification,
 }

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

@@ -1,5 +1,6 @@
 import { describe, expect, it } from 'vitest'
-import { chat } from '@stacksjs/notifications'
+import { chat, useChat } from '@stacksjs/notifications'
+import { Err } from '@stacksjs/types'
 
 describe('Slack Test', () => {
   it('should send chat', async () => {
@@ -12,8 +13,8 @@ describe('Slack Test', () => {
     expect(test).toBeDefined()
   })
 
-  it('should send chat using useNotification', async () => {
-    const notification = useNotification('chat').slack
+  it('should send chat using useChat', async () => {
+    const notification = useChat('slack')
     const test = await notification.send({
       content: 'Test Slack Message!',
       webhookUrl: 'https://hooks.slack.com/services/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',
@@ -29,6 +30,6 @@ describe('Slack Test', () => {
       webhookUrl: '',
     })
 
-    expect(test.error).toThrowError()
+    expect(test).toBeInstanceOf(Err)
   })
 })

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

@@ -1,5 +1,6 @@
 import { describe, expect, it } from 'vitest'
-import { email } from '@stacksjs/notifications'
+import { email, useEmail } from '@stacksjs/notifications'
+import { notification as env } from '@stacksjs/config'
 
 describe('Mailgun Test', () => {
   it('should not send email', async () => {
@@ -14,8 +15,8 @@ describe('Mailgun Test', () => {
     expect(test).toBeDefined()
   })
 
-  it('should send email using useNotification', async () => {
-    const notification = useNotification().mailgun
+  it('should send email using useEmail', async () => {
+    const notification = useEmail('mailgun')
     const test = await notification.send({
       from: 'repuestobrian2@gmail.com',
       to: 'repuestobrian@gmail',

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

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { email, useNotification } from '@stacksjs/notifications'
+import { email, useEmail } from '@stacksjs/notifications'
 import { notification as env } from '@stacksjs/config'
 
 describe('Sendgrid Test', () => {
@@ -15,8 +15,8 @@ describe('Sendgrid Test', () => {
     expect(test).toBeDefined()
   })
 
-  it('should send email using useNotification', async () => {
-    const notification = useNotification().sendgrid
+  it('should send email using useEmail', async () => {
+    const notification = useEmail('sendgrid')
     const test = await notification.send({
       from: env.email.sendgrid.from,
       to: 'repuestobrian2@gmail.com',

package/core/notifications/tests/sms/Twilio.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { sms } from '@stacksjs/notifications'
+import { sms, useSMS } from '@stacksjs/notifications'
 import { notification } from '@stacksjs/config'
 
 describe('Twilio Test', () => {
@@ -14,8 +14,8 @@ describe('Twilio Test', () => {
     expect(test).toBeDefined()
   })
 
-  it('should send sms using useNotification', async () => {
-    const notification = useNotification('sms').twilio
+  it('should send sms using useSMS', async () => {
+    const notif = useSMS('twilio')
     const test = await notif.send({
       content: 'Test SMS from Stacks',
       to: notification.sms.twilio.to,

package/core/objects/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/objects",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "The Stacks objects.",
   "author": "Chris Breuer",

package/core/path/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/path",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "The Stacks path.",
   "author": "Chris Breuer",

package/core/path/src/index.ts

@@ -274,6 +274,10 @@ export function testingPath(path?: string) {
   return corePath(`testing/${path || ''}`)
 }
 
+export function testsPath(path?: string) {
+  return frameworkPath(`tests/${path || ''}`)
+}
+
 export function typesPath(path?: string) {
   return corePath(`types/${path || ''}`)
 }
@@ -348,6 +352,7 @@ export const path = {
   stringsPath,
   tablesPath,
   testingPath,
+  testsPath,
   typesPath,
   uiPath,
   utilsPath,

package/core/payments/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/payments",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "The Stacks payments package. Currently supporting Stripe.",
   "author": "Chris Breuer",

package/core/push/README.md

@@ -1,62 +1,36 @@
-# Stacks Notifications
+# Stacks Chat
 
-wip
+Stacks Push is driver system for Pushing messages through apps.
 
 ## ☘️ Features
 
-wip
-
-- ⚡️
-
-wip
+- 📦 Push Messages
 
 ## 🤖 Usage
 
-wip
-
 ```bash
-pnpm i -D @stacksjs/notifications
+pnpm i -D @stacksjs/push
 ```
 
-Now, you can use it in your project:
+You may now use it in your project:
 
-```js
-import notifications from '@stacksjs/notifications'
-
-// wip
-```
-
-## 🤖 Drivers
-
-### Email
+wip
 
-- Sendgrid
-- Mailgun
-- Mailjet
-- Netcore
-- Nodemailer
-- Post Mark
-- Ses
-- Mandrill
-- EmailJS
+### Drivers
 
-### SMS
+Drivers are configured with the following environment variables:
 
-- Twilio
-- Nexmo
-- Gupshup
-- Plivo
-- SMS77
-- SNS
-- Telnyx
-- Termii
+#### Discord
 
-### Chat
+- None
 
-- Discord
-- Slack
+#### Slack
 
-Learn more in the docs.
+```bash
+SLACK_APPLICATION_ID=SAID123
+SLACK_CLIENT_ID=SCID123
+SLACK_SECRET_KEY=SSK123
+```
 
 ## 🧪 Testing
 
@@ -82,6 +56,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/push/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/push",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "The Stacks Push integration",
   "author": "Chris Breuer",

package/core/realtime/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/realtime",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "The Stacks realtime integration.",
   "author": "Chris Breuer",

package/core/router/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/router",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "The Stacks framework router.",
   "author": "Chris Breuer",

package/core/search-engine/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/search-engine",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "The Stacks search engine integrations.",
   "author": "Chris Breuer",

package/core/security/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/security",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "The Stacks framework security.",
   "author": "Chris Breuer",