@larksuiteoapi/node-sdk 1.12.0 → 1.13.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@larksuiteoapi/node-sdk",
-  "version": "1.12.0",
+  "version": "1.13.1",
   "description": "larksuite open sdk for nodejs",
   "keywords": [
     "feishu",

package/types/index.d.ts

@@ -10,7 +10,9 @@
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-import { AxiosRequestConfig } from 'axios';
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
+
+declare const defaultHttpInstance: AxiosInstance;
 
 interface Cache {
     set: (key: string | Symbol, value: any, expire?: number, options?: {
@@ -60,6 +62,26 @@ interface IRequestOptions$1 {
     headers?: Record<string, string>;
 }
 
+interface HttpInstance {
+    request<T = any, R = T, D = any>(opts: HttpRequestOptions<D>): Promise<R>;
+    get<T = any, R = T, D = any>(url: string, opts?: HttpRequestOptions<D>): Promise<R>;
+    delete<T = any, R = T, D = any>(url: string, opts?: HttpRequestOptions<D>): Promise<R>;
+    head<T = any, R = T, D = any>(url: string, opts?: HttpRequestOptions<D>): Promise<R>;
+    options<T = any, R = T, D = any>(url: string, opts?: HttpRequestOptions<D>): Promise<R>;
+    post<T = any, R = T, D = any>(url: string, data?: D, opts?: HttpRequestOptions<D>): Promise<R>;
+    put<T = any, R = T, D = any>(url: string, data?: D, opts?: HttpRequestOptions<D>): Promise<R>;
+    patch<T = any, R = T, D = any>(url: string, data?: D, opts?: HttpRequestOptions<D>): Promise<R>;
+}
+declare type ResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
+interface HttpRequestOptions<D> {
+    url?: string;
+    method?: string;
+    headers?: Record<string, any>;
+    params?: Record<string, any>;
+    data?: D;
+    responseType?: ResponseType;
+}
+
 interface IRequestOptions {
     lark?: {
         [CTenantKey]?: string;
@@ -82,6 +104,7 @@ interface IClientParams {
     appType?: AppType;
     helpDeskId?: string;
     helpDeskToken?: string;
+    httpInstance?: HttpInstance;
 }
 interface IPayload {
     params?: Record<string, any>;
@@ -94,6 +117,7 @@ declare abstract class Client$1 {
     tokenManager: any;
     domain: any;
     logger: Logger;
+    httpInstance: HttpInstance;
     abstract formatPayload(payload?: IPayload, options?: IRequestOptions$1): Promise<Required<IPayload>>;
     /**
      * 智能门禁
@@ -1042,7 +1066,7 @@ declare abstract class Client$1 {
                         } | undefined;
                         recommend_item_infos?: {
                             item_id?: string | undefined;
-                            item_type?: "link" | "application" | undefined;
+                            item_type?: "application" | "link" | undefined;
                             name?: string | undefined;
                             description?: string | undefined;
                             link_url?: string | undefined;
@@ -1059,7 +1083,7 @@ declare abstract class Client$1 {
                         }[] | undefined;
                         distributed_recommend_item_infos?: {
                             item_id?: string | undefined;
-                            item_type?: "link" | "application" | undefined;
+                            item_type?: "application" | "link" | undefined;
                             name?: string | undefined;
                             description?: string | undefined;
                             link_url?: string | undefined;
@@ -1108,7 +1132,7 @@ declare abstract class Client$1 {
                         } | undefined;
                         recommend_item_infos?: {
                             item_id?: string | undefined;
-                            item_type?: "link" | "application" | undefined;
+                            item_type?: "application" | "link" | undefined;
                             name?: string | undefined;
                             description?: string | undefined;
                             link_url?: string | undefined;
@@ -1125,7 +1149,7 @@ declare abstract class Client$1 {
                         }[] | undefined;
                         distributed_recommend_item_infos?: {
                             item_id?: string | undefined;
-                            item_type?: "link" | "application" | undefined;
+                            item_type?: "application" | "link" | undefined;
                             name?: string | undefined;
                             description?: string | undefined;
                             link_url?: string | undefined;
@@ -38981,7 +39005,7 @@ declare abstract class Client$1 {
                         custom_fields?: {
                             key?: string | undefined;
                             label?: string | undefined;
-                            type?: "file" | "text" | "date" | "option" | undefined;
+                            type?: "text" | "file" | "date" | "option" | undefined;
                             value?: string | undefined;
                         }[] | undefined;
                     }[] | undefined;
@@ -39170,7 +39194,7 @@ declare abstract class Client$1 {
                         custom_fields?: {
                             key?: string | undefined;
                             label?: string | undefined;
-                            type?: "file" | "text" | "date" | "option" | undefined;
+                            type?: "text" | "file" | "date" | "option" | undefined;
                             value?: string | undefined;
                         }[] | undefined;
                     }[] | undefined;
@@ -53532,6 +53556,7 @@ interface IParams$1 {
     domain: string;
     logger: Logger;
     appType: AppType;
+    httpInstance: HttpInstance;
 }
 declare class AppTicketManager {
     appId: string;
@@ -53540,6 +53565,7 @@ declare class AppTicketManager {
     domain: string;
     logger: Logger;
     appType: AppType;
+    httpInstance: HttpInstance;
     constructor(params: IParams$1);
     checkAppTicket(): Promise<void>;
     requestAppTicket(): Promise<void>;
@@ -53553,6 +53579,7 @@ interface IParams {
     domain: string;
     logger: Logger;
     appType: AppType;
+    httpInstance: HttpInstance;
 }
 declare class TokenManager {
     appId: string;
@@ -53562,6 +53589,7 @@ declare class TokenManager {
     domain: string;
     logger: Logger;
     appType: AppType;
+    httpInstance: HttpInstance;
     constructor(params: IParams);
     getCustomTenantAccessToken(): Promise<any>;
     getMarketTenantAccessToken(tenantKey: string): Promise<any>;
@@ -53581,6 +53609,7 @@ declare class Client extends Client$1 {
     disableTokenCache?: boolean;
     appType: AppType;
     domain: string;
+    httpInstance: HttpInstance;
     constructor(params: IClientParams);
     formatPayload(payload?: IPayload, options?: IRequestOptions): Promise<Required<IPayload>>;
     request<T = any>(payload: AxiosRequestConfig, options?: IRequestOptions): Promise<T>;
@@ -57754,4 +57783,4 @@ interface InteractiveCardSelectMenuActionItem extends InteractiveCardActionBaseI
     value?: Record<string, any>;
 }
 
-export { AESCipher, AppType, CAppTicket, CTenantAccessToken, Cache, CardActionHandler, Client, Domain, EventDispatcher, IHandles as EventHandles, InteractiveCard, InteractiveCardActionEvent, InteractiveCardActionItem, InteractiveCardButtonActionItem, InteractiveCardDatePickerActionItem, InteractiveCardDivElement, InteractiveCardDividerElement, InteractiveCardElement, InteractiveCardField, InteractiveCardImageElement, InteractiveCardImageItem, InteractiveCardLarkMdItem, InteractiveCardMarkdownElement, InteractiveCardNoteElement, InteractiveCardOverflowActionItem, InteractiveCardPlainTextItem, InteractiveCardSelectMenuActionItem, InteractiveCardTextItem, InteractiveCardTitle, InteractiveCardUrlItem, InterfaceCardActionElement, LoggerLevel, adaptDefault, adaptExpress, adaptKoa, adaptKoaRouter, generateChallenge, withAll, withHelpDeskCredential, withTenantKey, withTenantToken, withUserAccessToken };
+export { AESCipher, AppType, CAppTicket, CTenantAccessToken, Cache, CardActionHandler, Client, Domain, EventDispatcher, IHandles as EventHandles, HttpInstance, HttpRequestOptions, InteractiveCard, InteractiveCardActionEvent, InteractiveCardActionItem, InteractiveCardButtonActionItem, InteractiveCardDatePickerActionItem, InteractiveCardDivElement, InteractiveCardDividerElement, InteractiveCardElement, InteractiveCardField, InteractiveCardImageElement, InteractiveCardImageItem, InteractiveCardLarkMdItem, InteractiveCardMarkdownElement, InteractiveCardNoteElement, InteractiveCardOverflowActionItem, InteractiveCardPlainTextItem, InteractiveCardSelectMenuActionItem, InteractiveCardTextItem, InteractiveCardTitle, InteractiveCardUrlItem, InterfaceCardActionElement, LoggerLevel, adaptDefault, adaptExpress, adaptKoa, adaptKoaRouter, defaultHttpInstance, generateChallenge, withAll, withHelpDeskCredential, withTenantKey, withTenantToken, withUserAccessToken };