@carsayo/types 1.1.0 → 1.1.2

package/dist/types/modules/board/interface.d.ts

@@ -0,0 +1,233 @@
+import { BoardKey } from "../../../data";
+import { MemberType } from "../member";
+import { Board_watchableMemberType, Board_writableMemberType, Post_LikeHateState } from "./type";
+/** 글 리스트 검색 결과 */
+export interface PostList {
+    totalCount: number;
+    /** 해당 게시판 카테고리 내 중요 글(상단 고정글) */
+    importantPost: PostShortInfo[];
+    /** 검색 결과(고정글 제외) */
+    searchedPost: PostShortInfo[];
+}
+/** 글 상세정보 */
+export interface PostShortInfo {
+    /**
+     * 글 Id
+     * @description Autoincrement Integer
+     */
+    id: number;
+    /** 글 카테고리 */
+    board_category: Board_Category;
+    title: string;
+    content: string;
+    /** 작성 회원 정보, 비회원 글이 아닐 경우 정의됩니다 */
+    member: {
+        id: string;
+        name_nick: string;
+        type: MemberType;
+    } | null;
+    /** 비회원 작성 글일 경우 정의됩니다 */
+    guest: {
+        name: string;
+    } | null;
+    /**
+     * 공개글인지 여부
+     * 비공개글일 경우 본인과 관리자만 읽을 수 있습니다.
+     */
+    isPublic: boolean;
+    /**
+     * 중요한 글인지 여부
+     * 게시판에서 important한 글은 상단에 고정되어야 합니다!!
+     */
+    isImportant: boolean;
+    /** 밴된 글인지 여부. 관리자가 밴먹인 글인지 여부입니다. */
+    isBanned: boolean;
+    /**
+     * 조회수
+     */
+    count_read: number;
+    /**
+     * 좋아요 개수
+     */
+    count_like: number;
+    /**
+     * 싫어요 개수
+     */
+    count_hate: number;
+    /**
+     * 댓글 개수
+     */
+    count_comment: number;
+    created_at: Date;
+    updated_at: Date;
+}
+/** 글 상세정보 */
+export interface PostDetailInfo {
+    /**
+     * 글 Id
+     * @description Autoincrement Integer
+     */
+    id: number;
+    /** 게시판 정보 */
+    board: {
+        id: number;
+        name: string;
+        key: BoardKey;
+        description: string;
+        /** 게시판을 볼 수 있는 회원 타입 */
+        watchableMemberType: Board_watchableMemberType;
+        /** 게시판에 글을 쓸 수 있는 회원 타입 */
+        writableMemberType: Board_writableMemberType;
+    };
+    /** 글 카테고리 */
+    board_category: Board_Category;
+    title: string;
+    content: string;
+    content_html: string;
+    /** 댓글 리스트 */
+    comment: PostComment[];
+    /** 작성 회원 정보, 비회원 글이 아닐 경우 정의됩니다 */
+    member: {
+        id: string;
+        name_nick: string;
+        type: MemberType;
+    } | null;
+    /** 비회원 작성 글일 경우 정의됩니다 */
+    guest: {
+        name: string;
+    } | null;
+    /**
+     * 공개글인지 여부
+     * 비공개글일 경우 본인과 관리자만 읽을 수 있습니다.
+     */
+    isPublic: boolean;
+    /**
+     * 중요한 글인지 여부
+     * 게시판에서 important한 글은 상단에 고정되어야 합니다!!
+     */
+    isImportant: boolean;
+    /** 밴된 글인지 여부. 관리자가 밴먹인 글인지 여부입니다. */
+    isBanned: boolean;
+    /** 요청자가 이 글을 좋아요/싫어요했는지 여부
+     * @normal 비회원이거나, 좋아요/싫어요 상태가 아닌 것을 의미합니다
+     */
+    likeStatus: Post_LikeHateState;
+    /**
+     * 조회수
+     */
+    count_read: number;
+    /**
+     * 좋아요 개수
+     */
+    count_like: number;
+    /**
+     * 싫어요 개수
+     */
+    count_hate: number;
+    /**
+     * 댓글 개수
+     */
+    count_comment: number;
+    created_at: Date;
+    updated_at: Date;
+}
+/** 댓글 상세정보 */
+export interface PostComment {
+    /**
+     * 댓글 Id
+     * @description Autoincrement Integer
+     */
+    id: number;
+    /** 어느 글의 댓글인지 */
+    board_postId: number;
+    /** 작성 회원 정보, 비회원 댓글이 아닐 경우 정의됩니다 */
+    member: {
+        id: string;
+        name_nick: string;
+        type: MemberType;
+    } | null;
+    /** 비회원 작성 댓글일 경우 정의됩니다 */
+    guest: {
+        name: string;
+    } | null;
+    content: string;
+    isBanned: boolean;
+    /** 대댓글 리스트 */
+    post_comment_reply: PostCommentReply[];
+    created_at: Date;
+    updated_at: Date;
+    /** 댓글 삭제 여부 판단은 이걸루 하세용 */
+    deleted_at: Date | null;
+}
+export interface PostCommentReply {
+    id: number;
+    /** 어느 댓글의 댓글인지 */
+    board_post_commentId: number;
+    /** 작성 회원 정보, 비회원 대댓글이 아닐 경우 정의됩니다 */
+    member: {
+        id: string;
+        name_nick: string;
+        type: MemberType;
+    } | null;
+    /** 비회원 작성 대댓글일 경우 정의됩니다 */
+    guest: {
+        name: string;
+    } | null;
+    content: string;
+    isBanned: boolean;
+    created_at: Date;
+    updated_at: Date;
+    /** 대댓글 삭제 여부 판단은 이걸루 하세용 */
+    deleted_at: Date | null;
+}
+/** 게시판 정보 */
+export interface BoardInfo {
+    /**
+     * 게시판 ID
+     */
+    id: number;
+    /**
+     * 게시판 키값. 중요합니다.
+     */
+    key: BoardKey;
+    /**
+     * 게시판 이름
+     */
+    name: string;
+    /**
+     * 게시판 설명
+     */
+    description: string;
+    /**
+     * 게시판을 볼 수 있는 회원 타입
+     */
+    watchableMemberType: Board_watchableMemberType;
+    /**
+     * 게시판에 글을 작성할  수 있는 회원 타입
+     */
+    writableMemberType: Board_writableMemberType;
+    /**
+     * 댓글 작성 가능 게시판 여부
+     */
+    commentAble: boolean;
+    /**
+     * 신고 기능 가능 여부
+     */
+    reportAble: boolean;
+    /**
+     * 싫어요 가능 여부
+     */
+    hateAble: boolean;
+    /**
+     * 좋아요 가능 여부
+     */
+    likeAble: boolean;
+    board_category_list: Board_Category[];
+}
+/** 게시판 카테고리 */
+export interface Board_Category {
+    id: number;
+    name: string;
+    /** 해당 게시판을 볼 수 있는 회원 타입 */
+    watchableMemberType: Board_watchableMemberType;
+}

