@lemoncloud/ssocio-stacks-api 0.23.1212 → 0.24.107

package/dist/lib/seats-types.d.ts

@@ -0,0 +1,237 @@
+/**
+ * `lib/seats-types.ts`
+ * - types for seat-reservation support
+ *
+ *
+ * @author      Aiden <aiden@lemoncloud.io>
+ * @date        2024-04-18 initial version
+ *
+ * @copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { User } from '../service/backend-types';
+import { GenericNode } from './types';
+/**
+ * defines the possible types
+ */
+export declare const $SeatLUT: {
+    /**
+     * 좌석 항목의 종류들
+     */
+    SeatStereo: {
+        /** 기본형 */
+        '': string;
+        /** 예약그룹 */
+        group: string;
+        /** 예약단위 */
+        unit: string;
+    };
+    /**
+     * 좌석 유닛의 항목
+     */
+    SeatUnitType: {
+        '': string;
+        /** 스크린골프 */
+        golf: string;
+        /** 독서실 */
+        reading: string;
+    };
+    /**
+     * 좌석 상태의 항목
+     */
+    SeatStateType: {
+        /** 선택없음 */
+        '': string;
+        /** 예약중 */
+        reserved: string;
+        /** 예약가능 */
+        onSale: string;
+        /** 점검중 */
+        disabled: string;
+        /** 이용중 */
+        inUse: string;
+        /** 이용완료 */
+        used: string;
+        /** 취소 */
+        canceled: string;
+        /** 대기중 */
+        standBy: string;
+        /** 예약불가 */
+        unable: string;
+        /** 마감 */
+        closed: string;
+    };
+    /**
+     * 좌석 그룹의 타입
+     */
+    GroupType: {
+        /** 월권  */
+        monthly: string;
+        /** 일권 */
+        daily: string;
+        /** 시간권 */
+        time: string;
+    };
+};
+/**
+ * stereo-type in seat
+ */
+export declare type SeatStereo = keyof typeof $SeatLUT.SeatStereo;
+/**
+ * input type in seat
+ */
+export declare type SeatUnitType = keyof typeof $SeatLUT.SeatUnitType;
+/**
+ * status type in seat
+ */
+export declare type SeatStateType = keyof typeof $SeatLUT.SeatStateType;
+/**
+ * group-type in seat
+ */
+export declare type GroupType = keyof typeof $SeatLUT.GroupType;
+/**
+ * type: `SeatState`
+ * - internal state of each seat elements
+ */
+export interface SeatState {
+    /**
+     * internally invalidated. (like deleted)
+     */
+    invalid?: boolean;
+    /**
+     * soldout not for sale. (displayed but soldout)
+     */
+    state?: SeatStateType;
+}
+/**
+ * type: `Seat`
+ * - common class for seat sub-class
+ */
+export interface Seat<T extends SeatStereo = SeatStereo> extends SeatState {
+    /**
+     * local id of seat
+     */
+    id: string;
+    /**
+     * stereo types.
+     */
+    stereo?: T;
+    /** seat-id (which is unique in seat-model) */
+    oid?: string;
+    /** item-id linked */
+    iid?: string;
+    /** prod-id linked */
+    pid?: string;
+    /** 해당 예약 인스턴스의 시작 시각 정보 */
+    seatStartTime?: number;
+    /** 해당 예약 인스턴스의 종료 시각 정보 */
+    seatEndTime?: number;
+    /**
+     * 해당 예약 인스턴스의 시작 구간 텍스트 타입
+     * - ex) "20:00"
+     */
+    seatT1?: string;
+    /**
+     * 해당 예약 인스턴스의 종료 구간 텍스트 타입
+     * - ex) "21:00"
+     */
+    seatT2?: string;
+    /** 해당 날짜의 텍스트 */
+    fullDate?: string;
+    /** 해당 날짜의 요일 */
+    dayOfAWeek?: number;
+    /** 설정된 시분할 기준값 (분) */
+    duration?: number;
+    /** (linked) the target program-id */
+    programId?: string;
+    /** (linked) the target zone-id */
+    zoneId?: string;
+    /**
+     * (optional) internal last error.
+     */
+    error?: string;
+}
+/**
+ * type: `SeatGroup`
+ * --------------
+ */
+export interface SeatGroup extends Seat<'group'> {
+    /** name of this instance */
+    name?: string;
+    /**
+     * price of seat
+     */
+    price?: number;
+    /**
+     * list of types
+     * - in summary of seats.
+     */
+    units?: SeatUnit[];
+    /** (optional) 매핑된 상품 단위 */
+    prodType?: GroupType;
+    /** (optional) 사용 만료 일자 */
+    endDate?: string;
+    /** (optional) 좌석 할당 시각 */
+    assignedAt?: number;
+    /** (optional) 좌석 취소 시각 */
+    canceledAt?: number;
+    /**
+     * (optional) 주문자 정보
+     */
+    orderer?: User;
+    /** (linked) the origin orider-id via `ssocio-orders-api` */
+    orderId?: string;
+}
+/**
+ * type: `seat-unit`
+ * - single element which can be selected from seat.
+ * - 기본적으로 판메 `재고`를 가지고 있는 단위.
+ */
+export interface SeatUnit extends Seat<'unit'> {
+    /**
+     * name of this unit
+     */
+    name?: string;
+    /**
+     * parent-id (= id of seat-group)
+     */
+    parent?: string;
+    /**
+     * type of unit
+     */
+    unitType?: string;
+    /**
+     * possible stocks (integer)
+     */
+    stock?: number;
+    /** 해당 예약 인스턴스의 판매일 여부 */
+    isBusinessDay?: boolean;
+    /** 해당 예약 인스턴스의 공휴일 여부 */
+    isHoliday?: boolean;
+    /** 해당 예약 인스턴스의 할인일 여부 */
+    isSaleDay?: boolean;
+    /** 해당 예약 인스턴스의 예약제한 여부 */
+    isDisableDay?: boolean;
+    /** (optional) the assignd stock-id  */
+    stockId?: string;
+    /** (optional) the assignd ticket-id  */
+    ticketId?: string;
+}
+/**
+ * types in seat-root.
+ */
+export declare type SeatRoots = SeatGroup;
+/**
+ * seat's hyper modeling
+ * - supporting all stereo into single seat data.
+ *
+ * NOTE
+ * - 좌석 생성 설정과 재고 인스턴스를 분리할 필요가 있음. (재고 없으면 인스턴스 생성 할필요 없을듯!!)
+ */
+export interface SeatNode extends GenericNode {
+    /** seat id */
+    id?: string;
+    /** this name */
+    name?: string;
+    /** single-line option-text */
+    option?: string;
+}

package/dist/lib/types.d.ts

@@ -11,6 +11,7 @@
  */
 export * from './categories-types';
 export * from './stocks-types';
+export * from './seats-types';
 /**
  * a node represent.
  */