@signskart/shared 1.0.0

package/package.json

@@ -0,0 +1,10 @@
+{
+    "name": "@signskart/shared",
+    "version": "1.0.0",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "build": "tsc --project tsconfig.json"
+    },
+    "license": "MIT"
+}

package/src/interfaces/banner.ts

@@ -0,0 +1,60 @@
+import { ILocalizedString } from './common';
+import { IStore } from './store';
+
+// media types
+export type BannerMediaType = 'image' | 'video';
+
+export interface BannerMedia {
+    type: BannerMediaType;
+    sources: {
+        desktop: string;
+        mobile?: string;
+        tablet?: string;
+    };
+    altText?: ILocalizedString;    // i18n-friendly alt text for accessibility
+
+    // Video-specific fields
+    poster?: string;
+    autoplay?: boolean;
+    loop?: boolean;
+    muted?: boolean;
+}
+
+// link types
+export type LinkType = 'internal' | 'external';
+
+export interface BannerLink {
+    type: LinkType;
+    url: string;
+    openInNewTab: boolean;
+}
+
+export interface IBannerFormValues extends Omit<IBanner, 'visibility'> {
+    visibility: BannerVisibility & {
+        scheduledRange?: [Date, Date]; // used only in the form
+    };
+}
+
+// visibility controls (with optional scheduling)
+export interface BannerVisibility {
+    status: boolean;
+    scheduled: {
+        from: Date | null;
+        to: Date | null;
+    };
+}
+
+// main banner interface
+export interface IBanner {
+    _id?: string;                         // MongoDB document ID
+    store: IStore;                        // Store ID (multi-tenant support)
+    title: ILocalizedString;             // i18n title
+    description?: ILocalizedString;      // optional i18n description
+    media: BannerMedia;                  // image or video media block
+    link?: BannerLink;                   // optional CTA link
+    visibility: BannerVisibility;        // active + scheduled
+    position: string;                    // UI position, e.g. 'homepage-top'
+    sortOrder: number;                   // for ordering banners
+    createdAt: Date;
+    updatedAt: Date;
+}

package/src/interfaces/category.ts

@@ -0,0 +1,61 @@
+import { ILocalizedString } from "./common";
+import { IStore } from "./store";
+
+export interface ICategory {
+    _id: string;
+    name: ILocalizedString;
+    description?: ILocalizedString;
+    slug?: string;
+    parent?: string | null;
+    parentName?: string;
+    children?: string[];
+    level?: number;
+    status?: boolean;
+    store: IStore;
+    skuInitial?: string;
+    sortPosition?: number;
+
+    images?: {
+        desktopBanner?: string;
+        mobileBanner?: string;
+        shopPageThumbnail?: string;
+        categoryThumbnail?: string;
+    };
+
+    metaData?: {
+        category?: {
+            titleTag?: string;
+            headerTag?: string;
+            metaDescription?: string;
+            csrKeywords?: string;
+        };
+        product?: {
+            titleTag?: string;
+            headerTag?: string;
+            metaDescription?: string;
+            csrKeywords?: string;
+        };
+    };
+
+    createdAt?: string;
+    updatedAt?: string;
+    productCount?: number;
+
+    [key: string]: any; // Optional catch-all for dynamic properties
+}
+
+export interface CategoryQueryParams {
+    page?: number;
+    limit?: number;
+    name?: string;
+    status?: string;
+    minLevel?: string;
+    maxLevel?: string;
+}
+
+export interface CategoryResponse {
+    categories: ICategory[];
+    totalCategories: number;
+    totalPages: number;
+    currentPage: number;
+}

package/src/interfaces/common.ts

@@ -0,0 +1,3 @@
+export interface ILocalizedString {
+    [languageCode: string]: string;
+}

package/src/interfaces/coupon.ts

@@ -0,0 +1,25 @@
+import { ILocalizedString } from './common';
+import { IStore } from './store';
+import { Dayjs } from 'dayjs';
+
+
+export interface IDiscountType {
+    type: string;
+    value: number;
+}
+
+export interface ICoupon {
+    _id: string;
+    title: ILocalizedString;
+    logo: string;
+    couponCode: string;
+    startTime: string | Dayjs;
+    endTime: string | Dayjs;
+    discountType: IDiscountType;
+    minimumAmount: number;
+    isPromotional: boolean;
+    status: boolean;
+    store: IStore;
+    createdAt: string;
+    updatedAt: string;
+}

package/src/interfaces/currency.ts

@@ -0,0 +1,11 @@
+export interface ICurrency {
+    _id?: string;
+    name: string;
+    symbol: string;
+    status: boolean; 
+    // iso_code: string;
+    // exchange_rate?: string;
+    live_exchange_rates?: 'show' | 'hide';
+    createdAt: string;
+    updatedAt: string;
+}

package/src/interfaces/globalSetting.ts

@@ -0,0 +1,25 @@
+export interface IGlobalSetting {
+    _id: string;
+    name: string;
+    number_of_image_per_product: number;
+    shop_name: string;
+    address: string;
+    company_name: string;
+    vat_number: string;
+    post_code: string;
+    contact: string;
+    email: string;
+    website: string;
+    default_currency: string;
+    default_time_zone: string;
+    default_date_format: string;
+    receipt_size: string;
+    from_email: string;
+    email_to_customer: boolean;
+    allow_auto_trans: boolean;
+    translation_key: string;
+    default_language: string;
+    floating_number: number;
+    createdAt: string;
+    updatedAt: string;
+}

package/src/interfaces/index.ts

@@ -0,0 +1,12 @@
+export * from './category';
+export * from './product';
+export * from './productType';
+export * from './globalSetting';
+export * from './store';
+export * from './currency';
+export * from './coupon';
+export * from './variant';
+export * from './subscriber';
+export * from './language';
+export * from './banner';
+export * from './common'

package/src/interfaces/language.ts

@@ -0,0 +1,9 @@
+export interface ILanguage {
+    _id: string
+    name: string;
+    iso_code: string;
+    flag: string;
+    status: boolean;
+    createdAt: string;
+    updatedAt: string;
+}  

package/src/interfaces/product.ts

@@ -0,0 +1,79 @@
+import { ICategory, ILocalizedString, IProductType, IStore, IVariant } from "@/utils/interface";
+
+export interface IPrices {
+    originalPrice: number;
+    price: number
+    discount?: number;
+}
+
+export interface IMetaDataProduct {
+    title?: string;
+    header?: string;
+    description?: string;
+    keywords?: string[];
+    canonicalUrl?: string;
+}
+
+export interface IImages {
+    productImage?: string;
+    seoImage?: string;
+    displayImage?: string;
+}  
+
+export interface IProduct {
+    _id: string;
+    sku?: string;
+    barcode?: string;
+    title: ILocalizedString;
+    description?: ILocalizedString;
+    slug: string;
+    categories: ICategory[];
+    category: ICategory;
+    productType?: IProductType;
+    image: string[];
+    stock: number;
+    sales: number;
+    tag: string[];
+    variants: IVariant[];        // direct ref array
+    hasVariant: boolean;
+    hasSize: boolean;
+    isCombination: boolean;
+    prices: IPrices;
+    status: boolean;
+    store: IStore;
+    images?: IImages;
+    metaData?: {
+        product?: IMetaDataProduct;
+    };
+    createdAt?: Date;
+    updatedAt?: Date;
+
+    // Optional: virtual populate
+    variantList?: IVariant[];
+
+    [key: string]: any;
+}
+
+export interface IProductQuery {
+    page?: number;
+    limit?: number;
+    category?: string;
+    title?: string;
+    price?: string;
+    stockStatus?: string;
+    published?: string;
+    minPrice?: string;
+    maxPrice?: string;
+}
+
+export interface IProductResponse {
+    products: IProduct[];
+    totalDoc: number;
+    limits: number;
+    pages: number;
+}
+
+export interface IProductUpdate {
+    ids: string[];
+    [key: string]: any;
+}

package/src/interfaces/productType.ts

@@ -0,0 +1,100 @@
+import { IStore } from "./store";
+
+export interface IProductType {
+    _id: string;
+    name: string;
+    slug: string;
+    status: boolean;
+    pricingChart: IPricingChartDocument;
+    shippingChart: IShippingChartDocument;
+    variantChart: IVariantChart;
+    frameChart: IFrameChartDocument;
+    store: IStore;
+}
+
+// pricing
+export interface IPricingTier {
+    from: number;
+    to: number;
+    price: number;
+}
+
+export interface IPricingData {
+    label: string;
+    tiers: IPricingTier[];
+}
+
+export interface IPricingChartDocument {
+    _id: string;
+    name: string;
+    pricing: IPricingData[];
+    status: boolean;
+}
+
+
+export interface IPricingChartFormProps {
+    onClose: () => void;
+    pricingChartId?: string | null;
+    initialData?: IPricingChartDocument | null;
+}
+
+// Frame
+export interface IFrameChartDocument {
+    _id: string;
+    name: string;
+    pricing: IPricingData[];
+    status: boolean;
+}
+
+export interface IFrameChartFormProps {
+    onClose: () => void;
+    frameChartId?: string | null;
+    initialData?: IFrameChartDocument | null;
+}
+
+
+// Shipping
+export interface IShippingTier {
+    from: number;
+    to: number;
+    price: number;
+}
+
+export interface IShippingData {
+    label: string;
+    day: number;
+    tiers: IShippingTier[];
+}
+
+export interface IShippingChartDocument {
+    _id: string;
+    name: string;
+    shipping: IShippingData[];
+    status: boolean;
+}
+
+export interface IShippingChartFormProps {
+    onClose: () => void;
+    shippingChartId?: string | null;
+    initialData?: IShippingChartDocument | null;
+}
+
+// variant
+export interface IVariantOption {
+    label: string;
+}
+
+export interface IVariantChart {
+    _id: string;
+    name: string;
+    status: boolean;
+    variants: IVariantOption[];
+    createdAt?: string;
+    updatedAt?: string;
+}
+
+export interface IVariantChartFormProps {
+    onClose: () => void;
+    variantChartId?: string | null;
+    initialData?: IVariantChart | null;
+}

package/src/interfaces/store.ts

