@szymonpiatek/nextwordpress 0.0.1 → 0.0.3

package/dist/index.d.cts

@@ -4,32 +4,6 @@ interface NextWordpressConfig {
     /** Used in browser / client components (e.g., public domain). */
     clientURL: string;
 }
-interface WordPressPaginationHeaders {
-    total: number;
-    totalPages: number;
-}
-interface WordPressResponse<T> {
-    data: T;
-    headers: WordPressPaginationHeaders;
-}
-declare class WordPressAPIError extends Error {
-    status: number;
-    endpoint: string;
-    constructor(message: string, status: number, endpoint: string);
-}
-
-declare function resolveBaseUrl(config: NextWordpressConfig): string;
-declare function buildUrl(config: NextWordpressConfig, path: string, query?: Record<string, unknown>): string;
-
-declare function createFetcher(config: NextWordpressConfig): {
-    wpFetch: <T>(path: string, query?: Record<string, unknown>, tags?: string[]) => Promise<T>;
-    wpFetchGraceful: <T>(path: string, fallback: T, query?: Record<string, unknown>, tags?: string[]) => Promise<T>;
-    wpFetchPaginated: <T>(path: string, query?: Record<string, unknown>, tags?: string[]) => Promise<WordPressResponse<T[]>>;
-    wpFetchPaginatedGraceful: <T>(path: string, query?: Record<string, unknown>, tags?: string[]) => Promise<WordPressResponse<T[]>>;
-    wpMutate: <T>(path: string, body: unknown, method?: "POST" | "PUT" | "PATCH" | "DELETE") => Promise<T>;
-};
-type WordPressFetcher = ReturnType<typeof createFetcher>;
-
 interface WPEntity {
     id: number;
     date: string;
@@ -60,6 +34,8 @@ interface Taxonomy {
     meta: Record<string, unknown>;
 }
 
+declare function resolveBaseUrl(config: NextWordpressConfig): string;
+
 interface MediaSize {
     file: string;
     width: number;
@@ -220,6 +196,15 @@ interface Post extends WPEntity {
     _embedded?: PostEmbedded;
 }
 
+interface WordPressPaginationHeaders {
+    total: number;
+    totalPages: number;
+}
+interface WordPressResponse<T> {
+    data: T;
+    headers: WordPressPaginationHeaders;
+}
+
 interface Category extends Taxonomy {
     taxonomy: 'category';
     parent: number;
@@ -243,7 +228,94 @@ interface Page extends WPEntity {
     meta: Record<string, unknown>;
 }
 
+interface Menu {
+    id: number;
+    description: string;
+    name: string;
+    slug: string;
+    meta: Record<string, unknown>;
+    locations: string[];
+    auto_add: boolean;
+}
+interface MenuItem {
+    id: number;
+    title: {
+        rendered: string;
+    };
+    status: string;
+    url: string;
+    attr_title: string;
+    description: string;
+    type: string;
+    type_label: string;
+    object: string;
+    object_id: number;
+    parent: number;
+    menu_order: number;
+    target: string;
+    classes: string[];
+    xfn: string[];
+    invalid: boolean;
+    menus: number;
+    meta: Record<string, unknown>;
+}
+interface MenuLocation {
+    name: string;
+    description: string;
+    menu: number;
+}
+interface MenuWithItems {
+    menu: Menu;
+    items: MenuItem[];
+}
+
+interface CommentAuthorAvatar {
+    '24': string;
+    '48': string;
+    '96': string;
+    [size: string]: string;
+}
+interface Comment {
+    id: number;
+    post: number;
+    parent: number;
+    author: number;
+    author_name: string;
+    author_email: string;
+    author_url: string;
+    author_ip: string;
+    author_avatar_urls: CommentAuthorAvatar;
+    date: string;
+    date_gmt: string;
+    content: {
+        rendered: string;
+    };
+    link: string;
+    status: 'approve' | 'hold' | 'spam' | 'trash';
+    type: string;
+    meta: Record<string, unknown>;
+}
+interface CreateCommentInput {
+    post: number;
+    content: string;
+    author_name?: string;
+    author_email?: string;
+    author_url?: string;
+    parent?: number;
+}
+
 declare function createWordPressClient(config: NextWordpressConfig): {
+    getCommentsByPostId: (postId: number, page?: number, perPage?: number) => Promise<WordPressResponse<Comment[]>>;
+    getAllCommentsByPostId: (postId: number) => Promise<Comment[]>;
+    getCommentById: (id: number) => Promise<Comment>;
+    getCommentReplies: (parentId: number) => Promise<Comment[]>;
+    createComment: (input: CreateCommentInput) => Promise<Comment>;
+    getMenus: () => Promise<Menu[]>;
+    getMenuById: (id: number) => Promise<Menu>;
+    getMenuBySlug: (slug: string) => Promise<Menu | undefined>;
+    getMenuItemsByMenuId: (menuId: number) => Promise<MenuItem[]>;
+    getMenuLocations: () => Promise<Record<string, MenuLocation>>;
+    getMenuByLocation: (location: string) => Promise<MenuWithItems | undefined>;
     getAllPages: () => Promise<Page[]>;
     getPageById: (id: number) => Promise<Page>;
     getPageBySlug: (slug: string) => Promise<Page | undefined>;
@@ -694,4 +766,476 @@ declare function createWooCommerceClient(config: WooCommerceConfig): {
     getProductVariationById: (productId: number, variationId: number) => Promise<WCProductVariation>;
 };
 
-export { type Author, type BlockType, type Category, type EditorBlock, type EmbeddedAuthor, type EmbeddedTerm, type FeaturedMedia, type MediaDetails, type MediaSize, type NextWordpressConfig, type OmnibusPriceEntry, type OmnibusProductData, type Page, type Post, type PostEmbedded, type RenderedContent, type RenderedTitle, type SearchResult, type Tag, type Taxonomy, type TemplatePart, type WCAddress, type WCCoupon, type WCCreateOrderInput, type WCCustomer, type WCDimensions, type WCImage, type WCOrder, type WCOrderLineItem, type WCProduct, type WCProductAttribute, type WCProductCategory, type WCProductDefaultAttribute, type WCProductFilterParams, type WCProductTag, type WCProductVariation, type WCProductVariationWithOmnibus, type WCProductWithOmnibus, type WCShippingLine, type WPEntity, type WooCommerceConfig, type WooCommerceFetcher, type WooCommercePaginationHeaders, type WooCommerceResponse, WordPressAPIError, type WordPressFetcher, type WordPressPaginationHeaders, type WordPressResponse, buildUrl, createFetcher, createWooCommerceClient, createWooCommerceFetcher, createWordPressClient, extractOmnibusData, resolveBaseUrl, withOmnibus, withOmnibusVariation };
+type WPGraphQLConfig = NextWordpressConfig;
+interface GQLPageInfo {
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+    startCursor?: string;
+    endCursor?: string;
+}
+interface GQLConnection<T> {
+    nodes: T[];
+    pageInfo: GQLPageInfo;
+}
+interface GQLError {
+    message: string;
+    locations?: Array<{
+        line: number;
+        column: number;
+    }>;
+    path?: string[];
+}
+declare class WPGraphQLError extends Error {
+    readonly status: number;
+    readonly endpoint: string;
+    readonly gqlErrors?: GQLError[] | undefined;
+    constructor(message: string, status: number, endpoint: string, gqlErrors?: GQLError[] | undefined);
+}
+
+declare function createWPGraphQLFetcher(config: WPGraphQLConfig): {
+    gqlFetch: <TData>(document: string, variables?: Record<string, unknown>, tags?: string[]) => Promise<TData>;
+    gqlFetchGraceful: <TData>(document: string, fallback: TData, variables?: Record<string, unknown>, tags?: string[]) => Promise<TData>;
+};
+type WPGraphQLFetcher = ReturnType<typeof createWPGraphQLFetcher>;
+
+interface GQLPostFilter {
+    authorName?: string;
+    categoryName?: string;
+    tag?: string;
+    search?: string;
+    status?: string;
+}
+interface GQLPost {
+    id: string;
+    databaseId: number;
+    slug: string;
+    title: string;
+    content: string;
+    excerpt: string;
+    date: string;
+    modified: string;
+    status: string;
+    uri: string;
+    author?: {
+        node: {
+            databaseId: number;
+            name: string;
+            slug: string;
+            avatar?: {
+                url: string;
+            };
+        };
+    };
+    featuredImage?: {
+        node: {
+            sourceUrl: string;
+            altText: string;
+            mediaDetails?: {
+                width: number;
+                height: number;
+            };
+        };
+    };
+    categories?: {
+        nodes: Array<{
+            databaseId: number;
+            name: string;
+            slug: string;
+        }>;
+    };
+    tags?: {
+        nodes: Array<{
+            databaseId: number;
+            name: string;
+            slug: string;
+        }>;
+    };
+}
+
+interface GQLPage {
+    id: string;
+    databaseId: number;
+    slug: string;
+    title: string;
+    content: string;
+    date: string;
+    modified: string;
+    status: string;
+    uri: string;
+    featuredImage?: {
+        node: {
+            sourceUrl: string;
+            altText: string;
+            mediaDetails?: {
+                width: number;
+                height: number;
+            };
+        };
+    };
+}
+
+interface GQLCategory {
+    id: string;
+    databaseId: number;
+    name: string;
+    slug: string;
+    description: string;
+    count: number | null;
+    uri: string;
+    parent?: {
+        node: {
+            databaseId: number;
+            name: string;
+            slug: string;
+        };
+    };
+}
+
+interface GQLTag {
+    id: string;
+    databaseId: number;
+    name: string;
+    slug: string;
+    description: string;
+    count: number;
+    uri: string;
+}
+
+interface GQLAuthor {
+    id: string;
+    databaseId: number;
+    name: string;
+    slug: string;
+    description: string;
+    email: string;
+    uri: string;
+    avatar?: {
+        url: string;
+        width: number;
+        height: number;
+    };
+}
+
+interface GQLMenuItem {
+    id: string;
+    databaseId: number;
+    label: string;
+    url: string;
+    parentId: string | null;
+    order: number;
+    target: string;
+    cssClasses: string[];
+    description: string;
+    connectedNode?: {
+        node: {
+            __typename: string;
+            id?: string;
+            databaseId?: number;
+            slug?: string;
+        };
+    };
+}
+interface GQLMenu {
+    id: string;
+    databaseId: number;
+    name: string;
+    slug: string;
+    locations: string[];
+    menuItems?: {
+        nodes: GQLMenuItem[];
+    };
+}
+
+interface GQLCommentAuthor {
+    name: string;
+    url: string;
+    avatar?: {
+        url: string;
+        width: number;
+        height: number;
+    };
+}
+interface GQLComment {
+    id: string;
+    databaseId: number;
+    content: string;
+    date: string;
+    parentId: string | null;
+    status: string;
+    author: {
+        node: GQLCommentAuthor;
+    };
+    replies?: {
+        nodes: GQLComment[];
+    };
+}
+
+declare function createWPGraphQLCoreClient(config: WPGraphQLConfig): {
+    getCommentsByPostId: (postId: number, first?: number, after?: string) => Promise<{
+        nodes: GQLComment[];
+        pageInfo: {
+            hasNextPage: boolean;
+            endCursor?: string;
+        };
+    }>;
+    getAllCommentsByPostId: (postId: number) => Promise<GQLComment[]>;
+    getCommentById: (id: number) => Promise<GQLComment | null>;
+    getMenus: () => Promise<GQLMenu[]>;
+    getMenuById: (id: number) => Promise<GQLMenu | null>;
+    getMenuBySlug: (slug: string) => Promise<GQLMenu | null>;
+    getMenuByLocation: (location: string) => Promise<GQLMenu | null>;
+    getMenuItems: (menuSlug: string) => Promise<GQLMenuItem[]>;
+    getAuthors: (first?: number, after?: string) => Promise<GQLConnection<GQLAuthor>>;
+    getAuthorBySlug: (slug: string) => Promise<GQLAuthor | null>;
+    getTags: (first?: number, after?: string) => Promise<GQLConnection<GQLTag>>;
+    getTagBySlug: (slug: string) => Promise<GQLTag | null>;
+    getCategories: (first?: number, after?: string) => Promise<GQLConnection<GQLCategory>>;
+    getCategoryBySlug: (slug: string) => Promise<GQLCategory | null>;
+    getCategoryByDatabaseId: (id: number) => Promise<GQLCategory | null>;
+    getPages: (first?: number, after?: string) => Promise<GQLConnection<GQLPage>>;
+    getPageBySlug: (slug: string) => Promise<GQLPage | null>;
+    getPageByUri: (uri: string) => Promise<GQLPage | null>;
+    getAllPageUris: () => Promise<{
+        uri: string;
+    }[]>;
+    getPosts: (first?: number, after?: string, filter?: GQLPostFilter) => Promise<GQLConnection<GQLPost>>;
+    getPostBySlug: (slug: string) => Promise<GQLPost | null>;
+    getPostByDatabaseId: (id: number) => Promise<GQLPost | null>;
+    getRecentPosts: (first?: number) => Promise<GQLPost[]>;
+    getAllPostSlugs: () => Promise<{
+        slug: string;
+    }[]>;
+    getAllPostsForSitemap: () => Promise<{
+        slug: string;
+        modified: string;
+    }[]>;
+};
+
+interface GQLYoastSEO {
+    title: string;
+    metaDesc: string;
+    canonical: string;
+    opengraphTitle: string;
+    opengraphDescription: string;
+    opengraphImage?: {
+        sourceUrl: string;
+        altText: string;
+    };
+    twitterTitle: string;
+    twitterDescription: string;
+    twitterImage?: {
+        sourceUrl: string;
+    };
+    schema?: {
+        raw: string;
+    };
+}
+interface GQLPostWithSEO extends GQLPost {
+    seo: GQLYoastSEO;
+}
+interface GQLPageWithSEO extends GQLPage {
+    seo: GQLYoastSEO;
+}
+
+declare function createYoastQueries(fetcher: WPGraphQLFetcher): {
+    getPostWithSEO: (slug: string) => Promise<GQLPostWithSEO | null>;
+    getPageWithSEO: (slug: string) => Promise<GQLPageWithSEO | null>;
+    getPageWithSEOByUri: (uri: string) => Promise<GQLPageWithSEO | null>;
+};
+
+interface GQLACFFieldGroup {
+    [key: string]: unknown;
+}
+
+declare function buildACFFragment(fieldGroupName: string, fields: string[]): string;
+declare function buildPostWithACFQuery(fieldGroupName: string, fields: string[]): string;
+declare function buildPageWithACFQuery(fieldGroupName: string, fields: string[]): string;
+declare function buildPostsWithACFQuery(fieldGroupName: string, fields: string[]): string;
+
+interface GQLProductFilter {
+    search?: string;
+    categoryId?: number;
+    tagId?: number;
+    onSale?: boolean;
+    featured?: boolean;
+    stockStatus?: 'IN_STOCK' | 'OUT_OF_STOCK' | 'ON_BACKORDER';
+    minPrice?: string;
+    maxPrice?: string;
+}
+interface GQLProductVariation {
+    id: string;
+    databaseId: number;
+    slug: string;
+    sku: string;
+    price: string;
+    regularPrice: string;
+    salePrice?: string;
+    onSale: boolean;
+    stockStatus: 'IN_STOCK' | 'OUT_OF_STOCK' | 'ON_BACKORDER';
+    stockQuantity?: number;
+    image?: {
+        sourceUrl: string;
+        altText: string;
+    };
+    attributes?: {
+        nodes: Array<{
+            name: string;
+            value: string;
+        }>;
+    };
+}
+interface GQLProduct {
+    id: string;
+    databaseId: number;
+    slug: string;
+    name: string;
+    description: string;
+    shortDescription: string;
+    sku: string;
+    price: string;
+    regularPrice: string;
+    salePrice?: string;
+    onSale: boolean;
+    stockStatus: 'IN_STOCK' | 'OUT_OF_STOCK' | 'ON_BACKORDER';
+    stockQuantity?: number;
+    manageStock: boolean;
+    type: 'SIMPLE' | 'VARIABLE' | 'GROUPED' | 'EXTERNAL';
+    featuredImage?: {
+        node: {
+            sourceUrl: string;
+            altText: string;
+        };
+    };
+    galleryImages?: {
+        nodes: Array<{
+            sourceUrl: string;
+            altText: string;
+        }>;
+    };
+    productCategories?: {
+        nodes: Array<{
+            databaseId: number;
+            name: string;
+            slug: string;
+        }>;
+    };
+    productTags?: {
+        nodes: Array<{
+            databaseId: number;
+            name: string;
+            slug: string;
+        }>;
+    };
+    variations?: {
+        nodes: GQLProductVariation[];
+    };
+}
+
+interface GQLLineItem {
+    productId: number;
+    variationId?: number;
+    quantity: number;
+    subtotal: string;
+    total: string;
+    product?: {
+        node: {
+            databaseId: number;
+            name: string;
+            slug: string;
+        };
+    };
+}
+interface GQLOrderAddress {
+    firstName: string;
+    lastName: string;
+    address1: string;
+    address2?: string;
+    city: string;
+    postcode: string;
+    country: string;
+    email?: string;
+    phone?: string;
+}
+interface GQLOrder {
+    id: string;
+    databaseId: number;
+    orderNumber: string;
+    status: string;
+    date: string;
+    modified: string;
+    total: string;
+    subtotal: string;
+    totalTax: string;
+    shippingTotal: string;
+    currency: string;
+    billing?: GQLOrderAddress;
+    shipping?: GQLOrderAddress;
+    lineItems?: {
+        nodes: GQLLineItem[];
+    };
+}
+
+interface GQLCustomer {
+    id: string;
+    databaseId: number;
+    email: string;
+    firstName: string;
+    lastName: string;
+    username: string;
+    billing?: {
+        firstName: string;
+        lastName: string;
+        address1: string;
+        address2?: string;
+        city: string;
+        postcode: string;
+        country: string;
+        phone?: string;
+    };
+    shipping?: {
+        firstName: string;
+        lastName: string;
+        address1: string;
+        address2?: string;
+        city: string;
+        postcode: string;
+        country: string;
+    };
+}
+
+declare function createWPGraphQLWooCommerceClient(config: WPGraphQLConfig): {
+    getCustomer: () => Promise<GQLCustomer | null>;
+    getCustomerById: (id: number) => Promise<GQLCustomer | null>;
+    getOrder: (id: number) => Promise<GQLOrder | null>;
+    getMyOrders: (first?: number, after?: string) => Promise<GQLConnection<GQLOrder>>;
+    getProducts: (first?: number, after?: string, filter?: GQLProductFilter) => Promise<GQLConnection<GQLProduct>>;
+    getProductBySlug: (slug: string) => Promise<GQLProduct | null>;
+    getProductByDatabaseId: (id: number) => Promise<GQLProduct | null>;
+    getFeaturedProducts: (first?: number) => Promise<GQLProduct[]>;
+    getOnSaleProducts: (first?: number) => Promise<GQLProduct[]>;
+    getAllProductSlugs: () => Promise<{
+        slug: string;
+    }[]>;
+};
+
+interface GQLCPTNode {
+    id: string;
+    databaseId: number;
+    slug: string;
+    title: string;
+    date: string;
+    modified: string;
+    status: string;
+    uri: string;
+    [key: string]: unknown;
+}
+
+declare function createCPTQueries(fetcher: WPGraphQLFetcher, typeName: string, singularTypeName: string, extraFields?: string): {
+    getItems: (first?: number, after?: string) => Promise<GQLConnection<GQLCPTNode>>;
+    getItemBySlug: (slug: string) => Promise<GQLCPTNode | null>;
+    getAllSlugs: () => Promise<{
+        slug: string;
+    }[]>;
+};
+
+export { type Author, type BlockType, type Category, type Comment, type CommentAuthorAvatar, type CreateCommentInput, type EditorBlock, type EmbeddedAuthor, type EmbeddedTerm, type FeaturedMedia, type GQLACFFieldGroup, type GQLAuthor, type GQLCPTNode, type GQLCategory, type GQLConnection, type GQLCustomer, type GQLError, type GQLLineItem, type GQLOrder, type GQLOrderAddress, type GQLPage, type GQLPageInfo, type GQLPageWithSEO, type GQLPost, type GQLPostFilter, type GQLPostWithSEO, type GQLProduct, type GQLProductFilter, type GQLProductVariation, type GQLTag, type GQLYoastSEO, type MediaDetails, type MediaSize, type Menu, type MenuItem, type MenuLocation, type MenuWithItems, type NextWordpressConfig, type OmnibusPriceEntry, type OmnibusProductData, type Page, type Post, type PostEmbedded, type RenderedContent, type RenderedTitle, type SearchResult, type Tag, type Taxonomy, type TemplatePart, type WCAddress, type WCCoupon, type WCCreateOrderInput, type WCCustomer, type WCDimensions, type WCImage, type WCOrder, type WCOrderLineItem, type WCProduct, type WCProductAttribute, type WCProductCategory, type WCProductDefaultAttribute, type WCProductFilterParams, type WCProductTag, type WCProductVariation, type WCProductVariationWithOmnibus, type WCProductWithOmnibus, type WCShippingLine, type WPEntity, type WPGraphQLConfig, WPGraphQLError, type WPGraphQLFetcher, type WooCommerceConfig, type WooCommerceFetcher, type WooCommercePaginationHeaders, type WooCommerceResponse, buildACFFragment, buildPageWithACFQuery, buildPostWithACFQuery, buildPostsWithACFQuery, createCPTQueries, createWPGraphQLCoreClient as createWPGraphQLClient, createWPGraphQLCoreClient, createWPGraphQLFetcher, createWPGraphQLWooCommerceClient, createWooCommerceClient, createWooCommerceFetcher, createWordPressClient, createYoastQueries, extractOmnibusData, resolveBaseUrl, withOmnibus, withOmnibusVariation };