@szymonpiatek/nextwordpress 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,697 @@
+interface NextWordpressConfig {
+    /** Used in server components / SSR (e.g., internal Docker hostname). */
+    serverURL: string;
+    /** 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;
+    date_gmt: string;
+    modified: string;
+    modified_gmt: string;
+    slug: string;
+    status: 'publish' | 'future' | 'draft' | 'pending' | 'private';
+    link: string;
+    guid: {
+        rendered: string;
+    };
+}
+interface RenderedContent {
+    rendered: string;
+    protected: boolean;
+}
+interface RenderedTitle {
+    rendered: string;
+}
+interface Taxonomy {
+    id: number;
+    count: number;
+    description: string;
+    link: string;
+    name: string;
+    slug: string;
+    meta: Record<string, unknown>;
+}
+
+interface MediaSize {
+    file: string;
+    width: number;
+    height: number;
+    mime_type: string;
+    source_url: string;
+}
+interface MediaDetails {
+    width: number;
+    height: number;
+    file: string;
+    sizes: Record<string, MediaSize>;
+}
+interface FeaturedMedia extends WPEntity {
+    title: RenderedTitle;
+    author: number;
+    caption: {
+        rendered: string;
+    };
+    alt_text: string;
+    media_type: string;
+    mime_type: string;
+    media_details: MediaDetails;
+    source_url: string;
+}
+
+interface Author {
+    id: number;
+    name: string;
+    url: string;
+    description: string;
+    link: string;
+    slug: string;
+    avatar_urls: Record<string, string>;
+    meta: Record<string, unknown>;
+}
+interface EmbeddedAuthor {
+    id: number;
+    name: string;
+    slug: string;
+    avatar_urls: Record<string, string>;
+}
+interface EmbeddedTerm {
+    id: number;
+    name: string;
+    slug: string;
+}
+
+interface BlockSupports {
+    align?: boolean | string[];
+    anchor?: boolean;
+    className?: boolean;
+    color?: {
+        background?: boolean;
+        gradients?: boolean;
+        text?: boolean;
+    };
+    spacing?: {
+        margin?: boolean;
+        padding?: boolean;
+    };
+    typography?: {
+        fontSize?: boolean;
+        lineHeight?: boolean;
+    };
+    [key: string]: unknown;
+}
+interface BlockStyle {
+    name: string;
+    label: string;
+    isDefault: boolean;
+}
+interface BlockType {
+    api_version: number;
+    title: string;
+    name: string;
+    description: string;
+    icon: string;
+    category: string;
+    keywords: string[];
+    parent: string[];
+    supports: BlockSupports;
+    styles: BlockStyle[];
+    textdomain: string;
+    example: Record<string, unknown>;
+    attributes: Record<string, unknown>;
+    provides_context: Record<string, string>;
+    uses_context: string[];
+    editor_script: string;
+    script: string;
+    editor_style: string;
+    style: string;
+}
+interface EditorBlock {
+    id: string;
+    name: string;
+    attributes: Record<string, unknown>;
+    innerBlocks: EditorBlock[];
+    innerHTML: string;
+    innerContent: (string | null)[];
+}
+interface TemplatePart {
+    id: string;
+    slug: string;
+    theme: string;
+    type: string;
+    source: string;
+    origin: string;
+    content: string | EditorBlock[];
+    title: {
+        raw: string;
+        rendered: string;
+    };
+    description: string;
+    status: 'publish' | 'future' | 'draft' | 'pending' | 'private';
+    wp_id: number;
+    has_theme_file: boolean;
+    author: number;
+    area: string;
+}
+interface SearchResult {
+    id: number;
+    title: string;
+    url: string;
+    type: string;
+    subtype: string;
+    _links: {
+        self: Array<{
+            embeddable: boolean;
+            href: string;
+        }>;
+        about: Array<{
+            href: string;
+        }>;
+    };
+}
+
+interface PostEmbedded {
+    author?: EmbeddedAuthor[];
+    'wp:featuredmedia'?: FeaturedMedia[];
+    'wp:term'?: EmbeddedTerm[][];
+}
+interface Post extends WPEntity {
+    title: RenderedTitle;
+    content: RenderedContent;
+    excerpt: RenderedContent;
+    author: number;
+    featured_media: number;
+    comment_status: 'open' | 'closed';
+    ping_status: 'open' | 'closed';
+    sticky: boolean;
+    template: string;
+    format: 'standard' | 'aside' | 'chat' | 'gallery' | 'link' | 'image' | 'quote' | 'status' | 'video' | 'audio';
+    categories: number[];
+    tags: number[];
+    meta: Record<string, unknown>;
+    blocks?: EditorBlock[];
+    _embedded?: PostEmbedded;
+}
+
+interface Category extends Taxonomy {
+    taxonomy: 'category';
+    parent: number;
+}
+
+interface Tag extends Taxonomy {
+    taxonomy: 'post_tag';
+}
+
+interface Page extends WPEntity {
+    title: RenderedTitle;
+    content: RenderedContent;
+    excerpt: RenderedContent;
+    author: number;
+    featured_media: number;
+    parent: number;
+    menu_order: number;
+    comment_status: 'open' | 'closed';
+    ping_status: 'open' | 'closed';
+    template: string;
+    meta: Record<string, unknown>;
+}
+
+declare function createWordPressClient(config: NextWordpressConfig): {
+    getAllPages: () => Promise<Page[]>;
+    getPageById: (id: number) => Promise<Page>;
+    getPageBySlug: (slug: string) => Promise<Page | undefined>;
+    getFeaturedMediaById: (id: number) => Promise<FeaturedMedia>;
+    getAllAuthors: () => Promise<Author[]>;
+    getAuthorById: (id: number) => Promise<Author>;
+    getAuthorBySlug: (slug: string) => Promise<Author>;
+    searchAuthors: (query: string) => Promise<Author[]>;
+    getAllTags: () => Promise<Tag[]>;
+    getTagById: (id: number) => Promise<Tag>;
+    getTagBySlug: (slug: string) => Promise<Tag>;
+    getTagsByPost: (postId: number) => Promise<Tag[]>;
+    searchTags: (query: string) => Promise<Tag[]>;
+    getAllCategories: () => Promise<Category[]>;
+    getCategoryById: (id: number) => Promise<Category>;
+    getCategoryBySlug: (slug: string) => Promise<Category>;
+    searchCategories: (query: string) => Promise<Category[]>;
+    getPostsPaginated: (page?: number, perPage?: number, filterParams?: {
+        author?: string;
+        tag?: string;
+        category?: string;
+        search?: string;
+    }) => Promise<WordPressResponse<Post[]>>;
+    getRecentPosts: (filterParams?: {
+        author?: string;
+        tag?: string;
+        category?: string;
+        search?: string;
+    }) => Promise<Post[]>;
+    getPostById: (id: number) => Promise<Post>;
+    getPostBySlug: (slug: string) => Promise<Post | undefined>;
+    getPostsByCategory: (categoryId: number) => Promise<Post[]>;
+    getPostsByTag: (tagId: number) => Promise<Post[]>;
+    getPostsByAuthor: (authorId: number) => Promise<Post[]>;
+    getPostsByCategoryPaginated: (categoryId: number, page?: number, perPage?: number) => Promise<WordPressResponse<Post[]>>;
+    getPostsByTagPaginated: (tagId: number, page?: number, perPage?: number) => Promise<WordPressResponse<Post[]>>;
+    getPostsByAuthorPaginated: (authorId: number, page?: number, perPage?: number) => Promise<WordPressResponse<Post[]>>;
+    getAllPostSlugs: () => Promise<{
+        slug: string;
+    }[]>;
+    getAllPostsForSitemap: () => Promise<{
+        slug: string;
+        modified: string;
+    }[]>;
+};
+
+interface WooCommerceConfig {
+    serverURL: string;
+    consumerKey: string;
+    consumerSecret: string;
+    cacheTTL?: number;
+}
+interface WooCommercePaginationHeaders {
+    total: number;
+    totalPages: number;
+}
+interface WooCommerceResponse<T> {
+    data: T;
+    headers: WooCommercePaginationHeaders;
+}
+
+declare function createWooCommerceFetcher(config: WooCommerceConfig): {
+    wcFetch: <T>(path: string, query?: Record<string, unknown>, tags?: string[], options?: RequestInit) => Promise<T>;
+    wcFetchGraceful: <T>(path: string, fallback: T, query?: Record<string, unknown>, tags?: string[]) => Promise<T>;
+    wcFetchPaginated: <T>(path: string, query?: Record<string, unknown>, tags?: string[]) => Promise<WooCommerceResponse<T[]>>;
+    wcFetchPaginatedGraceful: <T>(path: string, query?: Record<string, unknown>, tags?: string[]) => Promise<WooCommerceResponse<T[]>>;
+    wcMutate: <T>(path: string, body: unknown, method?: "POST" | "PUT" | "PATCH" | "DELETE") => Promise<T>;
+};
+type WooCommerceFetcher = ReturnType<typeof createWooCommerceFetcher>;
+
+interface WCImage {
+    id: number;
+    src: string;
+    name: string;
+    alt: string;
+}
+interface WCDimensions {
+    length: string;
+    width: string;
+    height: string;
+}
+interface WCAddress {
+    first_name: string;
+    last_name: string;
+    company: string;
+    address_1: string;
+    address_2: string;
+    city: string;
+    state: string;
+    postcode: string;
+    country: string;
+    email?: string;
+    phone?: string;
+}
+
+interface WCProductCategory {
+    id: number;
+    name: string;
+    slug: string;
+    parent: number;
+    description: string;
+    display: string;
+    image: WCImage | null;
+    menu_order: number;
+    count: number;
+}
+
+interface WCProductAttribute {
+    id: number;
+    name: string;
+    position: number;
+    visible: boolean;
+    variation: boolean;
+    options: string[];
+}
+interface WCProductDefaultAttribute {
+    id: number;
+    name: string;
+    option: string;
+}
+interface WCProductVariation {
+    id: number;
+    date_created: string;
+    date_modified: string;
+    description: string;
+    permalink: string;
+    sku: string;
+    price: string;
+    regular_price: string;
+    sale_price: string;
+    on_sale: boolean;
+    purchasable: boolean;
+    stock_quantity: number | null;
+    stock_status: 'instock' | 'outofstock' | 'onbackorder';
+    manage_stock: boolean;
+    backorders: 'no' | 'notify' | 'yes';
+    backorders_allowed: boolean;
+    backordered: boolean;
+    weight: string;
+    dimensions: WCDimensions;
+    image: WCImage | null;
+    attributes: Array<{
+        id: number;
+        name: string;
+        option: string;
+    }>;
+}
+interface WCProduct {
+    id: number;
+    name: string;
+    slug: string;
+    permalink: string;
+    date_created: string;
+    date_modified: string;
+    type: 'simple' | 'grouped' | 'external' | 'variable';
+    status: 'draft' | 'pending' | 'private' | 'publish';
+    featured: boolean;
+    catalog_visibility: 'visible' | 'catalog' | 'search' | 'hidden';
+    description: string;
+    short_description: string;
+    sku: string;
+    price: string;
+    regular_price: string;
+    sale_price: string;
+    on_sale: boolean;
+    purchasable: boolean;
+    total_sales: number;
+    virtual: boolean;
+    downloadable: boolean;
+    tax_status: 'taxable' | 'shipping' | 'none';
+    tax_class: string;
+    manage_stock: boolean;
+    stock_quantity: number | null;
+    stock_status: 'instock' | 'outofstock' | 'onbackorder';
+    backorders: 'no' | 'notify' | 'yes';
+    backorders_allowed: boolean;
+    backordered: boolean;
+    sold_individually: boolean;
+    weight: string;
+    dimensions: WCDimensions;
+    shipping_required: boolean;
+    shipping_taxable: boolean;
+    shipping_class: string;
+    shipping_class_id: number;
+    reviews_allowed: boolean;
+    average_rating: string;
+    rating_count: number;
+    related_ids: number[];
+    upsell_ids: number[];
+    cross_sell_ids: number[];
+    parent_id: number;
+    categories: Array<{
+        id: number;
+        name: string;
+        slug: string;
+    }>;
+    tags: Array<{
+        id: number;
+        name: string;
+        slug: string;
+    }>;
+    images: WCImage[];
+    attributes: WCProductAttribute[];
+    default_attributes: WCProductDefaultAttribute[];
+    variations: number[];
+    grouped_products: number[];
+    menu_order: number;
+    meta_data: Array<{
+        id: number;
+        key: string;
+        value: unknown;
+    }>;
+}
+interface WCProductFilterParams {
+    category?: string;
+    tag?: string;
+    featured?: boolean;
+    on_sale?: boolean;
+    min_price?: string;
+    max_price?: string;
+    search?: string;
+    orderby?: 'date' | 'id' | 'include' | 'title' | 'slug' | 'price' | 'popularity' | 'rating';
+    order?: 'asc' | 'desc';
+    stock_status?: 'instock' | 'outofstock' | 'onbackorder';
+    type?: WCProduct['type'];
+}
+
+interface WCProductTag {
+    id: number;
+    name: string;
+    slug: string;
+    description: string;
+    count: number;
+}
+
+interface WCOrderLineItem {
+    id: number;
+    name: string;
+    product_id: number;
+    variation_id: number;
+    quantity: number;
+    sku: string;
+    price: number;
+    subtotal: string;
+    subtotal_tax: string;
+    total: string;
+    total_tax: string;
+    taxes: Array<{
+        id: number;
+        total: string;
+        subtotal: string;
+    }>;
+    meta_data: Array<{
+        id: number;
+        key: string;
+        value: unknown;
+        display_key: string;
+        display_value: string;
+    }>;
+    image: {
+        id: string;
+        src: string;
+    } | null;
+}
+interface WCShippingLine {
+    id: number;
+    method_title: string;
+    method_id: string;
+    instance_id: string;
+    total: string;
+    total_tax: string;
+    taxes: Array<{
+        id: number;
+        total: string;
+    }>;
+    meta_data: Array<{
+        id: number;
+        key: string;
+        value: unknown;
+    }>;
+}
+interface WCOrder {
+    id: number;
+    parent_id: number;
+    status: 'pending' | 'processing' | 'on-hold' | 'completed' | 'cancelled' | 'refunded' | 'failed' | 'trash';
+    currency: string;
+    date_created: string;
+    date_modified: string;
+    discount_total: string;
+    discount_tax: string;
+    shipping_total: string;
+    shipping_tax: string;
+    cart_tax: string;
+    total: string;
+    total_tax: string;
+    customer_id: number;
+    order_key: string;
+    billing: WCAddress;
+    shipping: WCAddress;
+    payment_method: string;
+    payment_method_title: string;
+    transaction_id: string;
+    customer_note: string;
+    line_items: WCOrderLineItem[];
+    shipping_lines: WCShippingLine[];
+    meta_data: Array<{
+        id: number;
+        key: string;
+        value: unknown;
+    }>;
+}
+interface WCCreateOrderInput {
+    status?: WCOrder['status'];
+    payment_method?: string;
+    payment_method_title?: string;
+    customer_id?: number;
+    customer_note?: string;
+    billing?: Partial<WCAddress>;
+    shipping?: Partial<WCAddress>;
+    line_items: Array<{
+        product_id: number;
+        variation_id?: number;
+        quantity: number;
+    }>;
+    coupon_lines?: Array<{
+        code: string;
+    }>;
+    shipping_lines?: Array<{
+        method_id: string;
+        method_title: string;
+        total: string;
+    }>;
+    meta_data?: Array<{
+        key: string;
+        value: unknown;
+    }>;
+    set_paid?: boolean;
+}
+
+interface WCCoupon {
+    id: number;
+    code: string;
+    discount_type: 'percent' | 'fixed_cart' | 'fixed_product';
+    amount: string;
+    date_expires: string | null;
+    usage_count: number;
+    individual_use: boolean;
+    product_ids: number[];
+    excluded_product_ids: number[];
+    usage_limit: number | null;
+    usage_limit_per_user: number | null;
+    free_shipping: boolean;
+    minimum_amount: string;
+    maximum_amount: string;
+    description: string;
+}
+
+interface WCCustomer {
+    id: number;
+    date_created: string;
+    date_modified: string;
+    email: string;
+    first_name: string;
+    last_name: string;
+    role: string;
+    username: string;
+    billing: WCAddress;
+    shipping: Omit<WCAddress, 'email' | 'phone'>;
+    is_paying_customer: boolean;
+    avatar_url: string;
+    orders_count: number;
+    total_spent: string;
+    meta_data: Array<{
+        id: number;
+        key: string;
+        value: unknown;
+    }>;
+}
+
+interface OmnibusPriceEntry {
+    price: string;
+    date: string;
+}
+interface OmnibusProductData {
+    lowestPrice: string | null;
+    priceHistory: OmnibusPriceEntry[];
+}
+type WCProductWithOmnibus = WCProduct & {
+    omnibus: OmnibusProductData;
+};
+type WCProductVariationWithOmnibus = WCProductVariation & {
+    omnibus: OmnibusProductData;
+};
+
+declare function extractOmnibusData(meta_data: Array<{
+    id: number;
+    key: string;
+    value: unknown;
+}>): OmnibusProductData;
+declare function withOmnibus(product: WCProduct): WCProductWithOmnibus;
+declare function withOmnibusVariation(variation: WCProductVariation & {
+    meta_data?: Array<{
+        id: number;
+        key: string;
+        value: unknown;
+    }>;
+}): WCProductVariationWithOmnibus;
+
+declare function createWooCommerceClient(config: WooCommerceConfig): {
+    getCustomerById: (id: number) => Promise<WCCustomer>;
+    getCustomerByEmail: (email: string) => Promise<WCCustomer | undefined>;
+    getCustomerByEmailNoCache: (email: string) => Promise<WCCustomer | undefined>;
+    createCustomer: (data: Pick<WCCustomer, "email" | "first_name" | "last_name"> & {
+        username?: string;
+        password?: string;
+        billing?: Partial<WCAddress>;
+        shipping?: Partial<Omit<WCAddress, "email" | "phone">>;
+    }) => Promise<WCCustomer>;
+    getCouponByCode: (code: string) => Promise<WCCoupon | undefined>;
+    validateCoupon: (code: string) => Promise<{
+        valid: boolean;
+        coupon?: WCCoupon;
+        reason?: string;
+    }>;
+    createOrder: (input: WCCreateOrderInput) => Promise<WCOrder>;
+    getOrderById: (id: number) => Promise<WCOrder>;
+    updateOrder: (id: number, data: Partial<WCCreateOrderInput>) => Promise<WCOrder>;
+    getOrdersByCustomer: (customerId: number) => Promise<WCOrder[]>;
+    getAllProductTags: () => Promise<WCProductTag[]>;
+    getProductTagById: (id: number) => Promise<WCProductTag>;
+    getProductsByTag: (tagId: number, limit?: number) => Promise<WCProduct[]>;
+    getAllProductCategories: () => Promise<WCProductCategory[]>;
+    getProductCategoryById: (id: number) => Promise<WCProductCategory>;
+    getProductCategoryBySlug: (slug: string) => Promise<WCProductCategory | undefined>;
+    getProductsByCategory: (categoryId: number, limit?: number) => Promise<WCProduct[]>;
+    getProductsByCategorySlug: (categorySlug: string) => Promise<WCProduct[]>;
+    getProducts: (filterParams?: WCProductFilterParams) => Promise<WCProduct[]>;
+    getProductsPaginated: (page?: number, perPage?: number, filterParams?: WCProductFilterParams) => Promise<WooCommerceResponse<WCProduct[]>>;
+    getProductById: (id: number) => Promise<WCProduct>;
+    getProductBySlug: (slug: string) => Promise<WCProduct | undefined>;
+    getFeaturedProducts: (limit?: number) => Promise<WCProduct[]>;
+    getOnSaleProducts: (limit?: number) => Promise<WCProduct[]>;
+    getRelatedProducts: (productId: number) => Promise<WCProduct[]>;
+    getAllProductSlugs: () => Promise<{
+        slug: string;
+    }[]>;
+    getProductVariations: (productId: number) => Promise<WCProductVariation[]>;
+    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 };