kizlo 0.1.0

package/dist/webhook/utils.js

@@ -0,0 +1,21 @@
+import { WebhookEvent } from "./schema.js";
+import { safeValidateSchema } from "@kizlo/shared";
+
+//#region src/webhook/utils.ts
+async function validateWebhookEvent(events, data) {
+	const internal = await safeValidateSchema(WebhookEvent, data);
+	if (internal.success) return internal.value;
+	const external = events?.find((a) => a.types.includes(data.type))?.data;
+	if (external) {
+		const result = await safeValidateSchema(external, data.data);
+		if (!result.success) return null;
+		return {
+			type: data.type,
+			data: result.value
+		};
+	}
+	return null;
+}
+
+//#endregion
+export { validateWebhookEvent };

package/dist/wordpress/comment/service.d.ts

@@ -0,0 +1,28 @@
+import { WP_Error } from "../error.js";
+import { WP_List, WP_Result } from "../types.js";
+import { WordPressService } from "../service.js";
+import { WP_Comment, WP_CommentCreateErrorCode, WP_CommentCreateInput, WP_CommentDeleteErrorCode, WP_CommentDeleteInput, WP_CommentDeleteResponse, WP_CommentListErrorCode, WP_CommentListInput, WP_CommentRetrieveErrorCode, WP_CommentRetrieveInput, WP_CommentUpdateErrorCode, WP_CommentUpdateInput } from "./types.js";
+import "../index.js";
+
+//#region src/wordpress/comment/service.d.ts
+declare class CommentService {
+  private readonly wordpress;
+  constructor(wordpress: WordPressService);
+  list(input: WP_CommentListInput): Promise<{
+    data: null;
+    status: number;
+    headers: Headers;
+    error: WP_Error<WP_CommentListErrorCode>;
+  } | {
+    data: WP_List<WP_Comment>;
+    status: number;
+    headers: Headers;
+    error: null;
+  }>;
+  create(input: WP_CommentCreateInput): Promise<WP_Result<WP_Comment, WP_CommentCreateErrorCode>>;
+  get(input: WP_CommentRetrieveInput): Promise<WP_Result<WP_Comment, WP_CommentRetrieveErrorCode>>;
+  update(input: WP_CommentUpdateInput): Promise<WP_Result<WP_Comment, WP_CommentUpdateErrorCode>>;
+  delete(input: WP_CommentDeleteInput): Promise<WP_Result<WP_CommentDeleteResponse, WP_CommentDeleteErrorCode>>;
+}
+//#endregion
+export { CommentService };

package/dist/wordpress/comment/service.js

@@ -0,0 +1,55 @@
+import { WP_CORE_BASE } from "../constants.js";
+
+//#region src/wordpress/comment/service.ts
+var CommentService = class {
+	wordpress;
+	constructor(wordpress) {
+		this.wordpress = wordpress;
+	}
+	async list(input) {
+		const { ...searchParams } = input;
+		const result = await this.wordpress.get("/comments", {
+			base: WP_CORE_BASE,
+			searchParams
+		});
+		if (result.error) return result;
+		return {
+			...result,
+			data: this.wordpress.resolveList({
+				data: result.data,
+				headers: result.headers,
+				searchParams
+			})
+		};
+	}
+	async create(input) {
+		return this.wordpress.post("/comments", {
+			base: WP_CORE_BASE,
+			body: input
+		});
+	}
+	async get(input) {
+		const { id,...searchParams } = input;
+		return this.wordpress.get(`/comments/${id}`, {
+			base: WP_CORE_BASE,
+			searchParams
+		});
+	}
+	async update(input) {
+		const { id,...body } = input;
+		return this.wordpress.post(`/comments/${id}`, {
+			base: WP_CORE_BASE,
+			body
+		});
+	}
+	async delete(input) {
+		const { id,...searchParams } = input;
+		return this.wordpress.delete(`/comments/${id}`, {
+			base: WP_CORE_BASE,
+			searchParams
+		});
+	}
+};
+
+//#endregion
+export { CommentService };

package/dist/wordpress/comment/types.d.ts

