feeef 0.5.38-dev.4 → 0.6.2

package/build/src/core/entities/category.d.ts

@@ -11,3 +11,24 @@ export interface CategoryEntity {
     createdAt: any;
     updatedAt: any;
 }
+/**
+ * Input data for creating a new category
+ */
+export interface CategoryCreateInput {
+    name: string;
+    storeId: string;
+    parentId?: string;
+    description?: string;
+    photoUrl?: string;
+    metadata?: Record<string, any>;
+}
+/**
+ * Input data for updating an existing category
+ */
+export interface CategoryUpdateInput {
+    name?: string;
+    parentId?: string | null;
+    description?: string;
+    photoUrl?: string;
+    metadata?: Record<string, any>;
+}

package/build/src/core/entities/feedback.d.ts

@@ -0,0 +1,100 @@
+/**
+ * Feedback status enum
+ */
+export declare enum FeedbackStatus {
+    open = "open",
+    inProgress = "in_progress",
+    resolved = "resolved",
+    closed = "closed"
+}
+/**
+ * Feedback priority enum
+ */
+export declare enum FeedbackPriority {
+    low = "low",
+    medium = "medium",
+    high = "high",
+    critical = "critical"
+}
+/**
+ * Feedback comment interface
+ */
+export interface FeedbackComment {
+    id: string;
+    userId: string;
+    comment: string;
+    createdAt: any;
+}
+/**
+ * Feedback attachment interface
+ */
+export interface FeedbackAttachment {
+    url: string;
+    name: string;
+    type: string;
+    size?: number;
+}
+/**
+ * Feedback entity interface
+ */
+export interface FeedbackEntity {
+    id: string;
+    userId: string;
+    title: string;
+    details: string | null;
+    status: FeedbackStatus;
+    priority: FeedbackPriority;
+    tags: string[];
+    attachments: FeedbackAttachment[];
+    comments: FeedbackComment[];
+    appVersion: string | null;
+    metadata: Record<string, any>;
+    resolvedAt: any | null;
+    createdAt: any;
+    updatedAt: any;
+}
+/**
+ * Input data for creating a new feedback
+ */
+export interface FeedbackCreateInput {
+    title: string;
+    details?: string;
+    priority?: FeedbackPriority;
+    tags?: string[];
+    attachments?: FeedbackAttachment[];
+    appVersion?: string;
+    metadata?: Record<string, any>;
+}
+/**
+ * Input data for updating an existing feedback
+ */
+export interface FeedbackUpdateInput {
+    title?: string;
+    details?: string;
+    status?: FeedbackStatus;
+    priority?: FeedbackPriority;
+    tags?: string[];
+    attachments?: FeedbackAttachment[];
+    appVersion?: string;
+    metadata?: Record<string, any>;
+    comment?: string;
+}
+/**
+ * Options for listing feedbacks
+ */
+export interface FeedbackListOptions {
+    page?: number;
+    offset?: number;
+    limit?: number;
+    status?: FeedbackStatus[];
+    priority?: FeedbackPriority[];
+    tags?: string[];
+    q?: string;
+    createdAfter?: Date | string;
+    createdBefore?: Date | string;
+    updatedAfter?: Date | string;
+    updatedBefore?: Date | string;
+    resolvedAfter?: Date | string;
+    resolvedBefore?: Date | string;
+    resolved?: boolean;
+}

package/build/src/core/entities/order.d.ts

@@ -106,4 +106,97 @@ interface OrderMetadata {
     [key: string]: any;
 }
 export declare const convertOrderEntityToOrderTrackEntity: (order: OrderEntity) => OrderTrackEntity;