package/dist/types/modules/board/type.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @case like: 좋아요
+ * @case normal: 기본 (좋아요도 싫어요도 아님)
+ * @case hate: 싫어요
+ */
+export type Post_LikeHateState = "like" | "hate" | "normal";
+export declare const Post_LikeHateState: {
+    like: string;
+    hate: string;
+    normal: string;
+};
+/**
+ * @description 해당 컨텐츠를 볼 수 있는 회원 타입
+ * @notice 어드민은 모든 컨텐츠를 볼 수 있습니다
+ * @case common: 모든 회원 타입에 대하여 허용된 컨텐츠
+ * @case customer: 일반 회원에 대하여 허용된 컨텐츠
+ * @case dealer: 딜러에게만 허용된 컨텐츠
+ * @case admin: 어드민에 대하여만 허용된 컨텐츠
+ */
+export type Board_watchableMemberType = "null" | "common" | "customer" | "dealer" | "admin";
+/**
+ * @description 글을 작성할 수 있는 회원 유형
+ * @notice 어드민은 모든 컨텐츠 작성이 가능합니다
+ * @case common: 모든 회원 타입에 대하여 작성이 허용된 컨텐츠
+ * @case customer: 일반 회원에 대하여만 작성이 허용된 컨텐츠
+ * @case dealer: 딜러에게 대하여만 작성이 허용된 컨텐츠
+ * @case admin: 어드민에 대하여만 작성이 허용된 컨텐츠
+ */
+export type Board_writableMemberType = "null" | "common" | "customer" | "dealer" | "admin";

