@lemoncloud/clipbiz-backend-api 0.25.1019

package/README.md

@@ -0,0 +1,4 @@
+# @lemoncloud/clipbiz-backend-api
+
+- 관리용 서비스 API
+

package/dist/cores/types.d.ts

@@ -0,0 +1,217 @@
+/**
+ * `types.ts`
+ * - common types used in `/cores`
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-06-21 optimized w/ `abstract-services`
+ * @date        2022-06-28 added `Codable` interface for general types.
+ * @date        2023-01-18 optimized with `lemon-core@3.2.4`
+ * @date        2023-02-15 optimized with `lemon-core@3.2.5`
+ * @date        2024-11-14 optimized `IdentityToken`.
+ *
+ * @copyright   (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ * @origin      `@lemoncloud/codes-backend-api/cores`
+ */
+import { NextIdentity, CoreModel, View, Body } from 'lemon-model';
+export { CoreModel, View, Body };
+/** type: `IdentityTokenSite` */
+export interface IdentityTokenSite {
+    /** site-code (ex: kwonsun) */
+    code?: string;
+    /** name of site (ex: 권선) */
+    name?: string;
+}
+/** type: `IdentityTokenUser` */
+export interface IdentityTokenUser {
+    /** name of user (ex: 홍길동) */
+    name?: string;
+    /** nick of user (ex: 홍사마) */
+    nick?: string;
+    /** (optional) login-id of user */
+    login?: string;
+    /** (optional) email of user */
+    email?: string;
+}
+/** type: `IdentityTokenGroup` */
+export interface IdentityTokenGroup {
+    /** site-code (ex: kwonsun) */
+    code?: string;
+    /** name of site (ex: 권선) */
+    name?: string;
+}
+/**
+ * type: `IdentityToken` (named as `session`)
+ * - 계정토큰(= JWT(IdentityToken))으로, `/refresh`시 AWS Key와 함께 발급됨 (기본, 1일동안 유효함)
+ * - `backend-api`에서 조직/그룹/사용자에 맞게 재설정됨!
+ * - 세션토큰 검사는 `proxy.getCurrentSession()` 이용하기
+ */
+export interface IdentityToken<T = any, U extends IdentityTokenUser = IdentityTokenUser, S extends IdentityTokenSite = IdentityTokenSite, G extends IdentityTokenGroup = IdentityTokenGroup> extends NextIdentity<T> {
+    /**
+     * site-id (= id in `SiteModel(사이트)`)
+     * - `#` 일경우, 특정 site에 엮이지 않음 (무시됨)
+     * - `0000` 일경우, 기본 site 정보로 환경설정에 따름
+     * - 메인 `backend-api` (see `.iss`)에서 관리되는 `site-model`의 id
+     *
+     * @see SiteModel
+     */
+    sid: string;
+    /**
+     * group-id (= id in `GroupModel(그룹)`)
+     * - `group`은 `user`를 물리적 구분으로 나눠서 생각해볼때 이용가능함.
+     *
+     * @see GroupModel
+     */
+    gid: string;
+    /**
+     * user-id (= id in `UserModel(유저)`)
+     * - 메인 `backend-api` (see `.iss`)에서 관리되는 `user-model`의 id.
+     *
+     * @see UserModel
+     */
+    uid: string;
+    /**
+     * auth-id (= id in `AuthModel(인정정보)`)
+     * - 메인 `backend-api` (see `.iss`)에서 관리되는 `auth-model`의 id.
+     * - 인증 정보를 통해서, 로그인의 추가 상세 정보를 알 수 있음.
+     *
+     * @see AuthModel
+     */
+    aid: string;
+    /**
+     * list of roles  (like `user`, `admin`, `super`)
+     */
+    roles: string[];
+    /**
+     * (optional) internal `identity-id` (= delegated identity)
+     * - `.identityId` 는 aws cognito 인증을 통해서, 현재 인증된 `identity-id`를 알 수 있음
+     * - 다만, `delegated`된 경우에는 위임된 id 가 들어감.
+     *
+     * @deprecated 삭제될 예정! @241114
+     */
+    iid?: string;
+    /**
+     * service-name of issuer
+     * ex) `lemon-backend-api`
+     */
+    iss?: string;
+    /** Site Info */
+    Site: S;
+    /** User Info */
+    User: U;
+    /** (optional) Group Info */
+    Group?: G;
+}
+/**
+ * type `ListResult`
+ */
+export interface ListResult<T, R = any> {
+    /**
+     * total searched count
+     */
+    total?: number;
+    /**
+     * max items count in the page
+     */
+    limit?: number;
+    /**
+     * current page number.
+     */
+    page?: number;
+    /**
+     * (optional) time took in sec
+     */
+    took?: number;
+    /**
+     * items searched
+     */
+    list: T[];
+    /**
+     * (optional) aggr list
+     */
+    aggr?: R[];
+}
+export interface AggrKeyCount {
+    /** name of key(or bucket name) */
+    key: string;
+    /** number of count */
+    val: number;
+}
+/**
+ * type `PaginatedListResult`
+ */
+export interface PaginatedListResult<T, R = string> extends ListResult<T, R> {
+    /**
+     * current page
+     */
+    page: number;
+}
+/**
+ * type `ListParam`
+ */
+export interface ListParam {
+    /**
+     * max items count to be fetched
+     */
+    limit?: number;
+    /**
+     * (optional) sorting order
+     *  - 'asc': older first
+     *  - 'desc': newer first
+     *  - string: extended sorting features
+     */
+    sort?: 'asc' | 'desc' | string;
+}
+/**
+ * type `PaginateParam`
+ */
+export interface PaginateParam extends ListParam {
+    /**
+     * page # to fetch (0-indexed)
+     */
+    page?: number;
+    /**
+     * (optional) offset # from start.
+     */
+    offset?: number;
+    /**
+     * (optional) flag to filter by uid
+     */
+    uid?: string;
+    /**
+     * (optional) flag to filter by sid (only for admin role)
+     */
+    sid?: string;
+}
+/**
+ * type `BulkUpdateBody`
+ */
+export interface BulkUpdateBody<T> extends BulkBody<T> {
+    /**
+     * list bulk update model with id
+     */
+    list: T[];
+}
+/**
+ * body data for bulk
+ */
+export interface BulkBody<T> {
+    list: T[];
+}
+/**
+ * list of the selected model-id
+ */
+export interface BodyList<T extends {
+    id: string;
+} = {
+    id: string;
+}> {
+    list: T[];
+}
+/**
+ * type `BulkItemsResult`
+ */
+export interface BulkItemsResult {
+    success: number;
+    failed: number;
+    failedItems: any[];
+}

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

