@lemoncloud/clipbiz-backend-api 0.25.1019

package/dist/modules/auth/oauth2/oauth2-model.d.ts

@@ -0,0 +1,350 @@
+/**
+ * `oauth2-model.ts`
+ * - common model definitions for `oauth2`
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-03-04 refactoring for activity service.
+ *
+ * Copyright (C) 2020 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { CoreModel, SimpleSet } from 'lemon-model';
+import { AccountKey, AccountStereo, SiteStereo, HostStereo, UserStereo, GroupStereo, RoleStereo, AuthStereo } from './oauth2-types';
+export { SimpleSet, AccountStereo, SiteStereo, HostStereo, UserStereo, GroupStereo, RoleStereo, AuthStereo };
+/**
+ * type: `AccountModel`
+ * - 가입(또는 인증/무인증) 처리된 회원 정보를 담음.
+ * - `AWS:cognito:identity-id` 1개당 매핑되는 정보를 여기에 저장.
+ * - 각 인증방법(소셜,디바이스,기타등등)에 따라 1개 디바이스에서 여러개의 계정(인증)이 존재 가능함.
+ */
+export interface AccountModel<T extends string = any, S extends string = any> extends CoreModel<T> {
+    /** account-id (= _id of `AccountKey`) */
+    id?: string;
+    /** stereo type (just as reference) */
+    stereo?: S;
+    /** detailed key components */
+    key$?: AccountKey;
+    /**
+     * (optional) other account-id which is aliased
+     */
+    aliasId?: string;
+    /**
+     * user-id of `user` to be linked
+     *
+     * @see UserModel
+     */
+    userId?: string;
+    /**
+     * (optional) open-id to make `access-token`
+     * - 로그인 처리(cognito인증) 할때 이용되는 ID (.identityId와 매칭됨)
+     * - 비어있는 경우, 이걸로 로그인 연동 안되어 있음
+     * - 소셜 로그인시 `open-id := social:<provider>:<social-id>`
+     */
+    openId?: string;
+    /**
+     * (optional) identity-id from context.
+     * - initialized when creation.
+     *
+     * @see NextIdentityCognito.identityId
+     */
+    identityId?: string;
+    /**
+     * (optional) identity-pool-id from context.
+     * - initialized when creation.
+     *
+     * @see NextIdentityCognito.identityPoolId
+     */
+    identityPoolId?: string;
+    /**
+     * account-id to login
+     *
+     * @see NextIdentityAccess.Account?.id
+     */
+    accountId?: string;
+    /**
+     * account-no: mobile # if stereo is 'mobile', otherwise social id
+     *
+     * @see NextIdentityAccess.Account?.socialId
+     */
+    accountNo?: string;
+    /**
+     * profile's nick-name
+     * ex) mike
+     */
+    nick?: string;
+    /**
+     * (optional) profile's real-name
+     * ex) 김실명
+     */
+    name?: string;
+    /**
+     * (optional) profile's phone
+     * ex) 01012345678
+     */
+    phone?: string;
+    /**
+     * profile's photo in url
+     * ex) //abc.com/~/a.png
+     */
+    photo?: string;
+    /**
+     * (optional) email aliases
+     */
+    email?: string;
+    /**
+     * group name as reference
+     */
+    group?: string;
+}
+/**
+ * 사이트(아파트) 모델
+ * - 외부 사이트ID (target 저장)를 기준으로 내부ID 생성됨.
+ */
+export interface SiteModel<T extends string = any, S extends string = any> extends CoreModel<T> {
+    /**
+     * site-id (auto-seq, or custom generated)
+     * - case.1 auto-sequence which is generated locally.
+     * - case.2 external linked id ([A-Z]+[0-9]+). must be started with upper-letter.
+     */
+    id?: string;
+    /** stereo type (just as reference) */
+    stereo?: S;
+    /** (internal) aliased id */
+    aliasId?: string;
+    /** (optional) alias name as reference */
+    alias?: string;
+    /** target host of domain */
+    host?: string;
+    /** (optional) base of domain */
+    base?: string;
+    /** site-name (or nickname) */
+    name?: string;
+    /**
+     * target domain (or full host-name)
+     * - use `HostModel` to route multi-hosts to single site.
+     */
+    domain?: string;
+    /** (optional) internal code as reference */
+    code?: string;
+    /** flag of linked status with remote `sites-api` */
+    linked?: number;
+    /** flag of site(or domain) is in public scope (limited to invite) */
+    isPublic?: number;
+    /**
+     * business-area type CODE(Alphabet).
+     * - ex) A
+     */
+    typeCode?: string;
+}
+/**
+ * 호스트(도메인) 모델
+ * - 호스트(도메인)으로부터 라우팅되는 타겟 사이트를 찾기 위함.
+ * - 호스트:사이트 = N:1
+ */
+export interface HostModel<T extends string = any, S extends string = any> extends CoreModel<T> {
+    /** target host (or domain) */
+    id?: string;
+    /** stereo type */
+    stereo?: S;
+    /** (linked) domain when linked */
+    domain?: string;
+    /** (linked) id of site-model */
+    siteId?: string;
+    /** flag of invalid */
+    invalid?: number;
+}
+/**
+ * 유저 모델
+ * - `identityId`별 매핑되는 유저모델 있음.
+ * - `Account`는 로그인 방식에 따라서 여러개 있으며, `User`는 실제 유저 정보.
+ */
+export interface UserModel<T extends string = any, S extends string = any> extends CoreModel<T> {
+    /**
+     * user-id (:= <auto-seq>)
+     * - use `findUser()`
+     */
+    id?: string;
+    /** stereo type (just as reference) */
+    stereo?: S;
+    /** (internal) aliased id */
+    aliasId?: string;
+    /** (optional) alias name as reference */
+    alias?: string;
+    /**
+     * main account-id which was initialized.
+     * - 기본 로그인용 계정 정보를 담음. (여러 게정으로 동일 User로 로그인할 수 있음)
+     */
+    accountId?: string;
+    /**
+     * (optional) login-id used to login
+     */
+    loginId?: string;
+    /**
+     * (optional) login-pw used to login
+     */
+    loginPw?: string;
+    /**
+     * (optiona) email of user
+     */
+    email?: string;
+    /**
+     * name of user
+     */
+    name?: string;
+    /**
+     * nick of user
+     */
+    nick?: string;
+    /** (optional) the expected role to be requested (or common role in global) */
+    role?: string;
+    /**
+     * (optional) the roles in array.
+     * (주의! 전체 사이트에 공통 적용됨)
+     */
+    roles?: string[];
+    /** (optional) main site to login */
+    siteId?: string;
+}
+/**
+ * 그룹 모델
+ * - CRUD (추가 생성) 가능한 모델임
+ */
+export interface GroupModel<T extends string = any, S extends string = any> extends CoreModel<T> {
+    /** user-id (auto-seq) */
+    id?: string;
+    /** stereo type */
+    stereo?: S;
+    /** 이 그룹이 구성된 사이트의 ID  */
+    siteId?: string;
+    /** 그룹 이름 (관리용 이름으로 변경가능함 ) */
+    name?: string;
+    /** (optional) internal code as reference */
+    code?: string;
+    /** 이 그룹에 할당된 역할 목록 (포함된 유저는 이 값을 함께 포함함) */
+    roles?: string[];
+}
+/**
+ * 역할 관리
+ * - 각 `User`와 `Site`별 설정된 권한/그룹 정보를 가짐
+ * - `*` 는 전체 사이트를 의미
+ */
+export interface RoleModel<T extends string = any, S extends string = any> extends CoreModel<T> {
+    /**
+     * role-name (must be lower-cased alphabets)
+     * or
+     * role-id := <userId>@<siteId>
+     */
+    id?: string;
+    /** stereo type (just as referece) */
+    stereo?: S;
+    /** 역할 이름 (역할 이름으로 이거로 사용가능한 권한을 검색하여 이용할 수 있음) */
+    name?: string;
+    /** site-id to link */
+    siteId?: string;
+    /** user-id to link */
+    userId?: string;
+    /** 이 유저가 포함된 그룹 ID */
+    groupId?: string;
+    /**
+     * main role definition.
+     * 주의! 타입 정의할때 model에는 string 을 추가해주고, body/view 에서 string를 빼주자!!
+     *
+     * WARN - if empty. then it will throw error of `403`.
+     */
+    role?: string;
+    /** 이 유저에게 할당된 역할 목록 */
+    roles?: string[];
+}
+/**
+ * type: `AuthModel`
+ * - 핸드폰이나 이메일등 인증 관련 정보를 가짐
+ * - TODO: ID/PW 로그인 지원시 인증 관리 방법 관리 필요!
+ *
+ */
+export interface AuthModel<T extends string = any, S extends string = any> extends CoreModel<T> {
+    /**
+     * id = <stereo>:md5(md5(<phone|email|...>), stereo)
+     */
+    id?: string;
+    /** stereo type */
+    stereo?: S;
+    /** (internal) parent-id if issued for target site */
+    parentId?: string;
+    /** (internal) delegate-id if issued by remote session */
+    delegateId?: string;
+    /**
+     * 참여자 정보. (최종 사용자ID)
+     */
+    identityId?: string;
+    /**
+     * 인증 Pool 정보. (최종 사용자ID)
+     */
+    identityPoolId?: string;
+    /**
+     * (internal) identityToken from cognito.
+     */
+    _identityToken?: string;
+    /**
+     * 인증 번호 발급여부.
+     */
+    issued?: number;
+    /** 인증 발급 시간 */
+    issuedAt?: number;
+    /**
+     * 인증 확인 여부.
+     */
+    verified?: number;
+    /** 인증 확인 시간 */
+    verifiedAt?: number;
+    /** 사용 여부 */
+    consumed?: number;
+    /** 처리 완료 시간 */
+    consumedAt?: number;
+    /** 인증 유효 기간 (약 6개월) */
+    expiredAt?: number;
+    /** (oauth2) aliased auth-id */
+    aliasId?: string;
+    /** (optional) alias name as reference */
+    alias?: string;
+    /** (oauth2) account-id when authed */
+    accountId?: string;
+    /** (oauth2) client-ip when authed */
+    clientIp?: string;
+    /** (oauth2) user-agent when authed */
+    userAgent?: string;
+    /** (oauth2) user-id when authed */
+    userId?: string;
+    /** (oauth2) site-id when authed */
+    siteId?: string;
+    /** refreshed last time */
+    refreshedAt?: number;
+    /** refreshed count number */
+    refreshedNo?: number;
+    /**
+     * WARN! updatable fields from core.
+     */
+    error?: string;
+}
+/**
+ * type: `InviteModel`
+ * - 초대시 생성됨.
+ */
+export interface InviteModel<T extends string = any, S extends string = any> extends CoreModel<T> {
+    /**
+     * id := uuid
+     */
+    id?: string;
+    /** stereo type */
+    stereo?: S;
+    /** the requested role */
+    role?: string;
+    /** user email (as account) to invite */
+    email?: string;
+    /** the initial invited time */
+    invitedAt?: number;
+    /** expires timeout (max 30min) */
+    expiredAt?: number;
+    /** checked time */
+    checkedAt?: number;
+    /** (internal) error */
+    error?: string;
+}