stacks 0.53.1 → 0.56.3

package/core/validation/src/is.ts

@@ -1,257 +1,110 @@
 import { getTypeName, toString } from '@stacksjs/utils'
-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 isNumeric(number: string) {
-  return validator.isNumeric(number)
-}
-
-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)
-}
 
 export function isDef<T = any>(val?: T): val is T {
   return typeof val !== 'undefined'
 }
+
 export function isBoolean(val: any): val is boolean {
   return typeof val === 'boolean'
 }
+
 export function isFunction<T extends Function>(val: any): val is T {
   return typeof val === 'function'
 }
+
 export function isNumber(val: any): val is number {
   return typeof val === 'number'
 }
+
 export function isString(val: unknown): val is string {
   return typeof val === 'string'
 }
+
 export function isObject(val: any): val is object {
   return toString(val) === '[object Object]'
 }
+
 export function isWindow(val: any): boolean {
   return typeof window !== 'undefined' && toString(val) === '[object Window]'
 }
+
 export const isBrowser = typeof window !== 'undefined'
+
 export const isServer = typeof document === 'undefined' // https://remix.run/docs/en/v1/pages/gotchas#typeof-window-checks
+
 export function isMap(val: any): val is Map<any, any> {
   return toString(val) === '[object Map]'
 }
+
 export function isSet(val: any): val is Set<any> {
   return toString(val) === '[object Set]'
 }
+
 export function isPromise<T = any>(val: any): val is Promise<T> {
   return toString(val) === '[object Promise]'
 }
+
 export function isUndefined(v: any) {
   return getTypeName(v) === 'undefined'
 }
+
 export function isNull(v: any) {
   return getTypeName(v) === 'null'
 }
+
 export function isSymbol(v: any) {
   return getTypeName(v) === 'symbol'
 }
+
 export function isDate(v: any) {
   return getTypeName(v) === 'date'
 }
+
 export function isRegExp(v: any) {
   return getTypeName(v) === 'regexp'
 }
+
 export function isArray(v: any) {
   return getTypeName(v) === 'array'
 }
+
 export function isPrimitive(v: any) {
   const type = getTypeName(v)
   return type === 'null' || type === 'undefined' || type === 'string' || type === 'number' || type === 'boolean' || type === 'symbol'
 }
+
 export function isInteger(v: any) {
   return isNumber(v) && Number.isInteger(v)
 }
+
 export function isFloat(v: any) {
   return isNumber(v) && !Number.isInteger(v)
 }
+
 export function isPositive(v: any) {
   return isNumber(v) && v > 0
 }
+
 export function isNegative(v: any) {
   return isNumber(v) && v < 0
 }
+
 export function isEven(v: any) {
   return isNumber(v) && v % 2 === 0
 }
+
 export function isOdd(v: any) {
   return isNumber(v) && v % 2 !== 0
 }
+
 export function isEvenOrOdd(v: any) {
   return isNumber(v) && (v % 2 === 0 ? 'even' : 'odd')
 }
+
 export function isPositiveOrNegative(v: any) {
   return isNumber(v) && (v > 0 ? 'positive' : 'negative')
 }
+
 export function isIntegerOrFloat(v: any) {
   return isNumber(v) && (Number.isInteger(v) ? 'integer' : 'float')
 }

package/core/validation/src/rules.ts

