@lemoncloud/clipbiz-backend-api 0.25.1019

package/dist/modules/auth/types.d.ts

@@ -0,0 +1,318 @@
+/**
+ * `auth/types.ts`
+ * - 기본 types used in `backed-proxy`
+ *
+ * **[중요! exports 순서]**
+ * 1. define data type in `types.ts` w/ internal types.
+ * 2. define Model in `model.ts`
+ * 3. define View/Body in `view.ts`, and external types.
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ *
+ * @copyright   (C) lemoncloud.io 2023 - All Rights Reserved.
+ * @origin      `@lemoncloud/codes-backend-api/modules/auth`
+ */
+import { OAuthAPITokenResult } from './oauth2/oauth2-types';
+import { AuthModel, RoleModel, SiteModel, UserModel } from './model';
+/**
+ * Lookup Table
+ *
+ * WARN! DO NOT EXPORT AS `$LUT`. use default export instead.
+ */
+declare const $LUT: {
+    /**
+     * Possible type of model.
+     */
+    ModelType: {
+        /** host model */
+        host: string;
+        /** site model */
+        site: string;
+        /** account model */
+        account: string;
+        /** user model */
+        user: string;
+        /** group model */
+        group: string;
+        /** role model */
+        role: string;
+        /** auth model */
+        auth: string;
+        /** invite model */
+        invite: string;
+    };
+    /**
+     * HostStereo.
+     */
+    HostStereo: {
+        '': string;
+        '#alias': string;
+    };
+    /**
+     * SiteStereo.
+     */
+    SiteStereo: {
+        /** created per user automatically */
+        mine: string;
+        /** created for `workspace` manually */
+        work: string;
+        '': string;
+        '#alias': string;
+        domain: string;
+        session: string;
+    };
+    /**
+     * AccountStereo.
+     */
+    AccountStereo: {
+        business: string;
+        code: string;
+        '': string;
+        '#alias': string;
+        iid: string;
+        login: string;
+        phone: string; /**
+         * SiteStereo.
+         */
+        email: string;
+        social: string;
+        session: string;
+    };
+    /**
+     * UserStereo.
+     */
+    UserStereo: {
+        '': string;
+        /** (internal) alias by code */
+        '#code': string;
+        /** admin user */
+        admin: string;
+        /** normal user */
+        user: string;
+        /** dummy user */
+        dummy: string;
+        '#alias': string;
+        session: string;
+    };
+    /**
+     * UserRole
+     */
+    UserRole: {
+        '': string;
+        /** self user */
+        self: string;
+        /** Guest user */
+        guest: string;
+        /** normal user */
+        user: string;
+        /** owner */
+        owner: string;
+        /** member */
+        member: string;
+        /** session: authed by session remotely */
+        session: string;
+        /** admin user (normal) */
+        admin: string;
+    };
+    /**
+     * GroupStereo.
+     */
+    GroupStereo: {
+        '': string;
+        '#alias': string;
+    };
+    /**
+     * RoleStereo.
+     */
+    RoleStereo: {
+        /** owner */
+        owner: string;
+        /** member */
+        member: string;
+        '': string;
+        '#alias': string;
+    };
+    /**
+     * AuthStereo.
+     */
+    AuthStereo: {
+        '#': string;
+        '': string;
+        '#alias': string; /** member */
+        session: string; /** admin user (normal) */
+        phone: string;
+        email: string;
+    };
+    /**
+     * InviteStereo
+     */
+    InviteStereo: {
+        /** empty */
+        '': string;
+        /** (internal) alias type */
+        '#alias': string;
+    };
+    /**
+     * GenderType
+     */
+    GenderType: {
+        '': string;
+        male: string;
+        female: string;
+    };
+};
+/**
+ * type: `HostStereo`
+ */
+export declare type HostStereo = keyof typeof $LUT.HostStereo;
+/**
+ * type: `SiteStereo`
+ */
+export declare type SiteStereo = keyof typeof $LUT.SiteStereo;
+/**
+ * type: `AccountStereo`
+ */
+export declare type AccountStereo = keyof typeof $LUT.AccountStereo;
+/**
+ * type: `UserStereo`
+ */
+export declare type UserStereo = keyof typeof $LUT.UserStereo;
+/**
+ * type: `UserRole`
+ */
+export declare type UserRole = keyof typeof $LUT.UserRole;
+/**
+ * type: `GroupStereo`
+ */
+export declare type GroupStereo = keyof typeof $LUT.GroupStereo;
+/**
+ * type: `RoleStereo`
+ */
+export declare type RoleStereo = keyof typeof $LUT.RoleStereo;
+/**
+ * type: `AuthStereo`
+ */
+export declare type AuthStereo = keyof typeof $LUT.AuthStereo;
+/**
+ * type: `InviteStereo`
+ */
+export declare type InviteStereo = keyof typeof $LUT.InviteStereo;
+/**
+ * type: `GenderType`
+ */
+export declare type GenderType = keyof typeof $LUT.GenderType;
+/**
+ * general form of agreement.
+ */
+export interface Agreement {
+    /** 서비스 이용 약관 */
+    service?: number;
+    /** 개인정보 처리방침 */
+    privacy?: number;
+    /** 개인정보 제3자 제공 동의 */
+    privacy3rd?: number;
+    /**
+     * save timestamp of agreed
+     */
+    [key: string]: number;
+}
+/**
+ * extended alias infor
+ */
+export interface Alias {
+    /**
+     * type of alias
+     */
+    type?: string;
+    /**
+     * alias value
+     * - can be different by `type`
+     */
+    alias?: string;
+}
+/**
+ * common jwt properties
+ */
+export interface JwtCommon {
+    /**
+     * expired at (sec)
+     */
+    exp?: number;
+    /**
+     * issued at (sec)
+     * = Math.floor(current_ms / 1000)
+     */
+    iat?: number;
+    /**
+     * issuer name.
+     */
+    iss?: string;
+}
+/**
+ * 주소입력 지원
+ */
+export interface UseAddressBasic {
+    /** 주소(우편번호) */
+    addrPost?: string;
+    /** 주소(거리=우편번호매칭) */
+    addrStreet?: string;
+    /** 주소(상세) */
+    addrDetail?: string;
+    /** 주소(추가) */
+    addrExtra?: string;
+}
+/**
+ * type: `UserTokenModel`
+ * - user model with final Token and information.
+ * - 내부 로직에서 쓰이는 모델로, 사용자에게는 `UserTokenView`로 전달됨
+ *
+ * @see UserTransformer.asUserTokenView()
+ */
+export interface UserTokenModel extends UserModel {
+    /**
+     * token result.
+     */
+    readonly $token: OAuthAPITokenResult<undefined, undefined>;
+    /** (optional) site linked */
+    readonly $site?: SiteModel;
+    /** (optional) auth linked */
+    readonly $auth?: AuthModel;
+    /** (optional) role linked */
+    readonly $role?: RoleModel;
+}
+/**
+ * contain id + text
+ */
+export interface TextPair {
+    /** id of text (see text-model) */
+    id: string;
+    /** text in string */
+    text: string;
+}
+/**
+ * type: `UserAliasUpdateBody`
+ * - 로그인 계정 수정을 위한 Request Body
+ */
+export interface UserAliasUpdateBody {
+    /** type of alias */
+    type: AccountStereo;
+    /** alias before the change */
+    alias1: string;
+    /** alias after change */
+    alias2: string;
+}
+/**
+ * params of `/invite`
+ * - 사용자 초대하기 (email or userId)
+ */
+export interface UserInviteParams {
+    /** email address */
+    email?: string;
+    /** or user-id to invite */
+    userId?: string;
+    /** role to assign */
+    role?: 'guest' | 'member';
+}
+/** must export $LUT as default */
+export default $LUT;

