Add blog loader

Author: mciszczon

.editorconfig

@@ -0,0 +1,11 @@
+# Generated by editorconfig.timseverien.com
+# https://editor.timseverien.com/#config
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+insert_final_newline = true
+tab_width = 2
+trim_trailing_whitespace = true

.gitattributes

@@ -0,0 +1,3 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+*.lockb binary diff=lockb

.github/workflows/any.yml

@@ -0,0 +1,17 @@
+name: Build & Test
+on:
+  push:
+    branches-ignore:
+      - main
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: oven-sh/setup-bun@v2
+      - run: bun install
+      - run: bun test
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/main.yml

@@ -0,0 +1,24 @@
+name: Publish
+on:
+  push:
+    branches:
+      - main
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: oven-sh/setup-bun@v2
+        with:
+          registry-url: "https://registry.npmjs.org"
+          scope: "@onhive.io"
+      - run: bun install
+      - run: bun test
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+      - run: bun run build
+      - run: bun publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,9 @@
+# Editors
+.idea
+
+# Node
+node_modules
+
+# Dist
+dist
+coverage

.husky/pre-commit

@@ -0,0 +1 @@
+bunx lint-staged

.prettierignore

@@ -0,0 +1,3 @@
+# Ignore artifacts:
+dist
+coverage

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "printWidth": 80,
+  "singleQuote": false,
+  "trailingComma": "none",
+  "tabWidth": 2
+}

README.md

@@ -1,2 +1,3 @@
 # hive-astro-loader
+
 Astro Content Layer loader for the Hive blockchain

bun.lockb

@@ -0,0 +1,6 @@
+telemetry = false
+
+[test]
+coverage = true
+overageThreshold = 0.9
+coverageReporter  = ["text", "lcov"]

bunfig.toml

@@ -0,0 +1,12 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import eslintConfigPrettier from "eslint-config-prettier";
+import tseslint from "typescript-eslint";
+
+export default [
+  { files: ["**/*.{js,mjs,cjs,ts}"], ignores: ["./dist/"] },
+  { languageOptions: { globals: { ...globals.browser, ...globals.node } } },
+  ...tseslint.configs.recommended,
+  pluginJs.configs.recommended,
+  eslintConfigPrettier
+];

eslint.config.mjs

@@ -0,0 +1,58 @@
+{
+  "name": "@onhive.io/astro-loader",
+  "version": "0.0.0",
+  "author": "mietek.dev <hi@mietek.dev>",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/instytutfi/hive-astro-loader.git"
+  },
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "bunx tsup src/index.ts",
+    "dev": "bunx tsup src/index.ts --watch",
+    "lint": "bunx eslint src --fix",
+    "pretty": "bunx prettier src --write",
+    "prepare": "bunx husky"
+  },
+  "dependencies": {
+    "@hiveio/dhive": "^1.3.1-beta"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.13.0",
+    "@types/bun": "latest",
+    "eslint": "^9.13.0",
+    "eslint-config-prettier": "^9.1.0",
+    "globals": "^15.11.0",
+    "husky": "^9.1.6",
+    "lint-staged": "^15.2.10",
+    "prettier": "^3.3.3",
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.3",
+    "typescript-eslint": "^8.11.0"
+  },
+  "peerDependencies": {
+    "astro": "^4.16.7"
+  },
+  "lint-staged": {
+    "**/*": [
+      "bunx eslint --fix",
+      "bunx prettier --write --ignore-unknown"
+    ]
+  },
+  "bugs": {
+    "url": "https://github.com/instytutfi/hive-astro-loader/issues"
+  },
+  "description": "Astro Content Layer loader for the Hive blockchain",
+  "homepage": "https:/onhive.io/tools/hive-astro-loader/",
+  "keywords": [
+    "astro",
+    "astro-loader",
+    "content-layer",
+    "hive"
+  ],
+  "license": "MIT"
+}

package.json

@@ -0,0 +1,29 @@
+import type { Discussion } from "@hiveio/dhive";
+import type { Post } from "~/schema/posts.ts";
+
+/**
+ * Adapts dHive Discussion to our Post schema.
+ * Unfortunately, data returned by dHive is different to Discussion type...
+ */
+export function adaptPost(post: Discussion): Post {
+  return {
+    id: post.post_id.toString(),
+    author: post.author,
+    title: post.title,
+    description: post.json_metadata.description,
+    created: new Date(post.created),
+    updated: post.updated ? new Date(post.updated) : undefined,
+    community: post?.community
+      ? { id: post.community, name: post.community_title }
+      : undefined,
+    category: post.category,
+    tags: post.json_metadata.tags,
+    image: post.json_metadata.image?.pop(),
+    canonical: post.url,
+    content: post.body,
+    meta: {
+      app: post.json_metadata.app,
+      format: post.json_metadata.format
+    }
+  };
+}

src/adapters/posts.ts

@@ -0,0 +1,13 @@
+import { describe, test, expect } from "bun:test";
+import { getAccountPosts } from "~/api/posts.ts";
+
+describe("getAccountPosts", () => {
+  test("returns discussions", async () => {
+    const posts = await getAccountPosts("hive.coding");
+    expect(posts).toBeArray();
+    expect(posts.length).toBeGreaterThan(0);
+    const firstPost = posts.pop();
+    expect(firstPost?.author).toBe("hive.coding");
+    expect(firstPost?.created).toBeInstanceOf(Date);
+  });
+});

src/api/__tests__/posts.test.ts

@@ -0,0 +1,10 @@
+import { Client } from "@hiveio/dhive";
+
+const HIVE_API = "https://api.hive.blog";
+const HIVEKINGS_API = "https://api.hivekings.com";
+const ANYX_API = "https://anyx.io";
+const OPENHIVE_API = "https://api.openhive.network";
+
+const APIS = [HIVE_API, HIVEKINGS_API, ANYX_API, OPENHIVE_API];
+
+export const hive = new Client(APIS);

src/api/common.ts

@@ -0,0 +1,11 @@
+import { hive } from "~/api/common";
+import { adaptPost } from "~/adapters/posts.ts";
+import type { Post } from "~/schema/posts.ts";
+
+export async function getAccountPosts(author: string): Promise<Post[]> {
+  return hive.hivemind
+    .getAccountPosts({ account: author, sort: "posts" })
+    .then((discussions) => {
+      return discussions.map(adaptPost);
+    });
+}

src/api/posts.ts

@@ -0,0 +1,4 @@
+export { hiveBlogLoader } from "~/loaders/blogLoader";
+
+export type { Post } from "~/schema/posts.ts";
+export type { Community } from "~/schema/community.ts";

src/index.ts

@@ -0,0 +1,22 @@
+import type { Loader } from "astro/loaders";
+import { getAccountPosts } from "~/api/posts.ts";
+import { typeToZ } from "~/schema/utils.ts";
+import type { Post } from "~/schema/posts.ts";
+
+export function hiveBlogLoader(author: string): Loader {
+  return {
+    name: "hive-blog-loader",
+    load: async function (this: Loader, { store, logger }) {
+      logger.debug(`Fetching blog posts [author: ${author}]`);
+      const data = await getAccountPosts(author);
+      store.clear();
+      data.forEach((post) => {
+        store.set({
+          id: post.id.toString(),
+          data: { ...post }
+        });
+      });
+    },
+    schema: typeToZ<Post[]>
+  };
+}

src/loaders/blogLoader.ts

@@ -0,0 +1,4 @@
+export type Community = {
+  id: string;
+  name: string;
+};

src/schema/community.ts

@@ -0,0 +1,20 @@
+import type { Community } from "~/schema/community.ts";
+
+export type Post = {
+  id: string;
+  author: string;
+  title: string;
+  description: string;
+  created: Date;
+  updated?: Date;
+  community?: Community;
+  category: string;
+  tags: string[];
+  image?: string;
+  canonical: string;
+  content: string;
+  meta: {
+    app: string;
+    format: string;
+  };
+};

src/schema/posts.ts

@@ -0,0 +1,5 @@
+import { z } from "astro/zod";
+
+export function typeToZ<T>() {
+  return z.custom<T>(() => true) as z.ZodType<T>;
+}

src/schema/utils.ts

@@ -0,0 +1,30 @@
+{
+  "extends": "astro/tsconfigs/strict",
+  "compilerOptions": {
+    "baseUrl": "./src",
+    "paths": {
+      "~/*": ["./*"]
+    },
+    /* Base Options: */
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "target": "es2022",
+    "allowJs": true,
+    "resolveJsonModule": true,
+    "moduleDetection": "force",
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
+    /* Strictness */
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    /* AND if you're building for a library: */
+    "declaration": true,
+    "declarationMap": true,
+    /* If NOT transpiling with TypeScript: */
+    "module": "preserve",
+    "noEmit": true,
+    /* If your code doesn't run in the DOM: */
+    "lib": ["es2022"]
+  }
+}

tsconfig.json

@@ -0,0 +1,10 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: ["src/index.ts"],
+  format: ["esm"],
+  dts: true,
+  splitting: false,
+  sourcemap: true,
+  clean: true
+});