@ntnyq/utils 0.4.1 → 0.4.3

package/dist/index.cjs

@@ -18,8 +18,8 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   NOOP: () => NOOP,
   at: () => at,
   cAF: () => cAF,
@@ -38,6 +38,7 @@ __export(src_exports, {
   getObjectType: () => getObjectType,
   hasOwn: () => hasOwn,
   hours: () => hours,
+  interopDefault: () => interopDefault,
   isArray: () => isArray,
   isArrayEqual: () => isArrayEqual,
   isBoolean: () => isBoolean,
@@ -77,6 +78,7 @@ __export(src_exports, {
   pascalCase: () => pascalCase,
   pick: () => pick,
   rAF: () => rAF,
+  resolveSubOptions: () => resolveSubOptions,
   seconds: () => seconds,
   slash: () => slash,
   snakeCase: () => snakeCase,
@@ -94,7 +96,7 @@ __export(src_exports, {
   warnOnce: () => warnOnce,
   weeks: () => weeks
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/is/isDeepEqual.ts
 function isDeepEqual(value1, value2) {
@@ -614,6 +616,17 @@ function titleCase(str, opts) {
 
 // src/vendor/scule.ts
 var capitalize = upperFirst;
+
+// src/module/interopDefault.ts
+async function interopDefault(mod) {
+  const resolved = await mod;
+  return resolved.default || resolved;
+}
+
+// src/module/resolveSubOptions.ts
+function resolveSubOptions(options, key) {
+  return typeof options[key] === "boolean" ? {} : options[key] || {};
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   NOOP,
@@ -634,6 +647,7 @@ var capitalize = upperFirst;
   getObjectType,
   hasOwn,
   hours,
+  interopDefault,
   isArray,
   isArrayEqual,
   isBoolean,
@@ -673,6 +687,7 @@ var capitalize = upperFirst;
   pascalCase,
   pick,
   rAF,
+  resolveSubOptions,
   seconds,
   slash,
   snakeCase,

package/dist/index.d.cts

@@ -174,6 +174,18 @@ declare function unique<T>(array: T[]): T[];
  */
 declare function uniqueBy<T>(array: T[], equalFn: (a: T, b: T) => boolean): T[];
 
+type JsonArray = JsonValue[] | readonly JsonValue[];
+type JsonObject = {
+    [Key in string]: JsonValue;
+} & {
+    [Key in string]?: JsonValue | undefined;
+};
+type JsonPrimitive = boolean | number | string | null;
+/**
+ * @copyright {@link https://github.com/sindresorhus/type-fest/blob/main/source/basic.d.ts}
+ */
+type JsonValue = JsonArray | JsonObject | JsonPrimitive;
+
 /**
  * interop module
  */
@@ -184,6 +196,7 @@ type InteropModuleDefault<T> = T extends {
 type AnyFn<T = any, R = any> = (...args: T[]) => R;
 type Arrayable<T> = T | T[];
 type Awaitable<T> = Promise<T> | T;
+type Callable<T> = AnyFn<any, T> | T;
 type MayBe<T> = T | undefined;
 type Nullable<T> = T | null;
 type PrimitiveType = bigint | boolean | number | string | symbol | null | undefined;
@@ -362,4 +375,49 @@ declare function sortObject<T extends Record<string, any>>(obj: T, options?: Sor
  */
 declare const capitalize: typeof upperFirst;
 
-export { type AnyFn, type Arrayable, type Awaitable, type CleanObjectOptions, type InteropModuleDefault, type MayBe, NOOP, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, capitalize, chunk, clamp, cleanObject, days, debounce, ensurePrefix, ensureSuffix, escapeHtml, flattenArrayable, getObjectType, hasOwn, hours, isArray, isArrayEqual, isBoolean, isBrowser, isDeepEqual, isEmptyArray, isEmptyObject, isEmptyString, isEmptyStringOrWhitespace, isFunction, isInteger, isNaN, isNativePromise, isNil, isNonEmptyString, isNull, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+/**
+ * Interop default export from a module
+ *
+ * @param mod - The module
+ * @returns The default export
+ *
+ * @example
+ *
+ * ```ts
+ * import { interopDefault } from '@ntnyq/utils'
+ *
+ * const { unindent } = await interopDefault(import('@ntnyq/utils'))
+ * ```
+ */
+declare function interopDefault<T>(mod: Awaitable<T>): Promise<InteropModuleDefault<T>>;
+
+/**
+ * Resolve sub options `boolean | Options` to `Options`
+ * @param options - core options
+ * @param key - sub options key
+ * @returns resolved sub options
+ *
+ * @example
+ *
+ * ```ts
+ * import { resolveSubOptions } from '@ntnyq/utils'
+ *
+ * interface Options {
+ *   compile?: boolean | {
+ *     include?: string[]
+ *     exclude?: string[]
+ *   }
+ * }
+ *
+ * const options: Options = {
+ *   compile: true
+ * }
+ *
+ * console.log(resolveSubOptions(options, 'compile'))
+ *
+ * // => {}
+ * ```
+ */
+declare function resolveSubOptions<T extends Record<string, any>, K extends keyof T>(options: T, key: K): Partial<ResolvedOptions<T[K]>>;
+
+export { type AnyFn, type Arrayable, type Awaitable, type Callable, type CleanObjectOptions, type InteropModuleDefault, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type MayBe, NOOP, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, capitalize, chunk, clamp, cleanObject, days, debounce, ensurePrefix, ensureSuffix, escapeHtml, flattenArrayable, getObjectType, hasOwn, hours, interopDefault, isArray, isArrayEqual, isBoolean, isBrowser, isDeepEqual, isEmptyArray, isEmptyObject, isEmptyString, isEmptyStringOrWhitespace, isFunction, isInteger, isNaN, isNativePromise, isNil, isNonEmptyString, isNull, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, resolveSubOptions, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.d.ts

@@ -174,6 +174,18 @@ declare function unique<T>(array: T[]): T[];
  */
 declare function uniqueBy<T>(array: T[], equalFn: (a: T, b: T) => boolean): T[];
 
+type JsonArray = JsonValue[] | readonly JsonValue[];
+type JsonObject = {
+    [Key in string]: JsonValue;
+} & {
+    [Key in string]?: JsonValue | undefined;
+};
+type JsonPrimitive = boolean | number | string | null;
+/**
+ * @copyright {@link https://github.com/sindresorhus/type-fest/blob/main/source/basic.d.ts}
+ */
+type JsonValue = JsonArray | JsonObject | JsonPrimitive;
+
 /**
  * interop module
  */
@@ -184,6 +196,7 @@ type InteropModuleDefault<T> = T extends {
 type AnyFn<T = any, R = any> = (...args: T[]) => R;
 type Arrayable<T> = T | T[];
 type Awaitable<T> = Promise<T> | T;
+type Callable<T> = AnyFn<any, T> | T;
 type MayBe<T> = T | undefined;
 type Nullable<T> = T | null;
 type PrimitiveType = bigint | boolean | number | string | symbol | null | undefined;
@@ -362,4 +375,49 @@ declare function sortObject<T extends Record<string, any>>(obj: T, options?: Sor
  */
 declare const capitalize: typeof upperFirst;
 
-export { type AnyFn, type Arrayable, type Awaitable, type CleanObjectOptions, type InteropModuleDefault, type MayBe, NOOP, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, capitalize, chunk, clamp, cleanObject, days, debounce, ensurePrefix, ensureSuffix, escapeHtml, flattenArrayable, getObjectType, hasOwn, hours, isArray, isArrayEqual, isBoolean, isBrowser, isDeepEqual, isEmptyArray, isEmptyObject, isEmptyString, isEmptyStringOrWhitespace, isFunction, isInteger, isNaN, isNativePromise, isNil, isNonEmptyString, isNull, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+/**
+ * Interop default export from a module
+ *
+ * @param mod - The module
+ * @returns The default export
+ *
+ * @example
+ *
+ * ```ts
+ * import { interopDefault } from '@ntnyq/utils'
+ *
+ * const { unindent } = await interopDefault(import('@ntnyq/utils'))
+ * ```
+ */
+declare function interopDefault<T>(mod: Awaitable<T>): Promise<InteropModuleDefault<T>>;
+
+/**
+ * Resolve sub options `boolean | Options` to `Options`
+ * @param options - core options
+ * @param key - sub options key
+ * @returns resolved sub options
+ *
+ * @example
+ *
+ * ```ts
+ * import { resolveSubOptions } from '@ntnyq/utils'
+ *
+ * interface Options {
+ *   compile?: boolean | {
+ *     include?: string[]
+ *     exclude?: string[]
+ *   }
+ * }
+ *
+ * const options: Options = {
+ *   compile: true
+ * }
+ *
+ * console.log(resolveSubOptions(options, 'compile'))
+ *
+ * // => {}
+ * ```
+ */
+declare function resolveSubOptions<T extends Record<string, any>, K extends keyof T>(options: T, key: K): Partial<ResolvedOptions<T[K]>>;
+
+export { type AnyFn, type Arrayable, type Awaitable, type Callable, type CleanObjectOptions, type InteropModuleDefault, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type MayBe, NOOP, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, capitalize, chunk, clamp, cleanObject, days, debounce, ensurePrefix, ensureSuffix, escapeHtml, flattenArrayable, getObjectType, hasOwn, hours, interopDefault, isArray, isArrayEqual, isBoolean, isBrowser, isDeepEqual, isEmptyArray, isEmptyObject, isEmptyString, isEmptyStringOrWhitespace, isFunction, isInteger, isNaN, isNativePromise, isNil, isNonEmptyString, isNull, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, resolveSubOptions, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.js

@@ -516,6 +516,17 @@ function titleCase(str, opts) {
 
 // src/vendor/scule.ts
 var capitalize = upperFirst;
+
+// src/module/interopDefault.ts
+async function interopDefault(mod) {
+  const resolved = await mod;
+  return resolved.default || resolved;
+}
+
+// src/module/resolveSubOptions.ts
+function resolveSubOptions(options, key) {
+  return typeof options[key] === "boolean" ? {} : options[key] || {};
+}
 export {
   NOOP,
   at,
@@ -535,6 +546,7 @@ export {
   getObjectType,
   hasOwn,
   hours,
+  interopDefault,
   isArray,
   isArrayEqual,
   isBoolean,
@@ -574,6 +586,7 @@ export {
   pascalCase,
   pick,
   rAF,
+  resolveSubOptions,
   seconds,
   slash,
   snakeCase,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ntnyq/utils",
   "type": "module",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "Common used utils.",
   "keywords": [
     "utils"
@@ -40,18 +40,18 @@
     "scule": "^1.3.0"
   },
   "devDependencies": {
-    "@ntnyq/eslint-config": "^3.8.1",
+    "@ntnyq/eslint-config": "^3.10.4",
     "@ntnyq/prettier-config": "^1.22.0",
-    "@vitest/coverage-v8": "^2.1.8",
-    "bumpp": "^9.8.1",
-    "eslint": "^9.16.0",
+    "@vitest/coverage-v8": "^3.0.0-beta.3",
+    "bumpp": "^9.9.2",
+    "eslint": "^9.17.0",
     "husky": "^9.1.7",
     "nano-staged": "^0.8.0",
-    "npm-run-all2": "^7.0.1",
+    "npm-run-all2": "^7.0.2",
     "prettier": "^3.4.2",
     "tsup": "^8.3.5",
     "typescript": "^5.7.2",
-    "vitest": "^2.1.8"
+    "vitest": "^3.0.0-beta.3"
   },
   "engines": {
     "node": ">=18.18.0"