@@ -0,0 +1,126 @@
+import { USD, currency } from '@stacksjs/utils'
+import { validator } from './validate'
+
+/**
+ * Thanks to VineJS for the following types:
+ *
+ * The context shared with the entire validation pipeline.
+ * Each field gets its own context object.
+ */
+export interface FieldContext {
+  /**
+   * Field value
+   */
+  value: unknown
+
+  /**
+   * The data property is the top-level object under validation.
+   */
+  data: any
+
+  /**
+   * Shared metadata across the entire validation lifecycle. It can be
+   * used to pass data between validation rules
+   */
+  meta: Record<string, any>
+
+  /**
+   * Mutate the value of field under validation.
+   */
+  mutate(newValue: any, field: FieldContext): void
+
+  /**
+   * Report error to the error reporter
+   */
+  report: ErrorReporterContract['report']
+
+  /**
+   * Is this field valid. Default: true
+   */
+  isValid: boolean
+
+  /**
+   * Is this field has value defined.
+   */
+  isDefined: boolean
+
+  /**
+   * Wildcard path for the field. The value is a nested
+   * pointer to the field under validation.
+   *
+   * In case of arrays, the `*` wildcard is used.
+   */
+  wildCardPath: string
+
+  /**
+   * The parent property is the parent of the field. It could be an
+   * array or an object.
+   */
+  parent: any
+
+  /**
+   * Name of the field under validation. In case of an array, the field
+   * name will be a number
+   */
+  name: string | number
+
+  /**
+   * Is this field an array member
+   */
+  isArrayMember: boolean
+}
+
+/**
+ * Thanks to VineJS for the following types:
+ *
+ * The error reporter is used to report errors during the validation
+ * process.
+ */
+export interface ErrorReporterContract {
+  /**
+   * A boolean to known if there are one or more
+   * errors.
+   */
+  hasErrors: boolean
+
+  /**
+   * Creates an instance of an exception to throw
+   */
+  createError(): Error
+
+  /**
+   * Report error for a field
+   */
+  report(message: string, rule: string, field: FieldContext, args?: Record<string, any>): any
+}
+
+// export const isMoney = validator.createRule((value: unknown, _, field: FieldContext) => {
+export const isMoney = validator.createRule((value: unknown, _, field: FieldContext) => {
+  /**
+   * Convert string representation of a number to a JavaScript
+   * Number data type.
+   */
+  const numericValue = validator.helpers.asNumber(value)
+
+  /**
+   * Report error, if the value is NaN post-conversion
+   */
+  if (Number.isNaN(numericValue)) {
+    field.report(
+      'The {{ field }} field value must be a number',
+      'money',
+      field,
+    )
+    return
+  }
+
+  /**
+   * Create amount type
+   */
+  const amount = currency({ amount: numericValue, currency: USD })
+
+  /**
+   * Mutate the field's value
+   */
+  field.mutate(amount, field)
+}) as any

package/core/validation/src/types/env.ts