@@ -0,0 +1,206 @@
+import { WP_Context, WP_Link, WP_ListOrder } from "../types.js";
+
+//#region src/wordpress/comment/types.d.ts
+/** State of the comment, as returned in responses. */
+type WP_CommentStatus = "approved" | "hold" | "spam" | "trash" | "unapproved";
+/** Status filter values accepted by `GET /wp/v2/comments`. WP's list filter uses present-tense (`approve`, not `approved`) and adds an `all` alias. */
+type WP_CommentStatusFilter = "approve" | "hold" | "spam" | "trash" | "all";
+/** Status values accepted by `POST /wp/v2/comments` and `POST /wp/v2/comments/<id>`. Same present-tense vocabulary as the filter, minus the `all` alias. */
+type WP_CommentStatusInput = "approve" | "hold" | "spam" | "trash";
+/** Type of the comment. */
+type WP_CommentType = "comment" | "pingback" | "trackback";
+/** Sort collection by comment attribute. */
+type WP_CommentOrderBy = "date" | "date_gmt" | "id" | "include" | "post" | "parent" | "type";
+/** The content for the comment. */
+interface WP_CommentContent {
+  /** HTML content for the comment, transformed for display. */
+  rendered: string;
+  /** Content for the comment, as it exists in the database. */
+  raw: string;
+}
+/** Avatar URLs for the comment author, keyed by image size in pixels (e.g. "24", "48", "96"). */
+type WP_CommentAvatarUrls = Record<string, string>;
+/** Hypermedia links for the comment resource. */
+interface WP_CommentLinks {
+  self?: WP_Link[];
+  collection?: WP_Link[];
+  up?: WP_Link[];
+  "in-reply-to"?: WP_Link[];
+  children?: WP_Link[];
+  author?: WP_Link[];
+  [rel: string]: WP_Link[] | undefined;
+}
+interface WP_Comment {
+  /** Unique identifier for the comment. */
+  id: number;
+  /** The ID of the user object, if author was a user. */
+  author: number;
+  /** Email address for the comment author. */
+  author_email: string;
+  /** IP address for the comment author. */
+  author_ip: string;
+  /** Display name for the comment author. */
+  author_name: string;
+  /** URL for the comment author. */
+  author_url: string;
+  /** User agent for the comment author. */
+  author_user_agent: string;
+  /** The content for the comment. */
+  content: WP_CommentContent;
+  /** The date the comment was published, in the site's timezone. */
+  date: string;
+  /** The date the comment was published, as GMT. */
+  date_gmt: string;
+  /** URL to the comment. */
+  link: string;
+  /** The ID for the parent of the comment. */
+  parent: number;
+  /** The ID of the associated post object. */
+  post: number;
+  /** State of the comment. */
+  status: WP_CommentStatus;
+  /** Type of the comment. */
+  type: WP_CommentType;
+  /** Avatar URLs for the comment author. */
+  author_avatar_urls: WP_CommentAvatarUrls;
+  /** Meta fields. */
+  meta: Record<string, unknown>;
+  /** Hypermedia links. */
+  _links?: WP_CommentLinks;
+}
+interface WP_CommentListInput {
+  /** Scope under which the request is made; determines fields present in response. */
+  context?: WP_Context;
+  /** Current page of the collection. */
+  page?: number;
+  /** Maximum number of items to be returned in result set. */
+  per_page?: number;
+  /** Limit results to those matching a string. */
+  search?: string;
+  /** Limit response to comments published after a given ISO8601 compliant date. */
+  after?: string;
+  /** Limit result set to comments assigned to specific user IDs. Requires authorization. */
+  author?: number | number[];
+  /** Ensure result set excludes comments assigned to specific user IDs. Requires authorization. */
+  author_exclude?: number | number[];
+  /** Limit result set to that from a specific author email. Requires authorization. */
+  author_email?: string;
+  /** Limit response to comments published before a given ISO8601 compliant date. */
+  before?: string;
+  /** Ensure result set excludes specific IDs. */
+  exclude?: number | number[];
+  /** Limit result set to specific IDs. */
+  include?: number | number[];
+  /** Offset the result set by a specific number of items. */
+  offset?: number;
+  /** Order sort attribute ascending or descending. */
+  order?: WP_ListOrder;
+  /** Sort collection by comment attribute. */
+  orderby?: WP_CommentOrderBy;
+  /** Limit result set to comments of specific parent IDs. */
+  parent?: number | number[];
+  /** Ensure result set excludes specific parent IDs. */
+  parent_exclude?: number | number[];
+  /** Limit result set to comments assigned to specific post IDs. */
+  post?: number | number[];
+  /** Limit result set to comments assigned a specific status. Requires authorization. */
+  status?: WP_CommentStatusFilter | WP_CommentStatusFilter[];
+  /** Limit result set to comments assigned a specific type. Requires authorization. */
+  type?: string;
+  /** The password for the post if it is password protected. */
+  password?: string;
+}
+type WP_CommentListErrorCode = "rest_cannot_read" | "rest_cannot_read_post" | "rest_forbidden_context" | "rest_forbidden_param" | "rest_comment_not_supported_post_type";
+/** Content payload accepted when creating or updating a comment. */
+type WP_CommentContentInput = string | {
+  raw: string;
+};
+interface WP_CommentCreateInput {
+  /** The ID of the user object, if author was a user. */
+  author?: number;
+  /** Email address for the comment author. */
+  author_email?: string;
+  /** IP address for the comment author. */
+  author_ip?: string;
+  /** Display name for the comment author. */
+  author_name?: string;
+  /** URL for the comment author. */
+  author_url?: string;
+  /** User agent for the comment author. */
+  author_user_agent?: string;
+  /** The content for the comment. */
+  content?: WP_CommentContentInput;
+  /** The date the comment was published, in the site's timezone. */
+  date?: string;
+  /** The date the comment was published, as GMT. */
+  date_gmt?: string;
+  /** The ID for the parent of the comment. */
+  parent?: number;
+  /** The ID of the associated post object. */
+  post?: number;
+  /** State of the comment. */
+  status?: WP_CommentStatusInput;
+  /** Meta fields. */
+  meta?: Record<string, unknown>;
+}
+type WP_CommentCreateErrorCode = "rest_comment_author_data_required" | "rest_comment_author_invalid" | "rest_comment_content_invalid" | "rest_comment_exists" | "rest_invalid_comment_type" | "rest_cannot_read_post" | "rest_comment_login_required" | "rest_cannot_create_note" | "rest_comment_closed" | "rest_comment_draft_post" | "rest_comment_invalid_author" | "rest_comment_invalid_author_ip" | "rest_comment_invalid_post_id" | "rest_comment_invalid_status" | "rest_comment_not_supported_post_type" | "rest_comment_trash_post" | "rest_comment_failed_create";
+interface WP_CommentRetrieveInput {
+  /** Unique identifier for the comment. */
+  id: number;
+  /** Scope under which the request is made; determines fields present in response. */
+  context?: WP_Context;
+  /** The password for the parent post of the comment (if the post is password protected). */
+  password?: string | undefined;
+}
+type WP_CommentRetrieveErrorCode = "rest_cannot_read" | "rest_cannot_read_post" | "rest_forbidden_context" | "rest_comment_invalid_id" | "rest_post_invalid_id";
+interface WP_CommentUpdateInput {
+  /** Unique identifier for the comment. */
+  id: number;
+  /** The ID of the user object, if author was a user. */
+  author?: number;
+  /** Email address for the comment author. */
+  author_email?: string;
+  /** IP address for the comment author. */
+  author_ip?: string;
+  /** Display name for the comment author. */
+  author_name?: string;
+  /** URL for the comment author. */
+  author_url?: string;
+  /** User agent for the comment author. */
+  author_user_agent?: string;
+  /** The content for the comment. */
+  content?: WP_CommentContentInput;
+  /** The date the comment was published, in the site's timezone. */
+  date?: string;
+  /** The date the comment was published, as GMT. */
+  date_gmt?: string;
+  /** The ID for the parent of the comment. */
+  parent?: number;
+  /** The ID of the associated post object. */
+  post?: number;
+  /** State of the comment. */
+  status?: WP_CommentStatusInput;
+  /** Meta fields. */
+  meta?: Record<string, unknown>;
+}
+type WP_CommentUpdateErrorCode = "rest_comment_author_invalid" | "rest_comment_content_invalid" | "rest_cannot_edit" | "rest_comment_invalid_post_id" | "rest_comment_invalid_id" | "rest_comment_invalid_type" | "rest_post_invalid_id" | "rest_comment_failed_edit";
+interface WP_CommentDeleteInput {
+  /** Unique identifier for the comment. */
+  id: number;
+  /** Whether to bypass Trash and force deletion. */
+  force?: boolean;
+  /** The password for the parent post of the comment (if the post is password protected). */
+  password?: string;
+}
+/**
+ * Response from `DELETE /wp/v2/comments/<id>`.
+ * - When `force=true`: returns `{ deleted: true, previous: WP_Comment }`.
+ * - When `force=false` (trashed): returns the updated `WP_Comment` with `status: "trash"`.
+ */
+type WP_CommentDeleteResponse = WP_Comment | {
+  deleted: true;
+  previous: WP_Comment;
+};
+type WP_CommentDeleteErrorCode = "rest_cannot_delete" | "rest_comment_invalid_id" | "rest_post_invalid_id" | "rest_already_trashed" | "rest_trash_not_supported";
+//#endregion
+export { WP_Comment, WP_CommentAvatarUrls, WP_CommentContent, WP_CommentContentInput, WP_CommentCreateErrorCode, WP_CommentCreateInput, WP_CommentDeleteErrorCode, WP_CommentDeleteInput, WP_CommentDeleteResponse, WP_CommentLinks, WP_CommentListErrorCode, WP_CommentListInput, WP_CommentOrderBy, WP_CommentRetrieveErrorCode, WP_CommentRetrieveInput, WP_CommentStatus, WP_CommentStatusFilter, WP_CommentStatusInput, WP_CommentType, WP_CommentUpdateErrorCode, WP_CommentUpdateInput };

