feeef 0.6.0 → 0.6.3

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

@@ -0,0 +1,330 @@
+import { AxiosInstance } from 'axios';
+/**
+ * Delivery fees structure - Array of [home, desk] prices per state
+ */
+export type DeliveryFees = (number | null)[][];
+/**
+ * Ecotrack delivery integration configuration
+ */
+export interface EcotrackDeliveryIntegration {
+    baseUrl: string;
+    token: string;
+    active?: boolean;
+    metadata?: Record<string, any>;
+}
+/**
+ * Ecotrack finance data
+ */
+export interface EcotrackFinanceData {
+    success: boolean;
+    amountsNotEncaissed: number;
+    feesNotEncaissed: number;
+    notEncaissed: number;
+    amountsEncaissed: number;
+    feesEncaissed: number;
+    encaissed: number;
+    amountsPaymentReady: number;
+    feesPaymentReady: number;
+    paymentReady: number;
+}
+/**
+ * Ecotrack wilaya (state) statistics
+ */
+export interface EcotrackWilayaData {
+    wilayaId: number;
+    total: number;
+    retours: number;
+    livred: number;
+    wilayaName: string;
+}
+/**
+ * Ecotrack today's activity
+ */
+export interface EcotrackTodayActivity {
+    expedie: number;
+    delivered: number;
+    returned: number;
+    suspended: number;
+}
+/**
+ * Ecotrack global statistics
+ */
+export interface EcotrackGlobalStats {
+    enTraitement: number;
+    livred: number;
+    retours: number;
+    total: number;
+}
+/**
+ * Ecotrack statistics data
+ */
+export interface EcotrackStatisticsData {
+    topWilaya: EcotrackWilayaData[];
+    todayActivity: EcotrackTodayActivity;
+    globalStats: EcotrackGlobalStats;
+}
+/**
+ * Ecotrack sync result
+ */
+export interface EcotrackSyncResult {
+    success: boolean;
+    message: string;
+    syncId?: string;
+    totalFetched?: number;
+    totalUpdated?: number;
+    totalSkipped?: number;
+    syncedAt?: string;
+    errors?: string[];
+}
+/**
+ * Ecotrack sync status
+ */
+export interface EcotrackSyncStatus {
+    canSync: boolean;
+    lastSyncAt?: string;
+    nextSyncAvailableAt?: string;
+    minutesUntilNextSync?: number;
+}
+/**
+ * Ecotrack Delivery Integration API
+ */
+export declare class EcotrackDeliveryIntegrationApi {
+    private client;
+    private integration;
+    private storeId;
+    constructor(client: AxiosInstance, integration: EcotrackDeliveryIntegration, storeId: string);
+    /**
+     * Gets delivery fees from Ecotrack
+     */
+    getDeliveryFees(): Promise<DeliveryFees>;
+    /**
+     * Gets financial data from Ecotrack
+     */
+    getFinancialData(options?: {
+        limit?: number;
+        search?: string;
+        telephone?: string;
+    }): Promise<EcotrackFinanceData>;
+    /**
+     * Gets statistics data from Ecotrack
+     */
+    getStatistics(): Promise<EcotrackStatisticsData>;
+    /**
+     * Gets the sync status for this store's Ecotrack integration
+     */
+    getSyncStatus(): Promise<EcotrackSyncStatus>;
+    /**
+     * Triggers a sync of orders from Ecotrack
+     */
+    triggerSync(options?: {
+        startDate?: Date | string;
+        endDate?: Date | string;
+    }): Promise<EcotrackSyncResult>;
+}
+/**
+ * Yalidine agent type
+ */
+export declare enum YalidineAgent {
+    yalidine = "yalidine",
+    guepex = "guepex"
+}
+/**
+ * Yalidine delivery integration configuration
+ */
+export interface YalidineDeliveryIntegration {
+    id: string;
+    token: string;
+    agent?: YalidineAgent;
+    active?: boolean;
+    metadata?: Record<string, any>;
+}
+/**
+ * Yalidine Delivery Integration API
+ */
+export declare class YalidineDeliveryIntegrationApi {
+    private client;
+    private integration;
+    private storeId;
+    constructor(client: AxiosInstance, integration: YalidineDeliveryIntegration, storeId: string);
+    /**
+     * Gets delivery fees from Yalidine
+     */
+    getDeliveryFees(): Promise<DeliveryFees>;
+}
+/**
+ * Procolis delivery integration configuration
+ */
+export interface ProcolisDeliveryIntegration {
+    key: string;
+    token: string;
+    active?: boolean;
+    metadata?: Record<string, any>;
+}
+/**
+ * Procolis Delivery Integration API
+ */
+export declare class ProcolisDeliveryIntegrationApi {
+    private client;
+    private integration;
+    private storeId;
+    constructor(client: AxiosInstance, integration: ProcolisDeliveryIntegration, storeId: string);
+    /**
+     * Gets delivery fees from Procolis
+     */
+    getDeliveryFees(): Promise<DeliveryFees>;
+    /**
+     * Sends an order to Procolis
+     */
+    send(orderId: string): Promise<void>;
+}
+/**
+ * Noest delivery integration configuration
+ */
+export interface NoestDeliveryIntegration {
+    guid: string;
+    token: string;
+    active?: boolean;
+    metadata?: Record<string, any>;
+}
+/**
+ * Noest Delivery Integration API
+ */
+export declare class NoestDeliveryIntegrationApi {
+    private client;
+    private integration;
+    private storeId;
+    constructor(client: AxiosInstance, integration: NoestDeliveryIntegration, storeId: string);
+    /**
+     * Gets delivery fees from Noest
+     */
+    getDeliveryFees(): Promise<DeliveryFees>;
+    /**
+     * Sends an order to Noest
+     */
+    send(orderId: string): Promise<void>;
+}
+/**
+ * Google Sheets integration configuration for API calls
+ * (Note: For store integrations, use GoogleSheetsIntegration from store.ts)
+ */
+export interface GoogleSheetsIntegrationConfig {
+    id: string;
+    name: string;
+    active?: boolean;
+    oauth2?: Record<string, any>;
+    metadata?: Record<string, any>;
+    simple?: boolean;
+    columns?: Array<{
+        field: string;
+        name: string;
+        enabled: boolean;
+        defaultValue?: any;
+    }>;
+}
+/**
+ * Google Sheets Integration API
+ */
+export declare class GoogleSheetIntegrationApi {
+    private client;
+    private integration;
+    private storeId;
+    constructor(client: AxiosInstance, integration: GoogleSheetsIntegrationConfig, storeId: string);
+    /**
+     * Appends a row to the Google Sheet
+     */
+    appendRow(values: string[]): Promise<void>;
+    /**
+     * Creates a new spreadsheet
+     */
+    createSpreadsheet(name: string): Promise<void>;
+}
+/**
+ * Zimou delivery integration configuration
+ */
+export interface ZimouDeliveryIntegration {
+    id: string;
+    apiKey: string;
+    active?: boolean;
+    silentMode?: boolean;
+    autoSend?: boolean;
+    metadata?: Record<string, any>;
+}
+/**
+ * Zimou Delivery Integration API
+ */
+export declare class ZimouDeliveryIntegrationApi {
+    private client;
+    private integration;
+    private storeId;
+    constructor(client: AxiosInstance, integration: ZimouDeliveryIntegration, storeId: string);
+    /**
+     * Gets delivery fees from Zimou
+     */
+    getDeliveryFees(): Promise<DeliveryFees>;
+    /**
+     * Sends an order to Zimou
+     */
+    send(orderId: string): Promise<void>;
+}
+/**
+ * Ecomanager delivery integration configuration
+ */
+export interface EcomanagerDeliveryIntegration {
+    baseUrl: string;
+    token: string;
+    active?: boolean;
+    autoSend?: boolean;
+    metadata?: Record<string, any>;
+}
+/**
+ * Ecomanager Delivery Integration API
+ */
+export declare class EcomanagerDeliveryIntegrationApi {
+    private client;
+    private integration;
+    private storeId;
+    constructor(client: AxiosInstance, integration: EcomanagerDeliveryIntegration, storeId: string);
+    /**
+     * Gets delivery fees from Ecomanager
+     */
+    getDeliveryFees(): Promise<DeliveryFees>;
+    /**
+     * Sends an order to Ecomanager
+     */
+    send(orderId: string): Promise<void>;
+}
+/**
+ * Factory for creating integration API instances
+ */
+export declare class IntegrationFactory {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * Creates an Ecotrack integration API
+     */
+    ecotrack(integration: EcotrackDeliveryIntegration, storeId: string): EcotrackDeliveryIntegrationApi;
+    /**
+     * Creates a Yalidine integration API
+     */
+    yalidine(integration: YalidineDeliveryIntegration, storeId: string): YalidineDeliveryIntegrationApi;
+    /**
+     * Creates a Procolis integration API
+     */
+    procolis(integration: ProcolisDeliveryIntegration, storeId: string): ProcolisDeliveryIntegrationApi;
+    /**
+     * Creates a Noest integration API
+     */
+    noest(integration: NoestDeliveryIntegration, storeId: string): NoestDeliveryIntegrationApi;
+    /**
+     * Creates a Google Sheets integration API
+     */
+    googleSheets(integration: GoogleSheetsIntegrationConfig, storeId: string): GoogleSheetIntegrationApi;
+    /**
+     * Creates a Zimou integration API
+     */
+    zimou(integration: ZimouDeliveryIntegration, storeId: string): ZimouDeliveryIntegrationApi;
+    /**
+     * Creates an Ecomanager integration API
+     */
+    ecomanager(integration: EcomanagerDeliveryIntegration, storeId: string): EcomanagerDeliveryIntegrationApi;
+}

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

