@stacksjs/utils 0.58.73 → 0.59.2

package/dist/macroable.d.ts

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

package/dist/math.d.ts

@@ -0,0 +1,3 @@
+export declare const clamp: (n: number, min: number, max: number) => number;
+export declare function rand(min: number, max: number): number;
+export { and, createGenericProjection, createProjection, logicNot, logicOr, or, useAbs, useAverage, useCeil, useClamp, useFloor, useMath, useMax, useMin, usePrecision, useProjection, useRound, useSum, useTrunc, } from '@vueuse/math';

package/dist/p.d.ts

@@ -0,0 +1,41 @@
+interface POptions {
+    /**
+     * How many promises are resolved at the same time.
+     */
+    concurrency?: number | undefined;
+}
+declare class PInstance<T = any> extends Promise<Awaited<T>[]> {
+    items: Iterable<T>;
+    options?: POptions | undefined;
+    private promises;
+    get promise(): Promise<Awaited<T>[]>;
+    constructor(items?: Iterable<T>, options?: POptions | undefined);
+    add(...args: (T | Promise<T>)[]): void;
+    map<U>(fn: (value: Awaited<T>, index: number) => U): PInstance<Promise<U>>;
+    filter(fn: (value: Awaited<T>, index: number) => boolean | Promise<boolean>): PInstance<Promise<T>>;
+    forEach(fn: (value: Awaited<T>, index: number) => void): Promise<void>;
+    reduce<U>(fn: (previousValue: U, currentValue: Awaited<T>, currentIndex: number, array: Awaited<T>[]) => U, initialValue: U): Promise<U>;
+    clear(): void;
+    then(fn?: () => PromiseLike<any>): Promise<any>;
+    catch(fn?: (err: unknown) => PromiseLike<any>): Promise<any>;
+    finally(fn?: () => void): Promise<Awaited<T>[]>;
+}
+/**
+ * Utility for managing multiple promises.
+ *
+ * @see https://github.com/antfu/utils/tree/main/docs/p.md
+ * @category Promise
+ * @example
+ * ```
+ * import { p } from '@stacksjs/utils'
+ *
+ * const items = [1, 2, 3, 4, 5]
+ *
+ * await p(items)
+ *   .map(async i => await multiply(i, 3))
+ *   .filter(async i => await isEven(i))
+ * // [6, 12]
+ * ```
+ */
+export declare function p<T = any>(items?: Iterable<T>, options?: POptions): PInstance<T>;
+export {};

package/dist/promise.d.ts

@@ -0,0 +1,61 @@
+export interface SingletonPromiseReturn<T> {
+    (): Promise<T>;
+    /**
+     * Reset current staled promise.
+     * Await it to have proper shutdown.
+     */
+    reset: () => Promise<void>;
+}
+/**
+ * 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 declare function createSingletonPromise<T>(fn: () => Promise<T>): SingletonPromiseReturn<T>;
+/**
+ * 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 declare function createPromiseLock(): {
+    run<T = void>(fn: () => Promise<T>): Promise<T>;
+    wait(): Promise<void>;
+    isWaiting(): boolean;
+    clear(): void;
+};
+/**
+ * Return a Promise with `resolve` and `reject` methods
+ *
+ * @category Promise
+ * @example
+ * ```
+ * const promise = createControlledPromise()
+ *
+ * await promise
+ *
+ * // in anther context:
+ * promise.resolve(data)
+ * ```
+ */
+export declare function createControlledPromise<T>(): ControlledPromise<T>;
+/**
+ * Create a promise that will be resolved after `ms` milliseconds.
+ */

package/dist/regex.d.ts

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

package/dist/retry.d.ts

@@ -0,0 +1,2 @@
+export declare function retry(fn: Function, options: any): Promise<any>;
+export declare function calculateDelay(attemptCount: number, initialDelay: number, backoffFactor: number, jitter?: boolean): number;

