@evenicanpm/cms 2.0.1 → 2.3.0

package/package.json

@@ -1,20 +1,22 @@
 {
 	"name": "@evenicanpm/cms",
-	"version": "2.0.1",
+	"version": "2.3.0",
 	"description": "Strapi 5 client and queries for e4 Headless.",
 	"author": "Evenica",
 	"type": "module",
 	"license": "ISC",
 	"exports": "./src/index.ts",
-	"types": "./dist/index.d.ts",
+	"types": "./src/index.ts",
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1"
 	},
-	"dependencies": {
+	"dependencies": {},
+	"peerDependencies": {
+		"@strapi/blocks-react-renderer": "^1.0.1",
 		"strapi-sdk-js": "^3.0.0"
 	},
 	"devDependencies": {
 		"@types/node": "^24.0.13"
 	},
-	"gitHead": "bbaff05f6f592114ad7a25caeee531e4fa1b14cf"
+	"gitHead": "72bf1aeb02a3d96c587706c0d91606698e38ff6a"
 }

package/src/content/blogs/index.ts

@@ -1,18 +1,30 @@
+import type { StrapiResponse } from "strapi-sdk-js";
 import { strapi } from "../../client";
 import type { Blog } from "./types";
 
+const getLocaleOption = (options: { locale?: string }) =>
+	options.locale ? { locale: options.locale } : {};
+
 // Queries
 const getBlogs = async (options: {
 	pagination: { pageSize: number; page: number };
-}) => {
-	return await strapi.find<Blog>("blogs", {
+	locale?: string;
+}): Promise<StrapiResponse<Blog[]>> => {
+	return strapi.find<Blog>("blogs", {
 		pagination: { ...options.pagination, withCount: true },
 		populate: "*",
-	});
+		...getLocaleOption(options),
+	} as Parameters<typeof strapi.find>[1]);
 };
 
-const getBlog = async (options: { id: string }) => {
-	return await strapi.findOne<Blog>("blogs", options.id, { populate: "*" });
+const getBlog = async (options: {
+	id: string;
+	locale?: string;
+}): Promise<StrapiResponse<Blog>> => {
+	return strapi.findOne<Blog>("blogs", options.id, {
+		populate: "*",
+		...getLocaleOption(options),
+	} as Parameters<typeof strapi.findOne>[2]);
 };
 
 export { getBlog, getBlogs };

package/src/content/blogs/types.ts

@@ -5,12 +5,27 @@
  * TODO: Auto-generated interfaces from Strapi
  */
 
+export interface BlogImage {
+	id: number;
+	url: string;
+	alternativeText: string | null;
+	caption: string | null;
+	formats: {
+		large?: { url: string };
+		medium?: { url: string };
+		small?: { url: string };
+		thumbnail?: { url: string };
+	};
+}
+
 export interface Blog {
 	title: string;
-	content: unknown;
-	image: unknown;
+	content: unknown[];
+	image: BlogImage | null;
+	author?: string;
 	documentId: string;
 	id: number;
+	locale?: string;
 	shortDescription: string;
 	createdAt: Date;
 	publishedAt: Date;

package/src/content/header/index.ts

@@ -0,0 +1,26 @@
+import { strapi } from "../../client";
+import type { HeaderConfig } from "./types";
+
+type HeaderApiResponse = {
+	data?: (HeaderConfig & { attributes?: HeaderConfig }) | null;
+};
+
+export async function getHeader(): Promise<HeaderConfig | null> {
+	try {
+		const params = {
+			populate: "announcementBanner",
+		};
+		const res = await strapi.request<HeaderApiResponse>("get", "/header", {
+			params,
+		});
+
+		const payload = res?.data;
+		if (!payload) return null;
+
+		const config = payload.attributes ?? payload;
+		return config as HeaderConfig;
+	} catch (error) {
+		console.warn("header unavailable from Strapi, falling back to null", error);
+		return null;
+	}
+}

package/src/content/header/types.ts

@@ -0,0 +1,19 @@
+export interface AnnouncementBanner {
+	enabled: boolean;
+	text?: string;
+	backgroundColor?: string;
+	textColor?: string;
+	link?: string;
+	linkText?: string;
+	dismissible?: boolean;
+}
+
+export interface HeaderConfig {
+	showSearch: boolean;
+	showCart: boolean;
+	showUserMenu: boolean;
+	showWishlist: boolean;
+	showLocaleSwitcher: boolean;
+	showLogo: boolean;
+	announcementBanner?: AnnouncementBanner;
+}

package/src/content/navigation/index.ts

@@ -19,7 +19,8 @@ const getMainNavigation = async () => {
 		);
 		return response;
 	} catch (error) {
-		console.log("error fetching strapi navigation data", error);
+		console.error("error fetching strapi navigation data", error);
+		return [];
 	}
 };
 

