folderblog 0.0.1 → 0.0.3

package/dist/index.d.ts

@@ -1,3 +1,14 @@
+export { C as ContentConfig, D as DEFAULT_IMAGE_SIZES, a as DatabaseBuildInput, b as DatabasePlugin, c as DatabaseResult, d as DebugConfig, e as DirectoryConfig, I as ImageEmbeddingPlugin, f as ImageMetadata, g as ImageProcessOptions, h as ImageProcessResult, i as ImageProcessorPlugin, j as ImageSizeConfig, k as IssueCollector, l as IssueCollectorState, L as LogLevel, M as MediaConfig, m as MermaidConfig, n as MermaidRenderOptions, o as MermaidRendererPlugin, p as MermaidResult, q as MermaidStrategy, r as PipelineConfig, s as Plugin, t as PluginByName, u as PluginConfig, P as PluginContext, v as PluginName, w as ProcessConfig, x as ProcessConfigWithDefaults, S as SimilarityConfig, y as SimilarityPlugin, z as SimilarityResult, T as TextEmbeddingPlugin, A as calculateSummary, B as filterIssues, E as generateIssueReport, F as getMediaOutputDir, G as getOutputDir, H as withDefaults } from './config-Dctsdeo6.js';
+export { B as BrokenLinkIssue, f as BuildReport, C as CacheContext, g as CacheStats, h as CachedMediaMetadata, i as CachedMediaSizeVariant, E as EmbeddingErrorIssue, j as EmbeddingMap, G as GraphData, k as GraphEdge, l as GraphNode, m as IssueCategory, I as IssueFilterOptions, n as IssueModule, b as IssueReport, a as IssueSeverity, c as IssueSummary, M as MediaMetadata, o as MediaPathMap, p as MediaProcessingIssue, q as MediaSizeVariant, r as MermaidErrorIssue, s as MissingMediaIssue, O as OUTPUT_FILES, t as OutputFiles, u as PathHashMap, v as PluginErrorIssue, w as PostCover, x as PostCoverError, y as PostCoverSize, z as PostMetadata, A as ProcessResult, e as ProcessedMedia, d as ProcessedPost, P as ProcessingIssue, R as RelationshipType, S as SlugConflictIssue, D as SlugHashMap, T as TocItem, F as buildEmbeddingCacheFromManifest, H as buildMediaCacheFromManifest, J as createEmptyCacheStats, K as isBrokenLinkIssue, L as isEmbeddingErrorIssue, N as isMediaProcessingIssue, Q as isMermaidErrorIssue, U as isMissingMediaIssue, V as isPluginErrorIssue, W as isSlugConflictIssue } from './output-0P0br3Jc.js';
+export { BlockOnly, FileMap, HeaderOnly, LinkResolverOptions, ObsidianLink, PageAndBlock, PageAndHeader, PageOnly } from './processor/types.js';
+export { CopyOnlyImageProcessor, NoOpDatabase, NoOpImageEmbedder, NoOpSimilarity, NoOpTextEmbedder, PassthroughMermaidRenderer, PluginManager, PluginManagerConfig, createAllNoOpPlugins, createDefaultPlugins, createPluginManager, topologicalSort } from './processor/plugins.js';
+export { CosineSimilarityPlugin, SimilarityPluginOptions, cosineSimilarity, createSimilarityPlugin } from './plugins/similarity.js';
+export { BaseSlugOptions, CustomToLinkOptions, DEFAULT_PIPELINE_OPTIONS, FileItem, FrontmatterResult, MarkdownResult, PipelineOptions, Processor, ProcessorOptions, RehypePlugin, RemarkPlugin, SlugAssignment, SlugConfig, SlugManager, buildFileMaps, buildToc, combineHashes, copyFile, countWords, createBasePipeline, createCustomToLink, createPathVariations, createProcessor, ensureDir, estimateReadingTime, extractFirstParagraph, extractHeadings, fileExists, findByFileNameCaseInsensitive, findFiles, findMarkdownFiles, generateBaseSlug, getContentStats, getExtension, getFileName, getStats, hashBuffer, hashContent, hastToHtml, mdastToHast, mdastToText, normalizePath, parseFrontmatter, parseToMdast, processFolder, processMarkdown, processVault, readJson, readText, relativePath, remarkMarkdownLinkResolver, resolveFile, resolveFromCandidates, resolveMarkdownLink, resolveMarkdownLinkPath, resolveSlugConflict, resolveWikilink, shortHash, toSlug, wikiToObsidian, wikilinkToMarkdownLink, writeJson, writeText } from './processor/index.js';
+import 'mdast';
+import 'hast';
+import 'remark-obsidian-link';
+import 'unified';
+
 /**
  * Base post fields shared between list and detail responses
  */
