@stacksjs/utils 0.51.0 → 0.52.0

package/dist/base.d.ts

@@ -1,5 +1,5 @@
-export declare const assert: (condition: boolean, message: string) => asserts condition;
-export declare const toString: (v: any) => any;
-export declare const noop: () => void;
-export declare const loop: (times: number, callback: any) => void;
-export declare const getTypeName: (v: any) => any;
+export declare function assert(condition: boolean, message: string): asserts condition;
+export declare function toString(v: any): any;
+export declare function noop(): void;
+export declare function loop(times: number, callback: any): void;
+export declare function getTypeName(v: any): any;

package/dist/base.mjs

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

package/dist/config.d.ts

@@ -0,0 +1,23 @@
+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 declare function env(key: any, fallback?: any): any;
+export declare function defineApp(options: Partial<AppOptions>): Partial<AppOptions>;
+export declare function defineCache(options: Partial<CacheOptions>): Partial<CacheOptions>;
+export declare function defineCdn(options: Partial<CdnOptions>): Partial<CdnOptions>;
+export declare function defineCli(options: Partial<UserCliOptions>): Partial<UserCliOptions>;
+export declare function defineCronJobsConfig(options: Partial<CronJobOptions>[]): Partial<CronJobOptions>[];
+export declare function defineDatabase(options: Partial<DatabaseOptions>): Partial<DatabaseOptions>;
+export declare function defineDebugConfig(options: Partial<DebugOptions>): Partial<DebugOptions>;
+export declare function defineDns(options: Partial<DnsOptions>): Partial<DnsOptions>;
+export declare function defineEmailConfig(options: Partial<EmailOptions>): Partial<EmailOptions>;
+export declare function defineEvents(options: Partial<Events>): Partial<Events>;
+export declare function defineGit(options: Partial<GitOptions>): Partial<GitOptions>;
+export declare function defineHashing(options: Partial<HashingOptions>): Partial<HashingOptions>;
+export declare function defineLibrary(options: Partial<LibraryOptions>): Partial<LibraryOptions>;
+export declare function defineModel(options: Partial<Model>): Partial<Model>;
+export declare function defineNotification(options: Partial<NotificationOptions>): Partial<NotificationOptions>;
+export declare function definePage(options: Partial<PagesOption>): Partial<PagesOption>;
+export declare function definePayment(options: Partial<PaymentOptions>): Partial<PaymentOptions>;
+export declare function defineSearchEngine(options: Partial<SearchEngineOptions>): Partial<SearchEngineOptions>;
+export declare function defineServices(options: Partial<ServicesOptions>): Partial<ServicesOptions>;
+export declare function defineStorage(options: Partial<StorageOptions>): Partial<StorageOptions>;
+export declare function defineUi(options: Partial<UiOptions>): Partial<UiOptions>;

package/dist/config.mjs

@@ -0,0 +1,66 @@
+export function env(key, fallback) {
+  return key;
+}
+export function defineApp(options) {
+  return options;
+}
+export function defineCache(options) {
+  return options;
+}
+export function defineCdn(options) {
+  return options;
+}
+export function defineCli(options) {
+  return options;
+}
+export function defineCronJobsConfig(options) {
+  return options;
+}
+export function defineDatabase(options) {
+  return options;
+}
+export function defineDebugConfig(options) {
+  return options;
+}
+export function defineDns(options) {
+  return options;
+}
+export function defineEmailConfig(options) {
+  return options;
+}
+export function defineEvents(options) {
+  return options;
+}
+export function defineGit(options) {
+  return options;
+}
+export function defineHashing(options) {
+  return options;
+}
+export function defineLibrary(options) {
+  return options;
+}
+export function defineModel(options) {
+  return options;
+}
+export function defineNotification(options) {
+  return options;
+}
+export function definePage(options) {
+  return options;
+}
+export function definePayment(options) {
+  return options;
+}
+export function defineSearchEngine(options) {
+  return options;
+}
+export function defineServices(options) {
+  return options;
+}
+export function defineStorage(options) {
+  return options;
+}
+export function defineUi(options) {
+  return options;
+}