+/**
+ * Input for creating a new order (admin/merchant)
+ */
+export interface OrderCreateInput {
+    id?: string;
+    customerName?: string;
+    customerPhone: string;
+    customerEmail?: string;
+    customerNote?: string;
+    shippingAddress?: string;
+    shippingCity?: string;
+    shippingState?: string;
+    shippingCountry?: string;
+    shippingType: ShippingType;
+    shippingMethodId?: string;
+    paymentMethodId?: string;
+    items: OrderItemInput[];
+    coupon?: string;
+    couponId?: string;
+    source?: string;
+    status?: OrderStatus;
+    paymentStatus?: PaymentStatus;
+    deliveryStatus?: DeliveryStatus;
+    customStatus?: string;
+    customFields?: Record<string, any>;
+    metadata?: Record<string, any>;
+    storeId: string;
+    tags?: string[];
+}
+/**
+ * Input for order items when creating/updating an order
+ */
+export interface OrderItemInput {
+    productId: string;
+    quantity: number;
+    variantPath?: string;
+    offerCode?: string;
+    addons?: Record<string, number>;
+    price?: number;
+    discount?: number;
+}
+/**
+ * Input data for updating an existing order
+ */
+export interface OrderUpdateInput {
+    customerName?: string;
+    customerPhone?: string;
+    customerEmail?: string;
+    customerNote?: string;
+    shippingAddress?: string;
+    shippingCity?: string;
+    shippingState?: string;
+    shippingCountry?: string;
+    shippingType?: ShippingType;
+    shippingMethodId?: string;
+    trackingCode?: string;
+    paymentMethodId?: string;
+    items?: OrderItemInput[];
+    subtotal?: number;
+    shippingPrice?: number;
+    total?: number;
+    discount?: number;
+    coupon?: string;
+    couponId?: string;
+    source?: string;
+    confirmerId?: string;
+    status?: OrderStatus;
+    paymentStatus?: PaymentStatus;
+    deliveryStatus?: DeliveryStatus;
+    customStatus?: string;
+    customFields?: Record<string, any>;
+    metadata?: Record<string, any>;
+    tags?: string[];
+}
+/**
+ * Order pricing calculation result
+ */
+export interface OrderPricing {
+    subtotal: number;
+    shippingPrice: number | null;
+    calculatedTotal: number;
+}
+/**
+ * Options for calculating order pricing
+ */
+export interface CalculateOrderPricingOptions {
+    storeId: string;
+    items: OrderItemInput[];
+    shippingState?: string;
+    shippingCountry?: string;
+    shippingType?: ShippingType;
+    shippingAddress?: string;
+}
 export {};

package/build/src/core/entities/product.d.ts

@@ -176,3 +176,79 @@ export interface ProductOffer {
     maxQuantity?: number;
     freeShipping?: boolean;
 }
+/**
+ * Input data for creating a new product
+ */
+export interface ProductCreateInput {
+    name: string;
+    storeId: string;
+    slug?: string;
+    photoUrl?: string;
+    media?: string[];
+    shippingMethodId?: string;
+    shippingPriceId?: string;
+    categoryId?: string;
+    category?: EmbaddedCategory;
+    title?: string;
+    description?: string;
+    body?: string;
+    sku?: string;
+    price: number;
+    cost?: number;
+    discount?: number;
+    stock?: number;
+    variant?: ProductVariant;
+    offers?: ProductOffer[];
+    addons?: ProductAddon[];
+    metadata?: Record<string, any>;
+    status?: ProductStatus;
+    type?: ProductType;
+    decoration?: ProductDecoration;
+    integrationsData?: IntegrationsData;
+}
+/**
+ * Input data for updating an existing product
+ */
+export interface ProductUpdateInput {
+    name?: string;
+    slug?: string;
+    photoUrl?: string;
+    media?: string[];
+    shippingMethodId?: string;
+    shippingPriceId?: string;
+    categoryId?: string;
+    category?: EmbaddedCategory;
+    title?: string;
+    description?: string;
+    body?: string;
+    sku?: string;
+    price?: number;
+    cost?: number;
+    discount?: number;
+    stock?: number;
+    variant?: ProductVariant;
+    offers?: ProductOffer[];
+    addons?: ProductAddon[];
+    metadata?: Record<string, any>;
+    status?: ProductStatus;
+    type?: ProductType;
+    decoration?: ProductDecoration;
+    integrationsData?: IntegrationsData;
+}
+/**
+ * Product report/analytics data
+ */
+export interface ProductReport {
+    views: number;
+    likes: number;
+    dislikes: number;
+    sold: number;
+    revenue: number;
+    conversionRate: number;
+    averageOrderValue: number;
+    topVariants?: Array<{
+        path: string;
+        sold: number;
+    }>;
+    salesByDate?: Record<string, number>;
+}