@@ -9,13 +20,13 @@ interface PostBase {
     excerpt: string;
 }
 /**
- * Post summary in list responses
+ * Post summary returned by `blog.posts.list()`
  */
 interface PostSummary extends PostBase {
     url: string;
 }
 /**
- * Full post from detail endpoint
+ * Full post returned by `blog.posts.get(slug)`
  */
 interface Post extends PostBase {
     content: string;
@@ -23,7 +34,7 @@ interface Post extends PostBase {
     images: string[];
 }
 /**
- * Site information
+ * Site information returned by `blog.site.get()`
  */
 interface Site {
     site: string;
@@ -32,39 +43,63 @@ interface Site {
     url: string;
 }
 /**
- * Client options
+ * Options for creating a FolderBlog client
  */
 interface FolderBlogOptions {
+    /** Custom fetch implementation (defaults to globalThis.fetch) */
     fetch?: typeof fetch;
 }
 /**
- * The FolderBlog client
+ * The FolderBlog client interface
  */
 interface FolderBlogClient {
     posts: {
+        /** List all published posts */
         list(): Promise<PostSummary[]>;
+        /** Get a single post by slug */
         get(slug: string): Promise<Post>;
     };
     site: {
+        /** Get site metadata */
         get(): Promise<Site>;
     };
+    tags: {
+        /** List all tags */
+        list(): Promise<string[]>;
+    };
+    categories: {
+        /** List all categories */
+        list(): Promise<string[]>;
+    };
+    feed: {
+        /** Get RSS feed (XML string) */
+        rss(): Promise<string>;
+        /** Get JSON feed */
+        json(): Promise<Record<string, unknown>>;
+    };
 }
 
 /**
- * Create a FolderBlog client
+ * Create a FolderBlog client for consuming blog APIs.
  *
  * @example
  * ```ts
+ * import { folderBlog } from 'folderblog';
+ *
  * const blog = folderBlog('yourname.folder.blog');
+ *
  * const posts = await blog.posts.list();
  * const post = await blog.posts.get('hello-world');
  * const site = await blog.site.get();
+ * const tags = await blog.tags.list();
+ * const categories = await blog.categories.list();
+ * const rss = await blog.feed.rss();
  * ```
  */
 declare function folderBlog(domain: string, options?: FolderBlogOptions): FolderBlogClient;
 
 /**
- * Base error class for folder-blog SDK errors
+ * Base error class for folderblog SDK errors
  */
 declare class FolderBlogError extends Error {
     /** HTTP status code if applicable */
@@ -92,8 +127,42 @@ declare class ApiError extends FolderBlogError {
  * Error thrown when network/fetch fails
  */
 declare class NetworkError extends FolderBlogError {
-    readonly cause?: Error;
     constructor(message: string, cause?: Error);
 }
 
-export { ApiError, type FolderBlogClient, FolderBlogError, type FolderBlogOptions, NetworkError, NotFoundError, type Post, type PostSummary, type Site, folderBlog };
+/**
+ * folderblog - Official SDK for folder.blog
+ *
+ * Everything you need: API client, server middleware, and markdown processor.
+ *
+ * @example API client
+ * ```ts
+ * import { folderBlog } from 'folderblog';
+ *
+ * const blog = folderBlog('yourname.folder.blog');
+ * const posts = await blog.posts.list();
+ * ```
+ *
+ * @example Markdown processing
+ * ```ts
+ * import { processFolder, Processor } from 'folderblog';
+ * ```
+ *
+ * @example Server middleware
+ * ```ts
+ * import { createHandler } from 'folderblog/server';
+ * ```
+ *
+ * @example Fine-grained imports (tree-shaking)
+ * ```ts
+ * import { Processor } from 'folderblog/processor';
+ * import { PluginManager } from 'folderblog/processor/plugins';
+ * import type { ProcessConfig } from 'folderblog/processor/types';
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+declare const VERSION = "0.0.2";
+
+export { ApiError, type FolderBlogClient, FolderBlogError, type FolderBlogOptions, NetworkError, NotFoundError, type Post, type PostSummary, type Site, VERSION, folderBlog };

package/dist/index.js

@@ -1 +1,100 @@
-var o=class extends Error{status;url;constructor(t,r){super(t),this.name="FolderBlogError",this.status=r?.status,this.url=r?.url}},a=class extends o{constructor(t,r,u){super(`${t} not found: ${r}`,{status:404,url:u}),this.name="NotFoundError"}},l=class extends o{constructor(t,r,u){super(t,{status:r,url:u}),this.name="ApiError"}},c=class extends o{cause;constructor(t,r){super(t),this.name="NetworkError",this.cause=r}};function m(e){let t=e.trim();return t.endsWith("/")&&(t=t.slice(0,-1)),!t.startsWith("http://")&&!t.startsWith("https://")&&(t=`https://${t}`),t}function h(e,t={}){let r=m(e),u=t.fetch??globalThis.fetch;async function p(n){let s=`${r}${n}`,i;try{i=await u(s,{method:"GET",headers:{Accept:"application/json"}})}catch(d){throw new c(`Failed to fetch ${s}`,d instanceof Error?d:void 0)}if(!i.ok)throw i.status===404?new a("Resource",n,s):new l(`API request failed: ${i.statusText}`,i.status,s);try{return await i.json()}catch{throw new l("Failed to parse JSON response",i.status,s)}}return{posts:{async list(){return(await p("/api/posts")).posts},async get(n){if(!n)throw new o("Post slug is required");try{return await p(`/api/posts/${encodeURIComponent(n)}`)}catch(s){throw s instanceof a?new a("Post",n,s.url):s}}},site:{async get(){return p("/api")}}}}export{l as ApiError,o as FolderBlogError,c as NetworkError,a as NotFoundError,h as folderBlog};
+import { FolderBlogError, NotFoundError, ApiError, NetworkError } from './chunk-XQD3UUL5.js';
+export { ApiError, FolderBlogError, NetworkError, NotFoundError } from './chunk-XQD3UUL5.js';
+import { normalizeBaseUrl } from './chunk-Q6EXKX6K.js';
+export { DEFAULT_PIPELINE_OPTIONS, IssueCollector, Processor, SlugManager, buildFileMaps, buildToc, calculateSummary, combineHashes, copyFile, countWords, createBasePipeline, createCustomToLink, createPathVariations, createProcessor, ensureDir, estimateReadingTime, extractFirstParagraph, extractHeadings, fileExists, filterIssues, findByFileNameCaseInsensitive, findFiles, findMarkdownFiles, generateBaseSlug, generateIssueReport, getContentStats, getExtension, getFileName, getStats, hashBuffer, hashContent, hastToHtml, mdastToHast, mdastToText, normalizePath, parseFrontmatter, parseToMdast, processFolder, processMarkdown, processVault, readJson, readText, relativePath, remarkMarkdownLinkResolver, resolveFile, resolveFromCandidates, resolveMarkdownLink, resolveMarkdownLinkPath, resolveSlugConflict, resolveWikilink, shortHash, toSlug, wikiToObsidian, wikilinkToMarkdownLink, writeJson, writeText } from './chunk-LPPBVXJ7.js';
+export { DEFAULT_IMAGE_SIZES, OUTPUT_FILES, buildEmbeddingCacheFromManifest, buildMediaCacheFromManifest, createEmptyCacheStats, getMediaOutputDir, getOutputDir, isBrokenLinkIssue, isEmbeddingErrorIssue, isMediaProcessingIssue, isMermaidErrorIssue, isMissingMediaIssue, isPluginErrorIssue, isSlugConflictIssue, withDefaults } from './chunk-D26H5722.js';
+export { CopyOnlyImageProcessor, CosineSimilarityPlugin, NoOpDatabase, NoOpImageEmbedder, NoOpSimilarity, NoOpTextEmbedder, PassthroughMermaidRenderer, PluginManager, cosineSimilarity, createAllNoOpPlugins, createDefaultPlugins, createPluginManager, createSimilarityPlugin, topologicalSort } from './chunk-B43UAOPC.js';
+import './chunk-3RG5ZIWI.js';
+
+// src/client.ts
+function folderBlog(domain, options = {}) {
+  const baseUrl = normalizeBaseUrl(domain);
+  const fetchFn = options.fetch ?? globalThis.fetch;
+  async function fetchRaw(path, accept) {
+    const url = `${baseUrl}${path}`;
+    let response;
+    try {
+      response = await fetchFn(url, {
+        method: "GET",
+        ...accept ? { headers: { Accept: accept } } : {}
+      });
+    } catch (error) {
+      throw new NetworkError(
+        `Failed to fetch ${url}`,
+        error instanceof Error ? error : void 0
+      );
+    }
+    if (!response.ok) {
+      if (response.status === 404) {
+        throw new NotFoundError("Resource", path, url);
+      }
+      throw new ApiError(
+        `API request failed: ${response.statusText}`,
+        response.status,
+        url
+      );
+    }
+    return response;
+  }
+  async function request(path) {
+    const response = await fetchRaw(path, "application/json");
+    try {
+      return await response.json();
+    } catch {
+      throw new ApiError("Failed to parse JSON response", response.status, `${baseUrl}${path}`);
+    }
+  }
+  async function requestText(path) {
+    const response = await fetchRaw(path);
+    return response.text();
+  }
+  return {
+    posts: {
+      async list() {
+        const data = await request("/api/posts");
+        return data.posts;
+      },
+      async get(slug) {
+        if (!slug) throw new FolderBlogError("Post slug is required");
+        try {
+          return await request(`/api/posts/${encodeURIComponent(slug)}`);
+        } catch (error) {
+          if (error instanceof NotFoundError) {
+            throw new NotFoundError("Post", slug, error.url);
+          }
+          throw error;
+        }
+      }
+    },
+    site: {
+      async get() {
+        return request("/api");
+      }
+    },
+    tags: {
+      async list() {
+        const data = await request("/api/tags");
+        return data.tags;
+      }
+    },
+    categories: {
+      async list() {
+        const data = await request("/api/categories");
+        return data.categories;
+      }
+    },
+    feed: {
+      async rss() {
+        return requestText("/api/feed.xml");
+      },
+      async json() {
+        return request("/api/feed.json");
+      }
+    }
+  };
+}
+
+// src/index.ts
+var VERSION = "0.0.2";
+
+export { VERSION, folderBlog };