astro-accelerator-utils 0.2.34 → 0.2.36

package/lib/v1/accelerator.d.mts

@@ -11,6 +11,7 @@ export class Accelerator {
     siteUrl: string;
     subfolder: string;
     useTrailingUrlSlash: boolean;
+    captureStatistics: boolean;
     get authors(): Authors;
     get cache(): Cache;
     get dateFormatter(): DateFormatter;
@@ -20,6 +21,7 @@ export class Accelerator {
     get posts(): Posts;
     get taxonomy(): Taxonomy;
     get urlFormatter(): UrlFormatter;
+    get statistics(): typeof StatisticsStub;
 }
 export type Site = import("../../types/Site").Site;
 import { Authors } from "./authors.mjs";
@@ -31,3 +33,4 @@ import { Paging } from "./paging.mjs";
 import { Posts } from "./posts.mjs";
 import { Taxonomy } from "./taxonomy.mjs";
 import { UrlFormatter } from "./urls.mjs";
+import { StatisticsStub } from "./statistics-stub.mjs";

package/lib/v1/accelerator.mjs

@@ -7,6 +7,8 @@ import { Paging } from './paging.mjs';
 import { Posts } from './posts.mjs';
 import { Taxonomy } from './taxonomy.mjs';
 import { UrlFormatter } from './urls.mjs';
+import { Statistics } from './statistics.mjs';
+import { StatisticsStub } from './statistics-stub.mjs';
 
 /**
  * @typedef { import("../../types/Site").Site } Site
@@ -22,6 +24,7 @@ export class Accelerator {
         this.siteUrl = site.url;
         this.subfolder = site.subfolder;
         this.useTrailingUrlSlash = site.useTrailingUrlSlash;
+        this.captureStatistics = site.captureStatistics;
     }
 
     get authors() {
@@ -57,6 +60,12 @@ export class Accelerator {
     }
 
     get urlFormatter() {
-        return new UrlFormatter(this.siteUrl, this.subfolder, this.useTrailingUrlSlash)
+        return new UrlFormatter(this.siteUrl, this.subfolder, this.useTrailingUrlSlash);
+    }
+
+    get statistics() {
+        return (this.captureStatistics)
+            ? Statistics
+            : StatisticsStub;
     }
 }

package/lib/v1/cache.d.mts

@@ -30,9 +30,9 @@ export class Cache {
      */
     clear(): Promise<void>;
     /**
- * Get's the path of the cache files
- * @returns {string}
- */
+     * Get's the path of the cache files
+     * @returns {string}
+     */
     getCachePath(): string;
     /**
      * Gets the file path for a cache item

package/lib/v1/cache.mjs

@@ -78,23 +78,23 @@ export class Cache {
         }
     }
 
-        /**
+    /**
      * Get's the path of the cache files
      * @returns {string}
      */
-         getCachePath () {
-            const cachePath = path.join(process.cwd(), '.cache/');
-            fs.mkdirSync(cachePath, { recursive: true })
-            return cachePath;
-        }
-    
-        /**
-         * Gets the file path for a cache item
-         * @param {string} key 
-         * @returns {string}
-         */
-        getItemPath (key) {
-            const cachePath = this.getCachePath();
-            return path.join(cachePath, key + '.json');
-        }
+    getCachePath () {
+        const cachePath = path.join(process.cwd(), '.cache/');
+        fs.mkdirSync(cachePath, { recursive: true })
+        return cachePath;
+    }
+
+    /**
+     * Gets the file path for a cache item
+     * @param {string} key 
+     * @returns {string}
+     */
+    getItemPath (key) {
+        const cachePath = this.getCachePath();
+        return path.join(cachePath, key + '.json');
+    }
 }

package/lib/v1/statistics-stub.d.mts

@@ -0,0 +1,5 @@
+export class StatisticsStub {
+    constructor(operation: any);
+    start(): void;
+    stop(): void;
+}

package/lib/v1/statistics-stub.mjs

@@ -0,0 +1,10 @@
+export class StatisticsStub {
+    constructor(operation) {
+    }
+
+    start() {
+    }
+
+    stop() {
+    }
+}

package/lib/v1/statistics.d.mts

@@ -0,0 +1,39 @@
+export class Statistics {
+    /**
+     * Clears the stats file
+     */
+    static purge(): void;
+    /**
+     * Get's the path of the log files
+     * @returns {string}
+     */
+    static getLogPath(): string;
+    /**
+     * Gets the file path for a log item
+     * @returns {string}
+     */
+    static getItemPath(): string;
+    /**
+     * Creates a new stats instance - all instances append to the stats file
+     * Use Statistics.purge() to reset the file
+     * After creating a timer, use start() and stop() to record an event
+     * @param {string} operation
+     */
+    constructor(operation: string);
+    operation: string;
+    /**
+     * Gets high resolution time in ms
+     * @returns number
+     */
+    getMilliseconds(): number;
+    /**
+     * Start the timer
+     */
+    start(): void;
+    /**
+     * Stop the timer (logs to .logs/statistics.csv)
+     */
+    stop(): void;
+    end: number;
+    duration: number;
+}

package/lib/v1/statistics.mjs

@@ -0,0 +1,74 @@
+import fs from 'fs';
+import path from 'path';
+import process from 'process';
+import { EOL } from 'os';
+
+export class Statistics {
+    /**
+     * Creates a new stats instance - all instances append to the stats file
+     * Use Statistics.purge() to reset the file
+     * After creating a timer, use start() and stop() to record an event
+     * @param {string} operation 
+     */
+    constructor(operation) {
+        this.operation = operation.replace(/"/g, '');
+    }
+
+    /**
+     * Clears the stats file
+     */
+    static purge() {
+        const path = this.getItemPath();
+        if (fs.existsSync(path)) {
+            fs.unlinkSync(path);
+        }
+
+        fs.writeFileSync(path, `Operation,Date,Duration${EOL}`);
+    }
+
+    /**
+     * Gets high resolution time in ms
+     * @returns number
+     */
+    getMilliseconds() {
+        const hrtime = process.hrtime();
+        return (hrtime[0] * 1000) + (hrtime[1] / 1000000);
+    }
+
+    /**
+     * Start the timer
+     */
+    start() {
+        this.start = this.getMilliseconds();
+    }
+
+    /**
+     * Stop the timer (logs to .logs/statistics.csv)
+     */
+    stop() {
+        this.end = this.getMilliseconds();
+        this.duration = this.end - this.start;
+
+        const path = Statistics.getItemPath();
+        fs.appendFileSync(path, `"${this.operation}",${console.timeStamp},${this.duration}${EOL}`);
+    }
+
+    /**
+     * Get's the path of the log files
+     * @returns {string}
+     */
+    static getLogPath () {
+        const logPath = path.join(process.cwd(), '.log/');
+        fs.mkdirSync(logPath, { recursive: true })
+        return logPath;
+    }
+
+    /**
+     * Gets the file path for a log item
+     * @returns {string}
+     */
+    static getItemPath () {
+        const cachePath = this.getLogPath();
+        return path.join(cachePath, 'statistics.csv');
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-accelerator-utils",
-  "version": "0.2.34",
+  "version": "0.2.36",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "type": "module",

package/types/Site.d.ts

@@ -1,6 +1,7 @@
 export type Site = {
     url: string;
     useTrailingUrlSlash?: boolean;
+    captureStatistics: boolean;
     dateOptions: Intl.DateTimeFormatOptions;
     subfolder: string;
     feedUrl: string;