@mohasinac/appkit 2.1.3 → 2.2.0

package/dist/features/admin/schemas/firestore.d.ts

@@ -0,0 +1,311 @@
+/**
+ * Admin Feature Firestore Document Types & Constants
+ * Covers: notifications, chat rooms, site settings
+ */
+export type NotificationType = "order_placed" | "order_confirmed" | "order_shipped" | "order_delivered" | "order_cancelled" | "bid_placed" | "bid_outbid" | "bid_won" | "bid_lost" | "review_approved" | "review_replied" | "product_available" | "promotion" | "system" | "welcome" | "offer_received" | "offer_responded" | "offer_expired" | "offer_counter_accepted" | "refund_initiated";
+export type NotificationPriority = "low" | "normal" | "high";
+export interface NotificationDocument {
+    id: string;
+    userId: string;
+    type: NotificationType;
+    priority: NotificationPriority;
+    title: string;
+    message: string;
+    imageUrl?: string;
+    actionUrl?: string;
+    actionLabel?: string;
+    isRead: boolean;
+    readAt?: Date;
+    relatedId?: string;
+    relatedType?: "order" | "product" | "bid" | "review" | "blog" | "user" | "offer";
+    createdAt: Date;
+    updatedAt: Date;
+}
+export declare const NOTIFICATIONS_COLLECTION: "notifications";
+export declare const NOTIFICATIONS_INDEXED_FIELDS: readonly ["userId", "isRead", "createdAt", "type"];
+export declare const NOTIFICATION_FIELDS: {
+    readonly ID: "id";
+    readonly USER_ID: "userId";
+    readonly TYPE: "type";
+    readonly PRIORITY: "priority";
+    readonly TITLE: "title";
+    readonly MESSAGE: "message";
+    readonly IMAGE_URL: "imageUrl";
+    readonly ACTION_URL: "actionUrl";
+    readonly ACTION_LABEL: "actionLabel";
+    readonly IS_READ: "isRead";
+    readonly READ_AT: "readAt";
+    readonly RELATED_ID: "relatedId";
+    readonly RELATED_TYPE: "relatedType";
+    readonly CREATED_AT: "createdAt";
+    readonly UPDATED_AT: "updatedAt";
+    readonly TYPE_VALUES: {
+        readonly ORDER_PLACED: NotificationType;
+        readonly ORDER_CONFIRMED: NotificationType;
+        readonly ORDER_SHIPPED: NotificationType;
+        readonly ORDER_DELIVERED: NotificationType;
+        readonly ORDER_CANCELLED: NotificationType;
+        readonly BID_PLACED: NotificationType;
+        readonly BID_OUTBID: NotificationType;
+        readonly BID_WON: NotificationType;
+        readonly BID_LOST: NotificationType;
+        readonly REVIEW_APPROVED: NotificationType;
+        readonly REVIEW_REPLIED: NotificationType;
+        readonly PRODUCT_AVAILABLE: NotificationType;
+        readonly PROMOTION: NotificationType;
+        readonly SYSTEM: NotificationType;
+        readonly WELCOME: NotificationType;
+        readonly OFFER_RECEIVED: NotificationType;
+        readonly OFFER_RESPONDED: NotificationType;
+        readonly OFFER_EXPIRED: NotificationType;
+        readonly OFFER_COUNTER_ACCEPTED: NotificationType;
+        readonly REFUND_INITIATED: NotificationType;
+    };
+    readonly PRIORITY_VALUES: {
+        readonly LOW: NotificationPriority;
+        readonly NORMAL: NotificationPriority;
+        readonly HIGH: NotificationPriority;
+    };
+};
+export declare const DEFAULT_NOTIFICATION_DATA: Partial<NotificationDocument>;
+export declare const NOTIFICATION_PUBLIC_FIELDS: readonly ["id", "type", "priority", "title", "message", "imageUrl", "actionUrl", "actionLabel", "isRead", "readAt", "relatedId", "relatedType", "createdAt"];
+export type NotificationCreateInput = Omit<NotificationDocument, "id" | "createdAt" | "updatedAt" | "isRead" | "readAt">;
+export type NotificationUpdateInput = Partial<Pick<NotificationDocument, "isRead" | "readAt">>;
+export declare const notificationQueryHelpers: {
+    readonly byUser: (userId: string) => readonly ["userId", "==", string];
+    readonly unread: (userId: string) => readonly [readonly ["userId", "==", string], readonly ["isRead", "==", false]];
+    readonly byType: (type: NotificationType) => readonly ["type", "==", NotificationType];
+};
+export interface ChatRoomDocument {
+    id: string;
+    buyerId: string;
+    sellerId: string;
+    orderId: string;
+    productId?: string;
+    productTitle?: string;
+    buyerName: string;
+    sellerName: string;
+    lastMessage?: string;
+    lastMessageAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+    /** UIDs of participants who soft-deleted this room on their side. */
+    deletedBy: string[];
+    /** True for admin-created group chats (> 2 participants). */
+    isGroup: boolean;
+    /** All participant UIDs. For 1-1 rooms: [buyerId, sellerId]. */
+    participantIds: string[];
+    /** Set by admin to permanently revoke all access. */
+    adminDeleted: boolean;
+}
+export declare const CHAT_ROOM_COLLECTION: "chatRooms";
+export declare const CHAT_ROOM_INDEXED_FIELDS: readonly ["buyerId", "sellerId", "orderId", "participantIds", "adminDeleted", "updatedAt"];
+export declare const CHAT_ROOM_FIELDS: {
+    readonly ID: "id";
+    readonly BUYER_ID: "buyerId";
+    readonly SELLER_ID: "sellerId";
+    readonly ORDER_ID: "orderId";
+    readonly PRODUCT_ID: "productId";
+    readonly PRODUCT_TITLE: "productTitle";
+    readonly BUYER_NAME: "buyerName";
+    readonly SELLER_NAME: "sellerName";
+    readonly LAST_MESSAGE: "lastMessage";
+    readonly LAST_MESSAGE_AT: "lastMessageAt";
+    readonly CREATED_AT: "createdAt";
+    readonly UPDATED_AT: "updatedAt";
+    readonly DELETED_BY: "deletedBy";
+    readonly IS_GROUP: "isGroup";
+    readonly PARTICIPANT_IDS: "participantIds";
+    readonly ADMIN_DELETED: "adminDeleted";
+};
+export declare const DEFAULT_CHAT_ROOM_DATA: Omit<ChatRoomDocument, "id" | "createdAt" | "updatedAt" | "lastMessage" | "lastMessageAt" | "productId" | "productTitle">;
+export type ChatRoomCreateInput = Omit<ChatRoomDocument, "id" | "createdAt" | "updatedAt" | "lastMessage" | "lastMessageAt" | "deletedBy" | "adminDeleted">;
+export type ChatRoomUpdateInput = Pick<ChatRoomDocument, "lastMessage" | "lastMessageAt" | "updatedAt">;
+export declare const chatRoomQueryHelpers: {
+    readonly byBuyer: (buyerId: string) => readonly ["buyerId", "==", string];
+    readonly bySeller: (sellerId: string) => readonly ["sellerId", "==", string];
+    readonly byOrder: (orderId: string) => readonly ["orderId", "==", string];
+    readonly active: () => readonly ["adminDeleted", "==", false];
+};
+export interface TrustBarItem {
+    icon: string;
+    label: string;
+    visible: boolean;
+}
+export interface FeaturedResult {
+    beforeImage: string;
+    afterImage: string;
+    caption: string;
+}
+export interface SiteSettingsCredentials {
+    razorpayKeyId?: string;
+    razorpayKeySecret?: string;
+    razorpayWebhookSecret?: string;
+    resendApiKey?: string;
+    whatsappApiKey?: string;
+    shiprocketEmail?: string;
+    shiprocketPassword?: string;
+    metaAppId?: string;
+    metaAppSecret?: string;
+    metaPageAccessToken?: string;
+    metaPageId?: string;
+}
+export interface SiteSettingsCredentialsMasked {
+    razorpayKeyId?: string;
+    razorpayKeySecret?: string;
+    razorpayWebhookSecret?: string;
+    resendApiKey?: string;
+    whatsappApiKey?: string;
+    shiprocketEmail?: string;
+    shiprocketPassword?: string;
+    metaAppId?: string;
+    metaAppSecret?: string;
+    metaPageAccessToken?: string;
+    metaPageId?: string;
+}
+export interface SiteSettingsDocument {
+    id: "global";
+    siteName: string;
+    motto: string;
+    logo: {
+        url: string;
+        alt: string;
+        format: "svg" | "png";
+    };
+    background: {
+        light: {
+            type: "color" | "gradient" | "image" | "video";
+            value: string;
+            overlay?: {
+                enabled: boolean;
+                color: string;
+                opacity: number;
+            };
+        };
+        dark: {
+            type: "color" | "gradient" | "image" | "video";
+            value: string;
+            overlay?: {
+                enabled: boolean;
+                color: string;
+                opacity: number;
+            };
+        };
+    };
+    contact: {
+        email: string;
+        phone: string;
+        address: string;
+        /** Business UPI Virtual Payment Address (market-specific) */
+        upiVpa?: string;
+        /** WhatsApp number with country code (market-specific) */
+        whatsappNumber?: string;
+    };
+    payment: {
+        razorpayEnabled: boolean;
+        upiManualEnabled: boolean;
+        codEnabled: boolean;
+    };
+    commissions: {
+        razorpayFeePercent: number;
+        codDepositPercent: number;
+        sellerShippingFixed: number;
+        platformShippingPercent: number;
+        platformShippingFixedMin: number;
+        processingFeePercent?: number;
+        gstPercent?: number;
+        gatewayFeePercent?: number;
+        autoPayoutWindowDays?: number;
+    };
+    socialLinks: {
+        facebook?: string;
+        twitter?: string;
+        instagram?: string;
+        linkedin?: string;
+    };
+    emailSettings: {
+        fromName: string;
+        fromEmail: string;
+        replyTo: string;
+    };
+    seo: {
+        defaultTitle: string;
+        defaultDescription: string;
+        keywords: string[];
+        ogImage: string;
+    };
+    features: {
+        id: string;
+        name: string;
+        description: string;
+        icon: string;
+        enabled: boolean;
+    }[];
+    featureFlags: {
+        chats: boolean;
+        smsVerification: boolean;
+        translations: boolean;
+        wishlists: boolean;
+        auctions: boolean;
+        reviews: boolean;
+        events: boolean;
+        blog: boolean;
+        coupons: boolean;
+        notifications: boolean;
+        sellerRegistration: boolean;
+        preOrders: boolean;
+    };
+    legalPages: {
+        termsOfService: string;
+        privacyPolicy: string;
+        refundPolicy: string;
+        shippingPolicy: string;
+    };
+    shipping: {
+        estimatedDays: number;
+        minOrderForFree: number;
+    };
+    returns: {
+        windowDays: number;
+    };
+    faq: {
+        variables: {
+            shippingDays: number;
+            minOrderValue: number;
+            returnWindow: number;
+            supportEmail: string;
+            supportPhone: string;
+            codDeposit: number;
+        };
+    };
+    navbarConfig?: {
+        hiddenNavItems?: string[];
+    };
+    footerConfig?: {
+        trustBar?: {
+            enabled?: boolean;
+            items?: TrustBarItem[];
+        };
+        newsletterEnabled?: boolean;
+    };
+    /** Encrypted provider credentials � never return raw to the client. */
+    credentials?: SiteSettingsCredentials;
+    featuredResults?: FeaturedResult[];
+    createdAt: Date;
+    updatedAt: Date;
+}
+export type FeatureFlagKey = keyof SiteSettingsDocument["featureFlags"];
+export interface FeatureFlagMeta {
+    key: FeatureFlagKey;
+    labelKey: string;
+    descKey: string;
+    icon: string;
+    category: "platform" | "payment";
+}
+export declare const SITE_SETTINGS_COLLECTION: "siteSettings";
+export declare const SITE_SETTINGS_INDEXED_FIELDS: readonly [];
+export declare const DEFAULT_SITE_SETTINGS_DATA: Partial<SiteSettingsDocument>;
+export declare const SITE_SETTINGS_PUBLIC_FIELDS: readonly ["siteName", "motto", "logo", "background", "contact.email", "contact.phone", "payment", "commissions", "socialLinks", "seo", "features", "featureFlags", "faq.variables"];
+export type SiteSettingsUpdateInput = Partial<Omit<SiteSettingsDocument, "id" | "createdAt" | "updatedAt">>;
+export declare const DEFAULT_TRUST_BAR_ITEMS: TrustBarItem[];
+export declare const FEATURE_FLAG_META: FeatureFlagMeta[];