@@ -0,0 +1,68 @@
+import type { AxiosInstance } from 'axios';
+/**
+ * Options for sending a notification
+ */
+export interface SendNotificationOptions {
+    /**
+     * Notification title (required)
+     * Max 100 characters (FCM recommendation)
+     */
+    title: string;
+    /**
+     * Notification body/message (required)
+     * Max 4000 characters (FCM recommendation)
+     */
+    body: string;
+    /**
+     * Additional data payload (optional)
+     * Key-value pairs sent with the notification
+     */
+    data?: Record<string, string>;
+    /**
+     * Click URL (optional)
+     * URL to open when notification is clicked
+     */
+    clickUrl?: string;
+    /**
+     * Sound file name (optional)
+     * Default: 'default'
+     */
+    sound?: string;
+    /**
+     * Filterator JSON string for advanced user filtering (optional)
+     * Supports complex filtering conditions - same format as users page
+     */
+    filterator?: string | object;
+    /**
+     * Other standard user filter parameters
+     */
+    q?: string;
+    page?: number;
+    limit?: number;
+}
+/**
+ * Response from sending notifications
+ */
+export interface SendNotificationResponse {
+    message: string;
+    stats: {
+        usersProcessed: number;
+        tokensSent: number;
+        tokensFailed: number;
+        errors?: string[];
+    };
+}
+/**
+ * Service for managing notifications
+ */
+export declare class NotificationsService {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * Send notifications to filtered users
+     * Admin only - uses filterator to filter users
+     * @param options - Notification options including filterator
+     * @returns Promise that resolves to send statistics
+     */
+    send(options: SendNotificationOptions): Promise<SendNotificationResponse>;
+}

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