package/dist/sleep.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Pauses execution for a specified number of milliseconds.
+ * @param ms The number of milliseconds to pause execution.
+ * @returns A promise that resolves after the specified delay.
+ */
+export declare function sleep(ms: number): Promise<void>;
+/**
+ * Pauses execution for a specified number of milliseconds.
+ * @param ms The number of milliseconds to pause execution.
+ * @returns A promise that resolves after the specified delay.
+ */
+export declare function wait(ms: number): Promise<void>;
+/**
+ * Pauses execution for a specified number of milliseconds.
+ * @param ms The number of milliseconds to pause execution.
+ * @returns A promise that resolves after the specified delay.
+ */
+export declare function delay(ms: number): Promise<void>;
+/**
+ * Pauses execution until a specified condition is met.
+ * @param condition The condition to wait for.
+ * @param interval The interval at which to check the condition, in milliseconds. Defaults to 1000.
+ * @returns A promise that resolves when the condition is met.
+ */
+export declare function waitUntil(condition: () => boolean, interval?: number): Promise<void>;
+/**
+ * Pauses execution while a specified condition is met.
+ * @param condition The condition to wait while.
+ * @param interval The interval at which to check the condition, in milliseconds. Defaults to 1000.
+ * @returns A promise that resolves when the condition is no longer met.
+ */
+export declare function waitWhile(condition: () => boolean, interval?: number): Promise<void>;

package/dist/throttle.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Throttle a function.
+ *
+ * @param {Function} fn - The function to throttle.
+ * @param {number} [wait] - The time to wait between function calls.
+ * @returns {Function} - A new function that throttles the calls to the original function.
+ *
+ * @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 declare function throttle(fn: Function, wait?: number): (this: unknown, ...args: any[]) => void;

package/dist/vendors.d.ts

@@ -0,0 +1,4 @@
+export { asyncComputed, breakpointsAntDesign, breakpointsBootstrapV5, breakpointsMasterCss, breakpointsQuasar, breakpointsSematic, breakpointsTailwind, breakpointsVuetify, cloneFnJSON, computedAsync, computedInject, createFetch, createReusableTemplate, createTemplatePromise, createUnrefFn, customStorageEventName, defaultDocument, defaultLocation, defaultNavigator, defaultWindow, executeTransition, formatTimeAgo, getSSRHandler, mapGamepadToXbox360Controller, onClickOutside, onKeyDown, onKeyPressed, onKeyStroke, onKeyUp, onLongPress, onStartTyping, setSSRHandler, templateRef, unrefElement, useActiveElement, useAnimate, useAsyncQueue, useAsyncState, useBase64, useBattery, useBluetooth, useBreakpoints, useBroadcastChannel, useBrowserLocation, useCached, useClipboard, useCloned, useColorMode, useConfirmDialog, useCssVar, useCurrentElement, useCycleList, useDark, useDebouncedRefHistory, useDeviceMotion, useDeviceOrientation, useDevicePixelRatio, useDevicesList, useDisplayMedia, useDocumentVisibility, useDraggable, useDropZone, useElementBounding, useElementByPoint, useElementHover, useElementSize, useElementVisibility, useEventBus, useEventListener, useEventSource, useEyeDropper, useFavicon, useFetch, useFileDialog, useFileSystemAccess, useFocus, useFocusWithin, useFps, useFullscreen, useGamepad, useGeolocation, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useKeyModifier, useLocalStorage, useMagicKeys, useManualRefHistory, useMediaControls, useMediaQuery, useMemoize, useMemory, useMounted, useMouse, useMouseInElement, useMousePressed, useMutationObserver, useNavigatorLanguage, useNetwork, useObjectUrl, useOffsetPagination, useOnline, usePageLeave, useParallax, useParentElement, usePerformanceObserver, usePermission, usePointer, usePointerLock, usePointerSwipe, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useRafFn, useRefHistory, useResizeObserver, useScreenOrientation, useScreenSafeArea, useScriptTag, useScroll, useScrollLock, useSessionStorage, useShare, useSorted, useSpeechRecognition, useSpeechSynthesis, useStepper, useStorage, useStorageAsync, useStyleTag, useSupported, useSwipe, useTemplateRefsList, useTextDirection, useTextSelection, useTextareaAutosize, useThrottledRefHistory, useTimeAgo, useTimeoutPoll, useTimestamp, useTitle, useTransition, useToggle, useUrlSearchParams, useUserMedia, useVModel, useVModels, useVibrate, useVirtualList, useWakeLock, useWebNotification, useWebSocket, useWebWorker, useWebWorkerFn, useWindowFocus, useWindowScroll, useWindowSize, useDateFormat, useNow, watchArray, watchAtMost, watchDebounced, watchDeep, watchIgnorable, watchImmediate, watchOnce, watchPausable, watchThrottled, watchTriggerable, watchWithFilter, whenever, syncRef, syncRefs, throttledRef, throttledWatch, toReactive, tryOnBeforeMount, tryOnBeforeUnmount, tryOnMounted, tryOnScopeDispose, tryOnUnmounted, until, isDefined, ignorableWatch, extendRef, eagerComputed, debouncedRef, debouncedWatch, createReactiveFn, createSharedComposable, createInjectionState, createGlobalState, createEventHook, controlledRef, controlledComputed, computedEager, computedWithControl, autoResetRef, injectLocal, makeDestructurable, pausableWatch, provideLocal, reactify, reactifyObject, reactiveComputed, reactiveOmit, reactivePick, refAutoReset, refDebounced, refDefault, refThrottled, refWithControl, resolveRef, resolveUnref, useArrayDifference, useArrayEvery, useArrayFilter, useArrayFind, useArrayFindIndex, useArrayIncludes, useArrayMap, useArrayReduce, useArraySome, useArrayUnique, useClipboardItems, useCounter, useDebounce, useDebounceFn, useInterval, useIntervalFn, useLastChanged, useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useToNumber, useToString, } from '@vueuse/core';
+export type { HeadObject, HeadObjectPlain, } from '@vueuse/head';
+export { Head, HeadVuePlugin, createHead, renderHeadToString, } from '@vueuse/head';
+export { default as readableSize } from 'pretty-bytes';

