@btst/stack 1.0.1 → 1.1.1

package/src/plugins/blog/client/localization/blog-forms.ts

@@ -0,0 +1,45 @@
+export const BLOG_FORMS = {
+	BLOG_FORMS_TITLE_LABEL: "Title",
+	BLOG_FORMS_REQUIRED_ASTERISK: " *",
+	BLOG_FORMS_TITLE_PLACEHOLDER: "Enter your post title...",
+
+	BLOG_FORMS_SLUG_LABEL: "Slug",
+	BLOG_FORMS_SLUG_PLACEHOLDER: "url-friendly-slug",
+
+	BLOG_FORMS_EXCERPT_LABEL: "Excerpt",
+	BLOG_FORMS_EXCERPT_PLACEHOLDER: "Brief summary of your post...",
+
+	BLOG_FORMS_TAGS_LABEL: "Tags",
+	BLOG_FORMS_TAGS_PLACEHOLDER: "Enter your post tags...",
+
+	BLOG_FORMS_CONTENT_LABEL: "Content",
+
+	BLOG_FORMS_PUBLISHED_LABEL: "Published",
+	BLOG_FORMS_PUBLISHED_DESCRIPTION: "Toggle to publish immediately",
+
+	BLOG_FORMS_SUBMIT_CREATE_IDLE: "Create Post",
+	BLOG_FORMS_SUBMIT_CREATE_PENDING: "Creating...",
+	BLOG_FORMS_SUBMIT_UPDATE_IDLE: "Update Post",
+	BLOG_FORMS_SUBMIT_UPDATE_PENDING: "Updating...",
+	BLOG_FORMS_CANCEL_BUTTON: "Cancel",
+
+	BLOG_FORMS_TOAST_CREATE_SUCCESS: "Post created successfully",
+	BLOG_FORMS_TOAST_UPDATE_SUCCESS: "Post updated successfully",
+	BLOG_FORMS_LOADING_POST: "Loading post...",
+
+	// Markdown editor
+	BLOG_FORMS_EDITOR_PLACEHOLDER: "Write something...",
+
+	// Featured image field
+	BLOG_FORMS_FEATURED_IMAGE_LABEL: "Image",
+	BLOG_FORMS_FEATURED_IMAGE_REQUIRED_ASTERISK: " *",
+	BLOG_FORMS_FEATURED_IMAGE_INPUT_PLACEHOLDER: "Image URL or upload below...",
+	BLOG_FORMS_FEATURED_IMAGE_UPLOAD_BUTTON: "Upload",
+	BLOG_FORMS_FEATURED_IMAGE_UPLOADING_BUTTON: "Uploading...",
+	BLOG_FORMS_FEATURED_IMAGE_UPLOADING_TEXT: "Uploading image...",
+	BLOG_FORMS_FEATURED_IMAGE_PREVIEW_ALT: "Featured image preview",
+	BLOG_FORMS_FEATURED_IMAGE_ERROR_NOT_IMAGE: "Please select an image file",
+	BLOG_FORMS_FEATURED_IMAGE_ERROR_TOO_LARGE: "Image size must be less than 4MB",
+	BLOG_FORMS_FEATURED_IMAGE_TOAST_SUCCESS: "Image uploaded successfully",
+	BLOG_FORMS_FEATURED_IMAGE_TOAST_FAILURE: "Failed to upload image",
+};

package/src/plugins/blog/client/localization/blog-list.ts

@@ -0,0 +1,14 @@
+export const BLOG_LIST = {
+	BLOG_LIST_TITLE: "Blog Posts",
+	BLOG_LIST_DRAFTS_TITLE: "Draft Posts",
+	BLOG_LIST_EMPTY: "There are no posts here yet.",
+	BLOG_LIST_LOAD_MORE: "Load more posts",
+	BLOG_LIST_LOADING_MORE: "Loading more...",
+	BLOG_LIST_SEARCH_PLACEHOLDER: "Search Blog Posts...",
+	BLOG_LIST_SEARCH_BUTTON: "Search Posts",
+	BLOG_LIST_SEARCH_EMPTY: "No blog posts found.",
+	BLOG_TAG_PAGE_TITLE: "{tag} Posts",
+	BLOG_TAG_PAGE_DESCRIPTION: "Browse all posts with this tag",
+	BLOG_TAG_NOT_FOUND: "Tag not found",
+	BLOG_TAG_NOT_FOUND_DESCRIPTION: "The tag you are looking for does not exist.",
+};

package/src/plugins/blog/client/localization/blog-post.ts

