stacks 0.47.4 → 0.48.2

package/core/server/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/server",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "Local development and production-ready.",
   "author": "Chris Breuer",

package/core/sms/README.md

@@ -1,60 +1,99 @@
-# Stacks Notifications
+# Stacks SMS
 
-wip
+Stacks SMS is driver system for sending SMS messages.
 
 ## ☘️ Features
 
-wip
+- 📦 Send SMS
 
-- ⚡️
+## 🤖 Usage
 
-wip
+```bash
+pnpm i -D @stacksjs/sms
+```
 
-## 🤖 Usage
+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
+}
+```
 
-wip
+### Drivers
+
+Drivers are configured with the following environment variables:
+
+#### Twilio
 
 ```bash
-pnpm i -D @stacksjs/notifications
+TWILIO_ACCOUNT_SID=ACtest
+TWILIO_AUTH_TOKEN=testtoken
+TWILIO_FROM_NUMBER=+112345
+TWILIO_TO_NUMBER=+145678
 ```
 
-Now, you can use it in your project:
+#### Nexmo
+
+```bash
+VONAGE_API_KEY=VN123
+VONAGE_API_SECRET=testkey
+VONAGE_FROM_NUMBER=+112345
+```
+
+#### Gupshup
+
+```bash
+GUPSHUP_USER_ID=GU123
+GUPSHUP_PASSWORD=password
+```
 
-```js
-import notifications from '@stacksjs/notifications'
+#### Plivo
 
-// wip
+```bash
+PLIVO_ACCOUNT_ID=PA123
+PLIVO_AUTH_TOKEN=testtoken
+PLIVO_FROM_NUMBER=+112345
 ```
 
-## 🤖 Drivers
+#### SMS77
 
-### Email
+```bash
+SMS77_API_KEY=SA123
+SMS77_FROM=from@example.com
+```
 
-- Sendgrid
-- Mailgun
-- Mailjet
-- Netcore
-- Nodemailer
-- Post Mark
-- Ses
-- Mandrill
-- EmailJS
+#### SNS
 
-### SMS
+```bash
+SMS77_API_KEY=SA123
+SMS77_FROM=from@example.com
+```
 
-- Twilio
-- Nexmo
-- Gupshup
-- Plivo
-- SMS77
-- SNS
-- Telnyx
-- Termii
+#### Telnyx
 
-### Chat
+```bash
+TELNYX_API_KEY=TA123
+TELNYX_MESSAGE_PROFILE_ID=testprofileid
+TELNYX_FROM=from@example.com
+```
+
+#### Termii
 
-- Discord
-- Slack
+```bash
+TERMII_API_KEY=TermA123
+TERMII_SENDER=from@example.com
+```
 
 Learn more in the docs.
 
@@ -82,6 +121,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/sms/package.json

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

package/core/storage/package.json

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

package/core/storage/src/index.ts

@@ -87,6 +87,7 @@ export function isFolder(path: string): boolean {
   }
 }
 
+
 /**
  * Determine whether a path is a file.
  */
@@ -169,6 +170,18 @@ export function doesFolderExist(path: string) {
   return fs.existsSync(path)
 }
 
