@chinggis.systems/collection-ui 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,142 @@
+import type { CSSProperties, ReactNode } from "react";
+export type CollectionLayoutName = "banner" | "block-grid" | "carousel" | "dynamic" | "featured" | "grid" | "grid-title" | "hero" | "image-grid" | "list" | "relative" | "slide" | "special";
+export type CollectionLayoutDirection = "horizontal" | "vertical";
+export type CollectionLayoutShape = "circle" | "rectangle" | "square";
+export type CollectionItemMediaKind = "audio" | "book" | "ebook" | string;
+export interface CollectionItem {
+    id: string;
+    title?: string | null;
+    author?: string | null;
+    description?: string | null;
+    imageUrl?: string | null;
+    productId?: string | null;
+    type?: CollectionItemMediaKind | null;
+    price?: number | null;
+    discountPrice?: number | null;
+    href?: string | null;
+    sort?: number | null;
+    metadata?: Record<string, unknown>;
+}
+export interface CollectionLayout {
+    name: CollectionLayoutName;
+    direction?: CollectionLayoutDirection | null;
+    isNumbered?: boolean | null;
+    columns?: number | null;
+    itemLimit?: number | null;
+    shape?: CollectionLayoutShape | null;
+}
+export interface Collection {
+    id: string;
+    name?: string | null;
+    description?: string | null;
+    imageUrl?: string | null;
+    linkName?: string | null;
+    href?: string | null;
+    type?: string | null;
+    sort?: number | null;
+    layout?: CollectionLayout | null;
+    items?: CollectionItem[] | null;
+    collections?: Collection[] | null;
+    metadata?: Record<string, unknown>;
+}
+export interface LinkRenderProps {
+    href: string;
+    children: ReactNode;
+    className?: string;
+    collection?: Collection;
+    item?: CollectionItem;
+    onClick?: () => void;
+}
+export interface ImageRenderProps {
+    src: string;
+    alt: string;
+    width: number;
+    height: number;
+    className?: string;
+    priority?: boolean;
+    sizes?: string;
+    style?: CSSProperties;
+    collection?: Collection;
+    item?: CollectionItem;
+}
+export interface BookMediaRenderProps {
+    item: CollectionItem;
+    src?: string | null;
+    alt: string;
+    width?: number;
+    height?: number;
+    isAudio?: boolean;
+    priority?: boolean;
+    className?: string;
+}
+export interface PriceRenderProps {
+    value?: number | null;
+    compareAtValue?: number | null;
+    className?: string;
+    compareAtClassName?: string;
+}
+export interface HtmlRenderProps {
+    html: string;
+    className?: string;
+    onReadMore?: () => void;
+    maxHeight?: "sm" | "md" | "lg";
+}
+export interface ItemRenderProps {
+    item: CollectionItem;
+    href?: string | null;
+    index: number;
+    number?: number;
+    variant: "card" | "featured" | "special" | "vertical";
+    collection?: Collection;
+    renderBookMedia?: (props: BookMediaRenderProps) => ReactNode;
+    renderPrice?: (props: PriceRenderProps) => ReactNode;
+    renderHtml?: (props: HtmlRenderProps) => ReactNode;
+}
+export interface CarouselRenderProps {
+    id: string;
+    slides: ReactNode[];
+    className?: string;
+    slideClassName?: string;
+    previousLabel: string;
+    nextLabel: string;
+    showControls?: boolean;
+    effect?: "slide" | "coverflow";
+    centeredSlides?: boolean;
+    loop?: boolean;
+    slidesPerView?: number | "auto";
+    slidesPerGroupAuto?: boolean;
+    spaceBetween?: number;
+    breakpoints?: Record<string | number, unknown>;
+}
+export interface CollectionRendererLabels {
+    all?: string;
+    viewAll?: string;
+    readMore?: string;
+    previous?: string;
+    next?: string;
+}
+export interface CollectionRendererAdapters {
+    renderLink?: (props: LinkRenderProps) => ReactNode;
+    renderImage?: (props: ImageRenderProps) => ReactNode;
+    renderItem?: (props: ItemRenderProps) => ReactNode;
+    renderBookMedia?: (props: BookMediaRenderProps) => ReactNode;
+    renderPrice?: (props: PriceRenderProps) => ReactNode;
+    renderHtml?: (props: HtmlRenderProps) => ReactNode;
+    renderCarousel?: (props: CarouselRenderProps) => ReactNode;
+    resolveCollectionHref?: (collection: Collection) => string | null | undefined;
+    resolveItemHref?: (item: CollectionItem) => string | null | undefined;
+    onCollectionClick?: (collection: Collection, href?: string | null) => void;
+    onItemClick?: (item: CollectionItem, href?: string | null) => void;
+    renderContainer?: (children: ReactNode, props: {
+        className?: string;
+    }) => ReactNode;
+    formatCollectionType?: (type: string) => ReactNode;
+}
+export interface CollectionRendererProps {
+    collection: Collection;
+    layout?: CollectionLayout | null;
+    adapters?: CollectionRendererAdapters;
+    labels?: CollectionRendererLabels;
+    className?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEtD,MAAM,MAAM,oBAAoB,GAC5B,QAAQ,GACR,YAAY,GACZ,UAAU,GACV,SAAS,GACT,UAAU,GACV,MAAM,GACN,YAAY,GACZ,MAAM,GACN,YAAY,GACZ,MAAM,GACN,UAAU,GACV,OAAO,GACP,SAAS,CAAC;AAEd,MAAM,MAAM,yBAAyB,GAAG,YAAY,GAAG,UAAU,CAAC;AAElE,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,CAAC;AAEtE,MAAM,MAAM,uBAAuB,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAE1E,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,IAAI,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;IACtC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,oBAAoB,CAAC;IAC3B,SAAS,CAAC,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAC7C,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,KAAK,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACjC,KAAK,CAAC,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IAChC,WAAW,CAAC,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,IAAI,CAAC,EAAE,cAAc,CAAC;CACvB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,cAAc,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;IACxB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,CAAC;IACtD,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,SAAS,CAAC;IAC7D,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,SAAS,CAAC;IACrD,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,SAAS,CAAC;CACpD;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,MAAM,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;IAC/B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAChC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,wBAAwB;IACvC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,0BAA0B;IACzC,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,SAAS,CAAC;IACnD,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,SAAS,CAAC;IACrD,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,SAAS,CAAC;IACnD,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,SAAS,CAAC;IAC7D,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,SAAS,CAAC;IACrD,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,SAAS,CAAC;IACnD,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,SAAS,CAAC;IAC3D,qBAAqB,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC9E,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACtE,iBAAiB,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;IAC3E,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;IACnE,eAAe,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,SAAS,CAAC;IACpF,oBAAoB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,SAAS,CAAC;CACpD;AAED,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,EAAE,0BAA0B,CAAC;IACtC,MAAM,CAAC,EAAE,wBAAwB,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/utils.d.ts

@@ -0,0 +1,9 @@
+import type { Collection, CollectionItem } from "./types";
+export declare function cx(...values: Array<string | false | null | undefined>): string;
+export declare function sortCollections(items?: Collection[] | null): Collection[];
+export declare function compact<T>(items?: Array<T | null | undefined> | null): T[];
+export declare function hasItems(collection: Collection): boolean;
+export declare function hasCollections(collection: Collection): boolean;
+export declare function defaultCollectionHref(collection: Collection): string | null;
+export declare function defaultItemHref(item: CollectionItem): string | null;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE1D,wBAAgB,EAAE,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,KAAK,GAAG,IAAI,GAAG,SAAS,CAAC,UAErE;AAED,wBAAgB,eAAe,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,GAAG,IAAI,gBAQ1D;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,CAE1E;AAED,wBAAgB,QAAQ,CAAC,UAAU,EAAE,UAAU,WAE9C;AAED,wBAAgB,cAAc,CAAC,UAAU,EAAE,UAAU,WAEpD;AAED,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,UAAU,iBAE3D;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,cAAc,iBAEnD"}

package/dist/utils.js

@@ -0,0 +1,27 @@
+export function cx(...values) {
+    return values.filter(Boolean).join(" ");
+}
+export function sortCollections(items) {
+    return [...compact(items)].sort((a, b) => {
+        if (a.sort != null || b.sort != null) {
+            return (b.sort ?? Number.NEGATIVE_INFINITY) - (a.sort ?? Number.NEGATIVE_INFINITY);
+        }
+        return (a.name ?? "").localeCompare(b.name ?? "");
+    });
+}
+export function compact(items) {
+    return (items ?? []).filter((item) => Boolean(item));
+}
+export function hasItems(collection) {
+    return compact(collection.items).length > 0;
+}
+export function hasCollections(collection) {
+    return compact(collection.collections).length > 0;
+}
+export function defaultCollectionHref(collection) {
+    return collection.href ?? collection.linkName ?? null;
+}
+export function defaultItemHref(item) {
+    return item.href ?? null;
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,EAAE,CAAC,GAAG,MAAgD;IACpE,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAA2B;IACzD,OAAO,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACvC,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;YACrC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,iBAAiB,CAAC,CAAC;QACrF,CAAC;QAED,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,OAAO,CAAI,KAA0C;IACnE,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAa,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,UAAsB;IAC7C,OAAO,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,UAAsB;IACnD,OAAO,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,UAAsB;IAC1D,OAAO,UAAU,CAAC,IAAI,IAAI,UAAU,CAAC,QAAQ,IAAI,IAAI,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,IAAoB;IAClD,OAAO,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC;AAC3B,CAAC"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@chinggis.systems/collection-ui",
+  "version": "1.0.0",
+  "description": "Reusable React collection layout renderer with app-provided link, image, and item adapters.",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": [
+    "./dist/styles.css",
+    "./src/styles.css"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./styles.css": "./dist/styles.css"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && cp src/styles.css dist/styles.css && mkdir -p dist/assets && cp -R src/assets/. dist/assets/",
+    "typecheck": "tsc -p tsconfig.build.json --noEmit"
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "react-dom": ">=18",
+    "swiper": ">=8"
+  },
+  "devDependencies": {
+    "@types/react": "19.2.14",
+    "@types/react-dom": "19.2.3",
+    "typescript": "6.0.2"
+  },
+  "keywords": [],
+  "author": ""
+}