webring 0.0.1 → 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+* Initial release

package/README.md

@@ -1,5 +1,7 @@
 # webring
 
+[![webring](https://img.shields.io/npm/v/webring.svg)](https://www.npmjs.com/package/webring)
+
 `webring` gathers the latest posts from your favorite RSS feeds so that you can embed them on your site.
 
 Inspired by:
@@ -7,6 +9,12 @@ Inspired by:
 - https://github.com/lukehsiao/openring-rs
 - https://git.sr.ht/~sircmpwn/openring
 
+## Installation
+
+```
+npm i webring
+```
+
 ## Quick Start
 
 This library is meant to be used with static site generators. It is framework agnostic.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "webring",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "scripts": {
     "lint": "eslint .",
     "build": "tsc",
@@ -35,5 +35,13 @@
   "lint-staged": {
     "*.{js,jsx,ts,tsx}": "eslint --cache --fix",
     "*": "prettier --ignore-unknown --write"
-  }
+  },
+  "files": [
+    "dist",
+    "package.json",
+    "README.md",
+    "LICENSE",
+    "package-lock.json",
+    "CHANGELOG.md"
+  ]
 }

package/.github/dependabot.yml

@@ -1,12 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "monthly"
-      day: "sunday"
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "monthly"
-      day: "sunday"

package/.prettierrc.json

@@ -1,3 +0,0 @@
-{
-  "printWidth": 120
-}

package/.vscode/extensions.json

@@ -1,3 +0,0 @@
-{
-  "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
-}

package/Earthfile

@@ -1 +0,0 @@
-VERSION 0.9

package/eslint.config.js

@@ -1,17 +0,0 @@
-import eslint from "@eslint/js";
-import tseslint from "typescript-eslint";
-
-export default tseslint.config(
-  eslint.configs.recommended,
-  ...tseslint.configs.strictTypeChecked,
-  ...tseslint.configs.stylisticTypeChecked,
-  {
-    languageOptions: {
-      parserOptions: {
-        project: true,
-        tsconfigRootDir: import.meta.dirname,
-      },
-    },
-    ignores: ["*.js"],
-  },
-);

package/src/cache.ts

@@ -1,48 +0,0 @@
-import * as R from "remeda";
-import type { Configuration, Cache, Result, ResultEntry, CacheEntry, Source } from "./types.js";
-
-export async function runWithCache(config: Configuration, cache: Cache): Promise<[Result, Cache]> {
-  const promises = R.pipe(
-    config.sources,
-    R.map((source) => fetchWithCache(source, cache, config)),
-    R.filter((result) => result !== undefined),
-  );
-  const results = await Promise.all(promises);
-
-  const definedResults = results.filter((result) => result !== undefined) as ResultEntry[];
-
-  const updatedCache: Cache = R.pipe(
-    definedResults,
-    R.map((result): [string, CacheEntry] => [result.source.url, { timestamp: new Date(), data: result }]),
-    R.fromEntries(),
-  );
-
-  const topResults = R.pipe(
-    definedResults,
-    R.sortBy((result) => result.date.getTime()),
-    R.reverse(),
-    R.take(config.number),
-  );
-
-  return [topResults, updatedCache];
-}
-
-export async function fetchWithCache(
-  source: Source,
-  cache: Cache,
-  config: Configuration,
-): Promise<ResultEntry | undefined> {
-  const cacheEntry = cache[source.url];
-  if (cacheEntry) {
-    const now = new Date();
-    if (now.getTime() - cacheEntry.timestamp.getTime() < config.cache_duration_minutes * 60 * 1000) {
-      console.log(`Cache entry found for ${source.url}`);
-      return Promise.resolve(cacheEntry.data);
-    } else {
-      console.log(`Cache entry for ${source.url} is too old`);
-    }
-  }
-
-  console.log(`No cache entry for ${source.url}`);
-  return fetch(source, config.truncate);
-}

package/src/fetch.ts

@@ -1,38 +0,0 @@
-import Parser from "rss-parser";
-import sanitizeHtml from "sanitize-html";
-import truncate from "truncate-html";
-import { type Source, type ResultEntry, FeedEntrySchema } from "./types.js";
-import * as R from "remeda";
-
-export async function fetch(source: Source, length: number): Promise<ResultEntry | undefined> {
-  const parser = new Parser();
-  try {
-    const feed = await parser.parseURL(source.url);
-
-    const firstItem = R.pipe(
-      feed.items,
-      R.map((item) => FeedEntrySchema.parse(item)),
-      R.sortBy((item) => new Date(item.date).getTime()),
-      R.reverse(),
-      R.first(),
-    );
-
-    if (!firstItem) {
-      throw new Error("no items found in feed");
-    }
-
-    const preview =
-      firstItem.contentSnippet ?? firstItem.content ?? firstItem.description ?? firstItem["content:encoded"];
-
-    return {
-      title: firstItem.title,
-      url: firstItem.link,
-      date: new Date(firstItem.date),
-      source,
-      preview: preview ? truncate(sanitizeHtml(preview), length) : undefined,
-    };
-  } catch (e) {
-    console.error(`Error fetching ${source.url}: ${e as string}`);
-    return undefined;
-  }
-}

package/src/index.ts

@@ -1,26 +0,0 @@
-import { runWithCache } from "./cache.js";
-import { type Configuration, type Result, type Cache, CacheSchema } from "./types.js";
-import fs from "fs/promises";
-
-export async function run(config: Configuration): Promise<Result> {
-  const cacheFilename = "cache.json";
-  const currentDir = process.cwd();
-  const fullFilename = `${currentDir}/${cacheFilename}`;
-
-  let cacheObject: Cache = {};
-
-  try {
-    const cacheFile = await fs.readFile(fullFilename);
-    cacheObject = CacheSchema.parse(JSON.parse(cacheFile.toString()));
-  } catch (e) {
-    console.error("Error reading cache file:", e);
-    throw e;
-  }
-
-  const [result, updatedCache] = await runWithCache(config, cacheObject);
-
-  // write the updated cache to cache.json
-  await fs.writeFile(fullFilename, JSON.stringify(updatedCache));
-
-  return result;
-}

package/src/types.ts

@@ -1,63 +0,0 @@
-import { z } from "zod";
-
-export type Source = z.infer<typeof SourceSchema>;
-const SourceSchema = z.object({
-  url: z.string(),
-  title: z.string(),
-});
-
-export type Configuration = z.infer<typeof ConfigurationSchema>;
-const ConfigurationSchema = z.object({
-  sources: SourceSchema.array(),
-  number: z.number(),
-  cache_duration_minutes: z.number(),
-  truncate: z.number(),
-});
-
-export type ResultEntry = z.infer<typeof ResultEntrySchema>;
-const ResultEntrySchema = z.object({
-  title: z.string(),
-  url: z.string(),
-  date: z.coerce.date(),
-  source: SourceSchema,
-  preview: z.string().optional(),
-});
-
-export type Result = z.infer<typeof ResultSchema>;
-const ResultSchema = z.array(ResultEntrySchema);
-
-export type CacheEntry = z.infer<typeof CacheEntrySchema>;
-export const CacheEntrySchema = z.object({
-  timestamp: z.coerce.date(),
-  data: ResultEntrySchema,
-});
-
-export type Cache = z.infer<typeof CacheSchema>;
-export const CacheSchema = z.record(CacheEntrySchema);
-
-export const FeedEntrySchema = z
-  .object({
-    title: z.string(),
-    link: z.string(),
-    isoDate: z.coerce.date().optional(),
-    pubDate: z.coerce.date().optional(),
-    content: z.string().optional(),
-    contentSnippet: z.string().optional(),
-    "content:encoded": z.string().optional(),
-    description: z.string().optional(),
-  })
-  .transform((entry) => {
-    const date = entry.isoDate ?? entry.pubDate;
-    if (!date) {
-      throw new Error("no date found in feed entry");
-    }
-    return {
-      title: entry.title,
-      link: entry.link,
-      date,
-      content: entry.content,
-      contentSnippet: entry.contentSnippet,
-      description: entry.description,
-      "content:encoded": entry["content:encoded"],
-    };
-  });

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": ["@tsconfig/strictest/tsconfig.json", "@tsconfig/node20/tsconfig.json"],
-  "exclude": ["eslint.config.js", "dist"],
-  "compilerOptions": {
-    "outDir": "dist",
-    "declaration": true
-  }
-}