package/src/content/pages/index.ts

@@ -1,14 +1,29 @@
 import { strapi } from "../../client";
 import type { Page } from "./types";
 
-const getPage = async (options: { slug: string }) => {
-	const { slug } = options;
+const getPage = async (options: {
+	slug: string;
+	status?: "draft" | "published";
+	locale?: string;
+}) => {
+	const { slug, status, locale } = options;
 
-	// Equivalent of: pages.find({ filter: { slug }, populate: "*" })
 	return await strapi.find<Page>("pages", {
 		filters: { slug },
-		populate: "*",
-	});
+		populate: {
+			seo: true,
+			block: {
+				on: {
+					"blocks.hero-image": {
+						populate: { image: true },
+					},
+					"blocks.rich-text": true,
+				},
+			},
+		},
+		...((status ? { status } : {}) as object),
+		...(locale ? { locale } : {}),
+	} as Parameters<typeof strapi.find>[1]);
 };
 
 export { getPage };

package/src/content/pages/types.ts

@@ -11,6 +11,8 @@ type MetaElement = {
 };
 
 export interface Page {
+	id: number;
+	documentId: string;
 	title: string;
 	slug: string;
 	seo: {
@@ -23,9 +25,5 @@ export interface Page {
 		meta: Array<MetaElement>;
 	} | null;
 
-	block: Array<{
-		__component: "blocks.rich-text";
-		id: number;
-		content: string;
-	}>;
+	block: Array<{ __component: string; id: number; [key: string]: unknown }>;
 }

package/src/index.ts

@@ -1,6 +1,8 @@
 import * as blogs from "./content/blogs";
+import * as header from "./content/header";
 import * as navigation from "./content/navigation";
 import * as pages from "./content/pages";
+import * as locales from "./locales";
 import * as media from "./media";
 import * as session from "./session";
 
@@ -8,6 +10,8 @@ export const cms = {
 	blogs,
 	pages,
 	navigation,
+	locales,
 	media,
 	session,
+	header,
 };

package/src/locales/index.ts

@@ -0,0 +1,15 @@
+import { strapi } from "../client";
+import type { CmsLocale } from "./types";
+
+const getLocales = async () => {
+	try {
+		return await strapi.request<CmsLocale[]>("get", "/i18n/locales", {
+			headers: {},
+		});
+	} catch (error) {
+		console.log("error fetching strapi locale data", error);
+		return [];
+	}
+};
+
+export { getLocales };

package/src/locales/types.ts

@@ -0,0 +1,10 @@
+export interface CmsLocale {
+	id: number;
+	documentId?: string;
+	name: string;
+	code: string;
+	isDefault?: boolean;
+	createdAt?: string;
+	updatedAt?: string;
+	publishedAt?: string;
+}

package/tsconfig.json

@@ -6,13 +6,11 @@
 		"sourceMap": true,
 		"esModuleInterop": true,
 		"skipLibCheck": true,
-		"declaration": true,
 		"moduleResolution": "node",
 		"resolveJsonModule": true,
-		"outDir": "./dist",
 		"baseUrl": "./",
-		"emitDeclarationOnly": true,
+		"noEmit": true,
 		"jsx": "preserve"
 	},
-	"include": ["./"]
+	"include": ["./src"]
 }

package/dist/client.d.ts

@@ -1,3 +0,0 @@
-import Strapi from "strapi-sdk-js";
-declare const strapi: Strapi;
-export { strapi };

package/dist/content/blogs/index.d.ts

@@ -1,11 +0,0 @@
-import type { Blog } from "./types";
-declare const getBlogs: (options: {
-    pagination: {
-        pageSize: number;
-        page: number;
-    };
-}) => Promise<import("strapi-sdk-js").StrapiResponse<Blog[]>>;
-declare const getBlog: (options: {
-    id: string;
-}) => Promise<import("strapi-sdk-js").StrapiResponse<Blog>>;
-export { getBlogs, getBlog };