package/dist/types/modules/car/dto.d.ts

@@ -0,0 +1,72 @@
+/** DTO는 서버단에 요청을 보낼 때 사용하는 클래스 유형으로 서버단에서 이 곳에 정의된 대로 유효성 검사를 처리합니다. */
+import { CarMakerId, PopularCarCategoryId } from "../../../data";
+export declare class GetCarModelDTO {
+    carMakerId: CarMakerId;
+    /**
+     * 가격 정보가 없는 모델도 같이 검색하는 옵션
+     * @notice 기본값은 false입니다
+     * @description 슈퍼카에서만 사용합니다
+     */
+    withoutPriceModel?: boolean;
+}
+export declare class GetCarTrimDTO {
+    carModelId: number;
+}
+export declare class GetCarGradeDTO {
+    carTrimId: number;
+}
+export declare class GetCarColorDTO {
+    carGradeId: number;
+}
+export declare class GetCarOptionDTO {
+    carGradeId: number;
+}
+/** 차량 좋아요 정보 업데이트 */
+export declare class UpdateInterestCarDTO {
+    carModelId: number;
+    isInterest: boolean;
+}
+/** 인기차량 설정 */
+export declare class SetCarPopularDTO {
+    name: string;
+    description: string;
+    carModelId: number;
+    popularCategoryId: PopularCarCategoryId;
+    /** 인기차량 정렬을 위한 가중치
+     * @notice 높은 값이 먼저 정렬되어 나옵니다
+     */
+    orderWeight?: number;
+}
+/** 인기차량 제거 */
+export declare class DeleteCarPopularDTO {
+    id: number;
+}
+export declare class SearchCarDTO {
+    skip?: number;
+    take: number;
+    keyword: string;
+}
+export declare class CreateCarSearchKeywordDTO {
+    keyword: string;
+}
+export declare class DeleteCarSearchKeywordDTO {
+    id: number;
+}
+export declare class GetCarDTO {
+    carId: string;
+}
+export declare class CarDataDTO {
+    id: string;
+    isPublic: boolean;
+    isForeign: boolean | null;
+    car_makerId: number | null;
+    car_modelId: number | null;
+    car_trimId: number | null;
+    car_gradeId: number | null;
+    car_colorId: number | null;
+    car_LINK_option: CarOptionDTO[] | null;
+    isDefaultOption: boolean | null;
+}
+export declare class CarOptionDTO {
+    car_optionId: number;
+}

package/dist/types/modules/car/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./dto";
+export * from "./interface";
+export * from "./type";

package/dist/types/modules/car/interface.d.ts