@@ -0,0 +1,134 @@
+import { AxiosInstance, CancelToken } from 'axios';
+/**
+ * Options for uploading a file
+ */
+export interface UploadOptions {
+    /** The file to upload */
+    file: File | Blob;
+    /** Optional folder path */
+    folder?: string;
+    /** Progress callback */
+    onProgress?: (progress: UploadProgress) => void;
+    /** Cancel token for aborting the upload */
+    cancelToken?: CancelToken;
+}
+/**
+ * Upload progress information
+ */
+export interface UploadProgress {
+    /** Bytes sent */
+    loaded: number;
+    /** Total bytes */
+    total: number;
+    /** Progress percentage (0-100) */
+    percentage: number;
+}
+/**
+ * Upload result
+ */
+export interface UploadResult {
+    /** URL of the uploaded file */
+    url: string;
+}
+/**
+ * Options for uploading bytes
+ */
+export interface UploadBytesOptions {
+    /** The bytes to upload */
+    bytes: Uint8Array | ArrayBuffer;
+    /** The filename */
+    filename: string;
+    /** Optional folder path */
+    folder?: string;
+    /** Progress callback */
+    onProgress?: (progress: UploadProgress) => void;
+    /** Cancel token for aborting the upload */
+    cancelToken?: CancelToken;
+}
+/**
+ * Storage service for uploading files
+ */
+export declare class StorageService {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * Uploads a file
+     * @param options - Upload options
+     * @returns Promise resolving to the upload result
+     */
+    upload(options: UploadOptions): Promise<UploadResult>;
+    /**
+     * Uploads bytes directly
+     * @param options - Upload options
+     * @returns Promise resolving to the upload result
+     */
+    uploadBytes(options: UploadBytesOptions): Promise<UploadResult>;
+    /**
+     * Uploads a file for a store
+     * @param file - The file to upload
+     * @param storeId - The store ID
+     * @param options - Additional options
+     * @returns Promise resolving to the upload result
+     */
+    uploadStoreFile(file: File | Blob, storeId: string, options?: {
+        subfolder?: string;
+        onProgress?: (progress: UploadProgress) => void;
+        cancelToken?: CancelToken;
+    }): Promise<UploadResult>;
+    /**
+     * Uploads a product image
+     * @param file - The file to upload
+     * @param storeId - The store ID
+     * @param productId - The product ID
+     * @param options - Additional options
+     * @returns Promise resolving to the upload result
+     */
+    uploadProductImage(file: File | Blob, storeId: string, productId: string, options?: {
+        onProgress?: (progress: UploadProgress) => void;
+        cancelToken?: CancelToken;
+    }): Promise<UploadResult>;
+    /**
+     * Uploads a store logo
+     * @param file - The file to upload
+     * @param storeId - The store ID
+     * @param options - Additional options
+     * @returns Promise resolving to the upload result
+     */
+    uploadStoreLogo(file: File | Blob, storeId: string, options?: {
+        onProgress?: (progress: UploadProgress) => void;
+        cancelToken?: CancelToken;
+    }): Promise<UploadResult>;
+    /**
+     * Uploads a store icon
+     * @param file - The file to upload
+     * @param storeId - The store ID
+     * @param options - Additional options
+     * @returns Promise resolving to the upload result
+     */
+    uploadStoreIcon(file: File | Blob, storeId: string, options?: {
+        onProgress?: (progress: UploadProgress) => void;
+        cancelToken?: CancelToken;
+    }): Promise<UploadResult>;
+    /**
+     * Uploads a user avatar
+     * @param file - The file to upload
+     * @param userId - The user ID
+     * @param options - Additional options
+     * @returns Promise resolving to the upload result
+     */
+    uploadUserAvatar(file: File | Blob, userId: string, options?: {
+        onProgress?: (progress: UploadProgress) => void;
+        cancelToken?: CancelToken;
+    }): Promise<UploadResult>;
+    /**
+     * Uploads a feedback attachment
+     * @param file - The file to upload
+     * @param feedbackId - The feedback ID
+     * @param options - Additional options
+     * @returns Promise resolving to the upload result
+     */
+    uploadFeedbackAttachment(file: File | Blob, feedbackId: string, options?: {
+        onProgress?: (progress: UploadProgress) => void;
+        cancelToken?: CancelToken;
+    }): Promise<UploadResult>;
+}

