@blueking/chat-helper 0.0.1-beta.1

package/dist/index.ts.js

@@ -0,0 +1,40 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * 蓝鲸智云PaaS平台 (BlueKing PaaS) available.
+ *
+ * Copyright (C) 2021 THL A29 Limited, a Tencent company.  All rights reserved.
+ *
+ * 蓝鲸智云PaaS平台 (BlueKing PaaS) is licensed under the MIT License.
+ *
+ * License for 蓝鲸智云PaaS平台 (BlueKing PaaS):
+ *
+ * ---------------------------------------------------
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
+ * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
+ * the Software.
+ *
+ * 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 { useAgent } from './agent/index.ts.js';
+import { useHttp } from './http/index.ts.js';
+import { useMessage } from './message/index.ts.js';
+import { useSession } from './session/index.ts.js';
+export const useChatHelper = (options)=>{
+    const http = useHttp(options);
+    const message = useMessage(http);
+    const agent = useAgent(options, http, message);
+    const session = useSession(http, message, agent);
+    return {
+        agent,
+        session,
+        message,
+        http
+    };
+};

package/dist/message/index.d.ts

@@ -0,0 +1,2 @@
+export * from './type';
+export * from './use-message';

package/dist/message/index.ts.js

@@ -0,0 +1,26 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * 蓝鲸智云PaaS平台 (BlueKing PaaS) available.
+ *
+ * Copyright (C) 2021 THL A29 Limited, a Tencent company.  All rights reserved.
+ *
+ * 蓝鲸智云PaaS平台 (BlueKing PaaS) is licensed under the MIT License.
+ *
+ * License for 蓝鲸智云PaaS平台 (BlueKing PaaS):
+ *
+ * ---------------------------------------------------
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
+ * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
+ * the Software.
+ *
+ * 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.
+ */ export * from './type.ts.js';
+export * from './use-message.ts.js';

package/dist/message/type.d.ts

