@grom.js/effect-tg 0.3.1 → 0.5.0

package/src/Bot.ts

@@ -0,0 +1,16 @@
+import type * as Effect from 'effect/Effect'
+import type * as BotApi from './BotApi.ts'
+import * as Context from 'effect/Context'
+
+export type Bot<E = never, R = never> = Effect.Effect<void, E, R | Update>
+
+export class Update extends Context.Tag('@grom.js/effect-tg/Bot/Update')<
+  Update,
+  BotApi.Types.Update
+>() {}
+
+export interface Middleware {
+  <E, R>(self: Bot<E, R>): Bot<any, any>
+}
+
+export const middleware: <M extends Middleware>(middleware: M) => M = mw => mw

package/src/BotApi.ts

@@ -0,0 +1,68 @@
+import type { MethodParams, MethodResults } from './internal/botApiMethods.gen.ts'
+import type { BotApiShape } from './internal/botApiShape.gen.ts'
+import type * as Types from './internal/botApiTypes.gen.ts'
+import * as Context from 'effect/Context'
+import * as Data from 'effect/Data'
+import * as Effect from 'effect/Effect'
+import * as Layer from 'effect/Layer'
+import * as BotApiTransport from './BotApiTransport.ts'
+import * as internal from './internal/botApi.ts'
+
+export type { MethodParams, MethodResults, Types }
+
+export class BotApi extends Context.Tag('@grom.js/effect-tg/BotApi')<
+  BotApi,
+  BotApi.Service
+>() {}
+
+export declare namespace BotApi {
+  export type Service = BotApiShape
+}
+
+export interface Method<
+  M extends keyof MethodParams,
+  E = BotApiError | BotApiTransport.BotApiTransportError,
+  R = never,
+> {
+  (params: MethodParams[M]): Effect.Effect<MethodResults[M], E, R>
+}
+
+/**
+ * Error returned from the Bot API server in case of unsuccessful method call.
+ */
+export class BotApiError extends Data.TaggedError('@grom.js/effect-tg/BotApi/BotApiError')<{
+  code: number
+  description: string
+  parameters?: Types.ResponseParameters
+}> {
+  override get message() {
+    return `(${this.code}) ${this.description}`
+  }
+}
+
+export const make: (
+  transport: BotApiTransport.BotApiTransport.Service,
+) => BotApiShape = internal.make
+
+export const layer: Layer.Layer<
+  BotApi,
+  never,
+  BotApiTransport.BotApiTransport
+> = Layer.effect(
+  BotApi,
+  Effect.andThen(BotApiTransport.BotApiTransport, internal.make),
+)
+
+export const callMethod: <M extends keyof MethodParams>(
+  method: M,
+  params: MethodParams[M],
+) => Effect.Effect<
+  MethodResults[M],
+  BotApiError | BotApiTransport.BotApiTransportError,
+  BotApi
+> = (
+  method: string,
+  params: unknown = undefined,
+) => BotApi.pipe(
+  Effect.flatMap((api: any) => api[method](params)),
+) as any

package/src/BotApiTransport.ts

@@ -0,0 +1,55 @@
+import type * as Types from './internal/botApiTypes.gen.ts'
+import * as HttpClient from '@effect/platform/HttpClient'
+import * as Context from 'effect/Context'
+import * as Data from 'effect/Data'
+import * as Effect from 'effect/Effect'
+import * as Layer from 'effect/Layer'
+import * as BotApiUrl from './BotApiUrl.ts'
+import * as internal from './internal/botApiTransport.ts'
+
+export class BotApiTransport extends Context.Tag('@grom.js/effect-tg/BotApiTransport')<
+  BotApiTransport,
+  BotApiTransport.Service
+>() {}
+
+export declare namespace BotApiTransport {
+  export interface Service {
+    sendRequest: (
+      method: string,
+      params: unknown,
+    ) => Effect.Effect<BotApiResponse, BotApiTransportError>
+  }
+}
+
+/**
+ * @see https://core.telegram.org/bots/api#making-requests
+ */
+export type BotApiResponse
+  = {
+    ok: true
+    result: unknown
+    description?: string
+  } | {
+    ok: false
+    error_code: number
+    description: string
+    parameters?: Types.ResponseParameters
+  }
+
+/**
+ * Error caused by the transport when accessing Bot API.
+ */
+export class BotApiTransportError extends Data.TaggedError('@grom.js/effect-tg/BotApiTransport/BotApiTransportError')<{
+  cause: unknown
+}> {}
+
+export const layer: Layer.Layer<
+  BotApiTransport,
+  never,
+  HttpClient.HttpClient | BotApiUrl.BotApiUrl
+> = Layer.effect(
+  BotApiTransport,
+  Effect.all([HttpClient.HttpClient, BotApiUrl.BotApiUrl]).pipe(
+    Effect.andThen(reqs => internal.make(...reqs)),
+  ),
+)

