@stacksjs/utils 0.64.6 → 0.67.0

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/clean.ts

@@ -1,15 +0,0 @@
-import { path as p } from '@stacksjs/path'
-
-export async function cleanProject() {
-  const $ = Bun.$
-  await $`rm -rf ${p.projectPath('bun.lockb')}`
-  await $`rm -rf ${p.projectPath('yarn.lock')}` // just in case
-  await $`rm -rf ${p.projectPath('node_modules/')}`
-  await $`rm -rf ${p.frameworkPath('dist')}`
-  await $`rm -rf ${p.frameworkPath('node_modules')}`
-  await $`rm -rf ${p.frameworkPath('**/dist')}`
-  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')}`
-}

package/src/config.ts

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

package/src/debounce.ts

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

package/src/equal.ts

@@ -1,24 +0,0 @@
-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 === 'array') {
-    if (value1.length !== value2.length) return false
-
-    return value1.every((item: any, i: number) => {
-      return isDeepEqual(item, value2[i])
-    })
-  }
-  if (type1 === 'object') {
-    const keyArr = Object.keys(value1)
-    if (keyArr.length !== Object.keys(value2).length) return false
-
-    return keyArr.every((key: string) => {
-      return isDeepEqual(value1[key], value2[key])
-    })
-  }
-  return Object.is(value1, value2)
-}

package/src/export-size.ts

@@ -1 +0,0 @@
-export { getExportsSize } from 'export-size'

package/src/find.ts

@@ -1,88 +0,0 @@
-import type { Dirent } from 'node:fs'
-import fs from 'node:fs/promises'
-import os from 'node:os'
-import path from 'node:path'
-import { italic } from '@stacksjs/cli'
-import { log } from '@stacksjs/logging'
-
-const targetFileName = 'buddy' // The exact name of the target file
-
-const excludePatterns = [
-  'node_modules',
-  'dist',
-  'vendor',
-  `${os.homedir()}/Documents`,
-  `${os.homedir()}/Pictures`,
-  `${os.homedir()}/Library`,
-  `${os.homedir()}/.Trash`,
-  /.*out.*|.*\.out.*|out-.*/, // exclude any folder with 'out' in the name
-  /.*\/\..*/, // exclude any folder that starts with a dot
-]
-
-interface FindStacksProjectsOptions {
-  quiet?: boolean
-}
-
-export async function findStacksProjects(dir?: string, options?: FindStacksProjectsOptions): Promise<string[]> {
-  dir = dir || os.homedir()
-
-  if (!options?.quiet) {
-    log.info(`Searching for Stacks projects in: ${italic(dir)}`)
-    log.info(`This may take a few moments...`)
-    console.log('')
-    console.log(italic('  Please note, while Stacks is searching for projects on your machine,'))
-    console.log(italic('  you may be asked for permissions to scan certain directories.'))
-    console.log('')
-    log.debug(`Excluding directories: ${excludePatterns.join(', ')}`)
-  }
-
-  const foundProjects = await searchDirectory(dir)
-
-  if (!foundProjects) throw new Error('No Stacks projects found')
-
-  return foundProjects
-}
-
-async function searchDirectory(directory: string) {
-  const foundProjects: string[] = []
-
-  const isExcluded = excludePatterns.some((pattern) =>
-    typeof pattern === 'string' ? directory.includes(pattern) : pattern.test(directory),
-  )
-  if (isExcluded) return
-
-  let items: Dirent[]
-  try {
-    items = await fs.readdir(directory, { withFileTypes: true })
-  } catch (error) {
-    console.error(`Error reading directory ${directory}:`, error)
-    return
-  }
-
-  let buddyFileFound = false
-  let storageDirFound = false
-
-  for (const item of items) {
-    if (item.isFile() && item.name === targetFileName) {
-      buddyFileFound = true
-    } else if (item.isDirectory()) {
-      // Recursively search in directories
-      const fullPath = path.join(directory, item.name)
-      if (item.name === 'storage') {
-        // Check if the 'storage/framework/core/buddy/' structure exists within this directory
-        try {
-          const storagePath = path.join(fullPath, 'framework/core/buddy')
-          await fs.access(storagePath)
-          storageDirFound = true
-        } catch (error) {
-          // The specific directory structure does not exist
-        }
-      }
-      await searchDirectory(fullPath)
-    }
-  }
-
-  if (buddyFileFound && storageDirFound) foundProjects.push(directory) // Both conditions are met
-
-  return foundProjects
-}

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/git.ts

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

