telega

2.0.0

2.3.0 2.2.1 2.2.0 2.1.0 2.0.0 1.2.0 1.1.0 1.0.0 0.15.0 0.14.0 0.13.0 0.12.1 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.1 0.5.0 0.4.0 0.3.0 0.2.0 0.1.1 0.1.0 0.0.6 0.0.5 0.0.4 0.0.3 0.0.2 0.0.1

Gleam Telegram Bot Library

HexDocs

Current section

Files

Jump to

Readme 32 Versions 10 Dependencies Dependants Files Activity

telega src telega@flow@types.erl

Raw

src/telega@flow@types.erl

-module(telega@flow@types).
-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch, inline]).
-define(FILEPATH, "src/telega/flow/types.gleam").
-export_type([flow_state/0, flow_stack_frame/0, parallel_state/0, flow_instance/0, wait_result/0, flow_instance_row/0, flow_storage/1, step_config/4, conditional_transition/1, parallel_config/1, subflow_config/4, flow_action/1, flow/4, flow_trigger/0, inline_step/0, composed_step/0]).

-if(?OTP_RELEASE >= 27).
-define(MODULEDOC(Str), -moduledoc(Str)).
-define(DOC(Str), -doc(Str)).
-else.
-define(MODULEDOC(Str), -compile([])).
-define(DOC(Str), -compile([])).
-endif.

?MODULEDOC(
    " Shared type definitions for the flow system.\n"
    "\n"
    " This module contains all types used across flow submodules.\n"
).

-type flow_state() :: {flow_state,
        binary(),
        gleam@dict:dict(binary(), binary()),
        list(binary()),
        list(flow_stack_frame()),
        gleam@option:option(parallel_state())}.

-type flow_stack_frame() :: {flow_stack_frame,
        binary(),
        binary(),
        gleam@dict:dict(binary(), binary())}.

-type parallel_state() :: {parallel_state,
        list(binary()),
        list(binary()),
        gleam@dict:dict(binary(), gleam@dict:dict(binary(), binary())),
        binary()}.

-type flow_instance() :: {flow_instance,
        binary(),
        binary(),
        integer(),
        integer(),
        flow_state(),
        gleam@dict:dict(binary(), binary()),
        gleam@option:option(binary()),
        gleam@option:option(integer()),
        integer(),
        integer()}.

-type wait_result() :: {text_input, binary()} |
    {bool_callback, boolean()} |
    {data_callback, binary()} |
    {photo_input, list(binary())} |
    {video_input, binary()} |
    {voice_input, binary()} |
    {audio_input, binary()} |
    {location_input, float(), float()} |
    {command_input, binary(), binary()} |
    pending.

-type flow_instance_row() :: {flow_instance_row,
        binary(),
        binary(),
        integer(),
        integer(),
        binary(),
        gleam@dict:dict(binary(), binary()),
        gleam@dict:dict(binary(), binary()),
        gleam@option:option(binary()),
        gleam@option:option(integer()),
        integer(),
        integer()}.

-type flow_storage(AQSQ) :: {flow_storage,
        fun((flow_instance()) -> {ok, nil} | {error, AQSQ}),
        fun((binary()) -> {ok, gleam@option:option(flow_instance())} |
            {error, AQSQ}),
        fun((binary()) -> {ok, nil} | {error, AQSQ}),
        fun((integer(), integer()) -> {ok, list(flow_instance())} |
            {error, AQSQ})}.

-type step_config(AQSR, AQSS, AQST, AQSU) :: {step_config,
        fun((telega@bot:context(AQSS, AQST, AQSU), flow_instance()) -> {ok,
                {telega@bot:context(AQSS, AQST, AQSU),
                    flow_action(AQSR),
                    flow_instance()}} |
            {error, AQST}),
        list(fun((telega@bot:context(AQSS, AQST, AQSU), flow_instance(), fun(() -> {ok,
                {telega@bot:context(AQSS, AQST, AQSU),
                    flow_action(AQSR),
                    flow_instance()}} |
            {error, AQST})) -> {ok,
                {telega@bot:context(AQSS, AQST, AQSU),
                    flow_action(AQSR),
                    flow_instance()}} |
            {error, AQST})),
        gleam@option:option(fun((telega@bot:context(AQSS, AQST, AQSU), flow_instance()) -> {ok,
                {telega@bot:context(AQSS, AQST, AQSU), flow_instance()}} |
            {error, AQST})),
        gleam@option:option(fun((telega@bot:context(AQSS, AQST, AQSU), flow_instance()) -> {ok,
                {telega@bot:context(AQSS, AQST, AQSU), flow_instance()}} |
            {error, AQST}))}.