package/dist/wordpress/constants.d.ts

@@ -0,0 +1,14 @@
+import { Duration } from "@kizlo/shared";
+
+//#region src/wordpress/constants.d.ts
+declare const WC_CORE_BASE = "/wp-json/wc/v3";
+declare const WP_CORE_BASE = "/wp-json/wp/v2";
+declare const WP_KIZLO_BASE = "/wp-json/kizlo/v1";
+declare const WC_STORE_BASE = "/wp-json/wc/store/v1";
+declare const CART_HASH_HEADER_KEY = "cart-hash";
+declare const WP_AUTH_TYPE = "Basic";
+declare const WP_AUTH_HEADER_KEY = "authorization";
+declare const UNEXPECTED_BODY_SNIPPET_LENGTH = 500;
+declare const SAFE_REQUEST_TIMEOUT: Duration;
+//#endregion
+export { CART_HASH_HEADER_KEY, SAFE_REQUEST_TIMEOUT, UNEXPECTED_BODY_SNIPPET_LENGTH, WC_CORE_BASE, WC_STORE_BASE, WP_AUTH_HEADER_KEY, WP_AUTH_TYPE, WP_CORE_BASE, WP_KIZLO_BASE };

package/dist/wordpress/constants.js

@@ -0,0 +1,13 @@
+//#region src/wordpress/constants.ts
+const WC_CORE_BASE = `/wp-json/wc/v3`;
+const WP_CORE_BASE = "/wp-json/wp/v2";
+const WP_KIZLO_BASE = `/wp-json/kizlo/v1`;
+const WC_STORE_BASE = `/wp-json/wc/store/v1`;
+const CART_HASH_HEADER_KEY = "cart-hash";
+const WP_AUTH_TYPE = "Basic";
+const WP_AUTH_HEADER_KEY = "authorization";
+const UNEXPECTED_BODY_SNIPPET_LENGTH = 500;
+const SAFE_REQUEST_TIMEOUT = "30 seconds";
+
+//#endregion
+export { CART_HASH_HEADER_KEY, SAFE_REQUEST_TIMEOUT, UNEXPECTED_BODY_SNIPPET_LENGTH, WC_CORE_BASE, WC_STORE_BASE, WP_AUTH_HEADER_KEY, WP_AUTH_TYPE, WP_CORE_BASE, WP_KIZLO_BASE };

