stacks 0.50.0 → 0.52.0

package/core/utils/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/utils",
   "type": "module",
-  "version": "0.50.0",
-  "packageManager": "pnpm@7.25.1",
+  "version": "0.52.0",
+  "packageManager": "pnpm@8.5.1",
   "description": "The Stacks helper functions.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -26,6 +26,12 @@
     "functions",
     "stacks"
   ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    }
+  },
   "main": "dist/index.mjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -36,17 +42,37 @@
     "dist",
     "README.md"
   ],
-  "engines": {
-    "node": ">=v18.13.0",
-    "pnpm": ">=7.25.1"
-  },
   "scripts": {
-    "build": "mkdist -d",
-    "dev": "mkdist -d",
+    "build": "unbuild",
+    "dev": "unbuild --stub",
     "prepublishOnly": "pnpm run build",
     "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
+    "@stacksjs/arrays": "workspace:*",
+    "@stacksjs/cli": "workspace:*",
+    "@stacksjs/config": "workspace:*",
+    "@stacksjs/development": "workspace:*",
+    "@stacksjs/lint": "workspace:*",
+    "@stacksjs/path": "workspace:*",
+    "@stacksjs/storage": "workspace:*",
+    "@stacksjs/types": "workspace:*",
+    "@vueuse/core": "^10.1.2",
+    "@vueuse/head": "^1.1.26",
+    "@vueuse/math": "^10.1.2",
+    "@vueuse/shared": "^10.1.2",
+    "defu": "^6.1.2",
+    "detect-indent": "^7.0.1",
+    "detect-newline": "^4.0.0",
+    "dinero.js": "2.0.0-alpha.14",
+    "fast-glob": "^3.2.12",
+    "kolorist": "1.8.0",
+    "p-limit": "^4.0.0",
+    "rimraf": "^5.0.0",
+    "semver": "^7.5.1",
+    "yaml": "^2.2.2"
+  },
+  "dependencies": {
     "@stacksjs/arrays": "workspace:*",
     "@stacksjs/cli": "workspace:*",
     "@stacksjs/config": "workspace:*",
@@ -54,25 +80,23 @@
     "@stacksjs/path": "workspace:*",
     "@stacksjs/storage": "workspace:*",
     "@stacksjs/types": "workspace:*",
-    "@vueuse/core": "^9.11.1",
-    "@vueuse/head": "^1.0.22",
-    "@vueuse/math": "^9.11.1",
-    "@vueuse/shared": "^9.11.1",
-    "defu": "^6.1.1",
+    "@vueuse/core": "^10.1.2",
+    "@vueuse/head": "^1.1.26",
+    "@vueuse/math": "^10.1.2",
+    "@vueuse/shared": "^10.1.2",
+    "defu": "^6.1.2",
     "detect-indent": "^7.0.1",
     "detect-newline": "^4.0.0",
-    "dinero.js": "2.0.0-alpha.13",
-    "esno": "^0.16.3",
+    "dinero.js": "2.0.0-alpha.14",
     "fast-glob": "^3.2.12",
-    "kolorist": "1.6.0",
+    "kolorist": "1.8.0",
     "p-limit": "^4.0.0",
-    "rimraf": "^4.1.1",
-    "throttle-debounce": "^5.0.0"
+    "perfect-debounce": "^1.0.0",
+    "rimraf": "^5.0.0",
+    "semver": "^7.5.1",
+    "yaml": "^2.2.2"
   },
   "devDependencies": {
-    "@stacksjs/testing": "workspace:*",
-    "@types/throttle-debounce": "^5.0.0",
-    "mkdist": "^1.1.0",
-    "typescript": "^4.9.4"
+    "@stacksjs/development": "workspace:*"
   }
 }

package/core/utils/src/base.ts

