libmodulor 0.4.0 → 0.5.0

package/dist/esm/utils/types/funcs.js

@@ -1,15 +1,36 @@
 import { IllegalArgumentError } from '../../error/index.js';
+/**
+ * Assert that the value is defined
+ * @param value
+ * @param key
+ * @see isBlank
+ */
 export function assertIsDefined(value, key) {
     if (isBlank(value)) {
         throw new IllegalArgumentError(`${key} is required`);
     }
 }
+/**
+ * Checker whether the value is blank or not
+ *
+ * Blank means `undefined`, `null`, `''` (if string), `[]` (if array).
+ *
+ * This is insipred by Ruby's `blank?` method.
+ *
+ * @param value
+ * @returns
+ */
 export function isBlank(value) {
     return (value === undefined ||
         value === null ||
         (typeof value === 'string' && value.trim().length === 0) ||
         (Array.isArray(value) && value.length === 0));
 }
+/**
+ * Get an array filled with `[0 .. n-1]`
+ * @param n
+ * @returns
+ */
 export function range(n) {
     const items = [];
     for (let i = 0; i < n; i++) {
@@ -17,12 +38,26 @@ export function range(n) {
     }
     return items;
 }
+/**
+ * Get a random item from the array
+ *
+ * Although the name is inspired by Ruby's, the signature and implementation is not exactly the same (for now).
+ *
+ * @param items
+ * @returns
+ */
 export function sample(items) {
     if (items.length === 0) {
         return null;
     }
     return items[Math.floor(Math.random() * items.length)] ?? null;
 }
+/**
+ * Get an array of size `n` filled with `val`
+ * @param val
+ * @param n
+ * @returns
+ */
 export function tupleOf(val, n) {
     const items = [];
     for (let i = 0; i < n; i++) {

package/dist/esm/utils/types/utility-types.d.ts

@@ -1,5 +1,22 @@
+/**
+ * Extract a subset of a union type in a strict manner
+ *
+ * @example
+ *
+ * ```
+ * type Color = 'red' | 'orange' | 'green';
+ * type PassColor = Extract<Color, 'green' | 'toto'>; // Does not trigger any error
+ * type PassColor = ExtractStrict<Color, 'green' | 'toto'>; // Type '"green" | "toto"' does not satisfy the constraint 'Color'. Type '"toto"' is not assignable to type 'Color'.
+ * ```
+ */
 export type ExtractStrict<T, U extends T> = Extract<T, U>;
+/**
+ * Get a type corresponding to T with all the properties `NonNullable`, recursively
+ */
 export type RecursiveNonNullable<T> = {
     [K in keyof T]-?: RecursiveNonNullable<NonNullable<T[K]>>;
 };
+/**
+ * Extract the string keys of T
+ */
 export type StringKeys<T extends object> = Extract<keyof T, string>;

package/dist/esm/utils/types/utility-types.js

@@ -1 +1,2 @@
+// Some Utility Types that are not provided by TypeScript out of the box
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "libmodulor",
     "description": "An opinionated TypeScript library to create business oriented applications",
-    "version": "0.4.0",
+    "version": "0.5.0",
     "license": "LGPL-3.0",
     "author": "Chafik H'nini <chafik.hnini@gmail.com>",
     "homepage": "https://github.com/c100k/libmodulor#readme",
@@ -57,8 +57,8 @@
         }
     },
     "peerDependencies": {
-        "@hono/node-server": "^1.13.7",
-        "@modelcontextprotocol/sdk": "^1.4.1",
+        "@hono/node-server": "^1.13.8",
+        "@modelcontextprotocol/sdk": "^1.5.0",
         "@stricli/core": "^1.1.1",
         "buffer": "^6.0.3",
         "cookie-parser": "^1.4.7",
@@ -66,18 +66,18 @@
         "express-fileupload": "^1.5.1",
         "fast-check": "^3.23.2",
         "helmet": "^8.0.0",
-        "hono": "^4.6.19",
-        "inversify": "^6.2.1",
-        "jose": "^5.9.6",
+        "hono": "^4.7.2",
+        "inversify": "^6.2.2",
+        "jose": "^6.0.6",
         "knex": "^3.1.0",
-        "pg": "^8.13.1",
+        "pg": "^8.13.3",
         "react": "^18.3.1",
         "react-dom": "^18.3.1",
-        "react-native": "^0.76.6",
+        "react-native": "^0.78.0",
         "reflect-metadata": "^0.2.2",
         "sqlite3": "^5.1.7",
         "typescript": "^5.7.3",
-        "vite": "^6.0.11"
+        "vite": "^6.1.1"
     },
     "peerDependenciesMeta": {
         "@hono/node-server": {