@jangaba/qube 1.0.0

package/README.md

@@ -0,0 +1,72 @@
+# qube
+
+Compute all parameters of a cube from any single one.
+
+## Install
+
+```bash
+npm install qube
+```
+
+## Usage
+
+```js
+const { cube } = require("qube");
+// or
+import { cube } from "qube";
+
+cube({ edge: 5 });
+// {
+//   edge: 5,
+//   faceDiagonal: 7.071,
+//   spaceDiagonal: 8.660,
+//   surfaceArea: 150,
+//   volume: 125,
+//   faceArea: 25,
+//   perimeter: 20,
+//   totalEdgeLength: 60,
+//   circumRadius: 4.330,
+//   inRadius: 2.5,
+//   midRadius: 3.536
+// }
+
+cube({ volume: 125 });    // from volume
+cube({ surfaceArea: 150 });  // from surface area
+cube({ spaceDiagonal: 8.66 }); // from space diagonal
+```
+
+## Supported inputs
+
+| Parameter | Description |
+|---|---|
+| `edge` | Edge length |
+| `faceDiagonal` | Face diagonal (a√2) |
+| `spaceDiagonal` | Space diagonal (a√3) |
+| `surfaceArea` | Surface area (6a²) |
+| `volume` | Volume (a³) |
+| `faceArea` | Area of one face (a²) |
+| `perimeter` | Perimeter of one face (4a) |
+| `totalEdgeLength` | Sum of all 12 edges (12a) |
+| `circumRadius` | Circumscribed sphere radius |
+| `inRadius` | Inscribed sphere radius |
+| `midRadius` | Midsphere radius (touches edges) |
+
+Pass **any one** parameter and get **all 11** back.
+
+## API
+
+### `cube(input): CubeResult`
+
+Returns an object with all 11 cube parameters.
+
+### `printCube(input): CubeResult`
+
+Same as `cube()` but also logs the results to the console.
+
+### `descriptions`
+
+Object mapping parameter names to Slovak descriptions.
+
+## License
+
+MIT

package/index.d.ts

@@ -0,0 +1,48 @@
+export interface CubeResult {
+  /** Dlzka hrany */
+  edge: number;
+  /** Uhlopriecka steny (podstavy): a√2 */
+  faceDiagonal: number;
+  /** Telesova uhlopriecka: a√3 */
+  spaceDiagonal: number;
+  /** Povrch kocky: 6a² */
+  surfaceArea: number;
+  /** Objem kocky: a³ */
+  volume: number;
+  /** Obsah jednej steny: a² */
+  faceArea: number;
+  /** Obvod jednej steny: 4a */
+  perimeter: number;
+  /** Sucet dlzok vsetkych hran: 12a */
+  totalEdgeLength: number;
+  /** Polomer opisanej gule: (a√3)/2 */
+  circumRadius: number;
+  /** Polomer vpisanej gule: a/2 */
+  inRadius: number;
+  /** Polomer strednej gule (dotyka sa hran): (a√2)/2 */
+  midRadius: number;
+}
+
+export type CubeInput = { [K in keyof CubeResult]?: number } & {
+  [key: string]: never;
+};
+
+/**
+ * Vypocita vsetky parametre kocky zo zadaneho jedneho parametra.
+ *
+ * @example
+ * cube({ edge: 5 })
+ * cube({ volume: 125 })
+ * cube({ surfaceArea: 150 })
+ */
+export function cube(input: Partial<CubeResult>): CubeResult;
+
+/**
+ * Vypise vsetky parametre kocky do konzoly a vrati vysledok.
+ */
+export function printCube(input: Partial<CubeResult>): CubeResult;
+
+/** Popisy parametrov v slovencine. */
+export const descriptions: Record<keyof CubeResult, string>;
+
+export default cube;

package/index.js

@@ -0,0 +1,101 @@
+/**
+ * Cube Calculator
+ *
+ * Vypocita vsetky parametre kocky zo zadaneho jedneho parametra.
+ *
+ * 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
+ */
+
+const SQRT2 = Math.sqrt(2);
+const SQRT3 = Math.sqrt(3);
+
+function fromEdge(a) {
+  return {
+    edge: a,
+    faceDiagonal: a * SQRT2,
+    spaceDiagonal: a * SQRT3,
+    surfaceArea: 6 * a * a,
+    volume: a * a * a,
+    faceArea: a * a,
+    perimeter: 4 * a,
+    totalEdgeLength: 12 * a,
+    circumRadius: (a * SQRT3) / 2,
+    inRadius: a / 2,
+    midRadius: (a * SQRT2) / 2,
+  };
+}
+
+const paramToEdge = {
+  edge: (v) => v,
+  faceDiagonal: (v) => v / SQRT2,
+  spaceDiagonal: (v) => v / SQRT3,
+  surfaceArea: (v) => Math.sqrt(v / 6),
+  volume: (v) => Math.cbrt(v),
+  faceArea: (v) => Math.sqrt(v),
+  perimeter: (v) => v / 4,
+  totalEdgeLength: (v) => v / 12,
+  circumRadius: (v) => (2 * v) / SQRT3,
+  inRadius: (v) => 2 * v,
+  midRadius: (v) => (2 * v) / SQRT2,
+};
+
+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",
+};
+
+function cube(input) {
+  const keys = Object.keys(input).filter((k) => k in paramToEdge);
+
+  if (keys.length === 0) {
+    throw new Error(
+      `Neznamy parameter. Povolene: ${Object.keys(paramToEdge).join(", ")}`
+    );
+  }
+  if (keys.length > 1) {
+    throw new Error("Zadaj prave jeden 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.");
+  }
+
+  const a = paramToEdge[key](value);
+  return fromEdge(a);
+}
+
+function printCube(input) {
+  const result = cube(input);
+  console.log("=== Parametre kocky ===");
+  for (const [key, value] of Object.entries(result)) {
+    const desc = descriptions[key] || key;
+    console.log(`  ${desc}: ${value}`);
+  }
+  return result;
+}
+
+module.exports = { cube, printCube, descriptions };
+module.exports.default = cube;

package/index.mjs

@@ -0,0 +1,6 @@
+import { createRequire } from "module";
+const require = createRequire(import.meta.url);
+const mod = require("./index.js");
+
+export const { cube, printCube, descriptions } = mod;
+export default cube;

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@jangaba/qube",
+  "version": "1.0.0",
+  "description": "Cube calculator – compute all cube parameters from any single one (edge, diagonal, volume, surface area, radius...)",
+  "main": "index.js",
+  "module": "index.mjs",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./index.mjs",
+      "require": "./index.js",
+      "types": "./index.d.ts"
+    }
+  },
+  "files": [
+    "index.js",
+    "index.mjs",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "test": "node cube.test.js"
+  },
+  "keywords": [
+    "cube",
+    "geometry",
+    "calculator",
+    "math",
+    "kocka",
+    "diagonal",
+    "volume",
+    "surface-area"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": ""
+  }
+}