@@ -0,0 +1,249 @@
+import { CarMakerId, CarCategoryId, PopularCarCategoryId } from "../../../data";
+import { CarMakerType } from "./type";
+/**
+ *  @description 차량 제조사
+ */
+export interface CarMaker {
+    id: CarMakerId;
+    name: string;
+    name_en: string;
+    country: string;
+    image_url: string;
+    type: CarMakerType;
+}
+/**
+ * @description 차량 모델
+ */
+export interface CarModel {
+    id: number;
+    name: string;
+    name_brand: string;
+    name_short: string;
+    name_generation: string;
+    released_day: string;
+    image_url: string;
+    car_category: CarCategory | null;
+    /** 가격 정보가 없을 경우 min, max 둘 다 0이 찍혀 나옵니다 */
+    price: {
+        max: number;
+        min: number;
+    };
+}
+/**
+ * @description 차량 카테고리
+ */
+export interface CarCategory {
+    id: CarCategoryId;
+    name: string;
+    option: CarCategoryOption;
+}
+/**
+ * @description 차량 카테고리 옵션정보
+ */
+export interface CarCategoryOption {
+    /**
+     * 장기렌트를 통한 주문 가능 카테고리 여부
+     */
+    allow_rent: boolean;
+    /**
+     * 리스 주문 가능 카테고리 여부
+     */
+    allow_lease: boolean;
+    /**
+     * 신차 주문 가능 카테고리 여부
+     */
+    allow_new: boolean;
+}
+/**
+ * @description 차량 모델 리스트를 카테고리별로 정렬
+ */
+export interface CarModelOrderByCategory {
+    [key: number]: {
+        categoryName: string;
+        categoryOption: CarCategoryOption;
+        carModelList: {
+            id: number;
+            name: string;
+            name_brand: string;
+            name_short: string;
+            name_generation: string;
+            released_day: string;
+        }[];
+    };
+}
+/**
+ * @description 차량 상세모델
+ */
+export interface CarTrim {
+    id: number;
+    name: string;
+    image_url: string;
+    car_purpose: {
+        id: number;
+        name: string;
+    } | null;
+    car_shape: {
+        id: number;
+        name: string;
+    } | null;
+}
+/** 차량 상세모델 (트림 내 등급 포함) */
+export interface CarTrimIncludeGrade extends CarTrim {
+    grade: CarGrade[];
+}
+/**
+ * @description 차량 등급
+ */
+export interface CarGrade {
+    id: number;
+    name: string;
+    price: number;
+    updated_day: string;
+    released_month: string;
+    /** 연식
+     * @notice 23년 7월 모델: 24
+     */
+    modelYear: number;
+}
+/**
+ * @description 차량 색상
+ */
+export interface CarColor {
+    id: number;
+    name: string;
+    name_short: string;
+    price: number;
+    image_url: string;
+}
+/**
+ * @description 차량 옵션
+ */
+export interface CarOption {
+    id: number;
+    name: string;
+    price: number;
+    position: number;
+    updated_day: string;
+}
+export interface InterestCarInfo extends CarModel {
+    created_at: Date;
+    carMaker: CarMaker;
+    isInterest: boolean;
+}
+export interface PopularCarCategory {
+    id: PopularCarCategoryId;
+    name: string;
+    description: string;
+    carList: PopularCar[];
+}
+export interface PopularCar {
+    id: number;
+    name: string;
+    description: string;
+    /** 관심차량 여부 */
+    isInterest: boolean;
+    model: CarModel;
+    maker: CarMaker;
+}
+/**
+ * @description 차량 검색시 나타나는 차량 정보 양식
+ */
+export interface SearchedCarModel {
+    id: number;
+    name: string;
+    name_brand: string;
+    name_short: string;
+    name_generation: string;
+    released_day: string;
+    image_url: string;
+    car_category: CarCategory | null;
+    car_maker: CarMaker | null;
+}
+export interface CarSearchKeyword {
+    id: number;
+    /** 검색 키워드 */
+    keyword: string;
+    /** 정렬을 위한 값입니다 */
+    orderWeight: number;
+}
+export interface CarDetailInfo {
+    id: string;
+    created_at: Date;
+    updated_at: Date;
+    car_color: {
+        id: number;
+        name: string;
+        name_short: string;
+        image_url: string;
+        price: number;
+    } | null;
+    car_grade: {
+        id: number;
+        name: string;
+        price: number;
+        updated_day: string;
+        released_month: string;
+    } | null;
+    car_maker: {
+        id: number;
+        name: string;
+        country: string;
+    } | null;
+    car_model: {
+        id: number;
+        name: string;
+        name_brand: string;
+        name_short: string;
+        name_generation: string;
+        released_day: string;
+        car_category: {
+            id: number;
+            name: string;
+        } | null;
+    } | null;
+    car_trim: {
+        id: number;
+        name: string;
+        image_url: string;
+    } | null;
+    car_option: {
+        id: number;
+        name: string;
+        price: number;
+    }[];
+}
+export interface CarShortInfo {
+    id: string;
+    car_grade: {
+        id: number;
+        name: string;
+        price: number;
+    } | null;
+    car_model: {
+        id: number;
+        name: string;
+        name_brand: string;
+        name_short: string;
+        name_generation: string;
+        car_category: {
+            id: number;
+            name: string;
+        } | null;
+    } | null;
+    car_trim: {
+        id: number;
+        name: string;
+        image_url: string;
+    } | null;
+    car_color: {
+        id: number;
+        name: string;
+        name_short: string;
+        image_url: string;
+    } | null;
+    car_maker: {
+        id: number;
+        name: string;
+        country: string;
+    } | null;
+}