package/src/BotApiUrl.ts

@@ -0,0 +1,28 @@
+import * as Context from 'effect/Context'
+
+export class BotApiUrl extends Context.Tag('@grom.js/effect-tg/BotApiUrl')<
+  BotApiUrl,
+  BotApiUrl.Service
+>() {}
+
+export declare namespace BotApiUrl {
+  export interface Service {
+    toMethod: (method: string) => URL
+    toFile: (filePath: string) => URL
+  }
+}
+
+export const makeProd = (token: string): BotApiUrl.Service => (
+  {
+    toMethod: (method: string) => new URL(`https://api.telegram.org/bot${token}/${method}`),
+    toFile: (filePath: string) => new URL(`https://api.telegram.org/file/bot${token}/${filePath}`),
+  }
+)
+
+export const makeTest = (token: string): BotApiUrl.Service => (
+  {
+    toMethod: (method: string) => new URL(`https://api.telegram.org/bot${token}/test/${method}`),
+    // TODO: make sure this works in test environment
+    toFile: (filePath: string) => new URL(`https://api.telegram.org/file/bot${token}/${filePath}`),
+  }
+)

package/src/Content.ts

@@ -0,0 +1,410 @@
+import type * as Duration from 'effect/Duration'
+import type * as File from './File.ts'
+import type * as LinkPreview from './LinkPreview.ts'
+import type * as Text_ from './Text.ts'
+import * as Data from 'effect/Data'
+import * as Option from 'effect/Option'
+
+/**
+ * Content of a message to be sent.
+ *
+ * @todo Paid media
+ * @todo Invoices (fiat & stars)
+ * @see {@link https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1_input_message_content.html TDLib • td_api.InputMessageContent}
+ */
+export type Content
+  = | Text
+    | Photo
+    | Audio
+    | Document
+    | Video
+    | Animation
+    | Voice
+    | VideoNote
+    | Location
+    | Venue
+    | Contact
+    | Dice
+    | Sticker
+
+/**
+ * Content of a text message.
+ *
+ * @see {@link https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1input_message_text.html TDLib • td_api.inputMessageText}
+ * @see {@link https://core.telegram.org/bots/api#sendmessage Bot API • sendMessage}
+ */
+export class Text extends Data.TaggedClass('Text')<{
+  text: Text_.Text
+  linkPreview: Option.Option<LinkPreview.LinkPreview>
+}> {}
+
+/**
+ * Content of a photo message.
+ *
+ * @see {@link https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1input_message_photo.html TDLib • td_api.inputMessagePhoto}
+ * @see {@link https://core.telegram.org/bots/api#sendphoto Bot API • sendPhoto}
+ */
+export class Photo extends Data.TaggedClass('Photo')<{
+  file: File.FileId | File.External | File.InputFile
+  caption: Option.Option<Text_.Text>
+  layout: 'caption-above' | 'caption-below'
+  spoiler: boolean
+}> {}
+
+/**
+ * Content of an audio message.
+ *
+ * @see {@link https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1input_message_audio.html TDLib • td_api.inputMessageAudio}
+ * @see {@link https://core.telegram.org/bots/api#sendaudio Bot API • sendAudio}
+ */
+export class Audio extends Data.TaggedClass('Audio')<{
+  file: File.FileId | File.External | File.InputFile
+  caption: Option.Option<Text_.Text>
+  duration: Option.Option<Duration.Duration>
+  performer: Option.Option<string>
+  title: Option.Option<string>
+  thumbnail: Option.Option<File.InputFile>
+}> {}
+
+/**
+ * Content of a document message.
+ *
+ * @see {@link https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1input_message_document.html TDLib • td_api.inputMessageDocument}
+ * @see {@link https://core.telegram.org/bots/api#senddocument Bot API • sendDocument}
+ */
+export class Document extends Data.TaggedClass('Document')<{
+  file: File.FileId | File.External | File.InputFile
+  caption: Option.Option<Text_.Text>
+  thumbnail: Option.Option<File.InputFile>
+  contentTypeDetection: boolean
+}> {}
+
+/**
+ * Content of a video message.
+ *
+ * @see {@link https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1input_message_video.html TDLib • td_api.inputMessageVideo}
+ * @see {@link https://core.telegram.org/bots/api#sendvideo Bot API • sendVideo}
+ */
+export class Video extends Data.TaggedClass('Video')<{
+  file: File.FileId | File.External | File.InputFile
+  caption: Option.Option<Text_.Text>
+  layout: 'caption-above' | 'caption-below'
+  spoiler: boolean
+  duration: Option.Option<Duration.Duration>
+  width: Option.Option<number>
+  height: Option.Option<number>
+  thumbnail: Option.Option<File.InputFile>
+  cover: Option.Option<File.FileId | File.External | File.InputFile>
+  startAt: Option.Option<Duration.Duration>
+  supportsStreaming: boolean
+}> {}
+
+/**
+ * Content of an animation message (GIF or video without sound).
+ *
+ * @see {@link https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1input_message_animation.html TDLib • td_api.inputMessageAnimation}
+ * @see {@link https://core.telegram.org/bots/api#sendanimation Bot API • sendAnimation}
+ */
+export class Animation extends Data.TaggedClass('Animation')<{
+  file: File.FileId | File.External | File.InputFile
+  caption: Option.Option<Text_.Text>
+  layout: 'caption-above' | 'caption-below'
+  spoiler: boolean
+  duration: Option.Option<Duration.Duration>
+  width: Option.Option<number>
+  height: Option.Option<number>
+  thumbnail: Option.Option<File.InputFile>
+}> {}
+
+/**
+ * Content of a voice note message.
+ *
+ * @see {@link https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1input_message_voice_note.html TDLib • td_api.inputMessageVoiceNote}
+ * @see {@link https://core.telegram.org/bots/api#sendvoice Bot API • sendVoice}
+ */
+export class Voice extends Data.TaggedClass('Voice')<{
+  file: File.FileId | File.External | File.InputFile
+  caption: Option.Option<Text_.Text>
+  duration: Option.Option<Duration.Duration>
+}> {}
+
+/**
+ * Content of a video note message (round video).
+ *
+ * @see {@link https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1input_message_video_note.html TDLib • td_api.inputMessageVideoNote}
+ * @see {@link https://core.telegram.org/bots/api#sendvideonote Bot API • sendVideoNote}
+ */
+export class VideoNote extends Data.TaggedClass('VideoNote')<{
+  file: File.FileId | File.InputFile
+  duration: Option.Option<Duration.Duration>
+  diameter: Option.Option<number>
+  thumbnail: Option.Option<File.InputFile>
+}> {}
+
+/**
+ * Content of a location message.
+ *
+ * @see {@link https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1input_message_location.html TDLib • td_api.inputMessageLocation}
+ * @see {@link https://core.telegram.org/bots/api#sendlocation Bot API • sendLocation}
+ */
+export class Location extends Data.TaggedClass('Location')<{
+  latitude: number
+  longitude: number
+  uncertaintyRadius: Option.Option<number>
+  livePeriod: Option.Option<Duration.Duration>
+  heading: Option.Option<number>
+  proximityAlertRadius: Option.Option<number>
+}> {}
+
+/**
+ * Content of a venue message.
+ *
+ * @see {@link https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1input_message_venue.html TDLib • td_api.inputMessageVenue}
+ * @see {@link https://core.telegram.org/bots/api#sendvenue Bot API • sendVenue}
+ */
+export class Venue extends Data.TaggedClass('Venue')<{
+  latitude: number
+  longitude: number
+  title: string
+  address: string
+  foursquareId: Option.Option<string>
+  foursquareType: Option.Option<string>
+  googlePlaceId: Option.Option<string>
+  googlePlaceType: Option.Option<string>
+}> {}
+
+/**
+ * Content of a contact message.
+ *
+ * @see {@link https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1input_message_contact.html TDLib • td_api.inputMessageContact}
+ * @see {@link https://core.telegram.org/bots/api#sendcontact Bot API • sendContact}
+ */
+export class Contact extends Data.TaggedClass('Contact')<{
+  phoneNumber: string
+  firstName: string
+  lastName: Option.Option<string>
+  vcard: Option.Option<string>
+}> {}
+
+/**
+ * Content of a dice message.
+ *
+ * @see {@link https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1input_message_dice.html TDLib • td_api.inputMessageDice}
+ * @see {@link https://core.telegram.org/bots/api#senddice Bot API • sendDice}
+ */
+export class Dice extends Data.TaggedClass('Dice')<{
+  emoji: '🎲' | '🎯' | '🏀' | '⚽' | '🎳' | '🎰'
+}> {}
+
+/**
+ * Content of a sticker message.
+ *
+ * @see {@link https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1input_message_sticker.html TDLib • td_api.inputMessageSticker}
+ * @see {@link https://core.telegram.org/bots/api#sendsticker Bot API • sendSticker}
+ */
+export class Sticker extends Data.TaggedClass('Sticker')<{
+  file: File.FileId | File.External | File.InputFile
+  emoji: Option.Option<string>
+}> {}
+
+// ——— Constructors ——————————————————————————————————————————————————————————
+
+export const text = (
+  text: Text_.Text,
+  options?: {
+    linkPreview?: LinkPreview.LinkPreview
+  },
+) => new Text({
+  text,
+  linkPreview: Option.fromNullable(options?.linkPreview),
+})
+
+export const photo = (
+  file: File.FileId | File.External | File.InputFile,
+  options: {
+    caption?: Text_.Text
+    layout?: 'caption-above' | 'caption-below'
+    spoiler?: boolean
+  },
+): Photo => new Photo({
+  file,
+  caption: Option.fromNullable(options.caption),
+  layout: options.layout ?? 'caption-below',
+  spoiler: options.spoiler ?? false,
+})
+
+export const audio = (
+  file: File.FileId | File.External | File.InputFile,
+  options: {
+    caption?: Text_.Text
+    duration?: Duration.Duration
+    performer?: string
+    title?: string
+    thumbnail?: File.InputFile
+  },
+): Audio => new Audio({
+  file,
+  caption: Option.fromNullable(options.caption),
+  duration: Option.fromNullable(options.duration),
+  performer: Option.fromNullable(options.performer),
+  title: Option.fromNullable(options.title),
+  thumbnail: Option.fromNullable(options.thumbnail),
+})
+
+export const document = (
+  file: File.FileId | File.External | File.InputFile,
+  options: {
+    caption?: Text_.Text
+    thumbnail?: File.InputFile
+    contentTypeDetection?: boolean
+  },
+): Document => new Document({
+  file,
+  caption: Option.fromNullable(options.caption),
+  thumbnail: Option.fromNullable(options.thumbnail),
+  contentTypeDetection: options.contentTypeDetection ?? false,
+})
+
+export const video = (
+  file: File.FileId | File.External | File.InputFile,
+  options: {
+    caption?: Text_.Text
+    layout?: 'caption-above' | 'caption-below'
+    spoiler?: boolean
+    duration?: Duration.Duration
+    width?: number
+    height?: number
+    thumbnail?: File.InputFile
+    cover?: File.FileId | File.External | File.InputFile
+    startAt?: Duration.Duration
+    supportsStreaming?: boolean
+  },
+): Video => new Video({
+  file,
+  caption: Option.fromNullable(options.caption),
+  layout: options.layout ?? 'caption-below',
+  spoiler: options.spoiler ?? false,
+  duration: Option.fromNullable(options.duration),
+  width: Option.fromNullable(options.width),
+  height: Option.fromNullable(options.height),
+  thumbnail: Option.fromNullable(options.thumbnail),
+  cover: Option.fromNullable(options.cover),
+  startAt: Option.fromNullable(options.startAt),
+  supportsStreaming: options.supportsStreaming ?? false,
+})
+
+export const animation = (
+  file: File.FileId | File.External | File.InputFile,
+  options: {
+    caption?: Text_.Text
+    layout?: 'caption-above' | 'caption-below'
+    spoiler?: boolean
+    duration?: Duration.Duration
+    width?: number
+    height?: number
+    thumbnail?: File.InputFile
+  },
+): Animation => new Animation({
+  file,
+  caption: Option.fromNullable(options.caption),
+  layout: options.layout ?? 'caption-below',
+  spoiler: options.spoiler ?? false,
+  duration: Option.fromNullable(options.duration),
+  width: Option.fromNullable(options.width),
+  height: Option.fromNullable(options.height),
+  thumbnail: Option.fromNullable(options.thumbnail),
+})
+
+export const voice = (
+  file: File.FileId | File.External | File.InputFile,
+  options: {
+    caption?: Text_.Text
+    duration?: Duration.Duration
+  },
+): Voice => new Voice({
+  file,
+  caption: Option.fromNullable(options.caption),
+  duration: Option.fromNullable(options.duration),
+})
+
+export const videoNote = (
+  file: File.FileId | File.InputFile,
+  options: {
+    duration?: Duration.Duration
+    diameter?: number
+    thumbnail?: File.InputFile
+  },
+): VideoNote => new VideoNote({
+  file,
+  duration: Option.fromNullable(options.duration),
+  diameter: Option.fromNullable(options.diameter),
+  thumbnail: Option.fromNullable(options.thumbnail),
+})
+
+export const location = (options: {
+  latitude: number
+  longitude: number
+  uncertaintyRadius?: number
+}): Location => new Location({
+  latitude: options.latitude,
+  longitude: options.longitude,
+  uncertaintyRadius: Option.fromNullable(options.uncertaintyRadius),
+  livePeriod: Option.none(),
+  heading: Option.none(),
+  proximityAlertRadius: Option.none(),
+})
+
+export const liveLocation = (options: {
+  latitude: number
+  longitude: number
+  uncertaintyRadius?: number
+  livePeriod: Duration.Duration
+  heading?: number
+  proximityAlertRadius?: number
+}): Location => new Location({
+  latitude: options.latitude,
+  longitude: options.longitude,
+  uncertaintyRadius: Option.fromNullable(options.uncertaintyRadius),
+  livePeriod: Option.some(options.livePeriod),
+  heading: Option.fromNullable(options.heading),
+  proximityAlertRadius: Option.fromNullable(options.proximityAlertRadius),
+})
+
+export const venue = (options: {
+  latitude: number
+  longitude: number
+  title: string
+  address: string
+  foursquareId?: string
+  foursquareType?: string
+  googlePlaceId?: string
+  googlePlaceType?: string
+}): Venue => new Venue({
+  latitude: options.latitude,
+  longitude: options.longitude,
+  title: options.title,
+  address: options.address,
+  foursquareId: Option.fromNullable(options.foursquareId),
+  foursquareType: Option.fromNullable(options.foursquareType),
+  googlePlaceId: Option.fromNullable(options.googlePlaceId),
+  googlePlaceType: Option.fromNullable(options.googlePlaceType),
+})
+
+export const contact = (options: {
+  phoneNumber: string
+  firstName: string
+  lastName?: string
+  vcard?: string
+}): Contact => new Contact({
+  phoneNumber: options.phoneNumber,
+  firstName: options.firstName,
+  lastName: Option.fromNullable(options.lastName),
+  vcard: Option.fromNullable(options.vcard),
+})
+
+export const dice = (emoji: Dice['emoji']): Dice => new Dice({ emoji })
+
+export const sticker = (
+  file: File.FileId | File.External | File.InputFile,
+  emoji?: string,
+): Sticker => new Sticker({ file, emoji: Option.fromNullable(emoji) })

