@amiable-dev/docusaurus-plugin-stentorosaur 0.16.0 → 0.16.2

package/lib/data-source-resolver.client.d.ts

@@ -0,0 +1,23 @@
+/**
+ * ADR-001: Client-Safe Data Source Resolver
+ *
+ * This module provides URL building utilities that can be safely imported
+ * in browser/client contexts. It does NOT import any Node.js-only modules
+ * like @docusaurus/utils-validation.
+ *
+ * For server-side validation and resolution, use data-source-resolver.ts.
+ *
+ * @see docs/adrs/ADR-001-configurable-data-fetching-strategies.md
+ */
+import type { DataSource } from './types';
+/**
+ * Build the fetch URL for a given DataSource configuration.
+ *
+ * This is the client-safe version that can be used in browser contexts.
+ * It assumes the DataSource has already been validated.
+ *
+ * @param dataSource - Validated DataSource configuration
+ * @returns URL string for fetching, or null for build-only strategy
+ */
+export declare function buildFetchUrl(dataSource: DataSource): string | null;
+//# sourceMappingURL=data-source-resolver.client.d.ts.map

package/lib/data-source-resolver.client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-source-resolver.client.d.ts","sourceRoot":"","sources":["../src/data-source-resolver.client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAU1C;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,CAsCnE"}

package/lib/data-source-resolver.client.js

@@ -0,0 +1,63 @@
+"use strict";
+/**
+ * ADR-001: Client-Safe Data Source Resolver
+ *
+ * This module provides URL building utilities that can be safely imported
+ * in browser/client contexts. It does NOT import any Node.js-only modules
+ * like @docusaurus/utils-validation.
+ *
+ * For server-side validation and resolution, use data-source-resolver.ts.
+ *
+ * @see docs/adrs/ADR-001-configurable-data-fetching-strategies.md
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildFetchUrl = buildFetchUrl;
+/**
+ * Default values for GitHub strategy
+ */
+const GITHUB_DEFAULTS = {
+    branch: 'status-data',
+    path: 'current.json',
+};
+/**
+ * Build the fetch URL for a given DataSource configuration.
+ *
+ * This is the client-safe version that can be used in browser contexts.
+ * It assumes the DataSource has already been validated.
+ *
+ * @param dataSource - Validated DataSource configuration
+ * @returns URL string for fetching, or null for build-only strategy
+ */
+function buildFetchUrl(dataSource) {
+    switch (dataSource.strategy) {
+        case 'github': {
+            const { owner, repo, branch = GITHUB_DEFAULTS.branch, path = GITHUB_DEFAULTS.path } = dataSource;
+            return `https://raw.githubusercontent.com/${owner}/${repo}/${branch}/${path}`;
+        }
+        case 'http': {
+            let url = dataSource.url;
+            // Append cache-busting parameter if enabled
+            if (dataSource.cacheBust) {
+                const timestamp = Date.now();
+                const separator = url.includes('?') ? '&' : '?';
+                url = `${url}${separator}t=${timestamp}`;
+            }
+            return url;
+        }
+        case 'static': {
+            // Use file:// protocol for local files
+            const path = dataSource.path;
+            if (path.startsWith('/')) {
+                return `file://${path}`;
+            }
+            return `file://${path}`;
+        }
+        case 'build-only':
+            return null;
+        default: {
+            // Exhaustive check
+            const _exhaustive = dataSource;
+            throw new Error(`Unknown strategy: ${_exhaustive.strategy}`);
+        }
+    }
+}

package/lib/hooks/useStatusData.js

@@ -15,7 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useStatusData = useStatusData;
 const react_1 = require("react");