package/dist/types/modules/car/type.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @domestic 국산차
+ * @imported 수입차
+ * @etc 기타
+ */
+export declare const CarMakerType: {
+    domestic: string;
+    imported: string;
+    etc: string;
+};
+export type CarMakerType = keyof typeof CarMakerType;

package/dist/types/modules/collaborator/dto.d.ts

@@ -0,0 +1,10 @@
+/** DTO는 서버단에 요청을 보낼 때 사용하는 클래스 유형으로 서버단에서 이 곳에 정의된 대로 유효성 검사를 처리합니다. */
+import { CollaboratorId } from "../../../data";
+import { OrderIdDTO } from "../order";
+/** 협력사 관리자 - 주문 상세정보 확인 */
+export declare class GetCollaboratorOrderDetailDTO extends OrderIdDTO {
+    /**
+     * @description 해당 소속사 카매니저가 입찰한 주문 리스트 검색
+     */
+    collaboratorId: CollaboratorId;
+}

package/dist/types/modules/collaborator/index.d.ts

@@ -0,0 +1 @@
+export * from "./dto";

package/dist/types/modules/common/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./interface";
+export * from "./type";

package/dist/types/modules/common/interface.d.ts

@@ -0,0 +1,23 @@
+import { SidoId, SigunguId } from "../../../data";
+/**
+ * @description 시도 정보
+ */
+export interface Sido {
+    id: SidoId;
+    name: string;
+    name_short: string;
+}
+export interface Sigungu {
+    id: SigunguId;
+    sido: Sido;
+    name: string | null;
+}
+/**
+ * @description 지역 정보
+ */
+export interface Region {
+    sidoId: SidoId;
+    sido: string;
+    sigunguId: SigunguId;
+    sigungu: string | null;
+}

package/dist/types/modules/common/type.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @description 배너가 노출되는 대상
+ * @case common: 모든 회원 타입에 대하여 노출되는 배너
+ * @case customer: 일반 회원에 대하여 노출되는 배너
+ * @case dealer: 딜러에게 노출되는 배너
+ * @case admin: 어드민에 대하여 노출되는 배너
+ */
+export declare const ContentTarget: {
+    readonly common: "common";
+    readonly customer: "customer";
+    readonly dealer: "dealer";
+    readonly admin: "admin";
+};
+export type ContentTarget = keyof typeof ContentTarget;
+export declare const DeviceType: {
+    readonly IOS: "IOS";
+    readonly Android: "Android";
+    readonly Web: "Web";
+};
+export type DeviceType = keyof typeof DeviceType;
+export declare const OrderMethod: {
+    readonly desc: "desc";
+    readonly asc: "asc";
+};
+export type OrderMethod = keyof typeof OrderMethod;

package/dist/types/modules/file/dto.d.ts

@@ -0,0 +1,17 @@
+export declare class FileIdDTO {
+    fileId: string;
+}
+export declare class GetFileUploadUrlDTO {
+    fileName: string;
+    /** @example png */
+    extension: string;
+    /**
+     * @public 공개파일
+     * @private 비공개 파일, 소유자와 어드민만 확인 가능
+     */
+    isPublic: "true" | "false";
+    /** 적절한 파일 유형을 영문으로 입력해 주세용
+     * @notice "profileImage"일 경우에는 서버단에서 추가적인 이미지 처리를 합니다. 프로필 이미지 업로드에는 무조건 해 주세용
+     */
+    fileType: string | "profileImage";
+}

package/dist/types/modules/file/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./dto";
+export * from "./interface";
+export * from "./type";