package/dist/wordpress/error.d.ts

@@ -0,0 +1,9 @@
+import { WP_CommonErrorCode, WP_ErrorData } from "./types.js";
+
+//#region src/wordpress/error.d.ts
+declare class WP_Error<TCode extends string = string> extends Error {
+  code: TCode | WP_CommonErrorCode;
+  constructor(error: WP_ErrorData<TCode>);
+}
+//#endregion
+export { WP_Error };

package/dist/wordpress/error.js

@@ -0,0 +1,12 @@
+//#region src/wordpress/error.ts
+var WP_Error = class extends Error {
+	code;
+	constructor(error) {
+		super(error.message ?? "Internal server error, please try again.");
+		this.name = "WordPress Error";
+		this.code = error.code;
+	}
+};
+
+//#endregion
+export { WP_Error };

package/dist/wordpress/index.d.ts

@@ -0,0 +1,15 @@
+import { WP_Error } from "./error.js";
+import { WP_CommonErrorCode, WP_Context, WP_CurrencyFormat, WP_ErrorData, WP_Link, WP_List, WP_ListMetadata, WP_ListOrder, WP_RequestInput, WP_Result, WordPressCredentials } from "./types.js";
+import { WP_MenuItem, WP_MenuItemCreateErrorCode, WP_MenuItemCreateInput, WP_MenuItemDeleteErrorCode, WP_MenuItemDeleteInput, WP_MenuItemDeleteResponse, WP_MenuItemLinks, WP_MenuItemListErrorCode, WP_MenuItemListInput, WP_MenuItemOrderBy, WP_MenuItemRetrieveErrorCode, WP_MenuItemRetrieveInput, WP_MenuItemStatus, WP_MenuItemStatusFilter, WP_MenuItemTarget, WP_MenuItemTaxRelation, WP_MenuItemTitle, WP_MenuItemTitleInput, WP_MenuItemType, WP_MenuItemUpdateErrorCode, WP_MenuItemUpdateInput } from "./menu/items/types.js";
+import { MenuItemService } from "./menu/items/service.js";
+import { WP_Menu, WP_MenuCreateErrorCode, WP_MenuCreateInput, WP_MenuDeleteErrorCode, WP_MenuDeleteInput, WP_MenuDeleteResponse, WP_MenuLinks, WP_MenuListErrorCode, WP_MenuListInput, WP_MenuOrderBy, WP_MenuRetrieveErrorCode, WP_MenuRetrieveInput, WP_MenuUpdateErrorCode, WP_MenuUpdateInput } from "./menu/types.js";
+import { MenuService } from "./menu/service.js";
+import { WP_Post, WP_PostCommentStatus, WP_PostContent, WP_PostContentInput, WP_PostCreateErrorCode, WP_PostCreateInput, WP_PostDeleteErrorCode, WP_PostDeleteInput, WP_PostDeleteResponse, WP_PostExcerpt, WP_PostExcerptInput, WP_PostFormat, WP_PostGuid, WP_PostLinks, WP_PostListErrorCode, WP_PostListInput, WP_PostOrderBy, WP_PostRetrieveErrorCode, WP_PostRetrieveInput, WP_PostStatus, WP_PostStatusFilter, WP_PostTaxRelation, WP_PostTitle, WP_PostTitleInput, WP_PostUpdateErrorCode, WP_PostUpdateInput } from "./post/types.js";
+import { PostService } from "./post/service.js";
+import { WP_User, WP_UserAvatarUrls, WP_UserCapabilities, WP_UserCreateErrorCode, WP_UserCreateInput, WP_UserDeleteErrorCode, WP_UserDeleteInput, WP_UserDeleteMeErrorCode, WP_UserDeleteMeInput, WP_UserDeleteMeResponse, WP_UserDeleteResponse, WP_UserLinks, WP_UserListErrorCode, WP_UserListInput, WP_UserOrderBy, WP_UserRetrieveErrorCode, WP_UserRetrieveInput, WP_UserRetrieveMeErrorCode, WP_UserRetrieveMeInput, WP_UserUpdateErrorCode, WP_UserUpdateInput, WP_UserUpdateMeErrorCode, WP_UserUpdateMeInput, WP_UserWho } from "./user/types.js";
+import { UserService } from "./user/service.js";
+import { WordPressService } from "./service.js";
+import { WP_Comment, WP_CommentAvatarUrls, WP_CommentContent, WP_CommentContentInput, WP_CommentCreateErrorCode, WP_CommentCreateInput, WP_CommentDeleteErrorCode, WP_CommentDeleteInput, WP_CommentDeleteResponse, WP_CommentLinks, WP_CommentListErrorCode, WP_CommentListInput, WP_CommentOrderBy, WP_CommentRetrieveErrorCode, WP_CommentRetrieveInput, WP_CommentStatus, WP_CommentStatusFilter, WP_CommentStatusInput, WP_CommentType, WP_CommentUpdateErrorCode, WP_CommentUpdateInput } from "./comment/types.js";
+import { CommentService } from "./comment/service.js";
+import { CART_HASH_HEADER_KEY, SAFE_REQUEST_TIMEOUT, UNEXPECTED_BODY_SNIPPET_LENGTH, WC_CORE_BASE, WC_STORE_BASE, WP_AUTH_HEADER_KEY, WP_AUTH_TYPE, WP_CORE_BASE, WP_KIZLO_BASE } from "./constants.js";
+import { isWordPressResourceError } from "./utils.js";

