@stacksjs/utils 0.64.5 → 0.65.0

package/dist/macroable.d.ts

@@ -0,0 +1 @@
+export { Macroable } from "macroable";

package/dist/utils.d.ts

@@ -0,0 +1,2 @@
+export declare const components: unknown;
+export declare const functions: unknown;

package/dist/versions.d.ts

@@ -0,0 +1,2 @@
+import { version } from "../package.json";
+export { version };

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@stacksjs/utils",
   "type": "module",
-  "version": "0.64.5",
+  "version": "0.65.0",
   "description": "The Stacks helper functions.",
   "author": "Chris Breuer",
-  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "contributors": ["Chris Breuer <chris@stacksjs.org>"],
   "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
   "homepage": "https://github.com/stacksjs/stacks/tree/main/storage/framework/core/helpers#readme",
   "repository": {
     "type": "git",
@@ -37,34 +38,28 @@
   },
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
-  "contributors": [
-    "Chris Breuer <chris@stacksjs.org>"
-  ],
-  "files": [
-    "README.md",
-    "dist",
-    "src"
-  ],
+  "files": ["README.md", "dist", "src"],
   "scripts": {
-    "build": "bun --bun build.ts",
-    "typecheck": "bun --bun tsc --noEmit",
+    "build": "bun build.ts",
+    "typecheck": "bun tsc --noEmit",
     "prepublishOnly": "bun run build",
     "size": "bun scripts/export-size.ts"
   },
   "dependencies": {
-    "@stacksjs/actions": "latest",
-    "@stacksjs/arrays": "latest",
-    "@stacksjs/cli": "latest",
-    "@stacksjs/config": "latest",
-    "@stacksjs/lint": "latest",
-    "@stacksjs/path": "latest",
-    "@stacksjs/storage": "latest",
-    "@stacksjs/strings": "latest",
-    "@stacksjs/types": "latest",
-    "@vueuse/core": "^11.0.3",
+    "@stacksjs/actions": "0.64.6",
+    "@stacksjs/arrays": "0.64.6",
+    "@stacksjs/cli": "0.64.6",
+    "@stacksjs/config": "0.64.6",
+    "@stacksjs/lint": "0.64.6",
+    "@stacksjs/path": "0.64.6",
+    "@stacksjs/storage": "0.64.6",
+    "@stacksjs/strings": "0.64.6",
+    "@stacksjs/types": "0.64.6",
+    "@vueuse/core": "^11.1.0",
     "@vueuse/head": "^2.0.0",
-    "@vueuse/math": "^11.0.3",
-    "@vueuse/shared": "^11.0.3",
+    "@vueuse/math": "^11.1.0",
+    "@vueuse/shared": "^11.1.0",
+    "ace-builds": "^1.36.2",
     "bun-plugin-env": "^0.4.1",
     "bun-plugin-yml": "^0.3.1",
     "defu": "^6.1.4",
@@ -77,13 +72,12 @@
     "magic-regexp": "^0.8.0",
     "perfect-debounce": "^1.0.0",
     "pretty-bytes": "^6.1.1",
-    "ace-builds": "^1.36.0",
     "resize-observer-polyfill": "^1.5.1",
     "vue3-ace-editor": "^2.2.4",
-    "yaml": "^2.5.0"
+    "yaml": "^2.5.1"
   },
   "devDependencies": {
-    "@stacksjs/development": "latest",
+    "@stacksjs/development": "0.64.6",
     "@types/js-yaml": "^4.0.9",
     "markdown-table": "^3.0.3",
     "vue-starport": "^0.4.0"

package/src/clean.ts

@@ -11,5 +11,5 @@ export async function cleanProject() {
   await $`rm -rf ${p.frameworkPath('**/node_modules')}`
   await $`rm -rf ${p.frameworkCloudPath('cdk.out/')}`
   await $`rm -rf ${p.frameworkCloudPath('cdk.context.json')}`
-  await $`rm -rf ${p.frameworkCloudPath('dist.zip')}`
+  await $`rm -rf ${p.cloudPath('dist.zip')}`
 }

package/src/config.ts

@@ -1,25 +1,25 @@
 export {
   defineApp,
   defineCache,
-  defineCli,
   defineCdn,
+  defineChat,
+  defineCli,
   defineCronJob,
-  defineJob,
-  defineDependencies,
   defineDatabase,
+  defineDependencies,
   defineDns,
+  defineEmail,
   defineEmailConfig,
   defineGit,
   defineHashing,
+  defineJob,
   defineLibrary,
   defineNotification,
-  defineSms,
-  defineEmail,
-  defineChat,
   definePayment,
   defineQueue,
   defineSearchEngine,
   defineServices,
+  defineSms,
   defineStorage,
   defineUi,
 } from '@stacksjs/config'

package/src/equal.ts

@@ -3,10 +3,12 @@ import { getTypeName } from '@stacksjs/types'
 export function isDeepEqual(value1: any, value2: any): boolean {
   const type1 = getTypeName(value1)
   const type2 = getTypeName(value2)
-  if (type1 !== type2) return false
+  if (type1 !== type2)
+    return false
 
   if (type1 === 'array') {
-    if (value1.length !== value2.length) return false
+    if (value1.length !== value2.length)
+      return false
 
     return value1.every((item: any, i: number) => {
       return isDeepEqual(item, value2[i])
@@ -14,7 +16,8 @@ export function isDeepEqual(value1: any, value2: any): boolean {
   }
   if (type1 === 'object') {
     const keyArr = Object.keys(value1)
-    if (keyArr.length !== Object.keys(value2).length) return false
+    if (keyArr.length !== Object.keys(value2).length)
+      return false
 
     return keyArr.every((key: string) => {
       return isDeepEqual(value1[key], value2[key])

package/src/find.ts

@@ -1,3 +1,4 @@
+/* eslint no-console: 0 */
 import type { Dirent } from 'node:fs'
 import fs from 'node:fs/promises'
 import os from 'node:os'
@@ -11,11 +12,12 @@ const excludePatterns = [
   'node_modules',
   'dist',
   'vendor',
+  'storage/framework',
   `${os.homedir()}/Documents`,
   `${os.homedir()}/Pictures`,
   `${os.homedir()}/Library`,
   `${os.homedir()}/.Trash`,
-  /.*out.*|.*\.out.*|out-.*/, // exclude any folder with 'out' in the name
+  /.*out.*/, // exclude any folder with 'out' in the name
   /.*\/\..*/, // exclude any folder that starts with a dot
 ]
 
@@ -38,25 +40,31 @@ export async function findStacksProjects(dir?: string, options?: FindStacksProje
 
   const foundProjects = await searchDirectory(dir)
 
-  if (!foundProjects) throw new Error('No Stacks projects found')
+  if (!foundProjects)
+    throw new Error('No Stacks projects found')
 
   return foundProjects
 }
 
-async function searchDirectory(directory: string) {
+// this searches a dir for Stacks projects which we define
+// as a dir that contains a 'buddy' file and a 'storage'
+// dir with a 'framework/core/buddy' structure
+async function searchDirectory(directory: string): Promise<string[]> {
   const foundProjects: string[] = []
-
-  const isExcluded = excludePatterns.some((pattern) =>
+  const isExcluded = excludePatterns.some(pattern =>
     typeof pattern === 'string' ? directory.includes(pattern) : pattern.test(directory),
   )
-  if (isExcluded) return
+
+  if (isExcluded)
+    return foundProjects
 
   let items: Dirent[]
   try {
     items = await fs.readdir(directory, { withFileTypes: true })
-  } catch (error) {
+  }
+  catch (error) {
     console.error(`Error reading directory ${directory}:`, error)
-    return
+    return foundProjects
   }
 
   let buddyFileFound = false
@@ -65,24 +73,30 @@ async function searchDirectory(directory: string) {
   for (const item of items) {
     if (item.isFile() && item.name === targetFileName) {
       buddyFileFound = true
-    } else if (item.isDirectory()) {
-      // Recursively search in directories
+    }
+
+    if (item.isDirectory()) {
       const fullPath = path.join(directory, item.name)
       if (item.name === 'storage') {
-        // Check if the 'storage/framework/core/buddy/' structure exists within this directory
+        const storagePath = path.join(fullPath, 'framework/core/buddy')
         try {
-          const storagePath = path.join(fullPath, 'framework/core/buddy')
           await fs.access(storagePath)
           storageDirFound = true
-        } catch (error) {
-          // The specific directory structure does not exist
+        }
+        catch (error) {
+          console.error(`Error accessing directory ${storagePath}:`, error)
         }
       }
-      await searchDirectory(fullPath)
+
+      // Accumulate results from recursive calls
+      const subDirProjects = await searchDirectory(fullPath)
+      foundProjects.push(...subDirProjects)
     }
   }
 
-  if (buddyFileFound && storageDirFound) foundProjects.push(directory) // Both conditions are met
+  if (buddyFileFound && storageDirFound) {
+    foundProjects.push(directory)
+  }
 
   return foundProjects
 }

package/src/git.ts

@@ -1,10 +1,13 @@
 import { execSync } from 'node:child_process'
+import { handleError } from '@stacksjs/error-handling'
 
-export function isGitClean() {
+export function isGitClean(): boolean {
   try {
     execSync('git diff-index --quiet HEAD --')
     return true
-  } catch (error) {
+  }
+  catch (error) {
+    handleError(error)
     return false
   }
 }

package/src/hash.ts

@@ -6,15 +6,17 @@ import { hashPaths } from '@stacksjs/storage'
 export function originRequestFunctionHash() {
   try {
     return hashPaths(p.cloudPath('src/edge'))
-  } catch (error: any) {
+  }
+  catch (error: any) {
     log.error('Are we in a Docker container? Failed to hash paths. Error below:')
     log.error(error)
     return undefined
   }
 }
 
+const docsSrc = [p.projectPath('docs'), p.frameworkPath('docs/dist')]
+
 export function websiteSourceHash() {
-  const docsSrc = [p.projectPath('docs')]
   const websiteSrc = [
     p.projectPath('resources/views'),
     p.projectPath('resources/assets'),
@@ -23,13 +25,12 @@ export function websiteSourceHash() {
     p.projectPath('resources/components'),
     p.projectPath('resources/modules'),
     p.projectPath('resources/stores'),
+    p.frameworkPath('views/web'),
   ]
 
   return config.app.docMode === true ? hashPaths(docsSrc) : hashPaths(websiteSrc)
 }
 
 export function docsSourceHash() {
-  const docsSrc = [p.projectPath('docs')]
-
   return hashPaths(docsSrc)
 }

package/src/helpers.ts

@@ -1,14 +1,14 @@
+import type { NpmScript } from '@stacksjs/enums'
+import type { Result } from '@stacksjs/error-handling'
+import type { CliOptions, Manifest, Subprocess } from '@stacksjs/types'
 import type { AddressInfo } from 'node:net'
 import { runAction } from '@stacksjs/actions'
 import { log, runCommand } from '@stacksjs/cli'
 import { app, ui } from '@stacksjs/config'
-import type { NpmScript } from '@stacksjs/enums'
 import { Action } from '@stacksjs/enums'
-import type { Result } from '@stacksjs/error-handling'
 import { err, handleError, ok } from '@stacksjs/error-handling'
 import { frameworkPath, projectPath } from '@stacksjs/path'
 import * as storage from '@stacksjs/storage'
-import type { CliOptions, Manifest, Subprocess } from '@stacksjs/types'
 import { parse } from 'yaml'
 
 // import { semver } from './versions'
@@ -19,12 +19,14 @@ export async function packageManager() {
 }
 
 export async function initProject(): Promise<Result<Subprocess, Error>> {
-  if (app.env !== 'production') log.info('Project not yet initialized, generating application key...')
+  if (app.env !== 'production')
+    log.info('Project not yet initialized, generating application key...')
   else handleError('Please run `buddy key:generate` to generate an application key')
 
   const result = await runAction(Action.KeyGenerate, { cwd: projectPath() })
 
-  if (result.isErr()) return err(handleError(result.error))
+  if (result.isErr())
+    return err(handleError(result.error))
 
   log.info('Application key generated.')
 
@@ -32,10 +34,12 @@ export async function initProject(): Promise<Result<Subprocess, Error>> {
 }
 
 export async function ensureProjectIsInitialized() {
-  if (storage.isFile(projectPath('.env'))) return await isAppKeySet()
+  if (storage.isFile(projectPath('.env')))
+    return await isAppKeySet()
 
   // copy the .env.example file to .env
-  if (storage.isFile(projectPath('.env.example'))) await runCommand('cp .env.example .env', { cwd: projectPath() })
+  if (storage.isFile(projectPath('.env.example')))
+    await runCommand('cp .env.example .env', { cwd: projectPath() })
   else console.error('no .env.example file found')
 
   return await isAppKeySet()
@@ -57,7 +61,7 @@ export async function frameworkVersion(): Promise<string> {
 export async function isAppKeySet() {
   const env = await storage.readTextFile('.env', projectPath())
   const lines = env.data.split('\n')
-  const appKey = lines.find((line) => line.startsWith('APP_KEY='))
+  const appKey = lines.find(line => line.startsWith('APP_KEY='))
 
   return !!(appKey && appKey.length > 16)
 }
@@ -69,18 +73,23 @@ export async function isAppKeySet() {
  * @param preset
  */
 export function determineResetPreset(preset?: string) {
-  if (ui.reset) preset = ui.reset
+  if (ui.reset)
+    preset = ui.reset
 
-  if (preset === 'tailwind') return ["import '@unocss/reset/tailwind.css'"]
+  if (preset === 'tailwind')
+    return ['import \'@unocss/reset/tailwind.css\'']
 
-  if (preset === 'normalize') return ["import '@unocss/reset/normalize.css'"]
+  if (preset === 'normalize')
+    return ['import \'@unocss/reset/normalize.css\'']
 
   if (preset === 'sanitize')
-    return ["import '@unocss/reset/sanitize/sanitize.css'", "import '@unocss/reset/sanitize/assets.css"]
+    return ['import \'@unocss/reset/sanitize/sanitize.css\'', 'import \'@unocss/reset/sanitize/assets.css']
 
-  if (preset === 'eric-meyer') return ["import '@unocss/reset/eric-meyer.css'"]
+  if (preset === 'eric-meyer')
+    return ['import \'@unocss/reset/eric-meyer.css\'']
 
-  if (preset === 'antfu') return ["import '@unocss/reset/antfu.css'"]
+  if (preset === 'antfu')
+    return ['import \'@unocss/reset/antfu.css\'']
 
   return []
 }
@@ -90,11 +99,11 @@ export function determineResetPreset(preset?: string) {
  */
 export function isManifest(obj: any): obj is Manifest {
   return (
-    obj &&
-    typeof obj === 'object' &&
-    isOptionalString(obj.name) &&
-    isOptionalString(obj.version) &&
-    isOptionalString(obj.description)
+    obj
+    && typeof obj === 'object'
+    && isOptionalString(obj.name)
+    && isOptionalString(obj.version)
+    && isOptionalString(obj.description)
   )
 }
 
@@ -122,7 +131,8 @@ export async function runNpmScript(script: NpmScript, options?: CliOptions): Pro
   const { data: manifest } = await storage.readJsonFile('package.json', frameworkPath())
 
   // simple, yet effective check to see if the script exists
-  if (isManifest(manifest) && hasScript(manifest, script)) return await runCommand(`bun --bun run ${script}`, options)
+  if (isManifest(manifest) && hasScript(manifest, script))
+    return await runCommand(`bun run ${script}`, options)
 
   return err(handleError(`The ${script} script does not exist in the package.json file.`))
 }
@@ -133,7 +143,8 @@ export async function runNpmScript(script: NpmScript, options?: CliOptions): Pro
 export function hasScript(manifest: Manifest, script: NpmScript): boolean {
   const scripts = manifest.scripts as Record<NpmScript, string> | undefined
 
-  if (scripts && typeof scripts === 'object') return Boolean(scripts[script])
+  if (scripts && typeof scripts === 'object')
+    return Boolean(scripts[script])
 
   return false
 }
@@ -155,19 +166,20 @@ export function parseYaml(content: any) {
  * @param options
  */
 export function determineDebugLevel(options?: CliOptions) {
-  if (options?.verbose === true) return true
+  if (options?.verbose === true)
+    return true
 
   return app.debug === true
 }
 
 export function isIpv6(address: AddressInfo): boolean {
   return (
-    address.family === 'IPv6' ||
+    address.family === 'IPv6'
     // in node >=18.0 <18.4 this was an integer value. This was changed in a minor version.
     // See: https://github.com/laravel/vite-plugin/issues/103
 
     // @ts-expect-error-next-line
-    address.family === 6
+    || address.family === 6
   )
 }
 

package/src/index.ts

@@ -1,21 +1,12 @@
-export * from './base'
 export * from './clean'
+
 export * from './config'
-export * from './debounce'
 export * from './equal'
 export * from './export-size'
 export * from './find'
-export * from './function'
 export * from './git'
-export * from './guards'
 export * from './hash'
 export * from './helpers'
 export * from './macroable'
-export * from './math'
-export * from './promise'
-export * from './regex'
-export * from './retry'
-export * from './sleep'
-export * from './throttle'
-export * from './vendors'
 export * from './versions'
+export * from '@stacksjs/browser'

package/src/utils.ts

@@ -6,10 +6,10 @@ const ignore = ['readme-md']
 
 export const components = fs
   .readdirSync(resolve(__dirname, './resources/components'))
-  .map((item) => kebabCase(item.replace(/\.(stx|vue)/g, '')))
-  .filter((item) => !ignore.includes(item))
+  .map(item => kebabCase(item.replace(/\.(stx|vue)/g, '')))
+  .filter(item => !ignore.includes(item))
 
 export const functions = fs
   .readdirSync(resolve(__dirname, './resources/functions'))
-  .map((item) => kebabCase(item.replace(/.ts/g, '')))
-  .filter((item) => !ignore.includes(item))
+  .map(item => kebabCase(item.replace(/.ts/g, '')))
+  .filter(item => !ignore.includes(item))

package/src/base.ts

@@ -1,12 +0,0 @@
-export { toString } from '@stacksjs/strings'
-
-// export function assert(condition: boolean, message: string): asserts condition {
-//   if (!condition)
-//     throw new Error(message)
-// }
-
-// export function noop() {}
-
-export async function loop(times: number, callback: any) {
-  ;[...Array(times)].forEach(async (item, i) => await callback(i))
-}

package/src/debounce.ts

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

package/src/function.ts

@@ -1,32 +0,0 @@
-import type { Fn, Nullable } from '@stacksjs/types'
-
-/**
- * Call every function in an array
- */
-export function batchInvoke(functions: Nullable<Fn>[]) {
-  functions.forEach((fn) => fn?.())
-}
-
-// /**
-//  * Call the function
-//  */
-// export function invoke(fn: Fn) {
-//   return fn()
-// }
-
-/**
- * Pass the value through the callback, and return the value
- *
- * @example
- * ```
- * function createUser(name: string): User {
- *   return tap(new User, user => {
- *     user.name = name
- *   })
- * }
- * ```
- */
-export function tap<T>(value: T, callback: (value: T) => void): T {
-  callback(value)
-  return value
-}

package/src/guards.ts

@@ -1,39 +0,0 @@
-/**
- * Type guard to filter out null-ish values
- *
- * @category Guards
- * @example array.filter(notNullish)
- */
-export function notNullish<T>(v: T | null | undefined): v is NonNullable<T> {
-  return v != null
-}
-
-/**
- * Type guard to filter out null values
- *
- * @category Guards
- * @example array.filter(noNull)
- */
-export function noNull<T>(v: T | null): v is Exclude<T, null> {
-  return v !== null
-}
-
-/**
- * Type guard to filter out null-ish values
- *
- * @category Guards
- * @example array.filter(notUndefined)
- */
-export function notUndefined<T>(v: T): v is Exclude<T, undefined> {
-  return v !== undefined
-}
-
-/**
- * Type guard to filter out falsy values
- *
- * @category Guards
- * @example array.filter(isTruthy)
- */
-export function isTruthy<T>(v: T): v is NonNullable<T> {
-  return Boolean(v)
-}

package/src/math.ts

@@ -1,30 +0,0 @@
-export const clamp = (n: number, min: number, max: number) => Math.min(max, Math.max(min, n))
-
-export function rand(min: number, max: number) {
-  min = Math.ceil(min)
-  max = Math.floor(max)
-  return Math.floor(Math.random() * (max - min + 1)) + min
-}
-
-// not, -> exported as well in ../regex
-export {
-  and,
-  createGenericProjection,
-  createProjection,
-  logicNot,
-  logicOr,
-  or,
-  useAbs,
-  useAverage,
-  useCeil,
-  useClamp,
-  useFloor,
-  useMath,
-  useMax,
-  useMin,
-  usePrecision,
-  useProjection,
-  useRound,
-  useSum,
-  useTrunc,
-} from '@vueuse/math'