@readpress/wp-blog 1.0.0

package/dist/types-Ds1ProIy.d.ts

@@ -0,0 +1,238 @@
+interface WpRenderedField {
+    rendered: string;
+}
+interface WpFeaturedMedia {
+    source_url?: string;
+}
+interface WpTerm {
+    id: number;
+    slug?: string;
+    name?: string;
+    taxonomy?: string;
+    count?: number;
+}
+interface WpAuthor {
+    id: number;
+    name?: string;
+    slug?: string;
+    url?: string;
+    description?: string;
+    link?: string;
+    avatar_urls?: Record<string, string>;
+    [key: string]: unknown;
+}
+interface WpEmbedded {
+    "wp:featuredmedia"?: WpFeaturedMedia[];
+    "wp:term"?: WpTerm[][];
+    author?: WpAuthor[];
+}
+interface WpPost {
+    id: number;
+    slug: string;
+    link: string;
+    date: string;
+    modified: string;
+    title: WpRenderedField;
+    excerpt: WpRenderedField;
+    content: WpRenderedField;
+    _embedded?: WpEmbedded;
+}
+interface LinkRewriteContext {
+    href: string;
+    pathname: string;
+    search: string;
+    hash: string;
+}
+interface LinkRewriteRule {
+    source: string;
+    destination?: string;
+    action?: "ignore";
+    transform?: (context: LinkRewriteContext) => string;
+}
+type ClassNameMapMode = "append" | "replace" | "replace-all";
+interface ClassNameMapRule {
+    className: string;
+    mode?: ClassNameMapMode;
+}
+type ClassNameMapValue = string | ClassNameMapRule;
+type ClassNameMap = Record<string, ClassNameMapValue>;
+type PlaceholderProps = Record<string, unknown>;
+interface HtmlContentPart {
+    type: "html";
+    html: string;
+}
+interface PlaceholderContentPart {
+    type: "placeholder";
+    name: string;
+    props: PlaceholderProps;
+}
+type WpContentPart = HtmlContentPart | PlaceholderContentPart;
+interface PlaceholderParseOptions {
+    namespace?: string;
+    maxPropsLength?: number;
+}
+/**
+ * Normalized post shape returned by this package.
+ */
+interface BlogPostSummary {
+    id: number;
+    slug: string;
+    url: string;
+    date: string;
+    modified: string;
+    publishedDate: string;
+    updatedDate: string;
+    title: string;
+    excerpt: string;
+    featuredImageUrl: string | null;
+    author: BlogAuthor | null;
+    categories: BlogTerm[];
+    tags: BlogTerm[];
+}
+/**
+ * Full post shape returned by single-post methods.
+ */
+interface BlogPost extends BlogPostSummary {
+    contentHtml: string;
+}
+interface BlogTerm {
+    id: number;
+    slug: string;
+    name: string;
+    count: number;
+}
+type BlogAuthor = WpAuthor;
+type BlogTermOrder = "default" | "alphabetical" | "count";
+interface GetTermsParams {
+    order?: BlogTermOrder;
+}
+interface GetAuthorsParams {
+    page?: number;
+    perPage?: number;
+}
+type BlogTextMode = "plain" | "html";
+type BlogPostSummaryField = keyof BlogPostSummary;
+type BlogPostField = keyof BlogPost;
+type SelectFields<T, TSelect extends readonly (keyof T)[] | undefined> = TSelect extends readonly (keyof T)[] ? Pick<T, TSelect[number]> : T;
+/**
+ * Pagination metadata returned from list endpoints.
+ */
+interface PaginationMeta {
+    page: number;
+    perPage: number;
+    totalItems: number;
+    totalPages: number;
+}
+/**
+ * Response returned by getPosts.
+ */
+interface PostListResult<TItem = BlogPostSummary> {
+    items: TItem[];
+    pagination: PaginationMeta;
+}
+/**
+ * Optional pagination parameters for getPosts.
+ */
+interface GetPostsParams<TSelect extends readonly BlogPostSummaryField[] | undefined = undefined> {
+    page?: number;
+    perPage?: number;
+    status?: "draft" | "private" | "publish" | "any";
+    categorySlug?: string;
+    tagSlug?: string;
+    textMode?: BlogTextMode;
+    select?: TSelect;
+}
+/**
+ * Options for creating an explicit WordPress client.
+ */
+interface WpClientOptions {
+    wpUrl?: string;
+    endpoint?: string;
+    perPage?: number;
+    auth?: WpAuthConfig;
+    rewriteLinks?: LinkRewriteRule[];
+    classNameMap?: ClassNameMap;
+    fetchImpl?: typeof fetch;
+    requestInit?: RequestInit;
+}
+type WpAuthType = "none" | "basic" | "bearer" | "headers";
+interface WpAuthConfig {
+    type?: WpAuthType;
+    user?: string;
+    appPassword?: string;
+    token?: string;
+    headers?: Record<string, string>;
+}
+interface WpAuthResolvedConfig {
+    type: WpAuthType;
+    user?: string;
+    appPassword?: string;
+    token?: string;
+    headers?: Record<string, string>;
+}
+interface GetPostParams<TSelect extends readonly BlogPostField[] | undefined = undefined> {
+    status?: "draft" | "private" | "publish" | "any";
+    textMode?: BlogTextMode;
+    select?: TSelect;
+}
+interface QueryRawRestInput {
+    path: string;
+    params?: Record<string, string | number | boolean | null | undefined>;
+    method?: string;
+    body?: unknown;
+    headers?: Record<string, string>;
+}
+interface QueryRawParams {
+    rest?: QueryRawRestInput;
+    authRequired?: boolean;
+}
+interface QueryGraphqlParams {
+    query: string;
+    variables?: Record<string, unknown>;
+}
+interface QueryGraphqlResult<TData = unknown> {
+    data?: TData;
+    errors?: Array<Record<string, unknown>>;
+}
+interface WpBlogClient {
+    /**
+     * Fetches a page of published WordPress posts.
+     */
+    getPosts<TSelect extends readonly BlogPostSummaryField[] | undefined = undefined>(params?: GetPostsParams<TSelect>): Promise<PostListResult<SelectFields<BlogPostSummary, TSelect>>>;
+    /**
+     * Fetches a single post by slug, or null when not found.
+     */
+    getPostBySlug<TSelect extends readonly BlogPostField[] | undefined = undefined>(slug: string, params?: GetPostParams<TSelect>): Promise<SelectFields<BlogPost, TSelect> | null>;
+    /**
+     * Fetches a single published post by WordPress post ID, or null when not found.
+     */
+    getPostById<TSelect extends readonly BlogPostField[] | undefined = undefined>(id: number, params?: GetPostParams<TSelect>): Promise<SelectFields<BlogPost, TSelect> | null>;
+    /**
+     * Executes a raw request against REST for custom fields/shapes.
+     * Use this as an escape hatch for custom fields/shapes.
+     */
+    queryRaw<TData = unknown>(params: QueryRawParams): Promise<TData>;
+    /**
+     * Executes a raw GraphQL request.
+     * Uses WP_URL + WP_ENDPOINT and existing WP_AUTH_* auth config.
+     */
+    queryGraphql<TData = unknown>(params: QueryGraphqlParams): Promise<QueryGraphqlResult<TData>>;
+    /**
+     * Fetches blog categories for archive navigation/sidebars.
+     */
+    getCategories(params?: GetTermsParams): Promise<BlogTerm[]>;
+    /**
+     * Fetches blog tags for archive navigation/sidebars.
+     */
+    getTags(params?: GetTermsParams): Promise<BlogTerm[]>;
+    /**
+     * Fetches a page of WordPress authors.
+     */
+    getAuthors(params?: GetAuthorsParams): Promise<BlogAuthor[]>;
+    /**
+     * Fetches a single WordPress author by ID.
+     */
+    getAuthorById(id: number): Promise<BlogAuthor | null>;
+}
+
+export type { WpAuthType as A, BlogTerm as B, ClassNameMap as C, WpEmbedded as D, WpFeaturedMedia as E, WpPost as F, GetAuthorsParams as G, HtmlContentPart as H, WpRenderedField as I, WpTerm as J, LinkRewriteContext as L, PlaceholderParseOptions as P, QueryGraphqlParams as Q, SelectFields as S, WpContentPart as W, WpClientOptions as a, WpBlogClient as b, WpAuthor as c, GetTermsParams as d, BlogPostField as e, GetPostParams as f, BlogPost as g, BlogPostSummaryField as h, GetPostsParams as i, PostListResult as j, BlogPostSummary as k, QueryGraphqlResult as l, QueryRawParams as m, BlogAuthor as n, BlogTermOrder as o, BlogTextMode as p, ClassNameMapMode as q, ClassNameMapRule as r, ClassNameMapValue as s, LinkRewriteRule as t, PaginationMeta as u, PlaceholderContentPart as v, PlaceholderProps as w, QueryRawRestInput as x, WpAuthConfig as y, WpAuthResolvedConfig as z };

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@readpress/wp-blog",
+  "version": "1.0.0",
+  "description": "Lightweight headless WordPress blog adapter for modern web apps",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "require": "./dist/react.js",
+      "import": "./dist/react.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "prepack": "npm run build",
+    "test": "npm run build && node --test test/*.test.mjs",
+    "docs:api": "typedoc",
+    "docs:api:clean": "rm -rf docs/reference && typedoc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/readpress/wp-blog.git"
+  },
+  "homepage": "https://github.com/readpress/wp-blog#readme",
+  "bugs": {
+    "url": "https://github.com/readpress/wp-blog/issues"
+  },
+  "keywords": [
+    "wordpress",
+    "headless",
+    "adapter",
+    "rest-api"
+  ],
+  "author": "",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0"
+  },
+  "devDependencies": {
+    "tslib": "^2.8.1",
+    "tsup": "^8.5.1",
+    "typedoc": "^0.28.17",
+    "typedoc-plugin-markdown": "^4.10.0",
+    "typescript": "^5.9.3"
+  }
+}