@@ -0,0 +1,285 @@
+/**
+ * `auth/model.ts`
+ * - model definitions per account data
+ *
+ *
+ * @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 { CoreModel } from 'lemon-model';
+import $LUT, { AccountStereo, Agreement, Alias, AuthStereo, GenderType, SiteStereo, UseAddressBasic, UserStereo, RoleStereo, InviteStereo } from './types';
+import * as $oauth2 from './oauth2/oauth2-model';
+/**
+ * type: `ModelType`
+ */
+export declare type ModelType = keyof typeof $LUT.ModelType;
+/**
+ * type: `Model`: common model
+ */
+export declare type Model = CoreModel<ModelType>;
+/**
+ * type: boolean style number.
+ */
+export declare type BoolFlag = 0 | 1;
+/**
+ * head of `account-model`
+ */
+export interface AccountHead {
+    /** id of account */
+    id?: string;
+    /** name of account */
+    name?: string;
+    /** stereo of account */
+    stereo?: AccountStereo;
+    /** open-id */
+    openId?: string;
+}
+/**
+ * type: `AccountModel`
+ * - 가입(또는 인증/무인증) 처리된 회원 정보를 담음.
+ */
+export interface AccountModel extends AccountHead, $oauth2.AccountModel<ModelType, AccountStereo> {
+    /** := identity-id */
+    id?: string;
+    /** flag of push notices */
+    isPushNotice?: number;
+    /** flag of push communities */
+    isPushCommunity?: number;
+    /** flag of push marketing */
+    isPushMarketing?: number;
+}
+/**
+ * 호스트(도메인) 모델
+ * - 호스트(도메인)으로부터 라우팅되는 타셋 사이트를 찾기 위함.
+ * - 라우트:사이트 = N:1  ()
+ */
+export interface HostModel extends $oauth2.HostModel<ModelType> {
+    /** target host (or domain) */
+    id?: string;
+}
+/**
+ * head of `site-model`
+ */
+export interface SiteHead {
+    /** id of site */
+    id?: string;
+    /** name of site */
+    name?: string;
+}
+/**
+ * 그룹 모델
+ * - CRUD (추가 생성) 가능한 모델임
+ */
+export interface GroupModel extends $oauth2.GroupModel<ModelType> {
+    /** user-id (auto-seq) */
+    id?: string;
+}
+/**
+ * type: `SiteModel`
+ * - represent of site
+ */
+export interface SiteModel<S extends string = SiteStereo> extends SiteHead, $oauth2.SiteModel<ModelType, S> {
+    /** id of site */
+    id?: string;
+    /** stereo of site */
+    stereo?: S;
+    /**
+     * flag of legacy system
+     */
+    legacy?: number;
+    /**
+     * (optional) extended alias infor if stereo == '#alias'
+     */
+    alias$?: Alias;
+    /** owner's user-id */
+    ownerId?: string;
+    /** (partial) owner-info */
+    owner$?: UserHead;
+}
+/**
+ * 역할 관리
+ * - 각 `User`와 `Site`별 설정된 권한/그룹 정보를 가짐
+ * - `*` 는 전체 사이트를 의미
+ */
+export interface RoleModel<S extends string = RoleStereo> extends $oauth2.RoleModel<ModelType, S> {
+    /**
+     * role-name (must be lower-cased alphabets)
+     * or
+     * role-id := <userId>@<siteId>
+     */
+    id?: string;
+    /** stereo type of role */
+    stereo?: S;
+    /** (internal) linked user */
+    readonly $user?: UserModel;
+}
+/**
+ * head of `user-model`
+ */
+export interface UserHead {
+    /** id of user */
+    id?: string;
+    /** name of user */
+    name?: string;
+}
+/**
+ * type: `UserModel`
+ * - represent of user login
+ */
+export interface UserModel<S extends string = UserStereo> extends UserHead, $oauth2.UserModel<ModelType, S> {
+    /** stereo type of user */
+    stereo?: S;
+    /** user code (= encode(id)) */
+    code?: string;
+    /** name of model */
+    name?: string;
+    /** nick of model */
+    nick?: string;
+    /** (optional) photo of user */
+    photo?: string;
+    /** (optional) user phone */
+    phone?: string;
+    /** (optional) user infor text content. */
+    text?: string;
+    /** (optional) user gender */
+    gender?: GenderType;
+    /** (optional) birth of user */
+    birth?: string;
+    /** (optional) address of user */
+    address?: UseAddressBasic;
+    /** (optional) email of model */
+    email?: string;
+    /** (optional) the alias-id linked (valid only if stereo is alias) */
+    aliasId?: string;
+    /** (optional) the type of alias (default 'login') */
+    aliasType?: string;
+    /** (optional) the site-id (as default login) */
+    siteId?: string;
+    /** (partial) site-info of default */
+    site$?: SiteHead;
+    /** (optional) the login-id */
+    loginType?: string;
+    /** (optional) the login-id */
+    loginId?: string;
+    /** (optional) the login-pw (encoded) */
+    loginPw?: string;
+    /** (optional) the final iid from IAM */
+    identityId?: string;
+    /** (optional) the last auth-id */
+    lastAuthId?: string;
+    /**
+     * (optional) agreement detail in timestamp.
+     */
+    agree$?: Agreement;
+    /**
+     * (optional) extended alias infor if stereo == '#alias'
+     */
+    alias$?: Alias;
+    /** (internal) account linked */
+    readonly $account?: AccountModel;
+}
+/**
+ * head of `auth-model`
+ */
+export interface AuthHead {
+    /** id of auth */
+    id?: string;
+    /** name of auth */
+    name?: string;
+}
+/**
+ * type: `AuthModel`
+ *  - authorized token information.
+ */
+export interface AuthModel extends AuthHead, $oauth2.AuthModel<ModelType, AuthStereo> {
+    /** uuid */
+    id?: string;
+    /** (optional) for internal */
+    name?: string;
+    /**
+     * stereo: same as provider.stereo.
+     */
+    stereo?: AuthStereo;
+}
+/**
+ * head of `invite-model`
+ */
+export interface InviteHead {
+    /** id of invite */
+    id?: string;
+    /** name of invite */
+    name?: string;
+}
+/**
+ * type: `InviteModel`
+ *  - inviteorized token information.
+ */
+export interface InviteModel extends InviteHead, $oauth2.InviteModel<ModelType, InviteStereo> {
+    /**
+     * stereo-type
+     */
+    stereo?: InviteStereo;
+    /** code to verify (:= uuid) */
+    code?: string;
+    /** auth-id requested */
+    authId?: string;
+    /** auth-info requested */
+    auth$?: AuthHead;
+    /** user-id to invite */
+    userId?: string;
+    /** user-info to invite */
+    user$?: UserHead;
+    /** site-id requested */
+    siteId?: string;
+    /** site-info requested */
+    site$?: SiteHead;
+    /** (optional) location to open in browser  */
+    readonly Location?: string;
+}
+/**
+ * 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: {
+    account: string[];
+    site: string[];
+    user: string[];
+    auth: string[];
+    invite: string[];
+};
+export declare const $FIELD: {
+    account: string[];
+    host: string[];
+    site: string[];
+    user: string[];
+    role: string[];
+    group: string[];
+    auth: string[];
+    invite: string[];
+};
+/** must export default as below */
+declare const _default: {
+    $HEAD: {
+        account: string[];
+        site: string[];
+        user: string[];
+        auth: string[];
+        invite: string[];
+    };
+    $FIELD: {
+        account: string[];
+        host: string[];
+        site: string[];
+        user: string[];
+        role: string[];
+        group: string[];
+        auth: string[];
+        invite: string[];
+    };
+};
+export default _default;