@pisell/pisellos 1.0.5 → 1.0.7

package/dist/solution/BookingByStep/index.d.ts

@@ -8,6 +8,7 @@ import { IStep } from '../../modules/Step/tyeps';
 import { TimeSliceItem, ResourceItem } from './utils/resources';
 import { ITime } from '../../modules/Date/types';
 import dayjs from 'dayjs';
+import { LoadScheduleAvailableDateParams } from '../../modules/Schedule/types';
 import { IHolder, IFetchHolderAccountsParams } from '../../modules/AccountList/types';
 export declare class BookingByStepImpl extends BaseModule implements Module {
     protected defaultName: string;
@@ -42,26 +43,70 @@ export declare class BookingByStepImpl extends BaseModule implements Module {
      * 更新step
      */
     updateStep(key: string, step: IStep): void;
+    /**
+     *
+     * 加载商品，然后导到商品列表里去
+     * @param {({
+     *     category_ids?: number[];
+     *     product_ids?: number[];
+     *     collection?: number | string[];
+     *     schedule_date?: string;
+     *   })} {
+     *     category_ids = [],
+     *     product_ids = [],
+     *     collection = [],
+     *     schedule_date,
+     *   }
+     * @return {*}
+     * @memberof BookingByStepImpl
+     */
     loadProducts({ category_ids, product_ids, collection, schedule_date, }: {
         category_ids?: number[];
         product_ids?: number[];
         collection?: number | string[];
         schedule_date?: string;
     }): Promise<any>;
+    /**
+     * 通过 schedule 来读取商品，适用于 session 类商品
+     *
+     * @param {{
+     *     date: string;
+     *     product_ids?: number[];
+     *     category_ids?: number[];
+     *   }} {
+     *     date,
+     *     product_ids = [],
+     *     category_ids = [],
+     *   }
+     * @return {*}
+     * @memberof BookingByStepImpl
+     */
     loadProductByScheduleDate({ date, product_ids, category_ids, }: {
         date: string;
         product_ids?: number[];
         category_ids?: number[];
     }): Promise<any>;
+    /**
+     * 更新完商品数据、切换日期、或者在较后的流程里登录了，检测当前购物车里是否有商品，如果有，则需要更新购物车里的商品价格
+     *
+     * @param {string} date
+     * @memberof BookingByStepImpl
+     */
     updateQuotationPriceAndCart(date: string): Promise<void>;
-    loadAllSchedule(): Promise<void>;
-    loadScheduleAvailableDate({ startDate, endDate, custom_page_id, channel, }: {
-        startDate: string;
-        endDate: string;
-        custom_page_id?: number;
-        channel?: string;
-    }): Promise<ITime[]>;
-    storeProduct(productData: ProductData): Promise<void>;
+    /**
+     * ui 层提供日期的起始范围，返回一个起始范围内日期的可用情况
+     * 适用于先选日期的流程，确定日期是否可用
+     * 已知问题：如果挂接的商品的资源不可用，后端是不会计算的
+     *
+     * @param {LoadScheduleAvailableDateParams} {
+     *     startDate,
+     *     endDate,
+     *     custom_page_id,
+     *     channel,
+     *   }
+     * @memberof BookingByStepImpl
+     */
+    loadScheduleAvailableDate({ startDate, endDate, custom_page_id, channel, }: LoadScheduleAvailableDateParams): Promise<ITime[]>;
     addAccount(account: Account | IHolder, extra?: {
         type: 'account' | 'holder';
         customerId: number;
@@ -73,7 +118,7 @@ export declare class BookingByStepImpl extends BaseModule implements Module {
     getAccounts(): Promise<(Account | null)[]>;
     checkHasLoginAccount(): boolean;
     setActiveAccount(id: string): void;
-    getActiveAccount(): Account | null;
+    getActiveAccount(): Account | undefined;
     removeAccount(id: string): void;
     /**
      * 获取holder类型账户列表
@@ -126,7 +171,60 @@ export declare class BookingByStepImpl extends BaseModule implements Module {
         cover?: boolean;
     }): Promise<void>;
     getOtherParams(): Promise<Record<string, any>>;
+    /**
+     * 往购物车加商品数据(duration 类、普通商品)
+     * 老接口，先不删，怕 UI 有问题，直接桥接到新接口addProductToCart上
+     *
+     * @param {ProductData} productData
+     * @memberof BookingByStepImpl
+     */
+    storeProduct(productData: ProductData): Promise<void>;
+    /**
+     * 往购物车加商品数据
+     *
+     * @param {({
+     *     product: ProductData;
+     *     date?: { startTime: string; endTime: string } | null;
+     *     account?: Account | null;
+     *   })} {
+     *     product,
+     *     date,
+     *     account,
+     *   }
+     * @return {*}
+     * @memberof BookingByStepImpl
+     */
+    addProductToCart({ product, date, account, }: {
+        product: ProductData;
+        date?: {
+            startTime: string;
+            endTime: string;
+        } | null;
+        account?: Account | null;
+    }): void;
+    /**
+     * 添加完购物车以后做的一些检测，比如日期是否在同一天
+     *
+     * @param {({ date?: { startTime: string; endTime: string } | null })} { date }
+     * @memberof BookingByStepImpl
+     */
+    addProductCheck({ date, }: {
+        date?: {
+            startTime: string;
+            endTime: string;
+        } | null;
+    }): void;
+    beforeUpdateCart(params: IUpdateItemParams, targetCartItem: CartItem): void;
     updateCart(params: IUpdateItemParams): void;
+    /**
+     * 更新购物车以后的一些操作，比如检测资源是否重复，检测资源容量是否足够
+     *
+     * @param {IUpdateItemParams} params
+     * @param {CartItem} targetCartItem
+     * @return {*}
+     * @memberof BookingByStepImpl
+     */
+    updateCartCheck(params: IUpdateItemParams, targetCartItem: CartItem): void;
     deleteCart(cartItemId: string): void;
     clearCart(): void;
     clearCartByAccount(account_id: string): void;
@@ -147,7 +245,20 @@ export declare class BookingByStepImpl extends BaseModule implements Module {
     checkCartItems(type: ECartItemCheckType): string[];
     destroy(): void;
     getResourcesList(): any[];
+    /**
+     * 在日期那边点击下一步的时候，检查这一天购物车里的商品是不是都有资源可以用
+     *
+     * @return {*}
+     * @memberof BookingByStepImpl
+     */
     checkResourceListForDate(): boolean;
+    /**
+     * 给单个购物车里的商品获取资源列表，给 UI 用的
+     *
+     * @param {(string | number)} id
+     * @return {*}
+     * @memberof BookingByStepImpl
+     */
     getResourcesListByCartItem(id: string | number): {
         id: number | undefined;
         _id: string;
@@ -156,11 +267,6 @@ export declare class BookingByStepImpl extends BaseModule implements Module {
         holder_id: string | number | undefined;
         holder_name: string | undefined;
     } | undefined;
-    getResourceTimeSlot({ product, resources, currentResourceId, }: {
-        product: ProductData;
-        resources: any[];
-        currentResourceId: number;
-    }): TimeSliceItem[];
     autoSelectAccountResources({ cartItem, holder_id, resources_code, timeSlots, countMap, capacity, }: {
         cartItem: CartItem;
         holder_id: string;
@@ -204,14 +310,6 @@ export declare class BookingByStepImpl extends BaseModule implements Module {
         count: number;
         left: number;
     }[];
-    addProductToCart({ product, date, account, }: {
-        product: ProductData;
-        date: {
-            startTime: string;
-            endTime: string;
-        };
-        account: Account;
-    }): void;
     setOtherData(key: string, value: any): void;
     getOtherData(key: string): any;
     getProductTypeById(id: number): Promise<"duration" | "session" | "normal">;
@@ -235,14 +333,6 @@ export declare class BookingByStepImpl extends BaseModule implements Module {
         scheduleIds?: number[];
         resources?: ProductResourceItem[];
     }): Promise<Record<string, TimeSliceItem[]>>;
-    getAvailableDateForSession(params?: {
-        startDate?: string;
-        endDate?: string;
-        type?: 'month';
-    }): Promise<{
-        dateList: ITime[];
-        firstAvailableDate: ITime | undefined;
-    }>;
     getAvailableDateForSessionOptimize(params?: {
         startDate?: string;
         endDate?: string;