package/dist/debounce.d.ts

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

package/dist/debounce.mjs

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

package/dist/guards.d.ts

@@ -4,7 +4,6 @@
  * @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
  *

package/dist/guards.mjs

@@ -1,6 +1,3 @@
-export function notNullish(v) {
-  return v != null;
-}
 export function noNull(v) {
   return v !== null;
 }

package/dist/helpers.d.ts

@@ -1,4 +1,4 @@
-import type { CliOptions, Manifest, NpmScript } from '@stacksjs/types';
+import type { CliOptions, CommandResult, Manifest, NpmScript } from '@stacksjs/types';
 import detectIndent from 'detect-indent';
 export declare function isProjectCreated(): Promise<boolean>;
 export declare function frameworkVersion(): Promise<string>;
@@ -10,8 +10,6 @@ export declare function isAppKeySet(): Promise<boolean>;
  * @param preset
  */
 export declare function determineResetPreset(preset?: string): string[];
-export declare function env(key?: string, fallback?: any): any;
-export declare function config(key?: string, fallback?: string): void;
 /**
  * Determines whether the specified value is a package manifest.
  */
@@ -24,12 +22,25 @@ 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<import("neverthrow").Result<import("execa").ExecaReturnValue<string>, Error>>;
+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 * from '@dinero.js/currencies';
+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 * from 'dinero.js';
 export { detectIndent };
 export { detectNewline } from 'detect-newline';

package/dist/helpers.mjs

@@ -1,8 +1,9 @@
-import { log, runCommand, spawn } from "@stacksjs/cli";
+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"))
     return await isAppKeySet();