@@ -0,0 +1,9 @@
+export const BLOG_POST = {
+	BLOG_POST_ADD_TITLE: "Add New Post",
+	BLOG_POST_ADD_DESCRIPTION: "Create a new blog post.",
+	BLOG_POST_EDIT_TITLE: "Edit Post",
+	BLOG_POST_EDIT_DESCRIPTION: "Update your blog post.",
+	BLOG_POST_ON_THIS_PAGE: "In This Post",
+	BLOG_POST_KEEP_READING: "Keep Reading",
+	BLOG_POST_VIEW_ALL: "View all",
+};

package/src/plugins/blog/client/localization/index.ts

@@ -0,0 +1,15 @@
+import { BLOG_CARD } from "./blog-card";
+import { BLOG_COMMON } from "./blog-common";
+import { BLOG_LIST } from "./blog-list";
+import { BLOG_POST } from "./blog-post";
+import { BLOG_FORMS } from "./blog-forms";
+
+export const BLOG_LOCALIZATION = {
+	...BLOG_COMMON,
+	...BLOG_LIST,
+	...BLOG_CARD,
+	...BLOG_POST,
+	...BLOG_FORMS,
+};
+
+export type BlogLocalization = typeof BLOG_LOCALIZATION;

package/src/plugins/blog/client/overrides.ts

@@ -0,0 +1,123 @@
+import type { SerializedPost } from "../types";
+import type { ComponentType } from "react";
+import type { BlogLocalization } from "./localization";
+
+/**
+ * Context passed to lifecycle hooks
+ */
+export interface RouteContext {
+	path: string;
+	params?: Record<string, string>;
+	isSSR: boolean;
+	[key: string]: any;
+}
+
+/**
+ * Overridable components and functions for the Blog plugin
+ *
+ * External consumers can provide their own implementations of these
+ * to customize the behavior for their framework (Next.js, React Router, etc.)
+ */
+export interface BlogPluginOverrides {
+	Link?: ComponentType<React.ComponentProps<"a"> & Record<string, any>>;
+	PostCard?: ComponentType<{
+		post: SerializedPost;
+	}>;
+	/**
+	 * Navigation function for programmatic navigation
+	 */
+	navigate: (path: string) => void | Promise<void>;
+	/**
+	 * Refresh function to invalidate server-side cache (e.g., Next.js router.refresh())
+	 */
+	refresh?: () => void | Promise<void>;
+	/**
+	 * Image component for displaying images
+	 */
+	Image?: ComponentType<
+		React.ImgHTMLAttributes<HTMLImageElement> & Record<string, any>
+	>;
+	/**
+	 * Function used to upload an image and return its URL.
+	 */
+	uploadImage: (file: File) => Promise<string>;
+	/**
+	 * Localization object for the blog plugin
+	 */
+	localization?: BlogLocalization;
+	/**
+	 * API base URL
+	 */
+	apiBaseURL: string;
+	/**
+	 * API base path
+	 */
+	apiBasePath: string;
+	/**
+	 * Whether to show the attribution
+	 */
+	showAttribution?: boolean;
+
+	// Lifecycle Hooks (optional)
+	/**
+	 * Called when a route is rendered
+	 * @param routeName - Name of the route (e.g., 'posts', 'post', 'newPost')
+	 * @param context - Route context with path, params, etc.
+	 */
+	onRouteRender?: (
+		routeName: string,
+		context: RouteContext,
+	) => void | Promise<void>;
+
+	/**
+	 * Called when a route encounters an error
+	 * @param routeName - Name of the route
+	 * @param error - The error that occurred
+	 * @param context - Route context
+	 */
+	onRouteError?: (
+		routeName: string,
+		error: Error,
+		context: RouteContext,
+	) => void | Promise<void>;
+
+	/**
+	 * Called before the posts list page is rendered
+	 * Return false to prevent rendering (e.g., for authorization)
+	 * @param context - Route context
+	 */
+	onBeforePostsPageRendered?: (context: RouteContext) => boolean;
+
+	/**
+	 * Called before a single post page is rendered
+	 * Return false to prevent rendering (e.g., for authorization)
+	 * @param slug - The post slug
+	 * @param context - Route context
+	 */
+	onBeforePostPageRendered?: (slug: string, context: RouteContext) => boolean;
+
+	/**
+	 * Called before the new post page is rendered
+	 * Return false to prevent rendering (e.g., for authorization)
+	 * @param context - Route context
+	 */
+	onBeforeNewPostPageRendered?: (context: RouteContext) => boolean;
+
+	/**
+	 * Called before the edit post page is rendered
+	 * Return false to prevent rendering (e.g., for authorization)
+	 * @param slug - The post slug being edited
+	 * @param context - Route context
+	 */
+	onBeforeEditPostPageRendered?: (
+		slug: string,
+		context: RouteContext,
+	) => boolean;
+
+	/**
+	 * Called before the drafts page is rendered
+	 * Return false to prevent rendering (e.g., for authorization)
+	 * @param context - Route context
+	 */
+	onBeforeDraftsPageRendered?: (context: RouteContext) => boolean;
+}