@jangaba/qube 1.0.0 → 1.0.1

package/index.d.ts

@@ -1,25 +1,25 @@
 export interface CubeResult {
-  /** Dlzka hrany */
+  /** Edge length */
   edge: number;
-  /** Uhlopriecka steny (podstavy): a√2 */
+  /** Face diagonal: a√2 */
   faceDiagonal: number;
-  /** Telesova uhlopriecka: a√3 */
+  /** Space diagonal: a√3 */
   spaceDiagonal: number;
-  /** Povrch kocky: 6a² */
+  /** Surface area: 6a² */
   surfaceArea: number;
-  /** Objem kocky: a³ */
+  /** Volume: a³ */
   volume: number;
-  /** Obsah jednej steny: a² */
+  /** Face area: a² */
   faceArea: number;
-  /** Obvod jednej steny: 4a */
+  /** Face perimeter: 4a */
   perimeter: number;
-  /** Sucet dlzok vsetkych hran: 12a */
+  /** Total edge length: 12a */
   totalEdgeLength: number;
-  /** Polomer opisanej gule: (a√3)/2 */
+  /** Circumscribed sphere radius: (a√3)/2 */
   circumRadius: number;
-  /** Polomer vpisanej gule: a/2 */
+  /** Inscribed sphere radius: a/2 */
   inRadius: number;
-  /** Polomer strednej gule (dotyka sa hran): (a√2)/2 */
+  /** Midsphere radius (touches edges): (a√2)/2 */
   midRadius: number;
 }
 
@@ -28,7 +28,7 @@ export type CubeInput = { [K in keyof CubeResult]?: number } & {
 };
 
 /**
- * Vypocita vsetky parametre kocky zo zadaneho jedneho parametra.
+ * Compute all cube parameters from any single one.
  *
  * @example
  * cube({ edge: 5 })
@@ -38,11 +38,11 @@ export type CubeInput = { [K in keyof CubeResult]?: number } & {
 export function cube(input: Partial<CubeResult>): CubeResult;
 
 /**
- * Vypise vsetky parametre kocky do konzoly a vrati vysledok.
+ * Print all cube parameters to the console and return the result.
  */
 export function printCube(input: Partial<CubeResult>): CubeResult;
 
-/** Popisy parametrov v slovencine. */
+/** Human-readable parameter descriptions. */
 export const descriptions: Record<keyof CubeResult, string>;
 
 export default cube;

package/index.js

@@ -1,20 +1,20 @@
 /**
  * Cube Calculator
  *
- * Vypocita vsetky parametre kocky zo zadaneho jedneho parametra.
+ * Compute all cube parameters from any single one.
  *
- * Parametre kocky:
- *   a              - dlzka hrany
- *   faceDiagonal   - uhlopriecka podstavy (steny): a√2
- *   spaceDiagonal  - telesova uhlopriecka: a√3
- *   surfaceArea    - povrch kocky: 6a²
- *   volume         - objem kocky: a³
- *   faceArea       - obsah jednej steny: a²
- *   perimeter      - obvod jednej steny: 4a
- *   totalEdgeLength - sucet dlzok vsetkych hran: 12a
- *   circumRadius   - polomer opisanej gule: (a√3)/2
- *   inRadius       - polomer vpisanej gule: a/2
- *   midRadius      - polomer strednej gule (dotyka sa hran): (a√2)/2
+ * Parameters:
+ *   edge            - edge length
+ *   faceDiagonal    - face diagonal: a√2
+ *   spaceDiagonal   - space diagonal: a√3
+ *   surfaceArea     - surface area: 6a²
+ *   volume          - volume: a³
+ *   faceArea        - face area: a²
+ *   perimeter       - face perimeter: 4a
+ *   totalEdgeLength - total edge length: 12a
+ *   circumRadius    - circumscribed sphere radius: (a√3)/2
+ *   inRadius        - inscribed sphere radius: a/2
+ *   midRadius       - midsphere radius (touches edges): (a√2)/2
  */
 
 const SQRT2 = Math.sqrt(2);
@@ -51,17 +51,17 @@ const paramToEdge = {
 };
 
 const descriptions = {
-  edge: "Dlzka hrany",
-  faceDiagonal: "Uhlopriecka steny (podstavy)",
-  spaceDiagonal: "Telesova uhlopriecka",
-  surfaceArea: "Povrch kocky",
-  volume: "Objem kocky",
-  faceArea: "Obsah jednej steny",
-  perimeter: "Obvod jednej steny",
-  totalEdgeLength: "Sucet dlzok vsetkych hran",
-  circumRadius: "Polomer opisanej gule",
-  inRadius: "Polomer vpisanej gule",
-  midRadius: "Polomer strednej gule",
+  edge: "Edge length",
+  faceDiagonal: "Face diagonal",
+  spaceDiagonal: "Space diagonal",
+  surfaceArea: "Surface area",
+  volume: "Volume",
+  faceArea: "Face area",
+  perimeter: "Face perimeter",
+  totalEdgeLength: "Total edge length",
+  circumRadius: "Circumscribed sphere radius",
+  inRadius: "Inscribed sphere radius",
+  midRadius: "Midsphere radius",
 };
 
 function cube(input) {
@@ -69,18 +69,18 @@ function cube(input) {
 
   if (keys.length === 0) {
     throw new Error(
-      `Neznamy parameter. Povolene: ${Object.keys(paramToEdge).join(", ")}`
+      `Unknown parameter. Allowed: ${Object.keys(paramToEdge).join(", ")}`
     );
   }
   if (keys.length > 1) {
-    throw new Error("Zadaj prave jeden parameter.");
+    throw new Error("Provide exactly one parameter.");
   }
 
   const key = keys[0];
   const value = input[key];
 
   if (typeof value !== "number" || value <= 0 || !isFinite(value)) {
-    throw new Error("Hodnota musi byt kladne konecne cislo.");
+    throw new Error("Value must be a positive finite number.");
   }
 
   const a = paramToEdge[key](value);
@@ -89,7 +89,7 @@ function cube(input) {
 
 function printCube(input) {
   const result = cube(input);
-  console.log("=== Parametre kocky ===");
+  console.log("=== Cube parameters ===");
   for (const [key, value] of Object.entries(result)) {
     const desc = descriptions[key] || key;
     console.log(`  ${desc}: ${value}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jangaba/qube",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Cube calculator – compute all cube parameters from any single one (edge, diagonal, volume, surface area, radius...)",
   "main": "index.js",
   "module": "index.mjs",
@@ -34,5 +34,8 @@
   "repository": {
     "type": "git",
     "url": ""
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }