platform/plugins/telegram/src/index.ts
Kristina b997b0c753
UBERF-7604: Preparation for telegram notifications (#6123)
Signed-off-by: Kristina Fefelova <kristin.fefelova@gmail.com>
2024-08-06 15:27:42 +07:00

129 lines
3.6 KiB
TypeScript

//
// Copyright © 2020, 2021 Anticrm Platform Contributors.
//
// Licensed under the Eclipse Public License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. You may
// obtain a copy of the License at https://www.eclipse.org/legal/epl-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//
// See the License for the specific language governing permissions and
// limitations under the License.
//
import { ChannelItem } from '@hcengineering/contact'
import { Account, AttachedDoc, Class, Doc, Ref, Timestamp } from '@hcengineering/core'
import { InboxNotification, NotificationProvider, NotificationType } from '@hcengineering/notification'
import type { IntlString, Plugin } from '@hcengineering/platform'
import { Metadata, plugin } from '@hcengineering/platform'
import type { Handler, IntegrationType } from '@hcengineering/setting'
import { TemplateField } from '@hcengineering/templates'
import type { AnyComponent } from '@hcengineering/ui'
/**
* @public
*/
export interface BaseTelegramMessage extends Doc {
content: string
attachments?: number
}
/**
* @public
*/
export interface TelegramMessage extends BaseTelegramMessage, ChannelItem {}
/**
* @public
*/
export interface NewTelegramMessage extends BaseTelegramMessage, AttachedDoc {
status: 'new' | 'sent'
}
/**
* @public
*/
export interface SharedTelegramMessage extends BaseTelegramMessage {
incoming: boolean
sender: string
sendOn: Timestamp
}
/**
* @public
*/
export interface SharedTelegramMessages extends AttachedDoc {
messages: SharedTelegramMessage[]
}
export interface TelegramNotificationRecord {
notificationId: Ref<InboxNotification>
workspace: string
account: Ref<Account>
title: string
quote?: string
body: string
sender: string
}
/**
* @public
*/
export const telegramId = 'telegram' as Plugin
export default plugin(telegramId, {
component: {
Chat: '' as AnyComponent,
Connect: '' as AnyComponent,
Reconnect: '' as AnyComponent,
IconTelegram: '' as AnyComponent,
SharedMessages: '' as AnyComponent
},
integrationType: {
Telegram: '' as Ref<IntegrationType>
},
handler: {
DisconnectHandler: '' as Handler
},
ids: {
NewMessageNotification: '' as Ref<NotificationType>
},
class: {
Message: '' as Ref<Class<TelegramMessage>>,
NewMessage: '' as Ref<Class<NewTelegramMessage>>,
SharedMessage: '' as Ref<Class<SharedTelegramMessage>>,
SharedMessages: '' as Ref<Class<SharedTelegramMessages>>
},
templateField: {
CurrentEmployeeTelegram: '' as Ref<TemplateField>,
IntegrationOwnerTG: '' as Ref<TemplateField>
},
metadata: {
TelegramURL: '' as Metadata<string>,
BotUrl: '' as Metadata<string>
},
providers: {
TelegramNotificationProvider: '' as Ref<NotificationProvider>
},
string: {
BotDescription: '' as IntlString,
BotShortDescription: '' as IntlString,
WelcomeMessage: '' as IntlString,
TestMessage: '' as IntlString,
ConnectMessage: '' as IntlString,
StopMessage: '' as IntlString,
StartBot: '' as IntlString,
ConnectAccount: '' as IntlString,
ShowCommandsDetails: '' as IntlString,
TurnNotificationsOff: '' as IntlString,
ConnectedDescriptionHtml: '' as IntlString,
AccountAlreadyConnectedHtml: '' as IntlString,
AccountConnectedHtml: '' as IntlString,
AccountAlreadyConnected: '' as IntlString,
InvalidCode: '' as IntlString,
SomethingWentWrong: '' as IntlString
}
})