@@ -0,0 +1,277 @@
+export declare enum MessageContentStatus {
+    Complete = "complete",
+    Error = "error",
+    Stop = "stop",
+    Streaming = "streaming"
+}
+export declare enum MessageContentType {
+    Image = "image",
+    ReferenceDocument = "reference_document",
+    Text = "text",
+    Thinking = "thinking",
+    ToolCall = "tool_call"
+}
+export declare enum MessageRole {
+    Assistant = "assistant",
+    Guide = "guide",
+    Hidden = "hidden",
+    HiddenAssistant = "hidden-assistant",
+    HiddenGuide = "hidden-guide",
+    HiddenSystem = "hidden-system",
+    HiddenUser = "hidden-user",
+    Info = "info",
+    Pause = "pause",
+    Placeholder = "placeholder",
+    System = "system",
+    TemplateAssistant = "template-assistant",
+    TemplateGuide = "template-guide",
+    TemplateHidden = "template-hidden",
+    TemplateSystem = "template-system",
+    TemplateUser = "template-user",
+    User = "user"
+}
+export declare enum MessageStatus {
+    Complete = "complete",
+    Error = "error",
+    Pending = "pending",
+    Stop = "stop",
+    Streaming = "streaming"
+}
+export interface IAssistantMessage extends IBaseMessage {
+    role: MessageRole.Assistant;
+    content: Array<IImageMessageContent | IReferenceDocumentMessageContent | ITextMessageContent | IThinkingMessageContent | IToolCallMessageContent>;
+}
+export interface IAssistantMessageApi extends IBaseMessageApi {
+    role: MessageRole.Assistant;
+    content: Array<IImageMessageContentApi | IReferenceDocumentMessageContentApi | ITextMessageContentApi | IThinkingMessageContentApi | IToolCallMessageContentApi>;
+}
+export interface IBaseMessage {
+    id: number;
+    property?: Record<string, unknown>;
+    status?: MessageStatus;
+}
+export interface IBaseMessageApi {
+    id: number;
+    property?: Record<string, unknown>;
+    status?: MessageStatus;
+}
+export interface IBaseMessageContent {
+    status: MessageContentStatus;
+}
+export interface IBaseMessageContentApi {
+    status: MessageContentStatus;
+}
+export interface IGuideMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.Guide;
+}
+export interface IGuideMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.Guide;
+}
+export interface IHiddenAssistantMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.HiddenAssistant;
+}
+export interface IHiddenAssistantMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.HiddenAssistant;
+}
+export interface IHiddenGuideMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.HiddenGuide;
+}
+export interface IHiddenGuideMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.HiddenGuide;
+}
+export interface IHiddenMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.Hidden;
+}
+export interface IHiddenMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.Hidden;
+}
+export interface IHiddenSystemMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.HiddenSystem;
+}
+export interface IHiddenSystemMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.HiddenSystem;
+}
+export interface IHiddenUserMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.HiddenUser;
+}
+export interface IHiddenUserMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.HiddenUser;
+}
+export interface IImageMessageContent extends IBaseMessageContent {
+    type: MessageContentType.Image;
+    data: {
+        height?: number;
+        url: string;
+        width?: number;
+    };
+}
+export interface IImageMessageContentApi extends IBaseMessageContentApi {
+    type: MessageContentType.Image;
+    data: {
+        height?: number;
+        url: string;
+        width?: number;
+    };
+}
+export interface IInfoMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.Info;
+}
+export interface IInfoMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.Info;
+}
+export type IMessage = IAssistantMessage | IGuideMessage | IHiddenAssistantMessage | IHiddenGuideMessage | IHiddenMessage | IHiddenSystemMessage | IHiddenUserMessage | IInfoMessage | IPauseMessage | IPlaceholderMessage | ISystemMessage | ITemplateAssistantMessage | ITemplateGuideMessage | ITemplateHiddenMessage | ITemplateSystemMessage | ITemplateUserMessage | IUserMessage;
+export type IMessageApi = IAssistantMessageApi | IGuideMessageApi | IHiddenAssistantMessageApi | IHiddenGuideMessageApi | IHiddenMessageApi | IHiddenSystemMessageApi | IHiddenUserMessageApi | IInfoMessageApi | IPauseMessageApi | IPlaceholderMessageApi | ISystemMessageApi | ITemplateAssistantMessageApi | ITemplateGuideMessageApi | ITemplateHiddenMessageApi | ITemplateSystemMessageApi | ITemplateUserMessageApi | IUserMessageApi;
+export type IMessageContent = IImageMessageContent | IReferenceDocumentMessageContent | ITextMessageContent | IThinkingMessageContent | IToolCallMessageContent;
+export type IMessageContentApi = IImageMessageContentApi | IReferenceDocumentMessageContentApi | ITextMessageContentApi | IThinkingMessageContentApi | IToolCallMessageContentApi;
+export interface IPauseMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.Pause;
+}
+export interface IPauseMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.Pause;
+}
+export interface IPlaceholderMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.Placeholder;
+}
+export interface IPlaceholderMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.Placeholder;
+}
+export interface IReferenceDocumentMessageContent extends IBaseMessageContent {
+    type: MessageContentType.ReferenceDocument;
+    data: {
+        icon?: string;
+        originFileUrl?: string;
+        title: string;
+        url: string;
+    }[];
+}
+export interface IReferenceDocumentMessageContentApi extends IBaseMessageContentApi {
+    type: MessageContentType.ReferenceDocument;
+    data: {
+        icon?: string;
+        origin_file_url?: string;
+        title: string;
+        url: string;
+    }[];
+}
+export interface ISystemMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.System;
+}
+export interface ISystemMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.System;
+}
+export interface ITemplateAssistantMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.TemplateAssistant;
+}
+export interface ITemplateAssistantMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.TemplateAssistant;
+}
+export interface ITemplateGuideMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.TemplateGuide;
+}
+export interface ITemplateGuideMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.TemplateGuide;
+}
+export interface ITemplateHiddenMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.TemplateHidden;
+}
+export interface ITemplateHiddenMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.TemplateHidden;
+}
+export interface ITemplateSystemMessage extends IBaseMessage {
+    content: ITextMessageContentApi[];
+    role: MessageRole.TemplateSystem;
+}
+export interface ITemplateSystemMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.TemplateSystem;
+}
+export interface ITemplateUserMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.TemplateUser;
+}
+export interface ITemplateUserMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.TemplateUser;
+}
+export interface ITextMessageContent extends IBaseMessageContent {
+    data: string;
+    id?: number;
+    type: MessageContentType.Text;
+}
+export interface ITextMessageContentApi extends IBaseMessageContent {
+    data: string;
+    id?: number;
+    type: MessageContentType.Text;
+}
+export interface IThinkingMessageContent extends IBaseMessageContent {
+    type: MessageContentType.Thinking;
+    data: {
+        duration?: number;
+        text: string;
+        title?: string;
+    };
+}
+export interface IThinkingMessageContentApi extends IBaseMessageContentApi {
+    type: MessageContentType.Thinking;
+    data: {
+        duration?: number;
+        text: string;
+        title?: string;
+    };
+}
+export interface IToolCallMessageContent extends IBaseMessageContent {
+    type: MessageContentType.ToolCall;
+    data: {
+        args?: string;
+        chunk?: string;
+        parentMessageId?: string;
+        result?: string;
+        toolCallId: string;
+        toolCallName: string;
+    };
+}
+export interface IToolCallMessageContentApi extends IBaseMessageContentApi {
+    type: MessageContentType.ToolCall;
+    data: {
+        args?: string;
+        chunk?: string;
+        parent_message_id?: string;
+        result?: string;
+        tool_call_id: string;
+        tool_call_name: string;
+    };
+}
+export interface IUserMessage extends IBaseMessage {
+    content: ITextMessageContent[];
+    role: MessageRole.User;
+}
+export interface IUserMessageApi extends IBaseMessageApi {
+    content: ITextMessageContentApi[];
+    role: MessageRole.User;
+}