@@ -0,0 +1,147 @@
+import process from 'node:process'
+import type { VineObject } from '@vinejs/vine'
+import validator from '@vinejs/vine'
+import type { Infer } from '@vinejs/vine/build/src/types'
+import { loadEnv } from 'vite'
+import { projectPath } from '@stacksjs/path'
+
+// TODO: envSchema needs to be auto generated from the .env file
+// envSchema could also be named "backendEnvSchema"
+const envSchema = validator.object({
+  APP_NAME: validator.string().optional(),
+  APP_ENV: validator.enum(['local', 'development', 'staging', 'production']).optional(),
+  APP_KEY: validator.string().optional(),
+  APP_URL: validator.string(),
+  APP_DEBUG: validator.boolean().optional(),
+  APP_SUBDOMAIN_API: validator.string().optional(),
+  APP_SUBDOMAIN_DOCS: validator.string().optional(),
+  APP_SUBDOMAIN_LIBRARY: validator.string().optional(),
+  APP_BUCKET: validator.string().optional(),
+
+  DB_CONNECTION: validator.string().optional(),
+  DB_HOST: validator.string().optional(),
+  DB_PORT: validator.number().optional(),
+  DB_DATABASE: validator.string().optional(),
+  DB_USERNAME: validator.string().optional(),
+  DB_PASSWORD: validator.string().optional(),
+
+  SEARCH_ENGINE_DRIVER: validator.string().optional(),
+  MEILISEARCH_HOST: validator.string().optional(),
+  MEILISEARCH_KEY: validator.string().optional(),
+
+  CACHE_DRIVER: validator.enum(['dynamodb', 'memcached', 'redis']).optional(),
+  CACHE_PREFIX: validator.string().optional(),
+  CACHE_TTL: validator.number().optional(),
+
+  AWS_ACCESS_KEY_ID: validator.string().optional(),
+  AWS_SECRET_ACCESS_KEY: validator.string().optional(),
+  AWS_DEFAULT_REGION: validator.string().optional(),
+  DYNAMODB_CACHE_TABLE: validator.string().optional(),
+  DYNAMODB_ENDPOINT: validator.string().optional(),
+
+  MEMCACHED_PERSISTENT_ID: validator.string().optional(),
+  MEMCACHED_USERNAME: validator.string().optional(),
+  MEMCACHED_PASSWORD: validator.string().optional(),
+  MEMCACHED_HOST: validator.string().optional(),
+  MEMCACHED_PORT: validator.number().optional(),
+
+  REDIS_HOST: validator.string().optional(),
+  REDIS_PORT: validator.number().optional(),
+
+  MAIL_FROM_NAME: validator.string().optional(),
+  MAIL_FROM_ADDRESS: validator.string().optional(),
+
+  EMAILJS_HOST: validator.string().optional(),
+  EMAILJS_USERNAME: validator.string().optional(),
+  EMAILJS_PASSWORD: validator.string().optional(),
+  EMAILJS_PORT: validator.number().optional(),
+  EMAILJS_SECURE: validator.boolean().optional(),
+
+  MAILGUN_API_KEY: validator.string().optional(),
+  MAILGUN_DOMAIN: validator.string().optional(),
+  MAILGUN_USERNAME: validator.string().optional(),
+
+  MAILJET_API_KEY: validator.string().optional(),
+  MAILJET_API_SECRET: validator.string().optional(),
+
+  MANDRILL_API_KEY: validator.string().optional(),
+
+  NETCORE_API_KEY: validator.string().optional(),
+
+  NODEMAILER_HOST: validator.string().optional(),
+  NODEMAILER_USERNAME: validator.string().optional(),
+  NODEMAILER_PASSWORD: validator.string().optional(),
+  NODEMAILER_PORT: validator.number().optional(),
+  NODEMAILER_SECURE: validator.boolean().optional(),
+
+  POSTMARK_API_TOKEN: validator.string().optional(),
+  POSTMARK_API_KEY: validator.string().optional(),
+
+  SENDGRID_API_KEY: validator.string().optional(),
+  SENDGRID_SENDER_NAME: validator.string().optional(),
+
+  SES_API_VERSION: validator.string().optional(),
+  SES_ACCESS_KEY_ID: validator.string().optional(),
+  SES_SECRET_ACCESS_KEY: validator.string().optional(),
+  SES_REGION: validator.string().optional(),
+
+  FROM_PHONE_NUMBER: validator.string().optional(),
+  TWILIO_ACCOUNT_SID: validator.string().optional(),
+  TWILIO_AUTH_TOKEN: validator.string().optional(),
+
+  VONAGE_API_KEY: validator.string().optional(),
+  VONAGE_API_SECRET: validator.string().optional(),
+
+  GUPSHUP_USER_ID: validator.string().optional(),
+  GUPSHUP_PASSWORD: validator.string().optional(),
+
+  PLIVO_ACCOUNT_ID: validator.string().optional(),
+  PLIVO_AUTH_TOKEN: validator.string().optional(),
+
+  SMS77_API_KEY: validator.string().optional(),
+
+  SNS_REGION: validator.string().optional(),
+  SNS_ACCESS_KEY_ID: validator.string().optional(),
+  SNS_SECRET_ACCESS_KEY: validator.string().optional(),
+
+  TELNYX_API_KEY: validator.string().optional(),
+  TELNYX_MESSAGE_PROFILE_ID: validator.string().optional(),
+
+  TERMII_API_KEY: validator.string().optional(),
+
+  SLACK_FROM: validator.string().optional(),
+  SLACK_APPLICATION_ID: validator.string().optional(),
+  SLACK_CLIENT_ID: validator.string().optional(),
+  SLACK_SECRET_KEY: validator.string().optional(),
+
+  MICROSOFT_TEAMS_APPLICATION_ID: validator.string().optional(),
+  MICROSOFT_TEAMS_CLIENT_ID: validator.string().optional(),
+  MICROSOFT_TEAMS_SECRET: validator.string().optional(),
+}) as VineObject<any, any, any>
+
+const frontendEnvSchema = validator.object({
+  FRONTEND_APP_ENV: validator.enum(['local', 'development', 'staging', 'production']).optional(),
+  FRONTEND_APP_URL: validator.string().optional(),
+}) as VineObject<any, any, any>
+
+export type Env = Infer<typeof envSchema>
+export type EnvKeys = keyof Env
+
+export type FrontendEnv = Infer<typeof frontendEnvSchema>
+export type FrontendEnvKeys = keyof FrontendEnv
+
+export const env = process.env as Env
+export async function getEnv() {
+  try {
+    const mode = process.env.NODE_ENV ?? 'development'
+    const data = loadEnv(mode, projectPath(), '')
+    const v = validator.compile(envSchema)
+
+    return v.validate(data)
+  }
+  catch (error: any) {
+    handleError(error)
+  }
+}
+
+export { loadEnv }

