@grom.js/effect-tg 0.9.0 → 0.10.0

package/README.md

@@ -83,15 +83,22 @@ This design enables:
 ```ts
 import { FetchHttpClient } from '@effect/platform'
 import { BotApi, BotApiTransport, BotApiUrl } from '@grom.js/effect-tg'
-import { Effect, Layer } from 'effect'
+import { Config, Effect, Layer } from 'effect'
 
+// Use a shortcut to construct BotApi
+const BotApiLive = Layer.provide(
+  BotApi.layerConfig({ token: Config.redacted('BOT_TOKEN') }),
+  FetchHttpClient.layer
+)
+
+// Or provide all layers manually
 const BotApiLive = BotApi.layer.pipe(
   Layer.provide(BotApiTransport.layer),
   Layer.provide(
-    Layer.succeed(
+    Layer.effect(
       BotApiUrl.BotApiUrl,
-      BotApiUrl.makeProd('YOUR_BOT_TOKEN')
-    )
+      Effect.map(Config.string('BOT_API_TOKEN'), BotApiUrl.makeProd)
+    ),
   ),
   Layer.provide(FetchHttpClient.layer),
 )

package/dist/BotApi.d.ts

@@ -1,8 +1,12 @@
+import type * as Config from 'effect/Config';
+import type * as ConfigError from 'effect/ConfigError';
 import type * as BotApiError from './BotApiError.ts';
 import type { MethodParams, MethodResults, BotApi as Service, Types } from './internal/botApi.gen.ts';
+import * as HttpClient from '@effect/platform/HttpClient';
 import * as Context from 'effect/Context';
 import * as Effect from 'effect/Effect';
 import * as Layer from 'effect/Layer';
+import * as Redacted from 'effect/Redacted';
 import * as BotApiTransport from './BotApiTransport.ts';
 export type { MethodParams, MethodResults, Service, Types };
 declare const BotApi_base: Context.TagClass<BotApi, "@grom.js/effect-tg/BotApi", Service>;
@@ -17,4 +21,32 @@ export declare const make: (args: {
 }) => Service;
 export declare const layer: Layer.Layer<BotApi, never, BotApiTransport.BotApiTransport>;
 type MethodArgs<TMethod extends keyof MethodParams> = void extends MethodParams[TMethod] ? [params?: MethodParams[TMethod]] : [params: MethodParams[TMethod]];
+/**
+ * Constructs a `BotApi` layer from the given configuration.
+ */
+export declare const layerConfig: (options: {
+    /**
+     * Bot API token from [@BotFather](https://t.me/BotFather).
+     */
+    readonly token: Config.Config<Redacted.Redacted>;
+    /**
+     * Target Bot API environment:
+     *
+     * - `prod` — production environment
+     * - `test` — [test environment](https://core.telegram.org/bots/features#dedicated-test-environment)
+     *
+     * @default 'prod'
+     */
+    readonly environment?: "prod" | "test";
+    /**
+     * A function to transform the underlying `BotApiTransport` before
+     * it's used to call Bot API methods.
+     *
+     * Useful for:
+     * - Adding custom middleware (logging, metrics, caching)
+     * - Adding custom retry logic or error handling
+     * - Integrating with monitoring or debugging tools
+     */
+    readonly transformTransport?: (transport: BotApiTransport.Service) => BotApiTransport.Service;
+}) => Layer.Layer<BotApi, ConfigError.ConfigError, HttpClient.HttpClient>;
 //# sourceMappingURL=BotApi.d.ts.map

package/dist/BotApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BotApi.d.ts","sourceRoot":"","sources":["../src/BotApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,WAAW,MAAM,kBAAkB,CAAA;AACpD,OAAO,KAAK,EACV,YAAY,EACZ,aAAa,EACb,MAAM,IAAI,OAAO,EACjB,KAAK,EACN,MAAM,0BAA0B,CAAA;AACjC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAGvD,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;;AAE3D,qBAAa,MAAO,SAAQ,WAGzB;CAAG;AAEN,MAAM,WAAW,YAAY,CAAC,OAAO,SAAS,MAAM,YAAY;IAC9D,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,CAC3C,aAAa,CAAC,OAAO,CAAC,EACtB,WAAW,CAAC,WAAW,EACvB,KAAK,CACN,CAAA;CACF;AAED,eAAO,MAAM,UAAU,EAAE,CAAC,OAAO,SAAS,MAAM,YAAY,EAC1D,MAAM,EAAE,OAAO,EACf,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,KACzB,MAAM,CAAC,MAAM,CAChB,aAAa,CAAC,OAAO,CAAC,EACtB,WAAW,CAAC,WAAW,EACvB,MAAM,CAMA,CAAA;AAER,eAAO,MAAM,IAAI,EAAE,CAAC,IAAI,EAAE;IACxB,SAAS,EAAE,eAAe,CAAC,OAAO,CAAA;CACnC,KAAK,OAAuB,CAAA;AAE7B,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CAC7B,MAAM,EACN,KAAK,EACL,eAAe,CAAC,eAAe,CAOhC,CAAA;AAED,KAAK,UAAU,CAAC,OAAO,SAAS,MAAM,YAAY,IAChD,IAAI,SAAS,YAAY,CAAC,OAAO,CAAC,GAC9B,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,GAChC,CAAC,MAAM,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA"}
+{"version":3,"file":"BotApi.d.ts","sourceRoot":"","sources":["../src/BotApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,KAAK,WAAW,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,KAAK,WAAW,MAAM,kBAAkB,CAAA;AACpD,OAAO,KAAK,EACV,YAAY,EACZ,aAAa,EACb,MAAM,IAAI,OAAO,EACjB,KAAK,EACN,MAAM,0BAA0B,CAAA;AACjC,OAAO,KAAK,UAAU,MAAM,6BAA6B,CAAA;AACzD,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAA;AAC3C,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAIvD,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;;AAE3D,qBAAa,MAAO,SAAQ,WAGzB;CAAG;AAEN,MAAM,WAAW,YAAY,CAAC,OAAO,SAAS,MAAM,YAAY;IAC9D,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,CAC3C,aAAa,CAAC,OAAO,CAAC,EACtB,WAAW,CAAC,WAAW,EACvB,KAAK,CACN,CAAA;CACF;AAED,eAAO,MAAM,UAAU,EAAE,CAAC,OAAO,SAAS,MAAM,YAAY,EAC1D,MAAM,EAAE,OAAO,EACf,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,KACzB,MAAM,CAAC,MAAM,CAChB,aAAa,CAAC,OAAO,CAAC,EACtB,WAAW,CAAC,WAAW,EACvB,MAAM,CAMA,CAAA;AAER,eAAO,MAAM,IAAI,EAAE,CAAC,IAAI,EAAE;IACxB,SAAS,EAAE,eAAe,CAAC,OAAO,CAAA;CACnC,KAAK,OAAuB,CAAA;AAE7B,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CAC7B,MAAM,EACN,KAAK,EACL,eAAe,CAAC,eAAe,CAOhC,CAAA;AAED,KAAK,UAAU,CAAC,OAAO,SAAS,MAAM,YAAY,IAChD,IAAI,SAAS,YAAY,CAAC,OAAO,CAAC,GAC9B,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,GAChC,CAAC,MAAM,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;AAErC;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,SAAS;IACnC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IAEhD;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAEtC;;;;;;;;OAQG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAAE,eAAe,CAAC,OAAO,KAAK,eAAe,CAAC,OAAO,CAAA;CAC9F,KAAG,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,WAAW,EAAE,UAAU,CAAC,UAAU,CAyBrE,CAAA"}

package/dist/BotApi.js

@@ -1,11 +1,27 @@
+import * as HttpClient from '@effect/platform/HttpClient';
 import * as Context from 'effect/Context';
 import * as Effect from 'effect/Effect';
+import * as Function from 'effect/Function';
 import * as Layer from 'effect/Layer';
+import * as Redacted from 'effect/Redacted';
 import * as BotApiTransport from "./BotApiTransport.js";
+import * as BotApiUrl from "./BotApiUrl.js";
 import * as internal from "./internal/botApi.js";
 export class BotApi extends Context.Tag('@grom.js/effect-tg/BotApi')() {
 }
 export const callMethod = (method, params = undefined) => BotApi.pipe(Effect.flatMap(api => api[method](params)));
 export const make = internal.make;
 export const layer = Layer.effect(BotApi, Effect.andThen(BotApiTransport.BotApiTransport, transport => internal.make({ transport })));
+/**
+ * Constructs a `BotApi` layer from the given configuration.
+ */
+export const layerConfig = (options) => {
+    const { token, environment = 'prod', transformTransport, } = options;
+    return Layer.provide(layer, Layer.effect(BotApiTransport.BotApiTransport, Effect.all([
+        HttpClient.HttpClient,
+        token.pipe(Effect.map(token => (environment === 'prod'
+            ? BotApiUrl.makeProd(Redacted.value(token))
+            : BotApiUrl.makeTest(Redacted.value(token))))),
+    ]).pipe(Effect.map(([httpClient, botApiUrl]) => BotApiTransport.make({ httpClient, botApiUrl })), Effect.map(transformTransport ?? Function.identity))));
+};
 //# sourceMappingURL=BotApi.js.map

package/dist/BotApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"BotApi.js","sourceRoot":"","sources":["../src/BotApi.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AACvD,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAA;AAIhD,MAAM,OAAO,MAAO,SAAQ,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,EAGjE;CAAG;AAUN,MAAM,CAAC,MAAM,UAAU,GAOnB,CACF,MAAc,EACd,SAAkB,SAAS,EAC3B,EAAE,CAAC,MAAM,CAAC,IAAI,CACd,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAE,GAAW,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAC7C,CAAA;AAER,MAAM,CAAC,MAAM,IAAI,GAED,QAAQ,CAAC,IAAI,CAAA;AAE7B,MAAM,CAAC,MAAM,KAAK,GAId,KAAK,CAAC,MAAM,CACd,MAAM,EACN,MAAM,CAAC,OAAO,CACZ,eAAe,CAAC,eAAe,EAC/B,SAAS,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC,CAC1C,CACF,CAAA"}
+{"version":3,"file":"BotApi.js","sourceRoot":"","sources":["../src/BotApi.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,UAAU,MAAM,6BAA6B,CAAA;AACzD,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAA;AAC3C,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAA;AAC3C,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AACvD,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAA;AAIhD,MAAM,OAAO,MAAO,SAAQ,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,EAGjE;CAAG;AAUN,MAAM,CAAC,MAAM,UAAU,GAOnB,CACF,MAAc,EACd,SAAkB,SAAS,EAC3B,EAAE,CAAC,MAAM,CAAC,IAAI,CACd,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAE,GAAW,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAC7C,CAAA;AAER,MAAM,CAAC,MAAM,IAAI,GAED,QAAQ,CAAC,IAAI,CAAA;AAE7B,MAAM,CAAC,MAAM,KAAK,GAId,KAAK,CAAC,MAAM,CACd,MAAM,EACN,MAAM,CAAC,OAAO,CACZ,eAAe,CAAC,eAAe,EAC/B,SAAS,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC,CAC1C,CACF,CAAA;AAOD;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OA0B3B,EAAuE,EAAE;IACxE,MAAM,EACJ,KAAK,EACL,WAAW,GAAG,MAAM,EACpB,kBAAkB,GACnB,GAAG,OAAO,CAAA;IACX,OAAO,KAAK,CAAC,OAAO,CAClB,KAAK,EACL,KAAK,CAAC,MAAM,CACV,eAAe,CAAC,eAAe,EAC/B,MAAM,CAAC,GAAG,CAAC;QACT,UAAU,CAAC,UAAU;QACrB,KAAK,CAAC,IAAI,CACR,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAClB,WAAW,KAAK,MAAM;YACpB,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC3C,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAC9C,CAAC,CACH;KACF,CAAC,CAAC,IAAI,CACL,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC,EACxF,MAAM,CAAC,GAAG,CAAC,kBAAkB,IAAI,QAAQ,CAAC,QAAQ,CAAC,CACpD,CACF,CACF,CAAA;AACH,CAAC,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@grom.js/effect-tg",
   "type": "module",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Effectful library for crafting Telegram bots.",
   "author": {
     "name": "Vladislav Deryabkin",

package/src/BotApi.ts

@@ -1,3 +1,5 @@
+import type * as Config from 'effect/Config'
+import type * as ConfigError from 'effect/ConfigError'
 import type * as BotApiError from './BotApiError.ts'
 import type {
   MethodParams,
@@ -5,10 +7,14 @@ import type {
   BotApi as Service,
   Types,
 } from './internal/botApi.gen.ts'
+import * as HttpClient from '@effect/platform/HttpClient'
 import * as Context from 'effect/Context'
 import * as Effect from 'effect/Effect'
+import * as Function from 'effect/Function'
 import * as Layer from 'effect/Layer'
+import * as Redacted from 'effect/Redacted'
 import * as BotApiTransport from './BotApiTransport.ts'
+import * as BotApiUrl from './BotApiUrl.ts'
 import * as internal from './internal/botApi.ts'
 
 export type { MethodParams, MethodResults, Service, Types }
@@ -60,3 +66,59 @@ type MethodArgs<TMethod extends keyof MethodParams> =
   void extends MethodParams[TMethod]
     ? [params?: MethodParams[TMethod]]
     : [params: MethodParams[TMethod]]
+
+/**
+ * Constructs a `BotApi` layer from the given configuration.
+ */
+export const layerConfig = (options: {
+  /**
+   * Bot API token from [@BotFather](https://t.me/BotFather).
+   */
+  readonly token: Config.Config<Redacted.Redacted>
+
+  /**
+   * Target Bot API environment:
+   *
+   * - `prod` — production environment
+   * - `test` — [test environment](https://core.telegram.org/bots/features#dedicated-test-environment)
+   *
+   * @default 'prod'
+   */
+  readonly environment?: 'prod' | 'test'
+
+  /**
+   * A function to transform the underlying `BotApiTransport` before
+   * it's used to call Bot API methods.
+   *
+   * Useful for:
+   * - Adding custom middleware (logging, metrics, caching)
+   * - Adding custom retry logic or error handling
+   * - Integrating with monitoring or debugging tools
+   */
+  readonly transformTransport?: (transport: BotApiTransport.Service) => BotApiTransport.Service
+}): Layer.Layer<BotApi, ConfigError.ConfigError, HttpClient.HttpClient> => {
+  const {
+    token,
+    environment = 'prod',
+    transformTransport,
+  } = options
+  return Layer.provide(
+    layer,
+    Layer.effect(
+      BotApiTransport.BotApiTransport,
+      Effect.all([
+        HttpClient.HttpClient,
+        token.pipe(
+          Effect.map(token => (
+            environment === 'prod'
+              ? BotApiUrl.makeProd(Redacted.value(token))
+              : BotApiUrl.makeTest(Redacted.value(token))
+          )),
+        ),
+      ]).pipe(
+        Effect.map(([httpClient, botApiUrl]) => BotApiTransport.make({ httpClient, botApiUrl })),
+        Effect.map(transformTransport ?? Function.identity),
+      ),
+    ),
+  )
+}