package/dist/message/type.ts.js

@@ -0,0 +1,67 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * 蓝鲸智云PaaS平台 (BlueKing PaaS) available.
+ *
+ * Copyright (C) 2021 THL A29 Limited, a Tencent company.  All rights reserved.
+ *
+ * 蓝鲸智云PaaS平台 (BlueKing PaaS) is licensed under the MIT License.
+ *
+ * License for 蓝鲸智云PaaS平台 (BlueKing PaaS):
+ *
+ * ---------------------------------------------------
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
+ * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
+ * the Software.
+ *
+ * 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.
+ */ export var MessageContentStatus;
+(function(MessageContentStatus) {
+    MessageContentStatus["Complete"] = "complete";
+    MessageContentStatus["Error"] = "error";
+    MessageContentStatus["Stop"] = "stop";
+    MessageContentStatus["Streaming"] = "streaming";
+})(MessageContentStatus || (MessageContentStatus = {}));
+export var MessageContentType;
+(function(MessageContentType) {
+    MessageContentType["Image"] = "image";
+    MessageContentType["ReferenceDocument"] = "reference_document";
+    MessageContentType["Text"] = "text";
+    MessageContentType["Thinking"] = "thinking";
+    MessageContentType["ToolCall"] = "tool_call";
+})(MessageContentType || (MessageContentType = {}));
+export var MessageRole;
+(function(MessageRole) {
+    MessageRole["Assistant"] = "assistant";
+    MessageRole["Guide"] = "guide";
+    MessageRole["Hidden"] = "hidden";
+    MessageRole["HiddenAssistant"] = "hidden-assistant";
+    MessageRole["HiddenGuide"] = "hidden-guide";
+    MessageRole["HiddenSystem"] = "hidden-system";
+    MessageRole["HiddenUser"] = "hidden-user";
+    MessageRole["Info"] = "info";
+    MessageRole["Pause"] = "pause";
+    MessageRole["Placeholder"] = "placeholder";
+    MessageRole["System"] = "system";
+    MessageRole["TemplateAssistant"] = "template-assistant";
+    MessageRole["TemplateGuide"] = "template-guide";
+    MessageRole["TemplateHidden"] = "template-hidden";
+    MessageRole["TemplateSystem"] = "template-system";
+    MessageRole["TemplateUser"] = "template-user";
+    MessageRole["User"] = "user";
+})(MessageRole || (MessageRole = {}));
+export var MessageStatus;
+(function(MessageStatus) {
+    MessageStatus["Complete"] = "complete";
+    MessageStatus["Error"] = "error";
+    MessageStatus["Pending"] = "pending";
+    MessageStatus["Stop"] = "stop";
+    MessageStatus["Streaming"] = "streaming";
+})(MessageStatus || (MessageStatus = {}));