package/dist/wordpress/menu/items/service.d.ts

@@ -0,0 +1,28 @@
+import { WP_Error } from "../../error.js";
+import { WP_List, WP_Result } from "../../types.js";
+import { WP_MenuItem, WP_MenuItemCreateErrorCode, WP_MenuItemCreateInput, WP_MenuItemDeleteErrorCode, WP_MenuItemDeleteInput, WP_MenuItemDeleteResponse, WP_MenuItemListErrorCode, WP_MenuItemListInput, WP_MenuItemRetrieveErrorCode, WP_MenuItemRetrieveInput, WP_MenuItemUpdateErrorCode, WP_MenuItemUpdateInput } from "./types.js";
+import { WordPressService } from "../../service.js";
+import "../../index.js";
+
+//#region src/wordpress/menu/items/service.d.ts
+declare class MenuItemService {
+  private readonly wordpress;
+  constructor(wordpress: WordPressService);
+  list(input: WP_MenuItemListInput): Promise<{
+    data: null;
+    status: number;
+    headers: Headers;
+    error: WP_Error<WP_MenuItemListErrorCode>;
+  } | {
+    data: WP_List<WP_MenuItem>;
+    status: number;
+    headers: Headers;
+    error: null;
+  }>;
+  create(input: WP_MenuItemCreateInput): Promise<WP_Result<WP_MenuItem, WP_MenuItemCreateErrorCode>>;
+  get(input: WP_MenuItemRetrieveInput): Promise<WP_Result<WP_MenuItem, WP_MenuItemRetrieveErrorCode>>;
+  update(input: WP_MenuItemUpdateInput): Promise<WP_Result<WP_MenuItem, WP_MenuItemUpdateErrorCode>>;
+  delete(input: WP_MenuItemDeleteInput): Promise<WP_Result<WP_MenuItemDeleteResponse, WP_MenuItemDeleteErrorCode>>;
+}
+//#endregion
+export { MenuItemService };