package/src/Dialog.ts

@@ -0,0 +1,54 @@
+import * as Data from 'effect/Data'
+import * as internal from './internal/dialog.ts'
+
+export type Dialog
+  = | UserId
+    | GroupId
+    | ChannelId
+    | SupergroupId
+    | PublicChannel
+    | PublicSupergroup
+    | ForumTopic
+    | ChannelDm
+
+export class UserId extends internal.PeerId({
+  tag: 'UserId',
+  isValid: id => (id >= 1 && id <= 0xFFFFFFFFFF),
+  toDialogId: id => id,
+}) {}
+
+export class GroupId extends internal.PeerId({
+  tag: 'GroupId',
+  isValid: id => (id >= 1 && id <= 999999999999),
+  toDialogId: id => -id,
+}) {}
+
+export class ChannelId extends internal.PeerId({
+  tag: 'ChannelId',
+  isValid: id => (id >= 1 && id <= 997852516352),
+  toDialogId: id => -(1000000000000 + id),
+}) {}
+
+export class SupergroupId extends internal.PeerId({
+  tag: 'SupergroupId',
+  isValid: id => (id >= 1 && id <= 997852516352),
+  toDialogId: id => -(1000000000000 + id),
+}) {}
+
+export class PublicChannel extends Data.TaggedClass('PublicChannel')<{
+  username: string
+}> {}
+
+export class PublicSupergroup extends Data.TaggedClass('PublicSupergroup')<{
+  username: string
+}> {}
+
+export class ForumTopic extends Data.TaggedClass('ForumTopic')<{
+  forum: SupergroupId | PublicSupergroup
+  topicId: number
+}> {}
+
+export class ChannelDm extends Data.TaggedClass('ChannelDm')<{
+  channel: ChannelId | PublicChannel
+  userId: number
+}> {}

package/src/File.ts

@@ -0,0 +1,45 @@
+import type * as Stream from 'effect/Stream'
+import * as HttpClient from '@effect/platform/HttpClient'
+import * as Brand from 'effect/Brand'
+import * as Data from 'effect/Data'
+import * as Effect from 'effect/Effect'
+import * as BotApi from './BotApi.ts'
+import * as BotApiUrl from './BotApiUrl.ts'
+
+export type FileId = string & Brand.Brand<'FileId'>
+export const FileId = Brand.nominal<FileId>()
+
+export type External = URL & Brand.Brand<'External'>
+export const External = Brand.nominal<External>()
+
+export class InputFile extends Data.TaggedClass('InputFile')<{
+  stream: Stream.Stream<Uint8Array>
+  filename: string
+  mimeType?: string
+}> {}
+
+/**
+ * @internal
+ */
+const downloadRequest = Effect.fnUntraced(
+  function* (fileId: FileId) {
+    const file = yield* BotApi.callMethod('getFile', { file_id: fileId })
+    if (file.file_path == null) {
+      return yield* Effect.die(new Error(`Bot API returned no file path for file "${fileId}".`))
+    }
+    const url = yield* BotApiUrl.BotApiUrl
+    return yield* HttpClient.get(url.toFile(file.file_path))
+  },
+)
+
+export const download = (fileId: FileId) => (
+  downloadRequest(fileId).pipe(
+    Effect.flatMap(request => request.arrayBuffer),
+  )
+)
+
+export const downloadStream = (fileId: FileId) => (
+  downloadRequest(fileId).pipe(
+    Effect.andThen(request => request.stream),
+  )
+)