package/dist/features/admin/schemas/firestore.js

@@ -0,0 +1,246 @@
+/**
+ * Admin Feature Firestore Document Types & Constants
+ * Covers: notifications, chat rooms, site settings
+ */
+export const NOTIFICATIONS_COLLECTION = "notifications";
+export const NOTIFICATIONS_INDEXED_FIELDS = [
+    "userId",
+    "isRead",
+    "createdAt",
+    "type",
+];
+export const NOTIFICATION_FIELDS = {
+    ID: "id",
+    USER_ID: "userId",
+    TYPE: "type",
+    PRIORITY: "priority",
+    TITLE: "title",
+    MESSAGE: "message",
+    IMAGE_URL: "imageUrl",
+    ACTION_URL: "actionUrl",
+    ACTION_LABEL: "actionLabel",
+    IS_READ: "isRead",
+    READ_AT: "readAt",
+    RELATED_ID: "relatedId",
+    RELATED_TYPE: "relatedType",
+    CREATED_AT: "createdAt",
+    UPDATED_AT: "updatedAt",
+    TYPE_VALUES: {
+        ORDER_PLACED: "order_placed",
+        ORDER_CONFIRMED: "order_confirmed",
+        ORDER_SHIPPED: "order_shipped",
+        ORDER_DELIVERED: "order_delivered",
+        ORDER_CANCELLED: "order_cancelled",
+        BID_PLACED: "bid_placed",
+        BID_OUTBID: "bid_outbid",
+        BID_WON: "bid_won",
+        BID_LOST: "bid_lost",
+        REVIEW_APPROVED: "review_approved",
+        REVIEW_REPLIED: "review_replied",
+        PRODUCT_AVAILABLE: "product_available",
+        PROMOTION: "promotion",
+        SYSTEM: "system",
+        WELCOME: "welcome",
+        OFFER_RECEIVED: "offer_received",
+        OFFER_RESPONDED: "offer_responded",
+        OFFER_EXPIRED: "offer_expired",
+        OFFER_COUNTER_ACCEPTED: "offer_counter_accepted",
+        REFUND_INITIATED: "refund_initiated",
+    },
+    PRIORITY_VALUES: {
+        LOW: "low",
+        NORMAL: "normal",
+        HIGH: "high",
+    },
+};
+export const DEFAULT_NOTIFICATION_DATA = {
+    priority: "normal",
+    isRead: false,
+};
+export const NOTIFICATION_PUBLIC_FIELDS = [
+    "id",
+    "type",
+    "priority",
+    "title",
+    "message",
+    "imageUrl",
+    "actionUrl",
+    "actionLabel",
+    "isRead",
+    "readAt",
+    "relatedId",
+    "relatedType",
+    "createdAt",
+];
+export const notificationQueryHelpers = {
+    byUser: (userId) => ["userId", "==", userId],
+    unread: (userId) => [
+        ["userId", "==", userId],
+        ["isRead", "==", false],
+    ],
+    byType: (type) => ["type", "==", type],
+};
+export const CHAT_ROOM_COLLECTION = "chatRooms";
+export const CHAT_ROOM_INDEXED_FIELDS = [
+    "buyerId",
+    "sellerId",
+    "orderId",
+    "participantIds",
+    "adminDeleted",
+    "updatedAt",
+];
+export const CHAT_ROOM_FIELDS = {
+    ID: "id",
+    BUYER_ID: "buyerId",
+    SELLER_ID: "sellerId",
+    ORDER_ID: "orderId",
+    PRODUCT_ID: "productId",
+    PRODUCT_TITLE: "productTitle",
+    BUYER_NAME: "buyerName",
+    SELLER_NAME: "sellerName",
+    LAST_MESSAGE: "lastMessage",
+    LAST_MESSAGE_AT: "lastMessageAt",
+    CREATED_AT: "createdAt",
+    UPDATED_AT: "updatedAt",
+    DELETED_BY: "deletedBy",
+    IS_GROUP: "isGroup",
+    PARTICIPANT_IDS: "participantIds",
+    ADMIN_DELETED: "adminDeleted",
+};
+export const DEFAULT_CHAT_ROOM_DATA = {
+    buyerId: "",
+    sellerId: "",
+    orderId: "",
+    buyerName: "",
+    sellerName: "",
+    deletedBy: [],
+    isGroup: false,
+    participantIds: [],
+    adminDeleted: false,
+};
+export const chatRoomQueryHelpers = {
+    byBuyer: (buyerId) => ["buyerId", "==", buyerId],
+    bySeller: (sellerId) => ["sellerId", "==", sellerId],
+    byOrder: (orderId) => ["orderId", "==", orderId],
+    active: () => ["adminDeleted", "==", false],
+};
+export const SITE_SETTINGS_COLLECTION = "siteSettings";
+export const SITE_SETTINGS_INDEXED_FIELDS = [];
+export const DEFAULT_SITE_SETTINGS_DATA = {
+    id: "global",
+    siteName: "My Store",
+    motto: "Your Marketplace, Your Rules",
+    payment: {
+        razorpayEnabled: true,
+        upiManualEnabled: true,
+        codEnabled: true,
+    },
+    commissions: {
+        razorpayFeePercent: 5,
+        codDepositPercent: 10,
+        sellerShippingFixed: 0,
+        platformShippingPercent: 10,
+        platformShippingFixedMin: 0,
+    },
+    featureFlags: {
+        chats: true,
+        smsVerification: true,
+        translations: false,
+        wishlists: true,
+        auctions: true,
+        reviews: true,
+        events: true,
+        blog: true,
+        coupons: true,
+        notifications: true,
+        sellerRegistration: true,
+        preOrders: false,
+    },
+    shipping: {
+        estimatedDays: 5,
+        minOrderForFree: 0,
+    },
+    returns: {
+        windowDays: 7,
+    },
+};
+export const SITE_SETTINGS_PUBLIC_FIELDS = [
+    "siteName",
+    "motto",
+    "logo",
+    "background",
+    "contact.email",
+    "contact.phone",
+    "payment",
+    "commissions",
+    "socialLinks",
+    "seo",
+    "features",
+    "featureFlags",
+    "faq.variables",
+];
+export const DEFAULT_TRUST_BAR_ITEMS = [
+    { icon: "??", label: "Free Shipping", visible: true },
+    { icon: "??", label: "Easy Returns", visible: true },
+    { icon: "??", label: "Secure Payment", visible: true },
+    { icon: "??", label: "24/7 Support", visible: true },
+    { icon: "?", label: "Authentic Sellers", visible: true },
+];
+export const FEATURE_FLAG_META = [
+    {
+        key: "chats",
+        labelKey: "chats",
+        descKey: "chatsDesc",
+        icon: "??",
+        category: "platform",
+    },
+    {
+        key: "smsVerification",
+        labelKey: "smsVerification",
+        descKey: "smsVerificationDesc",
+        icon: "??",
+        category: "platform",
+    },
+    {
+        key: "translations",
+        labelKey: "translations",
+        descKey: "translationsDesc",
+        icon: "??",
+        category: "platform",
+    },
+    {
+        key: "auctions",
+        labelKey: "auctions",
+        descKey: "auctionsDesc",
+        icon: "??",
+        category: "platform",
+    },
+    {
+        key: "reviews",
+        labelKey: "reviews",
+        descKey: "reviewsDesc",
+        icon: "?",
+        category: "platform",
+    },
+    {
+        key: "notifications",
+        labelKey: "notifications",
+        descKey: "notificationsDesc",
+        icon: "??",
+        category: "platform",
+    },
+    {
+        key: "sellerRegistration",
+        labelKey: "sellerRegistration",
+        descKey: "sellerRegistrationDesc",
+        icon: "??",
+        category: "platform",
+    },
+    {
+        key: "preOrders",
+        labelKey: "preOrders",
+        descKey: "preOrdersDesc",
+        icon: "??",
+        category: "platform",
+    },
+];

