@signskart/shared 1.0.0 → 1.2.0

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './interfaces';

package/dist/index.js

@@ -0,0 +1 @@
+export * from './interfaces';

package/dist/interfaces/banner.d.ts

@@ -0,0 +1,47 @@
+import { ILocalizedString } from './common';
+import { IStore } from './store';
+export type BannerMediaType = 'image' | 'video';
+export interface BannerMedia {
+    type: BannerMediaType;
+    sources: {
+        desktop: string;
+        mobile?: string;
+        tablet?: string;
+    };
+    altText?: ILocalizedString;
+    poster?: string;
+    autoplay?: boolean;
+    loop?: boolean;
+    muted?: boolean;
+}
+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];
+    };
+}
+export interface BannerVisibility {
+    status: boolean;
+    scheduled: {
+        from: Date | null;
+        to: Date | null;
+    };
+}
+export interface IBanner {
+    _id?: string;
+    store: IStore;
+    title: ILocalizedString;
+    description?: ILocalizedString;
+    media: BannerMedia;
+    link?: BannerLink;
+    visibility: BannerVisibility;
+    position: string;
+    sortOrder: number;
+    createdAt: Date;
+    updatedAt: Date;
+}

package/dist/interfaces/banner.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/category.d.ts

@@ -0,0 +1,54 @@
+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;
+}
+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/dist/interfaces/category.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/common.d.ts

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

package/dist/interfaces/common.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/coupon.d.ts

@@ -0,0 +1,21 @@
+import { ILocalizedString } from './common';
+import { IStore } from './store';
+export interface IDiscountType {
+    type: string;
+    value: number;
+}
+export 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;
+}

package/dist/interfaces/coupon.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/currency.d.ts

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

package/dist/interfaces/currency.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/globalSetting.d.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/dist/interfaces/globalSetting.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/index.d.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/dist/interfaces/index.js

@@ -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/dist/interfaces/language.d.ts

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

package/dist/interfaces/language.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/product.d.ts

@@ -0,0 +1,69 @@
+import { ICategory, ILocalizedString, IProductType, IStore, IVariant } from "./";
+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[];
+    hasVariant: boolean;
+    hasSize: boolean;
+    isCombination: boolean;
+    prices: IPrices;
+    status: boolean;
+    store: IStore;
+    images?: IImages;
+    metaData?: {
+        product?: IMetaDataProduct;
+    };
+    createdAt?: Date;
+    updatedAt?: Date;
+    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/dist/interfaces/product.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/productType.d.ts

@@ -0,0 +1,80 @@
+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;
+}
+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;
+}
+export interface IFrameChartDocument {
+    _id: string;
+    name: string;
+    pricing: IPricingData[];
+    status: boolean;
+}
+export interface IFrameChartFormProps {
+    onClose: () => void;
+    frameChartId?: string | null;
+    initialData?: IFrameChartDocument | null;
+}
+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;
+}
+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/dist/interfaces/productType.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/store.d.ts

@@ -0,0 +1,27 @@
+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/dist/interfaces/store.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/subscriber.d.ts

@@ -0,0 +1,104 @@
+import { IStore } from "./store";
+export interface ISubscriberSegmentRules {
+    status?: 'active' | 'unsubscribed' | 'bounced' | 'blocked';
+    channels?: 'email' | 'sms' | 'push' | Array<'email' | 'sms' | 'push'>;
+}
+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 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;
+    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/dist/interfaces/subscriber.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/variant.d.ts

@@ -0,0 +1,37 @@
+import { ILocalizedString } from "./";
+export interface IVariantPrices {
+    originalPrice: number;
+    price: number;
+    discount?: number;
+}
+export 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;
+}
+export interface IProductVariantQuery {
+    page?: number;
+    limit?: number;
+    title?: string;
+    price?: string;
+    stockStatus?: string;
+    minPrice?: string;
+    maxPrice?: string;
+}

package/dist/interfaces/variant.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@signskart/shared",
-    "version": "1.0.0",
+    "version": "1.2.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "scripts": {

package/src/index.ts

@@ -0,0 +1 @@
+export * from './interfaces';

package/src/interfaces/coupon.ts

@@ -1,6 +1,5 @@
 import { ILocalizedString } from './common';
 import { IStore } from './store';
-import { Dayjs } from 'dayjs';
 
 
 export interface IDiscountType {
@@ -13,8 +12,8 @@ export interface ICoupon {
     title: ILocalizedString;
     logo: string;
     couponCode: string;
-    startTime: string | Dayjs;
-    endTime: string | Dayjs;
+    startTime: string;
+    endTime: string;
     discountType: IDiscountType;
     minimumAmount: number;
     isPromotional: boolean;

package/src/interfaces/product.ts

@@ -1,4 +1,4 @@
-import { ICategory, ILocalizedString, IProductType, IStore, IVariant } from "@/utils/interface";
+import { ICategory, ILocalizedString, IProductType, IStore, IVariant } from "./";
 
 export interface IPrices {
     originalPrice: number;

package/src/interfaces/variant.ts

@@ -1,4 +1,4 @@
-import { ILocalizedString } from "@/utils/interface";
+import { ILocalizedString } from "./";
 
 export interface IVariantPrices {
     originalPrice: number;

package/tsconfig.json

@@ -2,6 +2,7 @@
     "compilerOptions": {
         "target": "ESNext",
         "module": "ESNext",
+        "moduleResolution": "node",
         "declaration": true,
         "outDir": "dist",
         "rootDir": "src",
@@ -11,6 +12,9 @@
         "skipLibCheck": true
     },
     "include": [
+        "src/interfaces",
+        "src/constants",
+        "src/types",
         "src"
     ]
 }