package/core/validation/src/types/index.ts

@@ -0,0 +1,2 @@
+export * from './env'
+export * from './money'

package/core/validation/src/types/money.ts

@@ -0,0 +1,17 @@
+import type { FieldOptions, Validation } from '@vinejs/vine/build/src/types'
+import type { Money } from '@stacksjs/types'
+import { BaseLiteralType } from '@vinejs/vine'
+import { isMoney } from '../rules'
+
+export class MoneyValidator extends BaseLiteralType<Money, Money> {
+  constructor(options?: FieldOptions, validations?: Validation<any>[]) {
+    super(options, validations || [isMoney()])
+  }
+
+  clone() {
+    return new MoneyValidator(
+      this.cloneOptions(),
+      this.cloneValidations(),
+    ) as this
+  }
+}

package/core/validation/src/validate.ts

@@ -1,29 +1,18 @@
-import { z as validate, z } from 'zod'
+import type { VineString as ValidationString } from '@vinejs/vine'
+import validator, { Vine as Validator } from '@vinejs/vine'
+import { MoneyValidator } from './types/money'
 
-export const envVariables = validate.object({
-  APP_NAME: validate.string().default('Stacks').optional(),
-  APP_ENV: validate.string().default('local').optional(),
-  APP_KEY: validate.string(),
-  APP_URL: validate.string().url().default('http://localhost:3333'),
-  APP_DEBUG: validate.boolean().default(true),
-  DB_CONNECTION: validate.string().default('mysql').optional(),
-  DB_DATABASE: validate.string().default('stacks').optional(),
-  DB_USERNAME: validate.string().default('root').optional(),
-  DB_PASSWORD: validate.string().optional(),
-  SEARCH_ENGINE_DRIVER: validate.string().optional(),
-  MEILISEARCH_HOST: validate.string().optional().default('http://127.0.0.1:7700'),
-  MEILISEARCH_KEY: validate.string().optional(),
+Validator.macro('money', () => {
+  return new MoneyValidator()
 })
 
-export type StacksEnv = validate.infer<typeof envVariables>
+const validate: Validator = validator
+const string: ValidationString = validator.string()
+const number: Validator['number'] = validator.number
+const boolean: Validator['boolean'] = validator.boolean
+const array: Validator['array'] = validator.array
+const object: Validator['object'] = validator.object
+const any: Validator['any'] = validator.any
+// const email = () => validator.string().email()
 
-export enum Type {
-  String = 'String',
-  Number = 'Number',
-  Boolean = 'Boolean',
-  Date = 'Date',
-  Object = 'Object',
-  Array = 'Array',
-}
-
-export { validate, z }
+export { validate, validator, Validator, string, number, boolean, array, object, any }

package/core/vite-plugin/README.md

@@ -0,0 +1,59 @@
+# Vite Plugin Stacks
+
+This package contains the Stacks Vite plugin.
+
+## ☘️ Features
+
+wip
+
+- ⚡️
+
+wip
+
+## 🤖 Usage
+
+wip
+
+```bash
+pnpm i -D @stacksjs/vite-plugin
+```
+
+Now, you can use it in your project:
+
+```js
+import vitePlugin from '@stacksjs/vite-plugin'
+
+// wip
+```
+
+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)
+
+## 📄 License
+
+The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
+
+Made with ❤️

package/core/vite-plugin/build.config.ts

@@ -0,0 +1,21 @@
+import { alias, defineBuildConfig } from '@stacksjs/development'
+
+export default defineBuildConfig({
+  alias,
+
+  entries: [
+    './src/index',
+  ],
+
+  externals: [
+    'vite',
+    'vitepress',
+  ],
+
+  rollup: {
+    inlineDependencies: true,
+  },
+
+  clean: true,
+  declaration: true,
+})