@pacem/pacem-foundation 1.0.0-bernoulli → 1.0.0-binet

package/dist/esm/rect.js

@@ -1,11 +1,18 @@
 /*!
- * @pacem/pacem-foundation v1.0.0-bernoulli (https://js.pacem.it)
+ * @pacem/pacem-foundation v1.0.0-binet (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */
 import { Matrix2D } from './matrix2d';
 import { parseAsNumericalArray, Point, Size } from "./geom";
+/** Rectangle-related utilities (parsing, transform computation, intersection, bounding box). */
 export class Rect {
+    /**
+     * Parses a string containing exactly four numbers into a {@link Rect}.
+     * @param rect String to parse (e.g. `"0 0 100 50"`, in `x y width height` order).
+     * @returns The parsed rect.
+     * @throws If `rect` does not contain exactly four numbers.
+     */
     static parse(rect) {
         let arr = parseAsNumericalArray(rect);
         if (arr && arr.length === 4) {
@@ -13,6 +20,10 @@ export class Rect {
         }
         throw new Error(`Cannot parse "${rect}" as a valid Rect.`);
     }
+    /**
+     * Type-guards a value as a valid {@link Rect} object.
+     * @param obj Value to check.
+     */
     static isRect(obj) {
         return Point.isPoint(obj) && Size.isSize(obj);
     }

package/dist/esm/strings.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-foundation v1.0.0-bernoulli (https://js.pacem.it)
+ * @pacem/pacem-foundation v1.0.0-binet (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */
@@ -145,6 +145,7 @@ function diffLines(a, b) {
     return diffInternal(aTokens, bTokens, dp, '\n');
 }
 //#endregion
+/** String manipulation utilities. */
 export class Strings {
     /** @deprecated Use String.prototype.padStart() instead. */
     static leftPad(v, targetLength, padChar) {
@@ -154,6 +155,14 @@ export class Strings {
         //    retval = padChar + retval;
         //return retval;
     }
+    /**
+     * Formats a template string, replacing `{0}`, `{1}`, ... placeholders with the corresponding arguments.
+     * Doubled braces (`{{`/`}}`) escape a placeholder.
+     * @param template Template string containing `{n}` placeholders.
+     * @param args Values to substitute into the placeholders, by index.
+     * @returns The formatted string.
+     * @throws If the template references an argument index that was not supplied.
+     */
     static format(template, ...args) {
         const array = Array.from(args);
         let retval = template;
@@ -169,6 +178,13 @@ export class Strings {
         }
         return retval;
     }
+    /**
+     * Computes a diff between two strings, using the Longest Common Subsequence algorithm.
+     * @param a First (original) string.
+     * @param b Second (modified) string.
+     * @param mode Diffing granularity: `'char'` (default), `'word'` or `'line'`.
+     * @returns Array of {@link DiffToken}s describing unchanged, removed and added chunks.
+     */
     static diff(a, b, mode = 'char') {
         switch (mode) {
             case 'line':
@@ -179,6 +195,12 @@ export class Strings {
                 return diffChars(a, b);
         }
     }
+    /**
+     * Computes the cryptographic hash of a string using the SubtleCrypto API.
+     * @param input String to hash.
+     * @param algo Hash algorithm to use (defaults to `SHA-256`).
+     * @returns A promise resolving with the hash, hex-encoded.
+     */
     static async hash(input, algo = 'SHA-256') {
         const hashBuffer = await crypto.subtle.digest(algo, new TextEncoder().encode(input));
         return Array.from(new Uint8Array(hashBuffer))

package/package.json

@@ -4,6 +4,7 @@
     "dist/browser/*.*",
     "dist/bundle/*.*",
     "dist/esm/*.*",
+    "dist/docs/*.*",
     "typings/*.*",
     "README.md",
     "LICENSE",
@@ -24,7 +25,7 @@
       "types": "./typings/index.d.ts"
     }
   },
-  "version": "1.0.0-bernoulli",
+  "version": "1.0.0-binet",
   "author": {
     "name": "Pacem",
     "url": "https://pacem.it"