@stacksjs/utils 0.53.1 → 0.56.23

package/dist/equal.mjs

@@ -1,23 +0,0 @@
-import { getTypeName } from "./base.mjs";
-export function isDeepEqual(value1, value2) {
-  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, i) => {
-      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) => {
-      return isDeepEqual(value1[key], value2[key]);
-    });
-  }
-  return Object.is(value1, value2);
-}

package/dist/function.d.ts

@@ -1,18 +0,0 @@
-import type { Fn, Nullable } from '@stacksjs/types';
-/**
- * Call every function in an array
- */
-export declare function batchInvoke(functions: Nullable<Fn>[]): void;
-/**
- * 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 declare function tap<T>(value: T, callback: (value: T) => void): T;

package/dist/function.mjs

@@ -1,7 +0,0 @@
-export function batchInvoke(functions) {
-  functions.forEach((fn) => fn && fn());
-}
-export function tap(value, callback) {
-  callback(value);
-  return value;
-}

package/dist/guards.d.ts

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

package/dist/guards.mjs

@@ -1,12 +0,0 @@
-export function notNullish(v) {
-  return v != null;
-}
-export function noNull(v) {
-  return v !== null;
-}
-export function notUndefined(v) {
-  return v !== void 0;
-}
-export function isTruthy(v) {
-  return Boolean(v);
-}

package/dist/helpers.d.ts

@@ -1,46 +0,0 @@
-import type { CliOptions, CommandResult, Manifest, NpmScript } from '@stacksjs/types';
-import detectIndent from 'detect-indent';
-export declare function isProjectCreated(): Promise<boolean>;
-export declare function installIfVersionMismatch(): Promise<void>;
-export declare function frameworkVersion(): Promise<string>;
-export declare function isAppKeySet(): Promise<boolean>;
-/**
- * Determines the utilized reset preset.
- *
- * @url https://www.npmjs.com/package/@unocss/reset
- * @param preset
- */
-export declare function determineResetPreset(preset?: string): string[];
-/**
- * Determines whether the specified value is a package manifest.
- */
-export declare function isManifest(obj: any): obj is Manifest;
-/**
- * Determines whether the specified value is a string, null, or undefined.
- */
-export declare function isOptionalString(value: any): value is string | undefined;
-export declare function setEnvValue(key: string, value: string): Promise<void>;
-/**
- * Runs the specified NPM script in the package.json file.
- */
-export declare function runNpmScript(script: NpmScript, options?: CliOptions): Promise<CommandResult>;
-/**
- * Determines whether the specified NPM script exists in the given manifest.
- */
-export declare function hasScript(manifest: Manifest, script: NpmScript): boolean;
-export declare function parseYaml(content: any): any;
-/**
- * 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 declare function determineDebugLevel(options?: CliOptions): boolean;
-export { detectIndent };
-export { detectNewline } from 'detect-newline';

package/dist/helpers.mjs

@@ -1,92 +0,0 @@
-import detectIndent from "detect-indent";
-import { frameworkPath, projectPath } from "@stacksjs/path";
-import { parse } from "yaml";
-import { execSync, log, runCommand, spawn } from "@stacksjs/cli";
-import { app, ui } from "@stacksjs/config";
-import { storage } from "@stacksjs/storage";
-import { semver } from "./versions.mjs";
-export async function isProjectCreated() {
-  if (storage.isFile(".env"))
-    return await isAppKeySet();
-  if (storage.isFile(".env.example"))
-    await spawn("cp .env.example .env", { stdio: "inherit", cwd: projectPath() });
-  return await isAppKeySet();
-}
-export async function installIfVersionMismatch() {
-  const dependenciesYaml = storage.fs.readFileSync(projectPath("tea.yaml"), "utf8");
-  const dependencies = parseYaml(dependenciesYaml).dependencies;
-  const requiredNodeVersion = dependencies["nodejs.org"];
-  const requiredPnpmVersion = dependencies["pnpm.io"];
-  const installedNodeVersion = process.version;
-  const installedPnpmVersion = execSync("pnpm -v").trim();
-  if (!semver.satisfies(installedNodeVersion, requiredNodeVersion)) {
-    log.error(`Installed Node.js version (${installedNodeVersion}) does not satisfy required version (${requiredNodeVersion}). One moment...`);
-    await runCommand(`tea +nodejs.org${requiredNodeVersion} >/dev/null 2>&1`);
-  }
-  if (!semver.satisfies(installedPnpmVersion, requiredPnpmVersion)) {
-    log.error(`Installed pnpm version (${installedPnpmVersion}) does not satisfy required version (${requiredPnpmVersion}). One moment...`);
-    await runCommand(`tea +pnpm.io${requiredPnpmVersion} >/dev/null 2>&1`);
-  }
-}
-export async function frameworkVersion() {
-  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);
-}
-export function determineResetPreset(preset) {
-  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 [];
-}
-export function isManifest(obj) {
-  return obj && typeof obj === "object" && isOptionalString(obj.name) && isOptionalString(obj.version) && isOptionalString(obj.description);
-}
-export function isOptionalString(value) {
-  const type = typeof value;
-  return value === null || type === "undefined" || type === "string";
-}
-export async function setEnvValue(key, value) {
-  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
-  });
-}
-export async function runNpmScript(script, options) {
-  const { data: manifest } = await storage.readJsonFile("package.json", frameworkPath());
-  if (isManifest(manifest) && hasScript(manifest, script))
-    return await runCommand(`pnpm run ${script}`, options);
-  log.error(`The specified npm script "${script}" does not exist in the package.json file`);
-  process.exit();
-}
-export function hasScript(manifest, script) {
-  const scripts = manifest.scripts;
-  if (scripts && typeof scripts === "object")
-    return Boolean(scripts[script]);
-  return false;
-}
-export function parseYaml(content) {
-  return parse(content);
-}
-export function determineDebugLevel(options) {
-  if (options?.verbose === true)
-    return true;
-  return app.debug === true;
-}
-export { detectIndent };
-export { detectNewline } from "detect-newline";

package/dist/math.d.ts

@@ -1,3 +0,0 @@
-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, not, or, useAbs, useAverage, useCeil, useClamp, useFloor, useMath, useMax, useMin, usePrecision, useProjection, useRound, useSum, useTrunc, } from '@vueuse/math';

package/dist/math.mjs

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

package/dist/p.d.ts

@@ -1,41 +0,0 @@
-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/p.mjs

@@ -1,74 +0,0 @@
-import pLimit from "p-limit";
-const VOID = Symbol("p-void");
-class PInstance extends Promise {
-  constructor(items = [], options) {
-    super(() => {
-    });
-    this.items = items;
-    this.options = options;
-    this.promises = /* @__PURE__ */ new Set();
-  }
-  get promise() {
-    let batch;
-    const items = [...Array.from(this.items), ...Array.from(this.promises)];
-    if (this.options?.concurrency) {
-      const limit = pLimit(this.options.concurrency);
-      batch = Promise.all(items.map((p2) => limit(() => p2)));
-    } else {
-      batch = Promise.all(items);
-    }
-    return batch.then((l) => l.filter((i) => i !== VOID));
-  }
-  add(...args) {
-    args.forEach((i) => {
-      this.promises.add(i);
-    });
-  }
-  map(fn) {
-    return new PInstance(
-      Array.from(this.items).map(async (i, idx) => {
-        const v = await i;
-        if (v === VOID)
-          return VOID;
-        return fn(v, idx);
-      }),
-      this.options
-    );
-  }
-  filter(fn) {
-    return new PInstance(
-      Array.from(this.items).map(async (i, idx) => {
-        const v = await i;
-        const r = await fn(v, idx);
-        if (!r)
-          return VOID;
-        return v;
-      }),
-      this.options
-    );
-  }
-  forEach(fn) {
-    return this.map(fn).then();
-  }
-  reduce(fn, initialValue) {
-    return this.promise.then((array) => array.reduce(fn, initialValue));
-  }
-  clear() {
-    this.promises.clear();
-  }
-  then(fn) {
-    const p2 = this.promise;
-    if (fn)
-      return p2.then(fn);
-    return p2;
-  }
-  catch(fn) {
-    return this.promise.catch(fn);
-  }
-  finally(fn) {
-    return this.promise.finally(fn);
-  }
-}
-export function p(items, options) {
-  return new PInstance(items, options);
-}