package/dist/versions.d.ts

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/utils",
   "type": "module",
-  "version": "0.58.73",
+  "version": "0.59.2",
   "description": "The Stacks helper functions.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -63,14 +63,14 @@
     "@stacksjs/strings": "latest",
     "@stacksjs/types": "latest",
     "@types/js-yaml": "^4.0.9",
-    "@vueuse/core": "^10.8.0",
+    "@vueuse/core": "^10.9.0",
     "@vueuse/head": "^2.0.0",
-    "@vueuse/math": "^10.8.0",
-    "@vueuse/shared": "^10.8.0",
+    "@vueuse/math": "^10.9.0",
+    "@vueuse/shared": "^10.9.0",
+    "bun-plugin-env": "^0.4.1",
+    "bun-plugin-yml": "^0.3.0",
     "export-size": "^0.7.0",
-    "js-yaml": "^4.1.0",
-    "rimraf": "^5.0.5",
-    "yaml": "^2.3.4"
+    "yaml": "^2.4.0"
   },
   "dependencies": {
     "@dinero.js/currencies": "2.0.0-alpha.14",
@@ -83,10 +83,12 @@
     "@stacksjs/storage": "latest",
     "@stacksjs/strings": "latest",
     "@stacksjs/types": "latest",
-    "@vueuse/core": "^10.8.0",
+    "@vueuse/core": "^10.9.0",
     "@vueuse/head": "^2.0.0",
-    "@vueuse/math": "^10.8.0",
-    "@vueuse/shared": "^10.8.0",
+    "@vueuse/math": "^10.9.0",
+    "@vueuse/shared": "^10.9.0",
+    "bun-plugin-env": "^0.4.1",
+    "bun-plugin-yml": "^0.3.0",
     "defu": "^6.1.4",
     "detect-indent": "^7.0.1",
     "detect-newline": "^4.0.1",
@@ -99,8 +101,7 @@
     "p-limit": "^5.0.0",
     "perfect-debounce": "^1.0.0",
     "pretty-bytes": "^6.1.1",
-    "rimraf": "^5.0.5",
-    "yaml": "^2.3.4"
+    "yaml": "^2.4.0"
   },
   "devDependencies": {
     "@stacksjs/development": "latest",

package/src/clean.ts

@@ -1,17 +1,15 @@
 import { path as p } from '@stacksjs/path'
-import { rimraf } from './delete'
+import { $ } from 'bun'
 
 export async function cleanProject() {
-  return await rimraf([
-    p.projectPath('bun.lockb'),
-    p.projectPath('yarn.lock'),
-    p.projectPath('node_modules/'),
-    p.frameworkPath('dist'),
-    p.frameworkPath('node_modules'),
-    p.frameworkPath('**/dist'),
-    p.frameworkPath('**/node_modules'),
-    p.frameworkCloudPath('cdk.out/'),
-    p.frameworkCloudPath('cdk.context.json'),
-    p.frameworkCloudPath('dist.zip'),
-  ])
+  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/find.ts

@@ -11,11 +11,13 @@ const targetFileName = 'buddy' // The exact name of the target file
 const excludePatterns = [
   'node_modules',
   'dist',
-  /.*out.*/,
+  '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 {
@@ -26,7 +28,8 @@ export async function findStacksProjects(dir?: string, options?: FindStacksProje
   dir = dir || os.homedir()
 
   if (!options?.quiet) {
-    log.info(`This may take a few moments, searching for Stacks projects in: ${italic(dir)}`)
+    log.info(`Searching for Stacks projects in: ${italic(dir)}`)
+    log.info(`This may take a few moments...`)
     // eslint-disable-next-line no-console
     console.log('')
     // eslint-disable-next-line no-console
@@ -38,54 +41,57 @@ export async function findStacksProjects(dir?: string, options?: FindStacksProje
     log.debug(`Excluding directories: ${excludePatterns.join(', ')}`)
   }
 
-  const foundProjects: string[] = []
+  const foundProjects = await searchDirectory(dir)
 
-  async function searchDirectory(directory: string) {
-    if (path.basename(directory).startsWith('.'))
-      return
+  if (!foundProjects)
+    throw new Error('No Stacks projects found')
 
-    const isExcluded = excludePatterns.some(pattern => typeof pattern === 'string' ? directory.includes(pattern) : pattern.test(directory))
-    if (isExcluded)
-      return
+  return foundProjects
+}
 
-    let items: Dirent[]
-    try {
-      items = await fs.readdir(directory, { withFileTypes: true })
-    }
-    catch (error) {
-      console.error(`Error reading directory ${directory}:`, error)
-      return
-    }
+async function searchDirectory(directory: string) {
+  const foundProjects: string[] = []
 
-    let buddyFileFound = false
-    let storageDirFound = false
+  const isExcluded = excludePatterns.some(pattern => typeof pattern === 'string' ? directory.includes(pattern) : pattern.test(directory))
+  if (isExcluded)
+    return
 
-    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
-          }
+  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)
       }
+      await searchDirectory(fullPath)
     }
-
-    if (buddyFileFound && storageDirFound)
-      foundProjects.push(directory) // Both conditions are met
   }
 
-  await searchDirectory(dir)
+  if (buddyFileFound && storageDirFound)
+    foundProjects.push(directory) // Both conditions are met
+
   return foundProjects
 }

package/src/index.ts

@@ -3,7 +3,6 @@ export * from './clean'
 export * from './config'
 export * from './currency'
 export * from './debounce'
-export * from './delete'
 export * from './equal'
 export * from './export-size'
 export * from './find'

package/src/delete.ts

@@ -1 +0,0 @@
-export { rimraf } from 'rimraf'