package/src/glob.ts

@@ -1 +0,0 @@
-export { glob } from '@stacksjs/storage'

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/hash.ts

@@ -1,35 +0,0 @@
-import { config } from '@stacksjs/config'
-import { log } from '@stacksjs/logging'
-import { path as p } from '@stacksjs/path'
-import { hashPaths } from '@stacksjs/storage'
-
-export function originRequestFunctionHash() {
-  try {
-    return hashPaths(p.cloudPath('src/edge'))
-  } catch (error: any) {
-    log.error('Are we in a Docker container? Failed to hash paths. Error below:')
-    log.error(error)
-    return undefined
-  }
-}
-
-export function websiteSourceHash() {
-  const docsSrc = [p.projectPath('docs')]
-  const websiteSrc = [
-    p.projectPath('resources/views'),
-    p.projectPath('resources/assets'),
-    p.projectPath('resources/lang'),
-    p.projectPath('resources/functions'),
-    p.projectPath('resources/components'),
-    p.projectPath('resources/modules'),
-    p.projectPath('resources/stores'),
-  ]
-
-  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,174 +0,0 @@
-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'
-
-export async function packageManager() {
-  const { packageManager } = await storage.readPackageJson(frameworkPath('package.json'))
-  return packageManager
-}
-
-export async function initProject(): Promise<Result<Subprocess, Error>> {
-  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))
-
-  log.info('Application key generated.')
-
-  return ok(result.value)
-}
-
-export async function ensureProjectIsInitialized() {
-  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() })
-  else console.error('no .env.example file found')
-
-  return await isAppKeySet()
-}
-
-export async function installIfVersionMismatch() {
-  // const requiredBunVersion = '0.8.1'
-  // const installedBunVersion = process.version
-  // if (!semver.satisfies(installedBunVersion, requiredBunVersion)) {
-  //   log.warn(`Installed Bun version ${italic(installedBunVersion)} does not satisfy required version ${italic(requiredBunVersion)}. Adding it to your environment. One moment...`)
-  //   await runCommand(`tea +bun.sh${requiredBunVersion} >/dev/null 2>&1`)
-  // }
-}
-
-export async function frameworkVersion(): Promise<string> {
-  return (await storage.readPackageJson(frameworkPath('package.json'))).version
-}
-
-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='))
-
-  return !!(appKey && appKey.length > 16)
-}
-
-/**
- * Determines the utilized reset preset.
- *
- * @url https://www.npmjs.com/package/@unocss/reset
- * @param preset
- */
-export function determineResetPreset(preset?: string) {
-  if (ui.reset) preset = ui.reset
-
-  if (preset === 'tailwind') return ["import '@unocss/reset/tailwind.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"]
-
-  if (preset === 'eric-meyer') return ["import '@unocss/reset/eric-meyer.css'"]
-
-  if (preset === 'antfu') return ["import '@unocss/reset/antfu.css'"]
-
-  return []
-}
-
-/**
- * Determines whether the specified value is a package manifest.
- */
-export function isManifest(obj: any): obj is Manifest {
-  return (
-    obj &&
-    typeof obj === 'object' &&
-    isOptionalString(obj.name) &&
-    isOptionalString(obj.version) &&
-    isOptionalString(obj.description)
-  )
-}
-
-/**
- * Determines whether the specified value is a string, null, or undefined.
- */
-export function isOptionalString(value: any): value is string | undefined {
-  const type = typeof value
-  return value === null || type === 'undefined' || type === 'string'
-}
-
-export async function setEnvValue(key: string, value: string) {
-  const file = await storage.readTextFile(projectPath('.env'))
-
-  await storage.writeTextFile({
-    path: projectPath('.env'),
-    data: file.data.replace(/APP_KEY=/g, `APP_KEY=${value}`), // todo: do not hardcode the APP_KEY here and instead use the key parameter
-  })
-}
-
-/**
- * Runs the specified NPM script in the package.json file.
- */
-export async function runNpmScript(script: NpmScript, options?: CliOptions): Promise<Result<Subprocess, Error>> {
-  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)
-
-  return err(handleError(`The ${script} script does not exist in the package.json file.`))
-}
-
-/**
- * Determines whether the specified NPM script exists in the given manifest.
- */
-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])
-
-  return false
-}
-
-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 function isIpv6(address: AddressInfo): boolean {
-  return (
-    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
-  )
-}
-
-export { dump as dumpYaml, load as loadYaml } from 'js-yaml'

