@ls-stack/utils 1.0.0 → 1.1.0

package/dist/arrayUtils.d.ts

@@ -24,7 +24,7 @@ type SortOrder = 'desc' | 'asc';
  *
  * Sort by `ascending` order by default
  *
- * Use `Infinity` as as wildcard to absulute max and min values
+ * Use `Infinity` as as wildcard to absolute max and min values
  *
  * @example
  * const items = [1, 3, 2, 4];
@@ -37,14 +37,15 @@ type SortOrder = 'desc' | 'asc';
  * // return a array to sort by multiple values
  * const sortedItems = sortBy(items, (item) => [item.a, item.b]);
  **/
-declare function sortBy<T>(arr: T[], sortByValue: (item: T) => (number | string)[] | number | string, { order }?: {
+declare function sortBy<T>(arr: T[], sortByValue: (item: T) => (number | string)[] | number | string, props?: {
     order?: SortOrder | SortOrder[];
-}): T[];
+} | SortOrder | SortOrder[]): T[];
 declare function arrayWithPrev<T>(array: T[]): [current: T, prev: T | null][];
 declare function arrayWithPrevAndIndex<T>(array: T[]): {
     item: T;
     prev: T | null;
     index: number;
 }[];
+declare function isInArray<T, const U extends T>(value: T, oneOf: readonly U[]): value is U;
 
-export { type FilterAndMapReturn, arrayWithPrev, arrayWithPrevAndIndex, filterAndMap, sortBy };
+export { type FilterAndMapReturn, arrayWithPrev, arrayWithPrevAndIndex, filterAndMap, isInArray, sortBy };

package/dist/arrayUtils.js

@@ -2,12 +2,14 @@ import {
   arrayWithPrev,
   arrayWithPrevAndIndex,
   filterAndMap,
+  isInArray,
   sortBy
-} from "./chunk-5SB253CL.js";
+} from "./chunk-W7X6NSGR.js";
 export {
   arrayWithPrev,
   arrayWithPrevAndIndex,
   filterAndMap,
+  isInArray,
   sortBy
 };
 //# sourceMappingURL=arrayUtils.js.map

package/dist/{chunk-5SB253CL.js → chunk-W7X6NSGR.js}

@@ -11,7 +11,8 @@ function filterAndMap(array, mapFilter) {
   }
   return result;
 }