@@ -1,19 +1,24 @@
-export const assert = (condition: boolean, message: string): asserts condition => {
+export function assert(condition: boolean, message: string): asserts condition {
   if (!condition)
     throw new Error(message)
 }
 
-export const toString = (v: any) => Object.prototype.toString.call(v)
+export function toString(v: any) {
+  return Object.prototype.toString.call(v)
+}
 
-export const noop = () => {}
+export function noop() {}
 
-export const loop = (times: number, callback: any) => {
+export function loop(times: number, callback: any) {
   [...Array(times)].forEach((item, i) => callback(i))
 }
 
-export const getTypeName = (v: any) => {
+export function getTypeName(v: any) {
   if (v === null)
     return 'null'
   const type = toString(v).slice(8, -1).toLowerCase()
-  return typeof v === 'object' || typeof v === 'function' ? type : typeof v
+
+  return (typeof v === 'object' || typeof v === 'function')
+    ? type
+    : typeof v
 }

package/core/utils/src/config.ts

@@ -0,0 +1,97 @@
+import type { UserCliOptions, AppOptions, CacheOptions, CdnOptions, CronJobOptions, DatabaseOptions, DebugOptions, DnsOptions, EmailOptions, Events, GitOptions, HashingOptions, LibraryOptions, Model, NotificationOptions, PagesOption, PaymentOptions, SearchEngineOptions, ServicesOptions, StorageOptions, UiOptions } from '@stacksjs/types'
+
+export function env(key: any, fallback?: any) {
+  // console.log('isClient', isClient)
+  // if (key && import.meta?.env)
+  //   return import.meta.env[key]
+
+  return key
+}
+
+export function defineApp(options: Partial<AppOptions>) {
+  return options
+}
+
+export function defineCache(options: Partial<CacheOptions>) {
+  return options
+}
+
+export function defineCdn(options: Partial<CdnOptions>) {
+  return options
+}
+
+export function defineCli(options: Partial<UserCliOptions>) {
+  return options
+}
+
+export function defineCronJobsConfig(options: Partial<CronJobOptions>[]) {
+  return options
+}
+
+export function defineDatabase(options: Partial<DatabaseOptions>) {
+  return options
+}
+
+export function defineDebugConfig(options: Partial<DebugOptions>) {
+  return options
+}
+
+// export function defineCloudConfig(options: Partial<CloudOptions>) {
+//   return options
+// }
+
+export function defineDns(options: Partial<DnsOptions>) {
+  return options
+}
+
+export function defineEmailConfig(options: Partial<EmailOptions>) {
+  return options
+}
+
+export function defineEvents(options: Partial<Events>) {
+  return options
+}
+
+export function defineGit(options: Partial<GitOptions>) {
+  return options
+}
+
+export function defineHashing(options: Partial<HashingOptions>) {
+  return options
+}
+
+export function defineLibrary(options: Partial<LibraryOptions>) {
+  return options
+}
+
+export function defineModel(options: Partial<Model>) {
+  return options
+}
+
+export function defineNotification(options: Partial<NotificationOptions>) {
+  return options
+}
+
+export function definePage(options: Partial<PagesOption>) {
+  return options
+}
+
+export function definePayment(options: Partial<PaymentOptions>) {
+  return options
+}
+
+export function defineSearchEngine(options: Partial<SearchEngineOptions>) {
+  return options
+}
+
+export function defineServices(options: Partial<ServicesOptions>) {
+  return options
+}
+
+export function defineStorage(options: Partial<StorageOptions>) {
+  return options
+}
+
+export function defineUi(options: Partial<UiOptions>) {
+  return options
+}

package/core/utils/src/debounce.ts

@@ -0,0 +1 @@
+export { debounce } from 'perfect-debounce'

package/core/utils/src/guards.ts

@@ -4,9 +4,9 @@
  * @category Guards
  * @example array.filter(notNullish)
  */
-export function notNullish<T>(v: T | null | undefined): v is NonNullable<T> {
-  return v != null
-}
+// export function notNullish<T>(v: T | null | undefined): v is NonNullable<T> {
+//   return v != null
+// }
 
 /**
  * Type guard to filter out null values

package/core/utils/src/helpers.ts

@@ -1,9 +1,10 @@
-import { log, runCommand, spawn } from '@stacksjs/cli'
-import type { CliOptions, Manifest, NpmScript } from '@stacksjs/types'
+import type { CliOptions, CommandResult, Manifest, NpmScript } from '@stacksjs/types'
+import detectIndent from 'detect-indent'
 import { frameworkPath, projectPath } from '@stacksjs/path'
+import { parse } from 'yaml'
+import { log, runCommand, spawn } from '@stacksjs/cli'
 import storage from '@stacksjs/storage'
-import { ui } from '@stacksjs/config'
-import detectIndent from 'detect-indent'
+import { ui, app } from '@stacksjs/config'
 
 export async function isProjectCreated() {
   if (storage.isFile('.env'))
@@ -60,22 +61,6 @@ export function determineResetPreset(preset?: string) {
   return []
 }
 
-export function env(key?: string, fallback?: any) {
-  // console.log('isClient', isClient)
-  if (key && import.meta?.env) {
-    console.log('key', key, 'fallback', import.meta?.env[key])
-    return import.meta.env[key]
-  }
-
-  return fallback
-}
-
-export function config(key?: string, fallback?: string) {
-  // eslint-disable-next-line no-console
-  console.log('key', key, 'fallback', fallback)
-  // return key ? configArr[key as string] : fallback
-}
-
 /**
  * Determines whether the specified value is a package manifest.
  */
@@ -109,7 +94,7 @@ export async function setEnvValue(key: string, value: string) {
 /**
  * Runs the specified NPM script in the package.json file.
  */
-export async function runNpmScript(script: NpmScript, options?: CliOptions) {
+export async function runNpmScript(script: NpmScript, options?: CliOptions): Promise<CommandResult> {
   const { data: manifest } = await storage.readJsonFile('package.json', frameworkPath())
 
   if (isManifest(manifest) && hasScript(manifest, script)) // simple, yet effective check to see if the script exists
@@ -131,7 +116,30 @@ export function hasScript(manifest: Manifest, script: NpmScript): boolean {
   return false
 }
 
-export * from '@dinero.js/currencies'
+export function parseYaml(content: any) {
+  return parse(content)
+}
+
+/**
+ * Determines the level of debugging.
+ *
+ * The debug level is determined by the following:
+ * 1. The --verbose flag
+ * 2. The debug property in the app configuration
+ *
+ * Currently, we don't support a custom debug level,
+ * though, we would like to in the future.
+ *
+ * @param options
+ */
+export function determineDebugLevel(options?: CliOptions) {
+  if (options?.verbose === true)
+    return true
+
+  return app.debug === true
+}
+
+// export { SemVer } from 'semver'
 export * from 'dinero.js'
 export { detectIndent }
 export { detectNewline } from 'detect-newline'

package/core/utils/src/index.ts

@@ -1,13 +1,16 @@
 export { assert, toString, noop, loop, getTypeName } from './base'
+export * from './config'
+export * from './debounce'
 export * from './equal'
-export * from './helpers'
-export type { SingletonPromiseReturn, ControlledPromise } from './promise'
-export { createSingletonPromise, createPromiseLock, createControlledPromise, sleep } from './promise'
 export * from './function'
 export * from './guards'
+export * from './helpers'
 export { isDef, isBoolean, isFunction, isNumber, isString, isObject, isWindow, isBrowser, isServer, isMap, isSet, isPromise } from './is'
 export * from './p'
-export * from './vendor'
+export type { SingletonPromiseReturn, ControlledPromise } from './promise'
+export { createSingletonPromise, createPromiseLock, createControlledPromise, sleep } from './promise'
+export * as semver from 'semver'
+export * from './throttle'
 
 export * from '@vueuse/core'
 export * from '@vueuse/math'

package/core/utils/src/is.ts

@@ -1,14 +1,83 @@
-import { toString } from './base'
+import { getTypeName, toString } from './base'
 
-export const isDef = <T = any>(val?: T): val is T => typeof val !== 'undefined'
-export const isBoolean = (val: any): val is boolean => typeof val === 'boolean'
-export const isFunction = <T extends Function> (val: any): val is T => typeof val === 'function'
-export const isNumber = (val: any): val is number => typeof val === 'number'
-export const isString = (val: unknown): val is string => typeof val === 'string'
-export const isObject = (val: any): val is object => toString(val) === '[object Object]'
-export const isWindow = (val: any): boolean => typeof window !== 'undefined' && toString(val) === '[object Window]'
+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 const isMap = (val: any): val is Map<any, any> => toString(val) === '[object Map]'
-export const isSet = (val: any): val is Set<any> => toString(val) === '[object Set]'
-export const isPromise = <T = any>(val: any): val is Promise<T> => isObject(val) && isFunction(val.then) && isFunction(val.catch)
+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/utils/src/promise.ts

@@ -1,5 +1,5 @@
-import { remove } from '@stacksjs/arrays'
 import type { Fn } from '@stacksjs/types'
+import { remove } from '@stacksjs/arrays'
 
 export interface SingletonPromiseReturn<T> {
   (): Promise<T>

package/core/utils/src/throttle.ts

@@ -0,0 +1,45 @@
+/**
+ * Throttle a function.
+ *
+ * @param fn
+ * @param wait
+ * @returns
+ *
+ * @example
+ * ```ts
+ * // logs window dimensions at most every 250ms
+ * window.addEventListener(
+ *   "resize",
+ *   throttle(function (evt) {
+ *     console.log(window.innerWidth)
+ *     console.log(window.innerHeight)
+ *   }, 250)
+ * )
+ */
+export function throttle(fn: Function, wait = 300) {
+  let inThrottle: boolean
+  let lastFn: ReturnType<typeof setTimeout>
+  let lastTime: number
+
+  return function (this: any) {
+    const context = this
+    const args = arguments
+
+    if (!inThrottle) {
+      fn.apply(context, args)
+
+      lastTime = Date.now()
+      inThrottle = true
+    }
+    else {
+      clearTimeout(lastFn)
+
+      lastFn = setTimeout(() => {
+        if (Date.now() - lastTime >= wait) {
+          fn.apply(context, args)
+          lastTime = Date.now()
+        }
+      }, Math.max(wait - (Date.now() - lastTime), 0))
+    }
+  }
+}

package/core/validation/README.md

@@ -32,7 +32,7 @@ pnpm test
 
 Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
 
-## 💪🏼 Contributing
+## 🚜 Contributing
 
 Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
 

package/core/validation/build.config.ts

@@ -0,0 +1,13 @@
+import { defineBuildConfig } from 'unbuild'
+
+export default defineBuildConfig({
+  entries: [
+    {
+      builder: 'mkdist',
+      input: './src/',
+      outDir: './dist/',
+    },
+  ],
+
+  declaration: true,
+})

package/core/validation/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/validation",
   "type": "module",
-  "version": "0.50.0",
-  "packageManager": "pnpm@7.25.1",
+  "version": "0.52.0",
+  "packageManager": "pnpm@8.5.1",
   "description": "The Stacks Validation methods.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -23,7 +23,12 @@
     "functions",
     "stacks"
   ],
-  "main": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    }
+  },
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "contributors": [
@@ -33,23 +38,17 @@
     "dist",
     "README.md"
   ],
-  "engines": {
-    "node": ">=v18.13.0",
-    "pnpm": ">=7.25.1"
-  },
   "scripts": {
-    "build": "mkdist -d",
-    "dev": "mkdist -d",
+    "build": "unbuild",
+    "dev": "unbuild --stub",
     "prepublishOnly": "pnpm run build",
     "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
-    "zod": "^3.20.2"
+    "zod": "^3.21.4"
   },
   "devDependencies": {
-    "@stacksjs/path": "workspace:*",
-    "@stacksjs/testing": "workspace:*",
-    "mkdist": "^1.1.0",
-    "typescript": "^4.9.4"
+    "@stacksjs/development": "workspace:*",
+    "@stacksjs/path": "workspace:*"
   }
 }

package/core/validation/src/index.ts

@@ -1,5 +1,29 @@
-import { z } from 'zod'
+import { z as validate, z } from 'zod'
 
-const validate = z
+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(),
+})
+
+export type StacksEnv = validate.infer<typeof envVariables>
+
+export enum Type {
+  String = 'String',
+  Number = 'Number',
+  Boolean = 'Boolean',
+  Date = 'Date',
+  Object = 'Object',
+  Array = 'Array',
+}
 
 export { validate, z }

package/docs/.vitepress/config.ts

@@ -0,0 +1,9 @@
+/**
+ * This is the place where the VitePress documentation is defined.
+ * This is required because there is no way to set a custom
+ * path for the VitePress config.
+ */
+
+import docs from '../../../config/docs'
+
+export default docs

package/docs/README.md

@@ -0,0 +1,13 @@
+# Docs
+
+This folder contains the generated Stacks documentation.
+
+## How To
+
+To generate the documentation, run the following command:
+
+```bash
+pnpm run dev
+pnpm run build
+pnpm run deploy
+```

package/docs/node_modules/.bin/rimraf

@@ -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/rimraf@5.0.0/node_modules/rimraf/dist/cjs/src/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/cjs/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/cjs/src/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/cjs/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules:$NODE_PATH"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/cjs/src/bin.js" "$@"
+else
+  exec node  "$basedir/../../../../node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/cjs/src/bin.js" "$@"
+fi