@@ -15,8 +16,8 @@ export async function frameworkVersion() {
   return packageJson.version;
 }
 export async function isAppKeySet() {
-  const env2 = await storage.readTextFile(".env", projectPath());
-  const lines = env2.data.split("\n");
+  const env = await storage.readTextFile(".env", projectPath());
+  const lines = env.data.split("\n");
   const appKey = lines.find((line) => line.startsWith("APP_KEY="));
   if (appKey && appKey.length > 16)
     return true;
@@ -37,15 +38,6 @@ export function determineResetPreset(preset) {
     return ["import '@unocss/reset/antfu.css'"];
   return [];
 }
-export function env(key, fallback) {
-  if (key && import.meta?.env) {
-    return import.meta.env[key];
-  }
-  return fallback;
-}
-export function config(key, fallback) {
-  console.log("key", key, "fallback", fallback);
-}
 export function isManifest(obj) {
   return obj && typeof obj === "object" && isOptionalString(obj.name) && isOptionalString(obj.version) && isOptionalString(obj.description);
 }
@@ -74,7 +66,14 @@ export function hasScript(manifest, script) {
     return Boolean(scripts[script]);
   return false;
 }
-export * from "@dinero.js/currencies";
+export function parseYaml(content) {
+  return parse(content);
+}
+export function determineDebugLevel(options) {
+  if (options?.verbose === true)
+    return true;
+  return app.debug === true;
+}
 export * from "dinero.js";
 export { detectIndent };
 export { detectNewline } from "detect-newline";

package/dist/index.d.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';
 export * from '@vueuse/shared';

package/dist/index.mjs

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

package/dist/is.d.ts

@@ -1,12 +1,28 @@
-export declare const isDef: <T = any>(val?: T | undefined) => val is T;
-export declare const isBoolean: (val: any) => val is boolean;
-export declare const isFunction: <T extends Function>(val: any) => val is T;
-export declare const isNumber: (val: any) => val is number;
-export declare const isString: (val: unknown) => val is string;
-export declare const isObject: (val: any) => val is object;
-export declare const isWindow: (val: any) => boolean;
+export declare function isDef<T = any>(val?: T): val is T;
+export declare function isBoolean(val: any): val is boolean;
+export declare function isFunction<T extends Function>(val: any): val is T;
+export declare function isNumber(val: any): val is number;
+export declare function isString(val: unknown): val is string;
+export declare function isObject(val: any): val is object;
+export declare function isWindow(val: any): boolean;
 export declare const isBrowser: boolean;
 export declare const isServer: boolean;
-export declare const isMap: (val: any) => val is Map<any, any>;
-export declare const isSet: (val: any) => val is Set<any>;
-export declare const isPromise: <T = any>(val: any) => val is Promise<T>;
+export declare function isMap(val: any): val is Map<any, any>;
+export declare function isSet(val: any): val is Set<any>;
+export declare function isPromise<T = any>(val: any): val is Promise<T>;
+export declare function isUndefined(v: any): boolean;
+export declare function isNull(v: any): boolean;
+export declare function isSymbol(v: any): boolean;
+export declare function isDate(v: any): boolean;
+export declare function isRegExp(v: any): boolean;
+export declare function isArray(v: any): boolean;
+export declare function isPrimitive(v: any): boolean;
+export declare function isInteger(v: any): boolean;
+export declare function isFloat(v: any): boolean;
+export declare function isPositive(v: any): boolean;
+export declare function isNegative(v: any): boolean;
+export declare function isEven(v: any): boolean;
+export declare function isOdd(v: any): boolean;
+export declare function isEvenOrOdd(v: any): false | "even" | "odd";
+export declare function isPositiveOrNegative(v: any): false | "positive" | "negative";
+export declare function isIntegerOrFloat(v: any): false | "integer" | "float";

package/dist/is.mjs

@@ -1,13 +1,82 @@
-import { toString } from "./base.mjs";
-export const isDef = (val) => typeof val !== "undefined";
-export const isBoolean = (val) => typeof val === "boolean";
-export const isFunction = (val) => typeof val === "function";
-export const isNumber = (val) => typeof val === "number";
-export const isString = (val) => typeof val === "string";
-export const isObject = (val) => toString(val) === "[object Object]";
-export const isWindow = (val) => typeof window !== "undefined" && toString(val) === "[object Window]";
+import { getTypeName, toString } from "./base.mjs";
+export function isDef(val) {
+  return typeof val !== "undefined";
+}
+export function isBoolean(val) {
+  return typeof val === "boolean";
+}
+export function isFunction(val) {
+  return typeof val === "function";
+}
+export function isNumber(val) {
+  return typeof val === "number";
+}
+export function isString(val) {
+  return typeof val === "string";
+}
+export function isObject(val) {
+  return toString(val) === "[object Object]";
+}
+export function isWindow(val) {
+  return typeof window !== "undefined" && toString(val) === "[object Window]";
+}
 export const isBrowser = typeof window !== "undefined";
 export const isServer = typeof document === "undefined";
-export const isMap = (val) => toString(val) === "[object Map]";
-export const isSet = (val) => toString(val) === "[object Set]";
-export const isPromise = (val) => isObject(val) && isFunction(val.then) && isFunction(val.catch);
+export function isMap(val) {
+  return toString(val) === "[object Map]";
+}
+export function isSet(val) {
+  return toString(val) === "[object Set]";
+}
+export function isPromise(val) {
+  return toString(val) === "[object Promise]";
+}
+export function isUndefined(v) {
+  return getTypeName(v) === "undefined";
+}
+export function isNull(v) {
+  return getTypeName(v) === "null";
+}
+export function isSymbol(v) {
+  return getTypeName(v) === "symbol";
+}
+export function isDate(v) {
+  return getTypeName(v) === "date";
+}
+export function isRegExp(v) {
+  return getTypeName(v) === "regexp";
+}
+export function isArray(v) {
+  return getTypeName(v) === "array";
+}
+export function isPrimitive(v) {
+  const type = getTypeName(v);
+  return type === "null" || type === "undefined" || type === "string" || type === "number" || type === "boolean" || type === "symbol";
+}
+export function isInteger(v) {
+  return isNumber(v) && Number.isInteger(v);
+}
+export function isFloat(v) {
+  return isNumber(v) && !Number.isInteger(v);
+}
+export function isPositive(v) {
+  return isNumber(v) && v > 0;
+}
+export function isNegative(v) {
+  return isNumber(v) && v < 0;
+}
+export function isEven(v) {
+  return isNumber(v) && v % 2 === 0;
+}
+export function isOdd(v) {
+  return isNumber(v) && v % 2 !== 0;
+}
+export function isEvenOrOdd(v) {
+  return isNumber(v) && (v % 2 === 0 ? "even" : "odd");
+}
+export function isPositiveOrNegative(v) {
+  return isNumber(v) && (v > 0 ? "positive" : "negative");
+}
+export function isIntegerOrFloat(v) {
+  return isNumber(v) && (Number.isInteger(v) ? "integer" : "float");
+}

package/dist/throttle.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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: any) => void;

