astro-accelerator-utils 0.0.5 → 0.0.7

package/dist/index.d.ts

@@ -1,6 +1,9 @@
-export type { Site } from './Site';
-export type { Frontmatter } from './Frontmatter';
+export type { Frontmatter } from './types/Frontmatter';
+export type { PagePredicate } from './types/PagePredicate';
+export type { Site } from './types/Site';
+export { getCachePath, getItem, getItemPath, setItem } from './lib/Cache';
 export { formatDate, formatModifiedDate } from './lib/dates';
 export { isAuthor, isListable, isSearch, showInMenu, showInSearch, showInSitemap } from './lib/postFiltering';
 export { sortByModDate, sortByPubDate, sortByPubDateDesc } from './lib/postOrdering';
+export { getPages } from './lib/postQueries';
 export { addSlashToAddress, addSlashToUrl } from './lib/urls';

package/dist/index.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addSlashToUrl = exports.addSlashToAddress = exports.sortByPubDateDesc = exports.sortByPubDate = exports.sortByModDate = exports.showInSitemap = exports.showInSearch = exports.showInMenu = exports.isSearch = exports.isListable = exports.isAuthor = exports.formatModifiedDate = exports.formatDate = void 0;
+exports.addSlashToUrl = exports.addSlashToAddress = exports.getPages = exports.sortByPubDateDesc = exports.sortByPubDate = exports.sortByModDate = exports.showInSitemap = exports.showInSearch = exports.showInMenu = exports.isSearch = exports.isListable = exports.isAuthor = exports.formatModifiedDate = exports.formatDate = exports.setItem = exports.getItemPath = exports.getItem = exports.getCachePath = void 0;
+var Cache_1 = require("./lib/Cache");
+Object.defineProperty(exports, "getCachePath", { enumerable: true, get: function () { return Cache_1.getCachePath; } });
+Object.defineProperty(exports, "getItem", { enumerable: true, get: function () { return Cache_1.getItem; } });
+Object.defineProperty(exports, "getItemPath", { enumerable: true, get: function () { return Cache_1.getItemPath; } });
+Object.defineProperty(exports, "setItem", { enumerable: true, get: function () { return Cache_1.setItem; } });
 var dates_1 = require("./lib/dates");
 Object.defineProperty(exports, "formatDate", { enumerable: true, get: function () { return dates_1.formatDate; } });
 Object.defineProperty(exports, "formatModifiedDate", { enumerable: true, get: function () { return dates_1.formatModifiedDate; } });
@@ -15,6 +20,8 @@ var postOrdering_1 = require("./lib/postOrdering");
 Object.defineProperty(exports, "sortByModDate", { enumerable: true, get: function () { return postOrdering_1.sortByModDate; } });
 Object.defineProperty(exports, "sortByPubDate", { enumerable: true, get: function () { return postOrdering_1.sortByPubDate; } });
 Object.defineProperty(exports, "sortByPubDateDesc", { enumerable: true, get: function () { return postOrdering_1.sortByPubDateDesc; } });
+var postQueries_1 = require("./lib/postQueries");
+Object.defineProperty(exports, "getPages", { enumerable: true, get: function () { return postQueries_1.getPages; } });
 var urls_1 = require("./lib/urls");
 Object.defineProperty(exports, "addSlashToAddress", { enumerable: true, get: function () { return urls_1.addSlashToAddress; } });
 Object.defineProperty(exports, "addSlashToUrl", { enumerable: true, get: function () { return urls_1.addSlashToUrl; } });

package/dist/lib/Cache.d.ts

@@ -0,0 +1,5 @@
+export declare const maxAge = 200;
+export declare function getCachePath(): Promise<string>;
+export declare function getItemPath(key: string): Promise<string>;
+export declare function getItem(key: string): Promise<any>;
+export declare function setItem(key: string, value: object): Promise<void>;

package/dist/lib/Cache.js

@@ -0,0 +1,60 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setItem = exports.getItem = exports.getItemPath = exports.getCachePath = exports.maxAge = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const process_1 = __importDefault(require("process"));
+exports.maxAge = 200; //seconds
+function getCachePath() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cachePath = path_1.default.join(process_1.default.cwd(), '.cache/');
+        yield fs_1.default.promises.mkdir(cachePath, { recursive: true });
+        return cachePath;
+    });
+}
+exports.getCachePath = getCachePath;
+function getItemPath(key) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cachePath = yield getCachePath();
+        return path_1.default.join(cachePath, key + '.cache');
+    });
+}
+exports.getItemPath = getItemPath;
+function getItem(key) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const itemPath = yield getItemPath(key);
+        try {
+            const { mtime } = yield fs_1.default.promises.stat(itemPath);
+            var date_time = new Date();
+            let timeDifference = Math.abs((date_time.getTime() - mtime.getTime()) / 1000);
+            if (timeDifference < exports.maxAge) {
+                console.log('Cache hit', key);
+                const content = fs_1.default.readFileSync(itemPath).toString();
+                return JSON.parse(content);
+            }
+        }
+        catch (_a) { }
+        console.warn('Cache miss', key);
+        return null;
+    });
+}
+exports.getItem = getItem;
+function setItem(key, value) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const itemPath = yield getItemPath(key);
+        yield fs_1.default.promises.writeFile(itemPath, JSON.stringify(value));
+    });
+}
+exports.setItem = setItem;