package/dist/wordpress/menu/items/service.js

@@ -0,0 +1,55 @@
+import { WP_CORE_BASE } from "../../constants.js";
+
+//#region src/wordpress/menu/items/service.ts
+var MenuItemService = class {
+	wordpress;
+	constructor(wordpress) {
+		this.wordpress = wordpress;
+	}
+	async list(input) {
+		const { ...searchParams } = input;
+		const result = await this.wordpress.get("/menu-items", {
+			base: WP_CORE_BASE,
+			searchParams
+		});
+		if (result.error) return result;
+		return {
+			...result,
+			data: this.wordpress.resolveList({
+				data: result.data,
+				headers: result.headers,
+				searchParams
+			})
+		};
+	}
+	async create(input) {
+		return this.wordpress.post("/menu-items", {
+			base: WP_CORE_BASE,
+			body: input
+		});
+	}
+	async get(input) {
+		const { id,...searchParams } = input;
+		return this.wordpress.get(`/menu-items/${id}`, {
+			base: WP_CORE_BASE,
+			searchParams
+		});
+	}
+	async update(input) {
+		const { id,...body } = input;
+		return this.wordpress.post(`/menu-items/${id}`, {
+			base: WP_CORE_BASE,
+			body
+		});
+	}
+	async delete(input) {
+		const { id,...searchParams } = input;
+		return this.wordpress.delete(`/menu-items/${id}`, {
+			base: WP_CORE_BASE,
+			searchParams
+		});
+	}
+};
+
+//#endregion
+export { MenuItemService };