@szymonpiatek/nextwordpress 0.0.7 → 0.0.9

package/dist/{types-Be60n09c.d.cts → types-Dxb6tuW_.d.cts}

@@ -1,3 +1,33 @@
+declare const ErrorCode: {
+    readonly WP_REQUEST_FAILED: "WP_REQUEST_FAILED";
+    readonly WP_NOT_FOUND: "WP_NOT_FOUND";
+    readonly WP_UNAUTHORIZED: "WP_UNAUTHORIZED";
+    readonly WP_FORBIDDEN: "WP_FORBIDDEN";
+    readonly GQL_REQUEST_FAILED: "GQL_REQUEST_FAILED";
+    readonly GQL_NO_DATA: "GQL_NO_DATA";
+    readonly GQL_ERRORS_IN_RESPONSE: "GQL_ERRORS_IN_RESPONSE";
+    readonly WOO_REQUEST_FAILED: "WOO_REQUEST_FAILED";
+    readonly WOO_NOT_FOUND: "WOO_NOT_FOUND";
+    readonly WOO_UNAUTHORIZED: "WOO_UNAUTHORIZED";
+    readonly WOO_FORBIDDEN: "WOO_FORBIDDEN";
+    readonly WOO_COUPON_NOT_FOUND: "WOO_COUPON_NOT_FOUND";
+    readonly WOO_PRODUCT_NOT_FOUND: "WOO_PRODUCT_NOT_FOUND";
+    readonly WOO_ORDER_NOT_FOUND: "WOO_ORDER_NOT_FOUND";
+    readonly WOO_CUSTOMER_NOT_FOUND: "WOO_CUSTOMER_NOT_FOUND";
+    readonly WOO_CATEGORY_NOT_FOUND: "WOO_CATEGORY_NOT_FOUND";
+    readonly WOO_TAG_NOT_FOUND: "WOO_TAG_NOT_FOUND";
+    readonly WOO_REVIEW_NOT_FOUND: "WOO_REVIEW_NOT_FOUND";
+    readonly WOO_WEBHOOK_NOT_FOUND: "WOO_WEBHOOK_NOT_FOUND";
+    readonly WOO_SHIPPING_ZONE_NOT_FOUND: "WOO_SHIPPING_ZONE_NOT_FOUND";
+    readonly AUTH_JWT_FAILED: "AUTH_JWT_FAILED";
+    readonly AUTH_CREDENTIALS_INVALID: "AUTH_CREDENTIALS_INVALID";
+    readonly AUTH_TOKEN_INVALID: "AUTH_TOKEN_INVALID";
+};
+type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
+declare const defaultMessages: Record<ErrorCode, string>;
+declare const defaultMessagesPl: Record<ErrorCode, string>;
+declare function resolveMessage(code: ErrorCode, overrides?: Partial<Record<ErrorCode, string>>): string;
+
 interface NextWordpressConfig {
     /** Used in server components / SSR (e.g., internal Docker hostname). */
     serverURL: string;
@@ -5,6 +35,8 @@ interface NextWordpressConfig {
     clientURL: string;
     /** Cache TTL in seconds for Next.js ISR revalidation (default: 300). */
     cacheTTL?: number;
+    /** Override default error messages by error code. */
+    errorMessages?: Partial<Record<ErrorCode, string>>;
 }
 interface WPEntity {
     id: number;
@@ -47,8 +79,9 @@ interface JwtAuthResponse {
     user_display_name: string;
 }
 declare class AuthenticationError extends Error {
-    status: number;
-    constructor(message: string, status: number);
+    readonly code: ErrorCode;
+    readonly status: number;
+    constructor(code: ErrorCode, status: number, message: string, detail?: string);
 }
 
 interface MediaSize {
@@ -219,6 +252,12 @@ interface WordPressResponse<T> {
     data: T;
     headers: WordPressPaginationHeaders;
 }
+declare class WordPressAPIError extends Error {
+    readonly code: ErrorCode;
+    readonly status: number;
+    readonly endpoint: string;
+    constructor(code: ErrorCode, status: number, endpoint: string, message: string, detail?: string);
+}
 
 interface WooCommerceConfig {
     serverURL: string;
@@ -226,6 +265,8 @@ interface WooCommerceConfig {
     consumerKey: string;
     consumerSecret: string;
     cacheTTL?: number;
+    /** Override default error messages by error code. */
+    errorMessages?: Partial<Record<ErrorCode, string>>;
 }
 interface WooCommercePaginationHeaders {
     total: number;
@@ -235,6 +276,13 @@ interface WooCommerceResponse<T> {
     data: T;
     headers: WooCommercePaginationHeaders;
 }
+declare class WooCommerceError extends Error {
+    readonly code: ErrorCode;
+    readonly status: number;
+    readonly endpoint: string;
+    readonly upstreamCode?: string | undefined;
+    constructor(code: ErrorCode, status: number, endpoint: string, message: string, upstreamCode?: string | undefined, detail?: string);
+}
 
 interface WCImage {
     id: number;
@@ -541,10 +589,11 @@ interface GQLError {
     path?: string[];
 }
 declare class WPGraphQLError extends Error {
+    readonly code: ErrorCode;
     readonly status: number;
     readonly endpoint: string;
     readonly gqlErrors?: GQLError[] | undefined;
-    constructor(message: string, status: number, endpoint: string, gqlErrors?: GQLError[] | undefined);
+    constructor(code: ErrorCode, status: number, endpoint: string, message: string, gqlErrors?: GQLError[] | undefined);
 }
 
 interface GQLPostFilter {
@@ -601,4 +650,4 @@ interface GQLPost {
     };
 }
 
-export { type Author as A, type BlockType as B, type WCProductAttribute as C, type WCProductDefaultAttribute as D, type EditorBlock as E, type FeaturedMedia as F, type GQLPost as G, type WCShippingLine as H, WPGraphQLError as I, type JwtAuthCredentials as J, type WooCommercePaginationHeaders as K, type MediaDetails as M, type NextWordpressConfig as N, type Post as P, type RenderedTitle as R, type SearchResult as S, type Taxonomy as T, type UpdateCustomerInput as U, type WordPressResponse as W, type WooCommerceConfig as a, type WCProduct as b, type WCProductFilterParams as c, type WooCommerceResponse as d, type WCCreateOrderInput as e, type WCOrder as f, type WCCustomer as g, type WPGraphQLConfig as h, type GQLPostFilter as i, type GQLConnection as j, type JwtAuthResponse as k, type WPEntity as l, type RenderedContent as m, type WCImage as n, type WCProductVariation as o, type WCAddress as p, AuthenticationError as q, type EmbeddedAuthor as r, type EmbeddedTerm as s, type GQLError as t, type GQLPageInfo as u, type MediaSize as v, type PostEmbedded as w, type TemplatePart as x, type WCDimensions as y, type WCOrderLineItem as z };
+export { type Author as A, type BlockType as B, type WCOrderLineItem as C, type WCProductAttribute as D, type EditorBlock as E, type FeaturedMedia as F, type GQLPost as G, type WCProductDefaultAttribute as H, type WCShippingLine as I, type JwtAuthCredentials as J, WPGraphQLError as K, WooCommerceError as L, type MediaDetails as M, type NextWordpressConfig as N, type WooCommercePaginationHeaders as O, type Post as P, WordPressAPIError as Q, type RenderedTitle as R, type SearchResult as S, type Taxonomy as T, type UpdateCustomerInput as U, defaultMessages as V, type WordPressResponse as W, defaultMessagesPl as X, resolveMessage as Y, type WooCommerceConfig as a, type WCProduct as b, type WCProductFilterParams as c, type WooCommerceResponse as d, type WCCreateOrderInput as e, type WCOrder as f, type WCCustomer as g, type WPGraphQLConfig as h, type GQLPostFilter as i, type GQLConnection as j, type JwtAuthResponse as k, type WPEntity as l, type RenderedContent as m, type WCImage as n, type WCProductVariation as o, type WCAddress as p, AuthenticationError as q, type EmbeddedAuthor as r, type EmbeddedTerm as s, ErrorCode as t, type GQLError as u, type GQLPageInfo as v, type MediaSize as w, type PostEmbedded as x, type TemplatePart as y, type WCDimensions as z };

package/dist/{types-Be60n09c.d.ts → types-Dxb6tuW_.d.ts}

@@ -1,3 +1,33 @@
+declare const ErrorCode: {
+    readonly WP_REQUEST_FAILED: "WP_REQUEST_FAILED";
+    readonly WP_NOT_FOUND: "WP_NOT_FOUND";
+    readonly WP_UNAUTHORIZED: "WP_UNAUTHORIZED";
+    readonly WP_FORBIDDEN: "WP_FORBIDDEN";
+    readonly GQL_REQUEST_FAILED: "GQL_REQUEST_FAILED";
+    readonly GQL_NO_DATA: "GQL_NO_DATA";
+    readonly GQL_ERRORS_IN_RESPONSE: "GQL_ERRORS_IN_RESPONSE";
+    readonly WOO_REQUEST_FAILED: "WOO_REQUEST_FAILED";
+    readonly WOO_NOT_FOUND: "WOO_NOT_FOUND";
+    readonly WOO_UNAUTHORIZED: "WOO_UNAUTHORIZED";
+    readonly WOO_FORBIDDEN: "WOO_FORBIDDEN";
+    readonly WOO_COUPON_NOT_FOUND: "WOO_COUPON_NOT_FOUND";
+    readonly WOO_PRODUCT_NOT_FOUND: "WOO_PRODUCT_NOT_FOUND";
+    readonly WOO_ORDER_NOT_FOUND: "WOO_ORDER_NOT_FOUND";
+    readonly WOO_CUSTOMER_NOT_FOUND: "WOO_CUSTOMER_NOT_FOUND";
+    readonly WOO_CATEGORY_NOT_FOUND: "WOO_CATEGORY_NOT_FOUND";
+    readonly WOO_TAG_NOT_FOUND: "WOO_TAG_NOT_FOUND";
+    readonly WOO_REVIEW_NOT_FOUND: "WOO_REVIEW_NOT_FOUND";
+    readonly WOO_WEBHOOK_NOT_FOUND: "WOO_WEBHOOK_NOT_FOUND";
+    readonly WOO_SHIPPING_ZONE_NOT_FOUND: "WOO_SHIPPING_ZONE_NOT_FOUND";
+    readonly AUTH_JWT_FAILED: "AUTH_JWT_FAILED";
+    readonly AUTH_CREDENTIALS_INVALID: "AUTH_CREDENTIALS_INVALID";
+    readonly AUTH_TOKEN_INVALID: "AUTH_TOKEN_INVALID";
+};
+type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
+declare const defaultMessages: Record<ErrorCode, string>;
+declare const defaultMessagesPl: Record<ErrorCode, string>;
+declare function resolveMessage(code: ErrorCode, overrides?: Partial<Record<ErrorCode, string>>): string;
+
 interface NextWordpressConfig {
     /** Used in server components / SSR (e.g., internal Docker hostname). */
     serverURL: string;
@@ -5,6 +35,8 @@ interface NextWordpressConfig {
     clientURL: string;
     /** Cache TTL in seconds for Next.js ISR revalidation (default: 300). */
     cacheTTL?: number;
+    /** Override default error messages by error code. */
+    errorMessages?: Partial<Record<ErrorCode, string>>;
 }
 interface WPEntity {
     id: number;
@@ -47,8 +79,9 @@ interface JwtAuthResponse {
     user_display_name: string;
 }
 declare class AuthenticationError extends Error {
-    status: number;
-    constructor(message: string, status: number);
+    readonly code: ErrorCode;
+    readonly status: number;
+    constructor(code: ErrorCode, status: number, message: string, detail?: string);
 }
 
 interface MediaSize {
@@ -219,6 +252,12 @@ interface WordPressResponse<T> {
     data: T;
     headers: WordPressPaginationHeaders;
 }
+declare class WordPressAPIError extends Error {
+    readonly code: ErrorCode;
+    readonly status: number;
+    readonly endpoint: string;
+    constructor(code: ErrorCode, status: number, endpoint: string, message: string, detail?: string);
+}
 
 interface WooCommerceConfig {
     serverURL: string;
@@ -226,6 +265,8 @@ interface WooCommerceConfig {
     consumerKey: string;
     consumerSecret: string;
     cacheTTL?: number;
+    /** Override default error messages by error code. */
+    errorMessages?: Partial<Record<ErrorCode, string>>;
 }
 interface WooCommercePaginationHeaders {
     total: number;
@@ -235,6 +276,13 @@ interface WooCommerceResponse<T> {
     data: T;
     headers: WooCommercePaginationHeaders;
 }
+declare class WooCommerceError extends Error {
+    readonly code: ErrorCode;
+    readonly status: number;
+    readonly endpoint: string;
+    readonly upstreamCode?: string | undefined;
+    constructor(code: ErrorCode, status: number, endpoint: string, message: string, upstreamCode?: string | undefined, detail?: string);
+}
 
 interface WCImage {
     id: number;
@@ -541,10 +589,11 @@ interface GQLError {
     path?: string[];
 }
 declare class WPGraphQLError extends Error {
+    readonly code: ErrorCode;
     readonly status: number;
     readonly endpoint: string;
     readonly gqlErrors?: GQLError[] | undefined;
-    constructor(message: string, status: number, endpoint: string, gqlErrors?: GQLError[] | undefined);
+    constructor(code: ErrorCode, status: number, endpoint: string, message: string, gqlErrors?: GQLError[] | undefined);
 }
 
 interface GQLPostFilter {
@@ -601,4 +650,4 @@ interface GQLPost {
     };
 }
 
-export { type Author as A, type BlockType as B, type WCProductAttribute as C, type WCProductDefaultAttribute as D, type EditorBlock as E, type FeaturedMedia as F, type GQLPost as G, type WCShippingLine as H, WPGraphQLError as I, type JwtAuthCredentials as J, type WooCommercePaginationHeaders as K, type MediaDetails as M, type NextWordpressConfig as N, type Post as P, type RenderedTitle as R, type SearchResult as S, type Taxonomy as T, type UpdateCustomerInput as U, type WordPressResponse as W, type WooCommerceConfig as a, type WCProduct as b, type WCProductFilterParams as c, type WooCommerceResponse as d, type WCCreateOrderInput as e, type WCOrder as f, type WCCustomer as g, type WPGraphQLConfig as h, type GQLPostFilter as i, type GQLConnection as j, type JwtAuthResponse as k, type WPEntity as l, type RenderedContent as m, type WCImage as n, type WCProductVariation as o, type WCAddress as p, AuthenticationError as q, type EmbeddedAuthor as r, type EmbeddedTerm as s, type GQLError as t, type GQLPageInfo as u, type MediaSize as v, type PostEmbedded as w, type TemplatePart as x, type WCDimensions as y, type WCOrderLineItem as z };
+export { type Author as A, type BlockType as B, type WCOrderLineItem as C, type WCProductAttribute as D, type EditorBlock as E, type FeaturedMedia as F, type GQLPost as G, type WCProductDefaultAttribute as H, type WCShippingLine as I, type JwtAuthCredentials as J, WPGraphQLError as K, WooCommerceError as L, type MediaDetails as M, type NextWordpressConfig as N, type WooCommercePaginationHeaders as O, type Post as P, WordPressAPIError as Q, type RenderedTitle as R, type SearchResult as S, type Taxonomy as T, type UpdateCustomerInput as U, defaultMessages as V, type WordPressResponse as W, defaultMessagesPl as X, resolveMessage as Y, type WooCommerceConfig as a, type WCProduct as b, type WCProductFilterParams as c, type WooCommerceResponse as d, type WCCreateOrderInput as e, type WCOrder as f, type WCCustomer as g, type WPGraphQLConfig as h, type GQLPostFilter as i, type GQLConnection as j, type JwtAuthResponse as k, type WPEntity as l, type RenderedContent as m, type WCImage as n, type WCProductVariation as o, type WCAddress as p, AuthenticationError as q, type EmbeddedAuthor as r, type EmbeddedTerm as s, ErrorCode as t, type GQLError as u, type GQLPageInfo as v, type MediaSize as w, type PostEmbedded as x, type TemplatePart as y, type WCDimensions as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@szymonpiatek/nextwordpress",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Szymon Piątek - Next.js WordPress client (types, queries, fetcher)",
   "license": "UNLICENSED",
   "private": false,
@@ -42,15 +42,22 @@
     "lint:fix": "eslint \"src/**/*.ts\" --fix",
     "format": "prettier --write \"src/**/*.{ts,md,json}\"",
     "typecheck": "tsc --noEmit",
-    "prepublishOnly": "npm run lint && npm run test && npm run clean && npm run build"
+    "prepublishOnly": "npm run lint && npm run test && npm run clean && npm run build",
+    "docs:dev": "typedoc && vitepress dev ../docs",
+    "docs:build": "typedoc && vitepress build ../docs",
+    "docs:preview": "vitepress preview ../docs"
   },
   "peerDependencies": {
     "react": ">=18.0.0",
     "swr": ">=2.0.0"
   },
   "peerDependenciesMeta": {
-    "react": { "optional": true },
-    "swr": { "optional": true }
+    "react": {
+      "optional": true
+    },
+    "swr": {
+      "optional": true
+    }
   },
   "dependencies": {
     "zod": "^3.23.8"
@@ -72,8 +79,11 @@
     "swr": "^2.4.1",
     "ts-jest": "^29.2.5",
     "tsup": "^8.3.5",
+    "typedoc": "^0.28.19",
+    "typedoc-plugin-markdown": "^4.12.0",
     "typescript": "^5.6.3",
-    "typescript-eslint": "^8.15.0"
+    "typescript-eslint": "^8.15.0",
+    "vitepress": "^1.6.4"
   },
   "repository": {
     "type": "git",