@zinaid/utils 0.0.3 → 0.0.4

package/dist/index.d.ts

@@ -1,2 +1,3 @@
+export * from './optional-require';
 export * from './utils';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -1,46 +1,48 @@
-import { castableToArray as s, compareValues as t, entriesKeyValue as r, getAccessibleValues as a, isAccessibleData as o, isArray as l, isBoolean as b, isFalsy as n, isFiniteNumber as u, isFloat as c, isFunction as y, isInteger as m, isMap as p, isNegativeNumber as A, isNonPrimitive as N, isNull as S, isNumber as g, isObject as F, isObjectAny as v, isPositiveNumber as T, isPrimitive as f, isSet as j, isString as O, isStringable as P, isSymbol as V, isTruthy as d, isTruthyObject as h, isUndefined as k, isWeakMap as q, isWeakSet as w, looseEqual as z, lowerFirst as D, normalizeToArray as E, objectToString as J, resolveDefault as M, strictEqual as U, toArrayable as W, toJsonSerializable as x, toJsonable as B, toLower as I, toUpper as K, typeOf as L, upperFirst as C } from "./utils.js";
+import { optionalRequire as s } from "./optional-require.js";
+import { castableToArray as t, compareValues as o, entriesKeyValue as a, getAccessibleValues as l, isAccessibleData as n, isArray as b, isBoolean as u, isFalsy as c, isFiniteNumber as m, isFloat as p, isFunction as y, isInteger as A, isMap as N, isNegativeNumber as S, isNonPrimitive as g, isNull as F, isNumber as f, isObject as v, isObjectAny as T, isPositiveNumber as j, isPrimitive as O, isSet as q, isString as P, isStringable as V, isSymbol as d, isTruthy as h, isTruthyObject as k, isUndefined as w, isWeakMap as x, isWeakSet as z, looseEqual as D, lowerFirst as E, normalizeToArray as J, objectToString as M, resolveDefault as U, strictEqual as W, toArrayable as B, toJsonSerializable as I, toJsonable as K, toLower as L, toUpper as R, typeOf as C, upperFirst as G } from "./utils.js";
 export {
-  s as castableToArray,
-  t as compareValues,
-  r as entriesKeyValue,
-  a as getAccessibleValues,
-  o as isAccessibleData,
-  l as isArray,
-  b as isBoolean,
-  n as isFalsy,
-  u as isFiniteNumber,
-  c as isFloat,
+  t as castableToArray,
+  o as compareValues,
+  a as entriesKeyValue,
+  l as getAccessibleValues,
+  n as isAccessibleData,
+  b as isArray,
+  u as isBoolean,
+  c as isFalsy,
+  m as isFiniteNumber,
+  p as isFloat,
   y as isFunction,
-  m as isInteger,
-  p as isMap,
-  A as isNegativeNumber,
-  N as isNonPrimitive,
-  S as isNull,
-  g as isNumber,
-  F as isObject,
-  v as isObjectAny,
-  T as isPositiveNumber,
-  f as isPrimitive,
-  j as isSet,
-  O as isString,
-  P as isStringable,
-  V as isSymbol,
-  d as isTruthy,
-  h as isTruthyObject,
-  k as isUndefined,
-  q as isWeakMap,
-  w as isWeakSet,
-  z as looseEqual,
-  D as lowerFirst,
-  E as normalizeToArray,
-  J as objectToString,
-  M as resolveDefault,
-  U as strictEqual,
-  W as toArrayable,
-  x as toJsonSerializable,
-  B as toJsonable,
-  I as toLower,
-  K as toUpper,
-  L as typeOf,
-  C as upperFirst
+  A as isInteger,
+  N as isMap,
+  S as isNegativeNumber,
+  g as isNonPrimitive,
+  F as isNull,
+  f as isNumber,
+  v as isObject,
+  T as isObjectAny,
+  j as isPositiveNumber,
+  O as isPrimitive,
+  q as isSet,
+  P as isString,
+  V as isStringable,
+  d as isSymbol,
+  h as isTruthy,
+  k as isTruthyObject,
+  w as isUndefined,
+  x as isWeakMap,
+  z as isWeakSet,
+  D as looseEqual,
+  E as lowerFirst,
+  J as normalizeToArray,
+  M as objectToString,
+  s as optionalRequire,
+  U as resolveDefault,
+  W as strictEqual,
+  B as toArrayable,
+  I as toJsonSerializable,
+  K as toJsonable,
+  L as toLower,
+  R as toUpper,
+  C as typeOf,
+  G as upperFirst
 };

package/dist/optional-require.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Dynamically require a module in a way that works in both Node.js and bundled environments.
+ * The module name is passed as a variable to prevent static analysis by bundlers.
+ *
+ * @param moduleName - The name of the module to require
+ * @param errorMessage - Custom error message if module is not found
+ * @returns The required module
+ * @throws Error with helpful message if the module is not installed
+ *
+ * @example
+ * // Load an optional dependency at runtime
+ * const pluralize = optionalRequire<typeof import('pluralize')>(
+ *     'pluralize',
+ *     'The "pluralize" package is required. Please install it: npm install pluralize'
+ * );
+ */
+export declare function optionalRequire<T>(moduleName: string, errorMessage?: string): T;
+//# sourceMappingURL=optional-require.d.ts.map

package/dist/optional-require.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"optional-require.d.ts","sourceRoot":"","sources":["../src/optional-require.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAC7B,UAAU,EAAE,MAAM,EAClB,YAAY,CAAC,EAAE,MAAM,GACtB,CAAC,CAaH"}

package/dist/optional-require.js

@@ -0,0 +1,13 @@
+function n(r, t) {
+  try {
+    const e = r;
+    return require(e);
+  } catch {
+    throw new Error(
+      t ?? `The "${r}" package is required. Please install it: npm install ${r}`
+    );
+  }
+}
+export {
+  n as optionalRequire
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zinaid/utils",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "A set of utility functions for the @zinaid packages.",
   "type": "module",
   "main": "dist/index.js",
@@ -21,6 +21,10 @@
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
     },
+    "./optional-require": {
+      "import": "./dist/optional-require.js",
+      "types": "./dist/optional-require.d.ts"
+    },
     "./utils": {
       "import": "./dist/utils.js",
       "types": "./dist/utils.d.ts"