package/dist/promise.d.ts

@@ -1,65 +0,0 @@
-import type { Fn } from '@stacksjs/types';
-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>;
-/**
- * Promised `setTimeout`.
- *
- * @category Promise
- */
-export declare function sleep(ms: number, callback?: Fn<any>): Promise<void>;

package/dist/promise.mjs

@@ -1,57 +0,0 @@
-import { remove } from "@stacksjs/arrays";
-export function createSingletonPromise(fn) {
-  let _promise;
-  function wrapper() {
-    if (!_promise)
-      _promise = fn();
-    return _promise;
-  }
-  wrapper.reset = async () => {
-    const _prev = _promise;
-    _promise = void 0;
-    if (_prev)
-      await _prev;
-  };
-  return wrapper;
-}
-export function createPromiseLock() {
-  const locks = [];
-  return {
-    async run(fn) {
-      const p = fn();
-      locks.push(p);
-      try {
-        return await p;
-      } finally {
-        remove(locks, p);
-      }
-    },
-    async wait() {
-      await Promise.allSettled(locks);
-    },
-    isWaiting() {
-      return Boolean(locks.length);
-    },
-    clear() {
-      locks.length = 0;
-    }
-  };
-}
-export function createControlledPromise() {
-  let resolve, reject;
-  const promise = new Promise((_resolve, _reject) => {
-    resolve = _resolve;
-    reject = _reject;
-  });
-  promise.resolve = resolve;
-  promise.reject = reject;
-  return promise;
-}
-export function sleep(ms, callback) {
-  return new Promise(
-    (resolve) => setTimeout(async () => {
-      await callback?.();
-      resolve();
-    }, ms)
-  );
-}

package/dist/throttle.d.ts

@@ -1,19 +0,0 @@
-/**
- * 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 declare function throttle(fn: Function, wait?: number): (this: unknown, ...args: any[]) => void;

package/dist/throttle.mjs

@@ -1,20 +0,0 @@
-export function throttle(fn, wait = 300) {
-  let inThrottle;
-  let lastFn;
-  let lastTime;
-  return function(...args) {
-    if (!inThrottle) {
-      fn.apply(this, args);
-      lastTime = Date.now();
-      inThrottle = true;
-    } else {
-      clearTimeout(lastFn);
-      lastFn = setTimeout(() => {
-        if (Date.now() - lastTime >= wait) {
-          fn.apply(this, args);
-          lastTime = Date.now();
-        }
-      }, Math.max(wait - (Date.now() - lastTime), 0));
-    }
-  };
-}

package/dist/vendors.d.ts

@@ -1,3 +0,0 @@
-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, } from '@vueuse/core';
-export type { HeadClient, HeadObject, HeadObjectPlain, HookBeforeDomUpdate, HookEntriesResolved, HookTagsResolved, LegacyHeadOptions, } from '@vueuse/head';
-export { Head, HeadVuePlugin, createHead, renderHeadToString, } from '@vueuse/head';