-const data_source_resolver_1 = require("../data-source-resolver");
+const data_source_resolver_client_1 = require("../data-source-resolver.client");
 const data_source_validator_1 = require("../data-source-validator");
 /**
  * Custom hook for fetching status data based on DataSource configuration.
@@ -45,7 +45,7 @@ function useStatusData(options) {
      */
     const fetchData = (0, react_1.useCallback)(async () => {
         // Build fetch URL based on strategy
-        let url = (0, data_source_resolver_1.buildFetchUrl)(dataSource);
+        let url = (0, data_source_resolver_client_1.buildFetchUrl)(dataSource);
         // Build-only strategy doesn't fetch
         if (url === null) {
             setLoading(false);

package/lib/theme/StatusPage/index.js

@@ -18,7 +18,7 @@ const IncidentHistory_1 = __importDefault(require("../IncidentHistory"));
 const MaintenanceList_1 = __importDefault(require("../Maintenance/MaintenanceList"));
 const PerformanceMetrics_1 = __importDefault(require("../PerformanceMetrics"));
 const version_1 = require("../../version");
-const data_source_resolver_1 = require("../../data-source-resolver");
+const data_source_resolver_client_1 = require("../../data-source-resolver.client");
 const styles_module_css_1 = __importDefault(require("./styles.module.css"));
 function StatusPage({ statusData }) {
     const { items = [], incidents = [], maintenance = [], lastUpdated, showServices = true, showIncidents = true, showPerformanceMetrics = true, useDemoData = false, fetchUrl, dataSource, } = statusData || {};
@@ -31,7 +31,7 @@ function StatusPage({ statusData }) {
     const dataBaseUrl = (0, react_1.useMemo)(() => {
         if (dataSource) {
             // Build URL from dataSource, stripping the file part to get base URL
-            const url = (0, data_source_resolver_1.buildFetchUrl)(dataSource);
+            const url = (0, data_source_resolver_client_1.buildFetchUrl)(dataSource);
             if (url) {
                 // Remove file:// prefix for browser context
                 const cleanUrl = url.startsWith('file://') ? url.replace('file://', '') : url;

package/lib/theme/UptimeStatusPage/index.js

@@ -17,7 +17,7 @@ const IncidentHistory_1 = __importDefault(require("../IncidentHistory"));
 const MaintenanceList_1 = __importDefault(require("../Maintenance/MaintenanceList"));
 const StatusBoard_1 = __importDefault(require("../StatusBoard"));
 const PerformanceMetrics_1 = __importDefault(require("../PerformanceMetrics"));
-const data_source_resolver_1 = require("../../data-source-resolver");
+const data_source_resolver_client_1 = require("../../data-source-resolver.client");
 const styles_module_css_1 = __importDefault(require("./styles.module.css"));
 // Default configuration with all sections enabled
 const DEFAULT_CONFIG = {
@@ -42,7 +42,7 @@ function UptimeStatusPage({ statusData }) {
     const dataBaseUrl = (0, react_1.useMemo)(() => {
         if (dataSource) {
             // Build URL from dataSource, stripping the file part to get base URL
-            const url = (0, data_source_resolver_1.buildFetchUrl)(dataSource);
+            const url = (0, data_source_resolver_client_1.buildFetchUrl)(dataSource);
             if (url) {
                 // Remove file:// prefix for browser context
                 const cleanUrl = url.startsWith('file://') ? url.replace('file://', '') : url;

package/lib/version.d.ts

@@ -2,5 +2,5 @@
  * Plugin version - auto-generated during build
  * DO NOT EDIT MANUALLY - This file is generated from package.json
  */
-export declare const PLUGIN_VERSION = "0.16.0";
+export declare const PLUGIN_VERSION = "0.16.2";
 //# sourceMappingURL=version.d.ts.map

package/lib/version.js

@@ -5,4 +5,4 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PLUGIN_VERSION = void 0;
-exports.PLUGIN_VERSION = '0.16.0';
+exports.PLUGIN_VERSION = '0.16.2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amiable-dev/docusaurus-plugin-stentorosaur",
-  "version": "0.16.0",
+  "version": "0.16.2",
   "description": "A Docusaurus plugin for displaying status monitoring dashboard powered by GitHub Issues and Actions, similar to Upptime",
   "main": "lib/index.js",
   "types": "src/plugin-status.d.ts",

package/scripts/calculate-actions-minutes.js

@@ -0,0 +1,276 @@
+#!/usr/bin/env node
+
+/**
+ * Calculate GitHub Actions minutes used per month for amiable-dev/amiable-docusaurus
+ *
+ * This script fetches workflow run data and calculates billable minutes.
+ *
+ * Usage:
+ *   GITHUB_TOKEN=your_token node scripts/calculate-actions-minutes.js
+ *
+ * Options:
+ *   --months N    Number of months to analyze (default: 3)
+ *   --verbose     Show detailed output
+ */
+
+const { Octokit } = require('@octokit/rest');
+
+const OWNER = 'amiable-dev';
+const REPO = 'amiable-docusaurus';
+
+// GitHub Actions billing multipliers (for private repos)
+// Public repos have unlimited free minutes
+const BILLING_MULTIPLIERS = {
+  'ubuntu-latest': 1,    // Linux: 1x
+  'ubuntu-20.04': 1,
+  'ubuntu-22.04': 1,
+  'windows-latest': 2,   // Windows: 2x
+  'windows-2019': 2,
+  'windows-2022': 2,
+  'macos-latest': 10,    // macOS: 10x
+  'macos-11': 10,
+  'macos-12': 10,
+  'macos-13': 10,
+};
+
+async function getWorkflowRuns(octokit, startDate, endDate) {
+  const runs = [];
+  let page = 1;
+  const perPage = 100;
+
+  console.log(`Fetching workflow runs from ${startDate.toISOString()} to ${endDate.toISOString()}...`);
+
+  while (true) {
+    const response = await octokit.actions.listWorkflowRunsForRepo({
+      owner: OWNER,
+      repo: REPO,
+      per_page: perPage,
+      page,
+      created: `${startDate.toISOString().split('T')[0]}..${endDate.toISOString().split('T')[0]}`,
+    });
+
+    runs.push(...response.data.workflow_runs);
+
+    if (response.data.workflow_runs.length < perPage) {
+      break;
+    }
+
+    page++;
+  }
+
+  return runs;
+}
+
+async function getJobsForRun(octokit, runId) {
+  const response = await octokit.actions.listJobsForWorkflowRun({
+    owner: OWNER,
+    repo: REPO,
+    run_id: runId,
+  });
+
+  return response.data.jobs;
+}
+
+function calculateJobDuration(job) {
+  if (!job.started_at || !job.completed_at) {
+    return 0;
+  }
+
+  const start = new Date(job.started_at);
+  const end = new Date(job.completed_at);
+  const durationMs = end - start;
+  const durationMinutes = Math.ceil(durationMs / 1000 / 60); // Round up to nearest minute
+
+  return durationMinutes;
+}
+
+function getRunnerMultiplier(runnerName) {
+  if (!runnerName) return 1;
+
+  for (const [key, multiplier] of Object.entries(BILLING_MULTIPLIERS)) {
+    if (runnerName.toLowerCase().includes(key.toLowerCase())) {
+      return multiplier;
+    }
+  }
+
+  return 1; // Default to Linux multiplier
+}
+
+async function analyzeMonthlyUsage(octokit, months = 3, verbose = false) {
+  const now = new Date();
+  const monthlyData = {};
+
+  // Initialize monthly buckets
+  for (let i = 0; i < months; i++) {
+    const date = new Date(now.getFullYear(), now.getMonth() - i, 1);
+    const monthKey = `${date.getFullYear()}-${String(date.getMonth() + 1).padStart(2, '0')}`;
+    monthlyData[monthKey] = {
+      runs: 0,
+      jobs: 0,
+      totalMinutes: 0,
+      billableMinutes: 0,
+      workflows: {},
+      runners: {},
+    };
+  }
+
+  // Fetch workflow runs for the entire period
+  const startDate = new Date(now.getFullYear(), now.getMonth() - months + 1, 1);
+  const endDate = now;
+
+  const runs = await getWorkflowRuns(octokit, startDate, endDate);
+
+  console.log(`\nFound ${runs.length} workflow runs in the last ${months} months\n`);
+
+  // Process each run
+  for (const run of runs) {
+    const runDate = new Date(run.created_at);
+    const monthKey = `${runDate.getFullYear()}-${String(runDate.getMonth() + 1).padStart(2, '0')}`;
+
+    if (!monthlyData[monthKey]) continue;
+
+    monthlyData[monthKey].runs++;
+
+    // Get jobs for this run
+    const jobs = await getJobsForRun(octokit, run.id);
+
+    for (const job of jobs) {
+      const duration = calculateJobDuration(job);
+      const multiplier = getRunnerMultiplier(job.runner_name);
+      const billableMinutes = duration * multiplier;
+
+      monthlyData[monthKey].jobs++;
+      monthlyData[monthKey].totalMinutes += duration;
+      monthlyData[monthKey].billableMinutes += billableMinutes;
+
+      // Track by workflow
+      const workflowName = run.name || run.path;
+      if (!monthlyData[monthKey].workflows[workflowName]) {
+        monthlyData[monthKey].workflows[workflowName] = {
+          runs: 0,
+          minutes: 0,
+          billableMinutes: 0,
+        };
+      }
+      monthlyData[monthKey].workflows[workflowName].runs++;
+      monthlyData[monthKey].workflows[workflowName].minutes += duration;
+      monthlyData[monthKey].workflows[workflowName].billableMinutes += billableMinutes;
+
+      // Track by runner
+      const runnerType = job.runner_name || 'unknown';
+      if (!monthlyData[monthKey].runners[runnerType]) {
+        monthlyData[monthKey].runners[runnerType] = {
+          jobs: 0,
+          minutes: 0,
+          billableMinutes: 0,
+        };
+      }
+      monthlyData[monthKey].runners[runnerType].jobs++;
+      monthlyData[monthKey].runners[runnerType].minutes += duration;
+      monthlyData[monthKey].runners[runnerType].billableMinutes += billableMinutes;
+
+      if (verbose) {
+        console.log(`  [${monthKey}] ${workflowName}: ${duration}min (${billableMinutes} billable) on ${runnerType}`);
+      }
+    }
+
+    // Add small delay to avoid rate limiting
+    await new Promise(resolve => setTimeout(resolve, 100));
+  }
+
+  return monthlyData;
+}
+
+function printReport(monthlyData) {
+  console.log('\n=== GitHub Actions Usage Report ===\n');
+  console.log(`Repository: ${OWNER}/${REPO}\n`);
+
+  const sortedMonths = Object.keys(monthlyData).sort().reverse();
+
+  let totalRuns = 0;
+  let totalJobs = 0;
+  let totalMinutes = 0;
+  let totalBillableMinutes = 0;
+
+  for (const month of sortedMonths) {
+    const data = monthlyData[month];
+    totalRuns += data.runs;
+    totalJobs += data.jobs;
+    totalMinutes += data.totalMinutes;
+    totalBillableMinutes += data.billableMinutes;
+
+    console.log(`Month: ${month}`);
+    console.log(`  Workflow Runs: ${data.runs}`);
+    console.log(`  Total Jobs: ${data.jobs}`);
+    console.log(`  Actual Minutes: ${data.totalMinutes.toLocaleString()}`);
+    console.log(`  Billable Minutes: ${data.billableMinutes.toLocaleString()}`);
+
+    // Top workflows
+    const topWorkflows = Object.entries(data.workflows)
+      .sort((a, b) => b[1].billableMinutes - a[1].billableMinutes)
+      .slice(0, 5);
+
+    if (topWorkflows.length > 0) {
+      console.log('\n  Top Workflows:');
+      for (const [name, stats] of topWorkflows) {
+        console.log(`    - ${name}: ${stats.runs} runs, ${stats.billableMinutes} billable minutes`);
+      }
+    }
+
+    // Runner breakdown
+    console.log('\n  By Runner Type:');
+    for (const [runner, stats] of Object.entries(data.runners)) {
+      console.log(`    - ${runner}: ${stats.jobs} jobs, ${stats.minutes} min (${stats.billableMinutes} billable)`);
+    }
+
+    console.log('\n');
+  }
+
+  console.log('=== Overall Totals ===');
+  console.log(`Total Runs: ${totalRuns}`);
+  console.log(`Total Jobs: ${totalJobs}`);
+  console.log(`Total Actual Minutes: ${totalMinutes.toLocaleString()}`);
+  console.log(`Total Billable Minutes: ${totalBillableMinutes.toLocaleString()}`);
+
+  if (totalRuns > 0) {
+    console.log(`\nAverage per Run: ${Math.round(totalMinutes / totalRuns)} minutes (${Math.round(totalBillableMinutes / totalRuns)} billable)`);
+  }
+}
+
+async function main() {
+  const token = process.env.GITHUB_TOKEN;
+  if (!token) {
+    console.error('Error: GITHUB_TOKEN environment variable is required');
+    console.error('Usage: GITHUB_TOKEN=your_token node scripts/calculate-actions-minutes.js');
+    process.exit(1);
+  }
+
+  // Parse command line arguments
+  const args = process.argv.slice(2);
+  let months = 3;
+  let verbose = false;
+
+  for (let i = 0; i < args.length; i++) {
+    if (args[i] === '--months' && args[i + 1]) {
+      months = parseInt(args[i + 1], 10);
+      i++;
+    } else if (args[i] === '--verbose') {
+      verbose = true;
+    }
+  }
+
+  const octokit = new Octokit({ auth: token });
+
+  try {
+    const monthlyData = await analyzeMonthlyUsage(octokit, months, verbose);
+    printReport(monthlyData);
+  } catch (error) {
+    console.error('Error:', error.message);
+    if (error.response) {
+      console.error('Response:', error.response.data);
+    }
+    process.exit(1);
+  }
+}
+
+main();

package/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/annotation-utils.ts","./src/data-source-resolver.ts","./src/data-source-validator.ts","./src/demo-data.ts","./src/github-service.ts","./src/historical-data.ts","./src/index.ts","./src/label-utils.ts","./src/maintenance-utils.ts","./src/options.ts","./src/plugin-status.d.ts","./src/time-utils.ts","./src/types.ts","./src/version.ts","./src/hooks/index.ts","./src/hooks/useStatusData.ts","./src/notifications/simple-index.ts","./src/notifications/simple-notification-service.ts","./src/notifications/types.ts","./src/notifications/providers/discord-provider.ts","./src/notifications/providers/email-provider.ts","./src/notifications/providers/slack-provider.ts","./src/notifications/providers/telegram-provider.ts","./src/theme/css-modules.d.ts","./src/theme/theme-layout.d.ts","./src/theme/ChartPanel/index.tsx","./src/theme/IncidentHistory/index.tsx","./src/theme/Maintenance/MaintenanceItem/index.tsx","./src/theme/Maintenance/MaintenanceList/index.tsx","./src/theme/PerformanceMetrics/index.tsx","./src/theme/ResponseTimeChart/index.tsx","./src/theme/SLIChart/index.tsx","./src/theme/StatusBoard/index.tsx","./src/theme/StatusHistory/index.tsx","./src/theme/StatusItem/MiniHeatmap.tsx","./src/theme/StatusItem/index.tsx","./src/theme/StatusPage/index.tsx","./src/theme/UptimeChart/index.tsx","./src/theme/UptimeStatusPage/index.tsx","./src/theme/components/ExportButton.tsx","./src/theme/hooks/useChartExport.ts","./src/theme/hooks/useDataExport.ts","./src/utils/csv.ts","./src/utils/markdown.ts"],"version":"5.9.3"}
+{"root":["./src/annotation-utils.ts","./src/data-source-resolver.client.ts","./src/data-source-resolver.ts","./src/data-source-validator.ts","./src/demo-data.ts","./src/github-service.ts","./src/historical-data.ts","./src/index.ts","./src/label-utils.ts","./src/maintenance-utils.ts","./src/options.ts","./src/plugin-status.d.ts","./src/time-utils.ts","./src/types.ts","./src/version.ts","./src/hooks/index.ts","./src/hooks/useStatusData.ts","./src/notifications/simple-index.ts","./src/notifications/simple-notification-service.ts","./src/notifications/types.ts","./src/notifications/providers/discord-provider.ts","./src/notifications/providers/email-provider.ts","./src/notifications/providers/slack-provider.ts","./src/notifications/providers/telegram-provider.ts","./src/theme/css-modules.d.ts","./src/theme/theme-layout.d.ts","./src/theme/ChartPanel/index.tsx","./src/theme/IncidentHistory/index.tsx","./src/theme/Maintenance/MaintenanceItem/index.tsx","./src/theme/Maintenance/MaintenanceList/index.tsx","./src/theme/PerformanceMetrics/index.tsx","./src/theme/ResponseTimeChart/index.tsx","./src/theme/SLIChart/index.tsx","./src/theme/StatusBoard/index.tsx","./src/theme/StatusHistory/index.tsx","./src/theme/StatusItem/MiniHeatmap.tsx","./src/theme/StatusItem/index.tsx","./src/theme/StatusPage/index.tsx","./src/theme/UptimeChart/index.tsx","./src/theme/UptimeStatusPage/index.tsx","./src/theme/components/ExportButton.tsx","./src/theme/hooks/useChartExport.ts","./src/theme/hooks/useDataExport.ts","./src/utils/csv.ts","./src/utils/markdown.ts"],"version":"5.9.3"}