package/dist/throttle.mjs

@@ -0,0 +1,22 @@
+export function throttle(fn, wait = 300) {
+  let inThrottle;
+  let lastFn;
+  let lastTime;
+  return function() {
+    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/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/utils",
   "type": "module",
-  "version": "0.51.0",
-  "packageManager": "pnpm@7.26.3",
+  "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,42 +42,60 @@
     "dist",
     "README.md"
   ],
-  "engines": {
-    "node": ">=v18.14.0",
-    "pnpm": ">=7.26.3"
-  },
   "peerDependencies": {
-    "@vueuse/core": "^9.12.0",
-    "@vueuse/head": "^1.0.24",
-    "@vueuse/math": "^9.12.0",
-    "@vueuse/shared": "^9.12.0",
+    "@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",
+    "@stacksjs/arrays": "0.52.0",
+    "@stacksjs/cli": "0.52.0",
+    "@stacksjs/config": "0.52.0",
+    "@stacksjs/development": "0.52.0",
+    "@stacksjs/lint": "0.52.0",
+    "@stacksjs/path": "0.52.0",
+    "@stacksjs/storage": "0.52.0",
+    "@stacksjs/types": "0.52.0"
+  },
+  "dependencies": {
+    "@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.2",
-    "throttle-debounce": "^5.0.0",
-    "@stacksjs/arrays": "0.51.0",
-    "@stacksjs/cli": "0.51.0",
-    "@stacksjs/config": "0.51.0",
-    "@stacksjs/lint": "0.51.0",
-    "@stacksjs/path": "0.51.0",
-    "@stacksjs/storage": "0.51.0",
-    "@stacksjs/types": "0.51.0"
+    "perfect-debounce": "^1.0.0",
+    "rimraf": "^5.0.0",
+    "semver": "^7.5.1",
+    "yaml": "^2.2.2",
+    "@stacksjs/arrays": "0.52.0",
+    "@stacksjs/cli": "0.52.0",
+    "@stacksjs/config": "0.52.0",
+    "@stacksjs/lint": "0.52.0",
+    "@stacksjs/path": "0.52.0",
+    "@stacksjs/storage": "0.52.0",
+    "@stacksjs/types": "0.52.0"
   },
   "devDependencies": {
-    "@types/throttle-debounce": "^5.0.0",
-    "mkdist": "^1.1.0",
-    "typescript": "^4.9.5",
-    "@stacksjs/testing": "0.51.0"
+    "@stacksjs/development": "0.52.0"
   },
   "scripts": {
-    "build": "mkdist -d",
-    "dev": "mkdist -d",
+    "build": "unbuild",
+    "dev": "unbuild --stub",
     "typecheck": "tsc --noEmit"
   }
 }

package/dist/vendor.d.ts

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

package/dist/vendor.mjs

@@ -1 +0,0 @@
-export { throttle, debounce } from "throttle-debounce";