chz-telegram-bot 0.3.24 → 0.3.26

package/helpers/builders/inlineQueryActionBuilder.ts

@@ -1,6 +1,7 @@
 import { InlineQueryHandler } from '../../types/handlers';
 import { Noop } from '../noop';
 import { InlineQueryAction } from '../../entities/actions/inlineQueryAction';
+import { InlineActionPropertyProvider } from '../../types/propertyProvider';
 
 /**
  * Builder for `InlineQueryAction`
@@ -9,7 +10,7 @@ export class InlineQueryActionBuilder {
     private readonly name: string;
     private pattern: RegExp = /.+/gi;
 
-    private active = true;
+    private activeProvider: InlineActionPropertyProvider<boolean> = () => true;
     private handler: InlineQueryHandler = Noop.call;
 
     /**
@@ -41,7 +42,19 @@ export class InlineQueryActionBuilder {
 
     /** If called during building, action is marked as disabled and never checked. */
     disabled() {
-        this.active = false;
+        this.activeProvider = () => false;
+
+        return this;
+    }
+
+    /**
+     * Configures action to use property value providers instead of static value to allow changes in runtime
+     */
+    withConfiguration(configuration: {
+        isActiveProvider?: InlineActionPropertyProvider<boolean>;
+    }) {
+        if (configuration.isActiveProvider)
+            this.activeProvider = configuration.isActiveProvider;
 
         return this;
     }
@@ -51,7 +64,7 @@ export class InlineQueryActionBuilder {
         return new InlineQueryAction(
             this.handler,
             this.name,
-            this.active,
+            this.activeProvider,
             this.pattern
         );
     }

package/helpers/builders/scheduledActionBuilder.ts

@@ -3,6 +3,7 @@ import { CachedStateFactory } from '../../entities/cachedStateFactory';
 import { ActionStateBase } from '../../entities/states/actionStateBase';
 import { IActionState } from '../../types/actionState';
 import { ScheduledHandler } from '../../types/handlers';
+import { ScheduledActionPropertyProvider } from '../../types/propertyProvider';
 import { Hours, HoursOfDay } from '../../types/timeValues';
 import { Noop } from '../noop';
 