package/build/src/core/entities/shipping_method.d.ts

@@ -27,3 +27,31 @@ export declare enum ShippingMethodPolicy {
     private = "private",
     public = "public"
 }
+/**
+ * Input data for creating a new shipping method
+ */
+export interface ShippingMethodCreateInput {
+    name: string;
+    storeId: string;
+    description?: string;
+    logoUrl?: string;
+    ondarkLogoUrl?: string;
+    price?: number;
+    rates?: (number | null)[][] | null;
+    status?: ShippingMethodStatus;
+    policy?: ShippingMethodPolicy;
+    sourceId?: string;
+}
+/**
+ * Input data for updating an existing shipping method
+ */
+export interface ShippingMethodUpdateInput {
+    name?: string;
+    description?: string;
+    logoUrl?: string;
+    ondarkLogoUrl?: string;
+    price?: number;
+    rates?: (number | null)[][] | null;
+    status?: ShippingMethodStatus;
+    policy?: ShippingMethodPolicy;
+}

package/build/src/core/entities/shipping_price.d.ts

@@ -118,3 +118,22 @@ export declare function getAvailableShippingTypes(prices: ShippingPriceRates, co
     type: ShippingPriceType;
     price: number;
 }>;
+/**
+ * Input data for creating a new shipping price
+ */
+export interface ShippingPriceCreateInput {
+    name: string;
+    storeId: string;
+    logoUrl?: string;
+    prices: ShippingPriceRates;
+    status?: ShippingPriceStatus;
+}
+/**
+ * Input data for updating an existing shipping price
+ */
+export interface ShippingPriceUpdateInput {
+    name?: string;
+    logoUrl?: string;
+    prices?: ShippingPriceRates;
+    status?: ShippingPriceStatus;
+}

package/build/src/core/entities/store.d.ts

@@ -46,6 +46,11 @@ export interface StoreEntity {
 }
 export declare const generatePublicStoreIntegrations: (integrations: StoreIntegrations | null | undefined) => PublicStoreIntegrations | null;
 export declare const generatePublicStoreIntegrationCustomFields: (customFields: any | null | undefined) => PublicCustomFieldsIntegration | null | undefined;
+/**
+ * Generates public Meta Pixel integration data from private integration data.
+ * Only exposes non-sensitive information (pixel IDs, active status, objectives).
+ * Sensitive data like oauth2 tokens, pixel API keys, and metadata are NOT exposed.
+ */
 export declare const generatePublicStoreIntegrationMetaPixel: (metaPixel: MetaPixelIntegration | null | undefined) => PublicMetaPixelIntegration | null | undefined;
 export declare const generatePublicStoreIntegrationTiktokPixel: (tiktokPixel: TiktokPixelIntegration | null | undefined) => PublicTiktokPixelIntegration | null | undefined;
 export declare const generatePublicStoreIntegrationGoogleAnalytics: (googleAnalytics: GoogleAnalyticsIntegration | null | undefined) => PublicGoogleAnalyticsIntegration | null | undefined;
@@ -259,6 +264,17 @@ export interface MetaPixel {
     id: string;
     key?: string;
 }
