@lemoncloud/ssocio-stacks-api 0.23.313

package/dist/view/types.d.ts

@@ -0,0 +1,204 @@
+/**
+ * `types.ts`
+ * - view types used in API controllers and transformer
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-06-21 optimized w/ `abstract-services`
+ *
+ * @copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { View, Body } from '../cores/types';
+import { BankModel, TestModel, ProgramModel, CategoryModel, PaymentModel, CancelModel, DisplayModel, PeriodEnrollModel, TimeEnrollModel, PushNotificationModel, ProgramOperatorModel, FirmModel } from '../service/backend-model';
+/**
+ * type: `CategoryView`
+ */
+export interface CategoryView extends View, Omit<Partial<CategoryModel>, 'hidden'> {
+    /** hidden(숨김) flag */
+    hidden?: boolean;
+}
+/**
+ * type: `CategoryBody`
+ */
+export interface CategoryBody extends Body, Partial<CategoryView> {
+}
+/**
+ * type: `ProgramView`
+ */
+export interface ProgramView extends View, Omit<Partial<ProgramModel>, 'payment$' | 'cancel$' | 'display$' | 'period$' | 'time$' | 'push$' | 'operator$' | 'useNumOfPeopleLimit' | 'useImage' | 'useFacilityInfo' | 'useAutoExtend' | 'usePushNotification'> {
+    /** (optional) 프로그램 결제 정보를 보여줌 */
+    readonly payment$?: PaymentView;
+    /** (optional) 프로그램 취소 정보를 보여줌 */
+    readonly cancel$?: CancelView;
+    /** (optional) 프로그램 결제 정보를 보여줌 */
+    readonly display$?: DisplayView;
+    /** (optional) 프로그램 기간 신청 관리 정보를 보여줌 */
+    readonly period$?: PeriodEnrollView;
+    /** (optional) 프로그램 시간 신청 관리 정보를 보여줌 */
+    readonly time$?: TimeEnrollView;
+    /** (optional) 푸쉬 관리 정보를 보여줌 */
+    readonly push$?: PushNotificationView;
+    /** (optional) 업체/강사 관리 정보를 보여줌 */
+    readonly operator$?: ProgramOperatorView;
+    /** flag of use 인원 제한 */
+    useNumOfPeopleLimit?: boolean;
+    /** flag of use 이미지 사용 */
+    useImage?: boolean;
+    /** flag of use 시설 정보 */
+    useFacilityInfo?: boolean;
+    /** flag of use 자동 연장 */
+    useAutoExtend?: boolean;
+    /** flag of use 푸쉬 알람 */
+    usePushNotification?: boolean;
+}
+/**
+ * type: `ProgramBody`
+ */
+export interface ProgramBody extends Body, Omit<Partial<ProgramView>, 'payment$' | 'cancel$' | 'display$' | 'period$' | 'time$' | 'operator$'> {
+    /** (optional) 프로그램 결제 정보를 가짐 */
+    payment$?: PaymentBody;
+    /** (optional) 프로그램 취소 정보를 가짐 */
+    cancel$?: CancelBody;
+    /** (optional) 프로그램 결제 정보를 가짐 */
+    display$?: DisplayBody;
+    /** (optional) 프로그램 기간 신청 관리 정보를 가짐 */
+    period$?: PeriodEnrollBody;
+    /** (optional) 프로그램 시간 신청 관리 정보를 가짐 */
+    time$?: TimeEnrollBody;
+    /** (optional) 업체/강사 관리 정보를 가짐 */
+    operator$?: ProgramOperatorBody;
+}
+/**
+ * type: `PaymentView`
+ */
+export interface PaymentView extends View, Omit<Partial<PaymentModel>, 'useTenant'> {
+    /** 세대원 선택 여부 flag*/
+    useTenant?: boolean;
+}
+/**
+ * type: `PaymentBody`
+ */
+export interface PaymentBody extends Body, Partial<PaymentView> {
+}
+/**
+ * type: `CancelView`
+ */
+export interface CancelView extends View, Omit<Partial<CancelModel>, 'useCancellationPeriod' | 'usePenalty' | 'useCollectReason'> {
+    /** 취소 기간 사용 (허용) 여부 flag*/
+    useCancellationPeriod?: boolean;
+    /** 위약금 사용 여부 flag */
+    usePenalty?: boolean;
+    /** 취소 사유 수집 사용 여부 flag */
+    useCollectReason?: boolean;
+}
+/**
+ * type: `CancelBody`
+ */
+export interface CancelBody extends Body, Partial<CancelView> {
+}
+/**
+ * type: `DisplayView`
+ */
+export interface DisplayView extends View, Omit<Partial<DisplayModel>, 'useDisplay'> {
+    /** 노출 상태 여부 flag */
+    useDisplay?: boolean;
+}
+/**
+ * type: `DisplayBody`
+ */
+export interface DisplayBody extends Body, Partial<DisplayView> {
+}
+/**
+ * type: `PeriodEnrollView`
+ */
+export interface PeriodEnrollView extends View, Omit<Partial<PeriodEnrollModel>, 'useMonthly' | 'useDaily' | 'useEarlyRegister' | 'useAutoExtension'> {
+    /** 월권 신청 사용 여부 flag */
+    useMonthly?: boolean;
+    /** 일권 신청 사용 여부 flag */
+    useDaily?: boolean;
+    /** 우선 등록 여부 flag */
+    useEarlyRegister?: boolean;
+    /** 자동 연장 사용 여부 flag */
+    useAutoExtension?: boolean;
+}
+/**
+ * type: `PeriodEnrollBody`
+ */
+export interface PeriodEnrollBody extends Body, Partial<PeriodEnrollView> {
+}
+/**
+ * type: `TimeEnrollView`
+ */
+export interface TimeEnrollView extends View, Omit<Partial<TimeEnrollModel>, 'useTimeLimit' | 'useDayOfTheWeekPolicy'> {
+    /** 시간 제한 사용 여부 flag */
+    useTimeLimit?: boolean;
+    /** 요일 정책 사용 여부 flag  */
+    useDayOfTheWeekPolicy?: boolean;
+}
+/**
+ * type: `TimeEnrollBody`
+ */
+export interface TimeEnrollBody extends Body, Partial<TimeEnrollView> {
+}
+/**
+ * type: `PushNotificationView`
+ */
+export interface PushNotificationView extends View, Partial<PushNotificationModel> {
+}
+/**
+ * type: `PushNotificationBody`
+ */
+export interface PushNotificationBody extends Body, Partial<PushNotificationView> {
+}
+/**
+ * type: `ProgramOperatorView`
+ */
+export interface ProgramOperatorView extends View, Omit<Partial<ProgramOperatorModel>, 'useProfileDisplay'> {
+    /** 프로필 노출 여부 flag */
+    useProfileDisplay?: boolean;
+}
+/**
+ * type: `ProgramOperatorBody`
+ */
+export interface ProgramOperatorBody extends Body, Partial<ProgramOperatorView> {
+}
+/**
+ * type: `FirmView`
+ */
+export interface FirmView extends View, Omit<Partial<FirmModel>, 'isValid'> {
+    /** 협력 업체 유효 여부 flag */
+    isValid?: boolean;
+}
+/**
+ * type: `FirmBody`
+ */
+export interface FirmBody extends Body, Partial<FirmView> {
+}
+/**
+ * type: `TestView`
+ * - usually same as post's body.
+ */
+export interface TestView extends View, Omit<Partial<TestModel>, 'id' | 'required'> {
+    /**
+     * unique id of this type
+     */
+    id: string;
+    /**
+     * (optional) flag required.
+     */
+    required?: boolean;
+}
+/**
+ * Type `TestBody`
+ */
+export interface TestBody extends Body, Partial<TestView> {
+}
+/**
+ * type `BankView` (은행)
+ */
+export interface BankView extends View, Partial<BankModel> {
+}
+/**
+ * type `BankBody` (은행)
+ */
+export interface BankBody extends Body, Partial<BankView> {
+}

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@lemoncloud/ssocio-stacks-api",
+  "version": "0.23.313",
+  "description": "ssocio stacks management api",
+  "types": "dist/view/types.d.ts",
+  "scripts": {},
+  "dependencies": {
+    "lemon-model": "^1.0.2"
+  },
+  "browser": {
+    "fs": false
+  },
+  "files": [
+    "lib/**/*",
+    "dist/**/*",
+    "example/**/*"
+  ],
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Steve Jung (steve@lemoncloud.io)",
+  "license": "MIT"
+}