package/dist/modules/auth/views.d.ts

@@ -0,0 +1,266 @@
+/**
+ * `auth/views.ts`
+ * - types used in `backed-proxy`
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ *
+ * @copyright   (C) lemoncloud.io 2023 - All Rights Reserved.
+ * @origin      `@lemoncloud/codes-backend-api/modules/auth`
+ */
+import { View, Body } from 'lemon-model';
+import { AccountModel, AuthModel, GroupModel, HostModel, InviteModel, RoleModel, SiteModel, UserModel } from './model';
+import { OAuthAPITokenResult, OAuthLoginUserBody, OAuthLoginUserParam } from './oauth2/oauth2-types';
+import { IdentityToken } from '../../cores/types';
+import $LUT, { Agreement } from './types';
+export * from './types';
+export default $LUT;
+/**
+ * type: `SiteView`
+ * - usually same as post's body.
+ */
+export interface SiteView extends View, Omit<Partial<SiteModel>, 'id' | 'legacy' | 'isPublic' | 'owner$'> {
+    /**
+     * unique id of this type
+     */
+    id: string;
+    /** flag of legacy site */
+    legacy?: boolean;
+    /** flag if domain is in public */
+    isPublic?: boolean;
+    /** (optional) owner info */
+    readonly owner$?: UserView;
+}
+/**
+ * Type `SiteBody`
+ */
+export interface SiteBody extends Body, Partial<SiteView> {
+}
+/** type: `AccountView` */
+export interface AccountView extends View, Omit<Partial<AccountModel>, 'id' | 'isPushNotice' | 'isPushCommunity' | 'isPushMarketing'> {
+    id?: string;
+    isPushNotice?: boolean;
+    isPushCommunity?: boolean;
+    isPushMarketing?: boolean;
+}
+/**
+ * Type `AccountBody`
+ */
+export interface AccountBody extends Body, Partial<AccountView> {
+}
+/**
+ * type: `UserView`
+ * - usually same as post's body.
+ */
+export interface UserView extends View, Omit<Partial<UserModel>, 'id' | '$account'> {
+    /**
+     * unique id of this type
+     */
+    id: string;
+    /** (optional) account linked */
+    readonly $account?: AccountView;
+}
+/**
+ * Type `UserBody`
+ */
+export interface UserBody extends Body, Partial<UserView> {
+}
+/** type: `HostView` */
+export interface HostView extends View, Omit<Partial<HostModel>, 'id'> {
+    /**
+     * unique id of this type
+     */
+    id: string;
+}
+/** Type `HostBody` */
+export interface HostBody extends Body, Partial<HostView> {
+}
+/** type: `GroupView` */
+export interface GroupView extends View, Omit<Partial<GroupModel>, 'id'> {
+    /**
+     * auto-seq id of this model.
+     */
+    id: string;
+}
+/** Type `GroupBody` */
+export interface GroupBody extends Body, Partial<GroupView> {
+}
+/** type: `RoleView` */
+export interface RoleView extends View, Omit<Partial<RoleModel>, 'id' | '$user'> {
+    /**
+     * auto-seq id of this model.
+     */
+    id: string;
+    /** (optional) linked user */
+    readonly $user?: UserView;
+}
+/** Type `RoleBody` */
+export interface RoleBody extends Body, Partial<RoleView> {
+}
+/** type: `AuthView` */
+export interface AuthView extends View, Omit<Partial<AuthModel>, 'id'> {
+    /**
+     * auto-seq id of this model.
+     */
+    id: string;
+}
+/** Type `AuthBody` */
+export interface AuthBody extends Body, Partial<AuthView> {
+}
+/** type: `InviteView` */
+export interface InviteView extends View, Omit<Partial<InviteModel>, 'id'> {
+    /**
+     * auto-seq id of this model.
+     */
+    id: string;
+}
+/** Type `InviteBody` */
+export interface InviteBody extends Body, Partial<InviteView> {
+}
+/**
+ * param of `/login-user`.
+ */
+export interface LoginUserParam extends OAuthLoginUserParam {
+    /**
+     * flag to issue token (default 1)
+     */
+    token: any;
+}
+/**
+ * body of `/login-user`.
+ */
+export interface LoginUserBody extends OAuthLoginUserBody {
+    /**
+     * user-id to login
+     */
+    uid: string;
+}
+export interface RegisterEmailUserBody extends Body {
+    /**
+     * email address
+     */
+    email: string;
+    /**
+     * (optional) check if email is verified
+     */
+    emailVerified?: boolean;
+    /**
+     * name
+     */
+    name: string;
+    /**
+     * access password-1
+     */
+    password1: string;
+    /**
+     * access password-2
+     */
+    password2: string;
+    /** agreeds */
+    agree$: Agreement;
+    /** (optional) 추천인 ID */
+    referrerId?: string;
+    /**
+     * phone verified.
+     * - 연결할 전화번호 (나중에 이걸로 로그인 가능함)
+     */
+    phone?: string;
+}
+/**
+ * detailed user-info
+ */
+export interface UserInfo$ {
+    /**
+     * the final identity-id in linked.
+     *
+     * @see AccountModel.delegatedId
+     */
+    iid: string;
+    /**
+     * the current account-model along with `context.identity`
+     *
+     * @see AccountView
+     */
+    $account: AccountView;
+}
+/**
+ * user-profile
+ */
+export interface UserProfile$<T = any> {
+    /** site-id */
+    sid: string;
+    /** group-id */
+    gid: string;
+    /** user-id */
+    uid: string;
+    /** roles */
+    roles: string[];
+    /** the current(or delegated) identity-id */
+    identityId: string;
+    /** site in detail */
+    $site: SiteView;
+    /** user in detail */
+    $user: UserView;
+    /** user in detail */
+    $role: RoleView;
+    /** auth in detail */
+    $auth: AuthView;
+    /** (optional) the detailed user-info */
+    $info?: UserInfo$;
+    /** (optional) the detailed user-info */
+    $token?: T;
+}
+/**
+ * type: `UserTokenView`
+ * - result view of user with token
+ */
+export interface UserTokenView extends UserView {
+    /**
+     * token result.
+     */
+    readonly Token: OAuthAPITokenResult<SiteView, UserView>;
+    /** (optional) site linked */
+    readonly $site?: SiteView;
+    /** (optional) auth linked */
+    readonly $auth?: AuthView;
+    /** (optional) role linked */
+    readonly $role?: RoleView;
+}
+/**
+ * type: `UserDuplicateCheckResult`
+ * - result view of exist user with alias
+ */
+export interface UserDuplicateCheckResult {
+    /** 로그인 ID (input) */
+    loginId: string;
+    /** 유저등록여부 */
+    hasUser: boolean;
+    /** (optinal) 업체 ID */
+    siteId?: string;
+}
+/**
+ * type: `MyUserSiteLink`
+ * - 회사 가입 요청 정보를 담음
+ */
+export interface MyUserSiteLinkElement$ {
+    /** 승인 요청 시각 */
+    requestedAt?: number;
+    /** 가입 승인 시각 */
+    allowedAt?: number;
+    /** 가입 거절 시각 */
+    rejectedAt?: number;
+    /** 탈퇴 시각 */
+    leavedAt?: number;
+}
+/**
+ * type: `UserDelegateBody`
+ * - body of `/users/0/delegate`
+ */
+export interface UserDelegateBody<T = any> {
+    /**
+     * session(identity-token) to delegate
+     *
+     * - (default) use `x-lemon-identity` if not defined.
+     */
+    $token?: IdentityToken<T>;
+}