package/src/index.ts

@@ -1,21 +0,0 @@
-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'

package/src/macroable.ts

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

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'

package/src/promise.ts

@@ -1,116 +0,0 @@
-import { remove } from '@stacksjs/arrays'
-
-export interface SingletonPromiseReturn<T> {
-  (): Promise<T>
-  /**
-   * Reset current staled promise.
-   * Await it to have proper shutdown.
-   */
-  reset: () => Promise<void>
-}
-
-// export { peek } from 'bun'
-
-/**
- * Promise with `resolve` and `reject` methods of itself
- */
-export interface ControlledPromise<T = void> extends Promise<T> {
-  resolve: (value: T | PromiseLike<T>) => void
-  reject: (reason?: any) => void
-}
-
-/**
- * Create singleton promise function.
- *
- * @category Promise
- */
-export function createSingletonPromise<T>(fn: () => Promise<T>): SingletonPromiseReturn<T> {
-  let _promise: Promise<T> | undefined
-
-  function wrapper() {
-    if (!_promise) _promise = fn()
-    return _promise
-  }
-  wrapper.reset = async () => {
-    const _prev = _promise
-    _promise = undefined
-    if (_prev) await _prev
-  }
-
-  return wrapper
-}
-
-/**
- * Create a promise lock.
- *
- * @category Promise
- * @example
- * ```
- * const lock = createPromiseLock()
- *
- * lock.run(async () => {
- *   await doSomething()
- * })
- *
- * // in anther context:
- * await lock.wait() // it will wait all tasking finished
- * ```
- */
-export function createPromiseLock() {
-  const locks: Promise<any>[] = []
-
-  return {
-    async run<T = void>(fn: () => Promise<T>): Promise<T> {
-      const p = fn()
-      locks.push(p)
-      try {
-        return await p
-      } finally {
-        remove(locks, p)
-      }
-    },
-    async wait(): Promise<void> {
-      await Promise.allSettled(locks)
-    },
-    isWaiting() {
-      return Boolean(locks.length)
-    },
-    clear() {
-      locks.length = 0
-    },
-  }
-}
-
-/**
- * Return a Promise with `resolve` and `reject` methods
- *
- * @category Promise
- * @example
- * ```
- * const promise = createControlledPromise()
- *
- * await promise
- *
- * // in anther context:
- * promise.resolve(data)
- * ```
- */
-export function createControlledPromise<T>(): ControlledPromise<T> {
-  let resolve: any
-  let reject: any
-
-  const promise = new Promise<T>((_resolve, _reject) => {
-    resolve = _resolve
-    reject = _reject
-  }) as ControlledPromise<T>
-
-  promise.resolve = resolve
-
-  promise.reject = reject
-  return promise
-}
-
-/**
- * Create a promise that will be resolved after `ms` milliseconds.
- */
-// export { sleep, sleepSync } from 'bun'

package/src/regex.ts

@@ -1,35 +0,0 @@
-export type {
-  Flag,
-  MagicRegExp,
-  MagicRegExpMatchArray,
-  Input,
-  MapToStringCapturedBy,
-  StringCapturedBy,
-} from 'magic-regexp'
-export {
-  createRegExp,
-  caseInsensitive,
-  anyOf,
-  carriageReturn,
-  char,
-  charIn,
-  charNotIn,
-  digit,
-  dotAll,
-  exactly,
-  global,
-  letter,
-  linefeed,
-  maybe,
-  multiline,
-  not,
-  oneOrMore,
-  sticky,
-  tab,
-  unicode,
-  whitespace,
-  withIndices,
-  word,
-  wordBoundary,
-  wordChar,
-} from 'magic-regexp'