package/build/src/index.d.ts

@@ -10,16 +10,31 @@ export * from './core/entities/country.js';
 export * from './core/entities/state.js';
 export * from './core/entities/city.js';
 export * from './core/entities/currency.js';
+export * from './core/entities/feedback.js';
+export * from './feeef/repositories/repository.js';
 export * from './feeef/repositories/deposits.js';
 export * from './feeef/repositories/transfers.js';
 export * from './feeef/repositories/shipping_prices.js';
+export * from './feeef/repositories/shipping_methods.js';
 export * from './feeef/repositories/users.js';
-export type { TransferEntity, TransferCreateInput } from './feeef/repositories/transfers.js';
-export type { DepositEntity, DepositCreateInput } from './feeef/repositories/deposits.js';
+export * from './feeef/repositories/stores.js';
+export * from './feeef/repositories/products.js';
+export * from './feeef/repositories/orders.js';
+export * from './feeef/repositories/categories.js';
+export * from './feeef/repositories/feedbacks.js';
+export * from './feeef/repositories/countries.js';
+export * from './feeef/repositories/states.js';
+export * from './feeef/repositories/cities.js';
+export * from './feeef/repositories/currencies.js';
+export type { TransferEntity, TransferCreateInput, TransferUpdateInput, TransferType, TransferListOptions, } from './feeef/repositories/transfers.js';
+export type { DepositEntity, DepositCreateInput, DepositUpdateInput, DepositStatus, DepositListOptions, PayPalOrderResponse, PayPalCaptureResponse, } from './feeef/repositories/deposits.js';
 export * from './core/embadded/address.js';
 export * from './core/embadded/category.js';
 export * from './core/embadded/contact.js';
 export * from './feeef/services/cart.js';
 export * from './feeef/services/actions.js';
+export * from './feeef/services/notifications.js';
+export * from './feeef/services/storage.js';
+export * from './feeef/services/integrations.js';
 export * from './utils.js';
 export type { StoreIntegrations } from './core/entities/store.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "feeef",
   "description": "feeef sdk for javascript",
-  "version": "0.6.0",
+  "version": "0.6.3",
   "main": "build/index.js",
   "type": "module",
   "files": [