-type conditional_transition(AQSV) :: {conditional_transition,
        binary(),
        list({fun((flow_instance()) -> boolean()), AQSV}),
        AQSV}.

-type parallel_config(AQSW) :: {parallel_config, binary(), list(AQSW), AQSW}.

-type subflow_config(AQSX, AQSY, AQSZ, AQTA) :: {subflow_config,
        binary(),
        flow(gleam@dynamic:dynamic_(), AQSY, AQSZ, AQTA),
        AQSX,
        fun((flow_instance()) -> gleam@dict:dict(binary(), binary())),
        fun((gleam@dict:dict(binary(), binary()), flow_instance()) -> flow_instance())}.

-type flow_action(AQTB) :: {next, AQTB} |
    {next_string, binary()} |
    back |
    {complete, gleam@dict:dict(binary(), binary())} |
    cancel |
    wait |
    wait_callback |
    {wait_with_timeout, integer()} |
    {wait_callback_with_timeout, integer()} |
    {go_to, AQTB} |
    {exit, gleam@option:option(gleam@dict:dict(binary(), binary()))} |
    {return_from_subflow, gleam@dict:dict(binary(), binary())} |
    {start_parallel, list(AQTB), AQTB} |
    {complete_parallel_step, AQTB, gleam@dict:dict(binary(), binary())} |
    {enter_subflow, binary(), gleam@dict:dict(binary(), binary())}.

-type flow(AQTC, AQTD, AQTE, AQTF) :: {flow,
        binary(),
        gleam@dict:dict(binary(), step_config(AQTC, AQTD, AQTE, AQTF)),
        AQTC,
        fun((AQTC) -> binary()),
        fun((binary()) -> {ok, AQTC} | {error, nil}),
        flow_storage(AQTE),
        gleam@option:option(fun((telega@bot:context(AQTD, AQTE, AQTF), flow_instance()) -> {ok,
                telega@bot:context(AQTD, AQTE, AQTF)} |
            {error, AQTE})),
        gleam@option:option(fun((telega@bot:context(AQTD, AQTE, AQTF), flow_instance(), gleam@option:option(AQTE)) -> {ok,
                telega@bot:context(AQTD, AQTE, AQTF)} |
            {error, AQTE})),
        list(fun((telega@bot:context(AQTD, AQTE, AQTF), flow_instance(), fun(() -> {ok,
                {telega@bot:context(AQTD, AQTE, AQTF),
                    flow_action(AQTC),
                    flow_instance()}} |
            {error, AQTE})) -> {ok,
                {telega@bot:context(AQTD, AQTE, AQTF),
                    flow_action(AQTC),
                    flow_instance()}} |
            {error, AQTE})),
        list(conditional_transition(AQTC)),
        list(parallel_config(AQTC)),
        list(subflow_config(AQTC, AQTD, AQTE, AQTF)),
        gleam@option:option(fun((telega@bot:context(AQTD, AQTE, AQTF), flow_instance()) -> {ok,
                {telega@bot:context(AQTD, AQTE, AQTF), flow_instance()}} |
            {error, AQTE})),
        gleam@option:option(fun((telega@bot:context(AQTD, AQTE, AQTF), flow_instance()) -> {ok,
                {telega@bot:context(AQTD, AQTE, AQTF), flow_instance()}} |
            {error, AQTE})),
        gleam@option:option(fun((telega@bot:context(AQTD, AQTE, AQTF), flow_instance()) -> {ok,
                telega@bot:context(AQTD, AQTE, AQTF)} |
            {error, AQTE})),
        gleam@option:option(integer()),
        gleam@option:option(fun((telega@bot:context(AQTD, AQTE, AQTF), flow_instance()) -> {ok,
                telega@bot:context(AQTD, AQTE, AQTF)} |
            {error, AQTE}))}.

-type flow_trigger() :: {on_command, binary()} |
    {on_text, telega@router:pattern()} |
    {on_callback, telega@router:pattern()} |
    {on_filtered, telega@router:filter()} |
    on_photo |
    on_video |
    on_audio |
    on_voice |
    on_any_text.

-type inline_step() :: {inline_step, binary()}.

-type composed_step() :: {composed_flow_step, integer()} |
    composed_select_flow |
    composed_start_parallel |
    {composed_parallel_flow, integer()} |
    composed_merge_results.

Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT