@signskart/shared 1.0.0 → 1.0.1

package/ReadMe.md

@@ -0,0 +1,67 @@
+## 📦 Publish Instructions
+
+To build and publish this package, follow these steps:
+
+### Step 1: Build the Project
+
+```bash
+npm run build
+```
+
+### Step 2: Publish the Package
+
+```bash
+npm publish --access public
+
+npm version patch
+npm publish
+```
+
+---
+
+## 🚫 Usage Notice
+
+> **⚠️ This package is the intellectual property of [Signskart](https://www.signskart.com). Unauthorized use, distribution, modification, or publishing is strictly prohibited.**
+
+You **may not**:
+
+* Use this package in your projects without written permission from Signskart.
+* Rebrand or redistribute it under your own or another name.
+* Reverse-engineer or repurpose any part of the codebase.
+
+All rights reserved © Signskart, 2025.
+
+---
+
+## ✅ Intended Use Case
+
+This package is developed exclusively for Signskart’s internal and client-facing projects. It is optimized to support features and workflows aligned with our services, including but not limited to:
+
+* Signboard design automation
+* Print-ready file generation
+* Vendor-side tool integration
+
+---
+
+## 🤝 Collaboration & Permission
+
+If you are interested in collaborating, contributing, or using this package under a commercial or open-source license, please contact:
+
+📧 **Email**: [support@signskart.com](mailto:support@signskart.com)
+
+🌐 **Website**: [https://www.signskart.com](https://www.signskart.com)
+
+We welcome:
+
+* Strategic tech partnerships
+* Contributions under an approved contributor license
+* API integrations aligned with our ecosystem
+
+---
+
+## ✍️ Author Signature
+
+Warm regards,
+**RAJAN KUMAR**
+ | Founder at [Signskart](https://signskart.com)
+📧 [admin@signskart.com](mailto:admin@signskart.com)

package/dist/index.d.mts

@@ -0,0 +1,513 @@
+interface ILocalizedString {
+    [languageCode: string]: string;
+}
+
+interface ICurrency {
+    _id?: string;
+    name: string;
+    symbol: string;
+    status: boolean;
+    live_exchange_rates?: 'show' | 'hide';
+    createdAt?: string;
+    updatedAt?: string;
+}
+
+interface IStoreSettings {
+    logo: string;
+    theme: 'light' | 'dark';
+    timezone: string;
+}
+interface IStore {
+    _id?: string;
+    name: string;
+    shortName: string;
+    slug: string;
+    domain: string;
+    currency: ICurrency;
+    settings: IStoreSettings;
+    status: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface ICreateStoreDTO {
+    name: string;
+    shortName: string;
+    slug: string;
+    domain: string;
+    currency: string;
+    settings: Partial<IStoreSettings>;
+    status: boolean;
+}
+
+declare const TAGS: readonly ["new", "hot", "sale", "featured", "exclusive"];
+type Tag = typeof TAGS[number];
+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;
+    tags: Tag[];
+    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;
+}
+interface CategoryQueryParams {
+    page?: number;
+    limit?: number;
+    name?: string;
+    status?: string;
+    minLevel?: string;
+    maxLevel?: string;
+}
+interface CategoryResponse {
+    categories: ICategory[];
+    totalCategories: number;
+    totalPages: number;
+    currentPage: number;
+}
+
+interface IPrices {
+    originalPrice: number;
+    price: number;
+    discount?: number;
+}
+interface IMetaDataProduct {
+    title?: string;
+    header?: string;
+    description?: string;
+    keywords?: string[];
+    canonicalUrl?: string;
+}
+interface IImages {
+    productImage?: string;
+    seoImage?: string;
+    displayImage?: string;
+}
+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[];
+    hasVariant: boolean;
+    prices: IPrices;
+    status: boolean;
+    store: IStore;
+    images?: IImages;
+    metaData?: {
+        product?: IMetaDataProduct;
+    };
+    createdAt?: Date;
+    updatedAt?: Date;
+    variantList?: IVariant[];
+    [key: string]: any;
+}
+interface IProductQuery {
+    page?: number;
+    limit?: number;
+    category?: string;
+    categories?: string[];
+    title?: string;
+    price?: string;
+    stockStatus?: string;
+    published?: string;
+    status?: boolean;
+    minPrice?: string;
+    maxPrice?: string;
+}
+interface IProductResponse {
+    products: IProduct[];
+    totalDoc: number;
+    limits: number;
+    pages: number;
+}
+interface IProductUpdate {
+    ids: string[];
+    [key: string]: any;
+}
+
+interface IProductType {
+    _id: string;
+    name: string;
+    slug: string;
+    status: boolean;
+    pricingChart: IPricingChartDocument;
+    shippingChart: IShippingChartDocument;
+    variantChart: IVariantChart;
+    frameChart: IFrameChartDocument;
+    store: IStore;
+}
+interface IPricingTier {
+    from: number;
+    to: number;
+    price: number;
+}
+interface IPricingData {
+    label: string;
+    tiers: IPricingTier[];
+}
+interface IPricingChartDocument {
+    _id: string;
+    name: string;
+    pricing: IPricingData[];
+    status: boolean;
+}
+interface IPricingChartFormProps {
+    onClose: () => void;
+    pricingChartId?: string | null;
+    initialData?: IPricingChartDocument | null;
+}
+interface IFrameChartDocument {
+    _id: string;
+    name: string;
+    pricing: IPricingData[];
+    status: boolean;
+}
+interface IFrameChartFormProps {
+    onClose: () => void;
+    frameChartId?: string | null;
+    initialData?: IFrameChartDocument | null;
+}
+interface IShippingTier {
+    from: number;
+    to: number;
+    price: number;
+}
+interface IShippingData {
+    label: string;
+    day: number;
+    tiers: IShippingTier[];
+}
+interface IShippingChartDocument {
+    _id: string;
+    name: string;
+    shipping: IShippingData[];
+    status: boolean;
+}
+interface IShippingChartFormProps {
+    onClose: () => void;
+    shippingChartId?: string | null;
+    initialData?: IShippingChartDocument | null;
+}
+interface IVariantOption {
+    label: string;
+}
+interface IVariantChart {
+    _id: string;
+    name: string;
+    status: boolean;
+    variants: IVariantOption[];
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface IVariantChartFormProps {
+    onClose: () => void;
+    variantChartId?: string | null;
+    initialData?: IVariantChart | null;
+}
+
+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;
+}
+
+interface IDiscountType {
+    type: string;
+    value: number;
+}
+interface ICoupon {
+    _id: string;
+    title: ILocalizedString;
+    logo: string;
+    couponCode: string;
+    startTime: string;
+    endTime: string;
+    discountType: IDiscountType;
+    minimumAmount: number;
+    isPromotional: boolean;
+    status: boolean;
+    store: IStore;
+    createdAt: string;
+    updatedAt: string;
+}
+
+interface IVariantPrices {
+    originalPrice: number;
+    price: number;
+    discount?: number;
+}
+interface IVariant {
+    _id: string;
+    productId?: string;
+    sku: string;
+    barcode?: string;
+    title: ILocalizedString;
+    description?: ILocalizedString;
+    slug: string;
+    stock: number;
+    sales?: number;
+    tag?: string[];
+    prices: IVariantPrices;
+    image?: string;
+    templateJson?: string;
+    size: {
+        width: number;
+        height: number;
+    };
+    status: boolean;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+interface IProductVariantQuery {
+    page?: number;
+    limit?: number;
+    title?: string;
+    price?: string;
+    stockStatus?: string;
+    minPrice?: string;
+    maxPrice?: string;
+}
+
+interface ISubscriberSegmentRules {
+    status?: 'active' | 'unsubscribed' | 'bounced' | 'blocked';
+    channels?: 'email' | 'sms' | 'push' | Array<'email' | 'sms' | 'push'>;
+}
+interface ISubscriber {
+    _id?: string;
+    email?: string;
+    phone?: string;
+    userId?: string;
+    channels: Array<'email' | 'sms' | 'push'>;
+    status?: 'active' | 'unsubscribed' | 'bounced' | 'blocked';
+    locale?: string;
+    store?: IStore | string;
+    schemaVersion?: number;
+    isDeleted?: boolean;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+interface ISubscriberCampaignContent {
+    html?: string;
+    text?: string;
+}
+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;
+}
+interface ISubscriberCampaignLogMetaLocation {
+    country?: string;
+    city?: string;
+}
+interface ISubscriberCampaignLogMeta {
+    ip?: string;
+    userAgent?: string;
+    location?: ISubscriberCampaignLogMetaLocation;
+}
+interface ISubscriberCampaignLog {
+    _id?: string;
+    campaignId: string;
+    subscriberId: string;
+    event: 'delivered' | 'opened' | 'clicked' | 'bounced' | 'unsubscribed';
+    timestamp?: Date;
+    meta?: ISubscriberCampaignLogMeta;
+}
+interface ISubscriberEventBase {
+    _id?: string;
+    subscriberId: string;
+    createdAt?: Date;
+}
+interface ISubscriberEventSubscribed extends ISubscriberEventBase {
+    eventType: 'subscribed' | 'unsubscribed' | 'preference_updated' | 'bounced' | 'created' | 'deleted';
+    details?: Record<string, any>;
+}
+interface ISubscriberEventUpdated extends ISubscriberEventBase {
+    eventType: 'updated';
+    details: {
+        updatedFields: Record<string, any>;
+    };
+}
+type ISubscriberEvent = ISubscriberEventSubscribed | ISubscriberEventUpdated;
+interface ISubscriberList {
+    _id?: string;
+    store?: IStore;
+    name: string;
+    description?: string;
+    channel: 'email' | 'sms' | 'push';
+    defaultOptIn?: boolean;
+    createdAt?: Date;
+}
+interface ISubscriberPreference {
+    _id?: string;
+    subscriberId: string;
+    channel: 'email' | 'sms' | 'push';
+    topics: string[];
+    unsubscribed: boolean;
+    updatedAt?: Date;
+}
+interface ISubscriberSegment {
+    _id?: string;
+    store?: IStore;
+    name: string;
+    type: 'static' | 'dynamic';
+    rules?: ISubscriberSegmentRules;
+    subscriberIds?: Array<string>;
+    createdAt?: Date;
+}
+interface ISubscriberSubscription {
+    _id?: string;
+    subscriberId: string;
+    listId: string;
+    status?: 'subscribed' | 'unsubscribed' | 'pending';
+    subscribedAt?: Date;
+    unsubscribedAt?: Date;
+    isDeleted?: boolean;
+}
+
+interface ILanguage {
+    _id: string;
+    name: string;
+    iso_code: string;
+    flag: string;
+    status: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+
+type BannerMediaType = 'image' | 'video';
+interface BannerMedia {
+    type: BannerMediaType;
+    sources: {
+        desktop: string;
+        mobile?: string;
+        tablet?: string;
+    };
+    altText?: ILocalizedString;
+    poster?: string;
+    autoplay?: boolean;
+    loop?: boolean;
+    muted?: boolean;
+}
+type LinkType = 'internal' | 'external';
+interface BannerLink {
+    type: LinkType;
+    url: string;
+    openInNewTab: boolean;
+}
+interface IBannerFormValues extends Omit<IBanner, 'visibility'> {
+    visibility: BannerVisibility & {
+        scheduledRange?: [Date, Date];
+    };
+}
+interface BannerVisibility {
+    status: boolean;
+    scheduled: {
+        from: Date | null;
+        to: Date | null;
+    };
+}
+interface IBanner {
+    _id?: string;
+    store: IStore;
+    title: ILocalizedString;
+    description?: ILocalizedString;
+    media: BannerMedia;
+    link?: BannerLink;
+    visibility: BannerVisibility;
+    position: string;
+    sortOrder: number;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+type CustomerPhotoStatus = 'pending' | 'approved' | 'rejected';
+interface ICustomerPhotos {
+    _id?: string;
+    store: IStore;
+    customer: {
+        name?: string;
+        email?: string;
+        comment?: string;
+    };
+    photos: string[];
+    status: CustomerPhotoStatus;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface CustomerPhotosQueryParams {
+    page?: number;
+    limit?: number;
+    name?: string;
+    email?: string;
+    status?: CustomerPhotoStatus;
+    store?: string;
+}
+
+export { type BannerLink, type BannerMedia, type BannerMediaType, type BannerVisibility, type CategoryQueryParams, type CategoryResponse, type CustomerPhotoStatus, type CustomerPhotosQueryParams, type IBanner, type IBannerFormValues, type ICategory, type ICoupon, type ICreateStoreDTO, type ICurrency, type ICustomerPhotos, type IDiscountType, type IFrameChartDocument, type IFrameChartFormProps, type IGlobalSetting, type IImages, type ILanguage, type ILocalizedString, type IMetaDataProduct, type IPrices, type IPricingChartDocument, type IPricingChartFormProps, type IPricingData, type IPricingTier, type IProduct, type IProductQuery, type IProductResponse, type IProductType, type IProductUpdate, type IProductVariantQuery, type IShippingChartDocument, type IShippingChartFormProps, type IShippingData, type IShippingTier, type IStore, type IStoreSettings, type ISubscriber, type ISubscriberCampaign, type ISubscriberCampaignContent, type ISubscriberCampaignLog, type ISubscriberCampaignLogMeta, type ISubscriberCampaignLogMetaLocation, type ISubscriberEvent, type ISubscriberEventBase, type ISubscriberEventSubscribed, type ISubscriberEventUpdated, type ISubscriberList, type ISubscriberPreference, type ISubscriberSegment, type ISubscriberSegmentRules, type ISubscriberSubscription, type IVariant, type IVariantChart, type IVariantChartFormProps, type IVariantOption, type IVariantPrices, type LinkType, TAGS, type Tag };