package/dist/features/admin/schemas/index.d.ts

@@ -0,0 +1 @@
+export * from "./firestore";

package/dist/features/admin/schemas/index.js

@@ -0,0 +1 @@
+export * from "./firestore";

package/dist/features/admin/server.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @mohasinac/appkit/features/admin/server
+ *
+ * Server-only entry point for admin API route handlers.
+ */
+import "server-only";
+export * from "./actions";
+export { notificationRepository } from "./repository/notification.repository";
+export { chatRepository } from "./repository/chat.repository";
+export type { ChatRoomDocument, ChatRoomCreateInput, } from "./repository/chat.repository";
+export { siteSettingsRepository } from "./repository/site-settings.repository";
+export { GET as adminProductsGET } from "./api/products/route";
+export { GET as adminCouponsGET } from "./api/coupons/route";
+export { GET as adminReviewsGET } from "./api/reviews/route";
+export { GET as adminBidsGET } from "./api/bids/route";

package/dist/features/admin/server.js

@@ -0,0 +1,14 @@
+/**
+ * @mohasinac/appkit/features/admin/server
+ *
+ * Server-only entry point for admin API route handlers.
+ */
+import "server-only";
+export * from "./actions";
+export { notificationRepository } from "./repository/notification.repository";
+export { chatRepository } from "./repository/chat.repository";
+export { siteSettingsRepository } from "./repository/site-settings.repository";
+export { GET as adminProductsGET } from "./api/products/route";
+export { GET as adminCouponsGET } from "./api/coupons/route";
+export { GET as adminReviewsGET } from "./api/reviews/route";
+export { GET as adminBidsGET } from "./api/bids/route";

