@hailbytes/security-roi-calculator 1.0.0

package/index.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Type declarations for @hailbytes/security-roi-calculator.
+ */
+
+export interface ROIInputs {
+  employeeCount: number;
+  avgSalary: number;
+  incidentsPerYear: number;
+  avgIncidentCost: number;
+  /** Pre-training phishing click rate, as a percent (0–100). */
+  clickRateBefore: number;
+  /** Expected reduction in click rate, as a percent (0–100). */
+  expectedReduction: number;
+  trainingHoursPerYear: number;
+  /** Platform licensing $ per year (total). */
+  platformLicensing: number;
+  implementationHours: number;
+  hourlyRate: number;
+}
+
+export interface ROIResult {
+  inputs: ROIInputs;
+  annualRiskReduction: number;
+  totalTrainingCost: number;
+  platformLicensing: number;
+  implementationCost: number;
+  productivityCost: number;
+  netBenefit: number;
+  /** ROI as a percent (e.g. 250 means 250%). */
+  roi: number;
+  paybackMonths: number;
+  clickRateBefore: number;
+  clickRateAfter: number;
+  clickRateReduction: number;
+  preventedIncidents: number;
+  isPositiveROI: boolean;
+}
+
+/**
+ * Pure ROI calculation — no DOM required.
+ */
+export function calculateROI(inputs: ROIInputs): ROIResult;
+
+/**
+ * The custom-element class. Importing this module also registers
+ * the `<hailbytes-roi-calculator>` tag via `customElements.define`.
+ *
+ * Supported attributes:
+ *   - `theme="dark"|"light"`  (default: `"dark"`)
+ *   - `branding="off"`        hides the "by HailBytes" header line and CTA
+ */
+export default class HailbytesROICalculator extends HTMLElement {
+  static readonly observedAttributes: readonly string[];
+}
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'hailbytes-roi-calculator': HailbytesROICalculator;
+  }
+  interface HTMLElementEventMap {
+    'roi-calculated': CustomEvent<ROIResult>;
+  }
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@hailbytes/security-roi-calculator",
+  "version": "1.0.0",
+  "description": "Zero-dependency web component for calculating security awareness training ROI. Works in Hugo, React, Vue, or plain HTML.",
+  "type": "module",
+  "main": "./hailbytes-roi-calculator.js",
+  "module": "./hailbytes-roi-calculator.js",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./hailbytes-roi-calculator.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "./index.d.ts",
+  "files": [
+    "hailbytes-roi-calculator.js",
+    "index.d.ts",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "sideEffects": [
+    "./hailbytes-roi-calculator.js"
+  ],
+  "scripts": {
+    "test": "node --test test/smoke.test.mjs"
+  },
+  "keywords": [
+    "roi",
+    "roi-calculator",
+    "security-awareness",
+    "security-training",
+    "cybersecurity",
+    "web-component",
+    "custom-element",
+    "es-module",
+    "zero-dependency",
+    "hailbytes",
+    "vanilla-js"
+  ],
+  "author": "HailBytes, LLC (https://hailbytes.com)",
+  "license": "MPL-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/HailBytes/security-roi-calculator.git"
+  },
+  "bugs": {
+    "url": "https://github.com/HailBytes/security-roi-calculator/issues"
+  },
+  "homepage": "https://hailbytes.com",
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}