@stacksjs/utils 0.56.34 → 0.57.2

package/dist/base.d.ts

@@ -0,0 +1,3 @@
+export declare function toString(v: any): any;
+export declare function loop(times: number, callback: any): void;
+export declare function getTypeName(v: any): any;

package/dist/base.mjs

@@ -0,0 +1,12 @@
+export function toString(v) {
+  return Object.prototype.toString.call(v);
+}
+export function loop(times, callback) {
+  [...Array(times)].forEach((item, i) => callback(i));
+}
+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,28 @@
+import type { AppOptions, CacheOptions, CdnOptions, CronJobOptions, DatabaseOptions, DebugOptions, DnsOptions, EmailOptions, Events, GitOptions, HashingOptions, JobOptions, LibraryOptions, Model, NotificationOptions, PagesOption, PaymentOptions, QueueOptions, SearchEngineOptions, ServicesOptions, StorageOptions, UiOptions, UserCliOptions } from '@stacksjs/types';
+export { loadStacksConfig as config } from '@stacksjs/config';
+export declare function defineApp(config: Partial<AppOptions>): AppOptions;
+export declare function defineCache(config: Partial<CacheOptions>): CacheOptions;
+export declare function defineCdn(config: Partial<CdnOptions>): CdnOptions;
+export declare function defineCli(config: Partial<UserCliOptions>): UserCliOptions;
+export declare function defineCronJobsConfig(config: Partial<CronJobOptions>[]): CronJobOptions[];
+export declare function defineJobsConfig(config: Partial<JobOptions>[]): JobOptions[];
+export declare function defineDatabase(config: Partial<DatabaseOptions>): DatabaseOptions;
+export declare function defineDebugConfig(config: Partial<DebugOptions>): DebugOptions;
+export declare function defineDns(config: Partial<DnsOptions>): DnsOptions;
+export declare function defineEmailConfig(config: Partial<EmailOptions>): EmailOptions;
+export declare function defineEvents(config: Partial<Events>): Events;
+export declare function defineGit(config: Partial<GitOptions>): GitOptions;
+export declare function defineHashing(config: Partial<HashingOptions>): HashingOptions;
+export declare function defineLibrary(config: Partial<LibraryOptions>): LibraryOptions;
+export declare function defineModel(config: Partial<Model>): Model;
+export declare function defineNotification(config: Partial<NotificationOptions>): NotificationOptions;
+export declare function defineSms(config: Partial<NotificationOptions['sms']>): NotificationOptions;
+export declare function defineEmail(config: Partial<NotificationOptions['email']>): NotificationOptions;
+export declare function defineChat(config: Partial<NotificationOptions['chat']>): NotificationOptions;
+export declare function definePage(config: Partial<PagesOption>): PagesOption;
+export declare function definePayment(config: Partial<PaymentOptions>): PaymentOptions;
+export declare function defineQueue(config: Partial<QueueOptions>): QueueOptions;
+export declare function defineSearchEngine(config: Partial<SearchEngineOptions>): SearchEngineOptions;
+export declare function defineServices(config: Partial<ServicesOptions>): ServicesOptions;
+export declare function defineStorage(config: Partial<StorageOptions>): StorageOptions;
+export declare function defineUi(config: Partial<UiOptions>): UiOptions;

package/dist/config.mjs

@@ -0,0 +1,79 @@
+export { loadStacksConfig as config } from "@stacksjs/config";
+export function defineApp(config) {
+  return config;
+}
+export function defineCache(config) {
+  return config;
+}
+export function defineCdn(config) {
+  return config;
+}
+export function defineCli(config) {
+  return config;
+}
+export function defineCronJobsConfig(config) {
+  return config;
+}
+export function defineJobsConfig(config) {
+  return config;
+}
+export function defineDatabase(config) {
+  return config;
+}
+export function defineDebugConfig(config) {
+  return config;
+}
+export function defineDns(config) {
+  return config;
+}
+export function defineEmailConfig(config) {
+  return config;
+}
+export function defineEvents(config) {
+  return config;
+}
+export function defineGit(config) {
+  return config;
+}
+export function defineHashing(config) {
+  return config;
+}
+export function defineLibrary(config) {
+  return config;
+}
+export function defineModel(config) {
+  return config;
+}
+export function defineNotification(config) {
+  return config;
+}
+export function defineSms(config) {
+  return config;
+}
+export function defineEmail(config) {
+  return config;
+}
+export function defineChat(config) {
+  return config;
+}
+export function definePage(config) {
+  return config;
+}
+export function definePayment(config) {
+  return config;
+}
+export function defineQueue(config) {
+  return config;
+}
+export function defineSearchEngine(config) {
+  return config;
+}
+export function defineServices(config) {
+  return config;
+}
+export function defineStorage(config) {
+  return config;
+}
+export function defineUi(config) {
+  return config;
+}

package/dist/currency.d.ts

@@ -0,0 +1,3 @@
+export { add, allocate, compare, convert, equal, greaterThan, greaterThanOrEqual, hasSubUnits, isZero, lessThan, lessThanOrEqual, maximum, minimum, multiply, normalizeScale, dinero, dinero as money, subtract, toSnapshot, toUnits, toDecimal, trimScale, haveSameCurrency, haveSameAmount, dinero as currency, } from 'dinero.js';
+export { USD } from '@dinero.js/currencies';
+export type { Dinero, Currency } from 'dinero.js';

package/dist/currency.mjs

@@ -0,0 +1,28 @@
+export {
+  add,
+  allocate,
+  compare,
+  convert,
+  equal,
+  greaterThan,
+  greaterThanOrEqual,
+  hasSubUnits,
+  isZero,
+  lessThan,
+  lessThanOrEqual,
+  maximum,
+  minimum,
+  multiply,
+  normalizeScale,
+  dinero,
+  dinero as money,
+  subtract,
+  toSnapshot,
+  toUnits,
+  toDecimal,
+  trimScale,
+  haveSameCurrency,
+  haveSameAmount,
+  dinero as currency
+} from "dinero.js";
+export { USD } from "@dinero.js/currencies";

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/delete.d.ts

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

package/dist/delete.mjs

@@ -0,0 +1 @@
+export { rimraf, rimraf as del } from "rimraf";

package/dist/equal.d.ts

@@ -0,0 +1 @@
+export declare function isDeepEqual(value1: any, value2: any): boolean;

package/dist/equal.mjs

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

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

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

package/dist/guards.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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

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

@@ -0,0 +1,46 @@
+/// <reference types="node" />
+import type { AddressInfo } from 'node:net';
+import type { CliOptions, CommandResult, Manifest, NpmScript } from '@stacksjs/types';
+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 declare function isIpv6(address: AddressInfo): boolean;

package/dist/helpers.mjs

@@ -0,0 +1,92 @@
+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 * as 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 function isIpv6(address) {
+  return address.family === "IPv6" || address.family === 6;
+}