@@ -12,17 +13,20 @@ import { Noop } from '../noop';
 export class ScheduledActionBuilderWithState<
     TActionState extends IActionState
 > {
-    private active = true;
-    private time: HoursOfDay = 0;
+    private readonly name: string;
     private readonly cachedStateFactories = new Map<
         string,
         CachedStateFactory
     >();
-    private whitelist: number[] = [];
     private readonly stateConstructor: () => TActionState;
     private handler: ScheduledHandler<TActionState> = Noop.call;
 
-    private readonly name: string;
+    private whitelistProvider: ScheduledActionPropertyProvider<number[]> =
+        () => [];
+    private activeProvider: ScheduledActionPropertyProvider<boolean> = () =>
+        true;
+    private timeinHoursProvider: ScheduledActionPropertyProvider<HoursOfDay> =
+        () => 0;
 
     /**
      * Builder for `ScheduledAction` with state represented by `TActionState`
@@ -39,7 +43,7 @@ export class ScheduledActionBuilderWithState<
      * @param chatIds Chat ids to execute in.
      */
     in(chatIds: number[]) {
-        this.whitelist = chatIds;
+        this.whitelistProvider = () => chatIds;
 
         return this;
     }
@@ -49,7 +53,7 @@ export class ScheduledActionBuilderWithState<
      * @param time Time of day (0 - 23) to execute action.
      */
     runAt(time: HoursOfDay) {
-        this.time = time;
+        this.timeinHoursProvider = () => time;
 
         return this;
     }
@@ -85,7 +89,27 @@ export class ScheduledActionBuilderWithState<
 
     /** If called during building, action is marked as disabled and never checked. */
     disabled() {
-        this.active = false;
+        this.activeProvider = () => false;
+
+        return this;
+    }
+
+    /**
+     * Configures action to use property value providers instead of static value to allow changes in runtime
+     */
+    withConfiguration(configuration: {
+        timeinHoursProvider?: ScheduledActionPropertyProvider<HoursOfDay>;
+        isActiveProvider?: ScheduledActionPropertyProvider<boolean>;
+        chatsWhitelistProvider?: ScheduledActionPropertyProvider<number[]>;
+    }) {
+        if (configuration.chatsWhitelistProvider)
+            this.whitelistProvider = configuration.chatsWhitelistProvider;
+
+        if (configuration.timeinHoursProvider)
+            this.timeinHoursProvider = configuration.timeinHoursProvider;
+
+        if (configuration.isActiveProvider)
+            this.activeProvider = configuration.isActiveProvider;
 
         return this;
     }
@@ -95,9 +119,11 @@ export class ScheduledActionBuilderWithState<
         return new ScheduledAction<TActionState>(
             this.name,
             this.handler,
-            this.time,
-            this.active,
-            this.whitelist,
+            {
+                chatsWhitelistProvider: this.whitelistProvider,
+                isActiveProvider: this.activeProvider,
+                timeinHoursProvider: this.timeinHoursProvider
+            },
             this.cachedStateFactories,
             this.stateConstructor
         );

package/package.json

@@ -1,44 +1,44 @@
-{
-    "name": "chz-telegram-bot",
-    "description": "Opinionated TypeScript framework that provides a structured approach to building Telegram bots.",
-    "author": {
-        "name": "Alex Halanin",
-        "url": "https://github.com/AlexSolari"
-    },
-    "license": "MIT",
-    "keywords": [
-        "telegram",
-        "telegram bot"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/AlexSolari/botFramework.git"
-    },
-    "version": "0.3.24",
-    "type": "module",
-    "dependencies": {
-        "async-sema": "^3.1.1",
-        "moment": "^2.29.4",
-        "telegraf": "^4.16.3"
-    },
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "devDependencies": {
-        "@eslint/js": "^9.29.0",
-        "@types/markdown-escape": "^1.1.3",
-        "@types/node": "^22.5.5",
-        "eslint": "^9.29.0",
-        "globals": "^16.2.0",
-        "typescript": "^5.9.0-beta",
-        "typescript-eslint": "^8.34.1"
-    },
-    "scripts": {
-        "build": "tsc",
-        "lint": "npx eslint && tsc --noEmit"
-    },
-    "overrides": {
-        "telegraf": {
-            "node-fetch": "3.3.2"
-        }
-    }
-}
+{
+    "name": "chz-telegram-bot",
+    "description": "Opinionated TypeScript framework that provides a structured approach to building Telegram bots.",
+    "author": {
+        "name": "Alex Halanin",
+        "url": "https://github.com/AlexSolari"
+    },
+    "license": "MIT",
+    "keywords": [
+        "telegram",
+        "telegram bot"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/AlexSolari/botFramework.git"
+    },
+    "version": "0.3.26",
+    "type": "module",
+    "dependencies": {
+        "async-sema": "^3.1.1",
+        "moment": "^2.29.4",
+        "telegraf": "^4.16.3"
+    },
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "devDependencies": {
+        "@eslint/js": "^9.29.0",
+        "@types/markdown-escape": "^1.1.3",
+        "@types/node": "^22.5.5",
+        "eslint": "^9.29.0",
+        "globals": "^16.2.0",
+        "typescript": "^5.9.0-beta",
+        "typescript-eslint": "^8.34.1"
+    },
+    "scripts": {
+        "build": "tsc",
+        "lint": "npx eslint && tsc --noEmit"
+    },
+    "overrides": {
+        "telegraf": {
+            "node-fetch": "3.3.2"
+        }
+    }
+}

package/services/jsonLogger.ts

@@ -12,6 +12,25 @@ export class JsonLogger implements ILogger {
         return JSON.stringify(plainObject);
     }
 
+    private getCircularReplacer() {
+        const ancestors: unknown[] = [];
+        return function <V>(this: V, _: unknown, value: V) {
+            if (typeof value !== 'object' || value === null) {
+                return value;
+            }
+            // `this` is the object that value is contained in,
+            // i.e., its direct parent.
+            while (ancestors.length > 0 && ancestors.at(-1) !== this) {
+                ancestors.pop();
+            }
+            if (ancestors.includes(value)) {
+                return '[Circular]';
+            }
+            ancestors.push(value);
+            return value;
+        };
+    }
+
     createScope(botName: string, traceId: TraceId, chatName: string) {
         return {
             logObjectWithTraceId: (data: any) => {
@@ -63,7 +82,10 @@ export class JsonLogger implements ILogger {
         extraData?: unknown
     ) {
         const dataString = extraData
-            ? `,"extraData":${JSON.stringify(extraData)}`
+            ? `,"extraData":${JSON.stringify(
+                  extraData,
+                  this.getCircularReplacer()
+              )}`
             : '';
 
         console.error(

package/types/propertyProvider.ts

@@ -0,0 +1,14 @@
+import { ChatContext } from '../entities/context/chatContext';
+import { InlineQueryContext } from '../entities/context/inlineQueryContext';
+import { MessageContext } from '../entities/context/messageContext';
+import { IActionState } from './actionState';
+
+export type CommandActionPropertyProvider<T> = (
+    ctx: MessageContext<IActionState>
+) => T;
+
+export type InlineActionPropertyProvider<T> = (ctx: InlineQueryContext) => T;
+
+export type ScheduledActionPropertyProvider<T> = (
+    ctx: ChatContext<IActionState>
+) => T;

package/dist/dtos/actionPermissionsData.d.ts

@@ -1,7 +0,0 @@
-export declare class ActionPermissionsData {
-    readonly userIdsWhitelist: number[];
-    readonly chatIdsWhitelist: number[];
-    readonly chatIdsBlacklist: number[];
-    constructor(userIdsWhitelist: number[], chatIdsWhitelist: number[], chatIdsBlacklist: number[]);
-}
-//# sourceMappingURL=actionPermissionsData.d.ts.map

package/dist/dtos/actionPermissionsData.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"actionPermissionsData.d.ts","sourceRoot":"","sources":["../../dtos/actionPermissionsData.ts"],"names":[],"mappings":"AAAA,qBAAa,qBAAqB;IAE1B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE;IACnC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE;IACnC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE;gBAF1B,gBAAgB,EAAE,MAAM,EAAE,EAC1B,gBAAgB,EAAE,MAAM,EAAE,EAC1B,gBAAgB,EAAE,MAAM,EAAE;CAE1C"}

package/dist/dtos/actionPermissionsData.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActionPermissionsData = void 0;
-class ActionPermissionsData {
-    userIdsWhitelist;
-    chatIdsWhitelist;
-    chatIdsBlacklist;
-    constructor(userIdsWhitelist, chatIdsWhitelist, chatIdsBlacklist) {
-        this.userIdsWhitelist = userIdsWhitelist;
-        this.chatIdsWhitelist = chatIdsWhitelist;
-        this.chatIdsBlacklist = chatIdsBlacklist;
-    }
-}
-exports.ActionPermissionsData = ActionPermissionsData;

package/dtos/actionPermissionsData.ts

@@ -1,7 +0,0 @@
-export class ActionPermissionsData {
-    constructor(
-        readonly userIdsWhitelist: number[],
-        readonly chatIdsWhitelist: number[],
-        readonly chatIdsBlacklist: number[]
-    ) {}
-}