-function sortBy(arr, sortByValue, { order = "asc" } = {}) {
+function sortBy(arr, sortByValue, props = "asc") {
+  const order = Array.isArray(props) || typeof props === "string" ? props : props.order ?? "asc";
   return [...arr].sort((a, b) => {
     const _aPriority = sortByValue(a);
     const _bPriority = sortByValue(b);
@@ -44,11 +45,20 @@ function arrayWithPrevAndIndex(array) {
     index: i
   }));
 }
+function isInArray(value, oneOf) {
+  for (let i = 0; i < oneOf.length; i++) {
+    if (oneOf[i] === value) {
+      return true;
+    }
+  }
+  return false;
+}
 
 export {
   filterAndMap,
   sortBy,
   arrayWithPrev,
-  arrayWithPrevAndIndex
+  arrayWithPrevAndIndex,
+  isInArray
 };
-//# sourceMappingURL=chunk-5SB253CL.js.map
+//# sourceMappingURL=chunk-W7X6NSGR.js.map

package/dist/chunk-W7X6NSGR.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/arrayUtils.ts"],"sourcesContent":["/**\n * allow to filter and map with better typing ergonomics\n *\n * In the `mapFilter` function return `false` to reject the item, or any other\n * value to map it.\n *\n * @example\n * // Filter reject and turn value into `value mapped`\n * const items = ['value', 'value', 'reject', 'reject'];\n *\n * const mappedItems = filterAndMap(items, (item) =>\n *   item === 'reject'\n *     ? false\n *     : `${item} mapped`,\n * );\n *\n * mappedItems; // ['value mapped', 'value mapped']\n */\nexport function filterAndMap<T, R>(\n  array: IterableIterator<T> | readonly T[],\n  mapFilter: (item: T, index: number) => false | R,\n): R[] {\n  const result: R[] = [];\n\n  let i = -1;\n  for (const item of array) {\n    i += 1;\n    const filterResult = mapFilter(item, i);\n\n    if (filterResult !== false) {\n      result.push(filterResult);\n    }\n  }\n\n  return result;\n}\n\nexport type FilterAndMapReturn<T> = false | T;\n\ntype SortOrder = 'desc' | 'asc';\n\n/**\n * Sort an array based on a value\n *\n * Sort by `ascending` order by default\n *\n * Use `Infinity` as as wildcard to absolute max and min values\n *\n * @example\n * const items = [1, 3, 2, 4];\n *\n * const sortedItems = sortBy(items, (item) => item);\n * // [1, 2, 3, 4]\n *\n * const items2 = [{ a: 1, b: 2 }, { a: 2, b: 1 }, { a: 1, b: 1}]\n *\n * // return a array to sort by multiple values\n * const sortedItems = sortBy(items, (item) => [item.a, item.b]);\n **/\nexport function sortBy<T>(\n  arr: T[],\n  sortByValue: (item: T) => (number | string)[] | number | string,\n  props: { order?: SortOrder | SortOrder[] } | SortOrder | SortOrder[] = 'asc',\n) {\n  const order =\n    Array.isArray(props) || typeof props === 'string' ?\n      props\n    : props.order ?? 'asc';\n\n  return [...arr].sort((a, b) => {\n    const _aPriority = sortByValue(a);\n    const _bPriority = sortByValue(b);\n\n    const aPriority = Array.isArray(_aPriority) ? _aPriority : [_aPriority];\n    const bPriority = Array.isArray(_bPriority) ? _bPriority : [_bPriority];\n\n    for (let i = 0; i < aPriority.length; i++) {\n      const levelOrder: SortOrder =\n        typeof order === 'string' ? order : order[i] ?? 'asc';\n\n      const aP = aPriority[i] ?? 0;\n      const bP = bPriority[i] ?? 0;\n\n      if (aP === bP) {\n        continue;\n      }\n\n      if (bP === Infinity || aP === -Infinity || aP < bP) {\n        return levelOrder === 'asc' ? -1 : 1;\n      }\n\n      if (aP === Infinity || bP === -Infinity || aP > bP) {\n        return levelOrder === 'asc' ? 1 : -1;\n      }\n    }\n\n    return 0;\n  });\n}\n\nexport function arrayWithPrev<T>(array: T[]): [current: T, prev: T | null][] {\n  return array.map((item, i) => [item, array[i - 1] ?? null]);\n}\n\nexport function arrayWithPrevAndIndex<T>(\n  array: T[],\n): { item: T; prev: T | null; index: number }[] {\n  return array.map((item, i) => ({\n    item,\n    prev: array[i - 1] ?? null,\n    index: i,\n  }));\n}\n\nexport function isInArray<T, const U extends T>(\n  value: T,\n  oneOf: readonly U[],\n): value is U {\n  for (let i = 0; i < oneOf.length; i++) {\n    if (oneOf[i] === value) {\n      return true;\n    }\n  }\n\n  return false;\n}\n"],"mappings":";AAkBO,SAAS,aACd,OACA,WACK;AACL,QAAM,SAAc,CAAC;AAErB,MAAI,IAAI;AACR,aAAW,QAAQ,OAAO;AACxB,SAAK;AACL,UAAM,eAAe,UAAU,MAAM,CAAC;AAEtC,QAAI,iBAAiB,OAAO;AAC1B,aAAO,KAAK,YAAY;AAAA,IAC1B;AAAA,EACF;AAEA,SAAO;AACT;AAwBO,SAAS,OACd,KACA,aACA,QAAuE,OACvE;AACA,QAAM,QACJ,MAAM,QAAQ,KAAK,KAAK,OAAO,UAAU,WACvC,QACA,MAAM,SAAS;AAEnB,SAAO,CAAC,GAAG,GAAG,EAAE,KAAK,CAAC,GAAG,MAAM;AAC7B,UAAM,aAAa,YAAY,CAAC;AAChC,UAAM,aAAa,YAAY,CAAC;AAEhC,UAAM,YAAY,MAAM,QAAQ,UAAU,IAAI,aAAa,CAAC,UAAU;AACtE,UAAM,YAAY,MAAM,QAAQ,UAAU,IAAI,aAAa,CAAC,UAAU;AAEtE,aAAS,IAAI,GAAG,IAAI,UAAU,QAAQ,KAAK;AACzC,YAAM,aACJ,OAAO,UAAU,WAAW,QAAQ,MAAM,CAAC,KAAK;AAElD,YAAM,KAAK,UAAU,CAAC,KAAK;AAC3B,YAAM,KAAK,UAAU,CAAC,KAAK;AAE3B,UAAI,OAAO,IAAI;AACb;AAAA,MACF;AAEA,UAAI,OAAO,YAAY,OAAO,aAAa,KAAK,IAAI;AAClD,eAAO,eAAe,QAAQ,KAAK;AAAA,MACrC;AAEA,UAAI,OAAO,YAAY,OAAO,aAAa,KAAK,IAAI;AAClD,eAAO,eAAe,QAAQ,IAAI;AAAA,MACpC;AAAA,IACF;AAEA,WAAO;AAAA,EACT,CAAC;AACH;AAEO,SAAS,cAAiB,OAA4C;AAC3E,SAAO,MAAM,IAAI,CAAC,MAAM,MAAM,CAAC,MAAM,MAAM,IAAI,CAAC,KAAK,IAAI,CAAC;AAC5D;AAEO,SAAS,sBACd,OAC8C;AAC9C,SAAO,MAAM,IAAI,CAAC,MAAM,OAAO;AAAA,IAC7B;AAAA,IACA,MAAM,MAAM,IAAI,CAAC,KAAK;AAAA,IACtB,OAAO;AAAA,EACT,EAAE;AACJ;AAEO,SAAS,UACd,OACA,OACY;AACZ,WAAS,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK;AACrC,QAAI,MAAM,CAAC,MAAM,OAAO;AACtB,aAAO;AAAA,IACT;AAAA,EACF;AAEA,SAAO;AACT;","names":[]}

package/dist/testUtils.js

@@ -8,7 +8,7 @@ import {
 import {
   arrayWithPrevAndIndex,
   filterAndMap
-} from "./chunk-5SB253CL.js";
+} from "./chunk-W7X6NSGR.js";
 import {
   isObject
 } from "./chunk-JT3EBBCA.js";

package/dist/typingFnUtils.d.ts

@@ -1,5 +1,15 @@
 import { NonPartial } from './typingUtils.js';
 
 declare function asNonPartial<T extends Record<string, unknown>>(obj: T): NonPartial<T>;
+/** a wrapper to Object.entries with a better typing inference */
+declare function typedObjectEntries<T extends Record<string, unknown>>(obj: T): NonNullable<{
+    [K in keyof T]: [K, T[K]];
+}[keyof T]>[];
+/** a wrapper to Object.keys with a better typing inference */
+declare function typedObjectKeys<T extends Record<string, unknown>>(obj: T): (keyof T)[];
+/** a safe way to cast types, use to substitute the `as Type` */
+declare function asType<T = unknown>(value: T): T;
+/** narrow a string to a union of strings */
+declare function narrowStringToUnion<const T extends string>(key: string | undefined | null, union: T[]): T | undefined;
 
-export { asNonPartial };
+export { asNonPartial, asType, narrowStringToUnion, typedObjectEntries, typedObjectKeys };

package/dist/typingFnUtils.js

@@ -2,7 +2,26 @@
 function asNonPartial(obj) {
   return obj;
 }
+function typedObjectEntries(obj) {
+  return Object.entries(obj);
+}
+function typedObjectKeys(obj) {
+  return Object.keys(obj);
+}
+function asType(value) {
+  return value;
+}
+function narrowStringToUnion(key, union) {
+  if (key && union.includes(key)) {
+    return key;
+  }
+  return void 0;
+}
 export {
-  asNonPartial
+  asNonPartial,
+  asType,
+  narrowStringToUnion,
+  typedObjectEntries,
+  typedObjectKeys
 };
 //# sourceMappingURL=typingFnUtils.js.map

package/dist/typingFnUtils.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/typingFnUtils.ts"],"sourcesContent":["import { NonPartial } from './typingUtils';\n\nexport function asNonPartial<T extends Record<string, unknown>>(\n  obj: T,\n): NonPartial<T> {\n  return obj;\n}\n"],"mappings":";AAEO,SAAS,aACd,KACe;AACf,SAAO;AACT;","names":[]}
+{"version":3,"sources":["../src/typingFnUtils.ts"],"sourcesContent":["import { NonPartial } from './typingUtils';\n\nexport function asNonPartial<T extends Record<string, unknown>>(\n  obj: T,\n): NonPartial<T> {\n  return obj;\n}\n\n/** a wrapper to Object.entries with a better typing inference */\nexport function typedObjectEntries<T extends Record<string, unknown>>(\n  obj: T,\n): NonNullable<\n  {\n    [K in keyof T]: [K, T[K]];\n  }[keyof T]\n>[] {\n  return Object.entries(obj) as any;\n}\n\n/** a wrapper to Object.keys with a better typing inference */\nexport function typedObjectKeys<T extends Record<string, unknown>>(\n  obj: T,\n): (keyof T)[] {\n  return Object.keys(obj) as any;\n}\n\n/** a safe way to cast types, use to substitute the `as Type` */\nexport function asType<T = unknown>(value: T): T {\n  return value;\n}\n\n/** narrow a string to a union of strings */\nexport function narrowStringToUnion<const T extends string>(\n  key: string | undefined | null,\n  union: T[],\n): T | undefined {\n  if (key && union.includes(key as T)) {\n    return key as T;\n  }\n\n  return undefined;\n}\n"],"mappings":";AAEO,SAAS,aACd,KACe;AACf,SAAO;AACT;AAGO,SAAS,mBACd,KAKE;AACF,SAAO,OAAO,QAAQ,GAAG;AAC3B;AAGO,SAAS,gBACd,KACa;AACb,SAAO,OAAO,KAAK,GAAG;AACxB;AAGO,SAAS,OAAoB,OAAa;AAC/C,SAAO;AACT;AAGO,SAAS,oBACd,KACA,OACe;AACf,MAAI,OAAO,MAAM,SAAS,GAAQ,GAAG;AACnC,WAAO;AAAA,EACT;AAEA,SAAO;AACT;","names":[]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ls-stack/utils",
   "description": "Typescript utils",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "license": "MIT",
   "files": [
     "dist"

package/dist/chunk-5SB253CL.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/arrayUtils.ts"],"sourcesContent":["/**\n * allow to filter and map with better typing ergonomics\n *\n * In the `mapFilter` function return `false` to reject the item, or any other\n * value to map it.\n *\n * @example\n * // Filter reject and turn value into `value mapped`\n * const items = ['value', 'value', 'reject', 'reject'];\n *\n * const mappedItems = filterAndMap(items, (item) =>\n *   item === 'reject'\n *     ? false\n *     : `${item} mapped`,\n * );\n *\n * mappedItems; // ['value mapped', 'value mapped']\n */\nexport function filterAndMap<T, R>(\n  array: IterableIterator<T> | readonly T[],\n  mapFilter: (item: T, index: number) => false | R,\n): R[] {\n  const result: R[] = [];\n\n  let i = -1;\n  for (const item of array) {\n    i += 1;\n    const filterResult = mapFilter(item, i);\n\n    if (filterResult !== false) {\n      result.push(filterResult);\n    }\n  }\n\n  return result;\n}\n\nexport type FilterAndMapReturn<T> = false | T;\n\ntype SortOrder = 'desc' | 'asc';\n\n/**\n * Sort an array based on a value\n *\n * Sort by `ascending` order by default\n *\n * Use `Infinity` as as wildcard to absulute max and min values\n *\n * @example\n * const items = [1, 3, 2, 4];\n *\n * const sortedItems = sortBy(items, (item) => item);\n * // [1, 2, 3, 4]\n *\n * const items2 = [{ a: 1, b: 2 }, { a: 2, b: 1 }, { a: 1, b: 1}]\n *\n * // return a array to sort by multiple values\n * const sortedItems = sortBy(items, (item) => [item.a, item.b]);\n **/\nexport function sortBy<T>(\n  arr: T[],\n  sortByValue: (item: T) => (number | string)[] | number | string,\n  { order = 'asc' }: { order?: SortOrder | SortOrder[] } = {},\n) {\n  return [...arr].sort((a, b) => {\n    const _aPriority = sortByValue(a);\n    const _bPriority = sortByValue(b);\n\n    const aPriority = Array.isArray(_aPriority) ? _aPriority : [_aPriority];\n    const bPriority = Array.isArray(_bPriority) ? _bPriority : [_bPriority];\n\n    for (let i = 0; i < aPriority.length; i++) {\n      const levelOrder: SortOrder =\n        typeof order === 'string' ? order : order[i] ?? 'asc';\n\n      const aP = aPriority[i] ?? 0;\n      const bP = bPriority[i] ?? 0;\n\n      if (aP === bP) {\n        continue;\n      }\n\n      if (bP === Infinity || aP === -Infinity || aP < bP) {\n        return levelOrder === 'asc' ? -1 : 1;\n      }\n\n      if (aP === Infinity || bP === -Infinity || aP > bP) {\n        return levelOrder === 'asc' ? 1 : -1;\n      }\n    }\n\n    return 0;\n  });\n}\n\nexport function arrayWithPrev<T>(array: T[]): [current: T, prev: T | null][] {\n  return array.map((item, i) => [item, array[i - 1] ?? null]);\n}\n\nexport function arrayWithPrevAndIndex<T>(\n  array: T[],\n): { item: T; prev: T | null; index: number }[] {\n  return array.map((item, i) => ({\n    item,\n    prev: array[i - 1] ?? null,\n    index: i,\n  }));\n}\n"],"mappings":";AAkBO,SAAS,aACd,OACA,WACK;AACL,QAAM,SAAc,CAAC;AAErB,MAAI,IAAI;AACR,aAAW,QAAQ,OAAO;AACxB,SAAK;AACL,UAAM,eAAe,UAAU,MAAM,CAAC;AAEtC,QAAI,iBAAiB,OAAO;AAC1B,aAAO,KAAK,YAAY;AAAA,IAC1B;AAAA,EACF;AAEA,SAAO;AACT;AAwBO,SAAS,OACd,KACA,aACA,EAAE,QAAQ,MAAM,IAAyC,CAAC,GAC1D;AACA,SAAO,CAAC,GAAG,GAAG,EAAE,KAAK,CAAC,GAAG,MAAM;AAC7B,UAAM,aAAa,YAAY,CAAC;AAChC,UAAM,aAAa,YAAY,CAAC;AAEhC,UAAM,YAAY,MAAM,QAAQ,UAAU,IAAI,aAAa,CAAC,UAAU;AACtE,UAAM,YAAY,MAAM,QAAQ,UAAU,IAAI,aAAa,CAAC,UAAU;AAEtE,aAAS,IAAI,GAAG,IAAI,UAAU,QAAQ,KAAK;AACzC,YAAM,aACJ,OAAO,UAAU,WAAW,QAAQ,MAAM,CAAC,KAAK;AAElD,YAAM,KAAK,UAAU,CAAC,KAAK;AAC3B,YAAM,KAAK,UAAU,CAAC,KAAK;AAE3B,UAAI,OAAO,IAAI;AACb;AAAA,MACF;AAEA,UAAI,OAAO,YAAY,OAAO,aAAa,KAAK,IAAI;AAClD,eAAO,eAAe,QAAQ,KAAK;AAAA,MACrC;AAEA,UAAI,OAAO,YAAY,OAAO,aAAa,KAAK,IAAI;AAClD,eAAO,eAAe,QAAQ,IAAI;AAAA,MACpC;AAAA,IACF;AAEA,WAAO;AAAA,EACT,CAAC;AACH;AAEO,SAAS,cAAiB,OAA4C;AAC3E,SAAO,MAAM,IAAI,CAAC,MAAM,MAAM,CAAC,MAAM,MAAM,IAAI,CAAC,KAAK,IAAI,CAAC;AAC5D;AAEO,SAAS,sBACd,OAC8C;AAC9C,SAAO,MAAM,IAAI,CAAC,MAAM,OAAO;AAAA,IAC7B;AAAA,IACA,MAAM,MAAM,IAAI,CAAC,KAAK;AAAA,IACtB,OAAO;AAAA,EACT,EAAE;AACJ;","names":[]}