package/dist/lib/dates.d.ts

@@ -1,4 +1,4 @@
-import type { Site } from '../Site';
-import type { Frontmatter } from '../Frontmatter';
+import type { Site } from '../types/Site';
+import type { Frontmatter } from '../types/Frontmatter';
 export declare function formatDate(frontmatter: Frontmatter, lang: string, site: Site): string;
 export declare function formatModifiedDate(frontmatter: Frontmatter, lang: string, site: Site): string;

package/dist/lib/postFiltering.d.ts

@@ -1,6 +1,7 @@
-export declare function showInSitemap(p: any): boolean;
-export declare function showInSearch(p: any): boolean;
-export declare function showInMenu(p: any): boolean;
-export declare function isAuthor(p: any): boolean;
-export declare function isSearch(p: any): boolean;
-export declare function isListable(p: any): boolean;
+import { Markdown } from '../types/Markdown';
+export declare function showInSitemap(p: Markdown<Record<string, any>>): boolean;
+export declare function showInSearch(p: Markdown<Record<string, any>>): boolean;
+export declare function showInMenu(p: Markdown<Record<string, any>>): boolean;
+export declare function isAuthor(p: Markdown<Record<string, any>>): boolean;
+export declare function isSearch(p: Markdown<Record<string, any>>): boolean;
+export declare function isListable(p: Markdown<Record<string, any>>): boolean;

package/dist/lib/postOrdering.d.ts

@@ -1,3 +1,4 @@
-export declare function sortByPubDate(a: any, b: any): any;
-export declare function sortByPubDateDesc(a: any, b: any): any;
-export declare function sortByModDate(a: any, b: any): any;
+import { Markdown } from "../types/Markdown";
+export declare function sortByPubDate(a: Markdown<Record<string, any>>, b: Markdown<Record<string, any>>): any;
+export declare function sortByPubDateDesc(a: Markdown<Record<string, any>>, b: Markdown<Record<string, any>>): any;
+export declare function sortByModDate(a: Markdown<Record<string, any>>, b: Markdown<Record<string, any>>): any;

package/dist/lib/postQueries.d.ts

@@ -0,0 +1,3 @@
+import { Markdown } from "../types/Markdown";
+import { PagePredicate } from "../types/PagePredicate";
+export declare function getPages(fetchPages: () => Record<string, any>, filter?: PagePredicate | null): Promise<Markdown<Record<string, any>>[]>;

package/dist/lib/postQueries.js

@@ -0,0 +1,29 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPages = void 0;
+const Cache_1 = require("./Cache");
+function getPages(fetchPages, filter) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const key = 'PageQueries__getPages';
+        let allPages = yield (0, Cache_1.getItem)(key);
+        if (allPages == null) {
+            const pageImportResult = fetchPages();
+            allPages = Object.values(pageImportResult);
+            yield (0, Cache_1.setItem)(key, allPages);
+        }
+        if (filter == null) {
+            return allPages;
+        }
+        return allPages.filter(filter);
+    });
+}
+exports.getPages = getPages;

package/dist/lib/urls.d.ts

@@ -1,3 +1,3 @@
-import type { Site } from '../Site';
+import type { Site } from '../types/Site';
 export declare function addSlashToUrl(url: URL): URL;
 export declare function addSlashToAddress(address: string | undefined, site: Site): string;

package/dist/types/Frontmatter.d.ts

@@ -0,0 +1 @@
+export type Frontmatter = Record<string, any>;

package/dist/types/Frontmatter.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/Markdown.d.ts

@@ -0,0 +1,4 @@
+export interface Markdown<T extends Record<string, any>> {
+    url: string;
+    frontmatter: T;
+}

package/dist/types/Markdown.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/PagePredicate.d.ts

@@ -0,0 +1,2 @@
+import { Markdown } from "./Markdown";
+export type PagePredicate = (value: Markdown<Record<string, any>>, index: number, array: Markdown<Record<string, any>>[]) => boolean;

package/dist/types/PagePredicate.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/Site.d.ts

@@ -0,0 +1,34 @@
+export type Site = {
+    url: string;
+    dateOptions: Intl.DateTimeFormatOptions;
+    subfolder: string;
+    feedUrl: string;
+    title: string;
+    description: string;
+    defaultLanguage: string;
+    themeColor: string;
+    owner: string;
+    default: {
+        lang: string;
+        locale: string;
+        dir: string;
+    };
+    search: {
+        fallbackUrl: 'https://www.google.com/search' | string;
+        fallbackSite: 'q' | string;
+        fallbackQuery: 'q' | string;
+    };
+    pageSize: number;
+    pageLinks: number;
+    rssLimit: number;
+    featureFlags: {
+        codeBlocks: 'copy'[];
+        figures: 'enlarge'[];
+        youTubeLinks: 'embed'[];
+    };
+    images: {
+        contentSize: string;
+        listerSize: string;
+        authorSize: string;
+    };
+};

package/dist/types/Site.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-accelerator-utils",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "dist/index.js",
   "scripts": {
@@ -25,6 +25,7 @@
   },
   "homepage": "https://astro.stevefenton.co.uk/",
   "devDependencies": {
-    "typescript": "^4.9.3"
+    "typescript": "^4.9.3",
+    "@types/node": "^18.11.9"
   }
 }