@satorijs/adapter-lark 3.6.2 → 3.7.1

package/src/types/internal.ts

@@ -15,17 +15,15 @@ type Method = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'
 export class Internal {
   constructor(private bot: LarkBot) {}
 
-  private processReponse(response: any): BaseResponse {
-    const { code, msg } = response
-    if (code === 0) {
-      return response
-    } else {
-      this.bot.logger.debug('response: %o', response)
-      throw new Error(`HTTP response with non-zero status (${code}) with message "${msg}"`)
-    }
+  private assertResponse(response: HTTP.Response<BaseResponse>) {
+    if (!response.data.code) return
+    this.bot.logger.debug('response: %o', response.data)
+    const error = new HTTP.Error(`request failed`)
+    error.response = response
+    throw error
   }
 
-  static define(routes: Dict<Partial<Record<Method, string | string[]>>>) {
+  static define(routes: Dict<Partial<Record<Method, string | string[]>>>, extractData = true) {
     for (const path in routes) {
       for (const key in routes[path]) {
         const method = key as Method
@@ -49,7 +47,9 @@ export class Internal {
             } else if (args.length > 1) {
               throw new Error(`too many arguments for ${path}, received ${raw}`)
             }
-            return this.processReponse((await this.bot.http(method, url, config)).data)
+            const response = await this.bot.http(method, url, config)
+            this.assertResponse(response)
+            return extractData ? response.data.data : response.data
           }
         }
       }

package/src/utils.ts

@@ -123,9 +123,9 @@ export async function adaptSession<C extends Context>(bot: LarkBot<C>, body: Eve
         session.channelId = body.event.context.open_chat_id
         session.guildId = body.event.context.open_chat_id
         session.userId = body.event.operator.open_id
-        const { data } = await bot.internal.getImChat(session.channelId)
+        const chat = await bot.internal.getImChat(session.channelId)
         // TODO: add channel data
-        session.isDirect = data.chat_mode === 'p2p'
+        session.isDirect = chat.chat_mode === 'p2p'
       }
       break
   }
@@ -201,7 +201,7 @@ export function extractIdType(id: string): Lark.ReceiveIdType {
   return 'user_id'
 }
 
-export function decodeChannel(channelId: string, guild: GetImChatResponse['data']): Universal.Channel {
+export function decodeChannel(channelId: string, guild: GetImChatResponse): Universal.Channel {
   return {
     id: channelId,
     type: Universal.Channel.Type.TEXT,

package/lib/types/auth.d.ts

@@ -1,40 +0,0 @@
-import { BaseResponse } from '.';
-/**
- * Lark defines three types of token:
- * - app_access_token: to access the API in an app (published on App Store).
- * - tenant_access_token: to access the API as an enterprise or a team (tenant).
- *   *We commonly use this one*
- * - user_access_token: to access the API as the specific user.
- *
- * @see https://open.larksuite.com/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM
- */
-export interface AppCredentials {
-    app_id: string;
-    app_secret: string;
-}
-export interface AppAccessToken extends BaseResponse {
-    /** access token */
-    app_access_token: string;
-    /** expire time in seconds. e.g: 7140 (119 minutes) */
-    expire: number;
-}
-export interface TenantAccessToken extends BaseResponse {
-    /** access token */
-    tenant_access_token: string;
-    /** expire time in seconds. e.g: 7140 (119 minutes) */
-    expire: number;
-}
-declare module './internal' {
-    interface Internal {
-        /**
-         * Returns the app_access_token for the bot.
-         * @see https://open.larksuite.com/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_access_token_internal
-         */
-        getAppAccessToken(data: AppCredentials): Promise<AppAccessToken>;
-        /**
-         * Returns the tenant_access_token for the bot.
-         * @see https://open.larksuite.com/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token_internal
-         */
-        getTenantAccessToken(data: AppCredentials): Promise<TenantAccessToken>;
-    }
-}

package/lib/types/guild.d.ts

@@ -1,59 +0,0 @@
-import { Dict } from '@satorijs/satori';
-import { Lark } from '.';
-import { Paginated, Pagination } from './utils';
-declare module '.' {
-    namespace Lark {
-        interface Guild {
-            avatar: string;
-            name: string;
-            description: string;
-            i18n_names: Dict<string>;
-            add_member_permission: string;
-            share_card_permission: string;
-            at_all_permission: string;
-            edit_permission: string;
-            owner_id_type: string;
-            owner_id: string;
-            chat_id: string;
-            chat_mode: string;
-            chat_type: string;
-            chat_tag: string;
-            join_message_visibility: string;
-            leave_message_visibility: string;
-            membership_approval: string;
-            moderation_permission: string;
-            external: boolean;
-            tenant_key: string;
-            user_count: string;
-            bot_count: string;
-        }
-    }
-}
-export interface GuildMember {
-    member_id_type: Lark.UserIdType;
-    member_id: string;
-    name: string;
-    tenant_key: string;
-}
-declare module './internal' {
-    interface Internal {
-        /** @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list */
-        getCurrentUserGuilds(params?: Pagination<{
-            user_id_type?: Lark.UserIdType;
-        }>): Promise<{
-            data: Paginated<Lark.Guild>;
-        }>;
-        /** @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get */
-        getGuildInfo(chat_id: string, params?: {
-            user_id_type?: string;
-        }): Promise<BaseResponse & {
-            data: Lark.Guild;
-        }>;
-        /** @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/get */
-        getGuildMembers(chat_id: string, params?: Pagination<{
-            member_id_type?: Lark.UserIdType;
-        }>): Promise<{
-            data: Paginated<GuildMember>;
-        }>;
-    }
-}

package/lib/types/message/asset.d.ts

@@ -1,40 +0,0 @@
-import { BaseResponse } from '..';
-export interface Asset<T> extends BaseResponse {
-    data: T;
-}
-export type Image = Asset<{
-    image_key: string;
-}>;
-export type File = Asset<{
-    file_key: string;
-}>;
-declare module '../internal' {
-    interface Internal {
-        /**
-         * Upload an image to obtain an `image_key` for use in sending messages or changing the avatar.
-         *
-         * The data should contain:
-         * - `image_type`: 'message' | 'avatar'
-         * - `image': Buffer
-         * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create
-         */
-        uploadImage(data: FormData): Promise<Image>;
-        /**
-         * Upload a file to obtain a `file_key` for use in sending messages.
-         *
-         * The data should contain:
-         * - `file_type`: 'opus' | 'mp4' | 'pdf' | 'xls' | 'ppt' | 'stream'
-         *   - `opus`: Opus audio file
-         *   - `mp4`: MP4 video file
-         *   - `pdf`: PDF file
-         *   - `xls`: Excel file
-         *   - `ppt`: PowerPoint file
-         *   - `stream`: Stream file, or any other file not listed above
-         * - `file_name`: string, include extension
-         * - `duration`?: number, the duration of audio/video file in milliseconds
-         * - `file`: Buffer
-         * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/file/create
-         */
-        uploadFile(data: FormData): Promise<File>;
-    }
-}

package/lib/types/user.d.ts

@@ -1,78 +0,0 @@
-import { Lark } from '.';
-declare module '.' {
-    namespace Lark {
-        interface User {
-            union_id: string;
-            user_id?: string;
-            open_id: string;
-            name?: string;
-            en_name?: string;
-            nickname?: string;
-            email?: string;
-            mobile?: string;
-            mobile_visible: boolean;
-            gender?: Gender;
-            avatar?: AvatarInfo;
-            status?: UserStatus;
-            department_ids?: string[];
-            leader_user_id?: string;
-            city?: string;
-            country?: string;
-            work_station?: string;
-            join_time?: number;
-            is_tenant_manager?: boolean;
-            employee_no?: string;
-            employee_type?: number;
-            orders?: UserOrder[];
-            custom_attrs?: any;
-            enterprise_email?: string;
-            job_title?: string;
-            geo?: string;
-            job_level_id?: string;
-            job_family_id?: string;
-            assign_info?: any;
-            department_path?: DepartmentDetail[];
-        }
-        enum Gender {
-            SECRET = 0,
-            MALE = 1,
-            FEMALE = 2
-        }
-        interface AvatarInfo {
-            avatar_72: string;
-            avatar_240: string;
-            avatar_640: string;
-            avatar_origin: string;
-        }
-        interface UserStatus {
-            is_frozen: boolean;
-            is_resigned: boolean;
-            is_activated: boolean;
-            is_exited: boolean;
-            is_unjoin: boolean;
-        }
-        interface UserOrder {
-            department_id: string;
-            user_order: number;
-            department_order: number;
-            is_primary_dept: boolean;
-        }
-        interface DepartmentDetail {
-            dotted_line_leader_user_ids: string[];
-        }
-    }
-}
-export interface GuildMember {
-    member_id_type: Lark.UserIdType;
-    member_id: string;
-    name: string;
-    tenant_key: string;
-}
-declare module './internal' {
-    interface Internal {
-        /** @see https://open.larksuite.com/document/server-docs/contact-v3/user/get */
-        getContactUser(user_id: string, user_id_type?: Lark.UserIdType, department_id_type?: Lark.DepartmentIdType): Promise<BaseResponse & {
-            data: Lark.User;
-        }>;
-    }
-}

package/lib/types/utils.d.ts

@@ -1,9 +0,0 @@
-export type Pagination<T> = T & {
-    page_size?: number;
-    page_token?: string;
-};
-export interface Paginated<T> {
-    items: T[];
-    has_more: boolean;
-    page_token: string;
-}