+export function createFolder(dir: string): Promise<void> {
+  return new Promise((resolve, reject) => {
+    fs.mkdirs(dir, (err: any) => {
+      if (err)
+        reject(err)
+
+      else
+        resolve()
+    })
+  })
+}
+
 export const filesystem = {
   _dirname,
   readJsonFile,

package/core/strings/README.md

@@ -17,9 +17,16 @@ Now, you can use it in your project:
 
 ```js
 import {
-  addIrregularRule, addPluralRule, addSingularRule, addUncountableRule, camelCase, capitalCase, constantCase, dotCase,
+  // pluralize
+  addIrregularRule, addPluralRule, addSingularRule, addUncountableRule,
+
+  // case
+  camelCase, capitalCase, constantCase, dotCase,
   headerCase, isPlural, isSingular, kebabCase, noCase, paramCase, pascalCase,
-  pathCase, plural, sentenceCase, singular, snakeCase
+  pathCase, plural, sentenceCase, singular, snakeCase,
+
+  // validation
+  isEmail, isStrongPassword, isAlphanumeric, validateUsername, isURL, isMobilePhone, isAlpha, isPostalCode, isDate, isNumeric, isBoolean, isHexColor, isHexadecimal, isBase64, isUUID, isJSON, isCreditCard, isISBN, isIP, isIPRange, isMACAddress, isLatLong, isLatitude, isLongitude, isCurrency, isDataURI, isMimeType, isJWT, isMongoId, isAscii, isBase32, isByteLength, isFQDN, isFullWidth, isHalfWidth, isHash, isHSL, isIBAN, isIdentityCard, isISIN, isISO8601, isISRC, isISSN, isISO31661Alpha2, isISO31661Alpha3
 } from '@stacksjs/strings'
 
 console.log(camelCase('hello world')) // helloWorld
@@ -58,6 +65,7 @@ Many thanks to the following core technologies & people who have contributed to
 
 - [change-case](https://www.npmjs.com/package/change-case)
 - [pluralize](https://www.npmjs.com/package/pluralize)
+- [validation](https://www.npmjs.com/package/validation)
 - [Chris Breuer](https://github.com/chrisbbreuer)
 - [All Contributors](../../contributors)
 

package/core/strings/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/strings",
   "type": "module",
-  "version": "0.47.4",
+  "version": "0.48.2",
   "packageManager": "pnpm@7.21.0",
   "description": "The Stacks string utilities.",
   "author": "Chris Breuer",
@@ -57,8 +57,10 @@
   "peerDependencies": {
     "@stacksjs/alias": "workspace:*",
     "@types/pluralize": "^0.0.29",
+    "@types/validator": "^13.7.10",
     "change-case": "^4.1.2",
-    "pluralize": "^8.0.0"
+    "pluralize": "^8.0.0",
+    "validator": "^13.7.0"
   },
   "devDependencies": {
     "@stacksjs/testing": "workspace:*",

package/core/strings/src/case.ts

@@ -0,0 +1,14 @@
+export {
+  camelCase,
+  capitalCase,
+  constantCase,
+  dotCase,
+  headerCase,
+  noCase,
+  paramCase,
+  paramCase as kebabCase,
+  pascalCase,
+  pathCase,
+  sentenceCase,
+  snakeCase,
+} from 'change-case'

package/core/strings/src/index.ts

@@ -1,97 +1,4 @@
-export { plural, singular, isPlural, isSingular, addPluralRule, addSingularRule, addIrregularRule, addUncountableRule } from 'pluralize'
-
-export {
-  camelCase,
-  capitalCase,
-  constantCase,
-  dotCase,
-  headerCase,
-  noCase,
-  paramCase,
-  paramCase as kebabCase,
-  pascalCase,
-  pathCase,
-  sentenceCase,
-  snakeCase,
-} from 'change-case'
-
-/**
- * Replace backslash to slash
- *
- * @category String
- */
-export function slash(str: string) {
-  return str.replace(/\\/g, '/')
-}
-
-/**
- * Ensure prefix of a string
- *
- * @category String
- */
-export function ensurePrefix(prefix: string, str: string) {
-  if (!str.startsWith(prefix))
-    return prefix + str
-  return str
-}
-
-/**
- * Ensure suffix of a string
- *
- * @category String
- */
-export function ensureSuffix(suffix: string, str: string) {
-  if (!str.endsWith(suffix))
-    return str + suffix
-  return str
-}
-
-/**
- * Dead simple template engine, just like Python's `.format()`
- *
- * @category String
- * @example
- * ```
- * const result = template(
- *   'Hello {0}! My name is {1}.',
- *   'Buddy',
- *   'Chris'
- * ) // Hello Buddy! My name is Chris.
- * ```
- */
-export function template(str: string, ...args: any[]): string {
-  return str.replace(/{(\d+)}/g, (match, key) => {
-    const index = Number(key)
-    if (Number.isNaN(index))
-      return match
-    return args[index]
-  })
-}
-
-// port from nanoid
-// https://github.com/ai/nanoid
-const urlAlphabet = 'useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict'
-/**
- * Generate a random string
- * @category String
- */
-export function randomStr(size = 16, dict = urlAlphabet) {
-  let id = ''
-  let i = size
-  const len = dict.length
-  while (i--)
-    id += dict[(Math.random() * len) | 0]
-  return id
-}
-
-/**
- * First letter uppercase, other lowercase
- * @category string
- * @example
- * ```
- * capitalize('hello') => 'Hello'
- * ```
- */
-export function capitalize(str: string): string {
-  return str[0].toUpperCase() + str.slice(1).toLowerCase()
-}
+export * from './case'
+export * from './utils'
+export * from './pluralize'
+export * from './validation'

package/core/strings/src/pluralize.ts

@@ -0,0 +1 @@
+export { plural, singular, isPlural, isSingular, addPluralRule, addSingularRule, addIrregularRule, addUncountableRule } from 'pluralize'

package/core/strings/src/utils.ts

@@ -0,0 +1,80 @@
+/**
+ * Replace backslash to slash
+ *
+ * @category String
+ */
+export function slash(str: string) {
+  return str.replace(/\\/g, '/')
+}
+
+/**
+ * Ensure prefix of a string
+ *
+ * @category String
+ */
+export function ensurePrefix(prefix: string, str: string) {
+  if (!str.startsWith(prefix))
+    return prefix + str
+  return str
+}
+
+/**
+ * Ensure suffix of a string
+ *
+ * @category String
+ */
+export function ensureSuffix(suffix: string, str: string) {
+  if (!str.endsWith(suffix))
+    return str + suffix
+  return str
+}
+
+/**
+ * Dead simple template engine, just like Python's `.format()`
+ *
+ * @category String
+ * @example
+ * ```
+ * const result = template(
+ *   'Hello {0}! My name is {1}.',
+ *   'Buddy',
+ *   'Chris'
+ * ) // Hello Buddy! My name is Chris.
+ * ```
+ */
+export function template(str: string, ...args: any[]): string {
+  return str.replace(/{(\d+)}/g, (match, key) => {
+    const index = Number(key)
+    if (Number.isNaN(index))
+      return match
+    return args[index]
+  })
+}
+
+// port from nanoid
+// https://github.com/ai/nanoid
+const urlAlphabet = 'useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict'
+/**
+ * Generate a random string
+ * @category String
+ */
+export function randomStr(size = 16, dict = urlAlphabet) {
+  let id = ''
+  let i = size
+  const len = dict.length
+  while (i--)
+    id += dict[(Math.random() * len) | 0]
+  return id
+}
+
+/**
+ * First letter uppercase, other lowercase
+ * @category string
+ * @example
+ * ```
+ * capitalize('hello') => 'Hello'
+ * ```
+ */
+export function capitalize(str: string): string {
+  return str[0].toUpperCase() + str.slice(1).toLowerCase()
+}

package/core/strings/src/validation.ts

@@ -0,0 +1,182 @@
+import validator from 'validator'
+import type { HashAlgorithm } from '@stacksjs/types'
+
+export function isEmail(email: string) {
+  return validator.isEmail(email)
+}
+
+export function isStrongPassword(password: string) {
+  return validator.isStrongPassword(password)
+}
+
+export function isAlphanumeric(username: string) {
+  return validator.isAlphanumeric(username)
+}
+
+export function validateUsername(username: string) {
+  return isAlphanumeric(username)
+}
+
+export function isURL(url: string) {
+  return validator.isURL(url)
+}
+
+export function isMobilePhone(phoneNumber: string) {
+  return validator.isMobilePhone(phoneNumber)
+}
+
+export function isAlpha(name: string) {
+  return validator.isAlpha(name)
+}
+
+export function isPostalCode(zipCode: string) {
+  return validator.isPostalCode(zipCode, 'any')
+}
+
+export function isDate(date: string) {
+  return validator.isDate(date)
+}
+
+export function isNumeric(number: string) {
+  return validator.isNumeric(number)
+}
+
+export function isBoolean(boolean: string) {
+  return validator.isBoolean(boolean)
+}
+
+export function isHexColor(color: string) {
+  return validator.isHexColor(color)
+}
+
+export function isHexadecimal(hex: string) {
+  return validator.isHexadecimal(hex)
+}
+
+export function isBase64(base64: string) {
+  return validator.isBase64(base64)
+}
+
+export function isUUID(uuid: string) {
+  return validator.isUUID(uuid)
+}
+
+export function isJSON(json: string) {
+  return validator.isJSON(json)
+}
+
+export function isCreditCard(creditCard: string) {
+  return validator.isCreditCard(creditCard)
+}
+
+export function isISBN(isbn: string) {
+  return validator.isISBN(isbn)
+}
+
+export function isIP(ip: string) {
+  return validator.isIP(ip)
+}
+
+export function isIPRange(ip: string) {
+  return validator.isIPRange(ip)
+}
+
+export function isMACAddress(macAddress: string) {
+  return validator.isMACAddress(macAddress)
+}
+
+export function isLatLong(latitude: string) {
+  return validator.isLatLong(latitude)
+}
+
+export function isLatitude(longitude: string) {
+  return validator.isLatLong(longitude)
+}
+
+export function isLongitude(longitude: string) {
+  return validator.isLatLong(longitude)
+}
+
+export function isCurrency(currency: string) {
+  return validator.isCurrency(currency)
+}
+
+export function isDataURI(dataURI: string) {
+  return validator.isDataURI(dataURI)
+}
+
+export function isMimeType(mimeType: string) {
+  return validator.isMimeType(mimeType)
+}
+
+export function isJWT(jwt: string) {
+  return validator.isJWT(jwt)
+}
+
+export function isMongoId(mongoId: string) {
+  return validator.isMongoId(mongoId)
+}
+
+export function isAscii(ascii: string) {
+  return validator.isAscii(ascii)
+}
+
+export function isBase32(base32: string) {
+  return validator.isBase32(base32)
+}
+
+export function isByteLength(byteLength: string) {
+  return validator.isByteLength(byteLength)
+}
+
+export function isFQDN(fqdn: string) {
+  return validator.isFQDN(fqdn)
+}
+
+export function isFullWidth(fullWidth: string) {
+  return validator.isFullWidth(fullWidth)
+}
+
+export function isHalfWidth(halfWidth: string) {
+  return validator.isHalfWidth(halfWidth)
+}
+
+export function isHash(hash: string, algorithm: HashAlgorithm) {
+  return validator.isHash(hash, algorithm)
+}
+
+export function isHSL(hsl: string) {
+  return validator.isHSL(hsl)
+}
+
+export function isIBAN(iban: string) {
+  return validator.isIBAN(iban)
+}
+
+export function isIdentityCard(identityCard: string) {
+  return validator.isIdentityCard(identityCard)
+}
+
+export function isISIN(isin: string) {
+  return validator.isISIN(isin)
+}
+
+export function isISO8601(iso8601: string) {
+  return validator.isISO8601(iso8601)
+}
+
+export function isISRC(isrc: string) {
+  return validator.isISRC(isrc)
+}
+
+export function isISSN(issn: string) {
+  return validator.isISSN(issn)
+}
+
+export function isISO31661Alpha2(iso31661Alpha2: string) {
+  return validator.isISO31661Alpha2(iso31661Alpha2)
+}
+
+export function isISO31661Alpha3(iso31661Alpha3: string) {
+  return validator.isISO31661Alpha3(iso31661Alpha3)
+}