@@ -0,0 +1,30 @@
+import { ICurrency } from "./currency";
+
+export interface IStoreSettings {
+    logo: string;
+    theme: 'light' | 'dark';
+    timezone: string;
+}
+
+export interface IStore {
+    _id: string;
+    name: string;
+    shortName: string;
+    slug: string;
+    domain: string;
+    currency: ICurrency;
+    settings: IStoreSettings;
+    status: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+
+export interface ICreateStoreDTO {
+    name: string;
+    shortName: string;
+    slug: string;
+    domain: string;
+    currency: string;
+    settings: Partial<IStoreSettings>;
+    status: boolean;
+}

package/src/interfaces/subscriber.ts

@@ -0,0 +1,129 @@
+import { IStore } from "./store";
+
+export interface ISubscriberSegmentRules {
+    status?: 'active' | 'unsubscribed' | 'bounced' | 'blocked';
+    channels?: 'email' | 'sms' | 'push' | Array<'email' | 'sms' | 'push'>;
+    // Add more filtering fields as needed
+}
+
+
+export interface ISubscriber {
+    _id?: string;
+    email?: string;
+    phone?: string;
+    userId?: string;
+    channels: Array<'email' | 'sms' | 'push'>;
+    status?: 'active' | 'unsubscribed' | 'bounced' | 'blocked';
+    locale?: string;
+    store?: IStore;
+    schemaVersion?: number;
+    isDeleted?: boolean;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+
+export interface ISubscriberCampaignContent {
+    html?: string;
+    text?: string;
+}
+
+export interface ISubscriberCampaign {
+    _id?: string;
+    store?: IStore;
+    name: string;
+    type: 'email' | 'sms' | 'push';
+    segmentId?: string;
+    subject?: string;
+    content?: ISubscriberCampaignContent;
+    status?: 'draft' | 'scheduled' | 'sent' | 'failed';
+    scheduledAt?: Date;
+    sentAt?: Date;
+    createdAt?: Date;
+}
+
+export interface ISubscriberCampaignLogMetaLocation {
+    country?: string;
+    city?: string;
+}
+
+export interface ISubscriberCampaignLogMeta {
+    ip?: string;
+    userAgent?: string;
+    location?: ISubscriberCampaignLogMetaLocation;
+}
+
+export interface ISubscriberCampaignLog {
+    _id?: string;
+    campaignId: string;
+    subscriberId: string;
+    event: 'delivered' | 'opened' | 'clicked' | 'bounced' | 'unsubscribed';
+    timestamp?: Date;
+    meta?: ISubscriberCampaignLogMeta;
+}
+
+// export interface ISubscriberEvent {
+//     _id?: string;
+//     subscriberId: string;
+//     eventType: 'subscribed' | 'unsubscribed' | 'preference_updated' | 'bounced';
+//     details?: Record<string, any>;
+//     createdAt?: Date;
+// }
+
+export interface ISubscriberEventBase {
+    _id?: string;
+    subscriberId: string;
+    createdAt?: Date;
+}
+
+export interface ISubscriberEventSubscribed extends ISubscriberEventBase {
+    eventType: 'subscribed' | 'unsubscribed' | 'preference_updated' | 'bounced' | 'created' | 'deleted';
+    details?: Record<string, any>;
+}
+
+export interface ISubscriberEventUpdated extends ISubscriberEventBase {
+    eventType: 'updated';
+    details: {
+        updatedFields: Record<string, any>;
+    };
+}
+
+export type ISubscriberEvent = ISubscriberEventSubscribed | ISubscriberEventUpdated;  
+
+export interface ISubscriberList {
+    _id?: string;
+    store?: IStore;
+    name: string;
+    description?: string;
+    channel: 'email' | 'sms' | 'push';
+    defaultOptIn?: boolean;
+    createdAt?: Date;
+}
+
+export interface ISubscriberPreference {
+    _id?: string;
+    subscriberId: string;
+    channel: 'email' | 'sms' | 'push';
+    topics: string[];
+    unsubscribed: boolean;
+    updatedAt?: Date;
+}
+
+export interface ISubscriberSegment {
+    _id?: string;
+    store?: IStore;
+    name: string;
+    type: 'static' | 'dynamic';
+    rules?: ISubscriberSegmentRules; // Replace with a specific type if you have a schema for rules
+    subscriberIds?: Array<string>;
+    createdAt?: Date;
+}
+
+export interface ISubscriberSubscription {
+    _id?: string;
+    subscriberId: string;
+    listId: string;
+    status?: 'subscribed' | 'unsubscribed' | 'pending';
+    subscribedAt?: Date;
+    unsubscribedAt?: Date;
+    isDeleted?: boolean;
+}

package/src/interfaces/variant.ts

@@ -0,0 +1,40 @@
+import { ILocalizedString } from "@/utils/interface";
+
+export interface IVariantPrices {
+    originalPrice: number;
+    price: number;
+    discount?: number;
+}
+
+export interface IVariant {
+    _id: string;                // MongoDB ObjectId string (optional on creation)
+    productId?: string;          // Reference to parent product's _id
+    sku: string;
+    barcode?: string;
+    title: ILocalizedString;     // Multilingual title
+    description?: ILocalizedString;
+    slug: string;
+    stock: number;
+    sales?: number;              // Default 0
+    tag?: string[];
+    prices: IVariantPrices;
+    image?: string;
+    templateJson?: string;
+    size: {
+        width: number;
+        height: number;
+    }
+    status: boolean;            // Active status, default true
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+
+export interface IProductVariantQuery {
+    page?: number;
+    limit?: number;
+    title?: string;
+    price?: string;
+    stockStatus?: string;
+    minPrice?: string;
+    maxPrice?: string;
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+    "compilerOptions": {
+        "target": "ESNext",
+        "module": "ESNext",
+        "declaration": true,
+        "outDir": "dist",
+        "rootDir": "src",
+        "strict": true,
+        "esModuleInterop": true,
+        "forceConsistentCasingInFileNames": true,
+        "skipLibCheck": true
+    },
+    "include": [
+        "src"
+    ]
+}