package/dist/features/admin/types/index.d.ts

@@ -0,0 +1,61 @@
+import type React from "react";
+import type { TableColumn } from "../../../contracts";
+export type { AdminProduct, AdminProductStatus, AdminProductDrawerMode, } from "./product.types";
+export { ADMIN_PRODUCT_STATUS_OPTIONS } from "./product.types";
+/**
+ * Admin-specific column definition that narrows `render` to `React.ReactNode`.
+ * Extends `TableColumn<T>` from `@mohasinac/contracts` so it is compatible
+ * with column arrays built from the base type.
+ */
+export interface AdminTableColumn<T = Record<string, unknown>> extends Omit<TableColumn<T>, "render"> {
+    render?: (row: T) => React.ReactNode;
+}
+export interface DashboardStats {
+    totalOrders?: number;
+    totalRevenue?: number;
+    totalUsers?: number;
+    totalProducts?: number;
+    pendingOrders?: number;
+    pendingReviews?: number;
+    newUsersToday?: number;
+    currency?: string;
+}
+export interface AdminListParams {
+    q?: string;
+    page?: number;
+    perPage?: number;
+    sort?: string;
+    filters?: string;
+}
+export interface AdminListResponse<T> {
+    items: T[];
+    total: number;
+    page: number;
+    perPage: number;
+    totalPages: number;
+}
+export interface AnalyticsMonthEntry {
+    month: string;
+    orders: number;
+    revenue: number;
+}
+export interface AnalyticsTopProduct {
+    productId: string;
+    title: string;
+    revenue: number;
+    orders: number;
+    mainImage?: string;
+}
+export interface AnalyticsSummary {
+    totalOrders: number;
+    totalRevenue: number;
+    newOrdersThisMonth: number;
+    revenueThisMonth: number;
+    totalProducts?: number;
+    publishedProducts?: number;
+}
+export interface AdminAnalyticsData {
+    summary: AnalyticsSummary;
+    ordersByMonth: AnalyticsMonthEntry[];
+    topProducts: AnalyticsTopProduct[];
+}

package/dist/features/admin/types/index.js

@@ -0,0 +1 @@
+export { ADMIN_PRODUCT_STATUS_OPTIONS } from "./product.types";