package/dist/content/blogs/types.d.ts

@@ -1,20 +0,0 @@
-/**
- * Interface is not auto-generated and needs to be updated
- * whenever Strapi Content-Type is modified.
- *
- * TODO: Auto-generated interfaces from Strapi
- */
-export interface Blog {
-    title: string;
-    content: any;
-    image: any;
-    documentId: string;
-    id: number;
-    shortDescription: string;
-    createdAt: Date;
-    publishedAt: Date;
-    createdBy: {
-        firstname: string;
-        lastname: string;
-    };
-}

package/dist/content/navigation/index.d.ts

@@ -1,8 +0,0 @@
-/**
- * Fetch main navigation TREE
- *
- * Not an actual content type and has a specific endpoint
- * so must use axios.request api directly
- */
-declare const getMainNavigation: () => Promise<unknown>;
-export { getMainNavigation };

package/dist/content/navigation/types.d.ts

@@ -1,45 +0,0 @@
-export interface CmsNavigation {
-    nodes: {
-        name: string;
-        id: number;
-        items: (CmsPage | CmsSubMenu)[];
-    }[];
-}
-export interface CmsPage {
-    type: string;
-    id: number;
-    name: string;
-    slug: string;
-}
-export interface CmsSubMenu {
-    type: string;
-    name: string;
-    pages: CmsPage[];
-}
-export interface CmsNavRelated {
-    id: number;
-    title: string;
-    slug: string;
-    createdAt: string;
-    updatedAt: string;
-    publishedAt?: string | null;
-    /** Optional content‑type hint Strapi adds when `populate=*` */
-    __contentType?: string;
-    /**
-     * Any other attributes your model exposes (e.g., SEO fields,
-     * coverImage, etc.). Keep this open so the type stays valid
-     * if the Strapi model grows.
-     */
-    [key: string]: unknown;
-}
-export interface CmsNavItem {
-    title: string;
-    menuAttached: boolean;
-    path: string;
-    type: "INTERNAL" | "EXTERNAL" | "WRAPPER";
-    uiRouterKey: string;
-    slug: string;
-    related: CmsNavRelated | null;
-    external: boolean;
-    items: CmsNavItem[];
-}

package/dist/content/pages/index.d.ts

@@ -1,5 +0,0 @@
-import type { Page } from "./types";
-declare const getPage: (options: {
-    slug: string;
-}) => Promise<import("strapi-sdk-js").StrapiResponse<Page[]>>;
-export { getPage };

package/dist/content/pages/types.d.ts

@@ -1,32 +0,0 @@
-/**
- * Interface is not auto-generated and needs to be updated
- * whenever Strapi Content-Type is modified.
- *
- * TODO: Auto-generated interfaces from Strapi
- */
-type MetaElement = {
-    name: string;
-    content: string;
-};
-export interface Page {
-    title: string;
-    slug: string;
-    seo: {
-        metaTitle?: string;
-        metaDescription?: string;
-        shareImage?: any;
-        metaImage?: {
-            media: {
-                url: string;
-            };
-        };
-        metaKeywords: Array<string>;
-        meta: Array<MetaElement>;
-    } | null;
-    block: Array<{
-        __component: "blocks.rich-text";
-        id: number;
-        content: string;
-    }>;
-}
-export {};

package/dist/index.d.ts

@@ -1,12 +0,0 @@
-import * as blogs from "./content/blogs";
-import * as navigation from "./content/navigation";
-import * as pages from "./content/pages";
-import * as media from "./media";
-import * as session from "./session";
-export declare const cms: {
-    blogs: typeof blogs;
-    pages: typeof pages;
-    navigation: typeof navigation;
-    media: typeof media;
-    session: typeof session;
-};

package/dist/media/get-image-url.d.ts

@@ -1,7 +0,0 @@
-export type imageSizes = "small" | "medium" | "large" | "thumbnail";
-/**
- * @param formats formats array from CMS data
- * @param size size of the image
- * @returns largest available image url
- */
-export declare const getImageUrl: (formats: any, size?: imageSizes) => any;

package/dist/media/index.d.ts

@@ -1 +0,0 @@
-export * from "./get-image-url";

package/dist/session/index.d.ts

@@ -1,2 +0,0 @@
-declare const signout: () => Promise<void>;
-export { signout };