+/**
+ * Facebook Marketing OAuth data
+ * Used for accessing Facebook Marketing API (pixels, ads, etc.)
+ */
+export interface FacebookMarketingOAuth {
+    accessToken: string;
+    tokenType?: string;
+    expiresIn?: number;
+    expiresAt?: string;
+    scopes?: string[];
+}
 export interface TiktokPixel {
     name?: string;
     id: string;
@@ -271,6 +287,8 @@ export interface MetaPixelIntegration {
     draftObjective?: MetaPixelEvent | null;
     active: boolean;
     metadata: Record<string, any>;
+    /** Facebook Marketing OAuth data - for accessing pixels via API */
+    oauth2?: FacebookMarketingOAuth | null;
 }
 export interface TiktokPixelIntegration {
     id: string;
@@ -478,3 +496,90 @@ export interface StoreSubscription {
     remaining: number;
     metadata: Record<string, any>;
 }
+/**
+ * Input data for creating a new store
+ */
+export interface StoreCreateInput {
+    name: string;
+    slug?: string;
+    title?: string;
+    description?: string;
+    iconUrl?: string;
+    logoUrl?: string;
+    ondarkLogoUrl?: string;
+    categories?: EmbaddedCategory[];
+    addresses?: EmbaddedAddress[];
+    contacts?: EmbaddedContact[];
+    decoration?: StoreDecoration;
+    domain?: StoreDomain;
+    banner?: StoreBanner;
+    action?: StoreAction;
+    metadata?: Record<string, any>;
+    defaultShippingRates?: (number | null)[][] | null;
+    shippingPriceId?: string;
+    configs?: StoreConfigs;
+    metaPixelIds?: string[];
+    tiktokPixelIds?: string[];
+    googleAnalyticsId?: string;
+    googleTagsId?: string;
+}
+/**
+ * Input data for updating an existing store
+ */
+export interface StoreUpdateInput {
+    name?: string;
+    slug?: string;
+    title?: string;
+    description?: string;
+    iconUrl?: string;
+    logoUrl?: string;
+    ondarkLogoUrl?: string;
+    categories?: EmbaddedCategory[];
+    addresses?: EmbaddedAddress[];
+    contacts?: EmbaddedContact[];
+    decoration?: StoreDecoration;
+    domain?: StoreDomain;
+    banner?: StoreBanner;
+    action?: StoreAction;
+    metadata?: Record<string, any>;
+    defaultShippingRates?: (number | null)[][] | null;
+    shippingPriceId?: string;
+    configs?: StoreConfigs;
+    metaPixelIds?: string[];
+    tiktokPixelIds?: string[];
+    googleAnalyticsId?: string;
+    googleTagsId?: string;
+    integrations?: StoreIntegrations;
+}
+/**
+ * Store summary data
+ */
+export interface StoreSummary {
+    ordersCount: number;
+    productsCount: number;
+    revenue: number;
+    topProducts?: Array<{
+        id: string;
+        name: string;
+        sold: number;
+    }>;
+    ordersByStatus?: Record<string, number>;
+    recentOrders?: any[];
+}
+/**
+ * Input for adding a store member
+ */
+export interface AddStoreMemberInput {
+    email: string;
+    role: StoreMemberRole;
+    name?: string;
+    metadata?: Record<string, any>;
+}
+/**
+ * Input for updating a store member
+ */
+export interface UpdateStoreMemberInput {
+    role?: StoreMemberRole;
+    name?: string;
+    metadata?: Record<string, any>;
+}

package/build/src/feeef/feeef.d.ts

@@ -11,8 +11,13 @@ import { StateRepository } from './repositories/states.js';
 import { CityRepository } from './repositories/cities.js';
 import { CurrencyRepository } from './repositories/currencies.js';
 import { ShippingPriceRepository } from './repositories/shipping_prices.js';
+import { ShippingMethodRepository } from './repositories/shipping_methods.js';
+import { FeedbackRepository } from './repositories/feedbacks.js';
 import { CartService } from './services/cart.js';
 import { ActionsService } from './services/actions.js';
+import { NotificationsService } from './services/notifications.js';
+import { StorageService } from './services/storage.js';
+import { IntegrationFactory } from './services/integrations.js';
 /**
  * Configuration options for the FeeeF module.
  */
@@ -97,6 +102,14 @@ export declare class FeeeF {
      * The repository for managing shipping prices.
      */
     shippingPrices: ShippingPriceRepository;
+    /**
+     * The repository for managing shipping methods.
+     */
+    shippingMethods: ShippingMethodRepository;
+    /**
+     * The repository for managing feedbacks.
+     */
+    feedbacks: FeedbackRepository;
     /**
      * The cart service for managing the cart.
      */
@@ -105,6 +118,18 @@ export declare class FeeeF {
      * The actions service for performing various actions (file uploads, etc.)
      */
     actions: ActionsService;
+    /**
+     * The notifications service for sending push notifications
+     */
+    notifications: NotificationsService;
+    /**
+     * The storage service for uploading files
+     */
+    storage: StorageService;
+    /**
+     * The integration factory for creating integration API instances
+     */
+    integrations: IntegrationFactory;
     /**
      * Constructs a new instance of the FeeeF class.
      * @param {FeeeFConfig} config - The configuration object.
@@ -114,7 +139,9 @@ export declare class FeeeF {
      */
     constructor({ apiKey, client, cache, baseURL }: FeeeFConfig);
     /**
-     * set header method to set custom headers for all requests
+     * Sets a header for all requests
+     * @param {string} key - The header key.
+     * @param {string} value - The header value.
      */
     setHeader(key: string, value: string): void;
     /**

package/build/src/feeef/repositories/categories.d.ts

@@ -1,13 +1,53 @@
 import { AxiosInstance } from 'axios';
-import { ModelRepository } from './repository.js';
-import { CategoryEntity } from '../../core/entities/category.js';
+import { ModelRepository, ListResponse } from './repository.js';
+import { CategoryEntity, CategoryCreateInput, CategoryUpdateInput } from '../../core/entities/category.js';
+/**
+ * Options for listing categories
+ */
+export interface CategoryListOptions {
+    page?: number;
+    offset?: number;
+    limit?: number;
+    storeId?: string;
+    parentId?: string | null;
+    q?: string;
+    params?: Record<string, any>;
+}
 /**
  * Represents a repository for managing categories.
  */
-export declare class CategoryRepository extends ModelRepository<CategoryEntity, any, any> {
+export declare class CategoryRepository extends ModelRepository<CategoryEntity, CategoryCreateInput, CategoryUpdateInput> {
     /**
      * Creates a new instance of the CategoryRepository class.
      * @param client - The AxiosInstance used for making HTTP requests.
      */
     constructor(client: AxiosInstance);
+    /**
+     * Lists categories with optional filtering.
+     * @param options - The options for listing categories.
+     * @returns A Promise that resolves to a list of Category entities.
+     */
+    list(options?: CategoryListOptions): Promise<ListResponse<CategoryEntity>>;
+    /**
+     * Lists categories for a specific store.
+     * @param storeId - The store ID.
+     * @param options - Optional list options.
+     * @returns A Promise that resolves to a list of Category entities.
+     */
+    listByStore(storeId: string, options?: Omit<CategoryListOptions, 'storeId'>): Promise<ListResponse<CategoryEntity>>;
+    /**
+     * Lists root categories (no parent) for a store.
+     * @param storeId - The store ID.
+     * @param options - Optional list options.
+     * @returns A Promise that resolves to a list of root Category entities.
+     */
+    listRootCategories(storeId: string, options?: Omit<CategoryListOptions, 'storeId' | 'parentId'>): Promise<ListResponse<CategoryEntity>>;
+    /**
+     * Lists child categories for a parent category.
+     * @param storeId - The store ID.
+     * @param parentId - The parent category ID.
+     * @param options - Optional list options.
+     * @returns A Promise that resolves to a list of child Category entities.
+     */
+    listChildren(storeId: string, parentId: string, options?: Omit<CategoryListOptions, 'storeId' | 'parentId'>): Promise<ListResponse<CategoryEntity>>;
 }