package/dist/modules/mock/model.d.ts

@@ -0,0 +1,100 @@
+/**
+ * `model.ts`
+ * - model definitions per account data
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ *
+ * Copyright (C) 2020 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { CoreModel, NextIdentityAccess, SimpleSet } from 'lemon-model';
+import $LUT from './types';
+/**
+ * type: `ModelType`
+ */
+export declare type ModelType = keyof typeof $LUT.ModelType;
+/**
+ * type: `Model`: common model
+ */
+export declare type Model = CoreModel<ModelType>;
+/**
+ * type: `MockHead`
+ * - common head of mock-model.
+ */
+export interface MockHead {
+    /** id of mock */
+    id?: string;
+    /** name of mock */
+    name?: string;
+}
+/**
+ * `mock`: internal mock model.
+ * - provice mocks data
+ */
+export interface MockModel<T = string> extends MockHead, Model {
+    /** name of this model */
+    name?: string;
+    /** alias-id when stereo='#alias' */
+    aliasId?: string;
+    /** json encoding all data */
+    meta?: T;
+}
+export interface MockModelExt<T = string> extends MockModel<T> {
+    /** extended data with any type */
+    [key: string]: any;
+}
+/**
+ * type: `TestHead`
+ * - common head of test-model.
+ */
+export interface TestHead {
+    /** internal reference */
+    _idx?: number;
+    /** internal date(YYYY-MM-DD) */
+    _date?: string;
+}
+/**
+ * `test`: internal test model.
+ */
+export interface TestModel extends Model, TestHead {
+    /** name of model */
+    name?: string;
+    /** test count */
+    count?: number;
+    /** (optional) extra */
+    extra?: SimpleSet;
+    /**
+     * inner Object.
+     */
+    readonly Model?: Model;
+    /**
+     * (view) Access Infor.
+     */
+    readonly $identity?: NextIdentityAccess;
+}
+/**
+ * extract field names from models
+ * - only fields start with lowercase, or all upper.
+ */
+export declare const filterFields: (fields: string[], base?: string[]) => string[];
+/** field names from head */
+export declare const $HEAD: {
+    mock: string[];
+    test: string[];
+};
+export declare const $FIELD: {
+    mock: string[];
+    test: string[];
+};
+/** must export default as below */
+declare const _default: {
+    $HEAD: {
+        mock: string[];
+        test: string[];
+    };
+    $FIELD: {
+        mock: string[];
+        test: string[];
+    };
+};
+export default _default;

package/dist/modules/mock/types.d.ts

@@ -0,0 +1,42 @@
+/**
+ * `types.ts`
+ * - 기본 types used in `backend-proxy`
+ *
+ * **[중요! exports 순서]**
+ * 1. define data type in `types.ts` w/ internal types.
+ * 2. define Model in `model.ts`
+ * 3. define View/Body in `view.ts`, and external types.
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ *
+ * Copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+/**
+ * Lookup Table
+ *
+ * WARN! DO NOT EXPORT AS `$LUT`. use default export instead.
+ */
+declare const $LUT: {
+    /**
+     * Possible type of model.
+     */
+    ModelType: {
+        /** mock model */
+        mock: string;
+        /** test model */
+        test: string;
+    };
+    /** type: MockStereo */
+    MockStereo: {
+        '': string;
+        '#': string;
+        '#alias': string;
+    };
+};
+/**
+ * type: `MockStereo`
+ */
+export declare type MockStereo = keyof typeof $LUT.MockStereo;
+/** must export $LUT as default */
+export default $LUT;